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-07-13 15:55+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-win-reg.pl:35 ../tools/virt-list-filesystems.pl:30
25 #: ../tools/virt-tar.pl:31 ../tools/virt-make-fs.pl:35
26 #: ../tools/virt-list-partitions.pl:30
31 #: ../src/guestfs.pod:5
32 msgid "guestfs - Library for accessing and modifying virtual machine images"
34 "guestfs — бібліотека для доступу та внесення змін до образів віртуальних "
38 #: ../src/guestfs.pod:7 ../fish/guestfish.pod:7
39 #: ../test-tool/libguestfs-test-tool.pod:7 ../fuse/guestmount.pod:7
40 #: ../tools/virt-win-reg.pl:39 ../tools/virt-list-filesystems.pl:34
41 #: ../tools/virt-tar.pl:35 ../tools/virt-make-fs.pl:39
42 #: ../tools/virt-list-partitions.pl:34
44 msgstr "КОРОТКИЙ ОПИС"
47 #: ../src/guestfs.pod:9
50 " #include <guestfs.h>\n"
53 " #include <guestfs.h>\n"
57 #: ../src/guestfs.pod:11
60 " guestfs_h *g = guestfs_create ();\n"
61 " guestfs_add_drive (g, \"guest.img\");\n"
62 " guestfs_launch (g);\n"
63 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
64 " guestfs_touch (g, \"/hello\");\n"
65 " guestfs_umount (g, \"/\");\n"
66 " guestfs_close (g);\n"
69 " guestfs_h *g = guestfs_create ();\n"
70 " guestfs_add_drive (g, \"guest.img\");\n"
71 " guestfs_launch (g);\n"
72 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
73 " guestfs_touch (g, \"/hello\");\n"
74 " guestfs_umount (g, \"/\");\n"
75 " guestfs_close (g);\n"
79 #: ../src/guestfs.pod:19
82 " cc prog.c -o prog -lguestfs\n"
84 " cc prog.c -o prog `pkg-config libguestfs --cflags --libs`\n"
87 " cc prog.c -o prog -lguestfs\n"
89 " cc prog.c -o prog `pkg-config libguestfs --cflags --libs`\n"
93 #: ../src/guestfs.pod:23 ../fish/guestfish.pod:30
94 #: ../test-tool/libguestfs-test-tool.pod:11 ../fuse/guestmount.pod:20
95 #: ../tools/virt-win-reg.pl:63 ../tools/virt-list-filesystems.pl:40
96 #: ../tools/virt-tar.pl:77 ../tools/virt-make-fs.pl:47
97 #: ../tools/virt-list-partitions.pl:40
102 #: ../src/guestfs.pod:25
104 "Libguestfs is a library for accessing and modifying guest disk images. "
105 "Amongst the things this is good for: making batch configuration changes to "
106 "guests, getting disk used/free statistics (see also: virt-df), migrating "
107 "between virtualization systems (see also: virt-p2v), performing partial "
108 "backups, performing partial guest clones, cloning guests and changing "
109 "registry/UUID/hostname info, and much else besides."
113 #: ../src/guestfs.pod:33
115 "Libguestfs uses Linux kernel and qemu code, and can access any type of guest "
116 "filesystem that Linux and qemu can, including but not limited to: ext2/3/4, "
117 "btrfs, FAT and NTFS, LVM, many different disk partition schemes, qcow, "
122 #: ../src/guestfs.pod:38
124 "Libguestfs provides ways to enumerate guest storage (eg. partitions, LVs, "
125 "what filesystem is in each LV, etc.). It can also run commands in the "
126 "context of the guest. Also you can access filesystems over FUSE."
130 #: ../src/guestfs.pod:43
132 "Libguestfs is a library that can be linked with C and C++ management "
133 "programs (or management programs written in OCaml, Perl, Python, Ruby, Java, "
134 "PHP, Haskell or C#). You can also use it from shell scripts or the command "
139 #: ../src/guestfs.pod:48
141 "You don't need to be root to use libguestfs, although obviously you do need "
142 "enough permissions to access the disk images."
146 #: ../src/guestfs.pod:51
148 "Libguestfs is a large API because it can do many things. For a gentle "
149 "introduction, please read the L</API OVERVIEW> section next."
153 #: ../src/guestfs.pod:54
155 "There are also some example programs in the L<guestfs-examples(3)> manual "
160 #: ../src/guestfs.pod:57
165 #: ../src/guestfs.pod:59
167 "This section provides a gentler overview of the libguestfs API. We also try "
168 "to group API calls together, where that may not be obvious from reading "
169 "about the individual calls in the main section of this manual."
173 #: ../src/guestfs.pod:64
178 #: ../src/guestfs.pod:66
180 "Before you can use libguestfs calls, you have to create a handle. Then you "
181 "must add at least one disk image to the handle, followed by launching the "
182 "handle, then performing whatever operations you want, and finally closing "
183 "the handle. By convention we use the single letter C<g> for the name of the "
184 "handle variable, although of course you can use any name you want."
188 #: ../src/guestfs.pod:73
189 msgid "The general structure of all libguestfs-using programs looks like this:"
193 #: ../src/guestfs.pod:76
196 " guestfs_h *g = guestfs_create ();\n"
199 " guestfs_h *g = guestfs_create ();\n"
203 #: ../src/guestfs.pod:78
206 " /* Call guestfs_add_drive additional times if there are\n"
207 " * multiple disk images.\n"
209 " guestfs_add_drive (g, \"guest.img\");\n"
214 #: ../src/guestfs.pod:83
217 " /* Most manipulation calls won't work until you've launched\n"
218 " * the handle 'g'. You have to do this _after_ adding drives\n"
219 " * and _before_ other commands.\n"
221 " guestfs_launch (g);\n"
226 #: ../src/guestfs.pod:89
229 " /* Now you can examine what partitions, LVs etc are available.\n"
231 " char **partitions = guestfs_list_partitions (g);\n"
232 " char **logvols = guestfs_lvs (g);\n"
237 #: ../src/guestfs.pod:94
240 " /* To access a filesystem in the image, you must mount it.\n"
242 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
245 " /* Щоб отримати доступ до файлової системи на образі, вам слід його змонтувати.\n"
247 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
251 #: ../src/guestfs.pod:98
254 #| " /* Now you can perform filesystem actions on the guest\n"
255 #| " * disk image.\n"
257 #| " guestfs_touch (g, \"/hello\");\n"
260 " /* Now you can perform filesystem actions on the guest\n"
263 " guestfs_touch (g, \"/hello\");\n"
266 " /* Тепер ви можете виконувати дії з файловою системою на\n"
267 " * образі диска операційної системи.\n"
269 " guestfs_touch (g, \"/hello\");\n"
273 #: ../src/guestfs.pod:103
276 " /* This is only needed for libguestfs < 1.5.24. Since then\n"
277 " * it is done automatically when you close the handle. See\n"
278 " * discussion of autosync in this page.\n"
280 " guestfs_sync (g);\n"
285 #: ../src/guestfs.pod:109
288 " /* Close the handle 'g'. */\n"
289 " guestfs_close (g);\n"
294 #: ../src/guestfs.pod:112
296 "The code above doesn't include any error checking. In real code you should "
297 "check return values carefully for errors. In general all functions that "
298 "return integers return C<-1> on error, and all functions that return "
299 "pointers return C<NULL> on error. See section L</ERROR HANDLING> below for "
300 "how to handle errors, and consult the documentation for each function call "
301 "below to see precisely how they return error indications. See L<guestfs-"
302 "examples(3)> for fully worked examples."
306 #: ../src/guestfs.pod:121
311 #: ../src/guestfs.pod:123
313 "The image filename (C<\"guest.img\"> in the example above) could be a disk "
314 "image from a virtual machine, a L<dd(1)> copy of a physical hard disk, an "
315 "actual block device, or simply an empty file of zeroes that you have created "
316 "through L<posix_fallocate(3)>. Libguestfs lets you do useful things to all "
321 #: ../src/guestfs.pod:129
323 "The call you should use in modern code for adding drives is L</"
324 "guestfs_add_drive_opts>. To add a disk image, allowing writes, and "
325 "specifying that the format is raw, do:"
329 #: ../src/guestfs.pod:133
332 " guestfs_add_drive_opts (g, filename,\n"
333 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
339 #: ../src/guestfs.pod:137
340 msgid "You can add a disk read-only using:"
344 #: ../src/guestfs.pod:139
347 " guestfs_add_drive_opts (g, filename,\n"
348 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
349 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
355 #: ../src/guestfs.pod:144
357 "or by calling the older function L</guestfs_add_drive_ro>. In either case "
358 "libguestfs won't modify the file."
362 #: ../src/guestfs.pod:147
364 "Be extremely cautious if the disk image is in use, eg. if it is being used "
365 "by a virtual machine. Adding it read-write will almost certainly cause disk "
366 "corruption, but adding it read-only is safe."
370 #: ../src/guestfs.pod:151
372 "You must add at least one disk image, and you may add multiple disk images. "
373 "In the API, the disk images are usually referred to as C</dev/sda> (for the "
374 "first one you added), C</dev/sdb> (for the second one you added), etc."
378 #: ../src/guestfs.pod:156
380 "Once L</guestfs_launch> has been called you cannot add any more images. You "
381 "can call L</guestfs_list_devices> to get a list of the device names, in the "
382 "order that you added them. See also L</BLOCK DEVICE NAMING> below."
386 #: ../src/guestfs.pod:161
391 #: ../src/guestfs.pod:163
393 "Before you can read or write files, create directories and so on in a disk "
394 "image that contains filesystems, you have to mount those filesystems using "
395 "L</guestfs_mount_options> or L</guestfs_mount_ro>. If you already know that "
396 "a disk image contains (for example) one partition with a filesystem on that "
397 "partition, then you can mount it directly:"
401 #: ../src/guestfs.pod:170
404 " guestfs_mount_options (g, \"\", \"/dev/sda1\", \"/\");\n"
409 #: ../src/guestfs.pod:172
411 "where C</dev/sda1> means literally the first partition (C<1>) of the first "
412 "disk image that we added (C</dev/sda>). If the disk contains Linux LVM2 "
413 "logical volumes you could refer to those instead (eg. C</dev/VG/LV>). Note "
414 "that these are libguestfs virtual devices, and are nothing to do with host "
419 #: ../src/guestfs.pod:178
421 "If you are given a disk image and you don't know what it contains then you "
422 "have to find out. Libguestfs can do that too: use L</"
423 "guestfs_list_partitions> and L</guestfs_lvs> to list possible partitions and "
424 "LVs, and either try mounting each to see what is mountable, or else examine "
425 "them with L</guestfs_vfs_type> or L</guestfs_file>. To list just "
426 "filesystems, use L</guestfs_list_filesystems>."
430 #: ../src/guestfs.pod:186
432 "Libguestfs also has a set of APIs for inspection of unknown disk images (see "
433 "L</INSPECTION> below). But you might find it easier to look at higher level "
434 "programs built on top of libguestfs, in particular L<virt-inspector(1)>."
438 #: ../src/guestfs.pod:191
440 "To mount a filesystem read-only, use L</guestfs_mount_ro>. There are "
441 "several other variations of the C<guestfs_mount_*> call."
445 #: ../src/guestfs.pod:194
446 msgid "FILESYSTEM ACCESS AND MODIFICATION"
450 #: ../src/guestfs.pod:196
452 "The majority of the libguestfs API consists of fairly low-level calls for "
453 "accessing and modifying the files, directories, symlinks etc on mounted "
454 "filesystems. There are over a hundred such calls which you can find listed "
455 "in detail below in this man page, and we don't even pretend to cover them "
456 "all in this overview."
460 #: ../src/guestfs.pod:202
462 "Specify filenames as full paths, starting with C<\"/\"> and including the "
467 #: ../src/guestfs.pod:205
469 "For example, if you mounted a filesystem at C<\"/\"> and you want to read "
470 "the file called C<\"etc/passwd\"> then you could do:"
474 #: ../src/guestfs.pod:208
477 " char *data = guestfs_cat (g, \"/etc/passwd\");\n"
482 #: ../src/guestfs.pod:210
484 "This would return C<data> as a newly allocated buffer containing the full "
485 "content of that file (with some conditions: see also L</DOWNLOADING> below), "
486 "or C<NULL> if there was an error."
490 #: ../src/guestfs.pod:214
492 "As another example, to create a top-level directory on that filesystem "
493 "called C<\"var\"> you would do:"
497 #: ../src/guestfs.pod:217
500 " guestfs_mkdir (g, \"/var\");\n"
505 #: ../src/guestfs.pod:219
506 msgid "To create a symlink you could do:"
510 #: ../src/guestfs.pod:221
513 " guestfs_ln_s (g, \"/etc/init.d/portmap\",\n"
514 " \"/etc/rc3.d/S30portmap\");\n"
519 #: ../src/guestfs.pod:224
521 "Libguestfs will reject attempts to use relative paths and there is no "
522 "concept of a current working directory."
526 #: ../src/guestfs.pod:227
528 "Libguestfs can return errors in many situations: for example if the "
529 "filesystem isn't writable, or if a file or directory that you requested "
530 "doesn't exist. If you are using the C API (documented here) you have to "
531 "check for those error conditions after each call. (Other language bindings "
532 "turn these errors into exceptions)."
536 #: ../src/guestfs.pod:233
538 "File writes are affected by the per-handle umask, set by calling L</"
539 "guestfs_umask> and defaulting to 022. See L</UMASK>."
543 #: ../src/guestfs.pod:236
545 msgstr "ПОДІЛ НА РОЗДІЛИ"
548 #: ../src/guestfs.pod:238
550 "Libguestfs contains API calls to read, create and modify partition tables on "
555 #: ../src/guestfs.pod:241
557 "In the common case where you want to create a single partition covering the "
558 "whole disk, you should use the L</guestfs_part_disk> call:"
562 #: ../src/guestfs.pod:245
565 " const char *parttype = \"mbr\";\n"
566 " if (disk_is_larger_than_2TB)\n"
567 " parttype = \"gpt\";\n"
568 " guestfs_part_disk (g, \"/dev/sda\", parttype);\n"
573 #: ../src/guestfs.pod:250
575 "Obviously this effectively wipes anything that was on that disk image before."
579 #: ../src/guestfs.pod:253
584 #: ../src/guestfs.pod:255
586 "Libguestfs provides access to a large part of the LVM2 API, such as L</"
587 "guestfs_lvcreate> and L</guestfs_vgremove>. It won't make much sense unless "
588 "you familiarize yourself with the concepts of physical volumes, volume "
589 "groups and logical volumes."
593 #: ../src/guestfs.pod:260
595 "This author strongly recommends reading the LVM HOWTO, online at L<http://"
596 "tldp.org/HOWTO/LVM-HOWTO/>."
600 #: ../src/guestfs.pod:263
605 #: ../src/guestfs.pod:265
607 "Use L</guestfs_cat> to download small, text only files. This call is "
608 "limited to files which are less than 2 MB and which cannot contain any ASCII "
609 "NUL (C<\\0>) characters. However the API is very simple to use."
613 #: ../src/guestfs.pod:269
615 "L</guestfs_read_file> can be used to read files which contain arbitrary 8 "
616 "bit data, since it returns a (pointer, size) pair. However it is still "
617 "limited to \"small\" files, less than 2 MB."
621 #: ../src/guestfs.pod:273
623 "L</guestfs_download> can be used to download any file, with no limits on "
624 "content or size (even files larger than 4 GB)."
628 #: ../src/guestfs.pod:276
630 "To download multiple files, see L</guestfs_tar_out> and L</guestfs_tgz_out>."
634 #: ../src/guestfs.pod:279
636 msgstr "ВИВАНТАЖЕННЯ"
639 #: ../src/guestfs.pod:281
641 "It's often the case that you want to write a file or files to the disk image."
645 #: ../src/guestfs.pod:284
647 "To write a small file with fixed content, use L</guestfs_write>. To create "
648 "a file of all zeroes, use L</guestfs_truncate_size> (sparse) or L</"
649 "guestfs_fallocate64> (with all disk blocks allocated). There are a variety "
650 "of other functions for creating test files, for example L</guestfs_fill> and "
651 "L</guestfs_fill_pattern>."
655 #: ../src/guestfs.pod:290
657 "To upload a single file, use L</guestfs_upload>. This call has no limits on "
658 "file content or size (even files larger than 4 GB)."
662 #: ../src/guestfs.pod:293
664 "To upload multiple files, see L</guestfs_tar_in> and L</guestfs_tgz_in>."
668 #: ../src/guestfs.pod:295
670 "However the fastest way to upload I<large numbers of arbitrary files> is to "
671 "turn them into a squashfs or CD ISO (see L<mksquashfs(8)> and L<mkisofs(8)"
672 ">), then attach this using L</guestfs_add_drive_ro>. If you add the drive "
673 "in a predictable way (eg. adding it last after all other drives) then you "
674 "can get the device name from L</guestfs_list_devices> and mount it directly "
675 "using L</guestfs_mount_ro>. Note that squashfs images are sometimes non-"
676 "portable between kernel versions, and they don't support labels or UUIDs. "
677 "If you want to pre-build an image or you need to mount it using a label or "
678 "UUID, use an ISO image instead."
682 #: ../src/guestfs.pod:306
687 #: ../src/guestfs.pod:308
689 "There are various different commands for copying between files and devices "
690 "and in and out of the guest filesystem. These are summarised in the table "
695 #: ../src/guestfs.pod:314
696 msgid "B<file> to B<file>"
700 #: ../src/guestfs.pod:316
702 "Use L</guestfs_cp> to copy a single file, or L</guestfs_cp_a> to copy "
703 "directories recursively."
707 #: ../src/guestfs.pod:319
708 msgid "B<file or device> to B<file or device>"
712 #: ../src/guestfs.pod:321
714 "Use L</guestfs_dd> which efficiently uses L<dd(1)> to copy between files and "
715 "devices in the guest."
719 #: ../src/guestfs.pod:324
720 msgid "Example: duplicate the contents of an LV:"
724 #: ../src/guestfs.pod:326
727 " guestfs_dd (g, \"/dev/VG/Original\", \"/dev/VG/Copy\");\n"
732 #: ../src/guestfs.pod:328
734 "The destination (C</dev/VG/Copy>) must be at least as large as the source "
735 "(C</dev/VG/Original>). To copy less than the whole source device, use L</"
736 "guestfs_copy_size>."
740 #: ../src/guestfs.pod:332
741 msgid "B<file on the host> to B<file or device>"
745 #: ../src/guestfs.pod:334
746 msgid "Use L</guestfs_upload>. See L</UPLOADING> above."
750 #: ../src/guestfs.pod:336
751 msgid "B<file or device> to B<file on the host>"
755 #: ../src/guestfs.pod:338
756 msgid "Use L</guestfs_download>. See L</DOWNLOADING> above."
760 #: ../src/guestfs.pod:342
761 msgid "UPLOADING AND DOWNLOADING TO PIPES AND FILE DESCRIPTORS"
765 #: ../src/guestfs.pod:344
767 "Calls like L</guestfs_upload>, L</guestfs_download>, L</guestfs_tar_in>, L</"
768 "guestfs_tar_out> etc appear to only take filenames as arguments, so it "
769 "appears you can only upload and download to files. However many Un*x-like "
770 "hosts let you use the special device files C</dev/stdin>, C</dev/stdout>, C</"
771 "dev/stderr> and C</dev/fd/N> to read and write from stdin, stdout, stderr, "
772 "and arbitrary file descriptor N."
776 #: ../src/guestfs.pod:352
777 msgid "For example, L<virt-cat(1)> writes its output to stdout by doing:"
781 #: ../src/guestfs.pod:355
784 " guestfs_download (g, filename, \"/dev/stdout\");\n"
789 #: ../src/guestfs.pod:357
790 msgid "and you can write tar output to a file descriptor C<fd> by doing:"
794 #: ../src/guestfs.pod:359
798 " snprintf (devfd, sizeof devfd, \"/dev/fd/%d\", fd);\n"
799 " guestfs_tar_out (g, \"/\", devfd);\n"
804 #: ../src/guestfs.pod:363
805 msgid "LISTING FILES"
809 #: ../src/guestfs.pod:365
811 "L</guestfs_ll> is just designed for humans to read (mainly when using the "
812 "L<guestfish(1)>-equivalent command C<ll>)."
816 #: ../src/guestfs.pod:368
818 "L</guestfs_ls> is a quick way to get a list of files in a directory from "
819 "programs, as a flat list of strings."
823 #: ../src/guestfs.pod:371
825 "L</guestfs_readdir> is a programmatic way to get a list of files in a "
826 "directory, plus additional information about each one. It is more "
827 "equivalent to using the L<readdir(3)> call on a local filesystem."
831 #: ../src/guestfs.pod:375
833 "L</guestfs_find> and L</guestfs_find0> can be used to recursively list files."
837 #: ../src/guestfs.pod:378
838 msgid "RUNNING COMMANDS"
842 #: ../src/guestfs.pod:380
844 "Although libguestfs is primarily an API for manipulating files inside guest "
845 "images, we also provide some limited facilities for running commands inside "
850 #: ../src/guestfs.pod:384
851 msgid "There are many limitations to this:"
855 #: ../src/guestfs.pod:388 ../src/guestfs.pod:393 ../src/guestfs.pod:398
856 #: ../src/guestfs.pod:402 ../src/guestfs.pod:407 ../src/guestfs.pod:411
857 #: ../src/guestfs.pod:416 ../src/guestfs.pod:421 ../src/guestfs.pod:1064
858 #: ../src/guestfs.pod:1068 ../src/guestfs.pod:1072 ../src/guestfs.pod:1077
859 #: ../src/guestfs.pod:1085 ../src/guestfs.pod:1104 ../src/guestfs.pod:1112
860 #: ../src/guestfs.pod:1134 ../src/guestfs.pod:1138 ../src/guestfs.pod:1142
861 #: ../src/guestfs.pod:1146 ../src/guestfs.pod:1150 ../src/guestfs.pod:1154
862 #: ../src/guestfs.pod:1643 ../src/guestfs.pod:1648 ../src/guestfs.pod:1652
863 #: ../src/guestfs.pod:1754 ../src/guestfs.pod:1759 ../src/guestfs.pod:1763
864 #: ../src/guestfs.pod:1773 ../src/guestfs.pod:2008 ../src/guestfs.pod:2013
865 #: ../src/guestfs.pod:2019 ../src/guestfs.pod:2027 ../src/guestfs.pod:2381
866 #: ../src/guestfs.pod:2387 ../src/guestfs.pod:2392 ../src/guestfs.pod:2398
867 #: ../src/guestfs.pod:2972 ../src/guestfs.pod:2976 ../src/guestfs.pod:2980
868 #: ../src/guestfs.pod:2984 ../src/guestfs-actions.pod:15
869 #: ../src/guestfs-actions.pod:22 ../src/guestfs-actions.pod:583
870 #: ../src/guestfs-actions.pod:591 ../src/guestfs-actions.pod:598
871 #: ../src/guestfs-actions.pod:605 ../src/guestfs-actions.pod:1603
872 #: ../src/guestfs-actions.pod:1607 ../src/guestfs-actions.pod:1611
873 #: ../src/guestfs-actions.pod:1615 ../src/guestfs-actions.pod:1623
874 #: ../src/guestfs-actions.pod:1627 ../src/guestfs-actions.pod:1631
875 #: ../src/guestfs-actions.pod:1641 ../src/guestfs-actions.pod:1645
876 #: ../src/guestfs-actions.pod:1649 ../src/guestfs-actions.pod:1787
877 #: ../src/guestfs-actions.pod:1791 ../src/guestfs-actions.pod:1796
878 #: ../src/guestfs-actions.pod:1801 ../src/guestfs-actions.pod:1862
879 #: ../src/guestfs-actions.pod:1866 ../src/guestfs-actions.pod:1871
880 #: ../src/guestfs-actions.pod:2789 ../src/guestfs-actions.pod:2795
881 #: ../src/guestfs-actions.pod:2803 ../src/guestfs-actions.pod:2810
882 #: ../src/guestfs-actions.pod:2817 ../fish/guestfish.pod:445
883 #: ../fish/guestfish.pod:449 ../fish/guestfish.pod:453
884 #: ../fish/guestfish.pod:457 ../fish/guestfish-actions.pod:13
885 #: ../fish/guestfish-actions.pod:20 ../fish/guestfish-actions.pod:385
886 #: ../fish/guestfish-actions.pod:393 ../fish/guestfish-actions.pod:400
887 #: ../fish/guestfish-actions.pod:407 ../fish/guestfish-actions.pod:1074
888 #: ../fish/guestfish-actions.pod:1078 ../fish/guestfish-actions.pod:1082
889 #: ../fish/guestfish-actions.pod:1086 ../fish/guestfish-actions.pod:1094
890 #: ../fish/guestfish-actions.pod:1098 ../fish/guestfish-actions.pod:1102
891 #: ../fish/guestfish-actions.pod:1112 ../fish/guestfish-actions.pod:1116
892 #: ../fish/guestfish-actions.pod:1120 ../fish/guestfish-actions.pod:1210
893 #: ../fish/guestfish-actions.pod:1214 ../fish/guestfish-actions.pod:1219
894 #: ../fish/guestfish-actions.pod:1224 ../fish/guestfish-actions.pod:1266
895 #: ../fish/guestfish-actions.pod:1270 ../fish/guestfish-actions.pod:1275
896 #: ../fish/guestfish-actions.pod:1902 ../fish/guestfish-actions.pod:1908
897 #: ../fish/guestfish-actions.pod:1916 ../fish/guestfish-actions.pod:1923
898 #: ../fish/guestfish-actions.pod:1930 ../tools/virt-win-reg.pl:195
899 #: ../tools/virt-win-reg.pl:200 ../tools/virt-win-reg.pl:206
900 #: ../tools/virt-win-reg.pl:708 ../tools/virt-win-reg.pl:714
901 #: ../tools/virt-win-reg.pl:720
906 #: ../src/guestfs.pod:390
908 "The kernel version that the command runs under will be different from what "
913 #: ../src/guestfs.pod:395
915 "If the command needs to communicate with daemons, then most likely they "
920 #: ../src/guestfs.pod:400
921 msgid "The command will be running in limited memory."
925 #: ../src/guestfs.pod:404
927 "The network may not be available unless you enable it (see L</"
928 "guestfs_set_network>)."
932 #: ../src/guestfs.pod:409
933 msgid "Only supports Linux guests (not Windows, BSD, etc)."
937 #: ../src/guestfs.pod:413
939 "Architecture limitations (eg. won't work for a PPC guest on an X86 host)."
943 #: ../src/guestfs.pod:418
945 "For SELinux guests, you may need to enable SELinux and load policy first. "
946 "See L</SELINUX> in this manpage."
950 #: ../src/guestfs.pod:423
952 "I<Security:> It is not safe to run commands from untrusted, possibly "
953 "malicious guests. These commands may attempt to exploit your program by "
954 "sending unexpected output. They could also try to exploit the Linux kernel "
955 "or qemu provided by the libguestfs appliance. They could use the network "
956 "provided by the libguestfs appliance to bypass ordinary network partitions "
957 "and firewalls. They could use the elevated privileges or different SELinux "
958 "context of your program to their advantage."
962 #: ../src/guestfs.pod:432
964 "A secure alternative is to use libguestfs to install a \"firstboot\" script "
965 "(a script which runs when the guest next boots normally), and to have this "
966 "script run the commands you want in the normal context of the running guest, "
967 "network security and so on. For information about other security issues, "
972 #: ../src/guestfs.pod:440
974 "The two main API calls to run commands are L</guestfs_command> and L</"
975 "guestfs_sh> (there are also variations)."
979 #: ../src/guestfs.pod:443
981 "The difference is that L</guestfs_sh> runs commands using the shell, so any "
982 "shell globs, redirections, etc will work."
986 #: ../src/guestfs.pod:446
987 msgid "CONFIGURATION FILES"
988 msgstr "ФАЙЛИ НАЛАШТУВАННЯ"
991 #: ../src/guestfs.pod:448
993 "To read and write configuration files in Linux guest filesystems, we "
994 "strongly recommend using Augeas. For example, Augeas understands how to "
995 "read and write, say, a Linux shadow password file or X.org configuration "
996 "file, and so avoids you having to write that code."
1000 #: ../src/guestfs.pod:453
1002 "The main Augeas calls are bound through the C<guestfs_aug_*> APIs. We don't "
1003 "document Augeas itself here because there is excellent documentation on the "
1004 "L<http://augeas.net/> website."
1008 #: ../src/guestfs.pod:457
1010 "If you don't want to use Augeas (you fool!) then try calling L</"
1011 "guestfs_read_lines> to get the file as a list of lines which you can iterate "
1016 #: ../src/guestfs.pod:461
1021 #: ../src/guestfs.pod:463
1023 "We support SELinux guests. To ensure that labeling happens correctly in "
1024 "SELinux guests, you need to enable SELinux and load the guest's policy:"
1028 #: ../src/guestfs.pod:469 ../src/guestfs.pod:1257 ../src/guestfs.pod:1395
1029 #: ../src/guestfs.pod:2426
1034 #: ../src/guestfs.pod:471
1035 msgid "Before launching, do:"
1039 #: ../src/guestfs.pod:473
1042 " guestfs_set_selinux (g, 1);\n"
1047 #: ../src/guestfs.pod:475 ../src/guestfs.pod:1261 ../src/guestfs.pod:1399
1048 #: ../src/guestfs.pod:2451
1053 #: ../src/guestfs.pod:477
1055 "After mounting the guest's filesystem(s), load the policy. This is best "
1056 "done by running the L<load_policy(8)> command in the guest itself:"
1060 #: ../src/guestfs.pod:481
1063 " guestfs_sh (g, \"/usr/sbin/load_policy\");\n"
1068 #: ../src/guestfs.pod:483
1070 "(Older versions of C<load_policy> require you to specify the name of the "
1075 #: ../src/guestfs.pod:486 ../src/guestfs.pod:1405
1080 #: ../src/guestfs.pod:488
1082 "Optionally, set the security context for the API. The correct security "
1083 "context to use can only be known by inspecting the guest. As an example:"
1087 #: ../src/guestfs.pod:492
1090 " guestfs_setcon (g, \"unconfined_u:unconfined_r:unconfined_t:s0\");\n"
1095 #: ../src/guestfs.pod:496
1096 msgid "This will work for running commands and editing existing files."
1100 #: ../src/guestfs.pod:498
1102 "When new files are created, you may need to label them explicitly, for "
1103 "example by running the external command C<restorecon pathname>."
1107 #: ../src/guestfs.pod:502
1112 #: ../src/guestfs.pod:504
1114 "Certain calls are affected by the current file mode creation mask (the "
1115 "\"umask\"). In particular ones which create files or directories, such as "
1116 "L</guestfs_touch>, L</guestfs_mknod> or L</guestfs_mkdir>. This affects "
1117 "either the default mode that the file is created with or modifies the mode "
1122 #: ../src/guestfs.pod:510
1124 "The default umask is C<022>, so files are created with modes such as C<0644> "
1125 "and directories with C<0755>."
1129 #: ../src/guestfs.pod:513
1131 "There are two ways to avoid being affected by umask. Either set umask to 0 "
1132 "(call C<guestfs_umask (g, 0)> early after launching). Or call L</"
1133 "guestfs_chmod> after creating each file or directory."
1137 #: ../src/guestfs.pod:517
1138 msgid "For more information about umask, see L<umask(2)>."
1142 #: ../src/guestfs.pod:519 ../fish/guestfish.pod:767
1143 msgid "ENCRYPTED DISKS"
1147 #: ../src/guestfs.pod:521
1149 "Libguestfs allows you to access Linux guests which have been encrypted using "
1150 "whole disk encryption that conforms to the Linux Unified Key Setup (LUKS) "
1151 "standard. This includes nearly all whole disk encryption systems used by "
1152 "modern Linux guests."
1156 #: ../src/guestfs.pod:527
1158 "Use L</guestfs_vfs_type> to identify LUKS-encrypted block devices (it "
1159 "returns the string C<crypto_LUKS>)."
1163 #: ../src/guestfs.pod:530
1165 "Then open these devices by calling L</guestfs_luks_open>. Obviously you "
1166 "will require the passphrase!"
1170 #: ../src/guestfs.pod:533
1172 "Opening a LUKS device creates a new device mapper device called C</dev/"
1173 "mapper/mapname> (where C<mapname> is the string you supply to L</"
1174 "guestfs_luks_open>). Reads and writes to this mapper device are decrypted "
1175 "from and encrypted to the underlying block device respectively."
1179 #: ../src/guestfs.pod:539
1181 "LVM volume groups on the device can be made visible by calling L</"
1182 "guestfs_vgscan> followed by L</guestfs_vg_activate_all>. The logical volume"
1183 "(s) can now be mounted in the usual way."
1187 #: ../src/guestfs.pod:543
1189 "Use the reverse process to close a LUKS device. Unmount any logical volumes "
1190 "on it, deactivate the volume groups by caling C<guestfs_vg_activate (g, 0, "
1191 "[\"/dev/VG\"])>. Then close the mapper device by calling L</"
1192 "guestfs_luks_close> on the C</dev/mapper/mapname> device (I<not> the "
1193 "underlying encrypted block device)."
1197 #: ../src/guestfs.pod:550
1202 #: ../src/guestfs.pod:552
1204 "Libguestfs has APIs for inspecting an unknown disk image to find out if it "
1205 "contains operating systems, an install CD or a live CD. (These APIs used to "
1206 "be in a separate Perl-only library called L<Sys::Guestfs::Lib(3)> but since "
1207 "version 1.5.3 the most frequently used part of this library has been "
1208 "rewritten in C and moved into the core code)."
1212 #: ../src/guestfs.pod:559
1214 "Add all disks belonging to the unknown virtual machine and call L</"
1215 "guestfs_launch> in the usual way."
1219 #: ../src/guestfs.pod:562
1221 "Then call L</guestfs_inspect_os>. This function uses other libguestfs calls "
1222 "and certain heuristics, and returns a list of operating systems that were "
1223 "found. An empty list means none were found. A single element is the root "
1224 "filesystem of the operating system. For dual- or multi-boot guests, "
1225 "multiple roots can be returned, each one corresponding to a separate "
1226 "operating system. (Multi-boot virtual machines are extremely rare in the "
1227 "world of virtualization, but since this scenario can happen, we have built "
1228 "libguestfs to deal with it.)"
1232 #: ../src/guestfs.pod:571
1234 "For each root, you can then call various C<guestfs_inspect_get_*> functions "
1235 "to get additional details about that operating system. For example, call L</"
1236 "guestfs_inspect_get_type> to return the string C<windows> or C<linux> for "
1237 "Windows and Linux-based operating systems respectively."
1241 #: ../src/guestfs.pod:577
1243 "Un*x-like and Linux-based operating systems usually consist of several "
1244 "filesystems which are mounted at boot time (for example, a separate boot "
1245 "partition mounted on C</boot>). The inspection rules are able to detect how "
1246 "filesystems correspond to mount points. Call "
1247 "C<guestfs_inspect_get_mountpoints> to get this mapping. It might return a "
1248 "hash table like this example:"
1252 #: ../src/guestfs.pod:584
1255 " /boot => /dev/sda1\n"
1256 " / => /dev/vg_guest/lv_root\n"
1257 " /usr => /dev/vg_guest/lv_usr\n"
1262 #: ../src/guestfs.pod:588
1264 "The caller can then make calls to L</guestfs_mount_options> to mount the "
1265 "filesystems as suggested."
1269 #: ../src/guestfs.pod:591
1271 "Be careful to mount filesystems in the right order (eg. C</> before C</"
1272 "usr>). Sorting the keys of the hash by length, shortest first, should work."
1276 #: ../src/guestfs.pod:595
1278 "Inspection currently only works for some common operating systems. "
1279 "Contributors are welcome to send patches for other operating systems that we "
1280 "currently cannot detect."
1284 #: ../src/guestfs.pod:599
1286 "Encrypted disks must be opened before inspection. See L</ENCRYPTED DISKS> "
1287 "for more details. The L</guestfs_inspect_os> function just ignores any "
1288 "encrypted devices."
1292 #: ../src/guestfs.pod:603
1294 "A note on the implementation: The call L</guestfs_inspect_os> performs "
1295 "inspection and caches the results in the guest handle. Subsequent calls to "
1296 "C<guestfs_inspect_get_*> return this cached information, but I<do not> re-"
1297 "read the disks. If you change the content of the guest disks, you can redo "
1298 "inspection by calling L</guestfs_inspect_os> again. (L</"
1299 "guestfs_inspect_list_applications> works a little differently from the other "
1300 "calls and does read the disks. See documentation for that function for "
1305 #: ../src/guestfs.pod:612
1306 msgid "INSPECTING INSTALL DISKS"
1310 #: ../src/guestfs.pod:614
1312 "Libguestfs (since 1.9.4) can detect some install disks, install CDs, live "
1317 #: ../src/guestfs.pod:617
1319 "Call L</guestfs_inspect_get_format> to return the format of the operating "
1320 "system, which currently can be C<installed> (a regular operating system) or "
1321 "C<installer> (some sort of install disk)."
1325 #: ../src/guestfs.pod:621
1327 "Further information is available about the operating system that can be "
1328 "installed using the regular inspection APIs like L</"
1329 "guestfs_inspect_get_product_name>, L</guestfs_inspect_get_major_version> etc."
1333 #: ../src/guestfs.pod:626
1335 "Some additional information specific to installer disks is also available "
1336 "from the L</guestfs_inspect_is_live>, L</guestfs_inspect_is_netinst> and L</"
1337 "guestfs_inspect_is_multipart> calls."
1341 #: ../src/guestfs.pod:631
1342 msgid "SPECIAL CONSIDERATIONS FOR WINDOWS GUESTS"
1346 #: ../src/guestfs.pod:633
1348 "Libguestfs can mount NTFS partitions. It does this using the L<http://www."
1349 "ntfs-3g.org/> driver."
1353 #: ../src/guestfs.pod:636
1354 msgid "DRIVE LETTERS AND PATHS"
1358 #: ../src/guestfs.pod:638
1360 "DOS and Windows still use drive letters, and the filesystems are always "
1361 "treated as case insensitive by Windows itself, and therefore you might find "
1362 "a Windows configuration file referring to a path like C<c:\\windows"
1363 "\\system32>. When the filesystem is mounted in libguestfs, that directory "
1364 "might be referred to as C</WINDOWS/System32>."
1368 #: ../src/guestfs.pod:644
1370 "Drive letter mappings can be found using inspection (see L</INSPECTION> and "
1371 "L</guestfs_inspect_get_drive_mappings>)"
1375 #: ../src/guestfs.pod:647
1377 "Dealing with separator characters (backslash vs forward slash) is outside "
1378 "the scope of libguestfs, but usually a simple character replacement will "
1383 #: ../src/guestfs.pod:651
1385 "To resolve the case insensitivity of paths, call L</"
1386 "guestfs_case_sensitive_path>."
1390 #: ../src/guestfs.pod:654
1391 msgid "ACCESSING THE WINDOWS REGISTRY"
1395 #: ../src/guestfs.pod:656
1397 "Libguestfs also provides some help for decoding Windows Registry \"hive\" "
1398 "files, through the library C<hivex> which is part of the libguestfs project "
1399 "although ships as a separate tarball. You have to locate and download the "
1400 "hive file(s) yourself, and then pass them to C<hivex> functions. See also "
1401 "the programs L<hivexml(1)>, L<hivexsh(1)>, L<hivexregedit(1)> and L<virt-win-"
1402 "reg(1)> for more help on this issue."
1406 #: ../src/guestfs.pod:664
1407 msgid "SYMLINKS ON NTFS-3G FILESYSTEMS"
1411 #: ../src/guestfs.pod:666
1413 "Ntfs-3g tries to rewrite \"Junction Points\" and NTFS \"symbolic links\" to "
1414 "provide something which looks like a Linux symlink. The way it tries to do "
1415 "the rewriting is described here:"
1419 #: ../src/guestfs.pod:670
1421 "L<http://www.tuxera.com/community/ntfs-3g-advanced/junction-points-and-"
1424 "L<http://www.tuxera.com/community/ntfs-3g-advanced/junction-points-and-"
1428 #: ../src/guestfs.pod:672
1430 "The essential problem is that ntfs-3g simply does not have enough "
1431 "information to do a correct job. NTFS links can contain drive letters and "
1432 "references to external device GUIDs that ntfs-3g has no way of resolving. "
1433 "It is almost certainly the case that libguestfs callers should ignore what "
1434 "ntfs-3g does (ie. don't use L</guestfs_readlink> on NTFS volumes)."
1438 #: ../src/guestfs.pod:679
1440 "Instead if you encounter a symbolic link on an ntfs-3g filesystem, use L</"
1441 "guestfs_lgetxattr> to read the C<system.ntfs_reparse_data> extended "
1442 "attribute, and read the raw reparse data from that (you can find the format "
1443 "documented in various places around the web)."
1447 #: ../src/guestfs.pod:684
1448 msgid "EXTENDED ATTRIBUTES ON NTFS-3G FILESYSTEMS"
1452 #: ../src/guestfs.pod:686
1454 "There are other useful extended attributes that can be read from ntfs-3g "
1455 "filesystems (using L</guestfs_getxattr>). See:"
1459 #: ../src/guestfs.pod:689
1461 "L<http://www.tuxera.com/community/ntfs-3g-advanced/extended-attributes/>"
1463 "L<http://www.tuxera.com/community/ntfs-3g-advanced/extended-attributes/>"
1466 #: ../src/guestfs.pod:691
1467 msgid "USING LIBGUESTFS WITH OTHER PROGRAMMING LANGUAGES"
1471 #: ../src/guestfs.pod:693
1473 "Although we don't want to discourage you from using the C API, we will "
1474 "mention here that the same API is also available in other languages."
1478 #: ../src/guestfs.pod:696
1480 "The API is broadly identical in all supported languages. This means that "
1481 "the C call C<guestfs_add_drive_ro(g,file)> is C<$g-E<gt>add_drive_ro($file)> "
1482 "in Perl, C<g.add_drive_ro(file)> in Python, and C<g#add_drive_ro file> in "
1483 "OCaml. In other words, a straightforward, predictable isomorphism between "
1488 #: ../src/guestfs.pod:702
1490 "Error messages are automatically transformed into exceptions if the language "
1495 #: ../src/guestfs.pod:705
1497 "We don't try to \"object orientify\" parts of the API in OO languages, "
1498 "although contributors are welcome to write higher level APIs above what we "
1499 "provide in their favourite languages if they wish."
1503 #: ../src/guestfs.pod:711
1508 #: ../src/guestfs.pod:713
1510 "You can use the I<guestfs.h> header file from C++ programs. The C++ API is "
1511 "identical to the C API. C++ classes and exceptions are not used."
1515 #: ../src/guestfs.pod:717
1520 #: ../src/guestfs.pod:719
1522 "The C# bindings are highly experimental. Please read the warnings at the "
1523 "top of C<csharp/Libguestfs.cs>."
1527 #: ../src/guestfs.pod:722
1532 #: ../src/guestfs.pod:724
1534 "This is the only language binding that is working but incomplete. Only "
1535 "calls which return simple integers have been bound in Haskell, and we are "
1536 "looking for help to complete this binding."
1540 #: ../src/guestfs.pod:728
1545 #: ../src/guestfs.pod:730
1547 "Full documentation is contained in the Javadoc which is distributed with "
1552 #: ../src/guestfs.pod:733
1557 #: ../src/guestfs.pod:735
1558 msgid "See L<guestfs-ocaml(3)>."
1559 msgstr "Див. L<guestfs-ocaml(3)>."
1562 #: ../src/guestfs.pod:737
1567 #: ../src/guestfs.pod:739
1568 msgid "See L<guestfs-perl(3)> and L<Sys::Guestfs(3)>."
1569 msgstr "Див. L<guestfs-perl(3)> та L<Sys::Guestfs(3)>."
1572 #: ../src/guestfs.pod:741
1577 #: ../src/guestfs.pod:743
1579 "For documentation see C<README-PHP> supplied with libguestfs sources or in "
1580 "the php-libguestfs package for your distribution."
1584 #: ../src/guestfs.pod:746
1585 msgid "The PHP binding only works correctly on 64 bit machines."
1589 #: ../src/guestfs.pod:748
1594 #: ../src/guestfs.pod:750
1595 msgid "See L<guestfs-python(3)>."
1596 msgstr "Див. L<guestfs-python(3)>."
1599 #: ../src/guestfs.pod:752
1604 #: ../src/guestfs.pod:754
1605 msgid "See L<guestfs-ruby(3)>."
1606 msgstr "Див. L<guestfs-ruby(3)>."
1609 #: ../src/guestfs.pod:756
1610 msgid "B<shell scripts>"
1611 msgstr "B<скрипти оболонки>"
1614 #: ../src/guestfs.pod:758
1615 msgid "See L<guestfish(1)>."
1616 msgstr "Див. L<guestfish(1)>."
1619 #: ../src/guestfs.pod:762
1620 msgid "LIBGUESTFS GOTCHAS"
1624 #: ../src/guestfs.pod:764
1626 "L<http://en.wikipedia.org/wiki/Gotcha_(programming)>: \"A feature of a "
1627 "system [...] that works in the way it is documented but is counterintuitive "
1628 "and almost invites mistakes.\""
1632 #: ../src/guestfs.pod:768
1634 "Since we developed libguestfs and the associated tools, there are several "
1635 "things we would have designed differently, but are now stuck with for "
1636 "backwards compatibility or other reasons. If there is ever a libguestfs 2.0 "
1637 "release, you can expect these to change. Beware of them."
1641 #: ../src/guestfs.pod:776
1642 msgid "Autosync / forgetting to sync."
1646 #: ../src/guestfs.pod:778
1648 "I<Update:> Autosync is enabled by default for all API users starting from "
1649 "libguestfs 1.5.24. This section only applies to older versions."
1653 #: ../src/guestfs.pod:781
1655 "When modifying a filesystem from C or another language, you B<must> unmount "
1656 "all filesystems and call L</guestfs_sync> explicitly before you close the "
1657 "libguestfs handle. You can also call:"
1661 #: ../src/guestfs.pod:785
1664 " guestfs_set_autosync (g, 1);\n"
1669 #: ../src/guestfs.pod:787
1671 "to have the unmount/sync done automatically for you when the handle 'g' is "
1672 "closed. (This feature is called \"autosync\", L</guestfs_set_autosync> q.v.)"
1676 #: ../src/guestfs.pod:791
1678 "If you forget to do this, then it is entirely possible that your changes "
1679 "won't be written out, or will be partially written, or (very rarely) that "
1680 "you'll get disk corruption."
1684 #: ../src/guestfs.pod:795
1686 "Note that in L<guestfish(3)> autosync is the default. So quick and dirty "
1687 "guestfish scripts that forget to sync will work just fine, which can make "
1688 "this very puzzling if you are trying to debug a problem."
1692 #: ../src/guestfs.pod:799
1693 msgid "Mount option C<-o sync> should not be the default."
1697 #: ../src/guestfs.pod:801
1699 "If you use L</guestfs_mount>, then C<-o sync,noatime> are added implicitly. "
1700 "However C<-o sync> does not add any reliability benefit, but does have a "
1701 "very large performance impact."
1705 #: ../src/guestfs.pod:805
1707 "The work around is to use L</guestfs_mount_options> and set the mount "
1708 "options that you actually want to use."
1712 #: ../src/guestfs.pod:808
1713 msgid "Read-only should be the default."
1717 #: ../src/guestfs.pod:810
1719 "In L<guestfish(3)>, I<--ro> should be the default, and you should have to "
1720 "specify I<--rw> if you want to make changes to the image."
1724 #: ../src/guestfs.pod:813
1725 msgid "This would reduce the potential to corrupt live VM images."
1729 #: ../src/guestfs.pod:815
1731 "Note that many filesystems change the disk when you just mount and unmount, "
1732 "even if you didn't perform any writes. You need to use L</"
1733 "guestfs_add_drive_ro> to guarantee that the disk is not changed."
1737 #: ../src/guestfs.pod:819
1738 msgid "guestfish command line is hard to use."
1742 #: ../src/guestfs.pod:821
1744 "C<guestfish disk.img> doesn't do what people expect (open C<disk.img> for "
1745 "examination). It tries to run a guestfish command C<disk.img> which doesn't "
1746 "exist, so it fails. In earlier versions of guestfish the error message was "
1747 "also unintuitive, but we have corrected this since. Like the Bourne shell, "
1748 "we should have used C<guestfish -c command> to run commands."
1752 #: ../src/guestfs.pod:828
1753 msgid "guestfish megabyte modifiers don't work right on all commands"
1757 #: ../src/guestfs.pod:830
1759 "In recent guestfish you can use C<1M> to mean 1 megabyte (and similarly for "
1760 "other modifiers). What guestfish actually does is to multiply the number "
1761 "part by the modifier part and pass the result to the C API. However this "
1762 "doesn't work for a few APIs which aren't expecting bytes, but are already "
1763 "expecting some other unit (eg. megabytes)."
1767 #: ../src/guestfs.pod:837
1768 msgid "The most common is L</guestfs_lvcreate>. The guestfish command:"
1772 #: ../src/guestfs.pod:839
1775 " lvcreate LV VG 100M\n"
1780 #: ../src/guestfs.pod:841
1782 "does not do what you might expect. Instead because L</guestfs_lvcreate> is "
1783 "already expecting megabytes, this tries to create a 100 I<terabyte> (100 "
1784 "megabytes * megabytes) logical volume. The error message you get from this "
1785 "is also a little obscure."
1789 #: ../src/guestfs.pod:846
1791 "This could be fixed in the generator by specially marking parameters and "
1792 "return values which take bytes or other units."
1796 #: ../src/guestfs.pod:849
1797 msgid "Ambiguity between devices and paths"
1801 #: ../src/guestfs.pod:851
1803 "There is a subtle ambiguity in the API between a device name (eg. C</dev/"
1804 "sdb2>) and a similar pathname. A file might just happen to be called "
1805 "C<sdb2> in the directory C</dev> (consider some non-Unix VM image)."
1809 #: ../src/guestfs.pod:856
1811 "In the current API we usually resolve this ambiguity by having two separate "
1812 "calls, for example L</guestfs_checksum> and L</guestfs_checksum_device>. "
1813 "Some API calls are ambiguous and (incorrectly) resolve the problem by "
1814 "detecting if the path supplied begins with C</dev/>."
1818 #: ../src/guestfs.pod:862
1820 "To avoid both the ambiguity and the need to duplicate some calls, we could "
1821 "make paths/devices into structured names. One way to do this would be to "
1822 "use a notation like grub (C<hd(0,0)>), although nobody really likes this "
1823 "aspect of grub. Another way would be to use a structured type, equivalent "
1824 "to this OCaml type:"
1828 #: ../src/guestfs.pod:868
1831 " type path = Path of string | Device of int | Partition of int * int\n"
1836 #: ../src/guestfs.pod:870
1837 msgid "which would allow you to pass arguments like:"
1841 #: ../src/guestfs.pod:872
1844 " Path \"/foo/bar\"\n"
1845 " Device 1 (* /dev/sdb, or perhaps /dev/sda *)\n"
1846 " Partition (1, 2) (* /dev/sdb2 (or is it /dev/sda2 or /dev/sdb3?) *)\n"
1847 " Path \"/dev/sdb2\" (* not a device *)\n"
1852 #: ../src/guestfs.pod:877
1854 "As you can see there are still problems to resolve even with this "
1855 "representation. Also consider how it might work in guestfish."
1859 #: ../src/guestfs.pod:882
1860 msgid "KEYS AND PASSPHRASES"
1864 #: ../src/guestfs.pod:884
1866 "Certain libguestfs calls take a parameter that contains sensitive key "
1867 "material, passed in as a C string."
1871 #: ../src/guestfs.pod:887
1873 "In the future we would hope to change the libguestfs implementation so that "
1874 "keys are L<mlock(2)>-ed into physical RAM, and thus can never end up in "
1875 "swap. However this is I<not> done at the moment, because of the complexity "
1876 "of such an implementation."
1880 #: ../src/guestfs.pod:892
1882 "Therefore you should be aware that any key parameter you pass to libguestfs "
1883 "might end up being written out to the swap partition. If this is a concern, "
1884 "scrub the swap partition or don't use libguestfs on encrypted devices."
1888 #: ../src/guestfs.pod:897
1889 msgid "MULTIPLE HANDLES AND MULTIPLE THREADS"
1893 #: ../src/guestfs.pod:899
1895 "All high-level libguestfs actions are synchronous. If you want to use "
1896 "libguestfs asynchronously then you must create a thread."
1900 #: ../src/guestfs.pod:902
1902 "Only use the handle from a single thread. Either use the handle exclusively "
1903 "from one thread, or provide your own mutex so that two threads cannot issue "
1904 "calls on the same handle at the same time."
1908 #: ../src/guestfs.pod:906
1910 "See the graphical program guestfs-browser for one possible architecture for "
1911 "multithreaded programs using libvirt and libguestfs."
1915 #: ../src/guestfs.pod:909
1920 #: ../src/guestfs.pod:911
1922 "Libguestfs needs a supermin appliance, which it finds by looking along an "
1927 #: ../src/guestfs.pod:914
1929 "By default it looks for these in the directory C<$libdir/guestfs> (eg. C</"
1930 "usr/local/lib/guestfs> or C</usr/lib64/guestfs>)."
1934 #: ../src/guestfs.pod:917
1936 "Use L</guestfs_set_path> or set the environment variable L</LIBGUESTFS_PATH> "
1937 "to change the directories that libguestfs will search in. The value is a "
1938 "colon-separated list of paths. The current directory is I<not> searched "
1939 "unless the path contains an empty element or C<.>. For example "
1940 "C<LIBGUESTFS_PATH=:/usr/lib/guestfs> would search the current directory and "
1941 "then C</usr/lib/guestfs>."
1945 #: ../src/guestfs.pod:924
1946 msgid "QEMU WRAPPERS"
1950 #: ../src/guestfs.pod:926
1952 "If you want to compile your own qemu, run qemu from a non-standard location, "
1953 "or pass extra arguments to qemu, then you can write a shell-script wrapper "
1958 #: ../src/guestfs.pod:930
1960 "There is one important rule to remember: you I<must C<exec qemu>> as the "
1961 "last command in the shell script (so that qemu replaces the shell and "
1962 "becomes the direct child of the libguestfs-using program). If you don't do "
1963 "this, then the qemu process won't be cleaned up correctly."
1967 #: ../src/guestfs.pod:935
1969 "Here is an example of a wrapper, where I have built my own copy of qemu from "
1974 #: ../src/guestfs.pod:938
1978 " qemudir=/home/rjones/d/qemu\n"
1979 " exec $qemudir/x86_64-softmmu/qemu-system-x86_64 -L $qemudir/pc-bios \"$@\"\n"
1984 #: ../src/guestfs.pod:942
1986 "Save this script as C</tmp/qemu.wrapper> (or wherever), C<chmod +x>, and "
1987 "then use it by setting the LIBGUESTFS_QEMU environment variable. For "
1992 #: ../src/guestfs.pod:946
1995 " LIBGUESTFS_QEMU=/tmp/qemu.wrapper guestfish\n"
2000 #: ../src/guestfs.pod:948
2002 "Note that libguestfs also calls qemu with the -help and -version options in "
2003 "order to determine features."
2007 #: ../src/guestfs.pod:951
2008 msgid "ATTACHING TO RUNNING DAEMONS"
2012 #: ../src/guestfs.pod:953
2014 "I<Note (1):> This is B<highly experimental> and has a tendency to eat "
2015 "babies. Use with caution."
2019 #: ../src/guestfs.pod:956
2021 "I<Note (2):> This section explains how to attach to a running daemon from a "
2022 "low level perspective. For most users, simply using virt tools such as "
2023 "L<guestfish(1)> with the I<--live> option will \"just work\"."
2027 #: ../src/guestfs.pod:960
2028 msgid "Using guestfs_set_attach_method"
2032 #: ../src/guestfs.pod:962
2034 "By calling L</guestfs_set_attach_method> you can change how the library "
2035 "connects to the C<guestfsd> daemon in L</guestfs_launch> (read L</"
2036 "ARCHITECTURE> for some background)."
2040 #: ../src/guestfs.pod:966
2042 "The normal attach method is C<appliance>, where a small appliance is created "
2043 "containing the daemon, and then the library connects to this."
2047 #: ../src/guestfs.pod:969
2049 "Setting attach method to C<unix:I<path>> (where I<path> is the path of a "
2050 "Unix domain socket) causes L</guestfs_launch> to connect to an existing "
2051 "daemon over the Unix domain socket."
2055 #: ../src/guestfs.pod:973
2057 "The normal use for this is to connect to a running virtual machine that "
2058 "contains a C<guestfsd> daemon, and send commands so you can read and write "
2059 "files inside the live virtual machine."
2063 #: ../src/guestfs.pod:977
2064 msgid "Using guestfs_add_domain with live flag"
2068 #: ../src/guestfs.pod:979
2070 "L</guestfs_add_domain> provides some help for getting the correct attach "
2071 "method. If you pass the C<live> option to this function, then (if the "
2072 "virtual machine is running) it will examine the libvirt XML looking for a "
2073 "virtio-serial channel to connect to:"
2077 #: ../src/guestfs.pod:985
2084 " <channel type='unix'>\n"
2085 " <source mode='bind' path='/path/to/socket'/>\n"
2086 " <target type='virtio' name='org.libguestfs.channel.0'/>\n"
2095 #: ../src/guestfs.pod:997
2097 "L</guestfs_add_domain> extracts C</path/to/socket> and sets the attach "
2098 "method to C<unix:/path/to/socket>."
2102 #: ../src/guestfs.pod:1000
2104 "Some of the libguestfs tools (including guestfish) support a I<--live> "
2105 "option which is passed through to L</guestfs_add_domain> thus allowing you "
2106 "to attach to and modify live virtual machines."
2110 #: ../src/guestfs.pod:1004
2112 "The virtual machine needs to have been set up beforehand so that it has the "
2113 "virtio-serial channel and so that guestfsd is running inside it."
2117 #: ../src/guestfs.pod:1008
2118 msgid "ABI GUARANTEE"
2122 #: ../src/guestfs.pod:1010
2124 "We guarantee the libguestfs ABI (binary interface), for public, high-level "
2125 "actions as outlined in this section. Although we will deprecate some "
2126 "actions, for example if they get replaced by newer calls, we will keep the "
2127 "old actions forever. This allows you the developer to program in confidence "
2128 "against the libguestfs API."
2132 #: ../src/guestfs.pod:1016
2133 msgid "BLOCK DEVICE NAMING"
2137 #: ../src/guestfs.pod:1018
2139 "In the kernel there is now quite a profusion of schemata for naming block "
2140 "devices (in this context, by I<block device> I mean a physical or virtual "
2141 "hard drive). The original Linux IDE driver used names starting with C</dev/"
2142 "hd*>. SCSI devices have historically used a different naming scheme, C</dev/"
2143 "sd*>. When the Linux kernel I<libata> driver became a popular replacement "
2144 "for the old IDE driver (particularly for SATA devices) those devices also "
2145 "used the C</dev/sd*> scheme. Additionally we now have virtual machines with "
2146 "paravirtualized drivers. This has created several different naming systems, "
2147 "such as C</dev/vd*> for virtio disks and C</dev/xvd*> for Xen PV disks."
2151 #: ../src/guestfs.pod:1030
2153 "As discussed above, libguestfs uses a qemu appliance running an embedded "
2154 "Linux kernel to access block devices. We can run a variety of appliances "
2155 "based on a variety of Linux kernels."
2159 #: ../src/guestfs.pod:1034
2161 "This causes a problem for libguestfs because many API calls use device or "
2162 "partition names. Working scripts and the recipe (example) scripts that we "
2163 "make available over the internet could fail if the naming scheme changes."
2167 #: ../src/guestfs.pod:1039
2169 "Therefore libguestfs defines C</dev/sd*> as the I<standard naming scheme>. "
2170 "Internally C</dev/sd*> names are translated, if necessary, to other names as "
2171 "required. For example, under RHEL 5 which uses the C</dev/hd*> scheme, any "
2172 "device parameter C</dev/sda2> is translated to C</dev/hda2> transparently."
2176 #: ../src/guestfs.pod:1045
2178 "Note that this I<only> applies to parameters. The L</guestfs_list_devices>, "
2179 "L</guestfs_list_partitions> and similar calls return the true names of the "
2180 "devices and partitions as known to the appliance."
2184 #: ../src/guestfs.pod:1050
2185 msgid "ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION"
2189 #: ../src/guestfs.pod:1052
2191 "Usually this translation is transparent. However in some (very rare) cases "
2192 "you may need to know the exact algorithm. Such cases include where you use "
2193 "L</guestfs_config> to add a mixture of virtio and IDE devices to the qemu-"
2194 "based appliance, so have a mixture of C</dev/sd*> and C</dev/vd*> devices."
2198 #: ../src/guestfs.pod:1058
2200 "The algorithm is applied only to I<parameters> which are known to be either "
2201 "device or partition names. Return values from functions such as L</"
2202 "guestfs_list_devices> are never changed."
2206 #: ../src/guestfs.pod:1066
2207 msgid "Is the string a parameter which is a device or partition name?"
2211 #: ../src/guestfs.pod:1070
2212 msgid "Does the string begin with C</dev/sd>?"
2216 #: ../src/guestfs.pod:1074
2218 "Does the named device exist? If so, we use that device. However if I<not> "
2219 "then we continue with this algorithm."
2223 #: ../src/guestfs.pod:1079
2224 msgid "Replace initial C</dev/sd> string with C</dev/hd>."
2228 #: ../src/guestfs.pod:1081
2229 msgid "For example, change C</dev/sda2> to C</dev/hda2>."
2233 #: ../src/guestfs.pod:1083
2234 msgid "If that named device exists, use it. If not, continue."
2238 #: ../src/guestfs.pod:1087
2239 msgid "Replace initial C</dev/sd> string with C</dev/vd>."
2243 #: ../src/guestfs.pod:1089
2244 msgid "If that named device exists, use it. If not, return an error."
2248 #: ../src/guestfs.pod:1093
2249 msgid "PORTABILITY CONCERNS WITH BLOCK DEVICE NAMING"
2253 #: ../src/guestfs.pod:1095
2255 "Although the standard naming scheme and automatic translation is useful for "
2256 "simple programs and guestfish scripts, for larger programs it is best not to "
2257 "rely on this mechanism."
2261 #: ../src/guestfs.pod:1099
2263 "Where possible for maximum future portability programs using libguestfs "
2264 "should use these future-proof techniques:"
2268 #: ../src/guestfs.pod:1106
2270 "Use L</guestfs_list_devices> or L</guestfs_list_partitions> to list actual "
2271 "device names, and then use those names directly."
2275 #: ../src/guestfs.pod:1109
2277 "Since those device names exist by definition, they will never be translated."
2281 #: ../src/guestfs.pod:1114
2283 "Use higher level ways to identify filesystems, such as LVM names, UUIDs and "
2284 "filesystem labels."
2288 #: ../src/guestfs.pod:1119
2293 #: ../src/guestfs.pod:1121
2295 "This section discusses security implications of using libguestfs, "
2296 "particularly with untrusted or malicious guests or disk images."
2300 #: ../src/guestfs.pod:1124
2301 msgid "GENERAL SECURITY CONSIDERATIONS"
2305 #: ../src/guestfs.pod:1126
2307 "Be careful with any files or data that you download from a guest (by "
2308 "\"download\" we mean not just the L</guestfs_download> command but any "
2309 "command that reads files, filenames, directories or anything else from a "
2310 "disk image). An attacker could manipulate the data to fool your program "
2311 "into doing the wrong thing. Consider cases such as:"
2315 #: ../src/guestfs.pod:1136
2316 msgid "the data (file etc) not being present"
2320 #: ../src/guestfs.pod:1140
2321 msgid "being present but empty"
2325 #: ../src/guestfs.pod:1144
2326 msgid "being much larger than normal"
2330 #: ../src/guestfs.pod:1148
2331 msgid "containing arbitrary 8 bit data"
2335 #: ../src/guestfs.pod:1152
2336 msgid "being in an unexpected character encoding"
2340 #: ../src/guestfs.pod:1156
2341 msgid "containing homoglyphs."
2345 #: ../src/guestfs.pod:1160
2346 msgid "SECURITY OF MOUNTING FILESYSTEMS"
2350 #: ../src/guestfs.pod:1162
2352 "When you mount a filesystem under Linux, mistakes in the kernel filesystem "
2353 "(VFS) module can sometimes be escalated into exploits by deliberately "
2354 "creating a malicious, malformed filesystem. These exploits are very severe "
2355 "for two reasons. Firstly there are very many filesystem drivers in the "
2356 "kernel, and many of them are infrequently used and not much developer "
2357 "attention has been paid to the code. Linux userspace helps potential "
2358 "crackers by detecting the filesystem type and automatically choosing the "
2359 "right VFS driver, even if that filesystem type is obscure or unexpected for "
2360 "the administrator. Secondly, a kernel-level exploit is like a local root "
2361 "exploit (worse in some ways), giving immediate and total access to the "
2362 "system right down to the hardware level."
2366 #: ../src/guestfs.pod:1175
2368 "That explains why you should never mount a filesystem from an untrusted "
2369 "guest on your host kernel. How about libguestfs? We run a Linux kernel "
2370 "inside a qemu virtual machine, usually running as a non-root user. The "
2371 "attacker would need to write a filesystem which first exploited the kernel, "
2372 "and then exploited either qemu virtualization (eg. a faulty qemu driver) or "
2373 "the libguestfs protocol, and finally to be as serious as the host kernel "
2374 "exploit it would need to escalate its privileges to root. This multi-step "
2375 "escalation, performed by a static piece of data, is thought to be extremely "
2376 "hard to do, although we never say 'never' about security issues."
2380 #: ../src/guestfs.pod:1186
2382 "In any case callers can reduce the attack surface by forcing the filesystem "
2383 "type when mounting (use L</guestfs_mount_vfs>)."
2387 #: ../src/guestfs.pod:1189
2388 msgid "PROTOCOL SECURITY"
2392 #: ../src/guestfs.pod:1191
2394 "The protocol is designed to be secure, being based on RFC 4506 (XDR) with a "
2395 "defined upper message size. However a program that uses libguestfs must "
2396 "also take care - for example you can write a program that downloads a binary "
2397 "from a disk image and executes it locally, and no amount of protocol "
2398 "security will save you from the consequences."
2402 #: ../src/guestfs.pod:1197
2403 msgid "INSPECTION SECURITY"
2407 #: ../src/guestfs.pod:1199
2409 "Parts of the inspection API (see L</INSPECTION>) return untrusted strings "
2410 "directly from the guest, and these could contain any 8 bit data. Callers "
2411 "should be careful to escape these before printing them to a structured file "
2412 "(for example, use HTML escaping if creating a web page)."
2416 #: ../src/guestfs.pod:1205
2418 "Guest configuration may be altered in unusual ways by the administrator of "
2419 "the virtual machine, and may not reflect reality (particularly for untrusted "
2420 "or actively malicious guests). For example we parse the hostname from "
2421 "configuration files like C</etc/sysconfig/network> that we find in the "
2422 "guest, but the guest administrator can easily manipulate these files to "
2423 "provide the wrong hostname."
2427 #: ../src/guestfs.pod:1213
2429 "The inspection API parses guest configuration using two external libraries: "
2430 "Augeas (Linux configuration) and hivex (Windows Registry). Both are "
2431 "designed to be robust in the face of malicious data, although denial of "
2432 "service attacks are still possible, for example with oversized configuration "
2437 #: ../src/guestfs.pod:1219
2438 msgid "RUNNING UNTRUSTED GUEST COMMANDS"
2442 #: ../src/guestfs.pod:1221
2444 "Be very cautious about running commands from the guest. By running a "
2445 "command in the guest, you are giving CPU time to a binary that you do not "
2446 "control, under the same user account as the library, albeit wrapped in qemu "
2447 "virtualization. More information and alternatives can be found in the "
2448 "section L</RUNNING COMMANDS>."
2452 #: ../src/guestfs.pod:1227
2453 msgid "CVE-2010-3851"
2454 msgstr "CVE-2010-3851"
2457 #: ../src/guestfs.pod:1229
2458 msgid "https://bugzilla.redhat.com/642934"
2459 msgstr "https://bugzilla.redhat.com/642934"
2462 #: ../src/guestfs.pod:1231
2464 "This security bug concerns the automatic disk format detection that qemu "
2465 "does on disk images."
2469 #: ../src/guestfs.pod:1234
2471 "A raw disk image is just the raw bytes, there is no header. Other disk "
2472 "images like qcow2 contain a special header. Qemu deals with this by looking "
2473 "for one of the known headers, and if none is found then assuming the disk "
2474 "image must be raw."
2478 #: ../src/guestfs.pod:1239
2480 "This allows a guest which has been given a raw disk image to write some "
2481 "other header. At next boot (or when the disk image is accessed by "
2482 "libguestfs) qemu would do autodetection and think the disk image format was, "
2483 "say, qcow2 based on the header written by the guest."
2487 #: ../src/guestfs.pod:1244
2489 "This in itself would not be a problem, but qcow2 offers many features, one "
2490 "of which is to allow a disk image to refer to another image (called the "
2491 "\"backing disk\"). It does this by placing the path to the backing disk "
2492 "into the qcow2 header. This path is not validated and could point to any "
2493 "host file (eg. \"/etc/passwd\"). The backing disk is then exposed through "
2494 "\"holes\" in the qcow2 disk image, which of course is completely under the "
2495 "control of the attacker."
2499 #: ../src/guestfs.pod:1252
2501 "In libguestfs this is rather hard to exploit except under two circumstances:"
2505 #: ../src/guestfs.pod:1259
2506 msgid "You have enabled the network or have opened the disk in write mode."
2510 #: ../src/guestfs.pod:1263
2512 "You are also running untrusted code from the guest (see L</RUNNING "
2517 #: ../src/guestfs.pod:1268
2519 "The way to avoid this is to specify the expected disk format when adding "
2520 "disks (the optional C<format> option to L</guestfs_add_drive_opts>). You "
2521 "should always do this if the disk is raw format, and it's a good idea for "
2526 #: ../src/guestfs.pod:1273
2528 "For disks added from libvirt using calls like L</guestfs_add_domain>, the "
2529 "format is fetched from libvirt and passed through."
2533 #: ../src/guestfs.pod:1276
2535 "For libguestfs tools, use the I<--format> command line parameter as "
2540 #: ../src/guestfs.pod:1279
2541 msgid "CONNECTION MANAGEMENT"
2545 #: ../src/guestfs.pod:1281
2550 #: ../src/guestfs.pod:1283
2552 "C<guestfs_h> is the opaque type representing a connection handle. Create a "
2553 "handle by calling L</guestfs_create>. Call L</guestfs_close> to free the "
2554 "handle and release all resources used."
2558 #: ../src/guestfs.pod:1287
2560 "For information on using multiple handles and threads, see the section L</"
2561 "MULTIPLE HANDLES AND MULTIPLE THREADS> above."
2565 #: ../src/guestfs.pod:1290
2566 msgid "guestfs_create"
2570 #: ../src/guestfs.pod:1292
2573 " guestfs_h *guestfs_create (void);\n"
2578 #: ../src/guestfs.pod:1294
2579 msgid "Create a connection handle."
2583 #: ../src/guestfs.pod:1296
2585 "On success this returns a non-NULL pointer to a handle. On error it returns "
2590 #: ../src/guestfs.pod:1299
2592 "You have to \"configure\" the handle after creating it. This includes "
2593 "calling L</guestfs_add_drive_opts> (or one of the equivalent calls) on the "
2594 "handle at least once."
2598 #: ../src/guestfs.pod:1303
2599 msgid "After configuring the handle, you have to call L</guestfs_launch>."
2603 #: ../src/guestfs.pod:1305
2605 "You may also want to configure error handling for the handle. See the L</"
2606 "ERROR HANDLING> section below."
2610 #: ../src/guestfs.pod:1308
2611 msgid "guestfs_close"
2615 #: ../src/guestfs.pod:1310
2618 " void guestfs_close (guestfs_h *g);\n"
2623 #: ../src/guestfs.pod:1312
2624 msgid "This closes the connection handle and frees up all resources used."
2628 #: ../src/guestfs.pod:1314
2630 "If autosync was set on the handle and the handle was launched, then this "
2631 "implicitly calls various functions to unmount filesystems and sync the "
2632 "disk. See L</guestfs_set_autosync> for more details."
2636 #: ../src/guestfs.pod:1318
2637 msgid "If a close callback was set on the handle, then it is called."
2641 #: ../src/guestfs.pod:1320
2642 msgid "ERROR HANDLING"
2643 msgstr "ОБРОБКА ПОМИЛОК"
2646 #: ../src/guestfs.pod:1322
2648 "API functions can return errors. For example, almost all functions that "
2649 "return C<int> will return C<-1> to indicate an error."
2653 #: ../src/guestfs.pod:1325
2655 "Additional information is available for errors: an error message string and "
2656 "optionally an error number (errno) if the thing that failed was a system "
2661 #: ../src/guestfs.pod:1329
2663 "You can get at the additional information about the last error on the handle "
2664 "by calling L</guestfs_last_error>, L</guestfs_last_errno>, and/or by setting "
2665 "up an error handler with L</guestfs_set_error_handler>."
2669 #: ../src/guestfs.pod:1334
2671 "When the handle is created, a default error handler is installed which "
2672 "prints the error message string to C<stderr>. For small short-running "
2673 "command line programs it is sufficient to do:"
2677 #: ../src/guestfs.pod:1338
2680 " if (guestfs_launch (g) == -1)\n"
2681 " exit (EXIT_FAILURE);\n"
2686 #: ../src/guestfs.pod:1341
2688 "since the default error handler will ensure that an error message has been "
2689 "printed to C<stderr> before the program exits."
2693 #: ../src/guestfs.pod:1344
2695 "For other programs the caller will almost certainly want to install an "
2696 "alternate error handler or do error handling in-line like this:"
2700 #: ../src/guestfs.pod:1347
2703 " g = guestfs_create ();\n"
2708 #: ../src/guestfs.pod:1349
2711 " /* This disables the default behaviour of printing errors\n"
2713 " guestfs_set_error_handler (g, NULL, NULL);\n"
2718 #: ../src/guestfs.pod:1353
2721 " if (guestfs_launch (g) == -1) {\n"
2722 " /* Examine the error message and print it etc. */\n"
2723 " char *msg = guestfs_last_error (g);\n"
2724 " int errnum = guestfs_last_errno (g);\n"
2725 " fprintf (stderr, \"%s\\n\", msg);\n"
2732 #: ../src/guestfs.pod:1361
2734 "Out of memory errors are handled differently. The default action is to call "
2735 "L<abort(3)>. If this is undesirable, then you can set a handler using L</"
2736 "guestfs_set_out_of_memory_handler>."
2740 #: ../src/guestfs.pod:1365
2742 "L</guestfs_create> returns C<NULL> if the handle cannot be created, and "
2743 "because there is no handle if this happens there is no way to get additional "
2744 "error information. However L</guestfs_create> is supposed to be a "
2745 "lightweight operation which can only fail because of insufficient memory (it "
2746 "returns NULL in this case)."
2750 #: ../src/guestfs.pod:1371
2751 msgid "guestfs_last_error"
2755 #: ../src/guestfs.pod:1373
2758 " const char *guestfs_last_error (guestfs_h *g);\n"
2763 #: ../src/guestfs.pod:1375
2765 "This returns the last error message that happened on C<g>. If there has not "
2766 "been an error since the handle was created, then this returns C<NULL>."
2770 #: ../src/guestfs.pod:1379
2772 "The lifetime of the returned string is until the next error occurs, or L</"
2773 "guestfs_close> is called."
2777 #: ../src/guestfs.pod:1382
2778 msgid "guestfs_last_errno"
2782 #: ../src/guestfs.pod:1384
2785 " int guestfs_last_errno (guestfs_h *g);\n"
2790 #: ../src/guestfs.pod:1386
2791 msgid "This returns the last error number (errno) that happened on C<g>."
2795 #: ../src/guestfs.pod:1388
2796 msgid "If successful, an errno integer not equal to zero is returned."
2800 #: ../src/guestfs.pod:1390
2802 "If no error, this returns 0. This call can return 0 in three situations:"
2806 #: ../src/guestfs.pod:1397
2807 msgid "There has not been any error on the handle."
2811 #: ../src/guestfs.pod:1401
2813 "There has been an error but the errno was meaningless. This corresponds to "
2814 "the case where the error did not come from a failed system call, but for "
2815 "some other reason."
2819 #: ../src/guestfs.pod:1407
2821 "There was an error from a failed system call, but for some reason the errno "
2822 "was not captured and returned. This usually indicates a bug in libguestfs."
2826 #: ../src/guestfs.pod:1413
2828 "Libguestfs tries to convert the errno from inside the applicance into a "
2829 "corresponding errno for the caller (not entirely trivial: the appliance "
2830 "might be running a completely different operating system from the library "
2831 "and error numbers are not standardized across Un*xen). If this could not be "
2832 "done, then the error is translated to C<EINVAL>. In practice this should "
2833 "only happen in very rare circumstances."
2837 #: ../src/guestfs.pod:1421
2838 msgid "guestfs_set_error_handler"
2842 #: ../src/guestfs.pod:1423
2845 " typedef void (*guestfs_error_handler_cb) (guestfs_h *g,\n"
2847 " const char *msg);\n"
2848 " void guestfs_set_error_handler (guestfs_h *g,\n"
2849 " guestfs_error_handler_cb cb,\n"
2855 #: ../src/guestfs.pod:1430
2857 "The callback C<cb> will be called if there is an error. The parameters "
2858 "passed to the callback are an opaque data pointer and the error message "
2863 #: ../src/guestfs.pod:1434
2865 "C<errno> is not passed to the callback. To get that the callback must call "
2866 "L</guestfs_last_errno>."
2870 #: ../src/guestfs.pod:1437
2872 "Note that the message string C<msg> is freed as soon as the callback "
2873 "function returns, so if you want to stash it somewhere you must make your "
2878 #: ../src/guestfs.pod:1441
2879 msgid "The default handler prints messages on C<stderr>."
2883 #: ../src/guestfs.pod:1443
2884 msgid "If you set C<cb> to C<NULL> then I<no> handler is called."
2888 #: ../src/guestfs.pod:1445
2889 msgid "guestfs_get_error_handler"
2893 #: ../src/guestfs.pod:1447
2896 " guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g,\n"
2897 " void **opaque_rtn);\n"
2902 #: ../src/guestfs.pod:1450
2903 msgid "Returns the current error handler callback."
2907 #: ../src/guestfs.pod:1452
2908 msgid "guestfs_set_out_of_memory_handler"
2912 #: ../src/guestfs.pod:1454
2915 " typedef void (*guestfs_abort_cb) (void);\n"
2916 " int guestfs_set_out_of_memory_handler (guestfs_h *g,\n"
2917 " guestfs_abort_cb);\n"
2922 #: ../src/guestfs.pod:1458
2924 "The callback C<cb> will be called if there is an out of memory situation. "
2925 "I<Note this callback must not return>."
2929 #: ../src/guestfs.pod:1461
2930 msgid "The default is to call L<abort(3)>."
2934 #: ../src/guestfs.pod:1463
2936 "You cannot set C<cb> to C<NULL>. You can't ignore out of memory situations."
2940 #: ../src/guestfs.pod:1466
2941 msgid "guestfs_get_out_of_memory_handler"
2945 #: ../src/guestfs.pod:1468
2948 " guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n"
2953 #: ../src/guestfs.pod:1470
2954 msgid "This returns the current out of memory handler."
2958 #: ../src/guestfs.pod:1472
2963 #: ../src/guestfs.pod:1474 ../fish/guestfish.pod:1010
2968 #: ../src/guestfs.pod:1476
2973 #: ../src/guestfs.pod:1478
2978 #: ../src/guestfs.pod:1480
2979 msgid "AVAILABILITY"
2983 #: ../src/guestfs.pod:1482
2984 msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE"
2988 #: ../src/guestfs.pod:1484
2990 "Using L</guestfs_available> you can test availability of the following "
2991 "groups of functions. This test queries the appliance to see if the "
2992 "appliance you are currently using supports the functionality."
2996 #: ../src/guestfs.pod:1489
2997 msgid "@AVAILABILITY@"
3001 #: ../src/guestfs.pod:1491
3002 msgid "GUESTFISH supported COMMAND"
3006 #: ../src/guestfs.pod:1493
3008 "In L<guestfish(3)> there is a handy interactive command C<supported> which "
3009 "prints out the available groups and whether they are supported by this build "
3010 "of libguestfs. Note however that you have to do C<run> first."
3014 #: ../src/guestfs.pod:1498
3015 msgid "SINGLE CALLS AT COMPILE TIME"
3019 #: ../src/guestfs.pod:1500
3021 "Since version 1.5.8, C<E<lt>guestfs.hE<gt>> defines symbols for each C API "
3022 "function, such as:"
3026 #: ../src/guestfs.pod:1503
3029 " #define LIBGUESTFS_HAVE_DD 1\n"
3034 #: ../src/guestfs.pod:1505
3035 msgid "if L</guestfs_dd> is available."
3039 #: ../src/guestfs.pod:1507
3041 "Before version 1.5.8, if you needed to test whether a single libguestfs "
3042 "function is available at compile time, we recommended using build tools such "
3043 "as autoconf or cmake. For example in autotools you could use:"
3047 #: ../src/guestfs.pod:1512
3050 " AC_CHECK_LIB([guestfs],[guestfs_create])\n"
3051 " AC_CHECK_FUNCS([guestfs_dd])\n"
3056 #: ../src/guestfs.pod:1515
3058 "which would result in C<HAVE_GUESTFS_DD> being either defined or not defined "
3063 #: ../src/guestfs.pod:1518
3064 msgid "SINGLE CALLS AT RUN TIME"
3068 #: ../src/guestfs.pod:1520
3070 "Testing at compile time doesn't guarantee that a function really exists in "
3071 "the library. The reason is that you might be dynamically linked against a "
3072 "previous I<libguestfs.so> (dynamic library) which doesn't have the call. "
3073 "This situation unfortunately results in a segmentation fault, which is a "
3074 "shortcoming of the C dynamic linking system itself."
3078 #: ../src/guestfs.pod:1527
3080 "You can use L<dlopen(3)> to test if a function is available at run time, as "
3081 "in this example program (note that you still need the compile time check as "
3086 #: ../src/guestfs.pod:1531
3089 " #include <stdio.h>\n"
3090 " #include <stdlib.h>\n"
3091 " #include <unistd.h>\n"
3092 " #include <dlfcn.h>\n"
3093 " #include <guestfs.h>\n"
3098 #: ../src/guestfs.pod:1537
3103 " #ifdef LIBGUESTFS_HAVE_DD\n"
3105 " int has_function;\n"
3110 #: ../src/guestfs.pod:1543
3113 " /* Test if the function guestfs_dd is really available. */\n"
3114 " dl = dlopen (NULL, RTLD_LAZY);\n"
3116 " fprintf (stderr, \"dlopen: %s\\n\", dlerror ());\n"
3117 " exit (EXIT_FAILURE);\n"
3119 " has_function = dlsym (dl, \"guestfs_dd\") != NULL;\n"
3125 #: ../src/guestfs.pod:1552
3128 " if (!has_function)\n"
3129 " printf (\"this libguestfs.so does NOT have guestfs_dd function\\n\");\n"
3131 " printf (\"this libguestfs.so has guestfs_dd function\\n\");\n"
3132 " /* Now it's safe to call\n"
3133 " guestfs_dd (g, \"foo\", \"bar\");\n"
3137 " printf (\"guestfs_dd function was not found at compile time\\n\");\n"
3144 #: ../src/guestfs.pod:1565
3146 "You may think the above is an awful lot of hassle, and it is. There are "
3147 "other ways outside of the C linking system to ensure that this kind of "
3148 "incompatibility never arises, such as using package versioning:"
3152 #: ../src/guestfs.pod:1570
3155 " Requires: libguestfs >= 1.0.80\n"
3160 #: ../src/guestfs.pod:1572
3161 msgid "CALLS WITH OPTIONAL ARGUMENTS"
3165 #: ../src/guestfs.pod:1574
3167 "A recent feature of the API is the introduction of calls which take optional "
3168 "arguments. In C these are declared 3 ways. The main way is as a call which "
3169 "takes variable arguments (ie. C<...>), as in this example:"
3173 #: ../src/guestfs.pod:1579
3176 " int guestfs_add_drive_opts (guestfs_h *g, const char *filename, ...);\n"
3181 #: ../src/guestfs.pod:1581
3183 "Call this with a list of optional arguments, terminated by C<-1>. So to "
3184 "call with no optional arguments specified:"
3188 #: ../src/guestfs.pod:1584
3191 " guestfs_add_drive_opts (g, filename, -1);\n"
3196 #: ../src/guestfs.pod:1586
3197 msgid "With a single optional argument:"
3201 #: ../src/guestfs.pod:1588
3204 " guestfs_add_drive_opts (g, filename,\n"
3205 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
3211 #: ../src/guestfs.pod:1592
3216 #: ../src/guestfs.pod:1594
3219 " guestfs_add_drive_opts (g, filename,\n"
3220 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
3221 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
3227 #: ../src/guestfs.pod:1599
3229 "and so forth. Don't forget the terminating C<-1> otherwise Bad Things will "
3234 #: ../src/guestfs.pod:1602
3235 msgid "USING va_list FOR OPTIONAL ARGUMENTS"
3239 #: ../src/guestfs.pod:1604
3241 "The second variant has the same name with the suffix C<_va>, which works the "
3242 "same way but takes a C<va_list>. See the C manual for details. For the "
3243 "example function, this is declared:"
3247 #: ../src/guestfs.pod:1608
3250 " int guestfs_add_drive_opts_va (guestfs_h *g, const char *filename,\n"
3256 #: ../src/guestfs.pod:1611
3257 msgid "CONSTRUCTING OPTIONAL ARGUMENTS"
3261 #: ../src/guestfs.pod:1613
3263 "The third variant is useful where you need to construct these calls. You "
3264 "pass in a structure where you fill in the optional fields. The structure "
3265 "has a bitmask as the first element which you must set to indicate which "
3266 "fields you have filled in. For our example function the structure and call "
3271 #: ../src/guestfs.pod:1619
3274 " struct guestfs_add_drive_opts_argv {\n"
3275 " uint64_t bitmask;\n"
3277 " const char *format;\n"
3280 " int guestfs_add_drive_opts_argv (guestfs_h *g, const char *filename,\n"
3281 " const struct guestfs_add_drive_opts_argv *optargs);\n"
3286 #: ../src/guestfs.pod:1628
3287 msgid "You could call it like this:"
3291 #: ../src/guestfs.pod:1630
3294 " struct guestfs_add_drive_opts_argv optargs = {\n"
3295 " .bitmask = GUESTFS_ADD_DRIVE_OPTS_READONLY_BITMASK |\n"
3296 " GUESTFS_ADD_DRIVE_OPTS_FORMAT_BITMASK,\n"
3298 " .format = \"qcow2\"\n"
3304 #: ../src/guestfs.pod:1637
3307 " guestfs_add_drive_opts_argv (g, filename, &optargs);\n"
3312 #: ../src/guestfs.pod:1639 ../src/guestfs-actions.pod:11
3313 #: ../src/guestfs-actions.pod:1858 ../src/guestfs-actions.pod:2785
3314 #: ../fish/guestfish-actions.pod:9 ../fish/guestfish-actions.pod:1262
3315 #: ../fish/guestfish-actions.pod:1898 ../tools/virt-win-reg.pl:704
3320 #: ../src/guestfs.pod:1645
3321 msgid "The C<_BITMASK> suffix on each option name when specifying the bitmask."
3325 #: ../src/guestfs.pod:1650
3326 msgid "You do not need to fill in all fields of the structure."
3330 #: ../src/guestfs.pod:1654
3332 "There must be a one-to-one correspondence between fields of the structure "
3333 "that are filled in, and bits set in the bitmask."
3337 #: ../src/guestfs.pod:1659
3338 msgid "OPTIONAL ARGUMENTS IN OTHER LANGUAGES"
3342 #: ../src/guestfs.pod:1661
3344 "In other languages, optional arguments are expressed in the way that is "
3345 "natural for that language. We refer you to the language-specific "
3346 "documentation for more details on that."
3350 #: ../src/guestfs.pod:1665
3351 msgid "For guestfish, see L<guestfish(1)/OPTIONAL ARGUMENTS>."
3355 #: ../src/guestfs.pod:1667
3356 msgid "SETTING CALLBACKS TO HANDLE EVENTS"
3360 #: ../src/guestfs.pod:1669
3362 "B<Note:> This section documents the generic event mechanism introduced in "
3363 "libguestfs 1.10, which you should use in new code if possible. The old "
3364 "functions C<guestfs_set_log_message_callback>, "
3365 "C<guestfs_set_subprocess_quit_callback>, "
3366 "C<guestfs_set_launch_done_callback>, C<guestfs_set_close_callback> and "
3367 "C<guestfs_set_progress_callback> are no longer documented in this manual "
3368 "page. Because of the ABI guarantee, the old functions continue to work."
3372 #: ../src/guestfs.pod:1678
3374 "Handles generate events when certain things happen, such as log messages "
3375 "being generated, progress messages during long-running operations, or the "
3376 "handle being closed. The API calls described below let you register a "
3377 "callback to be called when events happen. You can register multiple "
3378 "callbacks (for the same, different or overlapping sets of events), and "
3379 "individually remove callbacks. If callbacks are not removed, then they "
3380 "remain in force until the handle is closed."
3384 #: ../src/guestfs.pod:1686
3386 "In the current implementation, events are only generated synchronously: that "
3387 "means that events (and hence callbacks) can only happen while you are in the "
3388 "middle of making another libguestfs call. The callback is called in the "
3393 #: ../src/guestfs.pod:1691
3395 "Events may contain a payload, usually nothing (void), an array of 64 bit "
3396 "unsigned integers, or a message buffer. Payloads are discussed later on."
3400 #: ../src/guestfs.pod:1695
3401 msgid "CLASSES OF EVENTS"
3405 #: ../src/guestfs.pod:1699
3406 msgid "GUESTFS_EVENT_CLOSE (payload type: void)"
3410 #: ../src/guestfs.pod:1702
3412 "The callback function will be called while the handle is being closed "
3413 "(synchronously from L</guestfs_close>)."
3417 #: ../src/guestfs.pod:1705
3419 "Note that libguestfs installs an L<atexit(3)> handler to try to clean up "
3420 "handles that are open when the program exits. This means that this callback "
3421 "might be called indirectly from L<exit(3)>, which can cause unexpected "
3422 "problems in higher-level languages (eg. if your HLL interpreter has already "
3423 "been cleaned up by the time this is called, and if your callback then jumps "
3424 "into some HLL function)."
3428 #: ../src/guestfs.pod:1712
3430 "If no callback is registered: the handle is closed without any callback "
3435 #: ../src/guestfs.pod:1715
3436 msgid "GUESTFS_EVENT_SUBPROCESS_QUIT (payload type: void)"
3440 #: ../src/guestfs.pod:1718
3442 "The callback function will be called when the child process quits, either "
3443 "asynchronously or if killed by L</guestfs_kill_subprocess>. (This "
3444 "corresponds to a transition from any state to the CONFIG state)."
3448 #: ../src/guestfs.pod:1722 ../src/guestfs.pod:1731
3449 msgid "If no callback is registered: the event is ignored."
3453 #: ../src/guestfs.pod:1724
3454 msgid "GUESTFS_EVENT_LAUNCH_DONE (payload type: void)"
3458 #: ../src/guestfs.pod:1727
3460 "The callback function will be called when the child process becomes ready "
3461 "first time after it has been launched. (This corresponds to a transition "
3462 "from LAUNCHING to the READY state)."
3466 #: ../src/guestfs.pod:1733
3467 msgid "GUESTFS_EVENT_PROGRESS (payload type: array of 4 x uint64_t)"
3471 #: ../src/guestfs.pod:1736
3473 "Some long-running operations can generate progress messages. If this "
3474 "callback is registered, then it will be called each time a progress message "
3475 "is generated (usually two seconds after the operation started, and three "
3476 "times per second thereafter until it completes, although the frequency may "
3477 "change in future versions)."
3481 #: ../src/guestfs.pod:1742
3483 "The callback receives in the payload four unsigned 64 bit numbers which are "
3484 "(in order): C<proc_nr>, C<serial>, C<position>, C<total>."
3488 #: ../src/guestfs.pod:1745
3490 "The units of C<total> are not defined, although for some operations C<total> "
3491 "may relate in some way to the amount of data to be transferred (eg. in bytes "
3492 "or megabytes), and C<position> may be the portion which has been transferred."
3496 #: ../src/guestfs.pod:1750
3497 msgid "The only defined and stable parts of the API are:"
3501 #: ../src/guestfs.pod:1756
3503 "The callback can display to the user some type of progress bar or indicator "
3504 "which shows the ratio of C<position>:C<total>."
3508 #: ../src/guestfs.pod:1761
3509 msgid "0 E<lt>= C<position> E<lt>= C<total>"
3513 #: ../src/guestfs.pod:1765
3515 "If any progress notification is sent during a call, then a final progress "
3516 "notification is always sent when C<position> = C<total> (I<unless> the call "
3517 "fails with an error)."
3521 #: ../src/guestfs.pod:1769
3523 "This is to simplify caller code, so callers can easily set the progress "
3524 "indicator to \"100%\" at the end of the operation, without requiring special "
3525 "code to detect this case."
3529 #: ../src/guestfs.pod:1775
3531 "For some calls we are unable to estimate the progress of the call, but we "
3532 "can still generate progress messages to indicate activity. This is known as "
3533 "\"pulse mode\", and is directly supported by certain progress bar "
3534 "implementations (eg. GtkProgressBar)."
3538 #: ../src/guestfs.pod:1780
3540 "For these calls, zero or more progress messages are generated with "
3541 "C<position = 0> and C<total = 1>, followed by a final message with "
3542 "C<position = total = 1>."
3546 #: ../src/guestfs.pod:1784
3548 "As noted above, if the call fails with an error then the final message may "
3553 #: ../src/guestfs.pod:1789
3555 "The callback also receives the procedure number (C<proc_nr>) and serial "
3556 "number (C<serial>) of the call. These are only useful for debugging "
3557 "protocol issues, and the callback can normally ignore them. The callback "
3558 "may want to print these numbers in error messages or debugging messages."
3562 #: ../src/guestfs.pod:1795
3563 msgid "If no callback is registered: progress messages are discarded."
3567 #: ../src/guestfs.pod:1797
3568 msgid "GUESTFS_EVENT_APPLIANCE (payload type: message buffer)"
3572 #: ../src/guestfs.pod:1800
3574 "The callback function is called whenever a log message is generated by qemu, "
3575 "the appliance kernel, guestfsd (daemon), or utility programs."
3579 #: ../src/guestfs.pod:1803
3581 "If the verbose flag (L</guestfs_set_verbose>) is set before launch (L</"
3582 "guestfs_launch>) then additional debug messages are generated."
3586 #: ../src/guestfs.pod:1806 ../src/guestfs.pod:1820
3588 "If no callback is registered: the messages are discarded unless the verbose "
3589 "flag is set in which case they are sent to stderr. You can override the "
3590 "printing of verbose messages to stderr by setting up a callback."
3594 #: ../src/guestfs.pod:1811
3595 msgid "GUESTFS_EVENT_LIBRARY (payload type: message buffer)"
3599 #: ../src/guestfs.pod:1814
3601 "The callback function is called whenever a log message is generated by the "
3602 "library part of libguestfs."
3606 #: ../src/guestfs.pod:1817
3608 "If the verbose flag (L</guestfs_set_verbose>) is set then additional debug "
3609 "messages are generated."
3613 #: ../src/guestfs.pod:1825
3614 msgid "GUESTFS_EVENT_TRACE (payload type: message buffer)"
3618 #: ../src/guestfs.pod:1828
3620 "The callback function is called whenever a trace message is generated. This "
3621 "only applies if the trace flag (L</guestfs_set_trace>) is set."
3625 #: ../src/guestfs.pod:1831
3627 "If no callback is registered: the messages are sent to stderr. You can "
3628 "override the printing of trace messages to stderr by setting up a callback."
3632 #: ../src/guestfs.pod:1837
3633 msgid "guestfs_set_event_callback"
3637 #: ../src/guestfs.pod:1839
3640 " int guestfs_set_event_callback (guestfs_h *g,\n"
3641 " guestfs_event_callback cb,\n"
3642 " uint64_t event_bitmask,\n"
3649 #: ../src/guestfs.pod:1845
3651 "This function registers a callback (C<cb>) for all event classes in the "
3656 #: ../src/guestfs.pod:1848
3658 "For example, to register for all log message events, you could call this "
3659 "function with the bitmask C<GUESTFS_EVENT_APPLIANCE|GUESTFS_EVENT_LIBRARY>. "
3660 "To register a single callback for all possible classes of events, use "
3661 "C<GUESTFS_EVENT_ALL>."
3665 #: ../src/guestfs.pod:1854
3666 msgid "C<flags> should always be passed as 0."
3670 #: ../src/guestfs.pod:1856
3672 "C<opaque> is an opaque pointer which is passed to the callback. You can use "
3673 "it for any purpose."
3677 #: ../src/guestfs.pod:1859
3679 "The return value is the event handle (an integer) which you can use to "
3680 "delete the callback (see below)."
3684 #: ../src/guestfs.pod:1862
3686 "If there is an error, this function returns C<-1>, and sets the error in the "
3687 "handle in the usual way (see L</guestfs_last_error> etc.)"
3691 #: ../src/guestfs.pod:1865
3693 "Callbacks remain in effect until they are deleted, or until the handle is "
3698 #: ../src/guestfs.pod:1868
3700 "In the case where multiple callbacks are registered for a particular event "
3701 "class, all of the callbacks are called. The order in which multiple "
3702 "callbacks are called is not defined."
3706 #: ../src/guestfs.pod:1872
3707 msgid "guestfs_delete_event_callback"
3711 #: ../src/guestfs.pod:1874
3714 " void guestfs_delete_event_callback (guestfs_h *g, int event_handle);\n"
3719 #: ../src/guestfs.pod:1876
3721 "Delete a callback that was previously registered. C<event_handle> should be "
3722 "the integer that was returned by a previous call to "
3723 "C<guestfs_set_event_callback> on the same handle."
3727 #: ../src/guestfs.pod:1880
3728 msgid "guestfs_event_callback"
3732 #: ../src/guestfs.pod:1882
3735 " typedef void (*guestfs_event_callback) (\n"
3738 " uint64_t event,\n"
3739 " int event_handle,\n"
3741 " const char *buf, size_t buf_len,\n"
3742 " const uint64_t *array, size_t array_len);\n"
3747 #: ../src/guestfs.pod:1891
3749 "This is the type of the event callback function that you have to provide."
3753 #: ../src/guestfs.pod:1894
3755 "The basic parameters are: the handle (C<g>), the opaque user pointer "
3756 "(C<opaque>), the event class (eg. C<GUESTFS_EVENT_PROGRESS>), the event "
3757 "handle, and C<flags> which in the current API you should ignore."
3761 #: ../src/guestfs.pod:1898
3763 "The remaining parameters contain the event payload (if any). Each event may "
3764 "contain a payload, which usually relates to the event class, but for future "
3765 "proofing your code should be written to handle any payload for any event "
3770 #: ../src/guestfs.pod:1903
3772 "C<buf> and C<buf_len> contain a message buffer (if C<buf_len == 0>, then "
3773 "there is no message buffer). Note that this message buffer can contain "
3774 "arbitrary 8 bit data, including NUL bytes."
3778 #: ../src/guestfs.pod:1907
3780 "C<array> and C<array_len> is an array of 64 bit unsigned integers. At the "
3781 "moment this is only used for progress messages."
3785 #: ../src/guestfs.pod:1910
3786 msgid "EXAMPLE: CAPTURING LOG MESSAGES"
3790 #: ../src/guestfs.pod:1912
3792 "One motivation for the generic event API was to allow GUI programs to "
3793 "capture debug and other messages. In libguestfs E<le> 1.8 these were sent "
3794 "unconditionally to C<stderr>."
3798 #: ../src/guestfs.pod:1916
3800 "Events associated with log messages are: C<GUESTFS_EVENT_LIBRARY>, "
3801 "C<GUESTFS_EVENT_APPLIANCE> and C<GUESTFS_EVENT_TRACE>. (Note that error "
3802 "messages are not events; you must capture error messages separately)."
3806 #: ../src/guestfs.pod:1921
3808 "Programs have to set up a callback to capture the classes of events of "
3813 #: ../src/guestfs.pod:1924
3817 " guestfs_set_event_callback\n"
3818 " (g, message_callback,\n"
3819 " GUESTFS_EVENT_LIBRARY|GUESTFS_EVENT_APPLIANCE|\n"
3820 " GUESTFS_EVENT_TRACE,\n"
3821 " 0, NULL) == -1)\n"
3822 " if (eh == -1) {\n"
3823 " // handle error in the usual way\n"
3829 #: ../src/guestfs.pod:1934
3831 "The callback can then direct messages to the appropriate place. In this "
3832 "example, messages are directed to syslog:"
3836 #: ../src/guestfs.pod:1937
3840 " message_callback (\n"
3843 " uint64_t event,\n"
3844 " int event_handle,\n"
3846 " const char *buf, size_t buf_len,\n"
3847 " const uint64_t *array, size_t array_len)\n"
3849 " const int priority = LOG_USER|LOG_INFO;\n"
3850 " if (buf_len > 0)\n"
3851 " syslog (priority, \"event 0x%lx: %s\", event, buf);\n"
3857 #: ../src/guestfs.pod:1952
3858 msgid "PRIVATE DATA AREA"
3862 #: ../src/guestfs.pod:1954
3864 "You can attach named pieces of private data to the libguestfs handle, fetch "
3865 "them by name, and walk over them, for the lifetime of the handle. This is "
3866 "called the private data area and is only available from the C API."
3870 #: ../src/guestfs.pod:1959
3871 msgid "To attach a named piece of data, use the following call:"
3875 #: ../src/guestfs.pod:1961
3878 " void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n"
3883 #: ../src/guestfs.pod:1963
3885 "C<key> is the name to associate with this data, and C<data> is an arbitrary "
3886 "pointer (which can be C<NULL>). Any previous item with the same key is "
3891 #: ../src/guestfs.pod:1967
3893 "You can use any C<key> you want, but your key should I<not> start with an "
3894 "underscore character. Keys beginning with an underscore character are "
3895 "reserved for internal libguestfs purposes (eg. for implementing language "
3896 "bindings). It is recommended that you prefix the key with some unique "
3897 "string to avoid collisions with other users."
3901 #: ../src/guestfs.pod:1973
3902 msgid "To retrieve the pointer, use:"
3906 #: ../src/guestfs.pod:1975
3909 " void *guestfs_get_private (guestfs_h *g, const char *key);\n"
3914 #: ../src/guestfs.pod:1977
3916 "This function returns C<NULL> if either no data is found associated with "
3917 "C<key>, or if the user previously set the C<key>'s C<data> pointer to "
3922 #: ../src/guestfs.pod:1981
3924 "Libguestfs does not try to look at or interpret the C<data> pointer in any "
3925 "way. As far as libguestfs is concerned, it need not be a valid pointer at "
3926 "all. In particular, libguestfs does I<not> try to free the data when the "
3927 "handle is closed. If the data must be freed, then the caller must either "
3928 "free it before calling L</guestfs_close> or must set up a close callback to "
3929 "do it (see L</GUESTFS_EVENT_CLOSE>)."
3933 #: ../src/guestfs.pod:1988
3934 msgid "To walk over all entries, use these two functions:"
3938 #: ../src/guestfs.pod:1990
3941 " void *guestfs_first_private (guestfs_h *g, const char **key_rtn);\n"
3946 #: ../src/guestfs.pod:1992
3949 " void *guestfs_next_private (guestfs_h *g, const char **key_rtn);\n"
3954 #: ../src/guestfs.pod:1994
3956 "C<guestfs_first_private> returns the first key, pointer pair (\"first\" does "
3957 "not have any particular meaning -- keys are not returned in any defined "
3958 "order). A pointer to the key is returned in C<*key_rtn> and the "
3959 "corresponding data pointer is returned from the function. C<NULL> is "
3960 "returned if there are no keys stored in the handle."
3964 #: ../src/guestfs.pod:2000
3966 "C<guestfs_next_private> returns the next key, pointer pair. The return "
3967 "value of this function is also C<NULL> is there are no further entries to "
3972 #: ../src/guestfs.pod:2004
3973 msgid "Notes about walking over entries:"
3977 #: ../src/guestfs.pod:2010
3979 "You must not call C<guestfs_set_private> while walking over the entries."
3983 #: ../src/guestfs.pod:2015
3985 "The handle maintains an internal iterator which is reset when you call "
3986 "C<guestfs_first_private>. This internal iterator is invalidated when you "
3987 "call C<guestfs_set_private>."
3991 #: ../src/guestfs.pod:2021
3992 msgid "If you have set the data pointer associated with a key to C<NULL>, ie:"
3996 #: ../src/guestfs.pod:2023
3999 " guestfs_set_private (g, key, NULL);\n"
4004 #: ../src/guestfs.pod:2025
4005 msgid "then that C<key> is not returned when walking."
4009 #: ../src/guestfs.pod:2029
4011 "C<*key_rtn> is only valid until the next call to C<guestfs_first_private>, "
4012 "C<guestfs_next_private> or C<guestfs_set_private>."
4016 #: ../src/guestfs.pod:2035
4018 "The following example code shows how to print all keys and data pointers "
4019 "that are associated with the handle C<g>:"
4023 #: ../src/guestfs.pod:2038
4026 " const char *key;\n"
4027 " void *data = guestfs_first_private (g, &key);\n"
4028 " while (data != NULL)\n"
4030 " printf (\"key = %s, data = %p\\n\", key, data);\n"
4031 " data = guestfs_next_private (g, &key);\n"
4037 #: ../src/guestfs.pod:2046
4039 "More commonly you are only interested in keys that begin with an application-"
4040 "specific prefix C<foo_>. Modify the loop like so:"
4044 #: ../src/guestfs.pod:2049
4047 " const char *key;\n"
4048 " void *data = guestfs_first_private (g, &key);\n"
4049 " while (data != NULL)\n"
4051 " if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
4052 " printf (\"key = %s, data = %p\\n\", key, data);\n"
4053 " data = guestfs_next_private (g, &key);\n"
4059 #: ../src/guestfs.pod:2058
4061 "If you need to modify keys while walking, then you have to jump back to the "
4062 "beginning of the loop. For example, to delete all keys prefixed with "
4067 #: ../src/guestfs.pod:2062
4070 " const char *key;\n"
4073 " data = guestfs_first_private (g, &key);\n"
4074 " while (data != NULL)\n"
4076 " if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
4078 " guestfs_set_private (g, key, NULL);\n"
4079 " /* note that 'key' pointer is now invalid, and so is\n"
4080 " the internal iterator */\n"
4083 " data = guestfs_next_private (g, &key);\n"
4089 #: ../src/guestfs.pod:2078
4091 "Note that the above loop is guaranteed to terminate because the keys are "
4092 "being deleted, but other manipulations of keys within the loop might not "
4093 "terminate unless you also maintain an indication of which keys have been "
4098 #: ../src/guestfs.pod:2083 ../src/guestfs.pod:2088
4103 #: ../src/guestfs.pod:2085
4105 "<!-- old anchor for the next section --> <a name="
4106 "\"state_machine_and_low_level_event_api\"/>"
4108 "<!-- old anchor for the next section --> <a name="
4109 "\"state_machine_and_low_level_event_api\"/>"
4112 #: ../src/guestfs.pod:2090
4113 msgid "ARCHITECTURE"
4114 msgstr "АРХІТЕКТУРА"
4117 #: ../src/guestfs.pod:2092
4119 "Internally, libguestfs is implemented by running an appliance (a special "
4120 "type of small virtual machine) using L<qemu(1)>. Qemu runs as a child "
4121 "process of the main program."
4125 #: ../src/guestfs.pod:2096
4128 " ___________________\n"
4130 " | main program |\n"
4132 " | | child process / appliance\n"
4133 " | | __________________________\n"
4135 " +-------------------+ RPC | +-----------------+ |\n"
4136 " | libguestfs <--------------------> guestfsd | |\n"
4137 " | | | +-----------------+ |\n"
4138 " \\___________________/ | | Linux kernel | |\n"
4139 " | +--^--------------+ |\n"
4140 " \\_________|________________/\n"
4146 " \\______________/\n"
4151 #: ../src/guestfs.pod:2116
4153 "The library, linked to the main program, creates the child process and hence "
4154 "the appliance in the L</guestfs_launch> function."
4158 #: ../src/guestfs.pod:2119
4160 "Inside the appliance is a Linux kernel and a complete stack of userspace "
4161 "tools (such as LVM and ext2 programs) and a small controlling daemon called "
4162 "L</guestfsd>. The library talks to L</guestfsd> using remote procedure "
4163 "calls (RPC). There is a mostly one-to-one correspondence between libguestfs "
4164 "API calls and RPC calls to the daemon. Lastly the disk image(s) are "
4165 "attached to the qemu process which translates device access by the "
4166 "appliance's Linux kernel into accesses to the image."
4170 #: ../src/guestfs.pod:2128
4172 "A common misunderstanding is that the appliance \"is\" the virtual machine. "
4173 "Although the disk image you are attached to might also be used by some "
4174 "virtual machine, libguestfs doesn't know or care about this. (But you will "
4175 "care if both libguestfs's qemu process and your virtual machine are trying "
4176 "to update the disk image at the same time, since these usually results in "
4177 "massive disk corruption)."
4181 #: ../src/guestfs.pod:2135
4182 msgid "STATE MACHINE"
4183 msgstr "СКІНЧЕННИЙ АВТОМАТ"
4186 #: ../src/guestfs.pod:2137
4187 msgid "libguestfs uses a state machine to model the child process:"
4191 #: ../src/guestfs.pod:2139
4203 " / | \\ \\ guestfs_launch\n"
4204 " / | _\\__V______\n"
4206 " / | | LAUNCHING |\n"
4207 " / | \\___________/\n"
4209 " / | guestfs_launch\n"
4211 " ______ / __|____V\n"
4212 " / \\ ------> / \\\n"
4213 " | BUSY | | READY |\n"
4214 " \\______/ <------ \\________/\n"
4219 #: ../src/guestfs.pod:2161
4221 "The normal transitions are (1) CONFIG (when the handle is created, but there "
4222 "is no child process), (2) LAUNCHING (when the child process is booting up), "
4223 "(3) alternating between READY and BUSY as commands are issued to, and "
4224 "carried out by, the child process."
4228 #: ../src/guestfs.pod:2166
4230 "The guest may be killed by L</guestfs_kill_subprocess>, or may die "
4231 "asynchronously at any time (eg. due to some internal error), and that causes "
4232 "the state to transition back to CONFIG."
4236 #: ../src/guestfs.pod:2170
4238 "Configuration commands for qemu such as L</guestfs_add_drive> can only be "
4239 "issued when in the CONFIG state."
4243 #: ../src/guestfs.pod:2173
4245 "The API offers one call that goes from CONFIG through LAUNCHING to READY. "
4246 "L</guestfs_launch> blocks until the child process is READY to accept "
4247 "commands (or until some failure or timeout). L</guestfs_launch> internally "
4248 "moves the state from CONFIG to LAUNCHING while it is running."
4252 #: ../src/guestfs.pod:2179
4254 "API actions such as L</guestfs_mount> can only be issued when in the READY "
4255 "state. These API calls block waiting for the command to be carried out (ie. "
4256 "the state to transition to BUSY and then back to READY). There are no non-"
4257 "blocking versions, and no way to issue more than one command per handle at "
4262 #: ../src/guestfs.pod:2185
4264 "Finally, the child process sends asynchronous messages back to the main "
4265 "program, such as kernel log messages. You can register a callback to "
4266 "receive these messages."
4270 #: ../src/guestfs.pod:2189
4275 #: ../src/guestfs.pod:2191
4276 msgid "COMMUNICATION PROTOCOL"
4280 #: ../src/guestfs.pod:2193
4282 "Don't rely on using this protocol directly. This section documents how it "
4283 "currently works, but it may change at any time."
4287 #: ../src/guestfs.pod:2196
4289 "The protocol used to talk between the library and the daemon running inside "
4290 "the qemu virtual machine is a simple RPC mechanism built on top of XDR (RFC "
4291 "1014, RFC 1832, RFC 4506)."
4295 #: ../src/guestfs.pod:2200
4297 "The detailed format of structures is in C<src/guestfs_protocol.x> (note: "
4298 "this file is automatically generated)."
4302 #: ../src/guestfs.pod:2203
4304 "There are two broad cases, ordinary functions that don't have any C<FileIn> "
4305 "and C<FileOut> parameters, which are handled with very simple request/reply "
4306 "messages. Then there are functions that have any C<FileIn> or C<FileOut> "
4307 "parameters, which use the same request and reply messages, but they may also "
4308 "be followed by files sent using a chunked encoding."
4312 #: ../src/guestfs.pod:2210
4313 msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)"
4317 #: ../src/guestfs.pod:2212
4318 msgid "For ordinary functions, the request message is:"
4322 #: ../src/guestfs.pod:2214
4325 " total length (header + arguments,\n"
4326 " but not including the length word itself)\n"
4327 " struct guestfs_message_header (encoded as XDR)\n"
4328 " struct guestfs_<foo>_args (encoded as XDR)\n"
4333 #: ../src/guestfs.pod:2219
4335 "The total length field allows the daemon to allocate a fixed size buffer "
4336 "into which it slurps the rest of the message. As a result, the total length "
4337 "is limited to C<GUESTFS_MESSAGE_MAX> bytes (currently 4MB), which means the "
4338 "effective size of any request is limited to somewhere under this size."
4342 #: ../src/guestfs.pod:2225
4344 "Note also that many functions don't take any arguments, in which case the "
4345 "C<guestfs_I<foo>_args> is completely omitted."
4349 #: ../src/guestfs.pod:2228
4351 "The header contains the procedure number (C<guestfs_proc>) which is how the "
4352 "receiver knows what type of args structure to expect, or none at all."
4356 #: ../src/guestfs.pod:2232
4358 "For functions that take optional arguments, the optional arguments are "
4359 "encoded in the C<guestfs_I<foo>_args> structure in the same way as ordinary "
4360 "arguments. A bitmask in the header indicates which optional arguments are "
4361 "meaningful. The bitmask is also checked to see if it contains bits set "
4362 "which the daemon does not know about (eg. if more optional arguments were "
4363 "added in a later version of the library), and this causes the call to be "
4368 #: ../src/guestfs.pod:2240
4369 msgid "The reply message for ordinary functions is:"
4373 #: ../src/guestfs.pod:2242
4376 " total length (header + ret,\n"
4377 " but not including the length word itself)\n"
4378 " struct guestfs_message_header (encoded as XDR)\n"
4379 " struct guestfs_<foo>_ret (encoded as XDR)\n"
4384 #: ../src/guestfs.pod:2247
4386 "As above the C<guestfs_I<foo>_ret> structure may be completely omitted for "
4387 "functions that return no formal return values."
4391 #: ../src/guestfs.pod:2250
4393 "As above the total length of the reply is limited to C<GUESTFS_MESSAGE_MAX>."
4397 #: ../src/guestfs.pod:2253
4399 "In the case of an error, a flag is set in the header, and the reply message "
4400 "is slightly changed:"
4404 #: ../src/guestfs.pod:2256
4407 " total length (header + error,\n"
4408 " but not including the length word itself)\n"
4409 " struct guestfs_message_header (encoded as XDR)\n"
4410 " struct guestfs_message_error (encoded as XDR)\n"
4415 #: ../src/guestfs.pod:2261
4417 "The C<guestfs_message_error> structure contains the error message as a "
4422 #: ../src/guestfs.pod:2264
4423 msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS"
4427 #: ../src/guestfs.pod:2266
4429 "A C<FileIn> parameter indicates that we transfer a file I<into> the guest. "
4430 "The normal request message is sent (see above). However this is followed by "
4431 "a sequence of file chunks."
4435 #: ../src/guestfs.pod:2270
4438 " total length (header + arguments,\n"
4439 " but not including the length word itself,\n"
4440 " and not including the chunks)\n"
4441 " struct guestfs_message_header (encoded as XDR)\n"
4442 " struct guestfs_<foo>_args (encoded as XDR)\n"
4443 " sequence of chunks for FileIn param #0\n"
4444 " sequence of chunks for FileIn param #1 etc.\n"
4449 #: ../src/guestfs.pod:2278
4450 msgid "The \"sequence of chunks\" is:"
4454 #: ../src/guestfs.pod:2280
4457 " length of chunk (not including length word itself)\n"
4458 " struct guestfs_chunk (encoded as XDR)\n"
4459 " length of chunk\n"
4460 " struct guestfs_chunk (encoded as XDR)\n"
4462 " length of chunk\n"
4463 " struct guestfs_chunk (with data.data_len == 0)\n"
4468 #: ../src/guestfs.pod:2288
4470 "The final chunk has the C<data_len> field set to zero. Additionally a flag "
4471 "is set in the final chunk to indicate either successful completion or early "
4476 #: ../src/guestfs.pod:2292
4478 "At time of writing there are no functions that have more than one FileIn "
4479 "parameter. However this is (theoretically) supported, by sending the "
4480 "sequence of chunks for each FileIn parameter one after another (from left to "
4485 #: ../src/guestfs.pod:2297
4487 "Both the library (sender) I<and> the daemon (receiver) may cancel the "
4488 "transfer. The library does this by sending a chunk with a special flag set "
4489 "to indicate cancellation. When the daemon sees this, it cancels the whole "
4490 "RPC, does I<not> send any reply, and goes back to reading the next request."
4494 #: ../src/guestfs.pod:2303
4496 "The daemon may also cancel. It does this by writing a special word "
4497 "C<GUESTFS_CANCEL_FLAG> to the socket. The library listens for this during "
4498 "the transfer, and if it gets it, it will cancel the transfer (it sends a "
4499 "cancel chunk). The special word is chosen so that even if cancellation "
4500 "happens right at the end of the transfer (after the library has finished "
4501 "writing and has started listening for the reply), the \"spurious\" cancel "
4502 "flag will not be confused with the reply message."
4506 #: ../src/guestfs.pod:2312
4508 "This protocol allows the transfer of arbitrary sized files (no 32 bit "
4509 "limit), and also files where the size is not known in advance (eg. from "
4510 "pipes or sockets). However the chunks are rather small "
4511 "(C<GUESTFS_MAX_CHUNK_SIZE>), so that neither the library nor the daemon need "
4512 "to keep much in memory."
4516 #: ../src/guestfs.pod:2318
4517 msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS"
4521 #: ../src/guestfs.pod:2320
4523 "The protocol for FileOut parameters is exactly the same as for FileIn "
4524 "parameters, but with the roles of daemon and library reversed."
4528 #: ../src/guestfs.pod:2323
4531 " total length (header + ret,\n"
4532 " but not including the length word itself,\n"
4533 " and not including the chunks)\n"
4534 " struct guestfs_message_header (encoded as XDR)\n"
4535 " struct guestfs_<foo>_ret (encoded as XDR)\n"
4536 " sequence of chunks for FileOut param #0\n"
4537 " sequence of chunks for FileOut param #1 etc.\n"
4542 #: ../src/guestfs.pod:2331
4543 msgid "INITIAL MESSAGE"
4547 #: ../src/guestfs.pod:2333
4549 "When the daemon launches it sends an initial word (C<GUESTFS_LAUNCH_FLAG>) "
4550 "which indicates that the guest and daemon is alive. This is what L</"
4551 "guestfs_launch> waits for."
4555 #: ../src/guestfs.pod:2337
4556 msgid "PROGRESS NOTIFICATION MESSAGES"
4560 #: ../src/guestfs.pod:2339
4562 "The daemon may send progress notification messages at any time. These are "
4563 "distinguished by the normal length word being replaced by "
4564 "C<GUESTFS_PROGRESS_FLAG>, followed by a fixed size progress message."
4568 #: ../src/guestfs.pod:2343
4570 "The library turns them into progress callbacks (see L</"
4571 "GUESTFS_EVENT_PROGRESS>) if there is a callback registered, or discards them "
4576 #: ../src/guestfs.pod:2347
4578 "The daemon self-limits the frequency of progress messages it sends (see "
4579 "C<daemon/proto.c:notify_progress>). Not all calls generate progress "
4584 #: ../src/guestfs.pod:2351
4585 msgid "LIBGUESTFS VERSION NUMBERS"
4589 #: ../src/guestfs.pod:2353
4591 "Since April 2010, libguestfs has started to make separate development and "
4592 "stable releases, along with corresponding branches in our git repository. "
4593 "These separate releases can be identified by version number:"
4597 #: ../src/guestfs.pod:2358
4600 " even numbers for stable: 1.2.x, 1.4.x, ...\n"
4601 " .-------- odd numbers for development: 1.3.x, 1.5.x, ...\n"
4607 " | `-------- sub-version\n"
4609 " `------ always '1' because we don't change the ABI\n"
4614 #: ../src/guestfs.pod:2369
4615 msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"."
4619 #: ../src/guestfs.pod:2371
4621 "As time passes we cherry pick fixes from the development branch and backport "
4622 "those into the stable branch, the effect being that the stable branch should "
4623 "get more stable and less buggy over time. So the stable releases are ideal "
4624 "for people who don't need new features but would just like the software to "
4629 #: ../src/guestfs.pod:2377
4630 msgid "Our criteria for backporting changes are:"
4634 #: ../src/guestfs.pod:2383
4636 "Documentation changes which don't affect any code are backported unless the "
4637 "documentation refers to a future feature which is not in stable."
4641 #: ../src/guestfs.pod:2389
4643 "Bug fixes which are not controversial, fix obvious problems, and have been "
4644 "well tested are backported."
4648 #: ../src/guestfs.pod:2394
4650 "Simple rearrangements of code which shouldn't affect how it works get "
4651 "backported. This is so that the code in the two branches doesn't get too "
4652 "far out of step, allowing us to backport future fixes more easily."
4656 #: ../src/guestfs.pod:2400
4658 "We I<don't> backport new features, new APIs, new tools etc, except in one "
4659 "exceptional case: the new feature is required in order to implement an "
4660 "important bug fix."
4664 #: ../src/guestfs.pod:2406
4666 "A new stable branch starts when we think the new features in development are "
4667 "substantial and compelling enough over the current stable branch to warrant "
4668 "it. When that happens we create new stable and development versions 1.N.0 "
4669 "and 1.(N+1).0 [N is even]. The new dot-oh release won't necessarily be so "
4670 "stable at this point, but by backporting fixes from development, that branch "
4671 "will stabilize over time."
4675 #: ../src/guestfs.pod:2414
4676 msgid "EXTENDING LIBGUESTFS"
4680 #: ../src/guestfs.pod:2416
4681 msgid "ADDING A NEW API ACTION"
4685 #: ../src/guestfs.pod:2418
4687 "Large amounts of boilerplate code in libguestfs (RPC, bindings, "
4688 "documentation) are generated, and this makes it easy to extend the "
4693 #: ../src/guestfs.pod:2422
4694 msgid "To add a new API action there are two changes:"
4698 #: ../src/guestfs.pod:2428
4700 "You need to add a description of the call (name, parameters, return type, "
4701 "tests, documentation) to C<generator/generator_actions.ml>."
4705 #: ../src/guestfs.pod:2431
4707 "There are two sorts of API action, depending on whether the call goes "
4708 "through to the daemon in the appliance, or is serviced entirely by the "
4709 "library (see L</ARCHITECTURE> above). L</guestfs_sync> is an example of the "
4710 "former, since the sync is done in the appliance. L</guestfs_set_trace> is "
4711 "an example of the latter, since a trace flag is maintained in the handle and "
4712 "all tracing is done on the library side."
4716 #: ../src/guestfs.pod:2439
4718 "Most new actions are of the first type, and get added to the "
4719 "C<daemon_functions> list. Each function has a unique procedure number used "
4720 "in the RPC protocol which is assigned to that action when we publish "
4721 "libguestfs and cannot be reused. Take the latest procedure number and "
4726 #: ../src/guestfs.pod:2445
4728 "For library-only actions of the second type, add to the "
4729 "C<non_daemon_functions> list. Since these functions are serviced by the "
4730 "library and do not travel over the RPC mechanism to the daemon, these "
4731 "functions do not need a procedure number, and so the procedure number is set "
4736 #: ../src/guestfs.pod:2453
4737 msgid "Implement the action (in C):"
4741 #: ../src/guestfs.pod:2455
4743 "For daemon actions, implement the function C<do_E<lt>nameE<gt>> in the "
4744 "C<daemon/> directory."
4748 #: ../src/guestfs.pod:2458
4750 "For library actions, implement the function C<guestfs__E<lt>nameE<gt>> "
4751 "(note: double underscore) in the C<src/> directory."
4755 #: ../src/guestfs.pod:2461
4756 msgid "In either case, use another function as an example of what to do."
4760 #: ../src/guestfs.pod:2465
4761 msgid "After making these changes, use C<make> to compile."
4765 #: ../src/guestfs.pod:2467
4767 "Note that you don't need to implement the RPC, language bindings, manual "
4768 "pages or anything else. It's all automatically generated from the OCaml "
4773 #: ../src/guestfs.pod:2471
4774 msgid "ADDING TESTS FOR AN API ACTION"
4778 #: ../src/guestfs.pod:2473
4780 "You can supply zero or as many tests as you want per API call. The tests "
4781 "can either be added as part of the API description (C<generator/"
4782 "generator_actions.ml>), or in some rarer cases you may want to drop a script "
4783 "into C<regressions/>. Note that adding a script to C<regressions/> is "
4784 "slower, so if possible use the first method."
4788 #: ../src/guestfs.pod:2479
4790 "The following describes the test environment used when you add an API test "
4791 "in C<generator_actions.ml>."
4795 #: ../src/guestfs.pod:2482
4796 msgid "The test environment has 4 block devices:"
4800 #: ../src/guestfs.pod:2486
4801 msgid "C</dev/sda> 500MB"
4805 #: ../src/guestfs.pod:2488
4806 msgid "General block device for testing."
4810 #: ../src/guestfs.pod:2490
4811 msgid "C</dev/sdb> 50MB"
4815 #: ../src/guestfs.pod:2492
4817 "C</dev/sdb1> is an ext2 filesystem used for testing filesystem write "
4822 #: ../src/guestfs.pod:2495
4823 msgid "C</dev/sdc> 10MB"
4827 #: ../src/guestfs.pod:2497
4828 msgid "Used in a few tests where two block devices are needed."
4832 #: ../src/guestfs.pod:2499
4834 msgstr "C</dev/sdd>"
4837 #: ../src/guestfs.pod:2501
4838 msgid "ISO with fixed content (see C<images/test.iso>)."
4842 #: ../src/guestfs.pod:2505
4844 "To be able to run the tests in a reasonable amount of time, the libguestfs "
4845 "appliance and block devices are reused between tests. So don't try testing "
4846 "L</guestfs_kill_subprocess> :-x"
4850 #: ../src/guestfs.pod:2509
4852 "Each test starts with an initial scenario, selected using one of the "
4853 "C<Init*> expressions, described in C<generator/generator_types.ml>. These "
4854 "initialize the disks mentioned above in a particular way as documented in "
4855 "C<generator_types.ml>. You should not assume anything about the previous "
4856 "contents of other disks that are not initialized."
4860 #: ../src/guestfs.pod:2515
4862 "You can add a prerequisite clause to any individual test. This is a run-"
4863 "time check, which, if it fails, causes the test to be skipped. Useful if "
4864 "testing a command which might not work on all variations of libguestfs "
4865 "builds. A test that has prerequisite of C<Always> means to run "
4870 #: ../src/guestfs.pod:2521
4872 "In addition, packagers can skip individual tests by setting environment "
4873 "variables before running C<make check>."
4877 #: ../src/guestfs.pod:2524
4880 " SKIP_TEST_<CMD>_<NUM>=1\n"
4885 #: ../src/guestfs.pod:2526
4886 msgid "eg: C<SKIP_TEST_COMMAND_3=1> skips test #3 of L</guestfs_command>."
4890 #: ../src/guestfs.pod:2528
4895 #: ../src/guestfs.pod:2530
4898 " SKIP_TEST_<CMD>=1\n"
4903 #: ../src/guestfs.pod:2532
4904 msgid "eg: C<SKIP_TEST_ZEROFREE=1> skips all L</guestfs_zerofree> tests."
4908 #: ../src/guestfs.pod:2534
4909 msgid "Packagers can run only certain tests by setting for example:"
4913 #: ../src/guestfs.pod:2536
4916 " TEST_ONLY=\"vfs_type zerofree\"\n"
4921 #: ../src/guestfs.pod:2538
4923 "See C<capitests/tests.c> for more details of how these environment variables "
4928 #: ../src/guestfs.pod:2541
4929 msgid "DEBUGGING NEW API ACTIONS"
4933 #: ../src/guestfs.pod:2543
4934 msgid "Test new actions work before submitting them."
4938 #: ../src/guestfs.pod:2545
4939 msgid "You can use guestfish to try out new commands."
4943 #: ../src/guestfs.pod:2547
4945 "Debugging the daemon is a problem because it runs inside a minimal "
4946 "environment. However you can fprintf messages in the daemon to stderr, and "
4947 "they will show up if you use C<guestfish -v>."
4951 #: ../src/guestfs.pod:2551
4952 msgid "FORMATTING CODE AND OTHER CONVENTIONS"
4956 #: ../src/guestfs.pod:2553
4958 "Our C source code generally adheres to some basic code-formatting "
4959 "conventions. The existing code base is not totally consistent on this "
4960 "front, but we do prefer that contributed code be formatted similarly. In "
4961 "short, use spaces-not-TABs for indentation, use 2 spaces for each "
4962 "indentation level, and other than that, follow the K&R style."
4966 #: ../src/guestfs.pod:2559
4968 "If you use Emacs, add the following to one of one of your start-up files (e."
4969 "g., ~/.emacs), to help ensure that you get indentation right:"
4973 #: ../src/guestfs.pod:2562
4976 " ;;; In libguestfs, indent with spaces everywhere (not TABs).\n"
4977 " ;;; Exceptions: Makefile and ChangeLog modes.\n"
4978 " (add-hook 'find-file-hook\n"
4979 " '(lambda () (if (and buffer-file-name\n"
4980 " (string-match \"/libguestfs\\\\>\"\n"
4981 " (buffer-file-name))\n"
4982 " (not (string-equal mode-name \"Change Log\"))\n"
4983 " (not (string-equal mode-name \"Makefile\")))\n"
4984 " (setq indent-tabs-mode nil))))\n"
4989 #: ../src/guestfs.pod:2572
4992 " ;;; When editing C sources in libguestfs, use this style.\n"
4993 " (defun libguestfs-c-mode ()\n"
4994 " \"C mode with adjusted defaults for use with libguestfs.\"\n"
4996 " (c-set-style \"K&R\")\n"
4997 " (setq c-indent-level 2)\n"
4998 " (setq c-basic-offset 2))\n"
4999 " (add-hook 'c-mode-hook\n"
5000 " '(lambda () (if (string-match \"/libguestfs\\\\>\"\n"
5001 " (buffer-file-name))\n"
5002 " (libguestfs-c-mode))))\n"
5007 #: ../src/guestfs.pod:2584
5008 msgid "Enable warnings when compiling (and fix any problems this finds):"
5012 #: ../src/guestfs.pod:2587
5015 " ./configure --enable-gcc-warnings\n"
5020 #: ../src/guestfs.pod:2589
5021 msgid "Useful targets are:"
5025 #: ../src/guestfs.pod:2591
5028 " make syntax-check # checks the syntax of the C code\n"
5029 " make check # runs the test suite\n"
5034 #: ../src/guestfs.pod:2594
5035 msgid "DAEMON CUSTOM PRINTF FORMATTERS"
5039 #: ../src/guestfs.pod:2596
5041 "In the daemon code we have created custom printf formatters C<%Q> and C<%R>, "
5042 "which are used to do shell quoting."
5046 #: ../src/guestfs.pod:2601
5051 #: ../src/guestfs.pod:2603
5053 "Simple shell quoted string. Any spaces or other shell characters are "
5058 #: ../src/guestfs.pod:2606
5063 #: ../src/guestfs.pod:2608
5065 "Same as C<%Q> except the string is treated as a path which is prefixed by "
5070 #: ../src/guestfs.pod:2613 ../fish/guestfish.pod:242 ../fish/guestfish.pod:615
5071 msgid "For example:"
5075 #: ../src/guestfs.pod:2615
5078 " asprintf (&cmd, \"cat %R\", path);\n"
5083 #: ../src/guestfs.pod:2617
5084 msgid "would produce C<cat /sysroot/some\\ path\\ with\\ spaces>"
5088 #: ../src/guestfs.pod:2619
5090 "I<Note:> Do I<not> use these when you are passing parameters to the C<command"
5091 "{,r,v,rv}()> functions. These parameters do NOT need to be quoted because "
5092 "they are not passed via the shell (instead, straight to exec). You probably "
5093 "want to use the C<sysroot_path()> function however."
5097 #: ../src/guestfs.pod:2625
5098 msgid "SUBMITTING YOUR NEW API ACTIONS"
5102 #: ../src/guestfs.pod:2627
5104 "Submit patches to the mailing list: L<http://www.redhat.com/mailman/listinfo/"
5105 "libguestfs> and CC to L<rjones@redhat.com>."
5109 #: ../src/guestfs.pod:2631
5110 msgid "INTERNATIONALIZATION (I18N) SUPPORT"
5114 #: ../src/guestfs.pod:2633
5115 msgid "We support i18n (gettext anyhow) in the library."
5119 #: ../src/guestfs.pod:2635
5121 "However many messages come from the daemon, and we don't translate those at "
5122 "the moment. One reason is that the appliance generally has all locale files "
5123 "removed from it, because they take up a lot of space. So we'd have to readd "
5124 "some of those, as well as copying our PO files into the appliance."
5128 #: ../src/guestfs.pod:2641
5130 "Debugging messages are never translated, since they are intended for the "
5135 #: ../src/guestfs.pod:2644
5136 msgid "SOURCE CODE SUBDIRECTORIES"
5140 #: ../src/guestfs.pod:2648 ../src/guestfs-actions.pod:6106
5141 #: ../fish/guestfish-actions.pod:4041
5142 msgid "C<appliance>"
5143 msgstr "C<appliance>"
5146 #: ../src/guestfs.pod:2650
5147 msgid "The libguestfs appliance, build scripts and so on."
5151 #: ../src/guestfs.pod:2652
5152 msgid "C<capitests>"
5153 msgstr "C<capitests>"
5156 #: ../src/guestfs.pod:2654
5157 msgid "Automated tests of the C API."
5161 #: ../src/guestfs.pod:2656
5166 #: ../src/guestfs.pod:2658
5168 "The L<virt-cat(1)>, L<virt-filesystems(1)> and L<virt-ls(1)> commands and "
5173 #: ../src/guestfs.pod:2661
5180 #: ../src/guestfs.pod:2663
5182 "Safety and liveness tests of components that libguestfs depends upon (not of "
5183 "libguestfs itself). Mainly this is for qemu and the kernel."
5187 #: ../src/guestfs.pod:2666
5192 #: ../src/guestfs.pod:2668
5193 msgid "Outside contributions, experimental parts."
5197 #: ../src/guestfs.pod:2670
5202 #: ../src/guestfs.pod:2672
5204 "The daemon that runs inside the libguestfs appliance and carries out actions."
5208 #: ../src/guestfs.pod:2675
5213 #: ../src/guestfs.pod:2677
5214 msgid "L<virt-df(1)> command and documentation."
5218 #: ../src/guestfs.pod:2679
5223 #: ../src/guestfs.pod:2681
5224 msgid "L<virt-edit(1)> command and documentation."
5228 #: ../src/guestfs.pod:2683
5230 msgstr "C<examples>"
5233 #: ../src/guestfs.pod:2685
5234 msgid "C API example code."
5235 msgstr "Код прикладів використання програмного інтерфейсу мовою C."
5238 #: ../src/guestfs.pod:2687
5243 #: ../src/guestfs.pod:2689
5245 "L<guestfish(1)>, the command-line shell, and various shell scripts built on "
5246 "top such as L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, "
5247 "L<virt-tar-out(1)>."
5251 #: ../src/guestfs.pod:2693
5256 #: ../src/guestfs.pod:2695
5258 "L<guestmount(1)>, FUSE (userspace filesystem) built on top of libguestfs."
5262 #: ../src/guestfs.pod:2697
5263 msgid "C<generator>"
5264 msgstr "C<generator>"
5267 #: ../src/guestfs.pod:2699
5269 "The crucially important generator, used to automatically generate large "
5270 "amounts of boilerplate C code for things like RPC and bindings."
5274 #: ../src/guestfs.pod:2702
5279 #: ../src/guestfs.pod:2704
5280 msgid "Files used by the test suite."
5284 #: ../src/guestfs.pod:2706
5285 msgid "Some \"phony\" guest images which we test against."
5289 #: ../src/guestfs.pod:2708
5290 msgid "C<inspector>"
5291 msgstr "C<inspector>"
5294 #: ../src/guestfs.pod:2710
5295 msgid "L<virt-inspector(1)>, the virtual machine image inspector."
5299 #: ../src/guestfs.pod:2712
5304 #: ../src/guestfs.pod:2714
5305 msgid "Logo used on the website. The fish is called Arthur by the way."
5309 #: ../src/guestfs.pod:2716
5314 #: ../src/guestfs.pod:2718
5315 msgid "M4 macros used by autoconf."
5319 #: ../src/guestfs.pod:2720
5324 #: ../src/guestfs.pod:2722
5325 msgid "Translations of simple gettext strings."
5326 msgstr "Переклади простих рядків gettext."
5329 #: ../src/guestfs.pod:2724
5334 #: ../src/guestfs.pod:2726
5336 "The build infrastructure and PO files for translations of manpages and POD "
5337 "files. Eventually this will be combined with the C<po> directory, but that "
5338 "is rather complicated."
5342 #: ../src/guestfs.pod:2730
5343 msgid "C<regressions>"
5344 msgstr "C<regressions>"
5347 #: ../src/guestfs.pod:2732
5348 msgid "Regression tests."
5349 msgstr "Тести на регресії."
5352 #: ../src/guestfs.pod:2734
5357 #: ../src/guestfs.pod:2736
5358 msgid "L<virt-rescue(1)> command and documentation."
5362 #: ../src/guestfs.pod:2738
5367 #: ../src/guestfs.pod:2740
5368 msgid "Source code to the C library."
5372 #: ../src/guestfs.pod:2742
5377 #: ../src/guestfs.pod:2744
5378 msgid "Command line tools written in Perl (L<virt-resize(1)> and many others)."
5382 #: ../src/guestfs.pod:2746
5383 msgid "C<test-tool>"
5384 msgstr "C<test-tool>"
5387 #: ../src/guestfs.pod:2748
5389 "Test tool for end users to test if their qemu/kernel combination will work "
5394 #: ../src/guestfs.pod:2751
5399 #: ../src/guestfs.pod:2753
5404 #: ../src/guestfs.pod:2755
5409 #: ../src/guestfs.pod:2757
5414 #: ../src/guestfs.pod:2759
5419 #: ../src/guestfs.pod:2761
5424 #: ../src/guestfs.pod:2763
5429 #: ../src/guestfs.pod:2765
5434 #: ../src/guestfs.pod:2767
5435 msgid "Language bindings."
5436 msgstr "Прив’язки до мов програмування."
5439 #: ../src/guestfs.pod:2771
5444 #: ../src/guestfs.pod:2773
5445 msgid "PROTOCOL LIMITS"
5449 #: ../src/guestfs.pod:2775
5451 "Internally libguestfs uses a message-based protocol to pass API calls and "
5452 "their responses to and from a small \"appliance\" (see L</INTERNALS> for "
5453 "plenty more detail about this). The maximum message size used by the "
5454 "protocol is slightly less than 4 MB. For some API calls you may need to be "
5455 "aware of this limit. The API calls which may be affected are individually "
5456 "documented, with a link back to this section of the documentation."
5460 #: ../src/guestfs.pod:2783
5462 "A simple call such as L</guestfs_cat> returns its result (the file data) in "
5463 "a simple string. Because this string is at some point internally encoded as "
5464 "a message, the maximum size that it can return is slightly under 4 MB. If "
5465 "the requested file is larger than this then you will get an error."
5469 #: ../src/guestfs.pod:2789
5471 "In order to transfer large files into and out of the guest filesystem, you "
5472 "need to use particular calls that support this. The sections L</UPLOADING> "
5473 "and L</DOWNLOADING> document how to do this."
5477 #: ../src/guestfs.pod:2793
5479 "You might also consider mounting the disk image using our FUSE filesystem "
5480 "support (L<guestmount(1)>)."
5484 #: ../src/guestfs.pod:2796
5485 msgid "MAXIMUM NUMBER OF DISKS"
5489 #: ../src/guestfs.pod:2798
5490 msgid "When using virtio disks (the default) the current limit is B<25> disks."
5494 #: ../src/guestfs.pod:2801
5496 "Virtio itself consumes 1 virtual PCI slot per disk, and PCI is limited to 31 "
5497 "slots. However febootstrap only understands disks with names C</dev/vda> "
5498 "through C</dev/vdz> (26 letters) and it reserves one disk for its own "
5503 #: ../src/guestfs.pod:2806
5505 "We are working to substantially raise this limit in future versions but it "
5506 "requires complex changes to qemu."
5510 #: ../src/guestfs.pod:2809
5512 "In future versions of libguestfs it should also be possible to \"hot plug\" "
5513 "disks (add and remove disks after calling L</guestfs_launch>). This also "
5514 "requires changes to qemu."
5518 #: ../src/guestfs.pod:2813
5519 msgid "MAXIMUM NUMBER OF PARTITIONS PER DISK"
5523 #: ../src/guestfs.pod:2815
5524 msgid "Virtio limits the maximum number of partitions per disk to B<15>."
5528 #: ../src/guestfs.pod:2817
5530 "This is because it reserves 4 bits for the minor device number (thus C</dev/"
5531 "vda>, and C</dev/vda1> through C</dev/vda15>)."
5535 #: ../src/guestfs.pod:2820
5537 "If you attach a disk with more than 15 partitions, the extra partitions are "
5538 "ignored by libguestfs."
5542 #: ../src/guestfs.pod:2823
5543 msgid "MAXIMUM SIZE OF A DISK"
5547 #: ../src/guestfs.pod:2825
5548 msgid "Probably the limit is between 2**63-1 and 2**64-1 bytes."
5552 #: ../src/guestfs.pod:2827
5554 "We have tested block devices up to 1 exabyte (2**60 or "
5555 "1,152,921,504,606,846,976 bytes) using sparse files backed by an XFS host "
5560 #: ../src/guestfs.pod:2831
5562 "Although libguestfs probably does not impose any limit, the underlying host "
5563 "storage will. If you store disk images on a host ext4 filesystem, then the "
5564 "maximum size will be limited by the maximum ext4 file size (currently 16 "
5565 "TB). If you store disk images as host logical volumes then you are limited "
5566 "by the maximum size of an LV."
5570 #: ../src/guestfs.pod:2837
5572 "For the hugest disk image files, we recommend using XFS on the host for "
5577 #: ../src/guestfs.pod:2840
5578 msgid "MAXIMUM SIZE OF A PARTITION"
5582 #: ../src/guestfs.pod:2842
5584 "The MBR (ie. classic MS-DOS) partitioning scheme uses 32 bit sector "
5585 "numbers. Assuming a 512 byte sector size, this means that MBR cannot "
5586 "address a partition located beyond 2 TB on the disk."
5590 #: ../src/guestfs.pod:2846
5592 "It is recommended that you use GPT partitions on disks which are larger than "
5593 "this size. GPT uses 64 bit sector numbers and so can address partitions "
5594 "which are theoretically larger than the largest disk we could support."
5598 #: ../src/guestfs.pod:2851
5599 msgid "MAXIMUM SIZE OF A FILESYSTEM, FILES, DIRECTORIES"
5603 #: ../src/guestfs.pod:2853
5605 "This depends on the filesystem type. libguestfs itself does not impose any "
5606 "known limit. Consult Wikipedia or the filesystem documentation to find out "
5607 "what these limits are."
5611 #: ../src/guestfs.pod:2857
5612 msgid "MAXIMUM UPLOAD AND DOWNLOAD"
5616 #: ../src/guestfs.pod:2859
5618 "The API functions L</guestfs_upload>, L</guestfs_download>, L</"
5619 "guestfs_tar_in>, L</guestfs_tar_out> and the like allow unlimited sized "
5620 "uploads and downloads."
5624 #: ../src/guestfs.pod:2863
5626 #| msgid "INSPECTION"
5627 msgid "INSPECTION LIMITS"
5631 #: ../src/guestfs.pod:2865
5633 "The inspection code has several arbitrary limits on things like the size of "
5634 "Windows Registry hive it will read, and the length of product name. These "
5635 "are intended to stop a malicious guest from consuming arbitrary amounts of "
5636 "memory and disk space on the host, and should not be reached in practice. "
5637 "See the source code for more information."
5641 #: ../src/guestfs.pod:2871 ../fish/guestfish.pod:1017
5642 #: ../test-tool/libguestfs-test-tool.pod:82
5643 msgid "ENVIRONMENT VARIABLES"
5644 msgstr "ЗМІННІ СЕРЕДОВИЩА"
5647 #: ../src/guestfs.pod:2875 ../fish/guestfish.pod:1048
5648 msgid "LIBGUESTFS_APPEND"
5652 #: ../src/guestfs.pod:2877 ../fish/guestfish.pod:1050
5653 msgid "Pass additional options to the guest kernel."
5657 #: ../src/guestfs.pod:2879 ../fish/guestfish.pod:1052
5658 msgid "LIBGUESTFS_DEBUG"
5662 #: ../src/guestfs.pod:2881
5664 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
5665 "effect as calling C<guestfs_set_verbose (g, 1)>."
5669 #: ../src/guestfs.pod:2884 ../fish/guestfish.pod:1057
5670 msgid "LIBGUESTFS_MEMSIZE"
5674 #: ../src/guestfs.pod:2886 ../fish/guestfish.pod:1059
5676 "Set the memory allocated to the qemu process, in megabytes. For example:"
5680 #: ../src/guestfs.pod:2889 ../fish/guestfish.pod:1062
5683 " LIBGUESTFS_MEMSIZE=700\n"
5688 #: ../src/guestfs.pod:2891 ../fish/guestfish.pod:1064
5689 msgid "LIBGUESTFS_PATH"
5693 #: ../src/guestfs.pod:2893
5695 "Set the path that libguestfs uses to search for a supermin appliance. See "
5696 "the discussion of paths in section L</PATH> above."
5700 #: ../src/guestfs.pod:2896 ../fish/guestfish.pod:1069
5701 msgid "LIBGUESTFS_QEMU"
5705 #: ../src/guestfs.pod:2898 ../fish/guestfish.pod:1071
5707 "Set the default qemu binary that libguestfs uses. If not set, then the qemu "
5708 "which was found at compile time by the configure script is used."
5712 #: ../src/guestfs.pod:2902
5713 msgid "See also L</QEMU WRAPPERS> above."
5717 #: ../src/guestfs.pod:2904 ../fish/guestfish.pod:1075
5718 msgid "LIBGUESTFS_TRACE"
5722 #: ../src/guestfs.pod:2906
5724 "Set C<LIBGUESTFS_TRACE=1> to enable command traces. This has the same "
5725 "effect as calling C<guestfs_set_trace (g, 1)>."
5729 #: ../src/guestfs.pod:2909 ../fish/guestfish.pod:1084
5734 #: ../src/guestfs.pod:2911 ../fish/guestfish.pod:1086
5736 "Location of temporary directory, defaults to C</tmp> except for the cached "
5737 "supermin appliance which defaults to C</var/tmp>."
5741 #: ../src/guestfs.pod:2914 ../fish/guestfish.pod:1089
5743 "If libguestfs was compiled to use the supermin appliance then the real "
5744 "appliance is cached in this directory, shared between all handles belonging "
5745 "to the same EUID. You can use C<$TMPDIR> to configure another directory to "
5746 "use in case C</var/tmp> is not large enough."
5750 #: ../src/guestfs.pod:2922 ../fish/guestfish.pod:1156
5751 #: ../test-tool/libguestfs-test-tool.pod:87 ../fuse/guestmount.pod:279
5752 #: ../tools/virt-win-reg.pl:744 ../tools/virt-list-filesystems.pl:189
5753 #: ../tools/virt-tar.pl:286 ../tools/virt-make-fs.pl:539
5754 #: ../tools/virt-list-partitions.pl:257
5756 msgstr "ТАКОЖ ПЕРЕГЛЯНЬТЕ"
5759 #: ../src/guestfs.pod:2924
5761 "L<guestfs-examples(3)>, L<guestfs-ocaml(3)>, L<guestfs-python(3)>, L<guestfs-"
5762 "ruby(3)>, L<guestfish(1)>, L<guestmount(1)>, L<virt-cat(1)>, L<virt-copy-in"
5763 "(1)>, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, L<virt-filesystems"
5764 "(1)>, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, L<virt-list-"
5765 "partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, L<virt-rescue(1)>, L<virt-"
5766 "tar(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<virt-win-reg(1)>, L<qemu(1)"
5767 ">, L<febootstrap(1)>, L<hivex(3)>, L<http://libguestfs.org/>."
5771 #: ../src/guestfs.pod:2951
5773 "Tools with a similar purpose: L<fdisk(8)>, L<parted(8)>, L<kpartx(8)>, L<lvm"
5774 "(8)>, L<disktype(1)>."
5778 #: ../src/guestfs.pod:2958 ../tools/virt-win-reg.pl:759
5779 #: ../tools/virt-make-fs.pl:553
5784 #: ../src/guestfs.pod:2960
5785 msgid "To get a list of bugs against libguestfs use this link:"
5787 "Щоб переглянути список відомих вад у libguestfs, скористайтеся таким "
5791 #: ../src/guestfs.pod:2962
5793 "L<https://bugzilla.redhat.com/buglist.cgi?"
5794 "component=libguestfs&product=Virtualization+Tools>"
5796 "L<https://bugzilla.redhat.com/buglist.cgi?"
5797 "component=libguestfs&product=Virtualization+Tools>"
5800 #: ../src/guestfs.pod:2964
5801 msgid "To report a new bug against libguestfs use this link:"
5802 msgstr "Для звітування щодо вад у libguestfs скористайтеся цим посиланням:"
5805 #: ../src/guestfs.pod:2966
5807 "L<https://bugzilla.redhat.com/enter_bug.cgi?"
5808 "component=libguestfs&product=Virtualization+Tools>"
5810 "L<https://bugzilla.redhat.com/enter_bug.cgi?"
5811 "component=libguestfs&product=Virtualization+Tools>"
5814 #: ../src/guestfs.pod:2968
5815 msgid "When reporting a bug, please check:"
5819 #: ../src/guestfs.pod:2974
5820 msgid "That the bug hasn't been reported already."
5824 #: ../src/guestfs.pod:2978
5825 msgid "That you are testing a recent version."
5829 #: ../src/guestfs.pod:2982
5830 msgid "Describe the bug accurately, and give a way to reproduce it."
5834 #: ../src/guestfs.pod:2986
5836 "Run libguestfs-test-tool and paste the B<complete, unedited> output into the "
5841 #: ../src/guestfs.pod:2991 ../fish/guestfish.pod:1180
5842 #: ../test-tool/libguestfs-test-tool.pod:93 ../fuse/guestmount.pod:290
5847 #: ../src/guestfs.pod:2993 ../fish/guestfish.pod:1182
5848 #: ../test-tool/libguestfs-test-tool.pod:95 ../fuse/guestmount.pod:292
5849 msgid "Richard W.M. Jones (C<rjones at redhat dot com>)"
5853 #: ../src/guestfs.pod:2995 ../fish/guestfish.pod:1184
5854 #: ../test-tool/libguestfs-test-tool.pod:97 ../fuse/guestmount.pod:294
5855 #: ../tools/virt-win-reg.pl:774 ../tools/virt-list-filesystems.pl:206
5856 #: ../tools/virt-tar.pl:305 ../tools/virt-make-fs.pl:568
5857 #: ../tools/virt-list-partitions.pl:273
5859 msgstr "АВТОРСЬКІ ПРАВА"
5862 #: ../src/guestfs.pod:2997 ../fish/guestfish.pod:1186
5863 #: ../test-tool/libguestfs-test-tool.pod:99
5864 msgid "Copyright (C) 2009-2011 Red Hat Inc. L<http://libguestfs.org/>"
5868 #: ../src/guestfs.pod:3000
5870 "This library is free software; you can redistribute it and/or modify it "
5871 "under the terms of the GNU Lesser General Public License as published by the "
5872 "Free Software Foundation; either version 2 of the License, or (at your "
5873 "option) any later version."
5877 #: ../src/guestfs.pod:3005
5879 "This library is distributed in the hope that it will be useful, but WITHOUT "
5880 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
5881 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License "
5886 #: ../src/guestfs.pod:3010
5888 "You should have received a copy of the GNU Lesser General Public License "
5889 "along with this library; if not, write to the Free Software Foundation, "
5890 "Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA"
5894 #: ../src/guestfs-actions.pod:1
5895 msgid "guestfs_add_cdrom"
5899 #: ../src/guestfs-actions.pod:3
5903 " guestfs_add_cdrom (guestfs_h *g,\n"
5904 " const char *filename);\n"
5909 #: ../src/guestfs-actions.pod:7 ../fish/guestfish-actions.pod:5
5910 msgid "This function adds a virtual CD-ROM disk image to the guest."
5914 #: ../src/guestfs-actions.pod:9 ../fish/guestfish-actions.pod:7
5915 msgid "This is equivalent to the qemu parameter I<-cdrom filename>."
5919 #: ../src/guestfs-actions.pod:17
5921 "This call checks for the existence of C<filename>. This stops you from "
5922 "specifying other types of drive which are supported by qemu such as C<nbd:> "
5923 "and C<http:> URLs. To specify those, use the general C<guestfs_config> call "
5928 #: ../src/guestfs-actions.pod:24
5930 "If you just want to add an ISO file (often you use this as an efficient way "
5931 "to transfer large files into the guest), then you should probably use "
5932 "C<guestfs_add_drive_ro> instead."
5936 #: ../src/guestfs-actions.pod:30 ../src/guestfs-actions.pod:140
5937 #: ../src/guestfs-actions.pod:201 ../src/guestfs-actions.pod:238
5938 #: ../src/guestfs-actions.pod:252 ../src/guestfs-actions.pod:273
5939 #: ../src/guestfs-actions.pod:293 ../src/guestfs-actions.pod:307
5940 #: ../src/guestfs-actions.pod:422 ../src/guestfs-actions.pod:442
5941 #: ../src/guestfs-actions.pod:456 ../src/guestfs-actions.pod:501
5942 #: ../src/guestfs-actions.pod:529 ../src/guestfs-actions.pod:547
5943 #: ../src/guestfs-actions.pod:614 ../src/guestfs-actions.pod:647
5944 #: ../src/guestfs-actions.pod:661 ../src/guestfs-actions.pod:676
5945 #: ../src/guestfs-actions.pod:775 ../src/guestfs-actions.pod:793
5946 #: ../src/guestfs-actions.pod:807 ../src/guestfs-actions.pod:821
5947 #: ../src/guestfs-actions.pod:982 ../src/guestfs-actions.pod:1002
5948 #: ../src/guestfs-actions.pod:1020 ../src/guestfs-actions.pod:1104
5949 #: ../src/guestfs-actions.pod:1122 ../src/guestfs-actions.pod:1141
5950 #: ../src/guestfs-actions.pod:1155 ../src/guestfs-actions.pod:1175
5951 #: ../src/guestfs-actions.pod:1245 ../src/guestfs-actions.pod:1276
5952 #: ../src/guestfs-actions.pod:1301 ../src/guestfs-actions.pod:1343
5953 #: ../src/guestfs-actions.pod:1449 ../src/guestfs-actions.pod:1483
5954 #: ../src/guestfs-actions.pod:1698 ../src/guestfs-actions.pod:1720
5955 #: ../src/guestfs-actions.pod:1807 ../src/guestfs-actions.pod:2271
5956 #: ../src/guestfs-actions.pod:2415 ../src/guestfs-actions.pod:2476
5957 #: ../src/guestfs-actions.pod:2511 ../src/guestfs-actions.pod:3551
5958 #: ../src/guestfs-actions.pod:3566 ../src/guestfs-actions.pod:3591
5959 #: ../src/guestfs-actions.pod:3780 ../src/guestfs-actions.pod:3794
5960 #: ../src/guestfs-actions.pod:3807 ../src/guestfs-actions.pod:3821
5961 #: ../src/guestfs-actions.pod:3836 ../src/guestfs-actions.pod:3872
5962 #: ../src/guestfs-actions.pod:3944 ../src/guestfs-actions.pod:3964
5963 #: ../src/guestfs-actions.pod:3981 ../src/guestfs-actions.pod:4004
5964 #: ../src/guestfs-actions.pod:4027 ../src/guestfs-actions.pod:4062
5965 #: ../src/guestfs-actions.pod:4081 ../src/guestfs-actions.pod:4100
5966 #: ../src/guestfs-actions.pod:4135 ../src/guestfs-actions.pod:4147
5967 #: ../src/guestfs-actions.pod:4183 ../src/guestfs-actions.pod:4199
5968 #: ../src/guestfs-actions.pod:4212 ../src/guestfs-actions.pod:4227
5969 #: ../src/guestfs-actions.pod:4244 ../src/guestfs-actions.pod:4337
5970 #: ../src/guestfs-actions.pod:4357 ../src/guestfs-actions.pod:4370
5971 #: ../src/guestfs-actions.pod:4421 ../src/guestfs-actions.pod:4439
5972 #: ../src/guestfs-actions.pod:4457 ../src/guestfs-actions.pod:4473
5973 #: ../src/guestfs-actions.pod:4487 ../src/guestfs-actions.pod:4501
5974 #: ../src/guestfs-actions.pod:4518 ../src/guestfs-actions.pod:4533
5975 #: ../src/guestfs-actions.pod:4553 ../src/guestfs-actions.pod:4623
5976 #: ../src/guestfs-actions.pod:4696 ../src/guestfs-actions.pod:4727
5977 #: ../src/guestfs-actions.pod:4746 ../src/guestfs-actions.pod:4765
5978 #: ../src/guestfs-actions.pod:4777 ../src/guestfs-actions.pod:4794
5979 #: ../src/guestfs-actions.pod:4807 ../src/guestfs-actions.pod:4822
5980 #: ../src/guestfs-actions.pod:4837 ../src/guestfs-actions.pod:4872
5981 #: ../src/guestfs-actions.pod:4905 ../src/guestfs-actions.pod:4944
5982 #: ../src/guestfs-actions.pod:4964 ../src/guestfs-actions.pod:4978
5983 #: ../src/guestfs-actions.pod:4995 ../src/guestfs-actions.pod:5044
5984 #: ../src/guestfs-actions.pod:5090 ../src/guestfs-actions.pod:5144
5985 #: ../src/guestfs-actions.pod:5180 ../src/guestfs-actions.pod:5215
5986 #: ../src/guestfs-actions.pod:5232 ../src/guestfs-actions.pod:5250
5987 #: ../src/guestfs-actions.pod:5384 ../src/guestfs-actions.pod:5441
5988 #: ../src/guestfs-actions.pod:5463 ../src/guestfs-actions.pod:5481
5989 #: ../src/guestfs-actions.pod:5513 ../src/guestfs-actions.pod:5579
5990 #: ../src/guestfs-actions.pod:5596 ../src/guestfs-actions.pod:5609
5991 #: ../src/guestfs-actions.pod:5623 ../src/guestfs-actions.pod:5912
5992 #: ../src/guestfs-actions.pod:5931 ../src/guestfs-actions.pod:5950
5993 #: ../src/guestfs-actions.pod:5964 ../src/guestfs-actions.pod:5976
5994 #: ../src/guestfs-actions.pod:5990 ../src/guestfs-actions.pod:6002
5995 #: ../src/guestfs-actions.pod:6016 ../src/guestfs-actions.pod:6032
5996 #: ../src/guestfs-actions.pod:6053 ../src/guestfs-actions.pod:6072
5997 #: ../src/guestfs-actions.pod:6091 ../src/guestfs-actions.pod:6121
5998 #: ../src/guestfs-actions.pod:6139 ../src/guestfs-actions.pod:6162
5999 #: ../src/guestfs-actions.pod:6180 ../src/guestfs-actions.pod:6199
6000 #: ../src/guestfs-actions.pod:6220 ../src/guestfs-actions.pod:6239
6001 #: ../src/guestfs-actions.pod:6256 ../src/guestfs-actions.pod:6284
6002 #: ../src/guestfs-actions.pod:6308 ../src/guestfs-actions.pod:6327
6003 #: ../src/guestfs-actions.pod:6351 ../src/guestfs-actions.pod:6370
6004 #: ../src/guestfs-actions.pod:6385 ../src/guestfs-actions.pod:6404
6005 #: ../src/guestfs-actions.pod:6441 ../src/guestfs-actions.pod:6471
6006 #: ../src/guestfs-actions.pod:6504 ../src/guestfs-actions.pod:6626
6007 #: ../src/guestfs-actions.pod:6747 ../src/guestfs-actions.pod:6759
6008 #: ../src/guestfs-actions.pod:6772 ../src/guestfs-actions.pod:6785
6009 #: ../src/guestfs-actions.pod:6807 ../src/guestfs-actions.pod:6820
6010 #: ../src/guestfs-actions.pod:6833 ../src/guestfs-actions.pod:6846
6011 #: ../src/guestfs-actions.pod:6861 ../src/guestfs-actions.pod:6920
6012 #: ../src/guestfs-actions.pod:6937 ../src/guestfs-actions.pod:6953
6013 #: ../src/guestfs-actions.pod:6969 ../src/guestfs-actions.pod:6986
6014 #: ../src/guestfs-actions.pod:6999 ../src/guestfs-actions.pod:7019
6015 #: ../src/guestfs-actions.pod:7055 ../src/guestfs-actions.pod:7069
6016 #: ../src/guestfs-actions.pod:7110 ../src/guestfs-actions.pod:7123
6017 #: ../src/guestfs-actions.pod:7141 ../src/guestfs-actions.pod:7175
6018 #: ../src/guestfs-actions.pod:7211 ../src/guestfs-actions.pod:7327
6019 #: ../src/guestfs-actions.pod:7342 ../src/guestfs-actions.pod:7356
6020 #: ../src/guestfs-actions.pod:7411 ../src/guestfs-actions.pod:7424
6021 #: ../src/guestfs-actions.pod:7469 ../src/guestfs-actions.pod:7502
6022 #: ../src/guestfs-actions.pod:7563 ../src/guestfs-actions.pod:7589
6023 #: ../src/guestfs-actions.pod:7656 ../src/guestfs-actions.pod:7675
6024 #: ../src/guestfs-actions.pod:7704
6025 msgid "This function returns 0 on success or -1 on error."
6029 #: ../src/guestfs-actions.pod:32 ../src/guestfs-actions.pod:254
6030 #: ../src/guestfs-actions.pod:275 ../fish/guestfish-actions.pod:28
6031 #: ../fish/guestfish-actions.pod:163 ../fish/guestfish-actions.pod:177
6033 "This function is deprecated. In new code, use the C<add_drive_opts> call "
6038 #: ../src/guestfs-actions.pod:35 ../src/guestfs-actions.pod:257
6039 #: ../src/guestfs-actions.pod:278 ../src/guestfs-actions.pod:1454
6040 #: ../src/guestfs-actions.pod:1949 ../src/guestfs-actions.pod:1970
6041 #: ../src/guestfs-actions.pod:4558 ../src/guestfs-actions.pod:4877
6042 #: ../src/guestfs-actions.pod:5095 ../src/guestfs-actions.pod:5185
6043 #: ../src/guestfs-actions.pod:6449 ../src/guestfs-actions.pod:6479
6044 #: ../src/guestfs-actions.pod:6512 ../src/guestfs-actions.pod:6571
6045 #: ../src/guestfs-actions.pod:7507 ../src/guestfs-actions.pod:7597
6046 #: ../src/guestfs-actions.pod:7767 ../fish/guestfish-actions.pod:31
6047 #: ../fish/guestfish-actions.pod:166 ../fish/guestfish-actions.pod:180
6048 #: ../fish/guestfish-actions.pod:961 ../fish/guestfish-actions.pod:1321
6049 #: ../fish/guestfish-actions.pod:1335 ../fish/guestfish-actions.pod:3054
6050 #: ../fish/guestfish-actions.pod:3261 ../fish/guestfish-actions.pod:3375
6051 #: ../fish/guestfish-actions.pod:3423 ../fish/guestfish-actions.pod:4303
6052 #: ../fish/guestfish-actions.pod:4326 ../fish/guestfish-actions.pod:4348
6053 #: ../fish/guestfish-actions.pod:4386 ../fish/guestfish-actions.pod:5021
6054 #: ../fish/guestfish-actions.pod:5119
6056 "Deprecated functions will not be removed from the API, but the fact that "
6057 "they are deprecated indicates that there are problems with correct use of "
6062 #: ../src/guestfs-actions.pod:39 ../src/guestfs-actions.pod:142
6063 #: ../src/guestfs-actions.pod:1106 ../src/guestfs-actions.pod:1921
6064 #: ../src/guestfs-actions.pod:2019 ../src/guestfs-actions.pod:2122
6065 #: ../src/guestfs-actions.pod:3553 ../src/guestfs-actions.pod:3573
6066 #: ../src/guestfs-actions.pod:4881 ../src/guestfs-actions.pod:6141
6067 #: ../src/guestfs-actions.pod:6258 ../src/guestfs-actions.pod:6372
6068 #: ../src/guestfs-actions.pod:6863 ../src/guestfs-actions.pod:6988
6069 #: ../src/guestfs-actions.pod:7511
6070 msgid "(Added in 0.3)"
6074 #: ../src/guestfs-actions.pod:41
6075 msgid "guestfs_add_domain"
6079 #: ../src/guestfs-actions.pod:43
6083 " guestfs_add_domain (guestfs_h *g,\n"
6084 " const char *dom,\n"
6090 #: ../src/guestfs-actions.pod:48 ../src/guestfs-actions.pod:151
6091 #: ../src/guestfs-actions.pod:2756 ../src/guestfs-actions.pod:4572
6092 #: ../src/guestfs-actions.pod:4891 ../src/guestfs-actions.pod:5108
6094 "You may supply a list of optional arguments to this call. Use zero or more "
6095 "of the following pairs of parameters, and terminate the list with C<-1> on "
6096 "its own. See L</CALLS WITH OPTIONAL ARGUMENTS>."
6100 #: ../src/guestfs-actions.pod:53
6103 " GUESTFS_ADD_DOMAIN_LIBVIRTURI, const char *libvirturi,\n"
6104 " GUESTFS_ADD_DOMAIN_READONLY, int readonly,\n"
6105 " GUESTFS_ADD_DOMAIN_IFACE, const char *iface,\n"
6106 " GUESTFS_ADD_DOMAIN_LIVE, int live,\n"
6107 " GUESTFS_ADD_DOMAIN_ALLOWUUID, int allowuuid,\n"
6112 #: ../src/guestfs-actions.pod:59
6114 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
6115 "It works by connecting to libvirt, requesting the domain and domain XML from "
6116 "libvirt, parsing it for disks, and calling C<guestfs_add_drive_opts> on each "
6121 #: ../src/guestfs-actions.pod:64 ../fish/guestfish-actions.pod:46
6123 "The number of disks added is returned. This operation is atomic: if an "
6124 "error is returned, then no disks are added."
6128 #: ../src/guestfs-actions.pod:67 ../fish/guestfish-actions.pod:49
6130 "This function does some minimal checks to make sure the libvirt domain is "
6131 "not running (unless C<readonly> is true). In a future version we will try "
6132 "to acquire the libvirt lock on each disk."
6136 #: ../src/guestfs-actions.pod:71 ../fish/guestfish-actions.pod:53
6138 "Disks must be accessible locally. This often means that adding disks from a "
6139 "remote libvirt connection (see L<http://libvirt.org/remote.html>) will fail "
6140 "unless those disks are accessible via the same device path locally too."
6144 #: ../src/guestfs-actions.pod:76 ../fish/guestfish-actions.pod:58
6146 "The optional C<libvirturi> parameter sets the libvirt URI (see L<http://"
6147 "libvirt.org/uri.html>). If this is not set then we connect to the default "
6148 "libvirt URI (or one set through an environment variable, see the libvirt "
6149 "documentation for full details)."
6153 #: ../src/guestfs-actions.pod:82 ../fish/guestfish-actions.pod:64
6155 "The optional C<live> flag controls whether this call will try to connect to "
6156 "a running virtual machine C<guestfsd> process if it sees a suitable "
6157 "E<lt>channelE<gt> element in the libvirt XML definition. The default (if "
6158 "the flag is omitted) is never to try. See L<guestfs(3)/ATTACHING TO RUNNING "
6159 "DAEMONS> for more information."
6163 #: ../src/guestfs-actions.pod:89 ../fish/guestfish-actions.pod:71
6165 "If the C<allowuuid> flag is true (default is false) then a UUID I<may> be "
6166 "passed instead of the domain name. The C<dom> string is treated as a UUID "
6167 "first and looked up, and if that lookup fails then we treat C<dom> as a name "
6172 #: ../src/guestfs-actions.pod:94
6174 "The other optional parameters are passed directly through to "
6175 "C<guestfs_add_drive_opts>."
6179 #: ../src/guestfs-actions.pod:97 ../src/guestfs-actions.pod:350
6180 #: ../src/guestfs-actions.pod:515 ../src/guestfs-actions.pod:693
6181 #: ../src/guestfs-actions.pod:724 ../src/guestfs-actions.pod:742
6182 #: ../src/guestfs-actions.pod:761 ../src/guestfs-actions.pod:1321
6183 #: ../src/guestfs-actions.pod:1677 ../src/guestfs-actions.pod:1880
6184 #: ../src/guestfs-actions.pod:1991 ../src/guestfs-actions.pod:2031
6185 #: ../src/guestfs-actions.pod:2086 ../src/guestfs-actions.pod:2109
6186 #: ../src/guestfs-actions.pod:2402 ../src/guestfs-actions.pod:2874
6187 #: ../src/guestfs-actions.pod:2892 ../src/guestfs-actions.pod:5067
6188 #: ../src/guestfs-actions.pod:5287 ../src/guestfs-actions.pod:5693
6189 #: ../src/guestfs-actions.pod:5719 ../src/guestfs-actions.pod:7096
6190 #: ../src/guestfs-actions.pod:7522 ../src/guestfs-actions.pod:7535
6191 #: ../src/guestfs-actions.pod:7548
6192 msgid "On error this function returns -1."
6196 #: ../src/guestfs-actions.pod:99
6197 msgid "(Added in 1.7.4)"
6201 #: ../src/guestfs-actions.pod:101
6202 msgid "guestfs_add_domain_va"
6206 #: ../src/guestfs-actions.pod:103
6210 " guestfs_add_domain_va (guestfs_h *g,\n"
6211 " const char *dom,\n"
6217 #: ../src/guestfs-actions.pod:108
6218 msgid "This is the \"va_list variant\" of L</guestfs_add_domain>."
6222 #: ../src/guestfs-actions.pod:110 ../src/guestfs-actions.pod:121
6223 #: ../src/guestfs-actions.pod:214 ../src/guestfs-actions.pod:225
6224 #: ../src/guestfs-actions.pod:2840 ../src/guestfs-actions.pod:2852
6225 #: ../src/guestfs-actions.pod:4637 ../src/guestfs-actions.pod:4649
6226 #: ../src/guestfs-actions.pod:4919 ../src/guestfs-actions.pod:4931
6227 #: ../src/guestfs-actions.pod:5157 ../src/guestfs-actions.pod:5168
6228 msgid "See L</CALLS WITH OPTIONAL ARGUMENTS>."
6232 #: ../src/guestfs-actions.pod:112
6233 msgid "guestfs_add_domain_argv"
6237 #: ../src/guestfs-actions.pod:114
6241 " guestfs_add_domain_argv (guestfs_h *g,\n"
6242 " const char *dom,\n"
6243 " const struct guestfs_add_domain_argv *optargs);\n"
6248 #: ../src/guestfs-actions.pod:119
6249 msgid "This is the \"argv variant\" of L</guestfs_add_domain>."
6253 #: ../src/guestfs-actions.pod:123
6254 msgid "guestfs_add_drive"
6258 #: ../src/guestfs-actions.pod:125
6262 " guestfs_add_drive (guestfs_h *g,\n"
6263 " const char *filename);\n"
6268 #: ../src/guestfs-actions.pod:129
6270 "This function is the equivalent of calling C<guestfs_add_drive_opts> with no "
6271 "optional parameters, so the disk is added writable, with the format being "
6272 "detected automatically."
6276 #: ../src/guestfs-actions.pod:133
6278 "Automatic detection of the format opens you up to a potential security hole "
6279 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
6280 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
6281 "you should think about replacing calls to this function with calls to "
6282 "C<guestfs_add_drive_opts>, and specifying the format."
6286 #: ../src/guestfs-actions.pod:144
6287 msgid "guestfs_add_drive_opts"
6291 #: ../src/guestfs-actions.pod:146
6295 " guestfs_add_drive_opts (guestfs_h *g,\n"
6296 " const char *filename,\n"
6302 #: ../src/guestfs-actions.pod:156
6305 " GUESTFS_ADD_DRIVE_OPTS_READONLY, int readonly,\n"
6306 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, const char *format,\n"
6307 " GUESTFS_ADD_DRIVE_OPTS_IFACE, const char *iface,\n"
6312 #: ../src/guestfs-actions.pod:160 ../fish/guestfish-actions.pod:102
6314 "This function adds a virtual machine disk image C<filename> to libguestfs. "
6315 "The first time you call this function, the disk appears as C</dev/sda>, the "
6316 "second time as C</dev/sdb>, and so on."
6320 #: ../src/guestfs-actions.pod:165 ../fish/guestfish-actions.pod:107
6322 "You don't necessarily need to be root when using libguestfs. However you "
6323 "obviously do need sufficient permissions to access the filename for whatever "
6324 "operations you want to perform (ie. read access if you just want to read the "
6325 "image or write access if you want to modify the image)."
6329 #: ../src/guestfs-actions.pod:171 ../fish/guestfish-actions.pod:113
6330 msgid "This call checks that C<filename> exists."
6334 #: ../src/guestfs-actions.pod:173 ../src/guestfs-actions.pod:4585
6335 #: ../fish/guestfish-actions.pod:115 ../fish/guestfish-actions.pod:3065
6336 msgid "The optional arguments are:"
6340 #: ../src/guestfs-actions.pod:177 ../fish/guestfish-actions.pod:119
6342 msgstr "C<readonly>"
6345 #: ../src/guestfs-actions.pod:179 ../fish/guestfish-actions.pod:121
6347 "If true then the image is treated as read-only. Writes are still allowed, "
6348 "but they are stored in a temporary snapshot overlay which is discarded at "
6349 "the end. The disk that you add is not modified."
6353 #: ../src/guestfs-actions.pod:183 ../fish/guestfish-actions.pod:125
6358 #: ../src/guestfs-actions.pod:185
6360 "This forces the image format. If you omit this (or use C<guestfs_add_drive> "
6361 "or C<guestfs_add_drive_ro>) then the format is automatically detected. "
6362 "Possible formats include C<raw> and C<qcow2>."
6366 #: ../src/guestfs-actions.pod:189 ../fish/guestfish-actions.pod:131
6368 "Automatic detection of the format opens you up to a potential security hole "
6369 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
6370 "RHBZ#642934. Specifying the format closes this security hole."
6374 #: ../src/guestfs-actions.pod:194 ../fish/guestfish-actions.pod:136
6379 #: ../src/guestfs-actions.pod:196
6381 "This rarely-used option lets you emulate the behaviour of the deprecated "
6382 "C<guestfs_add_drive_with_if> call (q.v.)"
6386 #: ../src/guestfs-actions.pod:203
6387 msgid "(Added in 1.5.23)"
6391 #: ../src/guestfs-actions.pod:205
6392 msgid "guestfs_add_drive_opts_va"
6396 #: ../src/guestfs-actions.pod:207
6400 " guestfs_add_drive_opts_va (guestfs_h *g,\n"
6401 " const char *filename,\n"
6407 #: ../src/guestfs-actions.pod:212
6408 msgid "This is the \"va_list variant\" of L</guestfs_add_drive_opts>."
6412 #: ../src/guestfs-actions.pod:216
6413 msgid "guestfs_add_drive_opts_argv"
6417 #: ../src/guestfs-actions.pod:218
6421 " guestfs_add_drive_opts_argv (guestfs_h *g,\n"
6422 " const char *filename,\n"
6423 " const struct guestfs_add_drive_opts_argv *optargs);\n"
6428 #: ../src/guestfs-actions.pod:223
6429 msgid "This is the \"argv variant\" of L</guestfs_add_drive_opts>."
6433 #: ../src/guestfs-actions.pod:227
6434 msgid "guestfs_add_drive_ro"
6438 #: ../src/guestfs-actions.pod:229
6442 " guestfs_add_drive_ro (guestfs_h *g,\n"
6443 " const char *filename);\n"
6448 #: ../src/guestfs-actions.pod:233
6450 "This function is the equivalent of calling C<guestfs_add_drive_opts> with "
6451 "the optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the "
6452 "disk is added read-only, with the format being detected automatically."
6456 #: ../src/guestfs-actions.pod:240
6457 msgid "(Added in 1.0.38)"
6461 #: ../src/guestfs-actions.pod:242
6462 msgid "guestfs_add_drive_ro_with_if"
6466 #: ../src/guestfs-actions.pod:244
6470 " guestfs_add_drive_ro_with_if (guestfs_h *g,\n"
6471 " const char *filename,\n"
6472 " const char *iface);\n"
6477 #: ../src/guestfs-actions.pod:249
6479 "This is the same as C<guestfs_add_drive_ro> but it allows you to specify the "
6480 "QEMU interface emulation to use at run time."
6484 #: ../src/guestfs-actions.pod:261 ../src/guestfs-actions.pod:282
6485 #: ../src/guestfs-actions.pod:2361
6486 msgid "(Added in 1.0.84)"
6490 #: ../src/guestfs-actions.pod:263
6491 msgid "guestfs_add_drive_with_if"
6495 #: ../src/guestfs-actions.pod:265
6499 " guestfs_add_drive_with_if (guestfs_h *g,\n"
6500 " const char *filename,\n"
6501 " const char *iface);\n"
6506 #: ../src/guestfs-actions.pod:270
6508 "This is the same as C<guestfs_add_drive> but it allows you to specify the "
6509 "QEMU interface emulation to use at run time."
6513 #: ../src/guestfs-actions.pod:284
6514 msgid "guestfs_aug_clear"
6518 #: ../src/guestfs-actions.pod:286
6522 " guestfs_aug_clear (guestfs_h *g,\n"
6523 " const char *augpath);\n"
6528 #: ../src/guestfs-actions.pod:290 ../fish/guestfish-actions.pod:188
6530 "Set the value associated with C<path> to C<NULL>. This is the same as the "
6531 "L<augtool(1)> C<clear> command."
6535 #: ../src/guestfs-actions.pod:295 ../src/guestfs-actions.pod:2111
6536 msgid "(Added in 1.3.4)"
6540 #: ../src/guestfs-actions.pod:297
6541 msgid "guestfs_aug_close"
6545 #: ../src/guestfs-actions.pod:299
6549 " guestfs_aug_close (guestfs_h *g);\n"
6554 #: ../src/guestfs-actions.pod:302
6556 "Close the current Augeas handle and free up any resources used by it. After "
6557 "calling this, you have to call C<guestfs_aug_init> again before you can use "
6558 "any other Augeas functions."
6562 #: ../src/guestfs-actions.pod:309 ../src/guestfs-actions.pod:334
6563 #: ../src/guestfs-actions.pod:352 ../src/guestfs-actions.pod:366
6564 #: ../src/guestfs-actions.pod:424 ../src/guestfs-actions.pod:444
6565 #: ../src/guestfs-actions.pod:458 ../src/guestfs-actions.pod:489
6566 #: ../src/guestfs-actions.pod:503 ../src/guestfs-actions.pod:517
6567 #: ../src/guestfs-actions.pod:531 ../src/guestfs-actions.pod:549
6568 #: ../src/guestfs-actions.pod:5770
6569 msgid "(Added in 0.7)"
6573 #: ../src/guestfs-actions.pod:311
6574 msgid "guestfs_aug_defnode"
6578 #: ../src/guestfs-actions.pod:313
6581 " struct guestfs_int_bool *\n"
6582 " guestfs_aug_defnode (guestfs_h *g,\n"
6583 " const char *name,\n"
6584 " const char *expr,\n"
6585 " const char *val);\n"
6590 #: ../src/guestfs-actions.pod:319 ../fish/guestfish-actions.pod:204
6592 "Defines a variable C<name> whose value is the result of evaluating C<expr>."
6596 #: ../src/guestfs-actions.pod:322
6598 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
6599 "calling C<guestfs_aug_set> C<expr>, C<value>. C<name> will be the nodeset "
6600 "containing that single node."
6604 #: ../src/guestfs-actions.pod:326 ../fish/guestfish-actions.pod:211
6606 "On success this returns a pair containing the number of nodes in the "
6607 "nodeset, and a boolean flag if a node was created."
6611 #: ../src/guestfs-actions.pod:330
6613 "This function returns a C<struct guestfs_int_bool *>, or NULL if there was "
6614 "an error. I<The caller must call C<guestfs_free_int_bool> after use>."
6618 #: ../src/guestfs-actions.pod:336
6619 msgid "guestfs_aug_defvar"
6623 #: ../src/guestfs-actions.pod:338
6627 " guestfs_aug_defvar (guestfs_h *g,\n"
6628 " const char *name,\n"
6629 " const char *expr);\n"
6634 #: ../src/guestfs-actions.pod:343 ../fish/guestfish-actions.pod:219
6636 "Defines an Augeas variable C<name> whose value is the result of evaluating "
6637 "C<expr>. If C<expr> is NULL, then C<name> is undefined."
6641 #: ../src/guestfs-actions.pod:347 ../fish/guestfish-actions.pod:223
6643 "On success this returns the number of nodes in C<expr>, or C<0> if C<expr> "
6644 "evaluates to something which is not a nodeset."
6648 #: ../src/guestfs-actions.pod:354
6649 msgid "guestfs_aug_get"
6653 #: ../src/guestfs-actions.pod:356
6657 " guestfs_aug_get (guestfs_h *g,\n"
6658 " const char *augpath);\n"
6663 #: ../src/guestfs-actions.pod:360 ../fish/guestfish-actions.pod:230
6665 "Look up the value associated with C<path>. If C<path> matches exactly one "
6666 "node, the C<value> is returned."
6670 #: ../src/guestfs-actions.pod:363 ../src/guestfs-actions.pod:863
6671 #: ../src/guestfs-actions.pod:881 ../src/guestfs-actions.pod:941
6672 #: ../src/guestfs-actions.pod:957 ../src/guestfs-actions.pod:1060
6673 #: ../src/guestfs-actions.pod:1190 ../src/guestfs-actions.pod:1207
6674 #: ../src/guestfs-actions.pod:1226 ../src/guestfs-actions.pod:1360
6675 #: ../src/guestfs-actions.pod:1548 ../src/guestfs-actions.pod:1660
6676 #: ../src/guestfs-actions.pod:1823 ../src/guestfs-actions.pod:1840
6677 #: ../src/guestfs-actions.pod:1907 ../src/guestfs-actions.pod:1943
6678 #: ../src/guestfs-actions.pod:1964 ../src/guestfs-actions.pod:2134
6679 #: ../src/guestfs-actions.pod:2326 ../src/guestfs-actions.pod:2530
6680 #: ../src/guestfs-actions.pod:2620 ../src/guestfs-actions.pod:2724
6681 #: ../src/guestfs-actions.pod:2743 ../src/guestfs-actions.pod:2957
6682 #: ../src/guestfs-actions.pod:2985 ../src/guestfs-actions.pod:3006
6683 #: ../src/guestfs-actions.pod:3040 ../src/guestfs-actions.pod:3099
6684 #: ../src/guestfs-actions.pod:3119 ../src/guestfs-actions.pod:3139
6685 #: ../src/guestfs-actions.pod:3766 ../src/guestfs-actions.pod:4119
6686 #: ../src/guestfs-actions.pod:4289 ../src/guestfs-actions.pod:4399
6687 #: ../src/guestfs-actions.pod:5305 ../src/guestfs-actions.pod:5498
6688 #: ../src/guestfs-actions.pod:5668 ../src/guestfs-actions.pod:5846
6689 #: ../src/guestfs-actions.pod:5895 ../src/guestfs-actions.pod:6532
6690 #: ../src/guestfs-actions.pod:6548 ../src/guestfs-actions.pod:6565
6691 #: ../src/guestfs-actions.pod:6596 ../src/guestfs-actions.pod:7270
6692 #: ../src/guestfs-actions.pod:7289 ../src/guestfs-actions.pod:7307
6693 #: ../src/guestfs-actions.pod:7481 ../src/guestfs-actions.pod:7761
6695 "This function returns a string, or NULL on error. I<The caller must free "
6696 "the returned string after use>."
6700 #: ../src/guestfs-actions.pod:368
6701 msgid "guestfs_aug_init"
6705 #: ../src/guestfs-actions.pod:370
6709 " guestfs_aug_init (guestfs_h *g,\n"
6710 " const char *root,\n"
6716 #: ../src/guestfs-actions.pod:375 ../fish/guestfish-actions.pod:237
6718 "Create a new Augeas handle for editing configuration files. If there was "
6719 "any previous Augeas handle associated with this guestfs session, then it is "
6724 #: ../src/guestfs-actions.pod:379
6725 msgid "You must call this before using any other C<guestfs_aug_*> commands."
6729 #: ../src/guestfs-actions.pod:382 ../fish/guestfish-actions.pod:244
6731 "C<root> is the filesystem root. C<root> must not be NULL, use C</> instead."
6735 #: ../src/guestfs-actions.pod:385 ../fish/guestfish-actions.pod:247
6737 "The flags are the same as the flags defined in E<lt>augeas.hE<gt>, the "
6738 "logical I<or> of the following integers:"
6742 #: ../src/guestfs-actions.pod:391 ../fish/guestfish-actions.pod:253
6743 msgid "C<AUG_SAVE_BACKUP> = 1"
6744 msgstr "C<AUG_SAVE_BACKUP> = 1"
6747 #: ../src/guestfs-actions.pod:393 ../fish/guestfish-actions.pod:255
6748 msgid "Keep the original file with a C<.augsave> extension."
6752 #: ../src/guestfs-actions.pod:395 ../fish/guestfish-actions.pod:257
6753 msgid "C<AUG_SAVE_NEWFILE> = 2"
6754 msgstr "C<AUG_SAVE_NEWFILE> = 2"
6757 #: ../src/guestfs-actions.pod:397 ../fish/guestfish-actions.pod:259
6759 "Save changes into a file with extension C<.augnew>, and do not overwrite "
6760 "original. Overrides C<AUG_SAVE_BACKUP>."
6764 #: ../src/guestfs-actions.pod:400 ../fish/guestfish-actions.pod:262
6765 msgid "C<AUG_TYPE_CHECK> = 4"
6766 msgstr "C<AUG_TYPE_CHECK> = 4"
6769 #: ../src/guestfs-actions.pod:402 ../fish/guestfish-actions.pod:264
6770 msgid "Typecheck lenses (can be expensive)."
6774 #: ../src/guestfs-actions.pod:404 ../fish/guestfish-actions.pod:266
6775 msgid "C<AUG_NO_STDINC> = 8"
6776 msgstr "C<AUG_NO_STDINC> = 8"
6779 #: ../src/guestfs-actions.pod:406 ../fish/guestfish-actions.pod:268
6780 msgid "Do not use standard load path for modules."
6784 #: ../src/guestfs-actions.pod:408 ../fish/guestfish-actions.pod:270
6785 msgid "C<AUG_SAVE_NOOP> = 16"
6786 msgstr "C<AUG_SAVE_NOOP> = 16"
6789 #: ../src/guestfs-actions.pod:410 ../fish/guestfish-actions.pod:272
6790 msgid "Make save a no-op, just record what would have been changed."
6794 #: ../src/guestfs-actions.pod:412 ../fish/guestfish-actions.pod:274
6795 msgid "C<AUG_NO_LOAD> = 32"
6796 msgstr "C<AUG_NO_LOAD> = 32"
6799 #: ../src/guestfs-actions.pod:414
6800 msgid "Do not load the tree in C<guestfs_aug_init>."
6804 #: ../src/guestfs-actions.pod:418
6805 msgid "To close the handle, you can call C<guestfs_aug_close>."
6809 #: ../src/guestfs-actions.pod:420 ../fish/guestfish-actions.pod:282
6810 msgid "To find out more about Augeas, see L<http://augeas.net/>."
6814 #: ../src/guestfs-actions.pod:426
6815 msgid "guestfs_aug_insert"
6819 #: ../src/guestfs-actions.pod:428
6823 " guestfs_aug_insert (guestfs_h *g,\n"
6824 " const char *augpath,\n"
6825 " const char *label,\n"
6831 #: ../src/guestfs-actions.pod:434 ../fish/guestfish-actions.pod:288
6833 "Create a new sibling C<label> for C<path>, inserting it into the tree before "
6834 "or after C<path> (depending on the boolean flag C<before>)."
6838 #: ../src/guestfs-actions.pod:438 ../fish/guestfish-actions.pod:292
6840 "C<path> must match exactly one existing node in the tree, and C<label> must "
6841 "be a label, ie. not contain C</>, C<*> or end with a bracketed index C<[N]>."
6845 #: ../src/guestfs-actions.pod:446
6846 msgid "guestfs_aug_load"
6850 #: ../src/guestfs-actions.pod:448
6854 " guestfs_aug_load (guestfs_h *g);\n"
6859 #: ../src/guestfs-actions.pod:451 ../fish/guestfish-actions.pod:300
6860 msgid "Load files into the tree."
6861 msgstr "Завантажити файли до ієрархії."
6864 #: ../src/guestfs-actions.pod:453 ../fish/guestfish-actions.pod:302
6865 msgid "See C<aug_load> in the Augeas documentation for the full gory details."
6869 #: ../src/guestfs-actions.pod:460
6870 msgid "guestfs_aug_ls"
6874 #: ../src/guestfs-actions.pod:462
6878 " guestfs_aug_ls (guestfs_h *g,\n"
6879 " const char *augpath);\n"
6884 #: ../src/guestfs-actions.pod:466
6886 "This is just a shortcut for listing C<guestfs_aug_match> C<path/*> and "
6887 "sorting the resulting nodes into alphabetical order."
6891 #: ../src/guestfs-actions.pod:469 ../src/guestfs-actions.pod:485
6892 #: ../src/guestfs-actions.pod:631 ../src/guestfs-actions.pod:1079
6893 #: ../src/guestfs-actions.pod:1375 ../src/guestfs-actions.pod:1394
6894 #: ../src/guestfs-actions.pod:1497 ../src/guestfs-actions.pod:1516
6895 #: ../src/guestfs-actions.pod:1762 ../src/guestfs-actions.pod:2206
6896 #: ../src/guestfs-actions.pod:2222 ../src/guestfs-actions.pod:2241
6897 #: ../src/guestfs-actions.pod:2284 ../src/guestfs-actions.pod:2308
6898 #: ../src/guestfs-actions.pod:2379 ../src/guestfs-actions.pod:2428
6899 #: ../src/guestfs-actions.pod:2685 ../src/guestfs-actions.pod:3059
6900 #: ../src/guestfs-actions.pod:3335 ../src/guestfs-actions.pod:3649
6901 #: ../src/guestfs-actions.pod:3666 ../src/guestfs-actions.pod:3686
6902 #: ../src/guestfs-actions.pod:3748 ../src/guestfs-actions.pod:3853
6903 #: ../src/guestfs-actions.pod:4261 ../src/guestfs-actions.pod:5028
6904 #: ../src/guestfs-actions.pod:5640 ../src/guestfs-actions.pod:5766
6905 #: ../src/guestfs-actions.pod:5880 ../src/guestfs-actions.pod:6612
6906 #: ../src/guestfs-actions.pod:6673 ../src/guestfs-actions.pod:6728
6907 #: ../src/guestfs-actions.pod:6874 ../src/guestfs-actions.pod:6898
6908 #: ../src/guestfs-actions.pod:7374 ../src/guestfs-actions.pod:7394
6909 #: ../src/guestfs-actions.pod:7441 ../src/guestfs-actions.pod:7613
6910 #: ../src/guestfs-actions.pod:7632 ../src/guestfs-actions.pod:7718
6911 #: ../src/guestfs-actions.pod:7737 ../src/guestfs-actions.pod:7783
6912 #: ../src/guestfs-actions.pod:7802
6914 "This function returns a NULL-terminated array of strings (like L<environ(3)"
6915 ">), or NULL if there was an error. I<The caller must free the strings and "
6916 "the array after use>."
6920 #: ../src/guestfs-actions.pod:473 ../src/guestfs-actions.pod:1004
6921 #: ../src/guestfs-actions.pod:1022 ../src/guestfs-actions.pod:1432
6922 #: ../src/guestfs-actions.pod:3413 ../src/guestfs-actions.pod:3444
6923 #: ../src/guestfs-actions.pod:4102 ../src/guestfs-actions.pod:4152
6924 #: ../src/guestfs-actions.pod:4339 ../src/guestfs-actions.pod:4372
6925 #: ../src/guestfs-actions.pod:4535 ../src/guestfs-actions.pod:5032
6926 #: ../src/guestfs-actions.pod:5581 ../src/guestfs-actions.pod:5978
6927 #: ../src/guestfs-actions.pod:5992 ../src/guestfs-actions.pod:6004
6928 #: ../src/guestfs-actions.pod:6453 ../src/guestfs-actions.pod:7112
6929 #: ../src/guestfs-actions.pod:7125 ../src/guestfs-actions.pod:7358
6930 #: ../src/guestfs-actions.pod:7601
6931 msgid "(Added in 0.8)"
6935 #: ../src/guestfs-actions.pod:475
6936 msgid "guestfs_aug_match"
6940 #: ../src/guestfs-actions.pod:477
6944 " guestfs_aug_match (guestfs_h *g,\n"
6945 " const char *augpath);\n"
6950 #: ../src/guestfs-actions.pod:481 ../fish/guestfish-actions.pod:316
6952 "Returns a list of paths which match the path expression C<path>. The "
6953 "returned paths are sufficiently qualified so that they match exactly one "
6954 "node in the current tree."
6958 #: ../src/guestfs-actions.pod:491
6959 msgid "guestfs_aug_mv"
6963 #: ../src/guestfs-actions.pod:493
6967 " guestfs_aug_mv (guestfs_h *g,\n"
6968 " const char *src,\n"
6969 " const char *dest);\n"
6974 #: ../src/guestfs-actions.pod:498 ../fish/guestfish-actions.pod:324
6976 "Move the node C<src> to C<dest>. C<src> must match exactly one node. "
6977 "C<dest> is overwritten if it exists."
6981 #: ../src/guestfs-actions.pod:505
6982 msgid "guestfs_aug_rm"
6986 #: ../src/guestfs-actions.pod:507
6990 " guestfs_aug_rm (guestfs_h *g,\n"
6991 " const char *augpath);\n"
6996 #: ../src/guestfs-actions.pod:511 ../fish/guestfish-actions.pod:331
6997 msgid "Remove C<path> and all of its children."
7001 #: ../src/guestfs-actions.pod:513 ../fish/guestfish-actions.pod:333
7002 msgid "On success this returns the number of entries which were removed."
7006 #: ../src/guestfs-actions.pod:519
7007 msgid "guestfs_aug_save"
7011 #: ../src/guestfs-actions.pod:521
7015 " guestfs_aug_save (guestfs_h *g);\n"
7020 #: ../src/guestfs-actions.pod:524 ../fish/guestfish-actions.pod:339
7021 msgid "This writes all pending changes to disk."
7025 #: ../src/guestfs-actions.pod:526
7027 "The flags which were passed to C<guestfs_aug_init> affect exactly how files "
7032 #: ../src/guestfs-actions.pod:533
7033 msgid "guestfs_aug_set"
7037 #: ../src/guestfs-actions.pod:535
7041 " guestfs_aug_set (guestfs_h *g,\n"
7042 " const char *augpath,\n"
7043 " const char *val);\n"
7048 #: ../src/guestfs-actions.pod:540 ../fish/guestfish-actions.pod:348
7049 msgid "Set the value associated with C<path> to C<val>."
7053 #: ../src/guestfs-actions.pod:542
7055 "In the Augeas API, it is possible to clear a node by setting the value to "
7056 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
7057 "this call. Instead you must use the C<guestfs_aug_clear> call."
7061 #: ../src/guestfs-actions.pod:551
7062 msgid "guestfs_available"
7066 #: ../src/guestfs-actions.pod:553
7070 " guestfs_available (guestfs_h *g,\n"
7071 " char *const *groups);\n"
7076 #: ../src/guestfs-actions.pod:557 ../fish/guestfish-actions.pod:359
7078 "This command is used to check the availability of some groups of "
7079 "functionality in the appliance, which not all builds of the libguestfs "
7080 "appliance will be able to provide."
7084 #: ../src/guestfs-actions.pod:561
7086 "The libguestfs groups, and the functions that those groups correspond to, "
7087 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
7088 "runtime by calling C<guestfs_available_all_groups>."
7092 #: ../src/guestfs-actions.pod:566 ../fish/guestfish-actions.pod:368
7094 "The argument C<groups> is a list of group names, eg: C<[\"inotify\", \"augeas"
7095 "\"]> would check for the availability of the Linux inotify functions and "
7096 "Augeas (configuration file editing) functions."
7100 #: ../src/guestfs-actions.pod:571 ../fish/guestfish-actions.pod:373
7101 msgid "The command returns no error if I<all> requested groups are available."
7105 #: ../src/guestfs-actions.pod:573 ../fish/guestfish-actions.pod:375
7107 "It fails with an error if one or more of the requested groups is unavailable "
7112 #: ../src/guestfs-actions.pod:576 ../fish/guestfish-actions.pod:378
7114 "If an unknown group name is included in the list of groups then an error is "
7119 #: ../src/guestfs-actions.pod:579 ../fish/guestfish-actions.pod:381
7121 msgstr "I<Нотатки:>"
7124 #: ../src/guestfs-actions.pod:585
7125 msgid "You must call C<guestfs_launch> before calling this function."
7129 #: ../src/guestfs-actions.pod:587 ../fish/guestfish-actions.pod:389
7131 "The reason is because we don't know what groups are supported by the "
7132 "appliance/daemon until it is running and can be queried."
7136 #: ../src/guestfs-actions.pod:593 ../fish/guestfish-actions.pod:395
7138 "If a group of functions is available, this does not necessarily mean that "
7139 "they will work. You still have to check for errors when calling individual "
7140 "API functions even if they are available."
7144 #: ../src/guestfs-actions.pod:600 ../fish/guestfish-actions.pod:402
7146 "It is usually the job of distro packagers to build complete functionality "
7147 "into the libguestfs appliance. Upstream libguestfs, if built from source "
7148 "with all requirements satisfied, will support everything."
7152 #: ../src/guestfs-actions.pod:607
7154 "This call was added in version C<1.0.80>. In previous versions of "
7155 "libguestfs all you could do would be to speculatively execute a command to "
7156 "find out if the daemon implemented it. See also C<guestfs_version>."
7160 #: ../src/guestfs-actions.pod:616 ../src/guestfs-actions.pod:1177
7161 msgid "(Added in 1.0.80)"
7165 #: ../src/guestfs-actions.pod:618
7166 msgid "guestfs_available_all_groups"
7170 #: ../src/guestfs-actions.pod:620
7174 " guestfs_available_all_groups (guestfs_h *g);\n"
7179 #: ../src/guestfs-actions.pod:623
7181 "This command returns a list of all optional groups that this daemon knows "
7182 "about. Note this returns both supported and unsupported groups. To find "
7183 "out which ones the daemon can actually support you have to call "
7184 "C<guestfs_available> on each member of the returned list."
7188 #: ../src/guestfs-actions.pod:629
7189 msgid "See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>."
7193 #: ../src/guestfs-actions.pod:635
7194 msgid "(Added in 1.3.15)"
7198 #: ../src/guestfs-actions.pod:637
7199 msgid "guestfs_base64_in"
7203 #: ../src/guestfs-actions.pod:639
7207 " guestfs_base64_in (guestfs_h *g,\n"
7208 " const char *base64file,\n"
7209 " const char *filename);\n"
7214 #: ../src/guestfs-actions.pod:644 ../fish/guestfish-actions.pod:432
7216 "This command uploads base64-encoded data from C<base64file> to C<filename>."
7220 #: ../src/guestfs-actions.pod:649 ../src/guestfs-actions.pod:663
7221 msgid "(Added in 1.3.5)"
7225 #: ../src/guestfs-actions.pod:651
7226 msgid "guestfs_base64_out"
7230 #: ../src/guestfs-actions.pod:653
7234 " guestfs_base64_out (guestfs_h *g,\n"
7235 " const char *filename,\n"
7236 " const char *base64file);\n"
7241 #: ../src/guestfs-actions.pod:658 ../fish/guestfish-actions.pod:441
7243 "This command downloads the contents of C<filename>, writing it out to local "
7244 "file C<base64file> encoded as base64."
7248 #: ../src/guestfs-actions.pod:665
7249 msgid "guestfs_blockdev_flushbufs"
7253 #: ../src/guestfs-actions.pod:667
7257 " guestfs_blockdev_flushbufs (guestfs_h *g,\n"
7258 " const char *device);\n"
7263 #: ../src/guestfs-actions.pod:671 ../fish/guestfish-actions.pod:450
7265 "This tells the kernel to flush internal buffers associated with C<device>."
7269 #: ../src/guestfs-actions.pod:674 ../src/guestfs-actions.pod:691
7270 #: ../src/guestfs-actions.pod:706 ../src/guestfs-actions.pod:722
7271 #: ../src/guestfs-actions.pod:740 ../src/guestfs-actions.pod:759
7272 #: ../src/guestfs-actions.pod:773 ../src/guestfs-actions.pod:791
7273 #: ../src/guestfs-actions.pod:805 ../src/guestfs-actions.pod:819
7274 #: ../fish/guestfish-actions.pod:453 ../fish/guestfish-actions.pod:464
7275 #: ../fish/guestfish-actions.pod:473 ../fish/guestfish-actions.pod:483
7276 #: ../fish/guestfish-actions.pod:495 ../fish/guestfish-actions.pod:508
7277 #: ../fish/guestfish-actions.pod:516 ../fish/guestfish-actions.pod:527
7278 #: ../fish/guestfish-actions.pod:535 ../fish/guestfish-actions.pod:543
7279 msgid "This uses the L<blockdev(8)> command."
7283 #: ../src/guestfs-actions.pod:678 ../src/guestfs-actions.pod:695
7284 #: ../src/guestfs-actions.pod:710 ../src/guestfs-actions.pod:726
7285 #: ../src/guestfs-actions.pod:744 ../src/guestfs-actions.pod:763
7286 #: ../src/guestfs-actions.pod:777 ../src/guestfs-actions.pod:795
7287 #: ../src/guestfs-actions.pod:809 ../src/guestfs-actions.pod:823
7288 msgid "(Added in 0.9.3)"
7292 #: ../src/guestfs-actions.pod:680
7293 msgid "guestfs_blockdev_getbsz"
7297 #: ../src/guestfs-actions.pod:682
7301 " guestfs_blockdev_getbsz (guestfs_h *g,\n"
7302 " const char *device);\n"
7307 #: ../src/guestfs-actions.pod:686 ../fish/guestfish-actions.pod:459
7308 msgid "This returns the block size of a device."
7312 #: ../src/guestfs-actions.pod:688 ../src/guestfs-actions.pod:788
7313 #: ../fish/guestfish-actions.pod:461 ../fish/guestfish-actions.pod:524
7315 "(Note this is different from both I<size in blocks> and I<filesystem block "
7320 #: ../src/guestfs-actions.pod:697
7321 msgid "guestfs_blockdev_getro"
7325 #: ../src/guestfs-actions.pod:699
7329 " guestfs_blockdev_getro (guestfs_h *g,\n"
7330 " const char *device);\n"
7335 #: ../src/guestfs-actions.pod:703 ../fish/guestfish-actions.pod:470
7337 "Returns a boolean indicating if the block device is read-only (true if read-"
7338 "only, false if not)."
7342 #: ../src/guestfs-actions.pod:708 ../src/guestfs-actions.pod:1415
7343 #: ../src/guestfs-actions.pod:1430 ../src/guestfs-actions.pod:1919
7344 #: ../src/guestfs-actions.pod:1930 ../src/guestfs-actions.pod:2002
7345 #: ../src/guestfs-actions.pod:2057 ../src/guestfs-actions.pod:2072
7346 #: ../src/guestfs-actions.pod:2097 ../src/guestfs-actions.pod:2120
7347 #: ../src/guestfs-actions.pod:3156 ../src/guestfs-actions.pod:3172
7348 #: ../src/guestfs-actions.pod:3190 ../src/guestfs-actions.pod:3352
7349 #: ../src/guestfs-actions.pod:3366 ../src/guestfs-actions.pod:3381
7350 #: ../src/guestfs-actions.pod:3395 ../src/guestfs-actions.pod:3411
7351 #: ../src/guestfs-actions.pod:3426 ../src/guestfs-actions.pod:3442
7352 #: ../src/guestfs-actions.pod:3456 ../src/guestfs-actions.pod:3469
7353 #: ../src/guestfs-actions.pod:3483 ../src/guestfs-actions.pod:3498
7354 #: ../src/guestfs-actions.pod:3513 ../src/guestfs-actions.pod:3526
7355 #: ../src/guestfs-actions.pod:3540 ../src/guestfs-actions.pod:5269
7356 msgid "This function returns a C truth value on success or -1 on error."
7360 #: ../src/guestfs-actions.pod:712
7361 msgid "guestfs_blockdev_getsize64"
7365 #: ../src/guestfs-actions.pod:714
7369 " guestfs_blockdev_getsize64 (guestfs_h *g,\n"
7370 " const char *device);\n"
7375 #: ../src/guestfs-actions.pod:718 ../fish/guestfish-actions.pod:479
7376 msgid "This returns the size of the device in bytes."
7380 #: ../src/guestfs-actions.pod:720
7381 msgid "See also C<guestfs_blockdev_getsz>."
7385 #: ../src/guestfs-actions.pod:728
7386 msgid "guestfs_blockdev_getss"
7390 #: ../src/guestfs-actions.pod:730
7394 " guestfs_blockdev_getss (guestfs_h *g,\n"
7395 " const char *device);\n"
7400 #: ../src/guestfs-actions.pod:734 ../fish/guestfish-actions.pod:489
7402 "This returns the size of sectors on a block device. Usually 512, but can be "
7403 "larger for modern devices."
7407 #: ../src/guestfs-actions.pod:737
7409 "(Note, this is not the size in sectors, use C<guestfs_blockdev_getsz> for "
7414 #: ../src/guestfs-actions.pod:746
7415 msgid "guestfs_blockdev_getsz"
7419 #: ../src/guestfs-actions.pod:748
7423 " guestfs_blockdev_getsz (guestfs_h *g,\n"
7424 " const char *device);\n"
7429 #: ../src/guestfs-actions.pod:752 ../fish/guestfish-actions.pod:501
7431 "This returns the size of the device in units of 512-byte sectors (even if "
7432 "the sectorsize isn't 512 bytes ... weird)."
7436 #: ../src/guestfs-actions.pod:755
7438 "See also C<guestfs_blockdev_getss> for the real sector size of the device, "
7439 "and C<guestfs_blockdev_getsize64> for the more useful I<size in bytes>."
7443 #: ../src/guestfs-actions.pod:765
7444 msgid "guestfs_blockdev_rereadpt"
7448 #: ../src/guestfs-actions.pod:767
7452 " guestfs_blockdev_rereadpt (guestfs_h *g,\n"
7453 " const char *device);\n"
7458 #: ../src/guestfs-actions.pod:771 ../fish/guestfish-actions.pod:514
7459 msgid "Reread the partition table on C<device>."
7463 #: ../src/guestfs-actions.pod:779
7464 msgid "guestfs_blockdev_setbsz"
7468 #: ../src/guestfs-actions.pod:781
7472 " guestfs_blockdev_setbsz (guestfs_h *g,\n"
7473 " const char *device,\n"
7474 " int blocksize);\n"
7479 #: ../src/guestfs-actions.pod:786 ../fish/guestfish-actions.pod:522
7480 msgid "This sets the block size of a device."
7484 #: ../src/guestfs-actions.pod:797
7485 msgid "guestfs_blockdev_setro"
7489 #: ../src/guestfs-actions.pod:799
7493 " guestfs_blockdev_setro (guestfs_h *g,\n"
7494 " const char *device);\n"
7499 #: ../src/guestfs-actions.pod:803 ../fish/guestfish-actions.pod:533
7500 msgid "Sets the block device named C<device> to read-only."
7504 #: ../src/guestfs-actions.pod:811
7505 msgid "guestfs_blockdev_setrw"
7509 #: ../src/guestfs-actions.pod:813
7513 " guestfs_blockdev_setrw (guestfs_h *g,\n"
7514 " const char *device);\n"
7519 #: ../src/guestfs-actions.pod:817 ../fish/guestfish-actions.pod:541
7520 msgid "Sets the block device named C<device> to read-write."
7524 #: ../src/guestfs-actions.pod:825
7525 msgid "guestfs_case_sensitive_path"
7529 #: ../src/guestfs-actions.pod:827
7533 " guestfs_case_sensitive_path (guestfs_h *g,\n"
7534 " const char *path);\n"
7539 #: ../src/guestfs-actions.pod:831 ../fish/guestfish-actions.pod:549
7541 "This can be used to resolve case insensitive paths on a filesystem which is "
7542 "case sensitive. The use case is to resolve paths which you have read from "
7543 "Windows configuration files or the Windows Registry, to the true path."
7547 #: ../src/guestfs-actions.pod:836 ../fish/guestfish-actions.pod:554
7549 "The command handles a peculiarity of the Linux ntfs-3g filesystem driver "
7550 "(and probably others), which is that although the underlying filesystem is "
7551 "case-insensitive, the driver exports the filesystem to Linux as case-"
7556 #: ../src/guestfs-actions.pod:841 ../fish/guestfish-actions.pod:559
7558 "One consequence of this is that special directories such as C<c:\\windows> "
7559 "may appear as C</WINDOWS> or C</windows> (or other things) depending on the "
7560 "precise details of how they were created. In Windows itself this would not "
7565 #: ../src/guestfs-actions.pod:847 ../fish/guestfish-actions.pod:565
7567 "Bug or feature? You decide: L<http://www.tuxera.com/community/ntfs-3g-faq/"
7572 #: ../src/guestfs-actions.pod:850 ../fish/guestfish-actions.pod:568
7574 "This function resolves the true case of each element in the path and returns "
7575 "the case-sensitive path."
7579 #: ../src/guestfs-actions.pod:853
7581 "Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\") might return C<"
7582 "\"/WINDOWS/system32\"> (the exact return value would depend on details of "
7583 "how the directories were originally created under Windows)."
7587 #: ../src/guestfs-actions.pod:858 ../fish/guestfish-actions.pod:576
7588 msgid "I<Note>: This function does not handle drive names, backslashes etc."
7592 #: ../src/guestfs-actions.pod:861
7593 msgid "See also C<guestfs_realpath>."
7597 #: ../src/guestfs-actions.pod:866 ../src/guestfs-actions.pod:7292
7598 msgid "(Added in 1.0.75)"
7602 #: ../src/guestfs-actions.pod:868
7607 #: ../src/guestfs-actions.pod:870
7611 " guestfs_cat (guestfs_h *g,\n"
7612 " const char *path);\n"
7617 #: ../src/guestfs-actions.pod:874 ../src/guestfs-actions.pod:5756
7618 #: ../fish/guestfish-actions.pod:585 ../fish/guestfish-actions.pod:3800
7619 msgid "Return the contents of the file named C<path>."
7623 #: ../src/guestfs-actions.pod:876
7625 "Note that this function cannot correctly handle binary files (specifically, "
7626 "files containing C<\\0> character which is treated as end of string). For "
7627 "those you need to use the C<guestfs_read_file> or C<guestfs_download> "
7628 "functions which have a more complex interface."
7632 #: ../src/guestfs-actions.pod:884 ../src/guestfs-actions.pod:1063
7633 #: ../src/guestfs-actions.pod:1083 ../src/guestfs-actions.pod:1379
7634 #: ../src/guestfs-actions.pod:1398 ../src/guestfs-actions.pod:1501
7635 #: ../src/guestfs-actions.pod:1520 ../src/guestfs-actions.pod:1766
7636 #: ../src/guestfs-actions.pod:2226 ../src/guestfs-actions.pod:2245
7637 #: ../src/guestfs-actions.pod:2288 ../src/guestfs-actions.pod:2312
7638 #: ../src/guestfs-actions.pod:2329 ../src/guestfs-actions.pod:2358
7639 #: ../src/guestfs-actions.pod:5538 ../src/guestfs-actions.pod:5564
7640 #: ../src/guestfs-actions.pod:5695 ../src/guestfs-actions.pod:5721
7641 #: ../src/guestfs-actions.pod:5745 ../src/guestfs-actions.pod:6677
7642 #: ../src/guestfs-actions.pod:6732 ../src/guestfs-actions.pod:6878
7643 #: ../src/guestfs-actions.pod:6902 ../src/guestfs-actions.pod:7565
7644 #: ../src/guestfs-actions.pod:7591 ../src/guestfs-actions.pod:7617
7645 #: ../src/guestfs-actions.pod:7636 ../src/guestfs-actions.pod:7722
7646 #: ../src/guestfs-actions.pod:7741 ../src/guestfs-actions.pod:7787
7647 #: ../src/guestfs-actions.pod:7806 ../fish/guestfish-actions.pod:592
7648 #: ../fish/guestfish-actions.pod:727 ../fish/guestfish-actions.pod:739
7649 #: ../fish/guestfish-actions.pod:915 ../fish/guestfish-actions.pod:925
7650 #: ../fish/guestfish-actions.pod:992 ../fish/guestfish-actions.pod:1002
7651 #: ../fish/guestfish-actions.pod:1194 ../fish/guestfish-actions.pod:1495
7652 #: ../fish/guestfish-actions.pod:1505 ../fish/guestfish-actions.pod:1533
7653 #: ../fish/guestfish-actions.pod:1548 ../fish/guestfish-actions.pod:1558
7654 #: ../fish/guestfish-actions.pod:1577 ../fish/guestfish-actions.pod:3670
7655 #: ../fish/guestfish-actions.pod:3685 ../fish/guestfish-actions.pod:3761
7656 #: ../fish/guestfish-actions.pod:3778 ../fish/guestfish-actions.pod:3793
7657 #: ../fish/guestfish-actions.pod:4447 ../fish/guestfish-actions.pod:4493
7658 #: ../fish/guestfish-actions.pod:4578 ../fish/guestfish-actions.pod:4593
7659 #: ../fish/guestfish-actions.pod:4997 ../fish/guestfish-actions.pod:5015
7660 #: ../fish/guestfish-actions.pod:5032 ../fish/guestfish-actions.pod:5042
7661 #: ../fish/guestfish-actions.pod:5091 ../fish/guestfish-actions.pod:5101
7662 #: ../fish/guestfish-actions.pod:5130 ../fish/guestfish-actions.pod:5140
7664 "Because of the message protocol, there is a transfer limit of somewhere "
7665 "between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
7669 #: ../src/guestfs-actions.pod:887 ../src/guestfs-actions.pod:3670
7670 #: ../src/guestfs-actions.pod:3752 ../src/guestfs-actions.pod:3769
7671 #: ../src/guestfs-actions.pod:3857 ../src/guestfs-actions.pod:4265
7672 #: ../src/guestfs-actions.pod:4279 ../src/guestfs-actions.pod:5644
7673 #: ../src/guestfs-actions.pod:5658 ../src/guestfs-actions.pod:7445
7674 #: ../src/guestfs-actions.pod:7459
7675 msgid "(Added in 0.4)"
7679 #: ../src/guestfs-actions.pod:889
7680 msgid "guestfs_checksum"
7684 #: ../src/guestfs-actions.pod:891
7688 " guestfs_checksum (guestfs_h *g,\n"
7689 " const char *csumtype,\n"
7690 " const char *path);\n"
7695 #: ../src/guestfs-actions.pod:896 ../fish/guestfish-actions.pod:599
7697 "This call computes the MD5, SHAx or CRC checksum of the file named C<path>."
7701 #: ../src/guestfs-actions.pod:899 ../fish/guestfish-actions.pod:602
7703 "The type of checksum to compute is given by the C<csumtype> parameter which "
7704 "must have one of the following values:"
7708 #: ../src/guestfs-actions.pod:904 ../fish/guestfish-actions.pod:607
7713 #: ../src/guestfs-actions.pod:906 ../fish/guestfish-actions.pod:609
7715 "Compute the cyclic redundancy check (CRC) specified by POSIX for the "
7720 #: ../src/guestfs-actions.pod:909 ../fish/guestfish-actions.pod:612
7725 #: ../src/guestfs-actions.pod:911 ../fish/guestfish-actions.pod:614
7726 msgid "Compute the MD5 hash (using the C<md5sum> program)."
7730 #: ../src/guestfs-actions.pod:913 ../fish/guestfish-actions.pod:616
7735 #: ../src/guestfs-actions.pod:915 ../fish/guestfish-actions.pod:618
7736 msgid "Compute the SHA1 hash (using the C<sha1sum> program)."
7740 #: ../src/guestfs-actions.pod:917 ../fish/guestfish-actions.pod:620
7745 #: ../src/guestfs-actions.pod:919 ../fish/guestfish-actions.pod:622
7746 msgid "Compute the SHA224 hash (using the C<sha224sum> program)."
7750 #: ../src/guestfs-actions.pod:921 ../fish/guestfish-actions.pod:624
7755 #: ../src/guestfs-actions.pod:923 ../fish/guestfish-actions.pod:626
7756 msgid "Compute the SHA256 hash (using the C<sha256sum> program)."
7760 #: ../src/guestfs-actions.pod:925 ../fish/guestfish-actions.pod:628
7765 #: ../src/guestfs-actions.pod:927 ../fish/guestfish-actions.pod:630
7766 msgid "Compute the SHA384 hash (using the C<sha384sum> program)."
7770 #: ../src/guestfs-actions.pod:929 ../fish/guestfish-actions.pod:632
7775 #: ../src/guestfs-actions.pod:931 ../fish/guestfish-actions.pod:634
7776 msgid "Compute the SHA512 hash (using the C<sha512sum> program)."
7780 #: ../src/guestfs-actions.pod:935 ../fish/guestfish-actions.pod:638
7781 msgid "The checksum is returned as a printable string."
7785 #: ../src/guestfs-actions.pod:937
7786 msgid "To get the checksum for a device, use C<guestfs_checksum_device>."
7790 #: ../src/guestfs-actions.pod:939
7791 msgid "To get the checksums for many files, use C<guestfs_checksums_out>."
7795 #: ../src/guestfs-actions.pod:944 ../src/guestfs-actions.pod:1252
7796 #: ../src/guestfs-actions.pod:2088 ../src/guestfs-actions.pod:3368
7797 #: ../src/guestfs-actions.pod:3397 ../src/guestfs-actions.pod:3458
7798 #: ../src/guestfs-actions.pod:3485 ../src/guestfs-actions.pod:7148
7799 msgid "(Added in 1.0.2)"
7803 #: ../src/guestfs-actions.pod:946
7804 msgid "guestfs_checksum_device"
7808 #: ../src/guestfs-actions.pod:948
7812 " guestfs_checksum_device (guestfs_h *g,\n"
7813 " const char *csumtype,\n"
7814 " const char *device);\n"
7819 #: ../src/guestfs-actions.pod:953
7821 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
7822 "device named C<device>. For the types of checksums supported see the "
7823 "C<guestfs_checksum> command."
7827 #: ../src/guestfs-actions.pod:960 ../src/guestfs-actions.pod:5099
7828 #: ../src/guestfs-actions.pod:5234 ../src/guestfs-actions.pod:5271
7829 #: ../src/guestfs-actions.pod:5289 ../src/guestfs-actions.pod:5465
7830 #: ../src/guestfs-actions.pod:7057 ../src/guestfs-actions.pod:7071
7831 #: ../src/guestfs-actions.pod:7471
7832 msgid "(Added in 1.3.2)"
7836 #: ../src/guestfs-actions.pod:962
7837 msgid "guestfs_checksums_out"
7841 #: ../src/guestfs-actions.pod:964
7845 " guestfs_checksums_out (guestfs_h *g,\n"
7846 " const char *csumtype,\n"
7847 " const char *directory,\n"
7848 " const char *sumsfile);\n"
7853 #: ../src/guestfs-actions.pod:970 ../fish/guestfish-actions.pod:656
7855 "This command computes the checksums of all regular files in C<directory> and "
7856 "then emits a list of those checksums to the local output file C<sumsfile>."
7860 #: ../src/guestfs-actions.pod:974 ../fish/guestfish-actions.pod:660
7862 "This can be used for verifying the integrity of a virtual machine. However "
7863 "to be properly secure you should pay attention to the output of the checksum "
7864 "command (it uses the ones from GNU coreutils). In particular when the "
7865 "filename is not printable, coreutils uses a special backslash syntax. For "
7866 "more information, see the GNU coreutils info file."
7870 #: ../src/guestfs-actions.pod:984
7871 msgid "(Added in 1.3.7)"
7875 #: ../src/guestfs-actions.pod:986
7876 msgid "guestfs_chmod"
7880 #: ../src/guestfs-actions.pod:988
7884 " guestfs_chmod (guestfs_h *g,\n"
7886 " const char *path);\n"
7891 #: ../src/guestfs-actions.pod:993 ../fish/guestfish-actions.pod:674
7893 "Change the mode (permissions) of C<path> to C<mode>. Only numeric modes are "
7898 #: ../src/guestfs-actions.pod:996 ../fish/guestfish-actions.pod:677
7900 "I<Note>: When using this command from guestfish, C<mode> by default would be "
7901 "decimal, unless you prefix it with C<0> to get octal, ie. use C<0700> not "
7906 #: ../src/guestfs-actions.pod:1000 ../src/guestfs-actions.pod:4516
7907 #: ../src/guestfs-actions.pod:4725 ../src/guestfs-actions.pod:4744
7908 #: ../src/guestfs-actions.pod:4763 ../fish/guestfish-actions.pod:681
7909 #: ../fish/guestfish-actions.pod:3029 ../fish/guestfish-actions.pod:3168
7910 #: ../fish/guestfish-actions.pod:3178 ../fish/guestfish-actions.pod:3188
7911 msgid "The mode actually set is affected by the umask."
7915 #: ../src/guestfs-actions.pod:1006
7916 msgid "guestfs_chown"
7920 #: ../src/guestfs-actions.pod:1008
7924 " guestfs_chown (guestfs_h *g,\n"
7927 " const char *path);\n"
7932 #: ../src/guestfs-actions.pod:1014 ../fish/guestfish-actions.pod:687
7933 msgid "Change the file owner to C<owner> and group to C<group>."
7937 #: ../src/guestfs-actions.pod:1016 ../src/guestfs-actions.pod:3587
7938 #: ../fish/guestfish-actions.pod:689 ../fish/guestfish-actions.pod:2464
7940 "Only numeric uid and gid are supported. If you want to use names, you will "
7941 "need to locate and parse the password file yourself (Augeas support makes "
7942 "this relatively easy)."
7946 #: ../src/guestfs-actions.pod:1024
7947 msgid "guestfs_command"
7951 #: ../src/guestfs-actions.pod:1026
7955 " guestfs_command (guestfs_h *g,\n"
7956 " char *const *arguments);\n"
7961 #: ../src/guestfs-actions.pod:1030 ../fish/guestfish-actions.pod:697
7963 "This call runs a command from the guest filesystem. The filesystem must be "
7964 "mounted, and must contain a compatible operating system (ie. something "
7965 "Linux, with the same or compatible processor architecture)."
7969 #: ../src/guestfs-actions.pod:1035
7971 "The single parameter is an argv-style list of arguments. The first element "
7972 "is the name of the program to run. Subsequent elements are parameters. The "
7973 "list must be non-empty (ie. must contain a program name). Note that the "
7974 "command runs directly, and is I<not> invoked via the shell (see "
7979 #: ../src/guestfs-actions.pod:1042 ../fish/guestfish-actions.pod:709
7980 msgid "The return value is anything printed to I<stdout> by the command."
7984 #: ../src/guestfs-actions.pod:1045 ../fish/guestfish-actions.pod:712
7986 "If the command returns a non-zero exit status, then this function returns an "
7987 "error message. The error message string is the content of I<stderr> from "
7992 #: ../src/guestfs-actions.pod:1049 ../fish/guestfish-actions.pod:716
7994 "The C<$PATH> environment variable will contain at least C</usr/bin> and C</"
7995 "bin>. If you require a program from another location, you should provide "
7996 "the full path in the first parameter."
8000 #: ../src/guestfs-actions.pod:1054 ../fish/guestfish-actions.pod:721
8002 "Shared libraries and data files required by the program must be available on "
8003 "filesystems which are mounted in the correct places. It is the caller's "
8004 "responsibility to ensure all filesystems that are needed are mounted at the "
8009 #: ../src/guestfs-actions.pod:1066 ../src/guestfs-actions.pod:1086
8010 #: ../src/guestfs-actions.pod:1551
8011 msgid "(Added in 0.9.1)"
8015 #: ../src/guestfs-actions.pod:1068
8016 msgid "guestfs_command_lines"
8020 #: ../src/guestfs-actions.pod:1070
8024 " guestfs_command_lines (guestfs_h *g,\n"
8025 " char *const *arguments);\n"
8030 #: ../src/guestfs-actions.pod:1074
8032 "This is the same as C<guestfs_command>, but splits the result into a list of "
8037 #: ../src/guestfs-actions.pod:1077
8038 msgid "See also: C<guestfs_sh_lines>"
8042 #: ../src/guestfs-actions.pod:1088
8043 msgid "guestfs_config"
8047 #: ../src/guestfs-actions.pod:1090
8051 " guestfs_config (guestfs_h *g,\n"
8052 " const char *qemuparam,\n"
8053 " const char *qemuvalue);\n"
8058 #: ../src/guestfs-actions.pod:1095 ../fish/guestfish-actions.pod:746
8060 "This can be used to add arbitrary qemu command line parameters of the form "
8061 "I<-param value>. Actually it's not quite arbitrary - we prevent you from "
8062 "setting some parameters which would interfere with parameters that we use."
8066 #: ../src/guestfs-actions.pod:1100 ../fish/guestfish-actions.pod:751
8067 msgid "The first character of C<param> string must be a C<-> (dash)."
8071 #: ../src/guestfs-actions.pod:1102 ../fish/guestfish-actions.pod:753
8072 msgid "C<value> can be NULL."
8076 #: ../src/guestfs-actions.pod:1108
8077 msgid "guestfs_copy_size"
8081 #: ../src/guestfs-actions.pod:1110
8085 " guestfs_copy_size (guestfs_h *g,\n"
8086 " const char *src,\n"
8087 " const char *dest,\n"
8093 #: ../src/guestfs-actions.pod:1116 ../fish/guestfish-actions.pod:759
8095 "This command copies exactly C<size> bytes from one source device or file "
8096 "C<src> to another destination device or file C<dest>."
8100 #: ../src/guestfs-actions.pod:1119 ../fish/guestfish-actions.pod:762
8102 "Note this will fail if the source is too short or if the destination is not "
8107 #: ../src/guestfs-actions.pod:1124 ../src/guestfs-actions.pod:1247
8108 #: ../src/guestfs-actions.pod:1278 ../src/guestfs-actions.pod:1323
8109 #: ../src/guestfs-actions.pod:1700 ../src/guestfs-actions.pod:1722
8110 #: ../src/guestfs-actions.pod:3568 ../src/guestfs-actions.pod:7143
8111 #: ../src/guestfs-actions.pod:7177 ../src/guestfs-actions.pod:7658
8112 #: ../src/guestfs-actions.pod:7677
8114 "This long-running command can generate progress notification messages so "
8115 "that the caller can display a progress bar or indicator. To receive these "
8116 "messages, the caller must register a progress event callback. See L<guestfs"
8117 "(3)/GUESTFS_EVENT_PROGRESS>."
8121 #: ../src/guestfs-actions.pod:1129 ../src/guestfs-actions.pod:4292
8122 #: ../src/guestfs-actions.pod:5671 ../src/guestfs-actions.pod:7378
8123 #: ../src/guestfs-actions.pod:7398 ../src/guestfs-actions.pod:7484
8124 msgid "(Added in 1.0.87)"
8128 #: ../src/guestfs-actions.pod:1131
8133 #: ../src/guestfs-actions.pod:1133
8137 " guestfs_cp (guestfs_h *g,\n"
8138 " const char *src,\n"
8139 " const char *dest);\n"
8144 #: ../src/guestfs-actions.pod:1138 ../fish/guestfish-actions.pod:769
8146 "This copies a file from C<src> to C<dest> where C<dest> is either a "
8147 "destination filename or destination directory."
8151 #: ../src/guestfs-actions.pod:1143 ../src/guestfs-actions.pod:1157
8152 #: ../src/guestfs-actions.pod:1229 ../src/guestfs-actions.pod:1303
8153 #: ../src/guestfs-actions.pod:1417 ../src/guestfs-actions.pod:5046
8154 #: ../src/guestfs-actions.pod:5515
8155 msgid "(Added in 1.0.18)"
8159 #: ../src/guestfs-actions.pod:1145
8160 msgid "guestfs_cp_a"
8164 #: ../src/guestfs-actions.pod:1147
8168 " guestfs_cp_a (guestfs_h *g,\n"
8169 " const char *src,\n"
8170 " const char *dest);\n"
8175 #: ../src/guestfs-actions.pod:1152 ../fish/guestfish-actions.pod:776
8177 "This copies a file or directory from C<src> to C<dest> recursively using the "
8182 #: ../src/guestfs-actions.pod:1159
8187 #: ../src/guestfs-actions.pod:1161
8191 " guestfs_dd (guestfs_h *g,\n"
8192 " const char *src,\n"
8193 " const char *dest);\n"
8198 #: ../src/guestfs-actions.pod:1166 ../fish/guestfish-actions.pod:783
8200 "This command copies from one source device or file C<src> to another "
8201 "destination device or file C<dest>. Normally you would use this to copy to "
8202 "or from a device or partition, for example to duplicate a filesystem."
8206 #: ../src/guestfs-actions.pod:1171
8208 "If the destination is a device, it must be as large or larger than the "
8209 "source file or device, otherwise the copy will fail. This command cannot do "
8210 "partial copies (see C<guestfs_copy_size>)."
8214 #: ../src/guestfs-actions.pod:1179
8219 #: ../src/guestfs-actions.pod:1181
8223 " guestfs_df (guestfs_h *g);\n"
8228 #: ../src/guestfs-actions.pod:1184 ../fish/guestfish-actions.pod:796
8229 msgid "This command runs the C<df> command to report disk space used."
8233 #: ../src/guestfs-actions.pod:1186 ../src/guestfs-actions.pod:1203
8235 "This command is mostly useful for interactive sessions. It is I<not> "
8236 "intended that you try to parse the output string. Use C<guestfs_statvfs> "
8241 #: ../src/guestfs-actions.pod:1193 ../src/guestfs-actions.pod:1210
8242 #: ../src/guestfs-actions.pod:1328 ../src/guestfs-actions.pod:2291
8243 #: ../src/guestfs-actions.pod:2315 ../src/guestfs-actions.pod:2383
8244 #: ../src/guestfs-actions.pod:4402 ../src/guestfs-actions.pod:4946
8245 #: ../src/guestfs-actions.pod:6881 ../src/guestfs-actions.pod:6905
8246 #: ../src/guestfs-actions.pod:7524 ../src/guestfs-actions.pod:7537
8247 #: ../src/guestfs-actions.pod:7550
8248 msgid "(Added in 1.0.54)"
8252 #: ../src/guestfs-actions.pod:1195
8253 msgid "guestfs_df_h"
8257 #: ../src/guestfs-actions.pod:1197
8261 " guestfs_df_h (guestfs_h *g);\n"
8266 #: ../src/guestfs-actions.pod:1200 ../fish/guestfish-actions.pod:806
8268 "This command runs the C<df -h> command to report disk space used in human-"
8273 #: ../src/guestfs-actions.pod:1212
8274 msgid "guestfs_dmesg"
8278 #: ../src/guestfs-actions.pod:1214
8282 " guestfs_dmesg (guestfs_h *g);\n"
8287 #: ../src/guestfs-actions.pod:1217 ../fish/guestfish-actions.pod:817
8289 "This returns the kernel messages (C<dmesg> output) from the guest kernel. "
8290 "This is sometimes useful for extended debugging of problems."
8294 #: ../src/guestfs-actions.pod:1221
8296 "Another way to get the same information is to enable verbose messages with "
8297 "C<guestfs_set_verbose> or by setting the environment variable "
8298 "C<LIBGUESTFS_DEBUG=1> before running the program."
8302 #: ../src/guestfs-actions.pod:1231
8303 msgid "guestfs_download"
8307 #: ../src/guestfs-actions.pod:1233
8311 " guestfs_download (guestfs_h *g,\n"
8312 " const char *remotefilename,\n"
8313 " const char *filename);\n"
8318 #: ../src/guestfs-actions.pod:1238 ../src/guestfs-actions.pod:1263
8319 #: ../fish/guestfish-actions.pod:830 ../fish/guestfish-actions.pod:843
8321 "Download file C<remotefilename> and save it as C<filename> on the local "
8326 #: ../src/guestfs-actions.pod:1241 ../src/guestfs-actions.pod:7137
8327 #: ../fish/guestfish-actions.pod:833 ../fish/guestfish-actions.pod:4751
8328 msgid "C<filename> can also be a named pipe."
8332 #: ../src/guestfs-actions.pod:1243
8333 msgid "See also C<guestfs_upload>, C<guestfs_cat>."
8337 #: ../src/guestfs-actions.pod:1254
8338 msgid "guestfs_download_offset"
8342 #: ../src/guestfs-actions.pod:1256
8346 " guestfs_download_offset (guestfs_h *g,\n"
8347 " const char *remotefilename,\n"
8348 " const char *filename,\n"
8349 " int64_t offset,\n"
8355 #: ../src/guestfs-actions.pod:1266 ../fish/guestfish-actions.pod:846
8357 "C<remotefilename> is read for C<size> bytes starting at C<offset> (this "
8358 "region must be within the file or device)."
8362 #: ../src/guestfs-actions.pod:1269
8364 "Note that there is no limit on the amount of data that can be downloaded "
8365 "with this call, unlike with C<guestfs_pread>, and this call always reads the "
8366 "full amount unless an error occurs."
8370 #: ../src/guestfs-actions.pod:1274
8371 msgid "See also C<guestfs_download>, C<guestfs_pread>."
8375 #: ../src/guestfs-actions.pod:1283 ../src/guestfs-actions.pod:7182
8376 msgid "(Added in 1.5.17)"
8380 #: ../src/guestfs-actions.pod:1285
8381 msgid "guestfs_drop_caches"
8385 #: ../src/guestfs-actions.pod:1287
8389 " guestfs_drop_caches (guestfs_h *g,\n"
8390 " int whattodrop);\n"
8395 #: ../src/guestfs-actions.pod:1291 ../fish/guestfish-actions.pod:862
8397 "This instructs the guest kernel to drop its page cache, and/or dentries and "
8398 "inode caches. The parameter C<whattodrop> tells the kernel what precisely "
8399 "to drop, see L<http://linux-mm.org/Drop_Caches>"
8403 #: ../src/guestfs-actions.pod:1296 ../fish/guestfish-actions.pod:867
8404 msgid "Setting C<whattodrop> to 3 should drop everything."
8408 #: ../src/guestfs-actions.pod:1298 ../fish/guestfish-actions.pod:869
8410 "This automatically calls L<sync(2)> before the operation, so that the "
8411 "maximum guest memory is freed."
8415 #: ../src/guestfs-actions.pod:1305
8420 #: ../src/guestfs-actions.pod:1307
8424 " guestfs_du (guestfs_h *g,\n"
8425 " const char *path);\n"
8430 #: ../src/guestfs-actions.pod:1311 ../fish/guestfish-actions.pod:876
8432 "This command runs the C<du -s> command to estimate file space usage for "
8437 #: ../src/guestfs-actions.pod:1314 ../fish/guestfish-actions.pod:879
8439 "C<path> can be a file or a directory. If C<path> is a directory then the "
8440 "estimate includes the contents of the directory and all subdirectories "
8445 #: ../src/guestfs-actions.pod:1318 ../fish/guestfish-actions.pod:883
8447 "The result is the estimated size in I<kilobytes> (ie. units of 1024 bytes)."
8451 #: ../src/guestfs-actions.pod:1330
8452 msgid "guestfs_e2fsck_f"
8456 #: ../src/guestfs-actions.pod:1332
8460 " guestfs_e2fsck_f (guestfs_h *g,\n"
8461 " const char *device);\n"
8466 #: ../src/guestfs-actions.pod:1336 ../fish/guestfish-actions.pod:890
8468 "This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3 filesystem checker "
8469 "on C<device>, noninteractively (I<-p>), even if the filesystem appears to be "
8474 #: ../src/guestfs-actions.pod:1340
8476 "This command is only needed because of C<guestfs_resize2fs> (q.v.). "
8477 "Normally you should use C<guestfs_fsck>."
8481 #: ../src/guestfs-actions.pod:1345
8482 msgid "(Added in 1.0.29)"
8486 #: ../src/guestfs-actions.pod:1347
8487 msgid "guestfs_echo_daemon"
8491 #: ../src/guestfs-actions.pod:1349
8495 " guestfs_echo_daemon (guestfs_h *g,\n"
8496 " char *const *words);\n"
8501 #: ../src/guestfs-actions.pod:1353 ../fish/guestfish-actions.pod:901
8503 "This command concatenates the list of C<words> passed with single spaces "
8504 "between them and returns the resulting string."
8508 #: ../src/guestfs-actions.pod:1356 ../fish/guestfish-actions.pod:904
8509 msgid "You can use this command to test the connection through to the daemon."
8513 #: ../src/guestfs-actions.pod:1358
8514 msgid "See also C<guestfs_ping_daemon>."
8518 #: ../src/guestfs-actions.pod:1363 ../src/guestfs-actions.pod:2099
8519 #: ../src/guestfs-actions.pod:6353
8520 msgid "(Added in 1.0.69)"
8524 #: ../src/guestfs-actions.pod:1365
8525 msgid "guestfs_egrep"
8529 #: ../src/guestfs-actions.pod:1367
8533 " guestfs_egrep (guestfs_h *g,\n"
8534 " const char *regex,\n"
8535 " const char *path);\n"
8540 #: ../src/guestfs-actions.pod:1372 ../fish/guestfish-actions.pod:912
8542 "This calls the external C<egrep> program and returns the matching lines."
8546 #: ../src/guestfs-actions.pod:1382 ../src/guestfs-actions.pod:1401
8547 #: ../src/guestfs-actions.pod:1458 ../src/guestfs-actions.pod:1504
8548 #: ../src/guestfs-actions.pod:1523 ../src/guestfs-actions.pod:2229
8549 #: ../src/guestfs-actions.pod:2248 ../src/guestfs-actions.pod:2404
8550 #: ../src/guestfs-actions.pod:2417 ../src/guestfs-actions.pod:2432
8551 #: ../src/guestfs-actions.pod:2478 ../src/guestfs-actions.pod:2500
8552 #: ../src/guestfs-actions.pod:2513 ../src/guestfs-actions.pod:3782
8553 #: ../src/guestfs-actions.pod:3796 ../src/guestfs-actions.pod:3809
8554 #: ../src/guestfs-actions.pod:3823 ../src/guestfs-actions.pod:4824
8555 #: ../src/guestfs-actions.pod:5849 ../src/guestfs-actions.pod:5898
8556 #: ../src/guestfs-actions.pod:6749 ../src/guestfs-actions.pod:6761
8557 #: ../src/guestfs-actions.pod:6774 ../src/guestfs-actions.pod:6787
8558 #: ../src/guestfs-actions.pod:6809 ../src/guestfs-actions.pod:6822
8559 #: ../src/guestfs-actions.pod:6835 ../src/guestfs-actions.pod:6848
8560 #: ../src/guestfs-actions.pod:7620 ../src/guestfs-actions.pod:7639
8561 #: ../src/guestfs-actions.pod:7725 ../src/guestfs-actions.pod:7744
8562 #: ../src/guestfs-actions.pod:7790 ../src/guestfs-actions.pod:7809
8563 msgid "(Added in 1.0.66)"
8567 #: ../src/guestfs-actions.pod:1384
8568 msgid "guestfs_egrepi"
8572 #: ../src/guestfs-actions.pod:1386
8576 " guestfs_egrepi (guestfs_h *g,\n"
8577 " const char *regex,\n"
8578 " const char *path);\n"
8583 #: ../src/guestfs-actions.pod:1391 ../fish/guestfish-actions.pod:922
8585 "This calls the external C<egrep -i> program and returns the matching lines."
8589 #: ../src/guestfs-actions.pod:1403
8590 msgid "guestfs_equal"
8594 #: ../src/guestfs-actions.pod:1405
8598 " guestfs_equal (guestfs_h *g,\n"
8599 " const char *file1,\n"
8600 " const char *file2);\n"
8605 #: ../src/guestfs-actions.pod:1410 ../fish/guestfish-actions.pod:932
8607 "This compares the two files C<file1> and C<file2> and returns true if their "
8608 "content is exactly equal, or false otherwise."
8612 #: ../src/guestfs-actions.pod:1413 ../fish/guestfish-actions.pod:935
8613 msgid "The external L<cmp(1)> program is used for the comparison."
8617 #: ../src/guestfs-actions.pod:1419
8618 msgid "guestfs_exists"
8622 #: ../src/guestfs-actions.pod:1421
8626 " guestfs_exists (guestfs_h *g,\n"
8627 " const char *path);\n"
8632 #: ../src/guestfs-actions.pod:1425 ../fish/guestfish-actions.pod:941
8634 "This returns C<true> if and only if there is a file, directory (or anything) "
8635 "with the given C<path> name."
8639 #: ../src/guestfs-actions.pod:1428
8640 msgid "See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>."
8644 #: ../src/guestfs-actions.pod:1434
8645 msgid "guestfs_fallocate"
8649 #: ../src/guestfs-actions.pod:1436
8653 " guestfs_fallocate (guestfs_h *g,\n"
8654 " const char *path,\n"
8660 #: ../src/guestfs-actions.pod:1441 ../src/guestfs-actions.pod:1467
8661 #: ../fish/guestfish-actions.pod:950 ../fish/guestfish-actions.pod:969
8663 "This command preallocates a file (containing zero bytes) named C<path> of "
8664 "size C<len> bytes. If the file exists already, it is overwritten."
8668 #: ../src/guestfs-actions.pod:1445 ../fish/guestfish-actions.pod:954
8670 "Do not confuse this with the guestfish-specific C<alloc> command which "
8671 "allocates a file in the host and attaches it as a device."
8675 #: ../src/guestfs-actions.pod:1451 ../fish/guestfish-actions.pod:958
8677 "This function is deprecated. In new code, use the C<fallocate64> call "
8682 #: ../src/guestfs-actions.pod:1460
8683 msgid "guestfs_fallocate64"
8687 #: ../src/guestfs-actions.pod:1462
8691 " guestfs_fallocate64 (guestfs_h *g,\n"
8692 " const char *path,\n"
8698 #: ../src/guestfs-actions.pod:1471
8700 "Note that this call allocates disk blocks for the file. To create a sparse "
8701 "file use C<guestfs_truncate_size> instead."
8705 #: ../src/guestfs-actions.pod:1474
8707 "The deprecated call C<guestfs_fallocate> does the same, but owing to an "
8708 "oversight it only allowed 30 bit lengths to be specified, effectively "
8709 "limiting the maximum size of files created through that call to 1GB."
8713 #: ../src/guestfs-actions.pod:1479 ../fish/guestfish-actions.pod:981
8715 "Do not confuse this with the guestfish-specific C<alloc> and C<sparse> "
8716 "commands which create a file in the host and attach it as a device."
8720 #: ../src/guestfs-actions.pod:1485
8721 msgid "(Added in 1.3.17)"
8725 #: ../src/guestfs-actions.pod:1487
8726 msgid "guestfs_fgrep"
8730 #: ../src/guestfs-actions.pod:1489
8734 " guestfs_fgrep (guestfs_h *g,\n"
8735 " const char *pattern,\n"
8736 " const char *path);\n"
8741 #: ../src/guestfs-actions.pod:1494 ../fish/guestfish-actions.pod:989
8743 "This calls the external C<fgrep> program and returns the matching lines."
8747 #: ../src/guestfs-actions.pod:1506
8748 msgid "guestfs_fgrepi"
8752 #: ../src/guestfs-actions.pod:1508
8756 " guestfs_fgrepi (guestfs_h *g,\n"
8757 " const char *pattern,\n"
8758 " const char *path);\n"
8763 #: ../src/guestfs-actions.pod:1513 ../fish/guestfish-actions.pod:999
8765 "This calls the external C<fgrep -i> program and returns the matching lines."
8769 #: ../src/guestfs-actions.pod:1525
8770 msgid "guestfs_file"
8774 #: ../src/guestfs-actions.pod:1527
8778 " guestfs_file (guestfs_h *g,\n"
8779 " const char *path);\n"
8784 #: ../src/guestfs-actions.pod:1531 ../fish/guestfish-actions.pod:1009
8786 "This call uses the standard L<file(1)> command to determine the type or "
8787 "contents of the file."
8791 #: ../src/guestfs-actions.pod:1534 ../fish/guestfish-actions.pod:1012
8793 "This call will also transparently look inside various types of compressed "
8798 #: ../src/guestfs-actions.pod:1537 ../fish/guestfish-actions.pod:1015
8800 "The exact command which runs is C<file -zb path>. Note in particular that "
8801 "the filename is not prepended to the output (the I<-b> option)."
8805 #: ../src/guestfs-actions.pod:1541 ../fish/guestfish-actions.pod:1019
8807 "The output depends on the output of the underlying L<file(1)> command and it "
8808 "can change in future in ways beyond our control. In other words, the output "
8809 "is not guaranteed by the ABI."
8813 #: ../src/guestfs-actions.pod:1545
8815 "See also: L<file(1)>, C<guestfs_vfs_type>, C<guestfs_lstat>, "
8816 "C<guestfs_is_file>, C<guestfs_is_blockdev> (etc), C<guestfs_is_zero>."
8820 #: ../src/guestfs-actions.pod:1553
8821 msgid "guestfs_file_architecture"
8825 #: ../src/guestfs-actions.pod:1555
8829 " guestfs_file_architecture (guestfs_h *g,\n"
8830 " const char *filename);\n"
8835 #: ../src/guestfs-actions.pod:1559 ../fish/guestfish-actions.pod:1030
8837 "This detects the architecture of the binary C<filename>, and returns it if "
8842 #: ../src/guestfs-actions.pod:1562 ../fish/guestfish-actions.pod:1033
8843 msgid "Currently defined architectures are:"
8847 #: ../src/guestfs-actions.pod:1566 ../fish/guestfish-actions.pod:1037
8852 #: ../src/guestfs-actions.pod:1568 ../fish/guestfish-actions.pod:1039
8854 "This string is returned for all 32 bit i386, i486, i586, i686 binaries "
8855 "irrespective of the precise processor requirements of the binary."
8859 #: ../src/guestfs-actions.pod:1571 ../fish/guestfish-actions.pod:1042
8864 #: ../src/guestfs-actions.pod:1573 ../fish/guestfish-actions.pod:1044
8865 msgid "64 bit x86-64."
8869 #: ../src/guestfs-actions.pod:1575 ../fish/guestfish-actions.pod:1046
8874 #: ../src/guestfs-actions.pod:1577 ../fish/guestfish-actions.pod:1048
8875 msgid "32 bit SPARC."
8879 #: ../src/guestfs-actions.pod:1579 ../fish/guestfish-actions.pod:1050
8884 #: ../src/guestfs-actions.pod:1581 ../fish/guestfish-actions.pod:1052
8885 msgid "64 bit SPARC V9 and above."
8889 #: ../src/guestfs-actions.pod:1583 ../fish/guestfish-actions.pod:1054
8894 #: ../src/guestfs-actions.pod:1585 ../fish/guestfish-actions.pod:1056
8895 msgid "Intel Itanium."
8896 msgstr "Intel Itanium."
8899 #: ../src/guestfs-actions.pod:1587 ../fish/guestfish-actions.pod:1058
8904 #: ../src/guestfs-actions.pod:1589 ../fish/guestfish-actions.pod:1060
8905 msgid "32 bit Power PC."
8909 #: ../src/guestfs-actions.pod:1591 ../fish/guestfish-actions.pod:1062
8914 #: ../src/guestfs-actions.pod:1593 ../fish/guestfish-actions.pod:1064
8915 msgid "64 bit Power PC."
8919 #: ../src/guestfs-actions.pod:1597 ../fish/guestfish-actions.pod:1068
8920 msgid "Libguestfs may return other architecture strings in future."
8924 #: ../src/guestfs-actions.pod:1599 ../fish/guestfish-actions.pod:1070
8925 msgid "The function works on at least the following types of files:"
8929 #: ../src/guestfs-actions.pod:1605 ../fish/guestfish-actions.pod:1076
8930 msgid "many types of Un*x and Linux binary"
8934 #: ../src/guestfs-actions.pod:1609 ../fish/guestfish-actions.pod:1080
8935 msgid "many types of Un*x and Linux shared library"
8939 #: ../src/guestfs-actions.pod:1613 ../fish/guestfish-actions.pod:1084
8940 msgid "Windows Win32 and Win64 binaries"
8944 #: ../src/guestfs-actions.pod:1617 ../fish/guestfish-actions.pod:1088
8945 msgid "Windows Win32 and Win64 DLLs"
8949 #: ../src/guestfs-actions.pod:1619 ../fish/guestfish-actions.pod:1090
8950 msgid "Win32 binaries and DLLs return C<i386>."
8954 #: ../src/guestfs-actions.pod:1621 ../fish/guestfish-actions.pod:1092
8955 msgid "Win64 binaries and DLLs return C<x86_64>."
8959 #: ../src/guestfs-actions.pod:1625 ../fish/guestfish-actions.pod:1096
8960 msgid "Linux kernel modules"
8964 #: ../src/guestfs-actions.pod:1629 ../fish/guestfish-actions.pod:1100
8965 msgid "Linux new-style initrd images"
8969 #: ../src/guestfs-actions.pod:1633 ../fish/guestfish-actions.pod:1104
8970 msgid "some non-x86 Linux vmlinuz kernels"
8974 #: ../src/guestfs-actions.pod:1637 ../fish/guestfish-actions.pod:1108
8975 msgid "What it can't do currently:"
8979 #: ../src/guestfs-actions.pod:1643 ../fish/guestfish-actions.pod:1114
8980 msgid "static libraries (libfoo.a)"
8984 #: ../src/guestfs-actions.pod:1647 ../fish/guestfish-actions.pod:1118
8985 msgid "Linux old-style initrd as compressed ext2 filesystem (RHEL 3)"
8989 #: ../src/guestfs-actions.pod:1651 ../fish/guestfish-actions.pod:1122
8990 msgid "x86 Linux vmlinuz kernels"
8994 #: ../src/guestfs-actions.pod:1653 ../fish/guestfish-actions.pod:1124
8996 "x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and "
8997 "compressed code, and are horribly hard to unpack. If you want to find the "
8998 "architecture of a kernel, use the architecture of the associated initrd or "
8999 "kernel module(s) instead."
9003 #: ../src/guestfs-actions.pod:1663 ../src/guestfs-actions.pod:1826
9004 #: ../src/guestfs-actions.pod:1843 ../src/guestfs-actions.pod:2533
9005 #: ../src/guestfs-actions.pod:2623 ../src/guestfs-actions.pod:2689
9006 #: ../src/guestfs-actions.pod:2876 ../src/guestfs-actions.pod:2894
9007 #: ../src/guestfs-actions.pod:2934 ../src/guestfs-actions.pod:3009
9008 #: ../src/guestfs-actions.pod:3102 ../src/guestfs-actions.pod:3339
9009 #: ../src/guestfs-actions.pod:3471
9010 msgid "(Added in 1.5.3)"
9014 #: ../src/guestfs-actions.pod:1665
9015 msgid "guestfs_filesize"
9019 #: ../src/guestfs-actions.pod:1667
9023 " guestfs_filesize (guestfs_h *g,\n"
9024 " const char *file);\n"
9029 #: ../src/guestfs-actions.pod:1671 ../fish/guestfish-actions.pod:1135
9030 msgid "This command returns the size of C<file> in bytes."
9034 #: ../src/guestfs-actions.pod:1673
9036 "To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>, "
9037 "C<guestfs_is_dir>, C<guestfs_is_file> etc. To get the size of block "
9038 "devices, use C<guestfs_blockdev_getsize64>."
9042 #: ../src/guestfs-actions.pod:1679
9043 msgid "(Added in 1.0.82)"
9047 #: ../src/guestfs-actions.pod:1681
9048 msgid "guestfs_fill"
9052 #: ../src/guestfs-actions.pod:1683
9056 " guestfs_fill (guestfs_h *g,\n"
9059 " const char *path);\n"
9064 #: ../src/guestfs-actions.pod:1689 ../fish/guestfish-actions.pod:1145
9066 "This command creates a new file called C<path>. The initial content of the "
9067 "file is C<len> octets of C<c>, where C<c> must be a number in the range C<"
9072 #: ../src/guestfs-actions.pod:1693
9074 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
9075 "C<guestfs_truncate_size>. To create a file with a pattern of repeating "
9076 "bytes use C<guestfs_fill_pattern>."
9080 #: ../src/guestfs-actions.pod:1705
9081 msgid "(Added in 1.0.79)"
9085 #: ../src/guestfs-actions.pod:1707
9086 msgid "guestfs_fill_pattern"
9090 #: ../src/guestfs-actions.pod:1709
9094 " guestfs_fill_pattern (guestfs_h *g,\n"
9095 " const char *pattern,\n"
9097 " const char *path);\n"
9102 #: ../src/guestfs-actions.pod:1715
9104 "This function is like C<guestfs_fill> except that it creates a new file of "
9105 "length C<len> containing the repeating pattern of bytes in C<pattern>. The "
9106 "pattern is truncated if necessary to ensure the length of the file is "
9107 "exactly C<len> bytes."
9111 #: ../src/guestfs-actions.pod:1727
9112 msgid "(Added in 1.3.12)"
9116 #: ../src/guestfs-actions.pod:1729
9117 msgid "guestfs_find"
9121 #: ../src/guestfs-actions.pod:1731
9125 " guestfs_find (guestfs_h *g,\n"
9126 " const char *directory);\n"
9131 #: ../src/guestfs-actions.pod:1735 ../fish/guestfish-actions.pod:1167
9133 "This command lists out all files and directories, recursively, starting at "
9134 "C<directory>. It is essentially equivalent to running the shell command "
9135 "C<find directory -print> but some post-processing happens on the output, "
9140 #: ../src/guestfs-actions.pod:1740 ../fish/guestfish-actions.pod:1172
9142 "This returns a list of strings I<without any prefix>. Thus if the directory "
9147 #: ../src/guestfs-actions.pod:1743 ../fish/guestfish-actions.pod:1175
9157 #: ../src/guestfs-actions.pod:1747
9159 "then the returned list from C<guestfs_find> C</tmp> would be 4 elements:"
9163 #: ../src/guestfs-actions.pod:1750 ../fish/guestfish-actions.pod:1182
9174 #: ../src/guestfs-actions.pod:1755 ../fish/guestfish-actions.pod:1187
9175 msgid "If C<directory> is not a directory, then this command returns an error."
9179 #: ../src/guestfs-actions.pod:1758 ../fish/guestfish-actions.pod:1190
9180 msgid "The returned list is sorted."
9184 #: ../src/guestfs-actions.pod:1760
9185 msgid "See also C<guestfs_find0>."
9189 #: ../src/guestfs-actions.pod:1769 ../src/guestfs-actions.pod:4229
9190 #: ../src/guestfs-actions.pod:5933
9191 msgid "(Added in 1.0.27)"
9195 #: ../src/guestfs-actions.pod:1771
9196 msgid "guestfs_find0"
9200 #: ../src/guestfs-actions.pod:1773
9204 " guestfs_find0 (guestfs_h *g,\n"
9205 " const char *directory,\n"
9206 " const char *files);\n"
9211 #: ../src/guestfs-actions.pod:1778 ../fish/guestfish-actions.pod:1201
9213 "This command lists out all files and directories, recursively, starting at "
9214 "C<directory>, placing the resulting list in the external file called "
9219 #: ../src/guestfs-actions.pod:1782
9221 "This command works the same way as C<guestfs_find> with the following "
9226 #: ../src/guestfs-actions.pod:1789 ../fish/guestfish-actions.pod:1212
9227 msgid "The resulting list is written to an external file."
9231 #: ../src/guestfs-actions.pod:1793 ../fish/guestfish-actions.pod:1216
9233 "Items (filenames) in the result are separated by C<\\0> characters. See "
9234 "L<find(1)> option I<-print0>."
9238 #: ../src/guestfs-actions.pod:1798 ../fish/guestfish-actions.pod:1221
9239 msgid "This command is not limited in the number of names that it can return."
9243 #: ../src/guestfs-actions.pod:1803 ../fish/guestfish-actions.pod:1226
9244 msgid "The result list is not sorted."
9248 #: ../src/guestfs-actions.pod:1809
9249 msgid "(Added in 1.0.74)"
9253 #: ../src/guestfs-actions.pod:1811
9254 msgid "guestfs_findfs_label"
9258 #: ../src/guestfs-actions.pod:1813
9262 " guestfs_findfs_label (guestfs_h *g,\n"
9263 " const char *label);\n"
9268 #: ../src/guestfs-actions.pod:1817 ../fish/guestfish-actions.pod:1236
9270 "This command searches the filesystems and returns the one which has the "
9271 "given label. An error is returned if no such filesystem can be found."
9275 #: ../src/guestfs-actions.pod:1821
9276 msgid "To find the label of a filesystem, use C<guestfs_vfs_label>."
9280 #: ../src/guestfs-actions.pod:1828
9281 msgid "guestfs_findfs_uuid"
9285 #: ../src/guestfs-actions.pod:1830
9289 " guestfs_findfs_uuid (guestfs_h *g,\n"
9290 " const char *uuid);\n"
9295 #: ../src/guestfs-actions.pod:1834 ../fish/guestfish-actions.pod:1246
9297 "This command searches the filesystems and returns the one which has the "
9298 "given UUID. An error is returned if no such filesystem can be found."
9302 #: ../src/guestfs-actions.pod:1838
9303 msgid "To find the UUID of a filesystem, use C<guestfs_vfs_uuid>."
9307 #: ../src/guestfs-actions.pod:1845
9308 msgid "guestfs_fsck"
9312 #: ../src/guestfs-actions.pod:1847
9316 " guestfs_fsck (guestfs_h *g,\n"
9317 " const char *fstype,\n"
9318 " const char *device);\n"
9323 #: ../src/guestfs-actions.pod:1852 ../fish/guestfish-actions.pod:1256
9325 "This runs the filesystem checker (fsck) on C<device> which should have "
9326 "filesystem type C<fstype>."
9330 #: ../src/guestfs-actions.pod:1855 ../fish/guestfish-actions.pod:1259
9332 "The returned integer is the status. See L<fsck(8)> for the list of status "
9333 "codes from C<fsck>."
9337 #: ../src/guestfs-actions.pod:1864 ../fish/guestfish-actions.pod:1268
9338 msgid "Multiple status codes can be summed together."
9342 #: ../src/guestfs-actions.pod:1868 ../fish/guestfish-actions.pod:1272
9344 "A non-zero return code can mean \"success\", for example if errors have been "
9345 "corrected on the filesystem."
9349 #: ../src/guestfs-actions.pod:1873 ../fish/guestfish-actions.pod:1277
9350 msgid "Checking or repairing NTFS volumes is not supported (by linux-ntfs)."
9354 #: ../src/guestfs-actions.pod:1878 ../fish/guestfish-actions.pod:1282
9356 "This command is entirely equivalent to running C<fsck -a -t fstype device>."
9360 #: ../src/guestfs-actions.pod:1882 ../src/guestfs-actions.pod:7663
9361 msgid "(Added in 1.0.16)"
9365 #: ../src/guestfs-actions.pod:1884
9366 msgid "guestfs_get_append"
9370 #: ../src/guestfs-actions.pod:1886
9374 " guestfs_get_append (guestfs_h *g);\n"
9379 #: ../src/guestfs-actions.pod:1889 ../fish/guestfish-actions.pod:1288
9381 "Return the additional kernel options which are added to the guest kernel "
9386 #: ../src/guestfs-actions.pod:1892 ../fish/guestfish-actions.pod:1291
9387 msgid "If C<NULL> then no options are added."
9391 #: ../src/guestfs-actions.pod:1894
9393 "This function returns a string which may be NULL. There is no way to return "
9394 "an error from this function. The string is owned by the guest handle and "
9395 "must I<not> be freed."
9399 #: ../src/guestfs-actions.pod:1898 ../src/guestfs-actions.pod:5611
9400 #: ../src/guestfs-actions.pod:6093 ../src/guestfs-actions.pod:6516
9401 #: ../src/guestfs-actions.pod:6535 ../src/guestfs-actions.pod:6551
9402 #: ../src/guestfs-actions.pod:6575 ../src/guestfs-actions.pod:7329
9403 #: ../src/guestfs-actions.pod:7344 ../src/guestfs-actions.pod:7706
9404 msgid "(Added in 1.0.26)"
9408 #: ../src/guestfs-actions.pod:1900
9409 msgid "guestfs_get_attach_method"
9413 #: ../src/guestfs-actions.pod:1902
9417 " guestfs_get_attach_method (guestfs_h *g);\n"
9422 #: ../src/guestfs-actions.pod:1905
9423 msgid "Return the current attach method. See C<guestfs_set_attach_method>."
9427 #: ../src/guestfs-actions.pod:1910 ../src/guestfs-actions.pod:6123
9428 msgid "(Added in 1.9.8)"
9432 #: ../src/guestfs-actions.pod:1912
9433 msgid "guestfs_get_autosync"
9437 #: ../src/guestfs-actions.pod:1914
9441 " guestfs_get_autosync (guestfs_h *g);\n"
9446 #: ../src/guestfs-actions.pod:1917 ../fish/guestfish-actions.pod:1303
9447 msgid "Get the autosync flag."
9451 #: ../src/guestfs-actions.pod:1923
9452 msgid "guestfs_get_direct"
9456 #: ../src/guestfs-actions.pod:1925
9460 " guestfs_get_direct (guestfs_h *g);\n"
9465 #: ../src/guestfs-actions.pod:1928 ../fish/guestfish-actions.pod:1309
9466 msgid "Return the direct appliance mode flag."
9470 #: ../src/guestfs-actions.pod:1932 ../src/guestfs-actions.pod:6164
9471 msgid "(Added in 1.0.72)"
9475 #: ../src/guestfs-actions.pod:1934
9476 msgid "guestfs_get_e2label"
9480 #: ../src/guestfs-actions.pod:1936
9484 " guestfs_get_e2label (guestfs_h *g,\n"
9485 " const char *device);\n"
9490 #: ../src/guestfs-actions.pod:1940 ../fish/guestfish-actions.pod:1315
9492 "This returns the ext2/3/4 filesystem label of the filesystem on C<device>."
9496 #: ../src/guestfs-actions.pod:1946 ../fish/guestfish-actions.pod:1318
9498 "This function is deprecated. In new code, use the C<vfs_label> call instead."
9502 #: ../src/guestfs-actions.pod:1953 ../src/guestfs-actions.pod:1974
9503 #: ../src/guestfs-actions.pod:6182 ../src/guestfs-actions.pod:6201
9504 msgid "(Added in 1.0.15)"
9508 #: ../src/guestfs-actions.pod:1955
9509 msgid "guestfs_get_e2uuid"
9513 #: ../src/guestfs-actions.pod:1957
9517 " guestfs_get_e2uuid (guestfs_h *g,\n"
9518 " const char *device);\n"
9523 #: ../src/guestfs-actions.pod:1961 ../fish/guestfish-actions.pod:1329
9525 "This returns the ext2/3/4 filesystem UUID of the filesystem on C<device>."
9529 #: ../src/guestfs-actions.pod:1967 ../fish/guestfish-actions.pod:1332
9531 "This function is deprecated. In new code, use the C<vfs_uuid> call instead."
9535 #: ../src/guestfs-actions.pod:1976
9536 msgid "guestfs_get_memsize"
9540 #: ../src/guestfs-actions.pod:1978
9544 " guestfs_get_memsize (guestfs_h *g);\n"
9549 #: ../src/guestfs-actions.pod:1981 ../fish/guestfish-actions.pod:1343
9551 "This gets the memory size in megabytes allocated to the qemu subprocess."
9555 #: ../src/guestfs-actions.pod:1984
9557 "If C<guestfs_set_memsize> was not called on this handle, and if "
9558 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
9559 "value for memsize."
9563 #: ../src/guestfs-actions.pod:1988 ../src/guestfs-actions.pod:2069
9564 #: ../src/guestfs-actions.pod:6217 ../src/guestfs-actions.pod:6324
9565 #: ../fish/guestfish-actions.pod:1350 ../fish/guestfish-actions.pod:1401
9566 #: ../fish/guestfish-actions.pod:4126 ../fish/guestfish-actions.pod:4213
9568 "For more information on the architecture of libguestfs, see L<guestfs(3)>."
9572 #: ../src/guestfs-actions.pod:1993 ../src/guestfs-actions.pod:4520
9573 #: ../src/guestfs-actions.pod:4729 ../src/guestfs-actions.pod:4748
9574 #: ../src/guestfs-actions.pod:4767 ../src/guestfs-actions.pod:4779
9575 #: ../src/guestfs-actions.pod:4796 ../src/guestfs-actions.pod:4809
9576 #: ../src/guestfs-actions.pod:5836 ../src/guestfs-actions.pod:6222
9577 #: ../src/guestfs-actions.pod:6483 ../src/guestfs-actions.pod:7098
9578 msgid "(Added in 1.0.55)"
9582 #: ../src/guestfs-actions.pod:1995
9583 msgid "guestfs_get_network"
9587 #: ../src/guestfs-actions.pod:1997
9591 " guestfs_get_network (guestfs_h *g);\n"
9596 #: ../src/guestfs-actions.pod:2000 ../fish/guestfish-actions.pod:1357
9597 msgid "This returns the enable network flag."
9601 #: ../src/guestfs-actions.pod:2004 ../src/guestfs-actions.pod:6241
9602 msgid "(Added in 1.5.4)"
9606 #: ../src/guestfs-actions.pod:2006
9607 msgid "guestfs_get_path"
9611 #: ../src/guestfs-actions.pod:2008
9615 " guestfs_get_path (guestfs_h *g);\n"
9620 #: ../src/guestfs-actions.pod:2011 ../fish/guestfish-actions.pod:1363
9621 msgid "Return the current search path."
9625 #: ../src/guestfs-actions.pod:2013 ../fish/guestfish-actions.pod:1365
9627 "This is always non-NULL. If it wasn't set already, then this will return "
9632 #: ../src/guestfs-actions.pod:2016 ../src/guestfs-actions.pod:2045
9634 "This function returns a string, or NULL on error. The string is owned by "
9635 "the guest handle and must I<not> be freed."
9639 #: ../src/guestfs-actions.pod:2021
9640 msgid "guestfs_get_pid"
9644 #: ../src/guestfs-actions.pod:2023
9648 " guestfs_get_pid (guestfs_h *g);\n"
9653 #: ../src/guestfs-actions.pod:2026 ../fish/guestfish-actions.pod:1374
9655 "Return the process ID of the qemu subprocess. If there is no qemu "
9656 "subprocess, then this will return an error."
9660 #: ../src/guestfs-actions.pod:2029 ../fish/guestfish-actions.pod:1377
9661 msgid "This is an internal call used for debugging and testing."
9665 #: ../src/guestfs-actions.pod:2033
9666 msgid "(Added in 1.0.56)"
9670 #: ../src/guestfs-actions.pod:2035
9671 msgid "guestfs_get_qemu"
9675 #: ../src/guestfs-actions.pod:2037
9679 " guestfs_get_qemu (guestfs_h *g);\n"
9684 #: ../src/guestfs-actions.pod:2040 ../fish/guestfish-actions.pod:1383
9685 msgid "Return the current qemu binary."
9689 #: ../src/guestfs-actions.pod:2042 ../fish/guestfish-actions.pod:1385
9691 "This is always non-NULL. If it wasn't set already, then this will return "
9692 "the default qemu binary name."
9696 #: ../src/guestfs-actions.pod:2048 ../src/guestfs-actions.pod:6286
9697 msgid "(Added in 1.0.6)"
9701 #: ../src/guestfs-actions.pod:2050
9702 msgid "guestfs_get_recovery_proc"
9706 #: ../src/guestfs-actions.pod:2052
9710 " guestfs_get_recovery_proc (guestfs_h *g);\n"
9715 #: ../src/guestfs-actions.pod:2055 ../fish/guestfish-actions.pod:1392
9716 msgid "Return the recovery process enabled flag."
9720 #: ../src/guestfs-actions.pod:2059 ../src/guestfs-actions.pod:3593
9721 #: ../src/guestfs-actions.pod:3924 ../src/guestfs-actions.pod:4327
9722 #: ../src/guestfs-actions.pod:4359 ../src/guestfs-actions.pod:5541
9723 #: ../src/guestfs-actions.pod:5884 ../src/guestfs-actions.pod:6310
9724 #: ../src/guestfs-actions.pod:7001 ../src/guestfs-actions.pod:7021
9725 #: ../src/guestfs-actions.pod:7213
9726 msgid "(Added in 1.0.77)"
9730 #: ../src/guestfs-actions.pod:2061
9731 msgid "guestfs_get_selinux"
9735 #: ../src/guestfs-actions.pod:2063
9739 " guestfs_get_selinux (guestfs_h *g);\n"
9744 #: ../src/guestfs-actions.pod:2066
9746 "This returns the current setting of the selinux flag which is passed to the "
9747 "appliance at boot time. See C<guestfs_set_selinux>."
9751 #: ../src/guestfs-actions.pod:2074 ../src/guestfs-actions.pod:2137
9752 #: ../src/guestfs-actions.pod:6329 ../src/guestfs-actions.pod:6387
9753 msgid "(Added in 1.0.67)"
9757 #: ../src/guestfs-actions.pod:2076
9758 msgid "guestfs_get_state"
9762 #: ../src/guestfs-actions.pod:2078
9766 " guestfs_get_state (guestfs_h *g);\n"
9771 #: ../src/guestfs-actions.pod:2081 ../fish/guestfish-actions.pod:1408
9773 "This returns the current state as an opaque integer. This is only useful "
9774 "for printing debug and internal error messages."
9778 #: ../src/guestfs-actions.pod:2084 ../src/guestfs-actions.pod:3364
9779 #: ../src/guestfs-actions.pod:3393 ../src/guestfs-actions.pod:3454
9780 #: ../src/guestfs-actions.pod:3481 ../fish/guestfish-actions.pod:1411
9781 #: ../fish/guestfish-actions.pod:2331 ../fish/guestfish-actions.pod:2349
9782 #: ../fish/guestfish-actions.pod:2387 ../fish/guestfish-actions.pod:2403
9783 msgid "For more information on states, see L<guestfs(3)>."
9787 #: ../src/guestfs-actions.pod:2090
9788 msgid "guestfs_get_trace"
9792 #: ../src/guestfs-actions.pod:2092
9796 " guestfs_get_trace (guestfs_h *g);\n"
9801 #: ../src/guestfs-actions.pod:2095 ../fish/guestfish-actions.pod:1417
9802 msgid "Return the command trace flag."
9806 #: ../src/guestfs-actions.pod:2101
9807 msgid "guestfs_get_umask"
9811 #: ../src/guestfs-actions.pod:2103
9815 " guestfs_get_umask (guestfs_h *g);\n"
9820 #: ../src/guestfs-actions.pod:2106
9822 "Return the current umask. By default the umask is C<022> unless it has been "
9823 "set by calling C<guestfs_umask>."
9827 #: ../src/guestfs-actions.pod:2113
9828 msgid "guestfs_get_verbose"
9832 #: ../src/guestfs-actions.pod:2115
9836 " guestfs_get_verbose (guestfs_h *g);\n"
9841 #: ../src/guestfs-actions.pod:2118 ../fish/guestfish-actions.pod:1430
9842 msgid "This returns the verbose messages flag."
9846 #: ../src/guestfs-actions.pod:2124
9847 msgid "guestfs_getcon"
9851 #: ../src/guestfs-actions.pod:2126
9855 " guestfs_getcon (guestfs_h *g);\n"
9860 #: ../src/guestfs-actions.pod:2129 ../fish/guestfish-actions.pod:1436
9861 msgid "This gets the SELinux security context of the daemon."
9865 #: ../src/guestfs-actions.pod:2131
9867 "See the documentation about SELINUX in L<guestfs(3)>, and C<guestfs_setcon>"
9871 #: ../src/guestfs-actions.pod:2139
9872 msgid "guestfs_getxattr"
9876 #: ../src/guestfs-actions.pod:2141
9880 " guestfs_getxattr (guestfs_h *g,\n"
9881 " const char *path,\n"
9882 " const char *name,\n"
9883 " size_t *size_r);\n"
9888 #: ../src/guestfs-actions.pod:2147
9890 "Get a single extended attribute from file C<path> named C<name>. This call "
9891 "follows symlinks. If you want to lookup an extended attribute for the "
9892 "symlink itself, use C<guestfs_lgetxattr>."
9896 #: ../src/guestfs-actions.pod:2151 ../src/guestfs-actions.pod:3607
9898 "Normally it is better to get all extended attributes from a file in one go "
9899 "by calling C<guestfs_getxattrs>. However some Linux filesystem "
9900 "implementations are buggy and do not provide a way to list out attributes. "
9901 "For these filesystems (notably ntfs-3g) you have to know the names of the "
9902 "extended attributes you want in advance and call this function."
9906 #: ../src/guestfs-actions.pod:2158 ../src/guestfs-actions.pod:3614
9907 #: ../fish/guestfish-actions.pod:1456 ../fish/guestfish-actions.pod:2483
9909 "Extended attribute values are blobs of binary data. If there is no extended "
9910 "attribute named C<name>, this returns an error."
9914 #: ../src/guestfs-actions.pod:2161
9915 msgid "See also: C<guestfs_getxattrs>, C<guestfs_lgetxattr>, L<attr(5)>."
9919 #: ../src/guestfs-actions.pod:2163 ../src/guestfs-actions.pod:2354
9920 #: ../src/guestfs-actions.pod:2824 ../src/guestfs-actions.pod:3619
9921 #: ../src/guestfs-actions.pod:5534 ../src/guestfs-actions.pod:5560
9922 #: ../src/guestfs-actions.pod:5741
9924 "This function returns a buffer, or NULL on error. The size of the returned "
9925 "buffer is written to C<*size_r>. I<The caller must free the returned buffer "
9930 #: ../src/guestfs-actions.pod:2167 ../src/guestfs-actions.pod:3623
9931 msgid "(Added in 1.7.24)"
9935 #: ../src/guestfs-actions.pod:2169
9936 msgid "guestfs_getxattrs"
9940 #: ../src/guestfs-actions.pod:2171
9943 " struct guestfs_xattr_list *\n"
9944 " guestfs_getxattrs (guestfs_h *g,\n"
9945 " const char *path);\n"
9950 #: ../src/guestfs-actions.pod:2175 ../fish/guestfish-actions.pod:1465
9952 "This call lists the extended attributes of the file or directory C<path>."
9956 #: ../src/guestfs-actions.pod:2178 ../fish/guestfish-actions.pod:1468
9958 "At the system call level, this is a combination of the L<listxattr(2)> and "
9959 "L<getxattr(2)> calls."
9963 #: ../src/guestfs-actions.pod:2181
9964 msgid "See also: C<guestfs_lgetxattrs>, L<attr(5)>."
9968 #: ../src/guestfs-actions.pod:2183 ../src/guestfs-actions.pod:3635
9969 #: ../src/guestfs-actions.pod:4323
9971 "This function returns a C<struct guestfs_xattr_list *>, or NULL if there was "
9972 "an error. I<The caller must call C<guestfs_free_xattr_list> after use>."
9976 #: ../src/guestfs-actions.pod:2187 ../src/guestfs-actions.pod:3639
9977 #: ../src/guestfs-actions.pod:3838 ../src/guestfs-actions.pod:3874
9978 #: ../src/guestfs-actions.pod:5914 ../src/guestfs-actions.pod:6406
9979 #: ../src/guestfs-actions.pod:7771
9980 msgid "(Added in 1.0.59)"
9984 #: ../src/guestfs-actions.pod:2189
9985 msgid "guestfs_glob_expand"
9989 #: ../src/guestfs-actions.pod:2191
9993 " guestfs_glob_expand (guestfs_h *g,\n"
9994 " const char *pattern);\n"
9999 #: ../src/guestfs-actions.pod:2195 ../fish/guestfish-actions.pod:1477
10001 "This command searches for all the pathnames matching C<pattern> according to "
10002 "the wildcard expansion rules used by the shell."
10006 #: ../src/guestfs-actions.pod:2199 ../fish/guestfish-actions.pod:1481
10008 "If no paths match, then this returns an empty list (note: not an error)."
10012 #: ../src/guestfs-actions.pod:2202 ../fish/guestfish-actions.pod:1484
10014 "It is just a wrapper around the C L<glob(3)> function with flags C<GLOB_MARK|"
10015 "GLOB_BRACE>. See that manual page for more details."
10019 #: ../src/guestfs-actions.pod:2210 ../src/guestfs-actions.pod:6599
10020 #: ../src/guestfs-actions.pod:6616
10021 msgid "(Added in 1.0.50)"
10025 #: ../src/guestfs-actions.pod:2212
10026 msgid "guestfs_grep"
10030 #: ../src/guestfs-actions.pod:2214
10034 " guestfs_grep (guestfs_h *g,\n"
10035 " const char *regex,\n"
10036 " const char *path);\n"
10041 #: ../src/guestfs-actions.pod:2219 ../fish/guestfish-actions.pod:1492
10042 msgid "This calls the external C<grep> program and returns the matching lines."
10046 #: ../src/guestfs-actions.pod:2231
10047 msgid "guestfs_grepi"
10051 #: ../src/guestfs-actions.pod:2233
10055 " guestfs_grepi (guestfs_h *g,\n"
10056 " const char *regex,\n"
10057 " const char *path);\n"
10062 #: ../src/guestfs-actions.pod:2238 ../fish/guestfish-actions.pod:1502
10064 "This calls the external C<grep -i> program and returns the matching lines."
10068 #: ../src/guestfs-actions.pod:2250
10069 msgid "guestfs_grub_install"
10073 #: ../src/guestfs-actions.pod:2252
10077 " guestfs_grub_install (guestfs_h *g,\n"
10078 " const char *root,\n"
10079 " const char *device);\n"
10084 #: ../src/guestfs-actions.pod:2257 ../fish/guestfish-actions.pod:1512
10086 "This command installs GRUB (the Grand Unified Bootloader) on C<device>, with "
10087 "the root directory being C<root>."
10091 #: ../src/guestfs-actions.pod:2260 ../fish/guestfish-actions.pod:1515
10093 "Note: If grub-install reports the error \"No suitable drive was found in the "
10094 "generated device map.\" it may be that you need to create a C</boot/grub/"
10095 "device.map> file first that contains the mapping between grub device names "
10096 "and Linux device names. It is usually sufficient to create a file "
10101 #: ../src/guestfs-actions.pod:2267 ../fish/guestfish-actions.pod:1522
10104 " (hd0) /dev/vda\n"
10109 #: ../src/guestfs-actions.pod:2269 ../fish/guestfish-actions.pod:1524
10110 msgid "replacing C</dev/vda> with the name of the installation device."
10114 #: ../src/guestfs-actions.pod:2273
10115 msgid "(Added in 1.0.17)"
10119 #: ../src/guestfs-actions.pod:2275
10120 msgid "guestfs_head"
10124 #: ../src/guestfs-actions.pod:2277
10128 " guestfs_head (guestfs_h *g,\n"
10129 " const char *path);\n"
10134 #: ../src/guestfs-actions.pod:2281 ../fish/guestfish-actions.pod:1530
10136 "This command returns up to the first 10 lines of a file as a list of strings."
10140 #: ../src/guestfs-actions.pod:2293
10141 msgid "guestfs_head_n"
10145 #: ../src/guestfs-actions.pod:2295
10149 " guestfs_head_n (guestfs_h *g,\n"
10151 " const char *path);\n"
10156 #: ../src/guestfs-actions.pod:2300 ../fish/guestfish-actions.pod:1540
10158 "If the parameter C<nrlines> is a positive number, this returns the first "
10159 "C<nrlines> lines of the file C<path>."
10163 #: ../src/guestfs-actions.pod:2303 ../fish/guestfish-actions.pod:1543
10165 "If the parameter C<nrlines> is a negative number, this returns lines from "
10166 "the file C<path>, excluding the last C<nrlines> lines."
10170 #: ../src/guestfs-actions.pod:2306 ../src/guestfs-actions.pod:6896
10171 #: ../fish/guestfish-actions.pod:1546 ../fish/guestfish-actions.pod:4591
10172 msgid "If the parameter C<nrlines> is zero, this returns an empty list."
10176 #: ../src/guestfs-actions.pod:2317
10177 msgid "guestfs_hexdump"
10181 #: ../src/guestfs-actions.pod:2319
10185 " guestfs_hexdump (guestfs_h *g,\n"
10186 " const char *path);\n"
10191 #: ../src/guestfs-actions.pod:2323 ../fish/guestfish-actions.pod:1555
10193 "This runs C<hexdump -C> on the given C<path>. The result is the human-"
10194 "readable, canonical hex dump of the file."
10198 #: ../src/guestfs-actions.pod:2332 ../src/guestfs-actions.pod:6680
10199 #: ../src/guestfs-actions.pod:6735
10200 msgid "(Added in 1.0.22)"
10204 #: ../src/guestfs-actions.pod:2334
10205 msgid "guestfs_initrd_cat"
10209 #: ../src/guestfs-actions.pod:2336
10213 " guestfs_initrd_cat (guestfs_h *g,\n"
10214 " const char *initrdpath,\n"
10215 " const char *filename,\n"
10216 " size_t *size_r);\n"
10221 #: ../src/guestfs-actions.pod:2342 ../fish/guestfish-actions.pod:1565
10223 "This command unpacks the file C<filename> from the initrd file called "
10224 "C<initrdpath>. The filename must be given I<without> the initial C</> "
10229 #: ../src/guestfs-actions.pod:2346 ../fish/guestfish-actions.pod:1569
10231 "For example, in guestfish you could use the following command to examine the "
10232 "boot script (usually called C</init>) contained in a Linux initrd or "
10237 #: ../src/guestfs-actions.pod:2350 ../fish/guestfish-actions.pod:1573
10240 " initrd-cat /boot/initrd-<version>.img init\n"
10245 #: ../src/guestfs-actions.pod:2352
10246 msgid "See also C<guestfs_initrd_list>."
10250 #: ../src/guestfs-actions.pod:2363
10251 msgid "guestfs_initrd_list"
10255 #: ../src/guestfs-actions.pod:2365
10259 " guestfs_initrd_list (guestfs_h *g,\n"
10260 " const char *path);\n"
10265 #: ../src/guestfs-actions.pod:2369 ../fish/guestfish-actions.pod:1584
10266 msgid "This command lists out files contained in an initrd."
10270 #: ../src/guestfs-actions.pod:2371 ../fish/guestfish-actions.pod:1586
10272 "The files are listed without any initial C</> character. The files are "
10273 "listed in the order they appear (not necessarily alphabetical). Directory "
10274 "names are listed as separate items."
10278 #: ../src/guestfs-actions.pod:2375 ../fish/guestfish-actions.pod:1590
10280 "Old Linux kernels (2.4 and earlier) used a compressed ext2 filesystem as "
10281 "initrd. We I<only> support the newer initramfs format (compressed cpio "
10286 #: ../src/guestfs-actions.pod:2385
10287 msgid "guestfs_inotify_add_watch"
10291 #: ../src/guestfs-actions.pod:2387
10295 " guestfs_inotify_add_watch (guestfs_h *g,\n"
10296 " const char *path,\n"
10302 #: ../src/guestfs-actions.pod:2392 ../fish/guestfish-actions.pod:1598
10303 msgid "Watch C<path> for the events listed in C<mask>."
10307 #: ../src/guestfs-actions.pod:2394 ../fish/guestfish-actions.pod:1600
10309 "Note that if C<path> is a directory then events within that directory are "
10310 "watched, but this does I<not> happen recursively (in subdirectories)."
10314 #: ../src/guestfs-actions.pod:2398 ../fish/guestfish-actions.pod:1604
10316 "Note for non-C or non-Linux callers: the inotify events are defined by the "
10317 "Linux kernel ABI and are listed in C</usr/include/sys/inotify.h>."
10321 #: ../src/guestfs-actions.pod:2406
10322 msgid "guestfs_inotify_close"
10326 #: ../src/guestfs-actions.pod:2408
10330 " guestfs_inotify_close (guestfs_h *g);\n"
10335 #: ../src/guestfs-actions.pod:2411 ../fish/guestfish-actions.pod:1612
10337 "This closes the inotify handle which was previously opened by inotify_init. "
10338 "It removes all watches, throws away any pending events, and deallocates all "
10343 #: ../src/guestfs-actions.pod:2419
10344 msgid "guestfs_inotify_files"
10348 #: ../src/guestfs-actions.pod:2421
10352 " guestfs_inotify_files (guestfs_h *g);\n"
10357 #: ../src/guestfs-actions.pod:2424
10359 "This function is a helpful wrapper around C<guestfs_inotify_read> which just "
10360 "returns a list of pathnames of objects that were touched. The returned "
10361 "pathnames are sorted and deduplicated."
10365 #: ../src/guestfs-actions.pod:2434
10366 msgid "guestfs_inotify_init"
10370 #: ../src/guestfs-actions.pod:2436
10374 " guestfs_inotify_init (guestfs_h *g,\n"
10375 " int maxevents);\n"
10380 #: ../src/guestfs-actions.pod:2440 ../fish/guestfish-actions.pod:1628
10382 "This command creates a new inotify handle. The inotify subsystem can be "
10383 "used to notify events which happen to objects in the guest filesystem."
10387 #: ../src/guestfs-actions.pod:2444
10389 "C<maxevents> is the maximum number of events which will be queued up between "
10390 "calls to C<guestfs_inotify_read> or C<guestfs_inotify_files>. If this is "
10391 "passed as C<0>, then the kernel (or previously set) default is used. For "
10392 "Linux 2.6.29 the default was 16384 events. Beyond this limit, the kernel "
10393 "throws away events, but records the fact that it threw them away by setting "
10394 "a flag C<IN_Q_OVERFLOW> in the returned structure list (see "
10395 "C<guestfs_inotify_read>)."
10399 #: ../src/guestfs-actions.pod:2454
10401 "Before any events are generated, you have to add some watches to the "
10402 "internal watch list. See: C<guestfs_inotify_add_watch>, "
10403 "C<guestfs_inotify_rm_watch> and C<guestfs_inotify_watch_all>."
10407 #: ../src/guestfs-actions.pod:2460
10409 "Queued up events should be read periodically by calling "
10410 "C<guestfs_inotify_read> (or C<guestfs_inotify_files> which is just a helpful "
10411 "wrapper around C<guestfs_inotify_read>). If you don't read the events out "
10412 "often enough then you risk the internal queue overflowing."
10416 #: ../src/guestfs-actions.pod:2467
10418 "The handle should be closed after use by calling C<guestfs_inotify_close>. "
10419 "This also removes any watches automatically."
10423 #: ../src/guestfs-actions.pod:2471 ../fish/guestfish-actions.pod:1659
10425 "See also L<inotify(7)> for an overview of the inotify interface as exposed "
10426 "by the Linux kernel, which is roughly what we expose via libguestfs. Note "
10427 "that there is one global inotify handle per libguestfs instance."
10431 #: ../src/guestfs-actions.pod:2480
10432 msgid "guestfs_inotify_read"
10436 #: ../src/guestfs-actions.pod:2482
10439 " struct guestfs_inotify_event_list *\n"
10440 " guestfs_inotify_read (guestfs_h *g);\n"
10445 #: ../src/guestfs-actions.pod:2485 ../fish/guestfish-actions.pod:1668
10447 "Return the complete queue of events that have happened since the previous "
10452 #: ../src/guestfs-actions.pod:2488 ../fish/guestfish-actions.pod:1671
10453 msgid "If no events have happened, this returns an empty list."
10457 #: ../src/guestfs-actions.pod:2490 ../fish/guestfish-actions.pod:1673
10459 "I<Note>: In order to make sure that all events have been read, you must call "
10460 "this function repeatedly until it returns an empty list. The reason is that "
10461 "the call will read events up to the maximum appliance-to-host message size "
10462 "and leave remaining events in the queue."
10466 #: ../src/guestfs-actions.pod:2496
10468 "This function returns a C<struct guestfs_inotify_event_list *>, or NULL if "
10469 "there was an error. I<The caller must call "
10470 "C<guestfs_free_inotify_event_list> after use>."
10474 #: ../src/guestfs-actions.pod:2502
10475 msgid "guestfs_inotify_rm_watch"
10479 #: ../src/guestfs-actions.pod:2504
10483 " guestfs_inotify_rm_watch (guestfs_h *g,\n"
10489 #: ../src/guestfs-actions.pod:2508
10491 "Remove a previously defined inotify watch. See C<guestfs_inotify_add_watch>."
10495 #: ../src/guestfs-actions.pod:2515
10496 msgid "guestfs_inspect_get_arch"
10500 #: ../src/guestfs-actions.pod:2517
10504 " guestfs_inspect_get_arch (guestfs_h *g,\n"
10505 " const char *root);\n"
10510 #: ../src/guestfs-actions.pod:2521
10512 "This returns the architecture of the inspected operating system. The "
10513 "possible return values are listed under C<guestfs_file_architecture>."
10517 #: ../src/guestfs-actions.pod:2525 ../fish/guestfish-actions.pod:1694
10519 "If the architecture could not be determined, then the string C<unknown> is "
10524 #: ../src/guestfs-actions.pod:2528 ../src/guestfs-actions.pod:2618
10525 #: ../src/guestfs-actions.pod:2722 ../src/guestfs-actions.pod:2741
10526 #: ../src/guestfs-actions.pod:2872 ../src/guestfs-actions.pod:2955
10527 #: ../src/guestfs-actions.pod:2983 ../src/guestfs-actions.pod:3004
10528 #: ../src/guestfs-actions.pod:3057 ../src/guestfs-actions.pod:3097
10529 #: ../src/guestfs-actions.pod:3117 ../src/guestfs-actions.pod:3137
10530 #: ../src/guestfs-actions.pod:3154 ../src/guestfs-actions.pod:3170
10531 #: ../src/guestfs-actions.pod:3188 ../src/guestfs-actions.pod:3290
10532 #: ../src/guestfs-actions.pod:3331 ../fish/guestfish-actions.pod:1697
10533 #: ../fish/guestfish-actions.pod:1780 ../fish/guestfish-actions.pod:1859
10534 #: ../fish/guestfish-actions.pod:1871 ../fish/guestfish-actions.pod:1955
10535 #: ../fish/guestfish-actions.pod:2016 ../fish/guestfish-actions.pod:2037
10536 #: ../fish/guestfish-actions.pod:2051 ../fish/guestfish-actions.pod:2091
10537 #: ../fish/guestfish-actions.pod:2123 ../fish/guestfish-actions.pod:2136
10538 #: ../fish/guestfish-actions.pod:2149 ../fish/guestfish-actions.pod:2159
10539 #: ../fish/guestfish-actions.pod:2169 ../fish/guestfish-actions.pod:2181
10540 #: ../fish/guestfish-actions.pod:2277 ../fish/guestfish-actions.pod:2311
10541 msgid "Please read L<guestfs(3)/INSPECTION> for more details."
10545 #: ../src/guestfs-actions.pod:2535
10546 msgid "guestfs_inspect_get_distro"
10550 #: ../src/guestfs-actions.pod:2537
10554 " guestfs_inspect_get_distro (guestfs_h *g,\n"
10555 " const char *root);\n"
10560 #: ../src/guestfs-actions.pod:2541 ../fish/guestfish-actions.pod:1703
10562 "This returns the distro (distribution) of the inspected operating system."
10566 #: ../src/guestfs-actions.pod:2544 ../fish/guestfish-actions.pod:1706
10567 msgid "Currently defined distros are:"
10571 #: ../src/guestfs-actions.pod:2548 ../fish/guestfish-actions.pod:1710
10572 msgid "\"archlinux\""
10573 msgstr "\"archlinux\""
10576 #: ../src/guestfs-actions.pod:2550 ../fish/guestfish-actions.pod:1712
10577 msgid "Arch Linux."
10578 msgstr "Arch Linux."
10581 #: ../src/guestfs-actions.pod:2552 ../fish/guestfish-actions.pod:1714
10583 #| msgid "\"gentoo\""
10585 msgstr "\"gentoo\""
10588 #: ../src/guestfs-actions.pod:2554 ../fish/guestfish-actions.pod:1716
10593 #: ../src/guestfs-actions.pod:2556 ../fish/guestfish-actions.pod:1718
10595 msgstr "\"debian\""
10598 #: ../src/guestfs-actions.pod:2558 ../fish/guestfish-actions.pod:1720
10603 #: ../src/guestfs-actions.pod:2560 ../fish/guestfish-actions.pod:1722
10605 msgstr "\"fedora\""
10608 #: ../src/guestfs-actions.pod:2562 ../fish/guestfish-actions.pod:1724
10613 #: ../src/guestfs-actions.pod:2564 ../fish/guestfish-actions.pod:1726
10615 msgstr "\"gentoo\""
10618 #: ../src/guestfs-actions.pod:2566 ../fish/guestfish-actions.pod:1728
10623 #: ../src/guestfs-actions.pod:2568 ../fish/guestfish-actions.pod:1730
10624 msgid "\"linuxmint\""
10625 msgstr "\"linuxmint\""
10628 #: ../src/guestfs-actions.pod:2570 ../fish/guestfish-actions.pod:1732
10629 msgid "Linux Mint."
10630 msgstr "Linux Mint."
10633 #: ../src/guestfs-actions.pod:2572 ../fish/guestfish-actions.pod:1734
10634 msgid "\"mandriva\""
10635 msgstr "\"mandriva\""
10638 #: ../src/guestfs-actions.pod:2574 ../fish/guestfish-actions.pod:1736
10643 #: ../src/guestfs-actions.pod:2576 ../fish/guestfish-actions.pod:1738
10648 #: ../src/guestfs-actions.pod:2578 ../fish/guestfish-actions.pod:1740
10653 #: ../src/guestfs-actions.pod:2580 ../fish/guestfish-actions.pod:1742
10655 msgstr "\"pardus\""
10658 #: ../src/guestfs-actions.pod:2582 ../fish/guestfish-actions.pod:1744
10663 #: ../src/guestfs-actions.pod:2584 ../fish/guestfish-actions.pod:1746
10664 msgid "\"redhat-based\""
10665 msgstr "\"redhat-based\""
10668 #: ../src/guestfs-actions.pod:2586 ../fish/guestfish-actions.pod:1748
10669 msgid "Some Red Hat-derived distro."
10670 msgstr "Дистрибутив, що походить від Red Hat."
10673 #: ../src/guestfs-actions.pod:2588 ../fish/guestfish-actions.pod:1750
10678 #: ../src/guestfs-actions.pod:2590 ../fish/guestfish-actions.pod:1752
10680 #| msgid "Red Hat Enterprise Linux and some derivatives."
10681 msgid "Red Hat Enterprise Linux."
10682 msgstr "Red Hat Enterprise Linux та деякі з похідних дистрибутивів."
10685 #: ../src/guestfs-actions.pod:2592 ../fish/guestfish-actions.pod:1754
10686 msgid "\"scientificlinux\""
10690 #: ../src/guestfs-actions.pod:2594 ../fish/guestfish-actions.pod:1756
10691 msgid "Scientific Linux."
10695 #: ../src/guestfs-actions.pod:2596 ../fish/guestfish-actions.pod:1758
10696 msgid "\"slackware\""
10700 #: ../src/guestfs-actions.pod:2598 ../fish/guestfish-actions.pod:1760
10705 #: ../src/guestfs-actions.pod:2600 ../fish/guestfish-actions.pod:1762
10707 msgstr "\"ubuntu\""
10710 #: ../src/guestfs-actions.pod:2602 ../fish/guestfish-actions.pod:1764
10715 #: ../src/guestfs-actions.pod:2604 ../src/guestfs-actions.pod:2713
10716 #: ../src/guestfs-actions.pod:3088 ../fish/guestfish-actions.pod:1766
10717 #: ../fish/guestfish-actions.pod:1850 ../fish/guestfish-actions.pod:2114
10718 msgid "\"unknown\""
10719 msgstr "\"unknown\""
10722 #: ../src/guestfs-actions.pod:2606 ../fish/guestfish-actions.pod:1768
10723 msgid "The distro could not be determined."
10724 msgstr "Дистрибутив, тип якого не вдалося визначити."
10727 #: ../src/guestfs-actions.pod:2608 ../src/guestfs-actions.pod:3080
10728 #: ../fish/guestfish-actions.pod:1770 ../fish/guestfish-actions.pod:2106
10729 msgid "\"windows\""
10730 msgstr "\"windows\""
10733 #: ../src/guestfs-actions.pod:2610 ../fish/guestfish-actions.pod:1772
10735 "Windows does not have distributions. This string is returned if the OS type "
10740 #: ../src/guestfs-actions.pod:2615 ../src/guestfs-actions.pod:2719
10741 #: ../src/guestfs-actions.pod:3094 ../fish/guestfish-actions.pod:1777
10742 #: ../fish/guestfish-actions.pod:1856 ../fish/guestfish-actions.pod:2120
10744 "Future versions of libguestfs may return other strings here. The caller "
10745 "should be prepared to handle any string."
10749 #: ../src/guestfs-actions.pod:2625
10750 msgid "guestfs_inspect_get_drive_mappings"
10754 #: ../src/guestfs-actions.pod:2627
10758 " guestfs_inspect_get_drive_mappings (guestfs_h *g,\n"
10759 " const char *root);\n"
10764 #: ../src/guestfs-actions.pod:2631 ../fish/guestfish-actions.pod:1786
10766 "This call is useful for Windows which uses a primitive system of assigning "
10767 "drive letters (like \"C:\") to partitions. This inspection API examines the "
10768 "Windows Registry to find out how disks/partitions are mapped to drive "
10769 "letters, and returns a hash table as in the example below:"
10773 #: ../src/guestfs-actions.pod:2637 ../fish/guestfish-actions.pod:1792
10776 " C => /dev/vda2\n"
10777 " E => /dev/vdb1\n"
10778 " F => /dev/vdc1\n"
10783 #: ../src/guestfs-actions.pod:2641 ../fish/guestfish-actions.pod:1796
10785 "Note that keys are drive letters. For Windows, the key is case insensitive "
10786 "and just contains the drive letter, without the customary colon separator "
10791 #: ../src/guestfs-actions.pod:2645 ../fish/guestfish-actions.pod:1800
10793 "In future we may support other operating systems that also used drive "
10794 "letters, but the keys for those might not be case insensitive and might be "
10795 "longer than 1 character. For example in OS-9, hard drives were named C<h0>, "
10800 #: ../src/guestfs-actions.pod:2650 ../fish/guestfish-actions.pod:1805
10802 "For Windows guests, currently only hard drive mappings are returned. "
10803 "Removable disks (eg. DVD-ROMs) are ignored."
10807 #: ../src/guestfs-actions.pod:2653 ../fish/guestfish-actions.pod:1808
10809 "For guests that do not use drive mappings, or if the drive mappings could "
10810 "not be determined, this returns an empty hash table."
10814 #: ../src/guestfs-actions.pod:2656
10816 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
10817 "C<guestfs_inspect_get_mountpoints>, C<guestfs_inspect_get_filesystems>."
10821 #: ../src/guestfs-actions.pod:2660 ../src/guestfs-actions.pod:2928
10822 #: ../src/guestfs-actions.pod:3726 ../src/guestfs-actions.pod:5008
10823 #: ../src/guestfs-actions.pod:7037
10825 "This function returns a NULL-terminated array of strings, or NULL if there "
10826 "was an error. The array of strings will always have length C<2n+1>, where "
10827 "C<n> keys and values alternate, followed by the trailing NULL entry. I<The "
10828 "caller must free the strings and the array after use>."
10832 #: ../src/guestfs-actions.pod:2666 ../src/guestfs-actions.pod:3122
10833 msgid "(Added in 1.9.17)"
10837 #: ../src/guestfs-actions.pod:2668
10838 msgid "guestfs_inspect_get_filesystems"
10842 #: ../src/guestfs-actions.pod:2670
10846 " guestfs_inspect_get_filesystems (guestfs_h *g,\n"
10847 " const char *root);\n"
10852 #: ../src/guestfs-actions.pod:2674 ../fish/guestfish-actions.pod:1819
10854 "This returns a list of all the filesystems that we think are associated with "
10855 "this operating system. This includes the root filesystem, other ordinary "
10856 "filesystems, and non-mounted devices like swap partitions."
10860 #: ../src/guestfs-actions.pod:2679 ../fish/guestfish-actions.pod:1824
10862 "In the case of a multi-boot virtual machine, it is possible for a filesystem "
10863 "to be shared between operating systems."
10867 #: ../src/guestfs-actions.pod:2682
10869 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
10870 "C<guestfs_inspect_get_mountpoints>."
10874 #: ../src/guestfs-actions.pod:2691
10875 msgid "guestfs_inspect_get_format"
10879 #: ../src/guestfs-actions.pod:2693
10883 " guestfs_inspect_get_format (guestfs_h *g,\n"
10884 " const char *root);\n"
10889 #: ../src/guestfs-actions.pod:2697 ../fish/guestfish-actions.pod:1834
10891 "This returns the format of the inspected operating system. You can use it "
10892 "to detect install images, live CDs and similar."
10896 #: ../src/guestfs-actions.pod:2700 ../fish/guestfish-actions.pod:1837
10897 msgid "Currently defined formats are:"
10901 #: ../src/guestfs-actions.pod:2704 ../fish/guestfish-actions.pod:1841
10902 msgid "\"installed\""
10903 msgstr "\"installed\""
10906 #: ../src/guestfs-actions.pod:2706 ../fish/guestfish-actions.pod:1843
10907 msgid "This is an installed operating system."
10908 msgstr "Це встановлена операційна система."
10911 #: ../src/guestfs-actions.pod:2708 ../fish/guestfish-actions.pod:1845
10912 msgid "\"installer\""
10916 #: ../src/guestfs-actions.pod:2710 ../fish/guestfish-actions.pod:1847
10918 "The disk image being inspected is not an installed operating system, but a "
10919 "I<bootable> install disk, live CD, or similar."
10923 #: ../src/guestfs-actions.pod:2715 ../fish/guestfish-actions.pod:1852
10924 msgid "The format of this disk image is not known."
10928 #: ../src/guestfs-actions.pod:2727 ../src/guestfs-actions.pod:3158
10929 #: ../src/guestfs-actions.pod:3174 ../src/guestfs-actions.pod:3192
10930 #: ../src/guestfs-actions.pod:5952
10931 msgid "(Added in 1.9.4)"
10935 #: ../src/guestfs-actions.pod:2729
10936 msgid "guestfs_inspect_get_hostname"
10940 #: ../src/guestfs-actions.pod:2731
10944 " guestfs_inspect_get_hostname (guestfs_h *g,\n"
10945 " const char *root);\n"
10950 #: ../src/guestfs-actions.pod:2735 ../fish/guestfish-actions.pod:1865
10952 "This function returns the hostname of the operating system as found by "
10953 "inspection of the guest's configuration files."
10957 #: ../src/guestfs-actions.pod:2738 ../fish/guestfish-actions.pod:1868
10959 "If the hostname could not be determined, then the string C<unknown> is "
10964 #: ../src/guestfs-actions.pod:2746
10965 msgid "(Added in 1.7.9)"
10969 #: ../src/guestfs-actions.pod:2748
10970 msgid "guestfs_inspect_get_icon"
10974 #: ../src/guestfs-actions.pod:2750
10978 " guestfs_inspect_get_icon (guestfs_h *g,\n"
10979 " const char *root,\n"
10980 " size_t *size_r,\n"
10986 #: ../src/guestfs-actions.pod:2761
10989 " GUESTFS_INSPECT_GET_ICON_FAVICON, int favicon,\n"
10990 " GUESTFS_INSPECT_GET_ICON_HIGHQUALITY, int highquality,\n"
10995 #: ../src/guestfs-actions.pod:2764 ../fish/guestfish-actions.pod:1877
10997 "This function returns an icon corresponding to the inspected operating "
10998 "system. The icon is returned as a buffer containing a PNG image (re-encoded "
10999 "to PNG if necessary)."
11003 #: ../src/guestfs-actions.pod:2768 ../fish/guestfish-actions.pod:1881
11005 "If it was not possible to get an icon this function returns a zero-length "
11006 "(non-NULL) buffer. I<Callers must check for this case>."
11010 #: ../src/guestfs-actions.pod:2771 ../fish/guestfish-actions.pod:1884
11012 "Libguestfs will start by looking for a file called C</etc/favicon.png> or "
11013 "C<C:\\etc\\favicon.png> and if it has the correct format, the contents of "
11014 "this file will be returned. You can disable favicons by passing the "
11015 "optional C<favicon> boolean as false (default is true)."
11019 #: ../src/guestfs-actions.pod:2777 ../fish/guestfish-actions.pod:1890
11021 "If finding the favicon fails, then we look in other places in the guest for "
11026 #: ../src/guestfs-actions.pod:2780 ../fish/guestfish-actions.pod:1893
11028 "If the optional C<highquality> boolean is true then only high quality icons "
11029 "are returned, which means only icons of high resolution with an alpha "
11030 "channel. The default (false) is to return any icon we can, even if it is of "
11031 "substandard quality."
11035 #: ../src/guestfs-actions.pod:2791 ../fish/guestfish-actions.pod:1904
11037 "Unlike most other inspection API calls, the guest's disks must be mounted up "
11038 "before you call this, since it needs to read information from the guest "
11039 "filesystem during the call."
11043 #: ../src/guestfs-actions.pod:2797 ../fish/guestfish-actions.pod:1910
11045 "B<Security:> The icon data comes from the untrusted guest, and should be "
11046 "treated with caution. PNG files have been known to contain exploits. "
11047 "Ensure that libpng (or other relevant libraries) are fully up to date before "
11048 "trying to process or display the icon."
11052 #: ../src/guestfs-actions.pod:2805 ../fish/guestfish-actions.pod:1918
11054 "The PNG image returned can be any size. It might not be square. Libguestfs "
11055 "tries to return the largest, highest quality icon available. The "
11056 "application must scale the icon to the required size."
11060 #: ../src/guestfs-actions.pod:2812 ../fish/guestfish-actions.pod:1925
11062 "Extracting icons from Windows guests requires the external C<wrestool> "
11063 "program from the C<icoutils> package, and several programs (C<bmptopnm>, "
11064 "C<pnmtopng>, C<pamcut>) from the C<netpbm> package. These must be "
11065 "installed separately."
11069 #: ../src/guestfs-actions.pod:2819 ../fish/guestfish-actions.pod:1932
11071 "Operating system icons are usually trademarks. Seek legal advice before "
11072 "using trademarks in applications."
11076 #: ../src/guestfs-actions.pod:2828 ../src/guestfs-actions.pod:3653
11077 #: ../src/guestfs-actions.pod:4907
11078 msgid "(Added in 1.11.12)"
11082 #: ../src/guestfs-actions.pod:2830
11083 msgid "guestfs_inspect_get_icon_va"
11087 #: ../src/guestfs-actions.pod:2832
11091 " guestfs_inspect_get_icon_va (guestfs_h *g,\n"
11092 " const char *root,\n"
11093 " size_t *size_r,\n"
11094 " va_list args);\n"
11099 #: ../src/guestfs-actions.pod:2838
11100 msgid "This is the \"va_list variant\" of L</guestfs_inspect_get_icon>."
11104 #: ../src/guestfs-actions.pod:2842
11105 msgid "guestfs_inspect_get_icon_argv"
11109 #: ../src/guestfs-actions.pod:2844
11113 " guestfs_inspect_get_icon_argv (guestfs_h *g,\n"
11114 " const char *root,\n"
11115 " size_t *size_r,\n"
11116 " const struct guestfs_inspect_get_icon_argv *optargs);\n"
11121 #: ../src/guestfs-actions.pod:2850
11122 msgid "This is the \"argv variant\" of L</guestfs_inspect_get_icon>."
11126 #: ../src/guestfs-actions.pod:2854
11127 msgid "guestfs_inspect_get_major_version"
11131 #: ../src/guestfs-actions.pod:2856
11135 " guestfs_inspect_get_major_version (guestfs_h *g,\n"
11136 " const char *root);\n"
11141 #: ../src/guestfs-actions.pod:2860 ../fish/guestfish-actions.pod:1943
11143 "This returns the major version number of the inspected operating system."
11147 #: ../src/guestfs-actions.pod:2863 ../fish/guestfish-actions.pod:1946
11149 "Windows uses a consistent versioning scheme which is I<not> reflected in the "
11150 "popular public names used by the operating system. Notably the operating "
11151 "system known as \"Windows 7\" is really version 6.1 (ie. major = 6, minor = "
11152 "1). You can find out the real versions corresponding to releases of Windows "
11153 "by consulting Wikipedia or MSDN."
11157 #: ../src/guestfs-actions.pod:2870 ../src/guestfs-actions.pod:2887
11158 #: ../fish/guestfish-actions.pod:1953 ../fish/guestfish-actions.pod:1964
11159 msgid "If the version could not be determined, then C<0> is returned."
11163 #: ../src/guestfs-actions.pod:2878
11164 msgid "guestfs_inspect_get_minor_version"
11168 #: ../src/guestfs-actions.pod:2880
11172 " guestfs_inspect_get_minor_version (guestfs_h *g,\n"
11173 " const char *root);\n"
11178 #: ../src/guestfs-actions.pod:2884 ../fish/guestfish-actions.pod:1961
11180 "This returns the minor version number of the inspected operating system."
11184 #: ../src/guestfs-actions.pod:2889
11186 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
11187 "C<guestfs_inspect_get_major_version>."
11191 #: ../src/guestfs-actions.pod:2896
11192 msgid "guestfs_inspect_get_mountpoints"
11196 #: ../src/guestfs-actions.pod:2898
11200 " guestfs_inspect_get_mountpoints (guestfs_h *g,\n"
11201 " const char *root);\n"
11206 #: ../src/guestfs-actions.pod:2902 ../fish/guestfish-actions.pod:1973
11208 "This returns a hash of where we think the filesystems associated with this "
11209 "operating system should be mounted. Callers should note that this is at "
11210 "best an educated guess made by reading configuration files such as C</etc/"
11211 "fstab>. I<In particular note> that this may return filesystems which are "
11212 "non-existent or not mountable and callers should be prepared to handle or "
11213 "ignore failures if they try to mount them."
11217 #: ../src/guestfs-actions.pod:2911 ../fish/guestfish-actions.pod:1982
11219 "Each element in the returned hashtable has a key which is the path of the "
11220 "mountpoint (eg. C</boot>) and a value which is the filesystem that would be "
11221 "mounted there (eg. C</dev/sda1>)."
11225 #: ../src/guestfs-actions.pod:2916 ../fish/guestfish-actions.pod:1987
11227 "Non-mounted devices such as swap devices are I<not> returned in this list."
11231 #: ../src/guestfs-actions.pod:2919
11233 "For operating systems like Windows which still use drive letters, this call "
11234 "will only return an entry for the first drive \"mounted on\" C</>. For "
11235 "information about the mapping of drive letters to partitions, see "
11236 "C<guestfs_inspect_get_drive_mappings>."
11240 #: ../src/guestfs-actions.pod:2925
11242 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
11243 "C<guestfs_inspect_get_filesystems>."
11247 #: ../src/guestfs-actions.pod:2936
11248 msgid "guestfs_inspect_get_package_format"
11252 #: ../src/guestfs-actions.pod:2938
11256 " guestfs_inspect_get_package_format (guestfs_h *g,\n"
11257 " const char *root);\n"
11262 #: ../src/guestfs-actions.pod:2942
11264 "This function and C<guestfs_inspect_get_package_management> return the "
11265 "package format and package management tool used by the inspected operating "
11266 "system. For example for Fedora these functions would return C<rpm> (package "
11267 "format) and C<yum> (package management)."
11271 #: ../src/guestfs-actions.pod:2948 ../fish/guestfish-actions.pod:2009
11273 "This returns the string C<unknown> if we could not determine the package "
11274 "format I<or> if the operating system does not have a real packaging system "
11279 #: ../src/guestfs-actions.pod:2952 ../fish/guestfish-actions.pod:2013
11281 "Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>. "
11282 "Future versions of libguestfs may return other strings."
11286 #: ../src/guestfs-actions.pod:2960 ../src/guestfs-actions.pod:2988
11287 msgid "(Added in 1.7.5)"
11291 #: ../src/guestfs-actions.pod:2962
11292 msgid "guestfs_inspect_get_package_management"
11296 #: ../src/guestfs-actions.pod:2964
11300 " guestfs_inspect_get_package_management (guestfs_h *g,\n"
11301 " const char *root);\n"
11306 #: ../src/guestfs-actions.pod:2968
11308 "C<guestfs_inspect_get_package_format> and this function return the package "
11309 "format and package management tool used by the inspected operating system. "
11310 "For example for Fedora these functions would return C<rpm> (package format) "
11311 "and C<yum> (package management)."
11315 #: ../src/guestfs-actions.pod:2974 ../fish/guestfish-actions.pod:2028
11317 "This returns the string C<unknown> if we could not determine the package "
11318 "management tool I<or> if the operating system does not have a real packaging "
11319 "system (eg. Windows)."
11323 #: ../src/guestfs-actions.pod:2978 ../fish/guestfish-actions.pod:2032
11325 "Possible strings include: C<yum>, C<up2date>, C<apt> (for all Debian "
11326 "derivatives), C<portage>, C<pisi>, C<pacman>, C<urpmi>. Future versions of "
11327 "libguestfs may return other strings."
11331 #: ../src/guestfs-actions.pod:2990
11332 msgid "guestfs_inspect_get_product_name"
11336 #: ../src/guestfs-actions.pod:2992
11340 " guestfs_inspect_get_product_name (guestfs_h *g,\n"
11341 " const char *root);\n"
11346 #: ../src/guestfs-actions.pod:2996 ../fish/guestfish-actions.pod:2043
11348 "This returns the product name of the inspected operating system. The "
11349 "product name is generally some freeform string which can be displayed to the "
11350 "user, but should not be parsed by programs."
11354 #: ../src/guestfs-actions.pod:3001 ../fish/guestfish-actions.pod:2048
11356 "If the product name could not be determined, then the string C<unknown> is "
11361 #: ../src/guestfs-actions.pod:3011
11362 msgid "guestfs_inspect_get_product_variant"
11366 #: ../src/guestfs-actions.pod:3013
11370 " guestfs_inspect_get_product_variant (guestfs_h *g,\n"
11371 " const char *root);\n"
11376 #: ../src/guestfs-actions.pod:3017 ../fish/guestfish-actions.pod:2057
11378 #| msgid "This is an installed operating system."
11379 msgid "This returns the product variant of the inspected operating system."
11380 msgstr "Це встановлена операційна система."
11383 #: ../src/guestfs-actions.pod:3020 ../fish/guestfish-actions.pod:2060
11385 "For Windows guests, this returns the contents of the Registry key C<HKLM"
11386 "\\Software\\Microsoft\\Windows NT\\CurrentVersion> C<InstallationType> which "
11387 "is usually a string such as C<Client> or C<Server> (other values are "
11388 "possible). This can be used to distinguish consumer and enterprise versions "
11389 "of Windows that have the same version number (for example, Windows 7 and "
11390 "Windows 2008 Server are both version 6.1, but the former is C<Client> and "
11391 "the latter is C<Server>)."
11395 #: ../src/guestfs-actions.pod:3029 ../fish/guestfish-actions.pod:2069
11397 "For enterprise Linux guests, in future we intend this to return the product "
11398 "variant such as C<Desktop>, C<Server> and so on. But this is not "
11399 "implemented at present."
11403 #: ../src/guestfs-actions.pod:3033 ../fish/guestfish-actions.pod:2073
11405 "If the product variant could not be determined, then the string C<unknown> "
11410 #: ../src/guestfs-actions.pod:3036
11412 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
11413 "C<guestfs_inspect_get_product_name>, C<guestfs_inspect_get_major_version>."
11417 #: ../src/guestfs-actions.pod:3043
11418 msgid "(Added in 1.9.13)"
11422 #: ../src/guestfs-actions.pod:3045
11423 msgid "guestfs_inspect_get_roots"
11427 #: ../src/guestfs-actions.pod:3047
11431 " guestfs_inspect_get_roots (guestfs_h *g);\n"
11436 #: ../src/guestfs-actions.pod:3050
11438 "This function is a convenient way to get the list of root devices, as "
11439 "returned from a previous call to C<guestfs_inspect_os>, but without redoing "
11440 "the whole inspection process."
11444 #: ../src/guestfs-actions.pod:3054
11446 "This returns an empty list if either no root devices were found or the "
11447 "caller has not called C<guestfs_inspect_os>."
11451 #: ../src/guestfs-actions.pod:3063
11452 msgid "(Added in 1.7.3)"
11456 #: ../src/guestfs-actions.pod:3065
11457 msgid "guestfs_inspect_get_type"
11461 #: ../src/guestfs-actions.pod:3067
11465 " guestfs_inspect_get_type (guestfs_h *g,\n"
11466 " const char *root);\n"
11471 #: ../src/guestfs-actions.pod:3071 ../fish/guestfish-actions.pod:2097
11473 "This returns the type of the inspected operating system. Currently defined "
11478 #: ../src/guestfs-actions.pod:3076 ../fish/guestfish-actions.pod:2102
11483 #: ../src/guestfs-actions.pod:3078 ../fish/guestfish-actions.pod:2104
11484 msgid "Any Linux-based operating system."
11488 #: ../src/guestfs-actions.pod:3082 ../fish/guestfish-actions.pod:2108
11489 msgid "Any Microsoft Windows operating system."
11493 #: ../src/guestfs-actions.pod:3084 ../fish/guestfish-actions.pod:2110
11494 msgid "\"freebsd\""
11495 msgstr "\"freebsd\""
11498 #: ../src/guestfs-actions.pod:3086 ../fish/guestfish-actions.pod:2112
11503 #: ../src/guestfs-actions.pod:3090 ../fish/guestfish-actions.pod:2116
11504 msgid "The operating system type could not be determined."
11508 #: ../src/guestfs-actions.pod:3104
11509 msgid "guestfs_inspect_get_windows_current_control_set"
11513 #: ../src/guestfs-actions.pod:3106
11517 " guestfs_inspect_get_windows_current_control_set (guestfs_h *g,\n"
11518 " const char *root);\n"
11523 #: ../src/guestfs-actions.pod:3110 ../fish/guestfish-actions.pod:2129
11525 "This returns the Windows CurrentControlSet of the inspected guest. The "
11526 "CurrentControlSet is a registry key name such as C<ControlSet001>."
11530 #: ../src/guestfs-actions.pod:3113 ../fish/guestfish-actions.pod:2132
11532 "This call assumes that the guest is Windows and that the Registry could be "
11533 "examined by inspection. If this is not the case then an error is returned."
11537 #: ../src/guestfs-actions.pod:3124
11538 msgid "guestfs_inspect_get_windows_systemroot"
11542 #: ../src/guestfs-actions.pod:3126
11546 " guestfs_inspect_get_windows_systemroot (guestfs_h *g,\n"
11547 " const char *root);\n"
11552 #: ../src/guestfs-actions.pod:3130 ../fish/guestfish-actions.pod:2142
11554 "This returns the Windows systemroot of the inspected guest. The systemroot "
11555 "is a directory path such as C</WINDOWS>."
11559 #: ../src/guestfs-actions.pod:3133 ../fish/guestfish-actions.pod:2145
11561 "This call assumes that the guest is Windows and that the systemroot could be "
11562 "determined by inspection. If this is not the case then an error is returned."
11566 #: ../src/guestfs-actions.pod:3142
11567 msgid "(Added in 1.5.25)"
11571 #: ../src/guestfs-actions.pod:3144
11572 msgid "guestfs_inspect_is_live"
11576 #: ../src/guestfs-actions.pod:3146
11580 " guestfs_inspect_is_live (guestfs_h *g,\n"
11581 " const char *root);\n"
11586 #: ../src/guestfs-actions.pod:3150
11588 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
11589 "disk), then this returns true if a live image was detected on the disk."
11593 #: ../src/guestfs-actions.pod:3160
11594 msgid "guestfs_inspect_is_multipart"
11598 #: ../src/guestfs-actions.pod:3162
11602 " guestfs_inspect_is_multipart (guestfs_h *g,\n"
11603 " const char *root);\n"
11608 #: ../src/guestfs-actions.pod:3166
11610 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
11611 "disk), then this returns true if the disk is part of a set."
11615 #: ../src/guestfs-actions.pod:3176
11616 msgid "guestfs_inspect_is_netinst"
11620 #: ../src/guestfs-actions.pod:3178
11624 " guestfs_inspect_is_netinst (guestfs_h *g,\n"
11625 " const char *root);\n"
11630 #: ../src/guestfs-actions.pod:3182
11632 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
11633 "disk), then this returns true if the disk is a network installer, ie. not a "
11634 "self-contained install CD but one which is likely to require network access "
11635 "to complete the install."
11639 #: ../src/guestfs-actions.pod:3194
11640 msgid "guestfs_inspect_list_applications"
11644 #: ../src/guestfs-actions.pod:3196
11647 " struct guestfs_application_list *\n"
11648 " guestfs_inspect_list_applications (guestfs_h *g,\n"
11649 " const char *root);\n"
11654 #: ../src/guestfs-actions.pod:3200 ../fish/guestfish-actions.pod:2187
11655 msgid "Return the list of applications installed in the operating system."
11659 #: ../src/guestfs-actions.pod:3202
11661 "I<Note:> This call works differently from other parts of the inspection "
11662 "API. You have to call C<guestfs_inspect_os>, then "
11663 "C<guestfs_inspect_get_mountpoints>, then mount up the disks, before calling "
11664 "this. Listing applications is a significantly more difficult operation "
11665 "which requires access to the full filesystem. Also note that unlike the "
11666 "other C<guestfs_inspect_get_*> calls which are just returning data cached in "
11667 "the libguestfs handle, this call actually reads parts of the mounted "
11668 "filesystems during the call."
11672 #: ../src/guestfs-actions.pod:3212 ../fish/guestfish-actions.pod:2199
11674 "This returns an empty list if the inspection code was not able to determine "
11675 "the list of applications."
11679 #: ../src/guestfs-actions.pod:3215 ../fish/guestfish-actions.pod:2202
11680 msgid "The application structure contains the following fields:"
11684 #: ../src/guestfs-actions.pod:3219 ../fish/guestfish-actions.pod:2206
11685 msgid "C<app_name>"
11686 msgstr "C<app_name>"
11689 #: ../src/guestfs-actions.pod:3221 ../fish/guestfish-actions.pod:2208
11691 "The name of the application. For Red Hat-derived and Debian-derived Linux "
11692 "guests, this is the package name."
11696 #: ../src/guestfs-actions.pod:3224 ../fish/guestfish-actions.pod:2211
11697 msgid "C<app_display_name>"
11698 msgstr "C<app_display_name>"
11701 #: ../src/guestfs-actions.pod:3226 ../fish/guestfish-actions.pod:2213
11703 "The display name of the application, sometimes localized to the install "
11704 "language of the guest operating system."
11708 #: ../src/guestfs-actions.pod:3229 ../fish/guestfish-actions.pod:2216
11710 "If unavailable this is returned as an empty string C<\"\">. Callers needing "
11711 "to display something can use C<app_name> instead."
11715 #: ../src/guestfs-actions.pod:3232 ../fish/guestfish-actions.pod:2219
11716 msgid "C<app_epoch>"
11717 msgstr "C<app_epoch>"
11720 #: ../src/guestfs-actions.pod:3234 ../fish/guestfish-actions.pod:2221
11722 "For package managers which use epochs, this contains the epoch of the "
11723 "package (an integer). If unavailable, this is returned as C<0>."
11727 #: ../src/guestfs-actions.pod:3237 ../fish/guestfish-actions.pod:2224
11728 msgid "C<app_version>"
11729 msgstr "C<app_version>"
11732 #: ../src/guestfs-actions.pod:3239 ../fish/guestfish-actions.pod:2226
11734 "The version string of the application or package. If unavailable this is "
11735 "returned as an empty string C<\"\">."
11739 #: ../src/guestfs-actions.pod:3242 ../fish/guestfish-actions.pod:2229
11740 msgid "C<app_release>"
11741 msgstr "C<app_release>"
11744 #: ../src/guestfs-actions.pod:3244 ../fish/guestfish-actions.pod:2231
11746 "The release string of the application or package, for package managers that "
11747 "use this. If unavailable this is returned as an empty string C<\"\">."
11751 #: ../src/guestfs-actions.pod:3248 ../fish/guestfish-actions.pod:2235
11752 msgid "C<app_install_path>"
11753 msgstr "C<app_install_path>"
11756 #: ../src/guestfs-actions.pod:3250 ../fish/guestfish-actions.pod:2237
11758 "The installation path of the application (on operating systems such as "
11759 "Windows which use installation paths). This path is in the format used by "
11760 "the guest operating system, it is not a libguestfs path."
11764 #: ../src/guestfs-actions.pod:3255 ../fish/guestfish-actions.pod:2242
11765 msgid "If unavailable this is returned as an empty string C<\"\">."
11769 #: ../src/guestfs-actions.pod:3257 ../fish/guestfish-actions.pod:2244
11770 msgid "C<app_trans_path>"
11771 msgstr "C<app_trans_path>"
11774 #: ../src/guestfs-actions.pod:3259 ../fish/guestfish-actions.pod:2246
11776 "The install path translated into a libguestfs path. If unavailable this is "
11777 "returned as an empty string C<\"\">."
11781 #: ../src/guestfs-actions.pod:3262 ../fish/guestfish-actions.pod:2249
11782 msgid "C<app_publisher>"
11783 msgstr "C<app_publisher>"
11786 #: ../src/guestfs-actions.pod:3264 ../fish/guestfish-actions.pod:2251
11788 "The name of the publisher of the application, for package managers that use "
11789 "this. If unavailable this is returned as an empty string C<\"\">."
11793 #: ../src/guestfs-actions.pod:3268 ../fish/guestfish-actions.pod:2255
11795 msgstr "C<app_url>"
11798 #: ../src/guestfs-actions.pod:3270 ../fish/guestfish-actions.pod:2257
11800 "The URL (eg. upstream URL) of the application. If unavailable this is "
11801 "returned as an empty string C<\"\">."
11805 #: ../src/guestfs-actions.pod:3273 ../fish/guestfish-actions.pod:2260
11806 msgid "C<app_source_package>"
11810 #: ../src/guestfs-actions.pod:3275 ../fish/guestfish-actions.pod:2262
11812 "For packaging systems which support this, the name of the source package. "
11813 "If unavailable this is returned as an empty string C<\"\">."
11817 #: ../src/guestfs-actions.pod:3278 ../fish/guestfish-actions.pod:2265
11818 msgid "C<app_summary>"
11822 #: ../src/guestfs-actions.pod:3280 ../fish/guestfish-actions.pod:2267
11824 "A short (usually one line) description of the application or package. If "
11825 "unavailable this is returned as an empty string C<\"\">."
11829 #: ../src/guestfs-actions.pod:3283 ../fish/guestfish-actions.pod:2270
11830 msgid "C<app_description>"
11834 #: ../src/guestfs-actions.pod:3285 ../fish/guestfish-actions.pod:2272
11836 "A longer description of the application or package. If unavailable this is "
11837 "returned as an empty string C<\"\">."
11841 #: ../src/guestfs-actions.pod:3292
11843 "This function returns a C<struct guestfs_application_list *>, or NULL if "
11844 "there was an error. I<The caller must call C<guestfs_free_application_list> "
11849 #: ../src/guestfs-actions.pod:3296
11850 msgid "(Added in 1.7.8)"
11854 #: ../src/guestfs-actions.pod:3298
11855 msgid "guestfs_inspect_os"
11859 #: ../src/guestfs-actions.pod:3300
11863 " guestfs_inspect_os (guestfs_h *g);\n"
11868 #: ../src/guestfs-actions.pod:3303 ../fish/guestfish-actions.pod:2283
11870 "This function uses other libguestfs functions and certain heuristics to "
11871 "inspect the disk(s) (usually disks belonging to a virtual machine), looking "
11872 "for operating systems."
11876 #: ../src/guestfs-actions.pod:3307 ../fish/guestfish-actions.pod:2287
11877 msgid "The list returned is empty if no operating systems were found."
11881 #: ../src/guestfs-actions.pod:3309 ../fish/guestfish-actions.pod:2289
11883 "If one operating system was found, then this returns a list with a single "
11884 "element, which is the name of the root filesystem of this operating system. "
11885 "It is also possible for this function to return a list containing more than "
11886 "one element, indicating a dual-boot or multi-boot virtual machine, with each "
11887 "element being the root filesystem of one of the operating systems."
11891 #: ../src/guestfs-actions.pod:3316
11893 "You can pass the root string(s) returned to other C<guestfs_inspect_get_*> "
11894 "functions in order to query further information about each operating system, "
11895 "such as the name and version."
11899 #: ../src/guestfs-actions.pod:3321
11901 "This function uses other libguestfs features such as C<guestfs_mount_ro> and "
11902 "C<guestfs_umount_all> in order to mount and unmount filesystems and look at "
11903 "the contents. This should be called with no disks currently mounted. The "
11904 "function may also use Augeas, so any existing Augeas handle will be closed."
11908 #: ../src/guestfs-actions.pod:3327 ../fish/guestfish-actions.pod:2307
11910 "This function cannot decrypt encrypted disks. The caller must do that first "
11911 "(supplying the necessary keys) if the disk is encrypted."
11915 #: ../src/guestfs-actions.pod:3333 ../src/guestfs-actions.pod:3664
11916 #: ../src/guestfs-actions.pod:3746
11917 msgid "See also C<guestfs_list_filesystems>."
11921 #: ../src/guestfs-actions.pod:3341
11922 msgid "guestfs_is_blockdev"
11926 #: ../src/guestfs-actions.pod:3343
11930 " guestfs_is_blockdev (guestfs_h *g,\n"
11931 " const char *path);\n"
11936 #: ../src/guestfs-actions.pod:3347 ../fish/guestfish-actions.pod:2319
11938 "This returns C<true> if and only if there is a block device with the given "
11943 #: ../src/guestfs-actions.pod:3350 ../src/guestfs-actions.pod:3379
11944 #: ../src/guestfs-actions.pod:3409 ../src/guestfs-actions.pod:3424
11945 #: ../src/guestfs-actions.pod:3440 ../src/guestfs-actions.pod:3496
11946 #: ../src/guestfs-actions.pod:3511
11947 msgid "See also C<guestfs_stat>."
11951 #: ../src/guestfs-actions.pod:3354 ../src/guestfs-actions.pod:3383
11952 #: ../src/guestfs-actions.pod:3428 ../src/guestfs-actions.pod:3500
11953 #: ../src/guestfs-actions.pod:3515
11954 msgid "(Added in 1.5.10)"
11958 #: ../src/guestfs-actions.pod:3356
11959 msgid "guestfs_is_busy"
11963 #: ../src/guestfs-actions.pod:3358
11967 " guestfs_is_busy (guestfs_h *g);\n"
11972 #: ../src/guestfs-actions.pod:3361 ../fish/guestfish-actions.pod:2328
11974 "This returns true iff this handle is busy processing a command (in the "
11979 #: ../src/guestfs-actions.pod:3370
11980 msgid "guestfs_is_chardev"
11984 #: ../src/guestfs-actions.pod:3372
11988 " guestfs_is_chardev (guestfs_h *g,\n"
11989 " const char *path);\n"
11994 #: ../src/guestfs-actions.pod:3376 ../fish/guestfish-actions.pod:2337
11996 "This returns C<true> if and only if there is a character device with the "
11997 "given C<path> name."
12001 #: ../src/guestfs-actions.pod:3385
12002 msgid "guestfs_is_config"
12006 #: ../src/guestfs-actions.pod:3387
12010 " guestfs_is_config (guestfs_h *g);\n"
12015 #: ../src/guestfs-actions.pod:3390 ../fish/guestfish-actions.pod:2346
12017 "This returns true iff this handle is being configured (in the C<CONFIG> "
12022 #: ../src/guestfs-actions.pod:3399
12023 msgid "guestfs_is_dir"
12027 #: ../src/guestfs-actions.pod:3401
12031 " guestfs_is_dir (guestfs_h *g,\n"
12032 " const char *path);\n"
12037 #: ../src/guestfs-actions.pod:3405 ../fish/guestfish-actions.pod:2355
12039 "This returns C<true> if and only if there is a directory with the given "
12040 "C<path> name. Note that it returns false for other objects like files."
12044 #: ../src/guestfs-actions.pod:3415
12045 msgid "guestfs_is_fifo"
12049 #: ../src/guestfs-actions.pod:3417
12053 " guestfs_is_fifo (guestfs_h *g,\n"
12054 " const char *path);\n"
12059 #: ../src/guestfs-actions.pod:3421 ../fish/guestfish-actions.pod:2365
12061 "This returns C<true> if and only if there is a FIFO (named pipe) with the "
12062 "given C<path> name."
12066 #: ../src/guestfs-actions.pod:3430
12067 msgid "guestfs_is_file"
12071 #: ../src/guestfs-actions.pod:3432
12075 " guestfs_is_file (guestfs_h *g,\n"
12076 " const char *path);\n"
12081 #: ../src/guestfs-actions.pod:3436 ../fish/guestfish-actions.pod:2374
12083 "This returns C<true> if and only if there is a regular file with the given "
12084 "C<path> name. Note that it returns false for other objects like directories."
12088 #: ../src/guestfs-actions.pod:3446
12089 msgid "guestfs_is_launching"
12093 #: ../src/guestfs-actions.pod:3448
12097 " guestfs_is_launching (guestfs_h *g);\n"
12102 #: ../src/guestfs-actions.pod:3451 ../fish/guestfish-actions.pod:2384
12104 "This returns true iff this handle is launching the subprocess (in the "
12105 "C<LAUNCHING> state)."
12109 #: ../src/guestfs-actions.pod:3460
12110 msgid "guestfs_is_lv"
12114 #: ../src/guestfs-actions.pod:3462
12118 " guestfs_is_lv (guestfs_h *g,\n"
12119 " const char *device);\n"
12124 #: ../src/guestfs-actions.pod:3466 ../fish/guestfish-actions.pod:2393
12126 "This command tests whether C<device> is a logical volume, and returns true "
12127 "iff this is the case."
12131 #: ../src/guestfs-actions.pod:3473
12132 msgid "guestfs_is_ready"
12136 #: ../src/guestfs-actions.pod:3475
12140 " guestfs_is_ready (guestfs_h *g);\n"
12145 #: ../src/guestfs-actions.pod:3478 ../fish/guestfish-actions.pod:2400
12147 "This returns true iff this handle is ready to accept commands (in the "
12152 #: ../src/guestfs-actions.pod:3487
12153 msgid "guestfs_is_socket"
12157 #: ../src/guestfs-actions.pod:3489
12161 " guestfs_is_socket (guestfs_h *g,\n"
12162 " const char *path);\n"
12167 #: ../src/guestfs-actions.pod:3493 ../fish/guestfish-actions.pod:2409
12169 "This returns C<true> if and only if there is a Unix domain socket with the "
12170 "given C<path> name."
12174 #: ../src/guestfs-actions.pod:3502
12175 msgid "guestfs_is_symlink"
12179 #: ../src/guestfs-actions.pod:3504
12183 " guestfs_is_symlink (guestfs_h *g,\n"
12184 " const char *path);\n"
12189 #: ../src/guestfs-actions.pod:3508 ../fish/guestfish-actions.pod:2418
12191 "This returns C<true> if and only if there is a symbolic link with the given "
12196 #: ../src/guestfs-actions.pod:3517
12197 msgid "guestfs_is_zero"
12201 #: ../src/guestfs-actions.pod:3519
12205 " guestfs_is_zero (guestfs_h *g,\n"
12206 " const char *path);\n"
12211 #: ../src/guestfs-actions.pod:3523 ../fish/guestfish-actions.pod:2427
12213 "This returns true iff the file exists and the file is empty or it contains "
12218 #: ../src/guestfs-actions.pod:3528 ../src/guestfs-actions.pod:3542
12219 msgid "(Added in 1.11.8)"
12223 #: ../src/guestfs-actions.pod:3530
12224 msgid "guestfs_is_zero_device"
12228 #: ../src/guestfs-actions.pod:3532
12232 " guestfs_is_zero_device (guestfs_h *g,\n"
12233 " const char *device);\n"
12238 #: ../src/guestfs-actions.pod:3536 ../fish/guestfish-actions.pod:2434
12239 msgid "This returns true iff the device exists and contains all zero bytes."
12243 #: ../src/guestfs-actions.pod:3538 ../fish/guestfish-actions.pod:2436
12244 msgid "Note that for large devices this can take a long time to run."
12248 #: ../src/guestfs-actions.pod:3544
12249 msgid "guestfs_kill_subprocess"
12253 #: ../src/guestfs-actions.pod:3546
12257 " guestfs_kill_subprocess (guestfs_h *g);\n"
12262 #: ../src/guestfs-actions.pod:3549 ../fish/guestfish-actions.pod:2442
12263 msgid "This kills the qemu subprocess. You should never need to call this."
12267 #: ../src/guestfs-actions.pod:3555
12268 msgid "guestfs_launch"
12272 #: ../src/guestfs-actions.pod:3557
12276 " guestfs_launch (guestfs_h *g);\n"
12281 #: ../src/guestfs-actions.pod:3560 ../fish/guestfish-actions.pod:2450
12283 "Internally libguestfs is implemented by running a virtual machine using "
12288 #: ../src/guestfs-actions.pod:3563 ../fish/guestfish-actions.pod:2453
12290 "You should call this after configuring the handle (eg. adding drives) but "
12291 "before performing any actions."
12295 #: ../src/guestfs-actions.pod:3575
12296 msgid "guestfs_lchown"
12300 #: ../src/guestfs-actions.pod:3577
12304 " guestfs_lchown (guestfs_h *g,\n"
12307 " const char *path);\n"
12312 #: ../src/guestfs-actions.pod:3583
12314 "Change the file owner to C<owner> and group to C<group>. This is like "
12315 "C<guestfs_chown> but if C<path> is a symlink then the link itself is "
12316 "changed, not the target."
12320 #: ../src/guestfs-actions.pod:3595
12321 msgid "guestfs_lgetxattr"
12325 #: ../src/guestfs-actions.pod:3597
12329 " guestfs_lgetxattr (guestfs_h *g,\n"
12330 " const char *path,\n"
12331 " const char *name,\n"
12332 " size_t *size_r);\n"
12337 #: ../src/guestfs-actions.pod:3603 ../fish/guestfish-actions.pod:2472
12339 "Get a single extended attribute from file C<path> named C<name>. If C<path> "
12340 "is a symlink, then this call returns an extended attribute from the symlink."
12344 #: ../src/guestfs-actions.pod:3617
12345 msgid "See also: C<guestfs_lgetxattrs>, C<guestfs_getxattr>, L<attr(5)>."
12349 #: ../src/guestfs-actions.pod:3625
12350 msgid "guestfs_lgetxattrs"
12354 #: ../src/guestfs-actions.pod:3627
12357 " struct guestfs_xattr_list *\n"
12358 " guestfs_lgetxattrs (guestfs_h *g,\n"
12359 " const char *path);\n"
12364 #: ../src/guestfs-actions.pod:3631
12366 "This is the same as C<guestfs_getxattrs>, but if C<path> is a symbolic link, "
12367 "then it returns the extended attributes of the link itself."
12371 #: ../src/guestfs-actions.pod:3641
12372 msgid "guestfs_list_9p"
12376 #: ../src/guestfs-actions.pod:3643
12380 " guestfs_list_9p (guestfs_h *g);\n"
12385 #: ../src/guestfs-actions.pod:3646 ../fish/guestfish-actions.pod:2500
12387 "List all 9p filesystems attached to the guest. A list of mount tags is "
12392 #: ../src/guestfs-actions.pod:3655
12393 msgid "guestfs_list_devices"
12397 #: ../src/guestfs-actions.pod:3657
12401 " guestfs_list_devices (guestfs_h *g);\n"
12406 #: ../src/guestfs-actions.pod:3660 ../fish/guestfish-actions.pod:2507
12407 msgid "List all the block devices."
12411 #: ../src/guestfs-actions.pod:3662 ../fish/guestfish-actions.pod:2509
12412 msgid "The full block device names are returned, eg. C</dev/sda>."
12416 #: ../src/guestfs-actions.pod:3672
12417 msgid "guestfs_list_dm_devices"
12421 #: ../src/guestfs-actions.pod:3674
12425 " guestfs_list_dm_devices (guestfs_h *g);\n"
12430 #: ../src/guestfs-actions.pod:3677 ../fish/guestfish-actions.pod:2517
12431 msgid "List all device mapper devices."
12435 #: ../src/guestfs-actions.pod:3679
12437 "The returned list contains C</dev/mapper/*> devices, eg. ones created by a "
12438 "previous call to C<guestfs_luks_open>."
12442 #: ../src/guestfs-actions.pod:3682
12444 "Device mapper devices which correspond to logical volumes are I<not> "
12445 "returned in this list. Call C<guestfs_lvs> if you want to list logical "
12450 #: ../src/guestfs-actions.pod:3690 ../src/guestfs-actions.pod:5146
12451 msgid "(Added in 1.11.15)"
12455 #: ../src/guestfs-actions.pod:3692
12456 msgid "guestfs_list_filesystems"
12460 #: ../src/guestfs-actions.pod:3694
12464 " guestfs_list_filesystems (guestfs_h *g);\n"
12469 #: ../src/guestfs-actions.pod:3697 ../fish/guestfish-actions.pod:2530
12471 "This inspection command looks for filesystems on partitions, block devices "
12472 "and logical volumes, returning a list of devices containing filesystems and "
12477 #: ../src/guestfs-actions.pod:3701 ../fish/guestfish-actions.pod:2534
12479 "The return value is a hash, where the keys are the devices containing "
12480 "filesystems, and the values are the filesystem types. For example:"
12484 #: ../src/guestfs-actions.pod:3705 ../fish/guestfish-actions.pod:2538
12487 " \"/dev/sda1\" => \"ntfs\"\n"
12488 " \"/dev/sda2\" => \"ext2\"\n"
12489 " \"/dev/vg_guest/lv_root\" => \"ext4\"\n"
12490 " \"/dev/vg_guest/lv_swap\" => \"swap\"\n"
12495 #: ../src/guestfs-actions.pod:3710 ../fish/guestfish-actions.pod:2543
12497 "The value can have the special value \"unknown\", meaning the content of the "
12498 "device is undetermined or empty. \"swap\" means a Linux swap partition."
12502 #: ../src/guestfs-actions.pod:3714
12504 "This command runs other libguestfs commands, which might include "
12505 "C<guestfs_mount> and C<guestfs_umount>, and therefore you should use this "
12506 "soon after launch and only when nothing is mounted."
12510 #: ../src/guestfs-actions.pod:3718
12512 "Not all of the filesystems returned will be mountable. In particular, swap "
12513 "partitions are returned in the list. Also this command does not check that "
12514 "each filesystem found is valid and mountable, and some filesystems might be "
12515 "mountable but require special options. Filesystems may not all belong to a "
12516 "single logical operating system (use C<guestfs_inspect_os> to look for OSes)."
12520 #: ../src/guestfs-actions.pod:3732 ../src/guestfs-actions.pod:5501
12521 msgid "(Added in 1.5.15)"
12525 #: ../src/guestfs-actions.pod:3734
12526 msgid "guestfs_list_partitions"
12530 #: ../src/guestfs-actions.pod:3736
12534 " guestfs_list_partitions (guestfs_h *g);\n"
12539 #: ../src/guestfs-actions.pod:3739 ../fish/guestfish-actions.pod:2563
12540 msgid "List all the partitions detected on all block devices."
12544 #: ../src/guestfs-actions.pod:3741 ../fish/guestfish-actions.pod:2565
12545 msgid "The full partition device names are returned, eg. C</dev/sda1>"
12549 #: ../src/guestfs-actions.pod:3743
12551 "This does not return logical volumes. For that you will need to call "
12556 #: ../src/guestfs-actions.pod:3754
12561 #: ../src/guestfs-actions.pod:3756
12565 " guestfs_ll (guestfs_h *g,\n"
12566 " const char *directory);\n"
12571 #: ../src/guestfs-actions.pod:3760 ../fish/guestfish-actions.pod:2576
12573 "List the files in C<directory> (relative to the root directory, there is no "
12574 "cwd) in the format of 'ls -la'."
12578 #: ../src/guestfs-actions.pod:3763 ../fish/guestfish-actions.pod:2579
12580 "This command is mostly useful for interactive sessions. It is I<not> "
12581 "intended that you try to parse the output string."
12585 #: ../src/guestfs-actions.pod:3771
12590 #: ../src/guestfs-actions.pod:3773
12594 " guestfs_ln (guestfs_h *g,\n"
12595 " const char *target,\n"
12596 " const char *linkname);\n"
12601 #: ../src/guestfs-actions.pod:3778 ../fish/guestfish-actions.pod:2586
12602 msgid "This command creates a hard link using the C<ln> command."
12606 #: ../src/guestfs-actions.pod:3784
12607 msgid "guestfs_ln_f"
12611 #: ../src/guestfs-actions.pod:3786
12615 " guestfs_ln_f (guestfs_h *g,\n"
12616 " const char *target,\n"
12617 " const char *linkname);\n"
12622 #: ../src/guestfs-actions.pod:3791 ../fish/guestfish-actions.pod:2592
12624 "This command creates a hard link using the C<ln -f> command. The I<-f> "
12625 "option removes the link (C<linkname>) if it exists already."
12629 #: ../src/guestfs-actions.pod:3798
12630 msgid "guestfs_ln_s"
12634 #: ../src/guestfs-actions.pod:3800
12638 " guestfs_ln_s (guestfs_h *g,\n"
12639 " const char *target,\n"
12640 " const char *linkname);\n"
12645 #: ../src/guestfs-actions.pod:3805 ../fish/guestfish-actions.pod:2599
12646 msgid "This command creates a symbolic link using the C<ln -s> command."
12650 #: ../src/guestfs-actions.pod:3811
12651 msgid "guestfs_ln_sf"
12655 #: ../src/guestfs-actions.pod:3813
12659 " guestfs_ln_sf (guestfs_h *g,\n"
12660 " const char *target,\n"
12661 " const char *linkname);\n"
12666 #: ../src/guestfs-actions.pod:3818 ../fish/guestfish-actions.pod:2605
12668 "This command creates a symbolic link using the C<ln -sf> command, The I<-f> "
12669 "option removes the link (C<linkname>) if it exists already."
12673 #: ../src/guestfs-actions.pod:3825
12674 msgid "guestfs_lremovexattr"
12678 #: ../src/guestfs-actions.pod:3827
12682 " guestfs_lremovexattr (guestfs_h *g,\n"
12683 " const char *xattr,\n"
12684 " const char *path);\n"
12689 #: ../src/guestfs-actions.pod:3832
12691 "This is the same as C<guestfs_removexattr>, but if C<path> is a symbolic "
12692 "link, then it removes an extended attribute of the link itself."
12696 #: ../src/guestfs-actions.pod:3840
12701 #: ../src/guestfs-actions.pod:3842
12705 " guestfs_ls (guestfs_h *g,\n"
12706 " const char *directory);\n"
12711 #: ../src/guestfs-actions.pod:3846 ../fish/guestfish-actions.pod:2620
12713 "List the files in C<directory> (relative to the root directory, there is no "
12714 "cwd). The '.' and '..' entries are not returned, but hidden files are shown."
12718 #: ../src/guestfs-actions.pod:3850
12720 "This command is mostly useful for interactive sessions. Programs should "
12721 "probably use C<guestfs_readdir> instead."
12725 #: ../src/guestfs-actions.pod:3859
12726 msgid "guestfs_lsetxattr"
12730 #: ../src/guestfs-actions.pod:3861
12734 " guestfs_lsetxattr (guestfs_h *g,\n"
12735 " const char *xattr,\n"
12736 " const char *val,\n"
12738 " const char *path);\n"
12743 #: ../src/guestfs-actions.pod:3868
12745 "This is the same as C<guestfs_setxattr>, but if C<path> is a symbolic link, "
12746 "then it sets an extended attribute of the link itself."
12750 #: ../src/guestfs-actions.pod:3876
12751 msgid "guestfs_lstat"
12755 #: ../src/guestfs-actions.pod:3878
12758 " struct guestfs_stat *\n"
12759 " guestfs_lstat (guestfs_h *g,\n"
12760 " const char *path);\n"
12765 #: ../src/guestfs-actions.pod:3882 ../src/guestfs-actions.pod:6636
12766 #: ../fish/guestfish-actions.pod:2639 ../fish/guestfish-actions.pod:4426
12767 msgid "Returns file information for the given C<path>."
12771 #: ../src/guestfs-actions.pod:3884
12773 "This is the same as C<guestfs_stat> except that if C<path> is a symbolic "
12774 "link, then the link is stat-ed, not the file it refers to."
12778 #: ../src/guestfs-actions.pod:3888 ../fish/guestfish-actions.pod:2645
12779 msgid "This is the same as the C<lstat(2)> system call."
12783 #: ../src/guestfs-actions.pod:3890 ../src/guestfs-actions.pod:6640
12785 "This function returns a C<struct guestfs_stat *>, or NULL if there was an "
12786 "error. I<The caller must call C<guestfs_free_stat> after use>."
12790 #: ../src/guestfs-actions.pod:3894 ../src/guestfs-actions.pod:6644
12791 #: ../src/guestfs-actions.pod:6662 ../src/guestfs-actions.pod:7043
12792 msgid "(Added in 0.9.2)"
12796 #: ../src/guestfs-actions.pod:3896
12797 msgid "guestfs_lstatlist"
12801 #: ../src/guestfs-actions.pod:3898
12804 " struct guestfs_stat_list *\n"
12805 " guestfs_lstatlist (guestfs_h *g,\n"
12806 " const char *path,\n"
12807 " char *const *names);\n"
12812 #: ../src/guestfs-actions.pod:3903
12814 "This call allows you to perform the C<guestfs_lstat> operation on multiple "
12815 "files, where all files are in the directory C<path>. C<names> is the list "
12816 "of files from this directory."
12820 #: ../src/guestfs-actions.pod:3907 ../fish/guestfish-actions.pod:2655
12822 "On return you get a list of stat structs, with a one-to-one correspondence "
12823 "to the C<names> list. If any name did not exist or could not be lstat'd, "
12824 "then the C<ino> field of that structure is set to C<-1>."
12828 #: ../src/guestfs-actions.pod:3912
12830 "This call is intended for programs that want to efficiently list a directory "
12831 "contents without making many round-trips. See also C<guestfs_lxattrlist> "
12832 "for a similarly efficient call for getting extended attributes. Very long "
12833 "directory listings might cause the protocol message size to be exceeded, "
12834 "causing this call to fail. The caller must split up such requests into "
12835 "smaller groups of names."
12839 #: ../src/guestfs-actions.pod:3920
12841 "This function returns a C<struct guestfs_stat_list *>, or NULL if there was "
12842 "an error. I<The caller must call C<guestfs_free_stat_list> after use>."
12846 #: ../src/guestfs-actions.pod:3926
12847 msgid "guestfs_luks_add_key"
12851 #: ../src/guestfs-actions.pod:3928
12855 " guestfs_luks_add_key (guestfs_h *g,\n"
12856 " const char *device,\n"
12857 " const char *key,\n"
12858 " const char *newkey,\n"
12864 #: ../src/guestfs-actions.pod:3935 ../fish/guestfish-actions.pod:2672
12866 "This command adds a new key on LUKS device C<device>. C<key> is any "
12867 "existing key, and is used to access the device. C<newkey> is the new key to "
12868 "add. C<keyslot> is the key slot that will be replaced."
12872 #: ../src/guestfs-actions.pod:3940
12874 "Note that if C<keyslot> already contains a key, then this command will "
12875 "fail. You have to use C<guestfs_luks_kill_slot> first to remove that key."
12879 #: ../src/guestfs-actions.pod:3946 ../src/guestfs-actions.pod:3986
12880 #: ../src/guestfs-actions.pod:4009 ../src/guestfs-actions.pod:4029
12881 #: ../src/guestfs-actions.pod:4064 ../src/guestfs-actions.pod:4083
12883 "This function takes a key or passphrase parameter which could contain "
12884 "sensitive material. Read the section L</KEYS AND PASSPHRASES> for more "
12889 #: ../src/guestfs-actions.pod:3950 ../src/guestfs-actions.pod:3990
12890 #: ../src/guestfs-actions.pod:4013 ../src/guestfs-actions.pod:4033
12891 msgid "(Added in 1.5.2)"
12895 #: ../src/guestfs-actions.pod:3952
12896 msgid "guestfs_luks_close"
12900 #: ../src/guestfs-actions.pod:3954
12904 " guestfs_luks_close (guestfs_h *g,\n"
12905 " const char *device);\n"
12910 #: ../src/guestfs-actions.pod:3958
12912 "This closes a LUKS device that was created earlier by C<guestfs_luks_open> "
12913 "or C<guestfs_luks_open_ro>. The C<device> parameter must be the name of the "
12914 "LUKS mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
12915 "underlying block device."
12919 #: ../src/guestfs-actions.pod:3966 ../src/guestfs-actions.pod:4068
12920 #: ../src/guestfs-actions.pod:4087 ../src/guestfs-actions.pod:4137
12921 #: ../src/guestfs-actions.pod:4185
12922 msgid "(Added in 1.5.1)"
12926 #: ../src/guestfs-actions.pod:3968
12927 msgid "guestfs_luks_format"
12931 #: ../src/guestfs-actions.pod:3970
12935 " guestfs_luks_format (guestfs_h *g,\n"
12936 " const char *device,\n"
12937 " const char *key,\n"
12943 #: ../src/guestfs-actions.pod:3976 ../fish/guestfish-actions.pod:2698
12945 "This command erases existing data on C<device> and formats the device as a "
12946 "LUKS encrypted device. C<key> is the initial key, which is added to key "
12947 "slot C<slot>. (LUKS supports 8 key slots, numbered 0-7)."
12951 #: ../src/guestfs-actions.pod:3983 ../src/guestfs-actions.pod:4006
12952 #: ../src/guestfs-actions.pod:4149 ../src/guestfs-actions.pod:5252
12953 #: ../src/guestfs-actions.pod:6034 ../src/guestfs-actions.pod:6443
12954 #: ../src/guestfs-actions.pod:6473 ../src/guestfs-actions.pod:6506
12955 #: ../src/guestfs-actions.pod:7682 ../fish/guestfish-actions.pod:2706
12956 #: ../fish/guestfish-actions.pod:2719 ../fish/guestfish-actions.pod:2806
12957 #: ../fish/guestfish-actions.pod:3467 ../fish/guestfish-actions.pod:3987
12958 #: ../fish/guestfish-actions.pod:4297 ../fish/guestfish-actions.pod:4320
12959 #: ../fish/guestfish-actions.pod:4342 ../fish/guestfish-actions.pod:5066
12961 "B<This command is dangerous. Without careful use you can easily destroy all "
12966 #: ../src/guestfs-actions.pod:3992
12967 msgid "guestfs_luks_format_cipher"
12971 #: ../src/guestfs-actions.pod:3994
12975 " guestfs_luks_format_cipher (guestfs_h *g,\n"
12976 " const char *device,\n"
12977 " const char *key,\n"
12979 " const char *cipher);\n"
12984 #: ../src/guestfs-actions.pod:4001
12986 "This command is the same as C<guestfs_luks_format> but it also allows you to "
12987 "set the C<cipher> used."
12991 #: ../src/guestfs-actions.pod:4015
12992 msgid "guestfs_luks_kill_slot"
12996 #: ../src/guestfs-actions.pod:4017
13000 " guestfs_luks_kill_slot (guestfs_h *g,\n"
13001 " const char *device,\n"
13002 " const char *key,\n"
13008 #: ../src/guestfs-actions.pod:4023 ../fish/guestfish-actions.pod:2726
13010 "This command deletes the key in key slot C<keyslot> from the encrypted LUKS "
13011 "device C<device>. C<key> must be one of the I<other> keys."
13015 #: ../src/guestfs-actions.pod:4035
13016 msgid "guestfs_luks_open"
13020 #: ../src/guestfs-actions.pod:4037
13024 " guestfs_luks_open (guestfs_h *g,\n"
13025 " const char *device,\n"
13026 " const char *key,\n"
13027 " const char *mapname);\n"
13032 #: ../src/guestfs-actions.pod:4043 ../fish/guestfish-actions.pod:2737
13034 "This command opens a block device which has been encrypted according to the "
13035 "Linux Unified Key Setup (LUKS) standard."
13039 #: ../src/guestfs-actions.pod:4046 ../fish/guestfish-actions.pod:2740
13040 msgid "C<device> is the encrypted block device or partition."
13044 #: ../src/guestfs-actions.pod:4048 ../fish/guestfish-actions.pod:2742
13046 "The caller must supply one of the keys associated with the LUKS block "
13047 "device, in the C<key> parameter."
13051 #: ../src/guestfs-actions.pod:4051 ../fish/guestfish-actions.pod:2745
13053 "This creates a new block device called C</dev/mapper/mapname>. Reads and "
13054 "writes to this block device are decrypted from and encrypted to the "
13055 "underlying C<device> respectively."
13059 #: ../src/guestfs-actions.pod:4055
13061 "If this block device contains LVM volume groups, then calling "
13062 "C<guestfs_vgscan> followed by C<guestfs_vg_activate_all> will make them "
13067 #: ../src/guestfs-actions.pod:4059
13068 msgid "Use C<guestfs_list_dm_devices> to list all device mapper devices."
13072 #: ../src/guestfs-actions.pod:4070
13073 msgid "guestfs_luks_open_ro"
13077 #: ../src/guestfs-actions.pod:4072
13081 " guestfs_luks_open_ro (guestfs_h *g,\n"
13082 " const char *device,\n"
13083 " const char *key,\n"
13084 " const char *mapname);\n"
13089 #: ../src/guestfs-actions.pod:4078
13091 "This is the same as C<guestfs_luks_open> except that a read-only mapping is "
13096 #: ../src/guestfs-actions.pod:4089
13097 msgid "guestfs_lvcreate"
13101 #: ../src/guestfs-actions.pod:4091
13105 " guestfs_lvcreate (guestfs_h *g,\n"
13106 " const char *logvol,\n"
13107 " const char *volgroup,\n"
13113 #: ../src/guestfs-actions.pod:4097 ../fish/guestfish-actions.pod:2773
13115 "This creates an LVM logical volume called C<logvol> on the volume group "
13116 "C<volgroup>, with C<size> megabytes."
13120 #: ../src/guestfs-actions.pod:4104
13121 msgid "guestfs_lvm_canonical_lv_name"
13125 #: ../src/guestfs-actions.pod:4106
13129 " guestfs_lvm_canonical_lv_name (guestfs_h *g,\n"
13130 " const char *lvname);\n"
13135 #: ../src/guestfs-actions.pod:4110 ../fish/guestfish-actions.pod:2780
13137 "This converts alternative naming schemes for LVs that you might find to the "
13138 "canonical name. For example, C</dev/mapper/VG-LV> is converted to C</dev/VG/"
13143 #: ../src/guestfs-actions.pod:4114 ../fish/guestfish-actions.pod:2784
13145 "This command returns an error if the C<lvname> parameter does not refer to a "
13150 #: ../src/guestfs-actions.pod:4117
13151 msgid "See also C<guestfs_is_lv>."
13155 #: ../src/guestfs-actions.pod:4122
13156 msgid "(Added in 1.5.24)"
13160 #: ../src/guestfs-actions.pod:4124
13161 msgid "guestfs_lvm_clear_filter"
13165 #: ../src/guestfs-actions.pod:4126
13169 " guestfs_lvm_clear_filter (guestfs_h *g);\n"
13174 #: ../src/guestfs-actions.pod:4129
13176 "This undoes the effect of C<guestfs_lvm_set_filter>. LVM will be able to "
13177 "see every block device."
13181 #: ../src/guestfs-actions.pod:4132 ../src/guestfs-actions.pod:4174
13182 #: ../fish/guestfish-actions.pod:2796 ../fish/guestfish-actions.pod:2827
13184 "This command also clears the LVM cache and performs a volume group scan."
13188 #: ../src/guestfs-actions.pod:4139
13189 msgid "guestfs_lvm_remove_all"
13193 #: ../src/guestfs-actions.pod:4141
13197 " guestfs_lvm_remove_all (guestfs_h *g);\n"
13202 #: ../src/guestfs-actions.pod:4144 ../fish/guestfish-actions.pod:2803
13204 "This command removes all LVM logical volumes, volume groups and physical "
13209 #: ../src/guestfs-actions.pod:4154
13210 msgid "guestfs_lvm_set_filter"
13214 #: ../src/guestfs-actions.pod:4156
13218 " guestfs_lvm_set_filter (guestfs_h *g,\n"
13219 " char *const *devices);\n"
13224 #: ../src/guestfs-actions.pod:4160 ../fish/guestfish-actions.pod:2813
13226 "This sets the LVM device filter so that LVM will only be able to \"see\" the "
13227 "block devices in the list C<devices>, and will ignore all other attached "
13232 #: ../src/guestfs-actions.pod:4164 ../fish/guestfish-actions.pod:2817
13234 "Where disk image(s) contain duplicate PVs or VGs, this command is useful to "
13235 "get LVM to ignore the duplicates, otherwise LVM can get confused. Note also "
13236 "there are two types of duplication possible: either cloned PVs/VGs which "
13237 "have identical UUIDs; or VGs that are not cloned but just happen to have the "
13238 "same name. In normal operation you cannot create this situation, but you "
13239 "can do it outside LVM, eg. by cloning disk images or by bit twiddling "
13240 "inside the LVM metadata."
13244 #: ../src/guestfs-actions.pod:4177 ../fish/guestfish-actions.pod:2830
13245 msgid "You can filter whole block devices or individual partitions."
13249 #: ../src/guestfs-actions.pod:4179 ../fish/guestfish-actions.pod:2832
13251 "You cannot use this if any VG is currently in use (eg. contains a mounted "
13252 "filesystem), even if you are not filtering out that VG."
13256 #: ../src/guestfs-actions.pod:4187
13257 msgid "guestfs_lvremove"
13261 #: ../src/guestfs-actions.pod:4189
13265 " guestfs_lvremove (guestfs_h *g,\n"
13266 " const char *device);\n"
13271 #: ../src/guestfs-actions.pod:4193 ../fish/guestfish-actions.pod:2840
13273 "Remove an LVM logical volume C<device>, where C<device> is the path to the "
13274 "LV, such as C</dev/VG/LV>."
13278 #: ../src/guestfs-actions.pod:4196 ../fish/guestfish-actions.pod:2843
13280 "You can also remove all LVs in a volume group by specifying the VG name, C</"
13285 #: ../src/guestfs-actions.pod:4201 ../src/guestfs-actions.pod:5598
13286 #: ../src/guestfs-actions.pod:7413
13287 msgid "(Added in 1.0.13)"
13291 #: ../src/guestfs-actions.pod:4203
13292 msgid "guestfs_lvrename"
13296 #: ../src/guestfs-actions.pod:4205
13300 " guestfs_lvrename (guestfs_h *g,\n"
13301 " const char *logvol,\n"
13302 " const char *newlogvol);\n"
13307 #: ../src/guestfs-actions.pod:4210 ../fish/guestfish-actions.pod:2850
13308 msgid "Rename a logical volume C<logvol> with the new name C<newlogvol>."
13312 #: ../src/guestfs-actions.pod:4214 ../src/guestfs-actions.pod:7426
13313 msgid "(Added in 1.0.83)"
13317 #: ../src/guestfs-actions.pod:4216
13318 msgid "guestfs_lvresize"
13322 #: ../src/guestfs-actions.pod:4218
13326 " guestfs_lvresize (guestfs_h *g,\n"
13327 " const char *device,\n"
13333 #: ../src/guestfs-actions.pod:4223 ../fish/guestfish-actions.pod:2856
13335 "This resizes (expands or shrinks) an existing LVM logical volume to "
13336 "C<mbytes>. When reducing, data in the reduced part is lost."
13340 #: ../src/guestfs-actions.pod:4231
13341 msgid "guestfs_lvresize_free"
13345 #: ../src/guestfs-actions.pod:4233
13349 " guestfs_lvresize_free (guestfs_h *g,\n"
13350 " const char *lv,\n"
13356 #: ../src/guestfs-actions.pod:4238 ../fish/guestfish-actions.pod:2864
13358 "This expands an existing logical volume C<lv> so that it fills C<pc>% of the "
13359 "remaining free space in the volume group. Commonly you would call this with "
13360 "pc = 100 which expands the logical volume as much as possible, using all "
13361 "remaining free space in the volume group."
13365 #: ../src/guestfs-actions.pod:4246
13366 msgid "(Added in 1.3.3)"
13370 #: ../src/guestfs-actions.pod:4248
13371 msgid "guestfs_lvs"
13375 #: ../src/guestfs-actions.pod:4250
13379 " guestfs_lvs (guestfs_h *g);\n"
13384 #: ../src/guestfs-actions.pod:4253 ../fish/guestfish-actions.pod:2874
13386 "List all the logical volumes detected. This is the equivalent of the L<lvs"
13391 #: ../src/guestfs-actions.pod:4256 ../fish/guestfish-actions.pod:2877
13393 "This returns a list of the logical volume device names (eg. C</dev/"
13394 "VolGroup00/LogVol00>)."
13398 #: ../src/guestfs-actions.pod:4259
13399 msgid "See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>."
13403 #: ../src/guestfs-actions.pod:4267
13404 msgid "guestfs_lvs_full"
13408 #: ../src/guestfs-actions.pod:4269
13411 " struct guestfs_lvm_lv_list *\n"
13412 " guestfs_lvs_full (guestfs_h *g);\n"
13417 #: ../src/guestfs-actions.pod:4272 ../fish/guestfish-actions.pod:2886
13419 "List all the logical volumes detected. This is the equivalent of the L<lvs"
13420 "(8)> command. The \"full\" version includes all fields."
13424 #: ../src/guestfs-actions.pod:4275
13426 "This function returns a C<struct guestfs_lvm_lv_list *>, or NULL if there "
13427 "was an error. I<The caller must call C<guestfs_free_lvm_lv_list> after use>."
13431 #: ../src/guestfs-actions.pod:4281
13432 msgid "guestfs_lvuuid"
13436 #: ../src/guestfs-actions.pod:4283
13440 " guestfs_lvuuid (guestfs_h *g,\n"
13441 " const char *device);\n"
13446 #: ../src/guestfs-actions.pod:4287 ../fish/guestfish-actions.pod:2893
13447 msgid "This command returns the UUID of the LVM LV C<device>."
13451 #: ../src/guestfs-actions.pod:4294
13452 msgid "guestfs_lxattrlist"
13456 #: ../src/guestfs-actions.pod:4296
13459 " struct guestfs_xattr_list *\n"
13460 " guestfs_lxattrlist (guestfs_h *g,\n"
13461 " const char *path,\n"
13462 " char *const *names);\n"
13467 #: ../src/guestfs-actions.pod:4301 ../fish/guestfish-actions.pod:2899
13469 "This call allows you to get the extended attributes of multiple files, where "
13470 "all files are in the directory C<path>. C<names> is the list of files from "
13475 #: ../src/guestfs-actions.pod:4305 ../fish/guestfish-actions.pod:2903
13477 "On return you get a flat list of xattr structs which must be interpreted "
13478 "sequentially. The first xattr struct always has a zero-length C<attrname>. "
13479 "C<attrval> in this struct is zero-length to indicate there was an error "
13480 "doing C<lgetxattr> for this file, I<or> is a C string which is a decimal "
13481 "number (the number of following attributes for this file, which could be C<"
13482 "\"0\">). Then after the first xattr struct are the zero or more attributes "
13483 "for the first named file. This repeats for the second and subsequent files."
13487 #: ../src/guestfs-actions.pod:4315
13489 "This call is intended for programs that want to efficiently list a directory "
13490 "contents without making many round-trips. See also C<guestfs_lstatlist> for "
13491 "a similarly efficient call for getting standard stats. Very long directory "
13492 "listings might cause the protocol message size to be exceeded, causing this "
13493 "call to fail. The caller must split up such requests into smaller groups of "
13498 #: ../src/guestfs-actions.pod:4329
13499 msgid "guestfs_mkdir"
13503 #: ../src/guestfs-actions.pod:4331
13507 " guestfs_mkdir (guestfs_h *g,\n"
13508 " const char *path);\n"
13513 #: ../src/guestfs-actions.pod:4335 ../fish/guestfish-actions.pod:2925
13514 msgid "Create a directory named C<path>."
13518 #: ../src/guestfs-actions.pod:4341
13519 msgid "guestfs_mkdir_mode"
13523 #: ../src/guestfs-actions.pod:4343
13527 " guestfs_mkdir_mode (guestfs_h *g,\n"
13528 " const char *path,\n"
13534 #: ../src/guestfs-actions.pod:4348 ../fish/guestfish-actions.pod:2931
13536 "This command creates a directory, setting the initial permissions of the "
13537 "directory to C<mode>."
13541 #: ../src/guestfs-actions.pod:4351 ../fish/guestfish-actions.pod:2934
13543 "For common Linux filesystems, the actual mode which is set will be C<mode & "
13544 "~umask & 01777>. Non-native-Linux filesystems may interpret the mode in "
13549 #: ../src/guestfs-actions.pod:4355
13550 msgid "See also C<guestfs_mkdir>, C<guestfs_umask>"
13554 #: ../src/guestfs-actions.pod:4361
13555 msgid "guestfs_mkdir_p"
13559 #: ../src/guestfs-actions.pod:4363
13563 " guestfs_mkdir_p (guestfs_h *g,\n"
13564 " const char *path);\n"
13569 #: ../src/guestfs-actions.pod:4367 ../fish/guestfish-actions.pod:2944
13571 "Create a directory named C<path>, creating any parent directories as "
13572 "necessary. This is like the C<mkdir -p> shell command."
13576 #: ../src/guestfs-actions.pod:4374
13577 msgid "guestfs_mkdtemp"
13581 #: ../src/guestfs-actions.pod:4376
13585 " guestfs_mkdtemp (guestfs_h *g,\n"
13586 " const char *template);\n"
13591 #: ../src/guestfs-actions.pod:4380 ../fish/guestfish-actions.pod:2951
13593 "This command creates a temporary directory. The C<template> parameter "
13594 "should be a full pathname for the temporary directory name with the final "
13595 "six characters being \"XXXXXX\"."
13599 #: ../src/guestfs-actions.pod:4385 ../fish/guestfish-actions.pod:2956
13601 "For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\", the second one "
13602 "being suitable for Windows filesystems."
13606 #: ../src/guestfs-actions.pod:4388 ../fish/guestfish-actions.pod:2959
13607 msgid "The name of the temporary directory that was created is returned."
13611 #: ../src/guestfs-actions.pod:4391 ../fish/guestfish-actions.pod:2962
13612 msgid "The temporary directory is created with mode 0700 and is owned by root."
13616 #: ../src/guestfs-actions.pod:4394 ../fish/guestfish-actions.pod:2965
13618 "The caller is responsible for deleting the temporary directory and its "
13619 "contents after use."
13623 #: ../src/guestfs-actions.pod:4397 ../fish/guestfish-actions.pod:2968
13624 msgid "See also: L<mkdtemp(3)>"
13628 #: ../src/guestfs-actions.pod:4404
13629 msgid "guestfs_mke2fs_J"
13633 #: ../src/guestfs-actions.pod:4406
13637 " guestfs_mke2fs_J (guestfs_h *g,\n"
13638 " const char *fstype,\n"
13639 " int blocksize,\n"
13640 " const char *device,\n"
13641 " const char *journal);\n"
13646 #: ../src/guestfs-actions.pod:4413 ../fish/guestfish-actions.pod:2974
13648 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
13649 "C<journal>. It is equivalent to the command:"
13653 #: ../src/guestfs-actions.pod:4417 ../fish/guestfish-actions.pod:2978
13656 " mke2fs -t fstype -b blocksize -J device=<journal> <device>\n"
13661 #: ../src/guestfs-actions.pod:4419
13662 msgid "See also C<guestfs_mke2journal>."
13666 #: ../src/guestfs-actions.pod:4423 ../src/guestfs-actions.pod:4441
13667 #: ../src/guestfs-actions.pod:4459 ../src/guestfs-actions.pod:4475
13668 #: ../src/guestfs-actions.pod:4489 ../src/guestfs-actions.pod:4503
13669 #: ../src/guestfs-actions.pod:4562 ../src/guestfs-actions.pod:4839
13670 msgid "(Added in 1.0.68)"
13674 #: ../src/guestfs-actions.pod:4425
13675 msgid "guestfs_mke2fs_JL"
13679 #: ../src/guestfs-actions.pod:4427
13683 " guestfs_mke2fs_JL (guestfs_h *g,\n"
13684 " const char *fstype,\n"
13685 " int blocksize,\n"
13686 " const char *device,\n"
13687 " const char *label);\n"
13692 #: ../src/guestfs-actions.pod:4434 ../fish/guestfish-actions.pod:2986
13694 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
13695 "the journal labeled C<label>."
13699 #: ../src/guestfs-actions.pod:4437
13700 msgid "See also C<guestfs_mke2journal_L>."
13704 #: ../src/guestfs-actions.pod:4443
13705 msgid "guestfs_mke2fs_JU"
13709 #: ../src/guestfs-actions.pod:4445
13713 " guestfs_mke2fs_JU (guestfs_h *g,\n"
13714 " const char *fstype,\n"
13715 " int blocksize,\n"
13716 " const char *device,\n"
13717 " const char *uuid);\n"
13722 #: ../src/guestfs-actions.pod:4452 ../fish/guestfish-actions.pod:2995
13724 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
13725 "the journal with UUID C<uuid>."
13729 #: ../src/guestfs-actions.pod:4455
13730 msgid "See also C<guestfs_mke2journal_U>."
13734 #: ../src/guestfs-actions.pod:4461
13735 msgid "guestfs_mke2journal"
13739 #: ../src/guestfs-actions.pod:4463
13743 " guestfs_mke2journal (guestfs_h *g,\n"
13744 " int blocksize,\n"
13745 " const char *device);\n"
13750 #: ../src/guestfs-actions.pod:4468 ../fish/guestfish-actions.pod:3004
13752 "This creates an ext2 external journal on C<device>. It is equivalent to the "
13757 #: ../src/guestfs-actions.pod:4471 ../fish/guestfish-actions.pod:3007
13760 " mke2fs -O journal_dev -b blocksize device\n"
13765 #: ../src/guestfs-actions.pod:4477
13766 msgid "guestfs_mke2journal_L"
13770 #: ../src/guestfs-actions.pod:4479
13774 " guestfs_mke2journal_L (guestfs_h *g,\n"
13775 " int blocksize,\n"
13776 " const char *label,\n"
13777 " const char *device);\n"
13782 #: ../src/guestfs-actions.pod:4485 ../fish/guestfish-actions.pod:3013
13783 msgid "This creates an ext2 external journal on C<device> with label C<label>."
13787 #: ../src/guestfs-actions.pod:4491
13788 msgid "guestfs_mke2journal_U"
13792 #: ../src/guestfs-actions.pod:4493
13796 " guestfs_mke2journal_U (guestfs_h *g,\n"
13797 " int blocksize,\n"
13798 " const char *uuid,\n"
13799 " const char *device);\n"
13804 #: ../src/guestfs-actions.pod:4499 ../fish/guestfish-actions.pod:3019
13805 msgid "This creates an ext2 external journal on C<device> with UUID C<uuid>."
13809 #: ../src/guestfs-actions.pod:4505
13810 msgid "guestfs_mkfifo"
13814 #: ../src/guestfs-actions.pod:4507
13818 " guestfs_mkfifo (guestfs_h *g,\n"
13820 " const char *path);\n"
13825 #: ../src/guestfs-actions.pod:4512
13827 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
13828 "is just a convenient wrapper around C<guestfs_mknod>."
13832 #: ../src/guestfs-actions.pod:4522
13833 msgid "guestfs_mkfs"
13837 #: ../src/guestfs-actions.pod:4524
13841 " guestfs_mkfs (guestfs_h *g,\n"
13842 " const char *fstype,\n"
13843 " const char *device);\n"
13848 #: ../src/guestfs-actions.pod:4529 ../fish/guestfish-actions.pod:3035
13850 "This creates a filesystem on C<device> (usually a partition or LVM logical "
13851 "volume). The filesystem type is C<fstype>, for example C<ext3>."
13855 #: ../src/guestfs-actions.pod:4537
13856 msgid "guestfs_mkfs_b"
13860 #: ../src/guestfs-actions.pod:4539
13864 " guestfs_mkfs_b (guestfs_h *g,\n"
13865 " const char *fstype,\n"
13866 " int blocksize,\n"
13867 " const char *device);\n"
13872 #: ../src/guestfs-actions.pod:4545
13874 "This call is similar to C<guestfs_mkfs>, but it allows you to control the "
13875 "block size of the resulting filesystem. Supported block sizes depend on the "
13876 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
13880 #: ../src/guestfs-actions.pod:4550 ../src/guestfs-actions.pod:4595
13881 #: ../fish/guestfish-actions.pod:3048 ../fish/guestfish-actions.pod:3075
13883 "For VFAT and NTFS the C<blocksize> parameter is treated as the requested "
13888 #: ../src/guestfs-actions.pod:4555 ../fish/guestfish-actions.pod:3051
13890 "This function is deprecated. In new code, use the C<mkfs_opts> call instead."
13894 #: ../src/guestfs-actions.pod:4564
13895 msgid "guestfs_mkfs_opts"
13899 #: ../src/guestfs-actions.pod:4566
13903 " guestfs_mkfs_opts (guestfs_h *g,\n"
13904 " const char *fstype,\n"
13905 " const char *device,\n"
13911 #: ../src/guestfs-actions.pod:4577
13914 " GUESTFS_MKFS_OPTS_BLOCKSIZE, int blocksize,\n"
13915 " GUESTFS_MKFS_OPTS_FEATURES, const char *features,\n"
13916 " GUESTFS_MKFS_OPTS_INODE, int inode,\n"
13917 " GUESTFS_MKFS_OPTS_SECTORSIZE, int sectorsize,\n"
13922 #: ../src/guestfs-actions.pod:4582 ../fish/guestfish-actions.pod:3062
13924 "This function creates a filesystem on C<device>. The filesystem type is "
13925 "C<fstype>, for example C<ext3>."
13929 #: ../src/guestfs-actions.pod:4589 ../fish/guestfish-actions.pod:3069
13930 msgid "C<blocksize>"
13934 #: ../src/guestfs-actions.pod:4591 ../fish/guestfish-actions.pod:3071
13936 "The filesystem block size. Supported block sizes depend on the filesystem "
13937 "type, but typically they are C<1024>, C<2048> or C<4096> for Linux ext2/3 "
13942 #: ../src/guestfs-actions.pod:4598 ../fish/guestfish-actions.pod:3078
13943 msgid "For UFS block sizes, please see L<mkfs.ufs(8)>."
13947 #: ../src/guestfs-actions.pod:4600 ../fish/guestfish-actions.pod:3080
13948 msgid "C<features>"
13952 #: ../src/guestfs-actions.pod:4602 ../fish/guestfish-actions.pod:3082
13953 msgid "This passes the I<-O> parameter to the external mkfs program."
13957 #: ../src/guestfs-actions.pod:4604 ../fish/guestfish-actions.pod:3084
13959 "For certain filesystem types, this allows extra filesystem features to be "
13960 "selected. See L<mke2fs(8)> and L<mkfs.ufs(8)> for more details."
13964 #: ../src/guestfs-actions.pod:4608 ../fish/guestfish-actions.pod:3088
13966 "You cannot use this optional parameter with the C<gfs> or C<gfs2> filesystem "
13971 #: ../src/guestfs-actions.pod:4611 ../fish/guestfish-actions.pod:3091
13973 #| msgid "C<inspector>"
13975 msgstr "C<inspector>"
13978 #: ../src/guestfs-actions.pod:4613 ../fish/guestfish-actions.pod:3093
13980 "This passes the I<-I> parameter to the external L<mke2fs(8)> program which "
13981 "sets the inode size (only for ext2/3/4 filesystems at present)."
13985 #: ../src/guestfs-actions.pod:4616 ../fish/guestfish-actions.pod:3096
13987 #| msgid "C<inspector>"
13988 msgid "C<sectorsize>"
13989 msgstr "C<inspector>"
13992 #: ../src/guestfs-actions.pod:4618 ../fish/guestfish-actions.pod:3098
13994 "This passes the I<-S> parameter to external L<mkfs.ufs(8)> program, which "
13995 "sets sector size for ufs filesystem."
13999 #: ../src/guestfs-actions.pod:4625
14000 msgid "(Added in 1.7.19)"
14004 #: ../src/guestfs-actions.pod:4627
14005 msgid "guestfs_mkfs_opts_va"
14009 #: ../src/guestfs-actions.pod:4629
14013 " guestfs_mkfs_opts_va (guestfs_h *g,\n"
14014 " const char *fstype,\n"
14015 " const char *device,\n"
14016 " va_list args);\n"
14021 #: ../src/guestfs-actions.pod:4635
14022 msgid "This is the \"va_list variant\" of L</guestfs_mkfs_opts>."
14026 #: ../src/guestfs-actions.pod:4639
14027 msgid "guestfs_mkfs_opts_argv"
14031 #: ../src/guestfs-actions.pod:4641
14035 " guestfs_mkfs_opts_argv (guestfs_h *g,\n"
14036 " const char *fstype,\n"
14037 " const char *device,\n"
14038 " const struct guestfs_mkfs_opts_argv *optargs);\n"
14043 #: ../src/guestfs-actions.pod:4647
14044 msgid "This is the \"argv variant\" of L</guestfs_mkfs_opts>."
14048 #: ../src/guestfs-actions.pod:4651
14049 msgid "guestfs_mkmountpoint"
14053 #: ../src/guestfs-actions.pod:4653
14057 " guestfs_mkmountpoint (guestfs_h *g,\n"
14058 " const char *exemptpath);\n"
14063 #: ../src/guestfs-actions.pod:4657
14065 "C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are specialized calls "
14066 "that can be used to create extra mountpoints before mounting the first "
14071 #: ../src/guestfs-actions.pod:4661 ../fish/guestfish-actions.pod:3113
14073 "These calls are I<only> necessary in some very limited circumstances, mainly "
14074 "the case where you want to mount a mix of unrelated and/or read-only "
14075 "filesystems together."
14079 #: ../src/guestfs-actions.pod:4665 ../fish/guestfish-actions.pod:3117
14081 "For example, live CDs often contain a \"Russian doll\" nest of filesystems, "
14082 "an ISO outer layer, with a squashfs image inside, with an ext2/3 image "
14083 "inside that. You can unpack this as follows in guestfish:"
14087 #: ../src/guestfs-actions.pod:4670 ../fish/guestfish-actions.pod:3122
14090 " add-ro Fedora-11-i686-Live.iso\n"
14092 " mkmountpoint /cd\n"
14093 " mkmountpoint /sqsh\n"
14094 " mkmountpoint /ext3fs\n"
14095 " mount /dev/sda /cd\n"
14096 " mount-loop /cd/LiveOS/squashfs.img /sqsh\n"
14097 " mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs\n"
14102 #: ../src/guestfs-actions.pod:4679 ../fish/guestfish-actions.pod:3131
14103 msgid "The inner filesystem is now unpacked under the /ext3fs mountpoint."
14107 #: ../src/guestfs-actions.pod:4681
14109 "C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>. You "
14110 "may get unexpected errors if you try to mix these calls. It is safest to "
14111 "manually unmount filesystems and remove mountpoints after use."
14115 #: ../src/guestfs-actions.pod:4685
14117 "C<guestfs_umount_all> unmounts filesystems by sorting the paths longest "
14118 "first, so for this to work for manual mountpoints, you must ensure that the "
14119 "innermost mountpoints have the longest pathnames, as in the example code "
14124 #: ../src/guestfs-actions.pod:4690 ../fish/guestfish-actions.pod:3142
14126 "For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>"
14130 #: ../src/guestfs-actions.pod:4692
14132 "Autosync [see C<guestfs_set_autosync>, this is set by default on handles] "
14133 "can cause C<guestfs_umount_all> to be called when the handle is closed which "
14134 "can also trigger these issues."
14138 #: ../src/guestfs-actions.pod:4698 ../src/guestfs-actions.pod:5014
14139 #: ../src/guestfs-actions.pod:6018
14140 msgid "(Added in 1.0.62)"
14144 #: ../src/guestfs-actions.pod:4700
14145 msgid "guestfs_mknod"
14149 #: ../src/guestfs-actions.pod:4702
14153 " guestfs_mknod (guestfs_h *g,\n"
14157 " const char *path);\n"
14162 #: ../src/guestfs-actions.pod:4709 ../fish/guestfish-actions.pod:3152
14164 "This call creates block or character special devices, or named pipes (FIFOs)."
14168 #: ../src/guestfs-actions.pod:4712 ../fish/guestfish-actions.pod:3155
14170 "The C<mode> parameter should be the mode, using the standard constants. "
14171 "C<devmajor> and C<devminor> are the device major and minor numbers, only "
14172 "used when creating block and character special devices."
14176 #: ../src/guestfs-actions.pod:4717
14178 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
14179 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
14180 "regular file). These constants are available in the standard Linux header "
14181 "files, or you can use C<guestfs_mknod_b>, C<guestfs_mknod_c> or "
14182 "C<guestfs_mkfifo> which are wrappers around this command which bitwise OR in "
14183 "the appropriate constant for you."
14187 #: ../src/guestfs-actions.pod:4731
14188 msgid "guestfs_mknod_b"
14192 #: ../src/guestfs-actions.pod:4733
14196 " guestfs_mknod_b (guestfs_h *g,\n"
14200 " const char *path);\n"
14205 #: ../src/guestfs-actions.pod:4740
14207 "This call creates a block device node called C<path> with mode C<mode> and "
14208 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
14209 "wrapper around C<guestfs_mknod>."
14213 #: ../src/guestfs-actions.pod:4750
14214 msgid "guestfs_mknod_c"
14218 #: ../src/guestfs-actions.pod:4752
14222 " guestfs_mknod_c (guestfs_h *g,\n"
14226 " const char *path);\n"
14231 #: ../src/guestfs-actions.pod:4759
14233 "This call creates a char device node called C<path> with mode C<mode> and "
14234 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
14235 "wrapper around C<guestfs_mknod>."
14239 #: ../src/guestfs-actions.pod:4769
14240 msgid "guestfs_mkswap"
14244 #: ../src/guestfs-actions.pod:4771
14248 " guestfs_mkswap (guestfs_h *g,\n"
14249 " const char *device);\n"
14254 #: ../src/guestfs-actions.pod:4775 ../fish/guestfish-actions.pod:3194
14255 msgid "Create a swap partition on C<device>."
14259 #: ../src/guestfs-actions.pod:4781
14260 msgid "guestfs_mkswap_L"
14264 #: ../src/guestfs-actions.pod:4783
14268 " guestfs_mkswap_L (guestfs_h *g,\n"
14269 " const char *label,\n"
14270 " const char *device);\n"
14275 #: ../src/guestfs-actions.pod:4788 ../fish/guestfish-actions.pod:3200
14276 msgid "Create a swap partition on C<device> with label C<label>."
14280 #: ../src/guestfs-actions.pod:4790 ../fish/guestfish-actions.pod:3202
14282 "Note that you cannot attach a swap label to a block device (eg. C</dev/"
14283 "sda>), just to a partition. This appears to be a limitation of the kernel "
14288 #: ../src/guestfs-actions.pod:4798
14289 msgid "guestfs_mkswap_U"
14293 #: ../src/guestfs-actions.pod:4800
14297 " guestfs_mkswap_U (guestfs_h *g,\n"
14298 " const char *uuid,\n"
14299 " const char *device);\n"
14304 #: ../src/guestfs-actions.pod:4805 ../fish/guestfish-actions.pod:3210
14305 msgid "Create a swap partition on C<device> with UUID C<uuid>."
14309 #: ../src/guestfs-actions.pod:4811
14310 msgid "guestfs_mkswap_file"
14314 #: ../src/guestfs-actions.pod:4813
14318 " guestfs_mkswap_file (guestfs_h *g,\n"
14319 " const char *path);\n"
14324 #: ../src/guestfs-actions.pod:4817 ../fish/guestfish-actions.pod:3216
14325 msgid "Create a swap file."
14329 #: ../src/guestfs-actions.pod:4819
14331 "This command just writes a swap file signature to an existing file. To "
14332 "create the file itself, use something like C<guestfs_fallocate>."
14336 #: ../src/guestfs-actions.pod:4826
14337 msgid "guestfs_modprobe"
14341 #: ../src/guestfs-actions.pod:4828
14345 " guestfs_modprobe (guestfs_h *g,\n"
14346 " const char *modulename);\n"
14351 #: ../src/guestfs-actions.pod:4832 ../fish/guestfish-actions.pod:3225
14352 msgid "This loads a kernel module in the appliance."
14356 #: ../src/guestfs-actions.pod:4834 ../fish/guestfish-actions.pod:3227
14358 "The kernel module must have been whitelisted when libguestfs was built (see "
14359 "C<appliance/kmod.whitelist.in> in the source)."
14363 #: ../src/guestfs-actions.pod:4841
14364 msgid "guestfs_mount"
14368 #: ../src/guestfs-actions.pod:4843
14372 " guestfs_mount (guestfs_h *g,\n"
14373 " const char *device,\n"
14374 " const char *mountpoint);\n"
14379 #: ../src/guestfs-actions.pod:4848 ../fish/guestfish-actions.pod:3234
14381 "Mount a guest disk at a position in the filesystem. Block devices are named "
14382 "C</dev/sda>, C</dev/sdb> and so on, as they were added to the guest. If "
14383 "those block devices contain partitions, they will have the usual names (eg. "
14384 "C</dev/sda1>). Also LVM C</dev/VG/LV>-style names can be used."
14388 #: ../src/guestfs-actions.pod:4854 ../fish/guestfish-actions.pod:3240
14390 "The rules are the same as for L<mount(2)>: A filesystem must first be "
14391 "mounted on C</> before others can be mounted. Other filesystems can only be "
14392 "mounted on directories which already exist."
14396 #: ../src/guestfs-actions.pod:4859 ../fish/guestfish-actions.pod:3245
14398 "The mounted filesystem is writable, if we have sufficient permissions on the "
14399 "underlying device."
14403 #: ../src/guestfs-actions.pod:4862
14405 "B<Important note:> When you use this call, the filesystem options C<sync> "
14406 "and C<noatime> are set implicitly. This was originally done because we "
14407 "thought it would improve reliability, but it turns out that I<-o sync> has a "
14408 "very large negative performance impact and negligible effect on "
14409 "reliability. Therefore we recommend that you avoid using C<guestfs_mount> "
14410 "in any code that needs performance, and instead use C<guestfs_mount_options> "
14411 "(use an empty string for the first parameter if you don't want any options)."
14415 #: ../src/guestfs-actions.pod:4874 ../fish/guestfish-actions.pod:3258
14417 "This function is deprecated. In new code, use the C<mount_options> call "
14422 #: ../src/guestfs-actions.pod:4883
14423 msgid "guestfs_mount_9p"
14427 #: ../src/guestfs-actions.pod:4885
14431 " guestfs_mount_9p (guestfs_h *g,\n"
14432 " const char *mounttag,\n"
14433 " const char *mountpoint,\n"
14439 #: ../src/guestfs-actions.pod:4896
14442 " GUESTFS_MOUNT_9P_OPTIONS, const char *options,\n"
14447 #: ../src/guestfs-actions.pod:4898 ../fish/guestfish-actions.pod:3269
14449 "Mount the virtio-9p filesystem with the tag C<mounttag> on the directory "
14454 #: ../src/guestfs-actions.pod:4901 ../fish/guestfish-actions.pod:3272
14456 "If required, C<trans=virtio> will be automatically added to the options. "
14457 "Any other options required can be passed in the optional C<options> "
14462 #: ../src/guestfs-actions.pod:4909
14463 msgid "guestfs_mount_9p_va"
14467 #: ../src/guestfs-actions.pod:4911
14471 " guestfs_mount_9p_va (guestfs_h *g,\n"
14472 " const char *mounttag,\n"
14473 " const char *mountpoint,\n"
14474 " va_list args);\n"
14479 #: ../src/guestfs-actions.pod:4917
14480 msgid "This is the \"va_list variant\" of L</guestfs_mount_9p>."
14484 #: ../src/guestfs-actions.pod:4921
14485 msgid "guestfs_mount_9p_argv"
14489 #: ../src/guestfs-actions.pod:4923
14493 " guestfs_mount_9p_argv (guestfs_h *g,\n"
14494 " const char *mounttag,\n"
14495 " const char *mountpoint,\n"
14496 " const struct guestfs_mount_9p_argv *optargs);\n"
14501 #: ../src/guestfs-actions.pod:4929
14502 msgid "This is the \"argv variant\" of L</guestfs_mount_9p>."
14506 #: ../src/guestfs-actions.pod:4933
14507 msgid "guestfs_mount_loop"
14511 #: ../src/guestfs-actions.pod:4935
14515 " guestfs_mount_loop (guestfs_h *g,\n"
14516 " const char *file,\n"
14517 " const char *mountpoint);\n"
14522 #: ../src/guestfs-actions.pod:4940 ../fish/guestfish-actions.pod:3282
14524 "This command lets you mount C<file> (a filesystem image in a file) on a "
14525 "mount point. It is entirely equivalent to the command C<mount -o loop file "
14530 #: ../src/guestfs-actions.pod:4948
14531 msgid "guestfs_mount_options"
14535 #: ../src/guestfs-actions.pod:4950
14539 " guestfs_mount_options (guestfs_h *g,\n"
14540 " const char *options,\n"
14541 " const char *device,\n"
14542 " const char *mountpoint);\n"
14547 #: ../src/guestfs-actions.pod:4956
14549 "This is the same as the C<guestfs_mount> command, but it allows you to set "
14550 "the mount options as for the L<mount(8)> I<-o> flag."
14554 #: ../src/guestfs-actions.pod:4960 ../fish/guestfish-actions.pod:3294
14556 "If the C<options> parameter is an empty string, then no options are passed "
14557 "(all options default to whatever the filesystem uses)."
14561 #: ../src/guestfs-actions.pod:4966 ../src/guestfs-actions.pod:4980
14562 #: ../src/guestfs-actions.pod:4997
14563 msgid "(Added in 1.0.10)"
14567 #: ../src/guestfs-actions.pod:4968
14568 msgid "guestfs_mount_ro"
14572 #: ../src/guestfs-actions.pod:4970
14576 " guestfs_mount_ro (guestfs_h *g,\n"
14577 " const char *device,\n"
14578 " const char *mountpoint);\n"
14583 #: ../src/guestfs-actions.pod:4975
14585 "This is the same as the C<guestfs_mount> command, but it mounts the "
14586 "filesystem with the read-only (I<-o ro>) flag."
14590 #: ../src/guestfs-actions.pod:4982
14591 msgid "guestfs_mount_vfs"
14595 #: ../src/guestfs-actions.pod:4984
14599 " guestfs_mount_vfs (guestfs_h *g,\n"
14600 " const char *options,\n"
14601 " const char *vfstype,\n"
14602 " const char *device,\n"
14603 " const char *mountpoint);\n"
14608 #: ../src/guestfs-actions.pod:4991
14610 "This is the same as the C<guestfs_mount> command, but it allows you to set "
14611 "both the mount options and the vfstype as for the L<mount(8)> I<-o> and I<-"
14616 #: ../src/guestfs-actions.pod:4999
14617 msgid "guestfs_mountpoints"
14621 #: ../src/guestfs-actions.pod:5001
14625 " guestfs_mountpoints (guestfs_h *g);\n"
14630 #: ../src/guestfs-actions.pod:5004
14632 "This call is similar to C<guestfs_mounts>. That call returns a list of "
14633 "devices. This one returns a hash table (map) of device name to directory "
14634 "where the device is mounted."
14638 #: ../src/guestfs-actions.pod:5016
14639 msgid "guestfs_mounts"
14643 #: ../src/guestfs-actions.pod:5018
14647 " guestfs_mounts (guestfs_h *g);\n"
14652 #: ../src/guestfs-actions.pod:5021 ../fish/guestfish-actions.pod:3325
14654 "This returns the list of currently mounted filesystems. It returns the list "
14655 "of devices (eg. C</dev/sda1>, C</dev/VG/LV>)."
14659 #: ../src/guestfs-actions.pod:5024 ../fish/guestfish-actions.pod:3328
14660 msgid "Some internal mounts are not shown."
14664 #: ../src/guestfs-actions.pod:5026
14665 msgid "See also: C<guestfs_mountpoints>"
14669 #: ../src/guestfs-actions.pod:5034
14674 #: ../src/guestfs-actions.pod:5036
14678 " guestfs_mv (guestfs_h *g,\n"
14679 " const char *src,\n"
14680 " const char *dest);\n"
14685 #: ../src/guestfs-actions.pod:5041 ../fish/guestfish-actions.pod:3336
14687 "This moves a file from C<src> to C<dest> where C<dest> is either a "
14688 "destination filename or destination directory."
14692 #: ../src/guestfs-actions.pod:5048
14693 msgid "guestfs_ntfs_3g_probe"
14697 #: ../src/guestfs-actions.pod:5050
14701 " guestfs_ntfs_3g_probe (guestfs_h *g,\n"
14703 " const char *device);\n"
14708 #: ../src/guestfs-actions.pod:5055 ../fish/guestfish-actions.pod:3343
14710 "This command runs the L<ntfs-3g.probe(8)> command which probes an NTFS "
14711 "C<device> for mountability. (Not all NTFS volumes can be mounted read-"
14712 "write, and some cannot be mounted at all)."
14716 #: ../src/guestfs-actions.pod:5059 ../fish/guestfish-actions.pod:3347
14718 "C<rw> is a boolean flag. Set it to true if you want to test if the volume "
14719 "can be mounted read-write. Set it to false if you want to test if the "
14720 "volume can be mounted read-only."
14724 #: ../src/guestfs-actions.pod:5063 ../fish/guestfish-actions.pod:3351
14726 "The return value is an integer which C<0> if the operation would succeed, or "
14727 "some non-zero value documented in the L<ntfs-3g.probe(8)> manual page."
14731 #: ../src/guestfs-actions.pod:5069
14732 msgid "(Added in 1.0.43)"
14736 #: ../src/guestfs-actions.pod:5071
14737 msgid "guestfs_ntfsresize"
14741 #: ../src/guestfs-actions.pod:5073
14745 " guestfs_ntfsresize (guestfs_h *g,\n"
14746 " const char *device);\n"
14751 #: ../src/guestfs-actions.pod:5077 ../src/guestfs-actions.pod:5116
14752 #: ../fish/guestfish-actions.pod:3359 ../fish/guestfish-actions.pod:3383
14754 "This command resizes an NTFS filesystem, expanding or shrinking it to the "
14755 "size of the underlying device."
14759 #: ../src/guestfs-actions.pod:5080 ../fish/guestfish-actions.pod:3362
14761 "I<Note:> After the resize operation, the filesystem is marked as requiring a "
14762 "consistency check (for safety). You have to boot into Windows to perform "
14763 "this check and clear this condition. Furthermore, ntfsresize refuses to "
14764 "resize filesystems which have been marked in this way. So in effect it is "
14765 "not possible to call ntfsresize multiple times on a single filesystem "
14766 "without booting into Windows between each resize."
14770 #: ../src/guestfs-actions.pod:5088 ../src/guestfs-actions.pod:5142
14771 #: ../fish/guestfish-actions.pod:3370 ../fish/guestfish-actions.pod:3409
14773 #| msgid "See L<guestfish(1)>."
14774 msgid "See also L<ntfsresize(8)>."
14775 msgstr "Див. L<guestfish(1)>."
14778 #: ../src/guestfs-actions.pod:5092 ../src/guestfs-actions.pod:5182
14779 #: ../fish/guestfish-actions.pod:3372 ../fish/guestfish-actions.pod:3420
14781 "This function is deprecated. In new code, use the C<ntfsresize_opts> call "
14786 #: ../src/guestfs-actions.pod:5101
14787 msgid "guestfs_ntfsresize_opts"
14791 #: ../src/guestfs-actions.pod:5103
14795 " guestfs_ntfsresize_opts (guestfs_h *g,\n"
14796 " const char *device,\n"
14802 #: ../src/guestfs-actions.pod:5113
14805 " GUESTFS_NTFSRESIZE_OPTS_SIZE, int64_t size,\n"
14806 " GUESTFS_NTFSRESIZE_OPTS_FORCE, int force,\n"
14811 #: ../src/guestfs-actions.pod:5119 ../fish/guestfish-actions.pod:3386
14812 msgid "The optional parameters are:"
14816 #: ../src/guestfs-actions.pod:5123 ../fish/guestfish-actions.pod:3390
14818 #| msgid "C<inspector>"
14820 msgstr "C<inspector>"
14823 #: ../src/guestfs-actions.pod:5125 ../fish/guestfish-actions.pod:3392
14825 "The new size (in bytes) of the filesystem. If omitted, the filesystem is "
14826 "resized to fit the container (eg. partition)."
14830 #: ../src/guestfs-actions.pod:5128 ../fish/guestfish-actions.pod:3395
14832 #| msgid "C<format>"
14837 #: ../src/guestfs-actions.pod:5130 ../fish/guestfish-actions.pod:3397
14839 "If this option is true, then force the resize of the filesystem even if the "
14840 "filesystem is marked as requiring a consistency check."
14844 #: ../src/guestfs-actions.pod:5133
14846 "After the resize operation, the filesystem is always marked as requiring a "
14847 "consistency check (for safety). You have to boot into Windows to perform "
14848 "this check and clear this condition. If you I<don't> set the C<force> "
14849 "option then it is not possible to call C<guestfs_ntfsresize_opts> multiple "
14850 "times on a single filesystem without booting into Windows between each "
14855 #: ../src/guestfs-actions.pod:5148
14856 msgid "guestfs_ntfsresize_opts_va"
14860 #: ../src/guestfs-actions.pod:5150
14864 " guestfs_ntfsresize_opts_va (guestfs_h *g,\n"
14865 " const char *device,\n"
14866 " va_list args);\n"
14871 #: ../src/guestfs-actions.pod:5155
14872 msgid "This is the \"va_list variant\" of L</guestfs_ntfsresize_opts>."
14876 #: ../src/guestfs-actions.pod:5159
14877 msgid "guestfs_ntfsresize_opts_argv"
14881 #: ../src/guestfs-actions.pod:5161
14885 " guestfs_ntfsresize_opts_argv (guestfs_h *g,\n"
14886 " const char *device,\n"
14887 " const struct guestfs_ntfsresize_opts_argv *optargs);\n"
14892 #: ../src/guestfs-actions.pod:5166
14893 msgid "This is the \"argv variant\" of L</guestfs_ntfsresize_opts>."
14897 #: ../src/guestfs-actions.pod:5170
14898 msgid "guestfs_ntfsresize_size"
14902 #: ../src/guestfs-actions.pod:5172
14906 " guestfs_ntfsresize_size (guestfs_h *g,\n"
14907 " const char *device,\n"
14908 " int64_t size);\n"
14913 #: ../src/guestfs-actions.pod:5177
14915 "This command is the same as C<guestfs_ntfsresize> except that it allows you "
14916 "to specify the new size (in bytes) explicitly."
14920 #: ../src/guestfs-actions.pod:5189 ../src/guestfs-actions.pod:5625
14921 #: ../src/guestfs-actions.pod:5698 ../src/guestfs-actions.pod:5966
14922 #: ../src/guestfs-actions.pod:7568
14923 msgid "(Added in 1.3.14)"
14927 #: ../src/guestfs-actions.pod:5191
14928 msgid "guestfs_part_add"
14932 #: ../src/guestfs-actions.pod:5193
14936 " guestfs_part_add (guestfs_h *g,\n"
14937 " const char *device,\n"
14938 " const char *prlogex,\n"
14939 " int64_t startsect,\n"
14940 " int64_t endsect);\n"
14945 #: ../src/guestfs-actions.pod:5200
14947 "This command adds a partition to C<device>. If there is no partition table "
14948 "on the device, call C<guestfs_part_init> first."
14952 #: ../src/guestfs-actions.pod:5203 ../fish/guestfish-actions.pod:3434
14954 "The C<prlogex> parameter is the type of partition. Normally you should pass "
14955 "C<p> or C<primary> here, but MBR partition tables also support C<l> (or "
14956 "C<logical>) and C<e> (or C<extended>) partition types."
14960 #: ../src/guestfs-actions.pod:5208 ../fish/guestfish-actions.pod:3439
14962 "C<startsect> and C<endsect> are the start and end of the partition in "
14963 "I<sectors>. C<endsect> may be negative, which means it counts backwards "
14964 "from the end of the disk (C<-1> is the last sector)."
14968 #: ../src/guestfs-actions.pod:5212
14970 "Creating a partition which covers the whole disk is not so easy. Use "
14971 "C<guestfs_part_disk> to do that."
14975 #: ../src/guestfs-actions.pod:5217 ../src/guestfs-actions.pod:5255
14976 #: ../src/guestfs-actions.pod:5308 ../src/guestfs-actions.pod:5386
14977 #: ../src/guestfs-actions.pod:5424 ../src/guestfs-actions.pod:5443
14978 #: ../src/guestfs-actions.pod:5483
14979 msgid "(Added in 1.0.78)"
14983 #: ../src/guestfs-actions.pod:5219
14984 msgid "guestfs_part_del"
14988 #: ../src/guestfs-actions.pod:5221
14992 " guestfs_part_del (guestfs_h *g,\n"
14993 " const char *device,\n"
14999 #: ../src/guestfs-actions.pod:5226 ../fish/guestfish-actions.pod:3450
15000 msgid "This command deletes the partition numbered C<partnum> on C<device>."
15004 #: ../src/guestfs-actions.pod:5228 ../fish/guestfish-actions.pod:3452
15006 "Note that in the case of MBR partitioning, deleting an extended partition "
15007 "also deletes any logical partitions it contains."
15011 #: ../src/guestfs-actions.pod:5236
15012 msgid "guestfs_part_disk"
15016 #: ../src/guestfs-actions.pod:5238
15020 " guestfs_part_disk (guestfs_h *g,\n"
15021 " const char *device,\n"
15022 " const char *parttype);\n"
15027 #: ../src/guestfs-actions.pod:5243
15029 "This command is simply a combination of C<guestfs_part_init> followed by "
15030 "C<guestfs_part_add> to create a single primary partition covering the whole "
15035 #: ../src/guestfs-actions.pod:5247
15037 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
15038 "possible values are described in C<guestfs_part_init>."
15042 #: ../src/guestfs-actions.pod:5257
15043 msgid "guestfs_part_get_bootable"
15047 #: ../src/guestfs-actions.pod:5259
15051 " guestfs_part_get_bootable (guestfs_h *g,\n"
15052 " const char *device,\n"
15058 #: ../src/guestfs-actions.pod:5264 ../fish/guestfish-actions.pod:3474
15060 "This command returns true if the partition C<partnum> on C<device> has the "
15061 "bootable flag set."
15065 #: ../src/guestfs-actions.pod:5267
15066 msgid "See also C<guestfs_part_set_bootable>."
15070 #: ../src/guestfs-actions.pod:5273
15071 msgid "guestfs_part_get_mbr_id"
15075 #: ../src/guestfs-actions.pod:5275
15079 " guestfs_part_get_mbr_id (guestfs_h *g,\n"
15080 " const char *device,\n"
15086 #: ../src/guestfs-actions.pod:5280 ../fish/guestfish-actions.pod:3483
15088 "Returns the MBR type byte (also known as the ID byte) from the numbered "
15089 "partition C<partnum>."
15093 #: ../src/guestfs-actions.pod:5283 ../src/guestfs-actions.pod:5459
15095 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
15096 "undefined results for other partition table types (see "
15097 "C<guestfs_part_get_parttype>)."
15101 #: ../src/guestfs-actions.pod:5291
15102 msgid "guestfs_part_get_parttype"
15106 #: ../src/guestfs-actions.pod:5293
15110 " guestfs_part_get_parttype (guestfs_h *g,\n"
15111 " const char *device);\n"
15116 #: ../src/guestfs-actions.pod:5297 ../fish/guestfish-actions.pod:3494
15118 "This command examines the partition table on C<device> and returns the "
15119 "partition table type (format) being used."
15123 #: ../src/guestfs-actions.pod:5300
15125 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
15126 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
15127 "possible, although unusual. See C<guestfs_part_init> for a full list."
15131 #: ../src/guestfs-actions.pod:5310
15132 msgid "guestfs_part_init"
15136 #: ../src/guestfs-actions.pod:5312
15140 " guestfs_part_init (guestfs_h *g,\n"
15141 " const char *device,\n"
15142 " const char *parttype);\n"
15147 #: ../src/guestfs-actions.pod:5317 ../fish/guestfish-actions.pod:3506
15149 "This creates an empty partition table on C<device> of one of the partition "
15150 "types listed below. Usually C<parttype> should be either C<msdos> or C<gpt> "
15151 "(for large disks)."
15155 #: ../src/guestfs-actions.pod:5321
15157 "Initially there are no partitions. Following this, you should call "
15158 "C<guestfs_part_add> for each partition required."
15162 #: ../src/guestfs-actions.pod:5324 ../fish/guestfish-actions.pod:3513
15163 msgid "Possible values for C<parttype> are:"
15167 #: ../src/guestfs-actions.pod:5328 ../fish/guestfish-actions.pod:3517
15168 msgid "B<efi> | B<gpt>"
15172 #: ../src/guestfs-actions.pod:5330 ../fish/guestfish-actions.pod:3519
15173 msgid "Intel EFI / GPT partition table."
15177 #: ../src/guestfs-actions.pod:5332 ../fish/guestfish-actions.pod:3521
15179 "This is recommended for >= 2 TB partitions that will be accessed from Linux "
15180 "and Intel-based Mac OS X. It also has limited backwards compatibility with "
15181 "the C<mbr> format."
15185 #: ../src/guestfs-actions.pod:5336 ../fish/guestfish-actions.pod:3525
15186 msgid "B<mbr> | B<msdos>"
15190 #: ../src/guestfs-actions.pod:5338 ../fish/guestfish-actions.pod:3527
15192 "The standard PC \"Master Boot Record\" (MBR) format used by MS-DOS and "
15193 "Windows. This partition type will B<only> work for device sizes up to 2 "
15194 "TB. For large disks we recommend using C<gpt>."
15198 #: ../src/guestfs-actions.pod:5345 ../fish/guestfish-actions.pod:3534
15200 "Other partition table types that may work but are not supported include:"
15204 #: ../src/guestfs-actions.pod:5350 ../fish/guestfish-actions.pod:3539
15209 #: ../src/guestfs-actions.pod:5352 ../fish/guestfish-actions.pod:3541
15210 msgid "AIX disk labels."
15214 #: ../src/guestfs-actions.pod:5354 ../fish/guestfish-actions.pod:3543
15215 msgid "B<amiga> | B<rdb>"
15219 #: ../src/guestfs-actions.pod:5356 ../fish/guestfish-actions.pod:3545
15220 msgid "Amiga \"Rigid Disk Block\" format."
15224 #: ../src/guestfs-actions.pod:5358 ../fish/guestfish-actions.pod:3547
15229 #: ../src/guestfs-actions.pod:5360 ../fish/guestfish-actions.pod:3549
15230 msgid "BSD disk labels."
15234 #: ../src/guestfs-actions.pod:5362 ../fish/guestfish-actions.pod:3551
15239 #: ../src/guestfs-actions.pod:5364 ../fish/guestfish-actions.pod:3553
15240 msgid "DASD, used on IBM mainframes."
15244 #: ../src/guestfs-actions.pod:5366 ../fish/guestfish-actions.pod:3555
15249 #: ../src/guestfs-actions.pod:5368 ../fish/guestfish-actions.pod:3557
15250 msgid "MIPS/SGI volumes."
15254 #: ../src/guestfs-actions.pod:5370 ../fish/guestfish-actions.pod:3559
15259 #: ../src/guestfs-actions.pod:5372 ../fish/guestfish-actions.pod:3561
15260 msgid "Old Mac partition format. Modern Macs use C<gpt>."
15264 #: ../src/guestfs-actions.pod:5374 ../fish/guestfish-actions.pod:3563
15269 #: ../src/guestfs-actions.pod:5376 ../fish/guestfish-actions.pod:3565
15270 msgid "NEC PC-98 format, common in Japan apparently."
15274 #: ../src/guestfs-actions.pod:5378 ../fish/guestfish-actions.pod:3567
15279 #: ../src/guestfs-actions.pod:5380 ../fish/guestfish-actions.pod:3569
15280 msgid "Sun disk labels."
15284 #: ../src/guestfs-actions.pod:5388
15285 msgid "guestfs_part_list"
15289 #: ../src/guestfs-actions.pod:5390
15292 " struct guestfs_partition_list *\n"
15293 " guestfs_part_list (guestfs_h *g,\n"
15294 " const char *device);\n"
15299 #: ../src/guestfs-actions.pod:5394 ../fish/guestfish-actions.pod:3577
15301 "This command parses the partition table on C<device> and returns the list of "
15302 "partitions found."
15306 #: ../src/guestfs-actions.pod:5397 ../fish/guestfish-actions.pod:3580
15307 msgid "The fields in the returned structure are:"
15311 #: ../src/guestfs-actions.pod:5401 ../fish/guestfish-actions.pod:3584
15312 msgid "B<part_num>"
15316 #: ../src/guestfs-actions.pod:5403 ../fish/guestfish-actions.pod:3586
15317 msgid "Partition number, counting from 1."
15321 #: ../src/guestfs-actions.pod:5405 ../fish/guestfish-actions.pod:3588
15322 msgid "B<part_start>"
15326 #: ../src/guestfs-actions.pod:5407
15328 "Start of the partition I<in bytes>. To get sectors you have to divide by "
15329 "the device's sector size, see C<guestfs_blockdev_getss>."
15333 #: ../src/guestfs-actions.pod:5410 ../fish/guestfish-actions.pod:3593
15334 msgid "B<part_end>"
15338 #: ../src/guestfs-actions.pod:5412 ../fish/guestfish-actions.pod:3595
15339 msgid "End of the partition in bytes."
15343 #: ../src/guestfs-actions.pod:5414 ../fish/guestfish-actions.pod:3597
15344 msgid "B<part_size>"
15348 #: ../src/guestfs-actions.pod:5416 ../fish/guestfish-actions.pod:3599
15349 msgid "Size of the partition in bytes."
15353 #: ../src/guestfs-actions.pod:5420
15355 "This function returns a C<struct guestfs_partition_list *>, or NULL if there "
15356 "was an error. I<The caller must call C<guestfs_free_partition_list> after "
15361 #: ../src/guestfs-actions.pod:5426
15362 msgid "guestfs_part_set_bootable"
15366 #: ../src/guestfs-actions.pod:5428
15370 " guestfs_part_set_bootable (guestfs_h *g,\n"
15371 " const char *device,\n"
15373 " int bootable);\n"
15378 #: ../src/guestfs-actions.pod:5434 ../fish/guestfish-actions.pod:3607
15380 "This sets the bootable flag on partition numbered C<partnum> on device "
15381 "C<device>. Note that partitions are numbered from 1."
15385 #: ../src/guestfs-actions.pod:5437 ../fish/guestfish-actions.pod:3610
15387 "The bootable flag is used by some operating systems (notably Windows) to "
15388 "determine which partition to boot from. It is by no means universally "
15393 #: ../src/guestfs-actions.pod:5445
15394 msgid "guestfs_part_set_mbr_id"
15398 #: ../src/guestfs-actions.pod:5447
15402 " guestfs_part_set_mbr_id (guestfs_h *g,\n"
15403 " const char *device,\n"
15410 #: ../src/guestfs-actions.pod:5453 ../fish/guestfish-actions.pod:3618
15412 "Sets the MBR type byte (also known as the ID byte) of the numbered partition "
15413 "C<partnum> to C<idbyte>. Note that the type bytes quoted in most "
15414 "documentation are in fact hexadecimal numbers, but usually documented "
15415 "without any leading \"0x\" which might be confusing."
15419 #: ../src/guestfs-actions.pod:5467
15420 msgid "guestfs_part_set_name"
15424 #: ../src/guestfs-actions.pod:5469
15428 " guestfs_part_set_name (guestfs_h *g,\n"
15429 " const char *device,\n"
15431 " const char *name);\n"
15436 #: ../src/guestfs-actions.pod:5475 ../fish/guestfish-actions.pod:3632
15438 "This sets the partition name on partition numbered C<partnum> on device "
15439 "C<device>. Note that partitions are numbered from 1."
15443 #: ../src/guestfs-actions.pod:5478 ../fish/guestfish-actions.pod:3635
15445 "The partition name can only be set on certain types of partition table. "
15446 "This works on C<gpt> but not on C<mbr> partitions."
15450 #: ../src/guestfs-actions.pod:5485
15451 msgid "guestfs_part_to_dev"
15455 #: ../src/guestfs-actions.pod:5487
15459 " guestfs_part_to_dev (guestfs_h *g,\n"
15460 " const char *partition);\n"
15465 #: ../src/guestfs-actions.pod:5491 ../fish/guestfish-actions.pod:3642
15467 "This function takes a partition name (eg. \"/dev/sdb1\") and removes the "
15468 "partition number, returning the device name (eg. \"/dev/sdb\")."
15472 #: ../src/guestfs-actions.pod:5495
15474 "The named partition must exist, for example as a string returned from "
15475 "C<guestfs_list_partitions>."
15479 #: ../src/guestfs-actions.pod:5503
15480 msgid "guestfs_ping_daemon"
15484 #: ../src/guestfs-actions.pod:5505
15488 " guestfs_ping_daemon (guestfs_h *g);\n"
15493 #: ../src/guestfs-actions.pod:5508 ../fish/guestfish-actions.pod:3653
15495 "This is a test probe into the guestfs daemon running inside the qemu "
15496 "subprocess. Calling this function checks that the daemon responds to the "
15497 "ping message, without affecting the daemon or attached block device(s) in "
15502 #: ../src/guestfs-actions.pod:5517
15503 msgid "guestfs_pread"
15507 #: ../src/guestfs-actions.pod:5519
15511 " guestfs_pread (guestfs_h *g,\n"
15512 " const char *path,\n"
15514 " int64_t offset,\n"
15515 " size_t *size_r);\n"
15520 #: ../src/guestfs-actions.pod:5526 ../fish/guestfish-actions.pod:3662
15522 "This command lets you read part of a file. It reads C<count> bytes of the "
15523 "file, starting at C<offset>, from file C<path>."
15527 #: ../src/guestfs-actions.pod:5529 ../src/guestfs-actions.pod:5555
15528 #: ../fish/guestfish-actions.pod:3665 ../fish/guestfish-actions.pod:3680
15530 "This may read fewer bytes than requested. For further details see the "
15531 "L<pread(2)> system call."
15535 #: ../src/guestfs-actions.pod:5532
15536 msgid "See also C<guestfs_pwrite>, C<guestfs_pread_device>."
15540 #: ../src/guestfs-actions.pod:5543
15541 msgid "guestfs_pread_device"
15545 #: ../src/guestfs-actions.pod:5545
15549 " guestfs_pread_device (guestfs_h *g,\n"
15550 " const char *device,\n"
15552 " int64_t offset,\n"
15553 " size_t *size_r);\n"
15558 #: ../src/guestfs-actions.pod:5552 ../fish/guestfish-actions.pod:3677
15560 "This command lets you read part of a file. It reads C<count> bytes of "
15561 "C<device>, starting at C<offset>."
15565 #: ../src/guestfs-actions.pod:5558
15566 msgid "See also C<guestfs_pread>."
15570 #: ../src/guestfs-actions.pod:5567
15571 msgid "(Added in 1.5.21)"
15575 #: ../src/guestfs-actions.pod:5569
15576 msgid "guestfs_pvcreate"
15580 #: ../src/guestfs-actions.pod:5571
15584 " guestfs_pvcreate (guestfs_h *g,\n"
15585 " const char *device);\n"
15590 #: ../src/guestfs-actions.pod:5575 ../fish/guestfish-actions.pod:3692
15592 "This creates an LVM physical volume on the named C<device>, where C<device> "
15593 "should usually be a partition name such as C</dev/sda1>."
15597 #: ../src/guestfs-actions.pod:5583
15598 msgid "guestfs_pvremove"
15602 #: ../src/guestfs-actions.pod:5585
15606 " guestfs_pvremove (guestfs_h *g,\n"
15607 " const char *device);\n"
15612 #: ../src/guestfs-actions.pod:5589 ../fish/guestfish-actions.pod:3700
15614 "This wipes a physical volume C<device> so that LVM will no longer recognise "
15619 #: ../src/guestfs-actions.pod:5592 ../fish/guestfish-actions.pod:3703
15621 "The implementation uses the C<pvremove> command which refuses to wipe "
15622 "physical volumes that contain any volume groups, so you have to remove those "
15627 #: ../src/guestfs-actions.pod:5600
15628 msgid "guestfs_pvresize"
15632 #: ../src/guestfs-actions.pod:5602
15636 " guestfs_pvresize (guestfs_h *g,\n"
15637 " const char *device);\n"
15642 #: ../src/guestfs-actions.pod:5606 ../fish/guestfish-actions.pod:3711
15644 "This resizes (expands or shrinks) an existing LVM physical volume to match "
15645 "the new size of the underlying device."
15649 #: ../src/guestfs-actions.pod:5613
15650 msgid "guestfs_pvresize_size"
15654 #: ../src/guestfs-actions.pod:5615
15658 " guestfs_pvresize_size (guestfs_h *g,\n"
15659 " const char *device,\n"
15660 " int64_t size);\n"
15665 #: ../src/guestfs-actions.pod:5620
15667 "This command is the same as C<guestfs_pvresize> except that it allows you to "
15668 "specify the new size (in bytes) explicitly."
15672 #: ../src/guestfs-actions.pod:5627
15673 msgid "guestfs_pvs"
15677 #: ../src/guestfs-actions.pod:5629
15681 " guestfs_pvs (guestfs_h *g);\n"
15686 #: ../src/guestfs-actions.pod:5632 ../fish/guestfish-actions.pod:3725
15688 "List all the physical volumes detected. This is the equivalent of the L<pvs"
15693 #: ../src/guestfs-actions.pod:5635 ../fish/guestfish-actions.pod:3728
15695 "This returns a list of just the device names that contain PVs (eg. C</dev/"
15700 #: ../src/guestfs-actions.pod:5638
15701 msgid "See also C<guestfs_pvs_full>."
15705 #: ../src/guestfs-actions.pod:5646
15706 msgid "guestfs_pvs_full"
15710 #: ../src/guestfs-actions.pod:5648
15713 " struct guestfs_lvm_pv_list *\n"
15714 " guestfs_pvs_full (guestfs_h *g);\n"
15719 #: ../src/guestfs-actions.pod:5651 ../fish/guestfish-actions.pod:3737
15721 "List all the physical volumes detected. This is the equivalent of the L<pvs"
15722 "(8)> command. The \"full\" version includes all fields."
15726 #: ../src/guestfs-actions.pod:5654
15728 "This function returns a C<struct guestfs_lvm_pv_list *>, or NULL if there "
15729 "was an error. I<The caller must call C<guestfs_free_lvm_pv_list> after use>."
15733 #: ../src/guestfs-actions.pod:5660
15734 msgid "guestfs_pvuuid"
15738 #: ../src/guestfs-actions.pod:5662
15742 " guestfs_pvuuid (guestfs_h *g,\n"
15743 " const char *device);\n"
15748 #: ../src/guestfs-actions.pod:5666 ../fish/guestfish-actions.pod:3744
15749 msgid "This command returns the UUID of the LVM PV C<device>."
15753 #: ../src/guestfs-actions.pod:5673
15754 msgid "guestfs_pwrite"
15758 #: ../src/guestfs-actions.pod:5675
15762 " guestfs_pwrite (guestfs_h *g,\n"
15763 " const char *path,\n"
15764 " const char *content,\n"
15765 " size_t content_size,\n"
15766 " int64_t offset);\n"
15771 #: ../src/guestfs-actions.pod:5682 ../fish/guestfish-actions.pod:3750
15773 "This command writes to part of a file. It writes the data buffer C<content> "
15774 "to the file C<path> starting at offset C<offset>."
15778 #: ../src/guestfs-actions.pod:5685 ../fish/guestfish-actions.pod:3753
15780 "This command implements the L<pwrite(2)> system call, and like that system "
15781 "call it may not write the full data requested. The return value is the "
15782 "number of bytes that were actually written to the file. This could even be "
15783 "0, although short writes are unlikely for regular files in ordinary "
15788 #: ../src/guestfs-actions.pod:5691
15789 msgid "See also C<guestfs_pread>, C<guestfs_pwrite_device>."
15793 #: ../src/guestfs-actions.pod:5700
15794 msgid "guestfs_pwrite_device"
15798 #: ../src/guestfs-actions.pod:5702
15802 " guestfs_pwrite_device (guestfs_h *g,\n"
15803 " const char *device,\n"
15804 " const char *content,\n"
15805 " size_t content_size,\n"
15806 " int64_t offset);\n"
15811 #: ../src/guestfs-actions.pod:5709 ../fish/guestfish-actions.pod:3768
15813 "This command writes to part of a device. It writes the data buffer "
15814 "C<content> to C<device> starting at offset C<offset>."
15818 #: ../src/guestfs-actions.pod:5712 ../fish/guestfish-actions.pod:3771
15820 "This command implements the L<pwrite(2)> system call, and like that system "
15821 "call it may not write the full data requested (although short writes to disk "
15822 "devices and partitions are probably impossible with standard Linux kernels)."
15826 #: ../src/guestfs-actions.pod:5717
15827 msgid "See also C<guestfs_pwrite>."
15831 #: ../src/guestfs-actions.pod:5724
15832 msgid "(Added in 1.5.20)"
15836 #: ../src/guestfs-actions.pod:5726
15837 msgid "guestfs_read_file"
15841 #: ../src/guestfs-actions.pod:5728
15845 " guestfs_read_file (guestfs_h *g,\n"
15846 " const char *path,\n"
15847 " size_t *size_r);\n"
15852 #: ../src/guestfs-actions.pod:5733 ../fish/guestfish-actions.pod:3785
15853 msgid "This calls returns the contents of the file C<path> as a buffer."
15857 #: ../src/guestfs-actions.pod:5736
15859 "Unlike C<guestfs_cat>, this function can correctly handle files that contain "
15860 "embedded ASCII NUL characters. However unlike C<guestfs_download>, this "
15861 "function is limited in the total size of file that can be handled."
15865 #: ../src/guestfs-actions.pod:5748
15866 msgid "(Added in 1.0.63)"
15870 #: ../src/guestfs-actions.pod:5750
15871 msgid "guestfs_read_lines"
15875 #: ../src/guestfs-actions.pod:5752
15879 " guestfs_read_lines (guestfs_h *g,\n"
15880 " const char *path);\n"
15885 #: ../src/guestfs-actions.pod:5758 ../fish/guestfish-actions.pod:3802
15887 "The file contents are returned as a list of lines. Trailing C<LF> and "
15888 "C<CRLF> character sequences are I<not> returned."
15892 #: ../src/guestfs-actions.pod:5761
15894 "Note that this function cannot correctly handle binary files (specifically, "
15895 "files containing C<\\0> character which is treated as end of line). For "
15896 "those you need to use the C<guestfs_read_file> function which has a more "
15897 "complex interface."
15901 #: ../src/guestfs-actions.pod:5772
15902 msgid "guestfs_readdir"
15906 #: ../src/guestfs-actions.pod:5774
15909 " struct guestfs_dirent_list *\n"
15910 " guestfs_readdir (guestfs_h *g,\n"
15911 " const char *dir);\n"
15916 #: ../src/guestfs-actions.pod:5778 ../fish/guestfish-actions.pod:3814
15917 msgid "This returns the list of directory entries in directory C<dir>."
15921 #: ../src/guestfs-actions.pod:5780 ../fish/guestfish-actions.pod:3816
15923 "All entries in the directory are returned, including C<.> and C<..>. The "
15924 "entries are I<not> sorted, but returned in the same order as the underlying "
15929 #: ../src/guestfs-actions.pod:5784 ../fish/guestfish-actions.pod:3820
15931 "Also this call returns basic file type information about each file. The "
15932 "C<ftyp> field will contain one of the following characters:"
15936 #: ../src/guestfs-actions.pod:5789 ../fish/guestfish-actions.pod:3825
15941 #: ../src/guestfs-actions.pod:5791 ../fish/guestfish-actions.pod:3827
15942 msgid "Block special"
15946 #: ../src/guestfs-actions.pod:5793 ../fish/guestfish-actions.pod:3829
15951 #: ../src/guestfs-actions.pod:5795 ../fish/guestfish-actions.pod:3831
15952 msgid "Char special"
15956 #: ../src/guestfs-actions.pod:5797 ../fish/guestfish-actions.pod:3833
15961 #: ../src/guestfs-actions.pod:5799 ../fish/guestfish-actions.pod:3835
15966 #: ../src/guestfs-actions.pod:5801 ../fish/guestfish-actions.pod:3837
15971 #: ../src/guestfs-actions.pod:5803 ../fish/guestfish-actions.pod:3839
15972 msgid "FIFO (named pipe)"
15976 #: ../src/guestfs-actions.pod:5805 ../fish/guestfish-actions.pod:3841
15981 #: ../src/guestfs-actions.pod:5807 ../fish/guestfish-actions.pod:3843
15982 msgid "Symbolic link"
15986 #: ../src/guestfs-actions.pod:5809 ../fish/guestfish-actions.pod:3845
15991 #: ../src/guestfs-actions.pod:5811 ../fish/guestfish-actions.pod:3847
15992 msgid "Regular file"
15996 #: ../src/guestfs-actions.pod:5813 ../fish/guestfish-actions.pod:3849
16001 #: ../src/guestfs-actions.pod:5815 ../fish/guestfish-actions.pod:3851
16006 #: ../src/guestfs-actions.pod:5817 ../fish/guestfish-actions.pod:3853
16011 #: ../src/guestfs-actions.pod:5819 ../fish/guestfish-actions.pod:3855
16012 msgid "Unknown file type"
16016 #: ../src/guestfs-actions.pod:5821 ../fish/guestfish-actions.pod:3857
16021 #: ../src/guestfs-actions.pod:5823 ../fish/guestfish-actions.pod:3859
16023 "The L<readdir(3)> call returned a C<d_type> field with an unexpected value"
16027 #: ../src/guestfs-actions.pod:5828
16029 "This function is primarily intended for use by programs. To get a simple "
16030 "list of names, use C<guestfs_ls>. To get a printable directory for human "
16031 "consumption, use C<guestfs_ll>."
16035 #: ../src/guestfs-actions.pod:5832
16037 "This function returns a C<struct guestfs_dirent_list *>, or NULL if there "
16038 "was an error. I<The caller must call C<guestfs_free_dirent_list> after use>."
16042 #: ../src/guestfs-actions.pod:5838
16043 msgid "guestfs_readlink"
16047 #: ../src/guestfs-actions.pod:5840
16051 " guestfs_readlink (guestfs_h *g,\n"
16052 " const char *path);\n"
16057 #: ../src/guestfs-actions.pod:5844 ../fish/guestfish-actions.pod:3872
16058 msgid "This command reads the target of a symbolic link."
16062 #: ../src/guestfs-actions.pod:5851
16063 msgid "guestfs_readlinklist"
16067 #: ../src/guestfs-actions.pod:5853
16071 " guestfs_readlinklist (guestfs_h *g,\n"
16072 " const char *path,\n"
16073 " char *const *names);\n"
16078 #: ../src/guestfs-actions.pod:5858 ../fish/guestfish-actions.pod:3878
16080 "This call allows you to do a C<readlink> operation on multiple files, where "
16081 "all files are in the directory C<path>. C<names> is the list of files from "
16086 #: ../src/guestfs-actions.pod:5862 ../fish/guestfish-actions.pod:3882
16088 "On return you get a list of strings, with a one-to-one correspondence to the "
16089 "C<names> list. Each string is the value of the symbolic link."
16093 #: ../src/guestfs-actions.pod:5866 ../fish/guestfish-actions.pod:3886
16095 "If the C<readlink(2)> operation fails on any name, then the corresponding "
16096 "result string is the empty string C<\"\">. However the whole operation is "
16097 "completed even if there were C<readlink(2)> errors, and so you can call this "
16098 "function with names where you don't know if they are symbolic links already "
16099 "(albeit slightly less efficient)."
16103 #: ../src/guestfs-actions.pod:5873 ../fish/guestfish-actions.pod:3893
16105 "This call is intended for programs that want to efficiently list a directory "
16106 "contents without making many round-trips. Very long directory listings "
16107 "might cause the protocol message size to be exceeded, causing this call to "
16108 "fail. The caller must split up such requests into smaller groups of names."
16112 #: ../src/guestfs-actions.pod:5886
16113 msgid "guestfs_realpath"
16117 #: ../src/guestfs-actions.pod:5888
16121 " guestfs_realpath (guestfs_h *g,\n"
16122 " const char *path);\n"
16127 #: ../src/guestfs-actions.pod:5892 ../fish/guestfish-actions.pod:3904
16129 "Return the canonicalized absolute pathname of C<path>. The returned path "
16130 "has no C<.>, C<..> or symbolic link path elements."
16134 #: ../src/guestfs-actions.pod:5900
16135 msgid "guestfs_removexattr"
16139 #: ../src/guestfs-actions.pod:5902
16143 " guestfs_removexattr (guestfs_h *g,\n"
16144 " const char *xattr,\n"
16145 " const char *path);\n"
16150 #: ../src/guestfs-actions.pod:5907 ../fish/guestfish-actions.pod:3911
16152 "This call removes the extended attribute named C<xattr> of the file C<path>."
16156 #: ../src/guestfs-actions.pod:5910
16157 msgid "See also: C<guestfs_lremovexattr>, L<attr(5)>."
16161 #: ../src/guestfs-actions.pod:5916
16162 msgid "guestfs_resize2fs"
16166 #: ../src/guestfs-actions.pod:5918
16170 " guestfs_resize2fs (guestfs_h *g,\n"
16171 " const char *device);\n"
16176 #: ../src/guestfs-actions.pod:5922 ../fish/guestfish-actions.pod:3920
16178 "This resizes an ext2, ext3 or ext4 filesystem to match the size of the "
16179 "underlying device."
16183 #: ../src/guestfs-actions.pod:5925
16185 "I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f> on the "
16186 "C<device> before calling this command. For unknown reasons C<resize2fs> "
16187 "sometimes gives an error about this and sometimes not. In any case, it is "
16188 "always safe to call C<guestfs_e2fsck_f> before calling this function."
16192 #: ../src/guestfs-actions.pod:5935
16193 msgid "guestfs_resize2fs_M"
16197 #: ../src/guestfs-actions.pod:5937
16201 " guestfs_resize2fs_M (guestfs_h *g,\n"
16202 " const char *device);\n"
16207 #: ../src/guestfs-actions.pod:5941
16209 "This command is the same as C<guestfs_resize2fs>, but the filesystem is "
16210 "resized to its minimum size. This works like the I<-M> option to the "
16211 "C<resize2fs> command."
16215 #: ../src/guestfs-actions.pod:5945
16217 "To get the resulting size of the filesystem you should call "
16218 "C<guestfs_tune2fs_l> and read the C<Block size> and C<Block count> values. "
16219 "These two numbers, multiplied together, give the resulting size of the "
16220 "minimal filesystem in bytes."
16224 #: ../src/guestfs-actions.pod:5954
16225 msgid "guestfs_resize2fs_size"
16229 #: ../src/guestfs-actions.pod:5956
16233 " guestfs_resize2fs_size (guestfs_h *g,\n"
16234 " const char *device,\n"
16235 " int64_t size);\n"
16240 #: ../src/guestfs-actions.pod:5961
16242 "This command is the same as C<guestfs_resize2fs> except that it allows you "
16243 "to specify the new size (in bytes) explicitly."
16247 #: ../src/guestfs-actions.pod:5968
16252 #: ../src/guestfs-actions.pod:5970
16256 " guestfs_rm (guestfs_h *g,\n"
16257 " const char *path);\n"
16262 #: ../src/guestfs-actions.pod:5974 ../fish/guestfish-actions.pod:3953
16263 msgid "Remove the single file C<path>."
16267 #: ../src/guestfs-actions.pod:5980
16268 msgid "guestfs_rm_rf"
16272 #: ../src/guestfs-actions.pod:5982
16276 " guestfs_rm_rf (guestfs_h *g,\n"
16277 " const char *path);\n"
16282 #: ../src/guestfs-actions.pod:5986 ../fish/guestfish-actions.pod:3959
16284 "Remove the file or directory C<path>, recursively removing the contents if "
16285 "its a directory. This is like the C<rm -rf> shell command."
16289 #: ../src/guestfs-actions.pod:5994
16290 msgid "guestfs_rmdir"
16294 #: ../src/guestfs-actions.pod:5996
16298 " guestfs_rmdir (guestfs_h *g,\n"
16299 " const char *path);\n"
16304 #: ../src/guestfs-actions.pod:6000 ../fish/guestfish-actions.pod:3967
16305 msgid "Remove the single directory C<path>."
16309 #: ../src/guestfs-actions.pod:6006
16310 msgid "guestfs_rmmountpoint"
16314 #: ../src/guestfs-actions.pod:6008
16318 " guestfs_rmmountpoint (guestfs_h *g,\n"
16319 " const char *exemptpath);\n"
16324 #: ../src/guestfs-actions.pod:6012
16326 "This calls removes a mountpoint that was previously created with "
16327 "C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint> for full details."
16331 #: ../src/guestfs-actions.pod:6020
16332 msgid "guestfs_scrub_device"
16336 #: ../src/guestfs-actions.pod:6022
16340 " guestfs_scrub_device (guestfs_h *g,\n"
16341 " const char *device);\n"
16346 #: ../src/guestfs-actions.pod:6026 ../fish/guestfish-actions.pod:3981
16348 "This command writes patterns over C<device> to make data retrieval more "
16353 #: ../src/guestfs-actions.pod:6029 ../src/guestfs-actions.pod:6050
16354 #: ../src/guestfs-actions.pod:6069 ../fish/guestfish-actions.pod:3984
16355 #: ../fish/guestfish-actions.pod:3999 ../fish/guestfish-actions.pod:4012
16357 "It is an interface to the L<scrub(1)> program. See that manual page for "
16362 #: ../src/guestfs-actions.pod:6037 ../src/guestfs-actions.pod:6055
16363 #: ../src/guestfs-actions.pod:6074
16364 msgid "(Added in 1.0.52)"
16368 #: ../src/guestfs-actions.pod:6039
16369 msgid "guestfs_scrub_file"
16373 #: ../src/guestfs-actions.pod:6041
16377 " guestfs_scrub_file (guestfs_h *g,\n"
16378 " const char *file);\n"
16383 #: ../src/guestfs-actions.pod:6045 ../fish/guestfish-actions.pod:3994
16385 "This command writes patterns over a file to make data retrieval more "
16390 #: ../src/guestfs-actions.pod:6048 ../fish/guestfish-actions.pod:3997
16391 msgid "The file is I<removed> after scrubbing."
16395 #: ../src/guestfs-actions.pod:6057
16396 msgid "guestfs_scrub_freespace"
16400 #: ../src/guestfs-actions.pod:6059
16404 " guestfs_scrub_freespace (guestfs_h *g,\n"
16405 " const char *dir);\n"
16410 #: ../src/guestfs-actions.pod:6063
16412 "This command creates the directory C<dir> and then fills it with files until "
16413 "the filesystem is full, and scrubs the files as for C<guestfs_scrub_file>, "
16414 "and deletes them. The intention is to scrub any free space on the partition "
16415 "containing C<dir>."
16419 #: ../src/guestfs-actions.pod:6076
16420 msgid "guestfs_set_append"
16424 #: ../src/guestfs-actions.pod:6078
16428 " guestfs_set_append (guestfs_h *g,\n"
16429 " const char *append);\n"
16434 #: ../src/guestfs-actions.pod:6082 ../fish/guestfish-actions.pod:4021
16436 "This function is used to add additional options to the guest kernel command "
16441 #: ../src/guestfs-actions.pod:6085 ../fish/guestfish-actions.pod:4024
16443 "The default is C<NULL> unless overridden by setting C<LIBGUESTFS_APPEND> "
16444 "environment variable."
16448 #: ../src/guestfs-actions.pod:6088 ../fish/guestfish-actions.pod:4027
16450 "Setting C<append> to C<NULL> means I<no> additional options are passed "
16451 "(libguestfs always adds a few of its own)."
16455 #: ../src/guestfs-actions.pod:6095
16456 msgid "guestfs_set_attach_method"
16460 #: ../src/guestfs-actions.pod:6097
16464 " guestfs_set_attach_method (guestfs_h *g,\n"
16465 " const char *attachmethod);\n"
16470 #: ../src/guestfs-actions.pod:6101 ../fish/guestfish-actions.pod:4036
16472 "Set the method that libguestfs uses to connect to the back end guestfsd "
16473 "daemon. Possible methods are:"
16477 #: ../src/guestfs-actions.pod:6108 ../fish/guestfish-actions.pod:4043
16479 "Launch an appliance and connect to it. This is the ordinary method and the "
16484 #: ../src/guestfs-actions.pod:6111 ../fish/guestfish-actions.pod:4046
16485 msgid "C<unix:I<path>>"
16489 #: ../src/guestfs-actions.pod:6113 ../fish/guestfish-actions.pod:4048
16490 msgid "Connect to the Unix domain socket I<path>."
16494 #: ../src/guestfs-actions.pod:6115 ../fish/guestfish-actions.pod:4050
16496 "This method lets you connect to an existing daemon or (using virtio-serial) "
16497 "to a live guest. For more information, see L<guestfs(3)/ATTACHING TO "
16498 "RUNNING DAEMONS>."
16502 #: ../src/guestfs-actions.pod:6125
16503 msgid "guestfs_set_autosync"
16507 #: ../src/guestfs-actions.pod:6127
16511 " guestfs_set_autosync (guestfs_h *g,\n"
16512 " int autosync);\n"
16517 #: ../src/guestfs-actions.pod:6131 ../fish/guestfish-actions.pod:4062
16519 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
16520 "effort attempt to make filesystems consistent and synchronized when the "
16521 "handle is closed (also if the program exits without closing handles)."
16525 #: ../src/guestfs-actions.pod:6136 ../fish/guestfish-actions.pod:4067
16527 "This is enabled by default (since libguestfs 1.5.24, previously it was "
16528 "disabled by default)."
16532 #: ../src/guestfs-actions.pod:6143
16533 msgid "guestfs_set_direct"
16537 #: ../src/guestfs-actions.pod:6145
16541 " guestfs_set_direct (guestfs_h *g,\n"
16547 #: ../src/guestfs-actions.pod:6149 ../fish/guestfish-actions.pod:4076
16549 "If the direct appliance mode flag is enabled, then stdin and stdout are "
16550 "passed directly through to the appliance once it is launched."
16554 #: ../src/guestfs-actions.pod:6153
16556 "One consequence of this is that log messages aren't caught by the library "
16557 "and handled by C<guestfs_set_log_message_callback>, but go straight to "
16562 #: ../src/guestfs-actions.pod:6157 ../fish/guestfish-actions.pod:4084
16563 msgid "You probably don't want to use this unless you know what you are doing."
16567 #: ../src/guestfs-actions.pod:6160 ../fish/guestfish-actions.pod:4087
16568 msgid "The default is disabled."
16572 #: ../src/guestfs-actions.pod:6166
16573 msgid "guestfs_set_e2label"
16577 #: ../src/guestfs-actions.pod:6168
16581 " guestfs_set_e2label (guestfs_h *g,\n"
16582 " const char *device,\n"
16583 " const char *label);\n"
16588 #: ../src/guestfs-actions.pod:6173 ../fish/guestfish-actions.pod:4093
16590 "This sets the ext2/3/4 filesystem label of the filesystem on C<device> to "
16591 "C<label>. Filesystem labels are limited to 16 characters."
16595 #: ../src/guestfs-actions.pod:6177
16597 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label> to return "
16598 "the existing label on a filesystem."
16602 #: ../src/guestfs-actions.pod:6184
16603 msgid "guestfs_set_e2uuid"
16607 #: ../src/guestfs-actions.pod:6186
16611 " guestfs_set_e2uuid (guestfs_h *g,\n"
16612 " const char *device,\n"
16613 " const char *uuid);\n"
16618 #: ../src/guestfs-actions.pod:6191 ../fish/guestfish-actions.pod:4104
16620 "This sets the ext2/3/4 filesystem UUID of the filesystem on C<device> to "
16621 "C<uuid>. The format of the UUID and alternatives such as C<clear>, "
16622 "C<random> and C<time> are described in the L<tune2fs(8)> manpage."
16626 #: ../src/guestfs-actions.pod:6196
16628 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid> to return "
16629 "the existing UUID of a filesystem."
16633 #: ../src/guestfs-actions.pod:6203
16634 msgid "guestfs_set_memsize"
16638 #: ../src/guestfs-actions.pod:6205
16642 " guestfs_set_memsize (guestfs_h *g,\n"
16648 #: ../src/guestfs-actions.pod:6209
16650 "This sets the memory size in megabytes allocated to the qemu subprocess. "
16651 "This only has any effect if called before C<guestfs_launch>."
16655 #: ../src/guestfs-actions.pod:6213 ../fish/guestfish-actions.pod:4122
16657 "You can also change this by setting the environment variable "
16658 "C<LIBGUESTFS_MEMSIZE> before the handle is created."
16662 #: ../src/guestfs-actions.pod:6224
16663 msgid "guestfs_set_network"
16667 #: ../src/guestfs-actions.pod:6226
16671 " guestfs_set_network (guestfs_h *g,\n"
16677 #: ../src/guestfs-actions.pod:6230 ../fish/guestfish-actions.pod:4135
16679 "If C<network> is true, then the network is enabled in the libguestfs "
16680 "appliance. The default is false."
16684 #: ../src/guestfs-actions.pod:6233 ../fish/guestfish-actions.pod:4138
16686 "This affects whether commands are able to access the network (see L<guestfs"
16687 "(3)/RUNNING COMMANDS>)."
16691 #: ../src/guestfs-actions.pod:6236
16693 "You must call this before calling C<guestfs_launch>, otherwise it has no "
16698 #: ../src/guestfs-actions.pod:6243
16699 msgid "guestfs_set_path"
16703 #: ../src/guestfs-actions.pod:6245
16707 " guestfs_set_path (guestfs_h *g,\n"
16708 " const char *searchpath);\n"
16713 #: ../src/guestfs-actions.pod:6249 ../fish/guestfish-actions.pod:4150
16714 msgid "Set the path that libguestfs searches for kernel and initrd.img."
16718 #: ../src/guestfs-actions.pod:6251 ../fish/guestfish-actions.pod:4152
16720 "The default is C<$libdir/guestfs> unless overridden by setting "
16721 "C<LIBGUESTFS_PATH> environment variable."
16725 #: ../src/guestfs-actions.pod:6254 ../fish/guestfish-actions.pod:4155
16726 msgid "Setting C<path> to C<NULL> restores the default path."
16730 #: ../src/guestfs-actions.pod:6260
16731 msgid "guestfs_set_qemu"
16735 #: ../src/guestfs-actions.pod:6262
16739 " guestfs_set_qemu (guestfs_h *g,\n"
16740 " const char *qemu);\n"
16745 #: ../src/guestfs-actions.pod:6266 ../fish/guestfish-actions.pod:4163
16746 msgid "Set the qemu binary that we will use."
16750 #: ../src/guestfs-actions.pod:6268 ../fish/guestfish-actions.pod:4165
16752 "The default is chosen when the library was compiled by the configure script."
16756 #: ../src/guestfs-actions.pod:6271 ../fish/guestfish-actions.pod:4168
16758 "You can also override this by setting the C<LIBGUESTFS_QEMU> environment "
16763 #: ../src/guestfs-actions.pod:6274 ../fish/guestfish-actions.pod:4171
16764 msgid "Setting C<qemu> to C<NULL> restores the default qemu binary."
16768 #: ../src/guestfs-actions.pod:6276 ../fish/guestfish-actions.pod:4173
16770 "Note that you should call this function as early as possible after creating "
16771 "the handle. This is because some pre-launch operations depend on testing "
16772 "qemu features (by running C<qemu -help>). If the qemu binary changes, we "
16773 "don't retest features, and so you might see inconsistent results. Using the "
16774 "environment variable C<LIBGUESTFS_QEMU> is safest of all since that picks "
16775 "the qemu binary at the same time as the handle is created."
16779 #: ../src/guestfs-actions.pod:6288
16780 msgid "guestfs_set_recovery_proc"
16784 #: ../src/guestfs-actions.pod:6290
16788 " guestfs_set_recovery_proc (guestfs_h *g,\n"
16789 " int recoveryproc);\n"
16794 #: ../src/guestfs-actions.pod:6294
16796 "If this is called with the parameter C<false> then C<guestfs_launch> does "
16797 "not create a recovery process. The purpose of the recovery process is to "
16798 "stop runaway qemu processes in the case where the main program aborts "
16803 #: ../src/guestfs-actions.pod:6299
16805 "This only has any effect if called before C<guestfs_launch>, and the default "
16810 #: ../src/guestfs-actions.pod:6302 ../fish/guestfish-actions.pod:4195
16812 "About the only time when you would want to disable this is if the main "
16813 "process will fork itself into the background (\"daemonize\" itself). In "
16814 "this case the recovery process thinks that the main program has disappeared "
16815 "and so kills qemu, which is not very helpful."
16819 #: ../src/guestfs-actions.pod:6312
16820 msgid "guestfs_set_selinux"
16824 #: ../src/guestfs-actions.pod:6314
16828 " guestfs_set_selinux (guestfs_h *g,\n"
16834 #: ../src/guestfs-actions.pod:6318 ../fish/guestfish-actions.pod:4207
16836 "This sets the selinux flag that is passed to the appliance at boot time. "
16837 "The default is C<selinux=0> (disabled)."
16841 #: ../src/guestfs-actions.pod:6321 ../fish/guestfish-actions.pod:4210
16843 "Note that if SELinux is enabled, it is always in Permissive mode "
16844 "(C<enforcing=0>)."
16848 #: ../src/guestfs-actions.pod:6331
16849 msgid "guestfs_set_trace"
16853 #: ../src/guestfs-actions.pod:6333
16857 " guestfs_set_trace (guestfs_h *g,\n"
16863 #: ../src/guestfs-actions.pod:6337 ../fish/guestfish-actions.pod:4222
16865 "If the command trace flag is set to 1, then libguestfs calls, parameters and "
16866 "return values are traced."
16870 #: ../src/guestfs-actions.pod:6340 ../fish/guestfish-actions.pod:4225
16872 "If you want to trace C API calls into libguestfs (and other libraries) then "
16873 "possibly a better way is to use the external ltrace(1) command."
16877 #: ../src/guestfs-actions.pod:6344 ../fish/guestfish-actions.pod:4229
16879 "Command traces are disabled unless the environment variable "
16880 "C<LIBGUESTFS_TRACE> is defined and set to C<1>."
16884 #: ../src/guestfs-actions.pod:6347
16886 "Trace messages are normally sent to C<stderr>, unless you register a "
16887 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
16891 #: ../src/guestfs-actions.pod:6355
16892 msgid "guestfs_set_verbose"
16896 #: ../src/guestfs-actions.pod:6357
16900 " guestfs_set_verbose (guestfs_h *g,\n"
16906 #: ../src/guestfs-actions.pod:6361 ../fish/guestfish-actions.pod:4242
16907 msgid "If C<verbose> is true, this turns on verbose messages."
16911 #: ../src/guestfs-actions.pod:6363 ../fish/guestfish-actions.pod:4244
16913 "Verbose messages are disabled unless the environment variable "
16914 "C<LIBGUESTFS_DEBUG> is defined and set to C<1>."
16918 #: ../src/guestfs-actions.pod:6366
16920 "Verbose messages are normally sent to C<stderr>, unless you register a "
16921 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
16925 #: ../src/guestfs-actions.pod:6374
16926 msgid "guestfs_setcon"
16930 #: ../src/guestfs-actions.pod:6376
16934 " guestfs_setcon (guestfs_h *g,\n"
16935 " const char *context);\n"
16940 #: ../src/guestfs-actions.pod:6380 ../fish/guestfish-actions.pod:4255
16942 "This sets the SELinux security context of the daemon to the string "
16947 #: ../src/guestfs-actions.pod:6383 ../fish/guestfish-actions.pod:4258
16948 msgid "See the documentation about SELINUX in L<guestfs(3)>."
16952 #: ../src/guestfs-actions.pod:6389
16953 msgid "guestfs_setxattr"
16957 #: ../src/guestfs-actions.pod:6391
16961 " guestfs_setxattr (guestfs_h *g,\n"
16962 " const char *xattr,\n"
16963 " const char *val,\n"
16965 " const char *path);\n"
16970 #: ../src/guestfs-actions.pod:6398 ../fish/guestfish-actions.pod:4264
16972 "This call sets the extended attribute named C<xattr> of the file C<path> to "
16973 "the value C<val> (of length C<vallen>). The value is arbitrary 8 bit data."
16977 #: ../src/guestfs-actions.pod:6402
16978 msgid "See also: C<guestfs_lsetxattr>, L<attr(5)>."
16982 #: ../src/guestfs-actions.pod:6408
16983 msgid "guestfs_sfdisk"
16987 #: ../src/guestfs-actions.pod:6410
16991 " guestfs_sfdisk (guestfs_h *g,\n"
16992 " const char *device,\n"
16996 " char *const *lines);\n"
17001 #: ../src/guestfs-actions.pod:6418 ../fish/guestfish-actions.pod:4274
17003 "This is a direct interface to the L<sfdisk(8)> program for creating "
17004 "partitions on block devices."
17008 #: ../src/guestfs-actions.pod:6421 ../fish/guestfish-actions.pod:4277
17009 msgid "C<device> should be a block device, for example C</dev/sda>."
17013 #: ../src/guestfs-actions.pod:6423 ../fish/guestfish-actions.pod:4279
17015 "C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads and "
17016 "sectors on the device, which are passed directly to sfdisk as the I<-C>, I<-"
17017 "H> and I<-S> parameters. If you pass C<0> for any of these, then the "
17018 "corresponding parameter is omitted. Usually for 'large' disks, you can just "
17019 "pass C<0> for these, but for small (floppy-sized) disks, sfdisk (or rather, "
17020 "the kernel) cannot work out the right geometry and you will need to tell it."
17024 #: ../src/guestfs-actions.pod:6431 ../fish/guestfish-actions.pod:4287
17026 "C<lines> is a list of lines that we feed to C<sfdisk>. For more information "
17027 "refer to the L<sfdisk(8)> manpage."
17031 #: ../src/guestfs-actions.pod:6434 ../fish/guestfish-actions.pod:4290
17033 "To create a single partition occupying the whole disk, you would pass "
17034 "C<lines> as a single element list, when the single element being the string "
17039 #: ../src/guestfs-actions.pod:6438
17041 "See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>, C<guestfs_part_init>"
17045 #: ../src/guestfs-actions.pod:6446 ../src/guestfs-actions.pod:6476
17046 #: ../src/guestfs-actions.pod:6509 ../fish/guestfish-actions.pod:4300
17047 #: ../fish/guestfish-actions.pod:4323 ../fish/guestfish-actions.pod:4345
17049 "This function is deprecated. In new code, use the C<part_add> call instead."
17053 #: ../src/guestfs-actions.pod:6455
17054 msgid "guestfs_sfdiskM"
17058 #: ../src/guestfs-actions.pod:6457
17062 " guestfs_sfdiskM (guestfs_h *g,\n"
17063 " const char *device,\n"
17064 " char *const *lines);\n"
17069 #: ../src/guestfs-actions.pod:6462
17071 "This is a simplified interface to the C<guestfs_sfdisk> command, where "
17072 "partition sizes are specified in megabytes only (rounded to the nearest "
17073 "cylinder) and you don't need to specify the cyls, heads and sectors "
17074 "parameters which were rarely if ever used anyway."
17078 #: ../src/guestfs-actions.pod:6468
17080 "See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage and "
17081 "C<guestfs_part_disk>"
17085 #: ../src/guestfs-actions.pod:6485
17086 msgid "guestfs_sfdisk_N"
17090 #: ../src/guestfs-actions.pod:6487
17094 " guestfs_sfdisk_N (guestfs_h *g,\n"
17095 " const char *device,\n"
17100 " const char *line);\n"
17105 #: ../src/guestfs-actions.pod:6496 ../fish/guestfish-actions.pod:4334
17107 "This runs L<sfdisk(8)> option to modify just the single partition C<n> "
17108 "(note: C<n> counts from 1)."
17112 #: ../src/guestfs-actions.pod:6499
17114 "For other parameters, see C<guestfs_sfdisk>. You should usually pass C<0> "
17115 "for the cyls/heads/sectors parameters."
17119 #: ../src/guestfs-actions.pod:6502
17120 msgid "See also: C<guestfs_part_add>"
17124 #: ../src/guestfs-actions.pod:6518
17125 msgid "guestfs_sfdisk_disk_geometry"
17129 #: ../src/guestfs-actions.pod:6520
17133 " guestfs_sfdisk_disk_geometry (guestfs_h *g,\n"
17134 " const char *device);\n"
17139 #: ../src/guestfs-actions.pod:6524
17141 "This displays the disk geometry of C<device> read from the partition table. "
17142 "Especially in the case where the underlying block device has been resized, "
17143 "this can be different from the kernel's idea of the geometry (see "
17144 "C<guestfs_sfdisk_kernel_geometry>)."
17148 #: ../src/guestfs-actions.pod:6529 ../src/guestfs-actions.pod:6545
17149 #: ../fish/guestfish-actions.pod:4361 ../fish/guestfish-actions.pod:4370
17150 msgid "The result is in human-readable format, and not designed to be parsed."
17154 #: ../src/guestfs-actions.pod:6537
17155 msgid "guestfs_sfdisk_kernel_geometry"
17159 #: ../src/guestfs-actions.pod:6539
17163 " guestfs_sfdisk_kernel_geometry (guestfs_h *g,\n"
17164 " const char *device);\n"
17169 #: ../src/guestfs-actions.pod:6543 ../fish/guestfish-actions.pod:4368
17170 msgid "This displays the kernel's idea of the geometry of C<device>."
17174 #: ../src/guestfs-actions.pod:6553
17175 msgid "guestfs_sfdisk_l"
17179 #: ../src/guestfs-actions.pod:6555
17183 " guestfs_sfdisk_l (guestfs_h *g,\n"
17184 " const char *device);\n"
17189 #: ../src/guestfs-actions.pod:6559 ../fish/guestfish-actions.pod:4377
17191 "This displays the partition table on C<device>, in the human-readable output "
17192 "of the L<sfdisk(8)> command. It is not intended to be parsed."
17196 #: ../src/guestfs-actions.pod:6563
17197 msgid "See also: C<guestfs_part_list>"
17201 #: ../src/guestfs-actions.pod:6568 ../fish/guestfish-actions.pod:4383
17203 "This function is deprecated. In new code, use the C<part_list> call instead."
17207 #: ../src/guestfs-actions.pod:6577
17212 #: ../src/guestfs-actions.pod:6579
17216 " guestfs_sh (guestfs_h *g,\n"
17217 " const char *command);\n"
17222 #: ../src/guestfs-actions.pod:6583 ../fish/guestfish-actions.pod:4394
17224 "This call runs a command from the guest filesystem via the guest's C</bin/"
17229 #: ../src/guestfs-actions.pod:6586
17230 msgid "This is like C<guestfs_command>, but passes the command to:"
17234 #: ../src/guestfs-actions.pod:6588 ../fish/guestfish-actions.pod:4399
17237 " /bin/sh -c \"command\"\n"
17242 #: ../src/guestfs-actions.pod:6590 ../fish/guestfish-actions.pod:4401
17244 "Depending on the guest's shell, this usually results in wildcards being "
17245 "expanded, shell expressions being interpolated and so on."
17249 #: ../src/guestfs-actions.pod:6594
17250 msgid "All the provisos about C<guestfs_command> apply to this call."
17254 #: ../src/guestfs-actions.pod:6601
17255 msgid "guestfs_sh_lines"
17259 #: ../src/guestfs-actions.pod:6603
17263 " guestfs_sh_lines (guestfs_h *g,\n"
17264 " const char *command);\n"
17269 #: ../src/guestfs-actions.pod:6607
17271 "This is the same as C<guestfs_sh>, but splits the result into a list of "
17276 #: ../src/guestfs-actions.pod:6610
17277 msgid "See also: C<guestfs_command_lines>"
17281 #: ../src/guestfs-actions.pod:6618
17282 msgid "guestfs_sleep"
17286 #: ../src/guestfs-actions.pod:6620
17290 " guestfs_sleep (guestfs_h *g,\n"
17296 #: ../src/guestfs-actions.pod:6624 ../fish/guestfish-actions.pod:4420
17297 msgid "Sleep for C<secs> seconds."
17301 #: ../src/guestfs-actions.pod:6628
17302 msgid "(Added in 1.0.41)"
17306 #: ../src/guestfs-actions.pod:6630 ../src/guestfs-structs.pod:109
17307 msgid "guestfs_stat"
17311 #: ../src/guestfs-actions.pod:6632
17314 " struct guestfs_stat *\n"
17315 " guestfs_stat (guestfs_h *g,\n"
17316 " const char *path);\n"
17321 #: ../src/guestfs-actions.pod:6638 ../fish/guestfish-actions.pod:4428
17322 msgid "This is the same as the C<stat(2)> system call."
17326 #: ../src/guestfs-actions.pod:6646 ../src/guestfs-structs.pod:135
17327 msgid "guestfs_statvfs"
17331 #: ../src/guestfs-actions.pod:6648
17334 " struct guestfs_statvfs *\n"
17335 " guestfs_statvfs (guestfs_h *g,\n"
17336 " const char *path);\n"
17341 #: ../src/guestfs-actions.pod:6652 ../fish/guestfish-actions.pod:4434
17343 "Returns file system statistics for any mounted file system. C<path> should "
17344 "be a file or directory in the mounted file system (typically it is the mount "
17345 "point itself, but it doesn't need to be)."
17349 #: ../src/guestfs-actions.pod:6656 ../fish/guestfish-actions.pod:4438
17350 msgid "This is the same as the C<statvfs(2)> system call."
17354 #: ../src/guestfs-actions.pod:6658
17356 "This function returns a C<struct guestfs_statvfs *>, or NULL if there was an "
17357 "error. I<The caller must call C<guestfs_free_statvfs> after use>."
17361 #: ../src/guestfs-actions.pod:6664
17362 msgid "guestfs_strings"
17366 #: ../src/guestfs-actions.pod:6666
17370 " guestfs_strings (guestfs_h *g,\n"
17371 " const char *path);\n"
17376 #: ../src/guestfs-actions.pod:6670 ../fish/guestfish-actions.pod:4444
17378 "This runs the L<strings(1)> command on a file and returns the list of "
17379 "printable strings found."
17383 #: ../src/guestfs-actions.pod:6682
17384 msgid "guestfs_strings_e"
17388 #: ../src/guestfs-actions.pod:6684
17392 " guestfs_strings_e (guestfs_h *g,\n"
17393 " const char *encoding,\n"
17394 " const char *path);\n"
17399 #: ../src/guestfs-actions.pod:6689
17401 "This is like the C<guestfs_strings> command, but allows you to specify the "
17402 "encoding of strings that are looked for in the source file C<path>."
17406 #: ../src/guestfs-actions.pod:6693 ../fish/guestfish-actions.pod:4458
17407 msgid "Allowed encodings are:"
17411 #: ../src/guestfs-actions.pod:6697 ../fish/guestfish-actions.pod:4462
17416 #: ../src/guestfs-actions.pod:6699
17418 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
17419 "ISO-8859-X (this is what C<guestfs_strings> uses)."
17423 #: ../src/guestfs-actions.pod:6702 ../fish/guestfish-actions.pod:4467
17428 #: ../src/guestfs-actions.pod:6704 ../fish/guestfish-actions.pod:4469
17429 msgid "Single 8-bit-byte characters."
17433 #: ../src/guestfs-actions.pod:6706 ../fish/guestfish-actions.pod:4471
17438 #: ../src/guestfs-actions.pod:6708 ../fish/guestfish-actions.pod:4473
17439 msgid "16-bit big endian strings such as those encoded in UTF-16BE or UCS-2BE."
17443 #: ../src/guestfs-actions.pod:6711 ../fish/guestfish-actions.pod:4476
17444 msgid "l (lower case letter L)"
17448 #: ../src/guestfs-actions.pod:6713 ../fish/guestfish-actions.pod:4478
17450 "16-bit little endian such as UTF-16LE and UCS-2LE. This is useful for "
17451 "examining binaries in Windows guests."
17455 #: ../src/guestfs-actions.pod:6716 ../fish/guestfish-actions.pod:4481
17460 #: ../src/guestfs-actions.pod:6718 ../fish/guestfish-actions.pod:4483
17461 msgid "32-bit big endian such as UCS-4BE."
17465 #: ../src/guestfs-actions.pod:6720 ../fish/guestfish-actions.pod:4485
17470 #: ../src/guestfs-actions.pod:6722 ../fish/guestfish-actions.pod:4487
17471 msgid "32-bit little endian such as UCS-4LE."
17475 #: ../src/guestfs-actions.pod:6726 ../fish/guestfish-actions.pod:4491
17476 msgid "The returned strings are transcoded to UTF-8."
17480 #: ../src/guestfs-actions.pod:6737
17481 msgid "guestfs_swapoff_device"
17485 #: ../src/guestfs-actions.pod:6739
17489 " guestfs_swapoff_device (guestfs_h *g,\n"
17490 " const char *device);\n"
17495 #: ../src/guestfs-actions.pod:6743
17497 "This command disables the libguestfs appliance swap device or partition "
17498 "named C<device>. See C<guestfs_swapon_device>."
17502 #: ../src/guestfs-actions.pod:6751
17503 msgid "guestfs_swapoff_file"
17507 #: ../src/guestfs-actions.pod:6753
17511 " guestfs_swapoff_file (guestfs_h *g,\n"
17512 " const char *file);\n"
17517 #: ../src/guestfs-actions.pod:6757 ../fish/guestfish-actions.pod:4508
17518 msgid "This command disables the libguestfs appliance swap on file."
17522 #: ../src/guestfs-actions.pod:6763
17523 msgid "guestfs_swapoff_label"
17527 #: ../src/guestfs-actions.pod:6765
17531 " guestfs_swapoff_label (guestfs_h *g,\n"
17532 " const char *label);\n"
17537 #: ../src/guestfs-actions.pod:6769 ../fish/guestfish-actions.pod:4514
17539 "This command disables the libguestfs appliance swap on labeled swap "
17544 #: ../src/guestfs-actions.pod:6776
17545 msgid "guestfs_swapoff_uuid"
17549 #: ../src/guestfs-actions.pod:6778
17553 " guestfs_swapoff_uuid (guestfs_h *g,\n"
17554 " const char *uuid);\n"
17559 #: ../src/guestfs-actions.pod:6782 ../fish/guestfish-actions.pod:4521
17561 "This command disables the libguestfs appliance swap partition with the given "
17566 #: ../src/guestfs-actions.pod:6789
17567 msgid "guestfs_swapon_device"
17571 #: ../src/guestfs-actions.pod:6791
17575 " guestfs_swapon_device (guestfs_h *g,\n"
17576 " const char *device);\n"
17581 #: ../src/guestfs-actions.pod:6795
17583 "This command enables the libguestfs appliance to use the swap device or "
17584 "partition named C<device>. The increased memory is made available for all "
17585 "commands, for example those run using C<guestfs_command> or C<guestfs_sh>."
17589 #: ../src/guestfs-actions.pod:6800 ../fish/guestfish-actions.pod:4533
17591 "Note that you should not swap to existing guest swap partitions unless you "
17592 "know what you are doing. They may contain hibernation information, or other "
17593 "information that the guest doesn't want you to trash. You also risk leaking "
17594 "information about the host to the guest this way. Instead, attach a new "
17595 "host device to the guest and swap on that."
17599 #: ../src/guestfs-actions.pod:6811
17600 msgid "guestfs_swapon_file"
17604 #: ../src/guestfs-actions.pod:6813
17608 " guestfs_swapon_file (guestfs_h *g,\n"
17609 " const char *file);\n"
17614 #: ../src/guestfs-actions.pod:6817
17616 "This command enables swap to a file. See C<guestfs_swapon_device> for other "
17621 #: ../src/guestfs-actions.pod:6824
17622 msgid "guestfs_swapon_label"
17626 #: ../src/guestfs-actions.pod:6826
17630 " guestfs_swapon_label (guestfs_h *g,\n"
17631 " const char *label);\n"
17636 #: ../src/guestfs-actions.pod:6830
17638 "This command enables swap to a labeled swap partition. See "
17639 "C<guestfs_swapon_device> for other notes."
17643 #: ../src/guestfs-actions.pod:6837
17644 msgid "guestfs_swapon_uuid"
17648 #: ../src/guestfs-actions.pod:6839
17652 " guestfs_swapon_uuid (guestfs_h *g,\n"
17653 " const char *uuid);\n"
17658 #: ../src/guestfs-actions.pod:6843
17660 "This command enables swap to a swap partition with the given UUID. See "
17661 "C<guestfs_swapon_device> for other notes."
17665 #: ../src/guestfs-actions.pod:6850
17666 msgid "guestfs_sync"
17670 #: ../src/guestfs-actions.pod:6852
17674 " guestfs_sync (guestfs_h *g);\n"
17679 #: ../src/guestfs-actions.pod:6855 ../fish/guestfish-actions.pod:4565
17681 "This syncs the disk, so that any writes are flushed through to the "
17682 "underlying disk image."
17686 #: ../src/guestfs-actions.pod:6858 ../fish/guestfish-actions.pod:4568
17688 "You should always call this if you have modified a disk image, before "
17689 "closing the handle."
17693 #: ../src/guestfs-actions.pod:6865
17694 msgid "guestfs_tail"
17698 #: ../src/guestfs-actions.pod:6867
17702 " guestfs_tail (guestfs_h *g,\n"
17703 " const char *path);\n"
17708 #: ../src/guestfs-actions.pod:6871 ../fish/guestfish-actions.pod:4575
17710 "This command returns up to the last 10 lines of a file as a list of strings."
17714 #: ../src/guestfs-actions.pod:6883
17715 msgid "guestfs_tail_n"
17719 #: ../src/guestfs-actions.pod:6885
17723 " guestfs_tail_n (guestfs_h *g,\n"
17725 " const char *path);\n"
17730 #: ../src/guestfs-actions.pod:6890 ../fish/guestfish-actions.pod:4585
17732 "If the parameter C<nrlines> is a positive number, this returns the last "
17733 "C<nrlines> lines of the file C<path>."
17737 #: ../src/guestfs-actions.pod:6893 ../fish/guestfish-actions.pod:4588
17739 "If the parameter C<nrlines> is a negative number, this returns lines from "
17740 "the file C<path>, starting with the C<-nrlines>th line."
17744 #: ../src/guestfs-actions.pod:6907
17745 msgid "guestfs_tar_in"
17749 #: ../src/guestfs-actions.pod:6909
17753 " guestfs_tar_in (guestfs_h *g,\n"
17754 " const char *tarfile,\n"
17755 " const char *directory);\n"
17760 #: ../src/guestfs-actions.pod:6914 ../fish/guestfish-actions.pod:4600
17762 "This command uploads and unpacks local file C<tarfile> (an I<uncompressed> "
17763 "tar file) into C<directory>."
17767 #: ../src/guestfs-actions.pod:6917
17769 "To upload a compressed tarball, use C<guestfs_tgz_in> or C<guestfs_txz_in>."
17773 #: ../src/guestfs-actions.pod:6922 ../src/guestfs-actions.pod:6939
17774 #: ../src/guestfs-actions.pod:6955 ../src/guestfs-actions.pod:6971
17775 msgid "(Added in 1.0.3)"
17779 #: ../src/guestfs-actions.pod:6924
17780 msgid "guestfs_tar_out"
17784 #: ../src/guestfs-actions.pod:6926
17788 " guestfs_tar_out (guestfs_h *g,\n"
17789 " const char *directory,\n"
17790 " const char *tarfile);\n"
17795 #: ../src/guestfs-actions.pod:6931 ../fish/guestfish-actions.pod:4612
17797 "This command packs the contents of C<directory> and downloads it to local "
17802 #: ../src/guestfs-actions.pod:6934
17804 "To download a compressed tarball, use C<guestfs_tgz_out> or "
17805 "C<guestfs_txz_out>."
17809 #: ../src/guestfs-actions.pod:6941
17810 msgid "guestfs_tgz_in"
17814 #: ../src/guestfs-actions.pod:6943
17818 " guestfs_tgz_in (guestfs_h *g,\n"
17819 " const char *tarball,\n"
17820 " const char *directory);\n"
17825 #: ../src/guestfs-actions.pod:6948 ../fish/guestfish-actions.pod:4624
17827 "This command uploads and unpacks local file C<tarball> (a I<gzip compressed> "
17828 "tar file) into C<directory>."
17832 #: ../src/guestfs-actions.pod:6951
17833 msgid "To upload an uncompressed tarball, use C<guestfs_tar_in>."
17837 #: ../src/guestfs-actions.pod:6957
17838 msgid "guestfs_tgz_out"
17842 #: ../src/guestfs-actions.pod:6959
17846 " guestfs_tgz_out (guestfs_h *g,\n"
17847 " const char *directory,\n"
17848 " const char *tarball);\n"
17853 #: ../src/guestfs-actions.pod:6964 ../fish/guestfish-actions.pod:4635
17855 "This command packs the contents of C<directory> and downloads it to local "
17860 #: ../src/guestfs-actions.pod:6967
17861 msgid "To download an uncompressed tarball, use C<guestfs_tar_out>."
17865 #: ../src/guestfs-actions.pod:6973
17866 msgid "guestfs_touch"
17870 #: ../src/guestfs-actions.pod:6975
17874 " guestfs_touch (guestfs_h *g,\n"
17875 " const char *path);\n"
17880 #: ../src/guestfs-actions.pod:6979 ../fish/guestfish-actions.pod:4646
17882 "Touch acts like the L<touch(1)> command. It can be used to update the "
17883 "timestamps on a file, or, if the file does not exist, to create a new zero-"
17888 #: ../src/guestfs-actions.pod:6983 ../fish/guestfish-actions.pod:4650
17890 "This command only works on regular files, and will fail on other file types "
17891 "such as directories, symbolic links, block special etc."
17895 #: ../src/guestfs-actions.pod:6990
17896 msgid "guestfs_truncate"
17900 #: ../src/guestfs-actions.pod:6992
17904 " guestfs_truncate (guestfs_h *g,\n"
17905 " const char *path);\n"
17910 #: ../src/guestfs-actions.pod:6996 ../fish/guestfish-actions.pod:4657
17912 "This command truncates C<path> to a zero-length file. The file must exist "
17917 #: ../src/guestfs-actions.pod:7003
17918 msgid "guestfs_truncate_size"
17922 #: ../src/guestfs-actions.pod:7005
17926 " guestfs_truncate_size (guestfs_h *g,\n"
17927 " const char *path,\n"
17928 " int64_t size);\n"
17933 #: ../src/guestfs-actions.pod:7010 ../fish/guestfish-actions.pod:4664
17935 "This command truncates C<path> to size C<size> bytes. The file must exist "
17940 #: ../src/guestfs-actions.pod:7013
17942 "If the current file size is less than C<size> then the file is extended to "
17943 "the required size with zero bytes. This creates a sparse file (ie. disk "
17944 "blocks are not allocated for the file until you write to it). To create a "
17945 "non-sparse file of zeroes, use C<guestfs_fallocate64> instead."
17949 #: ../src/guestfs-actions.pod:7023
17950 msgid "guestfs_tune2fs_l"
17954 #: ../src/guestfs-actions.pod:7025
17958 " guestfs_tune2fs_l (guestfs_h *g,\n"
17959 " const char *device);\n"
17964 #: ../src/guestfs-actions.pod:7029 ../fish/guestfish-actions.pod:4677
17966 "This returns the contents of the ext2, ext3 or ext4 filesystem superblock on "
17971 #: ../src/guestfs-actions.pod:7032 ../fish/guestfish-actions.pod:4680
17973 "It is the same as running C<tune2fs -l device>. See L<tune2fs(8)> manpage "
17974 "for more details. The list of fields returned isn't clearly defined, and "
17975 "depends on both the version of C<tune2fs> that libguestfs was built against, "
17976 "and the filesystem itself."
17980 #: ../src/guestfs-actions.pod:7045
17981 msgid "guestfs_txz_in"
17985 #: ../src/guestfs-actions.pod:7047
17989 " guestfs_txz_in (guestfs_h *g,\n"
17990 " const char *tarball,\n"
17991 " const char *directory);\n"
17996 #: ../src/guestfs-actions.pod:7052 ../fish/guestfish-actions.pod:4689
17998 "This command uploads and unpacks local file C<tarball> (an I<xz compressed> "
17999 "tar file) into C<directory>."
18003 #: ../src/guestfs-actions.pod:7059
18004 msgid "guestfs_txz_out"
18008 #: ../src/guestfs-actions.pod:7061
18012 " guestfs_txz_out (guestfs_h *g,\n"
18013 " const char *directory,\n"
18014 " const char *tarball);\n"
18019 #: ../src/guestfs-actions.pod:7066 ../fish/guestfish-actions.pod:4698
18021 "This command packs the contents of C<directory> and downloads it to local "
18022 "file C<tarball> (as an xz compressed tar archive)."
18026 #: ../src/guestfs-actions.pod:7073
18027 msgid "guestfs_umask"
18031 #: ../src/guestfs-actions.pod:7075
18035 " guestfs_umask (guestfs_h *g,\n"
18041 #: ../src/guestfs-actions.pod:7079 ../fish/guestfish-actions.pod:4707
18043 "This function sets the mask used for creating new files and device nodes to "
18048 #: ../src/guestfs-actions.pod:7082 ../fish/guestfish-actions.pod:4710
18050 "Typical umask values would be C<022> which creates new files with "
18051 "permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and C<002> which creates "
18052 "new files with permissions like \"-rw-rw-r--\" or \"-rwxrwxr-x\"."
18056 #: ../src/guestfs-actions.pod:7087 ../fish/guestfish-actions.pod:4715
18058 "The default umask is C<022>. This is important because it means that "
18059 "directories and device nodes will be created with C<0644> or C<0755> mode "
18060 "even if you specify C<0777>."
18064 #: ../src/guestfs-actions.pod:7091
18066 "See also C<guestfs_get_umask>, L<umask(2)>, C<guestfs_mknod>, "
18067 "C<guestfs_mkdir>."
18071 #: ../src/guestfs-actions.pod:7094 ../fish/guestfish-actions.pod:4722
18072 msgid "This call returns the previous umask."
18076 #: ../src/guestfs-actions.pod:7100
18077 msgid "guestfs_umount"
18081 #: ../src/guestfs-actions.pod:7102
18085 " guestfs_umount (guestfs_h *g,\n"
18086 " const char *pathordevice);\n"
18091 #: ../src/guestfs-actions.pod:7106 ../fish/guestfish-actions.pod:4730
18093 "This unmounts the given filesystem. The filesystem may be specified either "
18094 "by its mountpoint (path) or the device which contains the filesystem."
18098 #: ../src/guestfs-actions.pod:7114
18099 msgid "guestfs_umount_all"
18103 #: ../src/guestfs-actions.pod:7116
18107 " guestfs_umount_all (guestfs_h *g);\n"
18112 #: ../src/guestfs-actions.pod:7119 ../fish/guestfish-actions.pod:4740
18113 msgid "This unmounts all mounted filesystems."
18117 #: ../src/guestfs-actions.pod:7121 ../fish/guestfish-actions.pod:4742
18118 msgid "Some internal mounts are not unmounted by this call."
18122 #: ../src/guestfs-actions.pod:7127
18123 msgid "guestfs_upload"
18127 #: ../src/guestfs-actions.pod:7129
18131 " guestfs_upload (guestfs_h *g,\n"
18132 " const char *filename,\n"
18133 " const char *remotefilename);\n"
18138 #: ../src/guestfs-actions.pod:7134 ../src/guestfs-actions.pod:7158
18139 #: ../fish/guestfish-actions.pod:4748 ../fish/guestfish-actions.pod:4761
18140 msgid "Upload local file C<filename> to C<remotefilename> on the filesystem."
18144 #: ../src/guestfs-actions.pod:7139
18145 msgid "See also C<guestfs_download>."
18149 #: ../src/guestfs-actions.pod:7150
18150 msgid "guestfs_upload_offset"
18154 #: ../src/guestfs-actions.pod:7152
18158 " guestfs_upload_offset (guestfs_h *g,\n"
18159 " const char *filename,\n"
18160 " const char *remotefilename,\n"
18161 " int64_t offset);\n"
18166 #: ../src/guestfs-actions.pod:7161 ../fish/guestfish-actions.pod:4764
18168 "C<remotefilename> is overwritten starting at the byte C<offset> specified. "
18169 "The intention is to overwrite parts of existing files or devices, although "
18170 "if a non-existant file is specified then it is created with a \"hole\" "
18171 "before C<offset>. The size of the data written is implicit in the size of "
18172 "the source C<filename>."
18176 #: ../src/guestfs-actions.pod:7168
18178 "Note that there is no limit on the amount of data that can be uploaded with "
18179 "this call, unlike with C<guestfs_pwrite>, and this call always writes the "
18180 "full amount unless an error occurs."
18184 #: ../src/guestfs-actions.pod:7173
18185 msgid "See also C<guestfs_upload>, C<guestfs_pwrite>."
18189 #: ../src/guestfs-actions.pod:7184
18190 msgid "guestfs_utimens"
18194 #: ../src/guestfs-actions.pod:7186
18198 " guestfs_utimens (guestfs_h *g,\n"
18199 " const char *path,\n"
18200 " int64_t atsecs,\n"
18201 " int64_t atnsecs,\n"
18202 " int64_t mtsecs,\n"
18203 " int64_t mtnsecs);\n"
18208 #: ../src/guestfs-actions.pod:7194 ../fish/guestfish-actions.pod:4784
18209 msgid "This command sets the timestamps of a file with nanosecond precision."
18213 #: ../src/guestfs-actions.pod:7197 ../fish/guestfish-actions.pod:4787
18215 "C<atsecs, atnsecs> are the last access time (atime) in secs and nanoseconds "
18220 #: ../src/guestfs-actions.pod:7200 ../fish/guestfish-actions.pod:4790
18222 "C<mtsecs, mtnsecs> are the last modification time (mtime) in secs and "
18223 "nanoseconds from the epoch."
18227 #: ../src/guestfs-actions.pod:7203 ../fish/guestfish-actions.pod:4793
18229 "If the C<*nsecs> field contains the special value C<-1> then the "
18230 "corresponding timestamp is set to the current time. (The C<*secs> field is "
18231 "ignored in this case)."
18235 #: ../src/guestfs-actions.pod:7207 ../fish/guestfish-actions.pod:4797
18237 "If the C<*nsecs> field contains the special value C<-2> then the "
18238 "corresponding timestamp is left unchanged. (The C<*secs> field is ignored "
18243 #: ../src/guestfs-actions.pod:7215 ../src/guestfs-structs.pod:175
18244 msgid "guestfs_version"
18248 #: ../src/guestfs-actions.pod:7217
18251 " struct guestfs_version *\n"
18252 " guestfs_version (guestfs_h *g);\n"
18257 #: ../src/guestfs-actions.pod:7220 ../fish/guestfish-actions.pod:4805
18259 "Return the libguestfs version number that the program is linked against."
18263 #: ../src/guestfs-actions.pod:7223 ../fish/guestfish-actions.pod:4808
18265 "Note that because of dynamic linking this is not necessarily the version of "
18266 "libguestfs that you compiled against. You can compile the program, and then "
18267 "at runtime dynamically link against a completely different C<libguestfs.so> "
18272 #: ../src/guestfs-actions.pod:7228 ../fish/guestfish-actions.pod:4813
18274 "This call was added in version C<1.0.58>. In previous versions of "
18275 "libguestfs there was no way to get the version number. From C code you can "
18276 "use dynamic linker functions to find out if this symbol exists (if it "
18277 "doesn't, then it's an earlier version)."
18281 #: ../src/guestfs-actions.pod:7234 ../fish/guestfish-actions.pod:4819
18283 "The call returns a structure with four elements. The first three (C<major>, "
18284 "C<minor> and C<release>) are numbers and correspond to the usual version "
18285 "triplet. The fourth element (C<extra>) is a string and is normally empty, "
18286 "but may be used for distro-specific information."
18290 #: ../src/guestfs-actions.pod:7240 ../fish/guestfish-actions.pod:4825
18292 "To construct the original version string: C<$major.$minor.$release$extra>"
18296 #: ../src/guestfs-actions.pod:7243 ../fish/guestfish-actions.pod:4828
18297 msgid "See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>."
18301 #: ../src/guestfs-actions.pod:7245
18303 "I<Note:> Don't use this call to test for availability of features. In "
18304 "enterprise distributions we backport features from later versions into "
18305 "earlier versions, making this an unreliable way to test for features. Use "
18306 "C<guestfs_available> instead."
18310 #: ../src/guestfs-actions.pod:7251
18312 "This function returns a C<struct guestfs_version *>, or NULL if there was an "
18313 "error. I<The caller must call C<guestfs_free_version> after use>."
18317 #: ../src/guestfs-actions.pod:7255
18318 msgid "(Added in 1.0.58)"
18322 #: ../src/guestfs-actions.pod:7257
18323 msgid "guestfs_vfs_label"
18327 #: ../src/guestfs-actions.pod:7259
18331 " guestfs_vfs_label (guestfs_h *g,\n"
18332 " const char *device);\n"
18337 #: ../src/guestfs-actions.pod:7263 ../fish/guestfish-actions.pod:4840
18338 msgid "This returns the filesystem label of the filesystem on C<device>."
18342 #: ../src/guestfs-actions.pod:7266 ../fish/guestfish-actions.pod:4843
18343 msgid "If the filesystem is unlabeled, this returns the empty string."
18347 #: ../src/guestfs-actions.pod:7268
18348 msgid "To find a filesystem from the label, use C<guestfs_findfs_label>."
18352 #: ../src/guestfs-actions.pod:7273 ../src/guestfs-actions.pod:7310
18353 msgid "(Added in 1.3.18)"
18357 #: ../src/guestfs-actions.pod:7275
18358 msgid "guestfs_vfs_type"
18362 #: ../src/guestfs-actions.pod:7277
18366 " guestfs_vfs_type (guestfs_h *g,\n"
18367 " const char *device);\n"
18372 #: ../src/guestfs-actions.pod:7281 ../fish/guestfish-actions.pod:4851
18374 "This command gets the filesystem type corresponding to the filesystem on "
18379 #: ../src/guestfs-actions.pod:7284 ../fish/guestfish-actions.pod:4854
18381 "For most filesystems, the result is the name of the Linux VFS module which "
18382 "would be used to mount this filesystem if you mounted it without specifying "
18383 "the filesystem type. For example a string such as C<ext3> or C<ntfs>."
18387 #: ../src/guestfs-actions.pod:7294
18388 msgid "guestfs_vfs_uuid"
18392 #: ../src/guestfs-actions.pod:7296
18396 " guestfs_vfs_uuid (guestfs_h *g,\n"
18397 " const char *device);\n"
18402 #: ../src/guestfs-actions.pod:7300 ../fish/guestfish-actions.pod:4863
18403 msgid "This returns the filesystem UUID of the filesystem on C<device>."
18407 #: ../src/guestfs-actions.pod:7303 ../fish/guestfish-actions.pod:4866
18408 msgid "If the filesystem does not have a UUID, this returns the empty string."
18412 #: ../src/guestfs-actions.pod:7305
18413 msgid "To find a filesystem from the UUID, use C<guestfs_findfs_uuid>."
18417 #: ../src/guestfs-actions.pod:7312
18418 msgid "guestfs_vg_activate"
18422 #: ../src/guestfs-actions.pod:7314
18426 " guestfs_vg_activate (guestfs_h *g,\n"
18428 " char *const *volgroups);\n"
18433 #: ../src/guestfs-actions.pod:7319 ../fish/guestfish-actions.pod:4874
18435 "This command activates or (if C<activate> is false) deactivates all logical "
18436 "volumes in the listed volume groups C<volgroups>."
18440 #: ../src/guestfs-actions.pod:7322 ../fish/guestfish-actions.pod:4877
18441 msgid "This command is the same as running C<vgchange -a y|n volgroups...>"
18445 #: ../src/guestfs-actions.pod:7324 ../fish/guestfish-actions.pod:4879
18447 "Note that if C<volgroups> is an empty list then B<all> volume groups are "
18448 "activated or deactivated."
18452 #: ../src/guestfs-actions.pod:7331
18453 msgid "guestfs_vg_activate_all"
18457 #: ../src/guestfs-actions.pod:7333
18461 " guestfs_vg_activate_all (guestfs_h *g,\n"
18462 " int activate);\n"
18467 #: ../src/guestfs-actions.pod:7337 ../fish/guestfish-actions.pod:4886
18469 "This command activates or (if C<activate> is false) deactivates all logical "
18470 "volumes in all volume groups."
18474 #: ../src/guestfs-actions.pod:7340 ../fish/guestfish-actions.pod:4889
18475 msgid "This command is the same as running C<vgchange -a y|n>"
18479 #: ../src/guestfs-actions.pod:7346
18480 msgid "guestfs_vgcreate"
18484 #: ../src/guestfs-actions.pod:7348
18488 " guestfs_vgcreate (guestfs_h *g,\n"
18489 " const char *volgroup,\n"
18490 " char *const *physvols);\n"
18495 #: ../src/guestfs-actions.pod:7353 ../fish/guestfish-actions.pod:4895
18497 "This creates an LVM volume group called C<volgroup> from the non-empty list "
18498 "of physical volumes C<physvols>."
18502 #: ../src/guestfs-actions.pod:7360
18503 msgid "guestfs_vglvuuids"
18507 #: ../src/guestfs-actions.pod:7362
18511 " guestfs_vglvuuids (guestfs_h *g,\n"
18512 " const char *vgname);\n"
18517 #: ../src/guestfs-actions.pod:7366 ../fish/guestfish-actions.pod:4902
18519 "Given a VG called C<vgname>, this returns the UUIDs of all the logical "
18520 "volumes created in this volume group."
18524 #: ../src/guestfs-actions.pod:7369
18526 "You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid> calls to "
18527 "associate logical volumes and volume groups."
18531 #: ../src/guestfs-actions.pod:7372
18532 msgid "See also C<guestfs_vgpvuuids>."
18536 #: ../src/guestfs-actions.pod:7380
18537 msgid "guestfs_vgpvuuids"
18541 #: ../src/guestfs-actions.pod:7382
18545 " guestfs_vgpvuuids (guestfs_h *g,\n"
18546 " const char *vgname);\n"
18551 #: ../src/guestfs-actions.pod:7386 ../fish/guestfish-actions.pod:4914
18553 "Given a VG called C<vgname>, this returns the UUIDs of all the physical "
18554 "volumes that this volume group resides on."
18558 #: ../src/guestfs-actions.pod:7389
18560 "You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid> calls to "
18561 "associate physical volumes and volume groups."
18565 #: ../src/guestfs-actions.pod:7392
18566 msgid "See also C<guestfs_vglvuuids>."
18570 #: ../src/guestfs-actions.pod:7400
18571 msgid "guestfs_vgremove"
18575 #: ../src/guestfs-actions.pod:7402
18579 " guestfs_vgremove (guestfs_h *g,\n"
18580 " const char *vgname);\n"
18585 #: ../src/guestfs-actions.pod:7406 ../fish/guestfish-actions.pod:4926
18586 msgid "Remove an LVM volume group C<vgname>, (for example C<VG>)."
18590 #: ../src/guestfs-actions.pod:7408 ../fish/guestfish-actions.pod:4928
18592 "This also forcibly removes all logical volumes in the volume group (if any)."
18596 #: ../src/guestfs-actions.pod:7415
18597 msgid "guestfs_vgrename"
18601 #: ../src/guestfs-actions.pod:7417
18605 " guestfs_vgrename (guestfs_h *g,\n"
18606 " const char *volgroup,\n"
18607 " const char *newvolgroup);\n"
18612 #: ../src/guestfs-actions.pod:7422 ../fish/guestfish-actions.pod:4935
18613 msgid "Rename a volume group C<volgroup> with the new name C<newvolgroup>."
18617 #: ../src/guestfs-actions.pod:7428
18618 msgid "guestfs_vgs"
18622 #: ../src/guestfs-actions.pod:7430
18626 " guestfs_vgs (guestfs_h *g);\n"
18631 #: ../src/guestfs-actions.pod:7433 ../fish/guestfish-actions.pod:4941
18633 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
18638 #: ../src/guestfs-actions.pod:7436 ../fish/guestfish-actions.pod:4944
18640 "This returns a list of just the volume group names that were detected (eg. "
18645 #: ../src/guestfs-actions.pod:7439
18646 msgid "See also C<guestfs_vgs_full>."
18650 #: ../src/guestfs-actions.pod:7447
18651 msgid "guestfs_vgs_full"
18655 #: ../src/guestfs-actions.pod:7449
18658 " struct guestfs_lvm_vg_list *\n"
18659 " guestfs_vgs_full (guestfs_h *g);\n"
18664 #: ../src/guestfs-actions.pod:7452 ../fish/guestfish-actions.pod:4953
18666 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
18667 "> command. The \"full\" version includes all fields."
18671 #: ../src/guestfs-actions.pod:7455
18673 "This function returns a C<struct guestfs_lvm_vg_list *>, or NULL if there "
18674 "was an error. I<The caller must call C<guestfs_free_lvm_vg_list> after use>."
18678 #: ../src/guestfs-actions.pod:7461
18679 msgid "guestfs_vgscan"
18683 #: ../src/guestfs-actions.pod:7463
18687 " guestfs_vgscan (guestfs_h *g);\n"
18692 #: ../src/guestfs-actions.pod:7466 ../fish/guestfish-actions.pod:4960
18694 "This rescans all block devices and rebuilds the list of LVM physical "
18695 "volumes, volume groups and logical volumes."
18699 #: ../src/guestfs-actions.pod:7473
18700 msgid "guestfs_vguuid"
18704 #: ../src/guestfs-actions.pod:7475
18708 " guestfs_vguuid (guestfs_h *g,\n"
18709 " const char *vgname);\n"
18714 #: ../src/guestfs-actions.pod:7479 ../fish/guestfish-actions.pod:4967
18715 msgid "This command returns the UUID of the LVM VG named C<vgname>."
18719 #: ../src/guestfs-actions.pod:7486
18720 msgid "guestfs_wait_ready"
18724 #: ../src/guestfs-actions.pod:7488
18728 " guestfs_wait_ready (guestfs_h *g);\n"
18733 #: ../src/guestfs-actions.pod:7491
18734 msgid "This function is a no op."
18738 #: ../src/guestfs-actions.pod:7493
18740 "In versions of the API E<lt> 1.0.71 you had to call this function just after "
18741 "calling C<guestfs_launch> to wait for the launch to complete. However this "
18742 "is no longer necessary because C<guestfs_launch> now does the waiting."
18746 #: ../src/guestfs-actions.pod:7498
18748 "If you see any calls to this function in code then you can just remove them, "
18749 "unless you want to retain compatibility with older versions of the API."
18753 #: ../src/guestfs-actions.pod:7504
18755 "This function is deprecated. In new code, use the C<launch> call instead."
18759 #: ../src/guestfs-actions.pod:7513
18760 msgid "guestfs_wc_c"
18764 #: ../src/guestfs-actions.pod:7515
18768 " guestfs_wc_c (guestfs_h *g,\n"
18769 " const char *path);\n"
18774 #: ../src/guestfs-actions.pod:7519 ../fish/guestfish-actions.pod:4973
18776 "This command counts the characters in a file, using the C<wc -c> external "
18781 #: ../src/guestfs-actions.pod:7526
18782 msgid "guestfs_wc_l"
18786 #: ../src/guestfs-actions.pod:7528
18790 " guestfs_wc_l (guestfs_h *g,\n"
18791 " const char *path);\n"
18796 #: ../src/guestfs-actions.pod:7532 ../fish/guestfish-actions.pod:4980
18798 "This command counts the lines in a file, using the C<wc -l> external command."
18802 #: ../src/guestfs-actions.pod:7539
18803 msgid "guestfs_wc_w"
18807 #: ../src/guestfs-actions.pod:7541
18811 " guestfs_wc_w (guestfs_h *g,\n"
18812 " const char *path);\n"
18817 #: ../src/guestfs-actions.pod:7545 ../fish/guestfish-actions.pod:4987
18819 "This command counts the words in a file, using the C<wc -w> external command."
18823 #: ../src/guestfs-actions.pod:7552
18824 msgid "guestfs_write"
18828 #: ../src/guestfs-actions.pod:7554
18832 " guestfs_write (guestfs_h *g,\n"
18833 " const char *path,\n"
18834 " const char *content,\n"
18835 " size_t content_size);\n"
18840 #: ../src/guestfs-actions.pod:7560 ../fish/guestfish-actions.pod:4994
18842 "This call creates a file called C<path>. The content of the file is the "
18843 "string C<content> (which can contain any 8 bit data)."
18847 #: ../src/guestfs-actions.pod:7570
18848 msgid "guestfs_write_file"
18852 #: ../src/guestfs-actions.pod:7572
18856 " guestfs_write_file (guestfs_h *g,\n"
18857 " const char *path,\n"
18858 " const char *content,\n"
18864 #: ../src/guestfs-actions.pod:7578 ../fish/guestfish-actions.pod:5004
18866 "This call creates a file called C<path>. The contents of the file is the "
18867 "string C<content> (which can contain any 8 bit data), with length C<size>."
18871 #: ../src/guestfs-actions.pod:7582 ../fish/guestfish-actions.pod:5008
18873 "As a special case, if C<size> is C<0> then the length is calculated using "
18874 "C<strlen> (so in this case the content cannot contain embedded ASCII NULs)."
18878 #: ../src/guestfs-actions.pod:7586 ../fish/guestfish-actions.pod:5012
18880 "I<NB.> Owing to a bug, writing content containing ASCII NUL characters does "
18881 "I<not> work, even if the length is specified."
18885 #: ../src/guestfs-actions.pod:7594 ../fish/guestfish-actions.pod:5018
18887 "This function is deprecated. In new code, use the C<write> call instead."
18891 #: ../src/guestfs-actions.pod:7603
18892 msgid "guestfs_zegrep"
18896 #: ../src/guestfs-actions.pod:7605
18900 " guestfs_zegrep (guestfs_h *g,\n"
18901 " const char *regex,\n"
18902 " const char *path);\n"
18907 #: ../src/guestfs-actions.pod:7610 ../fish/guestfish-actions.pod:5029
18909 "This calls the external C<zegrep> program and returns the matching lines."
18913 #: ../src/guestfs-actions.pod:7622
18914 msgid "guestfs_zegrepi"
18918 #: ../src/guestfs-actions.pod:7624
18922 " guestfs_zegrepi (guestfs_h *g,\n"
18923 " const char *regex,\n"
18924 " const char *path);\n"
18929 #: ../src/guestfs-actions.pod:7629 ../fish/guestfish-actions.pod:5039
18931 "This calls the external C<zegrep -i> program and returns the matching lines."
18935 #: ../src/guestfs-actions.pod:7641
18936 msgid "guestfs_zero"
18940 #: ../src/guestfs-actions.pod:7643
18944 " guestfs_zero (guestfs_h *g,\n"
18945 " const char *device);\n"
18950 #: ../src/guestfs-actions.pod:7647 ../fish/guestfish-actions.pod:5049
18951 msgid "This command writes zeroes over the first few blocks of C<device>."
18955 #: ../src/guestfs-actions.pod:7649 ../fish/guestfish-actions.pod:5051
18957 "How many blocks are zeroed isn't specified (but it's I<not> enough to "
18958 "securely wipe the device). It should be sufficient to remove any partition "
18959 "tables, filesystem superblocks and so on."
18963 #: ../src/guestfs-actions.pod:7653
18965 "See also: C<guestfs_zero_device>, C<guestfs_scrub_device>, "
18966 "C<guestfs_is_zero_device>"
18970 #: ../src/guestfs-actions.pod:7665
18971 msgid "guestfs_zero_device"
18975 #: ../src/guestfs-actions.pod:7667
18979 " guestfs_zero_device (guestfs_h *g,\n"
18980 " const char *device);\n"
18985 #: ../src/guestfs-actions.pod:7671
18987 "This command writes zeroes over the entire C<device>. Compare with "
18988 "C<guestfs_zero> which just zeroes the first few blocks of a device."
18992 #: ../src/guestfs-actions.pod:7685
18993 msgid "(Added in 1.3.1)"
18997 #: ../src/guestfs-actions.pod:7687
18998 msgid "guestfs_zerofree"
19002 #: ../src/guestfs-actions.pod:7689
19006 " guestfs_zerofree (guestfs_h *g,\n"
19007 " const char *device);\n"
19012 #: ../src/guestfs-actions.pod:7693 ../fish/guestfish-actions.pod:5073
19014 "This runs the I<zerofree> program on C<device>. This program claims to zero "
19015 "unused inodes and disk blocks on an ext2/3 filesystem, thus making it "
19016 "possible to compress the filesystem more effectively."
19020 #: ../src/guestfs-actions.pod:7698 ../fish/guestfish-actions.pod:5078
19021 msgid "You should B<not> run this program if the filesystem is mounted."
19025 #: ../src/guestfs-actions.pod:7701 ../fish/guestfish-actions.pod:5081
19027 "It is possible that using this program can damage the filesystem or data on "
19032 #: ../src/guestfs-actions.pod:7708
19033 msgid "guestfs_zfgrep"
19037 #: ../src/guestfs-actions.pod:7710
19041 " guestfs_zfgrep (guestfs_h *g,\n"
19042 " const char *pattern,\n"
19043 " const char *path);\n"
19048 #: ../src/guestfs-actions.pod:7715 ../fish/guestfish-actions.pod:5088
19050 "This calls the external C<zfgrep> program and returns the matching lines."
19054 #: ../src/guestfs-actions.pod:7727
19055 msgid "guestfs_zfgrepi"
19059 #: ../src/guestfs-actions.pod:7729
19063 " guestfs_zfgrepi (guestfs_h *g,\n"
19064 " const char *pattern,\n"
19065 " const char *path);\n"
19070 #: ../src/guestfs-actions.pod:7734 ../fish/guestfish-actions.pod:5098
19072 "This calls the external C<zfgrep -i> program and returns the matching lines."
19076 #: ../src/guestfs-actions.pod:7746
19077 msgid "guestfs_zfile"
19081 #: ../src/guestfs-actions.pod:7748
19085 " guestfs_zfile (guestfs_h *g,\n"
19086 " const char *meth,\n"
19087 " const char *path);\n"
19092 #: ../src/guestfs-actions.pod:7753 ../fish/guestfish-actions.pod:5108
19094 "This command runs C<file> after first decompressing C<path> using C<method>."
19098 #: ../src/guestfs-actions.pod:7756 ../fish/guestfish-actions.pod:5111
19099 msgid "C<method> must be one of C<gzip>, C<compress> or C<bzip2>."
19103 #: ../src/guestfs-actions.pod:7758
19105 "Since 1.0.63, use C<guestfs_file> instead which can now process compressed "
19110 #: ../src/guestfs-actions.pod:7764 ../fish/guestfish-actions.pod:5116
19112 "This function is deprecated. In new code, use the C<file> call instead."
19116 #: ../src/guestfs-actions.pod:7773
19117 msgid "guestfs_zgrep"
19121 #: ../src/guestfs-actions.pod:7775
19125 " guestfs_zgrep (guestfs_h *g,\n"
19126 " const char *regex,\n"
19127 " const char *path);\n"
19132 #: ../src/guestfs-actions.pod:7780 ../fish/guestfish-actions.pod:5127
19134 "This calls the external C<zgrep> program and returns the matching lines."
19138 #: ../src/guestfs-actions.pod:7792
19139 msgid "guestfs_zgrepi"
19143 #: ../src/guestfs-actions.pod:7794
19147 " guestfs_zgrepi (guestfs_h *g,\n"
19148 " const char *regex,\n"
19149 " const char *path);\n"
19154 #: ../src/guestfs-actions.pod:7799 ../fish/guestfish-actions.pod:5137
19156 "This calls the external C<zgrep -i> program and returns the matching lines."
19160 #: ../src/guestfs-availability.pod:3
19165 #: ../src/guestfs-availability.pod:5
19167 "The following functions: L</guestfs_aug_clear> L</guestfs_aug_close> L</"
19168 "guestfs_aug_defnode> L</guestfs_aug_defvar> L</guestfs_aug_get> L</"
19169 "guestfs_aug_init> L</guestfs_aug_insert> L</guestfs_aug_load> L</"
19170 "guestfs_aug_ls> L</guestfs_aug_match> L</guestfs_aug_mv> L</guestfs_aug_rm> "
19171 "L</guestfs_aug_save> L</guestfs_aug_set>"
19175 #: ../src/guestfs-availability.pod:21
19180 #: ../src/guestfs-availability.pod:23
19182 "The following functions: L</guestfs_inotify_add_watch> L</"
19183 "guestfs_inotify_close> L</guestfs_inotify_files> L</guestfs_inotify_init> L</"
19184 "guestfs_inotify_read> L</guestfs_inotify_rm_watch>"
19188 #: ../src/guestfs-availability.pod:31
19189 msgid "B<linuxfsuuid>"
19193 #: ../src/guestfs-availability.pod:33
19195 "The following functions: L</guestfs_mke2fs_JU> L</guestfs_mke2journal_U> L</"
19196 "guestfs_mkswap_U> L</guestfs_swapoff_uuid> L</guestfs_swapon_uuid>"
19200 #: ../src/guestfs-availability.pod:40
19201 msgid "B<linuxmodules>"
19205 #: ../src/guestfs-availability.pod:42
19206 msgid "The following functions: L</guestfs_modprobe>"
19210 #: ../src/guestfs-availability.pod:45
19211 msgid "B<linuxxattrs>"
19215 #: ../src/guestfs-availability.pod:47
19217 "The following functions: L</guestfs_getxattr> L</guestfs_getxattrs> L</"
19218 "guestfs_lgetxattr> L</guestfs_lgetxattrs> L</guestfs_lremovexattr> L</"
19219 "guestfs_lsetxattr> L</guestfs_lxattrlist> L</guestfs_removexattr> L</"
19220 "guestfs_setxattr>"
19224 #: ../src/guestfs-availability.pod:58
19229 #: ../src/guestfs-availability.pod:60
19231 "The following functions: L</guestfs_luks_add_key> L</guestfs_luks_close> L</"
19232 "guestfs_luks_format> L</guestfs_luks_format_cipher> L</"
19233 "guestfs_luks_kill_slot> L</guestfs_luks_open> L</guestfs_luks_open_ro>"
19237 #: ../src/guestfs-availability.pod:69
19242 #: ../src/guestfs-availability.pod:71
19244 "The following functions: L</guestfs_is_lv> L</guestfs_lvcreate> L</"
19245 "guestfs_lvm_remove_all> L</guestfs_lvm_set_filter> L</guestfs_lvremove> L</"
19246 "guestfs_lvresize> L</guestfs_lvresize_free> L</guestfs_lvs> L</"
19247 "guestfs_lvs_full> L</guestfs_pvcreate> L</guestfs_pvremove> L</"
19248 "guestfs_pvresize> L</guestfs_pvresize_size> L</guestfs_pvs> L</"
19249 "guestfs_pvs_full> L</guestfs_vg_activate> L</guestfs_vg_activate_all> L</"
19250 "guestfs_vgcreate> L</guestfs_vgremove> L</guestfs_vgs> L</guestfs_vgs_full>"
19254 #: ../src/guestfs-availability.pod:94
19259 #: ../src/guestfs-availability.pod:96
19261 "The following functions: L</guestfs_mkfifo> L</guestfs_mknod> L</"
19262 "guestfs_mknod_b> L</guestfs_mknod_c>"
19266 #: ../src/guestfs-availability.pod:102
19271 #: ../src/guestfs-availability.pod:104
19272 msgid "The following functions: L</guestfs_ntfs_3g_probe>"
19276 #: ../src/guestfs-availability.pod:107
19277 msgid "B<ntfsprogs>"
19281 #: ../src/guestfs-availability.pod:109
19283 "The following functions: L</guestfs_ntfsresize> L</guestfs_ntfsresize_opts> "
19284 "L</guestfs_ntfsresize_size>"
19288 #: ../src/guestfs-availability.pod:114
19289 msgid "B<realpath>"
19293 #: ../src/guestfs-availability.pod:116
19294 msgid "The following functions: L</guestfs_realpath>"
19298 #: ../src/guestfs-availability.pod:119
19303 #: ../src/guestfs-availability.pod:121
19305 "The following functions: L</guestfs_scrub_device> L</guestfs_scrub_file> L</"
19306 "guestfs_scrub_freespace>"
19310 #: ../src/guestfs-availability.pod:126
19315 #: ../src/guestfs-availability.pod:128
19316 msgid "The following functions: L</guestfs_getcon> L</guestfs_setcon>"
19320 #: ../src/guestfs-availability.pod:132
19325 #: ../src/guestfs-availability.pod:134
19326 msgid "The following functions: L</guestfs_txz_in> L</guestfs_txz_out>"
19330 #: ../src/guestfs-availability.pod:138
19331 msgid "B<zerofree>"
19335 #: ../src/guestfs-availability.pod:140
19336 msgid "The following functions: L</guestfs_zerofree>"
19340 #: ../src/guestfs-structs.pod:1
19341 msgid "guestfs_int_bool"
19345 #: ../src/guestfs-structs.pod:3
19348 " struct guestfs_int_bool {\n"
19356 #: ../src/guestfs-structs.pod:8
19359 " struct guestfs_int_bool_list {\n"
19360 " uint32_t len; /* Number of elements in list. */\n"
19361 " struct guestfs_int_bool *val; /* Elements. */\n"
19367 #: ../src/guestfs-structs.pod:13
19370 " void guestfs_free_int_bool (struct guestfs_free_int_bool *);\n"
19371 " void guestfs_free_int_bool_list (struct guestfs_free_int_bool_list *);\n"
19376 #: ../src/guestfs-structs.pod:16
19377 msgid "guestfs_lvm_pv"
19381 #: ../src/guestfs-structs.pod:18
19384 " struct guestfs_lvm_pv {\n"
19385 " char *pv_name;\n"
19386 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
19387 " char pv_uuid[32];\n"
19389 " uint64_t pv_size;\n"
19390 " uint64_t dev_size;\n"
19391 " uint64_t pv_free;\n"
19392 " uint64_t pv_used;\n"
19393 " char *pv_attr;\n"
19394 " int64_t pv_pe_count;\n"
19395 " int64_t pv_pe_alloc_count;\n"
19396 " char *pv_tags;\n"
19397 " uint64_t pe_start;\n"
19398 " int64_t pv_mda_count;\n"
19399 " uint64_t pv_mda_free;\n"
19405 #: ../src/guestfs-structs.pod:36
19408 " struct guestfs_lvm_pv_list {\n"
19409 " uint32_t len; /* Number of elements in list. */\n"
19410 " struct guestfs_lvm_pv *val; /* Elements. */\n"
19416 #: ../src/guestfs-structs.pod:41
19419 " void guestfs_free_lvm_pv (struct guestfs_free_lvm_pv *);\n"
19420 " void guestfs_free_lvm_pv_list (struct guestfs_free_lvm_pv_list *);\n"
19425 #: ../src/guestfs-structs.pod:44
19426 msgid "guestfs_lvm_vg"
19430 #: ../src/guestfs-structs.pod:46
19433 " struct guestfs_lvm_vg {\n"
19434 " char *vg_name;\n"
19435 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
19436 " char vg_uuid[32];\n"
19438 " char *vg_attr;\n"
19439 " uint64_t vg_size;\n"
19440 " uint64_t vg_free;\n"
19441 " char *vg_sysid;\n"
19442 " uint64_t vg_extent_size;\n"
19443 " int64_t vg_extent_count;\n"
19444 " int64_t vg_free_count;\n"
19445 " int64_t max_lv;\n"
19446 " int64_t max_pv;\n"
19447 " int64_t pv_count;\n"
19448 " int64_t lv_count;\n"
19449 " int64_t snap_count;\n"
19450 " int64_t vg_seqno;\n"
19451 " char *vg_tags;\n"
19452 " int64_t vg_mda_count;\n"
19453 " uint64_t vg_mda_free;\n"
19459 #: ../src/guestfs-structs.pod:69
19462 " struct guestfs_lvm_vg_list {\n"
19463 " uint32_t len; /* Number of elements in list. */\n"
19464 " struct guestfs_lvm_vg *val; /* Elements. */\n"
19470 #: ../src/guestfs-structs.pod:74
19473 " void guestfs_free_lvm_vg (struct guestfs_free_lvm_vg *);\n"
19474 " void guestfs_free_lvm_vg_list (struct guestfs_free_lvm_vg_list *);\n"
19479 #: ../src/guestfs-structs.pod:77
19480 msgid "guestfs_lvm_lv"
19484 #: ../src/guestfs-structs.pod:79
19487 " struct guestfs_lvm_lv {\n"
19488 " char *lv_name;\n"
19489 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
19490 " char lv_uuid[32];\n"
19491 " char *lv_attr;\n"
19492 " int64_t lv_major;\n"
19493 " int64_t lv_minor;\n"
19494 " int64_t lv_kernel_major;\n"
19495 " int64_t lv_kernel_minor;\n"
19496 " uint64_t lv_size;\n"
19497 " int64_t seg_count;\n"
19499 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
19500 " float snap_percent;\n"
19501 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
19502 " float copy_percent;\n"
19503 " char *move_pv;\n"
19504 " char *lv_tags;\n"
19505 " char *mirror_log;\n"
19506 " char *modules;\n"
19512 #: ../src/guestfs-structs.pod:101
19515 " struct guestfs_lvm_lv_list {\n"
19516 " uint32_t len; /* Number of elements in list. */\n"
19517 " struct guestfs_lvm_lv *val; /* Elements. */\n"
19523 #: ../src/guestfs-structs.pod:106
19526 " void guestfs_free_lvm_lv (struct guestfs_free_lvm_lv *);\n"
19527 " void guestfs_free_lvm_lv_list (struct guestfs_free_lvm_lv_list *);\n"
19532 #: ../src/guestfs-structs.pod:111
19535 " struct guestfs_stat {\n"
19539 " int64_t nlink;\n"
19544 " int64_t blksize;\n"
19545 " int64_t blocks;\n"
19546 " int64_t atime;\n"
19547 " int64_t mtime;\n"
19548 " int64_t ctime;\n"
19554 #: ../src/guestfs-structs.pod:127
19557 " struct guestfs_stat_list {\n"
19558 " uint32_t len; /* Number of elements in list. */\n"
19559 " struct guestfs_stat *val; /* Elements. */\n"
19565 #: ../src/guestfs-structs.pod:132
19568 " void guestfs_free_stat (struct guestfs_free_stat *);\n"
19569 " void guestfs_free_stat_list (struct guestfs_free_stat_list *);\n"
19574 #: ../src/guestfs-structs.pod:137
19577 " struct guestfs_statvfs {\n"
19578 " int64_t bsize;\n"
19579 " int64_t frsize;\n"
19580 " int64_t blocks;\n"
19581 " int64_t bfree;\n"
19582 " int64_t bavail;\n"
19583 " int64_t files;\n"
19584 " int64_t ffree;\n"
19585 " int64_t favail;\n"
19588 " int64_t namemax;\n"
19594 #: ../src/guestfs-structs.pod:151
19597 " struct guestfs_statvfs_list {\n"
19598 " uint32_t len; /* Number of elements in list. */\n"
19599 " struct guestfs_statvfs *val; /* Elements. */\n"
19605 #: ../src/guestfs-structs.pod:156
19608 " void guestfs_free_statvfs (struct guestfs_free_statvfs *);\n"
19609 " void guestfs_free_statvfs_list (struct guestfs_free_statvfs_list *);\n"
19614 #: ../src/guestfs-structs.pod:159
19615 msgid "guestfs_dirent"
19619 #: ../src/guestfs-structs.pod:161
19622 " struct guestfs_dirent {\n"
19631 #: ../src/guestfs-structs.pod:167
19634 " struct guestfs_dirent_list {\n"
19635 " uint32_t len; /* Number of elements in list. */\n"
19636 " struct guestfs_dirent *val; /* Elements. */\n"
19642 #: ../src/guestfs-structs.pod:172
19645 " void guestfs_free_dirent (struct guestfs_free_dirent *);\n"
19646 " void guestfs_free_dirent_list (struct guestfs_free_dirent_list *);\n"
19651 #: ../src/guestfs-structs.pod:177
19654 " struct guestfs_version {\n"
19655 " int64_t major;\n"
19656 " int64_t minor;\n"
19657 " int64_t release;\n"
19664 #: ../src/guestfs-structs.pod:184
19667 " struct guestfs_version_list {\n"
19668 " uint32_t len; /* Number of elements in list. */\n"
19669 " struct guestfs_version *val; /* Elements. */\n"
19675 #: ../src/guestfs-structs.pod:189
19678 " void guestfs_free_version (struct guestfs_free_version *);\n"
19679 " void guestfs_free_version_list (struct guestfs_free_version_list *);\n"
19684 #: ../src/guestfs-structs.pod:192
19685 msgid "guestfs_xattr"
19689 #: ../src/guestfs-structs.pod:194
19692 " struct guestfs_xattr {\n"
19693 " char *attrname;\n"
19694 " /* The next two fields describe a byte array. */\n"
19695 " uint32_t attrval_len;\n"
19696 " char *attrval;\n"
19702 #: ../src/guestfs-structs.pod:201
19705 " struct guestfs_xattr_list {\n"
19706 " uint32_t len; /* Number of elements in list. */\n"
19707 " struct guestfs_xattr *val; /* Elements. */\n"
19713 #: ../src/guestfs-structs.pod:206
19716 " void guestfs_free_xattr (struct guestfs_free_xattr *);\n"
19717 " void guestfs_free_xattr_list (struct guestfs_free_xattr_list *);\n"
19722 #: ../src/guestfs-structs.pod:209
19723 msgid "guestfs_inotify_event"
19727 #: ../src/guestfs-structs.pod:211
19730 " struct guestfs_inotify_event {\n"
19731 " int64_t in_wd;\n"
19732 " uint32_t in_mask;\n"
19733 " uint32_t in_cookie;\n"
19734 " char *in_name;\n"
19740 #: ../src/guestfs-structs.pod:218
19743 " struct guestfs_inotify_event_list {\n"
19744 " uint32_t len; /* Number of elements in list. */\n"
19745 " struct guestfs_inotify_event *val; /* Elements. */\n"
19751 #: ../src/guestfs-structs.pod:223
19754 " void guestfs_free_inotify_event (struct guestfs_free_inotify_event *);\n"
19755 " void guestfs_free_inotify_event_list (struct guestfs_free_inotify_event_list *);\n"
19760 #: ../src/guestfs-structs.pod:226
19761 msgid "guestfs_partition"
19765 #: ../src/guestfs-structs.pod:228
19768 " struct guestfs_partition {\n"
19769 " int32_t part_num;\n"
19770 " uint64_t part_start;\n"
19771 " uint64_t part_end;\n"
19772 " uint64_t part_size;\n"
19778 #: ../src/guestfs-structs.pod:235
19781 " struct guestfs_partition_list {\n"
19782 " uint32_t len; /* Number of elements in list. */\n"
19783 " struct guestfs_partition *val; /* Elements. */\n"
19789 #: ../src/guestfs-structs.pod:240
19792 " void guestfs_free_partition (struct guestfs_free_partition *);\n"
19793 " void guestfs_free_partition_list (struct guestfs_free_partition_list *);\n"
19798 #: ../src/guestfs-structs.pod:243
19799 msgid "guestfs_application"
19803 #: ../src/guestfs-structs.pod:245
19806 " struct guestfs_application {\n"
19807 " char *app_name;\n"
19808 " char *app_display_name;\n"
19809 " int32_t app_epoch;\n"
19810 " char *app_version;\n"
19811 " char *app_release;\n"
19812 " char *app_install_path;\n"
19813 " char *app_trans_path;\n"
19814 " char *app_publisher;\n"
19815 " char *app_url;\n"
19816 " char *app_source_package;\n"
19817 " char *app_summary;\n"
19818 " char *app_description;\n"
19824 #: ../src/guestfs-structs.pod:260
19827 " struct guestfs_application_list {\n"
19828 " uint32_t len; /* Number of elements in list. */\n"
19829 " struct guestfs_application *val; /* Elements. */\n"
19835 #: ../src/guestfs-structs.pod:265
19838 " void guestfs_free_application (struct guestfs_free_application *);\n"
19839 " void guestfs_free_application_list (struct guestfs_free_application_list *);\n"
19844 #: ../fish/guestfish.pod:5
19845 msgid "guestfish - the libguestfs Filesystem Interactive SHell"
19849 #: ../fish/guestfish.pod:9
19852 " guestfish [--options] [commands]\n"
19857 #: ../fish/guestfish.pod:11
19865 #: ../fish/guestfish.pod:13
19868 " guestfish [--ro|--rw] -a disk.img\n"
19873 #: ../fish/guestfish.pod:15
19876 " guestfish [--ro|--rw] -a disk.img -m dev[:mountpoint]\n"
19881 #: ../fish/guestfish.pod:17
19884 " guestfish -d libvirt-domain\n"
19889 #: ../fish/guestfish.pod:19
19892 " guestfish [--ro|--rw] -a disk.img -i\n"
19897 #: ../fish/guestfish.pod:21
19900 " guestfish -d libvirt-domain -i\n"
19905 #: ../fish/guestfish.pod:23 ../fuse/guestmount.pod:15
19906 #: ../tools/virt-win-reg.pl:51 ../tools/virt-tar.pl:64
19911 #: ../fish/guestfish.pod:25
19913 "Using guestfish in read/write mode on live virtual machines can be "
19914 "dangerous, potentially causing disk corruption. Use the I<--ro> (read-only) "
19915 "option to use guestfish safely if the disk image or virtual machine might be "
19920 #: ../fish/guestfish.pod:32
19922 "Guestfish is a shell and command-line tool for examining and modifying "
19923 "virtual machine filesystems. It uses libguestfs and exposes all of the "
19924 "functionality of the guestfs API, see L<guestfs(3)>."
19928 #: ../fish/guestfish.pod:36
19930 "Guestfish gives you structured access to the libguestfs API, from shell "
19931 "scripts or the command line or interactively. If you want to rescue a "
19932 "broken virtual machine image, you should look at the L<virt-rescue(1)> "
19937 #: ../fish/guestfish.pod:41 ../fish/guestfish.pod:949
19938 #: ../fuse/guestmount.pod:39 ../tools/virt-tar.pl:50
19943 #: ../fish/guestfish.pod:43
19944 msgid "As an interactive shell"
19948 #: ../fish/guestfish.pod:45
19956 #: ../fish/guestfish.pod:47
19959 " Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
19960 " editing virtual machine filesystems.\n"
19965 #: ../fish/guestfish.pod:50
19968 " Type: 'help' for a list of commands\n"
19969 " 'man' to read the manual\n"
19970 " 'quit' to quit the shell\n"
19975 #: ../fish/guestfish.pod:54
19978 " ><fs> add-ro disk.img\n"
19980 " ><fs> list-filesystems\n"
19981 " /dev/sda1: ext4\n"
19982 " /dev/vg_guest/lv_root: ext4\n"
19983 " /dev/vg_guest/lv_swap: swap\n"
19984 " ><fs> mount /dev/vg_guest/lv_root /\n"
19985 " ><fs> cat /etc/fstab\n"
19987 " # Created by anaconda\n"
19994 #: ../fish/guestfish.pod:67
19995 msgid "From shell scripts"
19999 #: ../fish/guestfish.pod:69
20000 msgid "Create a new C</etc/motd> file in a guest or disk image:"
20004 #: ../fish/guestfish.pod:71
20007 " guestfish <<_EOF_\n"
20010 " mount /dev/vg_guest/lv_root /\n"
20011 " write /etc/motd \"Welcome, new users\"\n"
20017 #: ../fish/guestfish.pod:78
20018 msgid "List the LVM logical volumes in a disk image:"
20022 #: ../fish/guestfish.pod:80
20025 " guestfish -a disk.img --ro <<_EOF_\n"
20033 #: ../fish/guestfish.pod:85
20034 msgid "List all the filesystems in a disk image:"
20038 #: ../fish/guestfish.pod:87
20041 " guestfish -a disk.img --ro <<_EOF_\n"
20043 " list-filesystems\n"
20049 #: ../fish/guestfish.pod:92
20050 msgid "On one command line"
20054 #: ../fish/guestfish.pod:94
20055 msgid "Update C</etc/resolv.conf> in a guest:"
20059 #: ../fish/guestfish.pod:96
20063 " add disk.img : run : mount /dev/vg_guest/lv_root / : \\\n"
20064 " write /etc/resolv.conf \"nameserver 1.2.3.4\"\n"
20069 #: ../fish/guestfish.pod:100
20070 msgid "Edit C</boot/grub/grub.conf> interactively:"
20074 #: ../fish/guestfish.pod:102
20077 " guestfish --rw --add disk.img \\\n"
20078 " --mount /dev/vg_guest/lv_root \\\n"
20079 " --mount /dev/sda1:/boot \\\n"
20080 " edit /boot/grub/grub.conf\n"
20085 #: ../fish/guestfish.pod:107
20086 msgid "Mount disks automatically"
20090 #: ../fish/guestfish.pod:109
20092 "Use the I<-i> option to automatically mount the disks from a virtual machine:"
20096 #: ../fish/guestfish.pod:112
20099 " guestfish --ro -a disk.img -i cat /etc/group\n"
20104 #: ../fish/guestfish.pod:114
20107 " guestfish --ro -d libvirt-domain -i cat /etc/group\n"
20112 #: ../fish/guestfish.pod:116
20113 msgid "Another way to edit C</boot/grub/grub.conf> interactively is:"
20117 #: ../fish/guestfish.pod:118
20120 " guestfish --rw -a disk.img -i edit /boot/grub/grub.conf\n"
20125 #: ../fish/guestfish.pod:120
20126 msgid "As a script interpreter"
20130 #: ../fish/guestfish.pod:122
20131 msgid "Create a 100MB disk containing an ext2-formatted partition:"
20135 #: ../fish/guestfish.pod:124
20138 " #!/usr/bin/guestfish -f\n"
20139 " sparse test1.img 100M\n"
20141 " part-disk /dev/sda mbr\n"
20142 " mkfs ext2 /dev/sda1\n"
20147 #: ../fish/guestfish.pod:130
20148 msgid "Start with a prepared disk"
20152 #: ../fish/guestfish.pod:132
20154 "An alternate way to create a 100MB disk called C<test1.img> containing a "
20155 "single ext2-formatted partition:"
20159 #: ../fish/guestfish.pod:135
20162 " guestfish -N fs\n"
20167 #: ../fish/guestfish.pod:137
20168 msgid "To list what is available do:"
20172 #: ../fish/guestfish.pod:139 ../fish/guestfish.pod:940
20175 " guestfish -N help | less\n"
20180 #: ../fish/guestfish.pod:141
20181 msgid "Remote control"
20185 #: ../fish/guestfish.pod:143
20188 " eval \"`guestfish --listen`\"\n"
20189 " guestfish --remote add-ro disk.img\n"
20190 " guestfish --remote run\n"
20191 " guestfish --remote lvs\n"
20196 #: ../fish/guestfish.pod:148 ../test-tool/libguestfs-test-tool.pod:37
20197 #: ../fuse/guestmount.pod:83 ../tools/virt-win-reg.pl:96
20198 #: ../tools/virt-list-filesystems.pl:53 ../tools/virt-tar.pl:103
20199 #: ../tools/virt-make-fs.pl:153 ../tools/virt-list-partitions.pl:54
20204 #: ../fish/guestfish.pod:152 ../fuse/guestmount.pod:143
20205 #: ../tools/virt-win-reg.pl:104 ../tools/virt-list-filesystems.pl:61
20206 #: ../tools/virt-tar.pl:111 ../tools/virt-make-fs.pl:161
20207 #: ../tools/virt-list-partitions.pl:62
20212 #: ../fish/guestfish.pod:154
20213 msgid "Displays general help on options."
20217 #: ../fish/guestfish.pod:156
20222 #: ../fish/guestfish.pod:158
20223 msgid "B<--cmd-help>"
20227 #: ../fish/guestfish.pod:160
20228 msgid "Lists all available guestfish commands."
20232 #: ../fish/guestfish.pod:162
20237 #: ../fish/guestfish.pod:164
20238 msgid "B<--cmd-help cmd>"
20242 #: ../fish/guestfish.pod:166
20243 msgid "Displays detailed help on a single command C<cmd>."
20247 #: ../fish/guestfish.pod:168
20248 msgid "B<-a image>"
20252 #: ../fish/guestfish.pod:170
20253 msgid "B<--add image>"
20257 #: ../fish/guestfish.pod:172
20258 msgid "Add a block device or virtual machine image to the shell."
20262 #: ../fish/guestfish.pod:174 ../fuse/guestmount.pod:91
20264 "The format of the disk image is auto-detected. To override this and force a "
20265 "particular format use the I<--format=..> option."
20269 #: ../fish/guestfish.pod:177
20271 "Using this flag is mostly equivalent to using the C<add> command, with "
20272 "C<readonly:true> if the I<--ro> flag was given, and with C<format:...> if "
20273 "the I<--format=...> flag was given."
20277 #: ../fish/guestfish.pod:181
20282 #: ../fish/guestfish.pod:183
20283 msgid "B<--connect URI>"
20287 #: ../fish/guestfish.pod:185 ../fuse/guestmount.pod:96
20289 "When used in conjunction with the I<-d> option, this specifies the libvirt "
20290 "URI to use. The default is to use the default libvirt connection."
20294 #: ../fish/guestfish.pod:189
20299 #: ../fish/guestfish.pod:191
20301 "If using the I<--listen> option and a csh-like shell, use this option. See "
20302 "section L</REMOTE CONTROL AND CSH> below."
20306 #: ../fish/guestfish.pod:194
20307 msgid "B<-d libvirt-domain>"
20311 #: ../fish/guestfish.pod:196
20312 msgid "B<--domain libvirt-domain>"
20316 #: ../fish/guestfish.pod:198 ../fuse/guestmount.pod:102
20318 "Add disks from the named libvirt domain. If the I<--ro> option is also "
20319 "used, then any libvirt domain can be used. However in write mode, only "
20320 "libvirt domains which are shut down can be named here."
20324 #: ../fish/guestfish.pod:202 ../fuse/guestmount.pod:106
20325 msgid "Domain UUIDs can be used instead of names."
20329 #: ../fish/guestfish.pod:204
20331 "Using this flag is mostly equivalent to using the C<add-domain> command, "
20332 "with C<readonly:true> if the I<--ro> flag was given, and with C<format:...> "
20333 "if the I<--format:...> flag was given."
20337 #: ../fish/guestfish.pod:208
20342 #: ../fish/guestfish.pod:210
20343 msgid "B<--no-dest-paths>"
20347 #: ../fish/guestfish.pod:212
20349 "Don't tab-complete paths on the guest filesystem. It is useful to be able "
20350 "to hit the tab key to complete paths on the guest filesystem, but this "
20351 "causes extra \"hidden\" guestfs calls to be made, so this option is here to "
20352 "allow this feature to be disabled."
20356 #: ../fish/guestfish.pod:217 ../fuse/guestmount.pod:120
20357 msgid "B<--echo-keys>"
20361 #: ../fish/guestfish.pod:219 ../fuse/guestmount.pod:122
20363 "When prompting for keys and passphrases, guestfish normally turns echoing "
20364 "off so you cannot see what you are typing. If you are not worried about "
20365 "Tempest attacks and there is no one else in the room you can specify this "
20366 "flag to see what you are typing."
20370 #: ../fish/guestfish.pod:224
20375 #: ../fish/guestfish.pod:226
20376 msgid "B<--file file>"
20380 #: ../fish/guestfish.pod:228
20381 msgid "Read commands from C<file>. To write pure guestfish scripts, use:"
20385 #: ../fish/guestfish.pod:231
20388 " #!/usr/bin/guestfish -f\n"
20393 #: ../fish/guestfish.pod:233
20394 msgid "B<--format=raw|qcow2|..>"
20398 #: ../fish/guestfish.pod:235
20399 msgid "B<--format>"
20403 #: ../fish/guestfish.pod:237 ../fuse/guestmount.pod:129
20405 "The default for the I<-a> option is to auto-detect the format of the disk "
20406 "image. Using this forces the disk format for I<-a> options which follow on "
20407 "the command line. Using I<--format> with no argument switches back to auto-"
20408 "detection for subsequent I<-a> options."
20412 #: ../fish/guestfish.pod:244
20415 " guestfish --format=raw -a disk.img\n"
20420 #: ../fish/guestfish.pod:246
20421 msgid "forces raw format (no auto-detection) for C<disk.img>."
20425 #: ../fish/guestfish.pod:248
20428 " guestfish --format=raw -a disk.img --format -a another.img\n"
20433 #: ../fish/guestfish.pod:250
20435 "forces raw format (no auto-detection) for C<disk.img> and reverts to auto-"
20436 "detection for C<another.img>."
20440 #: ../fish/guestfish.pod:253
20442 "If you have untrusted raw-format guest disk images, you should use this "
20443 "option to specify the disk format. This avoids a possible security problem "
20444 "with malicious guests (CVE-2010-3851). See also L</add-drive-opts>."
20448 #: ../fish/guestfish.pod:258
20453 #: ../fish/guestfish.pod:260
20454 msgid "B<--inspector>"
20458 #: ../fish/guestfish.pod:262 ../fuse/guestmount.pod:149
20460 "Using L<virt-inspector(1)> code, inspect the disks looking for an operating "
20461 "system and mount filesystems as they would be mounted on the real virtual "
20466 #: ../fish/guestfish.pod:266
20467 msgid "Typical usage is either:"
20471 #: ../fish/guestfish.pod:268
20474 " guestfish -d myguest -i\n"
20479 #: ../fish/guestfish.pod:270
20480 msgid "(for an inactive libvirt domain called I<myguest>), or:"
20484 #: ../fish/guestfish.pod:272
20487 " guestfish --ro -d myguest -i\n"
20492 #: ../fish/guestfish.pod:274
20493 msgid "(for active domains, readonly), or specify the block device directly:"
20497 #: ../fish/guestfish.pod:276
20500 " guestfish --rw -a /dev/Guests/MyGuest -i\n"
20505 #: ../fish/guestfish.pod:278
20507 "Note that the command line syntax changed slightly over older versions of "
20508 "guestfish. You can still use the old syntax:"
20512 #: ../fish/guestfish.pod:281
20515 " guestfish [--ro] -i disk.img\n"
20520 #: ../fish/guestfish.pod:283
20523 " guestfish [--ro] -i libvirt-domain\n"
20528 #: ../fish/guestfish.pod:285
20530 "Using this flag is mostly equivalent to using the C<inspect-os> command and "
20531 "then using other commands to mount the filesystems that were found."
20535 #: ../fish/guestfish.pod:289 ../fuse/guestmount.pod:153
20536 msgid "B<--keys-from-stdin>"
20540 #: ../fish/guestfish.pod:291 ../fuse/guestmount.pod:155
20542 "Read key or passphrase parameters from stdin. The default is to try to read "
20543 "passphrases from the user by opening C</dev/tty>."
20547 #: ../fish/guestfish.pod:294
20548 msgid "B<--listen>"
20552 #: ../fish/guestfish.pod:296
20554 "Fork into the background and listen for remote commands. See section L</"
20555 "REMOTE CONTROL GUESTFISH OVER A SOCKET> below."
20559 #: ../fish/guestfish.pod:299 ../fuse/guestmount.pod:158
20564 #: ../fish/guestfish.pod:301 ../fuse/guestmount.pod:160
20566 "Connect to a live virtual machine. (Experimental, see L<guestfs(3)/"
20567 "ATTACHING TO RUNNING DAEMONS>)."
20571 #: ../fish/guestfish.pod:304 ../fuse/guestmount.pod:163
20572 msgid "B<-m dev[:mountpoint[:options]]>"
20576 #: ../fish/guestfish.pod:306 ../fuse/guestmount.pod:165
20577 msgid "B<--mount dev[:mountpoint[:options]]>"
20581 #: ../fish/guestfish.pod:308
20582 msgid "Mount the named partition or logical volume on the given mountpoint."
20586 #: ../fish/guestfish.pod:310
20587 msgid "If the mountpoint is omitted, it defaults to C</>."
20591 #: ../fish/guestfish.pod:312
20592 msgid "You have to mount something on C</> before most commands will work."
20596 #: ../fish/guestfish.pod:314
20598 "If any I<-m> or I<--mount> options are given, the guest is automatically "
20603 #: ../fish/guestfish.pod:317
20605 "If you don't know what filesystems a disk image contains, you can either run "
20606 "guestfish without this option, then list the partitions, filesystems and LVs "
20607 "available (see L</list-partitions>, L</list-filesystems> and L</lvs> "
20608 "commands), or you can use the L<virt-filesystems(1)> program."
20612 #: ../fish/guestfish.pod:323 ../fuse/guestmount.pod:173
20614 "The third (and rarely used) part of the mount parameter is the list of mount "
20615 "options used to mount the underlying filesystem. If this is not given, then "
20616 "the mount options are either the empty string or C<ro> (the latter if the "
20617 "I<--ro> flag is used). By specifying the mount options, you override this "
20618 "default choice. Probably the only time you would use this is to enable ACLs "
20619 "and/or extended attributes if the filesystem can support them:"
20623 #: ../fish/guestfish.pod:331 ../fuse/guestmount.pod:181
20626 " -m /dev/sda1:/:acl,user_xattr\n"
20631 #: ../fish/guestfish.pod:333
20632 msgid "Using this flag is equivalent to using the C<mount-options> command."
20636 #: ../fish/guestfish.pod:335
20641 #: ../fish/guestfish.pod:337
20642 msgid "B<--no-sync>"
20646 #: ../fish/guestfish.pod:339
20648 "Disable autosync. This is enabled by default. See the discussion of "
20649 "autosync in the L<guestfs(3)> manpage."
20653 #: ../fish/guestfish.pod:342
20658 #: ../fish/guestfish.pod:344
20659 msgid "B<--new type>"
20663 #: ../fish/guestfish.pod:346
20668 #: ../fish/guestfish.pod:348
20670 "Prepare a fresh disk image formatted as \"type\". This is an alternative to "
20671 "the I<-a> option: whereas I<-a> adds an existing disk, I<-N> creates a "
20672 "preformatted disk with a filesystem and adds it. See L</PREPARED DISK "
20677 #: ../fish/guestfish.pod:353
20678 msgid "B<--progress-bars>"
20682 #: ../fish/guestfish.pod:355
20683 msgid "Enable progress bars, even when guestfish is used non-interactively."
20687 #: ../fish/guestfish.pod:357
20689 "Progress bars are enabled by default when guestfish is used as an "
20690 "interactive shell."
20694 #: ../fish/guestfish.pod:360
20695 msgid "B<--no-progress-bars>"
20699 #: ../fish/guestfish.pod:362
20700 msgid "Disable progress bars."
20704 #: ../fish/guestfish.pod:364
20705 msgid "B<--remote[=pid]>"
20709 #: ../fish/guestfish.pod:366
20711 "Send remote commands to C<$GUESTFISH_PID> or C<pid>. See section L</REMOTE "
20712 "CONTROL GUESTFISH OVER A SOCKET> below."
20716 #: ../fish/guestfish.pod:369
20721 #: ../fish/guestfish.pod:371
20726 #: ../fish/guestfish.pod:373
20728 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
20729 "mounts are done read-only."
20733 #: ../fish/guestfish.pod:376
20735 "The option must always be used if the disk image or virtual machine might be "
20736 "running, and is generally recommended in cases where you don't need write "
20737 "access to the disk."
20741 #: ../fish/guestfish.pod:380
20743 "Note that prepared disk images created with I<-N> are not affected by this "
20744 "option. Also commands like C<add> are not affected - you have to specify "
20745 "the C<readonly:true> option explicitly if you need it."
20749 #: ../fish/guestfish.pod:384
20750 msgid "See also L</OPENING DISKS FOR READ AND WRITE> below."
20754 #: ../fish/guestfish.pod:386 ../fuse/guestmount.pod:237
20755 msgid "B<--selinux>"
20759 #: ../fish/guestfish.pod:388
20760 msgid "Enable SELinux support for the guest. See L<guestfs(3)/SELINUX>."
20764 #: ../fish/guestfish.pod:390
20769 #: ../fish/guestfish.pod:392
20770 msgid "B<--verbose>"
20774 #: ../fish/guestfish.pod:394
20776 "Enable very verbose messages. This is particularly useful if you find a bug."
20780 #: ../fish/guestfish.pod:397
20785 #: ../fish/guestfish.pod:399 ../tools/virt-win-reg.pl:112
20786 #: ../tools/virt-list-filesystems.pl:69 ../tools/virt-tar.pl:119
20787 #: ../tools/virt-make-fs.pl:169 ../tools/virt-list-partitions.pl:70
20788 msgid "B<--version>"
20792 #: ../fish/guestfish.pod:401
20793 msgid "Display the guestfish / libguestfs version number and exit."
20797 #: ../fish/guestfish.pod:403
20802 #: ../fish/guestfish.pod:405
20807 #: ../fish/guestfish.pod:407 ../fuse/guestmount.pod:251
20809 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
20810 "mounts are done read-write."
20814 #: ../fish/guestfish.pod:410
20815 msgid "See L</OPENING DISKS FOR READ AND WRITE> below."
20819 #: ../fish/guestfish.pod:412
20824 #: ../fish/guestfish.pod:414
20825 msgid "Echo each command before executing it."
20829 #: ../fish/guestfish.pod:418
20830 msgid "COMMANDS ON COMMAND LINE"
20834 #: ../fish/guestfish.pod:420
20836 "Any additional (non-option) arguments are treated as commands to execute."
20840 #: ../fish/guestfish.pod:423
20842 "Commands to execute should be separated by a colon (C<:>), where the colon "
20843 "is a separate parameter. Thus:"
20847 #: ../fish/guestfish.pod:426
20850 " guestfish cmd [args...] : cmd [args...] : cmd [args...] ...\n"
20855 #: ../fish/guestfish.pod:428
20857 "If there are no additional arguments, then we enter a shell, either an "
20858 "interactive shell with a prompt (if the input is a terminal) or a non-"
20859 "interactive shell."
20863 #: ../fish/guestfish.pod:432
20865 "In either command line mode or non-interactive shell, the first command that "
20866 "gives an error causes the whole shell to exit. In interactive mode (with a "
20867 "prompt) if a command fails, you can continue to enter commands."
20871 #: ../fish/guestfish.pod:437
20872 msgid "USING launch (OR run)"
20876 #: ../fish/guestfish.pod:439
20878 "As with L<guestfs(3)>, you must first configure your guest by adding disks, "
20879 "then launch it, then mount any disks you need, and finally issue actions/"
20880 "commands. So the general order of the day is:"
20884 #: ../fish/guestfish.pod:447
20885 msgid "add or -a/--add"
20889 #: ../fish/guestfish.pod:451
20890 msgid "launch (aka run)"
20894 #: ../fish/guestfish.pod:455
20895 msgid "mount or -m/--mount"
20899 #: ../fish/guestfish.pod:459
20900 msgid "any other commands"
20904 #: ../fish/guestfish.pod:463
20906 "C<run> is a synonym for C<launch>. You must C<launch> (or C<run>) your "
20907 "guest before mounting or performing any other commands."
20911 #: ../fish/guestfish.pod:466
20913 "The only exception is that if any of the I<-i>, I<-m>, I<--mount>, I<-N> or "
20914 "I<--new> options were given then C<run> is done automatically, simply "
20915 "because guestfish can't perform the action you asked for without doing this."
20919 #: ../fish/guestfish.pod:471
20920 msgid "OPENING DISKS FOR READ AND WRITE"
20924 #: ../fish/guestfish.pod:473
20926 "The guestfish, L<guestmount(1)> and L<virt-rescue(1)> options I<--ro> and "
20927 "I<--rw> affect whether the other command line options I<-a>, I<-c>, I<-d>, "
20928 "I<-i> and I<-m> open disk images read-only or for writing."
20932 #: ../fish/guestfish.pod:478
20934 "In libguestfs E<le> 1.10, guestfish, guestmount and virt-rescue defaulted to "
20935 "opening disk images supplied on the command line for write. To open a disk "
20936 "image read-only you have to do I<-a image --ro>."
20940 #: ../fish/guestfish.pod:482
20942 "This matters: If you accidentally open a live VM disk image writable then "
20943 "you will cause irreversible disk corruption."
20947 #: ../fish/guestfish.pod:485
20949 "By libguestfs 1.12 we intend to change the default the other way. Disk "
20950 "images will be opened read-only. You will have to either specify "
20951 "I<guestfish --rw>, I<guestmount --rw>, I<virt-rescue --rw>, or change the "
20952 "configuration file C</etc/libguestfs-tools.conf> in order to get write "
20953 "access for disk images specified by those other command line options."
20957 #: ../fish/guestfish.pod:492
20959 "This version of guestfish, guestmount and virt-rescue has a I<--rw> option "
20960 "which does nothing (it is already the default). However it is highly "
20961 "recommended that you use this option to indicate that you need write access, "
20962 "and prepare your scripts for the day when this option will be required for "
20967 #: ../fish/guestfish.pod:498
20969 "B<Note:> This does I<not> affect commands like L</add> and L</mount>, or any "
20970 "other libguestfs program apart from guestfish and guestmount."
20974 #: ../fish/guestfish.pod:501
20979 #: ../fish/guestfish.pod:503
20981 "You can quote ordinary parameters using either single or double quotes. For "
20986 #: ../fish/guestfish.pod:506
20989 " add \"file with a space.img\"\n"
20994 #: ../fish/guestfish.pod:508
20997 " rm '/file name'\n"
21002 #: ../fish/guestfish.pod:510
21010 #: ../fish/guestfish.pod:512
21012 "A few commands require a list of strings to be passed. For these, use a "
21013 "whitespace-separated list, enclosed in quotes. Strings containing "
21014 "whitespace to be passed through must be enclosed in single quotes. A "
21015 "literal single quote must be escaped with a backslash."
21019 #: ../fish/guestfish.pod:517
21022 " vgcreate VG \"/dev/sda1 /dev/sdb1\"\n"
21023 " command \"/bin/echo 'foo bar'\"\n"
21024 " command \"/bin/echo \\'foo\\'\"\n"
21029 #: ../fish/guestfish.pod:521
21030 msgid "OPTIONAL ARGUMENTS"
21034 #: ../fish/guestfish.pod:523
21036 "Some commands take optional arguments. These arguments appear in this "
21037 "documentation as C<[argname:..]>. You can use them as in these examples:"
21041 #: ../fish/guestfish.pod:527
21044 " add-drive-opts filename\n"
21049 #: ../fish/guestfish.pod:529
21052 " add-drive-opts filename readonly:true\n"
21057 #: ../fish/guestfish.pod:531
21060 " add-drive-opts filename format:qcow2 readonly:false\n"
21065 #: ../fish/guestfish.pod:533
21067 "Each optional argument can appear at most once. All optional arguments must "
21068 "appear after the required ones."
21072 #: ../fish/guestfish.pod:536
21077 #: ../fish/guestfish.pod:538
21079 "This section applies to all commands which can take integers as parameters."
21083 #: ../fish/guestfish.pod:541
21084 msgid "SIZE SUFFIX"
21088 #: ../fish/guestfish.pod:543
21090 "When the command takes a parameter measured in bytes, you can use one of the "
21091 "following suffixes to specify kilobytes, megabytes and larger sizes:"
21095 #: ../fish/guestfish.pod:549
21096 msgid "B<k> or B<K> or B<KiB>"
21100 #: ../fish/guestfish.pod:551
21101 msgid "The size in kilobytes (multiplied by 1024)."
21105 #: ../fish/guestfish.pod:553
21110 #: ../fish/guestfish.pod:555
21111 msgid "The size in SI 1000 byte units."
21115 #: ../fish/guestfish.pod:557
21116 msgid "B<M> or B<MiB>"
21120 #: ../fish/guestfish.pod:559
21121 msgid "The size in megabytes (multiplied by 1048576)."
21125 #: ../fish/guestfish.pod:561
21130 #: ../fish/guestfish.pod:563
21131 msgid "The size in SI 1000000 byte units."
21135 #: ../fish/guestfish.pod:565
21136 msgid "B<G> or B<GiB>"
21140 #: ../fish/guestfish.pod:567
21141 msgid "The size in gigabytes (multiplied by 2**30)."
21145 #: ../fish/guestfish.pod:569
21150 #: ../fish/guestfish.pod:571
21151 msgid "The size in SI 10**9 byte units."
21155 #: ../fish/guestfish.pod:573
21156 msgid "B<T> or B<TiB>"
21160 #: ../fish/guestfish.pod:575
21161 msgid "The size in terabytes (multiplied by 2**40)."
21165 #: ../fish/guestfish.pod:577
21170 #: ../fish/guestfish.pod:579
21171 msgid "The size in SI 10**12 byte units."
21175 #: ../fish/guestfish.pod:581
21176 msgid "B<P> or B<PiB>"
21180 #: ../fish/guestfish.pod:583
21181 msgid "The size in petabytes (multiplied by 2**50)."
21185 #: ../fish/guestfish.pod:585
21190 #: ../fish/guestfish.pod:587
21191 msgid "The size in SI 10**15 byte units."
21195 #: ../fish/guestfish.pod:589
21196 msgid "B<E> or B<EiB>"
21200 #: ../fish/guestfish.pod:591
21201 msgid "The size in exabytes (multiplied by 2**60)."
21205 #: ../fish/guestfish.pod:593
21210 #: ../fish/guestfish.pod:595
21211 msgid "The size in SI 10**18 byte units."
21215 #: ../fish/guestfish.pod:597
21216 msgid "B<Z> or B<ZiB>"
21220 #: ../fish/guestfish.pod:599
21221 msgid "The size in zettabytes (multiplied by 2**70)."
21225 #: ../fish/guestfish.pod:601
21230 #: ../fish/guestfish.pod:603
21231 msgid "The size in SI 10**21 byte units."
21235 #: ../fish/guestfish.pod:605
21236 msgid "B<Y> or B<YiB>"
21240 #: ../fish/guestfish.pod:607
21241 msgid "The size in yottabytes (multiplied by 2**80)."
21245 #: ../fish/guestfish.pod:609
21250 #: ../fish/guestfish.pod:611
21251 msgid "The size in SI 10**24 byte units."
21255 #: ../fish/guestfish.pod:617
21258 " truncate-size /file 1G\n"
21263 #: ../fish/guestfish.pod:619
21264 msgid "would truncate the file to 1 gigabyte."
21268 #: ../fish/guestfish.pod:621
21270 "Be careful because a few commands take sizes in kilobytes or megabytes (eg. "
21271 "the parameter to L</memsize> is specified in megabytes already). Adding a "
21272 "suffix will probably not do what you expect."
21276 #: ../fish/guestfish.pod:625
21277 msgid "OCTAL AND HEXADECIMAL NUMBERS"
21281 #: ../fish/guestfish.pod:627
21283 "For specifying the radix (base) use the C convention: C<0> to prefix an "
21284 "octal number or C<0x> to prefix a hexadecimal number. For example:"
21288 #: ../fish/guestfish.pod:630
21291 " 1234 decimal number 1234\n"
21292 " 02322 octal number, equivalent to decimal 1234\n"
21293 " 0x4d2 hexadecimal number, equivalent to decimal 1234\n"
21298 #: ../fish/guestfish.pod:634
21300 "When using the C<chmod> command, you almost always want to specify an octal "
21301 "number for the mode, and you must prefix it with C<0> (unlike the Unix "
21302 "L<chmod(1)> program):"
21306 #: ../fish/guestfish.pod:638
21309 " chmod 0777 /public # OK\n"
21310 " chmod 777 /public # WRONG! This is mode 777 decimal = 01411 octal.\n"
21315 #: ../fish/guestfish.pod:641
21317 "Commands that return numbers usually print them in decimal, but some "
21318 "commands print numbers in other radices (eg. C<umask> prints the mode in "
21319 "octal, preceeded by C<0>)."
21323 #: ../fish/guestfish.pod:645
21324 msgid "WILDCARDS AND GLOBBING"
21328 #: ../fish/guestfish.pod:647
21330 "Neither guestfish nor the underlying guestfs API performs wildcard expansion "
21331 "(globbing) by default. So for example the following will not do what you "
21336 #: ../fish/guestfish.pod:651
21344 #: ../fish/guestfish.pod:653
21346 "Assuming you don't have a directory called literally C</home/*> then the "
21347 "above command will return an error."
21351 #: ../fish/guestfish.pod:656
21352 msgid "To perform wildcard expansion, use the C<glob> command."
21356 #: ../fish/guestfish.pod:658
21359 " glob rm-rf /home/*\n"
21364 #: ../fish/guestfish.pod:660
21366 "runs C<rm-rf> on each path that matches (ie. potentially running the command "
21367 "many times), equivalent to:"
21371 #: ../fish/guestfish.pod:663
21374 " rm-rf /home/jim\n"
21375 " rm-rf /home/joe\n"
21376 " rm-rf /home/mary\n"
21381 #: ../fish/guestfish.pod:667
21382 msgid "C<glob> only works on simple guest paths and not on device names."
21386 #: ../fish/guestfish.pod:669
21388 "If you have several parameters, each containing a wildcard, then glob will "
21389 "perform a Cartesian product."
21393 #: ../fish/guestfish.pod:672
21398 #: ../fish/guestfish.pod:674
21400 "Any line which starts with a I<#> character is treated as a comment and "
21401 "ignored. The I<#> can optionally be preceeded by whitespace, but B<not> by "
21402 "a command. For example:"
21406 #: ../fish/guestfish.pod:678
21409 " # this is a comment\n"
21410 " # this is a comment\n"
21411 " foo # NOT a comment\n"
21416 #: ../fish/guestfish.pod:682
21417 msgid "Blank lines are also ignored."
21421 #: ../fish/guestfish.pod:684
21422 msgid "RUNNING COMMANDS LOCALLY"
21426 #: ../fish/guestfish.pod:686
21428 "Any line which starts with a I<!> character is treated as a command sent to "
21429 "the local shell (C</bin/sh> or whatever L<system(3)> uses). For example:"
21433 #: ../fish/guestfish.pod:690
21437 " tgz-out /remote local/remote-data.tar.gz\n"
21442 #: ../fish/guestfish.pod:693
21444 "will create a directory C<local> on the host, and then export the contents "
21445 "of C</remote> on the mounted filesystem to C<local/remote-data.tar.gz>. "
21446 "(See C<tgz-out>)."
21450 #: ../fish/guestfish.pod:697
21452 "To change the local directory, use the C<lcd> command. C<!cd> will have no "
21453 "effect, due to the way that subprocesses work in Unix."
21457 #: ../fish/guestfish.pod:700
21458 msgid "LOCAL COMMANDS WITH INLINE EXECUTION"
21462 #: ../fish/guestfish.pod:702
21464 "If a line starts with I<E<lt>!> then the shell command is executed (as for "
21465 "I<!>), but subsequently any output (stdout) of the shell command is parsed "
21466 "and executed as guestfish commands."
21470 #: ../fish/guestfish.pod:706
21472 "Thus you can use shell script to construct arbitrary guestfish commands "
21473 "which are then parsed by guestfish."
21477 #: ../fish/guestfish.pod:709
21479 "For example it is tedious to create a sequence of files (eg. C</foo.1> "
21480 "through C</foo.100>) using guestfish commands alone. However this is simple "
21481 "if we use a shell script to create the guestfish commands for us:"
21485 #: ../fish/guestfish.pod:714
21488 " <! for n in `seq 1 100`; do echo write /foo.$n $n; done\n"
21493 #: ../fish/guestfish.pod:716
21494 msgid "or with names like C</foo.001>:"
21498 #: ../fish/guestfish.pod:718
21501 " <! for n in `seq 1 100`; do printf \"write /foo.%03d %d\\n\" $n $n; done\n"
21506 #: ../fish/guestfish.pod:720
21508 "When using guestfish interactively it can be helpful to just run the shell "
21509 "script first (ie. remove the initial C<E<lt>> character so it is just an "
21510 "ordinary I<!> local command), see what guestfish commands it would run, and "
21511 "when you are happy with those prepend the C<E<lt>> character to run the "
21512 "guestfish commands for real."
21516 #: ../fish/guestfish.pod:726
21521 #: ../fish/guestfish.pod:728
21523 "Use C<command E<lt>spaceE<gt> | command> to pipe the output of the first "
21524 "command (a guestfish command) to the second command (any host command). For "
21529 #: ../fish/guestfish.pod:732
21532 " cat /etc/passwd | awk -F: '$3 == 0 { print }'\n"
21537 #: ../fish/guestfish.pod:734
21539 "(where C<cat> is the guestfish cat command, but C<awk> is the host awk "
21540 "program). The above command would list all accounts in the guest filesystem "
21541 "which have UID 0, ie. root accounts including backdoors. Other examples:"
21545 #: ../fish/guestfish.pod:739
21548 " hexdump /bin/ls | head\n"
21549 " list-devices | tail -1\n"
21550 " tgz-out / - | tar ztf -\n"
21555 #: ../fish/guestfish.pod:743
21557 "The space before the pipe symbol is required, any space after the pipe "
21558 "symbol is optional. Everything after the pipe symbol is just passed "
21559 "straight to the host shell, so it can contain redirections, globs and "
21560 "anything else that makes sense on the host side."
21564 #: ../fish/guestfish.pod:748
21566 "To use a literal argument which begins with a pipe symbol, you have to quote "
21571 #: ../fish/guestfish.pod:751
21579 #: ../fish/guestfish.pod:753
21580 msgid "HOME DIRECTORIES"
21584 #: ../fish/guestfish.pod:755
21586 "If a parameter starts with the character C<~> then the tilde may be expanded "
21587 "as a home directory path (either C<~> for the current user's home directory, "
21588 "or C<~user> for another user)."
21592 #: ../fish/guestfish.pod:759
21594 "Note that home directory expansion happens for users known I<on the host>, "
21595 "not in the guest filesystem."
21599 #: ../fish/guestfish.pod:762
21601 "To use a literal argument which begins with a tilde, you have to quote it, "
21606 #: ../fish/guestfish.pod:765
21614 #: ../fish/guestfish.pod:769
21616 "Libguestfs has some support for Linux guests encrypted according to the "
21617 "Linux Unified Key Setup (LUKS) standard, which includes nearly all whole "
21618 "disk encryption systems used by modern Linux guests. Currently only LVM-on-"
21619 "LUKS is supported."
21623 #: ../fish/guestfish.pod:774
21624 msgid "Identify encrypted block devices and partitions using L</vfs-type>:"
21628 #: ../fish/guestfish.pod:776
21631 " ><fs> vfs-type /dev/sda2\n"
21637 #: ../fish/guestfish.pod:779
21639 "Then open those devices using L</luks-open>. This creates a device-mapper "
21640 "device called C</dev/mapper/luksdev>."
21644 #: ../fish/guestfish.pod:782
21647 " ><fs> luks-open /dev/sda2 luksdev\n"
21648 " Enter key or passphrase (\"key\"): <enter the passphrase>\n"
21653 #: ../fish/guestfish.pod:785
21655 "Finally you have to tell LVM to scan for volume groups on the newly created "
21660 #: ../fish/guestfish.pod:788
21664 " vg-activate-all true\n"
21669 #: ../fish/guestfish.pod:791
21670 msgid "The logical volume(s) can now be mounted in the usual way."
21674 #: ../fish/guestfish.pod:793
21676 "Before closing a LUKS device you must unmount any logical volumes on it and "
21677 "deactivate the volume groups by calling C<vg-activate false VG> on each "
21678 "one. Then you can close the mapper device:"
21682 #: ../fish/guestfish.pod:797
21685 " vg-activate false /dev/VG\n"
21686 " luks-close /dev/mapper/luksdev\n"
21691 #: ../fish/guestfish.pod:800
21692 msgid "WINDOWS PATHS"
21696 #: ../fish/guestfish.pod:802
21698 "If a path is prefixed with C<win:> then you can use Windows-style drive "
21699 "letters and paths (with some limitations). The following commands are "
21704 #: ../fish/guestfish.pod:806
21707 " file /WINDOWS/system32/config/system.LOG\n"
21712 #: ../fish/guestfish.pod:808
21715 " file win:\\windows\\system32\\config\\system.log\n"
21720 #: ../fish/guestfish.pod:810
21723 " file WIN:C:\\Windows\\SYSTEM32\\CONFIG\\SYSTEM.LOG\n"
21728 #: ../fish/guestfish.pod:812
21730 "The parameter is rewritten \"behind the scenes\" by looking up the position "
21731 "where the drive is mounted, prepending that to the path, changing all "
21732 "backslash characters to forward slash, then resolving the result using L</"
21733 "case-sensitive-path>. For example if the E: drive was mounted on C</e> then "
21734 "the parameter might be rewritten like this:"
21738 #: ../fish/guestfish.pod:818
21741 " win:e:\\foo\\bar => /e/FOO/bar\n"
21746 #: ../fish/guestfish.pod:820
21747 msgid "This only works in argument positions that expect a path."
21751 #: ../fish/guestfish.pod:822
21752 msgid "UPLOADING AND DOWNLOADING FILES"
21756 #: ../fish/guestfish.pod:824
21758 "For commands such as C<upload>, C<download>, C<tar-in>, C<tar-out> and "
21759 "others which upload from or download to a local file, you can use the "
21760 "special filename C<-> to mean \"from stdin\" or \"to stdout\". For example:"
21764 #: ../fish/guestfish.pod:828
21772 #: ../fish/guestfish.pod:830
21774 "reads stdin and creates from that a file C</foo> in the disk image, and:"
21778 #: ../fish/guestfish.pod:833
21781 " tar-out /etc - | tar tf -\n"
21786 #: ../fish/guestfish.pod:835
21788 "writes the tarball to stdout and then pipes that into the external \"tar\" "
21789 "command (see L</PIPES>)."
21793 #: ../fish/guestfish.pod:838
21795 "When using C<-> to read from stdin, the input is read up to the end of "
21796 "stdin. You can also use a special \"heredoc\"-like syntax to read up to "
21797 "some arbitrary end marker:"
21801 #: ../fish/guestfish.pod:842
21804 " upload -<<END /foo\n"
21813 #: ../fish/guestfish.pod:848
21815 "Any string of characters can be used instead of C<END>. The end marker must "
21816 "appear on a line of its own, without any preceeding or following characters "
21817 "(not even spaces)."
21821 #: ../fish/guestfish.pod:852
21823 "Note that the C<-E<lt>E<lt>> syntax only applies to parameters used to "
21824 "upload local files (so-called \"FileIn\" parameters in the generator)."
21828 #: ../fish/guestfish.pod:855
21829 msgid "EXIT ON ERROR BEHAVIOUR"
21833 #: ../fish/guestfish.pod:857
21835 "By default, guestfish will ignore any errors when in interactive mode (ie. "
21836 "taking commands from a human over a tty), and will exit on the first error "
21837 "in non-interactive mode (scripts, commands given on the command line)."
21841 #: ../fish/guestfish.pod:862
21843 "If you prefix a command with a I<-> character, then that command will not "
21844 "cause guestfish to exit, even if that (one) command returns an error."
21848 #: ../fish/guestfish.pod:866
21849 msgid "REMOTE CONTROL GUESTFISH OVER A SOCKET"
21853 #: ../fish/guestfish.pod:868
21855 "Guestfish can be remote-controlled over a socket. This is useful "
21856 "particularly in shell scripts where you want to make several different "
21857 "changes to a filesystem, but you don't want the overhead of starting up a "
21858 "guestfish process each time."
21862 #: ../fish/guestfish.pod:873
21863 msgid "Start a guestfish server process using:"
21867 #: ../fish/guestfish.pod:875
21870 " eval \"`guestfish --listen`\"\n"
21875 #: ../fish/guestfish.pod:877
21876 msgid "and then send it commands by doing:"
21880 #: ../fish/guestfish.pod:879
21883 " guestfish --remote cmd [...]\n"
21888 #: ../fish/guestfish.pod:881
21889 msgid "To cause the server to exit, send it the exit command:"
21893 #: ../fish/guestfish.pod:883
21896 " guestfish --remote exit\n"
21901 #: ../fish/guestfish.pod:885
21903 "Note that the server will normally exit if there is an error in a command. "
21904 "You can change this in the usual way. See section L</EXIT ON ERROR "
21909 #: ../fish/guestfish.pod:889
21910 msgid "CONTROLLING MULTIPLE GUESTFISH PROCESSES"
21914 #: ../fish/guestfish.pod:891
21916 "The C<eval> statement sets the environment variable C<$GUESTFISH_PID>, which "
21917 "is how the I<--remote> option knows where to send the commands. You can "
21918 "have several guestfish listener processes running using:"
21922 #: ../fish/guestfish.pod:895
21925 " eval \"`guestfish --listen`\"\n"
21926 " pid1=$GUESTFISH_PID\n"
21927 " eval \"`guestfish --listen`\"\n"
21928 " pid2=$GUESTFISH_PID\n"
21930 " guestfish --remote=$pid1 cmd\n"
21931 " guestfish --remote=$pid2 cmd\n"
21936 #: ../fish/guestfish.pod:903
21937 msgid "REMOTE CONTROL AND CSH"
21941 #: ../fish/guestfish.pod:905
21943 "When using csh-like shells (csh, tcsh etc) you have to add the I<--csh> "
21948 #: ../fish/guestfish.pod:908
21951 " eval \"`guestfish --listen --csh`\"\n"
21956 #: ../fish/guestfish.pod:910
21957 msgid "REMOTE CONTROL DETAILS"
21961 #: ../fish/guestfish.pod:912
21963 "Remote control happens over a Unix domain socket called C</tmp/.guestfish-"
21964 "$UID/socket-$PID>, where C<$UID> is the effective user ID of the process, "
21965 "and C<$PID> is the process ID of the server."
21969 #: ../fish/guestfish.pod:916
21970 msgid "Guestfish client and server versions must match exactly."
21974 #: ../fish/guestfish.pod:918
21975 msgid "PREPARED DISK IMAGES"
21979 #: ../fish/guestfish.pod:920
21981 "Use the I<-N type> or I<--new type> parameter to select one of a set of "
21982 "preformatted disk images that guestfish can make for you to save typing. "
21983 "This is particularly useful for testing purposes. This option is used "
21984 "instead of the I<-a> option, and like I<-a> can appear multiple times (and "
21985 "can be mixed with I<-a>)."
21989 #: ../fish/guestfish.pod:926
21991 "The new disk is called C<test1.img> for the first I<-N>, C<test2.img> for "
21992 "the second and so on. Existing files in the current directory are "
21997 #: ../fish/guestfish.pod:930
21999 "The type briefly describes how the disk should be sized, partitioned, how "
22000 "filesystem(s) should be created, and how content should be added. "
22001 "Optionally the type can be followed by extra parameters, separated by C<:> "
22002 "(colon) characters. For example, I<-N fs> creates a default 100MB, sparsely-"
22003 "allocated disk, containing a single partition, with the partition formatted "
22004 "as ext2. I<-N fs:ext4:1G> is the same, but for an ext4 filesystem on a 1GB "
22009 #: ../fish/guestfish.pod:938
22010 msgid "To list the available types and any extra parameters they take, run:"
22014 #: ../fish/guestfish.pod:942
22016 "Note that the prepared filesystem is not mounted. You would usually have to "
22017 "use the C<mount /dev/sda1 /> command or add the I<-m /dev/sda1> option."
22021 #: ../fish/guestfish.pod:946
22023 "If any I<-N> or I<--new> options are given, the guest is automatically "
22028 #: ../fish/guestfish.pod:951
22029 msgid "Create a 100MB disk with an ext4-formatted partition:"
22033 #: ../fish/guestfish.pod:953
22036 " guestfish -N fs:ext4\n"
22041 #: ../fish/guestfish.pod:955
22042 msgid "Create a 32MB disk with a VFAT-formatted partition, and mount it:"
22046 #: ../fish/guestfish.pod:957
22049 " guestfish -N fs:vfat:32M -m /dev/sda1\n"
22054 #: ../fish/guestfish.pod:959
22055 msgid "Create a blank 200MB disk:"
22059 #: ../fish/guestfish.pod:961
22062 " guestfish -N disk:200M\n"
22067 #: ../fish/guestfish.pod:963
22068 msgid "PROGRESS BARS"
22072 #: ../fish/guestfish.pod:965
22074 "Some (not all) long-running commands send progress notification messages as "
22075 "they are running. Guestfish turns these messages into progress bars."
22079 #: ../fish/guestfish.pod:969
22081 "When a command that supports progress bars takes longer than two seconds to "
22082 "run, and if progress bars are enabled, then you will see one appearing below "
22087 #: ../fish/guestfish.pod:973
22090 " ><fs> copy-size /large-file /another-file 2048M\n"
22091 " / 10% [#####-----------------------------------------] 00:30\n"
22096 #: ../fish/guestfish.pod:976
22098 "The spinner on the left hand side moves round once for every progress "
22099 "notification received from the backend. This is a (reasonably) golden "
22100 "assurance that the command is \"doing something\" even if the progress bar "
22101 "is not moving, because the command is able to send the progress "
22102 "notifications. When the bar reaches 100% and the command finishes, the "
22103 "spinner disappears."
22107 #: ../fish/guestfish.pod:983
22109 "Progress bars are enabled by default when guestfish is used interactively. "
22110 "You can enable them even for non-interactive modes using I<--progress-bars>, "
22111 "and you can disable them completely using I<--no-progress-bars>."
22115 #: ../fish/guestfish.pod:988
22116 msgid "GUESTFISH COMMANDS"
22120 #: ../fish/guestfish.pod:990
22122 "The commands in this section are guestfish convenience commands, in other "
22123 "words, they are not part of the L<guestfs(3)> API."
22127 #: ../fish/guestfish.pod:993
22132 #: ../fish/guestfish.pod:995
22141 #: ../fish/guestfish.pod:998
22142 msgid "Without any parameter, this provides general help."
22146 #: ../fish/guestfish.pod:1000
22147 msgid "With a C<cmd> parameter, this displays detailed help for that command."
22151 #: ../fish/guestfish.pod:1002
22152 msgid "quit | exit"
22156 #: ../fish/guestfish.pod:1004
22157 msgid "This exits guestfish. You can also use C<^D> key."
22161 #: ../fish/guestfish.pod:1006
22162 msgid "@FISH_COMMANDS@"
22166 #: ../fish/guestfish.pod:1008
22171 #: ../fish/guestfish.pod:1012 ../test-tool/libguestfs-test-tool.pod:77
22176 #: ../fish/guestfish.pod:1014
22178 "guestfish returns 0 if the commands completed without error, or 1 if there "
22183 #: ../fish/guestfish.pod:1021
22188 #: ../fish/guestfish.pod:1023
22190 "The C<edit> command uses C<$EDITOR> as the editor. If not set, it uses "
22195 #: ../fish/guestfish.pod:1026
22196 msgid "GUESTFISH_DISPLAY_IMAGE"
22200 #: ../fish/guestfish.pod:1028
22202 "The C<display> command uses C<$GUESTFISH_DISPLAY_IMAGE> to display images. "
22203 "If not set, it uses L<display(1)>."
22207 #: ../fish/guestfish.pod:1031
22208 msgid "GUESTFISH_PID"
22212 #: ../fish/guestfish.pod:1033
22214 "Used with the I<--remote> option to specify the remote guestfish process to "
22215 "control. See section L</REMOTE CONTROL GUESTFISH OVER A SOCKET>."
22219 #: ../fish/guestfish.pod:1037
22224 #: ../fish/guestfish.pod:1039
22226 "The L</hexedit> command uses C<$HEXEDITOR> as the external hex editor. If "
22227 "not specified, the external L<hexedit(1)> program is used."
22231 #: ../fish/guestfish.pod:1043
22236 #: ../fish/guestfish.pod:1045
22238 "If compiled with GNU readline support, various files in the home directory "
22239 "can be used. See L</FILES>."
22243 #: ../fish/guestfish.pod:1054
22245 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
22246 "effect as using the B<-v> option."
22250 #: ../fish/guestfish.pod:1066
22252 "Set the path that guestfish uses to search for kernel and initrd.img. See "
22253 "the discussion of paths in L<guestfs(3)>."
22257 #: ../fish/guestfish.pod:1077
22258 msgid "Set C<LIBGUESTFS_TRACE=1> to enable command traces."
22262 #: ../fish/guestfish.pod:1079
22267 #: ../fish/guestfish.pod:1081
22269 "The C<more> command uses C<$PAGER> as the pager. If not set, it uses "
22274 #: ../fish/guestfish.pod:1097 ../fuse/guestmount.pod:264
22279 #: ../fish/guestfish.pod:1101 ../fuse/guestmount.pod:268
22280 msgid "$HOME/.libguestfs-tools.rc"
22284 #: ../fish/guestfish.pod:1103 ../fuse/guestmount.pod:270
22285 msgid "/etc/libguestfs-tools.conf"
22289 #: ../fish/guestfish.pod:1105 ../fuse/guestmount.pod:272
22291 "This configuration file controls the default read-only or read-write mode "
22292 "(I<--ro> or I<--rw>)."
22296 #: ../fish/guestfish.pod:1108
22297 msgid "See L</OPENING DISKS FOR READ AND WRITE>."
22301 #: ../fish/guestfish.pod:1110
22302 msgid "$HOME/.guestfish"
22306 #: ../fish/guestfish.pod:1112
22308 "If compiled with GNU readline support, then the command history is saved in "
22313 #: ../fish/guestfish.pod:1115
22314 msgid "$HOME/.inputrc"
22318 #: ../fish/guestfish.pod:1117
22319 msgid "/etc/inputrc"
22323 #: ../fish/guestfish.pod:1119
22325 "If compiled with GNU readline support, then these files can be used to "
22326 "configure readline. For further information, please see L<readline(3)/"
22327 "INITIALIZATION FILE>."
22331 #: ../fish/guestfish.pod:1123
22332 msgid "To write rules which only apply to guestfish, use:"
22336 #: ../fish/guestfish.pod:1125
22346 #: ../fish/guestfish.pod:1129
22348 "Variables that you can set in inputrc that change the behaviour of guestfish "
22349 "in useful ways include:"
22353 #: ../fish/guestfish.pod:1134
22354 msgid "completion-ignore-case (default: on)"
22358 #: ../fish/guestfish.pod:1136
22360 "By default, guestfish will ignore case when tab-completing paths on the "
22365 #: ../fish/guestfish.pod:1139
22368 " set completion-ignore-case off\n"
22373 #: ../fish/guestfish.pod:1141
22374 msgid "to make guestfish case sensitive."
22378 #: ../fish/guestfish.pod:1145
22383 #: ../fish/guestfish.pod:1147
22384 msgid "test2.img (etc)"
22388 #: ../fish/guestfish.pod:1149
22390 "When using the I<-N> or I<--new> option, the prepared disk or filesystem "
22391 "will be created in the file C<test1.img> in the current directory. The "
22392 "second use of I<-N> will use C<test2.img> and so on. Any existing file with "
22393 "the same name will be overwritten."
22397 #: ../fish/guestfish.pod:1158
22399 "L<guestfs(3)>, L<http://libguestfs.org/>, L<virt-cat(1)>, L<virt-copy-in(1)"
22400 ">, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, L<virt-filesystems(1)"
22401 ">, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, L<virt-list-partitions"
22402 "(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, L<virt-rescue(1)>, L<virt-resize(1)"
22403 ">, L<virt-tar(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<virt-win-reg(1)"
22404 ">, L<display(1)>, L<hexedit(1)>."
22408 #: ../fish/guestfish.pod:1189 ../test-tool/libguestfs-test-tool.pod:102
22409 #: ../fuse/guestmount.pod:299 ../tools/virt-win-reg.pl:778
22410 #: ../tools/virt-list-filesystems.pl:210 ../tools/virt-tar.pl:309
22411 #: ../tools/virt-make-fs.pl:572 ../tools/virt-list-partitions.pl:277
22413 "This program is free software; you can redistribute it and/or modify it "
22414 "under the terms of the GNU General Public License as published by the Free "
22415 "Software Foundation; either version 2 of the License, or (at your option) "
22416 "any later version."
22420 #: ../fish/guestfish.pod:1194 ../test-tool/libguestfs-test-tool.pod:107
22421 #: ../fuse/guestmount.pod:304 ../tools/virt-win-reg.pl:783
22422 #: ../tools/virt-list-filesystems.pl:215 ../tools/virt-tar.pl:314
22423 #: ../tools/virt-make-fs.pl:577 ../tools/virt-list-partitions.pl:282
22425 "This program is distributed in the hope that it will be useful, but WITHOUT "
22426 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
22427 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for "
22432 #: ../fish/guestfish.pod:1199 ../test-tool/libguestfs-test-tool.pod:112
22433 #: ../fuse/guestmount.pod:309 ../tools/virt-win-reg.pl:788
22434 #: ../tools/virt-list-filesystems.pl:220 ../tools/virt-tar.pl:319
22435 #: ../tools/virt-make-fs.pl:582 ../tools/virt-list-partitions.pl:287
22437 "You should have received a copy of the GNU General Public License along with "
22438 "this program; if not, write to the Free Software Foundation, Inc., 675 Mass "
22439 "Ave, Cambridge, MA 02139, USA."
22443 #: ../fish/guestfish-actions.pod:1
22448 #: ../fish/guestfish-actions.pod:3
22451 " add-cdrom filename\n"
22456 #: ../fish/guestfish-actions.pod:15
22458 "This call checks for the existence of C<filename>. This stops you from "
22459 "specifying other types of drive which are supported by qemu such as C<nbd:> "
22460 "and C<http:> URLs. To specify those, use the general L</config> call "
22465 #: ../fish/guestfish-actions.pod:22
22467 "If you just want to add an ISO file (often you use this as an efficient way "
22468 "to transfer large files into the guest), then you should probably use L</add-"
22469 "drive-ro> instead."
22473 #: ../fish/guestfish-actions.pod:35
22478 #: ../fish/guestfish-actions.pod:37
22483 #: ../fish/guestfish-actions.pod:39
22486 " add-domain dom [libvirturi:..] [readonly:..] [iface:..] [live:..] [allowuuid:..]\n"
22491 #: ../fish/guestfish-actions.pod:41
22493 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
22494 "It works by connecting to libvirt, requesting the domain and domain XML from "
22495 "libvirt, parsing it for disks, and calling L</add-drive-opts> on each one."
22499 #: ../fish/guestfish-actions.pod:76
22501 "The other optional parameters are passed directly through to L</add-drive-"
22506 #: ../fish/guestfish-actions.pod:79 ../fish/guestfish-actions.pod:143
22507 #: ../fish/guestfish-actions.pod:1937 ../fish/guestfish-actions.pod:3103
22508 #: ../fish/guestfish-actions.pod:3276 ../fish/guestfish-actions.pod:3411
22510 "This command has one or more optional arguments. See L</OPTIONAL ARGUMENTS>."
22514 #: ../fish/guestfish-actions.pod:81
22519 #: ../fish/guestfish-actions.pod:83
22522 " add-drive filename\n"
22527 #: ../fish/guestfish-actions.pod:85
22529 "This function is the equivalent of calling L</add-drive-opts> with no "
22530 "optional parameters, so the disk is added writable, with the format being "
22531 "detected automatically."
22535 #: ../fish/guestfish-actions.pod:89
22537 "Automatic detection of the format opens you up to a potential security hole "
22538 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
22539 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
22540 "you should think about replacing calls to this function with calls to L</add-"
22541 "drive-opts>, and specifying the format."
22545 #: ../fish/guestfish-actions.pod:96
22546 msgid "add-drive-opts"
22550 #: ../fish/guestfish-actions.pod:98
22555 #: ../fish/guestfish-actions.pod:100
22558 " add-drive-opts filename [readonly:..] [format:..] [iface:..]\n"
22563 #: ../fish/guestfish-actions.pod:127
22565 "This forces the image format. If you omit this (or use L</add-drive> or L</"
22566 "add-drive-ro>) then the format is automatically detected. Possible formats "
22567 "include C<raw> and C<qcow2>."
22571 #: ../fish/guestfish-actions.pod:138
22573 "This rarely-used option lets you emulate the behaviour of the deprecated L</"
22574 "add-drive-with-if> call (q.v.)"
22578 #: ../fish/guestfish-actions.pod:145
22579 msgid "add-drive-ro"
22583 #: ../fish/guestfish-actions.pod:147
22588 #: ../fish/guestfish-actions.pod:149
22591 " add-drive-ro filename\n"
22596 #: ../fish/guestfish-actions.pod:151
22598 "This function is the equivalent of calling L</add-drive-opts> with the "
22599 "optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the disk "
22600 "is added read-only, with the format being detected automatically."
22604 #: ../fish/guestfish-actions.pod:156
22605 msgid "add-drive-ro-with-if"
22609 #: ../fish/guestfish-actions.pod:158
22612 " add-drive-ro-with-if filename iface\n"
22617 #: ../fish/guestfish-actions.pod:160
22619 "This is the same as L</add-drive-ro> but it allows you to specify the QEMU "
22620 "interface emulation to use at run time."
22624 #: ../fish/guestfish-actions.pod:170
22625 msgid "add-drive-with-if"
22629 #: ../fish/guestfish-actions.pod:172
22632 " add-drive-with-if filename iface\n"
22637 #: ../fish/guestfish-actions.pod:174
22639 "This is the same as L</add-drive> but it allows you to specify the QEMU "
22640 "interface emulation to use at run time."
22644 #: ../fish/guestfish-actions.pod:184
22649 #: ../fish/guestfish-actions.pod:186
22652 " aug-clear augpath\n"
22657 #: ../fish/guestfish-actions.pod:191
22662 #: ../fish/guestfish-actions.pod:193
22670 #: ../fish/guestfish-actions.pod:195
22672 "Close the current Augeas handle and free up any resources used by it. After "
22673 "calling this, you have to call L</aug-init> again before you can use any "
22674 "other Augeas functions."
22678 #: ../fish/guestfish-actions.pod:200
22679 msgid "aug-defnode"
22683 #: ../fish/guestfish-actions.pod:202
22686 " aug-defnode name expr val\n"
22691 #: ../fish/guestfish-actions.pod:207
22693 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
22694 "calling L</aug-set> C<expr>, C<value>. C<name> will be the nodeset "
22695 "containing that single node."
22699 #: ../fish/guestfish-actions.pod:215
22704 #: ../fish/guestfish-actions.pod:217
22707 " aug-defvar name expr\n"
22712 #: ../fish/guestfish-actions.pod:226
22717 #: ../fish/guestfish-actions.pod:228
22720 " aug-get augpath\n"
22725 #: ../fish/guestfish-actions.pod:233
22730 #: ../fish/guestfish-actions.pod:235
22733 " aug-init root flags\n"
22738 #: ../fish/guestfish-actions.pod:241
22739 msgid "You must call this before using any other L</aug-*> commands."
22743 #: ../fish/guestfish-actions.pod:276
22744 msgid "Do not load the tree in L</aug-init>."
22748 #: ../fish/guestfish-actions.pod:280
22749 msgid "To close the handle, you can call L</aug-close>."
22753 #: ../fish/guestfish-actions.pod:284
22758 #: ../fish/guestfish-actions.pod:286
22761 " aug-insert augpath label true|false\n"
22766 #: ../fish/guestfish-actions.pod:296
22771 #: ../fish/guestfish-actions.pod:298
22779 #: ../fish/guestfish-actions.pod:305
22784 #: ../fish/guestfish-actions.pod:307
22787 " aug-ls augpath\n"
22792 #: ../fish/guestfish-actions.pod:309
22794 "This is just a shortcut for listing L</aug-match> C<path/*> and sorting the "
22795 "resulting nodes into alphabetical order."
22799 #: ../fish/guestfish-actions.pod:312
22804 #: ../fish/guestfish-actions.pod:314
22807 " aug-match augpath\n"
22812 #: ../fish/guestfish-actions.pod:320
22817 #: ../fish/guestfish-actions.pod:322
22820 " aug-mv src dest\n"
22825 #: ../fish/guestfish-actions.pod:327
22830 #: ../fish/guestfish-actions.pod:329
22833 " aug-rm augpath\n"
22838 #: ../fish/guestfish-actions.pod:335
22843 #: ../fish/guestfish-actions.pod:337
22851 #: ../fish/guestfish-actions.pod:341
22853 "The flags which were passed to L</aug-init> affect exactly how files are "
22858 #: ../fish/guestfish-actions.pod:344
22863 #: ../fish/guestfish-actions.pod:346
22866 " aug-set augpath val\n"
22871 #: ../fish/guestfish-actions.pod:350
22873 "In the Augeas API, it is possible to clear a node by setting the value to "
22874 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
22875 "this call. Instead you must use the L</aug-clear> call."
22879 #: ../fish/guestfish-actions.pod:355
22884 #: ../fish/guestfish-actions.pod:357
22887 " available 'groups ...'\n"
22892 #: ../fish/guestfish-actions.pod:363
22894 "The libguestfs groups, and the functions that those groups correspond to, "
22895 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
22896 "runtime by calling L</available-all-groups>."
22900 #: ../fish/guestfish-actions.pod:387
22901 msgid "You must call L</launch> before calling this function."
22905 #: ../fish/guestfish-actions.pod:409
22907 "This call was added in version C<1.0.80>. In previous versions of "
22908 "libguestfs all you could do would be to speculatively execute a command to "
22909 "find out if the daemon implemented it. See also L</version>."
22913 #: ../fish/guestfish-actions.pod:416
22914 msgid "available-all-groups"
22918 #: ../fish/guestfish-actions.pod:418
22921 " available-all-groups\n"
22926 #: ../fish/guestfish-actions.pod:420
22928 "This command returns a list of all optional groups that this daemon knows "
22929 "about. Note this returns both supported and unsupported groups. To find "
22930 "out which ones the daemon can actually support you have to call L</"
22931 "available> on each member of the returned list."
22935 #: ../fish/guestfish-actions.pod:426
22936 msgid "See also L</available> and L<guestfs(3)/AVAILABILITY>."
22940 #: ../fish/guestfish-actions.pod:428
22945 #: ../fish/guestfish-actions.pod:430
22948 " base64-in (base64file|-) filename\n"
22953 #: ../fish/guestfish-actions.pod:435 ../fish/guestfish-actions.pod:444
22954 #: ../fish/guestfish-actions.pod:668 ../fish/guestfish-actions.pod:837
22955 #: ../fish/guestfish-actions.pod:856 ../fish/guestfish-actions.pod:1230
22956 #: ../fish/guestfish-actions.pod:4606 ../fish/guestfish-actions.pod:4618
22957 #: ../fish/guestfish-actions.pod:4629 ../fish/guestfish-actions.pod:4640
22958 #: ../fish/guestfish-actions.pod:4692 ../fish/guestfish-actions.pod:4701
22959 #: ../fish/guestfish-actions.pod:4755 ../fish/guestfish-actions.pod:4778
22960 msgid "Use C<-> instead of a filename to read/write from stdin/stdout."
22964 #: ../fish/guestfish-actions.pod:437
22969 #: ../fish/guestfish-actions.pod:439
22972 " base64-out filename (base64file|-)\n"
22977 #: ../fish/guestfish-actions.pod:446
22978 msgid "blockdev-flushbufs"
22982 #: ../fish/guestfish-actions.pod:448
22985 " blockdev-flushbufs device\n"
22990 #: ../fish/guestfish-actions.pod:455
22991 msgid "blockdev-getbsz"
22995 #: ../fish/guestfish-actions.pod:457
22998 " blockdev-getbsz device\n"
23003 #: ../fish/guestfish-actions.pod:466
23004 msgid "blockdev-getro"
23008 #: ../fish/guestfish-actions.pod:468
23011 " blockdev-getro device\n"
23016 #: ../fish/guestfish-actions.pod:475
23017 msgid "blockdev-getsize64"
23021 #: ../fish/guestfish-actions.pod:477
23024 " blockdev-getsize64 device\n"
23029 #: ../fish/guestfish-actions.pod:481
23030 msgid "See also L</blockdev-getsz>."
23034 #: ../fish/guestfish-actions.pod:485
23035 msgid "blockdev-getss"
23039 #: ../fish/guestfish-actions.pod:487
23042 " blockdev-getss device\n"
23047 #: ../fish/guestfish-actions.pod:492
23049 "(Note, this is not the size in sectors, use L</blockdev-getsz> for that)."
23053 #: ../fish/guestfish-actions.pod:497
23054 msgid "blockdev-getsz"
23058 #: ../fish/guestfish-actions.pod:499
23061 " blockdev-getsz device\n"
23066 #: ../fish/guestfish-actions.pod:504
23068 "See also L</blockdev-getss> for the real sector size of the device, and L</"
23069 "blockdev-getsize64> for the more useful I<size in bytes>."
23073 #: ../fish/guestfish-actions.pod:510
23074 msgid "blockdev-rereadpt"
23078 #: ../fish/guestfish-actions.pod:512
23081 " blockdev-rereadpt device\n"
23086 #: ../fish/guestfish-actions.pod:518
23087 msgid "blockdev-setbsz"
23091 #: ../fish/guestfish-actions.pod:520
23094 " blockdev-setbsz device blocksize\n"
23099 #: ../fish/guestfish-actions.pod:529
23100 msgid "blockdev-setro"
23104 #: ../fish/guestfish-actions.pod:531
23107 " blockdev-setro device\n"
23112 #: ../fish/guestfish-actions.pod:537
23113 msgid "blockdev-setrw"
23117 #: ../fish/guestfish-actions.pod:539
23120 " blockdev-setrw device\n"
23125 #: ../fish/guestfish-actions.pod:545
23126 msgid "case-sensitive-path"
23130 #: ../fish/guestfish-actions.pod:547
23133 " case-sensitive-path path\n"
23138 #: ../fish/guestfish-actions.pod:571
23140 "Thus L</case-sensitive-path> (\"/Windows/System32\") might return C<\"/"
23141 "WINDOWS/system32\"> (the exact return value would depend on details of how "
23142 "the directories were originally created under Windows)."
23146 #: ../fish/guestfish-actions.pod:579
23147 msgid "See also L</realpath>."
23151 #: ../fish/guestfish-actions.pod:581
23156 #: ../fish/guestfish-actions.pod:583
23164 #: ../fish/guestfish-actions.pod:587
23166 "Note that this function cannot correctly handle binary files (specifically, "
23167 "files containing C<\\0> character which is treated as end of string). For "
23168 "those you need to use the L</read-file> or L</download> functions which have "
23169 "a more complex interface."
23173 #: ../fish/guestfish-actions.pod:595
23178 #: ../fish/guestfish-actions.pod:597
23181 " checksum csumtype path\n"
23186 #: ../fish/guestfish-actions.pod:640
23187 msgid "To get the checksum for a device, use L</checksum-device>."
23191 #: ../fish/guestfish-actions.pod:642
23192 msgid "To get the checksums for many files, use L</checksums-out>."
23196 #: ../fish/guestfish-actions.pod:644
23197 msgid "checksum-device"
23201 #: ../fish/guestfish-actions.pod:646
23204 " checksum-device csumtype device\n"
23209 #: ../fish/guestfish-actions.pod:648
23211 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
23212 "device named C<device>. For the types of checksums supported see the L</"
23213 "checksum> command."
23217 #: ../fish/guestfish-actions.pod:652
23218 msgid "checksums-out"
23222 #: ../fish/guestfish-actions.pod:654
23225 " checksums-out csumtype directory (sumsfile|-)\n"
23230 #: ../fish/guestfish-actions.pod:670
23235 #: ../fish/guestfish-actions.pod:672
23238 " chmod mode path\n"
23243 #: ../fish/guestfish-actions.pod:683
23248 #: ../fish/guestfish-actions.pod:685
23251 " chown owner group path\n"
23256 #: ../fish/guestfish-actions.pod:693
23261 #: ../fish/guestfish-actions.pod:695
23264 " command 'arguments ...'\n"
23269 #: ../fish/guestfish-actions.pod:702
23271 "The single parameter is an argv-style list of arguments. The first element "
23272 "is the name of the program to run. Subsequent elements are parameters. The "
23273 "list must be non-empty (ie. must contain a program name). Note that the "
23274 "command runs directly, and is I<not> invoked via the shell (see L</sh>)."
23278 #: ../fish/guestfish-actions.pod:730
23279 msgid "command-lines"
23283 #: ../fish/guestfish-actions.pod:732
23286 " command-lines 'arguments ...'\n"
23291 #: ../fish/guestfish-actions.pod:734
23293 "This is the same as L</command>, but splits the result into a list of lines."
23297 #: ../fish/guestfish-actions.pod:737
23298 msgid "See also: L</sh-lines>"
23302 #: ../fish/guestfish-actions.pod:742
23307 #: ../fish/guestfish-actions.pod:744
23310 " config qemuparam qemuvalue\n"
23315 #: ../fish/guestfish-actions.pod:755
23320 #: ../fish/guestfish-actions.pod:757
23323 " copy-size src dest size\n"
23328 #: ../fish/guestfish-actions.pod:765
23333 #: ../fish/guestfish-actions.pod:767
23341 #: ../fish/guestfish-actions.pod:772
23346 #: ../fish/guestfish-actions.pod:774
23354 #: ../fish/guestfish-actions.pod:779
23359 #: ../fish/guestfish-actions.pod:781
23367 #: ../fish/guestfish-actions.pod:788
23369 "If the destination is a device, it must be as large or larger than the "
23370 "source file or device, otherwise the copy will fail. This command cannot do "
23371 "partial copies (see L</copy-size>)."
23375 #: ../fish/guestfish-actions.pod:792
23380 #: ../fish/guestfish-actions.pod:794
23388 #: ../fish/guestfish-actions.pod:798 ../fish/guestfish-actions.pod:809
23390 "This command is mostly useful for interactive sessions. It is I<not> "
23391 "intended that you try to parse the output string. Use L</statvfs> from "
23396 #: ../fish/guestfish-actions.pod:802
23401 #: ../fish/guestfish-actions.pod:804
23409 #: ../fish/guestfish-actions.pod:813
23414 #: ../fish/guestfish-actions.pod:815
23422 #: ../fish/guestfish-actions.pod:821
23424 "Another way to get the same information is to enable verbose messages with "
23425 "L</set-verbose> or by setting the environment variable C<LIBGUESTFS_DEBUG=1> "
23426 "before running the program."
23430 #: ../fish/guestfish-actions.pod:826
23435 #: ../fish/guestfish-actions.pod:828
23438 " download remotefilename (filename|-)\n"
23443 #: ../fish/guestfish-actions.pod:835
23444 msgid "See also L</upload>, L</cat>."
23448 #: ../fish/guestfish-actions.pod:839
23449 msgid "download-offset"
23453 #: ../fish/guestfish-actions.pod:841
23456 " download-offset remotefilename (filename|-) offset size\n"
23461 #: ../fish/guestfish-actions.pod:849
23463 "Note that there is no limit on the amount of data that can be downloaded "
23464 "with this call, unlike with L</pread>, and this call always reads the full "
23465 "amount unless an error occurs."
23469 #: ../fish/guestfish-actions.pod:854
23470 msgid "See also L</download>, L</pread>."
23474 #: ../fish/guestfish-actions.pod:858
23475 msgid "drop-caches"
23479 #: ../fish/guestfish-actions.pod:860
23482 " drop-caches whattodrop\n"
23487 #: ../fish/guestfish-actions.pod:872
23492 #: ../fish/guestfish-actions.pod:874
23500 #: ../fish/guestfish-actions.pod:886
23505 #: ../fish/guestfish-actions.pod:888
23508 " e2fsck-f device\n"
23513 #: ../fish/guestfish-actions.pod:894
23515 "This command is only needed because of L</resize2fs> (q.v.). Normally you "
23516 "should use L</fsck>."
23520 #: ../fish/guestfish-actions.pod:897
23521 msgid "echo-daemon"
23525 #: ../fish/guestfish-actions.pod:899
23528 " echo-daemon 'words ...'\n"
23533 #: ../fish/guestfish-actions.pod:906
23534 msgid "See also L</ping-daemon>."
23538 #: ../fish/guestfish-actions.pod:908
23543 #: ../fish/guestfish-actions.pod:910
23546 " egrep regex path\n"
23551 #: ../fish/guestfish-actions.pod:918
23556 #: ../fish/guestfish-actions.pod:920
23559 " egrepi regex path\n"
23564 #: ../fish/guestfish-actions.pod:928
23569 #: ../fish/guestfish-actions.pod:930
23572 " equal file1 file2\n"
23577 #: ../fish/guestfish-actions.pod:937
23582 #: ../fish/guestfish-actions.pod:939
23590 #: ../fish/guestfish-actions.pod:944
23591 msgid "See also L</is-file>, L</is-dir>, L</stat>."
23595 #: ../fish/guestfish-actions.pod:946
23600 #: ../fish/guestfish-actions.pod:948
23603 " fallocate path len\n"
23608 #: ../fish/guestfish-actions.pod:965
23609 msgid "fallocate64"
23613 #: ../fish/guestfish-actions.pod:967
23616 " fallocate64 path len\n"
23621 #: ../fish/guestfish-actions.pod:973
23623 "Note that this call allocates disk blocks for the file. To create a sparse "
23624 "file use L</truncate-size> instead."
23628 #: ../fish/guestfish-actions.pod:976
23630 "The deprecated call L</fallocate> does the same, but owing to an oversight "
23631 "it only allowed 30 bit lengths to be specified, effectively limiting the "
23632 "maximum size of files created through that call to 1GB."
23636 #: ../fish/guestfish-actions.pod:985
23641 #: ../fish/guestfish-actions.pod:987
23644 " fgrep pattern path\n"
23649 #: ../fish/guestfish-actions.pod:995
23654 #: ../fish/guestfish-actions.pod:997
23657 " fgrepi pattern path\n"
23662 #: ../fish/guestfish-actions.pod:1005
23667 #: ../fish/guestfish-actions.pod:1007
23675 #: ../fish/guestfish-actions.pod:1023
23677 "See also: L<file(1)>, L</vfs-type>, L</lstat>, L</is-file>, L</is-blockdev> "
23678 "(etc), L</is-zero>."
23682 #: ../fish/guestfish-actions.pod:1026
23683 msgid "file-architecture"
23687 #: ../fish/guestfish-actions.pod:1028
23690 " file-architecture filename\n"
23695 #: ../fish/guestfish-actions.pod:1131
23700 #: ../fish/guestfish-actions.pod:1133
23708 #: ../fish/guestfish-actions.pod:1137
23710 "To get other stats about a file, use L</stat>, L</lstat>, L</is-dir>, L</is-"
23711 "file> etc. To get the size of block devices, use L</blockdev-getsize64>."
23715 #: ../fish/guestfish-actions.pod:1141
23720 #: ../fish/guestfish-actions.pod:1143
23723 " fill c len path\n"
23728 #: ../fish/guestfish-actions.pod:1149
23730 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
23731 "L</truncate-size>. To create a file with a pattern of repeating bytes use "
23732 "L</fill-pattern>."
23736 #: ../fish/guestfish-actions.pod:1154
23737 msgid "fill-pattern"
23741 #: ../fish/guestfish-actions.pod:1156
23744 " fill-pattern pattern len path\n"
23749 #: ../fish/guestfish-actions.pod:1158
23751 "This function is like L</fill> except that it creates a new file of length "
23752 "C<len> containing the repeating pattern of bytes in C<pattern>. The pattern "
23753 "is truncated if necessary to ensure the length of the file is exactly C<len> "
23758 #: ../fish/guestfish-actions.pod:1163
23763 #: ../fish/guestfish-actions.pod:1165
23766 " find directory\n"
23771 #: ../fish/guestfish-actions.pod:1179
23772 msgid "then the returned list from L</find> C</tmp> would be 4 elements:"
23776 #: ../fish/guestfish-actions.pod:1192
23777 msgid "See also L</find0>."
23781 #: ../fish/guestfish-actions.pod:1197
23786 #: ../fish/guestfish-actions.pod:1199
23789 " find0 directory (files|-)\n"
23794 #: ../fish/guestfish-actions.pod:1205
23796 "This command works the same way as L</find> with the following exceptions:"
23800 #: ../fish/guestfish-actions.pod:1232
23801 msgid "findfs-label"
23805 #: ../fish/guestfish-actions.pod:1234
23808 " findfs-label label\n"
23813 #: ../fish/guestfish-actions.pod:1240
23814 msgid "To find the label of a filesystem, use L</vfs-label>."
23818 #: ../fish/guestfish-actions.pod:1242
23819 msgid "findfs-uuid"
23823 #: ../fish/guestfish-actions.pod:1244
23826 " findfs-uuid uuid\n"
23831 #: ../fish/guestfish-actions.pod:1250
23832 msgid "To find the UUID of a filesystem, use L</vfs-uuid>."
23836 #: ../fish/guestfish-actions.pod:1252
23841 #: ../fish/guestfish-actions.pod:1254
23844 " fsck fstype device\n"
23849 #: ../fish/guestfish-actions.pod:1284
23854 #: ../fish/guestfish-actions.pod:1286
23862 #: ../fish/guestfish-actions.pod:1293
23863 msgid "get-attach-method"
23867 #: ../fish/guestfish-actions.pod:1295
23870 " get-attach-method\n"
23875 #: ../fish/guestfish-actions.pod:1297
23876 msgid "Return the current attach method. See L</set-attach-method>."
23880 #: ../fish/guestfish-actions.pod:1299
23881 msgid "get-autosync"
23885 #: ../fish/guestfish-actions.pod:1301
23893 #: ../fish/guestfish-actions.pod:1305
23898 #: ../fish/guestfish-actions.pod:1307
23906 #: ../fish/guestfish-actions.pod:1311
23907 msgid "get-e2label"
23911 #: ../fish/guestfish-actions.pod:1313
23914 " get-e2label device\n"
23919 #: ../fish/guestfish-actions.pod:1325
23924 #: ../fish/guestfish-actions.pod:1327
23927 " get-e2uuid device\n"
23932 #: ../fish/guestfish-actions.pod:1339
23933 msgid "get-memsize"
23937 #: ../fish/guestfish-actions.pod:1341
23945 #: ../fish/guestfish-actions.pod:1346
23947 "If L</set-memsize> was not called on this handle, and if "
23948 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
23949 "value for memsize."
23953 #: ../fish/guestfish-actions.pod:1353
23954 msgid "get-network"
23958 #: ../fish/guestfish-actions.pod:1355
23966 #: ../fish/guestfish-actions.pod:1359
23971 #: ../fish/guestfish-actions.pod:1361
23979 #: ../fish/guestfish-actions.pod:1368
23984 #: ../fish/guestfish-actions.pod:1370
23989 #: ../fish/guestfish-actions.pod:1372
23997 #: ../fish/guestfish-actions.pod:1379
24002 #: ../fish/guestfish-actions.pod:1381
24010 #: ../fish/guestfish-actions.pod:1388
24011 msgid "get-recovery-proc"
24015 #: ../fish/guestfish-actions.pod:1390
24018 " get-recovery-proc\n"
24023 #: ../fish/guestfish-actions.pod:1394
24024 msgid "get-selinux"
24028 #: ../fish/guestfish-actions.pod:1396
24036 #: ../fish/guestfish-actions.pod:1398
24038 "This returns the current setting of the selinux flag which is passed to the "
24039 "appliance at boot time. See L</set-selinux>."
24043 #: ../fish/guestfish-actions.pod:1404
24048 #: ../fish/guestfish-actions.pod:1406
24056 #: ../fish/guestfish-actions.pod:1413
24061 #: ../fish/guestfish-actions.pod:1415
24069 #: ../fish/guestfish-actions.pod:1419
24074 #: ../fish/guestfish-actions.pod:1421
24082 #: ../fish/guestfish-actions.pod:1423
24084 "Return the current umask. By default the umask is C<022> unless it has been "
24085 "set by calling L</umask>."
24089 #: ../fish/guestfish-actions.pod:1426
24090 msgid "get-verbose"
24094 #: ../fish/guestfish-actions.pod:1428
24102 #: ../fish/guestfish-actions.pod:1432
24107 #: ../fish/guestfish-actions.pod:1434
24115 #: ../fish/guestfish-actions.pod:1438
24116 msgid "See the documentation about SELINUX in L<guestfs(3)>, and L</setcon>"
24120 #: ../fish/guestfish-actions.pod:1441
24125 #: ../fish/guestfish-actions.pod:1443
24128 " getxattr path name\n"
24133 #: ../fish/guestfish-actions.pod:1445
24135 "Get a single extended attribute from file C<path> named C<name>. This call "
24136 "follows symlinks. If you want to lookup an extended attribute for the "
24137 "symlink itself, use L</lgetxattr>."
24141 #: ../fish/guestfish-actions.pod:1449 ../fish/guestfish-actions.pod:2476
24143 "Normally it is better to get all extended attributes from a file in one go "
24144 "by calling L</getxattrs>. However some Linux filesystem implementations are "
24145 "buggy and do not provide a way to list out attributes. For these "
24146 "filesystems (notably ntfs-3g) you have to know the names of the extended "
24147 "attributes you want in advance and call this function."
24151 #: ../fish/guestfish-actions.pod:1459
24152 msgid "See also: L</getxattrs>, L</lgetxattr>, L<attr(5)>."
24156 #: ../fish/guestfish-actions.pod:1461
24161 #: ../fish/guestfish-actions.pod:1463
24164 " getxattrs path\n"
24169 #: ../fish/guestfish-actions.pod:1471
24170 msgid "See also: L</lgetxattrs>, L<attr(5)>."
24174 #: ../fish/guestfish-actions.pod:1473
24175 msgid "glob-expand"
24179 #: ../fish/guestfish-actions.pod:1475
24182 " glob-expand pattern\n"
24187 #: ../fish/guestfish-actions.pod:1488
24192 #: ../fish/guestfish-actions.pod:1490
24195 " grep regex path\n"
24200 #: ../fish/guestfish-actions.pod:1498
24205 #: ../fish/guestfish-actions.pod:1500
24208 " grepi regex path\n"
24213 #: ../fish/guestfish-actions.pod:1508
24214 msgid "grub-install"
24218 #: ../fish/guestfish-actions.pod:1510
24221 " grub-install root device\n"
24226 #: ../fish/guestfish-actions.pod:1526
24231 #: ../fish/guestfish-actions.pod:1528
24239 #: ../fish/guestfish-actions.pod:1536
24244 #: ../fish/guestfish-actions.pod:1538
24247 " head-n nrlines path\n"
24252 #: ../fish/guestfish-actions.pod:1551
24257 #: ../fish/guestfish-actions.pod:1553
24265 #: ../fish/guestfish-actions.pod:1561
24270 #: ../fish/guestfish-actions.pod:1563
24273 " initrd-cat initrdpath filename\n"
24278 #: ../fish/guestfish-actions.pod:1575
24279 msgid "See also L</initrd-list>."
24283 #: ../fish/guestfish-actions.pod:1580
24284 msgid "initrd-list"
24288 #: ../fish/guestfish-actions.pod:1582
24291 " initrd-list path\n"
24296 #: ../fish/guestfish-actions.pod:1594
24297 msgid "inotify-add-watch"
24301 #: ../fish/guestfish-actions.pod:1596
24304 " inotify-add-watch path mask\n"
24309 #: ../fish/guestfish-actions.pod:1608
24310 msgid "inotify-close"
24314 #: ../fish/guestfish-actions.pod:1610
24322 #: ../fish/guestfish-actions.pod:1616
24323 msgid "inotify-files"
24327 #: ../fish/guestfish-actions.pod:1618
24335 #: ../fish/guestfish-actions.pod:1620
24337 "This function is a helpful wrapper around L</inotify-read> which just "
24338 "returns a list of pathnames of objects that were touched. The returned "
24339 "pathnames are sorted and deduplicated."
24343 #: ../fish/guestfish-actions.pod:1624
24344 msgid "inotify-init"
24348 #: ../fish/guestfish-actions.pod:1626
24351 " inotify-init maxevents\n"
24356 #: ../fish/guestfish-actions.pod:1632
24358 "C<maxevents> is the maximum number of events which will be queued up between "
24359 "calls to L</inotify-read> or L</inotify-files>. If this is passed as C<0>, "
24360 "then the kernel (or previously set) default is used. For Linux 2.6.29 the "
24361 "default was 16384 events. Beyond this limit, the kernel throws away events, "
24362 "but records the fact that it threw them away by setting a flag "
24363 "C<IN_Q_OVERFLOW> in the returned structure list (see L</inotify-read>)."
24367 #: ../fish/guestfish-actions.pod:1642
24369 "Before any events are generated, you have to add some watches to the "
24370 "internal watch list. See: L</inotify-add-watch>, L</inotify-rm-watch> and "
24371 "L</inotify-watch-all>."
24375 #: ../fish/guestfish-actions.pod:1648
24377 "Queued up events should be read periodically by calling L</inotify-read> (or "
24378 "L</inotify-files> which is just a helpful wrapper around L</inotify-read>). "
24379 "If you don't read the events out often enough then you risk the internal "
24380 "queue overflowing."
24384 #: ../fish/guestfish-actions.pod:1655
24386 "The handle should be closed after use by calling L</inotify-close>. This "
24387 "also removes any watches automatically."
24391 #: ../fish/guestfish-actions.pod:1664
24392 msgid "inotify-read"
24396 #: ../fish/guestfish-actions.pod:1666
24404 #: ../fish/guestfish-actions.pod:1679
24405 msgid "inotify-rm-watch"
24409 #: ../fish/guestfish-actions.pod:1681
24412 " inotify-rm-watch wd\n"
24417 #: ../fish/guestfish-actions.pod:1683
24418 msgid "Remove a previously defined inotify watch. See L</inotify-add-watch>."
24422 #: ../fish/guestfish-actions.pod:1686
24423 msgid "inspect-get-arch"
24427 #: ../fish/guestfish-actions.pod:1688
24430 " inspect-get-arch root\n"
24435 #: ../fish/guestfish-actions.pod:1690
24437 "This returns the architecture of the inspected operating system. The "
24438 "possible return values are listed under L</file-architecture>."
24442 #: ../fish/guestfish-actions.pod:1699
24443 msgid "inspect-get-distro"
24447 #: ../fish/guestfish-actions.pod:1701
24450 " inspect-get-distro root\n"
24455 #: ../fish/guestfish-actions.pod:1782
24456 msgid "inspect-get-drive-mappings"
24460 #: ../fish/guestfish-actions.pod:1784
24463 " inspect-get-drive-mappings root\n"
24468 #: ../fish/guestfish-actions.pod:1811
24470 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
24471 "get-mountpoints>, L</inspect-get-filesystems>."
24475 #: ../fish/guestfish-actions.pod:1815
24476 msgid "inspect-get-filesystems"
24480 #: ../fish/guestfish-actions.pod:1817
24483 " inspect-get-filesystems root\n"
24488 #: ../fish/guestfish-actions.pod:1827
24490 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
24491 "get-mountpoints>."
24495 #: ../fish/guestfish-actions.pod:1830
24496 msgid "inspect-get-format"
24500 #: ../fish/guestfish-actions.pod:1832
24503 " inspect-get-format root\n"
24508 #: ../fish/guestfish-actions.pod:1861
24509 msgid "inspect-get-hostname"
24513 #: ../fish/guestfish-actions.pod:1863
24516 " inspect-get-hostname root\n"
24521 #: ../fish/guestfish-actions.pod:1873
24522 msgid "inspect-get-icon"
24526 #: ../fish/guestfish-actions.pod:1875
24529 " inspect-get-icon root [favicon:..] [highquality:..]\n"
24534 #: ../fish/guestfish-actions.pod:1939
24535 msgid "inspect-get-major-version"
24539 #: ../fish/guestfish-actions.pod:1941
24542 " inspect-get-major-version root\n"
24547 #: ../fish/guestfish-actions.pod:1957
24548 msgid "inspect-get-minor-version"
24552 #: ../fish/guestfish-actions.pod:1959
24555 " inspect-get-minor-version root\n"
24560 #: ../fish/guestfish-actions.pod:1966
24562 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
24563 "get-major-version>."
24567 #: ../fish/guestfish-actions.pod:1969
24568 msgid "inspect-get-mountpoints"
24572 #: ../fish/guestfish-actions.pod:1971
24575 " inspect-get-mountpoints root\n"
24580 #: ../fish/guestfish-actions.pod:1990
24582 "For operating systems like Windows which still use drive letters, this call "
24583 "will only return an entry for the first drive \"mounted on\" C</>. For "
24584 "information about the mapping of drive letters to partitions, see L</inspect-"
24585 "get-drive-mappings>."
24589 #: ../fish/guestfish-actions.pod:1996
24591 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
24592 "get-filesystems>."
24596 #: ../fish/guestfish-actions.pod:1999
24597 msgid "inspect-get-package-format"
24601 #: ../fish/guestfish-actions.pod:2001
24604 " inspect-get-package-format root\n"
24609 #: ../fish/guestfish-actions.pod:2003
24611 "This function and L</inspect-get-package-management> return the package "
24612 "format and package management tool used by the inspected operating system. "
24613 "For example for Fedora these functions would return C<rpm> (package format) "
24614 "and C<yum> (package management)."
24618 #: ../fish/guestfish-actions.pod:2018
24619 msgid "inspect-get-package-management"
24623 #: ../fish/guestfish-actions.pod:2020
24626 " inspect-get-package-management root\n"
24631 #: ../fish/guestfish-actions.pod:2022
24633 "L</inspect-get-package-format> and this function return the package format "
24634 "and package management tool used by the inspected operating system. For "
24635 "example for Fedora these functions would return C<rpm> (package format) and "
24636 "C<yum> (package management)."
24640 #: ../fish/guestfish-actions.pod:2039
24641 msgid "inspect-get-product-name"
24645 #: ../fish/guestfish-actions.pod:2041
24648 " inspect-get-product-name root\n"
24653 #: ../fish/guestfish-actions.pod:2053
24654 msgid "inspect-get-product-variant"
24658 #: ../fish/guestfish-actions.pod:2055
24661 " inspect-get-product-variant root\n"
24666 #: ../fish/guestfish-actions.pod:2076
24668 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
24669 "get-product-name>, L</inspect-get-major-version>."
24673 #: ../fish/guestfish-actions.pod:2080
24674 msgid "inspect-get-roots"
24678 #: ../fish/guestfish-actions.pod:2082
24681 " inspect-get-roots\n"
24686 #: ../fish/guestfish-actions.pod:2084
24688 "This function is a convenient way to get the list of root devices, as "
24689 "returned from a previous call to L</inspect-os>, but without redoing the "
24690 "whole inspection process."
24694 #: ../fish/guestfish-actions.pod:2088
24696 "This returns an empty list if either no root devices were found or the "
24697 "caller has not called L</inspect-os>."
24701 #: ../fish/guestfish-actions.pod:2093
24702 msgid "inspect-get-type"
24706 #: ../fish/guestfish-actions.pod:2095
24709 " inspect-get-type root\n"
24714 #: ../fish/guestfish-actions.pod:2125
24715 msgid "inspect-get-windows-current-control-set"
24719 #: ../fish/guestfish-actions.pod:2127
24722 " inspect-get-windows-current-control-set root\n"
24727 #: ../fish/guestfish-actions.pod:2138
24728 msgid "inspect-get-windows-systemroot"
24732 #: ../fish/guestfish-actions.pod:2140
24735 " inspect-get-windows-systemroot root\n"
24740 #: ../fish/guestfish-actions.pod:2151
24741 msgid "inspect-is-live"
24745 #: ../fish/guestfish-actions.pod:2153
24748 " inspect-is-live root\n"
24753 #: ../fish/guestfish-actions.pod:2155
24755 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
24756 "then this returns true if a live image was detected on the disk."
24760 #: ../fish/guestfish-actions.pod:2161
24761 msgid "inspect-is-multipart"
24765 #: ../fish/guestfish-actions.pod:2163
24768 " inspect-is-multipart root\n"
24773 #: ../fish/guestfish-actions.pod:2165
24775 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
24776 "then this returns true if the disk is part of a set."
24780 #: ../fish/guestfish-actions.pod:2171
24781 msgid "inspect-is-netinst"
24785 #: ../fish/guestfish-actions.pod:2173
24788 " inspect-is-netinst root\n"
24793 #: ../fish/guestfish-actions.pod:2175
24795 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
24796 "then this returns true if the disk is a network installer, ie. not a self-"
24797 "contained install CD but one which is likely to require network access to "
24798 "complete the install."
24802 #: ../fish/guestfish-actions.pod:2183
24803 msgid "inspect-list-applications"
24807 #: ../fish/guestfish-actions.pod:2185
24810 " inspect-list-applications root\n"
24815 #: ../fish/guestfish-actions.pod:2189
24817 "I<Note:> This call works differently from other parts of the inspection "
24818 "API. You have to call L</inspect-os>, then L</inspect-get-mountpoints>, "
24819 "then mount up the disks, before calling this. Listing applications is a "
24820 "significantly more difficult operation which requires access to the full "
24821 "filesystem. Also note that unlike the other L</inspect-get-*> calls which "
24822 "are just returning data cached in the libguestfs handle, this call actually "
24823 "reads parts of the mounted filesystems during the call."
24827 #: ../fish/guestfish-actions.pod:2279
24832 #: ../fish/guestfish-actions.pod:2281
24840 #: ../fish/guestfish-actions.pod:2296
24842 "You can pass the root string(s) returned to other L</inspect-get-*> "
24843 "functions in order to query further information about each operating system, "
24844 "such as the name and version."
24848 #: ../fish/guestfish-actions.pod:2301
24850 "This function uses other libguestfs features such as L</mount-ro> and L</"
24851 "umount-all> in order to mount and unmount filesystems and look at the "
24852 "contents. This should be called with no disks currently mounted. The "
24853 "function may also use Augeas, so any existing Augeas handle will be closed."
24857 #: ../fish/guestfish-actions.pod:2313 ../fish/guestfish-actions.pod:2511
24858 #: ../fish/guestfish-actions.pod:2570
24859 msgid "See also L</list-filesystems>."
24863 #: ../fish/guestfish-actions.pod:2315
24864 msgid "is-blockdev"
24868 #: ../fish/guestfish-actions.pod:2317
24871 " is-blockdev path\n"
24876 #: ../fish/guestfish-actions.pod:2322 ../fish/guestfish-actions.pod:2340
24877 #: ../fish/guestfish-actions.pod:2359 ../fish/guestfish-actions.pod:2368
24878 #: ../fish/guestfish-actions.pod:2378 ../fish/guestfish-actions.pod:2412
24879 #: ../fish/guestfish-actions.pod:2421
24880 msgid "See also L</stat>."
24884 #: ../fish/guestfish-actions.pod:2324
24889 #: ../fish/guestfish-actions.pod:2326
24897 #: ../fish/guestfish-actions.pod:2333
24902 #: ../fish/guestfish-actions.pod:2335
24905 " is-chardev path\n"
24910 #: ../fish/guestfish-actions.pod:2342
24915 #: ../fish/guestfish-actions.pod:2344
24923 #: ../fish/guestfish-actions.pod:2351
24928 #: ../fish/guestfish-actions.pod:2353
24936 #: ../fish/guestfish-actions.pod:2361
24941 #: ../fish/guestfish-actions.pod:2363
24949 #: ../fish/guestfish-actions.pod:2370
24954 #: ../fish/guestfish-actions.pod:2372
24962 #: ../fish/guestfish-actions.pod:2380
24963 msgid "is-launching"
24967 #: ../fish/guestfish-actions.pod:2382
24975 #: ../fish/guestfish-actions.pod:2389
24980 #: ../fish/guestfish-actions.pod:2391
24988 #: ../fish/guestfish-actions.pod:2396
24993 #: ../fish/guestfish-actions.pod:2398
25001 #: ../fish/guestfish-actions.pod:2405
25006 #: ../fish/guestfish-actions.pod:2407
25009 " is-socket path\n"
25014 #: ../fish/guestfish-actions.pod:2414
25019 #: ../fish/guestfish-actions.pod:2416
25022 " is-symlink path\n"
25027 #: ../fish/guestfish-actions.pod:2423
25032 #: ../fish/guestfish-actions.pod:2425
25040 #: ../fish/guestfish-actions.pod:2430
25041 msgid "is-zero-device"
25045 #: ../fish/guestfish-actions.pod:2432
25048 " is-zero-device device\n"
25053 #: ../fish/guestfish-actions.pod:2438
25054 msgid "kill-subprocess"
25058 #: ../fish/guestfish-actions.pod:2440
25061 " kill-subprocess\n"
25066 #: ../fish/guestfish-actions.pod:2444
25071 #: ../fish/guestfish-actions.pod:2446
25076 #: ../fish/guestfish-actions.pod:2448
25084 #: ../fish/guestfish-actions.pod:2456
25089 #: ../fish/guestfish-actions.pod:2458
25092 " lchown owner group path\n"
25097 #: ../fish/guestfish-actions.pod:2460
25099 "Change the file owner to C<owner> and group to C<group>. This is like L</"
25100 "chown> but if C<path> is a symlink then the link itself is changed, not the "
25105 #: ../fish/guestfish-actions.pod:2468
25110 #: ../fish/guestfish-actions.pod:2470
25113 " lgetxattr path name\n"
25118 #: ../fish/guestfish-actions.pod:2486
25119 msgid "See also: L</lgetxattrs>, L</getxattr>, L<attr(5)>."
25123 #: ../fish/guestfish-actions.pod:2488
25128 #: ../fish/guestfish-actions.pod:2490
25131 " lgetxattrs path\n"
25136 #: ../fish/guestfish-actions.pod:2492
25138 "This is the same as L</getxattrs>, but if C<path> is a symbolic link, then "
25139 "it returns the extended attributes of the link itself."
25143 #: ../fish/guestfish-actions.pod:2496
25148 #: ../fish/guestfish-actions.pod:2498
25156 #: ../fish/guestfish-actions.pod:2503
25157 msgid "list-devices"
25161 #: ../fish/guestfish-actions.pod:2505
25169 #: ../fish/guestfish-actions.pod:2513
25170 msgid "list-dm-devices"
25174 #: ../fish/guestfish-actions.pod:2515
25177 " list-dm-devices\n"
25182 #: ../fish/guestfish-actions.pod:2519
25184 "The returned list contains C</dev/mapper/*> devices, eg. ones created by a "
25185 "previous call to L</luks-open>."
25189 #: ../fish/guestfish-actions.pod:2522
25191 "Device mapper devices which correspond to logical volumes are I<not> "
25192 "returned in this list. Call L</lvs> if you want to list logical volumes."
25196 #: ../fish/guestfish-actions.pod:2526
25197 msgid "list-filesystems"
25201 #: ../fish/guestfish-actions.pod:2528
25204 " list-filesystems\n"
25209 #: ../fish/guestfish-actions.pod:2547
25211 "This command runs other libguestfs commands, which might include L</mount> "
25212 "and L</umount>, and therefore you should use this soon after launch and only "
25213 "when nothing is mounted."
25217 #: ../fish/guestfish-actions.pod:2551
25219 "Not all of the filesystems returned will be mountable. In particular, swap "
25220 "partitions are returned in the list. Also this command does not check that "
25221 "each filesystem found is valid and mountable, and some filesystems might be "
25222 "mountable but require special options. Filesystems may not all belong to a "
25223 "single logical operating system (use L</inspect-os> to look for OSes)."
25227 #: ../fish/guestfish-actions.pod:2559
25228 msgid "list-partitions"
25232 #: ../fish/guestfish-actions.pod:2561
25235 " list-partitions\n"
25240 #: ../fish/guestfish-actions.pod:2567
25242 "This does not return logical volumes. For that you will need to call L</"
25247 #: ../fish/guestfish-actions.pod:2572
25252 #: ../fish/guestfish-actions.pod:2574
25260 #: ../fish/guestfish-actions.pod:2582
25265 #: ../fish/guestfish-actions.pod:2584
25268 " ln target linkname\n"
25273 #: ../fish/guestfish-actions.pod:2588
25278 #: ../fish/guestfish-actions.pod:2590
25281 " ln-f target linkname\n"
25286 #: ../fish/guestfish-actions.pod:2595
25291 #: ../fish/guestfish-actions.pod:2597
25294 " ln-s target linkname\n"
25299 #: ../fish/guestfish-actions.pod:2601
25304 #: ../fish/guestfish-actions.pod:2603
25307 " ln-sf target linkname\n"
25312 #: ../fish/guestfish-actions.pod:2608
25313 msgid "lremovexattr"
25317 #: ../fish/guestfish-actions.pod:2610
25320 " lremovexattr xattr path\n"
25325 #: ../fish/guestfish-actions.pod:2612
25327 "This is the same as L</removexattr>, but if C<path> is a symbolic link, then "
25328 "it removes an extended attribute of the link itself."
25332 #: ../fish/guestfish-actions.pod:2616
25337 #: ../fish/guestfish-actions.pod:2618
25345 #: ../fish/guestfish-actions.pod:2624
25347 "This command is mostly useful for interactive sessions. Programs should "
25348 "probably use L</readdir> instead."
25352 #: ../fish/guestfish-actions.pod:2627
25357 #: ../fish/guestfish-actions.pod:2629
25360 " lsetxattr xattr val vallen path\n"
25365 #: ../fish/guestfish-actions.pod:2631
25367 "This is the same as L</setxattr>, but if C<path> is a symbolic link, then it "
25368 "sets an extended attribute of the link itself."
25372 #: ../fish/guestfish-actions.pod:2635
25377 #: ../fish/guestfish-actions.pod:2637
25385 #: ../fish/guestfish-actions.pod:2641
25387 "This is the same as L</stat> except that if C<path> is a symbolic link, then "
25388 "the link is stat-ed, not the file it refers to."
25392 #: ../fish/guestfish-actions.pod:2647
25397 #: ../fish/guestfish-actions.pod:2649
25400 " lstatlist path 'names ...'\n"
25405 #: ../fish/guestfish-actions.pod:2651
25407 "This call allows you to perform the L</lstat> operation on multiple files, "
25408 "where all files are in the directory C<path>. C<names> is the list of files "
25409 "from this directory."
25413 #: ../fish/guestfish-actions.pod:2660
25415 "This call is intended for programs that want to efficiently list a directory "
25416 "contents without making many round-trips. See also L</lxattrlist> for a "
25417 "similarly efficient call for getting extended attributes. Very long "
25418 "directory listings might cause the protocol message size to be exceeded, "
25419 "causing this call to fail. The caller must split up such requests into "
25420 "smaller groups of names."
25424 #: ../fish/guestfish-actions.pod:2668
25425 msgid "luks-add-key"
25429 #: ../fish/guestfish-actions.pod:2670
25432 " luks-add-key device keyslot\n"
25437 #: ../fish/guestfish-actions.pod:2677
25439 "Note that if C<keyslot> already contains a key, then this command will "
25440 "fail. You have to use L</luks-kill-slot> first to remove that key."
25444 #: ../fish/guestfish-actions.pod:2681 ../fish/guestfish-actions.pod:2703
25445 #: ../fish/guestfish-actions.pod:2716 ../fish/guestfish-actions.pod:2730
25446 #: ../fish/guestfish-actions.pod:2756 ../fish/guestfish-actions.pod:2766
25448 "This command has one or more key or passphrase parameters. Guestfish will "
25449 "prompt for these separately."
25453 #: ../fish/guestfish-actions.pod:2684
25458 #: ../fish/guestfish-actions.pod:2686
25461 " luks-close device\n"
25466 #: ../fish/guestfish-actions.pod:2688
25468 "This closes a LUKS device that was created earlier by L</luks-open> or L</"
25469 "luks-open-ro>. The C<device> parameter must be the name of the LUKS mapping "
25470 "device (ie. C</dev/mapper/mapname>) and I<not> the name of the underlying "
25475 #: ../fish/guestfish-actions.pod:2694
25476 msgid "luks-format"
25480 #: ../fish/guestfish-actions.pod:2696
25483 " luks-format device keyslot\n"
25488 #: ../fish/guestfish-actions.pod:2709
25489 msgid "luks-format-cipher"
25493 #: ../fish/guestfish-actions.pod:2711
25496 " luks-format-cipher device keyslot cipher\n"
25501 #: ../fish/guestfish-actions.pod:2713
25503 "This command is the same as L</luks-format> but it also allows you to set "
25504 "the C<cipher> used."
25508 #: ../fish/guestfish-actions.pod:2722
25509 msgid "luks-kill-slot"
25513 #: ../fish/guestfish-actions.pod:2724
25516 " luks-kill-slot device keyslot\n"
25521 #: ../fish/guestfish-actions.pod:2733
25526 #: ../fish/guestfish-actions.pod:2735
25529 " luks-open device mapname\n"
25534 #: ../fish/guestfish-actions.pod:2749
25536 "If this block device contains LVM volume groups, then calling L</vgscan> "
25537 "followed by L</vg-activate-all> will make them visible."
25541 #: ../fish/guestfish-actions.pod:2753
25542 msgid "Use L</list-dm-devices> to list all device mapper devices."
25546 #: ../fish/guestfish-actions.pod:2759
25547 msgid "luks-open-ro"
25551 #: ../fish/guestfish-actions.pod:2761
25554 " luks-open-ro device mapname\n"
25559 #: ../fish/guestfish-actions.pod:2763
25561 "This is the same as L</luks-open> except that a read-only mapping is created."
25565 #: ../fish/guestfish-actions.pod:2769
25570 #: ../fish/guestfish-actions.pod:2771
25573 " lvcreate logvol volgroup mbytes\n"
25578 #: ../fish/guestfish-actions.pod:2776
25579 msgid "lvm-canonical-lv-name"
25583 #: ../fish/guestfish-actions.pod:2778
25586 " lvm-canonical-lv-name lvname\n"
25591 #: ../fish/guestfish-actions.pod:2787
25592 msgid "See also L</is-lv>."
25596 #: ../fish/guestfish-actions.pod:2789
25597 msgid "lvm-clear-filter"
25601 #: ../fish/guestfish-actions.pod:2791
25604 " lvm-clear-filter\n"
25609 #: ../fish/guestfish-actions.pod:2793
25611 "This undoes the effect of L</lvm-set-filter>. LVM will be able to see every "
25616 #: ../fish/guestfish-actions.pod:2799
25617 msgid "lvm-remove-all"
25621 #: ../fish/guestfish-actions.pod:2801
25624 " lvm-remove-all\n"
25629 #: ../fish/guestfish-actions.pod:2809
25630 msgid "lvm-set-filter"
25634 #: ../fish/guestfish-actions.pod:2811
25637 " lvm-set-filter 'devices ...'\n"
25642 #: ../fish/guestfish-actions.pod:2836
25647 #: ../fish/guestfish-actions.pod:2838
25650 " lvremove device\n"
25655 #: ../fish/guestfish-actions.pod:2846
25660 #: ../fish/guestfish-actions.pod:2848
25663 " lvrename logvol newlogvol\n"
25668 #: ../fish/guestfish-actions.pod:2852
25673 #: ../fish/guestfish-actions.pod:2854
25676 " lvresize device mbytes\n"
25681 #: ../fish/guestfish-actions.pod:2860
25682 msgid "lvresize-free"
25686 #: ../fish/guestfish-actions.pod:2862
25689 " lvresize-free lv percent\n"
25694 #: ../fish/guestfish-actions.pod:2870
25699 #: ../fish/guestfish-actions.pod:2872
25707 #: ../fish/guestfish-actions.pod:2880
25708 msgid "See also L</lvs-full>, L</list-filesystems>."
25712 #: ../fish/guestfish-actions.pod:2882
25717 #: ../fish/guestfish-actions.pod:2884
25725 #: ../fish/guestfish-actions.pod:2889
25730 #: ../fish/guestfish-actions.pod:2891
25738 #: ../fish/guestfish-actions.pod:2895
25743 #: ../fish/guestfish-actions.pod:2897
25746 " lxattrlist path 'names ...'\n"
25751 #: ../fish/guestfish-actions.pod:2913
25753 "This call is intended for programs that want to efficiently list a directory "
25754 "contents without making many round-trips. See also L</lstatlist> for a "
25755 "similarly efficient call for getting standard stats. Very long directory "
25756 "listings might cause the protocol message size to be exceeded, causing this "
25757 "call to fail. The caller must split up such requests into smaller groups of "
25762 #: ../fish/guestfish-actions.pod:2921
25767 #: ../fish/guestfish-actions.pod:2923
25775 #: ../fish/guestfish-actions.pod:2927
25780 #: ../fish/guestfish-actions.pod:2929
25783 " mkdir-mode path mode\n"
25788 #: ../fish/guestfish-actions.pod:2938
25789 msgid "See also L</mkdir>, L</umask>"
25793 #: ../fish/guestfish-actions.pod:2940
25798 #: ../fish/guestfish-actions.pod:2942
25806 #: ../fish/guestfish-actions.pod:2947
25811 #: ../fish/guestfish-actions.pod:2949
25814 " mkdtemp template\n"
25819 #: ../fish/guestfish-actions.pod:2970
25824 #: ../fish/guestfish-actions.pod:2972
25827 " mke2fs-J fstype blocksize device journal\n"
25832 #: ../fish/guestfish-actions.pod:2980
25833 msgid "See also L</mke2journal>."
25837 #: ../fish/guestfish-actions.pod:2982
25842 #: ../fish/guestfish-actions.pod:2984
25845 " mke2fs-JL fstype blocksize device label\n"
25850 #: ../fish/guestfish-actions.pod:2989
25851 msgid "See also L</mke2journal-L>."
25855 #: ../fish/guestfish-actions.pod:2991
25860 #: ../fish/guestfish-actions.pod:2993
25863 " mke2fs-JU fstype blocksize device uuid\n"
25868 #: ../fish/guestfish-actions.pod:2998
25869 msgid "See also L</mke2journal-U>."
25873 #: ../fish/guestfish-actions.pod:3000
25874 msgid "mke2journal"
25878 #: ../fish/guestfish-actions.pod:3002
25881 " mke2journal blocksize device\n"
25886 #: ../fish/guestfish-actions.pod:3009
25887 msgid "mke2journal-L"
25891 #: ../fish/guestfish-actions.pod:3011
25894 " mke2journal-L blocksize label device\n"
25899 #: ../fish/guestfish-actions.pod:3015
25900 msgid "mke2journal-U"
25904 #: ../fish/guestfish-actions.pod:3017
25907 " mke2journal-U blocksize uuid device\n"
25912 #: ../fish/guestfish-actions.pod:3021
25917 #: ../fish/guestfish-actions.pod:3023
25920 " mkfifo mode path\n"
25925 #: ../fish/guestfish-actions.pod:3025
25927 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
25928 "is just a convenient wrapper around L</mknod>."
25932 #: ../fish/guestfish-actions.pod:3031
25937 #: ../fish/guestfish-actions.pod:3033
25940 " mkfs fstype device\n"
25945 #: ../fish/guestfish-actions.pod:3039
25950 #: ../fish/guestfish-actions.pod:3041
25953 " mkfs-b fstype blocksize device\n"
25958 #: ../fish/guestfish-actions.pod:3043
25960 "This call is similar to L</mkfs>, but it allows you to control the block "
25961 "size of the resulting filesystem. Supported block sizes depend on the "
25962 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
25966 #: ../fish/guestfish-actions.pod:3058
25971 #: ../fish/guestfish-actions.pod:3060
25974 " mkfs-opts fstype device [blocksize:..] [features:..] [inode:..] [sectorsize:..]\n"
25979 #: ../fish/guestfish-actions.pod:3105
25980 msgid "mkmountpoint"
25984 #: ../fish/guestfish-actions.pod:3107
25987 " mkmountpoint exemptpath\n"
25992 #: ../fish/guestfish-actions.pod:3109
25994 "L</mkmountpoint> and L</rmmountpoint> are specialized calls that can be used "
25995 "to create extra mountpoints before mounting the first filesystem."
25999 #: ../fish/guestfish-actions.pod:3133
26001 "L</mkmountpoint> is not compatible with L</umount-all>. You may get "
26002 "unexpected errors if you try to mix these calls. It is safest to manually "
26003 "unmount filesystems and remove mountpoints after use."
26007 #: ../fish/guestfish-actions.pod:3137
26009 "L</umount-all> unmounts filesystems by sorting the paths longest first, so "
26010 "for this to work for manual mountpoints, you must ensure that the innermost "
26011 "mountpoints have the longest pathnames, as in the example code above."
26015 #: ../fish/guestfish-actions.pod:3144
26017 "Autosync [see L</set-autosync>, this is set by default on handles] can cause "
26018 "L</umount-all> to be called when the handle is closed which can also trigger "
26023 #: ../fish/guestfish-actions.pod:3148
26028 #: ../fish/guestfish-actions.pod:3150
26031 " mknod mode devmajor devminor path\n"
26036 #: ../fish/guestfish-actions.pod:3160
26038 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
26039 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
26040 "regular file). These constants are available in the standard Linux header "
26041 "files, or you can use L</mknod-b>, L</mknod-c> or L</mkfifo> which are "
26042 "wrappers around this command which bitwise OR in the appropriate constant "
26047 #: ../fish/guestfish-actions.pod:3170
26052 #: ../fish/guestfish-actions.pod:3172
26055 " mknod-b mode devmajor devminor path\n"
26060 #: ../fish/guestfish-actions.pod:3174
26062 "This call creates a block device node called C<path> with mode C<mode> and "
26063 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
26064 "wrapper around L</mknod>."
26068 #: ../fish/guestfish-actions.pod:3180
26073 #: ../fish/guestfish-actions.pod:3182
26076 " mknod-c mode devmajor devminor path\n"
26081 #: ../fish/guestfish-actions.pod:3184
26083 "This call creates a char device node called C<path> with mode C<mode> and "
26084 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
26085 "wrapper around L</mknod>."
26089 #: ../fish/guestfish-actions.pod:3190
26094 #: ../fish/guestfish-actions.pod:3192
26102 #: ../fish/guestfish-actions.pod:3196
26107 #: ../fish/guestfish-actions.pod:3198
26110 " mkswap-L label device\n"
26115 #: ../fish/guestfish-actions.pod:3206
26120 #: ../fish/guestfish-actions.pod:3208
26123 " mkswap-U uuid device\n"
26128 #: ../fish/guestfish-actions.pod:3212
26129 msgid "mkswap-file"
26133 #: ../fish/guestfish-actions.pod:3214
26136 " mkswap-file path\n"
26141 #: ../fish/guestfish-actions.pod:3218
26143 "This command just writes a swap file signature to an existing file. To "
26144 "create the file itself, use something like L</fallocate>."
26148 #: ../fish/guestfish-actions.pod:3221
26153 #: ../fish/guestfish-actions.pod:3223
26156 " modprobe modulename\n"
26161 #: ../fish/guestfish-actions.pod:3230
26166 #: ../fish/guestfish-actions.pod:3232
26169 " mount device mountpoint\n"
26174 #: ../fish/guestfish-actions.pod:3248
26176 "B<Important note:> When you use this call, the filesystem options C<sync> "
26177 "and C<noatime> are set implicitly. This was originally done because we "
26178 "thought it would improve reliability, but it turns out that I<-o sync> has a "
26179 "very large negative performance impact and negligible effect on "
26180 "reliability. Therefore we recommend that you avoid using L</mount> in any "
26181 "code that needs performance, and instead use L</mount-options> (use an empty "
26182 "string for the first parameter if you don't want any options)."
26186 #: ../fish/guestfish-actions.pod:3265
26191 #: ../fish/guestfish-actions.pod:3267
26194 " mount-9p mounttag mountpoint [options:..]\n"
26199 #: ../fish/guestfish-actions.pod:3278
26204 #: ../fish/guestfish-actions.pod:3280
26207 " mount-loop file mountpoint\n"
26212 #: ../fish/guestfish-actions.pod:3286
26213 msgid "mount-options"
26217 #: ../fish/guestfish-actions.pod:3288
26220 " mount-options options device mountpoint\n"
26225 #: ../fish/guestfish-actions.pod:3290
26227 "This is the same as the L</mount> command, but it allows you to set the "
26228 "mount options as for the L<mount(8)> I<-o> flag."
26232 #: ../fish/guestfish-actions.pod:3298
26237 #: ../fish/guestfish-actions.pod:3300
26240 " mount-ro device mountpoint\n"
26245 #: ../fish/guestfish-actions.pod:3302
26247 "This is the same as the L</mount> command, but it mounts the filesystem with "
26248 "the read-only (I<-o ro>) flag."
26252 #: ../fish/guestfish-actions.pod:3305
26257 #: ../fish/guestfish-actions.pod:3307
26260 " mount-vfs options vfstype device mountpoint\n"
26265 #: ../fish/guestfish-actions.pod:3309
26267 "This is the same as the L</mount> command, but it allows you to set both the "
26268 "mount options and the vfstype as for the L<mount(8)> I<-o> and I<-t> flags."
26272 #: ../fish/guestfish-actions.pod:3313
26273 msgid "mountpoints"
26277 #: ../fish/guestfish-actions.pod:3315
26285 #: ../fish/guestfish-actions.pod:3317
26287 "This call is similar to L</mounts>. That call returns a list of devices. "
26288 "This one returns a hash table (map) of device name to directory where the "
26289 "device is mounted."
26293 #: ../fish/guestfish-actions.pod:3321
26298 #: ../fish/guestfish-actions.pod:3323
26306 #: ../fish/guestfish-actions.pod:3330
26307 msgid "See also: L</mountpoints>"
26311 #: ../fish/guestfish-actions.pod:3332
26316 #: ../fish/guestfish-actions.pod:3334
26324 #: ../fish/guestfish-actions.pod:3339
26325 msgid "ntfs-3g-probe"
26329 #: ../fish/guestfish-actions.pod:3341
26332 " ntfs-3g-probe true|false device\n"
26337 #: ../fish/guestfish-actions.pod:3355
26342 #: ../fish/guestfish-actions.pod:3357
26345 " ntfsresize device\n"
26350 #: ../fish/guestfish-actions.pod:3379
26351 msgid "ntfsresize-opts"
26355 #: ../fish/guestfish-actions.pod:3381
26358 " ntfsresize-opts device [size:..] [force:..]\n"
26363 #: ../fish/guestfish-actions.pod:3400
26365 "After the resize operation, the filesystem is always marked as requiring a "
26366 "consistency check (for safety). You have to boot into Windows to perform "
26367 "this check and clear this condition. If you I<don't> set the C<force> "
26368 "option then it is not possible to call L</ntfsresize-opts> multiple times on "
26369 "a single filesystem without booting into Windows between each resize."
26373 #: ../fish/guestfish-actions.pod:3413
26374 msgid "ntfsresize-size"
26378 #: ../fish/guestfish-actions.pod:3415
26381 " ntfsresize-size device size\n"
26386 #: ../fish/guestfish-actions.pod:3417
26388 "This command is the same as L</ntfsresize> except that it allows you to "
26389 "specify the new size (in bytes) explicitly."
26393 #: ../fish/guestfish-actions.pod:3427
26398 #: ../fish/guestfish-actions.pod:3429
26401 " part-add device prlogex startsect endsect\n"
26406 #: ../fish/guestfish-actions.pod:3431
26408 "This command adds a partition to C<device>. If there is no partition table "
26409 "on the device, call L</part-init> first."
26413 #: ../fish/guestfish-actions.pod:3443
26415 "Creating a partition which covers the whole disk is not so easy. Use L</"
26416 "part-disk> to do that."
26420 #: ../fish/guestfish-actions.pod:3446
26425 #: ../fish/guestfish-actions.pod:3448
26428 " part-del device partnum\n"
26433 #: ../fish/guestfish-actions.pod:3456
26438 #: ../fish/guestfish-actions.pod:3458
26441 " part-disk device parttype\n"
26446 #: ../fish/guestfish-actions.pod:3460
26448 "This command is simply a combination of L</part-init> followed by L</part-"
26449 "add> to create a single primary partition covering the whole disk."
26453 #: ../fish/guestfish-actions.pod:3464
26455 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
26456 "possible values are described in L</part-init>."
26460 #: ../fish/guestfish-actions.pod:3470
26461 msgid "part-get-bootable"
26465 #: ../fish/guestfish-actions.pod:3472
26468 " part-get-bootable device partnum\n"
26473 #: ../fish/guestfish-actions.pod:3477
26474 msgid "See also L</part-set-bootable>."
26478 #: ../fish/guestfish-actions.pod:3479
26479 msgid "part-get-mbr-id"
26483 #: ../fish/guestfish-actions.pod:3481
26486 " part-get-mbr-id device partnum\n"
26491 #: ../fish/guestfish-actions.pod:3486 ../fish/guestfish-actions.pod:3624
26493 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
26494 "undefined results for other partition table types (see L</part-get-"
26499 #: ../fish/guestfish-actions.pod:3490
26500 msgid "part-get-parttype"
26504 #: ../fish/guestfish-actions.pod:3492
26507 " part-get-parttype device\n"
26512 #: ../fish/guestfish-actions.pod:3497
26514 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
26515 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
26516 "possible, although unusual. See L</part-init> for a full list."
26520 #: ../fish/guestfish-actions.pod:3502
26525 #: ../fish/guestfish-actions.pod:3504
26528 " part-init device parttype\n"
26533 #: ../fish/guestfish-actions.pod:3510
26535 "Initially there are no partitions. Following this, you should call L</part-"
26536 "add> for each partition required."
26540 #: ../fish/guestfish-actions.pod:3573
26545 #: ../fish/guestfish-actions.pod:3575
26548 " part-list device\n"
26553 #: ../fish/guestfish-actions.pod:3590
26555 "Start of the partition I<in bytes>. To get sectors you have to divide by "
26556 "the device's sector size, see L</blockdev-getss>."
26560 #: ../fish/guestfish-actions.pod:3603
26561 msgid "part-set-bootable"
26565 #: ../fish/guestfish-actions.pod:3605
26568 " part-set-bootable device partnum true|false\n"
26573 #: ../fish/guestfish-actions.pod:3614
26574 msgid "part-set-mbr-id"
26578 #: ../fish/guestfish-actions.pod:3616
26581 " part-set-mbr-id device partnum idbyte\n"
26586 #: ../fish/guestfish-actions.pod:3628
26587 msgid "part-set-name"
26591 #: ../fish/guestfish-actions.pod:3630
26594 " part-set-name device partnum name\n"
26599 #: ../fish/guestfish-actions.pod:3638
26600 msgid "part-to-dev"
26604 #: ../fish/guestfish-actions.pod:3640
26607 " part-to-dev partition\n"
26612 #: ../fish/guestfish-actions.pod:3646
26614 "The named partition must exist, for example as a string returned from L</"
26615 "list-partitions>."
26619 #: ../fish/guestfish-actions.pod:3649
26620 msgid "ping-daemon"
26624 #: ../fish/guestfish-actions.pod:3651
26632 #: ../fish/guestfish-actions.pod:3658
26637 #: ../fish/guestfish-actions.pod:3660
26640 " pread path count offset\n"
26645 #: ../fish/guestfish-actions.pod:3668
26646 msgid "See also L</pwrite>, L</pread-device>."
26650 #: ../fish/guestfish-actions.pod:3673
26651 msgid "pread-device"
26655 #: ../fish/guestfish-actions.pod:3675
26658 " pread-device device count offset\n"
26663 #: ../fish/guestfish-actions.pod:3683
26664 msgid "See also L</pread>."
26668 #: ../fish/guestfish-actions.pod:3688
26673 #: ../fish/guestfish-actions.pod:3690
26676 " pvcreate device\n"
26681 #: ../fish/guestfish-actions.pod:3696
26686 #: ../fish/guestfish-actions.pod:3698
26689 " pvremove device\n"
26694 #: ../fish/guestfish-actions.pod:3707
26699 #: ../fish/guestfish-actions.pod:3709
26702 " pvresize device\n"
26707 #: ../fish/guestfish-actions.pod:3714
26708 msgid "pvresize-size"
26712 #: ../fish/guestfish-actions.pod:3716
26715 " pvresize-size device size\n"
26720 #: ../fish/guestfish-actions.pod:3718
26722 "This command is the same as L</pvresize> except that it allows you to "
26723 "specify the new size (in bytes) explicitly."
26727 #: ../fish/guestfish-actions.pod:3721
26732 #: ../fish/guestfish-actions.pod:3723
26740 #: ../fish/guestfish-actions.pod:3731
26741 msgid "See also L</pvs-full>."
26745 #: ../fish/guestfish-actions.pod:3733
26750 #: ../fish/guestfish-actions.pod:3735
26758 #: ../fish/guestfish-actions.pod:3740
26763 #: ../fish/guestfish-actions.pod:3742
26771 #: ../fish/guestfish-actions.pod:3746
26776 #: ../fish/guestfish-actions.pod:3748
26779 " pwrite path content offset\n"
26784 #: ../fish/guestfish-actions.pod:3759
26785 msgid "See also L</pread>, L</pwrite-device>."
26789 #: ../fish/guestfish-actions.pod:3764
26790 msgid "pwrite-device"
26794 #: ../fish/guestfish-actions.pod:3766
26797 " pwrite-device device content offset\n"
26802 #: ../fish/guestfish-actions.pod:3776
26803 msgid "See also L</pwrite>."
26807 #: ../fish/guestfish-actions.pod:3781
26812 #: ../fish/guestfish-actions.pod:3783
26815 " read-file path\n"
26820 #: ../fish/guestfish-actions.pod:3788
26822 "Unlike L</cat>, this function can correctly handle files that contain "
26823 "embedded ASCII NUL characters. However unlike L</download>, this function "
26824 "is limited in the total size of file that can be handled."
26828 #: ../fish/guestfish-actions.pod:3796
26833 #: ../fish/guestfish-actions.pod:3798
26836 " read-lines path\n"
26841 #: ../fish/guestfish-actions.pod:3805
26843 "Note that this function cannot correctly handle binary files (specifically, "
26844 "files containing C<\\0> character which is treated as end of line). For "
26845 "those you need to use the L</read-file> function which has a more complex "
26850 #: ../fish/guestfish-actions.pod:3810
26855 #: ../fish/guestfish-actions.pod:3812
26863 #: ../fish/guestfish-actions.pod:3864
26865 "This function is primarily intended for use by programs. To get a simple "
26866 "list of names, use L</ls>. To get a printable directory for human "
26867 "consumption, use L</ll>."
26871 #: ../fish/guestfish-actions.pod:3868
26876 #: ../fish/guestfish-actions.pod:3870
26884 #: ../fish/guestfish-actions.pod:3874
26885 msgid "readlinklist"
26889 #: ../fish/guestfish-actions.pod:3876
26892 " readlinklist path 'names ...'\n"
26897 #: ../fish/guestfish-actions.pod:3900
26902 #: ../fish/guestfish-actions.pod:3902
26910 #: ../fish/guestfish-actions.pod:3907
26911 msgid "removexattr"
26915 #: ../fish/guestfish-actions.pod:3909
26918 " removexattr xattr path\n"
26923 #: ../fish/guestfish-actions.pod:3914
26924 msgid "See also: L</lremovexattr>, L<attr(5)>."
26928 #: ../fish/guestfish-actions.pod:3916
26933 #: ../fish/guestfish-actions.pod:3918
26936 " resize2fs device\n"
26941 #: ../fish/guestfish-actions.pod:3923
26943 "I<Note:> It is sometimes required that you run L</e2fsck-f> on the C<device> "
26944 "before calling this command. For unknown reasons C<resize2fs> sometimes "
26945 "gives an error about this and sometimes not. In any case, it is always safe "
26946 "to call L</e2fsck-f> before calling this function."
26950 #: ../fish/guestfish-actions.pod:3929
26951 msgid "resize2fs-M"
26955 #: ../fish/guestfish-actions.pod:3931
26958 " resize2fs-M device\n"
26963 #: ../fish/guestfish-actions.pod:3933
26965 "This command is the same as L</resize2fs>, but the filesystem is resized to "
26966 "its minimum size. This works like the I<-M> option to the C<resize2fs> "
26971 #: ../fish/guestfish-actions.pod:3937
26973 "To get the resulting size of the filesystem you should call L</tune2fs-l> "
26974 "and read the C<Block size> and C<Block count> values. These two numbers, "
26975 "multiplied together, give the resulting size of the minimal filesystem in "
26980 #: ../fish/guestfish-actions.pod:3942
26981 msgid "resize2fs-size"
26985 #: ../fish/guestfish-actions.pod:3944
26988 " resize2fs-size device size\n"
26993 #: ../fish/guestfish-actions.pod:3946
26995 "This command is the same as L</resize2fs> except that it allows you to "
26996 "specify the new size (in bytes) explicitly."
27000 #: ../fish/guestfish-actions.pod:3949
27005 #: ../fish/guestfish-actions.pod:3951
27013 #: ../fish/guestfish-actions.pod:3955
27018 #: ../fish/guestfish-actions.pod:3957
27026 #: ../fish/guestfish-actions.pod:3963
27031 #: ../fish/guestfish-actions.pod:3965
27039 #: ../fish/guestfish-actions.pod:3969
27040 msgid "rmmountpoint"
27044 #: ../fish/guestfish-actions.pod:3971
27047 " rmmountpoint exemptpath\n"
27052 #: ../fish/guestfish-actions.pod:3973
27054 "This calls removes a mountpoint that was previously created with L</"
27055 "mkmountpoint>. See L</mkmountpoint> for full details."
27059 #: ../fish/guestfish-actions.pod:3977
27060 msgid "scrub-device"
27064 #: ../fish/guestfish-actions.pod:3979
27067 " scrub-device device\n"
27072 #: ../fish/guestfish-actions.pod:3990
27077 #: ../fish/guestfish-actions.pod:3992
27080 " scrub-file file\n"
27085 #: ../fish/guestfish-actions.pod:4002
27086 msgid "scrub-freespace"
27090 #: ../fish/guestfish-actions.pod:4004
27093 " scrub-freespace dir\n"
27098 #: ../fish/guestfish-actions.pod:4006
27100 "This command creates the directory C<dir> and then fills it with files until "
27101 "the filesystem is full, and scrubs the files as for L</scrub-file>, and "
27102 "deletes them. The intention is to scrub any free space on the partition "
27103 "containing C<dir>."
27107 #: ../fish/guestfish-actions.pod:4015
27112 #: ../fish/guestfish-actions.pod:4017
27117 #: ../fish/guestfish-actions.pod:4019
27120 " set-append append\n"
27125 #: ../fish/guestfish-actions.pod:4030
27126 msgid "set-attach-method"
27130 #: ../fish/guestfish-actions.pod:4032
27131 msgid "attach-method"
27135 #: ../fish/guestfish-actions.pod:4034
27138 " set-attach-method attachmethod\n"
27143 #: ../fish/guestfish-actions.pod:4056
27144 msgid "set-autosync"
27148 #: ../fish/guestfish-actions.pod:4058
27153 #: ../fish/guestfish-actions.pod:4060
27156 " set-autosync true|false\n"
27161 #: ../fish/guestfish-actions.pod:4070
27166 #: ../fish/guestfish-actions.pod:4072
27171 #: ../fish/guestfish-actions.pod:4074
27174 " set-direct true|false\n"
27179 #: ../fish/guestfish-actions.pod:4080
27181 "One consequence of this is that log messages aren't caught by the library "
27182 "and handled by L</set-log-message-callback>, but go straight to stdout."
27186 #: ../fish/guestfish-actions.pod:4089
27187 msgid "set-e2label"
27191 #: ../fish/guestfish-actions.pod:4091
27194 " set-e2label device label\n"
27199 #: ../fish/guestfish-actions.pod:4097
27201 "You can use either L</tune2fs-l> or L</get-e2label> to return the existing "
27202 "label on a filesystem."
27206 #: ../fish/guestfish-actions.pod:4100
27211 #: ../fish/guestfish-actions.pod:4102
27214 " set-e2uuid device uuid\n"
27219 #: ../fish/guestfish-actions.pod:4109
27221 "You can use either L</tune2fs-l> or L</get-e2uuid> to return the existing "
27222 "UUID of a filesystem."
27226 #: ../fish/guestfish-actions.pod:4112
27227 msgid "set-memsize"
27231 #: ../fish/guestfish-actions.pod:4114
27236 #: ../fish/guestfish-actions.pod:4116
27239 " set-memsize memsize\n"
27244 #: ../fish/guestfish-actions.pod:4118
27246 "This sets the memory size in megabytes allocated to the qemu subprocess. "
27247 "This only has any effect if called before L</launch>."
27251 #: ../fish/guestfish-actions.pod:4129
27252 msgid "set-network"
27256 #: ../fish/guestfish-actions.pod:4131
27261 #: ../fish/guestfish-actions.pod:4133
27264 " set-network true|false\n"
27269 #: ../fish/guestfish-actions.pod:4141
27271 "You must call this before calling L</launch>, otherwise it has no effect."
27275 #: ../fish/guestfish-actions.pod:4144
27280 #: ../fish/guestfish-actions.pod:4146
27285 #: ../fish/guestfish-actions.pod:4148
27288 " set-path searchpath\n"
27293 #: ../fish/guestfish-actions.pod:4157
27298 #: ../fish/guestfish-actions.pod:4159
27303 #: ../fish/guestfish-actions.pod:4161
27311 #: ../fish/guestfish-actions.pod:4181
27312 msgid "set-recovery-proc"
27316 #: ../fish/guestfish-actions.pod:4183
27317 msgid "recovery-proc"
27321 #: ../fish/guestfish-actions.pod:4185
27324 " set-recovery-proc true|false\n"
27329 #: ../fish/guestfish-actions.pod:4187
27331 "If this is called with the parameter C<false> then L</launch> does not "
27332 "create a recovery process. The purpose of the recovery process is to stop "
27333 "runaway qemu processes in the case where the main program aborts abruptly."
27337 #: ../fish/guestfish-actions.pod:4192
27339 "This only has any effect if called before L</launch>, and the default is "
27344 #: ../fish/guestfish-actions.pod:4201
27345 msgid "set-selinux"
27349 #: ../fish/guestfish-actions.pod:4203
27354 #: ../fish/guestfish-actions.pod:4205
27357 " set-selinux true|false\n"
27362 #: ../fish/guestfish-actions.pod:4216
27367 #: ../fish/guestfish-actions.pod:4218
27372 #: ../fish/guestfish-actions.pod:4220
27375 " set-trace true|false\n"
27380 #: ../fish/guestfish-actions.pod:4232
27382 "Trace messages are normally sent to C<stderr>, unless you register a "
27383 "callback to send them somewhere else (see L</set-event-callback>)."
27387 #: ../fish/guestfish-actions.pod:4236
27388 msgid "set-verbose"
27392 #: ../fish/guestfish-actions.pod:4238
27397 #: ../fish/guestfish-actions.pod:4240
27400 " set-verbose true|false\n"
27405 #: ../fish/guestfish-actions.pod:4247
27407 "Verbose messages are normally sent to C<stderr>, unless you register a "
27408 "callback to send them somewhere else (see L</set-event-callback>)."
27412 #: ../fish/guestfish-actions.pod:4251
27417 #: ../fish/guestfish-actions.pod:4253
27420 " setcon context\n"
27425 #: ../fish/guestfish-actions.pod:4260
27430 #: ../fish/guestfish-actions.pod:4262
27433 " setxattr xattr val vallen path\n"
27438 #: ../fish/guestfish-actions.pod:4268
27439 msgid "See also: L</lsetxattr>, L<attr(5)>."
27443 #: ../fish/guestfish-actions.pod:4270
27448 #: ../fish/guestfish-actions.pod:4272
27451 " sfdisk device cyls heads sectors 'lines ...'\n"
27456 #: ../fish/guestfish-actions.pod:4294
27457 msgid "See also: L</sfdisk-l>, L</sfdisk-N>, L</part-init>"
27461 #: ../fish/guestfish-actions.pod:4307
27466 #: ../fish/guestfish-actions.pod:4309
27469 " sfdiskM device 'lines ...'\n"
27474 #: ../fish/guestfish-actions.pod:4311
27476 "This is a simplified interface to the L</sfdisk> command, where partition "
27477 "sizes are specified in megabytes only (rounded to the nearest cylinder) and "
27478 "you don't need to specify the cyls, heads and sectors parameters which were "
27479 "rarely if ever used anyway."
27483 #: ../fish/guestfish-actions.pod:4317
27484 msgid "See also: L</sfdisk>, the L<sfdisk(8)> manpage and L</part-disk>"
27488 #: ../fish/guestfish-actions.pod:4330
27493 #: ../fish/guestfish-actions.pod:4332
27496 " sfdisk-N device partnum cyls heads sectors line\n"
27501 #: ../fish/guestfish-actions.pod:4337
27503 "For other parameters, see L</sfdisk>. You should usually pass C<0> for the "
27504 "cyls/heads/sectors parameters."
27508 #: ../fish/guestfish-actions.pod:4340
27509 msgid "See also: L</part-add>"
27513 #: ../fish/guestfish-actions.pod:4352
27514 msgid "sfdisk-disk-geometry"
27518 #: ../fish/guestfish-actions.pod:4354
27521 " sfdisk-disk-geometry device\n"
27526 #: ../fish/guestfish-actions.pod:4356
27528 "This displays the disk geometry of C<device> read from the partition table. "
27529 "Especially in the case where the underlying block device has been resized, "
27530 "this can be different from the kernel's idea of the geometry (see L</sfdisk-"
27531 "kernel-geometry>)."
27535 #: ../fish/guestfish-actions.pod:4364
27536 msgid "sfdisk-kernel-geometry"
27540 #: ../fish/guestfish-actions.pod:4366
27543 " sfdisk-kernel-geometry device\n"
27548 #: ../fish/guestfish-actions.pod:4373
27553 #: ../fish/guestfish-actions.pod:4375
27556 " sfdisk-l device\n"
27561 #: ../fish/guestfish-actions.pod:4381
27562 msgid "See also: L</part-list>"
27566 #: ../fish/guestfish-actions.pod:4390
27571 #: ../fish/guestfish-actions.pod:4392
27579 #: ../fish/guestfish-actions.pod:4397
27580 msgid "This is like L</command>, but passes the command to:"
27584 #: ../fish/guestfish-actions.pod:4405
27585 msgid "All the provisos about L</command> apply to this call."
27589 #: ../fish/guestfish-actions.pod:4407
27594 #: ../fish/guestfish-actions.pod:4409
27597 " sh-lines command\n"
27602 #: ../fish/guestfish-actions.pod:4411
27603 msgid "This is the same as L</sh>, but splits the result into a list of lines."
27607 #: ../fish/guestfish-actions.pod:4414
27608 msgid "See also: L</command-lines>"
27612 #: ../fish/guestfish-actions.pod:4416
27617 #: ../fish/guestfish-actions.pod:4418
27625 #: ../fish/guestfish-actions.pod:4422
27630 #: ../fish/guestfish-actions.pod:4424
27638 #: ../fish/guestfish-actions.pod:4430
27643 #: ../fish/guestfish-actions.pod:4432
27651 #: ../fish/guestfish-actions.pod:4440
27656 #: ../fish/guestfish-actions.pod:4442
27664 #: ../fish/guestfish-actions.pod:4450
27669 #: ../fish/guestfish-actions.pod:4452
27672 " strings-e encoding path\n"
27677 #: ../fish/guestfish-actions.pod:4454
27679 "This is like the L</strings> command, but allows you to specify the encoding "
27680 "of strings that are looked for in the source file C<path>."
27684 #: ../fish/guestfish-actions.pod:4464
27686 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
27687 "ISO-8859-X (this is what L</strings> uses)."
27691 #: ../fish/guestfish-actions.pod:4496
27692 msgid "swapoff-device"
27696 #: ../fish/guestfish-actions.pod:4498
27699 " swapoff-device device\n"
27704 #: ../fish/guestfish-actions.pod:4500
27706 "This command disables the libguestfs appliance swap device or partition "
27707 "named C<device>. See L</swapon-device>."
27711 #: ../fish/guestfish-actions.pod:4504
27712 msgid "swapoff-file"
27716 #: ../fish/guestfish-actions.pod:4506
27719 " swapoff-file file\n"
27724 #: ../fish/guestfish-actions.pod:4510
27725 msgid "swapoff-label"
27729 #: ../fish/guestfish-actions.pod:4512
27732 " swapoff-label label\n"
27737 #: ../fish/guestfish-actions.pod:4517
27738 msgid "swapoff-uuid"
27742 #: ../fish/guestfish-actions.pod:4519
27745 " swapoff-uuid uuid\n"
27750 #: ../fish/guestfish-actions.pod:4524
27751 msgid "swapon-device"
27755 #: ../fish/guestfish-actions.pod:4526
27758 " swapon-device device\n"
27763 #: ../fish/guestfish-actions.pod:4528
27765 "This command enables the libguestfs appliance to use the swap device or "
27766 "partition named C<device>. The increased memory is made available for all "
27767 "commands, for example those run using L</command> or L</sh>."
27771 #: ../fish/guestfish-actions.pod:4540
27772 msgid "swapon-file"
27776 #: ../fish/guestfish-actions.pod:4542
27779 " swapon-file file\n"
27784 #: ../fish/guestfish-actions.pod:4544
27786 "This command enables swap to a file. See L</swapon-device> for other notes."
27790 #: ../fish/guestfish-actions.pod:4547
27791 msgid "swapon-label"
27795 #: ../fish/guestfish-actions.pod:4549
27798 " swapon-label label\n"
27803 #: ../fish/guestfish-actions.pod:4551
27805 "This command enables swap to a labeled swap partition. See L</swapon-"
27806 "device> for other notes."
27810 #: ../fish/guestfish-actions.pod:4554
27811 msgid "swapon-uuid"
27815 #: ../fish/guestfish-actions.pod:4556
27818 " swapon-uuid uuid\n"
27823 #: ../fish/guestfish-actions.pod:4558
27825 "This command enables swap to a swap partition with the given UUID. See L</"
27826 "swapon-device> for other notes."
27830 #: ../fish/guestfish-actions.pod:4561
27835 #: ../fish/guestfish-actions.pod:4563
27843 #: ../fish/guestfish-actions.pod:4571
27848 #: ../fish/guestfish-actions.pod:4573
27856 #: ../fish/guestfish-actions.pod:4581
27861 #: ../fish/guestfish-actions.pod:4583
27864 " tail-n nrlines path\n"
27869 #: ../fish/guestfish-actions.pod:4596
27874 #: ../fish/guestfish-actions.pod:4598
27877 " tar-in (tarfile|-) directory\n"
27882 #: ../fish/guestfish-actions.pod:4603
27883 msgid "To upload a compressed tarball, use L</tgz-in> or L</txz-in>."
27887 #: ../fish/guestfish-actions.pod:4608
27892 #: ../fish/guestfish-actions.pod:4610
27895 " tar-out directory (tarfile|-)\n"
27900 #: ../fish/guestfish-actions.pod:4615
27901 msgid "To download a compressed tarball, use L</tgz-out> or L</txz-out>."
27905 #: ../fish/guestfish-actions.pod:4620
27910 #: ../fish/guestfish-actions.pod:4622
27913 " tgz-in (tarball|-) directory\n"
27918 #: ../fish/guestfish-actions.pod:4627
27919 msgid "To upload an uncompressed tarball, use L</tar-in>."
27923 #: ../fish/guestfish-actions.pod:4631
27928 #: ../fish/guestfish-actions.pod:4633
27931 " tgz-out directory (tarball|-)\n"
27936 #: ../fish/guestfish-actions.pod:4638
27937 msgid "To download an uncompressed tarball, use L</tar-out>."
27941 #: ../fish/guestfish-actions.pod:4642
27946 #: ../fish/guestfish-actions.pod:4644
27954 #: ../fish/guestfish-actions.pod:4653
27959 #: ../fish/guestfish-actions.pod:4655
27967 #: ../fish/guestfish-actions.pod:4660
27968 msgid "truncate-size"
27972 #: ../fish/guestfish-actions.pod:4662
27975 " truncate-size path size\n"
27980 #: ../fish/guestfish-actions.pod:4667
27982 "If the current file size is less than C<size> then the file is extended to "
27983 "the required size with zero bytes. This creates a sparse file (ie. disk "
27984 "blocks are not allocated for the file until you write to it). To create a "
27985 "non-sparse file of zeroes, use L</fallocate64> instead."
27989 #: ../fish/guestfish-actions.pod:4673
27994 #: ../fish/guestfish-actions.pod:4675
27997 " tune2fs-l device\n"
28002 #: ../fish/guestfish-actions.pod:4685
28007 #: ../fish/guestfish-actions.pod:4687
28010 " txz-in (tarball|-) directory\n"
28015 #: ../fish/guestfish-actions.pod:4694
28020 #: ../fish/guestfish-actions.pod:4696
28023 " txz-out directory (tarball|-)\n"
28028 #: ../fish/guestfish-actions.pod:4703
28033 #: ../fish/guestfish-actions.pod:4705
28041 #: ../fish/guestfish-actions.pod:4719
28042 msgid "See also L</get-umask>, L<umask(2)>, L</mknod>, L</mkdir>."
28046 #: ../fish/guestfish-actions.pod:4724
28051 #: ../fish/guestfish-actions.pod:4726
28056 #: ../fish/guestfish-actions.pod:4728
28059 " umount pathordevice\n"
28064 #: ../fish/guestfish-actions.pod:4734
28069 #: ../fish/guestfish-actions.pod:4736
28070 msgid "unmount-all"
28074 #: ../fish/guestfish-actions.pod:4738
28082 #: ../fish/guestfish-actions.pod:4744
28087 #: ../fish/guestfish-actions.pod:4746
28090 " upload (filename|-) remotefilename\n"
28095 #: ../fish/guestfish-actions.pod:4753
28096 msgid "See also L</download>."
28100 #: ../fish/guestfish-actions.pod:4757
28101 msgid "upload-offset"
28105 #: ../fish/guestfish-actions.pod:4759
28108 " upload-offset (filename|-) remotefilename offset\n"
28113 #: ../fish/guestfish-actions.pod:4771
28115 "Note that there is no limit on the amount of data that can be uploaded with "
28116 "this call, unlike with L</pwrite>, and this call always writes the full "
28117 "amount unless an error occurs."
28121 #: ../fish/guestfish-actions.pod:4776
28122 msgid "See also L</upload>, L</pwrite>."
28126 #: ../fish/guestfish-actions.pod:4780
28131 #: ../fish/guestfish-actions.pod:4782
28134 " utimens path atsecs atnsecs mtsecs mtnsecs\n"
28139 #: ../fish/guestfish-actions.pod:4801
28144 #: ../fish/guestfish-actions.pod:4803
28152 #: ../fish/guestfish-actions.pod:4830
28154 "I<Note:> Don't use this call to test for availability of features. In "
28155 "enterprise distributions we backport features from later versions into "
28156 "earlier versions, making this an unreliable way to test for features. Use "
28157 "L</available> instead."
28161 #: ../fish/guestfish-actions.pod:4836
28166 #: ../fish/guestfish-actions.pod:4838
28169 " vfs-label device\n"
28174 #: ../fish/guestfish-actions.pod:4845
28175 msgid "To find a filesystem from the label, use L</findfs-label>."
28179 #: ../fish/guestfish-actions.pod:4847
28184 #: ../fish/guestfish-actions.pod:4849
28187 " vfs-type device\n"
28192 #: ../fish/guestfish-actions.pod:4859
28197 #: ../fish/guestfish-actions.pod:4861
28200 " vfs-uuid device\n"
28205 #: ../fish/guestfish-actions.pod:4868
28206 msgid "To find a filesystem from the UUID, use L</findfs-uuid>."
28210 #: ../fish/guestfish-actions.pod:4870
28211 msgid "vg-activate"
28215 #: ../fish/guestfish-actions.pod:4872
28218 " vg-activate true|false 'volgroups ...'\n"
28223 #: ../fish/guestfish-actions.pod:4882
28224 msgid "vg-activate-all"
28228 #: ../fish/guestfish-actions.pod:4884
28231 " vg-activate-all true|false\n"
28236 #: ../fish/guestfish-actions.pod:4891
28241 #: ../fish/guestfish-actions.pod:4893
28244 " vgcreate volgroup 'physvols ...'\n"
28249 #: ../fish/guestfish-actions.pod:4898
28254 #: ../fish/guestfish-actions.pod:4900
28257 " vglvuuids vgname\n"
28262 #: ../fish/guestfish-actions.pod:4905
28264 "You can use this along with L</lvs> and L</lvuuid> calls to associate "
28265 "logical volumes and volume groups."
28269 #: ../fish/guestfish-actions.pod:4908
28270 msgid "See also L</vgpvuuids>."
28274 #: ../fish/guestfish-actions.pod:4910
28279 #: ../fish/guestfish-actions.pod:4912
28282 " vgpvuuids vgname\n"
28287 #: ../fish/guestfish-actions.pod:4917
28289 "You can use this along with L</pvs> and L</pvuuid> calls to associate "
28290 "physical volumes and volume groups."
28294 #: ../fish/guestfish-actions.pod:4920
28295 msgid "See also L</vglvuuids>."
28299 #: ../fish/guestfish-actions.pod:4922
28304 #: ../fish/guestfish-actions.pod:4924
28307 " vgremove vgname\n"
28312 #: ../fish/guestfish-actions.pod:4931
28317 #: ../fish/guestfish-actions.pod:4933
28320 " vgrename volgroup newvolgroup\n"
28325 #: ../fish/guestfish-actions.pod:4937
28330 #: ../fish/guestfish-actions.pod:4939
28338 #: ../fish/guestfish-actions.pod:4947
28339 msgid "See also L</vgs-full>."
28343 #: ../fish/guestfish-actions.pod:4949
28348 #: ../fish/guestfish-actions.pod:4951
28356 #: ../fish/guestfish-actions.pod:4956
28361 #: ../fish/guestfish-actions.pod:4958
28369 #: ../fish/guestfish-actions.pod:4963
28374 #: ../fish/guestfish-actions.pod:4965
28382 #: ../fish/guestfish-actions.pod:4969
28387 #: ../fish/guestfish-actions.pod:4971
28395 #: ../fish/guestfish-actions.pod:4976
28400 #: ../fish/guestfish-actions.pod:4978
28408 #: ../fish/guestfish-actions.pod:4983
28413 #: ../fish/guestfish-actions.pod:4985
28421 #: ../fish/guestfish-actions.pod:4990
28426 #: ../fish/guestfish-actions.pod:4992
28429 " write path content\n"
28434 #: ../fish/guestfish-actions.pod:5000
28439 #: ../fish/guestfish-actions.pod:5002
28442 " write-file path content size\n"
28447 #: ../fish/guestfish-actions.pod:5025
28452 #: ../fish/guestfish-actions.pod:5027
28455 " zegrep regex path\n"
28460 #: ../fish/guestfish-actions.pod:5035
28465 #: ../fish/guestfish-actions.pod:5037
28468 " zegrepi regex path\n"
28473 #: ../fish/guestfish-actions.pod:5045
28478 #: ../fish/guestfish-actions.pod:5047
28486 #: ../fish/guestfish-actions.pod:5055
28487 msgid "See also: L</zero-device>, L</scrub-device>, L</is-zero-device>"
28491 #: ../fish/guestfish-actions.pod:5058
28492 msgid "zero-device"
28496 #: ../fish/guestfish-actions.pod:5060
28499 " zero-device device\n"
28504 #: ../fish/guestfish-actions.pod:5062
28506 "This command writes zeroes over the entire C<device>. Compare with L</zero> "
28507 "which just zeroes the first few blocks of a device."
28511 #: ../fish/guestfish-actions.pod:5069
28516 #: ../fish/guestfish-actions.pod:5071
28519 " zerofree device\n"
28524 #: ../fish/guestfish-actions.pod:5084
28529 #: ../fish/guestfish-actions.pod:5086
28532 " zfgrep pattern path\n"
28537 #: ../fish/guestfish-actions.pod:5094
28542 #: ../fish/guestfish-actions.pod:5096
28545 " zfgrepi pattern path\n"
28550 #: ../fish/guestfish-actions.pod:5104
28555 #: ../fish/guestfish-actions.pod:5106
28558 " zfile meth path\n"
28563 #: ../fish/guestfish-actions.pod:5113
28565 "Since 1.0.63, use L</file> instead which can now process compressed files."
28569 #: ../fish/guestfish-actions.pod:5123
28574 #: ../fish/guestfish-actions.pod:5125
28577 " zgrep regex path\n"
28582 #: ../fish/guestfish-actions.pod:5133
28587 #: ../fish/guestfish-actions.pod:5135
28590 " zgrepi regex path\n"
28595 #: ../fish/guestfish-commands.pod:1
28600 #: ../fish/guestfish-commands.pod:3
28605 #: ../fish/guestfish-commands.pod:5
28608 " alloc filename size\n"
28613 #: ../fish/guestfish-commands.pod:7
28615 "This creates an empty (zeroed) file of the given size, and then adds so it "
28616 "can be further examined."
28620 #: ../fish/guestfish-commands.pod:10 ../fish/guestfish-commands.pod:182
28621 msgid "For more advanced image creation, see L<qemu-img(1)> utility."
28625 #: ../fish/guestfish-commands.pod:12 ../fish/guestfish-commands.pod:184
28626 msgid "Size can be specified using standard suffixes, eg. C<1M>."
28630 #: ../fish/guestfish-commands.pod:14
28632 "To create a sparse file, use L</sparse> instead. To create a prepared disk "
28633 "image, see L</PREPARED DISK IMAGES>."
28637 #: ../fish/guestfish-commands.pod:17
28642 #: ../fish/guestfish-commands.pod:19
28645 " copy-in local [local ...] /remotedir\n"
28650 #: ../fish/guestfish-commands.pod:21
28652 "C<copy-in> copies local files or directories recursively into the disk "
28653 "image, placing them in the directory called C</remotedir> (which must "
28654 "exist). This guestfish meta-command turns into a sequence of L</tar-in> and "
28655 "other commands as necessary."
28659 #: ../fish/guestfish-commands.pod:26
28661 "Multiple local files and directories can be specified, but the last "
28662 "parameter must always be a remote directory. Wildcards cannot be used."
28666 #: ../fish/guestfish-commands.pod:30
28671 #: ../fish/guestfish-commands.pod:32
28674 " copy-out remote [remote ...] localdir\n"
28679 #: ../fish/guestfish-commands.pod:34
28681 "C<copy-out> copies remote files or directories recursively out of the disk "
28682 "image, placing them on the host disk in a local directory called C<localdir> "
28683 "(which must exist). This guestfish meta-command turns into a sequence of L</"
28684 "download>, L</tar-out> and other commands as necessary."
28688 #: ../fish/guestfish-commands.pod:40
28690 "Multiple remote files and directories can be specified, but the last "
28691 "parameter must always be a local directory. To download to the current "
28692 "directory, use C<.> as in:"
28696 #: ../fish/guestfish-commands.pod:44
28699 " copy-out /home .\n"
28704 #: ../fish/guestfish-commands.pod:46
28706 "Wildcards cannot be used in the ordinary command, but you can use them with "
28707 "the help of L</glob> like this:"
28711 #: ../fish/guestfish-commands.pod:49
28714 " glob copy-out /home/* .\n"
28719 #: ../fish/guestfish-commands.pod:51
28724 #: ../fish/guestfish-commands.pod:53
28727 " display filename\n"
28732 #: ../fish/guestfish-commands.pod:55
28734 "Use C<display> (a graphical display program) to display an image file. It "
28735 "downloads the file, and runs C<display> on it."
28739 #: ../fish/guestfish-commands.pod:58
28741 "To use an alternative program, set the C<GUESTFISH_DISPLAY_IMAGE> "
28742 "environment variable. For example to use the GNOME display program:"
28746 #: ../fish/guestfish-commands.pod:61
28749 " export GUESTFISH_DISPLAY_IMAGE=eog\n"
28754 #: ../fish/guestfish-commands.pod:63
28756 #| msgid "See L<guestfish(1)>."
28757 msgid "See also L<display(1)>."
28758 msgstr "Див. L<guestfish(1)>."
28761 #: ../fish/guestfish-commands.pod:65
28766 #: ../fish/guestfish-commands.pod:67
28769 " echo [params ...]\n"
28774 #: ../fish/guestfish-commands.pod:69
28775 msgid "This echos the parameters to the terminal."
28779 #: ../fish/guestfish-commands.pod:71
28784 #: ../fish/guestfish-commands.pod:73
28789 #: ../fish/guestfish-commands.pod:75
28794 #: ../fish/guestfish-commands.pod:77
28802 #: ../fish/guestfish-commands.pod:79
28804 "This is used to edit a file. It downloads the file, edits it locally using "
28805 "your editor, then uploads the result."
28809 #: ../fish/guestfish-commands.pod:82
28811 "The editor is C<$EDITOR>. However if you use the alternate commands C<vi> "
28812 "or C<emacs> you will get those corresponding editors."
28816 #: ../fish/guestfish-commands.pod:86
28821 #: ../fish/guestfish-commands.pod:88
28824 " glob command args...\n"
28829 #: ../fish/guestfish-commands.pod:90
28831 "Expand wildcards in any paths in the args list, and run C<command> "
28832 "repeatedly on each matching path."
28836 #: ../fish/guestfish-commands.pod:93
28837 msgid "See L</WILDCARDS AND GLOBBING>."
28841 #: ../fish/guestfish-commands.pod:95
28846 #: ../fish/guestfish-commands.pod:97
28849 " hexedit <filename|device>\n"
28850 " hexedit <filename|device> <max>\n"
28851 " hexedit <filename|device> <start> <max>\n"
28856 #: ../fish/guestfish-commands.pod:101
28858 "Use hexedit (a hex editor) to edit all or part of a binary file or block "
28863 #: ../fish/guestfish-commands.pod:104
28865 "This command works by downloading potentially the whole file or device, "
28866 "editing it locally, then uploading it. If the file or device is large, you "
28867 "have to specify which part you wish to edit by using C<max> and/or C<start> "
28868 "C<max> parameters. C<start> and C<max> are specified in bytes, with the "
28869 "usual modifiers allowed such as C<1M> (1 megabyte)."
28873 #: ../fish/guestfish-commands.pod:111
28874 msgid "For example to edit the first few sectors of a disk you might do:"
28878 #: ../fish/guestfish-commands.pod:114
28881 " hexedit /dev/sda 1M\n"
28886 #: ../fish/guestfish-commands.pod:116
28888 "which would allow you to edit anywhere within the first megabyte of the disk."
28892 #: ../fish/guestfish-commands.pod:119
28893 msgid "To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:"
28897 #: ../fish/guestfish-commands.pod:121
28900 " hexedit /dev/sda1 0x400 0x400\n"
28905 #: ../fish/guestfish-commands.pod:123
28906 msgid "(assuming the superblock is in the standard location)."
28910 #: ../fish/guestfish-commands.pod:125
28912 "This command requires the external L<hexedit(1)> program. You can specify "
28913 "another program to use by setting the C<HEXEDITOR> environment variable."
28917 #: ../fish/guestfish-commands.pod:129
28918 msgid "See also L</hexdump>."
28922 #: ../fish/guestfish-commands.pod:131
28927 #: ../fish/guestfish-commands.pod:133
28935 #: ../fish/guestfish-commands.pod:135
28937 "Change the local directory, ie. the current directory of guestfish itself."
28941 #: ../fish/guestfish-commands.pod:138
28942 msgid "Note that C<!cd> won't do what you might expect."
28946 #: ../fish/guestfish-commands.pod:140
28951 #: ../fish/guestfish-commands.pod:142
28956 #: ../fish/guestfish-commands.pod:144
28964 #: ../fish/guestfish-commands.pod:146
28965 msgid "Opens the manual page for guestfish."
28969 #: ../fish/guestfish-commands.pod:148
28974 #: ../fish/guestfish-commands.pod:150
28979 #: ../fish/guestfish-commands.pod:152
28987 #: ../fish/guestfish-commands.pod:154
28995 #: ../fish/guestfish-commands.pod:156
28996 msgid "This is used to view a file."
29000 #: ../fish/guestfish-commands.pod:158
29002 "The default viewer is C<$PAGER>. However if you use the alternate command "
29003 "C<less> you will get the C<less> command specifically."
29007 #: ../fish/guestfish-commands.pod:161
29012 #: ../fish/guestfish-commands.pod:163
29020 #: ../fish/guestfish-commands.pod:165
29022 "Close and reopen the libguestfs handle. It is not necessary to use this "
29023 "normally, because the handle is closed properly when guestfish exits. "
29024 "However this is occasionally useful for testing."
29028 #: ../fish/guestfish-commands.pod:169
29033 #: ../fish/guestfish-commands.pod:171
29036 " sparse filename size\n"
29041 #: ../fish/guestfish-commands.pod:173
29043 "This creates an empty sparse file of the given size, and then adds so it can "
29044 "be further examined."
29048 #: ../fish/guestfish-commands.pod:176
29050 "In all respects it works the same as the L</alloc> command, except that the "
29051 "image file is allocated sparsely, which means that disk blocks are not "
29052 "assigned to the file until they are needed. Sparse disk files only use "
29053 "space when written to, but they are slower and there is a danger you could "
29054 "run out of real disk space during a write operation."
29058 #: ../fish/guestfish-commands.pod:186
29063 #: ../fish/guestfish-commands.pod:188
29071 #: ../fish/guestfish-commands.pod:190
29073 "This command returns a list of the optional groups known to the daemon, and "
29074 "indicates which ones are supported by this build of the libguestfs appliance."
29078 #: ../fish/guestfish-commands.pod:194
29079 msgid "See also L<guestfs(3)/AVAILABILITY>."
29083 #: ../fish/guestfish-commands.pod:196
29088 #: ../fish/guestfish-commands.pod:198
29091 " time command args...\n"
29096 #: ../fish/guestfish-commands.pod:200
29098 "Run the command as usual, but print the elapsed time afterwards. This can "
29099 "be useful for benchmarking operations."
29103 #: ../test-tool/libguestfs-test-tool.pod:5
29104 msgid "libguestfs-test-tool - End user tests for libguestfs"
29108 #: ../test-tool/libguestfs-test-tool.pod:9
29111 " libguestfs-test-tool [--options]\n"
29116 #: ../test-tool/libguestfs-test-tool.pod:13
29118 "libguestfs-test-tool is a test program shipped with libguestfs to end users "
29119 "and developers, to allow them to check basic libguestfs functionality is "
29120 "working. This is needed because libguestfs occasionally breaks for reasons "
29121 "beyond our control: usually because of changes in the underlying qemu or "
29122 "kernel packages, or the host environment."
29126 #: ../test-tool/libguestfs-test-tool.pod:20
29127 msgid "If you suspect a problem in libguestfs, then just run:"
29131 #: ../test-tool/libguestfs-test-tool.pod:22
29134 " libguestfs-test-tool\n"
29139 #: ../test-tool/libguestfs-test-tool.pod:24
29140 msgid "It will print lots of diagnostic messages."
29144 #: ../test-tool/libguestfs-test-tool.pod:26
29145 msgid "If it runs to completion successfully, you will see this near the end:"
29149 #: ../test-tool/libguestfs-test-tool.pod:28
29152 " ===== TEST FINISHED OK =====\n"
29157 #: ../test-tool/libguestfs-test-tool.pod:30
29158 msgid "and the test tool will exit with code 0."
29162 #: ../test-tool/libguestfs-test-tool.pod:32
29164 "If it fails (and/or exits with non-zero error code), please paste the "
29165 "B<complete, unedited> output of the test tool into a bug report. More "
29166 "information about reporting bugs can be found on the L<http://libguestfs.org/"
29171 #: ../test-tool/libguestfs-test-tool.pod:41
29176 #: ../test-tool/libguestfs-test-tool.pod:43
29177 msgid "Display short usage information and exit."
29181 #: ../test-tool/libguestfs-test-tool.pod:45
29182 msgid "I<--qemu qemu_binary>"
29186 #: ../test-tool/libguestfs-test-tool.pod:47
29188 "If you have downloaded another qemu binary, point this option at the full "
29189 "path of the binary to try it."
29193 #: ../test-tool/libguestfs-test-tool.pod:50
29194 msgid "I<--qemudir qemu_source_dir>"
29198 #: ../test-tool/libguestfs-test-tool.pod:52
29200 "If you have compiled qemu from source, point this option at the source "
29201 "directory to try it."
29205 #: ../test-tool/libguestfs-test-tool.pod:55
29206 msgid "I<--timeout N>"
29210 #: ../test-tool/libguestfs-test-tool.pod:57
29212 "Set the launch timeout to C<N> seconds. The default is 120 seconds which "
29213 "does not usually need to be adjusted unless your machine is very slow."
29217 #: ../test-tool/libguestfs-test-tool.pod:63
29218 msgid "TRYING OUT A DIFFERENT VERSION OF QEMU"
29222 #: ../test-tool/libguestfs-test-tool.pod:65
29224 "If you have compiled another version of qemu from source and would like to "
29225 "try that, then you can use the I<--qemudir> option to point to the qemu "
29226 "source directory."
29230 #: ../test-tool/libguestfs-test-tool.pod:69
29232 "If you have downloaded a qemu binary from somewhere, use the I<--qemu> "
29233 "option to point to the binary."
29237 #: ../test-tool/libguestfs-test-tool.pod:72
29239 "When using an alternate qemu with libguestfs, usually you would need to "
29240 "write a qemu wrapper script (see section I<QEMU WRAPPERS> in L<guestfs(3)"
29241 ">). libguestfs-test-tool writes a temporary qemu wrapper script when you "
29242 "use either of the I<--qemudir> or I<--qemu> options."
29246 #: ../test-tool/libguestfs-test-tool.pod:79
29248 "libguestfs-test-tool returns I<0> if the tests completed without error, or "
29249 "I<1> if there was an error."
29253 #: ../test-tool/libguestfs-test-tool.pod:84
29255 "For the full list of environment variables which may affect libguestfs, "
29256 "please see the L<guestfs(3)> manual page."
29260 #: ../test-tool/libguestfs-test-tool.pod:89
29261 msgid "L<guestfs(3)>, L<http://libguestfs.org/>, L<http://qemu.org/>."
29265 #: ../fuse/guestmount.pod:5
29267 "guestmount - Mount a guest filesystem on the host using FUSE and libguestfs"
29271 #: ../fuse/guestmount.pod:9
29274 " guestmount [--options] -a disk.img -m device [--ro] mountpoint\n"
29279 #: ../fuse/guestmount.pod:11
29282 " guestmount [--options] -a disk.img -i [--ro] mountpoint\n"
29287 #: ../fuse/guestmount.pod:13
29290 " guestmount [--options] -d Guest -i [--ro] mountpoint\n"
29295 #: ../fuse/guestmount.pod:17
29297 "You must I<not> use C<guestmount> in read-write mode on live virtual "
29298 "machines. If you do this, you risk disk corruption in the VM."
29302 #: ../fuse/guestmount.pod:22
29304 "The guestmount program can be used to mount virtual machine filesystems and "
29305 "other disk images on the host. It uses libguestfs for access to the guest "
29306 "filesystem, and FUSE (the \"filesystem in userspace\") to make it appear as "
29307 "a mountable device."
29311 #: ../fuse/guestmount.pod:27
29313 "Along with other options, you have to give at least one device (I<-a> "
29314 "option) or libvirt domain (I<-d> option), and at least one mountpoint (I<-m> "
29315 "option) or use the I<-i> inspection option. How this works is better "
29316 "explained in the L<guestfish(1)> manual page, or by looking at the examples "
29321 #: ../fuse/guestmount.pod:33
29323 "FUSE lets you mount filesystems as non-root. The mountpoint must be owned "
29324 "by you, and the filesystem will not be visible to any other users unless you "
29325 "make certain global configuration changes to C</etc/fuse.conf>. To unmount "
29326 "the filesystem, use the C<fusermount -u> command."
29330 #: ../fuse/guestmount.pod:41
29332 "For a typical Windows guest which has its main filesystem on the first "
29337 #: ../fuse/guestmount.pod:44
29340 " guestmount -a windows.img -m /dev/sda1 --ro /mnt\n"
29345 #: ../fuse/guestmount.pod:46
29347 "For a typical Linux guest which has a /boot filesystem on the first "
29348 "partition, and the root filesystem on a logical volume:"
29352 #: ../fuse/guestmount.pod:49
29355 " guestmount -a linux.img -m /dev/VG/LV -m /dev/sda1:/boot --ro /mnt\n"
29360 #: ../fuse/guestmount.pod:51
29361 msgid "To get libguestfs to detect guest mountpoints for you:"
29365 #: ../fuse/guestmount.pod:53
29368 " guestmount -a guest.img -i --ro /mnt\n"
29373 #: ../fuse/guestmount.pod:55
29374 msgid "For a libvirt guest called \"Guest\" you could do:"
29378 #: ../fuse/guestmount.pod:57
29381 " guestmount -d Guest -i --ro /mnt\n"
29386 #: ../fuse/guestmount.pod:59
29388 "If you don't know what filesystems are contained in a guest or disk image, "
29389 "use L<virt-filesystems(1)> first:"
29393 #: ../fuse/guestmount.pod:62
29396 " virt-filesystems MyGuest\n"
29401 #: ../fuse/guestmount.pod:64
29403 "If you want to trace the libguestfs calls but without excessive debugging "
29404 "information, we recommend:"
29408 #: ../fuse/guestmount.pod:67
29411 " guestmount [...] --trace /mnt\n"
29416 #: ../fuse/guestmount.pod:69
29417 msgid "If you want to debug the program, we recommend:"
29421 #: ../fuse/guestmount.pod:71
29424 " guestmount [...] --trace --verbose /mnt\n"
29429 #: ../fuse/guestmount.pod:73
29434 #: ../fuse/guestmount.pod:75
29435 msgid "Other users cannot see the filesystem by default"
29439 #: ../fuse/guestmount.pod:77
29441 "If you mount a filesystem as one user (eg. root), then other users will not "
29442 "be able to see it by default. The fix is to add the FUSE C<allow_other> "
29443 "option when mounting:"
29447 #: ../fuse/guestmount.pod:81
29450 " sudo guestmount [...] -o allow_other /mnt\n"
29455 #: ../fuse/guestmount.pod:87
29456 msgid "B<-a image> | B<--add image>"
29460 #: ../fuse/guestmount.pod:89
29461 msgid "Add a block device or virtual machine image."
29465 #: ../fuse/guestmount.pod:94
29466 msgid "B<-c URI> | B<--connect URI>"
29470 #: ../fuse/guestmount.pod:100
29471 msgid "B<-d libvirt-domain> | B<--domain libvirt-domain>"
29475 #: ../fuse/guestmount.pod:108
29476 msgid "B<--dir-cache-timeout N>"
29480 #: ../fuse/guestmount.pod:110
29482 "Set the readdir cache timeout to I<N> seconds, the default being 60 "
29483 "seconds. The readdir cache [actually, there are several semi-independent "
29484 "caches] is populated after a readdir(2) call with the stat and extended "
29485 "attributes of the files in the directory, in anticipation that they will be "
29486 "requested soon after."
29490 #: ../fuse/guestmount.pod:116
29492 "There is also a different attribute cache implemented by FUSE (see the FUSE "
29493 "option I<-o attr_timeout>), but the FUSE cache does not anticipate future "
29494 "requests, only cache existing ones."
29498 #: ../fuse/guestmount.pod:127
29499 msgid "B<--format=raw|qcow2|..> | B<--format>"
29503 #: ../fuse/guestmount.pod:134
29505 "If you have untrusted raw-format guest disk images, you should use this "
29506 "option to specify the disk format. This avoids a possible security problem "
29507 "with malicious guests (CVE-2010-3851). See also L<guestfs(3)/"
29508 "guestfs_add_drive_opts>."
29512 #: ../fuse/guestmount.pod:139
29513 msgid "B<--fuse-help>"
29517 #: ../fuse/guestmount.pod:141
29518 msgid "Display help on special FUSE options (see I<-o> below)."
29522 #: ../fuse/guestmount.pod:145
29523 msgid "Display brief help and exit."
29527 #: ../fuse/guestmount.pod:147
29528 msgid "B<-i> | B<--inspector>"
29532 #: ../fuse/guestmount.pod:167
29534 "Mount the named partition or logical volume on the given mountpoint B<in the "
29535 "guest> (this has nothing to do with mountpoints in the host)."
29539 #: ../fuse/guestmount.pod:170
29541 "If the mountpoint is omitted, it defaults to C</>. You have to mount "
29542 "something on C</>."
29546 #: ../fuse/guestmount.pod:183
29547 msgid "B<-n> | B<--no-sync>"
29551 #: ../fuse/guestmount.pod:185
29553 "By default, we attempt to sync the guest disk when the FUSE mountpoint is "
29554 "unmounted. If you specify this option, then we don't attempt to sync the "
29555 "disk. See the discussion of autosync in the L<guestfs(3)> manpage."
29559 #: ../fuse/guestmount.pod:190
29560 msgid "B<-o option> | B<--option option>"
29564 #: ../fuse/guestmount.pod:192
29565 msgid "Pass extra options to FUSE."
29569 #: ../fuse/guestmount.pod:194
29571 "To get a list of all the extra options supported by FUSE, use the command "
29572 "below. Note that only the FUSE I<-o> options can be passed, and only some "
29573 "of them are a good idea."
29577 #: ../fuse/guestmount.pod:198
29580 " guestmount --fuse-help\n"
29585 #: ../fuse/guestmount.pod:200
29586 msgid "Some potentially useful FUSE options:"
29590 #: ../fuse/guestmount.pod:204
29591 msgid "B<-o allow_other>"
29595 #: ../fuse/guestmount.pod:206
29596 msgid "Allow other users to see the filesystem."
29600 #: ../fuse/guestmount.pod:208
29601 msgid "B<-o attr_timeout=N>"
29605 #: ../fuse/guestmount.pod:210
29606 msgid "Enable attribute caching by FUSE, and set the timeout to I<N> seconds."
29610 #: ../fuse/guestmount.pod:212
29611 msgid "B<-o kernel_cache>"
29615 #: ../fuse/guestmount.pod:214
29617 "Allow the kernel to cache files (reduces the number of reads that have to go "
29618 "through the L<guestfs(3)> API). This is generally a good idea if you can "
29619 "afford the extra memory usage."
29623 #: ../fuse/guestmount.pod:218
29624 msgid "B<-o uid=N> B<-o gid=N>"
29628 #: ../fuse/guestmount.pod:220
29630 "Use these options to map all UIDs and GIDs inside the guest filesystem to "
29631 "the chosen values."
29635 #: ../fuse/guestmount.pod:225
29636 msgid "B<-r> | B<--ro>"
29640 #: ../fuse/guestmount.pod:227
29642 "Add devices and mount everything read-only. Also disallow writes and make "
29643 "the disk appear read-only to FUSE."
29647 #: ../fuse/guestmount.pod:230
29649 "This is highly recommended if you are not going to edit the guest disk. If "
29650 "the guest is running and this option is I<not> supplied, then there is a "
29651 "strong risk of disk corruption in the guest. We try to prevent this from "
29652 "happening, but it is not always possible."
29656 #: ../fuse/guestmount.pod:235
29657 msgid "See also L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
29661 #: ../fuse/guestmount.pod:239
29662 msgid "Enable SELinux support for the guest."
29666 #: ../fuse/guestmount.pod:241
29667 msgid "B<-v> | B<--verbose>"
29671 #: ../fuse/guestmount.pod:243
29672 msgid "Enable verbose messages from underlying libguestfs."
29676 #: ../fuse/guestmount.pod:245
29677 msgid "B<-V> | B<--version>"
29681 #: ../fuse/guestmount.pod:247
29682 msgid "Display the program version and exit."
29686 #: ../fuse/guestmount.pod:249
29687 msgid "B<-w> | B<--rw>"
29691 #: ../fuse/guestmount.pod:254 ../fuse/guestmount.pod:275
29692 msgid "See L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
29696 #: ../fuse/guestmount.pod:256
29697 msgid "B<-x> | B<--trace>"
29701 #: ../fuse/guestmount.pod:258
29702 msgid "Trace libguestfs calls and entry into each FUSE function."
29706 #: ../fuse/guestmount.pod:260
29707 msgid "This also stops the daemon from forking into the background."
29711 #: ../fuse/guestmount.pod:281
29713 "L<guestfish(1)>, L<virt-inspector(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
29714 "L<virt-tar(1)>, L<guestfs(3)>, L<http://libguestfs.org/>, L<http://fuse.sf."
29719 #: ../fuse/guestmount.pod:296
29720 msgid "Copyright (C) 2009-2010 Red Hat Inc. L<http://libguestfs.org/>"
29724 #: ../tools/virt-win-reg.pl:37
29726 "virt-win-reg - Export and merge Windows Registry entries from a Windows guest"
29730 #: ../tools/virt-win-reg.pl:41
29733 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey'\n"
29738 #: ../tools/virt-win-reg.pl:43
29741 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' name\n"
29746 #: ../tools/virt-win-reg.pl:45
29749 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' @\n"
29754 #: ../tools/virt-win-reg.pl:47
29757 " virt-win-reg --merge domname [input.reg ...]\n"
29762 #: ../tools/virt-win-reg.pl:49
29765 " virt-win-reg [--options] disk.img ... # instead of domname\n"
29770 #: ../tools/virt-win-reg.pl:53
29772 "You must I<not> use C<virt-win-reg> with the I<--merge> option on live "
29773 "virtual machines. If you do this, you I<will> get irreversible disk "
29774 "corruption in the VM. C<virt-win-reg> tries to stop you from doing this, "
29775 "but doesn't catch all cases."
29779 #: ../tools/virt-win-reg.pl:58
29781 "Modifying the Windows Registry is an inherently risky operation. The format "
29782 "is deliberately obscure and undocumented, and Registry changes can leave the "
29783 "system unbootable. Therefore when using the I<--merge> option, make sure "
29784 "you have a reliable backup first."
29788 #: ../tools/virt-win-reg.pl:65
29790 "This program can export and merge Windows Registry entries from a Windows "
29795 #: ../tools/virt-win-reg.pl:68
29797 "The first parameter is the libvirt guest name or the raw disk image of a "
29802 #: ../tools/virt-win-reg.pl:71
29804 "If I<--merge> is I<not> specified, then the chosen registry key is displayed/"
29805 "exported (recursively). For example:"
29809 #: ../tools/virt-win-reg.pl:74
29812 " $ virt-win-reg Windows7 'HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft'\n"
29817 #: ../tools/virt-win-reg.pl:76
29819 "You can also display single values from within registry keys, for example:"
29823 #: ../tools/virt-win-reg.pl:79
29826 " $ cvkey='HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion'\n"
29827 " $ virt-win-reg Windows7 $cvkey ProductName\n"
29828 " Windows 7 Enterprise\n"
29833 #: ../tools/virt-win-reg.pl:83
29835 "With I<--merge>, you can merge a textual regedit file into the Windows "
29840 #: ../tools/virt-win-reg.pl:86
29843 " $ virt-win-reg --merge Windows7 changes.reg\n"
29848 #: ../tools/virt-win-reg.pl:88 ../tools/virt-tar.pl:45
29853 #: ../tools/virt-win-reg.pl:90
29855 "This program is only meant for simple access to the registry. If you want "
29856 "to do complicated things with the registry, we suggest you download the "
29857 "Registry hive files from the guest using L<libguestfs(3)> or L<guestfish(1)> "
29858 "and access them locally, eg. using L<hivex(3)>, L<hivexsh(1)> or "
29859 "L<hivexregedit(1)>."
29863 #: ../tools/virt-win-reg.pl:106 ../tools/virt-list-filesystems.pl:63
29864 #: ../tools/virt-tar.pl:113 ../tools/virt-make-fs.pl:163
29865 #: ../tools/virt-list-partitions.pl:64
29866 msgid "Display brief help."
29870 #: ../tools/virt-win-reg.pl:114 ../tools/virt-list-filesystems.pl:71
29871 #: ../tools/virt-tar.pl:121 ../tools/virt-make-fs.pl:171
29872 #: ../tools/virt-list-partitions.pl:72
29873 msgid "Display version number and exit."
29877 #: ../tools/virt-win-reg.pl:120 ../tools/virt-make-fs.pl:177
29882 #: ../tools/virt-win-reg.pl:122
29883 msgid "Enable debugging messages."
29887 #: ../tools/virt-win-reg.pl:128 ../tools/virt-list-filesystems.pl:77
29888 #: ../tools/virt-tar.pl:127 ../tools/virt-list-partitions.pl:78
29889 msgid "B<--connect URI> | B<-c URI>"
29893 #: ../tools/virt-win-reg.pl:130 ../tools/virt-list-filesystems.pl:79
29894 #: ../tools/virt-tar.pl:129 ../tools/virt-list-partitions.pl:80
29896 "If using libvirt, connect to the given I<URI>. If omitted, then we connect "
29897 "to the default libvirt hypervisor."
29901 #: ../tools/virt-win-reg.pl:133 ../tools/virt-list-filesystems.pl:82
29902 #: ../tools/virt-tar.pl:132 ../tools/virt-list-partitions.pl:83
29904 "If you specify guest block devices directly, then libvirt is not used at all."
29908 #: ../tools/virt-win-reg.pl:140 ../tools/virt-list-filesystems.pl:89
29909 #: ../tools/virt-tar.pl:139 ../tools/virt-list-partitions.pl:90
29910 msgid "B<--format> raw"
29914 #: ../tools/virt-win-reg.pl:142 ../tools/virt-list-filesystems.pl:91
29915 #: ../tools/virt-tar.pl:141 ../tools/virt-list-partitions.pl:92
29917 "Specify the format of disk images given on the command line. If this is "
29918 "omitted then the format is autodetected from the content of the disk image."
29922 #: ../tools/virt-win-reg.pl:146 ../tools/virt-list-filesystems.pl:95
29923 #: ../tools/virt-tar.pl:145 ../tools/virt-list-partitions.pl:96
29925 "If disk images are requested from libvirt, then this program asks libvirt "
29926 "for this information. In this case, the value of the format parameter is "
29931 #: ../tools/virt-win-reg.pl:150 ../tools/virt-list-filesystems.pl:99
29932 #: ../tools/virt-tar.pl:149 ../tools/virt-list-partitions.pl:100
29934 "If working with untrusted raw-format guest disk images, you should ensure "
29935 "the format is always specified."
29939 #: ../tools/virt-win-reg.pl:157
29944 #: ../tools/virt-win-reg.pl:159
29946 "In merge mode, this merges a textual regedit file into the Windows Registry "
29947 "of the virtual machine. If this flag is I<not> given then virt-win-reg "
29948 "displays or exports Registry entries instead."
29952 #: ../tools/virt-win-reg.pl:163
29954 "Note that I<--merge> is I<unsafe> to use on live virtual machines, and will "
29955 "result in disk corruption. However exporting (without this flag) is always "
29960 #: ../tools/virt-win-reg.pl:171
29961 msgid "B<--encoding> UTF-16LE|ASCII"
29965 #: ../tools/virt-win-reg.pl:173
29967 "When merging (only), you may need to specify the encoding for strings to be "
29968 "used in the hive file. This is explained in detail in L<Win::Hivex::Regedit"
29969 "(3)/ENCODING STRINGS>."
29973 #: ../tools/virt-win-reg.pl:177
29975 "The default is to use UTF-16LE, which should work with recent versions of "
29980 #: ../tools/virt-win-reg.pl:184
29981 msgid "B<--unsafe-printable-strings>"
29985 #: ../tools/virt-win-reg.pl:186
29987 "When exporting (only), assume strings are UTF-16LE and print them as strings "
29988 "instead of hex sequences. Remove the final zero codepoint from strings if "
29993 #: ../tools/virt-win-reg.pl:190
29995 "This is unsafe and does not preserve the fidelity of strings in the original "
29996 "Registry for various reasons:"
30000 #: ../tools/virt-win-reg.pl:197
30002 "Assumes the original encoding is UTF-16LE. ASCII strings and strings in "
30003 "other encodings will be corrupted by this transformation."
30007 #: ../tools/virt-win-reg.pl:202
30009 "Assumes that everything which has type 1 or 2 is really a string and that "
30010 "everything else is not a string, but the type field in real Registries is "
30015 #: ../tools/virt-win-reg.pl:208
30017 "Loses information about whether a zero codepoint followed the string in the "
30022 #: ../tools/virt-win-reg.pl:213
30024 "This all happens because the Registry itself contains no information about "
30025 "how strings are encoded (see L<Win::Hivex::Regedit(3)/ENCODING STRINGS>)."
30029 #: ../tools/virt-win-reg.pl:217
30031 "You should only use this option for quick hacking and debugging of the "
30032 "Registry contents, and I<never> use it if the output is going to be passed "
30033 "into another program or stored in another Registry."
30037 #: ../tools/virt-win-reg.pl:554
30038 msgid "SUPPORTED SYSTEMS"
30042 #: ../tools/virt-win-reg.pl:556
30044 "The program currently supports Windows NT-derived guests starting with "
30045 "Windows XP through to at least Windows 7."
30049 #: ../tools/virt-win-reg.pl:559
30050 msgid "The following Registry keys are supported:"
30054 #: ../tools/virt-win-reg.pl:563
30055 msgid "C<HKEY_LOCAL_MACHINE\\SAM>"
30059 #: ../tools/virt-win-reg.pl:565
30060 msgid "C<HKEY_LOCAL_MACHINE\\SECURITY>"
30064 #: ../tools/virt-win-reg.pl:567
30065 msgid "C<HKEY_LOCAL_MACHINE\\SOFTWARE>"
30069 #: ../tools/virt-win-reg.pl:569
30070 msgid "C<HKEY_LOCAL_MACHINE\\SYSTEM>"
30074 #: ../tools/virt-win-reg.pl:571
30075 msgid "C<HKEY_USERS\\.DEFAULT>"
30079 #: ../tools/virt-win-reg.pl:573
30080 msgid "C<HKEY_USERS\\I<SID>>"
30084 #: ../tools/virt-win-reg.pl:575
30085 msgid "where I<SID> is a Windows User SID (eg. C<S-1-5-18>)."
30089 #: ../tools/virt-win-reg.pl:577
30090 msgid "C<HKEY_USERS\\I<username>>"
30094 #: ../tools/virt-win-reg.pl:579
30096 "where I<username> is a local user name (this is a libguestfs extension)."
30100 #: ../tools/virt-win-reg.pl:583
30102 "You can use C<HKLM> as a shorthand for C<HKEY_LOCAL_MACHINE>, and C<HKU> for "
30107 #: ../tools/virt-win-reg.pl:586
30109 "The literal keys C<HKEY_USERS\\$SID> and C<HKEY_CURRENT_USER> are not "
30110 "supported (there is no \"current user\")."
30114 #: ../tools/virt-win-reg.pl:589
30119 #: ../tools/virt-win-reg.pl:591
30121 "C<virt-win-reg> expects that regedit files have already been reencoded in "
30122 "the local encoding. Usually on Linux hosts, this means UTF-8 with Unix-"
30123 "style line endings. Since Windows regedit files are often in UTF-16LE with "
30124 "Windows-style line endings, you may need to reencode the whole file before "
30125 "or after processing."
30129 #: ../tools/virt-win-reg.pl:597
30131 "To reencode a file from Windows format to Linux (before processing it with "
30132 "the I<--merge> option), you would do something like this:"
30136 #: ../tools/virt-win-reg.pl:600
30139 " iconv -f utf-16le -t utf-8 < win.reg | dos2unix > linux.reg\n"
30144 #: ../tools/virt-win-reg.pl:602
30146 "To go in the opposite direction, after exporting and before sending the file "
30147 "to a Windows user, do something like this:"
30151 #: ../tools/virt-win-reg.pl:605
30154 " unix2dos linux.reg | iconv -f utf-8 -t utf-16le > win.reg\n"
30159 #: ../tools/virt-win-reg.pl:607
30160 msgid "For more information about encoding, see L<Win::Hivex::Regedit(3)>."
30164 #: ../tools/virt-win-reg.pl:609
30166 "If you are unsure about the current encoding, use the L<file(1)> command. "
30167 "Recent versions of Windows regedit.exe produce a UTF-16LE file with Windows-"
30168 "style (CRLF) line endings, like this:"
30172 #: ../tools/virt-win-reg.pl:613
30175 " $ file software.reg\n"
30176 " software.reg: Little-endian UTF-16 Unicode text, with very long lines,\n"
30177 " with CRLF line terminators\n"
30182 #: ../tools/virt-win-reg.pl:617
30183 msgid "This file would need conversion before you could I<--merge> it."
30187 #: ../tools/virt-win-reg.pl:619
30188 msgid "CurrentControlSet etc."
30192 #: ../tools/virt-win-reg.pl:621
30194 "Registry keys like C<CurrentControlSet> don't really exist in the Windows "
30195 "Registry at the level of the hive file, and therefore you cannot modify "
30200 #: ../tools/virt-win-reg.pl:625
30202 "C<CurrentControlSet> is usually an alias for C<ControlSet001>. In some "
30203 "circumstances it might refer to another control set. The way to find out is "
30204 "to look at the C<HKLM\\SYSTEM\\Select> key:"
30208 #: ../tools/virt-win-reg.pl:629
30211 " # virt-win-reg WindowsGuest 'HKLM\\SYSTEM\\Select'\n"
30212 " [HKEY_LOCAL_MACHINE\\SYSTEM\\Select]\n"
30213 " \"Current\"=dword:00000001\n"
30214 " \"Default\"=dword:00000001\n"
30215 " \"Failed\"=dword:00000000\n"
30216 " \"LastKnownGood\"=dword:00000002\n"
30221 #: ../tools/virt-win-reg.pl:636
30222 msgid "\"Current\" is the one which Windows will choose when it boots."
30226 #: ../tools/virt-win-reg.pl:638
30228 "Similarly, other C<Current...> keys in the path may need to be replaced."
30232 #: ../tools/virt-win-reg.pl:641
30233 msgid "WINDOWS TIPS"
30237 #: ../tools/virt-win-reg.pl:643
30239 "Note that some of these tips modify the guest disk image. The guest I<must> "
30240 "be shut off, else you will get disk corruption."
30244 #: ../tools/virt-win-reg.pl:646
30245 msgid "RUNNING A BATCH SCRIPT WHEN A USER LOGS IN"
30249 #: ../tools/virt-win-reg.pl:648
30251 "Prepare a DOS batch script, VBScript or executable. Upload this using "
30252 "L<guestfish(1)>. For this example the script is called C<test.bat> and it "
30253 "is uploaded into C<C:\\>:"
30257 #: ../tools/virt-win-reg.pl:652
30260 " guestfish -i -d WindowsGuest upload test.bat /test.bat\n"
30265 #: ../tools/virt-win-reg.pl:654
30266 msgid "Prepare a regedit file containing the registry change:"
30270 #: ../tools/virt-win-reg.pl:656
30273 " cat > test.reg <<'EOF'\n"
30274 " [HKLM\\Software\\Microsoft\\Windows\\CurrentVersion\\RunOnce]\n"
30275 " \"Test\"=\"c:\\\\test.bat\"\n"
30281 #: ../tools/virt-win-reg.pl:661
30283 "In this example we use the key C<RunOnce> which means that the script will "
30284 "run precisely once when the first user logs in. If you want it to run every "
30285 "time a user logs in, replace C<RunOnce> with C<Run>."
30289 #: ../tools/virt-win-reg.pl:665
30290 msgid "Now update the registry:"
30294 #: ../tools/virt-win-reg.pl:667
30297 " virt-win-reg --merge WindowsGuest test.reg\n"
30302 #: ../tools/virt-win-reg.pl:669
30303 msgid "INSTALLING A SERVICE"
30307 #: ../tools/virt-win-reg.pl:671
30309 "This section assumes you are familiar with Windows services, and you either "
30310 "have a program which handles the Windows Service Control Protocol directly "
30311 "or you want to run any program using a service wrapper like SrvAny or the "
30316 #: ../tools/virt-win-reg.pl:676
30318 "First upload the program and optionally the service wrapper. In this case "
30319 "the test program is called C<test.exe> and we are using the RHSrvAny wrapper:"
30323 #: ../tools/virt-win-reg.pl:680
30326 " guestfish -i -d WindowsGuest <<EOF\n"
30327 " upload rhsrvany.exe /rhsrvany.exe\n"
30328 " upload test.exe /test.exe\n"
30334 #: ../tools/virt-win-reg.pl:685
30336 "Prepare a regedit file containing the registry changes. In this example, "
30337 "the first registry change is needed for the service itself or the service "
30338 "wrapper (if used). The second registry change is only needed because I am "
30339 "using the RHSrvAny service wrapper."
30343 #: ../tools/virt-win-reg.pl:690
30346 " cat > service.reg <<'EOF'\n"
30347 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny]\n"
30348 " \"Type\"=dword:00000010\n"
30349 " \"Start\"=dword:00000002\n"
30350 " \"ErrorControl\"=dword:00000001\n"
30351 " \"ImagePath\"=\"c:\\\\rhsrvany.exe\"\n"
30352 " \"DisplayName\"=\"RHSrvAny\"\n"
30353 " \"ObjectName\"=\"NetworkService\"\n"
30358 #: ../tools/virt-win-reg.pl:699
30361 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny\\Parameters]\n"
30362 " \"CommandLine\"=\"c:\\\\test.exe\"\n"
30363 " \"PWD\"=\"c:\\\\Temp\"\n"
30369 #: ../tools/virt-win-reg.pl:710
30371 "For use of C<ControlSet001> see the section above in this manual page. You "
30372 "may need to adjust this according to the control set that is in use by the "
30377 #: ../tools/virt-win-reg.pl:716
30379 "C<\"ObjectName\"> controls the privileges that the service will have. An "
30380 "alternative is C<\"ObjectName\"=\"LocalSystem\"> which would be the most "
30381 "privileged account."
30385 #: ../tools/virt-win-reg.pl:722
30387 "For the meaning of the magic numbers, see this Microsoft KB article: "
30388 "L<http://support.microsoft.com/kb/103000>."
30392 #: ../tools/virt-win-reg.pl:727
30393 msgid "Update the registry:"
30397 #: ../tools/virt-win-reg.pl:729
30400 " virt-win-reg --merge WindowsGuest service.reg\n"
30405 #: ../tools/virt-win-reg.pl:731 ../tools/virt-list-filesystems.pl:182
30406 #: ../tools/virt-tar.pl:279 ../tools/virt-make-fs.pl:532
30407 #: ../tools/virt-list-partitions.pl:250
30408 msgid "SHELL QUOTING"
30412 #: ../tools/virt-win-reg.pl:733
30414 "Be careful when passing parameters containing C<\\> (backslash) in the "
30415 "shell. Usually you will have to use 'single quotes' or double backslashes "
30416 "(but not both) to protect them from the shell."
30420 #: ../tools/virt-win-reg.pl:737
30421 msgid "Paths and value names are case-insensitive."
30425 #: ../tools/virt-win-reg.pl:739 ../tools/virt-list-filesystems.pl:184
30426 #: ../tools/virt-tar.pl:281 ../tools/virt-make-fs.pl:534
30427 #: ../tools/virt-list-partitions.pl:252
30429 "Libvirt guest names can contain arbitrary characters, some of which have "
30430 "meaning to the shell such as C<#> and space. You may need to quote or "
30431 "escape these characters on the command line. See the shell manual page L<sh"
30432 "(1)> for details."
30436 #: ../tools/virt-win-reg.pl:746
30438 "L<hivex(3)>, L<hivexsh(1)>, L<hivexregedit(1)>, L<guestfs(3)>, L<guestfish(1)"
30439 ">, L<virt-cat(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Win::Hivex"
30440 "(3)>, L<Win::Hivex::Regedit(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
30444 #: ../tools/virt-win-reg.pl:761 ../tools/virt-make-fs.pl:555
30446 "When reporting bugs, please enable debugging and capture the I<complete> "
30451 #: ../tools/virt-win-reg.pl:764
30454 " export LIBGUESTFS_DEBUG=1\n"
30455 " virt-win-reg --debug [... rest ...] > /tmp/virt-win-reg.log 2>&1\n"
30460 #: ../tools/virt-win-reg.pl:767
30462 "Attach /tmp/virt-win-reg.log to a new bug report at L<https://bugzilla."
30467 #: ../tools/virt-win-reg.pl:770 ../tools/virt-list-filesystems.pl:202
30468 #: ../tools/virt-tar.pl:301 ../tools/virt-make-fs.pl:564
30469 #: ../tools/virt-list-partitions.pl:269
30474 #: ../tools/virt-win-reg.pl:772 ../tools/virt-list-filesystems.pl:204
30475 #: ../tools/virt-tar.pl:303 ../tools/virt-make-fs.pl:566
30476 #: ../tools/virt-list-partitions.pl:271
30477 msgid "Richard W.M. Jones L<http://people.redhat.com/~rjones/>"
30481 #: ../tools/virt-win-reg.pl:776 ../tools/virt-make-fs.pl:570
30482 msgid "Copyright (C) 2010 Red Hat Inc."
30486 #: ../tools/virt-list-filesystems.pl:32
30488 "virt-list-filesystems - List filesystems in a virtual machine or disk image"
30492 #: ../tools/virt-list-filesystems.pl:36
30495 " virt-list-filesystems [--options] domname\n"
30500 #: ../tools/virt-list-filesystems.pl:38
30503 " virt-list-filesystems [--options] disk.img [disk.img ...]\n"
30508 #: ../tools/virt-list-filesystems.pl:42 ../tools/virt-list-partitions.pl:42
30510 "This tool is obsolete. Use L<virt-filesystems(1)> as a more flexible "
30515 #: ../tools/virt-list-filesystems.pl:45
30517 "C<virt-list-filesystems> is a command line tool to list the filesystems that "
30518 "are contained in a virtual machine or disk image."
30522 #: ../tools/virt-list-filesystems.pl:49
30524 "C<virt-list-filesystems> is just a simple wrapper around L<libguestfs(3)> "
30525 "functionality. For more complex cases you should look at the L<guestfish(1)"
30530 #: ../tools/virt-list-filesystems.pl:106 ../tools/virt-list-partitions.pl:115
30531 msgid "B<-l> | B<--long>"
30535 #: ../tools/virt-list-filesystems.pl:108
30537 "With this option, C<virt-list-filesystems> displays the type of each "
30538 "filesystem too (where \"type\" means C<ext3>, C<xfs> etc.)"
30542 #: ../tools/virt-list-filesystems.pl:115
30543 msgid "B<-a> | B<--all>"
30547 #: ../tools/virt-list-filesystems.pl:117
30549 "Normally we only show mountable filesystems. If this option is given then "
30550 "swap devices are shown too."
30554 #: ../tools/virt-list-filesystems.pl:191
30556 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, L<virt-"
30557 "filesystems(1)>, L<virt-list-partitions(1)>, L<Sys::Guestfs(3)>, L<Sys::"
30558 "Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
30562 #: ../tools/virt-list-filesystems.pl:208 ../tools/virt-tar.pl:307
30563 msgid "Copyright (C) 2009 Red Hat Inc."
30567 #: ../tools/virt-tar.pl:33
30568 msgid "virt-tar - Extract or upload files to a virtual machine"
30572 #: ../tools/virt-tar.pl:37
30575 " virt-tar [--options] -x domname directory tarball\n"
30580 #: ../tools/virt-tar.pl:39
30583 " virt-tar [--options] -u domname tarball directory\n"
30588 #: ../tools/virt-tar.pl:41
30591 " virt-tar [--options] disk.img [disk.img ...] -x directory tarball\n"
30596 #: ../tools/virt-tar.pl:43
30599 " virt-tar [--options] disk.img [disk.img ...] -u tarball directory\n"
30604 #: ../tools/virt-tar.pl:47
30606 "This tool is obsolete. Use L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-"
30607 "tar-in(1)>, L<virt-tar-out(1)> as replacements."
30611 #: ../tools/virt-tar.pl:52
30612 msgid "Download C</home> from the VM into a local tarball:"
30616 #: ../tools/virt-tar.pl:54
30619 " virt-tar -x domname /home home.tar\n"
30624 #: ../tools/virt-tar.pl:56
30627 " virt-tar -zx domname /home home.tar.gz\n"
30632 #: ../tools/virt-tar.pl:58
30633 msgid "Upload a local tarball and unpack it inside C</tmp> in the VM:"
30637 #: ../tools/virt-tar.pl:60
30640 " virt-tar -u domname uploadstuff.tar /tmp\n"
30645 #: ../tools/virt-tar.pl:62
30648 " virt-tar -zu domname uploadstuff.tar.gz /tmp\n"
30653 #: ../tools/virt-tar.pl:66
30655 "You must I<not> use C<virt-tar> with the I<-u> option (upload) on live "
30656 "virtual machines. If you do this, you risk disk corruption in the VM. "
30657 "C<virt-tar> tries to stop you from doing this, but doesn't catch all cases."
30661 #: ../tools/virt-tar.pl:71
30663 "You can use I<-x> (extract) on live virtual machines, but you might get "
30664 "inconsistent results or errors if there is filesystem activity inside the "
30665 "VM. If the live VM is synched and quiescent, then C<virt-tar> will usually "
30666 "work, but the only way to guarantee consistent results is if the virtual "
30667 "machine is shut down."
30671 #: ../tools/virt-tar.pl:79
30673 "C<virt-tar> is a general purpose archive tool for downloading and uploading "
30674 "parts of a guest filesystem. There are many possibilities: making backups, "
30675 "uploading data files, snooping on guest activity, fixing or customizing "
30680 #: ../tools/virt-tar.pl:84
30682 "If you want to just view a single file, use L<virt-cat(1)>. If you just "
30683 "want to edit a single file, use L<virt-edit(1)>. For more complex cases you "
30684 "should look at the L<guestfish(1)> tool."
30688 #: ../tools/virt-tar.pl:88
30690 "There are two modes of operation: I<-x> (eXtract) downloads a directory and "
30691 "its contents (recursively) from the virtual machine into a local tarball. "
30692 "I<-u> uploads from a local tarball, unpacking it into a directory inside the "
30693 "virtual machine. You cannot use these two options together."
30697 #: ../tools/virt-tar.pl:94
30699 "In addition, you may need to use the I<-z> (gZip) option to enable "
30700 "compression. When uploading, you have to specify I<-z> if the upload file "
30701 "is compressed because virt-tar won't detect this on its own."
30705 #: ../tools/virt-tar.pl:98
30707 "C<virt-tar> can only handle tar (optionally gzipped) format tarballs. For "
30708 "example it cannot do PKZip files or bzip2 compression. If you want that "
30709 "then you'll have to rebuild the tarballs yourself. (This is a limitation of "
30710 "the L<libguestfs(3)> API)."
30714 #: ../tools/virt-tar.pl:156
30715 msgid "B<-x> | B<--extract> | B<--download>"
30719 #: ../tools/virt-tar.pl:158
30720 msgid "B<-u> | B<--upload>"
30724 #: ../tools/virt-tar.pl:160
30726 "Use I<-x> to extract (download) a directory from a virtual machine to a "
30731 #: ../tools/virt-tar.pl:163
30733 "Use I<-u> to upload and unpack from a local tarball into a virtual machine. "
30734 "Please read the L</WARNING> section above before using this option."
30738 #: ../tools/virt-tar.pl:167
30739 msgid "You must specify exactly one of these options."
30743 #: ../tools/virt-tar.pl:173
30744 msgid "B<-z> | B<--gzip>"
30748 #: ../tools/virt-tar.pl:175
30749 msgid "Specify that the input or output tarball is gzip-compressed."
30753 #: ../tools/virt-tar.pl:288
30755 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, L<virt-copy-"
30756 "in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<Sys::"
30757 "Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs."
30762 #: ../tools/virt-make-fs.pl:37
30763 msgid "virt-make-fs - Make a filesystem from a tar archive or files"
30767 #: ../tools/virt-make-fs.pl:41
30770 " virt-make-fs [--options] input.tar output.img\n"
30775 #: ../tools/virt-make-fs.pl:43
30778 " virt-make-fs [--options] input.tar.gz output.img\n"
30783 #: ../tools/virt-make-fs.pl:45
30786 " virt-make-fs [--options] directory output.img\n"
30791 #: ../tools/virt-make-fs.pl:49
30793 "Virt-make-fs is a command line tool for creating a filesystem from a tar "
30794 "archive or some files in a directory. It is similar to tools like L<mkisofs"
30795 "(1)>, L<genisoimage(1)> and L<mksquashfs(1)>. Unlike those tools, it can "
30796 "create common filesystem types like ext2/3 or NTFS, which can be useful if "
30797 "you want to attach these filesystems to existing virtual machines (eg. to "
30798 "import large amounts of read-only data to a VM)."
30802 #: ../tools/virt-make-fs.pl:57
30803 msgid "Basic usage is:"
30807 #: ../tools/virt-make-fs.pl:59
30810 " virt-make-fs input output\n"
30815 #: ../tools/virt-make-fs.pl:61
30817 "where C<input> is either a directory containing files that you want to add, "
30818 "or a tar archive (either uncompressed tar or gzip-compressed tar); and "
30819 "C<output> is a disk image. The input type is detected automatically. The "
30820 "output disk image defaults to a raw ext2 image unless you specify extra "
30821 "flags (see L</OPTIONS> below)."
30825 #: ../tools/virt-make-fs.pl:67
30826 msgid "EXTRA SPACE"
30830 #: ../tools/virt-make-fs.pl:69
30832 "Unlike formats such as tar and squashfs, a filesystem does not \"just fit\" "
30833 "the files that it contains, but might have extra space. Depending on how "
30834 "you are going to use the output, you might think this extra space is wasted "
30835 "and want to minimize it, or you might want to leave space so that more files "
30836 "can be added later. Virt-make-fs defaults to minimizing the extra space, "
30837 "but you can use the I<--size> flag to leave space in the filesystem if you "
30842 #: ../tools/virt-make-fs.pl:77
30844 "An alternative way to leave extra space but not make the output image any "
30845 "bigger is to use an alternative disk image format (instead of the default "
30846 "\"raw\" format). Using I<--format=qcow2> will use the native QEmu/KVM qcow2 "
30847 "image format (check your hypervisor supports this before using it). This "
30848 "allows you to choose a large I<--size> but the extra space won't actually be "
30849 "allocated in the image until you try to store something in it."
30853 #: ../tools/virt-make-fs.pl:85
30855 "Don't forget that you can also use local commands including L<resize2fs(8)> "
30856 "and L<virt-resize(1)> to resize existing filesystems, or rerun virt-make-fs "
30857 "to build another image from scratch."
30861 #: ../tools/virt-make-fs.pl:89 ../tools/virt-make-fs.pl:123
30862 #: ../tools/virt-make-fs.pl:142
30867 #: ../tools/virt-make-fs.pl:91
30870 " virt-make-fs --format=qcow2 --size=+200M input output.img\n"
30875 #: ../tools/virt-make-fs.pl:93
30876 msgid "FILESYSTEM TYPE"
30880 #: ../tools/virt-make-fs.pl:95
30882 "The default filesystem type is C<ext2>. Just about any filesystem type that "
30883 "libguestfs supports can be used (but I<not> read-only formats like "
30884 "ISO9660). Here are some of the more common choices:"
30888 #: ../tools/virt-make-fs.pl:101
30893 #: ../tools/virt-make-fs.pl:103
30895 "Note that ext3 filesystems contain a journal, typically 1-32 MB in size. If "
30896 "you are not going to use the filesystem in a way that requires the journal, "
30897 "then this is just wasted overhead."
30901 #: ../tools/virt-make-fs.pl:107
30902 msgid "I<ntfs> or I<vfat>"
30906 #: ../tools/virt-make-fs.pl:109
30907 msgid "Useful if exporting data to a Windows guest."
30911 #: ../tools/virt-make-fs.pl:111
30913 "I<Note for vfat>: The tar archive or local directory must only contain files "
30914 "which are owned by root (ie. UID:GID = 0:0). The reason is that the tar "
30915 "program running within libguestfs is unable to change the ownership of non-"
30916 "root files, since vfat itself does not support this."
30920 #: ../tools/virt-make-fs.pl:116
30925 #: ../tools/virt-make-fs.pl:118
30927 "Lower overhead than C<ext2>, but certain limitations on filename length and "
30928 "total filesystem size."
30932 #: ../tools/virt-make-fs.pl:125
30935 " virt-make-fs --type=minix input minixfs.img\n"
30940 #: ../tools/virt-make-fs.pl:127
30941 msgid "TO PARTITION OR NOT TO PARTITION"
30945 #: ../tools/virt-make-fs.pl:129
30946 msgid "Optionally virt-make-fs can add a partition table to the output disk."
30950 #: ../tools/virt-make-fs.pl:131
30952 "Adding a partition can make the disk image more compatible with certain "
30953 "virtualized operating systems which don't expect to see a filesystem "
30954 "directly located on a block device (Linux doesn't care and will happily "
30955 "handle both types)."
30959 #: ../tools/virt-make-fs.pl:136
30961 "On the other hand, if you have a partition table then the output image is no "
30962 "longer a straight filesystem. For example you cannot run L<fsck(8)> "
30963 "directly on a partitioned disk image. (However libguestfs tools such as "
30964 "L<guestfish(1)> and L<virt-resize(1)> can still be used)."
30968 #: ../tools/virt-make-fs.pl:144
30969 msgid "Add an MBR partition:"
30973 #: ../tools/virt-make-fs.pl:146
30976 " virt-make-fs --partition -- input disk.img\n"
30981 #: ../tools/virt-make-fs.pl:148
30983 "If the output disk image could be terabyte-sized or larger, it's better to "
30984 "use an EFI/GPT-compatible partition table:"
30988 #: ../tools/virt-make-fs.pl:151
30991 " virt-make-fs --partition=gpt --size=+4T --format=qcow2 input disk.img\n"
30996 #: ../tools/virt-make-fs.pl:179
30997 msgid "Enable debugging information."
31001 #: ../tools/virt-make-fs.pl:185
31002 msgid "B<--size=E<lt>NE<gt>>"
31006 #: ../tools/virt-make-fs.pl:187
31007 msgid "B<--size=+E<lt>NE<gt>>"
31011 #: ../tools/virt-make-fs.pl:189
31012 msgid "B<-s E<lt>NE<gt>>"
31016 #: ../tools/virt-make-fs.pl:191
31017 msgid "B<-s +E<lt>NE<gt>>"
31021 #: ../tools/virt-make-fs.pl:193
31023 "Use the I<--size> (or I<-s>) option to choose the size of the output image."
31027 #: ../tools/virt-make-fs.pl:196
31029 "If this option is I<not> given, then the output image will be just large "
31030 "enough to contain all the files, with not much wasted space."
31034 #: ../tools/virt-make-fs.pl:199
31036 "To choose a fixed size output disk, specify an absolute number followed by b/"
31037 "K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
31038 "Petabytes or Exabytes. This must be large enough to contain all the input "
31039 "files, else you will get an error."
31043 #: ../tools/virt-make-fs.pl:204
31045 "To leave extra space, specify C<+> (plus sign) and a number followed by b/K/"
31046 "M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
31047 "Petabytes or Exabytes. For example: I<--size=+200M> means enough space for "
31048 "the input files, and (approximately) an extra 200 MB free space."
31052 #: ../tools/virt-make-fs.pl:210
31054 "Note that virt-make-fs estimates free space, and therefore will not produce "
31055 "filesystems containing precisely the free space requested. (It is much more "
31056 "expensive and time-consuming to produce a filesystem which has precisely the "
31057 "desired free space)."
31061 #: ../tools/virt-make-fs.pl:219
31062 msgid "B<--format=E<lt>fmtE<gt>>"
31066 #: ../tools/virt-make-fs.pl:221
31067 msgid "B<-F E<lt>fmtE<gt>>"
31071 #: ../tools/virt-make-fs.pl:223
31072 msgid "Choose the output disk image format."
31076 #: ../tools/virt-make-fs.pl:225
31077 msgid "The default is C<raw> (raw disk image)."
31081 #: ../tools/virt-make-fs.pl:227
31083 "For other choices, see the L<qemu-img(1)> manpage. The only other choice "
31084 "that would really make sense here is C<qcow2>."
31088 #: ../tools/virt-make-fs.pl:234
31089 msgid "B<--type=E<lt>fsE<gt>>"
31093 #: ../tools/virt-make-fs.pl:236
31094 msgid "B<-t E<lt>fsE<gt>>"
31098 #: ../tools/virt-make-fs.pl:238
31099 msgid "Choose the output filesystem type."
31103 #: ../tools/virt-make-fs.pl:240
31104 msgid "The default is C<ext2>."
31108 #: ../tools/virt-make-fs.pl:242
31110 "Any filesystem which is supported read-write by libguestfs can be used here."
31114 #: ../tools/virt-make-fs.pl:249
31115 msgid "B<--partition>"
31119 #: ../tools/virt-make-fs.pl:251
31120 msgid "B<--partition=E<lt>parttypeE<gt>>"
31124 #: ../tools/virt-make-fs.pl:253
31126 "If specified, this flag adds an MBR partition table to the output disk image."
31130 #: ../tools/virt-make-fs.pl:256
31132 "You can change the partition table type, eg. I<--partition=gpt> for large "
31137 #: ../tools/virt-make-fs.pl:259
31139 "Note that if you just use a lonesome I<--partition>, the Perl option parser "
31140 "might consider the next parameter to be the partition type. For example:"
31144 #: ../tools/virt-make-fs.pl:263
31147 " virt-make-fs --partition input.tar ...\n"
31152 #: ../tools/virt-make-fs.pl:265
31154 "would cause virt-make-fs to think you wanted to use a partition type of "
31155 "C<input.tar> which is completely wrong. To avoid this, use I<--> (a double "
31156 "dash) between options and the input file argument:"
31160 #: ../tools/virt-make-fs.pl:269
31163 " virt-make-fs --partition -- input.tar ...\n"
31168 #: ../tools/virt-make-fs.pl:541
31170 "L<guestfish(1)>, L<virt-resize(1)>, L<virt-tar-in(1)>, L<mkisofs(1)>, "
31171 "L<genisoimage(1)>, L<mksquashfs(1)>, L<mke2fs(8)>, L<resize2fs(8)>, L<guestfs"
31172 "(3)>, L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
31176 #: ../tools/virt-make-fs.pl:558
31179 " export LIBGUESTFS_DEBUG=1\n"
31180 " virt-make-fs --debug [...] > /tmp/virt-make-fs.log 2>&1\n"
31185 #: ../tools/virt-make-fs.pl:561
31187 "Attach /tmp/virt-make-fs.log to a new bug report at L<https://bugzilla."
31192 #: ../tools/virt-list-partitions.pl:32
31194 "virt-list-partitions - List partitions in a virtual machine or disk image"
31198 #: ../tools/virt-list-partitions.pl:36
31201 " virt-list-partitions [--options] domname\n"
31206 #: ../tools/virt-list-partitions.pl:38
31209 " virt-list-partitions [--options] disk.img [disk.img ...]\n"
31214 #: ../tools/virt-list-partitions.pl:45
31216 "C<virt-list-partitions> is a command line tool to list the partitions that "
31217 "are contained in a virtual machine or disk image. It is mainly useful as a "
31218 "first step to using L<virt-resize(1)>."
31222 #: ../tools/virt-list-partitions.pl:50
31224 "C<virt-list-partitions> is just a simple wrapper around L<libguestfs(3)> "
31225 "functionality. For more complex cases you should look at the L<guestfish(1)"
31230 #: ../tools/virt-list-partitions.pl:107
31231 msgid "B<-h> | B<--human-readable>"
31235 #: ../tools/virt-list-partitions.pl:109
31236 msgid "Show sizes in human-readable form (eg. \"1G\")."
31240 #: ../tools/virt-list-partitions.pl:117
31242 "With this option, C<virt-list-partitions> displays the type and size of each "
31243 "partition too (where \"type\" means C<ext3>, C<pv> etc.)"
31247 #: ../tools/virt-list-partitions.pl:124
31248 msgid "B<-t> | B<--total>"
31252 #: ../tools/virt-list-partitions.pl:126
31254 "Display the total size of each block device (as a separate row or rows)."
31258 #: ../tools/virt-list-partitions.pl:259
31260 "L<guestfs(3)>, L<guestfish(1)>, L<virt-filesystems(1)>, L<virt-list-"
31261 "filesystems(1)>, L<virt-resize(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib"
31262 "(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
31266 #: ../tools/virt-list-partitions.pl:275
31267 msgid "Copyright (C) 2009-2010 Red Hat Inc."