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-01 20:21+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-win-reg.pl:536
897 #: ../tools/virt-win-reg.pl:542 ../tools/virt-win-reg.pl:548
898 #: ../tools/virt-resize.pl:345 ../tools/virt-resize.pl:350
899 #: ../tools/virt-resize.pl:360
904 #: ../src/guestfs.pod:390
906 "The kernel version that the command runs under will be different from what "
911 #: ../src/guestfs.pod:395
913 "If the command needs to communicate with daemons, then most likely they "
918 #: ../src/guestfs.pod:400
919 msgid "The command will be running in limited memory."
923 #: ../src/guestfs.pod:404
925 "The network may not be available unless you enable it (see L</"
926 "guestfs_set_network>)."
930 #: ../src/guestfs.pod:409
931 msgid "Only supports Linux guests (not Windows, BSD, etc)."
935 #: ../src/guestfs.pod:413
937 "Architecture limitations (eg. won't work for a PPC guest on an X86 host)."
941 #: ../src/guestfs.pod:418
943 "For SELinux guests, you may need to enable SELinux and load policy first. "
944 "See L</SELINUX> in this manpage."
948 #: ../src/guestfs.pod:423
950 "I<Security:> It is not safe to run commands from untrusted, possibly "
951 "malicious guests. These commands may attempt to exploit your program by "
952 "sending unexpected output. They could also try to exploit the Linux kernel "
953 "or qemu provided by the libguestfs appliance. They could use the network "
954 "provided by the libguestfs appliance to bypass ordinary network partitions "
955 "and firewalls. They could use the elevated privileges or different SELinux "
956 "context of your program to their advantage."
960 #: ../src/guestfs.pod:432
962 "A secure alternative is to use libguestfs to install a \"firstboot\" script "
963 "(a script which runs when the guest next boots normally), and to have this "
964 "script run the commands you want in the normal context of the running guest, "
965 "network security and so on. For information about other security issues, "
970 #: ../src/guestfs.pod:440
972 "The two main API calls to run commands are L</guestfs_command> and L</"
973 "guestfs_sh> (there are also variations)."
977 #: ../src/guestfs.pod:443
979 "The difference is that L</guestfs_sh> runs commands using the shell, so any "
980 "shell globs, redirections, etc will work."
984 #: ../src/guestfs.pod:446
985 msgid "CONFIGURATION FILES"
986 msgstr "ФАЙЛИ НАЛАШТУВАННЯ"
989 #: ../src/guestfs.pod:448
991 "To read and write configuration files in Linux guest filesystems, we "
992 "strongly recommend using Augeas. For example, Augeas understands how to "
993 "read and write, say, a Linux shadow password file or X.org configuration "
994 "file, and so avoids you having to write that code."
998 #: ../src/guestfs.pod:453
1000 "The main Augeas calls are bound through the C<guestfs_aug_*> APIs. We don't "
1001 "document Augeas itself here because there is excellent documentation on the "
1002 "L<http://augeas.net/> website."
1006 #: ../src/guestfs.pod:457
1008 "If you don't want to use Augeas (you fool!) then try calling L</"
1009 "guestfs_read_lines> to get the file as a list of lines which you can iterate "
1014 #: ../src/guestfs.pod:461
1019 #: ../src/guestfs.pod:463
1021 "We support SELinux guests. To ensure that labeling happens correctly in "
1022 "SELinux guests, you need to enable SELinux and load the guest's policy:"
1026 #: ../src/guestfs.pod:469 ../src/guestfs.pod:1281 ../src/guestfs.pod:1412
1027 #: ../src/guestfs.pod:2441
1032 #: ../src/guestfs.pod:471
1033 msgid "Before launching, do:"
1037 #: ../src/guestfs.pod:473
1040 " guestfs_set_selinux (g, 1);\n"
1045 #: ../src/guestfs.pod:475 ../src/guestfs.pod:1285 ../src/guestfs.pod:1416
1046 #: ../src/guestfs.pod:2466
1051 #: ../src/guestfs.pod:477
1053 "After mounting the guest's filesystem(s), load the policy. This is best "
1054 "done by running the L<load_policy(8)> command in the guest itself:"
1058 #: ../src/guestfs.pod:481
1061 " guestfs_sh (g, \"/usr/sbin/load_policy\");\n"
1066 #: ../src/guestfs.pod:483
1068 "(Older versions of C<load_policy> require you to specify the name of the "
1073 #: ../src/guestfs.pod:486 ../src/guestfs.pod:1422
1078 #: ../src/guestfs.pod:488
1080 "Optionally, set the security context for the API. The correct security "
1081 "context to use can only be known by inspecting the guest. As an example:"
1085 #: ../src/guestfs.pod:492
1088 " guestfs_setcon (g, \"unconfined_u:unconfined_r:unconfined_t:s0\");\n"
1093 #: ../src/guestfs.pod:496
1094 msgid "This will work for running commands and editing existing files."
1098 #: ../src/guestfs.pod:498
1100 "When new files are created, you may need to label them explicitly, for "
1101 "example by running the external command C<restorecon pathname>."
1105 #: ../src/guestfs.pod:502
1110 #: ../src/guestfs.pod:504
1112 "Certain calls are affected by the current file mode creation mask (the "
1113 "\"umask\"). In particular ones which create files or directories, such as "
1114 "L</guestfs_touch>, L</guestfs_mknod> or L</guestfs_mkdir>. This affects "
1115 "either the default mode that the file is created with or modifies the mode "
1120 #: ../src/guestfs.pod:510
1122 "The default umask is C<022>, so files are created with modes such as C<0644> "
1123 "and directories with C<0755>."
1127 #: ../src/guestfs.pod:513
1129 "There are two ways to avoid being affected by umask. Either set umask to 0 "
1130 "(call C<guestfs_umask (g, 0)> early after launching). Or call L</"
1131 "guestfs_chmod> after creating each file or directory."
1135 #: ../src/guestfs.pod:517
1136 msgid "For more information about umask, see L<umask(2)>."
1140 #: ../src/guestfs.pod:519 ../fish/guestfish.pod:765
1141 msgid "ENCRYPTED DISKS"
1145 #: ../src/guestfs.pod:521
1147 "Libguestfs allows you to access Linux guests which have been encrypted using "
1148 "whole disk encryption that conforms to the Linux Unified Key Setup (LUKS) "
1149 "standard. This includes nearly all whole disk encryption systems used by "
1150 "modern Linux guests."
1154 #: ../src/guestfs.pod:527
1156 "Use L</guestfs_vfs_type> to identify LUKS-encrypted block devices (it "
1157 "returns the string C<crypto_LUKS>)."
1161 #: ../src/guestfs.pod:530
1163 "Then open these devices by calling L</guestfs_luks_open>. Obviously you "
1164 "will require the passphrase!"
1168 #: ../src/guestfs.pod:533
1170 "Opening a LUKS device creates a new device mapper device called C</dev/"
1171 "mapper/mapname> (where C<mapname> is the string you supply to L</"
1172 "guestfs_luks_open>). Reads and writes to this mapper device are decrypted "
1173 "from and encrypted to the underlying block device respectively."
1177 #: ../src/guestfs.pod:539
1179 "LVM volume groups on the device can be made visible by calling L</"
1180 "guestfs_vgscan> followed by L</guestfs_vg_activate_all>. The logical volume"
1181 "(s) can now be mounted in the usual way."
1185 #: ../src/guestfs.pod:543
1187 "Use the reverse process to close a LUKS device. Unmount any logical volumes "
1188 "on it, deactivate the volume groups by caling C<guestfs_vg_activate (g, 0, "
1189 "[\"/dev/VG\"])>. Then close the mapper device by calling L</"
1190 "guestfs_luks_close> on the C</dev/mapper/mapname> device (I<not> the "
1191 "underlying encrypted block device)."
1195 #: ../src/guestfs.pod:550
1200 #: ../src/guestfs.pod:552
1202 "Libguestfs has APIs for inspecting an unknown disk image to find out if it "
1203 "contains operating systems, an install CD or a live CD. (These APIs used to "
1204 "be in a separate Perl-only library called L<Sys::Guestfs::Lib(3)> but since "
1205 "version 1.5.3 the most frequently used part of this library has been "
1206 "rewritten in C and moved into the core code)."
1210 #: ../src/guestfs.pod:559
1212 "Add all disks belonging to the unknown virtual machine and call L</"
1213 "guestfs_launch> in the usual way."
1217 #: ../src/guestfs.pod:562
1219 "Then call L</guestfs_inspect_os>. This function uses other libguestfs calls "
1220 "and certain heuristics, and returns a list of operating systems that were "
1221 "found. An empty list means none were found. A single element is the root "
1222 "filesystem of the operating system. For dual- or multi-boot guests, "
1223 "multiple roots can be returned, each one corresponding to a separate "
1224 "operating system. (Multi-boot virtual machines are extremely rare in the "
1225 "world of virtualization, but since this scenario can happen, we have built "
1226 "libguestfs to deal with it.)"
1230 #: ../src/guestfs.pod:571
1232 "For each root, you can then call various C<guestfs_inspect_get_*> functions "
1233 "to get additional details about that operating system. For example, call L</"
1234 "guestfs_inspect_get_type> to return the string C<windows> or C<linux> for "
1235 "Windows and Linux-based operating systems respectively."
1239 #: ../src/guestfs.pod:577
1241 "Un*x-like and Linux-based operating systems usually consist of several "
1242 "filesystems which are mounted at boot time (for example, a separate boot "
1243 "partition mounted on C</boot>). The inspection rules are able to detect how "
1244 "filesystems correspond to mount points. Call "
1245 "C<guestfs_inspect_get_mountpoints> to get this mapping. It might return a "
1246 "hash table like this example:"
1250 #: ../src/guestfs.pod:584
1253 " /boot => /dev/sda1\n"
1254 " / => /dev/vg_guest/lv_root\n"
1255 " /usr => /dev/vg_guest/lv_usr\n"
1260 #: ../src/guestfs.pod:588
1262 "The caller can then make calls to L</guestfs_mount_options> to mount the "
1263 "filesystems as suggested."
1267 #: ../src/guestfs.pod:591
1269 "Be careful to mount filesystems in the right order (eg. C</> before C</"
1270 "usr>). Sorting the keys of the hash by length, shortest first, should work."
1274 #: ../src/guestfs.pod:595
1276 "Inspection currently only works for some common operating systems. "
1277 "Contributors are welcome to send patches for other operating systems that we "
1278 "currently cannot detect."
1282 #: ../src/guestfs.pod:599
1284 "Encrypted disks must be opened before inspection. See L</ENCRYPTED DISKS> "
1285 "for more details. The L</guestfs_inspect_os> function just ignores any "
1286 "encrypted devices."
1290 #: ../src/guestfs.pod:603
1292 "A note on the implementation: The call L</guestfs_inspect_os> performs "
1293 "inspection and caches the results in the guest handle. Subsequent calls to "
1294 "C<guestfs_inspect_get_*> return this cached information, but I<do not> re-"
1295 "read the disks. If you change the content of the guest disks, you can redo "
1296 "inspection by calling L</guestfs_inspect_os> again. (L</"
1297 "guestfs_inspect_list_applications> works a little differently from the other "
1298 "calls and does read the disks. See documentation for that function for "
1303 #: ../src/guestfs.pod:612
1304 msgid "INSPECTING INSTALL DISKS"
1308 #: ../src/guestfs.pod:614
1310 "Libguestfs (since 1.9.4) can detect some install disks, install CDs, live "
1315 #: ../src/guestfs.pod:617
1317 "Call L</guestfs_inspect_get_format> to return the format of the operating "
1318 "system, which currently can be C<installed> (a regular operating system) or "
1319 "C<installer> (some sort of install disk)."
1323 #: ../src/guestfs.pod:621
1325 "Further information is available about the operating system that can be "
1326 "installed using the regular inspection APIs like L</"
1327 "guestfs_inspect_get_product_name>, L</guestfs_inspect_get_major_version> etc."
1331 #: ../src/guestfs.pod:626
1333 "Some additional information specific to installer disks is also available "
1334 "from the L</guestfs_inspect_is_live>, L</guestfs_inspect_is_netinst> and L</"
1335 "guestfs_inspect_is_multipart> calls."
1339 #: ../src/guestfs.pod:631
1340 msgid "SPECIAL CONSIDERATIONS FOR WINDOWS GUESTS"
1344 #: ../src/guestfs.pod:633
1346 "Libguestfs can mount NTFS partitions. It does this using the L<http://www."
1347 "ntfs-3g.org/> driver."
1351 #: ../src/guestfs.pod:636
1352 msgid "DRIVE LETTERS AND PATHS"
1356 #: ../src/guestfs.pod:638
1358 "DOS and Windows still use drive letters, and the filesystems are always "
1359 "treated as case insensitive by Windows itself, and therefore you might find "
1360 "a Windows configuration file referring to a path like C<c:\\windows"
1361 "\\system32>. When the filesystem is mounted in libguestfs, that directory "
1362 "might be referred to as C</WINDOWS/System32>."
1366 #: ../src/guestfs.pod:644
1368 "Drive letter mappings are outside the scope of libguestfs. You have to use "
1369 "libguestfs to read the appropriate Windows Registry and configuration files, "
1370 "to determine yourself how drives are mapped (see also L<hivex(3)> and L<virt-"
1375 #: ../src/guestfs.pod:649
1377 "Replacing backslash characters with forward slash characters is also outside "
1378 "the scope of libguestfs, but something that you can easily do."
1382 #: ../src/guestfs.pod:652
1384 "Where we can help is in resolving the case insensitivity of paths. For "
1385 "this, call L</guestfs_case_sensitive_path>."
1389 #: ../src/guestfs.pod:655
1390 msgid "ACCESSING THE WINDOWS REGISTRY"
1394 #: ../src/guestfs.pod:657
1396 "Libguestfs also provides some help for decoding Windows Registry \"hive\" "
1397 "files, through the library C<hivex> which is part of the libguestfs project "
1398 "although ships as a separate tarball. You have to locate and download the "
1399 "hive file(s) yourself, and then pass them to C<hivex> functions. See also "
1400 "the programs L<hivexml(1)>, L<hivexsh(1)>, L<hivexregedit(1)> and L<virt-win-"
1401 "reg(1)> for more help on this issue."
1405 #: ../src/guestfs.pod:665
1406 msgid "SYMLINKS ON NTFS-3G FILESYSTEMS"
1410 #: ../src/guestfs.pod:667
1412 "Ntfs-3g tries to rewrite \"Junction Points\" and NTFS \"symbolic links\" to "
1413 "provide something which looks like a Linux symlink. The way it tries to do "
1414 "the rewriting is described here:"
1418 #: ../src/guestfs.pod:671
1420 "L<http://www.tuxera.com/community/ntfs-3g-advanced/junction-points-and-"
1423 "L<http://www.tuxera.com/community/ntfs-3g-advanced/junction-points-and-"
1427 #: ../src/guestfs.pod:673
1429 "The essential problem is that ntfs-3g simply does not have enough "
1430 "information to do a correct job. NTFS links can contain drive letters and "
1431 "references to external device GUIDs that ntfs-3g has no way of resolving. "
1432 "It is almost certainly the case that libguestfs callers should ignore what "
1433 "ntfs-3g does (ie. don't use L</guestfs_readlink> on NTFS volumes)."
1437 #: ../src/guestfs.pod:680
1439 "Instead if you encounter a symbolic link on an ntfs-3g filesystem, use L</"
1440 "guestfs_lgetxattr> to read the C<system.ntfs_reparse_data> extended "
1441 "attribute, and read the raw reparse data from that (you can find the format "
1442 "documented in various places around the web)."
1446 #: ../src/guestfs.pod:685
1447 msgid "EXTENDED ATTRIBUTES ON NTFS-3G FILESYSTEMS"
1451 #: ../src/guestfs.pod:687
1453 "There are other useful extended attributes that can be read from ntfs-3g "
1454 "filesystems (using L</guestfs_getxattr>). See:"
1458 #: ../src/guestfs.pod:690
1460 "L<http://www.tuxera.com/community/ntfs-3g-advanced/extended-attributes/>"
1462 "L<http://www.tuxera.com/community/ntfs-3g-advanced/extended-attributes/>"
1465 #: ../src/guestfs.pod:692
1466 msgid "USING LIBGUESTFS WITH OTHER PROGRAMMING LANGUAGES"
1470 #: ../src/guestfs.pod:694
1472 "Although we don't want to discourage you from using the C API, we will "
1473 "mention here that the same API is also available in other languages."
1477 #: ../src/guestfs.pod:697
1479 "The API is broadly identical in all supported languages. This means that "
1480 "the C call C<guestfs_add_drive_ro(g,file)> is C<$g-E<gt>add_drive_ro($file)> "
1481 "in Perl, C<g.add_drive_ro(file)> in Python, and C<g#add_drive_ro file> in "
1482 "OCaml. In other words, a straightforward, predictable isomorphism between "
1487 #: ../src/guestfs.pod:703
1489 "Error messages are automatically transformed into exceptions if the language "
1494 #: ../src/guestfs.pod:706
1496 "We don't try to \"object orientify\" parts of the API in OO languages, "
1497 "although contributors are welcome to write higher level APIs above what we "
1498 "provide in their favourite languages if they wish."
1502 #: ../src/guestfs.pod:712
1507 #: ../src/guestfs.pod:714
1509 "You can use the I<guestfs.h> header file from C++ programs. The C++ API is "
1510 "identical to the C API. C++ classes and exceptions are not used."
1514 #: ../src/guestfs.pod:718
1519 #: ../src/guestfs.pod:720
1521 "The C# bindings are highly experimental. Please read the warnings at the "
1522 "top of C<csharp/Libguestfs.cs>."
1526 #: ../src/guestfs.pod:723
1531 #: ../src/guestfs.pod:725
1533 "This is the only language binding that is working but incomplete. Only "
1534 "calls which return simple integers have been bound in Haskell, and we are "
1535 "looking for help to complete this binding."
1539 #: ../src/guestfs.pod:729
1544 #: ../src/guestfs.pod:731
1546 "Full documentation is contained in the Javadoc which is distributed with "
1551 #: ../src/guestfs.pod:734
1556 #: ../src/guestfs.pod:736
1557 msgid "See L<guestfs-ocaml(3)>."
1558 msgstr "Див. L<guestfs-ocaml(3)>."
1561 #: ../src/guestfs.pod:738
1566 #: ../src/guestfs.pod:740
1567 msgid "See L<guestfs-perl(3)> and L<Sys::Guestfs(3)>."
1568 msgstr "Див. L<guestfs-perl(3)> та L<Sys::Guestfs(3)>."
1571 #: ../src/guestfs.pod:742
1576 #: ../src/guestfs.pod:744
1578 "For documentation see C<README-PHP> supplied with libguestfs sources or in "
1579 "the php-libguestfs package for your distribution."
1583 #: ../src/guestfs.pod:747
1584 msgid "The PHP binding only works correctly on 64 bit machines."
1588 #: ../src/guestfs.pod:749
1593 #: ../src/guestfs.pod:751
1594 msgid "See L<guestfs-python(3)>."
1595 msgstr "Див. L<guestfs-python(3)>."
1598 #: ../src/guestfs.pod:753
1603 #: ../src/guestfs.pod:755
1604 msgid "See L<guestfs-ruby(3)>."
1605 msgstr "Див. L<guestfs-ruby(3)>."
1608 #: ../src/guestfs.pod:757
1609 msgid "B<shell scripts>"
1610 msgstr "B<скрипти оболонки>"
1613 #: ../src/guestfs.pod:759
1614 msgid "See L<guestfish(1)>."
1615 msgstr "Див. L<guestfish(1)>."
1618 #: ../src/guestfs.pod:763
1619 msgid "LIBGUESTFS GOTCHAS"
1623 #: ../src/guestfs.pod:765
1625 "L<http://en.wikipedia.org/wiki/Gotcha_(programming)>: \"A feature of a "
1626 "system [...] that works in the way it is documented but is counterintuitive "
1627 "and almost invites mistakes.\""
1631 #: ../src/guestfs.pod:769
1633 "Since we developed libguestfs and the associated tools, there are several "
1634 "things we would have designed differently, but are now stuck with for "
1635 "backwards compatibility or other reasons. If there is ever a libguestfs 2.0 "
1636 "release, you can expect these to change. Beware of them."
1640 #: ../src/guestfs.pod:777
1641 msgid "Autosync / forgetting to sync."
1645 #: ../src/guestfs.pod:779
1647 "When modifying a filesystem from C or another language, you B<must> unmount "
1648 "all filesystems and call L</guestfs_sync> explicitly before you close the "
1649 "libguestfs handle. You can also call:"
1653 #: ../src/guestfs.pod:783
1656 " guestfs_set_autosync (g, 1);\n"
1661 #: ../src/guestfs.pod:785
1663 "to have the unmount/sync done automatically for you when the handle 'g' is "
1664 "closed. (This feature is called \"autosync\", L</guestfs_set_autosync> q.v.)"
1668 #: ../src/guestfs.pod:789
1670 "If you forget to do this, then it is entirely possible that your changes "
1671 "won't be written out, or will be partially written, or (very rarely) that "
1672 "you'll get disk corruption."
1676 #: ../src/guestfs.pod:793
1678 "Note that in L<guestfish(3)> autosync is the default. So quick and dirty "
1679 "guestfish scripts that forget to sync will work just fine, which can make "
1680 "this very puzzling if you are trying to debug a problem."
1684 #: ../src/guestfs.pod:797
1686 "Update: Autosync is enabled by default for all API users starting from "
1687 "libguestfs 1.5.24."
1691 #: ../src/guestfs.pod:800
1692 msgid "Mount option C<-o sync> should not be the default."
1696 #: ../src/guestfs.pod:802
1698 "If you use L</guestfs_mount>, then C<-o sync,noatime> are added implicitly. "
1699 "However C<-o sync> does not add any reliability benefit, but does have a "
1700 "very large performance impact."
1704 #: ../src/guestfs.pod:806
1706 "The work around is to use L</guestfs_mount_options> and set the mount "
1707 "options that you actually want to use."
1711 #: ../src/guestfs.pod:809
1712 msgid "Read-only should be the default."
1716 #: ../src/guestfs.pod:811
1718 "In L<guestfish(3)>, I<--ro> should be the default, and you should have to "
1719 "specify I<--rw> if you want to make changes to the image."
1723 #: ../src/guestfs.pod:814
1724 msgid "This would reduce the potential to corrupt live VM images."
1728 #: ../src/guestfs.pod:816
1730 "Note that many filesystems change the disk when you just mount and unmount, "
1731 "even if you didn't perform any writes. You need to use L</"
1732 "guestfs_add_drive_ro> to guarantee that the disk is not changed."
1736 #: ../src/guestfs.pod:820
1737 msgid "guestfish command line is hard to use."
1741 #: ../src/guestfs.pod:822
1743 "C<guestfish disk.img> doesn't do what people expect (open C<disk.img> for "
1744 "examination). It tries to run a guestfish command C<disk.img> which doesn't "
1745 "exist, so it fails. In earlier versions of guestfish the error message was "
1746 "also unintuitive, but we have corrected this since. Like the Bourne shell, "
1747 "we should have used C<guestfish -c command> to run commands."
1751 #: ../src/guestfs.pod:829
1752 msgid "guestfish megabyte modifiers don't work right on all commands"
1756 #: ../src/guestfs.pod:831
1758 "In recent guestfish you can use C<1M> to mean 1 megabyte (and similarly for "
1759 "other modifiers). What guestfish actually does is to multiply the number "
1760 "part by the modifier part and pass the result to the C API. However this "
1761 "doesn't work for a few APIs which aren't expecting bytes, but are already "
1762 "expecting some other unit (eg. megabytes)."
1766 #: ../src/guestfs.pod:838
1767 msgid "The most common is L</guestfs_lvcreate>. The guestfish command:"
1771 #: ../src/guestfs.pod:840
1774 " lvcreate LV VG 100M\n"
1779 #: ../src/guestfs.pod:842
1781 "does not do what you might expect. Instead because L</guestfs_lvcreate> is "
1782 "already expecting megabytes, this tries to create a 100 I<terabyte> (100 "
1783 "megabytes * megabytes) logical volume. The error message you get from this "
1784 "is also a little obscure."
1788 #: ../src/guestfs.pod:847
1790 "This could be fixed in the generator by specially marking parameters and "
1791 "return values which take bytes or other units."
1795 #: ../src/guestfs.pod:850
1796 msgid "Ambiguity between devices and paths"
1800 #: ../src/guestfs.pod:852
1802 "There is a subtle ambiguity in the API between a device name (eg. C</dev/"
1803 "sdb2>) and a similar pathname. A file might just happen to be called "
1804 "C<sdb2> in the directory C</dev> (consider some non-Unix VM image)."
1808 #: ../src/guestfs.pod:857
1810 "In the current API we usually resolve this ambiguity by having two separate "
1811 "calls, for example L</guestfs_checksum> and L</guestfs_checksum_device>. "
1812 "Some API calls are ambiguous and (incorrectly) resolve the problem by "
1813 "detecting if the path supplied begins with C</dev/>."
1817 #: ../src/guestfs.pod:863
1819 "To avoid both the ambiguity and the need to duplicate some calls, we could "
1820 "make paths/devices into structured names. One way to do this would be to "
1821 "use a notation like grub (C<hd(0,0)>), although nobody really likes this "
1822 "aspect of grub. Another way would be to use a structured type, equivalent "
1823 "to this OCaml type:"
1827 #: ../src/guestfs.pod:869
1830 " type path = Path of string | Device of int | Partition of int * int\n"
1835 #: ../src/guestfs.pod:871
1836 msgid "which would allow you to pass arguments like:"
1840 #: ../src/guestfs.pod:873
1843 " Path \"/foo/bar\"\n"
1844 " Device 1 (* /dev/sdb, or perhaps /dev/sda *)\n"
1845 " Partition (1, 2) (* /dev/sdb2 (or is it /dev/sda2 or /dev/sdb3?) *)\n"
1846 " Path \"/dev/sdb2\" (* not a device *)\n"
1851 #: ../src/guestfs.pod:878
1853 "As you can see there are still problems to resolve even with this "
1854 "representation. Also consider how it might work in guestfish."
1858 #: ../src/guestfs.pod:883
1859 msgid "PROTOCOL LIMITS"
1863 #: ../src/guestfs.pod:885
1865 "Internally libguestfs uses a message-based protocol to pass API calls and "
1866 "their responses to and from a small \"appliance\" (see L</INTERNALS> for "
1867 "plenty more detail about this). The maximum message size used by the "
1868 "protocol is slightly less than 4 MB. For some API calls you may need to be "
1869 "aware of this limit. The API calls which may be affected are individually "
1870 "documented, with a link back to this section of the documentation."
1874 #: ../src/guestfs.pod:893
1876 "A simple call such as L</guestfs_cat> returns its result (the file data) in "
1877 "a simple string. Because this string is at some point internally encoded as "
1878 "a message, the maximum size that it can return is slightly under 4 MB. If "
1879 "the requested file is larger than this then you will get an error."
1883 #: ../src/guestfs.pod:899
1885 "In order to transfer large files into and out of the guest filesystem, you "
1886 "need to use particular calls that support this. The sections L</UPLOADING> "
1887 "and L</DOWNLOADING> document how to do this."
1891 #: ../src/guestfs.pod:903
1893 "You might also consider mounting the disk image using our FUSE filesystem "
1894 "support (L<guestmount(1)>)."
1898 #: ../src/guestfs.pod:906
1899 msgid "KEYS AND PASSPHRASES"
1903 #: ../src/guestfs.pod:908
1905 "Certain libguestfs calls take a parameter that contains sensitive key "
1906 "material, passed in as a C string."
1910 #: ../src/guestfs.pod:911
1912 "In the future we would hope to change the libguestfs implementation so that "
1913 "keys are L<mlock(2)>-ed into physical RAM, and thus can never end up in "
1914 "swap. However this is I<not> done at the moment, because of the complexity "
1915 "of such an implementation."
1919 #: ../src/guestfs.pod:916
1921 "Therefore you should be aware that any key parameter you pass to libguestfs "
1922 "might end up being written out to the swap partition. If this is a concern, "
1923 "scrub the swap partition or don't use libguestfs on encrypted devices."
1927 #: ../src/guestfs.pod:921
1928 msgid "MULTIPLE HANDLES AND MULTIPLE THREADS"
1932 #: ../src/guestfs.pod:923
1934 "All high-level libguestfs actions are synchronous. If you want to use "
1935 "libguestfs asynchronously then you must create a thread."
1939 #: ../src/guestfs.pod:926
1941 "Only use the handle from a single thread. Either use the handle exclusively "
1942 "from one thread, or provide your own mutex so that two threads cannot issue "
1943 "calls on the same handle at the same time."
1947 #: ../src/guestfs.pod:930
1949 "See the graphical program guestfs-browser for one possible architecture for "
1950 "multithreaded programs using libvirt and libguestfs."
1954 #: ../src/guestfs.pod:933
1959 #: ../src/guestfs.pod:935
1961 "Libguestfs needs a supermin appliance, which it finds by looking along an "
1966 #: ../src/guestfs.pod:938
1968 "By default it looks for these in the directory C<$libdir/guestfs> (eg. C</"
1969 "usr/local/lib/guestfs> or C</usr/lib64/guestfs>)."
1973 #: ../src/guestfs.pod:941
1975 "Use L</guestfs_set_path> or set the environment variable L</LIBGUESTFS_PATH> "
1976 "to change the directories that libguestfs will search in. The value is a "
1977 "colon-separated list of paths. The current directory is I<not> searched "
1978 "unless the path contains an empty element or C<.>. For example "
1979 "C<LIBGUESTFS_PATH=:/usr/lib/guestfs> would search the current directory and "
1980 "then C</usr/lib/guestfs>."
1984 #: ../src/guestfs.pod:948
1985 msgid "QEMU WRAPPERS"
1989 #: ../src/guestfs.pod:950
1991 "If you want to compile your own qemu, run qemu from a non-standard location, "
1992 "or pass extra arguments to qemu, then you can write a shell-script wrapper "
1997 #: ../src/guestfs.pod:954
1999 "There is one important rule to remember: you I<must C<exec qemu>> as the "
2000 "last command in the shell script (so that qemu replaces the shell and "
2001 "becomes the direct child of the libguestfs-using program). If you don't do "
2002 "this, then the qemu process won't be cleaned up correctly."
2006 #: ../src/guestfs.pod:959
2008 "Here is an example of a wrapper, where I have built my own copy of qemu from "
2013 #: ../src/guestfs.pod:962
2017 " qemudir=/home/rjones/d/qemu\n"
2018 " exec $qemudir/x86_64-softmmu/qemu-system-x86_64 -L $qemudir/pc-bios \"$@\"\n"
2023 #: ../src/guestfs.pod:966
2025 "Save this script as C</tmp/qemu.wrapper> (or wherever), C<chmod +x>, and "
2026 "then use it by setting the LIBGUESTFS_QEMU environment variable. For "
2031 #: ../src/guestfs.pod:970
2034 " LIBGUESTFS_QEMU=/tmp/qemu.wrapper guestfish\n"
2039 #: ../src/guestfs.pod:972
2041 "Note that libguestfs also calls qemu with the -help and -version options in "
2042 "order to determine features."
2046 #: ../src/guestfs.pod:975
2047 msgid "ATTACHING TO RUNNING DAEMONS"
2051 #: ../src/guestfs.pod:977
2053 "I<Note (1):> This is B<highly experimental> and has a tendency to eat "
2054 "babies. Use with caution."
2058 #: ../src/guestfs.pod:980
2060 "I<Note (2):> This section explains how to attach to a running daemon from a "
2061 "low level perspective. For most users, simply using virt tools such as "
2062 "L<guestfish(1)> with the I<--live> option will \"just work\"."
2066 #: ../src/guestfs.pod:984
2067 msgid "Using guestfs_set_attach_method"
2071 #: ../src/guestfs.pod:986
2073 "By calling L</guestfs_set_attach_method> you can change how the library "
2074 "connects to the C<guestfsd> daemon in L</guestfs_launch> (read L</"
2075 "ARCHITECTURE> for some background)."
2079 #: ../src/guestfs.pod:990
2081 "The normal attach method is C<appliance>, where a small appliance is created "
2082 "containing the daemon, and then the library connects to this."
2086 #: ../src/guestfs.pod:993
2088 "Setting attach method to C<unix:I<path>> (where I<path> is the path of a "
2089 "Unix domain socket) causes L</guestfs_launch> to connect to an existing "
2090 "daemon over the Unix domain socket."
2094 #: ../src/guestfs.pod:997
2096 "The normal use for this is to connect to a running virtual machine that "
2097 "contains a C<guestfsd> daemon, and send commands so you can read and write "
2098 "files inside the live virtual machine."
2102 #: ../src/guestfs.pod:1001
2103 msgid "Using guestfs_add_domain with live flag"
2107 #: ../src/guestfs.pod:1003
2109 "L</guestfs_add_domain> provides some help for getting the correct attach "
2110 "method. If you pass the C<live> option to this function, then (if the "
2111 "virtual machine is running) it will examine the libvirt XML looking for a "
2112 "virtio-serial channel to connect to:"
2116 #: ../src/guestfs.pod:1009
2123 " <channel type='unix'>\n"
2124 " <source mode='bind' path='/path/to/socket'/>\n"
2125 " <target type='virtio' name='org.libguestfs.channel.0'/>\n"
2134 #: ../src/guestfs.pod:1021
2136 "L</guestfs_add_domain> extracts C</path/to/socket> and sets the attach "
2137 "method to C<unix:/path/to/socket>."
2141 #: ../src/guestfs.pod:1024
2143 "Some of the libguestfs tools (including guestfish) support a I<--live> "
2144 "option which is passed through to L</guestfs_add_domain> thus allowing you "
2145 "to attach to and modify live virtual machines."
2149 #: ../src/guestfs.pod:1028
2151 "The virtual machine needs to have been set up beforehand so that it has the "
2152 "virtio-serial channel and so that guestfsd is running inside it."
2156 #: ../src/guestfs.pod:1032
2157 msgid "ABI GUARANTEE"
2161 #: ../src/guestfs.pod:1034
2163 "We guarantee the libguestfs ABI (binary interface), for public, high-level "
2164 "actions as outlined in this section. Although we will deprecate some "
2165 "actions, for example if they get replaced by newer calls, we will keep the "
2166 "old actions forever. This allows you the developer to program in confidence "
2167 "against the libguestfs API."
2171 #: ../src/guestfs.pod:1040
2172 msgid "BLOCK DEVICE NAMING"
2176 #: ../src/guestfs.pod:1042
2178 "In the kernel there is now quite a profusion of schemata for naming block "
2179 "devices (in this context, by I<block device> I mean a physical or virtual "
2180 "hard drive). The original Linux IDE driver used names starting with C</dev/"
2181 "hd*>. SCSI devices have historically used a different naming scheme, C</dev/"
2182 "sd*>. When the Linux kernel I<libata> driver became a popular replacement "
2183 "for the old IDE driver (particularly for SATA devices) those devices also "
2184 "used the C</dev/sd*> scheme. Additionally we now have virtual machines with "
2185 "paravirtualized drivers. This has created several different naming systems, "
2186 "such as C</dev/vd*> for virtio disks and C</dev/xvd*> for Xen PV disks."
2190 #: ../src/guestfs.pod:1054
2192 "As discussed above, libguestfs uses a qemu appliance running an embedded "
2193 "Linux kernel to access block devices. We can run a variety of appliances "
2194 "based on a variety of Linux kernels."
2198 #: ../src/guestfs.pod:1058
2200 "This causes a problem for libguestfs because many API calls use device or "
2201 "partition names. Working scripts and the recipe (example) scripts that we "
2202 "make available over the internet could fail if the naming scheme changes."
2206 #: ../src/guestfs.pod:1063
2208 "Therefore libguestfs defines C</dev/sd*> as the I<standard naming scheme>. "
2209 "Internally C</dev/sd*> names are translated, if necessary, to other names as "
2210 "required. For example, under RHEL 5 which uses the C</dev/hd*> scheme, any "
2211 "device parameter C</dev/sda2> is translated to C</dev/hda2> transparently."
2215 #: ../src/guestfs.pod:1069
2217 "Note that this I<only> applies to parameters. The L</guestfs_list_devices>, "
2218 "L</guestfs_list_partitions> and similar calls return the true names of the "
2219 "devices and partitions as known to the appliance."
2223 #: ../src/guestfs.pod:1074
2224 msgid "ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION"
2228 #: ../src/guestfs.pod:1076
2230 "Usually this translation is transparent. However in some (very rare) cases "
2231 "you may need to know the exact algorithm. Such cases include where you use "
2232 "L</guestfs_config> to add a mixture of virtio and IDE devices to the qemu-"
2233 "based appliance, so have a mixture of C</dev/sd*> and C</dev/vd*> devices."
2237 #: ../src/guestfs.pod:1082
2239 "The algorithm is applied only to I<parameters> which are known to be either "
2240 "device or partition names. Return values from functions such as L</"
2241 "guestfs_list_devices> are never changed."
2245 #: ../src/guestfs.pod:1090
2246 msgid "Is the string a parameter which is a device or partition name?"
2250 #: ../src/guestfs.pod:1094
2251 msgid "Does the string begin with C</dev/sd>?"
2255 #: ../src/guestfs.pod:1098
2257 "Does the named device exist? If so, we use that device. However if I<not> "
2258 "then we continue with this algorithm."
2262 #: ../src/guestfs.pod:1103
2263 msgid "Replace initial C</dev/sd> string with C</dev/hd>."
2267 #: ../src/guestfs.pod:1105
2268 msgid "For example, change C</dev/sda2> to C</dev/hda2>."
2272 #: ../src/guestfs.pod:1107
2273 msgid "If that named device exists, use it. If not, continue."
2277 #: ../src/guestfs.pod:1111
2278 msgid "Replace initial C</dev/sd> string with C</dev/vd>."
2282 #: ../src/guestfs.pod:1113
2283 msgid "If that named device exists, use it. If not, return an error."
2287 #: ../src/guestfs.pod:1117
2288 msgid "PORTABILITY CONCERNS WITH BLOCK DEVICE NAMING"
2292 #: ../src/guestfs.pod:1119
2294 "Although the standard naming scheme and automatic translation is useful for "
2295 "simple programs and guestfish scripts, for larger programs it is best not to "
2296 "rely on this mechanism."
2300 #: ../src/guestfs.pod:1123
2302 "Where possible for maximum future portability programs using libguestfs "
2303 "should use these future-proof techniques:"
2307 #: ../src/guestfs.pod:1130
2309 "Use L</guestfs_list_devices> or L</guestfs_list_partitions> to list actual "
2310 "device names, and then use those names directly."
2314 #: ../src/guestfs.pod:1133
2316 "Since those device names exist by definition, they will never be translated."
2320 #: ../src/guestfs.pod:1138
2322 "Use higher level ways to identify filesystems, such as LVM names, UUIDs and "
2323 "filesystem labels."
2327 #: ../src/guestfs.pod:1143
2332 #: ../src/guestfs.pod:1145
2334 "This section discusses security implications of using libguestfs, "
2335 "particularly with untrusted or malicious guests or disk images."
2339 #: ../src/guestfs.pod:1148
2340 msgid "GENERAL SECURITY CONSIDERATIONS"
2344 #: ../src/guestfs.pod:1150
2346 "Be careful with any files or data that you download from a guest (by "
2347 "\"download\" we mean not just the L</guestfs_download> command but any "
2348 "command that reads files, filenames, directories or anything else from a "
2349 "disk image). An attacker could manipulate the data to fool your program "
2350 "into doing the wrong thing. Consider cases such as:"
2354 #: ../src/guestfs.pod:1160
2355 msgid "the data (file etc) not being present"
2359 #: ../src/guestfs.pod:1164
2360 msgid "being present but empty"
2364 #: ../src/guestfs.pod:1168
2365 msgid "being much larger than normal"
2369 #: ../src/guestfs.pod:1172
2370 msgid "containing arbitrary 8 bit data"
2374 #: ../src/guestfs.pod:1176
2375 msgid "being in an unexpected character encoding"
2379 #: ../src/guestfs.pod:1180
2380 msgid "containing homoglyphs."
2384 #: ../src/guestfs.pod:1184
2385 msgid "SECURITY OF MOUNTING FILESYSTEMS"
2389 #: ../src/guestfs.pod:1186
2391 "When you mount a filesystem under Linux, mistakes in the kernel filesystem "
2392 "(VFS) module can sometimes be escalated into exploits by deliberately "
2393 "creating a malicious, malformed filesystem. These exploits are very severe "
2394 "for two reasons. Firstly there are very many filesystem drivers in the "
2395 "kernel, and many of them are infrequently used and not much developer "
2396 "attention has been paid to the code. Linux userspace helps potential "
2397 "crackers by detecting the filesystem type and automatically choosing the "
2398 "right VFS driver, even if that filesystem type is obscure or unexpected for "
2399 "the administrator. Secondly, a kernel-level exploit is like a local root "
2400 "exploit (worse in some ways), giving immediate and total access to the "
2401 "system right down to the hardware level."
2405 #: ../src/guestfs.pod:1199
2407 "That explains why you should never mount a filesystem from an untrusted "
2408 "guest on your host kernel. How about libguestfs? We run a Linux kernel "
2409 "inside a qemu virtual machine, usually running as a non-root user. The "
2410 "attacker would need to write a filesystem which first exploited the kernel, "
2411 "and then exploited either qemu virtualization (eg. a faulty qemu driver) or "
2412 "the libguestfs protocol, and finally to be as serious as the host kernel "
2413 "exploit it would need to escalate its privileges to root. This multi-step "
2414 "escalation, performed by a static piece of data, is thought to be extremely "
2415 "hard to do, although we never say 'never' about security issues."
2419 #: ../src/guestfs.pod:1210
2421 "In any case callers can reduce the attack surface by forcing the filesystem "
2422 "type when mounting (use L</guestfs_mount_vfs>)."
2426 #: ../src/guestfs.pod:1213
2427 msgid "PROTOCOL SECURITY"
2431 #: ../src/guestfs.pod:1215
2433 "The protocol is designed to be secure, being based on RFC 4506 (XDR) with a "
2434 "defined upper message size. However a program that uses libguestfs must "
2435 "also take care - for example you can write a program that downloads a binary "
2436 "from a disk image and executes it locally, and no amount of protocol "
2437 "security will save you from the consequences."
2441 #: ../src/guestfs.pod:1221
2442 msgid "INSPECTION SECURITY"
2446 #: ../src/guestfs.pod:1223
2448 "Parts of the inspection API (see L</INSPECTION>) return untrusted strings "
2449 "directly from the guest, and these could contain any 8 bit data. Callers "
2450 "should be careful to escape these before printing them to a structured file "
2451 "(for example, use HTML escaping if creating a web page)."
2455 #: ../src/guestfs.pod:1229
2457 "Guest configuration may be altered in unusual ways by the administrator of "
2458 "the virtual machine, and may not reflect reality (particularly for untrusted "
2459 "or actively malicious guests). For example we parse the hostname from "
2460 "configuration files like C</etc/sysconfig/network> that we find in the "
2461 "guest, but the guest administrator can easily manipulate these files to "
2462 "provide the wrong hostname."
2466 #: ../src/guestfs.pod:1237
2468 "The inspection API parses guest configuration using two external libraries: "
2469 "Augeas (Linux configuration) and hivex (Windows Registry). Both are "
2470 "designed to be robust in the face of malicious data, although denial of "
2471 "service attacks are still possible, for example with oversized configuration "
2476 #: ../src/guestfs.pod:1243
2477 msgid "RUNNING UNTRUSTED GUEST COMMANDS"
2481 #: ../src/guestfs.pod:1245
2483 "Be very cautious about running commands from the guest. By running a "
2484 "command in the guest, you are giving CPU time to a binary that you do not "
2485 "control, under the same user account as the library, albeit wrapped in qemu "
2486 "virtualization. More information and alternatives can be found in the "
2487 "section L</RUNNING COMMANDS>."
2491 #: ../src/guestfs.pod:1251
2492 msgid "CVE-2010-3851"
2493 msgstr "CVE-2010-3851"
2496 #: ../src/guestfs.pod:1253
2497 msgid "https://bugzilla.redhat.com/642934"
2498 msgstr "https://bugzilla.redhat.com/642934"
2501 #: ../src/guestfs.pod:1255
2503 "This security bug concerns the automatic disk format detection that qemu "
2504 "does on disk images."
2508 #: ../src/guestfs.pod:1258
2510 "A raw disk image is just the raw bytes, there is no header. Other disk "
2511 "images like qcow2 contain a special header. Qemu deals with this by looking "
2512 "for one of the known headers, and if none is found then assuming the disk "
2513 "image must be raw."
2517 #: ../src/guestfs.pod:1263
2519 "This allows a guest which has been given a raw disk image to write some "
2520 "other header. At next boot (or when the disk image is accessed by "
2521 "libguestfs) qemu would do autodetection and think the disk image format was, "
2522 "say, qcow2 based on the header written by the guest."
2526 #: ../src/guestfs.pod:1268
2528 "This in itself would not be a problem, but qcow2 offers many features, one "
2529 "of which is to allow a disk image to refer to another image (called the "
2530 "\"backing disk\"). It does this by placing the path to the backing disk "
2531 "into the qcow2 header. This path is not validated and could point to any "
2532 "host file (eg. \"/etc/passwd\"). The backing disk is then exposed through "
2533 "\"holes\" in the qcow2 disk image, which of course is completely under the "
2534 "control of the attacker."
2538 #: ../src/guestfs.pod:1276
2540 "In libguestfs this is rather hard to exploit except under two circumstances:"
2544 #: ../src/guestfs.pod:1283
2545 msgid "You have enabled the network or have opened the disk in write mode."
2549 #: ../src/guestfs.pod:1287
2551 "You are also running untrusted code from the guest (see L</RUNNING "
2556 #: ../src/guestfs.pod:1292
2558 "The way to avoid this is to specify the expected disk format when adding "
2559 "disks (the optional C<format> option to L</guestfs_add_drive_opts>). You "
2560 "should always do this if the disk is raw format, and it's a good idea for "
2565 #: ../src/guestfs.pod:1297
2567 "For disks added from libvirt using calls like L</guestfs_add_domain>, the "
2568 "format is fetched from libvirt and passed through."
2572 #: ../src/guestfs.pod:1300
2574 "For libguestfs tools, use the I<--format> command line parameter as "
2579 #: ../src/guestfs.pod:1303
2580 msgid "CONNECTION MANAGEMENT"
2584 #: ../src/guestfs.pod:1305
2589 #: ../src/guestfs.pod:1307
2591 "C<guestfs_h> is the opaque type representing a connection handle. Create a "
2592 "handle by calling L</guestfs_create>. Call L</guestfs_close> to free the "
2593 "handle and release all resources used."
2597 #: ../src/guestfs.pod:1311
2599 "For information on using multiple handles and threads, see the section L</"
2600 "MULTIPLE HANDLES AND MULTIPLE THREADS> below."
2604 #: ../src/guestfs.pod:1314
2605 msgid "guestfs_create"
2609 #: ../src/guestfs.pod:1316
2612 " guestfs_h *guestfs_create (void);\n"
2617 #: ../src/guestfs.pod:1318
2618 msgid "Create a connection handle."
2622 #: ../src/guestfs.pod:1320
2624 "You have to call L</guestfs_add_drive_opts> (or one of the equivalent calls) "
2625 "on the handle at least once."
2629 #: ../src/guestfs.pod:1323
2631 "This function returns a non-NULL pointer to a handle on success or NULL on "
2636 #: ../src/guestfs.pod:1326
2637 msgid "After configuring the handle, you have to call L</guestfs_launch>."
2641 #: ../src/guestfs.pod:1328
2643 "You may also want to configure error handling for the handle. See L</ERROR "
2644 "HANDLING> section below."
2648 #: ../src/guestfs.pod:1331
2649 msgid "guestfs_close"
2653 #: ../src/guestfs.pod:1333
2656 " void guestfs_close (guestfs_h *g);\n"
2661 #: ../src/guestfs.pod:1335
2662 msgid "This closes the connection handle and frees up all resources used."
2666 #: ../src/guestfs.pod:1337
2667 msgid "ERROR HANDLING"
2668 msgstr "ОБРОБКА ПОМИЛОК"
2671 #: ../src/guestfs.pod:1339
2673 "API functions can return errors. For example, almost all functions that "
2674 "return C<int> will return C<-1> to indicate an error."
2678 #: ../src/guestfs.pod:1342
2680 "Additional information is available for errors: an error message string and "
2681 "optionally an error number (errno) if the thing that failed was a system "
2686 #: ../src/guestfs.pod:1346
2688 "You can get at the additional information about the last error on the handle "
2689 "by calling L</guestfs_last_error>, L</guestfs_last_errno>, and/or by setting "
2690 "up an error handler with L</guestfs_set_error_handler>."
2694 #: ../src/guestfs.pod:1351
2696 "When the handle is created, a default error handler is installed which "
2697 "prints the error message string to C<stderr>. For small short-running "
2698 "command line programs it is sufficient to do:"
2702 #: ../src/guestfs.pod:1355
2705 " if (guestfs_launch (g) == -1)\n"
2706 " exit (EXIT_FAILURE);\n"
2711 #: ../src/guestfs.pod:1358
2713 "since the default error handler will ensure that an error message has been "
2714 "printed to C<stderr> before the program exits."
2718 #: ../src/guestfs.pod:1361
2720 "For other programs the caller will almost certainly want to install an "
2721 "alternate error handler or do error handling in-line like this:"
2725 #: ../src/guestfs.pod:1364
2728 " g = guestfs_create ();\n"
2733 #: ../src/guestfs.pod:1366
2736 " /* This disables the default behaviour of printing errors\n"
2738 " guestfs_set_error_handler (g, NULL, NULL);\n"
2743 #: ../src/guestfs.pod:1370
2746 " if (guestfs_launch (g) == -1) {\n"
2747 " /* Examine the error message and print it etc. */\n"
2748 " char *msg = guestfs_last_error (g);\n"
2749 " int errnum = guestfs_last_errno (g);\n"
2750 " fprintf (stderr, \"%s\\n\", msg);\n"
2757 #: ../src/guestfs.pod:1378
2759 "Out of memory errors are handled differently. The default action is to call "
2760 "L<abort(3)>. If this is undesirable, then you can set a handler using L</"
2761 "guestfs_set_out_of_memory_handler>."
2765 #: ../src/guestfs.pod:1382
2767 "L</guestfs_create> returns C<NULL> if the handle cannot be created, and "
2768 "because there is no handle if this happens there is no way to get additional "
2769 "error information. However L</guestfs_create> is supposed to be a "
2770 "lightweight operation which can only fail because of insufficient memory (it "
2771 "returns NULL in this case)."
2775 #: ../src/guestfs.pod:1388
2776 msgid "guestfs_last_error"
2780 #: ../src/guestfs.pod:1390
2783 " const char *guestfs_last_error (guestfs_h *g);\n"
2788 #: ../src/guestfs.pod:1392
2790 "This returns the last error message that happened on C<g>. If there has not "
2791 "been an error since the handle was created, then this returns C<NULL>."
2795 #: ../src/guestfs.pod:1396
2797 "The lifetime of the returned string is until the next error occurs, or L</"
2798 "guestfs_close> is called."
2802 #: ../src/guestfs.pod:1399
2803 msgid "guestfs_last_errno"
2807 #: ../src/guestfs.pod:1401
2810 " int guestfs_last_errno (guestfs_h *g);\n"
2815 #: ../src/guestfs.pod:1403
2816 msgid "This returns the last error number (errno) that happened on C<g>."
2820 #: ../src/guestfs.pod:1405
2821 msgid "If successful, an errno integer not equal to zero is returned."
2825 #: ../src/guestfs.pod:1407
2827 "If no error, this returns 0. This call can return 0 in three situations:"
2831 #: ../src/guestfs.pod:1414
2832 msgid "There has not been any error on the handle."
2836 #: ../src/guestfs.pod:1418
2838 "There has been an error but the errno was meaningless. This corresponds to "
2839 "the case where the error did not come from a failed system call, but for "
2840 "some other reason."
2844 #: ../src/guestfs.pod:1424
2846 "There was an error from a failed system call, but for some reason the errno "
2847 "was not captured and returned. This usually indicates a bug in libguestfs."
2851 #: ../src/guestfs.pod:1430
2853 "Libguestfs tries to convert the errno from inside the applicance into a "
2854 "corresponding errno for the caller (not entirely trivial: the appliance "
2855 "might be running a completely different operating system from the library "
2856 "and error numbers are not standardized across Un*xen). If this could not be "
2857 "done, then the error is translated to C<EINVAL>. In practice this should "
2858 "only happen in very rare circumstances."
2862 #: ../src/guestfs.pod:1438
2863 msgid "guestfs_set_error_handler"
2867 #: ../src/guestfs.pod:1440
2870 " typedef void (*guestfs_error_handler_cb) (guestfs_h *g,\n"
2872 " const char *msg);\n"
2873 " void guestfs_set_error_handler (guestfs_h *g,\n"
2874 " guestfs_error_handler_cb cb,\n"
2880 #: ../src/guestfs.pod:1447
2882 "The callback C<cb> will be called if there is an error. The parameters "
2883 "passed to the callback are an opaque data pointer and the error message "
2888 #: ../src/guestfs.pod:1451
2890 "C<errno> is not passed to the callback. To get that the callback must call "
2891 "L</guestfs_last_errno>."
2895 #: ../src/guestfs.pod:1454
2897 "Note that the message string C<msg> is freed as soon as the callback "
2898 "function returns, so if you want to stash it somewhere you must make your "
2903 #: ../src/guestfs.pod:1458
2904 msgid "The default handler prints messages on C<stderr>."
2908 #: ../src/guestfs.pod:1460
2909 msgid "If you set C<cb> to C<NULL> then I<no> handler is called."
2913 #: ../src/guestfs.pod:1462
2914 msgid "guestfs_get_error_handler"
2918 #: ../src/guestfs.pod:1464
2921 " guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g,\n"
2922 " void **opaque_rtn);\n"
2927 #: ../src/guestfs.pod:1467
2928 msgid "Returns the current error handler callback."
2932 #: ../src/guestfs.pod:1469
2933 msgid "guestfs_set_out_of_memory_handler"
2937 #: ../src/guestfs.pod:1471
2940 " typedef void (*guestfs_abort_cb) (void);\n"
2941 " int guestfs_set_out_of_memory_handler (guestfs_h *g,\n"
2942 " guestfs_abort_cb);\n"
2947 #: ../src/guestfs.pod:1475
2949 "The callback C<cb> will be called if there is an out of memory situation. "
2950 "I<Note this callback must not return>."
2954 #: ../src/guestfs.pod:1478
2955 msgid "The default is to call L<abort(3)>."
2959 #: ../src/guestfs.pod:1480
2961 "You cannot set C<cb> to C<NULL>. You can't ignore out of memory situations."
2965 #: ../src/guestfs.pod:1483
2966 msgid "guestfs_get_out_of_memory_handler"
2970 #: ../src/guestfs.pod:1485
2973 " guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n"
2978 #: ../src/guestfs.pod:1487
2979 msgid "This returns the current out of memory handler."
2983 #: ../src/guestfs.pod:1489
2988 #: ../src/guestfs.pod:1491 ../fish/guestfish.pod:1003
2993 #: ../src/guestfs.pod:1493
2998 #: ../src/guestfs.pod:1495
3003 #: ../src/guestfs.pod:1497
3004 msgid "AVAILABILITY"
3008 #: ../src/guestfs.pod:1499
3009 msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE"
3013 #: ../src/guestfs.pod:1501
3015 "Using L</guestfs_available> you can test availability of the following "
3016 "groups of functions. This test queries the appliance to see if the "
3017 "appliance you are currently using supports the functionality."
3021 #: ../src/guestfs.pod:1506
3022 msgid "@AVAILABILITY@"
3026 #: ../src/guestfs.pod:1508
3027 msgid "GUESTFISH supported COMMAND"
3031 #: ../src/guestfs.pod:1510
3033 "In L<guestfish(3)> there is a handy interactive command C<supported> which "
3034 "prints out the available groups and whether they are supported by this build "
3035 "of libguestfs. Note however that you have to do C<run> first."
3039 #: ../src/guestfs.pod:1515
3040 msgid "SINGLE CALLS AT COMPILE TIME"
3044 #: ../src/guestfs.pod:1517
3046 "Since version 1.5.8, C<E<lt>guestfs.hE<gt>> defines symbols for each C API "
3047 "function, such as:"
3051 #: ../src/guestfs.pod:1520
3054 " #define LIBGUESTFS_HAVE_DD 1\n"
3059 #: ../src/guestfs.pod:1522
3060 msgid "if L</guestfs_dd> is available."
3064 #: ../src/guestfs.pod:1524
3066 "Before version 1.5.8, if you needed to test whether a single libguestfs "
3067 "function is available at compile time, we recommended using build tools such "
3068 "as autoconf or cmake. For example in autotools you could use:"
3072 #: ../src/guestfs.pod:1529
3075 " AC_CHECK_LIB([guestfs],[guestfs_create])\n"
3076 " AC_CHECK_FUNCS([guestfs_dd])\n"
3081 #: ../src/guestfs.pod:1532
3083 "which would result in C<HAVE_GUESTFS_DD> being either defined or not defined "
3088 #: ../src/guestfs.pod:1535
3089 msgid "SINGLE CALLS AT RUN TIME"
3093 #: ../src/guestfs.pod:1537
3095 "Testing at compile time doesn't guarantee that a function really exists in "
3096 "the library. The reason is that you might be dynamically linked against a "
3097 "previous I<libguestfs.so> (dynamic library) which doesn't have the call. "
3098 "This situation unfortunately results in a segmentation fault, which is a "
3099 "shortcoming of the C dynamic linking system itself."
3103 #: ../src/guestfs.pod:1544
3105 "You can use L<dlopen(3)> to test if a function is available at run time, as "
3106 "in this example program (note that you still need the compile time check as "
3111 #: ../src/guestfs.pod:1548
3114 " #include <stdio.h>\n"
3115 " #include <stdlib.h>\n"
3116 " #include <unistd.h>\n"
3117 " #include <dlfcn.h>\n"
3118 " #include <guestfs.h>\n"
3123 #: ../src/guestfs.pod:1554
3128 " #ifdef LIBGUESTFS_HAVE_DD\n"
3130 " int has_function;\n"
3135 #: ../src/guestfs.pod:1560
3138 " /* Test if the function guestfs_dd is really available. */\n"
3139 " dl = dlopen (NULL, RTLD_LAZY);\n"
3141 " fprintf (stderr, \"dlopen: %s\\n\", dlerror ());\n"
3142 " exit (EXIT_FAILURE);\n"
3144 " has_function = dlsym (dl, \"guestfs_dd\") != NULL;\n"
3150 #: ../src/guestfs.pod:1569
3153 " if (!has_function)\n"
3154 " printf (\"this libguestfs.so does NOT have guestfs_dd function\\n\");\n"
3156 " printf (\"this libguestfs.so has guestfs_dd function\\n\");\n"
3157 " /* Now it's safe to call\n"
3158 " guestfs_dd (g, \"foo\", \"bar\");\n"
3162 " printf (\"guestfs_dd function was not found at compile time\\n\");\n"
3169 #: ../src/guestfs.pod:1582
3171 "You may think the above is an awful lot of hassle, and it is. There are "
3172 "other ways outside of the C linking system to ensure that this kind of "
3173 "incompatibility never arises, such as using package versioning:"
3177 #: ../src/guestfs.pod:1587
3180 " Requires: libguestfs >= 1.0.80\n"
3185 #: ../src/guestfs.pod:1589
3186 msgid "CALLS WITH OPTIONAL ARGUMENTS"
3190 #: ../src/guestfs.pod:1591
3192 "A recent feature of the API is the introduction of calls which take optional "
3193 "arguments. In C these are declared 3 ways. The main way is as a call which "
3194 "takes variable arguments (ie. C<...>), as in this example:"
3198 #: ../src/guestfs.pod:1596
3201 " int guestfs_add_drive_opts (guestfs_h *g, const char *filename, ...);\n"
3206 #: ../src/guestfs.pod:1598
3208 "Call this with a list of optional arguments, terminated by C<-1>. So to "
3209 "call with no optional arguments specified:"
3213 #: ../src/guestfs.pod:1601
3216 " guestfs_add_drive_opts (g, filename, -1);\n"
3221 #: ../src/guestfs.pod:1603
3222 msgid "With a single optional argument:"
3226 #: ../src/guestfs.pod:1605
3229 " guestfs_add_drive_opts (g, filename,\n"
3230 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
3236 #: ../src/guestfs.pod:1609
3241 #: ../src/guestfs.pod:1611
3244 " guestfs_add_drive_opts (g, filename,\n"
3245 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
3246 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
3252 #: ../src/guestfs.pod:1616
3254 "and so forth. Don't forget the terminating C<-1> otherwise Bad Things will "
3259 #: ../src/guestfs.pod:1619
3260 msgid "USING va_list FOR OPTIONAL ARGUMENTS"
3264 #: ../src/guestfs.pod:1621
3266 "The second variant has the same name with the suffix C<_va>, which works the "
3267 "same way but takes a C<va_list>. See the C manual for details. For the "
3268 "example function, this is declared:"
3272 #: ../src/guestfs.pod:1625
3275 " int guestfs_add_drive_opts_va (guestfs_h *g, const char *filename,\n"
3281 #: ../src/guestfs.pod:1628
3282 msgid "CONSTRUCTING OPTIONAL ARGUMENTS"
3286 #: ../src/guestfs.pod:1630
3288 "The third variant is useful where you need to construct these calls. You "
3289 "pass in a structure where you fill in the optional fields. The structure "
3290 "has a bitmask as the first element which you must set to indicate which "
3291 "fields you have filled in. For our example function the structure and call "
3296 #: ../src/guestfs.pod:1636
3299 " struct guestfs_add_drive_opts_argv {\n"
3300 " uint64_t bitmask;\n"
3302 " const char *format;\n"
3305 " int guestfs_add_drive_opts_argv (guestfs_h *g, const char *filename,\n"
3306 " const struct guestfs_add_drive_opts_argv *optargs);\n"
3311 #: ../src/guestfs.pod:1645
3312 msgid "You could call it like this:"
3316 #: ../src/guestfs.pod:1647
3319 " struct guestfs_add_drive_opts_argv optargs = {\n"
3320 " .bitmask = GUESTFS_ADD_DRIVE_OPTS_READONLY_BITMASK |\n"
3321 " GUESTFS_ADD_DRIVE_OPTS_FORMAT_BITMASK,\n"
3323 " .format = \"qcow2\"\n"
3329 #: ../src/guestfs.pod:1654
3332 " guestfs_add_drive_opts_argv (g, filename, &optargs);\n"
3337 #: ../src/guestfs.pod:1656 ../src/guestfs-actions.pod:11
3338 #: ../src/guestfs-actions.pod:1855 ../fish/guestfish-actions.pod:9
3339 #: ../fish/guestfish-actions.pod:1260 ../tools/virt-win-reg.pl:532
3344 #: ../src/guestfs.pod:1662
3345 msgid "The C<_BITMASK> suffix on each option name when specifying the bitmask."
3349 #: ../src/guestfs.pod:1667
3350 msgid "You do not need to fill in all fields of the structure."
3354 #: ../src/guestfs.pod:1671
3356 "There must be a one-to-one correspondence between fields of the structure "
3357 "that are filled in, and bits set in the bitmask."
3361 #: ../src/guestfs.pod:1676
3362 msgid "OPTIONAL ARGUMENTS IN OTHER LANGUAGES"
3366 #: ../src/guestfs.pod:1678
3368 "In other languages, optional arguments are expressed in the way that is "
3369 "natural for that language. We refer you to the language-specific "
3370 "documentation for more details on that."
3374 #: ../src/guestfs.pod:1682
3375 msgid "For guestfish, see L<guestfish(1)/OPTIONAL ARGUMENTS>."
3379 #: ../src/guestfs.pod:1684
3380 msgid "SETTING CALLBACKS TO HANDLE EVENTS"
3384 #: ../src/guestfs.pod:1686
3386 "B<Note:> This section documents the generic event mechanism introduced in "
3387 "libguestfs 1.10, which you should use in new code if possible. The old "
3388 "functions C<guestfs_set_log_message_callback>, "
3389 "C<guestfs_set_subprocess_quit_callback>, "
3390 "C<guestfs_set_launch_done_callback>, C<guestfs_set_close_callback> and "
3391 "C<guestfs_set_progress_callback> are no longer documented in this manual "
3396 #: ../src/guestfs.pod:1694
3398 "Handles generate events when certain things happen, such as log messages "
3399 "being generated, progress messages during long-running operations, or the "
3400 "handle being closed. The API calls described below let you register a "
3401 "callback to be called when events happen. You can register multiple "
3402 "callbacks (for the same, different or overlapping sets of events), and "
3403 "individually remove callbacks. If callbacks are not removed, then they "
3404 "remain in force until the handle is closed."
3408 #: ../src/guestfs.pod:1702
3410 "In the current implementation, events are only generated synchronously: that "
3411 "means that events (and hence callbacks) can only happen while you are in the "
3412 "middle of making another libguestfs call. The callback is called in the "
3417 #: ../src/guestfs.pod:1707
3419 "Events may contain a payload, usually nothing (void), an array of 64 bit "
3420 "unsigned integers, or a message buffer. Payloads are discussed later on."
3424 #: ../src/guestfs.pod:1711
3425 msgid "CLASSES OF EVENTS"
3429 #: ../src/guestfs.pod:1715
3430 msgid "GUESTFS_EVENT_CLOSE (payload type: void)"
3434 #: ../src/guestfs.pod:1718
3436 "The callback function will be called while the handle is being closed "
3437 "(synchronously from L</guestfs_close>)."
3441 #: ../src/guestfs.pod:1721
3443 "Note that libguestfs installs an L<atexit(3)> handler to try to clean up "
3444 "handles that are open when the program exits. This means that this callback "
3445 "might be called indirectly from L<exit(3)>, which can cause unexpected "
3446 "problems in higher-level languages (eg. if your HLL interpreter has already "
3447 "been cleaned up by the time this is called, and if your callback then jumps "
3448 "into some HLL function)."
3452 #: ../src/guestfs.pod:1728
3454 "If no callback is registered: the handle is closed without any callback "
3459 #: ../src/guestfs.pod:1731
3460 msgid "GUESTFS_EVENT_SUBPROCESS_QUIT (payload type: void)"
3464 #: ../src/guestfs.pod:1734
3466 "The callback function will be called when the child process quits, either "
3467 "asynchronously or if killed by L</guestfs_kill_subprocess>. (This "
3468 "corresponds to a transition from any state to the CONFIG state)."
3472 #: ../src/guestfs.pod:1738 ../src/guestfs.pod:1747
3473 msgid "If no callback is registered: the event is ignored."
3477 #: ../src/guestfs.pod:1740
3478 msgid "GUESTFS_EVENT_LAUNCH_DONE (payload type: void)"
3482 #: ../src/guestfs.pod:1743
3484 "The callback function will be called when the child process becomes ready "
3485 "first time after it has been launched. (This corresponds to a transition "
3486 "from LAUNCHING to the READY state)."
3490 #: ../src/guestfs.pod:1749
3491 msgid "GUESTFS_EVENT_PROGRESS (payload type: array of 4 x uint64_t)"
3495 #: ../src/guestfs.pod:1752
3497 "Some long-running operations can generate progress messages. If this "
3498 "callback is registered, then it will be called each time a progress message "
3499 "is generated (usually two seconds after the operation started, and three "
3500 "times per second thereafter until it completes, although the frequency may "
3501 "change in future versions)."
3505 #: ../src/guestfs.pod:1758
3507 "The callback receives in the payload four unsigned 64 bit numbers which are "
3508 "(in order): C<proc_nr>, C<serial>, C<position>, C<total>."
3512 #: ../src/guestfs.pod:1761
3514 "The units of C<total> are not defined, although for some operations C<total> "
3515 "may relate in some way to the amount of data to be transferred (eg. in bytes "
3516 "or megabytes), and C<position> may be the portion which has been transferred."
3520 #: ../src/guestfs.pod:1766
3521 msgid "The only defined and stable parts of the API are:"
3525 #: ../src/guestfs.pod:1772
3527 "The callback can display to the user some type of progress bar or indicator "
3528 "which shows the ratio of C<position>:C<total>."
3532 #: ../src/guestfs.pod:1777
3533 msgid "0 E<lt>= C<position> E<lt>= C<total>"
3537 #: ../src/guestfs.pod:1781
3539 "If any progress notification is sent during a call, then a final progress "
3540 "notification is always sent when C<position> = C<total> (I<unless> the call "
3541 "fails with an error)."
3545 #: ../src/guestfs.pod:1785
3547 "This is to simplify caller code, so callers can easily set the progress "
3548 "indicator to \"100%\" at the end of the operation, without requiring special "
3549 "code to detect this case."
3553 #: ../src/guestfs.pod:1791
3555 "For some calls we are unable to estimate the progress of the call, but we "
3556 "can still generate progress messages to indicate activity. This is known as "
3557 "\"pulse mode\", and is directly supported by certain progress bar "
3558 "implementations (eg. GtkProgressBar)."
3562 #: ../src/guestfs.pod:1796
3564 "For these calls, zero or more progress messages are generated with "
3565 "C<position = 0> and C<total = 1>, followed by a final message with "
3566 "C<position = total = 1>."
3570 #: ../src/guestfs.pod:1800
3572 "As noted above, if the call fails with an error then the final message may "
3577 #: ../src/guestfs.pod:1805
3579 "The callback also receives the procedure number (C<proc_nr>) and serial "
3580 "number (C<serial>) of the call. These are only useful for debugging "
3581 "protocol issues, and the callback can normally ignore them. The callback "
3582 "may want to print these numbers in error messages or debugging messages."
3586 #: ../src/guestfs.pod:1811
3587 msgid "If no callback is registered: progress messages are discarded."
3591 #: ../src/guestfs.pod:1813
3592 msgid "GUESTFS_EVENT_APPLIANCE (payload type: message buffer)"
3596 #: ../src/guestfs.pod:1816
3598 "The callback function is called whenever a log message is generated by qemu, "
3599 "the appliance kernel, guestfsd (daemon), or utility programs."
3603 #: ../src/guestfs.pod:1819
3605 "If the verbose flag (L</guestfs_set_verbose>) is set before launch (L</"
3606 "guestfs_launch>) then additional debug messages are generated."
3610 #: ../src/guestfs.pod:1822 ../src/guestfs.pod:1836
3612 "If no callback is registered: the messages are discarded unless the verbose "
3613 "flag is set in which case they are sent to stderr. You can override the "
3614 "printing of verbose messages to stderr by setting up a callback."
3618 #: ../src/guestfs.pod:1827
3619 msgid "GUESTFS_EVENT_LIBRARY (payload type: message buffer)"
3623 #: ../src/guestfs.pod:1830
3625 "The callback function is called whenever a log message is generated by the "
3626 "library part of libguestfs."
3630 #: ../src/guestfs.pod:1833
3632 "If the verbose flag (L</guestfs_set_verbose>) is set then additional debug "
3633 "messages are generated."
3637 #: ../src/guestfs.pod:1841
3638 msgid "GUESTFS_EVENT_TRACE (payload type: message buffer)"
3642 #: ../src/guestfs.pod:1844
3644 "The callback function is called whenever a trace message is generated. This "
3645 "only applies if the trace flag (L</guestfs_set_trace>) is set."
3649 #: ../src/guestfs.pod:1847
3651 "If no callback is registered: the messages are sent to stderr. You can "
3652 "override the printing of trace messages to stderr by setting up a callback."
3656 #: ../src/guestfs.pod:1853
3657 msgid "guestfs_set_event_callback"
3661 #: ../src/guestfs.pod:1855
3664 " int guestfs_set_event_callback (guestfs_h *g,\n"
3665 " guestfs_event_callback cb,\n"
3666 " uint64_t event_bitmask,\n"
3673 #: ../src/guestfs.pod:1861
3675 "This function registers a callback (C<cb>) for all event classes in the "
3680 #: ../src/guestfs.pod:1864
3682 "For example, to register for all log message events, you could call this "
3683 "function with the bitmask C<GUESTFS_EVENT_APPLIANCE|GUESTFS_EVENT_LIBRARY>. "
3684 "To register a single callback for all possible classes of events, use "
3685 "C<GUESTFS_EVENT_ALL>."
3689 #: ../src/guestfs.pod:1870
3690 msgid "C<flags> should always be passed as 0."
3694 #: ../src/guestfs.pod:1872
3696 "C<opaque> is an opaque pointer which is passed to the callback. You can use "
3697 "it for any purpose."
3701 #: ../src/guestfs.pod:1875
3703 "The return value is the event handle (an integer) which you can use to "
3704 "delete the callback (see below)."
3708 #: ../src/guestfs.pod:1878
3710 "If there is an error, this function returns C<-1>, and sets the error in the "
3711 "handle in the usual way (see L</guestfs_last_error> etc.)"
3715 #: ../src/guestfs.pod:1881
3717 "Callbacks remain in effect until they are deleted, or until the handle is "
3722 #: ../src/guestfs.pod:1884
3724 "In the case where multiple callbacks are registered for a particular event "
3725 "class, all of the callbacks are called. The order in which multiple "
3726 "callbacks are called is not defined."
3730 #: ../src/guestfs.pod:1888
3731 msgid "guestfs_delete_event_callback"
3735 #: ../src/guestfs.pod:1890
3738 " void guestfs_delete_event_callback (guestfs_h *g, int event_handle);\n"
3743 #: ../src/guestfs.pod:1892
3745 "Delete a callback that was previously registered. C<event_handle> should be "
3746 "the integer that was returned by a previous call to "
3747 "C<guestfs_set_event_callback> on the same handle."
3751 #: ../src/guestfs.pod:1896
3752 msgid "guestfs_event_callback"
3756 #: ../src/guestfs.pod:1898
3759 " typedef void (*guestfs_event_callback) (\n"
3762 " uint64_t event,\n"
3763 " int event_handle,\n"
3765 " const char *buf, size_t buf_len,\n"
3766 " const uint64_t *array, size_t array_len);\n"
3771 #: ../src/guestfs.pod:1907
3773 "This is the type of the event callback function that you have to provide."
3777 #: ../src/guestfs.pod:1910
3779 "The basic parameters are: the handle (C<g>), the opaque user pointer "
3780 "(C<opaque>), the event class (eg. C<GUESTFS_EVENT_PROGRESS>), the event "
3781 "handle, and C<flags> which in the current API you should ignore."
3785 #: ../src/guestfs.pod:1914
3787 "The remaining parameters contain the event payload (if any). Each event may "
3788 "contain a payload, which usually relates to the event class, but for future "
3789 "proofing your code should be written to handle any payload for any event "
3794 #: ../src/guestfs.pod:1919
3796 "C<buf> and C<buf_len> contain a message buffer (if C<buf_len == 0>, then "
3797 "there is no message buffer). Note that this message buffer can contain "
3798 "arbitrary 8 bit data, including NUL bytes."
3802 #: ../src/guestfs.pod:1923
3804 "C<array> and C<array_len> is an array of 64 bit unsigned integers. At the "
3805 "moment this is only used for progress messages."
3809 #: ../src/guestfs.pod:1926
3810 msgid "EXAMPLE: CAPTURING LOG MESSAGES"
3814 #: ../src/guestfs.pod:1928
3816 "One motivation for the generic event API was to allow GUI programs to "
3817 "capture debug and other messages. In libguestfs E<le> 1.8 these were sent "
3818 "unconditionally to C<stderr>."
3822 #: ../src/guestfs.pod:1932
3824 "Events associated with log messages are: C<GUESTFS_EVENT_LIBRARY>, "
3825 "C<GUESTFS_EVENT_APPLIANCE> and C<GUESTFS_EVENT_TRACE>. (Note that error "
3826 "messages are not events; you must capture error messages separately)."
3830 #: ../src/guestfs.pod:1937
3832 "Programs have to set up a callback to capture the classes of events of "
3837 #: ../src/guestfs.pod:1940
3841 " guestfs_set_event_callback\n"
3842 " (g, message_callback,\n"
3843 " GUESTFS_EVENT_LIBRARY|GUESTFS_EVENT_APPLIANCE|\n"
3844 " GUESTFS_EVENT_TRACE,\n"
3845 " 0, NULL) == -1)\n"
3846 " if (eh == -1) {\n"
3847 " // handle error in the usual way\n"
3853 #: ../src/guestfs.pod:1950
3855 "The callback can then direct messages to the appropriate place. In this "
3856 "example, messages are directed to syslog:"
3860 #: ../src/guestfs.pod:1953
3864 " message_callback (\n"
3867 " uint64_t event,\n"
3868 " int event_handle,\n"
3870 " const char *buf, size_t buf_len,\n"
3871 " const uint64_t *array, size_t array_len)\n"
3873 " const int priority = LOG_USER|LOG_INFO;\n"
3874 " if (buf_len > 0)\n"
3875 " syslog (priority, \"event 0x%lx: %s\", event, buf);\n"
3881 #: ../src/guestfs.pod:1968
3882 msgid "PRIVATE DATA AREA"
3886 #: ../src/guestfs.pod:1970
3888 "You can attach named pieces of private data to the libguestfs handle, fetch "
3889 "them by name, and walk over them, for the lifetime of the handle. This is "
3890 "called the private data area and is only available from the C API."
3894 #: ../src/guestfs.pod:1975
3895 msgid "To attach a named piece of data, use the following call:"
3899 #: ../src/guestfs.pod:1977
3902 " void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n"
3907 #: ../src/guestfs.pod:1979
3909 "C<key> is the name to associate with this data, and C<data> is an arbitrary "
3910 "pointer (which can be C<NULL>). Any previous item with the same name is "
3915 #: ../src/guestfs.pod:1983
3917 "You can use any C<key> you want, but names beginning with an underscore "
3918 "character are reserved for internal libguestfs purposes (for implementing "
3919 "language bindings). It is recommended to prefix the name with some unique "
3920 "string to avoid collisions with other users."
3924 #: ../src/guestfs.pod:1988
3925 msgid "To retrieve the pointer, use:"
3929 #: ../src/guestfs.pod:1990
3932 " void *guestfs_get_private (guestfs_h *g, const char *key);\n"
3937 #: ../src/guestfs.pod:1992
3939 "This function returns C<NULL> if either no data is found associated with "
3940 "C<key>, or if the user previously set the C<key>'s C<data> pointer to "
3945 #: ../src/guestfs.pod:1996
3947 "Libguestfs does not try to look at or interpret the C<data> pointer in any "
3948 "way. As far as libguestfs is concerned, it need not be a valid pointer at "
3949 "all. In particular, libguestfs does I<not> try to free the data when the "
3950 "handle is closed. If the data must be freed, then the caller must either "
3951 "free it before calling L</guestfs_close> or must set up a close callback to "
3952 "do it (see L</GUESTFS_EVENT_CLOSE>)."
3956 #: ../src/guestfs.pod:2003
3957 msgid "To walk over all entries, use these two functions:"
3961 #: ../src/guestfs.pod:2005
3964 " void *guestfs_first_private (guestfs_h *g, const char **key_rtn);\n"
3969 #: ../src/guestfs.pod:2007
3972 " void *guestfs_next_private (guestfs_h *g, const char **key_rtn);\n"
3977 #: ../src/guestfs.pod:2009
3979 "C<guestfs_first_private> returns the first key, pointer pair (\"first\" does "
3980 "not have any particular meaning -- keys are not returned in any defined "
3981 "order). A pointer to the key is returned in C<*key_rtn> and the "
3982 "corresponding data pointer is returned from the function. C<NULL> is "
3983 "returned if there are no keys stored in the handle."
3987 #: ../src/guestfs.pod:2015
3989 "C<guestfs_next_private> returns the next key, pointer pair. The return "
3990 "value of this function is also C<NULL> is there are no further entries to "
3995 #: ../src/guestfs.pod:2019
3996 msgid "Notes about walking over entries:"
4000 #: ../src/guestfs.pod:2025
4002 "You must not call C<guestfs_set_private> while walking over the entries."
4006 #: ../src/guestfs.pod:2030
4008 "The handle maintains an internal iterator which is reset when you call "
4009 "C<guestfs_first_private>. This internal iterator is invalidated when you "
4010 "call C<guestfs_set_private>."
4014 #: ../src/guestfs.pod:2036
4015 msgid "If you have set the data pointer associated with a key to C<NULL>, ie:"
4019 #: ../src/guestfs.pod:2038
4022 " guestfs_set_private (g, key, NULL);\n"
4027 #: ../src/guestfs.pod:2040
4028 msgid "then that C<key> is not returned when walking."
4032 #: ../src/guestfs.pod:2044
4034 "C<*key_rtn> is only valid until the next call to C<guestfs_first_private>, "
4035 "C<guestfs_next_private> or C<guestfs_set_private>."
4039 #: ../src/guestfs.pod:2050
4041 "The following example code shows how to print all keys and data pointers "
4042 "that are associated with the handle C<g>:"
4046 #: ../src/guestfs.pod:2053
4049 " const char *key;\n"
4050 " void *data = guestfs_first_private (g, &key);\n"
4051 " while (data != NULL)\n"
4053 " printf (\"key = %s, data = %p\\n\", key, data);\n"
4054 " data = guestfs_next_private (g, &key);\n"
4060 #: ../src/guestfs.pod:2061
4062 "More commonly you are only interested in keys that begin with an application-"
4063 "specific prefix C<foo_>. Modify the loop like so:"
4067 #: ../src/guestfs.pod:2064
4070 " const char *key;\n"
4071 " void *data = guestfs_first_private (g, &key);\n"
4072 " while (data != NULL)\n"
4074 " if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
4075 " printf (\"key = %s, data = %p\\n\", key, data);\n"
4076 " data = guestfs_next_private (g, &key);\n"
4082 #: ../src/guestfs.pod:2073
4084 "If you need to modify keys while walking, then you have to jump back to the "
4085 "beginning of the loop. For example, to delete all keys prefixed with "
4090 #: ../src/guestfs.pod:2077
4093 " const char *key;\n"
4096 " data = guestfs_first_private (g, &key);\n"
4097 " while (data != NULL)\n"
4099 " if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
4101 " guestfs_set_private (g, key, NULL);\n"
4102 " /* note that 'key' pointer is now invalid, and so is\n"
4103 " the internal iterator */\n"
4106 " data = guestfs_next_private (g, &key);\n"
4112 #: ../src/guestfs.pod:2093
4114 "Note that the above loop is guaranteed to terminate because the keys are "
4115 "being deleted, but other manipulations of keys within the loop might not "
4116 "terminate unless you also maintain an indication of which keys have been "
4121 #: ../src/guestfs.pod:2098 ../src/guestfs.pod:2103
4126 #: ../src/guestfs.pod:2100
4128 "<!-- old anchor for the next section --> <a name="
4129 "\"state_machine_and_low_level_event_api\"/>"
4131 "<!-- old anchor for the next section --> <a name="
4132 "\"state_machine_and_low_level_event_api\"/>"
4135 #: ../src/guestfs.pod:2105
4136 msgid "ARCHITECTURE"
4137 msgstr "АРХІТЕКТУРА"
4140 #: ../src/guestfs.pod:2107
4142 "Internally, libguestfs is implemented by running an appliance (a special "
4143 "type of small virtual machine) using L<qemu(1)>. Qemu runs as a child "
4144 "process of the main program."
4148 #: ../src/guestfs.pod:2111
4151 " ___________________\n"
4153 " | main program |\n"
4155 " | | child process / appliance\n"
4156 " | | __________________________\n"
4158 " +-------------------+ RPC | +-----------------+ |\n"
4159 " | libguestfs <--------------------> guestfsd | |\n"
4160 " | | | +-----------------+ |\n"
4161 " \\___________________/ | | Linux kernel | |\n"
4162 " | +--^--------------+ |\n"
4163 " \\_________|________________/\n"
4169 " \\______________/\n"
4174 #: ../src/guestfs.pod:2131
4176 "The library, linked to the main program, creates the child process and hence "
4177 "the appliance in the L</guestfs_launch> function."
4181 #: ../src/guestfs.pod:2134
4183 "Inside the appliance is a Linux kernel and a complete stack of userspace "
4184 "tools (such as LVM and ext2 programs) and a small controlling daemon called "
4185 "L</guestfsd>. The library talks to L</guestfsd> using remote procedure "
4186 "calls (RPC). There is a mostly one-to-one correspondence between libguestfs "
4187 "API calls and RPC calls to the daemon. Lastly the disk image(s) are "
4188 "attached to the qemu process which translates device access by the "
4189 "appliance's Linux kernel into accesses to the image."
4193 #: ../src/guestfs.pod:2143
4195 "A common misunderstanding is that the appliance \"is\" the virtual machine. "
4196 "Although the disk image you are attached to might also be used by some "
4197 "virtual machine, libguestfs doesn't know or care about this. (But you will "
4198 "care if both libguestfs's qemu process and your virtual machine are trying "
4199 "to update the disk image at the same time, since these usually results in "
4200 "massive disk corruption)."
4204 #: ../src/guestfs.pod:2150
4205 msgid "STATE MACHINE"
4206 msgstr "СКІНЧЕННИЙ АВТОМАТ"
4209 #: ../src/guestfs.pod:2152
4210 msgid "libguestfs uses a state machine to model the child process:"
4214 #: ../src/guestfs.pod:2154
4226 " / | \\ \\ guestfs_launch\n"
4227 " / | _\\__V______\n"
4229 " / | | LAUNCHING |\n"
4230 " / | \\___________/\n"
4232 " / | guestfs_launch\n"
4234 " ______ / __|____V\n"
4235 " / \\ ------> / \\\n"
4236 " | BUSY | | READY |\n"
4237 " \\______/ <------ \\________/\n"
4242 #: ../src/guestfs.pod:2176
4244 "The normal transitions are (1) CONFIG (when the handle is created, but there "
4245 "is no child process), (2) LAUNCHING (when the child process is booting up), "
4246 "(3) alternating between READY and BUSY as commands are issued to, and "
4247 "carried out by, the child process."
4251 #: ../src/guestfs.pod:2181
4253 "The guest may be killed by L</guestfs_kill_subprocess>, or may die "
4254 "asynchronously at any time (eg. due to some internal error), and that causes "
4255 "the state to transition back to CONFIG."
4259 #: ../src/guestfs.pod:2185
4261 "Configuration commands for qemu such as L</guestfs_add_drive> can only be "
4262 "issued when in the CONFIG state."
4266 #: ../src/guestfs.pod:2188
4268 "The API offers one call that goes from CONFIG through LAUNCHING to READY. "
4269 "L</guestfs_launch> blocks until the child process is READY to accept "
4270 "commands (or until some failure or timeout). L</guestfs_launch> internally "
4271 "moves the state from CONFIG to LAUNCHING while it is running."
4275 #: ../src/guestfs.pod:2194
4277 "API actions such as L</guestfs_mount> can only be issued when in the READY "
4278 "state. These API calls block waiting for the command to be carried out (ie. "
4279 "the state to transition to BUSY and then back to READY). There are no non-"
4280 "blocking versions, and no way to issue more than one command per handle at "
4285 #: ../src/guestfs.pod:2200
4287 "Finally, the child process sends asynchronous messages back to the main "
4288 "program, such as kernel log messages. You can register a callback to "
4289 "receive these messages."
4293 #: ../src/guestfs.pod:2204
4298 #: ../src/guestfs.pod:2206
4299 msgid "COMMUNICATION PROTOCOL"
4303 #: ../src/guestfs.pod:2208
4305 "Don't rely on using this protocol directly. This section documents how it "
4306 "currently works, but it may change at any time."
4310 #: ../src/guestfs.pod:2211
4312 "The protocol used to talk between the library and the daemon running inside "
4313 "the qemu virtual machine is a simple RPC mechanism built on top of XDR (RFC "
4314 "1014, RFC 1832, RFC 4506)."
4318 #: ../src/guestfs.pod:2215
4320 "The detailed format of structures is in C<src/guestfs_protocol.x> (note: "
4321 "this file is automatically generated)."
4325 #: ../src/guestfs.pod:2218
4327 "There are two broad cases, ordinary functions that don't have any C<FileIn> "
4328 "and C<FileOut> parameters, which are handled with very simple request/reply "
4329 "messages. Then there are functions that have any C<FileIn> or C<FileOut> "
4330 "parameters, which use the same request and reply messages, but they may also "
4331 "be followed by files sent using a chunked encoding."
4335 #: ../src/guestfs.pod:2225
4336 msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)"
4340 #: ../src/guestfs.pod:2227
4341 msgid "For ordinary functions, the request message is:"
4345 #: ../src/guestfs.pod:2229
4348 " total length (header + arguments,\n"
4349 " but not including the length word itself)\n"
4350 " struct guestfs_message_header (encoded as XDR)\n"
4351 " struct guestfs_<foo>_args (encoded as XDR)\n"
4356 #: ../src/guestfs.pod:2234
4358 "The total length field allows the daemon to allocate a fixed size buffer "
4359 "into which it slurps the rest of the message. As a result, the total length "
4360 "is limited to C<GUESTFS_MESSAGE_MAX> bytes (currently 4MB), which means the "
4361 "effective size of any request is limited to somewhere under this size."
4365 #: ../src/guestfs.pod:2240
4367 "Note also that many functions don't take any arguments, in which case the "
4368 "C<guestfs_I<foo>_args> is completely omitted."
4372 #: ../src/guestfs.pod:2243
4374 "The header contains the procedure number (C<guestfs_proc>) which is how the "
4375 "receiver knows what type of args structure to expect, or none at all."
4379 #: ../src/guestfs.pod:2247
4381 "For functions that take optional arguments, the optional arguments are "
4382 "encoded in the C<guestfs_I<foo>_args> structure in the same way as ordinary "
4383 "arguments. A bitmask in the header indicates which optional arguments are "
4384 "meaningful. The bitmask is also checked to see if it contains bits set "
4385 "which the daemon does not know about (eg. if more optional arguments were "
4386 "added in a later version of the library), and this causes the call to be "
4391 #: ../src/guestfs.pod:2255
4392 msgid "The reply message for ordinary functions is:"
4396 #: ../src/guestfs.pod:2257
4399 " total length (header + ret,\n"
4400 " but not including the length word itself)\n"
4401 " struct guestfs_message_header (encoded as XDR)\n"
4402 " struct guestfs_<foo>_ret (encoded as XDR)\n"
4407 #: ../src/guestfs.pod:2262
4409 "As above the C<guestfs_I<foo>_ret> structure may be completely omitted for "
4410 "functions that return no formal return values."
4414 #: ../src/guestfs.pod:2265
4416 "As above the total length of the reply is limited to C<GUESTFS_MESSAGE_MAX>."
4420 #: ../src/guestfs.pod:2268
4422 "In the case of an error, a flag is set in the header, and the reply message "
4423 "is slightly changed:"
4427 #: ../src/guestfs.pod:2271
4430 " total length (header + error,\n"
4431 " but not including the length word itself)\n"
4432 " struct guestfs_message_header (encoded as XDR)\n"
4433 " struct guestfs_message_error (encoded as XDR)\n"
4438 #: ../src/guestfs.pod:2276
4440 "The C<guestfs_message_error> structure contains the error message as a "
4445 #: ../src/guestfs.pod:2279
4446 msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS"
4450 #: ../src/guestfs.pod:2281
4452 "A C<FileIn> parameter indicates that we transfer a file I<into> the guest. "
4453 "The normal request message is sent (see above). However this is followed by "
4454 "a sequence of file chunks."
4458 #: ../src/guestfs.pod:2285
4461 " total length (header + arguments,\n"
4462 " but not including the length word itself,\n"
4463 " and not including the chunks)\n"
4464 " struct guestfs_message_header (encoded as XDR)\n"
4465 " struct guestfs_<foo>_args (encoded as XDR)\n"
4466 " sequence of chunks for FileIn param #0\n"
4467 " sequence of chunks for FileIn param #1 etc.\n"
4472 #: ../src/guestfs.pod:2293
4473 msgid "The \"sequence of chunks\" is:"
4477 #: ../src/guestfs.pod:2295
4480 " length of chunk (not including length word itself)\n"
4481 " struct guestfs_chunk (encoded as XDR)\n"
4482 " length of chunk\n"
4483 " struct guestfs_chunk (encoded as XDR)\n"
4485 " length of chunk\n"
4486 " struct guestfs_chunk (with data.data_len == 0)\n"
4491 #: ../src/guestfs.pod:2303
4493 "The final chunk has the C<data_len> field set to zero. Additionally a flag "
4494 "is set in the final chunk to indicate either successful completion or early "
4499 #: ../src/guestfs.pod:2307
4501 "At time of writing there are no functions that have more than one FileIn "
4502 "parameter. However this is (theoretically) supported, by sending the "
4503 "sequence of chunks for each FileIn parameter one after another (from left to "
4508 #: ../src/guestfs.pod:2312
4510 "Both the library (sender) I<and> the daemon (receiver) may cancel the "
4511 "transfer. The library does this by sending a chunk with a special flag set "
4512 "to indicate cancellation. When the daemon sees this, it cancels the whole "
4513 "RPC, does I<not> send any reply, and goes back to reading the next request."
4517 #: ../src/guestfs.pod:2318
4519 "The daemon may also cancel. It does this by writing a special word "
4520 "C<GUESTFS_CANCEL_FLAG> to the socket. The library listens for this during "
4521 "the transfer, and if it gets it, it will cancel the transfer (it sends a "
4522 "cancel chunk). The special word is chosen so that even if cancellation "
4523 "happens right at the end of the transfer (after the library has finished "
4524 "writing and has started listening for the reply), the \"spurious\" cancel "
4525 "flag will not be confused with the reply message."
4529 #: ../src/guestfs.pod:2327
4531 "This protocol allows the transfer of arbitrary sized files (no 32 bit "
4532 "limit), and also files where the size is not known in advance (eg. from "
4533 "pipes or sockets). However the chunks are rather small "
4534 "(C<GUESTFS_MAX_CHUNK_SIZE>), so that neither the library nor the daemon need "
4535 "to keep much in memory."
4539 #: ../src/guestfs.pod:2333
4540 msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS"
4544 #: ../src/guestfs.pod:2335
4546 "The protocol for FileOut parameters is exactly the same as for FileIn "
4547 "parameters, but with the roles of daemon and library reversed."
4551 #: ../src/guestfs.pod:2338
4554 " total length (header + ret,\n"
4555 " but not including the length word itself,\n"
4556 " and not including the chunks)\n"
4557 " struct guestfs_message_header (encoded as XDR)\n"
4558 " struct guestfs_<foo>_ret (encoded as XDR)\n"
4559 " sequence of chunks for FileOut param #0\n"
4560 " sequence of chunks for FileOut param #1 etc.\n"
4565 #: ../src/guestfs.pod:2346
4566 msgid "INITIAL MESSAGE"
4570 #: ../src/guestfs.pod:2348
4572 "When the daemon launches it sends an initial word (C<GUESTFS_LAUNCH_FLAG>) "
4573 "which indicates that the guest and daemon is alive. This is what L</"
4574 "guestfs_launch> waits for."
4578 #: ../src/guestfs.pod:2352
4579 msgid "PROGRESS NOTIFICATION MESSAGES"
4583 #: ../src/guestfs.pod:2354
4585 "The daemon may send progress notification messages at any time. These are "
4586 "distinguished by the normal length word being replaced by "
4587 "C<GUESTFS_PROGRESS_FLAG>, followed by a fixed size progress message."
4591 #: ../src/guestfs.pod:2358
4593 "The library turns them into progress callbacks (see L</"
4594 "GUESTFS_EVENT_PROGRESS>) if there is a callback registered, or discards them "
4599 #: ../src/guestfs.pod:2362
4601 "The daemon self-limits the frequency of progress messages it sends (see "
4602 "C<daemon/proto.c:notify_progress>). Not all calls generate progress "
4607 #: ../src/guestfs.pod:2366
4608 msgid "LIBGUESTFS VERSION NUMBERS"
4612 #: ../src/guestfs.pod:2368
4614 "Since April 2010, libguestfs has started to make separate development and "
4615 "stable releases, along with corresponding branches in our git repository. "
4616 "These separate releases can be identified by version number:"
4620 #: ../src/guestfs.pod:2373
4623 " even numbers for stable: 1.2.x, 1.4.x, ...\n"
4624 " .-------- odd numbers for development: 1.3.x, 1.5.x, ...\n"
4630 " | `-------- sub-version\n"
4632 " `------ always '1' because we don't change the ABI\n"
4637 #: ../src/guestfs.pod:2384
4638 msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"."
4642 #: ../src/guestfs.pod:2386
4644 "As time passes we cherry pick fixes from the development branch and backport "
4645 "those into the stable branch, the effect being that the stable branch should "
4646 "get more stable and less buggy over time. So the stable releases are ideal "
4647 "for people who don't need new features but would just like the software to "
4652 #: ../src/guestfs.pod:2392
4653 msgid "Our criteria for backporting changes are:"
4657 #: ../src/guestfs.pod:2398
4659 "Documentation changes which don't affect any code are backported unless the "
4660 "documentation refers to a future feature which is not in stable."
4664 #: ../src/guestfs.pod:2404
4666 "Bug fixes which are not controversial, fix obvious problems, and have been "
4667 "well tested are backported."
4671 #: ../src/guestfs.pod:2409
4673 "Simple rearrangements of code which shouldn't affect how it works get "
4674 "backported. This is so that the code in the two branches doesn't get too "
4675 "far out of step, allowing us to backport future fixes more easily."
4679 #: ../src/guestfs.pod:2415
4681 "We I<don't> backport new features, new APIs, new tools etc, except in one "
4682 "exceptional case: the new feature is required in order to implement an "
4683 "important bug fix."
4687 #: ../src/guestfs.pod:2421
4689 "A new stable branch starts when we think the new features in development are "
4690 "substantial and compelling enough over the current stable branch to warrant "
4691 "it. When that happens we create new stable and development versions 1.N.0 "
4692 "and 1.(N+1).0 [N is even]. The new dot-oh release won't necessarily be so "
4693 "stable at this point, but by backporting fixes from development, that branch "
4694 "will stabilize over time."
4698 #: ../src/guestfs.pod:2429
4699 msgid "EXTENDING LIBGUESTFS"
4703 #: ../src/guestfs.pod:2431
4704 msgid "ADDING A NEW API ACTION"
4708 #: ../src/guestfs.pod:2433
4710 "Large amounts of boilerplate code in libguestfs (RPC, bindings, "
4711 "documentation) are generated, and this makes it easy to extend the "
4716 #: ../src/guestfs.pod:2437
4717 msgid "To add a new API action there are two changes:"
4721 #: ../src/guestfs.pod:2443
4723 "You need to add a description of the call (name, parameters, return type, "
4724 "tests, documentation) to C<generator/generator_actions.ml>."
4728 #: ../src/guestfs.pod:2446
4730 "There are two sorts of API action, depending on whether the call goes "
4731 "through to the daemon in the appliance, or is serviced entirely by the "
4732 "library (see L</ARCHITECTURE> above). L</guestfs_sync> is an example of the "
4733 "former, since the sync is done in the appliance. L</guestfs_set_trace> is "
4734 "an example of the latter, since a trace flag is maintained in the handle and "
4735 "all tracing is done on the library side."
4739 #: ../src/guestfs.pod:2454
4741 "Most new actions are of the first type, and get added to the "
4742 "C<daemon_functions> list. Each function has a unique procedure number used "
4743 "in the RPC protocol which is assigned to that action when we publish "
4744 "libguestfs and cannot be reused. Take the latest procedure number and "
4749 #: ../src/guestfs.pod:2460
4751 "For library-only actions of the second type, add to the "
4752 "C<non_daemon_functions> list. Since these functions are serviced by the "
4753 "library and do not travel over the RPC mechanism to the daemon, these "
4754 "functions do not need a procedure number, and so the procedure number is set "
4759 #: ../src/guestfs.pod:2468
4760 msgid "Implement the action (in C):"
4764 #: ../src/guestfs.pod:2470
4766 "For daemon actions, implement the function C<do_E<lt>nameE<gt>> in the "
4767 "C<daemon/> directory."
4771 #: ../src/guestfs.pod:2473
4773 "For library actions, implement the function C<guestfs__E<lt>nameE<gt>> "
4774 "(note: double underscore) in the C<src/> directory."
4778 #: ../src/guestfs.pod:2476
4779 msgid "In either case, use another function as an example of what to do."
4783 #: ../src/guestfs.pod:2480
4784 msgid "After making these changes, use C<make> to compile."
4788 #: ../src/guestfs.pod:2482
4790 "Note that you don't need to implement the RPC, language bindings, manual "
4791 "pages or anything else. It's all automatically generated from the OCaml "
4796 #: ../src/guestfs.pod:2486
4797 msgid "ADDING TESTS FOR AN API ACTION"
4801 #: ../src/guestfs.pod:2488
4803 "You can supply zero or as many tests as you want per API call. The tests "
4804 "can either be added as part of the API description (C<generator/"
4805 "generator_actions.ml>), or in some rarer cases you may want to drop a script "
4806 "into C<regressions/>. Note that adding a script to C<regressions/> is "
4807 "slower, so if possible use the first method."
4811 #: ../src/guestfs.pod:2494
4813 "The following describes the test environment used when you add an API test "
4814 "in C<generator_actions.ml>."
4818 #: ../src/guestfs.pod:2497
4819 msgid "The test environment has 4 block devices:"
4823 #: ../src/guestfs.pod:2501
4824 msgid "C</dev/sda> 500MB"
4828 #: ../src/guestfs.pod:2503
4829 msgid "General block device for testing."
4833 #: ../src/guestfs.pod:2505
4834 msgid "C</dev/sdb> 50MB"
4838 #: ../src/guestfs.pod:2507
4840 "C</dev/sdb1> is an ext2 filesystem used for testing filesystem write "
4845 #: ../src/guestfs.pod:2510
4846 msgid "C</dev/sdc> 10MB"
4850 #: ../src/guestfs.pod:2512
4851 msgid "Used in a few tests where two block devices are needed."
4855 #: ../src/guestfs.pod:2514
4857 msgstr "C</dev/sdd>"
4860 #: ../src/guestfs.pod:2516
4861 msgid "ISO with fixed content (see C<images/test.iso>)."
4865 #: ../src/guestfs.pod:2520
4867 "To be able to run the tests in a reasonable amount of time, the libguestfs "
4868 "appliance and block devices are reused between tests. So don't try testing "
4869 "L</guestfs_kill_subprocess> :-x"
4873 #: ../src/guestfs.pod:2524
4875 "Each test starts with an initial scenario, selected using one of the "
4876 "C<Init*> expressions, described in C<generator/generator_types.ml>. These "
4877 "initialize the disks mentioned above in a particular way as documented in "
4878 "C<generator_types.ml>. You should not assume anything about the previous "
4879 "contents of other disks that are not initialized."
4883 #: ../src/guestfs.pod:2530
4885 "You can add a prerequisite clause to any individual test. This is a run-"
4886 "time check, which, if it fails, causes the test to be skipped. Useful if "
4887 "testing a command which might not work on all variations of libguestfs "
4888 "builds. A test that has prerequisite of C<Always> means to run "
4893 #: ../src/guestfs.pod:2536
4895 "In addition, packagers can skip individual tests by setting environment "
4896 "variables before running C<make check>."
4900 #: ../src/guestfs.pod:2539
4903 " SKIP_TEST_<CMD>_<NUM>=1\n"
4908 #: ../src/guestfs.pod:2541
4909 msgid "eg: C<SKIP_TEST_COMMAND_3=1> skips test #3 of L</guestfs_command>."
4913 #: ../src/guestfs.pod:2543
4918 #: ../src/guestfs.pod:2545
4921 " SKIP_TEST_<CMD>=1\n"
4926 #: ../src/guestfs.pod:2547
4927 msgid "eg: C<SKIP_TEST_ZEROFREE=1> skips all L</guestfs_zerofree> tests."
4931 #: ../src/guestfs.pod:2549
4932 msgid "Packagers can run only certain tests by setting for example:"
4936 #: ../src/guestfs.pod:2551
4939 " TEST_ONLY=\"vfs_type zerofree\"\n"
4944 #: ../src/guestfs.pod:2553
4946 "See C<capitests/tests.c> for more details of how these environment variables "
4951 #: ../src/guestfs.pod:2556
4952 msgid "DEBUGGING NEW API ACTIONS"
4956 #: ../src/guestfs.pod:2558
4957 msgid "Test new actions work before submitting them."
4961 #: ../src/guestfs.pod:2560
4962 msgid "You can use guestfish to try out new commands."
4966 #: ../src/guestfs.pod:2562
4968 "Debugging the daemon is a problem because it runs inside a minimal "
4969 "environment. However you can fprintf messages in the daemon to stderr, and "
4970 "they will show up if you use C<guestfish -v>."
4974 #: ../src/guestfs.pod:2566
4975 msgid "FORMATTING CODE AND OTHER CONVENTIONS"
4979 #: ../src/guestfs.pod:2568
4981 "Our C source code generally adheres to some basic code-formatting "
4982 "conventions. The existing code base is not totally consistent on this "
4983 "front, but we do prefer that contributed code be formatted similarly. In "
4984 "short, use spaces-not-TABs for indentation, use 2 spaces for each "
4985 "indentation level, and other than that, follow the K&R style."
4989 #: ../src/guestfs.pod:2574
4991 "If you use Emacs, add the following to one of one of your start-up files (e."
4992 "g., ~/.emacs), to help ensure that you get indentation right:"
4996 #: ../src/guestfs.pod:2577
4999 " ;;; In libguestfs, indent with spaces everywhere (not TABs).\n"
5000 " ;;; Exceptions: Makefile and ChangeLog modes.\n"
5001 " (add-hook 'find-file-hook\n"
5002 " '(lambda () (if (and buffer-file-name\n"
5003 " (string-match \"/libguestfs\\\\>\"\n"
5004 " (buffer-file-name))\n"
5005 " (not (string-equal mode-name \"Change Log\"))\n"
5006 " (not (string-equal mode-name \"Makefile\")))\n"
5007 " (setq indent-tabs-mode nil))))\n"
5012 #: ../src/guestfs.pod:2587
5015 " ;;; When editing C sources in libguestfs, use this style.\n"
5016 " (defun libguestfs-c-mode ()\n"
5017 " \"C mode with adjusted defaults for use with libguestfs.\"\n"
5019 " (c-set-style \"K&R\")\n"
5020 " (setq c-indent-level 2)\n"
5021 " (setq c-basic-offset 2))\n"
5022 " (add-hook 'c-mode-hook\n"
5023 " '(lambda () (if (string-match \"/libguestfs\\\\>\"\n"
5024 " (buffer-file-name))\n"
5025 " (libguestfs-c-mode))))\n"
5030 #: ../src/guestfs.pod:2599
5031 msgid "Enable warnings when compiling (and fix any problems this finds):"
5035 #: ../src/guestfs.pod:2602
5038 " ./configure --enable-gcc-warnings\n"
5043 #: ../src/guestfs.pod:2604
5044 msgid "Useful targets are:"
5048 #: ../src/guestfs.pod:2606
5051 " make syntax-check # checks the syntax of the C code\n"
5052 " make check # runs the test suite\n"
5057 #: ../src/guestfs.pod:2609
5058 msgid "DAEMON CUSTOM PRINTF FORMATTERS"
5062 #: ../src/guestfs.pod:2611
5064 "In the daemon code we have created custom printf formatters C<%Q> and C<%R>, "
5065 "which are used to do shell quoting."
5069 #: ../src/guestfs.pod:2616
5074 #: ../src/guestfs.pod:2618
5076 "Simple shell quoted string. Any spaces or other shell characters are "
5081 #: ../src/guestfs.pod:2621
5086 #: ../src/guestfs.pod:2623
5088 "Same as C<%Q> except the string is treated as a path which is prefixed by "
5093 #: ../src/guestfs.pod:2628 ../fish/guestfish.pod:240 ../fish/guestfish.pod:613
5094 msgid "For example:"
5098 #: ../src/guestfs.pod:2630
5101 " asprintf (&cmd, \"cat %R\", path);\n"
5106 #: ../src/guestfs.pod:2632
5107 msgid "would produce C<cat /sysroot/some\\ path\\ with\\ spaces>"
5111 #: ../src/guestfs.pod:2634
5113 "I<Note:> Do I<not> use these when you are passing parameters to the C<command"
5114 "{,r,v,rv}()> functions. These parameters do NOT need to be quoted because "
5115 "they are not passed via the shell (instead, straight to exec). You probably "
5116 "want to use the C<sysroot_path()> function however."
5120 #: ../src/guestfs.pod:2640
5121 msgid "SUBMITTING YOUR NEW API ACTIONS"
5125 #: ../src/guestfs.pod:2642
5127 "Submit patches to the mailing list: L<http://www.redhat.com/mailman/listinfo/"
5128 "libguestfs> and CC to L<rjones@redhat.com>."
5132 #: ../src/guestfs.pod:2646
5133 msgid "INTERNATIONALIZATION (I18N) SUPPORT"
5137 #: ../src/guestfs.pod:2648
5138 msgid "We support i18n (gettext anyhow) in the library."
5142 #: ../src/guestfs.pod:2650
5144 "However many messages come from the daemon, and we don't translate those at "
5145 "the moment. One reason is that the appliance generally has all locale files "
5146 "removed from it, because they take up a lot of space. So we'd have to readd "
5147 "some of those, as well as copying our PO files into the appliance."
5151 #: ../src/guestfs.pod:2656
5153 "Debugging messages are never translated, since they are intended for the "
5158 #: ../src/guestfs.pod:2659
5159 msgid "SOURCE CODE SUBDIRECTORIES"
5163 #: ../src/guestfs.pod:2663 ../src/guestfs-actions.pod:5735
5164 #: ../fish/guestfish-actions.pod:3842
5165 msgid "C<appliance>"
5166 msgstr "C<appliance>"
5169 #: ../src/guestfs.pod:2665
5170 msgid "The libguestfs appliance, build scripts and so on."
5174 #: ../src/guestfs.pod:2667
5175 msgid "C<capitests>"
5176 msgstr "C<capitests>"
5179 #: ../src/guestfs.pod:2669
5180 msgid "Automated tests of the C API."
5184 #: ../src/guestfs.pod:2671
5189 #: ../src/guestfs.pod:2673
5191 "The L<virt-cat(1)>, L<virt-filesystems(1)> and L<virt-ls(1)> commands and "
5196 #: ../src/guestfs.pod:2676
5201 #: ../src/guestfs.pod:2678
5202 msgid "Outside contributions, experimental parts."
5206 #: ../src/guestfs.pod:2680
5211 #: ../src/guestfs.pod:2682
5213 "The daemon that runs inside the libguestfs appliance and carries out actions."
5217 #: ../src/guestfs.pod:2685
5222 #: ../src/guestfs.pod:2687
5223 msgid "L<virt-df(1)> command and documentation."
5227 #: ../src/guestfs.pod:2689
5229 msgstr "C<examples>"
5232 #: ../src/guestfs.pod:2691
5233 msgid "C API example code."
5234 msgstr "Код прикладів використання програмного інтерфейсу мовою C."
5237 #: ../src/guestfs.pod:2693
5242 #: ../src/guestfs.pod:2695
5244 "L<guestfish(1)>, the command-line shell, and various shell scripts built on "
5245 "top such as L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, "
5246 "L<virt-tar-out(1)>."
5250 #: ../src/guestfs.pod:2699
5255 #: ../src/guestfs.pod:2701
5257 "L<guestmount(1)>, FUSE (userspace filesystem) built on top of libguestfs."
5261 #: ../src/guestfs.pod:2703
5262 msgid "C<generator>"
5263 msgstr "C<generator>"
5266 #: ../src/guestfs.pod:2705
5268 "The crucially important generator, used to automatically generate large "
5269 "amounts of boilerplate C code for things like RPC and bindings."
5273 #: ../src/guestfs.pod:2708
5278 #: ../src/guestfs.pod:2710
5279 msgid "Files used by the test suite."
5283 #: ../src/guestfs.pod:2712
5284 msgid "Some \"phony\" guest images which we test against."
5288 #: ../src/guestfs.pod:2714
5289 msgid "C<inspector>"
5290 msgstr "C<inspector>"
5293 #: ../src/guestfs.pod:2716
5294 msgid "L<virt-inspector(1)>, the virtual machine image inspector."
5298 #: ../src/guestfs.pod:2718
5303 #: ../src/guestfs.pod:2720
5304 msgid "Logo used on the website. The fish is called Arthur by the way."
5308 #: ../src/guestfs.pod:2722
5313 #: ../src/guestfs.pod:2724
5314 msgid "M4 macros used by autoconf."
5318 #: ../src/guestfs.pod:2726
5323 #: ../src/guestfs.pod:2728
5324 msgid "Translations of simple gettext strings."
5325 msgstr "Переклади простих рядків gettext."
5328 #: ../src/guestfs.pod:2730
5333 #: ../src/guestfs.pod:2732
5335 "The build infrastructure and PO files for translations of manpages and POD "
5336 "files. Eventually this will be combined with the C<po> directory, but that "
5337 "is rather complicated."
5341 #: ../src/guestfs.pod:2736
5342 msgid "C<regressions>"
5343 msgstr "C<regressions>"
5346 #: ../src/guestfs.pod:2738
5347 msgid "Regression tests."
5348 msgstr "Тести на регресії."
5351 #: ../src/guestfs.pod:2740
5356 #: ../src/guestfs.pod:2742
5357 msgid "L<virt-rescue(1)> command and documentation."
5361 #: ../src/guestfs.pod:2744
5366 #: ../src/guestfs.pod:2746
5367 msgid "Source code to the C library."
5371 #: ../src/guestfs.pod:2748
5376 #: ../src/guestfs.pod:2750
5377 msgid "Command line tools written in Perl (L<virt-resize(1)> and many others)."
5381 #: ../src/guestfs.pod:2752
5382 msgid "C<test-tool>"
5383 msgstr "C<test-tool>"
5386 #: ../src/guestfs.pod:2754
5388 "Test tool for end users to test if their qemu/kernel combination will work "
5393 #: ../src/guestfs.pod:2757
5398 #: ../src/guestfs.pod:2759
5403 #: ../src/guestfs.pod:2761
5408 #: ../src/guestfs.pod:2763
5413 #: ../src/guestfs.pod:2765
5418 #: ../src/guestfs.pod:2767
5423 #: ../src/guestfs.pod:2769
5428 #: ../src/guestfs.pod:2771
5433 #: ../src/guestfs.pod:2773
5434 msgid "Language bindings."
5435 msgstr "Прив’язки до мов програмування."
5438 #: ../src/guestfs.pod:2777 ../fish/guestfish.pod:1010
5439 #: ../test-tool/libguestfs-test-tool.pod:104 ../tools/virt-edit.pl:330
5440 msgid "ENVIRONMENT VARIABLES"
5441 msgstr "ЗМІННІ СЕРЕДОВИЩА"
5444 #: ../src/guestfs.pod:2781 ../fish/guestfish.pod:1036
5445 msgid "LIBGUESTFS_APPEND"
5449 #: ../src/guestfs.pod:2783 ../fish/guestfish.pod:1038
5450 msgid "Pass additional options to the guest kernel."
5454 #: ../src/guestfs.pod:2785 ../fish/guestfish.pod:1040
5455 msgid "LIBGUESTFS_DEBUG"
5459 #: ../src/guestfs.pod:2787
5461 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
5462 "effect as calling C<guestfs_set_verbose (g, 1)>."
5466 #: ../src/guestfs.pod:2790 ../fish/guestfish.pod:1045
5467 msgid "LIBGUESTFS_MEMSIZE"
5471 #: ../src/guestfs.pod:2792 ../fish/guestfish.pod:1047
5473 "Set the memory allocated to the qemu process, in megabytes. For example:"
5477 #: ../src/guestfs.pod:2795 ../fish/guestfish.pod:1050
5480 " LIBGUESTFS_MEMSIZE=700\n"
5485 #: ../src/guestfs.pod:2797 ../fish/guestfish.pod:1052
5486 msgid "LIBGUESTFS_PATH"
5490 #: ../src/guestfs.pod:2799
5492 "Set the path that libguestfs uses to search for a supermin appliance. See "
5493 "the discussion of paths in section L</PATH> above."
5497 #: ../src/guestfs.pod:2802 ../fish/guestfish.pod:1057
5498 msgid "LIBGUESTFS_QEMU"
5502 #: ../src/guestfs.pod:2804 ../fish/guestfish.pod:1059
5504 "Set the default qemu binary that libguestfs uses. If not set, then the qemu "
5505 "which was found at compile time by the configure script is used."
5509 #: ../src/guestfs.pod:2808
5510 msgid "See also L</QEMU WRAPPERS> above."
5514 #: ../src/guestfs.pod:2810 ../fish/guestfish.pod:1063
5515 msgid "LIBGUESTFS_TRACE"
5519 #: ../src/guestfs.pod:2812
5521 "Set C<LIBGUESTFS_TRACE=1> to enable command traces. This has the same "
5522 "effect as calling C<guestfs_set_trace (g, 1)>."
5526 #: ../src/guestfs.pod:2815 ../fish/guestfish.pod:1072
5531 #: ../src/guestfs.pod:2817 ../fish/guestfish.pod:1074
5533 "Location of temporary directory, defaults to C</tmp> except for the cached "
5534 "supermin appliance which defaults to C</var/tmp>."
5538 #: ../src/guestfs.pod:2820 ../fish/guestfish.pod:1077
5540 "If libguestfs was compiled to use the supermin appliance then the real "
5541 "appliance is cached in this directory, shared between all handles belonging "
5542 "to the same EUID. You can use C<$TMPDIR> to configure another directory to "
5543 "use in case C</var/tmp> is not large enough."
5547 #: ../src/guestfs.pod:2828 ../fish/guestfish.pod:1144
5548 #: ../test-tool/libguestfs-test-tool.pod:109 ../fuse/guestmount.pod:267
5549 #: ../tools/virt-edit.pl:350 ../tools/virt-win-reg.pl:572
5550 #: ../tools/virt-resize.pl:1489 ../tools/virt-list-filesystems.pl:189
5551 #: ../tools/virt-tar.pl:286 ../tools/virt-make-fs.pl:539
5552 #: ../tools/virt-list-partitions.pl:257
5554 msgstr "ТАКОЖ ПЕРЕГЛЯНЬТЕ"
5557 #: ../src/guestfs.pod:2830
5559 "L<guestfs-examples(3)>, L<guestfs-ocaml(3)>, L<guestfs-python(3)>, L<guestfs-"
5560 "ruby(3)>, L<guestfish(1)>, L<guestmount(1)>, L<virt-cat(1)>, L<virt-copy-in"
5561 "(1)>, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, L<virt-filesystems"
5562 "(1)>, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, L<virt-list-"
5563 "partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, L<virt-rescue(1)>, L<virt-"
5564 "tar(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<virt-win-reg(1)>, L<qemu(1)"
5565 ">, L<febootstrap(1)>, L<hivex(3)>, L<http://libguestfs.org/>."
5569 #: ../src/guestfs.pod:2857
5571 "Tools with a similar purpose: L<fdisk(8)>, L<parted(8)>, L<kpartx(8)>, L<lvm"
5572 "(8)>, L<disktype(1)>."
5576 #: ../src/guestfs.pod:2864 ../tools/virt-win-reg.pl:587
5577 #: ../tools/virt-make-fs.pl:553
5582 #: ../src/guestfs.pod:2866
5583 msgid "To get a list of bugs against libguestfs use this link:"
5585 "Щоб переглянути список відомих вад у libguestfs, скористайтеся таким "
5589 #: ../src/guestfs.pod:2868
5591 "L<https://bugzilla.redhat.com/buglist.cgi?"
5592 "component=libguestfs&product=Virtualization+Tools>"
5594 "L<https://bugzilla.redhat.com/buglist.cgi?"
5595 "component=libguestfs&product=Virtualization+Tools>"
5598 #: ../src/guestfs.pod:2870
5599 msgid "To report a new bug against libguestfs use this link:"
5600 msgstr "Для звітування щодо вад у libguestfs скористайтеся цим посиланням:"
5603 #: ../src/guestfs.pod:2872
5605 "L<https://bugzilla.redhat.com/enter_bug.cgi?"
5606 "component=libguestfs&product=Virtualization+Tools>"
5608 "L<https://bugzilla.redhat.com/enter_bug.cgi?"
5609 "component=libguestfs&product=Virtualization+Tools>"
5612 #: ../src/guestfs.pod:2874
5613 msgid "When reporting a bug, please check:"
5617 #: ../src/guestfs.pod:2880
5618 msgid "That the bug hasn't been reported already."
5622 #: ../src/guestfs.pod:2884
5623 msgid "That you are testing a recent version."
5627 #: ../src/guestfs.pod:2888
5628 msgid "Describe the bug accurately, and give a way to reproduce it."
5632 #: ../src/guestfs.pod:2892
5634 "Run libguestfs-test-tool and paste the B<complete, unedited> output into the "
5639 #: ../src/guestfs.pod:2897 ../fish/guestfish.pod:1167
5640 #: ../test-tool/libguestfs-test-tool.pod:115 ../fuse/guestmount.pod:278
5645 #: ../src/guestfs.pod:2899 ../fish/guestfish.pod:1169
5646 #: ../test-tool/libguestfs-test-tool.pod:117 ../fuse/guestmount.pod:280
5647 msgid "Richard W.M. Jones (C<rjones at redhat dot com>)"
5651 #: ../src/guestfs.pod:2901 ../fish/guestfish.pod:1171
5652 #: ../test-tool/libguestfs-test-tool.pod:119 ../fuse/guestmount.pod:282
5653 #: ../tools/virt-edit.pl:368 ../tools/virt-win-reg.pl:602
5654 #: ../tools/virt-resize.pl:1514 ../tools/virt-list-filesystems.pl:206
5655 #: ../tools/virt-tar.pl:305 ../tools/virt-make-fs.pl:568
5656 #: ../tools/virt-list-partitions.pl:273
5658 msgstr "АВТОРСЬКІ ПРАВА"
5661 #: ../src/guestfs.pod:2903 ../fish/guestfish.pod:1173
5662 msgid "Copyright (C) 2009-2011 Red Hat Inc. L<http://libguestfs.org/>"
5666 #: ../src/guestfs.pod:2906
5668 "This library is free software; you can redistribute it and/or modify it "
5669 "under the terms of the GNU Lesser General Public License as published by the "
5670 "Free Software Foundation; either version 2 of the License, or (at your "
5671 "option) any later version."
5675 #: ../src/guestfs.pod:2911
5677 "This library is distributed in the hope that it will be useful, but WITHOUT "
5678 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
5679 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License "
5684 #: ../src/guestfs.pod:2916
5686 "You should have received a copy of the GNU Lesser General Public License "
5687 "along with this library; if not, write to the Free Software Foundation, "
5688 "Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA"
5692 #: ../src/guestfs-actions.pod:1
5693 msgid "guestfs_add_cdrom"
5697 #: ../src/guestfs-actions.pod:3
5701 " guestfs_add_cdrom (guestfs_h *g,\n"
5702 " const char *filename);\n"
5707 #: ../src/guestfs-actions.pod:7 ../fish/guestfish-actions.pod:5
5708 msgid "This function adds a virtual CD-ROM disk image to the guest."
5712 #: ../src/guestfs-actions.pod:9 ../fish/guestfish-actions.pod:7
5713 msgid "This is equivalent to the qemu parameter C<-cdrom filename>."
5717 #: ../src/guestfs-actions.pod:17
5719 "This call checks for the existence of C<filename>. This stops you from "
5720 "specifying other types of drive which are supported by qemu such as C<nbd:> "
5721 "and C<http:> URLs. To specify those, use the general C<guestfs_config> call "
5726 #: ../src/guestfs-actions.pod:24
5728 "If you just want to add an ISO file (often you use this as an efficient way "
5729 "to transfer large files into the guest), then you should probably use "
5730 "C<guestfs_add_drive_ro> instead."
5734 #: ../src/guestfs-actions.pod:30 ../src/guestfs-actions.pod:134
5735 #: ../src/guestfs-actions.pod:195 ../src/guestfs-actions.pod:232
5736 #: ../src/guestfs-actions.pod:246 ../src/guestfs-actions.pod:267
5737 #: ../src/guestfs-actions.pod:287 ../src/guestfs-actions.pod:301
5738 #: ../src/guestfs-actions.pod:416 ../src/guestfs-actions.pod:436
5739 #: ../src/guestfs-actions.pod:450 ../src/guestfs-actions.pod:495
5740 #: ../src/guestfs-actions.pod:523 ../src/guestfs-actions.pod:541
5741 #: ../src/guestfs-actions.pod:608 ../src/guestfs-actions.pod:641
5742 #: ../src/guestfs-actions.pod:655 ../src/guestfs-actions.pod:670
5743 #: ../src/guestfs-actions.pod:769 ../src/guestfs-actions.pod:787
5744 #: ../src/guestfs-actions.pod:801 ../src/guestfs-actions.pod:815
5745 #: ../src/guestfs-actions.pod:976 ../src/guestfs-actions.pod:996
5746 #: ../src/guestfs-actions.pod:1014 ../src/guestfs-actions.pod:1098
5747 #: ../src/guestfs-actions.pod:1116 ../src/guestfs-actions.pod:1135
5748 #: ../src/guestfs-actions.pod:1149 ../src/guestfs-actions.pod:1169
5749 #: ../src/guestfs-actions.pod:1239 ../src/guestfs-actions.pod:1270
5750 #: ../src/guestfs-actions.pod:1295 ../src/guestfs-actions.pod:1337
5751 #: ../src/guestfs-actions.pod:1443 ../src/guestfs-actions.pod:1477
5752 #: ../src/guestfs-actions.pod:1695 ../src/guestfs-actions.pod:1717
5753 #: ../src/guestfs-actions.pod:1804 ../src/guestfs-actions.pod:2266
5754 #: ../src/guestfs-actions.pod:2410 ../src/guestfs-actions.pod:2471
5755 #: ../src/guestfs-actions.pod:2506 ../src/guestfs-actions.pod:3380
5756 #: ../src/guestfs-actions.pod:3395 ../src/guestfs-actions.pod:3420
5757 #: ../src/guestfs-actions.pod:3575 ../src/guestfs-actions.pod:3589
5758 #: ../src/guestfs-actions.pod:3602 ../src/guestfs-actions.pod:3616
5759 #: ../src/guestfs-actions.pod:3631 ../src/guestfs-actions.pod:3667
5760 #: ../src/guestfs-actions.pod:3739 ../src/guestfs-actions.pod:3759
5761 #: ../src/guestfs-actions.pod:3776 ../src/guestfs-actions.pod:3799
5762 #: ../src/guestfs-actions.pod:3822 ../src/guestfs-actions.pod:3854
5763 #: ../src/guestfs-actions.pod:3873 ../src/guestfs-actions.pod:3892
5764 #: ../src/guestfs-actions.pod:3927 ../src/guestfs-actions.pod:3939
5765 #: ../src/guestfs-actions.pod:3975 ../src/guestfs-actions.pod:3991
5766 #: ../src/guestfs-actions.pod:4004 ../src/guestfs-actions.pod:4019
5767 #: ../src/guestfs-actions.pod:4036 ../src/guestfs-actions.pod:4129
5768 #: ../src/guestfs-actions.pod:4149 ../src/guestfs-actions.pod:4162
5769 #: ../src/guestfs-actions.pod:4213 ../src/guestfs-actions.pod:4231
5770 #: ../src/guestfs-actions.pod:4249 ../src/guestfs-actions.pod:4265
5771 #: ../src/guestfs-actions.pod:4279 ../src/guestfs-actions.pod:4293
5772 #: ../src/guestfs-actions.pod:4310 ../src/guestfs-actions.pod:4325
5773 #: ../src/guestfs-actions.pod:4345 ../src/guestfs-actions.pod:4403
5774 #: ../src/guestfs-actions.pod:4476 ../src/guestfs-actions.pod:4507
5775 #: ../src/guestfs-actions.pod:4526 ../src/guestfs-actions.pod:4545
5776 #: ../src/guestfs-actions.pod:4557 ../src/guestfs-actions.pod:4574
5777 #: ../src/guestfs-actions.pod:4587 ../src/guestfs-actions.pod:4602
5778 #: ../src/guestfs-actions.pod:4617 ../src/guestfs-actions.pod:4652
5779 #: ../src/guestfs-actions.pod:4667 ../src/guestfs-actions.pod:4687
5780 #: ../src/guestfs-actions.pod:4701 ../src/guestfs-actions.pod:4718
5781 #: ../src/guestfs-actions.pod:4767 ../src/guestfs-actions.pod:4804
5782 #: ../src/guestfs-actions.pod:4818 ../src/guestfs-actions.pod:4846
5783 #: ../src/guestfs-actions.pod:4863 ../src/guestfs-actions.pod:4881
5784 #: ../src/guestfs-actions.pod:5015 ../src/guestfs-actions.pod:5072
5785 #: ../src/guestfs-actions.pod:5094 ../src/guestfs-actions.pod:5112
5786 #: ../src/guestfs-actions.pod:5144 ../src/guestfs-actions.pod:5210
5787 #: ../src/guestfs-actions.pod:5227 ../src/guestfs-actions.pod:5240
5788 #: ../src/guestfs-actions.pod:5254 ../src/guestfs-actions.pod:5543
5789 #: ../src/guestfs-actions.pod:5562 ../src/guestfs-actions.pod:5581
5790 #: ../src/guestfs-actions.pod:5593 ../src/guestfs-actions.pod:5605
5791 #: ../src/guestfs-actions.pod:5619 ../src/guestfs-actions.pod:5631
5792 #: ../src/guestfs-actions.pod:5645 ../src/guestfs-actions.pod:5661
5793 #: ../src/guestfs-actions.pod:5682 ../src/guestfs-actions.pod:5701
5794 #: ../src/guestfs-actions.pod:5720 ../src/guestfs-actions.pod:5750
5795 #: ../src/guestfs-actions.pod:5766 ../src/guestfs-actions.pod:5789
5796 #: ../src/guestfs-actions.pod:5807 ../src/guestfs-actions.pod:5826
5797 #: ../src/guestfs-actions.pod:5847 ../src/guestfs-actions.pod:5866
5798 #: ../src/guestfs-actions.pod:5883 ../src/guestfs-actions.pod:5911
5799 #: ../src/guestfs-actions.pod:5935 ../src/guestfs-actions.pod:5954
5800 #: ../src/guestfs-actions.pod:5978 ../src/guestfs-actions.pod:5997
5801 #: ../src/guestfs-actions.pod:6012 ../src/guestfs-actions.pod:6031
5802 #: ../src/guestfs-actions.pod:6068 ../src/guestfs-actions.pod:6091
5803 #: ../src/guestfs-actions.pod:6117 ../src/guestfs-actions.pod:6225
5804 #: ../src/guestfs-actions.pod:6346 ../src/guestfs-actions.pod:6358
5805 #: ../src/guestfs-actions.pod:6371 ../src/guestfs-actions.pod:6384
5806 #: ../src/guestfs-actions.pod:6406 ../src/guestfs-actions.pod:6419
5807 #: ../src/guestfs-actions.pod:6432 ../src/guestfs-actions.pod:6445
5808 #: ../src/guestfs-actions.pod:6460 ../src/guestfs-actions.pod:6519
5809 #: ../src/guestfs-actions.pod:6536 ../src/guestfs-actions.pod:6552
5810 #: ../src/guestfs-actions.pod:6568 ../src/guestfs-actions.pod:6585
5811 #: ../src/guestfs-actions.pod:6598 ../src/guestfs-actions.pod:6618
5812 #: ../src/guestfs-actions.pod:6654 ../src/guestfs-actions.pod:6668
5813 #: ../src/guestfs-actions.pod:6709 ../src/guestfs-actions.pod:6722
5814 #: ../src/guestfs-actions.pod:6740 ../src/guestfs-actions.pod:6774
5815 #: ../src/guestfs-actions.pod:6810 ../src/guestfs-actions.pod:6929
5816 #: ../src/guestfs-actions.pod:6947 ../src/guestfs-actions.pod:6961
5817 #: ../src/guestfs-actions.pod:7016 ../src/guestfs-actions.pod:7029
5818 #: ../src/guestfs-actions.pod:7074 ../src/guestfs-actions.pod:7107
5819 #: ../src/guestfs-actions.pod:7161 ../src/guestfs-actions.pod:7187
5820 #: ../src/guestfs-actions.pod:7253 ../src/guestfs-actions.pod:7272
5821 #: ../src/guestfs-actions.pod:7301
5822 msgid "This function returns 0 on success or -1 on error."
5826 #: ../src/guestfs-actions.pod:32 ../src/guestfs-actions.pod:248
5827 #: ../src/guestfs-actions.pod:269 ../fish/guestfish-actions.pod:28
5828 #: ../fish/guestfish-actions.pod:158 ../fish/guestfish-actions.pod:172
5830 "This function is deprecated. In new code, use the C<add_drive_opts> call "
5835 #: ../src/guestfs-actions.pod:35 ../src/guestfs-actions.pod:251
5836 #: ../src/guestfs-actions.pod:272 ../src/guestfs-actions.pod:1448
5837 #: ../src/guestfs-actions.pod:1944 ../src/guestfs-actions.pod:1965
5838 #: ../src/guestfs-actions.pod:4350 ../src/guestfs-actions.pod:7195
5839 #: ../src/guestfs-actions.pod:7364 ../fish/guestfish-actions.pod:31
5840 #: ../fish/guestfish-actions.pod:161 ../fish/guestfish-actions.pod:175
5841 #: ../fish/guestfish-actions.pod:956 ../fish/guestfish-actions.pod:1319
5842 #: ../fish/guestfish-actions.pod:1333 ../fish/guestfish-actions.pod:2942
5843 #: ../fish/guestfish-actions.pod:4800 ../fish/guestfish-actions.pod:4897
5845 "Deprecated functions will not be removed from the API, but the fact that "
5846 "they are deprecated indicates that there are problems with correct use of "
5851 #: ../src/guestfs-actions.pod:39 ../src/guestfs-actions.pod:136
5852 #: ../src/guestfs-actions.pod:1100 ../src/guestfs-actions.pod:1916
5853 #: ../src/guestfs-actions.pod:2014 ../src/guestfs-actions.pod:2117
5854 #: ../src/guestfs-actions.pod:3382 ../src/guestfs-actions.pod:3402
5855 #: ../src/guestfs-actions.pod:4654 ../src/guestfs-actions.pod:5768
5856 #: ../src/guestfs-actions.pod:5885 ../src/guestfs-actions.pod:5999
5857 #: ../src/guestfs-actions.pod:6462 ../src/guestfs-actions.pod:6587
5858 #: ../src/guestfs-actions.pod:7109
5859 msgid "(Added in 0.3)"
5863 #: ../src/guestfs-actions.pod:41
5864 msgid "guestfs_add_domain"
5868 #: ../src/guestfs-actions.pod:43
5872 " guestfs_add_domain (guestfs_h *g,\n"
5873 " const char *dom,\n"
5879 #: ../src/guestfs-actions.pod:48 ../src/guestfs-actions.pod:145
5880 #: ../src/guestfs-actions.pod:4364
5882 "You may supply a list of optional arguments to this call. Use zero or more "
5883 "of the following pairs of parameters, and terminate the list with C<-1> on "
5884 "its own. See L</CALLS WITH OPTIONAL ARGUMENTS>."
5888 #: ../src/guestfs-actions.pod:53
5891 " GUESTFS_ADD_DOMAIN_LIBVIRTURI, const char *libvirturi,\n"
5892 " GUESTFS_ADD_DOMAIN_READONLY, int readonly,\n"
5893 " GUESTFS_ADD_DOMAIN_IFACE, const char *iface,\n"
5894 " GUESTFS_ADD_DOMAIN_LIVE, int live,\n"
5899 #: ../src/guestfs-actions.pod:58
5901 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
5902 "It works by connecting to libvirt, requesting the domain and domain XML from "
5903 "libvirt, parsing it for disks, and calling C<guestfs_add_drive_opts> on each "
5908 #: ../src/guestfs-actions.pod:63 ../fish/guestfish-actions.pod:46
5910 "The number of disks added is returned. This operation is atomic: if an "
5911 "error is returned, then no disks are added."
5915 #: ../src/guestfs-actions.pod:66 ../fish/guestfish-actions.pod:49
5917 "This function does some minimal checks to make sure the libvirt domain is "
5918 "not running (unless C<readonly> is true). In a future version we will try "
5919 "to acquire the libvirt lock on each disk."
5923 #: ../src/guestfs-actions.pod:70 ../fish/guestfish-actions.pod:53
5925 "Disks must be accessible locally. This often means that adding disks from a "
5926 "remote libvirt connection (see L<http://libvirt.org/remote.html>) will fail "
5927 "unless those disks are accessible via the same device path locally too."
5931 #: ../src/guestfs-actions.pod:75 ../fish/guestfish-actions.pod:58
5933 "The optional C<libvirturi> parameter sets the libvirt URI (see L<http://"
5934 "libvirt.org/uri.html>). If this is not set then we connect to the default "
5935 "libvirt URI (or one set through an environment variable, see the libvirt "
5936 "documentation for full details)."
5940 #: ../src/guestfs-actions.pod:81 ../fish/guestfish-actions.pod:64
5942 "The optional C<live> flag controls whether this call will try to connect to "
5943 "a running virtual machine C<guestfsd> process if it sees a suitable "
5944 "E<lt>channelE<gt> element in the libvirt XML definition. The default (if "
5945 "the flag is omitted) is never to try. See L<guestfs(3)/ATTACHING TO RUNNING "
5946 "DAEMONS> for more information."
5950 #: ../src/guestfs-actions.pod:88
5952 "The other optional parameters are passed directly through to "
5953 "C<guestfs_add_drive_opts>."
5957 #: ../src/guestfs-actions.pod:91 ../src/guestfs-actions.pod:344
5958 #: ../src/guestfs-actions.pod:509 ../src/guestfs-actions.pod:687
5959 #: ../src/guestfs-actions.pod:718 ../src/guestfs-actions.pod:736
5960 #: ../src/guestfs-actions.pod:755 ../src/guestfs-actions.pod:1315
5961 #: ../src/guestfs-actions.pod:1674 ../src/guestfs-actions.pod:1877
5962 #: ../src/guestfs-actions.pod:1986 ../src/guestfs-actions.pod:2026
5963 #: ../src/guestfs-actions.pod:2081 ../src/guestfs-actions.pod:2104
5964 #: ../src/guestfs-actions.pod:2397 ../src/guestfs-actions.pod:2728
5965 #: ../src/guestfs-actions.pod:2749 ../src/guestfs-actions.pod:4790
5966 #: ../src/guestfs-actions.pod:4918 ../src/guestfs-actions.pod:5324
5967 #: ../src/guestfs-actions.pod:5350 ../src/guestfs-actions.pod:6695
5968 #: ../src/guestfs-actions.pod:7120 ../src/guestfs-actions.pod:7133
5969 #: ../src/guestfs-actions.pod:7146
5970 msgid "On error this function returns -1."
5974 #: ../src/guestfs-actions.pod:93
5975 msgid "(Added in 1.7.4)"
5979 #: ../src/guestfs-actions.pod:95
5980 msgid "guestfs_add_domain_va"
5984 #: ../src/guestfs-actions.pod:97
5988 " guestfs_add_domain_va (guestfs_h *g,\n"
5989 " const char *dom,\n"
5995 #: ../src/guestfs-actions.pod:102
5996 msgid "This is the \"va_list variant\" of L</guestfs_add_domain>."
6000 #: ../src/guestfs-actions.pod:104 ../src/guestfs-actions.pod:115
6001 #: ../src/guestfs-actions.pod:208 ../src/guestfs-actions.pod:219
6002 #: ../src/guestfs-actions.pod:4417 ../src/guestfs-actions.pod:4429
6003 msgid "See L</CALLS WITH OPTIONAL ARGUMENTS>."
6007 #: ../src/guestfs-actions.pod:106
6008 msgid "guestfs_add_domain_argv"
6012 #: ../src/guestfs-actions.pod:108
6016 " guestfs_add_domain_argv (guestfs_h *g,\n"
6017 " const char *dom,\n"
6018 " const struct guestfs_add_domain_argv *optargs);\n"
6023 #: ../src/guestfs-actions.pod:113
6024 msgid "This is the \"argv variant\" of L</guestfs_add_domain>."
6028 #: ../src/guestfs-actions.pod:117
6029 msgid "guestfs_add_drive"
6033 #: ../src/guestfs-actions.pod:119
6037 " guestfs_add_drive (guestfs_h *g,\n"
6038 " const char *filename);\n"
6043 #: ../src/guestfs-actions.pod:123
6045 "This function is the equivalent of calling C<guestfs_add_drive_opts> with no "
6046 "optional parameters, so the disk is added writable, with the format being "
6047 "detected automatically."
6051 #: ../src/guestfs-actions.pod:127
6053 "Automatic detection of the format opens you up to a potential security hole "
6054 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
6055 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
6056 "you should think about replacing calls to this function with calls to "
6057 "C<guestfs_add_drive_opts>, and specifying the format."
6061 #: ../src/guestfs-actions.pod:138
6062 msgid "guestfs_add_drive_opts"
6066 #: ../src/guestfs-actions.pod:140
6070 " guestfs_add_drive_opts (guestfs_h *g,\n"
6071 " const char *filename,\n"
6077 #: ../src/guestfs-actions.pod:150
6080 " GUESTFS_ADD_DRIVE_OPTS_READONLY, int readonly,\n"
6081 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, const char *format,\n"
6082 " GUESTFS_ADD_DRIVE_OPTS_IFACE, const char *iface,\n"
6087 #: ../src/guestfs-actions.pod:154 ../fish/guestfish-actions.pod:97
6089 "This function adds a virtual machine disk image C<filename> to libguestfs. "
6090 "The first time you call this function, the disk appears as C</dev/sda>, the "
6091 "second time as C</dev/sdb>, and so on."
6095 #: ../src/guestfs-actions.pod:159 ../fish/guestfish-actions.pod:102
6097 "You don't necessarily need to be root when using libguestfs. However you "
6098 "obviously do need sufficient permissions to access the filename for whatever "
6099 "operations you want to perform (ie. read access if you just want to read the "
6100 "image or write access if you want to modify the image)."
6104 #: ../src/guestfs-actions.pod:165 ../fish/guestfish-actions.pod:108
6105 msgid "This call checks that C<filename> exists."
6109 #: ../src/guestfs-actions.pod:167 ../src/guestfs-actions.pod:4375
6110 #: ../fish/guestfish-actions.pod:110 ../fish/guestfish-actions.pod:2953
6111 msgid "The optional arguments are:"
6115 #: ../src/guestfs-actions.pod:171 ../fish/guestfish-actions.pod:114
6117 msgstr "C<readonly>"
6120 #: ../src/guestfs-actions.pod:173 ../fish/guestfish-actions.pod:116
6122 "If true then the image is treated as read-only. Writes are still allowed, "
6123 "but they are stored in a temporary snapshot overlay which is discarded at "
6124 "the end. The disk that you add is not modified."
6128 #: ../src/guestfs-actions.pod:177 ../fish/guestfish-actions.pod:120
6133 #: ../src/guestfs-actions.pod:179
6135 "This forces the image format. If you omit this (or use C<guestfs_add_drive> "
6136 "or C<guestfs_add_drive_ro>) then the format is automatically detected. "
6137 "Possible formats include C<raw> and C<qcow2>."
6141 #: ../src/guestfs-actions.pod:183 ../fish/guestfish-actions.pod:126
6143 "Automatic detection of the format opens you up to a potential security hole "
6144 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
6145 "RHBZ#642934. Specifying the format closes this security hole."
6149 #: ../src/guestfs-actions.pod:188 ../fish/guestfish-actions.pod:131
6154 #: ../src/guestfs-actions.pod:190
6156 "This rarely-used option lets you emulate the behaviour of the deprecated "
6157 "C<guestfs_add_drive_with_if> call (q.v.)"
6161 #: ../src/guestfs-actions.pod:197
6162 msgid "(Added in 1.5.23)"
6166 #: ../src/guestfs-actions.pod:199
6167 msgid "guestfs_add_drive_opts_va"
6171 #: ../src/guestfs-actions.pod:201
6175 " guestfs_add_drive_opts_va (guestfs_h *g,\n"
6176 " const char *filename,\n"
6182 #: ../src/guestfs-actions.pod:206
6183 msgid "This is the \"va_list variant\" of L</guestfs_add_drive_opts>."
6187 #: ../src/guestfs-actions.pod:210
6188 msgid "guestfs_add_drive_opts_argv"
6192 #: ../src/guestfs-actions.pod:212
6196 " guestfs_add_drive_opts_argv (guestfs_h *g,\n"
6197 " const char *filename,\n"
6198 " const struct guestfs_add_drive_opts_argv *optargs);\n"
6203 #: ../src/guestfs-actions.pod:217
6204 msgid "This is the \"argv variant\" of L</guestfs_add_drive_opts>."
6208 #: ../src/guestfs-actions.pod:221
6209 msgid "guestfs_add_drive_ro"
6213 #: ../src/guestfs-actions.pod:223
6217 " guestfs_add_drive_ro (guestfs_h *g,\n"
6218 " const char *filename);\n"
6223 #: ../src/guestfs-actions.pod:227
6225 "This function is the equivalent of calling C<guestfs_add_drive_opts> with "
6226 "the optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the "
6227 "disk is added read-only, with the format being detected automatically."
6231 #: ../src/guestfs-actions.pod:234
6232 msgid "(Added in 1.0.38)"
6236 #: ../src/guestfs-actions.pod:236
6237 msgid "guestfs_add_drive_ro_with_if"
6241 #: ../src/guestfs-actions.pod:238
6245 " guestfs_add_drive_ro_with_if (guestfs_h *g,\n"
6246 " const char *filename,\n"
6247 " const char *iface);\n"
6252 #: ../src/guestfs-actions.pod:243
6254 "This is the same as C<guestfs_add_drive_ro> but it allows you to specify the "
6255 "QEMU interface emulation to use at run time."
6259 #: ../src/guestfs-actions.pod:255 ../src/guestfs-actions.pod:276
6260 #: ../src/guestfs-actions.pod:2356
6261 msgid "(Added in 1.0.84)"
6265 #: ../src/guestfs-actions.pod:257
6266 msgid "guestfs_add_drive_with_if"
6270 #: ../src/guestfs-actions.pod:259
6274 " guestfs_add_drive_with_if (guestfs_h *g,\n"
6275 " const char *filename,\n"
6276 " const char *iface);\n"
6281 #: ../src/guestfs-actions.pod:264
6283 "This is the same as C<guestfs_add_drive> but it allows you to specify the "
6284 "QEMU interface emulation to use at run time."
6288 #: ../src/guestfs-actions.pod:278
6289 msgid "guestfs_aug_clear"
6293 #: ../src/guestfs-actions.pod:280
6297 " guestfs_aug_clear (guestfs_h *g,\n"
6298 " const char *augpath);\n"
6303 #: ../src/guestfs-actions.pod:284 ../fish/guestfish-actions.pod:183
6305 "Set the value associated with C<path> to C<NULL>. This is the same as the "
6306 "L<augtool(1)> C<clear> command."
6310 #: ../src/guestfs-actions.pod:289 ../src/guestfs-actions.pod:2106
6311 msgid "(Added in 1.3.4)"
6315 #: ../src/guestfs-actions.pod:291
6316 msgid "guestfs_aug_close"
6320 #: ../src/guestfs-actions.pod:293
6324 " guestfs_aug_close (guestfs_h *g);\n"
6329 #: ../src/guestfs-actions.pod:296
6331 "Close the current Augeas handle and free up any resources used by it. After "
6332 "calling this, you have to call C<guestfs_aug_init> again before you can use "
6333 "any other Augeas functions."
6337 #: ../src/guestfs-actions.pod:303 ../src/guestfs-actions.pod:328
6338 #: ../src/guestfs-actions.pod:346 ../src/guestfs-actions.pod:360
6339 #: ../src/guestfs-actions.pod:418 ../src/guestfs-actions.pod:438
6340 #: ../src/guestfs-actions.pod:452 ../src/guestfs-actions.pod:483
6341 #: ../src/guestfs-actions.pod:497 ../src/guestfs-actions.pod:511
6342 #: ../src/guestfs-actions.pod:525 ../src/guestfs-actions.pod:543
6343 #: ../src/guestfs-actions.pod:5401
6344 msgid "(Added in 0.7)"
6348 #: ../src/guestfs-actions.pod:305
6349 msgid "guestfs_aug_defnode"
6353 #: ../src/guestfs-actions.pod:307
6356 " struct guestfs_int_bool *\n"
6357 " guestfs_aug_defnode (guestfs_h *g,\n"
6358 " const char *name,\n"
6359 " const char *expr,\n"
6360 " const char *val);\n"
6365 #: ../src/guestfs-actions.pod:313 ../fish/guestfish-actions.pod:199
6367 "Defines a variable C<name> whose value is the result of evaluating C<expr>."
6371 #: ../src/guestfs-actions.pod:316
6373 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
6374 "calling C<guestfs_aug_set> C<expr>, C<value>. C<name> will be the nodeset "
6375 "containing that single node."
6379 #: ../src/guestfs-actions.pod:320 ../fish/guestfish-actions.pod:206
6381 "On success this returns a pair containing the number of nodes in the "
6382 "nodeset, and a boolean flag if a node was created."
6386 #: ../src/guestfs-actions.pod:324
6388 "This function returns a C<struct guestfs_int_bool *>, or NULL if there was "
6389 "an error. I<The caller must call C<guestfs_free_int_bool> after use>."
6393 #: ../src/guestfs-actions.pod:330
6394 msgid "guestfs_aug_defvar"
6398 #: ../src/guestfs-actions.pod:332
6402 " guestfs_aug_defvar (guestfs_h *g,\n"
6403 " const char *name,\n"
6404 " const char *expr);\n"
6409 #: ../src/guestfs-actions.pod:337 ../fish/guestfish-actions.pod:214
6411 "Defines an Augeas variable C<name> whose value is the result of evaluating "
6412 "C<expr>. If C<expr> is NULL, then C<name> is undefined."
6416 #: ../src/guestfs-actions.pod:341 ../fish/guestfish-actions.pod:218
6418 "On success this returns the number of nodes in C<expr>, or C<0> if C<expr> "
6419 "evaluates to something which is not a nodeset."
6423 #: ../src/guestfs-actions.pod:348
6424 msgid "guestfs_aug_get"
6428 #: ../src/guestfs-actions.pod:350
6432 " guestfs_aug_get (guestfs_h *g,\n"
6433 " const char *augpath);\n"
6438 #: ../src/guestfs-actions.pod:354 ../fish/guestfish-actions.pod:225
6440 "Look up the value associated with C<path>. If C<path> matches exactly one "
6441 "node, the C<value> is returned."
6445 #: ../src/guestfs-actions.pod:357 ../src/guestfs-actions.pod:857
6446 #: ../src/guestfs-actions.pod:875 ../src/guestfs-actions.pod:935
6447 #: ../src/guestfs-actions.pod:951 ../src/guestfs-actions.pod:1054
6448 #: ../src/guestfs-actions.pod:1184 ../src/guestfs-actions.pod:1201
6449 #: ../src/guestfs-actions.pod:1220 ../src/guestfs-actions.pod:1354
6450 #: ../src/guestfs-actions.pod:1545 ../src/guestfs-actions.pod:1657
6451 #: ../src/guestfs-actions.pod:1820 ../src/guestfs-actions.pod:1837
6452 #: ../src/guestfs-actions.pod:1904 ../src/guestfs-actions.pod:1938
6453 #: ../src/guestfs-actions.pod:1959 ../src/guestfs-actions.pod:2129
6454 #: ../src/guestfs-actions.pod:2321 ../src/guestfs-actions.pod:2528
6455 #: ../src/guestfs-actions.pod:2613 ../src/guestfs-actions.pod:2680
6456 #: ../src/guestfs-actions.pod:2700 ../src/guestfs-actions.pod:2814
6457 #: ../src/guestfs-actions.pod:2845 ../src/guestfs-actions.pod:2869
6458 #: ../src/guestfs-actions.pod:2906 ../src/guestfs-actions.pod:2966
6459 #: ../src/guestfs-actions.pod:2989 ../src/guestfs-actions.pod:3561
6460 #: ../src/guestfs-actions.pod:3911 ../src/guestfs-actions.pod:4081
6461 #: ../src/guestfs-actions.pod:4191 ../src/guestfs-actions.pod:4936
6462 #: ../src/guestfs-actions.pod:5129 ../src/guestfs-actions.pod:5299
6463 #: ../src/guestfs-actions.pod:5477 ../src/guestfs-actions.pod:5526
6464 #: ../src/guestfs-actions.pod:6138 ../src/guestfs-actions.pod:6154
6465 #: ../src/guestfs-actions.pod:6171 ../src/guestfs-actions.pod:6195
6466 #: ../src/guestfs-actions.pod:6869 ../src/guestfs-actions.pod:6888
6467 #: ../src/guestfs-actions.pod:6906 ../src/guestfs-actions.pod:7086
6468 #: ../src/guestfs-actions.pod:7358
6470 "This function returns a string, or NULL on error. I<The caller must free "
6471 "the returned string after use>."
6475 #: ../src/guestfs-actions.pod:362
6476 msgid "guestfs_aug_init"
6480 #: ../src/guestfs-actions.pod:364
6484 " guestfs_aug_init (guestfs_h *g,\n"
6485 " const char *root,\n"
6491 #: ../src/guestfs-actions.pod:369 ../fish/guestfish-actions.pod:232
6493 "Create a new Augeas handle for editing configuration files. If there was "
6494 "any previous Augeas handle associated with this guestfs session, then it is "
6499 #: ../src/guestfs-actions.pod:373
6500 msgid "You must call this before using any other C<guestfs_aug_*> commands."
6504 #: ../src/guestfs-actions.pod:376 ../fish/guestfish-actions.pod:239
6506 "C<root> is the filesystem root. C<root> must not be NULL, use C</> instead."
6510 #: ../src/guestfs-actions.pod:379 ../fish/guestfish-actions.pod:242
6512 "The flags are the same as the flags defined in E<lt>augeas.hE<gt>, the "
6513 "logical I<or> of the following integers:"
6517 #: ../src/guestfs-actions.pod:385 ../fish/guestfish-actions.pod:248
6518 msgid "C<AUG_SAVE_BACKUP> = 1"
6519 msgstr "C<AUG_SAVE_BACKUP> = 1"
6522 #: ../src/guestfs-actions.pod:387 ../fish/guestfish-actions.pod:250
6523 msgid "Keep the original file with a C<.augsave> extension."
6527 #: ../src/guestfs-actions.pod:389 ../fish/guestfish-actions.pod:252
6528 msgid "C<AUG_SAVE_NEWFILE> = 2"
6529 msgstr "C<AUG_SAVE_NEWFILE> = 2"
6532 #: ../src/guestfs-actions.pod:391 ../fish/guestfish-actions.pod:254
6534 "Save changes into a file with extension C<.augnew>, and do not overwrite "
6535 "original. Overrides C<AUG_SAVE_BACKUP>."
6539 #: ../src/guestfs-actions.pod:394 ../fish/guestfish-actions.pod:257
6540 msgid "C<AUG_TYPE_CHECK> = 4"
6541 msgstr "C<AUG_TYPE_CHECK> = 4"
6544 #: ../src/guestfs-actions.pod:396 ../fish/guestfish-actions.pod:259
6545 msgid "Typecheck lenses (can be expensive)."
6549 #: ../src/guestfs-actions.pod:398 ../fish/guestfish-actions.pod:261
6550 msgid "C<AUG_NO_STDINC> = 8"
6551 msgstr "C<AUG_NO_STDINC> = 8"
6554 #: ../src/guestfs-actions.pod:400 ../fish/guestfish-actions.pod:263
6555 msgid "Do not use standard load path for modules."
6559 #: ../src/guestfs-actions.pod:402 ../fish/guestfish-actions.pod:265
6560 msgid "C<AUG_SAVE_NOOP> = 16"
6561 msgstr "C<AUG_SAVE_NOOP> = 16"
6564 #: ../src/guestfs-actions.pod:404 ../fish/guestfish-actions.pod:267
6565 msgid "Make save a no-op, just record what would have been changed."
6569 #: ../src/guestfs-actions.pod:406 ../fish/guestfish-actions.pod:269
6570 msgid "C<AUG_NO_LOAD> = 32"
6571 msgstr "C<AUG_NO_LOAD> = 32"
6574 #: ../src/guestfs-actions.pod:408
6575 msgid "Do not load the tree in C<guestfs_aug_init>."
6579 #: ../src/guestfs-actions.pod:412
6580 msgid "To close the handle, you can call C<guestfs_aug_close>."
6584 #: ../src/guestfs-actions.pod:414 ../fish/guestfish-actions.pod:277
6585 msgid "To find out more about Augeas, see L<http://augeas.net/>."
6589 #: ../src/guestfs-actions.pod:420
6590 msgid "guestfs_aug_insert"
6594 #: ../src/guestfs-actions.pod:422
6598 " guestfs_aug_insert (guestfs_h *g,\n"
6599 " const char *augpath,\n"
6600 " const char *label,\n"
6606 #: ../src/guestfs-actions.pod:428 ../fish/guestfish-actions.pod:283
6608 "Create a new sibling C<label> for C<path>, inserting it into the tree before "
6609 "or after C<path> (depending on the boolean flag C<before>)."
6613 #: ../src/guestfs-actions.pod:432 ../fish/guestfish-actions.pod:287
6615 "C<path> must match exactly one existing node in the tree, and C<label> must "
6616 "be a label, ie. not contain C</>, C<*> or end with a bracketed index C<[N]>."
6620 #: ../src/guestfs-actions.pod:440
6621 msgid "guestfs_aug_load"
6625 #: ../src/guestfs-actions.pod:442
6629 " guestfs_aug_load (guestfs_h *g);\n"
6634 #: ../src/guestfs-actions.pod:445 ../fish/guestfish-actions.pod:295
6635 msgid "Load files into the tree."
6636 msgstr "Завантажити файли до ієрархії."
6639 #: ../src/guestfs-actions.pod:447 ../fish/guestfish-actions.pod:297
6640 msgid "See C<aug_load> in the Augeas documentation for the full gory details."
6644 #: ../src/guestfs-actions.pod:454
6645 msgid "guestfs_aug_ls"
6649 #: ../src/guestfs-actions.pod:456
6653 " guestfs_aug_ls (guestfs_h *g,\n"
6654 " const char *augpath);\n"
6659 #: ../src/guestfs-actions.pod:460
6661 "This is just a shortcut for listing C<guestfs_aug_match> C<path/*> and "
6662 "sorting the resulting nodes into alphabetical order."
6666 #: ../src/guestfs-actions.pod:463 ../src/guestfs-actions.pod:479
6667 #: ../src/guestfs-actions.pod:625 ../src/guestfs-actions.pod:1073
6668 #: ../src/guestfs-actions.pod:1369 ../src/guestfs-actions.pod:1388
6669 #: ../src/guestfs-actions.pod:1491 ../src/guestfs-actions.pod:1510
6670 #: ../src/guestfs-actions.pod:1759 ../src/guestfs-actions.pod:2201
6671 #: ../src/guestfs-actions.pod:2217 ../src/guestfs-actions.pod:2236
6672 #: ../src/guestfs-actions.pod:2279 ../src/guestfs-actions.pod:2303
6673 #: ../src/guestfs-actions.pod:2374 ../src/guestfs-actions.pod:2423
6674 #: ../src/guestfs-actions.pod:2638 ../src/guestfs-actions.pod:2923
6675 #: ../src/guestfs-actions.pod:3191 ../src/guestfs-actions.pod:3481
6676 #: ../src/guestfs-actions.pod:3543 ../src/guestfs-actions.pod:3648
6677 #: ../src/guestfs-actions.pod:4053 ../src/guestfs-actions.pod:4751
6678 #: ../src/guestfs-actions.pod:5271 ../src/guestfs-actions.pod:5397
6679 #: ../src/guestfs-actions.pod:5511 ../src/guestfs-actions.pod:6211
6680 #: ../src/guestfs-actions.pod:6272 ../src/guestfs-actions.pod:6327
6681 #: ../src/guestfs-actions.pod:6473 ../src/guestfs-actions.pod:6497
6682 #: ../src/guestfs-actions.pod:6979 ../src/guestfs-actions.pod:6999
6683 #: ../src/guestfs-actions.pod:7046 ../src/guestfs-actions.pod:7211
6684 #: ../src/guestfs-actions.pod:7230 ../src/guestfs-actions.pod:7315
6685 #: ../src/guestfs-actions.pod:7334 ../src/guestfs-actions.pod:7380
6686 #: ../src/guestfs-actions.pod:7399
6688 "This function returns a NULL-terminated array of strings (like L<environ(3)"
6689 ">), or NULL if there was an error. I<The caller must free the strings and "
6690 "the array after use>."
6694 #: ../src/guestfs-actions.pod:467 ../src/guestfs-actions.pod:998
6695 #: ../src/guestfs-actions.pod:1016 ../src/guestfs-actions.pod:1426
6696 #: ../src/guestfs-actions.pod:3269 ../src/guestfs-actions.pod:3300
6697 #: ../src/guestfs-actions.pod:3894 ../src/guestfs-actions.pod:3944
6698 #: ../src/guestfs-actions.pod:4131 ../src/guestfs-actions.pod:4164
6699 #: ../src/guestfs-actions.pod:4327 ../src/guestfs-actions.pod:4755
6700 #: ../src/guestfs-actions.pod:5212 ../src/guestfs-actions.pod:5607
6701 #: ../src/guestfs-actions.pod:5621 ../src/guestfs-actions.pod:5633
6702 #: ../src/guestfs-actions.pod:6073 ../src/guestfs-actions.pod:6711
6703 #: ../src/guestfs-actions.pod:6724 ../src/guestfs-actions.pod:6963
6704 #: ../src/guestfs-actions.pod:7199
6705 msgid "(Added in 0.8)"
6709 #: ../src/guestfs-actions.pod:469
6710 msgid "guestfs_aug_match"
6714 #: ../src/guestfs-actions.pod:471
6718 " guestfs_aug_match (guestfs_h *g,\n"
6719 " const char *augpath);\n"
6724 #: ../src/guestfs-actions.pod:475 ../fish/guestfish-actions.pod:311
6726 "Returns a list of paths which match the path expression C<path>. The "
6727 "returned paths are sufficiently qualified so that they match exactly one "
6728 "node in the current tree."
6732 #: ../src/guestfs-actions.pod:485
6733 msgid "guestfs_aug_mv"
6737 #: ../src/guestfs-actions.pod:487
6741 " guestfs_aug_mv (guestfs_h *g,\n"
6742 " const char *src,\n"
6743 " const char *dest);\n"
6748 #: ../src/guestfs-actions.pod:492 ../fish/guestfish-actions.pod:319
6750 "Move the node C<src> to C<dest>. C<src> must match exactly one node. "
6751 "C<dest> is overwritten if it exists."
6755 #: ../src/guestfs-actions.pod:499
6756 msgid "guestfs_aug_rm"
6760 #: ../src/guestfs-actions.pod:501
6764 " guestfs_aug_rm (guestfs_h *g,\n"
6765 " const char *augpath);\n"
6770 #: ../src/guestfs-actions.pod:505 ../fish/guestfish-actions.pod:326
6771 msgid "Remove C<path> and all of its children."
6775 #: ../src/guestfs-actions.pod:507 ../fish/guestfish-actions.pod:328
6776 msgid "On success this returns the number of entries which were removed."
6780 #: ../src/guestfs-actions.pod:513
6781 msgid "guestfs_aug_save"
6785 #: ../src/guestfs-actions.pod:515
6789 " guestfs_aug_save (guestfs_h *g);\n"
6794 #: ../src/guestfs-actions.pod:518 ../fish/guestfish-actions.pod:334
6795 msgid "This writes all pending changes to disk."
6799 #: ../src/guestfs-actions.pod:520
6801 "The flags which were passed to C<guestfs_aug_init> affect exactly how files "
6806 #: ../src/guestfs-actions.pod:527
6807 msgid "guestfs_aug_set"
6811 #: ../src/guestfs-actions.pod:529
6815 " guestfs_aug_set (guestfs_h *g,\n"
6816 " const char *augpath,\n"
6817 " const char *val);\n"
6822 #: ../src/guestfs-actions.pod:534 ../fish/guestfish-actions.pod:343
6823 msgid "Set the value associated with C<path> to C<val>."
6827 #: ../src/guestfs-actions.pod:536
6829 "In the Augeas API, it is possible to clear a node by setting the value to "
6830 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
6831 "this call. Instead you must use the C<guestfs_aug_clear> call."
6835 #: ../src/guestfs-actions.pod:545
6836 msgid "guestfs_available"
6840 #: ../src/guestfs-actions.pod:547
6844 " guestfs_available (guestfs_h *g,\n"
6845 " char *const *groups);\n"
6850 #: ../src/guestfs-actions.pod:551 ../fish/guestfish-actions.pod:354
6852 "This command is used to check the availability of some groups of "
6853 "functionality in the appliance, which not all builds of the libguestfs "
6854 "appliance will be able to provide."
6858 #: ../src/guestfs-actions.pod:555
6860 "The libguestfs groups, and the functions that those groups correspond to, "
6861 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
6862 "runtime by calling C<guestfs_available_all_groups>."
6866 #: ../src/guestfs-actions.pod:560 ../fish/guestfish-actions.pod:363
6868 "The argument C<groups> is a list of group names, eg: C<[\"inotify\", \"augeas"
6869 "\"]> would check for the availability of the Linux inotify functions and "
6870 "Augeas (configuration file editing) functions."
6874 #: ../src/guestfs-actions.pod:565 ../fish/guestfish-actions.pod:368
6875 msgid "The command returns no error if I<all> requested groups are available."
6879 #: ../src/guestfs-actions.pod:567 ../fish/guestfish-actions.pod:370
6881 "It fails with an error if one or more of the requested groups is unavailable "
6886 #: ../src/guestfs-actions.pod:570 ../fish/guestfish-actions.pod:373
6888 "If an unknown group name is included in the list of groups then an error is "
6893 #: ../src/guestfs-actions.pod:573 ../fish/guestfish-actions.pod:376
6895 msgstr "I<Нотатки:>"
6898 #: ../src/guestfs-actions.pod:579
6899 msgid "You must call C<guestfs_launch> before calling this function."
6903 #: ../src/guestfs-actions.pod:581 ../fish/guestfish-actions.pod:384
6905 "The reason is because we don't know what groups are supported by the "
6906 "appliance/daemon until it is running and can be queried."
6910 #: ../src/guestfs-actions.pod:587 ../fish/guestfish-actions.pod:390
6912 "If a group of functions is available, this does not necessarily mean that "
6913 "they will work. You still have to check for errors when calling individual "
6914 "API functions even if they are available."
6918 #: ../src/guestfs-actions.pod:594 ../fish/guestfish-actions.pod:397
6920 "It is usually the job of distro packagers to build complete functionality "
6921 "into the libguestfs appliance. Upstream libguestfs, if built from source "
6922 "with all requirements satisfied, will support everything."
6926 #: ../src/guestfs-actions.pod:601
6928 "This call was added in version C<1.0.80>. In previous versions of "
6929 "libguestfs all you could do would be to speculatively execute a command to "
6930 "find out if the daemon implemented it. See also C<guestfs_version>."
6934 #: ../src/guestfs-actions.pod:610 ../src/guestfs-actions.pod:1171
6935 msgid "(Added in 1.0.80)"
6939 #: ../src/guestfs-actions.pod:612
6940 msgid "guestfs_available_all_groups"
6944 #: ../src/guestfs-actions.pod:614
6948 " guestfs_available_all_groups (guestfs_h *g);\n"
6953 #: ../src/guestfs-actions.pod:617
6955 "This command returns a list of all optional groups that this daemon knows "
6956 "about. Note this returns both supported and unsupported groups. To find "
6957 "out which ones the daemon can actually support you have to call "
6958 "C<guestfs_available> on each member of the returned list."
6962 #: ../src/guestfs-actions.pod:623
6963 msgid "See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>."
6967 #: ../src/guestfs-actions.pod:629
6968 msgid "(Added in 1.3.15)"
6972 #: ../src/guestfs-actions.pod:631
6973 msgid "guestfs_base64_in"
6977 #: ../src/guestfs-actions.pod:633
6981 " guestfs_base64_in (guestfs_h *g,\n"
6982 " const char *base64file,\n"
6983 " const char *filename);\n"
6988 #: ../src/guestfs-actions.pod:638 ../fish/guestfish-actions.pod:427
6990 "This command uploads base64-encoded data from C<base64file> to C<filename>."
6994 #: ../src/guestfs-actions.pod:643 ../src/guestfs-actions.pod:657
6995 msgid "(Added in 1.3.5)"
6999 #: ../src/guestfs-actions.pod:645
7000 msgid "guestfs_base64_out"
7004 #: ../src/guestfs-actions.pod:647
7008 " guestfs_base64_out (guestfs_h *g,\n"
7009 " const char *filename,\n"
7010 " const char *base64file);\n"
7015 #: ../src/guestfs-actions.pod:652 ../fish/guestfish-actions.pod:436
7017 "This command downloads the contents of C<filename>, writing it out to local "
7018 "file C<base64file> encoded as base64."
7022 #: ../src/guestfs-actions.pod:659
7023 msgid "guestfs_blockdev_flushbufs"
7027 #: ../src/guestfs-actions.pod:661
7031 " guestfs_blockdev_flushbufs (guestfs_h *g,\n"
7032 " const char *device);\n"
7037 #: ../src/guestfs-actions.pod:665 ../fish/guestfish-actions.pod:445
7039 "This tells the kernel to flush internal buffers associated with C<device>."
7043 #: ../src/guestfs-actions.pod:668 ../src/guestfs-actions.pod:685
7044 #: ../src/guestfs-actions.pod:700 ../src/guestfs-actions.pod:716
7045 #: ../src/guestfs-actions.pod:734 ../src/guestfs-actions.pod:753
7046 #: ../src/guestfs-actions.pod:767 ../src/guestfs-actions.pod:785
7047 #: ../src/guestfs-actions.pod:799 ../src/guestfs-actions.pod:813
7048 #: ../fish/guestfish-actions.pod:448 ../fish/guestfish-actions.pod:459
7049 #: ../fish/guestfish-actions.pod:468 ../fish/guestfish-actions.pod:478
7050 #: ../fish/guestfish-actions.pod:490 ../fish/guestfish-actions.pod:503
7051 #: ../fish/guestfish-actions.pod:511 ../fish/guestfish-actions.pod:522
7052 #: ../fish/guestfish-actions.pod:530 ../fish/guestfish-actions.pod:538
7053 msgid "This uses the L<blockdev(8)> command."
7057 #: ../src/guestfs-actions.pod:672 ../src/guestfs-actions.pod:689
7058 #: ../src/guestfs-actions.pod:704 ../src/guestfs-actions.pod:720
7059 #: ../src/guestfs-actions.pod:738 ../src/guestfs-actions.pod:757
7060 #: ../src/guestfs-actions.pod:771 ../src/guestfs-actions.pod:789
7061 #: ../src/guestfs-actions.pod:803 ../src/guestfs-actions.pod:817
7062 msgid "(Added in 0.9.3)"
7066 #: ../src/guestfs-actions.pod:674
7067 msgid "guestfs_blockdev_getbsz"
7071 #: ../src/guestfs-actions.pod:676
7075 " guestfs_blockdev_getbsz (guestfs_h *g,\n"
7076 " const char *device);\n"
7081 #: ../src/guestfs-actions.pod:680 ../fish/guestfish-actions.pod:454
7082 msgid "This returns the block size of a device."
7086 #: ../src/guestfs-actions.pod:682 ../src/guestfs-actions.pod:782
7087 #: ../fish/guestfish-actions.pod:456 ../fish/guestfish-actions.pod:519
7089 "(Note this is different from both I<size in blocks> and I<filesystem block "
7094 #: ../src/guestfs-actions.pod:691
7095 msgid "guestfs_blockdev_getro"
7099 #: ../src/guestfs-actions.pod:693
7103 " guestfs_blockdev_getro (guestfs_h *g,\n"
7104 " const char *device);\n"
7109 #: ../src/guestfs-actions.pod:697 ../fish/guestfish-actions.pod:465
7111 "Returns a boolean indicating if the block device is read-only (true if read-"
7112 "only, false if not)."
7116 #: ../src/guestfs-actions.pod:702 ../src/guestfs-actions.pod:1409
7117 #: ../src/guestfs-actions.pod:1424 ../src/guestfs-actions.pod:1914
7118 #: ../src/guestfs-actions.pod:1925 ../src/guestfs-actions.pod:1997
7119 #: ../src/guestfs-actions.pod:2052 ../src/guestfs-actions.pod:2067
7120 #: ../src/guestfs-actions.pod:2092 ../src/guestfs-actions.pod:2115
7121 #: ../src/guestfs-actions.pod:3009 ../src/guestfs-actions.pod:3026
7122 #: ../src/guestfs-actions.pod:3045 ../src/guestfs-actions.pod:3208
7123 #: ../src/guestfs-actions.pod:3222 ../src/guestfs-actions.pod:3237
7124 #: ../src/guestfs-actions.pod:3251 ../src/guestfs-actions.pod:3267
7125 #: ../src/guestfs-actions.pod:3282 ../src/guestfs-actions.pod:3298
7126 #: ../src/guestfs-actions.pod:3312 ../src/guestfs-actions.pod:3325
7127 #: ../src/guestfs-actions.pod:3339 ../src/guestfs-actions.pod:3354
7128 #: ../src/guestfs-actions.pod:3369 ../src/guestfs-actions.pod:4900
7129 msgid "This function returns a C truth value on success or -1 on error."
7133 #: ../src/guestfs-actions.pod:706
7134 msgid "guestfs_blockdev_getsize64"
7138 #: ../src/guestfs-actions.pod:708
7142 " guestfs_blockdev_getsize64 (guestfs_h *g,\n"
7143 " const char *device);\n"
7148 #: ../src/guestfs-actions.pod:712 ../fish/guestfish-actions.pod:474
7149 msgid "This returns the size of the device in bytes."
7153 #: ../src/guestfs-actions.pod:714
7154 msgid "See also C<guestfs_blockdev_getsz>."
7158 #: ../src/guestfs-actions.pod:722
7159 msgid "guestfs_blockdev_getss"
7163 #: ../src/guestfs-actions.pod:724
7167 " guestfs_blockdev_getss (guestfs_h *g,\n"
7168 " const char *device);\n"
7173 #: ../src/guestfs-actions.pod:728 ../fish/guestfish-actions.pod:484
7175 "This returns the size of sectors on a block device. Usually 512, but can be "
7176 "larger for modern devices."
7180 #: ../src/guestfs-actions.pod:731
7182 "(Note, this is not the size in sectors, use C<guestfs_blockdev_getsz> for "
7187 #: ../src/guestfs-actions.pod:740
7188 msgid "guestfs_blockdev_getsz"
7192 #: ../src/guestfs-actions.pod:742
7196 " guestfs_blockdev_getsz (guestfs_h *g,\n"
7197 " const char *device);\n"
7202 #: ../src/guestfs-actions.pod:746 ../fish/guestfish-actions.pod:496
7204 "This returns the size of the device in units of 512-byte sectors (even if "
7205 "the sectorsize isn't 512 bytes ... weird)."
7209 #: ../src/guestfs-actions.pod:749
7211 "See also C<guestfs_blockdev_getss> for the real sector size of the device, "
7212 "and C<guestfs_blockdev_getsize64> for the more useful I<size in bytes>."
7216 #: ../src/guestfs-actions.pod:759
7217 msgid "guestfs_blockdev_rereadpt"
7221 #: ../src/guestfs-actions.pod:761
7225 " guestfs_blockdev_rereadpt (guestfs_h *g,\n"
7226 " const char *device);\n"
7231 #: ../src/guestfs-actions.pod:765 ../fish/guestfish-actions.pod:509
7232 msgid "Reread the partition table on C<device>."
7236 #: ../src/guestfs-actions.pod:773
7237 msgid "guestfs_blockdev_setbsz"
7241 #: ../src/guestfs-actions.pod:775
7245 " guestfs_blockdev_setbsz (guestfs_h *g,\n"
7246 " const char *device,\n"
7247 " int blocksize);\n"
7252 #: ../src/guestfs-actions.pod:780 ../fish/guestfish-actions.pod:517
7253 msgid "This sets the block size of a device."
7257 #: ../src/guestfs-actions.pod:791
7258 msgid "guestfs_blockdev_setro"
7262 #: ../src/guestfs-actions.pod:793
7266 " guestfs_blockdev_setro (guestfs_h *g,\n"
7267 " const char *device);\n"
7272 #: ../src/guestfs-actions.pod:797 ../fish/guestfish-actions.pod:528
7273 msgid "Sets the block device named C<device> to read-only."
7277 #: ../src/guestfs-actions.pod:805
7278 msgid "guestfs_blockdev_setrw"
7282 #: ../src/guestfs-actions.pod:807
7286 " guestfs_blockdev_setrw (guestfs_h *g,\n"
7287 " const char *device);\n"
7292 #: ../src/guestfs-actions.pod:811 ../fish/guestfish-actions.pod:536
7293 msgid "Sets the block device named C<device> to read-write."
7297 #: ../src/guestfs-actions.pod:819
7298 msgid "guestfs_case_sensitive_path"
7302 #: ../src/guestfs-actions.pod:821
7306 " guestfs_case_sensitive_path (guestfs_h *g,\n"
7307 " const char *path);\n"
7312 #: ../src/guestfs-actions.pod:825 ../fish/guestfish-actions.pod:544
7314 "This can be used to resolve case insensitive paths on a filesystem which is "
7315 "case sensitive. The use case is to resolve paths which you have read from "
7316 "Windows configuration files or the Windows Registry, to the true path."
7320 #: ../src/guestfs-actions.pod:830 ../fish/guestfish-actions.pod:549
7322 "The command handles a peculiarity of the Linux ntfs-3g filesystem driver "
7323 "(and probably others), which is that although the underlying filesystem is "
7324 "case-insensitive, the driver exports the filesystem to Linux as case-"
7329 #: ../src/guestfs-actions.pod:835 ../fish/guestfish-actions.pod:554
7331 "One consequence of this is that special directories such as C<c:\\windows> "
7332 "may appear as C</WINDOWS> or C</windows> (or other things) depending on the "
7333 "precise details of how they were created. In Windows itself this would not "
7338 #: ../src/guestfs-actions.pod:841 ../fish/guestfish-actions.pod:560
7340 "Bug or feature? You decide: L<http://www.tuxera.com/community/ntfs-3g-faq/"
7345 #: ../src/guestfs-actions.pod:844 ../fish/guestfish-actions.pod:563
7347 "This function resolves the true case of each element in the path and returns "
7348 "the case-sensitive path."
7352 #: ../src/guestfs-actions.pod:847
7354 "Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\") might return C<"
7355 "\"/WINDOWS/system32\"> (the exact return value would depend on details of "
7356 "how the directories were originally created under Windows)."
7360 #: ../src/guestfs-actions.pod:852 ../fish/guestfish-actions.pod:571
7361 msgid "I<Note>: This function does not handle drive names, backslashes etc."
7365 #: ../src/guestfs-actions.pod:855
7366 msgid "See also C<guestfs_realpath>."
7370 #: ../src/guestfs-actions.pod:860 ../src/guestfs-actions.pod:6891
7371 msgid "(Added in 1.0.75)"
7375 #: ../src/guestfs-actions.pod:862
7380 #: ../src/guestfs-actions.pod:864
7384 " guestfs_cat (guestfs_h *g,\n"
7385 " const char *path);\n"
7390 #: ../src/guestfs-actions.pod:868 ../src/guestfs-actions.pod:5387
7391 #: ../fish/guestfish-actions.pod:580 ../fish/guestfish-actions.pod:3601
7392 msgid "Return the contents of the file named C<path>."
7396 #: ../src/guestfs-actions.pod:870
7398 "Note that this function cannot correctly handle binary files (specifically, "
7399 "files containing C<\\0> character which is treated as end of string). For "
7400 "those you need to use the C<guestfs_read_file> or C<guestfs_download> "
7401 "functions which have a more complex interface."
7405 #: ../src/guestfs-actions.pod:878 ../src/guestfs-actions.pod:1057
7406 #: ../src/guestfs-actions.pod:1077 ../src/guestfs-actions.pod:1373
7407 #: ../src/guestfs-actions.pod:1392 ../src/guestfs-actions.pod:1495
7408 #: ../src/guestfs-actions.pod:1514 ../src/guestfs-actions.pod:1763
7409 #: ../src/guestfs-actions.pod:2221 ../src/guestfs-actions.pod:2240
7410 #: ../src/guestfs-actions.pod:2283 ../src/guestfs-actions.pod:2307
7411 #: ../src/guestfs-actions.pod:2324 ../src/guestfs-actions.pod:2353
7412 #: ../src/guestfs-actions.pod:5169 ../src/guestfs-actions.pod:5195
7413 #: ../src/guestfs-actions.pod:5326 ../src/guestfs-actions.pod:5352
7414 #: ../src/guestfs-actions.pod:5376 ../src/guestfs-actions.pod:6276
7415 #: ../src/guestfs-actions.pod:6331 ../src/guestfs-actions.pod:6477
7416 #: ../src/guestfs-actions.pod:6501 ../src/guestfs-actions.pod:7163
7417 #: ../src/guestfs-actions.pod:7189 ../src/guestfs-actions.pod:7215
7418 #: ../src/guestfs-actions.pod:7234 ../src/guestfs-actions.pod:7319
7419 #: ../src/guestfs-actions.pod:7338 ../src/guestfs-actions.pod:7384
7420 #: ../src/guestfs-actions.pod:7403 ../fish/guestfish-actions.pod:587
7421 #: ../fish/guestfish-actions.pod:722 ../fish/guestfish-actions.pod:734
7422 #: ../fish/guestfish-actions.pod:910 ../fish/guestfish-actions.pod:920
7423 #: ../fish/guestfish-actions.pod:987 ../fish/guestfish-actions.pod:997
7424 #: ../fish/guestfish-actions.pod:1192 ../fish/guestfish-actions.pod:1493
7425 #: ../fish/guestfish-actions.pod:1503 ../fish/guestfish-actions.pod:1531
7426 #: ../fish/guestfish-actions.pod:1546 ../fish/guestfish-actions.pod:1556
7427 #: ../fish/guestfish-actions.pod:1575 ../fish/guestfish-actions.pod:3471
7428 #: ../fish/guestfish-actions.pod:3486 ../fish/guestfish-actions.pod:3562
7429 #: ../fish/guestfish-actions.pod:3579 ../fish/guestfish-actions.pod:3594
7430 #: ../fish/guestfish-actions.pod:4220 ../fish/guestfish-actions.pod:4266
7431 #: ../fish/guestfish-actions.pod:4351 ../fish/guestfish-actions.pod:4366
7432 #: ../fish/guestfish-actions.pod:4776 ../fish/guestfish-actions.pod:4794
7433 #: ../fish/guestfish-actions.pod:4811 ../fish/guestfish-actions.pod:4821
7434 #: ../fish/guestfish-actions.pod:4869 ../fish/guestfish-actions.pod:4879
7435 #: ../fish/guestfish-actions.pod:4908 ../fish/guestfish-actions.pod:4918
7437 "Because of the message protocol, there is a transfer limit of somewhere "
7438 "between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
7442 #: ../src/guestfs-actions.pod:881 ../src/guestfs-actions.pod:3485
7443 #: ../src/guestfs-actions.pod:3547 ../src/guestfs-actions.pod:3564
7444 #: ../src/guestfs-actions.pod:3652 ../src/guestfs-actions.pod:4057
7445 #: ../src/guestfs-actions.pod:4071 ../src/guestfs-actions.pod:5275
7446 #: ../src/guestfs-actions.pod:5289 ../src/guestfs-actions.pod:7050
7447 #: ../src/guestfs-actions.pod:7064
7448 msgid "(Added in 0.4)"
7452 #: ../src/guestfs-actions.pod:883
7453 msgid "guestfs_checksum"
7457 #: ../src/guestfs-actions.pod:885
7461 " guestfs_checksum (guestfs_h *g,\n"
7462 " const char *csumtype,\n"
7463 " const char *path);\n"
7468 #: ../src/guestfs-actions.pod:890 ../fish/guestfish-actions.pod:594
7470 "This call computes the MD5, SHAx or CRC checksum of the file named C<path>."
7474 #: ../src/guestfs-actions.pod:893 ../fish/guestfish-actions.pod:597
7476 "The type of checksum to compute is given by the C<csumtype> parameter which "
7477 "must have one of the following values:"
7481 #: ../src/guestfs-actions.pod:898 ../fish/guestfish-actions.pod:602
7486 #: ../src/guestfs-actions.pod:900 ../fish/guestfish-actions.pod:604
7488 "Compute the cyclic redundancy check (CRC) specified by POSIX for the "
7493 #: ../src/guestfs-actions.pod:903 ../fish/guestfish-actions.pod:607
7498 #: ../src/guestfs-actions.pod:905 ../fish/guestfish-actions.pod:609
7499 msgid "Compute the MD5 hash (using the C<md5sum> program)."
7503 #: ../src/guestfs-actions.pod:907 ../fish/guestfish-actions.pod:611
7508 #: ../src/guestfs-actions.pod:909 ../fish/guestfish-actions.pod:613
7509 msgid "Compute the SHA1 hash (using the C<sha1sum> program)."
7513 #: ../src/guestfs-actions.pod:911 ../fish/guestfish-actions.pod:615
7518 #: ../src/guestfs-actions.pod:913 ../fish/guestfish-actions.pod:617
7519 msgid "Compute the SHA224 hash (using the C<sha224sum> program)."
7523 #: ../src/guestfs-actions.pod:915 ../fish/guestfish-actions.pod:619
7528 #: ../src/guestfs-actions.pod:917 ../fish/guestfish-actions.pod:621
7529 msgid "Compute the SHA256 hash (using the C<sha256sum> program)."
7533 #: ../src/guestfs-actions.pod:919 ../fish/guestfish-actions.pod:623
7538 #: ../src/guestfs-actions.pod:921 ../fish/guestfish-actions.pod:625
7539 msgid "Compute the SHA384 hash (using the C<sha384sum> program)."
7543 #: ../src/guestfs-actions.pod:923 ../fish/guestfish-actions.pod:627
7548 #: ../src/guestfs-actions.pod:925 ../fish/guestfish-actions.pod:629
7549 msgid "Compute the SHA512 hash (using the C<sha512sum> program)."
7553 #: ../src/guestfs-actions.pod:929 ../fish/guestfish-actions.pod:633
7554 msgid "The checksum is returned as a printable string."
7558 #: ../src/guestfs-actions.pod:931
7559 msgid "To get the checksum for a device, use C<guestfs_checksum_device>."
7563 #: ../src/guestfs-actions.pod:933
7564 msgid "To get the checksums for many files, use C<guestfs_checksums_out>."
7568 #: ../src/guestfs-actions.pod:938 ../src/guestfs-actions.pod:1246
7569 #: ../src/guestfs-actions.pod:2083 ../src/guestfs-actions.pod:3224
7570 #: ../src/guestfs-actions.pod:3253 ../src/guestfs-actions.pod:3314
7571 #: ../src/guestfs-actions.pod:3341 ../src/guestfs-actions.pod:6747
7572 msgid "(Added in 1.0.2)"
7576 #: ../src/guestfs-actions.pod:940
7577 msgid "guestfs_checksum_device"
7581 #: ../src/guestfs-actions.pod:942
7585 " guestfs_checksum_device (guestfs_h *g,\n"
7586 " const char *csumtype,\n"
7587 " const char *device);\n"
7592 #: ../src/guestfs-actions.pod:947
7594 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
7595 "device named C<device>. For the types of checksums supported see the "
7596 "C<guestfs_checksum> command."
7600 #: ../src/guestfs-actions.pod:954 ../src/guestfs-actions.pod:4806
7601 #: ../src/guestfs-actions.pod:4865 ../src/guestfs-actions.pod:4902
7602 #: ../src/guestfs-actions.pod:4920 ../src/guestfs-actions.pod:5096
7603 #: ../src/guestfs-actions.pod:6656 ../src/guestfs-actions.pod:6670
7604 #: ../src/guestfs-actions.pod:7076
7605 msgid "(Added in 1.3.2)"
7609 #: ../src/guestfs-actions.pod:956
7610 msgid "guestfs_checksums_out"
7614 #: ../src/guestfs-actions.pod:958
7618 " guestfs_checksums_out (guestfs_h *g,\n"
7619 " const char *csumtype,\n"
7620 " const char *directory,\n"
7621 " const char *sumsfile);\n"
7626 #: ../src/guestfs-actions.pod:964 ../fish/guestfish-actions.pod:651
7628 "This command computes the checksums of all regular files in C<directory> and "
7629 "then emits a list of those checksums to the local output file C<sumsfile>."
7633 #: ../src/guestfs-actions.pod:968 ../fish/guestfish-actions.pod:655
7635 "This can be used for verifying the integrity of a virtual machine. However "
7636 "to be properly secure you should pay attention to the output of the checksum "
7637 "command (it uses the ones from GNU coreutils). In particular when the "
7638 "filename is not printable, coreutils uses a special backslash syntax. For "
7639 "more information, see the GNU coreutils info file."
7643 #: ../src/guestfs-actions.pod:978
7644 msgid "(Added in 1.3.7)"
7648 #: ../src/guestfs-actions.pod:980
7649 msgid "guestfs_chmod"
7653 #: ../src/guestfs-actions.pod:982
7657 " guestfs_chmod (guestfs_h *g,\n"
7659 " const char *path);\n"
7664 #: ../src/guestfs-actions.pod:987 ../fish/guestfish-actions.pod:669
7666 "Change the mode (permissions) of C<path> to C<mode>. Only numeric modes are "
7671 #: ../src/guestfs-actions.pod:990 ../fish/guestfish-actions.pod:672
7673 "I<Note>: When using this command from guestfish, C<mode> by default would be "
7674 "decimal, unless you prefix it with C<0> to get octal, ie. use C<0700> not "
7679 #: ../src/guestfs-actions.pod:994 ../src/guestfs-actions.pod:4308
7680 #: ../src/guestfs-actions.pod:4505 ../src/guestfs-actions.pod:4524
7681 #: ../src/guestfs-actions.pod:4543 ../fish/guestfish-actions.pod:676
7682 #: ../fish/guestfish-actions.pod:2917 ../fish/guestfish-actions.pod:3046
7683 #: ../fish/guestfish-actions.pod:3056 ../fish/guestfish-actions.pod:3066
7684 msgid "The mode actually set is affected by the umask."
7688 #: ../src/guestfs-actions.pod:1000
7689 msgid "guestfs_chown"
7693 #: ../src/guestfs-actions.pod:1002
7697 " guestfs_chown (guestfs_h *g,\n"
7700 " const char *path);\n"
7705 #: ../src/guestfs-actions.pod:1008 ../fish/guestfish-actions.pod:682
7706 msgid "Change the file owner to C<owner> and group to C<group>."
7710 #: ../src/guestfs-actions.pod:1010 ../src/guestfs-actions.pod:3416
7711 #: ../fish/guestfish-actions.pod:684 ../fish/guestfish-actions.pod:2375
7713 "Only numeric uid and gid are supported. If you want to use names, you will "
7714 "need to locate and parse the password file yourself (Augeas support makes "
7715 "this relatively easy)."
7719 #: ../src/guestfs-actions.pod:1018
7720 msgid "guestfs_command"
7724 #: ../src/guestfs-actions.pod:1020
7728 " guestfs_command (guestfs_h *g,\n"
7729 " char *const *arguments);\n"
7734 #: ../src/guestfs-actions.pod:1024 ../fish/guestfish-actions.pod:692
7736 "This call runs a command from the guest filesystem. The filesystem must be "
7737 "mounted, and must contain a compatible operating system (ie. something "
7738 "Linux, with the same or compatible processor architecture)."
7742 #: ../src/guestfs-actions.pod:1029
7744 "The single parameter is an argv-style list of arguments. The first element "
7745 "is the name of the program to run. Subsequent elements are parameters. The "
7746 "list must be non-empty (ie. must contain a program name). Note that the "
7747 "command runs directly, and is I<not> invoked via the shell (see "
7752 #: ../src/guestfs-actions.pod:1036 ../fish/guestfish-actions.pod:704
7753 msgid "The return value is anything printed to I<stdout> by the command."
7757 #: ../src/guestfs-actions.pod:1039 ../fish/guestfish-actions.pod:707
7759 "If the command returns a non-zero exit status, then this function returns an "
7760 "error message. The error message string is the content of I<stderr> from "
7765 #: ../src/guestfs-actions.pod:1043 ../fish/guestfish-actions.pod:711
7767 "The C<$PATH> environment variable will contain at least C</usr/bin> and C</"
7768 "bin>. If you require a program from another location, you should provide "
7769 "the full path in the first parameter."
7773 #: ../src/guestfs-actions.pod:1048 ../fish/guestfish-actions.pod:716
7775 "Shared libraries and data files required by the program must be available on "
7776 "filesystems which are mounted in the correct places. It is the caller's "
7777 "responsibility to ensure all filesystems that are needed are mounted at the "
7782 #: ../src/guestfs-actions.pod:1060 ../src/guestfs-actions.pod:1080
7783 #: ../src/guestfs-actions.pod:1548
7784 msgid "(Added in 0.9.1)"
7788 #: ../src/guestfs-actions.pod:1062
7789 msgid "guestfs_command_lines"
7793 #: ../src/guestfs-actions.pod:1064
7797 " guestfs_command_lines (guestfs_h *g,\n"
7798 " char *const *arguments);\n"
7803 #: ../src/guestfs-actions.pod:1068
7805 "This is the same as C<guestfs_command>, but splits the result into a list of "
7810 #: ../src/guestfs-actions.pod:1071
7811 msgid "See also: C<guestfs_sh_lines>"
7815 #: ../src/guestfs-actions.pod:1082
7816 msgid "guestfs_config"
7820 #: ../src/guestfs-actions.pod:1084
7824 " guestfs_config (guestfs_h *g,\n"
7825 " const char *qemuparam,\n"
7826 " const char *qemuvalue);\n"
7831 #: ../src/guestfs-actions.pod:1089 ../fish/guestfish-actions.pod:741
7833 "This can be used to add arbitrary qemu command line parameters of the form "
7834 "C<-param value>. Actually it's not quite arbitrary - we prevent you from "
7835 "setting some parameters which would interfere with parameters that we use."
7839 #: ../src/guestfs-actions.pod:1094 ../fish/guestfish-actions.pod:746
7840 msgid "The first character of C<param> string must be a C<-> (dash)."
7844 #: ../src/guestfs-actions.pod:1096 ../fish/guestfish-actions.pod:748
7845 msgid "C<value> can be NULL."
7849 #: ../src/guestfs-actions.pod:1102
7850 msgid "guestfs_copy_size"
7854 #: ../src/guestfs-actions.pod:1104
7858 " guestfs_copy_size (guestfs_h *g,\n"
7859 " const char *src,\n"
7860 " const char *dest,\n"
7866 #: ../src/guestfs-actions.pod:1110 ../fish/guestfish-actions.pod:754
7868 "This command copies exactly C<size> bytes from one source device or file "
7869 "C<src> to another destination device or file C<dest>."
7873 #: ../src/guestfs-actions.pod:1113 ../fish/guestfish-actions.pod:757
7875 "Note this will fail if the source is too short or if the destination is not "
7880 #: ../src/guestfs-actions.pod:1118 ../src/guestfs-actions.pod:1241
7881 #: ../src/guestfs-actions.pod:1272 ../src/guestfs-actions.pod:1317
7882 #: ../src/guestfs-actions.pod:1697 ../src/guestfs-actions.pod:1719
7883 #: ../src/guestfs-actions.pod:3397 ../src/guestfs-actions.pod:6742
7884 #: ../src/guestfs-actions.pod:6776 ../src/guestfs-actions.pod:7255
7885 #: ../src/guestfs-actions.pod:7274
7887 "This long-running command can generate progress notification messages so "
7888 "that the caller can display a progress bar or indicator. To receive these "
7889 "messages, the caller must register a progress event callback. See L<guestfs"
7890 "(3)/GUESTFS_EVENT_PROGRESS>."
7894 #: ../src/guestfs-actions.pod:1123 ../src/guestfs-actions.pod:4084
7895 #: ../src/guestfs-actions.pod:5302 ../src/guestfs-actions.pod:6983
7896 #: ../src/guestfs-actions.pod:7003 ../src/guestfs-actions.pod:7089
7897 msgid "(Added in 1.0.87)"
7901 #: ../src/guestfs-actions.pod:1125
7906 #: ../src/guestfs-actions.pod:1127
7910 " guestfs_cp (guestfs_h *g,\n"
7911 " const char *src,\n"
7912 " const char *dest);\n"
7917 #: ../src/guestfs-actions.pod:1132 ../fish/guestfish-actions.pod:764
7919 "This copies a file from C<src> to C<dest> where C<dest> is either a "
7920 "destination filename or destination directory."
7924 #: ../src/guestfs-actions.pod:1137 ../src/guestfs-actions.pod:1151
7925 #: ../src/guestfs-actions.pod:1223 ../src/guestfs-actions.pod:1297
7926 #: ../src/guestfs-actions.pod:1411 ../src/guestfs-actions.pod:4769
7927 #: ../src/guestfs-actions.pod:5146
7928 msgid "(Added in 1.0.18)"
7932 #: ../src/guestfs-actions.pod:1139
7933 msgid "guestfs_cp_a"
7937 #: ../src/guestfs-actions.pod:1141
7941 " guestfs_cp_a (guestfs_h *g,\n"
7942 " const char *src,\n"
7943 " const char *dest);\n"
7948 #: ../src/guestfs-actions.pod:1146 ../fish/guestfish-actions.pod:771
7950 "This copies a file or directory from C<src> to C<dest> recursively using the "
7955 #: ../src/guestfs-actions.pod:1153
7960 #: ../src/guestfs-actions.pod:1155
7964 " guestfs_dd (guestfs_h *g,\n"
7965 " const char *src,\n"
7966 " const char *dest);\n"
7971 #: ../src/guestfs-actions.pod:1160 ../fish/guestfish-actions.pod:778
7973 "This command copies from one source device or file C<src> to another "
7974 "destination device or file C<dest>. Normally you would use this to copy to "
7975 "or from a device or partition, for example to duplicate a filesystem."
7979 #: ../src/guestfs-actions.pod:1165
7981 "If the destination is a device, it must be as large or larger than the "
7982 "source file or device, otherwise the copy will fail. This command cannot do "
7983 "partial copies (see C<guestfs_copy_size>)."
7987 #: ../src/guestfs-actions.pod:1173
7992 #: ../src/guestfs-actions.pod:1175
7996 " guestfs_df (guestfs_h *g);\n"
8001 #: ../src/guestfs-actions.pod:1178 ../fish/guestfish-actions.pod:791
8002 msgid "This command runs the C<df> command to report disk space used."
8006 #: ../src/guestfs-actions.pod:1180 ../src/guestfs-actions.pod:1197
8008 "This command is mostly useful for interactive sessions. It is I<not> "
8009 "intended that you try to parse the output string. Use C<guestfs_statvfs> "
8014 #: ../src/guestfs-actions.pod:1187 ../src/guestfs-actions.pod:1204
8015 #: ../src/guestfs-actions.pod:1322 ../src/guestfs-actions.pod:2286
8016 #: ../src/guestfs-actions.pod:2310 ../src/guestfs-actions.pod:2378
8017 #: ../src/guestfs-actions.pod:4194 ../src/guestfs-actions.pod:4669
8018 #: ../src/guestfs-actions.pod:6480 ../src/guestfs-actions.pod:6504
8019 #: ../src/guestfs-actions.pod:7122 ../src/guestfs-actions.pod:7135
8020 #: ../src/guestfs-actions.pod:7148
8021 msgid "(Added in 1.0.54)"
8025 #: ../src/guestfs-actions.pod:1189
8026 msgid "guestfs_df_h"
8030 #: ../src/guestfs-actions.pod:1191
8034 " guestfs_df_h (guestfs_h *g);\n"
8039 #: ../src/guestfs-actions.pod:1194 ../fish/guestfish-actions.pod:801
8041 "This command runs the C<df -h> command to report disk space used in human-"
8046 #: ../src/guestfs-actions.pod:1206
8047 msgid "guestfs_dmesg"
8051 #: ../src/guestfs-actions.pod:1208
8055 " guestfs_dmesg (guestfs_h *g);\n"
8060 #: ../src/guestfs-actions.pod:1211 ../fish/guestfish-actions.pod:812
8062 "This returns the kernel messages (C<dmesg> output) from the guest kernel. "
8063 "This is sometimes useful for extended debugging of problems."
8067 #: ../src/guestfs-actions.pod:1215
8069 "Another way to get the same information is to enable verbose messages with "
8070 "C<guestfs_set_verbose> or by setting the environment variable "
8071 "C<LIBGUESTFS_DEBUG=1> before running the program."
8075 #: ../src/guestfs-actions.pod:1225
8076 msgid "guestfs_download"
8080 #: ../src/guestfs-actions.pod:1227
8084 " guestfs_download (guestfs_h *g,\n"
8085 " const char *remotefilename,\n"
8086 " const char *filename);\n"
8091 #: ../src/guestfs-actions.pod:1232 ../src/guestfs-actions.pod:1257
8092 #: ../fish/guestfish-actions.pod:825 ../fish/guestfish-actions.pod:838
8094 "Download file C<remotefilename> and save it as C<filename> on the local "
8099 #: ../src/guestfs-actions.pod:1235 ../src/guestfs-actions.pod:6736
8100 #: ../fish/guestfish-actions.pod:828 ../fish/guestfish-actions.pod:4524
8101 msgid "C<filename> can also be a named pipe."
8105 #: ../src/guestfs-actions.pod:1237
8106 msgid "See also C<guestfs_upload>, C<guestfs_cat>."
8110 #: ../src/guestfs-actions.pod:1248
8111 msgid "guestfs_download_offset"
8115 #: ../src/guestfs-actions.pod:1250
8119 " guestfs_download_offset (guestfs_h *g,\n"
8120 " const char *remotefilename,\n"
8121 " const char *filename,\n"
8122 " int64_t offset,\n"
8128 #: ../src/guestfs-actions.pod:1260 ../fish/guestfish-actions.pod:841
8130 "C<remotefilename> is read for C<size> bytes starting at C<offset> (this "
8131 "region must be within the file or device)."
8135 #: ../src/guestfs-actions.pod:1263
8137 "Note that there is no limit on the amount of data that can be downloaded "
8138 "with this call, unlike with C<guestfs_pread>, and this call always reads the "
8139 "full amount unless an error occurs."
8143 #: ../src/guestfs-actions.pod:1268
8144 msgid "See also C<guestfs_download>, C<guestfs_pread>."
8148 #: ../src/guestfs-actions.pod:1277 ../src/guestfs-actions.pod:6781
8149 msgid "(Added in 1.5.17)"
8153 #: ../src/guestfs-actions.pod:1279
8154 msgid "guestfs_drop_caches"
8158 #: ../src/guestfs-actions.pod:1281
8162 " guestfs_drop_caches (guestfs_h *g,\n"
8163 " int whattodrop);\n"
8168 #: ../src/guestfs-actions.pod:1285 ../fish/guestfish-actions.pod:857
8170 "This instructs the guest kernel to drop its page cache, and/or dentries and "
8171 "inode caches. The parameter C<whattodrop> tells the kernel what precisely "
8172 "to drop, see L<http://linux-mm.org/Drop_Caches>"
8176 #: ../src/guestfs-actions.pod:1290 ../fish/guestfish-actions.pod:862
8177 msgid "Setting C<whattodrop> to 3 should drop everything."
8181 #: ../src/guestfs-actions.pod:1292 ../fish/guestfish-actions.pod:864
8183 "This automatically calls L<sync(2)> before the operation, so that the "
8184 "maximum guest memory is freed."
8188 #: ../src/guestfs-actions.pod:1299
8193 #: ../src/guestfs-actions.pod:1301
8197 " guestfs_du (guestfs_h *g,\n"
8198 " const char *path);\n"
8203 #: ../src/guestfs-actions.pod:1305 ../fish/guestfish-actions.pod:871
8205 "This command runs the C<du -s> command to estimate file space usage for "
8210 #: ../src/guestfs-actions.pod:1308 ../fish/guestfish-actions.pod:874
8212 "C<path> can be a file or a directory. If C<path> is a directory then the "
8213 "estimate includes the contents of the directory and all subdirectories "
8218 #: ../src/guestfs-actions.pod:1312 ../fish/guestfish-actions.pod:878
8220 "The result is the estimated size in I<kilobytes> (ie. units of 1024 bytes)."
8224 #: ../src/guestfs-actions.pod:1324
8225 msgid "guestfs_e2fsck_f"
8229 #: ../src/guestfs-actions.pod:1326
8233 " guestfs_e2fsck_f (guestfs_h *g,\n"
8234 " const char *device);\n"
8239 #: ../src/guestfs-actions.pod:1330 ../fish/guestfish-actions.pod:885
8241 "This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3 filesystem checker "
8242 "on C<device>, noninteractively (C<-p>), even if the filesystem appears to be "
8247 #: ../src/guestfs-actions.pod:1334
8249 "This command is only needed because of C<guestfs_resize2fs> (q.v.). "
8250 "Normally you should use C<guestfs_fsck>."
8254 #: ../src/guestfs-actions.pod:1339
8255 msgid "(Added in 1.0.29)"
8259 #: ../src/guestfs-actions.pod:1341
8260 msgid "guestfs_echo_daemon"
8264 #: ../src/guestfs-actions.pod:1343
8268 " guestfs_echo_daemon (guestfs_h *g,\n"
8269 " char *const *words);\n"
8274 #: ../src/guestfs-actions.pod:1347 ../fish/guestfish-actions.pod:896
8276 "This command concatenates the list of C<words> passed with single spaces "
8277 "between them and returns the resulting string."
8281 #: ../src/guestfs-actions.pod:1350 ../fish/guestfish-actions.pod:899
8282 msgid "You can use this command to test the connection through to the daemon."
8286 #: ../src/guestfs-actions.pod:1352
8287 msgid "See also C<guestfs_ping_daemon>."
8291 #: ../src/guestfs-actions.pod:1357 ../src/guestfs-actions.pod:2094
8292 #: ../src/guestfs-actions.pod:5980
8293 msgid "(Added in 1.0.69)"
8297 #: ../src/guestfs-actions.pod:1359
8298 msgid "guestfs_egrep"
8302 #: ../src/guestfs-actions.pod:1361
8306 " guestfs_egrep (guestfs_h *g,\n"
8307 " const char *regex,\n"
8308 " const char *path);\n"
8313 #: ../src/guestfs-actions.pod:1366 ../fish/guestfish-actions.pod:907
8315 "This calls the external C<egrep> program and returns the matching lines."
8319 #: ../src/guestfs-actions.pod:1376 ../src/guestfs-actions.pod:1395
8320 #: ../src/guestfs-actions.pod:1452 ../src/guestfs-actions.pod:1498
8321 #: ../src/guestfs-actions.pod:1517 ../src/guestfs-actions.pod:2224
8322 #: ../src/guestfs-actions.pod:2243 ../src/guestfs-actions.pod:2399
8323 #: ../src/guestfs-actions.pod:2412 ../src/guestfs-actions.pod:2427
8324 #: ../src/guestfs-actions.pod:2473 ../src/guestfs-actions.pod:2495
8325 #: ../src/guestfs-actions.pod:2508 ../src/guestfs-actions.pod:3577
8326 #: ../src/guestfs-actions.pod:3591 ../src/guestfs-actions.pod:3604
8327 #: ../src/guestfs-actions.pod:3618 ../src/guestfs-actions.pod:4604
8328 #: ../src/guestfs-actions.pod:5480 ../src/guestfs-actions.pod:5529
8329 #: ../src/guestfs-actions.pod:6348 ../src/guestfs-actions.pod:6360
8330 #: ../src/guestfs-actions.pod:6373 ../src/guestfs-actions.pod:6386
8331 #: ../src/guestfs-actions.pod:6408 ../src/guestfs-actions.pod:6421
8332 #: ../src/guestfs-actions.pod:6434 ../src/guestfs-actions.pod:6447
8333 #: ../src/guestfs-actions.pod:7218 ../src/guestfs-actions.pod:7237
8334 #: ../src/guestfs-actions.pod:7322 ../src/guestfs-actions.pod:7341
8335 #: ../src/guestfs-actions.pod:7387 ../src/guestfs-actions.pod:7406
8336 msgid "(Added in 1.0.66)"
8340 #: ../src/guestfs-actions.pod:1378
8341 msgid "guestfs_egrepi"
8345 #: ../src/guestfs-actions.pod:1380
8349 " guestfs_egrepi (guestfs_h *g,\n"
8350 " const char *regex,\n"
8351 " const char *path);\n"
8356 #: ../src/guestfs-actions.pod:1385 ../fish/guestfish-actions.pod:917
8358 "This calls the external C<egrep -i> program and returns the matching lines."
8362 #: ../src/guestfs-actions.pod:1397
8363 msgid "guestfs_equal"
8367 #: ../src/guestfs-actions.pod:1399
8371 " guestfs_equal (guestfs_h *g,\n"
8372 " const char *file1,\n"
8373 " const char *file2);\n"
8378 #: ../src/guestfs-actions.pod:1404 ../fish/guestfish-actions.pod:927
8380 "This compares the two files C<file1> and C<file2> and returns true if their "
8381 "content is exactly equal, or false otherwise."
8385 #: ../src/guestfs-actions.pod:1407 ../fish/guestfish-actions.pod:930
8386 msgid "The external L<cmp(1)> program is used for the comparison."
8390 #: ../src/guestfs-actions.pod:1413
8391 msgid "guestfs_exists"
8395 #: ../src/guestfs-actions.pod:1415
8399 " guestfs_exists (guestfs_h *g,\n"
8400 " const char *path);\n"
8405 #: ../src/guestfs-actions.pod:1419 ../fish/guestfish-actions.pod:936
8407 "This returns C<true> if and only if there is a file, directory (or anything) "
8408 "with the given C<path> name."
8412 #: ../src/guestfs-actions.pod:1422
8413 msgid "See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>."
8417 #: ../src/guestfs-actions.pod:1428
8418 msgid "guestfs_fallocate"
8422 #: ../src/guestfs-actions.pod:1430
8426 " guestfs_fallocate (guestfs_h *g,\n"
8427 " const char *path,\n"
8433 #: ../src/guestfs-actions.pod:1435 ../src/guestfs-actions.pod:1461
8434 #: ../fish/guestfish-actions.pod:945 ../fish/guestfish-actions.pod:964
8436 "This command preallocates a file (containing zero bytes) named C<path> of "
8437 "size C<len> bytes. If the file exists already, it is overwritten."
8441 #: ../src/guestfs-actions.pod:1439 ../fish/guestfish-actions.pod:949
8443 "Do not confuse this with the guestfish-specific C<alloc> command which "
8444 "allocates a file in the host and attaches it as a device."
8448 #: ../src/guestfs-actions.pod:1445 ../fish/guestfish-actions.pod:953
8450 "This function is deprecated. In new code, use the C<fallocate64> call "
8455 #: ../src/guestfs-actions.pod:1454
8456 msgid "guestfs_fallocate64"
8460 #: ../src/guestfs-actions.pod:1456
8464 " guestfs_fallocate64 (guestfs_h *g,\n"
8465 " const char *path,\n"
8471 #: ../src/guestfs-actions.pod:1465
8473 "Note that this call allocates disk blocks for the file. To create a sparse "
8474 "file use C<guestfs_truncate_size> instead."
8478 #: ../src/guestfs-actions.pod:1468
8480 "The deprecated call C<guestfs_fallocate> does the same, but owing to an "
8481 "oversight it only allowed 30 bit lengths to be specified, effectively "
8482 "limiting the maximum size of files created through that call to 1GB."
8486 #: ../src/guestfs-actions.pod:1473 ../fish/guestfish-actions.pod:976
8488 "Do not confuse this with the guestfish-specific C<alloc> and C<sparse> "
8489 "commands which create a file in the host and attach it as a device."
8493 #: ../src/guestfs-actions.pod:1479
8494 msgid "(Added in 1.3.17)"
8498 #: ../src/guestfs-actions.pod:1481
8499 msgid "guestfs_fgrep"
8503 #: ../src/guestfs-actions.pod:1483
8507 " guestfs_fgrep (guestfs_h *g,\n"
8508 " const char *pattern,\n"
8509 " const char *path);\n"
8514 #: ../src/guestfs-actions.pod:1488 ../fish/guestfish-actions.pod:984
8516 "This calls the external C<fgrep> program and returns the matching lines."
8520 #: ../src/guestfs-actions.pod:1500
8521 msgid "guestfs_fgrepi"
8525 #: ../src/guestfs-actions.pod:1502
8529 " guestfs_fgrepi (guestfs_h *g,\n"
8530 " const char *pattern,\n"
8531 " const char *path);\n"
8536 #: ../src/guestfs-actions.pod:1507 ../fish/guestfish-actions.pod:994
8538 "This calls the external C<fgrep -i> program and returns the matching lines."
8542 #: ../src/guestfs-actions.pod:1519
8543 msgid "guestfs_file"
8547 #: ../src/guestfs-actions.pod:1521
8551 " guestfs_file (guestfs_h *g,\n"
8552 " const char *path);\n"
8557 #: ../src/guestfs-actions.pod:1525 ../fish/guestfish-actions.pod:1004
8559 "This call uses the standard L<file(1)> command to determine the type or "
8560 "contents of the file."
8564 #: ../src/guestfs-actions.pod:1528 ../fish/guestfish-actions.pod:1007
8566 "This call will also transparently look inside various types of compressed "
8571 #: ../src/guestfs-actions.pod:1531 ../fish/guestfish-actions.pod:1010
8573 "The exact command which runs is C<file -zb path>. Note in particular that "
8574 "the filename is not prepended to the output (the C<-b> option)."
8578 #: ../src/guestfs-actions.pod:1535
8580 "This command can also be used on C</dev/> devices (and partitions, LV "
8581 "names). You can for example use this to determine if a device contains a "
8582 "filesystem, although it's usually better to use C<guestfs_vfs_type>."
8586 #: ../src/guestfs-actions.pod:1540 ../fish/guestfish-actions.pod:1019
8588 "If the C<path> does not begin with C</dev/> then this command only works for "
8589 "the content of regular files. For other file types (directory, symbolic "
8590 "link etc) it will just return the string C<directory> etc."
8594 #: ../src/guestfs-actions.pod:1550
8595 msgid "guestfs_file_architecture"
8599 #: ../src/guestfs-actions.pod:1552
8603 " guestfs_file_architecture (guestfs_h *g,\n"
8604 " const char *filename);\n"
8609 #: ../src/guestfs-actions.pod:1556 ../fish/guestfish-actions.pod:1028
8611 "This detects the architecture of the binary C<filename>, and returns it if "
8616 #: ../src/guestfs-actions.pod:1559 ../fish/guestfish-actions.pod:1031
8617 msgid "Currently defined architectures are:"
8621 #: ../src/guestfs-actions.pod:1563 ../fish/guestfish-actions.pod:1035
8626 #: ../src/guestfs-actions.pod:1565 ../fish/guestfish-actions.pod:1037
8628 "This string is returned for all 32 bit i386, i486, i586, i686 binaries "
8629 "irrespective of the precise processor requirements of the binary."
8633 #: ../src/guestfs-actions.pod:1568 ../fish/guestfish-actions.pod:1040
8638 #: ../src/guestfs-actions.pod:1570 ../fish/guestfish-actions.pod:1042
8639 msgid "64 bit x86-64."
8643 #: ../src/guestfs-actions.pod:1572 ../fish/guestfish-actions.pod:1044
8648 #: ../src/guestfs-actions.pod:1574 ../fish/guestfish-actions.pod:1046
8649 msgid "32 bit SPARC."
8653 #: ../src/guestfs-actions.pod:1576 ../fish/guestfish-actions.pod:1048
8658 #: ../src/guestfs-actions.pod:1578 ../fish/guestfish-actions.pod:1050
8659 msgid "64 bit SPARC V9 and above."
8663 #: ../src/guestfs-actions.pod:1580 ../fish/guestfish-actions.pod:1052
8668 #: ../src/guestfs-actions.pod:1582 ../fish/guestfish-actions.pod:1054
8669 msgid "Intel Itanium."
8670 msgstr "Intel Itanium."
8673 #: ../src/guestfs-actions.pod:1584 ../fish/guestfish-actions.pod:1056
8678 #: ../src/guestfs-actions.pod:1586 ../fish/guestfish-actions.pod:1058
8679 msgid "32 bit Power PC."
8683 #: ../src/guestfs-actions.pod:1588 ../fish/guestfish-actions.pod:1060
8688 #: ../src/guestfs-actions.pod:1590 ../fish/guestfish-actions.pod:1062
8689 msgid "64 bit Power PC."
8693 #: ../src/guestfs-actions.pod:1594 ../fish/guestfish-actions.pod:1066
8694 msgid "Libguestfs may return other architecture strings in future."
8698 #: ../src/guestfs-actions.pod:1596 ../fish/guestfish-actions.pod:1068
8699 msgid "The function works on at least the following types of files:"
8703 #: ../src/guestfs-actions.pod:1602 ../fish/guestfish-actions.pod:1074
8704 msgid "many types of Un*x and Linux binary"
8708 #: ../src/guestfs-actions.pod:1606 ../fish/guestfish-actions.pod:1078
8709 msgid "many types of Un*x and Linux shared library"
8713 #: ../src/guestfs-actions.pod:1610 ../fish/guestfish-actions.pod:1082
8714 msgid "Windows Win32 and Win64 binaries"
8718 #: ../src/guestfs-actions.pod:1614 ../fish/guestfish-actions.pod:1086
8719 msgid "Windows Win32 and Win64 DLLs"
8723 #: ../src/guestfs-actions.pod:1616 ../fish/guestfish-actions.pod:1088
8724 msgid "Win32 binaries and DLLs return C<i386>."
8728 #: ../src/guestfs-actions.pod:1618 ../fish/guestfish-actions.pod:1090
8729 msgid "Win64 binaries and DLLs return C<x86_64>."
8733 #: ../src/guestfs-actions.pod:1622 ../fish/guestfish-actions.pod:1094
8734 msgid "Linux kernel modules"
8738 #: ../src/guestfs-actions.pod:1626 ../fish/guestfish-actions.pod:1098
8739 msgid "Linux new-style initrd images"
8743 #: ../src/guestfs-actions.pod:1630 ../fish/guestfish-actions.pod:1102
8744 msgid "some non-x86 Linux vmlinuz kernels"
8748 #: ../src/guestfs-actions.pod:1634 ../fish/guestfish-actions.pod:1106
8749 msgid "What it can't do currently:"
8753 #: ../src/guestfs-actions.pod:1640 ../fish/guestfish-actions.pod:1112
8754 msgid "static libraries (libfoo.a)"
8758 #: ../src/guestfs-actions.pod:1644 ../fish/guestfish-actions.pod:1116
8759 msgid "Linux old-style initrd as compressed ext2 filesystem (RHEL 3)"
8763 #: ../src/guestfs-actions.pod:1648 ../fish/guestfish-actions.pod:1120
8764 msgid "x86 Linux vmlinuz kernels"
8768 #: ../src/guestfs-actions.pod:1650 ../fish/guestfish-actions.pod:1122
8770 "x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and "
8771 "compressed code, and are horribly hard to unpack. If you want to find the "
8772 "architecture of a kernel, use the architecture of the associated initrd or "
8773 "kernel module(s) instead."
8777 #: ../src/guestfs-actions.pod:1660 ../src/guestfs-actions.pod:1823
8778 #: ../src/guestfs-actions.pod:1840 ../src/guestfs-actions.pod:2531
8779 #: ../src/guestfs-actions.pod:2616 ../src/guestfs-actions.pod:2642
8780 #: ../src/guestfs-actions.pod:2730 ../src/guestfs-actions.pod:2751
8781 #: ../src/guestfs-actions.pod:2788 ../src/guestfs-actions.pod:2872
8782 #: ../src/guestfs-actions.pod:2969 ../src/guestfs-actions.pod:3195
8783 #: ../src/guestfs-actions.pod:3327
8784 msgid "(Added in 1.5.3)"
8788 #: ../src/guestfs-actions.pod:1662
8789 msgid "guestfs_filesize"
8793 #: ../src/guestfs-actions.pod:1664
8797 " guestfs_filesize (guestfs_h *g,\n"
8798 " const char *file);\n"
8803 #: ../src/guestfs-actions.pod:1668 ../fish/guestfish-actions.pod:1133
8804 msgid "This command returns the size of C<file> in bytes."
8808 #: ../src/guestfs-actions.pod:1670
8810 "To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>, "
8811 "C<guestfs_is_dir>, C<guestfs_is_file> etc. To get the size of block "
8812 "devices, use C<guestfs_blockdev_getsize64>."
8816 #: ../src/guestfs-actions.pod:1676
8817 msgid "(Added in 1.0.82)"
8821 #: ../src/guestfs-actions.pod:1678
8822 msgid "guestfs_fill"
8826 #: ../src/guestfs-actions.pod:1680
8830 " guestfs_fill (guestfs_h *g,\n"
8833 " const char *path);\n"
8838 #: ../src/guestfs-actions.pod:1686 ../fish/guestfish-actions.pod:1143
8840 "This command creates a new file called C<path>. The initial content of the "
8841 "file is C<len> octets of C<c>, where C<c> must be a number in the range C<"
8846 #: ../src/guestfs-actions.pod:1690
8848 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
8849 "C<guestfs_truncate_size>. To create a file with a pattern of repeating "
8850 "bytes use C<guestfs_fill_pattern>."
8854 #: ../src/guestfs-actions.pod:1702
8855 msgid "(Added in 1.0.79)"
8859 #: ../src/guestfs-actions.pod:1704
8860 msgid "guestfs_fill_pattern"
8864 #: ../src/guestfs-actions.pod:1706
8868 " guestfs_fill_pattern (guestfs_h *g,\n"
8869 " const char *pattern,\n"
8871 " const char *path);\n"
8876 #: ../src/guestfs-actions.pod:1712
8878 "This function is like C<guestfs_fill> except that it creates a new file of "
8879 "length C<len> containing the repeating pattern of bytes in C<pattern>. The "
8880 "pattern is truncated if necessary to ensure the length of the file is "
8881 "exactly C<len> bytes."
8885 #: ../src/guestfs-actions.pod:1724
8886 msgid "(Added in 1.3.12)"
8890 #: ../src/guestfs-actions.pod:1726
8891 msgid "guestfs_find"
8895 #: ../src/guestfs-actions.pod:1728
8899 " guestfs_find (guestfs_h *g,\n"
8900 " const char *directory);\n"
8905 #: ../src/guestfs-actions.pod:1732 ../fish/guestfish-actions.pod:1165
8907 "This command lists out all files and directories, recursively, starting at "
8908 "C<directory>. It is essentially equivalent to running the shell command "
8909 "C<find directory -print> but some post-processing happens on the output, "
8914 #: ../src/guestfs-actions.pod:1737 ../fish/guestfish-actions.pod:1170
8916 "This returns a list of strings I<without any prefix>. Thus if the directory "
8921 #: ../src/guestfs-actions.pod:1740 ../fish/guestfish-actions.pod:1173
8931 #: ../src/guestfs-actions.pod:1744
8933 "then the returned list from C<guestfs_find> C</tmp> would be 4 elements:"
8937 #: ../src/guestfs-actions.pod:1747 ../fish/guestfish-actions.pod:1180
8948 #: ../src/guestfs-actions.pod:1752 ../fish/guestfish-actions.pod:1185
8949 msgid "If C<directory> is not a directory, then this command returns an error."
8953 #: ../src/guestfs-actions.pod:1755 ../fish/guestfish-actions.pod:1188
8954 msgid "The returned list is sorted."
8958 #: ../src/guestfs-actions.pod:1757
8959 msgid "See also C<guestfs_find0>."
8963 #: ../src/guestfs-actions.pod:1766 ../src/guestfs-actions.pod:4021
8964 #: ../src/guestfs-actions.pod:5564
8965 msgid "(Added in 1.0.27)"
8969 #: ../src/guestfs-actions.pod:1768
8970 msgid "guestfs_find0"
8974 #: ../src/guestfs-actions.pod:1770
8978 " guestfs_find0 (guestfs_h *g,\n"
8979 " const char *directory,\n"
8980 " const char *files);\n"
8985 #: ../src/guestfs-actions.pod:1775 ../fish/guestfish-actions.pod:1199
8987 "This command lists out all files and directories, recursively, starting at "
8988 "C<directory>, placing the resulting list in the external file called "
8993 #: ../src/guestfs-actions.pod:1779
8995 "This command works the same way as C<guestfs_find> with the following "
9000 #: ../src/guestfs-actions.pod:1786 ../fish/guestfish-actions.pod:1210
9001 msgid "The resulting list is written to an external file."
9005 #: ../src/guestfs-actions.pod:1790 ../fish/guestfish-actions.pod:1214
9007 "Items (filenames) in the result are separated by C<\\0> characters. See "
9008 "L<find(1)> option I<-print0>."
9012 #: ../src/guestfs-actions.pod:1795 ../fish/guestfish-actions.pod:1219
9013 msgid "This command is not limited in the number of names that it can return."
9017 #: ../src/guestfs-actions.pod:1800 ../fish/guestfish-actions.pod:1224
9018 msgid "The result list is not sorted."
9022 #: ../src/guestfs-actions.pod:1806
9023 msgid "(Added in 1.0.74)"
9027 #: ../src/guestfs-actions.pod:1808
9028 msgid "guestfs_findfs_label"
9032 #: ../src/guestfs-actions.pod:1810
9036 " guestfs_findfs_label (guestfs_h *g,\n"
9037 " const char *label);\n"
9042 #: ../src/guestfs-actions.pod:1814 ../fish/guestfish-actions.pod:1234
9044 "This command searches the filesystems and returns the one which has the "
9045 "given label. An error is returned if no such filesystem can be found."
9049 #: ../src/guestfs-actions.pod:1818
9050 msgid "To find the label of a filesystem, use C<guestfs_vfs_label>."
9054 #: ../src/guestfs-actions.pod:1825
9055 msgid "guestfs_findfs_uuid"
9059 #: ../src/guestfs-actions.pod:1827
9063 " guestfs_findfs_uuid (guestfs_h *g,\n"
9064 " const char *uuid);\n"
9069 #: ../src/guestfs-actions.pod:1831 ../fish/guestfish-actions.pod:1244
9071 "This command searches the filesystems and returns the one which has the "
9072 "given UUID. An error is returned if no such filesystem can be found."
9076 #: ../src/guestfs-actions.pod:1835
9077 msgid "To find the UUID of a filesystem, use C<guestfs_vfs_uuid>."
9081 #: ../src/guestfs-actions.pod:1842
9082 msgid "guestfs_fsck"
9086 #: ../src/guestfs-actions.pod:1844
9090 " guestfs_fsck (guestfs_h *g,\n"
9091 " const char *fstype,\n"
9092 " const char *device);\n"
9097 #: ../src/guestfs-actions.pod:1849 ../fish/guestfish-actions.pod:1254
9099 "This runs the filesystem checker (fsck) on C<device> which should have "
9100 "filesystem type C<fstype>."
9104 #: ../src/guestfs-actions.pod:1852 ../fish/guestfish-actions.pod:1257
9106 "The returned integer is the status. See L<fsck(8)> for the list of status "
9107 "codes from C<fsck>."
9111 #: ../src/guestfs-actions.pod:1861 ../fish/guestfish-actions.pod:1266
9112 msgid "Multiple status codes can be summed together."
9116 #: ../src/guestfs-actions.pod:1865 ../fish/guestfish-actions.pod:1270
9118 "A non-zero return code can mean \"success\", for example if errors have been "
9119 "corrected on the filesystem."
9123 #: ../src/guestfs-actions.pod:1870 ../fish/guestfish-actions.pod:1275
9124 msgid "Checking or repairing NTFS volumes is not supported (by linux-ntfs)."
9128 #: ../src/guestfs-actions.pod:1875 ../fish/guestfish-actions.pod:1280
9130 "This command is entirely equivalent to running C<fsck -a -t fstype device>."
9134 #: ../src/guestfs-actions.pod:1879 ../src/guestfs-actions.pod:7260
9135 msgid "(Added in 1.0.16)"
9139 #: ../src/guestfs-actions.pod:1881
9140 msgid "guestfs_get_append"
9144 #: ../src/guestfs-actions.pod:1883
9148 " guestfs_get_append (guestfs_h *g);\n"
9153 #: ../src/guestfs-actions.pod:1886 ../fish/guestfish-actions.pod:1286
9155 "Return the additional kernel options which are added to the guest kernel "
9160 #: ../src/guestfs-actions.pod:1889 ../fish/guestfish-actions.pod:1289
9161 msgid "If C<NULL> then no options are added."
9165 #: ../src/guestfs-actions.pod:1891
9167 "This function returns a string which may be NULL. There is no way to return "
9168 "an error from this function. The string is owned by the guest handle and "
9169 "must I<not> be freed."
9173 #: ../src/guestfs-actions.pod:1895 ../src/guestfs-actions.pod:5242
9174 #: ../src/guestfs-actions.pod:5722 ../src/guestfs-actions.pod:6122
9175 #: ../src/guestfs-actions.pod:6141 ../src/guestfs-actions.pod:6157
9176 #: ../src/guestfs-actions.pod:6174 ../src/guestfs-actions.pod:6931
9177 #: ../src/guestfs-actions.pod:6949 ../src/guestfs-actions.pod:7303
9178 msgid "(Added in 1.0.26)"
9182 #: ../src/guestfs-actions.pod:1897
9183 msgid "guestfs_get_attach_method"
9187 #: ../src/guestfs-actions.pod:1899
9191 " guestfs_get_attach_method (guestfs_h *g);\n"
9196 #: ../src/guestfs-actions.pod:1902
9197 msgid "Return the current attach method. See C<guestfs_set_attach_method>."
9201 #: ../src/guestfs-actions.pod:1907
9202 msgid "guestfs_get_autosync"
9206 #: ../src/guestfs-actions.pod:1909
9210 " guestfs_get_autosync (guestfs_h *g);\n"
9215 #: ../src/guestfs-actions.pod:1912 ../fish/guestfish-actions.pod:1301
9216 msgid "Get the autosync flag."
9220 #: ../src/guestfs-actions.pod:1918
9221 msgid "guestfs_get_direct"
9225 #: ../src/guestfs-actions.pod:1920
9229 " guestfs_get_direct (guestfs_h *g);\n"
9234 #: ../src/guestfs-actions.pod:1923 ../fish/guestfish-actions.pod:1307
9235 msgid "Return the direct appliance mode flag."
9239 #: ../src/guestfs-actions.pod:1927 ../src/guestfs-actions.pod:5791
9240 msgid "(Added in 1.0.72)"
9244 #: ../src/guestfs-actions.pod:1929
9245 msgid "guestfs_get_e2label"
9249 #: ../src/guestfs-actions.pod:1931
9253 " guestfs_get_e2label (guestfs_h *g,\n"
9254 " const char *device);\n"
9259 #: ../src/guestfs-actions.pod:1935 ../fish/guestfish-actions.pod:1313
9261 "This returns the ext2/3/4 filesystem label of the filesystem on C<device>."
9265 #: ../src/guestfs-actions.pod:1941 ../fish/guestfish-actions.pod:1316
9267 "This function is deprecated. In new code, use the C<vfs_label> call instead."
9271 #: ../src/guestfs-actions.pod:1948 ../src/guestfs-actions.pod:1969
9272 #: ../src/guestfs-actions.pod:5809 ../src/guestfs-actions.pod:5828
9273 msgid "(Added in 1.0.15)"
9277 #: ../src/guestfs-actions.pod:1950
9278 msgid "guestfs_get_e2uuid"
9282 #: ../src/guestfs-actions.pod:1952
9286 " guestfs_get_e2uuid (guestfs_h *g,\n"
9287 " const char *device);\n"
9292 #: ../src/guestfs-actions.pod:1956 ../fish/guestfish-actions.pod:1327
9294 "This returns the ext2/3/4 filesystem UUID of the filesystem on C<device>."
9298 #: ../src/guestfs-actions.pod:1962 ../fish/guestfish-actions.pod:1330
9300 "This function is deprecated. In new code, use the C<vfs_uuid> call instead."
9304 #: ../src/guestfs-actions.pod:1971
9305 msgid "guestfs_get_memsize"
9309 #: ../src/guestfs-actions.pod:1973
9313 " guestfs_get_memsize (guestfs_h *g);\n"
9318 #: ../src/guestfs-actions.pod:1976 ../fish/guestfish-actions.pod:1341
9320 "This gets the memory size in megabytes allocated to the qemu subprocess."
9324 #: ../src/guestfs-actions.pod:1979
9326 "If C<guestfs_set_memsize> was not called on this handle, and if "
9327 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
9328 "value for memsize."
9332 #: ../src/guestfs-actions.pod:1983 ../src/guestfs-actions.pod:2064
9333 #: ../src/guestfs-actions.pod:5844 ../src/guestfs-actions.pod:5951
9334 #: ../fish/guestfish-actions.pod:1348 ../fish/guestfish-actions.pod:1399
9335 #: ../fish/guestfish-actions.pod:3927 ../fish/guestfish-actions.pod:4014
9337 "For more information on the architecture of libguestfs, see L<guestfs(3)>."
9341 #: ../src/guestfs-actions.pod:1988 ../src/guestfs-actions.pod:4312
9342 #: ../src/guestfs-actions.pod:4509 ../src/guestfs-actions.pod:4528
9343 #: ../src/guestfs-actions.pod:4547 ../src/guestfs-actions.pod:4559
9344 #: ../src/guestfs-actions.pod:4576 ../src/guestfs-actions.pod:4589
9345 #: ../src/guestfs-actions.pod:5467 ../src/guestfs-actions.pod:5849
9346 #: ../src/guestfs-actions.pod:6096 ../src/guestfs-actions.pod:6697
9347 msgid "(Added in 1.0.55)"
9351 #: ../src/guestfs-actions.pod:1990
9352 msgid "guestfs_get_network"
9356 #: ../src/guestfs-actions.pod:1992
9360 " guestfs_get_network (guestfs_h *g);\n"
9365 #: ../src/guestfs-actions.pod:1995 ../fish/guestfish-actions.pod:1355
9366 msgid "This returns the enable network flag."
9370 #: ../src/guestfs-actions.pod:1999 ../src/guestfs-actions.pod:5868
9371 msgid "(Added in 1.5.4)"
9375 #: ../src/guestfs-actions.pod:2001
9376 msgid "guestfs_get_path"
9380 #: ../src/guestfs-actions.pod:2003
9384 " guestfs_get_path (guestfs_h *g);\n"
9389 #: ../src/guestfs-actions.pod:2006 ../fish/guestfish-actions.pod:1361
9390 msgid "Return the current search path."
9394 #: ../src/guestfs-actions.pod:2008 ../fish/guestfish-actions.pod:1363
9396 "This is always non-NULL. If it wasn't set already, then this will return "
9401 #: ../src/guestfs-actions.pod:2011 ../src/guestfs-actions.pod:2040
9403 "This function returns a string, or NULL on error. The string is owned by "
9404 "the guest handle and must I<not> be freed."
9408 #: ../src/guestfs-actions.pod:2016
9409 msgid "guestfs_get_pid"
9413 #: ../src/guestfs-actions.pod:2018
9417 " guestfs_get_pid (guestfs_h *g);\n"
9422 #: ../src/guestfs-actions.pod:2021 ../fish/guestfish-actions.pod:1372
9424 "Return the process ID of the qemu subprocess. If there is no qemu "
9425 "subprocess, then this will return an error."
9429 #: ../src/guestfs-actions.pod:2024 ../fish/guestfish-actions.pod:1375
9430 msgid "This is an internal call used for debugging and testing."
9434 #: ../src/guestfs-actions.pod:2028
9435 msgid "(Added in 1.0.56)"
9439 #: ../src/guestfs-actions.pod:2030
9440 msgid "guestfs_get_qemu"
9444 #: ../src/guestfs-actions.pod:2032
9448 " guestfs_get_qemu (guestfs_h *g);\n"
9453 #: ../src/guestfs-actions.pod:2035 ../fish/guestfish-actions.pod:1381
9454 msgid "Return the current qemu binary."
9458 #: ../src/guestfs-actions.pod:2037 ../fish/guestfish-actions.pod:1383
9460 "This is always non-NULL. If it wasn't set already, then this will return "
9461 "the default qemu binary name."
9465 #: ../src/guestfs-actions.pod:2043 ../src/guestfs-actions.pod:5913
9466 msgid "(Added in 1.0.6)"
9470 #: ../src/guestfs-actions.pod:2045
9471 msgid "guestfs_get_recovery_proc"
9475 #: ../src/guestfs-actions.pod:2047
9479 " guestfs_get_recovery_proc (guestfs_h *g);\n"
9484 #: ../src/guestfs-actions.pod:2050 ../fish/guestfish-actions.pod:1390
9485 msgid "Return the recovery process enabled flag."
9489 #: ../src/guestfs-actions.pod:2054 ../src/guestfs-actions.pod:3422
9490 #: ../src/guestfs-actions.pod:3719 ../src/guestfs-actions.pod:4119
9491 #: ../src/guestfs-actions.pod:4151 ../src/guestfs-actions.pod:5172
9492 #: ../src/guestfs-actions.pod:5515 ../src/guestfs-actions.pod:5937
9493 #: ../src/guestfs-actions.pod:6600 ../src/guestfs-actions.pod:6620
9494 #: ../src/guestfs-actions.pod:6812
9495 msgid "(Added in 1.0.77)"
9499 #: ../src/guestfs-actions.pod:2056
9500 msgid "guestfs_get_selinux"
9504 #: ../src/guestfs-actions.pod:2058
9508 " guestfs_get_selinux (guestfs_h *g);\n"
9513 #: ../src/guestfs-actions.pod:2061
9515 "This returns the current setting of the selinux flag which is passed to the "
9516 "appliance at boot time. See C<guestfs_set_selinux>."
9520 #: ../src/guestfs-actions.pod:2069 ../src/guestfs-actions.pod:2132
9521 #: ../src/guestfs-actions.pod:5956 ../src/guestfs-actions.pod:6014
9522 msgid "(Added in 1.0.67)"
9526 #: ../src/guestfs-actions.pod:2071
9527 msgid "guestfs_get_state"
9531 #: ../src/guestfs-actions.pod:2073
9535 " guestfs_get_state (guestfs_h *g);\n"
9540 #: ../src/guestfs-actions.pod:2076 ../fish/guestfish-actions.pod:1406
9542 "This returns the current state as an opaque integer. This is only useful "
9543 "for printing debug and internal error messages."
9547 #: ../src/guestfs-actions.pod:2079 ../src/guestfs-actions.pod:3220
9548 #: ../src/guestfs-actions.pod:3249 ../src/guestfs-actions.pod:3310
9549 #: ../src/guestfs-actions.pod:3337 ../fish/guestfish-actions.pod:1409
9550 #: ../fish/guestfish-actions.pod:2257 ../fish/guestfish-actions.pod:2275
9551 #: ../fish/guestfish-actions.pod:2313 ../fish/guestfish-actions.pod:2329
9552 msgid "For more information on states, see L<guestfs(3)>."
9556 #: ../src/guestfs-actions.pod:2085
9557 msgid "guestfs_get_trace"
9561 #: ../src/guestfs-actions.pod:2087
9565 " guestfs_get_trace (guestfs_h *g);\n"
9570 #: ../src/guestfs-actions.pod:2090 ../fish/guestfish-actions.pod:1415
9571 msgid "Return the command trace flag."
9575 #: ../src/guestfs-actions.pod:2096
9576 msgid "guestfs_get_umask"
9580 #: ../src/guestfs-actions.pod:2098
9584 " guestfs_get_umask (guestfs_h *g);\n"
9589 #: ../src/guestfs-actions.pod:2101
9591 "Return the current umask. By default the umask is C<022> unless it has been "
9592 "set by calling C<guestfs_umask>."
9596 #: ../src/guestfs-actions.pod:2108
9597 msgid "guestfs_get_verbose"
9601 #: ../src/guestfs-actions.pod:2110
9605 " guestfs_get_verbose (guestfs_h *g);\n"
9610 #: ../src/guestfs-actions.pod:2113 ../fish/guestfish-actions.pod:1428
9611 msgid "This returns the verbose messages flag."
9615 #: ../src/guestfs-actions.pod:2119
9616 msgid "guestfs_getcon"
9620 #: ../src/guestfs-actions.pod:2121
9624 " guestfs_getcon (guestfs_h *g);\n"
9629 #: ../src/guestfs-actions.pod:2124 ../fish/guestfish-actions.pod:1434
9630 msgid "This gets the SELinux security context of the daemon."
9634 #: ../src/guestfs-actions.pod:2126
9636 "See the documentation about SELINUX in L<guestfs(3)>, and C<guestfs_setcon>"
9640 #: ../src/guestfs-actions.pod:2134
9641 msgid "guestfs_getxattr"
9645 #: ../src/guestfs-actions.pod:2136
9649 " guestfs_getxattr (guestfs_h *g,\n"
9650 " const char *path,\n"
9651 " const char *name,\n"
9652 " size_t *size_r);\n"
9657 #: ../src/guestfs-actions.pod:2142
9659 "Get a single extended attribute from file C<path> named C<name>. This call "
9660 "follows symlinks. If you want to lookup an extended attribute for the "
9661 "symlink itself, use C<guestfs_lgetxattr>."
9665 #: ../src/guestfs-actions.pod:2146 ../src/guestfs-actions.pod:3436
9667 "Normally it is better to get all extended attributes from a file in one go "
9668 "by calling C<guestfs_getxattrs>. However some Linux filesystem "
9669 "implementations are buggy and do not provide a way to list out attributes. "
9670 "For these filesystems (notably ntfs-3g) you have to know the names of the "
9671 "extended attributes you want in advance and call this function."
9675 #: ../src/guestfs-actions.pod:2153 ../src/guestfs-actions.pod:3443
9676 #: ../fish/guestfish-actions.pod:1454 ../fish/guestfish-actions.pod:2394
9678 "Extended attribute values are blobs of binary data. If there is no extended "
9679 "attribute named C<name>, this returns an error."
9683 #: ../src/guestfs-actions.pod:2156
9684 msgid "See also: C<guestfs_getxattrs>, C<guestfs_lgetxattr>, L<attr(5)>."
9688 #: ../src/guestfs-actions.pod:2158 ../src/guestfs-actions.pod:2349
9689 #: ../src/guestfs-actions.pod:3448 ../src/guestfs-actions.pod:5165
9690 #: ../src/guestfs-actions.pod:5191 ../src/guestfs-actions.pod:5372
9692 "This function returns a buffer, or NULL on error. The size of the returned "
9693 "buffer is written to C<*size_r>. I<The caller must free the returned buffer "
9698 #: ../src/guestfs-actions.pod:2162 ../src/guestfs-actions.pod:3452
9699 msgid "(Added in 1.7.24)"
9703 #: ../src/guestfs-actions.pod:2164
9704 msgid "guestfs_getxattrs"
9708 #: ../src/guestfs-actions.pod:2166
9711 " struct guestfs_xattr_list *\n"
9712 " guestfs_getxattrs (guestfs_h *g,\n"
9713 " const char *path);\n"
9718 #: ../src/guestfs-actions.pod:2170 ../fish/guestfish-actions.pod:1463
9720 "This call lists the extended attributes of the file or directory C<path>."
9724 #: ../src/guestfs-actions.pod:2173 ../fish/guestfish-actions.pod:1466
9726 "At the system call level, this is a combination of the L<listxattr(2)> and "
9727 "L<getxattr(2)> calls."
9731 #: ../src/guestfs-actions.pod:2176
9732 msgid "See also: C<guestfs_lgetxattrs>, L<attr(5)>."
9736 #: ../src/guestfs-actions.pod:2178 ../src/guestfs-actions.pod:3464
9737 #: ../src/guestfs-actions.pod:4115
9739 "This function returns a C<struct guestfs_xattr_list *>, or NULL if there was "
9740 "an error. I<The caller must call C<guestfs_free_xattr_list> after use>."
9744 #: ../src/guestfs-actions.pod:2182 ../src/guestfs-actions.pod:3468
9745 #: ../src/guestfs-actions.pod:3633 ../src/guestfs-actions.pod:3669
9746 #: ../src/guestfs-actions.pod:5545 ../src/guestfs-actions.pod:6033
9747 #: ../src/guestfs-actions.pod:7368
9748 msgid "(Added in 1.0.59)"
9752 #: ../src/guestfs-actions.pod:2184
9753 msgid "guestfs_glob_expand"
9757 #: ../src/guestfs-actions.pod:2186
9761 " guestfs_glob_expand (guestfs_h *g,\n"
9762 " const char *pattern);\n"
9767 #: ../src/guestfs-actions.pod:2190 ../fish/guestfish-actions.pod:1475
9769 "This command searches for all the pathnames matching C<pattern> according to "
9770 "the wildcard expansion rules used by the shell."
9774 #: ../src/guestfs-actions.pod:2194 ../fish/guestfish-actions.pod:1479
9776 "If no paths match, then this returns an empty list (note: not an error)."
9780 #: ../src/guestfs-actions.pod:2197 ../fish/guestfish-actions.pod:1482
9782 "It is just a wrapper around the C L<glob(3)> function with flags C<GLOB_MARK|"
9783 "GLOB_BRACE>. See that manual page for more details."
9787 #: ../src/guestfs-actions.pod:2205 ../src/guestfs-actions.pod:6198
9788 #: ../src/guestfs-actions.pod:6215
9789 msgid "(Added in 1.0.50)"
9793 #: ../src/guestfs-actions.pod:2207
9794 msgid "guestfs_grep"
9798 #: ../src/guestfs-actions.pod:2209
9802 " guestfs_grep (guestfs_h *g,\n"
9803 " const char *regex,\n"
9804 " const char *path);\n"
9809 #: ../src/guestfs-actions.pod:2214 ../fish/guestfish-actions.pod:1490
9810 msgid "This calls the external C<grep> program and returns the matching lines."
9814 #: ../src/guestfs-actions.pod:2226
9815 msgid "guestfs_grepi"
9819 #: ../src/guestfs-actions.pod:2228
9823 " guestfs_grepi (guestfs_h *g,\n"
9824 " const char *regex,\n"
9825 " const char *path);\n"
9830 #: ../src/guestfs-actions.pod:2233 ../fish/guestfish-actions.pod:1500
9832 "This calls the external C<grep -i> program and returns the matching lines."
9836 #: ../src/guestfs-actions.pod:2245
9837 msgid "guestfs_grub_install"
9841 #: ../src/guestfs-actions.pod:2247
9845 " guestfs_grub_install (guestfs_h *g,\n"
9846 " const char *root,\n"
9847 " const char *device);\n"
9852 #: ../src/guestfs-actions.pod:2252 ../fish/guestfish-actions.pod:1510
9854 "This command installs GRUB (the Grand Unified Bootloader) on C<device>, with "
9855 "the root directory being C<root>."
9859 #: ../src/guestfs-actions.pod:2255 ../fish/guestfish-actions.pod:1513
9861 "Note: If grub-install reports the error \"No suitable drive was found in the "
9862 "generated device map.\" it may be that you need to create a C</boot/grub/"
9863 "device.map> file first that contains the mapping between grub device names "
9864 "and Linux device names. It is usually sufficient to create a file "
9869 #: ../src/guestfs-actions.pod:2262 ../fish/guestfish-actions.pod:1520
9877 #: ../src/guestfs-actions.pod:2264 ../fish/guestfish-actions.pod:1522
9878 msgid "replacing C</dev/vda> with the name of the installation device."
9882 #: ../src/guestfs-actions.pod:2268
9883 msgid "(Added in 1.0.17)"
9887 #: ../src/guestfs-actions.pod:2270
9888 msgid "guestfs_head"
9892 #: ../src/guestfs-actions.pod:2272
9896 " guestfs_head (guestfs_h *g,\n"
9897 " const char *path);\n"
9902 #: ../src/guestfs-actions.pod:2276 ../fish/guestfish-actions.pod:1528
9904 "This command returns up to the first 10 lines of a file as a list of strings."
9908 #: ../src/guestfs-actions.pod:2288
9909 msgid "guestfs_head_n"
9913 #: ../src/guestfs-actions.pod:2290
9917 " guestfs_head_n (guestfs_h *g,\n"
9919 " const char *path);\n"
9924 #: ../src/guestfs-actions.pod:2295 ../fish/guestfish-actions.pod:1538
9926 "If the parameter C<nrlines> is a positive number, this returns the first "
9927 "C<nrlines> lines of the file C<path>."
9931 #: ../src/guestfs-actions.pod:2298 ../fish/guestfish-actions.pod:1541
9933 "If the parameter C<nrlines> is a negative number, this returns lines from "
9934 "the file C<path>, excluding the last C<nrlines> lines."
9938 #: ../src/guestfs-actions.pod:2301 ../src/guestfs-actions.pod:6495
9939 #: ../fish/guestfish-actions.pod:1544 ../fish/guestfish-actions.pod:4364
9940 msgid "If the parameter C<nrlines> is zero, this returns an empty list."
9944 #: ../src/guestfs-actions.pod:2312
9945 msgid "guestfs_hexdump"
9949 #: ../src/guestfs-actions.pod:2314
9953 " guestfs_hexdump (guestfs_h *g,\n"
9954 " const char *path);\n"
9959 #: ../src/guestfs-actions.pod:2318 ../fish/guestfish-actions.pod:1553
9961 "This runs C<hexdump -C> on the given C<path>. The result is the human-"
9962 "readable, canonical hex dump of the file."
9966 #: ../src/guestfs-actions.pod:2327 ../src/guestfs-actions.pod:6279
9967 #: ../src/guestfs-actions.pod:6334
9968 msgid "(Added in 1.0.22)"
9972 #: ../src/guestfs-actions.pod:2329
9973 msgid "guestfs_initrd_cat"
9977 #: ../src/guestfs-actions.pod:2331
9981 " guestfs_initrd_cat (guestfs_h *g,\n"
9982 " const char *initrdpath,\n"
9983 " const char *filename,\n"
9984 " size_t *size_r);\n"
9989 #: ../src/guestfs-actions.pod:2337 ../fish/guestfish-actions.pod:1563
9991 "This command unpacks the file C<filename> from the initrd file called "
9992 "C<initrdpath>. The filename must be given I<without> the initial C</> "
9997 #: ../src/guestfs-actions.pod:2341 ../fish/guestfish-actions.pod:1567
9999 "For example, in guestfish you could use the following command to examine the "
10000 "boot script (usually called C</init>) contained in a Linux initrd or "
10005 #: ../src/guestfs-actions.pod:2345 ../fish/guestfish-actions.pod:1571
10008 " initrd-cat /boot/initrd-<version>.img init\n"
10013 #: ../src/guestfs-actions.pod:2347
10014 msgid "See also C<guestfs_initrd_list>."
10018 #: ../src/guestfs-actions.pod:2358
10019 msgid "guestfs_initrd_list"
10023 #: ../src/guestfs-actions.pod:2360
10027 " guestfs_initrd_list (guestfs_h *g,\n"
10028 " const char *path);\n"
10033 #: ../src/guestfs-actions.pod:2364 ../fish/guestfish-actions.pod:1582
10034 msgid "This command lists out files contained in an initrd."
10038 #: ../src/guestfs-actions.pod:2366 ../fish/guestfish-actions.pod:1584
10040 "The files are listed without any initial C</> character. The files are "
10041 "listed in the order they appear (not necessarily alphabetical). Directory "
10042 "names are listed as separate items."
10046 #: ../src/guestfs-actions.pod:2370 ../fish/guestfish-actions.pod:1588
10048 "Old Linux kernels (2.4 and earlier) used a compressed ext2 filesystem as "
10049 "initrd. We I<only> support the newer initramfs format (compressed cpio "
10054 #: ../src/guestfs-actions.pod:2380
10055 msgid "guestfs_inotify_add_watch"
10059 #: ../src/guestfs-actions.pod:2382
10063 " guestfs_inotify_add_watch (guestfs_h *g,\n"
10064 " const char *path,\n"
10070 #: ../src/guestfs-actions.pod:2387 ../fish/guestfish-actions.pod:1596
10071 msgid "Watch C<path> for the events listed in C<mask>."
10075 #: ../src/guestfs-actions.pod:2389 ../fish/guestfish-actions.pod:1598
10077 "Note that if C<path> is a directory then events within that directory are "
10078 "watched, but this does I<not> happen recursively (in subdirectories)."
10082 #: ../src/guestfs-actions.pod:2393 ../fish/guestfish-actions.pod:1602
10084 "Note for non-C or non-Linux callers: the inotify events are defined by the "
10085 "Linux kernel ABI and are listed in C</usr/include/sys/inotify.h>."
10089 #: ../src/guestfs-actions.pod:2401
10090 msgid "guestfs_inotify_close"
10094 #: ../src/guestfs-actions.pod:2403
10098 " guestfs_inotify_close (guestfs_h *g);\n"
10103 #: ../src/guestfs-actions.pod:2406 ../fish/guestfish-actions.pod:1610
10105 "This closes the inotify handle which was previously opened by inotify_init. "
10106 "It removes all watches, throws away any pending events, and deallocates all "
10111 #: ../src/guestfs-actions.pod:2414
10112 msgid "guestfs_inotify_files"
10116 #: ../src/guestfs-actions.pod:2416
10120 " guestfs_inotify_files (guestfs_h *g);\n"
10125 #: ../src/guestfs-actions.pod:2419
10127 "This function is a helpful wrapper around C<guestfs_inotify_read> which just "
10128 "returns a list of pathnames of objects that were touched. The returned "
10129 "pathnames are sorted and deduplicated."
10133 #: ../src/guestfs-actions.pod:2429
10134 msgid "guestfs_inotify_init"
10138 #: ../src/guestfs-actions.pod:2431
10142 " guestfs_inotify_init (guestfs_h *g,\n"
10143 " int maxevents);\n"
10148 #: ../src/guestfs-actions.pod:2435 ../fish/guestfish-actions.pod:1626
10150 "This command creates a new inotify handle. The inotify subsystem can be "
10151 "used to notify events which happen to objects in the guest filesystem."
10155 #: ../src/guestfs-actions.pod:2439
10157 "C<maxevents> is the maximum number of events which will be queued up between "
10158 "calls to C<guestfs_inotify_read> or C<guestfs_inotify_files>. If this is "
10159 "passed as C<0>, then the kernel (or previously set) default is used. For "
10160 "Linux 2.6.29 the default was 16384 events. Beyond this limit, the kernel "
10161 "throws away events, but records the fact that it threw them away by setting "
10162 "a flag C<IN_Q_OVERFLOW> in the returned structure list (see "
10163 "C<guestfs_inotify_read>)."
10167 #: ../src/guestfs-actions.pod:2449
10169 "Before any events are generated, you have to add some watches to the "
10170 "internal watch list. See: C<guestfs_inotify_add_watch>, "
10171 "C<guestfs_inotify_rm_watch> and C<guestfs_inotify_watch_all>."
10175 #: ../src/guestfs-actions.pod:2455
10177 "Queued up events should be read periodically by calling "
10178 "C<guestfs_inotify_read> (or C<guestfs_inotify_files> which is just a helpful "
10179 "wrapper around C<guestfs_inotify_read>). If you don't read the events out "
10180 "often enough then you risk the internal queue overflowing."
10184 #: ../src/guestfs-actions.pod:2462
10186 "The handle should be closed after use by calling C<guestfs_inotify_close>. "
10187 "This also removes any watches automatically."
10191 #: ../src/guestfs-actions.pod:2466 ../fish/guestfish-actions.pod:1657
10193 "See also L<inotify(7)> for an overview of the inotify interface as exposed "
10194 "by the Linux kernel, which is roughly what we expose via libguestfs. Note "
10195 "that there is one global inotify handle per libguestfs instance."
10199 #: ../src/guestfs-actions.pod:2475
10200 msgid "guestfs_inotify_read"
10204 #: ../src/guestfs-actions.pod:2477
10207 " struct guestfs_inotify_event_list *\n"
10208 " guestfs_inotify_read (guestfs_h *g);\n"
10213 #: ../src/guestfs-actions.pod:2480 ../fish/guestfish-actions.pod:1666
10215 "Return the complete queue of events that have happened since the previous "
10220 #: ../src/guestfs-actions.pod:2483 ../fish/guestfish-actions.pod:1669
10221 msgid "If no events have happened, this returns an empty list."
10225 #: ../src/guestfs-actions.pod:2485 ../fish/guestfish-actions.pod:1671
10227 "I<Note>: In order to make sure that all events have been read, you must call "
10228 "this function repeatedly until it returns an empty list. The reason is that "
10229 "the call will read events up to the maximum appliance-to-host message size "
10230 "and leave remaining events in the queue."
10234 #: ../src/guestfs-actions.pod:2491
10236 "This function returns a C<struct guestfs_inotify_event_list *>, or NULL if "
10237 "there was an error. I<The caller must call "
10238 "C<guestfs_free_inotify_event_list> after use>."
10242 #: ../src/guestfs-actions.pod:2497
10243 msgid "guestfs_inotify_rm_watch"
10247 #: ../src/guestfs-actions.pod:2499
10251 " guestfs_inotify_rm_watch (guestfs_h *g,\n"
10257 #: ../src/guestfs-actions.pod:2503
10259 "Remove a previously defined inotify watch. See C<guestfs_inotify_add_watch>."
10263 #: ../src/guestfs-actions.pod:2510
10264 msgid "guestfs_inspect_get_arch"
10268 #: ../src/guestfs-actions.pod:2512
10272 " guestfs_inspect_get_arch (guestfs_h *g,\n"
10273 " const char *root);\n"
10278 #: ../src/guestfs-actions.pod:2516 ../src/guestfs-actions.pod:2539
10279 #: ../src/guestfs-actions.pod:2624 ../src/guestfs-actions.pod:2650
10280 #: ../src/guestfs-actions.pod:2689 ../src/guestfs-actions.pod:2711
10281 #: ../src/guestfs-actions.pod:2738 ../src/guestfs-actions.pod:2759
10282 #: ../src/guestfs-actions.pod:2796 ../src/guestfs-actions.pod:2825
10283 #: ../src/guestfs-actions.pod:2856 ../src/guestfs-actions.pod:2880
10284 #: ../src/guestfs-actions.pod:2935 ../src/guestfs-actions.pod:2977
10285 #: ../src/guestfs-actions.pod:3000 ../src/guestfs-actions.pod:3017
10286 #: ../src/guestfs-actions.pod:3034 ../src/guestfs-actions.pod:3053
10288 "This function should only be called with a root device string as returned by "
10289 "C<guestfs_inspect_os>."
10293 #: ../src/guestfs-actions.pod:2519
10295 "This returns the architecture of the inspected operating system. The "
10296 "possible return values are listed under C<guestfs_file_architecture>."
10300 #: ../src/guestfs-actions.pod:2523 ../fish/guestfish-actions.pod:1695
10302 "If the architecture could not be determined, then the string C<unknown> is "
10307 #: ../src/guestfs-actions.pod:2526 ../src/guestfs-actions.pod:2611
10308 #: ../src/guestfs-actions.pod:2678 ../src/guestfs-actions.pod:2698
10309 #: ../src/guestfs-actions.pod:2726 ../src/guestfs-actions.pod:2812
10310 #: ../src/guestfs-actions.pod:2843 ../src/guestfs-actions.pod:2867
10311 #: ../src/guestfs-actions.pod:2921 ../src/guestfs-actions.pod:2964
10312 #: ../src/guestfs-actions.pod:2987 ../src/guestfs-actions.pod:3007
10313 #: ../src/guestfs-actions.pod:3024 ../src/guestfs-actions.pod:3043
10314 #: ../src/guestfs-actions.pod:3146 ../src/guestfs-actions.pod:3187
10315 #: ../fish/guestfish-actions.pod:1698 ../fish/guestfish-actions.pod:1776
10316 #: ../fish/guestfish-actions.pod:1828 ../fish/guestfish-actions.pod:1843
10317 #: ../fish/guestfish-actions.pod:1864 ../fish/guestfish-actions.pod:1928
10318 #: ../fish/guestfish-actions.pod:1952 ../fish/guestfish-actions.pod:1969
10319 #: ../fish/guestfish-actions.pod:2012 ../fish/guestfish-actions.pod:2047
10320 #: ../fish/guestfish-actions.pod:2063 ../fish/guestfish-actions.pod:2076
10321 #: ../fish/guestfish-actions.pod:2089 ../fish/guestfish-actions.pod:2104
10322 #: ../fish/guestfish-actions.pod:2203 ../fish/guestfish-actions.pod:2237
10323 msgid "Please read L<guestfs(3)/INSPECTION> for more details."
10327 #: ../src/guestfs-actions.pod:2533
10328 msgid "guestfs_inspect_get_distro"
10332 #: ../src/guestfs-actions.pod:2535
10336 " guestfs_inspect_get_distro (guestfs_h *g,\n"
10337 " const char *root);\n"
10342 #: ../src/guestfs-actions.pod:2542 ../fish/guestfish-actions.pod:1707
10344 "This returns the distro (distribution) of the inspected operating system."
10348 #: ../src/guestfs-actions.pod:2545 ../fish/guestfish-actions.pod:1710
10349 msgid "Currently defined distros are:"
10353 #: ../src/guestfs-actions.pod:2549 ../fish/guestfish-actions.pod:1714
10354 msgid "\"archlinux\""
10355 msgstr "\"archlinux\""
10358 #: ../src/guestfs-actions.pod:2551 ../fish/guestfish-actions.pod:1716
10359 msgid "Arch Linux."
10360 msgstr "Arch Linux."
10363 #: ../src/guestfs-actions.pod:2553 ../fish/guestfish-actions.pod:1718
10365 msgstr "\"debian\""
10368 #: ../src/guestfs-actions.pod:2555 ../fish/guestfish-actions.pod:1720
10373 #: ../src/guestfs-actions.pod:2557 ../fish/guestfish-actions.pod:1722
10375 msgstr "\"fedora\""
10378 #: ../src/guestfs-actions.pod:2559 ../fish/guestfish-actions.pod:1724
10383 #: ../src/guestfs-actions.pod:2561 ../fish/guestfish-actions.pod:1726
10385 msgstr "\"gentoo\""
10388 #: ../src/guestfs-actions.pod:2563 ../fish/guestfish-actions.pod:1728
10393 #: ../src/guestfs-actions.pod:2565 ../fish/guestfish-actions.pod:1730
10394 msgid "\"linuxmint\""
10395 msgstr "\"linuxmint\""
10398 #: ../src/guestfs-actions.pod:2567 ../fish/guestfish-actions.pod:1732
10399 msgid "Linux Mint."
10400 msgstr "Linux Mint."
10403 #: ../src/guestfs-actions.pod:2569 ../fish/guestfish-actions.pod:1734
10404 msgid "\"mandriva\""
10405 msgstr "\"mandriva\""
10408 #: ../src/guestfs-actions.pod:2571 ../fish/guestfish-actions.pod:1736
10413 #: ../src/guestfs-actions.pod:2573 ../fish/guestfish-actions.pod:1738
10418 #: ../src/guestfs-actions.pod:2575 ../fish/guestfish-actions.pod:1740
10423 #: ../src/guestfs-actions.pod:2577 ../fish/guestfish-actions.pod:1742
10425 msgstr "\"pardus\""
10428 #: ../src/guestfs-actions.pod:2579 ../fish/guestfish-actions.pod:1744
10433 #: ../src/guestfs-actions.pod:2581 ../fish/guestfish-actions.pod:1746
10434 msgid "\"redhat-based\""
10435 msgstr "\"redhat-based\""
10438 #: ../src/guestfs-actions.pod:2583 ../fish/guestfish-actions.pod:1748
10439 msgid "Some Red Hat-derived distro."
10440 msgstr "Дистрибутив, що походить від Red Hat."
10443 #: ../src/guestfs-actions.pod:2585 ../fish/guestfish-actions.pod:1750
10448 #: ../src/guestfs-actions.pod:2587 ../fish/guestfish-actions.pod:1752
10449 msgid "Red Hat Enterprise Linux and some derivatives."
10450 msgstr "Red Hat Enterprise Linux та деякі з похідних дистрибутивів."
10453 #: ../src/guestfs-actions.pod:2589 ../fish/guestfish-actions.pod:1754
10454 msgid "\"slackware\""
10458 #: ../src/guestfs-actions.pod:2591 ../fish/guestfish-actions.pod:1756
10463 #: ../src/guestfs-actions.pod:2593 ../fish/guestfish-actions.pod:1758
10465 msgstr "\"ubuntu\""
10468 #: ../src/guestfs-actions.pod:2595 ../fish/guestfish-actions.pod:1760
10473 #: ../src/guestfs-actions.pod:2597 ../src/guestfs-actions.pod:2669
10474 #: ../src/guestfs-actions.pod:2955 ../fish/guestfish-actions.pod:1762
10475 #: ../fish/guestfish-actions.pod:1819 ../fish/guestfish-actions.pod:2038
10476 msgid "\"unknown\""
10477 msgstr "\"unknown\""
10480 #: ../src/guestfs-actions.pod:2599 ../fish/guestfish-actions.pod:1764
10481 msgid "The distro could not be determined."
10482 msgstr "Дистрибутив, тип якого не вдалося визначити."
10485 #: ../src/guestfs-actions.pod:2601 ../src/guestfs-actions.pod:2947
10486 #: ../fish/guestfish-actions.pod:1766 ../fish/guestfish-actions.pod:2030
10487 msgid "\"windows\""
10488 msgstr "\"windows\""
10491 #: ../src/guestfs-actions.pod:2603 ../fish/guestfish-actions.pod:1768
10493 "Windows does not have distributions. This string is returned if the OS type "
10498 #: ../src/guestfs-actions.pod:2608 ../src/guestfs-actions.pod:2675
10499 #: ../src/guestfs-actions.pod:2961 ../fish/guestfish-actions.pod:1773
10500 #: ../fish/guestfish-actions.pod:1825 ../fish/guestfish-actions.pod:2044
10502 "Future versions of libguestfs may return other strings here. The caller "
10503 "should be prepared to handle any string."
10507 #: ../src/guestfs-actions.pod:2618
10508 msgid "guestfs_inspect_get_filesystems"
10512 #: ../src/guestfs-actions.pod:2620
10516 " guestfs_inspect_get_filesystems (guestfs_h *g,\n"
10517 " const char *root);\n"
10522 #: ../src/guestfs-actions.pod:2627 ../fish/guestfish-actions.pod:1785
10524 "This returns a list of all the filesystems that we think are associated with "
10525 "this operating system. This includes the root filesystem, other ordinary "
10526 "filesystems, and non-mounted devices like swap partitions."
10530 #: ../src/guestfs-actions.pod:2632 ../fish/guestfish-actions.pod:1790
10532 "In the case of a multi-boot virtual machine, it is possible for a filesystem "
10533 "to be shared between operating systems."
10537 #: ../src/guestfs-actions.pod:2635
10539 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
10540 "C<guestfs_inspect_get_mountpoints>."
10544 #: ../src/guestfs-actions.pod:2644
10545 msgid "guestfs_inspect_get_format"
10549 #: ../src/guestfs-actions.pod:2646
10553 " guestfs_inspect_get_format (guestfs_h *g,\n"
10554 " const char *root);\n"
10559 #: ../src/guestfs-actions.pod:2653 ../fish/guestfish-actions.pod:1803
10561 "This returns the format of the inspected operating system. You can use it "
10562 "to detect install images, live CDs and similar."
10566 #: ../src/guestfs-actions.pod:2656 ../fish/guestfish-actions.pod:1806
10567 msgid "Currently defined formats are:"
10571 #: ../src/guestfs-actions.pod:2660 ../fish/guestfish-actions.pod:1810
10572 msgid "\"installed\""
10573 msgstr "\"installed\""
10576 #: ../src/guestfs-actions.pod:2662 ../fish/guestfish-actions.pod:1812
10577 msgid "This is an installed operating system."
10578 msgstr "Це встановлена операційна система."
10581 #: ../src/guestfs-actions.pod:2664 ../fish/guestfish-actions.pod:1814
10582 msgid "\"installer\""
10586 #: ../src/guestfs-actions.pod:2666 ../fish/guestfish-actions.pod:1816
10588 "The disk image being inspected is not an installed operating system, but a "
10589 "I<bootable> install disk, live CD, or similar."
10593 #: ../src/guestfs-actions.pod:2671 ../fish/guestfish-actions.pod:1821
10594 msgid "The format of this disk image is not known."
10598 #: ../src/guestfs-actions.pod:2683
10599 msgid "guestfs_inspect_get_hostname"
10603 #: ../src/guestfs-actions.pod:2685
10607 " guestfs_inspect_get_hostname (guestfs_h *g,\n"
10608 " const char *root);\n"
10613 #: ../src/guestfs-actions.pod:2692 ../fish/guestfish-actions.pod:1837
10615 "This function returns the hostname of the operating system as found by "
10616 "inspection of the guest's configuration files."
10620 #: ../src/guestfs-actions.pod:2695 ../fish/guestfish-actions.pod:1840
10622 "If the hostname could not be determined, then the string C<unknown> is "
10627 #: ../src/guestfs-actions.pod:2703
10628 msgid "(Added in 1.7.9)"
10632 #: ../src/guestfs-actions.pod:2705
10633 msgid "guestfs_inspect_get_major_version"
10637 #: ../src/guestfs-actions.pod:2707
10641 " guestfs_inspect_get_major_version (guestfs_h *g,\n"
10642 " const char *root);\n"
10647 #: ../src/guestfs-actions.pod:2714 ../fish/guestfish-actions.pod:1852
10649 "This returns the major version number of the inspected operating system."
10653 #: ../src/guestfs-actions.pod:2717 ../fish/guestfish-actions.pod:1855
10655 "Windows uses a consistent versioning scheme which is I<not> reflected in the "
10656 "popular public names used by the operating system. Notably the operating "
10657 "system known as \"Windows 7\" is really version 6.1 (ie. major = 6, minor = "
10658 "1). You can find out the real versions corresponding to releases of Windows "
10659 "by consulting Wikipedia or MSDN."
10663 #: ../src/guestfs-actions.pod:2724 ../src/guestfs-actions.pod:2744
10664 #: ../fish/guestfish-actions.pod:1862 ../fish/guestfish-actions.pod:1876
10665 msgid "If the version could not be determined, then C<0> is returned."
10669 #: ../src/guestfs-actions.pod:2732
10670 msgid "guestfs_inspect_get_minor_version"
10674 #: ../src/guestfs-actions.pod:2734
10678 " guestfs_inspect_get_minor_version (guestfs_h *g,\n"
10679 " const char *root);\n"
10684 #: ../src/guestfs-actions.pod:2741 ../fish/guestfish-actions.pod:1873
10686 "This returns the minor version number of the inspected operating system."
10690 #: ../src/guestfs-actions.pod:2746
10692 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
10693 "C<guestfs_inspect_get_major_version>."
10697 #: ../src/guestfs-actions.pod:2753
10698 msgid "guestfs_inspect_get_mountpoints"
10702 #: ../src/guestfs-actions.pod:2755
10706 " guestfs_inspect_get_mountpoints (guestfs_h *g,\n"
10707 " const char *root);\n"
10712 #: ../src/guestfs-actions.pod:2762 ../fish/guestfish-actions.pod:1888
10714 "This returns a hash of where we think the filesystems associated with this "
10715 "operating system should be mounted. Callers should note that this is at "
10716 "best an educated guess made by reading configuration files such as C</etc/"
10717 "fstab>. I<In particular note> that this may return filesystems which are "
10718 "non-existent or not mountable and callers should be prepared to handle or "
10719 "ignore failures if they try to mount them."
10723 #: ../src/guestfs-actions.pod:2771 ../fish/guestfish-actions.pod:1897
10725 "Each element in the returned hashtable has a key which is the path of the "
10726 "mountpoint (eg. C</boot>) and a value which is the filesystem that would be "
10727 "mounted there (eg. C</dev/sda1>)."
10731 #: ../src/guestfs-actions.pod:2776 ../fish/guestfish-actions.pod:1902
10733 "Non-mounted devices such as swap devices are I<not> returned in this list."
10737 #: ../src/guestfs-actions.pod:2779
10739 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
10740 "C<guestfs_inspect_get_filesystems>."
10744 #: ../src/guestfs-actions.pod:2782 ../src/guestfs-actions.pod:3521
10745 #: ../src/guestfs-actions.pod:4731 ../src/guestfs-actions.pod:6636
10747 "This function returns a NULL-terminated array of strings, or NULL if there "
10748 "was an error. The array of strings will always have length C<2n+1>, where "
10749 "C<n> keys and values alternate, followed by the trailing NULL entry. I<The "
10750 "caller must free the strings and the array after use>."
10754 #: ../src/guestfs-actions.pod:2790
10755 msgid "guestfs_inspect_get_package_format"
10759 #: ../src/guestfs-actions.pod:2792
10763 " guestfs_inspect_get_package_format (guestfs_h *g,\n"
10764 " const char *root);\n"
10769 #: ../src/guestfs-actions.pod:2799
10771 "This function and C<guestfs_inspect_get_package_management> return the "
10772 "package format and package management tool used by the inspected operating "
10773 "system. For example for Fedora these functions would return C<rpm> (package "
10774 "format) and C<yum> (package management)."
10778 #: ../src/guestfs-actions.pod:2805 ../fish/guestfish-actions.pod:1921
10780 "This returns the string C<unknown> if we could not determine the package "
10781 "format I<or> if the operating system does not have a real packaging system "
10786 #: ../src/guestfs-actions.pod:2809 ../fish/guestfish-actions.pod:1925
10788 "Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>. "
10789 "Future versions of libguestfs may return other strings."
10793 #: ../src/guestfs-actions.pod:2817 ../src/guestfs-actions.pod:2848
10794 msgid "(Added in 1.7.5)"
10798 #: ../src/guestfs-actions.pod:2819
10799 msgid "guestfs_inspect_get_package_management"
10803 #: ../src/guestfs-actions.pod:2821
10807 " guestfs_inspect_get_package_management (guestfs_h *g,\n"
10808 " const char *root);\n"
10813 #: ../src/guestfs-actions.pod:2828
10815 "C<guestfs_inspect_get_package_format> and this function return the package "
10816 "format and package management tool used by the inspected operating system. "
10817 "For example for Fedora these functions would return C<rpm> (package format) "
10818 "and C<yum> (package management)."
10822 #: ../src/guestfs-actions.pod:2834 ../fish/guestfish-actions.pod:1943
10824 "This returns the string C<unknown> if we could not determine the package "
10825 "management tool I<or> if the operating system does not have a real packaging "
10826 "system (eg. Windows)."
10830 #: ../src/guestfs-actions.pod:2838 ../fish/guestfish-actions.pod:1947
10832 "Possible strings include: C<yum>, C<up2date>, C<apt> (for all Debian "
10833 "derivatives), C<portage>, C<pisi>, C<pacman>, C<urpmi>. Future versions of "
10834 "libguestfs may return other strings."
10838 #: ../src/guestfs-actions.pod:2850
10839 msgid "guestfs_inspect_get_product_name"
10843 #: ../src/guestfs-actions.pod:2852
10847 " guestfs_inspect_get_product_name (guestfs_h *g,\n"
10848 " const char *root);\n"
10853 #: ../src/guestfs-actions.pod:2859 ../fish/guestfish-actions.pod:1961
10855 "This returns the product name of the inspected operating system. The "
10856 "product name is generally some freeform string which can be displayed to the "
10857 "user, but should not be parsed by programs."
10861 #: ../src/guestfs-actions.pod:2864 ../fish/guestfish-actions.pod:1966
10863 "If the product name could not be determined, then the string C<unknown> is "
10868 #: ../src/guestfs-actions.pod:2874
10869 msgid "guestfs_inspect_get_product_variant"
10873 #: ../src/guestfs-actions.pod:2876
10877 " guestfs_inspect_get_product_variant (guestfs_h *g,\n"
10878 " const char *root);\n"
10883 #: ../src/guestfs-actions.pod:2883 ../fish/guestfish-actions.pod:1978
10885 #| msgid "This is an installed operating system."
10886 msgid "This returns the product variant of the inspected operating system."
10887 msgstr "Це встановлена операційна система."
10890 #: ../src/guestfs-actions.pod:2886 ../fish/guestfish-actions.pod:1981
10892 "For Windows guests, this returns the contents of the Registry key C<HKLM"
10893 "\\Software\\Microsoft\\Windows NT\\CurrentVersion> C<InstallationType> which "
10894 "is usually a string such as C<Client> or C<Server> (other values are "
10895 "possible). This can be used to distinguish consumer and enterprise versions "
10896 "of Windows that have the same version number (for example, Windows 7 and "
10897 "Windows 2008 Server are both version 6.1, but the former is C<Client> and "
10898 "the latter is C<Server>)."
10902 #: ../src/guestfs-actions.pod:2895 ../fish/guestfish-actions.pod:1990
10904 "For enterprise Linux guests, in future we intend this to return the product "
10905 "variant such as C<Desktop>, C<Server> and so on. But this is not "
10906 "implemented at present."
10910 #: ../src/guestfs-actions.pod:2899 ../fish/guestfish-actions.pod:1994
10912 "If the product variant could not be determined, then the string C<unknown> "
10917 #: ../src/guestfs-actions.pod:2902
10919 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
10920 "C<guestfs_inspect_get_product_name>, C<guestfs_inspect_get_major_version>."
10924 #: ../src/guestfs-actions.pod:2909
10925 msgid "guestfs_inspect_get_roots"
10929 #: ../src/guestfs-actions.pod:2911
10933 " guestfs_inspect_get_roots (guestfs_h *g);\n"
10938 #: ../src/guestfs-actions.pod:2914
10940 "This function is a convenient way to get the list of root devices, as "
10941 "returned from a previous call to C<guestfs_inspect_os>, but without redoing "
10942 "the whole inspection process."
10946 #: ../src/guestfs-actions.pod:2918
10948 "This returns an empty list if either no root devices were found or the "
10949 "caller has not called C<guestfs_inspect_os>."
10953 #: ../src/guestfs-actions.pod:2927
10954 msgid "(Added in 1.7.3)"
10958 #: ../src/guestfs-actions.pod:2929
10959 msgid "guestfs_inspect_get_type"
10963 #: ../src/guestfs-actions.pod:2931
10967 " guestfs_inspect_get_type (guestfs_h *g,\n"
10968 " const char *root);\n"
10973 #: ../src/guestfs-actions.pod:2938 ../fish/guestfish-actions.pod:2021
10975 "This returns the type of the inspected operating system. Currently defined "
10980 #: ../src/guestfs-actions.pod:2943 ../fish/guestfish-actions.pod:2026
10985 #: ../src/guestfs-actions.pod:2945 ../fish/guestfish-actions.pod:2028
10986 msgid "Any Linux-based operating system."
10990 #: ../src/guestfs-actions.pod:2949 ../fish/guestfish-actions.pod:2032
10991 msgid "Any Microsoft Windows operating system."
10995 #: ../src/guestfs-actions.pod:2951 ../fish/guestfish-actions.pod:2034
10996 msgid "\"freebsd\""
10997 msgstr "\"freebsd\""
11000 #: ../src/guestfs-actions.pod:2953 ../fish/guestfish-actions.pod:2036
11005 #: ../src/guestfs-actions.pod:2957 ../fish/guestfish-actions.pod:2040
11006 msgid "The operating system type could not be determined."
11010 #: ../src/guestfs-actions.pod:2971
11011 msgid "guestfs_inspect_get_windows_systemroot"
11015 #: ../src/guestfs-actions.pod:2973
11019 " guestfs_inspect_get_windows_systemroot (guestfs_h *g,\n"
11020 " const char *root);\n"
11025 #: ../src/guestfs-actions.pod:2980 ../fish/guestfish-actions.pod:2056
11027 "This returns the Windows systemroot of the inspected guest. The systemroot "
11028 "is a directory path such as C</WINDOWS>."
11032 #: ../src/guestfs-actions.pod:2983 ../fish/guestfish-actions.pod:2059
11034 "This call assumes that the guest is Windows and that the systemroot could be "
11035 "determined by inspection. If this is not the case then an error is returned."
11039 #: ../src/guestfs-actions.pod:2992
11040 msgid "(Added in 1.5.25)"
11044 #: ../src/guestfs-actions.pod:2994
11045 msgid "guestfs_inspect_is_live"
11049 #: ../src/guestfs-actions.pod:2996
11053 " guestfs_inspect_is_live (guestfs_h *g,\n"
11054 " const char *root);\n"
11059 #: ../src/guestfs-actions.pod:3003
11061 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
11062 "disk), then this returns true if a live image was detected on the disk."
11066 #: ../src/guestfs-actions.pod:3011
11067 msgid "guestfs_inspect_is_multipart"
11071 #: ../src/guestfs-actions.pod:3013
11075 " guestfs_inspect_is_multipart (guestfs_h *g,\n"
11076 " const char *root);\n"
11081 #: ../src/guestfs-actions.pod:3020
11083 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
11084 "disk), then this returns true if the disk is part of a set."
11088 #: ../src/guestfs-actions.pod:3028
11089 msgid "guestfs_inspect_is_netinst"
11093 #: ../src/guestfs-actions.pod:3030
11097 " guestfs_inspect_is_netinst (guestfs_h *g,\n"
11098 " const char *root);\n"
11103 #: ../src/guestfs-actions.pod:3037
11105 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
11106 "disk), then this returns true if the disk is a network installer, ie. not a "
11107 "self-contained install CD but one which is likely to require network access "
11108 "to complete the install."
11112 #: ../src/guestfs-actions.pod:3047
11113 msgid "guestfs_inspect_list_applications"
11117 #: ../src/guestfs-actions.pod:3049
11120 " struct guestfs_application_list *\n"
11121 " guestfs_inspect_list_applications (guestfs_h *g,\n"
11122 " const char *root);\n"
11127 #: ../src/guestfs-actions.pod:3056 ../fish/guestfish-actions.pod:2113
11128 msgid "Return the list of applications installed in the operating system."
11132 #: ../src/guestfs-actions.pod:3058
11134 "I<Note:> This call works differently from other parts of the inspection "
11135 "API. You have to call C<guestfs_inspect_os>, then "
11136 "C<guestfs_inspect_get_mountpoints>, then mount up the disks, before calling "
11137 "this. Listing applications is a significantly more difficult operation "
11138 "which requires access to the full filesystem. Also note that unlike the "
11139 "other C<guestfs_inspect_get_*> calls which are just returning data cached in "
11140 "the libguestfs handle, this call actually reads parts of the mounted "
11141 "filesystems during the call."
11145 #: ../src/guestfs-actions.pod:3068 ../fish/guestfish-actions.pod:2125
11147 "This returns an empty list if the inspection code was not able to determine "
11148 "the list of applications."
11152 #: ../src/guestfs-actions.pod:3071 ../fish/guestfish-actions.pod:2128
11153 msgid "The application structure contains the following fields:"
11157 #: ../src/guestfs-actions.pod:3075 ../fish/guestfish-actions.pod:2132
11158 msgid "C<app_name>"
11159 msgstr "C<app_name>"
11162 #: ../src/guestfs-actions.pod:3077 ../fish/guestfish-actions.pod:2134
11164 "The name of the application. For Red Hat-derived and Debian-derived Linux "
11165 "guests, this is the package name."
11169 #: ../src/guestfs-actions.pod:3080 ../fish/guestfish-actions.pod:2137
11170 msgid "C<app_display_name>"
11171 msgstr "C<app_display_name>"
11174 #: ../src/guestfs-actions.pod:3082 ../fish/guestfish-actions.pod:2139
11176 "The display name of the application, sometimes localized to the install "
11177 "language of the guest operating system."
11181 #: ../src/guestfs-actions.pod:3085 ../fish/guestfish-actions.pod:2142
11183 "If unavailable this is returned as an empty string C<\"\">. Callers needing "
11184 "to display something can use C<app_name> instead."
11188 #: ../src/guestfs-actions.pod:3088 ../fish/guestfish-actions.pod:2145
11189 msgid "C<app_epoch>"
11190 msgstr "C<app_epoch>"
11193 #: ../src/guestfs-actions.pod:3090 ../fish/guestfish-actions.pod:2147
11195 "For package managers which use epochs, this contains the epoch of the "
11196 "package (an integer). If unavailable, this is returned as C<0>."
11200 #: ../src/guestfs-actions.pod:3093 ../fish/guestfish-actions.pod:2150
11201 msgid "C<app_version>"
11202 msgstr "C<app_version>"
11205 #: ../src/guestfs-actions.pod:3095 ../fish/guestfish-actions.pod:2152
11207 "The version string of the application or package. If unavailable this is "
11208 "returned as an empty string C<\"\">."
11212 #: ../src/guestfs-actions.pod:3098 ../fish/guestfish-actions.pod:2155
11213 msgid "C<app_release>"
11214 msgstr "C<app_release>"
11217 #: ../src/guestfs-actions.pod:3100 ../fish/guestfish-actions.pod:2157
11219 "The release string of the application or package, for package managers that "
11220 "use this. If unavailable this is returned as an empty string C<\"\">."
11224 #: ../src/guestfs-actions.pod:3104 ../fish/guestfish-actions.pod:2161
11225 msgid "C<app_install_path>"
11226 msgstr "C<app_install_path>"
11229 #: ../src/guestfs-actions.pod:3106 ../fish/guestfish-actions.pod:2163
11231 "The installation path of the application (on operating systems such as "
11232 "Windows which use installation paths). This path is in the format used by "
11233 "the guest operating system, it is not a libguestfs path."
11237 #: ../src/guestfs-actions.pod:3111 ../fish/guestfish-actions.pod:2168
11238 msgid "If unavailable this is returned as an empty string C<\"\">."
11242 #: ../src/guestfs-actions.pod:3113 ../fish/guestfish-actions.pod:2170
11243 msgid "C<app_trans_path>"
11244 msgstr "C<app_trans_path>"
11247 #: ../src/guestfs-actions.pod:3115 ../fish/guestfish-actions.pod:2172
11249 "The install path translated into a libguestfs path. If unavailable this is "
11250 "returned as an empty string C<\"\">."
11254 #: ../src/guestfs-actions.pod:3118 ../fish/guestfish-actions.pod:2175
11255 msgid "C<app_publisher>"
11256 msgstr "C<app_publisher>"
11259 #: ../src/guestfs-actions.pod:3120 ../fish/guestfish-actions.pod:2177
11261 "The name of the publisher of the application, for package managers that use "
11262 "this. If unavailable this is returned as an empty string C<\"\">."
11266 #: ../src/guestfs-actions.pod:3124 ../fish/guestfish-actions.pod:2181
11268 msgstr "C<app_url>"
11271 #: ../src/guestfs-actions.pod:3126 ../fish/guestfish-actions.pod:2183
11273 "The URL (eg. upstream URL) of the application. If unavailable this is "
11274 "returned as an empty string C<\"\">."
11278 #: ../src/guestfs-actions.pod:3129 ../fish/guestfish-actions.pod:2186
11279 msgid "C<app_source_package>"
11283 #: ../src/guestfs-actions.pod:3131 ../fish/guestfish-actions.pod:2188
11285 "For packaging systems which support this, the name of the source package. "
11286 "If unavailable this is returned as an empty string C<\"\">."
11290 #: ../src/guestfs-actions.pod:3134 ../fish/guestfish-actions.pod:2191
11291 msgid "C<app_summary>"
11295 #: ../src/guestfs-actions.pod:3136 ../fish/guestfish-actions.pod:2193
11297 "A short (usually one line) description of the application or package. If "
11298 "unavailable this is returned as an empty string C<\"\">."
11302 #: ../src/guestfs-actions.pod:3139 ../fish/guestfish-actions.pod:2196
11303 msgid "C<app_description>"
11307 #: ../src/guestfs-actions.pod:3141 ../fish/guestfish-actions.pod:2198
11309 "A longer description of the application or package. If unavailable this is "
11310 "returned as an empty string C<\"\">."
11314 #: ../src/guestfs-actions.pod:3148
11316 "This function returns a C<struct guestfs_application_list *>, or NULL if "
11317 "there was an error. I<The caller must call C<guestfs_free_application_list> "
11322 #: ../src/guestfs-actions.pod:3152
11323 msgid "(Added in 1.7.8)"
11327 #: ../src/guestfs-actions.pod:3154
11328 msgid "guestfs_inspect_os"
11332 #: ../src/guestfs-actions.pod:3156
11336 " guestfs_inspect_os (guestfs_h *g);\n"
11341 #: ../src/guestfs-actions.pod:3159 ../fish/guestfish-actions.pod:2209
11343 "This function uses other libguestfs functions and certain heuristics to "
11344 "inspect the disk(s) (usually disks belonging to a virtual machine), looking "
11345 "for operating systems."
11349 #: ../src/guestfs-actions.pod:3163 ../fish/guestfish-actions.pod:2213
11350 msgid "The list returned is empty if no operating systems were found."
11354 #: ../src/guestfs-actions.pod:3165 ../fish/guestfish-actions.pod:2215
11356 "If one operating system was found, then this returns a list with a single "
11357 "element, which is the name of the root filesystem of this operating system. "
11358 "It is also possible for this function to return a list containing more than "
11359 "one element, indicating a dual-boot or multi-boot virtual machine, with each "
11360 "element being the root filesystem of one of the operating systems."
11364 #: ../src/guestfs-actions.pod:3172
11366 "You can pass the root string(s) returned to other C<guestfs_inspect_get_*> "
11367 "functions in order to query further information about each operating system, "
11368 "such as the name and version."
11372 #: ../src/guestfs-actions.pod:3177
11374 "This function uses other libguestfs features such as C<guestfs_mount_ro> and "
11375 "C<guestfs_umount_all> in order to mount and unmount filesystems and look at "
11376 "the contents. This should be called with no disks currently mounted. The "
11377 "function may also use Augeas, so any existing Augeas handle will be closed."
11381 #: ../src/guestfs-actions.pod:3183 ../fish/guestfish-actions.pod:2233
11383 "This function cannot decrypt encrypted disks. The caller must do that first "
11384 "(supplying the necessary keys) if the disk is encrypted."
11388 #: ../src/guestfs-actions.pod:3189 ../src/guestfs-actions.pod:3479
11389 #: ../src/guestfs-actions.pod:3541
11390 msgid "See also C<guestfs_list_filesystems>."
11394 #: ../src/guestfs-actions.pod:3197
11395 msgid "guestfs_is_blockdev"
11399 #: ../src/guestfs-actions.pod:3199
11403 " guestfs_is_blockdev (guestfs_h *g,\n"
11404 " const char *path);\n"
11409 #: ../src/guestfs-actions.pod:3203 ../fish/guestfish-actions.pod:2245
11411 "This returns C<true> if and only if there is a block device with the given "
11416 #: ../src/guestfs-actions.pod:3206 ../src/guestfs-actions.pod:3235
11417 #: ../src/guestfs-actions.pod:3265 ../src/guestfs-actions.pod:3280
11418 #: ../src/guestfs-actions.pod:3296 ../src/guestfs-actions.pod:3352
11419 #: ../src/guestfs-actions.pod:3367
11420 msgid "See also C<guestfs_stat>."
11424 #: ../src/guestfs-actions.pod:3210 ../src/guestfs-actions.pod:3239
11425 #: ../src/guestfs-actions.pod:3284 ../src/guestfs-actions.pod:3356
11426 #: ../src/guestfs-actions.pod:3371
11427 msgid "(Added in 1.5.10)"
11431 #: ../src/guestfs-actions.pod:3212
11432 msgid "guestfs_is_busy"
11436 #: ../src/guestfs-actions.pod:3214
11440 " guestfs_is_busy (guestfs_h *g);\n"
11445 #: ../src/guestfs-actions.pod:3217 ../fish/guestfish-actions.pod:2254
11447 "This returns true iff this handle is busy processing a command (in the "
11452 #: ../src/guestfs-actions.pod:3226
11453 msgid "guestfs_is_chardev"
11457 #: ../src/guestfs-actions.pod:3228
11461 " guestfs_is_chardev (guestfs_h *g,\n"
11462 " const char *path);\n"
11467 #: ../src/guestfs-actions.pod:3232 ../fish/guestfish-actions.pod:2263
11469 "This returns C<true> if and only if there is a character device with the "
11470 "given C<path> name."
11474 #: ../src/guestfs-actions.pod:3241
11475 msgid "guestfs_is_config"
11479 #: ../src/guestfs-actions.pod:3243
11483 " guestfs_is_config (guestfs_h *g);\n"
11488 #: ../src/guestfs-actions.pod:3246 ../fish/guestfish-actions.pod:2272
11490 "This returns true iff this handle is being configured (in the C<CONFIG> "
11495 #: ../src/guestfs-actions.pod:3255
11496 msgid "guestfs_is_dir"
11500 #: ../src/guestfs-actions.pod:3257
11504 " guestfs_is_dir (guestfs_h *g,\n"
11505 " const char *path);\n"
11510 #: ../src/guestfs-actions.pod:3261 ../fish/guestfish-actions.pod:2281
11512 "This returns C<true> if and only if there is a directory with the given "
11513 "C<path> name. Note that it returns false for other objects like files."
11517 #: ../src/guestfs-actions.pod:3271
11518 msgid "guestfs_is_fifo"
11522 #: ../src/guestfs-actions.pod:3273
11526 " guestfs_is_fifo (guestfs_h *g,\n"
11527 " const char *path);\n"
11532 #: ../src/guestfs-actions.pod:3277 ../fish/guestfish-actions.pod:2291
11534 "This returns C<true> if and only if there is a FIFO (named pipe) with the "
11535 "given C<path> name."
11539 #: ../src/guestfs-actions.pod:3286
11540 msgid "guestfs_is_file"
11544 #: ../src/guestfs-actions.pod:3288
11548 " guestfs_is_file (guestfs_h *g,\n"
11549 " const char *path);\n"
11554 #: ../src/guestfs-actions.pod:3292 ../fish/guestfish-actions.pod:2300
11556 "This returns C<true> if and only if there is a regular file with the given "
11557 "C<path> name. Note that it returns false for other objects like directories."
11561 #: ../src/guestfs-actions.pod:3302
11562 msgid "guestfs_is_launching"
11566 #: ../src/guestfs-actions.pod:3304
11570 " guestfs_is_launching (guestfs_h *g);\n"
11575 #: ../src/guestfs-actions.pod:3307 ../fish/guestfish-actions.pod:2310
11577 "This returns true iff this handle is launching the subprocess (in the "
11578 "C<LAUNCHING> state)."
11582 #: ../src/guestfs-actions.pod:3316
11583 msgid "guestfs_is_lv"
11587 #: ../src/guestfs-actions.pod:3318
11591 " guestfs_is_lv (guestfs_h *g,\n"
11592 " const char *device);\n"
11597 #: ../src/guestfs-actions.pod:3322 ../fish/guestfish-actions.pod:2319
11599 "This command tests whether C<device> is a logical volume, and returns true "
11600 "iff this is the case."
11604 #: ../src/guestfs-actions.pod:3329
11605 msgid "guestfs_is_ready"
11609 #: ../src/guestfs-actions.pod:3331
11613 " guestfs_is_ready (guestfs_h *g);\n"
11618 #: ../src/guestfs-actions.pod:3334 ../fish/guestfish-actions.pod:2326
11620 "This returns true iff this handle is ready to accept commands (in the "
11625 #: ../src/guestfs-actions.pod:3343
11626 msgid "guestfs_is_socket"
11630 #: ../src/guestfs-actions.pod:3345
11634 " guestfs_is_socket (guestfs_h *g,\n"
11635 " const char *path);\n"
11640 #: ../src/guestfs-actions.pod:3349 ../fish/guestfish-actions.pod:2335
11642 "This returns C<true> if and only if there is a Unix domain socket with the "
11643 "given C<path> name."
11647 #: ../src/guestfs-actions.pod:3358
11648 msgid "guestfs_is_symlink"
11652 #: ../src/guestfs-actions.pod:3360
11656 " guestfs_is_symlink (guestfs_h *g,\n"
11657 " const char *path);\n"
11662 #: ../src/guestfs-actions.pod:3364 ../fish/guestfish-actions.pod:2344
11664 "This returns C<true> if and only if there is a symbolic link with the given "
11669 #: ../src/guestfs-actions.pod:3373
11670 msgid "guestfs_kill_subprocess"
11674 #: ../src/guestfs-actions.pod:3375
11678 " guestfs_kill_subprocess (guestfs_h *g);\n"
11683 #: ../src/guestfs-actions.pod:3378 ../fish/guestfish-actions.pod:2353
11684 msgid "This kills the qemu subprocess. You should never need to call this."
11688 #: ../src/guestfs-actions.pod:3384
11689 msgid "guestfs_launch"
11693 #: ../src/guestfs-actions.pod:3386
11697 " guestfs_launch (guestfs_h *g);\n"
11702 #: ../src/guestfs-actions.pod:3389 ../fish/guestfish-actions.pod:2361
11704 "Internally libguestfs is implemented by running a virtual machine using "
11709 #: ../src/guestfs-actions.pod:3392 ../fish/guestfish-actions.pod:2364
11711 "You should call this after configuring the handle (eg. adding drives) but "
11712 "before performing any actions."
11716 #: ../src/guestfs-actions.pod:3404
11717 msgid "guestfs_lchown"
11721 #: ../src/guestfs-actions.pod:3406
11725 " guestfs_lchown (guestfs_h *g,\n"
11728 " const char *path);\n"
11733 #: ../src/guestfs-actions.pod:3412
11735 "Change the file owner to C<owner> and group to C<group>. This is like "
11736 "C<guestfs_chown> but if C<path> is a symlink then the link itself is "
11737 "changed, not the target."
11741 #: ../src/guestfs-actions.pod:3424
11742 msgid "guestfs_lgetxattr"
11746 #: ../src/guestfs-actions.pod:3426
11750 " guestfs_lgetxattr (guestfs_h *g,\n"
11751 " const char *path,\n"
11752 " const char *name,\n"
11753 " size_t *size_r);\n"
11758 #: ../src/guestfs-actions.pod:3432 ../fish/guestfish-actions.pod:2383
11760 "Get a single extended attribute from file C<path> named C<name>. If C<path> "
11761 "is a symlink, then this call returns an extended attribute from the symlink."
11765 #: ../src/guestfs-actions.pod:3446
11766 msgid "See also: C<guestfs_lgetxattrs>, C<guestfs_getxattr>, L<attr(5)>."
11770 #: ../src/guestfs-actions.pod:3454
11771 msgid "guestfs_lgetxattrs"
11775 #: ../src/guestfs-actions.pod:3456
11778 " struct guestfs_xattr_list *\n"
11779 " guestfs_lgetxattrs (guestfs_h *g,\n"
11780 " const char *path);\n"
11785 #: ../src/guestfs-actions.pod:3460
11787 "This is the same as C<guestfs_getxattrs>, but if C<path> is a symbolic link, "
11788 "then it returns the extended attributes of the link itself."
11792 #: ../src/guestfs-actions.pod:3470
11793 msgid "guestfs_list_devices"
11797 #: ../src/guestfs-actions.pod:3472
11801 " guestfs_list_devices (guestfs_h *g);\n"
11806 #: ../src/guestfs-actions.pod:3475 ../fish/guestfish-actions.pod:2411
11807 msgid "List all the block devices."
11811 #: ../src/guestfs-actions.pod:3477 ../fish/guestfish-actions.pod:2413
11812 msgid "The full block device names are returned, eg. C</dev/sda>."
11816 #: ../src/guestfs-actions.pod:3487
11817 msgid "guestfs_list_filesystems"
11821 #: ../src/guestfs-actions.pod:3489
11825 " guestfs_list_filesystems (guestfs_h *g);\n"
11830 #: ../src/guestfs-actions.pod:3492 ../fish/guestfish-actions.pod:2421
11832 "This inspection command looks for filesystems on partitions, block devices "
11833 "and logical volumes, returning a list of devices containing filesystems and "
11838 #: ../src/guestfs-actions.pod:3496 ../fish/guestfish-actions.pod:2425
11840 "The return value is a hash, where the keys are the devices containing "
11841 "filesystems, and the values are the filesystem types. For example:"
11845 #: ../src/guestfs-actions.pod:3500 ../fish/guestfish-actions.pod:2429
11848 " \"/dev/sda1\" => \"ntfs\"\n"
11849 " \"/dev/sda2\" => \"ext2\"\n"
11850 " \"/dev/vg_guest/lv_root\" => \"ext4\"\n"
11851 " \"/dev/vg_guest/lv_swap\" => \"swap\"\n"
11856 #: ../src/guestfs-actions.pod:3505 ../fish/guestfish-actions.pod:2434
11858 "The value can have the special value \"unknown\", meaning the content of the "
11859 "device is undetermined or empty. \"swap\" means a Linux swap partition."
11863 #: ../src/guestfs-actions.pod:3509
11865 "This command runs other libguestfs commands, which might include "
11866 "C<guestfs_mount> and C<guestfs_umount>, and therefore you should use this "
11867 "soon after launch and only when nothing is mounted."
11871 #: ../src/guestfs-actions.pod:3513
11873 "Not all of the filesystems returned will be mountable. In particular, swap "
11874 "partitions are returned in the list. Also this command does not check that "
11875 "each filesystem found is valid and mountable, and some filesystems might be "
11876 "mountable but require special options. Filesystems may not all belong to a "
11877 "single logical operating system (use C<guestfs_inspect_os> to look for OSes)."
11881 #: ../src/guestfs-actions.pod:3527 ../src/guestfs-actions.pod:5132
11882 msgid "(Added in 1.5.15)"
11886 #: ../src/guestfs-actions.pod:3529
11887 msgid "guestfs_list_partitions"
11891 #: ../src/guestfs-actions.pod:3531
11895 " guestfs_list_partitions (guestfs_h *g);\n"
11900 #: ../src/guestfs-actions.pod:3534 ../fish/guestfish-actions.pod:2454
11901 msgid "List all the partitions detected on all block devices."
11905 #: ../src/guestfs-actions.pod:3536 ../fish/guestfish-actions.pod:2456
11906 msgid "The full partition device names are returned, eg. C</dev/sda1>"
11910 #: ../src/guestfs-actions.pod:3538
11912 "This does not return logical volumes. For that you will need to call "
11917 #: ../src/guestfs-actions.pod:3549
11922 #: ../src/guestfs-actions.pod:3551
11926 " guestfs_ll (guestfs_h *g,\n"
11927 " const char *directory);\n"
11932 #: ../src/guestfs-actions.pod:3555 ../fish/guestfish-actions.pod:2467
11934 "List the files in C<directory> (relative to the root directory, there is no "
11935 "cwd) in the format of 'ls -la'."
11939 #: ../src/guestfs-actions.pod:3558 ../fish/guestfish-actions.pod:2470
11941 "This command is mostly useful for interactive sessions. It is I<not> "
11942 "intended that you try to parse the output string."
11946 #: ../src/guestfs-actions.pod:3566
11951 #: ../src/guestfs-actions.pod:3568
11955 " guestfs_ln (guestfs_h *g,\n"
11956 " const char *target,\n"
11957 " const char *linkname);\n"
11962 #: ../src/guestfs-actions.pod:3573 ../fish/guestfish-actions.pod:2477
11963 msgid "This command creates a hard link using the C<ln> command."
11967 #: ../src/guestfs-actions.pod:3579
11968 msgid "guestfs_ln_f"
11972 #: ../src/guestfs-actions.pod:3581
11976 " guestfs_ln_f (guestfs_h *g,\n"
11977 " const char *target,\n"
11978 " const char *linkname);\n"
11983 #: ../src/guestfs-actions.pod:3586 ../fish/guestfish-actions.pod:2483
11985 "This command creates a hard link using the C<ln -f> command. The C<-f> "
11986 "option removes the link (C<linkname>) if it exists already."
11990 #: ../src/guestfs-actions.pod:3593
11991 msgid "guestfs_ln_s"
11995 #: ../src/guestfs-actions.pod:3595
11999 " guestfs_ln_s (guestfs_h *g,\n"
12000 " const char *target,\n"
12001 " const char *linkname);\n"
12006 #: ../src/guestfs-actions.pod:3600 ../fish/guestfish-actions.pod:2490
12007 msgid "This command creates a symbolic link using the C<ln -s> command."
12011 #: ../src/guestfs-actions.pod:3606
12012 msgid "guestfs_ln_sf"
12016 #: ../src/guestfs-actions.pod:3608
12020 " guestfs_ln_sf (guestfs_h *g,\n"
12021 " const char *target,\n"
12022 " const char *linkname);\n"
12027 #: ../src/guestfs-actions.pod:3613 ../fish/guestfish-actions.pod:2496
12029 "This command creates a symbolic link using the C<ln -sf> command, The C<-f> "
12030 "option removes the link (C<linkname>) if it exists already."
12034 #: ../src/guestfs-actions.pod:3620
12035 msgid "guestfs_lremovexattr"
12039 #: ../src/guestfs-actions.pod:3622
12043 " guestfs_lremovexattr (guestfs_h *g,\n"
12044 " const char *xattr,\n"
12045 " const char *path);\n"
12050 #: ../src/guestfs-actions.pod:3627
12052 "This is the same as C<guestfs_removexattr>, but if C<path> is a symbolic "
12053 "link, then it removes an extended attribute of the link itself."
12057 #: ../src/guestfs-actions.pod:3635
12062 #: ../src/guestfs-actions.pod:3637
12066 " guestfs_ls (guestfs_h *g,\n"
12067 " const char *directory);\n"
12072 #: ../src/guestfs-actions.pod:3641 ../fish/guestfish-actions.pod:2511
12074 "List the files in C<directory> (relative to the root directory, there is no "
12075 "cwd). The '.' and '..' entries are not returned, but hidden files are shown."
12079 #: ../src/guestfs-actions.pod:3645
12081 "This command is mostly useful for interactive sessions. Programs should "
12082 "probably use C<guestfs_readdir> instead."
12086 #: ../src/guestfs-actions.pod:3654
12087 msgid "guestfs_lsetxattr"
12091 #: ../src/guestfs-actions.pod:3656
12095 " guestfs_lsetxattr (guestfs_h *g,\n"
12096 " const char *xattr,\n"
12097 " const char *val,\n"
12099 " const char *path);\n"
12104 #: ../src/guestfs-actions.pod:3663
12106 "This is the same as C<guestfs_setxattr>, but if C<path> is a symbolic link, "
12107 "then it sets an extended attribute of the link itself."
12111 #: ../src/guestfs-actions.pod:3671
12112 msgid "guestfs_lstat"
12116 #: ../src/guestfs-actions.pod:3673
12119 " struct guestfs_stat *\n"
12120 " guestfs_lstat (guestfs_h *g,\n"
12121 " const char *path);\n"
12126 #: ../src/guestfs-actions.pod:3677 ../src/guestfs-actions.pod:6235
12127 #: ../fish/guestfish-actions.pod:2530 ../fish/guestfish-actions.pod:4199
12128 msgid "Returns file information for the given C<path>."
12132 #: ../src/guestfs-actions.pod:3679
12134 "This is the same as C<guestfs_stat> except that if C<path> is a symbolic "
12135 "link, then the link is stat-ed, not the file it refers to."
12139 #: ../src/guestfs-actions.pod:3683 ../fish/guestfish-actions.pod:2536
12140 msgid "This is the same as the C<lstat(2)> system call."
12144 #: ../src/guestfs-actions.pod:3685 ../src/guestfs-actions.pod:6239
12146 "This function returns a C<struct guestfs_stat *>, or NULL if there was an "
12147 "error. I<The caller must call C<guestfs_free_stat> after use>."
12151 #: ../src/guestfs-actions.pod:3689 ../src/guestfs-actions.pod:6243
12152 #: ../src/guestfs-actions.pod:6261 ../src/guestfs-actions.pod:6642
12153 msgid "(Added in 0.9.2)"
12157 #: ../src/guestfs-actions.pod:3691
12158 msgid "guestfs_lstatlist"
12162 #: ../src/guestfs-actions.pod:3693
12165 " struct guestfs_stat_list *\n"
12166 " guestfs_lstatlist (guestfs_h *g,\n"
12167 " const char *path,\n"
12168 " char *const *names);\n"
12173 #: ../src/guestfs-actions.pod:3698
12175 "This call allows you to perform the C<guestfs_lstat> operation on multiple "
12176 "files, where all files are in the directory C<path>. C<names> is the list "
12177 "of files from this directory."
12181 #: ../src/guestfs-actions.pod:3702 ../fish/guestfish-actions.pod:2546
12183 "On return you get a list of stat structs, with a one-to-one correspondence "
12184 "to the C<names> list. If any name did not exist or could not be lstat'd, "
12185 "then the C<ino> field of that structure is set to C<-1>."
12189 #: ../src/guestfs-actions.pod:3707
12191 "This call is intended for programs that want to efficiently list a directory "
12192 "contents without making many round-trips. See also C<guestfs_lxattrlist> "
12193 "for a similarly efficient call for getting extended attributes. Very long "
12194 "directory listings might cause the protocol message size to be exceeded, "
12195 "causing this call to fail. The caller must split up such requests into "
12196 "smaller groups of names."
12200 #: ../src/guestfs-actions.pod:3715
12202 "This function returns a C<struct guestfs_stat_list *>, or NULL if there was "
12203 "an error. I<The caller must call C<guestfs_free_stat_list> after use>."
12207 #: ../src/guestfs-actions.pod:3721
12208 msgid "guestfs_luks_add_key"
12212 #: ../src/guestfs-actions.pod:3723
12216 " guestfs_luks_add_key (guestfs_h *g,\n"
12217 " const char *device,\n"
12218 " const char *key,\n"
12219 " const char *newkey,\n"
12225 #: ../src/guestfs-actions.pod:3730 ../fish/guestfish-actions.pod:2563
12227 "This command adds a new key on LUKS device C<device>. C<key> is any "
12228 "existing key, and is used to access the device. C<newkey> is the new key to "
12229 "add. C<keyslot> is the key slot that will be replaced."
12233 #: ../src/guestfs-actions.pod:3735
12235 "Note that if C<keyslot> already contains a key, then this command will "
12236 "fail. You have to use C<guestfs_luks_kill_slot> first to remove that key."
12240 #: ../src/guestfs-actions.pod:3741 ../src/guestfs-actions.pod:3781
12241 #: ../src/guestfs-actions.pod:3804 ../src/guestfs-actions.pod:3824
12242 #: ../src/guestfs-actions.pod:3856 ../src/guestfs-actions.pod:3875
12244 "This function takes a key or passphrase parameter which could contain "
12245 "sensitive material. Read the section L</KEYS AND PASSPHRASES> for more "
12250 #: ../src/guestfs-actions.pod:3745 ../src/guestfs-actions.pod:3785
12251 #: ../src/guestfs-actions.pod:3808 ../src/guestfs-actions.pod:3828
12252 msgid "(Added in 1.5.2)"
12256 #: ../src/guestfs-actions.pod:3747
12257 msgid "guestfs_luks_close"
12261 #: ../src/guestfs-actions.pod:3749
12265 " guestfs_luks_close (guestfs_h *g,\n"
12266 " const char *device);\n"
12271 #: ../src/guestfs-actions.pod:3753
12273 "This closes a LUKS device that was created earlier by C<guestfs_luks_open> "
12274 "or C<guestfs_luks_open_ro>. The C<device> parameter must be the name of the "
12275 "LUKS mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
12276 "underlying block device."
12280 #: ../src/guestfs-actions.pod:3761 ../src/guestfs-actions.pod:3860
12281 #: ../src/guestfs-actions.pod:3879 ../src/guestfs-actions.pod:3929
12282 #: ../src/guestfs-actions.pod:3977
12283 msgid "(Added in 1.5.1)"
12287 #: ../src/guestfs-actions.pod:3763
12288 msgid "guestfs_luks_format"
12292 #: ../src/guestfs-actions.pod:3765
12296 " guestfs_luks_format (guestfs_h *g,\n"
12297 " const char *device,\n"
12298 " const char *key,\n"
12304 #: ../src/guestfs-actions.pod:3771 ../fish/guestfish-actions.pod:2589
12306 "This command erases existing data on C<device> and formats the device as a "
12307 "LUKS encrypted device. C<key> is the initial key, which is added to key "
12308 "slot C<slot>. (LUKS supports 8 key slots, numbered 0-7)."
12312 #: ../src/guestfs-actions.pod:3778 ../src/guestfs-actions.pod:3801
12313 #: ../src/guestfs-actions.pod:3941 ../src/guestfs-actions.pod:4883
12314 #: ../src/guestfs-actions.pod:5663 ../src/guestfs-actions.pod:6070
12315 #: ../src/guestfs-actions.pod:6093 ../src/guestfs-actions.pod:6119
12316 #: ../src/guestfs-actions.pod:7279 ../fish/guestfish-actions.pod:2597
12317 #: ../fish/guestfish-actions.pod:2610 ../fish/guestfish-actions.pod:2694
12318 #: ../fish/guestfish-actions.pod:3268 ../fish/guestfish-actions.pod:3788
12319 #: ../fish/guestfish-actions.pod:4098 ../fish/guestfish-actions.pod:4114
12320 #: ../fish/guestfish-actions.pod:4129 ../fish/guestfish-actions.pod:4844
12322 "B<This command is dangerous. Without careful use you can easily destroy all "
12327 #: ../src/guestfs-actions.pod:3787
12328 msgid "guestfs_luks_format_cipher"
12332 #: ../src/guestfs-actions.pod:3789
12336 " guestfs_luks_format_cipher (guestfs_h *g,\n"
12337 " const char *device,\n"
12338 " const char *key,\n"
12340 " const char *cipher);\n"
12345 #: ../src/guestfs-actions.pod:3796
12347 "This command is the same as C<guestfs_luks_format> but it also allows you to "
12348 "set the C<cipher> used."
12352 #: ../src/guestfs-actions.pod:3810
12353 msgid "guestfs_luks_kill_slot"
12357 #: ../src/guestfs-actions.pod:3812
12361 " guestfs_luks_kill_slot (guestfs_h *g,\n"
12362 " const char *device,\n"
12363 " const char *key,\n"
12369 #: ../src/guestfs-actions.pod:3818 ../fish/guestfish-actions.pod:2617
12371 "This command deletes the key in key slot C<keyslot> from the encrypted LUKS "
12372 "device C<device>. C<key> must be one of the I<other> keys."
12376 #: ../src/guestfs-actions.pod:3830
12377 msgid "guestfs_luks_open"
12381 #: ../src/guestfs-actions.pod:3832
12385 " guestfs_luks_open (guestfs_h *g,\n"
12386 " const char *device,\n"
12387 " const char *key,\n"
12388 " const char *mapname);\n"
12393 #: ../src/guestfs-actions.pod:3838 ../fish/guestfish-actions.pod:2628
12395 "This command opens a block device which has been encrypted according to the "
12396 "Linux Unified Key Setup (LUKS) standard."
12400 #: ../src/guestfs-actions.pod:3841 ../fish/guestfish-actions.pod:2631
12401 msgid "C<device> is the encrypted block device or partition."
12405 #: ../src/guestfs-actions.pod:3843 ../fish/guestfish-actions.pod:2633
12407 "The caller must supply one of the keys associated with the LUKS block "
12408 "device, in the C<key> parameter."
12412 #: ../src/guestfs-actions.pod:3846 ../fish/guestfish-actions.pod:2636
12414 "This creates a new block device called C</dev/mapper/mapname>. Reads and "
12415 "writes to this block device are decrypted from and encrypted to the "
12416 "underlying C<device> respectively."
12420 #: ../src/guestfs-actions.pod:3850
12422 "If this block device contains LVM volume groups, then calling "
12423 "C<guestfs_vgscan> followed by C<guestfs_vg_activate_all> will make them "
12428 #: ../src/guestfs-actions.pod:3862
12429 msgid "guestfs_luks_open_ro"
12433 #: ../src/guestfs-actions.pod:3864
12437 " guestfs_luks_open_ro (guestfs_h *g,\n"
12438 " const char *device,\n"
12439 " const char *key,\n"
12440 " const char *mapname);\n"
12445 #: ../src/guestfs-actions.pod:3870
12447 "This is the same as C<guestfs_luks_open> except that a read-only mapping is "
12452 #: ../src/guestfs-actions.pod:3881
12453 msgid "guestfs_lvcreate"
12457 #: ../src/guestfs-actions.pod:3883
12461 " guestfs_lvcreate (guestfs_h *g,\n"
12462 " const char *logvol,\n"
12463 " const char *volgroup,\n"
12469 #: ../src/guestfs-actions.pod:3889 ../fish/guestfish-actions.pod:2661
12471 "This creates an LVM logical volume called C<logvol> on the volume group "
12472 "C<volgroup>, with C<size> megabytes."
12476 #: ../src/guestfs-actions.pod:3896
12477 msgid "guestfs_lvm_canonical_lv_name"
12481 #: ../src/guestfs-actions.pod:3898
12485 " guestfs_lvm_canonical_lv_name (guestfs_h *g,\n"
12486 " const char *lvname);\n"
12491 #: ../src/guestfs-actions.pod:3902 ../fish/guestfish-actions.pod:2668
12493 "This converts alternative naming schemes for LVs that you might find to the "
12494 "canonical name. For example, C</dev/mapper/VG-LV> is converted to C</dev/VG/"
12499 #: ../src/guestfs-actions.pod:3906 ../fish/guestfish-actions.pod:2672
12501 "This command returns an error if the C<lvname> parameter does not refer to a "
12506 #: ../src/guestfs-actions.pod:3909
12507 msgid "See also C<guestfs_is_lv>."
12511 #: ../src/guestfs-actions.pod:3914
12512 msgid "(Added in 1.5.24)"
12516 #: ../src/guestfs-actions.pod:3916
12517 msgid "guestfs_lvm_clear_filter"
12521 #: ../src/guestfs-actions.pod:3918
12525 " guestfs_lvm_clear_filter (guestfs_h *g);\n"
12530 #: ../src/guestfs-actions.pod:3921
12532 "This undoes the effect of C<guestfs_lvm_set_filter>. LVM will be able to "
12533 "see every block device."
12537 #: ../src/guestfs-actions.pod:3924 ../src/guestfs-actions.pod:3966
12538 #: ../fish/guestfish-actions.pod:2684 ../fish/guestfish-actions.pod:2715
12540 "This command also clears the LVM cache and performs a volume group scan."
12544 #: ../src/guestfs-actions.pod:3931
12545 msgid "guestfs_lvm_remove_all"
12549 #: ../src/guestfs-actions.pod:3933
12553 " guestfs_lvm_remove_all (guestfs_h *g);\n"
12558 #: ../src/guestfs-actions.pod:3936 ../fish/guestfish-actions.pod:2691
12560 "This command removes all LVM logical volumes, volume groups and physical "
12565 #: ../src/guestfs-actions.pod:3946
12566 msgid "guestfs_lvm_set_filter"
12570 #: ../src/guestfs-actions.pod:3948
12574 " guestfs_lvm_set_filter (guestfs_h *g,\n"
12575 " char *const *devices);\n"
12580 #: ../src/guestfs-actions.pod:3952 ../fish/guestfish-actions.pod:2701
12582 "This sets the LVM device filter so that LVM will only be able to \"see\" the "
12583 "block devices in the list C<devices>, and will ignore all other attached "
12588 #: ../src/guestfs-actions.pod:3956 ../fish/guestfish-actions.pod:2705
12590 "Where disk image(s) contain duplicate PVs or VGs, this command is useful to "
12591 "get LVM to ignore the duplicates, otherwise LVM can get confused. Note also "
12592 "there are two types of duplication possible: either cloned PVs/VGs which "
12593 "have identical UUIDs; or VGs that are not cloned but just happen to have the "
12594 "same name. In normal operation you cannot create this situation, but you "
12595 "can do it outside LVM, eg. by cloning disk images or by bit twiddling "
12596 "inside the LVM metadata."
12600 #: ../src/guestfs-actions.pod:3969 ../fish/guestfish-actions.pod:2718
12601 msgid "You can filter whole block devices or individual partitions."
12605 #: ../src/guestfs-actions.pod:3971 ../fish/guestfish-actions.pod:2720
12607 "You cannot use this if any VG is currently in use (eg. contains a mounted "
12608 "filesystem), even if you are not filtering out that VG."
12612 #: ../src/guestfs-actions.pod:3979
12613 msgid "guestfs_lvremove"
12617 #: ../src/guestfs-actions.pod:3981
12621 " guestfs_lvremove (guestfs_h *g,\n"
12622 " const char *device);\n"
12627 #: ../src/guestfs-actions.pod:3985 ../fish/guestfish-actions.pod:2728
12629 "Remove an LVM logical volume C<device>, where C<device> is the path to the "
12630 "LV, such as C</dev/VG/LV>."
12634 #: ../src/guestfs-actions.pod:3988 ../fish/guestfish-actions.pod:2731
12636 "You can also remove all LVs in a volume group by specifying the VG name, C</"
12641 #: ../src/guestfs-actions.pod:3993 ../src/guestfs-actions.pod:5229
12642 #: ../src/guestfs-actions.pod:7018
12643 msgid "(Added in 1.0.13)"
12647 #: ../src/guestfs-actions.pod:3995
12648 msgid "guestfs_lvrename"
12652 #: ../src/guestfs-actions.pod:3997
12656 " guestfs_lvrename (guestfs_h *g,\n"
12657 " const char *logvol,\n"
12658 " const char *newlogvol);\n"
12663 #: ../src/guestfs-actions.pod:4002 ../fish/guestfish-actions.pod:2738
12664 msgid "Rename a logical volume C<logvol> with the new name C<newlogvol>."
12668 #: ../src/guestfs-actions.pod:4006 ../src/guestfs-actions.pod:7031
12669 msgid "(Added in 1.0.83)"
12673 #: ../src/guestfs-actions.pod:4008
12674 msgid "guestfs_lvresize"
12678 #: ../src/guestfs-actions.pod:4010
12682 " guestfs_lvresize (guestfs_h *g,\n"
12683 " const char *device,\n"
12689 #: ../src/guestfs-actions.pod:4015 ../fish/guestfish-actions.pod:2744
12691 "This resizes (expands or shrinks) an existing LVM logical volume to "
12692 "C<mbytes>. When reducing, data in the reduced part is lost."
12696 #: ../src/guestfs-actions.pod:4023
12697 msgid "guestfs_lvresize_free"
12701 #: ../src/guestfs-actions.pod:4025
12705 " guestfs_lvresize_free (guestfs_h *g,\n"
12706 " const char *lv,\n"
12712 #: ../src/guestfs-actions.pod:4030 ../fish/guestfish-actions.pod:2752
12714 "This expands an existing logical volume C<lv> so that it fills C<pc>% of the "
12715 "remaining free space in the volume group. Commonly you would call this with "
12716 "pc = 100 which expands the logical volume as much as possible, using all "
12717 "remaining free space in the volume group."
12721 #: ../src/guestfs-actions.pod:4038
12722 msgid "(Added in 1.3.3)"
12726 #: ../src/guestfs-actions.pod:4040
12727 msgid "guestfs_lvs"
12731 #: ../src/guestfs-actions.pod:4042
12735 " guestfs_lvs (guestfs_h *g);\n"
12740 #: ../src/guestfs-actions.pod:4045 ../fish/guestfish-actions.pod:2762
12742 "List all the logical volumes detected. This is the equivalent of the L<lvs"
12747 #: ../src/guestfs-actions.pod:4048 ../fish/guestfish-actions.pod:2765
12749 "This returns a list of the logical volume device names (eg. C</dev/"
12750 "VolGroup00/LogVol00>)."
12754 #: ../src/guestfs-actions.pod:4051
12755 msgid "See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>."
12759 #: ../src/guestfs-actions.pod:4059
12760 msgid "guestfs_lvs_full"
12764 #: ../src/guestfs-actions.pod:4061
12767 " struct guestfs_lvm_lv_list *\n"
12768 " guestfs_lvs_full (guestfs_h *g);\n"
12773 #: ../src/guestfs-actions.pod:4064 ../fish/guestfish-actions.pod:2774
12775 "List all the logical volumes detected. This is the equivalent of the L<lvs"
12776 "(8)> command. The \"full\" version includes all fields."
12780 #: ../src/guestfs-actions.pod:4067
12782 "This function returns a C<struct guestfs_lvm_lv_list *>, or NULL if there "
12783 "was an error. I<The caller must call C<guestfs_free_lvm_lv_list> after use>."
12787 #: ../src/guestfs-actions.pod:4073
12788 msgid "guestfs_lvuuid"
12792 #: ../src/guestfs-actions.pod:4075
12796 " guestfs_lvuuid (guestfs_h *g,\n"
12797 " const char *device);\n"
12802 #: ../src/guestfs-actions.pod:4079 ../fish/guestfish-actions.pod:2781
12803 msgid "This command returns the UUID of the LVM LV C<device>."
12807 #: ../src/guestfs-actions.pod:4086
12808 msgid "guestfs_lxattrlist"
12812 #: ../src/guestfs-actions.pod:4088
12815 " struct guestfs_xattr_list *\n"
12816 " guestfs_lxattrlist (guestfs_h *g,\n"
12817 " const char *path,\n"
12818 " char *const *names);\n"
12823 #: ../src/guestfs-actions.pod:4093 ../fish/guestfish-actions.pod:2787
12825 "This call allows you to get the extended attributes of multiple files, where "
12826 "all files are in the directory C<path>. C<names> is the list of files from "
12831 #: ../src/guestfs-actions.pod:4097 ../fish/guestfish-actions.pod:2791
12833 "On return you get a flat list of xattr structs which must be interpreted "
12834 "sequentially. The first xattr struct always has a zero-length C<attrname>. "
12835 "C<attrval> in this struct is zero-length to indicate there was an error "
12836 "doing C<lgetxattr> for this file, I<or> is a C string which is a decimal "
12837 "number (the number of following attributes for this file, which could be C<"
12838 "\"0\">). Then after the first xattr struct are the zero or more attributes "
12839 "for the first named file. This repeats for the second and subsequent files."
12843 #: ../src/guestfs-actions.pod:4107
12845 "This call is intended for programs that want to efficiently list a directory "
12846 "contents without making many round-trips. See also C<guestfs_lstatlist> for "
12847 "a similarly efficient call for getting standard stats. Very long directory "
12848 "listings might cause the protocol message size to be exceeded, causing this "
12849 "call to fail. The caller must split up such requests into smaller groups of "
12854 #: ../src/guestfs-actions.pod:4121
12855 msgid "guestfs_mkdir"
12859 #: ../src/guestfs-actions.pod:4123
12863 " guestfs_mkdir (guestfs_h *g,\n"
12864 " const char *path);\n"
12869 #: ../src/guestfs-actions.pod:4127 ../fish/guestfish-actions.pod:2813
12870 msgid "Create a directory named C<path>."
12874 #: ../src/guestfs-actions.pod:4133
12875 msgid "guestfs_mkdir_mode"
12879 #: ../src/guestfs-actions.pod:4135
12883 " guestfs_mkdir_mode (guestfs_h *g,\n"
12884 " const char *path,\n"
12890 #: ../src/guestfs-actions.pod:4140 ../fish/guestfish-actions.pod:2819
12892 "This command creates a directory, setting the initial permissions of the "
12893 "directory to C<mode>."
12897 #: ../src/guestfs-actions.pod:4143 ../fish/guestfish-actions.pod:2822
12899 "For common Linux filesystems, the actual mode which is set will be C<mode & "
12900 "~umask & 01777>. Non-native-Linux filesystems may interpret the mode in "
12905 #: ../src/guestfs-actions.pod:4147
12906 msgid "See also C<guestfs_mkdir>, C<guestfs_umask>"
12910 #: ../src/guestfs-actions.pod:4153
12911 msgid "guestfs_mkdir_p"
12915 #: ../src/guestfs-actions.pod:4155
12919 " guestfs_mkdir_p (guestfs_h *g,\n"
12920 " const char *path);\n"
12925 #: ../src/guestfs-actions.pod:4159 ../fish/guestfish-actions.pod:2832
12927 "Create a directory named C<path>, creating any parent directories as "
12928 "necessary. This is like the C<mkdir -p> shell command."
12932 #: ../src/guestfs-actions.pod:4166
12933 msgid "guestfs_mkdtemp"
12937 #: ../src/guestfs-actions.pod:4168
12941 " guestfs_mkdtemp (guestfs_h *g,\n"
12942 " const char *template);\n"
12947 #: ../src/guestfs-actions.pod:4172 ../fish/guestfish-actions.pod:2839
12949 "This command creates a temporary directory. The C<template> parameter "
12950 "should be a full pathname for the temporary directory name with the final "
12951 "six characters being \"XXXXXX\"."
12955 #: ../src/guestfs-actions.pod:4177 ../fish/guestfish-actions.pod:2844
12957 "For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\", the second one "
12958 "being suitable for Windows filesystems."
12962 #: ../src/guestfs-actions.pod:4180 ../fish/guestfish-actions.pod:2847
12963 msgid "The name of the temporary directory that was created is returned."
12967 #: ../src/guestfs-actions.pod:4183 ../fish/guestfish-actions.pod:2850
12968 msgid "The temporary directory is created with mode 0700 and is owned by root."
12972 #: ../src/guestfs-actions.pod:4186 ../fish/guestfish-actions.pod:2853
12974 "The caller is responsible for deleting the temporary directory and its "
12975 "contents after use."
12979 #: ../src/guestfs-actions.pod:4189 ../fish/guestfish-actions.pod:2856
12980 msgid "See also: L<mkdtemp(3)>"
12984 #: ../src/guestfs-actions.pod:4196
12985 msgid "guestfs_mke2fs_J"
12989 #: ../src/guestfs-actions.pod:4198
12993 " guestfs_mke2fs_J (guestfs_h *g,\n"
12994 " const char *fstype,\n"
12995 " int blocksize,\n"
12996 " const char *device,\n"
12997 " const char *journal);\n"
13002 #: ../src/guestfs-actions.pod:4205 ../fish/guestfish-actions.pod:2862
13004 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
13005 "C<journal>. It is equivalent to the command:"
13009 #: ../src/guestfs-actions.pod:4209 ../fish/guestfish-actions.pod:2866
13012 " mke2fs -t fstype -b blocksize -J device=<journal> <device>\n"
13017 #: ../src/guestfs-actions.pod:4211
13018 msgid "See also C<guestfs_mke2journal>."
13022 #: ../src/guestfs-actions.pod:4215 ../src/guestfs-actions.pod:4233
13023 #: ../src/guestfs-actions.pod:4251 ../src/guestfs-actions.pod:4267
13024 #: ../src/guestfs-actions.pod:4281 ../src/guestfs-actions.pod:4295
13025 #: ../src/guestfs-actions.pod:4354 ../src/guestfs-actions.pod:4619
13026 msgid "(Added in 1.0.68)"
13030 #: ../src/guestfs-actions.pod:4217
13031 msgid "guestfs_mke2fs_JL"
13035 #: ../src/guestfs-actions.pod:4219
13039 " guestfs_mke2fs_JL (guestfs_h *g,\n"
13040 " const char *fstype,\n"
13041 " int blocksize,\n"
13042 " const char *device,\n"
13043 " const char *label);\n"
13048 #: ../src/guestfs-actions.pod:4226 ../fish/guestfish-actions.pod:2874
13050 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
13051 "the journal labeled C<label>."
13055 #: ../src/guestfs-actions.pod:4229
13056 msgid "See also C<guestfs_mke2journal_L>."
13060 #: ../src/guestfs-actions.pod:4235
13061 msgid "guestfs_mke2fs_JU"
13065 #: ../src/guestfs-actions.pod:4237
13069 " guestfs_mke2fs_JU (guestfs_h *g,\n"
13070 " const char *fstype,\n"
13071 " int blocksize,\n"
13072 " const char *device,\n"
13073 " const char *uuid);\n"
13078 #: ../src/guestfs-actions.pod:4244 ../fish/guestfish-actions.pod:2883
13080 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
13081 "the journal with UUID C<uuid>."
13085 #: ../src/guestfs-actions.pod:4247
13086 msgid "See also C<guestfs_mke2journal_U>."
13090 #: ../src/guestfs-actions.pod:4253
13091 msgid "guestfs_mke2journal"
13095 #: ../src/guestfs-actions.pod:4255
13099 " guestfs_mke2journal (guestfs_h *g,\n"
13100 " int blocksize,\n"
13101 " const char *device);\n"
13106 #: ../src/guestfs-actions.pod:4260 ../fish/guestfish-actions.pod:2892
13108 "This creates an ext2 external journal on C<device>. It is equivalent to the "
13113 #: ../src/guestfs-actions.pod:4263 ../fish/guestfish-actions.pod:2895
13116 " mke2fs -O journal_dev -b blocksize device\n"
13121 #: ../src/guestfs-actions.pod:4269
13122 msgid "guestfs_mke2journal_L"
13126 #: ../src/guestfs-actions.pod:4271
13130 " guestfs_mke2journal_L (guestfs_h *g,\n"
13131 " int blocksize,\n"
13132 " const char *label,\n"
13133 " const char *device);\n"
13138 #: ../src/guestfs-actions.pod:4277 ../fish/guestfish-actions.pod:2901
13139 msgid "This creates an ext2 external journal on C<device> with label C<label>."
13143 #: ../src/guestfs-actions.pod:4283
13144 msgid "guestfs_mke2journal_U"
13148 #: ../src/guestfs-actions.pod:4285
13152 " guestfs_mke2journal_U (guestfs_h *g,\n"
13153 " int blocksize,\n"
13154 " const char *uuid,\n"
13155 " const char *device);\n"
13160 #: ../src/guestfs-actions.pod:4291 ../fish/guestfish-actions.pod:2907
13161 msgid "This creates an ext2 external journal on C<device> with UUID C<uuid>."
13165 #: ../src/guestfs-actions.pod:4297
13166 msgid "guestfs_mkfifo"
13170 #: ../src/guestfs-actions.pod:4299
13174 " guestfs_mkfifo (guestfs_h *g,\n"
13176 " const char *path);\n"
13181 #: ../src/guestfs-actions.pod:4304
13183 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
13184 "is just a convenient wrapper around C<guestfs_mknod>."
13188 #: ../src/guestfs-actions.pod:4314
13189 msgid "guestfs_mkfs"
13193 #: ../src/guestfs-actions.pod:4316
13197 " guestfs_mkfs (guestfs_h *g,\n"
13198 " const char *fstype,\n"
13199 " const char *device);\n"
13204 #: ../src/guestfs-actions.pod:4321 ../fish/guestfish-actions.pod:2923
13206 "This creates a filesystem on C<device> (usually a partition or LVM logical "
13207 "volume). The filesystem type is C<fstype>, for example C<ext3>."
13211 #: ../src/guestfs-actions.pod:4329
13212 msgid "guestfs_mkfs_b"
13216 #: ../src/guestfs-actions.pod:4331
13220 " guestfs_mkfs_b (guestfs_h *g,\n"
13221 " const char *fstype,\n"
13222 " int blocksize,\n"
13223 " const char *device);\n"
13228 #: ../src/guestfs-actions.pod:4337
13230 "This call is similar to C<guestfs_mkfs>, but it allows you to control the "
13231 "block size of the resulting filesystem. Supported block sizes depend on the "
13232 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
13236 #: ../src/guestfs-actions.pod:4342 ../src/guestfs-actions.pod:4385
13237 #: ../fish/guestfish-actions.pod:2936 ../fish/guestfish-actions.pod:2963
13239 "For VFAT and NTFS the C<blocksize> parameter is treated as the requested "
13244 #: ../src/guestfs-actions.pod:4347 ../fish/guestfish-actions.pod:2939
13246 "This function is deprecated. In new code, use the C<mkfs_opts> call instead."
13250 #: ../src/guestfs-actions.pod:4356
13251 msgid "guestfs_mkfs_opts"
13255 #: ../src/guestfs-actions.pod:4358
13259 " guestfs_mkfs_opts (guestfs_h *g,\n"
13260 " const char *fstype,\n"
13261 " const char *device,\n"
13267 #: ../src/guestfs-actions.pod:4369
13270 " GUESTFS_MKFS_OPTS_BLOCKSIZE, int blocksize,\n"
13271 " GUESTFS_MKFS_OPTS_FEATURES, const char *features,\n"
13276 #: ../src/guestfs-actions.pod:4372 ../fish/guestfish-actions.pod:2950
13278 "This function creates a filesystem on C<device>. The filesystem type is "
13279 "C<fstype>, for example C<ext3>."
13283 #: ../src/guestfs-actions.pod:4379 ../fish/guestfish-actions.pod:2957
13284 msgid "C<blocksize>"
13288 #: ../src/guestfs-actions.pod:4381 ../fish/guestfish-actions.pod:2959
13290 "The filesystem block size. Supported block sizes depend on the filesystem "
13291 "type, but typically they are C<1024>, C<2048> or C<4096> for Linux ext2/3 "
13296 #: ../src/guestfs-actions.pod:4388 ../fish/guestfish-actions.pod:2966
13297 msgid "For UFS block sizes, please see L<mkfs.ufs(8)>."
13301 #: ../src/guestfs-actions.pod:4390 ../fish/guestfish-actions.pod:2968
13302 msgid "C<features>"
13306 #: ../src/guestfs-actions.pod:4392 ../fish/guestfish-actions.pod:2970
13307 msgid "This passes the C<-O> parameter to the external mkfs program."
13311 #: ../src/guestfs-actions.pod:4394 ../fish/guestfish-actions.pod:2972
13313 "For certain filesystem types, this allows extra filesystem features to be "
13314 "selected. See L<mke2fs(8)> and L<mkfs.ufs(8)> for more details."
13318 #: ../src/guestfs-actions.pod:4398 ../fish/guestfish-actions.pod:2976
13320 "You cannot use this optional parameter with the C<gfs> or C<gfs2> filesystem "
13325 #: ../src/guestfs-actions.pod:4405
13326 msgid "(Added in 1.7.19)"
13330 #: ../src/guestfs-actions.pod:4407
13331 msgid "guestfs_mkfs_opts_va"
13335 #: ../src/guestfs-actions.pod:4409
13339 " guestfs_mkfs_opts_va (guestfs_h *g,\n"
13340 " const char *fstype,\n"
13341 " const char *device,\n"
13342 " va_list args);\n"
13347 #: ../src/guestfs-actions.pod:4415
13348 msgid "This is the \"va_list variant\" of L</guestfs_mkfs_opts>."
13352 #: ../src/guestfs-actions.pod:4419
13353 msgid "guestfs_mkfs_opts_argv"
13357 #: ../src/guestfs-actions.pod:4421
13361 " guestfs_mkfs_opts_argv (guestfs_h *g,\n"
13362 " const char *fstype,\n"
13363 " const char *device,\n"
13364 " const struct guestfs_mkfs_opts_argv *optargs);\n"
13369 #: ../src/guestfs-actions.pod:4427
13370 msgid "This is the \"argv variant\" of L</guestfs_mkfs_opts>."
13374 #: ../src/guestfs-actions.pod:4431
13375 msgid "guestfs_mkmountpoint"
13379 #: ../src/guestfs-actions.pod:4433
13383 " guestfs_mkmountpoint (guestfs_h *g,\n"
13384 " const char *exemptpath);\n"
13389 #: ../src/guestfs-actions.pod:4437
13391 "C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are specialized calls "
13392 "that can be used to create extra mountpoints before mounting the first "
13397 #: ../src/guestfs-actions.pod:4441 ../fish/guestfish-actions.pod:2991
13399 "These calls are I<only> necessary in some very limited circumstances, mainly "
13400 "the case where you want to mount a mix of unrelated and/or read-only "
13401 "filesystems together."
13405 #: ../src/guestfs-actions.pod:4445 ../fish/guestfish-actions.pod:2995
13407 "For example, live CDs often contain a \"Russian doll\" nest of filesystems, "
13408 "an ISO outer layer, with a squashfs image inside, with an ext2/3 image "
13409 "inside that. You can unpack this as follows in guestfish:"
13413 #: ../src/guestfs-actions.pod:4450 ../fish/guestfish-actions.pod:3000
13416 " add-ro Fedora-11-i686-Live.iso\n"
13418 " mkmountpoint /cd\n"
13419 " mkmountpoint /sqsh\n"
13420 " mkmountpoint /ext3fs\n"
13421 " mount /dev/sda /cd\n"
13422 " mount-loop /cd/LiveOS/squashfs.img /sqsh\n"
13423 " mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs\n"
13428 #: ../src/guestfs-actions.pod:4459 ../fish/guestfish-actions.pod:3009
13429 msgid "The inner filesystem is now unpacked under the /ext3fs mountpoint."
13433 #: ../src/guestfs-actions.pod:4461
13435 "C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>. You "
13436 "may get unexpected errors if you try to mix these calls. It is safest to "
13437 "manually unmount filesystems and remove mountpoints after use."
13441 #: ../src/guestfs-actions.pod:4465
13443 "C<guestfs_umount_all> unmounts filesystems by sorting the paths longest "
13444 "first, so for this to work for manual mountpoints, you must ensure that the "
13445 "innermost mountpoints have the longest pathnames, as in the example code "
13450 #: ../src/guestfs-actions.pod:4470 ../fish/guestfish-actions.pod:3020
13452 "For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>"
13456 #: ../src/guestfs-actions.pod:4472
13458 "Autosync [see C<guestfs_set_autosync>, this is set by default on handles] "
13459 "can cause C<guestfs_umount_all> to be called when the handle is closed which "
13460 "can also trigger these issues."
13464 #: ../src/guestfs-actions.pod:4478 ../src/guestfs-actions.pod:4737
13465 #: ../src/guestfs-actions.pod:5647
13466 msgid "(Added in 1.0.62)"
13470 #: ../src/guestfs-actions.pod:4480
13471 msgid "guestfs_mknod"
13475 #: ../src/guestfs-actions.pod:4482
13479 " guestfs_mknod (guestfs_h *g,\n"
13483 " const char *path);\n"
13488 #: ../src/guestfs-actions.pod:4489 ../fish/guestfish-actions.pod:3030
13490 "This call creates block or character special devices, or named pipes (FIFOs)."
13494 #: ../src/guestfs-actions.pod:4492 ../fish/guestfish-actions.pod:3033
13496 "The C<mode> parameter should be the mode, using the standard constants. "
13497 "C<devmajor> and C<devminor> are the device major and minor numbers, only "
13498 "used when creating block and character special devices."
13502 #: ../src/guestfs-actions.pod:4497
13504 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
13505 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
13506 "regular file). These constants are available in the standard Linux header "
13507 "files, or you can use C<guestfs_mknod_b>, C<guestfs_mknod_c> or "
13508 "C<guestfs_mkfifo> which are wrappers around this command which bitwise OR in "
13509 "the appropriate constant for you."
13513 #: ../src/guestfs-actions.pod:4511
13514 msgid "guestfs_mknod_b"
13518 #: ../src/guestfs-actions.pod:4513
13522 " guestfs_mknod_b (guestfs_h *g,\n"
13526 " const char *path);\n"
13531 #: ../src/guestfs-actions.pod:4520
13533 "This call creates a block device node called C<path> with mode C<mode> and "
13534 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
13535 "wrapper around C<guestfs_mknod>."
13539 #: ../src/guestfs-actions.pod:4530
13540 msgid "guestfs_mknod_c"
13544 #: ../src/guestfs-actions.pod:4532
13548 " guestfs_mknod_c (guestfs_h *g,\n"
13552 " const char *path);\n"
13557 #: ../src/guestfs-actions.pod:4539
13559 "This call creates a char device node called C<path> with mode C<mode> and "
13560 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
13561 "wrapper around C<guestfs_mknod>."
13565 #: ../src/guestfs-actions.pod:4549
13566 msgid "guestfs_mkswap"
13570 #: ../src/guestfs-actions.pod:4551
13574 " guestfs_mkswap (guestfs_h *g,\n"
13575 " const char *device);\n"
13580 #: ../src/guestfs-actions.pod:4555 ../fish/guestfish-actions.pod:3072
13581 msgid "Create a swap partition on C<device>."
13585 #: ../src/guestfs-actions.pod:4561
13586 msgid "guestfs_mkswap_L"
13590 #: ../src/guestfs-actions.pod:4563
13594 " guestfs_mkswap_L (guestfs_h *g,\n"
13595 " const char *label,\n"
13596 " const char *device);\n"
13601 #: ../src/guestfs-actions.pod:4568 ../fish/guestfish-actions.pod:3078
13602 msgid "Create a swap partition on C<device> with label C<label>."
13606 #: ../src/guestfs-actions.pod:4570 ../fish/guestfish-actions.pod:3080
13608 "Note that you cannot attach a swap label to a block device (eg. C</dev/"
13609 "sda>), just to a partition. This appears to be a limitation of the kernel "
13614 #: ../src/guestfs-actions.pod:4578
13615 msgid "guestfs_mkswap_U"
13619 #: ../src/guestfs-actions.pod:4580
13623 " guestfs_mkswap_U (guestfs_h *g,\n"
13624 " const char *uuid,\n"
13625 " const char *device);\n"
13630 #: ../src/guestfs-actions.pod:4585 ../fish/guestfish-actions.pod:3088
13631 msgid "Create a swap partition on C<device> with UUID C<uuid>."
13635 #: ../src/guestfs-actions.pod:4591
13636 msgid "guestfs_mkswap_file"
13640 #: ../src/guestfs-actions.pod:4593
13644 " guestfs_mkswap_file (guestfs_h *g,\n"
13645 " const char *path);\n"
13650 #: ../src/guestfs-actions.pod:4597 ../fish/guestfish-actions.pod:3094
13651 msgid "Create a swap file."
13655 #: ../src/guestfs-actions.pod:4599
13657 "This command just writes a swap file signature to an existing file. To "
13658 "create the file itself, use something like C<guestfs_fallocate>."
13662 #: ../src/guestfs-actions.pod:4606
13663 msgid "guestfs_modprobe"
13667 #: ../src/guestfs-actions.pod:4608
13671 " guestfs_modprobe (guestfs_h *g,\n"
13672 " const char *modulename);\n"
13677 #: ../src/guestfs-actions.pod:4612 ../fish/guestfish-actions.pod:3103
13678 msgid "This loads a kernel module in the appliance."
13682 #: ../src/guestfs-actions.pod:4614 ../fish/guestfish-actions.pod:3105
13684 "The kernel module must have been whitelisted when libguestfs was built (see "
13685 "C<appliance/kmod.whitelist.in> in the source)."
13689 #: ../src/guestfs-actions.pod:4621
13690 msgid "guestfs_mount"
13694 #: ../src/guestfs-actions.pod:4623
13698 " guestfs_mount (guestfs_h *g,\n"
13699 " const char *device,\n"
13700 " const char *mountpoint);\n"
13705 #: ../src/guestfs-actions.pod:4628 ../fish/guestfish-actions.pod:3112
13707 "Mount a guest disk at a position in the filesystem. Block devices are named "
13708 "C</dev/sda>, C</dev/sdb> and so on, as they were added to the guest. If "
13709 "those block devices contain partitions, they will have the usual names (eg. "
13710 "C</dev/sda1>). Also LVM C</dev/VG/LV>-style names can be used."
13714 #: ../src/guestfs-actions.pod:4634 ../fish/guestfish-actions.pod:3118
13716 "The rules are the same as for L<mount(2)>: A filesystem must first be "
13717 "mounted on C</> before others can be mounted. Other filesystems can only be "
13718 "mounted on directories which already exist."
13722 #: ../src/guestfs-actions.pod:4639 ../fish/guestfish-actions.pod:3123
13724 "The mounted filesystem is writable, if we have sufficient permissions on the "
13725 "underlying device."
13729 #: ../src/guestfs-actions.pod:4642
13731 "B<Important note:> When you use this call, the filesystem options C<sync> "
13732 "and C<noatime> are set implicitly. This was originally done because we "
13733 "thought it would improve reliability, but it turns out that I<-o sync> has a "
13734 "very large negative performance impact and negligible effect on "
13735 "reliability. Therefore we recommend that you avoid using C<guestfs_mount> "
13736 "in any code that needs performance, and instead use C<guestfs_mount_options> "
13737 "(use an empty string for the first parameter if you don't want any options)."
13741 #: ../src/guestfs-actions.pod:4656
13742 msgid "guestfs_mount_loop"
13746 #: ../src/guestfs-actions.pod:4658
13750 " guestfs_mount_loop (guestfs_h *g,\n"
13751 " const char *file,\n"
13752 " const char *mountpoint);\n"
13757 #: ../src/guestfs-actions.pod:4663 ../fish/guestfish-actions.pod:3140
13759 "This command lets you mount C<file> (a filesystem image in a file) on a "
13760 "mount point. It is entirely equivalent to the command C<mount -o loop file "
13765 #: ../src/guestfs-actions.pod:4671
13766 msgid "guestfs_mount_options"
13770 #: ../src/guestfs-actions.pod:4673
13774 " guestfs_mount_options (guestfs_h *g,\n"
13775 " const char *options,\n"
13776 " const char *device,\n"
13777 " const char *mountpoint);\n"
13782 #: ../src/guestfs-actions.pod:4679
13784 "This is the same as the C<guestfs_mount> command, but it allows you to set "
13785 "the mount options as for the L<mount(8)> I<-o> flag."
13789 #: ../src/guestfs-actions.pod:4683 ../fish/guestfish-actions.pod:3152
13791 "If the C<options> parameter is an empty string, then no options are passed "
13792 "(all options default to whatever the filesystem uses)."
13796 #: ../src/guestfs-actions.pod:4689 ../src/guestfs-actions.pod:4703
13797 #: ../src/guestfs-actions.pod:4720
13798 msgid "(Added in 1.0.10)"
13802 #: ../src/guestfs-actions.pod:4691
13803 msgid "guestfs_mount_ro"
13807 #: ../src/guestfs-actions.pod:4693
13811 " guestfs_mount_ro (guestfs_h *g,\n"
13812 " const char *device,\n"
13813 " const char *mountpoint);\n"
13818 #: ../src/guestfs-actions.pod:4698
13820 "This is the same as the C<guestfs_mount> command, but it mounts the "
13821 "filesystem with the read-only (I<-o ro>) flag."
13825 #: ../src/guestfs-actions.pod:4705
13826 msgid "guestfs_mount_vfs"
13830 #: ../src/guestfs-actions.pod:4707
13834 " guestfs_mount_vfs (guestfs_h *g,\n"
13835 " const char *options,\n"
13836 " const char *vfstype,\n"
13837 " const char *device,\n"
13838 " const char *mountpoint);\n"
13843 #: ../src/guestfs-actions.pod:4714
13845 "This is the same as the C<guestfs_mount> command, but it allows you to set "
13846 "both the mount options and the vfstype as for the L<mount(8)> I<-o> and I<-"
13851 #: ../src/guestfs-actions.pod:4722
13852 msgid "guestfs_mountpoints"
13856 #: ../src/guestfs-actions.pod:4724
13860 " guestfs_mountpoints (guestfs_h *g);\n"
13865 #: ../src/guestfs-actions.pod:4727
13867 "This call is similar to C<guestfs_mounts>. That call returns a list of "
13868 "devices. This one returns a hash table (map) of device name to directory "
13869 "where the device is mounted."
13873 #: ../src/guestfs-actions.pod:4739
13874 msgid "guestfs_mounts"
13878 #: ../src/guestfs-actions.pod:4741
13882 " guestfs_mounts (guestfs_h *g);\n"
13887 #: ../src/guestfs-actions.pod:4744 ../fish/guestfish-actions.pod:3183
13889 "This returns the list of currently mounted filesystems. It returns the list "
13890 "of devices (eg. C</dev/sda1>, C</dev/VG/LV>)."
13894 #: ../src/guestfs-actions.pod:4747 ../fish/guestfish-actions.pod:3186
13895 msgid "Some internal mounts are not shown."
13899 #: ../src/guestfs-actions.pod:4749
13900 msgid "See also: C<guestfs_mountpoints>"
13904 #: ../src/guestfs-actions.pod:4757
13909 #: ../src/guestfs-actions.pod:4759
13913 " guestfs_mv (guestfs_h *g,\n"
13914 " const char *src,\n"
13915 " const char *dest);\n"
13920 #: ../src/guestfs-actions.pod:4764 ../fish/guestfish-actions.pod:3194
13922 "This moves a file from C<src> to C<dest> where C<dest> is either a "
13923 "destination filename or destination directory."
13927 #: ../src/guestfs-actions.pod:4771
13928 msgid "guestfs_ntfs_3g_probe"
13932 #: ../src/guestfs-actions.pod:4773
13936 " guestfs_ntfs_3g_probe (guestfs_h *g,\n"
13938 " const char *device);\n"
13943 #: ../src/guestfs-actions.pod:4778 ../fish/guestfish-actions.pod:3201
13945 "This command runs the L<ntfs-3g.probe(8)> command which probes an NTFS "
13946 "C<device> for mountability. (Not all NTFS volumes can be mounted read-"
13947 "write, and some cannot be mounted at all)."
13951 #: ../src/guestfs-actions.pod:4782 ../fish/guestfish-actions.pod:3205
13953 "C<rw> is a boolean flag. Set it to true if you want to test if the volume "
13954 "can be mounted read-write. Set it to false if you want to test if the "
13955 "volume can be mounted read-only."
13959 #: ../src/guestfs-actions.pod:4786 ../fish/guestfish-actions.pod:3209
13961 "The return value is an integer which C<0> if the operation would succeed, or "
13962 "some non-zero value documented in the L<ntfs-3g.probe(8)> manual page."
13966 #: ../src/guestfs-actions.pod:4792
13967 msgid "(Added in 1.0.43)"
13971 #: ../src/guestfs-actions.pod:4794
13972 msgid "guestfs_ntfsresize"
13976 #: ../src/guestfs-actions.pod:4796
13980 " guestfs_ntfsresize (guestfs_h *g,\n"
13981 " const char *device);\n"
13986 #: ../src/guestfs-actions.pod:4800 ../fish/guestfish-actions.pod:3217
13988 "This command resizes an NTFS filesystem, expanding or shrinking it to the "
13989 "size of the underlying device. See also L<ntfsresize(8)>."
13993 #: ../src/guestfs-actions.pod:4808
13994 msgid "guestfs_ntfsresize_size"
13998 #: ../src/guestfs-actions.pod:4810
14002 " guestfs_ntfsresize_size (guestfs_h *g,\n"
14003 " const char *device,\n"
14004 " int64_t size);\n"
14009 #: ../src/guestfs-actions.pod:4815
14011 "This command is the same as C<guestfs_ntfsresize> except that it allows you "
14012 "to specify the new size (in bytes) explicitly."
14016 #: ../src/guestfs-actions.pod:4820 ../src/guestfs-actions.pod:5256
14017 #: ../src/guestfs-actions.pod:5329 ../src/guestfs-actions.pod:5595
14018 #: ../src/guestfs-actions.pod:7166
14019 msgid "(Added in 1.3.14)"
14023 #: ../src/guestfs-actions.pod:4822
14024 msgid "guestfs_part_add"
14028 #: ../src/guestfs-actions.pod:4824
14032 " guestfs_part_add (guestfs_h *g,\n"
14033 " const char *device,\n"
14034 " const char *prlogex,\n"
14035 " int64_t startsect,\n"
14036 " int64_t endsect);\n"
14041 #: ../src/guestfs-actions.pod:4831
14043 "This command adds a partition to C<device>. If there is no partition table "
14044 "on the device, call C<guestfs_part_init> first."
14048 #: ../src/guestfs-actions.pod:4834 ../fish/guestfish-actions.pod:3235
14050 "The C<prlogex> parameter is the type of partition. Normally you should pass "
14051 "C<p> or C<primary> here, but MBR partition tables also support C<l> (or "
14052 "C<logical>) and C<e> (or C<extended>) partition types."
14056 #: ../src/guestfs-actions.pod:4839 ../fish/guestfish-actions.pod:3240
14058 "C<startsect> and C<endsect> are the start and end of the partition in "
14059 "I<sectors>. C<endsect> may be negative, which means it counts backwards "
14060 "from the end of the disk (C<-1> is the last sector)."
14064 #: ../src/guestfs-actions.pod:4843
14066 "Creating a partition which covers the whole disk is not so easy. Use "
14067 "C<guestfs_part_disk> to do that."
14071 #: ../src/guestfs-actions.pod:4848 ../src/guestfs-actions.pod:4886
14072 #: ../src/guestfs-actions.pod:4939 ../src/guestfs-actions.pod:5017
14073 #: ../src/guestfs-actions.pod:5055 ../src/guestfs-actions.pod:5074
14074 #: ../src/guestfs-actions.pod:5114
14075 msgid "(Added in 1.0.78)"
14079 #: ../src/guestfs-actions.pod:4850
14080 msgid "guestfs_part_del"
14084 #: ../src/guestfs-actions.pod:4852
14088 " guestfs_part_del (guestfs_h *g,\n"
14089 " const char *device,\n"
14095 #: ../src/guestfs-actions.pod:4857 ../fish/guestfish-actions.pod:3251
14096 msgid "This command deletes the partition numbered C<partnum> on C<device>."
14100 #: ../src/guestfs-actions.pod:4859 ../fish/guestfish-actions.pod:3253
14102 "Note that in the case of MBR partitioning, deleting an extended partition "
14103 "also deletes any logical partitions it contains."
14107 #: ../src/guestfs-actions.pod:4867
14108 msgid "guestfs_part_disk"
14112 #: ../src/guestfs-actions.pod:4869
14116 " guestfs_part_disk (guestfs_h *g,\n"
14117 " const char *device,\n"
14118 " const char *parttype);\n"
14123 #: ../src/guestfs-actions.pod:4874
14125 "This command is simply a combination of C<guestfs_part_init> followed by "
14126 "C<guestfs_part_add> to create a single primary partition covering the whole "
14131 #: ../src/guestfs-actions.pod:4878
14133 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
14134 "possible values are described in C<guestfs_part_init>."
14138 #: ../src/guestfs-actions.pod:4888
14139 msgid "guestfs_part_get_bootable"
14143 #: ../src/guestfs-actions.pod:4890
14147 " guestfs_part_get_bootable (guestfs_h *g,\n"
14148 " const char *device,\n"
14154 #: ../src/guestfs-actions.pod:4895 ../fish/guestfish-actions.pod:3275
14156 "This command returns true if the partition C<partnum> on C<device> has the "
14157 "bootable flag set."
14161 #: ../src/guestfs-actions.pod:4898
14162 msgid "See also C<guestfs_part_set_bootable>."
14166 #: ../src/guestfs-actions.pod:4904
14167 msgid "guestfs_part_get_mbr_id"
14171 #: ../src/guestfs-actions.pod:4906
14175 " guestfs_part_get_mbr_id (guestfs_h *g,\n"
14176 " const char *device,\n"
14182 #: ../src/guestfs-actions.pod:4911 ../fish/guestfish-actions.pod:3284
14184 "Returns the MBR type byte (also known as the ID byte) from the numbered "
14185 "partition C<partnum>."
14189 #: ../src/guestfs-actions.pod:4914 ../src/guestfs-actions.pod:5090
14191 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
14192 "undefined results for other partition table types (see "
14193 "C<guestfs_part_get_parttype>)."
14197 #: ../src/guestfs-actions.pod:4922
14198 msgid "guestfs_part_get_parttype"
14202 #: ../src/guestfs-actions.pod:4924
14206 " guestfs_part_get_parttype (guestfs_h *g,\n"
14207 " const char *device);\n"
14212 #: ../src/guestfs-actions.pod:4928 ../fish/guestfish-actions.pod:3295
14214 "This command examines the partition table on C<device> and returns the "
14215 "partition table type (format) being used."
14219 #: ../src/guestfs-actions.pod:4931
14221 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
14222 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
14223 "possible, although unusual. See C<guestfs_part_init> for a full list."
14227 #: ../src/guestfs-actions.pod:4941
14228 msgid "guestfs_part_init"
14232 #: ../src/guestfs-actions.pod:4943
14236 " guestfs_part_init (guestfs_h *g,\n"
14237 " const char *device,\n"
14238 " const char *parttype);\n"
14243 #: ../src/guestfs-actions.pod:4948 ../fish/guestfish-actions.pod:3307
14245 "This creates an empty partition table on C<device> of one of the partition "
14246 "types listed below. Usually C<parttype> should be either C<msdos> or C<gpt> "
14247 "(for large disks)."
14251 #: ../src/guestfs-actions.pod:4952
14253 "Initially there are no partitions. Following this, you should call "
14254 "C<guestfs_part_add> for each partition required."
14258 #: ../src/guestfs-actions.pod:4955 ../fish/guestfish-actions.pod:3314
14259 msgid "Possible values for C<parttype> are:"
14263 #: ../src/guestfs-actions.pod:4959 ../fish/guestfish-actions.pod:3318
14264 msgid "B<efi> | B<gpt>"
14268 #: ../src/guestfs-actions.pod:4961 ../fish/guestfish-actions.pod:3320
14269 msgid "Intel EFI / GPT partition table."
14273 #: ../src/guestfs-actions.pod:4963 ../fish/guestfish-actions.pod:3322
14275 "This is recommended for >= 2 TB partitions that will be accessed from Linux "
14276 "and Intel-based Mac OS X. It also has limited backwards compatibility with "
14277 "the C<mbr> format."
14281 #: ../src/guestfs-actions.pod:4967 ../fish/guestfish-actions.pod:3326
14282 msgid "B<mbr> | B<msdos>"
14286 #: ../src/guestfs-actions.pod:4969 ../fish/guestfish-actions.pod:3328
14288 "The standard PC \"Master Boot Record\" (MBR) format used by MS-DOS and "
14289 "Windows. This partition type will B<only> work for device sizes up to 2 "
14290 "TB. For large disks we recommend using C<gpt>."
14294 #: ../src/guestfs-actions.pod:4976 ../fish/guestfish-actions.pod:3335
14296 "Other partition table types that may work but are not supported include:"
14300 #: ../src/guestfs-actions.pod:4981 ../fish/guestfish-actions.pod:3340
14305 #: ../src/guestfs-actions.pod:4983 ../fish/guestfish-actions.pod:3342
14306 msgid "AIX disk labels."
14310 #: ../src/guestfs-actions.pod:4985 ../fish/guestfish-actions.pod:3344
14311 msgid "B<amiga> | B<rdb>"
14315 #: ../src/guestfs-actions.pod:4987 ../fish/guestfish-actions.pod:3346
14316 msgid "Amiga \"Rigid Disk Block\" format."
14320 #: ../src/guestfs-actions.pod:4989 ../fish/guestfish-actions.pod:3348
14325 #: ../src/guestfs-actions.pod:4991 ../fish/guestfish-actions.pod:3350
14326 msgid "BSD disk labels."
14330 #: ../src/guestfs-actions.pod:4993 ../fish/guestfish-actions.pod:3352
14335 #: ../src/guestfs-actions.pod:4995 ../fish/guestfish-actions.pod:3354
14336 msgid "DASD, used on IBM mainframes."
14340 #: ../src/guestfs-actions.pod:4997 ../fish/guestfish-actions.pod:3356
14345 #: ../src/guestfs-actions.pod:4999 ../fish/guestfish-actions.pod:3358
14346 msgid "MIPS/SGI volumes."
14350 #: ../src/guestfs-actions.pod:5001 ../fish/guestfish-actions.pod:3360
14355 #: ../src/guestfs-actions.pod:5003 ../fish/guestfish-actions.pod:3362
14356 msgid "Old Mac partition format. Modern Macs use C<gpt>."
14360 #: ../src/guestfs-actions.pod:5005 ../fish/guestfish-actions.pod:3364
14365 #: ../src/guestfs-actions.pod:5007 ../fish/guestfish-actions.pod:3366
14366 msgid "NEC PC-98 format, common in Japan apparently."
14370 #: ../src/guestfs-actions.pod:5009 ../fish/guestfish-actions.pod:3368
14375 #: ../src/guestfs-actions.pod:5011 ../fish/guestfish-actions.pod:3370
14376 msgid "Sun disk labels."
14380 #: ../src/guestfs-actions.pod:5019
14381 msgid "guestfs_part_list"
14385 #: ../src/guestfs-actions.pod:5021
14388 " struct guestfs_partition_list *\n"
14389 " guestfs_part_list (guestfs_h *g,\n"
14390 " const char *device);\n"
14395 #: ../src/guestfs-actions.pod:5025 ../fish/guestfish-actions.pod:3378
14397 "This command parses the partition table on C<device> and returns the list of "
14398 "partitions found."
14402 #: ../src/guestfs-actions.pod:5028 ../fish/guestfish-actions.pod:3381
14403 msgid "The fields in the returned structure are:"
14407 #: ../src/guestfs-actions.pod:5032 ../fish/guestfish-actions.pod:3385
14408 msgid "B<part_num>"
14412 #: ../src/guestfs-actions.pod:5034 ../fish/guestfish-actions.pod:3387
14413 msgid "Partition number, counting from 1."
14417 #: ../src/guestfs-actions.pod:5036 ../fish/guestfish-actions.pod:3389
14418 msgid "B<part_start>"
14422 #: ../src/guestfs-actions.pod:5038
14424 "Start of the partition I<in bytes>. To get sectors you have to divide by "
14425 "the device's sector size, see C<guestfs_blockdev_getss>."
14429 #: ../src/guestfs-actions.pod:5041 ../fish/guestfish-actions.pod:3394
14430 msgid "B<part_end>"
14434 #: ../src/guestfs-actions.pod:5043 ../fish/guestfish-actions.pod:3396
14435 msgid "End of the partition in bytes."
14439 #: ../src/guestfs-actions.pod:5045 ../fish/guestfish-actions.pod:3398
14440 msgid "B<part_size>"
14444 #: ../src/guestfs-actions.pod:5047 ../fish/guestfish-actions.pod:3400
14445 msgid "Size of the partition in bytes."
14449 #: ../src/guestfs-actions.pod:5051
14451 "This function returns a C<struct guestfs_partition_list *>, or NULL if there "
14452 "was an error. I<The caller must call C<guestfs_free_partition_list> after "
14457 #: ../src/guestfs-actions.pod:5057
14458 msgid "guestfs_part_set_bootable"
14462 #: ../src/guestfs-actions.pod:5059
14466 " guestfs_part_set_bootable (guestfs_h *g,\n"
14467 " const char *device,\n"
14469 " int bootable);\n"
14474 #: ../src/guestfs-actions.pod:5065 ../fish/guestfish-actions.pod:3408
14476 "This sets the bootable flag on partition numbered C<partnum> on device "
14477 "C<device>. Note that partitions are numbered from 1."
14481 #: ../src/guestfs-actions.pod:5068 ../fish/guestfish-actions.pod:3411
14483 "The bootable flag is used by some operating systems (notably Windows) to "
14484 "determine which partition to boot from. It is by no means universally "
14489 #: ../src/guestfs-actions.pod:5076
14490 msgid "guestfs_part_set_mbr_id"
14494 #: ../src/guestfs-actions.pod:5078
14498 " guestfs_part_set_mbr_id (guestfs_h *g,\n"
14499 " const char *device,\n"
14506 #: ../src/guestfs-actions.pod:5084 ../fish/guestfish-actions.pod:3419
14508 "Sets the MBR type byte (also known as the ID byte) of the numbered partition "
14509 "C<partnum> to C<idbyte>. Note that the type bytes quoted in most "
14510 "documentation are in fact hexadecimal numbers, but usually documented "
14511 "without any leading \"0x\" which might be confusing."
14515 #: ../src/guestfs-actions.pod:5098
14516 msgid "guestfs_part_set_name"
14520 #: ../src/guestfs-actions.pod:5100
14524 " guestfs_part_set_name (guestfs_h *g,\n"
14525 " const char *device,\n"
14527 " const char *name);\n"
14532 #: ../src/guestfs-actions.pod:5106 ../fish/guestfish-actions.pod:3433
14534 "This sets the partition name on partition numbered C<partnum> on device "
14535 "C<device>. Note that partitions are numbered from 1."
14539 #: ../src/guestfs-actions.pod:5109 ../fish/guestfish-actions.pod:3436
14541 "The partition name can only be set on certain types of partition table. "
14542 "This works on C<gpt> but not on C<mbr> partitions."
14546 #: ../src/guestfs-actions.pod:5116
14547 msgid "guestfs_part_to_dev"
14551 #: ../src/guestfs-actions.pod:5118
14555 " guestfs_part_to_dev (guestfs_h *g,\n"
14556 " const char *partition);\n"
14561 #: ../src/guestfs-actions.pod:5122 ../fish/guestfish-actions.pod:3443
14563 "This function takes a partition name (eg. \"/dev/sdb1\") and removes the "
14564 "partition number, returning the device name (eg. \"/dev/sdb\")."
14568 #: ../src/guestfs-actions.pod:5126
14570 "The named partition must exist, for example as a string returned from "
14571 "C<guestfs_list_partitions>."
14575 #: ../src/guestfs-actions.pod:5134
14576 msgid "guestfs_ping_daemon"
14580 #: ../src/guestfs-actions.pod:5136
14584 " guestfs_ping_daemon (guestfs_h *g);\n"
14589 #: ../src/guestfs-actions.pod:5139 ../fish/guestfish-actions.pod:3454
14591 "This is a test probe into the guestfs daemon running inside the qemu "
14592 "subprocess. Calling this function checks that the daemon responds to the "
14593 "ping message, without affecting the daemon or attached block device(s) in "
14598 #: ../src/guestfs-actions.pod:5148
14599 msgid "guestfs_pread"
14603 #: ../src/guestfs-actions.pod:5150
14607 " guestfs_pread (guestfs_h *g,\n"
14608 " const char *path,\n"
14610 " int64_t offset,\n"
14611 " size_t *size_r);\n"
14616 #: ../src/guestfs-actions.pod:5157 ../fish/guestfish-actions.pod:3463
14618 "This command lets you read part of a file. It reads C<count> bytes of the "
14619 "file, starting at C<offset>, from file C<path>."
14623 #: ../src/guestfs-actions.pod:5160 ../src/guestfs-actions.pod:5186
14624 #: ../fish/guestfish-actions.pod:3466 ../fish/guestfish-actions.pod:3481
14626 "This may read fewer bytes than requested. For further details see the "
14627 "L<pread(2)> system call."
14631 #: ../src/guestfs-actions.pod:5163
14632 msgid "See also C<guestfs_pwrite>, C<guestfs_pread_device>."
14636 #: ../src/guestfs-actions.pod:5174
14637 msgid "guestfs_pread_device"
14641 #: ../src/guestfs-actions.pod:5176
14645 " guestfs_pread_device (guestfs_h *g,\n"
14646 " const char *device,\n"
14648 " int64_t offset,\n"
14649 " size_t *size_r);\n"
14654 #: ../src/guestfs-actions.pod:5183 ../fish/guestfish-actions.pod:3478
14656 "This command lets you read part of a file. It reads C<count> bytes of "
14657 "C<device>, starting at C<offset>."
14661 #: ../src/guestfs-actions.pod:5189
14662 msgid "See also C<guestfs_pread>."
14666 #: ../src/guestfs-actions.pod:5198
14667 msgid "(Added in 1.5.21)"
14671 #: ../src/guestfs-actions.pod:5200
14672 msgid "guestfs_pvcreate"
14676 #: ../src/guestfs-actions.pod:5202
14680 " guestfs_pvcreate (guestfs_h *g,\n"
14681 " const char *device);\n"
14686 #: ../src/guestfs-actions.pod:5206 ../fish/guestfish-actions.pod:3493
14688 "This creates an LVM physical volume on the named C<device>, where C<device> "
14689 "should usually be a partition name such as C</dev/sda1>."
14693 #: ../src/guestfs-actions.pod:5214
14694 msgid "guestfs_pvremove"
14698 #: ../src/guestfs-actions.pod:5216
14702 " guestfs_pvremove (guestfs_h *g,\n"
14703 " const char *device);\n"
14708 #: ../src/guestfs-actions.pod:5220 ../fish/guestfish-actions.pod:3501
14710 "This wipes a physical volume C<device> so that LVM will no longer recognise "
14715 #: ../src/guestfs-actions.pod:5223 ../fish/guestfish-actions.pod:3504
14717 "The implementation uses the C<pvremove> command which refuses to wipe "
14718 "physical volumes that contain any volume groups, so you have to remove those "
14723 #: ../src/guestfs-actions.pod:5231
14724 msgid "guestfs_pvresize"
14728 #: ../src/guestfs-actions.pod:5233
14732 " guestfs_pvresize (guestfs_h *g,\n"
14733 " const char *device);\n"
14738 #: ../src/guestfs-actions.pod:5237 ../fish/guestfish-actions.pod:3512
14740 "This resizes (expands or shrinks) an existing LVM physical volume to match "
14741 "the new size of the underlying device."
14745 #: ../src/guestfs-actions.pod:5244
14746 msgid "guestfs_pvresize_size"
14750 #: ../src/guestfs-actions.pod:5246
14754 " guestfs_pvresize_size (guestfs_h *g,\n"
14755 " const char *device,\n"
14756 " int64_t size);\n"
14761 #: ../src/guestfs-actions.pod:5251
14763 "This command is the same as C<guestfs_pvresize> except that it allows you to "
14764 "specify the new size (in bytes) explicitly."
14768 #: ../src/guestfs-actions.pod:5258
14769 msgid "guestfs_pvs"
14773 #: ../src/guestfs-actions.pod:5260
14777 " guestfs_pvs (guestfs_h *g);\n"
14782 #: ../src/guestfs-actions.pod:5263 ../fish/guestfish-actions.pod:3526
14784 "List all the physical volumes detected. This is the equivalent of the L<pvs"
14789 #: ../src/guestfs-actions.pod:5266 ../fish/guestfish-actions.pod:3529
14791 "This returns a list of just the device names that contain PVs (eg. C</dev/"
14796 #: ../src/guestfs-actions.pod:5269
14797 msgid "See also C<guestfs_pvs_full>."
14801 #: ../src/guestfs-actions.pod:5277
14802 msgid "guestfs_pvs_full"
14806 #: ../src/guestfs-actions.pod:5279
14809 " struct guestfs_lvm_pv_list *\n"
14810 " guestfs_pvs_full (guestfs_h *g);\n"
14815 #: ../src/guestfs-actions.pod:5282 ../fish/guestfish-actions.pod:3538
14817 "List all the physical volumes detected. This is the equivalent of the L<pvs"
14818 "(8)> command. The \"full\" version includes all fields."
14822 #: ../src/guestfs-actions.pod:5285
14824 "This function returns a C<struct guestfs_lvm_pv_list *>, or NULL if there "
14825 "was an error. I<The caller must call C<guestfs_free_lvm_pv_list> after use>."
14829 #: ../src/guestfs-actions.pod:5291
14830 msgid "guestfs_pvuuid"
14834 #: ../src/guestfs-actions.pod:5293
14838 " guestfs_pvuuid (guestfs_h *g,\n"
14839 " const char *device);\n"
14844 #: ../src/guestfs-actions.pod:5297 ../fish/guestfish-actions.pod:3545
14845 msgid "This command returns the UUID of the LVM PV C<device>."
14849 #: ../src/guestfs-actions.pod:5304
14850 msgid "guestfs_pwrite"
14854 #: ../src/guestfs-actions.pod:5306
14858 " guestfs_pwrite (guestfs_h *g,\n"
14859 " const char *path,\n"
14860 " const char *content,\n"
14861 " size_t content_size,\n"
14862 " int64_t offset);\n"
14867 #: ../src/guestfs-actions.pod:5313 ../fish/guestfish-actions.pod:3551
14869 "This command writes to part of a file. It writes the data buffer C<content> "
14870 "to the file C<path> starting at offset C<offset>."
14874 #: ../src/guestfs-actions.pod:5316 ../fish/guestfish-actions.pod:3554
14876 "This command implements the L<pwrite(2)> system call, and like that system "
14877 "call it may not write the full data requested. The return value is the "
14878 "number of bytes that were actually written to the file. This could even be "
14879 "0, although short writes are unlikely for regular files in ordinary "
14884 #: ../src/guestfs-actions.pod:5322
14885 msgid "See also C<guestfs_pread>, C<guestfs_pwrite_device>."
14889 #: ../src/guestfs-actions.pod:5331
14890 msgid "guestfs_pwrite_device"
14894 #: ../src/guestfs-actions.pod:5333
14898 " guestfs_pwrite_device (guestfs_h *g,\n"
14899 " const char *device,\n"
14900 " const char *content,\n"
14901 " size_t content_size,\n"
14902 " int64_t offset);\n"
14907 #: ../src/guestfs-actions.pod:5340 ../fish/guestfish-actions.pod:3569
14909 "This command writes to part of a device. It writes the data buffer "
14910 "C<content> to C<device> starting at offset C<offset>."
14914 #: ../src/guestfs-actions.pod:5343 ../fish/guestfish-actions.pod:3572
14916 "This command implements the L<pwrite(2)> system call, and like that system "
14917 "call it may not write the full data requested (although short writes to disk "
14918 "devices and partitions are probably impossible with standard Linux kernels)."
14922 #: ../src/guestfs-actions.pod:5348
14923 msgid "See also C<guestfs_pwrite>."
14927 #: ../src/guestfs-actions.pod:5355
14928 msgid "(Added in 1.5.20)"
14932 #: ../src/guestfs-actions.pod:5357
14933 msgid "guestfs_read_file"
14937 #: ../src/guestfs-actions.pod:5359
14941 " guestfs_read_file (guestfs_h *g,\n"
14942 " const char *path,\n"
14943 " size_t *size_r);\n"
14948 #: ../src/guestfs-actions.pod:5364 ../fish/guestfish-actions.pod:3586
14949 msgid "This calls returns the contents of the file C<path> as a buffer."
14953 #: ../src/guestfs-actions.pod:5367
14955 "Unlike C<guestfs_cat>, this function can correctly handle files that contain "
14956 "embedded ASCII NUL characters. However unlike C<guestfs_download>, this "
14957 "function is limited in the total size of file that can be handled."
14961 #: ../src/guestfs-actions.pod:5379
14962 msgid "(Added in 1.0.63)"
14966 #: ../src/guestfs-actions.pod:5381
14967 msgid "guestfs_read_lines"
14971 #: ../src/guestfs-actions.pod:5383
14975 " guestfs_read_lines (guestfs_h *g,\n"
14976 " const char *path);\n"
14981 #: ../src/guestfs-actions.pod:5389 ../fish/guestfish-actions.pod:3603
14983 "The file contents are returned as a list of lines. Trailing C<LF> and "
14984 "C<CRLF> character sequences are I<not> returned."
14988 #: ../src/guestfs-actions.pod:5392
14990 "Note that this function cannot correctly handle binary files (specifically, "
14991 "files containing C<\\0> character which is treated as end of line). For "
14992 "those you need to use the C<guestfs_read_file> function which has a more "
14993 "complex interface."
14997 #: ../src/guestfs-actions.pod:5403
14998 msgid "guestfs_readdir"
15002 #: ../src/guestfs-actions.pod:5405
15005 " struct guestfs_dirent_list *\n"
15006 " guestfs_readdir (guestfs_h *g,\n"
15007 " const char *dir);\n"
15012 #: ../src/guestfs-actions.pod:5409 ../fish/guestfish-actions.pod:3615
15013 msgid "This returns the list of directory entries in directory C<dir>."
15017 #: ../src/guestfs-actions.pod:5411 ../fish/guestfish-actions.pod:3617
15019 "All entries in the directory are returned, including C<.> and C<..>. The "
15020 "entries are I<not> sorted, but returned in the same order as the underlying "
15025 #: ../src/guestfs-actions.pod:5415 ../fish/guestfish-actions.pod:3621
15027 "Also this call returns basic file type information about each file. The "
15028 "C<ftyp> field will contain one of the following characters:"
15032 #: ../src/guestfs-actions.pod:5420 ../fish/guestfish-actions.pod:3626
15037 #: ../src/guestfs-actions.pod:5422 ../fish/guestfish-actions.pod:3628
15038 msgid "Block special"
15042 #: ../src/guestfs-actions.pod:5424 ../fish/guestfish-actions.pod:3630
15047 #: ../src/guestfs-actions.pod:5426 ../fish/guestfish-actions.pod:3632
15048 msgid "Char special"
15052 #: ../src/guestfs-actions.pod:5428 ../fish/guestfish-actions.pod:3634
15057 #: ../src/guestfs-actions.pod:5430 ../fish/guestfish-actions.pod:3636
15062 #: ../src/guestfs-actions.pod:5432 ../fish/guestfish-actions.pod:3638
15067 #: ../src/guestfs-actions.pod:5434 ../fish/guestfish-actions.pod:3640
15068 msgid "FIFO (named pipe)"
15072 #: ../src/guestfs-actions.pod:5436 ../fish/guestfish-actions.pod:3642
15077 #: ../src/guestfs-actions.pod:5438 ../fish/guestfish-actions.pod:3644
15078 msgid "Symbolic link"
15082 #: ../src/guestfs-actions.pod:5440 ../fish/guestfish-actions.pod:3646
15087 #: ../src/guestfs-actions.pod:5442 ../fish/guestfish-actions.pod:3648
15088 msgid "Regular file"
15092 #: ../src/guestfs-actions.pod:5444 ../fish/guestfish-actions.pod:3650
15097 #: ../src/guestfs-actions.pod:5446 ../fish/guestfish-actions.pod:3652
15102 #: ../src/guestfs-actions.pod:5448 ../fish/guestfish-actions.pod:3654
15107 #: ../src/guestfs-actions.pod:5450 ../fish/guestfish-actions.pod:3656
15108 msgid "Unknown file type"
15112 #: ../src/guestfs-actions.pod:5452 ../fish/guestfish-actions.pod:3658
15117 #: ../src/guestfs-actions.pod:5454 ../fish/guestfish-actions.pod:3660
15119 "The L<readdir(3)> call returned a C<d_type> field with an unexpected value"
15123 #: ../src/guestfs-actions.pod:5459
15125 "This function is primarily intended for use by programs. To get a simple "
15126 "list of names, use C<guestfs_ls>. To get a printable directory for human "
15127 "consumption, use C<guestfs_ll>."
15131 #: ../src/guestfs-actions.pod:5463
15133 "This function returns a C<struct guestfs_dirent_list *>, or NULL if there "
15134 "was an error. I<The caller must call C<guestfs_free_dirent_list> after use>."
15138 #: ../src/guestfs-actions.pod:5469
15139 msgid "guestfs_readlink"
15143 #: ../src/guestfs-actions.pod:5471
15147 " guestfs_readlink (guestfs_h *g,\n"
15148 " const char *path);\n"
15153 #: ../src/guestfs-actions.pod:5475 ../fish/guestfish-actions.pod:3673
15154 msgid "This command reads the target of a symbolic link."
15158 #: ../src/guestfs-actions.pod:5482
15159 msgid "guestfs_readlinklist"
15163 #: ../src/guestfs-actions.pod:5484
15167 " guestfs_readlinklist (guestfs_h *g,\n"
15168 " const char *path,\n"
15169 " char *const *names);\n"
15174 #: ../src/guestfs-actions.pod:5489 ../fish/guestfish-actions.pod:3679
15176 "This call allows you to do a C<readlink> operation on multiple files, where "
15177 "all files are in the directory C<path>. C<names> is the list of files from "
15182 #: ../src/guestfs-actions.pod:5493 ../fish/guestfish-actions.pod:3683
15184 "On return you get a list of strings, with a one-to-one correspondence to the "
15185 "C<names> list. Each string is the value of the symbolic link."
15189 #: ../src/guestfs-actions.pod:5497 ../fish/guestfish-actions.pod:3687
15191 "If the C<readlink(2)> operation fails on any name, then the corresponding "
15192 "result string is the empty string C<\"\">. However the whole operation is "
15193 "completed even if there were C<readlink(2)> errors, and so you can call this "
15194 "function with names where you don't know if they are symbolic links already "
15195 "(albeit slightly less efficient)."
15199 #: ../src/guestfs-actions.pod:5504 ../fish/guestfish-actions.pod:3694
15201 "This call is intended for programs that want to efficiently list a directory "
15202 "contents without making many round-trips. Very long directory listings "
15203 "might cause the protocol message size to be exceeded, causing this call to "
15204 "fail. The caller must split up such requests into smaller groups of names."
15208 #: ../src/guestfs-actions.pod:5517
15209 msgid "guestfs_realpath"
15213 #: ../src/guestfs-actions.pod:5519
15217 " guestfs_realpath (guestfs_h *g,\n"
15218 " const char *path);\n"
15223 #: ../src/guestfs-actions.pod:5523 ../fish/guestfish-actions.pod:3705
15225 "Return the canonicalized absolute pathname of C<path>. The returned path "
15226 "has no C<.>, C<..> or symbolic link path elements."
15230 #: ../src/guestfs-actions.pod:5531
15231 msgid "guestfs_removexattr"
15235 #: ../src/guestfs-actions.pod:5533
15239 " guestfs_removexattr (guestfs_h *g,\n"
15240 " const char *xattr,\n"
15241 " const char *path);\n"
15246 #: ../src/guestfs-actions.pod:5538 ../fish/guestfish-actions.pod:3712
15248 "This call removes the extended attribute named C<xattr> of the file C<path>."
15252 #: ../src/guestfs-actions.pod:5541
15253 msgid "See also: C<guestfs_lremovexattr>, L<attr(5)>."
15257 #: ../src/guestfs-actions.pod:5547
15258 msgid "guestfs_resize2fs"
15262 #: ../src/guestfs-actions.pod:5549
15266 " guestfs_resize2fs (guestfs_h *g,\n"
15267 " const char *device);\n"
15272 #: ../src/guestfs-actions.pod:5553 ../fish/guestfish-actions.pod:3721
15274 "This resizes an ext2, ext3 or ext4 filesystem to match the size of the "
15275 "underlying device."
15279 #: ../src/guestfs-actions.pod:5556
15281 "I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f> on the "
15282 "C<device> before calling this command. For unknown reasons C<resize2fs> "
15283 "sometimes gives an error about this and sometimes not. In any case, it is "
15284 "always safe to call C<guestfs_e2fsck_f> before calling this function."
15288 #: ../src/guestfs-actions.pod:5566
15289 msgid "guestfs_resize2fs_M"
15293 #: ../src/guestfs-actions.pod:5568
15297 " guestfs_resize2fs_M (guestfs_h *g,\n"
15298 " const char *device);\n"
15303 #: ../src/guestfs-actions.pod:5572
15305 "This command is the same as C<guestfs_resize2fs>, but the filesystem is "
15306 "resized to its minimum size. This works like the C<-M> option to the "
15307 "C<resize2fs> command."
15311 #: ../src/guestfs-actions.pod:5576
15313 "To get the resulting size of the filesystem you should call "
15314 "C<guestfs_tune2fs_l> and read the C<Block size> and C<Block count> values. "
15315 "These two numbers, multiplied together, give the resulting size of the "
15316 "minimal filesystem in bytes."
15320 #: ../src/guestfs-actions.pod:5583
15321 msgid "guestfs_resize2fs_size"
15325 #: ../src/guestfs-actions.pod:5585
15329 " guestfs_resize2fs_size (guestfs_h *g,\n"
15330 " const char *device,\n"
15331 " int64_t size);\n"
15336 #: ../src/guestfs-actions.pod:5590
15338 "This command is the same as C<guestfs_resize2fs> except that it allows you "
15339 "to specify the new size (in bytes) explicitly."
15343 #: ../src/guestfs-actions.pod:5597
15348 #: ../src/guestfs-actions.pod:5599
15352 " guestfs_rm (guestfs_h *g,\n"
15353 " const char *path);\n"
15358 #: ../src/guestfs-actions.pod:5603 ../fish/guestfish-actions.pod:3754
15359 msgid "Remove the single file C<path>."
15363 #: ../src/guestfs-actions.pod:5609
15364 msgid "guestfs_rm_rf"
15368 #: ../src/guestfs-actions.pod:5611
15372 " guestfs_rm_rf (guestfs_h *g,\n"
15373 " const char *path);\n"
15378 #: ../src/guestfs-actions.pod:5615 ../fish/guestfish-actions.pod:3760
15380 "Remove the file or directory C<path>, recursively removing the contents if "
15381 "its a directory. This is like the C<rm -rf> shell command."
15385 #: ../src/guestfs-actions.pod:5623
15386 msgid "guestfs_rmdir"
15390 #: ../src/guestfs-actions.pod:5625
15394 " guestfs_rmdir (guestfs_h *g,\n"
15395 " const char *path);\n"
15400 #: ../src/guestfs-actions.pod:5629 ../fish/guestfish-actions.pod:3768
15401 msgid "Remove the single directory C<path>."
15405 #: ../src/guestfs-actions.pod:5635
15406 msgid "guestfs_rmmountpoint"
15410 #: ../src/guestfs-actions.pod:5637
15414 " guestfs_rmmountpoint (guestfs_h *g,\n"
15415 " const char *exemptpath);\n"
15420 #: ../src/guestfs-actions.pod:5641
15422 "This calls removes a mountpoint that was previously created with "
15423 "C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint> for full details."
15427 #: ../src/guestfs-actions.pod:5649
15428 msgid "guestfs_scrub_device"
15432 #: ../src/guestfs-actions.pod:5651
15436 " guestfs_scrub_device (guestfs_h *g,\n"
15437 " const char *device);\n"
15442 #: ../src/guestfs-actions.pod:5655 ../fish/guestfish-actions.pod:3782
15444 "This command writes patterns over C<device> to make data retrieval more "
15449 #: ../src/guestfs-actions.pod:5658 ../src/guestfs-actions.pod:5679
15450 #: ../src/guestfs-actions.pod:5698 ../fish/guestfish-actions.pod:3785
15451 #: ../fish/guestfish-actions.pod:3800 ../fish/guestfish-actions.pod:3813
15453 "It is an interface to the L<scrub(1)> program. See that manual page for "
15458 #: ../src/guestfs-actions.pod:5666 ../src/guestfs-actions.pod:5684
15459 #: ../src/guestfs-actions.pod:5703
15460 msgid "(Added in 1.0.52)"
15464 #: ../src/guestfs-actions.pod:5668
15465 msgid "guestfs_scrub_file"
15469 #: ../src/guestfs-actions.pod:5670
15473 " guestfs_scrub_file (guestfs_h *g,\n"
15474 " const char *file);\n"
15479 #: ../src/guestfs-actions.pod:5674 ../fish/guestfish-actions.pod:3795
15481 "This command writes patterns over a file to make data retrieval more "
15486 #: ../src/guestfs-actions.pod:5677 ../fish/guestfish-actions.pod:3798
15487 msgid "The file is I<removed> after scrubbing."
15491 #: ../src/guestfs-actions.pod:5686
15492 msgid "guestfs_scrub_freespace"
15496 #: ../src/guestfs-actions.pod:5688
15500 " guestfs_scrub_freespace (guestfs_h *g,\n"
15501 " const char *dir);\n"
15506 #: ../src/guestfs-actions.pod:5692
15508 "This command creates the directory C<dir> and then fills it with files until "
15509 "the filesystem is full, and scrubs the files as for C<guestfs_scrub_file>, "
15510 "and deletes them. The intention is to scrub any free space on the partition "
15511 "containing C<dir>."
15515 #: ../src/guestfs-actions.pod:5705
15516 msgid "guestfs_set_append"
15520 #: ../src/guestfs-actions.pod:5707
15524 " guestfs_set_append (guestfs_h *g,\n"
15525 " const char *append);\n"
15530 #: ../src/guestfs-actions.pod:5711 ../fish/guestfish-actions.pod:3822
15532 "This function is used to add additional options to the guest kernel command "
15537 #: ../src/guestfs-actions.pod:5714 ../fish/guestfish-actions.pod:3825
15539 "The default is C<NULL> unless overridden by setting C<LIBGUESTFS_APPEND> "
15540 "environment variable."
15544 #: ../src/guestfs-actions.pod:5717 ../fish/guestfish-actions.pod:3828
15546 "Setting C<append> to C<NULL> means I<no> additional options are passed "
15547 "(libguestfs always adds a few of its own)."
15551 #: ../src/guestfs-actions.pod:5724
15552 msgid "guestfs_set_attach_method"
15556 #: ../src/guestfs-actions.pod:5726
15560 " guestfs_set_attach_method (guestfs_h *g,\n"
15561 " const char *attachmethod);\n"
15566 #: ../src/guestfs-actions.pod:5730 ../fish/guestfish-actions.pod:3837
15568 "Set the method that libguestfs uses to connect to the back end guestfsd "
15569 "daemon. Possible methods are:"
15573 #: ../src/guestfs-actions.pod:5737 ../fish/guestfish-actions.pod:3844
15575 "Launch an appliance and connect to it. This is the ordinary method and the "
15580 #: ../src/guestfs-actions.pod:5740 ../fish/guestfish-actions.pod:3847
15581 msgid "C<unix:I<path>>"
15585 #: ../src/guestfs-actions.pod:5742 ../fish/guestfish-actions.pod:3849
15586 msgid "Connect to the Unix domain socket I<path>."
15590 #: ../src/guestfs-actions.pod:5744 ../fish/guestfish-actions.pod:3851
15592 "This method lets you connect to an existing daemon or (using virtio-serial) "
15593 "to a live guest. For more information, see L<guestfs(3)/ATTACHING TO "
15594 "RUNNING DAEMONS>."
15598 #: ../src/guestfs-actions.pod:5752
15599 msgid "guestfs_set_autosync"
15603 #: ../src/guestfs-actions.pod:5754
15607 " guestfs_set_autosync (guestfs_h *g,\n"
15608 " int autosync);\n"
15613 #: ../src/guestfs-actions.pod:5758 ../fish/guestfish-actions.pod:3863
15615 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
15616 "effort attempt to make filesystems consistent and synchronized when the "
15617 "handle is closed (also if the program exits without closing handles)."
15621 #: ../src/guestfs-actions.pod:5763 ../fish/guestfish-actions.pod:3868
15623 "This is enabled by default (since libguestfs 1.5.24, previously it was "
15624 "disabled by default)."
15628 #: ../src/guestfs-actions.pod:5770
15629 msgid "guestfs_set_direct"
15633 #: ../src/guestfs-actions.pod:5772
15637 " guestfs_set_direct (guestfs_h *g,\n"
15643 #: ../src/guestfs-actions.pod:5776 ../fish/guestfish-actions.pod:3877
15645 "If the direct appliance mode flag is enabled, then stdin and stdout are "
15646 "passed directly through to the appliance once it is launched."
15650 #: ../src/guestfs-actions.pod:5780
15652 "One consequence of this is that log messages aren't caught by the library "
15653 "and handled by C<guestfs_set_log_message_callback>, but go straight to "
15658 #: ../src/guestfs-actions.pod:5784 ../fish/guestfish-actions.pod:3885
15659 msgid "You probably don't want to use this unless you know what you are doing."
15663 #: ../src/guestfs-actions.pod:5787 ../fish/guestfish-actions.pod:3888
15664 msgid "The default is disabled."
15668 #: ../src/guestfs-actions.pod:5793
15669 msgid "guestfs_set_e2label"
15673 #: ../src/guestfs-actions.pod:5795
15677 " guestfs_set_e2label (guestfs_h *g,\n"
15678 " const char *device,\n"
15679 " const char *label);\n"
15684 #: ../src/guestfs-actions.pod:5800 ../fish/guestfish-actions.pod:3894
15686 "This sets the ext2/3/4 filesystem label of the filesystem on C<device> to "
15687 "C<label>. Filesystem labels are limited to 16 characters."
15691 #: ../src/guestfs-actions.pod:5804
15693 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label> to return "
15694 "the existing label on a filesystem."
15698 #: ../src/guestfs-actions.pod:5811
15699 msgid "guestfs_set_e2uuid"
15703 #: ../src/guestfs-actions.pod:5813
15707 " guestfs_set_e2uuid (guestfs_h *g,\n"
15708 " const char *device,\n"
15709 " const char *uuid);\n"
15714 #: ../src/guestfs-actions.pod:5818 ../fish/guestfish-actions.pod:3905
15716 "This sets the ext2/3/4 filesystem UUID of the filesystem on C<device> to "
15717 "C<uuid>. The format of the UUID and alternatives such as C<clear>, "
15718 "C<random> and C<time> are described in the L<tune2fs(8)> manpage."
15722 #: ../src/guestfs-actions.pod:5823
15724 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid> to return "
15725 "the existing UUID of a filesystem."
15729 #: ../src/guestfs-actions.pod:5830
15730 msgid "guestfs_set_memsize"
15734 #: ../src/guestfs-actions.pod:5832
15738 " guestfs_set_memsize (guestfs_h *g,\n"
15744 #: ../src/guestfs-actions.pod:5836
15746 "This sets the memory size in megabytes allocated to the qemu subprocess. "
15747 "This only has any effect if called before C<guestfs_launch>."
15751 #: ../src/guestfs-actions.pod:5840 ../fish/guestfish-actions.pod:3923
15753 "You can also change this by setting the environment variable "
15754 "C<LIBGUESTFS_MEMSIZE> before the handle is created."
15758 #: ../src/guestfs-actions.pod:5851
15759 msgid "guestfs_set_network"
15763 #: ../src/guestfs-actions.pod:5853
15767 " guestfs_set_network (guestfs_h *g,\n"
15773 #: ../src/guestfs-actions.pod:5857 ../fish/guestfish-actions.pod:3936
15775 "If C<network> is true, then the network is enabled in the libguestfs "
15776 "appliance. The default is false."
15780 #: ../src/guestfs-actions.pod:5860 ../fish/guestfish-actions.pod:3939
15782 "This affects whether commands are able to access the network (see L<guestfs"
15783 "(3)/RUNNING COMMANDS>)."
15787 #: ../src/guestfs-actions.pod:5863
15789 "You must call this before calling C<guestfs_launch>, otherwise it has no "
15794 #: ../src/guestfs-actions.pod:5870
15795 msgid "guestfs_set_path"
15799 #: ../src/guestfs-actions.pod:5872
15803 " guestfs_set_path (guestfs_h *g,\n"
15804 " const char *searchpath);\n"
15809 #: ../src/guestfs-actions.pod:5876 ../fish/guestfish-actions.pod:3951
15810 msgid "Set the path that libguestfs searches for kernel and initrd.img."
15814 #: ../src/guestfs-actions.pod:5878 ../fish/guestfish-actions.pod:3953
15816 "The default is C<$libdir/guestfs> unless overridden by setting "
15817 "C<LIBGUESTFS_PATH> environment variable."
15821 #: ../src/guestfs-actions.pod:5881 ../fish/guestfish-actions.pod:3956
15822 msgid "Setting C<path> to C<NULL> restores the default path."
15826 #: ../src/guestfs-actions.pod:5887
15827 msgid "guestfs_set_qemu"
15831 #: ../src/guestfs-actions.pod:5889
15835 " guestfs_set_qemu (guestfs_h *g,\n"
15836 " const char *qemu);\n"
15841 #: ../src/guestfs-actions.pod:5893 ../fish/guestfish-actions.pod:3964
15842 msgid "Set the qemu binary that we will use."
15846 #: ../src/guestfs-actions.pod:5895 ../fish/guestfish-actions.pod:3966
15848 "The default is chosen when the library was compiled by the configure script."
15852 #: ../src/guestfs-actions.pod:5898 ../fish/guestfish-actions.pod:3969
15854 "You can also override this by setting the C<LIBGUESTFS_QEMU> environment "
15859 #: ../src/guestfs-actions.pod:5901 ../fish/guestfish-actions.pod:3972
15860 msgid "Setting C<qemu> to C<NULL> restores the default qemu binary."
15864 #: ../src/guestfs-actions.pod:5903 ../fish/guestfish-actions.pod:3974
15866 "Note that you should call this function as early as possible after creating "
15867 "the handle. This is because some pre-launch operations depend on testing "
15868 "qemu features (by running C<qemu -help>). If the qemu binary changes, we "
15869 "don't retest features, and so you might see inconsistent results. Using the "
15870 "environment variable C<LIBGUESTFS_QEMU> is safest of all since that picks "
15871 "the qemu binary at the same time as the handle is created."
15875 #: ../src/guestfs-actions.pod:5915
15876 msgid "guestfs_set_recovery_proc"
15880 #: ../src/guestfs-actions.pod:5917
15884 " guestfs_set_recovery_proc (guestfs_h *g,\n"
15885 " int recoveryproc);\n"
15890 #: ../src/guestfs-actions.pod:5921
15892 "If this is called with the parameter C<false> then C<guestfs_launch> does "
15893 "not create a recovery process. The purpose of the recovery process is to "
15894 "stop runaway qemu processes in the case where the main program aborts "
15899 #: ../src/guestfs-actions.pod:5926
15901 "This only has any effect if called before C<guestfs_launch>, and the default "
15906 #: ../src/guestfs-actions.pod:5929 ../fish/guestfish-actions.pod:3996
15908 "About the only time when you would want to disable this is if the main "
15909 "process will fork itself into the background (\"daemonize\" itself). In "
15910 "this case the recovery process thinks that the main program has disappeared "
15911 "and so kills qemu, which is not very helpful."
15915 #: ../src/guestfs-actions.pod:5939
15916 msgid "guestfs_set_selinux"
15920 #: ../src/guestfs-actions.pod:5941
15924 " guestfs_set_selinux (guestfs_h *g,\n"
15930 #: ../src/guestfs-actions.pod:5945 ../fish/guestfish-actions.pod:4008
15932 "This sets the selinux flag that is passed to the appliance at boot time. "
15933 "The default is C<selinux=0> (disabled)."
15937 #: ../src/guestfs-actions.pod:5948 ../fish/guestfish-actions.pod:4011
15939 "Note that if SELinux is enabled, it is always in Permissive mode "
15940 "(C<enforcing=0>)."
15944 #: ../src/guestfs-actions.pod:5958
15945 msgid "guestfs_set_trace"
15949 #: ../src/guestfs-actions.pod:5960
15953 " guestfs_set_trace (guestfs_h *g,\n"
15959 #: ../src/guestfs-actions.pod:5964 ../fish/guestfish-actions.pod:4023
15961 "If the command trace flag is set to 1, then libguestfs calls, parameters and "
15962 "return values are traced."
15966 #: ../src/guestfs-actions.pod:5967 ../fish/guestfish-actions.pod:4026
15968 "If you want to trace C API calls into libguestfs (and other libraries) then "
15969 "possibly a better way is to use the external ltrace(1) command."
15973 #: ../src/guestfs-actions.pod:5971 ../fish/guestfish-actions.pod:4030
15975 "Command traces are disabled unless the environment variable "
15976 "C<LIBGUESTFS_TRACE> is defined and set to C<1>."
15980 #: ../src/guestfs-actions.pod:5974
15982 "Trace messages are normally sent to C<stderr>, unless you register a "
15983 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
15987 #: ../src/guestfs-actions.pod:5982
15988 msgid "guestfs_set_verbose"
15992 #: ../src/guestfs-actions.pod:5984
15996 " guestfs_set_verbose (guestfs_h *g,\n"
16002 #: ../src/guestfs-actions.pod:5988 ../fish/guestfish-actions.pod:4043
16003 msgid "If C<verbose> is true, this turns on verbose messages."
16007 #: ../src/guestfs-actions.pod:5990 ../fish/guestfish-actions.pod:4045
16009 "Verbose messages are disabled unless the environment variable "
16010 "C<LIBGUESTFS_DEBUG> is defined and set to C<1>."
16014 #: ../src/guestfs-actions.pod:5993
16016 "Verbose messages are normally sent to C<stderr>, unless you register a "
16017 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
16021 #: ../src/guestfs-actions.pod:6001
16022 msgid "guestfs_setcon"
16026 #: ../src/guestfs-actions.pod:6003
16030 " guestfs_setcon (guestfs_h *g,\n"
16031 " const char *context);\n"
16036 #: ../src/guestfs-actions.pod:6007 ../fish/guestfish-actions.pod:4056
16038 "This sets the SELinux security context of the daemon to the string "
16043 #: ../src/guestfs-actions.pod:6010 ../fish/guestfish-actions.pod:4059
16044 msgid "See the documentation about SELINUX in L<guestfs(3)>."
16048 #: ../src/guestfs-actions.pod:6016
16049 msgid "guestfs_setxattr"
16053 #: ../src/guestfs-actions.pod:6018
16057 " guestfs_setxattr (guestfs_h *g,\n"
16058 " const char *xattr,\n"
16059 " const char *val,\n"
16061 " const char *path);\n"
16066 #: ../src/guestfs-actions.pod:6025 ../fish/guestfish-actions.pod:4065
16068 "This call sets the extended attribute named C<xattr> of the file C<path> to "
16069 "the value C<val> (of length C<vallen>). The value is arbitrary 8 bit data."
16073 #: ../src/guestfs-actions.pod:6029
16074 msgid "See also: C<guestfs_lsetxattr>, L<attr(5)>."
16078 #: ../src/guestfs-actions.pod:6035
16079 msgid "guestfs_sfdisk"
16083 #: ../src/guestfs-actions.pod:6037
16087 " guestfs_sfdisk (guestfs_h *g,\n"
16088 " const char *device,\n"
16092 " char *const *lines);\n"
16097 #: ../src/guestfs-actions.pod:6045 ../fish/guestfish-actions.pod:4075
16099 "This is a direct interface to the L<sfdisk(8)> program for creating "
16100 "partitions on block devices."
16104 #: ../src/guestfs-actions.pod:6048 ../fish/guestfish-actions.pod:4078
16105 msgid "C<device> should be a block device, for example C</dev/sda>."
16109 #: ../src/guestfs-actions.pod:6050 ../fish/guestfish-actions.pod:4080
16111 "C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads and "
16112 "sectors on the device, which are passed directly to sfdisk as the I<-C>, I<-"
16113 "H> and I<-S> parameters. If you pass C<0> for any of these, then the "
16114 "corresponding parameter is omitted. Usually for 'large' disks, you can just "
16115 "pass C<0> for these, but for small (floppy-sized) disks, sfdisk (or rather, "
16116 "the kernel) cannot work out the right geometry and you will need to tell it."
16120 #: ../src/guestfs-actions.pod:6058 ../fish/guestfish-actions.pod:4088
16122 "C<lines> is a list of lines that we feed to C<sfdisk>. For more information "
16123 "refer to the L<sfdisk(8)> manpage."
16127 #: ../src/guestfs-actions.pod:6061 ../fish/guestfish-actions.pod:4091
16129 "To create a single partition occupying the whole disk, you would pass "
16130 "C<lines> as a single element list, when the single element being the string "
16135 #: ../src/guestfs-actions.pod:6065
16137 "See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>, C<guestfs_part_init>"
16141 #: ../src/guestfs-actions.pod:6075
16142 msgid "guestfs_sfdiskM"
16146 #: ../src/guestfs-actions.pod:6077
16150 " guestfs_sfdiskM (guestfs_h *g,\n"
16151 " const char *device,\n"
16152 " char *const *lines);\n"
16157 #: ../src/guestfs-actions.pod:6082
16159 "This is a simplified interface to the C<guestfs_sfdisk> command, where "
16160 "partition sizes are specified in megabytes only (rounded to the nearest "
16161 "cylinder) and you don't need to specify the cyls, heads and sectors "
16162 "parameters which were rarely if ever used anyway."
16166 #: ../src/guestfs-actions.pod:6088
16168 "See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage and "
16169 "C<guestfs_part_disk>"
16173 #: ../src/guestfs-actions.pod:6098
16174 msgid "guestfs_sfdisk_N"
16178 #: ../src/guestfs-actions.pod:6100
16182 " guestfs_sfdisk_N (guestfs_h *g,\n"
16183 " const char *device,\n"
16188 " const char *line);\n"
16193 #: ../src/guestfs-actions.pod:6109 ../fish/guestfish-actions.pod:4121
16195 "This runs L<sfdisk(8)> option to modify just the single partition C<n> "
16196 "(note: C<n> counts from 1)."
16200 #: ../src/guestfs-actions.pod:6112
16202 "For other parameters, see C<guestfs_sfdisk>. You should usually pass C<0> "
16203 "for the cyls/heads/sectors parameters."
16207 #: ../src/guestfs-actions.pod:6115
16208 msgid "See also: C<guestfs_part_add>"
16212 #: ../src/guestfs-actions.pod:6124
16213 msgid "guestfs_sfdisk_disk_geometry"
16217 #: ../src/guestfs-actions.pod:6126
16221 " guestfs_sfdisk_disk_geometry (guestfs_h *g,\n"
16222 " const char *device);\n"
16227 #: ../src/guestfs-actions.pod:6130
16229 "This displays the disk geometry of C<device> read from the partition table. "
16230 "Especially in the case where the underlying block device has been resized, "
16231 "this can be different from the kernel's idea of the geometry (see "
16232 "C<guestfs_sfdisk_kernel_geometry>)."
16236 #: ../src/guestfs-actions.pod:6135 ../src/guestfs-actions.pod:6151
16237 #: ../fish/guestfish-actions.pod:4141 ../fish/guestfish-actions.pod:4150
16238 msgid "The result is in human-readable format, and not designed to be parsed."
16242 #: ../src/guestfs-actions.pod:6143
16243 msgid "guestfs_sfdisk_kernel_geometry"
16247 #: ../src/guestfs-actions.pod:6145
16251 " guestfs_sfdisk_kernel_geometry (guestfs_h *g,\n"
16252 " const char *device);\n"
16257 #: ../src/guestfs-actions.pod:6149 ../fish/guestfish-actions.pod:4148
16258 msgid "This displays the kernel's idea of the geometry of C<device>."
16262 #: ../src/guestfs-actions.pod:6159
16263 msgid "guestfs_sfdisk_l"
16267 #: ../src/guestfs-actions.pod:6161
16271 " guestfs_sfdisk_l (guestfs_h *g,\n"
16272 " const char *device);\n"
16277 #: ../src/guestfs-actions.pod:6165 ../fish/guestfish-actions.pod:4157
16279 "This displays the partition table on C<device>, in the human-readable output "
16280 "of the L<sfdisk(8)> command. It is not intended to be parsed."
16284 #: ../src/guestfs-actions.pod:6169
16285 msgid "See also: C<guestfs_part_list>"
16289 #: ../src/guestfs-actions.pod:6176
16294 #: ../src/guestfs-actions.pod:6178
16298 " guestfs_sh (guestfs_h *g,\n"
16299 " const char *command);\n"
16304 #: ../src/guestfs-actions.pod:6182 ../fish/guestfish-actions.pod:4167
16306 "This call runs a command from the guest filesystem via the guest's C</bin/"
16311 #: ../src/guestfs-actions.pod:6185
16312 msgid "This is like C<guestfs_command>, but passes the command to:"
16316 #: ../src/guestfs-actions.pod:6187 ../fish/guestfish-actions.pod:4172
16319 " /bin/sh -c \"command\"\n"
16324 #: ../src/guestfs-actions.pod:6189 ../fish/guestfish-actions.pod:4174
16326 "Depending on the guest's shell, this usually results in wildcards being "
16327 "expanded, shell expressions being interpolated and so on."
16331 #: ../src/guestfs-actions.pod:6193
16332 msgid "All the provisos about C<guestfs_command> apply to this call."
16336 #: ../src/guestfs-actions.pod:6200
16337 msgid "guestfs_sh_lines"
16341 #: ../src/guestfs-actions.pod:6202
16345 " guestfs_sh_lines (guestfs_h *g,\n"
16346 " const char *command);\n"
16351 #: ../src/guestfs-actions.pod:6206
16353 "This is the same as C<guestfs_sh>, but splits the result into a list of "
16358 #: ../src/guestfs-actions.pod:6209
16359 msgid "See also: C<guestfs_command_lines>"
16363 #: ../src/guestfs-actions.pod:6217
16364 msgid "guestfs_sleep"
16368 #: ../src/guestfs-actions.pod:6219
16372 " guestfs_sleep (guestfs_h *g,\n"
16378 #: ../src/guestfs-actions.pod:6223 ../fish/guestfish-actions.pod:4193
16379 msgid "Sleep for C<secs> seconds."
16383 #: ../src/guestfs-actions.pod:6227
16384 msgid "(Added in 1.0.41)"
16388 #: ../src/guestfs-actions.pod:6229 ../src/guestfs-structs.pod:109
16389 msgid "guestfs_stat"
16393 #: ../src/guestfs-actions.pod:6231
16396 " struct guestfs_stat *\n"
16397 " guestfs_stat (guestfs_h *g,\n"
16398 " const char *path);\n"
16403 #: ../src/guestfs-actions.pod:6237 ../fish/guestfish-actions.pod:4201
16404 msgid "This is the same as the C<stat(2)> system call."
16408 #: ../src/guestfs-actions.pod:6245 ../src/guestfs-structs.pod:135
16409 msgid "guestfs_statvfs"
16413 #: ../src/guestfs-actions.pod:6247
16416 " struct guestfs_statvfs *\n"
16417 " guestfs_statvfs (guestfs_h *g,\n"
16418 " const char *path);\n"
16423 #: ../src/guestfs-actions.pod:6251 ../fish/guestfish-actions.pod:4207
16425 "Returns file system statistics for any mounted file system. C<path> should "
16426 "be a file or directory in the mounted file system (typically it is the mount "
16427 "point itself, but it doesn't need to be)."
16431 #: ../src/guestfs-actions.pod:6255 ../fish/guestfish-actions.pod:4211
16432 msgid "This is the same as the C<statvfs(2)> system call."
16436 #: ../src/guestfs-actions.pod:6257
16438 "This function returns a C<struct guestfs_statvfs *>, or NULL if there was an "
16439 "error. I<The caller must call C<guestfs_free_statvfs> after use>."
16443 #: ../src/guestfs-actions.pod:6263
16444 msgid "guestfs_strings"
16448 #: ../src/guestfs-actions.pod:6265
16452 " guestfs_strings (guestfs_h *g,\n"
16453 " const char *path);\n"
16458 #: ../src/guestfs-actions.pod:6269 ../fish/guestfish-actions.pod:4217
16460 "This runs the L<strings(1)> command on a file and returns the list of "
16461 "printable strings found."
16465 #: ../src/guestfs-actions.pod:6281
16466 msgid "guestfs_strings_e"
16470 #: ../src/guestfs-actions.pod:6283
16474 " guestfs_strings_e (guestfs_h *g,\n"
16475 " const char *encoding,\n"
16476 " const char *path);\n"
16481 #: ../src/guestfs-actions.pod:6288
16483 "This is like the C<guestfs_strings> command, but allows you to specify the "
16484 "encoding of strings that are looked for in the source file C<path>."
16488 #: ../src/guestfs-actions.pod:6292 ../fish/guestfish-actions.pod:4231
16489 msgid "Allowed encodings are:"
16493 #: ../src/guestfs-actions.pod:6296 ../fish/guestfish-actions.pod:4235
16498 #: ../src/guestfs-actions.pod:6298
16500 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
16501 "ISO-8859-X (this is what C<guestfs_strings> uses)."
16505 #: ../src/guestfs-actions.pod:6301 ../fish/guestfish-actions.pod:4240
16510 #: ../src/guestfs-actions.pod:6303 ../fish/guestfish-actions.pod:4242
16511 msgid "Single 8-bit-byte characters."
16515 #: ../src/guestfs-actions.pod:6305 ../fish/guestfish-actions.pod:4244
16520 #: ../src/guestfs-actions.pod:6307 ../fish/guestfish-actions.pod:4246
16521 msgid "16-bit big endian strings such as those encoded in UTF-16BE or UCS-2BE."
16525 #: ../src/guestfs-actions.pod:6310 ../fish/guestfish-actions.pod:4249
16526 msgid "l (lower case letter L)"
16530 #: ../src/guestfs-actions.pod:6312 ../fish/guestfish-actions.pod:4251
16532 "16-bit little endian such as UTF-16LE and UCS-2LE. This is useful for "
16533 "examining binaries in Windows guests."
16537 #: ../src/guestfs-actions.pod:6315 ../fish/guestfish-actions.pod:4254
16542 #: ../src/guestfs-actions.pod:6317 ../fish/guestfish-actions.pod:4256
16543 msgid "32-bit big endian such as UCS-4BE."
16547 #: ../src/guestfs-actions.pod:6319 ../fish/guestfish-actions.pod:4258
16552 #: ../src/guestfs-actions.pod:6321 ../fish/guestfish-actions.pod:4260
16553 msgid "32-bit little endian such as UCS-4LE."
16557 #: ../src/guestfs-actions.pod:6325 ../fish/guestfish-actions.pod:4264
16558 msgid "The returned strings are transcoded to UTF-8."
16562 #: ../src/guestfs-actions.pod:6336
16563 msgid "guestfs_swapoff_device"
16567 #: ../src/guestfs-actions.pod:6338
16571 " guestfs_swapoff_device (guestfs_h *g,\n"
16572 " const char *device);\n"
16577 #: ../src/guestfs-actions.pod:6342
16579 "This command disables the libguestfs appliance swap device or partition "
16580 "named C<device>. See C<guestfs_swapon_device>."
16584 #: ../src/guestfs-actions.pod:6350
16585 msgid "guestfs_swapoff_file"
16589 #: ../src/guestfs-actions.pod:6352
16593 " guestfs_swapoff_file (guestfs_h *g,\n"
16594 " const char *file);\n"
16599 #: ../src/guestfs-actions.pod:6356 ../fish/guestfish-actions.pod:4281
16600 msgid "This command disables the libguestfs appliance swap on file."
16604 #: ../src/guestfs-actions.pod:6362
16605 msgid "guestfs_swapoff_label"
16609 #: ../src/guestfs-actions.pod:6364
16613 " guestfs_swapoff_label (guestfs_h *g,\n"
16614 " const char *label);\n"
16619 #: ../src/guestfs-actions.pod:6368 ../fish/guestfish-actions.pod:4287
16621 "This command disables the libguestfs appliance swap on labeled swap "
16626 #: ../src/guestfs-actions.pod:6375
16627 msgid "guestfs_swapoff_uuid"
16631 #: ../src/guestfs-actions.pod:6377
16635 " guestfs_swapoff_uuid (guestfs_h *g,\n"
16636 " const char *uuid);\n"
16641 #: ../src/guestfs-actions.pod:6381 ../fish/guestfish-actions.pod:4294
16643 "This command disables the libguestfs appliance swap partition with the given "
16648 #: ../src/guestfs-actions.pod:6388
16649 msgid "guestfs_swapon_device"
16653 #: ../src/guestfs-actions.pod:6390
16657 " guestfs_swapon_device (guestfs_h *g,\n"
16658 " const char *device);\n"
16663 #: ../src/guestfs-actions.pod:6394
16665 "This command enables the libguestfs appliance to use the swap device or "
16666 "partition named C<device>. The increased memory is made available for all "
16667 "commands, for example those run using C<guestfs_command> or C<guestfs_sh>."
16671 #: ../src/guestfs-actions.pod:6399 ../fish/guestfish-actions.pod:4306
16673 "Note that you should not swap to existing guest swap partitions unless you "
16674 "know what you are doing. They may contain hibernation information, or other "
16675 "information that the guest doesn't want you to trash. You also risk leaking "
16676 "information about the host to the guest this way. Instead, attach a new "
16677 "host device to the guest and swap on that."
16681 #: ../src/guestfs-actions.pod:6410
16682 msgid "guestfs_swapon_file"
16686 #: ../src/guestfs-actions.pod:6412
16690 " guestfs_swapon_file (guestfs_h *g,\n"
16691 " const char *file);\n"
16696 #: ../src/guestfs-actions.pod:6416
16698 "This command enables swap to a file. See C<guestfs_swapon_device> for other "
16703 #: ../src/guestfs-actions.pod:6423
16704 msgid "guestfs_swapon_label"
16708 #: ../src/guestfs-actions.pod:6425
16712 " guestfs_swapon_label (guestfs_h *g,\n"
16713 " const char *label);\n"
16718 #: ../src/guestfs-actions.pod:6429
16720 "This command enables swap to a labeled swap partition. See "
16721 "C<guestfs_swapon_device> for other notes."
16725 #: ../src/guestfs-actions.pod:6436
16726 msgid "guestfs_swapon_uuid"
16730 #: ../src/guestfs-actions.pod:6438
16734 " guestfs_swapon_uuid (guestfs_h *g,\n"
16735 " const char *uuid);\n"
16740 #: ../src/guestfs-actions.pod:6442
16742 "This command enables swap to a swap partition with the given UUID. See "
16743 "C<guestfs_swapon_device> for other notes."
16747 #: ../src/guestfs-actions.pod:6449
16748 msgid "guestfs_sync"
16752 #: ../src/guestfs-actions.pod:6451
16756 " guestfs_sync (guestfs_h *g);\n"
16761 #: ../src/guestfs-actions.pod:6454 ../fish/guestfish-actions.pod:4338
16763 "This syncs the disk, so that any writes are flushed through to the "
16764 "underlying disk image."
16768 #: ../src/guestfs-actions.pod:6457 ../fish/guestfish-actions.pod:4341
16770 "You should always call this if you have modified a disk image, before "
16771 "closing the handle."
16775 #: ../src/guestfs-actions.pod:6464
16776 msgid "guestfs_tail"
16780 #: ../src/guestfs-actions.pod:6466
16784 " guestfs_tail (guestfs_h *g,\n"
16785 " const char *path);\n"
16790 #: ../src/guestfs-actions.pod:6470 ../fish/guestfish-actions.pod:4348
16792 "This command returns up to the last 10 lines of a file as a list of strings."
16796 #: ../src/guestfs-actions.pod:6482
16797 msgid "guestfs_tail_n"
16801 #: ../src/guestfs-actions.pod:6484
16805 " guestfs_tail_n (guestfs_h *g,\n"
16807 " const char *path);\n"
16812 #: ../src/guestfs-actions.pod:6489 ../fish/guestfish-actions.pod:4358
16814 "If the parameter C<nrlines> is a positive number, this returns the last "
16815 "C<nrlines> lines of the file C<path>."
16819 #: ../src/guestfs-actions.pod:6492 ../fish/guestfish-actions.pod:4361
16821 "If the parameter C<nrlines> is a negative number, this returns lines from "
16822 "the file C<path>, starting with the C<-nrlines>th line."
16826 #: ../src/guestfs-actions.pod:6506
16827 msgid "guestfs_tar_in"
16831 #: ../src/guestfs-actions.pod:6508
16835 " guestfs_tar_in (guestfs_h *g,\n"
16836 " const char *tarfile,\n"
16837 " const char *directory);\n"
16842 #: ../src/guestfs-actions.pod:6513 ../fish/guestfish-actions.pod:4373
16844 "This command uploads and unpacks local file C<tarfile> (an I<uncompressed> "
16845 "tar file) into C<directory>."
16849 #: ../src/guestfs-actions.pod:6516
16851 "To upload a compressed tarball, use C<guestfs_tgz_in> or C<guestfs_txz_in>."
16855 #: ../src/guestfs-actions.pod:6521 ../src/guestfs-actions.pod:6538
16856 #: ../src/guestfs-actions.pod:6554 ../src/guestfs-actions.pod:6570
16857 msgid "(Added in 1.0.3)"
16861 #: ../src/guestfs-actions.pod:6523
16862 msgid "guestfs_tar_out"
16866 #: ../src/guestfs-actions.pod:6525
16870 " guestfs_tar_out (guestfs_h *g,\n"
16871 " const char *directory,\n"
16872 " const char *tarfile);\n"
16877 #: ../src/guestfs-actions.pod:6530 ../fish/guestfish-actions.pod:4385
16879 "This command packs the contents of C<directory> and downloads it to local "
16884 #: ../src/guestfs-actions.pod:6533
16886 "To download a compressed tarball, use C<guestfs_tgz_out> or "
16887 "C<guestfs_txz_out>."
16891 #: ../src/guestfs-actions.pod:6540
16892 msgid "guestfs_tgz_in"
16896 #: ../src/guestfs-actions.pod:6542
16900 " guestfs_tgz_in (guestfs_h *g,\n"
16901 " const char *tarball,\n"
16902 " const char *directory);\n"
16907 #: ../src/guestfs-actions.pod:6547 ../fish/guestfish-actions.pod:4397
16909 "This command uploads and unpacks local file C<tarball> (a I<gzip compressed> "
16910 "tar file) into C<directory>."
16914 #: ../src/guestfs-actions.pod:6550
16915 msgid "To upload an uncompressed tarball, use C<guestfs_tar_in>."
16919 #: ../src/guestfs-actions.pod:6556
16920 msgid "guestfs_tgz_out"
16924 #: ../src/guestfs-actions.pod:6558
16928 " guestfs_tgz_out (guestfs_h *g,\n"
16929 " const char *directory,\n"
16930 " const char *tarball);\n"
16935 #: ../src/guestfs-actions.pod:6563 ../fish/guestfish-actions.pod:4408
16937 "This command packs the contents of C<directory> and downloads it to local "
16942 #: ../src/guestfs-actions.pod:6566
16943 msgid "To download an uncompressed tarball, use C<guestfs_tar_out>."
16947 #: ../src/guestfs-actions.pod:6572
16948 msgid "guestfs_touch"
16952 #: ../src/guestfs-actions.pod:6574
16956 " guestfs_touch (guestfs_h *g,\n"
16957 " const char *path);\n"
16962 #: ../src/guestfs-actions.pod:6578 ../fish/guestfish-actions.pod:4419
16964 "Touch acts like the L<touch(1)> command. It can be used to update the "
16965 "timestamps on a file, or, if the file does not exist, to create a new zero-"
16970 #: ../src/guestfs-actions.pod:6582 ../fish/guestfish-actions.pod:4423
16972 "This command only works on regular files, and will fail on other file types "
16973 "such as directories, symbolic links, block special etc."
16977 #: ../src/guestfs-actions.pod:6589
16978 msgid "guestfs_truncate"
16982 #: ../src/guestfs-actions.pod:6591
16986 " guestfs_truncate (guestfs_h *g,\n"
16987 " const char *path);\n"
16992 #: ../src/guestfs-actions.pod:6595 ../fish/guestfish-actions.pod:4430
16994 "This command truncates C<path> to a zero-length file. The file must exist "
16999 #: ../src/guestfs-actions.pod:6602
17000 msgid "guestfs_truncate_size"
17004 #: ../src/guestfs-actions.pod:6604
17008 " guestfs_truncate_size (guestfs_h *g,\n"
17009 " const char *path,\n"
17010 " int64_t size);\n"
17015 #: ../src/guestfs-actions.pod:6609 ../fish/guestfish-actions.pod:4437
17017 "This command truncates C<path> to size C<size> bytes. The file must exist "
17022 #: ../src/guestfs-actions.pod:6612
17024 "If the current file size is less than C<size> then the file is extended to "
17025 "the required size with zero bytes. This creates a sparse file (ie. disk "
17026 "blocks are not allocated for the file until you write to it). To create a "
17027 "non-sparse file of zeroes, use C<guestfs_fallocate64> instead."
17031 #: ../src/guestfs-actions.pod:6622
17032 msgid "guestfs_tune2fs_l"
17036 #: ../src/guestfs-actions.pod:6624
17040 " guestfs_tune2fs_l (guestfs_h *g,\n"
17041 " const char *device);\n"
17046 #: ../src/guestfs-actions.pod:6628 ../fish/guestfish-actions.pod:4450
17048 "This returns the contents of the ext2, ext3 or ext4 filesystem superblock on "
17053 #: ../src/guestfs-actions.pod:6631 ../fish/guestfish-actions.pod:4453
17055 "It is the same as running C<tune2fs -l device>. See L<tune2fs(8)> manpage "
17056 "for more details. The list of fields returned isn't clearly defined, and "
17057 "depends on both the version of C<tune2fs> that libguestfs was built against, "
17058 "and the filesystem itself."
17062 #: ../src/guestfs-actions.pod:6644
17063 msgid "guestfs_txz_in"
17067 #: ../src/guestfs-actions.pod:6646
17071 " guestfs_txz_in (guestfs_h *g,\n"
17072 " const char *tarball,\n"
17073 " const char *directory);\n"
17078 #: ../src/guestfs-actions.pod:6651 ../fish/guestfish-actions.pod:4462
17080 "This command uploads and unpacks local file C<tarball> (an I<xz compressed> "
17081 "tar file) into C<directory>."
17085 #: ../src/guestfs-actions.pod:6658
17086 msgid "guestfs_txz_out"
17090 #: ../src/guestfs-actions.pod:6660
17094 " guestfs_txz_out (guestfs_h *g,\n"
17095 " const char *directory,\n"
17096 " const char *tarball);\n"
17101 #: ../src/guestfs-actions.pod:6665 ../fish/guestfish-actions.pod:4471
17103 "This command packs the contents of C<directory> and downloads it to local "
17104 "file C<tarball> (as an xz compressed tar archive)."
17108 #: ../src/guestfs-actions.pod:6672
17109 msgid "guestfs_umask"
17113 #: ../src/guestfs-actions.pod:6674
17117 " guestfs_umask (guestfs_h *g,\n"
17123 #: ../src/guestfs-actions.pod:6678 ../fish/guestfish-actions.pod:4480
17125 "This function sets the mask used for creating new files and device nodes to "
17130 #: ../src/guestfs-actions.pod:6681 ../fish/guestfish-actions.pod:4483
17132 "Typical umask values would be C<022> which creates new files with "
17133 "permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and C<002> which creates "
17134 "new files with permissions like \"-rw-rw-r--\" or \"-rwxrwxr-x\"."
17138 #: ../src/guestfs-actions.pod:6686 ../fish/guestfish-actions.pod:4488
17140 "The default umask is C<022>. This is important because it means that "
17141 "directories and device nodes will be created with C<0644> or C<0755> mode "
17142 "even if you specify C<0777>."
17146 #: ../src/guestfs-actions.pod:6690
17148 "See also C<guestfs_get_umask>, L<umask(2)>, C<guestfs_mknod>, "
17149 "C<guestfs_mkdir>."
17153 #: ../src/guestfs-actions.pod:6693 ../fish/guestfish-actions.pod:4495
17154 msgid "This call returns the previous umask."
17158 #: ../src/guestfs-actions.pod:6699
17159 msgid "guestfs_umount"
17163 #: ../src/guestfs-actions.pod:6701
17167 " guestfs_umount (guestfs_h *g,\n"
17168 " const char *pathordevice);\n"
17173 #: ../src/guestfs-actions.pod:6705 ../fish/guestfish-actions.pod:4503
17175 "This unmounts the given filesystem. The filesystem may be specified either "
17176 "by its mountpoint (path) or the device which contains the filesystem."
17180 #: ../src/guestfs-actions.pod:6713
17181 msgid "guestfs_umount_all"
17185 #: ../src/guestfs-actions.pod:6715
17189 " guestfs_umount_all (guestfs_h *g);\n"
17194 #: ../src/guestfs-actions.pod:6718 ../fish/guestfish-actions.pod:4513
17195 msgid "This unmounts all mounted filesystems."
17199 #: ../src/guestfs-actions.pod:6720 ../fish/guestfish-actions.pod:4515
17200 msgid "Some internal mounts are not unmounted by this call."
17204 #: ../src/guestfs-actions.pod:6726
17205 msgid "guestfs_upload"
17209 #: ../src/guestfs-actions.pod:6728
17213 " guestfs_upload (guestfs_h *g,\n"
17214 " const char *filename,\n"
17215 " const char *remotefilename);\n"
17220 #: ../src/guestfs-actions.pod:6733 ../src/guestfs-actions.pod:6757
17221 #: ../fish/guestfish-actions.pod:4521 ../fish/guestfish-actions.pod:4534
17222 msgid "Upload local file C<filename> to C<remotefilename> on the filesystem."
17226 #: ../src/guestfs-actions.pod:6738
17227 msgid "See also C<guestfs_download>."
17231 #: ../src/guestfs-actions.pod:6749
17232 msgid "guestfs_upload_offset"
17236 #: ../src/guestfs-actions.pod:6751
17240 " guestfs_upload_offset (guestfs_h *g,\n"
17241 " const char *filename,\n"
17242 " const char *remotefilename,\n"
17243 " int64_t offset);\n"
17248 #: ../src/guestfs-actions.pod:6760 ../fish/guestfish-actions.pod:4537
17250 "C<remotefilename> is overwritten starting at the byte C<offset> specified. "
17251 "The intention is to overwrite parts of existing files or devices, although "
17252 "if a non-existant file is specified then it is created with a \"hole\" "
17253 "before C<offset>. The size of the data written is implicit in the size of "
17254 "the source C<filename>."
17258 #: ../src/guestfs-actions.pod:6767
17260 "Note that there is no limit on the amount of data that can be uploaded with "
17261 "this call, unlike with C<guestfs_pwrite>, and this call always writes the "
17262 "full amount unless an error occurs."
17266 #: ../src/guestfs-actions.pod:6772
17267 msgid "See also C<guestfs_upload>, C<guestfs_pwrite>."
17271 #: ../src/guestfs-actions.pod:6783
17272 msgid "guestfs_utimens"
17276 #: ../src/guestfs-actions.pod:6785
17280 " guestfs_utimens (guestfs_h *g,\n"
17281 " const char *path,\n"
17282 " int64_t atsecs,\n"
17283 " int64_t atnsecs,\n"
17284 " int64_t mtsecs,\n"
17285 " int64_t mtnsecs);\n"
17290 #: ../src/guestfs-actions.pod:6793 ../fish/guestfish-actions.pod:4557
17291 msgid "This command sets the timestamps of a file with nanosecond precision."
17295 #: ../src/guestfs-actions.pod:6796 ../fish/guestfish-actions.pod:4560
17297 "C<atsecs, atnsecs> are the last access time (atime) in secs and nanoseconds "
17302 #: ../src/guestfs-actions.pod:6799 ../fish/guestfish-actions.pod:4563
17304 "C<mtsecs, mtnsecs> are the last modification time (mtime) in secs and "
17305 "nanoseconds from the epoch."
17309 #: ../src/guestfs-actions.pod:6802 ../fish/guestfish-actions.pod:4566
17311 "If the C<*nsecs> field contains the special value C<-1> then the "
17312 "corresponding timestamp is set to the current time. (The C<*secs> field is "
17313 "ignored in this case)."
17317 #: ../src/guestfs-actions.pod:6806 ../fish/guestfish-actions.pod:4570
17319 "If the C<*nsecs> field contains the special value C<-2> then the "
17320 "corresponding timestamp is left unchanged. (The C<*secs> field is ignored "
17325 #: ../src/guestfs-actions.pod:6814 ../src/guestfs-structs.pod:175
17326 msgid "guestfs_version"
17330 #: ../src/guestfs-actions.pod:6816
17333 " struct guestfs_version *\n"
17334 " guestfs_version (guestfs_h *g);\n"
17339 #: ../src/guestfs-actions.pod:6819 ../fish/guestfish-actions.pod:4578
17341 "Return the libguestfs version number that the program is linked against."
17345 #: ../src/guestfs-actions.pod:6822 ../fish/guestfish-actions.pod:4581
17347 "Note that because of dynamic linking this is not necessarily the version of "
17348 "libguestfs that you compiled against. You can compile the program, and then "
17349 "at runtime dynamically link against a completely different C<libguestfs.so> "
17354 #: ../src/guestfs-actions.pod:6827 ../fish/guestfish-actions.pod:4586
17356 "This call was added in version C<1.0.58>. In previous versions of "
17357 "libguestfs there was no way to get the version number. From C code you can "
17358 "use dynamic linker functions to find out if this symbol exists (if it "
17359 "doesn't, then it's an earlier version)."
17363 #: ../src/guestfs-actions.pod:6833 ../fish/guestfish-actions.pod:4592
17365 "The call returns a structure with four elements. The first three (C<major>, "
17366 "C<minor> and C<release>) are numbers and correspond to the usual version "
17367 "triplet. The fourth element (C<extra>) is a string and is normally empty, "
17368 "but may be used for distro-specific information."
17372 #: ../src/guestfs-actions.pod:6839 ../fish/guestfish-actions.pod:4598
17374 "To construct the original version string: C<$major.$minor.$release$extra>"
17378 #: ../src/guestfs-actions.pod:6842 ../fish/guestfish-actions.pod:4601
17379 msgid "See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>."
17383 #: ../src/guestfs-actions.pod:6844
17385 "I<Note:> Don't use this call to test for availability of features. In "
17386 "enterprise distributions we backport features from later versions into "
17387 "earlier versions, making this an unreliable way to test for features. Use "
17388 "C<guestfs_available> instead."
17392 #: ../src/guestfs-actions.pod:6850
17394 "This function returns a C<struct guestfs_version *>, or NULL if there was an "
17395 "error. I<The caller must call C<guestfs_free_version> after use>."
17399 #: ../src/guestfs-actions.pod:6854
17400 msgid "(Added in 1.0.58)"
17404 #: ../src/guestfs-actions.pod:6856
17405 msgid "guestfs_vfs_label"
17409 #: ../src/guestfs-actions.pod:6858
17413 " guestfs_vfs_label (guestfs_h *g,\n"
17414 " const char *device);\n"
17419 #: ../src/guestfs-actions.pod:6862 ../fish/guestfish-actions.pod:4613
17420 msgid "This returns the filesystem label of the filesystem on C<device>."
17424 #: ../src/guestfs-actions.pod:6865 ../fish/guestfish-actions.pod:4616
17425 msgid "If the filesystem is unlabeled, this returns the empty string."
17429 #: ../src/guestfs-actions.pod:6867
17430 msgid "To find a filesystem from the label, use C<guestfs_findfs_label>."
17434 #: ../src/guestfs-actions.pod:6872 ../src/guestfs-actions.pod:6909
17435 msgid "(Added in 1.3.18)"
17439 #: ../src/guestfs-actions.pod:6874
17440 msgid "guestfs_vfs_type"
17444 #: ../src/guestfs-actions.pod:6876
17448 " guestfs_vfs_type (guestfs_h *g,\n"
17449 " const char *device);\n"
17454 #: ../src/guestfs-actions.pod:6880 ../fish/guestfish-actions.pod:4624
17456 "This command gets the filesystem type corresponding to the filesystem on "
17461 #: ../src/guestfs-actions.pod:6883 ../fish/guestfish-actions.pod:4627
17463 "For most filesystems, the result is the name of the Linux VFS module which "
17464 "would be used to mount this filesystem if you mounted it without specifying "
17465 "the filesystem type. For example a string such as C<ext3> or C<ntfs>."
17469 #: ../src/guestfs-actions.pod:6893
17470 msgid "guestfs_vfs_uuid"
17474 #: ../src/guestfs-actions.pod:6895
17478 " guestfs_vfs_uuid (guestfs_h *g,\n"
17479 " const char *device);\n"
17484 #: ../src/guestfs-actions.pod:6899 ../fish/guestfish-actions.pod:4636
17485 msgid "This returns the filesystem UUID of the filesystem on C<device>."
17489 #: ../src/guestfs-actions.pod:6902 ../fish/guestfish-actions.pod:4639
17490 msgid "If the filesystem does not have a UUID, this returns the empty string."
17494 #: ../src/guestfs-actions.pod:6904
17495 msgid "To find a filesystem from the UUID, use C<guestfs_findfs_uuid>."
17499 #: ../src/guestfs-actions.pod:6911
17500 msgid "guestfs_vg_activate"
17504 #: ../src/guestfs-actions.pod:6913
17508 " guestfs_vg_activate (guestfs_h *g,\n"
17510 " char *const *volgroups);\n"
17515 #: ../src/guestfs-actions.pod:6918 ../fish/guestfish-actions.pod:4647
17517 "This command activates or (if C<activate> is false) deactivates all logical "
17518 "volumes in the listed volume groups C<volgroups>. If activated, then they "
17519 "are made known to the kernel, ie. they appear as C</dev/mapper> devices. If "
17520 "deactivated, then those devices disappear."
17524 #: ../src/guestfs-actions.pod:6924 ../fish/guestfish-actions.pod:4653
17525 msgid "This command is the same as running C<vgchange -a y|n volgroups...>"
17529 #: ../src/guestfs-actions.pod:6926 ../fish/guestfish-actions.pod:4655
17531 "Note that if C<volgroups> is an empty list then B<all> volume groups are "
17532 "activated or deactivated."
17536 #: ../src/guestfs-actions.pod:6933
17537 msgid "guestfs_vg_activate_all"
17541 #: ../src/guestfs-actions.pod:6935
17545 " guestfs_vg_activate_all (guestfs_h *g,\n"
17546 " int activate);\n"
17551 #: ../src/guestfs-actions.pod:6939 ../fish/guestfish-actions.pod:4662
17553 "This command activates or (if C<activate> is false) deactivates all logical "
17554 "volumes in all volume groups. If activated, then they are made known to the "
17555 "kernel, ie. they appear as C</dev/mapper> devices. If deactivated, then "
17556 "those devices disappear."
17560 #: ../src/guestfs-actions.pod:6945 ../fish/guestfish-actions.pod:4668
17561 msgid "This command is the same as running C<vgchange -a y|n>"
17565 #: ../src/guestfs-actions.pod:6951
17566 msgid "guestfs_vgcreate"
17570 #: ../src/guestfs-actions.pod:6953
17574 " guestfs_vgcreate (guestfs_h *g,\n"
17575 " const char *volgroup,\n"
17576 " char *const *physvols);\n"
17581 #: ../src/guestfs-actions.pod:6958 ../fish/guestfish-actions.pod:4674
17583 "This creates an LVM volume group called C<volgroup> from the non-empty list "
17584 "of physical volumes C<physvols>."
17588 #: ../src/guestfs-actions.pod:6965
17589 msgid "guestfs_vglvuuids"
17593 #: ../src/guestfs-actions.pod:6967
17597 " guestfs_vglvuuids (guestfs_h *g,\n"
17598 " const char *vgname);\n"
17603 #: ../src/guestfs-actions.pod:6971 ../fish/guestfish-actions.pod:4681
17605 "Given a VG called C<vgname>, this returns the UUIDs of all the logical "
17606 "volumes created in this volume group."
17610 #: ../src/guestfs-actions.pod:6974
17612 "You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid> calls to "
17613 "associate logical volumes and volume groups."
17617 #: ../src/guestfs-actions.pod:6977
17618 msgid "See also C<guestfs_vgpvuuids>."
17622 #: ../src/guestfs-actions.pod:6985
17623 msgid "guestfs_vgpvuuids"
17627 #: ../src/guestfs-actions.pod:6987
17631 " guestfs_vgpvuuids (guestfs_h *g,\n"
17632 " const char *vgname);\n"
17637 #: ../src/guestfs-actions.pod:6991 ../fish/guestfish-actions.pod:4693
17639 "Given a VG called C<vgname>, this returns the UUIDs of all the physical "
17640 "volumes that this volume group resides on."
17644 #: ../src/guestfs-actions.pod:6994
17646 "You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid> calls to "
17647 "associate physical volumes and volume groups."
17651 #: ../src/guestfs-actions.pod:6997
17652 msgid "See also C<guestfs_vglvuuids>."
17656 #: ../src/guestfs-actions.pod:7005
17657 msgid "guestfs_vgremove"
17661 #: ../src/guestfs-actions.pod:7007
17665 " guestfs_vgremove (guestfs_h *g,\n"
17666 " const char *vgname);\n"
17671 #: ../src/guestfs-actions.pod:7011 ../fish/guestfish-actions.pod:4705
17672 msgid "Remove an LVM volume group C<vgname>, (for example C<VG>)."
17676 #: ../src/guestfs-actions.pod:7013 ../fish/guestfish-actions.pod:4707
17678 "This also forcibly removes all logical volumes in the volume group (if any)."
17682 #: ../src/guestfs-actions.pod:7020
17683 msgid "guestfs_vgrename"
17687 #: ../src/guestfs-actions.pod:7022
17691 " guestfs_vgrename (guestfs_h *g,\n"
17692 " const char *volgroup,\n"
17693 " const char *newvolgroup);\n"
17698 #: ../src/guestfs-actions.pod:7027 ../fish/guestfish-actions.pod:4714
17699 msgid "Rename a volume group C<volgroup> with the new name C<newvolgroup>."
17703 #: ../src/guestfs-actions.pod:7033
17704 msgid "guestfs_vgs"
17708 #: ../src/guestfs-actions.pod:7035
17712 " guestfs_vgs (guestfs_h *g);\n"
17717 #: ../src/guestfs-actions.pod:7038 ../fish/guestfish-actions.pod:4720
17719 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
17724 #: ../src/guestfs-actions.pod:7041 ../fish/guestfish-actions.pod:4723
17726 "This returns a list of just the volume group names that were detected (eg. "
17731 #: ../src/guestfs-actions.pod:7044
17732 msgid "See also C<guestfs_vgs_full>."
17736 #: ../src/guestfs-actions.pod:7052
17737 msgid "guestfs_vgs_full"
17741 #: ../src/guestfs-actions.pod:7054
17744 " struct guestfs_lvm_vg_list *\n"
17745 " guestfs_vgs_full (guestfs_h *g);\n"
17750 #: ../src/guestfs-actions.pod:7057 ../fish/guestfish-actions.pod:4732
17752 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
17753 "> command. The \"full\" version includes all fields."
17757 #: ../src/guestfs-actions.pod:7060
17759 "This function returns a C<struct guestfs_lvm_vg_list *>, or NULL if there "
17760 "was an error. I<The caller must call C<guestfs_free_lvm_vg_list> after use>."
17764 #: ../src/guestfs-actions.pod:7066
17765 msgid "guestfs_vgscan"
17769 #: ../src/guestfs-actions.pod:7068
17773 " guestfs_vgscan (guestfs_h *g);\n"
17778 #: ../src/guestfs-actions.pod:7071 ../fish/guestfish-actions.pod:4739
17780 "This rescans all block devices and rebuilds the list of LVM physical "
17781 "volumes, volume groups and logical volumes."
17785 #: ../src/guestfs-actions.pod:7078
17786 msgid "guestfs_vguuid"
17790 #: ../src/guestfs-actions.pod:7080
17794 " guestfs_vguuid (guestfs_h *g,\n"
17795 " const char *vgname);\n"
17800 #: ../src/guestfs-actions.pod:7084 ../fish/guestfish-actions.pod:4746
17801 msgid "This command returns the UUID of the LVM VG named C<vgname>."
17805 #: ../src/guestfs-actions.pod:7091
17806 msgid "guestfs_wait_ready"
17810 #: ../src/guestfs-actions.pod:7093
17814 " guestfs_wait_ready (guestfs_h *g);\n"
17819 #: ../src/guestfs-actions.pod:7096
17820 msgid "This function is a no op."
17824 #: ../src/guestfs-actions.pod:7098
17826 "In versions of the API E<lt> 1.0.71 you had to call this function just after "
17827 "calling C<guestfs_launch> to wait for the launch to complete. However this "
17828 "is no longer necessary because C<guestfs_launch> now does the waiting."
17832 #: ../src/guestfs-actions.pod:7103
17834 "If you see any calls to this function in code then you can just remove them, "
17835 "unless you want to retain compatibility with older versions of the API."
17839 #: ../src/guestfs-actions.pod:7111
17840 msgid "guestfs_wc_c"
17844 #: ../src/guestfs-actions.pod:7113
17848 " guestfs_wc_c (guestfs_h *g,\n"
17849 " const char *path);\n"
17854 #: ../src/guestfs-actions.pod:7117 ../fish/guestfish-actions.pod:4752
17856 "This command counts the characters in a file, using the C<wc -c> external "
17861 #: ../src/guestfs-actions.pod:7124
17862 msgid "guestfs_wc_l"
17866 #: ../src/guestfs-actions.pod:7126
17870 " guestfs_wc_l (guestfs_h *g,\n"
17871 " const char *path);\n"
17876 #: ../src/guestfs-actions.pod:7130 ../fish/guestfish-actions.pod:4759
17878 "This command counts the lines in a file, using the C<wc -l> external command."
17882 #: ../src/guestfs-actions.pod:7137
17883 msgid "guestfs_wc_w"
17887 #: ../src/guestfs-actions.pod:7139
17891 " guestfs_wc_w (guestfs_h *g,\n"
17892 " const char *path);\n"
17897 #: ../src/guestfs-actions.pod:7143 ../fish/guestfish-actions.pod:4766
17899 "This command counts the words in a file, using the C<wc -w> external command."
17903 #: ../src/guestfs-actions.pod:7150
17904 msgid "guestfs_write"
17908 #: ../src/guestfs-actions.pod:7152
17912 " guestfs_write (guestfs_h *g,\n"
17913 " const char *path,\n"
17914 " const char *content,\n"
17915 " size_t content_size);\n"
17920 #: ../src/guestfs-actions.pod:7158 ../fish/guestfish-actions.pod:4773
17922 "This call creates a file called C<path>. The content of the file is the "
17923 "string C<content> (which can contain any 8 bit data)."
17927 #: ../src/guestfs-actions.pod:7168
17928 msgid "guestfs_write_file"
17932 #: ../src/guestfs-actions.pod:7170
17936 " guestfs_write_file (guestfs_h *g,\n"
17937 " const char *path,\n"
17938 " const char *content,\n"
17944 #: ../src/guestfs-actions.pod:7176 ../fish/guestfish-actions.pod:4783
17946 "This call creates a file called C<path>. The contents of the file is the "
17947 "string C<content> (which can contain any 8 bit data), with length C<size>."
17951 #: ../src/guestfs-actions.pod:7180 ../fish/guestfish-actions.pod:4787
17953 "As a special case, if C<size> is C<0> then the length is calculated using "
17954 "C<strlen> (so in this case the content cannot contain embedded ASCII NULs)."
17958 #: ../src/guestfs-actions.pod:7184 ../fish/guestfish-actions.pod:4791
17960 "I<NB.> Owing to a bug, writing content containing ASCII NUL characters does "
17961 "I<not> work, even if the length is specified."
17965 #: ../src/guestfs-actions.pod:7192 ../fish/guestfish-actions.pod:4797
17967 "This function is deprecated. In new code, use the C<write> call instead."
17971 #: ../src/guestfs-actions.pod:7201
17972 msgid "guestfs_zegrep"
17976 #: ../src/guestfs-actions.pod:7203
17980 " guestfs_zegrep (guestfs_h *g,\n"
17981 " const char *regex,\n"
17982 " const char *path);\n"
17987 #: ../src/guestfs-actions.pod:7208 ../fish/guestfish-actions.pod:4808
17989 "This calls the external C<zegrep> program and returns the matching lines."
17993 #: ../src/guestfs-actions.pod:7220
17994 msgid "guestfs_zegrepi"
17998 #: ../src/guestfs-actions.pod:7222
18002 " guestfs_zegrepi (guestfs_h *g,\n"
18003 " const char *regex,\n"
18004 " const char *path);\n"
18009 #: ../src/guestfs-actions.pod:7227 ../fish/guestfish-actions.pod:4818
18011 "This calls the external C<zegrep -i> program and returns the matching lines."
18015 #: ../src/guestfs-actions.pod:7239
18016 msgid "guestfs_zero"
18020 #: ../src/guestfs-actions.pod:7241
18024 " guestfs_zero (guestfs_h *g,\n"
18025 " const char *device);\n"
18030 #: ../src/guestfs-actions.pod:7245 ../fish/guestfish-actions.pod:4828
18031 msgid "This command writes zeroes over the first few blocks of C<device>."
18035 #: ../src/guestfs-actions.pod:7247 ../fish/guestfish-actions.pod:4830
18037 "How many blocks are zeroed isn't specified (but it's I<not> enough to "
18038 "securely wipe the device). It should be sufficient to remove any partition "
18039 "tables, filesystem superblocks and so on."
18043 #: ../src/guestfs-actions.pod:7251
18044 msgid "See also: C<guestfs_zero_device>, C<guestfs_scrub_device>."
18048 #: ../src/guestfs-actions.pod:7262
18049 msgid "guestfs_zero_device"
18053 #: ../src/guestfs-actions.pod:7264
18057 " guestfs_zero_device (guestfs_h *g,\n"
18058 " const char *device);\n"
18063 #: ../src/guestfs-actions.pod:7268
18065 "This command writes zeroes over the entire C<device>. Compare with "
18066 "C<guestfs_zero> which just zeroes the first few blocks of a device."
18070 #: ../src/guestfs-actions.pod:7282
18071 msgid "(Added in 1.3.1)"
18075 #: ../src/guestfs-actions.pod:7284
18076 msgid "guestfs_zerofree"
18080 #: ../src/guestfs-actions.pod:7286
18084 " guestfs_zerofree (guestfs_h *g,\n"
18085 " const char *device);\n"
18090 #: ../src/guestfs-actions.pod:7290 ../fish/guestfish-actions.pod:4851
18092 "This runs the I<zerofree> program on C<device>. This program claims to zero "
18093 "unused inodes and disk blocks on an ext2/3 filesystem, thus making it "
18094 "possible to compress the filesystem more effectively."
18098 #: ../src/guestfs-actions.pod:7295 ../fish/guestfish-actions.pod:4856
18099 msgid "You should B<not> run this program if the filesystem is mounted."
18103 #: ../src/guestfs-actions.pod:7298 ../fish/guestfish-actions.pod:4859
18105 "It is possible that using this program can damage the filesystem or data on "
18110 #: ../src/guestfs-actions.pod:7305
18111 msgid "guestfs_zfgrep"
18115 #: ../src/guestfs-actions.pod:7307
18119 " guestfs_zfgrep (guestfs_h *g,\n"
18120 " const char *pattern,\n"
18121 " const char *path);\n"
18126 #: ../src/guestfs-actions.pod:7312 ../fish/guestfish-actions.pod:4866
18128 "This calls the external C<zfgrep> program and returns the matching lines."
18132 #: ../src/guestfs-actions.pod:7324
18133 msgid "guestfs_zfgrepi"
18137 #: ../src/guestfs-actions.pod:7326
18141 " guestfs_zfgrepi (guestfs_h *g,\n"
18142 " const char *pattern,\n"
18143 " const char *path);\n"
18148 #: ../src/guestfs-actions.pod:7331 ../fish/guestfish-actions.pod:4876
18150 "This calls the external C<zfgrep -i> program and returns the matching lines."
18154 #: ../src/guestfs-actions.pod:7343
18155 msgid "guestfs_zfile"
18159 #: ../src/guestfs-actions.pod:7345
18163 " guestfs_zfile (guestfs_h *g,\n"
18164 " const char *meth,\n"
18165 " const char *path);\n"
18170 #: ../src/guestfs-actions.pod:7350 ../fish/guestfish-actions.pod:4886
18172 "This command runs C<file> after first decompressing C<path> using C<method>."
18176 #: ../src/guestfs-actions.pod:7353 ../fish/guestfish-actions.pod:4889
18177 msgid "C<method> must be one of C<gzip>, C<compress> or C<bzip2>."
18181 #: ../src/guestfs-actions.pod:7355
18183 "Since 1.0.63, use C<guestfs_file> instead which can now process compressed "
18188 #: ../src/guestfs-actions.pod:7361 ../fish/guestfish-actions.pod:4894
18190 "This function is deprecated. In new code, use the C<file> call instead."
18194 #: ../src/guestfs-actions.pod:7370
18195 msgid "guestfs_zgrep"
18199 #: ../src/guestfs-actions.pod:7372
18203 " guestfs_zgrep (guestfs_h *g,\n"
18204 " const char *regex,\n"
18205 " const char *path);\n"
18210 #: ../src/guestfs-actions.pod:7377 ../fish/guestfish-actions.pod:4905
18212 "This calls the external C<zgrep> program and returns the matching lines."
18216 #: ../src/guestfs-actions.pod:7389
18217 msgid "guestfs_zgrepi"
18221 #: ../src/guestfs-actions.pod:7391
18225 " guestfs_zgrepi (guestfs_h *g,\n"
18226 " const char *regex,\n"
18227 " const char *path);\n"
18232 #: ../src/guestfs-actions.pod:7396 ../fish/guestfish-actions.pod:4915
18234 "This calls the external C<zgrep -i> program and returns the matching lines."
18238 #: ../src/guestfs-availability.pod:3
18243 #: ../src/guestfs-availability.pod:5
18245 "The following functions: L</guestfs_aug_clear> L</guestfs_aug_close> L</"
18246 "guestfs_aug_defnode> L</guestfs_aug_defvar> L</guestfs_aug_get> L</"
18247 "guestfs_aug_init> L</guestfs_aug_insert> L</guestfs_aug_load> L</"
18248 "guestfs_aug_ls> L</guestfs_aug_match> L</guestfs_aug_mv> L</guestfs_aug_rm> "
18249 "L</guestfs_aug_save> L</guestfs_aug_set>"
18253 #: ../src/guestfs-availability.pod:21
18258 #: ../src/guestfs-availability.pod:23
18260 "The following functions: L</guestfs_inotify_add_watch> L</"
18261 "guestfs_inotify_close> L</guestfs_inotify_files> L</guestfs_inotify_init> L</"
18262 "guestfs_inotify_read> L</guestfs_inotify_rm_watch>"
18266 #: ../src/guestfs-availability.pod:31
18267 msgid "B<linuxfsuuid>"
18271 #: ../src/guestfs-availability.pod:33
18273 "The following functions: L</guestfs_mke2fs_JU> L</guestfs_mke2journal_U> L</"
18274 "guestfs_mkswap_U> L</guestfs_swapoff_uuid> L</guestfs_swapon_uuid>"
18278 #: ../src/guestfs-availability.pod:40
18279 msgid "B<linuxmodules>"
18283 #: ../src/guestfs-availability.pod:42
18284 msgid "The following functions: L</guestfs_modprobe>"
18288 #: ../src/guestfs-availability.pod:45
18289 msgid "B<linuxxattrs>"
18293 #: ../src/guestfs-availability.pod:47
18295 "The following functions: L</guestfs_getxattr> L</guestfs_getxattrs> L</"
18296 "guestfs_lgetxattr> L</guestfs_lgetxattrs> L</guestfs_lremovexattr> L</"
18297 "guestfs_lsetxattr> L</guestfs_lxattrlist> L</guestfs_removexattr> L</"
18298 "guestfs_setxattr>"
18302 #: ../src/guestfs-availability.pod:58
18307 #: ../src/guestfs-availability.pod:60
18309 "The following functions: L</guestfs_luks_add_key> L</guestfs_luks_close> L</"
18310 "guestfs_luks_format> L</guestfs_luks_format_cipher> L</"
18311 "guestfs_luks_kill_slot> L</guestfs_luks_open> L</guestfs_luks_open_ro>"
18315 #: ../src/guestfs-availability.pod:69
18320 #: ../src/guestfs-availability.pod:71
18322 "The following functions: L</guestfs_is_lv> L</guestfs_lvcreate> L</"
18323 "guestfs_lvm_remove_all> L</guestfs_lvm_set_filter> L</guestfs_lvremove> L</"
18324 "guestfs_lvresize> L</guestfs_lvresize_free> L</guestfs_lvs> L</"
18325 "guestfs_lvs_full> L</guestfs_pvcreate> L</guestfs_pvremove> L</"
18326 "guestfs_pvresize> L</guestfs_pvresize_size> L</guestfs_pvs> L</"
18327 "guestfs_pvs_full> L</guestfs_vg_activate> L</guestfs_vg_activate_all> L</"
18328 "guestfs_vgcreate> L</guestfs_vgremove> L</guestfs_vgs> L</guestfs_vgs_full>"
18332 #: ../src/guestfs-availability.pod:94
18337 #: ../src/guestfs-availability.pod:96
18339 "The following functions: L</guestfs_mkfifo> L</guestfs_mknod> L</"
18340 "guestfs_mknod_b> L</guestfs_mknod_c>"
18344 #: ../src/guestfs-availability.pod:102
18349 #: ../src/guestfs-availability.pod:104
18350 msgid "The following functions: L</guestfs_ntfs_3g_probe>"
18354 #: ../src/guestfs-availability.pod:107
18355 msgid "B<ntfsprogs>"
18359 #: ../src/guestfs-availability.pod:109
18361 "The following functions: L</guestfs_ntfsresize> L</guestfs_ntfsresize_size>"
18365 #: ../src/guestfs-availability.pod:113
18366 msgid "B<realpath>"
18370 #: ../src/guestfs-availability.pod:115
18371 msgid "The following functions: L</guestfs_realpath>"
18375 #: ../src/guestfs-availability.pod:118
18380 #: ../src/guestfs-availability.pod:120
18382 "The following functions: L</guestfs_scrub_device> L</guestfs_scrub_file> L</"
18383 "guestfs_scrub_freespace>"
18387 #: ../src/guestfs-availability.pod:125
18392 #: ../src/guestfs-availability.pod:127
18393 msgid "The following functions: L</guestfs_getcon> L</guestfs_setcon>"
18397 #: ../src/guestfs-availability.pod:131
18402 #: ../src/guestfs-availability.pod:133
18403 msgid "The following functions: L</guestfs_txz_in> L</guestfs_txz_out>"
18407 #: ../src/guestfs-availability.pod:137
18408 msgid "B<zerofree>"
18412 #: ../src/guestfs-availability.pod:139
18413 msgid "The following functions: L</guestfs_zerofree>"
18417 #: ../src/guestfs-structs.pod:1
18418 msgid "guestfs_int_bool"
18422 #: ../src/guestfs-structs.pod:3
18425 " struct guestfs_int_bool {\n"
18433 #: ../src/guestfs-structs.pod:8
18436 " struct guestfs_int_bool_list {\n"
18437 " uint32_t len; /* Number of elements in list. */\n"
18438 " struct guestfs_int_bool *val; /* Elements. */\n"
18444 #: ../src/guestfs-structs.pod:13
18447 " void guestfs_free_int_bool (struct guestfs_free_int_bool *);\n"
18448 " void guestfs_free_int_bool_list (struct guestfs_free_int_bool_list *);\n"
18453 #: ../src/guestfs-structs.pod:16
18454 msgid "guestfs_lvm_pv"
18458 #: ../src/guestfs-structs.pod:18
18461 " struct guestfs_lvm_pv {\n"
18462 " char *pv_name;\n"
18463 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
18464 " char pv_uuid[32];\n"
18466 " uint64_t pv_size;\n"
18467 " uint64_t dev_size;\n"
18468 " uint64_t pv_free;\n"
18469 " uint64_t pv_used;\n"
18470 " char *pv_attr;\n"
18471 " int64_t pv_pe_count;\n"
18472 " int64_t pv_pe_alloc_count;\n"
18473 " char *pv_tags;\n"
18474 " uint64_t pe_start;\n"
18475 " int64_t pv_mda_count;\n"
18476 " uint64_t pv_mda_free;\n"
18482 #: ../src/guestfs-structs.pod:36
18485 " struct guestfs_lvm_pv_list {\n"
18486 " uint32_t len; /* Number of elements in list. */\n"
18487 " struct guestfs_lvm_pv *val; /* Elements. */\n"
18493 #: ../src/guestfs-structs.pod:41
18496 " void guestfs_free_lvm_pv (struct guestfs_free_lvm_pv *);\n"
18497 " void guestfs_free_lvm_pv_list (struct guestfs_free_lvm_pv_list *);\n"
18502 #: ../src/guestfs-structs.pod:44
18503 msgid "guestfs_lvm_vg"
18507 #: ../src/guestfs-structs.pod:46
18510 " struct guestfs_lvm_vg {\n"
18511 " char *vg_name;\n"
18512 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
18513 " char vg_uuid[32];\n"
18515 " char *vg_attr;\n"
18516 " uint64_t vg_size;\n"
18517 " uint64_t vg_free;\n"
18518 " char *vg_sysid;\n"
18519 " uint64_t vg_extent_size;\n"
18520 " int64_t vg_extent_count;\n"
18521 " int64_t vg_free_count;\n"
18522 " int64_t max_lv;\n"
18523 " int64_t max_pv;\n"
18524 " int64_t pv_count;\n"
18525 " int64_t lv_count;\n"
18526 " int64_t snap_count;\n"
18527 " int64_t vg_seqno;\n"
18528 " char *vg_tags;\n"
18529 " int64_t vg_mda_count;\n"
18530 " uint64_t vg_mda_free;\n"
18536 #: ../src/guestfs-structs.pod:69
18539 " struct guestfs_lvm_vg_list {\n"
18540 " uint32_t len; /* Number of elements in list. */\n"
18541 " struct guestfs_lvm_vg *val; /* Elements. */\n"
18547 #: ../src/guestfs-structs.pod:74
18550 " void guestfs_free_lvm_vg (struct guestfs_free_lvm_vg *);\n"
18551 " void guestfs_free_lvm_vg_list (struct guestfs_free_lvm_vg_list *);\n"
18556 #: ../src/guestfs-structs.pod:77
18557 msgid "guestfs_lvm_lv"
18561 #: ../src/guestfs-structs.pod:79
18564 " struct guestfs_lvm_lv {\n"
18565 " char *lv_name;\n"
18566 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
18567 " char lv_uuid[32];\n"
18568 " char *lv_attr;\n"
18569 " int64_t lv_major;\n"
18570 " int64_t lv_minor;\n"
18571 " int64_t lv_kernel_major;\n"
18572 " int64_t lv_kernel_minor;\n"
18573 " uint64_t lv_size;\n"
18574 " int64_t seg_count;\n"
18576 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
18577 " float snap_percent;\n"
18578 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
18579 " float copy_percent;\n"
18580 " char *move_pv;\n"
18581 " char *lv_tags;\n"
18582 " char *mirror_log;\n"
18583 " char *modules;\n"
18589 #: ../src/guestfs-structs.pod:101
18592 " struct guestfs_lvm_lv_list {\n"
18593 " uint32_t len; /* Number of elements in list. */\n"
18594 " struct guestfs_lvm_lv *val; /* Elements. */\n"
18600 #: ../src/guestfs-structs.pod:106
18603 " void guestfs_free_lvm_lv (struct guestfs_free_lvm_lv *);\n"
18604 " void guestfs_free_lvm_lv_list (struct guestfs_free_lvm_lv_list *);\n"
18609 #: ../src/guestfs-structs.pod:111
18612 " struct guestfs_stat {\n"
18616 " int64_t nlink;\n"
18621 " int64_t blksize;\n"
18622 " int64_t blocks;\n"
18623 " int64_t atime;\n"
18624 " int64_t mtime;\n"
18625 " int64_t ctime;\n"
18631 #: ../src/guestfs-structs.pod:127
18634 " struct guestfs_stat_list {\n"
18635 " uint32_t len; /* Number of elements in list. */\n"
18636 " struct guestfs_stat *val; /* Elements. */\n"
18642 #: ../src/guestfs-structs.pod:132
18645 " void guestfs_free_stat (struct guestfs_free_stat *);\n"
18646 " void guestfs_free_stat_list (struct guestfs_free_stat_list *);\n"
18651 #: ../src/guestfs-structs.pod:137
18654 " struct guestfs_statvfs {\n"
18655 " int64_t bsize;\n"
18656 " int64_t frsize;\n"
18657 " int64_t blocks;\n"
18658 " int64_t bfree;\n"
18659 " int64_t bavail;\n"
18660 " int64_t files;\n"
18661 " int64_t ffree;\n"
18662 " int64_t favail;\n"
18665 " int64_t namemax;\n"
18671 #: ../src/guestfs-structs.pod:151
18674 " struct guestfs_statvfs_list {\n"
18675 " uint32_t len; /* Number of elements in list. */\n"
18676 " struct guestfs_statvfs *val; /* Elements. */\n"
18682 #: ../src/guestfs-structs.pod:156
18685 " void guestfs_free_statvfs (struct guestfs_free_statvfs *);\n"
18686 " void guestfs_free_statvfs_list (struct guestfs_free_statvfs_list *);\n"
18691 #: ../src/guestfs-structs.pod:159
18692 msgid "guestfs_dirent"
18696 #: ../src/guestfs-structs.pod:161
18699 " struct guestfs_dirent {\n"
18708 #: ../src/guestfs-structs.pod:167
18711 " struct guestfs_dirent_list {\n"
18712 " uint32_t len; /* Number of elements in list. */\n"
18713 " struct guestfs_dirent *val; /* Elements. */\n"
18719 #: ../src/guestfs-structs.pod:172
18722 " void guestfs_free_dirent (struct guestfs_free_dirent *);\n"
18723 " void guestfs_free_dirent_list (struct guestfs_free_dirent_list *);\n"
18728 #: ../src/guestfs-structs.pod:177
18731 " struct guestfs_version {\n"
18732 " int64_t major;\n"
18733 " int64_t minor;\n"
18734 " int64_t release;\n"
18741 #: ../src/guestfs-structs.pod:184
18744 " struct guestfs_version_list {\n"
18745 " uint32_t len; /* Number of elements in list. */\n"
18746 " struct guestfs_version *val; /* Elements. */\n"
18752 #: ../src/guestfs-structs.pod:189
18755 " void guestfs_free_version (struct guestfs_free_version *);\n"
18756 " void guestfs_free_version_list (struct guestfs_free_version_list *);\n"
18761 #: ../src/guestfs-structs.pod:192
18762 msgid "guestfs_xattr"
18766 #: ../src/guestfs-structs.pod:194
18769 " struct guestfs_xattr {\n"
18770 " char *attrname;\n"
18771 " /* The next two fields describe a byte array. */\n"
18772 " uint32_t attrval_len;\n"
18773 " char *attrval;\n"
18779 #: ../src/guestfs-structs.pod:201
18782 " struct guestfs_xattr_list {\n"
18783 " uint32_t len; /* Number of elements in list. */\n"
18784 " struct guestfs_xattr *val; /* Elements. */\n"
18790 #: ../src/guestfs-structs.pod:206
18793 " void guestfs_free_xattr (struct guestfs_free_xattr *);\n"
18794 " void guestfs_free_xattr_list (struct guestfs_free_xattr_list *);\n"
18799 #: ../src/guestfs-structs.pod:209
18800 msgid "guestfs_inotify_event"
18804 #: ../src/guestfs-structs.pod:211
18807 " struct guestfs_inotify_event {\n"
18808 " int64_t in_wd;\n"
18809 " uint32_t in_mask;\n"
18810 " uint32_t in_cookie;\n"
18811 " char *in_name;\n"
18817 #: ../src/guestfs-structs.pod:218
18820 " struct guestfs_inotify_event_list {\n"
18821 " uint32_t len; /* Number of elements in list. */\n"
18822 " struct guestfs_inotify_event *val; /* Elements. */\n"
18828 #: ../src/guestfs-structs.pod:223
18831 " void guestfs_free_inotify_event (struct guestfs_free_inotify_event *);\n"
18832 " void guestfs_free_inotify_event_list (struct guestfs_free_inotify_event_list *);\n"
18837 #: ../src/guestfs-structs.pod:226
18838 msgid "guestfs_partition"
18842 #: ../src/guestfs-structs.pod:228
18845 " struct guestfs_partition {\n"
18846 " int32_t part_num;\n"
18847 " uint64_t part_start;\n"
18848 " uint64_t part_end;\n"
18849 " uint64_t part_size;\n"
18855 #: ../src/guestfs-structs.pod:235
18858 " struct guestfs_partition_list {\n"
18859 " uint32_t len; /* Number of elements in list. */\n"
18860 " struct guestfs_partition *val; /* Elements. */\n"
18866 #: ../src/guestfs-structs.pod:240
18869 " void guestfs_free_partition (struct guestfs_free_partition *);\n"
18870 " void guestfs_free_partition_list (struct guestfs_free_partition_list *);\n"
18875 #: ../src/guestfs-structs.pod:243
18876 msgid "guestfs_application"
18880 #: ../src/guestfs-structs.pod:245
18883 " struct guestfs_application {\n"
18884 " char *app_name;\n"
18885 " char *app_display_name;\n"
18886 " int32_t app_epoch;\n"
18887 " char *app_version;\n"
18888 " char *app_release;\n"
18889 " char *app_install_path;\n"
18890 " char *app_trans_path;\n"
18891 " char *app_publisher;\n"
18892 " char *app_url;\n"
18893 " char *app_source_package;\n"
18894 " char *app_summary;\n"
18895 " char *app_description;\n"
18901 #: ../src/guestfs-structs.pod:260
18904 " struct guestfs_application_list {\n"
18905 " uint32_t len; /* Number of elements in list. */\n"
18906 " struct guestfs_application *val; /* Elements. */\n"
18912 #: ../src/guestfs-structs.pod:265
18915 " void guestfs_free_application (struct guestfs_free_application *);\n"
18916 " void guestfs_free_application_list (struct guestfs_free_application_list *);\n"
18921 #: ../fish/guestfish.pod:5
18922 msgid "guestfish - the libguestfs Filesystem Interactive SHell"
18926 #: ../fish/guestfish.pod:9
18929 " guestfish [--options] [commands]\n"
18934 #: ../fish/guestfish.pod:11
18942 #: ../fish/guestfish.pod:13
18945 " guestfish [--ro|--rw] -a disk.img\n"
18950 #: ../fish/guestfish.pod:15
18953 " guestfish [--ro|--rw] -a disk.img -m dev[:mountpoint]\n"
18958 #: ../fish/guestfish.pod:17
18961 " guestfish -d libvirt-domain\n"
18966 #: ../fish/guestfish.pod:19
18969 " guestfish [--ro|--rw] -a disk.img -i\n"
18974 #: ../fish/guestfish.pod:21
18977 " guestfish -d libvirt-domain -i\n"
18982 #: ../fish/guestfish.pod:23 ../fuse/guestmount.pod:15 ../tools/virt-edit.pl:44
18983 #: ../tools/virt-win-reg.pl:51 ../tools/virt-tar.pl:64
18988 #: ../fish/guestfish.pod:25
18990 "Using guestfish in read/write mode on live virtual machines can be "
18991 "dangerous, potentially causing disk corruption. Use the I<--ro> (read-only) "
18992 "option to use guestfish safely if the disk image or virtual machine might be "
18997 #: ../fish/guestfish.pod:32
18999 "Guestfish is a shell and command-line tool for examining and modifying "
19000 "virtual machine filesystems. It uses libguestfs and exposes all of the "
19001 "functionality of the guestfs API, see L<guestfs(3)>."
19005 #: ../fish/guestfish.pod:36
19007 "Guestfish gives you structured access to the libguestfs API, from shell "
19008 "scripts or the command line or interactively. If you want to rescue a "
19009 "broken virtual machine image, you should look at the L<virt-rescue(1)> "
19014 #: ../fish/guestfish.pod:41 ../fish/guestfish.pod:942
19015 #: ../fuse/guestmount.pod:39 ../tools/virt-edit.pl:58
19016 #: ../tools/virt-resize.pl:64 ../tools/virt-tar.pl:50
19021 #: ../fish/guestfish.pod:43
19022 msgid "As an interactive shell"
19026 #: ../fish/guestfish.pod:45
19034 #: ../fish/guestfish.pod:47
19037 " Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
19038 " editing virtual machine filesystems.\n"
19043 #: ../fish/guestfish.pod:50
19046 " Type: 'help' for a list of commands\n"
19047 " 'man' to read the manual\n"
19048 " 'quit' to quit the shell\n"
19053 #: ../fish/guestfish.pod:54
19056 " ><fs> add-ro disk.img\n"
19058 " ><fs> list-filesystems\n"
19059 " /dev/sda1: ext4\n"
19060 " /dev/vg_guest/lv_root: ext4\n"
19061 " /dev/vg_guest/lv_swap: swap\n"
19062 " ><fs> mount /dev/vg_guest/lv_root /\n"
19063 " ><fs> cat /etc/fstab\n"
19065 " # Created by anaconda\n"
19072 #: ../fish/guestfish.pod:67
19073 msgid "From shell scripts"
19077 #: ../fish/guestfish.pod:69
19078 msgid "Create a new C</etc/motd> file in a guest or disk image:"
19082 #: ../fish/guestfish.pod:71
19085 " guestfish <<_EOF_\n"
19088 " mount /dev/vg_guest/lv_root /\n"
19089 " write /etc/motd \"Welcome, new users\"\n"
19095 #: ../fish/guestfish.pod:78
19096 msgid "List the LVM logical volumes in a disk image:"
19100 #: ../fish/guestfish.pod:80
19103 " guestfish -a disk.img --ro <<_EOF_\n"
19111 #: ../fish/guestfish.pod:85
19112 msgid "List all the filesystems in a disk image:"
19116 #: ../fish/guestfish.pod:87
19119 " guestfish -a disk.img --ro <<_EOF_\n"
19121 " list-filesystems\n"
19127 #: ../fish/guestfish.pod:92
19128 msgid "On one command line"
19132 #: ../fish/guestfish.pod:94
19133 msgid "Update C</etc/resolv.conf> in a guest:"
19137 #: ../fish/guestfish.pod:96
19141 " add disk.img : run : mount /dev/vg_guest/lv_root / : \\\n"
19142 " write /etc/resolv.conf \"nameserver 1.2.3.4\"\n"
19147 #: ../fish/guestfish.pod:100
19148 msgid "Edit C</boot/grub/grub.conf> interactively:"
19152 #: ../fish/guestfish.pod:102
19155 " guestfish --rw --add disk.img \\\n"
19156 " --mount /dev/vg_guest/lv_root \\\n"
19157 " --mount /dev/sda1:/boot \\\n"
19158 " edit /boot/grub/grub.conf\n"
19163 #: ../fish/guestfish.pod:107
19164 msgid "Mount disks automatically"
19168 #: ../fish/guestfish.pod:109
19170 "Use the I<-i> option to automatically mount the disks from a virtual machine:"
19174 #: ../fish/guestfish.pod:112
19177 " guestfish --ro -a disk.img -i cat /etc/group\n"
19182 #: ../fish/guestfish.pod:114
19185 " guestfish --ro -d libvirt-domain -i cat /etc/group\n"
19190 #: ../fish/guestfish.pod:116
19191 msgid "Another way to edit C</boot/grub/grub.conf> interactively is:"
19195 #: ../fish/guestfish.pod:118
19198 " guestfish --rw -a disk.img -i edit /boot/grub/grub.conf\n"
19203 #: ../fish/guestfish.pod:120
19204 msgid "As a script interpreter"
19208 #: ../fish/guestfish.pod:122
19209 msgid "Create a 100MB disk containing an ext2-formatted partition:"
19213 #: ../fish/guestfish.pod:124
19216 " #!/usr/bin/guestfish -f\n"
19217 " sparse test1.img 100M\n"
19219 " part-disk /dev/sda mbr\n"
19220 " mkfs ext2 /dev/sda1\n"
19225 #: ../fish/guestfish.pod:130
19226 msgid "Start with a prepared disk"
19230 #: ../fish/guestfish.pod:132
19232 "An alternate way to create a 100MB disk called C<test1.img> containing a "
19233 "single ext2-formatted partition:"
19237 #: ../fish/guestfish.pod:135
19240 " guestfish -N fs\n"
19245 #: ../fish/guestfish.pod:137
19246 msgid "To list what is available do:"
19250 #: ../fish/guestfish.pod:139 ../fish/guestfish.pod:933
19253 " guestfish -N help | less\n"
19258 #: ../fish/guestfish.pod:141
19259 msgid "Remote control"
19263 #: ../fish/guestfish.pod:143
19266 " eval \"`guestfish --listen`\"\n"
19267 " guestfish --remote add-ro disk.img\n"
19268 " guestfish --remote run\n"
19269 " guestfish --remote lvs\n"
19274 #: ../fish/guestfish.pod:148 ../test-tool/libguestfs-test-tool.pod:37
19275 #: ../fuse/guestmount.pod:73 ../tools/virt-edit.pl:72
19276 #: ../tools/virt-win-reg.pl:96 ../tools/virt-resize.pl:254
19277 #: ../tools/virt-list-filesystems.pl:53 ../tools/virt-tar.pl:103
19278 #: ../tools/virt-make-fs.pl:153 ../tools/virt-list-partitions.pl:54
19283 #: ../fish/guestfish.pod:152 ../fuse/guestmount.pod:131
19284 #: ../tools/virt-edit.pl:80 ../tools/virt-win-reg.pl:104
19285 #: ../tools/virt-resize.pl:262 ../tools/virt-list-filesystems.pl:61
19286 #: ../tools/virt-tar.pl:111 ../tools/virt-make-fs.pl:161
19287 #: ../tools/virt-list-partitions.pl:62
19292 #: ../fish/guestfish.pod:154
19293 msgid "Displays general help on options."
19297 #: ../fish/guestfish.pod:156
19302 #: ../fish/guestfish.pod:158
19303 msgid "B<--cmd-help>"
19307 #: ../fish/guestfish.pod:160
19308 msgid "Lists all available guestfish commands."
19312 #: ../fish/guestfish.pod:162
19317 #: ../fish/guestfish.pod:164
19318 msgid "B<--cmd-help cmd>"
19322 #: ../fish/guestfish.pod:166
19323 msgid "Displays detailed help on a single command C<cmd>."
19327 #: ../fish/guestfish.pod:168
19328 msgid "B<-a image>"
19332 #: ../fish/guestfish.pod:170
19333 msgid "B<--add image>"
19337 #: ../fish/guestfish.pod:172
19338 msgid "Add a block device or virtual machine image to the shell."
19342 #: ../fish/guestfish.pod:174 ../fuse/guestmount.pod:81
19344 "The format of the disk image is auto-detected. To override this and force a "
19345 "particular format use the I<--format=..> option."
19349 #: ../fish/guestfish.pod:177
19351 "Using this flag is mostly equivalent to using the C<add> command, with "
19352 "C<readonly:true> if the I<--ro> flag was given, and with C<format:...> if "
19353 "the I<--format:...> flag was given."
19357 #: ../fish/guestfish.pod:181
19362 #: ../fish/guestfish.pod:183
19363 msgid "B<--connect URI>"
19367 #: ../fish/guestfish.pod:185 ../fuse/guestmount.pod:86
19369 "When used in conjunction with the I<-d> option, this specifies the libvirt "
19370 "URI to use. The default is to use the default libvirt connection."
19374 #: ../fish/guestfish.pod:189
19379 #: ../fish/guestfish.pod:191
19381 "If using the I<--listen> option and a csh-like shell, use this option. See "
19382 "section L</REMOTE CONTROL AND CSH> below."
19386 #: ../fish/guestfish.pod:194
19387 msgid "B<-d libvirt-domain>"
19391 #: ../fish/guestfish.pod:196
19392 msgid "B<--domain libvirt-domain>"
19396 #: ../fish/guestfish.pod:198 ../fuse/guestmount.pod:92
19398 "Add disks from the named libvirt domain. If the I<--ro> option is also "
19399 "used, then any libvirt domain can be used. However in write mode, only "
19400 "libvirt domains which are shut down can be named here."
19404 #: ../fish/guestfish.pod:202
19406 "Using this flag is mostly equivalent to using the C<add-domain> command, "
19407 "with C<readonly:true> if the I<--ro> flag was given, and with C<format:...> "
19408 "if the I<--format:...> flag was given."
19412 #: ../fish/guestfish.pod:206
19417 #: ../fish/guestfish.pod:208
19418 msgid "B<--no-dest-paths>"
19422 #: ../fish/guestfish.pod:210
19424 "Don't tab-complete paths on the guest filesystem. It is useful to be able "
19425 "to hit the tab key to complete paths on the guest filesystem, but this "
19426 "causes extra \"hidden\" guestfs calls to be made, so this option is here to "
19427 "allow this feature to be disabled."
19431 #: ../fish/guestfish.pod:215 ../fuse/guestmount.pod:108
19432 msgid "B<--echo-keys>"
19436 #: ../fish/guestfish.pod:217 ../fuse/guestmount.pod:110
19438 "When prompting for keys and passphrases, guestfish normally turns echoing "
19439 "off so you cannot see what you are typing. If you are not worried about "
19440 "Tempest attacks and there is no one else in the room you can specify this "
19441 "flag to see what you are typing."
19445 #: ../fish/guestfish.pod:222
19450 #: ../fish/guestfish.pod:224
19451 msgid "B<--file file>"
19455 #: ../fish/guestfish.pod:226
19456 msgid "Read commands from C<file>. To write pure guestfish scripts, use:"
19460 #: ../fish/guestfish.pod:229
19463 " #!/usr/bin/guestfish -f\n"
19468 #: ../fish/guestfish.pod:231
19469 msgid "B<--format=raw|qcow2|..>"
19473 #: ../fish/guestfish.pod:233
19474 msgid "B<--format>"
19478 #: ../fish/guestfish.pod:235 ../fuse/guestmount.pod:117
19480 "The default for the I<-a> option is to auto-detect the format of the disk "
19481 "image. Using this forces the disk format for I<-a> options which follow on "
19482 "the command line. Using I<--format> with no argument switches back to auto-"
19483 "detection for subsequent I<-a> options."
19487 #: ../fish/guestfish.pod:242
19490 " guestfish --format=raw -a disk.img\n"
19495 #: ../fish/guestfish.pod:244
19496 msgid "forces raw format (no auto-detection) for C<disk.img>."
19500 #: ../fish/guestfish.pod:246
19503 " guestfish --format=raw -a disk.img --format -a another.img\n"
19508 #: ../fish/guestfish.pod:248
19510 "forces raw format (no auto-detection) for C<disk.img> and reverts to auto-"
19511 "detection for C<another.img>."
19515 #: ../fish/guestfish.pod:251
19517 "If you have untrusted raw-format guest disk images, you should use this "
19518 "option to specify the disk format. This avoids a possible security problem "
19519 "with malicious guests (CVE-2010-3851). See also L</add-drive-opts>."
19523 #: ../fish/guestfish.pod:256
19528 #: ../fish/guestfish.pod:258
19529 msgid "B<--inspector>"
19533 #: ../fish/guestfish.pod:260 ../fuse/guestmount.pod:137
19535 "Using L<virt-inspector(1)> code, inspect the disks looking for an operating "
19536 "system and mount filesystems as they would be mounted on the real virtual "
19541 #: ../fish/guestfish.pod:264
19542 msgid "Typical usage is either:"
19546 #: ../fish/guestfish.pod:266
19549 " guestfish -d myguest -i\n"
19554 #: ../fish/guestfish.pod:268
19555 msgid "(for an inactive libvirt domain called I<myguest>), or:"
19559 #: ../fish/guestfish.pod:270
19562 " guestfish --ro -d myguest -i\n"
19567 #: ../fish/guestfish.pod:272
19568 msgid "(for active domains, readonly), or specify the block device directly:"
19572 #: ../fish/guestfish.pod:274
19575 " guestfish --rw -a /dev/Guests/MyGuest -i\n"
19580 #: ../fish/guestfish.pod:276
19582 "Note that the command line syntax changed slightly over older versions of "
19583 "guestfish. You can still use the old syntax:"
19587 #: ../fish/guestfish.pod:279
19590 " guestfish [--ro] -i disk.img\n"
19595 #: ../fish/guestfish.pod:281
19598 " guestfish [--ro] -i libvirt-domain\n"
19603 #: ../fish/guestfish.pod:283
19605 "Using this flag is mostly equivalent to using the C<inspect-os> command and "
19606 "then using other commands to mount the filesystems that were found."
19610 #: ../fish/guestfish.pod:287 ../fuse/guestmount.pod:141
19611 msgid "B<--keys-from-stdin>"
19615 #: ../fish/guestfish.pod:289 ../fuse/guestmount.pod:143
19617 "Read key or passphrase parameters from stdin. The default is to try to read "
19618 "passphrases from the user by opening C</dev/tty>."
19622 #: ../fish/guestfish.pod:292
19623 msgid "B<--listen>"
19627 #: ../fish/guestfish.pod:294
19629 "Fork into the background and listen for remote commands. See section L</"
19630 "REMOTE CONTROL GUESTFISH OVER A SOCKET> below."
19634 #: ../fish/guestfish.pod:297 ../fuse/guestmount.pod:146
19639 #: ../fish/guestfish.pod:299 ../fuse/guestmount.pod:148
19641 "Connect to a live virtual machine. (Experimental, see L<guestfs(3)/"
19642 "ATTACHING TO RUNNING DAEMONS>)."
19646 #: ../fish/guestfish.pod:302 ../fuse/guestmount.pod:151
19647 msgid "B<-m dev[:mountpoint[:options]]>"
19651 #: ../fish/guestfish.pod:304 ../fuse/guestmount.pod:153
19652 msgid "B<--mount dev[:mountpoint[:options]]>"
19656 #: ../fish/guestfish.pod:306
19657 msgid "Mount the named partition or logical volume on the given mountpoint."
19661 #: ../fish/guestfish.pod:308
19662 msgid "If the mountpoint is omitted, it defaults to C</>."
19666 #: ../fish/guestfish.pod:310
19667 msgid "You have to mount something on C</> before most commands will work."
19671 #: ../fish/guestfish.pod:312
19673 "If any I<-m> or I<--mount> options are given, the guest is automatically "
19678 #: ../fish/guestfish.pod:315
19680 "If you don't know what filesystems a disk image contains, you can either run "
19681 "guestfish without this option, then list the partitions, filesystems and LVs "
19682 "available (see L</list-partitions>, L</list-filesystems> and L</lvs> "
19683 "commands), or you can use the L<virt-filesystems(1)> program."
19687 #: ../fish/guestfish.pod:321 ../fuse/guestmount.pod:161
19689 "The third (and rarely used) part of the mount parameter is the list of mount "
19690 "options used to mount the underlying filesystem. If this is not given, then "
19691 "the mount options are either the empty string or C<ro> (the latter if the "
19692 "I<--ro> flag is used). By specifying the mount options, you override this "
19693 "default choice. Probably the only time you would use this is to enable ACLs "
19694 "and/or extended attributes if the filesystem can support them:"
19698 #: ../fish/guestfish.pod:329 ../fuse/guestmount.pod:169
19701 " -m /dev/sda1:/:acl,user_xattr\n"
19706 #: ../fish/guestfish.pod:331
19707 msgid "Using this flag is equivalent to using the C<mount-options> command."
19711 #: ../fish/guestfish.pod:333
19716 #: ../fish/guestfish.pod:335
19717 msgid "B<--no-sync>"
19721 #: ../fish/guestfish.pod:337
19723 "Disable autosync. This is enabled by default. See the discussion of "
19724 "autosync in the L<guestfs(3)> manpage."
19728 #: ../fish/guestfish.pod:340
19733 #: ../fish/guestfish.pod:342
19734 msgid "B<--new type>"
19738 #: ../fish/guestfish.pod:344
19743 #: ../fish/guestfish.pod:346
19745 "Prepare a fresh disk image formatted as \"type\". This is an alternative to "
19746 "the I<-a> option: whereas I<-a> adds an existing disk, I<-N> creates a "
19747 "preformatted disk with a filesystem and adds it. See L</PREPARED DISK "
19752 #: ../fish/guestfish.pod:351
19753 msgid "B<--progress-bars>"
19757 #: ../fish/guestfish.pod:353
19758 msgid "Enable progress bars, even when guestfish is used non-interactively."
19762 #: ../fish/guestfish.pod:355
19764 "Progress bars are enabled by default when guestfish is used as an "
19765 "interactive shell."
19769 #: ../fish/guestfish.pod:358
19770 msgid "B<--no-progress-bars>"
19774 #: ../fish/guestfish.pod:360
19775 msgid "Disable progress bars."
19779 #: ../fish/guestfish.pod:362
19780 msgid "B<--remote[=pid]>"
19784 #: ../fish/guestfish.pod:364
19786 "Send remote commands to C<$GUESTFISH_PID> or C<pid>. See section L</REMOTE "
19787 "CONTROL GUESTFISH OVER A SOCKET> below."
19791 #: ../fish/guestfish.pod:367
19796 #: ../fish/guestfish.pod:369
19801 #: ../fish/guestfish.pod:371
19803 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
19804 "mounts are done read-only."
19808 #: ../fish/guestfish.pod:374
19810 "The option must always be used if the disk image or virtual machine might be "
19811 "running, and is generally recommended in cases where you don't need write "
19812 "access to the disk."
19816 #: ../fish/guestfish.pod:378
19818 "Note that prepared disk images created with I<-N> are not affected by this "
19819 "option. Also commands like C<add> are not affected - you have to specify "
19820 "the C<readonly:true> option explicitly if you need it."
19824 #: ../fish/guestfish.pod:382
19825 msgid "See also L</OPENING DISKS FOR READ AND WRITE> below."
19829 #: ../fish/guestfish.pod:384 ../fuse/guestmount.pod:225
19830 msgid "B<--selinux>"
19834 #: ../fish/guestfish.pod:386
19835 msgid "Enable SELinux support for the guest. See L<guestfs(3)/SELINUX>."
19839 #: ../fish/guestfish.pod:388
19844 #: ../fish/guestfish.pod:390
19845 msgid "B<--verbose>"
19849 #: ../fish/guestfish.pod:392
19851 "Enable very verbose messages. This is particularly useful if you find a bug."
19855 #: ../fish/guestfish.pod:395
19860 #: ../fish/guestfish.pod:397 ../tools/virt-edit.pl:88
19861 #: ../tools/virt-win-reg.pl:112 ../tools/virt-resize.pl:270
19862 #: ../tools/virt-list-filesystems.pl:69 ../tools/virt-tar.pl:119
19863 #: ../tools/virt-make-fs.pl:169 ../tools/virt-list-partitions.pl:70
19864 msgid "B<--version>"
19868 #: ../fish/guestfish.pod:399
19869 msgid "Display the guestfish / libguestfs version number and exit."
19873 #: ../fish/guestfish.pod:401
19878 #: ../fish/guestfish.pod:403
19883 #: ../fish/guestfish.pod:405 ../fuse/guestmount.pod:239
19885 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
19886 "mounts are done read-write."
19890 #: ../fish/guestfish.pod:408
19891 msgid "See L</OPENING DISKS FOR READ AND WRITE> below."
19895 #: ../fish/guestfish.pod:410
19900 #: ../fish/guestfish.pod:412
19901 msgid "Echo each command before executing it."
19905 #: ../fish/guestfish.pod:416
19906 msgid "COMMANDS ON COMMAND LINE"
19910 #: ../fish/guestfish.pod:418
19912 "Any additional (non-option) arguments are treated as commands to execute."
19916 #: ../fish/guestfish.pod:421
19918 "Commands to execute should be separated by a colon (C<:>), where the colon "
19919 "is a separate parameter. Thus:"
19923 #: ../fish/guestfish.pod:424
19926 " guestfish cmd [args...] : cmd [args...] : cmd [args...] ...\n"
19931 #: ../fish/guestfish.pod:426
19933 "If there are no additional arguments, then we enter a shell, either an "
19934 "interactive shell with a prompt (if the input is a terminal) or a non-"
19935 "interactive shell."
19939 #: ../fish/guestfish.pod:430
19941 "In either command line mode or non-interactive shell, the first command that "
19942 "gives an error causes the whole shell to exit. In interactive mode (with a "
19943 "prompt) if a command fails, you can continue to enter commands."
19947 #: ../fish/guestfish.pod:435
19948 msgid "USING launch (OR run)"
19952 #: ../fish/guestfish.pod:437
19954 "As with L<guestfs(3)>, you must first configure your guest by adding disks, "
19955 "then launch it, then mount any disks you need, and finally issue actions/"
19956 "commands. So the general order of the day is:"
19960 #: ../fish/guestfish.pod:445
19961 msgid "add or -a/--add"
19965 #: ../fish/guestfish.pod:449
19966 msgid "launch (aka run)"
19970 #: ../fish/guestfish.pod:453
19971 msgid "mount or -m/--mount"
19975 #: ../fish/guestfish.pod:457
19976 msgid "any other commands"
19980 #: ../fish/guestfish.pod:461
19982 "C<run> is a synonym for C<launch>. You must C<launch> (or C<run>) your "
19983 "guest before mounting or performing any other commands."
19987 #: ../fish/guestfish.pod:464
19989 "The only exception is that if any of the I<-i>, I<-m>, I<--mount>, I<-N> or "
19990 "I<--new> options were given then C<run> is done automatically, simply "
19991 "because guestfish can't perform the action you asked for without doing this."
19995 #: ../fish/guestfish.pod:469
19996 msgid "OPENING DISKS FOR READ AND WRITE"
20000 #: ../fish/guestfish.pod:471
20002 "The guestfish, L<guestmount(1)> and L<virt-rescue(1)> options I<--ro> and "
20003 "I<--rw> affect whether the other command line options I<-a>, I<-c>, I<-d>, "
20004 "I<-i> and I<-m> open disk images read-only or for writing."
20008 #: ../fish/guestfish.pod:476
20010 "In libguestfs E<le> 1.8, guestfish, guestmount and virt-rescue defaulted to "
20011 "opening disk images supplied on the command line for write. To open a disk "
20012 "image read-only you have to do I<-a image --ro>."
20016 #: ../fish/guestfish.pod:480
20018 "This matters: If you accidentally open a live VM disk image writable then "
20019 "you will cause irreversible disk corruption."
20023 #: ../fish/guestfish.pod:483
20025 "By libguestfs 1.10 we intend to change the default the other way. Disk "
20026 "images will be opened read-only. You will have to either specify "
20027 "I<guestfish --rw>, I<guestmount --rw>, I<virt-rescue --rw>, or change the "
20028 "configuration file C</etc/libguestfs-tools.conf> in order to get write "
20029 "access for disk images specified by those other command line options."
20033 #: ../fish/guestfish.pod:490
20035 "This version of guestfish, guestmount and virt-rescue has a I<--rw> option "
20036 "which does nothing (it is already the default). However it is highly "
20037 "recommended that you use this option to indicate that you need write access, "
20038 "and prepare your scripts for the day when this option will be required for "
20043 #: ../fish/guestfish.pod:496
20045 "B<Note:> This does I<not> affect commands like L</add> and L</mount>, or any "
20046 "other libguestfs program apart from guestfish and guestmount."
20050 #: ../fish/guestfish.pod:499
20055 #: ../fish/guestfish.pod:501
20057 "You can quote ordinary parameters using either single or double quotes. For "
20062 #: ../fish/guestfish.pod:504
20065 " add \"file with a space.img\"\n"
20070 #: ../fish/guestfish.pod:506
20073 " rm '/file name'\n"
20078 #: ../fish/guestfish.pod:508
20086 #: ../fish/guestfish.pod:510
20088 "A few commands require a list of strings to be passed. For these, use a "
20089 "whitespace-separated list, enclosed in quotes. Strings containing "
20090 "whitespace to be passed through must be enclosed in single quotes. A "
20091 "literal single quote must be escaped with a backslash."
20095 #: ../fish/guestfish.pod:515
20098 " vgcreate VG \"/dev/sda1 /dev/sdb1\"\n"
20099 " command \"/bin/echo 'foo bar'\"\n"
20100 " command \"/bin/echo \\'foo\\'\"\n"
20105 #: ../fish/guestfish.pod:519
20106 msgid "OPTIONAL ARGUMENTS"
20110 #: ../fish/guestfish.pod:521
20112 "Some commands take optional arguments. These arguments appear in this "
20113 "documentation as C<[argname:..]>. You can use them as in these examples:"
20117 #: ../fish/guestfish.pod:525
20120 " add-drive-opts filename\n"
20125 #: ../fish/guestfish.pod:527
20128 " add-drive-opts filename readonly:true\n"
20133 #: ../fish/guestfish.pod:529
20136 " add-drive-opts filename format:qcow2 readonly:false\n"
20141 #: ../fish/guestfish.pod:531
20143 "Each optional argument can appear at most once. All optional arguments must "
20144 "appear after the required ones."
20148 #: ../fish/guestfish.pod:534
20153 #: ../fish/guestfish.pod:536
20155 "This section applies to all commands which can take integers as parameters."
20159 #: ../fish/guestfish.pod:539
20160 msgid "SIZE SUFFIX"
20164 #: ../fish/guestfish.pod:541
20166 "When the command takes a parameter measured in bytes, you can use one of the "
20167 "following suffixes to specify kilobytes, megabytes and larger sizes:"
20171 #: ../fish/guestfish.pod:547
20172 msgid "B<k> or B<K> or B<KiB>"
20176 #: ../fish/guestfish.pod:549
20177 msgid "The size in kilobytes (multiplied by 1024)."
20181 #: ../fish/guestfish.pod:551
20186 #: ../fish/guestfish.pod:553
20187 msgid "The size in SI 1000 byte units."
20191 #: ../fish/guestfish.pod:555
20192 msgid "B<M> or B<MiB>"
20196 #: ../fish/guestfish.pod:557
20197 msgid "The size in megabytes (multiplied by 1048576)."
20201 #: ../fish/guestfish.pod:559
20206 #: ../fish/guestfish.pod:561
20207 msgid "The size in SI 1000000 byte units."
20211 #: ../fish/guestfish.pod:563
20212 msgid "B<G> or B<GiB>"
20216 #: ../fish/guestfish.pod:565
20217 msgid "The size in gigabytes (multiplied by 2**30)."
20221 #: ../fish/guestfish.pod:567
20226 #: ../fish/guestfish.pod:569
20227 msgid "The size in SI 10**9 byte units."
20231 #: ../fish/guestfish.pod:571
20232 msgid "B<T> or B<TiB>"
20236 #: ../fish/guestfish.pod:573
20237 msgid "The size in terabytes (multiplied by 2**40)."
20241 #: ../fish/guestfish.pod:575
20246 #: ../fish/guestfish.pod:577
20247 msgid "The size in SI 10**12 byte units."
20251 #: ../fish/guestfish.pod:579
20252 msgid "B<P> or B<PiB>"
20256 #: ../fish/guestfish.pod:581
20257 msgid "The size in petabytes (multiplied by 2**50)."
20261 #: ../fish/guestfish.pod:583
20266 #: ../fish/guestfish.pod:585
20267 msgid "The size in SI 10**15 byte units."
20271 #: ../fish/guestfish.pod:587
20272 msgid "B<E> or B<EiB>"
20276 #: ../fish/guestfish.pod:589
20277 msgid "The size in exabytes (multiplied by 2**60)."
20281 #: ../fish/guestfish.pod:591
20286 #: ../fish/guestfish.pod:593
20287 msgid "The size in SI 10**18 byte units."
20291 #: ../fish/guestfish.pod:595
20292 msgid "B<Z> or B<ZiB>"
20296 #: ../fish/guestfish.pod:597
20297 msgid "The size in zettabytes (multiplied by 2**70)."
20301 #: ../fish/guestfish.pod:599
20306 #: ../fish/guestfish.pod:601
20307 msgid "The size in SI 10**21 byte units."
20311 #: ../fish/guestfish.pod:603
20312 msgid "B<Y> or B<YiB>"
20316 #: ../fish/guestfish.pod:605
20317 msgid "The size in yottabytes (multiplied by 2**80)."
20321 #: ../fish/guestfish.pod:607
20326 #: ../fish/guestfish.pod:609
20327 msgid "The size in SI 10**24 byte units."
20331 #: ../fish/guestfish.pod:615
20334 " truncate-size /file 1G\n"
20339 #: ../fish/guestfish.pod:617
20340 msgid "would truncate the file to 1 gigabyte."
20344 #: ../fish/guestfish.pod:619
20346 "Be careful because a few commands take sizes in kilobytes or megabytes (eg. "
20347 "the parameter to L</memsize> is specified in megabytes already). Adding a "
20348 "suffix will probably not do what you expect."
20352 #: ../fish/guestfish.pod:623
20353 msgid "OCTAL AND HEXADECIMAL NUMBERS"
20357 #: ../fish/guestfish.pod:625
20359 "For specifying the radix (base) use the C convention: C<0> to prefix an "
20360 "octal number or C<0x> to prefix a hexadecimal number. For example:"
20364 #: ../fish/guestfish.pod:628
20367 " 1234 decimal number 1234\n"
20368 " 02322 octal number, equivalent to decimal 1234\n"
20369 " 0x4d2 hexadecimal number, equivalent to decimal 1234\n"
20374 #: ../fish/guestfish.pod:632
20376 "When using the C<chmod> command, you almost always want to specify an octal "
20377 "number for the mode, and you must prefix it with C<0> (unlike the Unix "
20378 "L<chmod(1)> program):"
20382 #: ../fish/guestfish.pod:636
20385 " chmod 0777 /public # OK\n"
20386 " chmod 777 /public # WRONG! This is mode 777 decimal = 01411 octal.\n"
20391 #: ../fish/guestfish.pod:639
20393 "Commands that return numbers usually print them in decimal, but some "
20394 "commands print numbers in other radices (eg. C<umask> prints the mode in "
20395 "octal, preceeded by C<0>)."
20399 #: ../fish/guestfish.pod:643
20400 msgid "WILDCARDS AND GLOBBING"
20404 #: ../fish/guestfish.pod:645
20406 "Neither guestfish nor the underlying guestfs API performs wildcard expansion "
20407 "(globbing) by default. So for example the following will not do what you "
20412 #: ../fish/guestfish.pod:649
20420 #: ../fish/guestfish.pod:651
20422 "Assuming you don't have a directory called literally C</home/*> then the "
20423 "above command will return an error."
20427 #: ../fish/guestfish.pod:654
20428 msgid "To perform wildcard expansion, use the C<glob> command."
20432 #: ../fish/guestfish.pod:656
20435 " glob rm-rf /home/*\n"
20440 #: ../fish/guestfish.pod:658
20442 "runs C<rm-rf> on each path that matches (ie. potentially running the command "
20443 "many times), equivalent to:"
20447 #: ../fish/guestfish.pod:661
20450 " rm-rf /home/jim\n"
20451 " rm-rf /home/joe\n"
20452 " rm-rf /home/mary\n"
20457 #: ../fish/guestfish.pod:665
20458 msgid "C<glob> only works on simple guest paths and not on device names."
20462 #: ../fish/guestfish.pod:667
20464 "If you have several parameters, each containing a wildcard, then glob will "
20465 "perform a Cartesian product."
20469 #: ../fish/guestfish.pod:670
20474 #: ../fish/guestfish.pod:672
20476 "Any line which starts with a I<#> character is treated as a comment and "
20477 "ignored. The I<#> can optionally be preceeded by whitespace, but B<not> by "
20478 "a command. For example:"
20482 #: ../fish/guestfish.pod:676
20485 " # this is a comment\n"
20486 " # this is a comment\n"
20487 " foo # NOT a comment\n"
20492 #: ../fish/guestfish.pod:680
20493 msgid "Blank lines are also ignored."
20497 #: ../fish/guestfish.pod:682
20498 msgid "RUNNING COMMANDS LOCALLY"
20502 #: ../fish/guestfish.pod:684
20504 "Any line which starts with a I<!> character is treated as a command sent to "
20505 "the local shell (C</bin/sh> or whatever L<system(3)> uses). For example:"
20509 #: ../fish/guestfish.pod:688
20513 " tgz-out /remote local/remote-data.tar.gz\n"
20518 #: ../fish/guestfish.pod:691
20520 "will create a directory C<local> on the host, and then export the contents "
20521 "of C</remote> on the mounted filesystem to C<local/remote-data.tar.gz>. "
20522 "(See C<tgz-out>)."
20526 #: ../fish/guestfish.pod:695
20528 "To change the local directory, use the C<lcd> command. C<!cd> will have no "
20529 "effect, due to the way that subprocesses work in Unix."
20533 #: ../fish/guestfish.pod:698
20534 msgid "LOCAL COMMANDS WITH INLINE EXECUTION"
20538 #: ../fish/guestfish.pod:700
20540 "If a line starts with I<E<lt>!> then the shell command is executed (as for "
20541 "I<!>), but subsequently any output (stdout) of the shell command is parsed "
20542 "and executed as guestfish commands."
20546 #: ../fish/guestfish.pod:704
20548 "Thus you can use shell script to construct arbitrary guestfish commands "
20549 "which are then parsed by guestfish."
20553 #: ../fish/guestfish.pod:707
20555 "For example it is tedious to create a sequence of files (eg. C</foo.1> "
20556 "through C</foo.100>) using guestfish commands alone. However this is simple "
20557 "if we use a shell script to create the guestfish commands for us:"
20561 #: ../fish/guestfish.pod:712
20564 " <! for n in `seq 1 100`; do echo write /foo.$n $n; done\n"
20569 #: ../fish/guestfish.pod:714
20570 msgid "or with names like C</foo.001>:"
20574 #: ../fish/guestfish.pod:716
20577 " <! for n in `seq 1 100`; do printf \"write /foo.%03d %d\\n\" $n $n; done\n"
20582 #: ../fish/guestfish.pod:718
20584 "When using guestfish interactively it can be helpful to just run the shell "
20585 "script first (ie. remove the initial C<E<lt>> character so it is just an "
20586 "ordinary I<!> local command), see what guestfish commands it would run, and "
20587 "when you are happy with those prepend the C<E<lt>> character to run the "
20588 "guestfish commands for real."
20592 #: ../fish/guestfish.pod:724
20597 #: ../fish/guestfish.pod:726
20599 "Use C<command E<lt>spaceE<gt> | command> to pipe the output of the first "
20600 "command (a guestfish command) to the second command (any host command). For "
20605 #: ../fish/guestfish.pod:730
20608 " cat /etc/passwd | awk -F: '$3 == 0 { print }'\n"
20613 #: ../fish/guestfish.pod:732
20615 "(where C<cat> is the guestfish cat command, but C<awk> is the host awk "
20616 "program). The above command would list all accounts in the guest filesystem "
20617 "which have UID 0, ie. root accounts including backdoors. Other examples:"
20621 #: ../fish/guestfish.pod:737
20624 " hexdump /bin/ls | head\n"
20625 " list-devices | tail -1\n"
20626 " tgz-out / - | tar ztf -\n"
20631 #: ../fish/guestfish.pod:741
20633 "The space before the pipe symbol is required, any space after the pipe "
20634 "symbol is optional. Everything after the pipe symbol is just passed "
20635 "straight to the host shell, so it can contain redirections, globs and "
20636 "anything else that makes sense on the host side."
20640 #: ../fish/guestfish.pod:746
20642 "To use a literal argument which begins with a pipe symbol, you have to quote "
20647 #: ../fish/guestfish.pod:749
20655 #: ../fish/guestfish.pod:751
20656 msgid "HOME DIRECTORIES"
20660 #: ../fish/guestfish.pod:753
20662 "If a parameter starts with the character C<~> then the tilde may be expanded "
20663 "as a home directory path (either C<~> for the current user's home directory, "
20664 "or C<~user> for another user)."
20668 #: ../fish/guestfish.pod:757
20670 "Note that home directory expansion happens for users known I<on the host>, "
20671 "not in the guest filesystem."
20675 #: ../fish/guestfish.pod:760
20677 "To use a literal argument which begins with a tilde, you have to quote it, "
20682 #: ../fish/guestfish.pod:763
20690 #: ../fish/guestfish.pod:767
20692 "Libguestfs has some support for Linux guests encrypted according to the "
20693 "Linux Unified Key Setup (LUKS) standard, which includes nearly all whole "
20694 "disk encryption systems used by modern Linux guests. Currently only LVM-on-"
20695 "LUKS is supported."
20699 #: ../fish/guestfish.pod:772
20700 msgid "Identify encrypted block devices and partitions using L</vfs-type>:"
20704 #: ../fish/guestfish.pod:774
20707 " ><fs> vfs-type /dev/sda2\n"
20713 #: ../fish/guestfish.pod:777
20715 "Then open those devices using L</luks-open>. This creates a device-mapper "
20716 "device called C</dev/mapper/luksdev>."
20720 #: ../fish/guestfish.pod:780
20723 " ><fs> luks-open /dev/sda2 luksdev\n"
20724 " Enter key or passphrase (\"key\"): <enter the passphrase>\n"
20729 #: ../fish/guestfish.pod:783
20731 "Finally you have to tell LVM to scan for volume groups on the newly created "
20736 #: ../fish/guestfish.pod:786
20740 " vg-activate-all true\n"
20745 #: ../fish/guestfish.pod:789
20746 msgid "The logical volume(s) can now be mounted in the usual way."
20750 #: ../fish/guestfish.pod:791
20752 "Before closing a LUKS device you must unmount any logical volumes on it and "
20753 "deactivate the volume groups by calling C<vg-activate false VG> on each "
20754 "one. Then you can close the mapper device:"
20758 #: ../fish/guestfish.pod:795
20761 " vg-activate false /dev/VG\n"
20762 " luks-close /dev/mapper/luksdev\n"
20767 #: ../fish/guestfish.pod:798
20768 msgid "WINDOWS PATHS"
20772 #: ../fish/guestfish.pod:800
20774 "If a path is prefixed with C<win:> then you can use Windows-style paths "
20775 "(with some limitations). The following commands are equivalent:"
20779 #: ../fish/guestfish.pod:803
20782 " file /WINDOWS/system32/config/system.LOG\n"
20787 #: ../fish/guestfish.pod:805
20790 " file win:/windows/system32/config/system.log\n"
20795 #: ../fish/guestfish.pod:807
20798 " file win:\\windows\\system32\\config\\system.log\n"
20803 #: ../fish/guestfish.pod:809
20806 " file WIN:C:\\Windows\\SYSTEM32\\conFIG\\SYSTEM.LOG\n"
20811 #: ../fish/guestfish.pod:811
20813 "This syntax implicitly calls C<case-sensitive-path> (q.v.) so it also "
20814 "handles case insensitivity like Windows would. This only works in argument "
20815 "positions that expect a path."
20819 #: ../fish/guestfish.pod:815
20820 msgid "UPLOADING AND DOWNLOADING FILES"
20824 #: ../fish/guestfish.pod:817
20826 "For commands such as C<upload>, C<download>, C<tar-in>, C<tar-out> and "
20827 "others which upload from or download to a local file, you can use the "
20828 "special filename C<-> to mean \"from stdin\" or \"to stdout\". For example:"
20832 #: ../fish/guestfish.pod:821
20840 #: ../fish/guestfish.pod:823
20842 "reads stdin and creates from that a file C</foo> in the disk image, and:"
20846 #: ../fish/guestfish.pod:826
20849 " tar-out /etc - | tar tf -\n"
20854 #: ../fish/guestfish.pod:828
20856 "writes the tarball to stdout and then pipes that into the external \"tar\" "
20857 "command (see L</PIPES>)."
20861 #: ../fish/guestfish.pod:831
20863 "When using C<-> to read from stdin, the input is read up to the end of "
20864 "stdin. You can also use a special \"heredoc\"-like syntax to read up to "
20865 "some arbitrary end marker:"
20869 #: ../fish/guestfish.pod:835
20872 " upload -<<END /foo\n"
20881 #: ../fish/guestfish.pod:841
20883 "Any string of characters can be used instead of C<END>. The end marker must "
20884 "appear on a line of its own, without any preceeding or following characters "
20885 "(not even spaces)."
20889 #: ../fish/guestfish.pod:845
20891 "Note that the C<-E<lt>E<lt>> syntax only applies to parameters used to "
20892 "upload local files (so-called \"FileIn\" parameters in the generator)."
20896 #: ../fish/guestfish.pod:848
20897 msgid "EXIT ON ERROR BEHAVIOUR"
20901 #: ../fish/guestfish.pod:850
20903 "By default, guestfish will ignore any errors when in interactive mode (ie. "
20904 "taking commands from a human over a tty), and will exit on the first error "
20905 "in non-interactive mode (scripts, commands given on the command line)."
20909 #: ../fish/guestfish.pod:855
20911 "If you prefix a command with a I<-> character, then that command will not "
20912 "cause guestfish to exit, even if that (one) command returns an error."
20916 #: ../fish/guestfish.pod:859
20917 msgid "REMOTE CONTROL GUESTFISH OVER A SOCKET"
20921 #: ../fish/guestfish.pod:861
20923 "Guestfish can be remote-controlled over a socket. This is useful "
20924 "particularly in shell scripts where you want to make several different "
20925 "changes to a filesystem, but you don't want the overhead of starting up a "
20926 "guestfish process each time."
20930 #: ../fish/guestfish.pod:866
20931 msgid "Start a guestfish server process using:"
20935 #: ../fish/guestfish.pod:868
20938 " eval \"`guestfish --listen`\"\n"
20943 #: ../fish/guestfish.pod:870
20944 msgid "and then send it commands by doing:"
20948 #: ../fish/guestfish.pod:872
20951 " guestfish --remote cmd [...]\n"
20956 #: ../fish/guestfish.pod:874
20957 msgid "To cause the server to exit, send it the exit command:"
20961 #: ../fish/guestfish.pod:876
20964 " guestfish --remote exit\n"
20969 #: ../fish/guestfish.pod:878
20971 "Note that the server will normally exit if there is an error in a command. "
20972 "You can change this in the usual way. See section L</EXIT ON ERROR "
20977 #: ../fish/guestfish.pod:882
20978 msgid "CONTROLLING MULTIPLE GUESTFISH PROCESSES"
20982 #: ../fish/guestfish.pod:884
20984 "The C<eval> statement sets the environment variable C<$GUESTFISH_PID>, which "
20985 "is how the I<--remote> option knows where to send the commands. You can "
20986 "have several guestfish listener processes running using:"
20990 #: ../fish/guestfish.pod:888
20993 " eval \"`guestfish --listen`\"\n"
20994 " pid1=$GUESTFISH_PID\n"
20995 " eval \"`guestfish --listen`\"\n"
20996 " pid2=$GUESTFISH_PID\n"
20998 " guestfish --remote=$pid1 cmd\n"
20999 " guestfish --remote=$pid2 cmd\n"
21004 #: ../fish/guestfish.pod:896
21005 msgid "REMOTE CONTROL AND CSH"
21009 #: ../fish/guestfish.pod:898
21011 "When using csh-like shells (csh, tcsh etc) you have to add the I<--csh> "
21016 #: ../fish/guestfish.pod:901
21019 " eval \"`guestfish --listen --csh`\"\n"
21024 #: ../fish/guestfish.pod:903
21025 msgid "REMOTE CONTROL DETAILS"
21029 #: ../fish/guestfish.pod:905
21031 "Remote control happens over a Unix domain socket called C</tmp/.guestfish-"
21032 "$UID/socket-$PID>, where C<$UID> is the effective user ID of the process, "
21033 "and C<$PID> is the process ID of the server."
21037 #: ../fish/guestfish.pod:909
21038 msgid "Guestfish client and server versions must match exactly."
21042 #: ../fish/guestfish.pod:911
21043 msgid "PREPARED DISK IMAGES"
21047 #: ../fish/guestfish.pod:913
21049 "Use the I<-N type> or I<--new type> parameter to select one of a set of "
21050 "preformatted disk images that guestfish can make for you to save typing. "
21051 "This is particularly useful for testing purposes. This option is used "
21052 "instead of the I<-a> option, and like I<-a> can appear multiple times (and "
21053 "can be mixed with I<-a>)."
21057 #: ../fish/guestfish.pod:919
21059 "The new disk is called C<test1.img> for the first I<-N>, C<test2.img> for "
21060 "the second and so on. Existing files in the current directory are "
21065 #: ../fish/guestfish.pod:923
21067 "The type briefly describes how the disk should be sized, partitioned, how "
21068 "filesystem(s) should be created, and how content should be added. "
21069 "Optionally the type can be followed by extra parameters, separated by C<:> "
21070 "(colon) characters. For example, I<-N fs> creates a default 100MB, sparsely-"
21071 "allocated disk, containing a single partition, with the partition formatted "
21072 "as ext2. I<-N fs:ext4:1G> is the same, but for an ext4 filesystem on a 1GB "
21077 #: ../fish/guestfish.pod:931
21078 msgid "To list the available types and any extra parameters they take, run:"
21082 #: ../fish/guestfish.pod:935
21084 "Note that the prepared filesystem is not mounted. You would usually have to "
21085 "use the C<mount /dev/sda1 /> command or add the I<-m /dev/sda1> option."
21089 #: ../fish/guestfish.pod:939
21091 "If any I<-N> or I<--new> options are given, the guest is automatically "
21096 #: ../fish/guestfish.pod:944
21097 msgid "Create a 100MB disk with an ext4-formatted partition:"
21101 #: ../fish/guestfish.pod:946
21104 " guestfish -N fs:ext4\n"
21109 #: ../fish/guestfish.pod:948
21110 msgid "Create a 32MB disk with a VFAT-formatted partition, and mount it:"
21114 #: ../fish/guestfish.pod:950
21117 " guestfish -N fs:vfat:32M -m /dev/sda1\n"
21122 #: ../fish/guestfish.pod:952
21123 msgid "Create a blank 200MB disk:"
21127 #: ../fish/guestfish.pod:954
21130 " guestfish -N disk:200M\n"
21135 #: ../fish/guestfish.pod:956
21136 msgid "PROGRESS BARS"
21140 #: ../fish/guestfish.pod:958
21142 "Some (not all) long-running commands send progress notification messages as "
21143 "they are running. Guestfish turns these messages into progress bars."
21147 #: ../fish/guestfish.pod:962
21149 "When a command that supports progress bars takes longer than two seconds to "
21150 "run, and if progress bars are enabled, then you will see one appearing below "
21155 #: ../fish/guestfish.pod:966
21158 " ><fs> copy-size /large-file /another-file 2048M\n"
21159 " / 10% [#####-----------------------------------------] 00:30\n"
21164 #: ../fish/guestfish.pod:969
21166 "The spinner on the left hand side moves round once for every progress "
21167 "notification received from the backend. This is a (reasonably) golden "
21168 "assurance that the command is \"doing something\" even if the progress bar "
21169 "is not moving, because the command is able to send the progress "
21170 "notifications. When the bar reaches 100% and the command finishes, the "
21171 "spinner disappears."
21175 #: ../fish/guestfish.pod:976
21177 "Progress bars are enabled by default when guestfish is used interactively. "
21178 "You can enable them even for non-interactive modes using I<--progress-bars>, "
21179 "and you can disable them completely using I<--no-progress-bars>."
21183 #: ../fish/guestfish.pod:981
21184 msgid "GUESTFISH COMMANDS"
21188 #: ../fish/guestfish.pod:983
21190 "The commands in this section are guestfish convenience commands, in other "
21191 "words, they are not part of the L<guestfs(3)> API."
21195 #: ../fish/guestfish.pod:986
21200 #: ../fish/guestfish.pod:988
21209 #: ../fish/guestfish.pod:991
21210 msgid "Without any parameter, this provides general help."
21214 #: ../fish/guestfish.pod:993
21215 msgid "With a C<cmd> parameter, this displays detailed help for that command."
21219 #: ../fish/guestfish.pod:995
21220 msgid "quit | exit"
21224 #: ../fish/guestfish.pod:997
21225 msgid "This exits guestfish. You can also use C<^D> key."
21229 #: ../fish/guestfish.pod:999
21230 msgid "@FISH_COMMANDS@"
21234 #: ../fish/guestfish.pod:1001
21239 #: ../fish/guestfish.pod:1005 ../test-tool/libguestfs-test-tool.pod:83
21244 #: ../fish/guestfish.pod:1007
21246 "guestfish returns 0 if the commands completed without error, or 1 if there "
21251 #: ../fish/guestfish.pod:1014
21256 #: ../fish/guestfish.pod:1016
21258 "The C<edit> command uses C<$EDITOR> as the editor. If not set, it uses "
21263 #: ../fish/guestfish.pod:1019
21264 msgid "GUESTFISH_PID"
21268 #: ../fish/guestfish.pod:1021
21270 "Used with the I<--remote> option to specify the remote guestfish process to "
21271 "control. See section L</REMOTE CONTROL GUESTFISH OVER A SOCKET>."
21275 #: ../fish/guestfish.pod:1025
21280 #: ../fish/guestfish.pod:1027
21282 "The L</hexedit> command uses C<$HEXEDITOR> as the external hex editor. If "
21283 "not specified, the external L<hexedit(1)> program is used."
21287 #: ../fish/guestfish.pod:1031
21292 #: ../fish/guestfish.pod:1033
21294 "If compiled with GNU readline support, various files in the home directory "
21295 "can be used. See L</FILES>."
21299 #: ../fish/guestfish.pod:1042
21301 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
21302 "effect as using the B<-v> option."
21306 #: ../fish/guestfish.pod:1054
21308 "Set the path that guestfish uses to search for kernel and initrd.img. See "
21309 "the discussion of paths in L<guestfs(3)>."
21313 #: ../fish/guestfish.pod:1065
21314 msgid "Set C<LIBGUESTFS_TRACE=1> to enable command traces."
21318 #: ../fish/guestfish.pod:1067
21323 #: ../fish/guestfish.pod:1069
21325 "The C<more> command uses C<$PAGER> as the pager. If not set, it uses "
21330 #: ../fish/guestfish.pod:1085 ../test-tool/libguestfs-test-tool.pod:88
21331 #: ../fuse/guestmount.pod:252
21336 #: ../fish/guestfish.pod:1089 ../fuse/guestmount.pod:256
21337 msgid "$HOME/.libguestfs-tools.rc"
21341 #: ../fish/guestfish.pod:1091 ../fuse/guestmount.pod:258
21342 msgid "/etc/libguestfs-tools.conf"
21346 #: ../fish/guestfish.pod:1093 ../fuse/guestmount.pod:260
21348 "This configuration file controls the default read-only or read-write mode "
21349 "(I<--ro> or I<--rw>)."
21353 #: ../fish/guestfish.pod:1096
21354 msgid "See L</OPENING DISKS FOR READ AND WRITE>."
21358 #: ../fish/guestfish.pod:1098
21359 msgid "$HOME/.guestfish"
21363 #: ../fish/guestfish.pod:1100
21365 "If compiled with GNU readline support, then the command history is saved in "
21370 #: ../fish/guestfish.pod:1103
21371 msgid "$HOME/.inputrc"
21375 #: ../fish/guestfish.pod:1105
21376 msgid "/etc/inputrc"
21380 #: ../fish/guestfish.pod:1107
21382 "If compiled with GNU readline support, then these files can be used to "
21383 "configure readline. For further information, please see L<readline(3)/"
21384 "INITIALIZATION FILE>."
21388 #: ../fish/guestfish.pod:1111
21389 msgid "To write rules which only apply to guestfish, use:"
21393 #: ../fish/guestfish.pod:1113
21403 #: ../fish/guestfish.pod:1117
21405 "Variables that you can set in inputrc that change the behaviour of guestfish "
21406 "in useful ways include:"
21410 #: ../fish/guestfish.pod:1122
21411 msgid "completion-ignore-case (default: on)"
21415 #: ../fish/guestfish.pod:1124
21417 "By default, guestfish will ignore case when tab-completing paths on the "
21422 #: ../fish/guestfish.pod:1127
21425 " set completion-ignore-case off\n"
21430 #: ../fish/guestfish.pod:1129
21431 msgid "to make guestfish case sensitive."
21435 #: ../fish/guestfish.pod:1133
21440 #: ../fish/guestfish.pod:1135
21441 msgid "test2.img (etc)"
21445 #: ../fish/guestfish.pod:1137
21447 "When using the C<-N> or C<--new> option, the prepared disk or filesystem "
21448 "will be created in the file C<test1.img> in the current directory. The "
21449 "second use of C<-N> will use C<test2.img> and so on. Any existing file with "
21450 "the same name will be overwritten."
21454 #: ../fish/guestfish.pod:1146
21456 "L<guestfs(3)>, L<http://libguestfs.org/>, L<virt-cat(1)>, L<virt-copy-in(1)"
21457 ">, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, L<virt-filesystems(1)"
21458 ">, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, L<virt-list-partitions"
21459 "(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, L<virt-rescue(1)>, L<virt-resize(1)"
21460 ">, L<virt-tar(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<virt-win-reg(1)"
21461 ">, L<hexedit(1)>."
21465 #: ../fish/guestfish.pod:1176 ../test-tool/libguestfs-test-tool.pod:124
21466 #: ../fuse/guestmount.pod:287 ../tools/virt-edit.pl:372
21467 #: ../tools/virt-win-reg.pl:606 ../tools/virt-resize.pl:1518
21468 #: ../tools/virt-list-filesystems.pl:210 ../tools/virt-tar.pl:309
21469 #: ../tools/virt-make-fs.pl:572 ../tools/virt-list-partitions.pl:277
21471 "This program is free software; you can redistribute it and/or modify it "
21472 "under the terms of the GNU General Public License as published by the Free "
21473 "Software Foundation; either version 2 of the License, or (at your option) "
21474 "any later version."
21478 #: ../fish/guestfish.pod:1181 ../test-tool/libguestfs-test-tool.pod:129
21479 #: ../fuse/guestmount.pod:292 ../tools/virt-edit.pl:377
21480 #: ../tools/virt-win-reg.pl:611 ../tools/virt-resize.pl:1523
21481 #: ../tools/virt-list-filesystems.pl:215 ../tools/virt-tar.pl:314
21482 #: ../tools/virt-make-fs.pl:577 ../tools/virt-list-partitions.pl:282
21484 "This program is distributed in the hope that it will be useful, but WITHOUT "
21485 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
21486 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for "
21491 #: ../fish/guestfish.pod:1186 ../test-tool/libguestfs-test-tool.pod:134
21492 #: ../fuse/guestmount.pod:297 ../tools/virt-edit.pl:382
21493 #: ../tools/virt-win-reg.pl:616 ../tools/virt-resize.pl:1528
21494 #: ../tools/virt-list-filesystems.pl:220 ../tools/virt-tar.pl:319
21495 #: ../tools/virt-make-fs.pl:582 ../tools/virt-list-partitions.pl:287
21497 "You should have received a copy of the GNU General Public License along with "
21498 "this program; if not, write to the Free Software Foundation, Inc., 675 Mass "
21499 "Ave, Cambridge, MA 02139, USA."
21503 #: ../fish/guestfish-actions.pod:1
21508 #: ../fish/guestfish-actions.pod:3
21511 " add-cdrom filename\n"
21516 #: ../fish/guestfish-actions.pod:15
21518 "This call checks for the existence of C<filename>. This stops you from "
21519 "specifying other types of drive which are supported by qemu such as C<nbd:> "
21520 "and C<http:> URLs. To specify those, use the general L</config> call "
21525 #: ../fish/guestfish-actions.pod:22
21527 "If you just want to add an ISO file (often you use this as an efficient way "
21528 "to transfer large files into the guest), then you should probably use L</add-"
21529 "drive-ro> instead."
21533 #: ../fish/guestfish-actions.pod:35
21538 #: ../fish/guestfish-actions.pod:37
21543 #: ../fish/guestfish-actions.pod:39
21546 " add-domain dom [libvirturi:..] [readonly:..] [iface:..] [live:..]\n"
21551 #: ../fish/guestfish-actions.pod:41
21553 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
21554 "It works by connecting to libvirt, requesting the domain and domain XML from "
21555 "libvirt, parsing it for disks, and calling L</add-drive-opts> on each one."
21559 #: ../fish/guestfish-actions.pod:71
21561 "The other optional parameters are passed directly through to L</add-drive-"
21566 #: ../fish/guestfish-actions.pod:74 ../fish/guestfish-actions.pod:138
21567 #: ../fish/guestfish-actions.pod:2981
21569 "This command has one or more optional arguments. See L</OPTIONAL ARGUMENTS>."
21573 #: ../fish/guestfish-actions.pod:76
21578 #: ../fish/guestfish-actions.pod:78
21581 " add-drive filename\n"
21586 #: ../fish/guestfish-actions.pod:80
21588 "This function is the equivalent of calling L</add-drive-opts> with no "
21589 "optional parameters, so the disk is added writable, with the format being "
21590 "detected automatically."
21594 #: ../fish/guestfish-actions.pod:84
21596 "Automatic detection of the format opens you up to a potential security hole "
21597 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
21598 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
21599 "you should think about replacing calls to this function with calls to L</add-"
21600 "drive-opts>, and specifying the format."
21604 #: ../fish/guestfish-actions.pod:91
21605 msgid "add-drive-opts"
21609 #: ../fish/guestfish-actions.pod:93
21614 #: ../fish/guestfish-actions.pod:95
21617 " add-drive-opts filename [readonly:..] [format:..] [iface:..]\n"
21622 #: ../fish/guestfish-actions.pod:122
21624 "This forces the image format. If you omit this (or use L</add-drive> or L</"
21625 "add-drive-ro>) then the format is automatically detected. Possible formats "
21626 "include C<raw> and C<qcow2>."
21630 #: ../fish/guestfish-actions.pod:133
21632 "This rarely-used option lets you emulate the behaviour of the deprecated L</"
21633 "add-drive-with-if> call (q.v.)"
21637 #: ../fish/guestfish-actions.pod:140
21638 msgid "add-drive-ro"
21642 #: ../fish/guestfish-actions.pod:142
21647 #: ../fish/guestfish-actions.pod:144
21650 " add-drive-ro filename\n"
21655 #: ../fish/guestfish-actions.pod:146
21657 "This function is the equivalent of calling L</add-drive-opts> with the "
21658 "optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the disk "
21659 "is added read-only, with the format being detected automatically."
21663 #: ../fish/guestfish-actions.pod:151
21664 msgid "add-drive-ro-with-if"
21668 #: ../fish/guestfish-actions.pod:153
21671 " add-drive-ro-with-if filename iface\n"
21676 #: ../fish/guestfish-actions.pod:155
21678 "This is the same as L</add-drive-ro> but it allows you to specify the QEMU "
21679 "interface emulation to use at run time."
21683 #: ../fish/guestfish-actions.pod:165
21684 msgid "add-drive-with-if"
21688 #: ../fish/guestfish-actions.pod:167
21691 " add-drive-with-if filename iface\n"
21696 #: ../fish/guestfish-actions.pod:169
21698 "This is the same as L</add-drive> but it allows you to specify the QEMU "
21699 "interface emulation to use at run time."
21703 #: ../fish/guestfish-actions.pod:179
21708 #: ../fish/guestfish-actions.pod:181
21711 " aug-clear augpath\n"
21716 #: ../fish/guestfish-actions.pod:186
21721 #: ../fish/guestfish-actions.pod:188
21729 #: ../fish/guestfish-actions.pod:190
21731 "Close the current Augeas handle and free up any resources used by it. After "
21732 "calling this, you have to call L</aug-init> again before you can use any "
21733 "other Augeas functions."
21737 #: ../fish/guestfish-actions.pod:195
21738 msgid "aug-defnode"
21742 #: ../fish/guestfish-actions.pod:197
21745 " aug-defnode name expr val\n"
21750 #: ../fish/guestfish-actions.pod:202
21752 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
21753 "calling L</aug-set> C<expr>, C<value>. C<name> will be the nodeset "
21754 "containing that single node."
21758 #: ../fish/guestfish-actions.pod:210
21763 #: ../fish/guestfish-actions.pod:212
21766 " aug-defvar name expr\n"
21771 #: ../fish/guestfish-actions.pod:221
21776 #: ../fish/guestfish-actions.pod:223
21779 " aug-get augpath\n"
21784 #: ../fish/guestfish-actions.pod:228
21789 #: ../fish/guestfish-actions.pod:230
21792 " aug-init root flags\n"
21797 #: ../fish/guestfish-actions.pod:236
21798 msgid "You must call this before using any other L</aug-*> commands."
21802 #: ../fish/guestfish-actions.pod:271
21803 msgid "Do not load the tree in L</aug-init>."
21807 #: ../fish/guestfish-actions.pod:275
21808 msgid "To close the handle, you can call L</aug-close>."
21812 #: ../fish/guestfish-actions.pod:279
21817 #: ../fish/guestfish-actions.pod:281
21820 " aug-insert augpath label true|false\n"
21825 #: ../fish/guestfish-actions.pod:291
21830 #: ../fish/guestfish-actions.pod:293
21838 #: ../fish/guestfish-actions.pod:300
21843 #: ../fish/guestfish-actions.pod:302
21846 " aug-ls augpath\n"
21851 #: ../fish/guestfish-actions.pod:304
21853 "This is just a shortcut for listing L</aug-match> C<path/*> and sorting the "
21854 "resulting nodes into alphabetical order."
21858 #: ../fish/guestfish-actions.pod:307
21863 #: ../fish/guestfish-actions.pod:309
21866 " aug-match augpath\n"
21871 #: ../fish/guestfish-actions.pod:315
21876 #: ../fish/guestfish-actions.pod:317
21879 " aug-mv src dest\n"
21884 #: ../fish/guestfish-actions.pod:322
21889 #: ../fish/guestfish-actions.pod:324
21892 " aug-rm augpath\n"
21897 #: ../fish/guestfish-actions.pod:330
21902 #: ../fish/guestfish-actions.pod:332
21910 #: ../fish/guestfish-actions.pod:336
21912 "The flags which were passed to L</aug-init> affect exactly how files are "
21917 #: ../fish/guestfish-actions.pod:339
21922 #: ../fish/guestfish-actions.pod:341
21925 " aug-set augpath val\n"
21930 #: ../fish/guestfish-actions.pod:345
21932 "In the Augeas API, it is possible to clear a node by setting the value to "
21933 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
21934 "this call. Instead you must use the L</aug-clear> call."
21938 #: ../fish/guestfish-actions.pod:350
21943 #: ../fish/guestfish-actions.pod:352
21946 " available 'groups ...'\n"
21951 #: ../fish/guestfish-actions.pod:358
21953 "The libguestfs groups, and the functions that those groups correspond to, "
21954 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
21955 "runtime by calling L</available-all-groups>."
21959 #: ../fish/guestfish-actions.pod:382
21960 msgid "You must call L</launch> before calling this function."
21964 #: ../fish/guestfish-actions.pod:404
21966 "This call was added in version C<1.0.80>. In previous versions of "
21967 "libguestfs all you could do would be to speculatively execute a command to "
21968 "find out if the daemon implemented it. See also L</version>."
21972 #: ../fish/guestfish-actions.pod:411
21973 msgid "available-all-groups"
21977 #: ../fish/guestfish-actions.pod:413
21980 " available-all-groups\n"
21985 #: ../fish/guestfish-actions.pod:415
21987 "This command returns a list of all optional groups that this daemon knows "
21988 "about. Note this returns both supported and unsupported groups. To find "
21989 "out which ones the daemon can actually support you have to call L</"
21990 "available> on each member of the returned list."
21994 #: ../fish/guestfish-actions.pod:421
21995 msgid "See also L</available> and L<guestfs(3)/AVAILABILITY>."
21999 #: ../fish/guestfish-actions.pod:423
22004 #: ../fish/guestfish-actions.pod:425
22007 " base64-in (base64file|-) filename\n"
22012 #: ../fish/guestfish-actions.pod:430 ../fish/guestfish-actions.pod:439
22013 #: ../fish/guestfish-actions.pod:663 ../fish/guestfish-actions.pod:832
22014 #: ../fish/guestfish-actions.pod:851 ../fish/guestfish-actions.pod:1228
22015 #: ../fish/guestfish-actions.pod:4379 ../fish/guestfish-actions.pod:4391
22016 #: ../fish/guestfish-actions.pod:4402 ../fish/guestfish-actions.pod:4413
22017 #: ../fish/guestfish-actions.pod:4465 ../fish/guestfish-actions.pod:4474
22018 #: ../fish/guestfish-actions.pod:4528 ../fish/guestfish-actions.pod:4551
22019 msgid "Use C<-> instead of a filename to read/write from stdin/stdout."
22023 #: ../fish/guestfish-actions.pod:432
22028 #: ../fish/guestfish-actions.pod:434
22031 " base64-out filename (base64file|-)\n"
22036 #: ../fish/guestfish-actions.pod:441
22037 msgid "blockdev-flushbufs"
22041 #: ../fish/guestfish-actions.pod:443
22044 " blockdev-flushbufs device\n"
22049 #: ../fish/guestfish-actions.pod:450
22050 msgid "blockdev-getbsz"
22054 #: ../fish/guestfish-actions.pod:452
22057 " blockdev-getbsz device\n"
22062 #: ../fish/guestfish-actions.pod:461
22063 msgid "blockdev-getro"
22067 #: ../fish/guestfish-actions.pod:463
22070 " blockdev-getro device\n"
22075 #: ../fish/guestfish-actions.pod:470
22076 msgid "blockdev-getsize64"
22080 #: ../fish/guestfish-actions.pod:472
22083 " blockdev-getsize64 device\n"
22088 #: ../fish/guestfish-actions.pod:476
22089 msgid "See also L</blockdev-getsz>."
22093 #: ../fish/guestfish-actions.pod:480
22094 msgid "blockdev-getss"
22098 #: ../fish/guestfish-actions.pod:482
22101 " blockdev-getss device\n"
22106 #: ../fish/guestfish-actions.pod:487
22108 "(Note, this is not the size in sectors, use L</blockdev-getsz> for that)."
22112 #: ../fish/guestfish-actions.pod:492
22113 msgid "blockdev-getsz"
22117 #: ../fish/guestfish-actions.pod:494
22120 " blockdev-getsz device\n"
22125 #: ../fish/guestfish-actions.pod:499
22127 "See also L</blockdev-getss> for the real sector size of the device, and L</"
22128 "blockdev-getsize64> for the more useful I<size in bytes>."
22132 #: ../fish/guestfish-actions.pod:505
22133 msgid "blockdev-rereadpt"
22137 #: ../fish/guestfish-actions.pod:507
22140 " blockdev-rereadpt device\n"
22145 #: ../fish/guestfish-actions.pod:513
22146 msgid "blockdev-setbsz"
22150 #: ../fish/guestfish-actions.pod:515
22153 " blockdev-setbsz device blocksize\n"
22158 #: ../fish/guestfish-actions.pod:524
22159 msgid "blockdev-setro"
22163 #: ../fish/guestfish-actions.pod:526
22166 " blockdev-setro device\n"
22171 #: ../fish/guestfish-actions.pod:532
22172 msgid "blockdev-setrw"
22176 #: ../fish/guestfish-actions.pod:534
22179 " blockdev-setrw device\n"
22184 #: ../fish/guestfish-actions.pod:540
22185 msgid "case-sensitive-path"
22189 #: ../fish/guestfish-actions.pod:542
22192 " case-sensitive-path path\n"
22197 #: ../fish/guestfish-actions.pod:566
22199 "Thus L</case-sensitive-path> (\"/Windows/System32\") might return C<\"/"
22200 "WINDOWS/system32\"> (the exact return value would depend on details of how "
22201 "the directories were originally created under Windows)."
22205 #: ../fish/guestfish-actions.pod:574
22206 msgid "See also L</realpath>."
22210 #: ../fish/guestfish-actions.pod:576
22215 #: ../fish/guestfish-actions.pod:578
22223 #: ../fish/guestfish-actions.pod:582
22225 "Note that this function cannot correctly handle binary files (specifically, "
22226 "files containing C<\\0> character which is treated as end of string). For "
22227 "those you need to use the L</read-file> or L</download> functions which have "
22228 "a more complex interface."
22232 #: ../fish/guestfish-actions.pod:590
22237 #: ../fish/guestfish-actions.pod:592
22240 " checksum csumtype path\n"
22245 #: ../fish/guestfish-actions.pod:635
22246 msgid "To get the checksum for a device, use L</checksum-device>."
22250 #: ../fish/guestfish-actions.pod:637
22251 msgid "To get the checksums for many files, use L</checksums-out>."
22255 #: ../fish/guestfish-actions.pod:639
22256 msgid "checksum-device"
22260 #: ../fish/guestfish-actions.pod:641
22263 " checksum-device csumtype device\n"
22268 #: ../fish/guestfish-actions.pod:643
22270 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
22271 "device named C<device>. For the types of checksums supported see the L</"
22272 "checksum> command."
22276 #: ../fish/guestfish-actions.pod:647
22277 msgid "checksums-out"
22281 #: ../fish/guestfish-actions.pod:649
22284 " checksums-out csumtype directory (sumsfile|-)\n"
22289 #: ../fish/guestfish-actions.pod:665
22294 #: ../fish/guestfish-actions.pod:667
22297 " chmod mode path\n"
22302 #: ../fish/guestfish-actions.pod:678
22307 #: ../fish/guestfish-actions.pod:680
22310 " chown owner group path\n"
22315 #: ../fish/guestfish-actions.pod:688
22320 #: ../fish/guestfish-actions.pod:690
22323 " command 'arguments ...'\n"
22328 #: ../fish/guestfish-actions.pod:697
22330 "The single parameter is an argv-style list of arguments. The first element "
22331 "is the name of the program to run. Subsequent elements are parameters. The "
22332 "list must be non-empty (ie. must contain a program name). Note that the "
22333 "command runs directly, and is I<not> invoked via the shell (see L</sh>)."
22337 #: ../fish/guestfish-actions.pod:725
22338 msgid "command-lines"
22342 #: ../fish/guestfish-actions.pod:727
22345 " command-lines 'arguments ...'\n"
22350 #: ../fish/guestfish-actions.pod:729
22352 "This is the same as L</command>, but splits the result into a list of lines."
22356 #: ../fish/guestfish-actions.pod:732
22357 msgid "See also: L</sh-lines>"
22361 #: ../fish/guestfish-actions.pod:737
22366 #: ../fish/guestfish-actions.pod:739
22369 " config qemuparam qemuvalue\n"
22374 #: ../fish/guestfish-actions.pod:750
22379 #: ../fish/guestfish-actions.pod:752
22382 " copy-size src dest size\n"
22387 #: ../fish/guestfish-actions.pod:760
22392 #: ../fish/guestfish-actions.pod:762
22400 #: ../fish/guestfish-actions.pod:767
22405 #: ../fish/guestfish-actions.pod:769
22413 #: ../fish/guestfish-actions.pod:774
22418 #: ../fish/guestfish-actions.pod:776
22426 #: ../fish/guestfish-actions.pod:783
22428 "If the destination is a device, it must be as large or larger than the "
22429 "source file or device, otherwise the copy will fail. This command cannot do "
22430 "partial copies (see L</copy-size>)."
22434 #: ../fish/guestfish-actions.pod:787
22439 #: ../fish/guestfish-actions.pod:789
22447 #: ../fish/guestfish-actions.pod:793 ../fish/guestfish-actions.pod:804
22449 "This command is mostly useful for interactive sessions. It is I<not> "
22450 "intended that you try to parse the output string. Use L</statvfs> from "
22455 #: ../fish/guestfish-actions.pod:797
22460 #: ../fish/guestfish-actions.pod:799
22468 #: ../fish/guestfish-actions.pod:808
22473 #: ../fish/guestfish-actions.pod:810
22481 #: ../fish/guestfish-actions.pod:816
22483 "Another way to get the same information is to enable verbose messages with "
22484 "L</set-verbose> or by setting the environment variable C<LIBGUESTFS_DEBUG=1> "
22485 "before running the program."
22489 #: ../fish/guestfish-actions.pod:821
22494 #: ../fish/guestfish-actions.pod:823
22497 " download remotefilename (filename|-)\n"
22502 #: ../fish/guestfish-actions.pod:830
22503 msgid "See also L</upload>, L</cat>."
22507 #: ../fish/guestfish-actions.pod:834
22508 msgid "download-offset"
22512 #: ../fish/guestfish-actions.pod:836
22515 " download-offset remotefilename (filename|-) offset size\n"
22520 #: ../fish/guestfish-actions.pod:844
22522 "Note that there is no limit on the amount of data that can be downloaded "
22523 "with this call, unlike with L</pread>, and this call always reads the full "
22524 "amount unless an error occurs."
22528 #: ../fish/guestfish-actions.pod:849
22529 msgid "See also L</download>, L</pread>."
22533 #: ../fish/guestfish-actions.pod:853
22534 msgid "drop-caches"
22538 #: ../fish/guestfish-actions.pod:855
22541 " drop-caches whattodrop\n"
22546 #: ../fish/guestfish-actions.pod:867
22551 #: ../fish/guestfish-actions.pod:869
22559 #: ../fish/guestfish-actions.pod:881
22564 #: ../fish/guestfish-actions.pod:883
22567 " e2fsck-f device\n"
22572 #: ../fish/guestfish-actions.pod:889
22574 "This command is only needed because of L</resize2fs> (q.v.). Normally you "
22575 "should use L</fsck>."
22579 #: ../fish/guestfish-actions.pod:892
22580 msgid "echo-daemon"
22584 #: ../fish/guestfish-actions.pod:894
22587 " echo-daemon 'words ...'\n"
22592 #: ../fish/guestfish-actions.pod:901
22593 msgid "See also L</ping-daemon>."
22597 #: ../fish/guestfish-actions.pod:903
22602 #: ../fish/guestfish-actions.pod:905
22605 " egrep regex path\n"
22610 #: ../fish/guestfish-actions.pod:913
22615 #: ../fish/guestfish-actions.pod:915
22618 " egrepi regex path\n"
22623 #: ../fish/guestfish-actions.pod:923
22628 #: ../fish/guestfish-actions.pod:925
22631 " equal file1 file2\n"
22636 #: ../fish/guestfish-actions.pod:932
22641 #: ../fish/guestfish-actions.pod:934
22649 #: ../fish/guestfish-actions.pod:939
22650 msgid "See also L</is-file>, L</is-dir>, L</stat>."
22654 #: ../fish/guestfish-actions.pod:941
22659 #: ../fish/guestfish-actions.pod:943
22662 " fallocate path len\n"
22667 #: ../fish/guestfish-actions.pod:960
22668 msgid "fallocate64"
22672 #: ../fish/guestfish-actions.pod:962
22675 " fallocate64 path len\n"
22680 #: ../fish/guestfish-actions.pod:968
22682 "Note that this call allocates disk blocks for the file. To create a sparse "
22683 "file use L</truncate-size> instead."
22687 #: ../fish/guestfish-actions.pod:971
22689 "The deprecated call L</fallocate> does the same, but owing to an oversight "
22690 "it only allowed 30 bit lengths to be specified, effectively limiting the "
22691 "maximum size of files created through that call to 1GB."
22695 #: ../fish/guestfish-actions.pod:980
22700 #: ../fish/guestfish-actions.pod:982
22703 " fgrep pattern path\n"
22708 #: ../fish/guestfish-actions.pod:990
22713 #: ../fish/guestfish-actions.pod:992
22716 " fgrepi pattern path\n"
22721 #: ../fish/guestfish-actions.pod:1000
22726 #: ../fish/guestfish-actions.pod:1002
22734 #: ../fish/guestfish-actions.pod:1014
22736 "This command can also be used on C</dev/> devices (and partitions, LV "
22737 "names). You can for example use this to determine if a device contains a "
22738 "filesystem, although it's usually better to use L</vfs-type>."
22742 #: ../fish/guestfish-actions.pod:1024
22743 msgid "file-architecture"
22747 #: ../fish/guestfish-actions.pod:1026
22750 " file-architecture filename\n"
22755 #: ../fish/guestfish-actions.pod:1129
22760 #: ../fish/guestfish-actions.pod:1131
22768 #: ../fish/guestfish-actions.pod:1135
22770 "To get other stats about a file, use L</stat>, L</lstat>, L</is-dir>, L</is-"
22771 "file> etc. To get the size of block devices, use L</blockdev-getsize64>."
22775 #: ../fish/guestfish-actions.pod:1139
22780 #: ../fish/guestfish-actions.pod:1141
22783 " fill c len path\n"
22788 #: ../fish/guestfish-actions.pod:1147
22790 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
22791 "L</truncate-size>. To create a file with a pattern of repeating bytes use "
22792 "L</fill-pattern>."
22796 #: ../fish/guestfish-actions.pod:1152
22797 msgid "fill-pattern"
22801 #: ../fish/guestfish-actions.pod:1154
22804 " fill-pattern pattern len path\n"
22809 #: ../fish/guestfish-actions.pod:1156
22811 "This function is like L</fill> except that it creates a new file of length "
22812 "C<len> containing the repeating pattern of bytes in C<pattern>. The pattern "
22813 "is truncated if necessary to ensure the length of the file is exactly C<len> "
22818 #: ../fish/guestfish-actions.pod:1161
22823 #: ../fish/guestfish-actions.pod:1163
22826 " find directory\n"
22831 #: ../fish/guestfish-actions.pod:1177
22832 msgid "then the returned list from L</find> C</tmp> would be 4 elements:"
22836 #: ../fish/guestfish-actions.pod:1190
22837 msgid "See also L</find0>."
22841 #: ../fish/guestfish-actions.pod:1195
22846 #: ../fish/guestfish-actions.pod:1197
22849 " find0 directory (files|-)\n"
22854 #: ../fish/guestfish-actions.pod:1203
22856 "This command works the same way as L</find> with the following exceptions:"
22860 #: ../fish/guestfish-actions.pod:1230
22861 msgid "findfs-label"
22865 #: ../fish/guestfish-actions.pod:1232
22868 " findfs-label label\n"
22873 #: ../fish/guestfish-actions.pod:1238
22874 msgid "To find the label of a filesystem, use L</vfs-label>."
22878 #: ../fish/guestfish-actions.pod:1240
22879 msgid "findfs-uuid"
22883 #: ../fish/guestfish-actions.pod:1242
22886 " findfs-uuid uuid\n"
22891 #: ../fish/guestfish-actions.pod:1248
22892 msgid "To find the UUID of a filesystem, use L</vfs-uuid>."
22896 #: ../fish/guestfish-actions.pod:1250
22901 #: ../fish/guestfish-actions.pod:1252
22904 " fsck fstype device\n"
22909 #: ../fish/guestfish-actions.pod:1282
22914 #: ../fish/guestfish-actions.pod:1284
22922 #: ../fish/guestfish-actions.pod:1291
22923 msgid "get-attach-method"
22927 #: ../fish/guestfish-actions.pod:1293
22930 " get-attach-method\n"
22935 #: ../fish/guestfish-actions.pod:1295
22936 msgid "Return the current attach method. See L</set-attach-method>."
22940 #: ../fish/guestfish-actions.pod:1297
22941 msgid "get-autosync"
22945 #: ../fish/guestfish-actions.pod:1299
22953 #: ../fish/guestfish-actions.pod:1303
22958 #: ../fish/guestfish-actions.pod:1305
22966 #: ../fish/guestfish-actions.pod:1309
22967 msgid "get-e2label"
22971 #: ../fish/guestfish-actions.pod:1311
22974 " get-e2label device\n"
22979 #: ../fish/guestfish-actions.pod:1323
22984 #: ../fish/guestfish-actions.pod:1325
22987 " get-e2uuid device\n"
22992 #: ../fish/guestfish-actions.pod:1337
22993 msgid "get-memsize"
22997 #: ../fish/guestfish-actions.pod:1339
23005 #: ../fish/guestfish-actions.pod:1344
23007 "If L</set-memsize> was not called on this handle, and if "
23008 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
23009 "value for memsize."
23013 #: ../fish/guestfish-actions.pod:1351
23014 msgid "get-network"
23018 #: ../fish/guestfish-actions.pod:1353
23026 #: ../fish/guestfish-actions.pod:1357
23031 #: ../fish/guestfish-actions.pod:1359
23039 #: ../fish/guestfish-actions.pod:1366
23044 #: ../fish/guestfish-actions.pod:1368
23049 #: ../fish/guestfish-actions.pod:1370
23057 #: ../fish/guestfish-actions.pod:1377
23062 #: ../fish/guestfish-actions.pod:1379
23070 #: ../fish/guestfish-actions.pod:1386
23071 msgid "get-recovery-proc"
23075 #: ../fish/guestfish-actions.pod:1388
23078 " get-recovery-proc\n"
23083 #: ../fish/guestfish-actions.pod:1392
23084 msgid "get-selinux"
23088 #: ../fish/guestfish-actions.pod:1394
23096 #: ../fish/guestfish-actions.pod:1396
23098 "This returns the current setting of the selinux flag which is passed to the "
23099 "appliance at boot time. See L</set-selinux>."
23103 #: ../fish/guestfish-actions.pod:1402
23108 #: ../fish/guestfish-actions.pod:1404
23116 #: ../fish/guestfish-actions.pod:1411
23121 #: ../fish/guestfish-actions.pod:1413
23129 #: ../fish/guestfish-actions.pod:1417
23134 #: ../fish/guestfish-actions.pod:1419
23142 #: ../fish/guestfish-actions.pod:1421
23144 "Return the current umask. By default the umask is C<022> unless it has been "
23145 "set by calling L</umask>."
23149 #: ../fish/guestfish-actions.pod:1424
23150 msgid "get-verbose"
23154 #: ../fish/guestfish-actions.pod:1426
23162 #: ../fish/guestfish-actions.pod:1430
23167 #: ../fish/guestfish-actions.pod:1432
23175 #: ../fish/guestfish-actions.pod:1436
23176 msgid "See the documentation about SELINUX in L<guestfs(3)>, and L</setcon>"
23180 #: ../fish/guestfish-actions.pod:1439
23185 #: ../fish/guestfish-actions.pod:1441
23188 " getxattr path name\n"
23193 #: ../fish/guestfish-actions.pod:1443
23195 "Get a single extended attribute from file C<path> named C<name>. This call "
23196 "follows symlinks. If you want to lookup an extended attribute for the "
23197 "symlink itself, use L</lgetxattr>."
23201 #: ../fish/guestfish-actions.pod:1447 ../fish/guestfish-actions.pod:2387
23203 "Normally it is better to get all extended attributes from a file in one go "
23204 "by calling L</getxattrs>. However some Linux filesystem implementations are "
23205 "buggy and do not provide a way to list out attributes. For these "
23206 "filesystems (notably ntfs-3g) you have to know the names of the extended "
23207 "attributes you want in advance and call this function."
23211 #: ../fish/guestfish-actions.pod:1457
23212 msgid "See also: L</getxattrs>, L</lgetxattr>, L<attr(5)>."
23216 #: ../fish/guestfish-actions.pod:1459
23221 #: ../fish/guestfish-actions.pod:1461
23224 " getxattrs path\n"
23229 #: ../fish/guestfish-actions.pod:1469
23230 msgid "See also: L</lgetxattrs>, L<attr(5)>."
23234 #: ../fish/guestfish-actions.pod:1471
23235 msgid "glob-expand"
23239 #: ../fish/guestfish-actions.pod:1473
23242 " glob-expand pattern\n"
23247 #: ../fish/guestfish-actions.pod:1486
23252 #: ../fish/guestfish-actions.pod:1488
23255 " grep regex path\n"
23260 #: ../fish/guestfish-actions.pod:1496
23265 #: ../fish/guestfish-actions.pod:1498
23268 " grepi regex path\n"
23273 #: ../fish/guestfish-actions.pod:1506
23274 msgid "grub-install"
23278 #: ../fish/guestfish-actions.pod:1508
23281 " grub-install root device\n"
23286 #: ../fish/guestfish-actions.pod:1524
23291 #: ../fish/guestfish-actions.pod:1526
23299 #: ../fish/guestfish-actions.pod:1534
23304 #: ../fish/guestfish-actions.pod:1536
23307 " head-n nrlines path\n"
23312 #: ../fish/guestfish-actions.pod:1549
23317 #: ../fish/guestfish-actions.pod:1551
23325 #: ../fish/guestfish-actions.pod:1559
23330 #: ../fish/guestfish-actions.pod:1561
23333 " initrd-cat initrdpath filename\n"
23338 #: ../fish/guestfish-actions.pod:1573
23339 msgid "See also L</initrd-list>."
23343 #: ../fish/guestfish-actions.pod:1578
23344 msgid "initrd-list"
23348 #: ../fish/guestfish-actions.pod:1580
23351 " initrd-list path\n"
23356 #: ../fish/guestfish-actions.pod:1592
23357 msgid "inotify-add-watch"
23361 #: ../fish/guestfish-actions.pod:1594
23364 " inotify-add-watch path mask\n"
23369 #: ../fish/guestfish-actions.pod:1606
23370 msgid "inotify-close"
23374 #: ../fish/guestfish-actions.pod:1608
23382 #: ../fish/guestfish-actions.pod:1614
23383 msgid "inotify-files"
23387 #: ../fish/guestfish-actions.pod:1616
23395 #: ../fish/guestfish-actions.pod:1618
23397 "This function is a helpful wrapper around L</inotify-read> which just "
23398 "returns a list of pathnames of objects that were touched. The returned "
23399 "pathnames are sorted and deduplicated."
23403 #: ../fish/guestfish-actions.pod:1622
23404 msgid "inotify-init"
23408 #: ../fish/guestfish-actions.pod:1624
23411 " inotify-init maxevents\n"
23416 #: ../fish/guestfish-actions.pod:1630
23418 "C<maxevents> is the maximum number of events which will be queued up between "
23419 "calls to L</inotify-read> or L</inotify-files>. If this is passed as C<0>, "
23420 "then the kernel (or previously set) default is used. For Linux 2.6.29 the "
23421 "default was 16384 events. Beyond this limit, the kernel throws away events, "
23422 "but records the fact that it threw them away by setting a flag "
23423 "C<IN_Q_OVERFLOW> in the returned structure list (see L</inotify-read>)."
23427 #: ../fish/guestfish-actions.pod:1640
23429 "Before any events are generated, you have to add some watches to the "
23430 "internal watch list. See: L</inotify-add-watch>, L</inotify-rm-watch> and "
23431 "L</inotify-watch-all>."
23435 #: ../fish/guestfish-actions.pod:1646
23437 "Queued up events should be read periodically by calling L</inotify-read> (or "
23438 "L</inotify-files> which is just a helpful wrapper around L</inotify-read>). "
23439 "If you don't read the events out often enough then you risk the internal "
23440 "queue overflowing."
23444 #: ../fish/guestfish-actions.pod:1653
23446 "The handle should be closed after use by calling L</inotify-close>. This "
23447 "also removes any watches automatically."
23451 #: ../fish/guestfish-actions.pod:1662
23452 msgid "inotify-read"
23456 #: ../fish/guestfish-actions.pod:1664
23464 #: ../fish/guestfish-actions.pod:1677
23465 msgid "inotify-rm-watch"
23469 #: ../fish/guestfish-actions.pod:1679
23472 " inotify-rm-watch wd\n"
23477 #: ../fish/guestfish-actions.pod:1681
23478 msgid "Remove a previously defined inotify watch. See L</inotify-add-watch>."
23482 #: ../fish/guestfish-actions.pod:1684
23483 msgid "inspect-get-arch"
23487 #: ../fish/guestfish-actions.pod:1686
23490 " inspect-get-arch root\n"
23495 #: ../fish/guestfish-actions.pod:1688 ../fish/guestfish-actions.pod:1704
23496 #: ../fish/guestfish-actions.pod:1782 ../fish/guestfish-actions.pod:1800
23497 #: ../fish/guestfish-actions.pod:1834 ../fish/guestfish-actions.pod:1849
23498 #: ../fish/guestfish-actions.pod:1870 ../fish/guestfish-actions.pod:1885
23499 #: ../fish/guestfish-actions.pod:1912 ../fish/guestfish-actions.pod:1934
23500 #: ../fish/guestfish-actions.pod:1958 ../fish/guestfish-actions.pod:1975
23501 #: ../fish/guestfish-actions.pod:2018 ../fish/guestfish-actions.pod:2053
23502 #: ../fish/guestfish-actions.pod:2069 ../fish/guestfish-actions.pod:2082
23503 #: ../fish/guestfish-actions.pod:2095 ../fish/guestfish-actions.pod:2110
23505 "This function should only be called with a root device string as returned by "
23510 #: ../fish/guestfish-actions.pod:1691
23512 "This returns the architecture of the inspected operating system. The "
23513 "possible return values are listed under L</file-architecture>."
23517 #: ../fish/guestfish-actions.pod:1700
23518 msgid "inspect-get-distro"
23522 #: ../fish/guestfish-actions.pod:1702
23525 " inspect-get-distro root\n"
23530 #: ../fish/guestfish-actions.pod:1778
23531 msgid "inspect-get-filesystems"
23535 #: ../fish/guestfish-actions.pod:1780
23538 " inspect-get-filesystems root\n"
23543 #: ../fish/guestfish-actions.pod:1793
23545 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
23546 "get-mountpoints>."
23550 #: ../fish/guestfish-actions.pod:1796
23551 msgid "inspect-get-format"
23555 #: ../fish/guestfish-actions.pod:1798
23558 " inspect-get-format root\n"
23563 #: ../fish/guestfish-actions.pod:1830
23564 msgid "inspect-get-hostname"
23568 #: ../fish/guestfish-actions.pod:1832
23571 " inspect-get-hostname root\n"
23576 #: ../fish/guestfish-actions.pod:1845
23577 msgid "inspect-get-major-version"
23581 #: ../fish/guestfish-actions.pod:1847
23584 " inspect-get-major-version root\n"
23589 #: ../fish/guestfish-actions.pod:1866
23590 msgid "inspect-get-minor-version"
23594 #: ../fish/guestfish-actions.pod:1868
23597 " inspect-get-minor-version root\n"
23602 #: ../fish/guestfish-actions.pod:1878
23604 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
23605 "get-major-version>."
23609 #: ../fish/guestfish-actions.pod:1881
23610 msgid "inspect-get-mountpoints"
23614 #: ../fish/guestfish-actions.pod:1883
23617 " inspect-get-mountpoints root\n"
23622 #: ../fish/guestfish-actions.pod:1905
23624 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
23625 "get-filesystems>."
23629 #: ../fish/guestfish-actions.pod:1908
23630 msgid "inspect-get-package-format"
23634 #: ../fish/guestfish-actions.pod:1910
23637 " inspect-get-package-format root\n"
23642 #: ../fish/guestfish-actions.pod:1915
23644 "This function and L</inspect-get-package-management> return the package "
23645 "format and package management tool used by the inspected operating system. "
23646 "For example for Fedora these functions would return C<rpm> (package format) "
23647 "and C<yum> (package management)."
23651 #: ../fish/guestfish-actions.pod:1930
23652 msgid "inspect-get-package-management"
23656 #: ../fish/guestfish-actions.pod:1932
23659 " inspect-get-package-management root\n"
23664 #: ../fish/guestfish-actions.pod:1937
23666 "L</inspect-get-package-format> and this function return the package format "
23667 "and package management tool used by the inspected operating system. For "
23668 "example for Fedora these functions would return C<rpm> (package format) and "
23669 "C<yum> (package management)."
23673 #: ../fish/guestfish-actions.pod:1954
23674 msgid "inspect-get-product-name"
23678 #: ../fish/guestfish-actions.pod:1956
23681 " inspect-get-product-name root\n"
23686 #: ../fish/guestfish-actions.pod:1971
23687 msgid "inspect-get-product-variant"
23691 #: ../fish/guestfish-actions.pod:1973
23694 " inspect-get-product-variant root\n"
23699 #: ../fish/guestfish-actions.pod:1997
23701 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
23702 "get-product-name>, L</inspect-get-major-version>."
23706 #: ../fish/guestfish-actions.pod:2001
23707 msgid "inspect-get-roots"
23711 #: ../fish/guestfish-actions.pod:2003
23714 " inspect-get-roots\n"
23719 #: ../fish/guestfish-actions.pod:2005
23721 "This function is a convenient way to get the list of root devices, as "
23722 "returned from a previous call to L</inspect-os>, but without redoing the "
23723 "whole inspection process."
23727 #: ../fish/guestfish-actions.pod:2009
23729 "This returns an empty list if either no root devices were found or the "
23730 "caller has not called L</inspect-os>."
23734 #: ../fish/guestfish-actions.pod:2014
23735 msgid "inspect-get-type"
23739 #: ../fish/guestfish-actions.pod:2016
23742 " inspect-get-type root\n"
23747 #: ../fish/guestfish-actions.pod:2049
23748 msgid "inspect-get-windows-systemroot"
23752 #: ../fish/guestfish-actions.pod:2051
23755 " inspect-get-windows-systemroot root\n"
23760 #: ../fish/guestfish-actions.pod:2065
23761 msgid "inspect-is-live"
23765 #: ../fish/guestfish-actions.pod:2067
23768 " inspect-is-live root\n"
23773 #: ../fish/guestfish-actions.pod:2072
23775 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
23776 "then this returns true if a live image was detected on the disk."
23780 #: ../fish/guestfish-actions.pod:2078
23781 msgid "inspect-is-multipart"
23785 #: ../fish/guestfish-actions.pod:2080
23788 " inspect-is-multipart root\n"
23793 #: ../fish/guestfish-actions.pod:2085
23795 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
23796 "then this returns true if the disk is part of a set."
23800 #: ../fish/guestfish-actions.pod:2091
23801 msgid "inspect-is-netinst"
23805 #: ../fish/guestfish-actions.pod:2093
23808 " inspect-is-netinst root\n"
23813 #: ../fish/guestfish-actions.pod:2098
23815 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
23816 "then this returns true if the disk is a network installer, ie. not a self-"
23817 "contained install CD but one which is likely to require network access to "
23818 "complete the install."
23822 #: ../fish/guestfish-actions.pod:2106
23823 msgid "inspect-list-applications"
23827 #: ../fish/guestfish-actions.pod:2108
23830 " inspect-list-applications root\n"
23835 #: ../fish/guestfish-actions.pod:2115
23837 "I<Note:> This call works differently from other parts of the inspection "
23838 "API. You have to call L</inspect-os>, then L</inspect-get-mountpoints>, "
23839 "then mount up the disks, before calling this. Listing applications is a "
23840 "significantly more difficult operation which requires access to the full "
23841 "filesystem. Also note that unlike the other L</inspect-get-*> calls which "
23842 "are just returning data cached in the libguestfs handle, this call actually "
23843 "reads parts of the mounted filesystems during the call."
23847 #: ../fish/guestfish-actions.pod:2205
23852 #: ../fish/guestfish-actions.pod:2207
23860 #: ../fish/guestfish-actions.pod:2222
23862 "You can pass the root string(s) returned to other L</inspect-get-*> "
23863 "functions in order to query further information about each operating system, "
23864 "such as the name and version."
23868 #: ../fish/guestfish-actions.pod:2227
23870 "This function uses other libguestfs features such as L</mount-ro> and L</"
23871 "umount-all> in order to mount and unmount filesystems and look at the "
23872 "contents. This should be called with no disks currently mounted. The "
23873 "function may also use Augeas, so any existing Augeas handle will be closed."
23877 #: ../fish/guestfish-actions.pod:2239 ../fish/guestfish-actions.pod:2415
23878 #: ../fish/guestfish-actions.pod:2461
23879 msgid "See also L</list-filesystems>."
23883 #: ../fish/guestfish-actions.pod:2241
23884 msgid "is-blockdev"
23888 #: ../fish/guestfish-actions.pod:2243
23891 " is-blockdev path\n"
23896 #: ../fish/guestfish-actions.pod:2248 ../fish/guestfish-actions.pod:2266
23897 #: ../fish/guestfish-actions.pod:2285 ../fish/guestfish-actions.pod:2294
23898 #: ../fish/guestfish-actions.pod:2304 ../fish/guestfish-actions.pod:2338
23899 #: ../fish/guestfish-actions.pod:2347
23900 msgid "See also L</stat>."
23904 #: ../fish/guestfish-actions.pod:2250
23909 #: ../fish/guestfish-actions.pod:2252
23917 #: ../fish/guestfish-actions.pod:2259
23922 #: ../fish/guestfish-actions.pod:2261
23925 " is-chardev path\n"
23930 #: ../fish/guestfish-actions.pod:2268
23935 #: ../fish/guestfish-actions.pod:2270
23943 #: ../fish/guestfish-actions.pod:2277
23948 #: ../fish/guestfish-actions.pod:2279
23956 #: ../fish/guestfish-actions.pod:2287
23961 #: ../fish/guestfish-actions.pod:2289
23969 #: ../fish/guestfish-actions.pod:2296
23974 #: ../fish/guestfish-actions.pod:2298
23982 #: ../fish/guestfish-actions.pod:2306
23983 msgid "is-launching"
23987 #: ../fish/guestfish-actions.pod:2308
23995 #: ../fish/guestfish-actions.pod:2315
24000 #: ../fish/guestfish-actions.pod:2317
24008 #: ../fish/guestfish-actions.pod:2322
24013 #: ../fish/guestfish-actions.pod:2324
24021 #: ../fish/guestfish-actions.pod:2331
24026 #: ../fish/guestfish-actions.pod:2333
24029 " is-socket path\n"
24034 #: ../fish/guestfish-actions.pod:2340
24039 #: ../fish/guestfish-actions.pod:2342
24042 " is-symlink path\n"
24047 #: ../fish/guestfish-actions.pod:2349
24048 msgid "kill-subprocess"
24052 #: ../fish/guestfish-actions.pod:2351
24055 " kill-subprocess\n"
24060 #: ../fish/guestfish-actions.pod:2355
24065 #: ../fish/guestfish-actions.pod:2357
24070 #: ../fish/guestfish-actions.pod:2359
24078 #: ../fish/guestfish-actions.pod:2367
24083 #: ../fish/guestfish-actions.pod:2369
24086 " lchown owner group path\n"
24091 #: ../fish/guestfish-actions.pod:2371
24093 "Change the file owner to C<owner> and group to C<group>. This is like L</"
24094 "chown> but if C<path> is a symlink then the link itself is changed, not the "
24099 #: ../fish/guestfish-actions.pod:2379
24104 #: ../fish/guestfish-actions.pod:2381
24107 " lgetxattr path name\n"
24112 #: ../fish/guestfish-actions.pod:2397
24113 msgid "See also: L</lgetxattrs>, L</getxattr>, L<attr(5)>."
24117 #: ../fish/guestfish-actions.pod:2399
24122 #: ../fish/guestfish-actions.pod:2401
24125 " lgetxattrs path\n"
24130 #: ../fish/guestfish-actions.pod:2403
24132 "This is the same as L</getxattrs>, but if C<path> is a symbolic link, then "
24133 "it returns the extended attributes of the link itself."
24137 #: ../fish/guestfish-actions.pod:2407
24138 msgid "list-devices"
24142 #: ../fish/guestfish-actions.pod:2409
24150 #: ../fish/guestfish-actions.pod:2417
24151 msgid "list-filesystems"
24155 #: ../fish/guestfish-actions.pod:2419
24158 " list-filesystems\n"
24163 #: ../fish/guestfish-actions.pod:2438
24165 "This command runs other libguestfs commands, which might include L</mount> "
24166 "and L</umount>, and therefore you should use this soon after launch and only "
24167 "when nothing is mounted."
24171 #: ../fish/guestfish-actions.pod:2442
24173 "Not all of the filesystems returned will be mountable. In particular, swap "
24174 "partitions are returned in the list. Also this command does not check that "
24175 "each filesystem found is valid and mountable, and some filesystems might be "
24176 "mountable but require special options. Filesystems may not all belong to a "
24177 "single logical operating system (use L</inspect-os> to look for OSes)."
24181 #: ../fish/guestfish-actions.pod:2450
24182 msgid "list-partitions"
24186 #: ../fish/guestfish-actions.pod:2452
24189 " list-partitions\n"
24194 #: ../fish/guestfish-actions.pod:2458
24196 "This does not return logical volumes. For that you will need to call L</"
24201 #: ../fish/guestfish-actions.pod:2463
24206 #: ../fish/guestfish-actions.pod:2465
24214 #: ../fish/guestfish-actions.pod:2473
24219 #: ../fish/guestfish-actions.pod:2475
24222 " ln target linkname\n"
24227 #: ../fish/guestfish-actions.pod:2479
24232 #: ../fish/guestfish-actions.pod:2481
24235 " ln-f target linkname\n"
24240 #: ../fish/guestfish-actions.pod:2486
24245 #: ../fish/guestfish-actions.pod:2488
24248 " ln-s target linkname\n"
24253 #: ../fish/guestfish-actions.pod:2492
24258 #: ../fish/guestfish-actions.pod:2494
24261 " ln-sf target linkname\n"
24266 #: ../fish/guestfish-actions.pod:2499
24267 msgid "lremovexattr"
24271 #: ../fish/guestfish-actions.pod:2501
24274 " lremovexattr xattr path\n"
24279 #: ../fish/guestfish-actions.pod:2503
24281 "This is the same as L</removexattr>, but if C<path> is a symbolic link, then "
24282 "it removes an extended attribute of the link itself."
24286 #: ../fish/guestfish-actions.pod:2507
24291 #: ../fish/guestfish-actions.pod:2509
24299 #: ../fish/guestfish-actions.pod:2515
24301 "This command is mostly useful for interactive sessions. Programs should "
24302 "probably use L</readdir> instead."
24306 #: ../fish/guestfish-actions.pod:2518
24311 #: ../fish/guestfish-actions.pod:2520
24314 " lsetxattr xattr val vallen path\n"
24319 #: ../fish/guestfish-actions.pod:2522
24321 "This is the same as L</setxattr>, but if C<path> is a symbolic link, then it "
24322 "sets an extended attribute of the link itself."
24326 #: ../fish/guestfish-actions.pod:2526
24331 #: ../fish/guestfish-actions.pod:2528
24339 #: ../fish/guestfish-actions.pod:2532
24341 "This is the same as L</stat> except that if C<path> is a symbolic link, then "
24342 "the link is stat-ed, not the file it refers to."
24346 #: ../fish/guestfish-actions.pod:2538
24351 #: ../fish/guestfish-actions.pod:2540
24354 " lstatlist path 'names ...'\n"
24359 #: ../fish/guestfish-actions.pod:2542
24361 "This call allows you to perform the L</lstat> operation on multiple files, "
24362 "where all files are in the directory C<path>. C<names> is the list of files "
24363 "from this directory."
24367 #: ../fish/guestfish-actions.pod:2551
24369 "This call is intended for programs that want to efficiently list a directory "
24370 "contents without making many round-trips. See also L</lxattrlist> for a "
24371 "similarly efficient call for getting extended attributes. Very long "
24372 "directory listings might cause the protocol message size to be exceeded, "
24373 "causing this call to fail. The caller must split up such requests into "
24374 "smaller groups of names."
24378 #: ../fish/guestfish-actions.pod:2559
24379 msgid "luks-add-key"
24383 #: ../fish/guestfish-actions.pod:2561
24386 " luks-add-key device keyslot\n"
24391 #: ../fish/guestfish-actions.pod:2568
24393 "Note that if C<keyslot> already contains a key, then this command will "
24394 "fail. You have to use L</luks-kill-slot> first to remove that key."
24398 #: ../fish/guestfish-actions.pod:2572 ../fish/guestfish-actions.pod:2594
24399 #: ../fish/guestfish-actions.pod:2607 ../fish/guestfish-actions.pod:2621
24400 #: ../fish/guestfish-actions.pod:2644 ../fish/guestfish-actions.pod:2654
24402 "This command has one or more key or passphrase parameters. Guestfish will "
24403 "prompt for these separately."
24407 #: ../fish/guestfish-actions.pod:2575
24412 #: ../fish/guestfish-actions.pod:2577
24415 " luks-close device\n"
24420 #: ../fish/guestfish-actions.pod:2579
24422 "This closes a LUKS device that was created earlier by L</luks-open> or L</"
24423 "luks-open-ro>. The C<device> parameter must be the name of the LUKS mapping "
24424 "device (ie. C</dev/mapper/mapname>) and I<not> the name of the underlying "
24429 #: ../fish/guestfish-actions.pod:2585
24430 msgid "luks-format"
24434 #: ../fish/guestfish-actions.pod:2587
24437 " luks-format device keyslot\n"
24442 #: ../fish/guestfish-actions.pod:2600
24443 msgid "luks-format-cipher"
24447 #: ../fish/guestfish-actions.pod:2602
24450 " luks-format-cipher device keyslot cipher\n"
24455 #: ../fish/guestfish-actions.pod:2604
24457 "This command is the same as L</luks-format> but it also allows you to set "
24458 "the C<cipher> used."
24462 #: ../fish/guestfish-actions.pod:2613
24463 msgid "luks-kill-slot"
24467 #: ../fish/guestfish-actions.pod:2615
24470 " luks-kill-slot device keyslot\n"
24475 #: ../fish/guestfish-actions.pod:2624
24480 #: ../fish/guestfish-actions.pod:2626
24483 " luks-open device mapname\n"
24488 #: ../fish/guestfish-actions.pod:2640
24490 "If this block device contains LVM volume groups, then calling L</vgscan> "
24491 "followed by L</vg-activate-all> will make them visible."
24495 #: ../fish/guestfish-actions.pod:2647
24496 msgid "luks-open-ro"
24500 #: ../fish/guestfish-actions.pod:2649
24503 " luks-open-ro device mapname\n"
24508 #: ../fish/guestfish-actions.pod:2651
24510 "This is the same as L</luks-open> except that a read-only mapping is created."
24514 #: ../fish/guestfish-actions.pod:2657
24519 #: ../fish/guestfish-actions.pod:2659
24522 " lvcreate logvol volgroup mbytes\n"
24527 #: ../fish/guestfish-actions.pod:2664
24528 msgid "lvm-canonical-lv-name"
24532 #: ../fish/guestfish-actions.pod:2666
24535 " lvm-canonical-lv-name lvname\n"
24540 #: ../fish/guestfish-actions.pod:2675
24541 msgid "See also L</is-lv>."
24545 #: ../fish/guestfish-actions.pod:2677
24546 msgid "lvm-clear-filter"
24550 #: ../fish/guestfish-actions.pod:2679
24553 " lvm-clear-filter\n"
24558 #: ../fish/guestfish-actions.pod:2681
24560 "This undoes the effect of L</lvm-set-filter>. LVM will be able to see every "
24565 #: ../fish/guestfish-actions.pod:2687
24566 msgid "lvm-remove-all"
24570 #: ../fish/guestfish-actions.pod:2689
24573 " lvm-remove-all\n"
24578 #: ../fish/guestfish-actions.pod:2697
24579 msgid "lvm-set-filter"
24583 #: ../fish/guestfish-actions.pod:2699
24586 " lvm-set-filter 'devices ...'\n"
24591 #: ../fish/guestfish-actions.pod:2724
24596 #: ../fish/guestfish-actions.pod:2726
24599 " lvremove device\n"
24604 #: ../fish/guestfish-actions.pod:2734
24609 #: ../fish/guestfish-actions.pod:2736
24612 " lvrename logvol newlogvol\n"
24617 #: ../fish/guestfish-actions.pod:2740
24622 #: ../fish/guestfish-actions.pod:2742
24625 " lvresize device mbytes\n"
24630 #: ../fish/guestfish-actions.pod:2748
24631 msgid "lvresize-free"
24635 #: ../fish/guestfish-actions.pod:2750
24638 " lvresize-free lv percent\n"
24643 #: ../fish/guestfish-actions.pod:2758
24648 #: ../fish/guestfish-actions.pod:2760
24656 #: ../fish/guestfish-actions.pod:2768
24657 msgid "See also L</lvs-full>, L</list-filesystems>."
24661 #: ../fish/guestfish-actions.pod:2770
24666 #: ../fish/guestfish-actions.pod:2772
24674 #: ../fish/guestfish-actions.pod:2777
24679 #: ../fish/guestfish-actions.pod:2779
24687 #: ../fish/guestfish-actions.pod:2783
24692 #: ../fish/guestfish-actions.pod:2785
24695 " lxattrlist path 'names ...'\n"
24700 #: ../fish/guestfish-actions.pod:2801
24702 "This call is intended for programs that want to efficiently list a directory "
24703 "contents without making many round-trips. See also L</lstatlist> for a "
24704 "similarly efficient call for getting standard stats. Very long directory "
24705 "listings might cause the protocol message size to be exceeded, causing this "
24706 "call to fail. The caller must split up such requests into smaller groups of "
24711 #: ../fish/guestfish-actions.pod:2809
24716 #: ../fish/guestfish-actions.pod:2811
24724 #: ../fish/guestfish-actions.pod:2815
24729 #: ../fish/guestfish-actions.pod:2817
24732 " mkdir-mode path mode\n"
24737 #: ../fish/guestfish-actions.pod:2826
24738 msgid "See also L</mkdir>, L</umask>"
24742 #: ../fish/guestfish-actions.pod:2828
24747 #: ../fish/guestfish-actions.pod:2830
24755 #: ../fish/guestfish-actions.pod:2835
24760 #: ../fish/guestfish-actions.pod:2837
24763 " mkdtemp template\n"
24768 #: ../fish/guestfish-actions.pod:2858
24773 #: ../fish/guestfish-actions.pod:2860
24776 " mke2fs-J fstype blocksize device journal\n"
24781 #: ../fish/guestfish-actions.pod:2868
24782 msgid "See also L</mke2journal>."
24786 #: ../fish/guestfish-actions.pod:2870
24791 #: ../fish/guestfish-actions.pod:2872
24794 " mke2fs-JL fstype blocksize device label\n"
24799 #: ../fish/guestfish-actions.pod:2877
24800 msgid "See also L</mke2journal-L>."
24804 #: ../fish/guestfish-actions.pod:2879
24809 #: ../fish/guestfish-actions.pod:2881
24812 " mke2fs-JU fstype blocksize device uuid\n"
24817 #: ../fish/guestfish-actions.pod:2886
24818 msgid "See also L</mke2journal-U>."
24822 #: ../fish/guestfish-actions.pod:2888
24823 msgid "mke2journal"
24827 #: ../fish/guestfish-actions.pod:2890
24830 " mke2journal blocksize device\n"
24835 #: ../fish/guestfish-actions.pod:2897
24836 msgid "mke2journal-L"
24840 #: ../fish/guestfish-actions.pod:2899
24843 " mke2journal-L blocksize label device\n"
24848 #: ../fish/guestfish-actions.pod:2903
24849 msgid "mke2journal-U"
24853 #: ../fish/guestfish-actions.pod:2905
24856 " mke2journal-U blocksize uuid device\n"
24861 #: ../fish/guestfish-actions.pod:2909
24866 #: ../fish/guestfish-actions.pod:2911
24869 " mkfifo mode path\n"
24874 #: ../fish/guestfish-actions.pod:2913
24876 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
24877 "is just a convenient wrapper around L</mknod>."
24881 #: ../fish/guestfish-actions.pod:2919
24886 #: ../fish/guestfish-actions.pod:2921
24889 " mkfs fstype device\n"
24894 #: ../fish/guestfish-actions.pod:2927
24899 #: ../fish/guestfish-actions.pod:2929
24902 " mkfs-b fstype blocksize device\n"
24907 #: ../fish/guestfish-actions.pod:2931
24909 "This call is similar to L</mkfs>, but it allows you to control the block "
24910 "size of the resulting filesystem. Supported block sizes depend on the "
24911 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
24915 #: ../fish/guestfish-actions.pod:2946
24920 #: ../fish/guestfish-actions.pod:2948
24923 " mkfs-opts fstype device [blocksize:..] [features:..]\n"
24928 #: ../fish/guestfish-actions.pod:2983
24929 msgid "mkmountpoint"
24933 #: ../fish/guestfish-actions.pod:2985
24936 " mkmountpoint exemptpath\n"
24941 #: ../fish/guestfish-actions.pod:2987
24943 "L</mkmountpoint> and L</rmmountpoint> are specialized calls that can be used "
24944 "to create extra mountpoints before mounting the first filesystem."
24948 #: ../fish/guestfish-actions.pod:3011
24950 "L</mkmountpoint> is not compatible with L</umount-all>. You may get "
24951 "unexpected errors if you try to mix these calls. It is safest to manually "
24952 "unmount filesystems and remove mountpoints after use."
24956 #: ../fish/guestfish-actions.pod:3015
24958 "L</umount-all> unmounts filesystems by sorting the paths longest first, so "
24959 "for this to work for manual mountpoints, you must ensure that the innermost "
24960 "mountpoints have the longest pathnames, as in the example code above."
24964 #: ../fish/guestfish-actions.pod:3022
24966 "Autosync [see L</set-autosync>, this is set by default on handles] can cause "
24967 "L</umount-all> to be called when the handle is closed which can also trigger "
24972 #: ../fish/guestfish-actions.pod:3026
24977 #: ../fish/guestfish-actions.pod:3028
24980 " mknod mode devmajor devminor path\n"
24985 #: ../fish/guestfish-actions.pod:3038
24987 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
24988 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
24989 "regular file). These constants are available in the standard Linux header "
24990 "files, or you can use L</mknod-b>, L</mknod-c> or L</mkfifo> which are "
24991 "wrappers around this command which bitwise OR in the appropriate constant "
24996 #: ../fish/guestfish-actions.pod:3048
25001 #: ../fish/guestfish-actions.pod:3050
25004 " mknod-b mode devmajor devminor path\n"
25009 #: ../fish/guestfish-actions.pod:3052
25011 "This call creates a block device node called C<path> with mode C<mode> and "
25012 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
25013 "wrapper around L</mknod>."
25017 #: ../fish/guestfish-actions.pod:3058
25022 #: ../fish/guestfish-actions.pod:3060
25025 " mknod-c mode devmajor devminor path\n"
25030 #: ../fish/guestfish-actions.pod:3062
25032 "This call creates a char device node called C<path> with mode C<mode> and "
25033 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
25034 "wrapper around L</mknod>."
25038 #: ../fish/guestfish-actions.pod:3068
25043 #: ../fish/guestfish-actions.pod:3070
25051 #: ../fish/guestfish-actions.pod:3074
25056 #: ../fish/guestfish-actions.pod:3076
25059 " mkswap-L label device\n"
25064 #: ../fish/guestfish-actions.pod:3084
25069 #: ../fish/guestfish-actions.pod:3086
25072 " mkswap-U uuid device\n"
25077 #: ../fish/guestfish-actions.pod:3090
25078 msgid "mkswap-file"
25082 #: ../fish/guestfish-actions.pod:3092
25085 " mkswap-file path\n"
25090 #: ../fish/guestfish-actions.pod:3096
25092 "This command just writes a swap file signature to an existing file. To "
25093 "create the file itself, use something like L</fallocate>."
25097 #: ../fish/guestfish-actions.pod:3099
25102 #: ../fish/guestfish-actions.pod:3101
25105 " modprobe modulename\n"
25110 #: ../fish/guestfish-actions.pod:3108
25115 #: ../fish/guestfish-actions.pod:3110
25118 " mount device mountpoint\n"
25123 #: ../fish/guestfish-actions.pod:3126
25125 "B<Important note:> When you use this call, the filesystem options C<sync> "
25126 "and C<noatime> are set implicitly. This was originally done because we "
25127 "thought it would improve reliability, but it turns out that I<-o sync> has a "
25128 "very large negative performance impact and negligible effect on "
25129 "reliability. Therefore we recommend that you avoid using L</mount> in any "
25130 "code that needs performance, and instead use L</mount-options> (use an empty "
25131 "string for the first parameter if you don't want any options)."
25135 #: ../fish/guestfish-actions.pod:3136
25140 #: ../fish/guestfish-actions.pod:3138
25143 " mount-loop file mountpoint\n"
25148 #: ../fish/guestfish-actions.pod:3144
25149 msgid "mount-options"
25153 #: ../fish/guestfish-actions.pod:3146
25156 " mount-options options device mountpoint\n"
25161 #: ../fish/guestfish-actions.pod:3148
25163 "This is the same as the L</mount> command, but it allows you to set the "
25164 "mount options as for the L<mount(8)> I<-o> flag."
25168 #: ../fish/guestfish-actions.pod:3156
25173 #: ../fish/guestfish-actions.pod:3158
25176 " mount-ro device mountpoint\n"
25181 #: ../fish/guestfish-actions.pod:3160
25183 "This is the same as the L</mount> command, but it mounts the filesystem with "
25184 "the read-only (I<-o ro>) flag."
25188 #: ../fish/guestfish-actions.pod:3163
25193 #: ../fish/guestfish-actions.pod:3165
25196 " mount-vfs options vfstype device mountpoint\n"
25201 #: ../fish/guestfish-actions.pod:3167
25203 "This is the same as the L</mount> command, but it allows you to set both the "
25204 "mount options and the vfstype as for the L<mount(8)> I<-o> and I<-t> flags."
25208 #: ../fish/guestfish-actions.pod:3171
25209 msgid "mountpoints"
25213 #: ../fish/guestfish-actions.pod:3173
25221 #: ../fish/guestfish-actions.pod:3175
25223 "This call is similar to L</mounts>. That call returns a list of devices. "
25224 "This one returns a hash table (map) of device name to directory where the "
25225 "device is mounted."
25229 #: ../fish/guestfish-actions.pod:3179
25234 #: ../fish/guestfish-actions.pod:3181
25242 #: ../fish/guestfish-actions.pod:3188
25243 msgid "See also: L</mountpoints>"
25247 #: ../fish/guestfish-actions.pod:3190
25252 #: ../fish/guestfish-actions.pod:3192
25260 #: ../fish/guestfish-actions.pod:3197
25261 msgid "ntfs-3g-probe"
25265 #: ../fish/guestfish-actions.pod:3199
25268 " ntfs-3g-probe true|false device\n"
25273 #: ../fish/guestfish-actions.pod:3213
25278 #: ../fish/guestfish-actions.pod:3215
25281 " ntfsresize device\n"
25286 #: ../fish/guestfish-actions.pod:3221
25287 msgid "ntfsresize-size"
25291 #: ../fish/guestfish-actions.pod:3223
25294 " ntfsresize-size device size\n"
25299 #: ../fish/guestfish-actions.pod:3225
25301 "This command is the same as L</ntfsresize> except that it allows you to "
25302 "specify the new size (in bytes) explicitly."
25306 #: ../fish/guestfish-actions.pod:3228
25311 #: ../fish/guestfish-actions.pod:3230
25314 " part-add device prlogex startsect endsect\n"
25319 #: ../fish/guestfish-actions.pod:3232
25321 "This command adds a partition to C<device>. If there is no partition table "
25322 "on the device, call L</part-init> first."
25326 #: ../fish/guestfish-actions.pod:3244
25328 "Creating a partition which covers the whole disk is not so easy. Use L</"
25329 "part-disk> to do that."
25333 #: ../fish/guestfish-actions.pod:3247
25338 #: ../fish/guestfish-actions.pod:3249
25341 " part-del device partnum\n"
25346 #: ../fish/guestfish-actions.pod:3257
25351 #: ../fish/guestfish-actions.pod:3259
25354 " part-disk device parttype\n"
25359 #: ../fish/guestfish-actions.pod:3261
25361 "This command is simply a combination of L</part-init> followed by L</part-"
25362 "add> to create a single primary partition covering the whole disk."
25366 #: ../fish/guestfish-actions.pod:3265
25368 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
25369 "possible values are described in L</part-init>."
25373 #: ../fish/guestfish-actions.pod:3271
25374 msgid "part-get-bootable"
25378 #: ../fish/guestfish-actions.pod:3273
25381 " part-get-bootable device partnum\n"
25386 #: ../fish/guestfish-actions.pod:3278
25387 msgid "See also L</part-set-bootable>."
25391 #: ../fish/guestfish-actions.pod:3280
25392 msgid "part-get-mbr-id"
25396 #: ../fish/guestfish-actions.pod:3282
25399 " part-get-mbr-id device partnum\n"
25404 #: ../fish/guestfish-actions.pod:3287 ../fish/guestfish-actions.pod:3425
25406 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
25407 "undefined results for other partition table types (see L</part-get-"
25412 #: ../fish/guestfish-actions.pod:3291
25413 msgid "part-get-parttype"
25417 #: ../fish/guestfish-actions.pod:3293
25420 " part-get-parttype device\n"
25425 #: ../fish/guestfish-actions.pod:3298
25427 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
25428 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
25429 "possible, although unusual. See L</part-init> for a full list."
25433 #: ../fish/guestfish-actions.pod:3303
25438 #: ../fish/guestfish-actions.pod:3305
25441 " part-init device parttype\n"
25446 #: ../fish/guestfish-actions.pod:3311
25448 "Initially there are no partitions. Following this, you should call L</part-"
25449 "add> for each partition required."
25453 #: ../fish/guestfish-actions.pod:3374
25458 #: ../fish/guestfish-actions.pod:3376
25461 " part-list device\n"
25466 #: ../fish/guestfish-actions.pod:3391
25468 "Start of the partition I<in bytes>. To get sectors you have to divide by "
25469 "the device's sector size, see L</blockdev-getss>."
25473 #: ../fish/guestfish-actions.pod:3404
25474 msgid "part-set-bootable"
25478 #: ../fish/guestfish-actions.pod:3406
25481 " part-set-bootable device partnum true|false\n"
25486 #: ../fish/guestfish-actions.pod:3415
25487 msgid "part-set-mbr-id"
25491 #: ../fish/guestfish-actions.pod:3417
25494 " part-set-mbr-id device partnum idbyte\n"
25499 #: ../fish/guestfish-actions.pod:3429
25500 msgid "part-set-name"
25504 #: ../fish/guestfish-actions.pod:3431
25507 " part-set-name device partnum name\n"
25512 #: ../fish/guestfish-actions.pod:3439
25513 msgid "part-to-dev"
25517 #: ../fish/guestfish-actions.pod:3441
25520 " part-to-dev partition\n"
25525 #: ../fish/guestfish-actions.pod:3447
25527 "The named partition must exist, for example as a string returned from L</"
25528 "list-partitions>."
25532 #: ../fish/guestfish-actions.pod:3450
25533 msgid "ping-daemon"
25537 #: ../fish/guestfish-actions.pod:3452
25545 #: ../fish/guestfish-actions.pod:3459
25550 #: ../fish/guestfish-actions.pod:3461
25553 " pread path count offset\n"
25558 #: ../fish/guestfish-actions.pod:3469
25559 msgid "See also L</pwrite>, L</pread-device>."
25563 #: ../fish/guestfish-actions.pod:3474
25564 msgid "pread-device"
25568 #: ../fish/guestfish-actions.pod:3476
25571 " pread-device device count offset\n"
25576 #: ../fish/guestfish-actions.pod:3484
25577 msgid "See also L</pread>."
25581 #: ../fish/guestfish-actions.pod:3489
25586 #: ../fish/guestfish-actions.pod:3491
25589 " pvcreate device\n"
25594 #: ../fish/guestfish-actions.pod:3497
25599 #: ../fish/guestfish-actions.pod:3499
25602 " pvremove device\n"
25607 #: ../fish/guestfish-actions.pod:3508
25612 #: ../fish/guestfish-actions.pod:3510
25615 " pvresize device\n"
25620 #: ../fish/guestfish-actions.pod:3515
25621 msgid "pvresize-size"
25625 #: ../fish/guestfish-actions.pod:3517
25628 " pvresize-size device size\n"
25633 #: ../fish/guestfish-actions.pod:3519
25635 "This command is the same as L</pvresize> except that it allows you to "
25636 "specify the new size (in bytes) explicitly."
25640 #: ../fish/guestfish-actions.pod:3522
25645 #: ../fish/guestfish-actions.pod:3524
25653 #: ../fish/guestfish-actions.pod:3532
25654 msgid "See also L</pvs-full>."
25658 #: ../fish/guestfish-actions.pod:3534
25663 #: ../fish/guestfish-actions.pod:3536
25671 #: ../fish/guestfish-actions.pod:3541
25676 #: ../fish/guestfish-actions.pod:3543
25684 #: ../fish/guestfish-actions.pod:3547
25689 #: ../fish/guestfish-actions.pod:3549
25692 " pwrite path content offset\n"
25697 #: ../fish/guestfish-actions.pod:3560
25698 msgid "See also L</pread>, L</pwrite-device>."
25702 #: ../fish/guestfish-actions.pod:3565
25703 msgid "pwrite-device"
25707 #: ../fish/guestfish-actions.pod:3567
25710 " pwrite-device device content offset\n"
25715 #: ../fish/guestfish-actions.pod:3577
25716 msgid "See also L</pwrite>."
25720 #: ../fish/guestfish-actions.pod:3582
25725 #: ../fish/guestfish-actions.pod:3584
25728 " read-file path\n"
25733 #: ../fish/guestfish-actions.pod:3589
25735 "Unlike L</cat>, this function can correctly handle files that contain "
25736 "embedded ASCII NUL characters. However unlike L</download>, this function "
25737 "is limited in the total size of file that can be handled."
25741 #: ../fish/guestfish-actions.pod:3597
25746 #: ../fish/guestfish-actions.pod:3599
25749 " read-lines path\n"
25754 #: ../fish/guestfish-actions.pod:3606
25756 "Note that this function cannot correctly handle binary files (specifically, "
25757 "files containing C<\\0> character which is treated as end of line). For "
25758 "those you need to use the L</read-file> function which has a more complex "
25763 #: ../fish/guestfish-actions.pod:3611
25768 #: ../fish/guestfish-actions.pod:3613
25776 #: ../fish/guestfish-actions.pod:3665
25778 "This function is primarily intended for use by programs. To get a simple "
25779 "list of names, use L</ls>. To get a printable directory for human "
25780 "consumption, use L</ll>."
25784 #: ../fish/guestfish-actions.pod:3669
25789 #: ../fish/guestfish-actions.pod:3671
25797 #: ../fish/guestfish-actions.pod:3675
25798 msgid "readlinklist"
25802 #: ../fish/guestfish-actions.pod:3677
25805 " readlinklist path 'names ...'\n"
25810 #: ../fish/guestfish-actions.pod:3701
25815 #: ../fish/guestfish-actions.pod:3703
25823 #: ../fish/guestfish-actions.pod:3708
25824 msgid "removexattr"
25828 #: ../fish/guestfish-actions.pod:3710
25831 " removexattr xattr path\n"
25836 #: ../fish/guestfish-actions.pod:3715
25837 msgid "See also: L</lremovexattr>, L<attr(5)>."
25841 #: ../fish/guestfish-actions.pod:3717
25846 #: ../fish/guestfish-actions.pod:3719
25849 " resize2fs device\n"
25854 #: ../fish/guestfish-actions.pod:3724
25856 "I<Note:> It is sometimes required that you run L</e2fsck-f> on the C<device> "
25857 "before calling this command. For unknown reasons C<resize2fs> sometimes "
25858 "gives an error about this and sometimes not. In any case, it is always safe "
25859 "to call L</e2fsck-f> before calling this function."
25863 #: ../fish/guestfish-actions.pod:3730
25864 msgid "resize2fs-M"
25868 #: ../fish/guestfish-actions.pod:3732
25871 " resize2fs-M device\n"
25876 #: ../fish/guestfish-actions.pod:3734
25878 "This command is the same as L</resize2fs>, but the filesystem is resized to "
25879 "its minimum size. This works like the C<-M> option to the C<resize2fs> "
25884 #: ../fish/guestfish-actions.pod:3738
25886 "To get the resulting size of the filesystem you should call L</tune2fs-l> "
25887 "and read the C<Block size> and C<Block count> values. These two numbers, "
25888 "multiplied together, give the resulting size of the minimal filesystem in "
25893 #: ../fish/guestfish-actions.pod:3743
25894 msgid "resize2fs-size"
25898 #: ../fish/guestfish-actions.pod:3745
25901 " resize2fs-size device size\n"
25906 #: ../fish/guestfish-actions.pod:3747
25908 "This command is the same as L</resize2fs> except that it allows you to "
25909 "specify the new size (in bytes) explicitly."
25913 #: ../fish/guestfish-actions.pod:3750
25918 #: ../fish/guestfish-actions.pod:3752
25926 #: ../fish/guestfish-actions.pod:3756
25931 #: ../fish/guestfish-actions.pod:3758
25939 #: ../fish/guestfish-actions.pod:3764
25944 #: ../fish/guestfish-actions.pod:3766
25952 #: ../fish/guestfish-actions.pod:3770
25953 msgid "rmmountpoint"
25957 #: ../fish/guestfish-actions.pod:3772
25960 " rmmountpoint exemptpath\n"
25965 #: ../fish/guestfish-actions.pod:3774
25967 "This calls removes a mountpoint that was previously created with L</"
25968 "mkmountpoint>. See L</mkmountpoint> for full details."
25972 #: ../fish/guestfish-actions.pod:3778
25973 msgid "scrub-device"
25977 #: ../fish/guestfish-actions.pod:3780
25980 " scrub-device device\n"
25985 #: ../fish/guestfish-actions.pod:3791
25990 #: ../fish/guestfish-actions.pod:3793
25993 " scrub-file file\n"
25998 #: ../fish/guestfish-actions.pod:3803
25999 msgid "scrub-freespace"
26003 #: ../fish/guestfish-actions.pod:3805
26006 " scrub-freespace dir\n"
26011 #: ../fish/guestfish-actions.pod:3807
26013 "This command creates the directory C<dir> and then fills it with files until "
26014 "the filesystem is full, and scrubs the files as for L</scrub-file>, and "
26015 "deletes them. The intention is to scrub any free space on the partition "
26016 "containing C<dir>."
26020 #: ../fish/guestfish-actions.pod:3816
26025 #: ../fish/guestfish-actions.pod:3818
26030 #: ../fish/guestfish-actions.pod:3820
26033 " set-append append\n"
26038 #: ../fish/guestfish-actions.pod:3831
26039 msgid "set-attach-method"
26043 #: ../fish/guestfish-actions.pod:3833
26044 msgid "attach-method"
26048 #: ../fish/guestfish-actions.pod:3835
26051 " set-attach-method attachmethod\n"
26056 #: ../fish/guestfish-actions.pod:3857
26057 msgid "set-autosync"
26061 #: ../fish/guestfish-actions.pod:3859
26066 #: ../fish/guestfish-actions.pod:3861
26069 " set-autosync true|false\n"
26074 #: ../fish/guestfish-actions.pod:3871
26079 #: ../fish/guestfish-actions.pod:3873
26084 #: ../fish/guestfish-actions.pod:3875
26087 " set-direct true|false\n"
26092 #: ../fish/guestfish-actions.pod:3881
26094 "One consequence of this is that log messages aren't caught by the library "
26095 "and handled by L</set-log-message-callback>, but go straight to stdout."
26099 #: ../fish/guestfish-actions.pod:3890
26100 msgid "set-e2label"
26104 #: ../fish/guestfish-actions.pod:3892
26107 " set-e2label device label\n"
26112 #: ../fish/guestfish-actions.pod:3898
26114 "You can use either L</tune2fs-l> or L</get-e2label> to return the existing "
26115 "label on a filesystem."
26119 #: ../fish/guestfish-actions.pod:3901
26124 #: ../fish/guestfish-actions.pod:3903
26127 " set-e2uuid device uuid\n"
26132 #: ../fish/guestfish-actions.pod:3910
26134 "You can use either L</tune2fs-l> or L</get-e2uuid> to return the existing "
26135 "UUID of a filesystem."
26139 #: ../fish/guestfish-actions.pod:3913
26140 msgid "set-memsize"
26144 #: ../fish/guestfish-actions.pod:3915
26149 #: ../fish/guestfish-actions.pod:3917
26152 " set-memsize memsize\n"
26157 #: ../fish/guestfish-actions.pod:3919
26159 "This sets the memory size in megabytes allocated to the qemu subprocess. "
26160 "This only has any effect if called before L</launch>."
26164 #: ../fish/guestfish-actions.pod:3930
26165 msgid "set-network"
26169 #: ../fish/guestfish-actions.pod:3932
26174 #: ../fish/guestfish-actions.pod:3934
26177 " set-network true|false\n"
26182 #: ../fish/guestfish-actions.pod:3942
26184 "You must call this before calling L</launch>, otherwise it has no effect."
26188 #: ../fish/guestfish-actions.pod:3945
26193 #: ../fish/guestfish-actions.pod:3947
26198 #: ../fish/guestfish-actions.pod:3949
26201 " set-path searchpath\n"
26206 #: ../fish/guestfish-actions.pod:3958
26211 #: ../fish/guestfish-actions.pod:3960
26216 #: ../fish/guestfish-actions.pod:3962
26224 #: ../fish/guestfish-actions.pod:3982
26225 msgid "set-recovery-proc"
26229 #: ../fish/guestfish-actions.pod:3984
26230 msgid "recovery-proc"
26234 #: ../fish/guestfish-actions.pod:3986
26237 " set-recovery-proc true|false\n"
26242 #: ../fish/guestfish-actions.pod:3988
26244 "If this is called with the parameter C<false> then L</launch> does not "
26245 "create a recovery process. The purpose of the recovery process is to stop "
26246 "runaway qemu processes in the case where the main program aborts abruptly."
26250 #: ../fish/guestfish-actions.pod:3993
26252 "This only has any effect if called before L</launch>, and the default is "
26257 #: ../fish/guestfish-actions.pod:4002
26258 msgid "set-selinux"
26262 #: ../fish/guestfish-actions.pod:4004
26267 #: ../fish/guestfish-actions.pod:4006
26270 " set-selinux true|false\n"
26275 #: ../fish/guestfish-actions.pod:4017
26280 #: ../fish/guestfish-actions.pod:4019
26285 #: ../fish/guestfish-actions.pod:4021
26288 " set-trace true|false\n"
26293 #: ../fish/guestfish-actions.pod:4033
26295 "Trace messages are normally sent to C<stderr>, unless you register a "
26296 "callback to send them somewhere else (see L</set-event-callback>)."
26300 #: ../fish/guestfish-actions.pod:4037
26301 msgid "set-verbose"
26305 #: ../fish/guestfish-actions.pod:4039
26310 #: ../fish/guestfish-actions.pod:4041
26313 " set-verbose true|false\n"
26318 #: ../fish/guestfish-actions.pod:4048
26320 "Verbose messages are normally sent to C<stderr>, unless you register a "
26321 "callback to send them somewhere else (see L</set-event-callback>)."
26325 #: ../fish/guestfish-actions.pod:4052
26330 #: ../fish/guestfish-actions.pod:4054
26333 " setcon context\n"
26338 #: ../fish/guestfish-actions.pod:4061
26343 #: ../fish/guestfish-actions.pod:4063
26346 " setxattr xattr val vallen path\n"
26351 #: ../fish/guestfish-actions.pod:4069
26352 msgid "See also: L</lsetxattr>, L<attr(5)>."
26356 #: ../fish/guestfish-actions.pod:4071
26361 #: ../fish/guestfish-actions.pod:4073
26364 " sfdisk device cyls heads sectors 'lines ...'\n"
26369 #: ../fish/guestfish-actions.pod:4095
26370 msgid "See also: L</sfdisk-l>, L</sfdisk-N>, L</part-init>"
26374 #: ../fish/guestfish-actions.pod:4101
26379 #: ../fish/guestfish-actions.pod:4103
26382 " sfdiskM device 'lines ...'\n"
26387 #: ../fish/guestfish-actions.pod:4105
26389 "This is a simplified interface to the L</sfdisk> command, where partition "
26390 "sizes are specified in megabytes only (rounded to the nearest cylinder) and "
26391 "you don't need to specify the cyls, heads and sectors parameters which were "
26392 "rarely if ever used anyway."
26396 #: ../fish/guestfish-actions.pod:4111
26397 msgid "See also: L</sfdisk>, the L<sfdisk(8)> manpage and L</part-disk>"
26401 #: ../fish/guestfish-actions.pod:4117
26406 #: ../fish/guestfish-actions.pod:4119
26409 " sfdisk-N device partnum cyls heads sectors line\n"
26414 #: ../fish/guestfish-actions.pod:4124
26416 "For other parameters, see L</sfdisk>. You should usually pass C<0> for the "
26417 "cyls/heads/sectors parameters."
26421 #: ../fish/guestfish-actions.pod:4127
26422 msgid "See also: L</part-add>"
26426 #: ../fish/guestfish-actions.pod:4132
26427 msgid "sfdisk-disk-geometry"
26431 #: ../fish/guestfish-actions.pod:4134
26434 " sfdisk-disk-geometry device\n"
26439 #: ../fish/guestfish-actions.pod:4136
26441 "This displays the disk geometry of C<device> read from the partition table. "
26442 "Especially in the case where the underlying block device has been resized, "
26443 "this can be different from the kernel's idea of the geometry (see L</sfdisk-"
26444 "kernel-geometry>)."
26448 #: ../fish/guestfish-actions.pod:4144
26449 msgid "sfdisk-kernel-geometry"
26453 #: ../fish/guestfish-actions.pod:4146
26456 " sfdisk-kernel-geometry device\n"
26461 #: ../fish/guestfish-actions.pod:4153
26466 #: ../fish/guestfish-actions.pod:4155
26469 " sfdisk-l device\n"
26474 #: ../fish/guestfish-actions.pod:4161
26475 msgid "See also: L</part-list>"
26479 #: ../fish/guestfish-actions.pod:4163
26484 #: ../fish/guestfish-actions.pod:4165
26492 #: ../fish/guestfish-actions.pod:4170
26493 msgid "This is like L</command>, but passes the command to:"
26497 #: ../fish/guestfish-actions.pod:4178
26498 msgid "All the provisos about L</command> apply to this call."
26502 #: ../fish/guestfish-actions.pod:4180
26507 #: ../fish/guestfish-actions.pod:4182
26510 " sh-lines command\n"
26515 #: ../fish/guestfish-actions.pod:4184
26516 msgid "This is the same as L</sh>, but splits the result into a list of lines."
26520 #: ../fish/guestfish-actions.pod:4187
26521 msgid "See also: L</command-lines>"
26525 #: ../fish/guestfish-actions.pod:4189
26530 #: ../fish/guestfish-actions.pod:4191
26538 #: ../fish/guestfish-actions.pod:4195
26543 #: ../fish/guestfish-actions.pod:4197
26551 #: ../fish/guestfish-actions.pod:4203
26556 #: ../fish/guestfish-actions.pod:4205
26564 #: ../fish/guestfish-actions.pod:4213
26569 #: ../fish/guestfish-actions.pod:4215
26577 #: ../fish/guestfish-actions.pod:4223
26582 #: ../fish/guestfish-actions.pod:4225
26585 " strings-e encoding path\n"
26590 #: ../fish/guestfish-actions.pod:4227
26592 "This is like the L</strings> command, but allows you to specify the encoding "
26593 "of strings that are looked for in the source file C<path>."
26597 #: ../fish/guestfish-actions.pod:4237
26599 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
26600 "ISO-8859-X (this is what L</strings> uses)."
26604 #: ../fish/guestfish-actions.pod:4269
26605 msgid "swapoff-device"
26609 #: ../fish/guestfish-actions.pod:4271
26612 " swapoff-device device\n"
26617 #: ../fish/guestfish-actions.pod:4273
26619 "This command disables the libguestfs appliance swap device or partition "
26620 "named C<device>. See L</swapon-device>."
26624 #: ../fish/guestfish-actions.pod:4277
26625 msgid "swapoff-file"
26629 #: ../fish/guestfish-actions.pod:4279
26632 " swapoff-file file\n"
26637 #: ../fish/guestfish-actions.pod:4283
26638 msgid "swapoff-label"
26642 #: ../fish/guestfish-actions.pod:4285
26645 " swapoff-label label\n"
26650 #: ../fish/guestfish-actions.pod:4290
26651 msgid "swapoff-uuid"
26655 #: ../fish/guestfish-actions.pod:4292
26658 " swapoff-uuid uuid\n"
26663 #: ../fish/guestfish-actions.pod:4297
26664 msgid "swapon-device"
26668 #: ../fish/guestfish-actions.pod:4299
26671 " swapon-device device\n"
26676 #: ../fish/guestfish-actions.pod:4301
26678 "This command enables the libguestfs appliance to use the swap device or "
26679 "partition named C<device>. The increased memory is made available for all "
26680 "commands, for example those run using L</command> or L</sh>."
26684 #: ../fish/guestfish-actions.pod:4313
26685 msgid "swapon-file"
26689 #: ../fish/guestfish-actions.pod:4315
26692 " swapon-file file\n"
26697 #: ../fish/guestfish-actions.pod:4317
26699 "This command enables swap to a file. See L</swapon-device> for other notes."
26703 #: ../fish/guestfish-actions.pod:4320
26704 msgid "swapon-label"
26708 #: ../fish/guestfish-actions.pod:4322
26711 " swapon-label label\n"
26716 #: ../fish/guestfish-actions.pod:4324
26718 "This command enables swap to a labeled swap partition. See L</swapon-"
26719 "device> for other notes."
26723 #: ../fish/guestfish-actions.pod:4327
26724 msgid "swapon-uuid"
26728 #: ../fish/guestfish-actions.pod:4329
26731 " swapon-uuid uuid\n"
26736 #: ../fish/guestfish-actions.pod:4331
26738 "This command enables swap to a swap partition with the given UUID. See L</"
26739 "swapon-device> for other notes."
26743 #: ../fish/guestfish-actions.pod:4334
26748 #: ../fish/guestfish-actions.pod:4336
26756 #: ../fish/guestfish-actions.pod:4344
26761 #: ../fish/guestfish-actions.pod:4346
26769 #: ../fish/guestfish-actions.pod:4354
26774 #: ../fish/guestfish-actions.pod:4356
26777 " tail-n nrlines path\n"
26782 #: ../fish/guestfish-actions.pod:4369
26787 #: ../fish/guestfish-actions.pod:4371
26790 " tar-in (tarfile|-) directory\n"
26795 #: ../fish/guestfish-actions.pod:4376
26796 msgid "To upload a compressed tarball, use L</tgz-in> or L</txz-in>."
26800 #: ../fish/guestfish-actions.pod:4381
26805 #: ../fish/guestfish-actions.pod:4383
26808 " tar-out directory (tarfile|-)\n"
26813 #: ../fish/guestfish-actions.pod:4388
26814 msgid "To download a compressed tarball, use L</tgz-out> or L</txz-out>."
26818 #: ../fish/guestfish-actions.pod:4393
26823 #: ../fish/guestfish-actions.pod:4395
26826 " tgz-in (tarball|-) directory\n"
26831 #: ../fish/guestfish-actions.pod:4400
26832 msgid "To upload an uncompressed tarball, use L</tar-in>."
26836 #: ../fish/guestfish-actions.pod:4404
26841 #: ../fish/guestfish-actions.pod:4406
26844 " tgz-out directory (tarball|-)\n"
26849 #: ../fish/guestfish-actions.pod:4411
26850 msgid "To download an uncompressed tarball, use L</tar-out>."
26854 #: ../fish/guestfish-actions.pod:4415
26859 #: ../fish/guestfish-actions.pod:4417
26867 #: ../fish/guestfish-actions.pod:4426
26872 #: ../fish/guestfish-actions.pod:4428
26880 #: ../fish/guestfish-actions.pod:4433
26881 msgid "truncate-size"
26885 #: ../fish/guestfish-actions.pod:4435
26888 " truncate-size path size\n"
26893 #: ../fish/guestfish-actions.pod:4440
26895 "If the current file size is less than C<size> then the file is extended to "
26896 "the required size with zero bytes. This creates a sparse file (ie. disk "
26897 "blocks are not allocated for the file until you write to it). To create a "
26898 "non-sparse file of zeroes, use L</fallocate64> instead."
26902 #: ../fish/guestfish-actions.pod:4446
26907 #: ../fish/guestfish-actions.pod:4448
26910 " tune2fs-l device\n"
26915 #: ../fish/guestfish-actions.pod:4458
26920 #: ../fish/guestfish-actions.pod:4460
26923 " txz-in (tarball|-) directory\n"
26928 #: ../fish/guestfish-actions.pod:4467
26933 #: ../fish/guestfish-actions.pod:4469
26936 " txz-out directory (tarball|-)\n"
26941 #: ../fish/guestfish-actions.pod:4476
26946 #: ../fish/guestfish-actions.pod:4478
26954 #: ../fish/guestfish-actions.pod:4492
26955 msgid "See also L</get-umask>, L<umask(2)>, L</mknod>, L</mkdir>."
26959 #: ../fish/guestfish-actions.pod:4497
26964 #: ../fish/guestfish-actions.pod:4499
26969 #: ../fish/guestfish-actions.pod:4501
26972 " umount pathordevice\n"
26977 #: ../fish/guestfish-actions.pod:4507
26982 #: ../fish/guestfish-actions.pod:4509
26983 msgid "unmount-all"
26987 #: ../fish/guestfish-actions.pod:4511
26995 #: ../fish/guestfish-actions.pod:4517
27000 #: ../fish/guestfish-actions.pod:4519
27003 " upload (filename|-) remotefilename\n"
27008 #: ../fish/guestfish-actions.pod:4526
27009 msgid "See also L</download>."
27013 #: ../fish/guestfish-actions.pod:4530
27014 msgid "upload-offset"
27018 #: ../fish/guestfish-actions.pod:4532
27021 " upload-offset (filename|-) remotefilename offset\n"
27026 #: ../fish/guestfish-actions.pod:4544
27028 "Note that there is no limit on the amount of data that can be uploaded with "
27029 "this call, unlike with L</pwrite>, and this call always writes the full "
27030 "amount unless an error occurs."
27034 #: ../fish/guestfish-actions.pod:4549
27035 msgid "See also L</upload>, L</pwrite>."
27039 #: ../fish/guestfish-actions.pod:4553
27044 #: ../fish/guestfish-actions.pod:4555
27047 " utimens path atsecs atnsecs mtsecs mtnsecs\n"
27052 #: ../fish/guestfish-actions.pod:4574
27057 #: ../fish/guestfish-actions.pod:4576
27065 #: ../fish/guestfish-actions.pod:4603
27067 "I<Note:> Don't use this call to test for availability of features. In "
27068 "enterprise distributions we backport features from later versions into "
27069 "earlier versions, making this an unreliable way to test for features. Use "
27070 "L</available> instead."
27074 #: ../fish/guestfish-actions.pod:4609
27079 #: ../fish/guestfish-actions.pod:4611
27082 " vfs-label device\n"
27087 #: ../fish/guestfish-actions.pod:4618
27088 msgid "To find a filesystem from the label, use L</findfs-label>."
27092 #: ../fish/guestfish-actions.pod:4620
27097 #: ../fish/guestfish-actions.pod:4622
27100 " vfs-type device\n"
27105 #: ../fish/guestfish-actions.pod:4632
27110 #: ../fish/guestfish-actions.pod:4634
27113 " vfs-uuid device\n"
27118 #: ../fish/guestfish-actions.pod:4641
27119 msgid "To find a filesystem from the UUID, use L</findfs-uuid>."
27123 #: ../fish/guestfish-actions.pod:4643
27124 msgid "vg-activate"
27128 #: ../fish/guestfish-actions.pod:4645
27131 " vg-activate true|false 'volgroups ...'\n"
27136 #: ../fish/guestfish-actions.pod:4658
27137 msgid "vg-activate-all"
27141 #: ../fish/guestfish-actions.pod:4660
27144 " vg-activate-all true|false\n"
27149 #: ../fish/guestfish-actions.pod:4670
27154 #: ../fish/guestfish-actions.pod:4672
27157 " vgcreate volgroup 'physvols ...'\n"
27162 #: ../fish/guestfish-actions.pod:4677
27167 #: ../fish/guestfish-actions.pod:4679
27170 " vglvuuids vgname\n"
27175 #: ../fish/guestfish-actions.pod:4684
27177 "You can use this along with L</lvs> and L</lvuuid> calls to associate "
27178 "logical volumes and volume groups."
27182 #: ../fish/guestfish-actions.pod:4687
27183 msgid "See also L</vgpvuuids>."
27187 #: ../fish/guestfish-actions.pod:4689
27192 #: ../fish/guestfish-actions.pod:4691
27195 " vgpvuuids vgname\n"
27200 #: ../fish/guestfish-actions.pod:4696
27202 "You can use this along with L</pvs> and L</pvuuid> calls to associate "
27203 "physical volumes and volume groups."
27207 #: ../fish/guestfish-actions.pod:4699
27208 msgid "See also L</vglvuuids>."
27212 #: ../fish/guestfish-actions.pod:4701
27217 #: ../fish/guestfish-actions.pod:4703
27220 " vgremove vgname\n"
27225 #: ../fish/guestfish-actions.pod:4710
27230 #: ../fish/guestfish-actions.pod:4712
27233 " vgrename volgroup newvolgroup\n"
27238 #: ../fish/guestfish-actions.pod:4716
27243 #: ../fish/guestfish-actions.pod:4718
27251 #: ../fish/guestfish-actions.pod:4726
27252 msgid "See also L</vgs-full>."
27256 #: ../fish/guestfish-actions.pod:4728
27261 #: ../fish/guestfish-actions.pod:4730
27269 #: ../fish/guestfish-actions.pod:4735
27274 #: ../fish/guestfish-actions.pod:4737
27282 #: ../fish/guestfish-actions.pod:4742
27287 #: ../fish/guestfish-actions.pod:4744
27295 #: ../fish/guestfish-actions.pod:4748
27300 #: ../fish/guestfish-actions.pod:4750
27308 #: ../fish/guestfish-actions.pod:4755
27313 #: ../fish/guestfish-actions.pod:4757
27321 #: ../fish/guestfish-actions.pod:4762
27326 #: ../fish/guestfish-actions.pod:4764
27334 #: ../fish/guestfish-actions.pod:4769
27339 #: ../fish/guestfish-actions.pod:4771
27342 " write path content\n"
27347 #: ../fish/guestfish-actions.pod:4779
27352 #: ../fish/guestfish-actions.pod:4781
27355 " write-file path content size\n"
27360 #: ../fish/guestfish-actions.pod:4804
27365 #: ../fish/guestfish-actions.pod:4806
27368 " zegrep regex path\n"
27373 #: ../fish/guestfish-actions.pod:4814
27378 #: ../fish/guestfish-actions.pod:4816
27381 " zegrepi regex path\n"
27386 #: ../fish/guestfish-actions.pod:4824
27391 #: ../fish/guestfish-actions.pod:4826
27399 #: ../fish/guestfish-actions.pod:4834
27400 msgid "See also: L</zero-device>, L</scrub-device>."
27404 #: ../fish/guestfish-actions.pod:4836
27405 msgid "zero-device"
27409 #: ../fish/guestfish-actions.pod:4838
27412 " zero-device device\n"
27417 #: ../fish/guestfish-actions.pod:4840
27419 "This command writes zeroes over the entire C<device>. Compare with L</zero> "
27420 "which just zeroes the first few blocks of a device."
27424 #: ../fish/guestfish-actions.pod:4847
27429 #: ../fish/guestfish-actions.pod:4849
27432 " zerofree device\n"
27437 #: ../fish/guestfish-actions.pod:4862
27442 #: ../fish/guestfish-actions.pod:4864
27445 " zfgrep pattern path\n"
27450 #: ../fish/guestfish-actions.pod:4872
27455 #: ../fish/guestfish-actions.pod:4874
27458 " zfgrepi pattern path\n"
27463 #: ../fish/guestfish-actions.pod:4882
27468 #: ../fish/guestfish-actions.pod:4884
27471 " zfile meth path\n"
27476 #: ../fish/guestfish-actions.pod:4891
27478 "Since 1.0.63, use L</file> instead which can now process compressed files."
27482 #: ../fish/guestfish-actions.pod:4901
27487 #: ../fish/guestfish-actions.pod:4903
27490 " zgrep regex path\n"
27495 #: ../fish/guestfish-actions.pod:4911
27500 #: ../fish/guestfish-actions.pod:4913
27503 " zgrepi regex path\n"
27508 #: ../fish/guestfish-commands.pod:1
27513 #: ../fish/guestfish-commands.pod:3
27518 #: ../fish/guestfish-commands.pod:5
27521 " alloc filename size\n"
27526 #: ../fish/guestfish-commands.pod:7
27528 "This creates an empty (zeroed) file of the given size, and then adds so it "
27529 "can be further examined."
27533 #: ../fish/guestfish-commands.pod:10 ../fish/guestfish-commands.pod:168
27534 msgid "For more advanced image creation, see L<qemu-img(1)> utility."
27538 #: ../fish/guestfish-commands.pod:12 ../fish/guestfish-commands.pod:170
27539 msgid "Size can be specified using standard suffixes, eg. C<1M>."
27543 #: ../fish/guestfish-commands.pod:14
27545 "To create a sparse file, use L</sparse> instead. To create a prepared disk "
27546 "image, see L</PREPARED DISK IMAGES>."
27550 #: ../fish/guestfish-commands.pod:17
27555 #: ../fish/guestfish-commands.pod:19
27558 " copy-in local [local ...] /remotedir\n"
27563 #: ../fish/guestfish-commands.pod:21
27565 "C<copy-in> copies local files or directories recursively into the disk "
27566 "image, placing them in the directory called C</remotedir> (which must "
27567 "exist). This guestfish meta-command turns into a sequence of L</tar-in> and "
27568 "other commands as necessary."
27572 #: ../fish/guestfish-commands.pod:26
27574 "Multiple local files and directories can be specified, but the last "
27575 "parameter must always be a remote directory. Wildcards cannot be used."
27579 #: ../fish/guestfish-commands.pod:30
27584 #: ../fish/guestfish-commands.pod:32
27587 " copy-out remote [remote ...] localdir\n"
27592 #: ../fish/guestfish-commands.pod:34
27594 "C<copy-out> copies remote files or directories recursively out of the disk "
27595 "image, placing them on the host disk in a local directory called C<localdir> "
27596 "(which must exist). This guestfish meta-command turns into a sequence of L</"
27597 "download>, L</tar-out> and other commands as necessary."
27601 #: ../fish/guestfish-commands.pod:40
27603 "Multiple remote files and directories can be specified, but the last "
27604 "parameter must always be a local directory. To download to the current "
27605 "directory, use C<.> as in:"
27609 #: ../fish/guestfish-commands.pod:44
27612 " copy-out /home .\n"
27617 #: ../fish/guestfish-commands.pod:46
27619 "Wildcards cannot be used in the ordinary command, but you can use them with "
27620 "the help of L</glob> like this:"
27624 #: ../fish/guestfish-commands.pod:49
27627 " glob copy-out /home/* .\n"
27632 #: ../fish/guestfish-commands.pod:51
27637 #: ../fish/guestfish-commands.pod:53
27640 " echo [params ...]\n"
27645 #: ../fish/guestfish-commands.pod:55
27646 msgid "This echos the parameters to the terminal."
27650 #: ../fish/guestfish-commands.pod:57
27655 #: ../fish/guestfish-commands.pod:59
27660 #: ../fish/guestfish-commands.pod:61
27665 #: ../fish/guestfish-commands.pod:63
27673 #: ../fish/guestfish-commands.pod:65
27675 "This is used to edit a file. It downloads the file, edits it locally using "
27676 "your editor, then uploads the result."
27680 #: ../fish/guestfish-commands.pod:68
27682 "The editor is C<$EDITOR>. However if you use the alternate commands C<vi> "
27683 "or C<emacs> you will get those corresponding editors."
27687 #: ../fish/guestfish-commands.pod:72
27692 #: ../fish/guestfish-commands.pod:74
27695 " glob command args...\n"
27700 #: ../fish/guestfish-commands.pod:76
27702 "Expand wildcards in any paths in the args list, and run C<command> "
27703 "repeatedly on each matching path."
27707 #: ../fish/guestfish-commands.pod:79
27708 msgid "See L</WILDCARDS AND GLOBBING>."
27712 #: ../fish/guestfish-commands.pod:81
27717 #: ../fish/guestfish-commands.pod:83
27720 " hexedit <filename|device>\n"
27721 " hexedit <filename|device> <max>\n"
27722 " hexedit <filename|device> <start> <max>\n"
27727 #: ../fish/guestfish-commands.pod:87
27729 "Use hexedit (a hex editor) to edit all or part of a binary file or block "
27734 #: ../fish/guestfish-commands.pod:90
27736 "This command works by downloading potentially the whole file or device, "
27737 "editing it locally, then uploading it. If the file or device is large, you "
27738 "have to specify which part you wish to edit by using C<max> and/or C<start> "
27739 "C<max> parameters. C<start> and C<max> are specified in bytes, with the "
27740 "usual modifiers allowed such as C<1M> (1 megabyte)."
27744 #: ../fish/guestfish-commands.pod:97
27745 msgid "For example to edit the first few sectors of a disk you might do:"
27749 #: ../fish/guestfish-commands.pod:100
27752 " hexedit /dev/sda 1M\n"
27757 #: ../fish/guestfish-commands.pod:102
27759 "which would allow you to edit anywhere within the first megabyte of the disk."
27763 #: ../fish/guestfish-commands.pod:105
27764 msgid "To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:"
27768 #: ../fish/guestfish-commands.pod:107
27771 " hexedit /dev/sda1 0x400 0x400\n"
27776 #: ../fish/guestfish-commands.pod:109
27777 msgid "(assuming the superblock is in the standard location)."
27781 #: ../fish/guestfish-commands.pod:111
27783 "This command requires the external L<hexedit(1)> program. You can specify "
27784 "another program to use by setting the C<HEXEDITOR> environment variable."
27788 #: ../fish/guestfish-commands.pod:115
27789 msgid "See also L</hexdump>."
27793 #: ../fish/guestfish-commands.pod:117
27798 #: ../fish/guestfish-commands.pod:119
27806 #: ../fish/guestfish-commands.pod:121
27808 "Change the local directory, ie. the current directory of guestfish itself."
27812 #: ../fish/guestfish-commands.pod:124
27813 msgid "Note that C<!cd> won't do what you might expect."
27817 #: ../fish/guestfish-commands.pod:126
27822 #: ../fish/guestfish-commands.pod:128
27827 #: ../fish/guestfish-commands.pod:130
27835 #: ../fish/guestfish-commands.pod:132
27836 msgid "Opens the manual page for guestfish."
27840 #: ../fish/guestfish-commands.pod:134
27845 #: ../fish/guestfish-commands.pod:136
27850 #: ../fish/guestfish-commands.pod:138
27858 #: ../fish/guestfish-commands.pod:140
27866 #: ../fish/guestfish-commands.pod:142
27867 msgid "This is used to view a file."
27871 #: ../fish/guestfish-commands.pod:144
27873 "The default viewer is C<$PAGER>. However if you use the alternate command "
27874 "C<less> you will get the C<less> command specifically."
27878 #: ../fish/guestfish-commands.pod:147
27883 #: ../fish/guestfish-commands.pod:149
27891 #: ../fish/guestfish-commands.pod:151
27893 "Close and reopen the libguestfs handle. It is not necessary to use this "
27894 "normally, because the handle is closed properly when guestfish exits. "
27895 "However this is occasionally useful for testing."
27899 #: ../fish/guestfish-commands.pod:155
27904 #: ../fish/guestfish-commands.pod:157
27907 " sparse filename size\n"
27912 #: ../fish/guestfish-commands.pod:159
27914 "This creates an empty sparse file of the given size, and then adds so it can "
27915 "be further examined."
27919 #: ../fish/guestfish-commands.pod:162
27921 "In all respects it works the same as the L</alloc> command, except that the "
27922 "image file is allocated sparsely, which means that disk blocks are not "
27923 "assigned to the file until they are needed. Sparse disk files only use "
27924 "space when written to, but they are slower and there is a danger you could "
27925 "run out of real disk space during a write operation."
27929 #: ../fish/guestfish-commands.pod:172
27934 #: ../fish/guestfish-commands.pod:174
27942 #: ../fish/guestfish-commands.pod:176
27944 "This command returns a list of the optional groups known to the daemon, and "
27945 "indicates which ones are supported by this build of the libguestfs appliance."
27949 #: ../fish/guestfish-commands.pod:180
27950 msgid "See also L<guestfs(3)/AVAILABILITY>."
27954 #: ../fish/guestfish-commands.pod:182
27959 #: ../fish/guestfish-commands.pod:184
27962 " time command args...\n"
27967 #: ../fish/guestfish-commands.pod:186
27969 "Run the command as usual, but print the elapsed time afterwards. This can "
27970 "be useful for benchmarking operations."
27974 #: ../test-tool/libguestfs-test-tool.pod:5
27975 msgid "libguestfs-test-tool - End user tests for libguestfs"
27979 #: ../test-tool/libguestfs-test-tool.pod:9
27982 " libguestfs-test-tool [--options]\n"
27987 #: ../test-tool/libguestfs-test-tool.pod:13
27989 "libguestfs-test-tool is a test program shipped with libguestfs to end users "
27990 "and developers, to allow them to check basic libguestfs functionality is "
27991 "working. This is needed because libguestfs occasionally breaks for reasons "
27992 "beyond our control: usually because of changes in the underlying qemu or "
27993 "kernel packages, or the host environment."
27997 #: ../test-tool/libguestfs-test-tool.pod:20
27998 msgid "If you suspect a problem in libguestfs, then just run:"
28002 #: ../test-tool/libguestfs-test-tool.pod:22
28005 " libguestfs-test-tool\n"
28010 #: ../test-tool/libguestfs-test-tool.pod:24
28011 msgid "It will print lots of diagnostic messages."
28015 #: ../test-tool/libguestfs-test-tool.pod:26
28016 msgid "If it runs to completion successfully, you will see this near the end:"
28020 #: ../test-tool/libguestfs-test-tool.pod:28
28023 " ===== TEST FINISHED OK =====\n"
28028 #: ../test-tool/libguestfs-test-tool.pod:30
28029 msgid "and the test tool will exit with code 0."
28033 #: ../test-tool/libguestfs-test-tool.pod:32
28035 "If it fails (and/or exits with non-zero error code), please paste the "
28036 "B<complete, unedited> output of the test tool into a bug report. More "
28037 "information about reporting bugs can be found on the L<http://libguestfs.org/"
28042 #: ../test-tool/libguestfs-test-tool.pod:41
28047 #: ../test-tool/libguestfs-test-tool.pod:43
28048 msgid "Display short usage information and exit."
28052 #: ../test-tool/libguestfs-test-tool.pod:45
28053 msgid "I<--helper /path/to/libguestfs-test-tool-helper>"
28057 #: ../test-tool/libguestfs-test-tool.pod:47
28059 "Pass an alternate name for the helper program. libguestfs-test-tool will "
28060 "normally look in the C<$libexec> directory that was configured when the tool "
28065 #: ../test-tool/libguestfs-test-tool.pod:51
28066 msgid "I<--qemu qemu_binary>"
28070 #: ../test-tool/libguestfs-test-tool.pod:53
28072 "If you have downloaded another qemu binary, point this option at the full "
28073 "path of the binary to try it."
28077 #: ../test-tool/libguestfs-test-tool.pod:56
28078 msgid "I<--qemudir qemu_source_dir>"
28082 #: ../test-tool/libguestfs-test-tool.pod:58
28084 "If you have compiled qemu from source, point this option at the source "
28085 "directory to try it."
28089 #: ../test-tool/libguestfs-test-tool.pod:61
28090 msgid "I<--timeout N>"
28094 #: ../test-tool/libguestfs-test-tool.pod:63
28096 "Set the launch timeout to C<N> seconds. The default is 120 seconds which "
28097 "does not usually need to be adjusted unless your machine is very slow."
28101 #: ../test-tool/libguestfs-test-tool.pod:69
28102 msgid "TRYING OUT A DIFFERENT VERSION OF QEMU"
28106 #: ../test-tool/libguestfs-test-tool.pod:71
28108 "If you have compiled another version of qemu from source and would like to "
28109 "try that, then you can use the I<--qemudir> option to point to the qemu "
28110 "source directory."
28114 #: ../test-tool/libguestfs-test-tool.pod:75
28116 "If you have downloaded a qemu binary from somewhere, use the I<--qemu> "
28117 "option to point to the binary."
28121 #: ../test-tool/libguestfs-test-tool.pod:78
28123 "When using an alternate qemu with libguestfs, usually you would need to "
28124 "write a qemu wrapper script (see section I<QEMU WRAPPERS> in L<guestfs(3)"
28125 ">). libguestfs-test-tool writes a temporary qemu wrapper script when you "
28126 "use either of the I<--qemudir> or I<--qemu> options."
28130 #: ../test-tool/libguestfs-test-tool.pod:85
28132 "libguestfs-test-tool returns I<0> if the tests completed without error, or "
28133 "I<1> if there was an error."
28137 #: ../test-tool/libguestfs-test-tool.pod:92
28138 msgid "/usr/libexec/libguestfs-test-tool-helper"
28142 #: ../test-tool/libguestfs-test-tool.pod:94
28144 "This helper program is run inside the appliance and provides additional "
28149 #: ../test-tool/libguestfs-test-tool.pod:97
28150 msgid "/usr/bin/mkisofs"
28154 #: ../test-tool/libguestfs-test-tool.pod:99
28156 "The C<mkisofs> command is required in order to construct a CD-ROM ISO file "
28157 "which is used as part of the tests."
28161 #: ../test-tool/libguestfs-test-tool.pod:106
28163 "For the full list of environment variables which may affect libguestfs, "
28164 "please see the L<guestfs(3)> manual page."
28168 #: ../test-tool/libguestfs-test-tool.pod:111
28169 msgid "L<guestfs(3)>, L<http://libguestfs.org/>, L<http://qemu.org/>."
28173 #: ../test-tool/libguestfs-test-tool.pod:121
28174 msgid "Copyright (C) 2009 Red Hat Inc. L<http://libguestfs.org/>"
28178 #: ../fuse/guestmount.pod:5
28180 "guestmount - Mount a guest filesystem on the host using FUSE and libguestfs"
28184 #: ../fuse/guestmount.pod:9
28187 " guestmount [--options] -a disk.img -m device [--ro] mountpoint\n"
28192 #: ../fuse/guestmount.pod:11
28195 " guestmount [--options] -a disk.img -i [--ro] mountpoint\n"
28200 #: ../fuse/guestmount.pod:13
28203 " guestmount [--options] -d Guest -i [--ro] mountpoint\n"
28208 #: ../fuse/guestmount.pod:17
28210 "You must I<not> use C<guestmount> in read-write mode on live virtual "
28211 "machines. If you do this, you risk disk corruption in the VM."
28215 #: ../fuse/guestmount.pod:22
28217 "The guestmount program can be used to mount virtual machine filesystems and "
28218 "other disk images on the host. It uses libguestfs for access to the guest "
28219 "filesystem, and FUSE (the \"filesystem in userspace\") to make it appear as "
28220 "a mountable device."
28224 #: ../fuse/guestmount.pod:27
28226 "Along with other options, you have to give at least one device (I<-a> "
28227 "option) or libvirt domain (I<-d> option), and at least one mountpoint (I<-m> "
28228 "option) or use the I<-i> inspection option. How this works is better "
28229 "explained in the L<guestfish(1)> manual page, or by looking at the examples "
28234 #: ../fuse/guestmount.pod:33
28236 "FUSE lets you mount filesystems as non-root. The mountpoint must be owned "
28237 "by you, and the filesystem will not be visible to any other users unless you "
28238 "make certain global configuration changes to C</etc/fuse.conf>. To unmount "
28239 "the filesystem, use the C<fusermount -u> command."
28243 #: ../fuse/guestmount.pod:41
28245 "For a typical Windows guest which has its main filesystem on the first "
28250 #: ../fuse/guestmount.pod:44
28253 " guestmount -a windows.img -m /dev/sda1 --ro /mnt\n"
28258 #: ../fuse/guestmount.pod:46
28260 "For a typical Linux guest which has a /boot filesystem on the first "
28261 "partition, and the root filesystem on a logical volume:"
28265 #: ../fuse/guestmount.pod:49
28268 " guestmount -a linux.img -m /dev/VG/LV -m /dev/sda1:/boot --ro /mnt\n"
28273 #: ../fuse/guestmount.pod:51
28274 msgid "To get libguestfs to detect guest mountpoints for you:"
28278 #: ../fuse/guestmount.pod:53
28281 " guestmount -a guest.img -i --ro /mnt\n"
28286 #: ../fuse/guestmount.pod:55
28287 msgid "For a libvirt guest called \"Guest\" you could do:"
28291 #: ../fuse/guestmount.pod:57
28294 " guestmount -d Guest -i --ro /mnt\n"
28299 #: ../fuse/guestmount.pod:59
28301 "If you don't know what filesystems are contained in a guest or disk image, "
28302 "use L<virt-filesystems(1)> first:"
28306 #: ../fuse/guestmount.pod:62
28309 " virt-filesystems MyGuest\n"
28314 #: ../fuse/guestmount.pod:64
28316 "If you want to trace the libguestfs calls but without excessive debugging "
28317 "information, we recommend:"
28321 #: ../fuse/guestmount.pod:67
28324 " guestmount [...] --trace /mnt\n"
28329 #: ../fuse/guestmount.pod:69
28330 msgid "If you want to debug the program, we recommend:"
28334 #: ../fuse/guestmount.pod:71
28337 " guestmount [...] --trace --verbose /mnt\n"
28342 #: ../fuse/guestmount.pod:77
28343 msgid "B<-a image> | B<--add image>"
28347 #: ../fuse/guestmount.pod:79
28348 msgid "Add a block device or virtual machine image."
28352 #: ../fuse/guestmount.pod:84
28353 msgid "B<-c URI> | B<--connect URI>"
28357 #: ../fuse/guestmount.pod:90
28358 msgid "B<-d libvirt-domain> | B<--domain libvirt-domain>"
28362 #: ../fuse/guestmount.pod:96
28363 msgid "B<--dir-cache-timeout N>"
28367 #: ../fuse/guestmount.pod:98
28369 "Set the readdir cache timeout to I<N> seconds, the default being 60 "
28370 "seconds. The readdir cache [actually, there are several semi-independent "
28371 "caches] is populated after a readdir(2) call with the stat and extended "
28372 "attributes of the files in the directory, in anticipation that they will be "
28373 "requested soon after."
28377 #: ../fuse/guestmount.pod:104
28379 "There is also a different attribute cache implemented by FUSE (see the FUSE "
28380 "option I<-o attr_timeout>), but the FUSE cache does not anticipate future "
28381 "requests, only cache existing ones."
28385 #: ../fuse/guestmount.pod:115
28386 msgid "B<--format=raw|qcow2|..> | B<--format>"
28390 #: ../fuse/guestmount.pod:122
28392 "If you have untrusted raw-format guest disk images, you should use this "
28393 "option to specify the disk format. This avoids a possible security problem "
28394 "with malicious guests (CVE-2010-3851). See also L<guestfs(3)/"
28395 "guestfs_add_drive_opts>."
28399 #: ../fuse/guestmount.pod:127
28400 msgid "B<--fuse-help>"
28404 #: ../fuse/guestmount.pod:129
28405 msgid "Display help on special FUSE options (see I<-o> below)."
28409 #: ../fuse/guestmount.pod:133
28410 msgid "Display brief help and exit."
28414 #: ../fuse/guestmount.pod:135
28415 msgid "B<-i> | B<--inspector>"
28419 #: ../fuse/guestmount.pod:155
28421 "Mount the named partition or logical volume on the given mountpoint B<in the "
28422 "guest> (this has nothing to do with mountpoints in the host)."
28426 #: ../fuse/guestmount.pod:158
28428 "If the mountpoint is omitted, it defaults to C</>. You have to mount "
28429 "something on C</>."
28433 #: ../fuse/guestmount.pod:171
28434 msgid "B<-n> | B<--no-sync>"
28438 #: ../fuse/guestmount.pod:173
28440 "By default, we attempt to sync the guest disk when the FUSE mountpoint is "
28441 "unmounted. If you specify this option, then we don't attempt to sync the "
28442 "disk. See the discussion of autosync in the L<guestfs(3)> manpage."
28446 #: ../fuse/guestmount.pod:178
28447 msgid "B<-o option> | B<--option option>"
28451 #: ../fuse/guestmount.pod:180
28452 msgid "Pass extra options to FUSE."
28456 #: ../fuse/guestmount.pod:182
28458 "To get a list of all the extra options supported by FUSE, use the command "
28459 "below. Note that only the FUSE I<-o> options can be passed, and only some "
28460 "of them are a good idea."
28464 #: ../fuse/guestmount.pod:186
28467 " guestmount --fuse-help\n"
28472 #: ../fuse/guestmount.pod:188
28473 msgid "Some potentially useful FUSE options:"
28477 #: ../fuse/guestmount.pod:192
28478 msgid "B<-o allow_other>"
28482 #: ../fuse/guestmount.pod:194
28483 msgid "Allow other users to see the filesystem."
28487 #: ../fuse/guestmount.pod:196
28488 msgid "B<-o attr_timeout=N>"
28492 #: ../fuse/guestmount.pod:198
28493 msgid "Enable attribute caching by FUSE, and set the timeout to I<N> seconds."
28497 #: ../fuse/guestmount.pod:200
28498 msgid "B<-o kernel_cache>"
28502 #: ../fuse/guestmount.pod:202
28504 "Allow the kernel to cache files (reduces the number of reads that have to go "
28505 "through the L<guestfs(3)> API). This is generally a good idea if you can "
28506 "afford the extra memory usage."
28510 #: ../fuse/guestmount.pod:206
28511 msgid "B<-o uid=N> B<-o gid=N>"
28515 #: ../fuse/guestmount.pod:208
28517 "Use these options to map all UIDs and GIDs inside the guest filesystem to "
28518 "the chosen values."
28522 #: ../fuse/guestmount.pod:213
28523 msgid "B<-r> | B<--ro>"
28527 #: ../fuse/guestmount.pod:215
28529 "Add devices and mount everything read-only. Also disallow writes and make "
28530 "the disk appear read-only to FUSE."
28534 #: ../fuse/guestmount.pod:218
28536 "This is highly recommended if you are not going to edit the guest disk. If "
28537 "the guest is running and this option is I<not> supplied, then there is a "
28538 "strong risk of disk corruption in the guest. We try to prevent this from "
28539 "happening, but it is not always possible."
28543 #: ../fuse/guestmount.pod:223
28544 msgid "See also L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
28548 #: ../fuse/guestmount.pod:227
28549 msgid "Enable SELinux support for the guest."
28553 #: ../fuse/guestmount.pod:229
28554 msgid "B<-v> | B<--verbose>"
28558 #: ../fuse/guestmount.pod:231
28559 msgid "Enable verbose messages from underlying libguestfs."
28563 #: ../fuse/guestmount.pod:233
28564 msgid "B<-V> | B<--version>"
28568 #: ../fuse/guestmount.pod:235
28569 msgid "Display the program version and exit."
28573 #: ../fuse/guestmount.pod:237
28574 msgid "B<-w> | B<--rw>"
28578 #: ../fuse/guestmount.pod:242 ../fuse/guestmount.pod:263
28579 msgid "See L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
28583 #: ../fuse/guestmount.pod:244
28584 msgid "B<-x> | B<--trace>"
28588 #: ../fuse/guestmount.pod:246
28589 msgid "Trace libguestfs calls and entry into each FUSE function."
28593 #: ../fuse/guestmount.pod:248
28594 msgid "This also stops the daemon from forking into the background."
28598 #: ../fuse/guestmount.pod:269
28600 "L<guestfish(1)>, L<virt-inspector(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
28601 "L<virt-tar(1)>, L<guestfs(3)>, L<http://libguestfs.org/>, L<http://fuse.sf."
28606 #: ../fuse/guestmount.pod:284
28607 msgid "Copyright (C) 2009-2010 Red Hat Inc. L<http://libguestfs.org/>"
28611 #: ../tools/virt-edit.pl:34
28612 msgid "virt-edit - Edit a file in a virtual machine"
28616 #: ../tools/virt-edit.pl:38
28619 " virt-edit [--options] domname file\n"
28624 #: ../tools/virt-edit.pl:40
28627 " virt-edit [--options] disk.img [disk.img ...] file\n"
28632 #: ../tools/virt-edit.pl:42
28635 " virt-edit [domname|disk.img] file -e 'expr'\n"
28640 #: ../tools/virt-edit.pl:46
28642 "You must I<not> use C<virt-edit> on live virtual machines. If you do this, "
28643 "you risk disk corruption in the VM. C<virt-edit> tries to stop you from "
28644 "doing this, but doesn't catch all cases."
28648 #: ../tools/virt-edit.pl:52
28650 "C<virt-edit> is a command line tool to edit C<file> where C<file> exists in "
28651 "the named virtual machine (or disk image)."
28655 #: ../tools/virt-edit.pl:55
28657 "If you want to just view a file, use L<virt-cat(1)>. For more complex cases "
28658 "you should look at the L<guestfish(1)> tool."
28662 #: ../tools/virt-edit.pl:60
28663 msgid "Edit the named files interactively:"
28667 #: ../tools/virt-edit.pl:62
28670 " virt-edit mydomain /boot/grub/grub.conf\n"
28675 #: ../tools/virt-edit.pl:64
28678 " virt-edit mydomain /etc/passwd\n"
28683 #: ../tools/virt-edit.pl:66
28685 "You can also edit files non-interactively (see L</NON-INTERACTIVE EDITING> "
28686 "below). To change the init default level to 5:"
28690 #: ../tools/virt-edit.pl:70
28693 " virt-edit mydomain /etc/inittab -e 's/^id:.*/id:5:initdefault:/'\n"
28698 #: ../tools/virt-edit.pl:82 ../tools/virt-win-reg.pl:106
28699 #: ../tools/virt-list-filesystems.pl:63 ../tools/virt-tar.pl:113
28700 #: ../tools/virt-make-fs.pl:163 ../tools/virt-list-partitions.pl:64
28701 msgid "Display brief help."
28705 #: ../tools/virt-edit.pl:90 ../tools/virt-win-reg.pl:114
28706 #: ../tools/virt-resize.pl:272 ../tools/virt-list-filesystems.pl:71
28707 #: ../tools/virt-tar.pl:121 ../tools/virt-make-fs.pl:171
28708 #: ../tools/virt-list-partitions.pl:72
28709 msgid "Display version number and exit."
28713 #: ../tools/virt-edit.pl:96
28714 msgid "B<--backup extension> | B<-b extension>"
28718 #: ../tools/virt-edit.pl:98
28720 "Create a backup of the original file I<in the guest disk image>. The backup "
28721 "has the original filename with C<extension> added."
28725 #: ../tools/virt-edit.pl:101
28727 "Usually the first character of C<extension> would be a dot C<.> so you would "
28732 #: ../tools/virt-edit.pl:104
28735 " virt-edit -b .orig [etc]\n"
28740 #: ../tools/virt-edit.pl:106
28741 msgid "By default, no backup file is made."
28745 #: ../tools/virt-edit.pl:112 ../tools/virt-win-reg.pl:128
28746 #: ../tools/virt-list-filesystems.pl:77 ../tools/virt-tar.pl:127
28747 #: ../tools/virt-list-partitions.pl:78
28748 msgid "B<--connect URI> | B<-c URI>"
28752 #: ../tools/virt-edit.pl:114 ../tools/virt-win-reg.pl:130
28753 #: ../tools/virt-list-filesystems.pl:79 ../tools/virt-tar.pl:129
28754 #: ../tools/virt-list-partitions.pl:80
28756 "If using libvirt, connect to the given I<URI>. If omitted, then we connect "
28757 "to the default libvirt hypervisor."
28761 #: ../tools/virt-edit.pl:117 ../tools/virt-win-reg.pl:133
28762 #: ../tools/virt-list-filesystems.pl:82 ../tools/virt-tar.pl:132
28763 #: ../tools/virt-list-partitions.pl:83
28765 "If you specify guest block devices directly, then libvirt is not used at all."
28769 #: ../tools/virt-edit.pl:124 ../tools/virt-win-reg.pl:140
28770 #: ../tools/virt-resize.pl:520 ../tools/virt-list-filesystems.pl:89
28771 #: ../tools/virt-tar.pl:139 ../tools/virt-list-partitions.pl:90
28772 msgid "B<--format> raw"
28776 #: ../tools/virt-edit.pl:126 ../tools/virt-win-reg.pl:142
28777 #: ../tools/virt-list-filesystems.pl:91 ../tools/virt-tar.pl:141
28778 #: ../tools/virt-list-partitions.pl:92
28780 "Specify the format of disk images given on the command line. If this is "
28781 "omitted then the format is autodetected from the content of the disk image."
28785 #: ../tools/virt-edit.pl:130 ../tools/virt-win-reg.pl:146
28786 #: ../tools/virt-list-filesystems.pl:95 ../tools/virt-tar.pl:145
28787 #: ../tools/virt-list-partitions.pl:96
28789 "If disk images are requested from libvirt, then this program asks libvirt "
28790 "for this information. In this case, the value of the format parameter is "
28795 #: ../tools/virt-edit.pl:134 ../tools/virt-win-reg.pl:150
28796 #: ../tools/virt-resize.pl:525 ../tools/virt-resize.pl:540
28797 #: ../tools/virt-list-filesystems.pl:99 ../tools/virt-tar.pl:149
28798 #: ../tools/virt-list-partitions.pl:100
28800 "If working with untrusted raw-format guest disk images, you should ensure "
28801 "the format is always specified."
28805 #: ../tools/virt-edit.pl:141
28806 msgid "B<--expr EXPR> | B<-e EXPR>"
28810 #: ../tools/virt-edit.pl:143
28812 "Instead of launching the external editor, non-interactively apply the Perl "
28813 "expression C<EXPR> to each line in the file. See L</NON-INTERACTIVE "
28818 #: ../tools/virt-edit.pl:147
28820 "Be careful to properly quote the expression to prevent it from being altered "
28825 #: ../tools/virt-edit.pl:268
28826 msgid "NON-INTERACTIVE EDITING"
28830 #: ../tools/virt-edit.pl:270
28832 "C<virt-edit> normally calls out to C<$EDITOR> (or vi) so the system "
28833 "administrator can interactively edit the file."
28837 #: ../tools/virt-edit.pl:273
28839 "There are two ways also to use C<virt-edit> from scripts in order to make "
28840 "automated edits to files. (Note that although you I<can> use C<virt-edit> "
28841 "like this, it's less error-prone to write scripts directly using the "
28842 "libguestfs API and Augeas for configuration file editing.)"
28846 #: ../tools/virt-edit.pl:279
28848 "The first method is to temporarily set C<$EDITOR> to any script or program "
28849 "you want to run. The script is invoked as C<$EDITOR tmpfile> and it should "
28850 "update C<tmpfile> in place however it likes."
28854 #: ../tools/virt-edit.pl:283
28856 "The second method is to use the C<-e> parameter of C<virt-edit> to run a "
28857 "short Perl snippet in the style of L<sed(1)>. For example to replace all "
28858 "instances of C<foo> with C<bar> in a file:"
28862 #: ../tools/virt-edit.pl:287
28865 " virt-edit domname filename -e 's/foo/bar/'\n"
28870 #: ../tools/virt-edit.pl:289
28872 "The full power of Perl regular expressions can be used (see L<perlre(1)>). "
28873 "For example to delete root's password you could do:"
28877 #: ../tools/virt-edit.pl:292
28880 " virt-edit domname /etc/passwd -e 's/^root:.*?:/root::/'\n"
28885 #: ../tools/virt-edit.pl:294
28887 "What really happens is that the snippet is evaluated as a Perl expression "
28888 "for each line of the file. The line, including the final C<\\n>, is passed "
28889 "in C<$_> and the expression should update C<$_> or leave it unchanged."
28893 #: ../tools/virt-edit.pl:299
28895 "To delete a line, set C<$_> to the empty string. For example, to delete the "
28896 "C<apache> user account from the password file you can do:"
28900 #: ../tools/virt-edit.pl:302
28903 " virt-edit mydomain /etc/passwd -e '$_ = \"\" if /^apache:/'\n"
28908 #: ../tools/virt-edit.pl:304
28910 "To insert a line, prepend or append it to C<$_>. However appending lines to "
28911 "the end of the file is rather difficult this way since there is no concept "
28912 "of \"last line of the file\" - your expression just doesn't get called "
28913 "again. You might want to use the first method (setting C<$EDITOR>) if you "
28918 #: ../tools/virt-edit.pl:310
28920 "The variable C<$lineno> contains the current line number. As is "
28921 "traditional, the first line in the file is number C<1>."
28925 #: ../tools/virt-edit.pl:313
28927 "The return value from the expression is ignored, but the expression may call "
28928 "C<die> in order to abort the whole program, leaving the original file "
28933 #: ../tools/virt-edit.pl:317
28935 "Remember when matching the end of a line that C<$_> may contain the final C<"
28936 "\\n>, or (for DOS files) C<\\r\\n>, or if the file does not end with a "
28937 "newline then neither of these. Thus to match or substitute some text at the "
28938 "end of a line, use this regular expression:"
28942 #: ../tools/virt-edit.pl:322
28945 " /some text(\\r?\\n)?$/\n"
28950 #: ../tools/virt-edit.pl:324
28952 "Alternately, use the perl C<chomp> function, being careful not to chomp C<"
28953 "$_> itself (since that would remove all newlines from the file):"
28957 #: ../tools/virt-edit.pl:328
28960 " my $m = $_; chomp $m; $m =~ /some text$/\n"
28965 #: ../tools/virt-edit.pl:334
28970 #: ../tools/virt-edit.pl:336
28972 "If set, this string is used as the editor. It may contain arguments, eg. C<"
28977 #: ../tools/virt-edit.pl:339
28978 msgid "If not set, C<vi> is used."
28982 #: ../tools/virt-edit.pl:343 ../tools/virt-win-reg.pl:559
28983 #: ../tools/virt-resize.pl:1482 ../tools/virt-list-filesystems.pl:182
28984 #: ../tools/virt-tar.pl:279 ../tools/virt-make-fs.pl:532
28985 #: ../tools/virt-list-partitions.pl:250
28986 msgid "SHELL QUOTING"
28990 #: ../tools/virt-edit.pl:345 ../tools/virt-win-reg.pl:567
28991 #: ../tools/virt-resize.pl:1484 ../tools/virt-list-filesystems.pl:184
28992 #: ../tools/virt-tar.pl:281 ../tools/virt-make-fs.pl:534
28993 #: ../tools/virt-list-partitions.pl:252
28995 "Libvirt guest names can contain arbitrary characters, some of which have "
28996 "meaning to the shell such as C<#> and space. You may need to quote or "
28997 "escape these characters on the command line. See the shell manual page L<sh"
28998 "(1)> for details."
29002 #: ../tools/virt-edit.pl:352
29004 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, L<virt-"
29005 "tar-in(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, "
29006 "L<http://libguestfs.org/>, L<perl(1)>, L<perlre(1)>."
29010 #: ../tools/virt-edit.pl:364 ../tools/virt-win-reg.pl:598
29011 #: ../tools/virt-resize.pl:1510 ../tools/virt-list-filesystems.pl:202
29012 #: ../tools/virt-tar.pl:301 ../tools/virt-make-fs.pl:564
29013 #: ../tools/virt-list-partitions.pl:269
29018 #: ../tools/virt-edit.pl:366 ../tools/virt-win-reg.pl:600
29019 #: ../tools/virt-resize.pl:1512 ../tools/virt-list-filesystems.pl:204
29020 #: ../tools/virt-tar.pl:303 ../tools/virt-make-fs.pl:566
29021 #: ../tools/virt-list-partitions.pl:271
29022 msgid "Richard W.M. Jones L<http://people.redhat.com/~rjones/>"
29026 #: ../tools/virt-edit.pl:370 ../tools/virt-list-partitions.pl:275
29027 msgid "Copyright (C) 2009-2010 Red Hat Inc."
29031 #: ../tools/virt-win-reg.pl:37
29033 "virt-win-reg - Export and merge Windows Registry entries from a Windows guest"
29037 #: ../tools/virt-win-reg.pl:41
29040 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey'\n"
29045 #: ../tools/virt-win-reg.pl:43
29048 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' name\n"
29053 #: ../tools/virt-win-reg.pl:45
29056 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' @\n"
29061 #: ../tools/virt-win-reg.pl:47
29064 " virt-win-reg --merge domname [input.reg ...]\n"
29069 #: ../tools/virt-win-reg.pl:49
29072 " virt-win-reg [--options] disk.img ... # instead of domname\n"
29077 #: ../tools/virt-win-reg.pl:53
29079 "You must I<not> use C<virt-win-reg> with the C<--merge> option on live "
29080 "virtual machines. If you do this, you I<will> get irreversible disk "
29081 "corruption in the VM. C<virt-win-reg> tries to stop you from doing this, "
29082 "but doesn't catch all cases."
29086 #: ../tools/virt-win-reg.pl:58
29088 "Modifying the Windows Registry is an inherently risky operation. The format "
29089 "is deliberately obscure and undocumented, and Registry changes can leave the "
29090 "system unbootable. Therefore when using the C<--merge> option, make sure "
29091 "you have a reliable backup first."
29095 #: ../tools/virt-win-reg.pl:65
29097 "This program can export and merge Windows Registry entries from a Windows "
29102 #: ../tools/virt-win-reg.pl:68
29104 "The first parameter is the libvirt guest name or the raw disk image of a "
29109 #: ../tools/virt-win-reg.pl:71
29111 "If C<--merge> is I<not> specified, then the chosen registry key is displayed/"
29112 "exported (recursively). For example:"
29116 #: ../tools/virt-win-reg.pl:74
29119 " $ virt-win-reg Windows7 'HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft'\n"
29124 #: ../tools/virt-win-reg.pl:76
29126 "You can also display single values from within registry keys, for example:"
29130 #: ../tools/virt-win-reg.pl:79
29133 " $ cvkey='HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion'\n"
29134 " $ virt-win-reg Windows7 $cvkey ProductName\n"
29135 " Windows 7 Enterprise\n"
29140 #: ../tools/virt-win-reg.pl:83
29142 "With C<--merge>, you can merge a textual regedit file into the Windows "
29147 #: ../tools/virt-win-reg.pl:86
29150 " $ virt-win-reg --merge Windows7 changes.reg\n"
29155 #: ../tools/virt-win-reg.pl:88 ../tools/virt-tar.pl:45
29160 #: ../tools/virt-win-reg.pl:90
29162 "This program is only meant for simple access to the registry. If you want "
29163 "to do complicated things with the registry, we suggest you download the "
29164 "Registry hive files from the guest using L<libguestfs(3)> or L<guestfish(1)> "
29165 "and access them locally, eg. using L<hivex(3)>, L<hivexsh(1)> or "
29166 "L<hivexregedit(1)>."
29170 #: ../tools/virt-win-reg.pl:120 ../tools/virt-make-fs.pl:177
29175 #: ../tools/virt-win-reg.pl:122 ../tools/virt-resize.pl:498
29176 msgid "Enable debugging messages."
29180 #: ../tools/virt-win-reg.pl:157
29185 #: ../tools/virt-win-reg.pl:159
29187 "In merge mode, this merges a textual regedit file into the Windows Registry "
29188 "of the virtual machine. If this flag is I<not> given then virt-win-reg "
29189 "displays or exports Registry entries instead."
29193 #: ../tools/virt-win-reg.pl:163
29195 "Note that C<--merge> is I<unsafe> to use on live virtual machines, and will "
29196 "result in disk corruption. However exporting (without this flag) is always "
29201 #: ../tools/virt-win-reg.pl:171
29202 msgid "B<--encoding> UTF-16LE|ASCII"
29206 #: ../tools/virt-win-reg.pl:173
29208 "When merging (only), you may need to specify the encoding for strings to be "
29209 "used in the hive file. This is explained in detail in L<Win::Hivex::Regedit"
29210 "(3)/ENCODING STRINGS>."
29214 #: ../tools/virt-win-reg.pl:177
29216 "The default is to use UTF-16LE, which should work with recent versions of "
29221 #: ../tools/virt-win-reg.pl:402
29222 msgid "SUPPORTED SYSTEMS"
29226 #: ../tools/virt-win-reg.pl:404
29228 "The program currently supports Windows NT-derived guests starting with "
29229 "Windows XP through to at least Windows 7."
29233 #: ../tools/virt-win-reg.pl:407
29235 "Registry support is done for C<HKEY_LOCAL_MACHINE\\SAM>, C<HKEY_LOCAL_MACHINE"
29236 "\\SECURITY>, C<HKEY_LOCAL_MACHINE\\SOFTWARE>, C<HKEY_LOCAL_MACHINE\\SYSTEM> "
29237 "and C<HKEY_USERS\\.DEFAULT>."
29241 #: ../tools/virt-win-reg.pl:411
29243 "You can use C<HKLM> as a shorthand for C<HKEY_LOCAL_MACHINE>, and C<HKU> for "
29248 #: ../tools/virt-win-reg.pl:414
29250 "C<HKEY_USERS\\$SID> and C<HKEY_CURRENT_USER> are B<not> supported at this "
29255 #: ../tools/virt-win-reg.pl:417
29260 #: ../tools/virt-win-reg.pl:419
29262 "C<virt-win-reg> expects that regedit files have already been reencoded in "
29263 "the local encoding. Usually on Linux hosts, this means UTF-8 with Unix-"
29264 "style line endings. Since Windows regedit files are often in UTF-16LE with "
29265 "Windows-style line endings, you may need to reencode the whole file before "
29266 "or after processing."
29270 #: ../tools/virt-win-reg.pl:425
29272 "To reencode a file from Windows format to Linux (before processing it with "
29273 "the C<--merge> option), you would do something like this:"
29277 #: ../tools/virt-win-reg.pl:428
29280 " iconv -f utf-16le -t utf-8 < win.reg | dos2unix > linux.reg\n"
29285 #: ../tools/virt-win-reg.pl:430
29287 "To go in the opposite direction, after exporting and before sending the file "
29288 "to a Windows user, do something like this:"
29292 #: ../tools/virt-win-reg.pl:433
29295 " unix2dos linux.reg | iconv -f utf-8 -t utf-16le > win.reg\n"
29300 #: ../tools/virt-win-reg.pl:435
29301 msgid "For more information about encoding, see L<Win::Hivex::Regedit(3)>."
29305 #: ../tools/virt-win-reg.pl:437
29307 "If you are unsure about the current encoding, use the L<file(1)> command. "
29308 "Recent versions of Windows regedit.exe produce a UTF-16LE file with Windows-"
29309 "style (CRLF) line endings, like this:"
29313 #: ../tools/virt-win-reg.pl:441
29316 " $ file software.reg\n"
29317 " software.reg: Little-endian UTF-16 Unicode text, with very long lines,\n"
29318 " with CRLF line terminators\n"
29323 #: ../tools/virt-win-reg.pl:445
29324 msgid "This file would need conversion before you could C<--merge> it."
29328 #: ../tools/virt-win-reg.pl:447
29329 msgid "CurrentControlSet etc."
29333 #: ../tools/virt-win-reg.pl:449
29335 "Registry keys like C<CurrentControlSet> don't really exist in the Windows "
29336 "Registry at the level of the hive file, and therefore you cannot modify "
29341 #: ../tools/virt-win-reg.pl:453
29343 "C<CurrentControlSet> is usually an alias for C<ControlSet001>. In some "
29344 "circumstances it might refer to another control set. The way to find out is "
29345 "to look at the C<HKLM\\SYSTEM\\Select> key:"
29349 #: ../tools/virt-win-reg.pl:457
29352 " # virt-win-reg WindowsGuest 'HKLM\\SYSTEM\\Select'\n"
29353 " [HKEY_LOCAL_MACHINE\\SYSTEM\\Select]\n"
29354 " \"Current\"=dword:00000001\n"
29355 " \"Default\"=dword:00000001\n"
29356 " \"Failed\"=dword:00000000\n"
29357 " \"LastKnownGood\"=dword:00000002\n"
29362 #: ../tools/virt-win-reg.pl:464
29363 msgid "\"Current\" is the one which Windows will choose when it boots."
29367 #: ../tools/virt-win-reg.pl:466
29369 "Similarly, other C<Current...> keys in the path may need to be replaced."
29373 #: ../tools/virt-win-reg.pl:469
29374 msgid "WINDOWS TIPS"
29378 #: ../tools/virt-win-reg.pl:471
29380 "Note that some of these tips modify the guest disk image. The guest I<must> "
29381 "be shut off, else you will get disk corruption."
29385 #: ../tools/virt-win-reg.pl:474
29386 msgid "RUNNING A BATCH SCRIPT WHEN A USER LOGS IN"
29390 #: ../tools/virt-win-reg.pl:476
29392 "Prepare a DOS batch script, VBScript or executable. Upload this using "
29393 "L<guestfish(1)>. For this example the script is called C<test.bat> and it "
29394 "is uploaded into C<C:\\>:"
29398 #: ../tools/virt-win-reg.pl:480
29401 " guestfish -i -d WindowsGuest upload test.bat /test.bat\n"
29406 #: ../tools/virt-win-reg.pl:482
29407 msgid "Prepare a regedit file containing the registry change:"
29411 #: ../tools/virt-win-reg.pl:484
29414 " cat > test.reg <<'EOF'\n"
29415 " [HKLM\\Software\\Microsoft\\Windows\\CurrentVersion\\RunOnce]\n"
29416 " \"Test\"=\"c:\\\\test.bat\"\n"
29422 #: ../tools/virt-win-reg.pl:489
29424 "In this example we use the key C<RunOnce> which means that the script will "
29425 "run precisely once when the first user logs in. If you want it to run every "
29426 "time a user logs in, replace C<RunOnce> with C<Run>."
29430 #: ../tools/virt-win-reg.pl:493
29431 msgid "Now update the registry:"
29435 #: ../tools/virt-win-reg.pl:495
29438 " virt-win-reg --merge WindowsGuest test.reg\n"
29443 #: ../tools/virt-win-reg.pl:497
29444 msgid "INSTALLING A SERVICE"
29448 #: ../tools/virt-win-reg.pl:499
29450 "This section assumes you are familiar with Windows services, and you either "
29451 "have a program which handles the Windows Service Control Protocol directly "
29452 "or you want to run any program using a service wrapper like SrvAny or the "
29457 #: ../tools/virt-win-reg.pl:504
29459 "First upload the program and optionally the service wrapper. In this case "
29460 "the test program is called C<test.exe> and we are using the RHSrvAny wrapper:"
29464 #: ../tools/virt-win-reg.pl:508
29467 " guestfish -i -d WindowsGuest <<EOF\n"
29468 " upload rhsrvany.exe /rhsrvany.exe\n"
29469 " upload test.exe /test.exe\n"
29475 #: ../tools/virt-win-reg.pl:513
29477 "Prepare a regedit file containing the registry changes. In this example, "
29478 "the first registry change is needed for the service itself or the service "
29479 "wrapper (if used). The second registry change is only needed because I am "
29480 "using the RHSrvAny service wrapper."
29484 #: ../tools/virt-win-reg.pl:518
29487 " cat > service.reg <<'EOF'\n"
29488 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny]\n"
29489 " \"Type\"=dword:00000010\n"
29490 " \"Start\"=dword:00000002\n"
29491 " \"ErrorControl\"=dword:00000001\n"
29492 " \"ImagePath\"=\"c:\\\\rhsrvany.exe\"\n"
29493 " \"DisplayName\"=\"RHSrvAny\"\n"
29494 " \"ObjectName\"=\"NetworkService\"\n"
29499 #: ../tools/virt-win-reg.pl:527
29502 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny\\Parameters]\n"
29503 " \"CommandLine\"=\"c:\\\\test.exe\"\n"
29504 " \"PWD\"=\"c:\\\\Temp\"\n"
29510 #: ../tools/virt-win-reg.pl:538
29512 "For use of C<ControlSet001> see the section above in this manual page. You "
29513 "may need to adjust this according to the control set that is in use by the "
29518 #: ../tools/virt-win-reg.pl:544
29520 "C<\"ObjectName\"> controls the privileges that the service will have. An "
29521 "alternative is C<\"ObjectName\"=\"LocalSystem\"> which would be the most "
29522 "privileged account."
29526 #: ../tools/virt-win-reg.pl:550
29528 "For the meaning of the magic numbers, see this Microsoft KB article: "
29529 "L<http://support.microsoft.com/kb/103000>."
29533 #: ../tools/virt-win-reg.pl:555
29534 msgid "Update the registry:"
29538 #: ../tools/virt-win-reg.pl:557
29541 " virt-win-reg --merge WindowsGuest service.reg\n"
29546 #: ../tools/virt-win-reg.pl:561
29548 "Be careful when passing parameters containing C<\\> (backslash) in the "
29549 "shell. Usually you will have to use 'single quotes' or double backslashes "
29550 "(but not both) to protect them from the shell."
29554 #: ../tools/virt-win-reg.pl:565
29555 msgid "Paths and value names are case-insensitive."
29559 #: ../tools/virt-win-reg.pl:574
29561 "L<hivex(3)>, L<hivexsh(1)>, L<hivexregedit(1)>, L<guestfs(3)>, L<guestfish(1)"
29562 ">, L<virt-cat(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Win::Hivex"
29563 "(3)>, L<Win::Hivex::Regedit(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
29567 #: ../tools/virt-win-reg.pl:589 ../tools/virt-make-fs.pl:555
29569 "When reporting bugs, please enable debugging and capture the I<complete> "
29574 #: ../tools/virt-win-reg.pl:592
29577 " export LIBGUESTFS_DEBUG=1\n"
29578 " virt-win-reg --debug [... rest ...] > /tmp/virt-win-reg.log 2>&1\n"
29583 #: ../tools/virt-win-reg.pl:595
29585 "Attach /tmp/virt-win-reg.log to a new bug report at L<https://bugzilla."
29590 #: ../tools/virt-win-reg.pl:604 ../tools/virt-resize.pl:1516
29591 #: ../tools/virt-make-fs.pl:570
29592 msgid "Copyright (C) 2010 Red Hat Inc."
29596 #: ../tools/virt-resize.pl:42
29597 msgid "virt-resize - Resize a virtual machine disk"
29601 #: ../tools/virt-resize.pl:46
29604 " virt-resize [--resize /dev/sdaN=[+/-]<size>[%]]\n"
29605 " [--expand /dev/sdaN] [--shrink /dev/sdaN]\n"
29606 " [--ignore /dev/sdaN] [--delete /dev/sdaN] [...] indisk outdisk\n"
29611 #: ../tools/virt-resize.pl:52
29613 "Virt-resize is a tool which can resize a virtual machine disk, making it "
29614 "larger or smaller overall, and resizing or deleting any partitions contained "
29619 #: ../tools/virt-resize.pl:56
29621 "Virt-resize B<cannot> resize disk images in-place. Virt-resize B<should "
29622 "not> be used on live virtual machines - for consistent results, shut the "
29623 "virtual machine down before resizing it."
29627 #: ../tools/virt-resize.pl:60
29629 "If you are not familiar with the associated tools: L<virt-filesystems(1)> "
29630 "and L<virt-df(1)>, we recommend you go and read those manual pages first."
29634 #: ../tools/virt-resize.pl:66
29636 "Copy C<olddisk> to C<newdisk>, extending one of the guest's partitions to "
29637 "fill the extra 5GB of space."
29641 #: ../tools/virt-resize.pl:69
29644 " truncate -r olddisk newdisk; truncate -s +5G newdisk\n"
29645 " virt-filesystems --long -h --all -a olddisk\n"
29646 " # Note \"/dev/sda2\" is a partition inside the \"olddisk\" file.\n"
29647 " virt-resize --expand /dev/sda2 olddisk newdisk\n"
29652 #: ../tools/virt-resize.pl:74
29654 "As above, but make the /boot partition 200MB bigger, while giving the "
29655 "remaining space to /dev/sda2:"
29659 #: ../tools/virt-resize.pl:77
29662 " virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 olddisk newdisk\n"
29667 #: ../tools/virt-resize.pl:79
29668 msgid "As above, but the output format will be uncompressed qcow2:"
29672 #: ../tools/virt-resize.pl:81
29675 " qemu-img create -f qcow2 newdisk.qcow2 15G\n"
29676 " virt-resize --expand /dev/sda2 olddisk newdisk.qcow2\n"
29681 #: ../tools/virt-resize.pl:84
29682 msgid "DETAILED USAGE"
29686 #: ../tools/virt-resize.pl:86
29687 msgid "EXPANDING A VIRTUAL MACHINE DISK"
29691 #: ../tools/virt-resize.pl:90
29692 msgid "1. Shut down the virtual machine"
29696 #: ../tools/virt-resize.pl:92
29697 msgid "2. Locate input disk image"
29701 #: ../tools/virt-resize.pl:94
29703 "Locate the input disk image (ie. the file or device on the host containing "
29704 "the guest's disk). If the guest is managed by libvirt, you can use C<virsh "
29705 "dumpxml> like this to find the disk image name:"
29709 #: ../tools/virt-resize.pl:98
29712 " # virsh dumpxml guestname | xpath /domain/devices/disk/source\n"
29713 " Found 1 nodes:\n"
29715 " <source dev=\"/dev/vg/lv_guest\" />\n"
29720 #: ../tools/virt-resize.pl:103
29721 msgid "3. Look at current sizing"
29725 #: ../tools/virt-resize.pl:105
29726 msgid "Use L<virt-filesystems(1)> to display the current partitions and sizes:"
29730 #: ../tools/virt-resize.pl:108
29733 " # virt-filesystems --long --parts --blkdevs -h -a /dev/vg/lv_guest\n"
29734 " Name Type Size Parent\n"
29735 " /dev/sda1 partition 101M /dev/sda\n"
29736 " /dev/sda2 partition 7.9G /dev/sda\n"
29737 " /dev/sda device 8.0G -\n"
29742 #: ../tools/virt-resize.pl:114
29744 "(This example is a virtual machine with an 8 GB disk which we would like to "
29745 "expand up to 10 GB)."
29749 #: ../tools/virt-resize.pl:117
29750 msgid "4. Create output disk"
29754 #: ../tools/virt-resize.pl:119
29756 "Virt-resize cannot do in-place disk modifications. You have to have space "
29757 "to store the resized output disk."
29761 #: ../tools/virt-resize.pl:122
29763 "To store the resized disk image in a file, create a file of a suitable size:"
29767 #: ../tools/virt-resize.pl:125
29770 " # rm -f outdisk\n"
29771 " # truncate -s 10G outdisk\n"
29776 #: ../tools/virt-resize.pl:128
29777 msgid "Or use L<lvcreate(1)> to create a logical volume:"
29781 #: ../tools/virt-resize.pl:130
29784 " # lvcreate -L 10G -n lv_name vg_name\n"
29789 #: ../tools/virt-resize.pl:132
29790 msgid "Or use L<virsh(1)> vol-create-as to create a libvirt storage volume:"
29794 #: ../tools/virt-resize.pl:134
29797 " # virsh pool-list\n"
29798 " # virsh vol-create-as poolname newvol 10G\n"
29803 #: ../tools/virt-resize.pl:137
29808 #: ../tools/virt-resize.pl:139
29810 "virt-resize takes two mandatory parameters, the input disk (eg. device or "
29811 "file) and the output disk. The output disk is the one created in the "
29816 #: ../tools/virt-resize.pl:143
29819 " # virt-resize indisk outdisk\n"
29824 #: ../tools/virt-resize.pl:145
29826 "This command just copies disk image C<indisk> to disk image C<outdisk> "
29827 "I<without> resizing or changing any existing partitions. If C<outdisk> is "
29828 "larger, then an extra, empty partition is created at the end of the disk "
29829 "covering the extra space. If C<outdisk> is smaller, then it will give an "
29834 #: ../tools/virt-resize.pl:151
29836 "More realistically you'd want to expand existing partitions in the disk "
29837 "image by passing extra options (for the full list see the L</OPTIONS> "
29842 #: ../tools/virt-resize.pl:155
29844 "L</--expand> is the most useful option. It expands the named partition "
29845 "within the disk to fill any extra space:"
29849 #: ../tools/virt-resize.pl:158
29852 " # virt-resize --expand /dev/sda2 indisk outdisk\n"
29857 #: ../tools/virt-resize.pl:160
29859 "(In this case, an extra partition is I<not> created at the end of the disk, "
29860 "because there will be no unused space)."
29864 #: ../tools/virt-resize.pl:163
29866 "L</--resize> is the other commonly used option. The following would "
29867 "increase the size of /dev/sda1 by 200M, and expand /dev/sda2 to fill the "
29868 "rest of the available space:"
29872 #: ../tools/virt-resize.pl:167
29875 " # virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 \\\n"
29876 " indisk outdisk\n"
29881 #: ../tools/virt-resize.pl:170
29883 "If the expanded partition in the image contains a filesystem or LVM PV, then "
29884 "if virt-resize knows how, it will resize the contents, the equivalent of "
29885 "calling a command such as L<pvresize(8)>, L<resize2fs(8)> or L<ntfsresize(8)"
29886 ">. However virt-resize does not know how to resize some filesystems, so you "
29887 "would have to online resize them after booting the guest."
29891 #: ../tools/virt-resize.pl:177
29892 msgid "Other options are covered below."
29896 #: ../tools/virt-resize.pl:179
29901 #: ../tools/virt-resize.pl:181
29902 msgid "Thoroughly test the new disk image I<before> discarding the old one."
29906 #: ../tools/virt-resize.pl:183
29907 msgid "If you are using libvirt, edit the XML to point at the new disk:"
29911 #: ../tools/virt-resize.pl:185
29914 " # virsh edit guestname\n"
29919 #: ../tools/virt-resize.pl:187
29921 "Change E<lt>source ...E<gt>, see L<http://libvirt.org/formatdomain."
29922 "html#elementsDisks>"
29926 #: ../tools/virt-resize.pl:190
29927 msgid "Then start up the domain with the new, resized disk:"
29931 #: ../tools/virt-resize.pl:192
29934 " # virsh start guestname\n"
29939 #: ../tools/virt-resize.pl:194
29941 "and check that it still works. See also the L</NOTES> section below for "
29942 "additional information."
29946 #: ../tools/virt-resize.pl:197
29947 msgid "7. Resize LVs etc inside the guest"
29951 #: ../tools/virt-resize.pl:199
29952 msgid "(This can also be done offline using L<guestfish(1)>)"
29956 #: ../tools/virt-resize.pl:201
29958 "Once the guest has booted you should see the new space available, at least "
29959 "for filesystems that virt-resize knows how to resize, and for PVs. The user "
29960 "may need to resize LVs inside PVs, and also resize filesystem types that "
29961 "virt-resize does not know how to expand."
29965 #: ../tools/virt-resize.pl:208
29966 msgid "SHRINKING A VIRTUAL MACHINE DISK"
29970 #: ../tools/virt-resize.pl:210
29972 "Shrinking is somewhat more complex than expanding, and only an overview is "
29977 #: ../tools/virt-resize.pl:213
29979 "Firstly virt-resize will not attempt to shrink any partition content (PVs, "
29980 "filesystems). The user has to shrink content before passing the disk image "
29981 "to virt-resize, and virt-resize will check that the content has been shrunk "
29986 #: ../tools/virt-resize.pl:218
29987 msgid "(Shrinking can also be done offline using L<guestfish(1)>)"
29991 #: ../tools/virt-resize.pl:220
29993 "After shrinking PVs and filesystems, shut down the guest, and proceed with "
29994 "steps 3 and 4 above to allocate a new disk image."
29998 #: ../tools/virt-resize.pl:223
30000 "Then run virt-resize with any of the C<--shrink> and/or C<--resize> options."
30004 #: ../tools/virt-resize.pl:226
30005 msgid "IGNORING OR DELETING PARTITIONS"
30009 #: ../tools/virt-resize.pl:228
30011 "virt-resize also gives a convenient way to ignore or delete partitions when "
30012 "copying from the input disk to the output disk. Ignoring a partition speeds "
30013 "up the copy where you don't care about the existing contents of a "
30014 "partition. Deleting a partition removes it completely, but note that it "
30015 "also renumbers any partitions after the one which is deleted, which can "
30016 "leave some guests unbootable."
30020 #: ../tools/virt-resize.pl:235
30021 msgid "QCOW2 AND NON-SPARSE RAW FORMATS"
30025 #: ../tools/virt-resize.pl:237
30027 "If the input disk is in qcow2 format, then you may prefer that the output is "
30028 "in qcow2 format as well. Alternately, virt-resize can convert the format on "
30029 "the fly. The output format is simply determined by the format of the empty "
30030 "output container that you provide. Thus to create qcow2 output, use:"
30034 #: ../tools/virt-resize.pl:243
30037 " qemu-img create [-c] -f qcow2 outdisk [size]\n"
30042 #: ../tools/virt-resize.pl:245
30043 msgid "instead of the truncate command (use C<-c> for a compressed disk)."
30047 #: ../tools/virt-resize.pl:247
30048 msgid "Similarly, to get non-sparse raw output use:"
30052 #: ../tools/virt-resize.pl:249
30055 " fallocate -l size outdisk\n"
30060 #: ../tools/virt-resize.pl:251
30062 "(on older systems that don't have the L<fallocate(1)> command use C<dd if=/"
30063 "dev/zero of=outdisk bs=1M count=..>)"
30067 #: ../tools/virt-resize.pl:264
30068 msgid "Display help."
30072 #: ../tools/virt-resize.pl:278
30073 msgid "B<--resize part=size>"
30077 #: ../tools/virt-resize.pl:280
30079 "Resize the named partition (expanding or shrinking it) so that it has the "
30084 #: ../tools/virt-resize.pl:283
30086 "C<size> can be expressed as an absolute number followed by b/K/M/G/T/P/E to "
30087 "mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Petabytes or "
30088 "Exabytes; or as a percentage of the current size; or as a relative number or "
30089 "percentage. For example:"
30093 #: ../tools/virt-resize.pl:288
30096 " --resize /dev/sda2=10G\n"
30101 #: ../tools/virt-resize.pl:290
30104 " --resize /dev/sda4=90%\n"
30109 #: ../tools/virt-resize.pl:292
30112 " --resize /dev/sda2=+1G\n"
30117 #: ../tools/virt-resize.pl:294
30120 " --resize /dev/sda2=-200M\n"
30125 #: ../tools/virt-resize.pl:296
30128 " --resize /dev/sda1=+128K\n"
30133 #: ../tools/virt-resize.pl:298
30136 " --resize /dev/sda1=+10%\n"
30141 #: ../tools/virt-resize.pl:300
30144 " --resize /dev/sda1=-10%\n"
30149 #: ../tools/virt-resize.pl:302
30151 "You can increase the size of any partition. Virt-resize will expand the "
30152 "direct content of the partition if it knows how (see C<--expand> below)."
30156 #: ../tools/virt-resize.pl:306
30158 "You can only I<decrease> the size of partitions that contain filesystems or "
30159 "PVs which have already been shrunk. Virt-resize will check this has been "
30160 "done before proceeding, or else will print an error (see also C<--resize-"
30165 #: ../tools/virt-resize.pl:311 ../tools/virt-resize.pl:403
30166 #: ../tools/virt-resize.pl:420
30167 msgid "You can give this option multiple times."
30171 #: ../tools/virt-resize.pl:317
30172 msgid "B<--resize-force part=size>"
30176 #: ../tools/virt-resize.pl:319
30178 "This is the same as C<--resize> except that it will let you decrease the "
30179 "size of any partition. Generally this means you will lose any data which "
30180 "was at the end of the partition you shrink, but you may not care about that "
30181 "(eg. if shrinking an unused partition, or if you can easily recreate it such "
30182 "as a swap partition)."
30186 #: ../tools/virt-resize.pl:325
30187 msgid "See also the C<--ignore> option."
30191 #: ../tools/virt-resize.pl:331
30192 msgid "B<--expand part>"
30196 #: ../tools/virt-resize.pl:333
30198 "Expand the named partition so it uses up all extra space (space left over "
30199 "after any other resize changes that you request have been done)."
30203 #: ../tools/virt-resize.pl:336
30205 "If virt-resize knows how, it will expand the direct content of the "
30206 "partition. For example, if the partition is an LVM PV, it will expand the "
30207 "PV to fit (like calling L<pvresize(8)>). Virt-resize leaves any other "
30208 "content it doesn't know about alone."
30212 #: ../tools/virt-resize.pl:341
30213 msgid "Currently virt-resize can resize:"
30217 #: ../tools/virt-resize.pl:347
30219 "ext2, ext3 and ext4 filesystems when they are contained directly inside a "
30224 #: ../tools/virt-resize.pl:352
30226 "NTFS filesystems contained directly in a partition, if libguestfs was "
30227 "compiled with support for NTFS."
30231 #: ../tools/virt-resize.pl:355
30233 "The filesystem must have been shut down consistently last time it was used. "
30234 "Additionally, L<ntfsresize(8)> marks the resized filesystem as requiring a "
30235 "consistency check, so at the first boot after resizing Windows will check "
30240 #: ../tools/virt-resize.pl:362
30242 "LVM PVs (physical volumes). virt-resize does not usually resize anything "
30243 "inside the PV, but see the C<--LV-expand> option. The user could also "
30244 "resize LVs as desired after boot."
30248 #: ../tools/virt-resize.pl:368 ../tools/virt-resize.pl:390
30249 msgid "Note that you cannot use C<--expand> and C<--shrink> together."
30253 #: ../tools/virt-resize.pl:374
30254 msgid "B<--shrink part>"
30258 #: ../tools/virt-resize.pl:376
30260 "Shrink the named partition until the overall disk image fits in the "
30261 "destination. The named partition B<must> contain a filesystem or PV which "
30262 "has already been shrunk using another tool (eg. L<guestfish(1)> or other "
30263 "online tools). Virt-resize will check this and give an error if it has not "
30268 #: ../tools/virt-resize.pl:382
30270 "The amount by which the overall disk must be shrunk (after carrying out all "
30271 "other operations requested by the user) is called the \"deficit\". For "
30272 "example, a straight copy (assume no other operations) from a 5GB disk image "
30273 "to a 4GB disk image results in a 1GB deficit. In this case, virt-resize "
30274 "would give an error unless the user specified a partition to shrink and that "
30275 "partition had more than a gigabyte of free space."
30279 #: ../tools/virt-resize.pl:396
30280 msgid "B<--ignore part>"
30284 #: ../tools/virt-resize.pl:398
30286 "Ignore the named partition. Effectively this means the partition is "
30287 "allocated on the destination disk, but the content is not copied across from "
30288 "the source disk. The content of the partition will be blank (all zero "
30293 #: ../tools/virt-resize.pl:409
30294 msgid "B<--delete part>"
30298 #: ../tools/virt-resize.pl:411
30300 "Delete the named partition. It would be more accurate to describe this as "
30301 "\"don't copy it over\", since virt-resize doesn't do in-place changes and "
30302 "the original disk image is left intact."
30306 #: ../tools/virt-resize.pl:415
30308 "Note that when you delete a partition, then anything contained in the "
30309 "partition is also deleted. Furthermore, this causes any partitions that "
30310 "come after to be I<renumbered>, which can easily make your guest unbootable."
30314 #: ../tools/virt-resize.pl:426
30315 msgid "B<--LV-expand logvol>"
30319 #: ../tools/virt-resize.pl:428
30321 "This takes the logical volume and, as a final step, expands it to fill all "
30322 "the space available in its volume group. A typical usage, assuming a Linux "
30323 "guest with a single PV C</dev/sda2> and a root device called C</dev/vg_guest/"
30324 "lv_root> would be:"
30328 #: ../tools/virt-resize.pl:433
30331 " virt-resize indisk outdisk \\\n"
30332 " --expand /dev/sda2 --LV-expand /dev/vg_guest/lv_root\n"
30337 #: ../tools/virt-resize.pl:436
30339 "This would first expand the partition (and PV), and then expand the root "
30340 "device to fill the extra space in the PV."
30344 #: ../tools/virt-resize.pl:439
30346 "The contents of the LV are also resized if virt-resize knows how to do "
30347 "that. You can stop virt-resize from trying to expand the content by using "
30348 "the option C<--no-expand-content>."
30352 #: ../tools/virt-resize.pl:443
30353 msgid "Use L<virt-filesystems(1)> to list the filesystems in the guest."
30357 #: ../tools/virt-resize.pl:446
30359 "You can give this option multiple times, I<but> it doesn't make sense to do "
30360 "this unless the logical volumes you specify are all in different volume "
30365 #: ../tools/virt-resize.pl:454
30366 msgid "B<--no-copy-boot-loader>"
30370 #: ../tools/virt-resize.pl:456
30372 "By default, virt-resize copies over some sectors at the start of the disk "
30373 "(up to the beginning of the first partition). Commonly these sectors "
30374 "contain the Master Boot Record (MBR) and the boot loader, and are required "
30375 "in order for the guest to boot correctly."
30379 #: ../tools/virt-resize.pl:461
30381 "If you specify this flag, then this initial copy is not done. You may need "
30382 "to reinstall the boot loader in this case."
30386 #: ../tools/virt-resize.pl:469
30387 msgid "B<--no-extra-partition>"
30391 #: ../tools/virt-resize.pl:471
30393 "By default, virt-resize creates an extra partition if there is any extra, "
30394 "unused space after all resizing has happened. Use this option to prevent "
30395 "the extra partition from being created. If you do this then the extra space "
30396 "will be inaccessible until you run fdisk, parted, or some other partitioning "
30397 "tool in the guest."
30401 #: ../tools/virt-resize.pl:477
30403 "Note that if the surplus space is smaller than 10 MB, no extra partition "
30408 #: ../tools/virt-resize.pl:484
30409 msgid "B<--no-expand-content>"
30413 #: ../tools/virt-resize.pl:486
30415 "By default, virt-resize will try to expand the direct contents of "
30416 "partitions, if it knows how (see C<--expand> option above)."
30420 #: ../tools/virt-resize.pl:489
30422 "If you give the C<--no-expand-content> option then virt-resize will not "
30427 #: ../tools/virt-resize.pl:496
30428 msgid "B<-d> | B<--debug>"
30432 #: ../tools/virt-resize.pl:504
30433 msgid "B<-n> | B<--dryrun>"
30437 #: ../tools/virt-resize.pl:506
30438 msgid "Print a summary of what would be done, but don't do anything."
30442 #: ../tools/virt-resize.pl:512
30443 msgid "B<-q> | B<--quiet>"
30447 #: ../tools/virt-resize.pl:514
30448 msgid "Don't print the summary."
30452 #: ../tools/virt-resize.pl:522
30454 "Specify the format of the input disk image. If this flag is not given then "
30455 "it is auto-detected from the image itself."
30459 #: ../tools/virt-resize.pl:528
30461 "Note that this option I<does not> affect the output format. See L</QCOW2 "
30462 "AND NON-SPARSE RAW FORMATS>."
30466 #: ../tools/virt-resize.pl:535
30467 msgid "B<--output-format> raw"
30471 #: ../tools/virt-resize.pl:537
30473 "Specify the format of the output disk image. If this flag is not given then "
30474 "it is auto-detected from the image itself."
30478 #: ../tools/virt-resize.pl:543
30480 "Note that you still need to create the output disk with the right format. "
30481 "See L</QCOW2 AND NON-SPARSE RAW FORMATS>."
30485 #: ../tools/virt-resize.pl:1425
30490 #: ../tools/virt-resize.pl:1427
30491 msgid "\"Partition 1 does not end on cylinder boundary.\""
30495 #: ../tools/virt-resize.pl:1429
30497 "Virt-resize aligns partitions to multiples of 64 sectors. Usually this "
30498 "means the partitions will not be aligned to the ancient CHS geometry. "
30499 "However CHS geometry is meaningless for disks manufactured since the early "
30500 "1990s, and doubly so for virtual hard drives. Alignment of partitions to "
30501 "cylinders is not required by any modern operating system."
30505 #: ../tools/virt-resize.pl:1436
30506 msgid "RESIZING WINDOWS VIRTUAL MACHINES"
30510 #: ../tools/virt-resize.pl:1438
30512 "In Windows Vista and later versions, Microsoft switched to using a separate "
30513 "boot partition. In these VMs, typically C</dev/sda1> is the boot partition "
30514 "and C</dev/sda2> is the main (C:) drive. We have not had any luck resizing "
30515 "the boot partition. Doing so seems to break the guest completely. However "
30516 "expanding the second partition (ie. C: drive) should work."
30520 #: ../tools/virt-resize.pl:1445
30522 "Windows may initiate a lengthy \"chkdsk\" on first boot after a resize, if "
30523 "NTFS partitions have been expanded. This is just a safety check and (unless "
30524 "it find errors) is nothing to worry about."
30528 #: ../tools/virt-resize.pl:1449
30529 msgid "GUEST BOOT STUCK AT \"GRUB\""
30533 #: ../tools/virt-resize.pl:1451
30535 "If a Linux guest does not boot after resizing, and the boot is stuck after "
30536 "printing C<GRUB> on the console, try reinstalling grub. This sometimes "
30537 "happens on older (RHEL 5-era) guests, for reasons we don't fully understand, "
30538 "although we think is to do with partition alignment."
30542 #: ../tools/virt-resize.pl:1456
30545 " guestfish -i -a newdisk\n"
30546 " ><fs> cat /boot/grub/device.map\n"
30547 " # check the contents of this file are sensible or\n"
30548 " # edit the file if necessary\n"
30549 " ><fs> grub-install / /dev/vda\n"
30555 #: ../tools/virt-resize.pl:1463
30557 "For more flexible guest reconfiguration, including if you need to specify "
30558 "other parameters to grub-install, use L<virt-rescue(1)>."
30562 #: ../tools/virt-resize.pl:1466
30563 msgid "ALTERNATIVE TOOLS"
30567 #: ../tools/virt-resize.pl:1468
30569 "There are several proprietary tools for resizing partitions. We won't "
30570 "mention any here."
30574 #: ../tools/virt-resize.pl:1471
30576 "L<parted(8)> and its graphical shell gparted can do some types of resizing "
30577 "operations on disk images. They can resize and move partitions, but I don't "
30578 "think they can do anything with the contents, and they certainly don't "
30583 #: ../tools/virt-resize.pl:1476
30585 "L<guestfish(1)> can do everything that virt-resize can do and a lot more, "
30586 "but at a much lower level. You will probably end up hand-calculating sector "
30587 "offsets, which is something that virt-resize was designed to avoid. If you "
30588 "want to see the guestfish-equivalent commands that virt-resize runs, use the "
30593 #: ../tools/virt-resize.pl:1491
30595 "L<virt-filesystems(1)>, L<virt-df(1)>, L<guestfs(3)>, L<guestfish(1)>, L<lvm"
30596 "(8)>, L<pvresize(8)>, L<lvresize(8)>, L<resize2fs(8)>, L<ntfsresize(8)>, "
30597 "L<virsh(1)>, L<parted(8)>, L<truncate(1)>, L<fallocate(1)>, L<grub(8)>, "
30598 "L<grub-install(8)>, L<virt-rescue(1)>, L<Sys::Guestfs(3)>, L<http://"
30599 "libguestfs.org/>."
30603 #: ../tools/virt-list-filesystems.pl:32
30605 "virt-list-filesystems - List filesystems in a virtual machine or disk image"
30609 #: ../tools/virt-list-filesystems.pl:36
30612 " virt-list-filesystems [--options] domname\n"
30617 #: ../tools/virt-list-filesystems.pl:38
30620 " virt-list-filesystems [--options] disk.img [disk.img ...]\n"
30625 #: ../tools/virt-list-filesystems.pl:42 ../tools/virt-list-partitions.pl:42
30627 "This tool is obsolete. Use L<virt-filesystems(1)> as a more flexible "
30632 #: ../tools/virt-list-filesystems.pl:45
30634 "C<virt-list-filesystems> is a command line tool to list the filesystems that "
30635 "are contained in a virtual machine or disk image."
30639 #: ../tools/virt-list-filesystems.pl:49
30641 "C<virt-list-filesystems> is just a simple wrapper around L<libguestfs(3)> "
30642 "functionality. For more complex cases you should look at the L<guestfish(1)"
30647 #: ../tools/virt-list-filesystems.pl:106 ../tools/virt-list-partitions.pl:115
30648 msgid "B<-l> | B<--long>"
30652 #: ../tools/virt-list-filesystems.pl:108
30654 "With this option, C<virt-list-filesystems> displays the type of each "
30655 "filesystem too (where \"type\" means C<ext3>, C<xfs> etc.)"
30659 #: ../tools/virt-list-filesystems.pl:115
30660 msgid "B<-a> | B<--all>"
30664 #: ../tools/virt-list-filesystems.pl:117
30666 "Normally we only show mountable filesystems. If this option is given then "
30667 "swap devices are shown too."
30671 #: ../tools/virt-list-filesystems.pl:191
30673 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, L<virt-"
30674 "filesystems(1)>, L<virt-list-partitions(1)>, L<Sys::Guestfs(3)>, L<Sys::"
30675 "Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
30679 #: ../tools/virt-list-filesystems.pl:208 ../tools/virt-tar.pl:307
30680 msgid "Copyright (C) 2009 Red Hat Inc."
30684 #: ../tools/virt-tar.pl:33
30685 msgid "virt-tar - Extract or upload files to a virtual machine"
30689 #: ../tools/virt-tar.pl:37
30692 " virt-tar [--options] -x domname directory tarball\n"
30697 #: ../tools/virt-tar.pl:39
30700 " virt-tar [--options] -u domname tarball directory\n"
30705 #: ../tools/virt-tar.pl:41
30708 " virt-tar [--options] disk.img [disk.img ...] -x directory tarball\n"
30713 #: ../tools/virt-tar.pl:43
30716 " virt-tar [--options] disk.img [disk.img ...] -u tarball directory\n"
30721 #: ../tools/virt-tar.pl:47
30723 "This tool is obsolete. Use L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-"
30724 "tar-in(1)>, L<virt-tar-out(1)> as replacements."
30728 #: ../tools/virt-tar.pl:52
30729 msgid "Download C</home> from the VM into a local tarball:"
30733 #: ../tools/virt-tar.pl:54
30736 " virt-tar -x domname /home home.tar\n"
30741 #: ../tools/virt-tar.pl:56
30744 " virt-tar -zx domname /home home.tar.gz\n"
30749 #: ../tools/virt-tar.pl:58
30750 msgid "Upload a local tarball and unpack it inside C</tmp> in the VM:"
30754 #: ../tools/virt-tar.pl:60
30757 " virt-tar -u domname uploadstuff.tar /tmp\n"
30762 #: ../tools/virt-tar.pl:62
30765 " virt-tar -zu domname uploadstuff.tar.gz /tmp\n"
30770 #: ../tools/virt-tar.pl:66
30772 "You must I<not> use C<virt-tar> with the C<-u> option (upload) on live "
30773 "virtual machines. If you do this, you risk disk corruption in the VM. "
30774 "C<virt-tar> tries to stop you from doing this, but doesn't catch all cases."
30778 #: ../tools/virt-tar.pl:71
30780 "You can use C<-x> (extract) on live virtual machines, but you might get "
30781 "inconsistent results or errors if there is filesystem activity inside the "
30782 "VM. If the live VM is synched and quiescent, then C<virt-tar> will usually "
30783 "work, but the only way to guarantee consistent results is if the virtual "
30784 "machine is shut down."
30788 #: ../tools/virt-tar.pl:79
30790 "C<virt-tar> is a general purpose archive tool for downloading and uploading "
30791 "parts of a guest filesystem. There are many possibilities: making backups, "
30792 "uploading data files, snooping on guest activity, fixing or customizing "
30797 #: ../tools/virt-tar.pl:84
30799 "If you want to just view a single file, use L<virt-cat(1)>. If you just "
30800 "want to edit a single file, use L<virt-edit(1)>. For more complex cases you "
30801 "should look at the L<guestfish(1)> tool."
30805 #: ../tools/virt-tar.pl:88
30807 "There are two modes of operation: C<-x> (eXtract) downloads a directory and "
30808 "its contents (recursively) from the virtual machine into a local tarball. "
30809 "C<-u> uploads from a local tarball, unpacking it into a directory inside the "
30810 "virtual machine. You cannot use these two options together."
30814 #: ../tools/virt-tar.pl:94
30816 "In addition, you may need to use the C<-z> (gZip) option to enable "
30817 "compression. When uploading, you have to specify C<-z> if the upload file "
30818 "is compressed because virt-tar won't detect this on its own."
30822 #: ../tools/virt-tar.pl:98
30824 "C<virt-tar> can only handle tar (optionally gzipped) format tarballs. For "
30825 "example it cannot do PKZip files or bzip2 compression. If you want that "
30826 "then you'll have to rebuild the tarballs yourself. (This is a limitation of "
30827 "the L<libguestfs(3)> API)."
30831 #: ../tools/virt-tar.pl:156
30832 msgid "B<-x> | B<--extract> | B<--download>"
30836 #: ../tools/virt-tar.pl:158
30837 msgid "B<-u> | B<--upload>"
30841 #: ../tools/virt-tar.pl:160
30843 "Use C<-x> to extract (download) a directory from a virtual machine to a "
30848 #: ../tools/virt-tar.pl:163
30850 "Use C<-u> to upload and unpack from a local tarball into a virtual machine. "
30851 "Please read the L</WARNING> section above before using this option."
30855 #: ../tools/virt-tar.pl:167
30856 msgid "You must specify exactly one of these options."
30860 #: ../tools/virt-tar.pl:173
30861 msgid "B<-z> | B<--gzip>"
30865 #: ../tools/virt-tar.pl:175
30866 msgid "Specify that the input or output tarball is gzip-compressed."
30870 #: ../tools/virt-tar.pl:288
30872 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, L<virt-copy-"
30873 "in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<Sys::"
30874 "Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs."
30879 #: ../tools/virt-make-fs.pl:37
30880 msgid "virt-make-fs - Make a filesystem from a tar archive or files"
30884 #: ../tools/virt-make-fs.pl:41
30887 " virt-make-fs [--options] input.tar output.img\n"
30892 #: ../tools/virt-make-fs.pl:43
30895 " virt-make-fs [--options] input.tar.gz output.img\n"
30900 #: ../tools/virt-make-fs.pl:45
30903 " virt-make-fs [--options] directory output.img\n"
30908 #: ../tools/virt-make-fs.pl:49
30910 "Virt-make-fs is a command line tool for creating a filesystem from a tar "
30911 "archive or some files in a directory. It is similar to tools like L<mkisofs"
30912 "(1)>, L<genisoimage(1)> and L<mksquashfs(1)>. Unlike those tools, it can "
30913 "create common filesystem types like ext2/3 or NTFS, which can be useful if "
30914 "you want to attach these filesystems to existing virtual machines (eg. to "
30915 "import large amounts of read-only data to a VM)."
30919 #: ../tools/virt-make-fs.pl:57
30920 msgid "Basic usage is:"
30924 #: ../tools/virt-make-fs.pl:59
30927 " virt-make-fs input output\n"
30932 #: ../tools/virt-make-fs.pl:61
30934 "where C<input> is either a directory containing files that you want to add, "
30935 "or a tar archive (either uncompressed tar or gzip-compressed tar); and "
30936 "C<output> is a disk image. The input type is detected automatically. The "
30937 "output disk image defaults to a raw ext2 image unless you specify extra "
30938 "flags (see L</OPTIONS> below)."
30942 #: ../tools/virt-make-fs.pl:67
30943 msgid "EXTRA SPACE"
30947 #: ../tools/virt-make-fs.pl:69
30949 "Unlike formats such as tar and squashfs, a filesystem does not \"just fit\" "
30950 "the files that it contains, but might have extra space. Depending on how "
30951 "you are going to use the output, you might think this extra space is wasted "
30952 "and want to minimize it, or you might want to leave space so that more files "
30953 "can be added later. Virt-make-fs defaults to minimizing the extra space, "
30954 "but you can use the C<--size> flag to leave space in the filesystem if you "
30959 #: ../tools/virt-make-fs.pl:77
30961 "An alternative way to leave extra space but not make the output image any "
30962 "bigger is to use an alternative disk image format (instead of the default "
30963 "\"raw\" format). Using C<--format=qcow2> will use the native QEmu/KVM qcow2 "
30964 "image format (check your hypervisor supports this before using it). This "
30965 "allows you to choose a large C<--size> but the extra space won't actually be "
30966 "allocated in the image until you try to store something in it."
30970 #: ../tools/virt-make-fs.pl:85
30972 "Don't forget that you can also use local commands including L<resize2fs(8)> "
30973 "and L<virt-resize(1)> to resize existing filesystems, or rerun virt-make-fs "
30974 "to build another image from scratch."
30978 #: ../tools/virt-make-fs.pl:89 ../tools/virt-make-fs.pl:123
30979 #: ../tools/virt-make-fs.pl:142
30984 #: ../tools/virt-make-fs.pl:91
30987 " virt-make-fs --format=qcow2 --size=+200M input output.img\n"
30992 #: ../tools/virt-make-fs.pl:93
30993 msgid "FILESYSTEM TYPE"
30997 #: ../tools/virt-make-fs.pl:95
30999 "The default filesystem type is C<ext2>. Just about any filesystem type that "
31000 "libguestfs supports can be used (but I<not> read-only formats like "
31001 "ISO9660). Here are some of the more common choices:"
31005 #: ../tools/virt-make-fs.pl:101
31010 #: ../tools/virt-make-fs.pl:103
31012 "Note that ext3 filesystems contain a journal, typically 1-32 MB in size. If "
31013 "you are not going to use the filesystem in a way that requires the journal, "
31014 "then this is just wasted overhead."
31018 #: ../tools/virt-make-fs.pl:107
31019 msgid "I<ntfs> or I<vfat>"
31023 #: ../tools/virt-make-fs.pl:109
31024 msgid "Useful if exporting data to a Windows guest."
31028 #: ../tools/virt-make-fs.pl:111
31030 "I<Note for vfat>: The tar archive or local directory must only contain files "
31031 "which are owned by root (ie. UID:GID = 0:0). The reason is that the tar "
31032 "program running within libguestfs is unable to change the ownership of non-"
31033 "root files, since vfat itself does not support this."
31037 #: ../tools/virt-make-fs.pl:116
31042 #: ../tools/virt-make-fs.pl:118
31044 "Lower overhead than C<ext2>, but certain limitations on filename length and "
31045 "total filesystem size."
31049 #: ../tools/virt-make-fs.pl:125
31052 " virt-make-fs --type=minix input minixfs.img\n"
31057 #: ../tools/virt-make-fs.pl:127
31058 msgid "TO PARTITION OR NOT TO PARTITION"
31062 #: ../tools/virt-make-fs.pl:129
31063 msgid "Optionally virt-make-fs can add a partition table to the output disk."
31067 #: ../tools/virt-make-fs.pl:131
31069 "Adding a partition can make the disk image more compatible with certain "
31070 "virtualized operating systems which don't expect to see a filesystem "
31071 "directly located on a block device (Linux doesn't care and will happily "
31072 "handle both types)."
31076 #: ../tools/virt-make-fs.pl:136
31078 "On the other hand, if you have a partition table then the output image is no "
31079 "longer a straight filesystem. For example you cannot run L<fsck(8)> "
31080 "directly on a partitioned disk image. (However libguestfs tools such as "
31081 "L<guestfish(1)> and L<virt-resize(1)> can still be used)."
31085 #: ../tools/virt-make-fs.pl:144
31086 msgid "Add an MBR partition:"
31090 #: ../tools/virt-make-fs.pl:146
31093 " virt-make-fs --partition -- input disk.img\n"
31098 #: ../tools/virt-make-fs.pl:148
31100 "If the output disk image could be terabyte-sized or larger, it's better to "
31101 "use an EFI/GPT-compatible partition table:"
31105 #: ../tools/virt-make-fs.pl:151
31108 " virt-make-fs --partition=gpt --size=+4T --format=qcow2 input disk.img\n"
31113 #: ../tools/virt-make-fs.pl:179
31114 msgid "Enable debugging information."
31118 #: ../tools/virt-make-fs.pl:185
31119 msgid "B<--size=E<lt>NE<gt>>"
31123 #: ../tools/virt-make-fs.pl:187
31124 msgid "B<--size=+E<lt>NE<gt>>"
31128 #: ../tools/virt-make-fs.pl:189
31129 msgid "B<-s E<lt>NE<gt>>"
31133 #: ../tools/virt-make-fs.pl:191
31134 msgid "B<-s +E<lt>NE<gt>>"
31138 #: ../tools/virt-make-fs.pl:193
31140 "Use the C<--size> (or C<-s>) option to choose the size of the output image."
31144 #: ../tools/virt-make-fs.pl:196
31146 "If this option is I<not> given, then the output image will be just large "
31147 "enough to contain all the files, with not much wasted space."
31151 #: ../tools/virt-make-fs.pl:199
31153 "To choose a fixed size output disk, specify an absolute number followed by b/"
31154 "K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
31155 "Petabytes or Exabytes. This must be large enough to contain all the input "
31156 "files, else you will get an error."
31160 #: ../tools/virt-make-fs.pl:204
31162 "To leave extra space, specify C<+> (plus sign) and a number followed by b/K/"
31163 "M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
31164 "Petabytes or Exabytes. For example: C<--size=+200M> means enough space for "
31165 "the input files, and (approximately) an extra 200 MB free space."
31169 #: ../tools/virt-make-fs.pl:210
31171 "Note that virt-make-fs estimates free space, and therefore will not produce "
31172 "filesystems containing precisely the free space requested. (It is much more "
31173 "expensive and time-consuming to produce a filesystem which has precisely the "
31174 "desired free space)."
31178 #: ../tools/virt-make-fs.pl:219
31179 msgid "B<--format=E<lt>fmtE<gt>>"
31183 #: ../tools/virt-make-fs.pl:221
31184 msgid "B<-F E<lt>fmtE<gt>>"
31188 #: ../tools/virt-make-fs.pl:223
31189 msgid "Choose the output disk image format."
31193 #: ../tools/virt-make-fs.pl:225
31194 msgid "The default is C<raw> (raw disk image)."
31198 #: ../tools/virt-make-fs.pl:227
31200 "For other choices, see the L<qemu-img(1)> manpage. The only other choice "
31201 "that would really make sense here is C<qcow2>."
31205 #: ../tools/virt-make-fs.pl:234
31206 msgid "B<--type=E<lt>fsE<gt>>"
31210 #: ../tools/virt-make-fs.pl:236
31211 msgid "B<-t E<lt>fsE<gt>>"
31215 #: ../tools/virt-make-fs.pl:238
31216 msgid "Choose the output filesystem type."
31220 #: ../tools/virt-make-fs.pl:240
31221 msgid "The default is C<ext2>."
31225 #: ../tools/virt-make-fs.pl:242
31227 "Any filesystem which is supported read-write by libguestfs can be used here."
31231 #: ../tools/virt-make-fs.pl:249
31232 msgid "B<--partition>"
31236 #: ../tools/virt-make-fs.pl:251
31237 msgid "B<--partition=E<lt>parttypeE<gt>>"
31241 #: ../tools/virt-make-fs.pl:253
31243 "If specified, this flag adds an MBR partition table to the output disk image."
31247 #: ../tools/virt-make-fs.pl:256
31249 "You can change the partition table type, eg. C<--partition=gpt> for large "
31254 #: ../tools/virt-make-fs.pl:259
31256 "Note that if you just use a lonesome C<--partition>, the Perl option parser "
31257 "might consider the next parameter to be the partition type. For example:"
31261 #: ../tools/virt-make-fs.pl:263
31264 " virt-make-fs --partition input.tar ...\n"
31269 #: ../tools/virt-make-fs.pl:265
31271 "would cause virt-make-fs to think you wanted to use a partition type of "
31272 "C<input.tar> which is completely wrong. To avoid this, use C<--> (a double "
31273 "dash) between options and the input file argument:"
31277 #: ../tools/virt-make-fs.pl:269
31280 " virt-make-fs --partition -- input.tar ...\n"
31285 #: ../tools/virt-make-fs.pl:541
31287 "L<guestfish(1)>, L<virt-resize(1)>, L<virt-tar-in(1)>, L<mkisofs(1)>, "
31288 "L<genisoimage(1)>, L<mksquashfs(1)>, L<mke2fs(8)>, L<resize2fs(8)>, L<guestfs"
31289 "(3)>, L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
31293 #: ../tools/virt-make-fs.pl:558
31296 " export LIBGUESTFS_DEBUG=1\n"
31297 " virt-make-fs --debug [...] > /tmp/virt-make-fs.log 2>&1\n"
31302 #: ../tools/virt-make-fs.pl:561
31304 "Attach /tmp/virt-make-fs.log to a new bug report at L<https://bugzilla."
31309 #: ../tools/virt-list-partitions.pl:32
31311 "virt-list-partitions - List partitions in a virtual machine or disk image"
31315 #: ../tools/virt-list-partitions.pl:36
31318 " virt-list-partitions [--options] domname\n"
31323 #: ../tools/virt-list-partitions.pl:38
31326 " virt-list-partitions [--options] disk.img [disk.img ...]\n"
31331 #: ../tools/virt-list-partitions.pl:45
31333 "C<virt-list-partitions> is a command line tool to list the partitions that "
31334 "are contained in a virtual machine or disk image. It is mainly useful as a "
31335 "first step to using L<virt-resize(1)>."
31339 #: ../tools/virt-list-partitions.pl:50
31341 "C<virt-list-partitions> is just a simple wrapper around L<libguestfs(3)> "
31342 "functionality. For more complex cases you should look at the L<guestfish(1)"
31347 #: ../tools/virt-list-partitions.pl:107
31348 msgid "B<-h> | B<--human-readable>"
31352 #: ../tools/virt-list-partitions.pl:109
31353 msgid "Show sizes in human-readable form (eg. \"1G\")."
31357 #: ../tools/virt-list-partitions.pl:117
31359 "With this option, C<virt-list-partitions> displays the type and size of each "
31360 "partition too (where \"type\" means C<ext3>, C<pv> etc.)"
31364 #: ../tools/virt-list-partitions.pl:124
31365 msgid "B<-t> | B<--total>"
31369 #: ../tools/virt-list-partitions.pl:126
31371 "Display the total size of each block device (as a separate row or rows)."
31375 #: ../tools/virt-list-partitions.pl:259
31377 "L<guestfs(3)>, L<guestfish(1)>, L<virt-filesystems(1)>, L<virt-list-"
31378 "filesystems(1)>, L<virt-resize(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib"
31379 "(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."