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-06-28 19:35+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:2967 ../src/guestfs.pod:2971 ../src/guestfs.pod:2975
868 #: ../src/guestfs.pod:2979 ../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:2783 ../src/guestfs-actions.pod:2789
881 #: ../src/guestfs-actions.pod:2797 ../src/guestfs-actions.pod:2804
882 #: ../src/guestfs-actions.pod:2811 ../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:2779
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:5951
5141 #: ../fish/guestfish-actions.pod:3958
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
5178 #: ../src/guestfs.pod:2663
5179 msgid "Outside contributions, experimental parts."
5183 #: ../src/guestfs.pod:2665
5188 #: ../src/guestfs.pod:2667
5190 "The daemon that runs inside the libguestfs appliance and carries out actions."
5194 #: ../src/guestfs.pod:2670
5199 #: ../src/guestfs.pod:2672
5200 msgid "L<virt-df(1)> command and documentation."
5204 #: ../src/guestfs.pod:2674
5209 #: ../src/guestfs.pod:2676
5210 msgid "L<virt-edit(1)> command and documentation."
5214 #: ../src/guestfs.pod:2678
5216 msgstr "C<examples>"
5219 #: ../src/guestfs.pod:2680
5220 msgid "C API example code."
5221 msgstr "Код прикладів використання програмного інтерфейсу мовою C."
5224 #: ../src/guestfs.pod:2682
5229 #: ../src/guestfs.pod:2684
5231 "L<guestfish(1)>, the command-line shell, and various shell scripts built on "
5232 "top such as L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, "
5233 "L<virt-tar-out(1)>."
5237 #: ../src/guestfs.pod:2688
5242 #: ../src/guestfs.pod:2690
5244 "L<guestmount(1)>, FUSE (userspace filesystem) built on top of libguestfs."
5248 #: ../src/guestfs.pod:2692
5249 msgid "C<generator>"
5250 msgstr "C<generator>"
5253 #: ../src/guestfs.pod:2694
5255 "The crucially important generator, used to automatically generate large "
5256 "amounts of boilerplate C code for things like RPC and bindings."
5260 #: ../src/guestfs.pod:2697
5265 #: ../src/guestfs.pod:2699
5266 msgid "Files used by the test suite."
5270 #: ../src/guestfs.pod:2701
5271 msgid "Some \"phony\" guest images which we test against."
5275 #: ../src/guestfs.pod:2703
5276 msgid "C<inspector>"
5277 msgstr "C<inspector>"
5280 #: ../src/guestfs.pod:2705
5281 msgid "L<virt-inspector(1)>, the virtual machine image inspector."
5285 #: ../src/guestfs.pod:2707
5290 #: ../src/guestfs.pod:2709
5291 msgid "Logo used on the website. The fish is called Arthur by the way."
5295 #: ../src/guestfs.pod:2711
5300 #: ../src/guestfs.pod:2713
5301 msgid "M4 macros used by autoconf."
5305 #: ../src/guestfs.pod:2715
5310 #: ../src/guestfs.pod:2717
5311 msgid "Translations of simple gettext strings."
5312 msgstr "Переклади простих рядків gettext."
5315 #: ../src/guestfs.pod:2719
5320 #: ../src/guestfs.pod:2721
5322 "The build infrastructure and PO files for translations of manpages and POD "
5323 "files. Eventually this will be combined with the C<po> directory, but that "
5324 "is rather complicated."
5328 #: ../src/guestfs.pod:2725
5329 msgid "C<regressions>"
5330 msgstr "C<regressions>"
5333 #: ../src/guestfs.pod:2727
5334 msgid "Regression tests."
5335 msgstr "Тести на регресії."
5338 #: ../src/guestfs.pod:2729
5343 #: ../src/guestfs.pod:2731
5344 msgid "L<virt-rescue(1)> command and documentation."
5348 #: ../src/guestfs.pod:2733
5353 #: ../src/guestfs.pod:2735
5354 msgid "Source code to the C library."
5358 #: ../src/guestfs.pod:2737
5363 #: ../src/guestfs.pod:2739
5364 msgid "Command line tools written in Perl (L<virt-resize(1)> and many others)."
5368 #: ../src/guestfs.pod:2741
5369 msgid "C<test-tool>"
5370 msgstr "C<test-tool>"
5373 #: ../src/guestfs.pod:2743
5375 "Test tool for end users to test if their qemu/kernel combination will work "
5380 #: ../src/guestfs.pod:2746
5385 #: ../src/guestfs.pod:2748
5390 #: ../src/guestfs.pod:2750
5395 #: ../src/guestfs.pod:2752
5400 #: ../src/guestfs.pod:2754
5405 #: ../src/guestfs.pod:2756
5410 #: ../src/guestfs.pod:2758
5415 #: ../src/guestfs.pod:2760
5420 #: ../src/guestfs.pod:2762
5421 msgid "Language bindings."
5422 msgstr "Прив’язки до мов програмування."
5425 #: ../src/guestfs.pod:2766
5430 #: ../src/guestfs.pod:2768
5431 msgid "PROTOCOL LIMITS"
5435 #: ../src/guestfs.pod:2770
5437 "Internally libguestfs uses a message-based protocol to pass API calls and "
5438 "their responses to and from a small \"appliance\" (see L</INTERNALS> for "
5439 "plenty more detail about this). The maximum message size used by the "
5440 "protocol is slightly less than 4 MB. For some API calls you may need to be "
5441 "aware of this limit. The API calls which may be affected are individually "
5442 "documented, with a link back to this section of the documentation."
5446 #: ../src/guestfs.pod:2778
5448 "A simple call such as L</guestfs_cat> returns its result (the file data) in "
5449 "a simple string. Because this string is at some point internally encoded as "
5450 "a message, the maximum size that it can return is slightly under 4 MB. If "
5451 "the requested file is larger than this then you will get an error."
5455 #: ../src/guestfs.pod:2784
5457 "In order to transfer large files into and out of the guest filesystem, you "
5458 "need to use particular calls that support this. The sections L</UPLOADING> "
5459 "and L</DOWNLOADING> document how to do this."
5463 #: ../src/guestfs.pod:2788
5465 "You might also consider mounting the disk image using our FUSE filesystem "
5466 "support (L<guestmount(1)>)."
5470 #: ../src/guestfs.pod:2791
5471 msgid "MAXIMUM NUMBER OF DISKS"
5475 #: ../src/guestfs.pod:2793
5476 msgid "When using virtio disks (the default) the current limit is B<25> disks."
5480 #: ../src/guestfs.pod:2796
5482 "Virtio itself consumes 1 virtual PCI slot per disk, and PCI is limited to 31 "
5483 "slots. However febootstrap only understands disks with names C</dev/vda> "
5484 "through C</dev/vdz> (26 letters) and it reserves one disk for its own "
5489 #: ../src/guestfs.pod:2801
5491 "We are working to substantially raise this limit in future versions but it "
5492 "requires complex changes to qemu."
5496 #: ../src/guestfs.pod:2804
5498 "In future versions of libguestfs it should also be possible to \"hot plug\" "
5499 "disks (add and remove disks after calling L</guestfs_launch>). This also "
5500 "requires changes to qemu."
5504 #: ../src/guestfs.pod:2808
5505 msgid "MAXIMUM NUMBER OF PARTITIONS PER DISK"
5509 #: ../src/guestfs.pod:2810
5510 msgid "Virtio limits the maximum number of partitions per disk to B<15>."
5514 #: ../src/guestfs.pod:2812
5516 "This is because it reserves 4 bits for the minor device number (thus C</dev/"
5517 "vda>, and C</dev/vda1> through C</dev/vda15>)."
5521 #: ../src/guestfs.pod:2815
5523 "If you attach a disk with more than 15 partitions, the extra partitions are "
5524 "ignored by libguestfs."
5528 #: ../src/guestfs.pod:2818
5529 msgid "MAXIMUM SIZE OF A DISK"
5533 #: ../src/guestfs.pod:2820
5534 msgid "Probably the limit is between 2**63-1 and 2**64-1 bytes."
5538 #: ../src/guestfs.pod:2822
5540 "We have tested block devices up to 1 exabyte (2**60 or "
5541 "1,152,921,504,606,846,976 bytes) using sparse files backed by an XFS host "
5546 #: ../src/guestfs.pod:2826
5548 "Although libguestfs probably does not impose any limit, the underlying host "
5549 "storage will. If you store disk images on a host ext4 filesystem, then the "
5550 "maximum size will be limited by the maximum ext4 file size (currently 16 "
5551 "TB). If you store disk images as host logical volumes then you are limited "
5552 "by the maximum size of an LV."
5556 #: ../src/guestfs.pod:2832
5558 "For the hugest disk image files, we recommend using XFS on the host for "
5563 #: ../src/guestfs.pod:2835
5564 msgid "MAXIMUM SIZE OF A PARTITION"
5568 #: ../src/guestfs.pod:2837
5570 "The MBR (ie. classic MS-DOS) partitioning scheme uses 32 bit sector "
5571 "numbers. Assuming a 512 byte sector size, this means that MBR cannot "
5572 "address a partition located beyond 2 TB on the disk."
5576 #: ../src/guestfs.pod:2841
5578 "It is recommended that you use GPT partitions on disks which are larger than "
5579 "this size. GPT uses 64 bit sector numbers and so can address partitions "
5580 "which are theoretically larger than the largest disk we could support."
5584 #: ../src/guestfs.pod:2846
5585 msgid "MAXIMUM SIZE OF A FILESYSTEM, FILES, DIRECTORIES"
5589 #: ../src/guestfs.pod:2848
5591 "This depends on the filesystem type. libguestfs itself does not impose any "
5592 "known limit. Consult Wikipedia or the filesystem documentation to find out "
5593 "what these limits are."
5597 #: ../src/guestfs.pod:2852
5598 msgid "MAXIMUM UPLOAD AND DOWNLOAD"
5602 #: ../src/guestfs.pod:2854
5604 "The API functions L</guestfs_upload>, L</guestfs_download>, L</"
5605 "guestfs_tar_in>, L</guestfs_tar_out> and the like allow unlimited sized "
5606 "uploads and downloads."
5610 #: ../src/guestfs.pod:2858
5612 #| msgid "INSPECTION"
5613 msgid "INSPECTION LIMITS"
5617 #: ../src/guestfs.pod:2860
5619 "The inspection code has several arbitrary limits on things like the size of "
5620 "Windows Registry hive it will read, and the length of product name. These "
5621 "are intended to stop a malicious guest from consuming arbitrary amounts of "
5622 "memory and disk space on the host, and should not be reached in practice. "
5623 "See the source code for more information."
5627 #: ../src/guestfs.pod:2866 ../fish/guestfish.pod:1017
5628 #: ../test-tool/libguestfs-test-tool.pod:82
5629 msgid "ENVIRONMENT VARIABLES"
5630 msgstr "ЗМІННІ СЕРЕДОВИЩА"
5633 #: ../src/guestfs.pod:2870 ../fish/guestfish.pod:1048
5634 msgid "LIBGUESTFS_APPEND"
5638 #: ../src/guestfs.pod:2872 ../fish/guestfish.pod:1050
5639 msgid "Pass additional options to the guest kernel."
5643 #: ../src/guestfs.pod:2874 ../fish/guestfish.pod:1052
5644 msgid "LIBGUESTFS_DEBUG"
5648 #: ../src/guestfs.pod:2876
5650 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
5651 "effect as calling C<guestfs_set_verbose (g, 1)>."
5655 #: ../src/guestfs.pod:2879 ../fish/guestfish.pod:1057
5656 msgid "LIBGUESTFS_MEMSIZE"
5660 #: ../src/guestfs.pod:2881 ../fish/guestfish.pod:1059
5662 "Set the memory allocated to the qemu process, in megabytes. For example:"
5666 #: ../src/guestfs.pod:2884 ../fish/guestfish.pod:1062
5669 " LIBGUESTFS_MEMSIZE=700\n"
5674 #: ../src/guestfs.pod:2886 ../fish/guestfish.pod:1064
5675 msgid "LIBGUESTFS_PATH"
5679 #: ../src/guestfs.pod:2888
5681 "Set the path that libguestfs uses to search for a supermin appliance. See "
5682 "the discussion of paths in section L</PATH> above."
5686 #: ../src/guestfs.pod:2891 ../fish/guestfish.pod:1069
5687 msgid "LIBGUESTFS_QEMU"
5691 #: ../src/guestfs.pod:2893 ../fish/guestfish.pod:1071
5693 "Set the default qemu binary that libguestfs uses. If not set, then the qemu "
5694 "which was found at compile time by the configure script is used."
5698 #: ../src/guestfs.pod:2897
5699 msgid "See also L</QEMU WRAPPERS> above."
5703 #: ../src/guestfs.pod:2899 ../fish/guestfish.pod:1075
5704 msgid "LIBGUESTFS_TRACE"
5708 #: ../src/guestfs.pod:2901
5710 "Set C<LIBGUESTFS_TRACE=1> to enable command traces. This has the same "
5711 "effect as calling C<guestfs_set_trace (g, 1)>."
5715 #: ../src/guestfs.pod:2904 ../fish/guestfish.pod:1084
5720 #: ../src/guestfs.pod:2906 ../fish/guestfish.pod:1086
5722 "Location of temporary directory, defaults to C</tmp> except for the cached "
5723 "supermin appliance which defaults to C</var/tmp>."
5727 #: ../src/guestfs.pod:2909 ../fish/guestfish.pod:1089
5729 "If libguestfs was compiled to use the supermin appliance then the real "
5730 "appliance is cached in this directory, shared between all handles belonging "
5731 "to the same EUID. You can use C<$TMPDIR> to configure another directory to "
5732 "use in case C</var/tmp> is not large enough."
5736 #: ../src/guestfs.pod:2917 ../fish/guestfish.pod:1156
5737 #: ../test-tool/libguestfs-test-tool.pod:87 ../fuse/guestmount.pod:279
5738 #: ../tools/virt-win-reg.pl:744 ../tools/virt-list-filesystems.pl:189
5739 #: ../tools/virt-tar.pl:286 ../tools/virt-make-fs.pl:539
5740 #: ../tools/virt-list-partitions.pl:257
5742 msgstr "ТАКОЖ ПЕРЕГЛЯНЬТЕ"
5745 #: ../src/guestfs.pod:2919
5747 "L<guestfs-examples(3)>, L<guestfs-ocaml(3)>, L<guestfs-python(3)>, L<guestfs-"
5748 "ruby(3)>, L<guestfish(1)>, L<guestmount(1)>, L<virt-cat(1)>, L<virt-copy-in"
5749 "(1)>, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, L<virt-filesystems"
5750 "(1)>, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, L<virt-list-"
5751 "partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, L<virt-rescue(1)>, L<virt-"
5752 "tar(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<virt-win-reg(1)>, L<qemu(1)"
5753 ">, L<febootstrap(1)>, L<hivex(3)>, L<http://libguestfs.org/>."
5757 #: ../src/guestfs.pod:2946
5759 "Tools with a similar purpose: L<fdisk(8)>, L<parted(8)>, L<kpartx(8)>, L<lvm"
5760 "(8)>, L<disktype(1)>."
5764 #: ../src/guestfs.pod:2953 ../tools/virt-win-reg.pl:759
5765 #: ../tools/virt-make-fs.pl:553
5770 #: ../src/guestfs.pod:2955
5771 msgid "To get a list of bugs against libguestfs use this link:"
5773 "Щоб переглянути список відомих вад у libguestfs, скористайтеся таким "
5777 #: ../src/guestfs.pod:2957
5779 "L<https://bugzilla.redhat.com/buglist.cgi?"
5780 "component=libguestfs&product=Virtualization+Tools>"
5782 "L<https://bugzilla.redhat.com/buglist.cgi?"
5783 "component=libguestfs&product=Virtualization+Tools>"
5786 #: ../src/guestfs.pod:2959
5787 msgid "To report a new bug against libguestfs use this link:"
5788 msgstr "Для звітування щодо вад у libguestfs скористайтеся цим посиланням:"
5791 #: ../src/guestfs.pod:2961
5793 "L<https://bugzilla.redhat.com/enter_bug.cgi?"
5794 "component=libguestfs&product=Virtualization+Tools>"
5796 "L<https://bugzilla.redhat.com/enter_bug.cgi?"
5797 "component=libguestfs&product=Virtualization+Tools>"
5800 #: ../src/guestfs.pod:2963
5801 msgid "When reporting a bug, please check:"
5805 #: ../src/guestfs.pod:2969
5806 msgid "That the bug hasn't been reported already."
5810 #: ../src/guestfs.pod:2973
5811 msgid "That you are testing a recent version."
5815 #: ../src/guestfs.pod:2977
5816 msgid "Describe the bug accurately, and give a way to reproduce it."
5820 #: ../src/guestfs.pod:2981
5822 "Run libguestfs-test-tool and paste the B<complete, unedited> output into the "
5827 #: ../src/guestfs.pod:2986 ../fish/guestfish.pod:1180
5828 #: ../test-tool/libguestfs-test-tool.pod:93 ../fuse/guestmount.pod:290
5833 #: ../src/guestfs.pod:2988 ../fish/guestfish.pod:1182
5834 #: ../test-tool/libguestfs-test-tool.pod:95 ../fuse/guestmount.pod:292
5835 msgid "Richard W.M. Jones (C<rjones at redhat dot com>)"
5839 #: ../src/guestfs.pod:2990 ../fish/guestfish.pod:1184
5840 #: ../test-tool/libguestfs-test-tool.pod:97 ../fuse/guestmount.pod:294
5841 #: ../tools/virt-win-reg.pl:774 ../tools/virt-list-filesystems.pl:206
5842 #: ../tools/virt-tar.pl:305 ../tools/virt-make-fs.pl:568
5843 #: ../tools/virt-list-partitions.pl:273
5845 msgstr "АВТОРСЬКІ ПРАВА"
5848 #: ../src/guestfs.pod:2992 ../fish/guestfish.pod:1186
5849 #: ../test-tool/libguestfs-test-tool.pod:99
5850 msgid "Copyright (C) 2009-2011 Red Hat Inc. L<http://libguestfs.org/>"
5854 #: ../src/guestfs.pod:2995
5856 "This library is free software; you can redistribute it and/or modify it "
5857 "under the terms of the GNU Lesser General Public License as published by the "
5858 "Free Software Foundation; either version 2 of the License, or (at your "
5859 "option) any later version."
5863 #: ../src/guestfs.pod:3000
5865 "This library is distributed in the hope that it will be useful, but WITHOUT "
5866 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
5867 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License "
5872 #: ../src/guestfs.pod:3005
5874 "You should have received a copy of the GNU Lesser General Public License "
5875 "along with this library; if not, write to the Free Software Foundation, "
5876 "Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA"
5880 #: ../src/guestfs-actions.pod:1
5881 msgid "guestfs_add_cdrom"
5885 #: ../src/guestfs-actions.pod:3
5889 " guestfs_add_cdrom (guestfs_h *g,\n"
5890 " const char *filename);\n"
5895 #: ../src/guestfs-actions.pod:7 ../fish/guestfish-actions.pod:5
5896 msgid "This function adds a virtual CD-ROM disk image to the guest."
5900 #: ../src/guestfs-actions.pod:9 ../fish/guestfish-actions.pod:7
5901 msgid "This is equivalent to the qemu parameter I<-cdrom filename>."
5905 #: ../src/guestfs-actions.pod:17
5907 "This call checks for the existence of C<filename>. This stops you from "
5908 "specifying other types of drive which are supported by qemu such as C<nbd:> "
5909 "and C<http:> URLs. To specify those, use the general C<guestfs_config> call "
5914 #: ../src/guestfs-actions.pod:24
5916 "If you just want to add an ISO file (often you use this as an efficient way "
5917 "to transfer large files into the guest), then you should probably use "
5918 "C<guestfs_add_drive_ro> instead."
5922 #: ../src/guestfs-actions.pod:30 ../src/guestfs-actions.pod:140
5923 #: ../src/guestfs-actions.pod:201 ../src/guestfs-actions.pod:238
5924 #: ../src/guestfs-actions.pod:252 ../src/guestfs-actions.pod:273
5925 #: ../src/guestfs-actions.pod:293 ../src/guestfs-actions.pod:307
5926 #: ../src/guestfs-actions.pod:422 ../src/guestfs-actions.pod:442
5927 #: ../src/guestfs-actions.pod:456 ../src/guestfs-actions.pod:501
5928 #: ../src/guestfs-actions.pod:529 ../src/guestfs-actions.pod:547
5929 #: ../src/guestfs-actions.pod:614 ../src/guestfs-actions.pod:647
5930 #: ../src/guestfs-actions.pod:661 ../src/guestfs-actions.pod:676
5931 #: ../src/guestfs-actions.pod:775 ../src/guestfs-actions.pod:793
5932 #: ../src/guestfs-actions.pod:807 ../src/guestfs-actions.pod:821
5933 #: ../src/guestfs-actions.pod:982 ../src/guestfs-actions.pod:1002
5934 #: ../src/guestfs-actions.pod:1020 ../src/guestfs-actions.pod:1104
5935 #: ../src/guestfs-actions.pod:1122 ../src/guestfs-actions.pod:1141
5936 #: ../src/guestfs-actions.pod:1155 ../src/guestfs-actions.pod:1175
5937 #: ../src/guestfs-actions.pod:1245 ../src/guestfs-actions.pod:1276
5938 #: ../src/guestfs-actions.pod:1301 ../src/guestfs-actions.pod:1343
5939 #: ../src/guestfs-actions.pod:1449 ../src/guestfs-actions.pod:1483
5940 #: ../src/guestfs-actions.pod:1698 ../src/guestfs-actions.pod:1720
5941 #: ../src/guestfs-actions.pod:1807 ../src/guestfs-actions.pod:2269
5942 #: ../src/guestfs-actions.pod:2413 ../src/guestfs-actions.pod:2474
5943 #: ../src/guestfs-actions.pod:2509 ../src/guestfs-actions.pod:3529
5944 #: ../src/guestfs-actions.pod:3544 ../src/guestfs-actions.pod:3569
5945 #: ../src/guestfs-actions.pod:3736 ../src/guestfs-actions.pod:3750
5946 #: ../src/guestfs-actions.pod:3763 ../src/guestfs-actions.pod:3777
5947 #: ../src/guestfs-actions.pod:3792 ../src/guestfs-actions.pod:3828
5948 #: ../src/guestfs-actions.pod:3900 ../src/guestfs-actions.pod:3920
5949 #: ../src/guestfs-actions.pod:3937 ../src/guestfs-actions.pod:3960
5950 #: ../src/guestfs-actions.pod:3983 ../src/guestfs-actions.pod:4015
5951 #: ../src/guestfs-actions.pod:4034 ../src/guestfs-actions.pod:4053
5952 #: ../src/guestfs-actions.pod:4088 ../src/guestfs-actions.pod:4100
5953 #: ../src/guestfs-actions.pod:4136 ../src/guestfs-actions.pod:4152
5954 #: ../src/guestfs-actions.pod:4165 ../src/guestfs-actions.pod:4180
5955 #: ../src/guestfs-actions.pod:4197 ../src/guestfs-actions.pod:4290
5956 #: ../src/guestfs-actions.pod:4310 ../src/guestfs-actions.pod:4323
5957 #: ../src/guestfs-actions.pod:4374 ../src/guestfs-actions.pod:4392
5958 #: ../src/guestfs-actions.pod:4410 ../src/guestfs-actions.pod:4426
5959 #: ../src/guestfs-actions.pod:4440 ../src/guestfs-actions.pod:4454
5960 #: ../src/guestfs-actions.pod:4471 ../src/guestfs-actions.pod:4486
5961 #: ../src/guestfs-actions.pod:4506 ../src/guestfs-actions.pod:4564
5962 #: ../src/guestfs-actions.pod:4637 ../src/guestfs-actions.pod:4668
5963 #: ../src/guestfs-actions.pod:4687 ../src/guestfs-actions.pod:4706
5964 #: ../src/guestfs-actions.pod:4718 ../src/guestfs-actions.pod:4735
5965 #: ../src/guestfs-actions.pod:4748 ../src/guestfs-actions.pod:4763
5966 #: ../src/guestfs-actions.pod:4778 ../src/guestfs-actions.pod:4813
5967 #: ../src/guestfs-actions.pod:4846 ../src/guestfs-actions.pod:4883
5968 #: ../src/guestfs-actions.pod:4903 ../src/guestfs-actions.pod:4917
5969 #: ../src/guestfs-actions.pod:4934 ../src/guestfs-actions.pod:4983
5970 #: ../src/guestfs-actions.pod:5020 ../src/guestfs-actions.pod:5034
5971 #: ../src/guestfs-actions.pod:5062 ../src/guestfs-actions.pod:5079
5972 #: ../src/guestfs-actions.pod:5097 ../src/guestfs-actions.pod:5231
5973 #: ../src/guestfs-actions.pod:5288 ../src/guestfs-actions.pod:5310
5974 #: ../src/guestfs-actions.pod:5328 ../src/guestfs-actions.pod:5360
5975 #: ../src/guestfs-actions.pod:5426 ../src/guestfs-actions.pod:5443
5976 #: ../src/guestfs-actions.pod:5456 ../src/guestfs-actions.pod:5470
5977 #: ../src/guestfs-actions.pod:5759 ../src/guestfs-actions.pod:5778
5978 #: ../src/guestfs-actions.pod:5797 ../src/guestfs-actions.pod:5809
5979 #: ../src/guestfs-actions.pod:5821 ../src/guestfs-actions.pod:5835
5980 #: ../src/guestfs-actions.pod:5847 ../src/guestfs-actions.pod:5861
5981 #: ../src/guestfs-actions.pod:5877 ../src/guestfs-actions.pod:5898
5982 #: ../src/guestfs-actions.pod:5917 ../src/guestfs-actions.pod:5936
5983 #: ../src/guestfs-actions.pod:5966 ../src/guestfs-actions.pod:5982
5984 #: ../src/guestfs-actions.pod:6005 ../src/guestfs-actions.pod:6023
5985 #: ../src/guestfs-actions.pod:6042 ../src/guestfs-actions.pod:6063
5986 #: ../src/guestfs-actions.pod:6082 ../src/guestfs-actions.pod:6099
5987 #: ../src/guestfs-actions.pod:6127 ../src/guestfs-actions.pod:6151
5988 #: ../src/guestfs-actions.pod:6170 ../src/guestfs-actions.pod:6194
5989 #: ../src/guestfs-actions.pod:6213 ../src/guestfs-actions.pod:6228
5990 #: ../src/guestfs-actions.pod:6247 ../src/guestfs-actions.pod:6284
5991 #: ../src/guestfs-actions.pod:6314 ../src/guestfs-actions.pod:6347
5992 #: ../src/guestfs-actions.pod:6469 ../src/guestfs-actions.pod:6590
5993 #: ../src/guestfs-actions.pod:6602 ../src/guestfs-actions.pod:6615
5994 #: ../src/guestfs-actions.pod:6628 ../src/guestfs-actions.pod:6650
5995 #: ../src/guestfs-actions.pod:6663 ../src/guestfs-actions.pod:6676
5996 #: ../src/guestfs-actions.pod:6689 ../src/guestfs-actions.pod:6704
5997 #: ../src/guestfs-actions.pod:6763 ../src/guestfs-actions.pod:6780
5998 #: ../src/guestfs-actions.pod:6796 ../src/guestfs-actions.pod:6812
5999 #: ../src/guestfs-actions.pod:6829 ../src/guestfs-actions.pod:6842
6000 #: ../src/guestfs-actions.pod:6862 ../src/guestfs-actions.pod:6898
6001 #: ../src/guestfs-actions.pod:6912 ../src/guestfs-actions.pod:6953
6002 #: ../src/guestfs-actions.pod:6966 ../src/guestfs-actions.pod:6984
6003 #: ../src/guestfs-actions.pod:7018 ../src/guestfs-actions.pod:7054
6004 #: ../src/guestfs-actions.pod:7173 ../src/guestfs-actions.pod:7191
6005 #: ../src/guestfs-actions.pod:7205 ../src/guestfs-actions.pod:7260
6006 #: ../src/guestfs-actions.pod:7273 ../src/guestfs-actions.pod:7318
6007 #: ../src/guestfs-actions.pod:7351 ../src/guestfs-actions.pod:7412
6008 #: ../src/guestfs-actions.pod:7438 ../src/guestfs-actions.pod:7505
6009 #: ../src/guestfs-actions.pod:7524 ../src/guestfs-actions.pod:7553
6010 msgid "This function returns 0 on success or -1 on error."
6014 #: ../src/guestfs-actions.pod:32 ../src/guestfs-actions.pod:254
6015 #: ../src/guestfs-actions.pod:275 ../fish/guestfish-actions.pod:28
6016 #: ../fish/guestfish-actions.pod:163 ../fish/guestfish-actions.pod:177
6018 "This function is deprecated. In new code, use the C<add_drive_opts> call "
6023 #: ../src/guestfs-actions.pod:35 ../src/guestfs-actions.pod:257
6024 #: ../src/guestfs-actions.pod:278 ../src/guestfs-actions.pod:1454
6025 #: ../src/guestfs-actions.pod:1947 ../src/guestfs-actions.pod:1968
6026 #: ../src/guestfs-actions.pod:4511 ../src/guestfs-actions.pod:4818
6027 #: ../src/guestfs-actions.pod:6292 ../src/guestfs-actions.pod:6322
6028 #: ../src/guestfs-actions.pod:6355 ../src/guestfs-actions.pod:6414
6029 #: ../src/guestfs-actions.pod:7356 ../src/guestfs-actions.pod:7446
6030 #: ../src/guestfs-actions.pod:7616 ../fish/guestfish-actions.pod:31
6031 #: ../fish/guestfish-actions.pod:166 ../fish/guestfish-actions.pod:180
6032 #: ../fish/guestfish-actions.pod:961 ../fish/guestfish-actions.pod:1321
6033 #: ../fish/guestfish-actions.pod:1335 ../fish/guestfish-actions.pod:3038
6034 #: ../fish/guestfish-actions.pod:3235 ../fish/guestfish-actions.pod:4220
6035 #: ../fish/guestfish-actions.pod:4243 ../fish/guestfish-actions.pod:4265
6036 #: ../fish/guestfish-actions.pod:4303 ../fish/guestfish-actions.pod:4944
6037 #: ../fish/guestfish-actions.pod:5042
6039 "Deprecated functions will not be removed from the API, but the fact that "
6040 "they are deprecated indicates that there are problems with correct use of "
6045 #: ../src/guestfs-actions.pod:39 ../src/guestfs-actions.pod:142
6046 #: ../src/guestfs-actions.pod:1106 ../src/guestfs-actions.pod:1919
6047 #: ../src/guestfs-actions.pod:2017 ../src/guestfs-actions.pod:2120
6048 #: ../src/guestfs-actions.pod:3531 ../src/guestfs-actions.pod:3551
6049 #: ../src/guestfs-actions.pod:4822 ../src/guestfs-actions.pod:5984
6050 #: ../src/guestfs-actions.pod:6101 ../src/guestfs-actions.pod:6215
6051 #: ../src/guestfs-actions.pod:6706 ../src/guestfs-actions.pod:6831
6052 #: ../src/guestfs-actions.pod:7360
6053 msgid "(Added in 0.3)"
6057 #: ../src/guestfs-actions.pod:41
6058 msgid "guestfs_add_domain"
6062 #: ../src/guestfs-actions.pod:43
6066 " guestfs_add_domain (guestfs_h *g,\n"
6067 " const char *dom,\n"
6073 #: ../src/guestfs-actions.pod:48 ../src/guestfs-actions.pod:151
6074 #: ../src/guestfs-actions.pod:2750 ../src/guestfs-actions.pod:4525
6075 #: ../src/guestfs-actions.pod:4832
6077 "You may supply a list of optional arguments to this call. Use zero or more "
6078 "of the following pairs of parameters, and terminate the list with C<-1> on "
6079 "its own. See L</CALLS WITH OPTIONAL ARGUMENTS>."
6083 #: ../src/guestfs-actions.pod:53
6086 " GUESTFS_ADD_DOMAIN_LIBVIRTURI, const char *libvirturi,\n"
6087 " GUESTFS_ADD_DOMAIN_READONLY, int readonly,\n"
6088 " GUESTFS_ADD_DOMAIN_IFACE, const char *iface,\n"
6089 " GUESTFS_ADD_DOMAIN_LIVE, int live,\n"
6090 " GUESTFS_ADD_DOMAIN_ALLOWUUID, int allowuuid,\n"
6095 #: ../src/guestfs-actions.pod:59
6097 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
6098 "It works by connecting to libvirt, requesting the domain and domain XML from "
6099 "libvirt, parsing it for disks, and calling C<guestfs_add_drive_opts> on each "
6104 #: ../src/guestfs-actions.pod:64 ../fish/guestfish-actions.pod:46
6106 "The number of disks added is returned. This operation is atomic: if an "
6107 "error is returned, then no disks are added."
6111 #: ../src/guestfs-actions.pod:67 ../fish/guestfish-actions.pod:49
6113 "This function does some minimal checks to make sure the libvirt domain is "
6114 "not running (unless C<readonly> is true). In a future version we will try "
6115 "to acquire the libvirt lock on each disk."
6119 #: ../src/guestfs-actions.pod:71 ../fish/guestfish-actions.pod:53
6121 "Disks must be accessible locally. This often means that adding disks from a "
6122 "remote libvirt connection (see L<http://libvirt.org/remote.html>) will fail "
6123 "unless those disks are accessible via the same device path locally too."
6127 #: ../src/guestfs-actions.pod:76 ../fish/guestfish-actions.pod:58
6129 "The optional C<libvirturi> parameter sets the libvirt URI (see L<http://"
6130 "libvirt.org/uri.html>). If this is not set then we connect to the default "
6131 "libvirt URI (or one set through an environment variable, see the libvirt "
6132 "documentation for full details)."
6136 #: ../src/guestfs-actions.pod:82 ../fish/guestfish-actions.pod:64
6138 "The optional C<live> flag controls whether this call will try to connect to "
6139 "a running virtual machine C<guestfsd> process if it sees a suitable "
6140 "E<lt>channelE<gt> element in the libvirt XML definition. The default (if "
6141 "the flag is omitted) is never to try. See L<guestfs(3)/ATTACHING TO RUNNING "
6142 "DAEMONS> for more information."
6146 #: ../src/guestfs-actions.pod:89 ../fish/guestfish-actions.pod:71
6148 "If the C<allowuuid> flag is true (default is false) then a UUID I<may> be "
6149 "passed instead of the domain name. The C<dom> string is treated as a UUID "
6150 "first and looked up, and if that lookup fails then we treat C<dom> as a name "
6155 #: ../src/guestfs-actions.pod:94
6157 "The other optional parameters are passed directly through to "
6158 "C<guestfs_add_drive_opts>."
6162 #: ../src/guestfs-actions.pod:97 ../src/guestfs-actions.pod:350
6163 #: ../src/guestfs-actions.pod:515 ../src/guestfs-actions.pod:693
6164 #: ../src/guestfs-actions.pod:724 ../src/guestfs-actions.pod:742
6165 #: ../src/guestfs-actions.pod:761 ../src/guestfs-actions.pod:1321
6166 #: ../src/guestfs-actions.pod:1677 ../src/guestfs-actions.pod:1880
6167 #: ../src/guestfs-actions.pod:1989 ../src/guestfs-actions.pod:2029
6168 #: ../src/guestfs-actions.pod:2084 ../src/guestfs-actions.pod:2107
6169 #: ../src/guestfs-actions.pod:2400 ../src/guestfs-actions.pod:2866
6170 #: ../src/guestfs-actions.pod:2884 ../src/guestfs-actions.pod:5006
6171 #: ../src/guestfs-actions.pod:5134 ../src/guestfs-actions.pod:5540
6172 #: ../src/guestfs-actions.pod:5566 ../src/guestfs-actions.pod:6939
6173 #: ../src/guestfs-actions.pod:7371 ../src/guestfs-actions.pod:7384
6174 #: ../src/guestfs-actions.pod:7397
6175 msgid "On error this function returns -1."
6179 #: ../src/guestfs-actions.pod:99
6180 msgid "(Added in 1.7.4)"
6184 #: ../src/guestfs-actions.pod:101
6185 msgid "guestfs_add_domain_va"
6189 #: ../src/guestfs-actions.pod:103
6193 " guestfs_add_domain_va (guestfs_h *g,\n"
6194 " const char *dom,\n"
6200 #: ../src/guestfs-actions.pod:108
6201 msgid "This is the \"va_list variant\" of L</guestfs_add_domain>."
6205 #: ../src/guestfs-actions.pod:110 ../src/guestfs-actions.pod:121
6206 #: ../src/guestfs-actions.pod:214 ../src/guestfs-actions.pod:225
6207 #: ../src/guestfs-actions.pod:2832 ../src/guestfs-actions.pod:2844
6208 #: ../src/guestfs-actions.pod:4578 ../src/guestfs-actions.pod:4590
6209 #: ../src/guestfs-actions.pod:4858 ../src/guestfs-actions.pod:4870
6210 msgid "See L</CALLS WITH OPTIONAL ARGUMENTS>."
6214 #: ../src/guestfs-actions.pod:112
6215 msgid "guestfs_add_domain_argv"
6219 #: ../src/guestfs-actions.pod:114
6223 " guestfs_add_domain_argv (guestfs_h *g,\n"
6224 " const char *dom,\n"
6225 " const struct guestfs_add_domain_argv *optargs);\n"
6230 #: ../src/guestfs-actions.pod:119
6231 msgid "This is the \"argv variant\" of L</guestfs_add_domain>."
6235 #: ../src/guestfs-actions.pod:123
6236 msgid "guestfs_add_drive"
6240 #: ../src/guestfs-actions.pod:125
6244 " guestfs_add_drive (guestfs_h *g,\n"
6245 " const char *filename);\n"
6250 #: ../src/guestfs-actions.pod:129
6252 "This function is the equivalent of calling C<guestfs_add_drive_opts> with no "
6253 "optional parameters, so the disk is added writable, with the format being "
6254 "detected automatically."
6258 #: ../src/guestfs-actions.pod:133
6260 "Automatic detection of the format opens you up to a potential security hole "
6261 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
6262 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
6263 "you should think about replacing calls to this function with calls to "
6264 "C<guestfs_add_drive_opts>, and specifying the format."
6268 #: ../src/guestfs-actions.pod:144
6269 msgid "guestfs_add_drive_opts"
6273 #: ../src/guestfs-actions.pod:146
6277 " guestfs_add_drive_opts (guestfs_h *g,\n"
6278 " const char *filename,\n"
6284 #: ../src/guestfs-actions.pod:156
6287 " GUESTFS_ADD_DRIVE_OPTS_READONLY, int readonly,\n"
6288 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, const char *format,\n"
6289 " GUESTFS_ADD_DRIVE_OPTS_IFACE, const char *iface,\n"
6294 #: ../src/guestfs-actions.pod:160 ../fish/guestfish-actions.pod:102
6296 "This function adds a virtual machine disk image C<filename> to libguestfs. "
6297 "The first time you call this function, the disk appears as C</dev/sda>, the "
6298 "second time as C</dev/sdb>, and so on."
6302 #: ../src/guestfs-actions.pod:165 ../fish/guestfish-actions.pod:107
6304 "You don't necessarily need to be root when using libguestfs. However you "
6305 "obviously do need sufficient permissions to access the filename for whatever "
6306 "operations you want to perform (ie. read access if you just want to read the "
6307 "image or write access if you want to modify the image)."
6311 #: ../src/guestfs-actions.pod:171 ../fish/guestfish-actions.pod:113
6312 msgid "This call checks that C<filename> exists."
6316 #: ../src/guestfs-actions.pod:173 ../src/guestfs-actions.pod:4536
6317 #: ../fish/guestfish-actions.pod:115 ../fish/guestfish-actions.pod:3049
6318 msgid "The optional arguments are:"
6322 #: ../src/guestfs-actions.pod:177 ../fish/guestfish-actions.pod:119
6324 msgstr "C<readonly>"
6327 #: ../src/guestfs-actions.pod:179 ../fish/guestfish-actions.pod:121
6329 "If true then the image is treated as read-only. Writes are still allowed, "
6330 "but they are stored in a temporary snapshot overlay which is discarded at "
6331 "the end. The disk that you add is not modified."
6335 #: ../src/guestfs-actions.pod:183 ../fish/guestfish-actions.pod:125
6340 #: ../src/guestfs-actions.pod:185
6342 "This forces the image format. If you omit this (or use C<guestfs_add_drive> "
6343 "or C<guestfs_add_drive_ro>) then the format is automatically detected. "
6344 "Possible formats include C<raw> and C<qcow2>."
6348 #: ../src/guestfs-actions.pod:189 ../fish/guestfish-actions.pod:131
6350 "Automatic detection of the format opens you up to a potential security hole "
6351 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
6352 "RHBZ#642934. Specifying the format closes this security hole."
6356 #: ../src/guestfs-actions.pod:194 ../fish/guestfish-actions.pod:136
6361 #: ../src/guestfs-actions.pod:196
6363 "This rarely-used option lets you emulate the behaviour of the deprecated "
6364 "C<guestfs_add_drive_with_if> call (q.v.)"
6368 #: ../src/guestfs-actions.pod:203
6369 msgid "(Added in 1.5.23)"
6373 #: ../src/guestfs-actions.pod:205
6374 msgid "guestfs_add_drive_opts_va"
6378 #: ../src/guestfs-actions.pod:207
6382 " guestfs_add_drive_opts_va (guestfs_h *g,\n"
6383 " const char *filename,\n"
6389 #: ../src/guestfs-actions.pod:212
6390 msgid "This is the \"va_list variant\" of L</guestfs_add_drive_opts>."
6394 #: ../src/guestfs-actions.pod:216
6395 msgid "guestfs_add_drive_opts_argv"
6399 #: ../src/guestfs-actions.pod:218
6403 " guestfs_add_drive_opts_argv (guestfs_h *g,\n"
6404 " const char *filename,\n"
6405 " const struct guestfs_add_drive_opts_argv *optargs);\n"
6410 #: ../src/guestfs-actions.pod:223
6411 msgid "This is the \"argv variant\" of L</guestfs_add_drive_opts>."
6415 #: ../src/guestfs-actions.pod:227
6416 msgid "guestfs_add_drive_ro"
6420 #: ../src/guestfs-actions.pod:229
6424 " guestfs_add_drive_ro (guestfs_h *g,\n"
6425 " const char *filename);\n"
6430 #: ../src/guestfs-actions.pod:233
6432 "This function is the equivalent of calling C<guestfs_add_drive_opts> with "
6433 "the optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the "
6434 "disk is added read-only, with the format being detected automatically."
6438 #: ../src/guestfs-actions.pod:240
6439 msgid "(Added in 1.0.38)"
6443 #: ../src/guestfs-actions.pod:242
6444 msgid "guestfs_add_drive_ro_with_if"
6448 #: ../src/guestfs-actions.pod:244
6452 " guestfs_add_drive_ro_with_if (guestfs_h *g,\n"
6453 " const char *filename,\n"
6454 " const char *iface);\n"
6459 #: ../src/guestfs-actions.pod:249
6461 "This is the same as C<guestfs_add_drive_ro> but it allows you to specify the "
6462 "QEMU interface emulation to use at run time."
6466 #: ../src/guestfs-actions.pod:261 ../src/guestfs-actions.pod:282
6467 #: ../src/guestfs-actions.pod:2359
6468 msgid "(Added in 1.0.84)"
6472 #: ../src/guestfs-actions.pod:263
6473 msgid "guestfs_add_drive_with_if"
6477 #: ../src/guestfs-actions.pod:265
6481 " guestfs_add_drive_with_if (guestfs_h *g,\n"
6482 " const char *filename,\n"
6483 " const char *iface);\n"
6488 #: ../src/guestfs-actions.pod:270
6490 "This is the same as C<guestfs_add_drive> but it allows you to specify the "
6491 "QEMU interface emulation to use at run time."
6495 #: ../src/guestfs-actions.pod:284
6496 msgid "guestfs_aug_clear"
6500 #: ../src/guestfs-actions.pod:286
6504 " guestfs_aug_clear (guestfs_h *g,\n"
6505 " const char *augpath);\n"
6510 #: ../src/guestfs-actions.pod:290 ../fish/guestfish-actions.pod:188
6512 "Set the value associated with C<path> to C<NULL>. This is the same as the "
6513 "L<augtool(1)> C<clear> command."
6517 #: ../src/guestfs-actions.pod:295 ../src/guestfs-actions.pod:2109
6518 msgid "(Added in 1.3.4)"
6522 #: ../src/guestfs-actions.pod:297
6523 msgid "guestfs_aug_close"
6527 #: ../src/guestfs-actions.pod:299
6531 " guestfs_aug_close (guestfs_h *g);\n"
6536 #: ../src/guestfs-actions.pod:302
6538 "Close the current Augeas handle and free up any resources used by it. After "
6539 "calling this, you have to call C<guestfs_aug_init> again before you can use "
6540 "any other Augeas functions."
6544 #: ../src/guestfs-actions.pod:309 ../src/guestfs-actions.pod:334
6545 #: ../src/guestfs-actions.pod:352 ../src/guestfs-actions.pod:366
6546 #: ../src/guestfs-actions.pod:424 ../src/guestfs-actions.pod:444
6547 #: ../src/guestfs-actions.pod:458 ../src/guestfs-actions.pod:489
6548 #: ../src/guestfs-actions.pod:503 ../src/guestfs-actions.pod:517
6549 #: ../src/guestfs-actions.pod:531 ../src/guestfs-actions.pod:549
6550 #: ../src/guestfs-actions.pod:5617
6551 msgid "(Added in 0.7)"
6555 #: ../src/guestfs-actions.pod:311
6556 msgid "guestfs_aug_defnode"
6560 #: ../src/guestfs-actions.pod:313
6563 " struct guestfs_int_bool *\n"
6564 " guestfs_aug_defnode (guestfs_h *g,\n"
6565 " const char *name,\n"
6566 " const char *expr,\n"
6567 " const char *val);\n"
6572 #: ../src/guestfs-actions.pod:319 ../fish/guestfish-actions.pod:204
6574 "Defines a variable C<name> whose value is the result of evaluating C<expr>."
6578 #: ../src/guestfs-actions.pod:322
6580 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
6581 "calling C<guestfs_aug_set> C<expr>, C<value>. C<name> will be the nodeset "
6582 "containing that single node."
6586 #: ../src/guestfs-actions.pod:326 ../fish/guestfish-actions.pod:211
6588 "On success this returns a pair containing the number of nodes in the "
6589 "nodeset, and a boolean flag if a node was created."
6593 #: ../src/guestfs-actions.pod:330
6595 "This function returns a C<struct guestfs_int_bool *>, or NULL if there was "
6596 "an error. I<The caller must call C<guestfs_free_int_bool> after use>."
6600 #: ../src/guestfs-actions.pod:336
6601 msgid "guestfs_aug_defvar"
6605 #: ../src/guestfs-actions.pod:338
6609 " guestfs_aug_defvar (guestfs_h *g,\n"
6610 " const char *name,\n"
6611 " const char *expr);\n"
6616 #: ../src/guestfs-actions.pod:343 ../fish/guestfish-actions.pod:219
6618 "Defines an Augeas variable C<name> whose value is the result of evaluating "
6619 "C<expr>. If C<expr> is NULL, then C<name> is undefined."
6623 #: ../src/guestfs-actions.pod:347 ../fish/guestfish-actions.pod:223
6625 "On success this returns the number of nodes in C<expr>, or C<0> if C<expr> "
6626 "evaluates to something which is not a nodeset."
6630 #: ../src/guestfs-actions.pod:354
6631 msgid "guestfs_aug_get"
6635 #: ../src/guestfs-actions.pod:356
6639 " guestfs_aug_get (guestfs_h *g,\n"
6640 " const char *augpath);\n"
6645 #: ../src/guestfs-actions.pod:360 ../fish/guestfish-actions.pod:230
6647 "Look up the value associated with C<path>. If C<path> matches exactly one "
6648 "node, the C<value> is returned."
6652 #: ../src/guestfs-actions.pod:363 ../src/guestfs-actions.pod:863
6653 #: ../src/guestfs-actions.pod:881 ../src/guestfs-actions.pod:941
6654 #: ../src/guestfs-actions.pod:957 ../src/guestfs-actions.pod:1060
6655 #: ../src/guestfs-actions.pod:1190 ../src/guestfs-actions.pod:1207
6656 #: ../src/guestfs-actions.pod:1226 ../src/guestfs-actions.pod:1360
6657 #: ../src/guestfs-actions.pod:1548 ../src/guestfs-actions.pod:1660
6658 #: ../src/guestfs-actions.pod:1823 ../src/guestfs-actions.pod:1840
6659 #: ../src/guestfs-actions.pod:1907 ../src/guestfs-actions.pod:1941
6660 #: ../src/guestfs-actions.pod:1962 ../src/guestfs-actions.pod:2132
6661 #: ../src/guestfs-actions.pod:2324 ../src/guestfs-actions.pod:2528
6662 #: ../src/guestfs-actions.pod:2618 ../src/guestfs-actions.pod:2720
6663 #: ../src/guestfs-actions.pod:2737 ../src/guestfs-actions.pod:2949
6664 #: ../src/guestfs-actions.pod:2977 ../src/guestfs-actions.pod:2998
6665 #: ../src/guestfs-actions.pod:3032 ../src/guestfs-actions.pod:3089
6666 #: ../src/guestfs-actions.pod:3109 ../src/guestfs-actions.pod:3127
6667 #: ../src/guestfs-actions.pod:3722 ../src/guestfs-actions.pod:4072
6668 #: ../src/guestfs-actions.pod:4242 ../src/guestfs-actions.pod:4352
6669 #: ../src/guestfs-actions.pod:5152 ../src/guestfs-actions.pod:5345
6670 #: ../src/guestfs-actions.pod:5515 ../src/guestfs-actions.pod:5693
6671 #: ../src/guestfs-actions.pod:5742 ../src/guestfs-actions.pod:6375
6672 #: ../src/guestfs-actions.pod:6391 ../src/guestfs-actions.pod:6408
6673 #: ../src/guestfs-actions.pod:6439 ../src/guestfs-actions.pod:7113
6674 #: ../src/guestfs-actions.pod:7132 ../src/guestfs-actions.pod:7150
6675 #: ../src/guestfs-actions.pod:7330 ../src/guestfs-actions.pod:7610
6677 "This function returns a string, or NULL on error. I<The caller must free "
6678 "the returned string after use>."
6682 #: ../src/guestfs-actions.pod:368
6683 msgid "guestfs_aug_init"
6687 #: ../src/guestfs-actions.pod:370
6691 " guestfs_aug_init (guestfs_h *g,\n"
6692 " const char *root,\n"
6698 #: ../src/guestfs-actions.pod:375 ../fish/guestfish-actions.pod:237
6700 "Create a new Augeas handle for editing configuration files. If there was "
6701 "any previous Augeas handle associated with this guestfs session, then it is "
6706 #: ../src/guestfs-actions.pod:379
6707 msgid "You must call this before using any other C<guestfs_aug_*> commands."
6711 #: ../src/guestfs-actions.pod:382 ../fish/guestfish-actions.pod:244
6713 "C<root> is the filesystem root. C<root> must not be NULL, use C</> instead."
6717 #: ../src/guestfs-actions.pod:385 ../fish/guestfish-actions.pod:247
6719 "The flags are the same as the flags defined in E<lt>augeas.hE<gt>, the "
6720 "logical I<or> of the following integers:"
6724 #: ../src/guestfs-actions.pod:391 ../fish/guestfish-actions.pod:253
6725 msgid "C<AUG_SAVE_BACKUP> = 1"
6726 msgstr "C<AUG_SAVE_BACKUP> = 1"
6729 #: ../src/guestfs-actions.pod:393 ../fish/guestfish-actions.pod:255
6730 msgid "Keep the original file with a C<.augsave> extension."
6734 #: ../src/guestfs-actions.pod:395 ../fish/guestfish-actions.pod:257
6735 msgid "C<AUG_SAVE_NEWFILE> = 2"
6736 msgstr "C<AUG_SAVE_NEWFILE> = 2"
6739 #: ../src/guestfs-actions.pod:397 ../fish/guestfish-actions.pod:259
6741 "Save changes into a file with extension C<.augnew>, and do not overwrite "
6742 "original. Overrides C<AUG_SAVE_BACKUP>."
6746 #: ../src/guestfs-actions.pod:400 ../fish/guestfish-actions.pod:262
6747 msgid "C<AUG_TYPE_CHECK> = 4"
6748 msgstr "C<AUG_TYPE_CHECK> = 4"
6751 #: ../src/guestfs-actions.pod:402 ../fish/guestfish-actions.pod:264
6752 msgid "Typecheck lenses (can be expensive)."
6756 #: ../src/guestfs-actions.pod:404 ../fish/guestfish-actions.pod:266
6757 msgid "C<AUG_NO_STDINC> = 8"
6758 msgstr "C<AUG_NO_STDINC> = 8"
6761 #: ../src/guestfs-actions.pod:406 ../fish/guestfish-actions.pod:268
6762 msgid "Do not use standard load path for modules."
6766 #: ../src/guestfs-actions.pod:408 ../fish/guestfish-actions.pod:270
6767 msgid "C<AUG_SAVE_NOOP> = 16"
6768 msgstr "C<AUG_SAVE_NOOP> = 16"
6771 #: ../src/guestfs-actions.pod:410 ../fish/guestfish-actions.pod:272
6772 msgid "Make save a no-op, just record what would have been changed."
6776 #: ../src/guestfs-actions.pod:412 ../fish/guestfish-actions.pod:274
6777 msgid "C<AUG_NO_LOAD> = 32"
6778 msgstr "C<AUG_NO_LOAD> = 32"
6781 #: ../src/guestfs-actions.pod:414
6782 msgid "Do not load the tree in C<guestfs_aug_init>."
6786 #: ../src/guestfs-actions.pod:418
6787 msgid "To close the handle, you can call C<guestfs_aug_close>."
6791 #: ../src/guestfs-actions.pod:420 ../fish/guestfish-actions.pod:282
6792 msgid "To find out more about Augeas, see L<http://augeas.net/>."
6796 #: ../src/guestfs-actions.pod:426
6797 msgid "guestfs_aug_insert"
6801 #: ../src/guestfs-actions.pod:428
6805 " guestfs_aug_insert (guestfs_h *g,\n"
6806 " const char *augpath,\n"
6807 " const char *label,\n"
6813 #: ../src/guestfs-actions.pod:434 ../fish/guestfish-actions.pod:288
6815 "Create a new sibling C<label> for C<path>, inserting it into the tree before "
6816 "or after C<path> (depending on the boolean flag C<before>)."
6820 #: ../src/guestfs-actions.pod:438 ../fish/guestfish-actions.pod:292
6822 "C<path> must match exactly one existing node in the tree, and C<label> must "
6823 "be a label, ie. not contain C</>, C<*> or end with a bracketed index C<[N]>."
6827 #: ../src/guestfs-actions.pod:446
6828 msgid "guestfs_aug_load"
6832 #: ../src/guestfs-actions.pod:448
6836 " guestfs_aug_load (guestfs_h *g);\n"
6841 #: ../src/guestfs-actions.pod:451 ../fish/guestfish-actions.pod:300
6842 msgid "Load files into the tree."
6843 msgstr "Завантажити файли до ієрархії."
6846 #: ../src/guestfs-actions.pod:453 ../fish/guestfish-actions.pod:302
6847 msgid "See C<aug_load> in the Augeas documentation for the full gory details."
6851 #: ../src/guestfs-actions.pod:460
6852 msgid "guestfs_aug_ls"
6856 #: ../src/guestfs-actions.pod:462
6860 " guestfs_aug_ls (guestfs_h *g,\n"
6861 " const char *augpath);\n"
6866 #: ../src/guestfs-actions.pod:466
6868 "This is just a shortcut for listing C<guestfs_aug_match> C<path/*> and "
6869 "sorting the resulting nodes into alphabetical order."
6873 #: ../src/guestfs-actions.pod:469 ../src/guestfs-actions.pod:485
6874 #: ../src/guestfs-actions.pod:631 ../src/guestfs-actions.pod:1079
6875 #: ../src/guestfs-actions.pod:1375 ../src/guestfs-actions.pod:1394
6876 #: ../src/guestfs-actions.pod:1497 ../src/guestfs-actions.pod:1516
6877 #: ../src/guestfs-actions.pod:1762 ../src/guestfs-actions.pod:2204
6878 #: ../src/guestfs-actions.pod:2220 ../src/guestfs-actions.pod:2239
6879 #: ../src/guestfs-actions.pod:2282 ../src/guestfs-actions.pod:2306
6880 #: ../src/guestfs-actions.pod:2377 ../src/guestfs-actions.pod:2426
6881 #: ../src/guestfs-actions.pod:2681 ../src/guestfs-actions.pod:3049
6882 #: ../src/guestfs-actions.pod:3317 ../src/guestfs-actions.pod:3627
6883 #: ../src/guestfs-actions.pod:3642 ../src/guestfs-actions.pod:3704
6884 #: ../src/guestfs-actions.pod:3809 ../src/guestfs-actions.pod:4214
6885 #: ../src/guestfs-actions.pod:4967 ../src/guestfs-actions.pod:5487
6886 #: ../src/guestfs-actions.pod:5613 ../src/guestfs-actions.pod:5727
6887 #: ../src/guestfs-actions.pod:6455 ../src/guestfs-actions.pod:6516
6888 #: ../src/guestfs-actions.pod:6571 ../src/guestfs-actions.pod:6717
6889 #: ../src/guestfs-actions.pod:6741 ../src/guestfs-actions.pod:7223
6890 #: ../src/guestfs-actions.pod:7243 ../src/guestfs-actions.pod:7290
6891 #: ../src/guestfs-actions.pod:7462 ../src/guestfs-actions.pod:7481
6892 #: ../src/guestfs-actions.pod:7567 ../src/guestfs-actions.pod:7586
6893 #: ../src/guestfs-actions.pod:7632 ../src/guestfs-actions.pod:7651
6895 "This function returns a NULL-terminated array of strings (like L<environ(3)"
6896 ">), or NULL if there was an error. I<The caller must free the strings and "
6897 "the array after use>."
6901 #: ../src/guestfs-actions.pod:473 ../src/guestfs-actions.pod:1004
6902 #: ../src/guestfs-actions.pod:1022 ../src/guestfs-actions.pod:1432
6903 #: ../src/guestfs-actions.pod:3395 ../src/guestfs-actions.pod:3426
6904 #: ../src/guestfs-actions.pod:4055 ../src/guestfs-actions.pod:4105
6905 #: ../src/guestfs-actions.pod:4292 ../src/guestfs-actions.pod:4325
6906 #: ../src/guestfs-actions.pod:4488 ../src/guestfs-actions.pod:4971
6907 #: ../src/guestfs-actions.pod:5428 ../src/guestfs-actions.pod:5823
6908 #: ../src/guestfs-actions.pod:5837 ../src/guestfs-actions.pod:5849
6909 #: ../src/guestfs-actions.pod:6296 ../src/guestfs-actions.pod:6955
6910 #: ../src/guestfs-actions.pod:6968 ../src/guestfs-actions.pod:7207
6911 #: ../src/guestfs-actions.pod:7450
6912 msgid "(Added in 0.8)"
6916 #: ../src/guestfs-actions.pod:475
6917 msgid "guestfs_aug_match"
6921 #: ../src/guestfs-actions.pod:477
6925 " guestfs_aug_match (guestfs_h *g,\n"
6926 " const char *augpath);\n"
6931 #: ../src/guestfs-actions.pod:481 ../fish/guestfish-actions.pod:316
6933 "Returns a list of paths which match the path expression C<path>. The "
6934 "returned paths are sufficiently qualified so that they match exactly one "
6935 "node in the current tree."
6939 #: ../src/guestfs-actions.pod:491
6940 msgid "guestfs_aug_mv"
6944 #: ../src/guestfs-actions.pod:493
6948 " guestfs_aug_mv (guestfs_h *g,\n"
6949 " const char *src,\n"
6950 " const char *dest);\n"
6955 #: ../src/guestfs-actions.pod:498 ../fish/guestfish-actions.pod:324
6957 "Move the node C<src> to C<dest>. C<src> must match exactly one node. "
6958 "C<dest> is overwritten if it exists."
6962 #: ../src/guestfs-actions.pod:505
6963 msgid "guestfs_aug_rm"
6967 #: ../src/guestfs-actions.pod:507
6971 " guestfs_aug_rm (guestfs_h *g,\n"
6972 " const char *augpath);\n"
6977 #: ../src/guestfs-actions.pod:511 ../fish/guestfish-actions.pod:331
6978 msgid "Remove C<path> and all of its children."
6982 #: ../src/guestfs-actions.pod:513 ../fish/guestfish-actions.pod:333
6983 msgid "On success this returns the number of entries which were removed."
6987 #: ../src/guestfs-actions.pod:519
6988 msgid "guestfs_aug_save"
6992 #: ../src/guestfs-actions.pod:521
6996 " guestfs_aug_save (guestfs_h *g);\n"
7001 #: ../src/guestfs-actions.pod:524 ../fish/guestfish-actions.pod:339
7002 msgid "This writes all pending changes to disk."
7006 #: ../src/guestfs-actions.pod:526
7008 "The flags which were passed to C<guestfs_aug_init> affect exactly how files "
7013 #: ../src/guestfs-actions.pod:533
7014 msgid "guestfs_aug_set"
7018 #: ../src/guestfs-actions.pod:535
7022 " guestfs_aug_set (guestfs_h *g,\n"
7023 " const char *augpath,\n"
7024 " const char *val);\n"
7029 #: ../src/guestfs-actions.pod:540 ../fish/guestfish-actions.pod:348
7030 msgid "Set the value associated with C<path> to C<val>."
7034 #: ../src/guestfs-actions.pod:542
7036 "In the Augeas API, it is possible to clear a node by setting the value to "
7037 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
7038 "this call. Instead you must use the C<guestfs_aug_clear> call."
7042 #: ../src/guestfs-actions.pod:551
7043 msgid "guestfs_available"
7047 #: ../src/guestfs-actions.pod:553
7051 " guestfs_available (guestfs_h *g,\n"
7052 " char *const *groups);\n"
7057 #: ../src/guestfs-actions.pod:557 ../fish/guestfish-actions.pod:359
7059 "This command is used to check the availability of some groups of "
7060 "functionality in the appliance, which not all builds of the libguestfs "
7061 "appliance will be able to provide."
7065 #: ../src/guestfs-actions.pod:561
7067 "The libguestfs groups, and the functions that those groups correspond to, "
7068 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
7069 "runtime by calling C<guestfs_available_all_groups>."
7073 #: ../src/guestfs-actions.pod:566 ../fish/guestfish-actions.pod:368
7075 "The argument C<groups> is a list of group names, eg: C<[\"inotify\", \"augeas"
7076 "\"]> would check for the availability of the Linux inotify functions and "
7077 "Augeas (configuration file editing) functions."
7081 #: ../src/guestfs-actions.pod:571 ../fish/guestfish-actions.pod:373
7082 msgid "The command returns no error if I<all> requested groups are available."
7086 #: ../src/guestfs-actions.pod:573 ../fish/guestfish-actions.pod:375
7088 "It fails with an error if one or more of the requested groups is unavailable "
7093 #: ../src/guestfs-actions.pod:576 ../fish/guestfish-actions.pod:378
7095 "If an unknown group name is included in the list of groups then an error is "
7100 #: ../src/guestfs-actions.pod:579 ../fish/guestfish-actions.pod:381
7102 msgstr "I<Нотатки:>"
7105 #: ../src/guestfs-actions.pod:585
7106 msgid "You must call C<guestfs_launch> before calling this function."
7110 #: ../src/guestfs-actions.pod:587 ../fish/guestfish-actions.pod:389
7112 "The reason is because we don't know what groups are supported by the "
7113 "appliance/daemon until it is running and can be queried."
7117 #: ../src/guestfs-actions.pod:593 ../fish/guestfish-actions.pod:395
7119 "If a group of functions is available, this does not necessarily mean that "
7120 "they will work. You still have to check for errors when calling individual "
7121 "API functions even if they are available."
7125 #: ../src/guestfs-actions.pod:600 ../fish/guestfish-actions.pod:402
7127 "It is usually the job of distro packagers to build complete functionality "
7128 "into the libguestfs appliance. Upstream libguestfs, if built from source "
7129 "with all requirements satisfied, will support everything."
7133 #: ../src/guestfs-actions.pod:607
7135 "This call was added in version C<1.0.80>. In previous versions of "
7136 "libguestfs all you could do would be to speculatively execute a command to "
7137 "find out if the daemon implemented it. See also C<guestfs_version>."
7141 #: ../src/guestfs-actions.pod:616 ../src/guestfs-actions.pod:1177
7142 msgid "(Added in 1.0.80)"
7146 #: ../src/guestfs-actions.pod:618
7147 msgid "guestfs_available_all_groups"
7151 #: ../src/guestfs-actions.pod:620
7155 " guestfs_available_all_groups (guestfs_h *g);\n"
7160 #: ../src/guestfs-actions.pod:623
7162 "This command returns a list of all optional groups that this daemon knows "
7163 "about. Note this returns both supported and unsupported groups. To find "
7164 "out which ones the daemon can actually support you have to call "
7165 "C<guestfs_available> on each member of the returned list."
7169 #: ../src/guestfs-actions.pod:629
7170 msgid "See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>."
7174 #: ../src/guestfs-actions.pod:635
7175 msgid "(Added in 1.3.15)"
7179 #: ../src/guestfs-actions.pod:637
7180 msgid "guestfs_base64_in"
7184 #: ../src/guestfs-actions.pod:639
7188 " guestfs_base64_in (guestfs_h *g,\n"
7189 " const char *base64file,\n"
7190 " const char *filename);\n"
7195 #: ../src/guestfs-actions.pod:644 ../fish/guestfish-actions.pod:432
7197 "This command uploads base64-encoded data from C<base64file> to C<filename>."
7201 #: ../src/guestfs-actions.pod:649 ../src/guestfs-actions.pod:663
7202 msgid "(Added in 1.3.5)"
7206 #: ../src/guestfs-actions.pod:651
7207 msgid "guestfs_base64_out"
7211 #: ../src/guestfs-actions.pod:653
7215 " guestfs_base64_out (guestfs_h *g,\n"
7216 " const char *filename,\n"
7217 " const char *base64file);\n"
7222 #: ../src/guestfs-actions.pod:658 ../fish/guestfish-actions.pod:441
7224 "This command downloads the contents of C<filename>, writing it out to local "
7225 "file C<base64file> encoded as base64."
7229 #: ../src/guestfs-actions.pod:665
7230 msgid "guestfs_blockdev_flushbufs"
7234 #: ../src/guestfs-actions.pod:667
7238 " guestfs_blockdev_flushbufs (guestfs_h *g,\n"
7239 " const char *device);\n"
7244 #: ../src/guestfs-actions.pod:671 ../fish/guestfish-actions.pod:450
7246 "This tells the kernel to flush internal buffers associated with C<device>."
7250 #: ../src/guestfs-actions.pod:674 ../src/guestfs-actions.pod:691
7251 #: ../src/guestfs-actions.pod:706 ../src/guestfs-actions.pod:722
7252 #: ../src/guestfs-actions.pod:740 ../src/guestfs-actions.pod:759
7253 #: ../src/guestfs-actions.pod:773 ../src/guestfs-actions.pod:791
7254 #: ../src/guestfs-actions.pod:805 ../src/guestfs-actions.pod:819
7255 #: ../fish/guestfish-actions.pod:453 ../fish/guestfish-actions.pod:464
7256 #: ../fish/guestfish-actions.pod:473 ../fish/guestfish-actions.pod:483
7257 #: ../fish/guestfish-actions.pod:495 ../fish/guestfish-actions.pod:508
7258 #: ../fish/guestfish-actions.pod:516 ../fish/guestfish-actions.pod:527
7259 #: ../fish/guestfish-actions.pod:535 ../fish/guestfish-actions.pod:543
7260 msgid "This uses the L<blockdev(8)> command."
7264 #: ../src/guestfs-actions.pod:678 ../src/guestfs-actions.pod:695
7265 #: ../src/guestfs-actions.pod:710 ../src/guestfs-actions.pod:726
7266 #: ../src/guestfs-actions.pod:744 ../src/guestfs-actions.pod:763
7267 #: ../src/guestfs-actions.pod:777 ../src/guestfs-actions.pod:795
7268 #: ../src/guestfs-actions.pod:809 ../src/guestfs-actions.pod:823
7269 msgid "(Added in 0.9.3)"
7273 #: ../src/guestfs-actions.pod:680
7274 msgid "guestfs_blockdev_getbsz"
7278 #: ../src/guestfs-actions.pod:682
7282 " guestfs_blockdev_getbsz (guestfs_h *g,\n"
7283 " const char *device);\n"
7288 #: ../src/guestfs-actions.pod:686 ../fish/guestfish-actions.pod:459
7289 msgid "This returns the block size of a device."
7293 #: ../src/guestfs-actions.pod:688 ../src/guestfs-actions.pod:788
7294 #: ../fish/guestfish-actions.pod:461 ../fish/guestfish-actions.pod:524
7296 "(Note this is different from both I<size in blocks> and I<filesystem block "
7301 #: ../src/guestfs-actions.pod:697
7302 msgid "guestfs_blockdev_getro"
7306 #: ../src/guestfs-actions.pod:699
7310 " guestfs_blockdev_getro (guestfs_h *g,\n"
7311 " const char *device);\n"
7316 #: ../src/guestfs-actions.pod:703 ../fish/guestfish-actions.pod:470
7318 "Returns a boolean indicating if the block device is read-only (true if read-"
7319 "only, false if not)."
7323 #: ../src/guestfs-actions.pod:708 ../src/guestfs-actions.pod:1415
7324 #: ../src/guestfs-actions.pod:1430 ../src/guestfs-actions.pod:1917
7325 #: ../src/guestfs-actions.pod:1928 ../src/guestfs-actions.pod:2000
7326 #: ../src/guestfs-actions.pod:2055 ../src/guestfs-actions.pod:2070
7327 #: ../src/guestfs-actions.pod:2095 ../src/guestfs-actions.pod:2118
7328 #: ../src/guestfs-actions.pod:3144 ../src/guestfs-actions.pod:3158
7329 #: ../src/guestfs-actions.pod:3174 ../src/guestfs-actions.pod:3334
7330 #: ../src/guestfs-actions.pod:3348 ../src/guestfs-actions.pod:3363
7331 #: ../src/guestfs-actions.pod:3377 ../src/guestfs-actions.pod:3393
7332 #: ../src/guestfs-actions.pod:3408 ../src/guestfs-actions.pod:3424
7333 #: ../src/guestfs-actions.pod:3438 ../src/guestfs-actions.pod:3451
7334 #: ../src/guestfs-actions.pod:3465 ../src/guestfs-actions.pod:3480
7335 #: ../src/guestfs-actions.pod:3495 ../src/guestfs-actions.pod:3508
7336 #: ../src/guestfs-actions.pod:3520 ../src/guestfs-actions.pod:5116
7337 msgid "This function returns a C truth value on success or -1 on error."
7341 #: ../src/guestfs-actions.pod:712
7342 msgid "guestfs_blockdev_getsize64"
7346 #: ../src/guestfs-actions.pod:714
7350 " guestfs_blockdev_getsize64 (guestfs_h *g,\n"
7351 " const char *device);\n"
7356 #: ../src/guestfs-actions.pod:718 ../fish/guestfish-actions.pod:479
7357 msgid "This returns the size of the device in bytes."
7361 #: ../src/guestfs-actions.pod:720
7362 msgid "See also C<guestfs_blockdev_getsz>."
7366 #: ../src/guestfs-actions.pod:728
7367 msgid "guestfs_blockdev_getss"
7371 #: ../src/guestfs-actions.pod:730
7375 " guestfs_blockdev_getss (guestfs_h *g,\n"
7376 " const char *device);\n"
7381 #: ../src/guestfs-actions.pod:734 ../fish/guestfish-actions.pod:489
7383 "This returns the size of sectors on a block device. Usually 512, but can be "
7384 "larger for modern devices."
7388 #: ../src/guestfs-actions.pod:737
7390 "(Note, this is not the size in sectors, use C<guestfs_blockdev_getsz> for "
7395 #: ../src/guestfs-actions.pod:746
7396 msgid "guestfs_blockdev_getsz"
7400 #: ../src/guestfs-actions.pod:748
7404 " guestfs_blockdev_getsz (guestfs_h *g,\n"
7405 " const char *device);\n"
7410 #: ../src/guestfs-actions.pod:752 ../fish/guestfish-actions.pod:501
7412 "This returns the size of the device in units of 512-byte sectors (even if "
7413 "the sectorsize isn't 512 bytes ... weird)."
7417 #: ../src/guestfs-actions.pod:755
7419 "See also C<guestfs_blockdev_getss> for the real sector size of the device, "
7420 "and C<guestfs_blockdev_getsize64> for the more useful I<size in bytes>."
7424 #: ../src/guestfs-actions.pod:765
7425 msgid "guestfs_blockdev_rereadpt"
7429 #: ../src/guestfs-actions.pod:767
7433 " guestfs_blockdev_rereadpt (guestfs_h *g,\n"
7434 " const char *device);\n"
7439 #: ../src/guestfs-actions.pod:771 ../fish/guestfish-actions.pod:514
7440 msgid "Reread the partition table on C<device>."
7444 #: ../src/guestfs-actions.pod:779
7445 msgid "guestfs_blockdev_setbsz"
7449 #: ../src/guestfs-actions.pod:781
7453 " guestfs_blockdev_setbsz (guestfs_h *g,\n"
7454 " const char *device,\n"
7455 " int blocksize);\n"
7460 #: ../src/guestfs-actions.pod:786 ../fish/guestfish-actions.pod:522
7461 msgid "This sets the block size of a device."
7465 #: ../src/guestfs-actions.pod:797
7466 msgid "guestfs_blockdev_setro"
7470 #: ../src/guestfs-actions.pod:799
7474 " guestfs_blockdev_setro (guestfs_h *g,\n"
7475 " const char *device);\n"
7480 #: ../src/guestfs-actions.pod:803 ../fish/guestfish-actions.pod:533
7481 msgid "Sets the block device named C<device> to read-only."
7485 #: ../src/guestfs-actions.pod:811
7486 msgid "guestfs_blockdev_setrw"
7490 #: ../src/guestfs-actions.pod:813
7494 " guestfs_blockdev_setrw (guestfs_h *g,\n"
7495 " const char *device);\n"
7500 #: ../src/guestfs-actions.pod:817 ../fish/guestfish-actions.pod:541
7501 msgid "Sets the block device named C<device> to read-write."
7505 #: ../src/guestfs-actions.pod:825
7506 msgid "guestfs_case_sensitive_path"
7510 #: ../src/guestfs-actions.pod:827
7514 " guestfs_case_sensitive_path (guestfs_h *g,\n"
7515 " const char *path);\n"
7520 #: ../src/guestfs-actions.pod:831 ../fish/guestfish-actions.pod:549
7522 "This can be used to resolve case insensitive paths on a filesystem which is "
7523 "case sensitive. The use case is to resolve paths which you have read from "
7524 "Windows configuration files or the Windows Registry, to the true path."
7528 #: ../src/guestfs-actions.pod:836 ../fish/guestfish-actions.pod:554
7530 "The command handles a peculiarity of the Linux ntfs-3g filesystem driver "
7531 "(and probably others), which is that although the underlying filesystem is "
7532 "case-insensitive, the driver exports the filesystem to Linux as case-"
7537 #: ../src/guestfs-actions.pod:841 ../fish/guestfish-actions.pod:559
7539 "One consequence of this is that special directories such as C<c:\\windows> "
7540 "may appear as C</WINDOWS> or C</windows> (or other things) depending on the "
7541 "precise details of how they were created. In Windows itself this would not "
7546 #: ../src/guestfs-actions.pod:847 ../fish/guestfish-actions.pod:565
7548 "Bug or feature? You decide: L<http://www.tuxera.com/community/ntfs-3g-faq/"
7553 #: ../src/guestfs-actions.pod:850 ../fish/guestfish-actions.pod:568
7555 "This function resolves the true case of each element in the path and returns "
7556 "the case-sensitive path."
7560 #: ../src/guestfs-actions.pod:853
7562 "Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\") might return C<"
7563 "\"/WINDOWS/system32\"> (the exact return value would depend on details of "
7564 "how the directories were originally created under Windows)."
7568 #: ../src/guestfs-actions.pod:858 ../fish/guestfish-actions.pod:576
7569 msgid "I<Note>: This function does not handle drive names, backslashes etc."
7573 #: ../src/guestfs-actions.pod:861
7574 msgid "See also C<guestfs_realpath>."
7578 #: ../src/guestfs-actions.pod:866 ../src/guestfs-actions.pod:7135
7579 msgid "(Added in 1.0.75)"
7583 #: ../src/guestfs-actions.pod:868
7588 #: ../src/guestfs-actions.pod:870
7592 " guestfs_cat (guestfs_h *g,\n"
7593 " const char *path);\n"
7598 #: ../src/guestfs-actions.pod:874 ../src/guestfs-actions.pod:5603
7599 #: ../fish/guestfish-actions.pod:585 ../fish/guestfish-actions.pod:3717
7600 msgid "Return the contents of the file named C<path>."
7604 #: ../src/guestfs-actions.pod:876
7606 "Note that this function cannot correctly handle binary files (specifically, "
7607 "files containing C<\\0> character which is treated as end of string). For "
7608 "those you need to use the C<guestfs_read_file> or C<guestfs_download> "
7609 "functions which have a more complex interface."
7613 #: ../src/guestfs-actions.pod:884 ../src/guestfs-actions.pod:1063
7614 #: ../src/guestfs-actions.pod:1083 ../src/guestfs-actions.pod:1379
7615 #: ../src/guestfs-actions.pod:1398 ../src/guestfs-actions.pod:1501
7616 #: ../src/guestfs-actions.pod:1520 ../src/guestfs-actions.pod:1766
7617 #: ../src/guestfs-actions.pod:2224 ../src/guestfs-actions.pod:2243
7618 #: ../src/guestfs-actions.pod:2286 ../src/guestfs-actions.pod:2310
7619 #: ../src/guestfs-actions.pod:2327 ../src/guestfs-actions.pod:2356
7620 #: ../src/guestfs-actions.pod:5385 ../src/guestfs-actions.pod:5411
7621 #: ../src/guestfs-actions.pod:5542 ../src/guestfs-actions.pod:5568
7622 #: ../src/guestfs-actions.pod:5592 ../src/guestfs-actions.pod:6520
7623 #: ../src/guestfs-actions.pod:6575 ../src/guestfs-actions.pod:6721
7624 #: ../src/guestfs-actions.pod:6745 ../src/guestfs-actions.pod:7414
7625 #: ../src/guestfs-actions.pod:7440 ../src/guestfs-actions.pod:7466
7626 #: ../src/guestfs-actions.pod:7485 ../src/guestfs-actions.pod:7571
7627 #: ../src/guestfs-actions.pod:7590 ../src/guestfs-actions.pod:7636
7628 #: ../src/guestfs-actions.pod:7655 ../fish/guestfish-actions.pod:592
7629 #: ../fish/guestfish-actions.pod:727 ../fish/guestfish-actions.pod:739
7630 #: ../fish/guestfish-actions.pod:915 ../fish/guestfish-actions.pod:925
7631 #: ../fish/guestfish-actions.pod:992 ../fish/guestfish-actions.pod:1002
7632 #: ../fish/guestfish-actions.pod:1194 ../fish/guestfish-actions.pod:1495
7633 #: ../fish/guestfish-actions.pod:1505 ../fish/guestfish-actions.pod:1533
7634 #: ../fish/guestfish-actions.pod:1548 ../fish/guestfish-actions.pod:1558
7635 #: ../fish/guestfish-actions.pod:1577 ../fish/guestfish-actions.pod:3587
7636 #: ../fish/guestfish-actions.pod:3602 ../fish/guestfish-actions.pod:3678
7637 #: ../fish/guestfish-actions.pod:3695 ../fish/guestfish-actions.pod:3710
7638 #: ../fish/guestfish-actions.pod:4364 ../fish/guestfish-actions.pod:4410
7639 #: ../fish/guestfish-actions.pod:4495 ../fish/guestfish-actions.pod:4510
7640 #: ../fish/guestfish-actions.pod:4920 ../fish/guestfish-actions.pod:4938
7641 #: ../fish/guestfish-actions.pod:4955 ../fish/guestfish-actions.pod:4965
7642 #: ../fish/guestfish-actions.pod:5014 ../fish/guestfish-actions.pod:5024
7643 #: ../fish/guestfish-actions.pod:5053 ../fish/guestfish-actions.pod:5063
7645 "Because of the message protocol, there is a transfer limit of somewhere "
7646 "between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
7650 #: ../src/guestfs-actions.pod:887 ../src/guestfs-actions.pod:3646
7651 #: ../src/guestfs-actions.pod:3708 ../src/guestfs-actions.pod:3725
7652 #: ../src/guestfs-actions.pod:3813 ../src/guestfs-actions.pod:4218
7653 #: ../src/guestfs-actions.pod:4232 ../src/guestfs-actions.pod:5491
7654 #: ../src/guestfs-actions.pod:5505 ../src/guestfs-actions.pod:7294
7655 #: ../src/guestfs-actions.pod:7308
7656 msgid "(Added in 0.4)"
7660 #: ../src/guestfs-actions.pod:889
7661 msgid "guestfs_checksum"
7665 #: ../src/guestfs-actions.pod:891
7669 " guestfs_checksum (guestfs_h *g,\n"
7670 " const char *csumtype,\n"
7671 " const char *path);\n"
7676 #: ../src/guestfs-actions.pod:896 ../fish/guestfish-actions.pod:599
7678 "This call computes the MD5, SHAx or CRC checksum of the file named C<path>."
7682 #: ../src/guestfs-actions.pod:899 ../fish/guestfish-actions.pod:602
7684 "The type of checksum to compute is given by the C<csumtype> parameter which "
7685 "must have one of the following values:"
7689 #: ../src/guestfs-actions.pod:904 ../fish/guestfish-actions.pod:607
7694 #: ../src/guestfs-actions.pod:906 ../fish/guestfish-actions.pod:609
7696 "Compute the cyclic redundancy check (CRC) specified by POSIX for the "
7701 #: ../src/guestfs-actions.pod:909 ../fish/guestfish-actions.pod:612
7706 #: ../src/guestfs-actions.pod:911 ../fish/guestfish-actions.pod:614
7707 msgid "Compute the MD5 hash (using the C<md5sum> program)."
7711 #: ../src/guestfs-actions.pod:913 ../fish/guestfish-actions.pod:616
7716 #: ../src/guestfs-actions.pod:915 ../fish/guestfish-actions.pod:618
7717 msgid "Compute the SHA1 hash (using the C<sha1sum> program)."
7721 #: ../src/guestfs-actions.pod:917 ../fish/guestfish-actions.pod:620
7726 #: ../src/guestfs-actions.pod:919 ../fish/guestfish-actions.pod:622
7727 msgid "Compute the SHA224 hash (using the C<sha224sum> program)."
7731 #: ../src/guestfs-actions.pod:921 ../fish/guestfish-actions.pod:624
7736 #: ../src/guestfs-actions.pod:923 ../fish/guestfish-actions.pod:626
7737 msgid "Compute the SHA256 hash (using the C<sha256sum> program)."
7741 #: ../src/guestfs-actions.pod:925 ../fish/guestfish-actions.pod:628
7746 #: ../src/guestfs-actions.pod:927 ../fish/guestfish-actions.pod:630
7747 msgid "Compute the SHA384 hash (using the C<sha384sum> program)."
7751 #: ../src/guestfs-actions.pod:929 ../fish/guestfish-actions.pod:632
7756 #: ../src/guestfs-actions.pod:931 ../fish/guestfish-actions.pod:634
7757 msgid "Compute the SHA512 hash (using the C<sha512sum> program)."
7761 #: ../src/guestfs-actions.pod:935 ../fish/guestfish-actions.pod:638
7762 msgid "The checksum is returned as a printable string."
7766 #: ../src/guestfs-actions.pod:937
7767 msgid "To get the checksum for a device, use C<guestfs_checksum_device>."
7771 #: ../src/guestfs-actions.pod:939
7772 msgid "To get the checksums for many files, use C<guestfs_checksums_out>."
7776 #: ../src/guestfs-actions.pod:944 ../src/guestfs-actions.pod:1252
7777 #: ../src/guestfs-actions.pod:2086 ../src/guestfs-actions.pod:3350
7778 #: ../src/guestfs-actions.pod:3379 ../src/guestfs-actions.pod:3440
7779 #: ../src/guestfs-actions.pod:3467 ../src/guestfs-actions.pod:6991
7780 msgid "(Added in 1.0.2)"
7784 #: ../src/guestfs-actions.pod:946
7785 msgid "guestfs_checksum_device"
7789 #: ../src/guestfs-actions.pod:948
7793 " guestfs_checksum_device (guestfs_h *g,\n"
7794 " const char *csumtype,\n"
7795 " const char *device);\n"
7800 #: ../src/guestfs-actions.pod:953
7802 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
7803 "device named C<device>. For the types of checksums supported see the "
7804 "C<guestfs_checksum> command."
7808 #: ../src/guestfs-actions.pod:960 ../src/guestfs-actions.pod:5022
7809 #: ../src/guestfs-actions.pod:5081 ../src/guestfs-actions.pod:5118
7810 #: ../src/guestfs-actions.pod:5136 ../src/guestfs-actions.pod:5312
7811 #: ../src/guestfs-actions.pod:6900 ../src/guestfs-actions.pod:6914
7812 #: ../src/guestfs-actions.pod:7320
7813 msgid "(Added in 1.3.2)"
7817 #: ../src/guestfs-actions.pod:962
7818 msgid "guestfs_checksums_out"
7822 #: ../src/guestfs-actions.pod:964
7826 " guestfs_checksums_out (guestfs_h *g,\n"
7827 " const char *csumtype,\n"
7828 " const char *directory,\n"
7829 " const char *sumsfile);\n"
7834 #: ../src/guestfs-actions.pod:970 ../fish/guestfish-actions.pod:656
7836 "This command computes the checksums of all regular files in C<directory> and "
7837 "then emits a list of those checksums to the local output file C<sumsfile>."
7841 #: ../src/guestfs-actions.pod:974 ../fish/guestfish-actions.pod:660
7843 "This can be used for verifying the integrity of a virtual machine. However "
7844 "to be properly secure you should pay attention to the output of the checksum "
7845 "command (it uses the ones from GNU coreutils). In particular when the "
7846 "filename is not printable, coreutils uses a special backslash syntax. For "
7847 "more information, see the GNU coreutils info file."
7851 #: ../src/guestfs-actions.pod:984
7852 msgid "(Added in 1.3.7)"
7856 #: ../src/guestfs-actions.pod:986
7857 msgid "guestfs_chmod"
7861 #: ../src/guestfs-actions.pod:988
7865 " guestfs_chmod (guestfs_h *g,\n"
7867 " const char *path);\n"
7872 #: ../src/guestfs-actions.pod:993 ../fish/guestfish-actions.pod:674
7874 "Change the mode (permissions) of C<path> to C<mode>. Only numeric modes are "
7879 #: ../src/guestfs-actions.pod:996 ../fish/guestfish-actions.pod:677
7881 "I<Note>: When using this command from guestfish, C<mode> by default would be "
7882 "decimal, unless you prefix it with C<0> to get octal, ie. use C<0700> not "
7887 #: ../src/guestfs-actions.pod:1000 ../src/guestfs-actions.pod:4469
7888 #: ../src/guestfs-actions.pod:4666 ../src/guestfs-actions.pod:4685
7889 #: ../src/guestfs-actions.pod:4704 ../fish/guestfish-actions.pod:681
7890 #: ../fish/guestfish-actions.pod:3013 ../fish/guestfish-actions.pod:3142
7891 #: ../fish/guestfish-actions.pod:3152 ../fish/guestfish-actions.pod:3162
7892 msgid "The mode actually set is affected by the umask."
7896 #: ../src/guestfs-actions.pod:1006
7897 msgid "guestfs_chown"
7901 #: ../src/guestfs-actions.pod:1008
7905 " guestfs_chown (guestfs_h *g,\n"
7908 " const char *path);\n"
7913 #: ../src/guestfs-actions.pod:1014 ../fish/guestfish-actions.pod:687
7914 msgid "Change the file owner to C<owner> and group to C<group>."
7918 #: ../src/guestfs-actions.pod:1016 ../src/guestfs-actions.pod:3565
7919 #: ../fish/guestfish-actions.pod:689 ../fish/guestfish-actions.pod:2464
7921 "Only numeric uid and gid are supported. If you want to use names, you will "
7922 "need to locate and parse the password file yourself (Augeas support makes "
7923 "this relatively easy)."
7927 #: ../src/guestfs-actions.pod:1024
7928 msgid "guestfs_command"
7932 #: ../src/guestfs-actions.pod:1026
7936 " guestfs_command (guestfs_h *g,\n"
7937 " char *const *arguments);\n"
7942 #: ../src/guestfs-actions.pod:1030 ../fish/guestfish-actions.pod:697
7944 "This call runs a command from the guest filesystem. The filesystem must be "
7945 "mounted, and must contain a compatible operating system (ie. something "
7946 "Linux, with the same or compatible processor architecture)."
7950 #: ../src/guestfs-actions.pod:1035
7952 "The single parameter is an argv-style list of arguments. The first element "
7953 "is the name of the program to run. Subsequent elements are parameters. The "
7954 "list must be non-empty (ie. must contain a program name). Note that the "
7955 "command runs directly, and is I<not> invoked via the shell (see "
7960 #: ../src/guestfs-actions.pod:1042 ../fish/guestfish-actions.pod:709
7961 msgid "The return value is anything printed to I<stdout> by the command."
7965 #: ../src/guestfs-actions.pod:1045 ../fish/guestfish-actions.pod:712
7967 "If the command returns a non-zero exit status, then this function returns an "
7968 "error message. The error message string is the content of I<stderr> from "
7973 #: ../src/guestfs-actions.pod:1049 ../fish/guestfish-actions.pod:716
7975 "The C<$PATH> environment variable will contain at least C</usr/bin> and C</"
7976 "bin>. If you require a program from another location, you should provide "
7977 "the full path in the first parameter."
7981 #: ../src/guestfs-actions.pod:1054 ../fish/guestfish-actions.pod:721
7983 "Shared libraries and data files required by the program must be available on "
7984 "filesystems which are mounted in the correct places. It is the caller's "
7985 "responsibility to ensure all filesystems that are needed are mounted at the "
7990 #: ../src/guestfs-actions.pod:1066 ../src/guestfs-actions.pod:1086
7991 #: ../src/guestfs-actions.pod:1551
7992 msgid "(Added in 0.9.1)"
7996 #: ../src/guestfs-actions.pod:1068
7997 msgid "guestfs_command_lines"
8001 #: ../src/guestfs-actions.pod:1070
8005 " guestfs_command_lines (guestfs_h *g,\n"
8006 " char *const *arguments);\n"
8011 #: ../src/guestfs-actions.pod:1074
8013 "This is the same as C<guestfs_command>, but splits the result into a list of "
8018 #: ../src/guestfs-actions.pod:1077
8019 msgid "See also: C<guestfs_sh_lines>"
8023 #: ../src/guestfs-actions.pod:1088
8024 msgid "guestfs_config"
8028 #: ../src/guestfs-actions.pod:1090
8032 " guestfs_config (guestfs_h *g,\n"
8033 " const char *qemuparam,\n"
8034 " const char *qemuvalue);\n"
8039 #: ../src/guestfs-actions.pod:1095 ../fish/guestfish-actions.pod:746
8041 "This can be used to add arbitrary qemu command line parameters of the form "
8042 "I<-param value>. Actually it's not quite arbitrary - we prevent you from "
8043 "setting some parameters which would interfere with parameters that we use."
8047 #: ../src/guestfs-actions.pod:1100 ../fish/guestfish-actions.pod:751
8048 msgid "The first character of C<param> string must be a C<-> (dash)."
8052 #: ../src/guestfs-actions.pod:1102 ../fish/guestfish-actions.pod:753
8053 msgid "C<value> can be NULL."
8057 #: ../src/guestfs-actions.pod:1108
8058 msgid "guestfs_copy_size"
8062 #: ../src/guestfs-actions.pod:1110
8066 " guestfs_copy_size (guestfs_h *g,\n"
8067 " const char *src,\n"
8068 " const char *dest,\n"
8074 #: ../src/guestfs-actions.pod:1116 ../fish/guestfish-actions.pod:759
8076 "This command copies exactly C<size> bytes from one source device or file "
8077 "C<src> to another destination device or file C<dest>."
8081 #: ../src/guestfs-actions.pod:1119 ../fish/guestfish-actions.pod:762
8083 "Note this will fail if the source is too short or if the destination is not "
8088 #: ../src/guestfs-actions.pod:1124 ../src/guestfs-actions.pod:1247
8089 #: ../src/guestfs-actions.pod:1278 ../src/guestfs-actions.pod:1323
8090 #: ../src/guestfs-actions.pod:1700 ../src/guestfs-actions.pod:1722
8091 #: ../src/guestfs-actions.pod:3546 ../src/guestfs-actions.pod:6986
8092 #: ../src/guestfs-actions.pod:7020 ../src/guestfs-actions.pod:7507
8093 #: ../src/guestfs-actions.pod:7526
8095 "This long-running command can generate progress notification messages so "
8096 "that the caller can display a progress bar or indicator. To receive these "
8097 "messages, the caller must register a progress event callback. See L<guestfs"
8098 "(3)/GUESTFS_EVENT_PROGRESS>."
8102 #: ../src/guestfs-actions.pod:1129 ../src/guestfs-actions.pod:4245
8103 #: ../src/guestfs-actions.pod:5518 ../src/guestfs-actions.pod:7227
8104 #: ../src/guestfs-actions.pod:7247 ../src/guestfs-actions.pod:7333
8105 msgid "(Added in 1.0.87)"
8109 #: ../src/guestfs-actions.pod:1131
8114 #: ../src/guestfs-actions.pod:1133
8118 " guestfs_cp (guestfs_h *g,\n"
8119 " const char *src,\n"
8120 " const char *dest);\n"
8125 #: ../src/guestfs-actions.pod:1138 ../fish/guestfish-actions.pod:769
8127 "This copies a file from C<src> to C<dest> where C<dest> is either a "
8128 "destination filename or destination directory."
8132 #: ../src/guestfs-actions.pod:1143 ../src/guestfs-actions.pod:1157
8133 #: ../src/guestfs-actions.pod:1229 ../src/guestfs-actions.pod:1303
8134 #: ../src/guestfs-actions.pod:1417 ../src/guestfs-actions.pod:4985
8135 #: ../src/guestfs-actions.pod:5362
8136 msgid "(Added in 1.0.18)"
8140 #: ../src/guestfs-actions.pod:1145
8141 msgid "guestfs_cp_a"
8145 #: ../src/guestfs-actions.pod:1147
8149 " guestfs_cp_a (guestfs_h *g,\n"
8150 " const char *src,\n"
8151 " const char *dest);\n"
8156 #: ../src/guestfs-actions.pod:1152 ../fish/guestfish-actions.pod:776
8158 "This copies a file or directory from C<src> to C<dest> recursively using the "
8163 #: ../src/guestfs-actions.pod:1159
8168 #: ../src/guestfs-actions.pod:1161
8172 " guestfs_dd (guestfs_h *g,\n"
8173 " const char *src,\n"
8174 " const char *dest);\n"
8179 #: ../src/guestfs-actions.pod:1166 ../fish/guestfish-actions.pod:783
8181 "This command copies from one source device or file C<src> to another "
8182 "destination device or file C<dest>. Normally you would use this to copy to "
8183 "or from a device or partition, for example to duplicate a filesystem."
8187 #: ../src/guestfs-actions.pod:1171
8189 "If the destination is a device, it must be as large or larger than the "
8190 "source file or device, otherwise the copy will fail. This command cannot do "
8191 "partial copies (see C<guestfs_copy_size>)."
8195 #: ../src/guestfs-actions.pod:1179
8200 #: ../src/guestfs-actions.pod:1181
8204 " guestfs_df (guestfs_h *g);\n"
8209 #: ../src/guestfs-actions.pod:1184 ../fish/guestfish-actions.pod:796
8210 msgid "This command runs the C<df> command to report disk space used."
8214 #: ../src/guestfs-actions.pod:1186 ../src/guestfs-actions.pod:1203
8216 "This command is mostly useful for interactive sessions. It is I<not> "
8217 "intended that you try to parse the output string. Use C<guestfs_statvfs> "
8222 #: ../src/guestfs-actions.pod:1193 ../src/guestfs-actions.pod:1210
8223 #: ../src/guestfs-actions.pod:1328 ../src/guestfs-actions.pod:2289
8224 #: ../src/guestfs-actions.pod:2313 ../src/guestfs-actions.pod:2381
8225 #: ../src/guestfs-actions.pod:4355 ../src/guestfs-actions.pod:4885
8226 #: ../src/guestfs-actions.pod:6724 ../src/guestfs-actions.pod:6748
8227 #: ../src/guestfs-actions.pod:7373 ../src/guestfs-actions.pod:7386
8228 #: ../src/guestfs-actions.pod:7399
8229 msgid "(Added in 1.0.54)"
8233 #: ../src/guestfs-actions.pod:1195
8234 msgid "guestfs_df_h"
8238 #: ../src/guestfs-actions.pod:1197
8242 " guestfs_df_h (guestfs_h *g);\n"
8247 #: ../src/guestfs-actions.pod:1200 ../fish/guestfish-actions.pod:806
8249 "This command runs the C<df -h> command to report disk space used in human-"
8254 #: ../src/guestfs-actions.pod:1212
8255 msgid "guestfs_dmesg"
8259 #: ../src/guestfs-actions.pod:1214
8263 " guestfs_dmesg (guestfs_h *g);\n"
8268 #: ../src/guestfs-actions.pod:1217 ../fish/guestfish-actions.pod:817
8270 "This returns the kernel messages (C<dmesg> output) from the guest kernel. "
8271 "This is sometimes useful for extended debugging of problems."
8275 #: ../src/guestfs-actions.pod:1221
8277 "Another way to get the same information is to enable verbose messages with "
8278 "C<guestfs_set_verbose> or by setting the environment variable "
8279 "C<LIBGUESTFS_DEBUG=1> before running the program."
8283 #: ../src/guestfs-actions.pod:1231
8284 msgid "guestfs_download"
8288 #: ../src/guestfs-actions.pod:1233
8292 " guestfs_download (guestfs_h *g,\n"
8293 " const char *remotefilename,\n"
8294 " const char *filename);\n"
8299 #: ../src/guestfs-actions.pod:1238 ../src/guestfs-actions.pod:1263
8300 #: ../fish/guestfish-actions.pod:830 ../fish/guestfish-actions.pod:843
8302 "Download file C<remotefilename> and save it as C<filename> on the local "
8307 #: ../src/guestfs-actions.pod:1241 ../src/guestfs-actions.pod:6980
8308 #: ../fish/guestfish-actions.pod:833 ../fish/guestfish-actions.pod:4668
8309 msgid "C<filename> can also be a named pipe."
8313 #: ../src/guestfs-actions.pod:1243
8314 msgid "See also C<guestfs_upload>, C<guestfs_cat>."
8318 #: ../src/guestfs-actions.pod:1254
8319 msgid "guestfs_download_offset"
8323 #: ../src/guestfs-actions.pod:1256
8327 " guestfs_download_offset (guestfs_h *g,\n"
8328 " const char *remotefilename,\n"
8329 " const char *filename,\n"
8330 " int64_t offset,\n"
8336 #: ../src/guestfs-actions.pod:1266 ../fish/guestfish-actions.pod:846
8338 "C<remotefilename> is read for C<size> bytes starting at C<offset> (this "
8339 "region must be within the file or device)."
8343 #: ../src/guestfs-actions.pod:1269
8345 "Note that there is no limit on the amount of data that can be downloaded "
8346 "with this call, unlike with C<guestfs_pread>, and this call always reads the "
8347 "full amount unless an error occurs."
8351 #: ../src/guestfs-actions.pod:1274
8352 msgid "See also C<guestfs_download>, C<guestfs_pread>."
8356 #: ../src/guestfs-actions.pod:1283 ../src/guestfs-actions.pod:7025
8357 msgid "(Added in 1.5.17)"
8361 #: ../src/guestfs-actions.pod:1285
8362 msgid "guestfs_drop_caches"
8366 #: ../src/guestfs-actions.pod:1287
8370 " guestfs_drop_caches (guestfs_h *g,\n"
8371 " int whattodrop);\n"
8376 #: ../src/guestfs-actions.pod:1291 ../fish/guestfish-actions.pod:862
8378 "This instructs the guest kernel to drop its page cache, and/or dentries and "
8379 "inode caches. The parameter C<whattodrop> tells the kernel what precisely "
8380 "to drop, see L<http://linux-mm.org/Drop_Caches>"
8384 #: ../src/guestfs-actions.pod:1296 ../fish/guestfish-actions.pod:867
8385 msgid "Setting C<whattodrop> to 3 should drop everything."
8389 #: ../src/guestfs-actions.pod:1298 ../fish/guestfish-actions.pod:869
8391 "This automatically calls L<sync(2)> before the operation, so that the "
8392 "maximum guest memory is freed."
8396 #: ../src/guestfs-actions.pod:1305
8401 #: ../src/guestfs-actions.pod:1307
8405 " guestfs_du (guestfs_h *g,\n"
8406 " const char *path);\n"
8411 #: ../src/guestfs-actions.pod:1311 ../fish/guestfish-actions.pod:876
8413 "This command runs the C<du -s> command to estimate file space usage for "
8418 #: ../src/guestfs-actions.pod:1314 ../fish/guestfish-actions.pod:879
8420 "C<path> can be a file or a directory. If C<path> is a directory then the "
8421 "estimate includes the contents of the directory and all subdirectories "
8426 #: ../src/guestfs-actions.pod:1318 ../fish/guestfish-actions.pod:883
8428 "The result is the estimated size in I<kilobytes> (ie. units of 1024 bytes)."
8432 #: ../src/guestfs-actions.pod:1330
8433 msgid "guestfs_e2fsck_f"
8437 #: ../src/guestfs-actions.pod:1332
8441 " guestfs_e2fsck_f (guestfs_h *g,\n"
8442 " const char *device);\n"
8447 #: ../src/guestfs-actions.pod:1336 ../fish/guestfish-actions.pod:890
8449 "This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3 filesystem checker "
8450 "on C<device>, noninteractively (I<-p>), even if the filesystem appears to be "
8455 #: ../src/guestfs-actions.pod:1340
8457 "This command is only needed because of C<guestfs_resize2fs> (q.v.). "
8458 "Normally you should use C<guestfs_fsck>."
8462 #: ../src/guestfs-actions.pod:1345
8463 msgid "(Added in 1.0.29)"
8467 #: ../src/guestfs-actions.pod:1347
8468 msgid "guestfs_echo_daemon"
8472 #: ../src/guestfs-actions.pod:1349
8476 " guestfs_echo_daemon (guestfs_h *g,\n"
8477 " char *const *words);\n"
8482 #: ../src/guestfs-actions.pod:1353 ../fish/guestfish-actions.pod:901
8484 "This command concatenates the list of C<words> passed with single spaces "
8485 "between them and returns the resulting string."
8489 #: ../src/guestfs-actions.pod:1356 ../fish/guestfish-actions.pod:904
8490 msgid "You can use this command to test the connection through to the daemon."
8494 #: ../src/guestfs-actions.pod:1358
8495 msgid "See also C<guestfs_ping_daemon>."
8499 #: ../src/guestfs-actions.pod:1363 ../src/guestfs-actions.pod:2097
8500 #: ../src/guestfs-actions.pod:6196
8501 msgid "(Added in 1.0.69)"
8505 #: ../src/guestfs-actions.pod:1365
8506 msgid "guestfs_egrep"
8510 #: ../src/guestfs-actions.pod:1367
8514 " guestfs_egrep (guestfs_h *g,\n"
8515 " const char *regex,\n"
8516 " const char *path);\n"
8521 #: ../src/guestfs-actions.pod:1372 ../fish/guestfish-actions.pod:912
8523 "This calls the external C<egrep> program and returns the matching lines."
8527 #: ../src/guestfs-actions.pod:1382 ../src/guestfs-actions.pod:1401
8528 #: ../src/guestfs-actions.pod:1458 ../src/guestfs-actions.pod:1504
8529 #: ../src/guestfs-actions.pod:1523 ../src/guestfs-actions.pod:2227
8530 #: ../src/guestfs-actions.pod:2246 ../src/guestfs-actions.pod:2402
8531 #: ../src/guestfs-actions.pod:2415 ../src/guestfs-actions.pod:2430
8532 #: ../src/guestfs-actions.pod:2476 ../src/guestfs-actions.pod:2498
8533 #: ../src/guestfs-actions.pod:2511 ../src/guestfs-actions.pod:3738
8534 #: ../src/guestfs-actions.pod:3752 ../src/guestfs-actions.pod:3765
8535 #: ../src/guestfs-actions.pod:3779 ../src/guestfs-actions.pod:4765
8536 #: ../src/guestfs-actions.pod:5696 ../src/guestfs-actions.pod:5745
8537 #: ../src/guestfs-actions.pod:6592 ../src/guestfs-actions.pod:6604
8538 #: ../src/guestfs-actions.pod:6617 ../src/guestfs-actions.pod:6630
8539 #: ../src/guestfs-actions.pod:6652 ../src/guestfs-actions.pod:6665
8540 #: ../src/guestfs-actions.pod:6678 ../src/guestfs-actions.pod:6691
8541 #: ../src/guestfs-actions.pod:7469 ../src/guestfs-actions.pod:7488
8542 #: ../src/guestfs-actions.pod:7574 ../src/guestfs-actions.pod:7593
8543 #: ../src/guestfs-actions.pod:7639 ../src/guestfs-actions.pod:7658
8544 msgid "(Added in 1.0.66)"
8548 #: ../src/guestfs-actions.pod:1384
8549 msgid "guestfs_egrepi"
8553 #: ../src/guestfs-actions.pod:1386
8557 " guestfs_egrepi (guestfs_h *g,\n"
8558 " const char *regex,\n"
8559 " const char *path);\n"
8564 #: ../src/guestfs-actions.pod:1391 ../fish/guestfish-actions.pod:922
8566 "This calls the external C<egrep -i> program and returns the matching lines."
8570 #: ../src/guestfs-actions.pod:1403
8571 msgid "guestfs_equal"
8575 #: ../src/guestfs-actions.pod:1405
8579 " guestfs_equal (guestfs_h *g,\n"
8580 " const char *file1,\n"
8581 " const char *file2);\n"
8586 #: ../src/guestfs-actions.pod:1410 ../fish/guestfish-actions.pod:932
8588 "This compares the two files C<file1> and C<file2> and returns true if their "
8589 "content is exactly equal, or false otherwise."
8593 #: ../src/guestfs-actions.pod:1413 ../fish/guestfish-actions.pod:935
8594 msgid "The external L<cmp(1)> program is used for the comparison."
8598 #: ../src/guestfs-actions.pod:1419
8599 msgid "guestfs_exists"
8603 #: ../src/guestfs-actions.pod:1421
8607 " guestfs_exists (guestfs_h *g,\n"
8608 " const char *path);\n"
8613 #: ../src/guestfs-actions.pod:1425 ../fish/guestfish-actions.pod:941
8615 "This returns C<true> if and only if there is a file, directory (or anything) "
8616 "with the given C<path> name."
8620 #: ../src/guestfs-actions.pod:1428
8621 msgid "See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>."
8625 #: ../src/guestfs-actions.pod:1434
8626 msgid "guestfs_fallocate"
8630 #: ../src/guestfs-actions.pod:1436
8634 " guestfs_fallocate (guestfs_h *g,\n"
8635 " const char *path,\n"
8641 #: ../src/guestfs-actions.pod:1441 ../src/guestfs-actions.pod:1467
8642 #: ../fish/guestfish-actions.pod:950 ../fish/guestfish-actions.pod:969
8644 "This command preallocates a file (containing zero bytes) named C<path> of "
8645 "size C<len> bytes. If the file exists already, it is overwritten."
8649 #: ../src/guestfs-actions.pod:1445 ../fish/guestfish-actions.pod:954
8651 "Do not confuse this with the guestfish-specific C<alloc> command which "
8652 "allocates a file in the host and attaches it as a device."
8656 #: ../src/guestfs-actions.pod:1451 ../fish/guestfish-actions.pod:958
8658 "This function is deprecated. In new code, use the C<fallocate64> call "
8663 #: ../src/guestfs-actions.pod:1460
8664 msgid "guestfs_fallocate64"
8668 #: ../src/guestfs-actions.pod:1462
8672 " guestfs_fallocate64 (guestfs_h *g,\n"
8673 " const char *path,\n"
8679 #: ../src/guestfs-actions.pod:1471
8681 "Note that this call allocates disk blocks for the file. To create a sparse "
8682 "file use C<guestfs_truncate_size> instead."
8686 #: ../src/guestfs-actions.pod:1474
8688 "The deprecated call C<guestfs_fallocate> does the same, but owing to an "
8689 "oversight it only allowed 30 bit lengths to be specified, effectively "
8690 "limiting the maximum size of files created through that call to 1GB."
8694 #: ../src/guestfs-actions.pod:1479 ../fish/guestfish-actions.pod:981
8696 "Do not confuse this with the guestfish-specific C<alloc> and C<sparse> "
8697 "commands which create a file in the host and attach it as a device."
8701 #: ../src/guestfs-actions.pod:1485
8702 msgid "(Added in 1.3.17)"
8706 #: ../src/guestfs-actions.pod:1487
8707 msgid "guestfs_fgrep"
8711 #: ../src/guestfs-actions.pod:1489
8715 " guestfs_fgrep (guestfs_h *g,\n"
8716 " const char *pattern,\n"
8717 " const char *path);\n"
8722 #: ../src/guestfs-actions.pod:1494 ../fish/guestfish-actions.pod:989
8724 "This calls the external C<fgrep> program and returns the matching lines."
8728 #: ../src/guestfs-actions.pod:1506
8729 msgid "guestfs_fgrepi"
8733 #: ../src/guestfs-actions.pod:1508
8737 " guestfs_fgrepi (guestfs_h *g,\n"
8738 " const char *pattern,\n"
8739 " const char *path);\n"
8744 #: ../src/guestfs-actions.pod:1513 ../fish/guestfish-actions.pod:999
8746 "This calls the external C<fgrep -i> program and returns the matching lines."
8750 #: ../src/guestfs-actions.pod:1525
8751 msgid "guestfs_file"
8755 #: ../src/guestfs-actions.pod:1527
8759 " guestfs_file (guestfs_h *g,\n"
8760 " const char *path);\n"
8765 #: ../src/guestfs-actions.pod:1531 ../fish/guestfish-actions.pod:1009
8767 "This call uses the standard L<file(1)> command to determine the type or "
8768 "contents of the file."
8772 #: ../src/guestfs-actions.pod:1534 ../fish/guestfish-actions.pod:1012
8774 "This call will also transparently look inside various types of compressed "
8779 #: ../src/guestfs-actions.pod:1537 ../fish/guestfish-actions.pod:1015
8781 "The exact command which runs is C<file -zb path>. Note in particular that "
8782 "the filename is not prepended to the output (the I<-b> option)."
8786 #: ../src/guestfs-actions.pod:1541 ../fish/guestfish-actions.pod:1019
8788 "The output depends on the output of the underlying L<file(1)> command and it "
8789 "can change in future in ways beyond our control. In other words, the output "
8790 "is not guaranteed by the ABI."
8794 #: ../src/guestfs-actions.pod:1545
8796 "See also: L<file(1)>, C<guestfs_vfs_type>, C<guestfs_lstat>, "
8797 "C<guestfs_is_file>, C<guestfs_is_blockdev> (etc), C<guestfs_is_zero>."
8801 #: ../src/guestfs-actions.pod:1553
8802 msgid "guestfs_file_architecture"
8806 #: ../src/guestfs-actions.pod:1555
8810 " guestfs_file_architecture (guestfs_h *g,\n"
8811 " const char *filename);\n"
8816 #: ../src/guestfs-actions.pod:1559 ../fish/guestfish-actions.pod:1030
8818 "This detects the architecture of the binary C<filename>, and returns it if "
8823 #: ../src/guestfs-actions.pod:1562 ../fish/guestfish-actions.pod:1033
8824 msgid "Currently defined architectures are:"
8828 #: ../src/guestfs-actions.pod:1566 ../fish/guestfish-actions.pod:1037
8833 #: ../src/guestfs-actions.pod:1568 ../fish/guestfish-actions.pod:1039
8835 "This string is returned for all 32 bit i386, i486, i586, i686 binaries "
8836 "irrespective of the precise processor requirements of the binary."
8840 #: ../src/guestfs-actions.pod:1571 ../fish/guestfish-actions.pod:1042
8845 #: ../src/guestfs-actions.pod:1573 ../fish/guestfish-actions.pod:1044
8846 msgid "64 bit x86-64."
8850 #: ../src/guestfs-actions.pod:1575 ../fish/guestfish-actions.pod:1046
8855 #: ../src/guestfs-actions.pod:1577 ../fish/guestfish-actions.pod:1048
8856 msgid "32 bit SPARC."
8860 #: ../src/guestfs-actions.pod:1579 ../fish/guestfish-actions.pod:1050
8865 #: ../src/guestfs-actions.pod:1581 ../fish/guestfish-actions.pod:1052
8866 msgid "64 bit SPARC V9 and above."
8870 #: ../src/guestfs-actions.pod:1583 ../fish/guestfish-actions.pod:1054
8875 #: ../src/guestfs-actions.pod:1585 ../fish/guestfish-actions.pod:1056
8876 msgid "Intel Itanium."
8877 msgstr "Intel Itanium."
8880 #: ../src/guestfs-actions.pod:1587 ../fish/guestfish-actions.pod:1058
8885 #: ../src/guestfs-actions.pod:1589 ../fish/guestfish-actions.pod:1060
8886 msgid "32 bit Power PC."
8890 #: ../src/guestfs-actions.pod:1591 ../fish/guestfish-actions.pod:1062
8895 #: ../src/guestfs-actions.pod:1593 ../fish/guestfish-actions.pod:1064
8896 msgid "64 bit Power PC."
8900 #: ../src/guestfs-actions.pod:1597 ../fish/guestfish-actions.pod:1068
8901 msgid "Libguestfs may return other architecture strings in future."
8905 #: ../src/guestfs-actions.pod:1599 ../fish/guestfish-actions.pod:1070
8906 msgid "The function works on at least the following types of files:"
8910 #: ../src/guestfs-actions.pod:1605 ../fish/guestfish-actions.pod:1076
8911 msgid "many types of Un*x and Linux binary"
8915 #: ../src/guestfs-actions.pod:1609 ../fish/guestfish-actions.pod:1080
8916 msgid "many types of Un*x and Linux shared library"
8920 #: ../src/guestfs-actions.pod:1613 ../fish/guestfish-actions.pod:1084
8921 msgid "Windows Win32 and Win64 binaries"
8925 #: ../src/guestfs-actions.pod:1617 ../fish/guestfish-actions.pod:1088
8926 msgid "Windows Win32 and Win64 DLLs"
8930 #: ../src/guestfs-actions.pod:1619 ../fish/guestfish-actions.pod:1090
8931 msgid "Win32 binaries and DLLs return C<i386>."
8935 #: ../src/guestfs-actions.pod:1621 ../fish/guestfish-actions.pod:1092
8936 msgid "Win64 binaries and DLLs return C<x86_64>."
8940 #: ../src/guestfs-actions.pod:1625 ../fish/guestfish-actions.pod:1096
8941 msgid "Linux kernel modules"
8945 #: ../src/guestfs-actions.pod:1629 ../fish/guestfish-actions.pod:1100
8946 msgid "Linux new-style initrd images"
8950 #: ../src/guestfs-actions.pod:1633 ../fish/guestfish-actions.pod:1104
8951 msgid "some non-x86 Linux vmlinuz kernels"
8955 #: ../src/guestfs-actions.pod:1637 ../fish/guestfish-actions.pod:1108
8956 msgid "What it can't do currently:"
8960 #: ../src/guestfs-actions.pod:1643 ../fish/guestfish-actions.pod:1114
8961 msgid "static libraries (libfoo.a)"
8965 #: ../src/guestfs-actions.pod:1647 ../fish/guestfish-actions.pod:1118
8966 msgid "Linux old-style initrd as compressed ext2 filesystem (RHEL 3)"
8970 #: ../src/guestfs-actions.pod:1651 ../fish/guestfish-actions.pod:1122
8971 msgid "x86 Linux vmlinuz kernels"
8975 #: ../src/guestfs-actions.pod:1653 ../fish/guestfish-actions.pod:1124
8977 "x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and "
8978 "compressed code, and are horribly hard to unpack. If you want to find the "
8979 "architecture of a kernel, use the architecture of the associated initrd or "
8980 "kernel module(s) instead."
8984 #: ../src/guestfs-actions.pod:1663 ../src/guestfs-actions.pod:1826
8985 #: ../src/guestfs-actions.pod:1843 ../src/guestfs-actions.pod:2531
8986 #: ../src/guestfs-actions.pod:2621 ../src/guestfs-actions.pod:2685
8987 #: ../src/guestfs-actions.pod:2868 ../src/guestfs-actions.pod:2886
8988 #: ../src/guestfs-actions.pod:2926 ../src/guestfs-actions.pod:3001
8989 #: ../src/guestfs-actions.pod:3092 ../src/guestfs-actions.pod:3321
8990 #: ../src/guestfs-actions.pod:3453
8991 msgid "(Added in 1.5.3)"
8995 #: ../src/guestfs-actions.pod:1665
8996 msgid "guestfs_filesize"
9000 #: ../src/guestfs-actions.pod:1667
9004 " guestfs_filesize (guestfs_h *g,\n"
9005 " const char *file);\n"
9010 #: ../src/guestfs-actions.pod:1671 ../fish/guestfish-actions.pod:1135
9011 msgid "This command returns the size of C<file> in bytes."
9015 #: ../src/guestfs-actions.pod:1673
9017 "To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>, "
9018 "C<guestfs_is_dir>, C<guestfs_is_file> etc. To get the size of block "
9019 "devices, use C<guestfs_blockdev_getsize64>."
9023 #: ../src/guestfs-actions.pod:1679
9024 msgid "(Added in 1.0.82)"
9028 #: ../src/guestfs-actions.pod:1681
9029 msgid "guestfs_fill"
9033 #: ../src/guestfs-actions.pod:1683
9037 " guestfs_fill (guestfs_h *g,\n"
9040 " const char *path);\n"
9045 #: ../src/guestfs-actions.pod:1689 ../fish/guestfish-actions.pod:1145
9047 "This command creates a new file called C<path>. The initial content of the "
9048 "file is C<len> octets of C<c>, where C<c> must be a number in the range C<"
9053 #: ../src/guestfs-actions.pod:1693
9055 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
9056 "C<guestfs_truncate_size>. To create a file with a pattern of repeating "
9057 "bytes use C<guestfs_fill_pattern>."
9061 #: ../src/guestfs-actions.pod:1705
9062 msgid "(Added in 1.0.79)"
9066 #: ../src/guestfs-actions.pod:1707
9067 msgid "guestfs_fill_pattern"
9071 #: ../src/guestfs-actions.pod:1709
9075 " guestfs_fill_pattern (guestfs_h *g,\n"
9076 " const char *pattern,\n"
9078 " const char *path);\n"
9083 #: ../src/guestfs-actions.pod:1715
9085 "This function is like C<guestfs_fill> except that it creates a new file of "
9086 "length C<len> containing the repeating pattern of bytes in C<pattern>. The "
9087 "pattern is truncated if necessary to ensure the length of the file is "
9088 "exactly C<len> bytes."
9092 #: ../src/guestfs-actions.pod:1727
9093 msgid "(Added in 1.3.12)"
9097 #: ../src/guestfs-actions.pod:1729
9098 msgid "guestfs_find"
9102 #: ../src/guestfs-actions.pod:1731
9106 " guestfs_find (guestfs_h *g,\n"
9107 " const char *directory);\n"
9112 #: ../src/guestfs-actions.pod:1735 ../fish/guestfish-actions.pod:1167
9114 "This command lists out all files and directories, recursively, starting at "
9115 "C<directory>. It is essentially equivalent to running the shell command "
9116 "C<find directory -print> but some post-processing happens on the output, "
9121 #: ../src/guestfs-actions.pod:1740 ../fish/guestfish-actions.pod:1172
9123 "This returns a list of strings I<without any prefix>. Thus if the directory "
9128 #: ../src/guestfs-actions.pod:1743 ../fish/guestfish-actions.pod:1175
9138 #: ../src/guestfs-actions.pod:1747
9140 "then the returned list from C<guestfs_find> C</tmp> would be 4 elements:"
9144 #: ../src/guestfs-actions.pod:1750 ../fish/guestfish-actions.pod:1182
9155 #: ../src/guestfs-actions.pod:1755 ../fish/guestfish-actions.pod:1187
9156 msgid "If C<directory> is not a directory, then this command returns an error."
9160 #: ../src/guestfs-actions.pod:1758 ../fish/guestfish-actions.pod:1190
9161 msgid "The returned list is sorted."
9165 #: ../src/guestfs-actions.pod:1760
9166 msgid "See also C<guestfs_find0>."
9170 #: ../src/guestfs-actions.pod:1769 ../src/guestfs-actions.pod:4182
9171 #: ../src/guestfs-actions.pod:5780
9172 msgid "(Added in 1.0.27)"
9176 #: ../src/guestfs-actions.pod:1771
9177 msgid "guestfs_find0"
9181 #: ../src/guestfs-actions.pod:1773
9185 " guestfs_find0 (guestfs_h *g,\n"
9186 " const char *directory,\n"
9187 " const char *files);\n"
9192 #: ../src/guestfs-actions.pod:1778 ../fish/guestfish-actions.pod:1201
9194 "This command lists out all files and directories, recursively, starting at "
9195 "C<directory>, placing the resulting list in the external file called "
9200 #: ../src/guestfs-actions.pod:1782
9202 "This command works the same way as C<guestfs_find> with the following "
9207 #: ../src/guestfs-actions.pod:1789 ../fish/guestfish-actions.pod:1212
9208 msgid "The resulting list is written to an external file."
9212 #: ../src/guestfs-actions.pod:1793 ../fish/guestfish-actions.pod:1216
9214 "Items (filenames) in the result are separated by C<\\0> characters. See "
9215 "L<find(1)> option I<-print0>."
9219 #: ../src/guestfs-actions.pod:1798 ../fish/guestfish-actions.pod:1221
9220 msgid "This command is not limited in the number of names that it can return."
9224 #: ../src/guestfs-actions.pod:1803 ../fish/guestfish-actions.pod:1226
9225 msgid "The result list is not sorted."
9229 #: ../src/guestfs-actions.pod:1809
9230 msgid "(Added in 1.0.74)"
9234 #: ../src/guestfs-actions.pod:1811
9235 msgid "guestfs_findfs_label"
9239 #: ../src/guestfs-actions.pod:1813
9243 " guestfs_findfs_label (guestfs_h *g,\n"
9244 " const char *label);\n"
9249 #: ../src/guestfs-actions.pod:1817 ../fish/guestfish-actions.pod:1236
9251 "This command searches the filesystems and returns the one which has the "
9252 "given label. An error is returned if no such filesystem can be found."
9256 #: ../src/guestfs-actions.pod:1821
9257 msgid "To find the label of a filesystem, use C<guestfs_vfs_label>."
9261 #: ../src/guestfs-actions.pod:1828
9262 msgid "guestfs_findfs_uuid"
9266 #: ../src/guestfs-actions.pod:1830
9270 " guestfs_findfs_uuid (guestfs_h *g,\n"
9271 " const char *uuid);\n"
9276 #: ../src/guestfs-actions.pod:1834 ../fish/guestfish-actions.pod:1246
9278 "This command searches the filesystems and returns the one which has the "
9279 "given UUID. An error is returned if no such filesystem can be found."
9283 #: ../src/guestfs-actions.pod:1838
9284 msgid "To find the UUID of a filesystem, use C<guestfs_vfs_uuid>."
9288 #: ../src/guestfs-actions.pod:1845
9289 msgid "guestfs_fsck"
9293 #: ../src/guestfs-actions.pod:1847
9297 " guestfs_fsck (guestfs_h *g,\n"
9298 " const char *fstype,\n"
9299 " const char *device);\n"
9304 #: ../src/guestfs-actions.pod:1852 ../fish/guestfish-actions.pod:1256
9306 "This runs the filesystem checker (fsck) on C<device> which should have "
9307 "filesystem type C<fstype>."
9311 #: ../src/guestfs-actions.pod:1855 ../fish/guestfish-actions.pod:1259
9313 "The returned integer is the status. See L<fsck(8)> for the list of status "
9314 "codes from C<fsck>."
9318 #: ../src/guestfs-actions.pod:1864 ../fish/guestfish-actions.pod:1268
9319 msgid "Multiple status codes can be summed together."
9323 #: ../src/guestfs-actions.pod:1868 ../fish/guestfish-actions.pod:1272
9325 "A non-zero return code can mean \"success\", for example if errors have been "
9326 "corrected on the filesystem."
9330 #: ../src/guestfs-actions.pod:1873 ../fish/guestfish-actions.pod:1277
9331 msgid "Checking or repairing NTFS volumes is not supported (by linux-ntfs)."
9335 #: ../src/guestfs-actions.pod:1878 ../fish/guestfish-actions.pod:1282
9337 "This command is entirely equivalent to running C<fsck -a -t fstype device>."
9341 #: ../src/guestfs-actions.pod:1882 ../src/guestfs-actions.pod:7512
9342 msgid "(Added in 1.0.16)"
9346 #: ../src/guestfs-actions.pod:1884
9347 msgid "guestfs_get_append"
9351 #: ../src/guestfs-actions.pod:1886
9355 " guestfs_get_append (guestfs_h *g);\n"
9360 #: ../src/guestfs-actions.pod:1889 ../fish/guestfish-actions.pod:1288
9362 "Return the additional kernel options which are added to the guest kernel "
9367 #: ../src/guestfs-actions.pod:1892 ../fish/guestfish-actions.pod:1291
9368 msgid "If C<NULL> then no options are added."
9372 #: ../src/guestfs-actions.pod:1894
9374 "This function returns a string which may be NULL. There is no way to return "
9375 "an error from this function. The string is owned by the guest handle and "
9376 "must I<not> be freed."
9380 #: ../src/guestfs-actions.pod:1898 ../src/guestfs-actions.pod:5458
9381 #: ../src/guestfs-actions.pod:5938 ../src/guestfs-actions.pod:6359
9382 #: ../src/guestfs-actions.pod:6378 ../src/guestfs-actions.pod:6394
9383 #: ../src/guestfs-actions.pod:6418 ../src/guestfs-actions.pod:7175
9384 #: ../src/guestfs-actions.pod:7193 ../src/guestfs-actions.pod:7555
9385 msgid "(Added in 1.0.26)"
9389 #: ../src/guestfs-actions.pod:1900
9390 msgid "guestfs_get_attach_method"
9394 #: ../src/guestfs-actions.pod:1902
9398 " guestfs_get_attach_method (guestfs_h *g);\n"
9403 #: ../src/guestfs-actions.pod:1905
9404 msgid "Return the current attach method. See C<guestfs_set_attach_method>."
9408 #: ../src/guestfs-actions.pod:1910
9409 msgid "guestfs_get_autosync"
9413 #: ../src/guestfs-actions.pod:1912
9417 " guestfs_get_autosync (guestfs_h *g);\n"
9422 #: ../src/guestfs-actions.pod:1915 ../fish/guestfish-actions.pod:1303
9423 msgid "Get the autosync flag."
9427 #: ../src/guestfs-actions.pod:1921
9428 msgid "guestfs_get_direct"
9432 #: ../src/guestfs-actions.pod:1923
9436 " guestfs_get_direct (guestfs_h *g);\n"
9441 #: ../src/guestfs-actions.pod:1926 ../fish/guestfish-actions.pod:1309
9442 msgid "Return the direct appliance mode flag."
9446 #: ../src/guestfs-actions.pod:1930 ../src/guestfs-actions.pod:6007
9447 msgid "(Added in 1.0.72)"
9451 #: ../src/guestfs-actions.pod:1932
9452 msgid "guestfs_get_e2label"
9456 #: ../src/guestfs-actions.pod:1934
9460 " guestfs_get_e2label (guestfs_h *g,\n"
9461 " const char *device);\n"
9466 #: ../src/guestfs-actions.pod:1938 ../fish/guestfish-actions.pod:1315
9468 "This returns the ext2/3/4 filesystem label of the filesystem on C<device>."
9472 #: ../src/guestfs-actions.pod:1944 ../fish/guestfish-actions.pod:1318
9474 "This function is deprecated. In new code, use the C<vfs_label> call instead."
9478 #: ../src/guestfs-actions.pod:1951 ../src/guestfs-actions.pod:1972
9479 #: ../src/guestfs-actions.pod:6025 ../src/guestfs-actions.pod:6044
9480 msgid "(Added in 1.0.15)"
9484 #: ../src/guestfs-actions.pod:1953
9485 msgid "guestfs_get_e2uuid"
9489 #: ../src/guestfs-actions.pod:1955
9493 " guestfs_get_e2uuid (guestfs_h *g,\n"
9494 " const char *device);\n"
9499 #: ../src/guestfs-actions.pod:1959 ../fish/guestfish-actions.pod:1329
9501 "This returns the ext2/3/4 filesystem UUID of the filesystem on C<device>."
9505 #: ../src/guestfs-actions.pod:1965 ../fish/guestfish-actions.pod:1332
9507 "This function is deprecated. In new code, use the C<vfs_uuid> call instead."
9511 #: ../src/guestfs-actions.pod:1974
9512 msgid "guestfs_get_memsize"
9516 #: ../src/guestfs-actions.pod:1976
9520 " guestfs_get_memsize (guestfs_h *g);\n"
9525 #: ../src/guestfs-actions.pod:1979 ../fish/guestfish-actions.pod:1343
9527 "This gets the memory size in megabytes allocated to the qemu subprocess."
9531 #: ../src/guestfs-actions.pod:1982
9533 "If C<guestfs_set_memsize> was not called on this handle, and if "
9534 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
9535 "value for memsize."
9539 #: ../src/guestfs-actions.pod:1986 ../src/guestfs-actions.pod:2067
9540 #: ../src/guestfs-actions.pod:6060 ../src/guestfs-actions.pod:6167
9541 #: ../fish/guestfish-actions.pod:1350 ../fish/guestfish-actions.pod:1401
9542 #: ../fish/guestfish-actions.pod:4043 ../fish/guestfish-actions.pod:4130
9544 "For more information on the architecture of libguestfs, see L<guestfs(3)>."
9548 #: ../src/guestfs-actions.pod:1991 ../src/guestfs-actions.pod:4473
9549 #: ../src/guestfs-actions.pod:4670 ../src/guestfs-actions.pod:4689
9550 #: ../src/guestfs-actions.pod:4708 ../src/guestfs-actions.pod:4720
9551 #: ../src/guestfs-actions.pod:4737 ../src/guestfs-actions.pod:4750
9552 #: ../src/guestfs-actions.pod:5683 ../src/guestfs-actions.pod:6065
9553 #: ../src/guestfs-actions.pod:6326 ../src/guestfs-actions.pod:6941
9554 msgid "(Added in 1.0.55)"
9558 #: ../src/guestfs-actions.pod:1993
9559 msgid "guestfs_get_network"
9563 #: ../src/guestfs-actions.pod:1995
9567 " guestfs_get_network (guestfs_h *g);\n"
9572 #: ../src/guestfs-actions.pod:1998 ../fish/guestfish-actions.pod:1357
9573 msgid "This returns the enable network flag."
9577 #: ../src/guestfs-actions.pod:2002 ../src/guestfs-actions.pod:6084
9578 msgid "(Added in 1.5.4)"
9582 #: ../src/guestfs-actions.pod:2004
9583 msgid "guestfs_get_path"
9587 #: ../src/guestfs-actions.pod:2006
9591 " guestfs_get_path (guestfs_h *g);\n"
9596 #: ../src/guestfs-actions.pod:2009 ../fish/guestfish-actions.pod:1363
9597 msgid "Return the current search path."
9601 #: ../src/guestfs-actions.pod:2011 ../fish/guestfish-actions.pod:1365
9603 "This is always non-NULL. If it wasn't set already, then this will return "
9608 #: ../src/guestfs-actions.pod:2014 ../src/guestfs-actions.pod:2043
9610 "This function returns a string, or NULL on error. The string is owned by "
9611 "the guest handle and must I<not> be freed."
9615 #: ../src/guestfs-actions.pod:2019
9616 msgid "guestfs_get_pid"
9620 #: ../src/guestfs-actions.pod:2021
9624 " guestfs_get_pid (guestfs_h *g);\n"
9629 #: ../src/guestfs-actions.pod:2024 ../fish/guestfish-actions.pod:1374
9631 "Return the process ID of the qemu subprocess. If there is no qemu "
9632 "subprocess, then this will return an error."
9636 #: ../src/guestfs-actions.pod:2027 ../fish/guestfish-actions.pod:1377
9637 msgid "This is an internal call used for debugging and testing."
9641 #: ../src/guestfs-actions.pod:2031
9642 msgid "(Added in 1.0.56)"
9646 #: ../src/guestfs-actions.pod:2033
9647 msgid "guestfs_get_qemu"
9651 #: ../src/guestfs-actions.pod:2035
9655 " guestfs_get_qemu (guestfs_h *g);\n"
9660 #: ../src/guestfs-actions.pod:2038 ../fish/guestfish-actions.pod:1383
9661 msgid "Return the current qemu binary."
9665 #: ../src/guestfs-actions.pod:2040 ../fish/guestfish-actions.pod:1385
9667 "This is always non-NULL. If it wasn't set already, then this will return "
9668 "the default qemu binary name."
9672 #: ../src/guestfs-actions.pod:2046 ../src/guestfs-actions.pod:6129
9673 msgid "(Added in 1.0.6)"
9677 #: ../src/guestfs-actions.pod:2048
9678 msgid "guestfs_get_recovery_proc"
9682 #: ../src/guestfs-actions.pod:2050
9686 " guestfs_get_recovery_proc (guestfs_h *g);\n"
9691 #: ../src/guestfs-actions.pod:2053 ../fish/guestfish-actions.pod:1392
9692 msgid "Return the recovery process enabled flag."
9696 #: ../src/guestfs-actions.pod:2057 ../src/guestfs-actions.pod:3571
9697 #: ../src/guestfs-actions.pod:3880 ../src/guestfs-actions.pod:4280
9698 #: ../src/guestfs-actions.pod:4312 ../src/guestfs-actions.pod:5388
9699 #: ../src/guestfs-actions.pod:5731 ../src/guestfs-actions.pod:6153
9700 #: ../src/guestfs-actions.pod:6844 ../src/guestfs-actions.pod:6864
9701 #: ../src/guestfs-actions.pod:7056
9702 msgid "(Added in 1.0.77)"
9706 #: ../src/guestfs-actions.pod:2059
9707 msgid "guestfs_get_selinux"
9711 #: ../src/guestfs-actions.pod:2061
9715 " guestfs_get_selinux (guestfs_h *g);\n"
9720 #: ../src/guestfs-actions.pod:2064
9722 "This returns the current setting of the selinux flag which is passed to the "
9723 "appliance at boot time. See C<guestfs_set_selinux>."
9727 #: ../src/guestfs-actions.pod:2072 ../src/guestfs-actions.pod:2135
9728 #: ../src/guestfs-actions.pod:6172 ../src/guestfs-actions.pod:6230
9729 msgid "(Added in 1.0.67)"
9733 #: ../src/guestfs-actions.pod:2074
9734 msgid "guestfs_get_state"
9738 #: ../src/guestfs-actions.pod:2076
9742 " guestfs_get_state (guestfs_h *g);\n"
9747 #: ../src/guestfs-actions.pod:2079 ../fish/guestfish-actions.pod:1408
9749 "This returns the current state as an opaque integer. This is only useful "
9750 "for printing debug and internal error messages."
9754 #: ../src/guestfs-actions.pod:2082 ../src/guestfs-actions.pod:3346
9755 #: ../src/guestfs-actions.pod:3375 ../src/guestfs-actions.pod:3436
9756 #: ../src/guestfs-actions.pod:3463 ../fish/guestfish-actions.pod:1411
9757 #: ../fish/guestfish-actions.pod:2331 ../fish/guestfish-actions.pod:2349
9758 #: ../fish/guestfish-actions.pod:2387 ../fish/guestfish-actions.pod:2403
9759 msgid "For more information on states, see L<guestfs(3)>."
9763 #: ../src/guestfs-actions.pod:2088
9764 msgid "guestfs_get_trace"
9768 #: ../src/guestfs-actions.pod:2090
9772 " guestfs_get_trace (guestfs_h *g);\n"
9777 #: ../src/guestfs-actions.pod:2093 ../fish/guestfish-actions.pod:1417
9778 msgid "Return the command trace flag."
9782 #: ../src/guestfs-actions.pod:2099
9783 msgid "guestfs_get_umask"
9787 #: ../src/guestfs-actions.pod:2101
9791 " guestfs_get_umask (guestfs_h *g);\n"
9796 #: ../src/guestfs-actions.pod:2104
9798 "Return the current umask. By default the umask is C<022> unless it has been "
9799 "set by calling C<guestfs_umask>."
9803 #: ../src/guestfs-actions.pod:2111
9804 msgid "guestfs_get_verbose"
9808 #: ../src/guestfs-actions.pod:2113
9812 " guestfs_get_verbose (guestfs_h *g);\n"
9817 #: ../src/guestfs-actions.pod:2116 ../fish/guestfish-actions.pod:1430
9818 msgid "This returns the verbose messages flag."
9822 #: ../src/guestfs-actions.pod:2122
9823 msgid "guestfs_getcon"
9827 #: ../src/guestfs-actions.pod:2124
9831 " guestfs_getcon (guestfs_h *g);\n"
9836 #: ../src/guestfs-actions.pod:2127 ../fish/guestfish-actions.pod:1436
9837 msgid "This gets the SELinux security context of the daemon."
9841 #: ../src/guestfs-actions.pod:2129
9843 "See the documentation about SELINUX in L<guestfs(3)>, and C<guestfs_setcon>"
9847 #: ../src/guestfs-actions.pod:2137
9848 msgid "guestfs_getxattr"
9852 #: ../src/guestfs-actions.pod:2139
9856 " guestfs_getxattr (guestfs_h *g,\n"
9857 " const char *path,\n"
9858 " const char *name,\n"
9859 " size_t *size_r);\n"
9864 #: ../src/guestfs-actions.pod:2145
9866 "Get a single extended attribute from file C<path> named C<name>. This call "
9867 "follows symlinks. If you want to lookup an extended attribute for the "
9868 "symlink itself, use C<guestfs_lgetxattr>."
9872 #: ../src/guestfs-actions.pod:2149 ../src/guestfs-actions.pod:3585
9874 "Normally it is better to get all extended attributes from a file in one go "
9875 "by calling C<guestfs_getxattrs>. However some Linux filesystem "
9876 "implementations are buggy and do not provide a way to list out attributes. "
9877 "For these filesystems (notably ntfs-3g) you have to know the names of the "
9878 "extended attributes you want in advance and call this function."
9882 #: ../src/guestfs-actions.pod:2156 ../src/guestfs-actions.pod:3592
9883 #: ../fish/guestfish-actions.pod:1456 ../fish/guestfish-actions.pod:2483
9885 "Extended attribute values are blobs of binary data. If there is no extended "
9886 "attribute named C<name>, this returns an error."
9890 #: ../src/guestfs-actions.pod:2159
9891 msgid "See also: C<guestfs_getxattrs>, C<guestfs_lgetxattr>, L<attr(5)>."
9895 #: ../src/guestfs-actions.pod:2161 ../src/guestfs-actions.pod:2352
9896 #: ../src/guestfs-actions.pod:2818 ../src/guestfs-actions.pod:3597
9897 #: ../src/guestfs-actions.pod:5381 ../src/guestfs-actions.pod:5407
9898 #: ../src/guestfs-actions.pod:5588
9900 "This function returns a buffer, or NULL on error. The size of the returned "
9901 "buffer is written to C<*size_r>. I<The caller must free the returned buffer "
9906 #: ../src/guestfs-actions.pod:2165 ../src/guestfs-actions.pod:3601
9907 msgid "(Added in 1.7.24)"
9911 #: ../src/guestfs-actions.pod:2167
9912 msgid "guestfs_getxattrs"
9916 #: ../src/guestfs-actions.pod:2169
9919 " struct guestfs_xattr_list *\n"
9920 " guestfs_getxattrs (guestfs_h *g,\n"
9921 " const char *path);\n"
9926 #: ../src/guestfs-actions.pod:2173 ../fish/guestfish-actions.pod:1465
9928 "This call lists the extended attributes of the file or directory C<path>."
9932 #: ../src/guestfs-actions.pod:2176 ../fish/guestfish-actions.pod:1468
9934 "At the system call level, this is a combination of the L<listxattr(2)> and "
9935 "L<getxattr(2)> calls."
9939 #: ../src/guestfs-actions.pod:2179
9940 msgid "See also: C<guestfs_lgetxattrs>, L<attr(5)>."
9944 #: ../src/guestfs-actions.pod:2181 ../src/guestfs-actions.pod:3613
9945 #: ../src/guestfs-actions.pod:4276
9947 "This function returns a C<struct guestfs_xattr_list *>, or NULL if there was "
9948 "an error. I<The caller must call C<guestfs_free_xattr_list> after use>."
9952 #: ../src/guestfs-actions.pod:2185 ../src/guestfs-actions.pod:3617
9953 #: ../src/guestfs-actions.pod:3794 ../src/guestfs-actions.pod:3830
9954 #: ../src/guestfs-actions.pod:5761 ../src/guestfs-actions.pod:6249
9955 #: ../src/guestfs-actions.pod:7620
9956 msgid "(Added in 1.0.59)"
9960 #: ../src/guestfs-actions.pod:2187
9961 msgid "guestfs_glob_expand"
9965 #: ../src/guestfs-actions.pod:2189
9969 " guestfs_glob_expand (guestfs_h *g,\n"
9970 " const char *pattern);\n"
9975 #: ../src/guestfs-actions.pod:2193 ../fish/guestfish-actions.pod:1477
9977 "This command searches for all the pathnames matching C<pattern> according to "
9978 "the wildcard expansion rules used by the shell."
9982 #: ../src/guestfs-actions.pod:2197 ../fish/guestfish-actions.pod:1481
9984 "If no paths match, then this returns an empty list (note: not an error)."
9988 #: ../src/guestfs-actions.pod:2200 ../fish/guestfish-actions.pod:1484
9990 "It is just a wrapper around the C L<glob(3)> function with flags C<GLOB_MARK|"
9991 "GLOB_BRACE>. See that manual page for more details."
9995 #: ../src/guestfs-actions.pod:2208 ../src/guestfs-actions.pod:6442
9996 #: ../src/guestfs-actions.pod:6459
9997 msgid "(Added in 1.0.50)"
10001 #: ../src/guestfs-actions.pod:2210
10002 msgid "guestfs_grep"
10006 #: ../src/guestfs-actions.pod:2212
10010 " guestfs_grep (guestfs_h *g,\n"
10011 " const char *regex,\n"
10012 " const char *path);\n"
10017 #: ../src/guestfs-actions.pod:2217 ../fish/guestfish-actions.pod:1492
10018 msgid "This calls the external C<grep> program and returns the matching lines."
10022 #: ../src/guestfs-actions.pod:2229
10023 msgid "guestfs_grepi"
10027 #: ../src/guestfs-actions.pod:2231
10031 " guestfs_grepi (guestfs_h *g,\n"
10032 " const char *regex,\n"
10033 " const char *path);\n"
10038 #: ../src/guestfs-actions.pod:2236 ../fish/guestfish-actions.pod:1502
10040 "This calls the external C<grep -i> program and returns the matching lines."
10044 #: ../src/guestfs-actions.pod:2248
10045 msgid "guestfs_grub_install"
10049 #: ../src/guestfs-actions.pod:2250
10053 " guestfs_grub_install (guestfs_h *g,\n"
10054 " const char *root,\n"
10055 " const char *device);\n"
10060 #: ../src/guestfs-actions.pod:2255 ../fish/guestfish-actions.pod:1512
10062 "This command installs GRUB (the Grand Unified Bootloader) on C<device>, with "
10063 "the root directory being C<root>."
10067 #: ../src/guestfs-actions.pod:2258 ../fish/guestfish-actions.pod:1515
10069 "Note: If grub-install reports the error \"No suitable drive was found in the "
10070 "generated device map.\" it may be that you need to create a C</boot/grub/"
10071 "device.map> file first that contains the mapping between grub device names "
10072 "and Linux device names. It is usually sufficient to create a file "
10077 #: ../src/guestfs-actions.pod:2265 ../fish/guestfish-actions.pod:1522
10080 " (hd0) /dev/vda\n"
10085 #: ../src/guestfs-actions.pod:2267 ../fish/guestfish-actions.pod:1524
10086 msgid "replacing C</dev/vda> with the name of the installation device."
10090 #: ../src/guestfs-actions.pod:2271
10091 msgid "(Added in 1.0.17)"
10095 #: ../src/guestfs-actions.pod:2273
10096 msgid "guestfs_head"
10100 #: ../src/guestfs-actions.pod:2275
10104 " guestfs_head (guestfs_h *g,\n"
10105 " const char *path);\n"
10110 #: ../src/guestfs-actions.pod:2279 ../fish/guestfish-actions.pod:1530
10112 "This command returns up to the first 10 lines of a file as a list of strings."
10116 #: ../src/guestfs-actions.pod:2291
10117 msgid "guestfs_head_n"
10121 #: ../src/guestfs-actions.pod:2293
10125 " guestfs_head_n (guestfs_h *g,\n"
10127 " const char *path);\n"
10132 #: ../src/guestfs-actions.pod:2298 ../fish/guestfish-actions.pod:1540
10134 "If the parameter C<nrlines> is a positive number, this returns the first "
10135 "C<nrlines> lines of the file C<path>."
10139 #: ../src/guestfs-actions.pod:2301 ../fish/guestfish-actions.pod:1543
10141 "If the parameter C<nrlines> is a negative number, this returns lines from "
10142 "the file C<path>, excluding the last C<nrlines> lines."
10146 #: ../src/guestfs-actions.pod:2304 ../src/guestfs-actions.pod:6739
10147 #: ../fish/guestfish-actions.pod:1546 ../fish/guestfish-actions.pod:4508
10148 msgid "If the parameter C<nrlines> is zero, this returns an empty list."
10152 #: ../src/guestfs-actions.pod:2315
10153 msgid "guestfs_hexdump"
10157 #: ../src/guestfs-actions.pod:2317
10161 " guestfs_hexdump (guestfs_h *g,\n"
10162 " const char *path);\n"
10167 #: ../src/guestfs-actions.pod:2321 ../fish/guestfish-actions.pod:1555
10169 "This runs C<hexdump -C> on the given C<path>. The result is the human-"
10170 "readable, canonical hex dump of the file."
10174 #: ../src/guestfs-actions.pod:2330 ../src/guestfs-actions.pod:6523
10175 #: ../src/guestfs-actions.pod:6578
10176 msgid "(Added in 1.0.22)"
10180 #: ../src/guestfs-actions.pod:2332
10181 msgid "guestfs_initrd_cat"
10185 #: ../src/guestfs-actions.pod:2334
10189 " guestfs_initrd_cat (guestfs_h *g,\n"
10190 " const char *initrdpath,\n"
10191 " const char *filename,\n"
10192 " size_t *size_r);\n"
10197 #: ../src/guestfs-actions.pod:2340 ../fish/guestfish-actions.pod:1565
10199 "This command unpacks the file C<filename> from the initrd file called "
10200 "C<initrdpath>. The filename must be given I<without> the initial C</> "
10205 #: ../src/guestfs-actions.pod:2344 ../fish/guestfish-actions.pod:1569
10207 "For example, in guestfish you could use the following command to examine the "
10208 "boot script (usually called C</init>) contained in a Linux initrd or "
10213 #: ../src/guestfs-actions.pod:2348 ../fish/guestfish-actions.pod:1573
10216 " initrd-cat /boot/initrd-<version>.img init\n"
10221 #: ../src/guestfs-actions.pod:2350
10222 msgid "See also C<guestfs_initrd_list>."
10226 #: ../src/guestfs-actions.pod:2361
10227 msgid "guestfs_initrd_list"
10231 #: ../src/guestfs-actions.pod:2363
10235 " guestfs_initrd_list (guestfs_h *g,\n"
10236 " const char *path);\n"
10241 #: ../src/guestfs-actions.pod:2367 ../fish/guestfish-actions.pod:1584
10242 msgid "This command lists out files contained in an initrd."
10246 #: ../src/guestfs-actions.pod:2369 ../fish/guestfish-actions.pod:1586
10248 "The files are listed without any initial C</> character. The files are "
10249 "listed in the order they appear (not necessarily alphabetical). Directory "
10250 "names are listed as separate items."
10254 #: ../src/guestfs-actions.pod:2373 ../fish/guestfish-actions.pod:1590
10256 "Old Linux kernels (2.4 and earlier) used a compressed ext2 filesystem as "
10257 "initrd. We I<only> support the newer initramfs format (compressed cpio "
10262 #: ../src/guestfs-actions.pod:2383
10263 msgid "guestfs_inotify_add_watch"
10267 #: ../src/guestfs-actions.pod:2385
10271 " guestfs_inotify_add_watch (guestfs_h *g,\n"
10272 " const char *path,\n"
10278 #: ../src/guestfs-actions.pod:2390 ../fish/guestfish-actions.pod:1598
10279 msgid "Watch C<path> for the events listed in C<mask>."
10283 #: ../src/guestfs-actions.pod:2392 ../fish/guestfish-actions.pod:1600
10285 "Note that if C<path> is a directory then events within that directory are "
10286 "watched, but this does I<not> happen recursively (in subdirectories)."
10290 #: ../src/guestfs-actions.pod:2396 ../fish/guestfish-actions.pod:1604
10292 "Note for non-C or non-Linux callers: the inotify events are defined by the "
10293 "Linux kernel ABI and are listed in C</usr/include/sys/inotify.h>."
10297 #: ../src/guestfs-actions.pod:2404
10298 msgid "guestfs_inotify_close"
10302 #: ../src/guestfs-actions.pod:2406
10306 " guestfs_inotify_close (guestfs_h *g);\n"
10311 #: ../src/guestfs-actions.pod:2409 ../fish/guestfish-actions.pod:1612
10313 "This closes the inotify handle which was previously opened by inotify_init. "
10314 "It removes all watches, throws away any pending events, and deallocates all "
10319 #: ../src/guestfs-actions.pod:2417
10320 msgid "guestfs_inotify_files"
10324 #: ../src/guestfs-actions.pod:2419
10328 " guestfs_inotify_files (guestfs_h *g);\n"
10333 #: ../src/guestfs-actions.pod:2422
10335 "This function is a helpful wrapper around C<guestfs_inotify_read> which just "
10336 "returns a list of pathnames of objects that were touched. The returned "
10337 "pathnames are sorted and deduplicated."
10341 #: ../src/guestfs-actions.pod:2432
10342 msgid "guestfs_inotify_init"
10346 #: ../src/guestfs-actions.pod:2434
10350 " guestfs_inotify_init (guestfs_h *g,\n"
10351 " int maxevents);\n"
10356 #: ../src/guestfs-actions.pod:2438 ../fish/guestfish-actions.pod:1628
10358 "This command creates a new inotify handle. The inotify subsystem can be "
10359 "used to notify events which happen to objects in the guest filesystem."
10363 #: ../src/guestfs-actions.pod:2442
10365 "C<maxevents> is the maximum number of events which will be queued up between "
10366 "calls to C<guestfs_inotify_read> or C<guestfs_inotify_files>. If this is "
10367 "passed as C<0>, then the kernel (or previously set) default is used. For "
10368 "Linux 2.6.29 the default was 16384 events. Beyond this limit, the kernel "
10369 "throws away events, but records the fact that it threw them away by setting "
10370 "a flag C<IN_Q_OVERFLOW> in the returned structure list (see "
10371 "C<guestfs_inotify_read>)."
10375 #: ../src/guestfs-actions.pod:2452
10377 "Before any events are generated, you have to add some watches to the "
10378 "internal watch list. See: C<guestfs_inotify_add_watch>, "
10379 "C<guestfs_inotify_rm_watch> and C<guestfs_inotify_watch_all>."
10383 #: ../src/guestfs-actions.pod:2458
10385 "Queued up events should be read periodically by calling "
10386 "C<guestfs_inotify_read> (or C<guestfs_inotify_files> which is just a helpful "
10387 "wrapper around C<guestfs_inotify_read>). If you don't read the events out "
10388 "often enough then you risk the internal queue overflowing."
10392 #: ../src/guestfs-actions.pod:2465
10394 "The handle should be closed after use by calling C<guestfs_inotify_close>. "
10395 "This also removes any watches automatically."
10399 #: ../src/guestfs-actions.pod:2469 ../fish/guestfish-actions.pod:1659
10401 "See also L<inotify(7)> for an overview of the inotify interface as exposed "
10402 "by the Linux kernel, which is roughly what we expose via libguestfs. Note "
10403 "that there is one global inotify handle per libguestfs instance."
10407 #: ../src/guestfs-actions.pod:2478
10408 msgid "guestfs_inotify_read"
10412 #: ../src/guestfs-actions.pod:2480
10415 " struct guestfs_inotify_event_list *\n"
10416 " guestfs_inotify_read (guestfs_h *g);\n"
10421 #: ../src/guestfs-actions.pod:2483 ../fish/guestfish-actions.pod:1668
10423 "Return the complete queue of events that have happened since the previous "
10428 #: ../src/guestfs-actions.pod:2486 ../fish/guestfish-actions.pod:1671
10429 msgid "If no events have happened, this returns an empty list."
10433 #: ../src/guestfs-actions.pod:2488 ../fish/guestfish-actions.pod:1673
10435 "I<Note>: In order to make sure that all events have been read, you must call "
10436 "this function repeatedly until it returns an empty list. The reason is that "
10437 "the call will read events up to the maximum appliance-to-host message size "
10438 "and leave remaining events in the queue."
10442 #: ../src/guestfs-actions.pod:2494
10444 "This function returns a C<struct guestfs_inotify_event_list *>, or NULL if "
10445 "there was an error. I<The caller must call "
10446 "C<guestfs_free_inotify_event_list> after use>."
10450 #: ../src/guestfs-actions.pod:2500
10451 msgid "guestfs_inotify_rm_watch"
10455 #: ../src/guestfs-actions.pod:2502
10459 " guestfs_inotify_rm_watch (guestfs_h *g,\n"
10465 #: ../src/guestfs-actions.pod:2506
10467 "Remove a previously defined inotify watch. See C<guestfs_inotify_add_watch>."
10471 #: ../src/guestfs-actions.pod:2513
10472 msgid "guestfs_inspect_get_arch"
10476 #: ../src/guestfs-actions.pod:2515
10480 " guestfs_inspect_get_arch (guestfs_h *g,\n"
10481 " const char *root);\n"
10486 #: ../src/guestfs-actions.pod:2519
10488 "This returns the architecture of the inspected operating system. The "
10489 "possible return values are listed under C<guestfs_file_architecture>."
10493 #: ../src/guestfs-actions.pod:2523 ../fish/guestfish-actions.pod:1694
10495 "If the architecture could not be determined, then the string C<unknown> is "
10500 #: ../src/guestfs-actions.pod:2526 ../src/guestfs-actions.pod:2616
10501 #: ../src/guestfs-actions.pod:2718 ../src/guestfs-actions.pod:2735
10502 #: ../src/guestfs-actions.pod:2864 ../src/guestfs-actions.pod:2947
10503 #: ../src/guestfs-actions.pod:2975 ../src/guestfs-actions.pod:2996
10504 #: ../src/guestfs-actions.pod:3047 ../src/guestfs-actions.pod:3087
10505 #: ../src/guestfs-actions.pod:3107 ../src/guestfs-actions.pod:3125
10506 #: ../src/guestfs-actions.pod:3142 ../src/guestfs-actions.pod:3156
10507 #: ../src/guestfs-actions.pod:3172 ../src/guestfs-actions.pod:3272
10508 #: ../src/guestfs-actions.pod:3313 ../fish/guestfish-actions.pod:1697
10509 #: ../fish/guestfish-actions.pod:1780 ../fish/guestfish-actions.pod:1859
10510 #: ../fish/guestfish-actions.pod:1871 ../fish/guestfish-actions.pod:1955
10511 #: ../fish/guestfish-actions.pod:2016 ../fish/guestfish-actions.pod:2037
10512 #: ../fish/guestfish-actions.pod:2051 ../fish/guestfish-actions.pod:2091
10513 #: ../fish/guestfish-actions.pod:2123 ../fish/guestfish-actions.pod:2136
10514 #: ../fish/guestfish-actions.pod:2149 ../fish/guestfish-actions.pod:2159
10515 #: ../fish/guestfish-actions.pod:2169 ../fish/guestfish-actions.pod:2181
10516 #: ../fish/guestfish-actions.pod:2277 ../fish/guestfish-actions.pod:2311
10517 msgid "Please read L<guestfs(3)/INSPECTION> for more details."
10521 #: ../src/guestfs-actions.pod:2533
10522 msgid "guestfs_inspect_get_distro"
10526 #: ../src/guestfs-actions.pod:2535
10530 " guestfs_inspect_get_distro (guestfs_h *g,\n"
10531 " const char *root);\n"
10536 #: ../src/guestfs-actions.pod:2539 ../fish/guestfish-actions.pod:1703
10538 "This returns the distro (distribution) of the inspected operating system."
10542 #: ../src/guestfs-actions.pod:2542 ../fish/guestfish-actions.pod:1706
10543 msgid "Currently defined distros are:"
10547 #: ../src/guestfs-actions.pod:2546 ../fish/guestfish-actions.pod:1710
10548 msgid "\"archlinux\""
10549 msgstr "\"archlinux\""
10552 #: ../src/guestfs-actions.pod:2548 ../fish/guestfish-actions.pod:1712
10553 msgid "Arch Linux."
10554 msgstr "Arch Linux."
10557 #: ../src/guestfs-actions.pod:2550 ../fish/guestfish-actions.pod:1714
10559 #| msgid "\"gentoo\""
10561 msgstr "\"gentoo\""
10564 #: ../src/guestfs-actions.pod:2552 ../fish/guestfish-actions.pod:1716
10569 #: ../src/guestfs-actions.pod:2554 ../fish/guestfish-actions.pod:1718
10571 msgstr "\"debian\""
10574 #: ../src/guestfs-actions.pod:2556 ../fish/guestfish-actions.pod:1720
10579 #: ../src/guestfs-actions.pod:2558 ../fish/guestfish-actions.pod:1722
10581 msgstr "\"fedora\""
10584 #: ../src/guestfs-actions.pod:2560 ../fish/guestfish-actions.pod:1724
10589 #: ../src/guestfs-actions.pod:2562 ../fish/guestfish-actions.pod:1726
10591 msgstr "\"gentoo\""
10594 #: ../src/guestfs-actions.pod:2564 ../fish/guestfish-actions.pod:1728
10599 #: ../src/guestfs-actions.pod:2566 ../fish/guestfish-actions.pod:1730
10600 msgid "\"linuxmint\""
10601 msgstr "\"linuxmint\""
10604 #: ../src/guestfs-actions.pod:2568 ../fish/guestfish-actions.pod:1732
10605 msgid "Linux Mint."
10606 msgstr "Linux Mint."
10609 #: ../src/guestfs-actions.pod:2570 ../fish/guestfish-actions.pod:1734
10610 msgid "\"mandriva\""
10611 msgstr "\"mandriva\""
10614 #: ../src/guestfs-actions.pod:2572 ../fish/guestfish-actions.pod:1736
10619 #: ../src/guestfs-actions.pod:2574 ../fish/guestfish-actions.pod:1738
10624 #: ../src/guestfs-actions.pod:2576 ../fish/guestfish-actions.pod:1740
10629 #: ../src/guestfs-actions.pod:2578 ../fish/guestfish-actions.pod:1742
10631 msgstr "\"pardus\""
10634 #: ../src/guestfs-actions.pod:2580 ../fish/guestfish-actions.pod:1744
10639 #: ../src/guestfs-actions.pod:2582 ../fish/guestfish-actions.pod:1746
10640 msgid "\"redhat-based\""
10641 msgstr "\"redhat-based\""
10644 #: ../src/guestfs-actions.pod:2584 ../fish/guestfish-actions.pod:1748
10645 msgid "Some Red Hat-derived distro."
10646 msgstr "Дистрибутив, що походить від Red Hat."
10649 #: ../src/guestfs-actions.pod:2586 ../fish/guestfish-actions.pod:1750
10654 #: ../src/guestfs-actions.pod:2588 ../fish/guestfish-actions.pod:1752
10656 #| msgid "Red Hat Enterprise Linux and some derivatives."
10657 msgid "Red Hat Enterprise Linux."
10658 msgstr "Red Hat Enterprise Linux та деякі з похідних дистрибутивів."
10661 #: ../src/guestfs-actions.pod:2590 ../fish/guestfish-actions.pod:1754
10662 msgid "\"scientificlinux\""
10666 #: ../src/guestfs-actions.pod:2592 ../fish/guestfish-actions.pod:1756
10667 msgid "Scientific Linux."
10671 #: ../src/guestfs-actions.pod:2594 ../fish/guestfish-actions.pod:1758
10672 msgid "\"slackware\""
10676 #: ../src/guestfs-actions.pod:2596 ../fish/guestfish-actions.pod:1760
10681 #: ../src/guestfs-actions.pod:2598 ../fish/guestfish-actions.pod:1762
10683 msgstr "\"ubuntu\""
10686 #: ../src/guestfs-actions.pod:2600 ../fish/guestfish-actions.pod:1764
10691 #: ../src/guestfs-actions.pod:2602 ../src/guestfs-actions.pod:2709
10692 #: ../src/guestfs-actions.pod:3078 ../fish/guestfish-actions.pod:1766
10693 #: ../fish/guestfish-actions.pod:1850 ../fish/guestfish-actions.pod:2114
10694 msgid "\"unknown\""
10695 msgstr "\"unknown\""
10698 #: ../src/guestfs-actions.pod:2604 ../fish/guestfish-actions.pod:1768
10699 msgid "The distro could not be determined."
10700 msgstr "Дистрибутив, тип якого не вдалося визначити."
10703 #: ../src/guestfs-actions.pod:2606 ../src/guestfs-actions.pod:3070
10704 #: ../fish/guestfish-actions.pod:1770 ../fish/guestfish-actions.pod:2106
10705 msgid "\"windows\""
10706 msgstr "\"windows\""
10709 #: ../src/guestfs-actions.pod:2608 ../fish/guestfish-actions.pod:1772
10711 "Windows does not have distributions. This string is returned if the OS type "
10716 #: ../src/guestfs-actions.pod:2613 ../src/guestfs-actions.pod:2715
10717 #: ../src/guestfs-actions.pod:3084 ../fish/guestfish-actions.pod:1777
10718 #: ../fish/guestfish-actions.pod:1856 ../fish/guestfish-actions.pod:2120
10720 "Future versions of libguestfs may return other strings here. The caller "
10721 "should be prepared to handle any string."
10725 #: ../src/guestfs-actions.pod:2623
10726 msgid "guestfs_inspect_get_drive_mappings"
10730 #: ../src/guestfs-actions.pod:2625
10734 " guestfs_inspect_get_drive_mappings (guestfs_h *g,\n"
10735 " const char *root);\n"
10740 #: ../src/guestfs-actions.pod:2629 ../fish/guestfish-actions.pod:1786
10742 "This call is useful for Windows which uses a primitive system of assigning "
10743 "drive letters (like \"C:\") to partitions. This inspection API examines the "
10744 "Windows Registry to find out how disks/partitions are mapped to drive "
10745 "letters, and returns a hash table as in the example below:"
10749 #: ../src/guestfs-actions.pod:2635 ../fish/guestfish-actions.pod:1792
10752 " C => /dev/vda2\n"
10753 " E => /dev/vdb1\n"
10754 " F => /dev/vdc1\n"
10759 #: ../src/guestfs-actions.pod:2639 ../fish/guestfish-actions.pod:1796
10761 "Note that keys are drive letters. For Windows, the key is case insensitive "
10762 "and just contains the drive letter, without the customary colon separator "
10767 #: ../src/guestfs-actions.pod:2643 ../fish/guestfish-actions.pod:1800
10769 "In future we may support other operating systems that also used drive "
10770 "letters, but the keys for those might not be case insensitive and might be "
10771 "longer than 1 character. For example in OS-9, hard drives were named C<h0>, "
10776 #: ../src/guestfs-actions.pod:2648 ../fish/guestfish-actions.pod:1805
10778 "For Windows guests, currently only hard drive mappings are returned. "
10779 "Removable disks (eg. DVD-ROMs) are ignored."
10783 #: ../src/guestfs-actions.pod:2651 ../fish/guestfish-actions.pod:1808
10785 "For guests that do not use drive mappings, or if the drive mappings could "
10786 "not be determined, this returns an empty hash table."
10790 #: ../src/guestfs-actions.pod:2654
10792 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
10793 "C<guestfs_inspect_get_mountpoints>, C<guestfs_inspect_get_filesystems>."
10797 #: ../src/guestfs-actions.pod:2658 ../src/guestfs-actions.pod:2920
10798 #: ../src/guestfs-actions.pod:3682 ../src/guestfs-actions.pod:4947
10799 #: ../src/guestfs-actions.pod:6880
10801 "This function returns a NULL-terminated array of strings, or NULL if there "
10802 "was an error. The array of strings will always have length C<2n+1>, where "
10803 "C<n> keys and values alternate, followed by the trailing NULL entry. I<The "
10804 "caller must free the strings and the array after use>."
10808 #: ../src/guestfs-actions.pod:2664
10809 msgid "guestfs_inspect_get_filesystems"
10813 #: ../src/guestfs-actions.pod:2666
10817 " guestfs_inspect_get_filesystems (guestfs_h *g,\n"
10818 " const char *root);\n"
10823 #: ../src/guestfs-actions.pod:2670 ../fish/guestfish-actions.pod:1819
10825 "This returns a list of all the filesystems that we think are associated with "
10826 "this operating system. This includes the root filesystem, other ordinary "
10827 "filesystems, and non-mounted devices like swap partitions."
10831 #: ../src/guestfs-actions.pod:2675 ../fish/guestfish-actions.pod:1824
10833 "In the case of a multi-boot virtual machine, it is possible for a filesystem "
10834 "to be shared between operating systems."
10838 #: ../src/guestfs-actions.pod:2678
10840 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
10841 "C<guestfs_inspect_get_mountpoints>."
10845 #: ../src/guestfs-actions.pod:2687
10846 msgid "guestfs_inspect_get_format"
10850 #: ../src/guestfs-actions.pod:2689
10854 " guestfs_inspect_get_format (guestfs_h *g,\n"
10855 " const char *root);\n"
10860 #: ../src/guestfs-actions.pod:2693 ../fish/guestfish-actions.pod:1834
10862 "This returns the format of the inspected operating system. You can use it "
10863 "to detect install images, live CDs and similar."
10867 #: ../src/guestfs-actions.pod:2696 ../fish/guestfish-actions.pod:1837
10868 msgid "Currently defined formats are:"
10872 #: ../src/guestfs-actions.pod:2700 ../fish/guestfish-actions.pod:1841
10873 msgid "\"installed\""
10874 msgstr "\"installed\""
10877 #: ../src/guestfs-actions.pod:2702 ../fish/guestfish-actions.pod:1843
10878 msgid "This is an installed operating system."
10879 msgstr "Це встановлена операційна система."
10882 #: ../src/guestfs-actions.pod:2704 ../fish/guestfish-actions.pod:1845
10883 msgid "\"installer\""
10887 #: ../src/guestfs-actions.pod:2706 ../fish/guestfish-actions.pod:1847
10889 "The disk image being inspected is not an installed operating system, but a "
10890 "I<bootable> install disk, live CD, or similar."
10894 #: ../src/guestfs-actions.pod:2711 ../fish/guestfish-actions.pod:1852
10895 msgid "The format of this disk image is not known."
10899 #: ../src/guestfs-actions.pod:2723
10900 msgid "guestfs_inspect_get_hostname"
10904 #: ../src/guestfs-actions.pod:2725
10908 " guestfs_inspect_get_hostname (guestfs_h *g,\n"
10909 " const char *root);\n"
10914 #: ../src/guestfs-actions.pod:2729 ../fish/guestfish-actions.pod:1865
10916 "This function returns the hostname of the operating system as found by "
10917 "inspection of the guest's configuration files."
10921 #: ../src/guestfs-actions.pod:2732 ../fish/guestfish-actions.pod:1868
10923 "If the hostname could not be determined, then the string C<unknown> is "
10928 #: ../src/guestfs-actions.pod:2740
10929 msgid "(Added in 1.7.9)"
10933 #: ../src/guestfs-actions.pod:2742
10934 msgid "guestfs_inspect_get_icon"
10938 #: ../src/guestfs-actions.pod:2744
10942 " guestfs_inspect_get_icon (guestfs_h *g,\n"
10943 " const char *root,\n"
10944 " size_t *size_r,\n"
10950 #: ../src/guestfs-actions.pod:2755
10953 " GUESTFS_INSPECT_GET_ICON_FAVICON, int favicon,\n"
10954 " GUESTFS_INSPECT_GET_ICON_HIGHQUALITY, int highquality,\n"
10959 #: ../src/guestfs-actions.pod:2758 ../fish/guestfish-actions.pod:1877
10961 "This function returns an icon corresponding to the inspected operating "
10962 "system. The icon is returned as a buffer containing a PNG image (re-encoded "
10963 "to PNG if necessary)."
10967 #: ../src/guestfs-actions.pod:2762 ../fish/guestfish-actions.pod:1881
10969 "If it was not possible to get an icon this function returns a zero-length "
10970 "(non-NULL) buffer. I<Callers must check for this case>."
10974 #: ../src/guestfs-actions.pod:2765 ../fish/guestfish-actions.pod:1884
10976 "Libguestfs will start by looking for a file called C</etc/favicon.png> or "
10977 "C<C:\\etc\\favicon.png> and if it has the correct format, the contents of "
10978 "this file will be returned. You can disable favicons by passing the "
10979 "optional C<favicon> boolean as false (default is true)."
10983 #: ../src/guestfs-actions.pod:2771 ../fish/guestfish-actions.pod:1890
10985 "If finding the favicon fails, then we look in other places in the guest for "
10990 #: ../src/guestfs-actions.pod:2774 ../fish/guestfish-actions.pod:1893
10992 "If the optional C<highquality> boolean is true then only high quality icons "
10993 "are returned, which means only icons of high resolution with an alpha "
10994 "channel. The default (false) is to return any icon we can, even if it is of "
10995 "substandard quality."
10999 #: ../src/guestfs-actions.pod:2785 ../fish/guestfish-actions.pod:1904
11001 "Unlike most other inspection API calls, the guest's disks must be mounted up "
11002 "before you call this, since it needs to read information from the guest "
11003 "filesystem during the call."
11007 #: ../src/guestfs-actions.pod:2791 ../fish/guestfish-actions.pod:1910
11009 "B<Security:> The icon data comes from the untrusted guest, and should be "
11010 "treated with caution. PNG files have been known to contain exploits. "
11011 "Ensure that libpng (or other relevant libraries) are fully up to date before "
11012 "trying to process or display the icon."
11016 #: ../src/guestfs-actions.pod:2799 ../fish/guestfish-actions.pod:1918
11018 "The PNG image returned can be any size. It might not be square. Libguestfs "
11019 "tries to return the largest, highest quality icon available. The "
11020 "application must scale the icon to the required size."
11024 #: ../src/guestfs-actions.pod:2806 ../fish/guestfish-actions.pod:1925
11026 "Extracting icons from Windows guests requires the external C<wrestool> "
11027 "program from the C<icoutils> package, and several programs (C<bmptopnm>, "
11028 "C<pnmtopng>, C<pamcut>) from the C<netpbm> package. These must be "
11029 "installed separately."
11033 #: ../src/guestfs-actions.pod:2813 ../fish/guestfish-actions.pod:1932
11035 "Operating system icons are usually trademarks. Seek legal advice before "
11036 "using trademarks in applications."
11040 #: ../src/guestfs-actions.pod:2822
11041 msgid "guestfs_inspect_get_icon_va"
11045 #: ../src/guestfs-actions.pod:2824
11049 " guestfs_inspect_get_icon_va (guestfs_h *g,\n"
11050 " const char *root,\n"
11051 " size_t *size_r,\n"
11052 " va_list args);\n"
11057 #: ../src/guestfs-actions.pod:2830
11058 msgid "This is the \"va_list variant\" of L</guestfs_inspect_get_icon>."
11062 #: ../src/guestfs-actions.pod:2834
11063 msgid "guestfs_inspect_get_icon_argv"
11067 #: ../src/guestfs-actions.pod:2836
11071 " guestfs_inspect_get_icon_argv (guestfs_h *g,\n"
11072 " const char *root,\n"
11073 " size_t *size_r,\n"
11074 " const struct guestfs_inspect_get_icon_argv *optargs);\n"
11079 #: ../src/guestfs-actions.pod:2842
11080 msgid "This is the \"argv variant\" of L</guestfs_inspect_get_icon>."
11084 #: ../src/guestfs-actions.pod:2846
11085 msgid "guestfs_inspect_get_major_version"
11089 #: ../src/guestfs-actions.pod:2848
11093 " guestfs_inspect_get_major_version (guestfs_h *g,\n"
11094 " const char *root);\n"
11099 #: ../src/guestfs-actions.pod:2852 ../fish/guestfish-actions.pod:1943
11101 "This returns the major version number of the inspected operating system."
11105 #: ../src/guestfs-actions.pod:2855 ../fish/guestfish-actions.pod:1946
11107 "Windows uses a consistent versioning scheme which is I<not> reflected in the "
11108 "popular public names used by the operating system. Notably the operating "
11109 "system known as \"Windows 7\" is really version 6.1 (ie. major = 6, minor = "
11110 "1). You can find out the real versions corresponding to releases of Windows "
11111 "by consulting Wikipedia or MSDN."
11115 #: ../src/guestfs-actions.pod:2862 ../src/guestfs-actions.pod:2879
11116 #: ../fish/guestfish-actions.pod:1953 ../fish/guestfish-actions.pod:1964
11117 msgid "If the version could not be determined, then C<0> is returned."
11121 #: ../src/guestfs-actions.pod:2870
11122 msgid "guestfs_inspect_get_minor_version"
11126 #: ../src/guestfs-actions.pod:2872
11130 " guestfs_inspect_get_minor_version (guestfs_h *g,\n"
11131 " const char *root);\n"
11136 #: ../src/guestfs-actions.pod:2876 ../fish/guestfish-actions.pod:1961
11138 "This returns the minor version number of the inspected operating system."
11142 #: ../src/guestfs-actions.pod:2881
11144 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
11145 "C<guestfs_inspect_get_major_version>."
11149 #: ../src/guestfs-actions.pod:2888
11150 msgid "guestfs_inspect_get_mountpoints"
11154 #: ../src/guestfs-actions.pod:2890
11158 " guestfs_inspect_get_mountpoints (guestfs_h *g,\n"
11159 " const char *root);\n"
11164 #: ../src/guestfs-actions.pod:2894 ../fish/guestfish-actions.pod:1973
11166 "This returns a hash of where we think the filesystems associated with this "
11167 "operating system should be mounted. Callers should note that this is at "
11168 "best an educated guess made by reading configuration files such as C</etc/"
11169 "fstab>. I<In particular note> that this may return filesystems which are "
11170 "non-existent or not mountable and callers should be prepared to handle or "
11171 "ignore failures if they try to mount them."
11175 #: ../src/guestfs-actions.pod:2903 ../fish/guestfish-actions.pod:1982
11177 "Each element in the returned hashtable has a key which is the path of the "
11178 "mountpoint (eg. C</boot>) and a value which is the filesystem that would be "
11179 "mounted there (eg. C</dev/sda1>)."
11183 #: ../src/guestfs-actions.pod:2908 ../fish/guestfish-actions.pod:1987
11185 "Non-mounted devices such as swap devices are I<not> returned in this list."
11189 #: ../src/guestfs-actions.pod:2911
11191 "For operating systems like Windows which still use drive letters, this call "
11192 "will only return an entry for the first drive \"mounted on\" C</>. For "
11193 "information about the mapping of drive letters to partitions, see "
11194 "C<guestfs_inspect_get_drive_mappings>."
11198 #: ../src/guestfs-actions.pod:2917
11200 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
11201 "C<guestfs_inspect_get_filesystems>."
11205 #: ../src/guestfs-actions.pod:2928
11206 msgid "guestfs_inspect_get_package_format"
11210 #: ../src/guestfs-actions.pod:2930
11214 " guestfs_inspect_get_package_format (guestfs_h *g,\n"
11215 " const char *root);\n"
11220 #: ../src/guestfs-actions.pod:2934
11222 "This function and C<guestfs_inspect_get_package_management> return the "
11223 "package format and package management tool used by the inspected operating "
11224 "system. For example for Fedora these functions would return C<rpm> (package "
11225 "format) and C<yum> (package management)."
11229 #: ../src/guestfs-actions.pod:2940 ../fish/guestfish-actions.pod:2009
11231 "This returns the string C<unknown> if we could not determine the package "
11232 "format I<or> if the operating system does not have a real packaging system "
11237 #: ../src/guestfs-actions.pod:2944 ../fish/guestfish-actions.pod:2013
11239 "Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>. "
11240 "Future versions of libguestfs may return other strings."
11244 #: ../src/guestfs-actions.pod:2952 ../src/guestfs-actions.pod:2980
11245 msgid "(Added in 1.7.5)"
11249 #: ../src/guestfs-actions.pod:2954
11250 msgid "guestfs_inspect_get_package_management"
11254 #: ../src/guestfs-actions.pod:2956
11258 " guestfs_inspect_get_package_management (guestfs_h *g,\n"
11259 " const char *root);\n"
11264 #: ../src/guestfs-actions.pod:2960
11266 "C<guestfs_inspect_get_package_format> and this function return the package "
11267 "format and package management tool used by the inspected operating system. "
11268 "For example for Fedora these functions would return C<rpm> (package format) "
11269 "and C<yum> (package management)."
11273 #: ../src/guestfs-actions.pod:2966 ../fish/guestfish-actions.pod:2028
11275 "This returns the string C<unknown> if we could not determine the package "
11276 "management tool I<or> if the operating system does not have a real packaging "
11277 "system (eg. Windows)."
11281 #: ../src/guestfs-actions.pod:2970 ../fish/guestfish-actions.pod:2032
11283 "Possible strings include: C<yum>, C<up2date>, C<apt> (for all Debian "
11284 "derivatives), C<portage>, C<pisi>, C<pacman>, C<urpmi>. Future versions of "
11285 "libguestfs may return other strings."
11289 #: ../src/guestfs-actions.pod:2982
11290 msgid "guestfs_inspect_get_product_name"
11294 #: ../src/guestfs-actions.pod:2984
11298 " guestfs_inspect_get_product_name (guestfs_h *g,\n"
11299 " const char *root);\n"
11304 #: ../src/guestfs-actions.pod:2988 ../fish/guestfish-actions.pod:2043
11306 "This returns the product name of the inspected operating system. The "
11307 "product name is generally some freeform string which can be displayed to the "
11308 "user, but should not be parsed by programs."
11312 #: ../src/guestfs-actions.pod:2993 ../fish/guestfish-actions.pod:2048
11314 "If the product name could not be determined, then the string C<unknown> is "
11319 #: ../src/guestfs-actions.pod:3003
11320 msgid "guestfs_inspect_get_product_variant"
11324 #: ../src/guestfs-actions.pod:3005
11328 " guestfs_inspect_get_product_variant (guestfs_h *g,\n"
11329 " const char *root);\n"
11334 #: ../src/guestfs-actions.pod:3009 ../fish/guestfish-actions.pod:2057
11336 #| msgid "This is an installed operating system."
11337 msgid "This returns the product variant of the inspected operating system."
11338 msgstr "Це встановлена операційна система."
11341 #: ../src/guestfs-actions.pod:3012 ../fish/guestfish-actions.pod:2060
11343 "For Windows guests, this returns the contents of the Registry key C<HKLM"
11344 "\\Software\\Microsoft\\Windows NT\\CurrentVersion> C<InstallationType> which "
11345 "is usually a string such as C<Client> or C<Server> (other values are "
11346 "possible). This can be used to distinguish consumer and enterprise versions "
11347 "of Windows that have the same version number (for example, Windows 7 and "
11348 "Windows 2008 Server are both version 6.1, but the former is C<Client> and "
11349 "the latter is C<Server>)."
11353 #: ../src/guestfs-actions.pod:3021 ../fish/guestfish-actions.pod:2069
11355 "For enterprise Linux guests, in future we intend this to return the product "
11356 "variant such as C<Desktop>, C<Server> and so on. But this is not "
11357 "implemented at present."
11361 #: ../src/guestfs-actions.pod:3025 ../fish/guestfish-actions.pod:2073
11363 "If the product variant could not be determined, then the string C<unknown> "
11368 #: ../src/guestfs-actions.pod:3028
11370 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
11371 "C<guestfs_inspect_get_product_name>, C<guestfs_inspect_get_major_version>."
11375 #: ../src/guestfs-actions.pod:3035
11376 msgid "guestfs_inspect_get_roots"
11380 #: ../src/guestfs-actions.pod:3037
11384 " guestfs_inspect_get_roots (guestfs_h *g);\n"
11389 #: ../src/guestfs-actions.pod:3040
11391 "This function is a convenient way to get the list of root devices, as "
11392 "returned from a previous call to C<guestfs_inspect_os>, but without redoing "
11393 "the whole inspection process."
11397 #: ../src/guestfs-actions.pod:3044
11399 "This returns an empty list if either no root devices were found or the "
11400 "caller has not called C<guestfs_inspect_os>."
11404 #: ../src/guestfs-actions.pod:3053
11405 msgid "(Added in 1.7.3)"
11409 #: ../src/guestfs-actions.pod:3055
11410 msgid "guestfs_inspect_get_type"
11414 #: ../src/guestfs-actions.pod:3057
11418 " guestfs_inspect_get_type (guestfs_h *g,\n"
11419 " const char *root);\n"
11424 #: ../src/guestfs-actions.pod:3061 ../fish/guestfish-actions.pod:2097
11426 "This returns the type of the inspected operating system. Currently defined "
11431 #: ../src/guestfs-actions.pod:3066 ../fish/guestfish-actions.pod:2102
11436 #: ../src/guestfs-actions.pod:3068 ../fish/guestfish-actions.pod:2104
11437 msgid "Any Linux-based operating system."
11441 #: ../src/guestfs-actions.pod:3072 ../fish/guestfish-actions.pod:2108
11442 msgid "Any Microsoft Windows operating system."
11446 #: ../src/guestfs-actions.pod:3074 ../fish/guestfish-actions.pod:2110
11447 msgid "\"freebsd\""
11448 msgstr "\"freebsd\""
11451 #: ../src/guestfs-actions.pod:3076 ../fish/guestfish-actions.pod:2112
11456 #: ../src/guestfs-actions.pod:3080 ../fish/guestfish-actions.pod:2116
11457 msgid "The operating system type could not be determined."
11461 #: ../src/guestfs-actions.pod:3094
11462 msgid "guestfs_inspect_get_windows_current_control_set"
11466 #: ../src/guestfs-actions.pod:3096
11470 " guestfs_inspect_get_windows_current_control_set (guestfs_h *g,\n"
11471 " const char *root);\n"
11476 #: ../src/guestfs-actions.pod:3100 ../fish/guestfish-actions.pod:2129
11478 "This returns the Windows CurrentControlSet of the inspected guest. The "
11479 "CurrentControlSet is a registry key name such as C<ControlSet001>."
11483 #: ../src/guestfs-actions.pod:3103 ../fish/guestfish-actions.pod:2132
11485 "This call assumes that the guest is Windows and that the Registry could be "
11486 "examined by inspection. If this is not the case then an error is returned."
11490 #: ../src/guestfs-actions.pod:3112
11491 msgid "guestfs_inspect_get_windows_systemroot"
11495 #: ../src/guestfs-actions.pod:3114
11499 " guestfs_inspect_get_windows_systemroot (guestfs_h *g,\n"
11500 " const char *root);\n"
11505 #: ../src/guestfs-actions.pod:3118 ../fish/guestfish-actions.pod:2142
11507 "This returns the Windows systemroot of the inspected guest. The systemroot "
11508 "is a directory path such as C</WINDOWS>."
11512 #: ../src/guestfs-actions.pod:3121 ../fish/guestfish-actions.pod:2145
11514 "This call assumes that the guest is Windows and that the systemroot could be "
11515 "determined by inspection. If this is not the case then an error is returned."
11519 #: ../src/guestfs-actions.pod:3130
11520 msgid "(Added in 1.5.25)"
11524 #: ../src/guestfs-actions.pod:3132
11525 msgid "guestfs_inspect_is_live"
11529 #: ../src/guestfs-actions.pod:3134
11533 " guestfs_inspect_is_live (guestfs_h *g,\n"
11534 " const char *root);\n"
11539 #: ../src/guestfs-actions.pod:3138
11541 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
11542 "disk), then this returns true if a live image was detected on the disk."
11546 #: ../src/guestfs-actions.pod:3146
11547 msgid "guestfs_inspect_is_multipart"
11551 #: ../src/guestfs-actions.pod:3148
11555 " guestfs_inspect_is_multipart (guestfs_h *g,\n"
11556 " const char *root);\n"
11561 #: ../src/guestfs-actions.pod:3152
11563 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
11564 "disk), then this returns true if the disk is part of a set."
11568 #: ../src/guestfs-actions.pod:3160
11569 msgid "guestfs_inspect_is_netinst"
11573 #: ../src/guestfs-actions.pod:3162
11577 " guestfs_inspect_is_netinst (guestfs_h *g,\n"
11578 " const char *root);\n"
11583 #: ../src/guestfs-actions.pod:3166
11585 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
11586 "disk), then this returns true if the disk is a network installer, ie. not a "
11587 "self-contained install CD but one which is likely to require network access "
11588 "to complete the install."
11592 #: ../src/guestfs-actions.pod:3176
11593 msgid "guestfs_inspect_list_applications"
11597 #: ../src/guestfs-actions.pod:3178
11600 " struct guestfs_application_list *\n"
11601 " guestfs_inspect_list_applications (guestfs_h *g,\n"
11602 " const char *root);\n"
11607 #: ../src/guestfs-actions.pod:3182 ../fish/guestfish-actions.pod:2187
11608 msgid "Return the list of applications installed in the operating system."
11612 #: ../src/guestfs-actions.pod:3184
11614 "I<Note:> This call works differently from other parts of the inspection "
11615 "API. You have to call C<guestfs_inspect_os>, then "
11616 "C<guestfs_inspect_get_mountpoints>, then mount up the disks, before calling "
11617 "this. Listing applications is a significantly more difficult operation "
11618 "which requires access to the full filesystem. Also note that unlike the "
11619 "other C<guestfs_inspect_get_*> calls which are just returning data cached in "
11620 "the libguestfs handle, this call actually reads parts of the mounted "
11621 "filesystems during the call."
11625 #: ../src/guestfs-actions.pod:3194 ../fish/guestfish-actions.pod:2199
11627 "This returns an empty list if the inspection code was not able to determine "
11628 "the list of applications."
11632 #: ../src/guestfs-actions.pod:3197 ../fish/guestfish-actions.pod:2202
11633 msgid "The application structure contains the following fields:"
11637 #: ../src/guestfs-actions.pod:3201 ../fish/guestfish-actions.pod:2206
11638 msgid "C<app_name>"
11639 msgstr "C<app_name>"
11642 #: ../src/guestfs-actions.pod:3203 ../fish/guestfish-actions.pod:2208
11644 "The name of the application. For Red Hat-derived and Debian-derived Linux "
11645 "guests, this is the package name."
11649 #: ../src/guestfs-actions.pod:3206 ../fish/guestfish-actions.pod:2211
11650 msgid "C<app_display_name>"
11651 msgstr "C<app_display_name>"
11654 #: ../src/guestfs-actions.pod:3208 ../fish/guestfish-actions.pod:2213
11656 "The display name of the application, sometimes localized to the install "
11657 "language of the guest operating system."
11661 #: ../src/guestfs-actions.pod:3211 ../fish/guestfish-actions.pod:2216
11663 "If unavailable this is returned as an empty string C<\"\">. Callers needing "
11664 "to display something can use C<app_name> instead."
11668 #: ../src/guestfs-actions.pod:3214 ../fish/guestfish-actions.pod:2219
11669 msgid "C<app_epoch>"
11670 msgstr "C<app_epoch>"
11673 #: ../src/guestfs-actions.pod:3216 ../fish/guestfish-actions.pod:2221
11675 "For package managers which use epochs, this contains the epoch of the "
11676 "package (an integer). If unavailable, this is returned as C<0>."
11680 #: ../src/guestfs-actions.pod:3219 ../fish/guestfish-actions.pod:2224
11681 msgid "C<app_version>"
11682 msgstr "C<app_version>"
11685 #: ../src/guestfs-actions.pod:3221 ../fish/guestfish-actions.pod:2226
11687 "The version string of the application or package. If unavailable this is "
11688 "returned as an empty string C<\"\">."
11692 #: ../src/guestfs-actions.pod:3224 ../fish/guestfish-actions.pod:2229
11693 msgid "C<app_release>"
11694 msgstr "C<app_release>"
11697 #: ../src/guestfs-actions.pod:3226 ../fish/guestfish-actions.pod:2231
11699 "The release string of the application or package, for package managers that "
11700 "use this. If unavailable this is returned as an empty string C<\"\">."
11704 #: ../src/guestfs-actions.pod:3230 ../fish/guestfish-actions.pod:2235
11705 msgid "C<app_install_path>"
11706 msgstr "C<app_install_path>"
11709 #: ../src/guestfs-actions.pod:3232 ../fish/guestfish-actions.pod:2237
11711 "The installation path of the application (on operating systems such as "
11712 "Windows which use installation paths). This path is in the format used by "
11713 "the guest operating system, it is not a libguestfs path."
11717 #: ../src/guestfs-actions.pod:3237 ../fish/guestfish-actions.pod:2242
11718 msgid "If unavailable this is returned as an empty string C<\"\">."
11722 #: ../src/guestfs-actions.pod:3239 ../fish/guestfish-actions.pod:2244
11723 msgid "C<app_trans_path>"
11724 msgstr "C<app_trans_path>"
11727 #: ../src/guestfs-actions.pod:3241 ../fish/guestfish-actions.pod:2246
11729 "The install path translated into a libguestfs path. If unavailable this is "
11730 "returned as an empty string C<\"\">."
11734 #: ../src/guestfs-actions.pod:3244 ../fish/guestfish-actions.pod:2249
11735 msgid "C<app_publisher>"
11736 msgstr "C<app_publisher>"
11739 #: ../src/guestfs-actions.pod:3246 ../fish/guestfish-actions.pod:2251
11741 "The name of the publisher of the application, for package managers that use "
11742 "this. If unavailable this is returned as an empty string C<\"\">."
11746 #: ../src/guestfs-actions.pod:3250 ../fish/guestfish-actions.pod:2255
11748 msgstr "C<app_url>"
11751 #: ../src/guestfs-actions.pod:3252 ../fish/guestfish-actions.pod:2257
11753 "The URL (eg. upstream URL) of the application. If unavailable this is "
11754 "returned as an empty string C<\"\">."
11758 #: ../src/guestfs-actions.pod:3255 ../fish/guestfish-actions.pod:2260
11759 msgid "C<app_source_package>"
11763 #: ../src/guestfs-actions.pod:3257 ../fish/guestfish-actions.pod:2262
11765 "For packaging systems which support this, the name of the source package. "
11766 "If unavailable this is returned as an empty string C<\"\">."
11770 #: ../src/guestfs-actions.pod:3260 ../fish/guestfish-actions.pod:2265
11771 msgid "C<app_summary>"
11775 #: ../src/guestfs-actions.pod:3262 ../fish/guestfish-actions.pod:2267
11777 "A short (usually one line) description of the application or package. If "
11778 "unavailable this is returned as an empty string C<\"\">."
11782 #: ../src/guestfs-actions.pod:3265 ../fish/guestfish-actions.pod:2270
11783 msgid "C<app_description>"
11787 #: ../src/guestfs-actions.pod:3267 ../fish/guestfish-actions.pod:2272
11789 "A longer description of the application or package. If unavailable this is "
11790 "returned as an empty string C<\"\">."
11794 #: ../src/guestfs-actions.pod:3274
11796 "This function returns a C<struct guestfs_application_list *>, or NULL if "
11797 "there was an error. I<The caller must call C<guestfs_free_application_list> "
11802 #: ../src/guestfs-actions.pod:3278
11803 msgid "(Added in 1.7.8)"
11807 #: ../src/guestfs-actions.pod:3280
11808 msgid "guestfs_inspect_os"
11812 #: ../src/guestfs-actions.pod:3282
11816 " guestfs_inspect_os (guestfs_h *g);\n"
11821 #: ../src/guestfs-actions.pod:3285 ../fish/guestfish-actions.pod:2283
11823 "This function uses other libguestfs functions and certain heuristics to "
11824 "inspect the disk(s) (usually disks belonging to a virtual machine), looking "
11825 "for operating systems."
11829 #: ../src/guestfs-actions.pod:3289 ../fish/guestfish-actions.pod:2287
11830 msgid "The list returned is empty if no operating systems were found."
11834 #: ../src/guestfs-actions.pod:3291 ../fish/guestfish-actions.pod:2289
11836 "If one operating system was found, then this returns a list with a single "
11837 "element, which is the name of the root filesystem of this operating system. "
11838 "It is also possible for this function to return a list containing more than "
11839 "one element, indicating a dual-boot or multi-boot virtual machine, with each "
11840 "element being the root filesystem of one of the operating systems."
11844 #: ../src/guestfs-actions.pod:3298
11846 "You can pass the root string(s) returned to other C<guestfs_inspect_get_*> "
11847 "functions in order to query further information about each operating system, "
11848 "such as the name and version."
11852 #: ../src/guestfs-actions.pod:3303
11854 "This function uses other libguestfs features such as C<guestfs_mount_ro> and "
11855 "C<guestfs_umount_all> in order to mount and unmount filesystems and look at "
11856 "the contents. This should be called with no disks currently mounted. The "
11857 "function may also use Augeas, so any existing Augeas handle will be closed."
11861 #: ../src/guestfs-actions.pod:3309 ../fish/guestfish-actions.pod:2307
11863 "This function cannot decrypt encrypted disks. The caller must do that first "
11864 "(supplying the necessary keys) if the disk is encrypted."
11868 #: ../src/guestfs-actions.pod:3315 ../src/guestfs-actions.pod:3640
11869 #: ../src/guestfs-actions.pod:3702
11870 msgid "See also C<guestfs_list_filesystems>."
11874 #: ../src/guestfs-actions.pod:3323
11875 msgid "guestfs_is_blockdev"
11879 #: ../src/guestfs-actions.pod:3325
11883 " guestfs_is_blockdev (guestfs_h *g,\n"
11884 " const char *path);\n"
11889 #: ../src/guestfs-actions.pod:3329 ../fish/guestfish-actions.pod:2319
11891 "This returns C<true> if and only if there is a block device with the given "
11896 #: ../src/guestfs-actions.pod:3332 ../src/guestfs-actions.pod:3361
11897 #: ../src/guestfs-actions.pod:3391 ../src/guestfs-actions.pod:3406
11898 #: ../src/guestfs-actions.pod:3422 ../src/guestfs-actions.pod:3478
11899 #: ../src/guestfs-actions.pod:3493
11900 msgid "See also C<guestfs_stat>."
11904 #: ../src/guestfs-actions.pod:3336 ../src/guestfs-actions.pod:3365
11905 #: ../src/guestfs-actions.pod:3410 ../src/guestfs-actions.pod:3482
11906 #: ../src/guestfs-actions.pod:3497
11907 msgid "(Added in 1.5.10)"
11911 #: ../src/guestfs-actions.pod:3338
11912 msgid "guestfs_is_busy"
11916 #: ../src/guestfs-actions.pod:3340
11920 " guestfs_is_busy (guestfs_h *g);\n"
11925 #: ../src/guestfs-actions.pod:3343 ../fish/guestfish-actions.pod:2328
11927 "This returns true iff this handle is busy processing a command (in the "
11932 #: ../src/guestfs-actions.pod:3352
11933 msgid "guestfs_is_chardev"
11937 #: ../src/guestfs-actions.pod:3354
11941 " guestfs_is_chardev (guestfs_h *g,\n"
11942 " const char *path);\n"
11947 #: ../src/guestfs-actions.pod:3358 ../fish/guestfish-actions.pod:2337
11949 "This returns C<true> if and only if there is a character device with the "
11950 "given C<path> name."
11954 #: ../src/guestfs-actions.pod:3367
11955 msgid "guestfs_is_config"
11959 #: ../src/guestfs-actions.pod:3369
11963 " guestfs_is_config (guestfs_h *g);\n"
11968 #: ../src/guestfs-actions.pod:3372 ../fish/guestfish-actions.pod:2346
11970 "This returns true iff this handle is being configured (in the C<CONFIG> "
11975 #: ../src/guestfs-actions.pod:3381
11976 msgid "guestfs_is_dir"
11980 #: ../src/guestfs-actions.pod:3383
11984 " guestfs_is_dir (guestfs_h *g,\n"
11985 " const char *path);\n"
11990 #: ../src/guestfs-actions.pod:3387 ../fish/guestfish-actions.pod:2355
11992 "This returns C<true> if and only if there is a directory with the given "
11993 "C<path> name. Note that it returns false for other objects like files."
11997 #: ../src/guestfs-actions.pod:3397
11998 msgid "guestfs_is_fifo"
12002 #: ../src/guestfs-actions.pod:3399
12006 " guestfs_is_fifo (guestfs_h *g,\n"
12007 " const char *path);\n"
12012 #: ../src/guestfs-actions.pod:3403 ../fish/guestfish-actions.pod:2365
12014 "This returns C<true> if and only if there is a FIFO (named pipe) with the "
12015 "given C<path> name."
12019 #: ../src/guestfs-actions.pod:3412
12020 msgid "guestfs_is_file"
12024 #: ../src/guestfs-actions.pod:3414
12028 " guestfs_is_file (guestfs_h *g,\n"
12029 " const char *path);\n"
12034 #: ../src/guestfs-actions.pod:3418 ../fish/guestfish-actions.pod:2374
12036 "This returns C<true> if and only if there is a regular file with the given "
12037 "C<path> name. Note that it returns false for other objects like directories."
12041 #: ../src/guestfs-actions.pod:3428
12042 msgid "guestfs_is_launching"
12046 #: ../src/guestfs-actions.pod:3430
12050 " guestfs_is_launching (guestfs_h *g);\n"
12055 #: ../src/guestfs-actions.pod:3433 ../fish/guestfish-actions.pod:2384
12057 "This returns true iff this handle is launching the subprocess (in the "
12058 "C<LAUNCHING> state)."
12062 #: ../src/guestfs-actions.pod:3442
12063 msgid "guestfs_is_lv"
12067 #: ../src/guestfs-actions.pod:3444
12071 " guestfs_is_lv (guestfs_h *g,\n"
12072 " const char *device);\n"
12077 #: ../src/guestfs-actions.pod:3448 ../fish/guestfish-actions.pod:2393
12079 "This command tests whether C<device> is a logical volume, and returns true "
12080 "iff this is the case."
12084 #: ../src/guestfs-actions.pod:3455
12085 msgid "guestfs_is_ready"
12089 #: ../src/guestfs-actions.pod:3457
12093 " guestfs_is_ready (guestfs_h *g);\n"
12098 #: ../src/guestfs-actions.pod:3460 ../fish/guestfish-actions.pod:2400
12100 "This returns true iff this handle is ready to accept commands (in the "
12105 #: ../src/guestfs-actions.pod:3469
12106 msgid "guestfs_is_socket"
12110 #: ../src/guestfs-actions.pod:3471
12114 " guestfs_is_socket (guestfs_h *g,\n"
12115 " const char *path);\n"
12120 #: ../src/guestfs-actions.pod:3475 ../fish/guestfish-actions.pod:2409
12122 "This returns C<true> if and only if there is a Unix domain socket with the "
12123 "given C<path> name."
12127 #: ../src/guestfs-actions.pod:3484
12128 msgid "guestfs_is_symlink"
12132 #: ../src/guestfs-actions.pod:3486
12136 " guestfs_is_symlink (guestfs_h *g,\n"
12137 " const char *path);\n"
12142 #: ../src/guestfs-actions.pod:3490 ../fish/guestfish-actions.pod:2418
12144 "This returns C<true> if and only if there is a symbolic link with the given "
12149 #: ../src/guestfs-actions.pod:3499
12150 msgid "guestfs_is_zero"
12154 #: ../src/guestfs-actions.pod:3501
12158 " guestfs_is_zero (guestfs_h *g,\n"
12159 " const char *path);\n"
12164 #: ../src/guestfs-actions.pod:3505 ../fish/guestfish-actions.pod:2427
12166 "This returns true iff the file exists and the file is empty or it contains "
12171 #: ../src/guestfs-actions.pod:3510
12172 msgid "guestfs_is_zero_device"
12176 #: ../src/guestfs-actions.pod:3512
12180 " guestfs_is_zero_device (guestfs_h *g,\n"
12181 " const char *device);\n"
12186 #: ../src/guestfs-actions.pod:3516 ../fish/guestfish-actions.pod:2434
12187 msgid "This returns true iff the device exists and contains all zero bytes."
12191 #: ../src/guestfs-actions.pod:3518 ../fish/guestfish-actions.pod:2436
12192 msgid "Note that for large devices this can take a long time to run."
12196 #: ../src/guestfs-actions.pod:3522
12197 msgid "guestfs_kill_subprocess"
12201 #: ../src/guestfs-actions.pod:3524
12205 " guestfs_kill_subprocess (guestfs_h *g);\n"
12210 #: ../src/guestfs-actions.pod:3527 ../fish/guestfish-actions.pod:2442
12211 msgid "This kills the qemu subprocess. You should never need to call this."
12215 #: ../src/guestfs-actions.pod:3533
12216 msgid "guestfs_launch"
12220 #: ../src/guestfs-actions.pod:3535
12224 " guestfs_launch (guestfs_h *g);\n"
12229 #: ../src/guestfs-actions.pod:3538 ../fish/guestfish-actions.pod:2450
12231 "Internally libguestfs is implemented by running a virtual machine using "
12236 #: ../src/guestfs-actions.pod:3541 ../fish/guestfish-actions.pod:2453
12238 "You should call this after configuring the handle (eg. adding drives) but "
12239 "before performing any actions."
12243 #: ../src/guestfs-actions.pod:3553
12244 msgid "guestfs_lchown"
12248 #: ../src/guestfs-actions.pod:3555
12252 " guestfs_lchown (guestfs_h *g,\n"
12255 " const char *path);\n"
12260 #: ../src/guestfs-actions.pod:3561
12262 "Change the file owner to C<owner> and group to C<group>. This is like "
12263 "C<guestfs_chown> but if C<path> is a symlink then the link itself is "
12264 "changed, not the target."
12268 #: ../src/guestfs-actions.pod:3573
12269 msgid "guestfs_lgetxattr"
12273 #: ../src/guestfs-actions.pod:3575
12277 " guestfs_lgetxattr (guestfs_h *g,\n"
12278 " const char *path,\n"
12279 " const char *name,\n"
12280 " size_t *size_r);\n"
12285 #: ../src/guestfs-actions.pod:3581 ../fish/guestfish-actions.pod:2472
12287 "Get a single extended attribute from file C<path> named C<name>. If C<path> "
12288 "is a symlink, then this call returns an extended attribute from the symlink."
12292 #: ../src/guestfs-actions.pod:3595
12293 msgid "See also: C<guestfs_lgetxattrs>, C<guestfs_getxattr>, L<attr(5)>."
12297 #: ../src/guestfs-actions.pod:3603
12298 msgid "guestfs_lgetxattrs"
12302 #: ../src/guestfs-actions.pod:3605
12305 " struct guestfs_xattr_list *\n"
12306 " guestfs_lgetxattrs (guestfs_h *g,\n"
12307 " const char *path);\n"
12312 #: ../src/guestfs-actions.pod:3609
12314 "This is the same as C<guestfs_getxattrs>, but if C<path> is a symbolic link, "
12315 "then it returns the extended attributes of the link itself."
12319 #: ../src/guestfs-actions.pod:3619
12320 msgid "guestfs_list_9p"
12324 #: ../src/guestfs-actions.pod:3621
12328 " guestfs_list_9p (guestfs_h *g);\n"
12333 #: ../src/guestfs-actions.pod:3624 ../fish/guestfish-actions.pod:2500
12335 "List all 9p filesystems attached to the guest. A list of mount tags is "
12340 #: ../src/guestfs-actions.pod:3631
12341 msgid "guestfs_list_devices"
12345 #: ../src/guestfs-actions.pod:3633
12349 " guestfs_list_devices (guestfs_h *g);\n"
12354 #: ../src/guestfs-actions.pod:3636 ../fish/guestfish-actions.pod:2507
12355 msgid "List all the block devices."
12359 #: ../src/guestfs-actions.pod:3638 ../fish/guestfish-actions.pod:2509
12360 msgid "The full block device names are returned, eg. C</dev/sda>."
12364 #: ../src/guestfs-actions.pod:3648
12365 msgid "guestfs_list_filesystems"
12369 #: ../src/guestfs-actions.pod:3650
12373 " guestfs_list_filesystems (guestfs_h *g);\n"
12378 #: ../src/guestfs-actions.pod:3653 ../fish/guestfish-actions.pod:2517
12380 "This inspection command looks for filesystems on partitions, block devices "
12381 "and logical volumes, returning a list of devices containing filesystems and "
12386 #: ../src/guestfs-actions.pod:3657 ../fish/guestfish-actions.pod:2521
12388 "The return value is a hash, where the keys are the devices containing "
12389 "filesystems, and the values are the filesystem types. For example:"
12393 #: ../src/guestfs-actions.pod:3661 ../fish/guestfish-actions.pod:2525
12396 " \"/dev/sda1\" => \"ntfs\"\n"
12397 " \"/dev/sda2\" => \"ext2\"\n"
12398 " \"/dev/vg_guest/lv_root\" => \"ext4\"\n"
12399 " \"/dev/vg_guest/lv_swap\" => \"swap\"\n"
12404 #: ../src/guestfs-actions.pod:3666 ../fish/guestfish-actions.pod:2530
12406 "The value can have the special value \"unknown\", meaning the content of the "
12407 "device is undetermined or empty. \"swap\" means a Linux swap partition."
12411 #: ../src/guestfs-actions.pod:3670
12413 "This command runs other libguestfs commands, which might include "
12414 "C<guestfs_mount> and C<guestfs_umount>, and therefore you should use this "
12415 "soon after launch and only when nothing is mounted."
12419 #: ../src/guestfs-actions.pod:3674
12421 "Not all of the filesystems returned will be mountable. In particular, swap "
12422 "partitions are returned in the list. Also this command does not check that "
12423 "each filesystem found is valid and mountable, and some filesystems might be "
12424 "mountable but require special options. Filesystems may not all belong to a "
12425 "single logical operating system (use C<guestfs_inspect_os> to look for OSes)."
12429 #: ../src/guestfs-actions.pod:3688 ../src/guestfs-actions.pod:5348
12430 msgid "(Added in 1.5.15)"
12434 #: ../src/guestfs-actions.pod:3690
12435 msgid "guestfs_list_partitions"
12439 #: ../src/guestfs-actions.pod:3692
12443 " guestfs_list_partitions (guestfs_h *g);\n"
12448 #: ../src/guestfs-actions.pod:3695 ../fish/guestfish-actions.pod:2550
12449 msgid "List all the partitions detected on all block devices."
12453 #: ../src/guestfs-actions.pod:3697 ../fish/guestfish-actions.pod:2552
12454 msgid "The full partition device names are returned, eg. C</dev/sda1>"
12458 #: ../src/guestfs-actions.pod:3699
12460 "This does not return logical volumes. For that you will need to call "
12465 #: ../src/guestfs-actions.pod:3710
12470 #: ../src/guestfs-actions.pod:3712
12474 " guestfs_ll (guestfs_h *g,\n"
12475 " const char *directory);\n"
12480 #: ../src/guestfs-actions.pod:3716 ../fish/guestfish-actions.pod:2563
12482 "List the files in C<directory> (relative to the root directory, there is no "
12483 "cwd) in the format of 'ls -la'."
12487 #: ../src/guestfs-actions.pod:3719 ../fish/guestfish-actions.pod:2566
12489 "This command is mostly useful for interactive sessions. It is I<not> "
12490 "intended that you try to parse the output string."
12494 #: ../src/guestfs-actions.pod:3727
12499 #: ../src/guestfs-actions.pod:3729
12503 " guestfs_ln (guestfs_h *g,\n"
12504 " const char *target,\n"
12505 " const char *linkname);\n"
12510 #: ../src/guestfs-actions.pod:3734 ../fish/guestfish-actions.pod:2573
12511 msgid "This command creates a hard link using the C<ln> command."
12515 #: ../src/guestfs-actions.pod:3740
12516 msgid "guestfs_ln_f"
12520 #: ../src/guestfs-actions.pod:3742
12524 " guestfs_ln_f (guestfs_h *g,\n"
12525 " const char *target,\n"
12526 " const char *linkname);\n"
12531 #: ../src/guestfs-actions.pod:3747 ../fish/guestfish-actions.pod:2579
12533 "This command creates a hard link using the C<ln -f> command. The I<-f> "
12534 "option removes the link (C<linkname>) if it exists already."
12538 #: ../src/guestfs-actions.pod:3754
12539 msgid "guestfs_ln_s"
12543 #: ../src/guestfs-actions.pod:3756
12547 " guestfs_ln_s (guestfs_h *g,\n"
12548 " const char *target,\n"
12549 " const char *linkname);\n"
12554 #: ../src/guestfs-actions.pod:3761 ../fish/guestfish-actions.pod:2586
12555 msgid "This command creates a symbolic link using the C<ln -s> command."
12559 #: ../src/guestfs-actions.pod:3767
12560 msgid "guestfs_ln_sf"
12564 #: ../src/guestfs-actions.pod:3769
12568 " guestfs_ln_sf (guestfs_h *g,\n"
12569 " const char *target,\n"
12570 " const char *linkname);\n"
12575 #: ../src/guestfs-actions.pod:3774 ../fish/guestfish-actions.pod:2592
12577 "This command creates a symbolic link using the C<ln -sf> command, The I<-f> "
12578 "option removes the link (C<linkname>) if it exists already."
12582 #: ../src/guestfs-actions.pod:3781
12583 msgid "guestfs_lremovexattr"
12587 #: ../src/guestfs-actions.pod:3783
12591 " guestfs_lremovexattr (guestfs_h *g,\n"
12592 " const char *xattr,\n"
12593 " const char *path);\n"
12598 #: ../src/guestfs-actions.pod:3788
12600 "This is the same as C<guestfs_removexattr>, but if C<path> is a symbolic "
12601 "link, then it removes an extended attribute of the link itself."
12605 #: ../src/guestfs-actions.pod:3796
12610 #: ../src/guestfs-actions.pod:3798
12614 " guestfs_ls (guestfs_h *g,\n"
12615 " const char *directory);\n"
12620 #: ../src/guestfs-actions.pod:3802 ../fish/guestfish-actions.pod:2607
12622 "List the files in C<directory> (relative to the root directory, there is no "
12623 "cwd). The '.' and '..' entries are not returned, but hidden files are shown."
12627 #: ../src/guestfs-actions.pod:3806
12629 "This command is mostly useful for interactive sessions. Programs should "
12630 "probably use C<guestfs_readdir> instead."
12634 #: ../src/guestfs-actions.pod:3815
12635 msgid "guestfs_lsetxattr"
12639 #: ../src/guestfs-actions.pod:3817
12643 " guestfs_lsetxattr (guestfs_h *g,\n"
12644 " const char *xattr,\n"
12645 " const char *val,\n"
12647 " const char *path);\n"
12652 #: ../src/guestfs-actions.pod:3824
12654 "This is the same as C<guestfs_setxattr>, but if C<path> is a symbolic link, "
12655 "then it sets an extended attribute of the link itself."
12659 #: ../src/guestfs-actions.pod:3832
12660 msgid "guestfs_lstat"
12664 #: ../src/guestfs-actions.pod:3834
12667 " struct guestfs_stat *\n"
12668 " guestfs_lstat (guestfs_h *g,\n"
12669 " const char *path);\n"
12674 #: ../src/guestfs-actions.pod:3838 ../src/guestfs-actions.pod:6479
12675 #: ../fish/guestfish-actions.pod:2626 ../fish/guestfish-actions.pod:4343
12676 msgid "Returns file information for the given C<path>."
12680 #: ../src/guestfs-actions.pod:3840
12682 "This is the same as C<guestfs_stat> except that if C<path> is a symbolic "
12683 "link, then the link is stat-ed, not the file it refers to."
12687 #: ../src/guestfs-actions.pod:3844 ../fish/guestfish-actions.pod:2632
12688 msgid "This is the same as the C<lstat(2)> system call."
12692 #: ../src/guestfs-actions.pod:3846 ../src/guestfs-actions.pod:6483
12694 "This function returns a C<struct guestfs_stat *>, or NULL if there was an "
12695 "error. I<The caller must call C<guestfs_free_stat> after use>."
12699 #: ../src/guestfs-actions.pod:3850 ../src/guestfs-actions.pod:6487
12700 #: ../src/guestfs-actions.pod:6505 ../src/guestfs-actions.pod:6886
12701 msgid "(Added in 0.9.2)"
12705 #: ../src/guestfs-actions.pod:3852
12706 msgid "guestfs_lstatlist"
12710 #: ../src/guestfs-actions.pod:3854
12713 " struct guestfs_stat_list *\n"
12714 " guestfs_lstatlist (guestfs_h *g,\n"
12715 " const char *path,\n"
12716 " char *const *names);\n"
12721 #: ../src/guestfs-actions.pod:3859
12723 "This call allows you to perform the C<guestfs_lstat> operation on multiple "
12724 "files, where all files are in the directory C<path>. C<names> is the list "
12725 "of files from this directory."
12729 #: ../src/guestfs-actions.pod:3863 ../fish/guestfish-actions.pod:2642
12731 "On return you get a list of stat structs, with a one-to-one correspondence "
12732 "to the C<names> list. If any name did not exist or could not be lstat'd, "
12733 "then the C<ino> field of that structure is set to C<-1>."
12737 #: ../src/guestfs-actions.pod:3868
12739 "This call is intended for programs that want to efficiently list a directory "
12740 "contents without making many round-trips. See also C<guestfs_lxattrlist> "
12741 "for a similarly efficient call for getting extended attributes. Very long "
12742 "directory listings might cause the protocol message size to be exceeded, "
12743 "causing this call to fail. The caller must split up such requests into "
12744 "smaller groups of names."
12748 #: ../src/guestfs-actions.pod:3876
12750 "This function returns a C<struct guestfs_stat_list *>, or NULL if there was "
12751 "an error. I<The caller must call C<guestfs_free_stat_list> after use>."
12755 #: ../src/guestfs-actions.pod:3882
12756 msgid "guestfs_luks_add_key"
12760 #: ../src/guestfs-actions.pod:3884
12764 " guestfs_luks_add_key (guestfs_h *g,\n"
12765 " const char *device,\n"
12766 " const char *key,\n"
12767 " const char *newkey,\n"
12773 #: ../src/guestfs-actions.pod:3891 ../fish/guestfish-actions.pod:2659
12775 "This command adds a new key on LUKS device C<device>. C<key> is any "
12776 "existing key, and is used to access the device. C<newkey> is the new key to "
12777 "add. C<keyslot> is the key slot that will be replaced."
12781 #: ../src/guestfs-actions.pod:3896
12783 "Note that if C<keyslot> already contains a key, then this command will "
12784 "fail. You have to use C<guestfs_luks_kill_slot> first to remove that key."
12788 #: ../src/guestfs-actions.pod:3902 ../src/guestfs-actions.pod:3942
12789 #: ../src/guestfs-actions.pod:3965 ../src/guestfs-actions.pod:3985
12790 #: ../src/guestfs-actions.pod:4017 ../src/guestfs-actions.pod:4036
12792 "This function takes a key or passphrase parameter which could contain "
12793 "sensitive material. Read the section L</KEYS AND PASSPHRASES> for more "
12798 #: ../src/guestfs-actions.pod:3906 ../src/guestfs-actions.pod:3946
12799 #: ../src/guestfs-actions.pod:3969 ../src/guestfs-actions.pod:3989
12800 msgid "(Added in 1.5.2)"
12804 #: ../src/guestfs-actions.pod:3908
12805 msgid "guestfs_luks_close"
12809 #: ../src/guestfs-actions.pod:3910
12813 " guestfs_luks_close (guestfs_h *g,\n"
12814 " const char *device);\n"
12819 #: ../src/guestfs-actions.pod:3914
12821 "This closes a LUKS device that was created earlier by C<guestfs_luks_open> "
12822 "or C<guestfs_luks_open_ro>. The C<device> parameter must be the name of the "
12823 "LUKS mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
12824 "underlying block device."
12828 #: ../src/guestfs-actions.pod:3922 ../src/guestfs-actions.pod:4021
12829 #: ../src/guestfs-actions.pod:4040 ../src/guestfs-actions.pod:4090
12830 #: ../src/guestfs-actions.pod:4138
12831 msgid "(Added in 1.5.1)"
12835 #: ../src/guestfs-actions.pod:3924
12836 msgid "guestfs_luks_format"
12840 #: ../src/guestfs-actions.pod:3926
12844 " guestfs_luks_format (guestfs_h *g,\n"
12845 " const char *device,\n"
12846 " const char *key,\n"
12852 #: ../src/guestfs-actions.pod:3932 ../fish/guestfish-actions.pod:2685
12854 "This command erases existing data on C<device> and formats the device as a "
12855 "LUKS encrypted device. C<key> is the initial key, which is added to key "
12856 "slot C<slot>. (LUKS supports 8 key slots, numbered 0-7)."
12860 #: ../src/guestfs-actions.pod:3939 ../src/guestfs-actions.pod:3962
12861 #: ../src/guestfs-actions.pod:4102 ../src/guestfs-actions.pod:5099
12862 #: ../src/guestfs-actions.pod:5879 ../src/guestfs-actions.pod:6286
12863 #: ../src/guestfs-actions.pod:6316 ../src/guestfs-actions.pod:6349
12864 #: ../src/guestfs-actions.pod:7531 ../fish/guestfish-actions.pod:2693
12865 #: ../fish/guestfish-actions.pod:2706 ../fish/guestfish-actions.pod:2790
12866 #: ../fish/guestfish-actions.pod:3384 ../fish/guestfish-actions.pod:3904
12867 #: ../fish/guestfish-actions.pod:4214 ../fish/guestfish-actions.pod:4237
12868 #: ../fish/guestfish-actions.pod:4259 ../fish/guestfish-actions.pod:4989
12870 "B<This command is dangerous. Without careful use you can easily destroy all "
12875 #: ../src/guestfs-actions.pod:3948
12876 msgid "guestfs_luks_format_cipher"
12880 #: ../src/guestfs-actions.pod:3950
12884 " guestfs_luks_format_cipher (guestfs_h *g,\n"
12885 " const char *device,\n"
12886 " const char *key,\n"
12888 " const char *cipher);\n"
12893 #: ../src/guestfs-actions.pod:3957
12895 "This command is the same as C<guestfs_luks_format> but it also allows you to "
12896 "set the C<cipher> used."
12900 #: ../src/guestfs-actions.pod:3971
12901 msgid "guestfs_luks_kill_slot"
12905 #: ../src/guestfs-actions.pod:3973
12909 " guestfs_luks_kill_slot (guestfs_h *g,\n"
12910 " const char *device,\n"
12911 " const char *key,\n"
12917 #: ../src/guestfs-actions.pod:3979 ../fish/guestfish-actions.pod:2713
12919 "This command deletes the key in key slot C<keyslot> from the encrypted LUKS "
12920 "device C<device>. C<key> must be one of the I<other> keys."
12924 #: ../src/guestfs-actions.pod:3991
12925 msgid "guestfs_luks_open"
12929 #: ../src/guestfs-actions.pod:3993
12933 " guestfs_luks_open (guestfs_h *g,\n"
12934 " const char *device,\n"
12935 " const char *key,\n"
12936 " const char *mapname);\n"
12941 #: ../src/guestfs-actions.pod:3999 ../fish/guestfish-actions.pod:2724
12943 "This command opens a block device which has been encrypted according to the "
12944 "Linux Unified Key Setup (LUKS) standard."
12948 #: ../src/guestfs-actions.pod:4002 ../fish/guestfish-actions.pod:2727
12949 msgid "C<device> is the encrypted block device or partition."
12953 #: ../src/guestfs-actions.pod:4004 ../fish/guestfish-actions.pod:2729
12955 "The caller must supply one of the keys associated with the LUKS block "
12956 "device, in the C<key> parameter."
12960 #: ../src/guestfs-actions.pod:4007 ../fish/guestfish-actions.pod:2732
12962 "This creates a new block device called C</dev/mapper/mapname>. Reads and "
12963 "writes to this block device are decrypted from and encrypted to the "
12964 "underlying C<device> respectively."
12968 #: ../src/guestfs-actions.pod:4011
12970 "If this block device contains LVM volume groups, then calling "
12971 "C<guestfs_vgscan> followed by C<guestfs_vg_activate_all> will make them "
12976 #: ../src/guestfs-actions.pod:4023
12977 msgid "guestfs_luks_open_ro"
12981 #: ../src/guestfs-actions.pod:4025
12985 " guestfs_luks_open_ro (guestfs_h *g,\n"
12986 " const char *device,\n"
12987 " const char *key,\n"
12988 " const char *mapname);\n"
12993 #: ../src/guestfs-actions.pod:4031
12995 "This is the same as C<guestfs_luks_open> except that a read-only mapping is "
13000 #: ../src/guestfs-actions.pod:4042
13001 msgid "guestfs_lvcreate"
13005 #: ../src/guestfs-actions.pod:4044
13009 " guestfs_lvcreate (guestfs_h *g,\n"
13010 " const char *logvol,\n"
13011 " const char *volgroup,\n"
13017 #: ../src/guestfs-actions.pod:4050 ../fish/guestfish-actions.pod:2757
13019 "This creates an LVM logical volume called C<logvol> on the volume group "
13020 "C<volgroup>, with C<size> megabytes."
13024 #: ../src/guestfs-actions.pod:4057
13025 msgid "guestfs_lvm_canonical_lv_name"
13029 #: ../src/guestfs-actions.pod:4059
13033 " guestfs_lvm_canonical_lv_name (guestfs_h *g,\n"
13034 " const char *lvname);\n"
13039 #: ../src/guestfs-actions.pod:4063 ../fish/guestfish-actions.pod:2764
13041 "This converts alternative naming schemes for LVs that you might find to the "
13042 "canonical name. For example, C</dev/mapper/VG-LV> is converted to C</dev/VG/"
13047 #: ../src/guestfs-actions.pod:4067 ../fish/guestfish-actions.pod:2768
13049 "This command returns an error if the C<lvname> parameter does not refer to a "
13054 #: ../src/guestfs-actions.pod:4070
13055 msgid "See also C<guestfs_is_lv>."
13059 #: ../src/guestfs-actions.pod:4075
13060 msgid "(Added in 1.5.24)"
13064 #: ../src/guestfs-actions.pod:4077
13065 msgid "guestfs_lvm_clear_filter"
13069 #: ../src/guestfs-actions.pod:4079
13073 " guestfs_lvm_clear_filter (guestfs_h *g);\n"
13078 #: ../src/guestfs-actions.pod:4082
13080 "This undoes the effect of C<guestfs_lvm_set_filter>. LVM will be able to "
13081 "see every block device."
13085 #: ../src/guestfs-actions.pod:4085 ../src/guestfs-actions.pod:4127
13086 #: ../fish/guestfish-actions.pod:2780 ../fish/guestfish-actions.pod:2811
13088 "This command also clears the LVM cache and performs a volume group scan."
13092 #: ../src/guestfs-actions.pod:4092
13093 msgid "guestfs_lvm_remove_all"
13097 #: ../src/guestfs-actions.pod:4094
13101 " guestfs_lvm_remove_all (guestfs_h *g);\n"
13106 #: ../src/guestfs-actions.pod:4097 ../fish/guestfish-actions.pod:2787
13108 "This command removes all LVM logical volumes, volume groups and physical "
13113 #: ../src/guestfs-actions.pod:4107
13114 msgid "guestfs_lvm_set_filter"
13118 #: ../src/guestfs-actions.pod:4109
13122 " guestfs_lvm_set_filter (guestfs_h *g,\n"
13123 " char *const *devices);\n"
13128 #: ../src/guestfs-actions.pod:4113 ../fish/guestfish-actions.pod:2797
13130 "This sets the LVM device filter so that LVM will only be able to \"see\" the "
13131 "block devices in the list C<devices>, and will ignore all other attached "
13136 #: ../src/guestfs-actions.pod:4117 ../fish/guestfish-actions.pod:2801
13138 "Where disk image(s) contain duplicate PVs or VGs, this command is useful to "
13139 "get LVM to ignore the duplicates, otherwise LVM can get confused. Note also "
13140 "there are two types of duplication possible: either cloned PVs/VGs which "
13141 "have identical UUIDs; or VGs that are not cloned but just happen to have the "
13142 "same name. In normal operation you cannot create this situation, but you "
13143 "can do it outside LVM, eg. by cloning disk images or by bit twiddling "
13144 "inside the LVM metadata."
13148 #: ../src/guestfs-actions.pod:4130 ../fish/guestfish-actions.pod:2814
13149 msgid "You can filter whole block devices or individual partitions."
13153 #: ../src/guestfs-actions.pod:4132 ../fish/guestfish-actions.pod:2816
13155 "You cannot use this if any VG is currently in use (eg. contains a mounted "
13156 "filesystem), even if you are not filtering out that VG."
13160 #: ../src/guestfs-actions.pod:4140
13161 msgid "guestfs_lvremove"
13165 #: ../src/guestfs-actions.pod:4142
13169 " guestfs_lvremove (guestfs_h *g,\n"
13170 " const char *device);\n"
13175 #: ../src/guestfs-actions.pod:4146 ../fish/guestfish-actions.pod:2824
13177 "Remove an LVM logical volume C<device>, where C<device> is the path to the "
13178 "LV, such as C</dev/VG/LV>."
13182 #: ../src/guestfs-actions.pod:4149 ../fish/guestfish-actions.pod:2827
13184 "You can also remove all LVs in a volume group by specifying the VG name, C</"
13189 #: ../src/guestfs-actions.pod:4154 ../src/guestfs-actions.pod:5445
13190 #: ../src/guestfs-actions.pod:7262
13191 msgid "(Added in 1.0.13)"
13195 #: ../src/guestfs-actions.pod:4156
13196 msgid "guestfs_lvrename"
13200 #: ../src/guestfs-actions.pod:4158
13204 " guestfs_lvrename (guestfs_h *g,\n"
13205 " const char *logvol,\n"
13206 " const char *newlogvol);\n"
13211 #: ../src/guestfs-actions.pod:4163 ../fish/guestfish-actions.pod:2834
13212 msgid "Rename a logical volume C<logvol> with the new name C<newlogvol>."
13216 #: ../src/guestfs-actions.pod:4167 ../src/guestfs-actions.pod:7275
13217 msgid "(Added in 1.0.83)"
13221 #: ../src/guestfs-actions.pod:4169
13222 msgid "guestfs_lvresize"
13226 #: ../src/guestfs-actions.pod:4171
13230 " guestfs_lvresize (guestfs_h *g,\n"
13231 " const char *device,\n"
13237 #: ../src/guestfs-actions.pod:4176 ../fish/guestfish-actions.pod:2840
13239 "This resizes (expands or shrinks) an existing LVM logical volume to "
13240 "C<mbytes>. When reducing, data in the reduced part is lost."
13244 #: ../src/guestfs-actions.pod:4184
13245 msgid "guestfs_lvresize_free"
13249 #: ../src/guestfs-actions.pod:4186
13253 " guestfs_lvresize_free (guestfs_h *g,\n"
13254 " const char *lv,\n"
13260 #: ../src/guestfs-actions.pod:4191 ../fish/guestfish-actions.pod:2848
13262 "This expands an existing logical volume C<lv> so that it fills C<pc>% of the "
13263 "remaining free space in the volume group. Commonly you would call this with "
13264 "pc = 100 which expands the logical volume as much as possible, using all "
13265 "remaining free space in the volume group."
13269 #: ../src/guestfs-actions.pod:4199
13270 msgid "(Added in 1.3.3)"
13274 #: ../src/guestfs-actions.pod:4201
13275 msgid "guestfs_lvs"
13279 #: ../src/guestfs-actions.pod:4203
13283 " guestfs_lvs (guestfs_h *g);\n"
13288 #: ../src/guestfs-actions.pod:4206 ../fish/guestfish-actions.pod:2858
13290 "List all the logical volumes detected. This is the equivalent of the L<lvs"
13295 #: ../src/guestfs-actions.pod:4209 ../fish/guestfish-actions.pod:2861
13297 "This returns a list of the logical volume device names (eg. C</dev/"
13298 "VolGroup00/LogVol00>)."
13302 #: ../src/guestfs-actions.pod:4212
13303 msgid "See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>."
13307 #: ../src/guestfs-actions.pod:4220
13308 msgid "guestfs_lvs_full"
13312 #: ../src/guestfs-actions.pod:4222
13315 " struct guestfs_lvm_lv_list *\n"
13316 " guestfs_lvs_full (guestfs_h *g);\n"
13321 #: ../src/guestfs-actions.pod:4225 ../fish/guestfish-actions.pod:2870
13323 "List all the logical volumes detected. This is the equivalent of the L<lvs"
13324 "(8)> command. The \"full\" version includes all fields."
13328 #: ../src/guestfs-actions.pod:4228
13330 "This function returns a C<struct guestfs_lvm_lv_list *>, or NULL if there "
13331 "was an error. I<The caller must call C<guestfs_free_lvm_lv_list> after use>."
13335 #: ../src/guestfs-actions.pod:4234
13336 msgid "guestfs_lvuuid"
13340 #: ../src/guestfs-actions.pod:4236
13344 " guestfs_lvuuid (guestfs_h *g,\n"
13345 " const char *device);\n"
13350 #: ../src/guestfs-actions.pod:4240 ../fish/guestfish-actions.pod:2877
13351 msgid "This command returns the UUID of the LVM LV C<device>."
13355 #: ../src/guestfs-actions.pod:4247
13356 msgid "guestfs_lxattrlist"
13360 #: ../src/guestfs-actions.pod:4249
13363 " struct guestfs_xattr_list *\n"
13364 " guestfs_lxattrlist (guestfs_h *g,\n"
13365 " const char *path,\n"
13366 " char *const *names);\n"
13371 #: ../src/guestfs-actions.pod:4254 ../fish/guestfish-actions.pod:2883
13373 "This call allows you to get the extended attributes of multiple files, where "
13374 "all files are in the directory C<path>. C<names> is the list of files from "
13379 #: ../src/guestfs-actions.pod:4258 ../fish/guestfish-actions.pod:2887
13381 "On return you get a flat list of xattr structs which must be interpreted "
13382 "sequentially. The first xattr struct always has a zero-length C<attrname>. "
13383 "C<attrval> in this struct is zero-length to indicate there was an error "
13384 "doing C<lgetxattr> for this file, I<or> is a C string which is a decimal "
13385 "number (the number of following attributes for this file, which could be C<"
13386 "\"0\">). Then after the first xattr struct are the zero or more attributes "
13387 "for the first named file. This repeats for the second and subsequent files."
13391 #: ../src/guestfs-actions.pod:4268
13393 "This call is intended for programs that want to efficiently list a directory "
13394 "contents without making many round-trips. See also C<guestfs_lstatlist> for "
13395 "a similarly efficient call for getting standard stats. Very long directory "
13396 "listings might cause the protocol message size to be exceeded, causing this "
13397 "call to fail. The caller must split up such requests into smaller groups of "
13402 #: ../src/guestfs-actions.pod:4282
13403 msgid "guestfs_mkdir"
13407 #: ../src/guestfs-actions.pod:4284
13411 " guestfs_mkdir (guestfs_h *g,\n"
13412 " const char *path);\n"
13417 #: ../src/guestfs-actions.pod:4288 ../fish/guestfish-actions.pod:2909
13418 msgid "Create a directory named C<path>."
13422 #: ../src/guestfs-actions.pod:4294
13423 msgid "guestfs_mkdir_mode"
13427 #: ../src/guestfs-actions.pod:4296
13431 " guestfs_mkdir_mode (guestfs_h *g,\n"
13432 " const char *path,\n"
13438 #: ../src/guestfs-actions.pod:4301 ../fish/guestfish-actions.pod:2915
13440 "This command creates a directory, setting the initial permissions of the "
13441 "directory to C<mode>."
13445 #: ../src/guestfs-actions.pod:4304 ../fish/guestfish-actions.pod:2918
13447 "For common Linux filesystems, the actual mode which is set will be C<mode & "
13448 "~umask & 01777>. Non-native-Linux filesystems may interpret the mode in "
13453 #: ../src/guestfs-actions.pod:4308
13454 msgid "See also C<guestfs_mkdir>, C<guestfs_umask>"
13458 #: ../src/guestfs-actions.pod:4314
13459 msgid "guestfs_mkdir_p"
13463 #: ../src/guestfs-actions.pod:4316
13467 " guestfs_mkdir_p (guestfs_h *g,\n"
13468 " const char *path);\n"
13473 #: ../src/guestfs-actions.pod:4320 ../fish/guestfish-actions.pod:2928
13475 "Create a directory named C<path>, creating any parent directories as "
13476 "necessary. This is like the C<mkdir -p> shell command."
13480 #: ../src/guestfs-actions.pod:4327
13481 msgid "guestfs_mkdtemp"
13485 #: ../src/guestfs-actions.pod:4329
13489 " guestfs_mkdtemp (guestfs_h *g,\n"
13490 " const char *template);\n"
13495 #: ../src/guestfs-actions.pod:4333 ../fish/guestfish-actions.pod:2935
13497 "This command creates a temporary directory. The C<template> parameter "
13498 "should be a full pathname for the temporary directory name with the final "
13499 "six characters being \"XXXXXX\"."
13503 #: ../src/guestfs-actions.pod:4338 ../fish/guestfish-actions.pod:2940
13505 "For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\", the second one "
13506 "being suitable for Windows filesystems."
13510 #: ../src/guestfs-actions.pod:4341 ../fish/guestfish-actions.pod:2943
13511 msgid "The name of the temporary directory that was created is returned."
13515 #: ../src/guestfs-actions.pod:4344 ../fish/guestfish-actions.pod:2946
13516 msgid "The temporary directory is created with mode 0700 and is owned by root."
13520 #: ../src/guestfs-actions.pod:4347 ../fish/guestfish-actions.pod:2949
13522 "The caller is responsible for deleting the temporary directory and its "
13523 "contents after use."
13527 #: ../src/guestfs-actions.pod:4350 ../fish/guestfish-actions.pod:2952
13528 msgid "See also: L<mkdtemp(3)>"
13532 #: ../src/guestfs-actions.pod:4357
13533 msgid "guestfs_mke2fs_J"
13537 #: ../src/guestfs-actions.pod:4359
13541 " guestfs_mke2fs_J (guestfs_h *g,\n"
13542 " const char *fstype,\n"
13543 " int blocksize,\n"
13544 " const char *device,\n"
13545 " const char *journal);\n"
13550 #: ../src/guestfs-actions.pod:4366 ../fish/guestfish-actions.pod:2958
13552 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
13553 "C<journal>. It is equivalent to the command:"
13557 #: ../src/guestfs-actions.pod:4370 ../fish/guestfish-actions.pod:2962
13560 " mke2fs -t fstype -b blocksize -J device=<journal> <device>\n"
13565 #: ../src/guestfs-actions.pod:4372
13566 msgid "See also C<guestfs_mke2journal>."
13570 #: ../src/guestfs-actions.pod:4376 ../src/guestfs-actions.pod:4394
13571 #: ../src/guestfs-actions.pod:4412 ../src/guestfs-actions.pod:4428
13572 #: ../src/guestfs-actions.pod:4442 ../src/guestfs-actions.pod:4456
13573 #: ../src/guestfs-actions.pod:4515 ../src/guestfs-actions.pod:4780
13574 msgid "(Added in 1.0.68)"
13578 #: ../src/guestfs-actions.pod:4378
13579 msgid "guestfs_mke2fs_JL"
13583 #: ../src/guestfs-actions.pod:4380
13587 " guestfs_mke2fs_JL (guestfs_h *g,\n"
13588 " const char *fstype,\n"
13589 " int blocksize,\n"
13590 " const char *device,\n"
13591 " const char *label);\n"
13596 #: ../src/guestfs-actions.pod:4387 ../fish/guestfish-actions.pod:2970
13598 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
13599 "the journal labeled C<label>."
13603 #: ../src/guestfs-actions.pod:4390
13604 msgid "See also C<guestfs_mke2journal_L>."
13608 #: ../src/guestfs-actions.pod:4396
13609 msgid "guestfs_mke2fs_JU"
13613 #: ../src/guestfs-actions.pod:4398
13617 " guestfs_mke2fs_JU (guestfs_h *g,\n"
13618 " const char *fstype,\n"
13619 " int blocksize,\n"
13620 " const char *device,\n"
13621 " const char *uuid);\n"
13626 #: ../src/guestfs-actions.pod:4405 ../fish/guestfish-actions.pod:2979
13628 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
13629 "the journal with UUID C<uuid>."
13633 #: ../src/guestfs-actions.pod:4408
13634 msgid "See also C<guestfs_mke2journal_U>."
13638 #: ../src/guestfs-actions.pod:4414
13639 msgid "guestfs_mke2journal"
13643 #: ../src/guestfs-actions.pod:4416
13647 " guestfs_mke2journal (guestfs_h *g,\n"
13648 " int blocksize,\n"
13649 " const char *device);\n"
13654 #: ../src/guestfs-actions.pod:4421 ../fish/guestfish-actions.pod:2988
13656 "This creates an ext2 external journal on C<device>. It is equivalent to the "
13661 #: ../src/guestfs-actions.pod:4424 ../fish/guestfish-actions.pod:2991
13664 " mke2fs -O journal_dev -b blocksize device\n"
13669 #: ../src/guestfs-actions.pod:4430
13670 msgid "guestfs_mke2journal_L"
13674 #: ../src/guestfs-actions.pod:4432
13678 " guestfs_mke2journal_L (guestfs_h *g,\n"
13679 " int blocksize,\n"
13680 " const char *label,\n"
13681 " const char *device);\n"
13686 #: ../src/guestfs-actions.pod:4438 ../fish/guestfish-actions.pod:2997
13687 msgid "This creates an ext2 external journal on C<device> with label C<label>."
13691 #: ../src/guestfs-actions.pod:4444
13692 msgid "guestfs_mke2journal_U"
13696 #: ../src/guestfs-actions.pod:4446
13700 " guestfs_mke2journal_U (guestfs_h *g,\n"
13701 " int blocksize,\n"
13702 " const char *uuid,\n"
13703 " const char *device);\n"
13708 #: ../src/guestfs-actions.pod:4452 ../fish/guestfish-actions.pod:3003
13709 msgid "This creates an ext2 external journal on C<device> with UUID C<uuid>."
13713 #: ../src/guestfs-actions.pod:4458
13714 msgid "guestfs_mkfifo"
13718 #: ../src/guestfs-actions.pod:4460
13722 " guestfs_mkfifo (guestfs_h *g,\n"
13724 " const char *path);\n"
13729 #: ../src/guestfs-actions.pod:4465
13731 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
13732 "is just a convenient wrapper around C<guestfs_mknod>."
13736 #: ../src/guestfs-actions.pod:4475
13737 msgid "guestfs_mkfs"
13741 #: ../src/guestfs-actions.pod:4477
13745 " guestfs_mkfs (guestfs_h *g,\n"
13746 " const char *fstype,\n"
13747 " const char *device);\n"
13752 #: ../src/guestfs-actions.pod:4482 ../fish/guestfish-actions.pod:3019
13754 "This creates a filesystem on C<device> (usually a partition or LVM logical "
13755 "volume). The filesystem type is C<fstype>, for example C<ext3>."
13759 #: ../src/guestfs-actions.pod:4490
13760 msgid "guestfs_mkfs_b"
13764 #: ../src/guestfs-actions.pod:4492
13768 " guestfs_mkfs_b (guestfs_h *g,\n"
13769 " const char *fstype,\n"
13770 " int blocksize,\n"
13771 " const char *device);\n"
13776 #: ../src/guestfs-actions.pod:4498
13778 "This call is similar to C<guestfs_mkfs>, but it allows you to control the "
13779 "block size of the resulting filesystem. Supported block sizes depend on the "
13780 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
13784 #: ../src/guestfs-actions.pod:4503 ../src/guestfs-actions.pod:4546
13785 #: ../fish/guestfish-actions.pod:3032 ../fish/guestfish-actions.pod:3059
13787 "For VFAT and NTFS the C<blocksize> parameter is treated as the requested "
13792 #: ../src/guestfs-actions.pod:4508 ../fish/guestfish-actions.pod:3035
13794 "This function is deprecated. In new code, use the C<mkfs_opts> call instead."
13798 #: ../src/guestfs-actions.pod:4517
13799 msgid "guestfs_mkfs_opts"
13803 #: ../src/guestfs-actions.pod:4519
13807 " guestfs_mkfs_opts (guestfs_h *g,\n"
13808 " const char *fstype,\n"
13809 " const char *device,\n"
13815 #: ../src/guestfs-actions.pod:4530
13818 " GUESTFS_MKFS_OPTS_BLOCKSIZE, int blocksize,\n"
13819 " GUESTFS_MKFS_OPTS_FEATURES, const char *features,\n"
13824 #: ../src/guestfs-actions.pod:4533 ../fish/guestfish-actions.pod:3046
13826 "This function creates a filesystem on C<device>. The filesystem type is "
13827 "C<fstype>, for example C<ext3>."
13831 #: ../src/guestfs-actions.pod:4540 ../fish/guestfish-actions.pod:3053
13832 msgid "C<blocksize>"
13836 #: ../src/guestfs-actions.pod:4542 ../fish/guestfish-actions.pod:3055
13838 "The filesystem block size. Supported block sizes depend on the filesystem "
13839 "type, but typically they are C<1024>, C<2048> or C<4096> for Linux ext2/3 "
13844 #: ../src/guestfs-actions.pod:4549 ../fish/guestfish-actions.pod:3062
13845 msgid "For UFS block sizes, please see L<mkfs.ufs(8)>."
13849 #: ../src/guestfs-actions.pod:4551 ../fish/guestfish-actions.pod:3064
13850 msgid "C<features>"
13854 #: ../src/guestfs-actions.pod:4553 ../fish/guestfish-actions.pod:3066
13855 msgid "This passes the I<-O> parameter to the external mkfs program."
13859 #: ../src/guestfs-actions.pod:4555 ../fish/guestfish-actions.pod:3068
13861 "For certain filesystem types, this allows extra filesystem features to be "
13862 "selected. See L<mke2fs(8)> and L<mkfs.ufs(8)> for more details."
13866 #: ../src/guestfs-actions.pod:4559 ../fish/guestfish-actions.pod:3072
13868 "You cannot use this optional parameter with the C<gfs> or C<gfs2> filesystem "
13873 #: ../src/guestfs-actions.pod:4566
13874 msgid "(Added in 1.7.19)"
13878 #: ../src/guestfs-actions.pod:4568
13879 msgid "guestfs_mkfs_opts_va"
13883 #: ../src/guestfs-actions.pod:4570
13887 " guestfs_mkfs_opts_va (guestfs_h *g,\n"
13888 " const char *fstype,\n"
13889 " const char *device,\n"
13890 " va_list args);\n"
13895 #: ../src/guestfs-actions.pod:4576
13896 msgid "This is the \"va_list variant\" of L</guestfs_mkfs_opts>."
13900 #: ../src/guestfs-actions.pod:4580
13901 msgid "guestfs_mkfs_opts_argv"
13905 #: ../src/guestfs-actions.pod:4582
13909 " guestfs_mkfs_opts_argv (guestfs_h *g,\n"
13910 " const char *fstype,\n"
13911 " const char *device,\n"
13912 " const struct guestfs_mkfs_opts_argv *optargs);\n"
13917 #: ../src/guestfs-actions.pod:4588
13918 msgid "This is the \"argv variant\" of L</guestfs_mkfs_opts>."
13922 #: ../src/guestfs-actions.pod:4592
13923 msgid "guestfs_mkmountpoint"
13927 #: ../src/guestfs-actions.pod:4594
13931 " guestfs_mkmountpoint (guestfs_h *g,\n"
13932 " const char *exemptpath);\n"
13937 #: ../src/guestfs-actions.pod:4598
13939 "C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are specialized calls "
13940 "that can be used to create extra mountpoints before mounting the first "
13945 #: ../src/guestfs-actions.pod:4602 ../fish/guestfish-actions.pod:3087
13947 "These calls are I<only> necessary in some very limited circumstances, mainly "
13948 "the case where you want to mount a mix of unrelated and/or read-only "
13949 "filesystems together."
13953 #: ../src/guestfs-actions.pod:4606 ../fish/guestfish-actions.pod:3091
13955 "For example, live CDs often contain a \"Russian doll\" nest of filesystems, "
13956 "an ISO outer layer, with a squashfs image inside, with an ext2/3 image "
13957 "inside that. You can unpack this as follows in guestfish:"
13961 #: ../src/guestfs-actions.pod:4611 ../fish/guestfish-actions.pod:3096
13964 " add-ro Fedora-11-i686-Live.iso\n"
13966 " mkmountpoint /cd\n"
13967 " mkmountpoint /sqsh\n"
13968 " mkmountpoint /ext3fs\n"
13969 " mount /dev/sda /cd\n"
13970 " mount-loop /cd/LiveOS/squashfs.img /sqsh\n"
13971 " mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs\n"
13976 #: ../src/guestfs-actions.pod:4620 ../fish/guestfish-actions.pod:3105
13977 msgid "The inner filesystem is now unpacked under the /ext3fs mountpoint."
13981 #: ../src/guestfs-actions.pod:4622
13983 "C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>. You "
13984 "may get unexpected errors if you try to mix these calls. It is safest to "
13985 "manually unmount filesystems and remove mountpoints after use."
13989 #: ../src/guestfs-actions.pod:4626
13991 "C<guestfs_umount_all> unmounts filesystems by sorting the paths longest "
13992 "first, so for this to work for manual mountpoints, you must ensure that the "
13993 "innermost mountpoints have the longest pathnames, as in the example code "
13998 #: ../src/guestfs-actions.pod:4631 ../fish/guestfish-actions.pod:3116
14000 "For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>"
14004 #: ../src/guestfs-actions.pod:4633
14006 "Autosync [see C<guestfs_set_autosync>, this is set by default on handles] "
14007 "can cause C<guestfs_umount_all> to be called when the handle is closed which "
14008 "can also trigger these issues."
14012 #: ../src/guestfs-actions.pod:4639 ../src/guestfs-actions.pod:4953
14013 #: ../src/guestfs-actions.pod:5863
14014 msgid "(Added in 1.0.62)"
14018 #: ../src/guestfs-actions.pod:4641
14019 msgid "guestfs_mknod"
14023 #: ../src/guestfs-actions.pod:4643
14027 " guestfs_mknod (guestfs_h *g,\n"
14031 " const char *path);\n"
14036 #: ../src/guestfs-actions.pod:4650 ../fish/guestfish-actions.pod:3126
14038 "This call creates block or character special devices, or named pipes (FIFOs)."
14042 #: ../src/guestfs-actions.pod:4653 ../fish/guestfish-actions.pod:3129
14044 "The C<mode> parameter should be the mode, using the standard constants. "
14045 "C<devmajor> and C<devminor> are the device major and minor numbers, only "
14046 "used when creating block and character special devices."
14050 #: ../src/guestfs-actions.pod:4658
14052 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
14053 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
14054 "regular file). These constants are available in the standard Linux header "
14055 "files, or you can use C<guestfs_mknod_b>, C<guestfs_mknod_c> or "
14056 "C<guestfs_mkfifo> which are wrappers around this command which bitwise OR in "
14057 "the appropriate constant for you."
14061 #: ../src/guestfs-actions.pod:4672
14062 msgid "guestfs_mknod_b"
14066 #: ../src/guestfs-actions.pod:4674
14070 " guestfs_mknod_b (guestfs_h *g,\n"
14074 " const char *path);\n"
14079 #: ../src/guestfs-actions.pod:4681
14081 "This call creates a block device node called C<path> with mode C<mode> and "
14082 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
14083 "wrapper around C<guestfs_mknod>."
14087 #: ../src/guestfs-actions.pod:4691
14088 msgid "guestfs_mknod_c"
14092 #: ../src/guestfs-actions.pod:4693
14096 " guestfs_mknod_c (guestfs_h *g,\n"
14100 " const char *path);\n"
14105 #: ../src/guestfs-actions.pod:4700
14107 "This call creates a char device node called C<path> with mode C<mode> and "
14108 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
14109 "wrapper around C<guestfs_mknod>."
14113 #: ../src/guestfs-actions.pod:4710
14114 msgid "guestfs_mkswap"
14118 #: ../src/guestfs-actions.pod:4712
14122 " guestfs_mkswap (guestfs_h *g,\n"
14123 " const char *device);\n"
14128 #: ../src/guestfs-actions.pod:4716 ../fish/guestfish-actions.pod:3168
14129 msgid "Create a swap partition on C<device>."
14133 #: ../src/guestfs-actions.pod:4722
14134 msgid "guestfs_mkswap_L"
14138 #: ../src/guestfs-actions.pod:4724
14142 " guestfs_mkswap_L (guestfs_h *g,\n"
14143 " const char *label,\n"
14144 " const char *device);\n"
14149 #: ../src/guestfs-actions.pod:4729 ../fish/guestfish-actions.pod:3174
14150 msgid "Create a swap partition on C<device> with label C<label>."
14154 #: ../src/guestfs-actions.pod:4731 ../fish/guestfish-actions.pod:3176
14156 "Note that you cannot attach a swap label to a block device (eg. C</dev/"
14157 "sda>), just to a partition. This appears to be a limitation of the kernel "
14162 #: ../src/guestfs-actions.pod:4739
14163 msgid "guestfs_mkswap_U"
14167 #: ../src/guestfs-actions.pod:4741
14171 " guestfs_mkswap_U (guestfs_h *g,\n"
14172 " const char *uuid,\n"
14173 " const char *device);\n"
14178 #: ../src/guestfs-actions.pod:4746 ../fish/guestfish-actions.pod:3184
14179 msgid "Create a swap partition on C<device> with UUID C<uuid>."
14183 #: ../src/guestfs-actions.pod:4752
14184 msgid "guestfs_mkswap_file"
14188 #: ../src/guestfs-actions.pod:4754
14192 " guestfs_mkswap_file (guestfs_h *g,\n"
14193 " const char *path);\n"
14198 #: ../src/guestfs-actions.pod:4758 ../fish/guestfish-actions.pod:3190
14199 msgid "Create a swap file."
14203 #: ../src/guestfs-actions.pod:4760
14205 "This command just writes a swap file signature to an existing file. To "
14206 "create the file itself, use something like C<guestfs_fallocate>."
14210 #: ../src/guestfs-actions.pod:4767
14211 msgid "guestfs_modprobe"
14215 #: ../src/guestfs-actions.pod:4769
14219 " guestfs_modprobe (guestfs_h *g,\n"
14220 " const char *modulename);\n"
14225 #: ../src/guestfs-actions.pod:4773 ../fish/guestfish-actions.pod:3199
14226 msgid "This loads a kernel module in the appliance."
14230 #: ../src/guestfs-actions.pod:4775 ../fish/guestfish-actions.pod:3201
14232 "The kernel module must have been whitelisted when libguestfs was built (see "
14233 "C<appliance/kmod.whitelist.in> in the source)."
14237 #: ../src/guestfs-actions.pod:4782
14238 msgid "guestfs_mount"
14242 #: ../src/guestfs-actions.pod:4784
14246 " guestfs_mount (guestfs_h *g,\n"
14247 " const char *device,\n"
14248 " const char *mountpoint);\n"
14253 #: ../src/guestfs-actions.pod:4789 ../fish/guestfish-actions.pod:3208
14255 "Mount a guest disk at a position in the filesystem. Block devices are named "
14256 "C</dev/sda>, C</dev/sdb> and so on, as they were added to the guest. If "
14257 "those block devices contain partitions, they will have the usual names (eg. "
14258 "C</dev/sda1>). Also LVM C</dev/VG/LV>-style names can be used."
14262 #: ../src/guestfs-actions.pod:4795 ../fish/guestfish-actions.pod:3214
14264 "The rules are the same as for L<mount(2)>: A filesystem must first be "
14265 "mounted on C</> before others can be mounted. Other filesystems can only be "
14266 "mounted on directories which already exist."
14270 #: ../src/guestfs-actions.pod:4800 ../fish/guestfish-actions.pod:3219
14272 "The mounted filesystem is writable, if we have sufficient permissions on the "
14273 "underlying device."
14277 #: ../src/guestfs-actions.pod:4803
14279 "B<Important note:> When you use this call, the filesystem options C<sync> "
14280 "and C<noatime> are set implicitly. This was originally done because we "
14281 "thought it would improve reliability, but it turns out that I<-o sync> has a "
14282 "very large negative performance impact and negligible effect on "
14283 "reliability. Therefore we recommend that you avoid using C<guestfs_mount> "
14284 "in any code that needs performance, and instead use C<guestfs_mount_options> "
14285 "(use an empty string for the first parameter if you don't want any options)."
14289 #: ../src/guestfs-actions.pod:4815 ../fish/guestfish-actions.pod:3232
14291 "This function is deprecated. In new code, use the C<mount_options> call "
14296 #: ../src/guestfs-actions.pod:4824
14297 msgid "guestfs_mount_9p"
14301 #: ../src/guestfs-actions.pod:4826
14305 " guestfs_mount_9p (guestfs_h *g,\n"
14306 " const char *mounttag,\n"
14307 " const char *mountpoint,\n"
14313 #: ../src/guestfs-actions.pod:4837
14316 " GUESTFS_MOUNT_9P_OPTIONS, const char *options,\n"
14321 #: ../src/guestfs-actions.pod:4839 ../fish/guestfish-actions.pod:3243
14323 "Mount the virtio-9p filesystem with the tag C<mounttag> on the directory "
14328 #: ../src/guestfs-actions.pod:4842 ../fish/guestfish-actions.pod:3246
14330 "If required, C<trans=virtio> will be automatically added to the options. "
14331 "Any other options required can be passed in the optional C<options> "
14336 #: ../src/guestfs-actions.pod:4848
14337 msgid "guestfs_mount_9p_va"
14341 #: ../src/guestfs-actions.pod:4850
14345 " guestfs_mount_9p_va (guestfs_h *g,\n"
14346 " const char *mounttag,\n"
14347 " const char *mountpoint,\n"
14348 " va_list args);\n"
14353 #: ../src/guestfs-actions.pod:4856
14354 msgid "This is the \"va_list variant\" of L</guestfs_mount_9p>."
14358 #: ../src/guestfs-actions.pod:4860
14359 msgid "guestfs_mount_9p_argv"
14363 #: ../src/guestfs-actions.pod:4862
14367 " guestfs_mount_9p_argv (guestfs_h *g,\n"
14368 " const char *mounttag,\n"
14369 " const char *mountpoint,\n"
14370 " const struct guestfs_mount_9p_argv *optargs);\n"
14375 #: ../src/guestfs-actions.pod:4868
14376 msgid "This is the \"argv variant\" of L</guestfs_mount_9p>."
14380 #: ../src/guestfs-actions.pod:4872
14381 msgid "guestfs_mount_loop"
14385 #: ../src/guestfs-actions.pod:4874
14389 " guestfs_mount_loop (guestfs_h *g,\n"
14390 " const char *file,\n"
14391 " const char *mountpoint);\n"
14396 #: ../src/guestfs-actions.pod:4879 ../fish/guestfish-actions.pod:3256
14398 "This command lets you mount C<file> (a filesystem image in a file) on a "
14399 "mount point. It is entirely equivalent to the command C<mount -o loop file "
14404 #: ../src/guestfs-actions.pod:4887
14405 msgid "guestfs_mount_options"
14409 #: ../src/guestfs-actions.pod:4889
14413 " guestfs_mount_options (guestfs_h *g,\n"
14414 " const char *options,\n"
14415 " const char *device,\n"
14416 " const char *mountpoint);\n"
14421 #: ../src/guestfs-actions.pod:4895
14423 "This is the same as the C<guestfs_mount> command, but it allows you to set "
14424 "the mount options as for the L<mount(8)> I<-o> flag."
14428 #: ../src/guestfs-actions.pod:4899 ../fish/guestfish-actions.pod:3268
14430 "If the C<options> parameter is an empty string, then no options are passed "
14431 "(all options default to whatever the filesystem uses)."
14435 #: ../src/guestfs-actions.pod:4905 ../src/guestfs-actions.pod:4919
14436 #: ../src/guestfs-actions.pod:4936
14437 msgid "(Added in 1.0.10)"
14441 #: ../src/guestfs-actions.pod:4907
14442 msgid "guestfs_mount_ro"
14446 #: ../src/guestfs-actions.pod:4909
14450 " guestfs_mount_ro (guestfs_h *g,\n"
14451 " const char *device,\n"
14452 " const char *mountpoint);\n"
14457 #: ../src/guestfs-actions.pod:4914
14459 "This is the same as the C<guestfs_mount> command, but it mounts the "
14460 "filesystem with the read-only (I<-o ro>) flag."
14464 #: ../src/guestfs-actions.pod:4921
14465 msgid "guestfs_mount_vfs"
14469 #: ../src/guestfs-actions.pod:4923
14473 " guestfs_mount_vfs (guestfs_h *g,\n"
14474 " const char *options,\n"
14475 " const char *vfstype,\n"
14476 " const char *device,\n"
14477 " const char *mountpoint);\n"
14482 #: ../src/guestfs-actions.pod:4930
14484 "This is the same as the C<guestfs_mount> command, but it allows you to set "
14485 "both the mount options and the vfstype as for the L<mount(8)> I<-o> and I<-"
14490 #: ../src/guestfs-actions.pod:4938
14491 msgid "guestfs_mountpoints"
14495 #: ../src/guestfs-actions.pod:4940
14499 " guestfs_mountpoints (guestfs_h *g);\n"
14504 #: ../src/guestfs-actions.pod:4943
14506 "This call is similar to C<guestfs_mounts>. That call returns a list of "
14507 "devices. This one returns a hash table (map) of device name to directory "
14508 "where the device is mounted."
14512 #: ../src/guestfs-actions.pod:4955
14513 msgid "guestfs_mounts"
14517 #: ../src/guestfs-actions.pod:4957
14521 " guestfs_mounts (guestfs_h *g);\n"
14526 #: ../src/guestfs-actions.pod:4960 ../fish/guestfish-actions.pod:3299
14528 "This returns the list of currently mounted filesystems. It returns the list "
14529 "of devices (eg. C</dev/sda1>, C</dev/VG/LV>)."
14533 #: ../src/guestfs-actions.pod:4963 ../fish/guestfish-actions.pod:3302
14534 msgid "Some internal mounts are not shown."
14538 #: ../src/guestfs-actions.pod:4965
14539 msgid "See also: C<guestfs_mountpoints>"
14543 #: ../src/guestfs-actions.pod:4973
14548 #: ../src/guestfs-actions.pod:4975
14552 " guestfs_mv (guestfs_h *g,\n"
14553 " const char *src,\n"
14554 " const char *dest);\n"
14559 #: ../src/guestfs-actions.pod:4980 ../fish/guestfish-actions.pod:3310
14561 "This moves a file from C<src> to C<dest> where C<dest> is either a "
14562 "destination filename or destination directory."
14566 #: ../src/guestfs-actions.pod:4987
14567 msgid "guestfs_ntfs_3g_probe"
14571 #: ../src/guestfs-actions.pod:4989
14575 " guestfs_ntfs_3g_probe (guestfs_h *g,\n"
14577 " const char *device);\n"
14582 #: ../src/guestfs-actions.pod:4994 ../fish/guestfish-actions.pod:3317
14584 "This command runs the L<ntfs-3g.probe(8)> command which probes an NTFS "
14585 "C<device> for mountability. (Not all NTFS volumes can be mounted read-"
14586 "write, and some cannot be mounted at all)."
14590 #: ../src/guestfs-actions.pod:4998 ../fish/guestfish-actions.pod:3321
14592 "C<rw> is a boolean flag. Set it to true if you want to test if the volume "
14593 "can be mounted read-write. Set it to false if you want to test if the "
14594 "volume can be mounted read-only."
14598 #: ../src/guestfs-actions.pod:5002 ../fish/guestfish-actions.pod:3325
14600 "The return value is an integer which C<0> if the operation would succeed, or "
14601 "some non-zero value documented in the L<ntfs-3g.probe(8)> manual page."
14605 #: ../src/guestfs-actions.pod:5008
14606 msgid "(Added in 1.0.43)"
14610 #: ../src/guestfs-actions.pod:5010
14611 msgid "guestfs_ntfsresize"
14615 #: ../src/guestfs-actions.pod:5012
14619 " guestfs_ntfsresize (guestfs_h *g,\n"
14620 " const char *device);\n"
14625 #: ../src/guestfs-actions.pod:5016 ../fish/guestfish-actions.pod:3333
14627 "This command resizes an NTFS filesystem, expanding or shrinking it to the "
14628 "size of the underlying device. See also L<ntfsresize(8)>."
14632 #: ../src/guestfs-actions.pod:5024
14633 msgid "guestfs_ntfsresize_size"
14637 #: ../src/guestfs-actions.pod:5026
14641 " guestfs_ntfsresize_size (guestfs_h *g,\n"
14642 " const char *device,\n"
14643 " int64_t size);\n"
14648 #: ../src/guestfs-actions.pod:5031
14650 "This command is the same as C<guestfs_ntfsresize> except that it allows you "
14651 "to specify the new size (in bytes) explicitly."
14655 #: ../src/guestfs-actions.pod:5036 ../src/guestfs-actions.pod:5472
14656 #: ../src/guestfs-actions.pod:5545 ../src/guestfs-actions.pod:5811
14657 #: ../src/guestfs-actions.pod:7417
14658 msgid "(Added in 1.3.14)"
14662 #: ../src/guestfs-actions.pod:5038
14663 msgid "guestfs_part_add"
14667 #: ../src/guestfs-actions.pod:5040
14671 " guestfs_part_add (guestfs_h *g,\n"
14672 " const char *device,\n"
14673 " const char *prlogex,\n"
14674 " int64_t startsect,\n"
14675 " int64_t endsect);\n"
14680 #: ../src/guestfs-actions.pod:5047
14682 "This command adds a partition to C<device>. If there is no partition table "
14683 "on the device, call C<guestfs_part_init> first."
14687 #: ../src/guestfs-actions.pod:5050 ../fish/guestfish-actions.pod:3351
14689 "The C<prlogex> parameter is the type of partition. Normally you should pass "
14690 "C<p> or C<primary> here, but MBR partition tables also support C<l> (or "
14691 "C<logical>) and C<e> (or C<extended>) partition types."
14695 #: ../src/guestfs-actions.pod:5055 ../fish/guestfish-actions.pod:3356
14697 "C<startsect> and C<endsect> are the start and end of the partition in "
14698 "I<sectors>. C<endsect> may be negative, which means it counts backwards "
14699 "from the end of the disk (C<-1> is the last sector)."
14703 #: ../src/guestfs-actions.pod:5059
14705 "Creating a partition which covers the whole disk is not so easy. Use "
14706 "C<guestfs_part_disk> to do that."
14710 #: ../src/guestfs-actions.pod:5064 ../src/guestfs-actions.pod:5102
14711 #: ../src/guestfs-actions.pod:5155 ../src/guestfs-actions.pod:5233
14712 #: ../src/guestfs-actions.pod:5271 ../src/guestfs-actions.pod:5290
14713 #: ../src/guestfs-actions.pod:5330
14714 msgid "(Added in 1.0.78)"
14718 #: ../src/guestfs-actions.pod:5066
14719 msgid "guestfs_part_del"
14723 #: ../src/guestfs-actions.pod:5068
14727 " guestfs_part_del (guestfs_h *g,\n"
14728 " const char *device,\n"
14734 #: ../src/guestfs-actions.pod:5073 ../fish/guestfish-actions.pod:3367
14735 msgid "This command deletes the partition numbered C<partnum> on C<device>."
14739 #: ../src/guestfs-actions.pod:5075 ../fish/guestfish-actions.pod:3369
14741 "Note that in the case of MBR partitioning, deleting an extended partition "
14742 "also deletes any logical partitions it contains."
14746 #: ../src/guestfs-actions.pod:5083
14747 msgid "guestfs_part_disk"
14751 #: ../src/guestfs-actions.pod:5085
14755 " guestfs_part_disk (guestfs_h *g,\n"
14756 " const char *device,\n"
14757 " const char *parttype);\n"
14762 #: ../src/guestfs-actions.pod:5090
14764 "This command is simply a combination of C<guestfs_part_init> followed by "
14765 "C<guestfs_part_add> to create a single primary partition covering the whole "
14770 #: ../src/guestfs-actions.pod:5094
14772 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
14773 "possible values are described in C<guestfs_part_init>."
14777 #: ../src/guestfs-actions.pod:5104
14778 msgid "guestfs_part_get_bootable"
14782 #: ../src/guestfs-actions.pod:5106
14786 " guestfs_part_get_bootable (guestfs_h *g,\n"
14787 " const char *device,\n"
14793 #: ../src/guestfs-actions.pod:5111 ../fish/guestfish-actions.pod:3391
14795 "This command returns true if the partition C<partnum> on C<device> has the "
14796 "bootable flag set."
14800 #: ../src/guestfs-actions.pod:5114
14801 msgid "See also C<guestfs_part_set_bootable>."
14805 #: ../src/guestfs-actions.pod:5120
14806 msgid "guestfs_part_get_mbr_id"
14810 #: ../src/guestfs-actions.pod:5122
14814 " guestfs_part_get_mbr_id (guestfs_h *g,\n"
14815 " const char *device,\n"
14821 #: ../src/guestfs-actions.pod:5127 ../fish/guestfish-actions.pod:3400
14823 "Returns the MBR type byte (also known as the ID byte) from the numbered "
14824 "partition C<partnum>."
14828 #: ../src/guestfs-actions.pod:5130 ../src/guestfs-actions.pod:5306
14830 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
14831 "undefined results for other partition table types (see "
14832 "C<guestfs_part_get_parttype>)."
14836 #: ../src/guestfs-actions.pod:5138
14837 msgid "guestfs_part_get_parttype"
14841 #: ../src/guestfs-actions.pod:5140
14845 " guestfs_part_get_parttype (guestfs_h *g,\n"
14846 " const char *device);\n"
14851 #: ../src/guestfs-actions.pod:5144 ../fish/guestfish-actions.pod:3411
14853 "This command examines the partition table on C<device> and returns the "
14854 "partition table type (format) being used."
14858 #: ../src/guestfs-actions.pod:5147
14860 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
14861 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
14862 "possible, although unusual. See C<guestfs_part_init> for a full list."
14866 #: ../src/guestfs-actions.pod:5157
14867 msgid "guestfs_part_init"
14871 #: ../src/guestfs-actions.pod:5159
14875 " guestfs_part_init (guestfs_h *g,\n"
14876 " const char *device,\n"
14877 " const char *parttype);\n"
14882 #: ../src/guestfs-actions.pod:5164 ../fish/guestfish-actions.pod:3423
14884 "This creates an empty partition table on C<device> of one of the partition "
14885 "types listed below. Usually C<parttype> should be either C<msdos> or C<gpt> "
14886 "(for large disks)."
14890 #: ../src/guestfs-actions.pod:5168
14892 "Initially there are no partitions. Following this, you should call "
14893 "C<guestfs_part_add> for each partition required."
14897 #: ../src/guestfs-actions.pod:5171 ../fish/guestfish-actions.pod:3430
14898 msgid "Possible values for C<parttype> are:"
14902 #: ../src/guestfs-actions.pod:5175 ../fish/guestfish-actions.pod:3434
14903 msgid "B<efi> | B<gpt>"
14907 #: ../src/guestfs-actions.pod:5177 ../fish/guestfish-actions.pod:3436
14908 msgid "Intel EFI / GPT partition table."
14912 #: ../src/guestfs-actions.pod:5179 ../fish/guestfish-actions.pod:3438
14914 "This is recommended for >= 2 TB partitions that will be accessed from Linux "
14915 "and Intel-based Mac OS X. It also has limited backwards compatibility with "
14916 "the C<mbr> format."
14920 #: ../src/guestfs-actions.pod:5183 ../fish/guestfish-actions.pod:3442
14921 msgid "B<mbr> | B<msdos>"
14925 #: ../src/guestfs-actions.pod:5185 ../fish/guestfish-actions.pod:3444
14927 "The standard PC \"Master Boot Record\" (MBR) format used by MS-DOS and "
14928 "Windows. This partition type will B<only> work for device sizes up to 2 "
14929 "TB. For large disks we recommend using C<gpt>."
14933 #: ../src/guestfs-actions.pod:5192 ../fish/guestfish-actions.pod:3451
14935 "Other partition table types that may work but are not supported include:"
14939 #: ../src/guestfs-actions.pod:5197 ../fish/guestfish-actions.pod:3456
14944 #: ../src/guestfs-actions.pod:5199 ../fish/guestfish-actions.pod:3458
14945 msgid "AIX disk labels."
14949 #: ../src/guestfs-actions.pod:5201 ../fish/guestfish-actions.pod:3460
14950 msgid "B<amiga> | B<rdb>"
14954 #: ../src/guestfs-actions.pod:5203 ../fish/guestfish-actions.pod:3462
14955 msgid "Amiga \"Rigid Disk Block\" format."
14959 #: ../src/guestfs-actions.pod:5205 ../fish/guestfish-actions.pod:3464
14964 #: ../src/guestfs-actions.pod:5207 ../fish/guestfish-actions.pod:3466
14965 msgid "BSD disk labels."
14969 #: ../src/guestfs-actions.pod:5209 ../fish/guestfish-actions.pod:3468
14974 #: ../src/guestfs-actions.pod:5211 ../fish/guestfish-actions.pod:3470
14975 msgid "DASD, used on IBM mainframes."
14979 #: ../src/guestfs-actions.pod:5213 ../fish/guestfish-actions.pod:3472
14984 #: ../src/guestfs-actions.pod:5215 ../fish/guestfish-actions.pod:3474
14985 msgid "MIPS/SGI volumes."
14989 #: ../src/guestfs-actions.pod:5217 ../fish/guestfish-actions.pod:3476
14994 #: ../src/guestfs-actions.pod:5219 ../fish/guestfish-actions.pod:3478
14995 msgid "Old Mac partition format. Modern Macs use C<gpt>."
14999 #: ../src/guestfs-actions.pod:5221 ../fish/guestfish-actions.pod:3480
15004 #: ../src/guestfs-actions.pod:5223 ../fish/guestfish-actions.pod:3482
15005 msgid "NEC PC-98 format, common in Japan apparently."
15009 #: ../src/guestfs-actions.pod:5225 ../fish/guestfish-actions.pod:3484
15014 #: ../src/guestfs-actions.pod:5227 ../fish/guestfish-actions.pod:3486
15015 msgid "Sun disk labels."
15019 #: ../src/guestfs-actions.pod:5235
15020 msgid "guestfs_part_list"
15024 #: ../src/guestfs-actions.pod:5237
15027 " struct guestfs_partition_list *\n"
15028 " guestfs_part_list (guestfs_h *g,\n"
15029 " const char *device);\n"
15034 #: ../src/guestfs-actions.pod:5241 ../fish/guestfish-actions.pod:3494
15036 "This command parses the partition table on C<device> and returns the list of "
15037 "partitions found."
15041 #: ../src/guestfs-actions.pod:5244 ../fish/guestfish-actions.pod:3497
15042 msgid "The fields in the returned structure are:"
15046 #: ../src/guestfs-actions.pod:5248 ../fish/guestfish-actions.pod:3501
15047 msgid "B<part_num>"
15051 #: ../src/guestfs-actions.pod:5250 ../fish/guestfish-actions.pod:3503
15052 msgid "Partition number, counting from 1."
15056 #: ../src/guestfs-actions.pod:5252 ../fish/guestfish-actions.pod:3505
15057 msgid "B<part_start>"
15061 #: ../src/guestfs-actions.pod:5254
15063 "Start of the partition I<in bytes>. To get sectors you have to divide by "
15064 "the device's sector size, see C<guestfs_blockdev_getss>."
15068 #: ../src/guestfs-actions.pod:5257 ../fish/guestfish-actions.pod:3510
15069 msgid "B<part_end>"
15073 #: ../src/guestfs-actions.pod:5259 ../fish/guestfish-actions.pod:3512
15074 msgid "End of the partition in bytes."
15078 #: ../src/guestfs-actions.pod:5261 ../fish/guestfish-actions.pod:3514
15079 msgid "B<part_size>"
15083 #: ../src/guestfs-actions.pod:5263 ../fish/guestfish-actions.pod:3516
15084 msgid "Size of the partition in bytes."
15088 #: ../src/guestfs-actions.pod:5267
15090 "This function returns a C<struct guestfs_partition_list *>, or NULL if there "
15091 "was an error. I<The caller must call C<guestfs_free_partition_list> after "
15096 #: ../src/guestfs-actions.pod:5273
15097 msgid "guestfs_part_set_bootable"
15101 #: ../src/guestfs-actions.pod:5275
15105 " guestfs_part_set_bootable (guestfs_h *g,\n"
15106 " const char *device,\n"
15108 " int bootable);\n"
15113 #: ../src/guestfs-actions.pod:5281 ../fish/guestfish-actions.pod:3524
15115 "This sets the bootable flag on partition numbered C<partnum> on device "
15116 "C<device>. Note that partitions are numbered from 1."
15120 #: ../src/guestfs-actions.pod:5284 ../fish/guestfish-actions.pod:3527
15122 "The bootable flag is used by some operating systems (notably Windows) to "
15123 "determine which partition to boot from. It is by no means universally "
15128 #: ../src/guestfs-actions.pod:5292
15129 msgid "guestfs_part_set_mbr_id"
15133 #: ../src/guestfs-actions.pod:5294
15137 " guestfs_part_set_mbr_id (guestfs_h *g,\n"
15138 " const char *device,\n"
15145 #: ../src/guestfs-actions.pod:5300 ../fish/guestfish-actions.pod:3535
15147 "Sets the MBR type byte (also known as the ID byte) of the numbered partition "
15148 "C<partnum> to C<idbyte>. Note that the type bytes quoted in most "
15149 "documentation are in fact hexadecimal numbers, but usually documented "
15150 "without any leading \"0x\" which might be confusing."
15154 #: ../src/guestfs-actions.pod:5314
15155 msgid "guestfs_part_set_name"
15159 #: ../src/guestfs-actions.pod:5316
15163 " guestfs_part_set_name (guestfs_h *g,\n"
15164 " const char *device,\n"
15166 " const char *name);\n"
15171 #: ../src/guestfs-actions.pod:5322 ../fish/guestfish-actions.pod:3549
15173 "This sets the partition name on partition numbered C<partnum> on device "
15174 "C<device>. Note that partitions are numbered from 1."
15178 #: ../src/guestfs-actions.pod:5325 ../fish/guestfish-actions.pod:3552
15180 "The partition name can only be set on certain types of partition table. "
15181 "This works on C<gpt> but not on C<mbr> partitions."
15185 #: ../src/guestfs-actions.pod:5332
15186 msgid "guestfs_part_to_dev"
15190 #: ../src/guestfs-actions.pod:5334
15194 " guestfs_part_to_dev (guestfs_h *g,\n"
15195 " const char *partition);\n"
15200 #: ../src/guestfs-actions.pod:5338 ../fish/guestfish-actions.pod:3559
15202 "This function takes a partition name (eg. \"/dev/sdb1\") and removes the "
15203 "partition number, returning the device name (eg. \"/dev/sdb\")."
15207 #: ../src/guestfs-actions.pod:5342
15209 "The named partition must exist, for example as a string returned from "
15210 "C<guestfs_list_partitions>."
15214 #: ../src/guestfs-actions.pod:5350
15215 msgid "guestfs_ping_daemon"
15219 #: ../src/guestfs-actions.pod:5352
15223 " guestfs_ping_daemon (guestfs_h *g);\n"
15228 #: ../src/guestfs-actions.pod:5355 ../fish/guestfish-actions.pod:3570
15230 "This is a test probe into the guestfs daemon running inside the qemu "
15231 "subprocess. Calling this function checks that the daemon responds to the "
15232 "ping message, without affecting the daemon or attached block device(s) in "
15237 #: ../src/guestfs-actions.pod:5364
15238 msgid "guestfs_pread"
15242 #: ../src/guestfs-actions.pod:5366
15246 " guestfs_pread (guestfs_h *g,\n"
15247 " const char *path,\n"
15249 " int64_t offset,\n"
15250 " size_t *size_r);\n"
15255 #: ../src/guestfs-actions.pod:5373 ../fish/guestfish-actions.pod:3579
15257 "This command lets you read part of a file. It reads C<count> bytes of the "
15258 "file, starting at C<offset>, from file C<path>."
15262 #: ../src/guestfs-actions.pod:5376 ../src/guestfs-actions.pod:5402
15263 #: ../fish/guestfish-actions.pod:3582 ../fish/guestfish-actions.pod:3597
15265 "This may read fewer bytes than requested. For further details see the "
15266 "L<pread(2)> system call."
15270 #: ../src/guestfs-actions.pod:5379
15271 msgid "See also C<guestfs_pwrite>, C<guestfs_pread_device>."
15275 #: ../src/guestfs-actions.pod:5390
15276 msgid "guestfs_pread_device"
15280 #: ../src/guestfs-actions.pod:5392
15284 " guestfs_pread_device (guestfs_h *g,\n"
15285 " const char *device,\n"
15287 " int64_t offset,\n"
15288 " size_t *size_r);\n"
15293 #: ../src/guestfs-actions.pod:5399 ../fish/guestfish-actions.pod:3594
15295 "This command lets you read part of a file. It reads C<count> bytes of "
15296 "C<device>, starting at C<offset>."
15300 #: ../src/guestfs-actions.pod:5405
15301 msgid "See also C<guestfs_pread>."
15305 #: ../src/guestfs-actions.pod:5414
15306 msgid "(Added in 1.5.21)"
15310 #: ../src/guestfs-actions.pod:5416
15311 msgid "guestfs_pvcreate"
15315 #: ../src/guestfs-actions.pod:5418
15319 " guestfs_pvcreate (guestfs_h *g,\n"
15320 " const char *device);\n"
15325 #: ../src/guestfs-actions.pod:5422 ../fish/guestfish-actions.pod:3609
15327 "This creates an LVM physical volume on the named C<device>, where C<device> "
15328 "should usually be a partition name such as C</dev/sda1>."
15332 #: ../src/guestfs-actions.pod:5430
15333 msgid "guestfs_pvremove"
15337 #: ../src/guestfs-actions.pod:5432
15341 " guestfs_pvremove (guestfs_h *g,\n"
15342 " const char *device);\n"
15347 #: ../src/guestfs-actions.pod:5436 ../fish/guestfish-actions.pod:3617
15349 "This wipes a physical volume C<device> so that LVM will no longer recognise "
15354 #: ../src/guestfs-actions.pod:5439 ../fish/guestfish-actions.pod:3620
15356 "The implementation uses the C<pvremove> command which refuses to wipe "
15357 "physical volumes that contain any volume groups, so you have to remove those "
15362 #: ../src/guestfs-actions.pod:5447
15363 msgid "guestfs_pvresize"
15367 #: ../src/guestfs-actions.pod:5449
15371 " guestfs_pvresize (guestfs_h *g,\n"
15372 " const char *device);\n"
15377 #: ../src/guestfs-actions.pod:5453 ../fish/guestfish-actions.pod:3628
15379 "This resizes (expands or shrinks) an existing LVM physical volume to match "
15380 "the new size of the underlying device."
15384 #: ../src/guestfs-actions.pod:5460
15385 msgid "guestfs_pvresize_size"
15389 #: ../src/guestfs-actions.pod:5462
15393 " guestfs_pvresize_size (guestfs_h *g,\n"
15394 " const char *device,\n"
15395 " int64_t size);\n"
15400 #: ../src/guestfs-actions.pod:5467
15402 "This command is the same as C<guestfs_pvresize> except that it allows you to "
15403 "specify the new size (in bytes) explicitly."
15407 #: ../src/guestfs-actions.pod:5474
15408 msgid "guestfs_pvs"
15412 #: ../src/guestfs-actions.pod:5476
15416 " guestfs_pvs (guestfs_h *g);\n"
15421 #: ../src/guestfs-actions.pod:5479 ../fish/guestfish-actions.pod:3642
15423 "List all the physical volumes detected. This is the equivalent of the L<pvs"
15428 #: ../src/guestfs-actions.pod:5482 ../fish/guestfish-actions.pod:3645
15430 "This returns a list of just the device names that contain PVs (eg. C</dev/"
15435 #: ../src/guestfs-actions.pod:5485
15436 msgid "See also C<guestfs_pvs_full>."
15440 #: ../src/guestfs-actions.pod:5493
15441 msgid "guestfs_pvs_full"
15445 #: ../src/guestfs-actions.pod:5495
15448 " struct guestfs_lvm_pv_list *\n"
15449 " guestfs_pvs_full (guestfs_h *g);\n"
15454 #: ../src/guestfs-actions.pod:5498 ../fish/guestfish-actions.pod:3654
15456 "List all the physical volumes detected. This is the equivalent of the L<pvs"
15457 "(8)> command. The \"full\" version includes all fields."
15461 #: ../src/guestfs-actions.pod:5501
15463 "This function returns a C<struct guestfs_lvm_pv_list *>, or NULL if there "
15464 "was an error. I<The caller must call C<guestfs_free_lvm_pv_list> after use>."
15468 #: ../src/guestfs-actions.pod:5507
15469 msgid "guestfs_pvuuid"
15473 #: ../src/guestfs-actions.pod:5509
15477 " guestfs_pvuuid (guestfs_h *g,\n"
15478 " const char *device);\n"
15483 #: ../src/guestfs-actions.pod:5513 ../fish/guestfish-actions.pod:3661
15484 msgid "This command returns the UUID of the LVM PV C<device>."
15488 #: ../src/guestfs-actions.pod:5520
15489 msgid "guestfs_pwrite"
15493 #: ../src/guestfs-actions.pod:5522
15497 " guestfs_pwrite (guestfs_h *g,\n"
15498 " const char *path,\n"
15499 " const char *content,\n"
15500 " size_t content_size,\n"
15501 " int64_t offset);\n"
15506 #: ../src/guestfs-actions.pod:5529 ../fish/guestfish-actions.pod:3667
15508 "This command writes to part of a file. It writes the data buffer C<content> "
15509 "to the file C<path> starting at offset C<offset>."
15513 #: ../src/guestfs-actions.pod:5532 ../fish/guestfish-actions.pod:3670
15515 "This command implements the L<pwrite(2)> system call, and like that system "
15516 "call it may not write the full data requested. The return value is the "
15517 "number of bytes that were actually written to the file. This could even be "
15518 "0, although short writes are unlikely for regular files in ordinary "
15523 #: ../src/guestfs-actions.pod:5538
15524 msgid "See also C<guestfs_pread>, C<guestfs_pwrite_device>."
15528 #: ../src/guestfs-actions.pod:5547
15529 msgid "guestfs_pwrite_device"
15533 #: ../src/guestfs-actions.pod:5549
15537 " guestfs_pwrite_device (guestfs_h *g,\n"
15538 " const char *device,\n"
15539 " const char *content,\n"
15540 " size_t content_size,\n"
15541 " int64_t offset);\n"
15546 #: ../src/guestfs-actions.pod:5556 ../fish/guestfish-actions.pod:3685
15548 "This command writes to part of a device. It writes the data buffer "
15549 "C<content> to C<device> starting at offset C<offset>."
15553 #: ../src/guestfs-actions.pod:5559 ../fish/guestfish-actions.pod:3688
15555 "This command implements the L<pwrite(2)> system call, and like that system "
15556 "call it may not write the full data requested (although short writes to disk "
15557 "devices and partitions are probably impossible with standard Linux kernels)."
15561 #: ../src/guestfs-actions.pod:5564
15562 msgid "See also C<guestfs_pwrite>."
15566 #: ../src/guestfs-actions.pod:5571
15567 msgid "(Added in 1.5.20)"
15571 #: ../src/guestfs-actions.pod:5573
15572 msgid "guestfs_read_file"
15576 #: ../src/guestfs-actions.pod:5575
15580 " guestfs_read_file (guestfs_h *g,\n"
15581 " const char *path,\n"
15582 " size_t *size_r);\n"
15587 #: ../src/guestfs-actions.pod:5580 ../fish/guestfish-actions.pod:3702
15588 msgid "This calls returns the contents of the file C<path> as a buffer."
15592 #: ../src/guestfs-actions.pod:5583
15594 "Unlike C<guestfs_cat>, this function can correctly handle files that contain "
15595 "embedded ASCII NUL characters. However unlike C<guestfs_download>, this "
15596 "function is limited in the total size of file that can be handled."
15600 #: ../src/guestfs-actions.pod:5595
15601 msgid "(Added in 1.0.63)"
15605 #: ../src/guestfs-actions.pod:5597
15606 msgid "guestfs_read_lines"
15610 #: ../src/guestfs-actions.pod:5599
15614 " guestfs_read_lines (guestfs_h *g,\n"
15615 " const char *path);\n"
15620 #: ../src/guestfs-actions.pod:5605 ../fish/guestfish-actions.pod:3719
15622 "The file contents are returned as a list of lines. Trailing C<LF> and "
15623 "C<CRLF> character sequences are I<not> returned."
15627 #: ../src/guestfs-actions.pod:5608
15629 "Note that this function cannot correctly handle binary files (specifically, "
15630 "files containing C<\\0> character which is treated as end of line). For "
15631 "those you need to use the C<guestfs_read_file> function which has a more "
15632 "complex interface."
15636 #: ../src/guestfs-actions.pod:5619
15637 msgid "guestfs_readdir"
15641 #: ../src/guestfs-actions.pod:5621
15644 " struct guestfs_dirent_list *\n"
15645 " guestfs_readdir (guestfs_h *g,\n"
15646 " const char *dir);\n"
15651 #: ../src/guestfs-actions.pod:5625 ../fish/guestfish-actions.pod:3731
15652 msgid "This returns the list of directory entries in directory C<dir>."
15656 #: ../src/guestfs-actions.pod:5627 ../fish/guestfish-actions.pod:3733
15658 "All entries in the directory are returned, including C<.> and C<..>. The "
15659 "entries are I<not> sorted, but returned in the same order as the underlying "
15664 #: ../src/guestfs-actions.pod:5631 ../fish/guestfish-actions.pod:3737
15666 "Also this call returns basic file type information about each file. The "
15667 "C<ftyp> field will contain one of the following characters:"
15671 #: ../src/guestfs-actions.pod:5636 ../fish/guestfish-actions.pod:3742
15676 #: ../src/guestfs-actions.pod:5638 ../fish/guestfish-actions.pod:3744
15677 msgid "Block special"
15681 #: ../src/guestfs-actions.pod:5640 ../fish/guestfish-actions.pod:3746
15686 #: ../src/guestfs-actions.pod:5642 ../fish/guestfish-actions.pod:3748
15687 msgid "Char special"
15691 #: ../src/guestfs-actions.pod:5644 ../fish/guestfish-actions.pod:3750
15696 #: ../src/guestfs-actions.pod:5646 ../fish/guestfish-actions.pod:3752
15701 #: ../src/guestfs-actions.pod:5648 ../fish/guestfish-actions.pod:3754
15706 #: ../src/guestfs-actions.pod:5650 ../fish/guestfish-actions.pod:3756
15707 msgid "FIFO (named pipe)"
15711 #: ../src/guestfs-actions.pod:5652 ../fish/guestfish-actions.pod:3758
15716 #: ../src/guestfs-actions.pod:5654 ../fish/guestfish-actions.pod:3760
15717 msgid "Symbolic link"
15721 #: ../src/guestfs-actions.pod:5656 ../fish/guestfish-actions.pod:3762
15726 #: ../src/guestfs-actions.pod:5658 ../fish/guestfish-actions.pod:3764
15727 msgid "Regular file"
15731 #: ../src/guestfs-actions.pod:5660 ../fish/guestfish-actions.pod:3766
15736 #: ../src/guestfs-actions.pod:5662 ../fish/guestfish-actions.pod:3768
15741 #: ../src/guestfs-actions.pod:5664 ../fish/guestfish-actions.pod:3770
15746 #: ../src/guestfs-actions.pod:5666 ../fish/guestfish-actions.pod:3772
15747 msgid "Unknown file type"
15751 #: ../src/guestfs-actions.pod:5668 ../fish/guestfish-actions.pod:3774
15756 #: ../src/guestfs-actions.pod:5670 ../fish/guestfish-actions.pod:3776
15758 "The L<readdir(3)> call returned a C<d_type> field with an unexpected value"
15762 #: ../src/guestfs-actions.pod:5675
15764 "This function is primarily intended for use by programs. To get a simple "
15765 "list of names, use C<guestfs_ls>. To get a printable directory for human "
15766 "consumption, use C<guestfs_ll>."
15770 #: ../src/guestfs-actions.pod:5679
15772 "This function returns a C<struct guestfs_dirent_list *>, or NULL if there "
15773 "was an error. I<The caller must call C<guestfs_free_dirent_list> after use>."
15777 #: ../src/guestfs-actions.pod:5685
15778 msgid "guestfs_readlink"
15782 #: ../src/guestfs-actions.pod:5687
15786 " guestfs_readlink (guestfs_h *g,\n"
15787 " const char *path);\n"
15792 #: ../src/guestfs-actions.pod:5691 ../fish/guestfish-actions.pod:3789
15793 msgid "This command reads the target of a symbolic link."
15797 #: ../src/guestfs-actions.pod:5698
15798 msgid "guestfs_readlinklist"
15802 #: ../src/guestfs-actions.pod:5700
15806 " guestfs_readlinklist (guestfs_h *g,\n"
15807 " const char *path,\n"
15808 " char *const *names);\n"
15813 #: ../src/guestfs-actions.pod:5705 ../fish/guestfish-actions.pod:3795
15815 "This call allows you to do a C<readlink> operation on multiple files, where "
15816 "all files are in the directory C<path>. C<names> is the list of files from "
15821 #: ../src/guestfs-actions.pod:5709 ../fish/guestfish-actions.pod:3799
15823 "On return you get a list of strings, with a one-to-one correspondence to the "
15824 "C<names> list. Each string is the value of the symbolic link."
15828 #: ../src/guestfs-actions.pod:5713 ../fish/guestfish-actions.pod:3803
15830 "If the C<readlink(2)> operation fails on any name, then the corresponding "
15831 "result string is the empty string C<\"\">. However the whole operation is "
15832 "completed even if there were C<readlink(2)> errors, and so you can call this "
15833 "function with names where you don't know if they are symbolic links already "
15834 "(albeit slightly less efficient)."
15838 #: ../src/guestfs-actions.pod:5720 ../fish/guestfish-actions.pod:3810
15840 "This call is intended for programs that want to efficiently list a directory "
15841 "contents without making many round-trips. Very long directory listings "
15842 "might cause the protocol message size to be exceeded, causing this call to "
15843 "fail. The caller must split up such requests into smaller groups of names."
15847 #: ../src/guestfs-actions.pod:5733
15848 msgid "guestfs_realpath"
15852 #: ../src/guestfs-actions.pod:5735
15856 " guestfs_realpath (guestfs_h *g,\n"
15857 " const char *path);\n"
15862 #: ../src/guestfs-actions.pod:5739 ../fish/guestfish-actions.pod:3821
15864 "Return the canonicalized absolute pathname of C<path>. The returned path "
15865 "has no C<.>, C<..> or symbolic link path elements."
15869 #: ../src/guestfs-actions.pod:5747
15870 msgid "guestfs_removexattr"
15874 #: ../src/guestfs-actions.pod:5749
15878 " guestfs_removexattr (guestfs_h *g,\n"
15879 " const char *xattr,\n"
15880 " const char *path);\n"
15885 #: ../src/guestfs-actions.pod:5754 ../fish/guestfish-actions.pod:3828
15887 "This call removes the extended attribute named C<xattr> of the file C<path>."
15891 #: ../src/guestfs-actions.pod:5757
15892 msgid "See also: C<guestfs_lremovexattr>, L<attr(5)>."
15896 #: ../src/guestfs-actions.pod:5763
15897 msgid "guestfs_resize2fs"
15901 #: ../src/guestfs-actions.pod:5765
15905 " guestfs_resize2fs (guestfs_h *g,\n"
15906 " const char *device);\n"
15911 #: ../src/guestfs-actions.pod:5769 ../fish/guestfish-actions.pod:3837
15913 "This resizes an ext2, ext3 or ext4 filesystem to match the size of the "
15914 "underlying device."
15918 #: ../src/guestfs-actions.pod:5772
15920 "I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f> on the "
15921 "C<device> before calling this command. For unknown reasons C<resize2fs> "
15922 "sometimes gives an error about this and sometimes not. In any case, it is "
15923 "always safe to call C<guestfs_e2fsck_f> before calling this function."
15927 #: ../src/guestfs-actions.pod:5782
15928 msgid "guestfs_resize2fs_M"
15932 #: ../src/guestfs-actions.pod:5784
15936 " guestfs_resize2fs_M (guestfs_h *g,\n"
15937 " const char *device);\n"
15942 #: ../src/guestfs-actions.pod:5788
15944 "This command is the same as C<guestfs_resize2fs>, but the filesystem is "
15945 "resized to its minimum size. This works like the I<-M> option to the "
15946 "C<resize2fs> command."
15950 #: ../src/guestfs-actions.pod:5792
15952 "To get the resulting size of the filesystem you should call "
15953 "C<guestfs_tune2fs_l> and read the C<Block size> and C<Block count> values. "
15954 "These two numbers, multiplied together, give the resulting size of the "
15955 "minimal filesystem in bytes."
15959 #: ../src/guestfs-actions.pod:5799
15960 msgid "guestfs_resize2fs_size"
15964 #: ../src/guestfs-actions.pod:5801
15968 " guestfs_resize2fs_size (guestfs_h *g,\n"
15969 " const char *device,\n"
15970 " int64_t size);\n"
15975 #: ../src/guestfs-actions.pod:5806
15977 "This command is the same as C<guestfs_resize2fs> except that it allows you "
15978 "to specify the new size (in bytes) explicitly."
15982 #: ../src/guestfs-actions.pod:5813
15987 #: ../src/guestfs-actions.pod:5815
15991 " guestfs_rm (guestfs_h *g,\n"
15992 " const char *path);\n"
15997 #: ../src/guestfs-actions.pod:5819 ../fish/guestfish-actions.pod:3870
15998 msgid "Remove the single file C<path>."
16002 #: ../src/guestfs-actions.pod:5825
16003 msgid "guestfs_rm_rf"
16007 #: ../src/guestfs-actions.pod:5827
16011 " guestfs_rm_rf (guestfs_h *g,\n"
16012 " const char *path);\n"
16017 #: ../src/guestfs-actions.pod:5831 ../fish/guestfish-actions.pod:3876
16019 "Remove the file or directory C<path>, recursively removing the contents if "
16020 "its a directory. This is like the C<rm -rf> shell command."
16024 #: ../src/guestfs-actions.pod:5839
16025 msgid "guestfs_rmdir"
16029 #: ../src/guestfs-actions.pod:5841
16033 " guestfs_rmdir (guestfs_h *g,\n"
16034 " const char *path);\n"
16039 #: ../src/guestfs-actions.pod:5845 ../fish/guestfish-actions.pod:3884
16040 msgid "Remove the single directory C<path>."
16044 #: ../src/guestfs-actions.pod:5851
16045 msgid "guestfs_rmmountpoint"
16049 #: ../src/guestfs-actions.pod:5853
16053 " guestfs_rmmountpoint (guestfs_h *g,\n"
16054 " const char *exemptpath);\n"
16059 #: ../src/guestfs-actions.pod:5857
16061 "This calls removes a mountpoint that was previously created with "
16062 "C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint> for full details."
16066 #: ../src/guestfs-actions.pod:5865
16067 msgid "guestfs_scrub_device"
16071 #: ../src/guestfs-actions.pod:5867
16075 " guestfs_scrub_device (guestfs_h *g,\n"
16076 " const char *device);\n"
16081 #: ../src/guestfs-actions.pod:5871 ../fish/guestfish-actions.pod:3898
16083 "This command writes patterns over C<device> to make data retrieval more "
16088 #: ../src/guestfs-actions.pod:5874 ../src/guestfs-actions.pod:5895
16089 #: ../src/guestfs-actions.pod:5914 ../fish/guestfish-actions.pod:3901
16090 #: ../fish/guestfish-actions.pod:3916 ../fish/guestfish-actions.pod:3929
16092 "It is an interface to the L<scrub(1)> program. See that manual page for "
16097 #: ../src/guestfs-actions.pod:5882 ../src/guestfs-actions.pod:5900
16098 #: ../src/guestfs-actions.pod:5919
16099 msgid "(Added in 1.0.52)"
16103 #: ../src/guestfs-actions.pod:5884
16104 msgid "guestfs_scrub_file"
16108 #: ../src/guestfs-actions.pod:5886
16112 " guestfs_scrub_file (guestfs_h *g,\n"
16113 " const char *file);\n"
16118 #: ../src/guestfs-actions.pod:5890 ../fish/guestfish-actions.pod:3911
16120 "This command writes patterns over a file to make data retrieval more "
16125 #: ../src/guestfs-actions.pod:5893 ../fish/guestfish-actions.pod:3914
16126 msgid "The file is I<removed> after scrubbing."
16130 #: ../src/guestfs-actions.pod:5902
16131 msgid "guestfs_scrub_freespace"
16135 #: ../src/guestfs-actions.pod:5904
16139 " guestfs_scrub_freespace (guestfs_h *g,\n"
16140 " const char *dir);\n"
16145 #: ../src/guestfs-actions.pod:5908
16147 "This command creates the directory C<dir> and then fills it with files until "
16148 "the filesystem is full, and scrubs the files as for C<guestfs_scrub_file>, "
16149 "and deletes them. The intention is to scrub any free space on the partition "
16150 "containing C<dir>."
16154 #: ../src/guestfs-actions.pod:5921
16155 msgid "guestfs_set_append"
16159 #: ../src/guestfs-actions.pod:5923
16163 " guestfs_set_append (guestfs_h *g,\n"
16164 " const char *append);\n"
16169 #: ../src/guestfs-actions.pod:5927 ../fish/guestfish-actions.pod:3938
16171 "This function is used to add additional options to the guest kernel command "
16176 #: ../src/guestfs-actions.pod:5930 ../fish/guestfish-actions.pod:3941
16178 "The default is C<NULL> unless overridden by setting C<LIBGUESTFS_APPEND> "
16179 "environment variable."
16183 #: ../src/guestfs-actions.pod:5933 ../fish/guestfish-actions.pod:3944
16185 "Setting C<append> to C<NULL> means I<no> additional options are passed "
16186 "(libguestfs always adds a few of its own)."
16190 #: ../src/guestfs-actions.pod:5940
16191 msgid "guestfs_set_attach_method"
16195 #: ../src/guestfs-actions.pod:5942
16199 " guestfs_set_attach_method (guestfs_h *g,\n"
16200 " const char *attachmethod);\n"
16205 #: ../src/guestfs-actions.pod:5946 ../fish/guestfish-actions.pod:3953
16207 "Set the method that libguestfs uses to connect to the back end guestfsd "
16208 "daemon. Possible methods are:"
16212 #: ../src/guestfs-actions.pod:5953 ../fish/guestfish-actions.pod:3960
16214 "Launch an appliance and connect to it. This is the ordinary method and the "
16219 #: ../src/guestfs-actions.pod:5956 ../fish/guestfish-actions.pod:3963
16220 msgid "C<unix:I<path>>"
16224 #: ../src/guestfs-actions.pod:5958 ../fish/guestfish-actions.pod:3965
16225 msgid "Connect to the Unix domain socket I<path>."
16229 #: ../src/guestfs-actions.pod:5960 ../fish/guestfish-actions.pod:3967
16231 "This method lets you connect to an existing daemon or (using virtio-serial) "
16232 "to a live guest. For more information, see L<guestfs(3)/ATTACHING TO "
16233 "RUNNING DAEMONS>."
16237 #: ../src/guestfs-actions.pod:5968
16238 msgid "guestfs_set_autosync"
16242 #: ../src/guestfs-actions.pod:5970
16246 " guestfs_set_autosync (guestfs_h *g,\n"
16247 " int autosync);\n"
16252 #: ../src/guestfs-actions.pod:5974 ../fish/guestfish-actions.pod:3979
16254 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
16255 "effort attempt to make filesystems consistent and synchronized when the "
16256 "handle is closed (also if the program exits without closing handles)."
16260 #: ../src/guestfs-actions.pod:5979 ../fish/guestfish-actions.pod:3984
16262 "This is enabled by default (since libguestfs 1.5.24, previously it was "
16263 "disabled by default)."
16267 #: ../src/guestfs-actions.pod:5986
16268 msgid "guestfs_set_direct"
16272 #: ../src/guestfs-actions.pod:5988
16276 " guestfs_set_direct (guestfs_h *g,\n"
16282 #: ../src/guestfs-actions.pod:5992 ../fish/guestfish-actions.pod:3993
16284 "If the direct appliance mode flag is enabled, then stdin and stdout are "
16285 "passed directly through to the appliance once it is launched."
16289 #: ../src/guestfs-actions.pod:5996
16291 "One consequence of this is that log messages aren't caught by the library "
16292 "and handled by C<guestfs_set_log_message_callback>, but go straight to "
16297 #: ../src/guestfs-actions.pod:6000 ../fish/guestfish-actions.pod:4001
16298 msgid "You probably don't want to use this unless you know what you are doing."
16302 #: ../src/guestfs-actions.pod:6003 ../fish/guestfish-actions.pod:4004
16303 msgid "The default is disabled."
16307 #: ../src/guestfs-actions.pod:6009
16308 msgid "guestfs_set_e2label"
16312 #: ../src/guestfs-actions.pod:6011
16316 " guestfs_set_e2label (guestfs_h *g,\n"
16317 " const char *device,\n"
16318 " const char *label);\n"
16323 #: ../src/guestfs-actions.pod:6016 ../fish/guestfish-actions.pod:4010
16325 "This sets the ext2/3/4 filesystem label of the filesystem on C<device> to "
16326 "C<label>. Filesystem labels are limited to 16 characters."
16330 #: ../src/guestfs-actions.pod:6020
16332 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label> to return "
16333 "the existing label on a filesystem."
16337 #: ../src/guestfs-actions.pod:6027
16338 msgid "guestfs_set_e2uuid"
16342 #: ../src/guestfs-actions.pod:6029
16346 " guestfs_set_e2uuid (guestfs_h *g,\n"
16347 " const char *device,\n"
16348 " const char *uuid);\n"
16353 #: ../src/guestfs-actions.pod:6034 ../fish/guestfish-actions.pod:4021
16355 "This sets the ext2/3/4 filesystem UUID of the filesystem on C<device> to "
16356 "C<uuid>. The format of the UUID and alternatives such as C<clear>, "
16357 "C<random> and C<time> are described in the L<tune2fs(8)> manpage."
16361 #: ../src/guestfs-actions.pod:6039
16363 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid> to return "
16364 "the existing UUID of a filesystem."
16368 #: ../src/guestfs-actions.pod:6046
16369 msgid "guestfs_set_memsize"
16373 #: ../src/guestfs-actions.pod:6048
16377 " guestfs_set_memsize (guestfs_h *g,\n"
16383 #: ../src/guestfs-actions.pod:6052
16385 "This sets the memory size in megabytes allocated to the qemu subprocess. "
16386 "This only has any effect if called before C<guestfs_launch>."
16390 #: ../src/guestfs-actions.pod:6056 ../fish/guestfish-actions.pod:4039
16392 "You can also change this by setting the environment variable "
16393 "C<LIBGUESTFS_MEMSIZE> before the handle is created."
16397 #: ../src/guestfs-actions.pod:6067
16398 msgid "guestfs_set_network"
16402 #: ../src/guestfs-actions.pod:6069
16406 " guestfs_set_network (guestfs_h *g,\n"
16412 #: ../src/guestfs-actions.pod:6073 ../fish/guestfish-actions.pod:4052
16414 "If C<network> is true, then the network is enabled in the libguestfs "
16415 "appliance. The default is false."
16419 #: ../src/guestfs-actions.pod:6076 ../fish/guestfish-actions.pod:4055
16421 "This affects whether commands are able to access the network (see L<guestfs"
16422 "(3)/RUNNING COMMANDS>)."
16426 #: ../src/guestfs-actions.pod:6079
16428 "You must call this before calling C<guestfs_launch>, otherwise it has no "
16433 #: ../src/guestfs-actions.pod:6086
16434 msgid "guestfs_set_path"
16438 #: ../src/guestfs-actions.pod:6088
16442 " guestfs_set_path (guestfs_h *g,\n"
16443 " const char *searchpath);\n"
16448 #: ../src/guestfs-actions.pod:6092 ../fish/guestfish-actions.pod:4067
16449 msgid "Set the path that libguestfs searches for kernel and initrd.img."
16453 #: ../src/guestfs-actions.pod:6094 ../fish/guestfish-actions.pod:4069
16455 "The default is C<$libdir/guestfs> unless overridden by setting "
16456 "C<LIBGUESTFS_PATH> environment variable."
16460 #: ../src/guestfs-actions.pod:6097 ../fish/guestfish-actions.pod:4072
16461 msgid "Setting C<path> to C<NULL> restores the default path."
16465 #: ../src/guestfs-actions.pod:6103
16466 msgid "guestfs_set_qemu"
16470 #: ../src/guestfs-actions.pod:6105
16474 " guestfs_set_qemu (guestfs_h *g,\n"
16475 " const char *qemu);\n"
16480 #: ../src/guestfs-actions.pod:6109 ../fish/guestfish-actions.pod:4080
16481 msgid "Set the qemu binary that we will use."
16485 #: ../src/guestfs-actions.pod:6111 ../fish/guestfish-actions.pod:4082
16487 "The default is chosen when the library was compiled by the configure script."
16491 #: ../src/guestfs-actions.pod:6114 ../fish/guestfish-actions.pod:4085
16493 "You can also override this by setting the C<LIBGUESTFS_QEMU> environment "
16498 #: ../src/guestfs-actions.pod:6117 ../fish/guestfish-actions.pod:4088
16499 msgid "Setting C<qemu> to C<NULL> restores the default qemu binary."
16503 #: ../src/guestfs-actions.pod:6119 ../fish/guestfish-actions.pod:4090
16505 "Note that you should call this function as early as possible after creating "
16506 "the handle. This is because some pre-launch operations depend on testing "
16507 "qemu features (by running C<qemu -help>). If the qemu binary changes, we "
16508 "don't retest features, and so you might see inconsistent results. Using the "
16509 "environment variable C<LIBGUESTFS_QEMU> is safest of all since that picks "
16510 "the qemu binary at the same time as the handle is created."
16514 #: ../src/guestfs-actions.pod:6131
16515 msgid "guestfs_set_recovery_proc"
16519 #: ../src/guestfs-actions.pod:6133
16523 " guestfs_set_recovery_proc (guestfs_h *g,\n"
16524 " int recoveryproc);\n"
16529 #: ../src/guestfs-actions.pod:6137
16531 "If this is called with the parameter C<false> then C<guestfs_launch> does "
16532 "not create a recovery process. The purpose of the recovery process is to "
16533 "stop runaway qemu processes in the case where the main program aborts "
16538 #: ../src/guestfs-actions.pod:6142
16540 "This only has any effect if called before C<guestfs_launch>, and the default "
16545 #: ../src/guestfs-actions.pod:6145 ../fish/guestfish-actions.pod:4112
16547 "About the only time when you would want to disable this is if the main "
16548 "process will fork itself into the background (\"daemonize\" itself). In "
16549 "this case the recovery process thinks that the main program has disappeared "
16550 "and so kills qemu, which is not very helpful."
16554 #: ../src/guestfs-actions.pod:6155
16555 msgid "guestfs_set_selinux"
16559 #: ../src/guestfs-actions.pod:6157
16563 " guestfs_set_selinux (guestfs_h *g,\n"
16569 #: ../src/guestfs-actions.pod:6161 ../fish/guestfish-actions.pod:4124
16571 "This sets the selinux flag that is passed to the appliance at boot time. "
16572 "The default is C<selinux=0> (disabled)."
16576 #: ../src/guestfs-actions.pod:6164 ../fish/guestfish-actions.pod:4127
16578 "Note that if SELinux is enabled, it is always in Permissive mode "
16579 "(C<enforcing=0>)."
16583 #: ../src/guestfs-actions.pod:6174
16584 msgid "guestfs_set_trace"
16588 #: ../src/guestfs-actions.pod:6176
16592 " guestfs_set_trace (guestfs_h *g,\n"
16598 #: ../src/guestfs-actions.pod:6180 ../fish/guestfish-actions.pod:4139
16600 "If the command trace flag is set to 1, then libguestfs calls, parameters and "
16601 "return values are traced."
16605 #: ../src/guestfs-actions.pod:6183 ../fish/guestfish-actions.pod:4142
16607 "If you want to trace C API calls into libguestfs (and other libraries) then "
16608 "possibly a better way is to use the external ltrace(1) command."
16612 #: ../src/guestfs-actions.pod:6187 ../fish/guestfish-actions.pod:4146
16614 "Command traces are disabled unless the environment variable "
16615 "C<LIBGUESTFS_TRACE> is defined and set to C<1>."
16619 #: ../src/guestfs-actions.pod:6190
16621 "Trace messages are normally sent to C<stderr>, unless you register a "
16622 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
16626 #: ../src/guestfs-actions.pod:6198
16627 msgid "guestfs_set_verbose"
16631 #: ../src/guestfs-actions.pod:6200
16635 " guestfs_set_verbose (guestfs_h *g,\n"
16641 #: ../src/guestfs-actions.pod:6204 ../fish/guestfish-actions.pod:4159
16642 msgid "If C<verbose> is true, this turns on verbose messages."
16646 #: ../src/guestfs-actions.pod:6206 ../fish/guestfish-actions.pod:4161
16648 "Verbose messages are disabled unless the environment variable "
16649 "C<LIBGUESTFS_DEBUG> is defined and set to C<1>."
16653 #: ../src/guestfs-actions.pod:6209
16655 "Verbose messages are normally sent to C<stderr>, unless you register a "
16656 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
16660 #: ../src/guestfs-actions.pod:6217
16661 msgid "guestfs_setcon"
16665 #: ../src/guestfs-actions.pod:6219
16669 " guestfs_setcon (guestfs_h *g,\n"
16670 " const char *context);\n"
16675 #: ../src/guestfs-actions.pod:6223 ../fish/guestfish-actions.pod:4172
16677 "This sets the SELinux security context of the daemon to the string "
16682 #: ../src/guestfs-actions.pod:6226 ../fish/guestfish-actions.pod:4175
16683 msgid "See the documentation about SELINUX in L<guestfs(3)>."
16687 #: ../src/guestfs-actions.pod:6232
16688 msgid "guestfs_setxattr"
16692 #: ../src/guestfs-actions.pod:6234
16696 " guestfs_setxattr (guestfs_h *g,\n"
16697 " const char *xattr,\n"
16698 " const char *val,\n"
16700 " const char *path);\n"
16705 #: ../src/guestfs-actions.pod:6241 ../fish/guestfish-actions.pod:4181
16707 "This call sets the extended attribute named C<xattr> of the file C<path> to "
16708 "the value C<val> (of length C<vallen>). The value is arbitrary 8 bit data."
16712 #: ../src/guestfs-actions.pod:6245
16713 msgid "See also: C<guestfs_lsetxattr>, L<attr(5)>."
16717 #: ../src/guestfs-actions.pod:6251
16718 msgid "guestfs_sfdisk"
16722 #: ../src/guestfs-actions.pod:6253
16726 " guestfs_sfdisk (guestfs_h *g,\n"
16727 " const char *device,\n"
16731 " char *const *lines);\n"
16736 #: ../src/guestfs-actions.pod:6261 ../fish/guestfish-actions.pod:4191
16738 "This is a direct interface to the L<sfdisk(8)> program for creating "
16739 "partitions on block devices."
16743 #: ../src/guestfs-actions.pod:6264 ../fish/guestfish-actions.pod:4194
16744 msgid "C<device> should be a block device, for example C</dev/sda>."
16748 #: ../src/guestfs-actions.pod:6266 ../fish/guestfish-actions.pod:4196
16750 "C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads and "
16751 "sectors on the device, which are passed directly to sfdisk as the I<-C>, I<-"
16752 "H> and I<-S> parameters. If you pass C<0> for any of these, then the "
16753 "corresponding parameter is omitted. Usually for 'large' disks, you can just "
16754 "pass C<0> for these, but for small (floppy-sized) disks, sfdisk (or rather, "
16755 "the kernel) cannot work out the right geometry and you will need to tell it."
16759 #: ../src/guestfs-actions.pod:6274 ../fish/guestfish-actions.pod:4204
16761 "C<lines> is a list of lines that we feed to C<sfdisk>. For more information "
16762 "refer to the L<sfdisk(8)> manpage."
16766 #: ../src/guestfs-actions.pod:6277 ../fish/guestfish-actions.pod:4207
16768 "To create a single partition occupying the whole disk, you would pass "
16769 "C<lines> as a single element list, when the single element being the string "
16774 #: ../src/guestfs-actions.pod:6281
16776 "See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>, C<guestfs_part_init>"
16780 #: ../src/guestfs-actions.pod:6289 ../src/guestfs-actions.pod:6319
16781 #: ../src/guestfs-actions.pod:6352 ../fish/guestfish-actions.pod:4217
16782 #: ../fish/guestfish-actions.pod:4240 ../fish/guestfish-actions.pod:4262
16784 "This function is deprecated. In new code, use the C<part_add> call instead."
16788 #: ../src/guestfs-actions.pod:6298
16789 msgid "guestfs_sfdiskM"
16793 #: ../src/guestfs-actions.pod:6300
16797 " guestfs_sfdiskM (guestfs_h *g,\n"
16798 " const char *device,\n"
16799 " char *const *lines);\n"
16804 #: ../src/guestfs-actions.pod:6305
16806 "This is a simplified interface to the C<guestfs_sfdisk> command, where "
16807 "partition sizes are specified in megabytes only (rounded to the nearest "
16808 "cylinder) and you don't need to specify the cyls, heads and sectors "
16809 "parameters which were rarely if ever used anyway."
16813 #: ../src/guestfs-actions.pod:6311
16815 "See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage and "
16816 "C<guestfs_part_disk>"
16820 #: ../src/guestfs-actions.pod:6328
16821 msgid "guestfs_sfdisk_N"
16825 #: ../src/guestfs-actions.pod:6330
16829 " guestfs_sfdisk_N (guestfs_h *g,\n"
16830 " const char *device,\n"
16835 " const char *line);\n"
16840 #: ../src/guestfs-actions.pod:6339 ../fish/guestfish-actions.pod:4251
16842 "This runs L<sfdisk(8)> option to modify just the single partition C<n> "
16843 "(note: C<n> counts from 1)."
16847 #: ../src/guestfs-actions.pod:6342
16849 "For other parameters, see C<guestfs_sfdisk>. You should usually pass C<0> "
16850 "for the cyls/heads/sectors parameters."
16854 #: ../src/guestfs-actions.pod:6345
16855 msgid "See also: C<guestfs_part_add>"
16859 #: ../src/guestfs-actions.pod:6361
16860 msgid "guestfs_sfdisk_disk_geometry"
16864 #: ../src/guestfs-actions.pod:6363
16868 " guestfs_sfdisk_disk_geometry (guestfs_h *g,\n"
16869 " const char *device);\n"
16874 #: ../src/guestfs-actions.pod:6367
16876 "This displays the disk geometry of C<device> read from the partition table. "
16877 "Especially in the case where the underlying block device has been resized, "
16878 "this can be different from the kernel's idea of the geometry (see "
16879 "C<guestfs_sfdisk_kernel_geometry>)."
16883 #: ../src/guestfs-actions.pod:6372 ../src/guestfs-actions.pod:6388
16884 #: ../fish/guestfish-actions.pod:4278 ../fish/guestfish-actions.pod:4287
16885 msgid "The result is in human-readable format, and not designed to be parsed."
16889 #: ../src/guestfs-actions.pod:6380
16890 msgid "guestfs_sfdisk_kernel_geometry"
16894 #: ../src/guestfs-actions.pod:6382
16898 " guestfs_sfdisk_kernel_geometry (guestfs_h *g,\n"
16899 " const char *device);\n"
16904 #: ../src/guestfs-actions.pod:6386 ../fish/guestfish-actions.pod:4285
16905 msgid "This displays the kernel's idea of the geometry of C<device>."
16909 #: ../src/guestfs-actions.pod:6396
16910 msgid "guestfs_sfdisk_l"
16914 #: ../src/guestfs-actions.pod:6398
16918 " guestfs_sfdisk_l (guestfs_h *g,\n"
16919 " const char *device);\n"
16924 #: ../src/guestfs-actions.pod:6402 ../fish/guestfish-actions.pod:4294
16926 "This displays the partition table on C<device>, in the human-readable output "
16927 "of the L<sfdisk(8)> command. It is not intended to be parsed."
16931 #: ../src/guestfs-actions.pod:6406
16932 msgid "See also: C<guestfs_part_list>"
16936 #: ../src/guestfs-actions.pod:6411 ../fish/guestfish-actions.pod:4300
16938 "This function is deprecated. In new code, use the C<part_list> call instead."
16942 #: ../src/guestfs-actions.pod:6420
16947 #: ../src/guestfs-actions.pod:6422
16951 " guestfs_sh (guestfs_h *g,\n"
16952 " const char *command);\n"
16957 #: ../src/guestfs-actions.pod:6426 ../fish/guestfish-actions.pod:4311
16959 "This call runs a command from the guest filesystem via the guest's C</bin/"
16964 #: ../src/guestfs-actions.pod:6429
16965 msgid "This is like C<guestfs_command>, but passes the command to:"
16969 #: ../src/guestfs-actions.pod:6431 ../fish/guestfish-actions.pod:4316
16972 " /bin/sh -c \"command\"\n"
16977 #: ../src/guestfs-actions.pod:6433 ../fish/guestfish-actions.pod:4318
16979 "Depending on the guest's shell, this usually results in wildcards being "
16980 "expanded, shell expressions being interpolated and so on."
16984 #: ../src/guestfs-actions.pod:6437
16985 msgid "All the provisos about C<guestfs_command> apply to this call."
16989 #: ../src/guestfs-actions.pod:6444
16990 msgid "guestfs_sh_lines"
16994 #: ../src/guestfs-actions.pod:6446
16998 " guestfs_sh_lines (guestfs_h *g,\n"
16999 " const char *command);\n"
17004 #: ../src/guestfs-actions.pod:6450
17006 "This is the same as C<guestfs_sh>, but splits the result into a list of "
17011 #: ../src/guestfs-actions.pod:6453
17012 msgid "See also: C<guestfs_command_lines>"
17016 #: ../src/guestfs-actions.pod:6461
17017 msgid "guestfs_sleep"
17021 #: ../src/guestfs-actions.pod:6463
17025 " guestfs_sleep (guestfs_h *g,\n"
17031 #: ../src/guestfs-actions.pod:6467 ../fish/guestfish-actions.pod:4337
17032 msgid "Sleep for C<secs> seconds."
17036 #: ../src/guestfs-actions.pod:6471
17037 msgid "(Added in 1.0.41)"
17041 #: ../src/guestfs-actions.pod:6473 ../src/guestfs-structs.pod:109
17042 msgid "guestfs_stat"
17046 #: ../src/guestfs-actions.pod:6475
17049 " struct guestfs_stat *\n"
17050 " guestfs_stat (guestfs_h *g,\n"
17051 " const char *path);\n"
17056 #: ../src/guestfs-actions.pod:6481 ../fish/guestfish-actions.pod:4345
17057 msgid "This is the same as the C<stat(2)> system call."
17061 #: ../src/guestfs-actions.pod:6489 ../src/guestfs-structs.pod:135
17062 msgid "guestfs_statvfs"
17066 #: ../src/guestfs-actions.pod:6491
17069 " struct guestfs_statvfs *\n"
17070 " guestfs_statvfs (guestfs_h *g,\n"
17071 " const char *path);\n"
17076 #: ../src/guestfs-actions.pod:6495 ../fish/guestfish-actions.pod:4351
17078 "Returns file system statistics for any mounted file system. C<path> should "
17079 "be a file or directory in the mounted file system (typically it is the mount "
17080 "point itself, but it doesn't need to be)."
17084 #: ../src/guestfs-actions.pod:6499 ../fish/guestfish-actions.pod:4355
17085 msgid "This is the same as the C<statvfs(2)> system call."
17089 #: ../src/guestfs-actions.pod:6501
17091 "This function returns a C<struct guestfs_statvfs *>, or NULL if there was an "
17092 "error. I<The caller must call C<guestfs_free_statvfs> after use>."
17096 #: ../src/guestfs-actions.pod:6507
17097 msgid "guestfs_strings"
17101 #: ../src/guestfs-actions.pod:6509
17105 " guestfs_strings (guestfs_h *g,\n"
17106 " const char *path);\n"
17111 #: ../src/guestfs-actions.pod:6513 ../fish/guestfish-actions.pod:4361
17113 "This runs the L<strings(1)> command on a file and returns the list of "
17114 "printable strings found."
17118 #: ../src/guestfs-actions.pod:6525
17119 msgid "guestfs_strings_e"
17123 #: ../src/guestfs-actions.pod:6527
17127 " guestfs_strings_e (guestfs_h *g,\n"
17128 " const char *encoding,\n"
17129 " const char *path);\n"
17134 #: ../src/guestfs-actions.pod:6532
17136 "This is like the C<guestfs_strings> command, but allows you to specify the "
17137 "encoding of strings that are looked for in the source file C<path>."
17141 #: ../src/guestfs-actions.pod:6536 ../fish/guestfish-actions.pod:4375
17142 msgid "Allowed encodings are:"
17146 #: ../src/guestfs-actions.pod:6540 ../fish/guestfish-actions.pod:4379
17151 #: ../src/guestfs-actions.pod:6542
17153 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
17154 "ISO-8859-X (this is what C<guestfs_strings> uses)."
17158 #: ../src/guestfs-actions.pod:6545 ../fish/guestfish-actions.pod:4384
17163 #: ../src/guestfs-actions.pod:6547 ../fish/guestfish-actions.pod:4386
17164 msgid "Single 8-bit-byte characters."
17168 #: ../src/guestfs-actions.pod:6549 ../fish/guestfish-actions.pod:4388
17173 #: ../src/guestfs-actions.pod:6551 ../fish/guestfish-actions.pod:4390
17174 msgid "16-bit big endian strings such as those encoded in UTF-16BE or UCS-2BE."
17178 #: ../src/guestfs-actions.pod:6554 ../fish/guestfish-actions.pod:4393
17179 msgid "l (lower case letter L)"
17183 #: ../src/guestfs-actions.pod:6556 ../fish/guestfish-actions.pod:4395
17185 "16-bit little endian such as UTF-16LE and UCS-2LE. This is useful for "
17186 "examining binaries in Windows guests."
17190 #: ../src/guestfs-actions.pod:6559 ../fish/guestfish-actions.pod:4398
17195 #: ../src/guestfs-actions.pod:6561 ../fish/guestfish-actions.pod:4400
17196 msgid "32-bit big endian such as UCS-4BE."
17200 #: ../src/guestfs-actions.pod:6563 ../fish/guestfish-actions.pod:4402
17205 #: ../src/guestfs-actions.pod:6565 ../fish/guestfish-actions.pod:4404
17206 msgid "32-bit little endian such as UCS-4LE."
17210 #: ../src/guestfs-actions.pod:6569 ../fish/guestfish-actions.pod:4408
17211 msgid "The returned strings are transcoded to UTF-8."
17215 #: ../src/guestfs-actions.pod:6580
17216 msgid "guestfs_swapoff_device"
17220 #: ../src/guestfs-actions.pod:6582
17224 " guestfs_swapoff_device (guestfs_h *g,\n"
17225 " const char *device);\n"
17230 #: ../src/guestfs-actions.pod:6586
17232 "This command disables the libguestfs appliance swap device or partition "
17233 "named C<device>. See C<guestfs_swapon_device>."
17237 #: ../src/guestfs-actions.pod:6594
17238 msgid "guestfs_swapoff_file"
17242 #: ../src/guestfs-actions.pod:6596
17246 " guestfs_swapoff_file (guestfs_h *g,\n"
17247 " const char *file);\n"
17252 #: ../src/guestfs-actions.pod:6600 ../fish/guestfish-actions.pod:4425
17253 msgid "This command disables the libguestfs appliance swap on file."
17257 #: ../src/guestfs-actions.pod:6606
17258 msgid "guestfs_swapoff_label"
17262 #: ../src/guestfs-actions.pod:6608
17266 " guestfs_swapoff_label (guestfs_h *g,\n"
17267 " const char *label);\n"
17272 #: ../src/guestfs-actions.pod:6612 ../fish/guestfish-actions.pod:4431
17274 "This command disables the libguestfs appliance swap on labeled swap "
17279 #: ../src/guestfs-actions.pod:6619
17280 msgid "guestfs_swapoff_uuid"
17284 #: ../src/guestfs-actions.pod:6621
17288 " guestfs_swapoff_uuid (guestfs_h *g,\n"
17289 " const char *uuid);\n"
17294 #: ../src/guestfs-actions.pod:6625 ../fish/guestfish-actions.pod:4438
17296 "This command disables the libguestfs appliance swap partition with the given "
17301 #: ../src/guestfs-actions.pod:6632
17302 msgid "guestfs_swapon_device"
17306 #: ../src/guestfs-actions.pod:6634
17310 " guestfs_swapon_device (guestfs_h *g,\n"
17311 " const char *device);\n"
17316 #: ../src/guestfs-actions.pod:6638
17318 "This command enables the libguestfs appliance to use the swap device or "
17319 "partition named C<device>. The increased memory is made available for all "
17320 "commands, for example those run using C<guestfs_command> or C<guestfs_sh>."
17324 #: ../src/guestfs-actions.pod:6643 ../fish/guestfish-actions.pod:4450
17326 "Note that you should not swap to existing guest swap partitions unless you "
17327 "know what you are doing. They may contain hibernation information, or other "
17328 "information that the guest doesn't want you to trash. You also risk leaking "
17329 "information about the host to the guest this way. Instead, attach a new "
17330 "host device to the guest and swap on that."
17334 #: ../src/guestfs-actions.pod:6654
17335 msgid "guestfs_swapon_file"
17339 #: ../src/guestfs-actions.pod:6656
17343 " guestfs_swapon_file (guestfs_h *g,\n"
17344 " const char *file);\n"
17349 #: ../src/guestfs-actions.pod:6660
17351 "This command enables swap to a file. See C<guestfs_swapon_device> for other "
17356 #: ../src/guestfs-actions.pod:6667
17357 msgid "guestfs_swapon_label"
17361 #: ../src/guestfs-actions.pod:6669
17365 " guestfs_swapon_label (guestfs_h *g,\n"
17366 " const char *label);\n"
17371 #: ../src/guestfs-actions.pod:6673
17373 "This command enables swap to a labeled swap partition. See "
17374 "C<guestfs_swapon_device> for other notes."
17378 #: ../src/guestfs-actions.pod:6680
17379 msgid "guestfs_swapon_uuid"
17383 #: ../src/guestfs-actions.pod:6682
17387 " guestfs_swapon_uuid (guestfs_h *g,\n"
17388 " const char *uuid);\n"
17393 #: ../src/guestfs-actions.pod:6686
17395 "This command enables swap to a swap partition with the given UUID. See "
17396 "C<guestfs_swapon_device> for other notes."
17400 #: ../src/guestfs-actions.pod:6693
17401 msgid "guestfs_sync"
17405 #: ../src/guestfs-actions.pod:6695
17409 " guestfs_sync (guestfs_h *g);\n"
17414 #: ../src/guestfs-actions.pod:6698 ../fish/guestfish-actions.pod:4482
17416 "This syncs the disk, so that any writes are flushed through to the "
17417 "underlying disk image."
17421 #: ../src/guestfs-actions.pod:6701 ../fish/guestfish-actions.pod:4485
17423 "You should always call this if you have modified a disk image, before "
17424 "closing the handle."
17428 #: ../src/guestfs-actions.pod:6708
17429 msgid "guestfs_tail"
17433 #: ../src/guestfs-actions.pod:6710
17437 " guestfs_tail (guestfs_h *g,\n"
17438 " const char *path);\n"
17443 #: ../src/guestfs-actions.pod:6714 ../fish/guestfish-actions.pod:4492
17445 "This command returns up to the last 10 lines of a file as a list of strings."
17449 #: ../src/guestfs-actions.pod:6726
17450 msgid "guestfs_tail_n"
17454 #: ../src/guestfs-actions.pod:6728
17458 " guestfs_tail_n (guestfs_h *g,\n"
17460 " const char *path);\n"
17465 #: ../src/guestfs-actions.pod:6733 ../fish/guestfish-actions.pod:4502
17467 "If the parameter C<nrlines> is a positive number, this returns the last "
17468 "C<nrlines> lines of the file C<path>."
17472 #: ../src/guestfs-actions.pod:6736 ../fish/guestfish-actions.pod:4505
17474 "If the parameter C<nrlines> is a negative number, this returns lines from "
17475 "the file C<path>, starting with the C<-nrlines>th line."
17479 #: ../src/guestfs-actions.pod:6750
17480 msgid "guestfs_tar_in"
17484 #: ../src/guestfs-actions.pod:6752
17488 " guestfs_tar_in (guestfs_h *g,\n"
17489 " const char *tarfile,\n"
17490 " const char *directory);\n"
17495 #: ../src/guestfs-actions.pod:6757 ../fish/guestfish-actions.pod:4517
17497 "This command uploads and unpacks local file C<tarfile> (an I<uncompressed> "
17498 "tar file) into C<directory>."
17502 #: ../src/guestfs-actions.pod:6760
17504 "To upload a compressed tarball, use C<guestfs_tgz_in> or C<guestfs_txz_in>."
17508 #: ../src/guestfs-actions.pod:6765 ../src/guestfs-actions.pod:6782
17509 #: ../src/guestfs-actions.pod:6798 ../src/guestfs-actions.pod:6814
17510 msgid "(Added in 1.0.3)"
17514 #: ../src/guestfs-actions.pod:6767
17515 msgid "guestfs_tar_out"
17519 #: ../src/guestfs-actions.pod:6769
17523 " guestfs_tar_out (guestfs_h *g,\n"
17524 " const char *directory,\n"
17525 " const char *tarfile);\n"
17530 #: ../src/guestfs-actions.pod:6774 ../fish/guestfish-actions.pod:4529
17532 "This command packs the contents of C<directory> and downloads it to local "
17537 #: ../src/guestfs-actions.pod:6777
17539 "To download a compressed tarball, use C<guestfs_tgz_out> or "
17540 "C<guestfs_txz_out>."
17544 #: ../src/guestfs-actions.pod:6784
17545 msgid "guestfs_tgz_in"
17549 #: ../src/guestfs-actions.pod:6786
17553 " guestfs_tgz_in (guestfs_h *g,\n"
17554 " const char *tarball,\n"
17555 " const char *directory);\n"
17560 #: ../src/guestfs-actions.pod:6791 ../fish/guestfish-actions.pod:4541
17562 "This command uploads and unpacks local file C<tarball> (a I<gzip compressed> "
17563 "tar file) into C<directory>."
17567 #: ../src/guestfs-actions.pod:6794
17568 msgid "To upload an uncompressed tarball, use C<guestfs_tar_in>."
17572 #: ../src/guestfs-actions.pod:6800
17573 msgid "guestfs_tgz_out"
17577 #: ../src/guestfs-actions.pod:6802
17581 " guestfs_tgz_out (guestfs_h *g,\n"
17582 " const char *directory,\n"
17583 " const char *tarball);\n"
17588 #: ../src/guestfs-actions.pod:6807 ../fish/guestfish-actions.pod:4552
17590 "This command packs the contents of C<directory> and downloads it to local "
17595 #: ../src/guestfs-actions.pod:6810
17596 msgid "To download an uncompressed tarball, use C<guestfs_tar_out>."
17600 #: ../src/guestfs-actions.pod:6816
17601 msgid "guestfs_touch"
17605 #: ../src/guestfs-actions.pod:6818
17609 " guestfs_touch (guestfs_h *g,\n"
17610 " const char *path);\n"
17615 #: ../src/guestfs-actions.pod:6822 ../fish/guestfish-actions.pod:4563
17617 "Touch acts like the L<touch(1)> command. It can be used to update the "
17618 "timestamps on a file, or, if the file does not exist, to create a new zero-"
17623 #: ../src/guestfs-actions.pod:6826 ../fish/guestfish-actions.pod:4567
17625 "This command only works on regular files, and will fail on other file types "
17626 "such as directories, symbolic links, block special etc."
17630 #: ../src/guestfs-actions.pod:6833
17631 msgid "guestfs_truncate"
17635 #: ../src/guestfs-actions.pod:6835
17639 " guestfs_truncate (guestfs_h *g,\n"
17640 " const char *path);\n"
17645 #: ../src/guestfs-actions.pod:6839 ../fish/guestfish-actions.pod:4574
17647 "This command truncates C<path> to a zero-length file. The file must exist "
17652 #: ../src/guestfs-actions.pod:6846
17653 msgid "guestfs_truncate_size"
17657 #: ../src/guestfs-actions.pod:6848
17661 " guestfs_truncate_size (guestfs_h *g,\n"
17662 " const char *path,\n"
17663 " int64_t size);\n"
17668 #: ../src/guestfs-actions.pod:6853 ../fish/guestfish-actions.pod:4581
17670 "This command truncates C<path> to size C<size> bytes. The file must exist "
17675 #: ../src/guestfs-actions.pod:6856
17677 "If the current file size is less than C<size> then the file is extended to "
17678 "the required size with zero bytes. This creates a sparse file (ie. disk "
17679 "blocks are not allocated for the file until you write to it). To create a "
17680 "non-sparse file of zeroes, use C<guestfs_fallocate64> instead."
17684 #: ../src/guestfs-actions.pod:6866
17685 msgid "guestfs_tune2fs_l"
17689 #: ../src/guestfs-actions.pod:6868
17693 " guestfs_tune2fs_l (guestfs_h *g,\n"
17694 " const char *device);\n"
17699 #: ../src/guestfs-actions.pod:6872 ../fish/guestfish-actions.pod:4594
17701 "This returns the contents of the ext2, ext3 or ext4 filesystem superblock on "
17706 #: ../src/guestfs-actions.pod:6875 ../fish/guestfish-actions.pod:4597
17708 "It is the same as running C<tune2fs -l device>. See L<tune2fs(8)> manpage "
17709 "for more details. The list of fields returned isn't clearly defined, and "
17710 "depends on both the version of C<tune2fs> that libguestfs was built against, "
17711 "and the filesystem itself."
17715 #: ../src/guestfs-actions.pod:6888
17716 msgid "guestfs_txz_in"
17720 #: ../src/guestfs-actions.pod:6890
17724 " guestfs_txz_in (guestfs_h *g,\n"
17725 " const char *tarball,\n"
17726 " const char *directory);\n"
17731 #: ../src/guestfs-actions.pod:6895 ../fish/guestfish-actions.pod:4606
17733 "This command uploads and unpacks local file C<tarball> (an I<xz compressed> "
17734 "tar file) into C<directory>."
17738 #: ../src/guestfs-actions.pod:6902
17739 msgid "guestfs_txz_out"
17743 #: ../src/guestfs-actions.pod:6904
17747 " guestfs_txz_out (guestfs_h *g,\n"
17748 " const char *directory,\n"
17749 " const char *tarball);\n"
17754 #: ../src/guestfs-actions.pod:6909 ../fish/guestfish-actions.pod:4615
17756 "This command packs the contents of C<directory> and downloads it to local "
17757 "file C<tarball> (as an xz compressed tar archive)."
17761 #: ../src/guestfs-actions.pod:6916
17762 msgid "guestfs_umask"
17766 #: ../src/guestfs-actions.pod:6918
17770 " guestfs_umask (guestfs_h *g,\n"
17776 #: ../src/guestfs-actions.pod:6922 ../fish/guestfish-actions.pod:4624
17778 "This function sets the mask used for creating new files and device nodes to "
17783 #: ../src/guestfs-actions.pod:6925 ../fish/guestfish-actions.pod:4627
17785 "Typical umask values would be C<022> which creates new files with "
17786 "permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and C<002> which creates "
17787 "new files with permissions like \"-rw-rw-r--\" or \"-rwxrwxr-x\"."
17791 #: ../src/guestfs-actions.pod:6930 ../fish/guestfish-actions.pod:4632
17793 "The default umask is C<022>. This is important because it means that "
17794 "directories and device nodes will be created with C<0644> or C<0755> mode "
17795 "even if you specify C<0777>."
17799 #: ../src/guestfs-actions.pod:6934
17801 "See also C<guestfs_get_umask>, L<umask(2)>, C<guestfs_mknod>, "
17802 "C<guestfs_mkdir>."
17806 #: ../src/guestfs-actions.pod:6937 ../fish/guestfish-actions.pod:4639
17807 msgid "This call returns the previous umask."
17811 #: ../src/guestfs-actions.pod:6943
17812 msgid "guestfs_umount"
17816 #: ../src/guestfs-actions.pod:6945
17820 " guestfs_umount (guestfs_h *g,\n"
17821 " const char *pathordevice);\n"
17826 #: ../src/guestfs-actions.pod:6949 ../fish/guestfish-actions.pod:4647
17828 "This unmounts the given filesystem. The filesystem may be specified either "
17829 "by its mountpoint (path) or the device which contains the filesystem."
17833 #: ../src/guestfs-actions.pod:6957
17834 msgid "guestfs_umount_all"
17838 #: ../src/guestfs-actions.pod:6959
17842 " guestfs_umount_all (guestfs_h *g);\n"
17847 #: ../src/guestfs-actions.pod:6962 ../fish/guestfish-actions.pod:4657
17848 msgid "This unmounts all mounted filesystems."
17852 #: ../src/guestfs-actions.pod:6964 ../fish/guestfish-actions.pod:4659
17853 msgid "Some internal mounts are not unmounted by this call."
17857 #: ../src/guestfs-actions.pod:6970
17858 msgid "guestfs_upload"
17862 #: ../src/guestfs-actions.pod:6972
17866 " guestfs_upload (guestfs_h *g,\n"
17867 " const char *filename,\n"
17868 " const char *remotefilename);\n"
17873 #: ../src/guestfs-actions.pod:6977 ../src/guestfs-actions.pod:7001
17874 #: ../fish/guestfish-actions.pod:4665 ../fish/guestfish-actions.pod:4678
17875 msgid "Upload local file C<filename> to C<remotefilename> on the filesystem."
17879 #: ../src/guestfs-actions.pod:6982
17880 msgid "See also C<guestfs_download>."
17884 #: ../src/guestfs-actions.pod:6993
17885 msgid "guestfs_upload_offset"
17889 #: ../src/guestfs-actions.pod:6995
17893 " guestfs_upload_offset (guestfs_h *g,\n"
17894 " const char *filename,\n"
17895 " const char *remotefilename,\n"
17896 " int64_t offset);\n"
17901 #: ../src/guestfs-actions.pod:7004 ../fish/guestfish-actions.pod:4681
17903 "C<remotefilename> is overwritten starting at the byte C<offset> specified. "
17904 "The intention is to overwrite parts of existing files or devices, although "
17905 "if a non-existant file is specified then it is created with a \"hole\" "
17906 "before C<offset>. The size of the data written is implicit in the size of "
17907 "the source C<filename>."
17911 #: ../src/guestfs-actions.pod:7011
17913 "Note that there is no limit on the amount of data that can be uploaded with "
17914 "this call, unlike with C<guestfs_pwrite>, and this call always writes the "
17915 "full amount unless an error occurs."
17919 #: ../src/guestfs-actions.pod:7016
17920 msgid "See also C<guestfs_upload>, C<guestfs_pwrite>."
17924 #: ../src/guestfs-actions.pod:7027
17925 msgid "guestfs_utimens"
17929 #: ../src/guestfs-actions.pod:7029
17933 " guestfs_utimens (guestfs_h *g,\n"
17934 " const char *path,\n"
17935 " int64_t atsecs,\n"
17936 " int64_t atnsecs,\n"
17937 " int64_t mtsecs,\n"
17938 " int64_t mtnsecs);\n"
17943 #: ../src/guestfs-actions.pod:7037 ../fish/guestfish-actions.pod:4701
17944 msgid "This command sets the timestamps of a file with nanosecond precision."
17948 #: ../src/guestfs-actions.pod:7040 ../fish/guestfish-actions.pod:4704
17950 "C<atsecs, atnsecs> are the last access time (atime) in secs and nanoseconds "
17955 #: ../src/guestfs-actions.pod:7043 ../fish/guestfish-actions.pod:4707
17957 "C<mtsecs, mtnsecs> are the last modification time (mtime) in secs and "
17958 "nanoseconds from the epoch."
17962 #: ../src/guestfs-actions.pod:7046 ../fish/guestfish-actions.pod:4710
17964 "If the C<*nsecs> field contains the special value C<-1> then the "
17965 "corresponding timestamp is set to the current time. (The C<*secs> field is "
17966 "ignored in this case)."
17970 #: ../src/guestfs-actions.pod:7050 ../fish/guestfish-actions.pod:4714
17972 "If the C<*nsecs> field contains the special value C<-2> then the "
17973 "corresponding timestamp is left unchanged. (The C<*secs> field is ignored "
17978 #: ../src/guestfs-actions.pod:7058 ../src/guestfs-structs.pod:175
17979 msgid "guestfs_version"
17983 #: ../src/guestfs-actions.pod:7060
17986 " struct guestfs_version *\n"
17987 " guestfs_version (guestfs_h *g);\n"
17992 #: ../src/guestfs-actions.pod:7063 ../fish/guestfish-actions.pod:4722
17994 "Return the libguestfs version number that the program is linked against."
17998 #: ../src/guestfs-actions.pod:7066 ../fish/guestfish-actions.pod:4725
18000 "Note that because of dynamic linking this is not necessarily the version of "
18001 "libguestfs that you compiled against. You can compile the program, and then "
18002 "at runtime dynamically link against a completely different C<libguestfs.so> "
18007 #: ../src/guestfs-actions.pod:7071 ../fish/guestfish-actions.pod:4730
18009 "This call was added in version C<1.0.58>. In previous versions of "
18010 "libguestfs there was no way to get the version number. From C code you can "
18011 "use dynamic linker functions to find out if this symbol exists (if it "
18012 "doesn't, then it's an earlier version)."
18016 #: ../src/guestfs-actions.pod:7077 ../fish/guestfish-actions.pod:4736
18018 "The call returns a structure with four elements. The first three (C<major>, "
18019 "C<minor> and C<release>) are numbers and correspond to the usual version "
18020 "triplet. The fourth element (C<extra>) is a string and is normally empty, "
18021 "but may be used for distro-specific information."
18025 #: ../src/guestfs-actions.pod:7083 ../fish/guestfish-actions.pod:4742
18027 "To construct the original version string: C<$major.$minor.$release$extra>"
18031 #: ../src/guestfs-actions.pod:7086 ../fish/guestfish-actions.pod:4745
18032 msgid "See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>."
18036 #: ../src/guestfs-actions.pod:7088
18038 "I<Note:> Don't use this call to test for availability of features. In "
18039 "enterprise distributions we backport features from later versions into "
18040 "earlier versions, making this an unreliable way to test for features. Use "
18041 "C<guestfs_available> instead."
18045 #: ../src/guestfs-actions.pod:7094
18047 "This function returns a C<struct guestfs_version *>, or NULL if there was an "
18048 "error. I<The caller must call C<guestfs_free_version> after use>."
18052 #: ../src/guestfs-actions.pod:7098
18053 msgid "(Added in 1.0.58)"
18057 #: ../src/guestfs-actions.pod:7100
18058 msgid "guestfs_vfs_label"
18062 #: ../src/guestfs-actions.pod:7102
18066 " guestfs_vfs_label (guestfs_h *g,\n"
18067 " const char *device);\n"
18072 #: ../src/guestfs-actions.pod:7106 ../fish/guestfish-actions.pod:4757
18073 msgid "This returns the filesystem label of the filesystem on C<device>."
18077 #: ../src/guestfs-actions.pod:7109 ../fish/guestfish-actions.pod:4760
18078 msgid "If the filesystem is unlabeled, this returns the empty string."
18082 #: ../src/guestfs-actions.pod:7111
18083 msgid "To find a filesystem from the label, use C<guestfs_findfs_label>."
18087 #: ../src/guestfs-actions.pod:7116 ../src/guestfs-actions.pod:7153
18088 msgid "(Added in 1.3.18)"
18092 #: ../src/guestfs-actions.pod:7118
18093 msgid "guestfs_vfs_type"
18097 #: ../src/guestfs-actions.pod:7120
18101 " guestfs_vfs_type (guestfs_h *g,\n"
18102 " const char *device);\n"
18107 #: ../src/guestfs-actions.pod:7124 ../fish/guestfish-actions.pod:4768
18109 "This command gets the filesystem type corresponding to the filesystem on "
18114 #: ../src/guestfs-actions.pod:7127 ../fish/guestfish-actions.pod:4771
18116 "For most filesystems, the result is the name of the Linux VFS module which "
18117 "would be used to mount this filesystem if you mounted it without specifying "
18118 "the filesystem type. For example a string such as C<ext3> or C<ntfs>."
18122 #: ../src/guestfs-actions.pod:7137
18123 msgid "guestfs_vfs_uuid"
18127 #: ../src/guestfs-actions.pod:7139
18131 " guestfs_vfs_uuid (guestfs_h *g,\n"
18132 " const char *device);\n"
18137 #: ../src/guestfs-actions.pod:7143 ../fish/guestfish-actions.pod:4780
18138 msgid "This returns the filesystem UUID of the filesystem on C<device>."
18142 #: ../src/guestfs-actions.pod:7146 ../fish/guestfish-actions.pod:4783
18143 msgid "If the filesystem does not have a UUID, this returns the empty string."
18147 #: ../src/guestfs-actions.pod:7148
18148 msgid "To find a filesystem from the UUID, use C<guestfs_findfs_uuid>."
18152 #: ../src/guestfs-actions.pod:7155
18153 msgid "guestfs_vg_activate"
18157 #: ../src/guestfs-actions.pod:7157
18161 " guestfs_vg_activate (guestfs_h *g,\n"
18163 " char *const *volgroups);\n"
18168 #: ../src/guestfs-actions.pod:7162 ../fish/guestfish-actions.pod:4791
18170 "This command activates or (if C<activate> is false) deactivates all logical "
18171 "volumes in the listed volume groups C<volgroups>. If activated, then they "
18172 "are made known to the kernel, ie. they appear as C</dev/mapper> devices. If "
18173 "deactivated, then those devices disappear."
18177 #: ../src/guestfs-actions.pod:7168 ../fish/guestfish-actions.pod:4797
18178 msgid "This command is the same as running C<vgchange -a y|n volgroups...>"
18182 #: ../src/guestfs-actions.pod:7170 ../fish/guestfish-actions.pod:4799
18184 "Note that if C<volgroups> is an empty list then B<all> volume groups are "
18185 "activated or deactivated."
18189 #: ../src/guestfs-actions.pod:7177
18190 msgid "guestfs_vg_activate_all"
18194 #: ../src/guestfs-actions.pod:7179
18198 " guestfs_vg_activate_all (guestfs_h *g,\n"
18199 " int activate);\n"
18204 #: ../src/guestfs-actions.pod:7183 ../fish/guestfish-actions.pod:4806
18206 "This command activates or (if C<activate> is false) deactivates all logical "
18207 "volumes in all volume groups. If activated, then they are made known to the "
18208 "kernel, ie. they appear as C</dev/mapper> devices. If deactivated, then "
18209 "those devices disappear."
18213 #: ../src/guestfs-actions.pod:7189 ../fish/guestfish-actions.pod:4812
18214 msgid "This command is the same as running C<vgchange -a y|n>"
18218 #: ../src/guestfs-actions.pod:7195
18219 msgid "guestfs_vgcreate"
18223 #: ../src/guestfs-actions.pod:7197
18227 " guestfs_vgcreate (guestfs_h *g,\n"
18228 " const char *volgroup,\n"
18229 " char *const *physvols);\n"
18234 #: ../src/guestfs-actions.pod:7202 ../fish/guestfish-actions.pod:4818
18236 "This creates an LVM volume group called C<volgroup> from the non-empty list "
18237 "of physical volumes C<physvols>."
18241 #: ../src/guestfs-actions.pod:7209
18242 msgid "guestfs_vglvuuids"
18246 #: ../src/guestfs-actions.pod:7211
18250 " guestfs_vglvuuids (guestfs_h *g,\n"
18251 " const char *vgname);\n"
18256 #: ../src/guestfs-actions.pod:7215 ../fish/guestfish-actions.pod:4825
18258 "Given a VG called C<vgname>, this returns the UUIDs of all the logical "
18259 "volumes created in this volume group."
18263 #: ../src/guestfs-actions.pod:7218
18265 "You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid> calls to "
18266 "associate logical volumes and volume groups."
18270 #: ../src/guestfs-actions.pod:7221
18271 msgid "See also C<guestfs_vgpvuuids>."
18275 #: ../src/guestfs-actions.pod:7229
18276 msgid "guestfs_vgpvuuids"
18280 #: ../src/guestfs-actions.pod:7231
18284 " guestfs_vgpvuuids (guestfs_h *g,\n"
18285 " const char *vgname);\n"
18290 #: ../src/guestfs-actions.pod:7235 ../fish/guestfish-actions.pod:4837
18292 "Given a VG called C<vgname>, this returns the UUIDs of all the physical "
18293 "volumes that this volume group resides on."
18297 #: ../src/guestfs-actions.pod:7238
18299 "You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid> calls to "
18300 "associate physical volumes and volume groups."
18304 #: ../src/guestfs-actions.pod:7241
18305 msgid "See also C<guestfs_vglvuuids>."
18309 #: ../src/guestfs-actions.pod:7249
18310 msgid "guestfs_vgremove"
18314 #: ../src/guestfs-actions.pod:7251
18318 " guestfs_vgremove (guestfs_h *g,\n"
18319 " const char *vgname);\n"
18324 #: ../src/guestfs-actions.pod:7255 ../fish/guestfish-actions.pod:4849
18325 msgid "Remove an LVM volume group C<vgname>, (for example C<VG>)."
18329 #: ../src/guestfs-actions.pod:7257 ../fish/guestfish-actions.pod:4851
18331 "This also forcibly removes all logical volumes in the volume group (if any)."
18335 #: ../src/guestfs-actions.pod:7264
18336 msgid "guestfs_vgrename"
18340 #: ../src/guestfs-actions.pod:7266
18344 " guestfs_vgrename (guestfs_h *g,\n"
18345 " const char *volgroup,\n"
18346 " const char *newvolgroup);\n"
18351 #: ../src/guestfs-actions.pod:7271 ../fish/guestfish-actions.pod:4858
18352 msgid "Rename a volume group C<volgroup> with the new name C<newvolgroup>."
18356 #: ../src/guestfs-actions.pod:7277
18357 msgid "guestfs_vgs"
18361 #: ../src/guestfs-actions.pod:7279
18365 " guestfs_vgs (guestfs_h *g);\n"
18370 #: ../src/guestfs-actions.pod:7282 ../fish/guestfish-actions.pod:4864
18372 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
18377 #: ../src/guestfs-actions.pod:7285 ../fish/guestfish-actions.pod:4867
18379 "This returns a list of just the volume group names that were detected (eg. "
18384 #: ../src/guestfs-actions.pod:7288
18385 msgid "See also C<guestfs_vgs_full>."
18389 #: ../src/guestfs-actions.pod:7296
18390 msgid "guestfs_vgs_full"
18394 #: ../src/guestfs-actions.pod:7298
18397 " struct guestfs_lvm_vg_list *\n"
18398 " guestfs_vgs_full (guestfs_h *g);\n"
18403 #: ../src/guestfs-actions.pod:7301 ../fish/guestfish-actions.pod:4876
18405 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
18406 "> command. The \"full\" version includes all fields."
18410 #: ../src/guestfs-actions.pod:7304
18412 "This function returns a C<struct guestfs_lvm_vg_list *>, or NULL if there "
18413 "was an error. I<The caller must call C<guestfs_free_lvm_vg_list> after use>."
18417 #: ../src/guestfs-actions.pod:7310
18418 msgid "guestfs_vgscan"
18422 #: ../src/guestfs-actions.pod:7312
18426 " guestfs_vgscan (guestfs_h *g);\n"
18431 #: ../src/guestfs-actions.pod:7315 ../fish/guestfish-actions.pod:4883
18433 "This rescans all block devices and rebuilds the list of LVM physical "
18434 "volumes, volume groups and logical volumes."
18438 #: ../src/guestfs-actions.pod:7322
18439 msgid "guestfs_vguuid"
18443 #: ../src/guestfs-actions.pod:7324
18447 " guestfs_vguuid (guestfs_h *g,\n"
18448 " const char *vgname);\n"
18453 #: ../src/guestfs-actions.pod:7328 ../fish/guestfish-actions.pod:4890
18454 msgid "This command returns the UUID of the LVM VG named C<vgname>."
18458 #: ../src/guestfs-actions.pod:7335
18459 msgid "guestfs_wait_ready"
18463 #: ../src/guestfs-actions.pod:7337
18467 " guestfs_wait_ready (guestfs_h *g);\n"
18472 #: ../src/guestfs-actions.pod:7340
18473 msgid "This function is a no op."
18477 #: ../src/guestfs-actions.pod:7342
18479 "In versions of the API E<lt> 1.0.71 you had to call this function just after "
18480 "calling C<guestfs_launch> to wait for the launch to complete. However this "
18481 "is no longer necessary because C<guestfs_launch> now does the waiting."
18485 #: ../src/guestfs-actions.pod:7347
18487 "If you see any calls to this function in code then you can just remove them, "
18488 "unless you want to retain compatibility with older versions of the API."
18492 #: ../src/guestfs-actions.pod:7353
18494 "This function is deprecated. In new code, use the C<launch> call instead."
18498 #: ../src/guestfs-actions.pod:7362
18499 msgid "guestfs_wc_c"
18503 #: ../src/guestfs-actions.pod:7364
18507 " guestfs_wc_c (guestfs_h *g,\n"
18508 " const char *path);\n"
18513 #: ../src/guestfs-actions.pod:7368 ../fish/guestfish-actions.pod:4896
18515 "This command counts the characters in a file, using the C<wc -c> external "
18520 #: ../src/guestfs-actions.pod:7375
18521 msgid "guestfs_wc_l"
18525 #: ../src/guestfs-actions.pod:7377
18529 " guestfs_wc_l (guestfs_h *g,\n"
18530 " const char *path);\n"
18535 #: ../src/guestfs-actions.pod:7381 ../fish/guestfish-actions.pod:4903
18537 "This command counts the lines in a file, using the C<wc -l> external command."
18541 #: ../src/guestfs-actions.pod:7388
18542 msgid "guestfs_wc_w"
18546 #: ../src/guestfs-actions.pod:7390
18550 " guestfs_wc_w (guestfs_h *g,\n"
18551 " const char *path);\n"
18556 #: ../src/guestfs-actions.pod:7394 ../fish/guestfish-actions.pod:4910
18558 "This command counts the words in a file, using the C<wc -w> external command."
18562 #: ../src/guestfs-actions.pod:7401
18563 msgid "guestfs_write"
18567 #: ../src/guestfs-actions.pod:7403
18571 " guestfs_write (guestfs_h *g,\n"
18572 " const char *path,\n"
18573 " const char *content,\n"
18574 " size_t content_size);\n"
18579 #: ../src/guestfs-actions.pod:7409 ../fish/guestfish-actions.pod:4917
18581 "This call creates a file called C<path>. The content of the file is the "
18582 "string C<content> (which can contain any 8 bit data)."
18586 #: ../src/guestfs-actions.pod:7419
18587 msgid "guestfs_write_file"
18591 #: ../src/guestfs-actions.pod:7421
18595 " guestfs_write_file (guestfs_h *g,\n"
18596 " const char *path,\n"
18597 " const char *content,\n"
18603 #: ../src/guestfs-actions.pod:7427 ../fish/guestfish-actions.pod:4927
18605 "This call creates a file called C<path>. The contents of the file is the "
18606 "string C<content> (which can contain any 8 bit data), with length C<size>."
18610 #: ../src/guestfs-actions.pod:7431 ../fish/guestfish-actions.pod:4931
18612 "As a special case, if C<size> is C<0> then the length is calculated using "
18613 "C<strlen> (so in this case the content cannot contain embedded ASCII NULs)."
18617 #: ../src/guestfs-actions.pod:7435 ../fish/guestfish-actions.pod:4935
18619 "I<NB.> Owing to a bug, writing content containing ASCII NUL characters does "
18620 "I<not> work, even if the length is specified."
18624 #: ../src/guestfs-actions.pod:7443 ../fish/guestfish-actions.pod:4941
18626 "This function is deprecated. In new code, use the C<write> call instead."
18630 #: ../src/guestfs-actions.pod:7452
18631 msgid "guestfs_zegrep"
18635 #: ../src/guestfs-actions.pod:7454
18639 " guestfs_zegrep (guestfs_h *g,\n"
18640 " const char *regex,\n"
18641 " const char *path);\n"
18646 #: ../src/guestfs-actions.pod:7459 ../fish/guestfish-actions.pod:4952
18648 "This calls the external C<zegrep> program and returns the matching lines."
18652 #: ../src/guestfs-actions.pod:7471
18653 msgid "guestfs_zegrepi"
18657 #: ../src/guestfs-actions.pod:7473
18661 " guestfs_zegrepi (guestfs_h *g,\n"
18662 " const char *regex,\n"
18663 " const char *path);\n"
18668 #: ../src/guestfs-actions.pod:7478 ../fish/guestfish-actions.pod:4962
18670 "This calls the external C<zegrep -i> program and returns the matching lines."
18674 #: ../src/guestfs-actions.pod:7490
18675 msgid "guestfs_zero"
18679 #: ../src/guestfs-actions.pod:7492
18683 " guestfs_zero (guestfs_h *g,\n"
18684 " const char *device);\n"
18689 #: ../src/guestfs-actions.pod:7496 ../fish/guestfish-actions.pod:4972
18690 msgid "This command writes zeroes over the first few blocks of C<device>."
18694 #: ../src/guestfs-actions.pod:7498 ../fish/guestfish-actions.pod:4974
18696 "How many blocks are zeroed isn't specified (but it's I<not> enough to "
18697 "securely wipe the device). It should be sufficient to remove any partition "
18698 "tables, filesystem superblocks and so on."
18702 #: ../src/guestfs-actions.pod:7502
18704 "See also: C<guestfs_zero_device>, C<guestfs_scrub_device>, "
18705 "C<guestfs_is_zero_device>"
18709 #: ../src/guestfs-actions.pod:7514
18710 msgid "guestfs_zero_device"
18714 #: ../src/guestfs-actions.pod:7516
18718 " guestfs_zero_device (guestfs_h *g,\n"
18719 " const char *device);\n"
18724 #: ../src/guestfs-actions.pod:7520
18726 "This command writes zeroes over the entire C<device>. Compare with "
18727 "C<guestfs_zero> which just zeroes the first few blocks of a device."
18731 #: ../src/guestfs-actions.pod:7534
18732 msgid "(Added in 1.3.1)"
18736 #: ../src/guestfs-actions.pod:7536
18737 msgid "guestfs_zerofree"
18741 #: ../src/guestfs-actions.pod:7538
18745 " guestfs_zerofree (guestfs_h *g,\n"
18746 " const char *device);\n"
18751 #: ../src/guestfs-actions.pod:7542 ../fish/guestfish-actions.pod:4996
18753 "This runs the I<zerofree> program on C<device>. This program claims to zero "
18754 "unused inodes and disk blocks on an ext2/3 filesystem, thus making it "
18755 "possible to compress the filesystem more effectively."
18759 #: ../src/guestfs-actions.pod:7547 ../fish/guestfish-actions.pod:5001
18760 msgid "You should B<not> run this program if the filesystem is mounted."
18764 #: ../src/guestfs-actions.pod:7550 ../fish/guestfish-actions.pod:5004
18766 "It is possible that using this program can damage the filesystem or data on "
18771 #: ../src/guestfs-actions.pod:7557
18772 msgid "guestfs_zfgrep"
18776 #: ../src/guestfs-actions.pod:7559
18780 " guestfs_zfgrep (guestfs_h *g,\n"
18781 " const char *pattern,\n"
18782 " const char *path);\n"
18787 #: ../src/guestfs-actions.pod:7564 ../fish/guestfish-actions.pod:5011
18789 "This calls the external C<zfgrep> program and returns the matching lines."
18793 #: ../src/guestfs-actions.pod:7576
18794 msgid "guestfs_zfgrepi"
18798 #: ../src/guestfs-actions.pod:7578
18802 " guestfs_zfgrepi (guestfs_h *g,\n"
18803 " const char *pattern,\n"
18804 " const char *path);\n"
18809 #: ../src/guestfs-actions.pod:7583 ../fish/guestfish-actions.pod:5021
18811 "This calls the external C<zfgrep -i> program and returns the matching lines."
18815 #: ../src/guestfs-actions.pod:7595
18816 msgid "guestfs_zfile"
18820 #: ../src/guestfs-actions.pod:7597
18824 " guestfs_zfile (guestfs_h *g,\n"
18825 " const char *meth,\n"
18826 " const char *path);\n"
18831 #: ../src/guestfs-actions.pod:7602 ../fish/guestfish-actions.pod:5031
18833 "This command runs C<file> after first decompressing C<path> using C<method>."
18837 #: ../src/guestfs-actions.pod:7605 ../fish/guestfish-actions.pod:5034
18838 msgid "C<method> must be one of C<gzip>, C<compress> or C<bzip2>."
18842 #: ../src/guestfs-actions.pod:7607
18844 "Since 1.0.63, use C<guestfs_file> instead which can now process compressed "
18849 #: ../src/guestfs-actions.pod:7613 ../fish/guestfish-actions.pod:5039
18851 "This function is deprecated. In new code, use the C<file> call instead."
18855 #: ../src/guestfs-actions.pod:7622
18856 msgid "guestfs_zgrep"
18860 #: ../src/guestfs-actions.pod:7624
18864 " guestfs_zgrep (guestfs_h *g,\n"
18865 " const char *regex,\n"
18866 " const char *path);\n"
18871 #: ../src/guestfs-actions.pod:7629 ../fish/guestfish-actions.pod:5050
18873 "This calls the external C<zgrep> program and returns the matching lines."
18877 #: ../src/guestfs-actions.pod:7641
18878 msgid "guestfs_zgrepi"
18882 #: ../src/guestfs-actions.pod:7643
18886 " guestfs_zgrepi (guestfs_h *g,\n"
18887 " const char *regex,\n"
18888 " const char *path);\n"
18893 #: ../src/guestfs-actions.pod:7648 ../fish/guestfish-actions.pod:5060
18895 "This calls the external C<zgrep -i> program and returns the matching lines."
18899 #: ../src/guestfs-availability.pod:3
18904 #: ../src/guestfs-availability.pod:5
18906 "The following functions: L</guestfs_aug_clear> L</guestfs_aug_close> L</"
18907 "guestfs_aug_defnode> L</guestfs_aug_defvar> L</guestfs_aug_get> L</"
18908 "guestfs_aug_init> L</guestfs_aug_insert> L</guestfs_aug_load> L</"
18909 "guestfs_aug_ls> L</guestfs_aug_match> L</guestfs_aug_mv> L</guestfs_aug_rm> "
18910 "L</guestfs_aug_save> L</guestfs_aug_set>"
18914 #: ../src/guestfs-availability.pod:21
18919 #: ../src/guestfs-availability.pod:23
18921 "The following functions: L</guestfs_inotify_add_watch> L</"
18922 "guestfs_inotify_close> L</guestfs_inotify_files> L</guestfs_inotify_init> L</"
18923 "guestfs_inotify_read> L</guestfs_inotify_rm_watch>"
18927 #: ../src/guestfs-availability.pod:31
18928 msgid "B<linuxfsuuid>"
18932 #: ../src/guestfs-availability.pod:33
18934 "The following functions: L</guestfs_mke2fs_JU> L</guestfs_mke2journal_U> L</"
18935 "guestfs_mkswap_U> L</guestfs_swapoff_uuid> L</guestfs_swapon_uuid>"
18939 #: ../src/guestfs-availability.pod:40
18940 msgid "B<linuxmodules>"
18944 #: ../src/guestfs-availability.pod:42
18945 msgid "The following functions: L</guestfs_modprobe>"
18949 #: ../src/guestfs-availability.pod:45
18950 msgid "B<linuxxattrs>"
18954 #: ../src/guestfs-availability.pod:47
18956 "The following functions: L</guestfs_getxattr> L</guestfs_getxattrs> L</"
18957 "guestfs_lgetxattr> L</guestfs_lgetxattrs> L</guestfs_lremovexattr> L</"
18958 "guestfs_lsetxattr> L</guestfs_lxattrlist> L</guestfs_removexattr> L</"
18959 "guestfs_setxattr>"
18963 #: ../src/guestfs-availability.pod:58
18968 #: ../src/guestfs-availability.pod:60
18970 "The following functions: L</guestfs_luks_add_key> L</guestfs_luks_close> L</"
18971 "guestfs_luks_format> L</guestfs_luks_format_cipher> L</"
18972 "guestfs_luks_kill_slot> L</guestfs_luks_open> L</guestfs_luks_open_ro>"
18976 #: ../src/guestfs-availability.pod:69
18981 #: ../src/guestfs-availability.pod:71
18983 "The following functions: L</guestfs_is_lv> L</guestfs_lvcreate> L</"
18984 "guestfs_lvm_remove_all> L</guestfs_lvm_set_filter> L</guestfs_lvremove> L</"
18985 "guestfs_lvresize> L</guestfs_lvresize_free> L</guestfs_lvs> L</"
18986 "guestfs_lvs_full> L</guestfs_pvcreate> L</guestfs_pvremove> L</"
18987 "guestfs_pvresize> L</guestfs_pvresize_size> L</guestfs_pvs> L</"
18988 "guestfs_pvs_full> L</guestfs_vg_activate> L</guestfs_vg_activate_all> L</"
18989 "guestfs_vgcreate> L</guestfs_vgremove> L</guestfs_vgs> L</guestfs_vgs_full>"
18993 #: ../src/guestfs-availability.pod:94
18998 #: ../src/guestfs-availability.pod:96
19000 "The following functions: L</guestfs_mkfifo> L</guestfs_mknod> L</"
19001 "guestfs_mknod_b> L</guestfs_mknod_c>"
19005 #: ../src/guestfs-availability.pod:102
19010 #: ../src/guestfs-availability.pod:104
19011 msgid "The following functions: L</guestfs_ntfs_3g_probe>"
19015 #: ../src/guestfs-availability.pod:107
19016 msgid "B<ntfsprogs>"
19020 #: ../src/guestfs-availability.pod:109
19022 "The following functions: L</guestfs_ntfsresize> L</guestfs_ntfsresize_size>"
19026 #: ../src/guestfs-availability.pod:113
19027 msgid "B<realpath>"
19031 #: ../src/guestfs-availability.pod:115
19032 msgid "The following functions: L</guestfs_realpath>"
19036 #: ../src/guestfs-availability.pod:118
19041 #: ../src/guestfs-availability.pod:120
19043 "The following functions: L</guestfs_scrub_device> L</guestfs_scrub_file> L</"
19044 "guestfs_scrub_freespace>"
19048 #: ../src/guestfs-availability.pod:125
19053 #: ../src/guestfs-availability.pod:127
19054 msgid "The following functions: L</guestfs_getcon> L</guestfs_setcon>"
19058 #: ../src/guestfs-availability.pod:131
19063 #: ../src/guestfs-availability.pod:133
19064 msgid "The following functions: L</guestfs_txz_in> L</guestfs_txz_out>"
19068 #: ../src/guestfs-availability.pod:137
19069 msgid "B<zerofree>"
19073 #: ../src/guestfs-availability.pod:139
19074 msgid "The following functions: L</guestfs_zerofree>"
19078 #: ../src/guestfs-structs.pod:1
19079 msgid "guestfs_int_bool"
19083 #: ../src/guestfs-structs.pod:3
19086 " struct guestfs_int_bool {\n"
19094 #: ../src/guestfs-structs.pod:8
19097 " struct guestfs_int_bool_list {\n"
19098 " uint32_t len; /* Number of elements in list. */\n"
19099 " struct guestfs_int_bool *val; /* Elements. */\n"
19105 #: ../src/guestfs-structs.pod:13
19108 " void guestfs_free_int_bool (struct guestfs_free_int_bool *);\n"
19109 " void guestfs_free_int_bool_list (struct guestfs_free_int_bool_list *);\n"
19114 #: ../src/guestfs-structs.pod:16
19115 msgid "guestfs_lvm_pv"
19119 #: ../src/guestfs-structs.pod:18
19122 " struct guestfs_lvm_pv {\n"
19123 " char *pv_name;\n"
19124 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
19125 " char pv_uuid[32];\n"
19127 " uint64_t pv_size;\n"
19128 " uint64_t dev_size;\n"
19129 " uint64_t pv_free;\n"
19130 " uint64_t pv_used;\n"
19131 " char *pv_attr;\n"
19132 " int64_t pv_pe_count;\n"
19133 " int64_t pv_pe_alloc_count;\n"
19134 " char *pv_tags;\n"
19135 " uint64_t pe_start;\n"
19136 " int64_t pv_mda_count;\n"
19137 " uint64_t pv_mda_free;\n"
19143 #: ../src/guestfs-structs.pod:36
19146 " struct guestfs_lvm_pv_list {\n"
19147 " uint32_t len; /* Number of elements in list. */\n"
19148 " struct guestfs_lvm_pv *val; /* Elements. */\n"
19154 #: ../src/guestfs-structs.pod:41
19157 " void guestfs_free_lvm_pv (struct guestfs_free_lvm_pv *);\n"
19158 " void guestfs_free_lvm_pv_list (struct guestfs_free_lvm_pv_list *);\n"
19163 #: ../src/guestfs-structs.pod:44
19164 msgid "guestfs_lvm_vg"
19168 #: ../src/guestfs-structs.pod:46
19171 " struct guestfs_lvm_vg {\n"
19172 " char *vg_name;\n"
19173 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
19174 " char vg_uuid[32];\n"
19176 " char *vg_attr;\n"
19177 " uint64_t vg_size;\n"
19178 " uint64_t vg_free;\n"
19179 " char *vg_sysid;\n"
19180 " uint64_t vg_extent_size;\n"
19181 " int64_t vg_extent_count;\n"
19182 " int64_t vg_free_count;\n"
19183 " int64_t max_lv;\n"
19184 " int64_t max_pv;\n"
19185 " int64_t pv_count;\n"
19186 " int64_t lv_count;\n"
19187 " int64_t snap_count;\n"
19188 " int64_t vg_seqno;\n"
19189 " char *vg_tags;\n"
19190 " int64_t vg_mda_count;\n"
19191 " uint64_t vg_mda_free;\n"
19197 #: ../src/guestfs-structs.pod:69
19200 " struct guestfs_lvm_vg_list {\n"
19201 " uint32_t len; /* Number of elements in list. */\n"
19202 " struct guestfs_lvm_vg *val; /* Elements. */\n"
19208 #: ../src/guestfs-structs.pod:74
19211 " void guestfs_free_lvm_vg (struct guestfs_free_lvm_vg *);\n"
19212 " void guestfs_free_lvm_vg_list (struct guestfs_free_lvm_vg_list *);\n"
19217 #: ../src/guestfs-structs.pod:77
19218 msgid "guestfs_lvm_lv"
19222 #: ../src/guestfs-structs.pod:79
19225 " struct guestfs_lvm_lv {\n"
19226 " char *lv_name;\n"
19227 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
19228 " char lv_uuid[32];\n"
19229 " char *lv_attr;\n"
19230 " int64_t lv_major;\n"
19231 " int64_t lv_minor;\n"
19232 " int64_t lv_kernel_major;\n"
19233 " int64_t lv_kernel_minor;\n"
19234 " uint64_t lv_size;\n"
19235 " int64_t seg_count;\n"
19237 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
19238 " float snap_percent;\n"
19239 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
19240 " float copy_percent;\n"
19241 " char *move_pv;\n"
19242 " char *lv_tags;\n"
19243 " char *mirror_log;\n"
19244 " char *modules;\n"
19250 #: ../src/guestfs-structs.pod:101
19253 " struct guestfs_lvm_lv_list {\n"
19254 " uint32_t len; /* Number of elements in list. */\n"
19255 " struct guestfs_lvm_lv *val; /* Elements. */\n"
19261 #: ../src/guestfs-structs.pod:106
19264 " void guestfs_free_lvm_lv (struct guestfs_free_lvm_lv *);\n"
19265 " void guestfs_free_lvm_lv_list (struct guestfs_free_lvm_lv_list *);\n"
19270 #: ../src/guestfs-structs.pod:111
19273 " struct guestfs_stat {\n"
19277 " int64_t nlink;\n"
19282 " int64_t blksize;\n"
19283 " int64_t blocks;\n"
19284 " int64_t atime;\n"
19285 " int64_t mtime;\n"
19286 " int64_t ctime;\n"
19292 #: ../src/guestfs-structs.pod:127
19295 " struct guestfs_stat_list {\n"
19296 " uint32_t len; /* Number of elements in list. */\n"
19297 " struct guestfs_stat *val; /* Elements. */\n"
19303 #: ../src/guestfs-structs.pod:132
19306 " void guestfs_free_stat (struct guestfs_free_stat *);\n"
19307 " void guestfs_free_stat_list (struct guestfs_free_stat_list *);\n"
19312 #: ../src/guestfs-structs.pod:137
19315 " struct guestfs_statvfs {\n"
19316 " int64_t bsize;\n"
19317 " int64_t frsize;\n"
19318 " int64_t blocks;\n"
19319 " int64_t bfree;\n"
19320 " int64_t bavail;\n"
19321 " int64_t files;\n"
19322 " int64_t ffree;\n"
19323 " int64_t favail;\n"
19326 " int64_t namemax;\n"
19332 #: ../src/guestfs-structs.pod:151
19335 " struct guestfs_statvfs_list {\n"
19336 " uint32_t len; /* Number of elements in list. */\n"
19337 " struct guestfs_statvfs *val; /* Elements. */\n"
19343 #: ../src/guestfs-structs.pod:156
19346 " void guestfs_free_statvfs (struct guestfs_free_statvfs *);\n"
19347 " void guestfs_free_statvfs_list (struct guestfs_free_statvfs_list *);\n"
19352 #: ../src/guestfs-structs.pod:159
19353 msgid "guestfs_dirent"
19357 #: ../src/guestfs-structs.pod:161
19360 " struct guestfs_dirent {\n"
19369 #: ../src/guestfs-structs.pod:167
19372 " struct guestfs_dirent_list {\n"
19373 " uint32_t len; /* Number of elements in list. */\n"
19374 " struct guestfs_dirent *val; /* Elements. */\n"
19380 #: ../src/guestfs-structs.pod:172
19383 " void guestfs_free_dirent (struct guestfs_free_dirent *);\n"
19384 " void guestfs_free_dirent_list (struct guestfs_free_dirent_list *);\n"
19389 #: ../src/guestfs-structs.pod:177
19392 " struct guestfs_version {\n"
19393 " int64_t major;\n"
19394 " int64_t minor;\n"
19395 " int64_t release;\n"
19402 #: ../src/guestfs-structs.pod:184
19405 " struct guestfs_version_list {\n"
19406 " uint32_t len; /* Number of elements in list. */\n"
19407 " struct guestfs_version *val; /* Elements. */\n"
19413 #: ../src/guestfs-structs.pod:189
19416 " void guestfs_free_version (struct guestfs_free_version *);\n"
19417 " void guestfs_free_version_list (struct guestfs_free_version_list *);\n"
19422 #: ../src/guestfs-structs.pod:192
19423 msgid "guestfs_xattr"
19427 #: ../src/guestfs-structs.pod:194
19430 " struct guestfs_xattr {\n"
19431 " char *attrname;\n"
19432 " /* The next two fields describe a byte array. */\n"
19433 " uint32_t attrval_len;\n"
19434 " char *attrval;\n"
19440 #: ../src/guestfs-structs.pod:201
19443 " struct guestfs_xattr_list {\n"
19444 " uint32_t len; /* Number of elements in list. */\n"
19445 " struct guestfs_xattr *val; /* Elements. */\n"
19451 #: ../src/guestfs-structs.pod:206
19454 " void guestfs_free_xattr (struct guestfs_free_xattr *);\n"
19455 " void guestfs_free_xattr_list (struct guestfs_free_xattr_list *);\n"
19460 #: ../src/guestfs-structs.pod:209
19461 msgid "guestfs_inotify_event"
19465 #: ../src/guestfs-structs.pod:211
19468 " struct guestfs_inotify_event {\n"
19469 " int64_t in_wd;\n"
19470 " uint32_t in_mask;\n"
19471 " uint32_t in_cookie;\n"
19472 " char *in_name;\n"
19478 #: ../src/guestfs-structs.pod:218
19481 " struct guestfs_inotify_event_list {\n"
19482 " uint32_t len; /* Number of elements in list. */\n"
19483 " struct guestfs_inotify_event *val; /* Elements. */\n"
19489 #: ../src/guestfs-structs.pod:223
19492 " void guestfs_free_inotify_event (struct guestfs_free_inotify_event *);\n"
19493 " void guestfs_free_inotify_event_list (struct guestfs_free_inotify_event_list *);\n"
19498 #: ../src/guestfs-structs.pod:226
19499 msgid "guestfs_partition"
19503 #: ../src/guestfs-structs.pod:228
19506 " struct guestfs_partition {\n"
19507 " int32_t part_num;\n"
19508 " uint64_t part_start;\n"
19509 " uint64_t part_end;\n"
19510 " uint64_t part_size;\n"
19516 #: ../src/guestfs-structs.pod:235
19519 " struct guestfs_partition_list {\n"
19520 " uint32_t len; /* Number of elements in list. */\n"
19521 " struct guestfs_partition *val; /* Elements. */\n"
19527 #: ../src/guestfs-structs.pod:240
19530 " void guestfs_free_partition (struct guestfs_free_partition *);\n"
19531 " void guestfs_free_partition_list (struct guestfs_free_partition_list *);\n"
19536 #: ../src/guestfs-structs.pod:243
19537 msgid "guestfs_application"
19541 #: ../src/guestfs-structs.pod:245
19544 " struct guestfs_application {\n"
19545 " char *app_name;\n"
19546 " char *app_display_name;\n"
19547 " int32_t app_epoch;\n"
19548 " char *app_version;\n"
19549 " char *app_release;\n"
19550 " char *app_install_path;\n"
19551 " char *app_trans_path;\n"
19552 " char *app_publisher;\n"
19553 " char *app_url;\n"
19554 " char *app_source_package;\n"
19555 " char *app_summary;\n"
19556 " char *app_description;\n"
19562 #: ../src/guestfs-structs.pod:260
19565 " struct guestfs_application_list {\n"
19566 " uint32_t len; /* Number of elements in list. */\n"
19567 " struct guestfs_application *val; /* Elements. */\n"
19573 #: ../src/guestfs-structs.pod:265
19576 " void guestfs_free_application (struct guestfs_free_application *);\n"
19577 " void guestfs_free_application_list (struct guestfs_free_application_list *);\n"
19582 #: ../fish/guestfish.pod:5
19583 msgid "guestfish - the libguestfs Filesystem Interactive SHell"
19587 #: ../fish/guestfish.pod:9
19590 " guestfish [--options] [commands]\n"
19595 #: ../fish/guestfish.pod:11
19603 #: ../fish/guestfish.pod:13
19606 " guestfish [--ro|--rw] -a disk.img\n"
19611 #: ../fish/guestfish.pod:15
19614 " guestfish [--ro|--rw] -a disk.img -m dev[:mountpoint]\n"
19619 #: ../fish/guestfish.pod:17
19622 " guestfish -d libvirt-domain\n"
19627 #: ../fish/guestfish.pod:19
19630 " guestfish [--ro|--rw] -a disk.img -i\n"
19635 #: ../fish/guestfish.pod:21
19638 " guestfish -d libvirt-domain -i\n"
19643 #: ../fish/guestfish.pod:23 ../fuse/guestmount.pod:15
19644 #: ../tools/virt-win-reg.pl:51 ../tools/virt-tar.pl:64
19649 #: ../fish/guestfish.pod:25
19651 "Using guestfish in read/write mode on live virtual machines can be "
19652 "dangerous, potentially causing disk corruption. Use the I<--ro> (read-only) "
19653 "option to use guestfish safely if the disk image or virtual machine might be "
19658 #: ../fish/guestfish.pod:32
19660 "Guestfish is a shell and command-line tool for examining and modifying "
19661 "virtual machine filesystems. It uses libguestfs and exposes all of the "
19662 "functionality of the guestfs API, see L<guestfs(3)>."
19666 #: ../fish/guestfish.pod:36
19668 "Guestfish gives you structured access to the libguestfs API, from shell "
19669 "scripts or the command line or interactively. If you want to rescue a "
19670 "broken virtual machine image, you should look at the L<virt-rescue(1)> "
19675 #: ../fish/guestfish.pod:41 ../fish/guestfish.pod:949
19676 #: ../fuse/guestmount.pod:39 ../tools/virt-tar.pl:50
19681 #: ../fish/guestfish.pod:43
19682 msgid "As an interactive shell"
19686 #: ../fish/guestfish.pod:45
19694 #: ../fish/guestfish.pod:47
19697 " Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
19698 " editing virtual machine filesystems.\n"
19703 #: ../fish/guestfish.pod:50
19706 " Type: 'help' for a list of commands\n"
19707 " 'man' to read the manual\n"
19708 " 'quit' to quit the shell\n"
19713 #: ../fish/guestfish.pod:54
19716 " ><fs> add-ro disk.img\n"
19718 " ><fs> list-filesystems\n"
19719 " /dev/sda1: ext4\n"
19720 " /dev/vg_guest/lv_root: ext4\n"
19721 " /dev/vg_guest/lv_swap: swap\n"
19722 " ><fs> mount /dev/vg_guest/lv_root /\n"
19723 " ><fs> cat /etc/fstab\n"
19725 " # Created by anaconda\n"
19732 #: ../fish/guestfish.pod:67
19733 msgid "From shell scripts"
19737 #: ../fish/guestfish.pod:69
19738 msgid "Create a new C</etc/motd> file in a guest or disk image:"
19742 #: ../fish/guestfish.pod:71
19745 " guestfish <<_EOF_\n"
19748 " mount /dev/vg_guest/lv_root /\n"
19749 " write /etc/motd \"Welcome, new users\"\n"
19755 #: ../fish/guestfish.pod:78
19756 msgid "List the LVM logical volumes in a disk image:"
19760 #: ../fish/guestfish.pod:80
19763 " guestfish -a disk.img --ro <<_EOF_\n"
19771 #: ../fish/guestfish.pod:85
19772 msgid "List all the filesystems in a disk image:"
19776 #: ../fish/guestfish.pod:87
19779 " guestfish -a disk.img --ro <<_EOF_\n"
19781 " list-filesystems\n"
19787 #: ../fish/guestfish.pod:92
19788 msgid "On one command line"
19792 #: ../fish/guestfish.pod:94
19793 msgid "Update C</etc/resolv.conf> in a guest:"
19797 #: ../fish/guestfish.pod:96
19801 " add disk.img : run : mount /dev/vg_guest/lv_root / : \\\n"
19802 " write /etc/resolv.conf \"nameserver 1.2.3.4\"\n"
19807 #: ../fish/guestfish.pod:100
19808 msgid "Edit C</boot/grub/grub.conf> interactively:"
19812 #: ../fish/guestfish.pod:102
19815 " guestfish --rw --add disk.img \\\n"
19816 " --mount /dev/vg_guest/lv_root \\\n"
19817 " --mount /dev/sda1:/boot \\\n"
19818 " edit /boot/grub/grub.conf\n"
19823 #: ../fish/guestfish.pod:107
19824 msgid "Mount disks automatically"
19828 #: ../fish/guestfish.pod:109
19830 "Use the I<-i> option to automatically mount the disks from a virtual machine:"
19834 #: ../fish/guestfish.pod:112
19837 " guestfish --ro -a disk.img -i cat /etc/group\n"
19842 #: ../fish/guestfish.pod:114
19845 " guestfish --ro -d libvirt-domain -i cat /etc/group\n"
19850 #: ../fish/guestfish.pod:116
19851 msgid "Another way to edit C</boot/grub/grub.conf> interactively is:"
19855 #: ../fish/guestfish.pod:118
19858 " guestfish --rw -a disk.img -i edit /boot/grub/grub.conf\n"
19863 #: ../fish/guestfish.pod:120
19864 msgid "As a script interpreter"
19868 #: ../fish/guestfish.pod:122
19869 msgid "Create a 100MB disk containing an ext2-formatted partition:"
19873 #: ../fish/guestfish.pod:124
19876 " #!/usr/bin/guestfish -f\n"
19877 " sparse test1.img 100M\n"
19879 " part-disk /dev/sda mbr\n"
19880 " mkfs ext2 /dev/sda1\n"
19885 #: ../fish/guestfish.pod:130
19886 msgid "Start with a prepared disk"
19890 #: ../fish/guestfish.pod:132
19892 "An alternate way to create a 100MB disk called C<test1.img> containing a "
19893 "single ext2-formatted partition:"
19897 #: ../fish/guestfish.pod:135
19900 " guestfish -N fs\n"
19905 #: ../fish/guestfish.pod:137
19906 msgid "To list what is available do:"
19910 #: ../fish/guestfish.pod:139 ../fish/guestfish.pod:940
19913 " guestfish -N help | less\n"
19918 #: ../fish/guestfish.pod:141
19919 msgid "Remote control"
19923 #: ../fish/guestfish.pod:143
19926 " eval \"`guestfish --listen`\"\n"
19927 " guestfish --remote add-ro disk.img\n"
19928 " guestfish --remote run\n"
19929 " guestfish --remote lvs\n"
19934 #: ../fish/guestfish.pod:148 ../test-tool/libguestfs-test-tool.pod:37
19935 #: ../fuse/guestmount.pod:83 ../tools/virt-win-reg.pl:96
19936 #: ../tools/virt-list-filesystems.pl:53 ../tools/virt-tar.pl:103
19937 #: ../tools/virt-make-fs.pl:153 ../tools/virt-list-partitions.pl:54
19942 #: ../fish/guestfish.pod:152 ../fuse/guestmount.pod:143
19943 #: ../tools/virt-win-reg.pl:104 ../tools/virt-list-filesystems.pl:61
19944 #: ../tools/virt-tar.pl:111 ../tools/virt-make-fs.pl:161
19945 #: ../tools/virt-list-partitions.pl:62
19950 #: ../fish/guestfish.pod:154
19951 msgid "Displays general help on options."
19955 #: ../fish/guestfish.pod:156
19960 #: ../fish/guestfish.pod:158
19961 msgid "B<--cmd-help>"
19965 #: ../fish/guestfish.pod:160
19966 msgid "Lists all available guestfish commands."
19970 #: ../fish/guestfish.pod:162
19975 #: ../fish/guestfish.pod:164
19976 msgid "B<--cmd-help cmd>"
19980 #: ../fish/guestfish.pod:166
19981 msgid "Displays detailed help on a single command C<cmd>."
19985 #: ../fish/guestfish.pod:168
19986 msgid "B<-a image>"
19990 #: ../fish/guestfish.pod:170
19991 msgid "B<--add image>"
19995 #: ../fish/guestfish.pod:172
19996 msgid "Add a block device or virtual machine image to the shell."
20000 #: ../fish/guestfish.pod:174 ../fuse/guestmount.pod:91
20002 "The format of the disk image is auto-detected. To override this and force a "
20003 "particular format use the I<--format=..> option."
20007 #: ../fish/guestfish.pod:177
20009 "Using this flag is mostly equivalent to using the C<add> command, with "
20010 "C<readonly:true> if the I<--ro> flag was given, and with C<format:...> if "
20011 "the I<--format=...> flag was given."
20015 #: ../fish/guestfish.pod:181
20020 #: ../fish/guestfish.pod:183
20021 msgid "B<--connect URI>"
20025 #: ../fish/guestfish.pod:185 ../fuse/guestmount.pod:96
20027 "When used in conjunction with the I<-d> option, this specifies the libvirt "
20028 "URI to use. The default is to use the default libvirt connection."
20032 #: ../fish/guestfish.pod:189
20037 #: ../fish/guestfish.pod:191
20039 "If using the I<--listen> option and a csh-like shell, use this option. See "
20040 "section L</REMOTE CONTROL AND CSH> below."
20044 #: ../fish/guestfish.pod:194
20045 msgid "B<-d libvirt-domain>"
20049 #: ../fish/guestfish.pod:196
20050 msgid "B<--domain libvirt-domain>"
20054 #: ../fish/guestfish.pod:198 ../fuse/guestmount.pod:102
20056 "Add disks from the named libvirt domain. If the I<--ro> option is also "
20057 "used, then any libvirt domain can be used. However in write mode, only "
20058 "libvirt domains which are shut down can be named here."
20062 #: ../fish/guestfish.pod:202 ../fuse/guestmount.pod:106
20063 msgid "Domain UUIDs can be used instead of names."
20067 #: ../fish/guestfish.pod:204
20069 "Using this flag is mostly equivalent to using the C<add-domain> command, "
20070 "with C<readonly:true> if the I<--ro> flag was given, and with C<format:...> "
20071 "if the I<--format:...> flag was given."
20075 #: ../fish/guestfish.pod:208
20080 #: ../fish/guestfish.pod:210
20081 msgid "B<--no-dest-paths>"
20085 #: ../fish/guestfish.pod:212
20087 "Don't tab-complete paths on the guest filesystem. It is useful to be able "
20088 "to hit the tab key to complete paths on the guest filesystem, but this "
20089 "causes extra \"hidden\" guestfs calls to be made, so this option is here to "
20090 "allow this feature to be disabled."
20094 #: ../fish/guestfish.pod:217 ../fuse/guestmount.pod:120
20095 msgid "B<--echo-keys>"
20099 #: ../fish/guestfish.pod:219 ../fuse/guestmount.pod:122
20101 "When prompting for keys and passphrases, guestfish normally turns echoing "
20102 "off so you cannot see what you are typing. If you are not worried about "
20103 "Tempest attacks and there is no one else in the room you can specify this "
20104 "flag to see what you are typing."
20108 #: ../fish/guestfish.pod:224
20113 #: ../fish/guestfish.pod:226
20114 msgid "B<--file file>"
20118 #: ../fish/guestfish.pod:228
20119 msgid "Read commands from C<file>. To write pure guestfish scripts, use:"
20123 #: ../fish/guestfish.pod:231
20126 " #!/usr/bin/guestfish -f\n"
20131 #: ../fish/guestfish.pod:233
20132 msgid "B<--format=raw|qcow2|..>"
20136 #: ../fish/guestfish.pod:235
20137 msgid "B<--format>"
20141 #: ../fish/guestfish.pod:237 ../fuse/guestmount.pod:129
20143 "The default for the I<-a> option is to auto-detect the format of the disk "
20144 "image. Using this forces the disk format for I<-a> options which follow on "
20145 "the command line. Using I<--format> with no argument switches back to auto-"
20146 "detection for subsequent I<-a> options."
20150 #: ../fish/guestfish.pod:244
20153 " guestfish --format=raw -a disk.img\n"
20158 #: ../fish/guestfish.pod:246
20159 msgid "forces raw format (no auto-detection) for C<disk.img>."
20163 #: ../fish/guestfish.pod:248
20166 " guestfish --format=raw -a disk.img --format -a another.img\n"
20171 #: ../fish/guestfish.pod:250
20173 "forces raw format (no auto-detection) for C<disk.img> and reverts to auto-"
20174 "detection for C<another.img>."
20178 #: ../fish/guestfish.pod:253
20180 "If you have untrusted raw-format guest disk images, you should use this "
20181 "option to specify the disk format. This avoids a possible security problem "
20182 "with malicious guests (CVE-2010-3851). See also L</add-drive-opts>."
20186 #: ../fish/guestfish.pod:258
20191 #: ../fish/guestfish.pod:260
20192 msgid "B<--inspector>"
20196 #: ../fish/guestfish.pod:262 ../fuse/guestmount.pod:149
20198 "Using L<virt-inspector(1)> code, inspect the disks looking for an operating "
20199 "system and mount filesystems as they would be mounted on the real virtual "
20204 #: ../fish/guestfish.pod:266
20205 msgid "Typical usage is either:"
20209 #: ../fish/guestfish.pod:268
20212 " guestfish -d myguest -i\n"
20217 #: ../fish/guestfish.pod:270
20218 msgid "(for an inactive libvirt domain called I<myguest>), or:"
20222 #: ../fish/guestfish.pod:272
20225 " guestfish --ro -d myguest -i\n"
20230 #: ../fish/guestfish.pod:274
20231 msgid "(for active domains, readonly), or specify the block device directly:"
20235 #: ../fish/guestfish.pod:276
20238 " guestfish --rw -a /dev/Guests/MyGuest -i\n"
20243 #: ../fish/guestfish.pod:278
20245 "Note that the command line syntax changed slightly over older versions of "
20246 "guestfish. You can still use the old syntax:"
20250 #: ../fish/guestfish.pod:281
20253 " guestfish [--ro] -i disk.img\n"
20258 #: ../fish/guestfish.pod:283
20261 " guestfish [--ro] -i libvirt-domain\n"
20266 #: ../fish/guestfish.pod:285
20268 "Using this flag is mostly equivalent to using the C<inspect-os> command and "
20269 "then using other commands to mount the filesystems that were found."
20273 #: ../fish/guestfish.pod:289 ../fuse/guestmount.pod:153
20274 msgid "B<--keys-from-stdin>"
20278 #: ../fish/guestfish.pod:291 ../fuse/guestmount.pod:155
20280 "Read key or passphrase parameters from stdin. The default is to try to read "
20281 "passphrases from the user by opening C</dev/tty>."
20285 #: ../fish/guestfish.pod:294
20286 msgid "B<--listen>"
20290 #: ../fish/guestfish.pod:296
20292 "Fork into the background and listen for remote commands. See section L</"
20293 "REMOTE CONTROL GUESTFISH OVER A SOCKET> below."
20297 #: ../fish/guestfish.pod:299 ../fuse/guestmount.pod:158
20302 #: ../fish/guestfish.pod:301 ../fuse/guestmount.pod:160
20304 "Connect to a live virtual machine. (Experimental, see L<guestfs(3)/"
20305 "ATTACHING TO RUNNING DAEMONS>)."
20309 #: ../fish/guestfish.pod:304 ../fuse/guestmount.pod:163
20310 msgid "B<-m dev[:mountpoint[:options]]>"
20314 #: ../fish/guestfish.pod:306 ../fuse/guestmount.pod:165
20315 msgid "B<--mount dev[:mountpoint[:options]]>"
20319 #: ../fish/guestfish.pod:308
20320 msgid "Mount the named partition or logical volume on the given mountpoint."
20324 #: ../fish/guestfish.pod:310
20325 msgid "If the mountpoint is omitted, it defaults to C</>."
20329 #: ../fish/guestfish.pod:312
20330 msgid "You have to mount something on C</> before most commands will work."
20334 #: ../fish/guestfish.pod:314
20336 "If any I<-m> or I<--mount> options are given, the guest is automatically "
20341 #: ../fish/guestfish.pod:317
20343 "If you don't know what filesystems a disk image contains, you can either run "
20344 "guestfish without this option, then list the partitions, filesystems and LVs "
20345 "available (see L</list-partitions>, L</list-filesystems> and L</lvs> "
20346 "commands), or you can use the L<virt-filesystems(1)> program."
20350 #: ../fish/guestfish.pod:323 ../fuse/guestmount.pod:173
20352 "The third (and rarely used) part of the mount parameter is the list of mount "
20353 "options used to mount the underlying filesystem. If this is not given, then "
20354 "the mount options are either the empty string or C<ro> (the latter if the "
20355 "I<--ro> flag is used). By specifying the mount options, you override this "
20356 "default choice. Probably the only time you would use this is to enable ACLs "
20357 "and/or extended attributes if the filesystem can support them:"
20361 #: ../fish/guestfish.pod:331 ../fuse/guestmount.pod:181
20364 " -m /dev/sda1:/:acl,user_xattr\n"
20369 #: ../fish/guestfish.pod:333
20370 msgid "Using this flag is equivalent to using the C<mount-options> command."
20374 #: ../fish/guestfish.pod:335
20379 #: ../fish/guestfish.pod:337
20380 msgid "B<--no-sync>"
20384 #: ../fish/guestfish.pod:339
20386 "Disable autosync. This is enabled by default. See the discussion of "
20387 "autosync in the L<guestfs(3)> manpage."
20391 #: ../fish/guestfish.pod:342
20396 #: ../fish/guestfish.pod:344
20397 msgid "B<--new type>"
20401 #: ../fish/guestfish.pod:346
20406 #: ../fish/guestfish.pod:348
20408 "Prepare a fresh disk image formatted as \"type\". This is an alternative to "
20409 "the I<-a> option: whereas I<-a> adds an existing disk, I<-N> creates a "
20410 "preformatted disk with a filesystem and adds it. See L</PREPARED DISK "
20415 #: ../fish/guestfish.pod:353
20416 msgid "B<--progress-bars>"
20420 #: ../fish/guestfish.pod:355
20421 msgid "Enable progress bars, even when guestfish is used non-interactively."
20425 #: ../fish/guestfish.pod:357
20427 "Progress bars are enabled by default when guestfish is used as an "
20428 "interactive shell."
20432 #: ../fish/guestfish.pod:360
20433 msgid "B<--no-progress-bars>"
20437 #: ../fish/guestfish.pod:362
20438 msgid "Disable progress bars."
20442 #: ../fish/guestfish.pod:364
20443 msgid "B<--remote[=pid]>"
20447 #: ../fish/guestfish.pod:366
20449 "Send remote commands to C<$GUESTFISH_PID> or C<pid>. See section L</REMOTE "
20450 "CONTROL GUESTFISH OVER A SOCKET> below."
20454 #: ../fish/guestfish.pod:369
20459 #: ../fish/guestfish.pod:371
20464 #: ../fish/guestfish.pod:373
20466 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
20467 "mounts are done read-only."
20471 #: ../fish/guestfish.pod:376
20473 "The option must always be used if the disk image or virtual machine might be "
20474 "running, and is generally recommended in cases where you don't need write "
20475 "access to the disk."
20479 #: ../fish/guestfish.pod:380
20481 "Note that prepared disk images created with I<-N> are not affected by this "
20482 "option. Also commands like C<add> are not affected - you have to specify "
20483 "the C<readonly:true> option explicitly if you need it."
20487 #: ../fish/guestfish.pod:384
20488 msgid "See also L</OPENING DISKS FOR READ AND WRITE> below."
20492 #: ../fish/guestfish.pod:386 ../fuse/guestmount.pod:237
20493 msgid "B<--selinux>"
20497 #: ../fish/guestfish.pod:388
20498 msgid "Enable SELinux support for the guest. See L<guestfs(3)/SELINUX>."
20502 #: ../fish/guestfish.pod:390
20507 #: ../fish/guestfish.pod:392
20508 msgid "B<--verbose>"
20512 #: ../fish/guestfish.pod:394
20514 "Enable very verbose messages. This is particularly useful if you find a bug."
20518 #: ../fish/guestfish.pod:397
20523 #: ../fish/guestfish.pod:399 ../tools/virt-win-reg.pl:112
20524 #: ../tools/virt-list-filesystems.pl:69 ../tools/virt-tar.pl:119
20525 #: ../tools/virt-make-fs.pl:169 ../tools/virt-list-partitions.pl:70
20526 msgid "B<--version>"
20530 #: ../fish/guestfish.pod:401
20531 msgid "Display the guestfish / libguestfs version number and exit."
20535 #: ../fish/guestfish.pod:403
20540 #: ../fish/guestfish.pod:405
20545 #: ../fish/guestfish.pod:407 ../fuse/guestmount.pod:251
20547 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
20548 "mounts are done read-write."
20552 #: ../fish/guestfish.pod:410
20553 msgid "See L</OPENING DISKS FOR READ AND WRITE> below."
20557 #: ../fish/guestfish.pod:412
20562 #: ../fish/guestfish.pod:414
20563 msgid "Echo each command before executing it."
20567 #: ../fish/guestfish.pod:418
20568 msgid "COMMANDS ON COMMAND LINE"
20572 #: ../fish/guestfish.pod:420
20574 "Any additional (non-option) arguments are treated as commands to execute."
20578 #: ../fish/guestfish.pod:423
20580 "Commands to execute should be separated by a colon (C<:>), where the colon "
20581 "is a separate parameter. Thus:"
20585 #: ../fish/guestfish.pod:426
20588 " guestfish cmd [args...] : cmd [args...] : cmd [args...] ...\n"
20593 #: ../fish/guestfish.pod:428
20595 "If there are no additional arguments, then we enter a shell, either an "
20596 "interactive shell with a prompt (if the input is a terminal) or a non-"
20597 "interactive shell."
20601 #: ../fish/guestfish.pod:432
20603 "In either command line mode or non-interactive shell, the first command that "
20604 "gives an error causes the whole shell to exit. In interactive mode (with a "
20605 "prompt) if a command fails, you can continue to enter commands."
20609 #: ../fish/guestfish.pod:437
20610 msgid "USING launch (OR run)"
20614 #: ../fish/guestfish.pod:439
20616 "As with L<guestfs(3)>, you must first configure your guest by adding disks, "
20617 "then launch it, then mount any disks you need, and finally issue actions/"
20618 "commands. So the general order of the day is:"
20622 #: ../fish/guestfish.pod:447
20623 msgid "add or -a/--add"
20627 #: ../fish/guestfish.pod:451
20628 msgid "launch (aka run)"
20632 #: ../fish/guestfish.pod:455
20633 msgid "mount or -m/--mount"
20637 #: ../fish/guestfish.pod:459
20638 msgid "any other commands"
20642 #: ../fish/guestfish.pod:463
20644 "C<run> is a synonym for C<launch>. You must C<launch> (or C<run>) your "
20645 "guest before mounting or performing any other commands."
20649 #: ../fish/guestfish.pod:466
20651 "The only exception is that if any of the I<-i>, I<-m>, I<--mount>, I<-N> or "
20652 "I<--new> options were given then C<run> is done automatically, simply "
20653 "because guestfish can't perform the action you asked for without doing this."
20657 #: ../fish/guestfish.pod:471
20658 msgid "OPENING DISKS FOR READ AND WRITE"
20662 #: ../fish/guestfish.pod:473
20664 "The guestfish, L<guestmount(1)> and L<virt-rescue(1)> options I<--ro> and "
20665 "I<--rw> affect whether the other command line options I<-a>, I<-c>, I<-d>, "
20666 "I<-i> and I<-m> open disk images read-only or for writing."
20670 #: ../fish/guestfish.pod:478
20672 "In libguestfs E<le> 1.10, guestfish, guestmount and virt-rescue defaulted to "
20673 "opening disk images supplied on the command line for write. To open a disk "
20674 "image read-only you have to do I<-a image --ro>."
20678 #: ../fish/guestfish.pod:482
20680 "This matters: If you accidentally open a live VM disk image writable then "
20681 "you will cause irreversible disk corruption."
20685 #: ../fish/guestfish.pod:485
20687 "By libguestfs 1.12 we intend to change the default the other way. Disk "
20688 "images will be opened read-only. You will have to either specify "
20689 "I<guestfish --rw>, I<guestmount --rw>, I<virt-rescue --rw>, or change the "
20690 "configuration file C</etc/libguestfs-tools.conf> in order to get write "
20691 "access for disk images specified by those other command line options."
20695 #: ../fish/guestfish.pod:492
20697 "This version of guestfish, guestmount and virt-rescue has a I<--rw> option "
20698 "which does nothing (it is already the default). However it is highly "
20699 "recommended that you use this option to indicate that you need write access, "
20700 "and prepare your scripts for the day when this option will be required for "
20705 #: ../fish/guestfish.pod:498
20707 "B<Note:> This does I<not> affect commands like L</add> and L</mount>, or any "
20708 "other libguestfs program apart from guestfish and guestmount."
20712 #: ../fish/guestfish.pod:501
20717 #: ../fish/guestfish.pod:503
20719 "You can quote ordinary parameters using either single or double quotes. For "
20724 #: ../fish/guestfish.pod:506
20727 " add \"file with a space.img\"\n"
20732 #: ../fish/guestfish.pod:508
20735 " rm '/file name'\n"
20740 #: ../fish/guestfish.pod:510
20748 #: ../fish/guestfish.pod:512
20750 "A few commands require a list of strings to be passed. For these, use a "
20751 "whitespace-separated list, enclosed in quotes. Strings containing "
20752 "whitespace to be passed through must be enclosed in single quotes. A "
20753 "literal single quote must be escaped with a backslash."
20757 #: ../fish/guestfish.pod:517
20760 " vgcreate VG \"/dev/sda1 /dev/sdb1\"\n"
20761 " command \"/bin/echo 'foo bar'\"\n"
20762 " command \"/bin/echo \\'foo\\'\"\n"
20767 #: ../fish/guestfish.pod:521
20768 msgid "OPTIONAL ARGUMENTS"
20772 #: ../fish/guestfish.pod:523
20774 "Some commands take optional arguments. These arguments appear in this "
20775 "documentation as C<[argname:..]>. You can use them as in these examples:"
20779 #: ../fish/guestfish.pod:527
20782 " add-drive-opts filename\n"
20787 #: ../fish/guestfish.pod:529
20790 " add-drive-opts filename readonly:true\n"
20795 #: ../fish/guestfish.pod:531
20798 " add-drive-opts filename format:qcow2 readonly:false\n"
20803 #: ../fish/guestfish.pod:533
20805 "Each optional argument can appear at most once. All optional arguments must "
20806 "appear after the required ones."
20810 #: ../fish/guestfish.pod:536
20815 #: ../fish/guestfish.pod:538
20817 "This section applies to all commands which can take integers as parameters."
20821 #: ../fish/guestfish.pod:541
20822 msgid "SIZE SUFFIX"
20826 #: ../fish/guestfish.pod:543
20828 "When the command takes a parameter measured in bytes, you can use one of the "
20829 "following suffixes to specify kilobytes, megabytes and larger sizes:"
20833 #: ../fish/guestfish.pod:549
20834 msgid "B<k> or B<K> or B<KiB>"
20838 #: ../fish/guestfish.pod:551
20839 msgid "The size in kilobytes (multiplied by 1024)."
20843 #: ../fish/guestfish.pod:553
20848 #: ../fish/guestfish.pod:555
20849 msgid "The size in SI 1000 byte units."
20853 #: ../fish/guestfish.pod:557
20854 msgid "B<M> or B<MiB>"
20858 #: ../fish/guestfish.pod:559
20859 msgid "The size in megabytes (multiplied by 1048576)."
20863 #: ../fish/guestfish.pod:561
20868 #: ../fish/guestfish.pod:563
20869 msgid "The size in SI 1000000 byte units."
20873 #: ../fish/guestfish.pod:565
20874 msgid "B<G> or B<GiB>"
20878 #: ../fish/guestfish.pod:567
20879 msgid "The size in gigabytes (multiplied by 2**30)."
20883 #: ../fish/guestfish.pod:569
20888 #: ../fish/guestfish.pod:571
20889 msgid "The size in SI 10**9 byte units."
20893 #: ../fish/guestfish.pod:573
20894 msgid "B<T> or B<TiB>"
20898 #: ../fish/guestfish.pod:575
20899 msgid "The size in terabytes (multiplied by 2**40)."
20903 #: ../fish/guestfish.pod:577
20908 #: ../fish/guestfish.pod:579
20909 msgid "The size in SI 10**12 byte units."
20913 #: ../fish/guestfish.pod:581
20914 msgid "B<P> or B<PiB>"
20918 #: ../fish/guestfish.pod:583
20919 msgid "The size in petabytes (multiplied by 2**50)."
20923 #: ../fish/guestfish.pod:585
20928 #: ../fish/guestfish.pod:587
20929 msgid "The size in SI 10**15 byte units."
20933 #: ../fish/guestfish.pod:589
20934 msgid "B<E> or B<EiB>"
20938 #: ../fish/guestfish.pod:591
20939 msgid "The size in exabytes (multiplied by 2**60)."
20943 #: ../fish/guestfish.pod:593
20948 #: ../fish/guestfish.pod:595
20949 msgid "The size in SI 10**18 byte units."
20953 #: ../fish/guestfish.pod:597
20954 msgid "B<Z> or B<ZiB>"
20958 #: ../fish/guestfish.pod:599
20959 msgid "The size in zettabytes (multiplied by 2**70)."
20963 #: ../fish/guestfish.pod:601
20968 #: ../fish/guestfish.pod:603
20969 msgid "The size in SI 10**21 byte units."
20973 #: ../fish/guestfish.pod:605
20974 msgid "B<Y> or B<YiB>"
20978 #: ../fish/guestfish.pod:607
20979 msgid "The size in yottabytes (multiplied by 2**80)."
20983 #: ../fish/guestfish.pod:609
20988 #: ../fish/guestfish.pod:611
20989 msgid "The size in SI 10**24 byte units."
20993 #: ../fish/guestfish.pod:617
20996 " truncate-size /file 1G\n"
21001 #: ../fish/guestfish.pod:619
21002 msgid "would truncate the file to 1 gigabyte."
21006 #: ../fish/guestfish.pod:621
21008 "Be careful because a few commands take sizes in kilobytes or megabytes (eg. "
21009 "the parameter to L</memsize> is specified in megabytes already). Adding a "
21010 "suffix will probably not do what you expect."
21014 #: ../fish/guestfish.pod:625
21015 msgid "OCTAL AND HEXADECIMAL NUMBERS"
21019 #: ../fish/guestfish.pod:627
21021 "For specifying the radix (base) use the C convention: C<0> to prefix an "
21022 "octal number or C<0x> to prefix a hexadecimal number. For example:"
21026 #: ../fish/guestfish.pod:630
21029 " 1234 decimal number 1234\n"
21030 " 02322 octal number, equivalent to decimal 1234\n"
21031 " 0x4d2 hexadecimal number, equivalent to decimal 1234\n"
21036 #: ../fish/guestfish.pod:634
21038 "When using the C<chmod> command, you almost always want to specify an octal "
21039 "number for the mode, and you must prefix it with C<0> (unlike the Unix "
21040 "L<chmod(1)> program):"
21044 #: ../fish/guestfish.pod:638
21047 " chmod 0777 /public # OK\n"
21048 " chmod 777 /public # WRONG! This is mode 777 decimal = 01411 octal.\n"
21053 #: ../fish/guestfish.pod:641
21055 "Commands that return numbers usually print them in decimal, but some "
21056 "commands print numbers in other radices (eg. C<umask> prints the mode in "
21057 "octal, preceeded by C<0>)."
21061 #: ../fish/guestfish.pod:645
21062 msgid "WILDCARDS AND GLOBBING"
21066 #: ../fish/guestfish.pod:647
21068 "Neither guestfish nor the underlying guestfs API performs wildcard expansion "
21069 "(globbing) by default. So for example the following will not do what you "
21074 #: ../fish/guestfish.pod:651
21082 #: ../fish/guestfish.pod:653
21084 "Assuming you don't have a directory called literally C</home/*> then the "
21085 "above command will return an error."
21089 #: ../fish/guestfish.pod:656
21090 msgid "To perform wildcard expansion, use the C<glob> command."
21094 #: ../fish/guestfish.pod:658
21097 " glob rm-rf /home/*\n"
21102 #: ../fish/guestfish.pod:660
21104 "runs C<rm-rf> on each path that matches (ie. potentially running the command "
21105 "many times), equivalent to:"
21109 #: ../fish/guestfish.pod:663
21112 " rm-rf /home/jim\n"
21113 " rm-rf /home/joe\n"
21114 " rm-rf /home/mary\n"
21119 #: ../fish/guestfish.pod:667
21120 msgid "C<glob> only works on simple guest paths and not on device names."
21124 #: ../fish/guestfish.pod:669
21126 "If you have several parameters, each containing a wildcard, then glob will "
21127 "perform a Cartesian product."
21131 #: ../fish/guestfish.pod:672
21136 #: ../fish/guestfish.pod:674
21138 "Any line which starts with a I<#> character is treated as a comment and "
21139 "ignored. The I<#> can optionally be preceeded by whitespace, but B<not> by "
21140 "a command. For example:"
21144 #: ../fish/guestfish.pod:678
21147 " # this is a comment\n"
21148 " # this is a comment\n"
21149 " foo # NOT a comment\n"
21154 #: ../fish/guestfish.pod:682
21155 msgid "Blank lines are also ignored."
21159 #: ../fish/guestfish.pod:684
21160 msgid "RUNNING COMMANDS LOCALLY"
21164 #: ../fish/guestfish.pod:686
21166 "Any line which starts with a I<!> character is treated as a command sent to "
21167 "the local shell (C</bin/sh> or whatever L<system(3)> uses). For example:"
21171 #: ../fish/guestfish.pod:690
21175 " tgz-out /remote local/remote-data.tar.gz\n"
21180 #: ../fish/guestfish.pod:693
21182 "will create a directory C<local> on the host, and then export the contents "
21183 "of C</remote> on the mounted filesystem to C<local/remote-data.tar.gz>. "
21184 "(See C<tgz-out>)."
21188 #: ../fish/guestfish.pod:697
21190 "To change the local directory, use the C<lcd> command. C<!cd> will have no "
21191 "effect, due to the way that subprocesses work in Unix."
21195 #: ../fish/guestfish.pod:700
21196 msgid "LOCAL COMMANDS WITH INLINE EXECUTION"
21200 #: ../fish/guestfish.pod:702
21202 "If a line starts with I<E<lt>!> then the shell command is executed (as for "
21203 "I<!>), but subsequently any output (stdout) of the shell command is parsed "
21204 "and executed as guestfish commands."
21208 #: ../fish/guestfish.pod:706
21210 "Thus you can use shell script to construct arbitrary guestfish commands "
21211 "which are then parsed by guestfish."
21215 #: ../fish/guestfish.pod:709
21217 "For example it is tedious to create a sequence of files (eg. C</foo.1> "
21218 "through C</foo.100>) using guestfish commands alone. However this is simple "
21219 "if we use a shell script to create the guestfish commands for us:"
21223 #: ../fish/guestfish.pod:714
21226 " <! for n in `seq 1 100`; do echo write /foo.$n $n; done\n"
21231 #: ../fish/guestfish.pod:716
21232 msgid "or with names like C</foo.001>:"
21236 #: ../fish/guestfish.pod:718
21239 " <! for n in `seq 1 100`; do printf \"write /foo.%03d %d\\n\" $n $n; done\n"
21244 #: ../fish/guestfish.pod:720
21246 "When using guestfish interactively it can be helpful to just run the shell "
21247 "script first (ie. remove the initial C<E<lt>> character so it is just an "
21248 "ordinary I<!> local command), see what guestfish commands it would run, and "
21249 "when you are happy with those prepend the C<E<lt>> character to run the "
21250 "guestfish commands for real."
21254 #: ../fish/guestfish.pod:726
21259 #: ../fish/guestfish.pod:728
21261 "Use C<command E<lt>spaceE<gt> | command> to pipe the output of the first "
21262 "command (a guestfish command) to the second command (any host command). For "
21267 #: ../fish/guestfish.pod:732
21270 " cat /etc/passwd | awk -F: '$3 == 0 { print }'\n"
21275 #: ../fish/guestfish.pod:734
21277 "(where C<cat> is the guestfish cat command, but C<awk> is the host awk "
21278 "program). The above command would list all accounts in the guest filesystem "
21279 "which have UID 0, ie. root accounts including backdoors. Other examples:"
21283 #: ../fish/guestfish.pod:739
21286 " hexdump /bin/ls | head\n"
21287 " list-devices | tail -1\n"
21288 " tgz-out / - | tar ztf -\n"
21293 #: ../fish/guestfish.pod:743
21295 "The space before the pipe symbol is required, any space after the pipe "
21296 "symbol is optional. Everything after the pipe symbol is just passed "
21297 "straight to the host shell, so it can contain redirections, globs and "
21298 "anything else that makes sense on the host side."
21302 #: ../fish/guestfish.pod:748
21304 "To use a literal argument which begins with a pipe symbol, you have to quote "
21309 #: ../fish/guestfish.pod:751
21317 #: ../fish/guestfish.pod:753
21318 msgid "HOME DIRECTORIES"
21322 #: ../fish/guestfish.pod:755
21324 "If a parameter starts with the character C<~> then the tilde may be expanded "
21325 "as a home directory path (either C<~> for the current user's home directory, "
21326 "or C<~user> for another user)."
21330 #: ../fish/guestfish.pod:759
21332 "Note that home directory expansion happens for users known I<on the host>, "
21333 "not in the guest filesystem."
21337 #: ../fish/guestfish.pod:762
21339 "To use a literal argument which begins with a tilde, you have to quote it, "
21344 #: ../fish/guestfish.pod:765
21352 #: ../fish/guestfish.pod:769
21354 "Libguestfs has some support for Linux guests encrypted according to the "
21355 "Linux Unified Key Setup (LUKS) standard, which includes nearly all whole "
21356 "disk encryption systems used by modern Linux guests. Currently only LVM-on-"
21357 "LUKS is supported."
21361 #: ../fish/guestfish.pod:774
21362 msgid "Identify encrypted block devices and partitions using L</vfs-type>:"
21366 #: ../fish/guestfish.pod:776
21369 " ><fs> vfs-type /dev/sda2\n"
21375 #: ../fish/guestfish.pod:779
21377 "Then open those devices using L</luks-open>. This creates a device-mapper "
21378 "device called C</dev/mapper/luksdev>."
21382 #: ../fish/guestfish.pod:782
21385 " ><fs> luks-open /dev/sda2 luksdev\n"
21386 " Enter key or passphrase (\"key\"): <enter the passphrase>\n"
21391 #: ../fish/guestfish.pod:785
21393 "Finally you have to tell LVM to scan for volume groups on the newly created "
21398 #: ../fish/guestfish.pod:788
21402 " vg-activate-all true\n"
21407 #: ../fish/guestfish.pod:791
21408 msgid "The logical volume(s) can now be mounted in the usual way."
21412 #: ../fish/guestfish.pod:793
21414 "Before closing a LUKS device you must unmount any logical volumes on it and "
21415 "deactivate the volume groups by calling C<vg-activate false VG> on each "
21416 "one. Then you can close the mapper device:"
21420 #: ../fish/guestfish.pod:797
21423 " vg-activate false /dev/VG\n"
21424 " luks-close /dev/mapper/luksdev\n"
21429 #: ../fish/guestfish.pod:800
21430 msgid "WINDOWS PATHS"
21434 #: ../fish/guestfish.pod:802
21436 "If a path is prefixed with C<win:> then you can use Windows-style drive "
21437 "letters and paths (with some limitations). The following commands are "
21442 #: ../fish/guestfish.pod:806
21445 " file /WINDOWS/system32/config/system.LOG\n"
21450 #: ../fish/guestfish.pod:808
21453 " file win:\\windows\\system32\\config\\system.log\n"
21458 #: ../fish/guestfish.pod:810
21461 " file WIN:C:\\Windows\\SYSTEM32\\CONFIG\\SYSTEM.LOG\n"
21466 #: ../fish/guestfish.pod:812
21468 "The parameter is rewritten \"behind the scenes\" by looking up the position "
21469 "where the drive is mounted, prepending that to the path, changing all "
21470 "backslash characters to forward slash, then resolving the result using L</"
21471 "case-sensitive-path>. For example if the E: drive was mounted on C</e> then "
21472 "the parameter might be rewritten like this:"
21476 #: ../fish/guestfish.pod:818
21479 " win:e:\\foo\\bar => /e/FOO/bar\n"
21484 #: ../fish/guestfish.pod:820
21485 msgid "This only works in argument positions that expect a path."
21489 #: ../fish/guestfish.pod:822
21490 msgid "UPLOADING AND DOWNLOADING FILES"
21494 #: ../fish/guestfish.pod:824
21496 "For commands such as C<upload>, C<download>, C<tar-in>, C<tar-out> and "
21497 "others which upload from or download to a local file, you can use the "
21498 "special filename C<-> to mean \"from stdin\" or \"to stdout\". For example:"
21502 #: ../fish/guestfish.pod:828
21510 #: ../fish/guestfish.pod:830
21512 "reads stdin and creates from that a file C</foo> in the disk image, and:"
21516 #: ../fish/guestfish.pod:833
21519 " tar-out /etc - | tar tf -\n"
21524 #: ../fish/guestfish.pod:835
21526 "writes the tarball to stdout and then pipes that into the external \"tar\" "
21527 "command (see L</PIPES>)."
21531 #: ../fish/guestfish.pod:838
21533 "When using C<-> to read from stdin, the input is read up to the end of "
21534 "stdin. You can also use a special \"heredoc\"-like syntax to read up to "
21535 "some arbitrary end marker:"
21539 #: ../fish/guestfish.pod:842
21542 " upload -<<END /foo\n"
21551 #: ../fish/guestfish.pod:848
21553 "Any string of characters can be used instead of C<END>. The end marker must "
21554 "appear on a line of its own, without any preceeding or following characters "
21555 "(not even spaces)."
21559 #: ../fish/guestfish.pod:852
21561 "Note that the C<-E<lt>E<lt>> syntax only applies to parameters used to "
21562 "upload local files (so-called \"FileIn\" parameters in the generator)."
21566 #: ../fish/guestfish.pod:855
21567 msgid "EXIT ON ERROR BEHAVIOUR"
21571 #: ../fish/guestfish.pod:857
21573 "By default, guestfish will ignore any errors when in interactive mode (ie. "
21574 "taking commands from a human over a tty), and will exit on the first error "
21575 "in non-interactive mode (scripts, commands given on the command line)."
21579 #: ../fish/guestfish.pod:862
21581 "If you prefix a command with a I<-> character, then that command will not "
21582 "cause guestfish to exit, even if that (one) command returns an error."
21586 #: ../fish/guestfish.pod:866
21587 msgid "REMOTE CONTROL GUESTFISH OVER A SOCKET"
21591 #: ../fish/guestfish.pod:868
21593 "Guestfish can be remote-controlled over a socket. This is useful "
21594 "particularly in shell scripts where you want to make several different "
21595 "changes to a filesystem, but you don't want the overhead of starting up a "
21596 "guestfish process each time."
21600 #: ../fish/guestfish.pod:873
21601 msgid "Start a guestfish server process using:"
21605 #: ../fish/guestfish.pod:875
21608 " eval \"`guestfish --listen`\"\n"
21613 #: ../fish/guestfish.pod:877
21614 msgid "and then send it commands by doing:"
21618 #: ../fish/guestfish.pod:879
21621 " guestfish --remote cmd [...]\n"
21626 #: ../fish/guestfish.pod:881
21627 msgid "To cause the server to exit, send it the exit command:"
21631 #: ../fish/guestfish.pod:883
21634 " guestfish --remote exit\n"
21639 #: ../fish/guestfish.pod:885
21641 "Note that the server will normally exit if there is an error in a command. "
21642 "You can change this in the usual way. See section L</EXIT ON ERROR "
21647 #: ../fish/guestfish.pod:889
21648 msgid "CONTROLLING MULTIPLE GUESTFISH PROCESSES"
21652 #: ../fish/guestfish.pod:891
21654 "The C<eval> statement sets the environment variable C<$GUESTFISH_PID>, which "
21655 "is how the I<--remote> option knows where to send the commands. You can "
21656 "have several guestfish listener processes running using:"
21660 #: ../fish/guestfish.pod:895
21663 " eval \"`guestfish --listen`\"\n"
21664 " pid1=$GUESTFISH_PID\n"
21665 " eval \"`guestfish --listen`\"\n"
21666 " pid2=$GUESTFISH_PID\n"
21668 " guestfish --remote=$pid1 cmd\n"
21669 " guestfish --remote=$pid2 cmd\n"
21674 #: ../fish/guestfish.pod:903
21675 msgid "REMOTE CONTROL AND CSH"
21679 #: ../fish/guestfish.pod:905
21681 "When using csh-like shells (csh, tcsh etc) you have to add the I<--csh> "
21686 #: ../fish/guestfish.pod:908
21689 " eval \"`guestfish --listen --csh`\"\n"
21694 #: ../fish/guestfish.pod:910
21695 msgid "REMOTE CONTROL DETAILS"
21699 #: ../fish/guestfish.pod:912
21701 "Remote control happens over a Unix domain socket called C</tmp/.guestfish-"
21702 "$UID/socket-$PID>, where C<$UID> is the effective user ID of the process, "
21703 "and C<$PID> is the process ID of the server."
21707 #: ../fish/guestfish.pod:916
21708 msgid "Guestfish client and server versions must match exactly."
21712 #: ../fish/guestfish.pod:918
21713 msgid "PREPARED DISK IMAGES"
21717 #: ../fish/guestfish.pod:920
21719 "Use the I<-N type> or I<--new type> parameter to select one of a set of "
21720 "preformatted disk images that guestfish can make for you to save typing. "
21721 "This is particularly useful for testing purposes. This option is used "
21722 "instead of the I<-a> option, and like I<-a> can appear multiple times (and "
21723 "can be mixed with I<-a>)."
21727 #: ../fish/guestfish.pod:926
21729 "The new disk is called C<test1.img> for the first I<-N>, C<test2.img> for "
21730 "the second and so on. Existing files in the current directory are "
21735 #: ../fish/guestfish.pod:930
21737 "The type briefly describes how the disk should be sized, partitioned, how "
21738 "filesystem(s) should be created, and how content should be added. "
21739 "Optionally the type can be followed by extra parameters, separated by C<:> "
21740 "(colon) characters. For example, I<-N fs> creates a default 100MB, sparsely-"
21741 "allocated disk, containing a single partition, with the partition formatted "
21742 "as ext2. I<-N fs:ext4:1G> is the same, but for an ext4 filesystem on a 1GB "
21747 #: ../fish/guestfish.pod:938
21748 msgid "To list the available types and any extra parameters they take, run:"
21752 #: ../fish/guestfish.pod:942
21754 "Note that the prepared filesystem is not mounted. You would usually have to "
21755 "use the C<mount /dev/sda1 /> command or add the I<-m /dev/sda1> option."
21759 #: ../fish/guestfish.pod:946
21761 "If any I<-N> or I<--new> options are given, the guest is automatically "
21766 #: ../fish/guestfish.pod:951
21767 msgid "Create a 100MB disk with an ext4-formatted partition:"
21771 #: ../fish/guestfish.pod:953
21774 " guestfish -N fs:ext4\n"
21779 #: ../fish/guestfish.pod:955
21780 msgid "Create a 32MB disk with a VFAT-formatted partition, and mount it:"
21784 #: ../fish/guestfish.pod:957
21787 " guestfish -N fs:vfat:32M -m /dev/sda1\n"
21792 #: ../fish/guestfish.pod:959
21793 msgid "Create a blank 200MB disk:"
21797 #: ../fish/guestfish.pod:961
21800 " guestfish -N disk:200M\n"
21805 #: ../fish/guestfish.pod:963
21806 msgid "PROGRESS BARS"
21810 #: ../fish/guestfish.pod:965
21812 "Some (not all) long-running commands send progress notification messages as "
21813 "they are running. Guestfish turns these messages into progress bars."
21817 #: ../fish/guestfish.pod:969
21819 "When a command that supports progress bars takes longer than two seconds to "
21820 "run, and if progress bars are enabled, then you will see one appearing below "
21825 #: ../fish/guestfish.pod:973
21828 " ><fs> copy-size /large-file /another-file 2048M\n"
21829 " / 10% [#####-----------------------------------------] 00:30\n"
21834 #: ../fish/guestfish.pod:976
21836 "The spinner on the left hand side moves round once for every progress "
21837 "notification received from the backend. This is a (reasonably) golden "
21838 "assurance that the command is \"doing something\" even if the progress bar "
21839 "is not moving, because the command is able to send the progress "
21840 "notifications. When the bar reaches 100% and the command finishes, the "
21841 "spinner disappears."
21845 #: ../fish/guestfish.pod:983
21847 "Progress bars are enabled by default when guestfish is used interactively. "
21848 "You can enable them even for non-interactive modes using I<--progress-bars>, "
21849 "and you can disable them completely using I<--no-progress-bars>."
21853 #: ../fish/guestfish.pod:988
21854 msgid "GUESTFISH COMMANDS"
21858 #: ../fish/guestfish.pod:990
21860 "The commands in this section are guestfish convenience commands, in other "
21861 "words, they are not part of the L<guestfs(3)> API."
21865 #: ../fish/guestfish.pod:993
21870 #: ../fish/guestfish.pod:995
21879 #: ../fish/guestfish.pod:998
21880 msgid "Without any parameter, this provides general help."
21884 #: ../fish/guestfish.pod:1000
21885 msgid "With a C<cmd> parameter, this displays detailed help for that command."
21889 #: ../fish/guestfish.pod:1002
21890 msgid "quit | exit"
21894 #: ../fish/guestfish.pod:1004
21895 msgid "This exits guestfish. You can also use C<^D> key."
21899 #: ../fish/guestfish.pod:1006
21900 msgid "@FISH_COMMANDS@"
21904 #: ../fish/guestfish.pod:1008
21909 #: ../fish/guestfish.pod:1012 ../test-tool/libguestfs-test-tool.pod:77
21914 #: ../fish/guestfish.pod:1014
21916 "guestfish returns 0 if the commands completed without error, or 1 if there "
21921 #: ../fish/guestfish.pod:1021
21926 #: ../fish/guestfish.pod:1023
21928 "The C<edit> command uses C<$EDITOR> as the editor. If not set, it uses "
21933 #: ../fish/guestfish.pod:1026
21934 msgid "GUESTFISH_DISPLAY_IMAGE"
21938 #: ../fish/guestfish.pod:1028
21940 "The C<display> command uses C<$GUESTFISH_DISPLAY_IMAGE> to display images. "
21941 "If not set, it uses L<display(1)>."
21945 #: ../fish/guestfish.pod:1031
21946 msgid "GUESTFISH_PID"
21950 #: ../fish/guestfish.pod:1033
21952 "Used with the I<--remote> option to specify the remote guestfish process to "
21953 "control. See section L</REMOTE CONTROL GUESTFISH OVER A SOCKET>."
21957 #: ../fish/guestfish.pod:1037
21962 #: ../fish/guestfish.pod:1039
21964 "The L</hexedit> command uses C<$HEXEDITOR> as the external hex editor. If "
21965 "not specified, the external L<hexedit(1)> program is used."
21969 #: ../fish/guestfish.pod:1043
21974 #: ../fish/guestfish.pod:1045
21976 "If compiled with GNU readline support, various files in the home directory "
21977 "can be used. See L</FILES>."
21981 #: ../fish/guestfish.pod:1054
21983 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
21984 "effect as using the B<-v> option."
21988 #: ../fish/guestfish.pod:1066
21990 "Set the path that guestfish uses to search for kernel and initrd.img. See "
21991 "the discussion of paths in L<guestfs(3)>."
21995 #: ../fish/guestfish.pod:1077
21996 msgid "Set C<LIBGUESTFS_TRACE=1> to enable command traces."
22000 #: ../fish/guestfish.pod:1079
22005 #: ../fish/guestfish.pod:1081
22007 "The C<more> command uses C<$PAGER> as the pager. If not set, it uses "
22012 #: ../fish/guestfish.pod:1097 ../fuse/guestmount.pod:264
22017 #: ../fish/guestfish.pod:1101 ../fuse/guestmount.pod:268
22018 msgid "$HOME/.libguestfs-tools.rc"
22022 #: ../fish/guestfish.pod:1103 ../fuse/guestmount.pod:270
22023 msgid "/etc/libguestfs-tools.conf"
22027 #: ../fish/guestfish.pod:1105 ../fuse/guestmount.pod:272
22029 "This configuration file controls the default read-only or read-write mode "
22030 "(I<--ro> or I<--rw>)."
22034 #: ../fish/guestfish.pod:1108
22035 msgid "See L</OPENING DISKS FOR READ AND WRITE>."
22039 #: ../fish/guestfish.pod:1110
22040 msgid "$HOME/.guestfish"
22044 #: ../fish/guestfish.pod:1112
22046 "If compiled with GNU readline support, then the command history is saved in "
22051 #: ../fish/guestfish.pod:1115
22052 msgid "$HOME/.inputrc"
22056 #: ../fish/guestfish.pod:1117
22057 msgid "/etc/inputrc"
22061 #: ../fish/guestfish.pod:1119
22063 "If compiled with GNU readline support, then these files can be used to "
22064 "configure readline. For further information, please see L<readline(3)/"
22065 "INITIALIZATION FILE>."
22069 #: ../fish/guestfish.pod:1123
22070 msgid "To write rules which only apply to guestfish, use:"
22074 #: ../fish/guestfish.pod:1125
22084 #: ../fish/guestfish.pod:1129
22086 "Variables that you can set in inputrc that change the behaviour of guestfish "
22087 "in useful ways include:"
22091 #: ../fish/guestfish.pod:1134
22092 msgid "completion-ignore-case (default: on)"
22096 #: ../fish/guestfish.pod:1136
22098 "By default, guestfish will ignore case when tab-completing paths on the "
22103 #: ../fish/guestfish.pod:1139
22106 " set completion-ignore-case off\n"
22111 #: ../fish/guestfish.pod:1141
22112 msgid "to make guestfish case sensitive."
22116 #: ../fish/guestfish.pod:1145
22121 #: ../fish/guestfish.pod:1147
22122 msgid "test2.img (etc)"
22126 #: ../fish/guestfish.pod:1149
22128 "When using the I<-N> or I<--new> option, the prepared disk or filesystem "
22129 "will be created in the file C<test1.img> in the current directory. The "
22130 "second use of I<-N> will use C<test2.img> and so on. Any existing file with "
22131 "the same name will be overwritten."
22135 #: ../fish/guestfish.pod:1158
22137 "L<guestfs(3)>, L<http://libguestfs.org/>, L<virt-cat(1)>, L<virt-copy-in(1)"
22138 ">, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, L<virt-filesystems(1)"
22139 ">, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, L<virt-list-partitions"
22140 "(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, L<virt-rescue(1)>, L<virt-resize(1)"
22141 ">, L<virt-tar(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<virt-win-reg(1)"
22142 ">, L<display(1)>, L<hexedit(1)>."
22146 #: ../fish/guestfish.pod:1189 ../test-tool/libguestfs-test-tool.pod:102
22147 #: ../fuse/guestmount.pod:299 ../tools/virt-win-reg.pl:778
22148 #: ../tools/virt-list-filesystems.pl:210 ../tools/virt-tar.pl:309
22149 #: ../tools/virt-make-fs.pl:572 ../tools/virt-list-partitions.pl:277
22151 "This program is free software; you can redistribute it and/or modify it "
22152 "under the terms of the GNU General Public License as published by the Free "
22153 "Software Foundation; either version 2 of the License, or (at your option) "
22154 "any later version."
22158 #: ../fish/guestfish.pod:1194 ../test-tool/libguestfs-test-tool.pod:107
22159 #: ../fuse/guestmount.pod:304 ../tools/virt-win-reg.pl:783
22160 #: ../tools/virt-list-filesystems.pl:215 ../tools/virt-tar.pl:314
22161 #: ../tools/virt-make-fs.pl:577 ../tools/virt-list-partitions.pl:282
22163 "This program is distributed in the hope that it will be useful, but WITHOUT "
22164 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
22165 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for "
22170 #: ../fish/guestfish.pod:1199 ../test-tool/libguestfs-test-tool.pod:112
22171 #: ../fuse/guestmount.pod:309 ../tools/virt-win-reg.pl:788
22172 #: ../tools/virt-list-filesystems.pl:220 ../tools/virt-tar.pl:319
22173 #: ../tools/virt-make-fs.pl:582 ../tools/virt-list-partitions.pl:287
22175 "You should have received a copy of the GNU General Public License along with "
22176 "this program; if not, write to the Free Software Foundation, Inc., 675 Mass "
22177 "Ave, Cambridge, MA 02139, USA."
22181 #: ../fish/guestfish-actions.pod:1
22186 #: ../fish/guestfish-actions.pod:3
22189 " add-cdrom filename\n"
22194 #: ../fish/guestfish-actions.pod:15
22196 "This call checks for the existence of C<filename>. This stops you from "
22197 "specifying other types of drive which are supported by qemu such as C<nbd:> "
22198 "and C<http:> URLs. To specify those, use the general L</config> call "
22203 #: ../fish/guestfish-actions.pod:22
22205 "If you just want to add an ISO file (often you use this as an efficient way "
22206 "to transfer large files into the guest), then you should probably use L</add-"
22207 "drive-ro> instead."
22211 #: ../fish/guestfish-actions.pod:35
22216 #: ../fish/guestfish-actions.pod:37
22221 #: ../fish/guestfish-actions.pod:39
22224 " add-domain dom [libvirturi:..] [readonly:..] [iface:..] [live:..] [allowuuid:..]\n"
22229 #: ../fish/guestfish-actions.pod:41
22231 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
22232 "It works by connecting to libvirt, requesting the domain and domain XML from "
22233 "libvirt, parsing it for disks, and calling L</add-drive-opts> on each one."
22237 #: ../fish/guestfish-actions.pod:76
22239 "The other optional parameters are passed directly through to L</add-drive-"
22244 #: ../fish/guestfish-actions.pod:79 ../fish/guestfish-actions.pod:143
22245 #: ../fish/guestfish-actions.pod:1937 ../fish/guestfish-actions.pod:3077
22246 #: ../fish/guestfish-actions.pod:3250
22248 "This command has one or more optional arguments. See L</OPTIONAL ARGUMENTS>."
22252 #: ../fish/guestfish-actions.pod:81
22257 #: ../fish/guestfish-actions.pod:83
22260 " add-drive filename\n"
22265 #: ../fish/guestfish-actions.pod:85
22267 "This function is the equivalent of calling L</add-drive-opts> with no "
22268 "optional parameters, so the disk is added writable, with the format being "
22269 "detected automatically."
22273 #: ../fish/guestfish-actions.pod:89
22275 "Automatic detection of the format opens you up to a potential security hole "
22276 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
22277 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
22278 "you should think about replacing calls to this function with calls to L</add-"
22279 "drive-opts>, and specifying the format."
22283 #: ../fish/guestfish-actions.pod:96
22284 msgid "add-drive-opts"
22288 #: ../fish/guestfish-actions.pod:98
22293 #: ../fish/guestfish-actions.pod:100
22296 " add-drive-opts filename [readonly:..] [format:..] [iface:..]\n"
22301 #: ../fish/guestfish-actions.pod:127
22303 "This forces the image format. If you omit this (or use L</add-drive> or L</"
22304 "add-drive-ro>) then the format is automatically detected. Possible formats "
22305 "include C<raw> and C<qcow2>."
22309 #: ../fish/guestfish-actions.pod:138
22311 "This rarely-used option lets you emulate the behaviour of the deprecated L</"
22312 "add-drive-with-if> call (q.v.)"
22316 #: ../fish/guestfish-actions.pod:145
22317 msgid "add-drive-ro"
22321 #: ../fish/guestfish-actions.pod:147
22326 #: ../fish/guestfish-actions.pod:149
22329 " add-drive-ro filename\n"
22334 #: ../fish/guestfish-actions.pod:151
22336 "This function is the equivalent of calling L</add-drive-opts> with the "
22337 "optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the disk "
22338 "is added read-only, with the format being detected automatically."
22342 #: ../fish/guestfish-actions.pod:156
22343 msgid "add-drive-ro-with-if"
22347 #: ../fish/guestfish-actions.pod:158
22350 " add-drive-ro-with-if filename iface\n"
22355 #: ../fish/guestfish-actions.pod:160
22357 "This is the same as L</add-drive-ro> but it allows you to specify the QEMU "
22358 "interface emulation to use at run time."
22362 #: ../fish/guestfish-actions.pod:170
22363 msgid "add-drive-with-if"
22367 #: ../fish/guestfish-actions.pod:172
22370 " add-drive-with-if filename iface\n"
22375 #: ../fish/guestfish-actions.pod:174
22377 "This is the same as L</add-drive> but it allows you to specify the QEMU "
22378 "interface emulation to use at run time."
22382 #: ../fish/guestfish-actions.pod:184
22387 #: ../fish/guestfish-actions.pod:186
22390 " aug-clear augpath\n"
22395 #: ../fish/guestfish-actions.pod:191
22400 #: ../fish/guestfish-actions.pod:193
22408 #: ../fish/guestfish-actions.pod:195
22410 "Close the current Augeas handle and free up any resources used by it. After "
22411 "calling this, you have to call L</aug-init> again before you can use any "
22412 "other Augeas functions."
22416 #: ../fish/guestfish-actions.pod:200
22417 msgid "aug-defnode"
22421 #: ../fish/guestfish-actions.pod:202
22424 " aug-defnode name expr val\n"
22429 #: ../fish/guestfish-actions.pod:207
22431 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
22432 "calling L</aug-set> C<expr>, C<value>. C<name> will be the nodeset "
22433 "containing that single node."
22437 #: ../fish/guestfish-actions.pod:215
22442 #: ../fish/guestfish-actions.pod:217
22445 " aug-defvar name expr\n"
22450 #: ../fish/guestfish-actions.pod:226
22455 #: ../fish/guestfish-actions.pod:228
22458 " aug-get augpath\n"
22463 #: ../fish/guestfish-actions.pod:233
22468 #: ../fish/guestfish-actions.pod:235
22471 " aug-init root flags\n"
22476 #: ../fish/guestfish-actions.pod:241
22477 msgid "You must call this before using any other L</aug-*> commands."
22481 #: ../fish/guestfish-actions.pod:276
22482 msgid "Do not load the tree in L</aug-init>."
22486 #: ../fish/guestfish-actions.pod:280
22487 msgid "To close the handle, you can call L</aug-close>."
22491 #: ../fish/guestfish-actions.pod:284
22496 #: ../fish/guestfish-actions.pod:286
22499 " aug-insert augpath label true|false\n"
22504 #: ../fish/guestfish-actions.pod:296
22509 #: ../fish/guestfish-actions.pod:298
22517 #: ../fish/guestfish-actions.pod:305
22522 #: ../fish/guestfish-actions.pod:307
22525 " aug-ls augpath\n"
22530 #: ../fish/guestfish-actions.pod:309
22532 "This is just a shortcut for listing L</aug-match> C<path/*> and sorting the "
22533 "resulting nodes into alphabetical order."
22537 #: ../fish/guestfish-actions.pod:312
22542 #: ../fish/guestfish-actions.pod:314
22545 " aug-match augpath\n"
22550 #: ../fish/guestfish-actions.pod:320
22555 #: ../fish/guestfish-actions.pod:322
22558 " aug-mv src dest\n"
22563 #: ../fish/guestfish-actions.pod:327
22568 #: ../fish/guestfish-actions.pod:329
22571 " aug-rm augpath\n"
22576 #: ../fish/guestfish-actions.pod:335
22581 #: ../fish/guestfish-actions.pod:337
22589 #: ../fish/guestfish-actions.pod:341
22591 "The flags which were passed to L</aug-init> affect exactly how files are "
22596 #: ../fish/guestfish-actions.pod:344
22601 #: ../fish/guestfish-actions.pod:346
22604 " aug-set augpath val\n"
22609 #: ../fish/guestfish-actions.pod:350
22611 "In the Augeas API, it is possible to clear a node by setting the value to "
22612 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
22613 "this call. Instead you must use the L</aug-clear> call."
22617 #: ../fish/guestfish-actions.pod:355
22622 #: ../fish/guestfish-actions.pod:357
22625 " available 'groups ...'\n"
22630 #: ../fish/guestfish-actions.pod:363
22632 "The libguestfs groups, and the functions that those groups correspond to, "
22633 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
22634 "runtime by calling L</available-all-groups>."
22638 #: ../fish/guestfish-actions.pod:387
22639 msgid "You must call L</launch> before calling this function."
22643 #: ../fish/guestfish-actions.pod:409
22645 "This call was added in version C<1.0.80>. In previous versions of "
22646 "libguestfs all you could do would be to speculatively execute a command to "
22647 "find out if the daemon implemented it. See also L</version>."
22651 #: ../fish/guestfish-actions.pod:416
22652 msgid "available-all-groups"
22656 #: ../fish/guestfish-actions.pod:418
22659 " available-all-groups\n"
22664 #: ../fish/guestfish-actions.pod:420
22666 "This command returns a list of all optional groups that this daemon knows "
22667 "about. Note this returns both supported and unsupported groups. To find "
22668 "out which ones the daemon can actually support you have to call L</"
22669 "available> on each member of the returned list."
22673 #: ../fish/guestfish-actions.pod:426
22674 msgid "See also L</available> and L<guestfs(3)/AVAILABILITY>."
22678 #: ../fish/guestfish-actions.pod:428
22683 #: ../fish/guestfish-actions.pod:430
22686 " base64-in (base64file|-) filename\n"
22691 #: ../fish/guestfish-actions.pod:435 ../fish/guestfish-actions.pod:444
22692 #: ../fish/guestfish-actions.pod:668 ../fish/guestfish-actions.pod:837
22693 #: ../fish/guestfish-actions.pod:856 ../fish/guestfish-actions.pod:1230
22694 #: ../fish/guestfish-actions.pod:4523 ../fish/guestfish-actions.pod:4535
22695 #: ../fish/guestfish-actions.pod:4546 ../fish/guestfish-actions.pod:4557
22696 #: ../fish/guestfish-actions.pod:4609 ../fish/guestfish-actions.pod:4618
22697 #: ../fish/guestfish-actions.pod:4672 ../fish/guestfish-actions.pod:4695
22698 msgid "Use C<-> instead of a filename to read/write from stdin/stdout."
22702 #: ../fish/guestfish-actions.pod:437
22707 #: ../fish/guestfish-actions.pod:439
22710 " base64-out filename (base64file|-)\n"
22715 #: ../fish/guestfish-actions.pod:446
22716 msgid "blockdev-flushbufs"
22720 #: ../fish/guestfish-actions.pod:448
22723 " blockdev-flushbufs device\n"
22728 #: ../fish/guestfish-actions.pod:455
22729 msgid "blockdev-getbsz"
22733 #: ../fish/guestfish-actions.pod:457
22736 " blockdev-getbsz device\n"
22741 #: ../fish/guestfish-actions.pod:466
22742 msgid "blockdev-getro"
22746 #: ../fish/guestfish-actions.pod:468
22749 " blockdev-getro device\n"
22754 #: ../fish/guestfish-actions.pod:475
22755 msgid "blockdev-getsize64"
22759 #: ../fish/guestfish-actions.pod:477
22762 " blockdev-getsize64 device\n"
22767 #: ../fish/guestfish-actions.pod:481
22768 msgid "See also L</blockdev-getsz>."
22772 #: ../fish/guestfish-actions.pod:485
22773 msgid "blockdev-getss"
22777 #: ../fish/guestfish-actions.pod:487
22780 " blockdev-getss device\n"
22785 #: ../fish/guestfish-actions.pod:492
22787 "(Note, this is not the size in sectors, use L</blockdev-getsz> for that)."
22791 #: ../fish/guestfish-actions.pod:497
22792 msgid "blockdev-getsz"
22796 #: ../fish/guestfish-actions.pod:499
22799 " blockdev-getsz device\n"
22804 #: ../fish/guestfish-actions.pod:504
22806 "See also L</blockdev-getss> for the real sector size of the device, and L</"
22807 "blockdev-getsize64> for the more useful I<size in bytes>."
22811 #: ../fish/guestfish-actions.pod:510
22812 msgid "blockdev-rereadpt"
22816 #: ../fish/guestfish-actions.pod:512
22819 " blockdev-rereadpt device\n"
22824 #: ../fish/guestfish-actions.pod:518
22825 msgid "blockdev-setbsz"
22829 #: ../fish/guestfish-actions.pod:520
22832 " blockdev-setbsz device blocksize\n"
22837 #: ../fish/guestfish-actions.pod:529
22838 msgid "blockdev-setro"
22842 #: ../fish/guestfish-actions.pod:531
22845 " blockdev-setro device\n"
22850 #: ../fish/guestfish-actions.pod:537
22851 msgid "blockdev-setrw"
22855 #: ../fish/guestfish-actions.pod:539
22858 " blockdev-setrw device\n"
22863 #: ../fish/guestfish-actions.pod:545
22864 msgid "case-sensitive-path"
22868 #: ../fish/guestfish-actions.pod:547
22871 " case-sensitive-path path\n"
22876 #: ../fish/guestfish-actions.pod:571
22878 "Thus L</case-sensitive-path> (\"/Windows/System32\") might return C<\"/"
22879 "WINDOWS/system32\"> (the exact return value would depend on details of how "
22880 "the directories were originally created under Windows)."
22884 #: ../fish/guestfish-actions.pod:579
22885 msgid "See also L</realpath>."
22889 #: ../fish/guestfish-actions.pod:581
22894 #: ../fish/guestfish-actions.pod:583
22902 #: ../fish/guestfish-actions.pod:587
22904 "Note that this function cannot correctly handle binary files (specifically, "
22905 "files containing C<\\0> character which is treated as end of string). For "
22906 "those you need to use the L</read-file> or L</download> functions which have "
22907 "a more complex interface."
22911 #: ../fish/guestfish-actions.pod:595
22916 #: ../fish/guestfish-actions.pod:597
22919 " checksum csumtype path\n"
22924 #: ../fish/guestfish-actions.pod:640
22925 msgid "To get the checksum for a device, use L</checksum-device>."
22929 #: ../fish/guestfish-actions.pod:642
22930 msgid "To get the checksums for many files, use L</checksums-out>."
22934 #: ../fish/guestfish-actions.pod:644
22935 msgid "checksum-device"
22939 #: ../fish/guestfish-actions.pod:646
22942 " checksum-device csumtype device\n"
22947 #: ../fish/guestfish-actions.pod:648
22949 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
22950 "device named C<device>. For the types of checksums supported see the L</"
22951 "checksum> command."
22955 #: ../fish/guestfish-actions.pod:652
22956 msgid "checksums-out"
22960 #: ../fish/guestfish-actions.pod:654
22963 " checksums-out csumtype directory (sumsfile|-)\n"
22968 #: ../fish/guestfish-actions.pod:670
22973 #: ../fish/guestfish-actions.pod:672
22976 " chmod mode path\n"
22981 #: ../fish/guestfish-actions.pod:683
22986 #: ../fish/guestfish-actions.pod:685
22989 " chown owner group path\n"
22994 #: ../fish/guestfish-actions.pod:693
22999 #: ../fish/guestfish-actions.pod:695
23002 " command 'arguments ...'\n"
23007 #: ../fish/guestfish-actions.pod:702
23009 "The single parameter is an argv-style list of arguments. The first element "
23010 "is the name of the program to run. Subsequent elements are parameters. The "
23011 "list must be non-empty (ie. must contain a program name). Note that the "
23012 "command runs directly, and is I<not> invoked via the shell (see L</sh>)."
23016 #: ../fish/guestfish-actions.pod:730
23017 msgid "command-lines"
23021 #: ../fish/guestfish-actions.pod:732
23024 " command-lines 'arguments ...'\n"
23029 #: ../fish/guestfish-actions.pod:734
23031 "This is the same as L</command>, but splits the result into a list of lines."
23035 #: ../fish/guestfish-actions.pod:737
23036 msgid "See also: L</sh-lines>"
23040 #: ../fish/guestfish-actions.pod:742
23045 #: ../fish/guestfish-actions.pod:744
23048 " config qemuparam qemuvalue\n"
23053 #: ../fish/guestfish-actions.pod:755
23058 #: ../fish/guestfish-actions.pod:757
23061 " copy-size src dest size\n"
23066 #: ../fish/guestfish-actions.pod:765
23071 #: ../fish/guestfish-actions.pod:767
23079 #: ../fish/guestfish-actions.pod:772
23084 #: ../fish/guestfish-actions.pod:774
23092 #: ../fish/guestfish-actions.pod:779
23097 #: ../fish/guestfish-actions.pod:781
23105 #: ../fish/guestfish-actions.pod:788
23107 "If the destination is a device, it must be as large or larger than the "
23108 "source file or device, otherwise the copy will fail. This command cannot do "
23109 "partial copies (see L</copy-size>)."
23113 #: ../fish/guestfish-actions.pod:792
23118 #: ../fish/guestfish-actions.pod:794
23126 #: ../fish/guestfish-actions.pod:798 ../fish/guestfish-actions.pod:809
23128 "This command is mostly useful for interactive sessions. It is I<not> "
23129 "intended that you try to parse the output string. Use L</statvfs> from "
23134 #: ../fish/guestfish-actions.pod:802
23139 #: ../fish/guestfish-actions.pod:804
23147 #: ../fish/guestfish-actions.pod:813
23152 #: ../fish/guestfish-actions.pod:815
23160 #: ../fish/guestfish-actions.pod:821
23162 "Another way to get the same information is to enable verbose messages with "
23163 "L</set-verbose> or by setting the environment variable C<LIBGUESTFS_DEBUG=1> "
23164 "before running the program."
23168 #: ../fish/guestfish-actions.pod:826
23173 #: ../fish/guestfish-actions.pod:828
23176 " download remotefilename (filename|-)\n"
23181 #: ../fish/guestfish-actions.pod:835
23182 msgid "See also L</upload>, L</cat>."
23186 #: ../fish/guestfish-actions.pod:839
23187 msgid "download-offset"
23191 #: ../fish/guestfish-actions.pod:841
23194 " download-offset remotefilename (filename|-) offset size\n"
23199 #: ../fish/guestfish-actions.pod:849
23201 "Note that there is no limit on the amount of data that can be downloaded "
23202 "with this call, unlike with L</pread>, and this call always reads the full "
23203 "amount unless an error occurs."
23207 #: ../fish/guestfish-actions.pod:854
23208 msgid "See also L</download>, L</pread>."
23212 #: ../fish/guestfish-actions.pod:858
23213 msgid "drop-caches"
23217 #: ../fish/guestfish-actions.pod:860
23220 " drop-caches whattodrop\n"
23225 #: ../fish/guestfish-actions.pod:872
23230 #: ../fish/guestfish-actions.pod:874
23238 #: ../fish/guestfish-actions.pod:886
23243 #: ../fish/guestfish-actions.pod:888
23246 " e2fsck-f device\n"
23251 #: ../fish/guestfish-actions.pod:894
23253 "This command is only needed because of L</resize2fs> (q.v.). Normally you "
23254 "should use L</fsck>."
23258 #: ../fish/guestfish-actions.pod:897
23259 msgid "echo-daemon"
23263 #: ../fish/guestfish-actions.pod:899
23266 " echo-daemon 'words ...'\n"
23271 #: ../fish/guestfish-actions.pod:906
23272 msgid "See also L</ping-daemon>."
23276 #: ../fish/guestfish-actions.pod:908
23281 #: ../fish/guestfish-actions.pod:910
23284 " egrep regex path\n"
23289 #: ../fish/guestfish-actions.pod:918
23294 #: ../fish/guestfish-actions.pod:920
23297 " egrepi regex path\n"
23302 #: ../fish/guestfish-actions.pod:928
23307 #: ../fish/guestfish-actions.pod:930
23310 " equal file1 file2\n"
23315 #: ../fish/guestfish-actions.pod:937
23320 #: ../fish/guestfish-actions.pod:939
23328 #: ../fish/guestfish-actions.pod:944
23329 msgid "See also L</is-file>, L</is-dir>, L</stat>."
23333 #: ../fish/guestfish-actions.pod:946
23338 #: ../fish/guestfish-actions.pod:948
23341 " fallocate path len\n"
23346 #: ../fish/guestfish-actions.pod:965
23347 msgid "fallocate64"
23351 #: ../fish/guestfish-actions.pod:967
23354 " fallocate64 path len\n"
23359 #: ../fish/guestfish-actions.pod:973
23361 "Note that this call allocates disk blocks for the file. To create a sparse "
23362 "file use L</truncate-size> instead."
23366 #: ../fish/guestfish-actions.pod:976
23368 "The deprecated call L</fallocate> does the same, but owing to an oversight "
23369 "it only allowed 30 bit lengths to be specified, effectively limiting the "
23370 "maximum size of files created through that call to 1GB."
23374 #: ../fish/guestfish-actions.pod:985
23379 #: ../fish/guestfish-actions.pod:987
23382 " fgrep pattern path\n"
23387 #: ../fish/guestfish-actions.pod:995
23392 #: ../fish/guestfish-actions.pod:997
23395 " fgrepi pattern path\n"
23400 #: ../fish/guestfish-actions.pod:1005
23405 #: ../fish/guestfish-actions.pod:1007
23413 #: ../fish/guestfish-actions.pod:1023
23415 "See also: L<file(1)>, L</vfs-type>, L</lstat>, L</is-file>, L</is-blockdev> "
23416 "(etc), L</is-zero>."
23420 #: ../fish/guestfish-actions.pod:1026
23421 msgid "file-architecture"
23425 #: ../fish/guestfish-actions.pod:1028
23428 " file-architecture filename\n"
23433 #: ../fish/guestfish-actions.pod:1131
23438 #: ../fish/guestfish-actions.pod:1133
23446 #: ../fish/guestfish-actions.pod:1137
23448 "To get other stats about a file, use L</stat>, L</lstat>, L</is-dir>, L</is-"
23449 "file> etc. To get the size of block devices, use L</blockdev-getsize64>."
23453 #: ../fish/guestfish-actions.pod:1141
23458 #: ../fish/guestfish-actions.pod:1143
23461 " fill c len path\n"
23466 #: ../fish/guestfish-actions.pod:1149
23468 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
23469 "L</truncate-size>. To create a file with a pattern of repeating bytes use "
23470 "L</fill-pattern>."
23474 #: ../fish/guestfish-actions.pod:1154
23475 msgid "fill-pattern"
23479 #: ../fish/guestfish-actions.pod:1156
23482 " fill-pattern pattern len path\n"
23487 #: ../fish/guestfish-actions.pod:1158
23489 "This function is like L</fill> except that it creates a new file of length "
23490 "C<len> containing the repeating pattern of bytes in C<pattern>. The pattern "
23491 "is truncated if necessary to ensure the length of the file is exactly C<len> "
23496 #: ../fish/guestfish-actions.pod:1163
23501 #: ../fish/guestfish-actions.pod:1165
23504 " find directory\n"
23509 #: ../fish/guestfish-actions.pod:1179
23510 msgid "then the returned list from L</find> C</tmp> would be 4 elements:"
23514 #: ../fish/guestfish-actions.pod:1192
23515 msgid "See also L</find0>."
23519 #: ../fish/guestfish-actions.pod:1197
23524 #: ../fish/guestfish-actions.pod:1199
23527 " find0 directory (files|-)\n"
23532 #: ../fish/guestfish-actions.pod:1205
23534 "This command works the same way as L</find> with the following exceptions:"
23538 #: ../fish/guestfish-actions.pod:1232
23539 msgid "findfs-label"
23543 #: ../fish/guestfish-actions.pod:1234
23546 " findfs-label label\n"
23551 #: ../fish/guestfish-actions.pod:1240
23552 msgid "To find the label of a filesystem, use L</vfs-label>."
23556 #: ../fish/guestfish-actions.pod:1242
23557 msgid "findfs-uuid"
23561 #: ../fish/guestfish-actions.pod:1244
23564 " findfs-uuid uuid\n"
23569 #: ../fish/guestfish-actions.pod:1250
23570 msgid "To find the UUID of a filesystem, use L</vfs-uuid>."
23574 #: ../fish/guestfish-actions.pod:1252
23579 #: ../fish/guestfish-actions.pod:1254
23582 " fsck fstype device\n"
23587 #: ../fish/guestfish-actions.pod:1284
23592 #: ../fish/guestfish-actions.pod:1286
23600 #: ../fish/guestfish-actions.pod:1293
23601 msgid "get-attach-method"
23605 #: ../fish/guestfish-actions.pod:1295
23608 " get-attach-method\n"
23613 #: ../fish/guestfish-actions.pod:1297
23614 msgid "Return the current attach method. See L</set-attach-method>."
23618 #: ../fish/guestfish-actions.pod:1299
23619 msgid "get-autosync"
23623 #: ../fish/guestfish-actions.pod:1301
23631 #: ../fish/guestfish-actions.pod:1305
23636 #: ../fish/guestfish-actions.pod:1307
23644 #: ../fish/guestfish-actions.pod:1311
23645 msgid "get-e2label"
23649 #: ../fish/guestfish-actions.pod:1313
23652 " get-e2label device\n"
23657 #: ../fish/guestfish-actions.pod:1325
23662 #: ../fish/guestfish-actions.pod:1327
23665 " get-e2uuid device\n"
23670 #: ../fish/guestfish-actions.pod:1339
23671 msgid "get-memsize"
23675 #: ../fish/guestfish-actions.pod:1341
23683 #: ../fish/guestfish-actions.pod:1346
23685 "If L</set-memsize> was not called on this handle, and if "
23686 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
23687 "value for memsize."
23691 #: ../fish/guestfish-actions.pod:1353
23692 msgid "get-network"
23696 #: ../fish/guestfish-actions.pod:1355
23704 #: ../fish/guestfish-actions.pod:1359
23709 #: ../fish/guestfish-actions.pod:1361
23717 #: ../fish/guestfish-actions.pod:1368
23722 #: ../fish/guestfish-actions.pod:1370
23727 #: ../fish/guestfish-actions.pod:1372
23735 #: ../fish/guestfish-actions.pod:1379
23740 #: ../fish/guestfish-actions.pod:1381
23748 #: ../fish/guestfish-actions.pod:1388
23749 msgid "get-recovery-proc"
23753 #: ../fish/guestfish-actions.pod:1390
23756 " get-recovery-proc\n"
23761 #: ../fish/guestfish-actions.pod:1394
23762 msgid "get-selinux"
23766 #: ../fish/guestfish-actions.pod:1396
23774 #: ../fish/guestfish-actions.pod:1398
23776 "This returns the current setting of the selinux flag which is passed to the "
23777 "appliance at boot time. See L</set-selinux>."
23781 #: ../fish/guestfish-actions.pod:1404
23786 #: ../fish/guestfish-actions.pod:1406
23794 #: ../fish/guestfish-actions.pod:1413
23799 #: ../fish/guestfish-actions.pod:1415
23807 #: ../fish/guestfish-actions.pod:1419
23812 #: ../fish/guestfish-actions.pod:1421
23820 #: ../fish/guestfish-actions.pod:1423
23822 "Return the current umask. By default the umask is C<022> unless it has been "
23823 "set by calling L</umask>."
23827 #: ../fish/guestfish-actions.pod:1426
23828 msgid "get-verbose"
23832 #: ../fish/guestfish-actions.pod:1428
23840 #: ../fish/guestfish-actions.pod:1432
23845 #: ../fish/guestfish-actions.pod:1434
23853 #: ../fish/guestfish-actions.pod:1438
23854 msgid "See the documentation about SELINUX in L<guestfs(3)>, and L</setcon>"
23858 #: ../fish/guestfish-actions.pod:1441
23863 #: ../fish/guestfish-actions.pod:1443
23866 " getxattr path name\n"
23871 #: ../fish/guestfish-actions.pod:1445
23873 "Get a single extended attribute from file C<path> named C<name>. This call "
23874 "follows symlinks. If you want to lookup an extended attribute for the "
23875 "symlink itself, use L</lgetxattr>."
23879 #: ../fish/guestfish-actions.pod:1449 ../fish/guestfish-actions.pod:2476
23881 "Normally it is better to get all extended attributes from a file in one go "
23882 "by calling L</getxattrs>. However some Linux filesystem implementations are "
23883 "buggy and do not provide a way to list out attributes. For these "
23884 "filesystems (notably ntfs-3g) you have to know the names of the extended "
23885 "attributes you want in advance and call this function."
23889 #: ../fish/guestfish-actions.pod:1459
23890 msgid "See also: L</getxattrs>, L</lgetxattr>, L<attr(5)>."
23894 #: ../fish/guestfish-actions.pod:1461
23899 #: ../fish/guestfish-actions.pod:1463
23902 " getxattrs path\n"
23907 #: ../fish/guestfish-actions.pod:1471
23908 msgid "See also: L</lgetxattrs>, L<attr(5)>."
23912 #: ../fish/guestfish-actions.pod:1473
23913 msgid "glob-expand"
23917 #: ../fish/guestfish-actions.pod:1475
23920 " glob-expand pattern\n"
23925 #: ../fish/guestfish-actions.pod:1488
23930 #: ../fish/guestfish-actions.pod:1490
23933 " grep regex path\n"
23938 #: ../fish/guestfish-actions.pod:1498
23943 #: ../fish/guestfish-actions.pod:1500
23946 " grepi regex path\n"
23951 #: ../fish/guestfish-actions.pod:1508
23952 msgid "grub-install"
23956 #: ../fish/guestfish-actions.pod:1510
23959 " grub-install root device\n"
23964 #: ../fish/guestfish-actions.pod:1526
23969 #: ../fish/guestfish-actions.pod:1528
23977 #: ../fish/guestfish-actions.pod:1536
23982 #: ../fish/guestfish-actions.pod:1538
23985 " head-n nrlines path\n"
23990 #: ../fish/guestfish-actions.pod:1551
23995 #: ../fish/guestfish-actions.pod:1553
24003 #: ../fish/guestfish-actions.pod:1561
24008 #: ../fish/guestfish-actions.pod:1563
24011 " initrd-cat initrdpath filename\n"
24016 #: ../fish/guestfish-actions.pod:1575
24017 msgid "See also L</initrd-list>."
24021 #: ../fish/guestfish-actions.pod:1580
24022 msgid "initrd-list"
24026 #: ../fish/guestfish-actions.pod:1582
24029 " initrd-list path\n"
24034 #: ../fish/guestfish-actions.pod:1594
24035 msgid "inotify-add-watch"
24039 #: ../fish/guestfish-actions.pod:1596
24042 " inotify-add-watch path mask\n"
24047 #: ../fish/guestfish-actions.pod:1608
24048 msgid "inotify-close"
24052 #: ../fish/guestfish-actions.pod:1610
24060 #: ../fish/guestfish-actions.pod:1616
24061 msgid "inotify-files"
24065 #: ../fish/guestfish-actions.pod:1618
24073 #: ../fish/guestfish-actions.pod:1620
24075 "This function is a helpful wrapper around L</inotify-read> which just "
24076 "returns a list of pathnames of objects that were touched. The returned "
24077 "pathnames are sorted and deduplicated."
24081 #: ../fish/guestfish-actions.pod:1624
24082 msgid "inotify-init"
24086 #: ../fish/guestfish-actions.pod:1626
24089 " inotify-init maxevents\n"
24094 #: ../fish/guestfish-actions.pod:1632
24096 "C<maxevents> is the maximum number of events which will be queued up between "
24097 "calls to L</inotify-read> or L</inotify-files>. If this is passed as C<0>, "
24098 "then the kernel (or previously set) default is used. For Linux 2.6.29 the "
24099 "default was 16384 events. Beyond this limit, the kernel throws away events, "
24100 "but records the fact that it threw them away by setting a flag "
24101 "C<IN_Q_OVERFLOW> in the returned structure list (see L</inotify-read>)."
24105 #: ../fish/guestfish-actions.pod:1642
24107 "Before any events are generated, you have to add some watches to the "
24108 "internal watch list. See: L</inotify-add-watch>, L</inotify-rm-watch> and "
24109 "L</inotify-watch-all>."
24113 #: ../fish/guestfish-actions.pod:1648
24115 "Queued up events should be read periodically by calling L</inotify-read> (or "
24116 "L</inotify-files> which is just a helpful wrapper around L</inotify-read>). "
24117 "If you don't read the events out often enough then you risk the internal "
24118 "queue overflowing."
24122 #: ../fish/guestfish-actions.pod:1655
24124 "The handle should be closed after use by calling L</inotify-close>. This "
24125 "also removes any watches automatically."
24129 #: ../fish/guestfish-actions.pod:1664
24130 msgid "inotify-read"
24134 #: ../fish/guestfish-actions.pod:1666
24142 #: ../fish/guestfish-actions.pod:1679
24143 msgid "inotify-rm-watch"
24147 #: ../fish/guestfish-actions.pod:1681
24150 " inotify-rm-watch wd\n"
24155 #: ../fish/guestfish-actions.pod:1683
24156 msgid "Remove a previously defined inotify watch. See L</inotify-add-watch>."
24160 #: ../fish/guestfish-actions.pod:1686
24161 msgid "inspect-get-arch"
24165 #: ../fish/guestfish-actions.pod:1688
24168 " inspect-get-arch root\n"
24173 #: ../fish/guestfish-actions.pod:1690
24175 "This returns the architecture of the inspected operating system. The "
24176 "possible return values are listed under L</file-architecture>."
24180 #: ../fish/guestfish-actions.pod:1699
24181 msgid "inspect-get-distro"
24185 #: ../fish/guestfish-actions.pod:1701
24188 " inspect-get-distro root\n"
24193 #: ../fish/guestfish-actions.pod:1782
24194 msgid "inspect-get-drive-mappings"
24198 #: ../fish/guestfish-actions.pod:1784
24201 " inspect-get-drive-mappings root\n"
24206 #: ../fish/guestfish-actions.pod:1811
24208 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
24209 "get-mountpoints>, L</inspect-get-filesystems>."
24213 #: ../fish/guestfish-actions.pod:1815
24214 msgid "inspect-get-filesystems"
24218 #: ../fish/guestfish-actions.pod:1817
24221 " inspect-get-filesystems root\n"
24226 #: ../fish/guestfish-actions.pod:1827
24228 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
24229 "get-mountpoints>."
24233 #: ../fish/guestfish-actions.pod:1830
24234 msgid "inspect-get-format"
24238 #: ../fish/guestfish-actions.pod:1832
24241 " inspect-get-format root\n"
24246 #: ../fish/guestfish-actions.pod:1861
24247 msgid "inspect-get-hostname"
24251 #: ../fish/guestfish-actions.pod:1863
24254 " inspect-get-hostname root\n"
24259 #: ../fish/guestfish-actions.pod:1873
24260 msgid "inspect-get-icon"
24264 #: ../fish/guestfish-actions.pod:1875
24267 " inspect-get-icon root [favicon:..] [highquality:..]\n"
24272 #: ../fish/guestfish-actions.pod:1939
24273 msgid "inspect-get-major-version"
24277 #: ../fish/guestfish-actions.pod:1941
24280 " inspect-get-major-version root\n"
24285 #: ../fish/guestfish-actions.pod:1957
24286 msgid "inspect-get-minor-version"
24290 #: ../fish/guestfish-actions.pod:1959
24293 " inspect-get-minor-version root\n"
24298 #: ../fish/guestfish-actions.pod:1966
24300 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
24301 "get-major-version>."
24305 #: ../fish/guestfish-actions.pod:1969
24306 msgid "inspect-get-mountpoints"
24310 #: ../fish/guestfish-actions.pod:1971
24313 " inspect-get-mountpoints root\n"
24318 #: ../fish/guestfish-actions.pod:1990
24320 "For operating systems like Windows which still use drive letters, this call "
24321 "will only return an entry for the first drive \"mounted on\" C</>. For "
24322 "information about the mapping of drive letters to partitions, see L</inspect-"
24323 "get-drive-mappings>."
24327 #: ../fish/guestfish-actions.pod:1996
24329 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
24330 "get-filesystems>."
24334 #: ../fish/guestfish-actions.pod:1999
24335 msgid "inspect-get-package-format"
24339 #: ../fish/guestfish-actions.pod:2001
24342 " inspect-get-package-format root\n"
24347 #: ../fish/guestfish-actions.pod:2003
24349 "This function and L</inspect-get-package-management> return the package "
24350 "format and package management tool used by the inspected operating system. "
24351 "For example for Fedora these functions would return C<rpm> (package format) "
24352 "and C<yum> (package management)."
24356 #: ../fish/guestfish-actions.pod:2018
24357 msgid "inspect-get-package-management"
24361 #: ../fish/guestfish-actions.pod:2020
24364 " inspect-get-package-management root\n"
24369 #: ../fish/guestfish-actions.pod:2022
24371 "L</inspect-get-package-format> and this function return the package format "
24372 "and package management tool used by the inspected operating system. For "
24373 "example for Fedora these functions would return C<rpm> (package format) and "
24374 "C<yum> (package management)."
24378 #: ../fish/guestfish-actions.pod:2039
24379 msgid "inspect-get-product-name"
24383 #: ../fish/guestfish-actions.pod:2041
24386 " inspect-get-product-name root\n"
24391 #: ../fish/guestfish-actions.pod:2053
24392 msgid "inspect-get-product-variant"
24396 #: ../fish/guestfish-actions.pod:2055
24399 " inspect-get-product-variant root\n"
24404 #: ../fish/guestfish-actions.pod:2076
24406 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
24407 "get-product-name>, L</inspect-get-major-version>."
24411 #: ../fish/guestfish-actions.pod:2080
24412 msgid "inspect-get-roots"
24416 #: ../fish/guestfish-actions.pod:2082
24419 " inspect-get-roots\n"
24424 #: ../fish/guestfish-actions.pod:2084
24426 "This function is a convenient way to get the list of root devices, as "
24427 "returned from a previous call to L</inspect-os>, but without redoing the "
24428 "whole inspection process."
24432 #: ../fish/guestfish-actions.pod:2088
24434 "This returns an empty list if either no root devices were found or the "
24435 "caller has not called L</inspect-os>."
24439 #: ../fish/guestfish-actions.pod:2093
24440 msgid "inspect-get-type"
24444 #: ../fish/guestfish-actions.pod:2095
24447 " inspect-get-type root\n"
24452 #: ../fish/guestfish-actions.pod:2125
24453 msgid "inspect-get-windows-current-control-set"
24457 #: ../fish/guestfish-actions.pod:2127
24460 " inspect-get-windows-current-control-set root\n"
24465 #: ../fish/guestfish-actions.pod:2138
24466 msgid "inspect-get-windows-systemroot"
24470 #: ../fish/guestfish-actions.pod:2140
24473 " inspect-get-windows-systemroot root\n"
24478 #: ../fish/guestfish-actions.pod:2151
24479 msgid "inspect-is-live"
24483 #: ../fish/guestfish-actions.pod:2153
24486 " inspect-is-live root\n"
24491 #: ../fish/guestfish-actions.pod:2155
24493 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
24494 "then this returns true if a live image was detected on the disk."
24498 #: ../fish/guestfish-actions.pod:2161
24499 msgid "inspect-is-multipart"
24503 #: ../fish/guestfish-actions.pod:2163
24506 " inspect-is-multipart root\n"
24511 #: ../fish/guestfish-actions.pod:2165
24513 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
24514 "then this returns true if the disk is part of a set."
24518 #: ../fish/guestfish-actions.pod:2171
24519 msgid "inspect-is-netinst"
24523 #: ../fish/guestfish-actions.pod:2173
24526 " inspect-is-netinst root\n"
24531 #: ../fish/guestfish-actions.pod:2175
24533 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
24534 "then this returns true if the disk is a network installer, ie. not a self-"
24535 "contained install CD but one which is likely to require network access to "
24536 "complete the install."
24540 #: ../fish/guestfish-actions.pod:2183
24541 msgid "inspect-list-applications"
24545 #: ../fish/guestfish-actions.pod:2185
24548 " inspect-list-applications root\n"
24553 #: ../fish/guestfish-actions.pod:2189
24555 "I<Note:> This call works differently from other parts of the inspection "
24556 "API. You have to call L</inspect-os>, then L</inspect-get-mountpoints>, "
24557 "then mount up the disks, before calling this. Listing applications is a "
24558 "significantly more difficult operation which requires access to the full "
24559 "filesystem. Also note that unlike the other L</inspect-get-*> calls which "
24560 "are just returning data cached in the libguestfs handle, this call actually "
24561 "reads parts of the mounted filesystems during the call."
24565 #: ../fish/guestfish-actions.pod:2279
24570 #: ../fish/guestfish-actions.pod:2281
24578 #: ../fish/guestfish-actions.pod:2296
24580 "You can pass the root string(s) returned to other L</inspect-get-*> "
24581 "functions in order to query further information about each operating system, "
24582 "such as the name and version."
24586 #: ../fish/guestfish-actions.pod:2301
24588 "This function uses other libguestfs features such as L</mount-ro> and L</"
24589 "umount-all> in order to mount and unmount filesystems and look at the "
24590 "contents. This should be called with no disks currently mounted. The "
24591 "function may also use Augeas, so any existing Augeas handle will be closed."
24595 #: ../fish/guestfish-actions.pod:2313 ../fish/guestfish-actions.pod:2511
24596 #: ../fish/guestfish-actions.pod:2557
24597 msgid "See also L</list-filesystems>."
24601 #: ../fish/guestfish-actions.pod:2315
24602 msgid "is-blockdev"
24606 #: ../fish/guestfish-actions.pod:2317
24609 " is-blockdev path\n"
24614 #: ../fish/guestfish-actions.pod:2322 ../fish/guestfish-actions.pod:2340
24615 #: ../fish/guestfish-actions.pod:2359 ../fish/guestfish-actions.pod:2368
24616 #: ../fish/guestfish-actions.pod:2378 ../fish/guestfish-actions.pod:2412
24617 #: ../fish/guestfish-actions.pod:2421
24618 msgid "See also L</stat>."
24622 #: ../fish/guestfish-actions.pod:2324
24627 #: ../fish/guestfish-actions.pod:2326
24635 #: ../fish/guestfish-actions.pod:2333
24640 #: ../fish/guestfish-actions.pod:2335
24643 " is-chardev path\n"
24648 #: ../fish/guestfish-actions.pod:2342
24653 #: ../fish/guestfish-actions.pod:2344
24661 #: ../fish/guestfish-actions.pod:2351
24666 #: ../fish/guestfish-actions.pod:2353
24674 #: ../fish/guestfish-actions.pod:2361
24679 #: ../fish/guestfish-actions.pod:2363
24687 #: ../fish/guestfish-actions.pod:2370
24692 #: ../fish/guestfish-actions.pod:2372
24700 #: ../fish/guestfish-actions.pod:2380
24701 msgid "is-launching"
24705 #: ../fish/guestfish-actions.pod:2382
24713 #: ../fish/guestfish-actions.pod:2389
24718 #: ../fish/guestfish-actions.pod:2391
24726 #: ../fish/guestfish-actions.pod:2396
24731 #: ../fish/guestfish-actions.pod:2398
24739 #: ../fish/guestfish-actions.pod:2405
24744 #: ../fish/guestfish-actions.pod:2407
24747 " is-socket path\n"
24752 #: ../fish/guestfish-actions.pod:2414
24757 #: ../fish/guestfish-actions.pod:2416
24760 " is-symlink path\n"
24765 #: ../fish/guestfish-actions.pod:2423
24770 #: ../fish/guestfish-actions.pod:2425
24778 #: ../fish/guestfish-actions.pod:2430
24779 msgid "is-zero-device"
24783 #: ../fish/guestfish-actions.pod:2432
24786 " is-zero-device device\n"
24791 #: ../fish/guestfish-actions.pod:2438
24792 msgid "kill-subprocess"
24796 #: ../fish/guestfish-actions.pod:2440
24799 " kill-subprocess\n"
24804 #: ../fish/guestfish-actions.pod:2444
24809 #: ../fish/guestfish-actions.pod:2446
24814 #: ../fish/guestfish-actions.pod:2448
24822 #: ../fish/guestfish-actions.pod:2456
24827 #: ../fish/guestfish-actions.pod:2458
24830 " lchown owner group path\n"
24835 #: ../fish/guestfish-actions.pod:2460
24837 "Change the file owner to C<owner> and group to C<group>. This is like L</"
24838 "chown> but if C<path> is a symlink then the link itself is changed, not the "
24843 #: ../fish/guestfish-actions.pod:2468
24848 #: ../fish/guestfish-actions.pod:2470
24851 " lgetxattr path name\n"
24856 #: ../fish/guestfish-actions.pod:2486
24857 msgid "See also: L</lgetxattrs>, L</getxattr>, L<attr(5)>."
24861 #: ../fish/guestfish-actions.pod:2488
24866 #: ../fish/guestfish-actions.pod:2490
24869 " lgetxattrs path\n"
24874 #: ../fish/guestfish-actions.pod:2492
24876 "This is the same as L</getxattrs>, but if C<path> is a symbolic link, then "
24877 "it returns the extended attributes of the link itself."
24881 #: ../fish/guestfish-actions.pod:2496
24886 #: ../fish/guestfish-actions.pod:2498
24894 #: ../fish/guestfish-actions.pod:2503
24895 msgid "list-devices"
24899 #: ../fish/guestfish-actions.pod:2505
24907 #: ../fish/guestfish-actions.pod:2513
24908 msgid "list-filesystems"
24912 #: ../fish/guestfish-actions.pod:2515
24915 " list-filesystems\n"
24920 #: ../fish/guestfish-actions.pod:2534
24922 "This command runs other libguestfs commands, which might include L</mount> "
24923 "and L</umount>, and therefore you should use this soon after launch and only "
24924 "when nothing is mounted."
24928 #: ../fish/guestfish-actions.pod:2538
24930 "Not all of the filesystems returned will be mountable. In particular, swap "
24931 "partitions are returned in the list. Also this command does not check that "
24932 "each filesystem found is valid and mountable, and some filesystems might be "
24933 "mountable but require special options. Filesystems may not all belong to a "
24934 "single logical operating system (use L</inspect-os> to look for OSes)."
24938 #: ../fish/guestfish-actions.pod:2546
24939 msgid "list-partitions"
24943 #: ../fish/guestfish-actions.pod:2548
24946 " list-partitions\n"
24951 #: ../fish/guestfish-actions.pod:2554
24953 "This does not return logical volumes. For that you will need to call L</"
24958 #: ../fish/guestfish-actions.pod:2559
24963 #: ../fish/guestfish-actions.pod:2561
24971 #: ../fish/guestfish-actions.pod:2569
24976 #: ../fish/guestfish-actions.pod:2571
24979 " ln target linkname\n"
24984 #: ../fish/guestfish-actions.pod:2575
24989 #: ../fish/guestfish-actions.pod:2577
24992 " ln-f target linkname\n"
24997 #: ../fish/guestfish-actions.pod:2582
25002 #: ../fish/guestfish-actions.pod:2584
25005 " ln-s target linkname\n"
25010 #: ../fish/guestfish-actions.pod:2588
25015 #: ../fish/guestfish-actions.pod:2590
25018 " ln-sf target linkname\n"
25023 #: ../fish/guestfish-actions.pod:2595
25024 msgid "lremovexattr"
25028 #: ../fish/guestfish-actions.pod:2597
25031 " lremovexattr xattr path\n"
25036 #: ../fish/guestfish-actions.pod:2599
25038 "This is the same as L</removexattr>, but if C<path> is a symbolic link, then "
25039 "it removes an extended attribute of the link itself."
25043 #: ../fish/guestfish-actions.pod:2603
25048 #: ../fish/guestfish-actions.pod:2605
25056 #: ../fish/guestfish-actions.pod:2611
25058 "This command is mostly useful for interactive sessions. Programs should "
25059 "probably use L</readdir> instead."
25063 #: ../fish/guestfish-actions.pod:2614
25068 #: ../fish/guestfish-actions.pod:2616
25071 " lsetxattr xattr val vallen path\n"
25076 #: ../fish/guestfish-actions.pod:2618
25078 "This is the same as L</setxattr>, but if C<path> is a symbolic link, then it "
25079 "sets an extended attribute of the link itself."
25083 #: ../fish/guestfish-actions.pod:2622
25088 #: ../fish/guestfish-actions.pod:2624
25096 #: ../fish/guestfish-actions.pod:2628
25098 "This is the same as L</stat> except that if C<path> is a symbolic link, then "
25099 "the link is stat-ed, not the file it refers to."
25103 #: ../fish/guestfish-actions.pod:2634
25108 #: ../fish/guestfish-actions.pod:2636
25111 " lstatlist path 'names ...'\n"
25116 #: ../fish/guestfish-actions.pod:2638
25118 "This call allows you to perform the L</lstat> operation on multiple files, "
25119 "where all files are in the directory C<path>. C<names> is the list of files "
25120 "from this directory."
25124 #: ../fish/guestfish-actions.pod:2647
25126 "This call is intended for programs that want to efficiently list a directory "
25127 "contents without making many round-trips. See also L</lxattrlist> for a "
25128 "similarly efficient call for getting extended attributes. Very long "
25129 "directory listings might cause the protocol message size to be exceeded, "
25130 "causing this call to fail. The caller must split up such requests into "
25131 "smaller groups of names."
25135 #: ../fish/guestfish-actions.pod:2655
25136 msgid "luks-add-key"
25140 #: ../fish/guestfish-actions.pod:2657
25143 " luks-add-key device keyslot\n"
25148 #: ../fish/guestfish-actions.pod:2664
25150 "Note that if C<keyslot> already contains a key, then this command will "
25151 "fail. You have to use L</luks-kill-slot> first to remove that key."
25155 #: ../fish/guestfish-actions.pod:2668 ../fish/guestfish-actions.pod:2690
25156 #: ../fish/guestfish-actions.pod:2703 ../fish/guestfish-actions.pod:2717
25157 #: ../fish/guestfish-actions.pod:2740 ../fish/guestfish-actions.pod:2750
25159 "This command has one or more key or passphrase parameters. Guestfish will "
25160 "prompt for these separately."
25164 #: ../fish/guestfish-actions.pod:2671
25169 #: ../fish/guestfish-actions.pod:2673
25172 " luks-close device\n"
25177 #: ../fish/guestfish-actions.pod:2675
25179 "This closes a LUKS device that was created earlier by L</luks-open> or L</"
25180 "luks-open-ro>. The C<device> parameter must be the name of the LUKS mapping "
25181 "device (ie. C</dev/mapper/mapname>) and I<not> the name of the underlying "
25186 #: ../fish/guestfish-actions.pod:2681
25187 msgid "luks-format"
25191 #: ../fish/guestfish-actions.pod:2683
25194 " luks-format device keyslot\n"
25199 #: ../fish/guestfish-actions.pod:2696
25200 msgid "luks-format-cipher"
25204 #: ../fish/guestfish-actions.pod:2698
25207 " luks-format-cipher device keyslot cipher\n"
25212 #: ../fish/guestfish-actions.pod:2700
25214 "This command is the same as L</luks-format> but it also allows you to set "
25215 "the C<cipher> used."
25219 #: ../fish/guestfish-actions.pod:2709
25220 msgid "luks-kill-slot"
25224 #: ../fish/guestfish-actions.pod:2711
25227 " luks-kill-slot device keyslot\n"
25232 #: ../fish/guestfish-actions.pod:2720
25237 #: ../fish/guestfish-actions.pod:2722
25240 " luks-open device mapname\n"
25245 #: ../fish/guestfish-actions.pod:2736
25247 "If this block device contains LVM volume groups, then calling L</vgscan> "
25248 "followed by L</vg-activate-all> will make them visible."
25252 #: ../fish/guestfish-actions.pod:2743
25253 msgid "luks-open-ro"
25257 #: ../fish/guestfish-actions.pod:2745
25260 " luks-open-ro device mapname\n"
25265 #: ../fish/guestfish-actions.pod:2747
25267 "This is the same as L</luks-open> except that a read-only mapping is created."
25271 #: ../fish/guestfish-actions.pod:2753
25276 #: ../fish/guestfish-actions.pod:2755
25279 " lvcreate logvol volgroup mbytes\n"
25284 #: ../fish/guestfish-actions.pod:2760
25285 msgid "lvm-canonical-lv-name"
25289 #: ../fish/guestfish-actions.pod:2762
25292 " lvm-canonical-lv-name lvname\n"
25297 #: ../fish/guestfish-actions.pod:2771
25298 msgid "See also L</is-lv>."
25302 #: ../fish/guestfish-actions.pod:2773
25303 msgid "lvm-clear-filter"
25307 #: ../fish/guestfish-actions.pod:2775
25310 " lvm-clear-filter\n"
25315 #: ../fish/guestfish-actions.pod:2777
25317 "This undoes the effect of L</lvm-set-filter>. LVM will be able to see every "
25322 #: ../fish/guestfish-actions.pod:2783
25323 msgid "lvm-remove-all"
25327 #: ../fish/guestfish-actions.pod:2785
25330 " lvm-remove-all\n"
25335 #: ../fish/guestfish-actions.pod:2793
25336 msgid "lvm-set-filter"
25340 #: ../fish/guestfish-actions.pod:2795
25343 " lvm-set-filter 'devices ...'\n"
25348 #: ../fish/guestfish-actions.pod:2820
25353 #: ../fish/guestfish-actions.pod:2822
25356 " lvremove device\n"
25361 #: ../fish/guestfish-actions.pod:2830
25366 #: ../fish/guestfish-actions.pod:2832
25369 " lvrename logvol newlogvol\n"
25374 #: ../fish/guestfish-actions.pod:2836
25379 #: ../fish/guestfish-actions.pod:2838
25382 " lvresize device mbytes\n"
25387 #: ../fish/guestfish-actions.pod:2844
25388 msgid "lvresize-free"
25392 #: ../fish/guestfish-actions.pod:2846
25395 " lvresize-free lv percent\n"
25400 #: ../fish/guestfish-actions.pod:2854
25405 #: ../fish/guestfish-actions.pod:2856
25413 #: ../fish/guestfish-actions.pod:2864
25414 msgid "See also L</lvs-full>, L</list-filesystems>."
25418 #: ../fish/guestfish-actions.pod:2866
25423 #: ../fish/guestfish-actions.pod:2868
25431 #: ../fish/guestfish-actions.pod:2873
25436 #: ../fish/guestfish-actions.pod:2875
25444 #: ../fish/guestfish-actions.pod:2879
25449 #: ../fish/guestfish-actions.pod:2881
25452 " lxattrlist path 'names ...'\n"
25457 #: ../fish/guestfish-actions.pod:2897
25459 "This call is intended for programs that want to efficiently list a directory "
25460 "contents without making many round-trips. See also L</lstatlist> for a "
25461 "similarly efficient call for getting standard stats. Very long directory "
25462 "listings might cause the protocol message size to be exceeded, causing this "
25463 "call to fail. The caller must split up such requests into smaller groups of "
25468 #: ../fish/guestfish-actions.pod:2905
25473 #: ../fish/guestfish-actions.pod:2907
25481 #: ../fish/guestfish-actions.pod:2911
25486 #: ../fish/guestfish-actions.pod:2913
25489 " mkdir-mode path mode\n"
25494 #: ../fish/guestfish-actions.pod:2922
25495 msgid "See also L</mkdir>, L</umask>"
25499 #: ../fish/guestfish-actions.pod:2924
25504 #: ../fish/guestfish-actions.pod:2926
25512 #: ../fish/guestfish-actions.pod:2931
25517 #: ../fish/guestfish-actions.pod:2933
25520 " mkdtemp template\n"
25525 #: ../fish/guestfish-actions.pod:2954
25530 #: ../fish/guestfish-actions.pod:2956
25533 " mke2fs-J fstype blocksize device journal\n"
25538 #: ../fish/guestfish-actions.pod:2964
25539 msgid "See also L</mke2journal>."
25543 #: ../fish/guestfish-actions.pod:2966
25548 #: ../fish/guestfish-actions.pod:2968
25551 " mke2fs-JL fstype blocksize device label\n"
25556 #: ../fish/guestfish-actions.pod:2973
25557 msgid "See also L</mke2journal-L>."
25561 #: ../fish/guestfish-actions.pod:2975
25566 #: ../fish/guestfish-actions.pod:2977
25569 " mke2fs-JU fstype blocksize device uuid\n"
25574 #: ../fish/guestfish-actions.pod:2982
25575 msgid "See also L</mke2journal-U>."
25579 #: ../fish/guestfish-actions.pod:2984
25580 msgid "mke2journal"
25584 #: ../fish/guestfish-actions.pod:2986
25587 " mke2journal blocksize device\n"
25592 #: ../fish/guestfish-actions.pod:2993
25593 msgid "mke2journal-L"
25597 #: ../fish/guestfish-actions.pod:2995
25600 " mke2journal-L blocksize label device\n"
25605 #: ../fish/guestfish-actions.pod:2999
25606 msgid "mke2journal-U"
25610 #: ../fish/guestfish-actions.pod:3001
25613 " mke2journal-U blocksize uuid device\n"
25618 #: ../fish/guestfish-actions.pod:3005
25623 #: ../fish/guestfish-actions.pod:3007
25626 " mkfifo mode path\n"
25631 #: ../fish/guestfish-actions.pod:3009
25633 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
25634 "is just a convenient wrapper around L</mknod>."
25638 #: ../fish/guestfish-actions.pod:3015
25643 #: ../fish/guestfish-actions.pod:3017
25646 " mkfs fstype device\n"
25651 #: ../fish/guestfish-actions.pod:3023
25656 #: ../fish/guestfish-actions.pod:3025
25659 " mkfs-b fstype blocksize device\n"
25664 #: ../fish/guestfish-actions.pod:3027
25666 "This call is similar to L</mkfs>, but it allows you to control the block "
25667 "size of the resulting filesystem. Supported block sizes depend on the "
25668 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
25672 #: ../fish/guestfish-actions.pod:3042
25677 #: ../fish/guestfish-actions.pod:3044
25680 " mkfs-opts fstype device [blocksize:..] [features:..]\n"
25685 #: ../fish/guestfish-actions.pod:3079
25686 msgid "mkmountpoint"
25690 #: ../fish/guestfish-actions.pod:3081
25693 " mkmountpoint exemptpath\n"
25698 #: ../fish/guestfish-actions.pod:3083
25700 "L</mkmountpoint> and L</rmmountpoint> are specialized calls that can be used "
25701 "to create extra mountpoints before mounting the first filesystem."
25705 #: ../fish/guestfish-actions.pod:3107
25707 "L</mkmountpoint> is not compatible with L</umount-all>. You may get "
25708 "unexpected errors if you try to mix these calls. It is safest to manually "
25709 "unmount filesystems and remove mountpoints after use."
25713 #: ../fish/guestfish-actions.pod:3111
25715 "L</umount-all> unmounts filesystems by sorting the paths longest first, so "
25716 "for this to work for manual mountpoints, you must ensure that the innermost "
25717 "mountpoints have the longest pathnames, as in the example code above."
25721 #: ../fish/guestfish-actions.pod:3118
25723 "Autosync [see L</set-autosync>, this is set by default on handles] can cause "
25724 "L</umount-all> to be called when the handle is closed which can also trigger "
25729 #: ../fish/guestfish-actions.pod:3122
25734 #: ../fish/guestfish-actions.pod:3124
25737 " mknod mode devmajor devminor path\n"
25742 #: ../fish/guestfish-actions.pod:3134
25744 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
25745 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
25746 "regular file). These constants are available in the standard Linux header "
25747 "files, or you can use L</mknod-b>, L</mknod-c> or L</mkfifo> which are "
25748 "wrappers around this command which bitwise OR in the appropriate constant "
25753 #: ../fish/guestfish-actions.pod:3144
25758 #: ../fish/guestfish-actions.pod:3146
25761 " mknod-b mode devmajor devminor path\n"
25766 #: ../fish/guestfish-actions.pod:3148
25768 "This call creates a block device node called C<path> with mode C<mode> and "
25769 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
25770 "wrapper around L</mknod>."
25774 #: ../fish/guestfish-actions.pod:3154
25779 #: ../fish/guestfish-actions.pod:3156
25782 " mknod-c mode devmajor devminor path\n"
25787 #: ../fish/guestfish-actions.pod:3158
25789 "This call creates a char device node called C<path> with mode C<mode> and "
25790 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
25791 "wrapper around L</mknod>."
25795 #: ../fish/guestfish-actions.pod:3164
25800 #: ../fish/guestfish-actions.pod:3166
25808 #: ../fish/guestfish-actions.pod:3170
25813 #: ../fish/guestfish-actions.pod:3172
25816 " mkswap-L label device\n"
25821 #: ../fish/guestfish-actions.pod:3180
25826 #: ../fish/guestfish-actions.pod:3182
25829 " mkswap-U uuid device\n"
25834 #: ../fish/guestfish-actions.pod:3186
25835 msgid "mkswap-file"
25839 #: ../fish/guestfish-actions.pod:3188
25842 " mkswap-file path\n"
25847 #: ../fish/guestfish-actions.pod:3192
25849 "This command just writes a swap file signature to an existing file. To "
25850 "create the file itself, use something like L</fallocate>."
25854 #: ../fish/guestfish-actions.pod:3195
25859 #: ../fish/guestfish-actions.pod:3197
25862 " modprobe modulename\n"
25867 #: ../fish/guestfish-actions.pod:3204
25872 #: ../fish/guestfish-actions.pod:3206
25875 " mount device mountpoint\n"
25880 #: ../fish/guestfish-actions.pod:3222
25882 "B<Important note:> When you use this call, the filesystem options C<sync> "
25883 "and C<noatime> are set implicitly. This was originally done because we "
25884 "thought it would improve reliability, but it turns out that I<-o sync> has a "
25885 "very large negative performance impact and negligible effect on "
25886 "reliability. Therefore we recommend that you avoid using L</mount> in any "
25887 "code that needs performance, and instead use L</mount-options> (use an empty "
25888 "string for the first parameter if you don't want any options)."
25892 #: ../fish/guestfish-actions.pod:3239
25897 #: ../fish/guestfish-actions.pod:3241
25900 " mount-9p mounttag mountpoint [options:..]\n"
25905 #: ../fish/guestfish-actions.pod:3252
25910 #: ../fish/guestfish-actions.pod:3254
25913 " mount-loop file mountpoint\n"
25918 #: ../fish/guestfish-actions.pod:3260
25919 msgid "mount-options"
25923 #: ../fish/guestfish-actions.pod:3262
25926 " mount-options options device mountpoint\n"
25931 #: ../fish/guestfish-actions.pod:3264
25933 "This is the same as the L</mount> command, but it allows you to set the "
25934 "mount options as for the L<mount(8)> I<-o> flag."
25938 #: ../fish/guestfish-actions.pod:3272
25943 #: ../fish/guestfish-actions.pod:3274
25946 " mount-ro device mountpoint\n"
25951 #: ../fish/guestfish-actions.pod:3276
25953 "This is the same as the L</mount> command, but it mounts the filesystem with "
25954 "the read-only (I<-o ro>) flag."
25958 #: ../fish/guestfish-actions.pod:3279
25963 #: ../fish/guestfish-actions.pod:3281
25966 " mount-vfs options vfstype device mountpoint\n"
25971 #: ../fish/guestfish-actions.pod:3283
25973 "This is the same as the L</mount> command, but it allows you to set both the "
25974 "mount options and the vfstype as for the L<mount(8)> I<-o> and I<-t> flags."
25978 #: ../fish/guestfish-actions.pod:3287
25979 msgid "mountpoints"
25983 #: ../fish/guestfish-actions.pod:3289
25991 #: ../fish/guestfish-actions.pod:3291
25993 "This call is similar to L</mounts>. That call returns a list of devices. "
25994 "This one returns a hash table (map) of device name to directory where the "
25995 "device is mounted."
25999 #: ../fish/guestfish-actions.pod:3295
26004 #: ../fish/guestfish-actions.pod:3297
26012 #: ../fish/guestfish-actions.pod:3304
26013 msgid "See also: L</mountpoints>"
26017 #: ../fish/guestfish-actions.pod:3306
26022 #: ../fish/guestfish-actions.pod:3308
26030 #: ../fish/guestfish-actions.pod:3313
26031 msgid "ntfs-3g-probe"
26035 #: ../fish/guestfish-actions.pod:3315
26038 " ntfs-3g-probe true|false device\n"
26043 #: ../fish/guestfish-actions.pod:3329
26048 #: ../fish/guestfish-actions.pod:3331
26051 " ntfsresize device\n"
26056 #: ../fish/guestfish-actions.pod:3337
26057 msgid "ntfsresize-size"
26061 #: ../fish/guestfish-actions.pod:3339
26064 " ntfsresize-size device size\n"
26069 #: ../fish/guestfish-actions.pod:3341
26071 "This command is the same as L</ntfsresize> except that it allows you to "
26072 "specify the new size (in bytes) explicitly."
26076 #: ../fish/guestfish-actions.pod:3344
26081 #: ../fish/guestfish-actions.pod:3346
26084 " part-add device prlogex startsect endsect\n"
26089 #: ../fish/guestfish-actions.pod:3348
26091 "This command adds a partition to C<device>. If there is no partition table "
26092 "on the device, call L</part-init> first."
26096 #: ../fish/guestfish-actions.pod:3360
26098 "Creating a partition which covers the whole disk is not so easy. Use L</"
26099 "part-disk> to do that."
26103 #: ../fish/guestfish-actions.pod:3363
26108 #: ../fish/guestfish-actions.pod:3365
26111 " part-del device partnum\n"
26116 #: ../fish/guestfish-actions.pod:3373
26121 #: ../fish/guestfish-actions.pod:3375
26124 " part-disk device parttype\n"
26129 #: ../fish/guestfish-actions.pod:3377
26131 "This command is simply a combination of L</part-init> followed by L</part-"
26132 "add> to create a single primary partition covering the whole disk."
26136 #: ../fish/guestfish-actions.pod:3381
26138 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
26139 "possible values are described in L</part-init>."
26143 #: ../fish/guestfish-actions.pod:3387
26144 msgid "part-get-bootable"
26148 #: ../fish/guestfish-actions.pod:3389
26151 " part-get-bootable device partnum\n"
26156 #: ../fish/guestfish-actions.pod:3394
26157 msgid "See also L</part-set-bootable>."
26161 #: ../fish/guestfish-actions.pod:3396
26162 msgid "part-get-mbr-id"
26166 #: ../fish/guestfish-actions.pod:3398
26169 " part-get-mbr-id device partnum\n"
26174 #: ../fish/guestfish-actions.pod:3403 ../fish/guestfish-actions.pod:3541
26176 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
26177 "undefined results for other partition table types (see L</part-get-"
26182 #: ../fish/guestfish-actions.pod:3407
26183 msgid "part-get-parttype"
26187 #: ../fish/guestfish-actions.pod:3409
26190 " part-get-parttype device\n"
26195 #: ../fish/guestfish-actions.pod:3414
26197 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
26198 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
26199 "possible, although unusual. See L</part-init> for a full list."
26203 #: ../fish/guestfish-actions.pod:3419
26208 #: ../fish/guestfish-actions.pod:3421
26211 " part-init device parttype\n"
26216 #: ../fish/guestfish-actions.pod:3427
26218 "Initially there are no partitions. Following this, you should call L</part-"
26219 "add> for each partition required."
26223 #: ../fish/guestfish-actions.pod:3490
26228 #: ../fish/guestfish-actions.pod:3492
26231 " part-list device\n"
26236 #: ../fish/guestfish-actions.pod:3507
26238 "Start of the partition I<in bytes>. To get sectors you have to divide by "
26239 "the device's sector size, see L</blockdev-getss>."
26243 #: ../fish/guestfish-actions.pod:3520
26244 msgid "part-set-bootable"
26248 #: ../fish/guestfish-actions.pod:3522
26251 " part-set-bootable device partnum true|false\n"
26256 #: ../fish/guestfish-actions.pod:3531
26257 msgid "part-set-mbr-id"
26261 #: ../fish/guestfish-actions.pod:3533
26264 " part-set-mbr-id device partnum idbyte\n"
26269 #: ../fish/guestfish-actions.pod:3545
26270 msgid "part-set-name"
26274 #: ../fish/guestfish-actions.pod:3547
26277 " part-set-name device partnum name\n"
26282 #: ../fish/guestfish-actions.pod:3555
26283 msgid "part-to-dev"
26287 #: ../fish/guestfish-actions.pod:3557
26290 " part-to-dev partition\n"
26295 #: ../fish/guestfish-actions.pod:3563
26297 "The named partition must exist, for example as a string returned from L</"
26298 "list-partitions>."
26302 #: ../fish/guestfish-actions.pod:3566
26303 msgid "ping-daemon"
26307 #: ../fish/guestfish-actions.pod:3568
26315 #: ../fish/guestfish-actions.pod:3575
26320 #: ../fish/guestfish-actions.pod:3577
26323 " pread path count offset\n"
26328 #: ../fish/guestfish-actions.pod:3585
26329 msgid "See also L</pwrite>, L</pread-device>."
26333 #: ../fish/guestfish-actions.pod:3590
26334 msgid "pread-device"
26338 #: ../fish/guestfish-actions.pod:3592
26341 " pread-device device count offset\n"
26346 #: ../fish/guestfish-actions.pod:3600
26347 msgid "See also L</pread>."
26351 #: ../fish/guestfish-actions.pod:3605
26356 #: ../fish/guestfish-actions.pod:3607
26359 " pvcreate device\n"
26364 #: ../fish/guestfish-actions.pod:3613
26369 #: ../fish/guestfish-actions.pod:3615
26372 " pvremove device\n"
26377 #: ../fish/guestfish-actions.pod:3624
26382 #: ../fish/guestfish-actions.pod:3626
26385 " pvresize device\n"
26390 #: ../fish/guestfish-actions.pod:3631
26391 msgid "pvresize-size"
26395 #: ../fish/guestfish-actions.pod:3633
26398 " pvresize-size device size\n"
26403 #: ../fish/guestfish-actions.pod:3635
26405 "This command is the same as L</pvresize> except that it allows you to "
26406 "specify the new size (in bytes) explicitly."
26410 #: ../fish/guestfish-actions.pod:3638
26415 #: ../fish/guestfish-actions.pod:3640
26423 #: ../fish/guestfish-actions.pod:3648
26424 msgid "See also L</pvs-full>."
26428 #: ../fish/guestfish-actions.pod:3650
26433 #: ../fish/guestfish-actions.pod:3652
26441 #: ../fish/guestfish-actions.pod:3657
26446 #: ../fish/guestfish-actions.pod:3659
26454 #: ../fish/guestfish-actions.pod:3663
26459 #: ../fish/guestfish-actions.pod:3665
26462 " pwrite path content offset\n"
26467 #: ../fish/guestfish-actions.pod:3676
26468 msgid "See also L</pread>, L</pwrite-device>."
26472 #: ../fish/guestfish-actions.pod:3681
26473 msgid "pwrite-device"
26477 #: ../fish/guestfish-actions.pod:3683
26480 " pwrite-device device content offset\n"
26485 #: ../fish/guestfish-actions.pod:3693
26486 msgid "See also L</pwrite>."
26490 #: ../fish/guestfish-actions.pod:3698
26495 #: ../fish/guestfish-actions.pod:3700
26498 " read-file path\n"
26503 #: ../fish/guestfish-actions.pod:3705
26505 "Unlike L</cat>, this function can correctly handle files that contain "
26506 "embedded ASCII NUL characters. However unlike L</download>, this function "
26507 "is limited in the total size of file that can be handled."
26511 #: ../fish/guestfish-actions.pod:3713
26516 #: ../fish/guestfish-actions.pod:3715
26519 " read-lines path\n"
26524 #: ../fish/guestfish-actions.pod:3722
26526 "Note that this function cannot correctly handle binary files (specifically, "
26527 "files containing C<\\0> character which is treated as end of line). For "
26528 "those you need to use the L</read-file> function which has a more complex "
26533 #: ../fish/guestfish-actions.pod:3727
26538 #: ../fish/guestfish-actions.pod:3729
26546 #: ../fish/guestfish-actions.pod:3781
26548 "This function is primarily intended for use by programs. To get a simple "
26549 "list of names, use L</ls>. To get a printable directory for human "
26550 "consumption, use L</ll>."
26554 #: ../fish/guestfish-actions.pod:3785
26559 #: ../fish/guestfish-actions.pod:3787
26567 #: ../fish/guestfish-actions.pod:3791
26568 msgid "readlinklist"
26572 #: ../fish/guestfish-actions.pod:3793
26575 " readlinklist path 'names ...'\n"
26580 #: ../fish/guestfish-actions.pod:3817
26585 #: ../fish/guestfish-actions.pod:3819
26593 #: ../fish/guestfish-actions.pod:3824
26594 msgid "removexattr"
26598 #: ../fish/guestfish-actions.pod:3826
26601 " removexattr xattr path\n"
26606 #: ../fish/guestfish-actions.pod:3831
26607 msgid "See also: L</lremovexattr>, L<attr(5)>."
26611 #: ../fish/guestfish-actions.pod:3833
26616 #: ../fish/guestfish-actions.pod:3835
26619 " resize2fs device\n"
26624 #: ../fish/guestfish-actions.pod:3840
26626 "I<Note:> It is sometimes required that you run L</e2fsck-f> on the C<device> "
26627 "before calling this command. For unknown reasons C<resize2fs> sometimes "
26628 "gives an error about this and sometimes not. In any case, it is always safe "
26629 "to call L</e2fsck-f> before calling this function."
26633 #: ../fish/guestfish-actions.pod:3846
26634 msgid "resize2fs-M"
26638 #: ../fish/guestfish-actions.pod:3848
26641 " resize2fs-M device\n"
26646 #: ../fish/guestfish-actions.pod:3850
26648 "This command is the same as L</resize2fs>, but the filesystem is resized to "
26649 "its minimum size. This works like the I<-M> option to the C<resize2fs> "
26654 #: ../fish/guestfish-actions.pod:3854
26656 "To get the resulting size of the filesystem you should call L</tune2fs-l> "
26657 "and read the C<Block size> and C<Block count> values. These two numbers, "
26658 "multiplied together, give the resulting size of the minimal filesystem in "
26663 #: ../fish/guestfish-actions.pod:3859
26664 msgid "resize2fs-size"
26668 #: ../fish/guestfish-actions.pod:3861
26671 " resize2fs-size device size\n"
26676 #: ../fish/guestfish-actions.pod:3863
26678 "This command is the same as L</resize2fs> except that it allows you to "
26679 "specify the new size (in bytes) explicitly."
26683 #: ../fish/guestfish-actions.pod:3866
26688 #: ../fish/guestfish-actions.pod:3868
26696 #: ../fish/guestfish-actions.pod:3872
26701 #: ../fish/guestfish-actions.pod:3874
26709 #: ../fish/guestfish-actions.pod:3880
26714 #: ../fish/guestfish-actions.pod:3882
26722 #: ../fish/guestfish-actions.pod:3886
26723 msgid "rmmountpoint"
26727 #: ../fish/guestfish-actions.pod:3888
26730 " rmmountpoint exemptpath\n"
26735 #: ../fish/guestfish-actions.pod:3890
26737 "This calls removes a mountpoint that was previously created with L</"
26738 "mkmountpoint>. See L</mkmountpoint> for full details."
26742 #: ../fish/guestfish-actions.pod:3894
26743 msgid "scrub-device"
26747 #: ../fish/guestfish-actions.pod:3896
26750 " scrub-device device\n"
26755 #: ../fish/guestfish-actions.pod:3907
26760 #: ../fish/guestfish-actions.pod:3909
26763 " scrub-file file\n"
26768 #: ../fish/guestfish-actions.pod:3919
26769 msgid "scrub-freespace"
26773 #: ../fish/guestfish-actions.pod:3921
26776 " scrub-freespace dir\n"
26781 #: ../fish/guestfish-actions.pod:3923
26783 "This command creates the directory C<dir> and then fills it with files until "
26784 "the filesystem is full, and scrubs the files as for L</scrub-file>, and "
26785 "deletes them. The intention is to scrub any free space on the partition "
26786 "containing C<dir>."
26790 #: ../fish/guestfish-actions.pod:3932
26795 #: ../fish/guestfish-actions.pod:3934
26800 #: ../fish/guestfish-actions.pod:3936
26803 " set-append append\n"
26808 #: ../fish/guestfish-actions.pod:3947
26809 msgid "set-attach-method"
26813 #: ../fish/guestfish-actions.pod:3949
26814 msgid "attach-method"
26818 #: ../fish/guestfish-actions.pod:3951
26821 " set-attach-method attachmethod\n"
26826 #: ../fish/guestfish-actions.pod:3973
26827 msgid "set-autosync"
26831 #: ../fish/guestfish-actions.pod:3975
26836 #: ../fish/guestfish-actions.pod:3977
26839 " set-autosync true|false\n"
26844 #: ../fish/guestfish-actions.pod:3987
26849 #: ../fish/guestfish-actions.pod:3989
26854 #: ../fish/guestfish-actions.pod:3991
26857 " set-direct true|false\n"
26862 #: ../fish/guestfish-actions.pod:3997
26864 "One consequence of this is that log messages aren't caught by the library "
26865 "and handled by L</set-log-message-callback>, but go straight to stdout."
26869 #: ../fish/guestfish-actions.pod:4006
26870 msgid "set-e2label"
26874 #: ../fish/guestfish-actions.pod:4008
26877 " set-e2label device label\n"
26882 #: ../fish/guestfish-actions.pod:4014
26884 "You can use either L</tune2fs-l> or L</get-e2label> to return the existing "
26885 "label on a filesystem."
26889 #: ../fish/guestfish-actions.pod:4017
26894 #: ../fish/guestfish-actions.pod:4019
26897 " set-e2uuid device uuid\n"
26902 #: ../fish/guestfish-actions.pod:4026
26904 "You can use either L</tune2fs-l> or L</get-e2uuid> to return the existing "
26905 "UUID of a filesystem."
26909 #: ../fish/guestfish-actions.pod:4029
26910 msgid "set-memsize"
26914 #: ../fish/guestfish-actions.pod:4031
26919 #: ../fish/guestfish-actions.pod:4033
26922 " set-memsize memsize\n"
26927 #: ../fish/guestfish-actions.pod:4035
26929 "This sets the memory size in megabytes allocated to the qemu subprocess. "
26930 "This only has any effect if called before L</launch>."
26934 #: ../fish/guestfish-actions.pod:4046
26935 msgid "set-network"
26939 #: ../fish/guestfish-actions.pod:4048
26944 #: ../fish/guestfish-actions.pod:4050
26947 " set-network true|false\n"
26952 #: ../fish/guestfish-actions.pod:4058
26954 "You must call this before calling L</launch>, otherwise it has no effect."
26958 #: ../fish/guestfish-actions.pod:4061
26963 #: ../fish/guestfish-actions.pod:4063
26968 #: ../fish/guestfish-actions.pod:4065
26971 " set-path searchpath\n"
26976 #: ../fish/guestfish-actions.pod:4074
26981 #: ../fish/guestfish-actions.pod:4076
26986 #: ../fish/guestfish-actions.pod:4078
26994 #: ../fish/guestfish-actions.pod:4098
26995 msgid "set-recovery-proc"
26999 #: ../fish/guestfish-actions.pod:4100
27000 msgid "recovery-proc"
27004 #: ../fish/guestfish-actions.pod:4102
27007 " set-recovery-proc true|false\n"
27012 #: ../fish/guestfish-actions.pod:4104
27014 "If this is called with the parameter C<false> then L</launch> does not "
27015 "create a recovery process. The purpose of the recovery process is to stop "
27016 "runaway qemu processes in the case where the main program aborts abruptly."
27020 #: ../fish/guestfish-actions.pod:4109
27022 "This only has any effect if called before L</launch>, and the default is "
27027 #: ../fish/guestfish-actions.pod:4118
27028 msgid "set-selinux"
27032 #: ../fish/guestfish-actions.pod:4120
27037 #: ../fish/guestfish-actions.pod:4122
27040 " set-selinux true|false\n"
27045 #: ../fish/guestfish-actions.pod:4133
27050 #: ../fish/guestfish-actions.pod:4135
27055 #: ../fish/guestfish-actions.pod:4137
27058 " set-trace true|false\n"
27063 #: ../fish/guestfish-actions.pod:4149
27065 "Trace messages are normally sent to C<stderr>, unless you register a "
27066 "callback to send them somewhere else (see L</set-event-callback>)."
27070 #: ../fish/guestfish-actions.pod:4153
27071 msgid "set-verbose"
27075 #: ../fish/guestfish-actions.pod:4155
27080 #: ../fish/guestfish-actions.pod:4157
27083 " set-verbose true|false\n"
27088 #: ../fish/guestfish-actions.pod:4164
27090 "Verbose messages are normally sent to C<stderr>, unless you register a "
27091 "callback to send them somewhere else (see L</set-event-callback>)."
27095 #: ../fish/guestfish-actions.pod:4168
27100 #: ../fish/guestfish-actions.pod:4170
27103 " setcon context\n"
27108 #: ../fish/guestfish-actions.pod:4177
27113 #: ../fish/guestfish-actions.pod:4179
27116 " setxattr xattr val vallen path\n"
27121 #: ../fish/guestfish-actions.pod:4185
27122 msgid "See also: L</lsetxattr>, L<attr(5)>."
27126 #: ../fish/guestfish-actions.pod:4187
27131 #: ../fish/guestfish-actions.pod:4189
27134 " sfdisk device cyls heads sectors 'lines ...'\n"
27139 #: ../fish/guestfish-actions.pod:4211
27140 msgid "See also: L</sfdisk-l>, L</sfdisk-N>, L</part-init>"
27144 #: ../fish/guestfish-actions.pod:4224
27149 #: ../fish/guestfish-actions.pod:4226
27152 " sfdiskM device 'lines ...'\n"
27157 #: ../fish/guestfish-actions.pod:4228
27159 "This is a simplified interface to the L</sfdisk> command, where partition "
27160 "sizes are specified in megabytes only (rounded to the nearest cylinder) and "
27161 "you don't need to specify the cyls, heads and sectors parameters which were "
27162 "rarely if ever used anyway."
27166 #: ../fish/guestfish-actions.pod:4234
27167 msgid "See also: L</sfdisk>, the L<sfdisk(8)> manpage and L</part-disk>"
27171 #: ../fish/guestfish-actions.pod:4247
27176 #: ../fish/guestfish-actions.pod:4249
27179 " sfdisk-N device partnum cyls heads sectors line\n"
27184 #: ../fish/guestfish-actions.pod:4254
27186 "For other parameters, see L</sfdisk>. You should usually pass C<0> for the "
27187 "cyls/heads/sectors parameters."
27191 #: ../fish/guestfish-actions.pod:4257
27192 msgid "See also: L</part-add>"
27196 #: ../fish/guestfish-actions.pod:4269
27197 msgid "sfdisk-disk-geometry"
27201 #: ../fish/guestfish-actions.pod:4271
27204 " sfdisk-disk-geometry device\n"
27209 #: ../fish/guestfish-actions.pod:4273
27211 "This displays the disk geometry of C<device> read from the partition table. "
27212 "Especially in the case where the underlying block device has been resized, "
27213 "this can be different from the kernel's idea of the geometry (see L</sfdisk-"
27214 "kernel-geometry>)."
27218 #: ../fish/guestfish-actions.pod:4281
27219 msgid "sfdisk-kernel-geometry"
27223 #: ../fish/guestfish-actions.pod:4283
27226 " sfdisk-kernel-geometry device\n"
27231 #: ../fish/guestfish-actions.pod:4290
27236 #: ../fish/guestfish-actions.pod:4292
27239 " sfdisk-l device\n"
27244 #: ../fish/guestfish-actions.pod:4298
27245 msgid "See also: L</part-list>"
27249 #: ../fish/guestfish-actions.pod:4307
27254 #: ../fish/guestfish-actions.pod:4309
27262 #: ../fish/guestfish-actions.pod:4314
27263 msgid "This is like L</command>, but passes the command to:"
27267 #: ../fish/guestfish-actions.pod:4322
27268 msgid "All the provisos about L</command> apply to this call."
27272 #: ../fish/guestfish-actions.pod:4324
27277 #: ../fish/guestfish-actions.pod:4326
27280 " sh-lines command\n"
27285 #: ../fish/guestfish-actions.pod:4328
27286 msgid "This is the same as L</sh>, but splits the result into a list of lines."
27290 #: ../fish/guestfish-actions.pod:4331
27291 msgid "See also: L</command-lines>"
27295 #: ../fish/guestfish-actions.pod:4333
27300 #: ../fish/guestfish-actions.pod:4335
27308 #: ../fish/guestfish-actions.pod:4339
27313 #: ../fish/guestfish-actions.pod:4341
27321 #: ../fish/guestfish-actions.pod:4347
27326 #: ../fish/guestfish-actions.pod:4349
27334 #: ../fish/guestfish-actions.pod:4357
27339 #: ../fish/guestfish-actions.pod:4359
27347 #: ../fish/guestfish-actions.pod:4367
27352 #: ../fish/guestfish-actions.pod:4369
27355 " strings-e encoding path\n"
27360 #: ../fish/guestfish-actions.pod:4371
27362 "This is like the L</strings> command, but allows you to specify the encoding "
27363 "of strings that are looked for in the source file C<path>."
27367 #: ../fish/guestfish-actions.pod:4381
27369 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
27370 "ISO-8859-X (this is what L</strings> uses)."
27374 #: ../fish/guestfish-actions.pod:4413
27375 msgid "swapoff-device"
27379 #: ../fish/guestfish-actions.pod:4415
27382 " swapoff-device device\n"
27387 #: ../fish/guestfish-actions.pod:4417
27389 "This command disables the libguestfs appliance swap device or partition "
27390 "named C<device>. See L</swapon-device>."
27394 #: ../fish/guestfish-actions.pod:4421
27395 msgid "swapoff-file"
27399 #: ../fish/guestfish-actions.pod:4423
27402 " swapoff-file file\n"
27407 #: ../fish/guestfish-actions.pod:4427
27408 msgid "swapoff-label"
27412 #: ../fish/guestfish-actions.pod:4429
27415 " swapoff-label label\n"
27420 #: ../fish/guestfish-actions.pod:4434
27421 msgid "swapoff-uuid"
27425 #: ../fish/guestfish-actions.pod:4436
27428 " swapoff-uuid uuid\n"
27433 #: ../fish/guestfish-actions.pod:4441
27434 msgid "swapon-device"
27438 #: ../fish/guestfish-actions.pod:4443
27441 " swapon-device device\n"
27446 #: ../fish/guestfish-actions.pod:4445
27448 "This command enables the libguestfs appliance to use the swap device or "
27449 "partition named C<device>. The increased memory is made available for all "
27450 "commands, for example those run using L</command> or L</sh>."
27454 #: ../fish/guestfish-actions.pod:4457
27455 msgid "swapon-file"
27459 #: ../fish/guestfish-actions.pod:4459
27462 " swapon-file file\n"
27467 #: ../fish/guestfish-actions.pod:4461
27469 "This command enables swap to a file. See L</swapon-device> for other notes."
27473 #: ../fish/guestfish-actions.pod:4464
27474 msgid "swapon-label"
27478 #: ../fish/guestfish-actions.pod:4466
27481 " swapon-label label\n"
27486 #: ../fish/guestfish-actions.pod:4468
27488 "This command enables swap to a labeled swap partition. See L</swapon-"
27489 "device> for other notes."
27493 #: ../fish/guestfish-actions.pod:4471
27494 msgid "swapon-uuid"
27498 #: ../fish/guestfish-actions.pod:4473
27501 " swapon-uuid uuid\n"
27506 #: ../fish/guestfish-actions.pod:4475
27508 "This command enables swap to a swap partition with the given UUID. See L</"
27509 "swapon-device> for other notes."
27513 #: ../fish/guestfish-actions.pod:4478
27518 #: ../fish/guestfish-actions.pod:4480
27526 #: ../fish/guestfish-actions.pod:4488
27531 #: ../fish/guestfish-actions.pod:4490
27539 #: ../fish/guestfish-actions.pod:4498
27544 #: ../fish/guestfish-actions.pod:4500
27547 " tail-n nrlines path\n"
27552 #: ../fish/guestfish-actions.pod:4513
27557 #: ../fish/guestfish-actions.pod:4515
27560 " tar-in (tarfile|-) directory\n"
27565 #: ../fish/guestfish-actions.pod:4520
27566 msgid "To upload a compressed tarball, use L</tgz-in> or L</txz-in>."
27570 #: ../fish/guestfish-actions.pod:4525
27575 #: ../fish/guestfish-actions.pod:4527
27578 " tar-out directory (tarfile|-)\n"
27583 #: ../fish/guestfish-actions.pod:4532
27584 msgid "To download a compressed tarball, use L</tgz-out> or L</txz-out>."
27588 #: ../fish/guestfish-actions.pod:4537
27593 #: ../fish/guestfish-actions.pod:4539
27596 " tgz-in (tarball|-) directory\n"
27601 #: ../fish/guestfish-actions.pod:4544
27602 msgid "To upload an uncompressed tarball, use L</tar-in>."
27606 #: ../fish/guestfish-actions.pod:4548
27611 #: ../fish/guestfish-actions.pod:4550
27614 " tgz-out directory (tarball|-)\n"
27619 #: ../fish/guestfish-actions.pod:4555
27620 msgid "To download an uncompressed tarball, use L</tar-out>."
27624 #: ../fish/guestfish-actions.pod:4559
27629 #: ../fish/guestfish-actions.pod:4561
27637 #: ../fish/guestfish-actions.pod:4570
27642 #: ../fish/guestfish-actions.pod:4572
27650 #: ../fish/guestfish-actions.pod:4577
27651 msgid "truncate-size"
27655 #: ../fish/guestfish-actions.pod:4579
27658 " truncate-size path size\n"
27663 #: ../fish/guestfish-actions.pod:4584
27665 "If the current file size is less than C<size> then the file is extended to "
27666 "the required size with zero bytes. This creates a sparse file (ie. disk "
27667 "blocks are not allocated for the file until you write to it). To create a "
27668 "non-sparse file of zeroes, use L</fallocate64> instead."
27672 #: ../fish/guestfish-actions.pod:4590
27677 #: ../fish/guestfish-actions.pod:4592
27680 " tune2fs-l device\n"
27685 #: ../fish/guestfish-actions.pod:4602
27690 #: ../fish/guestfish-actions.pod:4604
27693 " txz-in (tarball|-) directory\n"
27698 #: ../fish/guestfish-actions.pod:4611
27703 #: ../fish/guestfish-actions.pod:4613
27706 " txz-out directory (tarball|-)\n"
27711 #: ../fish/guestfish-actions.pod:4620
27716 #: ../fish/guestfish-actions.pod:4622
27724 #: ../fish/guestfish-actions.pod:4636
27725 msgid "See also L</get-umask>, L<umask(2)>, L</mknod>, L</mkdir>."
27729 #: ../fish/guestfish-actions.pod:4641
27734 #: ../fish/guestfish-actions.pod:4643
27739 #: ../fish/guestfish-actions.pod:4645
27742 " umount pathordevice\n"
27747 #: ../fish/guestfish-actions.pod:4651
27752 #: ../fish/guestfish-actions.pod:4653
27753 msgid "unmount-all"
27757 #: ../fish/guestfish-actions.pod:4655
27765 #: ../fish/guestfish-actions.pod:4661
27770 #: ../fish/guestfish-actions.pod:4663
27773 " upload (filename|-) remotefilename\n"
27778 #: ../fish/guestfish-actions.pod:4670
27779 msgid "See also L</download>."
27783 #: ../fish/guestfish-actions.pod:4674
27784 msgid "upload-offset"
27788 #: ../fish/guestfish-actions.pod:4676
27791 " upload-offset (filename|-) remotefilename offset\n"
27796 #: ../fish/guestfish-actions.pod:4688
27798 "Note that there is no limit on the amount of data that can be uploaded with "
27799 "this call, unlike with L</pwrite>, and this call always writes the full "
27800 "amount unless an error occurs."
27804 #: ../fish/guestfish-actions.pod:4693
27805 msgid "See also L</upload>, L</pwrite>."
27809 #: ../fish/guestfish-actions.pod:4697
27814 #: ../fish/guestfish-actions.pod:4699
27817 " utimens path atsecs atnsecs mtsecs mtnsecs\n"
27822 #: ../fish/guestfish-actions.pod:4718
27827 #: ../fish/guestfish-actions.pod:4720
27835 #: ../fish/guestfish-actions.pod:4747
27837 "I<Note:> Don't use this call to test for availability of features. In "
27838 "enterprise distributions we backport features from later versions into "
27839 "earlier versions, making this an unreliable way to test for features. Use "
27840 "L</available> instead."
27844 #: ../fish/guestfish-actions.pod:4753
27849 #: ../fish/guestfish-actions.pod:4755
27852 " vfs-label device\n"
27857 #: ../fish/guestfish-actions.pod:4762
27858 msgid "To find a filesystem from the label, use L</findfs-label>."
27862 #: ../fish/guestfish-actions.pod:4764
27867 #: ../fish/guestfish-actions.pod:4766
27870 " vfs-type device\n"
27875 #: ../fish/guestfish-actions.pod:4776
27880 #: ../fish/guestfish-actions.pod:4778
27883 " vfs-uuid device\n"
27888 #: ../fish/guestfish-actions.pod:4785
27889 msgid "To find a filesystem from the UUID, use L</findfs-uuid>."
27893 #: ../fish/guestfish-actions.pod:4787
27894 msgid "vg-activate"
27898 #: ../fish/guestfish-actions.pod:4789
27901 " vg-activate true|false 'volgroups ...'\n"
27906 #: ../fish/guestfish-actions.pod:4802
27907 msgid "vg-activate-all"
27911 #: ../fish/guestfish-actions.pod:4804
27914 " vg-activate-all true|false\n"
27919 #: ../fish/guestfish-actions.pod:4814
27924 #: ../fish/guestfish-actions.pod:4816
27927 " vgcreate volgroup 'physvols ...'\n"
27932 #: ../fish/guestfish-actions.pod:4821
27937 #: ../fish/guestfish-actions.pod:4823
27940 " vglvuuids vgname\n"
27945 #: ../fish/guestfish-actions.pod:4828
27947 "You can use this along with L</lvs> and L</lvuuid> calls to associate "
27948 "logical volumes and volume groups."
27952 #: ../fish/guestfish-actions.pod:4831
27953 msgid "See also L</vgpvuuids>."
27957 #: ../fish/guestfish-actions.pod:4833
27962 #: ../fish/guestfish-actions.pod:4835
27965 " vgpvuuids vgname\n"
27970 #: ../fish/guestfish-actions.pod:4840
27972 "You can use this along with L</pvs> and L</pvuuid> calls to associate "
27973 "physical volumes and volume groups."
27977 #: ../fish/guestfish-actions.pod:4843
27978 msgid "See also L</vglvuuids>."
27982 #: ../fish/guestfish-actions.pod:4845
27987 #: ../fish/guestfish-actions.pod:4847
27990 " vgremove vgname\n"
27995 #: ../fish/guestfish-actions.pod:4854
28000 #: ../fish/guestfish-actions.pod:4856
28003 " vgrename volgroup newvolgroup\n"
28008 #: ../fish/guestfish-actions.pod:4860
28013 #: ../fish/guestfish-actions.pod:4862
28021 #: ../fish/guestfish-actions.pod:4870
28022 msgid "See also L</vgs-full>."
28026 #: ../fish/guestfish-actions.pod:4872
28031 #: ../fish/guestfish-actions.pod:4874
28039 #: ../fish/guestfish-actions.pod:4879
28044 #: ../fish/guestfish-actions.pod:4881
28052 #: ../fish/guestfish-actions.pod:4886
28057 #: ../fish/guestfish-actions.pod:4888
28065 #: ../fish/guestfish-actions.pod:4892
28070 #: ../fish/guestfish-actions.pod:4894
28078 #: ../fish/guestfish-actions.pod:4899
28083 #: ../fish/guestfish-actions.pod:4901
28091 #: ../fish/guestfish-actions.pod:4906
28096 #: ../fish/guestfish-actions.pod:4908
28104 #: ../fish/guestfish-actions.pod:4913
28109 #: ../fish/guestfish-actions.pod:4915
28112 " write path content\n"
28117 #: ../fish/guestfish-actions.pod:4923
28122 #: ../fish/guestfish-actions.pod:4925
28125 " write-file path content size\n"
28130 #: ../fish/guestfish-actions.pod:4948
28135 #: ../fish/guestfish-actions.pod:4950
28138 " zegrep regex path\n"
28143 #: ../fish/guestfish-actions.pod:4958
28148 #: ../fish/guestfish-actions.pod:4960
28151 " zegrepi regex path\n"
28156 #: ../fish/guestfish-actions.pod:4968
28161 #: ../fish/guestfish-actions.pod:4970
28169 #: ../fish/guestfish-actions.pod:4978
28170 msgid "See also: L</zero-device>, L</scrub-device>, L</is-zero-device>"
28174 #: ../fish/guestfish-actions.pod:4981
28175 msgid "zero-device"
28179 #: ../fish/guestfish-actions.pod:4983
28182 " zero-device device\n"
28187 #: ../fish/guestfish-actions.pod:4985
28189 "This command writes zeroes over the entire C<device>. Compare with L</zero> "
28190 "which just zeroes the first few blocks of a device."
28194 #: ../fish/guestfish-actions.pod:4992
28199 #: ../fish/guestfish-actions.pod:4994
28202 " zerofree device\n"
28207 #: ../fish/guestfish-actions.pod:5007
28212 #: ../fish/guestfish-actions.pod:5009
28215 " zfgrep pattern path\n"
28220 #: ../fish/guestfish-actions.pod:5017
28225 #: ../fish/guestfish-actions.pod:5019
28228 " zfgrepi pattern path\n"
28233 #: ../fish/guestfish-actions.pod:5027
28238 #: ../fish/guestfish-actions.pod:5029
28241 " zfile meth path\n"
28246 #: ../fish/guestfish-actions.pod:5036
28248 "Since 1.0.63, use L</file> instead which can now process compressed files."
28252 #: ../fish/guestfish-actions.pod:5046
28257 #: ../fish/guestfish-actions.pod:5048
28260 " zgrep regex path\n"
28265 #: ../fish/guestfish-actions.pod:5056
28270 #: ../fish/guestfish-actions.pod:5058
28273 " zgrepi regex path\n"
28278 #: ../fish/guestfish-commands.pod:1
28283 #: ../fish/guestfish-commands.pod:3
28288 #: ../fish/guestfish-commands.pod:5
28291 " alloc filename size\n"
28296 #: ../fish/guestfish-commands.pod:7
28298 "This creates an empty (zeroed) file of the given size, and then adds so it "
28299 "can be further examined."
28303 #: ../fish/guestfish-commands.pod:10 ../fish/guestfish-commands.pod:182
28304 msgid "For more advanced image creation, see L<qemu-img(1)> utility."
28308 #: ../fish/guestfish-commands.pod:12 ../fish/guestfish-commands.pod:184
28309 msgid "Size can be specified using standard suffixes, eg. C<1M>."
28313 #: ../fish/guestfish-commands.pod:14
28315 "To create a sparse file, use L</sparse> instead. To create a prepared disk "
28316 "image, see L</PREPARED DISK IMAGES>."
28320 #: ../fish/guestfish-commands.pod:17
28325 #: ../fish/guestfish-commands.pod:19
28328 " copy-in local [local ...] /remotedir\n"
28333 #: ../fish/guestfish-commands.pod:21
28335 "C<copy-in> copies local files or directories recursively into the disk "
28336 "image, placing them in the directory called C</remotedir> (which must "
28337 "exist). This guestfish meta-command turns into a sequence of L</tar-in> and "
28338 "other commands as necessary."
28342 #: ../fish/guestfish-commands.pod:26
28344 "Multiple local files and directories can be specified, but the last "
28345 "parameter must always be a remote directory. Wildcards cannot be used."
28349 #: ../fish/guestfish-commands.pod:30
28354 #: ../fish/guestfish-commands.pod:32
28357 " copy-out remote [remote ...] localdir\n"
28362 #: ../fish/guestfish-commands.pod:34
28364 "C<copy-out> copies remote files or directories recursively out of the disk "
28365 "image, placing them on the host disk in a local directory called C<localdir> "
28366 "(which must exist). This guestfish meta-command turns into a sequence of L</"
28367 "download>, L</tar-out> and other commands as necessary."
28371 #: ../fish/guestfish-commands.pod:40
28373 "Multiple remote files and directories can be specified, but the last "
28374 "parameter must always be a local directory. To download to the current "
28375 "directory, use C<.> as in:"
28379 #: ../fish/guestfish-commands.pod:44
28382 " copy-out /home .\n"
28387 #: ../fish/guestfish-commands.pod:46
28389 "Wildcards cannot be used in the ordinary command, but you can use them with "
28390 "the help of L</glob> like this:"
28394 #: ../fish/guestfish-commands.pod:49
28397 " glob copy-out /home/* .\n"
28402 #: ../fish/guestfish-commands.pod:51
28407 #: ../fish/guestfish-commands.pod:53
28410 " display filename\n"
28415 #: ../fish/guestfish-commands.pod:55
28417 "Use C<display> (a graphical display program) to display an image file. It "
28418 "downloads the file, and runs C<display> on it."
28422 #: ../fish/guestfish-commands.pod:58
28424 "To use an alternative program, set the C<GUESTFISH_DISPLAY_IMAGE> "
28425 "environment variable. For example to use the GNOME display program:"
28429 #: ../fish/guestfish-commands.pod:61
28432 " export GUESTFISH_DISPLAY_IMAGE=eog\n"
28437 #: ../fish/guestfish-commands.pod:63
28439 #| msgid "See L<guestfish(1)>."
28440 msgid "See also L<display(1)>."
28441 msgstr "Див. L<guestfish(1)>."
28444 #: ../fish/guestfish-commands.pod:65
28449 #: ../fish/guestfish-commands.pod:67
28452 " echo [params ...]\n"
28457 #: ../fish/guestfish-commands.pod:69
28458 msgid "This echos the parameters to the terminal."
28462 #: ../fish/guestfish-commands.pod:71
28467 #: ../fish/guestfish-commands.pod:73
28472 #: ../fish/guestfish-commands.pod:75
28477 #: ../fish/guestfish-commands.pod:77
28485 #: ../fish/guestfish-commands.pod:79
28487 "This is used to edit a file. It downloads the file, edits it locally using "
28488 "your editor, then uploads the result."
28492 #: ../fish/guestfish-commands.pod:82
28494 "The editor is C<$EDITOR>. However if you use the alternate commands C<vi> "
28495 "or C<emacs> you will get those corresponding editors."
28499 #: ../fish/guestfish-commands.pod:86
28504 #: ../fish/guestfish-commands.pod:88
28507 " glob command args...\n"
28512 #: ../fish/guestfish-commands.pod:90
28514 "Expand wildcards in any paths in the args list, and run C<command> "
28515 "repeatedly on each matching path."
28519 #: ../fish/guestfish-commands.pod:93
28520 msgid "See L</WILDCARDS AND GLOBBING>."
28524 #: ../fish/guestfish-commands.pod:95
28529 #: ../fish/guestfish-commands.pod:97
28532 " hexedit <filename|device>\n"
28533 " hexedit <filename|device> <max>\n"
28534 " hexedit <filename|device> <start> <max>\n"
28539 #: ../fish/guestfish-commands.pod:101
28541 "Use hexedit (a hex editor) to edit all or part of a binary file or block "
28546 #: ../fish/guestfish-commands.pod:104
28548 "This command works by downloading potentially the whole file or device, "
28549 "editing it locally, then uploading it. If the file or device is large, you "
28550 "have to specify which part you wish to edit by using C<max> and/or C<start> "
28551 "C<max> parameters. C<start> and C<max> are specified in bytes, with the "
28552 "usual modifiers allowed such as C<1M> (1 megabyte)."
28556 #: ../fish/guestfish-commands.pod:111
28557 msgid "For example to edit the first few sectors of a disk you might do:"
28561 #: ../fish/guestfish-commands.pod:114
28564 " hexedit /dev/sda 1M\n"
28569 #: ../fish/guestfish-commands.pod:116
28571 "which would allow you to edit anywhere within the first megabyte of the disk."
28575 #: ../fish/guestfish-commands.pod:119
28576 msgid "To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:"
28580 #: ../fish/guestfish-commands.pod:121
28583 " hexedit /dev/sda1 0x400 0x400\n"
28588 #: ../fish/guestfish-commands.pod:123
28589 msgid "(assuming the superblock is in the standard location)."
28593 #: ../fish/guestfish-commands.pod:125
28595 "This command requires the external L<hexedit(1)> program. You can specify "
28596 "another program to use by setting the C<HEXEDITOR> environment variable."
28600 #: ../fish/guestfish-commands.pod:129
28601 msgid "See also L</hexdump>."
28605 #: ../fish/guestfish-commands.pod:131
28610 #: ../fish/guestfish-commands.pod:133
28618 #: ../fish/guestfish-commands.pod:135
28620 "Change the local directory, ie. the current directory of guestfish itself."
28624 #: ../fish/guestfish-commands.pod:138
28625 msgid "Note that C<!cd> won't do what you might expect."
28629 #: ../fish/guestfish-commands.pod:140
28634 #: ../fish/guestfish-commands.pod:142
28639 #: ../fish/guestfish-commands.pod:144
28647 #: ../fish/guestfish-commands.pod:146
28648 msgid "Opens the manual page for guestfish."
28652 #: ../fish/guestfish-commands.pod:148
28657 #: ../fish/guestfish-commands.pod:150
28662 #: ../fish/guestfish-commands.pod:152
28670 #: ../fish/guestfish-commands.pod:154
28678 #: ../fish/guestfish-commands.pod:156
28679 msgid "This is used to view a file."
28683 #: ../fish/guestfish-commands.pod:158
28685 "The default viewer is C<$PAGER>. However if you use the alternate command "
28686 "C<less> you will get the C<less> command specifically."
28690 #: ../fish/guestfish-commands.pod:161
28695 #: ../fish/guestfish-commands.pod:163
28703 #: ../fish/guestfish-commands.pod:165
28705 "Close and reopen the libguestfs handle. It is not necessary to use this "
28706 "normally, because the handle is closed properly when guestfish exits. "
28707 "However this is occasionally useful for testing."
28711 #: ../fish/guestfish-commands.pod:169
28716 #: ../fish/guestfish-commands.pod:171
28719 " sparse filename size\n"
28724 #: ../fish/guestfish-commands.pod:173
28726 "This creates an empty sparse file of the given size, and then adds so it can "
28727 "be further examined."
28731 #: ../fish/guestfish-commands.pod:176
28733 "In all respects it works the same as the L</alloc> command, except that the "
28734 "image file is allocated sparsely, which means that disk blocks are not "
28735 "assigned to the file until they are needed. Sparse disk files only use "
28736 "space when written to, but they are slower and there is a danger you could "
28737 "run out of real disk space during a write operation."
28741 #: ../fish/guestfish-commands.pod:186
28746 #: ../fish/guestfish-commands.pod:188
28754 #: ../fish/guestfish-commands.pod:190
28756 "This command returns a list of the optional groups known to the daemon, and "
28757 "indicates which ones are supported by this build of the libguestfs appliance."
28761 #: ../fish/guestfish-commands.pod:194
28762 msgid "See also L<guestfs(3)/AVAILABILITY>."
28766 #: ../fish/guestfish-commands.pod:196
28771 #: ../fish/guestfish-commands.pod:198
28774 " time command args...\n"
28779 #: ../fish/guestfish-commands.pod:200
28781 "Run the command as usual, but print the elapsed time afterwards. This can "
28782 "be useful for benchmarking operations."
28786 #: ../test-tool/libguestfs-test-tool.pod:5
28787 msgid "libguestfs-test-tool - End user tests for libguestfs"
28791 #: ../test-tool/libguestfs-test-tool.pod:9
28794 " libguestfs-test-tool [--options]\n"
28799 #: ../test-tool/libguestfs-test-tool.pod:13
28801 "libguestfs-test-tool is a test program shipped with libguestfs to end users "
28802 "and developers, to allow them to check basic libguestfs functionality is "
28803 "working. This is needed because libguestfs occasionally breaks for reasons "
28804 "beyond our control: usually because of changes in the underlying qemu or "
28805 "kernel packages, or the host environment."
28809 #: ../test-tool/libguestfs-test-tool.pod:20
28810 msgid "If you suspect a problem in libguestfs, then just run:"
28814 #: ../test-tool/libguestfs-test-tool.pod:22
28817 " libguestfs-test-tool\n"
28822 #: ../test-tool/libguestfs-test-tool.pod:24
28823 msgid "It will print lots of diagnostic messages."
28827 #: ../test-tool/libguestfs-test-tool.pod:26
28828 msgid "If it runs to completion successfully, you will see this near the end:"
28832 #: ../test-tool/libguestfs-test-tool.pod:28
28835 " ===== TEST FINISHED OK =====\n"
28840 #: ../test-tool/libguestfs-test-tool.pod:30
28841 msgid "and the test tool will exit with code 0."
28845 #: ../test-tool/libguestfs-test-tool.pod:32
28847 "If it fails (and/or exits with non-zero error code), please paste the "
28848 "B<complete, unedited> output of the test tool into a bug report. More "
28849 "information about reporting bugs can be found on the L<http://libguestfs.org/"
28854 #: ../test-tool/libguestfs-test-tool.pod:41
28859 #: ../test-tool/libguestfs-test-tool.pod:43
28860 msgid "Display short usage information and exit."
28864 #: ../test-tool/libguestfs-test-tool.pod:45
28865 msgid "I<--qemu qemu_binary>"
28869 #: ../test-tool/libguestfs-test-tool.pod:47
28871 "If you have downloaded another qemu binary, point this option at the full "
28872 "path of the binary to try it."
28876 #: ../test-tool/libguestfs-test-tool.pod:50
28877 msgid "I<--qemudir qemu_source_dir>"
28881 #: ../test-tool/libguestfs-test-tool.pod:52
28883 "If you have compiled qemu from source, point this option at the source "
28884 "directory to try it."
28888 #: ../test-tool/libguestfs-test-tool.pod:55
28889 msgid "I<--timeout N>"
28893 #: ../test-tool/libguestfs-test-tool.pod:57
28895 "Set the launch timeout to C<N> seconds. The default is 120 seconds which "
28896 "does not usually need to be adjusted unless your machine is very slow."
28900 #: ../test-tool/libguestfs-test-tool.pod:63
28901 msgid "TRYING OUT A DIFFERENT VERSION OF QEMU"
28905 #: ../test-tool/libguestfs-test-tool.pod:65
28907 "If you have compiled another version of qemu from source and would like to "
28908 "try that, then you can use the I<--qemudir> option to point to the qemu "
28909 "source directory."
28913 #: ../test-tool/libguestfs-test-tool.pod:69
28915 "If you have downloaded a qemu binary from somewhere, use the I<--qemu> "
28916 "option to point to the binary."
28920 #: ../test-tool/libguestfs-test-tool.pod:72
28922 "When using an alternate qemu with libguestfs, usually you would need to "
28923 "write a qemu wrapper script (see section I<QEMU WRAPPERS> in L<guestfs(3)"
28924 ">). libguestfs-test-tool writes a temporary qemu wrapper script when you "
28925 "use either of the I<--qemudir> or I<--qemu> options."
28929 #: ../test-tool/libguestfs-test-tool.pod:79
28931 "libguestfs-test-tool returns I<0> if the tests completed without error, or "
28932 "I<1> if there was an error."
28936 #: ../test-tool/libguestfs-test-tool.pod:84
28938 "For the full list of environment variables which may affect libguestfs, "
28939 "please see the L<guestfs(3)> manual page."
28943 #: ../test-tool/libguestfs-test-tool.pod:89
28944 msgid "L<guestfs(3)>, L<http://libguestfs.org/>, L<http://qemu.org/>."
28948 #: ../fuse/guestmount.pod:5
28950 "guestmount - Mount a guest filesystem on the host using FUSE and libguestfs"
28954 #: ../fuse/guestmount.pod:9
28957 " guestmount [--options] -a disk.img -m device [--ro] mountpoint\n"
28962 #: ../fuse/guestmount.pod:11
28965 " guestmount [--options] -a disk.img -i [--ro] mountpoint\n"
28970 #: ../fuse/guestmount.pod:13
28973 " guestmount [--options] -d Guest -i [--ro] mountpoint\n"
28978 #: ../fuse/guestmount.pod:17
28980 "You must I<not> use C<guestmount> in read-write mode on live virtual "
28981 "machines. If you do this, you risk disk corruption in the VM."
28985 #: ../fuse/guestmount.pod:22
28987 "The guestmount program can be used to mount virtual machine filesystems and "
28988 "other disk images on the host. It uses libguestfs for access to the guest "
28989 "filesystem, and FUSE (the \"filesystem in userspace\") to make it appear as "
28990 "a mountable device."
28994 #: ../fuse/guestmount.pod:27
28996 "Along with other options, you have to give at least one device (I<-a> "
28997 "option) or libvirt domain (I<-d> option), and at least one mountpoint (I<-m> "
28998 "option) or use the I<-i> inspection option. How this works is better "
28999 "explained in the L<guestfish(1)> manual page, or by looking at the examples "
29004 #: ../fuse/guestmount.pod:33
29006 "FUSE lets you mount filesystems as non-root. The mountpoint must be owned "
29007 "by you, and the filesystem will not be visible to any other users unless you "
29008 "make certain global configuration changes to C</etc/fuse.conf>. To unmount "
29009 "the filesystem, use the C<fusermount -u> command."
29013 #: ../fuse/guestmount.pod:41
29015 "For a typical Windows guest which has its main filesystem on the first "
29020 #: ../fuse/guestmount.pod:44
29023 " guestmount -a windows.img -m /dev/sda1 --ro /mnt\n"
29028 #: ../fuse/guestmount.pod:46
29030 "For a typical Linux guest which has a /boot filesystem on the first "
29031 "partition, and the root filesystem on a logical volume:"
29035 #: ../fuse/guestmount.pod:49
29038 " guestmount -a linux.img -m /dev/VG/LV -m /dev/sda1:/boot --ro /mnt\n"
29043 #: ../fuse/guestmount.pod:51
29044 msgid "To get libguestfs to detect guest mountpoints for you:"
29048 #: ../fuse/guestmount.pod:53
29051 " guestmount -a guest.img -i --ro /mnt\n"
29056 #: ../fuse/guestmount.pod:55
29057 msgid "For a libvirt guest called \"Guest\" you could do:"
29061 #: ../fuse/guestmount.pod:57
29064 " guestmount -d Guest -i --ro /mnt\n"
29069 #: ../fuse/guestmount.pod:59
29071 "If you don't know what filesystems are contained in a guest or disk image, "
29072 "use L<virt-filesystems(1)> first:"
29076 #: ../fuse/guestmount.pod:62
29079 " virt-filesystems MyGuest\n"
29084 #: ../fuse/guestmount.pod:64
29086 "If you want to trace the libguestfs calls but without excessive debugging "
29087 "information, we recommend:"
29091 #: ../fuse/guestmount.pod:67
29094 " guestmount [...] --trace /mnt\n"
29099 #: ../fuse/guestmount.pod:69
29100 msgid "If you want to debug the program, we recommend:"
29104 #: ../fuse/guestmount.pod:71
29107 " guestmount [...] --trace --verbose /mnt\n"
29112 #: ../fuse/guestmount.pod:73
29117 #: ../fuse/guestmount.pod:75
29118 msgid "Other users cannot see the filesystem by default"
29122 #: ../fuse/guestmount.pod:77
29124 "If you mount a filesystem as one user (eg. root), then other users will not "
29125 "be able to see it by default. The fix is to add the FUSE C<allow_other> "
29126 "option when mounting:"
29130 #: ../fuse/guestmount.pod:81
29133 " sudo guestmount [...] -o allow_other /mnt\n"
29138 #: ../fuse/guestmount.pod:87
29139 msgid "B<-a image> | B<--add image>"
29143 #: ../fuse/guestmount.pod:89
29144 msgid "Add a block device or virtual machine image."
29148 #: ../fuse/guestmount.pod:94
29149 msgid "B<-c URI> | B<--connect URI>"
29153 #: ../fuse/guestmount.pod:100
29154 msgid "B<-d libvirt-domain> | B<--domain libvirt-domain>"
29158 #: ../fuse/guestmount.pod:108
29159 msgid "B<--dir-cache-timeout N>"
29163 #: ../fuse/guestmount.pod:110
29165 "Set the readdir cache timeout to I<N> seconds, the default being 60 "
29166 "seconds. The readdir cache [actually, there are several semi-independent "
29167 "caches] is populated after a readdir(2) call with the stat and extended "
29168 "attributes of the files in the directory, in anticipation that they will be "
29169 "requested soon after."
29173 #: ../fuse/guestmount.pod:116
29175 "There is also a different attribute cache implemented by FUSE (see the FUSE "
29176 "option I<-o attr_timeout>), but the FUSE cache does not anticipate future "
29177 "requests, only cache existing ones."
29181 #: ../fuse/guestmount.pod:127
29182 msgid "B<--format=raw|qcow2|..> | B<--format>"
29186 #: ../fuse/guestmount.pod:134
29188 "If you have untrusted raw-format guest disk images, you should use this "
29189 "option to specify the disk format. This avoids a possible security problem "
29190 "with malicious guests (CVE-2010-3851). See also L<guestfs(3)/"
29191 "guestfs_add_drive_opts>."
29195 #: ../fuse/guestmount.pod:139
29196 msgid "B<--fuse-help>"
29200 #: ../fuse/guestmount.pod:141
29201 msgid "Display help on special FUSE options (see I<-o> below)."
29205 #: ../fuse/guestmount.pod:145
29206 msgid "Display brief help and exit."
29210 #: ../fuse/guestmount.pod:147
29211 msgid "B<-i> | B<--inspector>"
29215 #: ../fuse/guestmount.pod:167
29217 "Mount the named partition or logical volume on the given mountpoint B<in the "
29218 "guest> (this has nothing to do with mountpoints in the host)."
29222 #: ../fuse/guestmount.pod:170
29224 "If the mountpoint is omitted, it defaults to C</>. You have to mount "
29225 "something on C</>."
29229 #: ../fuse/guestmount.pod:183
29230 msgid "B<-n> | B<--no-sync>"
29234 #: ../fuse/guestmount.pod:185
29236 "By default, we attempt to sync the guest disk when the FUSE mountpoint is "
29237 "unmounted. If you specify this option, then we don't attempt to sync the "
29238 "disk. See the discussion of autosync in the L<guestfs(3)> manpage."
29242 #: ../fuse/guestmount.pod:190
29243 msgid "B<-o option> | B<--option option>"
29247 #: ../fuse/guestmount.pod:192
29248 msgid "Pass extra options to FUSE."
29252 #: ../fuse/guestmount.pod:194
29254 "To get a list of all the extra options supported by FUSE, use the command "
29255 "below. Note that only the FUSE I<-o> options can be passed, and only some "
29256 "of them are a good idea."
29260 #: ../fuse/guestmount.pod:198
29263 " guestmount --fuse-help\n"
29268 #: ../fuse/guestmount.pod:200
29269 msgid "Some potentially useful FUSE options:"
29273 #: ../fuse/guestmount.pod:204
29274 msgid "B<-o allow_other>"
29278 #: ../fuse/guestmount.pod:206
29279 msgid "Allow other users to see the filesystem."
29283 #: ../fuse/guestmount.pod:208
29284 msgid "B<-o attr_timeout=N>"
29288 #: ../fuse/guestmount.pod:210
29289 msgid "Enable attribute caching by FUSE, and set the timeout to I<N> seconds."
29293 #: ../fuse/guestmount.pod:212
29294 msgid "B<-o kernel_cache>"
29298 #: ../fuse/guestmount.pod:214
29300 "Allow the kernel to cache files (reduces the number of reads that have to go "
29301 "through the L<guestfs(3)> API). This is generally a good idea if you can "
29302 "afford the extra memory usage."
29306 #: ../fuse/guestmount.pod:218
29307 msgid "B<-o uid=N> B<-o gid=N>"
29311 #: ../fuse/guestmount.pod:220
29313 "Use these options to map all UIDs and GIDs inside the guest filesystem to "
29314 "the chosen values."
29318 #: ../fuse/guestmount.pod:225
29319 msgid "B<-r> | B<--ro>"
29323 #: ../fuse/guestmount.pod:227
29325 "Add devices and mount everything read-only. Also disallow writes and make "
29326 "the disk appear read-only to FUSE."
29330 #: ../fuse/guestmount.pod:230
29332 "This is highly recommended if you are not going to edit the guest disk. If "
29333 "the guest is running and this option is I<not> supplied, then there is a "
29334 "strong risk of disk corruption in the guest. We try to prevent this from "
29335 "happening, but it is not always possible."
29339 #: ../fuse/guestmount.pod:235
29340 msgid "See also L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
29344 #: ../fuse/guestmount.pod:239
29345 msgid "Enable SELinux support for the guest."
29349 #: ../fuse/guestmount.pod:241
29350 msgid "B<-v> | B<--verbose>"
29354 #: ../fuse/guestmount.pod:243
29355 msgid "Enable verbose messages from underlying libguestfs."
29359 #: ../fuse/guestmount.pod:245
29360 msgid "B<-V> | B<--version>"
29364 #: ../fuse/guestmount.pod:247
29365 msgid "Display the program version and exit."
29369 #: ../fuse/guestmount.pod:249
29370 msgid "B<-w> | B<--rw>"
29374 #: ../fuse/guestmount.pod:254 ../fuse/guestmount.pod:275
29375 msgid "See L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
29379 #: ../fuse/guestmount.pod:256
29380 msgid "B<-x> | B<--trace>"
29384 #: ../fuse/guestmount.pod:258
29385 msgid "Trace libguestfs calls and entry into each FUSE function."
29389 #: ../fuse/guestmount.pod:260
29390 msgid "This also stops the daemon from forking into the background."
29394 #: ../fuse/guestmount.pod:281
29396 "L<guestfish(1)>, L<virt-inspector(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
29397 "L<virt-tar(1)>, L<guestfs(3)>, L<http://libguestfs.org/>, L<http://fuse.sf."
29402 #: ../fuse/guestmount.pod:296
29403 msgid "Copyright (C) 2009-2010 Red Hat Inc. L<http://libguestfs.org/>"
29407 #: ../tools/virt-win-reg.pl:37
29409 "virt-win-reg - Export and merge Windows Registry entries from a Windows guest"
29413 #: ../tools/virt-win-reg.pl:41
29416 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey'\n"
29421 #: ../tools/virt-win-reg.pl:43
29424 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' name\n"
29429 #: ../tools/virt-win-reg.pl:45
29432 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' @\n"
29437 #: ../tools/virt-win-reg.pl:47
29440 " virt-win-reg --merge domname [input.reg ...]\n"
29445 #: ../tools/virt-win-reg.pl:49
29448 " virt-win-reg [--options] disk.img ... # instead of domname\n"
29453 #: ../tools/virt-win-reg.pl:53
29455 "You must I<not> use C<virt-win-reg> with the I<--merge> option on live "
29456 "virtual machines. If you do this, you I<will> get irreversible disk "
29457 "corruption in the VM. C<virt-win-reg> tries to stop you from doing this, "
29458 "but doesn't catch all cases."
29462 #: ../tools/virt-win-reg.pl:58
29464 "Modifying the Windows Registry is an inherently risky operation. The format "
29465 "is deliberately obscure and undocumented, and Registry changes can leave the "
29466 "system unbootable. Therefore when using the I<--merge> option, make sure "
29467 "you have a reliable backup first."
29471 #: ../tools/virt-win-reg.pl:65
29473 "This program can export and merge Windows Registry entries from a Windows "
29478 #: ../tools/virt-win-reg.pl:68
29480 "The first parameter is the libvirt guest name or the raw disk image of a "
29485 #: ../tools/virt-win-reg.pl:71
29487 "If I<--merge> is I<not> specified, then the chosen registry key is displayed/"
29488 "exported (recursively). For example:"
29492 #: ../tools/virt-win-reg.pl:74
29495 " $ virt-win-reg Windows7 'HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft'\n"
29500 #: ../tools/virt-win-reg.pl:76
29502 "You can also display single values from within registry keys, for example:"
29506 #: ../tools/virt-win-reg.pl:79
29509 " $ cvkey='HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion'\n"
29510 " $ virt-win-reg Windows7 $cvkey ProductName\n"
29511 " Windows 7 Enterprise\n"
29516 #: ../tools/virt-win-reg.pl:83
29518 "With I<--merge>, you can merge a textual regedit file into the Windows "
29523 #: ../tools/virt-win-reg.pl:86
29526 " $ virt-win-reg --merge Windows7 changes.reg\n"
29531 #: ../tools/virt-win-reg.pl:88 ../tools/virt-tar.pl:45
29536 #: ../tools/virt-win-reg.pl:90
29538 "This program is only meant for simple access to the registry. If you want "
29539 "to do complicated things with the registry, we suggest you download the "
29540 "Registry hive files from the guest using L<libguestfs(3)> or L<guestfish(1)> "
29541 "and access them locally, eg. using L<hivex(3)>, L<hivexsh(1)> or "
29542 "L<hivexregedit(1)>."
29546 #: ../tools/virt-win-reg.pl:106 ../tools/virt-list-filesystems.pl:63
29547 #: ../tools/virt-tar.pl:113 ../tools/virt-make-fs.pl:163
29548 #: ../tools/virt-list-partitions.pl:64
29549 msgid "Display brief help."
29553 #: ../tools/virt-win-reg.pl:114 ../tools/virt-list-filesystems.pl:71
29554 #: ../tools/virt-tar.pl:121 ../tools/virt-make-fs.pl:171
29555 #: ../tools/virt-list-partitions.pl:72
29556 msgid "Display version number and exit."
29560 #: ../tools/virt-win-reg.pl:120 ../tools/virt-make-fs.pl:177
29565 #: ../tools/virt-win-reg.pl:122
29566 msgid "Enable debugging messages."
29570 #: ../tools/virt-win-reg.pl:128 ../tools/virt-list-filesystems.pl:77
29571 #: ../tools/virt-tar.pl:127 ../tools/virt-list-partitions.pl:78
29572 msgid "B<--connect URI> | B<-c URI>"
29576 #: ../tools/virt-win-reg.pl:130 ../tools/virt-list-filesystems.pl:79
29577 #: ../tools/virt-tar.pl:129 ../tools/virt-list-partitions.pl:80
29579 "If using libvirt, connect to the given I<URI>. If omitted, then we connect "
29580 "to the default libvirt hypervisor."
29584 #: ../tools/virt-win-reg.pl:133 ../tools/virt-list-filesystems.pl:82
29585 #: ../tools/virt-tar.pl:132 ../tools/virt-list-partitions.pl:83
29587 "If you specify guest block devices directly, then libvirt is not used at all."
29591 #: ../tools/virt-win-reg.pl:140 ../tools/virt-list-filesystems.pl:89
29592 #: ../tools/virt-tar.pl:139 ../tools/virt-list-partitions.pl:90
29593 msgid "B<--format> raw"
29597 #: ../tools/virt-win-reg.pl:142 ../tools/virt-list-filesystems.pl:91
29598 #: ../tools/virt-tar.pl:141 ../tools/virt-list-partitions.pl:92
29600 "Specify the format of disk images given on the command line. If this is "
29601 "omitted then the format is autodetected from the content of the disk image."
29605 #: ../tools/virt-win-reg.pl:146 ../tools/virt-list-filesystems.pl:95
29606 #: ../tools/virt-tar.pl:145 ../tools/virt-list-partitions.pl:96
29608 "If disk images are requested from libvirt, then this program asks libvirt "
29609 "for this information. In this case, the value of the format parameter is "
29614 #: ../tools/virt-win-reg.pl:150 ../tools/virt-list-filesystems.pl:99
29615 #: ../tools/virt-tar.pl:149 ../tools/virt-list-partitions.pl:100
29617 "If working with untrusted raw-format guest disk images, you should ensure "
29618 "the format is always specified."
29622 #: ../tools/virt-win-reg.pl:157
29627 #: ../tools/virt-win-reg.pl:159
29629 "In merge mode, this merges a textual regedit file into the Windows Registry "
29630 "of the virtual machine. If this flag is I<not> given then virt-win-reg "
29631 "displays or exports Registry entries instead."
29635 #: ../tools/virt-win-reg.pl:163
29637 "Note that I<--merge> is I<unsafe> to use on live virtual machines, and will "
29638 "result in disk corruption. However exporting (without this flag) is always "
29643 #: ../tools/virt-win-reg.pl:171
29644 msgid "B<--encoding> UTF-16LE|ASCII"
29648 #: ../tools/virt-win-reg.pl:173
29650 "When merging (only), you may need to specify the encoding for strings to be "
29651 "used in the hive file. This is explained in detail in L<Win::Hivex::Regedit"
29652 "(3)/ENCODING STRINGS>."
29656 #: ../tools/virt-win-reg.pl:177
29658 "The default is to use UTF-16LE, which should work with recent versions of "
29663 #: ../tools/virt-win-reg.pl:184
29664 msgid "B<--unsafe-printable-strings>"
29668 #: ../tools/virt-win-reg.pl:186
29670 "When exporting (only), assume strings are UTF-16LE and print them as strings "
29671 "instead of hex sequences. Remove the final zero codepoint from strings if "
29676 #: ../tools/virt-win-reg.pl:190
29678 "This is unsafe and does not preserve the fidelity of strings in the original "
29679 "Registry for various reasons:"
29683 #: ../tools/virt-win-reg.pl:197
29685 "Assumes the original encoding is UTF-16LE. ASCII strings and strings in "
29686 "other encodings will be corrupted by this transformation."
29690 #: ../tools/virt-win-reg.pl:202
29692 "Assumes that everything which has type 1 or 2 is really a string and that "
29693 "everything else is not a string, but the type field in real Registries is "
29698 #: ../tools/virt-win-reg.pl:208
29700 "Loses information about whether a zero codepoint followed the string in the "
29705 #: ../tools/virt-win-reg.pl:213
29707 "This all happens because the Registry itself contains no information about "
29708 "how strings are encoded (see L<Win::Hivex::Regedit(3)/ENCODING STRINGS>)."
29712 #: ../tools/virt-win-reg.pl:217
29714 "You should only use this option for quick hacking and debugging of the "
29715 "Registry contents, and I<never> use it if the output is going to be passed "
29716 "into another program or stored in another Registry."
29720 #: ../tools/virt-win-reg.pl:554
29721 msgid "SUPPORTED SYSTEMS"
29725 #: ../tools/virt-win-reg.pl:556
29727 "The program currently supports Windows NT-derived guests starting with "
29728 "Windows XP through to at least Windows 7."
29732 #: ../tools/virt-win-reg.pl:559
29733 msgid "The following Registry keys are supported:"
29737 #: ../tools/virt-win-reg.pl:563
29738 msgid "C<HKEY_LOCAL_MACHINE\\SAM>"
29742 #: ../tools/virt-win-reg.pl:565
29743 msgid "C<HKEY_LOCAL_MACHINE\\SECURITY>"
29747 #: ../tools/virt-win-reg.pl:567
29748 msgid "C<HKEY_LOCAL_MACHINE\\SOFTWARE>"
29752 #: ../tools/virt-win-reg.pl:569
29753 msgid "C<HKEY_LOCAL_MACHINE\\SYSTEM>"
29757 #: ../tools/virt-win-reg.pl:571
29758 msgid "C<HKEY_USERS\\.DEFAULT>"
29762 #: ../tools/virt-win-reg.pl:573
29763 msgid "C<HKEY_USERS\\I<SID>>"
29767 #: ../tools/virt-win-reg.pl:575
29768 msgid "where I<SID> is a Windows User SID (eg. C<S-1-5-18>)."
29772 #: ../tools/virt-win-reg.pl:577
29773 msgid "C<HKEY_USERS\\I<username>>"
29777 #: ../tools/virt-win-reg.pl:579
29779 "where I<username> is a local user name (this is a libguestfs extension)."
29783 #: ../tools/virt-win-reg.pl:583
29785 "You can use C<HKLM> as a shorthand for C<HKEY_LOCAL_MACHINE>, and C<HKU> for "
29790 #: ../tools/virt-win-reg.pl:586
29792 "The literal keys C<HKEY_USERS\\$SID> and C<HKEY_CURRENT_USER> are not "
29793 "supported (there is no \"current user\")."
29797 #: ../tools/virt-win-reg.pl:589
29802 #: ../tools/virt-win-reg.pl:591
29804 "C<virt-win-reg> expects that regedit files have already been reencoded in "
29805 "the local encoding. Usually on Linux hosts, this means UTF-8 with Unix-"
29806 "style line endings. Since Windows regedit files are often in UTF-16LE with "
29807 "Windows-style line endings, you may need to reencode the whole file before "
29808 "or after processing."
29812 #: ../tools/virt-win-reg.pl:597
29814 "To reencode a file from Windows format to Linux (before processing it with "
29815 "the I<--merge> option), you would do something like this:"
29819 #: ../tools/virt-win-reg.pl:600
29822 " iconv -f utf-16le -t utf-8 < win.reg | dos2unix > linux.reg\n"
29827 #: ../tools/virt-win-reg.pl:602
29829 "To go in the opposite direction, after exporting and before sending the file "
29830 "to a Windows user, do something like this:"
29834 #: ../tools/virt-win-reg.pl:605
29837 " unix2dos linux.reg | iconv -f utf-8 -t utf-16le > win.reg\n"
29842 #: ../tools/virt-win-reg.pl:607
29843 msgid "For more information about encoding, see L<Win::Hivex::Regedit(3)>."
29847 #: ../tools/virt-win-reg.pl:609
29849 "If you are unsure about the current encoding, use the L<file(1)> command. "
29850 "Recent versions of Windows regedit.exe produce a UTF-16LE file with Windows-"
29851 "style (CRLF) line endings, like this:"
29855 #: ../tools/virt-win-reg.pl:613
29858 " $ file software.reg\n"
29859 " software.reg: Little-endian UTF-16 Unicode text, with very long lines,\n"
29860 " with CRLF line terminators\n"
29865 #: ../tools/virt-win-reg.pl:617
29866 msgid "This file would need conversion before you could I<--merge> it."
29870 #: ../tools/virt-win-reg.pl:619
29871 msgid "CurrentControlSet etc."
29875 #: ../tools/virt-win-reg.pl:621
29877 "Registry keys like C<CurrentControlSet> don't really exist in the Windows "
29878 "Registry at the level of the hive file, and therefore you cannot modify "
29883 #: ../tools/virt-win-reg.pl:625
29885 "C<CurrentControlSet> is usually an alias for C<ControlSet001>. In some "
29886 "circumstances it might refer to another control set. The way to find out is "
29887 "to look at the C<HKLM\\SYSTEM\\Select> key:"
29891 #: ../tools/virt-win-reg.pl:629
29894 " # virt-win-reg WindowsGuest 'HKLM\\SYSTEM\\Select'\n"
29895 " [HKEY_LOCAL_MACHINE\\SYSTEM\\Select]\n"
29896 " \"Current\"=dword:00000001\n"
29897 " \"Default\"=dword:00000001\n"
29898 " \"Failed\"=dword:00000000\n"
29899 " \"LastKnownGood\"=dword:00000002\n"
29904 #: ../tools/virt-win-reg.pl:636
29905 msgid "\"Current\" is the one which Windows will choose when it boots."
29909 #: ../tools/virt-win-reg.pl:638
29911 "Similarly, other C<Current...> keys in the path may need to be replaced."
29915 #: ../tools/virt-win-reg.pl:641
29916 msgid "WINDOWS TIPS"
29920 #: ../tools/virt-win-reg.pl:643
29922 "Note that some of these tips modify the guest disk image. The guest I<must> "
29923 "be shut off, else you will get disk corruption."
29927 #: ../tools/virt-win-reg.pl:646
29928 msgid "RUNNING A BATCH SCRIPT WHEN A USER LOGS IN"
29932 #: ../tools/virt-win-reg.pl:648
29934 "Prepare a DOS batch script, VBScript or executable. Upload this using "
29935 "L<guestfish(1)>. For this example the script is called C<test.bat> and it "
29936 "is uploaded into C<C:\\>:"
29940 #: ../tools/virt-win-reg.pl:652
29943 " guestfish -i -d WindowsGuest upload test.bat /test.bat\n"
29948 #: ../tools/virt-win-reg.pl:654
29949 msgid "Prepare a regedit file containing the registry change:"
29953 #: ../tools/virt-win-reg.pl:656
29956 " cat > test.reg <<'EOF'\n"
29957 " [HKLM\\Software\\Microsoft\\Windows\\CurrentVersion\\RunOnce]\n"
29958 " \"Test\"=\"c:\\\\test.bat\"\n"
29964 #: ../tools/virt-win-reg.pl:661
29966 "In this example we use the key C<RunOnce> which means that the script will "
29967 "run precisely once when the first user logs in. If you want it to run every "
29968 "time a user logs in, replace C<RunOnce> with C<Run>."
29972 #: ../tools/virt-win-reg.pl:665
29973 msgid "Now update the registry:"
29977 #: ../tools/virt-win-reg.pl:667
29980 " virt-win-reg --merge WindowsGuest test.reg\n"
29985 #: ../tools/virt-win-reg.pl:669
29986 msgid "INSTALLING A SERVICE"
29990 #: ../tools/virt-win-reg.pl:671
29992 "This section assumes you are familiar with Windows services, and you either "
29993 "have a program which handles the Windows Service Control Protocol directly "
29994 "or you want to run any program using a service wrapper like SrvAny or the "
29999 #: ../tools/virt-win-reg.pl:676
30001 "First upload the program and optionally the service wrapper. In this case "
30002 "the test program is called C<test.exe> and we are using the RHSrvAny wrapper:"
30006 #: ../tools/virt-win-reg.pl:680
30009 " guestfish -i -d WindowsGuest <<EOF\n"
30010 " upload rhsrvany.exe /rhsrvany.exe\n"
30011 " upload test.exe /test.exe\n"
30017 #: ../tools/virt-win-reg.pl:685
30019 "Prepare a regedit file containing the registry changes. In this example, "
30020 "the first registry change is needed for the service itself or the service "
30021 "wrapper (if used). The second registry change is only needed because I am "
30022 "using the RHSrvAny service wrapper."
30026 #: ../tools/virt-win-reg.pl:690
30029 " cat > service.reg <<'EOF'\n"
30030 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny]\n"
30031 " \"Type\"=dword:00000010\n"
30032 " \"Start\"=dword:00000002\n"
30033 " \"ErrorControl\"=dword:00000001\n"
30034 " \"ImagePath\"=\"c:\\\\rhsrvany.exe\"\n"
30035 " \"DisplayName\"=\"RHSrvAny\"\n"
30036 " \"ObjectName\"=\"NetworkService\"\n"
30041 #: ../tools/virt-win-reg.pl:699
30044 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny\\Parameters]\n"
30045 " \"CommandLine\"=\"c:\\\\test.exe\"\n"
30046 " \"PWD\"=\"c:\\\\Temp\"\n"
30052 #: ../tools/virt-win-reg.pl:710
30054 "For use of C<ControlSet001> see the section above in this manual page. You "
30055 "may need to adjust this according to the control set that is in use by the "
30060 #: ../tools/virt-win-reg.pl:716
30062 "C<\"ObjectName\"> controls the privileges that the service will have. An "
30063 "alternative is C<\"ObjectName\"=\"LocalSystem\"> which would be the most "
30064 "privileged account."
30068 #: ../tools/virt-win-reg.pl:722
30070 "For the meaning of the magic numbers, see this Microsoft KB article: "
30071 "L<http://support.microsoft.com/kb/103000>."
30075 #: ../tools/virt-win-reg.pl:727
30076 msgid "Update the registry:"
30080 #: ../tools/virt-win-reg.pl:729
30083 " virt-win-reg --merge WindowsGuest service.reg\n"
30088 #: ../tools/virt-win-reg.pl:731 ../tools/virt-list-filesystems.pl:182
30089 #: ../tools/virt-tar.pl:279 ../tools/virt-make-fs.pl:532
30090 #: ../tools/virt-list-partitions.pl:250
30091 msgid "SHELL QUOTING"
30095 #: ../tools/virt-win-reg.pl:733
30097 "Be careful when passing parameters containing C<\\> (backslash) in the "
30098 "shell. Usually you will have to use 'single quotes' or double backslashes "
30099 "(but not both) to protect them from the shell."
30103 #: ../tools/virt-win-reg.pl:737
30104 msgid "Paths and value names are case-insensitive."
30108 #: ../tools/virt-win-reg.pl:739 ../tools/virt-list-filesystems.pl:184
30109 #: ../tools/virt-tar.pl:281 ../tools/virt-make-fs.pl:534
30110 #: ../tools/virt-list-partitions.pl:252
30112 "Libvirt guest names can contain arbitrary characters, some of which have "
30113 "meaning to the shell such as C<#> and space. You may need to quote or "
30114 "escape these characters on the command line. See the shell manual page L<sh"
30115 "(1)> for details."
30119 #: ../tools/virt-win-reg.pl:746
30121 "L<hivex(3)>, L<hivexsh(1)>, L<hivexregedit(1)>, L<guestfs(3)>, L<guestfish(1)"
30122 ">, L<virt-cat(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Win::Hivex"
30123 "(3)>, L<Win::Hivex::Regedit(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
30127 #: ../tools/virt-win-reg.pl:761 ../tools/virt-make-fs.pl:555
30129 "When reporting bugs, please enable debugging and capture the I<complete> "
30134 #: ../tools/virt-win-reg.pl:764
30137 " export LIBGUESTFS_DEBUG=1\n"
30138 " virt-win-reg --debug [... rest ...] > /tmp/virt-win-reg.log 2>&1\n"
30143 #: ../tools/virt-win-reg.pl:767
30145 "Attach /tmp/virt-win-reg.log to a new bug report at L<https://bugzilla."
30150 #: ../tools/virt-win-reg.pl:770 ../tools/virt-list-filesystems.pl:202
30151 #: ../tools/virt-tar.pl:301 ../tools/virt-make-fs.pl:564
30152 #: ../tools/virt-list-partitions.pl:269
30157 #: ../tools/virt-win-reg.pl:772 ../tools/virt-list-filesystems.pl:204
30158 #: ../tools/virt-tar.pl:303 ../tools/virt-make-fs.pl:566
30159 #: ../tools/virt-list-partitions.pl:271
30160 msgid "Richard W.M. Jones L<http://people.redhat.com/~rjones/>"
30164 #: ../tools/virt-win-reg.pl:776 ../tools/virt-make-fs.pl:570
30165 msgid "Copyright (C) 2010 Red Hat Inc."
30169 #: ../tools/virt-list-filesystems.pl:32
30171 "virt-list-filesystems - List filesystems in a virtual machine or disk image"
30175 #: ../tools/virt-list-filesystems.pl:36
30178 " virt-list-filesystems [--options] domname\n"
30183 #: ../tools/virt-list-filesystems.pl:38
30186 " virt-list-filesystems [--options] disk.img [disk.img ...]\n"
30191 #: ../tools/virt-list-filesystems.pl:42 ../tools/virt-list-partitions.pl:42
30193 "This tool is obsolete. Use L<virt-filesystems(1)> as a more flexible "
30198 #: ../tools/virt-list-filesystems.pl:45
30200 "C<virt-list-filesystems> is a command line tool to list the filesystems that "
30201 "are contained in a virtual machine or disk image."
30205 #: ../tools/virt-list-filesystems.pl:49
30207 "C<virt-list-filesystems> is just a simple wrapper around L<libguestfs(3)> "
30208 "functionality. For more complex cases you should look at the L<guestfish(1)"
30213 #: ../tools/virt-list-filesystems.pl:106 ../tools/virt-list-partitions.pl:115
30214 msgid "B<-l> | B<--long>"
30218 #: ../tools/virt-list-filesystems.pl:108
30220 "With this option, C<virt-list-filesystems> displays the type of each "
30221 "filesystem too (where \"type\" means C<ext3>, C<xfs> etc.)"
30225 #: ../tools/virt-list-filesystems.pl:115
30226 msgid "B<-a> | B<--all>"
30230 #: ../tools/virt-list-filesystems.pl:117
30232 "Normally we only show mountable filesystems. If this option is given then "
30233 "swap devices are shown too."
30237 #: ../tools/virt-list-filesystems.pl:191
30239 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, L<virt-"
30240 "filesystems(1)>, L<virt-list-partitions(1)>, L<Sys::Guestfs(3)>, L<Sys::"
30241 "Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
30245 #: ../tools/virt-list-filesystems.pl:208 ../tools/virt-tar.pl:307
30246 msgid "Copyright (C) 2009 Red Hat Inc."
30250 #: ../tools/virt-tar.pl:33
30251 msgid "virt-tar - Extract or upload files to a virtual machine"
30255 #: ../tools/virt-tar.pl:37
30258 " virt-tar [--options] -x domname directory tarball\n"
30263 #: ../tools/virt-tar.pl:39
30266 " virt-tar [--options] -u domname tarball directory\n"
30271 #: ../tools/virt-tar.pl:41
30274 " virt-tar [--options] disk.img [disk.img ...] -x directory tarball\n"
30279 #: ../tools/virt-tar.pl:43
30282 " virt-tar [--options] disk.img [disk.img ...] -u tarball directory\n"
30287 #: ../tools/virt-tar.pl:47
30289 "This tool is obsolete. Use L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-"
30290 "tar-in(1)>, L<virt-tar-out(1)> as replacements."
30294 #: ../tools/virt-tar.pl:52
30295 msgid "Download C</home> from the VM into a local tarball:"
30299 #: ../tools/virt-tar.pl:54
30302 " virt-tar -x domname /home home.tar\n"
30307 #: ../tools/virt-tar.pl:56
30310 " virt-tar -zx domname /home home.tar.gz\n"
30315 #: ../tools/virt-tar.pl:58
30316 msgid "Upload a local tarball and unpack it inside C</tmp> in the VM:"
30320 #: ../tools/virt-tar.pl:60
30323 " virt-tar -u domname uploadstuff.tar /tmp\n"
30328 #: ../tools/virt-tar.pl:62
30331 " virt-tar -zu domname uploadstuff.tar.gz /tmp\n"
30336 #: ../tools/virt-tar.pl:66
30338 "You must I<not> use C<virt-tar> with the I<-u> option (upload) on live "
30339 "virtual machines. If you do this, you risk disk corruption in the VM. "
30340 "C<virt-tar> tries to stop you from doing this, but doesn't catch all cases."
30344 #: ../tools/virt-tar.pl:71
30346 "You can use I<-x> (extract) on live virtual machines, but you might get "
30347 "inconsistent results or errors if there is filesystem activity inside the "
30348 "VM. If the live VM is synched and quiescent, then C<virt-tar> will usually "
30349 "work, but the only way to guarantee consistent results is if the virtual "
30350 "machine is shut down."
30354 #: ../tools/virt-tar.pl:79
30356 "C<virt-tar> is a general purpose archive tool for downloading and uploading "
30357 "parts of a guest filesystem. There are many possibilities: making backups, "
30358 "uploading data files, snooping on guest activity, fixing or customizing "
30363 #: ../tools/virt-tar.pl:84
30365 "If you want to just view a single file, use L<virt-cat(1)>. If you just "
30366 "want to edit a single file, use L<virt-edit(1)>. For more complex cases you "
30367 "should look at the L<guestfish(1)> tool."
30371 #: ../tools/virt-tar.pl:88
30373 "There are two modes of operation: I<-x> (eXtract) downloads a directory and "
30374 "its contents (recursively) from the virtual machine into a local tarball. "
30375 "I<-u> uploads from a local tarball, unpacking it into a directory inside the "
30376 "virtual machine. You cannot use these two options together."
30380 #: ../tools/virt-tar.pl:94
30382 "In addition, you may need to use the I<-z> (gZip) option to enable "
30383 "compression. When uploading, you have to specify I<-z> if the upload file "
30384 "is compressed because virt-tar won't detect this on its own."
30388 #: ../tools/virt-tar.pl:98
30390 "C<virt-tar> can only handle tar (optionally gzipped) format tarballs. For "
30391 "example it cannot do PKZip files or bzip2 compression. If you want that "
30392 "then you'll have to rebuild the tarballs yourself. (This is a limitation of "
30393 "the L<libguestfs(3)> API)."
30397 #: ../tools/virt-tar.pl:156
30398 msgid "B<-x> | B<--extract> | B<--download>"
30402 #: ../tools/virt-tar.pl:158
30403 msgid "B<-u> | B<--upload>"
30407 #: ../tools/virt-tar.pl:160
30409 "Use I<-x> to extract (download) a directory from a virtual machine to a "
30414 #: ../tools/virt-tar.pl:163
30416 "Use I<-u> to upload and unpack from a local tarball into a virtual machine. "
30417 "Please read the L</WARNING> section above before using this option."
30421 #: ../tools/virt-tar.pl:167
30422 msgid "You must specify exactly one of these options."
30426 #: ../tools/virt-tar.pl:173
30427 msgid "B<-z> | B<--gzip>"
30431 #: ../tools/virt-tar.pl:175
30432 msgid "Specify that the input or output tarball is gzip-compressed."
30436 #: ../tools/virt-tar.pl:288
30438 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, L<virt-copy-"
30439 "in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<Sys::"
30440 "Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs."
30445 #: ../tools/virt-make-fs.pl:37
30446 msgid "virt-make-fs - Make a filesystem from a tar archive or files"
30450 #: ../tools/virt-make-fs.pl:41
30453 " virt-make-fs [--options] input.tar output.img\n"
30458 #: ../tools/virt-make-fs.pl:43
30461 " virt-make-fs [--options] input.tar.gz output.img\n"
30466 #: ../tools/virt-make-fs.pl:45
30469 " virt-make-fs [--options] directory output.img\n"
30474 #: ../tools/virt-make-fs.pl:49
30476 "Virt-make-fs is a command line tool for creating a filesystem from a tar "
30477 "archive or some files in a directory. It is similar to tools like L<mkisofs"
30478 "(1)>, L<genisoimage(1)> and L<mksquashfs(1)>. Unlike those tools, it can "
30479 "create common filesystem types like ext2/3 or NTFS, which can be useful if "
30480 "you want to attach these filesystems to existing virtual machines (eg. to "
30481 "import large amounts of read-only data to a VM)."
30485 #: ../tools/virt-make-fs.pl:57
30486 msgid "Basic usage is:"
30490 #: ../tools/virt-make-fs.pl:59
30493 " virt-make-fs input output\n"
30498 #: ../tools/virt-make-fs.pl:61
30500 "where C<input> is either a directory containing files that you want to add, "
30501 "or a tar archive (either uncompressed tar or gzip-compressed tar); and "
30502 "C<output> is a disk image. The input type is detected automatically. The "
30503 "output disk image defaults to a raw ext2 image unless you specify extra "
30504 "flags (see L</OPTIONS> below)."
30508 #: ../tools/virt-make-fs.pl:67
30509 msgid "EXTRA SPACE"
30513 #: ../tools/virt-make-fs.pl:69
30515 "Unlike formats such as tar and squashfs, a filesystem does not \"just fit\" "
30516 "the files that it contains, but might have extra space. Depending on how "
30517 "you are going to use the output, you might think this extra space is wasted "
30518 "and want to minimize it, or you might want to leave space so that more files "
30519 "can be added later. Virt-make-fs defaults to minimizing the extra space, "
30520 "but you can use the I<--size> flag to leave space in the filesystem if you "
30525 #: ../tools/virt-make-fs.pl:77
30527 "An alternative way to leave extra space but not make the output image any "
30528 "bigger is to use an alternative disk image format (instead of the default "
30529 "\"raw\" format). Using I<--format=qcow2> will use the native QEmu/KVM qcow2 "
30530 "image format (check your hypervisor supports this before using it). This "
30531 "allows you to choose a large I<--size> but the extra space won't actually be "
30532 "allocated in the image until you try to store something in it."
30536 #: ../tools/virt-make-fs.pl:85
30538 "Don't forget that you can also use local commands including L<resize2fs(8)> "
30539 "and L<virt-resize(1)> to resize existing filesystems, or rerun virt-make-fs "
30540 "to build another image from scratch."
30544 #: ../tools/virt-make-fs.pl:89 ../tools/virt-make-fs.pl:123
30545 #: ../tools/virt-make-fs.pl:142
30550 #: ../tools/virt-make-fs.pl:91
30553 " virt-make-fs --format=qcow2 --size=+200M input output.img\n"
30558 #: ../tools/virt-make-fs.pl:93
30559 msgid "FILESYSTEM TYPE"
30563 #: ../tools/virt-make-fs.pl:95
30565 "The default filesystem type is C<ext2>. Just about any filesystem type that "
30566 "libguestfs supports can be used (but I<not> read-only formats like "
30567 "ISO9660). Here are some of the more common choices:"
30571 #: ../tools/virt-make-fs.pl:101
30576 #: ../tools/virt-make-fs.pl:103
30578 "Note that ext3 filesystems contain a journal, typically 1-32 MB in size. If "
30579 "you are not going to use the filesystem in a way that requires the journal, "
30580 "then this is just wasted overhead."
30584 #: ../tools/virt-make-fs.pl:107
30585 msgid "I<ntfs> or I<vfat>"
30589 #: ../tools/virt-make-fs.pl:109
30590 msgid "Useful if exporting data to a Windows guest."
30594 #: ../tools/virt-make-fs.pl:111
30596 "I<Note for vfat>: The tar archive or local directory must only contain files "
30597 "which are owned by root (ie. UID:GID = 0:0). The reason is that the tar "
30598 "program running within libguestfs is unable to change the ownership of non-"
30599 "root files, since vfat itself does not support this."
30603 #: ../tools/virt-make-fs.pl:116
30608 #: ../tools/virt-make-fs.pl:118
30610 "Lower overhead than C<ext2>, but certain limitations on filename length and "
30611 "total filesystem size."
30615 #: ../tools/virt-make-fs.pl:125
30618 " virt-make-fs --type=minix input minixfs.img\n"
30623 #: ../tools/virt-make-fs.pl:127
30624 msgid "TO PARTITION OR NOT TO PARTITION"
30628 #: ../tools/virt-make-fs.pl:129
30629 msgid "Optionally virt-make-fs can add a partition table to the output disk."
30633 #: ../tools/virt-make-fs.pl:131
30635 "Adding a partition can make the disk image more compatible with certain "
30636 "virtualized operating systems which don't expect to see a filesystem "
30637 "directly located on a block device (Linux doesn't care and will happily "
30638 "handle both types)."
30642 #: ../tools/virt-make-fs.pl:136
30644 "On the other hand, if you have a partition table then the output image is no "
30645 "longer a straight filesystem. For example you cannot run L<fsck(8)> "
30646 "directly on a partitioned disk image. (However libguestfs tools such as "
30647 "L<guestfish(1)> and L<virt-resize(1)> can still be used)."
30651 #: ../tools/virt-make-fs.pl:144
30652 msgid "Add an MBR partition:"
30656 #: ../tools/virt-make-fs.pl:146
30659 " virt-make-fs --partition -- input disk.img\n"
30664 #: ../tools/virt-make-fs.pl:148
30666 "If the output disk image could be terabyte-sized or larger, it's better to "
30667 "use an EFI/GPT-compatible partition table:"
30671 #: ../tools/virt-make-fs.pl:151
30674 " virt-make-fs --partition=gpt --size=+4T --format=qcow2 input disk.img\n"
30679 #: ../tools/virt-make-fs.pl:179
30680 msgid "Enable debugging information."
30684 #: ../tools/virt-make-fs.pl:185
30685 msgid "B<--size=E<lt>NE<gt>>"
30689 #: ../tools/virt-make-fs.pl:187
30690 msgid "B<--size=+E<lt>NE<gt>>"
30694 #: ../tools/virt-make-fs.pl:189
30695 msgid "B<-s E<lt>NE<gt>>"
30699 #: ../tools/virt-make-fs.pl:191
30700 msgid "B<-s +E<lt>NE<gt>>"
30704 #: ../tools/virt-make-fs.pl:193
30706 "Use the I<--size> (or I<-s>) option to choose the size of the output image."
30710 #: ../tools/virt-make-fs.pl:196
30712 "If this option is I<not> given, then the output image will be just large "
30713 "enough to contain all the files, with not much wasted space."
30717 #: ../tools/virt-make-fs.pl:199
30719 "To choose a fixed size output disk, specify an absolute number followed by b/"
30720 "K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
30721 "Petabytes or Exabytes. This must be large enough to contain all the input "
30722 "files, else you will get an error."
30726 #: ../tools/virt-make-fs.pl:204
30728 "To leave extra space, specify C<+> (plus sign) and a number followed by b/K/"
30729 "M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
30730 "Petabytes or Exabytes. For example: I<--size=+200M> means enough space for "
30731 "the input files, and (approximately) an extra 200 MB free space."
30735 #: ../tools/virt-make-fs.pl:210
30737 "Note that virt-make-fs estimates free space, and therefore will not produce "
30738 "filesystems containing precisely the free space requested. (It is much more "
30739 "expensive and time-consuming to produce a filesystem which has precisely the "
30740 "desired free space)."
30744 #: ../tools/virt-make-fs.pl:219
30745 msgid "B<--format=E<lt>fmtE<gt>>"
30749 #: ../tools/virt-make-fs.pl:221
30750 msgid "B<-F E<lt>fmtE<gt>>"
30754 #: ../tools/virt-make-fs.pl:223
30755 msgid "Choose the output disk image format."
30759 #: ../tools/virt-make-fs.pl:225
30760 msgid "The default is C<raw> (raw disk image)."
30764 #: ../tools/virt-make-fs.pl:227
30766 "For other choices, see the L<qemu-img(1)> manpage. The only other choice "
30767 "that would really make sense here is C<qcow2>."
30771 #: ../tools/virt-make-fs.pl:234
30772 msgid "B<--type=E<lt>fsE<gt>>"
30776 #: ../tools/virt-make-fs.pl:236
30777 msgid "B<-t E<lt>fsE<gt>>"
30781 #: ../tools/virt-make-fs.pl:238
30782 msgid "Choose the output filesystem type."
30786 #: ../tools/virt-make-fs.pl:240
30787 msgid "The default is C<ext2>."
30791 #: ../tools/virt-make-fs.pl:242
30793 "Any filesystem which is supported read-write by libguestfs can be used here."
30797 #: ../tools/virt-make-fs.pl:249
30798 msgid "B<--partition>"
30802 #: ../tools/virt-make-fs.pl:251
30803 msgid "B<--partition=E<lt>parttypeE<gt>>"
30807 #: ../tools/virt-make-fs.pl:253
30809 "If specified, this flag adds an MBR partition table to the output disk image."
30813 #: ../tools/virt-make-fs.pl:256
30815 "You can change the partition table type, eg. I<--partition=gpt> for large "
30820 #: ../tools/virt-make-fs.pl:259
30822 "Note that if you just use a lonesome I<--partition>, the Perl option parser "
30823 "might consider the next parameter to be the partition type. For example:"
30827 #: ../tools/virt-make-fs.pl:263
30830 " virt-make-fs --partition input.tar ...\n"
30835 #: ../tools/virt-make-fs.pl:265
30837 "would cause virt-make-fs to think you wanted to use a partition type of "
30838 "C<input.tar> which is completely wrong. To avoid this, use I<--> (a double "
30839 "dash) between options and the input file argument:"
30843 #: ../tools/virt-make-fs.pl:269
30846 " virt-make-fs --partition -- input.tar ...\n"
30851 #: ../tools/virt-make-fs.pl:541
30853 "L<guestfish(1)>, L<virt-resize(1)>, L<virt-tar-in(1)>, L<mkisofs(1)>, "
30854 "L<genisoimage(1)>, L<mksquashfs(1)>, L<mke2fs(8)>, L<resize2fs(8)>, L<guestfs"
30855 "(3)>, L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
30859 #: ../tools/virt-make-fs.pl:558
30862 " export LIBGUESTFS_DEBUG=1\n"
30863 " virt-make-fs --debug [...] > /tmp/virt-make-fs.log 2>&1\n"
30868 #: ../tools/virt-make-fs.pl:561
30870 "Attach /tmp/virt-make-fs.log to a new bug report at L<https://bugzilla."
30875 #: ../tools/virt-list-partitions.pl:32
30877 "virt-list-partitions - List partitions in a virtual machine or disk image"
30881 #: ../tools/virt-list-partitions.pl:36
30884 " virt-list-partitions [--options] domname\n"
30889 #: ../tools/virt-list-partitions.pl:38
30892 " virt-list-partitions [--options] disk.img [disk.img ...]\n"
30897 #: ../tools/virt-list-partitions.pl:45
30899 "C<virt-list-partitions> is a command line tool to list the partitions that "
30900 "are contained in a virtual machine or disk image. It is mainly useful as a "
30901 "first step to using L<virt-resize(1)>."
30905 #: ../tools/virt-list-partitions.pl:50
30907 "C<virt-list-partitions> is just a simple wrapper around L<libguestfs(3)> "
30908 "functionality. For more complex cases you should look at the L<guestfish(1)"
30913 #: ../tools/virt-list-partitions.pl:107
30914 msgid "B<-h> | B<--human-readable>"
30918 #: ../tools/virt-list-partitions.pl:109
30919 msgid "Show sizes in human-readable form (eg. \"1G\")."
30923 #: ../tools/virt-list-partitions.pl:117
30925 "With this option, C<virt-list-partitions> displays the type and size of each "
30926 "partition too (where \"type\" means C<ext3>, C<pv> etc.)"
30930 #: ../tools/virt-list-partitions.pl:124
30931 msgid "B<-t> | B<--total>"
30935 #: ../tools/virt-list-partitions.pl:126
30937 "Display the total size of each block device (as a separate row or rows)."
30941 #: ../tools/virt-list-partitions.pl:259
30943 "L<guestfs(3)>, L<guestfish(1)>, L<virt-filesystems(1)>, L<virt-list-"
30944 "filesystems(1)>, L<virt-resize(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib"
30945 "(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
30949 #: ../tools/virt-list-partitions.pl:275
30950 msgid "Copyright (C) 2009-2010 Red Hat Inc."