1 # SOME DESCRIPTIVE TITLE
2 # Copyright (C) YEAR Red Hat Inc.
3 # This file is distributed under the same license as the libguestfs package.
4 # FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
8 "Project-Id-Version: libguestfs\n"
9 "Report-Msgid-Bugs-To: libguestfs@redhat.com\n"
10 "POT-Creation-Date: 2011-04-18 22:36+0200\n"
11 "PO-Revision-Date: 2011-04-01 15:39+0000\n"
12 "Last-Translator: yurchor <yurchor@ukr.net>\n"
13 "Language-Team: Ukrainian <trans-uk@lists.fedoraproject.org>\n"
16 "Content-Type: text/plain; charset=UTF-8\n"
17 "Content-Transfer-Encoding: 8bit\n"
18 "Plural-Forms: nplurals=3; plural=(n%10==1 && n%100!=11 ? 0 : n%10>=2 && n"
19 "%10<=4 && (n%100<10 || n%100>=20) ? 1 : 2)\n"
22 #: ../src/guestfs.pod:3 ../fish/guestfish.pod:3
23 #: ../test-tool/libguestfs-test-tool.pod:3 ../fuse/guestmount.pod:3
24 #: ../tools/virt-edit.pl:32 ../tools/virt-win-reg.pl:35
25 #: ../tools/virt-list-filesystems.pl:30 ../tools/virt-tar.pl:31
26 #: ../tools/virt-make-fs.pl:35 ../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-edit.pl:36 ../tools/virt-win-reg.pl:39
41 #: ../tools/virt-list-filesystems.pl:34 ../tools/virt-tar.pl:35
42 #: ../tools/virt-make-fs.pl:39 ../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-edit.pl:50 ../tools/virt-win-reg.pl:63
96 #: ../tools/virt-list-filesystems.pl:40 ../tools/virt-tar.pl:77
97 #: ../tools/virt-make-fs.pl:47 ../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 pipe 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:1087
858 #: ../src/guestfs.pod:1091 ../src/guestfs.pod:1095 ../src/guestfs.pod:1100
859 #: ../src/guestfs.pod:1108 ../src/guestfs.pod:1127 ../src/guestfs.pod:1135
860 #: ../src/guestfs.pod:1157 ../src/guestfs.pod:1161 ../src/guestfs.pod:1165
861 #: ../src/guestfs.pod:1169 ../src/guestfs.pod:1173 ../src/guestfs.pod:1177
862 #: ../src/guestfs.pod:1659 ../src/guestfs.pod:1664 ../src/guestfs.pod:1668
863 #: ../src/guestfs.pod:1769 ../src/guestfs.pod:1774 ../src/guestfs.pod:1778
864 #: ../src/guestfs.pod:1788 ../src/guestfs.pod:2022 ../src/guestfs.pod:2027
865 #: ../src/guestfs.pod:2033 ../src/guestfs.pod:2041 ../src/guestfs.pod:2395
866 #: ../src/guestfs.pod:2401 ../src/guestfs.pod:2406 ../src/guestfs.pod:2412
867 #: ../src/guestfs.pod:2877 ../src/guestfs.pod:2881 ../src/guestfs.pod:2885
868 #: ../src/guestfs.pod:2889 ../src/guestfs-actions.pod:15
869 #: ../src/guestfs-actions.pod:22 ../src/guestfs-actions.pod:577
870 #: ../src/guestfs-actions.pod:585 ../src/guestfs-actions.pod:592
871 #: ../src/guestfs-actions.pod:599 ../src/guestfs-actions.pod:1600
872 #: ../src/guestfs-actions.pod:1604 ../src/guestfs-actions.pod:1608
873 #: ../src/guestfs-actions.pod:1612 ../src/guestfs-actions.pod:1620
874 #: ../src/guestfs-actions.pod:1624 ../src/guestfs-actions.pod:1628
875 #: ../src/guestfs-actions.pod:1638 ../src/guestfs-actions.pod:1642
876 #: ../src/guestfs-actions.pod:1646 ../src/guestfs-actions.pod:1784
877 #: ../src/guestfs-actions.pod:1788 ../src/guestfs-actions.pod:1793
878 #: ../src/guestfs-actions.pod:1798 ../src/guestfs-actions.pod:1859
879 #: ../src/guestfs-actions.pod:1863 ../src/guestfs-actions.pod:1868
880 #: ../fish/guestfish.pod:443 ../fish/guestfish.pod:447
881 #: ../fish/guestfish.pod:451 ../fish/guestfish.pod:455
882 #: ../fish/guestfish-actions.pod:13 ../fish/guestfish-actions.pod:20
883 #: ../fish/guestfish-actions.pod:380 ../fish/guestfish-actions.pod:388
884 #: ../fish/guestfish-actions.pod:395 ../fish/guestfish-actions.pod:402
885 #: ../fish/guestfish-actions.pod:1072 ../fish/guestfish-actions.pod:1076
886 #: ../fish/guestfish-actions.pod:1080 ../fish/guestfish-actions.pod:1084
887 #: ../fish/guestfish-actions.pod:1092 ../fish/guestfish-actions.pod:1096
888 #: ../fish/guestfish-actions.pod:1100 ../fish/guestfish-actions.pod:1110
889 #: ../fish/guestfish-actions.pod:1114 ../fish/guestfish-actions.pod:1118
890 #: ../fish/guestfish-actions.pod:1208 ../fish/guestfish-actions.pod:1212
891 #: ../fish/guestfish-actions.pod:1217 ../fish/guestfish-actions.pod:1222
892 #: ../fish/guestfish-actions.pod:1264 ../fish/guestfish-actions.pod:1268
893 #: ../fish/guestfish-actions.pod:1273 ../tools/virt-edit.pl:351
894 #: ../tools/virt-edit.pl:356 ../tools/virt-edit.pl:361
895 #: ../tools/virt-edit.pl:372 ../tools/virt-edit.pl:376
896 #: ../tools/virt-win-reg.pl:536 ../tools/virt-win-reg.pl:542
897 #: ../tools/virt-win-reg.pl:548
902 #: ../src/guestfs.pod:390
904 "The kernel version that the command runs under will be different from what "
909 #: ../src/guestfs.pod:395
911 "If the command needs to communicate with daemons, then most likely they "
916 #: ../src/guestfs.pod:400
917 msgid "The command will be running in limited memory."
921 #: ../src/guestfs.pod:404
923 "The network may not be available unless you enable it (see L</"
924 "guestfs_set_network>)."
928 #: ../src/guestfs.pod:409
929 msgid "Only supports Linux guests (not Windows, BSD, etc)."
933 #: ../src/guestfs.pod:413
935 "Architecture limitations (eg. won't work for a PPC guest on an X86 host)."
939 #: ../src/guestfs.pod:418
941 "For SELinux guests, you may need to enable SELinux and load policy first. "
942 "See L</SELINUX> in this manpage."
946 #: ../src/guestfs.pod:423
948 "I<Security:> It is not safe to run commands from untrusted, possibly "
949 "malicious guests. These commands may attempt to exploit your program by "
950 "sending unexpected output. They could also try to exploit the Linux kernel "
951 "or qemu provided by the libguestfs appliance. They could use the network "
952 "provided by the libguestfs appliance to bypass ordinary network partitions "
953 "and firewalls. They could use the elevated privileges or different SELinux "
954 "context of your program to their advantage."
958 #: ../src/guestfs.pod:432
960 "A secure alternative is to use libguestfs to install a \"firstboot\" script "
961 "(a script which runs when the guest next boots normally), and to have this "
962 "script run the commands you want in the normal context of the running guest, "
963 "network security and so on. For information about other security issues, "
968 #: ../src/guestfs.pod:440
970 "The two main API calls to run commands are L</guestfs_command> and L</"
971 "guestfs_sh> (there are also variations)."
975 #: ../src/guestfs.pod:443
977 "The difference is that L</guestfs_sh> runs commands using the shell, so any "
978 "shell globs, redirections, etc will work."
982 #: ../src/guestfs.pod:446
983 msgid "CONFIGURATION FILES"
984 msgstr "ФАЙЛИ НАЛАШТУВАННЯ"
987 #: ../src/guestfs.pod:448
989 "To read and write configuration files in Linux guest filesystems, we "
990 "strongly recommend using Augeas. For example, Augeas understands how to "
991 "read and write, say, a Linux shadow password file or X.org configuration "
992 "file, and so avoids you having to write that code."
996 #: ../src/guestfs.pod:453
998 "The main Augeas calls are bound through the C<guestfs_aug_*> APIs. We don't "
999 "document Augeas itself here because there is excellent documentation on the "
1000 "L<http://augeas.net/> website."
1004 #: ../src/guestfs.pod:457
1006 "If you don't want to use Augeas (you fool!) then try calling L</"
1007 "guestfs_read_lines> to get the file as a list of lines which you can iterate "
1012 #: ../src/guestfs.pod:461
1017 #: ../src/guestfs.pod:463
1019 "We support SELinux guests. To ensure that labeling happens correctly in "
1020 "SELinux guests, you need to enable SELinux and load the guest's policy:"
1024 #: ../src/guestfs.pod:469 ../src/guestfs.pod:1280 ../src/guestfs.pod:1411
1025 #: ../src/guestfs.pod:2440
1030 #: ../src/guestfs.pod:471
1031 msgid "Before launching, do:"
1035 #: ../src/guestfs.pod:473
1038 " guestfs_set_selinux (g, 1);\n"
1043 #: ../src/guestfs.pod:475 ../src/guestfs.pod:1284 ../src/guestfs.pod:1415
1044 #: ../src/guestfs.pod:2465
1049 #: ../src/guestfs.pod:477
1051 "After mounting the guest's filesystem(s), load the policy. This is best "
1052 "done by running the L<load_policy(8)> command in the guest itself:"
1056 #: ../src/guestfs.pod:481
1059 " guestfs_sh (g, \"/usr/sbin/load_policy\");\n"
1064 #: ../src/guestfs.pod:483
1066 "(Older versions of C<load_policy> require you to specify the name of the "
1071 #: ../src/guestfs.pod:486 ../src/guestfs.pod:1421
1076 #: ../src/guestfs.pod:488
1078 "Optionally, set the security context for the API. The correct security "
1079 "context to use can only be known by inspecting the guest. As an example:"
1083 #: ../src/guestfs.pod:492
1086 " guestfs_setcon (g, \"unconfined_u:unconfined_r:unconfined_t:s0\");\n"
1091 #: ../src/guestfs.pod:496
1092 msgid "This will work for running commands and editing existing files."
1096 #: ../src/guestfs.pod:498
1098 "When new files are created, you may need to label them explicitly, for "
1099 "example by running the external command C<restorecon pathname>."
1103 #: ../src/guestfs.pod:502
1108 #: ../src/guestfs.pod:504
1110 "Certain calls are affected by the current file mode creation mask (the "
1111 "\"umask\"). In particular ones which create files or directories, such as "
1112 "L</guestfs_touch>, L</guestfs_mknod> or L</guestfs_mkdir>. This affects "
1113 "either the default mode that the file is created with or modifies the mode "
1118 #: ../src/guestfs.pod:510
1120 "The default umask is C<022>, so files are created with modes such as C<0644> "
1121 "and directories with C<0755>."
1125 #: ../src/guestfs.pod:513
1127 "There are two ways to avoid being affected by umask. Either set umask to 0 "
1128 "(call C<guestfs_umask (g, 0)> early after launching). Or call L</"
1129 "guestfs_chmod> after creating each file or directory."
1133 #: ../src/guestfs.pod:517
1134 msgid "For more information about umask, see L<umask(2)>."
1138 #: ../src/guestfs.pod:519 ../fish/guestfish.pod:765
1139 msgid "ENCRYPTED DISKS"
1143 #: ../src/guestfs.pod:521
1145 "Libguestfs allows you to access Linux guests which have been encrypted using "
1146 "whole disk encryption that conforms to the Linux Unified Key Setup (LUKS) "
1147 "standard. This includes nearly all whole disk encryption systems used by "
1148 "modern Linux guests."
1152 #: ../src/guestfs.pod:527
1154 "Use L</guestfs_vfs_type> to identify LUKS-encrypted block devices (it "
1155 "returns the string C<crypto_LUKS>)."
1159 #: ../src/guestfs.pod:530
1161 "Then open these devices by calling L</guestfs_luks_open>. Obviously you "
1162 "will require the passphrase!"
1166 #: ../src/guestfs.pod:533
1168 "Opening a LUKS device creates a new device mapper device called C</dev/"
1169 "mapper/mapname> (where C<mapname> is the string you supply to L</"
1170 "guestfs_luks_open>). Reads and writes to this mapper device are decrypted "
1171 "from and encrypted to the underlying block device respectively."
1175 #: ../src/guestfs.pod:539
1177 "LVM volume groups on the device can be made visible by calling L</"
1178 "guestfs_vgscan> followed by L</guestfs_vg_activate_all>. The logical volume"
1179 "(s) can now be mounted in the usual way."
1183 #: ../src/guestfs.pod:543
1185 "Use the reverse process to close a LUKS device. Unmount any logical volumes "
1186 "on it, deactivate the volume groups by caling C<guestfs_vg_activate (g, 0, "
1187 "[\"/dev/VG\"])>. Then close the mapper device by calling L</"
1188 "guestfs_luks_close> on the C</dev/mapper/mapname> device (I<not> the "
1189 "underlying encrypted block device)."
1193 #: ../src/guestfs.pod:550
1198 #: ../src/guestfs.pod:552
1200 "Libguestfs has APIs for inspecting an unknown disk image to find out if it "
1201 "contains operating systems, an install CD or a live CD. (These APIs used to "
1202 "be in a separate Perl-only library called L<Sys::Guestfs::Lib(3)> but since "
1203 "version 1.5.3 the most frequently used part of this library has been "
1204 "rewritten in C and moved into the core code)."
1208 #: ../src/guestfs.pod:559
1210 "Add all disks belonging to the unknown virtual machine and call L</"
1211 "guestfs_launch> in the usual way."
1215 #: ../src/guestfs.pod:562
1217 "Then call L</guestfs_inspect_os>. This function uses other libguestfs calls "
1218 "and certain heuristics, and returns a list of operating systems that were "
1219 "found. An empty list means none were found. A single element is the root "
1220 "filesystem of the operating system. For dual- or multi-boot guests, "
1221 "multiple roots can be returned, each one corresponding to a separate "
1222 "operating system. (Multi-boot virtual machines are extremely rare in the "
1223 "world of virtualization, but since this scenario can happen, we have built "
1224 "libguestfs to deal with it.)"
1228 #: ../src/guestfs.pod:571
1230 "For each root, you can then call various C<guestfs_inspect_get_*> functions "
1231 "to get additional details about that operating system. For example, call L</"
1232 "guestfs_inspect_get_type> to return the string C<windows> or C<linux> for "
1233 "Windows and Linux-based operating systems respectively."
1237 #: ../src/guestfs.pod:577
1239 "Un*x-like and Linux-based operating systems usually consist of several "
1240 "filesystems which are mounted at boot time (for example, a separate boot "
1241 "partition mounted on C</boot>). The inspection rules are able to detect how "
1242 "filesystems correspond to mount points. Call "
1243 "C<guestfs_inspect_get_mountpoints> to get this mapping. It might return a "
1244 "hash table like this example:"
1248 #: ../src/guestfs.pod:584
1251 " /boot => /dev/sda1\n"
1252 " / => /dev/vg_guest/lv_root\n"
1253 " /usr => /dev/vg_guest/lv_usr\n"
1258 #: ../src/guestfs.pod:588
1260 "The caller can then make calls to L</guestfs_mount_options> to mount the "
1261 "filesystems as suggested."
1265 #: ../src/guestfs.pod:591
1267 "Be careful to mount filesystems in the right order (eg. C</> before C</"
1268 "usr>). Sorting the keys of the hash by length, shortest first, should work."
1272 #: ../src/guestfs.pod:595
1274 "Inspection currently only works for some common operating systems. "
1275 "Contributors are welcome to send patches for other operating systems that we "
1276 "currently cannot detect."
1280 #: ../src/guestfs.pod:599
1282 "Encrypted disks must be opened before inspection. See L</ENCRYPTED DISKS> "
1283 "for more details. The L</guestfs_inspect_os> function just ignores any "
1284 "encrypted devices."
1288 #: ../src/guestfs.pod:603
1290 "A note on the implementation: The call L</guestfs_inspect_os> performs "
1291 "inspection and caches the results in the guest handle. Subsequent calls to "
1292 "C<guestfs_inspect_get_*> return this cached information, but I<do not> re-"
1293 "read the disks. If you change the content of the guest disks, you can redo "
1294 "inspection by calling L</guestfs_inspect_os> again. (L</"
1295 "guestfs_inspect_list_applications> works a little differently from the other "
1296 "calls and does read the disks. See documentation for that function for "
1301 #: ../src/guestfs.pod:612
1302 msgid "INSPECTING INSTALL DISKS"
1306 #: ../src/guestfs.pod:614
1308 "Libguestfs (since 1.9.4) can detect some install disks, install CDs, live "
1313 #: ../src/guestfs.pod:617
1315 "Call L</guestfs_inspect_get_format> to return the format of the operating "
1316 "system, which currently can be C<installed> (a regular operating system) or "
1317 "C<installer> (some sort of install disk)."
1321 #: ../src/guestfs.pod:621
1323 "Further information is available about the operating system that can be "
1324 "installed using the regular inspection APIs like L</"
1325 "guestfs_inspect_get_product_name>, L</guestfs_inspect_get_major_version> etc."
1329 #: ../src/guestfs.pod:626
1331 "Some additional information specific to installer disks is also available "
1332 "from the L</guestfs_inspect_is_live>, L</guestfs_inspect_is_netinst> and L</"
1333 "guestfs_inspect_is_multipart> calls."
1337 #: ../src/guestfs.pod:631
1338 msgid "SPECIAL CONSIDERATIONS FOR WINDOWS GUESTS"
1342 #: ../src/guestfs.pod:633
1344 "Libguestfs can mount NTFS partitions. It does this using the L<http://www."
1345 "ntfs-3g.org/> driver."
1349 #: ../src/guestfs.pod:636
1350 msgid "DRIVE LETTERS AND PATHS"
1354 #: ../src/guestfs.pod:638
1356 "DOS and Windows still use drive letters, and the filesystems are always "
1357 "treated as case insensitive by Windows itself, and therefore you might find "
1358 "a Windows configuration file referring to a path like C<c:\\windows"
1359 "\\system32>. When the filesystem is mounted in libguestfs, that directory "
1360 "might be referred to as C</WINDOWS/System32>."
1364 #: ../src/guestfs.pod:644
1366 "Drive letter mappings can be found using inspection (see L</INSPECTION> and "
1367 "L</guestfs_inspect_get_drive_mappings>)"
1371 #: ../src/guestfs.pod:647
1373 "Dealing with separator characters (backslash vs forward slash) is outside "
1374 "the scope of libguestfs, but usually a simple character replacement will "
1379 #: ../src/guestfs.pod:651
1381 "To resolve the case insensitivity of paths, call L</"
1382 "guestfs_case_sensitive_path>."
1386 #: ../src/guestfs.pod:654
1387 msgid "ACCESSING THE WINDOWS REGISTRY"
1391 #: ../src/guestfs.pod:656
1393 "Libguestfs also provides some help for decoding Windows Registry \"hive\" "
1394 "files, through the library C<hivex> which is part of the libguestfs project "
1395 "although ships as a separate tarball. You have to locate and download the "
1396 "hive file(s) yourself, and then pass them to C<hivex> functions. See also "
1397 "the programs L<hivexml(1)>, L<hivexsh(1)>, L<hivexregedit(1)> and L<virt-win-"
1398 "reg(1)> for more help on this issue."
1402 #: ../src/guestfs.pod:664
1403 msgid "SYMLINKS ON NTFS-3G FILESYSTEMS"
1407 #: ../src/guestfs.pod:666
1409 "Ntfs-3g tries to rewrite \"Junction Points\" and NTFS \"symbolic links\" to "
1410 "provide something which looks like a Linux symlink. The way it tries to do "
1411 "the rewriting is described here:"
1415 #: ../src/guestfs.pod:670
1417 "L<http://www.tuxera.com/community/ntfs-3g-advanced/junction-points-and-"
1420 "L<http://www.tuxera.com/community/ntfs-3g-advanced/junction-points-and-"
1424 #: ../src/guestfs.pod:672
1426 "The essential problem is that ntfs-3g simply does not have enough "
1427 "information to do a correct job. NTFS links can contain drive letters and "
1428 "references to external device GUIDs that ntfs-3g has no way of resolving. "
1429 "It is almost certainly the case that libguestfs callers should ignore what "
1430 "ntfs-3g does (ie. don't use L</guestfs_readlink> on NTFS volumes)."
1434 #: ../src/guestfs.pod:679
1436 "Instead if you encounter a symbolic link on an ntfs-3g filesystem, use L</"
1437 "guestfs_lgetxattr> to read the C<system.ntfs_reparse_data> extended "
1438 "attribute, and read the raw reparse data from that (you can find the format "
1439 "documented in various places around the web)."
1443 #: ../src/guestfs.pod:684
1444 msgid "EXTENDED ATTRIBUTES ON NTFS-3G FILESYSTEMS"
1448 #: ../src/guestfs.pod:686
1450 "There are other useful extended attributes that can be read from ntfs-3g "
1451 "filesystems (using L</guestfs_getxattr>). See:"
1455 #: ../src/guestfs.pod:689
1457 "L<http://www.tuxera.com/community/ntfs-3g-advanced/extended-attributes/>"
1459 "L<http://www.tuxera.com/community/ntfs-3g-advanced/extended-attributes/>"
1462 #: ../src/guestfs.pod:691
1463 msgid "USING LIBGUESTFS WITH OTHER PROGRAMMING LANGUAGES"
1467 #: ../src/guestfs.pod:693
1469 "Although we don't want to discourage you from using the C API, we will "
1470 "mention here that the same API is also available in other languages."
1474 #: ../src/guestfs.pod:696
1476 "The API is broadly identical in all supported languages. This means that "
1477 "the C call C<guestfs_add_drive_ro(g,file)> is C<$g-E<gt>add_drive_ro($file)> "
1478 "in Perl, C<g.add_drive_ro(file)> in Python, and C<g#add_drive_ro file> in "
1479 "OCaml. In other words, a straightforward, predictable isomorphism between "
1484 #: ../src/guestfs.pod:702
1486 "Error messages are automatically transformed into exceptions if the language "
1491 #: ../src/guestfs.pod:705
1493 "We don't try to \"object orientify\" parts of the API in OO languages, "
1494 "although contributors are welcome to write higher level APIs above what we "
1495 "provide in their favourite languages if they wish."
1499 #: ../src/guestfs.pod:711
1504 #: ../src/guestfs.pod:713
1506 "You can use the I<guestfs.h> header file from C++ programs. The C++ API is "
1507 "identical to the C API. C++ classes and exceptions are not used."
1511 #: ../src/guestfs.pod:717
1516 #: ../src/guestfs.pod:719
1518 "The C# bindings are highly experimental. Please read the warnings at the "
1519 "top of C<csharp/Libguestfs.cs>."
1523 #: ../src/guestfs.pod:722
1528 #: ../src/guestfs.pod:724
1530 "This is the only language binding that is working but incomplete. Only "
1531 "calls which return simple integers have been bound in Haskell, and we are "
1532 "looking for help to complete this binding."
1536 #: ../src/guestfs.pod:728
1541 #: ../src/guestfs.pod:730
1543 "Full documentation is contained in the Javadoc which is distributed with "
1548 #: ../src/guestfs.pod:733
1553 #: ../src/guestfs.pod:735
1554 msgid "See L<guestfs-ocaml(3)>."
1555 msgstr "Див. L<guestfs-ocaml(3)>."
1558 #: ../src/guestfs.pod:737
1563 #: ../src/guestfs.pod:739
1564 msgid "See L<guestfs-perl(3)> and L<Sys::Guestfs(3)>."
1565 msgstr "Див. L<guestfs-perl(3)> та L<Sys::Guestfs(3)>."
1568 #: ../src/guestfs.pod:741
1573 #: ../src/guestfs.pod:743
1575 "For documentation see C<README-PHP> supplied with libguestfs sources or in "
1576 "the php-libguestfs package for your distribution."
1580 #: ../src/guestfs.pod:746
1581 msgid "The PHP binding only works correctly on 64 bit machines."
1585 #: ../src/guestfs.pod:748
1590 #: ../src/guestfs.pod:750
1591 msgid "See L<guestfs-python(3)>."
1592 msgstr "Див. L<guestfs-python(3)>."
1595 #: ../src/guestfs.pod:752
1600 #: ../src/guestfs.pod:754
1601 msgid "See L<guestfs-ruby(3)>."
1602 msgstr "Див. L<guestfs-ruby(3)>."
1605 #: ../src/guestfs.pod:756
1606 msgid "B<shell scripts>"
1607 msgstr "B<скрипти оболонки>"
1610 #: ../src/guestfs.pod:758
1611 msgid "See L<guestfish(1)>."
1612 msgstr "Див. L<guestfish(1)>."
1615 #: ../src/guestfs.pod:762
1616 msgid "LIBGUESTFS GOTCHAS"
1620 #: ../src/guestfs.pod:764
1622 "L<http://en.wikipedia.org/wiki/Gotcha_(programming)>: \"A feature of a "
1623 "system [...] that works in the way it is documented but is counterintuitive "
1624 "and almost invites mistakes.\""
1628 #: ../src/guestfs.pod:768
1630 "Since we developed libguestfs and the associated tools, there are several "
1631 "things we would have designed differently, but are now stuck with for "
1632 "backwards compatibility or other reasons. If there is ever a libguestfs 2.0 "
1633 "release, you can expect these to change. Beware of them."
1637 #: ../src/guestfs.pod:776
1638 msgid "Autosync / forgetting to sync."
1642 #: ../src/guestfs.pod:778
1644 "When modifying a filesystem from C or another language, you B<must> unmount "
1645 "all filesystems and call L</guestfs_sync> explicitly before you close the "
1646 "libguestfs handle. You can also call:"
1650 #: ../src/guestfs.pod:782
1653 " guestfs_set_autosync (g, 1);\n"
1658 #: ../src/guestfs.pod:784
1660 "to have the unmount/sync done automatically for you when the handle 'g' is "
1661 "closed. (This feature is called \"autosync\", L</guestfs_set_autosync> q.v.)"
1665 #: ../src/guestfs.pod:788
1667 "If you forget to do this, then it is entirely possible that your changes "
1668 "won't be written out, or will be partially written, or (very rarely) that "
1669 "you'll get disk corruption."
1673 #: ../src/guestfs.pod:792
1675 "Note that in L<guestfish(3)> autosync is the default. So quick and dirty "
1676 "guestfish scripts that forget to sync will work just fine, which can make "
1677 "this very puzzling if you are trying to debug a problem."
1681 #: ../src/guestfs.pod:796
1683 "Update: Autosync is enabled by default for all API users starting from "
1684 "libguestfs 1.5.24."
1688 #: ../src/guestfs.pod:799
1689 msgid "Mount option C<-o sync> should not be the default."
1693 #: ../src/guestfs.pod:801
1695 "If you use L</guestfs_mount>, then C<-o sync,noatime> are added implicitly. "
1696 "However C<-o sync> does not add any reliability benefit, but does have a "
1697 "very large performance impact."
1701 #: ../src/guestfs.pod:805
1703 "The work around is to use L</guestfs_mount_options> and set the mount "
1704 "options that you actually want to use."
1708 #: ../src/guestfs.pod:808
1709 msgid "Read-only should be the default."
1713 #: ../src/guestfs.pod:810
1715 "In L<guestfish(3)>, I<--ro> should be the default, and you should have to "
1716 "specify I<--rw> if you want to make changes to the image."
1720 #: ../src/guestfs.pod:813
1721 msgid "This would reduce the potential to corrupt live VM images."
1725 #: ../src/guestfs.pod:815
1727 "Note that many filesystems change the disk when you just mount and unmount, "
1728 "even if you didn't perform any writes. You need to use L</"
1729 "guestfs_add_drive_ro> to guarantee that the disk is not changed."
1733 #: ../src/guestfs.pod:819
1734 msgid "guestfish command line is hard to use."
1738 #: ../src/guestfs.pod:821
1740 "C<guestfish disk.img> doesn't do what people expect (open C<disk.img> for "
1741 "examination). It tries to run a guestfish command C<disk.img> which doesn't "
1742 "exist, so it fails. In earlier versions of guestfish the error message was "
1743 "also unintuitive, but we have corrected this since. Like the Bourne shell, "
1744 "we should have used C<guestfish -c command> to run commands."
1748 #: ../src/guestfs.pod:828
1749 msgid "guestfish megabyte modifiers don't work right on all commands"
1753 #: ../src/guestfs.pod:830
1755 "In recent guestfish you can use C<1M> to mean 1 megabyte (and similarly for "
1756 "other modifiers). What guestfish actually does is to multiply the number "
1757 "part by the modifier part and pass the result to the C API. However this "
1758 "doesn't work for a few APIs which aren't expecting bytes, but are already "
1759 "expecting some other unit (eg. megabytes)."
1763 #: ../src/guestfs.pod:837
1764 msgid "The most common is L</guestfs_lvcreate>. The guestfish command:"
1768 #: ../src/guestfs.pod:839
1771 " lvcreate LV VG 100M\n"
1776 #: ../src/guestfs.pod:841
1778 "does not do what you might expect. Instead because L</guestfs_lvcreate> is "
1779 "already expecting megabytes, this tries to create a 100 I<terabyte> (100 "
1780 "megabytes * megabytes) logical volume. The error message you get from this "
1781 "is also a little obscure."
1785 #: ../src/guestfs.pod:846
1787 "This could be fixed in the generator by specially marking parameters and "
1788 "return values which take bytes or other units."
1792 #: ../src/guestfs.pod:849
1793 msgid "Ambiguity between devices and paths"
1797 #: ../src/guestfs.pod:851
1799 "There is a subtle ambiguity in the API between a device name (eg. C</dev/"
1800 "sdb2>) and a similar pathname. A file might just happen to be called "
1801 "C<sdb2> in the directory C</dev> (consider some non-Unix VM image)."
1805 #: ../src/guestfs.pod:856
1807 "In the current API we usually resolve this ambiguity by having two separate "
1808 "calls, for example L</guestfs_checksum> and L</guestfs_checksum_device>. "
1809 "Some API calls are ambiguous and (incorrectly) resolve the problem by "
1810 "detecting if the path supplied begins with C</dev/>."
1814 #: ../src/guestfs.pod:862
1816 "To avoid both the ambiguity and the need to duplicate some calls, we could "
1817 "make paths/devices into structured names. One way to do this would be to "
1818 "use a notation like grub (C<hd(0,0)>), although nobody really likes this "
1819 "aspect of grub. Another way would be to use a structured type, equivalent "
1820 "to this OCaml type:"
1824 #: ../src/guestfs.pod:868
1827 " type path = Path of string | Device of int | Partition of int * int\n"
1832 #: ../src/guestfs.pod:870
1833 msgid "which would allow you to pass arguments like:"
1837 #: ../src/guestfs.pod:872
1840 " Path \"/foo/bar\"\n"
1841 " Device 1 (* /dev/sdb, or perhaps /dev/sda *)\n"
1842 " Partition (1, 2) (* /dev/sdb2 (or is it /dev/sda2 or /dev/sdb3?) *)\n"
1843 " Path \"/dev/sdb2\" (* not a device *)\n"
1848 #: ../src/guestfs.pod:877
1850 "As you can see there are still problems to resolve even with this "
1851 "representation. Also consider how it might work in guestfish."
1855 #: ../src/guestfs.pod:882
1856 msgid "PROTOCOL LIMITS"
1860 #: ../src/guestfs.pod:884
1862 "Internally libguestfs uses a message-based protocol to pass API calls and "
1863 "their responses to and from a small \"appliance\" (see L</INTERNALS> for "
1864 "plenty more detail about this). The maximum message size used by the "
1865 "protocol is slightly less than 4 MB. For some API calls you may need to be "
1866 "aware of this limit. The API calls which may be affected are individually "
1867 "documented, with a link back to this section of the documentation."
1871 #: ../src/guestfs.pod:892
1873 "A simple call such as L</guestfs_cat> returns its result (the file data) in "
1874 "a simple string. Because this string is at some point internally encoded as "
1875 "a message, the maximum size that it can return is slightly under 4 MB. If "
1876 "the requested file is larger than this then you will get an error."
1880 #: ../src/guestfs.pod:898
1882 "In order to transfer large files into and out of the guest filesystem, you "
1883 "need to use particular calls that support this. The sections L</UPLOADING> "
1884 "and L</DOWNLOADING> document how to do this."
1888 #: ../src/guestfs.pod:902
1890 "You might also consider mounting the disk image using our FUSE filesystem "
1891 "support (L<guestmount(1)>)."
1895 #: ../src/guestfs.pod:905
1896 msgid "KEYS AND PASSPHRASES"
1900 #: ../src/guestfs.pod:907
1902 "Certain libguestfs calls take a parameter that contains sensitive key "
1903 "material, passed in as a C string."
1907 #: ../src/guestfs.pod:910
1909 "In the future we would hope to change the libguestfs implementation so that "
1910 "keys are L<mlock(2)>-ed into physical RAM, and thus can never end up in "
1911 "swap. However this is I<not> done at the moment, because of the complexity "
1912 "of such an implementation."
1916 #: ../src/guestfs.pod:915
1918 "Therefore you should be aware that any key parameter you pass to libguestfs "
1919 "might end up being written out to the swap partition. If this is a concern, "
1920 "scrub the swap partition or don't use libguestfs on encrypted devices."
1924 #: ../src/guestfs.pod:920
1925 msgid "MULTIPLE HANDLES AND MULTIPLE THREADS"
1929 #: ../src/guestfs.pod:922
1931 "All high-level libguestfs actions are synchronous. If you want to use "
1932 "libguestfs asynchronously then you must create a thread."
1936 #: ../src/guestfs.pod:925
1938 "Only use the handle from a single thread. Either use the handle exclusively "
1939 "from one thread, or provide your own mutex so that two threads cannot issue "
1940 "calls on the same handle at the same time."
1944 #: ../src/guestfs.pod:929
1946 "See the graphical program guestfs-browser for one possible architecture for "
1947 "multithreaded programs using libvirt and libguestfs."
1951 #: ../src/guestfs.pod:932
1956 #: ../src/guestfs.pod:934
1958 "Libguestfs needs a supermin appliance, which it finds by looking along an "
1963 #: ../src/guestfs.pod:937
1965 "By default it looks for these in the directory C<$libdir/guestfs> (eg. C</"
1966 "usr/local/lib/guestfs> or C</usr/lib64/guestfs>)."
1970 #: ../src/guestfs.pod:940
1972 "Use L</guestfs_set_path> or set the environment variable L</LIBGUESTFS_PATH> "
1973 "to change the directories that libguestfs will search in. The value is a "
1974 "colon-separated list of paths. The current directory is I<not> searched "
1975 "unless the path contains an empty element or C<.>. For example "
1976 "C<LIBGUESTFS_PATH=:/usr/lib/guestfs> would search the current directory and "
1977 "then C</usr/lib/guestfs>."
1981 #: ../src/guestfs.pod:947
1982 msgid "QEMU WRAPPERS"
1986 #: ../src/guestfs.pod:949
1988 "If you want to compile your own qemu, run qemu from a non-standard location, "
1989 "or pass extra arguments to qemu, then you can write a shell-script wrapper "
1994 #: ../src/guestfs.pod:953
1996 "There is one important rule to remember: you I<must C<exec qemu>> as the "
1997 "last command in the shell script (so that qemu replaces the shell and "
1998 "becomes the direct child of the libguestfs-using program). If you don't do "
1999 "this, then the qemu process won't be cleaned up correctly."
2003 #: ../src/guestfs.pod:958
2005 "Here is an example of a wrapper, where I have built my own copy of qemu from "
2010 #: ../src/guestfs.pod:961
2014 " qemudir=/home/rjones/d/qemu\n"
2015 " exec $qemudir/x86_64-softmmu/qemu-system-x86_64 -L $qemudir/pc-bios \"$@\"\n"
2020 #: ../src/guestfs.pod:965
2022 "Save this script as C</tmp/qemu.wrapper> (or wherever), C<chmod +x>, and "
2023 "then use it by setting the LIBGUESTFS_QEMU environment variable. For "
2028 #: ../src/guestfs.pod:969
2031 " LIBGUESTFS_QEMU=/tmp/qemu.wrapper guestfish\n"
2036 #: ../src/guestfs.pod:971
2038 "Note that libguestfs also calls qemu with the -help and -version options in "
2039 "order to determine features."
2043 #: ../src/guestfs.pod:974
2044 msgid "ATTACHING TO RUNNING DAEMONS"
2048 #: ../src/guestfs.pod:976
2050 "I<Note (1):> This is B<highly experimental> and has a tendency to eat "
2051 "babies. Use with caution."
2055 #: ../src/guestfs.pod:979
2057 "I<Note (2):> This section explains how to attach to a running daemon from a "
2058 "low level perspective. For most users, simply using virt tools such as "
2059 "L<guestfish(1)> with the I<--live> option will \"just work\"."
2063 #: ../src/guestfs.pod:983
2064 msgid "Using guestfs_set_attach_method"
2068 #: ../src/guestfs.pod:985
2070 "By calling L</guestfs_set_attach_method> you can change how the library "
2071 "connects to the C<guestfsd> daemon in L</guestfs_launch> (read L</"
2072 "ARCHITECTURE> for some background)."
2076 #: ../src/guestfs.pod:989
2078 "The normal attach method is C<appliance>, where a small appliance is created "
2079 "containing the daemon, and then the library connects to this."
2083 #: ../src/guestfs.pod:992
2085 "Setting attach method to C<unix:I<path>> (where I<path> is the path of a "
2086 "Unix domain socket) causes L</guestfs_launch> to connect to an existing "
2087 "daemon over the Unix domain socket."
2091 #: ../src/guestfs.pod:996
2093 "The normal use for this is to connect to a running virtual machine that "
2094 "contains a C<guestfsd> daemon, and send commands so you can read and write "
2095 "files inside the live virtual machine."
2099 #: ../src/guestfs.pod:1000
2100 msgid "Using guestfs_add_domain with live flag"
2104 #: ../src/guestfs.pod:1002
2106 "L</guestfs_add_domain> provides some help for getting the correct attach "
2107 "method. If you pass the C<live> option to this function, then (if the "
2108 "virtual machine is running) it will examine the libvirt XML looking for a "
2109 "virtio-serial channel to connect to:"
2113 #: ../src/guestfs.pod:1008
2120 " <channel type='unix'>\n"
2121 " <source mode='bind' path='/path/to/socket'/>\n"
2122 " <target type='virtio' name='org.libguestfs.channel.0'/>\n"
2131 #: ../src/guestfs.pod:1020
2133 "L</guestfs_add_domain> extracts C</path/to/socket> and sets the attach "
2134 "method to C<unix:/path/to/socket>."
2138 #: ../src/guestfs.pod:1023
2140 "Some of the libguestfs tools (including guestfish) support a I<--live> "
2141 "option which is passed through to L</guestfs_add_domain> thus allowing you "
2142 "to attach to and modify live virtual machines."
2146 #: ../src/guestfs.pod:1027
2148 "The virtual machine needs to have been set up beforehand so that it has the "
2149 "virtio-serial channel and so that guestfsd is running inside it."
2153 #: ../src/guestfs.pod:1031
2154 msgid "ABI GUARANTEE"
2158 #: ../src/guestfs.pod:1033
2160 "We guarantee the libguestfs ABI (binary interface), for public, high-level "
2161 "actions as outlined in this section. Although we will deprecate some "
2162 "actions, for example if they get replaced by newer calls, we will keep the "
2163 "old actions forever. This allows you the developer to program in confidence "
2164 "against the libguestfs API."
2168 #: ../src/guestfs.pod:1039
2169 msgid "BLOCK DEVICE NAMING"
2173 #: ../src/guestfs.pod:1041
2175 "In the kernel there is now quite a profusion of schemata for naming block "
2176 "devices (in this context, by I<block device> I mean a physical or virtual "
2177 "hard drive). The original Linux IDE driver used names starting with C</dev/"
2178 "hd*>. SCSI devices have historically used a different naming scheme, C</dev/"
2179 "sd*>. When the Linux kernel I<libata> driver became a popular replacement "
2180 "for the old IDE driver (particularly for SATA devices) those devices also "
2181 "used the C</dev/sd*> scheme. Additionally we now have virtual machines with "
2182 "paravirtualized drivers. This has created several different naming systems, "
2183 "such as C</dev/vd*> for virtio disks and C</dev/xvd*> for Xen PV disks."
2187 #: ../src/guestfs.pod:1053
2189 "As discussed above, libguestfs uses a qemu appliance running an embedded "
2190 "Linux kernel to access block devices. We can run a variety of appliances "
2191 "based on a variety of Linux kernels."
2195 #: ../src/guestfs.pod:1057
2197 "This causes a problem for libguestfs because many API calls use device or "
2198 "partition names. Working scripts and the recipe (example) scripts that we "
2199 "make available over the internet could fail if the naming scheme changes."
2203 #: ../src/guestfs.pod:1062
2205 "Therefore libguestfs defines C</dev/sd*> as the I<standard naming scheme>. "
2206 "Internally C</dev/sd*> names are translated, if necessary, to other names as "
2207 "required. For example, under RHEL 5 which uses the C</dev/hd*> scheme, any "
2208 "device parameter C</dev/sda2> is translated to C</dev/hda2> transparently."
2212 #: ../src/guestfs.pod:1068
2214 "Note that this I<only> applies to parameters. The L</guestfs_list_devices>, "
2215 "L</guestfs_list_partitions> and similar calls return the true names of the "
2216 "devices and partitions as known to the appliance."
2220 #: ../src/guestfs.pod:1073
2221 msgid "ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION"
2225 #: ../src/guestfs.pod:1075
2227 "Usually this translation is transparent. However in some (very rare) cases "
2228 "you may need to know the exact algorithm. Such cases include where you use "
2229 "L</guestfs_config> to add a mixture of virtio and IDE devices to the qemu-"
2230 "based appliance, so have a mixture of C</dev/sd*> and C</dev/vd*> devices."
2234 #: ../src/guestfs.pod:1081
2236 "The algorithm is applied only to I<parameters> which are known to be either "
2237 "device or partition names. Return values from functions such as L</"
2238 "guestfs_list_devices> are never changed."
2242 #: ../src/guestfs.pod:1089
2243 msgid "Is the string a parameter which is a device or partition name?"
2247 #: ../src/guestfs.pod:1093
2248 msgid "Does the string begin with C</dev/sd>?"
2252 #: ../src/guestfs.pod:1097
2254 "Does the named device exist? If so, we use that device. However if I<not> "
2255 "then we continue with this algorithm."
2259 #: ../src/guestfs.pod:1102
2260 msgid "Replace initial C</dev/sd> string with C</dev/hd>."
2264 #: ../src/guestfs.pod:1104
2265 msgid "For example, change C</dev/sda2> to C</dev/hda2>."
2269 #: ../src/guestfs.pod:1106
2270 msgid "If that named device exists, use it. If not, continue."
2274 #: ../src/guestfs.pod:1110
2275 msgid "Replace initial C</dev/sd> string with C</dev/vd>."
2279 #: ../src/guestfs.pod:1112
2280 msgid "If that named device exists, use it. If not, return an error."
2284 #: ../src/guestfs.pod:1116
2285 msgid "PORTABILITY CONCERNS WITH BLOCK DEVICE NAMING"
2289 #: ../src/guestfs.pod:1118
2291 "Although the standard naming scheme and automatic translation is useful for "
2292 "simple programs and guestfish scripts, for larger programs it is best not to "
2293 "rely on this mechanism."
2297 #: ../src/guestfs.pod:1122
2299 "Where possible for maximum future portability programs using libguestfs "
2300 "should use these future-proof techniques:"
2304 #: ../src/guestfs.pod:1129
2306 "Use L</guestfs_list_devices> or L</guestfs_list_partitions> to list actual "
2307 "device names, and then use those names directly."
2311 #: ../src/guestfs.pod:1132
2313 "Since those device names exist by definition, they will never be translated."
2317 #: ../src/guestfs.pod:1137
2319 "Use higher level ways to identify filesystems, such as LVM names, UUIDs and "
2320 "filesystem labels."
2324 #: ../src/guestfs.pod:1142
2329 #: ../src/guestfs.pod:1144
2331 "This section discusses security implications of using libguestfs, "
2332 "particularly with untrusted or malicious guests or disk images."
2336 #: ../src/guestfs.pod:1147
2337 msgid "GENERAL SECURITY CONSIDERATIONS"
2341 #: ../src/guestfs.pod:1149
2343 "Be careful with any files or data that you download from a guest (by "
2344 "\"download\" we mean not just the L</guestfs_download> command but any "
2345 "command that reads files, filenames, directories or anything else from a "
2346 "disk image). An attacker could manipulate the data to fool your program "
2347 "into doing the wrong thing. Consider cases such as:"
2351 #: ../src/guestfs.pod:1159
2352 msgid "the data (file etc) not being present"
2356 #: ../src/guestfs.pod:1163
2357 msgid "being present but empty"
2361 #: ../src/guestfs.pod:1167
2362 msgid "being much larger than normal"
2366 #: ../src/guestfs.pod:1171
2367 msgid "containing arbitrary 8 bit data"
2371 #: ../src/guestfs.pod:1175
2372 msgid "being in an unexpected character encoding"
2376 #: ../src/guestfs.pod:1179
2377 msgid "containing homoglyphs."
2381 #: ../src/guestfs.pod:1183
2382 msgid "SECURITY OF MOUNTING FILESYSTEMS"
2386 #: ../src/guestfs.pod:1185
2388 "When you mount a filesystem under Linux, mistakes in the kernel filesystem "
2389 "(VFS) module can sometimes be escalated into exploits by deliberately "
2390 "creating a malicious, malformed filesystem. These exploits are very severe "
2391 "for two reasons. Firstly there are very many filesystem drivers in the "
2392 "kernel, and many of them are infrequently used and not much developer "
2393 "attention has been paid to the code. Linux userspace helps potential "
2394 "crackers by detecting the filesystem type and automatically choosing the "
2395 "right VFS driver, even if that filesystem type is obscure or unexpected for "
2396 "the administrator. Secondly, a kernel-level exploit is like a local root "
2397 "exploit (worse in some ways), giving immediate and total access to the "
2398 "system right down to the hardware level."
2402 #: ../src/guestfs.pod:1198
2404 "That explains why you should never mount a filesystem from an untrusted "
2405 "guest on your host kernel. How about libguestfs? We run a Linux kernel "
2406 "inside a qemu virtual machine, usually running as a non-root user. The "
2407 "attacker would need to write a filesystem which first exploited the kernel, "
2408 "and then exploited either qemu virtualization (eg. a faulty qemu driver) or "
2409 "the libguestfs protocol, and finally to be as serious as the host kernel "
2410 "exploit it would need to escalate its privileges to root. This multi-step "
2411 "escalation, performed by a static piece of data, is thought to be extremely "
2412 "hard to do, although we never say 'never' about security issues."
2416 #: ../src/guestfs.pod:1209
2418 "In any case callers can reduce the attack surface by forcing the filesystem "
2419 "type when mounting (use L</guestfs_mount_vfs>)."
2423 #: ../src/guestfs.pod:1212
2424 msgid "PROTOCOL SECURITY"
2428 #: ../src/guestfs.pod:1214
2430 "The protocol is designed to be secure, being based on RFC 4506 (XDR) with a "
2431 "defined upper message size. However a program that uses libguestfs must "
2432 "also take care - for example you can write a program that downloads a binary "
2433 "from a disk image and executes it locally, and no amount of protocol "
2434 "security will save you from the consequences."
2438 #: ../src/guestfs.pod:1220
2439 msgid "INSPECTION SECURITY"
2443 #: ../src/guestfs.pod:1222
2445 "Parts of the inspection API (see L</INSPECTION>) return untrusted strings "
2446 "directly from the guest, and these could contain any 8 bit data. Callers "
2447 "should be careful to escape these before printing them to a structured file "
2448 "(for example, use HTML escaping if creating a web page)."
2452 #: ../src/guestfs.pod:1228
2454 "Guest configuration may be altered in unusual ways by the administrator of "
2455 "the virtual machine, and may not reflect reality (particularly for untrusted "
2456 "or actively malicious guests). For example we parse the hostname from "
2457 "configuration files like C</etc/sysconfig/network> that we find in the "
2458 "guest, but the guest administrator can easily manipulate these files to "
2459 "provide the wrong hostname."
2463 #: ../src/guestfs.pod:1236
2465 "The inspection API parses guest configuration using two external libraries: "
2466 "Augeas (Linux configuration) and hivex (Windows Registry). Both are "
2467 "designed to be robust in the face of malicious data, although denial of "
2468 "service attacks are still possible, for example with oversized configuration "
2473 #: ../src/guestfs.pod:1242
2474 msgid "RUNNING UNTRUSTED GUEST COMMANDS"
2478 #: ../src/guestfs.pod:1244
2480 "Be very cautious about running commands from the guest. By running a "
2481 "command in the guest, you are giving CPU time to a binary that you do not "
2482 "control, under the same user account as the library, albeit wrapped in qemu "
2483 "virtualization. More information and alternatives can be found in the "
2484 "section L</RUNNING COMMANDS>."
2488 #: ../src/guestfs.pod:1250
2489 msgid "CVE-2010-3851"
2490 msgstr "CVE-2010-3851"
2493 #: ../src/guestfs.pod:1252
2494 msgid "https://bugzilla.redhat.com/642934"
2495 msgstr "https://bugzilla.redhat.com/642934"
2498 #: ../src/guestfs.pod:1254
2500 "This security bug concerns the automatic disk format detection that qemu "
2501 "does on disk images."
2505 #: ../src/guestfs.pod:1257
2507 "A raw disk image is just the raw bytes, there is no header. Other disk "
2508 "images like qcow2 contain a special header. Qemu deals with this by looking "
2509 "for one of the known headers, and if none is found then assuming the disk "
2510 "image must be raw."
2514 #: ../src/guestfs.pod:1262
2516 "This allows a guest which has been given a raw disk image to write some "
2517 "other header. At next boot (or when the disk image is accessed by "
2518 "libguestfs) qemu would do autodetection and think the disk image format was, "
2519 "say, qcow2 based on the header written by the guest."
2523 #: ../src/guestfs.pod:1267
2525 "This in itself would not be a problem, but qcow2 offers many features, one "
2526 "of which is to allow a disk image to refer to another image (called the "
2527 "\"backing disk\"). It does this by placing the path to the backing disk "
2528 "into the qcow2 header. This path is not validated and could point to any "
2529 "host file (eg. \"/etc/passwd\"). The backing disk is then exposed through "
2530 "\"holes\" in the qcow2 disk image, which of course is completely under the "
2531 "control of the attacker."
2535 #: ../src/guestfs.pod:1275
2537 "In libguestfs this is rather hard to exploit except under two circumstances:"
2541 #: ../src/guestfs.pod:1282
2542 msgid "You have enabled the network or have opened the disk in write mode."
2546 #: ../src/guestfs.pod:1286
2548 "You are also running untrusted code from the guest (see L</RUNNING "
2553 #: ../src/guestfs.pod:1291
2555 "The way to avoid this is to specify the expected disk format when adding "
2556 "disks (the optional C<format> option to L</guestfs_add_drive_opts>). You "
2557 "should always do this if the disk is raw format, and it's a good idea for "
2562 #: ../src/guestfs.pod:1296
2564 "For disks added from libvirt using calls like L</guestfs_add_domain>, the "
2565 "format is fetched from libvirt and passed through."
2569 #: ../src/guestfs.pod:1299
2571 "For libguestfs tools, use the I<--format> command line parameter as "
2576 #: ../src/guestfs.pod:1302
2577 msgid "CONNECTION MANAGEMENT"
2581 #: ../src/guestfs.pod:1304
2586 #: ../src/guestfs.pod:1306
2588 "C<guestfs_h> is the opaque type representing a connection handle. Create a "
2589 "handle by calling L</guestfs_create>. Call L</guestfs_close> to free the "
2590 "handle and release all resources used."
2594 #: ../src/guestfs.pod:1310
2596 "For information on using multiple handles and threads, see the section L</"
2597 "MULTIPLE HANDLES AND MULTIPLE THREADS> below."
2601 #: ../src/guestfs.pod:1313
2602 msgid "guestfs_create"
2606 #: ../src/guestfs.pod:1315
2609 " guestfs_h *guestfs_create (void);\n"
2614 #: ../src/guestfs.pod:1317
2615 msgid "Create a connection handle."
2619 #: ../src/guestfs.pod:1319
2621 "You have to call L</guestfs_add_drive_opts> (or one of the equivalent calls) "
2622 "on the handle at least once."
2626 #: ../src/guestfs.pod:1322
2628 "This function returns a non-NULL pointer to a handle on success or NULL on "
2633 #: ../src/guestfs.pod:1325
2634 msgid "After configuring the handle, you have to call L</guestfs_launch>."
2638 #: ../src/guestfs.pod:1327
2640 "You may also want to configure error handling for the handle. See L</ERROR "
2641 "HANDLING> section below."
2645 #: ../src/guestfs.pod:1330
2646 msgid "guestfs_close"
2650 #: ../src/guestfs.pod:1332
2653 " void guestfs_close (guestfs_h *g);\n"
2658 #: ../src/guestfs.pod:1334
2659 msgid "This closes the connection handle and frees up all resources used."
2663 #: ../src/guestfs.pod:1336
2664 msgid "ERROR HANDLING"
2665 msgstr "ОБРОБКА ПОМИЛОК"
2668 #: ../src/guestfs.pod:1338
2670 "API functions can return errors. For example, almost all functions that "
2671 "return C<int> will return C<-1> to indicate an error."
2675 #: ../src/guestfs.pod:1341
2677 "Additional information is available for errors: an error message string and "
2678 "optionally an error number (errno) if the thing that failed was a system "
2683 #: ../src/guestfs.pod:1345
2685 "You can get at the additional information about the last error on the handle "
2686 "by calling L</guestfs_last_error>, L</guestfs_last_errno>, and/or by setting "
2687 "up an error handler with L</guestfs_set_error_handler>."
2691 #: ../src/guestfs.pod:1350
2693 "When the handle is created, a default error handler is installed which "
2694 "prints the error message string to C<stderr>. For small short-running "
2695 "command line programs it is sufficient to do:"
2699 #: ../src/guestfs.pod:1354
2702 " if (guestfs_launch (g) == -1)\n"
2703 " exit (EXIT_FAILURE);\n"
2708 #: ../src/guestfs.pod:1357
2710 "since the default error handler will ensure that an error message has been "
2711 "printed to C<stderr> before the program exits."
2715 #: ../src/guestfs.pod:1360
2717 "For other programs the caller will almost certainly want to install an "
2718 "alternate error handler or do error handling in-line like this:"
2722 #: ../src/guestfs.pod:1363
2725 " g = guestfs_create ();\n"
2730 #: ../src/guestfs.pod:1365
2733 " /* This disables the default behaviour of printing errors\n"
2735 " guestfs_set_error_handler (g, NULL, NULL);\n"
2740 #: ../src/guestfs.pod:1369
2743 " if (guestfs_launch (g) == -1) {\n"
2744 " /* Examine the error message and print it etc. */\n"
2745 " char *msg = guestfs_last_error (g);\n"
2746 " int errnum = guestfs_last_errno (g);\n"
2747 " fprintf (stderr, \"%s\\n\", msg);\n"
2754 #: ../src/guestfs.pod:1377
2756 "Out of memory errors are handled differently. The default action is to call "
2757 "L<abort(3)>. If this is undesirable, then you can set a handler using L</"
2758 "guestfs_set_out_of_memory_handler>."
2762 #: ../src/guestfs.pod:1381
2764 "L</guestfs_create> returns C<NULL> if the handle cannot be created, and "
2765 "because there is no handle if this happens there is no way to get additional "
2766 "error information. However L</guestfs_create> is supposed to be a "
2767 "lightweight operation which can only fail because of insufficient memory (it "
2768 "returns NULL in this case)."
2772 #: ../src/guestfs.pod:1387
2773 msgid "guestfs_last_error"
2777 #: ../src/guestfs.pod:1389
2780 " const char *guestfs_last_error (guestfs_h *g);\n"
2785 #: ../src/guestfs.pod:1391
2787 "This returns the last error message that happened on C<g>. If there has not "
2788 "been an error since the handle was created, then this returns C<NULL>."
2792 #: ../src/guestfs.pod:1395
2794 "The lifetime of the returned string is until the next error occurs, or L</"
2795 "guestfs_close> is called."
2799 #: ../src/guestfs.pod:1398
2800 msgid "guestfs_last_errno"
2804 #: ../src/guestfs.pod:1400
2807 " int guestfs_last_errno (guestfs_h *g);\n"
2812 #: ../src/guestfs.pod:1402
2813 msgid "This returns the last error number (errno) that happened on C<g>."
2817 #: ../src/guestfs.pod:1404
2818 msgid "If successful, an errno integer not equal to zero is returned."
2822 #: ../src/guestfs.pod:1406
2824 "If no error, this returns 0. This call can return 0 in three situations:"
2828 #: ../src/guestfs.pod:1413
2829 msgid "There has not been any error on the handle."
2833 #: ../src/guestfs.pod:1417
2835 "There has been an error but the errno was meaningless. This corresponds to "
2836 "the case where the error did not come from a failed system call, but for "
2837 "some other reason."
2841 #: ../src/guestfs.pod:1423
2843 "There was an error from a failed system call, but for some reason the errno "
2844 "was not captured and returned. This usually indicates a bug in libguestfs."
2848 #: ../src/guestfs.pod:1429
2850 "Libguestfs tries to convert the errno from inside the applicance into a "
2851 "corresponding errno for the caller (not entirely trivial: the appliance "
2852 "might be running a completely different operating system from the library "
2853 "and error numbers are not standardized across Un*xen). If this could not be "
2854 "done, then the error is translated to C<EINVAL>. In practice this should "
2855 "only happen in very rare circumstances."
2859 #: ../src/guestfs.pod:1437
2860 msgid "guestfs_set_error_handler"
2864 #: ../src/guestfs.pod:1439
2867 " typedef void (*guestfs_error_handler_cb) (guestfs_h *g,\n"
2869 " const char *msg);\n"
2870 " void guestfs_set_error_handler (guestfs_h *g,\n"
2871 " guestfs_error_handler_cb cb,\n"
2877 #: ../src/guestfs.pod:1446
2879 "The callback C<cb> will be called if there is an error. The parameters "
2880 "passed to the callback are an opaque data pointer and the error message "
2885 #: ../src/guestfs.pod:1450
2887 "C<errno> is not passed to the callback. To get that the callback must call "
2888 "L</guestfs_last_errno>."
2892 #: ../src/guestfs.pod:1453
2894 "Note that the message string C<msg> is freed as soon as the callback "
2895 "function returns, so if you want to stash it somewhere you must make your "
2900 #: ../src/guestfs.pod:1457
2901 msgid "The default handler prints messages on C<stderr>."
2905 #: ../src/guestfs.pod:1459
2906 msgid "If you set C<cb> to C<NULL> then I<no> handler is called."
2910 #: ../src/guestfs.pod:1461
2911 msgid "guestfs_get_error_handler"
2915 #: ../src/guestfs.pod:1463
2918 " guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g,\n"
2919 " void **opaque_rtn);\n"
2924 #: ../src/guestfs.pod:1466
2925 msgid "Returns the current error handler callback."
2929 #: ../src/guestfs.pod:1468
2930 msgid "guestfs_set_out_of_memory_handler"
2934 #: ../src/guestfs.pod:1470
2937 " typedef void (*guestfs_abort_cb) (void);\n"
2938 " int guestfs_set_out_of_memory_handler (guestfs_h *g,\n"
2939 " guestfs_abort_cb);\n"
2944 #: ../src/guestfs.pod:1474
2946 "The callback C<cb> will be called if there is an out of memory situation. "
2947 "I<Note this callback must not return>."
2951 #: ../src/guestfs.pod:1477
2952 msgid "The default is to call L<abort(3)>."
2956 #: ../src/guestfs.pod:1479
2958 "You cannot set C<cb> to C<NULL>. You can't ignore out of memory situations."
2962 #: ../src/guestfs.pod:1482
2963 msgid "guestfs_get_out_of_memory_handler"
2967 #: ../src/guestfs.pod:1484
2970 " guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n"
2975 #: ../src/guestfs.pod:1486
2976 msgid "This returns the current out of memory handler."
2980 #: ../src/guestfs.pod:1488
2985 #: ../src/guestfs.pod:1490 ../fish/guestfish.pod:1008
2990 #: ../src/guestfs.pod:1492
2995 #: ../src/guestfs.pod:1494
3000 #: ../src/guestfs.pod:1496
3001 msgid "AVAILABILITY"
3005 #: ../src/guestfs.pod:1498
3006 msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE"
3010 #: ../src/guestfs.pod:1500
3012 "Using L</guestfs_available> you can test availability of the following "
3013 "groups of functions. This test queries the appliance to see if the "
3014 "appliance you are currently using supports the functionality."
3018 #: ../src/guestfs.pod:1505
3019 msgid "@AVAILABILITY@"
3023 #: ../src/guestfs.pod:1507
3024 msgid "GUESTFISH supported COMMAND"
3028 #: ../src/guestfs.pod:1509
3030 "In L<guestfish(3)> there is a handy interactive command C<supported> which "
3031 "prints out the available groups and whether they are supported by this build "
3032 "of libguestfs. Note however that you have to do C<run> first."
3036 #: ../src/guestfs.pod:1514
3037 msgid "SINGLE CALLS AT COMPILE TIME"
3041 #: ../src/guestfs.pod:1516
3043 "Since version 1.5.8, C<E<lt>guestfs.hE<gt>> defines symbols for each C API "
3044 "function, such as:"
3048 #: ../src/guestfs.pod:1519
3051 " #define LIBGUESTFS_HAVE_DD 1\n"
3056 #: ../src/guestfs.pod:1521
3057 msgid "if L</guestfs_dd> is available."
3061 #: ../src/guestfs.pod:1523
3063 "Before version 1.5.8, if you needed to test whether a single libguestfs "
3064 "function is available at compile time, we recommended using build tools such "
3065 "as autoconf or cmake. For example in autotools you could use:"
3069 #: ../src/guestfs.pod:1528
3072 " AC_CHECK_LIB([guestfs],[guestfs_create])\n"
3073 " AC_CHECK_FUNCS([guestfs_dd])\n"
3078 #: ../src/guestfs.pod:1531
3080 "which would result in C<HAVE_GUESTFS_DD> being either defined or not defined "
3085 #: ../src/guestfs.pod:1534
3086 msgid "SINGLE CALLS AT RUN TIME"
3090 #: ../src/guestfs.pod:1536
3092 "Testing at compile time doesn't guarantee that a function really exists in "
3093 "the library. The reason is that you might be dynamically linked against a "
3094 "previous I<libguestfs.so> (dynamic library) which doesn't have the call. "
3095 "This situation unfortunately results in a segmentation fault, which is a "
3096 "shortcoming of the C dynamic linking system itself."
3100 #: ../src/guestfs.pod:1543
3102 "You can use L<dlopen(3)> to test if a function is available at run time, as "
3103 "in this example program (note that you still need the compile time check as "
3108 #: ../src/guestfs.pod:1547
3111 " #include <stdio.h>\n"
3112 " #include <stdlib.h>\n"
3113 " #include <unistd.h>\n"
3114 " #include <dlfcn.h>\n"
3115 " #include <guestfs.h>\n"
3120 #: ../src/guestfs.pod:1553
3125 " #ifdef LIBGUESTFS_HAVE_DD\n"
3127 " int has_function;\n"
3132 #: ../src/guestfs.pod:1559
3135 " /* Test if the function guestfs_dd is really available. */\n"
3136 " dl = dlopen (NULL, RTLD_LAZY);\n"
3138 " fprintf (stderr, \"dlopen: %s\\n\", dlerror ());\n"
3139 " exit (EXIT_FAILURE);\n"
3141 " has_function = dlsym (dl, \"guestfs_dd\") != NULL;\n"
3147 #: ../src/guestfs.pod:1568
3150 " if (!has_function)\n"
3151 " printf (\"this libguestfs.so does NOT have guestfs_dd function\\n\");\n"
3153 " printf (\"this libguestfs.so has guestfs_dd function\\n\");\n"
3154 " /* Now it's safe to call\n"
3155 " guestfs_dd (g, \"foo\", \"bar\");\n"
3159 " printf (\"guestfs_dd function was not found at compile time\\n\");\n"
3166 #: ../src/guestfs.pod:1581
3168 "You may think the above is an awful lot of hassle, and it is. There are "
3169 "other ways outside of the C linking system to ensure that this kind of "
3170 "incompatibility never arises, such as using package versioning:"
3174 #: ../src/guestfs.pod:1586
3177 " Requires: libguestfs >= 1.0.80\n"
3182 #: ../src/guestfs.pod:1588
3183 msgid "CALLS WITH OPTIONAL ARGUMENTS"
3187 #: ../src/guestfs.pod:1590
3189 "A recent feature of the API is the introduction of calls which take optional "
3190 "arguments. In C these are declared 3 ways. The main way is as a call which "
3191 "takes variable arguments (ie. C<...>), as in this example:"
3195 #: ../src/guestfs.pod:1595
3198 " int guestfs_add_drive_opts (guestfs_h *g, const char *filename, ...);\n"
3203 #: ../src/guestfs.pod:1597
3205 "Call this with a list of optional arguments, terminated by C<-1>. So to "
3206 "call with no optional arguments specified:"
3210 #: ../src/guestfs.pod:1600
3213 " guestfs_add_drive_opts (g, filename, -1);\n"
3218 #: ../src/guestfs.pod:1602
3219 msgid "With a single optional argument:"
3223 #: ../src/guestfs.pod:1604
3226 " guestfs_add_drive_opts (g, filename,\n"
3227 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
3233 #: ../src/guestfs.pod:1608
3238 #: ../src/guestfs.pod:1610
3241 " guestfs_add_drive_opts (g, filename,\n"
3242 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
3243 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
3249 #: ../src/guestfs.pod:1615
3251 "and so forth. Don't forget the terminating C<-1> otherwise Bad Things will "
3256 #: ../src/guestfs.pod:1618
3257 msgid "USING va_list FOR OPTIONAL ARGUMENTS"
3261 #: ../src/guestfs.pod:1620
3263 "The second variant has the same name with the suffix C<_va>, which works the "
3264 "same way but takes a C<va_list>. See the C manual for details. For the "
3265 "example function, this is declared:"
3269 #: ../src/guestfs.pod:1624
3272 " int guestfs_add_drive_opts_va (guestfs_h *g, const char *filename,\n"
3278 #: ../src/guestfs.pod:1627
3279 msgid "CONSTRUCTING OPTIONAL ARGUMENTS"
3283 #: ../src/guestfs.pod:1629
3285 "The third variant is useful where you need to construct these calls. You "
3286 "pass in a structure where you fill in the optional fields. The structure "
3287 "has a bitmask as the first element which you must set to indicate which "
3288 "fields you have filled in. For our example function the structure and call "
3293 #: ../src/guestfs.pod:1635
3296 " struct guestfs_add_drive_opts_argv {\n"
3297 " uint64_t bitmask;\n"
3299 " const char *format;\n"
3302 " int guestfs_add_drive_opts_argv (guestfs_h *g, const char *filename,\n"
3303 " const struct guestfs_add_drive_opts_argv *optargs);\n"
3308 #: ../src/guestfs.pod:1644
3309 msgid "You could call it like this:"
3313 #: ../src/guestfs.pod:1646
3316 " struct guestfs_add_drive_opts_argv optargs = {\n"
3317 " .bitmask = GUESTFS_ADD_DRIVE_OPTS_READONLY_BITMASK |\n"
3318 " GUESTFS_ADD_DRIVE_OPTS_FORMAT_BITMASK,\n"
3320 " .format = \"qcow2\"\n"
3326 #: ../src/guestfs.pod:1653
3329 " guestfs_add_drive_opts_argv (g, filename, &optargs);\n"
3334 #: ../src/guestfs.pod:1655 ../src/guestfs-actions.pod:11
3335 #: ../src/guestfs-actions.pod:1855 ../fish/guestfish-actions.pod:9
3336 #: ../fish/guestfish-actions.pod:1260 ../tools/virt-win-reg.pl:532
3341 #: ../src/guestfs.pod:1661
3342 msgid "The C<_BITMASK> suffix on each option name when specifying the bitmask."
3346 #: ../src/guestfs.pod:1666
3347 msgid "You do not need to fill in all fields of the structure."
3351 #: ../src/guestfs.pod:1670
3353 "There must be a one-to-one correspondence between fields of the structure "
3354 "that are filled in, and bits set in the bitmask."
3358 #: ../src/guestfs.pod:1675
3359 msgid "OPTIONAL ARGUMENTS IN OTHER LANGUAGES"
3363 #: ../src/guestfs.pod:1677
3365 "In other languages, optional arguments are expressed in the way that is "
3366 "natural for that language. We refer you to the language-specific "
3367 "documentation for more details on that."
3371 #: ../src/guestfs.pod:1681
3372 msgid "For guestfish, see L<guestfish(1)/OPTIONAL ARGUMENTS>."
3376 #: ../src/guestfs.pod:1683
3377 msgid "SETTING CALLBACKS TO HANDLE EVENTS"
3381 #: ../src/guestfs.pod:1685
3383 "B<Note:> This section documents the generic event mechanism introduced in "
3384 "libguestfs 1.10, which you should use in new code if possible. The old "
3385 "functions C<guestfs_set_log_message_callback>, "
3386 "C<guestfs_set_subprocess_quit_callback>, "
3387 "C<guestfs_set_launch_done_callback>, C<guestfs_set_close_callback> and "
3388 "C<guestfs_set_progress_callback> are no longer documented in this manual "
3393 #: ../src/guestfs.pod:1693
3395 "Handles generate events when certain things happen, such as log messages "
3396 "being generated, progress messages during long-running operations, or the "
3397 "handle being closed. The API calls described below let you register a "
3398 "callback to be called when events happen. You can register multiple "
3399 "callbacks (for the same, different or overlapping sets of events), and "
3400 "individually remove callbacks. If callbacks are not removed, then they "
3401 "remain in force until the handle is closed."
3405 #: ../src/guestfs.pod:1701
3407 "In the current implementation, events are only generated synchronously: that "
3408 "means that events (and hence callbacks) can only happen while you are in the "
3409 "middle of making another libguestfs call. The callback is called in the "
3414 #: ../src/guestfs.pod:1706
3416 "Events may contain a payload, usually nothing (void), an array of 64 bit "
3417 "unsigned integers, or a message buffer. Payloads are discussed later on."
3421 #: ../src/guestfs.pod:1710
3422 msgid "CLASSES OF EVENTS"
3426 #: ../src/guestfs.pod:1714
3427 msgid "GUESTFS_EVENT_CLOSE (payload type: void)"
3431 #: ../src/guestfs.pod:1717
3433 "The callback function will be called while the handle is being closed "
3434 "(synchronously from L</guestfs_close>)."
3438 #: ../src/guestfs.pod:1720
3440 "Note that libguestfs installs an L<atexit(3)> handler to try to clean up "
3441 "handles that are open when the program exits. This means that this callback "
3442 "might be called indirectly from L<exit(3)>, which can cause unexpected "
3443 "problems in higher-level languages (eg. if your HLL interpreter has already "
3444 "been cleaned up by the time this is called, and if your callback then jumps "
3445 "into some HLL function)."
3449 #: ../src/guestfs.pod:1727
3451 "If no callback is registered: the handle is closed without any callback "
3456 #: ../src/guestfs.pod:1730
3457 msgid "GUESTFS_EVENT_SUBPROCESS_QUIT (payload type: void)"
3461 #: ../src/guestfs.pod:1733
3463 "The callback function will be called when the child process quits, either "
3464 "asynchronously or if killed by L</guestfs_kill_subprocess>. (This "
3465 "corresponds to a transition from any state to the CONFIG state)."
3469 #: ../src/guestfs.pod:1737 ../src/guestfs.pod:1746
3470 msgid "If no callback is registered: the event is ignored."
3474 #: ../src/guestfs.pod:1739
3475 msgid "GUESTFS_EVENT_LAUNCH_DONE (payload type: void)"
3479 #: ../src/guestfs.pod:1742
3481 "The callback function will be called when the child process becomes ready "
3482 "first time after it has been launched. (This corresponds to a transition "
3483 "from LAUNCHING to the READY state)."
3487 #: ../src/guestfs.pod:1748
3488 msgid "GUESTFS_EVENT_PROGRESS (payload type: array of 4 x uint64_t)"
3492 #: ../src/guestfs.pod:1751
3494 "Some long-running operations can generate progress messages. If this "
3495 "callback is registered, then it will be called each time a progress message "
3496 "is generated (usually two seconds after the operation started, and three "
3497 "times per second thereafter until it completes, although the frequency may "
3498 "change in future versions)."
3502 #: ../src/guestfs.pod:1757
3504 "The callback receives in the payload four unsigned 64 bit numbers which are "
3505 "(in order): C<proc_nr>, C<serial>, C<position>, C<total>."
3509 #: ../src/guestfs.pod:1760
3511 "The units of C<total> are not defined, although for some operations C<total> "
3512 "may relate in some way to the amount of data to be transferred (eg. in bytes "
3513 "or megabytes), and C<position> may be the portion which has been transferred."
3517 #: ../src/guestfs.pod:1765
3518 msgid "The only defined and stable parts of the API are:"
3522 #: ../src/guestfs.pod:1771
3524 "The callback can display to the user some type of progress bar or indicator "
3525 "which shows the ratio of C<position>:C<total>."
3529 #: ../src/guestfs.pod:1776
3530 msgid "0 E<lt>= C<position> E<lt>= C<total>"
3534 #: ../src/guestfs.pod:1780
3536 "If any progress notification is sent during a call, then a final progress "
3537 "notification is always sent when C<position> = C<total> (I<unless> the call "
3538 "fails with an error)."
3542 #: ../src/guestfs.pod:1784
3544 "This is to simplify caller code, so callers can easily set the progress "
3545 "indicator to \"100%\" at the end of the operation, without requiring special "
3546 "code to detect this case."
3550 #: ../src/guestfs.pod:1790
3552 "For some calls we are unable to estimate the progress of the call, but we "
3553 "can still generate progress messages to indicate activity. This is known as "
3554 "\"pulse mode\", and is directly supported by certain progress bar "
3555 "implementations (eg. GtkProgressBar)."
3559 #: ../src/guestfs.pod:1795
3561 "For these calls, zero or more progress messages are generated with "
3562 "C<position = 0> and C<total = 1>, followed by a final message with "
3563 "C<position = total = 1>."
3567 #: ../src/guestfs.pod:1799
3569 "As noted above, if the call fails with an error then the final message may "
3574 #: ../src/guestfs.pod:1804
3576 "The callback also receives the procedure number (C<proc_nr>) and serial "
3577 "number (C<serial>) of the call. These are only useful for debugging "
3578 "protocol issues, and the callback can normally ignore them. The callback "
3579 "may want to print these numbers in error messages or debugging messages."
3583 #: ../src/guestfs.pod:1810
3584 msgid "If no callback is registered: progress messages are discarded."
3588 #: ../src/guestfs.pod:1812
3589 msgid "GUESTFS_EVENT_APPLIANCE (payload type: message buffer)"
3593 #: ../src/guestfs.pod:1815
3595 "The callback function is called whenever a log message is generated by qemu, "
3596 "the appliance kernel, guestfsd (daemon), or utility programs."
3600 #: ../src/guestfs.pod:1818
3602 "If the verbose flag (L</guestfs_set_verbose>) is set before launch (L</"
3603 "guestfs_launch>) then additional debug messages are generated."
3607 #: ../src/guestfs.pod:1821 ../src/guestfs.pod:1835
3609 "If no callback is registered: the messages are discarded unless the verbose "
3610 "flag is set in which case they are sent to stderr. You can override the "
3611 "printing of verbose messages to stderr by setting up a callback."
3615 #: ../src/guestfs.pod:1826
3616 msgid "GUESTFS_EVENT_LIBRARY (payload type: message buffer)"
3620 #: ../src/guestfs.pod:1829
3622 "The callback function is called whenever a log message is generated by the "
3623 "library part of libguestfs."
3627 #: ../src/guestfs.pod:1832
3629 "If the verbose flag (L</guestfs_set_verbose>) is set then additional debug "
3630 "messages are generated."
3634 #: ../src/guestfs.pod:1840
3635 msgid "GUESTFS_EVENT_TRACE (payload type: message buffer)"
3639 #: ../src/guestfs.pod:1843
3641 "The callback function is called whenever a trace message is generated. This "
3642 "only applies if the trace flag (L</guestfs_set_trace>) is set."
3646 #: ../src/guestfs.pod:1846
3648 "If no callback is registered: the messages are sent to stderr. You can "
3649 "override the printing of trace messages to stderr by setting up a callback."
3653 #: ../src/guestfs.pod:1852
3654 msgid "guestfs_set_event_callback"
3658 #: ../src/guestfs.pod:1854
3661 " int guestfs_set_event_callback (guestfs_h *g,\n"
3662 " guestfs_event_callback cb,\n"
3663 " uint64_t event_bitmask,\n"
3670 #: ../src/guestfs.pod:1860
3672 "This function registers a callback (C<cb>) for all event classes in the "
3677 #: ../src/guestfs.pod:1863
3679 "For example, to register for all log message events, you could call this "
3680 "function with the bitmask C<GUESTFS_EVENT_APPLIANCE|GUESTFS_EVENT_LIBRARY>. "
3681 "To register a single callback for all possible classes of events, use "
3682 "C<GUESTFS_EVENT_ALL>."
3686 #: ../src/guestfs.pod:1869
3687 msgid "C<flags> should always be passed as 0."
3691 #: ../src/guestfs.pod:1871
3693 "C<opaque> is an opaque pointer which is passed to the callback. You can use "
3694 "it for any purpose."
3698 #: ../src/guestfs.pod:1874
3700 "The return value is the event handle (an integer) which you can use to "
3701 "delete the callback (see below)."
3705 #: ../src/guestfs.pod:1877
3707 "If there is an error, this function returns C<-1>, and sets the error in the "
3708 "handle in the usual way (see L</guestfs_last_error> etc.)"
3712 #: ../src/guestfs.pod:1880
3714 "Callbacks remain in effect until they are deleted, or until the handle is "
3719 #: ../src/guestfs.pod:1883
3721 "In the case where multiple callbacks are registered for a particular event "
3722 "class, all of the callbacks are called. The order in which multiple "
3723 "callbacks are called is not defined."
3727 #: ../src/guestfs.pod:1887
3728 msgid "guestfs_delete_event_callback"
3732 #: ../src/guestfs.pod:1889
3735 " void guestfs_delete_event_callback (guestfs_h *g, int event_handle);\n"
3740 #: ../src/guestfs.pod:1891
3742 "Delete a callback that was previously registered. C<event_handle> should be "
3743 "the integer that was returned by a previous call to "
3744 "C<guestfs_set_event_callback> on the same handle."
3748 #: ../src/guestfs.pod:1895
3749 msgid "guestfs_event_callback"
3753 #: ../src/guestfs.pod:1897
3756 " typedef void (*guestfs_event_callback) (\n"
3759 " uint64_t event,\n"
3760 " int event_handle,\n"
3762 " const char *buf, size_t buf_len,\n"
3763 " const uint64_t *array, size_t array_len);\n"
3768 #: ../src/guestfs.pod:1906
3770 "This is the type of the event callback function that you have to provide."
3774 #: ../src/guestfs.pod:1909
3776 "The basic parameters are: the handle (C<g>), the opaque user pointer "
3777 "(C<opaque>), the event class (eg. C<GUESTFS_EVENT_PROGRESS>), the event "
3778 "handle, and C<flags> which in the current API you should ignore."
3782 #: ../src/guestfs.pod:1913
3784 "The remaining parameters contain the event payload (if any). Each event may "
3785 "contain a payload, which usually relates to the event class, but for future "
3786 "proofing your code should be written to handle any payload for any event "
3791 #: ../src/guestfs.pod:1918
3793 "C<buf> and C<buf_len> contain a message buffer (if C<buf_len == 0>, then "
3794 "there is no message buffer). Note that this message buffer can contain "
3795 "arbitrary 8 bit data, including NUL bytes."
3799 #: ../src/guestfs.pod:1922
3801 "C<array> and C<array_len> is an array of 64 bit unsigned integers. At the "
3802 "moment this is only used for progress messages."
3806 #: ../src/guestfs.pod:1925
3807 msgid "EXAMPLE: CAPTURING LOG MESSAGES"
3811 #: ../src/guestfs.pod:1927
3813 "One motivation for the generic event API was to allow GUI programs to "
3814 "capture debug and other messages. In libguestfs E<le> 1.8 these were sent "
3815 "unconditionally to C<stderr>."
3819 #: ../src/guestfs.pod:1931
3821 "Events associated with log messages are: C<GUESTFS_EVENT_LIBRARY>, "
3822 "C<GUESTFS_EVENT_APPLIANCE> and C<GUESTFS_EVENT_TRACE>. (Note that error "
3823 "messages are not events; you must capture error messages separately)."
3827 #: ../src/guestfs.pod:1936
3829 "Programs have to set up a callback to capture the classes of events of "
3834 #: ../src/guestfs.pod:1939
3838 " guestfs_set_event_callback\n"
3839 " (g, message_callback,\n"
3840 " GUESTFS_EVENT_LIBRARY|GUESTFS_EVENT_APPLIANCE|\n"
3841 " GUESTFS_EVENT_TRACE,\n"
3842 " 0, NULL) == -1)\n"
3843 " if (eh == -1) {\n"
3844 " // handle error in the usual way\n"
3850 #: ../src/guestfs.pod:1949
3852 "The callback can then direct messages to the appropriate place. In this "
3853 "example, messages are directed to syslog:"
3857 #: ../src/guestfs.pod:1952
3861 " message_callback (\n"
3864 " uint64_t event,\n"
3865 " int event_handle,\n"
3867 " const char *buf, size_t buf_len,\n"
3868 " const uint64_t *array, size_t array_len)\n"
3870 " const int priority = LOG_USER|LOG_INFO;\n"
3871 " if (buf_len > 0)\n"
3872 " syslog (priority, \"event 0x%lx: %s\", event, buf);\n"
3878 #: ../src/guestfs.pod:1967
3879 msgid "PRIVATE DATA AREA"
3883 #: ../src/guestfs.pod:1969
3885 "You can attach named pieces of private data to the libguestfs handle, fetch "
3886 "them by name, and walk over them, for the lifetime of the handle. This is "
3887 "called the private data area and is only available from the C API."
3891 #: ../src/guestfs.pod:1974
3892 msgid "To attach a named piece of data, use the following call:"
3896 #: ../src/guestfs.pod:1976
3899 " void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n"
3904 #: ../src/guestfs.pod:1978
3906 "C<key> is the name to associate with this data, and C<data> is an arbitrary "
3907 "pointer (which can be C<NULL>). Any previous item with the same name is "
3912 #: ../src/guestfs.pod:1982
3914 "You can use any C<key> you want, but names beginning with an underscore "
3915 "character are reserved for internal libguestfs purposes (for implementing "
3916 "language bindings). It is recommended to prefix the name with some unique "
3917 "string to avoid collisions with other users."
3921 #: ../src/guestfs.pod:1987
3922 msgid "To retrieve the pointer, use:"
3926 #: ../src/guestfs.pod:1989
3929 " void *guestfs_get_private (guestfs_h *g, const char *key);\n"
3934 #: ../src/guestfs.pod:1991
3936 "This function returns C<NULL> if either no data is found associated with "
3937 "C<key>, or if the user previously set the C<key>'s C<data> pointer to "
3942 #: ../src/guestfs.pod:1995
3944 "Libguestfs does not try to look at or interpret the C<data> pointer in any "
3945 "way. As far as libguestfs is concerned, it need not be a valid pointer at "
3946 "all. In particular, libguestfs does I<not> try to free the data when the "
3947 "handle is closed. If the data must be freed, then the caller must either "
3948 "free it before calling L</guestfs_close> or must set up a close callback to "
3949 "do it (see L</GUESTFS_EVENT_CLOSE>)."
3953 #: ../src/guestfs.pod:2002
3954 msgid "To walk over all entries, use these two functions:"
3958 #: ../src/guestfs.pod:2004
3961 " void *guestfs_first_private (guestfs_h *g, const char **key_rtn);\n"
3966 #: ../src/guestfs.pod:2006
3969 " void *guestfs_next_private (guestfs_h *g, const char **key_rtn);\n"
3974 #: ../src/guestfs.pod:2008
3976 "C<guestfs_first_private> returns the first key, pointer pair (\"first\" does "
3977 "not have any particular meaning -- keys are not returned in any defined "
3978 "order). A pointer to the key is returned in C<*key_rtn> and the "
3979 "corresponding data pointer is returned from the function. C<NULL> is "
3980 "returned if there are no keys stored in the handle."
3984 #: ../src/guestfs.pod:2014
3986 "C<guestfs_next_private> returns the next key, pointer pair. The return "
3987 "value of this function is also C<NULL> is there are no further entries to "
3992 #: ../src/guestfs.pod:2018
3993 msgid "Notes about walking over entries:"
3997 #: ../src/guestfs.pod:2024
3999 "You must not call C<guestfs_set_private> while walking over the entries."
4003 #: ../src/guestfs.pod:2029
4005 "The handle maintains an internal iterator which is reset when you call "
4006 "C<guestfs_first_private>. This internal iterator is invalidated when you "
4007 "call C<guestfs_set_private>."
4011 #: ../src/guestfs.pod:2035
4012 msgid "If you have set the data pointer associated with a key to C<NULL>, ie:"
4016 #: ../src/guestfs.pod:2037
4019 " guestfs_set_private (g, key, NULL);\n"
4024 #: ../src/guestfs.pod:2039
4025 msgid "then that C<key> is not returned when walking."
4029 #: ../src/guestfs.pod:2043
4031 "C<*key_rtn> is only valid until the next call to C<guestfs_first_private>, "
4032 "C<guestfs_next_private> or C<guestfs_set_private>."
4036 #: ../src/guestfs.pod:2049
4038 "The following example code shows how to print all keys and data pointers "
4039 "that are associated with the handle C<g>:"
4043 #: ../src/guestfs.pod:2052
4046 " const char *key;\n"
4047 " void *data = guestfs_first_private (g, &key);\n"
4048 " while (data != NULL)\n"
4050 " printf (\"key = %s, data = %p\\n\", key, data);\n"
4051 " data = guestfs_next_private (g, &key);\n"
4057 #: ../src/guestfs.pod:2060
4059 "More commonly you are only interested in keys that begin with an application-"
4060 "specific prefix C<foo_>. Modify the loop like so:"
4064 #: ../src/guestfs.pod:2063
4067 " const char *key;\n"
4068 " void *data = guestfs_first_private (g, &key);\n"
4069 " while (data != NULL)\n"
4071 " if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
4072 " printf (\"key = %s, data = %p\\n\", key, data);\n"
4073 " data = guestfs_next_private (g, &key);\n"
4079 #: ../src/guestfs.pod:2072
4081 "If you need to modify keys while walking, then you have to jump back to the "
4082 "beginning of the loop. For example, to delete all keys prefixed with "
4087 #: ../src/guestfs.pod:2076
4090 " const char *key;\n"
4093 " data = guestfs_first_private (g, &key);\n"
4094 " while (data != NULL)\n"
4096 " if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
4098 " guestfs_set_private (g, key, NULL);\n"
4099 " /* note that 'key' pointer is now invalid, and so is\n"
4100 " the internal iterator */\n"
4103 " data = guestfs_next_private (g, &key);\n"
4109 #: ../src/guestfs.pod:2092
4111 "Note that the above loop is guaranteed to terminate because the keys are "
4112 "being deleted, but other manipulations of keys within the loop might not "
4113 "terminate unless you also maintain an indication of which keys have been "
4118 #: ../src/guestfs.pod:2097 ../src/guestfs.pod:2102
4123 #: ../src/guestfs.pod:2099
4125 "<!-- old anchor for the next section --> <a name="
4126 "\"state_machine_and_low_level_event_api\"/>"
4128 "<!-- old anchor for the next section --> <a name="
4129 "\"state_machine_and_low_level_event_api\"/>"
4132 #: ../src/guestfs.pod:2104
4133 msgid "ARCHITECTURE"
4134 msgstr "АРХІТЕКТУРА"
4137 #: ../src/guestfs.pod:2106
4139 "Internally, libguestfs is implemented by running an appliance (a special "
4140 "type of small virtual machine) using L<qemu(1)>. Qemu runs as a child "
4141 "process of the main program."
4145 #: ../src/guestfs.pod:2110
4148 " ___________________\n"
4150 " | main program |\n"
4152 " | | child process / appliance\n"
4153 " | | __________________________\n"
4155 " +-------------------+ RPC | +-----------------+ |\n"
4156 " | libguestfs <--------------------> guestfsd | |\n"
4157 " | | | +-----------------+ |\n"
4158 " \\___________________/ | | Linux kernel | |\n"
4159 " | +--^--------------+ |\n"
4160 " \\_________|________________/\n"
4166 " \\______________/\n"
4171 #: ../src/guestfs.pod:2130
4173 "The library, linked to the main program, creates the child process and hence "
4174 "the appliance in the L</guestfs_launch> function."
4178 #: ../src/guestfs.pod:2133
4180 "Inside the appliance is a Linux kernel and a complete stack of userspace "
4181 "tools (such as LVM and ext2 programs) and a small controlling daemon called "
4182 "L</guestfsd>. The library talks to L</guestfsd> using remote procedure "
4183 "calls (RPC). There is a mostly one-to-one correspondence between libguestfs "
4184 "API calls and RPC calls to the daemon. Lastly the disk image(s) are "
4185 "attached to the qemu process which translates device access by the "
4186 "appliance's Linux kernel into accesses to the image."
4190 #: ../src/guestfs.pod:2142
4192 "A common misunderstanding is that the appliance \"is\" the virtual machine. "
4193 "Although the disk image you are attached to might also be used by some "
4194 "virtual machine, libguestfs doesn't know or care about this. (But you will "
4195 "care if both libguestfs's qemu process and your virtual machine are trying "
4196 "to update the disk image at the same time, since these usually results in "
4197 "massive disk corruption)."
4201 #: ../src/guestfs.pod:2149
4202 msgid "STATE MACHINE"
4203 msgstr "СКІНЧЕННИЙ АВТОМАТ"
4206 #: ../src/guestfs.pod:2151
4207 msgid "libguestfs uses a state machine to model the child process:"
4211 #: ../src/guestfs.pod:2153
4223 " / | \\ \\ guestfs_launch\n"
4224 " / | _\\__V______\n"
4226 " / | | LAUNCHING |\n"
4227 " / | \\___________/\n"
4229 " / | guestfs_launch\n"
4231 " ______ / __|____V\n"
4232 " / \\ ------> / \\\n"
4233 " | BUSY | | READY |\n"
4234 " \\______/ <------ \\________/\n"
4239 #: ../src/guestfs.pod:2175
4241 "The normal transitions are (1) CONFIG (when the handle is created, but there "
4242 "is no child process), (2) LAUNCHING (when the child process is booting up), "
4243 "(3) alternating between READY and BUSY as commands are issued to, and "
4244 "carried out by, the child process."
4248 #: ../src/guestfs.pod:2180
4250 "The guest may be killed by L</guestfs_kill_subprocess>, or may die "
4251 "asynchronously at any time (eg. due to some internal error), and that causes "
4252 "the state to transition back to CONFIG."
4256 #: ../src/guestfs.pod:2184
4258 "Configuration commands for qemu such as L</guestfs_add_drive> can only be "
4259 "issued when in the CONFIG state."
4263 #: ../src/guestfs.pod:2187
4265 "The API offers one call that goes from CONFIG through LAUNCHING to READY. "
4266 "L</guestfs_launch> blocks until the child process is READY to accept "
4267 "commands (or until some failure or timeout). L</guestfs_launch> internally "
4268 "moves the state from CONFIG to LAUNCHING while it is running."
4272 #: ../src/guestfs.pod:2193
4274 "API actions such as L</guestfs_mount> can only be issued when in the READY "
4275 "state. These API calls block waiting for the command to be carried out (ie. "
4276 "the state to transition to BUSY and then back to READY). There are no non-"
4277 "blocking versions, and no way to issue more than one command per handle at "
4282 #: ../src/guestfs.pod:2199
4284 "Finally, the child process sends asynchronous messages back to the main "
4285 "program, such as kernel log messages. You can register a callback to "
4286 "receive these messages."
4290 #: ../src/guestfs.pod:2203
4295 #: ../src/guestfs.pod:2205
4296 msgid "COMMUNICATION PROTOCOL"
4300 #: ../src/guestfs.pod:2207
4302 "Don't rely on using this protocol directly. This section documents how it "
4303 "currently works, but it may change at any time."
4307 #: ../src/guestfs.pod:2210
4309 "The protocol used to talk between the library and the daemon running inside "
4310 "the qemu virtual machine is a simple RPC mechanism built on top of XDR (RFC "
4311 "1014, RFC 1832, RFC 4506)."
4315 #: ../src/guestfs.pod:2214
4317 "The detailed format of structures is in C<src/guestfs_protocol.x> (note: "
4318 "this file is automatically generated)."
4322 #: ../src/guestfs.pod:2217
4324 "There are two broad cases, ordinary functions that don't have any C<FileIn> "
4325 "and C<FileOut> parameters, which are handled with very simple request/reply "
4326 "messages. Then there are functions that have any C<FileIn> or C<FileOut> "
4327 "parameters, which use the same request and reply messages, but they may also "
4328 "be followed by files sent using a chunked encoding."
4332 #: ../src/guestfs.pod:2224
4333 msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)"
4337 #: ../src/guestfs.pod:2226
4338 msgid "For ordinary functions, the request message is:"
4342 #: ../src/guestfs.pod:2228
4345 " total length (header + arguments,\n"
4346 " but not including the length word itself)\n"
4347 " struct guestfs_message_header (encoded as XDR)\n"
4348 " struct guestfs_<foo>_args (encoded as XDR)\n"
4353 #: ../src/guestfs.pod:2233
4355 "The total length field allows the daemon to allocate a fixed size buffer "
4356 "into which it slurps the rest of the message. As a result, the total length "
4357 "is limited to C<GUESTFS_MESSAGE_MAX> bytes (currently 4MB), which means the "
4358 "effective size of any request is limited to somewhere under this size."
4362 #: ../src/guestfs.pod:2239
4364 "Note also that many functions don't take any arguments, in which case the "
4365 "C<guestfs_I<foo>_args> is completely omitted."
4369 #: ../src/guestfs.pod:2242
4371 "The header contains the procedure number (C<guestfs_proc>) which is how the "
4372 "receiver knows what type of args structure to expect, or none at all."
4376 #: ../src/guestfs.pod:2246
4378 "For functions that take optional arguments, the optional arguments are "
4379 "encoded in the C<guestfs_I<foo>_args> structure in the same way as ordinary "
4380 "arguments. A bitmask in the header indicates which optional arguments are "
4381 "meaningful. The bitmask is also checked to see if it contains bits set "
4382 "which the daemon does not know about (eg. if more optional arguments were "
4383 "added in a later version of the library), and this causes the call to be "
4388 #: ../src/guestfs.pod:2254
4389 msgid "The reply message for ordinary functions is:"
4393 #: ../src/guestfs.pod:2256
4396 " total length (header + ret,\n"
4397 " but not including the length word itself)\n"
4398 " struct guestfs_message_header (encoded as XDR)\n"
4399 " struct guestfs_<foo>_ret (encoded as XDR)\n"
4404 #: ../src/guestfs.pod:2261
4406 "As above the C<guestfs_I<foo>_ret> structure may be completely omitted for "
4407 "functions that return no formal return values."
4411 #: ../src/guestfs.pod:2264
4413 "As above the total length of the reply is limited to C<GUESTFS_MESSAGE_MAX>."
4417 #: ../src/guestfs.pod:2267
4419 "In the case of an error, a flag is set in the header, and the reply message "
4420 "is slightly changed:"
4424 #: ../src/guestfs.pod:2270
4427 " total length (header + error,\n"
4428 " but not including the length word itself)\n"
4429 " struct guestfs_message_header (encoded as XDR)\n"
4430 " struct guestfs_message_error (encoded as XDR)\n"
4435 #: ../src/guestfs.pod:2275
4437 "The C<guestfs_message_error> structure contains the error message as a "
4442 #: ../src/guestfs.pod:2278
4443 msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS"
4447 #: ../src/guestfs.pod:2280
4449 "A C<FileIn> parameter indicates that we transfer a file I<into> the guest. "
4450 "The normal request message is sent (see above). However this is followed by "
4451 "a sequence of file chunks."
4455 #: ../src/guestfs.pod:2284
4458 " total length (header + arguments,\n"
4459 " but not including the length word itself,\n"
4460 " and not including the chunks)\n"
4461 " struct guestfs_message_header (encoded as XDR)\n"
4462 " struct guestfs_<foo>_args (encoded as XDR)\n"
4463 " sequence of chunks for FileIn param #0\n"
4464 " sequence of chunks for FileIn param #1 etc.\n"
4469 #: ../src/guestfs.pod:2292
4470 msgid "The \"sequence of chunks\" is:"
4474 #: ../src/guestfs.pod:2294
4477 " length of chunk (not including length word itself)\n"
4478 " struct guestfs_chunk (encoded as XDR)\n"
4479 " length of chunk\n"
4480 " struct guestfs_chunk (encoded as XDR)\n"
4482 " length of chunk\n"
4483 " struct guestfs_chunk (with data.data_len == 0)\n"
4488 #: ../src/guestfs.pod:2302
4490 "The final chunk has the C<data_len> field set to zero. Additionally a flag "
4491 "is set in the final chunk to indicate either successful completion or early "
4496 #: ../src/guestfs.pod:2306
4498 "At time of writing there are no functions that have more than one FileIn "
4499 "parameter. However this is (theoretically) supported, by sending the "
4500 "sequence of chunks for each FileIn parameter one after another (from left to "
4505 #: ../src/guestfs.pod:2311
4507 "Both the library (sender) I<and> the daemon (receiver) may cancel the "
4508 "transfer. The library does this by sending a chunk with a special flag set "
4509 "to indicate cancellation. When the daemon sees this, it cancels the whole "
4510 "RPC, does I<not> send any reply, and goes back to reading the next request."
4514 #: ../src/guestfs.pod:2317
4516 "The daemon may also cancel. It does this by writing a special word "
4517 "C<GUESTFS_CANCEL_FLAG> to the socket. The library listens for this during "
4518 "the transfer, and if it gets it, it will cancel the transfer (it sends a "
4519 "cancel chunk). The special word is chosen so that even if cancellation "
4520 "happens right at the end of the transfer (after the library has finished "
4521 "writing and has started listening for the reply), the \"spurious\" cancel "
4522 "flag will not be confused with the reply message."
4526 #: ../src/guestfs.pod:2326
4528 "This protocol allows the transfer of arbitrary sized files (no 32 bit "
4529 "limit), and also files where the size is not known in advance (eg. from "
4530 "pipes or sockets). However the chunks are rather small "
4531 "(C<GUESTFS_MAX_CHUNK_SIZE>), so that neither the library nor the daemon need "
4532 "to keep much in memory."
4536 #: ../src/guestfs.pod:2332
4537 msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS"
4541 #: ../src/guestfs.pod:2334
4543 "The protocol for FileOut parameters is exactly the same as for FileIn "
4544 "parameters, but with the roles of daemon and library reversed."
4548 #: ../src/guestfs.pod:2337
4551 " total length (header + ret,\n"
4552 " but not including the length word itself,\n"
4553 " and not including the chunks)\n"
4554 " struct guestfs_message_header (encoded as XDR)\n"
4555 " struct guestfs_<foo>_ret (encoded as XDR)\n"
4556 " sequence of chunks for FileOut param #0\n"
4557 " sequence of chunks for FileOut param #1 etc.\n"
4562 #: ../src/guestfs.pod:2345
4563 msgid "INITIAL MESSAGE"
4567 #: ../src/guestfs.pod:2347
4569 "When the daemon launches it sends an initial word (C<GUESTFS_LAUNCH_FLAG>) "
4570 "which indicates that the guest and daemon is alive. This is what L</"
4571 "guestfs_launch> waits for."
4575 #: ../src/guestfs.pod:2351
4576 msgid "PROGRESS NOTIFICATION MESSAGES"
4580 #: ../src/guestfs.pod:2353
4582 "The daemon may send progress notification messages at any time. These are "
4583 "distinguished by the normal length word being replaced by "
4584 "C<GUESTFS_PROGRESS_FLAG>, followed by a fixed size progress message."
4588 #: ../src/guestfs.pod:2357
4590 "The library turns them into progress callbacks (see L</"
4591 "GUESTFS_EVENT_PROGRESS>) if there is a callback registered, or discards them "
4596 #: ../src/guestfs.pod:2361
4598 "The daemon self-limits the frequency of progress messages it sends (see "
4599 "C<daemon/proto.c:notify_progress>). Not all calls generate progress "
4604 #: ../src/guestfs.pod:2365
4605 msgid "LIBGUESTFS VERSION NUMBERS"
4609 #: ../src/guestfs.pod:2367
4611 "Since April 2010, libguestfs has started to make separate development and "
4612 "stable releases, along with corresponding branches in our git repository. "
4613 "These separate releases can be identified by version number:"
4617 #: ../src/guestfs.pod:2372
4620 " even numbers for stable: 1.2.x, 1.4.x, ...\n"
4621 " .-------- odd numbers for development: 1.3.x, 1.5.x, ...\n"
4627 " | `-------- sub-version\n"
4629 " `------ always '1' because we don't change the ABI\n"
4634 #: ../src/guestfs.pod:2383
4635 msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"."
4639 #: ../src/guestfs.pod:2385
4641 "As time passes we cherry pick fixes from the development branch and backport "
4642 "those into the stable branch, the effect being that the stable branch should "
4643 "get more stable and less buggy over time. So the stable releases are ideal "
4644 "for people who don't need new features but would just like the software to "
4649 #: ../src/guestfs.pod:2391
4650 msgid "Our criteria for backporting changes are:"
4654 #: ../src/guestfs.pod:2397
4656 "Documentation changes which don't affect any code are backported unless the "
4657 "documentation refers to a future feature which is not in stable."
4661 #: ../src/guestfs.pod:2403
4663 "Bug fixes which are not controversial, fix obvious problems, and have been "
4664 "well tested are backported."
4668 #: ../src/guestfs.pod:2408
4670 "Simple rearrangements of code which shouldn't affect how it works get "
4671 "backported. This is so that the code in the two branches doesn't get too "
4672 "far out of step, allowing us to backport future fixes more easily."
4676 #: ../src/guestfs.pod:2414
4678 "We I<don't> backport new features, new APIs, new tools etc, except in one "
4679 "exceptional case: the new feature is required in order to implement an "
4680 "important bug fix."
4684 #: ../src/guestfs.pod:2420
4686 "A new stable branch starts when we think the new features in development are "
4687 "substantial and compelling enough over the current stable branch to warrant "
4688 "it. When that happens we create new stable and development versions 1.N.0 "
4689 "and 1.(N+1).0 [N is even]. The new dot-oh release won't necessarily be so "
4690 "stable at this point, but by backporting fixes from development, that branch "
4691 "will stabilize over time."
4695 #: ../src/guestfs.pod:2428
4696 msgid "EXTENDING LIBGUESTFS"
4700 #: ../src/guestfs.pod:2430
4701 msgid "ADDING A NEW API ACTION"
4705 #: ../src/guestfs.pod:2432
4707 "Large amounts of boilerplate code in libguestfs (RPC, bindings, "
4708 "documentation) are generated, and this makes it easy to extend the "
4713 #: ../src/guestfs.pod:2436
4714 msgid "To add a new API action there are two changes:"
4718 #: ../src/guestfs.pod:2442
4720 "You need to add a description of the call (name, parameters, return type, "
4721 "tests, documentation) to C<generator/generator_actions.ml>."
4725 #: ../src/guestfs.pod:2445
4727 "There are two sorts of API action, depending on whether the call goes "
4728 "through to the daemon in the appliance, or is serviced entirely by the "
4729 "library (see L</ARCHITECTURE> above). L</guestfs_sync> is an example of the "
4730 "former, since the sync is done in the appliance. L</guestfs_set_trace> is "
4731 "an example of the latter, since a trace flag is maintained in the handle and "
4732 "all tracing is done on the library side."
4736 #: ../src/guestfs.pod:2453
4738 "Most new actions are of the first type, and get added to the "
4739 "C<daemon_functions> list. Each function has a unique procedure number used "
4740 "in the RPC protocol which is assigned to that action when we publish "
4741 "libguestfs and cannot be reused. Take the latest procedure number and "
4746 #: ../src/guestfs.pod:2459
4748 "For library-only actions of the second type, add to the "
4749 "C<non_daemon_functions> list. Since these functions are serviced by the "
4750 "library and do not travel over the RPC mechanism to the daemon, these "
4751 "functions do not need a procedure number, and so the procedure number is set "
4756 #: ../src/guestfs.pod:2467
4757 msgid "Implement the action (in C):"
4761 #: ../src/guestfs.pod:2469
4763 "For daemon actions, implement the function C<do_E<lt>nameE<gt>> in the "
4764 "C<daemon/> directory."
4768 #: ../src/guestfs.pod:2472
4770 "For library actions, implement the function C<guestfs__E<lt>nameE<gt>> "
4771 "(note: double underscore) in the C<src/> directory."
4775 #: ../src/guestfs.pod:2475
4776 msgid "In either case, use another function as an example of what to do."
4780 #: ../src/guestfs.pod:2479
4781 msgid "After making these changes, use C<make> to compile."
4785 #: ../src/guestfs.pod:2481
4787 "Note that you don't need to implement the RPC, language bindings, manual "
4788 "pages or anything else. It's all automatically generated from the OCaml "
4793 #: ../src/guestfs.pod:2485
4794 msgid "ADDING TESTS FOR AN API ACTION"
4798 #: ../src/guestfs.pod:2487
4800 "You can supply zero or as many tests as you want per API call. The tests "
4801 "can either be added as part of the API description (C<generator/"
4802 "generator_actions.ml>), or in some rarer cases you may want to drop a script "
4803 "into C<regressions/>. Note that adding a script to C<regressions/> is "
4804 "slower, so if possible use the first method."
4808 #: ../src/guestfs.pod:2493
4810 "The following describes the test environment used when you add an API test "
4811 "in C<generator_actions.ml>."
4815 #: ../src/guestfs.pod:2496
4816 msgid "The test environment has 4 block devices:"
4820 #: ../src/guestfs.pod:2500
4821 msgid "C</dev/sda> 500MB"
4825 #: ../src/guestfs.pod:2502
4826 msgid "General block device for testing."
4830 #: ../src/guestfs.pod:2504
4831 msgid "C</dev/sdb> 50MB"
4835 #: ../src/guestfs.pod:2506
4837 "C</dev/sdb1> is an ext2 filesystem used for testing filesystem write "
4842 #: ../src/guestfs.pod:2509
4843 msgid "C</dev/sdc> 10MB"
4847 #: ../src/guestfs.pod:2511
4848 msgid "Used in a few tests where two block devices are needed."
4852 #: ../src/guestfs.pod:2513
4854 msgstr "C</dev/sdd>"
4857 #: ../src/guestfs.pod:2515
4858 msgid "ISO with fixed content (see C<images/test.iso>)."
4862 #: ../src/guestfs.pod:2519
4864 "To be able to run the tests in a reasonable amount of time, the libguestfs "
4865 "appliance and block devices are reused between tests. So don't try testing "
4866 "L</guestfs_kill_subprocess> :-x"
4870 #: ../src/guestfs.pod:2523
4872 "Each test starts with an initial scenario, selected using one of the "
4873 "C<Init*> expressions, described in C<generator/generator_types.ml>. These "
4874 "initialize the disks mentioned above in a particular way as documented in "
4875 "C<generator_types.ml>. You should not assume anything about the previous "
4876 "contents of other disks that are not initialized."
4880 #: ../src/guestfs.pod:2529
4882 "You can add a prerequisite clause to any individual test. This is a run-"
4883 "time check, which, if it fails, causes the test to be skipped. Useful if "
4884 "testing a command which might not work on all variations of libguestfs "
4885 "builds. A test that has prerequisite of C<Always> means to run "
4890 #: ../src/guestfs.pod:2535
4892 "In addition, packagers can skip individual tests by setting environment "
4893 "variables before running C<make check>."
4897 #: ../src/guestfs.pod:2538
4900 " SKIP_TEST_<CMD>_<NUM>=1\n"
4905 #: ../src/guestfs.pod:2540
4906 msgid "eg: C<SKIP_TEST_COMMAND_3=1> skips test #3 of L</guestfs_command>."
4910 #: ../src/guestfs.pod:2542
4915 #: ../src/guestfs.pod:2544
4918 " SKIP_TEST_<CMD>=1\n"
4923 #: ../src/guestfs.pod:2546
4924 msgid "eg: C<SKIP_TEST_ZEROFREE=1> skips all L</guestfs_zerofree> tests."
4928 #: ../src/guestfs.pod:2548
4929 msgid "Packagers can run only certain tests by setting for example:"
4933 #: ../src/guestfs.pod:2550
4936 " TEST_ONLY=\"vfs_type zerofree\"\n"
4941 #: ../src/guestfs.pod:2552
4943 "See C<capitests/tests.c> for more details of how these environment variables "
4948 #: ../src/guestfs.pod:2555
4949 msgid "DEBUGGING NEW API ACTIONS"
4953 #: ../src/guestfs.pod:2557
4954 msgid "Test new actions work before submitting them."
4958 #: ../src/guestfs.pod:2559
4959 msgid "You can use guestfish to try out new commands."
4963 #: ../src/guestfs.pod:2561
4965 "Debugging the daemon is a problem because it runs inside a minimal "
4966 "environment. However you can fprintf messages in the daemon to stderr, and "
4967 "they will show up if you use C<guestfish -v>."
4971 #: ../src/guestfs.pod:2565
4972 msgid "FORMATTING CODE AND OTHER CONVENTIONS"
4976 #: ../src/guestfs.pod:2567
4978 "Our C source code generally adheres to some basic code-formatting "
4979 "conventions. The existing code base is not totally consistent on this "
4980 "front, but we do prefer that contributed code be formatted similarly. In "
4981 "short, use spaces-not-TABs for indentation, use 2 spaces for each "
4982 "indentation level, and other than that, follow the K&R style."
4986 #: ../src/guestfs.pod:2573
4988 "If you use Emacs, add the following to one of one of your start-up files (e."
4989 "g., ~/.emacs), to help ensure that you get indentation right:"
4993 #: ../src/guestfs.pod:2576
4996 " ;;; In libguestfs, indent with spaces everywhere (not TABs).\n"
4997 " ;;; Exceptions: Makefile and ChangeLog modes.\n"
4998 " (add-hook 'find-file-hook\n"
4999 " '(lambda () (if (and buffer-file-name\n"
5000 " (string-match \"/libguestfs\\\\>\"\n"
5001 " (buffer-file-name))\n"
5002 " (not (string-equal mode-name \"Change Log\"))\n"
5003 " (not (string-equal mode-name \"Makefile\")))\n"
5004 " (setq indent-tabs-mode nil))))\n"
5009 #: ../src/guestfs.pod:2586
5012 " ;;; When editing C sources in libguestfs, use this style.\n"
5013 " (defun libguestfs-c-mode ()\n"
5014 " \"C mode with adjusted defaults for use with libguestfs.\"\n"
5016 " (c-set-style \"K&R\")\n"
5017 " (setq c-indent-level 2)\n"
5018 " (setq c-basic-offset 2))\n"
5019 " (add-hook 'c-mode-hook\n"
5020 " '(lambda () (if (string-match \"/libguestfs\\\\>\"\n"
5021 " (buffer-file-name))\n"
5022 " (libguestfs-c-mode))))\n"
5027 #: ../src/guestfs.pod:2598
5028 msgid "Enable warnings when compiling (and fix any problems this finds):"
5032 #: ../src/guestfs.pod:2601
5035 " ./configure --enable-gcc-warnings\n"
5040 #: ../src/guestfs.pod:2603
5041 msgid "Useful targets are:"
5045 #: ../src/guestfs.pod:2605
5048 " make syntax-check # checks the syntax of the C code\n"
5049 " make check # runs the test suite\n"
5054 #: ../src/guestfs.pod:2608
5055 msgid "DAEMON CUSTOM PRINTF FORMATTERS"
5059 #: ../src/guestfs.pod:2610
5061 "In the daemon code we have created custom printf formatters C<%Q> and C<%R>, "
5062 "which are used to do shell quoting."
5066 #: ../src/guestfs.pod:2615
5071 #: ../src/guestfs.pod:2617
5073 "Simple shell quoted string. Any spaces or other shell characters are "
5078 #: ../src/guestfs.pod:2620
5083 #: ../src/guestfs.pod:2622
5085 "Same as C<%Q> except the string is treated as a path which is prefixed by "
5090 #: ../src/guestfs.pod:2627 ../fish/guestfish.pod:240 ../fish/guestfish.pod:613
5091 msgid "For example:"
5095 #: ../src/guestfs.pod:2629
5098 " asprintf (&cmd, \"cat %R\", path);\n"
5103 #: ../src/guestfs.pod:2631
5104 msgid "would produce C<cat /sysroot/some\\ path\\ with\\ spaces>"
5108 #: ../src/guestfs.pod:2633
5110 "I<Note:> Do I<not> use these when you are passing parameters to the C<command"
5111 "{,r,v,rv}()> functions. These parameters do NOT need to be quoted because "
5112 "they are not passed via the shell (instead, straight to exec). You probably "
5113 "want to use the C<sysroot_path()> function however."
5117 #: ../src/guestfs.pod:2639
5118 msgid "SUBMITTING YOUR NEW API ACTIONS"
5122 #: ../src/guestfs.pod:2641
5124 "Submit patches to the mailing list: L<http://www.redhat.com/mailman/listinfo/"
5125 "libguestfs> and CC to L<rjones@redhat.com>."
5129 #: ../src/guestfs.pod:2645
5130 msgid "INTERNATIONALIZATION (I18N) SUPPORT"
5134 #: ../src/guestfs.pod:2647
5135 msgid "We support i18n (gettext anyhow) in the library."
5139 #: ../src/guestfs.pod:2649
5141 "However many messages come from the daemon, and we don't translate those at "
5142 "the moment. One reason is that the appliance generally has all locale files "
5143 "removed from it, because they take up a lot of space. So we'd have to readd "
5144 "some of those, as well as copying our PO files into the appliance."
5148 #: ../src/guestfs.pod:2655
5150 "Debugging messages are never translated, since they are intended for the "
5155 #: ../src/guestfs.pod:2658
5156 msgid "SOURCE CODE SUBDIRECTORIES"
5160 #: ../src/guestfs.pod:2662 ../src/guestfs-actions.pod:5806
5161 #: ../fish/guestfish-actions.pod:3900
5162 msgid "C<appliance>"
5163 msgstr "C<appliance>"
5166 #: ../src/guestfs.pod:2664
5167 msgid "The libguestfs appliance, build scripts and so on."
5171 #: ../src/guestfs.pod:2666
5172 msgid "C<capitests>"
5173 msgstr "C<capitests>"
5176 #: ../src/guestfs.pod:2668
5177 msgid "Automated tests of the C API."
5181 #: ../src/guestfs.pod:2670
5186 #: ../src/guestfs.pod:2672
5188 "The L<virt-cat(1)>, L<virt-filesystems(1)> and L<virt-ls(1)> commands and "
5193 #: ../src/guestfs.pod:2675
5198 #: ../src/guestfs.pod:2677
5199 msgid "Outside contributions, experimental parts."
5203 #: ../src/guestfs.pod:2679
5208 #: ../src/guestfs.pod:2681
5210 "The daemon that runs inside the libguestfs appliance and carries out actions."
5214 #: ../src/guestfs.pod:2684
5219 #: ../src/guestfs.pod:2686
5220 msgid "L<virt-df(1)> command and documentation."
5224 #: ../src/guestfs.pod:2688
5226 msgstr "C<examples>"
5229 #: ../src/guestfs.pod:2690
5230 msgid "C API example code."
5231 msgstr "Код прикладів використання програмного інтерфейсу мовою C."
5234 #: ../src/guestfs.pod:2692
5239 #: ../src/guestfs.pod:2694
5241 "L<guestfish(1)>, the command-line shell, and various shell scripts built on "
5242 "top such as L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, "
5243 "L<virt-tar-out(1)>."
5247 #: ../src/guestfs.pod:2698
5252 #: ../src/guestfs.pod:2700
5254 "L<guestmount(1)>, FUSE (userspace filesystem) built on top of libguestfs."
5258 #: ../src/guestfs.pod:2702
5259 msgid "C<generator>"
5260 msgstr "C<generator>"
5263 #: ../src/guestfs.pod:2704
5265 "The crucially important generator, used to automatically generate large "
5266 "amounts of boilerplate C code for things like RPC and bindings."
5270 #: ../src/guestfs.pod:2707
5275 #: ../src/guestfs.pod:2709
5276 msgid "Files used by the test suite."
5280 #: ../src/guestfs.pod:2711
5281 msgid "Some \"phony\" guest images which we test against."
5285 #: ../src/guestfs.pod:2713
5286 msgid "C<inspector>"
5287 msgstr "C<inspector>"
5290 #: ../src/guestfs.pod:2715
5291 msgid "L<virt-inspector(1)>, the virtual machine image inspector."
5295 #: ../src/guestfs.pod:2717
5300 #: ../src/guestfs.pod:2719
5301 msgid "Logo used on the website. The fish is called Arthur by the way."
5305 #: ../src/guestfs.pod:2721
5310 #: ../src/guestfs.pod:2723
5311 msgid "M4 macros used by autoconf."
5315 #: ../src/guestfs.pod:2725
5320 #: ../src/guestfs.pod:2727
5321 msgid "Translations of simple gettext strings."
5322 msgstr "Переклади простих рядків gettext."
5325 #: ../src/guestfs.pod:2729
5330 #: ../src/guestfs.pod:2731
5332 "The build infrastructure and PO files for translations of manpages and POD "
5333 "files. Eventually this will be combined with the C<po> directory, but that "
5334 "is rather complicated."
5338 #: ../src/guestfs.pod:2735
5339 msgid "C<regressions>"
5340 msgstr "C<regressions>"
5343 #: ../src/guestfs.pod:2737
5344 msgid "Regression tests."
5345 msgstr "Тести на регресії."
5348 #: ../src/guestfs.pod:2739
5353 #: ../src/guestfs.pod:2741
5354 msgid "L<virt-rescue(1)> command and documentation."
5358 #: ../src/guestfs.pod:2743
5363 #: ../src/guestfs.pod:2745
5364 msgid "Source code to the C library."
5368 #: ../src/guestfs.pod:2747
5373 #: ../src/guestfs.pod:2749
5374 msgid "Command line tools written in Perl (L<virt-resize(1)> and many others)."
5378 #: ../src/guestfs.pod:2751
5379 msgid "C<test-tool>"
5380 msgstr "C<test-tool>"
5383 #: ../src/guestfs.pod:2753
5385 "Test tool for end users to test if their qemu/kernel combination will work "
5390 #: ../src/guestfs.pod:2756
5395 #: ../src/guestfs.pod:2758
5400 #: ../src/guestfs.pod:2760
5405 #: ../src/guestfs.pod:2762
5410 #: ../src/guestfs.pod:2764
5415 #: ../src/guestfs.pod:2766
5420 #: ../src/guestfs.pod:2768
5425 #: ../src/guestfs.pod:2770
5430 #: ../src/guestfs.pod:2772
5431 msgid "Language bindings."
5432 msgstr "Прив’язки до мов програмування."
5435 #: ../src/guestfs.pod:2776 ../fish/guestfish.pod:1015
5436 #: ../test-tool/libguestfs-test-tool.pod:82 ../tools/virt-edit.pl:476
5437 msgid "ENVIRONMENT VARIABLES"
5438 msgstr "ЗМІННІ СЕРЕДОВИЩА"
5441 #: ../src/guestfs.pod:2780 ../fish/guestfish.pod:1041
5442 msgid "LIBGUESTFS_APPEND"
5446 #: ../src/guestfs.pod:2782 ../fish/guestfish.pod:1043
5447 msgid "Pass additional options to the guest kernel."
5451 #: ../src/guestfs.pod:2784 ../fish/guestfish.pod:1045
5452 msgid "LIBGUESTFS_DEBUG"
5456 #: ../src/guestfs.pod:2786
5458 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
5459 "effect as calling C<guestfs_set_verbose (g, 1)>."
5463 #: ../src/guestfs.pod:2789 ../fish/guestfish.pod:1050
5464 msgid "LIBGUESTFS_MEMSIZE"
5468 #: ../src/guestfs.pod:2791 ../fish/guestfish.pod:1052
5470 "Set the memory allocated to the qemu process, in megabytes. For example:"
5474 #: ../src/guestfs.pod:2794 ../fish/guestfish.pod:1055
5477 " LIBGUESTFS_MEMSIZE=700\n"
5482 #: ../src/guestfs.pod:2796 ../fish/guestfish.pod:1057
5483 msgid "LIBGUESTFS_PATH"
5487 #: ../src/guestfs.pod:2798
5489 "Set the path that libguestfs uses to search for a supermin appliance. See "
5490 "the discussion of paths in section L</PATH> above."
5494 #: ../src/guestfs.pod:2801 ../fish/guestfish.pod:1062
5495 msgid "LIBGUESTFS_QEMU"
5499 #: ../src/guestfs.pod:2803 ../fish/guestfish.pod:1064
5501 "Set the default qemu binary that libguestfs uses. If not set, then the qemu "
5502 "which was found at compile time by the configure script is used."
5506 #: ../src/guestfs.pod:2807
5507 msgid "See also L</QEMU WRAPPERS> above."
5511 #: ../src/guestfs.pod:2809 ../fish/guestfish.pod:1068
5512 msgid "LIBGUESTFS_TRACE"
5516 #: ../src/guestfs.pod:2811
5518 "Set C<LIBGUESTFS_TRACE=1> to enable command traces. This has the same "
5519 "effect as calling C<guestfs_set_trace (g, 1)>."
5523 #: ../src/guestfs.pod:2814 ../fish/guestfish.pod:1077
5528 #: ../src/guestfs.pod:2816 ../fish/guestfish.pod:1079
5530 "Location of temporary directory, defaults to C</tmp> except for the cached "
5531 "supermin appliance which defaults to C</var/tmp>."
5535 #: ../src/guestfs.pod:2819 ../fish/guestfish.pod:1082
5537 "If libguestfs was compiled to use the supermin appliance then the real "
5538 "appliance is cached in this directory, shared between all handles belonging "
5539 "to the same EUID. You can use C<$TMPDIR> to configure another directory to "
5540 "use in case C</var/tmp> is not large enough."
5544 #: ../src/guestfs.pod:2827 ../fish/guestfish.pod:1149
5545 #: ../test-tool/libguestfs-test-tool.pod:87 ../fuse/guestmount.pod:267
5546 #: ../tools/virt-edit.pl:496 ../tools/virt-win-reg.pl:572
5547 #: ../tools/virt-list-filesystems.pl:189 ../tools/virt-tar.pl:286
5548 #: ../tools/virt-make-fs.pl:539 ../tools/virt-list-partitions.pl:257
5550 msgstr "ТАКОЖ ПЕРЕГЛЯНЬТЕ"
5553 #: ../src/guestfs.pod:2829
5555 "L<guestfs-examples(3)>, L<guestfs-ocaml(3)>, L<guestfs-python(3)>, L<guestfs-"
5556 "ruby(3)>, L<guestfish(1)>, L<guestmount(1)>, L<virt-cat(1)>, L<virt-copy-in"
5557 "(1)>, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, L<virt-filesystems"
5558 "(1)>, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, L<virt-list-"
5559 "partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, L<virt-rescue(1)>, L<virt-"
5560 "tar(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<virt-win-reg(1)>, L<qemu(1)"
5561 ">, L<febootstrap(1)>, L<hivex(3)>, L<http://libguestfs.org/>."
5565 #: ../src/guestfs.pod:2856
5567 "Tools with a similar purpose: L<fdisk(8)>, L<parted(8)>, L<kpartx(8)>, L<lvm"
5568 "(8)>, L<disktype(1)>."
5572 #: ../src/guestfs.pod:2863 ../tools/virt-win-reg.pl:587
5573 #: ../tools/virt-make-fs.pl:553
5578 #: ../src/guestfs.pod:2865
5579 msgid "To get a list of bugs against libguestfs use this link:"
5581 "Щоб переглянути список відомих вад у libguestfs, скористайтеся таким "
5585 #: ../src/guestfs.pod:2867
5587 "L<https://bugzilla.redhat.com/buglist.cgi?"
5588 "component=libguestfs&product=Virtualization+Tools>"
5590 "L<https://bugzilla.redhat.com/buglist.cgi?"
5591 "component=libguestfs&product=Virtualization+Tools>"
5594 #: ../src/guestfs.pod:2869
5595 msgid "To report a new bug against libguestfs use this link:"
5596 msgstr "Для звітування щодо вад у libguestfs скористайтеся цим посиланням:"
5599 #: ../src/guestfs.pod:2871
5601 "L<https://bugzilla.redhat.com/enter_bug.cgi?"
5602 "component=libguestfs&product=Virtualization+Tools>"
5604 "L<https://bugzilla.redhat.com/enter_bug.cgi?"
5605 "component=libguestfs&product=Virtualization+Tools>"
5608 #: ../src/guestfs.pod:2873
5609 msgid "When reporting a bug, please check:"
5613 #: ../src/guestfs.pod:2879
5614 msgid "That the bug hasn't been reported already."
5618 #: ../src/guestfs.pod:2883
5619 msgid "That you are testing a recent version."
5623 #: ../src/guestfs.pod:2887
5624 msgid "Describe the bug accurately, and give a way to reproduce it."
5628 #: ../src/guestfs.pod:2891
5630 "Run libguestfs-test-tool and paste the B<complete, unedited> output into the "
5635 #: ../src/guestfs.pod:2896 ../fish/guestfish.pod:1172
5636 #: ../test-tool/libguestfs-test-tool.pod:93 ../fuse/guestmount.pod:278
5641 #: ../src/guestfs.pod:2898 ../fish/guestfish.pod:1174
5642 #: ../test-tool/libguestfs-test-tool.pod:95 ../fuse/guestmount.pod:280
5643 msgid "Richard W.M. Jones (C<rjones at redhat dot com>)"
5647 #: ../src/guestfs.pod:2900 ../fish/guestfish.pod:1176
5648 #: ../test-tool/libguestfs-test-tool.pod:97 ../fuse/guestmount.pod:282
5649 #: ../tools/virt-edit.pl:514 ../tools/virt-win-reg.pl:602
5650 #: ../tools/virt-list-filesystems.pl:206 ../tools/virt-tar.pl:305
5651 #: ../tools/virt-make-fs.pl:568 ../tools/virt-list-partitions.pl:273
5653 msgstr "АВТОРСЬКІ ПРАВА"
5656 #: ../src/guestfs.pod:2902 ../fish/guestfish.pod:1178
5657 #: ../test-tool/libguestfs-test-tool.pod:99
5658 msgid "Copyright (C) 2009-2011 Red Hat Inc. L<http://libguestfs.org/>"
5662 #: ../src/guestfs.pod:2905
5664 "This library is free software; you can redistribute it and/or modify it "
5665 "under the terms of the GNU Lesser General Public License as published by the "
5666 "Free Software Foundation; either version 2 of the License, or (at your "
5667 "option) any later version."
5671 #: ../src/guestfs.pod:2910
5673 "This library is distributed in the hope that it will be useful, but WITHOUT "
5674 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
5675 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License "
5680 #: ../src/guestfs.pod:2915
5682 "You should have received a copy of the GNU Lesser General Public License "
5683 "along with this library; if not, write to the Free Software Foundation, "
5684 "Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA"
5688 #: ../src/guestfs-actions.pod:1
5689 msgid "guestfs_add_cdrom"
5693 #: ../src/guestfs-actions.pod:3
5697 " guestfs_add_cdrom (guestfs_h *g,\n"
5698 " const char *filename);\n"
5703 #: ../src/guestfs-actions.pod:7 ../fish/guestfish-actions.pod:5
5704 msgid "This function adds a virtual CD-ROM disk image to the guest."
5708 #: ../src/guestfs-actions.pod:9 ../fish/guestfish-actions.pod:7
5709 msgid "This is equivalent to the qemu parameter C<-cdrom filename>."
5713 #: ../src/guestfs-actions.pod:17
5715 "This call checks for the existence of C<filename>. This stops you from "
5716 "specifying other types of drive which are supported by qemu such as C<nbd:> "
5717 "and C<http:> URLs. To specify those, use the general C<guestfs_config> call "
5722 #: ../src/guestfs-actions.pod:24
5724 "If you just want to add an ISO file (often you use this as an efficient way "
5725 "to transfer large files into the guest), then you should probably use "
5726 "C<guestfs_add_drive_ro> instead."
5730 #: ../src/guestfs-actions.pod:30 ../src/guestfs-actions.pod:134
5731 #: ../src/guestfs-actions.pod:195 ../src/guestfs-actions.pod:232
5732 #: ../src/guestfs-actions.pod:246 ../src/guestfs-actions.pod:267
5733 #: ../src/guestfs-actions.pod:287 ../src/guestfs-actions.pod:301
5734 #: ../src/guestfs-actions.pod:416 ../src/guestfs-actions.pod:436
5735 #: ../src/guestfs-actions.pod:450 ../src/guestfs-actions.pod:495
5736 #: ../src/guestfs-actions.pod:523 ../src/guestfs-actions.pod:541
5737 #: ../src/guestfs-actions.pod:608 ../src/guestfs-actions.pod:641
5738 #: ../src/guestfs-actions.pod:655 ../src/guestfs-actions.pod:670
5739 #: ../src/guestfs-actions.pod:769 ../src/guestfs-actions.pod:787
5740 #: ../src/guestfs-actions.pod:801 ../src/guestfs-actions.pod:815
5741 #: ../src/guestfs-actions.pod:976 ../src/guestfs-actions.pod:996
5742 #: ../src/guestfs-actions.pod:1014 ../src/guestfs-actions.pod:1098
5743 #: ../src/guestfs-actions.pod:1116 ../src/guestfs-actions.pod:1135
5744 #: ../src/guestfs-actions.pod:1149 ../src/guestfs-actions.pod:1169
5745 #: ../src/guestfs-actions.pod:1239 ../src/guestfs-actions.pod:1270
5746 #: ../src/guestfs-actions.pod:1295 ../src/guestfs-actions.pod:1337
5747 #: ../src/guestfs-actions.pod:1443 ../src/guestfs-actions.pod:1477
5748 #: ../src/guestfs-actions.pod:1695 ../src/guestfs-actions.pod:1717
5749 #: ../src/guestfs-actions.pod:1804 ../src/guestfs-actions.pod:2266
5750 #: ../src/guestfs-actions.pod:2410 ../src/guestfs-actions.pod:2471
5751 #: ../src/guestfs-actions.pod:2506 ../src/guestfs-actions.pod:3451
5752 #: ../src/guestfs-actions.pod:3466 ../src/guestfs-actions.pod:3491
5753 #: ../src/guestfs-actions.pod:3646 ../src/guestfs-actions.pod:3660
5754 #: ../src/guestfs-actions.pod:3673 ../src/guestfs-actions.pod:3687
5755 #: ../src/guestfs-actions.pod:3702 ../src/guestfs-actions.pod:3738
5756 #: ../src/guestfs-actions.pod:3810 ../src/guestfs-actions.pod:3830
5757 #: ../src/guestfs-actions.pod:3847 ../src/guestfs-actions.pod:3870
5758 #: ../src/guestfs-actions.pod:3893 ../src/guestfs-actions.pod:3925
5759 #: ../src/guestfs-actions.pod:3944 ../src/guestfs-actions.pod:3963
5760 #: ../src/guestfs-actions.pod:3998 ../src/guestfs-actions.pod:4010
5761 #: ../src/guestfs-actions.pod:4046 ../src/guestfs-actions.pod:4062
5762 #: ../src/guestfs-actions.pod:4075 ../src/guestfs-actions.pod:4090
5763 #: ../src/guestfs-actions.pod:4107 ../src/guestfs-actions.pod:4200
5764 #: ../src/guestfs-actions.pod:4220 ../src/guestfs-actions.pod:4233
5765 #: ../src/guestfs-actions.pod:4284 ../src/guestfs-actions.pod:4302
5766 #: ../src/guestfs-actions.pod:4320 ../src/guestfs-actions.pod:4336
5767 #: ../src/guestfs-actions.pod:4350 ../src/guestfs-actions.pod:4364
5768 #: ../src/guestfs-actions.pod:4381 ../src/guestfs-actions.pod:4396
5769 #: ../src/guestfs-actions.pod:4416 ../src/guestfs-actions.pod:4474
5770 #: ../src/guestfs-actions.pod:4547 ../src/guestfs-actions.pod:4578
5771 #: ../src/guestfs-actions.pod:4597 ../src/guestfs-actions.pod:4616
5772 #: ../src/guestfs-actions.pod:4628 ../src/guestfs-actions.pod:4645
5773 #: ../src/guestfs-actions.pod:4658 ../src/guestfs-actions.pod:4673
5774 #: ../src/guestfs-actions.pod:4688 ../src/guestfs-actions.pod:4723
5775 #: ../src/guestfs-actions.pod:4738 ../src/guestfs-actions.pod:4758
5776 #: ../src/guestfs-actions.pod:4772 ../src/guestfs-actions.pod:4789
5777 #: ../src/guestfs-actions.pod:4838 ../src/guestfs-actions.pod:4875
5778 #: ../src/guestfs-actions.pod:4889 ../src/guestfs-actions.pod:4917
5779 #: ../src/guestfs-actions.pod:4934 ../src/guestfs-actions.pod:4952
5780 #: ../src/guestfs-actions.pod:5086 ../src/guestfs-actions.pod:5143
5781 #: ../src/guestfs-actions.pod:5165 ../src/guestfs-actions.pod:5183
5782 #: ../src/guestfs-actions.pod:5215 ../src/guestfs-actions.pod:5281
5783 #: ../src/guestfs-actions.pod:5298 ../src/guestfs-actions.pod:5311
5784 #: ../src/guestfs-actions.pod:5325 ../src/guestfs-actions.pod:5614
5785 #: ../src/guestfs-actions.pod:5633 ../src/guestfs-actions.pod:5652
5786 #: ../src/guestfs-actions.pod:5664 ../src/guestfs-actions.pod:5676
5787 #: ../src/guestfs-actions.pod:5690 ../src/guestfs-actions.pod:5702
5788 #: ../src/guestfs-actions.pod:5716 ../src/guestfs-actions.pod:5732
5789 #: ../src/guestfs-actions.pod:5753 ../src/guestfs-actions.pod:5772
5790 #: ../src/guestfs-actions.pod:5791 ../src/guestfs-actions.pod:5821
5791 #: ../src/guestfs-actions.pod:5837 ../src/guestfs-actions.pod:5860
5792 #: ../src/guestfs-actions.pod:5878 ../src/guestfs-actions.pod:5897
5793 #: ../src/guestfs-actions.pod:5918 ../src/guestfs-actions.pod:5937
5794 #: ../src/guestfs-actions.pod:5954 ../src/guestfs-actions.pod:5982
5795 #: ../src/guestfs-actions.pod:6006 ../src/guestfs-actions.pod:6025
5796 #: ../src/guestfs-actions.pod:6049 ../src/guestfs-actions.pod:6068
5797 #: ../src/guestfs-actions.pod:6083 ../src/guestfs-actions.pod:6102
5798 #: ../src/guestfs-actions.pod:6139 ../src/guestfs-actions.pod:6162
5799 #: ../src/guestfs-actions.pod:6188 ../src/guestfs-actions.pod:6296
5800 #: ../src/guestfs-actions.pod:6417 ../src/guestfs-actions.pod:6429
5801 #: ../src/guestfs-actions.pod:6442 ../src/guestfs-actions.pod:6455
5802 #: ../src/guestfs-actions.pod:6477 ../src/guestfs-actions.pod:6490
5803 #: ../src/guestfs-actions.pod:6503 ../src/guestfs-actions.pod:6516
5804 #: ../src/guestfs-actions.pod:6531 ../src/guestfs-actions.pod:6590
5805 #: ../src/guestfs-actions.pod:6607 ../src/guestfs-actions.pod:6623
5806 #: ../src/guestfs-actions.pod:6639 ../src/guestfs-actions.pod:6656
5807 #: ../src/guestfs-actions.pod:6669 ../src/guestfs-actions.pod:6689
5808 #: ../src/guestfs-actions.pod:6725 ../src/guestfs-actions.pod:6739
5809 #: ../src/guestfs-actions.pod:6780 ../src/guestfs-actions.pod:6793
5810 #: ../src/guestfs-actions.pod:6811 ../src/guestfs-actions.pod:6845
5811 #: ../src/guestfs-actions.pod:6881 ../src/guestfs-actions.pod:7000
5812 #: ../src/guestfs-actions.pod:7018 ../src/guestfs-actions.pod:7032
5813 #: ../src/guestfs-actions.pod:7087 ../src/guestfs-actions.pod:7100
5814 #: ../src/guestfs-actions.pod:7145 ../src/guestfs-actions.pod:7178
5815 #: ../src/guestfs-actions.pod:7232 ../src/guestfs-actions.pod:7258
5816 #: ../src/guestfs-actions.pod:7324 ../src/guestfs-actions.pod:7343
5817 #: ../src/guestfs-actions.pod:7372
5818 msgid "This function returns 0 on success or -1 on error."
5822 #: ../src/guestfs-actions.pod:32 ../src/guestfs-actions.pod:248
5823 #: ../src/guestfs-actions.pod:269 ../fish/guestfish-actions.pod:28
5824 #: ../fish/guestfish-actions.pod:158 ../fish/guestfish-actions.pod:172
5826 "This function is deprecated. In new code, use the C<add_drive_opts> call "
5831 #: ../src/guestfs-actions.pod:35 ../src/guestfs-actions.pod:251
5832 #: ../src/guestfs-actions.pod:272 ../src/guestfs-actions.pod:1448
5833 #: ../src/guestfs-actions.pod:1944 ../src/guestfs-actions.pod:1965
5834 #: ../src/guestfs-actions.pod:4421 ../src/guestfs-actions.pod:7266
5835 #: ../src/guestfs-actions.pod:7435 ../fish/guestfish-actions.pod:31
5836 #: ../fish/guestfish-actions.pod:161 ../fish/guestfish-actions.pod:175
5837 #: ../fish/guestfish-actions.pod:956 ../fish/guestfish-actions.pod:1319
5838 #: ../fish/guestfish-actions.pod:1333 ../fish/guestfish-actions.pod:3000
5839 #: ../fish/guestfish-actions.pod:4858 ../fish/guestfish-actions.pod:4955
5841 "Deprecated functions will not be removed from the API, but the fact that "
5842 "they are deprecated indicates that there are problems with correct use of "
5847 #: ../src/guestfs-actions.pod:39 ../src/guestfs-actions.pod:136
5848 #: ../src/guestfs-actions.pod:1100 ../src/guestfs-actions.pod:1916
5849 #: ../src/guestfs-actions.pod:2014 ../src/guestfs-actions.pod:2117
5850 #: ../src/guestfs-actions.pod:3453 ../src/guestfs-actions.pod:3473
5851 #: ../src/guestfs-actions.pod:4725 ../src/guestfs-actions.pod:5839
5852 #: ../src/guestfs-actions.pod:5956 ../src/guestfs-actions.pod:6070
5853 #: ../src/guestfs-actions.pod:6533 ../src/guestfs-actions.pod:6658
5854 #: ../src/guestfs-actions.pod:7180
5855 msgid "(Added in 0.3)"
5859 #: ../src/guestfs-actions.pod:41
5860 msgid "guestfs_add_domain"
5864 #: ../src/guestfs-actions.pod:43
5868 " guestfs_add_domain (guestfs_h *g,\n"
5869 " const char *dom,\n"
5875 #: ../src/guestfs-actions.pod:48 ../src/guestfs-actions.pod:145
5876 #: ../src/guestfs-actions.pod:4435
5878 "You may supply a list of optional arguments to this call. Use zero or more "
5879 "of the following pairs of parameters, and terminate the list with C<-1> on "
5880 "its own. See L</CALLS WITH OPTIONAL ARGUMENTS>."
5884 #: ../src/guestfs-actions.pod:53
5887 " GUESTFS_ADD_DOMAIN_LIBVIRTURI, const char *libvirturi,\n"
5888 " GUESTFS_ADD_DOMAIN_READONLY, int readonly,\n"
5889 " GUESTFS_ADD_DOMAIN_IFACE, const char *iface,\n"
5890 " GUESTFS_ADD_DOMAIN_LIVE, int live,\n"
5895 #: ../src/guestfs-actions.pod:58
5897 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
5898 "It works by connecting to libvirt, requesting the domain and domain XML from "
5899 "libvirt, parsing it for disks, and calling C<guestfs_add_drive_opts> on each "
5904 #: ../src/guestfs-actions.pod:63 ../fish/guestfish-actions.pod:46
5906 "The number of disks added is returned. This operation is atomic: if an "
5907 "error is returned, then no disks are added."
5911 #: ../src/guestfs-actions.pod:66 ../fish/guestfish-actions.pod:49
5913 "This function does some minimal checks to make sure the libvirt domain is "
5914 "not running (unless C<readonly> is true). In a future version we will try "
5915 "to acquire the libvirt lock on each disk."
5919 #: ../src/guestfs-actions.pod:70 ../fish/guestfish-actions.pod:53
5921 "Disks must be accessible locally. This often means that adding disks from a "
5922 "remote libvirt connection (see L<http://libvirt.org/remote.html>) will fail "
5923 "unless those disks are accessible via the same device path locally too."
5927 #: ../src/guestfs-actions.pod:75 ../fish/guestfish-actions.pod:58
5929 "The optional C<libvirturi> parameter sets the libvirt URI (see L<http://"
5930 "libvirt.org/uri.html>). If this is not set then we connect to the default "
5931 "libvirt URI (or one set through an environment variable, see the libvirt "
5932 "documentation for full details)."
5936 #: ../src/guestfs-actions.pod:81 ../fish/guestfish-actions.pod:64
5938 "The optional C<live> flag controls whether this call will try to connect to "
5939 "a running virtual machine C<guestfsd> process if it sees a suitable "
5940 "E<lt>channelE<gt> element in the libvirt XML definition. The default (if "
5941 "the flag is omitted) is never to try. See L<guestfs(3)/ATTACHING TO RUNNING "
5942 "DAEMONS> for more information."
5946 #: ../src/guestfs-actions.pod:88
5948 "The other optional parameters are passed directly through to "
5949 "C<guestfs_add_drive_opts>."
5953 #: ../src/guestfs-actions.pod:91 ../src/guestfs-actions.pod:344
5954 #: ../src/guestfs-actions.pod:509 ../src/guestfs-actions.pod:687
5955 #: ../src/guestfs-actions.pod:718 ../src/guestfs-actions.pod:736
5956 #: ../src/guestfs-actions.pod:755 ../src/guestfs-actions.pod:1315
5957 #: ../src/guestfs-actions.pod:1674 ../src/guestfs-actions.pod:1877
5958 #: ../src/guestfs-actions.pod:1986 ../src/guestfs-actions.pod:2026
5959 #: ../src/guestfs-actions.pod:2081 ../src/guestfs-actions.pod:2104
5960 #: ../src/guestfs-actions.pod:2397 ../src/guestfs-actions.pod:2772
5961 #: ../src/guestfs-actions.pod:2793 ../src/guestfs-actions.pod:4861
5962 #: ../src/guestfs-actions.pod:4989 ../src/guestfs-actions.pod:5395
5963 #: ../src/guestfs-actions.pod:5421 ../src/guestfs-actions.pod:6766
5964 #: ../src/guestfs-actions.pod:7191 ../src/guestfs-actions.pod:7204
5965 #: ../src/guestfs-actions.pod:7217
5966 msgid "On error this function returns -1."
5970 #: ../src/guestfs-actions.pod:93
5971 msgid "(Added in 1.7.4)"
5975 #: ../src/guestfs-actions.pod:95
5976 msgid "guestfs_add_domain_va"
5980 #: ../src/guestfs-actions.pod:97
5984 " guestfs_add_domain_va (guestfs_h *g,\n"
5985 " const char *dom,\n"
5991 #: ../src/guestfs-actions.pod:102
5992 msgid "This is the \"va_list variant\" of L</guestfs_add_domain>."
5996 #: ../src/guestfs-actions.pod:104 ../src/guestfs-actions.pod:115
5997 #: ../src/guestfs-actions.pod:208 ../src/guestfs-actions.pod:219
5998 #: ../src/guestfs-actions.pod:4488 ../src/guestfs-actions.pod:4500
5999 msgid "See L</CALLS WITH OPTIONAL ARGUMENTS>."
6003 #: ../src/guestfs-actions.pod:106
6004 msgid "guestfs_add_domain_argv"
6008 #: ../src/guestfs-actions.pod:108
6012 " guestfs_add_domain_argv (guestfs_h *g,\n"
6013 " const char *dom,\n"
6014 " const struct guestfs_add_domain_argv *optargs);\n"
6019 #: ../src/guestfs-actions.pod:113
6020 msgid "This is the \"argv variant\" of L</guestfs_add_domain>."
6024 #: ../src/guestfs-actions.pod:117
6025 msgid "guestfs_add_drive"
6029 #: ../src/guestfs-actions.pod:119
6033 " guestfs_add_drive (guestfs_h *g,\n"
6034 " const char *filename);\n"
6039 #: ../src/guestfs-actions.pod:123
6041 "This function is the equivalent of calling C<guestfs_add_drive_opts> with no "
6042 "optional parameters, so the disk is added writable, with the format being "
6043 "detected automatically."
6047 #: ../src/guestfs-actions.pod:127
6049 "Automatic detection of the format opens you up to a potential security hole "
6050 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
6051 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
6052 "you should think about replacing calls to this function with calls to "
6053 "C<guestfs_add_drive_opts>, and specifying the format."
6057 #: ../src/guestfs-actions.pod:138
6058 msgid "guestfs_add_drive_opts"
6062 #: ../src/guestfs-actions.pod:140
6066 " guestfs_add_drive_opts (guestfs_h *g,\n"
6067 " const char *filename,\n"
6073 #: ../src/guestfs-actions.pod:150
6076 " GUESTFS_ADD_DRIVE_OPTS_READONLY, int readonly,\n"
6077 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, const char *format,\n"
6078 " GUESTFS_ADD_DRIVE_OPTS_IFACE, const char *iface,\n"
6083 #: ../src/guestfs-actions.pod:154 ../fish/guestfish-actions.pod:97
6085 "This function adds a virtual machine disk image C<filename> to libguestfs. "
6086 "The first time you call this function, the disk appears as C</dev/sda>, the "
6087 "second time as C</dev/sdb>, and so on."
6091 #: ../src/guestfs-actions.pod:159 ../fish/guestfish-actions.pod:102
6093 "You don't necessarily need to be root when using libguestfs. However you "
6094 "obviously do need sufficient permissions to access the filename for whatever "
6095 "operations you want to perform (ie. read access if you just want to read the "
6096 "image or write access if you want to modify the image)."
6100 #: ../src/guestfs-actions.pod:165 ../fish/guestfish-actions.pod:108
6101 msgid "This call checks that C<filename> exists."
6105 #: ../src/guestfs-actions.pod:167 ../src/guestfs-actions.pod:4446
6106 #: ../fish/guestfish-actions.pod:110 ../fish/guestfish-actions.pod:3011
6107 msgid "The optional arguments are:"
6111 #: ../src/guestfs-actions.pod:171 ../fish/guestfish-actions.pod:114
6113 msgstr "C<readonly>"
6116 #: ../src/guestfs-actions.pod:173 ../fish/guestfish-actions.pod:116
6118 "If true then the image is treated as read-only. Writes are still allowed, "
6119 "but they are stored in a temporary snapshot overlay which is discarded at "
6120 "the end. The disk that you add is not modified."
6124 #: ../src/guestfs-actions.pod:177 ../fish/guestfish-actions.pod:120
6129 #: ../src/guestfs-actions.pod:179
6131 "This forces the image format. If you omit this (or use C<guestfs_add_drive> "
6132 "or C<guestfs_add_drive_ro>) then the format is automatically detected. "
6133 "Possible formats include C<raw> and C<qcow2>."
6137 #: ../src/guestfs-actions.pod:183 ../fish/guestfish-actions.pod:126
6139 "Automatic detection of the format opens you up to a potential security hole "
6140 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
6141 "RHBZ#642934. Specifying the format closes this security hole."
6145 #: ../src/guestfs-actions.pod:188 ../fish/guestfish-actions.pod:131
6150 #: ../src/guestfs-actions.pod:190
6152 "This rarely-used option lets you emulate the behaviour of the deprecated "
6153 "C<guestfs_add_drive_with_if> call (q.v.)"
6157 #: ../src/guestfs-actions.pod:197
6158 msgid "(Added in 1.5.23)"
6162 #: ../src/guestfs-actions.pod:199
6163 msgid "guestfs_add_drive_opts_va"
6167 #: ../src/guestfs-actions.pod:201
6171 " guestfs_add_drive_opts_va (guestfs_h *g,\n"
6172 " const char *filename,\n"
6178 #: ../src/guestfs-actions.pod:206
6179 msgid "This is the \"va_list variant\" of L</guestfs_add_drive_opts>."
6183 #: ../src/guestfs-actions.pod:210
6184 msgid "guestfs_add_drive_opts_argv"
6188 #: ../src/guestfs-actions.pod:212
6192 " guestfs_add_drive_opts_argv (guestfs_h *g,\n"
6193 " const char *filename,\n"
6194 " const struct guestfs_add_drive_opts_argv *optargs);\n"
6199 #: ../src/guestfs-actions.pod:217
6200 msgid "This is the \"argv variant\" of L</guestfs_add_drive_opts>."
6204 #: ../src/guestfs-actions.pod:221
6205 msgid "guestfs_add_drive_ro"
6209 #: ../src/guestfs-actions.pod:223
6213 " guestfs_add_drive_ro (guestfs_h *g,\n"
6214 " const char *filename);\n"
6219 #: ../src/guestfs-actions.pod:227
6221 "This function is the equivalent of calling C<guestfs_add_drive_opts> with "
6222 "the optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the "
6223 "disk is added read-only, with the format being detected automatically."
6227 #: ../src/guestfs-actions.pod:234
6228 msgid "(Added in 1.0.38)"
6232 #: ../src/guestfs-actions.pod:236
6233 msgid "guestfs_add_drive_ro_with_if"
6237 #: ../src/guestfs-actions.pod:238
6241 " guestfs_add_drive_ro_with_if (guestfs_h *g,\n"
6242 " const char *filename,\n"
6243 " const char *iface);\n"
6248 #: ../src/guestfs-actions.pod:243
6250 "This is the same as C<guestfs_add_drive_ro> but it allows you to specify the "
6251 "QEMU interface emulation to use at run time."
6255 #: ../src/guestfs-actions.pod:255 ../src/guestfs-actions.pod:276
6256 #: ../src/guestfs-actions.pod:2356
6257 msgid "(Added in 1.0.84)"
6261 #: ../src/guestfs-actions.pod:257
6262 msgid "guestfs_add_drive_with_if"
6266 #: ../src/guestfs-actions.pod:259
6270 " guestfs_add_drive_with_if (guestfs_h *g,\n"
6271 " const char *filename,\n"
6272 " const char *iface);\n"
6277 #: ../src/guestfs-actions.pod:264
6279 "This is the same as C<guestfs_add_drive> but it allows you to specify the "
6280 "QEMU interface emulation to use at run time."
6284 #: ../src/guestfs-actions.pod:278
6285 msgid "guestfs_aug_clear"
6289 #: ../src/guestfs-actions.pod:280
6293 " guestfs_aug_clear (guestfs_h *g,\n"
6294 " const char *augpath);\n"
6299 #: ../src/guestfs-actions.pod:284 ../fish/guestfish-actions.pod:183
6301 "Set the value associated with C<path> to C<NULL>. This is the same as the "
6302 "L<augtool(1)> C<clear> command."
6306 #: ../src/guestfs-actions.pod:289 ../src/guestfs-actions.pod:2106
6307 msgid "(Added in 1.3.4)"
6311 #: ../src/guestfs-actions.pod:291
6312 msgid "guestfs_aug_close"
6316 #: ../src/guestfs-actions.pod:293
6320 " guestfs_aug_close (guestfs_h *g);\n"
6325 #: ../src/guestfs-actions.pod:296
6327 "Close the current Augeas handle and free up any resources used by it. After "
6328 "calling this, you have to call C<guestfs_aug_init> again before you can use "
6329 "any other Augeas functions."
6333 #: ../src/guestfs-actions.pod:303 ../src/guestfs-actions.pod:328
6334 #: ../src/guestfs-actions.pod:346 ../src/guestfs-actions.pod:360
6335 #: ../src/guestfs-actions.pod:418 ../src/guestfs-actions.pod:438
6336 #: ../src/guestfs-actions.pod:452 ../src/guestfs-actions.pod:483
6337 #: ../src/guestfs-actions.pod:497 ../src/guestfs-actions.pod:511
6338 #: ../src/guestfs-actions.pod:525 ../src/guestfs-actions.pod:543
6339 #: ../src/guestfs-actions.pod:5472
6340 msgid "(Added in 0.7)"
6344 #: ../src/guestfs-actions.pod:305
6345 msgid "guestfs_aug_defnode"
6349 #: ../src/guestfs-actions.pod:307
6352 " struct guestfs_int_bool *\n"
6353 " guestfs_aug_defnode (guestfs_h *g,\n"
6354 " const char *name,\n"
6355 " const char *expr,\n"
6356 " const char *val);\n"
6361 #: ../src/guestfs-actions.pod:313 ../fish/guestfish-actions.pod:199
6363 "Defines a variable C<name> whose value is the result of evaluating C<expr>."
6367 #: ../src/guestfs-actions.pod:316
6369 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
6370 "calling C<guestfs_aug_set> C<expr>, C<value>. C<name> will be the nodeset "
6371 "containing that single node."
6375 #: ../src/guestfs-actions.pod:320 ../fish/guestfish-actions.pod:206
6377 "On success this returns a pair containing the number of nodes in the "
6378 "nodeset, and a boolean flag if a node was created."
6382 #: ../src/guestfs-actions.pod:324
6384 "This function returns a C<struct guestfs_int_bool *>, or NULL if there was "
6385 "an error. I<The caller must call C<guestfs_free_int_bool> after use>."
6389 #: ../src/guestfs-actions.pod:330
6390 msgid "guestfs_aug_defvar"
6394 #: ../src/guestfs-actions.pod:332
6398 " guestfs_aug_defvar (guestfs_h *g,\n"
6399 " const char *name,\n"
6400 " const char *expr);\n"
6405 #: ../src/guestfs-actions.pod:337 ../fish/guestfish-actions.pod:214
6407 "Defines an Augeas variable C<name> whose value is the result of evaluating "
6408 "C<expr>. If C<expr> is NULL, then C<name> is undefined."
6412 #: ../src/guestfs-actions.pod:341 ../fish/guestfish-actions.pod:218
6414 "On success this returns the number of nodes in C<expr>, or C<0> if C<expr> "
6415 "evaluates to something which is not a nodeset."
6419 #: ../src/guestfs-actions.pod:348
6420 msgid "guestfs_aug_get"
6424 #: ../src/guestfs-actions.pod:350
6428 " guestfs_aug_get (guestfs_h *g,\n"
6429 " const char *augpath);\n"
6434 #: ../src/guestfs-actions.pod:354 ../fish/guestfish-actions.pod:225
6436 "Look up the value associated with C<path>. If C<path> matches exactly one "
6437 "node, the C<value> is returned."
6441 #: ../src/guestfs-actions.pod:357 ../src/guestfs-actions.pod:857
6442 #: ../src/guestfs-actions.pod:875 ../src/guestfs-actions.pod:935
6443 #: ../src/guestfs-actions.pod:951 ../src/guestfs-actions.pod:1054
6444 #: ../src/guestfs-actions.pod:1184 ../src/guestfs-actions.pod:1201
6445 #: ../src/guestfs-actions.pod:1220 ../src/guestfs-actions.pod:1354
6446 #: ../src/guestfs-actions.pod:1545 ../src/guestfs-actions.pod:1657
6447 #: ../src/guestfs-actions.pod:1820 ../src/guestfs-actions.pod:1837
6448 #: ../src/guestfs-actions.pod:1904 ../src/guestfs-actions.pod:1938
6449 #: ../src/guestfs-actions.pod:1959 ../src/guestfs-actions.pod:2129
6450 #: ../src/guestfs-actions.pod:2321 ../src/guestfs-actions.pod:2528
6451 #: ../src/guestfs-actions.pod:2613 ../src/guestfs-actions.pod:2724
6452 #: ../src/guestfs-actions.pod:2744 ../src/guestfs-actions.pod:2864
6453 #: ../src/guestfs-actions.pod:2895 ../src/guestfs-actions.pod:2919
6454 #: ../src/guestfs-actions.pod:2956 ../src/guestfs-actions.pod:3016
6455 #: ../src/guestfs-actions.pod:3039 ../src/guestfs-actions.pod:3060
6456 #: ../src/guestfs-actions.pod:3632 ../src/guestfs-actions.pod:3982
6457 #: ../src/guestfs-actions.pod:4152 ../src/guestfs-actions.pod:4262
6458 #: ../src/guestfs-actions.pod:5007 ../src/guestfs-actions.pod:5200
6459 #: ../src/guestfs-actions.pod:5370 ../src/guestfs-actions.pod:5548
6460 #: ../src/guestfs-actions.pod:5597 ../src/guestfs-actions.pod:6209
6461 #: ../src/guestfs-actions.pod:6225 ../src/guestfs-actions.pod:6242
6462 #: ../src/guestfs-actions.pod:6266 ../src/guestfs-actions.pod:6940
6463 #: ../src/guestfs-actions.pod:6959 ../src/guestfs-actions.pod:6977
6464 #: ../src/guestfs-actions.pod:7157 ../src/guestfs-actions.pod:7429
6466 "This function returns a string, or NULL on error. I<The caller must free "
6467 "the returned string after use>."
6471 #: ../src/guestfs-actions.pod:362
6472 msgid "guestfs_aug_init"
6476 #: ../src/guestfs-actions.pod:364
6480 " guestfs_aug_init (guestfs_h *g,\n"
6481 " const char *root,\n"
6487 #: ../src/guestfs-actions.pod:369 ../fish/guestfish-actions.pod:232
6489 "Create a new Augeas handle for editing configuration files. If there was "
6490 "any previous Augeas handle associated with this guestfs session, then it is "
6495 #: ../src/guestfs-actions.pod:373
6496 msgid "You must call this before using any other C<guestfs_aug_*> commands."
6500 #: ../src/guestfs-actions.pod:376 ../fish/guestfish-actions.pod:239
6502 "C<root> is the filesystem root. C<root> must not be NULL, use C</> instead."
6506 #: ../src/guestfs-actions.pod:379 ../fish/guestfish-actions.pod:242
6508 "The flags are the same as the flags defined in E<lt>augeas.hE<gt>, the "
6509 "logical I<or> of the following integers:"
6513 #: ../src/guestfs-actions.pod:385 ../fish/guestfish-actions.pod:248
6514 msgid "C<AUG_SAVE_BACKUP> = 1"
6515 msgstr "C<AUG_SAVE_BACKUP> = 1"
6518 #: ../src/guestfs-actions.pod:387 ../fish/guestfish-actions.pod:250
6519 msgid "Keep the original file with a C<.augsave> extension."
6523 #: ../src/guestfs-actions.pod:389 ../fish/guestfish-actions.pod:252
6524 msgid "C<AUG_SAVE_NEWFILE> = 2"
6525 msgstr "C<AUG_SAVE_NEWFILE> = 2"
6528 #: ../src/guestfs-actions.pod:391 ../fish/guestfish-actions.pod:254
6530 "Save changes into a file with extension C<.augnew>, and do not overwrite "
6531 "original. Overrides C<AUG_SAVE_BACKUP>."
6535 #: ../src/guestfs-actions.pod:394 ../fish/guestfish-actions.pod:257
6536 msgid "C<AUG_TYPE_CHECK> = 4"
6537 msgstr "C<AUG_TYPE_CHECK> = 4"
6540 #: ../src/guestfs-actions.pod:396 ../fish/guestfish-actions.pod:259
6541 msgid "Typecheck lenses (can be expensive)."
6545 #: ../src/guestfs-actions.pod:398 ../fish/guestfish-actions.pod:261
6546 msgid "C<AUG_NO_STDINC> = 8"
6547 msgstr "C<AUG_NO_STDINC> = 8"
6550 #: ../src/guestfs-actions.pod:400 ../fish/guestfish-actions.pod:263
6551 msgid "Do not use standard load path for modules."
6555 #: ../src/guestfs-actions.pod:402 ../fish/guestfish-actions.pod:265
6556 msgid "C<AUG_SAVE_NOOP> = 16"
6557 msgstr "C<AUG_SAVE_NOOP> = 16"
6560 #: ../src/guestfs-actions.pod:404 ../fish/guestfish-actions.pod:267
6561 msgid "Make save a no-op, just record what would have been changed."
6565 #: ../src/guestfs-actions.pod:406 ../fish/guestfish-actions.pod:269
6566 msgid "C<AUG_NO_LOAD> = 32"
6567 msgstr "C<AUG_NO_LOAD> = 32"
6570 #: ../src/guestfs-actions.pod:408
6571 msgid "Do not load the tree in C<guestfs_aug_init>."
6575 #: ../src/guestfs-actions.pod:412
6576 msgid "To close the handle, you can call C<guestfs_aug_close>."
6580 #: ../src/guestfs-actions.pod:414 ../fish/guestfish-actions.pod:277
6581 msgid "To find out more about Augeas, see L<http://augeas.net/>."
6585 #: ../src/guestfs-actions.pod:420
6586 msgid "guestfs_aug_insert"
6590 #: ../src/guestfs-actions.pod:422
6594 " guestfs_aug_insert (guestfs_h *g,\n"
6595 " const char *augpath,\n"
6596 " const char *label,\n"
6602 #: ../src/guestfs-actions.pod:428 ../fish/guestfish-actions.pod:283
6604 "Create a new sibling C<label> for C<path>, inserting it into the tree before "
6605 "or after C<path> (depending on the boolean flag C<before>)."
6609 #: ../src/guestfs-actions.pod:432 ../fish/guestfish-actions.pod:287
6611 "C<path> must match exactly one existing node in the tree, and C<label> must "
6612 "be a label, ie. not contain C</>, C<*> or end with a bracketed index C<[N]>."
6616 #: ../src/guestfs-actions.pod:440
6617 msgid "guestfs_aug_load"
6621 #: ../src/guestfs-actions.pod:442
6625 " guestfs_aug_load (guestfs_h *g);\n"
6630 #: ../src/guestfs-actions.pod:445 ../fish/guestfish-actions.pod:295
6631 msgid "Load files into the tree."
6632 msgstr "Завантажити файли до ієрархії."
6635 #: ../src/guestfs-actions.pod:447 ../fish/guestfish-actions.pod:297
6636 msgid "See C<aug_load> in the Augeas documentation for the full gory details."
6640 #: ../src/guestfs-actions.pod:454
6641 msgid "guestfs_aug_ls"
6645 #: ../src/guestfs-actions.pod:456
6649 " guestfs_aug_ls (guestfs_h *g,\n"
6650 " const char *augpath);\n"
6655 #: ../src/guestfs-actions.pod:460
6657 "This is just a shortcut for listing C<guestfs_aug_match> C<path/*> and "
6658 "sorting the resulting nodes into alphabetical order."
6662 #: ../src/guestfs-actions.pod:463 ../src/guestfs-actions.pod:479
6663 #: ../src/guestfs-actions.pod:625 ../src/guestfs-actions.pod:1073
6664 #: ../src/guestfs-actions.pod:1369 ../src/guestfs-actions.pod:1388
6665 #: ../src/guestfs-actions.pod:1491 ../src/guestfs-actions.pod:1510
6666 #: ../src/guestfs-actions.pod:1759 ../src/guestfs-actions.pod:2201
6667 #: ../src/guestfs-actions.pod:2217 ../src/guestfs-actions.pod:2236
6668 #: ../src/guestfs-actions.pod:2279 ../src/guestfs-actions.pod:2303
6669 #: ../src/guestfs-actions.pod:2374 ../src/guestfs-actions.pod:2423
6670 #: ../src/guestfs-actions.pod:2682 ../src/guestfs-actions.pod:2973
6671 #: ../src/guestfs-actions.pod:3262 ../src/guestfs-actions.pod:3552
6672 #: ../src/guestfs-actions.pod:3614 ../src/guestfs-actions.pod:3719
6673 #: ../src/guestfs-actions.pod:4124 ../src/guestfs-actions.pod:4822
6674 #: ../src/guestfs-actions.pod:5342 ../src/guestfs-actions.pod:5468
6675 #: ../src/guestfs-actions.pod:5582 ../src/guestfs-actions.pod:6282
6676 #: ../src/guestfs-actions.pod:6343 ../src/guestfs-actions.pod:6398
6677 #: ../src/guestfs-actions.pod:6544 ../src/guestfs-actions.pod:6568
6678 #: ../src/guestfs-actions.pod:7050 ../src/guestfs-actions.pod:7070
6679 #: ../src/guestfs-actions.pod:7117 ../src/guestfs-actions.pod:7282
6680 #: ../src/guestfs-actions.pod:7301 ../src/guestfs-actions.pod:7386
6681 #: ../src/guestfs-actions.pod:7405 ../src/guestfs-actions.pod:7451
6682 #: ../src/guestfs-actions.pod:7470
6684 "This function returns a NULL-terminated array of strings (like L<environ(3)"
6685 ">), or NULL if there was an error. I<The caller must free the strings and "
6686 "the array after use>."
6690 #: ../src/guestfs-actions.pod:467 ../src/guestfs-actions.pod:998
6691 #: ../src/guestfs-actions.pod:1016 ../src/guestfs-actions.pod:1426
6692 #: ../src/guestfs-actions.pod:3340 ../src/guestfs-actions.pod:3371
6693 #: ../src/guestfs-actions.pod:3965 ../src/guestfs-actions.pod:4015
6694 #: ../src/guestfs-actions.pod:4202 ../src/guestfs-actions.pod:4235
6695 #: ../src/guestfs-actions.pod:4398 ../src/guestfs-actions.pod:4826
6696 #: ../src/guestfs-actions.pod:5283 ../src/guestfs-actions.pod:5678
6697 #: ../src/guestfs-actions.pod:5692 ../src/guestfs-actions.pod:5704
6698 #: ../src/guestfs-actions.pod:6144 ../src/guestfs-actions.pod:6782
6699 #: ../src/guestfs-actions.pod:6795 ../src/guestfs-actions.pod:7034
6700 #: ../src/guestfs-actions.pod:7270
6701 msgid "(Added in 0.8)"
6705 #: ../src/guestfs-actions.pod:469
6706 msgid "guestfs_aug_match"
6710 #: ../src/guestfs-actions.pod:471
6714 " guestfs_aug_match (guestfs_h *g,\n"
6715 " const char *augpath);\n"
6720 #: ../src/guestfs-actions.pod:475 ../fish/guestfish-actions.pod:311
6722 "Returns a list of paths which match the path expression C<path>. The "
6723 "returned paths are sufficiently qualified so that they match exactly one "
6724 "node in the current tree."
6728 #: ../src/guestfs-actions.pod:485
6729 msgid "guestfs_aug_mv"
6733 #: ../src/guestfs-actions.pod:487
6737 " guestfs_aug_mv (guestfs_h *g,\n"
6738 " const char *src,\n"
6739 " const char *dest);\n"
6744 #: ../src/guestfs-actions.pod:492 ../fish/guestfish-actions.pod:319
6746 "Move the node C<src> to C<dest>. C<src> must match exactly one node. "
6747 "C<dest> is overwritten if it exists."
6751 #: ../src/guestfs-actions.pod:499
6752 msgid "guestfs_aug_rm"
6756 #: ../src/guestfs-actions.pod:501
6760 " guestfs_aug_rm (guestfs_h *g,\n"
6761 " const char *augpath);\n"
6766 #: ../src/guestfs-actions.pod:505 ../fish/guestfish-actions.pod:326
6767 msgid "Remove C<path> and all of its children."
6771 #: ../src/guestfs-actions.pod:507 ../fish/guestfish-actions.pod:328
6772 msgid "On success this returns the number of entries which were removed."
6776 #: ../src/guestfs-actions.pod:513
6777 msgid "guestfs_aug_save"
6781 #: ../src/guestfs-actions.pod:515
6785 " guestfs_aug_save (guestfs_h *g);\n"
6790 #: ../src/guestfs-actions.pod:518 ../fish/guestfish-actions.pod:334
6791 msgid "This writes all pending changes to disk."
6795 #: ../src/guestfs-actions.pod:520
6797 "The flags which were passed to C<guestfs_aug_init> affect exactly how files "
6802 #: ../src/guestfs-actions.pod:527
6803 msgid "guestfs_aug_set"
6807 #: ../src/guestfs-actions.pod:529
6811 " guestfs_aug_set (guestfs_h *g,\n"
6812 " const char *augpath,\n"
6813 " const char *val);\n"
6818 #: ../src/guestfs-actions.pod:534 ../fish/guestfish-actions.pod:343
6819 msgid "Set the value associated with C<path> to C<val>."
6823 #: ../src/guestfs-actions.pod:536
6825 "In the Augeas API, it is possible to clear a node by setting the value to "
6826 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
6827 "this call. Instead you must use the C<guestfs_aug_clear> call."
6831 #: ../src/guestfs-actions.pod:545
6832 msgid "guestfs_available"
6836 #: ../src/guestfs-actions.pod:547
6840 " guestfs_available (guestfs_h *g,\n"
6841 " char *const *groups);\n"
6846 #: ../src/guestfs-actions.pod:551 ../fish/guestfish-actions.pod:354
6848 "This command is used to check the availability of some groups of "
6849 "functionality in the appliance, which not all builds of the libguestfs "
6850 "appliance will be able to provide."
6854 #: ../src/guestfs-actions.pod:555
6856 "The libguestfs groups, and the functions that those groups correspond to, "
6857 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
6858 "runtime by calling C<guestfs_available_all_groups>."
6862 #: ../src/guestfs-actions.pod:560 ../fish/guestfish-actions.pod:363
6864 "The argument C<groups> is a list of group names, eg: C<[\"inotify\", \"augeas"
6865 "\"]> would check for the availability of the Linux inotify functions and "
6866 "Augeas (configuration file editing) functions."
6870 #: ../src/guestfs-actions.pod:565 ../fish/guestfish-actions.pod:368
6871 msgid "The command returns no error if I<all> requested groups are available."
6875 #: ../src/guestfs-actions.pod:567 ../fish/guestfish-actions.pod:370
6877 "It fails with an error if one or more of the requested groups is unavailable "
6882 #: ../src/guestfs-actions.pod:570 ../fish/guestfish-actions.pod:373
6884 "If an unknown group name is included in the list of groups then an error is "
6889 #: ../src/guestfs-actions.pod:573 ../fish/guestfish-actions.pod:376
6891 msgstr "I<Нотатки:>"
6894 #: ../src/guestfs-actions.pod:579
6895 msgid "You must call C<guestfs_launch> before calling this function."
6899 #: ../src/guestfs-actions.pod:581 ../fish/guestfish-actions.pod:384
6901 "The reason is because we don't know what groups are supported by the "
6902 "appliance/daemon until it is running and can be queried."
6906 #: ../src/guestfs-actions.pod:587 ../fish/guestfish-actions.pod:390
6908 "If a group of functions is available, this does not necessarily mean that "
6909 "they will work. You still have to check for errors when calling individual "
6910 "API functions even if they are available."
6914 #: ../src/guestfs-actions.pod:594 ../fish/guestfish-actions.pod:397
6916 "It is usually the job of distro packagers to build complete functionality "
6917 "into the libguestfs appliance. Upstream libguestfs, if built from source "
6918 "with all requirements satisfied, will support everything."
6922 #: ../src/guestfs-actions.pod:601
6924 "This call was added in version C<1.0.80>. In previous versions of "
6925 "libguestfs all you could do would be to speculatively execute a command to "
6926 "find out if the daemon implemented it. See also C<guestfs_version>."
6930 #: ../src/guestfs-actions.pod:610 ../src/guestfs-actions.pod:1171
6931 msgid "(Added in 1.0.80)"
6935 #: ../src/guestfs-actions.pod:612
6936 msgid "guestfs_available_all_groups"
6940 #: ../src/guestfs-actions.pod:614
6944 " guestfs_available_all_groups (guestfs_h *g);\n"
6949 #: ../src/guestfs-actions.pod:617
6951 "This command returns a list of all optional groups that this daemon knows "
6952 "about. Note this returns both supported and unsupported groups. To find "
6953 "out which ones the daemon can actually support you have to call "
6954 "C<guestfs_available> on each member of the returned list."
6958 #: ../src/guestfs-actions.pod:623
6959 msgid "See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>."
6963 #: ../src/guestfs-actions.pod:629
6964 msgid "(Added in 1.3.15)"
6968 #: ../src/guestfs-actions.pod:631
6969 msgid "guestfs_base64_in"
6973 #: ../src/guestfs-actions.pod:633
6977 " guestfs_base64_in (guestfs_h *g,\n"
6978 " const char *base64file,\n"
6979 " const char *filename);\n"
6984 #: ../src/guestfs-actions.pod:638 ../fish/guestfish-actions.pod:427
6986 "This command uploads base64-encoded data from C<base64file> to C<filename>."
6990 #: ../src/guestfs-actions.pod:643 ../src/guestfs-actions.pod:657
6991 msgid "(Added in 1.3.5)"
6995 #: ../src/guestfs-actions.pod:645
6996 msgid "guestfs_base64_out"
7000 #: ../src/guestfs-actions.pod:647
7004 " guestfs_base64_out (guestfs_h *g,\n"
7005 " const char *filename,\n"
7006 " const char *base64file);\n"
7011 #: ../src/guestfs-actions.pod:652 ../fish/guestfish-actions.pod:436
7013 "This command downloads the contents of C<filename>, writing it out to local "
7014 "file C<base64file> encoded as base64."
7018 #: ../src/guestfs-actions.pod:659
7019 msgid "guestfs_blockdev_flushbufs"
7023 #: ../src/guestfs-actions.pod:661
7027 " guestfs_blockdev_flushbufs (guestfs_h *g,\n"
7028 " const char *device);\n"
7033 #: ../src/guestfs-actions.pod:665 ../fish/guestfish-actions.pod:445
7035 "This tells the kernel to flush internal buffers associated with C<device>."
7039 #: ../src/guestfs-actions.pod:668 ../src/guestfs-actions.pod:685
7040 #: ../src/guestfs-actions.pod:700 ../src/guestfs-actions.pod:716
7041 #: ../src/guestfs-actions.pod:734 ../src/guestfs-actions.pod:753
7042 #: ../src/guestfs-actions.pod:767 ../src/guestfs-actions.pod:785
7043 #: ../src/guestfs-actions.pod:799 ../src/guestfs-actions.pod:813
7044 #: ../fish/guestfish-actions.pod:448 ../fish/guestfish-actions.pod:459
7045 #: ../fish/guestfish-actions.pod:468 ../fish/guestfish-actions.pod:478
7046 #: ../fish/guestfish-actions.pod:490 ../fish/guestfish-actions.pod:503
7047 #: ../fish/guestfish-actions.pod:511 ../fish/guestfish-actions.pod:522
7048 #: ../fish/guestfish-actions.pod:530 ../fish/guestfish-actions.pod:538
7049 msgid "This uses the L<blockdev(8)> command."
7053 #: ../src/guestfs-actions.pod:672 ../src/guestfs-actions.pod:689
7054 #: ../src/guestfs-actions.pod:704 ../src/guestfs-actions.pod:720
7055 #: ../src/guestfs-actions.pod:738 ../src/guestfs-actions.pod:757
7056 #: ../src/guestfs-actions.pod:771 ../src/guestfs-actions.pod:789
7057 #: ../src/guestfs-actions.pod:803 ../src/guestfs-actions.pod:817
7058 msgid "(Added in 0.9.3)"
7062 #: ../src/guestfs-actions.pod:674
7063 msgid "guestfs_blockdev_getbsz"
7067 #: ../src/guestfs-actions.pod:676
7071 " guestfs_blockdev_getbsz (guestfs_h *g,\n"
7072 " const char *device);\n"
7077 #: ../src/guestfs-actions.pod:680 ../fish/guestfish-actions.pod:454
7078 msgid "This returns the block size of a device."
7082 #: ../src/guestfs-actions.pod:682 ../src/guestfs-actions.pod:782
7083 #: ../fish/guestfish-actions.pod:456 ../fish/guestfish-actions.pod:519
7085 "(Note this is different from both I<size in blocks> and I<filesystem block "
7090 #: ../src/guestfs-actions.pod:691
7091 msgid "guestfs_blockdev_getro"
7095 #: ../src/guestfs-actions.pod:693
7099 " guestfs_blockdev_getro (guestfs_h *g,\n"
7100 " const char *device);\n"
7105 #: ../src/guestfs-actions.pod:697 ../fish/guestfish-actions.pod:465
7107 "Returns a boolean indicating if the block device is read-only (true if read-"
7108 "only, false if not)."
7112 #: ../src/guestfs-actions.pod:702 ../src/guestfs-actions.pod:1409
7113 #: ../src/guestfs-actions.pod:1424 ../src/guestfs-actions.pod:1914
7114 #: ../src/guestfs-actions.pod:1925 ../src/guestfs-actions.pod:1997
7115 #: ../src/guestfs-actions.pod:2052 ../src/guestfs-actions.pod:2067
7116 #: ../src/guestfs-actions.pod:2092 ../src/guestfs-actions.pod:2115
7117 #: ../src/guestfs-actions.pod:3080 ../src/guestfs-actions.pod:3097
7118 #: ../src/guestfs-actions.pod:3116 ../src/guestfs-actions.pod:3279
7119 #: ../src/guestfs-actions.pod:3293 ../src/guestfs-actions.pod:3308
7120 #: ../src/guestfs-actions.pod:3322 ../src/guestfs-actions.pod:3338
7121 #: ../src/guestfs-actions.pod:3353 ../src/guestfs-actions.pod:3369
7122 #: ../src/guestfs-actions.pod:3383 ../src/guestfs-actions.pod:3396
7123 #: ../src/guestfs-actions.pod:3410 ../src/guestfs-actions.pod:3425
7124 #: ../src/guestfs-actions.pod:3440 ../src/guestfs-actions.pod:4971
7125 msgid "This function returns a C truth value on success or -1 on error."
7129 #: ../src/guestfs-actions.pod:706
7130 msgid "guestfs_blockdev_getsize64"
7134 #: ../src/guestfs-actions.pod:708
7138 " guestfs_blockdev_getsize64 (guestfs_h *g,\n"
7139 " const char *device);\n"
7144 #: ../src/guestfs-actions.pod:712 ../fish/guestfish-actions.pod:474
7145 msgid "This returns the size of the device in bytes."
7149 #: ../src/guestfs-actions.pod:714
7150 msgid "See also C<guestfs_blockdev_getsz>."
7154 #: ../src/guestfs-actions.pod:722
7155 msgid "guestfs_blockdev_getss"
7159 #: ../src/guestfs-actions.pod:724
7163 " guestfs_blockdev_getss (guestfs_h *g,\n"
7164 " const char *device);\n"
7169 #: ../src/guestfs-actions.pod:728 ../fish/guestfish-actions.pod:484
7171 "This returns the size of sectors on a block device. Usually 512, but can be "
7172 "larger for modern devices."
7176 #: ../src/guestfs-actions.pod:731
7178 "(Note, this is not the size in sectors, use C<guestfs_blockdev_getsz> for "
7183 #: ../src/guestfs-actions.pod:740
7184 msgid "guestfs_blockdev_getsz"
7188 #: ../src/guestfs-actions.pod:742
7192 " guestfs_blockdev_getsz (guestfs_h *g,\n"
7193 " const char *device);\n"
7198 #: ../src/guestfs-actions.pod:746 ../fish/guestfish-actions.pod:496
7200 "This returns the size of the device in units of 512-byte sectors (even if "
7201 "the sectorsize isn't 512 bytes ... weird)."
7205 #: ../src/guestfs-actions.pod:749
7207 "See also C<guestfs_blockdev_getss> for the real sector size of the device, "
7208 "and C<guestfs_blockdev_getsize64> for the more useful I<size in bytes>."
7212 #: ../src/guestfs-actions.pod:759
7213 msgid "guestfs_blockdev_rereadpt"
7217 #: ../src/guestfs-actions.pod:761
7221 " guestfs_blockdev_rereadpt (guestfs_h *g,\n"
7222 " const char *device);\n"
7227 #: ../src/guestfs-actions.pod:765 ../fish/guestfish-actions.pod:509
7228 msgid "Reread the partition table on C<device>."
7232 #: ../src/guestfs-actions.pod:773
7233 msgid "guestfs_blockdev_setbsz"
7237 #: ../src/guestfs-actions.pod:775
7241 " guestfs_blockdev_setbsz (guestfs_h *g,\n"
7242 " const char *device,\n"
7243 " int blocksize);\n"
7248 #: ../src/guestfs-actions.pod:780 ../fish/guestfish-actions.pod:517
7249 msgid "This sets the block size of a device."
7253 #: ../src/guestfs-actions.pod:791
7254 msgid "guestfs_blockdev_setro"
7258 #: ../src/guestfs-actions.pod:793
7262 " guestfs_blockdev_setro (guestfs_h *g,\n"
7263 " const char *device);\n"
7268 #: ../src/guestfs-actions.pod:797 ../fish/guestfish-actions.pod:528
7269 msgid "Sets the block device named C<device> to read-only."
7273 #: ../src/guestfs-actions.pod:805
7274 msgid "guestfs_blockdev_setrw"
7278 #: ../src/guestfs-actions.pod:807
7282 " guestfs_blockdev_setrw (guestfs_h *g,\n"
7283 " const char *device);\n"
7288 #: ../src/guestfs-actions.pod:811 ../fish/guestfish-actions.pod:536
7289 msgid "Sets the block device named C<device> to read-write."
7293 #: ../src/guestfs-actions.pod:819
7294 msgid "guestfs_case_sensitive_path"
7298 #: ../src/guestfs-actions.pod:821
7302 " guestfs_case_sensitive_path (guestfs_h *g,\n"
7303 " const char *path);\n"
7308 #: ../src/guestfs-actions.pod:825 ../fish/guestfish-actions.pod:544
7310 "This can be used to resolve case insensitive paths on a filesystem which is "
7311 "case sensitive. The use case is to resolve paths which you have read from "
7312 "Windows configuration files or the Windows Registry, to the true path."
7316 #: ../src/guestfs-actions.pod:830 ../fish/guestfish-actions.pod:549
7318 "The command handles a peculiarity of the Linux ntfs-3g filesystem driver "
7319 "(and probably others), which is that although the underlying filesystem is "
7320 "case-insensitive, the driver exports the filesystem to Linux as case-"
7325 #: ../src/guestfs-actions.pod:835 ../fish/guestfish-actions.pod:554
7327 "One consequence of this is that special directories such as C<c:\\windows> "
7328 "may appear as C</WINDOWS> or C</windows> (or other things) depending on the "
7329 "precise details of how they were created. In Windows itself this would not "
7334 #: ../src/guestfs-actions.pod:841 ../fish/guestfish-actions.pod:560
7336 "Bug or feature? You decide: L<http://www.tuxera.com/community/ntfs-3g-faq/"
7341 #: ../src/guestfs-actions.pod:844 ../fish/guestfish-actions.pod:563
7343 "This function resolves the true case of each element in the path and returns "
7344 "the case-sensitive path."
7348 #: ../src/guestfs-actions.pod:847
7350 "Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\") might return C<"
7351 "\"/WINDOWS/system32\"> (the exact return value would depend on details of "
7352 "how the directories were originally created under Windows)."
7356 #: ../src/guestfs-actions.pod:852 ../fish/guestfish-actions.pod:571
7357 msgid "I<Note>: This function does not handle drive names, backslashes etc."
7361 #: ../src/guestfs-actions.pod:855
7362 msgid "See also C<guestfs_realpath>."
7366 #: ../src/guestfs-actions.pod:860 ../src/guestfs-actions.pod:6962
7367 msgid "(Added in 1.0.75)"
7371 #: ../src/guestfs-actions.pod:862
7376 #: ../src/guestfs-actions.pod:864
7380 " guestfs_cat (guestfs_h *g,\n"
7381 " const char *path);\n"
7386 #: ../src/guestfs-actions.pod:868 ../src/guestfs-actions.pod:5458
7387 #: ../fish/guestfish-actions.pod:580 ../fish/guestfish-actions.pod:3659
7388 msgid "Return the contents of the file named C<path>."
7392 #: ../src/guestfs-actions.pod:870
7394 "Note that this function cannot correctly handle binary files (specifically, "
7395 "files containing C<\\0> character which is treated as end of string). For "
7396 "those you need to use the C<guestfs_read_file> or C<guestfs_download> "
7397 "functions which have a more complex interface."
7401 #: ../src/guestfs-actions.pod:878 ../src/guestfs-actions.pod:1057
7402 #: ../src/guestfs-actions.pod:1077 ../src/guestfs-actions.pod:1373
7403 #: ../src/guestfs-actions.pod:1392 ../src/guestfs-actions.pod:1495
7404 #: ../src/guestfs-actions.pod:1514 ../src/guestfs-actions.pod:1763
7405 #: ../src/guestfs-actions.pod:2221 ../src/guestfs-actions.pod:2240
7406 #: ../src/guestfs-actions.pod:2283 ../src/guestfs-actions.pod:2307
7407 #: ../src/guestfs-actions.pod:2324 ../src/guestfs-actions.pod:2353
7408 #: ../src/guestfs-actions.pod:5240 ../src/guestfs-actions.pod:5266
7409 #: ../src/guestfs-actions.pod:5397 ../src/guestfs-actions.pod:5423
7410 #: ../src/guestfs-actions.pod:5447 ../src/guestfs-actions.pod:6347
7411 #: ../src/guestfs-actions.pod:6402 ../src/guestfs-actions.pod:6548
7412 #: ../src/guestfs-actions.pod:6572 ../src/guestfs-actions.pod:7234
7413 #: ../src/guestfs-actions.pod:7260 ../src/guestfs-actions.pod:7286
7414 #: ../src/guestfs-actions.pod:7305 ../src/guestfs-actions.pod:7390
7415 #: ../src/guestfs-actions.pod:7409 ../src/guestfs-actions.pod:7455
7416 #: ../src/guestfs-actions.pod:7474 ../fish/guestfish-actions.pod:587
7417 #: ../fish/guestfish-actions.pod:722 ../fish/guestfish-actions.pod:734
7418 #: ../fish/guestfish-actions.pod:910 ../fish/guestfish-actions.pod:920
7419 #: ../fish/guestfish-actions.pod:987 ../fish/guestfish-actions.pod:997
7420 #: ../fish/guestfish-actions.pod:1192 ../fish/guestfish-actions.pod:1493
7421 #: ../fish/guestfish-actions.pod:1503 ../fish/guestfish-actions.pod:1531
7422 #: ../fish/guestfish-actions.pod:1546 ../fish/guestfish-actions.pod:1556
7423 #: ../fish/guestfish-actions.pod:1575 ../fish/guestfish-actions.pod:3529
7424 #: ../fish/guestfish-actions.pod:3544 ../fish/guestfish-actions.pod:3620
7425 #: ../fish/guestfish-actions.pod:3637 ../fish/guestfish-actions.pod:3652
7426 #: ../fish/guestfish-actions.pod:4278 ../fish/guestfish-actions.pod:4324
7427 #: ../fish/guestfish-actions.pod:4409 ../fish/guestfish-actions.pod:4424
7428 #: ../fish/guestfish-actions.pod:4834 ../fish/guestfish-actions.pod:4852
7429 #: ../fish/guestfish-actions.pod:4869 ../fish/guestfish-actions.pod:4879
7430 #: ../fish/guestfish-actions.pod:4927 ../fish/guestfish-actions.pod:4937
7431 #: ../fish/guestfish-actions.pod:4966 ../fish/guestfish-actions.pod:4976
7433 "Because of the message protocol, there is a transfer limit of somewhere "
7434 "between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
7438 #: ../src/guestfs-actions.pod:881 ../src/guestfs-actions.pod:3556
7439 #: ../src/guestfs-actions.pod:3618 ../src/guestfs-actions.pod:3635
7440 #: ../src/guestfs-actions.pod:3723 ../src/guestfs-actions.pod:4128
7441 #: ../src/guestfs-actions.pod:4142 ../src/guestfs-actions.pod:5346
7442 #: ../src/guestfs-actions.pod:5360 ../src/guestfs-actions.pod:7121
7443 #: ../src/guestfs-actions.pod:7135
7444 msgid "(Added in 0.4)"
7448 #: ../src/guestfs-actions.pod:883
7449 msgid "guestfs_checksum"
7453 #: ../src/guestfs-actions.pod:885
7457 " guestfs_checksum (guestfs_h *g,\n"
7458 " const char *csumtype,\n"
7459 " const char *path);\n"
7464 #: ../src/guestfs-actions.pod:890 ../fish/guestfish-actions.pod:594
7466 "This call computes the MD5, SHAx or CRC checksum of the file named C<path>."
7470 #: ../src/guestfs-actions.pod:893 ../fish/guestfish-actions.pod:597
7472 "The type of checksum to compute is given by the C<csumtype> parameter which "
7473 "must have one of the following values:"
7477 #: ../src/guestfs-actions.pod:898 ../fish/guestfish-actions.pod:602
7482 #: ../src/guestfs-actions.pod:900 ../fish/guestfish-actions.pod:604
7484 "Compute the cyclic redundancy check (CRC) specified by POSIX for the "
7489 #: ../src/guestfs-actions.pod:903 ../fish/guestfish-actions.pod:607
7494 #: ../src/guestfs-actions.pod:905 ../fish/guestfish-actions.pod:609
7495 msgid "Compute the MD5 hash (using the C<md5sum> program)."
7499 #: ../src/guestfs-actions.pod:907 ../fish/guestfish-actions.pod:611
7504 #: ../src/guestfs-actions.pod:909 ../fish/guestfish-actions.pod:613
7505 msgid "Compute the SHA1 hash (using the C<sha1sum> program)."
7509 #: ../src/guestfs-actions.pod:911 ../fish/guestfish-actions.pod:615
7514 #: ../src/guestfs-actions.pod:913 ../fish/guestfish-actions.pod:617
7515 msgid "Compute the SHA224 hash (using the C<sha224sum> program)."
7519 #: ../src/guestfs-actions.pod:915 ../fish/guestfish-actions.pod:619
7524 #: ../src/guestfs-actions.pod:917 ../fish/guestfish-actions.pod:621
7525 msgid "Compute the SHA256 hash (using the C<sha256sum> program)."
7529 #: ../src/guestfs-actions.pod:919 ../fish/guestfish-actions.pod:623
7534 #: ../src/guestfs-actions.pod:921 ../fish/guestfish-actions.pod:625
7535 msgid "Compute the SHA384 hash (using the C<sha384sum> program)."
7539 #: ../src/guestfs-actions.pod:923 ../fish/guestfish-actions.pod:627
7544 #: ../src/guestfs-actions.pod:925 ../fish/guestfish-actions.pod:629
7545 msgid "Compute the SHA512 hash (using the C<sha512sum> program)."
7549 #: ../src/guestfs-actions.pod:929 ../fish/guestfish-actions.pod:633
7550 msgid "The checksum is returned as a printable string."
7554 #: ../src/guestfs-actions.pod:931
7555 msgid "To get the checksum for a device, use C<guestfs_checksum_device>."
7559 #: ../src/guestfs-actions.pod:933
7560 msgid "To get the checksums for many files, use C<guestfs_checksums_out>."
7564 #: ../src/guestfs-actions.pod:938 ../src/guestfs-actions.pod:1246
7565 #: ../src/guestfs-actions.pod:2083 ../src/guestfs-actions.pod:3295
7566 #: ../src/guestfs-actions.pod:3324 ../src/guestfs-actions.pod:3385
7567 #: ../src/guestfs-actions.pod:3412 ../src/guestfs-actions.pod:6818
7568 msgid "(Added in 1.0.2)"
7572 #: ../src/guestfs-actions.pod:940
7573 msgid "guestfs_checksum_device"
7577 #: ../src/guestfs-actions.pod:942
7581 " guestfs_checksum_device (guestfs_h *g,\n"
7582 " const char *csumtype,\n"
7583 " const char *device);\n"
7588 #: ../src/guestfs-actions.pod:947
7590 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
7591 "device named C<device>. For the types of checksums supported see the "
7592 "C<guestfs_checksum> command."
7596 #: ../src/guestfs-actions.pod:954 ../src/guestfs-actions.pod:4877
7597 #: ../src/guestfs-actions.pod:4936 ../src/guestfs-actions.pod:4973
7598 #: ../src/guestfs-actions.pod:4991 ../src/guestfs-actions.pod:5167
7599 #: ../src/guestfs-actions.pod:6727 ../src/guestfs-actions.pod:6741
7600 #: ../src/guestfs-actions.pod:7147
7601 msgid "(Added in 1.3.2)"
7605 #: ../src/guestfs-actions.pod:956
7606 msgid "guestfs_checksums_out"
7610 #: ../src/guestfs-actions.pod:958
7614 " guestfs_checksums_out (guestfs_h *g,\n"
7615 " const char *csumtype,\n"
7616 " const char *directory,\n"
7617 " const char *sumsfile);\n"
7622 #: ../src/guestfs-actions.pod:964 ../fish/guestfish-actions.pod:651
7624 "This command computes the checksums of all regular files in C<directory> and "
7625 "then emits a list of those checksums to the local output file C<sumsfile>."
7629 #: ../src/guestfs-actions.pod:968 ../fish/guestfish-actions.pod:655
7631 "This can be used for verifying the integrity of a virtual machine. However "
7632 "to be properly secure you should pay attention to the output of the checksum "
7633 "command (it uses the ones from GNU coreutils). In particular when the "
7634 "filename is not printable, coreutils uses a special backslash syntax. For "
7635 "more information, see the GNU coreutils info file."
7639 #: ../src/guestfs-actions.pod:978
7640 msgid "(Added in 1.3.7)"
7644 #: ../src/guestfs-actions.pod:980
7645 msgid "guestfs_chmod"
7649 #: ../src/guestfs-actions.pod:982
7653 " guestfs_chmod (guestfs_h *g,\n"
7655 " const char *path);\n"
7660 #: ../src/guestfs-actions.pod:987 ../fish/guestfish-actions.pod:669
7662 "Change the mode (permissions) of C<path> to C<mode>. Only numeric modes are "
7667 #: ../src/guestfs-actions.pod:990 ../fish/guestfish-actions.pod:672
7669 "I<Note>: When using this command from guestfish, C<mode> by default would be "
7670 "decimal, unless you prefix it with C<0> to get octal, ie. use C<0700> not "
7675 #: ../src/guestfs-actions.pod:994 ../src/guestfs-actions.pod:4379
7676 #: ../src/guestfs-actions.pod:4576 ../src/guestfs-actions.pod:4595
7677 #: ../src/guestfs-actions.pod:4614 ../fish/guestfish-actions.pod:676
7678 #: ../fish/guestfish-actions.pod:2975 ../fish/guestfish-actions.pod:3104
7679 #: ../fish/guestfish-actions.pod:3114 ../fish/guestfish-actions.pod:3124
7680 msgid "The mode actually set is affected by the umask."
7684 #: ../src/guestfs-actions.pod:1000
7685 msgid "guestfs_chown"
7689 #: ../src/guestfs-actions.pod:1002
7693 " guestfs_chown (guestfs_h *g,\n"
7696 " const char *path);\n"
7701 #: ../src/guestfs-actions.pod:1008 ../fish/guestfish-actions.pod:682
7702 msgid "Change the file owner to C<owner> and group to C<group>."
7706 #: ../src/guestfs-actions.pod:1010 ../src/guestfs-actions.pod:3487
7707 #: ../fish/guestfish-actions.pod:684 ../fish/guestfish-actions.pod:2433
7709 "Only numeric uid and gid are supported. If you want to use names, you will "
7710 "need to locate and parse the password file yourself (Augeas support makes "
7711 "this relatively easy)."
7715 #: ../src/guestfs-actions.pod:1018
7716 msgid "guestfs_command"
7720 #: ../src/guestfs-actions.pod:1020
7724 " guestfs_command (guestfs_h *g,\n"
7725 " char *const *arguments);\n"
7730 #: ../src/guestfs-actions.pod:1024 ../fish/guestfish-actions.pod:692
7732 "This call runs a command from the guest filesystem. The filesystem must be "
7733 "mounted, and must contain a compatible operating system (ie. something "
7734 "Linux, with the same or compatible processor architecture)."
7738 #: ../src/guestfs-actions.pod:1029
7740 "The single parameter is an argv-style list of arguments. The first element "
7741 "is the name of the program to run. Subsequent elements are parameters. The "
7742 "list must be non-empty (ie. must contain a program name). Note that the "
7743 "command runs directly, and is I<not> invoked via the shell (see "
7748 #: ../src/guestfs-actions.pod:1036 ../fish/guestfish-actions.pod:704
7749 msgid "The return value is anything printed to I<stdout> by the command."
7753 #: ../src/guestfs-actions.pod:1039 ../fish/guestfish-actions.pod:707
7755 "If the command returns a non-zero exit status, then this function returns an "
7756 "error message. The error message string is the content of I<stderr> from "
7761 #: ../src/guestfs-actions.pod:1043 ../fish/guestfish-actions.pod:711
7763 "The C<$PATH> environment variable will contain at least C</usr/bin> and C</"
7764 "bin>. If you require a program from another location, you should provide "
7765 "the full path in the first parameter."
7769 #: ../src/guestfs-actions.pod:1048 ../fish/guestfish-actions.pod:716
7771 "Shared libraries and data files required by the program must be available on "
7772 "filesystems which are mounted in the correct places. It is the caller's "
7773 "responsibility to ensure all filesystems that are needed are mounted at the "
7778 #: ../src/guestfs-actions.pod:1060 ../src/guestfs-actions.pod:1080
7779 #: ../src/guestfs-actions.pod:1548
7780 msgid "(Added in 0.9.1)"
7784 #: ../src/guestfs-actions.pod:1062
7785 msgid "guestfs_command_lines"
7789 #: ../src/guestfs-actions.pod:1064
7793 " guestfs_command_lines (guestfs_h *g,\n"
7794 " char *const *arguments);\n"
7799 #: ../src/guestfs-actions.pod:1068
7801 "This is the same as C<guestfs_command>, but splits the result into a list of "
7806 #: ../src/guestfs-actions.pod:1071
7807 msgid "See also: C<guestfs_sh_lines>"
7811 #: ../src/guestfs-actions.pod:1082
7812 msgid "guestfs_config"
7816 #: ../src/guestfs-actions.pod:1084
7820 " guestfs_config (guestfs_h *g,\n"
7821 " const char *qemuparam,\n"
7822 " const char *qemuvalue);\n"
7827 #: ../src/guestfs-actions.pod:1089 ../fish/guestfish-actions.pod:741
7829 "This can be used to add arbitrary qemu command line parameters of the form "
7830 "C<-param value>. Actually it's not quite arbitrary - we prevent you from "
7831 "setting some parameters which would interfere with parameters that we use."
7835 #: ../src/guestfs-actions.pod:1094 ../fish/guestfish-actions.pod:746
7836 msgid "The first character of C<param> string must be a C<-> (dash)."
7840 #: ../src/guestfs-actions.pod:1096 ../fish/guestfish-actions.pod:748
7841 msgid "C<value> can be NULL."
7845 #: ../src/guestfs-actions.pod:1102
7846 msgid "guestfs_copy_size"
7850 #: ../src/guestfs-actions.pod:1104
7854 " guestfs_copy_size (guestfs_h *g,\n"
7855 " const char *src,\n"
7856 " const char *dest,\n"
7862 #: ../src/guestfs-actions.pod:1110 ../fish/guestfish-actions.pod:754
7864 "This command copies exactly C<size> bytes from one source device or file "
7865 "C<src> to another destination device or file C<dest>."
7869 #: ../src/guestfs-actions.pod:1113 ../fish/guestfish-actions.pod:757
7871 "Note this will fail if the source is too short or if the destination is not "
7876 #: ../src/guestfs-actions.pod:1118 ../src/guestfs-actions.pod:1241
7877 #: ../src/guestfs-actions.pod:1272 ../src/guestfs-actions.pod:1317
7878 #: ../src/guestfs-actions.pod:1697 ../src/guestfs-actions.pod:1719
7879 #: ../src/guestfs-actions.pod:3468 ../src/guestfs-actions.pod:6813
7880 #: ../src/guestfs-actions.pod:6847 ../src/guestfs-actions.pod:7326
7881 #: ../src/guestfs-actions.pod:7345
7883 "This long-running command can generate progress notification messages so "
7884 "that the caller can display a progress bar or indicator. To receive these "
7885 "messages, the caller must register a progress event callback. See L<guestfs"
7886 "(3)/GUESTFS_EVENT_PROGRESS>."
7890 #: ../src/guestfs-actions.pod:1123 ../src/guestfs-actions.pod:4155
7891 #: ../src/guestfs-actions.pod:5373 ../src/guestfs-actions.pod:7054
7892 #: ../src/guestfs-actions.pod:7074 ../src/guestfs-actions.pod:7160
7893 msgid "(Added in 1.0.87)"
7897 #: ../src/guestfs-actions.pod:1125
7902 #: ../src/guestfs-actions.pod:1127
7906 " guestfs_cp (guestfs_h *g,\n"
7907 " const char *src,\n"
7908 " const char *dest);\n"
7913 #: ../src/guestfs-actions.pod:1132 ../fish/guestfish-actions.pod:764
7915 "This copies a file from C<src> to C<dest> where C<dest> is either a "
7916 "destination filename or destination directory."
7920 #: ../src/guestfs-actions.pod:1137 ../src/guestfs-actions.pod:1151
7921 #: ../src/guestfs-actions.pod:1223 ../src/guestfs-actions.pod:1297
7922 #: ../src/guestfs-actions.pod:1411 ../src/guestfs-actions.pod:4840
7923 #: ../src/guestfs-actions.pod:5217
7924 msgid "(Added in 1.0.18)"
7928 #: ../src/guestfs-actions.pod:1139
7929 msgid "guestfs_cp_a"
7933 #: ../src/guestfs-actions.pod:1141
7937 " guestfs_cp_a (guestfs_h *g,\n"
7938 " const char *src,\n"
7939 " const char *dest);\n"
7944 #: ../src/guestfs-actions.pod:1146 ../fish/guestfish-actions.pod:771
7946 "This copies a file or directory from C<src> to C<dest> recursively using the "
7951 #: ../src/guestfs-actions.pod:1153
7956 #: ../src/guestfs-actions.pod:1155
7960 " guestfs_dd (guestfs_h *g,\n"
7961 " const char *src,\n"
7962 " const char *dest);\n"
7967 #: ../src/guestfs-actions.pod:1160 ../fish/guestfish-actions.pod:778
7969 "This command copies from one source device or file C<src> to another "
7970 "destination device or file C<dest>. Normally you would use this to copy to "
7971 "or from a device or partition, for example to duplicate a filesystem."
7975 #: ../src/guestfs-actions.pod:1165
7977 "If the destination is a device, it must be as large or larger than the "
7978 "source file or device, otherwise the copy will fail. This command cannot do "
7979 "partial copies (see C<guestfs_copy_size>)."
7983 #: ../src/guestfs-actions.pod:1173
7988 #: ../src/guestfs-actions.pod:1175
7992 " guestfs_df (guestfs_h *g);\n"
7997 #: ../src/guestfs-actions.pod:1178 ../fish/guestfish-actions.pod:791
7998 msgid "This command runs the C<df> command to report disk space used."
8002 #: ../src/guestfs-actions.pod:1180 ../src/guestfs-actions.pod:1197
8004 "This command is mostly useful for interactive sessions. It is I<not> "
8005 "intended that you try to parse the output string. Use C<guestfs_statvfs> "
8010 #: ../src/guestfs-actions.pod:1187 ../src/guestfs-actions.pod:1204
8011 #: ../src/guestfs-actions.pod:1322 ../src/guestfs-actions.pod:2286
8012 #: ../src/guestfs-actions.pod:2310 ../src/guestfs-actions.pod:2378
8013 #: ../src/guestfs-actions.pod:4265 ../src/guestfs-actions.pod:4740
8014 #: ../src/guestfs-actions.pod:6551 ../src/guestfs-actions.pod:6575
8015 #: ../src/guestfs-actions.pod:7193 ../src/guestfs-actions.pod:7206
8016 #: ../src/guestfs-actions.pod:7219
8017 msgid "(Added in 1.0.54)"
8021 #: ../src/guestfs-actions.pod:1189
8022 msgid "guestfs_df_h"
8026 #: ../src/guestfs-actions.pod:1191
8030 " guestfs_df_h (guestfs_h *g);\n"
8035 #: ../src/guestfs-actions.pod:1194 ../fish/guestfish-actions.pod:801
8037 "This command runs the C<df -h> command to report disk space used in human-"
8042 #: ../src/guestfs-actions.pod:1206
8043 msgid "guestfs_dmesg"
8047 #: ../src/guestfs-actions.pod:1208
8051 " guestfs_dmesg (guestfs_h *g);\n"
8056 #: ../src/guestfs-actions.pod:1211 ../fish/guestfish-actions.pod:812
8058 "This returns the kernel messages (C<dmesg> output) from the guest kernel. "
8059 "This is sometimes useful for extended debugging of problems."
8063 #: ../src/guestfs-actions.pod:1215
8065 "Another way to get the same information is to enable verbose messages with "
8066 "C<guestfs_set_verbose> or by setting the environment variable "
8067 "C<LIBGUESTFS_DEBUG=1> before running the program."
8071 #: ../src/guestfs-actions.pod:1225
8072 msgid "guestfs_download"
8076 #: ../src/guestfs-actions.pod:1227
8080 " guestfs_download (guestfs_h *g,\n"
8081 " const char *remotefilename,\n"
8082 " const char *filename);\n"
8087 #: ../src/guestfs-actions.pod:1232 ../src/guestfs-actions.pod:1257
8088 #: ../fish/guestfish-actions.pod:825 ../fish/guestfish-actions.pod:838
8090 "Download file C<remotefilename> and save it as C<filename> on the local "
8095 #: ../src/guestfs-actions.pod:1235 ../src/guestfs-actions.pod:6807
8096 #: ../fish/guestfish-actions.pod:828 ../fish/guestfish-actions.pod:4582
8097 msgid "C<filename> can also be a named pipe."
8101 #: ../src/guestfs-actions.pod:1237
8102 msgid "See also C<guestfs_upload>, C<guestfs_cat>."
8106 #: ../src/guestfs-actions.pod:1248
8107 msgid "guestfs_download_offset"
8111 #: ../src/guestfs-actions.pod:1250
8115 " guestfs_download_offset (guestfs_h *g,\n"
8116 " const char *remotefilename,\n"
8117 " const char *filename,\n"
8118 " int64_t offset,\n"
8124 #: ../src/guestfs-actions.pod:1260 ../fish/guestfish-actions.pod:841
8126 "C<remotefilename> is read for C<size> bytes starting at C<offset> (this "
8127 "region must be within the file or device)."
8131 #: ../src/guestfs-actions.pod:1263
8133 "Note that there is no limit on the amount of data that can be downloaded "
8134 "with this call, unlike with C<guestfs_pread>, and this call always reads the "
8135 "full amount unless an error occurs."
8139 #: ../src/guestfs-actions.pod:1268
8140 msgid "See also C<guestfs_download>, C<guestfs_pread>."
8144 #: ../src/guestfs-actions.pod:1277 ../src/guestfs-actions.pod:6852
8145 msgid "(Added in 1.5.17)"
8149 #: ../src/guestfs-actions.pod:1279
8150 msgid "guestfs_drop_caches"
8154 #: ../src/guestfs-actions.pod:1281
8158 " guestfs_drop_caches (guestfs_h *g,\n"
8159 " int whattodrop);\n"
8164 #: ../src/guestfs-actions.pod:1285 ../fish/guestfish-actions.pod:857
8166 "This instructs the guest kernel to drop its page cache, and/or dentries and "
8167 "inode caches. The parameter C<whattodrop> tells the kernel what precisely "
8168 "to drop, see L<http://linux-mm.org/Drop_Caches>"
8172 #: ../src/guestfs-actions.pod:1290 ../fish/guestfish-actions.pod:862
8173 msgid "Setting C<whattodrop> to 3 should drop everything."
8177 #: ../src/guestfs-actions.pod:1292 ../fish/guestfish-actions.pod:864
8179 "This automatically calls L<sync(2)> before the operation, so that the "
8180 "maximum guest memory is freed."
8184 #: ../src/guestfs-actions.pod:1299
8189 #: ../src/guestfs-actions.pod:1301
8193 " guestfs_du (guestfs_h *g,\n"
8194 " const char *path);\n"
8199 #: ../src/guestfs-actions.pod:1305 ../fish/guestfish-actions.pod:871
8201 "This command runs the C<du -s> command to estimate file space usage for "
8206 #: ../src/guestfs-actions.pod:1308 ../fish/guestfish-actions.pod:874
8208 "C<path> can be a file or a directory. If C<path> is a directory then the "
8209 "estimate includes the contents of the directory and all subdirectories "
8214 #: ../src/guestfs-actions.pod:1312 ../fish/guestfish-actions.pod:878
8216 "The result is the estimated size in I<kilobytes> (ie. units of 1024 bytes)."
8220 #: ../src/guestfs-actions.pod:1324
8221 msgid "guestfs_e2fsck_f"
8225 #: ../src/guestfs-actions.pod:1326
8229 " guestfs_e2fsck_f (guestfs_h *g,\n"
8230 " const char *device);\n"
8235 #: ../src/guestfs-actions.pod:1330 ../fish/guestfish-actions.pod:885
8237 "This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3 filesystem checker "
8238 "on C<device>, noninteractively (C<-p>), even if the filesystem appears to be "
8243 #: ../src/guestfs-actions.pod:1334
8245 "This command is only needed because of C<guestfs_resize2fs> (q.v.). "
8246 "Normally you should use C<guestfs_fsck>."
8250 #: ../src/guestfs-actions.pod:1339
8251 msgid "(Added in 1.0.29)"
8255 #: ../src/guestfs-actions.pod:1341
8256 msgid "guestfs_echo_daemon"
8260 #: ../src/guestfs-actions.pod:1343
8264 " guestfs_echo_daemon (guestfs_h *g,\n"
8265 " char *const *words);\n"
8270 #: ../src/guestfs-actions.pod:1347 ../fish/guestfish-actions.pod:896
8272 "This command concatenates the list of C<words> passed with single spaces "
8273 "between them and returns the resulting string."
8277 #: ../src/guestfs-actions.pod:1350 ../fish/guestfish-actions.pod:899
8278 msgid "You can use this command to test the connection through to the daemon."
8282 #: ../src/guestfs-actions.pod:1352
8283 msgid "See also C<guestfs_ping_daemon>."
8287 #: ../src/guestfs-actions.pod:1357 ../src/guestfs-actions.pod:2094
8288 #: ../src/guestfs-actions.pod:6051
8289 msgid "(Added in 1.0.69)"
8293 #: ../src/guestfs-actions.pod:1359
8294 msgid "guestfs_egrep"
8298 #: ../src/guestfs-actions.pod:1361
8302 " guestfs_egrep (guestfs_h *g,\n"
8303 " const char *regex,\n"
8304 " const char *path);\n"
8309 #: ../src/guestfs-actions.pod:1366 ../fish/guestfish-actions.pod:907
8311 "This calls the external C<egrep> program and returns the matching lines."
8315 #: ../src/guestfs-actions.pod:1376 ../src/guestfs-actions.pod:1395
8316 #: ../src/guestfs-actions.pod:1452 ../src/guestfs-actions.pod:1498
8317 #: ../src/guestfs-actions.pod:1517 ../src/guestfs-actions.pod:2224
8318 #: ../src/guestfs-actions.pod:2243 ../src/guestfs-actions.pod:2399
8319 #: ../src/guestfs-actions.pod:2412 ../src/guestfs-actions.pod:2427
8320 #: ../src/guestfs-actions.pod:2473 ../src/guestfs-actions.pod:2495
8321 #: ../src/guestfs-actions.pod:2508 ../src/guestfs-actions.pod:3648
8322 #: ../src/guestfs-actions.pod:3662 ../src/guestfs-actions.pod:3675
8323 #: ../src/guestfs-actions.pod:3689 ../src/guestfs-actions.pod:4675
8324 #: ../src/guestfs-actions.pod:5551 ../src/guestfs-actions.pod:5600
8325 #: ../src/guestfs-actions.pod:6419 ../src/guestfs-actions.pod:6431
8326 #: ../src/guestfs-actions.pod:6444 ../src/guestfs-actions.pod:6457
8327 #: ../src/guestfs-actions.pod:6479 ../src/guestfs-actions.pod:6492
8328 #: ../src/guestfs-actions.pod:6505 ../src/guestfs-actions.pod:6518
8329 #: ../src/guestfs-actions.pod:7289 ../src/guestfs-actions.pod:7308
8330 #: ../src/guestfs-actions.pod:7393 ../src/guestfs-actions.pod:7412
8331 #: ../src/guestfs-actions.pod:7458 ../src/guestfs-actions.pod:7477
8332 msgid "(Added in 1.0.66)"
8336 #: ../src/guestfs-actions.pod:1378
8337 msgid "guestfs_egrepi"
8341 #: ../src/guestfs-actions.pod:1380
8345 " guestfs_egrepi (guestfs_h *g,\n"
8346 " const char *regex,\n"
8347 " const char *path);\n"
8352 #: ../src/guestfs-actions.pod:1385 ../fish/guestfish-actions.pod:917
8354 "This calls the external C<egrep -i> program and returns the matching lines."
8358 #: ../src/guestfs-actions.pod:1397
8359 msgid "guestfs_equal"
8363 #: ../src/guestfs-actions.pod:1399
8367 " guestfs_equal (guestfs_h *g,\n"
8368 " const char *file1,\n"
8369 " const char *file2);\n"
8374 #: ../src/guestfs-actions.pod:1404 ../fish/guestfish-actions.pod:927
8376 "This compares the two files C<file1> and C<file2> and returns true if their "
8377 "content is exactly equal, or false otherwise."
8381 #: ../src/guestfs-actions.pod:1407 ../fish/guestfish-actions.pod:930
8382 msgid "The external L<cmp(1)> program is used for the comparison."
8386 #: ../src/guestfs-actions.pod:1413
8387 msgid "guestfs_exists"
8391 #: ../src/guestfs-actions.pod:1415
8395 " guestfs_exists (guestfs_h *g,\n"
8396 " const char *path);\n"
8401 #: ../src/guestfs-actions.pod:1419 ../fish/guestfish-actions.pod:936
8403 "This returns C<true> if and only if there is a file, directory (or anything) "
8404 "with the given C<path> name."
8408 #: ../src/guestfs-actions.pod:1422
8409 msgid "See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>."
8413 #: ../src/guestfs-actions.pod:1428
8414 msgid "guestfs_fallocate"
8418 #: ../src/guestfs-actions.pod:1430
8422 " guestfs_fallocate (guestfs_h *g,\n"
8423 " const char *path,\n"
8429 #: ../src/guestfs-actions.pod:1435 ../src/guestfs-actions.pod:1461
8430 #: ../fish/guestfish-actions.pod:945 ../fish/guestfish-actions.pod:964
8432 "This command preallocates a file (containing zero bytes) named C<path> of "
8433 "size C<len> bytes. If the file exists already, it is overwritten."
8437 #: ../src/guestfs-actions.pod:1439 ../fish/guestfish-actions.pod:949
8439 "Do not confuse this with the guestfish-specific C<alloc> command which "
8440 "allocates a file in the host and attaches it as a device."
8444 #: ../src/guestfs-actions.pod:1445 ../fish/guestfish-actions.pod:953
8446 "This function is deprecated. In new code, use the C<fallocate64> call "
8451 #: ../src/guestfs-actions.pod:1454
8452 msgid "guestfs_fallocate64"
8456 #: ../src/guestfs-actions.pod:1456
8460 " guestfs_fallocate64 (guestfs_h *g,\n"
8461 " const char *path,\n"
8467 #: ../src/guestfs-actions.pod:1465
8469 "Note that this call allocates disk blocks for the file. To create a sparse "
8470 "file use C<guestfs_truncate_size> instead."
8474 #: ../src/guestfs-actions.pod:1468
8476 "The deprecated call C<guestfs_fallocate> does the same, but owing to an "
8477 "oversight it only allowed 30 bit lengths to be specified, effectively "
8478 "limiting the maximum size of files created through that call to 1GB."
8482 #: ../src/guestfs-actions.pod:1473 ../fish/guestfish-actions.pod:976
8484 "Do not confuse this with the guestfish-specific C<alloc> and C<sparse> "
8485 "commands which create a file in the host and attach it as a device."
8489 #: ../src/guestfs-actions.pod:1479
8490 msgid "(Added in 1.3.17)"
8494 #: ../src/guestfs-actions.pod:1481
8495 msgid "guestfs_fgrep"
8499 #: ../src/guestfs-actions.pod:1483
8503 " guestfs_fgrep (guestfs_h *g,\n"
8504 " const char *pattern,\n"
8505 " const char *path);\n"
8510 #: ../src/guestfs-actions.pod:1488 ../fish/guestfish-actions.pod:984
8512 "This calls the external C<fgrep> program and returns the matching lines."
8516 #: ../src/guestfs-actions.pod:1500
8517 msgid "guestfs_fgrepi"
8521 #: ../src/guestfs-actions.pod:1502
8525 " guestfs_fgrepi (guestfs_h *g,\n"
8526 " const char *pattern,\n"
8527 " const char *path);\n"
8532 #: ../src/guestfs-actions.pod:1507 ../fish/guestfish-actions.pod:994
8534 "This calls the external C<fgrep -i> program and returns the matching lines."
8538 #: ../src/guestfs-actions.pod:1519
8539 msgid "guestfs_file"
8543 #: ../src/guestfs-actions.pod:1521
8547 " guestfs_file (guestfs_h *g,\n"
8548 " const char *path);\n"
8553 #: ../src/guestfs-actions.pod:1525 ../fish/guestfish-actions.pod:1004
8555 "This call uses the standard L<file(1)> command to determine the type or "
8556 "contents of the file."
8560 #: ../src/guestfs-actions.pod:1528 ../fish/guestfish-actions.pod:1007
8562 "This call will also transparently look inside various types of compressed "
8567 #: ../src/guestfs-actions.pod:1531 ../fish/guestfish-actions.pod:1010
8569 "The exact command which runs is C<file -zb path>. Note in particular that "
8570 "the filename is not prepended to the output (the C<-b> option)."
8574 #: ../src/guestfs-actions.pod:1535
8576 "This command can also be used on C</dev/> devices (and partitions, LV "
8577 "names). You can for example use this to determine if a device contains a "
8578 "filesystem, although it's usually better to use C<guestfs_vfs_type>."
8582 #: ../src/guestfs-actions.pod:1540 ../fish/guestfish-actions.pod:1019
8584 "If the C<path> does not begin with C</dev/> then this command only works for "
8585 "the content of regular files. For other file types (directory, symbolic "
8586 "link etc) it will just return the string C<directory> etc."
8590 #: ../src/guestfs-actions.pod:1550
8591 msgid "guestfs_file_architecture"
8595 #: ../src/guestfs-actions.pod:1552
8599 " guestfs_file_architecture (guestfs_h *g,\n"
8600 " const char *filename);\n"
8605 #: ../src/guestfs-actions.pod:1556 ../fish/guestfish-actions.pod:1028
8607 "This detects the architecture of the binary C<filename>, and returns it if "
8612 #: ../src/guestfs-actions.pod:1559 ../fish/guestfish-actions.pod:1031
8613 msgid "Currently defined architectures are:"
8617 #: ../src/guestfs-actions.pod:1563 ../fish/guestfish-actions.pod:1035
8622 #: ../src/guestfs-actions.pod:1565 ../fish/guestfish-actions.pod:1037
8624 "This string is returned for all 32 bit i386, i486, i586, i686 binaries "
8625 "irrespective of the precise processor requirements of the binary."
8629 #: ../src/guestfs-actions.pod:1568 ../fish/guestfish-actions.pod:1040
8634 #: ../src/guestfs-actions.pod:1570 ../fish/guestfish-actions.pod:1042
8635 msgid "64 bit x86-64."
8639 #: ../src/guestfs-actions.pod:1572 ../fish/guestfish-actions.pod:1044
8644 #: ../src/guestfs-actions.pod:1574 ../fish/guestfish-actions.pod:1046
8645 msgid "32 bit SPARC."
8649 #: ../src/guestfs-actions.pod:1576 ../fish/guestfish-actions.pod:1048
8654 #: ../src/guestfs-actions.pod:1578 ../fish/guestfish-actions.pod:1050
8655 msgid "64 bit SPARC V9 and above."
8659 #: ../src/guestfs-actions.pod:1580 ../fish/guestfish-actions.pod:1052
8664 #: ../src/guestfs-actions.pod:1582 ../fish/guestfish-actions.pod:1054
8665 msgid "Intel Itanium."
8666 msgstr "Intel Itanium."
8669 #: ../src/guestfs-actions.pod:1584 ../fish/guestfish-actions.pod:1056
8674 #: ../src/guestfs-actions.pod:1586 ../fish/guestfish-actions.pod:1058
8675 msgid "32 bit Power PC."
8679 #: ../src/guestfs-actions.pod:1588 ../fish/guestfish-actions.pod:1060
8684 #: ../src/guestfs-actions.pod:1590 ../fish/guestfish-actions.pod:1062
8685 msgid "64 bit Power PC."
8689 #: ../src/guestfs-actions.pod:1594 ../fish/guestfish-actions.pod:1066
8690 msgid "Libguestfs may return other architecture strings in future."
8694 #: ../src/guestfs-actions.pod:1596 ../fish/guestfish-actions.pod:1068
8695 msgid "The function works on at least the following types of files:"
8699 #: ../src/guestfs-actions.pod:1602 ../fish/guestfish-actions.pod:1074
8700 msgid "many types of Un*x and Linux binary"
8704 #: ../src/guestfs-actions.pod:1606 ../fish/guestfish-actions.pod:1078
8705 msgid "many types of Un*x and Linux shared library"
8709 #: ../src/guestfs-actions.pod:1610 ../fish/guestfish-actions.pod:1082
8710 msgid "Windows Win32 and Win64 binaries"
8714 #: ../src/guestfs-actions.pod:1614 ../fish/guestfish-actions.pod:1086
8715 msgid "Windows Win32 and Win64 DLLs"
8719 #: ../src/guestfs-actions.pod:1616 ../fish/guestfish-actions.pod:1088
8720 msgid "Win32 binaries and DLLs return C<i386>."
8724 #: ../src/guestfs-actions.pod:1618 ../fish/guestfish-actions.pod:1090
8725 msgid "Win64 binaries and DLLs return C<x86_64>."
8729 #: ../src/guestfs-actions.pod:1622 ../fish/guestfish-actions.pod:1094
8730 msgid "Linux kernel modules"
8734 #: ../src/guestfs-actions.pod:1626 ../fish/guestfish-actions.pod:1098
8735 msgid "Linux new-style initrd images"
8739 #: ../src/guestfs-actions.pod:1630 ../fish/guestfish-actions.pod:1102
8740 msgid "some non-x86 Linux vmlinuz kernels"
8744 #: ../src/guestfs-actions.pod:1634 ../fish/guestfish-actions.pod:1106
8745 msgid "What it can't do currently:"
8749 #: ../src/guestfs-actions.pod:1640 ../fish/guestfish-actions.pod:1112
8750 msgid "static libraries (libfoo.a)"
8754 #: ../src/guestfs-actions.pod:1644 ../fish/guestfish-actions.pod:1116
8755 msgid "Linux old-style initrd as compressed ext2 filesystem (RHEL 3)"
8759 #: ../src/guestfs-actions.pod:1648 ../fish/guestfish-actions.pod:1120
8760 msgid "x86 Linux vmlinuz kernels"
8764 #: ../src/guestfs-actions.pod:1650 ../fish/guestfish-actions.pod:1122
8766 "x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and "
8767 "compressed code, and are horribly hard to unpack. If you want to find the "
8768 "architecture of a kernel, use the architecture of the associated initrd or "
8769 "kernel module(s) instead."
8773 #: ../src/guestfs-actions.pod:1660 ../src/guestfs-actions.pod:1823
8774 #: ../src/guestfs-actions.pod:1840 ../src/guestfs-actions.pod:2531
8775 #: ../src/guestfs-actions.pod:2616 ../src/guestfs-actions.pod:2686
8776 #: ../src/guestfs-actions.pod:2774 ../src/guestfs-actions.pod:2795
8777 #: ../src/guestfs-actions.pod:2838 ../src/guestfs-actions.pod:2922
8778 #: ../src/guestfs-actions.pod:3019 ../src/guestfs-actions.pod:3266
8779 #: ../src/guestfs-actions.pod:3398
8780 msgid "(Added in 1.5.3)"
8784 #: ../src/guestfs-actions.pod:1662
8785 msgid "guestfs_filesize"
8789 #: ../src/guestfs-actions.pod:1664
8793 " guestfs_filesize (guestfs_h *g,\n"
8794 " const char *file);\n"
8799 #: ../src/guestfs-actions.pod:1668 ../fish/guestfish-actions.pod:1133
8800 msgid "This command returns the size of C<file> in bytes."
8804 #: ../src/guestfs-actions.pod:1670
8806 "To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>, "
8807 "C<guestfs_is_dir>, C<guestfs_is_file> etc. To get the size of block "
8808 "devices, use C<guestfs_blockdev_getsize64>."
8812 #: ../src/guestfs-actions.pod:1676
8813 msgid "(Added in 1.0.82)"
8817 #: ../src/guestfs-actions.pod:1678
8818 msgid "guestfs_fill"
8822 #: ../src/guestfs-actions.pod:1680
8826 " guestfs_fill (guestfs_h *g,\n"
8829 " const char *path);\n"
8834 #: ../src/guestfs-actions.pod:1686 ../fish/guestfish-actions.pod:1143
8836 "This command creates a new file called C<path>. The initial content of the "
8837 "file is C<len> octets of C<c>, where C<c> must be a number in the range C<"
8842 #: ../src/guestfs-actions.pod:1690
8844 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
8845 "C<guestfs_truncate_size>. To create a file with a pattern of repeating "
8846 "bytes use C<guestfs_fill_pattern>."
8850 #: ../src/guestfs-actions.pod:1702
8851 msgid "(Added in 1.0.79)"
8855 #: ../src/guestfs-actions.pod:1704
8856 msgid "guestfs_fill_pattern"
8860 #: ../src/guestfs-actions.pod:1706
8864 " guestfs_fill_pattern (guestfs_h *g,\n"
8865 " const char *pattern,\n"
8867 " const char *path);\n"
8872 #: ../src/guestfs-actions.pod:1712
8874 "This function is like C<guestfs_fill> except that it creates a new file of "
8875 "length C<len> containing the repeating pattern of bytes in C<pattern>. The "
8876 "pattern is truncated if necessary to ensure the length of the file is "
8877 "exactly C<len> bytes."
8881 #: ../src/guestfs-actions.pod:1724
8882 msgid "(Added in 1.3.12)"
8886 #: ../src/guestfs-actions.pod:1726
8887 msgid "guestfs_find"
8891 #: ../src/guestfs-actions.pod:1728
8895 " guestfs_find (guestfs_h *g,\n"
8896 " const char *directory);\n"
8901 #: ../src/guestfs-actions.pod:1732 ../fish/guestfish-actions.pod:1165
8903 "This command lists out all files and directories, recursively, starting at "
8904 "C<directory>. It is essentially equivalent to running the shell command "
8905 "C<find directory -print> but some post-processing happens on the output, "
8910 #: ../src/guestfs-actions.pod:1737 ../fish/guestfish-actions.pod:1170
8912 "This returns a list of strings I<without any prefix>. Thus if the directory "
8917 #: ../src/guestfs-actions.pod:1740 ../fish/guestfish-actions.pod:1173
8927 #: ../src/guestfs-actions.pod:1744
8929 "then the returned list from C<guestfs_find> C</tmp> would be 4 elements:"
8933 #: ../src/guestfs-actions.pod:1747 ../fish/guestfish-actions.pod:1180
8944 #: ../src/guestfs-actions.pod:1752 ../fish/guestfish-actions.pod:1185
8945 msgid "If C<directory> is not a directory, then this command returns an error."
8949 #: ../src/guestfs-actions.pod:1755 ../fish/guestfish-actions.pod:1188
8950 msgid "The returned list is sorted."
8954 #: ../src/guestfs-actions.pod:1757
8955 msgid "See also C<guestfs_find0>."
8959 #: ../src/guestfs-actions.pod:1766 ../src/guestfs-actions.pod:4092
8960 #: ../src/guestfs-actions.pod:5635
8961 msgid "(Added in 1.0.27)"
8965 #: ../src/guestfs-actions.pod:1768
8966 msgid "guestfs_find0"
8970 #: ../src/guestfs-actions.pod:1770
8974 " guestfs_find0 (guestfs_h *g,\n"
8975 " const char *directory,\n"
8976 " const char *files);\n"
8981 #: ../src/guestfs-actions.pod:1775 ../fish/guestfish-actions.pod:1199
8983 "This command lists out all files and directories, recursively, starting at "
8984 "C<directory>, placing the resulting list in the external file called "
8989 #: ../src/guestfs-actions.pod:1779
8991 "This command works the same way as C<guestfs_find> with the following "
8996 #: ../src/guestfs-actions.pod:1786 ../fish/guestfish-actions.pod:1210
8997 msgid "The resulting list is written to an external file."
9001 #: ../src/guestfs-actions.pod:1790 ../fish/guestfish-actions.pod:1214
9003 "Items (filenames) in the result are separated by C<\\0> characters. See "
9004 "L<find(1)> option I<-print0>."
9008 #: ../src/guestfs-actions.pod:1795 ../fish/guestfish-actions.pod:1219
9009 msgid "This command is not limited in the number of names that it can return."
9013 #: ../src/guestfs-actions.pod:1800 ../fish/guestfish-actions.pod:1224
9014 msgid "The result list is not sorted."
9018 #: ../src/guestfs-actions.pod:1806
9019 msgid "(Added in 1.0.74)"
9023 #: ../src/guestfs-actions.pod:1808
9024 msgid "guestfs_findfs_label"
9028 #: ../src/guestfs-actions.pod:1810
9032 " guestfs_findfs_label (guestfs_h *g,\n"
9033 " const char *label);\n"
9038 #: ../src/guestfs-actions.pod:1814 ../fish/guestfish-actions.pod:1234
9040 "This command searches the filesystems and returns the one which has the "
9041 "given label. An error is returned if no such filesystem can be found."
9045 #: ../src/guestfs-actions.pod:1818
9046 msgid "To find the label of a filesystem, use C<guestfs_vfs_label>."
9050 #: ../src/guestfs-actions.pod:1825
9051 msgid "guestfs_findfs_uuid"
9055 #: ../src/guestfs-actions.pod:1827
9059 " guestfs_findfs_uuid (guestfs_h *g,\n"
9060 " const char *uuid);\n"
9065 #: ../src/guestfs-actions.pod:1831 ../fish/guestfish-actions.pod:1244
9067 "This command searches the filesystems and returns the one which has the "
9068 "given UUID. An error is returned if no such filesystem can be found."
9072 #: ../src/guestfs-actions.pod:1835
9073 msgid "To find the UUID of a filesystem, use C<guestfs_vfs_uuid>."
9077 #: ../src/guestfs-actions.pod:1842
9078 msgid "guestfs_fsck"
9082 #: ../src/guestfs-actions.pod:1844
9086 " guestfs_fsck (guestfs_h *g,\n"
9087 " const char *fstype,\n"
9088 " const char *device);\n"
9093 #: ../src/guestfs-actions.pod:1849 ../fish/guestfish-actions.pod:1254
9095 "This runs the filesystem checker (fsck) on C<device> which should have "
9096 "filesystem type C<fstype>."
9100 #: ../src/guestfs-actions.pod:1852 ../fish/guestfish-actions.pod:1257
9102 "The returned integer is the status. See L<fsck(8)> for the list of status "
9103 "codes from C<fsck>."
9107 #: ../src/guestfs-actions.pod:1861 ../fish/guestfish-actions.pod:1266
9108 msgid "Multiple status codes can be summed together."
9112 #: ../src/guestfs-actions.pod:1865 ../fish/guestfish-actions.pod:1270
9114 "A non-zero return code can mean \"success\", for example if errors have been "
9115 "corrected on the filesystem."
9119 #: ../src/guestfs-actions.pod:1870 ../fish/guestfish-actions.pod:1275
9120 msgid "Checking or repairing NTFS volumes is not supported (by linux-ntfs)."
9124 #: ../src/guestfs-actions.pod:1875 ../fish/guestfish-actions.pod:1280
9126 "This command is entirely equivalent to running C<fsck -a -t fstype device>."
9130 #: ../src/guestfs-actions.pod:1879 ../src/guestfs-actions.pod:7331
9131 msgid "(Added in 1.0.16)"
9135 #: ../src/guestfs-actions.pod:1881
9136 msgid "guestfs_get_append"
9140 #: ../src/guestfs-actions.pod:1883
9144 " guestfs_get_append (guestfs_h *g);\n"
9149 #: ../src/guestfs-actions.pod:1886 ../fish/guestfish-actions.pod:1286
9151 "Return the additional kernel options which are added to the guest kernel "
9156 #: ../src/guestfs-actions.pod:1889 ../fish/guestfish-actions.pod:1289
9157 msgid "If C<NULL> then no options are added."
9161 #: ../src/guestfs-actions.pod:1891
9163 "This function returns a string which may be NULL. There is no way to return "
9164 "an error from this function. The string is owned by the guest handle and "
9165 "must I<not> be freed."
9169 #: ../src/guestfs-actions.pod:1895 ../src/guestfs-actions.pod:5313
9170 #: ../src/guestfs-actions.pod:5793 ../src/guestfs-actions.pod:6193
9171 #: ../src/guestfs-actions.pod:6212 ../src/guestfs-actions.pod:6228
9172 #: ../src/guestfs-actions.pod:6245 ../src/guestfs-actions.pod:7002
9173 #: ../src/guestfs-actions.pod:7020 ../src/guestfs-actions.pod:7374
9174 msgid "(Added in 1.0.26)"
9178 #: ../src/guestfs-actions.pod:1897
9179 msgid "guestfs_get_attach_method"
9183 #: ../src/guestfs-actions.pod:1899
9187 " guestfs_get_attach_method (guestfs_h *g);\n"
9192 #: ../src/guestfs-actions.pod:1902
9193 msgid "Return the current attach method. See C<guestfs_set_attach_method>."
9197 #: ../src/guestfs-actions.pod:1907
9198 msgid "guestfs_get_autosync"
9202 #: ../src/guestfs-actions.pod:1909
9206 " guestfs_get_autosync (guestfs_h *g);\n"
9211 #: ../src/guestfs-actions.pod:1912 ../fish/guestfish-actions.pod:1301
9212 msgid "Get the autosync flag."
9216 #: ../src/guestfs-actions.pod:1918
9217 msgid "guestfs_get_direct"
9221 #: ../src/guestfs-actions.pod:1920
9225 " guestfs_get_direct (guestfs_h *g);\n"
9230 #: ../src/guestfs-actions.pod:1923 ../fish/guestfish-actions.pod:1307
9231 msgid "Return the direct appliance mode flag."
9235 #: ../src/guestfs-actions.pod:1927 ../src/guestfs-actions.pod:5862
9236 msgid "(Added in 1.0.72)"
9240 #: ../src/guestfs-actions.pod:1929
9241 msgid "guestfs_get_e2label"
9245 #: ../src/guestfs-actions.pod:1931
9249 " guestfs_get_e2label (guestfs_h *g,\n"
9250 " const char *device);\n"
9255 #: ../src/guestfs-actions.pod:1935 ../fish/guestfish-actions.pod:1313
9257 "This returns the ext2/3/4 filesystem label of the filesystem on C<device>."
9261 #: ../src/guestfs-actions.pod:1941 ../fish/guestfish-actions.pod:1316
9263 "This function is deprecated. In new code, use the C<vfs_label> call instead."
9267 #: ../src/guestfs-actions.pod:1948 ../src/guestfs-actions.pod:1969
9268 #: ../src/guestfs-actions.pod:5880 ../src/guestfs-actions.pod:5899
9269 msgid "(Added in 1.0.15)"
9273 #: ../src/guestfs-actions.pod:1950
9274 msgid "guestfs_get_e2uuid"
9278 #: ../src/guestfs-actions.pod:1952
9282 " guestfs_get_e2uuid (guestfs_h *g,\n"
9283 " const char *device);\n"
9288 #: ../src/guestfs-actions.pod:1956 ../fish/guestfish-actions.pod:1327
9290 "This returns the ext2/3/4 filesystem UUID of the filesystem on C<device>."
9294 #: ../src/guestfs-actions.pod:1962 ../fish/guestfish-actions.pod:1330
9296 "This function is deprecated. In new code, use the C<vfs_uuid> call instead."
9300 #: ../src/guestfs-actions.pod:1971
9301 msgid "guestfs_get_memsize"
9305 #: ../src/guestfs-actions.pod:1973
9309 " guestfs_get_memsize (guestfs_h *g);\n"
9314 #: ../src/guestfs-actions.pod:1976 ../fish/guestfish-actions.pod:1341
9316 "This gets the memory size in megabytes allocated to the qemu subprocess."
9320 #: ../src/guestfs-actions.pod:1979
9322 "If C<guestfs_set_memsize> was not called on this handle, and if "
9323 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
9324 "value for memsize."
9328 #: ../src/guestfs-actions.pod:1983 ../src/guestfs-actions.pod:2064
9329 #: ../src/guestfs-actions.pod:5915 ../src/guestfs-actions.pod:6022
9330 #: ../fish/guestfish-actions.pod:1348 ../fish/guestfish-actions.pod:1399
9331 #: ../fish/guestfish-actions.pod:3985 ../fish/guestfish-actions.pod:4072
9333 "For more information on the architecture of libguestfs, see L<guestfs(3)>."
9337 #: ../src/guestfs-actions.pod:1988 ../src/guestfs-actions.pod:4383
9338 #: ../src/guestfs-actions.pod:4580 ../src/guestfs-actions.pod:4599
9339 #: ../src/guestfs-actions.pod:4618 ../src/guestfs-actions.pod:4630
9340 #: ../src/guestfs-actions.pod:4647 ../src/guestfs-actions.pod:4660
9341 #: ../src/guestfs-actions.pod:5538 ../src/guestfs-actions.pod:5920
9342 #: ../src/guestfs-actions.pod:6167 ../src/guestfs-actions.pod:6768
9343 msgid "(Added in 1.0.55)"
9347 #: ../src/guestfs-actions.pod:1990
9348 msgid "guestfs_get_network"
9352 #: ../src/guestfs-actions.pod:1992
9356 " guestfs_get_network (guestfs_h *g);\n"
9361 #: ../src/guestfs-actions.pod:1995 ../fish/guestfish-actions.pod:1355
9362 msgid "This returns the enable network flag."
9366 #: ../src/guestfs-actions.pod:1999 ../src/guestfs-actions.pod:5939
9367 msgid "(Added in 1.5.4)"
9371 #: ../src/guestfs-actions.pod:2001
9372 msgid "guestfs_get_path"
9376 #: ../src/guestfs-actions.pod:2003
9380 " guestfs_get_path (guestfs_h *g);\n"
9385 #: ../src/guestfs-actions.pod:2006 ../fish/guestfish-actions.pod:1361
9386 msgid "Return the current search path."
9390 #: ../src/guestfs-actions.pod:2008 ../fish/guestfish-actions.pod:1363
9392 "This is always non-NULL. If it wasn't set already, then this will return "
9397 #: ../src/guestfs-actions.pod:2011 ../src/guestfs-actions.pod:2040
9399 "This function returns a string, or NULL on error. The string is owned by "
9400 "the guest handle and must I<not> be freed."
9404 #: ../src/guestfs-actions.pod:2016
9405 msgid "guestfs_get_pid"
9409 #: ../src/guestfs-actions.pod:2018
9413 " guestfs_get_pid (guestfs_h *g);\n"
9418 #: ../src/guestfs-actions.pod:2021 ../fish/guestfish-actions.pod:1372
9420 "Return the process ID of the qemu subprocess. If there is no qemu "
9421 "subprocess, then this will return an error."
9425 #: ../src/guestfs-actions.pod:2024 ../fish/guestfish-actions.pod:1375
9426 msgid "This is an internal call used for debugging and testing."
9430 #: ../src/guestfs-actions.pod:2028
9431 msgid "(Added in 1.0.56)"
9435 #: ../src/guestfs-actions.pod:2030
9436 msgid "guestfs_get_qemu"
9440 #: ../src/guestfs-actions.pod:2032
9444 " guestfs_get_qemu (guestfs_h *g);\n"
9449 #: ../src/guestfs-actions.pod:2035 ../fish/guestfish-actions.pod:1381
9450 msgid "Return the current qemu binary."
9454 #: ../src/guestfs-actions.pod:2037 ../fish/guestfish-actions.pod:1383
9456 "This is always non-NULL. If it wasn't set already, then this will return "
9457 "the default qemu binary name."
9461 #: ../src/guestfs-actions.pod:2043 ../src/guestfs-actions.pod:5984
9462 msgid "(Added in 1.0.6)"
9466 #: ../src/guestfs-actions.pod:2045
9467 msgid "guestfs_get_recovery_proc"
9471 #: ../src/guestfs-actions.pod:2047
9475 " guestfs_get_recovery_proc (guestfs_h *g);\n"
9480 #: ../src/guestfs-actions.pod:2050 ../fish/guestfish-actions.pod:1390
9481 msgid "Return the recovery process enabled flag."
9485 #: ../src/guestfs-actions.pod:2054 ../src/guestfs-actions.pod:3493
9486 #: ../src/guestfs-actions.pod:3790 ../src/guestfs-actions.pod:4190
9487 #: ../src/guestfs-actions.pod:4222 ../src/guestfs-actions.pod:5243
9488 #: ../src/guestfs-actions.pod:5586 ../src/guestfs-actions.pod:6008
9489 #: ../src/guestfs-actions.pod:6671 ../src/guestfs-actions.pod:6691
9490 #: ../src/guestfs-actions.pod:6883
9491 msgid "(Added in 1.0.77)"
9495 #: ../src/guestfs-actions.pod:2056
9496 msgid "guestfs_get_selinux"
9500 #: ../src/guestfs-actions.pod:2058
9504 " guestfs_get_selinux (guestfs_h *g);\n"
9509 #: ../src/guestfs-actions.pod:2061
9511 "This returns the current setting of the selinux flag which is passed to the "
9512 "appliance at boot time. See C<guestfs_set_selinux>."
9516 #: ../src/guestfs-actions.pod:2069 ../src/guestfs-actions.pod:2132
9517 #: ../src/guestfs-actions.pod:6027 ../src/guestfs-actions.pod:6085
9518 msgid "(Added in 1.0.67)"
9522 #: ../src/guestfs-actions.pod:2071
9523 msgid "guestfs_get_state"
9527 #: ../src/guestfs-actions.pod:2073
9531 " guestfs_get_state (guestfs_h *g);\n"
9536 #: ../src/guestfs-actions.pod:2076 ../fish/guestfish-actions.pod:1406
9538 "This returns the current state as an opaque integer. This is only useful "
9539 "for printing debug and internal error messages."
9543 #: ../src/guestfs-actions.pod:2079 ../src/guestfs-actions.pod:3291
9544 #: ../src/guestfs-actions.pod:3320 ../src/guestfs-actions.pod:3381
9545 #: ../src/guestfs-actions.pod:3408 ../fish/guestfish-actions.pod:1409
9546 #: ../fish/guestfish-actions.pod:2315 ../fish/guestfish-actions.pod:2333
9547 #: ../fish/guestfish-actions.pod:2371 ../fish/guestfish-actions.pod:2387
9548 msgid "For more information on states, see L<guestfs(3)>."
9552 #: ../src/guestfs-actions.pod:2085
9553 msgid "guestfs_get_trace"
9557 #: ../src/guestfs-actions.pod:2087
9561 " guestfs_get_trace (guestfs_h *g);\n"
9566 #: ../src/guestfs-actions.pod:2090 ../fish/guestfish-actions.pod:1415
9567 msgid "Return the command trace flag."
9571 #: ../src/guestfs-actions.pod:2096
9572 msgid "guestfs_get_umask"
9576 #: ../src/guestfs-actions.pod:2098
9580 " guestfs_get_umask (guestfs_h *g);\n"
9585 #: ../src/guestfs-actions.pod:2101
9587 "Return the current umask. By default the umask is C<022> unless it has been "
9588 "set by calling C<guestfs_umask>."
9592 #: ../src/guestfs-actions.pod:2108
9593 msgid "guestfs_get_verbose"
9597 #: ../src/guestfs-actions.pod:2110
9601 " guestfs_get_verbose (guestfs_h *g);\n"
9606 #: ../src/guestfs-actions.pod:2113 ../fish/guestfish-actions.pod:1428
9607 msgid "This returns the verbose messages flag."
9611 #: ../src/guestfs-actions.pod:2119
9612 msgid "guestfs_getcon"
9616 #: ../src/guestfs-actions.pod:2121
9620 " guestfs_getcon (guestfs_h *g);\n"
9625 #: ../src/guestfs-actions.pod:2124 ../fish/guestfish-actions.pod:1434
9626 msgid "This gets the SELinux security context of the daemon."
9630 #: ../src/guestfs-actions.pod:2126
9632 "See the documentation about SELINUX in L<guestfs(3)>, and C<guestfs_setcon>"
9636 #: ../src/guestfs-actions.pod:2134
9637 msgid "guestfs_getxattr"
9641 #: ../src/guestfs-actions.pod:2136
9645 " guestfs_getxattr (guestfs_h *g,\n"
9646 " const char *path,\n"
9647 " const char *name,\n"
9648 " size_t *size_r);\n"
9653 #: ../src/guestfs-actions.pod:2142
9655 "Get a single extended attribute from file C<path> named C<name>. This call "
9656 "follows symlinks. If you want to lookup an extended attribute for the "
9657 "symlink itself, use C<guestfs_lgetxattr>."
9661 #: ../src/guestfs-actions.pod:2146 ../src/guestfs-actions.pod:3507
9663 "Normally it is better to get all extended attributes from a file in one go "
9664 "by calling C<guestfs_getxattrs>. However some Linux filesystem "
9665 "implementations are buggy and do not provide a way to list out attributes. "
9666 "For these filesystems (notably ntfs-3g) you have to know the names of the "
9667 "extended attributes you want in advance and call this function."
9671 #: ../src/guestfs-actions.pod:2153 ../src/guestfs-actions.pod:3514
9672 #: ../fish/guestfish-actions.pod:1454 ../fish/guestfish-actions.pod:2452
9674 "Extended attribute values are blobs of binary data. If there is no extended "
9675 "attribute named C<name>, this returns an error."
9679 #: ../src/guestfs-actions.pod:2156
9680 msgid "See also: C<guestfs_getxattrs>, C<guestfs_lgetxattr>, L<attr(5)>."
9684 #: ../src/guestfs-actions.pod:2158 ../src/guestfs-actions.pod:2349
9685 #: ../src/guestfs-actions.pod:3519 ../src/guestfs-actions.pod:5236
9686 #: ../src/guestfs-actions.pod:5262 ../src/guestfs-actions.pod:5443
9688 "This function returns a buffer, or NULL on error. The size of the returned "
9689 "buffer is written to C<*size_r>. I<The caller must free the returned buffer "
9694 #: ../src/guestfs-actions.pod:2162 ../src/guestfs-actions.pod:3523
9695 msgid "(Added in 1.7.24)"
9699 #: ../src/guestfs-actions.pod:2164
9700 msgid "guestfs_getxattrs"
9704 #: ../src/guestfs-actions.pod:2166
9707 " struct guestfs_xattr_list *\n"
9708 " guestfs_getxattrs (guestfs_h *g,\n"
9709 " const char *path);\n"
9714 #: ../src/guestfs-actions.pod:2170 ../fish/guestfish-actions.pod:1463
9716 "This call lists the extended attributes of the file or directory C<path>."
9720 #: ../src/guestfs-actions.pod:2173 ../fish/guestfish-actions.pod:1466
9722 "At the system call level, this is a combination of the L<listxattr(2)> and "
9723 "L<getxattr(2)> calls."
9727 #: ../src/guestfs-actions.pod:2176
9728 msgid "See also: C<guestfs_lgetxattrs>, L<attr(5)>."
9732 #: ../src/guestfs-actions.pod:2178 ../src/guestfs-actions.pod:3535
9733 #: ../src/guestfs-actions.pod:4186
9735 "This function returns a C<struct guestfs_xattr_list *>, or NULL if there was "
9736 "an error. I<The caller must call C<guestfs_free_xattr_list> after use>."
9740 #: ../src/guestfs-actions.pod:2182 ../src/guestfs-actions.pod:3539
9741 #: ../src/guestfs-actions.pod:3704 ../src/guestfs-actions.pod:3740
9742 #: ../src/guestfs-actions.pod:5616 ../src/guestfs-actions.pod:6104
9743 #: ../src/guestfs-actions.pod:7439
9744 msgid "(Added in 1.0.59)"
9748 #: ../src/guestfs-actions.pod:2184
9749 msgid "guestfs_glob_expand"
9753 #: ../src/guestfs-actions.pod:2186
9757 " guestfs_glob_expand (guestfs_h *g,\n"
9758 " const char *pattern);\n"
9763 #: ../src/guestfs-actions.pod:2190 ../fish/guestfish-actions.pod:1475
9765 "This command searches for all the pathnames matching C<pattern> according to "
9766 "the wildcard expansion rules used by the shell."
9770 #: ../src/guestfs-actions.pod:2194 ../fish/guestfish-actions.pod:1479
9772 "If no paths match, then this returns an empty list (note: not an error)."
9776 #: ../src/guestfs-actions.pod:2197 ../fish/guestfish-actions.pod:1482
9778 "It is just a wrapper around the C L<glob(3)> function with flags C<GLOB_MARK|"
9779 "GLOB_BRACE>. See that manual page for more details."
9783 #: ../src/guestfs-actions.pod:2205 ../src/guestfs-actions.pod:6269
9784 #: ../src/guestfs-actions.pod:6286
9785 msgid "(Added in 1.0.50)"
9789 #: ../src/guestfs-actions.pod:2207
9790 msgid "guestfs_grep"
9794 #: ../src/guestfs-actions.pod:2209
9798 " guestfs_grep (guestfs_h *g,\n"
9799 " const char *regex,\n"
9800 " const char *path);\n"
9805 #: ../src/guestfs-actions.pod:2214 ../fish/guestfish-actions.pod:1490
9806 msgid "This calls the external C<grep> program and returns the matching lines."
9810 #: ../src/guestfs-actions.pod:2226
9811 msgid "guestfs_grepi"
9815 #: ../src/guestfs-actions.pod:2228
9819 " guestfs_grepi (guestfs_h *g,\n"
9820 " const char *regex,\n"
9821 " const char *path);\n"
9826 #: ../src/guestfs-actions.pod:2233 ../fish/guestfish-actions.pod:1500
9828 "This calls the external C<grep -i> program and returns the matching lines."
9832 #: ../src/guestfs-actions.pod:2245
9833 msgid "guestfs_grub_install"
9837 #: ../src/guestfs-actions.pod:2247
9841 " guestfs_grub_install (guestfs_h *g,\n"
9842 " const char *root,\n"
9843 " const char *device);\n"
9848 #: ../src/guestfs-actions.pod:2252 ../fish/guestfish-actions.pod:1510
9850 "This command installs GRUB (the Grand Unified Bootloader) on C<device>, with "
9851 "the root directory being C<root>."
9855 #: ../src/guestfs-actions.pod:2255 ../fish/guestfish-actions.pod:1513
9857 "Note: If grub-install reports the error \"No suitable drive was found in the "
9858 "generated device map.\" it may be that you need to create a C</boot/grub/"
9859 "device.map> file first that contains the mapping between grub device names "
9860 "and Linux device names. It is usually sufficient to create a file "
9865 #: ../src/guestfs-actions.pod:2262 ../fish/guestfish-actions.pod:1520
9873 #: ../src/guestfs-actions.pod:2264 ../fish/guestfish-actions.pod:1522
9874 msgid "replacing C</dev/vda> with the name of the installation device."
9878 #: ../src/guestfs-actions.pod:2268
9879 msgid "(Added in 1.0.17)"
9883 #: ../src/guestfs-actions.pod:2270
9884 msgid "guestfs_head"
9888 #: ../src/guestfs-actions.pod:2272
9892 " guestfs_head (guestfs_h *g,\n"
9893 " const char *path);\n"
9898 #: ../src/guestfs-actions.pod:2276 ../fish/guestfish-actions.pod:1528
9900 "This command returns up to the first 10 lines of a file as a list of strings."
9904 #: ../src/guestfs-actions.pod:2288
9905 msgid "guestfs_head_n"
9909 #: ../src/guestfs-actions.pod:2290
9913 " guestfs_head_n (guestfs_h *g,\n"
9915 " const char *path);\n"
9920 #: ../src/guestfs-actions.pod:2295 ../fish/guestfish-actions.pod:1538
9922 "If the parameter C<nrlines> is a positive number, this returns the first "
9923 "C<nrlines> lines of the file C<path>."
9927 #: ../src/guestfs-actions.pod:2298 ../fish/guestfish-actions.pod:1541
9929 "If the parameter C<nrlines> is a negative number, this returns lines from "
9930 "the file C<path>, excluding the last C<nrlines> lines."
9934 #: ../src/guestfs-actions.pod:2301 ../src/guestfs-actions.pod:6566
9935 #: ../fish/guestfish-actions.pod:1544 ../fish/guestfish-actions.pod:4422
9936 msgid "If the parameter C<nrlines> is zero, this returns an empty list."
9940 #: ../src/guestfs-actions.pod:2312
9941 msgid "guestfs_hexdump"
9945 #: ../src/guestfs-actions.pod:2314
9949 " guestfs_hexdump (guestfs_h *g,\n"
9950 " const char *path);\n"
9955 #: ../src/guestfs-actions.pod:2318 ../fish/guestfish-actions.pod:1553
9957 "This runs C<hexdump -C> on the given C<path>. The result is the human-"
9958 "readable, canonical hex dump of the file."
9962 #: ../src/guestfs-actions.pod:2327 ../src/guestfs-actions.pod:6350
9963 #: ../src/guestfs-actions.pod:6405
9964 msgid "(Added in 1.0.22)"
9968 #: ../src/guestfs-actions.pod:2329
9969 msgid "guestfs_initrd_cat"
9973 #: ../src/guestfs-actions.pod:2331
9977 " guestfs_initrd_cat (guestfs_h *g,\n"
9978 " const char *initrdpath,\n"
9979 " const char *filename,\n"
9980 " size_t *size_r);\n"
9985 #: ../src/guestfs-actions.pod:2337 ../fish/guestfish-actions.pod:1563
9987 "This command unpacks the file C<filename> from the initrd file called "
9988 "C<initrdpath>. The filename must be given I<without> the initial C</> "
9993 #: ../src/guestfs-actions.pod:2341 ../fish/guestfish-actions.pod:1567
9995 "For example, in guestfish you could use the following command to examine the "
9996 "boot script (usually called C</init>) contained in a Linux initrd or "
10001 #: ../src/guestfs-actions.pod:2345 ../fish/guestfish-actions.pod:1571
10004 " initrd-cat /boot/initrd-<version>.img init\n"
10009 #: ../src/guestfs-actions.pod:2347
10010 msgid "See also C<guestfs_initrd_list>."
10014 #: ../src/guestfs-actions.pod:2358
10015 msgid "guestfs_initrd_list"
10019 #: ../src/guestfs-actions.pod:2360
10023 " guestfs_initrd_list (guestfs_h *g,\n"
10024 " const char *path);\n"
10029 #: ../src/guestfs-actions.pod:2364 ../fish/guestfish-actions.pod:1582
10030 msgid "This command lists out files contained in an initrd."
10034 #: ../src/guestfs-actions.pod:2366 ../fish/guestfish-actions.pod:1584
10036 "The files are listed without any initial C</> character. The files are "
10037 "listed in the order they appear (not necessarily alphabetical). Directory "
10038 "names are listed as separate items."
10042 #: ../src/guestfs-actions.pod:2370 ../fish/guestfish-actions.pod:1588
10044 "Old Linux kernels (2.4 and earlier) used a compressed ext2 filesystem as "
10045 "initrd. We I<only> support the newer initramfs format (compressed cpio "
10050 #: ../src/guestfs-actions.pod:2380
10051 msgid "guestfs_inotify_add_watch"
10055 #: ../src/guestfs-actions.pod:2382
10059 " guestfs_inotify_add_watch (guestfs_h *g,\n"
10060 " const char *path,\n"
10066 #: ../src/guestfs-actions.pod:2387 ../fish/guestfish-actions.pod:1596
10067 msgid "Watch C<path> for the events listed in C<mask>."
10071 #: ../src/guestfs-actions.pod:2389 ../fish/guestfish-actions.pod:1598
10073 "Note that if C<path> is a directory then events within that directory are "
10074 "watched, but this does I<not> happen recursively (in subdirectories)."
10078 #: ../src/guestfs-actions.pod:2393 ../fish/guestfish-actions.pod:1602
10080 "Note for non-C or non-Linux callers: the inotify events are defined by the "
10081 "Linux kernel ABI and are listed in C</usr/include/sys/inotify.h>."
10085 #: ../src/guestfs-actions.pod:2401
10086 msgid "guestfs_inotify_close"
10090 #: ../src/guestfs-actions.pod:2403
10094 " guestfs_inotify_close (guestfs_h *g);\n"
10099 #: ../src/guestfs-actions.pod:2406 ../fish/guestfish-actions.pod:1610
10101 "This closes the inotify handle which was previously opened by inotify_init. "
10102 "It removes all watches, throws away any pending events, and deallocates all "
10107 #: ../src/guestfs-actions.pod:2414
10108 msgid "guestfs_inotify_files"
10112 #: ../src/guestfs-actions.pod:2416
10116 " guestfs_inotify_files (guestfs_h *g);\n"
10121 #: ../src/guestfs-actions.pod:2419
10123 "This function is a helpful wrapper around C<guestfs_inotify_read> which just "
10124 "returns a list of pathnames of objects that were touched. The returned "
10125 "pathnames are sorted and deduplicated."
10129 #: ../src/guestfs-actions.pod:2429
10130 msgid "guestfs_inotify_init"
10134 #: ../src/guestfs-actions.pod:2431
10138 " guestfs_inotify_init (guestfs_h *g,\n"
10139 " int maxevents);\n"
10144 #: ../src/guestfs-actions.pod:2435 ../fish/guestfish-actions.pod:1626
10146 "This command creates a new inotify handle. The inotify subsystem can be "
10147 "used to notify events which happen to objects in the guest filesystem."
10151 #: ../src/guestfs-actions.pod:2439
10153 "C<maxevents> is the maximum number of events which will be queued up between "
10154 "calls to C<guestfs_inotify_read> or C<guestfs_inotify_files>. If this is "
10155 "passed as C<0>, then the kernel (or previously set) default is used. For "
10156 "Linux 2.6.29 the default was 16384 events. Beyond this limit, the kernel "
10157 "throws away events, but records the fact that it threw them away by setting "
10158 "a flag C<IN_Q_OVERFLOW> in the returned structure list (see "
10159 "C<guestfs_inotify_read>)."
10163 #: ../src/guestfs-actions.pod:2449
10165 "Before any events are generated, you have to add some watches to the "
10166 "internal watch list. See: C<guestfs_inotify_add_watch>, "
10167 "C<guestfs_inotify_rm_watch> and C<guestfs_inotify_watch_all>."
10171 #: ../src/guestfs-actions.pod:2455
10173 "Queued up events should be read periodically by calling "
10174 "C<guestfs_inotify_read> (or C<guestfs_inotify_files> which is just a helpful "
10175 "wrapper around C<guestfs_inotify_read>). If you don't read the events out "
10176 "often enough then you risk the internal queue overflowing."
10180 #: ../src/guestfs-actions.pod:2462
10182 "The handle should be closed after use by calling C<guestfs_inotify_close>. "
10183 "This also removes any watches automatically."
10187 #: ../src/guestfs-actions.pod:2466 ../fish/guestfish-actions.pod:1657
10189 "See also L<inotify(7)> for an overview of the inotify interface as exposed "
10190 "by the Linux kernel, which is roughly what we expose via libguestfs. Note "
10191 "that there is one global inotify handle per libguestfs instance."
10195 #: ../src/guestfs-actions.pod:2475
10196 msgid "guestfs_inotify_read"
10200 #: ../src/guestfs-actions.pod:2477
10203 " struct guestfs_inotify_event_list *\n"
10204 " guestfs_inotify_read (guestfs_h *g);\n"
10209 #: ../src/guestfs-actions.pod:2480 ../fish/guestfish-actions.pod:1666
10211 "Return the complete queue of events that have happened since the previous "
10216 #: ../src/guestfs-actions.pod:2483 ../fish/guestfish-actions.pod:1669
10217 msgid "If no events have happened, this returns an empty list."
10221 #: ../src/guestfs-actions.pod:2485 ../fish/guestfish-actions.pod:1671
10223 "I<Note>: In order to make sure that all events have been read, you must call "
10224 "this function repeatedly until it returns an empty list. The reason is that "
10225 "the call will read events up to the maximum appliance-to-host message size "
10226 "and leave remaining events in the queue."
10230 #: ../src/guestfs-actions.pod:2491
10232 "This function returns a C<struct guestfs_inotify_event_list *>, or NULL if "
10233 "there was an error. I<The caller must call "
10234 "C<guestfs_free_inotify_event_list> after use>."
10238 #: ../src/guestfs-actions.pod:2497
10239 msgid "guestfs_inotify_rm_watch"
10243 #: ../src/guestfs-actions.pod:2499
10247 " guestfs_inotify_rm_watch (guestfs_h *g,\n"
10253 #: ../src/guestfs-actions.pod:2503
10255 "Remove a previously defined inotify watch. See C<guestfs_inotify_add_watch>."
10259 #: ../src/guestfs-actions.pod:2510
10260 msgid "guestfs_inspect_get_arch"
10264 #: ../src/guestfs-actions.pod:2512
10268 " guestfs_inspect_get_arch (guestfs_h *g,\n"
10269 " const char *root);\n"
10274 #: ../src/guestfs-actions.pod:2516 ../src/guestfs-actions.pod:2539
10275 #: ../src/guestfs-actions.pod:2624 ../src/guestfs-actions.pod:2668
10276 #: ../src/guestfs-actions.pod:2694 ../src/guestfs-actions.pod:2733
10277 #: ../src/guestfs-actions.pod:2755 ../src/guestfs-actions.pod:2782
10278 #: ../src/guestfs-actions.pod:2803 ../src/guestfs-actions.pod:2846
10279 #: ../src/guestfs-actions.pod:2875 ../src/guestfs-actions.pod:2906
10280 #: ../src/guestfs-actions.pod:2930 ../src/guestfs-actions.pod:2985
10281 #: ../src/guestfs-actions.pod:3027 ../src/guestfs-actions.pod:3048
10282 #: ../src/guestfs-actions.pod:3071 ../src/guestfs-actions.pod:3088
10283 #: ../src/guestfs-actions.pod:3105 ../src/guestfs-actions.pod:3124
10285 "This function should only be called with a root device string as returned by "
10286 "C<guestfs_inspect_os>."
10290 #: ../src/guestfs-actions.pod:2519
10292 "This returns the architecture of the inspected operating system. The "
10293 "possible return values are listed under C<guestfs_file_architecture>."
10297 #: ../src/guestfs-actions.pod:2523 ../fish/guestfish-actions.pod:1695
10299 "If the architecture could not be determined, then the string C<unknown> is "
10304 #: ../src/guestfs-actions.pod:2526 ../src/guestfs-actions.pod:2611
10305 #: ../src/guestfs-actions.pod:2722 ../src/guestfs-actions.pod:2742
10306 #: ../src/guestfs-actions.pod:2770 ../src/guestfs-actions.pod:2862
10307 #: ../src/guestfs-actions.pod:2893 ../src/guestfs-actions.pod:2917
10308 #: ../src/guestfs-actions.pod:2971 ../src/guestfs-actions.pod:3014
10309 #: ../src/guestfs-actions.pod:3037 ../src/guestfs-actions.pod:3058
10310 #: ../src/guestfs-actions.pod:3078 ../src/guestfs-actions.pod:3095
10311 #: ../src/guestfs-actions.pod:3114 ../src/guestfs-actions.pod:3217
10312 #: ../src/guestfs-actions.pod:3258 ../fish/guestfish-actions.pod:1698
10313 #: ../fish/guestfish-actions.pod:1776 ../fish/guestfish-actions.pod:1864
10314 #: ../fish/guestfish-actions.pod:1879 ../fish/guestfish-actions.pod:1900
10315 #: ../fish/guestfish-actions.pod:1970 ../fish/guestfish-actions.pod:1994
10316 #: ../fish/guestfish-actions.pod:2011 ../fish/guestfish-actions.pod:2054
10317 #: ../fish/guestfish-actions.pod:2089 ../fish/guestfish-actions.pod:2105
10318 #: ../fish/guestfish-actions.pod:2121 ../fish/guestfish-actions.pod:2134
10319 #: ../fish/guestfish-actions.pod:2147 ../fish/guestfish-actions.pod:2162
10320 #: ../fish/guestfish-actions.pod:2261 ../fish/guestfish-actions.pod:2295
10321 msgid "Please read L<guestfs(3)/INSPECTION> for more details."
10325 #: ../src/guestfs-actions.pod:2533
10326 msgid "guestfs_inspect_get_distro"
10330 #: ../src/guestfs-actions.pod:2535
10334 " guestfs_inspect_get_distro (guestfs_h *g,\n"
10335 " const char *root);\n"
10340 #: ../src/guestfs-actions.pod:2542 ../fish/guestfish-actions.pod:1707
10342 "This returns the distro (distribution) of the inspected operating system."
10346 #: ../src/guestfs-actions.pod:2545 ../fish/guestfish-actions.pod:1710
10347 msgid "Currently defined distros are:"
10351 #: ../src/guestfs-actions.pod:2549 ../fish/guestfish-actions.pod:1714
10352 msgid "\"archlinux\""
10353 msgstr "\"archlinux\""
10356 #: ../src/guestfs-actions.pod:2551 ../fish/guestfish-actions.pod:1716
10357 msgid "Arch Linux."
10358 msgstr "Arch Linux."
10361 #: ../src/guestfs-actions.pod:2553 ../fish/guestfish-actions.pod:1718
10363 msgstr "\"debian\""
10366 #: ../src/guestfs-actions.pod:2555 ../fish/guestfish-actions.pod:1720
10371 #: ../src/guestfs-actions.pod:2557 ../fish/guestfish-actions.pod:1722
10373 msgstr "\"fedora\""
10376 #: ../src/guestfs-actions.pod:2559 ../fish/guestfish-actions.pod:1724
10381 #: ../src/guestfs-actions.pod:2561 ../fish/guestfish-actions.pod:1726
10383 msgstr "\"gentoo\""
10386 #: ../src/guestfs-actions.pod:2563 ../fish/guestfish-actions.pod:1728
10391 #: ../src/guestfs-actions.pod:2565 ../fish/guestfish-actions.pod:1730
10392 msgid "\"linuxmint\""
10393 msgstr "\"linuxmint\""
10396 #: ../src/guestfs-actions.pod:2567 ../fish/guestfish-actions.pod:1732
10397 msgid "Linux Mint."
10398 msgstr "Linux Mint."
10401 #: ../src/guestfs-actions.pod:2569 ../fish/guestfish-actions.pod:1734
10402 msgid "\"mandriva\""
10403 msgstr "\"mandriva\""
10406 #: ../src/guestfs-actions.pod:2571 ../fish/guestfish-actions.pod:1736
10411 #: ../src/guestfs-actions.pod:2573 ../fish/guestfish-actions.pod:1738
10416 #: ../src/guestfs-actions.pod:2575 ../fish/guestfish-actions.pod:1740
10421 #: ../src/guestfs-actions.pod:2577 ../fish/guestfish-actions.pod:1742
10423 msgstr "\"pardus\""
10426 #: ../src/guestfs-actions.pod:2579 ../fish/guestfish-actions.pod:1744
10431 #: ../src/guestfs-actions.pod:2581 ../fish/guestfish-actions.pod:1746
10432 msgid "\"redhat-based\""
10433 msgstr "\"redhat-based\""
10436 #: ../src/guestfs-actions.pod:2583 ../fish/guestfish-actions.pod:1748
10437 msgid "Some Red Hat-derived distro."
10438 msgstr "Дистрибутив, що походить від Red Hat."
10441 #: ../src/guestfs-actions.pod:2585 ../fish/guestfish-actions.pod:1750
10446 #: ../src/guestfs-actions.pod:2587 ../fish/guestfish-actions.pod:1752
10447 msgid "Red Hat Enterprise Linux and some derivatives."
10448 msgstr "Red Hat Enterprise Linux та деякі з похідних дистрибутивів."
10451 #: ../src/guestfs-actions.pod:2589 ../fish/guestfish-actions.pod:1754
10452 msgid "\"slackware\""
10456 #: ../src/guestfs-actions.pod:2591 ../fish/guestfish-actions.pod:1756
10461 #: ../src/guestfs-actions.pod:2593 ../fish/guestfish-actions.pod:1758
10463 msgstr "\"ubuntu\""
10466 #: ../src/guestfs-actions.pod:2595 ../fish/guestfish-actions.pod:1760
10471 #: ../src/guestfs-actions.pod:2597 ../src/guestfs-actions.pod:2713
10472 #: ../src/guestfs-actions.pod:3005 ../fish/guestfish-actions.pod:1762
10473 #: ../fish/guestfish-actions.pod:1855 ../fish/guestfish-actions.pod:2080
10474 msgid "\"unknown\""
10475 msgstr "\"unknown\""
10478 #: ../src/guestfs-actions.pod:2599 ../fish/guestfish-actions.pod:1764
10479 msgid "The distro could not be determined."
10480 msgstr "Дистрибутив, тип якого не вдалося визначити."
10483 #: ../src/guestfs-actions.pod:2601 ../src/guestfs-actions.pod:2997
10484 #: ../fish/guestfish-actions.pod:1766 ../fish/guestfish-actions.pod:2072
10485 msgid "\"windows\""
10486 msgstr "\"windows\""
10489 #: ../src/guestfs-actions.pod:2603 ../fish/guestfish-actions.pod:1768
10491 "Windows does not have distributions. This string is returned if the OS type "
10496 #: ../src/guestfs-actions.pod:2608 ../src/guestfs-actions.pod:2719
10497 #: ../src/guestfs-actions.pod:3011 ../fish/guestfish-actions.pod:1773
10498 #: ../fish/guestfish-actions.pod:1861 ../fish/guestfish-actions.pod:2086
10500 "Future versions of libguestfs may return other strings here. The caller "
10501 "should be prepared to handle any string."
10505 #: ../src/guestfs-actions.pod:2618
10506 msgid "guestfs_inspect_get_drive_mappings"
10510 #: ../src/guestfs-actions.pod:2620
10514 " guestfs_inspect_get_drive_mappings (guestfs_h *g,\n"
10515 " const char *root);\n"
10520 #: ../src/guestfs-actions.pod:2627 ../fish/guestfish-actions.pod:1785
10522 "This call is useful for Windows which uses a primitive system of assigning "
10523 "drive letters (like \"C:\") to partitions. This inspection API examines the "
10524 "Windows Registry to find out how disks/partitions are mapped to drive "
10525 "letters, and returns a hash table as in the example below:"
10529 #: ../src/guestfs-actions.pod:2633 ../fish/guestfish-actions.pod:1791
10532 " C => /dev/vda2\n"
10533 " E => /dev/vdb1\n"
10534 " F => /dev/vdc1\n"
10539 #: ../src/guestfs-actions.pod:2637 ../fish/guestfish-actions.pod:1795
10541 "Note that keys are drive letters. For Windows, the key is case insensitive "
10542 "and just contains the drive letter, without the customary colon separator "
10547 #: ../src/guestfs-actions.pod:2641 ../fish/guestfish-actions.pod:1799
10549 "In future we may support other operating systems that also used drive "
10550 "letters, but the keys for those might not be case insensitive and might be "
10551 "longer than 1 character. For example in OS-9, hard drives were named C<h0>, "
10556 #: ../src/guestfs-actions.pod:2646 ../fish/guestfish-actions.pod:1804
10558 "For Windows guests, currently only hard drive mappings are returned. "
10559 "Removable disks (eg. DVD-ROMs) are ignored."
10563 #: ../src/guestfs-actions.pod:2649 ../fish/guestfish-actions.pod:1807
10565 "For guests that do not use drive mappings, or if the drive mappings could "
10566 "not be determined, this returns an empty hash table."
10570 #: ../src/guestfs-actions.pod:2652
10572 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
10573 "C<guestfs_inspect_get_mountpoints>, C<guestfs_inspect_get_filesystems>."
10577 #: ../src/guestfs-actions.pod:2656 ../src/guestfs-actions.pod:2832
10578 #: ../src/guestfs-actions.pod:3592 ../src/guestfs-actions.pod:4802
10579 #: ../src/guestfs-actions.pod:6707
10581 "This function returns a NULL-terminated array of strings, or NULL if there "
10582 "was an error. The array of strings will always have length C<2n+1>, where "
10583 "C<n> keys and values alternate, followed by the trailing NULL entry. I<The "
10584 "caller must free the strings and the array after use>."
10588 #: ../src/guestfs-actions.pod:2662
10589 msgid "guestfs_inspect_get_filesystems"
10593 #: ../src/guestfs-actions.pod:2664
10597 " guestfs_inspect_get_filesystems (guestfs_h *g,\n"
10598 " const char *root);\n"
10603 #: ../src/guestfs-actions.pod:2671 ../fish/guestfish-actions.pod:1821
10605 "This returns a list of all the filesystems that we think are associated with "
10606 "this operating system. This includes the root filesystem, other ordinary "
10607 "filesystems, and non-mounted devices like swap partitions."
10611 #: ../src/guestfs-actions.pod:2676 ../fish/guestfish-actions.pod:1826
10613 "In the case of a multi-boot virtual machine, it is possible for a filesystem "
10614 "to be shared between operating systems."
10618 #: ../src/guestfs-actions.pod:2679
10620 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
10621 "C<guestfs_inspect_get_mountpoints>."
10625 #: ../src/guestfs-actions.pod:2688
10626 msgid "guestfs_inspect_get_format"
10630 #: ../src/guestfs-actions.pod:2690
10634 " guestfs_inspect_get_format (guestfs_h *g,\n"
10635 " const char *root);\n"
10640 #: ../src/guestfs-actions.pod:2697 ../fish/guestfish-actions.pod:1839
10642 "This returns the format of the inspected operating system. You can use it "
10643 "to detect install images, live CDs and similar."
10647 #: ../src/guestfs-actions.pod:2700 ../fish/guestfish-actions.pod:1842
10648 msgid "Currently defined formats are:"
10652 #: ../src/guestfs-actions.pod:2704 ../fish/guestfish-actions.pod:1846
10653 msgid "\"installed\""
10654 msgstr "\"installed\""
10657 #: ../src/guestfs-actions.pod:2706 ../fish/guestfish-actions.pod:1848
10658 msgid "This is an installed operating system."
10659 msgstr "Це встановлена операційна система."
10662 #: ../src/guestfs-actions.pod:2708 ../fish/guestfish-actions.pod:1850
10663 msgid "\"installer\""
10667 #: ../src/guestfs-actions.pod:2710 ../fish/guestfish-actions.pod:1852
10669 "The disk image being inspected is not an installed operating system, but a "
10670 "I<bootable> install disk, live CD, or similar."
10674 #: ../src/guestfs-actions.pod:2715 ../fish/guestfish-actions.pod:1857
10675 msgid "The format of this disk image is not known."
10679 #: ../src/guestfs-actions.pod:2727
10680 msgid "guestfs_inspect_get_hostname"
10684 #: ../src/guestfs-actions.pod:2729
10688 " guestfs_inspect_get_hostname (guestfs_h *g,\n"
10689 " const char *root);\n"
10694 #: ../src/guestfs-actions.pod:2736 ../fish/guestfish-actions.pod:1873
10696 "This function returns the hostname of the operating system as found by "
10697 "inspection of the guest's configuration files."
10701 #: ../src/guestfs-actions.pod:2739 ../fish/guestfish-actions.pod:1876
10703 "If the hostname could not be determined, then the string C<unknown> is "
10708 #: ../src/guestfs-actions.pod:2747
10709 msgid "(Added in 1.7.9)"
10713 #: ../src/guestfs-actions.pod:2749
10714 msgid "guestfs_inspect_get_major_version"
10718 #: ../src/guestfs-actions.pod:2751
10722 " guestfs_inspect_get_major_version (guestfs_h *g,\n"
10723 " const char *root);\n"
10728 #: ../src/guestfs-actions.pod:2758 ../fish/guestfish-actions.pod:1888
10730 "This returns the major version number of the inspected operating system."
10734 #: ../src/guestfs-actions.pod:2761 ../fish/guestfish-actions.pod:1891
10736 "Windows uses a consistent versioning scheme which is I<not> reflected in the "
10737 "popular public names used by the operating system. Notably the operating "
10738 "system known as \"Windows 7\" is really version 6.1 (ie. major = 6, minor = "
10739 "1). You can find out the real versions corresponding to releases of Windows "
10740 "by consulting Wikipedia or MSDN."
10744 #: ../src/guestfs-actions.pod:2768 ../src/guestfs-actions.pod:2788
10745 #: ../fish/guestfish-actions.pod:1898 ../fish/guestfish-actions.pod:1912
10746 msgid "If the version could not be determined, then C<0> is returned."
10750 #: ../src/guestfs-actions.pod:2776
10751 msgid "guestfs_inspect_get_minor_version"
10755 #: ../src/guestfs-actions.pod:2778
10759 " guestfs_inspect_get_minor_version (guestfs_h *g,\n"
10760 " const char *root);\n"
10765 #: ../src/guestfs-actions.pod:2785 ../fish/guestfish-actions.pod:1909
10767 "This returns the minor version number of the inspected operating system."
10771 #: ../src/guestfs-actions.pod:2790
10773 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
10774 "C<guestfs_inspect_get_major_version>."
10778 #: ../src/guestfs-actions.pod:2797
10779 msgid "guestfs_inspect_get_mountpoints"
10783 #: ../src/guestfs-actions.pod:2799
10787 " guestfs_inspect_get_mountpoints (guestfs_h *g,\n"
10788 " const char *root);\n"
10793 #: ../src/guestfs-actions.pod:2806 ../fish/guestfish-actions.pod:1924
10795 "This returns a hash of where we think the filesystems associated with this "
10796 "operating system should be mounted. Callers should note that this is at "
10797 "best an educated guess made by reading configuration files such as C</etc/"
10798 "fstab>. I<In particular note> that this may return filesystems which are "
10799 "non-existent or not mountable and callers should be prepared to handle or "
10800 "ignore failures if they try to mount them."
10804 #: ../src/guestfs-actions.pod:2815 ../fish/guestfish-actions.pod:1933
10806 "Each element in the returned hashtable has a key which is the path of the "
10807 "mountpoint (eg. C</boot>) and a value which is the filesystem that would be "
10808 "mounted there (eg. C</dev/sda1>)."
10812 #: ../src/guestfs-actions.pod:2820 ../fish/guestfish-actions.pod:1938
10814 "Non-mounted devices such as swap devices are I<not> returned in this list."
10818 #: ../src/guestfs-actions.pod:2823
10820 "For operating systems like Windows which still use drive letters, this call "
10821 "will only return an entry for the first drive \"mounted on\" C</>. For "
10822 "information about the mapping of drive letters to partitions, see "
10823 "C<guestfs_inspect_get_drive_mappings>."
10827 #: ../src/guestfs-actions.pod:2829
10829 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
10830 "C<guestfs_inspect_get_filesystems>."
10834 #: ../src/guestfs-actions.pod:2840
10835 msgid "guestfs_inspect_get_package_format"
10839 #: ../src/guestfs-actions.pod:2842
10843 " guestfs_inspect_get_package_format (guestfs_h *g,\n"
10844 " const char *root);\n"
10849 #: ../src/guestfs-actions.pod:2849
10851 "This function and C<guestfs_inspect_get_package_management> return the "
10852 "package format and package management tool used by the inspected operating "
10853 "system. For example for Fedora these functions would return C<rpm> (package "
10854 "format) and C<yum> (package management)."
10858 #: ../src/guestfs-actions.pod:2855 ../fish/guestfish-actions.pod:1963
10860 "This returns the string C<unknown> if we could not determine the package "
10861 "format I<or> if the operating system does not have a real packaging system "
10866 #: ../src/guestfs-actions.pod:2859 ../fish/guestfish-actions.pod:1967
10868 "Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>. "
10869 "Future versions of libguestfs may return other strings."
10873 #: ../src/guestfs-actions.pod:2867 ../src/guestfs-actions.pod:2898
10874 msgid "(Added in 1.7.5)"
10878 #: ../src/guestfs-actions.pod:2869
10879 msgid "guestfs_inspect_get_package_management"
10883 #: ../src/guestfs-actions.pod:2871
10887 " guestfs_inspect_get_package_management (guestfs_h *g,\n"
10888 " const char *root);\n"
10893 #: ../src/guestfs-actions.pod:2878
10895 "C<guestfs_inspect_get_package_format> and this function return the package "
10896 "format and package management tool used by the inspected operating system. "
10897 "For example for Fedora these functions would return C<rpm> (package format) "
10898 "and C<yum> (package management)."
10902 #: ../src/guestfs-actions.pod:2884 ../fish/guestfish-actions.pod:1985
10904 "This returns the string C<unknown> if we could not determine the package "
10905 "management tool I<or> if the operating system does not have a real packaging "
10906 "system (eg. Windows)."
10910 #: ../src/guestfs-actions.pod:2888 ../fish/guestfish-actions.pod:1989
10912 "Possible strings include: C<yum>, C<up2date>, C<apt> (for all Debian "
10913 "derivatives), C<portage>, C<pisi>, C<pacman>, C<urpmi>. Future versions of "
10914 "libguestfs may return other strings."
10918 #: ../src/guestfs-actions.pod:2900
10919 msgid "guestfs_inspect_get_product_name"
10923 #: ../src/guestfs-actions.pod:2902
10927 " guestfs_inspect_get_product_name (guestfs_h *g,\n"
10928 " const char *root);\n"
10933 #: ../src/guestfs-actions.pod:2909 ../fish/guestfish-actions.pod:2003
10935 "This returns the product name of the inspected operating system. The "
10936 "product name is generally some freeform string which can be displayed to the "
10937 "user, but should not be parsed by programs."
10941 #: ../src/guestfs-actions.pod:2914 ../fish/guestfish-actions.pod:2008
10943 "If the product name could not be determined, then the string C<unknown> is "
10948 #: ../src/guestfs-actions.pod:2924
10949 msgid "guestfs_inspect_get_product_variant"
10953 #: ../src/guestfs-actions.pod:2926
10957 " guestfs_inspect_get_product_variant (guestfs_h *g,\n"
10958 " const char *root);\n"
10963 #: ../src/guestfs-actions.pod:2933 ../fish/guestfish-actions.pod:2020
10965 #| msgid "This is an installed operating system."
10966 msgid "This returns the product variant of the inspected operating system."
10967 msgstr "Це встановлена операційна система."
10970 #: ../src/guestfs-actions.pod:2936 ../fish/guestfish-actions.pod:2023
10972 "For Windows guests, this returns the contents of the Registry key C<HKLM"
10973 "\\Software\\Microsoft\\Windows NT\\CurrentVersion> C<InstallationType> which "
10974 "is usually a string such as C<Client> or C<Server> (other values are "
10975 "possible). This can be used to distinguish consumer and enterprise versions "
10976 "of Windows that have the same version number (for example, Windows 7 and "
10977 "Windows 2008 Server are both version 6.1, but the former is C<Client> and "
10978 "the latter is C<Server>)."
10982 #: ../src/guestfs-actions.pod:2945 ../fish/guestfish-actions.pod:2032
10984 "For enterprise Linux guests, in future we intend this to return the product "
10985 "variant such as C<Desktop>, C<Server> and so on. But this is not "
10986 "implemented at present."
10990 #: ../src/guestfs-actions.pod:2949 ../fish/guestfish-actions.pod:2036
10992 "If the product variant could not be determined, then the string C<unknown> "
10997 #: ../src/guestfs-actions.pod:2952
10999 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
11000 "C<guestfs_inspect_get_product_name>, C<guestfs_inspect_get_major_version>."
11004 #: ../src/guestfs-actions.pod:2959
11005 msgid "guestfs_inspect_get_roots"
11009 #: ../src/guestfs-actions.pod:2961
11013 " guestfs_inspect_get_roots (guestfs_h *g);\n"
11018 #: ../src/guestfs-actions.pod:2964
11020 "This function is a convenient way to get the list of root devices, as "
11021 "returned from a previous call to C<guestfs_inspect_os>, but without redoing "
11022 "the whole inspection process."
11026 #: ../src/guestfs-actions.pod:2968
11028 "This returns an empty list if either no root devices were found or the "
11029 "caller has not called C<guestfs_inspect_os>."
11033 #: ../src/guestfs-actions.pod:2977
11034 msgid "(Added in 1.7.3)"
11038 #: ../src/guestfs-actions.pod:2979
11039 msgid "guestfs_inspect_get_type"
11043 #: ../src/guestfs-actions.pod:2981
11047 " guestfs_inspect_get_type (guestfs_h *g,\n"
11048 " const char *root);\n"
11053 #: ../src/guestfs-actions.pod:2988 ../fish/guestfish-actions.pod:2063
11055 "This returns the type of the inspected operating system. Currently defined "
11060 #: ../src/guestfs-actions.pod:2993 ../fish/guestfish-actions.pod:2068
11065 #: ../src/guestfs-actions.pod:2995 ../fish/guestfish-actions.pod:2070
11066 msgid "Any Linux-based operating system."
11070 #: ../src/guestfs-actions.pod:2999 ../fish/guestfish-actions.pod:2074
11071 msgid "Any Microsoft Windows operating system."
11075 #: ../src/guestfs-actions.pod:3001 ../fish/guestfish-actions.pod:2076
11076 msgid "\"freebsd\""
11077 msgstr "\"freebsd\""
11080 #: ../src/guestfs-actions.pod:3003 ../fish/guestfish-actions.pod:2078
11085 #: ../src/guestfs-actions.pod:3007 ../fish/guestfish-actions.pod:2082
11086 msgid "The operating system type could not be determined."
11090 #: ../src/guestfs-actions.pod:3021
11091 msgid "guestfs_inspect_get_windows_current_control_set"
11095 #: ../src/guestfs-actions.pod:3023
11099 " guestfs_inspect_get_windows_current_control_set (guestfs_h *g,\n"
11100 " const char *root);\n"
11105 #: ../src/guestfs-actions.pod:3030 ../fish/guestfish-actions.pod:2098
11107 "This returns the Windows CurrentControlSet of the inspected guest. The "
11108 "CurrentControlSet is a registry key name such as C<ControlSet001>."
11112 #: ../src/guestfs-actions.pod:3033 ../fish/guestfish-actions.pod:2101
11114 "This call assumes that the guest is Windows and that the Registry could be "
11115 "examined by inspection. If this is not the case then an error is returned."
11119 #: ../src/guestfs-actions.pod:3042
11120 msgid "guestfs_inspect_get_windows_systemroot"
11124 #: ../src/guestfs-actions.pod:3044
11128 " guestfs_inspect_get_windows_systemroot (guestfs_h *g,\n"
11129 " const char *root);\n"
11134 #: ../src/guestfs-actions.pod:3051 ../fish/guestfish-actions.pod:2114
11136 "This returns the Windows systemroot of the inspected guest. The systemroot "
11137 "is a directory path such as C</WINDOWS>."
11141 #: ../src/guestfs-actions.pod:3054 ../fish/guestfish-actions.pod:2117
11143 "This call assumes that the guest is Windows and that the systemroot could be "
11144 "determined by inspection. If this is not the case then an error is returned."
11148 #: ../src/guestfs-actions.pod:3063
11149 msgid "(Added in 1.5.25)"
11153 #: ../src/guestfs-actions.pod:3065
11154 msgid "guestfs_inspect_is_live"
11158 #: ../src/guestfs-actions.pod:3067
11162 " guestfs_inspect_is_live (guestfs_h *g,\n"
11163 " const char *root);\n"
11168 #: ../src/guestfs-actions.pod:3074
11170 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
11171 "disk), then this returns true if a live image was detected on the disk."
11175 #: ../src/guestfs-actions.pod:3082
11176 msgid "guestfs_inspect_is_multipart"
11180 #: ../src/guestfs-actions.pod:3084
11184 " guestfs_inspect_is_multipart (guestfs_h *g,\n"
11185 " const char *root);\n"
11190 #: ../src/guestfs-actions.pod:3091
11192 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
11193 "disk), then this returns true if the disk is part of a set."
11197 #: ../src/guestfs-actions.pod:3099
11198 msgid "guestfs_inspect_is_netinst"
11202 #: ../src/guestfs-actions.pod:3101
11206 " guestfs_inspect_is_netinst (guestfs_h *g,\n"
11207 " const char *root);\n"
11212 #: ../src/guestfs-actions.pod:3108
11214 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
11215 "disk), then this returns true if the disk is a network installer, ie. not a "
11216 "self-contained install CD but one which is likely to require network access "
11217 "to complete the install."
11221 #: ../src/guestfs-actions.pod:3118
11222 msgid "guestfs_inspect_list_applications"
11226 #: ../src/guestfs-actions.pod:3120
11229 " struct guestfs_application_list *\n"
11230 " guestfs_inspect_list_applications (guestfs_h *g,\n"
11231 " const char *root);\n"
11236 #: ../src/guestfs-actions.pod:3127 ../fish/guestfish-actions.pod:2171
11237 msgid "Return the list of applications installed in the operating system."
11241 #: ../src/guestfs-actions.pod:3129
11243 "I<Note:> This call works differently from other parts of the inspection "
11244 "API. You have to call C<guestfs_inspect_os>, then "
11245 "C<guestfs_inspect_get_mountpoints>, then mount up the disks, before calling "
11246 "this. Listing applications is a significantly more difficult operation "
11247 "which requires access to the full filesystem. Also note that unlike the "
11248 "other C<guestfs_inspect_get_*> calls which are just returning data cached in "
11249 "the libguestfs handle, this call actually reads parts of the mounted "
11250 "filesystems during the call."
11254 #: ../src/guestfs-actions.pod:3139 ../fish/guestfish-actions.pod:2183
11256 "This returns an empty list if the inspection code was not able to determine "
11257 "the list of applications."
11261 #: ../src/guestfs-actions.pod:3142 ../fish/guestfish-actions.pod:2186
11262 msgid "The application structure contains the following fields:"
11266 #: ../src/guestfs-actions.pod:3146 ../fish/guestfish-actions.pod:2190
11267 msgid "C<app_name>"
11268 msgstr "C<app_name>"
11271 #: ../src/guestfs-actions.pod:3148 ../fish/guestfish-actions.pod:2192
11273 "The name of the application. For Red Hat-derived and Debian-derived Linux "
11274 "guests, this is the package name."
11278 #: ../src/guestfs-actions.pod:3151 ../fish/guestfish-actions.pod:2195
11279 msgid "C<app_display_name>"
11280 msgstr "C<app_display_name>"
11283 #: ../src/guestfs-actions.pod:3153 ../fish/guestfish-actions.pod:2197
11285 "The display name of the application, sometimes localized to the install "
11286 "language of the guest operating system."
11290 #: ../src/guestfs-actions.pod:3156 ../fish/guestfish-actions.pod:2200
11292 "If unavailable this is returned as an empty string C<\"\">. Callers needing "
11293 "to display something can use C<app_name> instead."
11297 #: ../src/guestfs-actions.pod:3159 ../fish/guestfish-actions.pod:2203
11298 msgid "C<app_epoch>"
11299 msgstr "C<app_epoch>"
11302 #: ../src/guestfs-actions.pod:3161 ../fish/guestfish-actions.pod:2205
11304 "For package managers which use epochs, this contains the epoch of the "
11305 "package (an integer). If unavailable, this is returned as C<0>."
11309 #: ../src/guestfs-actions.pod:3164 ../fish/guestfish-actions.pod:2208
11310 msgid "C<app_version>"
11311 msgstr "C<app_version>"
11314 #: ../src/guestfs-actions.pod:3166 ../fish/guestfish-actions.pod:2210
11316 "The version string of the application or package. If unavailable this is "
11317 "returned as an empty string C<\"\">."
11321 #: ../src/guestfs-actions.pod:3169 ../fish/guestfish-actions.pod:2213
11322 msgid "C<app_release>"
11323 msgstr "C<app_release>"
11326 #: ../src/guestfs-actions.pod:3171 ../fish/guestfish-actions.pod:2215
11328 "The release string of the application or package, for package managers that "
11329 "use this. If unavailable this is returned as an empty string C<\"\">."
11333 #: ../src/guestfs-actions.pod:3175 ../fish/guestfish-actions.pod:2219
11334 msgid "C<app_install_path>"
11335 msgstr "C<app_install_path>"
11338 #: ../src/guestfs-actions.pod:3177 ../fish/guestfish-actions.pod:2221
11340 "The installation path of the application (on operating systems such as "
11341 "Windows which use installation paths). This path is in the format used by "
11342 "the guest operating system, it is not a libguestfs path."
11346 #: ../src/guestfs-actions.pod:3182 ../fish/guestfish-actions.pod:2226
11347 msgid "If unavailable this is returned as an empty string C<\"\">."
11351 #: ../src/guestfs-actions.pod:3184 ../fish/guestfish-actions.pod:2228
11352 msgid "C<app_trans_path>"
11353 msgstr "C<app_trans_path>"
11356 #: ../src/guestfs-actions.pod:3186 ../fish/guestfish-actions.pod:2230
11358 "The install path translated into a libguestfs path. If unavailable this is "
11359 "returned as an empty string C<\"\">."
11363 #: ../src/guestfs-actions.pod:3189 ../fish/guestfish-actions.pod:2233
11364 msgid "C<app_publisher>"
11365 msgstr "C<app_publisher>"
11368 #: ../src/guestfs-actions.pod:3191 ../fish/guestfish-actions.pod:2235
11370 "The name of the publisher of the application, for package managers that use "
11371 "this. If unavailable this is returned as an empty string C<\"\">."
11375 #: ../src/guestfs-actions.pod:3195 ../fish/guestfish-actions.pod:2239
11377 msgstr "C<app_url>"
11380 #: ../src/guestfs-actions.pod:3197 ../fish/guestfish-actions.pod:2241
11382 "The URL (eg. upstream URL) of the application. If unavailable this is "
11383 "returned as an empty string C<\"\">."
11387 #: ../src/guestfs-actions.pod:3200 ../fish/guestfish-actions.pod:2244
11388 msgid "C<app_source_package>"
11392 #: ../src/guestfs-actions.pod:3202 ../fish/guestfish-actions.pod:2246
11394 "For packaging systems which support this, the name of the source package. "
11395 "If unavailable this is returned as an empty string C<\"\">."
11399 #: ../src/guestfs-actions.pod:3205 ../fish/guestfish-actions.pod:2249
11400 msgid "C<app_summary>"
11404 #: ../src/guestfs-actions.pod:3207 ../fish/guestfish-actions.pod:2251
11406 "A short (usually one line) description of the application or package. If "
11407 "unavailable this is returned as an empty string C<\"\">."
11411 #: ../src/guestfs-actions.pod:3210 ../fish/guestfish-actions.pod:2254
11412 msgid "C<app_description>"
11416 #: ../src/guestfs-actions.pod:3212 ../fish/guestfish-actions.pod:2256
11418 "A longer description of the application or package. If unavailable this is "
11419 "returned as an empty string C<\"\">."
11423 #: ../src/guestfs-actions.pod:3219
11425 "This function returns a C<struct guestfs_application_list *>, or NULL if "
11426 "there was an error. I<The caller must call C<guestfs_free_application_list> "
11431 #: ../src/guestfs-actions.pod:3223
11432 msgid "(Added in 1.7.8)"
11436 #: ../src/guestfs-actions.pod:3225
11437 msgid "guestfs_inspect_os"
11441 #: ../src/guestfs-actions.pod:3227
11445 " guestfs_inspect_os (guestfs_h *g);\n"
11450 #: ../src/guestfs-actions.pod:3230 ../fish/guestfish-actions.pod:2267
11452 "This function uses other libguestfs functions and certain heuristics to "
11453 "inspect the disk(s) (usually disks belonging to a virtual machine), looking "
11454 "for operating systems."
11458 #: ../src/guestfs-actions.pod:3234 ../fish/guestfish-actions.pod:2271
11459 msgid "The list returned is empty if no operating systems were found."
11463 #: ../src/guestfs-actions.pod:3236 ../fish/guestfish-actions.pod:2273
11465 "If one operating system was found, then this returns a list with a single "
11466 "element, which is the name of the root filesystem of this operating system. "
11467 "It is also possible for this function to return a list containing more than "
11468 "one element, indicating a dual-boot or multi-boot virtual machine, with each "
11469 "element being the root filesystem of one of the operating systems."
11473 #: ../src/guestfs-actions.pod:3243
11475 "You can pass the root string(s) returned to other C<guestfs_inspect_get_*> "
11476 "functions in order to query further information about each operating system, "
11477 "such as the name and version."
11481 #: ../src/guestfs-actions.pod:3248
11483 "This function uses other libguestfs features such as C<guestfs_mount_ro> and "
11484 "C<guestfs_umount_all> in order to mount and unmount filesystems and look at "
11485 "the contents. This should be called with no disks currently mounted. The "
11486 "function may also use Augeas, so any existing Augeas handle will be closed."
11490 #: ../src/guestfs-actions.pod:3254 ../fish/guestfish-actions.pod:2291
11492 "This function cannot decrypt encrypted disks. The caller must do that first "
11493 "(supplying the necessary keys) if the disk is encrypted."
11497 #: ../src/guestfs-actions.pod:3260 ../src/guestfs-actions.pod:3550
11498 #: ../src/guestfs-actions.pod:3612
11499 msgid "See also C<guestfs_list_filesystems>."
11503 #: ../src/guestfs-actions.pod:3268
11504 msgid "guestfs_is_blockdev"
11508 #: ../src/guestfs-actions.pod:3270
11512 " guestfs_is_blockdev (guestfs_h *g,\n"
11513 " const char *path);\n"
11518 #: ../src/guestfs-actions.pod:3274 ../fish/guestfish-actions.pod:2303
11520 "This returns C<true> if and only if there is a block device with the given "
11525 #: ../src/guestfs-actions.pod:3277 ../src/guestfs-actions.pod:3306
11526 #: ../src/guestfs-actions.pod:3336 ../src/guestfs-actions.pod:3351
11527 #: ../src/guestfs-actions.pod:3367 ../src/guestfs-actions.pod:3423
11528 #: ../src/guestfs-actions.pod:3438
11529 msgid "See also C<guestfs_stat>."
11533 #: ../src/guestfs-actions.pod:3281 ../src/guestfs-actions.pod:3310
11534 #: ../src/guestfs-actions.pod:3355 ../src/guestfs-actions.pod:3427
11535 #: ../src/guestfs-actions.pod:3442
11536 msgid "(Added in 1.5.10)"
11540 #: ../src/guestfs-actions.pod:3283
11541 msgid "guestfs_is_busy"
11545 #: ../src/guestfs-actions.pod:3285
11549 " guestfs_is_busy (guestfs_h *g);\n"
11554 #: ../src/guestfs-actions.pod:3288 ../fish/guestfish-actions.pod:2312
11556 "This returns true iff this handle is busy processing a command (in the "
11561 #: ../src/guestfs-actions.pod:3297
11562 msgid "guestfs_is_chardev"
11566 #: ../src/guestfs-actions.pod:3299
11570 " guestfs_is_chardev (guestfs_h *g,\n"
11571 " const char *path);\n"
11576 #: ../src/guestfs-actions.pod:3303 ../fish/guestfish-actions.pod:2321
11578 "This returns C<true> if and only if there is a character device with the "
11579 "given C<path> name."
11583 #: ../src/guestfs-actions.pod:3312
11584 msgid "guestfs_is_config"
11588 #: ../src/guestfs-actions.pod:3314
11592 " guestfs_is_config (guestfs_h *g);\n"
11597 #: ../src/guestfs-actions.pod:3317 ../fish/guestfish-actions.pod:2330
11599 "This returns true iff this handle is being configured (in the C<CONFIG> "
11604 #: ../src/guestfs-actions.pod:3326
11605 msgid "guestfs_is_dir"
11609 #: ../src/guestfs-actions.pod:3328
11613 " guestfs_is_dir (guestfs_h *g,\n"
11614 " const char *path);\n"
11619 #: ../src/guestfs-actions.pod:3332 ../fish/guestfish-actions.pod:2339
11621 "This returns C<true> if and only if there is a directory with the given "
11622 "C<path> name. Note that it returns false for other objects like files."
11626 #: ../src/guestfs-actions.pod:3342
11627 msgid "guestfs_is_fifo"
11631 #: ../src/guestfs-actions.pod:3344
11635 " guestfs_is_fifo (guestfs_h *g,\n"
11636 " const char *path);\n"
11641 #: ../src/guestfs-actions.pod:3348 ../fish/guestfish-actions.pod:2349
11643 "This returns C<true> if and only if there is a FIFO (named pipe) with the "
11644 "given C<path> name."
11648 #: ../src/guestfs-actions.pod:3357
11649 msgid "guestfs_is_file"
11653 #: ../src/guestfs-actions.pod:3359
11657 " guestfs_is_file (guestfs_h *g,\n"
11658 " const char *path);\n"
11663 #: ../src/guestfs-actions.pod:3363 ../fish/guestfish-actions.pod:2358
11665 "This returns C<true> if and only if there is a regular file with the given "
11666 "C<path> name. Note that it returns false for other objects like directories."
11670 #: ../src/guestfs-actions.pod:3373
11671 msgid "guestfs_is_launching"
11675 #: ../src/guestfs-actions.pod:3375
11679 " guestfs_is_launching (guestfs_h *g);\n"
11684 #: ../src/guestfs-actions.pod:3378 ../fish/guestfish-actions.pod:2368
11686 "This returns true iff this handle is launching the subprocess (in the "
11687 "C<LAUNCHING> state)."
11691 #: ../src/guestfs-actions.pod:3387
11692 msgid "guestfs_is_lv"
11696 #: ../src/guestfs-actions.pod:3389
11700 " guestfs_is_lv (guestfs_h *g,\n"
11701 " const char *device);\n"
11706 #: ../src/guestfs-actions.pod:3393 ../fish/guestfish-actions.pod:2377
11708 "This command tests whether C<device> is a logical volume, and returns true "
11709 "iff this is the case."
11713 #: ../src/guestfs-actions.pod:3400
11714 msgid "guestfs_is_ready"
11718 #: ../src/guestfs-actions.pod:3402
11722 " guestfs_is_ready (guestfs_h *g);\n"
11727 #: ../src/guestfs-actions.pod:3405 ../fish/guestfish-actions.pod:2384
11729 "This returns true iff this handle is ready to accept commands (in the "
11734 #: ../src/guestfs-actions.pod:3414
11735 msgid "guestfs_is_socket"
11739 #: ../src/guestfs-actions.pod:3416
11743 " guestfs_is_socket (guestfs_h *g,\n"
11744 " const char *path);\n"
11749 #: ../src/guestfs-actions.pod:3420 ../fish/guestfish-actions.pod:2393
11751 "This returns C<true> if and only if there is a Unix domain socket with the "
11752 "given C<path> name."
11756 #: ../src/guestfs-actions.pod:3429
11757 msgid "guestfs_is_symlink"
11761 #: ../src/guestfs-actions.pod:3431
11765 " guestfs_is_symlink (guestfs_h *g,\n"
11766 " const char *path);\n"
11771 #: ../src/guestfs-actions.pod:3435 ../fish/guestfish-actions.pod:2402
11773 "This returns C<true> if and only if there is a symbolic link with the given "
11778 #: ../src/guestfs-actions.pod:3444
11779 msgid "guestfs_kill_subprocess"
11783 #: ../src/guestfs-actions.pod:3446
11787 " guestfs_kill_subprocess (guestfs_h *g);\n"
11792 #: ../src/guestfs-actions.pod:3449 ../fish/guestfish-actions.pod:2411
11793 msgid "This kills the qemu subprocess. You should never need to call this."
11797 #: ../src/guestfs-actions.pod:3455
11798 msgid "guestfs_launch"
11802 #: ../src/guestfs-actions.pod:3457
11806 " guestfs_launch (guestfs_h *g);\n"
11811 #: ../src/guestfs-actions.pod:3460 ../fish/guestfish-actions.pod:2419
11813 "Internally libguestfs is implemented by running a virtual machine using "
11818 #: ../src/guestfs-actions.pod:3463 ../fish/guestfish-actions.pod:2422
11820 "You should call this after configuring the handle (eg. adding drives) but "
11821 "before performing any actions."
11825 #: ../src/guestfs-actions.pod:3475
11826 msgid "guestfs_lchown"
11830 #: ../src/guestfs-actions.pod:3477
11834 " guestfs_lchown (guestfs_h *g,\n"
11837 " const char *path);\n"
11842 #: ../src/guestfs-actions.pod:3483
11844 "Change the file owner to C<owner> and group to C<group>. This is like "
11845 "C<guestfs_chown> but if C<path> is a symlink then the link itself is "
11846 "changed, not the target."
11850 #: ../src/guestfs-actions.pod:3495
11851 msgid "guestfs_lgetxattr"
11855 #: ../src/guestfs-actions.pod:3497
11859 " guestfs_lgetxattr (guestfs_h *g,\n"
11860 " const char *path,\n"
11861 " const char *name,\n"
11862 " size_t *size_r);\n"
11867 #: ../src/guestfs-actions.pod:3503 ../fish/guestfish-actions.pod:2441
11869 "Get a single extended attribute from file C<path> named C<name>. If C<path> "
11870 "is a symlink, then this call returns an extended attribute from the symlink."
11874 #: ../src/guestfs-actions.pod:3517
11875 msgid "See also: C<guestfs_lgetxattrs>, C<guestfs_getxattr>, L<attr(5)>."
11879 #: ../src/guestfs-actions.pod:3525
11880 msgid "guestfs_lgetxattrs"
11884 #: ../src/guestfs-actions.pod:3527
11887 " struct guestfs_xattr_list *\n"
11888 " guestfs_lgetxattrs (guestfs_h *g,\n"
11889 " const char *path);\n"
11894 #: ../src/guestfs-actions.pod:3531
11896 "This is the same as C<guestfs_getxattrs>, but if C<path> is a symbolic link, "
11897 "then it returns the extended attributes of the link itself."
11901 #: ../src/guestfs-actions.pod:3541
11902 msgid "guestfs_list_devices"
11906 #: ../src/guestfs-actions.pod:3543
11910 " guestfs_list_devices (guestfs_h *g);\n"
11915 #: ../src/guestfs-actions.pod:3546 ../fish/guestfish-actions.pod:2469
11916 msgid "List all the block devices."
11920 #: ../src/guestfs-actions.pod:3548 ../fish/guestfish-actions.pod:2471
11921 msgid "The full block device names are returned, eg. C</dev/sda>."
11925 #: ../src/guestfs-actions.pod:3558
11926 msgid "guestfs_list_filesystems"
11930 #: ../src/guestfs-actions.pod:3560
11934 " guestfs_list_filesystems (guestfs_h *g);\n"
11939 #: ../src/guestfs-actions.pod:3563 ../fish/guestfish-actions.pod:2479
11941 "This inspection command looks for filesystems on partitions, block devices "
11942 "and logical volumes, returning a list of devices containing filesystems and "
11947 #: ../src/guestfs-actions.pod:3567 ../fish/guestfish-actions.pod:2483
11949 "The return value is a hash, where the keys are the devices containing "
11950 "filesystems, and the values are the filesystem types. For example:"
11954 #: ../src/guestfs-actions.pod:3571 ../fish/guestfish-actions.pod:2487
11957 " \"/dev/sda1\" => \"ntfs\"\n"
11958 " \"/dev/sda2\" => \"ext2\"\n"
11959 " \"/dev/vg_guest/lv_root\" => \"ext4\"\n"
11960 " \"/dev/vg_guest/lv_swap\" => \"swap\"\n"
11965 #: ../src/guestfs-actions.pod:3576 ../fish/guestfish-actions.pod:2492
11967 "The value can have the special value \"unknown\", meaning the content of the "
11968 "device is undetermined or empty. \"swap\" means a Linux swap partition."
11972 #: ../src/guestfs-actions.pod:3580
11974 "This command runs other libguestfs commands, which might include "
11975 "C<guestfs_mount> and C<guestfs_umount>, and therefore you should use this "
11976 "soon after launch and only when nothing is mounted."
11980 #: ../src/guestfs-actions.pod:3584
11982 "Not all of the filesystems returned will be mountable. In particular, swap "
11983 "partitions are returned in the list. Also this command does not check that "
11984 "each filesystem found is valid and mountable, and some filesystems might be "
11985 "mountable but require special options. Filesystems may not all belong to a "
11986 "single logical operating system (use C<guestfs_inspect_os> to look for OSes)."
11990 #: ../src/guestfs-actions.pod:3598 ../src/guestfs-actions.pod:5203
11991 msgid "(Added in 1.5.15)"
11995 #: ../src/guestfs-actions.pod:3600
11996 msgid "guestfs_list_partitions"
12000 #: ../src/guestfs-actions.pod:3602
12004 " guestfs_list_partitions (guestfs_h *g);\n"
12009 #: ../src/guestfs-actions.pod:3605 ../fish/guestfish-actions.pod:2512
12010 msgid "List all the partitions detected on all block devices."
12014 #: ../src/guestfs-actions.pod:3607 ../fish/guestfish-actions.pod:2514
12015 msgid "The full partition device names are returned, eg. C</dev/sda1>"
12019 #: ../src/guestfs-actions.pod:3609
12021 "This does not return logical volumes. For that you will need to call "
12026 #: ../src/guestfs-actions.pod:3620
12031 #: ../src/guestfs-actions.pod:3622
12035 " guestfs_ll (guestfs_h *g,\n"
12036 " const char *directory);\n"
12041 #: ../src/guestfs-actions.pod:3626 ../fish/guestfish-actions.pod:2525
12043 "List the files in C<directory> (relative to the root directory, there is no "
12044 "cwd) in the format of 'ls -la'."
12048 #: ../src/guestfs-actions.pod:3629 ../fish/guestfish-actions.pod:2528
12050 "This command is mostly useful for interactive sessions. It is I<not> "
12051 "intended that you try to parse the output string."
12055 #: ../src/guestfs-actions.pod:3637
12060 #: ../src/guestfs-actions.pod:3639
12064 " guestfs_ln (guestfs_h *g,\n"
12065 " const char *target,\n"
12066 " const char *linkname);\n"
12071 #: ../src/guestfs-actions.pod:3644 ../fish/guestfish-actions.pod:2535
12072 msgid "This command creates a hard link using the C<ln> command."
12076 #: ../src/guestfs-actions.pod:3650
12077 msgid "guestfs_ln_f"
12081 #: ../src/guestfs-actions.pod:3652
12085 " guestfs_ln_f (guestfs_h *g,\n"
12086 " const char *target,\n"
12087 " const char *linkname);\n"
12092 #: ../src/guestfs-actions.pod:3657 ../fish/guestfish-actions.pod:2541
12094 "This command creates a hard link using the C<ln -f> command. The C<-f> "
12095 "option removes the link (C<linkname>) if it exists already."
12099 #: ../src/guestfs-actions.pod:3664
12100 msgid "guestfs_ln_s"
12104 #: ../src/guestfs-actions.pod:3666
12108 " guestfs_ln_s (guestfs_h *g,\n"
12109 " const char *target,\n"
12110 " const char *linkname);\n"
12115 #: ../src/guestfs-actions.pod:3671 ../fish/guestfish-actions.pod:2548
12116 msgid "This command creates a symbolic link using the C<ln -s> command."
12120 #: ../src/guestfs-actions.pod:3677
12121 msgid "guestfs_ln_sf"
12125 #: ../src/guestfs-actions.pod:3679
12129 " guestfs_ln_sf (guestfs_h *g,\n"
12130 " const char *target,\n"
12131 " const char *linkname);\n"
12136 #: ../src/guestfs-actions.pod:3684 ../fish/guestfish-actions.pod:2554
12138 "This command creates a symbolic link using the C<ln -sf> command, The C<-f> "
12139 "option removes the link (C<linkname>) if it exists already."
12143 #: ../src/guestfs-actions.pod:3691
12144 msgid "guestfs_lremovexattr"
12148 #: ../src/guestfs-actions.pod:3693
12152 " guestfs_lremovexattr (guestfs_h *g,\n"
12153 " const char *xattr,\n"
12154 " const char *path);\n"
12159 #: ../src/guestfs-actions.pod:3698
12161 "This is the same as C<guestfs_removexattr>, but if C<path> is a symbolic "
12162 "link, then it removes an extended attribute of the link itself."
12166 #: ../src/guestfs-actions.pod:3706
12171 #: ../src/guestfs-actions.pod:3708
12175 " guestfs_ls (guestfs_h *g,\n"
12176 " const char *directory);\n"
12181 #: ../src/guestfs-actions.pod:3712 ../fish/guestfish-actions.pod:2569
12183 "List the files in C<directory> (relative to the root directory, there is no "
12184 "cwd). The '.' and '..' entries are not returned, but hidden files are shown."
12188 #: ../src/guestfs-actions.pod:3716
12190 "This command is mostly useful for interactive sessions. Programs should "
12191 "probably use C<guestfs_readdir> instead."
12195 #: ../src/guestfs-actions.pod:3725
12196 msgid "guestfs_lsetxattr"
12200 #: ../src/guestfs-actions.pod:3727
12204 " guestfs_lsetxattr (guestfs_h *g,\n"
12205 " const char *xattr,\n"
12206 " const char *val,\n"
12208 " const char *path);\n"
12213 #: ../src/guestfs-actions.pod:3734
12215 "This is the same as C<guestfs_setxattr>, but if C<path> is a symbolic link, "
12216 "then it sets an extended attribute of the link itself."
12220 #: ../src/guestfs-actions.pod:3742
12221 msgid "guestfs_lstat"
12225 #: ../src/guestfs-actions.pod:3744
12228 " struct guestfs_stat *\n"
12229 " guestfs_lstat (guestfs_h *g,\n"
12230 " const char *path);\n"
12235 #: ../src/guestfs-actions.pod:3748 ../src/guestfs-actions.pod:6306
12236 #: ../fish/guestfish-actions.pod:2588 ../fish/guestfish-actions.pod:4257
12237 msgid "Returns file information for the given C<path>."
12241 #: ../src/guestfs-actions.pod:3750
12243 "This is the same as C<guestfs_stat> except that if C<path> is a symbolic "
12244 "link, then the link is stat-ed, not the file it refers to."
12248 #: ../src/guestfs-actions.pod:3754 ../fish/guestfish-actions.pod:2594
12249 msgid "This is the same as the C<lstat(2)> system call."
12253 #: ../src/guestfs-actions.pod:3756 ../src/guestfs-actions.pod:6310
12255 "This function returns a C<struct guestfs_stat *>, or NULL if there was an "
12256 "error. I<The caller must call C<guestfs_free_stat> after use>."
12260 #: ../src/guestfs-actions.pod:3760 ../src/guestfs-actions.pod:6314
12261 #: ../src/guestfs-actions.pod:6332 ../src/guestfs-actions.pod:6713
12262 msgid "(Added in 0.9.2)"
12266 #: ../src/guestfs-actions.pod:3762
12267 msgid "guestfs_lstatlist"
12271 #: ../src/guestfs-actions.pod:3764
12274 " struct guestfs_stat_list *\n"
12275 " guestfs_lstatlist (guestfs_h *g,\n"
12276 " const char *path,\n"
12277 " char *const *names);\n"
12282 #: ../src/guestfs-actions.pod:3769
12284 "This call allows you to perform the C<guestfs_lstat> operation on multiple "
12285 "files, where all files are in the directory C<path>. C<names> is the list "
12286 "of files from this directory."
12290 #: ../src/guestfs-actions.pod:3773 ../fish/guestfish-actions.pod:2604
12292 "On return you get a list of stat structs, with a one-to-one correspondence "
12293 "to the C<names> list. If any name did not exist or could not be lstat'd, "
12294 "then the C<ino> field of that structure is set to C<-1>."
12298 #: ../src/guestfs-actions.pod:3778
12300 "This call is intended for programs that want to efficiently list a directory "
12301 "contents without making many round-trips. See also C<guestfs_lxattrlist> "
12302 "for a similarly efficient call for getting extended attributes. Very long "
12303 "directory listings might cause the protocol message size to be exceeded, "
12304 "causing this call to fail. The caller must split up such requests into "
12305 "smaller groups of names."
12309 #: ../src/guestfs-actions.pod:3786
12311 "This function returns a C<struct guestfs_stat_list *>, or NULL if there was "
12312 "an error. I<The caller must call C<guestfs_free_stat_list> after use>."
12316 #: ../src/guestfs-actions.pod:3792
12317 msgid "guestfs_luks_add_key"
12321 #: ../src/guestfs-actions.pod:3794
12325 " guestfs_luks_add_key (guestfs_h *g,\n"
12326 " const char *device,\n"
12327 " const char *key,\n"
12328 " const char *newkey,\n"
12334 #: ../src/guestfs-actions.pod:3801 ../fish/guestfish-actions.pod:2621
12336 "This command adds a new key on LUKS device C<device>. C<key> is any "
12337 "existing key, and is used to access the device. C<newkey> is the new key to "
12338 "add. C<keyslot> is the key slot that will be replaced."
12342 #: ../src/guestfs-actions.pod:3806
12344 "Note that if C<keyslot> already contains a key, then this command will "
12345 "fail. You have to use C<guestfs_luks_kill_slot> first to remove that key."
12349 #: ../src/guestfs-actions.pod:3812 ../src/guestfs-actions.pod:3852
12350 #: ../src/guestfs-actions.pod:3875 ../src/guestfs-actions.pod:3895
12351 #: ../src/guestfs-actions.pod:3927 ../src/guestfs-actions.pod:3946
12353 "This function takes a key or passphrase parameter which could contain "
12354 "sensitive material. Read the section L</KEYS AND PASSPHRASES> for more "
12359 #: ../src/guestfs-actions.pod:3816 ../src/guestfs-actions.pod:3856
12360 #: ../src/guestfs-actions.pod:3879 ../src/guestfs-actions.pod:3899
12361 msgid "(Added in 1.5.2)"
12365 #: ../src/guestfs-actions.pod:3818
12366 msgid "guestfs_luks_close"
12370 #: ../src/guestfs-actions.pod:3820
12374 " guestfs_luks_close (guestfs_h *g,\n"
12375 " const char *device);\n"
12380 #: ../src/guestfs-actions.pod:3824
12382 "This closes a LUKS device that was created earlier by C<guestfs_luks_open> "
12383 "or C<guestfs_luks_open_ro>. The C<device> parameter must be the name of the "
12384 "LUKS mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
12385 "underlying block device."
12389 #: ../src/guestfs-actions.pod:3832 ../src/guestfs-actions.pod:3931
12390 #: ../src/guestfs-actions.pod:3950 ../src/guestfs-actions.pod:4000
12391 #: ../src/guestfs-actions.pod:4048
12392 msgid "(Added in 1.5.1)"
12396 #: ../src/guestfs-actions.pod:3834
12397 msgid "guestfs_luks_format"
12401 #: ../src/guestfs-actions.pod:3836
12405 " guestfs_luks_format (guestfs_h *g,\n"
12406 " const char *device,\n"
12407 " const char *key,\n"
12413 #: ../src/guestfs-actions.pod:3842 ../fish/guestfish-actions.pod:2647
12415 "This command erases existing data on C<device> and formats the device as a "
12416 "LUKS encrypted device. C<key> is the initial key, which is added to key "
12417 "slot C<slot>. (LUKS supports 8 key slots, numbered 0-7)."
12421 #: ../src/guestfs-actions.pod:3849 ../src/guestfs-actions.pod:3872
12422 #: ../src/guestfs-actions.pod:4012 ../src/guestfs-actions.pod:4954
12423 #: ../src/guestfs-actions.pod:5734 ../src/guestfs-actions.pod:6141
12424 #: ../src/guestfs-actions.pod:6164 ../src/guestfs-actions.pod:6190
12425 #: ../src/guestfs-actions.pod:7350 ../fish/guestfish-actions.pod:2655
12426 #: ../fish/guestfish-actions.pod:2668 ../fish/guestfish-actions.pod:2752
12427 #: ../fish/guestfish-actions.pod:3326 ../fish/guestfish-actions.pod:3846
12428 #: ../fish/guestfish-actions.pod:4156 ../fish/guestfish-actions.pod:4172
12429 #: ../fish/guestfish-actions.pod:4187 ../fish/guestfish-actions.pod:4902
12431 "B<This command is dangerous. Without careful use you can easily destroy all "
12436 #: ../src/guestfs-actions.pod:3858
12437 msgid "guestfs_luks_format_cipher"
12441 #: ../src/guestfs-actions.pod:3860
12445 " guestfs_luks_format_cipher (guestfs_h *g,\n"
12446 " const char *device,\n"
12447 " const char *key,\n"
12449 " const char *cipher);\n"
12454 #: ../src/guestfs-actions.pod:3867
12456 "This command is the same as C<guestfs_luks_format> but it also allows you to "
12457 "set the C<cipher> used."
12461 #: ../src/guestfs-actions.pod:3881
12462 msgid "guestfs_luks_kill_slot"
12466 #: ../src/guestfs-actions.pod:3883
12470 " guestfs_luks_kill_slot (guestfs_h *g,\n"
12471 " const char *device,\n"
12472 " const char *key,\n"
12478 #: ../src/guestfs-actions.pod:3889 ../fish/guestfish-actions.pod:2675
12480 "This command deletes the key in key slot C<keyslot> from the encrypted LUKS "
12481 "device C<device>. C<key> must be one of the I<other> keys."
12485 #: ../src/guestfs-actions.pod:3901
12486 msgid "guestfs_luks_open"
12490 #: ../src/guestfs-actions.pod:3903
12494 " guestfs_luks_open (guestfs_h *g,\n"
12495 " const char *device,\n"
12496 " const char *key,\n"
12497 " const char *mapname);\n"
12502 #: ../src/guestfs-actions.pod:3909 ../fish/guestfish-actions.pod:2686
12504 "This command opens a block device which has been encrypted according to the "
12505 "Linux Unified Key Setup (LUKS) standard."
12509 #: ../src/guestfs-actions.pod:3912 ../fish/guestfish-actions.pod:2689
12510 msgid "C<device> is the encrypted block device or partition."
12514 #: ../src/guestfs-actions.pod:3914 ../fish/guestfish-actions.pod:2691
12516 "The caller must supply one of the keys associated with the LUKS block "
12517 "device, in the C<key> parameter."
12521 #: ../src/guestfs-actions.pod:3917 ../fish/guestfish-actions.pod:2694
12523 "This creates a new block device called C</dev/mapper/mapname>. Reads and "
12524 "writes to this block device are decrypted from and encrypted to the "
12525 "underlying C<device> respectively."
12529 #: ../src/guestfs-actions.pod:3921
12531 "If this block device contains LVM volume groups, then calling "
12532 "C<guestfs_vgscan> followed by C<guestfs_vg_activate_all> will make them "
12537 #: ../src/guestfs-actions.pod:3933
12538 msgid "guestfs_luks_open_ro"
12542 #: ../src/guestfs-actions.pod:3935
12546 " guestfs_luks_open_ro (guestfs_h *g,\n"
12547 " const char *device,\n"
12548 " const char *key,\n"
12549 " const char *mapname);\n"
12554 #: ../src/guestfs-actions.pod:3941
12556 "This is the same as C<guestfs_luks_open> except that a read-only mapping is "
12561 #: ../src/guestfs-actions.pod:3952
12562 msgid "guestfs_lvcreate"
12566 #: ../src/guestfs-actions.pod:3954
12570 " guestfs_lvcreate (guestfs_h *g,\n"
12571 " const char *logvol,\n"
12572 " const char *volgroup,\n"
12578 #: ../src/guestfs-actions.pod:3960 ../fish/guestfish-actions.pod:2719
12580 "This creates an LVM logical volume called C<logvol> on the volume group "
12581 "C<volgroup>, with C<size> megabytes."
12585 #: ../src/guestfs-actions.pod:3967
12586 msgid "guestfs_lvm_canonical_lv_name"
12590 #: ../src/guestfs-actions.pod:3969
12594 " guestfs_lvm_canonical_lv_name (guestfs_h *g,\n"
12595 " const char *lvname);\n"
12600 #: ../src/guestfs-actions.pod:3973 ../fish/guestfish-actions.pod:2726
12602 "This converts alternative naming schemes for LVs that you might find to the "
12603 "canonical name. For example, C</dev/mapper/VG-LV> is converted to C</dev/VG/"
12608 #: ../src/guestfs-actions.pod:3977 ../fish/guestfish-actions.pod:2730
12610 "This command returns an error if the C<lvname> parameter does not refer to a "
12615 #: ../src/guestfs-actions.pod:3980
12616 msgid "See also C<guestfs_is_lv>."
12620 #: ../src/guestfs-actions.pod:3985
12621 msgid "(Added in 1.5.24)"
12625 #: ../src/guestfs-actions.pod:3987
12626 msgid "guestfs_lvm_clear_filter"
12630 #: ../src/guestfs-actions.pod:3989
12634 " guestfs_lvm_clear_filter (guestfs_h *g);\n"
12639 #: ../src/guestfs-actions.pod:3992
12641 "This undoes the effect of C<guestfs_lvm_set_filter>. LVM will be able to "
12642 "see every block device."
12646 #: ../src/guestfs-actions.pod:3995 ../src/guestfs-actions.pod:4037
12647 #: ../fish/guestfish-actions.pod:2742 ../fish/guestfish-actions.pod:2773
12649 "This command also clears the LVM cache and performs a volume group scan."
12653 #: ../src/guestfs-actions.pod:4002
12654 msgid "guestfs_lvm_remove_all"
12658 #: ../src/guestfs-actions.pod:4004
12662 " guestfs_lvm_remove_all (guestfs_h *g);\n"
12667 #: ../src/guestfs-actions.pod:4007 ../fish/guestfish-actions.pod:2749
12669 "This command removes all LVM logical volumes, volume groups and physical "
12674 #: ../src/guestfs-actions.pod:4017
12675 msgid "guestfs_lvm_set_filter"
12679 #: ../src/guestfs-actions.pod:4019
12683 " guestfs_lvm_set_filter (guestfs_h *g,\n"
12684 " char *const *devices);\n"
12689 #: ../src/guestfs-actions.pod:4023 ../fish/guestfish-actions.pod:2759
12691 "This sets the LVM device filter so that LVM will only be able to \"see\" the "
12692 "block devices in the list C<devices>, and will ignore all other attached "
12697 #: ../src/guestfs-actions.pod:4027 ../fish/guestfish-actions.pod:2763
12699 "Where disk image(s) contain duplicate PVs or VGs, this command is useful to "
12700 "get LVM to ignore the duplicates, otherwise LVM can get confused. Note also "
12701 "there are two types of duplication possible: either cloned PVs/VGs which "
12702 "have identical UUIDs; or VGs that are not cloned but just happen to have the "
12703 "same name. In normal operation you cannot create this situation, but you "
12704 "can do it outside LVM, eg. by cloning disk images or by bit twiddling "
12705 "inside the LVM metadata."
12709 #: ../src/guestfs-actions.pod:4040 ../fish/guestfish-actions.pod:2776
12710 msgid "You can filter whole block devices or individual partitions."
12714 #: ../src/guestfs-actions.pod:4042 ../fish/guestfish-actions.pod:2778
12716 "You cannot use this if any VG is currently in use (eg. contains a mounted "
12717 "filesystem), even if you are not filtering out that VG."
12721 #: ../src/guestfs-actions.pod:4050
12722 msgid "guestfs_lvremove"
12726 #: ../src/guestfs-actions.pod:4052
12730 " guestfs_lvremove (guestfs_h *g,\n"
12731 " const char *device);\n"
12736 #: ../src/guestfs-actions.pod:4056 ../fish/guestfish-actions.pod:2786
12738 "Remove an LVM logical volume C<device>, where C<device> is the path to the "
12739 "LV, such as C</dev/VG/LV>."
12743 #: ../src/guestfs-actions.pod:4059 ../fish/guestfish-actions.pod:2789
12745 "You can also remove all LVs in a volume group by specifying the VG name, C</"
12750 #: ../src/guestfs-actions.pod:4064 ../src/guestfs-actions.pod:5300
12751 #: ../src/guestfs-actions.pod:7089
12752 msgid "(Added in 1.0.13)"
12756 #: ../src/guestfs-actions.pod:4066
12757 msgid "guestfs_lvrename"
12761 #: ../src/guestfs-actions.pod:4068
12765 " guestfs_lvrename (guestfs_h *g,\n"
12766 " const char *logvol,\n"
12767 " const char *newlogvol);\n"
12772 #: ../src/guestfs-actions.pod:4073 ../fish/guestfish-actions.pod:2796
12773 msgid "Rename a logical volume C<logvol> with the new name C<newlogvol>."
12777 #: ../src/guestfs-actions.pod:4077 ../src/guestfs-actions.pod:7102
12778 msgid "(Added in 1.0.83)"
12782 #: ../src/guestfs-actions.pod:4079
12783 msgid "guestfs_lvresize"
12787 #: ../src/guestfs-actions.pod:4081
12791 " guestfs_lvresize (guestfs_h *g,\n"
12792 " const char *device,\n"
12798 #: ../src/guestfs-actions.pod:4086 ../fish/guestfish-actions.pod:2802
12800 "This resizes (expands or shrinks) an existing LVM logical volume to "
12801 "C<mbytes>. When reducing, data in the reduced part is lost."
12805 #: ../src/guestfs-actions.pod:4094
12806 msgid "guestfs_lvresize_free"
12810 #: ../src/guestfs-actions.pod:4096
12814 " guestfs_lvresize_free (guestfs_h *g,\n"
12815 " const char *lv,\n"
12821 #: ../src/guestfs-actions.pod:4101 ../fish/guestfish-actions.pod:2810
12823 "This expands an existing logical volume C<lv> so that it fills C<pc>% of the "
12824 "remaining free space in the volume group. Commonly you would call this with "
12825 "pc = 100 which expands the logical volume as much as possible, using all "
12826 "remaining free space in the volume group."
12830 #: ../src/guestfs-actions.pod:4109
12831 msgid "(Added in 1.3.3)"
12835 #: ../src/guestfs-actions.pod:4111
12836 msgid "guestfs_lvs"
12840 #: ../src/guestfs-actions.pod:4113
12844 " guestfs_lvs (guestfs_h *g);\n"
12849 #: ../src/guestfs-actions.pod:4116 ../fish/guestfish-actions.pod:2820
12851 "List all the logical volumes detected. This is the equivalent of the L<lvs"
12856 #: ../src/guestfs-actions.pod:4119 ../fish/guestfish-actions.pod:2823
12858 "This returns a list of the logical volume device names (eg. C</dev/"
12859 "VolGroup00/LogVol00>)."
12863 #: ../src/guestfs-actions.pod:4122
12864 msgid "See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>."
12868 #: ../src/guestfs-actions.pod:4130
12869 msgid "guestfs_lvs_full"
12873 #: ../src/guestfs-actions.pod:4132
12876 " struct guestfs_lvm_lv_list *\n"
12877 " guestfs_lvs_full (guestfs_h *g);\n"
12882 #: ../src/guestfs-actions.pod:4135 ../fish/guestfish-actions.pod:2832
12884 "List all the logical volumes detected. This is the equivalent of the L<lvs"
12885 "(8)> command. The \"full\" version includes all fields."
12889 #: ../src/guestfs-actions.pod:4138
12891 "This function returns a C<struct guestfs_lvm_lv_list *>, or NULL if there "
12892 "was an error. I<The caller must call C<guestfs_free_lvm_lv_list> after use>."
12896 #: ../src/guestfs-actions.pod:4144
12897 msgid "guestfs_lvuuid"
12901 #: ../src/guestfs-actions.pod:4146
12905 " guestfs_lvuuid (guestfs_h *g,\n"
12906 " const char *device);\n"
12911 #: ../src/guestfs-actions.pod:4150 ../fish/guestfish-actions.pod:2839
12912 msgid "This command returns the UUID of the LVM LV C<device>."
12916 #: ../src/guestfs-actions.pod:4157
12917 msgid "guestfs_lxattrlist"
12921 #: ../src/guestfs-actions.pod:4159
12924 " struct guestfs_xattr_list *\n"
12925 " guestfs_lxattrlist (guestfs_h *g,\n"
12926 " const char *path,\n"
12927 " char *const *names);\n"
12932 #: ../src/guestfs-actions.pod:4164 ../fish/guestfish-actions.pod:2845
12934 "This call allows you to get the extended attributes of multiple files, where "
12935 "all files are in the directory C<path>. C<names> is the list of files from "
12940 #: ../src/guestfs-actions.pod:4168 ../fish/guestfish-actions.pod:2849
12942 "On return you get a flat list of xattr structs which must be interpreted "
12943 "sequentially. The first xattr struct always has a zero-length C<attrname>. "
12944 "C<attrval> in this struct is zero-length to indicate there was an error "
12945 "doing C<lgetxattr> for this file, I<or> is a C string which is a decimal "
12946 "number (the number of following attributes for this file, which could be C<"
12947 "\"0\">). Then after the first xattr struct are the zero or more attributes "
12948 "for the first named file. This repeats for the second and subsequent files."
12952 #: ../src/guestfs-actions.pod:4178
12954 "This call is intended for programs that want to efficiently list a directory "
12955 "contents without making many round-trips. See also C<guestfs_lstatlist> for "
12956 "a similarly efficient call for getting standard stats. Very long directory "
12957 "listings might cause the protocol message size to be exceeded, causing this "
12958 "call to fail. The caller must split up such requests into smaller groups of "
12963 #: ../src/guestfs-actions.pod:4192
12964 msgid "guestfs_mkdir"
12968 #: ../src/guestfs-actions.pod:4194
12972 " guestfs_mkdir (guestfs_h *g,\n"
12973 " const char *path);\n"
12978 #: ../src/guestfs-actions.pod:4198 ../fish/guestfish-actions.pod:2871
12979 msgid "Create a directory named C<path>."
12983 #: ../src/guestfs-actions.pod:4204
12984 msgid "guestfs_mkdir_mode"
12988 #: ../src/guestfs-actions.pod:4206
12992 " guestfs_mkdir_mode (guestfs_h *g,\n"
12993 " const char *path,\n"
12999 #: ../src/guestfs-actions.pod:4211 ../fish/guestfish-actions.pod:2877
13001 "This command creates a directory, setting the initial permissions of the "
13002 "directory to C<mode>."
13006 #: ../src/guestfs-actions.pod:4214 ../fish/guestfish-actions.pod:2880
13008 "For common Linux filesystems, the actual mode which is set will be C<mode & "
13009 "~umask & 01777>. Non-native-Linux filesystems may interpret the mode in "
13014 #: ../src/guestfs-actions.pod:4218
13015 msgid "See also C<guestfs_mkdir>, C<guestfs_umask>"
13019 #: ../src/guestfs-actions.pod:4224
13020 msgid "guestfs_mkdir_p"
13024 #: ../src/guestfs-actions.pod:4226
13028 " guestfs_mkdir_p (guestfs_h *g,\n"
13029 " const char *path);\n"
13034 #: ../src/guestfs-actions.pod:4230 ../fish/guestfish-actions.pod:2890
13036 "Create a directory named C<path>, creating any parent directories as "
13037 "necessary. This is like the C<mkdir -p> shell command."
13041 #: ../src/guestfs-actions.pod:4237
13042 msgid "guestfs_mkdtemp"
13046 #: ../src/guestfs-actions.pod:4239
13050 " guestfs_mkdtemp (guestfs_h *g,\n"
13051 " const char *template);\n"
13056 #: ../src/guestfs-actions.pod:4243 ../fish/guestfish-actions.pod:2897
13058 "This command creates a temporary directory. The C<template> parameter "
13059 "should be a full pathname for the temporary directory name with the final "
13060 "six characters being \"XXXXXX\"."
13064 #: ../src/guestfs-actions.pod:4248 ../fish/guestfish-actions.pod:2902
13066 "For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\", the second one "
13067 "being suitable for Windows filesystems."
13071 #: ../src/guestfs-actions.pod:4251 ../fish/guestfish-actions.pod:2905
13072 msgid "The name of the temporary directory that was created is returned."
13076 #: ../src/guestfs-actions.pod:4254 ../fish/guestfish-actions.pod:2908
13077 msgid "The temporary directory is created with mode 0700 and is owned by root."
13081 #: ../src/guestfs-actions.pod:4257 ../fish/guestfish-actions.pod:2911
13083 "The caller is responsible for deleting the temporary directory and its "
13084 "contents after use."
13088 #: ../src/guestfs-actions.pod:4260 ../fish/guestfish-actions.pod:2914
13089 msgid "See also: L<mkdtemp(3)>"
13093 #: ../src/guestfs-actions.pod:4267
13094 msgid "guestfs_mke2fs_J"
13098 #: ../src/guestfs-actions.pod:4269
13102 " guestfs_mke2fs_J (guestfs_h *g,\n"
13103 " const char *fstype,\n"
13104 " int blocksize,\n"
13105 " const char *device,\n"
13106 " const char *journal);\n"
13111 #: ../src/guestfs-actions.pod:4276 ../fish/guestfish-actions.pod:2920
13113 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
13114 "C<journal>. It is equivalent to the command:"
13118 #: ../src/guestfs-actions.pod:4280 ../fish/guestfish-actions.pod:2924
13121 " mke2fs -t fstype -b blocksize -J device=<journal> <device>\n"
13126 #: ../src/guestfs-actions.pod:4282
13127 msgid "See also C<guestfs_mke2journal>."
13131 #: ../src/guestfs-actions.pod:4286 ../src/guestfs-actions.pod:4304
13132 #: ../src/guestfs-actions.pod:4322 ../src/guestfs-actions.pod:4338
13133 #: ../src/guestfs-actions.pod:4352 ../src/guestfs-actions.pod:4366
13134 #: ../src/guestfs-actions.pod:4425 ../src/guestfs-actions.pod:4690
13135 msgid "(Added in 1.0.68)"
13139 #: ../src/guestfs-actions.pod:4288
13140 msgid "guestfs_mke2fs_JL"
13144 #: ../src/guestfs-actions.pod:4290
13148 " guestfs_mke2fs_JL (guestfs_h *g,\n"
13149 " const char *fstype,\n"
13150 " int blocksize,\n"
13151 " const char *device,\n"
13152 " const char *label);\n"
13157 #: ../src/guestfs-actions.pod:4297 ../fish/guestfish-actions.pod:2932
13159 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
13160 "the journal labeled C<label>."
13164 #: ../src/guestfs-actions.pod:4300
13165 msgid "See also C<guestfs_mke2journal_L>."
13169 #: ../src/guestfs-actions.pod:4306
13170 msgid "guestfs_mke2fs_JU"
13174 #: ../src/guestfs-actions.pod:4308
13178 " guestfs_mke2fs_JU (guestfs_h *g,\n"
13179 " const char *fstype,\n"
13180 " int blocksize,\n"
13181 " const char *device,\n"
13182 " const char *uuid);\n"
13187 #: ../src/guestfs-actions.pod:4315 ../fish/guestfish-actions.pod:2941
13189 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
13190 "the journal with UUID C<uuid>."
13194 #: ../src/guestfs-actions.pod:4318
13195 msgid "See also C<guestfs_mke2journal_U>."
13199 #: ../src/guestfs-actions.pod:4324
13200 msgid "guestfs_mke2journal"
13204 #: ../src/guestfs-actions.pod:4326
13208 " guestfs_mke2journal (guestfs_h *g,\n"
13209 " int blocksize,\n"
13210 " const char *device);\n"
13215 #: ../src/guestfs-actions.pod:4331 ../fish/guestfish-actions.pod:2950
13217 "This creates an ext2 external journal on C<device>. It is equivalent to the "
13222 #: ../src/guestfs-actions.pod:4334 ../fish/guestfish-actions.pod:2953
13225 " mke2fs -O journal_dev -b blocksize device\n"
13230 #: ../src/guestfs-actions.pod:4340
13231 msgid "guestfs_mke2journal_L"
13235 #: ../src/guestfs-actions.pod:4342
13239 " guestfs_mke2journal_L (guestfs_h *g,\n"
13240 " int blocksize,\n"
13241 " const char *label,\n"
13242 " const char *device);\n"
13247 #: ../src/guestfs-actions.pod:4348 ../fish/guestfish-actions.pod:2959
13248 msgid "This creates an ext2 external journal on C<device> with label C<label>."
13252 #: ../src/guestfs-actions.pod:4354
13253 msgid "guestfs_mke2journal_U"
13257 #: ../src/guestfs-actions.pod:4356
13261 " guestfs_mke2journal_U (guestfs_h *g,\n"
13262 " int blocksize,\n"
13263 " const char *uuid,\n"
13264 " const char *device);\n"
13269 #: ../src/guestfs-actions.pod:4362 ../fish/guestfish-actions.pod:2965
13270 msgid "This creates an ext2 external journal on C<device> with UUID C<uuid>."
13274 #: ../src/guestfs-actions.pod:4368
13275 msgid "guestfs_mkfifo"
13279 #: ../src/guestfs-actions.pod:4370
13283 " guestfs_mkfifo (guestfs_h *g,\n"
13285 " const char *path);\n"
13290 #: ../src/guestfs-actions.pod:4375
13292 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
13293 "is just a convenient wrapper around C<guestfs_mknod>."
13297 #: ../src/guestfs-actions.pod:4385
13298 msgid "guestfs_mkfs"
13302 #: ../src/guestfs-actions.pod:4387
13306 " guestfs_mkfs (guestfs_h *g,\n"
13307 " const char *fstype,\n"
13308 " const char *device);\n"
13313 #: ../src/guestfs-actions.pod:4392 ../fish/guestfish-actions.pod:2981
13315 "This creates a filesystem on C<device> (usually a partition or LVM logical "
13316 "volume). The filesystem type is C<fstype>, for example C<ext3>."
13320 #: ../src/guestfs-actions.pod:4400
13321 msgid "guestfs_mkfs_b"
13325 #: ../src/guestfs-actions.pod:4402
13329 " guestfs_mkfs_b (guestfs_h *g,\n"
13330 " const char *fstype,\n"
13331 " int blocksize,\n"
13332 " const char *device);\n"
13337 #: ../src/guestfs-actions.pod:4408
13339 "This call is similar to C<guestfs_mkfs>, but it allows you to control the "
13340 "block size of the resulting filesystem. Supported block sizes depend on the "
13341 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
13345 #: ../src/guestfs-actions.pod:4413 ../src/guestfs-actions.pod:4456
13346 #: ../fish/guestfish-actions.pod:2994 ../fish/guestfish-actions.pod:3021
13348 "For VFAT and NTFS the C<blocksize> parameter is treated as the requested "
13353 #: ../src/guestfs-actions.pod:4418 ../fish/guestfish-actions.pod:2997
13355 "This function is deprecated. In new code, use the C<mkfs_opts> call instead."
13359 #: ../src/guestfs-actions.pod:4427
13360 msgid "guestfs_mkfs_opts"
13364 #: ../src/guestfs-actions.pod:4429
13368 " guestfs_mkfs_opts (guestfs_h *g,\n"
13369 " const char *fstype,\n"
13370 " const char *device,\n"
13376 #: ../src/guestfs-actions.pod:4440
13379 " GUESTFS_MKFS_OPTS_BLOCKSIZE, int blocksize,\n"
13380 " GUESTFS_MKFS_OPTS_FEATURES, const char *features,\n"
13385 #: ../src/guestfs-actions.pod:4443 ../fish/guestfish-actions.pod:3008
13387 "This function creates a filesystem on C<device>. The filesystem type is "
13388 "C<fstype>, for example C<ext3>."
13392 #: ../src/guestfs-actions.pod:4450 ../fish/guestfish-actions.pod:3015
13393 msgid "C<blocksize>"
13397 #: ../src/guestfs-actions.pod:4452 ../fish/guestfish-actions.pod:3017
13399 "The filesystem block size. Supported block sizes depend on the filesystem "
13400 "type, but typically they are C<1024>, C<2048> or C<4096> for Linux ext2/3 "
13405 #: ../src/guestfs-actions.pod:4459 ../fish/guestfish-actions.pod:3024
13406 msgid "For UFS block sizes, please see L<mkfs.ufs(8)>."
13410 #: ../src/guestfs-actions.pod:4461 ../fish/guestfish-actions.pod:3026
13411 msgid "C<features>"
13415 #: ../src/guestfs-actions.pod:4463 ../fish/guestfish-actions.pod:3028
13416 msgid "This passes the C<-O> parameter to the external mkfs program."
13420 #: ../src/guestfs-actions.pod:4465 ../fish/guestfish-actions.pod:3030
13422 "For certain filesystem types, this allows extra filesystem features to be "
13423 "selected. See L<mke2fs(8)> and L<mkfs.ufs(8)> for more details."
13427 #: ../src/guestfs-actions.pod:4469 ../fish/guestfish-actions.pod:3034
13429 "You cannot use this optional parameter with the C<gfs> or C<gfs2> filesystem "
13434 #: ../src/guestfs-actions.pod:4476
13435 msgid "(Added in 1.7.19)"
13439 #: ../src/guestfs-actions.pod:4478
13440 msgid "guestfs_mkfs_opts_va"
13444 #: ../src/guestfs-actions.pod:4480
13448 " guestfs_mkfs_opts_va (guestfs_h *g,\n"
13449 " const char *fstype,\n"
13450 " const char *device,\n"
13451 " va_list args);\n"
13456 #: ../src/guestfs-actions.pod:4486
13457 msgid "This is the \"va_list variant\" of L</guestfs_mkfs_opts>."
13461 #: ../src/guestfs-actions.pod:4490
13462 msgid "guestfs_mkfs_opts_argv"
13466 #: ../src/guestfs-actions.pod:4492
13470 " guestfs_mkfs_opts_argv (guestfs_h *g,\n"
13471 " const char *fstype,\n"
13472 " const char *device,\n"
13473 " const struct guestfs_mkfs_opts_argv *optargs);\n"
13478 #: ../src/guestfs-actions.pod:4498
13479 msgid "This is the \"argv variant\" of L</guestfs_mkfs_opts>."
13483 #: ../src/guestfs-actions.pod:4502
13484 msgid "guestfs_mkmountpoint"
13488 #: ../src/guestfs-actions.pod:4504
13492 " guestfs_mkmountpoint (guestfs_h *g,\n"
13493 " const char *exemptpath);\n"
13498 #: ../src/guestfs-actions.pod:4508
13500 "C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are specialized calls "
13501 "that can be used to create extra mountpoints before mounting the first "
13506 #: ../src/guestfs-actions.pod:4512 ../fish/guestfish-actions.pod:3049
13508 "These calls are I<only> necessary in some very limited circumstances, mainly "
13509 "the case where you want to mount a mix of unrelated and/or read-only "
13510 "filesystems together."
13514 #: ../src/guestfs-actions.pod:4516 ../fish/guestfish-actions.pod:3053
13516 "For example, live CDs often contain a \"Russian doll\" nest of filesystems, "
13517 "an ISO outer layer, with a squashfs image inside, with an ext2/3 image "
13518 "inside that. You can unpack this as follows in guestfish:"
13522 #: ../src/guestfs-actions.pod:4521 ../fish/guestfish-actions.pod:3058
13525 " add-ro Fedora-11-i686-Live.iso\n"
13527 " mkmountpoint /cd\n"
13528 " mkmountpoint /sqsh\n"
13529 " mkmountpoint /ext3fs\n"
13530 " mount /dev/sda /cd\n"
13531 " mount-loop /cd/LiveOS/squashfs.img /sqsh\n"
13532 " mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs\n"
13537 #: ../src/guestfs-actions.pod:4530 ../fish/guestfish-actions.pod:3067
13538 msgid "The inner filesystem is now unpacked under the /ext3fs mountpoint."
13542 #: ../src/guestfs-actions.pod:4532
13544 "C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>. You "
13545 "may get unexpected errors if you try to mix these calls. It is safest to "
13546 "manually unmount filesystems and remove mountpoints after use."
13550 #: ../src/guestfs-actions.pod:4536
13552 "C<guestfs_umount_all> unmounts filesystems by sorting the paths longest "
13553 "first, so for this to work for manual mountpoints, you must ensure that the "
13554 "innermost mountpoints have the longest pathnames, as in the example code "
13559 #: ../src/guestfs-actions.pod:4541 ../fish/guestfish-actions.pod:3078
13561 "For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>"
13565 #: ../src/guestfs-actions.pod:4543
13567 "Autosync [see C<guestfs_set_autosync>, this is set by default on handles] "
13568 "can cause C<guestfs_umount_all> to be called when the handle is closed which "
13569 "can also trigger these issues."
13573 #: ../src/guestfs-actions.pod:4549 ../src/guestfs-actions.pod:4808
13574 #: ../src/guestfs-actions.pod:5718
13575 msgid "(Added in 1.0.62)"
13579 #: ../src/guestfs-actions.pod:4551
13580 msgid "guestfs_mknod"
13584 #: ../src/guestfs-actions.pod:4553
13588 " guestfs_mknod (guestfs_h *g,\n"
13592 " const char *path);\n"
13597 #: ../src/guestfs-actions.pod:4560 ../fish/guestfish-actions.pod:3088
13599 "This call creates block or character special devices, or named pipes (FIFOs)."
13603 #: ../src/guestfs-actions.pod:4563 ../fish/guestfish-actions.pod:3091
13605 "The C<mode> parameter should be the mode, using the standard constants. "
13606 "C<devmajor> and C<devminor> are the device major and minor numbers, only "
13607 "used when creating block and character special devices."
13611 #: ../src/guestfs-actions.pod:4568
13613 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
13614 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
13615 "regular file). These constants are available in the standard Linux header "
13616 "files, or you can use C<guestfs_mknod_b>, C<guestfs_mknod_c> or "
13617 "C<guestfs_mkfifo> which are wrappers around this command which bitwise OR in "
13618 "the appropriate constant for you."
13622 #: ../src/guestfs-actions.pod:4582
13623 msgid "guestfs_mknod_b"
13627 #: ../src/guestfs-actions.pod:4584
13631 " guestfs_mknod_b (guestfs_h *g,\n"
13635 " const char *path);\n"
13640 #: ../src/guestfs-actions.pod:4591
13642 "This call creates a block device node called C<path> with mode C<mode> and "
13643 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
13644 "wrapper around C<guestfs_mknod>."
13648 #: ../src/guestfs-actions.pod:4601
13649 msgid "guestfs_mknod_c"
13653 #: ../src/guestfs-actions.pod:4603
13657 " guestfs_mknod_c (guestfs_h *g,\n"
13661 " const char *path);\n"
13666 #: ../src/guestfs-actions.pod:4610
13668 "This call creates a char device node called C<path> with mode C<mode> and "
13669 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
13670 "wrapper around C<guestfs_mknod>."
13674 #: ../src/guestfs-actions.pod:4620
13675 msgid "guestfs_mkswap"
13679 #: ../src/guestfs-actions.pod:4622
13683 " guestfs_mkswap (guestfs_h *g,\n"
13684 " const char *device);\n"
13689 #: ../src/guestfs-actions.pod:4626 ../fish/guestfish-actions.pod:3130
13690 msgid "Create a swap partition on C<device>."
13694 #: ../src/guestfs-actions.pod:4632
13695 msgid "guestfs_mkswap_L"
13699 #: ../src/guestfs-actions.pod:4634
13703 " guestfs_mkswap_L (guestfs_h *g,\n"
13704 " const char *label,\n"
13705 " const char *device);\n"
13710 #: ../src/guestfs-actions.pod:4639 ../fish/guestfish-actions.pod:3136
13711 msgid "Create a swap partition on C<device> with label C<label>."
13715 #: ../src/guestfs-actions.pod:4641 ../fish/guestfish-actions.pod:3138
13717 "Note that you cannot attach a swap label to a block device (eg. C</dev/"
13718 "sda>), just to a partition. This appears to be a limitation of the kernel "
13723 #: ../src/guestfs-actions.pod:4649
13724 msgid "guestfs_mkswap_U"
13728 #: ../src/guestfs-actions.pod:4651
13732 " guestfs_mkswap_U (guestfs_h *g,\n"
13733 " const char *uuid,\n"
13734 " const char *device);\n"
13739 #: ../src/guestfs-actions.pod:4656 ../fish/guestfish-actions.pod:3146
13740 msgid "Create a swap partition on C<device> with UUID C<uuid>."
13744 #: ../src/guestfs-actions.pod:4662
13745 msgid "guestfs_mkswap_file"
13749 #: ../src/guestfs-actions.pod:4664
13753 " guestfs_mkswap_file (guestfs_h *g,\n"
13754 " const char *path);\n"
13759 #: ../src/guestfs-actions.pod:4668 ../fish/guestfish-actions.pod:3152
13760 msgid "Create a swap file."
13764 #: ../src/guestfs-actions.pod:4670
13766 "This command just writes a swap file signature to an existing file. To "
13767 "create the file itself, use something like C<guestfs_fallocate>."
13771 #: ../src/guestfs-actions.pod:4677
13772 msgid "guestfs_modprobe"
13776 #: ../src/guestfs-actions.pod:4679
13780 " guestfs_modprobe (guestfs_h *g,\n"
13781 " const char *modulename);\n"
13786 #: ../src/guestfs-actions.pod:4683 ../fish/guestfish-actions.pod:3161
13787 msgid "This loads a kernel module in the appliance."
13791 #: ../src/guestfs-actions.pod:4685 ../fish/guestfish-actions.pod:3163
13793 "The kernel module must have been whitelisted when libguestfs was built (see "
13794 "C<appliance/kmod.whitelist.in> in the source)."
13798 #: ../src/guestfs-actions.pod:4692
13799 msgid "guestfs_mount"
13803 #: ../src/guestfs-actions.pod:4694
13807 " guestfs_mount (guestfs_h *g,\n"
13808 " const char *device,\n"
13809 " const char *mountpoint);\n"
13814 #: ../src/guestfs-actions.pod:4699 ../fish/guestfish-actions.pod:3170
13816 "Mount a guest disk at a position in the filesystem. Block devices are named "
13817 "C</dev/sda>, C</dev/sdb> and so on, as they were added to the guest. If "
13818 "those block devices contain partitions, they will have the usual names (eg. "
13819 "C</dev/sda1>). Also LVM C</dev/VG/LV>-style names can be used."
13823 #: ../src/guestfs-actions.pod:4705 ../fish/guestfish-actions.pod:3176
13825 "The rules are the same as for L<mount(2)>: A filesystem must first be "
13826 "mounted on C</> before others can be mounted. Other filesystems can only be "
13827 "mounted on directories which already exist."
13831 #: ../src/guestfs-actions.pod:4710 ../fish/guestfish-actions.pod:3181
13833 "The mounted filesystem is writable, if we have sufficient permissions on the "
13834 "underlying device."
13838 #: ../src/guestfs-actions.pod:4713
13840 "B<Important note:> When you use this call, the filesystem options C<sync> "
13841 "and C<noatime> are set implicitly. This was originally done because we "
13842 "thought it would improve reliability, but it turns out that I<-o sync> has a "
13843 "very large negative performance impact and negligible effect on "
13844 "reliability. Therefore we recommend that you avoid using C<guestfs_mount> "
13845 "in any code that needs performance, and instead use C<guestfs_mount_options> "
13846 "(use an empty string for the first parameter if you don't want any options)."
13850 #: ../src/guestfs-actions.pod:4727
13851 msgid "guestfs_mount_loop"
13855 #: ../src/guestfs-actions.pod:4729
13859 " guestfs_mount_loop (guestfs_h *g,\n"
13860 " const char *file,\n"
13861 " const char *mountpoint);\n"
13866 #: ../src/guestfs-actions.pod:4734 ../fish/guestfish-actions.pod:3198
13868 "This command lets you mount C<file> (a filesystem image in a file) on a "
13869 "mount point. It is entirely equivalent to the command C<mount -o loop file "
13874 #: ../src/guestfs-actions.pod:4742
13875 msgid "guestfs_mount_options"
13879 #: ../src/guestfs-actions.pod:4744
13883 " guestfs_mount_options (guestfs_h *g,\n"
13884 " const char *options,\n"
13885 " const char *device,\n"
13886 " const char *mountpoint);\n"
13891 #: ../src/guestfs-actions.pod:4750
13893 "This is the same as the C<guestfs_mount> command, but it allows you to set "
13894 "the mount options as for the L<mount(8)> I<-o> flag."
13898 #: ../src/guestfs-actions.pod:4754 ../fish/guestfish-actions.pod:3210
13900 "If the C<options> parameter is an empty string, then no options are passed "
13901 "(all options default to whatever the filesystem uses)."
13905 #: ../src/guestfs-actions.pod:4760 ../src/guestfs-actions.pod:4774
13906 #: ../src/guestfs-actions.pod:4791
13907 msgid "(Added in 1.0.10)"
13911 #: ../src/guestfs-actions.pod:4762
13912 msgid "guestfs_mount_ro"
13916 #: ../src/guestfs-actions.pod:4764
13920 " guestfs_mount_ro (guestfs_h *g,\n"
13921 " const char *device,\n"
13922 " const char *mountpoint);\n"
13927 #: ../src/guestfs-actions.pod:4769
13929 "This is the same as the C<guestfs_mount> command, but it mounts the "
13930 "filesystem with the read-only (I<-o ro>) flag."
13934 #: ../src/guestfs-actions.pod:4776
13935 msgid "guestfs_mount_vfs"
13939 #: ../src/guestfs-actions.pod:4778
13943 " guestfs_mount_vfs (guestfs_h *g,\n"
13944 " const char *options,\n"
13945 " const char *vfstype,\n"
13946 " const char *device,\n"
13947 " const char *mountpoint);\n"
13952 #: ../src/guestfs-actions.pod:4785
13954 "This is the same as the C<guestfs_mount> command, but it allows you to set "
13955 "both the mount options and the vfstype as for the L<mount(8)> I<-o> and I<-"
13960 #: ../src/guestfs-actions.pod:4793
13961 msgid "guestfs_mountpoints"
13965 #: ../src/guestfs-actions.pod:4795
13969 " guestfs_mountpoints (guestfs_h *g);\n"
13974 #: ../src/guestfs-actions.pod:4798
13976 "This call is similar to C<guestfs_mounts>. That call returns a list of "
13977 "devices. This one returns a hash table (map) of device name to directory "
13978 "where the device is mounted."
13982 #: ../src/guestfs-actions.pod:4810
13983 msgid "guestfs_mounts"
13987 #: ../src/guestfs-actions.pod:4812
13991 " guestfs_mounts (guestfs_h *g);\n"
13996 #: ../src/guestfs-actions.pod:4815 ../fish/guestfish-actions.pod:3241
13998 "This returns the list of currently mounted filesystems. It returns the list "
13999 "of devices (eg. C</dev/sda1>, C</dev/VG/LV>)."
14003 #: ../src/guestfs-actions.pod:4818 ../fish/guestfish-actions.pod:3244
14004 msgid "Some internal mounts are not shown."
14008 #: ../src/guestfs-actions.pod:4820
14009 msgid "See also: C<guestfs_mountpoints>"
14013 #: ../src/guestfs-actions.pod:4828
14018 #: ../src/guestfs-actions.pod:4830
14022 " guestfs_mv (guestfs_h *g,\n"
14023 " const char *src,\n"
14024 " const char *dest);\n"
14029 #: ../src/guestfs-actions.pod:4835 ../fish/guestfish-actions.pod:3252
14031 "This moves a file from C<src> to C<dest> where C<dest> is either a "
14032 "destination filename or destination directory."
14036 #: ../src/guestfs-actions.pod:4842
14037 msgid "guestfs_ntfs_3g_probe"
14041 #: ../src/guestfs-actions.pod:4844
14045 " guestfs_ntfs_3g_probe (guestfs_h *g,\n"
14047 " const char *device);\n"
14052 #: ../src/guestfs-actions.pod:4849 ../fish/guestfish-actions.pod:3259
14054 "This command runs the L<ntfs-3g.probe(8)> command which probes an NTFS "
14055 "C<device> for mountability. (Not all NTFS volumes can be mounted read-"
14056 "write, and some cannot be mounted at all)."
14060 #: ../src/guestfs-actions.pod:4853 ../fish/guestfish-actions.pod:3263
14062 "C<rw> is a boolean flag. Set it to true if you want to test if the volume "
14063 "can be mounted read-write. Set it to false if you want to test if the "
14064 "volume can be mounted read-only."
14068 #: ../src/guestfs-actions.pod:4857 ../fish/guestfish-actions.pod:3267
14070 "The return value is an integer which C<0> if the operation would succeed, or "
14071 "some non-zero value documented in the L<ntfs-3g.probe(8)> manual page."
14075 #: ../src/guestfs-actions.pod:4863
14076 msgid "(Added in 1.0.43)"
14080 #: ../src/guestfs-actions.pod:4865
14081 msgid "guestfs_ntfsresize"
14085 #: ../src/guestfs-actions.pod:4867
14089 " guestfs_ntfsresize (guestfs_h *g,\n"
14090 " const char *device);\n"
14095 #: ../src/guestfs-actions.pod:4871 ../fish/guestfish-actions.pod:3275
14097 "This command resizes an NTFS filesystem, expanding or shrinking it to the "
14098 "size of the underlying device. See also L<ntfsresize(8)>."
14102 #: ../src/guestfs-actions.pod:4879
14103 msgid "guestfs_ntfsresize_size"
14107 #: ../src/guestfs-actions.pod:4881
14111 " guestfs_ntfsresize_size (guestfs_h *g,\n"
14112 " const char *device,\n"
14113 " int64_t size);\n"
14118 #: ../src/guestfs-actions.pod:4886
14120 "This command is the same as C<guestfs_ntfsresize> except that it allows you "
14121 "to specify the new size (in bytes) explicitly."
14125 #: ../src/guestfs-actions.pod:4891 ../src/guestfs-actions.pod:5327
14126 #: ../src/guestfs-actions.pod:5400 ../src/guestfs-actions.pod:5666
14127 #: ../src/guestfs-actions.pod:7237
14128 msgid "(Added in 1.3.14)"
14132 #: ../src/guestfs-actions.pod:4893
14133 msgid "guestfs_part_add"
14137 #: ../src/guestfs-actions.pod:4895
14141 " guestfs_part_add (guestfs_h *g,\n"
14142 " const char *device,\n"
14143 " const char *prlogex,\n"
14144 " int64_t startsect,\n"
14145 " int64_t endsect);\n"
14150 #: ../src/guestfs-actions.pod:4902
14152 "This command adds a partition to C<device>. If there is no partition table "
14153 "on the device, call C<guestfs_part_init> first."
14157 #: ../src/guestfs-actions.pod:4905 ../fish/guestfish-actions.pod:3293
14159 "The C<prlogex> parameter is the type of partition. Normally you should pass "
14160 "C<p> or C<primary> here, but MBR partition tables also support C<l> (or "
14161 "C<logical>) and C<e> (or C<extended>) partition types."
14165 #: ../src/guestfs-actions.pod:4910 ../fish/guestfish-actions.pod:3298
14167 "C<startsect> and C<endsect> are the start and end of the partition in "
14168 "I<sectors>. C<endsect> may be negative, which means it counts backwards "
14169 "from the end of the disk (C<-1> is the last sector)."
14173 #: ../src/guestfs-actions.pod:4914
14175 "Creating a partition which covers the whole disk is not so easy. Use "
14176 "C<guestfs_part_disk> to do that."
14180 #: ../src/guestfs-actions.pod:4919 ../src/guestfs-actions.pod:4957
14181 #: ../src/guestfs-actions.pod:5010 ../src/guestfs-actions.pod:5088
14182 #: ../src/guestfs-actions.pod:5126 ../src/guestfs-actions.pod:5145
14183 #: ../src/guestfs-actions.pod:5185
14184 msgid "(Added in 1.0.78)"
14188 #: ../src/guestfs-actions.pod:4921
14189 msgid "guestfs_part_del"
14193 #: ../src/guestfs-actions.pod:4923
14197 " guestfs_part_del (guestfs_h *g,\n"
14198 " const char *device,\n"
14204 #: ../src/guestfs-actions.pod:4928 ../fish/guestfish-actions.pod:3309
14205 msgid "This command deletes the partition numbered C<partnum> on C<device>."
14209 #: ../src/guestfs-actions.pod:4930 ../fish/guestfish-actions.pod:3311
14211 "Note that in the case of MBR partitioning, deleting an extended partition "
14212 "also deletes any logical partitions it contains."
14216 #: ../src/guestfs-actions.pod:4938
14217 msgid "guestfs_part_disk"
14221 #: ../src/guestfs-actions.pod:4940
14225 " guestfs_part_disk (guestfs_h *g,\n"
14226 " const char *device,\n"
14227 " const char *parttype);\n"
14232 #: ../src/guestfs-actions.pod:4945
14234 "This command is simply a combination of C<guestfs_part_init> followed by "
14235 "C<guestfs_part_add> to create a single primary partition covering the whole "
14240 #: ../src/guestfs-actions.pod:4949
14242 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
14243 "possible values are described in C<guestfs_part_init>."
14247 #: ../src/guestfs-actions.pod:4959
14248 msgid "guestfs_part_get_bootable"
14252 #: ../src/guestfs-actions.pod:4961
14256 " guestfs_part_get_bootable (guestfs_h *g,\n"
14257 " const char *device,\n"
14263 #: ../src/guestfs-actions.pod:4966 ../fish/guestfish-actions.pod:3333
14265 "This command returns true if the partition C<partnum> on C<device> has the "
14266 "bootable flag set."
14270 #: ../src/guestfs-actions.pod:4969
14271 msgid "See also C<guestfs_part_set_bootable>."
14275 #: ../src/guestfs-actions.pod:4975
14276 msgid "guestfs_part_get_mbr_id"
14280 #: ../src/guestfs-actions.pod:4977
14284 " guestfs_part_get_mbr_id (guestfs_h *g,\n"
14285 " const char *device,\n"
14291 #: ../src/guestfs-actions.pod:4982 ../fish/guestfish-actions.pod:3342
14293 "Returns the MBR type byte (also known as the ID byte) from the numbered "
14294 "partition C<partnum>."
14298 #: ../src/guestfs-actions.pod:4985 ../src/guestfs-actions.pod:5161
14300 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
14301 "undefined results for other partition table types (see "
14302 "C<guestfs_part_get_parttype>)."
14306 #: ../src/guestfs-actions.pod:4993
14307 msgid "guestfs_part_get_parttype"
14311 #: ../src/guestfs-actions.pod:4995
14315 " guestfs_part_get_parttype (guestfs_h *g,\n"
14316 " const char *device);\n"
14321 #: ../src/guestfs-actions.pod:4999 ../fish/guestfish-actions.pod:3353
14323 "This command examines the partition table on C<device> and returns the "
14324 "partition table type (format) being used."
14328 #: ../src/guestfs-actions.pod:5002
14330 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
14331 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
14332 "possible, although unusual. See C<guestfs_part_init> for a full list."
14336 #: ../src/guestfs-actions.pod:5012
14337 msgid "guestfs_part_init"
14341 #: ../src/guestfs-actions.pod:5014
14345 " guestfs_part_init (guestfs_h *g,\n"
14346 " const char *device,\n"
14347 " const char *parttype);\n"
14352 #: ../src/guestfs-actions.pod:5019 ../fish/guestfish-actions.pod:3365
14354 "This creates an empty partition table on C<device> of one of the partition "
14355 "types listed below. Usually C<parttype> should be either C<msdos> or C<gpt> "
14356 "(for large disks)."
14360 #: ../src/guestfs-actions.pod:5023
14362 "Initially there are no partitions. Following this, you should call "
14363 "C<guestfs_part_add> for each partition required."
14367 #: ../src/guestfs-actions.pod:5026 ../fish/guestfish-actions.pod:3372
14368 msgid "Possible values for C<parttype> are:"
14372 #: ../src/guestfs-actions.pod:5030 ../fish/guestfish-actions.pod:3376
14373 msgid "B<efi> | B<gpt>"
14377 #: ../src/guestfs-actions.pod:5032 ../fish/guestfish-actions.pod:3378
14378 msgid "Intel EFI / GPT partition table."
14382 #: ../src/guestfs-actions.pod:5034 ../fish/guestfish-actions.pod:3380
14384 "This is recommended for >= 2 TB partitions that will be accessed from Linux "
14385 "and Intel-based Mac OS X. It also has limited backwards compatibility with "
14386 "the C<mbr> format."
14390 #: ../src/guestfs-actions.pod:5038 ../fish/guestfish-actions.pod:3384
14391 msgid "B<mbr> | B<msdos>"
14395 #: ../src/guestfs-actions.pod:5040 ../fish/guestfish-actions.pod:3386
14397 "The standard PC \"Master Boot Record\" (MBR) format used by MS-DOS and "
14398 "Windows. This partition type will B<only> work for device sizes up to 2 "
14399 "TB. For large disks we recommend using C<gpt>."
14403 #: ../src/guestfs-actions.pod:5047 ../fish/guestfish-actions.pod:3393
14405 "Other partition table types that may work but are not supported include:"
14409 #: ../src/guestfs-actions.pod:5052 ../fish/guestfish-actions.pod:3398
14414 #: ../src/guestfs-actions.pod:5054 ../fish/guestfish-actions.pod:3400
14415 msgid "AIX disk labels."
14419 #: ../src/guestfs-actions.pod:5056 ../fish/guestfish-actions.pod:3402
14420 msgid "B<amiga> | B<rdb>"
14424 #: ../src/guestfs-actions.pod:5058 ../fish/guestfish-actions.pod:3404
14425 msgid "Amiga \"Rigid Disk Block\" format."
14429 #: ../src/guestfs-actions.pod:5060 ../fish/guestfish-actions.pod:3406
14434 #: ../src/guestfs-actions.pod:5062 ../fish/guestfish-actions.pod:3408
14435 msgid "BSD disk labels."
14439 #: ../src/guestfs-actions.pod:5064 ../fish/guestfish-actions.pod:3410
14444 #: ../src/guestfs-actions.pod:5066 ../fish/guestfish-actions.pod:3412
14445 msgid "DASD, used on IBM mainframes."
14449 #: ../src/guestfs-actions.pod:5068 ../fish/guestfish-actions.pod:3414
14454 #: ../src/guestfs-actions.pod:5070 ../fish/guestfish-actions.pod:3416
14455 msgid "MIPS/SGI volumes."
14459 #: ../src/guestfs-actions.pod:5072 ../fish/guestfish-actions.pod:3418
14464 #: ../src/guestfs-actions.pod:5074 ../fish/guestfish-actions.pod:3420
14465 msgid "Old Mac partition format. Modern Macs use C<gpt>."
14469 #: ../src/guestfs-actions.pod:5076 ../fish/guestfish-actions.pod:3422
14474 #: ../src/guestfs-actions.pod:5078 ../fish/guestfish-actions.pod:3424
14475 msgid "NEC PC-98 format, common in Japan apparently."
14479 #: ../src/guestfs-actions.pod:5080 ../fish/guestfish-actions.pod:3426
14484 #: ../src/guestfs-actions.pod:5082 ../fish/guestfish-actions.pod:3428
14485 msgid "Sun disk labels."
14489 #: ../src/guestfs-actions.pod:5090
14490 msgid "guestfs_part_list"
14494 #: ../src/guestfs-actions.pod:5092
14497 " struct guestfs_partition_list *\n"
14498 " guestfs_part_list (guestfs_h *g,\n"
14499 " const char *device);\n"
14504 #: ../src/guestfs-actions.pod:5096 ../fish/guestfish-actions.pod:3436
14506 "This command parses the partition table on C<device> and returns the list of "
14507 "partitions found."
14511 #: ../src/guestfs-actions.pod:5099 ../fish/guestfish-actions.pod:3439
14512 msgid "The fields in the returned structure are:"
14516 #: ../src/guestfs-actions.pod:5103 ../fish/guestfish-actions.pod:3443
14517 msgid "B<part_num>"
14521 #: ../src/guestfs-actions.pod:5105 ../fish/guestfish-actions.pod:3445
14522 msgid "Partition number, counting from 1."
14526 #: ../src/guestfs-actions.pod:5107 ../fish/guestfish-actions.pod:3447
14527 msgid "B<part_start>"
14531 #: ../src/guestfs-actions.pod:5109
14533 "Start of the partition I<in bytes>. To get sectors you have to divide by "
14534 "the device's sector size, see C<guestfs_blockdev_getss>."
14538 #: ../src/guestfs-actions.pod:5112 ../fish/guestfish-actions.pod:3452
14539 msgid "B<part_end>"
14543 #: ../src/guestfs-actions.pod:5114 ../fish/guestfish-actions.pod:3454
14544 msgid "End of the partition in bytes."
14548 #: ../src/guestfs-actions.pod:5116 ../fish/guestfish-actions.pod:3456
14549 msgid "B<part_size>"
14553 #: ../src/guestfs-actions.pod:5118 ../fish/guestfish-actions.pod:3458
14554 msgid "Size of the partition in bytes."
14558 #: ../src/guestfs-actions.pod:5122
14560 "This function returns a C<struct guestfs_partition_list *>, or NULL if there "
14561 "was an error. I<The caller must call C<guestfs_free_partition_list> after "
14566 #: ../src/guestfs-actions.pod:5128
14567 msgid "guestfs_part_set_bootable"
14571 #: ../src/guestfs-actions.pod:5130
14575 " guestfs_part_set_bootable (guestfs_h *g,\n"
14576 " const char *device,\n"
14578 " int bootable);\n"
14583 #: ../src/guestfs-actions.pod:5136 ../fish/guestfish-actions.pod:3466
14585 "This sets the bootable flag on partition numbered C<partnum> on device "
14586 "C<device>. Note that partitions are numbered from 1."
14590 #: ../src/guestfs-actions.pod:5139 ../fish/guestfish-actions.pod:3469
14592 "The bootable flag is used by some operating systems (notably Windows) to "
14593 "determine which partition to boot from. It is by no means universally "
14598 #: ../src/guestfs-actions.pod:5147
14599 msgid "guestfs_part_set_mbr_id"
14603 #: ../src/guestfs-actions.pod:5149
14607 " guestfs_part_set_mbr_id (guestfs_h *g,\n"
14608 " const char *device,\n"
14615 #: ../src/guestfs-actions.pod:5155 ../fish/guestfish-actions.pod:3477
14617 "Sets the MBR type byte (also known as the ID byte) of the numbered partition "
14618 "C<partnum> to C<idbyte>. Note that the type bytes quoted in most "
14619 "documentation are in fact hexadecimal numbers, but usually documented "
14620 "without any leading \"0x\" which might be confusing."
14624 #: ../src/guestfs-actions.pod:5169
14625 msgid "guestfs_part_set_name"
14629 #: ../src/guestfs-actions.pod:5171
14633 " guestfs_part_set_name (guestfs_h *g,\n"
14634 " const char *device,\n"
14636 " const char *name);\n"
14641 #: ../src/guestfs-actions.pod:5177 ../fish/guestfish-actions.pod:3491
14643 "This sets the partition name on partition numbered C<partnum> on device "
14644 "C<device>. Note that partitions are numbered from 1."
14648 #: ../src/guestfs-actions.pod:5180 ../fish/guestfish-actions.pod:3494
14650 "The partition name can only be set on certain types of partition table. "
14651 "This works on C<gpt> but not on C<mbr> partitions."
14655 #: ../src/guestfs-actions.pod:5187
14656 msgid "guestfs_part_to_dev"
14660 #: ../src/guestfs-actions.pod:5189
14664 " guestfs_part_to_dev (guestfs_h *g,\n"
14665 " const char *partition);\n"
14670 #: ../src/guestfs-actions.pod:5193 ../fish/guestfish-actions.pod:3501
14672 "This function takes a partition name (eg. \"/dev/sdb1\") and removes the "
14673 "partition number, returning the device name (eg. \"/dev/sdb\")."
14677 #: ../src/guestfs-actions.pod:5197
14679 "The named partition must exist, for example as a string returned from "
14680 "C<guestfs_list_partitions>."
14684 #: ../src/guestfs-actions.pod:5205
14685 msgid "guestfs_ping_daemon"
14689 #: ../src/guestfs-actions.pod:5207
14693 " guestfs_ping_daemon (guestfs_h *g);\n"
14698 #: ../src/guestfs-actions.pod:5210 ../fish/guestfish-actions.pod:3512
14700 "This is a test probe into the guestfs daemon running inside the qemu "
14701 "subprocess. Calling this function checks that the daemon responds to the "
14702 "ping message, without affecting the daemon or attached block device(s) in "
14707 #: ../src/guestfs-actions.pod:5219
14708 msgid "guestfs_pread"
14712 #: ../src/guestfs-actions.pod:5221
14716 " guestfs_pread (guestfs_h *g,\n"
14717 " const char *path,\n"
14719 " int64_t offset,\n"
14720 " size_t *size_r);\n"
14725 #: ../src/guestfs-actions.pod:5228 ../fish/guestfish-actions.pod:3521
14727 "This command lets you read part of a file. It reads C<count> bytes of the "
14728 "file, starting at C<offset>, from file C<path>."
14732 #: ../src/guestfs-actions.pod:5231 ../src/guestfs-actions.pod:5257
14733 #: ../fish/guestfish-actions.pod:3524 ../fish/guestfish-actions.pod:3539
14735 "This may read fewer bytes than requested. For further details see the "
14736 "L<pread(2)> system call."
14740 #: ../src/guestfs-actions.pod:5234
14741 msgid "See also C<guestfs_pwrite>, C<guestfs_pread_device>."
14745 #: ../src/guestfs-actions.pod:5245
14746 msgid "guestfs_pread_device"
14750 #: ../src/guestfs-actions.pod:5247
14754 " guestfs_pread_device (guestfs_h *g,\n"
14755 " const char *device,\n"
14757 " int64_t offset,\n"
14758 " size_t *size_r);\n"
14763 #: ../src/guestfs-actions.pod:5254 ../fish/guestfish-actions.pod:3536
14765 "This command lets you read part of a file. It reads C<count> bytes of "
14766 "C<device>, starting at C<offset>."
14770 #: ../src/guestfs-actions.pod:5260
14771 msgid "See also C<guestfs_pread>."
14775 #: ../src/guestfs-actions.pod:5269
14776 msgid "(Added in 1.5.21)"
14780 #: ../src/guestfs-actions.pod:5271
14781 msgid "guestfs_pvcreate"
14785 #: ../src/guestfs-actions.pod:5273
14789 " guestfs_pvcreate (guestfs_h *g,\n"
14790 " const char *device);\n"
14795 #: ../src/guestfs-actions.pod:5277 ../fish/guestfish-actions.pod:3551
14797 "This creates an LVM physical volume on the named C<device>, where C<device> "
14798 "should usually be a partition name such as C</dev/sda1>."
14802 #: ../src/guestfs-actions.pod:5285
14803 msgid "guestfs_pvremove"
14807 #: ../src/guestfs-actions.pod:5287
14811 " guestfs_pvremove (guestfs_h *g,\n"
14812 " const char *device);\n"
14817 #: ../src/guestfs-actions.pod:5291 ../fish/guestfish-actions.pod:3559
14819 "This wipes a physical volume C<device> so that LVM will no longer recognise "
14824 #: ../src/guestfs-actions.pod:5294 ../fish/guestfish-actions.pod:3562
14826 "The implementation uses the C<pvremove> command which refuses to wipe "
14827 "physical volumes that contain any volume groups, so you have to remove those "
14832 #: ../src/guestfs-actions.pod:5302
14833 msgid "guestfs_pvresize"
14837 #: ../src/guestfs-actions.pod:5304
14841 " guestfs_pvresize (guestfs_h *g,\n"
14842 " const char *device);\n"
14847 #: ../src/guestfs-actions.pod:5308 ../fish/guestfish-actions.pod:3570
14849 "This resizes (expands or shrinks) an existing LVM physical volume to match "
14850 "the new size of the underlying device."
14854 #: ../src/guestfs-actions.pod:5315
14855 msgid "guestfs_pvresize_size"
14859 #: ../src/guestfs-actions.pod:5317
14863 " guestfs_pvresize_size (guestfs_h *g,\n"
14864 " const char *device,\n"
14865 " int64_t size);\n"
14870 #: ../src/guestfs-actions.pod:5322
14872 "This command is the same as C<guestfs_pvresize> except that it allows you to "
14873 "specify the new size (in bytes) explicitly."
14877 #: ../src/guestfs-actions.pod:5329
14878 msgid "guestfs_pvs"
14882 #: ../src/guestfs-actions.pod:5331
14886 " guestfs_pvs (guestfs_h *g);\n"
14891 #: ../src/guestfs-actions.pod:5334 ../fish/guestfish-actions.pod:3584
14893 "List all the physical volumes detected. This is the equivalent of the L<pvs"
14898 #: ../src/guestfs-actions.pod:5337 ../fish/guestfish-actions.pod:3587
14900 "This returns a list of just the device names that contain PVs (eg. C</dev/"
14905 #: ../src/guestfs-actions.pod:5340
14906 msgid "See also C<guestfs_pvs_full>."
14910 #: ../src/guestfs-actions.pod:5348
14911 msgid "guestfs_pvs_full"
14915 #: ../src/guestfs-actions.pod:5350
14918 " struct guestfs_lvm_pv_list *\n"
14919 " guestfs_pvs_full (guestfs_h *g);\n"
14924 #: ../src/guestfs-actions.pod:5353 ../fish/guestfish-actions.pod:3596
14926 "List all the physical volumes detected. This is the equivalent of the L<pvs"
14927 "(8)> command. The \"full\" version includes all fields."
14931 #: ../src/guestfs-actions.pod:5356
14933 "This function returns a C<struct guestfs_lvm_pv_list *>, or NULL if there "
14934 "was an error. I<The caller must call C<guestfs_free_lvm_pv_list> after use>."
14938 #: ../src/guestfs-actions.pod:5362
14939 msgid "guestfs_pvuuid"
14943 #: ../src/guestfs-actions.pod:5364
14947 " guestfs_pvuuid (guestfs_h *g,\n"
14948 " const char *device);\n"
14953 #: ../src/guestfs-actions.pod:5368 ../fish/guestfish-actions.pod:3603
14954 msgid "This command returns the UUID of the LVM PV C<device>."
14958 #: ../src/guestfs-actions.pod:5375
14959 msgid "guestfs_pwrite"
14963 #: ../src/guestfs-actions.pod:5377
14967 " guestfs_pwrite (guestfs_h *g,\n"
14968 " const char *path,\n"
14969 " const char *content,\n"
14970 " size_t content_size,\n"
14971 " int64_t offset);\n"
14976 #: ../src/guestfs-actions.pod:5384 ../fish/guestfish-actions.pod:3609
14978 "This command writes to part of a file. It writes the data buffer C<content> "
14979 "to the file C<path> starting at offset C<offset>."
14983 #: ../src/guestfs-actions.pod:5387 ../fish/guestfish-actions.pod:3612
14985 "This command implements the L<pwrite(2)> system call, and like that system "
14986 "call it may not write the full data requested. The return value is the "
14987 "number of bytes that were actually written to the file. This could even be "
14988 "0, although short writes are unlikely for regular files in ordinary "
14993 #: ../src/guestfs-actions.pod:5393
14994 msgid "See also C<guestfs_pread>, C<guestfs_pwrite_device>."
14998 #: ../src/guestfs-actions.pod:5402
14999 msgid "guestfs_pwrite_device"
15003 #: ../src/guestfs-actions.pod:5404
15007 " guestfs_pwrite_device (guestfs_h *g,\n"
15008 " const char *device,\n"
15009 " const char *content,\n"
15010 " size_t content_size,\n"
15011 " int64_t offset);\n"
15016 #: ../src/guestfs-actions.pod:5411 ../fish/guestfish-actions.pod:3627
15018 "This command writes to part of a device. It writes the data buffer "
15019 "C<content> to C<device> starting at offset C<offset>."
15023 #: ../src/guestfs-actions.pod:5414 ../fish/guestfish-actions.pod:3630
15025 "This command implements the L<pwrite(2)> system call, and like that system "
15026 "call it may not write the full data requested (although short writes to disk "
15027 "devices and partitions are probably impossible with standard Linux kernels)."
15031 #: ../src/guestfs-actions.pod:5419
15032 msgid "See also C<guestfs_pwrite>."
15036 #: ../src/guestfs-actions.pod:5426
15037 msgid "(Added in 1.5.20)"
15041 #: ../src/guestfs-actions.pod:5428
15042 msgid "guestfs_read_file"
15046 #: ../src/guestfs-actions.pod:5430
15050 " guestfs_read_file (guestfs_h *g,\n"
15051 " const char *path,\n"
15052 " size_t *size_r);\n"
15057 #: ../src/guestfs-actions.pod:5435 ../fish/guestfish-actions.pod:3644
15058 msgid "This calls returns the contents of the file C<path> as a buffer."
15062 #: ../src/guestfs-actions.pod:5438
15064 "Unlike C<guestfs_cat>, this function can correctly handle files that contain "
15065 "embedded ASCII NUL characters. However unlike C<guestfs_download>, this "
15066 "function is limited in the total size of file that can be handled."
15070 #: ../src/guestfs-actions.pod:5450
15071 msgid "(Added in 1.0.63)"
15075 #: ../src/guestfs-actions.pod:5452
15076 msgid "guestfs_read_lines"
15080 #: ../src/guestfs-actions.pod:5454
15084 " guestfs_read_lines (guestfs_h *g,\n"
15085 " const char *path);\n"
15090 #: ../src/guestfs-actions.pod:5460 ../fish/guestfish-actions.pod:3661
15092 "The file contents are returned as a list of lines. Trailing C<LF> and "
15093 "C<CRLF> character sequences are I<not> returned."
15097 #: ../src/guestfs-actions.pod:5463
15099 "Note that this function cannot correctly handle binary files (specifically, "
15100 "files containing C<\\0> character which is treated as end of line). For "
15101 "those you need to use the C<guestfs_read_file> function which has a more "
15102 "complex interface."
15106 #: ../src/guestfs-actions.pod:5474
15107 msgid "guestfs_readdir"
15111 #: ../src/guestfs-actions.pod:5476
15114 " struct guestfs_dirent_list *\n"
15115 " guestfs_readdir (guestfs_h *g,\n"
15116 " const char *dir);\n"
15121 #: ../src/guestfs-actions.pod:5480 ../fish/guestfish-actions.pod:3673
15122 msgid "This returns the list of directory entries in directory C<dir>."
15126 #: ../src/guestfs-actions.pod:5482 ../fish/guestfish-actions.pod:3675
15128 "All entries in the directory are returned, including C<.> and C<..>. The "
15129 "entries are I<not> sorted, but returned in the same order as the underlying "
15134 #: ../src/guestfs-actions.pod:5486 ../fish/guestfish-actions.pod:3679
15136 "Also this call returns basic file type information about each file. The "
15137 "C<ftyp> field will contain one of the following characters:"
15141 #: ../src/guestfs-actions.pod:5491 ../fish/guestfish-actions.pod:3684
15146 #: ../src/guestfs-actions.pod:5493 ../fish/guestfish-actions.pod:3686
15147 msgid "Block special"
15151 #: ../src/guestfs-actions.pod:5495 ../fish/guestfish-actions.pod:3688
15156 #: ../src/guestfs-actions.pod:5497 ../fish/guestfish-actions.pod:3690
15157 msgid "Char special"
15161 #: ../src/guestfs-actions.pod:5499 ../fish/guestfish-actions.pod:3692
15166 #: ../src/guestfs-actions.pod:5501 ../fish/guestfish-actions.pod:3694
15171 #: ../src/guestfs-actions.pod:5503 ../fish/guestfish-actions.pod:3696
15176 #: ../src/guestfs-actions.pod:5505 ../fish/guestfish-actions.pod:3698
15177 msgid "FIFO (named pipe)"
15181 #: ../src/guestfs-actions.pod:5507 ../fish/guestfish-actions.pod:3700
15186 #: ../src/guestfs-actions.pod:5509 ../fish/guestfish-actions.pod:3702
15187 msgid "Symbolic link"
15191 #: ../src/guestfs-actions.pod:5511 ../fish/guestfish-actions.pod:3704
15196 #: ../src/guestfs-actions.pod:5513 ../fish/guestfish-actions.pod:3706
15197 msgid "Regular file"
15201 #: ../src/guestfs-actions.pod:5515 ../fish/guestfish-actions.pod:3708
15206 #: ../src/guestfs-actions.pod:5517 ../fish/guestfish-actions.pod:3710
15211 #: ../src/guestfs-actions.pod:5519 ../fish/guestfish-actions.pod:3712
15216 #: ../src/guestfs-actions.pod:5521 ../fish/guestfish-actions.pod:3714
15217 msgid "Unknown file type"
15221 #: ../src/guestfs-actions.pod:5523 ../fish/guestfish-actions.pod:3716
15226 #: ../src/guestfs-actions.pod:5525 ../fish/guestfish-actions.pod:3718
15228 "The L<readdir(3)> call returned a C<d_type> field with an unexpected value"
15232 #: ../src/guestfs-actions.pod:5530
15234 "This function is primarily intended for use by programs. To get a simple "
15235 "list of names, use C<guestfs_ls>. To get a printable directory for human "
15236 "consumption, use C<guestfs_ll>."
15240 #: ../src/guestfs-actions.pod:5534
15242 "This function returns a C<struct guestfs_dirent_list *>, or NULL if there "
15243 "was an error. I<The caller must call C<guestfs_free_dirent_list> after use>."
15247 #: ../src/guestfs-actions.pod:5540
15248 msgid "guestfs_readlink"
15252 #: ../src/guestfs-actions.pod:5542
15256 " guestfs_readlink (guestfs_h *g,\n"
15257 " const char *path);\n"
15262 #: ../src/guestfs-actions.pod:5546 ../fish/guestfish-actions.pod:3731
15263 msgid "This command reads the target of a symbolic link."
15267 #: ../src/guestfs-actions.pod:5553
15268 msgid "guestfs_readlinklist"
15272 #: ../src/guestfs-actions.pod:5555
15276 " guestfs_readlinklist (guestfs_h *g,\n"
15277 " const char *path,\n"
15278 " char *const *names);\n"
15283 #: ../src/guestfs-actions.pod:5560 ../fish/guestfish-actions.pod:3737
15285 "This call allows you to do a C<readlink> operation on multiple files, where "
15286 "all files are in the directory C<path>. C<names> is the list of files from "
15291 #: ../src/guestfs-actions.pod:5564 ../fish/guestfish-actions.pod:3741
15293 "On return you get a list of strings, with a one-to-one correspondence to the "
15294 "C<names> list. Each string is the value of the symbolic link."
15298 #: ../src/guestfs-actions.pod:5568 ../fish/guestfish-actions.pod:3745
15300 "If the C<readlink(2)> operation fails on any name, then the corresponding "
15301 "result string is the empty string C<\"\">. However the whole operation is "
15302 "completed even if there were C<readlink(2)> errors, and so you can call this "
15303 "function with names where you don't know if they are symbolic links already "
15304 "(albeit slightly less efficient)."
15308 #: ../src/guestfs-actions.pod:5575 ../fish/guestfish-actions.pod:3752
15310 "This call is intended for programs that want to efficiently list a directory "
15311 "contents without making many round-trips. Very long directory listings "
15312 "might cause the protocol message size to be exceeded, causing this call to "
15313 "fail. The caller must split up such requests into smaller groups of names."
15317 #: ../src/guestfs-actions.pod:5588
15318 msgid "guestfs_realpath"
15322 #: ../src/guestfs-actions.pod:5590
15326 " guestfs_realpath (guestfs_h *g,\n"
15327 " const char *path);\n"
15332 #: ../src/guestfs-actions.pod:5594 ../fish/guestfish-actions.pod:3763
15334 "Return the canonicalized absolute pathname of C<path>. The returned path "
15335 "has no C<.>, C<..> or symbolic link path elements."
15339 #: ../src/guestfs-actions.pod:5602
15340 msgid "guestfs_removexattr"
15344 #: ../src/guestfs-actions.pod:5604
15348 " guestfs_removexattr (guestfs_h *g,\n"
15349 " const char *xattr,\n"
15350 " const char *path);\n"
15355 #: ../src/guestfs-actions.pod:5609 ../fish/guestfish-actions.pod:3770
15357 "This call removes the extended attribute named C<xattr> of the file C<path>."
15361 #: ../src/guestfs-actions.pod:5612
15362 msgid "See also: C<guestfs_lremovexattr>, L<attr(5)>."
15366 #: ../src/guestfs-actions.pod:5618
15367 msgid "guestfs_resize2fs"
15371 #: ../src/guestfs-actions.pod:5620
15375 " guestfs_resize2fs (guestfs_h *g,\n"
15376 " const char *device);\n"
15381 #: ../src/guestfs-actions.pod:5624 ../fish/guestfish-actions.pod:3779
15383 "This resizes an ext2, ext3 or ext4 filesystem to match the size of the "
15384 "underlying device."
15388 #: ../src/guestfs-actions.pod:5627
15390 "I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f> on the "
15391 "C<device> before calling this command. For unknown reasons C<resize2fs> "
15392 "sometimes gives an error about this and sometimes not. In any case, it is "
15393 "always safe to call C<guestfs_e2fsck_f> before calling this function."
15397 #: ../src/guestfs-actions.pod:5637
15398 msgid "guestfs_resize2fs_M"
15402 #: ../src/guestfs-actions.pod:5639
15406 " guestfs_resize2fs_M (guestfs_h *g,\n"
15407 " const char *device);\n"
15412 #: ../src/guestfs-actions.pod:5643
15414 "This command is the same as C<guestfs_resize2fs>, but the filesystem is "
15415 "resized to its minimum size. This works like the C<-M> option to the "
15416 "C<resize2fs> command."
15420 #: ../src/guestfs-actions.pod:5647
15422 "To get the resulting size of the filesystem you should call "
15423 "C<guestfs_tune2fs_l> and read the C<Block size> and C<Block count> values. "
15424 "These two numbers, multiplied together, give the resulting size of the "
15425 "minimal filesystem in bytes."
15429 #: ../src/guestfs-actions.pod:5654
15430 msgid "guestfs_resize2fs_size"
15434 #: ../src/guestfs-actions.pod:5656
15438 " guestfs_resize2fs_size (guestfs_h *g,\n"
15439 " const char *device,\n"
15440 " int64_t size);\n"
15445 #: ../src/guestfs-actions.pod:5661
15447 "This command is the same as C<guestfs_resize2fs> except that it allows you "
15448 "to specify the new size (in bytes) explicitly."
15452 #: ../src/guestfs-actions.pod:5668
15457 #: ../src/guestfs-actions.pod:5670
15461 " guestfs_rm (guestfs_h *g,\n"
15462 " const char *path);\n"
15467 #: ../src/guestfs-actions.pod:5674 ../fish/guestfish-actions.pod:3812
15468 msgid "Remove the single file C<path>."
15472 #: ../src/guestfs-actions.pod:5680
15473 msgid "guestfs_rm_rf"
15477 #: ../src/guestfs-actions.pod:5682
15481 " guestfs_rm_rf (guestfs_h *g,\n"
15482 " const char *path);\n"
15487 #: ../src/guestfs-actions.pod:5686 ../fish/guestfish-actions.pod:3818
15489 "Remove the file or directory C<path>, recursively removing the contents if "
15490 "its a directory. This is like the C<rm -rf> shell command."
15494 #: ../src/guestfs-actions.pod:5694
15495 msgid "guestfs_rmdir"
15499 #: ../src/guestfs-actions.pod:5696
15503 " guestfs_rmdir (guestfs_h *g,\n"
15504 " const char *path);\n"
15509 #: ../src/guestfs-actions.pod:5700 ../fish/guestfish-actions.pod:3826
15510 msgid "Remove the single directory C<path>."
15514 #: ../src/guestfs-actions.pod:5706
15515 msgid "guestfs_rmmountpoint"
15519 #: ../src/guestfs-actions.pod:5708
15523 " guestfs_rmmountpoint (guestfs_h *g,\n"
15524 " const char *exemptpath);\n"
15529 #: ../src/guestfs-actions.pod:5712
15531 "This calls removes a mountpoint that was previously created with "
15532 "C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint> for full details."
15536 #: ../src/guestfs-actions.pod:5720
15537 msgid "guestfs_scrub_device"
15541 #: ../src/guestfs-actions.pod:5722
15545 " guestfs_scrub_device (guestfs_h *g,\n"
15546 " const char *device);\n"
15551 #: ../src/guestfs-actions.pod:5726 ../fish/guestfish-actions.pod:3840
15553 "This command writes patterns over C<device> to make data retrieval more "
15558 #: ../src/guestfs-actions.pod:5729 ../src/guestfs-actions.pod:5750
15559 #: ../src/guestfs-actions.pod:5769 ../fish/guestfish-actions.pod:3843
15560 #: ../fish/guestfish-actions.pod:3858 ../fish/guestfish-actions.pod:3871
15562 "It is an interface to the L<scrub(1)> program. See that manual page for "
15567 #: ../src/guestfs-actions.pod:5737 ../src/guestfs-actions.pod:5755
15568 #: ../src/guestfs-actions.pod:5774
15569 msgid "(Added in 1.0.52)"
15573 #: ../src/guestfs-actions.pod:5739
15574 msgid "guestfs_scrub_file"
15578 #: ../src/guestfs-actions.pod:5741
15582 " guestfs_scrub_file (guestfs_h *g,\n"
15583 " const char *file);\n"
15588 #: ../src/guestfs-actions.pod:5745 ../fish/guestfish-actions.pod:3853
15590 "This command writes patterns over a file to make data retrieval more "
15595 #: ../src/guestfs-actions.pod:5748 ../fish/guestfish-actions.pod:3856
15596 msgid "The file is I<removed> after scrubbing."
15600 #: ../src/guestfs-actions.pod:5757
15601 msgid "guestfs_scrub_freespace"
15605 #: ../src/guestfs-actions.pod:5759
15609 " guestfs_scrub_freespace (guestfs_h *g,\n"
15610 " const char *dir);\n"
15615 #: ../src/guestfs-actions.pod:5763
15617 "This command creates the directory C<dir> and then fills it with files until "
15618 "the filesystem is full, and scrubs the files as for C<guestfs_scrub_file>, "
15619 "and deletes them. The intention is to scrub any free space on the partition "
15620 "containing C<dir>."
15624 #: ../src/guestfs-actions.pod:5776
15625 msgid "guestfs_set_append"
15629 #: ../src/guestfs-actions.pod:5778
15633 " guestfs_set_append (guestfs_h *g,\n"
15634 " const char *append);\n"
15639 #: ../src/guestfs-actions.pod:5782 ../fish/guestfish-actions.pod:3880
15641 "This function is used to add additional options to the guest kernel command "
15646 #: ../src/guestfs-actions.pod:5785 ../fish/guestfish-actions.pod:3883
15648 "The default is C<NULL> unless overridden by setting C<LIBGUESTFS_APPEND> "
15649 "environment variable."
15653 #: ../src/guestfs-actions.pod:5788 ../fish/guestfish-actions.pod:3886
15655 "Setting C<append> to C<NULL> means I<no> additional options are passed "
15656 "(libguestfs always adds a few of its own)."
15660 #: ../src/guestfs-actions.pod:5795
15661 msgid "guestfs_set_attach_method"
15665 #: ../src/guestfs-actions.pod:5797
15669 " guestfs_set_attach_method (guestfs_h *g,\n"
15670 " const char *attachmethod);\n"
15675 #: ../src/guestfs-actions.pod:5801 ../fish/guestfish-actions.pod:3895
15677 "Set the method that libguestfs uses to connect to the back end guestfsd "
15678 "daemon. Possible methods are:"
15682 #: ../src/guestfs-actions.pod:5808 ../fish/guestfish-actions.pod:3902
15684 "Launch an appliance and connect to it. This is the ordinary method and the "
15689 #: ../src/guestfs-actions.pod:5811 ../fish/guestfish-actions.pod:3905
15690 msgid "C<unix:I<path>>"
15694 #: ../src/guestfs-actions.pod:5813 ../fish/guestfish-actions.pod:3907
15695 msgid "Connect to the Unix domain socket I<path>."
15699 #: ../src/guestfs-actions.pod:5815 ../fish/guestfish-actions.pod:3909
15701 "This method lets you connect to an existing daemon or (using virtio-serial) "
15702 "to a live guest. For more information, see L<guestfs(3)/ATTACHING TO "
15703 "RUNNING DAEMONS>."
15707 #: ../src/guestfs-actions.pod:5823
15708 msgid "guestfs_set_autosync"
15712 #: ../src/guestfs-actions.pod:5825
15716 " guestfs_set_autosync (guestfs_h *g,\n"
15717 " int autosync);\n"
15722 #: ../src/guestfs-actions.pod:5829 ../fish/guestfish-actions.pod:3921
15724 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
15725 "effort attempt to make filesystems consistent and synchronized when the "
15726 "handle is closed (also if the program exits without closing handles)."
15730 #: ../src/guestfs-actions.pod:5834 ../fish/guestfish-actions.pod:3926
15732 "This is enabled by default (since libguestfs 1.5.24, previously it was "
15733 "disabled by default)."
15737 #: ../src/guestfs-actions.pod:5841
15738 msgid "guestfs_set_direct"
15742 #: ../src/guestfs-actions.pod:5843
15746 " guestfs_set_direct (guestfs_h *g,\n"
15752 #: ../src/guestfs-actions.pod:5847 ../fish/guestfish-actions.pod:3935
15754 "If the direct appliance mode flag is enabled, then stdin and stdout are "
15755 "passed directly through to the appliance once it is launched."
15759 #: ../src/guestfs-actions.pod:5851
15761 "One consequence of this is that log messages aren't caught by the library "
15762 "and handled by C<guestfs_set_log_message_callback>, but go straight to "
15767 #: ../src/guestfs-actions.pod:5855 ../fish/guestfish-actions.pod:3943
15768 msgid "You probably don't want to use this unless you know what you are doing."
15772 #: ../src/guestfs-actions.pod:5858 ../fish/guestfish-actions.pod:3946
15773 msgid "The default is disabled."
15777 #: ../src/guestfs-actions.pod:5864
15778 msgid "guestfs_set_e2label"
15782 #: ../src/guestfs-actions.pod:5866
15786 " guestfs_set_e2label (guestfs_h *g,\n"
15787 " const char *device,\n"
15788 " const char *label);\n"
15793 #: ../src/guestfs-actions.pod:5871 ../fish/guestfish-actions.pod:3952
15795 "This sets the ext2/3/4 filesystem label of the filesystem on C<device> to "
15796 "C<label>. Filesystem labels are limited to 16 characters."
15800 #: ../src/guestfs-actions.pod:5875
15802 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label> to return "
15803 "the existing label on a filesystem."
15807 #: ../src/guestfs-actions.pod:5882
15808 msgid "guestfs_set_e2uuid"
15812 #: ../src/guestfs-actions.pod:5884
15816 " guestfs_set_e2uuid (guestfs_h *g,\n"
15817 " const char *device,\n"
15818 " const char *uuid);\n"
15823 #: ../src/guestfs-actions.pod:5889 ../fish/guestfish-actions.pod:3963
15825 "This sets the ext2/3/4 filesystem UUID of the filesystem on C<device> to "
15826 "C<uuid>. The format of the UUID and alternatives such as C<clear>, "
15827 "C<random> and C<time> are described in the L<tune2fs(8)> manpage."
15831 #: ../src/guestfs-actions.pod:5894
15833 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid> to return "
15834 "the existing UUID of a filesystem."
15838 #: ../src/guestfs-actions.pod:5901
15839 msgid "guestfs_set_memsize"
15843 #: ../src/guestfs-actions.pod:5903
15847 " guestfs_set_memsize (guestfs_h *g,\n"
15853 #: ../src/guestfs-actions.pod:5907
15855 "This sets the memory size in megabytes allocated to the qemu subprocess. "
15856 "This only has any effect if called before C<guestfs_launch>."
15860 #: ../src/guestfs-actions.pod:5911 ../fish/guestfish-actions.pod:3981
15862 "You can also change this by setting the environment variable "
15863 "C<LIBGUESTFS_MEMSIZE> before the handle is created."
15867 #: ../src/guestfs-actions.pod:5922
15868 msgid "guestfs_set_network"
15872 #: ../src/guestfs-actions.pod:5924
15876 " guestfs_set_network (guestfs_h *g,\n"
15882 #: ../src/guestfs-actions.pod:5928 ../fish/guestfish-actions.pod:3994
15884 "If C<network> is true, then the network is enabled in the libguestfs "
15885 "appliance. The default is false."
15889 #: ../src/guestfs-actions.pod:5931 ../fish/guestfish-actions.pod:3997
15891 "This affects whether commands are able to access the network (see L<guestfs"
15892 "(3)/RUNNING COMMANDS>)."
15896 #: ../src/guestfs-actions.pod:5934
15898 "You must call this before calling C<guestfs_launch>, otherwise it has no "
15903 #: ../src/guestfs-actions.pod:5941
15904 msgid "guestfs_set_path"
15908 #: ../src/guestfs-actions.pod:5943
15912 " guestfs_set_path (guestfs_h *g,\n"
15913 " const char *searchpath);\n"
15918 #: ../src/guestfs-actions.pod:5947 ../fish/guestfish-actions.pod:4009
15919 msgid "Set the path that libguestfs searches for kernel and initrd.img."
15923 #: ../src/guestfs-actions.pod:5949 ../fish/guestfish-actions.pod:4011
15925 "The default is C<$libdir/guestfs> unless overridden by setting "
15926 "C<LIBGUESTFS_PATH> environment variable."
15930 #: ../src/guestfs-actions.pod:5952 ../fish/guestfish-actions.pod:4014
15931 msgid "Setting C<path> to C<NULL> restores the default path."
15935 #: ../src/guestfs-actions.pod:5958
15936 msgid "guestfs_set_qemu"
15940 #: ../src/guestfs-actions.pod:5960
15944 " guestfs_set_qemu (guestfs_h *g,\n"
15945 " const char *qemu);\n"
15950 #: ../src/guestfs-actions.pod:5964 ../fish/guestfish-actions.pod:4022
15951 msgid "Set the qemu binary that we will use."
15955 #: ../src/guestfs-actions.pod:5966 ../fish/guestfish-actions.pod:4024
15957 "The default is chosen when the library was compiled by the configure script."
15961 #: ../src/guestfs-actions.pod:5969 ../fish/guestfish-actions.pod:4027
15963 "You can also override this by setting the C<LIBGUESTFS_QEMU> environment "
15968 #: ../src/guestfs-actions.pod:5972 ../fish/guestfish-actions.pod:4030
15969 msgid "Setting C<qemu> to C<NULL> restores the default qemu binary."
15973 #: ../src/guestfs-actions.pod:5974 ../fish/guestfish-actions.pod:4032
15975 "Note that you should call this function as early as possible after creating "
15976 "the handle. This is because some pre-launch operations depend on testing "
15977 "qemu features (by running C<qemu -help>). If the qemu binary changes, we "
15978 "don't retest features, and so you might see inconsistent results. Using the "
15979 "environment variable C<LIBGUESTFS_QEMU> is safest of all since that picks "
15980 "the qemu binary at the same time as the handle is created."
15984 #: ../src/guestfs-actions.pod:5986
15985 msgid "guestfs_set_recovery_proc"
15989 #: ../src/guestfs-actions.pod:5988
15993 " guestfs_set_recovery_proc (guestfs_h *g,\n"
15994 " int recoveryproc);\n"
15999 #: ../src/guestfs-actions.pod:5992
16001 "If this is called with the parameter C<false> then C<guestfs_launch> does "
16002 "not create a recovery process. The purpose of the recovery process is to "
16003 "stop runaway qemu processes in the case where the main program aborts "
16008 #: ../src/guestfs-actions.pod:5997
16010 "This only has any effect if called before C<guestfs_launch>, and the default "
16015 #: ../src/guestfs-actions.pod:6000 ../fish/guestfish-actions.pod:4054
16017 "About the only time when you would want to disable this is if the main "
16018 "process will fork itself into the background (\"daemonize\" itself). In "
16019 "this case the recovery process thinks that the main program has disappeared "
16020 "and so kills qemu, which is not very helpful."
16024 #: ../src/guestfs-actions.pod:6010
16025 msgid "guestfs_set_selinux"
16029 #: ../src/guestfs-actions.pod:6012
16033 " guestfs_set_selinux (guestfs_h *g,\n"
16039 #: ../src/guestfs-actions.pod:6016 ../fish/guestfish-actions.pod:4066
16041 "This sets the selinux flag that is passed to the appliance at boot time. "
16042 "The default is C<selinux=0> (disabled)."
16046 #: ../src/guestfs-actions.pod:6019 ../fish/guestfish-actions.pod:4069
16048 "Note that if SELinux is enabled, it is always in Permissive mode "
16049 "(C<enforcing=0>)."
16053 #: ../src/guestfs-actions.pod:6029
16054 msgid "guestfs_set_trace"
16058 #: ../src/guestfs-actions.pod:6031
16062 " guestfs_set_trace (guestfs_h *g,\n"
16068 #: ../src/guestfs-actions.pod:6035 ../fish/guestfish-actions.pod:4081
16070 "If the command trace flag is set to 1, then libguestfs calls, parameters and "
16071 "return values are traced."
16075 #: ../src/guestfs-actions.pod:6038 ../fish/guestfish-actions.pod:4084
16077 "If you want to trace C API calls into libguestfs (and other libraries) then "
16078 "possibly a better way is to use the external ltrace(1) command."
16082 #: ../src/guestfs-actions.pod:6042 ../fish/guestfish-actions.pod:4088
16084 "Command traces are disabled unless the environment variable "
16085 "C<LIBGUESTFS_TRACE> is defined and set to C<1>."
16089 #: ../src/guestfs-actions.pod:6045
16091 "Trace messages are normally sent to C<stderr>, unless you register a "
16092 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
16096 #: ../src/guestfs-actions.pod:6053
16097 msgid "guestfs_set_verbose"
16101 #: ../src/guestfs-actions.pod:6055
16105 " guestfs_set_verbose (guestfs_h *g,\n"
16111 #: ../src/guestfs-actions.pod:6059 ../fish/guestfish-actions.pod:4101
16112 msgid "If C<verbose> is true, this turns on verbose messages."
16116 #: ../src/guestfs-actions.pod:6061 ../fish/guestfish-actions.pod:4103
16118 "Verbose messages are disabled unless the environment variable "
16119 "C<LIBGUESTFS_DEBUG> is defined and set to C<1>."
16123 #: ../src/guestfs-actions.pod:6064
16125 "Verbose messages are normally sent to C<stderr>, unless you register a "
16126 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
16130 #: ../src/guestfs-actions.pod:6072
16131 msgid "guestfs_setcon"
16135 #: ../src/guestfs-actions.pod:6074
16139 " guestfs_setcon (guestfs_h *g,\n"
16140 " const char *context);\n"
16145 #: ../src/guestfs-actions.pod:6078 ../fish/guestfish-actions.pod:4114
16147 "This sets the SELinux security context of the daemon to the string "
16152 #: ../src/guestfs-actions.pod:6081 ../fish/guestfish-actions.pod:4117
16153 msgid "See the documentation about SELINUX in L<guestfs(3)>."
16157 #: ../src/guestfs-actions.pod:6087
16158 msgid "guestfs_setxattr"
16162 #: ../src/guestfs-actions.pod:6089
16166 " guestfs_setxattr (guestfs_h *g,\n"
16167 " const char *xattr,\n"
16168 " const char *val,\n"
16170 " const char *path);\n"
16175 #: ../src/guestfs-actions.pod:6096 ../fish/guestfish-actions.pod:4123
16177 "This call sets the extended attribute named C<xattr> of the file C<path> to "
16178 "the value C<val> (of length C<vallen>). The value is arbitrary 8 bit data."
16182 #: ../src/guestfs-actions.pod:6100
16183 msgid "See also: C<guestfs_lsetxattr>, L<attr(5)>."
16187 #: ../src/guestfs-actions.pod:6106
16188 msgid "guestfs_sfdisk"
16192 #: ../src/guestfs-actions.pod:6108
16196 " guestfs_sfdisk (guestfs_h *g,\n"
16197 " const char *device,\n"
16201 " char *const *lines);\n"
16206 #: ../src/guestfs-actions.pod:6116 ../fish/guestfish-actions.pod:4133
16208 "This is a direct interface to the L<sfdisk(8)> program for creating "
16209 "partitions on block devices."
16213 #: ../src/guestfs-actions.pod:6119 ../fish/guestfish-actions.pod:4136
16214 msgid "C<device> should be a block device, for example C</dev/sda>."
16218 #: ../src/guestfs-actions.pod:6121 ../fish/guestfish-actions.pod:4138
16220 "C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads and "
16221 "sectors on the device, which are passed directly to sfdisk as the I<-C>, I<-"
16222 "H> and I<-S> parameters. If you pass C<0> for any of these, then the "
16223 "corresponding parameter is omitted. Usually for 'large' disks, you can just "
16224 "pass C<0> for these, but for small (floppy-sized) disks, sfdisk (or rather, "
16225 "the kernel) cannot work out the right geometry and you will need to tell it."
16229 #: ../src/guestfs-actions.pod:6129 ../fish/guestfish-actions.pod:4146
16231 "C<lines> is a list of lines that we feed to C<sfdisk>. For more information "
16232 "refer to the L<sfdisk(8)> manpage."
16236 #: ../src/guestfs-actions.pod:6132 ../fish/guestfish-actions.pod:4149
16238 "To create a single partition occupying the whole disk, you would pass "
16239 "C<lines> as a single element list, when the single element being the string "
16244 #: ../src/guestfs-actions.pod:6136
16246 "See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>, C<guestfs_part_init>"
16250 #: ../src/guestfs-actions.pod:6146
16251 msgid "guestfs_sfdiskM"
16255 #: ../src/guestfs-actions.pod:6148
16259 " guestfs_sfdiskM (guestfs_h *g,\n"
16260 " const char *device,\n"
16261 " char *const *lines);\n"
16266 #: ../src/guestfs-actions.pod:6153
16268 "This is a simplified interface to the C<guestfs_sfdisk> command, where "
16269 "partition sizes are specified in megabytes only (rounded to the nearest "
16270 "cylinder) and you don't need to specify the cyls, heads and sectors "
16271 "parameters which were rarely if ever used anyway."
16275 #: ../src/guestfs-actions.pod:6159
16277 "See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage and "
16278 "C<guestfs_part_disk>"
16282 #: ../src/guestfs-actions.pod:6169
16283 msgid "guestfs_sfdisk_N"
16287 #: ../src/guestfs-actions.pod:6171
16291 " guestfs_sfdisk_N (guestfs_h *g,\n"
16292 " const char *device,\n"
16297 " const char *line);\n"
16302 #: ../src/guestfs-actions.pod:6180 ../fish/guestfish-actions.pod:4179
16304 "This runs L<sfdisk(8)> option to modify just the single partition C<n> "
16305 "(note: C<n> counts from 1)."
16309 #: ../src/guestfs-actions.pod:6183
16311 "For other parameters, see C<guestfs_sfdisk>. You should usually pass C<0> "
16312 "for the cyls/heads/sectors parameters."
16316 #: ../src/guestfs-actions.pod:6186
16317 msgid "See also: C<guestfs_part_add>"
16321 #: ../src/guestfs-actions.pod:6195
16322 msgid "guestfs_sfdisk_disk_geometry"
16326 #: ../src/guestfs-actions.pod:6197
16330 " guestfs_sfdisk_disk_geometry (guestfs_h *g,\n"
16331 " const char *device);\n"
16336 #: ../src/guestfs-actions.pod:6201
16338 "This displays the disk geometry of C<device> read from the partition table. "
16339 "Especially in the case where the underlying block device has been resized, "
16340 "this can be different from the kernel's idea of the geometry (see "
16341 "C<guestfs_sfdisk_kernel_geometry>)."
16345 #: ../src/guestfs-actions.pod:6206 ../src/guestfs-actions.pod:6222
16346 #: ../fish/guestfish-actions.pod:4199 ../fish/guestfish-actions.pod:4208
16347 msgid "The result is in human-readable format, and not designed to be parsed."
16351 #: ../src/guestfs-actions.pod:6214
16352 msgid "guestfs_sfdisk_kernel_geometry"
16356 #: ../src/guestfs-actions.pod:6216
16360 " guestfs_sfdisk_kernel_geometry (guestfs_h *g,\n"
16361 " const char *device);\n"
16366 #: ../src/guestfs-actions.pod:6220 ../fish/guestfish-actions.pod:4206
16367 msgid "This displays the kernel's idea of the geometry of C<device>."
16371 #: ../src/guestfs-actions.pod:6230
16372 msgid "guestfs_sfdisk_l"
16376 #: ../src/guestfs-actions.pod:6232
16380 " guestfs_sfdisk_l (guestfs_h *g,\n"
16381 " const char *device);\n"
16386 #: ../src/guestfs-actions.pod:6236 ../fish/guestfish-actions.pod:4215
16388 "This displays the partition table on C<device>, in the human-readable output "
16389 "of the L<sfdisk(8)> command. It is not intended to be parsed."
16393 #: ../src/guestfs-actions.pod:6240
16394 msgid "See also: C<guestfs_part_list>"
16398 #: ../src/guestfs-actions.pod:6247
16403 #: ../src/guestfs-actions.pod:6249
16407 " guestfs_sh (guestfs_h *g,\n"
16408 " const char *command);\n"
16413 #: ../src/guestfs-actions.pod:6253 ../fish/guestfish-actions.pod:4225
16415 "This call runs a command from the guest filesystem via the guest's C</bin/"
16420 #: ../src/guestfs-actions.pod:6256
16421 msgid "This is like C<guestfs_command>, but passes the command to:"
16425 #: ../src/guestfs-actions.pod:6258 ../fish/guestfish-actions.pod:4230
16428 " /bin/sh -c \"command\"\n"
16433 #: ../src/guestfs-actions.pod:6260 ../fish/guestfish-actions.pod:4232
16435 "Depending on the guest's shell, this usually results in wildcards being "
16436 "expanded, shell expressions being interpolated and so on."
16440 #: ../src/guestfs-actions.pod:6264
16441 msgid "All the provisos about C<guestfs_command> apply to this call."
16445 #: ../src/guestfs-actions.pod:6271
16446 msgid "guestfs_sh_lines"
16450 #: ../src/guestfs-actions.pod:6273
16454 " guestfs_sh_lines (guestfs_h *g,\n"
16455 " const char *command);\n"
16460 #: ../src/guestfs-actions.pod:6277
16462 "This is the same as C<guestfs_sh>, but splits the result into a list of "
16467 #: ../src/guestfs-actions.pod:6280
16468 msgid "See also: C<guestfs_command_lines>"
16472 #: ../src/guestfs-actions.pod:6288
16473 msgid "guestfs_sleep"
16477 #: ../src/guestfs-actions.pod:6290
16481 " guestfs_sleep (guestfs_h *g,\n"
16487 #: ../src/guestfs-actions.pod:6294 ../fish/guestfish-actions.pod:4251
16488 msgid "Sleep for C<secs> seconds."
16492 #: ../src/guestfs-actions.pod:6298
16493 msgid "(Added in 1.0.41)"
16497 #: ../src/guestfs-actions.pod:6300 ../src/guestfs-structs.pod:109
16498 msgid "guestfs_stat"
16502 #: ../src/guestfs-actions.pod:6302
16505 " struct guestfs_stat *\n"
16506 " guestfs_stat (guestfs_h *g,\n"
16507 " const char *path);\n"
16512 #: ../src/guestfs-actions.pod:6308 ../fish/guestfish-actions.pod:4259
16513 msgid "This is the same as the C<stat(2)> system call."
16517 #: ../src/guestfs-actions.pod:6316 ../src/guestfs-structs.pod:135
16518 msgid "guestfs_statvfs"
16522 #: ../src/guestfs-actions.pod:6318
16525 " struct guestfs_statvfs *\n"
16526 " guestfs_statvfs (guestfs_h *g,\n"
16527 " const char *path);\n"
16532 #: ../src/guestfs-actions.pod:6322 ../fish/guestfish-actions.pod:4265
16534 "Returns file system statistics for any mounted file system. C<path> should "
16535 "be a file or directory in the mounted file system (typically it is the mount "
16536 "point itself, but it doesn't need to be)."
16540 #: ../src/guestfs-actions.pod:6326 ../fish/guestfish-actions.pod:4269
16541 msgid "This is the same as the C<statvfs(2)> system call."
16545 #: ../src/guestfs-actions.pod:6328
16547 "This function returns a C<struct guestfs_statvfs *>, or NULL if there was an "
16548 "error. I<The caller must call C<guestfs_free_statvfs> after use>."
16552 #: ../src/guestfs-actions.pod:6334
16553 msgid "guestfs_strings"
16557 #: ../src/guestfs-actions.pod:6336
16561 " guestfs_strings (guestfs_h *g,\n"
16562 " const char *path);\n"
16567 #: ../src/guestfs-actions.pod:6340 ../fish/guestfish-actions.pod:4275
16569 "This runs the L<strings(1)> command on a file and returns the list of "
16570 "printable strings found."
16574 #: ../src/guestfs-actions.pod:6352
16575 msgid "guestfs_strings_e"
16579 #: ../src/guestfs-actions.pod:6354
16583 " guestfs_strings_e (guestfs_h *g,\n"
16584 " const char *encoding,\n"
16585 " const char *path);\n"
16590 #: ../src/guestfs-actions.pod:6359
16592 "This is like the C<guestfs_strings> command, but allows you to specify the "
16593 "encoding of strings that are looked for in the source file C<path>."
16597 #: ../src/guestfs-actions.pod:6363 ../fish/guestfish-actions.pod:4289
16598 msgid "Allowed encodings are:"
16602 #: ../src/guestfs-actions.pod:6367 ../fish/guestfish-actions.pod:4293
16607 #: ../src/guestfs-actions.pod:6369
16609 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
16610 "ISO-8859-X (this is what C<guestfs_strings> uses)."
16614 #: ../src/guestfs-actions.pod:6372 ../fish/guestfish-actions.pod:4298
16619 #: ../src/guestfs-actions.pod:6374 ../fish/guestfish-actions.pod:4300
16620 msgid "Single 8-bit-byte characters."
16624 #: ../src/guestfs-actions.pod:6376 ../fish/guestfish-actions.pod:4302
16629 #: ../src/guestfs-actions.pod:6378 ../fish/guestfish-actions.pod:4304
16630 msgid "16-bit big endian strings such as those encoded in UTF-16BE or UCS-2BE."
16634 #: ../src/guestfs-actions.pod:6381 ../fish/guestfish-actions.pod:4307
16635 msgid "l (lower case letter L)"
16639 #: ../src/guestfs-actions.pod:6383 ../fish/guestfish-actions.pod:4309
16641 "16-bit little endian such as UTF-16LE and UCS-2LE. This is useful for "
16642 "examining binaries in Windows guests."
16646 #: ../src/guestfs-actions.pod:6386 ../fish/guestfish-actions.pod:4312
16651 #: ../src/guestfs-actions.pod:6388 ../fish/guestfish-actions.pod:4314
16652 msgid "32-bit big endian such as UCS-4BE."
16656 #: ../src/guestfs-actions.pod:6390 ../fish/guestfish-actions.pod:4316
16661 #: ../src/guestfs-actions.pod:6392 ../fish/guestfish-actions.pod:4318
16662 msgid "32-bit little endian such as UCS-4LE."
16666 #: ../src/guestfs-actions.pod:6396 ../fish/guestfish-actions.pod:4322
16667 msgid "The returned strings are transcoded to UTF-8."
16671 #: ../src/guestfs-actions.pod:6407
16672 msgid "guestfs_swapoff_device"
16676 #: ../src/guestfs-actions.pod:6409
16680 " guestfs_swapoff_device (guestfs_h *g,\n"
16681 " const char *device);\n"
16686 #: ../src/guestfs-actions.pod:6413
16688 "This command disables the libguestfs appliance swap device or partition "
16689 "named C<device>. See C<guestfs_swapon_device>."
16693 #: ../src/guestfs-actions.pod:6421
16694 msgid "guestfs_swapoff_file"
16698 #: ../src/guestfs-actions.pod:6423
16702 " guestfs_swapoff_file (guestfs_h *g,\n"
16703 " const char *file);\n"
16708 #: ../src/guestfs-actions.pod:6427 ../fish/guestfish-actions.pod:4339
16709 msgid "This command disables the libguestfs appliance swap on file."
16713 #: ../src/guestfs-actions.pod:6433
16714 msgid "guestfs_swapoff_label"
16718 #: ../src/guestfs-actions.pod:6435
16722 " guestfs_swapoff_label (guestfs_h *g,\n"
16723 " const char *label);\n"
16728 #: ../src/guestfs-actions.pod:6439 ../fish/guestfish-actions.pod:4345
16730 "This command disables the libguestfs appliance swap on labeled swap "
16735 #: ../src/guestfs-actions.pod:6446
16736 msgid "guestfs_swapoff_uuid"
16740 #: ../src/guestfs-actions.pod:6448
16744 " guestfs_swapoff_uuid (guestfs_h *g,\n"
16745 " const char *uuid);\n"
16750 #: ../src/guestfs-actions.pod:6452 ../fish/guestfish-actions.pod:4352
16752 "This command disables the libguestfs appliance swap partition with the given "
16757 #: ../src/guestfs-actions.pod:6459
16758 msgid "guestfs_swapon_device"
16762 #: ../src/guestfs-actions.pod:6461
16766 " guestfs_swapon_device (guestfs_h *g,\n"
16767 " const char *device);\n"
16772 #: ../src/guestfs-actions.pod:6465
16774 "This command enables the libguestfs appliance to use the swap device or "
16775 "partition named C<device>. The increased memory is made available for all "
16776 "commands, for example those run using C<guestfs_command> or C<guestfs_sh>."
16780 #: ../src/guestfs-actions.pod:6470 ../fish/guestfish-actions.pod:4364
16782 "Note that you should not swap to existing guest swap partitions unless you "
16783 "know what you are doing. They may contain hibernation information, or other "
16784 "information that the guest doesn't want you to trash. You also risk leaking "
16785 "information about the host to the guest this way. Instead, attach a new "
16786 "host device to the guest and swap on that."
16790 #: ../src/guestfs-actions.pod:6481
16791 msgid "guestfs_swapon_file"
16795 #: ../src/guestfs-actions.pod:6483
16799 " guestfs_swapon_file (guestfs_h *g,\n"
16800 " const char *file);\n"
16805 #: ../src/guestfs-actions.pod:6487
16807 "This command enables swap to a file. See C<guestfs_swapon_device> for other "
16812 #: ../src/guestfs-actions.pod:6494
16813 msgid "guestfs_swapon_label"
16817 #: ../src/guestfs-actions.pod:6496
16821 " guestfs_swapon_label (guestfs_h *g,\n"
16822 " const char *label);\n"
16827 #: ../src/guestfs-actions.pod:6500
16829 "This command enables swap to a labeled swap partition. See "
16830 "C<guestfs_swapon_device> for other notes."
16834 #: ../src/guestfs-actions.pod:6507
16835 msgid "guestfs_swapon_uuid"
16839 #: ../src/guestfs-actions.pod:6509
16843 " guestfs_swapon_uuid (guestfs_h *g,\n"
16844 " const char *uuid);\n"
16849 #: ../src/guestfs-actions.pod:6513
16851 "This command enables swap to a swap partition with the given UUID. See "
16852 "C<guestfs_swapon_device> for other notes."
16856 #: ../src/guestfs-actions.pod:6520
16857 msgid "guestfs_sync"
16861 #: ../src/guestfs-actions.pod:6522
16865 " guestfs_sync (guestfs_h *g);\n"
16870 #: ../src/guestfs-actions.pod:6525 ../fish/guestfish-actions.pod:4396
16872 "This syncs the disk, so that any writes are flushed through to the "
16873 "underlying disk image."
16877 #: ../src/guestfs-actions.pod:6528 ../fish/guestfish-actions.pod:4399
16879 "You should always call this if you have modified a disk image, before "
16880 "closing the handle."
16884 #: ../src/guestfs-actions.pod:6535
16885 msgid "guestfs_tail"
16889 #: ../src/guestfs-actions.pod:6537
16893 " guestfs_tail (guestfs_h *g,\n"
16894 " const char *path);\n"
16899 #: ../src/guestfs-actions.pod:6541 ../fish/guestfish-actions.pod:4406
16901 "This command returns up to the last 10 lines of a file as a list of strings."
16905 #: ../src/guestfs-actions.pod:6553
16906 msgid "guestfs_tail_n"
16910 #: ../src/guestfs-actions.pod:6555
16914 " guestfs_tail_n (guestfs_h *g,\n"
16916 " const char *path);\n"
16921 #: ../src/guestfs-actions.pod:6560 ../fish/guestfish-actions.pod:4416
16923 "If the parameter C<nrlines> is a positive number, this returns the last "
16924 "C<nrlines> lines of the file C<path>."
16928 #: ../src/guestfs-actions.pod:6563 ../fish/guestfish-actions.pod:4419
16930 "If the parameter C<nrlines> is a negative number, this returns lines from "
16931 "the file C<path>, starting with the C<-nrlines>th line."
16935 #: ../src/guestfs-actions.pod:6577
16936 msgid "guestfs_tar_in"
16940 #: ../src/guestfs-actions.pod:6579
16944 " guestfs_tar_in (guestfs_h *g,\n"
16945 " const char *tarfile,\n"
16946 " const char *directory);\n"
16951 #: ../src/guestfs-actions.pod:6584 ../fish/guestfish-actions.pod:4431
16953 "This command uploads and unpacks local file C<tarfile> (an I<uncompressed> "
16954 "tar file) into C<directory>."
16958 #: ../src/guestfs-actions.pod:6587
16960 "To upload a compressed tarball, use C<guestfs_tgz_in> or C<guestfs_txz_in>."
16964 #: ../src/guestfs-actions.pod:6592 ../src/guestfs-actions.pod:6609
16965 #: ../src/guestfs-actions.pod:6625 ../src/guestfs-actions.pod:6641
16966 msgid "(Added in 1.0.3)"
16970 #: ../src/guestfs-actions.pod:6594
16971 msgid "guestfs_tar_out"
16975 #: ../src/guestfs-actions.pod:6596
16979 " guestfs_tar_out (guestfs_h *g,\n"
16980 " const char *directory,\n"
16981 " const char *tarfile);\n"
16986 #: ../src/guestfs-actions.pod:6601 ../fish/guestfish-actions.pod:4443
16988 "This command packs the contents of C<directory> and downloads it to local "
16993 #: ../src/guestfs-actions.pod:6604
16995 "To download a compressed tarball, use C<guestfs_tgz_out> or "
16996 "C<guestfs_txz_out>."
17000 #: ../src/guestfs-actions.pod:6611
17001 msgid "guestfs_tgz_in"
17005 #: ../src/guestfs-actions.pod:6613
17009 " guestfs_tgz_in (guestfs_h *g,\n"
17010 " const char *tarball,\n"
17011 " const char *directory);\n"
17016 #: ../src/guestfs-actions.pod:6618 ../fish/guestfish-actions.pod:4455
17018 "This command uploads and unpacks local file C<tarball> (a I<gzip compressed> "
17019 "tar file) into C<directory>."
17023 #: ../src/guestfs-actions.pod:6621
17024 msgid "To upload an uncompressed tarball, use C<guestfs_tar_in>."
17028 #: ../src/guestfs-actions.pod:6627
17029 msgid "guestfs_tgz_out"
17033 #: ../src/guestfs-actions.pod:6629
17037 " guestfs_tgz_out (guestfs_h *g,\n"
17038 " const char *directory,\n"
17039 " const char *tarball);\n"
17044 #: ../src/guestfs-actions.pod:6634 ../fish/guestfish-actions.pod:4466
17046 "This command packs the contents of C<directory> and downloads it to local "
17051 #: ../src/guestfs-actions.pod:6637
17052 msgid "To download an uncompressed tarball, use C<guestfs_tar_out>."
17056 #: ../src/guestfs-actions.pod:6643
17057 msgid "guestfs_touch"
17061 #: ../src/guestfs-actions.pod:6645
17065 " guestfs_touch (guestfs_h *g,\n"
17066 " const char *path);\n"
17071 #: ../src/guestfs-actions.pod:6649 ../fish/guestfish-actions.pod:4477
17073 "Touch acts like the L<touch(1)> command. It can be used to update the "
17074 "timestamps on a file, or, if the file does not exist, to create a new zero-"
17079 #: ../src/guestfs-actions.pod:6653 ../fish/guestfish-actions.pod:4481
17081 "This command only works on regular files, and will fail on other file types "
17082 "such as directories, symbolic links, block special etc."
17086 #: ../src/guestfs-actions.pod:6660
17087 msgid "guestfs_truncate"
17091 #: ../src/guestfs-actions.pod:6662
17095 " guestfs_truncate (guestfs_h *g,\n"
17096 " const char *path);\n"
17101 #: ../src/guestfs-actions.pod:6666 ../fish/guestfish-actions.pod:4488
17103 "This command truncates C<path> to a zero-length file. The file must exist "
17108 #: ../src/guestfs-actions.pod:6673
17109 msgid "guestfs_truncate_size"
17113 #: ../src/guestfs-actions.pod:6675
17117 " guestfs_truncate_size (guestfs_h *g,\n"
17118 " const char *path,\n"
17119 " int64_t size);\n"
17124 #: ../src/guestfs-actions.pod:6680 ../fish/guestfish-actions.pod:4495
17126 "This command truncates C<path> to size C<size> bytes. The file must exist "
17131 #: ../src/guestfs-actions.pod:6683
17133 "If the current file size is less than C<size> then the file is extended to "
17134 "the required size with zero bytes. This creates a sparse file (ie. disk "
17135 "blocks are not allocated for the file until you write to it). To create a "
17136 "non-sparse file of zeroes, use C<guestfs_fallocate64> instead."
17140 #: ../src/guestfs-actions.pod:6693
17141 msgid "guestfs_tune2fs_l"
17145 #: ../src/guestfs-actions.pod:6695
17149 " guestfs_tune2fs_l (guestfs_h *g,\n"
17150 " const char *device);\n"
17155 #: ../src/guestfs-actions.pod:6699 ../fish/guestfish-actions.pod:4508
17157 "This returns the contents of the ext2, ext3 or ext4 filesystem superblock on "
17162 #: ../src/guestfs-actions.pod:6702 ../fish/guestfish-actions.pod:4511
17164 "It is the same as running C<tune2fs -l device>. See L<tune2fs(8)> manpage "
17165 "for more details. The list of fields returned isn't clearly defined, and "
17166 "depends on both the version of C<tune2fs> that libguestfs was built against, "
17167 "and the filesystem itself."
17171 #: ../src/guestfs-actions.pod:6715
17172 msgid "guestfs_txz_in"
17176 #: ../src/guestfs-actions.pod:6717
17180 " guestfs_txz_in (guestfs_h *g,\n"
17181 " const char *tarball,\n"
17182 " const char *directory);\n"
17187 #: ../src/guestfs-actions.pod:6722 ../fish/guestfish-actions.pod:4520
17189 "This command uploads and unpacks local file C<tarball> (an I<xz compressed> "
17190 "tar file) into C<directory>."
17194 #: ../src/guestfs-actions.pod:6729
17195 msgid "guestfs_txz_out"
17199 #: ../src/guestfs-actions.pod:6731
17203 " guestfs_txz_out (guestfs_h *g,\n"
17204 " const char *directory,\n"
17205 " const char *tarball);\n"
17210 #: ../src/guestfs-actions.pod:6736 ../fish/guestfish-actions.pod:4529
17212 "This command packs the contents of C<directory> and downloads it to local "
17213 "file C<tarball> (as an xz compressed tar archive)."
17217 #: ../src/guestfs-actions.pod:6743
17218 msgid "guestfs_umask"
17222 #: ../src/guestfs-actions.pod:6745
17226 " guestfs_umask (guestfs_h *g,\n"
17232 #: ../src/guestfs-actions.pod:6749 ../fish/guestfish-actions.pod:4538
17234 "This function sets the mask used for creating new files and device nodes to "
17239 #: ../src/guestfs-actions.pod:6752 ../fish/guestfish-actions.pod:4541
17241 "Typical umask values would be C<022> which creates new files with "
17242 "permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and C<002> which creates "
17243 "new files with permissions like \"-rw-rw-r--\" or \"-rwxrwxr-x\"."
17247 #: ../src/guestfs-actions.pod:6757 ../fish/guestfish-actions.pod:4546
17249 "The default umask is C<022>. This is important because it means that "
17250 "directories and device nodes will be created with C<0644> or C<0755> mode "
17251 "even if you specify C<0777>."
17255 #: ../src/guestfs-actions.pod:6761
17257 "See also C<guestfs_get_umask>, L<umask(2)>, C<guestfs_mknod>, "
17258 "C<guestfs_mkdir>."
17262 #: ../src/guestfs-actions.pod:6764 ../fish/guestfish-actions.pod:4553
17263 msgid "This call returns the previous umask."
17267 #: ../src/guestfs-actions.pod:6770
17268 msgid "guestfs_umount"
17272 #: ../src/guestfs-actions.pod:6772
17276 " guestfs_umount (guestfs_h *g,\n"
17277 " const char *pathordevice);\n"
17282 #: ../src/guestfs-actions.pod:6776 ../fish/guestfish-actions.pod:4561
17284 "This unmounts the given filesystem. The filesystem may be specified either "
17285 "by its mountpoint (path) or the device which contains the filesystem."
17289 #: ../src/guestfs-actions.pod:6784
17290 msgid "guestfs_umount_all"
17294 #: ../src/guestfs-actions.pod:6786
17298 " guestfs_umount_all (guestfs_h *g);\n"
17303 #: ../src/guestfs-actions.pod:6789 ../fish/guestfish-actions.pod:4571
17304 msgid "This unmounts all mounted filesystems."
17308 #: ../src/guestfs-actions.pod:6791 ../fish/guestfish-actions.pod:4573
17309 msgid "Some internal mounts are not unmounted by this call."
17313 #: ../src/guestfs-actions.pod:6797
17314 msgid "guestfs_upload"
17318 #: ../src/guestfs-actions.pod:6799
17322 " guestfs_upload (guestfs_h *g,\n"
17323 " const char *filename,\n"
17324 " const char *remotefilename);\n"
17329 #: ../src/guestfs-actions.pod:6804 ../src/guestfs-actions.pod:6828
17330 #: ../fish/guestfish-actions.pod:4579 ../fish/guestfish-actions.pod:4592
17331 msgid "Upload local file C<filename> to C<remotefilename> on the filesystem."
17335 #: ../src/guestfs-actions.pod:6809
17336 msgid "See also C<guestfs_download>."
17340 #: ../src/guestfs-actions.pod:6820
17341 msgid "guestfs_upload_offset"
17345 #: ../src/guestfs-actions.pod:6822
17349 " guestfs_upload_offset (guestfs_h *g,\n"
17350 " const char *filename,\n"
17351 " const char *remotefilename,\n"
17352 " int64_t offset);\n"
17357 #: ../src/guestfs-actions.pod:6831 ../fish/guestfish-actions.pod:4595
17359 "C<remotefilename> is overwritten starting at the byte C<offset> specified. "
17360 "The intention is to overwrite parts of existing files or devices, although "
17361 "if a non-existant file is specified then it is created with a \"hole\" "
17362 "before C<offset>. The size of the data written is implicit in the size of "
17363 "the source C<filename>."
17367 #: ../src/guestfs-actions.pod:6838
17369 "Note that there is no limit on the amount of data that can be uploaded with "
17370 "this call, unlike with C<guestfs_pwrite>, and this call always writes the "
17371 "full amount unless an error occurs."
17375 #: ../src/guestfs-actions.pod:6843
17376 msgid "See also C<guestfs_upload>, C<guestfs_pwrite>."
17380 #: ../src/guestfs-actions.pod:6854
17381 msgid "guestfs_utimens"
17385 #: ../src/guestfs-actions.pod:6856
17389 " guestfs_utimens (guestfs_h *g,\n"
17390 " const char *path,\n"
17391 " int64_t atsecs,\n"
17392 " int64_t atnsecs,\n"
17393 " int64_t mtsecs,\n"
17394 " int64_t mtnsecs);\n"
17399 #: ../src/guestfs-actions.pod:6864 ../fish/guestfish-actions.pod:4615
17400 msgid "This command sets the timestamps of a file with nanosecond precision."
17404 #: ../src/guestfs-actions.pod:6867 ../fish/guestfish-actions.pod:4618
17406 "C<atsecs, atnsecs> are the last access time (atime) in secs and nanoseconds "
17411 #: ../src/guestfs-actions.pod:6870 ../fish/guestfish-actions.pod:4621
17413 "C<mtsecs, mtnsecs> are the last modification time (mtime) in secs and "
17414 "nanoseconds from the epoch."
17418 #: ../src/guestfs-actions.pod:6873 ../fish/guestfish-actions.pod:4624
17420 "If the C<*nsecs> field contains the special value C<-1> then the "
17421 "corresponding timestamp is set to the current time. (The C<*secs> field is "
17422 "ignored in this case)."
17426 #: ../src/guestfs-actions.pod:6877 ../fish/guestfish-actions.pod:4628
17428 "If the C<*nsecs> field contains the special value C<-2> then the "
17429 "corresponding timestamp is left unchanged. (The C<*secs> field is ignored "
17434 #: ../src/guestfs-actions.pod:6885 ../src/guestfs-structs.pod:175
17435 msgid "guestfs_version"
17439 #: ../src/guestfs-actions.pod:6887
17442 " struct guestfs_version *\n"
17443 " guestfs_version (guestfs_h *g);\n"
17448 #: ../src/guestfs-actions.pod:6890 ../fish/guestfish-actions.pod:4636
17450 "Return the libguestfs version number that the program is linked against."
17454 #: ../src/guestfs-actions.pod:6893 ../fish/guestfish-actions.pod:4639
17456 "Note that because of dynamic linking this is not necessarily the version of "
17457 "libguestfs that you compiled against. You can compile the program, and then "
17458 "at runtime dynamically link against a completely different C<libguestfs.so> "
17463 #: ../src/guestfs-actions.pod:6898 ../fish/guestfish-actions.pod:4644
17465 "This call was added in version C<1.0.58>. In previous versions of "
17466 "libguestfs there was no way to get the version number. From C code you can "
17467 "use dynamic linker functions to find out if this symbol exists (if it "
17468 "doesn't, then it's an earlier version)."
17472 #: ../src/guestfs-actions.pod:6904 ../fish/guestfish-actions.pod:4650
17474 "The call returns a structure with four elements. The first three (C<major>, "
17475 "C<minor> and C<release>) are numbers and correspond to the usual version "
17476 "triplet. The fourth element (C<extra>) is a string and is normally empty, "
17477 "but may be used for distro-specific information."
17481 #: ../src/guestfs-actions.pod:6910 ../fish/guestfish-actions.pod:4656
17483 "To construct the original version string: C<$major.$minor.$release$extra>"
17487 #: ../src/guestfs-actions.pod:6913 ../fish/guestfish-actions.pod:4659
17488 msgid "See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>."
17492 #: ../src/guestfs-actions.pod:6915
17494 "I<Note:> Don't use this call to test for availability of features. In "
17495 "enterprise distributions we backport features from later versions into "
17496 "earlier versions, making this an unreliable way to test for features. Use "
17497 "C<guestfs_available> instead."
17501 #: ../src/guestfs-actions.pod:6921
17503 "This function returns a C<struct guestfs_version *>, or NULL if there was an "
17504 "error. I<The caller must call C<guestfs_free_version> after use>."
17508 #: ../src/guestfs-actions.pod:6925
17509 msgid "(Added in 1.0.58)"
17513 #: ../src/guestfs-actions.pod:6927
17514 msgid "guestfs_vfs_label"
17518 #: ../src/guestfs-actions.pod:6929
17522 " guestfs_vfs_label (guestfs_h *g,\n"
17523 " const char *device);\n"
17528 #: ../src/guestfs-actions.pod:6933 ../fish/guestfish-actions.pod:4671
17529 msgid "This returns the filesystem label of the filesystem on C<device>."
17533 #: ../src/guestfs-actions.pod:6936 ../fish/guestfish-actions.pod:4674
17534 msgid "If the filesystem is unlabeled, this returns the empty string."
17538 #: ../src/guestfs-actions.pod:6938
17539 msgid "To find a filesystem from the label, use C<guestfs_findfs_label>."
17543 #: ../src/guestfs-actions.pod:6943 ../src/guestfs-actions.pod:6980
17544 msgid "(Added in 1.3.18)"
17548 #: ../src/guestfs-actions.pod:6945
17549 msgid "guestfs_vfs_type"
17553 #: ../src/guestfs-actions.pod:6947
17557 " guestfs_vfs_type (guestfs_h *g,\n"
17558 " const char *device);\n"
17563 #: ../src/guestfs-actions.pod:6951 ../fish/guestfish-actions.pod:4682
17565 "This command gets the filesystem type corresponding to the filesystem on "
17570 #: ../src/guestfs-actions.pod:6954 ../fish/guestfish-actions.pod:4685
17572 "For most filesystems, the result is the name of the Linux VFS module which "
17573 "would be used to mount this filesystem if you mounted it without specifying "
17574 "the filesystem type. For example a string such as C<ext3> or C<ntfs>."
17578 #: ../src/guestfs-actions.pod:6964
17579 msgid "guestfs_vfs_uuid"
17583 #: ../src/guestfs-actions.pod:6966
17587 " guestfs_vfs_uuid (guestfs_h *g,\n"
17588 " const char *device);\n"
17593 #: ../src/guestfs-actions.pod:6970 ../fish/guestfish-actions.pod:4694
17594 msgid "This returns the filesystem UUID of the filesystem on C<device>."
17598 #: ../src/guestfs-actions.pod:6973 ../fish/guestfish-actions.pod:4697
17599 msgid "If the filesystem does not have a UUID, this returns the empty string."
17603 #: ../src/guestfs-actions.pod:6975
17604 msgid "To find a filesystem from the UUID, use C<guestfs_findfs_uuid>."
17608 #: ../src/guestfs-actions.pod:6982
17609 msgid "guestfs_vg_activate"
17613 #: ../src/guestfs-actions.pod:6984
17617 " guestfs_vg_activate (guestfs_h *g,\n"
17619 " char *const *volgroups);\n"
17624 #: ../src/guestfs-actions.pod:6989 ../fish/guestfish-actions.pod:4705
17626 "This command activates or (if C<activate> is false) deactivates all logical "
17627 "volumes in the listed volume groups C<volgroups>. If activated, then they "
17628 "are made known to the kernel, ie. they appear as C</dev/mapper> devices. If "
17629 "deactivated, then those devices disappear."
17633 #: ../src/guestfs-actions.pod:6995 ../fish/guestfish-actions.pod:4711
17634 msgid "This command is the same as running C<vgchange -a y|n volgroups...>"
17638 #: ../src/guestfs-actions.pod:6997 ../fish/guestfish-actions.pod:4713
17640 "Note that if C<volgroups> is an empty list then B<all> volume groups are "
17641 "activated or deactivated."
17645 #: ../src/guestfs-actions.pod:7004
17646 msgid "guestfs_vg_activate_all"
17650 #: ../src/guestfs-actions.pod:7006
17654 " guestfs_vg_activate_all (guestfs_h *g,\n"
17655 " int activate);\n"
17660 #: ../src/guestfs-actions.pod:7010 ../fish/guestfish-actions.pod:4720
17662 "This command activates or (if C<activate> is false) deactivates all logical "
17663 "volumes in all volume groups. If activated, then they are made known to the "
17664 "kernel, ie. they appear as C</dev/mapper> devices. If deactivated, then "
17665 "those devices disappear."
17669 #: ../src/guestfs-actions.pod:7016 ../fish/guestfish-actions.pod:4726
17670 msgid "This command is the same as running C<vgchange -a y|n>"
17674 #: ../src/guestfs-actions.pod:7022
17675 msgid "guestfs_vgcreate"
17679 #: ../src/guestfs-actions.pod:7024
17683 " guestfs_vgcreate (guestfs_h *g,\n"
17684 " const char *volgroup,\n"
17685 " char *const *physvols);\n"
17690 #: ../src/guestfs-actions.pod:7029 ../fish/guestfish-actions.pod:4732
17692 "This creates an LVM volume group called C<volgroup> from the non-empty list "
17693 "of physical volumes C<physvols>."
17697 #: ../src/guestfs-actions.pod:7036
17698 msgid "guestfs_vglvuuids"
17702 #: ../src/guestfs-actions.pod:7038
17706 " guestfs_vglvuuids (guestfs_h *g,\n"
17707 " const char *vgname);\n"
17712 #: ../src/guestfs-actions.pod:7042 ../fish/guestfish-actions.pod:4739
17714 "Given a VG called C<vgname>, this returns the UUIDs of all the logical "
17715 "volumes created in this volume group."
17719 #: ../src/guestfs-actions.pod:7045
17721 "You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid> calls to "
17722 "associate logical volumes and volume groups."
17726 #: ../src/guestfs-actions.pod:7048
17727 msgid "See also C<guestfs_vgpvuuids>."
17731 #: ../src/guestfs-actions.pod:7056
17732 msgid "guestfs_vgpvuuids"
17736 #: ../src/guestfs-actions.pod:7058
17740 " guestfs_vgpvuuids (guestfs_h *g,\n"
17741 " const char *vgname);\n"
17746 #: ../src/guestfs-actions.pod:7062 ../fish/guestfish-actions.pod:4751
17748 "Given a VG called C<vgname>, this returns the UUIDs of all the physical "
17749 "volumes that this volume group resides on."
17753 #: ../src/guestfs-actions.pod:7065
17755 "You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid> calls to "
17756 "associate physical volumes and volume groups."
17760 #: ../src/guestfs-actions.pod:7068
17761 msgid "See also C<guestfs_vglvuuids>."
17765 #: ../src/guestfs-actions.pod:7076
17766 msgid "guestfs_vgremove"
17770 #: ../src/guestfs-actions.pod:7078
17774 " guestfs_vgremove (guestfs_h *g,\n"
17775 " const char *vgname);\n"
17780 #: ../src/guestfs-actions.pod:7082 ../fish/guestfish-actions.pod:4763
17781 msgid "Remove an LVM volume group C<vgname>, (for example C<VG>)."
17785 #: ../src/guestfs-actions.pod:7084 ../fish/guestfish-actions.pod:4765
17787 "This also forcibly removes all logical volumes in the volume group (if any)."
17791 #: ../src/guestfs-actions.pod:7091
17792 msgid "guestfs_vgrename"
17796 #: ../src/guestfs-actions.pod:7093
17800 " guestfs_vgrename (guestfs_h *g,\n"
17801 " const char *volgroup,\n"
17802 " const char *newvolgroup);\n"
17807 #: ../src/guestfs-actions.pod:7098 ../fish/guestfish-actions.pod:4772
17808 msgid "Rename a volume group C<volgroup> with the new name C<newvolgroup>."
17812 #: ../src/guestfs-actions.pod:7104
17813 msgid "guestfs_vgs"
17817 #: ../src/guestfs-actions.pod:7106
17821 " guestfs_vgs (guestfs_h *g);\n"
17826 #: ../src/guestfs-actions.pod:7109 ../fish/guestfish-actions.pod:4778
17828 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
17833 #: ../src/guestfs-actions.pod:7112 ../fish/guestfish-actions.pod:4781
17835 "This returns a list of just the volume group names that were detected (eg. "
17840 #: ../src/guestfs-actions.pod:7115
17841 msgid "See also C<guestfs_vgs_full>."
17845 #: ../src/guestfs-actions.pod:7123
17846 msgid "guestfs_vgs_full"
17850 #: ../src/guestfs-actions.pod:7125
17853 " struct guestfs_lvm_vg_list *\n"
17854 " guestfs_vgs_full (guestfs_h *g);\n"
17859 #: ../src/guestfs-actions.pod:7128 ../fish/guestfish-actions.pod:4790
17861 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
17862 "> command. The \"full\" version includes all fields."
17866 #: ../src/guestfs-actions.pod:7131
17868 "This function returns a C<struct guestfs_lvm_vg_list *>, or NULL if there "
17869 "was an error. I<The caller must call C<guestfs_free_lvm_vg_list> after use>."
17873 #: ../src/guestfs-actions.pod:7137
17874 msgid "guestfs_vgscan"
17878 #: ../src/guestfs-actions.pod:7139
17882 " guestfs_vgscan (guestfs_h *g);\n"
17887 #: ../src/guestfs-actions.pod:7142 ../fish/guestfish-actions.pod:4797
17889 "This rescans all block devices and rebuilds the list of LVM physical "
17890 "volumes, volume groups and logical volumes."
17894 #: ../src/guestfs-actions.pod:7149
17895 msgid "guestfs_vguuid"
17899 #: ../src/guestfs-actions.pod:7151
17903 " guestfs_vguuid (guestfs_h *g,\n"
17904 " const char *vgname);\n"
17909 #: ../src/guestfs-actions.pod:7155 ../fish/guestfish-actions.pod:4804
17910 msgid "This command returns the UUID of the LVM VG named C<vgname>."
17914 #: ../src/guestfs-actions.pod:7162
17915 msgid "guestfs_wait_ready"
17919 #: ../src/guestfs-actions.pod:7164
17923 " guestfs_wait_ready (guestfs_h *g);\n"
17928 #: ../src/guestfs-actions.pod:7167
17929 msgid "This function is a no op."
17933 #: ../src/guestfs-actions.pod:7169
17935 "In versions of the API E<lt> 1.0.71 you had to call this function just after "
17936 "calling C<guestfs_launch> to wait for the launch to complete. However this "
17937 "is no longer necessary because C<guestfs_launch> now does the waiting."
17941 #: ../src/guestfs-actions.pod:7174
17943 "If you see any calls to this function in code then you can just remove them, "
17944 "unless you want to retain compatibility with older versions of the API."
17948 #: ../src/guestfs-actions.pod:7182
17949 msgid "guestfs_wc_c"
17953 #: ../src/guestfs-actions.pod:7184
17957 " guestfs_wc_c (guestfs_h *g,\n"
17958 " const char *path);\n"
17963 #: ../src/guestfs-actions.pod:7188 ../fish/guestfish-actions.pod:4810
17965 "This command counts the characters in a file, using the C<wc -c> external "
17970 #: ../src/guestfs-actions.pod:7195
17971 msgid "guestfs_wc_l"
17975 #: ../src/guestfs-actions.pod:7197
17979 " guestfs_wc_l (guestfs_h *g,\n"
17980 " const char *path);\n"
17985 #: ../src/guestfs-actions.pod:7201 ../fish/guestfish-actions.pod:4817
17987 "This command counts the lines in a file, using the C<wc -l> external command."
17991 #: ../src/guestfs-actions.pod:7208
17992 msgid "guestfs_wc_w"
17996 #: ../src/guestfs-actions.pod:7210
18000 " guestfs_wc_w (guestfs_h *g,\n"
18001 " const char *path);\n"
18006 #: ../src/guestfs-actions.pod:7214 ../fish/guestfish-actions.pod:4824
18008 "This command counts the words in a file, using the C<wc -w> external command."
18012 #: ../src/guestfs-actions.pod:7221
18013 msgid "guestfs_write"
18017 #: ../src/guestfs-actions.pod:7223
18021 " guestfs_write (guestfs_h *g,\n"
18022 " const char *path,\n"
18023 " const char *content,\n"
18024 " size_t content_size);\n"
18029 #: ../src/guestfs-actions.pod:7229 ../fish/guestfish-actions.pod:4831
18031 "This call creates a file called C<path>. The content of the file is the "
18032 "string C<content> (which can contain any 8 bit data)."
18036 #: ../src/guestfs-actions.pod:7239
18037 msgid "guestfs_write_file"
18041 #: ../src/guestfs-actions.pod:7241
18045 " guestfs_write_file (guestfs_h *g,\n"
18046 " const char *path,\n"
18047 " const char *content,\n"
18053 #: ../src/guestfs-actions.pod:7247 ../fish/guestfish-actions.pod:4841
18055 "This call creates a file called C<path>. The contents of the file is the "
18056 "string C<content> (which can contain any 8 bit data), with length C<size>."
18060 #: ../src/guestfs-actions.pod:7251 ../fish/guestfish-actions.pod:4845
18062 "As a special case, if C<size> is C<0> then the length is calculated using "
18063 "C<strlen> (so in this case the content cannot contain embedded ASCII NULs)."
18067 #: ../src/guestfs-actions.pod:7255 ../fish/guestfish-actions.pod:4849
18069 "I<NB.> Owing to a bug, writing content containing ASCII NUL characters does "
18070 "I<not> work, even if the length is specified."
18074 #: ../src/guestfs-actions.pod:7263 ../fish/guestfish-actions.pod:4855
18076 "This function is deprecated. In new code, use the C<write> call instead."
18080 #: ../src/guestfs-actions.pod:7272
18081 msgid "guestfs_zegrep"
18085 #: ../src/guestfs-actions.pod:7274
18089 " guestfs_zegrep (guestfs_h *g,\n"
18090 " const char *regex,\n"
18091 " const char *path);\n"
18096 #: ../src/guestfs-actions.pod:7279 ../fish/guestfish-actions.pod:4866
18098 "This calls the external C<zegrep> program and returns the matching lines."
18102 #: ../src/guestfs-actions.pod:7291
18103 msgid "guestfs_zegrepi"
18107 #: ../src/guestfs-actions.pod:7293
18111 " guestfs_zegrepi (guestfs_h *g,\n"
18112 " const char *regex,\n"
18113 " const char *path);\n"
18118 #: ../src/guestfs-actions.pod:7298 ../fish/guestfish-actions.pod:4876
18120 "This calls the external C<zegrep -i> program and returns the matching lines."
18124 #: ../src/guestfs-actions.pod:7310
18125 msgid "guestfs_zero"
18129 #: ../src/guestfs-actions.pod:7312
18133 " guestfs_zero (guestfs_h *g,\n"
18134 " const char *device);\n"
18139 #: ../src/guestfs-actions.pod:7316 ../fish/guestfish-actions.pod:4886
18140 msgid "This command writes zeroes over the first few blocks of C<device>."
18144 #: ../src/guestfs-actions.pod:7318 ../fish/guestfish-actions.pod:4888
18146 "How many blocks are zeroed isn't specified (but it's I<not> enough to "
18147 "securely wipe the device). It should be sufficient to remove any partition "
18148 "tables, filesystem superblocks and so on."
18152 #: ../src/guestfs-actions.pod:7322
18153 msgid "See also: C<guestfs_zero_device>, C<guestfs_scrub_device>."
18157 #: ../src/guestfs-actions.pod:7333
18158 msgid "guestfs_zero_device"
18162 #: ../src/guestfs-actions.pod:7335
18166 " guestfs_zero_device (guestfs_h *g,\n"
18167 " const char *device);\n"
18172 #: ../src/guestfs-actions.pod:7339
18174 "This command writes zeroes over the entire C<device>. Compare with "
18175 "C<guestfs_zero> which just zeroes the first few blocks of a device."
18179 #: ../src/guestfs-actions.pod:7353
18180 msgid "(Added in 1.3.1)"
18184 #: ../src/guestfs-actions.pod:7355
18185 msgid "guestfs_zerofree"
18189 #: ../src/guestfs-actions.pod:7357
18193 " guestfs_zerofree (guestfs_h *g,\n"
18194 " const char *device);\n"
18199 #: ../src/guestfs-actions.pod:7361 ../fish/guestfish-actions.pod:4909
18201 "This runs the I<zerofree> program on C<device>. This program claims to zero "
18202 "unused inodes and disk blocks on an ext2/3 filesystem, thus making it "
18203 "possible to compress the filesystem more effectively."
18207 #: ../src/guestfs-actions.pod:7366 ../fish/guestfish-actions.pod:4914
18208 msgid "You should B<not> run this program if the filesystem is mounted."
18212 #: ../src/guestfs-actions.pod:7369 ../fish/guestfish-actions.pod:4917
18214 "It is possible that using this program can damage the filesystem or data on "
18219 #: ../src/guestfs-actions.pod:7376
18220 msgid "guestfs_zfgrep"
18224 #: ../src/guestfs-actions.pod:7378
18228 " guestfs_zfgrep (guestfs_h *g,\n"
18229 " const char *pattern,\n"
18230 " const char *path);\n"
18235 #: ../src/guestfs-actions.pod:7383 ../fish/guestfish-actions.pod:4924
18237 "This calls the external C<zfgrep> program and returns the matching lines."
18241 #: ../src/guestfs-actions.pod:7395
18242 msgid "guestfs_zfgrepi"
18246 #: ../src/guestfs-actions.pod:7397
18250 " guestfs_zfgrepi (guestfs_h *g,\n"
18251 " const char *pattern,\n"
18252 " const char *path);\n"
18257 #: ../src/guestfs-actions.pod:7402 ../fish/guestfish-actions.pod:4934
18259 "This calls the external C<zfgrep -i> program and returns the matching lines."
18263 #: ../src/guestfs-actions.pod:7414
18264 msgid "guestfs_zfile"
18268 #: ../src/guestfs-actions.pod:7416
18272 " guestfs_zfile (guestfs_h *g,\n"
18273 " const char *meth,\n"
18274 " const char *path);\n"
18279 #: ../src/guestfs-actions.pod:7421 ../fish/guestfish-actions.pod:4944
18281 "This command runs C<file> after first decompressing C<path> using C<method>."
18285 #: ../src/guestfs-actions.pod:7424 ../fish/guestfish-actions.pod:4947
18286 msgid "C<method> must be one of C<gzip>, C<compress> or C<bzip2>."
18290 #: ../src/guestfs-actions.pod:7426
18292 "Since 1.0.63, use C<guestfs_file> instead which can now process compressed "
18297 #: ../src/guestfs-actions.pod:7432 ../fish/guestfish-actions.pod:4952
18299 "This function is deprecated. In new code, use the C<file> call instead."
18303 #: ../src/guestfs-actions.pod:7441
18304 msgid "guestfs_zgrep"
18308 #: ../src/guestfs-actions.pod:7443
18312 " guestfs_zgrep (guestfs_h *g,\n"
18313 " const char *regex,\n"
18314 " const char *path);\n"
18319 #: ../src/guestfs-actions.pod:7448 ../fish/guestfish-actions.pod:4963
18321 "This calls the external C<zgrep> program and returns the matching lines."
18325 #: ../src/guestfs-actions.pod:7460
18326 msgid "guestfs_zgrepi"
18330 #: ../src/guestfs-actions.pod:7462
18334 " guestfs_zgrepi (guestfs_h *g,\n"
18335 " const char *regex,\n"
18336 " const char *path);\n"
18341 #: ../src/guestfs-actions.pod:7467 ../fish/guestfish-actions.pod:4973
18343 "This calls the external C<zgrep -i> program and returns the matching lines."
18347 #: ../src/guestfs-availability.pod:3
18352 #: ../src/guestfs-availability.pod:5
18354 "The following functions: L</guestfs_aug_clear> L</guestfs_aug_close> L</"
18355 "guestfs_aug_defnode> L</guestfs_aug_defvar> L</guestfs_aug_get> L</"
18356 "guestfs_aug_init> L</guestfs_aug_insert> L</guestfs_aug_load> L</"
18357 "guestfs_aug_ls> L</guestfs_aug_match> L</guestfs_aug_mv> L</guestfs_aug_rm> "
18358 "L</guestfs_aug_save> L</guestfs_aug_set>"
18362 #: ../src/guestfs-availability.pod:21
18367 #: ../src/guestfs-availability.pod:23
18369 "The following functions: L</guestfs_inotify_add_watch> L</"
18370 "guestfs_inotify_close> L</guestfs_inotify_files> L</guestfs_inotify_init> L</"
18371 "guestfs_inotify_read> L</guestfs_inotify_rm_watch>"
18375 #: ../src/guestfs-availability.pod:31
18376 msgid "B<linuxfsuuid>"
18380 #: ../src/guestfs-availability.pod:33
18382 "The following functions: L</guestfs_mke2fs_JU> L</guestfs_mke2journal_U> L</"
18383 "guestfs_mkswap_U> L</guestfs_swapoff_uuid> L</guestfs_swapon_uuid>"
18387 #: ../src/guestfs-availability.pod:40
18388 msgid "B<linuxmodules>"
18392 #: ../src/guestfs-availability.pod:42
18393 msgid "The following functions: L</guestfs_modprobe>"
18397 #: ../src/guestfs-availability.pod:45
18398 msgid "B<linuxxattrs>"
18402 #: ../src/guestfs-availability.pod:47
18404 "The following functions: L</guestfs_getxattr> L</guestfs_getxattrs> L</"
18405 "guestfs_lgetxattr> L</guestfs_lgetxattrs> L</guestfs_lremovexattr> L</"
18406 "guestfs_lsetxattr> L</guestfs_lxattrlist> L</guestfs_removexattr> L</"
18407 "guestfs_setxattr>"
18411 #: ../src/guestfs-availability.pod:58
18416 #: ../src/guestfs-availability.pod:60
18418 "The following functions: L</guestfs_luks_add_key> L</guestfs_luks_close> L</"
18419 "guestfs_luks_format> L</guestfs_luks_format_cipher> L</"
18420 "guestfs_luks_kill_slot> L</guestfs_luks_open> L</guestfs_luks_open_ro>"
18424 #: ../src/guestfs-availability.pod:69
18429 #: ../src/guestfs-availability.pod:71
18431 "The following functions: L</guestfs_is_lv> L</guestfs_lvcreate> L</"
18432 "guestfs_lvm_remove_all> L</guestfs_lvm_set_filter> L</guestfs_lvremove> L</"
18433 "guestfs_lvresize> L</guestfs_lvresize_free> L</guestfs_lvs> L</"
18434 "guestfs_lvs_full> L</guestfs_pvcreate> L</guestfs_pvremove> L</"
18435 "guestfs_pvresize> L</guestfs_pvresize_size> L</guestfs_pvs> L</"
18436 "guestfs_pvs_full> L</guestfs_vg_activate> L</guestfs_vg_activate_all> L</"
18437 "guestfs_vgcreate> L</guestfs_vgremove> L</guestfs_vgs> L</guestfs_vgs_full>"
18441 #: ../src/guestfs-availability.pod:94
18446 #: ../src/guestfs-availability.pod:96
18448 "The following functions: L</guestfs_mkfifo> L</guestfs_mknod> L</"
18449 "guestfs_mknod_b> L</guestfs_mknod_c>"
18453 #: ../src/guestfs-availability.pod:102
18458 #: ../src/guestfs-availability.pod:104
18459 msgid "The following functions: L</guestfs_ntfs_3g_probe>"
18463 #: ../src/guestfs-availability.pod:107
18464 msgid "B<ntfsprogs>"
18468 #: ../src/guestfs-availability.pod:109
18470 "The following functions: L</guestfs_ntfsresize> L</guestfs_ntfsresize_size>"
18474 #: ../src/guestfs-availability.pod:113
18475 msgid "B<realpath>"
18479 #: ../src/guestfs-availability.pod:115
18480 msgid "The following functions: L</guestfs_realpath>"
18484 #: ../src/guestfs-availability.pod:118
18489 #: ../src/guestfs-availability.pod:120
18491 "The following functions: L</guestfs_scrub_device> L</guestfs_scrub_file> L</"
18492 "guestfs_scrub_freespace>"
18496 #: ../src/guestfs-availability.pod:125
18501 #: ../src/guestfs-availability.pod:127
18502 msgid "The following functions: L</guestfs_getcon> L</guestfs_setcon>"
18506 #: ../src/guestfs-availability.pod:131
18511 #: ../src/guestfs-availability.pod:133
18512 msgid "The following functions: L</guestfs_txz_in> L</guestfs_txz_out>"
18516 #: ../src/guestfs-availability.pod:137
18517 msgid "B<zerofree>"
18521 #: ../src/guestfs-availability.pod:139
18522 msgid "The following functions: L</guestfs_zerofree>"
18526 #: ../src/guestfs-structs.pod:1
18527 msgid "guestfs_int_bool"
18531 #: ../src/guestfs-structs.pod:3
18534 " struct guestfs_int_bool {\n"
18542 #: ../src/guestfs-structs.pod:8
18545 " struct guestfs_int_bool_list {\n"
18546 " uint32_t len; /* Number of elements in list. */\n"
18547 " struct guestfs_int_bool *val; /* Elements. */\n"
18553 #: ../src/guestfs-structs.pod:13
18556 " void guestfs_free_int_bool (struct guestfs_free_int_bool *);\n"
18557 " void guestfs_free_int_bool_list (struct guestfs_free_int_bool_list *);\n"
18562 #: ../src/guestfs-structs.pod:16
18563 msgid "guestfs_lvm_pv"
18567 #: ../src/guestfs-structs.pod:18
18570 " struct guestfs_lvm_pv {\n"
18571 " char *pv_name;\n"
18572 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
18573 " char pv_uuid[32];\n"
18575 " uint64_t pv_size;\n"
18576 " uint64_t dev_size;\n"
18577 " uint64_t pv_free;\n"
18578 " uint64_t pv_used;\n"
18579 " char *pv_attr;\n"
18580 " int64_t pv_pe_count;\n"
18581 " int64_t pv_pe_alloc_count;\n"
18582 " char *pv_tags;\n"
18583 " uint64_t pe_start;\n"
18584 " int64_t pv_mda_count;\n"
18585 " uint64_t pv_mda_free;\n"
18591 #: ../src/guestfs-structs.pod:36
18594 " struct guestfs_lvm_pv_list {\n"
18595 " uint32_t len; /* Number of elements in list. */\n"
18596 " struct guestfs_lvm_pv *val; /* Elements. */\n"
18602 #: ../src/guestfs-structs.pod:41
18605 " void guestfs_free_lvm_pv (struct guestfs_free_lvm_pv *);\n"
18606 " void guestfs_free_lvm_pv_list (struct guestfs_free_lvm_pv_list *);\n"
18611 #: ../src/guestfs-structs.pod:44
18612 msgid "guestfs_lvm_vg"
18616 #: ../src/guestfs-structs.pod:46
18619 " struct guestfs_lvm_vg {\n"
18620 " char *vg_name;\n"
18621 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
18622 " char vg_uuid[32];\n"
18624 " char *vg_attr;\n"
18625 " uint64_t vg_size;\n"
18626 " uint64_t vg_free;\n"
18627 " char *vg_sysid;\n"
18628 " uint64_t vg_extent_size;\n"
18629 " int64_t vg_extent_count;\n"
18630 " int64_t vg_free_count;\n"
18631 " int64_t max_lv;\n"
18632 " int64_t max_pv;\n"
18633 " int64_t pv_count;\n"
18634 " int64_t lv_count;\n"
18635 " int64_t snap_count;\n"
18636 " int64_t vg_seqno;\n"
18637 " char *vg_tags;\n"
18638 " int64_t vg_mda_count;\n"
18639 " uint64_t vg_mda_free;\n"
18645 #: ../src/guestfs-structs.pod:69
18648 " struct guestfs_lvm_vg_list {\n"
18649 " uint32_t len; /* Number of elements in list. */\n"
18650 " struct guestfs_lvm_vg *val; /* Elements. */\n"
18656 #: ../src/guestfs-structs.pod:74
18659 " void guestfs_free_lvm_vg (struct guestfs_free_lvm_vg *);\n"
18660 " void guestfs_free_lvm_vg_list (struct guestfs_free_lvm_vg_list *);\n"
18665 #: ../src/guestfs-structs.pod:77
18666 msgid "guestfs_lvm_lv"
18670 #: ../src/guestfs-structs.pod:79
18673 " struct guestfs_lvm_lv {\n"
18674 " char *lv_name;\n"
18675 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
18676 " char lv_uuid[32];\n"
18677 " char *lv_attr;\n"
18678 " int64_t lv_major;\n"
18679 " int64_t lv_minor;\n"
18680 " int64_t lv_kernel_major;\n"
18681 " int64_t lv_kernel_minor;\n"
18682 " uint64_t lv_size;\n"
18683 " int64_t seg_count;\n"
18685 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
18686 " float snap_percent;\n"
18687 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
18688 " float copy_percent;\n"
18689 " char *move_pv;\n"
18690 " char *lv_tags;\n"
18691 " char *mirror_log;\n"
18692 " char *modules;\n"
18698 #: ../src/guestfs-structs.pod:101
18701 " struct guestfs_lvm_lv_list {\n"
18702 " uint32_t len; /* Number of elements in list. */\n"
18703 " struct guestfs_lvm_lv *val; /* Elements. */\n"
18709 #: ../src/guestfs-structs.pod:106
18712 " void guestfs_free_lvm_lv (struct guestfs_free_lvm_lv *);\n"
18713 " void guestfs_free_lvm_lv_list (struct guestfs_free_lvm_lv_list *);\n"
18718 #: ../src/guestfs-structs.pod:111
18721 " struct guestfs_stat {\n"
18725 " int64_t nlink;\n"
18730 " int64_t blksize;\n"
18731 " int64_t blocks;\n"
18732 " int64_t atime;\n"
18733 " int64_t mtime;\n"
18734 " int64_t ctime;\n"
18740 #: ../src/guestfs-structs.pod:127
18743 " struct guestfs_stat_list {\n"
18744 " uint32_t len; /* Number of elements in list. */\n"
18745 " struct guestfs_stat *val; /* Elements. */\n"
18751 #: ../src/guestfs-structs.pod:132
18754 " void guestfs_free_stat (struct guestfs_free_stat *);\n"
18755 " void guestfs_free_stat_list (struct guestfs_free_stat_list *);\n"
18760 #: ../src/guestfs-structs.pod:137
18763 " struct guestfs_statvfs {\n"
18764 " int64_t bsize;\n"
18765 " int64_t frsize;\n"
18766 " int64_t blocks;\n"
18767 " int64_t bfree;\n"
18768 " int64_t bavail;\n"
18769 " int64_t files;\n"
18770 " int64_t ffree;\n"
18771 " int64_t favail;\n"
18774 " int64_t namemax;\n"
18780 #: ../src/guestfs-structs.pod:151
18783 " struct guestfs_statvfs_list {\n"
18784 " uint32_t len; /* Number of elements in list. */\n"
18785 " struct guestfs_statvfs *val; /* Elements. */\n"
18791 #: ../src/guestfs-structs.pod:156
18794 " void guestfs_free_statvfs (struct guestfs_free_statvfs *);\n"
18795 " void guestfs_free_statvfs_list (struct guestfs_free_statvfs_list *);\n"
18800 #: ../src/guestfs-structs.pod:159
18801 msgid "guestfs_dirent"
18805 #: ../src/guestfs-structs.pod:161
18808 " struct guestfs_dirent {\n"
18817 #: ../src/guestfs-structs.pod:167
18820 " struct guestfs_dirent_list {\n"
18821 " uint32_t len; /* Number of elements in list. */\n"
18822 " struct guestfs_dirent *val; /* Elements. */\n"
18828 #: ../src/guestfs-structs.pod:172
18831 " void guestfs_free_dirent (struct guestfs_free_dirent *);\n"
18832 " void guestfs_free_dirent_list (struct guestfs_free_dirent_list *);\n"
18837 #: ../src/guestfs-structs.pod:177
18840 " struct guestfs_version {\n"
18841 " int64_t major;\n"
18842 " int64_t minor;\n"
18843 " int64_t release;\n"
18850 #: ../src/guestfs-structs.pod:184
18853 " struct guestfs_version_list {\n"
18854 " uint32_t len; /* Number of elements in list. */\n"
18855 " struct guestfs_version *val; /* Elements. */\n"
18861 #: ../src/guestfs-structs.pod:189
18864 " void guestfs_free_version (struct guestfs_free_version *);\n"
18865 " void guestfs_free_version_list (struct guestfs_free_version_list *);\n"
18870 #: ../src/guestfs-structs.pod:192
18871 msgid "guestfs_xattr"
18875 #: ../src/guestfs-structs.pod:194
18878 " struct guestfs_xattr {\n"
18879 " char *attrname;\n"
18880 " /* The next two fields describe a byte array. */\n"
18881 " uint32_t attrval_len;\n"
18882 " char *attrval;\n"
18888 #: ../src/guestfs-structs.pod:201
18891 " struct guestfs_xattr_list {\n"
18892 " uint32_t len; /* Number of elements in list. */\n"
18893 " struct guestfs_xattr *val; /* Elements. */\n"
18899 #: ../src/guestfs-structs.pod:206
18902 " void guestfs_free_xattr (struct guestfs_free_xattr *);\n"
18903 " void guestfs_free_xattr_list (struct guestfs_free_xattr_list *);\n"
18908 #: ../src/guestfs-structs.pod:209
18909 msgid "guestfs_inotify_event"
18913 #: ../src/guestfs-structs.pod:211
18916 " struct guestfs_inotify_event {\n"
18917 " int64_t in_wd;\n"
18918 " uint32_t in_mask;\n"
18919 " uint32_t in_cookie;\n"
18920 " char *in_name;\n"
18926 #: ../src/guestfs-structs.pod:218
18929 " struct guestfs_inotify_event_list {\n"
18930 " uint32_t len; /* Number of elements in list. */\n"
18931 " struct guestfs_inotify_event *val; /* Elements. */\n"
18937 #: ../src/guestfs-structs.pod:223
18940 " void guestfs_free_inotify_event (struct guestfs_free_inotify_event *);\n"
18941 " void guestfs_free_inotify_event_list (struct guestfs_free_inotify_event_list *);\n"
18946 #: ../src/guestfs-structs.pod:226
18947 msgid "guestfs_partition"
18951 #: ../src/guestfs-structs.pod:228
18954 " struct guestfs_partition {\n"
18955 " int32_t part_num;\n"
18956 " uint64_t part_start;\n"
18957 " uint64_t part_end;\n"
18958 " uint64_t part_size;\n"
18964 #: ../src/guestfs-structs.pod:235
18967 " struct guestfs_partition_list {\n"
18968 " uint32_t len; /* Number of elements in list. */\n"
18969 " struct guestfs_partition *val; /* Elements. */\n"
18975 #: ../src/guestfs-structs.pod:240
18978 " void guestfs_free_partition (struct guestfs_free_partition *);\n"
18979 " void guestfs_free_partition_list (struct guestfs_free_partition_list *);\n"
18984 #: ../src/guestfs-structs.pod:243
18985 msgid "guestfs_application"
18989 #: ../src/guestfs-structs.pod:245
18992 " struct guestfs_application {\n"
18993 " char *app_name;\n"
18994 " char *app_display_name;\n"
18995 " int32_t app_epoch;\n"
18996 " char *app_version;\n"
18997 " char *app_release;\n"
18998 " char *app_install_path;\n"
18999 " char *app_trans_path;\n"
19000 " char *app_publisher;\n"
19001 " char *app_url;\n"
19002 " char *app_source_package;\n"
19003 " char *app_summary;\n"
19004 " char *app_description;\n"
19010 #: ../src/guestfs-structs.pod:260
19013 " struct guestfs_application_list {\n"
19014 " uint32_t len; /* Number of elements in list. */\n"
19015 " struct guestfs_application *val; /* Elements. */\n"
19021 #: ../src/guestfs-structs.pod:265
19024 " void guestfs_free_application (struct guestfs_free_application *);\n"
19025 " void guestfs_free_application_list (struct guestfs_free_application_list *);\n"
19030 #: ../fish/guestfish.pod:5
19031 msgid "guestfish - the libguestfs Filesystem Interactive SHell"
19035 #: ../fish/guestfish.pod:9
19038 " guestfish [--options] [commands]\n"
19043 #: ../fish/guestfish.pod:11
19051 #: ../fish/guestfish.pod:13
19054 " guestfish [--ro|--rw] -a disk.img\n"
19059 #: ../fish/guestfish.pod:15
19062 " guestfish [--ro|--rw] -a disk.img -m dev[:mountpoint]\n"
19067 #: ../fish/guestfish.pod:17
19070 " guestfish -d libvirt-domain\n"
19075 #: ../fish/guestfish.pod:19
19078 " guestfish [--ro|--rw] -a disk.img -i\n"
19083 #: ../fish/guestfish.pod:21
19086 " guestfish -d libvirt-domain -i\n"
19091 #: ../fish/guestfish.pod:23 ../fuse/guestmount.pod:15 ../tools/virt-edit.pl:44
19092 #: ../tools/virt-win-reg.pl:51 ../tools/virt-tar.pl:64
19097 #: ../fish/guestfish.pod:25
19099 "Using guestfish in read/write mode on live virtual machines can be "
19100 "dangerous, potentially causing disk corruption. Use the I<--ro> (read-only) "
19101 "option to use guestfish safely if the disk image or virtual machine might be "
19106 #: ../fish/guestfish.pod:32
19108 "Guestfish is a shell and command-line tool for examining and modifying "
19109 "virtual machine filesystems. It uses libguestfs and exposes all of the "
19110 "functionality of the guestfs API, see L<guestfs(3)>."
19114 #: ../fish/guestfish.pod:36
19116 "Guestfish gives you structured access to the libguestfs API, from shell "
19117 "scripts or the command line or interactively. If you want to rescue a "
19118 "broken virtual machine image, you should look at the L<virt-rescue(1)> "
19123 #: ../fish/guestfish.pod:41 ../fish/guestfish.pod:947
19124 #: ../fuse/guestmount.pod:39 ../tools/virt-edit.pl:63 ../tools/virt-tar.pl:50
19129 #: ../fish/guestfish.pod:43
19130 msgid "As an interactive shell"
19134 #: ../fish/guestfish.pod:45
19142 #: ../fish/guestfish.pod:47
19145 " Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
19146 " editing virtual machine filesystems.\n"
19151 #: ../fish/guestfish.pod:50
19154 " Type: 'help' for a list of commands\n"
19155 " 'man' to read the manual\n"
19156 " 'quit' to quit the shell\n"
19161 #: ../fish/guestfish.pod:54
19164 " ><fs> add-ro disk.img\n"
19166 " ><fs> list-filesystems\n"
19167 " /dev/sda1: ext4\n"
19168 " /dev/vg_guest/lv_root: ext4\n"
19169 " /dev/vg_guest/lv_swap: swap\n"
19170 " ><fs> mount /dev/vg_guest/lv_root /\n"
19171 " ><fs> cat /etc/fstab\n"
19173 " # Created by anaconda\n"
19180 #: ../fish/guestfish.pod:67
19181 msgid "From shell scripts"
19185 #: ../fish/guestfish.pod:69
19186 msgid "Create a new C</etc/motd> file in a guest or disk image:"
19190 #: ../fish/guestfish.pod:71
19193 " guestfish <<_EOF_\n"
19196 " mount /dev/vg_guest/lv_root /\n"
19197 " write /etc/motd \"Welcome, new users\"\n"
19203 #: ../fish/guestfish.pod:78
19204 msgid "List the LVM logical volumes in a disk image:"
19208 #: ../fish/guestfish.pod:80
19211 " guestfish -a disk.img --ro <<_EOF_\n"
19219 #: ../fish/guestfish.pod:85
19220 msgid "List all the filesystems in a disk image:"
19224 #: ../fish/guestfish.pod:87
19227 " guestfish -a disk.img --ro <<_EOF_\n"
19229 " list-filesystems\n"
19235 #: ../fish/guestfish.pod:92
19236 msgid "On one command line"
19240 #: ../fish/guestfish.pod:94
19241 msgid "Update C</etc/resolv.conf> in a guest:"
19245 #: ../fish/guestfish.pod:96
19249 " add disk.img : run : mount /dev/vg_guest/lv_root / : \\\n"
19250 " write /etc/resolv.conf \"nameserver 1.2.3.4\"\n"
19255 #: ../fish/guestfish.pod:100
19256 msgid "Edit C</boot/grub/grub.conf> interactively:"
19260 #: ../fish/guestfish.pod:102
19263 " guestfish --rw --add disk.img \\\n"
19264 " --mount /dev/vg_guest/lv_root \\\n"
19265 " --mount /dev/sda1:/boot \\\n"
19266 " edit /boot/grub/grub.conf\n"
19271 #: ../fish/guestfish.pod:107
19272 msgid "Mount disks automatically"
19276 #: ../fish/guestfish.pod:109
19278 "Use the I<-i> option to automatically mount the disks from a virtual machine:"
19282 #: ../fish/guestfish.pod:112
19285 " guestfish --ro -a disk.img -i cat /etc/group\n"
19290 #: ../fish/guestfish.pod:114
19293 " guestfish --ro -d libvirt-domain -i cat /etc/group\n"
19298 #: ../fish/guestfish.pod:116
19299 msgid "Another way to edit C</boot/grub/grub.conf> interactively is:"
19303 #: ../fish/guestfish.pod:118
19306 " guestfish --rw -a disk.img -i edit /boot/grub/grub.conf\n"
19311 #: ../fish/guestfish.pod:120
19312 msgid "As a script interpreter"
19316 #: ../fish/guestfish.pod:122
19317 msgid "Create a 100MB disk containing an ext2-formatted partition:"
19321 #: ../fish/guestfish.pod:124
19324 " #!/usr/bin/guestfish -f\n"
19325 " sparse test1.img 100M\n"
19327 " part-disk /dev/sda mbr\n"
19328 " mkfs ext2 /dev/sda1\n"
19333 #: ../fish/guestfish.pod:130
19334 msgid "Start with a prepared disk"
19338 #: ../fish/guestfish.pod:132
19340 "An alternate way to create a 100MB disk called C<test1.img> containing a "
19341 "single ext2-formatted partition:"
19345 #: ../fish/guestfish.pod:135
19348 " guestfish -N fs\n"
19353 #: ../fish/guestfish.pod:137
19354 msgid "To list what is available do:"
19358 #: ../fish/guestfish.pod:139 ../fish/guestfish.pod:938
19361 " guestfish -N help | less\n"
19366 #: ../fish/guestfish.pod:141
19367 msgid "Remote control"
19371 #: ../fish/guestfish.pod:143
19374 " eval \"`guestfish --listen`\"\n"
19375 " guestfish --remote add-ro disk.img\n"
19376 " guestfish --remote run\n"
19377 " guestfish --remote lvs\n"
19382 #: ../fish/guestfish.pod:148 ../test-tool/libguestfs-test-tool.pod:37
19383 #: ../fuse/guestmount.pod:73 ../tools/virt-edit.pl:81
19384 #: ../tools/virt-win-reg.pl:96 ../tools/virt-list-filesystems.pl:53
19385 #: ../tools/virt-tar.pl:103 ../tools/virt-make-fs.pl:153
19386 #: ../tools/virt-list-partitions.pl:54
19391 #: ../fish/guestfish.pod:152 ../fuse/guestmount.pod:131
19392 #: ../tools/virt-edit.pl:89 ../tools/virt-win-reg.pl:104
19393 #: ../tools/virt-list-filesystems.pl:61 ../tools/virt-tar.pl:111
19394 #: ../tools/virt-make-fs.pl:161 ../tools/virt-list-partitions.pl:62
19399 #: ../fish/guestfish.pod:154
19400 msgid "Displays general help on options."
19404 #: ../fish/guestfish.pod:156
19409 #: ../fish/guestfish.pod:158
19410 msgid "B<--cmd-help>"
19414 #: ../fish/guestfish.pod:160
19415 msgid "Lists all available guestfish commands."
19419 #: ../fish/guestfish.pod:162
19424 #: ../fish/guestfish.pod:164
19425 msgid "B<--cmd-help cmd>"
19429 #: ../fish/guestfish.pod:166
19430 msgid "Displays detailed help on a single command C<cmd>."
19434 #: ../fish/guestfish.pod:168
19435 msgid "B<-a image>"
19439 #: ../fish/guestfish.pod:170
19440 msgid "B<--add image>"
19444 #: ../fish/guestfish.pod:172
19445 msgid "Add a block device or virtual machine image to the shell."
19449 #: ../fish/guestfish.pod:174 ../fuse/guestmount.pod:81
19451 "The format of the disk image is auto-detected. To override this and force a "
19452 "particular format use the I<--format=..> option."
19456 #: ../fish/guestfish.pod:177
19458 "Using this flag is mostly equivalent to using the C<add> command, with "
19459 "C<readonly:true> if the I<--ro> flag was given, and with C<format:...> if "
19460 "the I<--format=...> flag was given."
19464 #: ../fish/guestfish.pod:181
19469 #: ../fish/guestfish.pod:183
19470 msgid "B<--connect URI>"
19474 #: ../fish/guestfish.pod:185 ../fuse/guestmount.pod:86
19476 "When used in conjunction with the I<-d> option, this specifies the libvirt "
19477 "URI to use. The default is to use the default libvirt connection."
19481 #: ../fish/guestfish.pod:189
19486 #: ../fish/guestfish.pod:191
19488 "If using the I<--listen> option and a csh-like shell, use this option. See "
19489 "section L</REMOTE CONTROL AND CSH> below."
19493 #: ../fish/guestfish.pod:194
19494 msgid "B<-d libvirt-domain>"
19498 #: ../fish/guestfish.pod:196
19499 msgid "B<--domain libvirt-domain>"
19503 #: ../fish/guestfish.pod:198 ../fuse/guestmount.pod:92
19505 "Add disks from the named libvirt domain. If the I<--ro> option is also "
19506 "used, then any libvirt domain can be used. However in write mode, only "
19507 "libvirt domains which are shut down can be named here."
19511 #: ../fish/guestfish.pod:202
19513 "Using this flag is mostly equivalent to using the C<add-domain> command, "
19514 "with C<readonly:true> if the I<--ro> flag was given, and with C<format:...> "
19515 "if the I<--format:...> flag was given."
19519 #: ../fish/guestfish.pod:206
19524 #: ../fish/guestfish.pod:208
19525 msgid "B<--no-dest-paths>"
19529 #: ../fish/guestfish.pod:210
19531 "Don't tab-complete paths on the guest filesystem. It is useful to be able "
19532 "to hit the tab key to complete paths on the guest filesystem, but this "
19533 "causes extra \"hidden\" guestfs calls to be made, so this option is here to "
19534 "allow this feature to be disabled."
19538 #: ../fish/guestfish.pod:215 ../fuse/guestmount.pod:108
19539 msgid "B<--echo-keys>"
19543 #: ../fish/guestfish.pod:217 ../fuse/guestmount.pod:110
19545 "When prompting for keys and passphrases, guestfish normally turns echoing "
19546 "off so you cannot see what you are typing. If you are not worried about "
19547 "Tempest attacks and there is no one else in the room you can specify this "
19548 "flag to see what you are typing."
19552 #: ../fish/guestfish.pod:222
19557 #: ../fish/guestfish.pod:224
19558 msgid "B<--file file>"
19562 #: ../fish/guestfish.pod:226
19563 msgid "Read commands from C<file>. To write pure guestfish scripts, use:"
19567 #: ../fish/guestfish.pod:229
19570 " #!/usr/bin/guestfish -f\n"
19575 #: ../fish/guestfish.pod:231
19576 msgid "B<--format=raw|qcow2|..>"
19580 #: ../fish/guestfish.pod:233
19581 msgid "B<--format>"
19585 #: ../fish/guestfish.pod:235 ../fuse/guestmount.pod:117
19587 "The default for the I<-a> option is to auto-detect the format of the disk "
19588 "image. Using this forces the disk format for I<-a> options which follow on "
19589 "the command line. Using I<--format> with no argument switches back to auto-"
19590 "detection for subsequent I<-a> options."
19594 #: ../fish/guestfish.pod:242
19597 " guestfish --format=raw -a disk.img\n"
19602 #: ../fish/guestfish.pod:244
19603 msgid "forces raw format (no auto-detection) for C<disk.img>."
19607 #: ../fish/guestfish.pod:246
19610 " guestfish --format=raw -a disk.img --format -a another.img\n"
19615 #: ../fish/guestfish.pod:248
19617 "forces raw format (no auto-detection) for C<disk.img> and reverts to auto-"
19618 "detection for C<another.img>."
19622 #: ../fish/guestfish.pod:251
19624 "If you have untrusted raw-format guest disk images, you should use this "
19625 "option to specify the disk format. This avoids a possible security problem "
19626 "with malicious guests (CVE-2010-3851). See also L</add-drive-opts>."
19630 #: ../fish/guestfish.pod:256
19635 #: ../fish/guestfish.pod:258
19636 msgid "B<--inspector>"
19640 #: ../fish/guestfish.pod:260 ../fuse/guestmount.pod:137
19642 "Using L<virt-inspector(1)> code, inspect the disks looking for an operating "
19643 "system and mount filesystems as they would be mounted on the real virtual "
19648 #: ../fish/guestfish.pod:264
19649 msgid "Typical usage is either:"
19653 #: ../fish/guestfish.pod:266
19656 " guestfish -d myguest -i\n"
19661 #: ../fish/guestfish.pod:268
19662 msgid "(for an inactive libvirt domain called I<myguest>), or:"
19666 #: ../fish/guestfish.pod:270
19669 " guestfish --ro -d myguest -i\n"
19674 #: ../fish/guestfish.pod:272
19675 msgid "(for active domains, readonly), or specify the block device directly:"
19679 #: ../fish/guestfish.pod:274
19682 " guestfish --rw -a /dev/Guests/MyGuest -i\n"
19687 #: ../fish/guestfish.pod:276
19689 "Note that the command line syntax changed slightly over older versions of "
19690 "guestfish. You can still use the old syntax:"
19694 #: ../fish/guestfish.pod:279
19697 " guestfish [--ro] -i disk.img\n"
19702 #: ../fish/guestfish.pod:281
19705 " guestfish [--ro] -i libvirt-domain\n"
19710 #: ../fish/guestfish.pod:283
19712 "Using this flag is mostly equivalent to using the C<inspect-os> command and "
19713 "then using other commands to mount the filesystems that were found."
19717 #: ../fish/guestfish.pod:287 ../fuse/guestmount.pod:141
19718 msgid "B<--keys-from-stdin>"
19722 #: ../fish/guestfish.pod:289 ../fuse/guestmount.pod:143
19724 "Read key or passphrase parameters from stdin. The default is to try to read "
19725 "passphrases from the user by opening C</dev/tty>."
19729 #: ../fish/guestfish.pod:292
19730 msgid "B<--listen>"
19734 #: ../fish/guestfish.pod:294
19736 "Fork into the background and listen for remote commands. See section L</"
19737 "REMOTE CONTROL GUESTFISH OVER A SOCKET> below."
19741 #: ../fish/guestfish.pod:297 ../fuse/guestmount.pod:146
19746 #: ../fish/guestfish.pod:299 ../fuse/guestmount.pod:148
19748 "Connect to a live virtual machine. (Experimental, see L<guestfs(3)/"
19749 "ATTACHING TO RUNNING DAEMONS>)."
19753 #: ../fish/guestfish.pod:302 ../fuse/guestmount.pod:151
19754 msgid "B<-m dev[:mountpoint[:options]]>"
19758 #: ../fish/guestfish.pod:304 ../fuse/guestmount.pod:153
19759 msgid "B<--mount dev[:mountpoint[:options]]>"
19763 #: ../fish/guestfish.pod:306
19764 msgid "Mount the named partition or logical volume on the given mountpoint."
19768 #: ../fish/guestfish.pod:308
19769 msgid "If the mountpoint is omitted, it defaults to C</>."
19773 #: ../fish/guestfish.pod:310
19774 msgid "You have to mount something on C</> before most commands will work."
19778 #: ../fish/guestfish.pod:312
19780 "If any I<-m> or I<--mount> options are given, the guest is automatically "
19785 #: ../fish/guestfish.pod:315
19787 "If you don't know what filesystems a disk image contains, you can either run "
19788 "guestfish without this option, then list the partitions, filesystems and LVs "
19789 "available (see L</list-partitions>, L</list-filesystems> and L</lvs> "
19790 "commands), or you can use the L<virt-filesystems(1)> program."
19794 #: ../fish/guestfish.pod:321 ../fuse/guestmount.pod:161
19796 "The third (and rarely used) part of the mount parameter is the list of mount "
19797 "options used to mount the underlying filesystem. If this is not given, then "
19798 "the mount options are either the empty string or C<ro> (the latter if the "
19799 "I<--ro> flag is used). By specifying the mount options, you override this "
19800 "default choice. Probably the only time you would use this is to enable ACLs "
19801 "and/or extended attributes if the filesystem can support them:"
19805 #: ../fish/guestfish.pod:329 ../fuse/guestmount.pod:169
19808 " -m /dev/sda1:/:acl,user_xattr\n"
19813 #: ../fish/guestfish.pod:331
19814 msgid "Using this flag is equivalent to using the C<mount-options> command."
19818 #: ../fish/guestfish.pod:333
19823 #: ../fish/guestfish.pod:335
19824 msgid "B<--no-sync>"
19828 #: ../fish/guestfish.pod:337
19830 "Disable autosync. This is enabled by default. See the discussion of "
19831 "autosync in the L<guestfs(3)> manpage."
19835 #: ../fish/guestfish.pod:340
19840 #: ../fish/guestfish.pod:342
19841 msgid "B<--new type>"
19845 #: ../fish/guestfish.pod:344
19850 #: ../fish/guestfish.pod:346
19852 "Prepare a fresh disk image formatted as \"type\". This is an alternative to "
19853 "the I<-a> option: whereas I<-a> adds an existing disk, I<-N> creates a "
19854 "preformatted disk with a filesystem and adds it. See L</PREPARED DISK "
19859 #: ../fish/guestfish.pod:351
19860 msgid "B<--progress-bars>"
19864 #: ../fish/guestfish.pod:353
19865 msgid "Enable progress bars, even when guestfish is used non-interactively."
19869 #: ../fish/guestfish.pod:355
19871 "Progress bars are enabled by default when guestfish is used as an "
19872 "interactive shell."
19876 #: ../fish/guestfish.pod:358
19877 msgid "B<--no-progress-bars>"
19881 #: ../fish/guestfish.pod:360
19882 msgid "Disable progress bars."
19886 #: ../fish/guestfish.pod:362
19887 msgid "B<--remote[=pid]>"
19891 #: ../fish/guestfish.pod:364
19893 "Send remote commands to C<$GUESTFISH_PID> or C<pid>. See section L</REMOTE "
19894 "CONTROL GUESTFISH OVER A SOCKET> below."
19898 #: ../fish/guestfish.pod:367
19903 #: ../fish/guestfish.pod:369
19908 #: ../fish/guestfish.pod:371
19910 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
19911 "mounts are done read-only."
19915 #: ../fish/guestfish.pod:374
19917 "The option must always be used if the disk image or virtual machine might be "
19918 "running, and is generally recommended in cases where you don't need write "
19919 "access to the disk."
19923 #: ../fish/guestfish.pod:378
19925 "Note that prepared disk images created with I<-N> are not affected by this "
19926 "option. Also commands like C<add> are not affected - you have to specify "
19927 "the C<readonly:true> option explicitly if you need it."
19931 #: ../fish/guestfish.pod:382
19932 msgid "See also L</OPENING DISKS FOR READ AND WRITE> below."
19936 #: ../fish/guestfish.pod:384 ../fuse/guestmount.pod:225
19937 msgid "B<--selinux>"
19941 #: ../fish/guestfish.pod:386
19942 msgid "Enable SELinux support for the guest. See L<guestfs(3)/SELINUX>."
19946 #: ../fish/guestfish.pod:388
19951 #: ../fish/guestfish.pod:390
19952 msgid "B<--verbose>"
19956 #: ../fish/guestfish.pod:392
19958 "Enable very verbose messages. This is particularly useful if you find a bug."
19962 #: ../fish/guestfish.pod:395
19967 #: ../fish/guestfish.pod:397 ../tools/virt-edit.pl:97
19968 #: ../tools/virt-win-reg.pl:112 ../tools/virt-list-filesystems.pl:69
19969 #: ../tools/virt-tar.pl:119 ../tools/virt-make-fs.pl:169
19970 #: ../tools/virt-list-partitions.pl:70
19971 msgid "B<--version>"
19975 #: ../fish/guestfish.pod:399
19976 msgid "Display the guestfish / libguestfs version number and exit."
19980 #: ../fish/guestfish.pod:401
19985 #: ../fish/guestfish.pod:403
19990 #: ../fish/guestfish.pod:405 ../fuse/guestmount.pod:239
19992 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
19993 "mounts are done read-write."
19997 #: ../fish/guestfish.pod:408
19998 msgid "See L</OPENING DISKS FOR READ AND WRITE> below."
20002 #: ../fish/guestfish.pod:410
20007 #: ../fish/guestfish.pod:412
20008 msgid "Echo each command before executing it."
20012 #: ../fish/guestfish.pod:416
20013 msgid "COMMANDS ON COMMAND LINE"
20017 #: ../fish/guestfish.pod:418
20019 "Any additional (non-option) arguments are treated as commands to execute."
20023 #: ../fish/guestfish.pod:421
20025 "Commands to execute should be separated by a colon (C<:>), where the colon "
20026 "is a separate parameter. Thus:"
20030 #: ../fish/guestfish.pod:424
20033 " guestfish cmd [args...] : cmd [args...] : cmd [args...] ...\n"
20038 #: ../fish/guestfish.pod:426
20040 "If there are no additional arguments, then we enter a shell, either an "
20041 "interactive shell with a prompt (if the input is a terminal) or a non-"
20042 "interactive shell."
20046 #: ../fish/guestfish.pod:430
20048 "In either command line mode or non-interactive shell, the first command that "
20049 "gives an error causes the whole shell to exit. In interactive mode (with a "
20050 "prompt) if a command fails, you can continue to enter commands."
20054 #: ../fish/guestfish.pod:435
20055 msgid "USING launch (OR run)"
20059 #: ../fish/guestfish.pod:437
20061 "As with L<guestfs(3)>, you must first configure your guest by adding disks, "
20062 "then launch it, then mount any disks you need, and finally issue actions/"
20063 "commands. So the general order of the day is:"
20067 #: ../fish/guestfish.pod:445
20068 msgid "add or -a/--add"
20072 #: ../fish/guestfish.pod:449
20073 msgid "launch (aka run)"
20077 #: ../fish/guestfish.pod:453
20078 msgid "mount or -m/--mount"
20082 #: ../fish/guestfish.pod:457
20083 msgid "any other commands"
20087 #: ../fish/guestfish.pod:461
20089 "C<run> is a synonym for C<launch>. You must C<launch> (or C<run>) your "
20090 "guest before mounting or performing any other commands."
20094 #: ../fish/guestfish.pod:464
20096 "The only exception is that if any of the I<-i>, I<-m>, I<--mount>, I<-N> or "
20097 "I<--new> options were given then C<run> is done automatically, simply "
20098 "because guestfish can't perform the action you asked for without doing this."
20102 #: ../fish/guestfish.pod:469
20103 msgid "OPENING DISKS FOR READ AND WRITE"
20107 #: ../fish/guestfish.pod:471
20109 "The guestfish, L<guestmount(1)> and L<virt-rescue(1)> options I<--ro> and "
20110 "I<--rw> affect whether the other command line options I<-a>, I<-c>, I<-d>, "
20111 "I<-i> and I<-m> open disk images read-only or for writing."
20115 #: ../fish/guestfish.pod:476
20117 "In libguestfs E<le> 1.10, guestfish, guestmount and virt-rescue defaulted to "
20118 "opening disk images supplied on the command line for write. To open a disk "
20119 "image read-only you have to do I<-a image --ro>."
20123 #: ../fish/guestfish.pod:480
20125 "This matters: If you accidentally open a live VM disk image writable then "
20126 "you will cause irreversible disk corruption."
20130 #: ../fish/guestfish.pod:483
20132 "By libguestfs 1.12 we intend to change the default the other way. Disk "
20133 "images will be opened read-only. You will have to either specify "
20134 "I<guestfish --rw>, I<guestmount --rw>, I<virt-rescue --rw>, or change the "
20135 "configuration file C</etc/libguestfs-tools.conf> in order to get write "
20136 "access for disk images specified by those other command line options."
20140 #: ../fish/guestfish.pod:490
20142 "This version of guestfish, guestmount and virt-rescue has a I<--rw> option "
20143 "which does nothing (it is already the default). However it is highly "
20144 "recommended that you use this option to indicate that you need write access, "
20145 "and prepare your scripts for the day when this option will be required for "
20150 #: ../fish/guestfish.pod:496
20152 "B<Note:> This does I<not> affect commands like L</add> and L</mount>, or any "
20153 "other libguestfs program apart from guestfish and guestmount."
20157 #: ../fish/guestfish.pod:499
20162 #: ../fish/guestfish.pod:501
20164 "You can quote ordinary parameters using either single or double quotes. For "
20169 #: ../fish/guestfish.pod:504
20172 " add \"file with a space.img\"\n"
20177 #: ../fish/guestfish.pod:506
20180 " rm '/file name'\n"
20185 #: ../fish/guestfish.pod:508
20193 #: ../fish/guestfish.pod:510
20195 "A few commands require a list of strings to be passed. For these, use a "
20196 "whitespace-separated list, enclosed in quotes. Strings containing "
20197 "whitespace to be passed through must be enclosed in single quotes. A "
20198 "literal single quote must be escaped with a backslash."
20202 #: ../fish/guestfish.pod:515
20205 " vgcreate VG \"/dev/sda1 /dev/sdb1\"\n"
20206 " command \"/bin/echo 'foo bar'\"\n"
20207 " command \"/bin/echo \\'foo\\'\"\n"
20212 #: ../fish/guestfish.pod:519
20213 msgid "OPTIONAL ARGUMENTS"
20217 #: ../fish/guestfish.pod:521
20219 "Some commands take optional arguments. These arguments appear in this "
20220 "documentation as C<[argname:..]>. You can use them as in these examples:"
20224 #: ../fish/guestfish.pod:525
20227 " add-drive-opts filename\n"
20232 #: ../fish/guestfish.pod:527
20235 " add-drive-opts filename readonly:true\n"
20240 #: ../fish/guestfish.pod:529
20243 " add-drive-opts filename format:qcow2 readonly:false\n"
20248 #: ../fish/guestfish.pod:531
20250 "Each optional argument can appear at most once. All optional arguments must "
20251 "appear after the required ones."
20255 #: ../fish/guestfish.pod:534
20260 #: ../fish/guestfish.pod:536
20262 "This section applies to all commands which can take integers as parameters."
20266 #: ../fish/guestfish.pod:539
20267 msgid "SIZE SUFFIX"
20271 #: ../fish/guestfish.pod:541
20273 "When the command takes a parameter measured in bytes, you can use one of the "
20274 "following suffixes to specify kilobytes, megabytes and larger sizes:"
20278 #: ../fish/guestfish.pod:547
20279 msgid "B<k> or B<K> or B<KiB>"
20283 #: ../fish/guestfish.pod:549
20284 msgid "The size in kilobytes (multiplied by 1024)."
20288 #: ../fish/guestfish.pod:551
20293 #: ../fish/guestfish.pod:553
20294 msgid "The size in SI 1000 byte units."
20298 #: ../fish/guestfish.pod:555
20299 msgid "B<M> or B<MiB>"
20303 #: ../fish/guestfish.pod:557
20304 msgid "The size in megabytes (multiplied by 1048576)."
20308 #: ../fish/guestfish.pod:559
20313 #: ../fish/guestfish.pod:561
20314 msgid "The size in SI 1000000 byte units."
20318 #: ../fish/guestfish.pod:563
20319 msgid "B<G> or B<GiB>"
20323 #: ../fish/guestfish.pod:565
20324 msgid "The size in gigabytes (multiplied by 2**30)."
20328 #: ../fish/guestfish.pod:567
20333 #: ../fish/guestfish.pod:569
20334 msgid "The size in SI 10**9 byte units."
20338 #: ../fish/guestfish.pod:571
20339 msgid "B<T> or B<TiB>"
20343 #: ../fish/guestfish.pod:573
20344 msgid "The size in terabytes (multiplied by 2**40)."
20348 #: ../fish/guestfish.pod:575
20353 #: ../fish/guestfish.pod:577
20354 msgid "The size in SI 10**12 byte units."
20358 #: ../fish/guestfish.pod:579
20359 msgid "B<P> or B<PiB>"
20363 #: ../fish/guestfish.pod:581
20364 msgid "The size in petabytes (multiplied by 2**50)."
20368 #: ../fish/guestfish.pod:583
20373 #: ../fish/guestfish.pod:585
20374 msgid "The size in SI 10**15 byte units."
20378 #: ../fish/guestfish.pod:587
20379 msgid "B<E> or B<EiB>"
20383 #: ../fish/guestfish.pod:589
20384 msgid "The size in exabytes (multiplied by 2**60)."
20388 #: ../fish/guestfish.pod:591
20393 #: ../fish/guestfish.pod:593
20394 msgid "The size in SI 10**18 byte units."
20398 #: ../fish/guestfish.pod:595
20399 msgid "B<Z> or B<ZiB>"
20403 #: ../fish/guestfish.pod:597
20404 msgid "The size in zettabytes (multiplied by 2**70)."
20408 #: ../fish/guestfish.pod:599
20413 #: ../fish/guestfish.pod:601
20414 msgid "The size in SI 10**21 byte units."
20418 #: ../fish/guestfish.pod:603
20419 msgid "B<Y> or B<YiB>"
20423 #: ../fish/guestfish.pod:605
20424 msgid "The size in yottabytes (multiplied by 2**80)."
20428 #: ../fish/guestfish.pod:607
20433 #: ../fish/guestfish.pod:609
20434 msgid "The size in SI 10**24 byte units."
20438 #: ../fish/guestfish.pod:615
20441 " truncate-size /file 1G\n"
20446 #: ../fish/guestfish.pod:617
20447 msgid "would truncate the file to 1 gigabyte."
20451 #: ../fish/guestfish.pod:619
20453 "Be careful because a few commands take sizes in kilobytes or megabytes (eg. "
20454 "the parameter to L</memsize> is specified in megabytes already). Adding a "
20455 "suffix will probably not do what you expect."
20459 #: ../fish/guestfish.pod:623
20460 msgid "OCTAL AND HEXADECIMAL NUMBERS"
20464 #: ../fish/guestfish.pod:625
20466 "For specifying the radix (base) use the C convention: C<0> to prefix an "
20467 "octal number or C<0x> to prefix a hexadecimal number. For example:"
20471 #: ../fish/guestfish.pod:628
20474 " 1234 decimal number 1234\n"
20475 " 02322 octal number, equivalent to decimal 1234\n"
20476 " 0x4d2 hexadecimal number, equivalent to decimal 1234\n"
20481 #: ../fish/guestfish.pod:632
20483 "When using the C<chmod> command, you almost always want to specify an octal "
20484 "number for the mode, and you must prefix it with C<0> (unlike the Unix "
20485 "L<chmod(1)> program):"
20489 #: ../fish/guestfish.pod:636
20492 " chmod 0777 /public # OK\n"
20493 " chmod 777 /public # WRONG! This is mode 777 decimal = 01411 octal.\n"
20498 #: ../fish/guestfish.pod:639
20500 "Commands that return numbers usually print them in decimal, but some "
20501 "commands print numbers in other radices (eg. C<umask> prints the mode in "
20502 "octal, preceeded by C<0>)."
20506 #: ../fish/guestfish.pod:643
20507 msgid "WILDCARDS AND GLOBBING"
20511 #: ../fish/guestfish.pod:645
20513 "Neither guestfish nor the underlying guestfs API performs wildcard expansion "
20514 "(globbing) by default. So for example the following will not do what you "
20519 #: ../fish/guestfish.pod:649
20527 #: ../fish/guestfish.pod:651
20529 "Assuming you don't have a directory called literally C</home/*> then the "
20530 "above command will return an error."
20534 #: ../fish/guestfish.pod:654
20535 msgid "To perform wildcard expansion, use the C<glob> command."
20539 #: ../fish/guestfish.pod:656
20542 " glob rm-rf /home/*\n"
20547 #: ../fish/guestfish.pod:658
20549 "runs C<rm-rf> on each path that matches (ie. potentially running the command "
20550 "many times), equivalent to:"
20554 #: ../fish/guestfish.pod:661
20557 " rm-rf /home/jim\n"
20558 " rm-rf /home/joe\n"
20559 " rm-rf /home/mary\n"
20564 #: ../fish/guestfish.pod:665
20565 msgid "C<glob> only works on simple guest paths and not on device names."
20569 #: ../fish/guestfish.pod:667
20571 "If you have several parameters, each containing a wildcard, then glob will "
20572 "perform a Cartesian product."
20576 #: ../fish/guestfish.pod:670
20581 #: ../fish/guestfish.pod:672
20583 "Any line which starts with a I<#> character is treated as a comment and "
20584 "ignored. The I<#> can optionally be preceeded by whitespace, but B<not> by "
20585 "a command. For example:"
20589 #: ../fish/guestfish.pod:676
20592 " # this is a comment\n"
20593 " # this is a comment\n"
20594 " foo # NOT a comment\n"
20599 #: ../fish/guestfish.pod:680
20600 msgid "Blank lines are also ignored."
20604 #: ../fish/guestfish.pod:682
20605 msgid "RUNNING COMMANDS LOCALLY"
20609 #: ../fish/guestfish.pod:684
20611 "Any line which starts with a I<!> character is treated as a command sent to "
20612 "the local shell (C</bin/sh> or whatever L<system(3)> uses). For example:"
20616 #: ../fish/guestfish.pod:688
20620 " tgz-out /remote local/remote-data.tar.gz\n"
20625 #: ../fish/guestfish.pod:691
20627 "will create a directory C<local> on the host, and then export the contents "
20628 "of C</remote> on the mounted filesystem to C<local/remote-data.tar.gz>. "
20629 "(See C<tgz-out>)."
20633 #: ../fish/guestfish.pod:695
20635 "To change the local directory, use the C<lcd> command. C<!cd> will have no "
20636 "effect, due to the way that subprocesses work in Unix."
20640 #: ../fish/guestfish.pod:698
20641 msgid "LOCAL COMMANDS WITH INLINE EXECUTION"
20645 #: ../fish/guestfish.pod:700
20647 "If a line starts with I<E<lt>!> then the shell command is executed (as for "
20648 "I<!>), but subsequently any output (stdout) of the shell command is parsed "
20649 "and executed as guestfish commands."
20653 #: ../fish/guestfish.pod:704
20655 "Thus you can use shell script to construct arbitrary guestfish commands "
20656 "which are then parsed by guestfish."
20660 #: ../fish/guestfish.pod:707
20662 "For example it is tedious to create a sequence of files (eg. C</foo.1> "
20663 "through C</foo.100>) using guestfish commands alone. However this is simple "
20664 "if we use a shell script to create the guestfish commands for us:"
20668 #: ../fish/guestfish.pod:712
20671 " <! for n in `seq 1 100`; do echo write /foo.$n $n; done\n"
20676 #: ../fish/guestfish.pod:714
20677 msgid "or with names like C</foo.001>:"
20681 #: ../fish/guestfish.pod:716
20684 " <! for n in `seq 1 100`; do printf \"write /foo.%03d %d\\n\" $n $n; done\n"
20689 #: ../fish/guestfish.pod:718
20691 "When using guestfish interactively it can be helpful to just run the shell "
20692 "script first (ie. remove the initial C<E<lt>> character so it is just an "
20693 "ordinary I<!> local command), see what guestfish commands it would run, and "
20694 "when you are happy with those prepend the C<E<lt>> character to run the "
20695 "guestfish commands for real."
20699 #: ../fish/guestfish.pod:724
20704 #: ../fish/guestfish.pod:726
20706 "Use C<command E<lt>spaceE<gt> | command> to pipe the output of the first "
20707 "command (a guestfish command) to the second command (any host command). For "
20712 #: ../fish/guestfish.pod:730
20715 " cat /etc/passwd | awk -F: '$3 == 0 { print }'\n"
20720 #: ../fish/guestfish.pod:732
20722 "(where C<cat> is the guestfish cat command, but C<awk> is the host awk "
20723 "program). The above command would list all accounts in the guest filesystem "
20724 "which have UID 0, ie. root accounts including backdoors. Other examples:"
20728 #: ../fish/guestfish.pod:737
20731 " hexdump /bin/ls | head\n"
20732 " list-devices | tail -1\n"
20733 " tgz-out / - | tar ztf -\n"
20738 #: ../fish/guestfish.pod:741
20740 "The space before the pipe symbol is required, any space after the pipe "
20741 "symbol is optional. Everything after the pipe symbol is just passed "
20742 "straight to the host shell, so it can contain redirections, globs and "
20743 "anything else that makes sense on the host side."
20747 #: ../fish/guestfish.pod:746
20749 "To use a literal argument which begins with a pipe symbol, you have to quote "
20754 #: ../fish/guestfish.pod:749
20762 #: ../fish/guestfish.pod:751
20763 msgid "HOME DIRECTORIES"
20767 #: ../fish/guestfish.pod:753
20769 "If a parameter starts with the character C<~> then the tilde may be expanded "
20770 "as a home directory path (either C<~> for the current user's home directory, "
20771 "or C<~user> for another user)."
20775 #: ../fish/guestfish.pod:757
20777 "Note that home directory expansion happens for users known I<on the host>, "
20778 "not in the guest filesystem."
20782 #: ../fish/guestfish.pod:760
20784 "To use a literal argument which begins with a tilde, you have to quote it, "
20789 #: ../fish/guestfish.pod:763
20797 #: ../fish/guestfish.pod:767
20799 "Libguestfs has some support for Linux guests encrypted according to the "
20800 "Linux Unified Key Setup (LUKS) standard, which includes nearly all whole "
20801 "disk encryption systems used by modern Linux guests. Currently only LVM-on-"
20802 "LUKS is supported."
20806 #: ../fish/guestfish.pod:772
20807 msgid "Identify encrypted block devices and partitions using L</vfs-type>:"
20811 #: ../fish/guestfish.pod:774
20814 " ><fs> vfs-type /dev/sda2\n"
20820 #: ../fish/guestfish.pod:777
20822 "Then open those devices using L</luks-open>. This creates a device-mapper "
20823 "device called C</dev/mapper/luksdev>."
20827 #: ../fish/guestfish.pod:780
20830 " ><fs> luks-open /dev/sda2 luksdev\n"
20831 " Enter key or passphrase (\"key\"): <enter the passphrase>\n"
20836 #: ../fish/guestfish.pod:783
20838 "Finally you have to tell LVM to scan for volume groups on the newly created "
20843 #: ../fish/guestfish.pod:786
20847 " vg-activate-all true\n"
20852 #: ../fish/guestfish.pod:789
20853 msgid "The logical volume(s) can now be mounted in the usual way."
20857 #: ../fish/guestfish.pod:791
20859 "Before closing a LUKS device you must unmount any logical volumes on it and "
20860 "deactivate the volume groups by calling C<vg-activate false VG> on each "
20861 "one. Then you can close the mapper device:"
20865 #: ../fish/guestfish.pod:795
20868 " vg-activate false /dev/VG\n"
20869 " luks-close /dev/mapper/luksdev\n"
20874 #: ../fish/guestfish.pod:798 ../tools/virt-edit.pl:342
20875 msgid "WINDOWS PATHS"
20879 #: ../fish/guestfish.pod:800
20881 "If a path is prefixed with C<win:> then you can use Windows-style drive "
20882 "letters and paths (with some limitations). The following commands are "
20887 #: ../fish/guestfish.pod:804
20890 " file /WINDOWS/system32/config/system.LOG\n"
20895 #: ../fish/guestfish.pod:806
20898 " file win:\\windows\\system32\\config\\system.log\n"
20903 #: ../fish/guestfish.pod:808
20906 " file WIN:C:\\Windows\\SYSTEM32\\CONFIG\\SYSTEM.LOG\n"
20911 #: ../fish/guestfish.pod:810
20913 "The parameter is rewritten \"behind the scenes\" by looking up the position "
20914 "where the drive is mounted, prepending that to the path, changing all "
20915 "backslash characters to forward slash, then resolving the result using L</"
20916 "case-sensitive-path>. For example if the E: drive was mounted on C</e> then "
20917 "the parameter might be rewritten like this:"
20921 #: ../fish/guestfish.pod:816
20924 " win:e:\\foo\\bar => /e/FOO/bar\n"
20929 #: ../fish/guestfish.pod:818
20930 msgid "This only works in argument positions that expect a path."
20934 #: ../fish/guestfish.pod:820
20935 msgid "UPLOADING AND DOWNLOADING FILES"
20939 #: ../fish/guestfish.pod:822
20941 "For commands such as C<upload>, C<download>, C<tar-in>, C<tar-out> and "
20942 "others which upload from or download to a local file, you can use the "
20943 "special filename C<-> to mean \"from stdin\" or \"to stdout\". For example:"
20947 #: ../fish/guestfish.pod:826
20955 #: ../fish/guestfish.pod:828
20957 "reads stdin and creates from that a file C</foo> in the disk image, and:"
20961 #: ../fish/guestfish.pod:831
20964 " tar-out /etc - | tar tf -\n"
20969 #: ../fish/guestfish.pod:833
20971 "writes the tarball to stdout and then pipes that into the external \"tar\" "
20972 "command (see L</PIPES>)."
20976 #: ../fish/guestfish.pod:836
20978 "When using C<-> to read from stdin, the input is read up to the end of "
20979 "stdin. You can also use a special \"heredoc\"-like syntax to read up to "
20980 "some arbitrary end marker:"
20984 #: ../fish/guestfish.pod:840
20987 " upload -<<END /foo\n"
20996 #: ../fish/guestfish.pod:846
20998 "Any string of characters can be used instead of C<END>. The end marker must "
20999 "appear on a line of its own, without any preceeding or following characters "
21000 "(not even spaces)."
21004 #: ../fish/guestfish.pod:850
21006 "Note that the C<-E<lt>E<lt>> syntax only applies to parameters used to "
21007 "upload local files (so-called \"FileIn\" parameters in the generator)."
21011 #: ../fish/guestfish.pod:853
21012 msgid "EXIT ON ERROR BEHAVIOUR"
21016 #: ../fish/guestfish.pod:855
21018 "By default, guestfish will ignore any errors when in interactive mode (ie. "
21019 "taking commands from a human over a tty), and will exit on the first error "
21020 "in non-interactive mode (scripts, commands given on the command line)."
21024 #: ../fish/guestfish.pod:860
21026 "If you prefix a command with a I<-> character, then that command will not "
21027 "cause guestfish to exit, even if that (one) command returns an error."
21031 #: ../fish/guestfish.pod:864
21032 msgid "REMOTE CONTROL GUESTFISH OVER A SOCKET"
21036 #: ../fish/guestfish.pod:866
21038 "Guestfish can be remote-controlled over a socket. This is useful "
21039 "particularly in shell scripts where you want to make several different "
21040 "changes to a filesystem, but you don't want the overhead of starting up a "
21041 "guestfish process each time."
21045 #: ../fish/guestfish.pod:871
21046 msgid "Start a guestfish server process using:"
21050 #: ../fish/guestfish.pod:873
21053 " eval \"`guestfish --listen`\"\n"
21058 #: ../fish/guestfish.pod:875
21059 msgid "and then send it commands by doing:"
21063 #: ../fish/guestfish.pod:877
21066 " guestfish --remote cmd [...]\n"
21071 #: ../fish/guestfish.pod:879
21072 msgid "To cause the server to exit, send it the exit command:"
21076 #: ../fish/guestfish.pod:881
21079 " guestfish --remote exit\n"
21084 #: ../fish/guestfish.pod:883
21086 "Note that the server will normally exit if there is an error in a command. "
21087 "You can change this in the usual way. See section L</EXIT ON ERROR "
21092 #: ../fish/guestfish.pod:887
21093 msgid "CONTROLLING MULTIPLE GUESTFISH PROCESSES"
21097 #: ../fish/guestfish.pod:889
21099 "The C<eval> statement sets the environment variable C<$GUESTFISH_PID>, which "
21100 "is how the I<--remote> option knows where to send the commands. You can "
21101 "have several guestfish listener processes running using:"
21105 #: ../fish/guestfish.pod:893
21108 " eval \"`guestfish --listen`\"\n"
21109 " pid1=$GUESTFISH_PID\n"
21110 " eval \"`guestfish --listen`\"\n"
21111 " pid2=$GUESTFISH_PID\n"
21113 " guestfish --remote=$pid1 cmd\n"
21114 " guestfish --remote=$pid2 cmd\n"
21119 #: ../fish/guestfish.pod:901
21120 msgid "REMOTE CONTROL AND CSH"
21124 #: ../fish/guestfish.pod:903
21126 "When using csh-like shells (csh, tcsh etc) you have to add the I<--csh> "
21131 #: ../fish/guestfish.pod:906
21134 " eval \"`guestfish --listen --csh`\"\n"
21139 #: ../fish/guestfish.pod:908
21140 msgid "REMOTE CONTROL DETAILS"
21144 #: ../fish/guestfish.pod:910
21146 "Remote control happens over a Unix domain socket called C</tmp/.guestfish-"
21147 "$UID/socket-$PID>, where C<$UID> is the effective user ID of the process, "
21148 "and C<$PID> is the process ID of the server."
21152 #: ../fish/guestfish.pod:914
21153 msgid "Guestfish client and server versions must match exactly."
21157 #: ../fish/guestfish.pod:916
21158 msgid "PREPARED DISK IMAGES"
21162 #: ../fish/guestfish.pod:918
21164 "Use the I<-N type> or I<--new type> parameter to select one of a set of "
21165 "preformatted disk images that guestfish can make for you to save typing. "
21166 "This is particularly useful for testing purposes. This option is used "
21167 "instead of the I<-a> option, and like I<-a> can appear multiple times (and "
21168 "can be mixed with I<-a>)."
21172 #: ../fish/guestfish.pod:924
21174 "The new disk is called C<test1.img> for the first I<-N>, C<test2.img> for "
21175 "the second and so on. Existing files in the current directory are "
21180 #: ../fish/guestfish.pod:928
21182 "The type briefly describes how the disk should be sized, partitioned, how "
21183 "filesystem(s) should be created, and how content should be added. "
21184 "Optionally the type can be followed by extra parameters, separated by C<:> "
21185 "(colon) characters. For example, I<-N fs> creates a default 100MB, sparsely-"
21186 "allocated disk, containing a single partition, with the partition formatted "
21187 "as ext2. I<-N fs:ext4:1G> is the same, but for an ext4 filesystem on a 1GB "
21192 #: ../fish/guestfish.pod:936
21193 msgid "To list the available types and any extra parameters they take, run:"
21197 #: ../fish/guestfish.pod:940
21199 "Note that the prepared filesystem is not mounted. You would usually have to "
21200 "use the C<mount /dev/sda1 /> command or add the I<-m /dev/sda1> option."
21204 #: ../fish/guestfish.pod:944
21206 "If any I<-N> or I<--new> options are given, the guest is automatically "
21211 #: ../fish/guestfish.pod:949
21212 msgid "Create a 100MB disk with an ext4-formatted partition:"
21216 #: ../fish/guestfish.pod:951
21219 " guestfish -N fs:ext4\n"
21224 #: ../fish/guestfish.pod:953
21225 msgid "Create a 32MB disk with a VFAT-formatted partition, and mount it:"
21229 #: ../fish/guestfish.pod:955
21232 " guestfish -N fs:vfat:32M -m /dev/sda1\n"
21237 #: ../fish/guestfish.pod:957
21238 msgid "Create a blank 200MB disk:"
21242 #: ../fish/guestfish.pod:959
21245 " guestfish -N disk:200M\n"
21250 #: ../fish/guestfish.pod:961
21251 msgid "PROGRESS BARS"
21255 #: ../fish/guestfish.pod:963
21257 "Some (not all) long-running commands send progress notification messages as "
21258 "they are running. Guestfish turns these messages into progress bars."
21262 #: ../fish/guestfish.pod:967
21264 "When a command that supports progress bars takes longer than two seconds to "
21265 "run, and if progress bars are enabled, then you will see one appearing below "
21270 #: ../fish/guestfish.pod:971
21273 " ><fs> copy-size /large-file /another-file 2048M\n"
21274 " / 10% [#####-----------------------------------------] 00:30\n"
21279 #: ../fish/guestfish.pod:974
21281 "The spinner on the left hand side moves round once for every progress "
21282 "notification received from the backend. This is a (reasonably) golden "
21283 "assurance that the command is \"doing something\" even if the progress bar "
21284 "is not moving, because the command is able to send the progress "
21285 "notifications. When the bar reaches 100% and the command finishes, the "
21286 "spinner disappears."
21290 #: ../fish/guestfish.pod:981
21292 "Progress bars are enabled by default when guestfish is used interactively. "
21293 "You can enable them even for non-interactive modes using I<--progress-bars>, "
21294 "and you can disable them completely using I<--no-progress-bars>."
21298 #: ../fish/guestfish.pod:986
21299 msgid "GUESTFISH COMMANDS"
21303 #: ../fish/guestfish.pod:988
21305 "The commands in this section are guestfish convenience commands, in other "
21306 "words, they are not part of the L<guestfs(3)> API."
21310 #: ../fish/guestfish.pod:991
21315 #: ../fish/guestfish.pod:993
21324 #: ../fish/guestfish.pod:996
21325 msgid "Without any parameter, this provides general help."
21329 #: ../fish/guestfish.pod:998
21330 msgid "With a C<cmd> parameter, this displays detailed help for that command."
21334 #: ../fish/guestfish.pod:1000
21335 msgid "quit | exit"
21339 #: ../fish/guestfish.pod:1002
21340 msgid "This exits guestfish. You can also use C<^D> key."
21344 #: ../fish/guestfish.pod:1004
21345 msgid "@FISH_COMMANDS@"
21349 #: ../fish/guestfish.pod:1006
21354 #: ../fish/guestfish.pod:1010 ../test-tool/libguestfs-test-tool.pod:77
21359 #: ../fish/guestfish.pod:1012
21361 "guestfish returns 0 if the commands completed without error, or 1 if there "
21366 #: ../fish/guestfish.pod:1019
21371 #: ../fish/guestfish.pod:1021
21373 "The C<edit> command uses C<$EDITOR> as the editor. If not set, it uses "
21378 #: ../fish/guestfish.pod:1024
21379 msgid "GUESTFISH_PID"
21383 #: ../fish/guestfish.pod:1026
21385 "Used with the I<--remote> option to specify the remote guestfish process to "
21386 "control. See section L</REMOTE CONTROL GUESTFISH OVER A SOCKET>."
21390 #: ../fish/guestfish.pod:1030
21395 #: ../fish/guestfish.pod:1032
21397 "The L</hexedit> command uses C<$HEXEDITOR> as the external hex editor. If "
21398 "not specified, the external L<hexedit(1)> program is used."
21402 #: ../fish/guestfish.pod:1036
21407 #: ../fish/guestfish.pod:1038
21409 "If compiled with GNU readline support, various files in the home directory "
21410 "can be used. See L</FILES>."
21414 #: ../fish/guestfish.pod:1047
21416 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
21417 "effect as using the B<-v> option."
21421 #: ../fish/guestfish.pod:1059
21423 "Set the path that guestfish uses to search for kernel and initrd.img. See "
21424 "the discussion of paths in L<guestfs(3)>."
21428 #: ../fish/guestfish.pod:1070
21429 msgid "Set C<LIBGUESTFS_TRACE=1> to enable command traces."
21433 #: ../fish/guestfish.pod:1072
21438 #: ../fish/guestfish.pod:1074
21440 "The C<more> command uses C<$PAGER> as the pager. If not set, it uses "
21445 #: ../fish/guestfish.pod:1090 ../fuse/guestmount.pod:252
21450 #: ../fish/guestfish.pod:1094 ../fuse/guestmount.pod:256
21451 msgid "$HOME/.libguestfs-tools.rc"
21455 #: ../fish/guestfish.pod:1096 ../fuse/guestmount.pod:258
21456 msgid "/etc/libguestfs-tools.conf"
21460 #: ../fish/guestfish.pod:1098 ../fuse/guestmount.pod:260
21462 "This configuration file controls the default read-only or read-write mode "
21463 "(I<--ro> or I<--rw>)."
21467 #: ../fish/guestfish.pod:1101
21468 msgid "See L</OPENING DISKS FOR READ AND WRITE>."
21472 #: ../fish/guestfish.pod:1103
21473 msgid "$HOME/.guestfish"
21477 #: ../fish/guestfish.pod:1105
21479 "If compiled with GNU readline support, then the command history is saved in "
21484 #: ../fish/guestfish.pod:1108
21485 msgid "$HOME/.inputrc"
21489 #: ../fish/guestfish.pod:1110
21490 msgid "/etc/inputrc"
21494 #: ../fish/guestfish.pod:1112
21496 "If compiled with GNU readline support, then these files can be used to "
21497 "configure readline. For further information, please see L<readline(3)/"
21498 "INITIALIZATION FILE>."
21502 #: ../fish/guestfish.pod:1116
21503 msgid "To write rules which only apply to guestfish, use:"
21507 #: ../fish/guestfish.pod:1118
21517 #: ../fish/guestfish.pod:1122
21519 "Variables that you can set in inputrc that change the behaviour of guestfish "
21520 "in useful ways include:"
21524 #: ../fish/guestfish.pod:1127
21525 msgid "completion-ignore-case (default: on)"
21529 #: ../fish/guestfish.pod:1129
21531 "By default, guestfish will ignore case when tab-completing paths on the "
21536 #: ../fish/guestfish.pod:1132
21539 " set completion-ignore-case off\n"
21544 #: ../fish/guestfish.pod:1134
21545 msgid "to make guestfish case sensitive."
21549 #: ../fish/guestfish.pod:1138
21554 #: ../fish/guestfish.pod:1140
21555 msgid "test2.img (etc)"
21559 #: ../fish/guestfish.pod:1142
21561 "When using the C<-N> or C<--new> option, the prepared disk or filesystem "
21562 "will be created in the file C<test1.img> in the current directory. The "
21563 "second use of C<-N> will use C<test2.img> and so on. Any existing file with "
21564 "the same name will be overwritten."
21568 #: ../fish/guestfish.pod:1151
21570 "L<guestfs(3)>, L<http://libguestfs.org/>, L<virt-cat(1)>, L<virt-copy-in(1)"
21571 ">, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, L<virt-filesystems(1)"
21572 ">, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, L<virt-list-partitions"
21573 "(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, L<virt-rescue(1)>, L<virt-resize(1)"
21574 ">, L<virt-tar(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<virt-win-reg(1)"
21575 ">, L<hexedit(1)>."
21579 #: ../fish/guestfish.pod:1181 ../test-tool/libguestfs-test-tool.pod:102
21580 #: ../fuse/guestmount.pod:287 ../tools/virt-edit.pl:518
21581 #: ../tools/virt-win-reg.pl:606 ../tools/virt-list-filesystems.pl:210
21582 #: ../tools/virt-tar.pl:309 ../tools/virt-make-fs.pl:572
21583 #: ../tools/virt-list-partitions.pl:277
21585 "This program is free software; you can redistribute it and/or modify it "
21586 "under the terms of the GNU General Public License as published by the Free "
21587 "Software Foundation; either version 2 of the License, or (at your option) "
21588 "any later version."
21592 #: ../fish/guestfish.pod:1186 ../test-tool/libguestfs-test-tool.pod:107
21593 #: ../fuse/guestmount.pod:292 ../tools/virt-edit.pl:523
21594 #: ../tools/virt-win-reg.pl:611 ../tools/virt-list-filesystems.pl:215
21595 #: ../tools/virt-tar.pl:314 ../tools/virt-make-fs.pl:577
21596 #: ../tools/virt-list-partitions.pl:282
21598 "This program is distributed in the hope that it will be useful, but WITHOUT "
21599 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
21600 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for "
21605 #: ../fish/guestfish.pod:1191 ../test-tool/libguestfs-test-tool.pod:112
21606 #: ../fuse/guestmount.pod:297 ../tools/virt-edit.pl:528
21607 #: ../tools/virt-win-reg.pl:616 ../tools/virt-list-filesystems.pl:220
21608 #: ../tools/virt-tar.pl:319 ../tools/virt-make-fs.pl:582
21609 #: ../tools/virt-list-partitions.pl:287
21611 "You should have received a copy of the GNU General Public License along with "
21612 "this program; if not, write to the Free Software Foundation, Inc., 675 Mass "
21613 "Ave, Cambridge, MA 02139, USA."
21617 #: ../fish/guestfish-actions.pod:1
21622 #: ../fish/guestfish-actions.pod:3
21625 " add-cdrom filename\n"
21630 #: ../fish/guestfish-actions.pod:15
21632 "This call checks for the existence of C<filename>. This stops you from "
21633 "specifying other types of drive which are supported by qemu such as C<nbd:> "
21634 "and C<http:> URLs. To specify those, use the general L</config> call "
21639 #: ../fish/guestfish-actions.pod:22
21641 "If you just want to add an ISO file (often you use this as an efficient way "
21642 "to transfer large files into the guest), then you should probably use L</add-"
21643 "drive-ro> instead."
21647 #: ../fish/guestfish-actions.pod:35
21652 #: ../fish/guestfish-actions.pod:37
21657 #: ../fish/guestfish-actions.pod:39
21660 " add-domain dom [libvirturi:..] [readonly:..] [iface:..] [live:..]\n"
21665 #: ../fish/guestfish-actions.pod:41
21667 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
21668 "It works by connecting to libvirt, requesting the domain and domain XML from "
21669 "libvirt, parsing it for disks, and calling L</add-drive-opts> on each one."
21673 #: ../fish/guestfish-actions.pod:71
21675 "The other optional parameters are passed directly through to L</add-drive-"
21680 #: ../fish/guestfish-actions.pod:74 ../fish/guestfish-actions.pod:138
21681 #: ../fish/guestfish-actions.pod:3039
21683 "This command has one or more optional arguments. See L</OPTIONAL ARGUMENTS>."
21687 #: ../fish/guestfish-actions.pod:76
21692 #: ../fish/guestfish-actions.pod:78
21695 " add-drive filename\n"
21700 #: ../fish/guestfish-actions.pod:80
21702 "This function is the equivalent of calling L</add-drive-opts> with no "
21703 "optional parameters, so the disk is added writable, with the format being "
21704 "detected automatically."
21708 #: ../fish/guestfish-actions.pod:84
21710 "Automatic detection of the format opens you up to a potential security hole "
21711 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
21712 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
21713 "you should think about replacing calls to this function with calls to L</add-"
21714 "drive-opts>, and specifying the format."
21718 #: ../fish/guestfish-actions.pod:91
21719 msgid "add-drive-opts"
21723 #: ../fish/guestfish-actions.pod:93
21728 #: ../fish/guestfish-actions.pod:95
21731 " add-drive-opts filename [readonly:..] [format:..] [iface:..]\n"
21736 #: ../fish/guestfish-actions.pod:122
21738 "This forces the image format. If you omit this (or use L</add-drive> or L</"
21739 "add-drive-ro>) then the format is automatically detected. Possible formats "
21740 "include C<raw> and C<qcow2>."
21744 #: ../fish/guestfish-actions.pod:133
21746 "This rarely-used option lets you emulate the behaviour of the deprecated L</"
21747 "add-drive-with-if> call (q.v.)"
21751 #: ../fish/guestfish-actions.pod:140
21752 msgid "add-drive-ro"
21756 #: ../fish/guestfish-actions.pod:142
21761 #: ../fish/guestfish-actions.pod:144
21764 " add-drive-ro filename\n"
21769 #: ../fish/guestfish-actions.pod:146
21771 "This function is the equivalent of calling L</add-drive-opts> with the "
21772 "optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the disk "
21773 "is added read-only, with the format being detected automatically."
21777 #: ../fish/guestfish-actions.pod:151
21778 msgid "add-drive-ro-with-if"
21782 #: ../fish/guestfish-actions.pod:153
21785 " add-drive-ro-with-if filename iface\n"
21790 #: ../fish/guestfish-actions.pod:155
21792 "This is the same as L</add-drive-ro> but it allows you to specify the QEMU "
21793 "interface emulation to use at run time."
21797 #: ../fish/guestfish-actions.pod:165
21798 msgid "add-drive-with-if"
21802 #: ../fish/guestfish-actions.pod:167
21805 " add-drive-with-if filename iface\n"
21810 #: ../fish/guestfish-actions.pod:169
21812 "This is the same as L</add-drive> but it allows you to specify the QEMU "
21813 "interface emulation to use at run time."
21817 #: ../fish/guestfish-actions.pod:179
21822 #: ../fish/guestfish-actions.pod:181
21825 " aug-clear augpath\n"
21830 #: ../fish/guestfish-actions.pod:186
21835 #: ../fish/guestfish-actions.pod:188
21843 #: ../fish/guestfish-actions.pod:190
21845 "Close the current Augeas handle and free up any resources used by it. After "
21846 "calling this, you have to call L</aug-init> again before you can use any "
21847 "other Augeas functions."
21851 #: ../fish/guestfish-actions.pod:195
21852 msgid "aug-defnode"
21856 #: ../fish/guestfish-actions.pod:197
21859 " aug-defnode name expr val\n"
21864 #: ../fish/guestfish-actions.pod:202
21866 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
21867 "calling L</aug-set> C<expr>, C<value>. C<name> will be the nodeset "
21868 "containing that single node."
21872 #: ../fish/guestfish-actions.pod:210
21877 #: ../fish/guestfish-actions.pod:212
21880 " aug-defvar name expr\n"
21885 #: ../fish/guestfish-actions.pod:221
21890 #: ../fish/guestfish-actions.pod:223
21893 " aug-get augpath\n"
21898 #: ../fish/guestfish-actions.pod:228
21903 #: ../fish/guestfish-actions.pod:230
21906 " aug-init root flags\n"
21911 #: ../fish/guestfish-actions.pod:236
21912 msgid "You must call this before using any other L</aug-*> commands."
21916 #: ../fish/guestfish-actions.pod:271
21917 msgid "Do not load the tree in L</aug-init>."
21921 #: ../fish/guestfish-actions.pod:275
21922 msgid "To close the handle, you can call L</aug-close>."
21926 #: ../fish/guestfish-actions.pod:279
21931 #: ../fish/guestfish-actions.pod:281
21934 " aug-insert augpath label true|false\n"
21939 #: ../fish/guestfish-actions.pod:291
21944 #: ../fish/guestfish-actions.pod:293
21952 #: ../fish/guestfish-actions.pod:300
21957 #: ../fish/guestfish-actions.pod:302
21960 " aug-ls augpath\n"
21965 #: ../fish/guestfish-actions.pod:304
21967 "This is just a shortcut for listing L</aug-match> C<path/*> and sorting the "
21968 "resulting nodes into alphabetical order."
21972 #: ../fish/guestfish-actions.pod:307
21977 #: ../fish/guestfish-actions.pod:309
21980 " aug-match augpath\n"
21985 #: ../fish/guestfish-actions.pod:315
21990 #: ../fish/guestfish-actions.pod:317
21993 " aug-mv src dest\n"
21998 #: ../fish/guestfish-actions.pod:322
22003 #: ../fish/guestfish-actions.pod:324
22006 " aug-rm augpath\n"
22011 #: ../fish/guestfish-actions.pod:330
22016 #: ../fish/guestfish-actions.pod:332
22024 #: ../fish/guestfish-actions.pod:336
22026 "The flags which were passed to L</aug-init> affect exactly how files are "
22031 #: ../fish/guestfish-actions.pod:339
22036 #: ../fish/guestfish-actions.pod:341
22039 " aug-set augpath val\n"
22044 #: ../fish/guestfish-actions.pod:345
22046 "In the Augeas API, it is possible to clear a node by setting the value to "
22047 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
22048 "this call. Instead you must use the L</aug-clear> call."
22052 #: ../fish/guestfish-actions.pod:350
22057 #: ../fish/guestfish-actions.pod:352
22060 " available 'groups ...'\n"
22065 #: ../fish/guestfish-actions.pod:358
22067 "The libguestfs groups, and the functions that those groups correspond to, "
22068 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
22069 "runtime by calling L</available-all-groups>."
22073 #: ../fish/guestfish-actions.pod:382
22074 msgid "You must call L</launch> before calling this function."
22078 #: ../fish/guestfish-actions.pod:404
22080 "This call was added in version C<1.0.80>. In previous versions of "
22081 "libguestfs all you could do would be to speculatively execute a command to "
22082 "find out if the daemon implemented it. See also L</version>."
22086 #: ../fish/guestfish-actions.pod:411
22087 msgid "available-all-groups"
22091 #: ../fish/guestfish-actions.pod:413
22094 " available-all-groups\n"
22099 #: ../fish/guestfish-actions.pod:415
22101 "This command returns a list of all optional groups that this daemon knows "
22102 "about. Note this returns both supported and unsupported groups. To find "
22103 "out which ones the daemon can actually support you have to call L</"
22104 "available> on each member of the returned list."
22108 #: ../fish/guestfish-actions.pod:421
22109 msgid "See also L</available> and L<guestfs(3)/AVAILABILITY>."
22113 #: ../fish/guestfish-actions.pod:423
22118 #: ../fish/guestfish-actions.pod:425
22121 " base64-in (base64file|-) filename\n"
22126 #: ../fish/guestfish-actions.pod:430 ../fish/guestfish-actions.pod:439
22127 #: ../fish/guestfish-actions.pod:663 ../fish/guestfish-actions.pod:832
22128 #: ../fish/guestfish-actions.pod:851 ../fish/guestfish-actions.pod:1228
22129 #: ../fish/guestfish-actions.pod:4437 ../fish/guestfish-actions.pod:4449
22130 #: ../fish/guestfish-actions.pod:4460 ../fish/guestfish-actions.pod:4471
22131 #: ../fish/guestfish-actions.pod:4523 ../fish/guestfish-actions.pod:4532
22132 #: ../fish/guestfish-actions.pod:4586 ../fish/guestfish-actions.pod:4609
22133 msgid "Use C<-> instead of a filename to read/write from stdin/stdout."
22137 #: ../fish/guestfish-actions.pod:432
22142 #: ../fish/guestfish-actions.pod:434
22145 " base64-out filename (base64file|-)\n"
22150 #: ../fish/guestfish-actions.pod:441
22151 msgid "blockdev-flushbufs"
22155 #: ../fish/guestfish-actions.pod:443
22158 " blockdev-flushbufs device\n"
22163 #: ../fish/guestfish-actions.pod:450
22164 msgid "blockdev-getbsz"
22168 #: ../fish/guestfish-actions.pod:452
22171 " blockdev-getbsz device\n"
22176 #: ../fish/guestfish-actions.pod:461
22177 msgid "blockdev-getro"
22181 #: ../fish/guestfish-actions.pod:463
22184 " blockdev-getro device\n"
22189 #: ../fish/guestfish-actions.pod:470
22190 msgid "blockdev-getsize64"
22194 #: ../fish/guestfish-actions.pod:472
22197 " blockdev-getsize64 device\n"
22202 #: ../fish/guestfish-actions.pod:476
22203 msgid "See also L</blockdev-getsz>."
22207 #: ../fish/guestfish-actions.pod:480
22208 msgid "blockdev-getss"
22212 #: ../fish/guestfish-actions.pod:482
22215 " blockdev-getss device\n"
22220 #: ../fish/guestfish-actions.pod:487
22222 "(Note, this is not the size in sectors, use L</blockdev-getsz> for that)."
22226 #: ../fish/guestfish-actions.pod:492
22227 msgid "blockdev-getsz"
22231 #: ../fish/guestfish-actions.pod:494
22234 " blockdev-getsz device\n"
22239 #: ../fish/guestfish-actions.pod:499
22241 "See also L</blockdev-getss> for the real sector size of the device, and L</"
22242 "blockdev-getsize64> for the more useful I<size in bytes>."
22246 #: ../fish/guestfish-actions.pod:505
22247 msgid "blockdev-rereadpt"
22251 #: ../fish/guestfish-actions.pod:507
22254 " blockdev-rereadpt device\n"
22259 #: ../fish/guestfish-actions.pod:513
22260 msgid "blockdev-setbsz"
22264 #: ../fish/guestfish-actions.pod:515
22267 " blockdev-setbsz device blocksize\n"
22272 #: ../fish/guestfish-actions.pod:524
22273 msgid "blockdev-setro"
22277 #: ../fish/guestfish-actions.pod:526
22280 " blockdev-setro device\n"
22285 #: ../fish/guestfish-actions.pod:532
22286 msgid "blockdev-setrw"
22290 #: ../fish/guestfish-actions.pod:534
22293 " blockdev-setrw device\n"
22298 #: ../fish/guestfish-actions.pod:540
22299 msgid "case-sensitive-path"
22303 #: ../fish/guestfish-actions.pod:542
22306 " case-sensitive-path path\n"
22311 #: ../fish/guestfish-actions.pod:566
22313 "Thus L</case-sensitive-path> (\"/Windows/System32\") might return C<\"/"
22314 "WINDOWS/system32\"> (the exact return value would depend on details of how "
22315 "the directories were originally created under Windows)."
22319 #: ../fish/guestfish-actions.pod:574
22320 msgid "See also L</realpath>."
22324 #: ../fish/guestfish-actions.pod:576
22329 #: ../fish/guestfish-actions.pod:578
22337 #: ../fish/guestfish-actions.pod:582
22339 "Note that this function cannot correctly handle binary files (specifically, "
22340 "files containing C<\\0> character which is treated as end of string). For "
22341 "those you need to use the L</read-file> or L</download> functions which have "
22342 "a more complex interface."
22346 #: ../fish/guestfish-actions.pod:590
22351 #: ../fish/guestfish-actions.pod:592
22354 " checksum csumtype path\n"
22359 #: ../fish/guestfish-actions.pod:635
22360 msgid "To get the checksum for a device, use L</checksum-device>."
22364 #: ../fish/guestfish-actions.pod:637
22365 msgid "To get the checksums for many files, use L</checksums-out>."
22369 #: ../fish/guestfish-actions.pod:639
22370 msgid "checksum-device"
22374 #: ../fish/guestfish-actions.pod:641
22377 " checksum-device csumtype device\n"
22382 #: ../fish/guestfish-actions.pod:643
22384 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
22385 "device named C<device>. For the types of checksums supported see the L</"
22386 "checksum> command."
22390 #: ../fish/guestfish-actions.pod:647
22391 msgid "checksums-out"
22395 #: ../fish/guestfish-actions.pod:649
22398 " checksums-out csumtype directory (sumsfile|-)\n"
22403 #: ../fish/guestfish-actions.pod:665
22408 #: ../fish/guestfish-actions.pod:667
22411 " chmod mode path\n"
22416 #: ../fish/guestfish-actions.pod:678
22421 #: ../fish/guestfish-actions.pod:680
22424 " chown owner group path\n"
22429 #: ../fish/guestfish-actions.pod:688
22434 #: ../fish/guestfish-actions.pod:690
22437 " command 'arguments ...'\n"
22442 #: ../fish/guestfish-actions.pod:697
22444 "The single parameter is an argv-style list of arguments. The first element "
22445 "is the name of the program to run. Subsequent elements are parameters. The "
22446 "list must be non-empty (ie. must contain a program name). Note that the "
22447 "command runs directly, and is I<not> invoked via the shell (see L</sh>)."
22451 #: ../fish/guestfish-actions.pod:725
22452 msgid "command-lines"
22456 #: ../fish/guestfish-actions.pod:727
22459 " command-lines 'arguments ...'\n"
22464 #: ../fish/guestfish-actions.pod:729
22466 "This is the same as L</command>, but splits the result into a list of lines."
22470 #: ../fish/guestfish-actions.pod:732
22471 msgid "See also: L</sh-lines>"
22475 #: ../fish/guestfish-actions.pod:737
22480 #: ../fish/guestfish-actions.pod:739
22483 " config qemuparam qemuvalue\n"
22488 #: ../fish/guestfish-actions.pod:750
22493 #: ../fish/guestfish-actions.pod:752
22496 " copy-size src dest size\n"
22501 #: ../fish/guestfish-actions.pod:760
22506 #: ../fish/guestfish-actions.pod:762
22514 #: ../fish/guestfish-actions.pod:767
22519 #: ../fish/guestfish-actions.pod:769
22527 #: ../fish/guestfish-actions.pod:774
22532 #: ../fish/guestfish-actions.pod:776
22540 #: ../fish/guestfish-actions.pod:783
22542 "If the destination is a device, it must be as large or larger than the "
22543 "source file or device, otherwise the copy will fail. This command cannot do "
22544 "partial copies (see L</copy-size>)."
22548 #: ../fish/guestfish-actions.pod:787
22553 #: ../fish/guestfish-actions.pod:789
22561 #: ../fish/guestfish-actions.pod:793 ../fish/guestfish-actions.pod:804
22563 "This command is mostly useful for interactive sessions. It is I<not> "
22564 "intended that you try to parse the output string. Use L</statvfs> from "
22569 #: ../fish/guestfish-actions.pod:797
22574 #: ../fish/guestfish-actions.pod:799
22582 #: ../fish/guestfish-actions.pod:808
22587 #: ../fish/guestfish-actions.pod:810
22595 #: ../fish/guestfish-actions.pod:816
22597 "Another way to get the same information is to enable verbose messages with "
22598 "L</set-verbose> or by setting the environment variable C<LIBGUESTFS_DEBUG=1> "
22599 "before running the program."
22603 #: ../fish/guestfish-actions.pod:821
22608 #: ../fish/guestfish-actions.pod:823
22611 " download remotefilename (filename|-)\n"
22616 #: ../fish/guestfish-actions.pod:830
22617 msgid "See also L</upload>, L</cat>."
22621 #: ../fish/guestfish-actions.pod:834
22622 msgid "download-offset"
22626 #: ../fish/guestfish-actions.pod:836
22629 " download-offset remotefilename (filename|-) offset size\n"
22634 #: ../fish/guestfish-actions.pod:844
22636 "Note that there is no limit on the amount of data that can be downloaded "
22637 "with this call, unlike with L</pread>, and this call always reads the full "
22638 "amount unless an error occurs."
22642 #: ../fish/guestfish-actions.pod:849
22643 msgid "See also L</download>, L</pread>."
22647 #: ../fish/guestfish-actions.pod:853
22648 msgid "drop-caches"
22652 #: ../fish/guestfish-actions.pod:855
22655 " drop-caches whattodrop\n"
22660 #: ../fish/guestfish-actions.pod:867
22665 #: ../fish/guestfish-actions.pod:869
22673 #: ../fish/guestfish-actions.pod:881
22678 #: ../fish/guestfish-actions.pod:883
22681 " e2fsck-f device\n"
22686 #: ../fish/guestfish-actions.pod:889
22688 "This command is only needed because of L</resize2fs> (q.v.). Normally you "
22689 "should use L</fsck>."
22693 #: ../fish/guestfish-actions.pod:892
22694 msgid "echo-daemon"
22698 #: ../fish/guestfish-actions.pod:894
22701 " echo-daemon 'words ...'\n"
22706 #: ../fish/guestfish-actions.pod:901
22707 msgid "See also L</ping-daemon>."
22711 #: ../fish/guestfish-actions.pod:903
22716 #: ../fish/guestfish-actions.pod:905
22719 " egrep regex path\n"
22724 #: ../fish/guestfish-actions.pod:913
22729 #: ../fish/guestfish-actions.pod:915
22732 " egrepi regex path\n"
22737 #: ../fish/guestfish-actions.pod:923
22742 #: ../fish/guestfish-actions.pod:925
22745 " equal file1 file2\n"
22750 #: ../fish/guestfish-actions.pod:932
22755 #: ../fish/guestfish-actions.pod:934
22763 #: ../fish/guestfish-actions.pod:939
22764 msgid "See also L</is-file>, L</is-dir>, L</stat>."
22768 #: ../fish/guestfish-actions.pod:941
22773 #: ../fish/guestfish-actions.pod:943
22776 " fallocate path len\n"
22781 #: ../fish/guestfish-actions.pod:960
22782 msgid "fallocate64"
22786 #: ../fish/guestfish-actions.pod:962
22789 " fallocate64 path len\n"
22794 #: ../fish/guestfish-actions.pod:968
22796 "Note that this call allocates disk blocks for the file. To create a sparse "
22797 "file use L</truncate-size> instead."
22801 #: ../fish/guestfish-actions.pod:971
22803 "The deprecated call L</fallocate> does the same, but owing to an oversight "
22804 "it only allowed 30 bit lengths to be specified, effectively limiting the "
22805 "maximum size of files created through that call to 1GB."
22809 #: ../fish/guestfish-actions.pod:980
22814 #: ../fish/guestfish-actions.pod:982
22817 " fgrep pattern path\n"
22822 #: ../fish/guestfish-actions.pod:990
22827 #: ../fish/guestfish-actions.pod:992
22830 " fgrepi pattern path\n"
22835 #: ../fish/guestfish-actions.pod:1000
22840 #: ../fish/guestfish-actions.pod:1002
22848 #: ../fish/guestfish-actions.pod:1014
22850 "This command can also be used on C</dev/> devices (and partitions, LV "
22851 "names). You can for example use this to determine if a device contains a "
22852 "filesystem, although it's usually better to use L</vfs-type>."
22856 #: ../fish/guestfish-actions.pod:1024
22857 msgid "file-architecture"
22861 #: ../fish/guestfish-actions.pod:1026
22864 " file-architecture filename\n"
22869 #: ../fish/guestfish-actions.pod:1129
22874 #: ../fish/guestfish-actions.pod:1131
22882 #: ../fish/guestfish-actions.pod:1135
22884 "To get other stats about a file, use L</stat>, L</lstat>, L</is-dir>, L</is-"
22885 "file> etc. To get the size of block devices, use L</blockdev-getsize64>."
22889 #: ../fish/guestfish-actions.pod:1139
22894 #: ../fish/guestfish-actions.pod:1141
22897 " fill c len path\n"
22902 #: ../fish/guestfish-actions.pod:1147
22904 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
22905 "L</truncate-size>. To create a file with a pattern of repeating bytes use "
22906 "L</fill-pattern>."
22910 #: ../fish/guestfish-actions.pod:1152
22911 msgid "fill-pattern"
22915 #: ../fish/guestfish-actions.pod:1154
22918 " fill-pattern pattern len path\n"
22923 #: ../fish/guestfish-actions.pod:1156
22925 "This function is like L</fill> except that it creates a new file of length "
22926 "C<len> containing the repeating pattern of bytes in C<pattern>. The pattern "
22927 "is truncated if necessary to ensure the length of the file is exactly C<len> "
22932 #: ../fish/guestfish-actions.pod:1161
22937 #: ../fish/guestfish-actions.pod:1163
22940 " find directory\n"
22945 #: ../fish/guestfish-actions.pod:1177
22946 msgid "then the returned list from L</find> C</tmp> would be 4 elements:"
22950 #: ../fish/guestfish-actions.pod:1190
22951 msgid "See also L</find0>."
22955 #: ../fish/guestfish-actions.pod:1195
22960 #: ../fish/guestfish-actions.pod:1197
22963 " find0 directory (files|-)\n"
22968 #: ../fish/guestfish-actions.pod:1203
22970 "This command works the same way as L</find> with the following exceptions:"
22974 #: ../fish/guestfish-actions.pod:1230
22975 msgid "findfs-label"
22979 #: ../fish/guestfish-actions.pod:1232
22982 " findfs-label label\n"
22987 #: ../fish/guestfish-actions.pod:1238
22988 msgid "To find the label of a filesystem, use L</vfs-label>."
22992 #: ../fish/guestfish-actions.pod:1240
22993 msgid "findfs-uuid"
22997 #: ../fish/guestfish-actions.pod:1242
23000 " findfs-uuid uuid\n"
23005 #: ../fish/guestfish-actions.pod:1248
23006 msgid "To find the UUID of a filesystem, use L</vfs-uuid>."
23010 #: ../fish/guestfish-actions.pod:1250
23015 #: ../fish/guestfish-actions.pod:1252
23018 " fsck fstype device\n"
23023 #: ../fish/guestfish-actions.pod:1282
23028 #: ../fish/guestfish-actions.pod:1284
23036 #: ../fish/guestfish-actions.pod:1291
23037 msgid "get-attach-method"
23041 #: ../fish/guestfish-actions.pod:1293
23044 " get-attach-method\n"
23049 #: ../fish/guestfish-actions.pod:1295
23050 msgid "Return the current attach method. See L</set-attach-method>."
23054 #: ../fish/guestfish-actions.pod:1297
23055 msgid "get-autosync"
23059 #: ../fish/guestfish-actions.pod:1299
23067 #: ../fish/guestfish-actions.pod:1303
23072 #: ../fish/guestfish-actions.pod:1305
23080 #: ../fish/guestfish-actions.pod:1309
23081 msgid "get-e2label"
23085 #: ../fish/guestfish-actions.pod:1311
23088 " get-e2label device\n"
23093 #: ../fish/guestfish-actions.pod:1323
23098 #: ../fish/guestfish-actions.pod:1325
23101 " get-e2uuid device\n"
23106 #: ../fish/guestfish-actions.pod:1337
23107 msgid "get-memsize"
23111 #: ../fish/guestfish-actions.pod:1339
23119 #: ../fish/guestfish-actions.pod:1344
23121 "If L</set-memsize> was not called on this handle, and if "
23122 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
23123 "value for memsize."
23127 #: ../fish/guestfish-actions.pod:1351
23128 msgid "get-network"
23132 #: ../fish/guestfish-actions.pod:1353
23140 #: ../fish/guestfish-actions.pod:1357
23145 #: ../fish/guestfish-actions.pod:1359
23153 #: ../fish/guestfish-actions.pod:1366
23158 #: ../fish/guestfish-actions.pod:1368
23163 #: ../fish/guestfish-actions.pod:1370
23171 #: ../fish/guestfish-actions.pod:1377
23176 #: ../fish/guestfish-actions.pod:1379
23184 #: ../fish/guestfish-actions.pod:1386
23185 msgid "get-recovery-proc"
23189 #: ../fish/guestfish-actions.pod:1388
23192 " get-recovery-proc\n"
23197 #: ../fish/guestfish-actions.pod:1392
23198 msgid "get-selinux"
23202 #: ../fish/guestfish-actions.pod:1394
23210 #: ../fish/guestfish-actions.pod:1396
23212 "This returns the current setting of the selinux flag which is passed to the "
23213 "appliance at boot time. See L</set-selinux>."
23217 #: ../fish/guestfish-actions.pod:1402
23222 #: ../fish/guestfish-actions.pod:1404
23230 #: ../fish/guestfish-actions.pod:1411
23235 #: ../fish/guestfish-actions.pod:1413
23243 #: ../fish/guestfish-actions.pod:1417
23248 #: ../fish/guestfish-actions.pod:1419
23256 #: ../fish/guestfish-actions.pod:1421
23258 "Return the current umask. By default the umask is C<022> unless it has been "
23259 "set by calling L</umask>."
23263 #: ../fish/guestfish-actions.pod:1424
23264 msgid "get-verbose"
23268 #: ../fish/guestfish-actions.pod:1426
23276 #: ../fish/guestfish-actions.pod:1430
23281 #: ../fish/guestfish-actions.pod:1432
23289 #: ../fish/guestfish-actions.pod:1436
23290 msgid "See the documentation about SELINUX in L<guestfs(3)>, and L</setcon>"
23294 #: ../fish/guestfish-actions.pod:1439
23299 #: ../fish/guestfish-actions.pod:1441
23302 " getxattr path name\n"
23307 #: ../fish/guestfish-actions.pod:1443
23309 "Get a single extended attribute from file C<path> named C<name>. This call "
23310 "follows symlinks. If you want to lookup an extended attribute for the "
23311 "symlink itself, use L</lgetxattr>."
23315 #: ../fish/guestfish-actions.pod:1447 ../fish/guestfish-actions.pod:2445
23317 "Normally it is better to get all extended attributes from a file in one go "
23318 "by calling L</getxattrs>. However some Linux filesystem implementations are "
23319 "buggy and do not provide a way to list out attributes. For these "
23320 "filesystems (notably ntfs-3g) you have to know the names of the extended "
23321 "attributes you want in advance and call this function."
23325 #: ../fish/guestfish-actions.pod:1457
23326 msgid "See also: L</getxattrs>, L</lgetxattr>, L<attr(5)>."
23330 #: ../fish/guestfish-actions.pod:1459
23335 #: ../fish/guestfish-actions.pod:1461
23338 " getxattrs path\n"
23343 #: ../fish/guestfish-actions.pod:1469
23344 msgid "See also: L</lgetxattrs>, L<attr(5)>."
23348 #: ../fish/guestfish-actions.pod:1471
23349 msgid "glob-expand"
23353 #: ../fish/guestfish-actions.pod:1473
23356 " glob-expand pattern\n"
23361 #: ../fish/guestfish-actions.pod:1486
23366 #: ../fish/guestfish-actions.pod:1488
23369 " grep regex path\n"
23374 #: ../fish/guestfish-actions.pod:1496
23379 #: ../fish/guestfish-actions.pod:1498
23382 " grepi regex path\n"
23387 #: ../fish/guestfish-actions.pod:1506
23388 msgid "grub-install"
23392 #: ../fish/guestfish-actions.pod:1508
23395 " grub-install root device\n"
23400 #: ../fish/guestfish-actions.pod:1524
23405 #: ../fish/guestfish-actions.pod:1526
23413 #: ../fish/guestfish-actions.pod:1534
23418 #: ../fish/guestfish-actions.pod:1536
23421 " head-n nrlines path\n"
23426 #: ../fish/guestfish-actions.pod:1549
23431 #: ../fish/guestfish-actions.pod:1551
23439 #: ../fish/guestfish-actions.pod:1559
23444 #: ../fish/guestfish-actions.pod:1561
23447 " initrd-cat initrdpath filename\n"
23452 #: ../fish/guestfish-actions.pod:1573
23453 msgid "See also L</initrd-list>."
23457 #: ../fish/guestfish-actions.pod:1578
23458 msgid "initrd-list"
23462 #: ../fish/guestfish-actions.pod:1580
23465 " initrd-list path\n"
23470 #: ../fish/guestfish-actions.pod:1592
23471 msgid "inotify-add-watch"
23475 #: ../fish/guestfish-actions.pod:1594
23478 " inotify-add-watch path mask\n"
23483 #: ../fish/guestfish-actions.pod:1606
23484 msgid "inotify-close"
23488 #: ../fish/guestfish-actions.pod:1608
23496 #: ../fish/guestfish-actions.pod:1614
23497 msgid "inotify-files"
23501 #: ../fish/guestfish-actions.pod:1616
23509 #: ../fish/guestfish-actions.pod:1618
23511 "This function is a helpful wrapper around L</inotify-read> which just "
23512 "returns a list of pathnames of objects that were touched. The returned "
23513 "pathnames are sorted and deduplicated."
23517 #: ../fish/guestfish-actions.pod:1622
23518 msgid "inotify-init"
23522 #: ../fish/guestfish-actions.pod:1624
23525 " inotify-init maxevents\n"
23530 #: ../fish/guestfish-actions.pod:1630
23532 "C<maxevents> is the maximum number of events which will be queued up between "
23533 "calls to L</inotify-read> or L</inotify-files>. If this is passed as C<0>, "
23534 "then the kernel (or previously set) default is used. For Linux 2.6.29 the "
23535 "default was 16384 events. Beyond this limit, the kernel throws away events, "
23536 "but records the fact that it threw them away by setting a flag "
23537 "C<IN_Q_OVERFLOW> in the returned structure list (see L</inotify-read>)."
23541 #: ../fish/guestfish-actions.pod:1640
23543 "Before any events are generated, you have to add some watches to the "
23544 "internal watch list. See: L</inotify-add-watch>, L</inotify-rm-watch> and "
23545 "L</inotify-watch-all>."
23549 #: ../fish/guestfish-actions.pod:1646
23551 "Queued up events should be read periodically by calling L</inotify-read> (or "
23552 "L</inotify-files> which is just a helpful wrapper around L</inotify-read>). "
23553 "If you don't read the events out often enough then you risk the internal "
23554 "queue overflowing."
23558 #: ../fish/guestfish-actions.pod:1653
23560 "The handle should be closed after use by calling L</inotify-close>. This "
23561 "also removes any watches automatically."
23565 #: ../fish/guestfish-actions.pod:1662
23566 msgid "inotify-read"
23570 #: ../fish/guestfish-actions.pod:1664
23578 #: ../fish/guestfish-actions.pod:1677
23579 msgid "inotify-rm-watch"
23583 #: ../fish/guestfish-actions.pod:1679
23586 " inotify-rm-watch wd\n"
23591 #: ../fish/guestfish-actions.pod:1681
23592 msgid "Remove a previously defined inotify watch. See L</inotify-add-watch>."
23596 #: ../fish/guestfish-actions.pod:1684
23597 msgid "inspect-get-arch"
23601 #: ../fish/guestfish-actions.pod:1686
23604 " inspect-get-arch root\n"
23609 #: ../fish/guestfish-actions.pod:1688 ../fish/guestfish-actions.pod:1704
23610 #: ../fish/guestfish-actions.pod:1782 ../fish/guestfish-actions.pod:1818
23611 #: ../fish/guestfish-actions.pod:1836 ../fish/guestfish-actions.pod:1870
23612 #: ../fish/guestfish-actions.pod:1885 ../fish/guestfish-actions.pod:1906
23613 #: ../fish/guestfish-actions.pod:1921 ../fish/guestfish-actions.pod:1954
23614 #: ../fish/guestfish-actions.pod:1976 ../fish/guestfish-actions.pod:2000
23615 #: ../fish/guestfish-actions.pod:2017 ../fish/guestfish-actions.pod:2060
23616 #: ../fish/guestfish-actions.pod:2095 ../fish/guestfish-actions.pod:2111
23617 #: ../fish/guestfish-actions.pod:2127 ../fish/guestfish-actions.pod:2140
23618 #: ../fish/guestfish-actions.pod:2153 ../fish/guestfish-actions.pod:2168
23620 "This function should only be called with a root device string as returned by "
23625 #: ../fish/guestfish-actions.pod:1691
23627 "This returns the architecture of the inspected operating system. The "
23628 "possible return values are listed under L</file-architecture>."
23632 #: ../fish/guestfish-actions.pod:1700
23633 msgid "inspect-get-distro"
23637 #: ../fish/guestfish-actions.pod:1702
23640 " inspect-get-distro root\n"
23645 #: ../fish/guestfish-actions.pod:1778
23646 msgid "inspect-get-drive-mappings"
23650 #: ../fish/guestfish-actions.pod:1780
23653 " inspect-get-drive-mappings root\n"
23658 #: ../fish/guestfish-actions.pod:1810
23660 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
23661 "get-mountpoints>, L</inspect-get-filesystems>."
23665 #: ../fish/guestfish-actions.pod:1814
23666 msgid "inspect-get-filesystems"
23670 #: ../fish/guestfish-actions.pod:1816
23673 " inspect-get-filesystems root\n"
23678 #: ../fish/guestfish-actions.pod:1829
23680 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
23681 "get-mountpoints>."
23685 #: ../fish/guestfish-actions.pod:1832
23686 msgid "inspect-get-format"
23690 #: ../fish/guestfish-actions.pod:1834
23693 " inspect-get-format root\n"
23698 #: ../fish/guestfish-actions.pod:1866
23699 msgid "inspect-get-hostname"
23703 #: ../fish/guestfish-actions.pod:1868
23706 " inspect-get-hostname root\n"
23711 #: ../fish/guestfish-actions.pod:1881
23712 msgid "inspect-get-major-version"
23716 #: ../fish/guestfish-actions.pod:1883
23719 " inspect-get-major-version root\n"
23724 #: ../fish/guestfish-actions.pod:1902
23725 msgid "inspect-get-minor-version"
23729 #: ../fish/guestfish-actions.pod:1904
23732 " inspect-get-minor-version root\n"
23737 #: ../fish/guestfish-actions.pod:1914
23739 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
23740 "get-major-version>."
23744 #: ../fish/guestfish-actions.pod:1917
23745 msgid "inspect-get-mountpoints"
23749 #: ../fish/guestfish-actions.pod:1919
23752 " inspect-get-mountpoints root\n"
23757 #: ../fish/guestfish-actions.pod:1941
23759 "For operating systems like Windows which still use drive letters, this call "
23760 "will only return an entry for the first drive \"mounted on\" C</>. For "
23761 "information about the mapping of drive letters to partitions, see L</inspect-"
23762 "get-drive-mappings>."
23766 #: ../fish/guestfish-actions.pod:1947
23768 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
23769 "get-filesystems>."
23773 #: ../fish/guestfish-actions.pod:1950
23774 msgid "inspect-get-package-format"
23778 #: ../fish/guestfish-actions.pod:1952
23781 " inspect-get-package-format root\n"
23786 #: ../fish/guestfish-actions.pod:1957
23788 "This function and L</inspect-get-package-management> return the package "
23789 "format and package management tool used by the inspected operating system. "
23790 "For example for Fedora these functions would return C<rpm> (package format) "
23791 "and C<yum> (package management)."
23795 #: ../fish/guestfish-actions.pod:1972
23796 msgid "inspect-get-package-management"
23800 #: ../fish/guestfish-actions.pod:1974
23803 " inspect-get-package-management root\n"
23808 #: ../fish/guestfish-actions.pod:1979
23810 "L</inspect-get-package-format> and this function return the package format "
23811 "and package management tool used by the inspected operating system. For "
23812 "example for Fedora these functions would return C<rpm> (package format) and "
23813 "C<yum> (package management)."
23817 #: ../fish/guestfish-actions.pod:1996
23818 msgid "inspect-get-product-name"
23822 #: ../fish/guestfish-actions.pod:1998
23825 " inspect-get-product-name root\n"
23830 #: ../fish/guestfish-actions.pod:2013
23831 msgid "inspect-get-product-variant"
23835 #: ../fish/guestfish-actions.pod:2015
23838 " inspect-get-product-variant root\n"
23843 #: ../fish/guestfish-actions.pod:2039
23845 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
23846 "get-product-name>, L</inspect-get-major-version>."
23850 #: ../fish/guestfish-actions.pod:2043
23851 msgid "inspect-get-roots"
23855 #: ../fish/guestfish-actions.pod:2045
23858 " inspect-get-roots\n"
23863 #: ../fish/guestfish-actions.pod:2047
23865 "This function is a convenient way to get the list of root devices, as "
23866 "returned from a previous call to L</inspect-os>, but without redoing the "
23867 "whole inspection process."
23871 #: ../fish/guestfish-actions.pod:2051
23873 "This returns an empty list if either no root devices were found or the "
23874 "caller has not called L</inspect-os>."
23878 #: ../fish/guestfish-actions.pod:2056
23879 msgid "inspect-get-type"
23883 #: ../fish/guestfish-actions.pod:2058
23886 " inspect-get-type root\n"
23891 #: ../fish/guestfish-actions.pod:2091
23892 msgid "inspect-get-windows-current-control-set"
23896 #: ../fish/guestfish-actions.pod:2093
23899 " inspect-get-windows-current-control-set root\n"
23904 #: ../fish/guestfish-actions.pod:2107
23905 msgid "inspect-get-windows-systemroot"
23909 #: ../fish/guestfish-actions.pod:2109
23912 " inspect-get-windows-systemroot root\n"
23917 #: ../fish/guestfish-actions.pod:2123
23918 msgid "inspect-is-live"
23922 #: ../fish/guestfish-actions.pod:2125
23925 " inspect-is-live root\n"
23930 #: ../fish/guestfish-actions.pod:2130
23932 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
23933 "then this returns true if a live image was detected on the disk."
23937 #: ../fish/guestfish-actions.pod:2136
23938 msgid "inspect-is-multipart"
23942 #: ../fish/guestfish-actions.pod:2138
23945 " inspect-is-multipart root\n"
23950 #: ../fish/guestfish-actions.pod:2143
23952 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
23953 "then this returns true if the disk is part of a set."
23957 #: ../fish/guestfish-actions.pod:2149
23958 msgid "inspect-is-netinst"
23962 #: ../fish/guestfish-actions.pod:2151
23965 " inspect-is-netinst root\n"
23970 #: ../fish/guestfish-actions.pod:2156
23972 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
23973 "then this returns true if the disk is a network installer, ie. not a self-"
23974 "contained install CD but one which is likely to require network access to "
23975 "complete the install."
23979 #: ../fish/guestfish-actions.pod:2164
23980 msgid "inspect-list-applications"
23984 #: ../fish/guestfish-actions.pod:2166
23987 " inspect-list-applications root\n"
23992 #: ../fish/guestfish-actions.pod:2173
23994 "I<Note:> This call works differently from other parts of the inspection "
23995 "API. You have to call L</inspect-os>, then L</inspect-get-mountpoints>, "
23996 "then mount up the disks, before calling this. Listing applications is a "
23997 "significantly more difficult operation which requires access to the full "
23998 "filesystem. Also note that unlike the other L</inspect-get-*> calls which "
23999 "are just returning data cached in the libguestfs handle, this call actually "
24000 "reads parts of the mounted filesystems during the call."
24004 #: ../fish/guestfish-actions.pod:2263
24009 #: ../fish/guestfish-actions.pod:2265
24017 #: ../fish/guestfish-actions.pod:2280
24019 "You can pass the root string(s) returned to other L</inspect-get-*> "
24020 "functions in order to query further information about each operating system, "
24021 "such as the name and version."
24025 #: ../fish/guestfish-actions.pod:2285
24027 "This function uses other libguestfs features such as L</mount-ro> and L</"
24028 "umount-all> in order to mount and unmount filesystems and look at the "
24029 "contents. This should be called with no disks currently mounted. The "
24030 "function may also use Augeas, so any existing Augeas handle will be closed."
24034 #: ../fish/guestfish-actions.pod:2297 ../fish/guestfish-actions.pod:2473
24035 #: ../fish/guestfish-actions.pod:2519
24036 msgid "See also L</list-filesystems>."
24040 #: ../fish/guestfish-actions.pod:2299
24041 msgid "is-blockdev"
24045 #: ../fish/guestfish-actions.pod:2301
24048 " is-blockdev path\n"
24053 #: ../fish/guestfish-actions.pod:2306 ../fish/guestfish-actions.pod:2324
24054 #: ../fish/guestfish-actions.pod:2343 ../fish/guestfish-actions.pod:2352
24055 #: ../fish/guestfish-actions.pod:2362 ../fish/guestfish-actions.pod:2396
24056 #: ../fish/guestfish-actions.pod:2405
24057 msgid "See also L</stat>."
24061 #: ../fish/guestfish-actions.pod:2308
24066 #: ../fish/guestfish-actions.pod:2310
24074 #: ../fish/guestfish-actions.pod:2317
24079 #: ../fish/guestfish-actions.pod:2319
24082 " is-chardev path\n"
24087 #: ../fish/guestfish-actions.pod:2326
24092 #: ../fish/guestfish-actions.pod:2328
24100 #: ../fish/guestfish-actions.pod:2335
24105 #: ../fish/guestfish-actions.pod:2337
24113 #: ../fish/guestfish-actions.pod:2345
24118 #: ../fish/guestfish-actions.pod:2347
24126 #: ../fish/guestfish-actions.pod:2354
24131 #: ../fish/guestfish-actions.pod:2356
24139 #: ../fish/guestfish-actions.pod:2364
24140 msgid "is-launching"
24144 #: ../fish/guestfish-actions.pod:2366
24152 #: ../fish/guestfish-actions.pod:2373
24157 #: ../fish/guestfish-actions.pod:2375
24165 #: ../fish/guestfish-actions.pod:2380
24170 #: ../fish/guestfish-actions.pod:2382
24178 #: ../fish/guestfish-actions.pod:2389
24183 #: ../fish/guestfish-actions.pod:2391
24186 " is-socket path\n"
24191 #: ../fish/guestfish-actions.pod:2398
24196 #: ../fish/guestfish-actions.pod:2400
24199 " is-symlink path\n"
24204 #: ../fish/guestfish-actions.pod:2407
24205 msgid "kill-subprocess"
24209 #: ../fish/guestfish-actions.pod:2409
24212 " kill-subprocess\n"
24217 #: ../fish/guestfish-actions.pod:2413
24222 #: ../fish/guestfish-actions.pod:2415
24227 #: ../fish/guestfish-actions.pod:2417
24235 #: ../fish/guestfish-actions.pod:2425
24240 #: ../fish/guestfish-actions.pod:2427
24243 " lchown owner group path\n"
24248 #: ../fish/guestfish-actions.pod:2429
24250 "Change the file owner to C<owner> and group to C<group>. This is like L</"
24251 "chown> but if C<path> is a symlink then the link itself is changed, not the "
24256 #: ../fish/guestfish-actions.pod:2437
24261 #: ../fish/guestfish-actions.pod:2439
24264 " lgetxattr path name\n"
24269 #: ../fish/guestfish-actions.pod:2455
24270 msgid "See also: L</lgetxattrs>, L</getxattr>, L<attr(5)>."
24274 #: ../fish/guestfish-actions.pod:2457
24279 #: ../fish/guestfish-actions.pod:2459
24282 " lgetxattrs path\n"
24287 #: ../fish/guestfish-actions.pod:2461
24289 "This is the same as L</getxattrs>, but if C<path> is a symbolic link, then "
24290 "it returns the extended attributes of the link itself."
24294 #: ../fish/guestfish-actions.pod:2465
24295 msgid "list-devices"
24299 #: ../fish/guestfish-actions.pod:2467
24307 #: ../fish/guestfish-actions.pod:2475
24308 msgid "list-filesystems"
24312 #: ../fish/guestfish-actions.pod:2477
24315 " list-filesystems\n"
24320 #: ../fish/guestfish-actions.pod:2496
24322 "This command runs other libguestfs commands, which might include L</mount> "
24323 "and L</umount>, and therefore you should use this soon after launch and only "
24324 "when nothing is mounted."
24328 #: ../fish/guestfish-actions.pod:2500
24330 "Not all of the filesystems returned will be mountable. In particular, swap "
24331 "partitions are returned in the list. Also this command does not check that "
24332 "each filesystem found is valid and mountable, and some filesystems might be "
24333 "mountable but require special options. Filesystems may not all belong to a "
24334 "single logical operating system (use L</inspect-os> to look for OSes)."
24338 #: ../fish/guestfish-actions.pod:2508
24339 msgid "list-partitions"
24343 #: ../fish/guestfish-actions.pod:2510
24346 " list-partitions\n"
24351 #: ../fish/guestfish-actions.pod:2516
24353 "This does not return logical volumes. For that you will need to call L</"
24358 #: ../fish/guestfish-actions.pod:2521
24363 #: ../fish/guestfish-actions.pod:2523
24371 #: ../fish/guestfish-actions.pod:2531
24376 #: ../fish/guestfish-actions.pod:2533
24379 " ln target linkname\n"
24384 #: ../fish/guestfish-actions.pod:2537
24389 #: ../fish/guestfish-actions.pod:2539
24392 " ln-f target linkname\n"
24397 #: ../fish/guestfish-actions.pod:2544
24402 #: ../fish/guestfish-actions.pod:2546
24405 " ln-s target linkname\n"
24410 #: ../fish/guestfish-actions.pod:2550
24415 #: ../fish/guestfish-actions.pod:2552
24418 " ln-sf target linkname\n"
24423 #: ../fish/guestfish-actions.pod:2557
24424 msgid "lremovexattr"
24428 #: ../fish/guestfish-actions.pod:2559
24431 " lremovexattr xattr path\n"
24436 #: ../fish/guestfish-actions.pod:2561
24438 "This is the same as L</removexattr>, but if C<path> is a symbolic link, then "
24439 "it removes an extended attribute of the link itself."
24443 #: ../fish/guestfish-actions.pod:2565
24448 #: ../fish/guestfish-actions.pod:2567
24456 #: ../fish/guestfish-actions.pod:2573
24458 "This command is mostly useful for interactive sessions. Programs should "
24459 "probably use L</readdir> instead."
24463 #: ../fish/guestfish-actions.pod:2576
24468 #: ../fish/guestfish-actions.pod:2578
24471 " lsetxattr xattr val vallen path\n"
24476 #: ../fish/guestfish-actions.pod:2580
24478 "This is the same as L</setxattr>, but if C<path> is a symbolic link, then it "
24479 "sets an extended attribute of the link itself."
24483 #: ../fish/guestfish-actions.pod:2584
24488 #: ../fish/guestfish-actions.pod:2586
24496 #: ../fish/guestfish-actions.pod:2590
24498 "This is the same as L</stat> except that if C<path> is a symbolic link, then "
24499 "the link is stat-ed, not the file it refers to."
24503 #: ../fish/guestfish-actions.pod:2596
24508 #: ../fish/guestfish-actions.pod:2598
24511 " lstatlist path 'names ...'\n"
24516 #: ../fish/guestfish-actions.pod:2600
24518 "This call allows you to perform the L</lstat> operation on multiple files, "
24519 "where all files are in the directory C<path>. C<names> is the list of files "
24520 "from this directory."
24524 #: ../fish/guestfish-actions.pod:2609
24526 "This call is intended for programs that want to efficiently list a directory "
24527 "contents without making many round-trips. See also L</lxattrlist> for a "
24528 "similarly efficient call for getting extended attributes. Very long "
24529 "directory listings might cause the protocol message size to be exceeded, "
24530 "causing this call to fail. The caller must split up such requests into "
24531 "smaller groups of names."
24535 #: ../fish/guestfish-actions.pod:2617
24536 msgid "luks-add-key"
24540 #: ../fish/guestfish-actions.pod:2619
24543 " luks-add-key device keyslot\n"
24548 #: ../fish/guestfish-actions.pod:2626
24550 "Note that if C<keyslot> already contains a key, then this command will "
24551 "fail. You have to use L</luks-kill-slot> first to remove that key."
24555 #: ../fish/guestfish-actions.pod:2630 ../fish/guestfish-actions.pod:2652
24556 #: ../fish/guestfish-actions.pod:2665 ../fish/guestfish-actions.pod:2679
24557 #: ../fish/guestfish-actions.pod:2702 ../fish/guestfish-actions.pod:2712
24559 "This command has one or more key or passphrase parameters. Guestfish will "
24560 "prompt for these separately."
24564 #: ../fish/guestfish-actions.pod:2633
24569 #: ../fish/guestfish-actions.pod:2635
24572 " luks-close device\n"
24577 #: ../fish/guestfish-actions.pod:2637
24579 "This closes a LUKS device that was created earlier by L</luks-open> or L</"
24580 "luks-open-ro>. The C<device> parameter must be the name of the LUKS mapping "
24581 "device (ie. C</dev/mapper/mapname>) and I<not> the name of the underlying "
24586 #: ../fish/guestfish-actions.pod:2643
24587 msgid "luks-format"
24591 #: ../fish/guestfish-actions.pod:2645
24594 " luks-format device keyslot\n"
24599 #: ../fish/guestfish-actions.pod:2658
24600 msgid "luks-format-cipher"
24604 #: ../fish/guestfish-actions.pod:2660
24607 " luks-format-cipher device keyslot cipher\n"
24612 #: ../fish/guestfish-actions.pod:2662
24614 "This command is the same as L</luks-format> but it also allows you to set "
24615 "the C<cipher> used."
24619 #: ../fish/guestfish-actions.pod:2671
24620 msgid "luks-kill-slot"
24624 #: ../fish/guestfish-actions.pod:2673
24627 " luks-kill-slot device keyslot\n"
24632 #: ../fish/guestfish-actions.pod:2682
24637 #: ../fish/guestfish-actions.pod:2684
24640 " luks-open device mapname\n"
24645 #: ../fish/guestfish-actions.pod:2698
24647 "If this block device contains LVM volume groups, then calling L</vgscan> "
24648 "followed by L</vg-activate-all> will make them visible."
24652 #: ../fish/guestfish-actions.pod:2705
24653 msgid "luks-open-ro"
24657 #: ../fish/guestfish-actions.pod:2707
24660 " luks-open-ro device mapname\n"
24665 #: ../fish/guestfish-actions.pod:2709
24667 "This is the same as L</luks-open> except that a read-only mapping is created."
24671 #: ../fish/guestfish-actions.pod:2715
24676 #: ../fish/guestfish-actions.pod:2717
24679 " lvcreate logvol volgroup mbytes\n"
24684 #: ../fish/guestfish-actions.pod:2722
24685 msgid "lvm-canonical-lv-name"
24689 #: ../fish/guestfish-actions.pod:2724
24692 " lvm-canonical-lv-name lvname\n"
24697 #: ../fish/guestfish-actions.pod:2733
24698 msgid "See also L</is-lv>."
24702 #: ../fish/guestfish-actions.pod:2735
24703 msgid "lvm-clear-filter"
24707 #: ../fish/guestfish-actions.pod:2737
24710 " lvm-clear-filter\n"
24715 #: ../fish/guestfish-actions.pod:2739
24717 "This undoes the effect of L</lvm-set-filter>. LVM will be able to see every "
24722 #: ../fish/guestfish-actions.pod:2745
24723 msgid "lvm-remove-all"
24727 #: ../fish/guestfish-actions.pod:2747
24730 " lvm-remove-all\n"
24735 #: ../fish/guestfish-actions.pod:2755
24736 msgid "lvm-set-filter"
24740 #: ../fish/guestfish-actions.pod:2757
24743 " lvm-set-filter 'devices ...'\n"
24748 #: ../fish/guestfish-actions.pod:2782
24753 #: ../fish/guestfish-actions.pod:2784
24756 " lvremove device\n"
24761 #: ../fish/guestfish-actions.pod:2792
24766 #: ../fish/guestfish-actions.pod:2794
24769 " lvrename logvol newlogvol\n"
24774 #: ../fish/guestfish-actions.pod:2798
24779 #: ../fish/guestfish-actions.pod:2800
24782 " lvresize device mbytes\n"
24787 #: ../fish/guestfish-actions.pod:2806
24788 msgid "lvresize-free"
24792 #: ../fish/guestfish-actions.pod:2808
24795 " lvresize-free lv percent\n"
24800 #: ../fish/guestfish-actions.pod:2816
24805 #: ../fish/guestfish-actions.pod:2818
24813 #: ../fish/guestfish-actions.pod:2826
24814 msgid "See also L</lvs-full>, L</list-filesystems>."
24818 #: ../fish/guestfish-actions.pod:2828
24823 #: ../fish/guestfish-actions.pod:2830
24831 #: ../fish/guestfish-actions.pod:2835
24836 #: ../fish/guestfish-actions.pod:2837
24844 #: ../fish/guestfish-actions.pod:2841
24849 #: ../fish/guestfish-actions.pod:2843
24852 " lxattrlist path 'names ...'\n"
24857 #: ../fish/guestfish-actions.pod:2859
24859 "This call is intended for programs that want to efficiently list a directory "
24860 "contents without making many round-trips. See also L</lstatlist> for a "
24861 "similarly efficient call for getting standard stats. Very long directory "
24862 "listings might cause the protocol message size to be exceeded, causing this "
24863 "call to fail. The caller must split up such requests into smaller groups of "
24868 #: ../fish/guestfish-actions.pod:2867
24873 #: ../fish/guestfish-actions.pod:2869
24881 #: ../fish/guestfish-actions.pod:2873
24886 #: ../fish/guestfish-actions.pod:2875
24889 " mkdir-mode path mode\n"
24894 #: ../fish/guestfish-actions.pod:2884
24895 msgid "See also L</mkdir>, L</umask>"
24899 #: ../fish/guestfish-actions.pod:2886
24904 #: ../fish/guestfish-actions.pod:2888
24912 #: ../fish/guestfish-actions.pod:2893
24917 #: ../fish/guestfish-actions.pod:2895
24920 " mkdtemp template\n"
24925 #: ../fish/guestfish-actions.pod:2916
24930 #: ../fish/guestfish-actions.pod:2918
24933 " mke2fs-J fstype blocksize device journal\n"
24938 #: ../fish/guestfish-actions.pod:2926
24939 msgid "See also L</mke2journal>."
24943 #: ../fish/guestfish-actions.pod:2928
24948 #: ../fish/guestfish-actions.pod:2930
24951 " mke2fs-JL fstype blocksize device label\n"
24956 #: ../fish/guestfish-actions.pod:2935
24957 msgid "See also L</mke2journal-L>."
24961 #: ../fish/guestfish-actions.pod:2937
24966 #: ../fish/guestfish-actions.pod:2939
24969 " mke2fs-JU fstype blocksize device uuid\n"
24974 #: ../fish/guestfish-actions.pod:2944
24975 msgid "See also L</mke2journal-U>."
24979 #: ../fish/guestfish-actions.pod:2946
24980 msgid "mke2journal"
24984 #: ../fish/guestfish-actions.pod:2948
24987 " mke2journal blocksize device\n"
24992 #: ../fish/guestfish-actions.pod:2955
24993 msgid "mke2journal-L"
24997 #: ../fish/guestfish-actions.pod:2957
25000 " mke2journal-L blocksize label device\n"
25005 #: ../fish/guestfish-actions.pod:2961
25006 msgid "mke2journal-U"
25010 #: ../fish/guestfish-actions.pod:2963
25013 " mke2journal-U blocksize uuid device\n"
25018 #: ../fish/guestfish-actions.pod:2967
25023 #: ../fish/guestfish-actions.pod:2969
25026 " mkfifo mode path\n"
25031 #: ../fish/guestfish-actions.pod:2971
25033 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
25034 "is just a convenient wrapper around L</mknod>."
25038 #: ../fish/guestfish-actions.pod:2977
25043 #: ../fish/guestfish-actions.pod:2979
25046 " mkfs fstype device\n"
25051 #: ../fish/guestfish-actions.pod:2985
25056 #: ../fish/guestfish-actions.pod:2987
25059 " mkfs-b fstype blocksize device\n"
25064 #: ../fish/guestfish-actions.pod:2989
25066 "This call is similar to L</mkfs>, but it allows you to control the block "
25067 "size of the resulting filesystem. Supported block sizes depend on the "
25068 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
25072 #: ../fish/guestfish-actions.pod:3004
25077 #: ../fish/guestfish-actions.pod:3006
25080 " mkfs-opts fstype device [blocksize:..] [features:..]\n"
25085 #: ../fish/guestfish-actions.pod:3041
25086 msgid "mkmountpoint"
25090 #: ../fish/guestfish-actions.pod:3043
25093 " mkmountpoint exemptpath\n"
25098 #: ../fish/guestfish-actions.pod:3045
25100 "L</mkmountpoint> and L</rmmountpoint> are specialized calls that can be used "
25101 "to create extra mountpoints before mounting the first filesystem."
25105 #: ../fish/guestfish-actions.pod:3069
25107 "L</mkmountpoint> is not compatible with L</umount-all>. You may get "
25108 "unexpected errors if you try to mix these calls. It is safest to manually "
25109 "unmount filesystems and remove mountpoints after use."
25113 #: ../fish/guestfish-actions.pod:3073
25115 "L</umount-all> unmounts filesystems by sorting the paths longest first, so "
25116 "for this to work for manual mountpoints, you must ensure that the innermost "
25117 "mountpoints have the longest pathnames, as in the example code above."
25121 #: ../fish/guestfish-actions.pod:3080
25123 "Autosync [see L</set-autosync>, this is set by default on handles] can cause "
25124 "L</umount-all> to be called when the handle is closed which can also trigger "
25129 #: ../fish/guestfish-actions.pod:3084
25134 #: ../fish/guestfish-actions.pod:3086
25137 " mknod mode devmajor devminor path\n"
25142 #: ../fish/guestfish-actions.pod:3096
25144 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
25145 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
25146 "regular file). These constants are available in the standard Linux header "
25147 "files, or you can use L</mknod-b>, L</mknod-c> or L</mkfifo> which are "
25148 "wrappers around this command which bitwise OR in the appropriate constant "
25153 #: ../fish/guestfish-actions.pod:3106
25158 #: ../fish/guestfish-actions.pod:3108
25161 " mknod-b mode devmajor devminor path\n"
25166 #: ../fish/guestfish-actions.pod:3110
25168 "This call creates a block device node called C<path> with mode C<mode> and "
25169 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
25170 "wrapper around L</mknod>."
25174 #: ../fish/guestfish-actions.pod:3116
25179 #: ../fish/guestfish-actions.pod:3118
25182 " mknod-c mode devmajor devminor path\n"
25187 #: ../fish/guestfish-actions.pod:3120
25189 "This call creates a char device node called C<path> with mode C<mode> and "
25190 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
25191 "wrapper around L</mknod>."
25195 #: ../fish/guestfish-actions.pod:3126
25200 #: ../fish/guestfish-actions.pod:3128
25208 #: ../fish/guestfish-actions.pod:3132
25213 #: ../fish/guestfish-actions.pod:3134
25216 " mkswap-L label device\n"
25221 #: ../fish/guestfish-actions.pod:3142
25226 #: ../fish/guestfish-actions.pod:3144
25229 " mkswap-U uuid device\n"
25234 #: ../fish/guestfish-actions.pod:3148
25235 msgid "mkswap-file"
25239 #: ../fish/guestfish-actions.pod:3150
25242 " mkswap-file path\n"
25247 #: ../fish/guestfish-actions.pod:3154
25249 "This command just writes a swap file signature to an existing file. To "
25250 "create the file itself, use something like L</fallocate>."
25254 #: ../fish/guestfish-actions.pod:3157
25259 #: ../fish/guestfish-actions.pod:3159
25262 " modprobe modulename\n"
25267 #: ../fish/guestfish-actions.pod:3166
25272 #: ../fish/guestfish-actions.pod:3168
25275 " mount device mountpoint\n"
25280 #: ../fish/guestfish-actions.pod:3184
25282 "B<Important note:> When you use this call, the filesystem options C<sync> "
25283 "and C<noatime> are set implicitly. This was originally done because we "
25284 "thought it would improve reliability, but it turns out that I<-o sync> has a "
25285 "very large negative performance impact and negligible effect on "
25286 "reliability. Therefore we recommend that you avoid using L</mount> in any "
25287 "code that needs performance, and instead use L</mount-options> (use an empty "
25288 "string for the first parameter if you don't want any options)."
25292 #: ../fish/guestfish-actions.pod:3194
25297 #: ../fish/guestfish-actions.pod:3196
25300 " mount-loop file mountpoint\n"
25305 #: ../fish/guestfish-actions.pod:3202
25306 msgid "mount-options"
25310 #: ../fish/guestfish-actions.pod:3204
25313 " mount-options options device mountpoint\n"
25318 #: ../fish/guestfish-actions.pod:3206
25320 "This is the same as the L</mount> command, but it allows you to set the "
25321 "mount options as for the L<mount(8)> I<-o> flag."
25325 #: ../fish/guestfish-actions.pod:3214
25330 #: ../fish/guestfish-actions.pod:3216
25333 " mount-ro device mountpoint\n"
25338 #: ../fish/guestfish-actions.pod:3218
25340 "This is the same as the L</mount> command, but it mounts the filesystem with "
25341 "the read-only (I<-o ro>) flag."
25345 #: ../fish/guestfish-actions.pod:3221
25350 #: ../fish/guestfish-actions.pod:3223
25353 " mount-vfs options vfstype device mountpoint\n"
25358 #: ../fish/guestfish-actions.pod:3225
25360 "This is the same as the L</mount> command, but it allows you to set both the "
25361 "mount options and the vfstype as for the L<mount(8)> I<-o> and I<-t> flags."
25365 #: ../fish/guestfish-actions.pod:3229
25366 msgid "mountpoints"
25370 #: ../fish/guestfish-actions.pod:3231
25378 #: ../fish/guestfish-actions.pod:3233
25380 "This call is similar to L</mounts>. That call returns a list of devices. "
25381 "This one returns a hash table (map) of device name to directory where the "
25382 "device is mounted."
25386 #: ../fish/guestfish-actions.pod:3237
25391 #: ../fish/guestfish-actions.pod:3239
25399 #: ../fish/guestfish-actions.pod:3246
25400 msgid "See also: L</mountpoints>"
25404 #: ../fish/guestfish-actions.pod:3248
25409 #: ../fish/guestfish-actions.pod:3250
25417 #: ../fish/guestfish-actions.pod:3255
25418 msgid "ntfs-3g-probe"
25422 #: ../fish/guestfish-actions.pod:3257
25425 " ntfs-3g-probe true|false device\n"
25430 #: ../fish/guestfish-actions.pod:3271
25435 #: ../fish/guestfish-actions.pod:3273
25438 " ntfsresize device\n"
25443 #: ../fish/guestfish-actions.pod:3279
25444 msgid "ntfsresize-size"
25448 #: ../fish/guestfish-actions.pod:3281
25451 " ntfsresize-size device size\n"
25456 #: ../fish/guestfish-actions.pod:3283
25458 "This command is the same as L</ntfsresize> except that it allows you to "
25459 "specify the new size (in bytes) explicitly."
25463 #: ../fish/guestfish-actions.pod:3286
25468 #: ../fish/guestfish-actions.pod:3288
25471 " part-add device prlogex startsect endsect\n"
25476 #: ../fish/guestfish-actions.pod:3290
25478 "This command adds a partition to C<device>. If there is no partition table "
25479 "on the device, call L</part-init> first."
25483 #: ../fish/guestfish-actions.pod:3302
25485 "Creating a partition which covers the whole disk is not so easy. Use L</"
25486 "part-disk> to do that."
25490 #: ../fish/guestfish-actions.pod:3305
25495 #: ../fish/guestfish-actions.pod:3307
25498 " part-del device partnum\n"
25503 #: ../fish/guestfish-actions.pod:3315
25508 #: ../fish/guestfish-actions.pod:3317
25511 " part-disk device parttype\n"
25516 #: ../fish/guestfish-actions.pod:3319
25518 "This command is simply a combination of L</part-init> followed by L</part-"
25519 "add> to create a single primary partition covering the whole disk."
25523 #: ../fish/guestfish-actions.pod:3323
25525 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
25526 "possible values are described in L</part-init>."
25530 #: ../fish/guestfish-actions.pod:3329
25531 msgid "part-get-bootable"
25535 #: ../fish/guestfish-actions.pod:3331
25538 " part-get-bootable device partnum\n"
25543 #: ../fish/guestfish-actions.pod:3336
25544 msgid "See also L</part-set-bootable>."
25548 #: ../fish/guestfish-actions.pod:3338
25549 msgid "part-get-mbr-id"
25553 #: ../fish/guestfish-actions.pod:3340
25556 " part-get-mbr-id device partnum\n"
25561 #: ../fish/guestfish-actions.pod:3345 ../fish/guestfish-actions.pod:3483
25563 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
25564 "undefined results for other partition table types (see L</part-get-"
25569 #: ../fish/guestfish-actions.pod:3349
25570 msgid "part-get-parttype"
25574 #: ../fish/guestfish-actions.pod:3351
25577 " part-get-parttype device\n"
25582 #: ../fish/guestfish-actions.pod:3356
25584 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
25585 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
25586 "possible, although unusual. See L</part-init> for a full list."
25590 #: ../fish/guestfish-actions.pod:3361
25595 #: ../fish/guestfish-actions.pod:3363
25598 " part-init device parttype\n"
25603 #: ../fish/guestfish-actions.pod:3369
25605 "Initially there are no partitions. Following this, you should call L</part-"
25606 "add> for each partition required."
25610 #: ../fish/guestfish-actions.pod:3432
25615 #: ../fish/guestfish-actions.pod:3434
25618 " part-list device\n"
25623 #: ../fish/guestfish-actions.pod:3449
25625 "Start of the partition I<in bytes>. To get sectors you have to divide by "
25626 "the device's sector size, see L</blockdev-getss>."
25630 #: ../fish/guestfish-actions.pod:3462
25631 msgid "part-set-bootable"
25635 #: ../fish/guestfish-actions.pod:3464
25638 " part-set-bootable device partnum true|false\n"
25643 #: ../fish/guestfish-actions.pod:3473
25644 msgid "part-set-mbr-id"
25648 #: ../fish/guestfish-actions.pod:3475
25651 " part-set-mbr-id device partnum idbyte\n"
25656 #: ../fish/guestfish-actions.pod:3487
25657 msgid "part-set-name"
25661 #: ../fish/guestfish-actions.pod:3489
25664 " part-set-name device partnum name\n"
25669 #: ../fish/guestfish-actions.pod:3497
25670 msgid "part-to-dev"
25674 #: ../fish/guestfish-actions.pod:3499
25677 " part-to-dev partition\n"
25682 #: ../fish/guestfish-actions.pod:3505
25684 "The named partition must exist, for example as a string returned from L</"
25685 "list-partitions>."
25689 #: ../fish/guestfish-actions.pod:3508
25690 msgid "ping-daemon"
25694 #: ../fish/guestfish-actions.pod:3510
25702 #: ../fish/guestfish-actions.pod:3517
25707 #: ../fish/guestfish-actions.pod:3519
25710 " pread path count offset\n"
25715 #: ../fish/guestfish-actions.pod:3527
25716 msgid "See also L</pwrite>, L</pread-device>."
25720 #: ../fish/guestfish-actions.pod:3532
25721 msgid "pread-device"
25725 #: ../fish/guestfish-actions.pod:3534
25728 " pread-device device count offset\n"
25733 #: ../fish/guestfish-actions.pod:3542
25734 msgid "See also L</pread>."
25738 #: ../fish/guestfish-actions.pod:3547
25743 #: ../fish/guestfish-actions.pod:3549
25746 " pvcreate device\n"
25751 #: ../fish/guestfish-actions.pod:3555
25756 #: ../fish/guestfish-actions.pod:3557
25759 " pvremove device\n"
25764 #: ../fish/guestfish-actions.pod:3566
25769 #: ../fish/guestfish-actions.pod:3568
25772 " pvresize device\n"
25777 #: ../fish/guestfish-actions.pod:3573
25778 msgid "pvresize-size"
25782 #: ../fish/guestfish-actions.pod:3575
25785 " pvresize-size device size\n"
25790 #: ../fish/guestfish-actions.pod:3577
25792 "This command is the same as L</pvresize> except that it allows you to "
25793 "specify the new size (in bytes) explicitly."
25797 #: ../fish/guestfish-actions.pod:3580
25802 #: ../fish/guestfish-actions.pod:3582
25810 #: ../fish/guestfish-actions.pod:3590
25811 msgid "See also L</pvs-full>."
25815 #: ../fish/guestfish-actions.pod:3592
25820 #: ../fish/guestfish-actions.pod:3594
25828 #: ../fish/guestfish-actions.pod:3599
25833 #: ../fish/guestfish-actions.pod:3601
25841 #: ../fish/guestfish-actions.pod:3605
25846 #: ../fish/guestfish-actions.pod:3607
25849 " pwrite path content offset\n"
25854 #: ../fish/guestfish-actions.pod:3618
25855 msgid "See also L</pread>, L</pwrite-device>."
25859 #: ../fish/guestfish-actions.pod:3623
25860 msgid "pwrite-device"
25864 #: ../fish/guestfish-actions.pod:3625
25867 " pwrite-device device content offset\n"
25872 #: ../fish/guestfish-actions.pod:3635
25873 msgid "See also L</pwrite>."
25877 #: ../fish/guestfish-actions.pod:3640
25882 #: ../fish/guestfish-actions.pod:3642
25885 " read-file path\n"
25890 #: ../fish/guestfish-actions.pod:3647
25892 "Unlike L</cat>, this function can correctly handle files that contain "
25893 "embedded ASCII NUL characters. However unlike L</download>, this function "
25894 "is limited in the total size of file that can be handled."
25898 #: ../fish/guestfish-actions.pod:3655
25903 #: ../fish/guestfish-actions.pod:3657
25906 " read-lines path\n"
25911 #: ../fish/guestfish-actions.pod:3664
25913 "Note that this function cannot correctly handle binary files (specifically, "
25914 "files containing C<\\0> character which is treated as end of line). For "
25915 "those you need to use the L</read-file> function which has a more complex "
25920 #: ../fish/guestfish-actions.pod:3669
25925 #: ../fish/guestfish-actions.pod:3671
25933 #: ../fish/guestfish-actions.pod:3723
25935 "This function is primarily intended for use by programs. To get a simple "
25936 "list of names, use L</ls>. To get a printable directory for human "
25937 "consumption, use L</ll>."
25941 #: ../fish/guestfish-actions.pod:3727
25946 #: ../fish/guestfish-actions.pod:3729
25954 #: ../fish/guestfish-actions.pod:3733
25955 msgid "readlinklist"
25959 #: ../fish/guestfish-actions.pod:3735
25962 " readlinklist path 'names ...'\n"
25967 #: ../fish/guestfish-actions.pod:3759
25972 #: ../fish/guestfish-actions.pod:3761
25980 #: ../fish/guestfish-actions.pod:3766
25981 msgid "removexattr"
25985 #: ../fish/guestfish-actions.pod:3768
25988 " removexattr xattr path\n"
25993 #: ../fish/guestfish-actions.pod:3773
25994 msgid "See also: L</lremovexattr>, L<attr(5)>."
25998 #: ../fish/guestfish-actions.pod:3775
26003 #: ../fish/guestfish-actions.pod:3777
26006 " resize2fs device\n"
26011 #: ../fish/guestfish-actions.pod:3782
26013 "I<Note:> It is sometimes required that you run L</e2fsck-f> on the C<device> "
26014 "before calling this command. For unknown reasons C<resize2fs> sometimes "
26015 "gives an error about this and sometimes not. In any case, it is always safe "
26016 "to call L</e2fsck-f> before calling this function."
26020 #: ../fish/guestfish-actions.pod:3788
26021 msgid "resize2fs-M"
26025 #: ../fish/guestfish-actions.pod:3790
26028 " resize2fs-M device\n"
26033 #: ../fish/guestfish-actions.pod:3792
26035 "This command is the same as L</resize2fs>, but the filesystem is resized to "
26036 "its minimum size. This works like the C<-M> option to the C<resize2fs> "
26041 #: ../fish/guestfish-actions.pod:3796
26043 "To get the resulting size of the filesystem you should call L</tune2fs-l> "
26044 "and read the C<Block size> and C<Block count> values. These two numbers, "
26045 "multiplied together, give the resulting size of the minimal filesystem in "
26050 #: ../fish/guestfish-actions.pod:3801
26051 msgid "resize2fs-size"
26055 #: ../fish/guestfish-actions.pod:3803
26058 " resize2fs-size device size\n"
26063 #: ../fish/guestfish-actions.pod:3805
26065 "This command is the same as L</resize2fs> except that it allows you to "
26066 "specify the new size (in bytes) explicitly."
26070 #: ../fish/guestfish-actions.pod:3808
26075 #: ../fish/guestfish-actions.pod:3810
26083 #: ../fish/guestfish-actions.pod:3814
26088 #: ../fish/guestfish-actions.pod:3816
26096 #: ../fish/guestfish-actions.pod:3822
26101 #: ../fish/guestfish-actions.pod:3824
26109 #: ../fish/guestfish-actions.pod:3828
26110 msgid "rmmountpoint"
26114 #: ../fish/guestfish-actions.pod:3830
26117 " rmmountpoint exemptpath\n"
26122 #: ../fish/guestfish-actions.pod:3832
26124 "This calls removes a mountpoint that was previously created with L</"
26125 "mkmountpoint>. See L</mkmountpoint> for full details."
26129 #: ../fish/guestfish-actions.pod:3836
26130 msgid "scrub-device"
26134 #: ../fish/guestfish-actions.pod:3838
26137 " scrub-device device\n"
26142 #: ../fish/guestfish-actions.pod:3849
26147 #: ../fish/guestfish-actions.pod:3851
26150 " scrub-file file\n"
26155 #: ../fish/guestfish-actions.pod:3861
26156 msgid "scrub-freespace"
26160 #: ../fish/guestfish-actions.pod:3863
26163 " scrub-freespace dir\n"
26168 #: ../fish/guestfish-actions.pod:3865
26170 "This command creates the directory C<dir> and then fills it with files until "
26171 "the filesystem is full, and scrubs the files as for L</scrub-file>, and "
26172 "deletes them. The intention is to scrub any free space on the partition "
26173 "containing C<dir>."
26177 #: ../fish/guestfish-actions.pod:3874
26182 #: ../fish/guestfish-actions.pod:3876
26187 #: ../fish/guestfish-actions.pod:3878
26190 " set-append append\n"
26195 #: ../fish/guestfish-actions.pod:3889
26196 msgid "set-attach-method"
26200 #: ../fish/guestfish-actions.pod:3891
26201 msgid "attach-method"
26205 #: ../fish/guestfish-actions.pod:3893
26208 " set-attach-method attachmethod\n"
26213 #: ../fish/guestfish-actions.pod:3915
26214 msgid "set-autosync"
26218 #: ../fish/guestfish-actions.pod:3917
26223 #: ../fish/guestfish-actions.pod:3919
26226 " set-autosync true|false\n"
26231 #: ../fish/guestfish-actions.pod:3929
26236 #: ../fish/guestfish-actions.pod:3931
26241 #: ../fish/guestfish-actions.pod:3933
26244 " set-direct true|false\n"
26249 #: ../fish/guestfish-actions.pod:3939
26251 "One consequence of this is that log messages aren't caught by the library "
26252 "and handled by L</set-log-message-callback>, but go straight to stdout."
26256 #: ../fish/guestfish-actions.pod:3948
26257 msgid "set-e2label"
26261 #: ../fish/guestfish-actions.pod:3950
26264 " set-e2label device label\n"
26269 #: ../fish/guestfish-actions.pod:3956
26271 "You can use either L</tune2fs-l> or L</get-e2label> to return the existing "
26272 "label on a filesystem."
26276 #: ../fish/guestfish-actions.pod:3959
26281 #: ../fish/guestfish-actions.pod:3961
26284 " set-e2uuid device uuid\n"
26289 #: ../fish/guestfish-actions.pod:3968
26291 "You can use either L</tune2fs-l> or L</get-e2uuid> to return the existing "
26292 "UUID of a filesystem."
26296 #: ../fish/guestfish-actions.pod:3971
26297 msgid "set-memsize"
26301 #: ../fish/guestfish-actions.pod:3973
26306 #: ../fish/guestfish-actions.pod:3975
26309 " set-memsize memsize\n"
26314 #: ../fish/guestfish-actions.pod:3977
26316 "This sets the memory size in megabytes allocated to the qemu subprocess. "
26317 "This only has any effect if called before L</launch>."
26321 #: ../fish/guestfish-actions.pod:3988
26322 msgid "set-network"
26326 #: ../fish/guestfish-actions.pod:3990
26331 #: ../fish/guestfish-actions.pod:3992
26334 " set-network true|false\n"
26339 #: ../fish/guestfish-actions.pod:4000
26341 "You must call this before calling L</launch>, otherwise it has no effect."
26345 #: ../fish/guestfish-actions.pod:4003
26350 #: ../fish/guestfish-actions.pod:4005
26355 #: ../fish/guestfish-actions.pod:4007
26358 " set-path searchpath\n"
26363 #: ../fish/guestfish-actions.pod:4016
26368 #: ../fish/guestfish-actions.pod:4018
26373 #: ../fish/guestfish-actions.pod:4020
26381 #: ../fish/guestfish-actions.pod:4040
26382 msgid "set-recovery-proc"
26386 #: ../fish/guestfish-actions.pod:4042
26387 msgid "recovery-proc"
26391 #: ../fish/guestfish-actions.pod:4044
26394 " set-recovery-proc true|false\n"
26399 #: ../fish/guestfish-actions.pod:4046
26401 "If this is called with the parameter C<false> then L</launch> does not "
26402 "create a recovery process. The purpose of the recovery process is to stop "
26403 "runaway qemu processes in the case where the main program aborts abruptly."
26407 #: ../fish/guestfish-actions.pod:4051
26409 "This only has any effect if called before L</launch>, and the default is "
26414 #: ../fish/guestfish-actions.pod:4060
26415 msgid "set-selinux"
26419 #: ../fish/guestfish-actions.pod:4062
26424 #: ../fish/guestfish-actions.pod:4064
26427 " set-selinux true|false\n"
26432 #: ../fish/guestfish-actions.pod:4075
26437 #: ../fish/guestfish-actions.pod:4077
26442 #: ../fish/guestfish-actions.pod:4079
26445 " set-trace true|false\n"
26450 #: ../fish/guestfish-actions.pod:4091
26452 "Trace messages are normally sent to C<stderr>, unless you register a "
26453 "callback to send them somewhere else (see L</set-event-callback>)."
26457 #: ../fish/guestfish-actions.pod:4095
26458 msgid "set-verbose"
26462 #: ../fish/guestfish-actions.pod:4097
26467 #: ../fish/guestfish-actions.pod:4099
26470 " set-verbose true|false\n"
26475 #: ../fish/guestfish-actions.pod:4106
26477 "Verbose messages are normally sent to C<stderr>, unless you register a "
26478 "callback to send them somewhere else (see L</set-event-callback>)."
26482 #: ../fish/guestfish-actions.pod:4110
26487 #: ../fish/guestfish-actions.pod:4112
26490 " setcon context\n"
26495 #: ../fish/guestfish-actions.pod:4119
26500 #: ../fish/guestfish-actions.pod:4121
26503 " setxattr xattr val vallen path\n"
26508 #: ../fish/guestfish-actions.pod:4127
26509 msgid "See also: L</lsetxattr>, L<attr(5)>."
26513 #: ../fish/guestfish-actions.pod:4129
26518 #: ../fish/guestfish-actions.pod:4131
26521 " sfdisk device cyls heads sectors 'lines ...'\n"
26526 #: ../fish/guestfish-actions.pod:4153
26527 msgid "See also: L</sfdisk-l>, L</sfdisk-N>, L</part-init>"
26531 #: ../fish/guestfish-actions.pod:4159
26536 #: ../fish/guestfish-actions.pod:4161
26539 " sfdiskM device 'lines ...'\n"
26544 #: ../fish/guestfish-actions.pod:4163
26546 "This is a simplified interface to the L</sfdisk> command, where partition "
26547 "sizes are specified in megabytes only (rounded to the nearest cylinder) and "
26548 "you don't need to specify the cyls, heads and sectors parameters which were "
26549 "rarely if ever used anyway."
26553 #: ../fish/guestfish-actions.pod:4169
26554 msgid "See also: L</sfdisk>, the L<sfdisk(8)> manpage and L</part-disk>"
26558 #: ../fish/guestfish-actions.pod:4175
26563 #: ../fish/guestfish-actions.pod:4177
26566 " sfdisk-N device partnum cyls heads sectors line\n"
26571 #: ../fish/guestfish-actions.pod:4182
26573 "For other parameters, see L</sfdisk>. You should usually pass C<0> for the "
26574 "cyls/heads/sectors parameters."
26578 #: ../fish/guestfish-actions.pod:4185
26579 msgid "See also: L</part-add>"
26583 #: ../fish/guestfish-actions.pod:4190
26584 msgid "sfdisk-disk-geometry"
26588 #: ../fish/guestfish-actions.pod:4192
26591 " sfdisk-disk-geometry device\n"
26596 #: ../fish/guestfish-actions.pod:4194
26598 "This displays the disk geometry of C<device> read from the partition table. "
26599 "Especially in the case where the underlying block device has been resized, "
26600 "this can be different from the kernel's idea of the geometry (see L</sfdisk-"
26601 "kernel-geometry>)."
26605 #: ../fish/guestfish-actions.pod:4202
26606 msgid "sfdisk-kernel-geometry"
26610 #: ../fish/guestfish-actions.pod:4204
26613 " sfdisk-kernel-geometry device\n"
26618 #: ../fish/guestfish-actions.pod:4211
26623 #: ../fish/guestfish-actions.pod:4213
26626 " sfdisk-l device\n"
26631 #: ../fish/guestfish-actions.pod:4219
26632 msgid "See also: L</part-list>"
26636 #: ../fish/guestfish-actions.pod:4221
26641 #: ../fish/guestfish-actions.pod:4223
26649 #: ../fish/guestfish-actions.pod:4228
26650 msgid "This is like L</command>, but passes the command to:"
26654 #: ../fish/guestfish-actions.pod:4236
26655 msgid "All the provisos about L</command> apply to this call."
26659 #: ../fish/guestfish-actions.pod:4238
26664 #: ../fish/guestfish-actions.pod:4240
26667 " sh-lines command\n"
26672 #: ../fish/guestfish-actions.pod:4242
26673 msgid "This is the same as L</sh>, but splits the result into a list of lines."
26677 #: ../fish/guestfish-actions.pod:4245
26678 msgid "See also: L</command-lines>"
26682 #: ../fish/guestfish-actions.pod:4247
26687 #: ../fish/guestfish-actions.pod:4249
26695 #: ../fish/guestfish-actions.pod:4253
26700 #: ../fish/guestfish-actions.pod:4255
26708 #: ../fish/guestfish-actions.pod:4261
26713 #: ../fish/guestfish-actions.pod:4263
26721 #: ../fish/guestfish-actions.pod:4271
26726 #: ../fish/guestfish-actions.pod:4273
26734 #: ../fish/guestfish-actions.pod:4281
26739 #: ../fish/guestfish-actions.pod:4283
26742 " strings-e encoding path\n"
26747 #: ../fish/guestfish-actions.pod:4285
26749 "This is like the L</strings> command, but allows you to specify the encoding "
26750 "of strings that are looked for in the source file C<path>."
26754 #: ../fish/guestfish-actions.pod:4295
26756 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
26757 "ISO-8859-X (this is what L</strings> uses)."
26761 #: ../fish/guestfish-actions.pod:4327
26762 msgid "swapoff-device"
26766 #: ../fish/guestfish-actions.pod:4329
26769 " swapoff-device device\n"
26774 #: ../fish/guestfish-actions.pod:4331
26776 "This command disables the libguestfs appliance swap device or partition "
26777 "named C<device>. See L</swapon-device>."
26781 #: ../fish/guestfish-actions.pod:4335
26782 msgid "swapoff-file"
26786 #: ../fish/guestfish-actions.pod:4337
26789 " swapoff-file file\n"
26794 #: ../fish/guestfish-actions.pod:4341
26795 msgid "swapoff-label"
26799 #: ../fish/guestfish-actions.pod:4343
26802 " swapoff-label label\n"
26807 #: ../fish/guestfish-actions.pod:4348
26808 msgid "swapoff-uuid"
26812 #: ../fish/guestfish-actions.pod:4350
26815 " swapoff-uuid uuid\n"
26820 #: ../fish/guestfish-actions.pod:4355
26821 msgid "swapon-device"
26825 #: ../fish/guestfish-actions.pod:4357
26828 " swapon-device device\n"
26833 #: ../fish/guestfish-actions.pod:4359
26835 "This command enables the libguestfs appliance to use the swap device or "
26836 "partition named C<device>. The increased memory is made available for all "
26837 "commands, for example those run using L</command> or L</sh>."
26841 #: ../fish/guestfish-actions.pod:4371
26842 msgid "swapon-file"
26846 #: ../fish/guestfish-actions.pod:4373
26849 " swapon-file file\n"
26854 #: ../fish/guestfish-actions.pod:4375
26856 "This command enables swap to a file. See L</swapon-device> for other notes."
26860 #: ../fish/guestfish-actions.pod:4378
26861 msgid "swapon-label"
26865 #: ../fish/guestfish-actions.pod:4380
26868 " swapon-label label\n"
26873 #: ../fish/guestfish-actions.pod:4382
26875 "This command enables swap to a labeled swap partition. See L</swapon-"
26876 "device> for other notes."
26880 #: ../fish/guestfish-actions.pod:4385
26881 msgid "swapon-uuid"
26885 #: ../fish/guestfish-actions.pod:4387
26888 " swapon-uuid uuid\n"
26893 #: ../fish/guestfish-actions.pod:4389
26895 "This command enables swap to a swap partition with the given UUID. See L</"
26896 "swapon-device> for other notes."
26900 #: ../fish/guestfish-actions.pod:4392
26905 #: ../fish/guestfish-actions.pod:4394
26913 #: ../fish/guestfish-actions.pod:4402
26918 #: ../fish/guestfish-actions.pod:4404
26926 #: ../fish/guestfish-actions.pod:4412
26931 #: ../fish/guestfish-actions.pod:4414
26934 " tail-n nrlines path\n"
26939 #: ../fish/guestfish-actions.pod:4427
26944 #: ../fish/guestfish-actions.pod:4429
26947 " tar-in (tarfile|-) directory\n"
26952 #: ../fish/guestfish-actions.pod:4434
26953 msgid "To upload a compressed tarball, use L</tgz-in> or L</txz-in>."
26957 #: ../fish/guestfish-actions.pod:4439
26962 #: ../fish/guestfish-actions.pod:4441
26965 " tar-out directory (tarfile|-)\n"
26970 #: ../fish/guestfish-actions.pod:4446
26971 msgid "To download a compressed tarball, use L</tgz-out> or L</txz-out>."
26975 #: ../fish/guestfish-actions.pod:4451
26980 #: ../fish/guestfish-actions.pod:4453
26983 " tgz-in (tarball|-) directory\n"
26988 #: ../fish/guestfish-actions.pod:4458
26989 msgid "To upload an uncompressed tarball, use L</tar-in>."
26993 #: ../fish/guestfish-actions.pod:4462
26998 #: ../fish/guestfish-actions.pod:4464
27001 " tgz-out directory (tarball|-)\n"
27006 #: ../fish/guestfish-actions.pod:4469
27007 msgid "To download an uncompressed tarball, use L</tar-out>."
27011 #: ../fish/guestfish-actions.pod:4473
27016 #: ../fish/guestfish-actions.pod:4475
27024 #: ../fish/guestfish-actions.pod:4484
27029 #: ../fish/guestfish-actions.pod:4486
27037 #: ../fish/guestfish-actions.pod:4491
27038 msgid "truncate-size"
27042 #: ../fish/guestfish-actions.pod:4493
27045 " truncate-size path size\n"
27050 #: ../fish/guestfish-actions.pod:4498
27052 "If the current file size is less than C<size> then the file is extended to "
27053 "the required size with zero bytes. This creates a sparse file (ie. disk "
27054 "blocks are not allocated for the file until you write to it). To create a "
27055 "non-sparse file of zeroes, use L</fallocate64> instead."
27059 #: ../fish/guestfish-actions.pod:4504
27064 #: ../fish/guestfish-actions.pod:4506
27067 " tune2fs-l device\n"
27072 #: ../fish/guestfish-actions.pod:4516
27077 #: ../fish/guestfish-actions.pod:4518
27080 " txz-in (tarball|-) directory\n"
27085 #: ../fish/guestfish-actions.pod:4525
27090 #: ../fish/guestfish-actions.pod:4527
27093 " txz-out directory (tarball|-)\n"
27098 #: ../fish/guestfish-actions.pod:4534
27103 #: ../fish/guestfish-actions.pod:4536
27111 #: ../fish/guestfish-actions.pod:4550
27112 msgid "See also L</get-umask>, L<umask(2)>, L</mknod>, L</mkdir>."
27116 #: ../fish/guestfish-actions.pod:4555
27121 #: ../fish/guestfish-actions.pod:4557
27126 #: ../fish/guestfish-actions.pod:4559
27129 " umount pathordevice\n"
27134 #: ../fish/guestfish-actions.pod:4565
27139 #: ../fish/guestfish-actions.pod:4567
27140 msgid "unmount-all"
27144 #: ../fish/guestfish-actions.pod:4569
27152 #: ../fish/guestfish-actions.pod:4575
27157 #: ../fish/guestfish-actions.pod:4577
27160 " upload (filename|-) remotefilename\n"
27165 #: ../fish/guestfish-actions.pod:4584
27166 msgid "See also L</download>."
27170 #: ../fish/guestfish-actions.pod:4588
27171 msgid "upload-offset"
27175 #: ../fish/guestfish-actions.pod:4590
27178 " upload-offset (filename|-) remotefilename offset\n"
27183 #: ../fish/guestfish-actions.pod:4602
27185 "Note that there is no limit on the amount of data that can be uploaded with "
27186 "this call, unlike with L</pwrite>, and this call always writes the full "
27187 "amount unless an error occurs."
27191 #: ../fish/guestfish-actions.pod:4607
27192 msgid "See also L</upload>, L</pwrite>."
27196 #: ../fish/guestfish-actions.pod:4611
27201 #: ../fish/guestfish-actions.pod:4613
27204 " utimens path atsecs atnsecs mtsecs mtnsecs\n"
27209 #: ../fish/guestfish-actions.pod:4632
27214 #: ../fish/guestfish-actions.pod:4634
27222 #: ../fish/guestfish-actions.pod:4661
27224 "I<Note:> Don't use this call to test for availability of features. In "
27225 "enterprise distributions we backport features from later versions into "
27226 "earlier versions, making this an unreliable way to test for features. Use "
27227 "L</available> instead."
27231 #: ../fish/guestfish-actions.pod:4667
27236 #: ../fish/guestfish-actions.pod:4669
27239 " vfs-label device\n"
27244 #: ../fish/guestfish-actions.pod:4676
27245 msgid "To find a filesystem from the label, use L</findfs-label>."
27249 #: ../fish/guestfish-actions.pod:4678
27254 #: ../fish/guestfish-actions.pod:4680
27257 " vfs-type device\n"
27262 #: ../fish/guestfish-actions.pod:4690
27267 #: ../fish/guestfish-actions.pod:4692
27270 " vfs-uuid device\n"
27275 #: ../fish/guestfish-actions.pod:4699
27276 msgid "To find a filesystem from the UUID, use L</findfs-uuid>."
27280 #: ../fish/guestfish-actions.pod:4701
27281 msgid "vg-activate"
27285 #: ../fish/guestfish-actions.pod:4703
27288 " vg-activate true|false 'volgroups ...'\n"
27293 #: ../fish/guestfish-actions.pod:4716
27294 msgid "vg-activate-all"
27298 #: ../fish/guestfish-actions.pod:4718
27301 " vg-activate-all true|false\n"
27306 #: ../fish/guestfish-actions.pod:4728
27311 #: ../fish/guestfish-actions.pod:4730
27314 " vgcreate volgroup 'physvols ...'\n"
27319 #: ../fish/guestfish-actions.pod:4735
27324 #: ../fish/guestfish-actions.pod:4737
27327 " vglvuuids vgname\n"
27332 #: ../fish/guestfish-actions.pod:4742
27334 "You can use this along with L</lvs> and L</lvuuid> calls to associate "
27335 "logical volumes and volume groups."
27339 #: ../fish/guestfish-actions.pod:4745
27340 msgid "See also L</vgpvuuids>."
27344 #: ../fish/guestfish-actions.pod:4747
27349 #: ../fish/guestfish-actions.pod:4749
27352 " vgpvuuids vgname\n"
27357 #: ../fish/guestfish-actions.pod:4754
27359 "You can use this along with L</pvs> and L</pvuuid> calls to associate "
27360 "physical volumes and volume groups."
27364 #: ../fish/guestfish-actions.pod:4757
27365 msgid "See also L</vglvuuids>."
27369 #: ../fish/guestfish-actions.pod:4759
27374 #: ../fish/guestfish-actions.pod:4761
27377 " vgremove vgname\n"
27382 #: ../fish/guestfish-actions.pod:4768
27387 #: ../fish/guestfish-actions.pod:4770
27390 " vgrename volgroup newvolgroup\n"
27395 #: ../fish/guestfish-actions.pod:4774
27400 #: ../fish/guestfish-actions.pod:4776
27408 #: ../fish/guestfish-actions.pod:4784
27409 msgid "See also L</vgs-full>."
27413 #: ../fish/guestfish-actions.pod:4786
27418 #: ../fish/guestfish-actions.pod:4788
27426 #: ../fish/guestfish-actions.pod:4793
27431 #: ../fish/guestfish-actions.pod:4795
27439 #: ../fish/guestfish-actions.pod:4800
27444 #: ../fish/guestfish-actions.pod:4802
27452 #: ../fish/guestfish-actions.pod:4806
27457 #: ../fish/guestfish-actions.pod:4808
27465 #: ../fish/guestfish-actions.pod:4813
27470 #: ../fish/guestfish-actions.pod:4815
27478 #: ../fish/guestfish-actions.pod:4820
27483 #: ../fish/guestfish-actions.pod:4822
27491 #: ../fish/guestfish-actions.pod:4827
27496 #: ../fish/guestfish-actions.pod:4829
27499 " write path content\n"
27504 #: ../fish/guestfish-actions.pod:4837
27509 #: ../fish/guestfish-actions.pod:4839
27512 " write-file path content size\n"
27517 #: ../fish/guestfish-actions.pod:4862
27522 #: ../fish/guestfish-actions.pod:4864
27525 " zegrep regex path\n"
27530 #: ../fish/guestfish-actions.pod:4872
27535 #: ../fish/guestfish-actions.pod:4874
27538 " zegrepi regex path\n"
27543 #: ../fish/guestfish-actions.pod:4882
27548 #: ../fish/guestfish-actions.pod:4884
27556 #: ../fish/guestfish-actions.pod:4892
27557 msgid "See also: L</zero-device>, L</scrub-device>."
27561 #: ../fish/guestfish-actions.pod:4894
27562 msgid "zero-device"
27566 #: ../fish/guestfish-actions.pod:4896
27569 " zero-device device\n"
27574 #: ../fish/guestfish-actions.pod:4898
27576 "This command writes zeroes over the entire C<device>. Compare with L</zero> "
27577 "which just zeroes the first few blocks of a device."
27581 #: ../fish/guestfish-actions.pod:4905
27586 #: ../fish/guestfish-actions.pod:4907
27589 " zerofree device\n"
27594 #: ../fish/guestfish-actions.pod:4920
27599 #: ../fish/guestfish-actions.pod:4922
27602 " zfgrep pattern path\n"
27607 #: ../fish/guestfish-actions.pod:4930
27612 #: ../fish/guestfish-actions.pod:4932
27615 " zfgrepi pattern path\n"
27620 #: ../fish/guestfish-actions.pod:4940
27625 #: ../fish/guestfish-actions.pod:4942
27628 " zfile meth path\n"
27633 #: ../fish/guestfish-actions.pod:4949
27635 "Since 1.0.63, use L</file> instead which can now process compressed files."
27639 #: ../fish/guestfish-actions.pod:4959
27644 #: ../fish/guestfish-actions.pod:4961
27647 " zgrep regex path\n"
27652 #: ../fish/guestfish-actions.pod:4969
27657 #: ../fish/guestfish-actions.pod:4971
27660 " zgrepi regex path\n"
27665 #: ../fish/guestfish-commands.pod:1
27670 #: ../fish/guestfish-commands.pod:3
27675 #: ../fish/guestfish-commands.pod:5
27678 " alloc filename size\n"
27683 #: ../fish/guestfish-commands.pod:7
27685 "This creates an empty (zeroed) file of the given size, and then adds so it "
27686 "can be further examined."
27690 #: ../fish/guestfish-commands.pod:10 ../fish/guestfish-commands.pod:168
27691 msgid "For more advanced image creation, see L<qemu-img(1)> utility."
27695 #: ../fish/guestfish-commands.pod:12 ../fish/guestfish-commands.pod:170
27696 msgid "Size can be specified using standard suffixes, eg. C<1M>."
27700 #: ../fish/guestfish-commands.pod:14
27702 "To create a sparse file, use L</sparse> instead. To create a prepared disk "
27703 "image, see L</PREPARED DISK IMAGES>."
27707 #: ../fish/guestfish-commands.pod:17
27712 #: ../fish/guestfish-commands.pod:19
27715 " copy-in local [local ...] /remotedir\n"
27720 #: ../fish/guestfish-commands.pod:21
27722 "C<copy-in> copies local files or directories recursively into the disk "
27723 "image, placing them in the directory called C</remotedir> (which must "
27724 "exist). This guestfish meta-command turns into a sequence of L</tar-in> and "
27725 "other commands as necessary."
27729 #: ../fish/guestfish-commands.pod:26
27731 "Multiple local files and directories can be specified, but the last "
27732 "parameter must always be a remote directory. Wildcards cannot be used."
27736 #: ../fish/guestfish-commands.pod:30
27741 #: ../fish/guestfish-commands.pod:32
27744 " copy-out remote [remote ...] localdir\n"
27749 #: ../fish/guestfish-commands.pod:34
27751 "C<copy-out> copies remote files or directories recursively out of the disk "
27752 "image, placing them on the host disk in a local directory called C<localdir> "
27753 "(which must exist). This guestfish meta-command turns into a sequence of L</"
27754 "download>, L</tar-out> and other commands as necessary."
27758 #: ../fish/guestfish-commands.pod:40
27760 "Multiple remote files and directories can be specified, but the last "
27761 "parameter must always be a local directory. To download to the current "
27762 "directory, use C<.> as in:"
27766 #: ../fish/guestfish-commands.pod:44
27769 " copy-out /home .\n"
27774 #: ../fish/guestfish-commands.pod:46
27776 "Wildcards cannot be used in the ordinary command, but you can use them with "
27777 "the help of L</glob> like this:"
27781 #: ../fish/guestfish-commands.pod:49
27784 " glob copy-out /home/* .\n"
27789 #: ../fish/guestfish-commands.pod:51
27794 #: ../fish/guestfish-commands.pod:53
27797 " echo [params ...]\n"
27802 #: ../fish/guestfish-commands.pod:55
27803 msgid "This echos the parameters to the terminal."
27807 #: ../fish/guestfish-commands.pod:57
27812 #: ../fish/guestfish-commands.pod:59
27817 #: ../fish/guestfish-commands.pod:61
27822 #: ../fish/guestfish-commands.pod:63
27830 #: ../fish/guestfish-commands.pod:65
27832 "This is used to edit a file. It downloads the file, edits it locally using "
27833 "your editor, then uploads the result."
27837 #: ../fish/guestfish-commands.pod:68
27839 "The editor is C<$EDITOR>. However if you use the alternate commands C<vi> "
27840 "or C<emacs> you will get those corresponding editors."
27844 #: ../fish/guestfish-commands.pod:72
27849 #: ../fish/guestfish-commands.pod:74
27852 " glob command args...\n"
27857 #: ../fish/guestfish-commands.pod:76
27859 "Expand wildcards in any paths in the args list, and run C<command> "
27860 "repeatedly on each matching path."
27864 #: ../fish/guestfish-commands.pod:79
27865 msgid "See L</WILDCARDS AND GLOBBING>."
27869 #: ../fish/guestfish-commands.pod:81
27874 #: ../fish/guestfish-commands.pod:83
27877 " hexedit <filename|device>\n"
27878 " hexedit <filename|device> <max>\n"
27879 " hexedit <filename|device> <start> <max>\n"
27884 #: ../fish/guestfish-commands.pod:87
27886 "Use hexedit (a hex editor) to edit all or part of a binary file or block "
27891 #: ../fish/guestfish-commands.pod:90
27893 "This command works by downloading potentially the whole file or device, "
27894 "editing it locally, then uploading it. If the file or device is large, you "
27895 "have to specify which part you wish to edit by using C<max> and/or C<start> "
27896 "C<max> parameters. C<start> and C<max> are specified in bytes, with the "
27897 "usual modifiers allowed such as C<1M> (1 megabyte)."
27901 #: ../fish/guestfish-commands.pod:97
27902 msgid "For example to edit the first few sectors of a disk you might do:"
27906 #: ../fish/guestfish-commands.pod:100
27909 " hexedit /dev/sda 1M\n"
27914 #: ../fish/guestfish-commands.pod:102
27916 "which would allow you to edit anywhere within the first megabyte of the disk."
27920 #: ../fish/guestfish-commands.pod:105
27921 msgid "To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:"
27925 #: ../fish/guestfish-commands.pod:107
27928 " hexedit /dev/sda1 0x400 0x400\n"
27933 #: ../fish/guestfish-commands.pod:109
27934 msgid "(assuming the superblock is in the standard location)."
27938 #: ../fish/guestfish-commands.pod:111
27940 "This command requires the external L<hexedit(1)> program. You can specify "
27941 "another program to use by setting the C<HEXEDITOR> environment variable."
27945 #: ../fish/guestfish-commands.pod:115
27946 msgid "See also L</hexdump>."
27950 #: ../fish/guestfish-commands.pod:117
27955 #: ../fish/guestfish-commands.pod:119
27963 #: ../fish/guestfish-commands.pod:121
27965 "Change the local directory, ie. the current directory of guestfish itself."
27969 #: ../fish/guestfish-commands.pod:124
27970 msgid "Note that C<!cd> won't do what you might expect."
27974 #: ../fish/guestfish-commands.pod:126
27979 #: ../fish/guestfish-commands.pod:128
27984 #: ../fish/guestfish-commands.pod:130
27992 #: ../fish/guestfish-commands.pod:132
27993 msgid "Opens the manual page for guestfish."
27997 #: ../fish/guestfish-commands.pod:134
28002 #: ../fish/guestfish-commands.pod:136
28007 #: ../fish/guestfish-commands.pod:138
28015 #: ../fish/guestfish-commands.pod:140
28023 #: ../fish/guestfish-commands.pod:142
28024 msgid "This is used to view a file."
28028 #: ../fish/guestfish-commands.pod:144
28030 "The default viewer is C<$PAGER>. However if you use the alternate command "
28031 "C<less> you will get the C<less> command specifically."
28035 #: ../fish/guestfish-commands.pod:147
28040 #: ../fish/guestfish-commands.pod:149
28048 #: ../fish/guestfish-commands.pod:151
28050 "Close and reopen the libguestfs handle. It is not necessary to use this "
28051 "normally, because the handle is closed properly when guestfish exits. "
28052 "However this is occasionally useful for testing."
28056 #: ../fish/guestfish-commands.pod:155
28061 #: ../fish/guestfish-commands.pod:157
28064 " sparse filename size\n"
28069 #: ../fish/guestfish-commands.pod:159
28071 "This creates an empty sparse file of the given size, and then adds so it can "
28072 "be further examined."
28076 #: ../fish/guestfish-commands.pod:162
28078 "In all respects it works the same as the L</alloc> command, except that the "
28079 "image file is allocated sparsely, which means that disk blocks are not "
28080 "assigned to the file until they are needed. Sparse disk files only use "
28081 "space when written to, but they are slower and there is a danger you could "
28082 "run out of real disk space during a write operation."
28086 #: ../fish/guestfish-commands.pod:172
28091 #: ../fish/guestfish-commands.pod:174
28099 #: ../fish/guestfish-commands.pod:176
28101 "This command returns a list of the optional groups known to the daemon, and "
28102 "indicates which ones are supported by this build of the libguestfs appliance."
28106 #: ../fish/guestfish-commands.pod:180
28107 msgid "See also L<guestfs(3)/AVAILABILITY>."
28111 #: ../fish/guestfish-commands.pod:182
28116 #: ../fish/guestfish-commands.pod:184
28119 " time command args...\n"
28124 #: ../fish/guestfish-commands.pod:186
28126 "Run the command as usual, but print the elapsed time afterwards. This can "
28127 "be useful for benchmarking operations."
28131 #: ../test-tool/libguestfs-test-tool.pod:5
28132 msgid "libguestfs-test-tool - End user tests for libguestfs"
28136 #: ../test-tool/libguestfs-test-tool.pod:9
28139 " libguestfs-test-tool [--options]\n"
28144 #: ../test-tool/libguestfs-test-tool.pod:13
28146 "libguestfs-test-tool is a test program shipped with libguestfs to end users "
28147 "and developers, to allow them to check basic libguestfs functionality is "
28148 "working. This is needed because libguestfs occasionally breaks for reasons "
28149 "beyond our control: usually because of changes in the underlying qemu or "
28150 "kernel packages, or the host environment."
28154 #: ../test-tool/libguestfs-test-tool.pod:20
28155 msgid "If you suspect a problem in libguestfs, then just run:"
28159 #: ../test-tool/libguestfs-test-tool.pod:22
28162 " libguestfs-test-tool\n"
28167 #: ../test-tool/libguestfs-test-tool.pod:24
28168 msgid "It will print lots of diagnostic messages."
28172 #: ../test-tool/libguestfs-test-tool.pod:26
28173 msgid "If it runs to completion successfully, you will see this near the end:"
28177 #: ../test-tool/libguestfs-test-tool.pod:28
28180 " ===== TEST FINISHED OK =====\n"
28185 #: ../test-tool/libguestfs-test-tool.pod:30
28186 msgid "and the test tool will exit with code 0."
28190 #: ../test-tool/libguestfs-test-tool.pod:32
28192 "If it fails (and/or exits with non-zero error code), please paste the "
28193 "B<complete, unedited> output of the test tool into a bug report. More "
28194 "information about reporting bugs can be found on the L<http://libguestfs.org/"
28199 #: ../test-tool/libguestfs-test-tool.pod:41
28204 #: ../test-tool/libguestfs-test-tool.pod:43
28205 msgid "Display short usage information and exit."
28209 #: ../test-tool/libguestfs-test-tool.pod:45
28210 msgid "I<--qemu qemu_binary>"
28214 #: ../test-tool/libguestfs-test-tool.pod:47
28216 "If you have downloaded another qemu binary, point this option at the full "
28217 "path of the binary to try it."
28221 #: ../test-tool/libguestfs-test-tool.pod:50
28222 msgid "I<--qemudir qemu_source_dir>"
28226 #: ../test-tool/libguestfs-test-tool.pod:52
28228 "If you have compiled qemu from source, point this option at the source "
28229 "directory to try it."
28233 #: ../test-tool/libguestfs-test-tool.pod:55
28234 msgid "I<--timeout N>"
28238 #: ../test-tool/libguestfs-test-tool.pod:57
28240 "Set the launch timeout to C<N> seconds. The default is 120 seconds which "
28241 "does not usually need to be adjusted unless your machine is very slow."
28245 #: ../test-tool/libguestfs-test-tool.pod:63
28246 msgid "TRYING OUT A DIFFERENT VERSION OF QEMU"
28250 #: ../test-tool/libguestfs-test-tool.pod:65
28252 "If you have compiled another version of qemu from source and would like to "
28253 "try that, then you can use the I<--qemudir> option to point to the qemu "
28254 "source directory."
28258 #: ../test-tool/libguestfs-test-tool.pod:69
28260 "If you have downloaded a qemu binary from somewhere, use the I<--qemu> "
28261 "option to point to the binary."
28265 #: ../test-tool/libguestfs-test-tool.pod:72
28267 "When using an alternate qemu with libguestfs, usually you would need to "
28268 "write a qemu wrapper script (see section I<QEMU WRAPPERS> in L<guestfs(3)"
28269 ">). libguestfs-test-tool writes a temporary qemu wrapper script when you "
28270 "use either of the I<--qemudir> or I<--qemu> options."
28274 #: ../test-tool/libguestfs-test-tool.pod:79
28276 "libguestfs-test-tool returns I<0> if the tests completed without error, or "
28277 "I<1> if there was an error."
28281 #: ../test-tool/libguestfs-test-tool.pod:84
28283 "For the full list of environment variables which may affect libguestfs, "
28284 "please see the L<guestfs(3)> manual page."
28288 #: ../test-tool/libguestfs-test-tool.pod:89
28289 msgid "L<guestfs(3)>, L<http://libguestfs.org/>, L<http://qemu.org/>."
28293 #: ../fuse/guestmount.pod:5
28295 "guestmount - Mount a guest filesystem on the host using FUSE and libguestfs"
28299 #: ../fuse/guestmount.pod:9
28302 " guestmount [--options] -a disk.img -m device [--ro] mountpoint\n"
28307 #: ../fuse/guestmount.pod:11
28310 " guestmount [--options] -a disk.img -i [--ro] mountpoint\n"
28315 #: ../fuse/guestmount.pod:13
28318 " guestmount [--options] -d Guest -i [--ro] mountpoint\n"
28323 #: ../fuse/guestmount.pod:17
28325 "You must I<not> use C<guestmount> in read-write mode on live virtual "
28326 "machines. If you do this, you risk disk corruption in the VM."
28330 #: ../fuse/guestmount.pod:22
28332 "The guestmount program can be used to mount virtual machine filesystems and "
28333 "other disk images on the host. It uses libguestfs for access to the guest "
28334 "filesystem, and FUSE (the \"filesystem in userspace\") to make it appear as "
28335 "a mountable device."
28339 #: ../fuse/guestmount.pod:27
28341 "Along with other options, you have to give at least one device (I<-a> "
28342 "option) or libvirt domain (I<-d> option), and at least one mountpoint (I<-m> "
28343 "option) or use the I<-i> inspection option. How this works is better "
28344 "explained in the L<guestfish(1)> manual page, or by looking at the examples "
28349 #: ../fuse/guestmount.pod:33
28351 "FUSE lets you mount filesystems as non-root. The mountpoint must be owned "
28352 "by you, and the filesystem will not be visible to any other users unless you "
28353 "make certain global configuration changes to C</etc/fuse.conf>. To unmount "
28354 "the filesystem, use the C<fusermount -u> command."
28358 #: ../fuse/guestmount.pod:41
28360 "For a typical Windows guest which has its main filesystem on the first "
28365 #: ../fuse/guestmount.pod:44
28368 " guestmount -a windows.img -m /dev/sda1 --ro /mnt\n"
28373 #: ../fuse/guestmount.pod:46
28375 "For a typical Linux guest which has a /boot filesystem on the first "
28376 "partition, and the root filesystem on a logical volume:"
28380 #: ../fuse/guestmount.pod:49
28383 " guestmount -a linux.img -m /dev/VG/LV -m /dev/sda1:/boot --ro /mnt\n"
28388 #: ../fuse/guestmount.pod:51
28389 msgid "To get libguestfs to detect guest mountpoints for you:"
28393 #: ../fuse/guestmount.pod:53
28396 " guestmount -a guest.img -i --ro /mnt\n"
28401 #: ../fuse/guestmount.pod:55
28402 msgid "For a libvirt guest called \"Guest\" you could do:"
28406 #: ../fuse/guestmount.pod:57
28409 " guestmount -d Guest -i --ro /mnt\n"
28414 #: ../fuse/guestmount.pod:59
28416 "If you don't know what filesystems are contained in a guest or disk image, "
28417 "use L<virt-filesystems(1)> first:"
28421 #: ../fuse/guestmount.pod:62
28424 " virt-filesystems MyGuest\n"
28429 #: ../fuse/guestmount.pod:64
28431 "If you want to trace the libguestfs calls but without excessive debugging "
28432 "information, we recommend:"
28436 #: ../fuse/guestmount.pod:67
28439 " guestmount [...] --trace /mnt\n"
28444 #: ../fuse/guestmount.pod:69
28445 msgid "If you want to debug the program, we recommend:"
28449 #: ../fuse/guestmount.pod:71
28452 " guestmount [...] --trace --verbose /mnt\n"
28457 #: ../fuse/guestmount.pod:77
28458 msgid "B<-a image> | B<--add image>"
28462 #: ../fuse/guestmount.pod:79
28463 msgid "Add a block device or virtual machine image."
28467 #: ../fuse/guestmount.pod:84
28468 msgid "B<-c URI> | B<--connect URI>"
28472 #: ../fuse/guestmount.pod:90
28473 msgid "B<-d libvirt-domain> | B<--domain libvirt-domain>"
28477 #: ../fuse/guestmount.pod:96
28478 msgid "B<--dir-cache-timeout N>"
28482 #: ../fuse/guestmount.pod:98
28484 "Set the readdir cache timeout to I<N> seconds, the default being 60 "
28485 "seconds. The readdir cache [actually, there are several semi-independent "
28486 "caches] is populated after a readdir(2) call with the stat and extended "
28487 "attributes of the files in the directory, in anticipation that they will be "
28488 "requested soon after."
28492 #: ../fuse/guestmount.pod:104
28494 "There is also a different attribute cache implemented by FUSE (see the FUSE "
28495 "option I<-o attr_timeout>), but the FUSE cache does not anticipate future "
28496 "requests, only cache existing ones."
28500 #: ../fuse/guestmount.pod:115
28501 msgid "B<--format=raw|qcow2|..> | B<--format>"
28505 #: ../fuse/guestmount.pod:122
28507 "If you have untrusted raw-format guest disk images, you should use this "
28508 "option to specify the disk format. This avoids a possible security problem "
28509 "with malicious guests (CVE-2010-3851). See also L<guestfs(3)/"
28510 "guestfs_add_drive_opts>."
28514 #: ../fuse/guestmount.pod:127
28515 msgid "B<--fuse-help>"
28519 #: ../fuse/guestmount.pod:129
28520 msgid "Display help on special FUSE options (see I<-o> below)."
28524 #: ../fuse/guestmount.pod:133
28525 msgid "Display brief help and exit."
28529 #: ../fuse/guestmount.pod:135
28530 msgid "B<-i> | B<--inspector>"
28534 #: ../fuse/guestmount.pod:155
28536 "Mount the named partition or logical volume on the given mountpoint B<in the "
28537 "guest> (this has nothing to do with mountpoints in the host)."
28541 #: ../fuse/guestmount.pod:158
28543 "If the mountpoint is omitted, it defaults to C</>. You have to mount "
28544 "something on C</>."
28548 #: ../fuse/guestmount.pod:171
28549 msgid "B<-n> | B<--no-sync>"
28553 #: ../fuse/guestmount.pod:173
28555 "By default, we attempt to sync the guest disk when the FUSE mountpoint is "
28556 "unmounted. If you specify this option, then we don't attempt to sync the "
28557 "disk. See the discussion of autosync in the L<guestfs(3)> manpage."
28561 #: ../fuse/guestmount.pod:178
28562 msgid "B<-o option> | B<--option option>"
28566 #: ../fuse/guestmount.pod:180
28567 msgid "Pass extra options to FUSE."
28571 #: ../fuse/guestmount.pod:182
28573 "To get a list of all the extra options supported by FUSE, use the command "
28574 "below. Note that only the FUSE I<-o> options can be passed, and only some "
28575 "of them are a good idea."
28579 #: ../fuse/guestmount.pod:186
28582 " guestmount --fuse-help\n"
28587 #: ../fuse/guestmount.pod:188
28588 msgid "Some potentially useful FUSE options:"
28592 #: ../fuse/guestmount.pod:192
28593 msgid "B<-o allow_other>"
28597 #: ../fuse/guestmount.pod:194
28598 msgid "Allow other users to see the filesystem."
28602 #: ../fuse/guestmount.pod:196
28603 msgid "B<-o attr_timeout=N>"
28607 #: ../fuse/guestmount.pod:198
28608 msgid "Enable attribute caching by FUSE, and set the timeout to I<N> seconds."
28612 #: ../fuse/guestmount.pod:200
28613 msgid "B<-o kernel_cache>"
28617 #: ../fuse/guestmount.pod:202
28619 "Allow the kernel to cache files (reduces the number of reads that have to go "
28620 "through the L<guestfs(3)> API). This is generally a good idea if you can "
28621 "afford the extra memory usage."
28625 #: ../fuse/guestmount.pod:206
28626 msgid "B<-o uid=N> B<-o gid=N>"
28630 #: ../fuse/guestmount.pod:208
28632 "Use these options to map all UIDs and GIDs inside the guest filesystem to "
28633 "the chosen values."
28637 #: ../fuse/guestmount.pod:213
28638 msgid "B<-r> | B<--ro>"
28642 #: ../fuse/guestmount.pod:215
28644 "Add devices and mount everything read-only. Also disallow writes and make "
28645 "the disk appear read-only to FUSE."
28649 #: ../fuse/guestmount.pod:218
28651 "This is highly recommended if you are not going to edit the guest disk. If "
28652 "the guest is running and this option is I<not> supplied, then there is a "
28653 "strong risk of disk corruption in the guest. We try to prevent this from "
28654 "happening, but it is not always possible."
28658 #: ../fuse/guestmount.pod:223
28659 msgid "See also L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
28663 #: ../fuse/guestmount.pod:227
28664 msgid "Enable SELinux support for the guest."
28668 #: ../fuse/guestmount.pod:229
28669 msgid "B<-v> | B<--verbose>"
28673 #: ../fuse/guestmount.pod:231
28674 msgid "Enable verbose messages from underlying libguestfs."
28678 #: ../fuse/guestmount.pod:233
28679 msgid "B<-V> | B<--version>"
28683 #: ../fuse/guestmount.pod:235
28684 msgid "Display the program version and exit."
28688 #: ../fuse/guestmount.pod:237
28689 msgid "B<-w> | B<--rw>"
28693 #: ../fuse/guestmount.pod:242 ../fuse/guestmount.pod:263
28694 msgid "See L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
28698 #: ../fuse/guestmount.pod:244
28699 msgid "B<-x> | B<--trace>"
28703 #: ../fuse/guestmount.pod:246
28704 msgid "Trace libguestfs calls and entry into each FUSE function."
28708 #: ../fuse/guestmount.pod:248
28709 msgid "This also stops the daemon from forking into the background."
28713 #: ../fuse/guestmount.pod:269
28715 "L<guestfish(1)>, L<virt-inspector(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
28716 "L<virt-tar(1)>, L<guestfs(3)>, L<http://libguestfs.org/>, L<http://fuse.sf."
28721 #: ../fuse/guestmount.pod:284
28722 msgid "Copyright (C) 2009-2010 Red Hat Inc. L<http://libguestfs.org/>"
28726 #: ../tools/virt-edit.pl:34
28727 msgid "virt-edit - Edit a file in a virtual machine"
28731 #: ../tools/virt-edit.pl:38
28734 " virt-edit [--options] domname file\n"
28739 #: ../tools/virt-edit.pl:40
28742 " virt-edit [--options] disk.img [disk.img ...] file\n"
28747 #: ../tools/virt-edit.pl:42
28750 " virt-edit [domname|disk.img] file -e 'expr'\n"
28755 #: ../tools/virt-edit.pl:46
28757 "You must I<not> use C<virt-edit> on live virtual machines. If you do this, "
28758 "you risk disk corruption in the VM. C<virt-edit> tries to stop you from "
28759 "doing this, but doesn't catch all cases."
28763 #: ../tools/virt-edit.pl:52
28765 "C<virt-edit> is a command line tool to edit C<file> where C<file> exists in "
28766 "the named virtual machine (or disk image)."
28770 #: ../tools/virt-edit.pl:55
28771 msgid "If you want to just view a file, use L<virt-cat(1)>."
28775 #: ../tools/virt-edit.pl:57
28777 "For more complex cases you should look at the L<guestfish(1)> tool (see L</"
28778 "USING GUESTFISH> below)."
28782 #: ../tools/virt-edit.pl:60
28784 "C<virt-edit> cannot be used to create a new file, nor to edit multiple "
28785 "files. L<guestfish(1)> can do that and much more."
28789 #: ../tools/virt-edit.pl:65
28790 msgid "Edit the named files interactively:"
28794 #: ../tools/virt-edit.pl:67
28797 " virt-edit mydomain /boot/grub/grub.conf\n"
28802 #: ../tools/virt-edit.pl:69
28805 " virt-edit mydomain /etc/passwd\n"
28810 #: ../tools/virt-edit.pl:71
28811 msgid "For Windows guests, some Windows paths are understood:"
28815 #: ../tools/virt-edit.pl:73
28818 " virt-edit mywindomain 'c:\\autoexec.bat'\n"
28823 #: ../tools/virt-edit.pl:75
28825 "You can also edit files non-interactively (see L</NON-INTERACTIVE EDITING> "
28826 "below). To change the init default level to 5:"
28830 #: ../tools/virt-edit.pl:79
28833 " virt-edit mydomain /etc/inittab -e 's/^id:.*/id:5:initdefault:/'\n"
28838 #: ../tools/virt-edit.pl:91 ../tools/virt-win-reg.pl:106
28839 #: ../tools/virt-list-filesystems.pl:63 ../tools/virt-tar.pl:113
28840 #: ../tools/virt-make-fs.pl:163 ../tools/virt-list-partitions.pl:64
28841 msgid "Display brief help."
28845 #: ../tools/virt-edit.pl:99 ../tools/virt-win-reg.pl:114
28846 #: ../tools/virt-list-filesystems.pl:71 ../tools/virt-tar.pl:121
28847 #: ../tools/virt-make-fs.pl:171 ../tools/virt-list-partitions.pl:72
28848 msgid "Display version number and exit."
28852 #: ../tools/virt-edit.pl:105
28853 msgid "B<--backup extension> | B<-b extension>"
28857 #: ../tools/virt-edit.pl:107
28859 "Create a backup of the original file I<in the guest disk image>. The backup "
28860 "has the original filename with C<extension> added."
28864 #: ../tools/virt-edit.pl:110
28866 "Usually the first character of C<extension> would be a dot C<.> so you would "
28871 #: ../tools/virt-edit.pl:113
28874 " virt-edit -b .orig [etc]\n"
28879 #: ../tools/virt-edit.pl:115
28880 msgid "By default, no backup file is made."
28884 #: ../tools/virt-edit.pl:121 ../tools/virt-win-reg.pl:128
28885 #: ../tools/virt-list-filesystems.pl:77 ../tools/virt-tar.pl:127
28886 #: ../tools/virt-list-partitions.pl:78
28887 msgid "B<--connect URI> | B<-c URI>"
28891 #: ../tools/virt-edit.pl:123 ../tools/virt-win-reg.pl:130
28892 #: ../tools/virt-list-filesystems.pl:79 ../tools/virt-tar.pl:129
28893 #: ../tools/virt-list-partitions.pl:80
28895 "If using libvirt, connect to the given I<URI>. If omitted, then we connect "
28896 "to the default libvirt hypervisor."
28900 #: ../tools/virt-edit.pl:126 ../tools/virt-win-reg.pl:133
28901 #: ../tools/virt-list-filesystems.pl:82 ../tools/virt-tar.pl:132
28902 #: ../tools/virt-list-partitions.pl:83
28904 "If you specify guest block devices directly, then libvirt is not used at all."
28908 #: ../tools/virt-edit.pl:133 ../tools/virt-win-reg.pl:140
28909 #: ../tools/virt-list-filesystems.pl:89 ../tools/virt-tar.pl:139
28910 #: ../tools/virt-list-partitions.pl:90
28911 msgid "B<--format> raw"
28915 #: ../tools/virt-edit.pl:135 ../tools/virt-win-reg.pl:142
28916 #: ../tools/virt-list-filesystems.pl:91 ../tools/virt-tar.pl:141
28917 #: ../tools/virt-list-partitions.pl:92
28919 "Specify the format of disk images given on the command line. If this is "
28920 "omitted then the format is autodetected from the content of the disk image."
28924 #: ../tools/virt-edit.pl:139 ../tools/virt-win-reg.pl:146
28925 #: ../tools/virt-list-filesystems.pl:95 ../tools/virt-tar.pl:145
28926 #: ../tools/virt-list-partitions.pl:96
28928 "If disk images are requested from libvirt, then this program asks libvirt "
28929 "for this information. In this case, the value of the format parameter is "
28934 #: ../tools/virt-edit.pl:143 ../tools/virt-win-reg.pl:150
28935 #: ../tools/virt-list-filesystems.pl:99 ../tools/virt-tar.pl:149
28936 #: ../tools/virt-list-partitions.pl:100
28938 "If working with untrusted raw-format guest disk images, you should ensure "
28939 "the format is always specified."
28943 #: ../tools/virt-edit.pl:150
28944 msgid "B<--expr EXPR> | B<-e EXPR>"
28948 #: ../tools/virt-edit.pl:152
28950 "Instead of launching the external editor, non-interactively apply the Perl "
28951 "expression C<EXPR> to each line in the file. See L</NON-INTERACTIVE "
28956 #: ../tools/virt-edit.pl:156
28958 "Be careful to properly quote the expression to prevent it from being altered "
28963 #: ../tools/virt-edit.pl:280
28964 msgid "NON-INTERACTIVE EDITING"
28968 #: ../tools/virt-edit.pl:282
28970 "C<virt-edit> normally calls out to C<$EDITOR> (or vi) so the system "
28971 "administrator can interactively edit the file."
28975 #: ../tools/virt-edit.pl:285
28977 "There are two ways also to use C<virt-edit> from scripts in order to make "
28978 "automated edits to files. (Note that although you I<can> use C<virt-edit> "
28979 "like this, it's less error-prone to write scripts directly using the "
28980 "libguestfs API and Augeas for configuration file editing.)"
28984 #: ../tools/virt-edit.pl:291
28986 "The first method is to temporarily set C<$EDITOR> to any script or program "
28987 "you want to run. The script is invoked as C<$EDITOR tmpfile> and it should "
28988 "update C<tmpfile> in place however it likes."
28992 #: ../tools/virt-edit.pl:295
28994 "The second method is to use the C<-e> parameter of C<virt-edit> to run a "
28995 "short Perl snippet in the style of L<sed(1)>. For example to replace all "
28996 "instances of C<foo> with C<bar> in a file:"
29000 #: ../tools/virt-edit.pl:299
29003 " virt-edit domname filename -e 's/foo/bar/'\n"
29008 #: ../tools/virt-edit.pl:301
29010 "The full power of Perl regular expressions can be used (see L<perlre(1)>). "
29011 "For example to delete root's password you could do:"
29015 #: ../tools/virt-edit.pl:304
29018 " virt-edit domname /etc/passwd -e 's/^root:.*?:/root::/'\n"
29023 #: ../tools/virt-edit.pl:306
29025 "What really happens is that the snippet is evaluated as a Perl expression "
29026 "for each line of the file. The line, including the final C<\\n>, is passed "
29027 "in C<$_> and the expression should update C<$_> or leave it unchanged."
29031 #: ../tools/virt-edit.pl:311
29033 "To delete a line, set C<$_> to the empty string. For example, to delete the "
29034 "C<apache> user account from the password file you can do:"
29038 #: ../tools/virt-edit.pl:314
29041 " virt-edit mydomain /etc/passwd -e '$_ = \"\" if /^apache:/'\n"
29046 #: ../tools/virt-edit.pl:316
29048 "To insert a line, prepend or append it to C<$_>. However appending lines to "
29049 "the end of the file is rather difficult this way since there is no concept "
29050 "of \"last line of the file\" - your expression just doesn't get called "
29051 "again. You might want to use the first method (setting C<$EDITOR>) if you "
29056 #: ../tools/virt-edit.pl:322
29058 "The variable C<$lineno> contains the current line number. As is "
29059 "traditional, the first line in the file is number C<1>."
29063 #: ../tools/virt-edit.pl:325
29065 "The return value from the expression is ignored, but the expression may call "
29066 "C<die> in order to abort the whole program, leaving the original file "
29071 #: ../tools/virt-edit.pl:329
29073 "Remember when matching the end of a line that C<$_> may contain the final C<"
29074 "\\n>, or (for DOS files) C<\\r\\n>, or if the file does not end with a "
29075 "newline then neither of these. Thus to match or substitute some text at the "
29076 "end of a line, use this regular expression:"
29080 #: ../tools/virt-edit.pl:334
29083 " /some text(\\r?\\n)?$/\n"
29088 #: ../tools/virt-edit.pl:336
29090 "Alternately, use the perl C<chomp> function, being careful not to chomp C<"
29091 "$_> itself (since that would remove all newlines from the file):"
29095 #: ../tools/virt-edit.pl:340
29098 " my $m = $_; chomp $m; $m =~ /some text$/\n"
29103 #: ../tools/virt-edit.pl:344
29105 "C<virt-edit> has a limited ability to understand Windows drive letters and "
29106 "paths (eg. C<E:\\foo\\bar.txt>)."
29110 #: ../tools/virt-edit.pl:347
29111 msgid "If and only if the guest is running Windows then:"
29115 #: ../tools/virt-edit.pl:353
29117 "Drive letter prefixes like C<C:> are resolved against the Windows Registry "
29118 "to the correct filesystem."
29122 #: ../tools/virt-edit.pl:358
29124 "Any backslash (C<\\>) characters in the path are replaced with forward "
29125 "slashes so that libguestfs can process it."
29129 #: ../tools/virt-edit.pl:363
29131 "The path is resolved case insensitively to locate the file that should be "
29136 #: ../tools/virt-edit.pl:368
29137 msgid "There are some known shortcomings:"
29141 #: ../tools/virt-edit.pl:374
29142 msgid "Some NTFS symbolic links may not be followed correctly."
29146 #: ../tools/virt-edit.pl:378
29147 msgid "NTFS junction points that cross filesystems are not followed."
29151 #: ../tools/virt-edit.pl:435
29152 msgid "USING GUESTFISH"
29156 #: ../tools/virt-edit.pl:437
29158 "L<guestfish(1)> is a more powerful, lower level tool which you can use when "
29159 "C<virt-edit> doesn't work."
29163 #: ../tools/virt-edit.pl:440
29164 msgid "Using C<virt-edit> is approximately equivalent to doing:"
29168 #: ../tools/virt-edit.pl:442
29171 " guestfish --rw -i -d domname edit /file\n"
29176 #: ../tools/virt-edit.pl:444
29178 "where C<domname> is the name of the libvirt guest, and C</file> is the full "
29179 "path to the file."
29183 #: ../tools/virt-edit.pl:447
29185 "The command above uses libguestfs's guest inspection feature and so does not "
29186 "work on guests that libguestfs cannot inspect, or on things like arbitrary "
29187 "disk images that don't contain guests. To edit a file on a disk image "
29192 #: ../tools/virt-edit.pl:452
29195 " guestfish --rw -a disk.img -m /dev/sda1 edit /file\n"
29200 #: ../tools/virt-edit.pl:454
29202 "where C<disk.img> is the disk image, C</dev/sda1> is the filesystem within "
29203 "the disk image to edit, and C</file> is the full path to the file."
29207 #: ../tools/virt-edit.pl:458
29209 "C<virt-edit> cannot create new files. Use the guestfish commands C<touch>, "
29210 "C<write> or C<upload> instead:"
29214 #: ../tools/virt-edit.pl:461
29217 " guestfish --rw -i -d domname touch /newfile\n"
29222 #: ../tools/virt-edit.pl:463
29225 " guestfish --rw -i -d domname write /newfile \"new content\"\n"
29230 #: ../tools/virt-edit.pl:465
29233 " guestfish --rw -i -d domname upload localfile /newfile\n"
29238 #: ../tools/virt-edit.pl:467
29240 "C<virt-edit> cannot edit multiple files, but guestfish can do it like this:"
29244 #: ../tools/virt-edit.pl:470
29247 " guestfish --rw -i -d domname edit /file1 : edit /file2\n"
29252 #: ../tools/virt-edit.pl:480
29257 #: ../tools/virt-edit.pl:482
29259 "If set, this string is used as the editor. It may contain arguments, eg. C<"
29264 #: ../tools/virt-edit.pl:485
29265 msgid "If not set, C<vi> is used."
29269 #: ../tools/virt-edit.pl:489 ../tools/virt-win-reg.pl:559
29270 #: ../tools/virt-list-filesystems.pl:182 ../tools/virt-tar.pl:279
29271 #: ../tools/virt-make-fs.pl:532 ../tools/virt-list-partitions.pl:250
29272 msgid "SHELL QUOTING"
29276 #: ../tools/virt-edit.pl:491 ../tools/virt-win-reg.pl:567
29277 #: ../tools/virt-list-filesystems.pl:184 ../tools/virt-tar.pl:281
29278 #: ../tools/virt-make-fs.pl:534 ../tools/virt-list-partitions.pl:252
29280 "Libvirt guest names can contain arbitrary characters, some of which have "
29281 "meaning to the shell such as C<#> and space. You may need to quote or "
29282 "escape these characters on the command line. See the shell manual page L<sh"
29283 "(1)> for details."
29287 #: ../tools/virt-edit.pl:498
29289 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, L<virt-"
29290 "tar-in(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, "
29291 "L<http://libguestfs.org/>, L<perl(1)>, L<perlre(1)>."
29295 #: ../tools/virt-edit.pl:510 ../tools/virt-win-reg.pl:598
29296 #: ../tools/virt-list-filesystems.pl:202 ../tools/virt-tar.pl:301
29297 #: ../tools/virt-make-fs.pl:564 ../tools/virt-list-partitions.pl:269
29302 #: ../tools/virt-edit.pl:512 ../tools/virt-win-reg.pl:600
29303 #: ../tools/virt-list-filesystems.pl:204 ../tools/virt-tar.pl:303
29304 #: ../tools/virt-make-fs.pl:566 ../tools/virt-list-partitions.pl:271
29305 msgid "Richard W.M. Jones L<http://people.redhat.com/~rjones/>"
29309 #: ../tools/virt-edit.pl:516
29310 msgid "Copyright (C) 2009-2011 Red Hat Inc."
29314 #: ../tools/virt-win-reg.pl:37
29316 "virt-win-reg - Export and merge Windows Registry entries from a Windows guest"
29320 #: ../tools/virt-win-reg.pl:41
29323 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey'\n"
29328 #: ../tools/virt-win-reg.pl:43
29331 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' name\n"
29336 #: ../tools/virt-win-reg.pl:45
29339 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' @\n"
29344 #: ../tools/virt-win-reg.pl:47
29347 " virt-win-reg --merge domname [input.reg ...]\n"
29352 #: ../tools/virt-win-reg.pl:49
29355 " virt-win-reg [--options] disk.img ... # instead of domname\n"
29360 #: ../tools/virt-win-reg.pl:53
29362 "You must I<not> use C<virt-win-reg> with the C<--merge> option on live "
29363 "virtual machines. If you do this, you I<will> get irreversible disk "
29364 "corruption in the VM. C<virt-win-reg> tries to stop you from doing this, "
29365 "but doesn't catch all cases."
29369 #: ../tools/virt-win-reg.pl:58
29371 "Modifying the Windows Registry is an inherently risky operation. The format "
29372 "is deliberately obscure and undocumented, and Registry changes can leave the "
29373 "system unbootable. Therefore when using the C<--merge> option, make sure "
29374 "you have a reliable backup first."
29378 #: ../tools/virt-win-reg.pl:65
29380 "This program can export and merge Windows Registry entries from a Windows "
29385 #: ../tools/virt-win-reg.pl:68
29387 "The first parameter is the libvirt guest name or the raw disk image of a "
29392 #: ../tools/virt-win-reg.pl:71
29394 "If C<--merge> is I<not> specified, then the chosen registry key is displayed/"
29395 "exported (recursively). For example:"
29399 #: ../tools/virt-win-reg.pl:74
29402 " $ virt-win-reg Windows7 'HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft'\n"
29407 #: ../tools/virt-win-reg.pl:76
29409 "You can also display single values from within registry keys, for example:"
29413 #: ../tools/virt-win-reg.pl:79
29416 " $ cvkey='HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion'\n"
29417 " $ virt-win-reg Windows7 $cvkey ProductName\n"
29418 " Windows 7 Enterprise\n"
29423 #: ../tools/virt-win-reg.pl:83
29425 "With C<--merge>, you can merge a textual regedit file into the Windows "
29430 #: ../tools/virt-win-reg.pl:86
29433 " $ virt-win-reg --merge Windows7 changes.reg\n"
29438 #: ../tools/virt-win-reg.pl:88 ../tools/virt-tar.pl:45
29443 #: ../tools/virt-win-reg.pl:90
29445 "This program is only meant for simple access to the registry. If you want "
29446 "to do complicated things with the registry, we suggest you download the "
29447 "Registry hive files from the guest using L<libguestfs(3)> or L<guestfish(1)> "
29448 "and access them locally, eg. using L<hivex(3)>, L<hivexsh(1)> or "
29449 "L<hivexregedit(1)>."
29453 #: ../tools/virt-win-reg.pl:120 ../tools/virt-make-fs.pl:177
29458 #: ../tools/virt-win-reg.pl:122
29459 msgid "Enable debugging messages."
29463 #: ../tools/virt-win-reg.pl:157
29468 #: ../tools/virt-win-reg.pl:159
29470 "In merge mode, this merges a textual regedit file into the Windows Registry "
29471 "of the virtual machine. If this flag is I<not> given then virt-win-reg "
29472 "displays or exports Registry entries instead."
29476 #: ../tools/virt-win-reg.pl:163
29478 "Note that C<--merge> is I<unsafe> to use on live virtual machines, and will "
29479 "result in disk corruption. However exporting (without this flag) is always "
29484 #: ../tools/virt-win-reg.pl:171
29485 msgid "B<--encoding> UTF-16LE|ASCII"
29489 #: ../tools/virt-win-reg.pl:173
29491 "When merging (only), you may need to specify the encoding for strings to be "
29492 "used in the hive file. This is explained in detail in L<Win::Hivex::Regedit"
29493 "(3)/ENCODING STRINGS>."
29497 #: ../tools/virt-win-reg.pl:177
29499 "The default is to use UTF-16LE, which should work with recent versions of "
29504 #: ../tools/virt-win-reg.pl:402
29505 msgid "SUPPORTED SYSTEMS"
29509 #: ../tools/virt-win-reg.pl:404
29511 "The program currently supports Windows NT-derived guests starting with "
29512 "Windows XP through to at least Windows 7."
29516 #: ../tools/virt-win-reg.pl:407
29518 "Registry support is done for C<HKEY_LOCAL_MACHINE\\SAM>, C<HKEY_LOCAL_MACHINE"
29519 "\\SECURITY>, C<HKEY_LOCAL_MACHINE\\SOFTWARE>, C<HKEY_LOCAL_MACHINE\\SYSTEM> "
29520 "and C<HKEY_USERS\\.DEFAULT>."
29524 #: ../tools/virt-win-reg.pl:411
29526 "You can use C<HKLM> as a shorthand for C<HKEY_LOCAL_MACHINE>, and C<HKU> for "
29531 #: ../tools/virt-win-reg.pl:414
29533 "C<HKEY_USERS\\$SID> and C<HKEY_CURRENT_USER> are B<not> supported at this "
29538 #: ../tools/virt-win-reg.pl:417
29543 #: ../tools/virt-win-reg.pl:419
29545 "C<virt-win-reg> expects that regedit files have already been reencoded in "
29546 "the local encoding. Usually on Linux hosts, this means UTF-8 with Unix-"
29547 "style line endings. Since Windows regedit files are often in UTF-16LE with "
29548 "Windows-style line endings, you may need to reencode the whole file before "
29549 "or after processing."
29553 #: ../tools/virt-win-reg.pl:425
29555 "To reencode a file from Windows format to Linux (before processing it with "
29556 "the C<--merge> option), you would do something like this:"
29560 #: ../tools/virt-win-reg.pl:428
29563 " iconv -f utf-16le -t utf-8 < win.reg | dos2unix > linux.reg\n"
29568 #: ../tools/virt-win-reg.pl:430
29570 "To go in the opposite direction, after exporting and before sending the file "
29571 "to a Windows user, do something like this:"
29575 #: ../tools/virt-win-reg.pl:433
29578 " unix2dos linux.reg | iconv -f utf-8 -t utf-16le > win.reg\n"
29583 #: ../tools/virt-win-reg.pl:435
29584 msgid "For more information about encoding, see L<Win::Hivex::Regedit(3)>."
29588 #: ../tools/virt-win-reg.pl:437
29590 "If you are unsure about the current encoding, use the L<file(1)> command. "
29591 "Recent versions of Windows regedit.exe produce a UTF-16LE file with Windows-"
29592 "style (CRLF) line endings, like this:"
29596 #: ../tools/virt-win-reg.pl:441
29599 " $ file software.reg\n"
29600 " software.reg: Little-endian UTF-16 Unicode text, with very long lines,\n"
29601 " with CRLF line terminators\n"
29606 #: ../tools/virt-win-reg.pl:445
29607 msgid "This file would need conversion before you could C<--merge> it."
29611 #: ../tools/virt-win-reg.pl:447
29612 msgid "CurrentControlSet etc."
29616 #: ../tools/virt-win-reg.pl:449
29618 "Registry keys like C<CurrentControlSet> don't really exist in the Windows "
29619 "Registry at the level of the hive file, and therefore you cannot modify "
29624 #: ../tools/virt-win-reg.pl:453
29626 "C<CurrentControlSet> is usually an alias for C<ControlSet001>. In some "
29627 "circumstances it might refer to another control set. The way to find out is "
29628 "to look at the C<HKLM\\SYSTEM\\Select> key:"
29632 #: ../tools/virt-win-reg.pl:457
29635 " # virt-win-reg WindowsGuest 'HKLM\\SYSTEM\\Select'\n"
29636 " [HKEY_LOCAL_MACHINE\\SYSTEM\\Select]\n"
29637 " \"Current\"=dword:00000001\n"
29638 " \"Default\"=dword:00000001\n"
29639 " \"Failed\"=dword:00000000\n"
29640 " \"LastKnownGood\"=dword:00000002\n"
29645 #: ../tools/virt-win-reg.pl:464
29646 msgid "\"Current\" is the one which Windows will choose when it boots."
29650 #: ../tools/virt-win-reg.pl:466
29652 "Similarly, other C<Current...> keys in the path may need to be replaced."
29656 #: ../tools/virt-win-reg.pl:469
29657 msgid "WINDOWS TIPS"
29661 #: ../tools/virt-win-reg.pl:471
29663 "Note that some of these tips modify the guest disk image. The guest I<must> "
29664 "be shut off, else you will get disk corruption."
29668 #: ../tools/virt-win-reg.pl:474
29669 msgid "RUNNING A BATCH SCRIPT WHEN A USER LOGS IN"
29673 #: ../tools/virt-win-reg.pl:476
29675 "Prepare a DOS batch script, VBScript or executable. Upload this using "
29676 "L<guestfish(1)>. For this example the script is called C<test.bat> and it "
29677 "is uploaded into C<C:\\>:"
29681 #: ../tools/virt-win-reg.pl:480
29684 " guestfish -i -d WindowsGuest upload test.bat /test.bat\n"
29689 #: ../tools/virt-win-reg.pl:482
29690 msgid "Prepare a regedit file containing the registry change:"
29694 #: ../tools/virt-win-reg.pl:484
29697 " cat > test.reg <<'EOF'\n"
29698 " [HKLM\\Software\\Microsoft\\Windows\\CurrentVersion\\RunOnce]\n"
29699 " \"Test\"=\"c:\\\\test.bat\"\n"
29705 #: ../tools/virt-win-reg.pl:489
29707 "In this example we use the key C<RunOnce> which means that the script will "
29708 "run precisely once when the first user logs in. If you want it to run every "
29709 "time a user logs in, replace C<RunOnce> with C<Run>."
29713 #: ../tools/virt-win-reg.pl:493
29714 msgid "Now update the registry:"
29718 #: ../tools/virt-win-reg.pl:495
29721 " virt-win-reg --merge WindowsGuest test.reg\n"
29726 #: ../tools/virt-win-reg.pl:497
29727 msgid "INSTALLING A SERVICE"
29731 #: ../tools/virt-win-reg.pl:499
29733 "This section assumes you are familiar with Windows services, and you either "
29734 "have a program which handles the Windows Service Control Protocol directly "
29735 "or you want to run any program using a service wrapper like SrvAny or the "
29740 #: ../tools/virt-win-reg.pl:504
29742 "First upload the program and optionally the service wrapper. In this case "
29743 "the test program is called C<test.exe> and we are using the RHSrvAny wrapper:"
29747 #: ../tools/virt-win-reg.pl:508
29750 " guestfish -i -d WindowsGuest <<EOF\n"
29751 " upload rhsrvany.exe /rhsrvany.exe\n"
29752 " upload test.exe /test.exe\n"
29758 #: ../tools/virt-win-reg.pl:513
29760 "Prepare a regedit file containing the registry changes. In this example, "
29761 "the first registry change is needed for the service itself or the service "
29762 "wrapper (if used). The second registry change is only needed because I am "
29763 "using the RHSrvAny service wrapper."
29767 #: ../tools/virt-win-reg.pl:518
29770 " cat > service.reg <<'EOF'\n"
29771 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny]\n"
29772 " \"Type\"=dword:00000010\n"
29773 " \"Start\"=dword:00000002\n"
29774 " \"ErrorControl\"=dword:00000001\n"
29775 " \"ImagePath\"=\"c:\\\\rhsrvany.exe\"\n"
29776 " \"DisplayName\"=\"RHSrvAny\"\n"
29777 " \"ObjectName\"=\"NetworkService\"\n"
29782 #: ../tools/virt-win-reg.pl:527
29785 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny\\Parameters]\n"
29786 " \"CommandLine\"=\"c:\\\\test.exe\"\n"
29787 " \"PWD\"=\"c:\\\\Temp\"\n"
29793 #: ../tools/virt-win-reg.pl:538
29795 "For use of C<ControlSet001> see the section above in this manual page. You "
29796 "may need to adjust this according to the control set that is in use by the "
29801 #: ../tools/virt-win-reg.pl:544
29803 "C<\"ObjectName\"> controls the privileges that the service will have. An "
29804 "alternative is C<\"ObjectName\"=\"LocalSystem\"> which would be the most "
29805 "privileged account."
29809 #: ../tools/virt-win-reg.pl:550
29811 "For the meaning of the magic numbers, see this Microsoft KB article: "
29812 "L<http://support.microsoft.com/kb/103000>."
29816 #: ../tools/virt-win-reg.pl:555
29817 msgid "Update the registry:"
29821 #: ../tools/virt-win-reg.pl:557
29824 " virt-win-reg --merge WindowsGuest service.reg\n"
29829 #: ../tools/virt-win-reg.pl:561
29831 "Be careful when passing parameters containing C<\\> (backslash) in the "
29832 "shell. Usually you will have to use 'single quotes' or double backslashes "
29833 "(but not both) to protect them from the shell."
29837 #: ../tools/virt-win-reg.pl:565
29838 msgid "Paths and value names are case-insensitive."
29842 #: ../tools/virt-win-reg.pl:574
29844 "L<hivex(3)>, L<hivexsh(1)>, L<hivexregedit(1)>, L<guestfs(3)>, L<guestfish(1)"
29845 ">, L<virt-cat(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Win::Hivex"
29846 "(3)>, L<Win::Hivex::Regedit(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
29850 #: ../tools/virt-win-reg.pl:589 ../tools/virt-make-fs.pl:555
29852 "When reporting bugs, please enable debugging and capture the I<complete> "
29857 #: ../tools/virt-win-reg.pl:592
29860 " export LIBGUESTFS_DEBUG=1\n"
29861 " virt-win-reg --debug [... rest ...] > /tmp/virt-win-reg.log 2>&1\n"
29866 #: ../tools/virt-win-reg.pl:595
29868 "Attach /tmp/virt-win-reg.log to a new bug report at L<https://bugzilla."
29873 #: ../tools/virt-win-reg.pl:604 ../tools/virt-make-fs.pl:570
29874 msgid "Copyright (C) 2010 Red Hat Inc."
29878 #: ../tools/virt-list-filesystems.pl:32
29880 "virt-list-filesystems - List filesystems in a virtual machine or disk image"
29884 #: ../tools/virt-list-filesystems.pl:36
29887 " virt-list-filesystems [--options] domname\n"
29892 #: ../tools/virt-list-filesystems.pl:38
29895 " virt-list-filesystems [--options] disk.img [disk.img ...]\n"
29900 #: ../tools/virt-list-filesystems.pl:42 ../tools/virt-list-partitions.pl:42
29902 "This tool is obsolete. Use L<virt-filesystems(1)> as a more flexible "
29907 #: ../tools/virt-list-filesystems.pl:45
29909 "C<virt-list-filesystems> is a command line tool to list the filesystems that "
29910 "are contained in a virtual machine or disk image."
29914 #: ../tools/virt-list-filesystems.pl:49
29916 "C<virt-list-filesystems> is just a simple wrapper around L<libguestfs(3)> "
29917 "functionality. For more complex cases you should look at the L<guestfish(1)"
29922 #: ../tools/virt-list-filesystems.pl:106 ../tools/virt-list-partitions.pl:115
29923 msgid "B<-l> | B<--long>"
29927 #: ../tools/virt-list-filesystems.pl:108
29929 "With this option, C<virt-list-filesystems> displays the type of each "
29930 "filesystem too (where \"type\" means C<ext3>, C<xfs> etc.)"
29934 #: ../tools/virt-list-filesystems.pl:115
29935 msgid "B<-a> | B<--all>"
29939 #: ../tools/virt-list-filesystems.pl:117
29941 "Normally we only show mountable filesystems. If this option is given then "
29942 "swap devices are shown too."
29946 #: ../tools/virt-list-filesystems.pl:191
29948 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, L<virt-"
29949 "filesystems(1)>, L<virt-list-partitions(1)>, L<Sys::Guestfs(3)>, L<Sys::"
29950 "Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
29954 #: ../tools/virt-list-filesystems.pl:208 ../tools/virt-tar.pl:307
29955 msgid "Copyright (C) 2009 Red Hat Inc."
29959 #: ../tools/virt-tar.pl:33
29960 msgid "virt-tar - Extract or upload files to a virtual machine"
29964 #: ../tools/virt-tar.pl:37
29967 " virt-tar [--options] -x domname directory tarball\n"
29972 #: ../tools/virt-tar.pl:39
29975 " virt-tar [--options] -u domname tarball directory\n"
29980 #: ../tools/virt-tar.pl:41
29983 " virt-tar [--options] disk.img [disk.img ...] -x directory tarball\n"
29988 #: ../tools/virt-tar.pl:43
29991 " virt-tar [--options] disk.img [disk.img ...] -u tarball directory\n"
29996 #: ../tools/virt-tar.pl:47
29998 "This tool is obsolete. Use L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-"
29999 "tar-in(1)>, L<virt-tar-out(1)> as replacements."
30003 #: ../tools/virt-tar.pl:52
30004 msgid "Download C</home> from the VM into a local tarball:"
30008 #: ../tools/virt-tar.pl:54
30011 " virt-tar -x domname /home home.tar\n"
30016 #: ../tools/virt-tar.pl:56
30019 " virt-tar -zx domname /home home.tar.gz\n"
30024 #: ../tools/virt-tar.pl:58
30025 msgid "Upload a local tarball and unpack it inside C</tmp> in the VM:"
30029 #: ../tools/virt-tar.pl:60
30032 " virt-tar -u domname uploadstuff.tar /tmp\n"
30037 #: ../tools/virt-tar.pl:62
30040 " virt-tar -zu domname uploadstuff.tar.gz /tmp\n"
30045 #: ../tools/virt-tar.pl:66
30047 "You must I<not> use C<virt-tar> with the C<-u> option (upload) on live "
30048 "virtual machines. If you do this, you risk disk corruption in the VM. "
30049 "C<virt-tar> tries to stop you from doing this, but doesn't catch all cases."
30053 #: ../tools/virt-tar.pl:71
30055 "You can use C<-x> (extract) on live virtual machines, but you might get "
30056 "inconsistent results or errors if there is filesystem activity inside the "
30057 "VM. If the live VM is synched and quiescent, then C<virt-tar> will usually "
30058 "work, but the only way to guarantee consistent results is if the virtual "
30059 "machine is shut down."
30063 #: ../tools/virt-tar.pl:79
30065 "C<virt-tar> is a general purpose archive tool for downloading and uploading "
30066 "parts of a guest filesystem. There are many possibilities: making backups, "
30067 "uploading data files, snooping on guest activity, fixing or customizing "
30072 #: ../tools/virt-tar.pl:84
30074 "If you want to just view a single file, use L<virt-cat(1)>. If you just "
30075 "want to edit a single file, use L<virt-edit(1)>. For more complex cases you "
30076 "should look at the L<guestfish(1)> tool."
30080 #: ../tools/virt-tar.pl:88
30082 "There are two modes of operation: C<-x> (eXtract) downloads a directory and "
30083 "its contents (recursively) from the virtual machine into a local tarball. "
30084 "C<-u> uploads from a local tarball, unpacking it into a directory inside the "
30085 "virtual machine. You cannot use these two options together."
30089 #: ../tools/virt-tar.pl:94
30091 "In addition, you may need to use the C<-z> (gZip) option to enable "
30092 "compression. When uploading, you have to specify C<-z> if the upload file "
30093 "is compressed because virt-tar won't detect this on its own."
30097 #: ../tools/virt-tar.pl:98
30099 "C<virt-tar> can only handle tar (optionally gzipped) format tarballs. For "
30100 "example it cannot do PKZip files or bzip2 compression. If you want that "
30101 "then you'll have to rebuild the tarballs yourself. (This is a limitation of "
30102 "the L<libguestfs(3)> API)."
30106 #: ../tools/virt-tar.pl:156
30107 msgid "B<-x> | B<--extract> | B<--download>"
30111 #: ../tools/virt-tar.pl:158
30112 msgid "B<-u> | B<--upload>"
30116 #: ../tools/virt-tar.pl:160
30118 "Use C<-x> to extract (download) a directory from a virtual machine to a "
30123 #: ../tools/virt-tar.pl:163
30125 "Use C<-u> to upload and unpack from a local tarball into a virtual machine. "
30126 "Please read the L</WARNING> section above before using this option."
30130 #: ../tools/virt-tar.pl:167
30131 msgid "You must specify exactly one of these options."
30135 #: ../tools/virt-tar.pl:173
30136 msgid "B<-z> | B<--gzip>"
30140 #: ../tools/virt-tar.pl:175
30141 msgid "Specify that the input or output tarball is gzip-compressed."
30145 #: ../tools/virt-tar.pl:288
30147 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, L<virt-copy-"
30148 "in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<Sys::"
30149 "Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs."
30154 #: ../tools/virt-make-fs.pl:37
30155 msgid "virt-make-fs - Make a filesystem from a tar archive or files"
30159 #: ../tools/virt-make-fs.pl:41
30162 " virt-make-fs [--options] input.tar output.img\n"
30167 #: ../tools/virt-make-fs.pl:43
30170 " virt-make-fs [--options] input.tar.gz output.img\n"
30175 #: ../tools/virt-make-fs.pl:45
30178 " virt-make-fs [--options] directory output.img\n"
30183 #: ../tools/virt-make-fs.pl:49
30185 "Virt-make-fs is a command line tool for creating a filesystem from a tar "
30186 "archive or some files in a directory. It is similar to tools like L<mkisofs"
30187 "(1)>, L<genisoimage(1)> and L<mksquashfs(1)>. Unlike those tools, it can "
30188 "create common filesystem types like ext2/3 or NTFS, which can be useful if "
30189 "you want to attach these filesystems to existing virtual machines (eg. to "
30190 "import large amounts of read-only data to a VM)."
30194 #: ../tools/virt-make-fs.pl:57
30195 msgid "Basic usage is:"
30199 #: ../tools/virt-make-fs.pl:59
30202 " virt-make-fs input output\n"
30207 #: ../tools/virt-make-fs.pl:61
30209 "where C<input> is either a directory containing files that you want to add, "
30210 "or a tar archive (either uncompressed tar or gzip-compressed tar); and "
30211 "C<output> is a disk image. The input type is detected automatically. The "
30212 "output disk image defaults to a raw ext2 image unless you specify extra "
30213 "flags (see L</OPTIONS> below)."
30217 #: ../tools/virt-make-fs.pl:67
30218 msgid "EXTRA SPACE"
30222 #: ../tools/virt-make-fs.pl:69
30224 "Unlike formats such as tar and squashfs, a filesystem does not \"just fit\" "
30225 "the files that it contains, but might have extra space. Depending on how "
30226 "you are going to use the output, you might think this extra space is wasted "
30227 "and want to minimize it, or you might want to leave space so that more files "
30228 "can be added later. Virt-make-fs defaults to minimizing the extra space, "
30229 "but you can use the C<--size> flag to leave space in the filesystem if you "
30234 #: ../tools/virt-make-fs.pl:77
30236 "An alternative way to leave extra space but not make the output image any "
30237 "bigger is to use an alternative disk image format (instead of the default "
30238 "\"raw\" format). Using C<--format=qcow2> will use the native QEmu/KVM qcow2 "
30239 "image format (check your hypervisor supports this before using it). This "
30240 "allows you to choose a large C<--size> but the extra space won't actually be "
30241 "allocated in the image until you try to store something in it."
30245 #: ../tools/virt-make-fs.pl:85
30247 "Don't forget that you can also use local commands including L<resize2fs(8)> "
30248 "and L<virt-resize(1)> to resize existing filesystems, or rerun virt-make-fs "
30249 "to build another image from scratch."
30253 #: ../tools/virt-make-fs.pl:89 ../tools/virt-make-fs.pl:123
30254 #: ../tools/virt-make-fs.pl:142
30259 #: ../tools/virt-make-fs.pl:91
30262 " virt-make-fs --format=qcow2 --size=+200M input output.img\n"
30267 #: ../tools/virt-make-fs.pl:93
30268 msgid "FILESYSTEM TYPE"
30272 #: ../tools/virt-make-fs.pl:95
30274 "The default filesystem type is C<ext2>. Just about any filesystem type that "
30275 "libguestfs supports can be used (but I<not> read-only formats like "
30276 "ISO9660). Here are some of the more common choices:"
30280 #: ../tools/virt-make-fs.pl:101
30285 #: ../tools/virt-make-fs.pl:103
30287 "Note that ext3 filesystems contain a journal, typically 1-32 MB in size. If "
30288 "you are not going to use the filesystem in a way that requires the journal, "
30289 "then this is just wasted overhead."
30293 #: ../tools/virt-make-fs.pl:107
30294 msgid "I<ntfs> or I<vfat>"
30298 #: ../tools/virt-make-fs.pl:109
30299 msgid "Useful if exporting data to a Windows guest."
30303 #: ../tools/virt-make-fs.pl:111
30305 "I<Note for vfat>: The tar archive or local directory must only contain files "
30306 "which are owned by root (ie. UID:GID = 0:0). The reason is that the tar "
30307 "program running within libguestfs is unable to change the ownership of non-"
30308 "root files, since vfat itself does not support this."
30312 #: ../tools/virt-make-fs.pl:116
30317 #: ../tools/virt-make-fs.pl:118
30319 "Lower overhead than C<ext2>, but certain limitations on filename length and "
30320 "total filesystem size."
30324 #: ../tools/virt-make-fs.pl:125
30327 " virt-make-fs --type=minix input minixfs.img\n"
30332 #: ../tools/virt-make-fs.pl:127
30333 msgid "TO PARTITION OR NOT TO PARTITION"
30337 #: ../tools/virt-make-fs.pl:129
30338 msgid "Optionally virt-make-fs can add a partition table to the output disk."
30342 #: ../tools/virt-make-fs.pl:131
30344 "Adding a partition can make the disk image more compatible with certain "
30345 "virtualized operating systems which don't expect to see a filesystem "
30346 "directly located on a block device (Linux doesn't care and will happily "
30347 "handle both types)."
30351 #: ../tools/virt-make-fs.pl:136
30353 "On the other hand, if you have a partition table then the output image is no "
30354 "longer a straight filesystem. For example you cannot run L<fsck(8)> "
30355 "directly on a partitioned disk image. (However libguestfs tools such as "
30356 "L<guestfish(1)> and L<virt-resize(1)> can still be used)."
30360 #: ../tools/virt-make-fs.pl:144
30361 msgid "Add an MBR partition:"
30365 #: ../tools/virt-make-fs.pl:146
30368 " virt-make-fs --partition -- input disk.img\n"
30373 #: ../tools/virt-make-fs.pl:148
30375 "If the output disk image could be terabyte-sized or larger, it's better to "
30376 "use an EFI/GPT-compatible partition table:"
30380 #: ../tools/virt-make-fs.pl:151
30383 " virt-make-fs --partition=gpt --size=+4T --format=qcow2 input disk.img\n"
30388 #: ../tools/virt-make-fs.pl:179
30389 msgid "Enable debugging information."
30393 #: ../tools/virt-make-fs.pl:185
30394 msgid "B<--size=E<lt>NE<gt>>"
30398 #: ../tools/virt-make-fs.pl:187
30399 msgid "B<--size=+E<lt>NE<gt>>"
30403 #: ../tools/virt-make-fs.pl:189
30404 msgid "B<-s E<lt>NE<gt>>"
30408 #: ../tools/virt-make-fs.pl:191
30409 msgid "B<-s +E<lt>NE<gt>>"
30413 #: ../tools/virt-make-fs.pl:193
30415 "Use the C<--size> (or C<-s>) option to choose the size of the output image."
30419 #: ../tools/virt-make-fs.pl:196
30421 "If this option is I<not> given, then the output image will be just large "
30422 "enough to contain all the files, with not much wasted space."
30426 #: ../tools/virt-make-fs.pl:199
30428 "To choose a fixed size output disk, specify an absolute number followed by b/"
30429 "K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
30430 "Petabytes or Exabytes. This must be large enough to contain all the input "
30431 "files, else you will get an error."
30435 #: ../tools/virt-make-fs.pl:204
30437 "To leave extra space, specify C<+> (plus sign) and a number followed by b/K/"
30438 "M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
30439 "Petabytes or Exabytes. For example: C<--size=+200M> means enough space for "
30440 "the input files, and (approximately) an extra 200 MB free space."
30444 #: ../tools/virt-make-fs.pl:210
30446 "Note that virt-make-fs estimates free space, and therefore will not produce "
30447 "filesystems containing precisely the free space requested. (It is much more "
30448 "expensive and time-consuming to produce a filesystem which has precisely the "
30449 "desired free space)."
30453 #: ../tools/virt-make-fs.pl:219
30454 msgid "B<--format=E<lt>fmtE<gt>>"
30458 #: ../tools/virt-make-fs.pl:221
30459 msgid "B<-F E<lt>fmtE<gt>>"
30463 #: ../tools/virt-make-fs.pl:223
30464 msgid "Choose the output disk image format."
30468 #: ../tools/virt-make-fs.pl:225
30469 msgid "The default is C<raw> (raw disk image)."
30473 #: ../tools/virt-make-fs.pl:227
30475 "For other choices, see the L<qemu-img(1)> manpage. The only other choice "
30476 "that would really make sense here is C<qcow2>."
30480 #: ../tools/virt-make-fs.pl:234
30481 msgid "B<--type=E<lt>fsE<gt>>"
30485 #: ../tools/virt-make-fs.pl:236
30486 msgid "B<-t E<lt>fsE<gt>>"
30490 #: ../tools/virt-make-fs.pl:238
30491 msgid "Choose the output filesystem type."
30495 #: ../tools/virt-make-fs.pl:240
30496 msgid "The default is C<ext2>."
30500 #: ../tools/virt-make-fs.pl:242
30502 "Any filesystem which is supported read-write by libguestfs can be used here."
30506 #: ../tools/virt-make-fs.pl:249
30507 msgid "B<--partition>"
30511 #: ../tools/virt-make-fs.pl:251
30512 msgid "B<--partition=E<lt>parttypeE<gt>>"
30516 #: ../tools/virt-make-fs.pl:253
30518 "If specified, this flag adds an MBR partition table to the output disk image."
30522 #: ../tools/virt-make-fs.pl:256
30524 "You can change the partition table type, eg. C<--partition=gpt> for large "
30529 #: ../tools/virt-make-fs.pl:259
30531 "Note that if you just use a lonesome C<--partition>, the Perl option parser "
30532 "might consider the next parameter to be the partition type. For example:"
30536 #: ../tools/virt-make-fs.pl:263
30539 " virt-make-fs --partition input.tar ...\n"
30544 #: ../tools/virt-make-fs.pl:265
30546 "would cause virt-make-fs to think you wanted to use a partition type of "
30547 "C<input.tar> which is completely wrong. To avoid this, use C<--> (a double "
30548 "dash) between options and the input file argument:"
30552 #: ../tools/virt-make-fs.pl:269
30555 " virt-make-fs --partition -- input.tar ...\n"
30560 #: ../tools/virt-make-fs.pl:541
30562 "L<guestfish(1)>, L<virt-resize(1)>, L<virt-tar-in(1)>, L<mkisofs(1)>, "
30563 "L<genisoimage(1)>, L<mksquashfs(1)>, L<mke2fs(8)>, L<resize2fs(8)>, L<guestfs"
30564 "(3)>, L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
30568 #: ../tools/virt-make-fs.pl:558
30571 " export LIBGUESTFS_DEBUG=1\n"
30572 " virt-make-fs --debug [...] > /tmp/virt-make-fs.log 2>&1\n"
30577 #: ../tools/virt-make-fs.pl:561
30579 "Attach /tmp/virt-make-fs.log to a new bug report at L<https://bugzilla."
30584 #: ../tools/virt-list-partitions.pl:32
30586 "virt-list-partitions - List partitions in a virtual machine or disk image"
30590 #: ../tools/virt-list-partitions.pl:36
30593 " virt-list-partitions [--options] domname\n"
30598 #: ../tools/virt-list-partitions.pl:38
30601 " virt-list-partitions [--options] disk.img [disk.img ...]\n"
30606 #: ../tools/virt-list-partitions.pl:45
30608 "C<virt-list-partitions> is a command line tool to list the partitions that "
30609 "are contained in a virtual machine or disk image. It is mainly useful as a "
30610 "first step to using L<virt-resize(1)>."
30614 #: ../tools/virt-list-partitions.pl:50
30616 "C<virt-list-partitions> is just a simple wrapper around L<libguestfs(3)> "
30617 "functionality. For more complex cases you should look at the L<guestfish(1)"
30622 #: ../tools/virt-list-partitions.pl:107
30623 msgid "B<-h> | B<--human-readable>"
30627 #: ../tools/virt-list-partitions.pl:109
30628 msgid "Show sizes in human-readable form (eg. \"1G\")."
30632 #: ../tools/virt-list-partitions.pl:117
30634 "With this option, C<virt-list-partitions> displays the type and size of each "
30635 "partition too (where \"type\" means C<ext3>, C<pv> etc.)"
30639 #: ../tools/virt-list-partitions.pl:124
30640 msgid "B<-t> | B<--total>"
30644 #: ../tools/virt-list-partitions.pl:126
30646 "Display the total size of each block device (as a separate row or rows)."
30650 #: ../tools/virt-list-partitions.pl:259
30652 "L<guestfs(3)>, L<guestfish(1)>, L<virt-filesystems(1)>, L<virt-list-"
30653 "filesystems(1)>, L<virt-resize(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib"
30654 "(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
30658 #: ../tools/virt-list-partitions.pl:275
30659 msgid "Copyright (C) 2009-2010 Red Hat Inc."