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-09 18:35+0200\n"
11 "PO-Revision-Date: 2011-04-01 15:39+0000\n"
12 "Last-Translator: yurchor <yurchor@ukr.net>\n"
13 "Language-Team: Ukrainian <trans-uk@lists.fedoraproject.org>\n"
16 "Content-Type: text/plain; charset=UTF-8\n"
17 "Content-Transfer-Encoding: 8bit\n"
18 "Plural-Forms: nplurals=3; plural=(n%10==1 && n%100!=11 ? 0 : n%10>=2 && n"
19 "%10<=4 && (n%100<10 || n%100>=20) ? 1 : 2)\n"
22 #: ../src/guestfs.pod:3 ../fish/guestfish.pod:3
23 #: ../test-tool/libguestfs-test-tool.pod:3 ../fuse/guestmount.pod:3
24 #: ../tools/virt-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:1088
858 #: ../src/guestfs.pod:1092 ../src/guestfs.pod:1096 ../src/guestfs.pod:1101
859 #: ../src/guestfs.pod:1109 ../src/guestfs.pod:1128 ../src/guestfs.pod:1136
860 #: ../src/guestfs.pod:1158 ../src/guestfs.pod:1162 ../src/guestfs.pod:1166
861 #: ../src/guestfs.pod:1170 ../src/guestfs.pod:1174 ../src/guestfs.pod:1178
862 #: ../src/guestfs.pod:1660 ../src/guestfs.pod:1665 ../src/guestfs.pod:1669
863 #: ../src/guestfs.pod:1770 ../src/guestfs.pod:1775 ../src/guestfs.pod:1779
864 #: ../src/guestfs.pod:1789 ../src/guestfs.pod:2023 ../src/guestfs.pod:2028
865 #: ../src/guestfs.pod:2034 ../src/guestfs.pod:2042 ../src/guestfs.pod:2396
866 #: ../src/guestfs.pod:2402 ../src/guestfs.pod:2407 ../src/guestfs.pod:2413
867 #: ../src/guestfs.pod:2878 ../src/guestfs.pod:2882 ../src/guestfs.pod:2886
868 #: ../src/guestfs.pod:2890 ../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:1281 ../src/guestfs.pod:1412
1025 #: ../src/guestfs.pod:2441
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:1285 ../src/guestfs.pod:1416
1044 #: ../src/guestfs.pod:2466
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:1422
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 are outside the scope of libguestfs. You have to use "
1367 "libguestfs to read the appropriate Windows Registry and configuration files, "
1368 "to determine yourself how drives are mapped (see also L<hivex(3)> and L<virt-"
1373 #: ../src/guestfs.pod:649
1375 "Replacing backslash characters with forward slash characters is also outside "
1376 "the scope of libguestfs, but something that you can easily do."
1380 #: ../src/guestfs.pod:652
1382 "Where we can help is in resolving the case insensitivity of paths. For "
1383 "this, call L</guestfs_case_sensitive_path>."
1387 #: ../src/guestfs.pod:655
1388 msgid "ACCESSING THE WINDOWS REGISTRY"
1392 #: ../src/guestfs.pod:657
1394 "Libguestfs also provides some help for decoding Windows Registry \"hive\" "
1395 "files, through the library C<hivex> which is part of the libguestfs project "
1396 "although ships as a separate tarball. You have to locate and download the "
1397 "hive file(s) yourself, and then pass them to C<hivex> functions. See also "
1398 "the programs L<hivexml(1)>, L<hivexsh(1)>, L<hivexregedit(1)> and L<virt-win-"
1399 "reg(1)> for more help on this issue."
1403 #: ../src/guestfs.pod:665
1404 msgid "SYMLINKS ON NTFS-3G FILESYSTEMS"
1408 #: ../src/guestfs.pod:667
1410 "Ntfs-3g tries to rewrite \"Junction Points\" and NTFS \"symbolic links\" to "
1411 "provide something which looks like a Linux symlink. The way it tries to do "
1412 "the rewriting is described here:"
1416 #: ../src/guestfs.pod:671
1418 "L<http://www.tuxera.com/community/ntfs-3g-advanced/junction-points-and-"
1421 "L<http://www.tuxera.com/community/ntfs-3g-advanced/junction-points-and-"
1425 #: ../src/guestfs.pod:673
1427 "The essential problem is that ntfs-3g simply does not have enough "
1428 "information to do a correct job. NTFS links can contain drive letters and "
1429 "references to external device GUIDs that ntfs-3g has no way of resolving. "
1430 "It is almost certainly the case that libguestfs callers should ignore what "
1431 "ntfs-3g does (ie. don't use L</guestfs_readlink> on NTFS volumes)."
1435 #: ../src/guestfs.pod:680
1437 "Instead if you encounter a symbolic link on an ntfs-3g filesystem, use L</"
1438 "guestfs_lgetxattr> to read the C<system.ntfs_reparse_data> extended "
1439 "attribute, and read the raw reparse data from that (you can find the format "
1440 "documented in various places around the web)."
1444 #: ../src/guestfs.pod:685
1445 msgid "EXTENDED ATTRIBUTES ON NTFS-3G FILESYSTEMS"
1449 #: ../src/guestfs.pod:687
1451 "There are other useful extended attributes that can be read from ntfs-3g "
1452 "filesystems (using L</guestfs_getxattr>). See:"
1456 #: ../src/guestfs.pod:690
1458 "L<http://www.tuxera.com/community/ntfs-3g-advanced/extended-attributes/>"
1460 "L<http://www.tuxera.com/community/ntfs-3g-advanced/extended-attributes/>"
1463 #: ../src/guestfs.pod:692
1464 msgid "USING LIBGUESTFS WITH OTHER PROGRAMMING LANGUAGES"
1468 #: ../src/guestfs.pod:694
1470 "Although we don't want to discourage you from using the C API, we will "
1471 "mention here that the same API is also available in other languages."
1475 #: ../src/guestfs.pod:697
1477 "The API is broadly identical in all supported languages. This means that "
1478 "the C call C<guestfs_add_drive_ro(g,file)> is C<$g-E<gt>add_drive_ro($file)> "
1479 "in Perl, C<g.add_drive_ro(file)> in Python, and C<g#add_drive_ro file> in "
1480 "OCaml. In other words, a straightforward, predictable isomorphism between "
1485 #: ../src/guestfs.pod:703
1487 "Error messages are automatically transformed into exceptions if the language "
1492 #: ../src/guestfs.pod:706
1494 "We don't try to \"object orientify\" parts of the API in OO languages, "
1495 "although contributors are welcome to write higher level APIs above what we "
1496 "provide in their favourite languages if they wish."
1500 #: ../src/guestfs.pod:712
1505 #: ../src/guestfs.pod:714
1507 "You can use the I<guestfs.h> header file from C++ programs. The C++ API is "
1508 "identical to the C API. C++ classes and exceptions are not used."
1512 #: ../src/guestfs.pod:718
1517 #: ../src/guestfs.pod:720
1519 "The C# bindings are highly experimental. Please read the warnings at the "
1520 "top of C<csharp/Libguestfs.cs>."
1524 #: ../src/guestfs.pod:723
1529 #: ../src/guestfs.pod:725
1531 "This is the only language binding that is working but incomplete. Only "
1532 "calls which return simple integers have been bound in Haskell, and we are "
1533 "looking for help to complete this binding."
1537 #: ../src/guestfs.pod:729
1542 #: ../src/guestfs.pod:731
1544 "Full documentation is contained in the Javadoc which is distributed with "
1549 #: ../src/guestfs.pod:734
1554 #: ../src/guestfs.pod:736
1555 msgid "See L<guestfs-ocaml(3)>."
1556 msgstr "Див. L<guestfs-ocaml(3)>."
1559 #: ../src/guestfs.pod:738
1564 #: ../src/guestfs.pod:740
1565 msgid "See L<guestfs-perl(3)> and L<Sys::Guestfs(3)>."
1566 msgstr "Див. L<guestfs-perl(3)> та L<Sys::Guestfs(3)>."
1569 #: ../src/guestfs.pod:742
1574 #: ../src/guestfs.pod:744
1576 "For documentation see C<README-PHP> supplied with libguestfs sources or in "
1577 "the php-libguestfs package for your distribution."
1581 #: ../src/guestfs.pod:747
1582 msgid "The PHP binding only works correctly on 64 bit machines."
1586 #: ../src/guestfs.pod:749
1591 #: ../src/guestfs.pod:751
1592 msgid "See L<guestfs-python(3)>."
1593 msgstr "Див. L<guestfs-python(3)>."
1596 #: ../src/guestfs.pod:753
1601 #: ../src/guestfs.pod:755
1602 msgid "See L<guestfs-ruby(3)>."
1603 msgstr "Див. L<guestfs-ruby(3)>."
1606 #: ../src/guestfs.pod:757
1607 msgid "B<shell scripts>"
1608 msgstr "B<скрипти оболонки>"
1611 #: ../src/guestfs.pod:759
1612 msgid "See L<guestfish(1)>."
1613 msgstr "Див. L<guestfish(1)>."
1616 #: ../src/guestfs.pod:763
1617 msgid "LIBGUESTFS GOTCHAS"
1621 #: ../src/guestfs.pod:765
1623 "L<http://en.wikipedia.org/wiki/Gotcha_(programming)>: \"A feature of a "
1624 "system [...] that works in the way it is documented but is counterintuitive "
1625 "and almost invites mistakes.\""
1629 #: ../src/guestfs.pod:769
1631 "Since we developed libguestfs and the associated tools, there are several "
1632 "things we would have designed differently, but are now stuck with for "
1633 "backwards compatibility or other reasons. If there is ever a libguestfs 2.0 "
1634 "release, you can expect these to change. Beware of them."
1638 #: ../src/guestfs.pod:777
1639 msgid "Autosync / forgetting to sync."
1643 #: ../src/guestfs.pod:779
1645 "When modifying a filesystem from C or another language, you B<must> unmount "
1646 "all filesystems and call L</guestfs_sync> explicitly before you close the "
1647 "libguestfs handle. You can also call:"
1651 #: ../src/guestfs.pod:783
1654 " guestfs_set_autosync (g, 1);\n"
1659 #: ../src/guestfs.pod:785
1661 "to have the unmount/sync done automatically for you when the handle 'g' is "
1662 "closed. (This feature is called \"autosync\", L</guestfs_set_autosync> q.v.)"
1666 #: ../src/guestfs.pod:789
1668 "If you forget to do this, then it is entirely possible that your changes "
1669 "won't be written out, or will be partially written, or (very rarely) that "
1670 "you'll get disk corruption."
1674 #: ../src/guestfs.pod:793
1676 "Note that in L<guestfish(3)> autosync is the default. So quick and dirty "
1677 "guestfish scripts that forget to sync will work just fine, which can make "
1678 "this very puzzling if you are trying to debug a problem."
1682 #: ../src/guestfs.pod:797
1684 "Update: Autosync is enabled by default for all API users starting from "
1685 "libguestfs 1.5.24."
1689 #: ../src/guestfs.pod:800
1690 msgid "Mount option C<-o sync> should not be the default."
1694 #: ../src/guestfs.pod:802
1696 "If you use L</guestfs_mount>, then C<-o sync,noatime> are added implicitly. "
1697 "However C<-o sync> does not add any reliability benefit, but does have a "
1698 "very large performance impact."
1702 #: ../src/guestfs.pod:806
1704 "The work around is to use L</guestfs_mount_options> and set the mount "
1705 "options that you actually want to use."
1709 #: ../src/guestfs.pod:809
1710 msgid "Read-only should be the default."
1714 #: ../src/guestfs.pod:811
1716 "In L<guestfish(3)>, I<--ro> should be the default, and you should have to "
1717 "specify I<--rw> if you want to make changes to the image."
1721 #: ../src/guestfs.pod:814
1722 msgid "This would reduce the potential to corrupt live VM images."
1726 #: ../src/guestfs.pod:816
1728 "Note that many filesystems change the disk when you just mount and unmount, "
1729 "even if you didn't perform any writes. You need to use L</"
1730 "guestfs_add_drive_ro> to guarantee that the disk is not changed."
1734 #: ../src/guestfs.pod:820
1735 msgid "guestfish command line is hard to use."
1739 #: ../src/guestfs.pod:822
1741 "C<guestfish disk.img> doesn't do what people expect (open C<disk.img> for "
1742 "examination). It tries to run a guestfish command C<disk.img> which doesn't "
1743 "exist, so it fails. In earlier versions of guestfish the error message was "
1744 "also unintuitive, but we have corrected this since. Like the Bourne shell, "
1745 "we should have used C<guestfish -c command> to run commands."
1749 #: ../src/guestfs.pod:829
1750 msgid "guestfish megabyte modifiers don't work right on all commands"
1754 #: ../src/guestfs.pod:831
1756 "In recent guestfish you can use C<1M> to mean 1 megabyte (and similarly for "
1757 "other modifiers). What guestfish actually does is to multiply the number "
1758 "part by the modifier part and pass the result to the C API. However this "
1759 "doesn't work for a few APIs which aren't expecting bytes, but are already "
1760 "expecting some other unit (eg. megabytes)."
1764 #: ../src/guestfs.pod:838
1765 msgid "The most common is L</guestfs_lvcreate>. The guestfish command:"
1769 #: ../src/guestfs.pod:840
1772 " lvcreate LV VG 100M\n"
1777 #: ../src/guestfs.pod:842
1779 "does not do what you might expect. Instead because L</guestfs_lvcreate> is "
1780 "already expecting megabytes, this tries to create a 100 I<terabyte> (100 "
1781 "megabytes * megabytes) logical volume. The error message you get from this "
1782 "is also a little obscure."
1786 #: ../src/guestfs.pod:847
1788 "This could be fixed in the generator by specially marking parameters and "
1789 "return values which take bytes or other units."
1793 #: ../src/guestfs.pod:850
1794 msgid "Ambiguity between devices and paths"
1798 #: ../src/guestfs.pod:852
1800 "There is a subtle ambiguity in the API between a device name (eg. C</dev/"
1801 "sdb2>) and a similar pathname. A file might just happen to be called "
1802 "C<sdb2> in the directory C</dev> (consider some non-Unix VM image)."
1806 #: ../src/guestfs.pod:857
1808 "In the current API we usually resolve this ambiguity by having two separate "
1809 "calls, for example L</guestfs_checksum> and L</guestfs_checksum_device>. "
1810 "Some API calls are ambiguous and (incorrectly) resolve the problem by "
1811 "detecting if the path supplied begins with C</dev/>."
1815 #: ../src/guestfs.pod:863
1817 "To avoid both the ambiguity and the need to duplicate some calls, we could "
1818 "make paths/devices into structured names. One way to do this would be to "
1819 "use a notation like grub (C<hd(0,0)>), although nobody really likes this "
1820 "aspect of grub. Another way would be to use a structured type, equivalent "
1821 "to this OCaml type:"
1825 #: ../src/guestfs.pod:869
1828 " type path = Path of string | Device of int | Partition of int * int\n"
1833 #: ../src/guestfs.pod:871
1834 msgid "which would allow you to pass arguments like:"
1838 #: ../src/guestfs.pod:873
1841 " Path \"/foo/bar\"\n"
1842 " Device 1 (* /dev/sdb, or perhaps /dev/sda *)\n"
1843 " Partition (1, 2) (* /dev/sdb2 (or is it /dev/sda2 or /dev/sdb3?) *)\n"
1844 " Path \"/dev/sdb2\" (* not a device *)\n"
1849 #: ../src/guestfs.pod:878
1851 "As you can see there are still problems to resolve even with this "
1852 "representation. Also consider how it might work in guestfish."
1856 #: ../src/guestfs.pod:883
1857 msgid "PROTOCOL LIMITS"
1861 #: ../src/guestfs.pod:885
1863 "Internally libguestfs uses a message-based protocol to pass API calls and "
1864 "their responses to and from a small \"appliance\" (see L</INTERNALS> for "
1865 "plenty more detail about this). The maximum message size used by the "
1866 "protocol is slightly less than 4 MB. For some API calls you may need to be "
1867 "aware of this limit. The API calls which may be affected are individually "
1868 "documented, with a link back to this section of the documentation."
1872 #: ../src/guestfs.pod:893
1874 "A simple call such as L</guestfs_cat> returns its result (the file data) in "
1875 "a simple string. Because this string is at some point internally encoded as "
1876 "a message, the maximum size that it can return is slightly under 4 MB. If "
1877 "the requested file is larger than this then you will get an error."
1881 #: ../src/guestfs.pod:899
1883 "In order to transfer large files into and out of the guest filesystem, you "
1884 "need to use particular calls that support this. The sections L</UPLOADING> "
1885 "and L</DOWNLOADING> document how to do this."
1889 #: ../src/guestfs.pod:903
1891 "You might also consider mounting the disk image using our FUSE filesystem "
1892 "support (L<guestmount(1)>)."
1896 #: ../src/guestfs.pod:906
1897 msgid "KEYS AND PASSPHRASES"
1901 #: ../src/guestfs.pod:908
1903 "Certain libguestfs calls take a parameter that contains sensitive key "
1904 "material, passed in as a C string."
1908 #: ../src/guestfs.pod:911
1910 "In the future we would hope to change the libguestfs implementation so that "
1911 "keys are L<mlock(2)>-ed into physical RAM, and thus can never end up in "
1912 "swap. However this is I<not> done at the moment, because of the complexity "
1913 "of such an implementation."
1917 #: ../src/guestfs.pod:916
1919 "Therefore you should be aware that any key parameter you pass to libguestfs "
1920 "might end up being written out to the swap partition. If this is a concern, "
1921 "scrub the swap partition or don't use libguestfs on encrypted devices."
1925 #: ../src/guestfs.pod:921
1926 msgid "MULTIPLE HANDLES AND MULTIPLE THREADS"
1930 #: ../src/guestfs.pod:923
1932 "All high-level libguestfs actions are synchronous. If you want to use "
1933 "libguestfs asynchronously then you must create a thread."
1937 #: ../src/guestfs.pod:926
1939 "Only use the handle from a single thread. Either use the handle exclusively "
1940 "from one thread, or provide your own mutex so that two threads cannot issue "
1941 "calls on the same handle at the same time."
1945 #: ../src/guestfs.pod:930
1947 "See the graphical program guestfs-browser for one possible architecture for "
1948 "multithreaded programs using libvirt and libguestfs."
1952 #: ../src/guestfs.pod:933
1957 #: ../src/guestfs.pod:935
1959 "Libguestfs needs a supermin appliance, which it finds by looking along an "
1964 #: ../src/guestfs.pod:938
1966 "By default it looks for these in the directory C<$libdir/guestfs> (eg. C</"
1967 "usr/local/lib/guestfs> or C</usr/lib64/guestfs>)."
1971 #: ../src/guestfs.pod:941
1973 "Use L</guestfs_set_path> or set the environment variable L</LIBGUESTFS_PATH> "
1974 "to change the directories that libguestfs will search in. The value is a "
1975 "colon-separated list of paths. The current directory is I<not> searched "
1976 "unless the path contains an empty element or C<.>. For example "
1977 "C<LIBGUESTFS_PATH=:/usr/lib/guestfs> would search the current directory and "
1978 "then C</usr/lib/guestfs>."
1982 #: ../src/guestfs.pod:948
1983 msgid "QEMU WRAPPERS"
1987 #: ../src/guestfs.pod:950
1989 "If you want to compile your own qemu, run qemu from a non-standard location, "
1990 "or pass extra arguments to qemu, then you can write a shell-script wrapper "
1995 #: ../src/guestfs.pod:954
1997 "There is one important rule to remember: you I<must C<exec qemu>> as the "
1998 "last command in the shell script (so that qemu replaces the shell and "
1999 "becomes the direct child of the libguestfs-using program). If you don't do "
2000 "this, then the qemu process won't be cleaned up correctly."
2004 #: ../src/guestfs.pod:959
2006 "Here is an example of a wrapper, where I have built my own copy of qemu from "
2011 #: ../src/guestfs.pod:962
2015 " qemudir=/home/rjones/d/qemu\n"
2016 " exec $qemudir/x86_64-softmmu/qemu-system-x86_64 -L $qemudir/pc-bios \"$@\"\n"
2021 #: ../src/guestfs.pod:966
2023 "Save this script as C</tmp/qemu.wrapper> (or wherever), C<chmod +x>, and "
2024 "then use it by setting the LIBGUESTFS_QEMU environment variable. For "
2029 #: ../src/guestfs.pod:970
2032 " LIBGUESTFS_QEMU=/tmp/qemu.wrapper guestfish\n"
2037 #: ../src/guestfs.pod:972
2039 "Note that libguestfs also calls qemu with the -help and -version options in "
2040 "order to determine features."
2044 #: ../src/guestfs.pod:975
2045 msgid "ATTACHING TO RUNNING DAEMONS"
2049 #: ../src/guestfs.pod:977
2051 "I<Note (1):> This is B<highly experimental> and has a tendency to eat "
2052 "babies. Use with caution."
2056 #: ../src/guestfs.pod:980
2058 "I<Note (2):> This section explains how to attach to a running daemon from a "
2059 "low level perspective. For most users, simply using virt tools such as "
2060 "L<guestfish(1)> with the I<--live> option will \"just work\"."
2064 #: ../src/guestfs.pod:984
2065 msgid "Using guestfs_set_attach_method"
2069 #: ../src/guestfs.pod:986
2071 "By calling L</guestfs_set_attach_method> you can change how the library "
2072 "connects to the C<guestfsd> daemon in L</guestfs_launch> (read L</"
2073 "ARCHITECTURE> for some background)."
2077 #: ../src/guestfs.pod:990
2079 "The normal attach method is C<appliance>, where a small appliance is created "
2080 "containing the daemon, and then the library connects to this."
2084 #: ../src/guestfs.pod:993
2086 "Setting attach method to C<unix:I<path>> (where I<path> is the path of a "
2087 "Unix domain socket) causes L</guestfs_launch> to connect to an existing "
2088 "daemon over the Unix domain socket."
2092 #: ../src/guestfs.pod:997
2094 "The normal use for this is to connect to a running virtual machine that "
2095 "contains a C<guestfsd> daemon, and send commands so you can read and write "
2096 "files inside the live virtual machine."
2100 #: ../src/guestfs.pod:1001
2101 msgid "Using guestfs_add_domain with live flag"
2105 #: ../src/guestfs.pod:1003
2107 "L</guestfs_add_domain> provides some help for getting the correct attach "
2108 "method. If you pass the C<live> option to this function, then (if the "
2109 "virtual machine is running) it will examine the libvirt XML looking for a "
2110 "virtio-serial channel to connect to:"
2114 #: ../src/guestfs.pod:1009
2121 " <channel type='unix'>\n"
2122 " <source mode='bind' path='/path/to/socket'/>\n"
2123 " <target type='virtio' name='org.libguestfs.channel.0'/>\n"
2132 #: ../src/guestfs.pod:1021
2134 "L</guestfs_add_domain> extracts C</path/to/socket> and sets the attach "
2135 "method to C<unix:/path/to/socket>."
2139 #: ../src/guestfs.pod:1024
2141 "Some of the libguestfs tools (including guestfish) support a I<--live> "
2142 "option which is passed through to L</guestfs_add_domain> thus allowing you "
2143 "to attach to and modify live virtual machines."
2147 #: ../src/guestfs.pod:1028
2149 "The virtual machine needs to have been set up beforehand so that it has the "
2150 "virtio-serial channel and so that guestfsd is running inside it."
2154 #: ../src/guestfs.pod:1032
2155 msgid "ABI GUARANTEE"
2159 #: ../src/guestfs.pod:1034
2161 "We guarantee the libguestfs ABI (binary interface), for public, high-level "
2162 "actions as outlined in this section. Although we will deprecate some "
2163 "actions, for example if they get replaced by newer calls, we will keep the "
2164 "old actions forever. This allows you the developer to program in confidence "
2165 "against the libguestfs API."
2169 #: ../src/guestfs.pod:1040
2170 msgid "BLOCK DEVICE NAMING"
2174 #: ../src/guestfs.pod:1042
2176 "In the kernel there is now quite a profusion of schemata for naming block "
2177 "devices (in this context, by I<block device> I mean a physical or virtual "
2178 "hard drive). The original Linux IDE driver used names starting with C</dev/"
2179 "hd*>. SCSI devices have historically used a different naming scheme, C</dev/"
2180 "sd*>. When the Linux kernel I<libata> driver became a popular replacement "
2181 "for the old IDE driver (particularly for SATA devices) those devices also "
2182 "used the C</dev/sd*> scheme. Additionally we now have virtual machines with "
2183 "paravirtualized drivers. This has created several different naming systems, "
2184 "such as C</dev/vd*> for virtio disks and C</dev/xvd*> for Xen PV disks."
2188 #: ../src/guestfs.pod:1054
2190 "As discussed above, libguestfs uses a qemu appliance running an embedded "
2191 "Linux kernel to access block devices. We can run a variety of appliances "
2192 "based on a variety of Linux kernels."
2196 #: ../src/guestfs.pod:1058
2198 "This causes a problem for libguestfs because many API calls use device or "
2199 "partition names. Working scripts and the recipe (example) scripts that we "
2200 "make available over the internet could fail if the naming scheme changes."
2204 #: ../src/guestfs.pod:1063
2206 "Therefore libguestfs defines C</dev/sd*> as the I<standard naming scheme>. "
2207 "Internally C</dev/sd*> names are translated, if necessary, to other names as "
2208 "required. For example, under RHEL 5 which uses the C</dev/hd*> scheme, any "
2209 "device parameter C</dev/sda2> is translated to C</dev/hda2> transparently."
2213 #: ../src/guestfs.pod:1069
2215 "Note that this I<only> applies to parameters. The L</guestfs_list_devices>, "
2216 "L</guestfs_list_partitions> and similar calls return the true names of the "
2217 "devices and partitions as known to the appliance."
2221 #: ../src/guestfs.pod:1074
2222 msgid "ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION"
2226 #: ../src/guestfs.pod:1076
2228 "Usually this translation is transparent. However in some (very rare) cases "
2229 "you may need to know the exact algorithm. Such cases include where you use "
2230 "L</guestfs_config> to add a mixture of virtio and IDE devices to the qemu-"
2231 "based appliance, so have a mixture of C</dev/sd*> and C</dev/vd*> devices."
2235 #: ../src/guestfs.pod:1082
2237 "The algorithm is applied only to I<parameters> which are known to be either "
2238 "device or partition names. Return values from functions such as L</"
2239 "guestfs_list_devices> are never changed."
2243 #: ../src/guestfs.pod:1090
2244 msgid "Is the string a parameter which is a device or partition name?"
2248 #: ../src/guestfs.pod:1094
2249 msgid "Does the string begin with C</dev/sd>?"
2253 #: ../src/guestfs.pod:1098
2255 "Does the named device exist? If so, we use that device. However if I<not> "
2256 "then we continue with this algorithm."
2260 #: ../src/guestfs.pod:1103
2261 msgid "Replace initial C</dev/sd> string with C</dev/hd>."
2265 #: ../src/guestfs.pod:1105
2266 msgid "For example, change C</dev/sda2> to C</dev/hda2>."
2270 #: ../src/guestfs.pod:1107
2271 msgid "If that named device exists, use it. If not, continue."
2275 #: ../src/guestfs.pod:1111
2276 msgid "Replace initial C</dev/sd> string with C</dev/vd>."
2280 #: ../src/guestfs.pod:1113
2281 msgid "If that named device exists, use it. If not, return an error."
2285 #: ../src/guestfs.pod:1117
2286 msgid "PORTABILITY CONCERNS WITH BLOCK DEVICE NAMING"
2290 #: ../src/guestfs.pod:1119
2292 "Although the standard naming scheme and automatic translation is useful for "
2293 "simple programs and guestfish scripts, for larger programs it is best not to "
2294 "rely on this mechanism."
2298 #: ../src/guestfs.pod:1123
2300 "Where possible for maximum future portability programs using libguestfs "
2301 "should use these future-proof techniques:"
2305 #: ../src/guestfs.pod:1130
2307 "Use L</guestfs_list_devices> or L</guestfs_list_partitions> to list actual "
2308 "device names, and then use those names directly."
2312 #: ../src/guestfs.pod:1133
2314 "Since those device names exist by definition, they will never be translated."
2318 #: ../src/guestfs.pod:1138
2320 "Use higher level ways to identify filesystems, such as LVM names, UUIDs and "
2321 "filesystem labels."
2325 #: ../src/guestfs.pod:1143
2330 #: ../src/guestfs.pod:1145
2332 "This section discusses security implications of using libguestfs, "
2333 "particularly with untrusted or malicious guests or disk images."
2337 #: ../src/guestfs.pod:1148
2338 msgid "GENERAL SECURITY CONSIDERATIONS"
2342 #: ../src/guestfs.pod:1150
2344 "Be careful with any files or data that you download from a guest (by "
2345 "\"download\" we mean not just the L</guestfs_download> command but any "
2346 "command that reads files, filenames, directories or anything else from a "
2347 "disk image). An attacker could manipulate the data to fool your program "
2348 "into doing the wrong thing. Consider cases such as:"
2352 #: ../src/guestfs.pod:1160
2353 msgid "the data (file etc) not being present"
2357 #: ../src/guestfs.pod:1164
2358 msgid "being present but empty"
2362 #: ../src/guestfs.pod:1168
2363 msgid "being much larger than normal"
2367 #: ../src/guestfs.pod:1172
2368 msgid "containing arbitrary 8 bit data"
2372 #: ../src/guestfs.pod:1176
2373 msgid "being in an unexpected character encoding"
2377 #: ../src/guestfs.pod:1180
2378 msgid "containing homoglyphs."
2382 #: ../src/guestfs.pod:1184
2383 msgid "SECURITY OF MOUNTING FILESYSTEMS"
2387 #: ../src/guestfs.pod:1186
2389 "When you mount a filesystem under Linux, mistakes in the kernel filesystem "
2390 "(VFS) module can sometimes be escalated into exploits by deliberately "
2391 "creating a malicious, malformed filesystem. These exploits are very severe "
2392 "for two reasons. Firstly there are very many filesystem drivers in the "
2393 "kernel, and many of them are infrequently used and not much developer "
2394 "attention has been paid to the code. Linux userspace helps potential "
2395 "crackers by detecting the filesystem type and automatically choosing the "
2396 "right VFS driver, even if that filesystem type is obscure or unexpected for "
2397 "the administrator. Secondly, a kernel-level exploit is like a local root "
2398 "exploit (worse in some ways), giving immediate and total access to the "
2399 "system right down to the hardware level."
2403 #: ../src/guestfs.pod:1199
2405 "That explains why you should never mount a filesystem from an untrusted "
2406 "guest on your host kernel. How about libguestfs? We run a Linux kernel "
2407 "inside a qemu virtual machine, usually running as a non-root user. The "
2408 "attacker would need to write a filesystem which first exploited the kernel, "
2409 "and then exploited either qemu virtualization (eg. a faulty qemu driver) or "
2410 "the libguestfs protocol, and finally to be as serious as the host kernel "
2411 "exploit it would need to escalate its privileges to root. This multi-step "
2412 "escalation, performed by a static piece of data, is thought to be extremely "
2413 "hard to do, although we never say 'never' about security issues."
2417 #: ../src/guestfs.pod:1210
2419 "In any case callers can reduce the attack surface by forcing the filesystem "
2420 "type when mounting (use L</guestfs_mount_vfs>)."
2424 #: ../src/guestfs.pod:1213
2425 msgid "PROTOCOL SECURITY"
2429 #: ../src/guestfs.pod:1215
2431 "The protocol is designed to be secure, being based on RFC 4506 (XDR) with a "
2432 "defined upper message size. However a program that uses libguestfs must "
2433 "also take care - for example you can write a program that downloads a binary "
2434 "from a disk image and executes it locally, and no amount of protocol "
2435 "security will save you from the consequences."
2439 #: ../src/guestfs.pod:1221
2440 msgid "INSPECTION SECURITY"
2444 #: ../src/guestfs.pod:1223
2446 "Parts of the inspection API (see L</INSPECTION>) return untrusted strings "
2447 "directly from the guest, and these could contain any 8 bit data. Callers "
2448 "should be careful to escape these before printing them to a structured file "
2449 "(for example, use HTML escaping if creating a web page)."
2453 #: ../src/guestfs.pod:1229
2455 "Guest configuration may be altered in unusual ways by the administrator of "
2456 "the virtual machine, and may not reflect reality (particularly for untrusted "
2457 "or actively malicious guests). For example we parse the hostname from "
2458 "configuration files like C</etc/sysconfig/network> that we find in the "
2459 "guest, but the guest administrator can easily manipulate these files to "
2460 "provide the wrong hostname."
2464 #: ../src/guestfs.pod:1237
2466 "The inspection API parses guest configuration using two external libraries: "
2467 "Augeas (Linux configuration) and hivex (Windows Registry). Both are "
2468 "designed to be robust in the face of malicious data, although denial of "
2469 "service attacks are still possible, for example with oversized configuration "
2474 #: ../src/guestfs.pod:1243
2475 msgid "RUNNING UNTRUSTED GUEST COMMANDS"
2479 #: ../src/guestfs.pod:1245
2481 "Be very cautious about running commands from the guest. By running a "
2482 "command in the guest, you are giving CPU time to a binary that you do not "
2483 "control, under the same user account as the library, albeit wrapped in qemu "
2484 "virtualization. More information and alternatives can be found in the "
2485 "section L</RUNNING COMMANDS>."
2489 #: ../src/guestfs.pod:1251
2490 msgid "CVE-2010-3851"
2491 msgstr "CVE-2010-3851"
2494 #: ../src/guestfs.pod:1253
2495 msgid "https://bugzilla.redhat.com/642934"
2496 msgstr "https://bugzilla.redhat.com/642934"
2499 #: ../src/guestfs.pod:1255
2501 "This security bug concerns the automatic disk format detection that qemu "
2502 "does on disk images."
2506 #: ../src/guestfs.pod:1258
2508 "A raw disk image is just the raw bytes, there is no header. Other disk "
2509 "images like qcow2 contain a special header. Qemu deals with this by looking "
2510 "for one of the known headers, and if none is found then assuming the disk "
2511 "image must be raw."
2515 #: ../src/guestfs.pod:1263
2517 "This allows a guest which has been given a raw disk image to write some "
2518 "other header. At next boot (or when the disk image is accessed by "
2519 "libguestfs) qemu would do autodetection and think the disk image format was, "
2520 "say, qcow2 based on the header written by the guest."
2524 #: ../src/guestfs.pod:1268
2526 "This in itself would not be a problem, but qcow2 offers many features, one "
2527 "of which is to allow a disk image to refer to another image (called the "
2528 "\"backing disk\"). It does this by placing the path to the backing disk "
2529 "into the qcow2 header. This path is not validated and could point to any "
2530 "host file (eg. \"/etc/passwd\"). The backing disk is then exposed through "
2531 "\"holes\" in the qcow2 disk image, which of course is completely under the "
2532 "control of the attacker."
2536 #: ../src/guestfs.pod:1276
2538 "In libguestfs this is rather hard to exploit except under two circumstances:"
2542 #: ../src/guestfs.pod:1283
2543 msgid "You have enabled the network or have opened the disk in write mode."
2547 #: ../src/guestfs.pod:1287
2549 "You are also running untrusted code from the guest (see L</RUNNING "
2554 #: ../src/guestfs.pod:1292
2556 "The way to avoid this is to specify the expected disk format when adding "
2557 "disks (the optional C<format> option to L</guestfs_add_drive_opts>). You "
2558 "should always do this if the disk is raw format, and it's a good idea for "
2563 #: ../src/guestfs.pod:1297
2565 "For disks added from libvirt using calls like L</guestfs_add_domain>, the "
2566 "format is fetched from libvirt and passed through."
2570 #: ../src/guestfs.pod:1300
2572 "For libguestfs tools, use the I<--format> command line parameter as "
2577 #: ../src/guestfs.pod:1303
2578 msgid "CONNECTION MANAGEMENT"
2582 #: ../src/guestfs.pod:1305
2587 #: ../src/guestfs.pod:1307
2589 "C<guestfs_h> is the opaque type representing a connection handle. Create a "
2590 "handle by calling L</guestfs_create>. Call L</guestfs_close> to free the "
2591 "handle and release all resources used."
2595 #: ../src/guestfs.pod:1311
2597 "For information on using multiple handles and threads, see the section L</"
2598 "MULTIPLE HANDLES AND MULTIPLE THREADS> below."
2602 #: ../src/guestfs.pod:1314
2603 msgid "guestfs_create"
2607 #: ../src/guestfs.pod:1316
2610 " guestfs_h *guestfs_create (void);\n"
2615 #: ../src/guestfs.pod:1318
2616 msgid "Create a connection handle."
2620 #: ../src/guestfs.pod:1320
2622 "You have to call L</guestfs_add_drive_opts> (or one of the equivalent calls) "
2623 "on the handle at least once."
2627 #: ../src/guestfs.pod:1323
2629 "This function returns a non-NULL pointer to a handle on success or NULL on "
2634 #: ../src/guestfs.pod:1326
2635 msgid "After configuring the handle, you have to call L</guestfs_launch>."
2639 #: ../src/guestfs.pod:1328
2641 "You may also want to configure error handling for the handle. See L</ERROR "
2642 "HANDLING> section below."
2646 #: ../src/guestfs.pod:1331
2647 msgid "guestfs_close"
2651 #: ../src/guestfs.pod:1333
2654 " void guestfs_close (guestfs_h *g);\n"
2659 #: ../src/guestfs.pod:1335
2660 msgid "This closes the connection handle and frees up all resources used."
2664 #: ../src/guestfs.pod:1337
2665 msgid "ERROR HANDLING"
2666 msgstr "ОБРОБКА ПОМИЛОК"
2669 #: ../src/guestfs.pod:1339
2671 "API functions can return errors. For example, almost all functions that "
2672 "return C<int> will return C<-1> to indicate an error."
2676 #: ../src/guestfs.pod:1342
2678 "Additional information is available for errors: an error message string and "
2679 "optionally an error number (errno) if the thing that failed was a system "
2684 #: ../src/guestfs.pod:1346
2686 "You can get at the additional information about the last error on the handle "
2687 "by calling L</guestfs_last_error>, L</guestfs_last_errno>, and/or by setting "
2688 "up an error handler with L</guestfs_set_error_handler>."
2692 #: ../src/guestfs.pod:1351
2694 "When the handle is created, a default error handler is installed which "
2695 "prints the error message string to C<stderr>. For small short-running "
2696 "command line programs it is sufficient to do:"
2700 #: ../src/guestfs.pod:1355
2703 " if (guestfs_launch (g) == -1)\n"
2704 " exit (EXIT_FAILURE);\n"
2709 #: ../src/guestfs.pod:1358
2711 "since the default error handler will ensure that an error message has been "
2712 "printed to C<stderr> before the program exits."
2716 #: ../src/guestfs.pod:1361
2718 "For other programs the caller will almost certainly want to install an "
2719 "alternate error handler or do error handling in-line like this:"
2723 #: ../src/guestfs.pod:1364
2726 " g = guestfs_create ();\n"
2731 #: ../src/guestfs.pod:1366
2734 " /* This disables the default behaviour of printing errors\n"
2736 " guestfs_set_error_handler (g, NULL, NULL);\n"
2741 #: ../src/guestfs.pod:1370
2744 " if (guestfs_launch (g) == -1) {\n"
2745 " /* Examine the error message and print it etc. */\n"
2746 " char *msg = guestfs_last_error (g);\n"
2747 " int errnum = guestfs_last_errno (g);\n"
2748 " fprintf (stderr, \"%s\\n\", msg);\n"
2755 #: ../src/guestfs.pod:1378
2757 "Out of memory errors are handled differently. The default action is to call "
2758 "L<abort(3)>. If this is undesirable, then you can set a handler using L</"
2759 "guestfs_set_out_of_memory_handler>."
2763 #: ../src/guestfs.pod:1382
2765 "L</guestfs_create> returns C<NULL> if the handle cannot be created, and "
2766 "because there is no handle if this happens there is no way to get additional "
2767 "error information. However L</guestfs_create> is supposed to be a "
2768 "lightweight operation which can only fail because of insufficient memory (it "
2769 "returns NULL in this case)."
2773 #: ../src/guestfs.pod:1388
2774 msgid "guestfs_last_error"
2778 #: ../src/guestfs.pod:1390
2781 " const char *guestfs_last_error (guestfs_h *g);\n"
2786 #: ../src/guestfs.pod:1392
2788 "This returns the last error message that happened on C<g>. If there has not "
2789 "been an error since the handle was created, then this returns C<NULL>."
2793 #: ../src/guestfs.pod:1396
2795 "The lifetime of the returned string is until the next error occurs, or L</"
2796 "guestfs_close> is called."
2800 #: ../src/guestfs.pod:1399
2801 msgid "guestfs_last_errno"
2805 #: ../src/guestfs.pod:1401
2808 " int guestfs_last_errno (guestfs_h *g);\n"
2813 #: ../src/guestfs.pod:1403
2814 msgid "This returns the last error number (errno) that happened on C<g>."
2818 #: ../src/guestfs.pod:1405
2819 msgid "If successful, an errno integer not equal to zero is returned."
2823 #: ../src/guestfs.pod:1407
2825 "If no error, this returns 0. This call can return 0 in three situations:"
2829 #: ../src/guestfs.pod:1414
2830 msgid "There has not been any error on the handle."
2834 #: ../src/guestfs.pod:1418
2836 "There has been an error but the errno was meaningless. This corresponds to "
2837 "the case where the error did not come from a failed system call, but for "
2838 "some other reason."
2842 #: ../src/guestfs.pod:1424
2844 "There was an error from a failed system call, but for some reason the errno "
2845 "was not captured and returned. This usually indicates a bug in libguestfs."
2849 #: ../src/guestfs.pod:1430
2851 "Libguestfs tries to convert the errno from inside the applicance into a "
2852 "corresponding errno for the caller (not entirely trivial: the appliance "
2853 "might be running a completely different operating system from the library "
2854 "and error numbers are not standardized across Un*xen). If this could not be "
2855 "done, then the error is translated to C<EINVAL>. In practice this should "
2856 "only happen in very rare circumstances."
2860 #: ../src/guestfs.pod:1438
2861 msgid "guestfs_set_error_handler"
2865 #: ../src/guestfs.pod:1440
2868 " typedef void (*guestfs_error_handler_cb) (guestfs_h *g,\n"
2870 " const char *msg);\n"
2871 " void guestfs_set_error_handler (guestfs_h *g,\n"
2872 " guestfs_error_handler_cb cb,\n"
2878 #: ../src/guestfs.pod:1447
2880 "The callback C<cb> will be called if there is an error. The parameters "
2881 "passed to the callback are an opaque data pointer and the error message "
2886 #: ../src/guestfs.pod:1451
2888 "C<errno> is not passed to the callback. To get that the callback must call "
2889 "L</guestfs_last_errno>."
2893 #: ../src/guestfs.pod:1454
2895 "Note that the message string C<msg> is freed as soon as the callback "
2896 "function returns, so if you want to stash it somewhere you must make your "
2901 #: ../src/guestfs.pod:1458
2902 msgid "The default handler prints messages on C<stderr>."
2906 #: ../src/guestfs.pod:1460
2907 msgid "If you set C<cb> to C<NULL> then I<no> handler is called."
2911 #: ../src/guestfs.pod:1462
2912 msgid "guestfs_get_error_handler"
2916 #: ../src/guestfs.pod:1464
2919 " guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g,\n"
2920 " void **opaque_rtn);\n"
2925 #: ../src/guestfs.pod:1467
2926 msgid "Returns the current error handler callback."
2930 #: ../src/guestfs.pod:1469
2931 msgid "guestfs_set_out_of_memory_handler"
2935 #: ../src/guestfs.pod:1471
2938 " typedef void (*guestfs_abort_cb) (void);\n"
2939 " int guestfs_set_out_of_memory_handler (guestfs_h *g,\n"
2940 " guestfs_abort_cb);\n"
2945 #: ../src/guestfs.pod:1475
2947 "The callback C<cb> will be called if there is an out of memory situation. "
2948 "I<Note this callback must not return>."
2952 #: ../src/guestfs.pod:1478
2953 msgid "The default is to call L<abort(3)>."
2957 #: ../src/guestfs.pod:1480
2959 "You cannot set C<cb> to C<NULL>. You can't ignore out of memory situations."
2963 #: ../src/guestfs.pod:1483
2964 msgid "guestfs_get_out_of_memory_handler"
2968 #: ../src/guestfs.pod:1485
2971 " guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n"
2976 #: ../src/guestfs.pod:1487
2977 msgid "This returns the current out of memory handler."
2981 #: ../src/guestfs.pod:1489
2986 #: ../src/guestfs.pod:1491 ../fish/guestfish.pod:1003
2991 #: ../src/guestfs.pod:1493
2996 #: ../src/guestfs.pod:1495
3001 #: ../src/guestfs.pod:1497
3002 msgid "AVAILABILITY"
3006 #: ../src/guestfs.pod:1499
3007 msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE"
3011 #: ../src/guestfs.pod:1501
3013 "Using L</guestfs_available> you can test availability of the following "
3014 "groups of functions. This test queries the appliance to see if the "
3015 "appliance you are currently using supports the functionality."
3019 #: ../src/guestfs.pod:1506
3020 msgid "@AVAILABILITY@"
3024 #: ../src/guestfs.pod:1508
3025 msgid "GUESTFISH supported COMMAND"
3029 #: ../src/guestfs.pod:1510
3031 "In L<guestfish(3)> there is a handy interactive command C<supported> which "
3032 "prints out the available groups and whether they are supported by this build "
3033 "of libguestfs. Note however that you have to do C<run> first."
3037 #: ../src/guestfs.pod:1515
3038 msgid "SINGLE CALLS AT COMPILE TIME"
3042 #: ../src/guestfs.pod:1517
3044 "Since version 1.5.8, C<E<lt>guestfs.hE<gt>> defines symbols for each C API "
3045 "function, such as:"
3049 #: ../src/guestfs.pod:1520
3052 " #define LIBGUESTFS_HAVE_DD 1\n"
3057 #: ../src/guestfs.pod:1522
3058 msgid "if L</guestfs_dd> is available."
3062 #: ../src/guestfs.pod:1524
3064 "Before version 1.5.8, if you needed to test whether a single libguestfs "
3065 "function is available at compile time, we recommended using build tools such "
3066 "as autoconf or cmake. For example in autotools you could use:"
3070 #: ../src/guestfs.pod:1529
3073 " AC_CHECK_LIB([guestfs],[guestfs_create])\n"
3074 " AC_CHECK_FUNCS([guestfs_dd])\n"
3079 #: ../src/guestfs.pod:1532
3081 "which would result in C<HAVE_GUESTFS_DD> being either defined or not defined "
3086 #: ../src/guestfs.pod:1535
3087 msgid "SINGLE CALLS AT RUN TIME"
3091 #: ../src/guestfs.pod:1537
3093 "Testing at compile time doesn't guarantee that a function really exists in "
3094 "the library. The reason is that you might be dynamically linked against a "
3095 "previous I<libguestfs.so> (dynamic library) which doesn't have the call. "
3096 "This situation unfortunately results in a segmentation fault, which is a "
3097 "shortcoming of the C dynamic linking system itself."
3101 #: ../src/guestfs.pod:1544
3103 "You can use L<dlopen(3)> to test if a function is available at run time, as "
3104 "in this example program (note that you still need the compile time check as "
3109 #: ../src/guestfs.pod:1548
3112 " #include <stdio.h>\n"
3113 " #include <stdlib.h>\n"
3114 " #include <unistd.h>\n"
3115 " #include <dlfcn.h>\n"
3116 " #include <guestfs.h>\n"
3121 #: ../src/guestfs.pod:1554
3126 " #ifdef LIBGUESTFS_HAVE_DD\n"
3128 " int has_function;\n"
3133 #: ../src/guestfs.pod:1560
3136 " /* Test if the function guestfs_dd is really available. */\n"
3137 " dl = dlopen (NULL, RTLD_LAZY);\n"
3139 " fprintf (stderr, \"dlopen: %s\\n\", dlerror ());\n"
3140 " exit (EXIT_FAILURE);\n"
3142 " has_function = dlsym (dl, \"guestfs_dd\") != NULL;\n"
3148 #: ../src/guestfs.pod:1569
3151 " if (!has_function)\n"
3152 " printf (\"this libguestfs.so does NOT have guestfs_dd function\\n\");\n"
3154 " printf (\"this libguestfs.so has guestfs_dd function\\n\");\n"
3155 " /* Now it's safe to call\n"
3156 " guestfs_dd (g, \"foo\", \"bar\");\n"
3160 " printf (\"guestfs_dd function was not found at compile time\\n\");\n"
3167 #: ../src/guestfs.pod:1582
3169 "You may think the above is an awful lot of hassle, and it is. There are "
3170 "other ways outside of the C linking system to ensure that this kind of "
3171 "incompatibility never arises, such as using package versioning:"
3175 #: ../src/guestfs.pod:1587
3178 " Requires: libguestfs >= 1.0.80\n"
3183 #: ../src/guestfs.pod:1589
3184 msgid "CALLS WITH OPTIONAL ARGUMENTS"
3188 #: ../src/guestfs.pod:1591
3190 "A recent feature of the API is the introduction of calls which take optional "
3191 "arguments. In C these are declared 3 ways. The main way is as a call which "
3192 "takes variable arguments (ie. C<...>), as in this example:"
3196 #: ../src/guestfs.pod:1596
3199 " int guestfs_add_drive_opts (guestfs_h *g, const char *filename, ...);\n"
3204 #: ../src/guestfs.pod:1598
3206 "Call this with a list of optional arguments, terminated by C<-1>. So to "
3207 "call with no optional arguments specified:"
3211 #: ../src/guestfs.pod:1601
3214 " guestfs_add_drive_opts (g, filename, -1);\n"
3219 #: ../src/guestfs.pod:1603
3220 msgid "With a single optional argument:"
3224 #: ../src/guestfs.pod:1605
3227 " guestfs_add_drive_opts (g, filename,\n"
3228 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
3234 #: ../src/guestfs.pod:1609
3239 #: ../src/guestfs.pod:1611
3242 " guestfs_add_drive_opts (g, filename,\n"
3243 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
3244 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
3250 #: ../src/guestfs.pod:1616
3252 "and so forth. Don't forget the terminating C<-1> otherwise Bad Things will "
3257 #: ../src/guestfs.pod:1619
3258 msgid "USING va_list FOR OPTIONAL ARGUMENTS"
3262 #: ../src/guestfs.pod:1621
3264 "The second variant has the same name with the suffix C<_va>, which works the "
3265 "same way but takes a C<va_list>. See the C manual for details. For the "
3266 "example function, this is declared:"
3270 #: ../src/guestfs.pod:1625
3273 " int guestfs_add_drive_opts_va (guestfs_h *g, const char *filename,\n"
3279 #: ../src/guestfs.pod:1628
3280 msgid "CONSTRUCTING OPTIONAL ARGUMENTS"
3284 #: ../src/guestfs.pod:1630
3286 "The third variant is useful where you need to construct these calls. You "
3287 "pass in a structure where you fill in the optional fields. The structure "
3288 "has a bitmask as the first element which you must set to indicate which "
3289 "fields you have filled in. For our example function the structure and call "
3294 #: ../src/guestfs.pod:1636
3297 " struct guestfs_add_drive_opts_argv {\n"
3298 " uint64_t bitmask;\n"
3300 " const char *format;\n"
3303 " int guestfs_add_drive_opts_argv (guestfs_h *g, const char *filename,\n"
3304 " const struct guestfs_add_drive_opts_argv *optargs);\n"
3309 #: ../src/guestfs.pod:1645
3310 msgid "You could call it like this:"
3314 #: ../src/guestfs.pod:1647
3317 " struct guestfs_add_drive_opts_argv optargs = {\n"
3318 " .bitmask = GUESTFS_ADD_DRIVE_OPTS_READONLY_BITMASK |\n"
3319 " GUESTFS_ADD_DRIVE_OPTS_FORMAT_BITMASK,\n"
3321 " .format = \"qcow2\"\n"
3327 #: ../src/guestfs.pod:1654
3330 " guestfs_add_drive_opts_argv (g, filename, &optargs);\n"
3335 #: ../src/guestfs.pod:1656 ../src/guestfs-actions.pod:11
3336 #: ../src/guestfs-actions.pod:1855 ../fish/guestfish-actions.pod:9
3337 #: ../fish/guestfish-actions.pod:1260 ../tools/virt-win-reg.pl:532
3342 #: ../src/guestfs.pod:1662
3343 msgid "The C<_BITMASK> suffix on each option name when specifying the bitmask."
3347 #: ../src/guestfs.pod:1667
3348 msgid "You do not need to fill in all fields of the structure."
3352 #: ../src/guestfs.pod:1671
3354 "There must be a one-to-one correspondence between fields of the structure "
3355 "that are filled in, and bits set in the bitmask."
3359 #: ../src/guestfs.pod:1676
3360 msgid "OPTIONAL ARGUMENTS IN OTHER LANGUAGES"
3364 #: ../src/guestfs.pod:1678
3366 "In other languages, optional arguments are expressed in the way that is "
3367 "natural for that language. We refer you to the language-specific "
3368 "documentation for more details on that."
3372 #: ../src/guestfs.pod:1682
3373 msgid "For guestfish, see L<guestfish(1)/OPTIONAL ARGUMENTS>."
3377 #: ../src/guestfs.pod:1684
3378 msgid "SETTING CALLBACKS TO HANDLE EVENTS"
3382 #: ../src/guestfs.pod:1686
3384 "B<Note:> This section documents the generic event mechanism introduced in "
3385 "libguestfs 1.10, which you should use in new code if possible. The old "
3386 "functions C<guestfs_set_log_message_callback>, "
3387 "C<guestfs_set_subprocess_quit_callback>, "
3388 "C<guestfs_set_launch_done_callback>, C<guestfs_set_close_callback> and "
3389 "C<guestfs_set_progress_callback> are no longer documented in this manual "
3394 #: ../src/guestfs.pod:1694
3396 "Handles generate events when certain things happen, such as log messages "
3397 "being generated, progress messages during long-running operations, or the "
3398 "handle being closed. The API calls described below let you register a "
3399 "callback to be called when events happen. You can register multiple "
3400 "callbacks (for the same, different or overlapping sets of events), and "
3401 "individually remove callbacks. If callbacks are not removed, then they "
3402 "remain in force until the handle is closed."
3406 #: ../src/guestfs.pod:1702
3408 "In the current implementation, events are only generated synchronously: that "
3409 "means that events (and hence callbacks) can only happen while you are in the "
3410 "middle of making another libguestfs call. The callback is called in the "
3415 #: ../src/guestfs.pod:1707
3417 "Events may contain a payload, usually nothing (void), an array of 64 bit "
3418 "unsigned integers, or a message buffer. Payloads are discussed later on."
3422 #: ../src/guestfs.pod:1711
3423 msgid "CLASSES OF EVENTS"
3427 #: ../src/guestfs.pod:1715
3428 msgid "GUESTFS_EVENT_CLOSE (payload type: void)"
3432 #: ../src/guestfs.pod:1718
3434 "The callback function will be called while the handle is being closed "
3435 "(synchronously from L</guestfs_close>)."
3439 #: ../src/guestfs.pod:1721
3441 "Note that libguestfs installs an L<atexit(3)> handler to try to clean up "
3442 "handles that are open when the program exits. This means that this callback "
3443 "might be called indirectly from L<exit(3)>, which can cause unexpected "
3444 "problems in higher-level languages (eg. if your HLL interpreter has already "
3445 "been cleaned up by the time this is called, and if your callback then jumps "
3446 "into some HLL function)."
3450 #: ../src/guestfs.pod:1728
3452 "If no callback is registered: the handle is closed without any callback "
3457 #: ../src/guestfs.pod:1731
3458 msgid "GUESTFS_EVENT_SUBPROCESS_QUIT (payload type: void)"
3462 #: ../src/guestfs.pod:1734
3464 "The callback function will be called when the child process quits, either "
3465 "asynchronously or if killed by L</guestfs_kill_subprocess>. (This "
3466 "corresponds to a transition from any state to the CONFIG state)."
3470 #: ../src/guestfs.pod:1738 ../src/guestfs.pod:1747
3471 msgid "If no callback is registered: the event is ignored."
3475 #: ../src/guestfs.pod:1740
3476 msgid "GUESTFS_EVENT_LAUNCH_DONE (payload type: void)"
3480 #: ../src/guestfs.pod:1743
3482 "The callback function will be called when the child process becomes ready "
3483 "first time after it has been launched. (This corresponds to a transition "
3484 "from LAUNCHING to the READY state)."
3488 #: ../src/guestfs.pod:1749
3489 msgid "GUESTFS_EVENT_PROGRESS (payload type: array of 4 x uint64_t)"
3493 #: ../src/guestfs.pod:1752
3495 "Some long-running operations can generate progress messages. If this "
3496 "callback is registered, then it will be called each time a progress message "
3497 "is generated (usually two seconds after the operation started, and three "
3498 "times per second thereafter until it completes, although the frequency may "
3499 "change in future versions)."
3503 #: ../src/guestfs.pod:1758
3505 "The callback receives in the payload four unsigned 64 bit numbers which are "
3506 "(in order): C<proc_nr>, C<serial>, C<position>, C<total>."
3510 #: ../src/guestfs.pod:1761
3512 "The units of C<total> are not defined, although for some operations C<total> "
3513 "may relate in some way to the amount of data to be transferred (eg. in bytes "
3514 "or megabytes), and C<position> may be the portion which has been transferred."
3518 #: ../src/guestfs.pod:1766
3519 msgid "The only defined and stable parts of the API are:"
3523 #: ../src/guestfs.pod:1772
3525 "The callback can display to the user some type of progress bar or indicator "
3526 "which shows the ratio of C<position>:C<total>."
3530 #: ../src/guestfs.pod:1777
3531 msgid "0 E<lt>= C<position> E<lt>= C<total>"
3535 #: ../src/guestfs.pod:1781
3537 "If any progress notification is sent during a call, then a final progress "
3538 "notification is always sent when C<position> = C<total> (I<unless> the call "
3539 "fails with an error)."
3543 #: ../src/guestfs.pod:1785
3545 "This is to simplify caller code, so callers can easily set the progress "
3546 "indicator to \"100%\" at the end of the operation, without requiring special "
3547 "code to detect this case."
3551 #: ../src/guestfs.pod:1791
3553 "For some calls we are unable to estimate the progress of the call, but we "
3554 "can still generate progress messages to indicate activity. This is known as "
3555 "\"pulse mode\", and is directly supported by certain progress bar "
3556 "implementations (eg. GtkProgressBar)."
3560 #: ../src/guestfs.pod:1796
3562 "For these calls, zero or more progress messages are generated with "
3563 "C<position = 0> and C<total = 1>, followed by a final message with "
3564 "C<position = total = 1>."
3568 #: ../src/guestfs.pod:1800
3570 "As noted above, if the call fails with an error then the final message may "
3575 #: ../src/guestfs.pod:1805
3577 "The callback also receives the procedure number (C<proc_nr>) and serial "
3578 "number (C<serial>) of the call. These are only useful for debugging "
3579 "protocol issues, and the callback can normally ignore them. The callback "
3580 "may want to print these numbers in error messages or debugging messages."
3584 #: ../src/guestfs.pod:1811
3585 msgid "If no callback is registered: progress messages are discarded."
3589 #: ../src/guestfs.pod:1813
3590 msgid "GUESTFS_EVENT_APPLIANCE (payload type: message buffer)"
3594 #: ../src/guestfs.pod:1816
3596 "The callback function is called whenever a log message is generated by qemu, "
3597 "the appliance kernel, guestfsd (daemon), or utility programs."
3601 #: ../src/guestfs.pod:1819
3603 "If the verbose flag (L</guestfs_set_verbose>) is set before launch (L</"
3604 "guestfs_launch>) then additional debug messages are generated."
3608 #: ../src/guestfs.pod:1822 ../src/guestfs.pod:1836
3610 "If no callback is registered: the messages are discarded unless the verbose "
3611 "flag is set in which case they are sent to stderr. You can override the "
3612 "printing of verbose messages to stderr by setting up a callback."
3616 #: ../src/guestfs.pod:1827
3617 msgid "GUESTFS_EVENT_LIBRARY (payload type: message buffer)"
3621 #: ../src/guestfs.pod:1830
3623 "The callback function is called whenever a log message is generated by the "
3624 "library part of libguestfs."
3628 #: ../src/guestfs.pod:1833
3630 "If the verbose flag (L</guestfs_set_verbose>) is set then additional debug "
3631 "messages are generated."
3635 #: ../src/guestfs.pod:1841
3636 msgid "GUESTFS_EVENT_TRACE (payload type: message buffer)"
3640 #: ../src/guestfs.pod:1844
3642 "The callback function is called whenever a trace message is generated. This "
3643 "only applies if the trace flag (L</guestfs_set_trace>) is set."
3647 #: ../src/guestfs.pod:1847
3649 "If no callback is registered: the messages are sent to stderr. You can "
3650 "override the printing of trace messages to stderr by setting up a callback."
3654 #: ../src/guestfs.pod:1853
3655 msgid "guestfs_set_event_callback"
3659 #: ../src/guestfs.pod:1855
3662 " int guestfs_set_event_callback (guestfs_h *g,\n"
3663 " guestfs_event_callback cb,\n"
3664 " uint64_t event_bitmask,\n"
3671 #: ../src/guestfs.pod:1861
3673 "This function registers a callback (C<cb>) for all event classes in the "
3678 #: ../src/guestfs.pod:1864
3680 "For example, to register for all log message events, you could call this "
3681 "function with the bitmask C<GUESTFS_EVENT_APPLIANCE|GUESTFS_EVENT_LIBRARY>. "
3682 "To register a single callback for all possible classes of events, use "
3683 "C<GUESTFS_EVENT_ALL>."
3687 #: ../src/guestfs.pod:1870
3688 msgid "C<flags> should always be passed as 0."
3692 #: ../src/guestfs.pod:1872
3694 "C<opaque> is an opaque pointer which is passed to the callback. You can use "
3695 "it for any purpose."
3699 #: ../src/guestfs.pod:1875
3701 "The return value is the event handle (an integer) which you can use to "
3702 "delete the callback (see below)."
3706 #: ../src/guestfs.pod:1878
3708 "If there is an error, this function returns C<-1>, and sets the error in the "
3709 "handle in the usual way (see L</guestfs_last_error> etc.)"
3713 #: ../src/guestfs.pod:1881
3715 "Callbacks remain in effect until they are deleted, or until the handle is "
3720 #: ../src/guestfs.pod:1884
3722 "In the case where multiple callbacks are registered for a particular event "
3723 "class, all of the callbacks are called. The order in which multiple "
3724 "callbacks are called is not defined."
3728 #: ../src/guestfs.pod:1888
3729 msgid "guestfs_delete_event_callback"
3733 #: ../src/guestfs.pod:1890
3736 " void guestfs_delete_event_callback (guestfs_h *g, int event_handle);\n"
3741 #: ../src/guestfs.pod:1892
3743 "Delete a callback that was previously registered. C<event_handle> should be "
3744 "the integer that was returned by a previous call to "
3745 "C<guestfs_set_event_callback> on the same handle."
3749 #: ../src/guestfs.pod:1896
3750 msgid "guestfs_event_callback"
3754 #: ../src/guestfs.pod:1898
3757 " typedef void (*guestfs_event_callback) (\n"
3760 " uint64_t event,\n"
3761 " int event_handle,\n"
3763 " const char *buf, size_t buf_len,\n"
3764 " const uint64_t *array, size_t array_len);\n"
3769 #: ../src/guestfs.pod:1907
3771 "This is the type of the event callback function that you have to provide."
3775 #: ../src/guestfs.pod:1910
3777 "The basic parameters are: the handle (C<g>), the opaque user pointer "
3778 "(C<opaque>), the event class (eg. C<GUESTFS_EVENT_PROGRESS>), the event "
3779 "handle, and C<flags> which in the current API you should ignore."
3783 #: ../src/guestfs.pod:1914
3785 "The remaining parameters contain the event payload (if any). Each event may "
3786 "contain a payload, which usually relates to the event class, but for future "
3787 "proofing your code should be written to handle any payload for any event "
3792 #: ../src/guestfs.pod:1919
3794 "C<buf> and C<buf_len> contain a message buffer (if C<buf_len == 0>, then "
3795 "there is no message buffer). Note that this message buffer can contain "
3796 "arbitrary 8 bit data, including NUL bytes."
3800 #: ../src/guestfs.pod:1923
3802 "C<array> and C<array_len> is an array of 64 bit unsigned integers. At the "
3803 "moment this is only used for progress messages."
3807 #: ../src/guestfs.pod:1926
3808 msgid "EXAMPLE: CAPTURING LOG MESSAGES"
3812 #: ../src/guestfs.pod:1928
3814 "One motivation for the generic event API was to allow GUI programs to "
3815 "capture debug and other messages. In libguestfs E<le> 1.8 these were sent "
3816 "unconditionally to C<stderr>."
3820 #: ../src/guestfs.pod:1932
3822 "Events associated with log messages are: C<GUESTFS_EVENT_LIBRARY>, "
3823 "C<GUESTFS_EVENT_APPLIANCE> and C<GUESTFS_EVENT_TRACE>. (Note that error "
3824 "messages are not events; you must capture error messages separately)."
3828 #: ../src/guestfs.pod:1937
3830 "Programs have to set up a callback to capture the classes of events of "
3835 #: ../src/guestfs.pod:1940
3839 " guestfs_set_event_callback\n"
3840 " (g, message_callback,\n"
3841 " GUESTFS_EVENT_LIBRARY|GUESTFS_EVENT_APPLIANCE|\n"
3842 " GUESTFS_EVENT_TRACE,\n"
3843 " 0, NULL) == -1)\n"
3844 " if (eh == -1) {\n"
3845 " // handle error in the usual way\n"
3851 #: ../src/guestfs.pod:1950
3853 "The callback can then direct messages to the appropriate place. In this "
3854 "example, messages are directed to syslog:"
3858 #: ../src/guestfs.pod:1953
3862 " message_callback (\n"
3865 " uint64_t event,\n"
3866 " int event_handle,\n"
3868 " const char *buf, size_t buf_len,\n"
3869 " const uint64_t *array, size_t array_len)\n"
3871 " const int priority = LOG_USER|LOG_INFO;\n"
3872 " if (buf_len > 0)\n"
3873 " syslog (priority, \"event 0x%lx: %s\", event, buf);\n"
3879 #: ../src/guestfs.pod:1968
3880 msgid "PRIVATE DATA AREA"
3884 #: ../src/guestfs.pod:1970
3886 "You can attach named pieces of private data to the libguestfs handle, fetch "
3887 "them by name, and walk over them, for the lifetime of the handle. This is "
3888 "called the private data area and is only available from the C API."
3892 #: ../src/guestfs.pod:1975
3893 msgid "To attach a named piece of data, use the following call:"
3897 #: ../src/guestfs.pod:1977
3900 " void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n"
3905 #: ../src/guestfs.pod:1979
3907 "C<key> is the name to associate with this data, and C<data> is an arbitrary "
3908 "pointer (which can be C<NULL>). Any previous item with the same name is "
3913 #: ../src/guestfs.pod:1983
3915 "You can use any C<key> you want, but names beginning with an underscore "
3916 "character are reserved for internal libguestfs purposes (for implementing "
3917 "language bindings). It is recommended to prefix the name with some unique "
3918 "string to avoid collisions with other users."
3922 #: ../src/guestfs.pod:1988
3923 msgid "To retrieve the pointer, use:"
3927 #: ../src/guestfs.pod:1990
3930 " void *guestfs_get_private (guestfs_h *g, const char *key);\n"
3935 #: ../src/guestfs.pod:1992
3937 "This function returns C<NULL> if either no data is found associated with "
3938 "C<key>, or if the user previously set the C<key>'s C<data> pointer to "
3943 #: ../src/guestfs.pod:1996
3945 "Libguestfs does not try to look at or interpret the C<data> pointer in any "
3946 "way. As far as libguestfs is concerned, it need not be a valid pointer at "
3947 "all. In particular, libguestfs does I<not> try to free the data when the "
3948 "handle is closed. If the data must be freed, then the caller must either "
3949 "free it before calling L</guestfs_close> or must set up a close callback to "
3950 "do it (see L</GUESTFS_EVENT_CLOSE>)."
3954 #: ../src/guestfs.pod:2003
3955 msgid "To walk over all entries, use these two functions:"
3959 #: ../src/guestfs.pod:2005
3962 " void *guestfs_first_private (guestfs_h *g, const char **key_rtn);\n"
3967 #: ../src/guestfs.pod:2007
3970 " void *guestfs_next_private (guestfs_h *g, const char **key_rtn);\n"
3975 #: ../src/guestfs.pod:2009
3977 "C<guestfs_first_private> returns the first key, pointer pair (\"first\" does "
3978 "not have any particular meaning -- keys are not returned in any defined "
3979 "order). A pointer to the key is returned in C<*key_rtn> and the "
3980 "corresponding data pointer is returned from the function. C<NULL> is "
3981 "returned if there are no keys stored in the handle."
3985 #: ../src/guestfs.pod:2015
3987 "C<guestfs_next_private> returns the next key, pointer pair. The return "
3988 "value of this function is also C<NULL> is there are no further entries to "
3993 #: ../src/guestfs.pod:2019
3994 msgid "Notes about walking over entries:"
3998 #: ../src/guestfs.pod:2025
4000 "You must not call C<guestfs_set_private> while walking over the entries."
4004 #: ../src/guestfs.pod:2030
4006 "The handle maintains an internal iterator which is reset when you call "
4007 "C<guestfs_first_private>. This internal iterator is invalidated when you "
4008 "call C<guestfs_set_private>."
4012 #: ../src/guestfs.pod:2036
4013 msgid "If you have set the data pointer associated with a key to C<NULL>, ie:"
4017 #: ../src/guestfs.pod:2038
4020 " guestfs_set_private (g, key, NULL);\n"
4025 #: ../src/guestfs.pod:2040
4026 msgid "then that C<key> is not returned when walking."
4030 #: ../src/guestfs.pod:2044
4032 "C<*key_rtn> is only valid until the next call to C<guestfs_first_private>, "
4033 "C<guestfs_next_private> or C<guestfs_set_private>."
4037 #: ../src/guestfs.pod:2050
4039 "The following example code shows how to print all keys and data pointers "
4040 "that are associated with the handle C<g>:"
4044 #: ../src/guestfs.pod:2053
4047 " const char *key;\n"
4048 " void *data = guestfs_first_private (g, &key);\n"
4049 " while (data != NULL)\n"
4051 " printf (\"key = %s, data = %p\\n\", key, data);\n"
4052 " data = guestfs_next_private (g, &key);\n"
4058 #: ../src/guestfs.pod:2061
4060 "More commonly you are only interested in keys that begin with an application-"
4061 "specific prefix C<foo_>. Modify the loop like so:"
4065 #: ../src/guestfs.pod:2064
4068 " const char *key;\n"
4069 " void *data = guestfs_first_private (g, &key);\n"
4070 " while (data != NULL)\n"
4072 " if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
4073 " printf (\"key = %s, data = %p\\n\", key, data);\n"
4074 " data = guestfs_next_private (g, &key);\n"
4080 #: ../src/guestfs.pod:2073
4082 "If you need to modify keys while walking, then you have to jump back to the "
4083 "beginning of the loop. For example, to delete all keys prefixed with "
4088 #: ../src/guestfs.pod:2077
4091 " const char *key;\n"
4094 " data = guestfs_first_private (g, &key);\n"
4095 " while (data != NULL)\n"
4097 " if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
4099 " guestfs_set_private (g, key, NULL);\n"
4100 " /* note that 'key' pointer is now invalid, and so is\n"
4101 " the internal iterator */\n"
4104 " data = guestfs_next_private (g, &key);\n"
4110 #: ../src/guestfs.pod:2093
4112 "Note that the above loop is guaranteed to terminate because the keys are "
4113 "being deleted, but other manipulations of keys within the loop might not "
4114 "terminate unless you also maintain an indication of which keys have been "
4119 #: ../src/guestfs.pod:2098 ../src/guestfs.pod:2103
4124 #: ../src/guestfs.pod:2100
4126 "<!-- old anchor for the next section --> <a name="
4127 "\"state_machine_and_low_level_event_api\"/>"
4129 "<!-- old anchor for the next section --> <a name="
4130 "\"state_machine_and_low_level_event_api\"/>"
4133 #: ../src/guestfs.pod:2105
4134 msgid "ARCHITECTURE"
4135 msgstr "АРХІТЕКТУРА"
4138 #: ../src/guestfs.pod:2107
4140 "Internally, libguestfs is implemented by running an appliance (a special "
4141 "type of small virtual machine) using L<qemu(1)>. Qemu runs as a child "
4142 "process of the main program."
4146 #: ../src/guestfs.pod:2111
4149 " ___________________\n"
4151 " | main program |\n"
4153 " | | child process / appliance\n"
4154 " | | __________________________\n"
4156 " +-------------------+ RPC | +-----------------+ |\n"
4157 " | libguestfs <--------------------> guestfsd | |\n"
4158 " | | | +-----------------+ |\n"
4159 " \\___________________/ | | Linux kernel | |\n"
4160 " | +--^--------------+ |\n"
4161 " \\_________|________________/\n"
4167 " \\______________/\n"
4172 #: ../src/guestfs.pod:2131
4174 "The library, linked to the main program, creates the child process and hence "
4175 "the appliance in the L</guestfs_launch> function."
4179 #: ../src/guestfs.pod:2134
4181 "Inside the appliance is a Linux kernel and a complete stack of userspace "
4182 "tools (such as LVM and ext2 programs) and a small controlling daemon called "
4183 "L</guestfsd>. The library talks to L</guestfsd> using remote procedure "
4184 "calls (RPC). There is a mostly one-to-one correspondence between libguestfs "
4185 "API calls and RPC calls to the daemon. Lastly the disk image(s) are "
4186 "attached to the qemu process which translates device access by the "
4187 "appliance's Linux kernel into accesses to the image."
4191 #: ../src/guestfs.pod:2143
4193 "A common misunderstanding is that the appliance \"is\" the virtual machine. "
4194 "Although the disk image you are attached to might also be used by some "
4195 "virtual machine, libguestfs doesn't know or care about this. (But you will "
4196 "care if both libguestfs's qemu process and your virtual machine are trying "
4197 "to update the disk image at the same time, since these usually results in "
4198 "massive disk corruption)."
4202 #: ../src/guestfs.pod:2150
4203 msgid "STATE MACHINE"
4204 msgstr "СКІНЧЕННИЙ АВТОМАТ"
4207 #: ../src/guestfs.pod:2152
4208 msgid "libguestfs uses a state machine to model the child process:"
4212 #: ../src/guestfs.pod:2154
4224 " / | \\ \\ guestfs_launch\n"
4225 " / | _\\__V______\n"
4227 " / | | LAUNCHING |\n"
4228 " / | \\___________/\n"
4230 " / | guestfs_launch\n"
4232 " ______ / __|____V\n"
4233 " / \\ ------> / \\\n"
4234 " | BUSY | | READY |\n"
4235 " \\______/ <------ \\________/\n"
4240 #: ../src/guestfs.pod:2176
4242 "The normal transitions are (1) CONFIG (when the handle is created, but there "
4243 "is no child process), (2) LAUNCHING (when the child process is booting up), "
4244 "(3) alternating between READY and BUSY as commands are issued to, and "
4245 "carried out by, the child process."
4249 #: ../src/guestfs.pod:2181
4251 "The guest may be killed by L</guestfs_kill_subprocess>, or may die "
4252 "asynchronously at any time (eg. due to some internal error), and that causes "
4253 "the state to transition back to CONFIG."
4257 #: ../src/guestfs.pod:2185
4259 "Configuration commands for qemu such as L</guestfs_add_drive> can only be "
4260 "issued when in the CONFIG state."
4264 #: ../src/guestfs.pod:2188
4266 "The API offers one call that goes from CONFIG through LAUNCHING to READY. "
4267 "L</guestfs_launch> blocks until the child process is READY to accept "
4268 "commands (or until some failure or timeout). L</guestfs_launch> internally "
4269 "moves the state from CONFIG to LAUNCHING while it is running."
4273 #: ../src/guestfs.pod:2194
4275 "API actions such as L</guestfs_mount> can only be issued when in the READY "
4276 "state. These API calls block waiting for the command to be carried out (ie. "
4277 "the state to transition to BUSY and then back to READY). There are no non-"
4278 "blocking versions, and no way to issue more than one command per handle at "
4283 #: ../src/guestfs.pod:2200
4285 "Finally, the child process sends asynchronous messages back to the main "
4286 "program, such as kernel log messages. You can register a callback to "
4287 "receive these messages."
4291 #: ../src/guestfs.pod:2204
4296 #: ../src/guestfs.pod:2206
4297 msgid "COMMUNICATION PROTOCOL"
4301 #: ../src/guestfs.pod:2208
4303 "Don't rely on using this protocol directly. This section documents how it "
4304 "currently works, but it may change at any time."
4308 #: ../src/guestfs.pod:2211
4310 "The protocol used to talk between the library and the daemon running inside "
4311 "the qemu virtual machine is a simple RPC mechanism built on top of XDR (RFC "
4312 "1014, RFC 1832, RFC 4506)."
4316 #: ../src/guestfs.pod:2215
4318 "The detailed format of structures is in C<src/guestfs_protocol.x> (note: "
4319 "this file is automatically generated)."
4323 #: ../src/guestfs.pod:2218
4325 "There are two broad cases, ordinary functions that don't have any C<FileIn> "
4326 "and C<FileOut> parameters, which are handled with very simple request/reply "
4327 "messages. Then there are functions that have any C<FileIn> or C<FileOut> "
4328 "parameters, which use the same request and reply messages, but they may also "
4329 "be followed by files sent using a chunked encoding."
4333 #: ../src/guestfs.pod:2225
4334 msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)"
4338 #: ../src/guestfs.pod:2227
4339 msgid "For ordinary functions, the request message is:"
4343 #: ../src/guestfs.pod:2229
4346 " total length (header + arguments,\n"
4347 " but not including the length word itself)\n"
4348 " struct guestfs_message_header (encoded as XDR)\n"
4349 " struct guestfs_<foo>_args (encoded as XDR)\n"
4354 #: ../src/guestfs.pod:2234
4356 "The total length field allows the daemon to allocate a fixed size buffer "
4357 "into which it slurps the rest of the message. As a result, the total length "
4358 "is limited to C<GUESTFS_MESSAGE_MAX> bytes (currently 4MB), which means the "
4359 "effective size of any request is limited to somewhere under this size."
4363 #: ../src/guestfs.pod:2240
4365 "Note also that many functions don't take any arguments, in which case the "
4366 "C<guestfs_I<foo>_args> is completely omitted."
4370 #: ../src/guestfs.pod:2243
4372 "The header contains the procedure number (C<guestfs_proc>) which is how the "
4373 "receiver knows what type of args structure to expect, or none at all."
4377 #: ../src/guestfs.pod:2247
4379 "For functions that take optional arguments, the optional arguments are "
4380 "encoded in the C<guestfs_I<foo>_args> structure in the same way as ordinary "
4381 "arguments. A bitmask in the header indicates which optional arguments are "
4382 "meaningful. The bitmask is also checked to see if it contains bits set "
4383 "which the daemon does not know about (eg. if more optional arguments were "
4384 "added in a later version of the library), and this causes the call to be "
4389 #: ../src/guestfs.pod:2255
4390 msgid "The reply message for ordinary functions is:"
4394 #: ../src/guestfs.pod:2257
4397 " total length (header + ret,\n"
4398 " but not including the length word itself)\n"
4399 " struct guestfs_message_header (encoded as XDR)\n"
4400 " struct guestfs_<foo>_ret (encoded as XDR)\n"
4405 #: ../src/guestfs.pod:2262
4407 "As above the C<guestfs_I<foo>_ret> structure may be completely omitted for "
4408 "functions that return no formal return values."
4412 #: ../src/guestfs.pod:2265
4414 "As above the total length of the reply is limited to C<GUESTFS_MESSAGE_MAX>."
4418 #: ../src/guestfs.pod:2268
4420 "In the case of an error, a flag is set in the header, and the reply message "
4421 "is slightly changed:"
4425 #: ../src/guestfs.pod:2271
4428 " total length (header + error,\n"
4429 " but not including the length word itself)\n"
4430 " struct guestfs_message_header (encoded as XDR)\n"
4431 " struct guestfs_message_error (encoded as XDR)\n"
4436 #: ../src/guestfs.pod:2276
4438 "The C<guestfs_message_error> structure contains the error message as a "
4443 #: ../src/guestfs.pod:2279
4444 msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS"
4448 #: ../src/guestfs.pod:2281
4450 "A C<FileIn> parameter indicates that we transfer a file I<into> the guest. "
4451 "The normal request message is sent (see above). However this is followed by "
4452 "a sequence of file chunks."
4456 #: ../src/guestfs.pod:2285
4459 " total length (header + arguments,\n"
4460 " but not including the length word itself,\n"
4461 " and not including the chunks)\n"
4462 " struct guestfs_message_header (encoded as XDR)\n"
4463 " struct guestfs_<foo>_args (encoded as XDR)\n"
4464 " sequence of chunks for FileIn param #0\n"
4465 " sequence of chunks for FileIn param #1 etc.\n"
4470 #: ../src/guestfs.pod:2293
4471 msgid "The \"sequence of chunks\" is:"
4475 #: ../src/guestfs.pod:2295
4478 " length of chunk (not including length word itself)\n"
4479 " struct guestfs_chunk (encoded as XDR)\n"
4480 " length of chunk\n"
4481 " struct guestfs_chunk (encoded as XDR)\n"
4483 " length of chunk\n"
4484 " struct guestfs_chunk (with data.data_len == 0)\n"
4489 #: ../src/guestfs.pod:2303
4491 "The final chunk has the C<data_len> field set to zero. Additionally a flag "
4492 "is set in the final chunk to indicate either successful completion or early "
4497 #: ../src/guestfs.pod:2307
4499 "At time of writing there are no functions that have more than one FileIn "
4500 "parameter. However this is (theoretically) supported, by sending the "
4501 "sequence of chunks for each FileIn parameter one after another (from left to "
4506 #: ../src/guestfs.pod:2312
4508 "Both the library (sender) I<and> the daemon (receiver) may cancel the "
4509 "transfer. The library does this by sending a chunk with a special flag set "
4510 "to indicate cancellation. When the daemon sees this, it cancels the whole "
4511 "RPC, does I<not> send any reply, and goes back to reading the next request."
4515 #: ../src/guestfs.pod:2318
4517 "The daemon may also cancel. It does this by writing a special word "
4518 "C<GUESTFS_CANCEL_FLAG> to the socket. The library listens for this during "
4519 "the transfer, and if it gets it, it will cancel the transfer (it sends a "
4520 "cancel chunk). The special word is chosen so that even if cancellation "
4521 "happens right at the end of the transfer (after the library has finished "
4522 "writing and has started listening for the reply), the \"spurious\" cancel "
4523 "flag will not be confused with the reply message."
4527 #: ../src/guestfs.pod:2327
4529 "This protocol allows the transfer of arbitrary sized files (no 32 bit "
4530 "limit), and also files where the size is not known in advance (eg. from "
4531 "pipes or sockets). However the chunks are rather small "
4532 "(C<GUESTFS_MAX_CHUNK_SIZE>), so that neither the library nor the daemon need "
4533 "to keep much in memory."
4537 #: ../src/guestfs.pod:2333
4538 msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS"
4542 #: ../src/guestfs.pod:2335
4544 "The protocol for FileOut parameters is exactly the same as for FileIn "
4545 "parameters, but with the roles of daemon and library reversed."
4549 #: ../src/guestfs.pod:2338
4552 " total length (header + ret,\n"
4553 " but not including the length word itself,\n"
4554 " and not including the chunks)\n"
4555 " struct guestfs_message_header (encoded as XDR)\n"
4556 " struct guestfs_<foo>_ret (encoded as XDR)\n"
4557 " sequence of chunks for FileOut param #0\n"
4558 " sequence of chunks for FileOut param #1 etc.\n"
4563 #: ../src/guestfs.pod:2346
4564 msgid "INITIAL MESSAGE"
4568 #: ../src/guestfs.pod:2348
4570 "When the daemon launches it sends an initial word (C<GUESTFS_LAUNCH_FLAG>) "
4571 "which indicates that the guest and daemon is alive. This is what L</"
4572 "guestfs_launch> waits for."
4576 #: ../src/guestfs.pod:2352
4577 msgid "PROGRESS NOTIFICATION MESSAGES"
4581 #: ../src/guestfs.pod:2354
4583 "The daemon may send progress notification messages at any time. These are "
4584 "distinguished by the normal length word being replaced by "
4585 "C<GUESTFS_PROGRESS_FLAG>, followed by a fixed size progress message."
4589 #: ../src/guestfs.pod:2358
4591 "The library turns them into progress callbacks (see L</"
4592 "GUESTFS_EVENT_PROGRESS>) if there is a callback registered, or discards them "
4597 #: ../src/guestfs.pod:2362
4599 "The daemon self-limits the frequency of progress messages it sends (see "
4600 "C<daemon/proto.c:notify_progress>). Not all calls generate progress "
4605 #: ../src/guestfs.pod:2366
4606 msgid "LIBGUESTFS VERSION NUMBERS"
4610 #: ../src/guestfs.pod:2368
4612 "Since April 2010, libguestfs has started to make separate development and "
4613 "stable releases, along with corresponding branches in our git repository. "
4614 "These separate releases can be identified by version number:"
4618 #: ../src/guestfs.pod:2373
4621 " even numbers for stable: 1.2.x, 1.4.x, ...\n"
4622 " .-------- odd numbers for development: 1.3.x, 1.5.x, ...\n"
4628 " | `-------- sub-version\n"
4630 " `------ always '1' because we don't change the ABI\n"
4635 #: ../src/guestfs.pod:2384
4636 msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"."
4640 #: ../src/guestfs.pod:2386
4642 "As time passes we cherry pick fixes from the development branch and backport "
4643 "those into the stable branch, the effect being that the stable branch should "
4644 "get more stable and less buggy over time. So the stable releases are ideal "
4645 "for people who don't need new features but would just like the software to "
4650 #: ../src/guestfs.pod:2392
4651 msgid "Our criteria for backporting changes are:"
4655 #: ../src/guestfs.pod:2398
4657 "Documentation changes which don't affect any code are backported unless the "
4658 "documentation refers to a future feature which is not in stable."
4662 #: ../src/guestfs.pod:2404
4664 "Bug fixes which are not controversial, fix obvious problems, and have been "
4665 "well tested are backported."
4669 #: ../src/guestfs.pod:2409
4671 "Simple rearrangements of code which shouldn't affect how it works get "
4672 "backported. This is so that the code in the two branches doesn't get too "
4673 "far out of step, allowing us to backport future fixes more easily."
4677 #: ../src/guestfs.pod:2415
4679 "We I<don't> backport new features, new APIs, new tools etc, except in one "
4680 "exceptional case: the new feature is required in order to implement an "
4681 "important bug fix."
4685 #: ../src/guestfs.pod:2421
4687 "A new stable branch starts when we think the new features in development are "
4688 "substantial and compelling enough over the current stable branch to warrant "
4689 "it. When that happens we create new stable and development versions 1.N.0 "
4690 "and 1.(N+1).0 [N is even]. The new dot-oh release won't necessarily be so "
4691 "stable at this point, but by backporting fixes from development, that branch "
4692 "will stabilize over time."
4696 #: ../src/guestfs.pod:2429
4697 msgid "EXTENDING LIBGUESTFS"
4701 #: ../src/guestfs.pod:2431
4702 msgid "ADDING A NEW API ACTION"
4706 #: ../src/guestfs.pod:2433
4708 "Large amounts of boilerplate code in libguestfs (RPC, bindings, "
4709 "documentation) are generated, and this makes it easy to extend the "
4714 #: ../src/guestfs.pod:2437
4715 msgid "To add a new API action there are two changes:"
4719 #: ../src/guestfs.pod:2443
4721 "You need to add a description of the call (name, parameters, return type, "
4722 "tests, documentation) to C<generator/generator_actions.ml>."
4726 #: ../src/guestfs.pod:2446
4728 "There are two sorts of API action, depending on whether the call goes "
4729 "through to the daemon in the appliance, or is serviced entirely by the "
4730 "library (see L</ARCHITECTURE> above). L</guestfs_sync> is an example of the "
4731 "former, since the sync is done in the appliance. L</guestfs_set_trace> is "
4732 "an example of the latter, since a trace flag is maintained in the handle and "
4733 "all tracing is done on the library side."
4737 #: ../src/guestfs.pod:2454
4739 "Most new actions are of the first type, and get added to the "
4740 "C<daemon_functions> list. Each function has a unique procedure number used "
4741 "in the RPC protocol which is assigned to that action when we publish "
4742 "libguestfs and cannot be reused. Take the latest procedure number and "
4747 #: ../src/guestfs.pod:2460
4749 "For library-only actions of the second type, add to the "
4750 "C<non_daemon_functions> list. Since these functions are serviced by the "
4751 "library and do not travel over the RPC mechanism to the daemon, these "
4752 "functions do not need a procedure number, and so the procedure number is set "
4757 #: ../src/guestfs.pod:2468
4758 msgid "Implement the action (in C):"
4762 #: ../src/guestfs.pod:2470
4764 "For daemon actions, implement the function C<do_E<lt>nameE<gt>> in the "
4765 "C<daemon/> directory."
4769 #: ../src/guestfs.pod:2473
4771 "For library actions, implement the function C<guestfs__E<lt>nameE<gt>> "
4772 "(note: double underscore) in the C<src/> directory."
4776 #: ../src/guestfs.pod:2476
4777 msgid "In either case, use another function as an example of what to do."
4781 #: ../src/guestfs.pod:2480
4782 msgid "After making these changes, use C<make> to compile."
4786 #: ../src/guestfs.pod:2482
4788 "Note that you don't need to implement the RPC, language bindings, manual "
4789 "pages or anything else. It's all automatically generated from the OCaml "
4794 #: ../src/guestfs.pod:2486
4795 msgid "ADDING TESTS FOR AN API ACTION"
4799 #: ../src/guestfs.pod:2488
4801 "You can supply zero or as many tests as you want per API call. The tests "
4802 "can either be added as part of the API description (C<generator/"
4803 "generator_actions.ml>), or in some rarer cases you may want to drop a script "
4804 "into C<regressions/>. Note that adding a script to C<regressions/> is "
4805 "slower, so if possible use the first method."
4809 #: ../src/guestfs.pod:2494
4811 "The following describes the test environment used when you add an API test "
4812 "in C<generator_actions.ml>."
4816 #: ../src/guestfs.pod:2497
4817 msgid "The test environment has 4 block devices:"
4821 #: ../src/guestfs.pod:2501
4822 msgid "C</dev/sda> 500MB"
4826 #: ../src/guestfs.pod:2503
4827 msgid "General block device for testing."
4831 #: ../src/guestfs.pod:2505
4832 msgid "C</dev/sdb> 50MB"
4836 #: ../src/guestfs.pod:2507
4838 "C</dev/sdb1> is an ext2 filesystem used for testing filesystem write "
4843 #: ../src/guestfs.pod:2510
4844 msgid "C</dev/sdc> 10MB"
4848 #: ../src/guestfs.pod:2512
4849 msgid "Used in a few tests where two block devices are needed."
4853 #: ../src/guestfs.pod:2514
4855 msgstr "C</dev/sdd>"
4858 #: ../src/guestfs.pod:2516
4859 msgid "ISO with fixed content (see C<images/test.iso>)."
4863 #: ../src/guestfs.pod:2520
4865 "To be able to run the tests in a reasonable amount of time, the libguestfs "
4866 "appliance and block devices are reused between tests. So don't try testing "
4867 "L</guestfs_kill_subprocess> :-x"
4871 #: ../src/guestfs.pod:2524
4873 "Each test starts with an initial scenario, selected using one of the "
4874 "C<Init*> expressions, described in C<generator/generator_types.ml>. These "
4875 "initialize the disks mentioned above in a particular way as documented in "
4876 "C<generator_types.ml>. You should not assume anything about the previous "
4877 "contents of other disks that are not initialized."
4881 #: ../src/guestfs.pod:2530
4883 "You can add a prerequisite clause to any individual test. This is a run-"
4884 "time check, which, if it fails, causes the test to be skipped. Useful if "
4885 "testing a command which might not work on all variations of libguestfs "
4886 "builds. A test that has prerequisite of C<Always> means to run "
4891 #: ../src/guestfs.pod:2536
4893 "In addition, packagers can skip individual tests by setting environment "
4894 "variables before running C<make check>."
4898 #: ../src/guestfs.pod:2539
4901 " SKIP_TEST_<CMD>_<NUM>=1\n"
4906 #: ../src/guestfs.pod:2541
4907 msgid "eg: C<SKIP_TEST_COMMAND_3=1> skips test #3 of L</guestfs_command>."
4911 #: ../src/guestfs.pod:2543
4916 #: ../src/guestfs.pod:2545
4919 " SKIP_TEST_<CMD>=1\n"
4924 #: ../src/guestfs.pod:2547
4925 msgid "eg: C<SKIP_TEST_ZEROFREE=1> skips all L</guestfs_zerofree> tests."
4929 #: ../src/guestfs.pod:2549
4930 msgid "Packagers can run only certain tests by setting for example:"
4934 #: ../src/guestfs.pod:2551
4937 " TEST_ONLY=\"vfs_type zerofree\"\n"
4942 #: ../src/guestfs.pod:2553
4944 "See C<capitests/tests.c> for more details of how these environment variables "
4949 #: ../src/guestfs.pod:2556
4950 msgid "DEBUGGING NEW API ACTIONS"
4954 #: ../src/guestfs.pod:2558
4955 msgid "Test new actions work before submitting them."
4959 #: ../src/guestfs.pod:2560
4960 msgid "You can use guestfish to try out new commands."
4964 #: ../src/guestfs.pod:2562
4966 "Debugging the daemon is a problem because it runs inside a minimal "
4967 "environment. However you can fprintf messages in the daemon to stderr, and "
4968 "they will show up if you use C<guestfish -v>."
4972 #: ../src/guestfs.pod:2566
4973 msgid "FORMATTING CODE AND OTHER CONVENTIONS"
4977 #: ../src/guestfs.pod:2568
4979 "Our C source code generally adheres to some basic code-formatting "
4980 "conventions. The existing code base is not totally consistent on this "
4981 "front, but we do prefer that contributed code be formatted similarly. In "
4982 "short, use spaces-not-TABs for indentation, use 2 spaces for each "
4983 "indentation level, and other than that, follow the K&R style."
4987 #: ../src/guestfs.pod:2574
4989 "If you use Emacs, add the following to one of one of your start-up files (e."
4990 "g., ~/.emacs), to help ensure that you get indentation right:"
4994 #: ../src/guestfs.pod:2577
4997 " ;;; In libguestfs, indent with spaces everywhere (not TABs).\n"
4998 " ;;; Exceptions: Makefile and ChangeLog modes.\n"
4999 " (add-hook 'find-file-hook\n"
5000 " '(lambda () (if (and buffer-file-name\n"
5001 " (string-match \"/libguestfs\\\\>\"\n"
5002 " (buffer-file-name))\n"
5003 " (not (string-equal mode-name \"Change Log\"))\n"
5004 " (not (string-equal mode-name \"Makefile\")))\n"
5005 " (setq indent-tabs-mode nil))))\n"
5010 #: ../src/guestfs.pod:2587
5013 " ;;; When editing C sources in libguestfs, use this style.\n"
5014 " (defun libguestfs-c-mode ()\n"
5015 " \"C mode with adjusted defaults for use with libguestfs.\"\n"
5017 " (c-set-style \"K&R\")\n"
5018 " (setq c-indent-level 2)\n"
5019 " (setq c-basic-offset 2))\n"
5020 " (add-hook 'c-mode-hook\n"
5021 " '(lambda () (if (string-match \"/libguestfs\\\\>\"\n"
5022 " (buffer-file-name))\n"
5023 " (libguestfs-c-mode))))\n"
5028 #: ../src/guestfs.pod:2599
5029 msgid "Enable warnings when compiling (and fix any problems this finds):"
5033 #: ../src/guestfs.pod:2602
5036 " ./configure --enable-gcc-warnings\n"
5041 #: ../src/guestfs.pod:2604
5042 msgid "Useful targets are:"
5046 #: ../src/guestfs.pod:2606
5049 " make syntax-check # checks the syntax of the C code\n"
5050 " make check # runs the test suite\n"
5055 #: ../src/guestfs.pod:2609
5056 msgid "DAEMON CUSTOM PRINTF FORMATTERS"
5060 #: ../src/guestfs.pod:2611
5062 "In the daemon code we have created custom printf formatters C<%Q> and C<%R>, "
5063 "which are used to do shell quoting."
5067 #: ../src/guestfs.pod:2616
5072 #: ../src/guestfs.pod:2618
5074 "Simple shell quoted string. Any spaces or other shell characters are "
5079 #: ../src/guestfs.pod:2621
5084 #: ../src/guestfs.pod:2623
5086 "Same as C<%Q> except the string is treated as a path which is prefixed by "
5091 #: ../src/guestfs.pod:2628 ../fish/guestfish.pod:240 ../fish/guestfish.pod:613
5092 msgid "For example:"
5096 #: ../src/guestfs.pod:2630
5099 " asprintf (&cmd, \"cat %R\", path);\n"
5104 #: ../src/guestfs.pod:2632
5105 msgid "would produce C<cat /sysroot/some\\ path\\ with\\ spaces>"
5109 #: ../src/guestfs.pod:2634
5111 "I<Note:> Do I<not> use these when you are passing parameters to the C<command"
5112 "{,r,v,rv}()> functions. These parameters do NOT need to be quoted because "
5113 "they are not passed via the shell (instead, straight to exec). You probably "
5114 "want to use the C<sysroot_path()> function however."
5118 #: ../src/guestfs.pod:2640
5119 msgid "SUBMITTING YOUR NEW API ACTIONS"
5123 #: ../src/guestfs.pod:2642
5125 "Submit patches to the mailing list: L<http://www.redhat.com/mailman/listinfo/"
5126 "libguestfs> and CC to L<rjones@redhat.com>."
5130 #: ../src/guestfs.pod:2646
5131 msgid "INTERNATIONALIZATION (I18N) SUPPORT"
5135 #: ../src/guestfs.pod:2648
5136 msgid "We support i18n (gettext anyhow) in the library."
5140 #: ../src/guestfs.pod:2650
5142 "However many messages come from the daemon, and we don't translate those at "
5143 "the moment. One reason is that the appliance generally has all locale files "
5144 "removed from it, because they take up a lot of space. So we'd have to readd "
5145 "some of those, as well as copying our PO files into the appliance."
5149 #: ../src/guestfs.pod:2656
5151 "Debugging messages are never translated, since they are intended for the "
5156 #: ../src/guestfs.pod:2659
5157 msgid "SOURCE CODE SUBDIRECTORIES"
5161 #: ../src/guestfs.pod:2663 ../src/guestfs-actions.pod:5806
5162 #: ../fish/guestfish-actions.pod:3900
5163 msgid "C<appliance>"
5164 msgstr "C<appliance>"
5167 #: ../src/guestfs.pod:2665
5168 msgid "The libguestfs appliance, build scripts and so on."
5172 #: ../src/guestfs.pod:2667
5173 msgid "C<capitests>"
5174 msgstr "C<capitests>"
5177 #: ../src/guestfs.pod:2669
5178 msgid "Automated tests of the C API."
5182 #: ../src/guestfs.pod:2671
5187 #: ../src/guestfs.pod:2673
5189 "The L<virt-cat(1)>, L<virt-filesystems(1)> and L<virt-ls(1)> commands and "
5194 #: ../src/guestfs.pod:2676
5199 #: ../src/guestfs.pod:2678
5200 msgid "Outside contributions, experimental parts."
5204 #: ../src/guestfs.pod:2680
5209 #: ../src/guestfs.pod:2682
5211 "The daemon that runs inside the libguestfs appliance and carries out actions."
5215 #: ../src/guestfs.pod:2685
5220 #: ../src/guestfs.pod:2687
5221 msgid "L<virt-df(1)> command and documentation."
5225 #: ../src/guestfs.pod:2689
5227 msgstr "C<examples>"
5230 #: ../src/guestfs.pod:2691
5231 msgid "C API example code."
5232 msgstr "Код прикладів використання програмного інтерфейсу мовою C."
5235 #: ../src/guestfs.pod:2693
5240 #: ../src/guestfs.pod:2695
5242 "L<guestfish(1)>, the command-line shell, and various shell scripts built on "
5243 "top such as L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, "
5244 "L<virt-tar-out(1)>."
5248 #: ../src/guestfs.pod:2699
5253 #: ../src/guestfs.pod:2701
5255 "L<guestmount(1)>, FUSE (userspace filesystem) built on top of libguestfs."
5259 #: ../src/guestfs.pod:2703
5260 msgid "C<generator>"
5261 msgstr "C<generator>"
5264 #: ../src/guestfs.pod:2705
5266 "The crucially important generator, used to automatically generate large "
5267 "amounts of boilerplate C code for things like RPC and bindings."
5271 #: ../src/guestfs.pod:2708
5276 #: ../src/guestfs.pod:2710
5277 msgid "Files used by the test suite."
5281 #: ../src/guestfs.pod:2712
5282 msgid "Some \"phony\" guest images which we test against."
5286 #: ../src/guestfs.pod:2714
5287 msgid "C<inspector>"
5288 msgstr "C<inspector>"
5291 #: ../src/guestfs.pod:2716
5292 msgid "L<virt-inspector(1)>, the virtual machine image inspector."
5296 #: ../src/guestfs.pod:2718
5301 #: ../src/guestfs.pod:2720
5302 msgid "Logo used on the website. The fish is called Arthur by the way."
5306 #: ../src/guestfs.pod:2722
5311 #: ../src/guestfs.pod:2724
5312 msgid "M4 macros used by autoconf."
5316 #: ../src/guestfs.pod:2726
5321 #: ../src/guestfs.pod:2728
5322 msgid "Translations of simple gettext strings."
5323 msgstr "Переклади простих рядків gettext."
5326 #: ../src/guestfs.pod:2730
5331 #: ../src/guestfs.pod:2732
5333 "The build infrastructure and PO files for translations of manpages and POD "
5334 "files. Eventually this will be combined with the C<po> directory, but that "
5335 "is rather complicated."
5339 #: ../src/guestfs.pod:2736
5340 msgid "C<regressions>"
5341 msgstr "C<regressions>"
5344 #: ../src/guestfs.pod:2738
5345 msgid "Regression tests."
5346 msgstr "Тести на регресії."
5349 #: ../src/guestfs.pod:2740
5354 #: ../src/guestfs.pod:2742
5355 msgid "L<virt-rescue(1)> command and documentation."
5359 #: ../src/guestfs.pod:2744
5364 #: ../src/guestfs.pod:2746
5365 msgid "Source code to the C library."
5369 #: ../src/guestfs.pod:2748
5374 #: ../src/guestfs.pod:2750
5375 msgid "Command line tools written in Perl (L<virt-resize(1)> and many others)."
5379 #: ../src/guestfs.pod:2752
5380 msgid "C<test-tool>"
5381 msgstr "C<test-tool>"
5384 #: ../src/guestfs.pod:2754
5386 "Test tool for end users to test if their qemu/kernel combination will work "
5391 #: ../src/guestfs.pod:2757
5396 #: ../src/guestfs.pod:2759
5401 #: ../src/guestfs.pod:2761
5406 #: ../src/guestfs.pod:2763
5411 #: ../src/guestfs.pod:2765
5416 #: ../src/guestfs.pod:2767
5421 #: ../src/guestfs.pod:2769
5426 #: ../src/guestfs.pod:2771
5431 #: ../src/guestfs.pod:2773
5432 msgid "Language bindings."
5433 msgstr "Прив’язки до мов програмування."
5436 #: ../src/guestfs.pod:2777 ../fish/guestfish.pod:1010
5437 #: ../test-tool/libguestfs-test-tool.pod:82 ../tools/virt-edit.pl:476
5438 msgid "ENVIRONMENT VARIABLES"
5439 msgstr "ЗМІННІ СЕРЕДОВИЩА"
5442 #: ../src/guestfs.pod:2781 ../fish/guestfish.pod:1036
5443 msgid "LIBGUESTFS_APPEND"
5447 #: ../src/guestfs.pod:2783 ../fish/guestfish.pod:1038
5448 msgid "Pass additional options to the guest kernel."
5452 #: ../src/guestfs.pod:2785 ../fish/guestfish.pod:1040
5453 msgid "LIBGUESTFS_DEBUG"
5457 #: ../src/guestfs.pod:2787
5459 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
5460 "effect as calling C<guestfs_set_verbose (g, 1)>."
5464 #: ../src/guestfs.pod:2790 ../fish/guestfish.pod:1045
5465 msgid "LIBGUESTFS_MEMSIZE"
5469 #: ../src/guestfs.pod:2792 ../fish/guestfish.pod:1047
5471 "Set the memory allocated to the qemu process, in megabytes. For example:"
5475 #: ../src/guestfs.pod:2795 ../fish/guestfish.pod:1050
5478 " LIBGUESTFS_MEMSIZE=700\n"
5483 #: ../src/guestfs.pod:2797 ../fish/guestfish.pod:1052
5484 msgid "LIBGUESTFS_PATH"
5488 #: ../src/guestfs.pod:2799
5490 "Set the path that libguestfs uses to search for a supermin appliance. See "
5491 "the discussion of paths in section L</PATH> above."
5495 #: ../src/guestfs.pod:2802 ../fish/guestfish.pod:1057
5496 msgid "LIBGUESTFS_QEMU"
5500 #: ../src/guestfs.pod:2804 ../fish/guestfish.pod:1059
5502 "Set the default qemu binary that libguestfs uses. If not set, then the qemu "
5503 "which was found at compile time by the configure script is used."
5507 #: ../src/guestfs.pod:2808
5508 msgid "See also L</QEMU WRAPPERS> above."
5512 #: ../src/guestfs.pod:2810 ../fish/guestfish.pod:1063
5513 msgid "LIBGUESTFS_TRACE"
5517 #: ../src/guestfs.pod:2812
5519 "Set C<LIBGUESTFS_TRACE=1> to enable command traces. This has the same "
5520 "effect as calling C<guestfs_set_trace (g, 1)>."
5524 #: ../src/guestfs.pod:2815 ../fish/guestfish.pod:1072
5529 #: ../src/guestfs.pod:2817 ../fish/guestfish.pod:1074
5531 "Location of temporary directory, defaults to C</tmp> except for the cached "
5532 "supermin appliance which defaults to C</var/tmp>."
5536 #: ../src/guestfs.pod:2820 ../fish/guestfish.pod:1077
5538 "If libguestfs was compiled to use the supermin appliance then the real "
5539 "appliance is cached in this directory, shared between all handles belonging "
5540 "to the same EUID. You can use C<$TMPDIR> to configure another directory to "
5541 "use in case C</var/tmp> is not large enough."
5545 #: ../src/guestfs.pod:2828 ../fish/guestfish.pod:1144
5546 #: ../test-tool/libguestfs-test-tool.pod:87 ../fuse/guestmount.pod:267
5547 #: ../tools/virt-edit.pl:496 ../tools/virt-win-reg.pl:572
5548 #: ../tools/virt-list-filesystems.pl:189 ../tools/virt-tar.pl:286
5549 #: ../tools/virt-make-fs.pl:539 ../tools/virt-list-partitions.pl:257
5551 msgstr "ТАКОЖ ПЕРЕГЛЯНЬТЕ"
5554 #: ../src/guestfs.pod:2830
5556 "L<guestfs-examples(3)>, L<guestfs-ocaml(3)>, L<guestfs-python(3)>, L<guestfs-"
5557 "ruby(3)>, L<guestfish(1)>, L<guestmount(1)>, L<virt-cat(1)>, L<virt-copy-in"
5558 "(1)>, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, L<virt-filesystems"
5559 "(1)>, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, L<virt-list-"
5560 "partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, L<virt-rescue(1)>, L<virt-"
5561 "tar(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<virt-win-reg(1)>, L<qemu(1)"
5562 ">, L<febootstrap(1)>, L<hivex(3)>, L<http://libguestfs.org/>."
5566 #: ../src/guestfs.pod:2857
5568 "Tools with a similar purpose: L<fdisk(8)>, L<parted(8)>, L<kpartx(8)>, L<lvm"
5569 "(8)>, L<disktype(1)>."
5573 #: ../src/guestfs.pod:2864 ../tools/virt-win-reg.pl:587
5574 #: ../tools/virt-make-fs.pl:553
5579 #: ../src/guestfs.pod:2866
5580 msgid "To get a list of bugs against libguestfs use this link:"
5582 "Щоб переглянути список відомих вад у libguestfs, скористайтеся таким "
5586 #: ../src/guestfs.pod:2868
5588 "L<https://bugzilla.redhat.com/buglist.cgi?"
5589 "component=libguestfs&product=Virtualization+Tools>"
5591 "L<https://bugzilla.redhat.com/buglist.cgi?"
5592 "component=libguestfs&product=Virtualization+Tools>"
5595 #: ../src/guestfs.pod:2870
5596 msgid "To report a new bug against libguestfs use this link:"
5597 msgstr "Для звітування щодо вад у libguestfs скористайтеся цим посиланням:"
5600 #: ../src/guestfs.pod:2872
5602 "L<https://bugzilla.redhat.com/enter_bug.cgi?"
5603 "component=libguestfs&product=Virtualization+Tools>"
5605 "L<https://bugzilla.redhat.com/enter_bug.cgi?"
5606 "component=libguestfs&product=Virtualization+Tools>"
5609 #: ../src/guestfs.pod:2874
5610 msgid "When reporting a bug, please check:"
5614 #: ../src/guestfs.pod:2880
5615 msgid "That the bug hasn't been reported already."
5619 #: ../src/guestfs.pod:2884
5620 msgid "That you are testing a recent version."
5624 #: ../src/guestfs.pod:2888
5625 msgid "Describe the bug accurately, and give a way to reproduce it."
5629 #: ../src/guestfs.pod:2892
5631 "Run libguestfs-test-tool and paste the B<complete, unedited> output into the "
5636 #: ../src/guestfs.pod:2897 ../fish/guestfish.pod:1167
5637 #: ../test-tool/libguestfs-test-tool.pod:93 ../fuse/guestmount.pod:278
5642 #: ../src/guestfs.pod:2899 ../fish/guestfish.pod:1169
5643 #: ../test-tool/libguestfs-test-tool.pod:95 ../fuse/guestmount.pod:280
5644 msgid "Richard W.M. Jones (C<rjones at redhat dot com>)"
5648 #: ../src/guestfs.pod:2901 ../fish/guestfish.pod:1171
5649 #: ../test-tool/libguestfs-test-tool.pod:97 ../fuse/guestmount.pod:282
5650 #: ../tools/virt-edit.pl:514 ../tools/virt-win-reg.pl:602
5651 #: ../tools/virt-list-filesystems.pl:206 ../tools/virt-tar.pl:305
5652 #: ../tools/virt-make-fs.pl:568 ../tools/virt-list-partitions.pl:273
5654 msgstr "АВТОРСЬКІ ПРАВА"
5657 #: ../src/guestfs.pod:2903 ../fish/guestfish.pod:1173
5658 #: ../test-tool/libguestfs-test-tool.pod:99
5659 msgid "Copyright (C) 2009-2011 Red Hat Inc. L<http://libguestfs.org/>"
5663 #: ../src/guestfs.pod:2906
5665 "This library is free software; you can redistribute it and/or modify it "
5666 "under the terms of the GNU Lesser General Public License as published by the "
5667 "Free Software Foundation; either version 2 of the License, or (at your "
5668 "option) any later version."
5672 #: ../src/guestfs.pod:2911
5674 "This library is distributed in the hope that it will be useful, but WITHOUT "
5675 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
5676 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License "
5681 #: ../src/guestfs.pod:2916
5683 "You should have received a copy of the GNU Lesser General Public License "
5684 "along with this library; if not, write to the Free Software Foundation, "
5685 "Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA"
5689 #: ../src/guestfs-actions.pod:1
5690 msgid "guestfs_add_cdrom"
5694 #: ../src/guestfs-actions.pod:3
5698 " guestfs_add_cdrom (guestfs_h *g,\n"
5699 " const char *filename);\n"
5704 #: ../src/guestfs-actions.pod:7 ../fish/guestfish-actions.pod:5
5705 msgid "This function adds a virtual CD-ROM disk image to the guest."
5709 #: ../src/guestfs-actions.pod:9 ../fish/guestfish-actions.pod:7
5710 msgid "This is equivalent to the qemu parameter C<-cdrom filename>."
5714 #: ../src/guestfs-actions.pod:17
5716 "This call checks for the existence of C<filename>. This stops you from "
5717 "specifying other types of drive which are supported by qemu such as C<nbd:> "
5718 "and C<http:> URLs. To specify those, use the general C<guestfs_config> call "
5723 #: ../src/guestfs-actions.pod:24
5725 "If you just want to add an ISO file (often you use this as an efficient way "
5726 "to transfer large files into the guest), then you should probably use "
5727 "C<guestfs_add_drive_ro> instead."
5731 #: ../src/guestfs-actions.pod:30 ../src/guestfs-actions.pod:134
5732 #: ../src/guestfs-actions.pod:195 ../src/guestfs-actions.pod:232
5733 #: ../src/guestfs-actions.pod:246 ../src/guestfs-actions.pod:267
5734 #: ../src/guestfs-actions.pod:287 ../src/guestfs-actions.pod:301
5735 #: ../src/guestfs-actions.pod:416 ../src/guestfs-actions.pod:436
5736 #: ../src/guestfs-actions.pod:450 ../src/guestfs-actions.pod:495
5737 #: ../src/guestfs-actions.pod:523 ../src/guestfs-actions.pod:541
5738 #: ../src/guestfs-actions.pod:608 ../src/guestfs-actions.pod:641
5739 #: ../src/guestfs-actions.pod:655 ../src/guestfs-actions.pod:670
5740 #: ../src/guestfs-actions.pod:769 ../src/guestfs-actions.pod:787
5741 #: ../src/guestfs-actions.pod:801 ../src/guestfs-actions.pod:815
5742 #: ../src/guestfs-actions.pod:976 ../src/guestfs-actions.pod:996
5743 #: ../src/guestfs-actions.pod:1014 ../src/guestfs-actions.pod:1098
5744 #: ../src/guestfs-actions.pod:1116 ../src/guestfs-actions.pod:1135
5745 #: ../src/guestfs-actions.pod:1149 ../src/guestfs-actions.pod:1169
5746 #: ../src/guestfs-actions.pod:1239 ../src/guestfs-actions.pod:1270
5747 #: ../src/guestfs-actions.pod:1295 ../src/guestfs-actions.pod:1337
5748 #: ../src/guestfs-actions.pod:1443 ../src/guestfs-actions.pod:1477
5749 #: ../src/guestfs-actions.pod:1695 ../src/guestfs-actions.pod:1717
5750 #: ../src/guestfs-actions.pod:1804 ../src/guestfs-actions.pod:2266
5751 #: ../src/guestfs-actions.pod:2410 ../src/guestfs-actions.pod:2471
5752 #: ../src/guestfs-actions.pod:2506 ../src/guestfs-actions.pod:3451
5753 #: ../src/guestfs-actions.pod:3466 ../src/guestfs-actions.pod:3491
5754 #: ../src/guestfs-actions.pod:3646 ../src/guestfs-actions.pod:3660
5755 #: ../src/guestfs-actions.pod:3673 ../src/guestfs-actions.pod:3687
5756 #: ../src/guestfs-actions.pod:3702 ../src/guestfs-actions.pod:3738
5757 #: ../src/guestfs-actions.pod:3810 ../src/guestfs-actions.pod:3830
5758 #: ../src/guestfs-actions.pod:3847 ../src/guestfs-actions.pod:3870
5759 #: ../src/guestfs-actions.pod:3893 ../src/guestfs-actions.pod:3925
5760 #: ../src/guestfs-actions.pod:3944 ../src/guestfs-actions.pod:3963
5761 #: ../src/guestfs-actions.pod:3998 ../src/guestfs-actions.pod:4010
5762 #: ../src/guestfs-actions.pod:4046 ../src/guestfs-actions.pod:4062
5763 #: ../src/guestfs-actions.pod:4075 ../src/guestfs-actions.pod:4090
5764 #: ../src/guestfs-actions.pod:4107 ../src/guestfs-actions.pod:4200
5765 #: ../src/guestfs-actions.pod:4220 ../src/guestfs-actions.pod:4233
5766 #: ../src/guestfs-actions.pod:4284 ../src/guestfs-actions.pod:4302
5767 #: ../src/guestfs-actions.pod:4320 ../src/guestfs-actions.pod:4336
5768 #: ../src/guestfs-actions.pod:4350 ../src/guestfs-actions.pod:4364
5769 #: ../src/guestfs-actions.pod:4381 ../src/guestfs-actions.pod:4396
5770 #: ../src/guestfs-actions.pod:4416 ../src/guestfs-actions.pod:4474
5771 #: ../src/guestfs-actions.pod:4547 ../src/guestfs-actions.pod:4578
5772 #: ../src/guestfs-actions.pod:4597 ../src/guestfs-actions.pod:4616
5773 #: ../src/guestfs-actions.pod:4628 ../src/guestfs-actions.pod:4645
5774 #: ../src/guestfs-actions.pod:4658 ../src/guestfs-actions.pod:4673
5775 #: ../src/guestfs-actions.pod:4688 ../src/guestfs-actions.pod:4723
5776 #: ../src/guestfs-actions.pod:4738 ../src/guestfs-actions.pod:4758
5777 #: ../src/guestfs-actions.pod:4772 ../src/guestfs-actions.pod:4789
5778 #: ../src/guestfs-actions.pod:4838 ../src/guestfs-actions.pod:4875
5779 #: ../src/guestfs-actions.pod:4889 ../src/guestfs-actions.pod:4917
5780 #: ../src/guestfs-actions.pod:4934 ../src/guestfs-actions.pod:4952
5781 #: ../src/guestfs-actions.pod:5086 ../src/guestfs-actions.pod:5143
5782 #: ../src/guestfs-actions.pod:5165 ../src/guestfs-actions.pod:5183
5783 #: ../src/guestfs-actions.pod:5215 ../src/guestfs-actions.pod:5281
5784 #: ../src/guestfs-actions.pod:5298 ../src/guestfs-actions.pod:5311
5785 #: ../src/guestfs-actions.pod:5325 ../src/guestfs-actions.pod:5614
5786 #: ../src/guestfs-actions.pod:5633 ../src/guestfs-actions.pod:5652
5787 #: ../src/guestfs-actions.pod:5664 ../src/guestfs-actions.pod:5676
5788 #: ../src/guestfs-actions.pod:5690 ../src/guestfs-actions.pod:5702
5789 #: ../src/guestfs-actions.pod:5716 ../src/guestfs-actions.pod:5732
5790 #: ../src/guestfs-actions.pod:5753 ../src/guestfs-actions.pod:5772
5791 #: ../src/guestfs-actions.pod:5791 ../src/guestfs-actions.pod:5821
5792 #: ../src/guestfs-actions.pod:5837 ../src/guestfs-actions.pod:5860
5793 #: ../src/guestfs-actions.pod:5878 ../src/guestfs-actions.pod:5897
5794 #: ../src/guestfs-actions.pod:5918 ../src/guestfs-actions.pod:5937
5795 #: ../src/guestfs-actions.pod:5954 ../src/guestfs-actions.pod:5982
5796 #: ../src/guestfs-actions.pod:6006 ../src/guestfs-actions.pod:6025
5797 #: ../src/guestfs-actions.pod:6049 ../src/guestfs-actions.pod:6068
5798 #: ../src/guestfs-actions.pod:6083 ../src/guestfs-actions.pod:6102
5799 #: ../src/guestfs-actions.pod:6139 ../src/guestfs-actions.pod:6162
5800 #: ../src/guestfs-actions.pod:6188 ../src/guestfs-actions.pod:6296
5801 #: ../src/guestfs-actions.pod:6417 ../src/guestfs-actions.pod:6429
5802 #: ../src/guestfs-actions.pod:6442 ../src/guestfs-actions.pod:6455
5803 #: ../src/guestfs-actions.pod:6477 ../src/guestfs-actions.pod:6490
5804 #: ../src/guestfs-actions.pod:6503 ../src/guestfs-actions.pod:6516
5805 #: ../src/guestfs-actions.pod:6531 ../src/guestfs-actions.pod:6590
5806 #: ../src/guestfs-actions.pod:6607 ../src/guestfs-actions.pod:6623
5807 #: ../src/guestfs-actions.pod:6639 ../src/guestfs-actions.pod:6656
5808 #: ../src/guestfs-actions.pod:6669 ../src/guestfs-actions.pod:6689
5809 #: ../src/guestfs-actions.pod:6725 ../src/guestfs-actions.pod:6739
5810 #: ../src/guestfs-actions.pod:6780 ../src/guestfs-actions.pod:6793
5811 #: ../src/guestfs-actions.pod:6811 ../src/guestfs-actions.pod:6845
5812 #: ../src/guestfs-actions.pod:6881 ../src/guestfs-actions.pod:7000
5813 #: ../src/guestfs-actions.pod:7018 ../src/guestfs-actions.pod:7032
5814 #: ../src/guestfs-actions.pod:7087 ../src/guestfs-actions.pod:7100
5815 #: ../src/guestfs-actions.pod:7145 ../src/guestfs-actions.pod:7178
5816 #: ../src/guestfs-actions.pod:7232 ../src/guestfs-actions.pod:7258
5817 #: ../src/guestfs-actions.pod:7324 ../src/guestfs-actions.pod:7343
5818 #: ../src/guestfs-actions.pod:7372
5819 msgid "This function returns 0 on success or -1 on error."
5823 #: ../src/guestfs-actions.pod:32 ../src/guestfs-actions.pod:248
5824 #: ../src/guestfs-actions.pod:269 ../fish/guestfish-actions.pod:28
5825 #: ../fish/guestfish-actions.pod:158 ../fish/guestfish-actions.pod:172
5827 "This function is deprecated. In new code, use the C<add_drive_opts> call "
5832 #: ../src/guestfs-actions.pod:35 ../src/guestfs-actions.pod:251
5833 #: ../src/guestfs-actions.pod:272 ../src/guestfs-actions.pod:1448
5834 #: ../src/guestfs-actions.pod:1944 ../src/guestfs-actions.pod:1965
5835 #: ../src/guestfs-actions.pod:4421 ../src/guestfs-actions.pod:7266
5836 #: ../src/guestfs-actions.pod:7435 ../fish/guestfish-actions.pod:31
5837 #: ../fish/guestfish-actions.pod:161 ../fish/guestfish-actions.pod:175
5838 #: ../fish/guestfish-actions.pod:956 ../fish/guestfish-actions.pod:1319
5839 #: ../fish/guestfish-actions.pod:1333 ../fish/guestfish-actions.pod:3000
5840 #: ../fish/guestfish-actions.pod:4858 ../fish/guestfish-actions.pod:4955
5842 "Deprecated functions will not be removed from the API, but the fact that "
5843 "they are deprecated indicates that there are problems with correct use of "
5848 #: ../src/guestfs-actions.pod:39 ../src/guestfs-actions.pod:136
5849 #: ../src/guestfs-actions.pod:1100 ../src/guestfs-actions.pod:1916
5850 #: ../src/guestfs-actions.pod:2014 ../src/guestfs-actions.pod:2117
5851 #: ../src/guestfs-actions.pod:3453 ../src/guestfs-actions.pod:3473
5852 #: ../src/guestfs-actions.pod:4725 ../src/guestfs-actions.pod:5839
5853 #: ../src/guestfs-actions.pod:5956 ../src/guestfs-actions.pod:6070
5854 #: ../src/guestfs-actions.pod:6533 ../src/guestfs-actions.pod:6658
5855 #: ../src/guestfs-actions.pod:7180
5856 msgid "(Added in 0.3)"
5860 #: ../src/guestfs-actions.pod:41
5861 msgid "guestfs_add_domain"
5865 #: ../src/guestfs-actions.pod:43
5869 " guestfs_add_domain (guestfs_h *g,\n"
5870 " const char *dom,\n"
5876 #: ../src/guestfs-actions.pod:48 ../src/guestfs-actions.pod:145
5877 #: ../src/guestfs-actions.pod:4435
5879 "You may supply a list of optional arguments to this call. Use zero or more "
5880 "of the following pairs of parameters, and terminate the list with C<-1> on "
5881 "its own. See L</CALLS WITH OPTIONAL ARGUMENTS>."
5885 #: ../src/guestfs-actions.pod:53
5888 " GUESTFS_ADD_DOMAIN_LIBVIRTURI, const char *libvirturi,\n"
5889 " GUESTFS_ADD_DOMAIN_READONLY, int readonly,\n"
5890 " GUESTFS_ADD_DOMAIN_IFACE, const char *iface,\n"
5891 " GUESTFS_ADD_DOMAIN_LIVE, int live,\n"
5896 #: ../src/guestfs-actions.pod:58
5898 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
5899 "It works by connecting to libvirt, requesting the domain and domain XML from "
5900 "libvirt, parsing it for disks, and calling C<guestfs_add_drive_opts> on each "
5905 #: ../src/guestfs-actions.pod:63 ../fish/guestfish-actions.pod:46
5907 "The number of disks added is returned. This operation is atomic: if an "
5908 "error is returned, then no disks are added."
5912 #: ../src/guestfs-actions.pod:66 ../fish/guestfish-actions.pod:49
5914 "This function does some minimal checks to make sure the libvirt domain is "
5915 "not running (unless C<readonly> is true). In a future version we will try "
5916 "to acquire the libvirt lock on each disk."
5920 #: ../src/guestfs-actions.pod:70 ../fish/guestfish-actions.pod:53
5922 "Disks must be accessible locally. This often means that adding disks from a "
5923 "remote libvirt connection (see L<http://libvirt.org/remote.html>) will fail "
5924 "unless those disks are accessible via the same device path locally too."
5928 #: ../src/guestfs-actions.pod:75 ../fish/guestfish-actions.pod:58
5930 "The optional C<libvirturi> parameter sets the libvirt URI (see L<http://"
5931 "libvirt.org/uri.html>). If this is not set then we connect to the default "
5932 "libvirt URI (or one set through an environment variable, see the libvirt "
5933 "documentation for full details)."
5937 #: ../src/guestfs-actions.pod:81 ../fish/guestfish-actions.pod:64
5939 "The optional C<live> flag controls whether this call will try to connect to "
5940 "a running virtual machine C<guestfsd> process if it sees a suitable "
5941 "E<lt>channelE<gt> element in the libvirt XML definition. The default (if "
5942 "the flag is omitted) is never to try. See L<guestfs(3)/ATTACHING TO RUNNING "
5943 "DAEMONS> for more information."
5947 #: ../src/guestfs-actions.pod:88
5949 "The other optional parameters are passed directly through to "
5950 "C<guestfs_add_drive_opts>."
5954 #: ../src/guestfs-actions.pod:91 ../src/guestfs-actions.pod:344
5955 #: ../src/guestfs-actions.pod:509 ../src/guestfs-actions.pod:687
5956 #: ../src/guestfs-actions.pod:718 ../src/guestfs-actions.pod:736
5957 #: ../src/guestfs-actions.pod:755 ../src/guestfs-actions.pod:1315
5958 #: ../src/guestfs-actions.pod:1674 ../src/guestfs-actions.pod:1877
5959 #: ../src/guestfs-actions.pod:1986 ../src/guestfs-actions.pod:2026
5960 #: ../src/guestfs-actions.pod:2081 ../src/guestfs-actions.pod:2104
5961 #: ../src/guestfs-actions.pod:2397 ../src/guestfs-actions.pod:2772
5962 #: ../src/guestfs-actions.pod:2793 ../src/guestfs-actions.pod:4861
5963 #: ../src/guestfs-actions.pod:4989 ../src/guestfs-actions.pod:5395
5964 #: ../src/guestfs-actions.pod:5421 ../src/guestfs-actions.pod:6766
5965 #: ../src/guestfs-actions.pod:7191 ../src/guestfs-actions.pod:7204
5966 #: ../src/guestfs-actions.pod:7217
5967 msgid "On error this function returns -1."
5971 #: ../src/guestfs-actions.pod:93
5972 msgid "(Added in 1.7.4)"
5976 #: ../src/guestfs-actions.pod:95
5977 msgid "guestfs_add_domain_va"
5981 #: ../src/guestfs-actions.pod:97
5985 " guestfs_add_domain_va (guestfs_h *g,\n"
5986 " const char *dom,\n"
5992 #: ../src/guestfs-actions.pod:102
5993 msgid "This is the \"va_list variant\" of L</guestfs_add_domain>."
5997 #: ../src/guestfs-actions.pod:104 ../src/guestfs-actions.pod:115
5998 #: ../src/guestfs-actions.pod:208 ../src/guestfs-actions.pod:219
5999 #: ../src/guestfs-actions.pod:4488 ../src/guestfs-actions.pod:4500
6000 msgid "See L</CALLS WITH OPTIONAL ARGUMENTS>."
6004 #: ../src/guestfs-actions.pod:106
6005 msgid "guestfs_add_domain_argv"
6009 #: ../src/guestfs-actions.pod:108
6013 " guestfs_add_domain_argv (guestfs_h *g,\n"
6014 " const char *dom,\n"
6015 " const struct guestfs_add_domain_argv *optargs);\n"
6020 #: ../src/guestfs-actions.pod:113
6021 msgid "This is the \"argv variant\" of L</guestfs_add_domain>."
6025 #: ../src/guestfs-actions.pod:117
6026 msgid "guestfs_add_drive"
6030 #: ../src/guestfs-actions.pod:119
6034 " guestfs_add_drive (guestfs_h *g,\n"
6035 " const char *filename);\n"
6040 #: ../src/guestfs-actions.pod:123
6042 "This function is the equivalent of calling C<guestfs_add_drive_opts> with no "
6043 "optional parameters, so the disk is added writable, with the format being "
6044 "detected automatically."
6048 #: ../src/guestfs-actions.pod:127
6050 "Automatic detection of the format opens you up to a potential security hole "
6051 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
6052 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
6053 "you should think about replacing calls to this function with calls to "
6054 "C<guestfs_add_drive_opts>, and specifying the format."
6058 #: ../src/guestfs-actions.pod:138
6059 msgid "guestfs_add_drive_opts"
6063 #: ../src/guestfs-actions.pod:140
6067 " guestfs_add_drive_opts (guestfs_h *g,\n"
6068 " const char *filename,\n"
6074 #: ../src/guestfs-actions.pod:150
6077 " GUESTFS_ADD_DRIVE_OPTS_READONLY, int readonly,\n"
6078 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, const char *format,\n"
6079 " GUESTFS_ADD_DRIVE_OPTS_IFACE, const char *iface,\n"
6084 #: ../src/guestfs-actions.pod:154 ../fish/guestfish-actions.pod:97
6086 "This function adds a virtual machine disk image C<filename> to libguestfs. "
6087 "The first time you call this function, the disk appears as C</dev/sda>, the "
6088 "second time as C</dev/sdb>, and so on."
6092 #: ../src/guestfs-actions.pod:159 ../fish/guestfish-actions.pod:102
6094 "You don't necessarily need to be root when using libguestfs. However you "
6095 "obviously do need sufficient permissions to access the filename for whatever "
6096 "operations you want to perform (ie. read access if you just want to read the "
6097 "image or write access if you want to modify the image)."
6101 #: ../src/guestfs-actions.pod:165 ../fish/guestfish-actions.pod:108
6102 msgid "This call checks that C<filename> exists."
6106 #: ../src/guestfs-actions.pod:167 ../src/guestfs-actions.pod:4446
6107 #: ../fish/guestfish-actions.pod:110 ../fish/guestfish-actions.pod:3011
6108 msgid "The optional arguments are:"
6112 #: ../src/guestfs-actions.pod:171 ../fish/guestfish-actions.pod:114
6114 msgstr "C<readonly>"
6117 #: ../src/guestfs-actions.pod:173 ../fish/guestfish-actions.pod:116
6119 "If true then the image is treated as read-only. Writes are still allowed, "
6120 "but they are stored in a temporary snapshot overlay which is discarded at "
6121 "the end. The disk that you add is not modified."
6125 #: ../src/guestfs-actions.pod:177 ../fish/guestfish-actions.pod:120
6130 #: ../src/guestfs-actions.pod:179
6132 "This forces the image format. If you omit this (or use C<guestfs_add_drive> "
6133 "or C<guestfs_add_drive_ro>) then the format is automatically detected. "
6134 "Possible formats include C<raw> and C<qcow2>."
6138 #: ../src/guestfs-actions.pod:183 ../fish/guestfish-actions.pod:126
6140 "Automatic detection of the format opens you up to a potential security hole "
6141 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
6142 "RHBZ#642934. Specifying the format closes this security hole."
6146 #: ../src/guestfs-actions.pod:188 ../fish/guestfish-actions.pod:131
6151 #: ../src/guestfs-actions.pod:190
6153 "This rarely-used option lets you emulate the behaviour of the deprecated "
6154 "C<guestfs_add_drive_with_if> call (q.v.)"
6158 #: ../src/guestfs-actions.pod:197
6159 msgid "(Added in 1.5.23)"
6163 #: ../src/guestfs-actions.pod:199
6164 msgid "guestfs_add_drive_opts_va"
6168 #: ../src/guestfs-actions.pod:201
6172 " guestfs_add_drive_opts_va (guestfs_h *g,\n"
6173 " const char *filename,\n"
6179 #: ../src/guestfs-actions.pod:206
6180 msgid "This is the \"va_list variant\" of L</guestfs_add_drive_opts>."
6184 #: ../src/guestfs-actions.pod:210
6185 msgid "guestfs_add_drive_opts_argv"
6189 #: ../src/guestfs-actions.pod:212
6193 " guestfs_add_drive_opts_argv (guestfs_h *g,\n"
6194 " const char *filename,\n"
6195 " const struct guestfs_add_drive_opts_argv *optargs);\n"
6200 #: ../src/guestfs-actions.pod:217
6201 msgid "This is the \"argv variant\" of L</guestfs_add_drive_opts>."
6205 #: ../src/guestfs-actions.pod:221
6206 msgid "guestfs_add_drive_ro"
6210 #: ../src/guestfs-actions.pod:223
6214 " guestfs_add_drive_ro (guestfs_h *g,\n"
6215 " const char *filename);\n"
6220 #: ../src/guestfs-actions.pod:227
6222 "This function is the equivalent of calling C<guestfs_add_drive_opts> with "
6223 "the optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the "
6224 "disk is added read-only, with the format being detected automatically."
6228 #: ../src/guestfs-actions.pod:234
6229 msgid "(Added in 1.0.38)"
6233 #: ../src/guestfs-actions.pod:236
6234 msgid "guestfs_add_drive_ro_with_if"
6238 #: ../src/guestfs-actions.pod:238
6242 " guestfs_add_drive_ro_with_if (guestfs_h *g,\n"
6243 " const char *filename,\n"
6244 " const char *iface);\n"
6249 #: ../src/guestfs-actions.pod:243
6251 "This is the same as C<guestfs_add_drive_ro> but it allows you to specify the "
6252 "QEMU interface emulation to use at run time."
6256 #: ../src/guestfs-actions.pod:255 ../src/guestfs-actions.pod:276
6257 #: ../src/guestfs-actions.pod:2356
6258 msgid "(Added in 1.0.84)"
6262 #: ../src/guestfs-actions.pod:257
6263 msgid "guestfs_add_drive_with_if"
6267 #: ../src/guestfs-actions.pod:259
6271 " guestfs_add_drive_with_if (guestfs_h *g,\n"
6272 " const char *filename,\n"
6273 " const char *iface);\n"
6278 #: ../src/guestfs-actions.pod:264
6280 "This is the same as C<guestfs_add_drive> but it allows you to specify the "
6281 "QEMU interface emulation to use at run time."
6285 #: ../src/guestfs-actions.pod:278
6286 msgid "guestfs_aug_clear"
6290 #: ../src/guestfs-actions.pod:280
6294 " guestfs_aug_clear (guestfs_h *g,\n"
6295 " const char *augpath);\n"
6300 #: ../src/guestfs-actions.pod:284 ../fish/guestfish-actions.pod:183
6302 "Set the value associated with C<path> to C<NULL>. This is the same as the "
6303 "L<augtool(1)> C<clear> command."
6307 #: ../src/guestfs-actions.pod:289 ../src/guestfs-actions.pod:2106
6308 msgid "(Added in 1.3.4)"
6312 #: ../src/guestfs-actions.pod:291
6313 msgid "guestfs_aug_close"
6317 #: ../src/guestfs-actions.pod:293
6321 " guestfs_aug_close (guestfs_h *g);\n"
6326 #: ../src/guestfs-actions.pod:296
6328 "Close the current Augeas handle and free up any resources used by it. After "
6329 "calling this, you have to call C<guestfs_aug_init> again before you can use "
6330 "any other Augeas functions."
6334 #: ../src/guestfs-actions.pod:303 ../src/guestfs-actions.pod:328
6335 #: ../src/guestfs-actions.pod:346 ../src/guestfs-actions.pod:360
6336 #: ../src/guestfs-actions.pod:418 ../src/guestfs-actions.pod:438
6337 #: ../src/guestfs-actions.pod:452 ../src/guestfs-actions.pod:483
6338 #: ../src/guestfs-actions.pod:497 ../src/guestfs-actions.pod:511
6339 #: ../src/guestfs-actions.pod:525 ../src/guestfs-actions.pod:543
6340 #: ../src/guestfs-actions.pod:5472
6341 msgid "(Added in 0.7)"
6345 #: ../src/guestfs-actions.pod:305
6346 msgid "guestfs_aug_defnode"
6350 #: ../src/guestfs-actions.pod:307
6353 " struct guestfs_int_bool *\n"
6354 " guestfs_aug_defnode (guestfs_h *g,\n"
6355 " const char *name,\n"
6356 " const char *expr,\n"
6357 " const char *val);\n"
6362 #: ../src/guestfs-actions.pod:313 ../fish/guestfish-actions.pod:199
6364 "Defines a variable C<name> whose value is the result of evaluating C<expr>."
6368 #: ../src/guestfs-actions.pod:316
6370 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
6371 "calling C<guestfs_aug_set> C<expr>, C<value>. C<name> will be the nodeset "
6372 "containing that single node."
6376 #: ../src/guestfs-actions.pod:320 ../fish/guestfish-actions.pod:206
6378 "On success this returns a pair containing the number of nodes in the "
6379 "nodeset, and a boolean flag if a node was created."
6383 #: ../src/guestfs-actions.pod:324
6385 "This function returns a C<struct guestfs_int_bool *>, or NULL if there was "
6386 "an error. I<The caller must call C<guestfs_free_int_bool> after use>."
6390 #: ../src/guestfs-actions.pod:330
6391 msgid "guestfs_aug_defvar"
6395 #: ../src/guestfs-actions.pod:332
6399 " guestfs_aug_defvar (guestfs_h *g,\n"
6400 " const char *name,\n"
6401 " const char *expr);\n"
6406 #: ../src/guestfs-actions.pod:337 ../fish/guestfish-actions.pod:214
6408 "Defines an Augeas variable C<name> whose value is the result of evaluating "
6409 "C<expr>. If C<expr> is NULL, then C<name> is undefined."
6413 #: ../src/guestfs-actions.pod:341 ../fish/guestfish-actions.pod:218
6415 "On success this returns the number of nodes in C<expr>, or C<0> if C<expr> "
6416 "evaluates to something which is not a nodeset."
6420 #: ../src/guestfs-actions.pod:348
6421 msgid "guestfs_aug_get"
6425 #: ../src/guestfs-actions.pod:350
6429 " guestfs_aug_get (guestfs_h *g,\n"
6430 " const char *augpath);\n"
6435 #: ../src/guestfs-actions.pod:354 ../fish/guestfish-actions.pod:225
6437 "Look up the value associated with C<path>. If C<path> matches exactly one "
6438 "node, the C<value> is returned."
6442 #: ../src/guestfs-actions.pod:357 ../src/guestfs-actions.pod:857
6443 #: ../src/guestfs-actions.pod:875 ../src/guestfs-actions.pod:935
6444 #: ../src/guestfs-actions.pod:951 ../src/guestfs-actions.pod:1054
6445 #: ../src/guestfs-actions.pod:1184 ../src/guestfs-actions.pod:1201
6446 #: ../src/guestfs-actions.pod:1220 ../src/guestfs-actions.pod:1354
6447 #: ../src/guestfs-actions.pod:1545 ../src/guestfs-actions.pod:1657
6448 #: ../src/guestfs-actions.pod:1820 ../src/guestfs-actions.pod:1837
6449 #: ../src/guestfs-actions.pod:1904 ../src/guestfs-actions.pod:1938
6450 #: ../src/guestfs-actions.pod:1959 ../src/guestfs-actions.pod:2129
6451 #: ../src/guestfs-actions.pod:2321 ../src/guestfs-actions.pod:2528
6452 #: ../src/guestfs-actions.pod:2613 ../src/guestfs-actions.pod:2724
6453 #: ../src/guestfs-actions.pod:2744 ../src/guestfs-actions.pod:2864
6454 #: ../src/guestfs-actions.pod:2895 ../src/guestfs-actions.pod:2919
6455 #: ../src/guestfs-actions.pod:2956 ../src/guestfs-actions.pod:3016
6456 #: ../src/guestfs-actions.pod:3039 ../src/guestfs-actions.pod:3060
6457 #: ../src/guestfs-actions.pod:3632 ../src/guestfs-actions.pod:3982
6458 #: ../src/guestfs-actions.pod:4152 ../src/guestfs-actions.pod:4262
6459 #: ../src/guestfs-actions.pod:5007 ../src/guestfs-actions.pod:5200
6460 #: ../src/guestfs-actions.pod:5370 ../src/guestfs-actions.pod:5548
6461 #: ../src/guestfs-actions.pod:5597 ../src/guestfs-actions.pod:6209
6462 #: ../src/guestfs-actions.pod:6225 ../src/guestfs-actions.pod:6242
6463 #: ../src/guestfs-actions.pod:6266 ../src/guestfs-actions.pod:6940
6464 #: ../src/guestfs-actions.pod:6959 ../src/guestfs-actions.pod:6977
6465 #: ../src/guestfs-actions.pod:7157 ../src/guestfs-actions.pod:7429
6467 "This function returns a string, or NULL on error. I<The caller must free "
6468 "the returned string after use>."
6472 #: ../src/guestfs-actions.pod:362
6473 msgid "guestfs_aug_init"
6477 #: ../src/guestfs-actions.pod:364
6481 " guestfs_aug_init (guestfs_h *g,\n"
6482 " const char *root,\n"
6488 #: ../src/guestfs-actions.pod:369 ../fish/guestfish-actions.pod:232
6490 "Create a new Augeas handle for editing configuration files. If there was "
6491 "any previous Augeas handle associated with this guestfs session, then it is "
6496 #: ../src/guestfs-actions.pod:373
6497 msgid "You must call this before using any other C<guestfs_aug_*> commands."
6501 #: ../src/guestfs-actions.pod:376 ../fish/guestfish-actions.pod:239
6503 "C<root> is the filesystem root. C<root> must not be NULL, use C</> instead."
6507 #: ../src/guestfs-actions.pod:379 ../fish/guestfish-actions.pod:242
6509 "The flags are the same as the flags defined in E<lt>augeas.hE<gt>, the "
6510 "logical I<or> of the following integers:"
6514 #: ../src/guestfs-actions.pod:385 ../fish/guestfish-actions.pod:248
6515 msgid "C<AUG_SAVE_BACKUP> = 1"
6516 msgstr "C<AUG_SAVE_BACKUP> = 1"
6519 #: ../src/guestfs-actions.pod:387 ../fish/guestfish-actions.pod:250
6520 msgid "Keep the original file with a C<.augsave> extension."
6524 #: ../src/guestfs-actions.pod:389 ../fish/guestfish-actions.pod:252
6525 msgid "C<AUG_SAVE_NEWFILE> = 2"
6526 msgstr "C<AUG_SAVE_NEWFILE> = 2"
6529 #: ../src/guestfs-actions.pod:391 ../fish/guestfish-actions.pod:254
6531 "Save changes into a file with extension C<.augnew>, and do not overwrite "
6532 "original. Overrides C<AUG_SAVE_BACKUP>."
6536 #: ../src/guestfs-actions.pod:394 ../fish/guestfish-actions.pod:257
6537 msgid "C<AUG_TYPE_CHECK> = 4"
6538 msgstr "C<AUG_TYPE_CHECK> = 4"
6541 #: ../src/guestfs-actions.pod:396 ../fish/guestfish-actions.pod:259
6542 msgid "Typecheck lenses (can be expensive)."
6546 #: ../src/guestfs-actions.pod:398 ../fish/guestfish-actions.pod:261
6547 msgid "C<AUG_NO_STDINC> = 8"
6548 msgstr "C<AUG_NO_STDINC> = 8"
6551 #: ../src/guestfs-actions.pod:400 ../fish/guestfish-actions.pod:263
6552 msgid "Do not use standard load path for modules."
6556 #: ../src/guestfs-actions.pod:402 ../fish/guestfish-actions.pod:265
6557 msgid "C<AUG_SAVE_NOOP> = 16"
6558 msgstr "C<AUG_SAVE_NOOP> = 16"
6561 #: ../src/guestfs-actions.pod:404 ../fish/guestfish-actions.pod:267
6562 msgid "Make save a no-op, just record what would have been changed."
6566 #: ../src/guestfs-actions.pod:406 ../fish/guestfish-actions.pod:269
6567 msgid "C<AUG_NO_LOAD> = 32"
6568 msgstr "C<AUG_NO_LOAD> = 32"
6571 #: ../src/guestfs-actions.pod:408
6572 msgid "Do not load the tree in C<guestfs_aug_init>."
6576 #: ../src/guestfs-actions.pod:412
6577 msgid "To close the handle, you can call C<guestfs_aug_close>."
6581 #: ../src/guestfs-actions.pod:414 ../fish/guestfish-actions.pod:277
6582 msgid "To find out more about Augeas, see L<http://augeas.net/>."
6586 #: ../src/guestfs-actions.pod:420
6587 msgid "guestfs_aug_insert"
6591 #: ../src/guestfs-actions.pod:422
6595 " guestfs_aug_insert (guestfs_h *g,\n"
6596 " const char *augpath,\n"
6597 " const char *label,\n"
6603 #: ../src/guestfs-actions.pod:428 ../fish/guestfish-actions.pod:283
6605 "Create a new sibling C<label> for C<path>, inserting it into the tree before "
6606 "or after C<path> (depending on the boolean flag C<before>)."
6610 #: ../src/guestfs-actions.pod:432 ../fish/guestfish-actions.pod:287
6612 "C<path> must match exactly one existing node in the tree, and C<label> must "
6613 "be a label, ie. not contain C</>, C<*> or end with a bracketed index C<[N]>."
6617 #: ../src/guestfs-actions.pod:440
6618 msgid "guestfs_aug_load"
6622 #: ../src/guestfs-actions.pod:442
6626 " guestfs_aug_load (guestfs_h *g);\n"
6631 #: ../src/guestfs-actions.pod:445 ../fish/guestfish-actions.pod:295
6632 msgid "Load files into the tree."
6633 msgstr "Завантажити файли до ієрархії."
6636 #: ../src/guestfs-actions.pod:447 ../fish/guestfish-actions.pod:297
6637 msgid "See C<aug_load> in the Augeas documentation for the full gory details."
6641 #: ../src/guestfs-actions.pod:454
6642 msgid "guestfs_aug_ls"
6646 #: ../src/guestfs-actions.pod:456
6650 " guestfs_aug_ls (guestfs_h *g,\n"
6651 " const char *augpath);\n"
6656 #: ../src/guestfs-actions.pod:460
6658 "This is just a shortcut for listing C<guestfs_aug_match> C<path/*> and "
6659 "sorting the resulting nodes into alphabetical order."
6663 #: ../src/guestfs-actions.pod:463 ../src/guestfs-actions.pod:479
6664 #: ../src/guestfs-actions.pod:625 ../src/guestfs-actions.pod:1073
6665 #: ../src/guestfs-actions.pod:1369 ../src/guestfs-actions.pod:1388
6666 #: ../src/guestfs-actions.pod:1491 ../src/guestfs-actions.pod:1510
6667 #: ../src/guestfs-actions.pod:1759 ../src/guestfs-actions.pod:2201
6668 #: ../src/guestfs-actions.pod:2217 ../src/guestfs-actions.pod:2236
6669 #: ../src/guestfs-actions.pod:2279 ../src/guestfs-actions.pod:2303
6670 #: ../src/guestfs-actions.pod:2374 ../src/guestfs-actions.pod:2423
6671 #: ../src/guestfs-actions.pod:2682 ../src/guestfs-actions.pod:2973
6672 #: ../src/guestfs-actions.pod:3262 ../src/guestfs-actions.pod:3552
6673 #: ../src/guestfs-actions.pod:3614 ../src/guestfs-actions.pod:3719
6674 #: ../src/guestfs-actions.pod:4124 ../src/guestfs-actions.pod:4822
6675 #: ../src/guestfs-actions.pod:5342 ../src/guestfs-actions.pod:5468
6676 #: ../src/guestfs-actions.pod:5582 ../src/guestfs-actions.pod:6282
6677 #: ../src/guestfs-actions.pod:6343 ../src/guestfs-actions.pod:6398
6678 #: ../src/guestfs-actions.pod:6544 ../src/guestfs-actions.pod:6568
6679 #: ../src/guestfs-actions.pod:7050 ../src/guestfs-actions.pod:7070
6680 #: ../src/guestfs-actions.pod:7117 ../src/guestfs-actions.pod:7282
6681 #: ../src/guestfs-actions.pod:7301 ../src/guestfs-actions.pod:7386
6682 #: ../src/guestfs-actions.pod:7405 ../src/guestfs-actions.pod:7451
6683 #: ../src/guestfs-actions.pod:7470
6685 "This function returns a NULL-terminated array of strings (like L<environ(3)"
6686 ">), or NULL if there was an error. I<The caller must free the strings and "
6687 "the array after use>."
6691 #: ../src/guestfs-actions.pod:467 ../src/guestfs-actions.pod:998
6692 #: ../src/guestfs-actions.pod:1016 ../src/guestfs-actions.pod:1426
6693 #: ../src/guestfs-actions.pod:3340 ../src/guestfs-actions.pod:3371
6694 #: ../src/guestfs-actions.pod:3965 ../src/guestfs-actions.pod:4015
6695 #: ../src/guestfs-actions.pod:4202 ../src/guestfs-actions.pod:4235
6696 #: ../src/guestfs-actions.pod:4398 ../src/guestfs-actions.pod:4826
6697 #: ../src/guestfs-actions.pod:5283 ../src/guestfs-actions.pod:5678
6698 #: ../src/guestfs-actions.pod:5692 ../src/guestfs-actions.pod:5704
6699 #: ../src/guestfs-actions.pod:6144 ../src/guestfs-actions.pod:6782
6700 #: ../src/guestfs-actions.pod:6795 ../src/guestfs-actions.pod:7034
6701 #: ../src/guestfs-actions.pod:7270
6702 msgid "(Added in 0.8)"
6706 #: ../src/guestfs-actions.pod:469
6707 msgid "guestfs_aug_match"
6711 #: ../src/guestfs-actions.pod:471
6715 " guestfs_aug_match (guestfs_h *g,\n"
6716 " const char *augpath);\n"
6721 #: ../src/guestfs-actions.pod:475 ../fish/guestfish-actions.pod:311
6723 "Returns a list of paths which match the path expression C<path>. The "
6724 "returned paths are sufficiently qualified so that they match exactly one "
6725 "node in the current tree."
6729 #: ../src/guestfs-actions.pod:485
6730 msgid "guestfs_aug_mv"
6734 #: ../src/guestfs-actions.pod:487
6738 " guestfs_aug_mv (guestfs_h *g,\n"
6739 " const char *src,\n"
6740 " const char *dest);\n"
6745 #: ../src/guestfs-actions.pod:492 ../fish/guestfish-actions.pod:319
6747 "Move the node C<src> to C<dest>. C<src> must match exactly one node. "
6748 "C<dest> is overwritten if it exists."
6752 #: ../src/guestfs-actions.pod:499
6753 msgid "guestfs_aug_rm"
6757 #: ../src/guestfs-actions.pod:501
6761 " guestfs_aug_rm (guestfs_h *g,\n"
6762 " const char *augpath);\n"
6767 #: ../src/guestfs-actions.pod:505 ../fish/guestfish-actions.pod:326
6768 msgid "Remove C<path> and all of its children."
6772 #: ../src/guestfs-actions.pod:507 ../fish/guestfish-actions.pod:328
6773 msgid "On success this returns the number of entries which were removed."
6777 #: ../src/guestfs-actions.pod:513
6778 msgid "guestfs_aug_save"
6782 #: ../src/guestfs-actions.pod:515
6786 " guestfs_aug_save (guestfs_h *g);\n"
6791 #: ../src/guestfs-actions.pod:518 ../fish/guestfish-actions.pod:334
6792 msgid "This writes all pending changes to disk."
6796 #: ../src/guestfs-actions.pod:520
6798 "The flags which were passed to C<guestfs_aug_init> affect exactly how files "
6803 #: ../src/guestfs-actions.pod:527
6804 msgid "guestfs_aug_set"
6808 #: ../src/guestfs-actions.pod:529
6812 " guestfs_aug_set (guestfs_h *g,\n"
6813 " const char *augpath,\n"
6814 " const char *val);\n"
6819 #: ../src/guestfs-actions.pod:534 ../fish/guestfish-actions.pod:343
6820 msgid "Set the value associated with C<path> to C<val>."
6824 #: ../src/guestfs-actions.pod:536
6826 "In the Augeas API, it is possible to clear a node by setting the value to "
6827 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
6828 "this call. Instead you must use the C<guestfs_aug_clear> call."
6832 #: ../src/guestfs-actions.pod:545
6833 msgid "guestfs_available"
6837 #: ../src/guestfs-actions.pod:547
6841 " guestfs_available (guestfs_h *g,\n"
6842 " char *const *groups);\n"
6847 #: ../src/guestfs-actions.pod:551 ../fish/guestfish-actions.pod:354
6849 "This command is used to check the availability of some groups of "
6850 "functionality in the appliance, which not all builds of the libguestfs "
6851 "appliance will be able to provide."
6855 #: ../src/guestfs-actions.pod:555
6857 "The libguestfs groups, and the functions that those groups correspond to, "
6858 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
6859 "runtime by calling C<guestfs_available_all_groups>."
6863 #: ../src/guestfs-actions.pod:560 ../fish/guestfish-actions.pod:363
6865 "The argument C<groups> is a list of group names, eg: C<[\"inotify\", \"augeas"
6866 "\"]> would check for the availability of the Linux inotify functions and "
6867 "Augeas (configuration file editing) functions."
6871 #: ../src/guestfs-actions.pod:565 ../fish/guestfish-actions.pod:368
6872 msgid "The command returns no error if I<all> requested groups are available."
6876 #: ../src/guestfs-actions.pod:567 ../fish/guestfish-actions.pod:370
6878 "It fails with an error if one or more of the requested groups is unavailable "
6883 #: ../src/guestfs-actions.pod:570 ../fish/guestfish-actions.pod:373
6885 "If an unknown group name is included in the list of groups then an error is "
6890 #: ../src/guestfs-actions.pod:573 ../fish/guestfish-actions.pod:376
6892 msgstr "I<Нотатки:>"
6895 #: ../src/guestfs-actions.pod:579
6896 msgid "You must call C<guestfs_launch> before calling this function."
6900 #: ../src/guestfs-actions.pod:581 ../fish/guestfish-actions.pod:384
6902 "The reason is because we don't know what groups are supported by the "
6903 "appliance/daemon until it is running and can be queried."
6907 #: ../src/guestfs-actions.pod:587 ../fish/guestfish-actions.pod:390
6909 "If a group of functions is available, this does not necessarily mean that "
6910 "they will work. You still have to check for errors when calling individual "
6911 "API functions even if they are available."
6915 #: ../src/guestfs-actions.pod:594 ../fish/guestfish-actions.pod:397
6917 "It is usually the job of distro packagers to build complete functionality "
6918 "into the libguestfs appliance. Upstream libguestfs, if built from source "
6919 "with all requirements satisfied, will support everything."
6923 #: ../src/guestfs-actions.pod:601
6925 "This call was added in version C<1.0.80>. In previous versions of "
6926 "libguestfs all you could do would be to speculatively execute a command to "
6927 "find out if the daemon implemented it. See also C<guestfs_version>."
6931 #: ../src/guestfs-actions.pod:610 ../src/guestfs-actions.pod:1171
6932 msgid "(Added in 1.0.80)"
6936 #: ../src/guestfs-actions.pod:612
6937 msgid "guestfs_available_all_groups"
6941 #: ../src/guestfs-actions.pod:614
6945 " guestfs_available_all_groups (guestfs_h *g);\n"
6950 #: ../src/guestfs-actions.pod:617
6952 "This command returns a list of all optional groups that this daemon knows "
6953 "about. Note this returns both supported and unsupported groups. To find "
6954 "out which ones the daemon can actually support you have to call "
6955 "C<guestfs_available> on each member of the returned list."
6959 #: ../src/guestfs-actions.pod:623
6960 msgid "See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>."
6964 #: ../src/guestfs-actions.pod:629
6965 msgid "(Added in 1.3.15)"
6969 #: ../src/guestfs-actions.pod:631
6970 msgid "guestfs_base64_in"
6974 #: ../src/guestfs-actions.pod:633
6978 " guestfs_base64_in (guestfs_h *g,\n"
6979 " const char *base64file,\n"
6980 " const char *filename);\n"
6985 #: ../src/guestfs-actions.pod:638 ../fish/guestfish-actions.pod:427
6987 "This command uploads base64-encoded data from C<base64file> to C<filename>."
6991 #: ../src/guestfs-actions.pod:643 ../src/guestfs-actions.pod:657
6992 msgid "(Added in 1.3.5)"
6996 #: ../src/guestfs-actions.pod:645
6997 msgid "guestfs_base64_out"
7001 #: ../src/guestfs-actions.pod:647
7005 " guestfs_base64_out (guestfs_h *g,\n"
7006 " const char *filename,\n"
7007 " const char *base64file);\n"
7012 #: ../src/guestfs-actions.pod:652 ../fish/guestfish-actions.pod:436
7014 "This command downloads the contents of C<filename>, writing it out to local "
7015 "file C<base64file> encoded as base64."
7019 #: ../src/guestfs-actions.pod:659
7020 msgid "guestfs_blockdev_flushbufs"
7024 #: ../src/guestfs-actions.pod:661
7028 " guestfs_blockdev_flushbufs (guestfs_h *g,\n"
7029 " const char *device);\n"
7034 #: ../src/guestfs-actions.pod:665 ../fish/guestfish-actions.pod:445
7036 "This tells the kernel to flush internal buffers associated with C<device>."
7040 #: ../src/guestfs-actions.pod:668 ../src/guestfs-actions.pod:685
7041 #: ../src/guestfs-actions.pod:700 ../src/guestfs-actions.pod:716
7042 #: ../src/guestfs-actions.pod:734 ../src/guestfs-actions.pod:753
7043 #: ../src/guestfs-actions.pod:767 ../src/guestfs-actions.pod:785
7044 #: ../src/guestfs-actions.pod:799 ../src/guestfs-actions.pod:813
7045 #: ../fish/guestfish-actions.pod:448 ../fish/guestfish-actions.pod:459
7046 #: ../fish/guestfish-actions.pod:468 ../fish/guestfish-actions.pod:478
7047 #: ../fish/guestfish-actions.pod:490 ../fish/guestfish-actions.pod:503
7048 #: ../fish/guestfish-actions.pod:511 ../fish/guestfish-actions.pod:522
7049 #: ../fish/guestfish-actions.pod:530 ../fish/guestfish-actions.pod:538
7050 msgid "This uses the L<blockdev(8)> command."
7054 #: ../src/guestfs-actions.pod:672 ../src/guestfs-actions.pod:689
7055 #: ../src/guestfs-actions.pod:704 ../src/guestfs-actions.pod:720
7056 #: ../src/guestfs-actions.pod:738 ../src/guestfs-actions.pod:757
7057 #: ../src/guestfs-actions.pod:771 ../src/guestfs-actions.pod:789
7058 #: ../src/guestfs-actions.pod:803 ../src/guestfs-actions.pod:817
7059 msgid "(Added in 0.9.3)"
7063 #: ../src/guestfs-actions.pod:674
7064 msgid "guestfs_blockdev_getbsz"
7068 #: ../src/guestfs-actions.pod:676
7072 " guestfs_blockdev_getbsz (guestfs_h *g,\n"
7073 " const char *device);\n"
7078 #: ../src/guestfs-actions.pod:680 ../fish/guestfish-actions.pod:454
7079 msgid "This returns the block size of a device."
7083 #: ../src/guestfs-actions.pod:682 ../src/guestfs-actions.pod:782
7084 #: ../fish/guestfish-actions.pod:456 ../fish/guestfish-actions.pod:519
7086 "(Note this is different from both I<size in blocks> and I<filesystem block "
7091 #: ../src/guestfs-actions.pod:691
7092 msgid "guestfs_blockdev_getro"
7096 #: ../src/guestfs-actions.pod:693
7100 " guestfs_blockdev_getro (guestfs_h *g,\n"
7101 " const char *device);\n"
7106 #: ../src/guestfs-actions.pod:697 ../fish/guestfish-actions.pod:465
7108 "Returns a boolean indicating if the block device is read-only (true if read-"
7109 "only, false if not)."
7113 #: ../src/guestfs-actions.pod:702 ../src/guestfs-actions.pod:1409
7114 #: ../src/guestfs-actions.pod:1424 ../src/guestfs-actions.pod:1914
7115 #: ../src/guestfs-actions.pod:1925 ../src/guestfs-actions.pod:1997
7116 #: ../src/guestfs-actions.pod:2052 ../src/guestfs-actions.pod:2067
7117 #: ../src/guestfs-actions.pod:2092 ../src/guestfs-actions.pod:2115
7118 #: ../src/guestfs-actions.pod:3080 ../src/guestfs-actions.pod:3097
7119 #: ../src/guestfs-actions.pod:3116 ../src/guestfs-actions.pod:3279
7120 #: ../src/guestfs-actions.pod:3293 ../src/guestfs-actions.pod:3308
7121 #: ../src/guestfs-actions.pod:3322 ../src/guestfs-actions.pod:3338
7122 #: ../src/guestfs-actions.pod:3353 ../src/guestfs-actions.pod:3369
7123 #: ../src/guestfs-actions.pod:3383 ../src/guestfs-actions.pod:3396
7124 #: ../src/guestfs-actions.pod:3410 ../src/guestfs-actions.pod:3425
7125 #: ../src/guestfs-actions.pod:3440 ../src/guestfs-actions.pod:4971
7126 msgid "This function returns a C truth value on success or -1 on error."
7130 #: ../src/guestfs-actions.pod:706
7131 msgid "guestfs_blockdev_getsize64"
7135 #: ../src/guestfs-actions.pod:708
7139 " guestfs_blockdev_getsize64 (guestfs_h *g,\n"
7140 " const char *device);\n"
7145 #: ../src/guestfs-actions.pod:712 ../fish/guestfish-actions.pod:474
7146 msgid "This returns the size of the device in bytes."
7150 #: ../src/guestfs-actions.pod:714
7151 msgid "See also C<guestfs_blockdev_getsz>."
7155 #: ../src/guestfs-actions.pod:722
7156 msgid "guestfs_blockdev_getss"
7160 #: ../src/guestfs-actions.pod:724
7164 " guestfs_blockdev_getss (guestfs_h *g,\n"
7165 " const char *device);\n"
7170 #: ../src/guestfs-actions.pod:728 ../fish/guestfish-actions.pod:484
7172 "This returns the size of sectors on a block device. Usually 512, but can be "
7173 "larger for modern devices."
7177 #: ../src/guestfs-actions.pod:731
7179 "(Note, this is not the size in sectors, use C<guestfs_blockdev_getsz> for "
7184 #: ../src/guestfs-actions.pod:740
7185 msgid "guestfs_blockdev_getsz"
7189 #: ../src/guestfs-actions.pod:742
7193 " guestfs_blockdev_getsz (guestfs_h *g,\n"
7194 " const char *device);\n"
7199 #: ../src/guestfs-actions.pod:746 ../fish/guestfish-actions.pod:496
7201 "This returns the size of the device in units of 512-byte sectors (even if "
7202 "the sectorsize isn't 512 bytes ... weird)."
7206 #: ../src/guestfs-actions.pod:749
7208 "See also C<guestfs_blockdev_getss> for the real sector size of the device, "
7209 "and C<guestfs_blockdev_getsize64> for the more useful I<size in bytes>."
7213 #: ../src/guestfs-actions.pod:759
7214 msgid "guestfs_blockdev_rereadpt"
7218 #: ../src/guestfs-actions.pod:761
7222 " guestfs_blockdev_rereadpt (guestfs_h *g,\n"
7223 " const char *device);\n"
7228 #: ../src/guestfs-actions.pod:765 ../fish/guestfish-actions.pod:509
7229 msgid "Reread the partition table on C<device>."
7233 #: ../src/guestfs-actions.pod:773
7234 msgid "guestfs_blockdev_setbsz"
7238 #: ../src/guestfs-actions.pod:775
7242 " guestfs_blockdev_setbsz (guestfs_h *g,\n"
7243 " const char *device,\n"
7244 " int blocksize);\n"
7249 #: ../src/guestfs-actions.pod:780 ../fish/guestfish-actions.pod:517
7250 msgid "This sets the block size of a device."
7254 #: ../src/guestfs-actions.pod:791
7255 msgid "guestfs_blockdev_setro"
7259 #: ../src/guestfs-actions.pod:793
7263 " guestfs_blockdev_setro (guestfs_h *g,\n"
7264 " const char *device);\n"
7269 #: ../src/guestfs-actions.pod:797 ../fish/guestfish-actions.pod:528
7270 msgid "Sets the block device named C<device> to read-only."
7274 #: ../src/guestfs-actions.pod:805
7275 msgid "guestfs_blockdev_setrw"
7279 #: ../src/guestfs-actions.pod:807
7283 " guestfs_blockdev_setrw (guestfs_h *g,\n"
7284 " const char *device);\n"
7289 #: ../src/guestfs-actions.pod:811 ../fish/guestfish-actions.pod:536
7290 msgid "Sets the block device named C<device> to read-write."
7294 #: ../src/guestfs-actions.pod:819
7295 msgid "guestfs_case_sensitive_path"
7299 #: ../src/guestfs-actions.pod:821
7303 " guestfs_case_sensitive_path (guestfs_h *g,\n"
7304 " const char *path);\n"
7309 #: ../src/guestfs-actions.pod:825 ../fish/guestfish-actions.pod:544
7311 "This can be used to resolve case insensitive paths on a filesystem which is "
7312 "case sensitive. The use case is to resolve paths which you have read from "
7313 "Windows configuration files or the Windows Registry, to the true path."
7317 #: ../src/guestfs-actions.pod:830 ../fish/guestfish-actions.pod:549
7319 "The command handles a peculiarity of the Linux ntfs-3g filesystem driver "
7320 "(and probably others), which is that although the underlying filesystem is "
7321 "case-insensitive, the driver exports the filesystem to Linux as case-"
7326 #: ../src/guestfs-actions.pod:835 ../fish/guestfish-actions.pod:554
7328 "One consequence of this is that special directories such as C<c:\\windows> "
7329 "may appear as C</WINDOWS> or C</windows> (or other things) depending on the "
7330 "precise details of how they were created. In Windows itself this would not "
7335 #: ../src/guestfs-actions.pod:841 ../fish/guestfish-actions.pod:560
7337 "Bug or feature? You decide: L<http://www.tuxera.com/community/ntfs-3g-faq/"
7342 #: ../src/guestfs-actions.pod:844 ../fish/guestfish-actions.pod:563
7344 "This function resolves the true case of each element in the path and returns "
7345 "the case-sensitive path."
7349 #: ../src/guestfs-actions.pod:847
7351 "Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\") might return C<"
7352 "\"/WINDOWS/system32\"> (the exact return value would depend on details of "
7353 "how the directories were originally created under Windows)."
7357 #: ../src/guestfs-actions.pod:852 ../fish/guestfish-actions.pod:571
7358 msgid "I<Note>: This function does not handle drive names, backslashes etc."
7362 #: ../src/guestfs-actions.pod:855
7363 msgid "See also C<guestfs_realpath>."
7367 #: ../src/guestfs-actions.pod:860 ../src/guestfs-actions.pod:6962
7368 msgid "(Added in 1.0.75)"
7372 #: ../src/guestfs-actions.pod:862
7377 #: ../src/guestfs-actions.pod:864
7381 " guestfs_cat (guestfs_h *g,\n"
7382 " const char *path);\n"
7387 #: ../src/guestfs-actions.pod:868 ../src/guestfs-actions.pod:5458
7388 #: ../fish/guestfish-actions.pod:580 ../fish/guestfish-actions.pod:3659
7389 msgid "Return the contents of the file named C<path>."
7393 #: ../src/guestfs-actions.pod:870
7395 "Note that this function cannot correctly handle binary files (specifically, "
7396 "files containing C<\\0> character which is treated as end of string). For "
7397 "those you need to use the C<guestfs_read_file> or C<guestfs_download> "
7398 "functions which have a more complex interface."
7402 #: ../src/guestfs-actions.pod:878 ../src/guestfs-actions.pod:1057
7403 #: ../src/guestfs-actions.pod:1077 ../src/guestfs-actions.pod:1373
7404 #: ../src/guestfs-actions.pod:1392 ../src/guestfs-actions.pod:1495
7405 #: ../src/guestfs-actions.pod:1514 ../src/guestfs-actions.pod:1763
7406 #: ../src/guestfs-actions.pod:2221 ../src/guestfs-actions.pod:2240
7407 #: ../src/guestfs-actions.pod:2283 ../src/guestfs-actions.pod:2307
7408 #: ../src/guestfs-actions.pod:2324 ../src/guestfs-actions.pod:2353
7409 #: ../src/guestfs-actions.pod:5240 ../src/guestfs-actions.pod:5266
7410 #: ../src/guestfs-actions.pod:5397 ../src/guestfs-actions.pod:5423
7411 #: ../src/guestfs-actions.pod:5447 ../src/guestfs-actions.pod:6347
7412 #: ../src/guestfs-actions.pod:6402 ../src/guestfs-actions.pod:6548
7413 #: ../src/guestfs-actions.pod:6572 ../src/guestfs-actions.pod:7234
7414 #: ../src/guestfs-actions.pod:7260 ../src/guestfs-actions.pod:7286
7415 #: ../src/guestfs-actions.pod:7305 ../src/guestfs-actions.pod:7390
7416 #: ../src/guestfs-actions.pod:7409 ../src/guestfs-actions.pod:7455
7417 #: ../src/guestfs-actions.pod:7474 ../fish/guestfish-actions.pod:587
7418 #: ../fish/guestfish-actions.pod:722 ../fish/guestfish-actions.pod:734
7419 #: ../fish/guestfish-actions.pod:910 ../fish/guestfish-actions.pod:920
7420 #: ../fish/guestfish-actions.pod:987 ../fish/guestfish-actions.pod:997
7421 #: ../fish/guestfish-actions.pod:1192 ../fish/guestfish-actions.pod:1493
7422 #: ../fish/guestfish-actions.pod:1503 ../fish/guestfish-actions.pod:1531
7423 #: ../fish/guestfish-actions.pod:1546 ../fish/guestfish-actions.pod:1556
7424 #: ../fish/guestfish-actions.pod:1575 ../fish/guestfish-actions.pod:3529
7425 #: ../fish/guestfish-actions.pod:3544 ../fish/guestfish-actions.pod:3620
7426 #: ../fish/guestfish-actions.pod:3637 ../fish/guestfish-actions.pod:3652
7427 #: ../fish/guestfish-actions.pod:4278 ../fish/guestfish-actions.pod:4324
7428 #: ../fish/guestfish-actions.pod:4409 ../fish/guestfish-actions.pod:4424
7429 #: ../fish/guestfish-actions.pod:4834 ../fish/guestfish-actions.pod:4852
7430 #: ../fish/guestfish-actions.pod:4869 ../fish/guestfish-actions.pod:4879
7431 #: ../fish/guestfish-actions.pod:4927 ../fish/guestfish-actions.pod:4937
7432 #: ../fish/guestfish-actions.pod:4966 ../fish/guestfish-actions.pod:4976
7434 "Because of the message protocol, there is a transfer limit of somewhere "
7435 "between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
7439 #: ../src/guestfs-actions.pod:881 ../src/guestfs-actions.pod:3556
7440 #: ../src/guestfs-actions.pod:3618 ../src/guestfs-actions.pod:3635
7441 #: ../src/guestfs-actions.pod:3723 ../src/guestfs-actions.pod:4128
7442 #: ../src/guestfs-actions.pod:4142 ../src/guestfs-actions.pod:5346
7443 #: ../src/guestfs-actions.pod:5360 ../src/guestfs-actions.pod:7121
7444 #: ../src/guestfs-actions.pod:7135
7445 msgid "(Added in 0.4)"
7449 #: ../src/guestfs-actions.pod:883
7450 msgid "guestfs_checksum"
7454 #: ../src/guestfs-actions.pod:885
7458 " guestfs_checksum (guestfs_h *g,\n"
7459 " const char *csumtype,\n"
7460 " const char *path);\n"
7465 #: ../src/guestfs-actions.pod:890 ../fish/guestfish-actions.pod:594
7467 "This call computes the MD5, SHAx or CRC checksum of the file named C<path>."
7471 #: ../src/guestfs-actions.pod:893 ../fish/guestfish-actions.pod:597
7473 "The type of checksum to compute is given by the C<csumtype> parameter which "
7474 "must have one of the following values:"
7478 #: ../src/guestfs-actions.pod:898 ../fish/guestfish-actions.pod:602
7483 #: ../src/guestfs-actions.pod:900 ../fish/guestfish-actions.pod:604
7485 "Compute the cyclic redundancy check (CRC) specified by POSIX for the "
7490 #: ../src/guestfs-actions.pod:903 ../fish/guestfish-actions.pod:607
7495 #: ../src/guestfs-actions.pod:905 ../fish/guestfish-actions.pod:609
7496 msgid "Compute the MD5 hash (using the C<md5sum> program)."
7500 #: ../src/guestfs-actions.pod:907 ../fish/guestfish-actions.pod:611
7505 #: ../src/guestfs-actions.pod:909 ../fish/guestfish-actions.pod:613
7506 msgid "Compute the SHA1 hash (using the C<sha1sum> program)."
7510 #: ../src/guestfs-actions.pod:911 ../fish/guestfish-actions.pod:615
7515 #: ../src/guestfs-actions.pod:913 ../fish/guestfish-actions.pod:617
7516 msgid "Compute the SHA224 hash (using the C<sha224sum> program)."
7520 #: ../src/guestfs-actions.pod:915 ../fish/guestfish-actions.pod:619
7525 #: ../src/guestfs-actions.pod:917 ../fish/guestfish-actions.pod:621
7526 msgid "Compute the SHA256 hash (using the C<sha256sum> program)."
7530 #: ../src/guestfs-actions.pod:919 ../fish/guestfish-actions.pod:623
7535 #: ../src/guestfs-actions.pod:921 ../fish/guestfish-actions.pod:625
7536 msgid "Compute the SHA384 hash (using the C<sha384sum> program)."
7540 #: ../src/guestfs-actions.pod:923 ../fish/guestfish-actions.pod:627
7545 #: ../src/guestfs-actions.pod:925 ../fish/guestfish-actions.pod:629
7546 msgid "Compute the SHA512 hash (using the C<sha512sum> program)."
7550 #: ../src/guestfs-actions.pod:929 ../fish/guestfish-actions.pod:633
7551 msgid "The checksum is returned as a printable string."
7555 #: ../src/guestfs-actions.pod:931
7556 msgid "To get the checksum for a device, use C<guestfs_checksum_device>."
7560 #: ../src/guestfs-actions.pod:933
7561 msgid "To get the checksums for many files, use C<guestfs_checksums_out>."
7565 #: ../src/guestfs-actions.pod:938 ../src/guestfs-actions.pod:1246
7566 #: ../src/guestfs-actions.pod:2083 ../src/guestfs-actions.pod:3295
7567 #: ../src/guestfs-actions.pod:3324 ../src/guestfs-actions.pod:3385
7568 #: ../src/guestfs-actions.pod:3412 ../src/guestfs-actions.pod:6818
7569 msgid "(Added in 1.0.2)"
7573 #: ../src/guestfs-actions.pod:940
7574 msgid "guestfs_checksum_device"
7578 #: ../src/guestfs-actions.pod:942
7582 " guestfs_checksum_device (guestfs_h *g,\n"
7583 " const char *csumtype,\n"
7584 " const char *device);\n"
7589 #: ../src/guestfs-actions.pod:947
7591 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
7592 "device named C<device>. For the types of checksums supported see the "
7593 "C<guestfs_checksum> command."
7597 #: ../src/guestfs-actions.pod:954 ../src/guestfs-actions.pod:4877
7598 #: ../src/guestfs-actions.pod:4936 ../src/guestfs-actions.pod:4973
7599 #: ../src/guestfs-actions.pod:4991 ../src/guestfs-actions.pod:5167
7600 #: ../src/guestfs-actions.pod:6727 ../src/guestfs-actions.pod:6741
7601 #: ../src/guestfs-actions.pod:7147
7602 msgid "(Added in 1.3.2)"
7606 #: ../src/guestfs-actions.pod:956
7607 msgid "guestfs_checksums_out"
7611 #: ../src/guestfs-actions.pod:958
7615 " guestfs_checksums_out (guestfs_h *g,\n"
7616 " const char *csumtype,\n"
7617 " const char *directory,\n"
7618 " const char *sumsfile);\n"
7623 #: ../src/guestfs-actions.pod:964 ../fish/guestfish-actions.pod:651
7625 "This command computes the checksums of all regular files in C<directory> and "
7626 "then emits a list of those checksums to the local output file C<sumsfile>."
7630 #: ../src/guestfs-actions.pod:968 ../fish/guestfish-actions.pod:655
7632 "This can be used for verifying the integrity of a virtual machine. However "
7633 "to be properly secure you should pay attention to the output of the checksum "
7634 "command (it uses the ones from GNU coreutils). In particular when the "
7635 "filename is not printable, coreutils uses a special backslash syntax. For "
7636 "more information, see the GNU coreutils info file."
7640 #: ../src/guestfs-actions.pod:978
7641 msgid "(Added in 1.3.7)"
7645 #: ../src/guestfs-actions.pod:980
7646 msgid "guestfs_chmod"
7650 #: ../src/guestfs-actions.pod:982
7654 " guestfs_chmod (guestfs_h *g,\n"
7656 " const char *path);\n"
7661 #: ../src/guestfs-actions.pod:987 ../fish/guestfish-actions.pod:669
7663 "Change the mode (permissions) of C<path> to C<mode>. Only numeric modes are "
7668 #: ../src/guestfs-actions.pod:990 ../fish/guestfish-actions.pod:672
7670 "I<Note>: When using this command from guestfish, C<mode> by default would be "
7671 "decimal, unless you prefix it with C<0> to get octal, ie. use C<0700> not "
7676 #: ../src/guestfs-actions.pod:994 ../src/guestfs-actions.pod:4379
7677 #: ../src/guestfs-actions.pod:4576 ../src/guestfs-actions.pod:4595
7678 #: ../src/guestfs-actions.pod:4614 ../fish/guestfish-actions.pod:676
7679 #: ../fish/guestfish-actions.pod:2975 ../fish/guestfish-actions.pod:3104
7680 #: ../fish/guestfish-actions.pod:3114 ../fish/guestfish-actions.pod:3124
7681 msgid "The mode actually set is affected by the umask."
7685 #: ../src/guestfs-actions.pod:1000
7686 msgid "guestfs_chown"
7690 #: ../src/guestfs-actions.pod:1002
7694 " guestfs_chown (guestfs_h *g,\n"
7697 " const char *path);\n"
7702 #: ../src/guestfs-actions.pod:1008 ../fish/guestfish-actions.pod:682
7703 msgid "Change the file owner to C<owner> and group to C<group>."
7707 #: ../src/guestfs-actions.pod:1010 ../src/guestfs-actions.pod:3487
7708 #: ../fish/guestfish-actions.pod:684 ../fish/guestfish-actions.pod:2433
7710 "Only numeric uid and gid are supported. If you want to use names, you will "
7711 "need to locate and parse the password file yourself (Augeas support makes "
7712 "this relatively easy)."
7716 #: ../src/guestfs-actions.pod:1018
7717 msgid "guestfs_command"
7721 #: ../src/guestfs-actions.pod:1020
7725 " guestfs_command (guestfs_h *g,\n"
7726 " char *const *arguments);\n"
7731 #: ../src/guestfs-actions.pod:1024 ../fish/guestfish-actions.pod:692
7733 "This call runs a command from the guest filesystem. The filesystem must be "
7734 "mounted, and must contain a compatible operating system (ie. something "
7735 "Linux, with the same or compatible processor architecture)."
7739 #: ../src/guestfs-actions.pod:1029
7741 "The single parameter is an argv-style list of arguments. The first element "
7742 "is the name of the program to run. Subsequent elements are parameters. The "
7743 "list must be non-empty (ie. must contain a program name). Note that the "
7744 "command runs directly, and is I<not> invoked via the shell (see "
7749 #: ../src/guestfs-actions.pod:1036 ../fish/guestfish-actions.pod:704
7750 msgid "The return value is anything printed to I<stdout> by the command."
7754 #: ../src/guestfs-actions.pod:1039 ../fish/guestfish-actions.pod:707
7756 "If the command returns a non-zero exit status, then this function returns an "
7757 "error message. The error message string is the content of I<stderr> from "
7762 #: ../src/guestfs-actions.pod:1043 ../fish/guestfish-actions.pod:711
7764 "The C<$PATH> environment variable will contain at least C</usr/bin> and C</"
7765 "bin>. If you require a program from another location, you should provide "
7766 "the full path in the first parameter."
7770 #: ../src/guestfs-actions.pod:1048 ../fish/guestfish-actions.pod:716
7772 "Shared libraries and data files required by the program must be available on "
7773 "filesystems which are mounted in the correct places. It is the caller's "
7774 "responsibility to ensure all filesystems that are needed are mounted at the "
7779 #: ../src/guestfs-actions.pod:1060 ../src/guestfs-actions.pod:1080
7780 #: ../src/guestfs-actions.pod:1548
7781 msgid "(Added in 0.9.1)"
7785 #: ../src/guestfs-actions.pod:1062
7786 msgid "guestfs_command_lines"
7790 #: ../src/guestfs-actions.pod:1064
7794 " guestfs_command_lines (guestfs_h *g,\n"
7795 " char *const *arguments);\n"
7800 #: ../src/guestfs-actions.pod:1068
7802 "This is the same as C<guestfs_command>, but splits the result into a list of "
7807 #: ../src/guestfs-actions.pod:1071
7808 msgid "See also: C<guestfs_sh_lines>"
7812 #: ../src/guestfs-actions.pod:1082
7813 msgid "guestfs_config"
7817 #: ../src/guestfs-actions.pod:1084
7821 " guestfs_config (guestfs_h *g,\n"
7822 " const char *qemuparam,\n"
7823 " const char *qemuvalue);\n"
7828 #: ../src/guestfs-actions.pod:1089 ../fish/guestfish-actions.pod:741
7830 "This can be used to add arbitrary qemu command line parameters of the form "
7831 "C<-param value>. Actually it's not quite arbitrary - we prevent you from "
7832 "setting some parameters which would interfere with parameters that we use."
7836 #: ../src/guestfs-actions.pod:1094 ../fish/guestfish-actions.pod:746
7837 msgid "The first character of C<param> string must be a C<-> (dash)."
7841 #: ../src/guestfs-actions.pod:1096 ../fish/guestfish-actions.pod:748
7842 msgid "C<value> can be NULL."
7846 #: ../src/guestfs-actions.pod:1102
7847 msgid "guestfs_copy_size"
7851 #: ../src/guestfs-actions.pod:1104
7855 " guestfs_copy_size (guestfs_h *g,\n"
7856 " const char *src,\n"
7857 " const char *dest,\n"
7863 #: ../src/guestfs-actions.pod:1110 ../fish/guestfish-actions.pod:754
7865 "This command copies exactly C<size> bytes from one source device or file "
7866 "C<src> to another destination device or file C<dest>."
7870 #: ../src/guestfs-actions.pod:1113 ../fish/guestfish-actions.pod:757
7872 "Note this will fail if the source is too short or if the destination is not "
7877 #: ../src/guestfs-actions.pod:1118 ../src/guestfs-actions.pod:1241
7878 #: ../src/guestfs-actions.pod:1272 ../src/guestfs-actions.pod:1317
7879 #: ../src/guestfs-actions.pod:1697 ../src/guestfs-actions.pod:1719
7880 #: ../src/guestfs-actions.pod:3468 ../src/guestfs-actions.pod:6813
7881 #: ../src/guestfs-actions.pod:6847 ../src/guestfs-actions.pod:7326
7882 #: ../src/guestfs-actions.pod:7345
7884 "This long-running command can generate progress notification messages so "
7885 "that the caller can display a progress bar or indicator. To receive these "
7886 "messages, the caller must register a progress event callback. See L<guestfs"
7887 "(3)/GUESTFS_EVENT_PROGRESS>."
7891 #: ../src/guestfs-actions.pod:1123 ../src/guestfs-actions.pod:4155
7892 #: ../src/guestfs-actions.pod:5373 ../src/guestfs-actions.pod:7054
7893 #: ../src/guestfs-actions.pod:7074 ../src/guestfs-actions.pod:7160
7894 msgid "(Added in 1.0.87)"
7898 #: ../src/guestfs-actions.pod:1125
7903 #: ../src/guestfs-actions.pod:1127
7907 " guestfs_cp (guestfs_h *g,\n"
7908 " const char *src,\n"
7909 " const char *dest);\n"
7914 #: ../src/guestfs-actions.pod:1132 ../fish/guestfish-actions.pod:764
7916 "This copies a file from C<src> to C<dest> where C<dest> is either a "
7917 "destination filename or destination directory."
7921 #: ../src/guestfs-actions.pod:1137 ../src/guestfs-actions.pod:1151
7922 #: ../src/guestfs-actions.pod:1223 ../src/guestfs-actions.pod:1297
7923 #: ../src/guestfs-actions.pod:1411 ../src/guestfs-actions.pod:4840
7924 #: ../src/guestfs-actions.pod:5217
7925 msgid "(Added in 1.0.18)"
7929 #: ../src/guestfs-actions.pod:1139
7930 msgid "guestfs_cp_a"
7934 #: ../src/guestfs-actions.pod:1141
7938 " guestfs_cp_a (guestfs_h *g,\n"
7939 " const char *src,\n"
7940 " const char *dest);\n"
7945 #: ../src/guestfs-actions.pod:1146 ../fish/guestfish-actions.pod:771
7947 "This copies a file or directory from C<src> to C<dest> recursively using the "
7952 #: ../src/guestfs-actions.pod:1153
7957 #: ../src/guestfs-actions.pod:1155
7961 " guestfs_dd (guestfs_h *g,\n"
7962 " const char *src,\n"
7963 " const char *dest);\n"
7968 #: ../src/guestfs-actions.pod:1160 ../fish/guestfish-actions.pod:778
7970 "This command copies from one source device or file C<src> to another "
7971 "destination device or file C<dest>. Normally you would use this to copy to "
7972 "or from a device or partition, for example to duplicate a filesystem."
7976 #: ../src/guestfs-actions.pod:1165
7978 "If the destination is a device, it must be as large or larger than the "
7979 "source file or device, otherwise the copy will fail. This command cannot do "
7980 "partial copies (see C<guestfs_copy_size>)."
7984 #: ../src/guestfs-actions.pod:1173
7989 #: ../src/guestfs-actions.pod:1175
7993 " guestfs_df (guestfs_h *g);\n"
7998 #: ../src/guestfs-actions.pod:1178 ../fish/guestfish-actions.pod:791
7999 msgid "This command runs the C<df> command to report disk space used."
8003 #: ../src/guestfs-actions.pod:1180 ../src/guestfs-actions.pod:1197
8005 "This command is mostly useful for interactive sessions. It is I<not> "
8006 "intended that you try to parse the output string. Use C<guestfs_statvfs> "
8011 #: ../src/guestfs-actions.pod:1187 ../src/guestfs-actions.pod:1204
8012 #: ../src/guestfs-actions.pod:1322 ../src/guestfs-actions.pod:2286
8013 #: ../src/guestfs-actions.pod:2310 ../src/guestfs-actions.pod:2378
8014 #: ../src/guestfs-actions.pod:4265 ../src/guestfs-actions.pod:4740
8015 #: ../src/guestfs-actions.pod:6551 ../src/guestfs-actions.pod:6575
8016 #: ../src/guestfs-actions.pod:7193 ../src/guestfs-actions.pod:7206
8017 #: ../src/guestfs-actions.pod:7219
8018 msgid "(Added in 1.0.54)"
8022 #: ../src/guestfs-actions.pod:1189
8023 msgid "guestfs_df_h"
8027 #: ../src/guestfs-actions.pod:1191
8031 " guestfs_df_h (guestfs_h *g);\n"
8036 #: ../src/guestfs-actions.pod:1194 ../fish/guestfish-actions.pod:801
8038 "This command runs the C<df -h> command to report disk space used in human-"
8043 #: ../src/guestfs-actions.pod:1206
8044 msgid "guestfs_dmesg"
8048 #: ../src/guestfs-actions.pod:1208
8052 " guestfs_dmesg (guestfs_h *g);\n"
8057 #: ../src/guestfs-actions.pod:1211 ../fish/guestfish-actions.pod:812
8059 "This returns the kernel messages (C<dmesg> output) from the guest kernel. "
8060 "This is sometimes useful for extended debugging of problems."
8064 #: ../src/guestfs-actions.pod:1215
8066 "Another way to get the same information is to enable verbose messages with "
8067 "C<guestfs_set_verbose> or by setting the environment variable "
8068 "C<LIBGUESTFS_DEBUG=1> before running the program."
8072 #: ../src/guestfs-actions.pod:1225
8073 msgid "guestfs_download"
8077 #: ../src/guestfs-actions.pod:1227
8081 " guestfs_download (guestfs_h *g,\n"
8082 " const char *remotefilename,\n"
8083 " const char *filename);\n"
8088 #: ../src/guestfs-actions.pod:1232 ../src/guestfs-actions.pod:1257
8089 #: ../fish/guestfish-actions.pod:825 ../fish/guestfish-actions.pod:838
8091 "Download file C<remotefilename> and save it as C<filename> on the local "
8096 #: ../src/guestfs-actions.pod:1235 ../src/guestfs-actions.pod:6807
8097 #: ../fish/guestfish-actions.pod:828 ../fish/guestfish-actions.pod:4582
8098 msgid "C<filename> can also be a named pipe."
8102 #: ../src/guestfs-actions.pod:1237
8103 msgid "See also C<guestfs_upload>, C<guestfs_cat>."
8107 #: ../src/guestfs-actions.pod:1248
8108 msgid "guestfs_download_offset"
8112 #: ../src/guestfs-actions.pod:1250
8116 " guestfs_download_offset (guestfs_h *g,\n"
8117 " const char *remotefilename,\n"
8118 " const char *filename,\n"
8119 " int64_t offset,\n"
8125 #: ../src/guestfs-actions.pod:1260 ../fish/guestfish-actions.pod:841
8127 "C<remotefilename> is read for C<size> bytes starting at C<offset> (this "
8128 "region must be within the file or device)."
8132 #: ../src/guestfs-actions.pod:1263
8134 "Note that there is no limit on the amount of data that can be downloaded "
8135 "with this call, unlike with C<guestfs_pread>, and this call always reads the "
8136 "full amount unless an error occurs."
8140 #: ../src/guestfs-actions.pod:1268
8141 msgid "See also C<guestfs_download>, C<guestfs_pread>."
8145 #: ../src/guestfs-actions.pod:1277 ../src/guestfs-actions.pod:6852
8146 msgid "(Added in 1.5.17)"
8150 #: ../src/guestfs-actions.pod:1279
8151 msgid "guestfs_drop_caches"
8155 #: ../src/guestfs-actions.pod:1281
8159 " guestfs_drop_caches (guestfs_h *g,\n"
8160 " int whattodrop);\n"
8165 #: ../src/guestfs-actions.pod:1285 ../fish/guestfish-actions.pod:857
8167 "This instructs the guest kernel to drop its page cache, and/or dentries and "
8168 "inode caches. The parameter C<whattodrop> tells the kernel what precisely "
8169 "to drop, see L<http://linux-mm.org/Drop_Caches>"
8173 #: ../src/guestfs-actions.pod:1290 ../fish/guestfish-actions.pod:862
8174 msgid "Setting C<whattodrop> to 3 should drop everything."
8178 #: ../src/guestfs-actions.pod:1292 ../fish/guestfish-actions.pod:864
8180 "This automatically calls L<sync(2)> before the operation, so that the "
8181 "maximum guest memory is freed."
8185 #: ../src/guestfs-actions.pod:1299
8190 #: ../src/guestfs-actions.pod:1301
8194 " guestfs_du (guestfs_h *g,\n"
8195 " const char *path);\n"
8200 #: ../src/guestfs-actions.pod:1305 ../fish/guestfish-actions.pod:871
8202 "This command runs the C<du -s> command to estimate file space usage for "
8207 #: ../src/guestfs-actions.pod:1308 ../fish/guestfish-actions.pod:874
8209 "C<path> can be a file or a directory. If C<path> is a directory then the "
8210 "estimate includes the contents of the directory and all subdirectories "
8215 #: ../src/guestfs-actions.pod:1312 ../fish/guestfish-actions.pod:878
8217 "The result is the estimated size in I<kilobytes> (ie. units of 1024 bytes)."
8221 #: ../src/guestfs-actions.pod:1324
8222 msgid "guestfs_e2fsck_f"
8226 #: ../src/guestfs-actions.pod:1326
8230 " guestfs_e2fsck_f (guestfs_h *g,\n"
8231 " const char *device);\n"
8236 #: ../src/guestfs-actions.pod:1330 ../fish/guestfish-actions.pod:885
8238 "This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3 filesystem checker "
8239 "on C<device>, noninteractively (C<-p>), even if the filesystem appears to be "
8244 #: ../src/guestfs-actions.pod:1334
8246 "This command is only needed because of C<guestfs_resize2fs> (q.v.). "
8247 "Normally you should use C<guestfs_fsck>."
8251 #: ../src/guestfs-actions.pod:1339
8252 msgid "(Added in 1.0.29)"
8256 #: ../src/guestfs-actions.pod:1341
8257 msgid "guestfs_echo_daemon"
8261 #: ../src/guestfs-actions.pod:1343
8265 " guestfs_echo_daemon (guestfs_h *g,\n"
8266 " char *const *words);\n"
8271 #: ../src/guestfs-actions.pod:1347 ../fish/guestfish-actions.pod:896
8273 "This command concatenates the list of C<words> passed with single spaces "
8274 "between them and returns the resulting string."
8278 #: ../src/guestfs-actions.pod:1350 ../fish/guestfish-actions.pod:899
8279 msgid "You can use this command to test the connection through to the daemon."
8283 #: ../src/guestfs-actions.pod:1352
8284 msgid "See also C<guestfs_ping_daemon>."
8288 #: ../src/guestfs-actions.pod:1357 ../src/guestfs-actions.pod:2094
8289 #: ../src/guestfs-actions.pod:6051
8290 msgid "(Added in 1.0.69)"
8294 #: ../src/guestfs-actions.pod:1359
8295 msgid "guestfs_egrep"
8299 #: ../src/guestfs-actions.pod:1361
8303 " guestfs_egrep (guestfs_h *g,\n"
8304 " const char *regex,\n"
8305 " const char *path);\n"
8310 #: ../src/guestfs-actions.pod:1366 ../fish/guestfish-actions.pod:907
8312 "This calls the external C<egrep> program and returns the matching lines."
8316 #: ../src/guestfs-actions.pod:1376 ../src/guestfs-actions.pod:1395
8317 #: ../src/guestfs-actions.pod:1452 ../src/guestfs-actions.pod:1498
8318 #: ../src/guestfs-actions.pod:1517 ../src/guestfs-actions.pod:2224
8319 #: ../src/guestfs-actions.pod:2243 ../src/guestfs-actions.pod:2399
8320 #: ../src/guestfs-actions.pod:2412 ../src/guestfs-actions.pod:2427
8321 #: ../src/guestfs-actions.pod:2473 ../src/guestfs-actions.pod:2495
8322 #: ../src/guestfs-actions.pod:2508 ../src/guestfs-actions.pod:3648
8323 #: ../src/guestfs-actions.pod:3662 ../src/guestfs-actions.pod:3675
8324 #: ../src/guestfs-actions.pod:3689 ../src/guestfs-actions.pod:4675
8325 #: ../src/guestfs-actions.pod:5551 ../src/guestfs-actions.pod:5600
8326 #: ../src/guestfs-actions.pod:6419 ../src/guestfs-actions.pod:6431
8327 #: ../src/guestfs-actions.pod:6444 ../src/guestfs-actions.pod:6457
8328 #: ../src/guestfs-actions.pod:6479 ../src/guestfs-actions.pod:6492
8329 #: ../src/guestfs-actions.pod:6505 ../src/guestfs-actions.pod:6518
8330 #: ../src/guestfs-actions.pod:7289 ../src/guestfs-actions.pod:7308
8331 #: ../src/guestfs-actions.pod:7393 ../src/guestfs-actions.pod:7412
8332 #: ../src/guestfs-actions.pod:7458 ../src/guestfs-actions.pod:7477
8333 msgid "(Added in 1.0.66)"
8337 #: ../src/guestfs-actions.pod:1378
8338 msgid "guestfs_egrepi"
8342 #: ../src/guestfs-actions.pod:1380
8346 " guestfs_egrepi (guestfs_h *g,\n"
8347 " const char *regex,\n"
8348 " const char *path);\n"
8353 #: ../src/guestfs-actions.pod:1385 ../fish/guestfish-actions.pod:917
8355 "This calls the external C<egrep -i> program and returns the matching lines."
8359 #: ../src/guestfs-actions.pod:1397
8360 msgid "guestfs_equal"
8364 #: ../src/guestfs-actions.pod:1399
8368 " guestfs_equal (guestfs_h *g,\n"
8369 " const char *file1,\n"
8370 " const char *file2);\n"
8375 #: ../src/guestfs-actions.pod:1404 ../fish/guestfish-actions.pod:927
8377 "This compares the two files C<file1> and C<file2> and returns true if their "
8378 "content is exactly equal, or false otherwise."
8382 #: ../src/guestfs-actions.pod:1407 ../fish/guestfish-actions.pod:930
8383 msgid "The external L<cmp(1)> program is used for the comparison."
8387 #: ../src/guestfs-actions.pod:1413
8388 msgid "guestfs_exists"
8392 #: ../src/guestfs-actions.pod:1415
8396 " guestfs_exists (guestfs_h *g,\n"
8397 " const char *path);\n"
8402 #: ../src/guestfs-actions.pod:1419 ../fish/guestfish-actions.pod:936
8404 "This returns C<true> if and only if there is a file, directory (or anything) "
8405 "with the given C<path> name."
8409 #: ../src/guestfs-actions.pod:1422
8410 msgid "See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>."
8414 #: ../src/guestfs-actions.pod:1428
8415 msgid "guestfs_fallocate"
8419 #: ../src/guestfs-actions.pod:1430
8423 " guestfs_fallocate (guestfs_h *g,\n"
8424 " const char *path,\n"
8430 #: ../src/guestfs-actions.pod:1435 ../src/guestfs-actions.pod:1461
8431 #: ../fish/guestfish-actions.pod:945 ../fish/guestfish-actions.pod:964
8433 "This command preallocates a file (containing zero bytes) named C<path> of "
8434 "size C<len> bytes. If the file exists already, it is overwritten."
8438 #: ../src/guestfs-actions.pod:1439 ../fish/guestfish-actions.pod:949
8440 "Do not confuse this with the guestfish-specific C<alloc> command which "
8441 "allocates a file in the host and attaches it as a device."
8445 #: ../src/guestfs-actions.pod:1445 ../fish/guestfish-actions.pod:953
8447 "This function is deprecated. In new code, use the C<fallocate64> call "
8452 #: ../src/guestfs-actions.pod:1454
8453 msgid "guestfs_fallocate64"
8457 #: ../src/guestfs-actions.pod:1456
8461 " guestfs_fallocate64 (guestfs_h *g,\n"
8462 " const char *path,\n"
8468 #: ../src/guestfs-actions.pod:1465
8470 "Note that this call allocates disk blocks for the file. To create a sparse "
8471 "file use C<guestfs_truncate_size> instead."
8475 #: ../src/guestfs-actions.pod:1468
8477 "The deprecated call C<guestfs_fallocate> does the same, but owing to an "
8478 "oversight it only allowed 30 bit lengths to be specified, effectively "
8479 "limiting the maximum size of files created through that call to 1GB."
8483 #: ../src/guestfs-actions.pod:1473 ../fish/guestfish-actions.pod:976
8485 "Do not confuse this with the guestfish-specific C<alloc> and C<sparse> "
8486 "commands which create a file in the host and attach it as a device."
8490 #: ../src/guestfs-actions.pod:1479
8491 msgid "(Added in 1.3.17)"
8495 #: ../src/guestfs-actions.pod:1481
8496 msgid "guestfs_fgrep"
8500 #: ../src/guestfs-actions.pod:1483
8504 " guestfs_fgrep (guestfs_h *g,\n"
8505 " const char *pattern,\n"
8506 " const char *path);\n"
8511 #: ../src/guestfs-actions.pod:1488 ../fish/guestfish-actions.pod:984
8513 "This calls the external C<fgrep> program and returns the matching lines."
8517 #: ../src/guestfs-actions.pod:1500
8518 msgid "guestfs_fgrepi"
8522 #: ../src/guestfs-actions.pod:1502
8526 " guestfs_fgrepi (guestfs_h *g,\n"
8527 " const char *pattern,\n"
8528 " const char *path);\n"
8533 #: ../src/guestfs-actions.pod:1507 ../fish/guestfish-actions.pod:994
8535 "This calls the external C<fgrep -i> program and returns the matching lines."
8539 #: ../src/guestfs-actions.pod:1519
8540 msgid "guestfs_file"
8544 #: ../src/guestfs-actions.pod:1521
8548 " guestfs_file (guestfs_h *g,\n"
8549 " const char *path);\n"
8554 #: ../src/guestfs-actions.pod:1525 ../fish/guestfish-actions.pod:1004
8556 "This call uses the standard L<file(1)> command to determine the type or "
8557 "contents of the file."
8561 #: ../src/guestfs-actions.pod:1528 ../fish/guestfish-actions.pod:1007
8563 "This call will also transparently look inside various types of compressed "
8568 #: ../src/guestfs-actions.pod:1531 ../fish/guestfish-actions.pod:1010
8570 "The exact command which runs is C<file -zb path>. Note in particular that "
8571 "the filename is not prepended to the output (the C<-b> option)."
8575 #: ../src/guestfs-actions.pod:1535
8577 "This command can also be used on C</dev/> devices (and partitions, LV "
8578 "names). You can for example use this to determine if a device contains a "
8579 "filesystem, although it's usually better to use C<guestfs_vfs_type>."
8583 #: ../src/guestfs-actions.pod:1540 ../fish/guestfish-actions.pod:1019
8585 "If the C<path> does not begin with C</dev/> then this command only works for "
8586 "the content of regular files. For other file types (directory, symbolic "
8587 "link etc) it will just return the string C<directory> etc."
8591 #: ../src/guestfs-actions.pod:1550
8592 msgid "guestfs_file_architecture"
8596 #: ../src/guestfs-actions.pod:1552
8600 " guestfs_file_architecture (guestfs_h *g,\n"
8601 " const char *filename);\n"
8606 #: ../src/guestfs-actions.pod:1556 ../fish/guestfish-actions.pod:1028
8608 "This detects the architecture of the binary C<filename>, and returns it if "
8613 #: ../src/guestfs-actions.pod:1559 ../fish/guestfish-actions.pod:1031
8614 msgid "Currently defined architectures are:"
8618 #: ../src/guestfs-actions.pod:1563 ../fish/guestfish-actions.pod:1035
8623 #: ../src/guestfs-actions.pod:1565 ../fish/guestfish-actions.pod:1037
8625 "This string is returned for all 32 bit i386, i486, i586, i686 binaries "
8626 "irrespective of the precise processor requirements of the binary."
8630 #: ../src/guestfs-actions.pod:1568 ../fish/guestfish-actions.pod:1040
8635 #: ../src/guestfs-actions.pod:1570 ../fish/guestfish-actions.pod:1042
8636 msgid "64 bit x86-64."
8640 #: ../src/guestfs-actions.pod:1572 ../fish/guestfish-actions.pod:1044
8645 #: ../src/guestfs-actions.pod:1574 ../fish/guestfish-actions.pod:1046
8646 msgid "32 bit SPARC."
8650 #: ../src/guestfs-actions.pod:1576 ../fish/guestfish-actions.pod:1048
8655 #: ../src/guestfs-actions.pod:1578 ../fish/guestfish-actions.pod:1050
8656 msgid "64 bit SPARC V9 and above."
8660 #: ../src/guestfs-actions.pod:1580 ../fish/guestfish-actions.pod:1052
8665 #: ../src/guestfs-actions.pod:1582 ../fish/guestfish-actions.pod:1054
8666 msgid "Intel Itanium."
8667 msgstr "Intel Itanium."
8670 #: ../src/guestfs-actions.pod:1584 ../fish/guestfish-actions.pod:1056
8675 #: ../src/guestfs-actions.pod:1586 ../fish/guestfish-actions.pod:1058
8676 msgid "32 bit Power PC."
8680 #: ../src/guestfs-actions.pod:1588 ../fish/guestfish-actions.pod:1060
8685 #: ../src/guestfs-actions.pod:1590 ../fish/guestfish-actions.pod:1062
8686 msgid "64 bit Power PC."
8690 #: ../src/guestfs-actions.pod:1594 ../fish/guestfish-actions.pod:1066
8691 msgid "Libguestfs may return other architecture strings in future."
8695 #: ../src/guestfs-actions.pod:1596 ../fish/guestfish-actions.pod:1068
8696 msgid "The function works on at least the following types of files:"
8700 #: ../src/guestfs-actions.pod:1602 ../fish/guestfish-actions.pod:1074
8701 msgid "many types of Un*x and Linux binary"
8705 #: ../src/guestfs-actions.pod:1606 ../fish/guestfish-actions.pod:1078
8706 msgid "many types of Un*x and Linux shared library"
8710 #: ../src/guestfs-actions.pod:1610 ../fish/guestfish-actions.pod:1082
8711 msgid "Windows Win32 and Win64 binaries"
8715 #: ../src/guestfs-actions.pod:1614 ../fish/guestfish-actions.pod:1086
8716 msgid "Windows Win32 and Win64 DLLs"
8720 #: ../src/guestfs-actions.pod:1616 ../fish/guestfish-actions.pod:1088
8721 msgid "Win32 binaries and DLLs return C<i386>."
8725 #: ../src/guestfs-actions.pod:1618 ../fish/guestfish-actions.pod:1090
8726 msgid "Win64 binaries and DLLs return C<x86_64>."
8730 #: ../src/guestfs-actions.pod:1622 ../fish/guestfish-actions.pod:1094
8731 msgid "Linux kernel modules"
8735 #: ../src/guestfs-actions.pod:1626 ../fish/guestfish-actions.pod:1098
8736 msgid "Linux new-style initrd images"
8740 #: ../src/guestfs-actions.pod:1630 ../fish/guestfish-actions.pod:1102
8741 msgid "some non-x86 Linux vmlinuz kernels"
8745 #: ../src/guestfs-actions.pod:1634 ../fish/guestfish-actions.pod:1106
8746 msgid "What it can't do currently:"
8750 #: ../src/guestfs-actions.pod:1640 ../fish/guestfish-actions.pod:1112
8751 msgid "static libraries (libfoo.a)"
8755 #: ../src/guestfs-actions.pod:1644 ../fish/guestfish-actions.pod:1116
8756 msgid "Linux old-style initrd as compressed ext2 filesystem (RHEL 3)"
8760 #: ../src/guestfs-actions.pod:1648 ../fish/guestfish-actions.pod:1120
8761 msgid "x86 Linux vmlinuz kernels"
8765 #: ../src/guestfs-actions.pod:1650 ../fish/guestfish-actions.pod:1122
8767 "x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and "
8768 "compressed code, and are horribly hard to unpack. If you want to find the "
8769 "architecture of a kernel, use the architecture of the associated initrd or "
8770 "kernel module(s) instead."
8774 #: ../src/guestfs-actions.pod:1660 ../src/guestfs-actions.pod:1823
8775 #: ../src/guestfs-actions.pod:1840 ../src/guestfs-actions.pod:2531
8776 #: ../src/guestfs-actions.pod:2616 ../src/guestfs-actions.pod:2686
8777 #: ../src/guestfs-actions.pod:2774 ../src/guestfs-actions.pod:2795
8778 #: ../src/guestfs-actions.pod:2838 ../src/guestfs-actions.pod:2922
8779 #: ../src/guestfs-actions.pod:3019 ../src/guestfs-actions.pod:3266
8780 #: ../src/guestfs-actions.pod:3398
8781 msgid "(Added in 1.5.3)"
8785 #: ../src/guestfs-actions.pod:1662
8786 msgid "guestfs_filesize"
8790 #: ../src/guestfs-actions.pod:1664
8794 " guestfs_filesize (guestfs_h *g,\n"
8795 " const char *file);\n"
8800 #: ../src/guestfs-actions.pod:1668 ../fish/guestfish-actions.pod:1133
8801 msgid "This command returns the size of C<file> in bytes."
8805 #: ../src/guestfs-actions.pod:1670
8807 "To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>, "
8808 "C<guestfs_is_dir>, C<guestfs_is_file> etc. To get the size of block "
8809 "devices, use C<guestfs_blockdev_getsize64>."
8813 #: ../src/guestfs-actions.pod:1676
8814 msgid "(Added in 1.0.82)"
8818 #: ../src/guestfs-actions.pod:1678
8819 msgid "guestfs_fill"
8823 #: ../src/guestfs-actions.pod:1680
8827 " guestfs_fill (guestfs_h *g,\n"
8830 " const char *path);\n"
8835 #: ../src/guestfs-actions.pod:1686 ../fish/guestfish-actions.pod:1143
8837 "This command creates a new file called C<path>. The initial content of the "
8838 "file is C<len> octets of C<c>, where C<c> must be a number in the range C<"
8843 #: ../src/guestfs-actions.pod:1690
8845 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
8846 "C<guestfs_truncate_size>. To create a file with a pattern of repeating "
8847 "bytes use C<guestfs_fill_pattern>."
8851 #: ../src/guestfs-actions.pod:1702
8852 msgid "(Added in 1.0.79)"
8856 #: ../src/guestfs-actions.pod:1704
8857 msgid "guestfs_fill_pattern"
8861 #: ../src/guestfs-actions.pod:1706
8865 " guestfs_fill_pattern (guestfs_h *g,\n"
8866 " const char *pattern,\n"
8868 " const char *path);\n"
8873 #: ../src/guestfs-actions.pod:1712
8875 "This function is like C<guestfs_fill> except that it creates a new file of "
8876 "length C<len> containing the repeating pattern of bytes in C<pattern>. The "
8877 "pattern is truncated if necessary to ensure the length of the file is "
8878 "exactly C<len> bytes."
8882 #: ../src/guestfs-actions.pod:1724
8883 msgid "(Added in 1.3.12)"
8887 #: ../src/guestfs-actions.pod:1726
8888 msgid "guestfs_find"
8892 #: ../src/guestfs-actions.pod:1728
8896 " guestfs_find (guestfs_h *g,\n"
8897 " const char *directory);\n"
8902 #: ../src/guestfs-actions.pod:1732 ../fish/guestfish-actions.pod:1165
8904 "This command lists out all files and directories, recursively, starting at "
8905 "C<directory>. It is essentially equivalent to running the shell command "
8906 "C<find directory -print> but some post-processing happens on the output, "
8911 #: ../src/guestfs-actions.pod:1737 ../fish/guestfish-actions.pod:1170
8913 "This returns a list of strings I<without any prefix>. Thus if the directory "
8918 #: ../src/guestfs-actions.pod:1740 ../fish/guestfish-actions.pod:1173
8928 #: ../src/guestfs-actions.pod:1744
8930 "then the returned list from C<guestfs_find> C</tmp> would be 4 elements:"
8934 #: ../src/guestfs-actions.pod:1747 ../fish/guestfish-actions.pod:1180
8945 #: ../src/guestfs-actions.pod:1752 ../fish/guestfish-actions.pod:1185
8946 msgid "If C<directory> is not a directory, then this command returns an error."
8950 #: ../src/guestfs-actions.pod:1755 ../fish/guestfish-actions.pod:1188
8951 msgid "The returned list is sorted."
8955 #: ../src/guestfs-actions.pod:1757
8956 msgid "See also C<guestfs_find0>."
8960 #: ../src/guestfs-actions.pod:1766 ../src/guestfs-actions.pod:4092
8961 #: ../src/guestfs-actions.pod:5635
8962 msgid "(Added in 1.0.27)"
8966 #: ../src/guestfs-actions.pod:1768
8967 msgid "guestfs_find0"
8971 #: ../src/guestfs-actions.pod:1770
8975 " guestfs_find0 (guestfs_h *g,\n"
8976 " const char *directory,\n"
8977 " const char *files);\n"
8982 #: ../src/guestfs-actions.pod:1775 ../fish/guestfish-actions.pod:1199
8984 "This command lists out all files and directories, recursively, starting at "
8985 "C<directory>, placing the resulting list in the external file called "
8990 #: ../src/guestfs-actions.pod:1779
8992 "This command works the same way as C<guestfs_find> with the following "
8997 #: ../src/guestfs-actions.pod:1786 ../fish/guestfish-actions.pod:1210
8998 msgid "The resulting list is written to an external file."
9002 #: ../src/guestfs-actions.pod:1790 ../fish/guestfish-actions.pod:1214
9004 "Items (filenames) in the result are separated by C<\\0> characters. See "
9005 "L<find(1)> option I<-print0>."
9009 #: ../src/guestfs-actions.pod:1795 ../fish/guestfish-actions.pod:1219
9010 msgid "This command is not limited in the number of names that it can return."
9014 #: ../src/guestfs-actions.pod:1800 ../fish/guestfish-actions.pod:1224
9015 msgid "The result list is not sorted."
9019 #: ../src/guestfs-actions.pod:1806
9020 msgid "(Added in 1.0.74)"
9024 #: ../src/guestfs-actions.pod:1808
9025 msgid "guestfs_findfs_label"
9029 #: ../src/guestfs-actions.pod:1810
9033 " guestfs_findfs_label (guestfs_h *g,\n"
9034 " const char *label);\n"
9039 #: ../src/guestfs-actions.pod:1814 ../fish/guestfish-actions.pod:1234
9041 "This command searches the filesystems and returns the one which has the "
9042 "given label. An error is returned if no such filesystem can be found."
9046 #: ../src/guestfs-actions.pod:1818
9047 msgid "To find the label of a filesystem, use C<guestfs_vfs_label>."
9051 #: ../src/guestfs-actions.pod:1825
9052 msgid "guestfs_findfs_uuid"
9056 #: ../src/guestfs-actions.pod:1827
9060 " guestfs_findfs_uuid (guestfs_h *g,\n"
9061 " const char *uuid);\n"
9066 #: ../src/guestfs-actions.pod:1831 ../fish/guestfish-actions.pod:1244
9068 "This command searches the filesystems and returns the one which has the "
9069 "given UUID. An error is returned if no such filesystem can be found."
9073 #: ../src/guestfs-actions.pod:1835
9074 msgid "To find the UUID of a filesystem, use C<guestfs_vfs_uuid>."
9078 #: ../src/guestfs-actions.pod:1842
9079 msgid "guestfs_fsck"
9083 #: ../src/guestfs-actions.pod:1844
9087 " guestfs_fsck (guestfs_h *g,\n"
9088 " const char *fstype,\n"
9089 " const char *device);\n"
9094 #: ../src/guestfs-actions.pod:1849 ../fish/guestfish-actions.pod:1254
9096 "This runs the filesystem checker (fsck) on C<device> which should have "
9097 "filesystem type C<fstype>."
9101 #: ../src/guestfs-actions.pod:1852 ../fish/guestfish-actions.pod:1257
9103 "The returned integer is the status. See L<fsck(8)> for the list of status "
9104 "codes from C<fsck>."
9108 #: ../src/guestfs-actions.pod:1861 ../fish/guestfish-actions.pod:1266
9109 msgid "Multiple status codes can be summed together."
9113 #: ../src/guestfs-actions.pod:1865 ../fish/guestfish-actions.pod:1270
9115 "A non-zero return code can mean \"success\", for example if errors have been "
9116 "corrected on the filesystem."
9120 #: ../src/guestfs-actions.pod:1870 ../fish/guestfish-actions.pod:1275
9121 msgid "Checking or repairing NTFS volumes is not supported (by linux-ntfs)."
9125 #: ../src/guestfs-actions.pod:1875 ../fish/guestfish-actions.pod:1280
9127 "This command is entirely equivalent to running C<fsck -a -t fstype device>."
9131 #: ../src/guestfs-actions.pod:1879 ../src/guestfs-actions.pod:7331
9132 msgid "(Added in 1.0.16)"
9136 #: ../src/guestfs-actions.pod:1881
9137 msgid "guestfs_get_append"
9141 #: ../src/guestfs-actions.pod:1883
9145 " guestfs_get_append (guestfs_h *g);\n"
9150 #: ../src/guestfs-actions.pod:1886 ../fish/guestfish-actions.pod:1286
9152 "Return the additional kernel options which are added to the guest kernel "
9157 #: ../src/guestfs-actions.pod:1889 ../fish/guestfish-actions.pod:1289
9158 msgid "If C<NULL> then no options are added."
9162 #: ../src/guestfs-actions.pod:1891
9164 "This function returns a string which may be NULL. There is no way to return "
9165 "an error from this function. The string is owned by the guest handle and "
9166 "must I<not> be freed."
9170 #: ../src/guestfs-actions.pod:1895 ../src/guestfs-actions.pod:5313
9171 #: ../src/guestfs-actions.pod:5793 ../src/guestfs-actions.pod:6193
9172 #: ../src/guestfs-actions.pod:6212 ../src/guestfs-actions.pod:6228
9173 #: ../src/guestfs-actions.pod:6245 ../src/guestfs-actions.pod:7002
9174 #: ../src/guestfs-actions.pod:7020 ../src/guestfs-actions.pod:7374
9175 msgid "(Added in 1.0.26)"
9179 #: ../src/guestfs-actions.pod:1897
9180 msgid "guestfs_get_attach_method"
9184 #: ../src/guestfs-actions.pod:1899
9188 " guestfs_get_attach_method (guestfs_h *g);\n"
9193 #: ../src/guestfs-actions.pod:1902
9194 msgid "Return the current attach method. See C<guestfs_set_attach_method>."
9198 #: ../src/guestfs-actions.pod:1907
9199 msgid "guestfs_get_autosync"
9203 #: ../src/guestfs-actions.pod:1909
9207 " guestfs_get_autosync (guestfs_h *g);\n"
9212 #: ../src/guestfs-actions.pod:1912 ../fish/guestfish-actions.pod:1301
9213 msgid "Get the autosync flag."
9217 #: ../src/guestfs-actions.pod:1918
9218 msgid "guestfs_get_direct"
9222 #: ../src/guestfs-actions.pod:1920
9226 " guestfs_get_direct (guestfs_h *g);\n"
9231 #: ../src/guestfs-actions.pod:1923 ../fish/guestfish-actions.pod:1307
9232 msgid "Return the direct appliance mode flag."
9236 #: ../src/guestfs-actions.pod:1927 ../src/guestfs-actions.pod:5862
9237 msgid "(Added in 1.0.72)"
9241 #: ../src/guestfs-actions.pod:1929
9242 msgid "guestfs_get_e2label"
9246 #: ../src/guestfs-actions.pod:1931
9250 " guestfs_get_e2label (guestfs_h *g,\n"
9251 " const char *device);\n"
9256 #: ../src/guestfs-actions.pod:1935 ../fish/guestfish-actions.pod:1313
9258 "This returns the ext2/3/4 filesystem label of the filesystem on C<device>."
9262 #: ../src/guestfs-actions.pod:1941 ../fish/guestfish-actions.pod:1316
9264 "This function is deprecated. In new code, use the C<vfs_label> call instead."
9268 #: ../src/guestfs-actions.pod:1948 ../src/guestfs-actions.pod:1969
9269 #: ../src/guestfs-actions.pod:5880 ../src/guestfs-actions.pod:5899
9270 msgid "(Added in 1.0.15)"
9274 #: ../src/guestfs-actions.pod:1950
9275 msgid "guestfs_get_e2uuid"
9279 #: ../src/guestfs-actions.pod:1952
9283 " guestfs_get_e2uuid (guestfs_h *g,\n"
9284 " const char *device);\n"
9289 #: ../src/guestfs-actions.pod:1956 ../fish/guestfish-actions.pod:1327
9291 "This returns the ext2/3/4 filesystem UUID of the filesystem on C<device>."
9295 #: ../src/guestfs-actions.pod:1962 ../fish/guestfish-actions.pod:1330
9297 "This function is deprecated. In new code, use the C<vfs_uuid> call instead."
9301 #: ../src/guestfs-actions.pod:1971
9302 msgid "guestfs_get_memsize"
9306 #: ../src/guestfs-actions.pod:1973
9310 " guestfs_get_memsize (guestfs_h *g);\n"
9315 #: ../src/guestfs-actions.pod:1976 ../fish/guestfish-actions.pod:1341
9317 "This gets the memory size in megabytes allocated to the qemu subprocess."
9321 #: ../src/guestfs-actions.pod:1979
9323 "If C<guestfs_set_memsize> was not called on this handle, and if "
9324 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
9325 "value for memsize."
9329 #: ../src/guestfs-actions.pod:1983 ../src/guestfs-actions.pod:2064
9330 #: ../src/guestfs-actions.pod:5915 ../src/guestfs-actions.pod:6022
9331 #: ../fish/guestfish-actions.pod:1348 ../fish/guestfish-actions.pod:1399
9332 #: ../fish/guestfish-actions.pod:3985 ../fish/guestfish-actions.pod:4072
9334 "For more information on the architecture of libguestfs, see L<guestfs(3)>."
9338 #: ../src/guestfs-actions.pod:1988 ../src/guestfs-actions.pod:4383
9339 #: ../src/guestfs-actions.pod:4580 ../src/guestfs-actions.pod:4599
9340 #: ../src/guestfs-actions.pod:4618 ../src/guestfs-actions.pod:4630
9341 #: ../src/guestfs-actions.pod:4647 ../src/guestfs-actions.pod:4660
9342 #: ../src/guestfs-actions.pod:5538 ../src/guestfs-actions.pod:5920
9343 #: ../src/guestfs-actions.pod:6167 ../src/guestfs-actions.pod:6768
9344 msgid "(Added in 1.0.55)"
9348 #: ../src/guestfs-actions.pod:1990
9349 msgid "guestfs_get_network"
9353 #: ../src/guestfs-actions.pod:1992
9357 " guestfs_get_network (guestfs_h *g);\n"
9362 #: ../src/guestfs-actions.pod:1995 ../fish/guestfish-actions.pod:1355
9363 msgid "This returns the enable network flag."
9367 #: ../src/guestfs-actions.pod:1999 ../src/guestfs-actions.pod:5939
9368 msgid "(Added in 1.5.4)"
9372 #: ../src/guestfs-actions.pod:2001
9373 msgid "guestfs_get_path"
9377 #: ../src/guestfs-actions.pod:2003
9381 " guestfs_get_path (guestfs_h *g);\n"
9386 #: ../src/guestfs-actions.pod:2006 ../fish/guestfish-actions.pod:1361
9387 msgid "Return the current search path."
9391 #: ../src/guestfs-actions.pod:2008 ../fish/guestfish-actions.pod:1363
9393 "This is always non-NULL. If it wasn't set already, then this will return "
9398 #: ../src/guestfs-actions.pod:2011 ../src/guestfs-actions.pod:2040
9400 "This function returns a string, or NULL on error. The string is owned by "
9401 "the guest handle and must I<not> be freed."
9405 #: ../src/guestfs-actions.pod:2016
9406 msgid "guestfs_get_pid"
9410 #: ../src/guestfs-actions.pod:2018
9414 " guestfs_get_pid (guestfs_h *g);\n"
9419 #: ../src/guestfs-actions.pod:2021 ../fish/guestfish-actions.pod:1372
9421 "Return the process ID of the qemu subprocess. If there is no qemu "
9422 "subprocess, then this will return an error."
9426 #: ../src/guestfs-actions.pod:2024 ../fish/guestfish-actions.pod:1375
9427 msgid "This is an internal call used for debugging and testing."
9431 #: ../src/guestfs-actions.pod:2028
9432 msgid "(Added in 1.0.56)"
9436 #: ../src/guestfs-actions.pod:2030
9437 msgid "guestfs_get_qemu"
9441 #: ../src/guestfs-actions.pod:2032
9445 " guestfs_get_qemu (guestfs_h *g);\n"
9450 #: ../src/guestfs-actions.pod:2035 ../fish/guestfish-actions.pod:1381
9451 msgid "Return the current qemu binary."
9455 #: ../src/guestfs-actions.pod:2037 ../fish/guestfish-actions.pod:1383
9457 "This is always non-NULL. If it wasn't set already, then this will return "
9458 "the default qemu binary name."
9462 #: ../src/guestfs-actions.pod:2043 ../src/guestfs-actions.pod:5984
9463 msgid "(Added in 1.0.6)"
9467 #: ../src/guestfs-actions.pod:2045
9468 msgid "guestfs_get_recovery_proc"
9472 #: ../src/guestfs-actions.pod:2047
9476 " guestfs_get_recovery_proc (guestfs_h *g);\n"
9481 #: ../src/guestfs-actions.pod:2050 ../fish/guestfish-actions.pod:1390
9482 msgid "Return the recovery process enabled flag."
9486 #: ../src/guestfs-actions.pod:2054 ../src/guestfs-actions.pod:3493
9487 #: ../src/guestfs-actions.pod:3790 ../src/guestfs-actions.pod:4190
9488 #: ../src/guestfs-actions.pod:4222 ../src/guestfs-actions.pod:5243
9489 #: ../src/guestfs-actions.pod:5586 ../src/guestfs-actions.pod:6008
9490 #: ../src/guestfs-actions.pod:6671 ../src/guestfs-actions.pod:6691
9491 #: ../src/guestfs-actions.pod:6883
9492 msgid "(Added in 1.0.77)"
9496 #: ../src/guestfs-actions.pod:2056
9497 msgid "guestfs_get_selinux"
9501 #: ../src/guestfs-actions.pod:2058
9505 " guestfs_get_selinux (guestfs_h *g);\n"
9510 #: ../src/guestfs-actions.pod:2061
9512 "This returns the current setting of the selinux flag which is passed to the "
9513 "appliance at boot time. See C<guestfs_set_selinux>."
9517 #: ../src/guestfs-actions.pod:2069 ../src/guestfs-actions.pod:2132
9518 #: ../src/guestfs-actions.pod:6027 ../src/guestfs-actions.pod:6085
9519 msgid "(Added in 1.0.67)"
9523 #: ../src/guestfs-actions.pod:2071
9524 msgid "guestfs_get_state"
9528 #: ../src/guestfs-actions.pod:2073
9532 " guestfs_get_state (guestfs_h *g);\n"
9537 #: ../src/guestfs-actions.pod:2076 ../fish/guestfish-actions.pod:1406
9539 "This returns the current state as an opaque integer. This is only useful "
9540 "for printing debug and internal error messages."
9544 #: ../src/guestfs-actions.pod:2079 ../src/guestfs-actions.pod:3291
9545 #: ../src/guestfs-actions.pod:3320 ../src/guestfs-actions.pod:3381
9546 #: ../src/guestfs-actions.pod:3408 ../fish/guestfish-actions.pod:1409
9547 #: ../fish/guestfish-actions.pod:2315 ../fish/guestfish-actions.pod:2333
9548 #: ../fish/guestfish-actions.pod:2371 ../fish/guestfish-actions.pod:2387
9549 msgid "For more information on states, see L<guestfs(3)>."
9553 #: ../src/guestfs-actions.pod:2085
9554 msgid "guestfs_get_trace"
9558 #: ../src/guestfs-actions.pod:2087
9562 " guestfs_get_trace (guestfs_h *g);\n"
9567 #: ../src/guestfs-actions.pod:2090 ../fish/guestfish-actions.pod:1415
9568 msgid "Return the command trace flag."
9572 #: ../src/guestfs-actions.pod:2096
9573 msgid "guestfs_get_umask"
9577 #: ../src/guestfs-actions.pod:2098
9581 " guestfs_get_umask (guestfs_h *g);\n"
9586 #: ../src/guestfs-actions.pod:2101
9588 "Return the current umask. By default the umask is C<022> unless it has been "
9589 "set by calling C<guestfs_umask>."
9593 #: ../src/guestfs-actions.pod:2108
9594 msgid "guestfs_get_verbose"
9598 #: ../src/guestfs-actions.pod:2110
9602 " guestfs_get_verbose (guestfs_h *g);\n"
9607 #: ../src/guestfs-actions.pod:2113 ../fish/guestfish-actions.pod:1428
9608 msgid "This returns the verbose messages flag."
9612 #: ../src/guestfs-actions.pod:2119
9613 msgid "guestfs_getcon"
9617 #: ../src/guestfs-actions.pod:2121
9621 " guestfs_getcon (guestfs_h *g);\n"
9626 #: ../src/guestfs-actions.pod:2124 ../fish/guestfish-actions.pod:1434
9627 msgid "This gets the SELinux security context of the daemon."
9631 #: ../src/guestfs-actions.pod:2126
9633 "See the documentation about SELINUX in L<guestfs(3)>, and C<guestfs_setcon>"
9637 #: ../src/guestfs-actions.pod:2134
9638 msgid "guestfs_getxattr"
9642 #: ../src/guestfs-actions.pod:2136
9646 " guestfs_getxattr (guestfs_h *g,\n"
9647 " const char *path,\n"
9648 " const char *name,\n"
9649 " size_t *size_r);\n"
9654 #: ../src/guestfs-actions.pod:2142
9656 "Get a single extended attribute from file C<path> named C<name>. This call "
9657 "follows symlinks. If you want to lookup an extended attribute for the "
9658 "symlink itself, use C<guestfs_lgetxattr>."
9662 #: ../src/guestfs-actions.pod:2146 ../src/guestfs-actions.pod:3507
9664 "Normally it is better to get all extended attributes from a file in one go "
9665 "by calling C<guestfs_getxattrs>. However some Linux filesystem "
9666 "implementations are buggy and do not provide a way to list out attributes. "
9667 "For these filesystems (notably ntfs-3g) you have to know the names of the "
9668 "extended attributes you want in advance and call this function."
9672 #: ../src/guestfs-actions.pod:2153 ../src/guestfs-actions.pod:3514
9673 #: ../fish/guestfish-actions.pod:1454 ../fish/guestfish-actions.pod:2452
9675 "Extended attribute values are blobs of binary data. If there is no extended "
9676 "attribute named C<name>, this returns an error."
9680 #: ../src/guestfs-actions.pod:2156
9681 msgid "See also: C<guestfs_getxattrs>, C<guestfs_lgetxattr>, L<attr(5)>."
9685 #: ../src/guestfs-actions.pod:2158 ../src/guestfs-actions.pod:2349
9686 #: ../src/guestfs-actions.pod:3519 ../src/guestfs-actions.pod:5236
9687 #: ../src/guestfs-actions.pod:5262 ../src/guestfs-actions.pod:5443
9689 "This function returns a buffer, or NULL on error. The size of the returned "
9690 "buffer is written to C<*size_r>. I<The caller must free the returned buffer "
9695 #: ../src/guestfs-actions.pod:2162 ../src/guestfs-actions.pod:3523
9696 msgid "(Added in 1.7.24)"
9700 #: ../src/guestfs-actions.pod:2164
9701 msgid "guestfs_getxattrs"
9705 #: ../src/guestfs-actions.pod:2166
9708 " struct guestfs_xattr_list *\n"
9709 " guestfs_getxattrs (guestfs_h *g,\n"
9710 " const char *path);\n"
9715 #: ../src/guestfs-actions.pod:2170 ../fish/guestfish-actions.pod:1463
9717 "This call lists the extended attributes of the file or directory C<path>."
9721 #: ../src/guestfs-actions.pod:2173 ../fish/guestfish-actions.pod:1466
9723 "At the system call level, this is a combination of the L<listxattr(2)> and "
9724 "L<getxattr(2)> calls."
9728 #: ../src/guestfs-actions.pod:2176
9729 msgid "See also: C<guestfs_lgetxattrs>, L<attr(5)>."
9733 #: ../src/guestfs-actions.pod:2178 ../src/guestfs-actions.pod:3535
9734 #: ../src/guestfs-actions.pod:4186
9736 "This function returns a C<struct guestfs_xattr_list *>, or NULL if there was "
9737 "an error. I<The caller must call C<guestfs_free_xattr_list> after use>."
9741 #: ../src/guestfs-actions.pod:2182 ../src/guestfs-actions.pod:3539
9742 #: ../src/guestfs-actions.pod:3704 ../src/guestfs-actions.pod:3740
9743 #: ../src/guestfs-actions.pod:5616 ../src/guestfs-actions.pod:6104
9744 #: ../src/guestfs-actions.pod:7439
9745 msgid "(Added in 1.0.59)"
9749 #: ../src/guestfs-actions.pod:2184
9750 msgid "guestfs_glob_expand"
9754 #: ../src/guestfs-actions.pod:2186
9758 " guestfs_glob_expand (guestfs_h *g,\n"
9759 " const char *pattern);\n"
9764 #: ../src/guestfs-actions.pod:2190 ../fish/guestfish-actions.pod:1475
9766 "This command searches for all the pathnames matching C<pattern> according to "
9767 "the wildcard expansion rules used by the shell."
9771 #: ../src/guestfs-actions.pod:2194 ../fish/guestfish-actions.pod:1479
9773 "If no paths match, then this returns an empty list (note: not an error)."
9777 #: ../src/guestfs-actions.pod:2197 ../fish/guestfish-actions.pod:1482
9779 "It is just a wrapper around the C L<glob(3)> function with flags C<GLOB_MARK|"
9780 "GLOB_BRACE>. See that manual page for more details."
9784 #: ../src/guestfs-actions.pod:2205 ../src/guestfs-actions.pod:6269
9785 #: ../src/guestfs-actions.pod:6286
9786 msgid "(Added in 1.0.50)"
9790 #: ../src/guestfs-actions.pod:2207
9791 msgid "guestfs_grep"
9795 #: ../src/guestfs-actions.pod:2209
9799 " guestfs_grep (guestfs_h *g,\n"
9800 " const char *regex,\n"
9801 " const char *path);\n"
9806 #: ../src/guestfs-actions.pod:2214 ../fish/guestfish-actions.pod:1490
9807 msgid "This calls the external C<grep> program and returns the matching lines."
9811 #: ../src/guestfs-actions.pod:2226
9812 msgid "guestfs_grepi"
9816 #: ../src/guestfs-actions.pod:2228
9820 " guestfs_grepi (guestfs_h *g,\n"
9821 " const char *regex,\n"
9822 " const char *path);\n"
9827 #: ../src/guestfs-actions.pod:2233 ../fish/guestfish-actions.pod:1500
9829 "This calls the external C<grep -i> program and returns the matching lines."
9833 #: ../src/guestfs-actions.pod:2245
9834 msgid "guestfs_grub_install"
9838 #: ../src/guestfs-actions.pod:2247
9842 " guestfs_grub_install (guestfs_h *g,\n"
9843 " const char *root,\n"
9844 " const char *device);\n"
9849 #: ../src/guestfs-actions.pod:2252 ../fish/guestfish-actions.pod:1510
9851 "This command installs GRUB (the Grand Unified Bootloader) on C<device>, with "
9852 "the root directory being C<root>."
9856 #: ../src/guestfs-actions.pod:2255 ../fish/guestfish-actions.pod:1513
9858 "Note: If grub-install reports the error \"No suitable drive was found in the "
9859 "generated device map.\" it may be that you need to create a C</boot/grub/"
9860 "device.map> file first that contains the mapping between grub device names "
9861 "and Linux device names. It is usually sufficient to create a file "
9866 #: ../src/guestfs-actions.pod:2262 ../fish/guestfish-actions.pod:1520
9874 #: ../src/guestfs-actions.pod:2264 ../fish/guestfish-actions.pod:1522
9875 msgid "replacing C</dev/vda> with the name of the installation device."
9879 #: ../src/guestfs-actions.pod:2268
9880 msgid "(Added in 1.0.17)"
9884 #: ../src/guestfs-actions.pod:2270
9885 msgid "guestfs_head"
9889 #: ../src/guestfs-actions.pod:2272
9893 " guestfs_head (guestfs_h *g,\n"
9894 " const char *path);\n"
9899 #: ../src/guestfs-actions.pod:2276 ../fish/guestfish-actions.pod:1528
9901 "This command returns up to the first 10 lines of a file as a list of strings."
9905 #: ../src/guestfs-actions.pod:2288
9906 msgid "guestfs_head_n"
9910 #: ../src/guestfs-actions.pod:2290
9914 " guestfs_head_n (guestfs_h *g,\n"
9916 " const char *path);\n"
9921 #: ../src/guestfs-actions.pod:2295 ../fish/guestfish-actions.pod:1538
9923 "If the parameter C<nrlines> is a positive number, this returns the first "
9924 "C<nrlines> lines of the file C<path>."
9928 #: ../src/guestfs-actions.pod:2298 ../fish/guestfish-actions.pod:1541
9930 "If the parameter C<nrlines> is a negative number, this returns lines from "
9931 "the file C<path>, excluding the last C<nrlines> lines."
9935 #: ../src/guestfs-actions.pod:2301 ../src/guestfs-actions.pod:6566
9936 #: ../fish/guestfish-actions.pod:1544 ../fish/guestfish-actions.pod:4422
9937 msgid "If the parameter C<nrlines> is zero, this returns an empty list."
9941 #: ../src/guestfs-actions.pod:2312
9942 msgid "guestfs_hexdump"
9946 #: ../src/guestfs-actions.pod:2314
9950 " guestfs_hexdump (guestfs_h *g,\n"
9951 " const char *path);\n"
9956 #: ../src/guestfs-actions.pod:2318 ../fish/guestfish-actions.pod:1553
9958 "This runs C<hexdump -C> on the given C<path>. The result is the human-"
9959 "readable, canonical hex dump of the file."
9963 #: ../src/guestfs-actions.pod:2327 ../src/guestfs-actions.pod:6350
9964 #: ../src/guestfs-actions.pod:6405
9965 msgid "(Added in 1.0.22)"
9969 #: ../src/guestfs-actions.pod:2329
9970 msgid "guestfs_initrd_cat"
9974 #: ../src/guestfs-actions.pod:2331
9978 " guestfs_initrd_cat (guestfs_h *g,\n"
9979 " const char *initrdpath,\n"
9980 " const char *filename,\n"
9981 " size_t *size_r);\n"
9986 #: ../src/guestfs-actions.pod:2337 ../fish/guestfish-actions.pod:1563
9988 "This command unpacks the file C<filename> from the initrd file called "
9989 "C<initrdpath>. The filename must be given I<without> the initial C</> "
9994 #: ../src/guestfs-actions.pod:2341 ../fish/guestfish-actions.pod:1567
9996 "For example, in guestfish you could use the following command to examine the "
9997 "boot script (usually called C</init>) contained in a Linux initrd or "
10002 #: ../src/guestfs-actions.pod:2345 ../fish/guestfish-actions.pod:1571
10005 " initrd-cat /boot/initrd-<version>.img init\n"
10010 #: ../src/guestfs-actions.pod:2347
10011 msgid "See also C<guestfs_initrd_list>."
10015 #: ../src/guestfs-actions.pod:2358
10016 msgid "guestfs_initrd_list"
10020 #: ../src/guestfs-actions.pod:2360
10024 " guestfs_initrd_list (guestfs_h *g,\n"
10025 " const char *path);\n"
10030 #: ../src/guestfs-actions.pod:2364 ../fish/guestfish-actions.pod:1582
10031 msgid "This command lists out files contained in an initrd."
10035 #: ../src/guestfs-actions.pod:2366 ../fish/guestfish-actions.pod:1584
10037 "The files are listed without any initial C</> character. The files are "
10038 "listed in the order they appear (not necessarily alphabetical). Directory "
10039 "names are listed as separate items."
10043 #: ../src/guestfs-actions.pod:2370 ../fish/guestfish-actions.pod:1588
10045 "Old Linux kernels (2.4 and earlier) used a compressed ext2 filesystem as "
10046 "initrd. We I<only> support the newer initramfs format (compressed cpio "
10051 #: ../src/guestfs-actions.pod:2380
10052 msgid "guestfs_inotify_add_watch"
10056 #: ../src/guestfs-actions.pod:2382
10060 " guestfs_inotify_add_watch (guestfs_h *g,\n"
10061 " const char *path,\n"
10067 #: ../src/guestfs-actions.pod:2387 ../fish/guestfish-actions.pod:1596
10068 msgid "Watch C<path> for the events listed in C<mask>."
10072 #: ../src/guestfs-actions.pod:2389 ../fish/guestfish-actions.pod:1598
10074 "Note that if C<path> is a directory then events within that directory are "
10075 "watched, but this does I<not> happen recursively (in subdirectories)."
10079 #: ../src/guestfs-actions.pod:2393 ../fish/guestfish-actions.pod:1602
10081 "Note for non-C or non-Linux callers: the inotify events are defined by the "
10082 "Linux kernel ABI and are listed in C</usr/include/sys/inotify.h>."
10086 #: ../src/guestfs-actions.pod:2401
10087 msgid "guestfs_inotify_close"
10091 #: ../src/guestfs-actions.pod:2403
10095 " guestfs_inotify_close (guestfs_h *g);\n"
10100 #: ../src/guestfs-actions.pod:2406 ../fish/guestfish-actions.pod:1610
10102 "This closes the inotify handle which was previously opened by inotify_init. "
10103 "It removes all watches, throws away any pending events, and deallocates all "
10108 #: ../src/guestfs-actions.pod:2414
10109 msgid "guestfs_inotify_files"
10113 #: ../src/guestfs-actions.pod:2416
10117 " guestfs_inotify_files (guestfs_h *g);\n"
10122 #: ../src/guestfs-actions.pod:2419
10124 "This function is a helpful wrapper around C<guestfs_inotify_read> which just "
10125 "returns a list of pathnames of objects that were touched. The returned "
10126 "pathnames are sorted and deduplicated."
10130 #: ../src/guestfs-actions.pod:2429
10131 msgid "guestfs_inotify_init"
10135 #: ../src/guestfs-actions.pod:2431
10139 " guestfs_inotify_init (guestfs_h *g,\n"
10140 " int maxevents);\n"
10145 #: ../src/guestfs-actions.pod:2435 ../fish/guestfish-actions.pod:1626
10147 "This command creates a new inotify handle. The inotify subsystem can be "
10148 "used to notify events which happen to objects in the guest filesystem."
10152 #: ../src/guestfs-actions.pod:2439
10154 "C<maxevents> is the maximum number of events which will be queued up between "
10155 "calls to C<guestfs_inotify_read> or C<guestfs_inotify_files>. If this is "
10156 "passed as C<0>, then the kernel (or previously set) default is used. For "
10157 "Linux 2.6.29 the default was 16384 events. Beyond this limit, the kernel "
10158 "throws away events, but records the fact that it threw them away by setting "
10159 "a flag C<IN_Q_OVERFLOW> in the returned structure list (see "
10160 "C<guestfs_inotify_read>)."
10164 #: ../src/guestfs-actions.pod:2449
10166 "Before any events are generated, you have to add some watches to the "
10167 "internal watch list. See: C<guestfs_inotify_add_watch>, "
10168 "C<guestfs_inotify_rm_watch> and C<guestfs_inotify_watch_all>."
10172 #: ../src/guestfs-actions.pod:2455
10174 "Queued up events should be read periodically by calling "
10175 "C<guestfs_inotify_read> (or C<guestfs_inotify_files> which is just a helpful "
10176 "wrapper around C<guestfs_inotify_read>). If you don't read the events out "
10177 "often enough then you risk the internal queue overflowing."
10181 #: ../src/guestfs-actions.pod:2462
10183 "The handle should be closed after use by calling C<guestfs_inotify_close>. "
10184 "This also removes any watches automatically."
10188 #: ../src/guestfs-actions.pod:2466 ../fish/guestfish-actions.pod:1657
10190 "See also L<inotify(7)> for an overview of the inotify interface as exposed "
10191 "by the Linux kernel, which is roughly what we expose via libguestfs. Note "
10192 "that there is one global inotify handle per libguestfs instance."
10196 #: ../src/guestfs-actions.pod:2475
10197 msgid "guestfs_inotify_read"
10201 #: ../src/guestfs-actions.pod:2477
10204 " struct guestfs_inotify_event_list *\n"
10205 " guestfs_inotify_read (guestfs_h *g);\n"
10210 #: ../src/guestfs-actions.pod:2480 ../fish/guestfish-actions.pod:1666
10212 "Return the complete queue of events that have happened since the previous "
10217 #: ../src/guestfs-actions.pod:2483 ../fish/guestfish-actions.pod:1669
10218 msgid "If no events have happened, this returns an empty list."
10222 #: ../src/guestfs-actions.pod:2485 ../fish/guestfish-actions.pod:1671
10224 "I<Note>: In order to make sure that all events have been read, you must call "
10225 "this function repeatedly until it returns an empty list. The reason is that "
10226 "the call will read events up to the maximum appliance-to-host message size "
10227 "and leave remaining events in the queue."
10231 #: ../src/guestfs-actions.pod:2491
10233 "This function returns a C<struct guestfs_inotify_event_list *>, or NULL if "
10234 "there was an error. I<The caller must call "
10235 "C<guestfs_free_inotify_event_list> after use>."
10239 #: ../src/guestfs-actions.pod:2497
10240 msgid "guestfs_inotify_rm_watch"
10244 #: ../src/guestfs-actions.pod:2499
10248 " guestfs_inotify_rm_watch (guestfs_h *g,\n"
10254 #: ../src/guestfs-actions.pod:2503
10256 "Remove a previously defined inotify watch. See C<guestfs_inotify_add_watch>."
10260 #: ../src/guestfs-actions.pod:2510
10261 msgid "guestfs_inspect_get_arch"
10265 #: ../src/guestfs-actions.pod:2512
10269 " guestfs_inspect_get_arch (guestfs_h *g,\n"
10270 " const char *root);\n"
10275 #: ../src/guestfs-actions.pod:2516 ../src/guestfs-actions.pod:2539
10276 #: ../src/guestfs-actions.pod:2624 ../src/guestfs-actions.pod:2668
10277 #: ../src/guestfs-actions.pod:2694 ../src/guestfs-actions.pod:2733
10278 #: ../src/guestfs-actions.pod:2755 ../src/guestfs-actions.pod:2782
10279 #: ../src/guestfs-actions.pod:2803 ../src/guestfs-actions.pod:2846
10280 #: ../src/guestfs-actions.pod:2875 ../src/guestfs-actions.pod:2906
10281 #: ../src/guestfs-actions.pod:2930 ../src/guestfs-actions.pod:2985
10282 #: ../src/guestfs-actions.pod:3027 ../src/guestfs-actions.pod:3048
10283 #: ../src/guestfs-actions.pod:3071 ../src/guestfs-actions.pod:3088
10284 #: ../src/guestfs-actions.pod:3105 ../src/guestfs-actions.pod:3124
10286 "This function should only be called with a root device string as returned by "
10287 "C<guestfs_inspect_os>."
10291 #: ../src/guestfs-actions.pod:2519
10293 "This returns the architecture of the inspected operating system. The "
10294 "possible return values are listed under C<guestfs_file_architecture>."
10298 #: ../src/guestfs-actions.pod:2523 ../fish/guestfish-actions.pod:1695
10300 "If the architecture could not be determined, then the string C<unknown> is "
10305 #: ../src/guestfs-actions.pod:2526 ../src/guestfs-actions.pod:2611
10306 #: ../src/guestfs-actions.pod:2722 ../src/guestfs-actions.pod:2742
10307 #: ../src/guestfs-actions.pod:2770 ../src/guestfs-actions.pod:2862
10308 #: ../src/guestfs-actions.pod:2893 ../src/guestfs-actions.pod:2917
10309 #: ../src/guestfs-actions.pod:2971 ../src/guestfs-actions.pod:3014
10310 #: ../src/guestfs-actions.pod:3037 ../src/guestfs-actions.pod:3058
10311 #: ../src/guestfs-actions.pod:3078 ../src/guestfs-actions.pod:3095
10312 #: ../src/guestfs-actions.pod:3114 ../src/guestfs-actions.pod:3217
10313 #: ../src/guestfs-actions.pod:3258 ../fish/guestfish-actions.pod:1698
10314 #: ../fish/guestfish-actions.pod:1776 ../fish/guestfish-actions.pod:1864
10315 #: ../fish/guestfish-actions.pod:1879 ../fish/guestfish-actions.pod:1900
10316 #: ../fish/guestfish-actions.pod:1970 ../fish/guestfish-actions.pod:1994
10317 #: ../fish/guestfish-actions.pod:2011 ../fish/guestfish-actions.pod:2054
10318 #: ../fish/guestfish-actions.pod:2089 ../fish/guestfish-actions.pod:2105
10319 #: ../fish/guestfish-actions.pod:2121 ../fish/guestfish-actions.pod:2134
10320 #: ../fish/guestfish-actions.pod:2147 ../fish/guestfish-actions.pod:2162
10321 #: ../fish/guestfish-actions.pod:2261 ../fish/guestfish-actions.pod:2295
10322 msgid "Please read L<guestfs(3)/INSPECTION> for more details."
10326 #: ../src/guestfs-actions.pod:2533
10327 msgid "guestfs_inspect_get_distro"
10331 #: ../src/guestfs-actions.pod:2535
10335 " guestfs_inspect_get_distro (guestfs_h *g,\n"
10336 " const char *root);\n"
10341 #: ../src/guestfs-actions.pod:2542 ../fish/guestfish-actions.pod:1707
10343 "This returns the distro (distribution) of the inspected operating system."
10347 #: ../src/guestfs-actions.pod:2545 ../fish/guestfish-actions.pod:1710
10348 msgid "Currently defined distros are:"
10352 #: ../src/guestfs-actions.pod:2549 ../fish/guestfish-actions.pod:1714
10353 msgid "\"archlinux\""
10354 msgstr "\"archlinux\""
10357 #: ../src/guestfs-actions.pod:2551 ../fish/guestfish-actions.pod:1716
10358 msgid "Arch Linux."
10359 msgstr "Arch Linux."
10362 #: ../src/guestfs-actions.pod:2553 ../fish/guestfish-actions.pod:1718
10364 msgstr "\"debian\""
10367 #: ../src/guestfs-actions.pod:2555 ../fish/guestfish-actions.pod:1720
10372 #: ../src/guestfs-actions.pod:2557 ../fish/guestfish-actions.pod:1722
10374 msgstr "\"fedora\""
10377 #: ../src/guestfs-actions.pod:2559 ../fish/guestfish-actions.pod:1724
10382 #: ../src/guestfs-actions.pod:2561 ../fish/guestfish-actions.pod:1726
10384 msgstr "\"gentoo\""
10387 #: ../src/guestfs-actions.pod:2563 ../fish/guestfish-actions.pod:1728
10392 #: ../src/guestfs-actions.pod:2565 ../fish/guestfish-actions.pod:1730
10393 msgid "\"linuxmint\""
10394 msgstr "\"linuxmint\""
10397 #: ../src/guestfs-actions.pod:2567 ../fish/guestfish-actions.pod:1732
10398 msgid "Linux Mint."
10399 msgstr "Linux Mint."
10402 #: ../src/guestfs-actions.pod:2569 ../fish/guestfish-actions.pod:1734
10403 msgid "\"mandriva\""
10404 msgstr "\"mandriva\""
10407 #: ../src/guestfs-actions.pod:2571 ../fish/guestfish-actions.pod:1736
10412 #: ../src/guestfs-actions.pod:2573 ../fish/guestfish-actions.pod:1738
10417 #: ../src/guestfs-actions.pod:2575 ../fish/guestfish-actions.pod:1740
10422 #: ../src/guestfs-actions.pod:2577 ../fish/guestfish-actions.pod:1742
10424 msgstr "\"pardus\""
10427 #: ../src/guestfs-actions.pod:2579 ../fish/guestfish-actions.pod:1744
10432 #: ../src/guestfs-actions.pod:2581 ../fish/guestfish-actions.pod:1746
10433 msgid "\"redhat-based\""
10434 msgstr "\"redhat-based\""
10437 #: ../src/guestfs-actions.pod:2583 ../fish/guestfish-actions.pod:1748
10438 msgid "Some Red Hat-derived distro."
10439 msgstr "Дистрибутив, що походить від Red Hat."
10442 #: ../src/guestfs-actions.pod:2585 ../fish/guestfish-actions.pod:1750
10447 #: ../src/guestfs-actions.pod:2587 ../fish/guestfish-actions.pod:1752
10448 msgid "Red Hat Enterprise Linux and some derivatives."
10449 msgstr "Red Hat Enterprise Linux та деякі з похідних дистрибутивів."
10452 #: ../src/guestfs-actions.pod:2589 ../fish/guestfish-actions.pod:1754
10453 msgid "\"slackware\""
10457 #: ../src/guestfs-actions.pod:2591 ../fish/guestfish-actions.pod:1756
10462 #: ../src/guestfs-actions.pod:2593 ../fish/guestfish-actions.pod:1758
10464 msgstr "\"ubuntu\""
10467 #: ../src/guestfs-actions.pod:2595 ../fish/guestfish-actions.pod:1760
10472 #: ../src/guestfs-actions.pod:2597 ../src/guestfs-actions.pod:2713
10473 #: ../src/guestfs-actions.pod:3005 ../fish/guestfish-actions.pod:1762
10474 #: ../fish/guestfish-actions.pod:1855 ../fish/guestfish-actions.pod:2080
10475 msgid "\"unknown\""
10476 msgstr "\"unknown\""
10479 #: ../src/guestfs-actions.pod:2599 ../fish/guestfish-actions.pod:1764
10480 msgid "The distro could not be determined."
10481 msgstr "Дистрибутив, тип якого не вдалося визначити."
10484 #: ../src/guestfs-actions.pod:2601 ../src/guestfs-actions.pod:2997
10485 #: ../fish/guestfish-actions.pod:1766 ../fish/guestfish-actions.pod:2072
10486 msgid "\"windows\""
10487 msgstr "\"windows\""
10490 #: ../src/guestfs-actions.pod:2603 ../fish/guestfish-actions.pod:1768
10492 "Windows does not have distributions. This string is returned if the OS type "
10497 #: ../src/guestfs-actions.pod:2608 ../src/guestfs-actions.pod:2719
10498 #: ../src/guestfs-actions.pod:3011 ../fish/guestfish-actions.pod:1773
10499 #: ../fish/guestfish-actions.pod:1861 ../fish/guestfish-actions.pod:2086
10501 "Future versions of libguestfs may return other strings here. The caller "
10502 "should be prepared to handle any string."
10506 #: ../src/guestfs-actions.pod:2618
10507 msgid "guestfs_inspect_get_drive_mappings"
10511 #: ../src/guestfs-actions.pod:2620
10515 " guestfs_inspect_get_drive_mappings (guestfs_h *g,\n"
10516 " const char *root);\n"
10521 #: ../src/guestfs-actions.pod:2627 ../fish/guestfish-actions.pod:1785
10523 "This call is useful for Windows which uses a primitive system of assigning "
10524 "drive letters (like \"C:\") to partitions. This inspection API examines the "
10525 "Windows Registry to find out how disks/partitions are mapped to drive "
10526 "letters, and returns a hash table as in the example below:"
10530 #: ../src/guestfs-actions.pod:2633 ../fish/guestfish-actions.pod:1791
10533 " C => /dev/vda2\n"
10534 " E => /dev/vdb1\n"
10535 " F => /dev/vdc1\n"
10540 #: ../src/guestfs-actions.pod:2637 ../fish/guestfish-actions.pod:1795
10542 "Note that keys are drive letters. For Windows, the key is case insensitive "
10543 "and just contains the drive letter, without the customary colon separator "
10548 #: ../src/guestfs-actions.pod:2641 ../fish/guestfish-actions.pod:1799
10550 "In future we may support other operating systems that also used drive "
10551 "letters, but the keys for those might not be case insensitive and might be "
10552 "longer than 1 character. For example in OS-9, hard drives were named C<h0>, "
10557 #: ../src/guestfs-actions.pod:2646 ../fish/guestfish-actions.pod:1804
10559 "For Windows guests, currently only hard drive mappings are returned. "
10560 "Removable disks (eg. DVD-ROMs) are ignored."
10564 #: ../src/guestfs-actions.pod:2649 ../fish/guestfish-actions.pod:1807
10566 "For guests that do not use drive mappings, or if the drive mappings could "
10567 "not be determined, this returns an empty hash table."
10571 #: ../src/guestfs-actions.pod:2652
10573 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
10574 "C<guestfs_inspect_get_mountpoints>, C<guestfs_inspect_get_filesystems>."
10578 #: ../src/guestfs-actions.pod:2656 ../src/guestfs-actions.pod:2832
10579 #: ../src/guestfs-actions.pod:3592 ../src/guestfs-actions.pod:4802
10580 #: ../src/guestfs-actions.pod:6707
10582 "This function returns a NULL-terminated array of strings, or NULL if there "
10583 "was an error. The array of strings will always have length C<2n+1>, where "
10584 "C<n> keys and values alternate, followed by the trailing NULL entry. I<The "
10585 "caller must free the strings and the array after use>."
10589 #: ../src/guestfs-actions.pod:2662
10590 msgid "guestfs_inspect_get_filesystems"
10594 #: ../src/guestfs-actions.pod:2664
10598 " guestfs_inspect_get_filesystems (guestfs_h *g,\n"
10599 " const char *root);\n"
10604 #: ../src/guestfs-actions.pod:2671 ../fish/guestfish-actions.pod:1821
10606 "This returns a list of all the filesystems that we think are associated with "
10607 "this operating system. This includes the root filesystem, other ordinary "
10608 "filesystems, and non-mounted devices like swap partitions."
10612 #: ../src/guestfs-actions.pod:2676 ../fish/guestfish-actions.pod:1826
10614 "In the case of a multi-boot virtual machine, it is possible for a filesystem "
10615 "to be shared between operating systems."
10619 #: ../src/guestfs-actions.pod:2679
10621 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
10622 "C<guestfs_inspect_get_mountpoints>."
10626 #: ../src/guestfs-actions.pod:2688
10627 msgid "guestfs_inspect_get_format"
10631 #: ../src/guestfs-actions.pod:2690
10635 " guestfs_inspect_get_format (guestfs_h *g,\n"
10636 " const char *root);\n"
10641 #: ../src/guestfs-actions.pod:2697 ../fish/guestfish-actions.pod:1839
10643 "This returns the format of the inspected operating system. You can use it "
10644 "to detect install images, live CDs and similar."
10648 #: ../src/guestfs-actions.pod:2700 ../fish/guestfish-actions.pod:1842
10649 msgid "Currently defined formats are:"
10653 #: ../src/guestfs-actions.pod:2704 ../fish/guestfish-actions.pod:1846
10654 msgid "\"installed\""
10655 msgstr "\"installed\""
10658 #: ../src/guestfs-actions.pod:2706 ../fish/guestfish-actions.pod:1848
10659 msgid "This is an installed operating system."
10660 msgstr "Це встановлена операційна система."
10663 #: ../src/guestfs-actions.pod:2708 ../fish/guestfish-actions.pod:1850
10664 msgid "\"installer\""
10668 #: ../src/guestfs-actions.pod:2710 ../fish/guestfish-actions.pod:1852
10670 "The disk image being inspected is not an installed operating system, but a "
10671 "I<bootable> install disk, live CD, or similar."
10675 #: ../src/guestfs-actions.pod:2715 ../fish/guestfish-actions.pod:1857
10676 msgid "The format of this disk image is not known."
10680 #: ../src/guestfs-actions.pod:2727
10681 msgid "guestfs_inspect_get_hostname"
10685 #: ../src/guestfs-actions.pod:2729
10689 " guestfs_inspect_get_hostname (guestfs_h *g,\n"
10690 " const char *root);\n"
10695 #: ../src/guestfs-actions.pod:2736 ../fish/guestfish-actions.pod:1873
10697 "This function returns the hostname of the operating system as found by "
10698 "inspection of the guest's configuration files."
10702 #: ../src/guestfs-actions.pod:2739 ../fish/guestfish-actions.pod:1876
10704 "If the hostname could not be determined, then the string C<unknown> is "
10709 #: ../src/guestfs-actions.pod:2747
10710 msgid "(Added in 1.7.9)"
10714 #: ../src/guestfs-actions.pod:2749
10715 msgid "guestfs_inspect_get_major_version"
10719 #: ../src/guestfs-actions.pod:2751
10723 " guestfs_inspect_get_major_version (guestfs_h *g,\n"
10724 " const char *root);\n"
10729 #: ../src/guestfs-actions.pod:2758 ../fish/guestfish-actions.pod:1888
10731 "This returns the major version number of the inspected operating system."
10735 #: ../src/guestfs-actions.pod:2761 ../fish/guestfish-actions.pod:1891
10737 "Windows uses a consistent versioning scheme which is I<not> reflected in the "
10738 "popular public names used by the operating system. Notably the operating "
10739 "system known as \"Windows 7\" is really version 6.1 (ie. major = 6, minor = "
10740 "1). You can find out the real versions corresponding to releases of Windows "
10741 "by consulting Wikipedia or MSDN."
10745 #: ../src/guestfs-actions.pod:2768 ../src/guestfs-actions.pod:2788
10746 #: ../fish/guestfish-actions.pod:1898 ../fish/guestfish-actions.pod:1912
10747 msgid "If the version could not be determined, then C<0> is returned."
10751 #: ../src/guestfs-actions.pod:2776
10752 msgid "guestfs_inspect_get_minor_version"
10756 #: ../src/guestfs-actions.pod:2778
10760 " guestfs_inspect_get_minor_version (guestfs_h *g,\n"
10761 " const char *root);\n"
10766 #: ../src/guestfs-actions.pod:2785 ../fish/guestfish-actions.pod:1909
10768 "This returns the minor version number of the inspected operating system."
10772 #: ../src/guestfs-actions.pod:2790
10774 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
10775 "C<guestfs_inspect_get_major_version>."
10779 #: ../src/guestfs-actions.pod:2797
10780 msgid "guestfs_inspect_get_mountpoints"
10784 #: ../src/guestfs-actions.pod:2799
10788 " guestfs_inspect_get_mountpoints (guestfs_h *g,\n"
10789 " const char *root);\n"
10794 #: ../src/guestfs-actions.pod:2806 ../fish/guestfish-actions.pod:1924
10796 "This returns a hash of where we think the filesystems associated with this "
10797 "operating system should be mounted. Callers should note that this is at "
10798 "best an educated guess made by reading configuration files such as C</etc/"
10799 "fstab>. I<In particular note> that this may return filesystems which are "
10800 "non-existent or not mountable and callers should be prepared to handle or "
10801 "ignore failures if they try to mount them."
10805 #: ../src/guestfs-actions.pod:2815 ../fish/guestfish-actions.pod:1933
10807 "Each element in the returned hashtable has a key which is the path of the "
10808 "mountpoint (eg. C</boot>) and a value which is the filesystem that would be "
10809 "mounted there (eg. C</dev/sda1>)."
10813 #: ../src/guestfs-actions.pod:2820 ../fish/guestfish-actions.pod:1938
10815 "Non-mounted devices such as swap devices are I<not> returned in this list."
10819 #: ../src/guestfs-actions.pod:2823
10821 "For operating systems like Windows which still use drive letters, this call "
10822 "will only return an entry for the first drive \"mounted on\" C</>. For "
10823 "information about the mapping of drive letters to partitions, see "
10824 "C<guestfs_inspect_get_drive_mappings>."
10828 #: ../src/guestfs-actions.pod:2829
10830 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
10831 "C<guestfs_inspect_get_filesystems>."
10835 #: ../src/guestfs-actions.pod:2840
10836 msgid "guestfs_inspect_get_package_format"
10840 #: ../src/guestfs-actions.pod:2842
10844 " guestfs_inspect_get_package_format (guestfs_h *g,\n"
10845 " const char *root);\n"
10850 #: ../src/guestfs-actions.pod:2849
10852 "This function and C<guestfs_inspect_get_package_management> return the "
10853 "package format and package management tool used by the inspected operating "
10854 "system. For example for Fedora these functions would return C<rpm> (package "
10855 "format) and C<yum> (package management)."
10859 #: ../src/guestfs-actions.pod:2855 ../fish/guestfish-actions.pod:1963
10861 "This returns the string C<unknown> if we could not determine the package "
10862 "format I<or> if the operating system does not have a real packaging system "
10867 #: ../src/guestfs-actions.pod:2859 ../fish/guestfish-actions.pod:1967
10869 "Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>. "
10870 "Future versions of libguestfs may return other strings."
10874 #: ../src/guestfs-actions.pod:2867 ../src/guestfs-actions.pod:2898
10875 msgid "(Added in 1.7.5)"
10879 #: ../src/guestfs-actions.pod:2869
10880 msgid "guestfs_inspect_get_package_management"
10884 #: ../src/guestfs-actions.pod:2871
10888 " guestfs_inspect_get_package_management (guestfs_h *g,\n"
10889 " const char *root);\n"
10894 #: ../src/guestfs-actions.pod:2878
10896 "C<guestfs_inspect_get_package_format> and this function return the package "
10897 "format and package management tool used by the inspected operating system. "
10898 "For example for Fedora these functions would return C<rpm> (package format) "
10899 "and C<yum> (package management)."
10903 #: ../src/guestfs-actions.pod:2884 ../fish/guestfish-actions.pod:1985
10905 "This returns the string C<unknown> if we could not determine the package "
10906 "management tool I<or> if the operating system does not have a real packaging "
10907 "system (eg. Windows)."
10911 #: ../src/guestfs-actions.pod:2888 ../fish/guestfish-actions.pod:1989
10913 "Possible strings include: C<yum>, C<up2date>, C<apt> (for all Debian "
10914 "derivatives), C<portage>, C<pisi>, C<pacman>, C<urpmi>. Future versions of "
10915 "libguestfs may return other strings."
10919 #: ../src/guestfs-actions.pod:2900
10920 msgid "guestfs_inspect_get_product_name"
10924 #: ../src/guestfs-actions.pod:2902
10928 " guestfs_inspect_get_product_name (guestfs_h *g,\n"
10929 " const char *root);\n"
10934 #: ../src/guestfs-actions.pod:2909 ../fish/guestfish-actions.pod:2003
10936 "This returns the product name of the inspected operating system. The "
10937 "product name is generally some freeform string which can be displayed to the "
10938 "user, but should not be parsed by programs."
10942 #: ../src/guestfs-actions.pod:2914 ../fish/guestfish-actions.pod:2008
10944 "If the product name could not be determined, then the string C<unknown> is "
10949 #: ../src/guestfs-actions.pod:2924
10950 msgid "guestfs_inspect_get_product_variant"
10954 #: ../src/guestfs-actions.pod:2926
10958 " guestfs_inspect_get_product_variant (guestfs_h *g,\n"
10959 " const char *root);\n"
10964 #: ../src/guestfs-actions.pod:2933 ../fish/guestfish-actions.pod:2020
10966 #| msgid "This is an installed operating system."
10967 msgid "This returns the product variant of the inspected operating system."
10968 msgstr "Це встановлена операційна система."
10971 #: ../src/guestfs-actions.pod:2936 ../fish/guestfish-actions.pod:2023
10973 "For Windows guests, this returns the contents of the Registry key C<HKLM"
10974 "\\Software\\Microsoft\\Windows NT\\CurrentVersion> C<InstallationType> which "
10975 "is usually a string such as C<Client> or C<Server> (other values are "
10976 "possible). This can be used to distinguish consumer and enterprise versions "
10977 "of Windows that have the same version number (for example, Windows 7 and "
10978 "Windows 2008 Server are both version 6.1, but the former is C<Client> and "
10979 "the latter is C<Server>)."
10983 #: ../src/guestfs-actions.pod:2945 ../fish/guestfish-actions.pod:2032
10985 "For enterprise Linux guests, in future we intend this to return the product "
10986 "variant such as C<Desktop>, C<Server> and so on. But this is not "
10987 "implemented at present."
10991 #: ../src/guestfs-actions.pod:2949 ../fish/guestfish-actions.pod:2036
10993 "If the product variant could not be determined, then the string C<unknown> "
10998 #: ../src/guestfs-actions.pod:2952
11000 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
11001 "C<guestfs_inspect_get_product_name>, C<guestfs_inspect_get_major_version>."
11005 #: ../src/guestfs-actions.pod:2959
11006 msgid "guestfs_inspect_get_roots"
11010 #: ../src/guestfs-actions.pod:2961
11014 " guestfs_inspect_get_roots (guestfs_h *g);\n"
11019 #: ../src/guestfs-actions.pod:2964
11021 "This function is a convenient way to get the list of root devices, as "
11022 "returned from a previous call to C<guestfs_inspect_os>, but without redoing "
11023 "the whole inspection process."
11027 #: ../src/guestfs-actions.pod:2968
11029 "This returns an empty list if either no root devices were found or the "
11030 "caller has not called C<guestfs_inspect_os>."
11034 #: ../src/guestfs-actions.pod:2977
11035 msgid "(Added in 1.7.3)"
11039 #: ../src/guestfs-actions.pod:2979
11040 msgid "guestfs_inspect_get_type"
11044 #: ../src/guestfs-actions.pod:2981
11048 " guestfs_inspect_get_type (guestfs_h *g,\n"
11049 " const char *root);\n"
11054 #: ../src/guestfs-actions.pod:2988 ../fish/guestfish-actions.pod:2063
11056 "This returns the type of the inspected operating system. Currently defined "
11061 #: ../src/guestfs-actions.pod:2993 ../fish/guestfish-actions.pod:2068
11066 #: ../src/guestfs-actions.pod:2995 ../fish/guestfish-actions.pod:2070
11067 msgid "Any Linux-based operating system."
11071 #: ../src/guestfs-actions.pod:2999 ../fish/guestfish-actions.pod:2074
11072 msgid "Any Microsoft Windows operating system."
11076 #: ../src/guestfs-actions.pod:3001 ../fish/guestfish-actions.pod:2076
11077 msgid "\"freebsd\""
11078 msgstr "\"freebsd\""
11081 #: ../src/guestfs-actions.pod:3003 ../fish/guestfish-actions.pod:2078
11086 #: ../src/guestfs-actions.pod:3007 ../fish/guestfish-actions.pod:2082
11087 msgid "The operating system type could not be determined."
11091 #: ../src/guestfs-actions.pod:3021
11092 msgid "guestfs_inspect_get_windows_current_control_set"
11096 #: ../src/guestfs-actions.pod:3023
11100 " guestfs_inspect_get_windows_current_control_set (guestfs_h *g,\n"
11101 " const char *root);\n"
11106 #: ../src/guestfs-actions.pod:3030 ../fish/guestfish-actions.pod:2098
11108 "This returns the Windows CurrentControlSet of the inspected guest. The "
11109 "CurrentControlSet is a registry key name such as C<ControlSet001>."
11113 #: ../src/guestfs-actions.pod:3033 ../fish/guestfish-actions.pod:2101
11115 "This call assumes that the guest is Windows and that the Registry could be "
11116 "examined by inspection. If this is not the case then an error is returned."
11120 #: ../src/guestfs-actions.pod:3042
11121 msgid "guestfs_inspect_get_windows_systemroot"
11125 #: ../src/guestfs-actions.pod:3044
11129 " guestfs_inspect_get_windows_systemroot (guestfs_h *g,\n"
11130 " const char *root);\n"
11135 #: ../src/guestfs-actions.pod:3051 ../fish/guestfish-actions.pod:2114
11137 "This returns the Windows systemroot of the inspected guest. The systemroot "
11138 "is a directory path such as C</WINDOWS>."
11142 #: ../src/guestfs-actions.pod:3054 ../fish/guestfish-actions.pod:2117
11144 "This call assumes that the guest is Windows and that the systemroot could be "
11145 "determined by inspection. If this is not the case then an error is returned."
11149 #: ../src/guestfs-actions.pod:3063
11150 msgid "(Added in 1.5.25)"
11154 #: ../src/guestfs-actions.pod:3065
11155 msgid "guestfs_inspect_is_live"
11159 #: ../src/guestfs-actions.pod:3067
11163 " guestfs_inspect_is_live (guestfs_h *g,\n"
11164 " const char *root);\n"
11169 #: ../src/guestfs-actions.pod:3074
11171 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
11172 "disk), then this returns true if a live image was detected on the disk."
11176 #: ../src/guestfs-actions.pod:3082
11177 msgid "guestfs_inspect_is_multipart"
11181 #: ../src/guestfs-actions.pod:3084
11185 " guestfs_inspect_is_multipart (guestfs_h *g,\n"
11186 " const char *root);\n"
11191 #: ../src/guestfs-actions.pod:3091
11193 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
11194 "disk), then this returns true if the disk is part of a set."
11198 #: ../src/guestfs-actions.pod:3099
11199 msgid "guestfs_inspect_is_netinst"
11203 #: ../src/guestfs-actions.pod:3101
11207 " guestfs_inspect_is_netinst (guestfs_h *g,\n"
11208 " const char *root);\n"
11213 #: ../src/guestfs-actions.pod:3108
11215 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
11216 "disk), then this returns true if the disk is a network installer, ie. not a "
11217 "self-contained install CD but one which is likely to require network access "
11218 "to complete the install."
11222 #: ../src/guestfs-actions.pod:3118
11223 msgid "guestfs_inspect_list_applications"
11227 #: ../src/guestfs-actions.pod:3120
11230 " struct guestfs_application_list *\n"
11231 " guestfs_inspect_list_applications (guestfs_h *g,\n"
11232 " const char *root);\n"
11237 #: ../src/guestfs-actions.pod:3127 ../fish/guestfish-actions.pod:2171
11238 msgid "Return the list of applications installed in the operating system."
11242 #: ../src/guestfs-actions.pod:3129
11244 "I<Note:> This call works differently from other parts of the inspection "
11245 "API. You have to call C<guestfs_inspect_os>, then "
11246 "C<guestfs_inspect_get_mountpoints>, then mount up the disks, before calling "
11247 "this. Listing applications is a significantly more difficult operation "
11248 "which requires access to the full filesystem. Also note that unlike the "
11249 "other C<guestfs_inspect_get_*> calls which are just returning data cached in "
11250 "the libguestfs handle, this call actually reads parts of the mounted "
11251 "filesystems during the call."
11255 #: ../src/guestfs-actions.pod:3139 ../fish/guestfish-actions.pod:2183
11257 "This returns an empty list if the inspection code was not able to determine "
11258 "the list of applications."
11262 #: ../src/guestfs-actions.pod:3142 ../fish/guestfish-actions.pod:2186
11263 msgid "The application structure contains the following fields:"
11267 #: ../src/guestfs-actions.pod:3146 ../fish/guestfish-actions.pod:2190
11268 msgid "C<app_name>"
11269 msgstr "C<app_name>"
11272 #: ../src/guestfs-actions.pod:3148 ../fish/guestfish-actions.pod:2192
11274 "The name of the application. For Red Hat-derived and Debian-derived Linux "
11275 "guests, this is the package name."
11279 #: ../src/guestfs-actions.pod:3151 ../fish/guestfish-actions.pod:2195
11280 msgid "C<app_display_name>"
11281 msgstr "C<app_display_name>"
11284 #: ../src/guestfs-actions.pod:3153 ../fish/guestfish-actions.pod:2197
11286 "The display name of the application, sometimes localized to the install "
11287 "language of the guest operating system."
11291 #: ../src/guestfs-actions.pod:3156 ../fish/guestfish-actions.pod:2200
11293 "If unavailable this is returned as an empty string C<\"\">. Callers needing "
11294 "to display something can use C<app_name> instead."
11298 #: ../src/guestfs-actions.pod:3159 ../fish/guestfish-actions.pod:2203
11299 msgid "C<app_epoch>"
11300 msgstr "C<app_epoch>"
11303 #: ../src/guestfs-actions.pod:3161 ../fish/guestfish-actions.pod:2205
11305 "For package managers which use epochs, this contains the epoch of the "
11306 "package (an integer). If unavailable, this is returned as C<0>."
11310 #: ../src/guestfs-actions.pod:3164 ../fish/guestfish-actions.pod:2208
11311 msgid "C<app_version>"
11312 msgstr "C<app_version>"
11315 #: ../src/guestfs-actions.pod:3166 ../fish/guestfish-actions.pod:2210
11317 "The version string of the application or package. If unavailable this is "
11318 "returned as an empty string C<\"\">."
11322 #: ../src/guestfs-actions.pod:3169 ../fish/guestfish-actions.pod:2213
11323 msgid "C<app_release>"
11324 msgstr "C<app_release>"
11327 #: ../src/guestfs-actions.pod:3171 ../fish/guestfish-actions.pod:2215
11329 "The release string of the application or package, for package managers that "
11330 "use this. If unavailable this is returned as an empty string C<\"\">."
11334 #: ../src/guestfs-actions.pod:3175 ../fish/guestfish-actions.pod:2219
11335 msgid "C<app_install_path>"
11336 msgstr "C<app_install_path>"
11339 #: ../src/guestfs-actions.pod:3177 ../fish/guestfish-actions.pod:2221
11341 "The installation path of the application (on operating systems such as "
11342 "Windows which use installation paths). This path is in the format used by "
11343 "the guest operating system, it is not a libguestfs path."
11347 #: ../src/guestfs-actions.pod:3182 ../fish/guestfish-actions.pod:2226
11348 msgid "If unavailable this is returned as an empty string C<\"\">."
11352 #: ../src/guestfs-actions.pod:3184 ../fish/guestfish-actions.pod:2228
11353 msgid "C<app_trans_path>"
11354 msgstr "C<app_trans_path>"
11357 #: ../src/guestfs-actions.pod:3186 ../fish/guestfish-actions.pod:2230
11359 "The install path translated into a libguestfs path. If unavailable this is "
11360 "returned as an empty string C<\"\">."
11364 #: ../src/guestfs-actions.pod:3189 ../fish/guestfish-actions.pod:2233
11365 msgid "C<app_publisher>"
11366 msgstr "C<app_publisher>"
11369 #: ../src/guestfs-actions.pod:3191 ../fish/guestfish-actions.pod:2235
11371 "The name of the publisher of the application, for package managers that use "
11372 "this. If unavailable this is returned as an empty string C<\"\">."
11376 #: ../src/guestfs-actions.pod:3195 ../fish/guestfish-actions.pod:2239
11378 msgstr "C<app_url>"
11381 #: ../src/guestfs-actions.pod:3197 ../fish/guestfish-actions.pod:2241
11383 "The URL (eg. upstream URL) of the application. If unavailable this is "
11384 "returned as an empty string C<\"\">."
11388 #: ../src/guestfs-actions.pod:3200 ../fish/guestfish-actions.pod:2244
11389 msgid "C<app_source_package>"
11393 #: ../src/guestfs-actions.pod:3202 ../fish/guestfish-actions.pod:2246
11395 "For packaging systems which support this, the name of the source package. "
11396 "If unavailable this is returned as an empty string C<\"\">."
11400 #: ../src/guestfs-actions.pod:3205 ../fish/guestfish-actions.pod:2249
11401 msgid "C<app_summary>"
11405 #: ../src/guestfs-actions.pod:3207 ../fish/guestfish-actions.pod:2251
11407 "A short (usually one line) description of the application or package. If "
11408 "unavailable this is returned as an empty string C<\"\">."
11412 #: ../src/guestfs-actions.pod:3210 ../fish/guestfish-actions.pod:2254
11413 msgid "C<app_description>"
11417 #: ../src/guestfs-actions.pod:3212 ../fish/guestfish-actions.pod:2256
11419 "A longer description of the application or package. If unavailable this is "
11420 "returned as an empty string C<\"\">."
11424 #: ../src/guestfs-actions.pod:3219
11426 "This function returns a C<struct guestfs_application_list *>, or NULL if "
11427 "there was an error. I<The caller must call C<guestfs_free_application_list> "
11432 #: ../src/guestfs-actions.pod:3223
11433 msgid "(Added in 1.7.8)"
11437 #: ../src/guestfs-actions.pod:3225
11438 msgid "guestfs_inspect_os"
11442 #: ../src/guestfs-actions.pod:3227
11446 " guestfs_inspect_os (guestfs_h *g);\n"
11451 #: ../src/guestfs-actions.pod:3230 ../fish/guestfish-actions.pod:2267
11453 "This function uses other libguestfs functions and certain heuristics to "
11454 "inspect the disk(s) (usually disks belonging to a virtual machine), looking "
11455 "for operating systems."
11459 #: ../src/guestfs-actions.pod:3234 ../fish/guestfish-actions.pod:2271
11460 msgid "The list returned is empty if no operating systems were found."
11464 #: ../src/guestfs-actions.pod:3236 ../fish/guestfish-actions.pod:2273
11466 "If one operating system was found, then this returns a list with a single "
11467 "element, which is the name of the root filesystem of this operating system. "
11468 "It is also possible for this function to return a list containing more than "
11469 "one element, indicating a dual-boot or multi-boot virtual machine, with each "
11470 "element being the root filesystem of one of the operating systems."
11474 #: ../src/guestfs-actions.pod:3243
11476 "You can pass the root string(s) returned to other C<guestfs_inspect_get_*> "
11477 "functions in order to query further information about each operating system, "
11478 "such as the name and version."
11482 #: ../src/guestfs-actions.pod:3248
11484 "This function uses other libguestfs features such as C<guestfs_mount_ro> and "
11485 "C<guestfs_umount_all> in order to mount and unmount filesystems and look at "
11486 "the contents. This should be called with no disks currently mounted. The "
11487 "function may also use Augeas, so any existing Augeas handle will be closed."
11491 #: ../src/guestfs-actions.pod:3254 ../fish/guestfish-actions.pod:2291
11493 "This function cannot decrypt encrypted disks. The caller must do that first "
11494 "(supplying the necessary keys) if the disk is encrypted."
11498 #: ../src/guestfs-actions.pod:3260 ../src/guestfs-actions.pod:3550
11499 #: ../src/guestfs-actions.pod:3612
11500 msgid "See also C<guestfs_list_filesystems>."
11504 #: ../src/guestfs-actions.pod:3268
11505 msgid "guestfs_is_blockdev"
11509 #: ../src/guestfs-actions.pod:3270
11513 " guestfs_is_blockdev (guestfs_h *g,\n"
11514 " const char *path);\n"
11519 #: ../src/guestfs-actions.pod:3274 ../fish/guestfish-actions.pod:2303
11521 "This returns C<true> if and only if there is a block device with the given "
11526 #: ../src/guestfs-actions.pod:3277 ../src/guestfs-actions.pod:3306
11527 #: ../src/guestfs-actions.pod:3336 ../src/guestfs-actions.pod:3351
11528 #: ../src/guestfs-actions.pod:3367 ../src/guestfs-actions.pod:3423
11529 #: ../src/guestfs-actions.pod:3438
11530 msgid "See also C<guestfs_stat>."
11534 #: ../src/guestfs-actions.pod:3281 ../src/guestfs-actions.pod:3310
11535 #: ../src/guestfs-actions.pod:3355 ../src/guestfs-actions.pod:3427
11536 #: ../src/guestfs-actions.pod:3442
11537 msgid "(Added in 1.5.10)"
11541 #: ../src/guestfs-actions.pod:3283
11542 msgid "guestfs_is_busy"
11546 #: ../src/guestfs-actions.pod:3285
11550 " guestfs_is_busy (guestfs_h *g);\n"
11555 #: ../src/guestfs-actions.pod:3288 ../fish/guestfish-actions.pod:2312
11557 "This returns true iff this handle is busy processing a command (in the "
11562 #: ../src/guestfs-actions.pod:3297
11563 msgid "guestfs_is_chardev"
11567 #: ../src/guestfs-actions.pod:3299
11571 " guestfs_is_chardev (guestfs_h *g,\n"
11572 " const char *path);\n"
11577 #: ../src/guestfs-actions.pod:3303 ../fish/guestfish-actions.pod:2321
11579 "This returns C<true> if and only if there is a character device with the "
11580 "given C<path> name."
11584 #: ../src/guestfs-actions.pod:3312
11585 msgid "guestfs_is_config"
11589 #: ../src/guestfs-actions.pod:3314
11593 " guestfs_is_config (guestfs_h *g);\n"
11598 #: ../src/guestfs-actions.pod:3317 ../fish/guestfish-actions.pod:2330
11600 "This returns true iff this handle is being configured (in the C<CONFIG> "
11605 #: ../src/guestfs-actions.pod:3326
11606 msgid "guestfs_is_dir"
11610 #: ../src/guestfs-actions.pod:3328
11614 " guestfs_is_dir (guestfs_h *g,\n"
11615 " const char *path);\n"
11620 #: ../src/guestfs-actions.pod:3332 ../fish/guestfish-actions.pod:2339
11622 "This returns C<true> if and only if there is a directory with the given "
11623 "C<path> name. Note that it returns false for other objects like files."
11627 #: ../src/guestfs-actions.pod:3342
11628 msgid "guestfs_is_fifo"
11632 #: ../src/guestfs-actions.pod:3344
11636 " guestfs_is_fifo (guestfs_h *g,\n"
11637 " const char *path);\n"
11642 #: ../src/guestfs-actions.pod:3348 ../fish/guestfish-actions.pod:2349
11644 "This returns C<true> if and only if there is a FIFO (named pipe) with the "
11645 "given C<path> name."
11649 #: ../src/guestfs-actions.pod:3357
11650 msgid "guestfs_is_file"
11654 #: ../src/guestfs-actions.pod:3359
11658 " guestfs_is_file (guestfs_h *g,\n"
11659 " const char *path);\n"
11664 #: ../src/guestfs-actions.pod:3363 ../fish/guestfish-actions.pod:2358
11666 "This returns C<true> if and only if there is a regular file with the given "
11667 "C<path> name. Note that it returns false for other objects like directories."
11671 #: ../src/guestfs-actions.pod:3373
11672 msgid "guestfs_is_launching"
11676 #: ../src/guestfs-actions.pod:3375
11680 " guestfs_is_launching (guestfs_h *g);\n"
11685 #: ../src/guestfs-actions.pod:3378 ../fish/guestfish-actions.pod:2368
11687 "This returns true iff this handle is launching the subprocess (in the "
11688 "C<LAUNCHING> state)."
11692 #: ../src/guestfs-actions.pod:3387
11693 msgid "guestfs_is_lv"
11697 #: ../src/guestfs-actions.pod:3389
11701 " guestfs_is_lv (guestfs_h *g,\n"
11702 " const char *device);\n"
11707 #: ../src/guestfs-actions.pod:3393 ../fish/guestfish-actions.pod:2377
11709 "This command tests whether C<device> is a logical volume, and returns true "
11710 "iff this is the case."
11714 #: ../src/guestfs-actions.pod:3400
11715 msgid "guestfs_is_ready"
11719 #: ../src/guestfs-actions.pod:3402
11723 " guestfs_is_ready (guestfs_h *g);\n"
11728 #: ../src/guestfs-actions.pod:3405 ../fish/guestfish-actions.pod:2384
11730 "This returns true iff this handle is ready to accept commands (in the "
11735 #: ../src/guestfs-actions.pod:3414
11736 msgid "guestfs_is_socket"
11740 #: ../src/guestfs-actions.pod:3416
11744 " guestfs_is_socket (guestfs_h *g,\n"
11745 " const char *path);\n"
11750 #: ../src/guestfs-actions.pod:3420 ../fish/guestfish-actions.pod:2393
11752 "This returns C<true> if and only if there is a Unix domain socket with the "
11753 "given C<path> name."
11757 #: ../src/guestfs-actions.pod:3429
11758 msgid "guestfs_is_symlink"
11762 #: ../src/guestfs-actions.pod:3431
11766 " guestfs_is_symlink (guestfs_h *g,\n"
11767 " const char *path);\n"
11772 #: ../src/guestfs-actions.pod:3435 ../fish/guestfish-actions.pod:2402
11774 "This returns C<true> if and only if there is a symbolic link with the given "
11779 #: ../src/guestfs-actions.pod:3444
11780 msgid "guestfs_kill_subprocess"
11784 #: ../src/guestfs-actions.pod:3446
11788 " guestfs_kill_subprocess (guestfs_h *g);\n"
11793 #: ../src/guestfs-actions.pod:3449 ../fish/guestfish-actions.pod:2411
11794 msgid "This kills the qemu subprocess. You should never need to call this."
11798 #: ../src/guestfs-actions.pod:3455
11799 msgid "guestfs_launch"
11803 #: ../src/guestfs-actions.pod:3457
11807 " guestfs_launch (guestfs_h *g);\n"
11812 #: ../src/guestfs-actions.pod:3460 ../fish/guestfish-actions.pod:2419
11814 "Internally libguestfs is implemented by running a virtual machine using "
11819 #: ../src/guestfs-actions.pod:3463 ../fish/guestfish-actions.pod:2422
11821 "You should call this after configuring the handle (eg. adding drives) but "
11822 "before performing any actions."
11826 #: ../src/guestfs-actions.pod:3475
11827 msgid "guestfs_lchown"
11831 #: ../src/guestfs-actions.pod:3477
11835 " guestfs_lchown (guestfs_h *g,\n"
11838 " const char *path);\n"
11843 #: ../src/guestfs-actions.pod:3483
11845 "Change the file owner to C<owner> and group to C<group>. This is like "
11846 "C<guestfs_chown> but if C<path> is a symlink then the link itself is "
11847 "changed, not the target."
11851 #: ../src/guestfs-actions.pod:3495
11852 msgid "guestfs_lgetxattr"
11856 #: ../src/guestfs-actions.pod:3497
11860 " guestfs_lgetxattr (guestfs_h *g,\n"
11861 " const char *path,\n"
11862 " const char *name,\n"
11863 " size_t *size_r);\n"
11868 #: ../src/guestfs-actions.pod:3503 ../fish/guestfish-actions.pod:2441
11870 "Get a single extended attribute from file C<path> named C<name>. If C<path> "
11871 "is a symlink, then this call returns an extended attribute from the symlink."
11875 #: ../src/guestfs-actions.pod:3517
11876 msgid "See also: C<guestfs_lgetxattrs>, C<guestfs_getxattr>, L<attr(5)>."
11880 #: ../src/guestfs-actions.pod:3525
11881 msgid "guestfs_lgetxattrs"
11885 #: ../src/guestfs-actions.pod:3527
11888 " struct guestfs_xattr_list *\n"
11889 " guestfs_lgetxattrs (guestfs_h *g,\n"
11890 " const char *path);\n"
11895 #: ../src/guestfs-actions.pod:3531
11897 "This is the same as C<guestfs_getxattrs>, but if C<path> is a symbolic link, "
11898 "then it returns the extended attributes of the link itself."
11902 #: ../src/guestfs-actions.pod:3541
11903 msgid "guestfs_list_devices"
11907 #: ../src/guestfs-actions.pod:3543
11911 " guestfs_list_devices (guestfs_h *g);\n"
11916 #: ../src/guestfs-actions.pod:3546 ../fish/guestfish-actions.pod:2469
11917 msgid "List all the block devices."
11921 #: ../src/guestfs-actions.pod:3548 ../fish/guestfish-actions.pod:2471
11922 msgid "The full block device names are returned, eg. C</dev/sda>."
11926 #: ../src/guestfs-actions.pod:3558
11927 msgid "guestfs_list_filesystems"
11931 #: ../src/guestfs-actions.pod:3560
11935 " guestfs_list_filesystems (guestfs_h *g);\n"
11940 #: ../src/guestfs-actions.pod:3563 ../fish/guestfish-actions.pod:2479
11942 "This inspection command looks for filesystems on partitions, block devices "
11943 "and logical volumes, returning a list of devices containing filesystems and "
11948 #: ../src/guestfs-actions.pod:3567 ../fish/guestfish-actions.pod:2483
11950 "The return value is a hash, where the keys are the devices containing "
11951 "filesystems, and the values are the filesystem types. For example:"
11955 #: ../src/guestfs-actions.pod:3571 ../fish/guestfish-actions.pod:2487
11958 " \"/dev/sda1\" => \"ntfs\"\n"
11959 " \"/dev/sda2\" => \"ext2\"\n"
11960 " \"/dev/vg_guest/lv_root\" => \"ext4\"\n"
11961 " \"/dev/vg_guest/lv_swap\" => \"swap\"\n"
11966 #: ../src/guestfs-actions.pod:3576 ../fish/guestfish-actions.pod:2492
11968 "The value can have the special value \"unknown\", meaning the content of the "
11969 "device is undetermined or empty. \"swap\" means a Linux swap partition."
11973 #: ../src/guestfs-actions.pod:3580
11975 "This command runs other libguestfs commands, which might include "
11976 "C<guestfs_mount> and C<guestfs_umount>, and therefore you should use this "
11977 "soon after launch and only when nothing is mounted."
11981 #: ../src/guestfs-actions.pod:3584
11983 "Not all of the filesystems returned will be mountable. In particular, swap "
11984 "partitions are returned in the list. Also this command does not check that "
11985 "each filesystem found is valid and mountable, and some filesystems might be "
11986 "mountable but require special options. Filesystems may not all belong to a "
11987 "single logical operating system (use C<guestfs_inspect_os> to look for OSes)."
11991 #: ../src/guestfs-actions.pod:3598 ../src/guestfs-actions.pod:5203
11992 msgid "(Added in 1.5.15)"
11996 #: ../src/guestfs-actions.pod:3600
11997 msgid "guestfs_list_partitions"
12001 #: ../src/guestfs-actions.pod:3602
12005 " guestfs_list_partitions (guestfs_h *g);\n"
12010 #: ../src/guestfs-actions.pod:3605 ../fish/guestfish-actions.pod:2512
12011 msgid "List all the partitions detected on all block devices."
12015 #: ../src/guestfs-actions.pod:3607 ../fish/guestfish-actions.pod:2514
12016 msgid "The full partition device names are returned, eg. C</dev/sda1>"
12020 #: ../src/guestfs-actions.pod:3609
12022 "This does not return logical volumes. For that you will need to call "
12027 #: ../src/guestfs-actions.pod:3620
12032 #: ../src/guestfs-actions.pod:3622
12036 " guestfs_ll (guestfs_h *g,\n"
12037 " const char *directory);\n"
12042 #: ../src/guestfs-actions.pod:3626 ../fish/guestfish-actions.pod:2525
12044 "List the files in C<directory> (relative to the root directory, there is no "
12045 "cwd) in the format of 'ls -la'."
12049 #: ../src/guestfs-actions.pod:3629 ../fish/guestfish-actions.pod:2528
12051 "This command is mostly useful for interactive sessions. It is I<not> "
12052 "intended that you try to parse the output string."
12056 #: ../src/guestfs-actions.pod:3637
12061 #: ../src/guestfs-actions.pod:3639
12065 " guestfs_ln (guestfs_h *g,\n"
12066 " const char *target,\n"
12067 " const char *linkname);\n"
12072 #: ../src/guestfs-actions.pod:3644 ../fish/guestfish-actions.pod:2535
12073 msgid "This command creates a hard link using the C<ln> command."
12077 #: ../src/guestfs-actions.pod:3650
12078 msgid "guestfs_ln_f"
12082 #: ../src/guestfs-actions.pod:3652
12086 " guestfs_ln_f (guestfs_h *g,\n"
12087 " const char *target,\n"
12088 " const char *linkname);\n"
12093 #: ../src/guestfs-actions.pod:3657 ../fish/guestfish-actions.pod:2541
12095 "This command creates a hard link using the C<ln -f> command. The C<-f> "
12096 "option removes the link (C<linkname>) if it exists already."
12100 #: ../src/guestfs-actions.pod:3664
12101 msgid "guestfs_ln_s"
12105 #: ../src/guestfs-actions.pod:3666
12109 " guestfs_ln_s (guestfs_h *g,\n"
12110 " const char *target,\n"
12111 " const char *linkname);\n"
12116 #: ../src/guestfs-actions.pod:3671 ../fish/guestfish-actions.pod:2548
12117 msgid "This command creates a symbolic link using the C<ln -s> command."
12121 #: ../src/guestfs-actions.pod:3677
12122 msgid "guestfs_ln_sf"
12126 #: ../src/guestfs-actions.pod:3679
12130 " guestfs_ln_sf (guestfs_h *g,\n"
12131 " const char *target,\n"
12132 " const char *linkname);\n"
12137 #: ../src/guestfs-actions.pod:3684 ../fish/guestfish-actions.pod:2554
12139 "This command creates a symbolic link using the C<ln -sf> command, The C<-f> "
12140 "option removes the link (C<linkname>) if it exists already."
12144 #: ../src/guestfs-actions.pod:3691
12145 msgid "guestfs_lremovexattr"
12149 #: ../src/guestfs-actions.pod:3693
12153 " guestfs_lremovexattr (guestfs_h *g,\n"
12154 " const char *xattr,\n"
12155 " const char *path);\n"
12160 #: ../src/guestfs-actions.pod:3698
12162 "This is the same as C<guestfs_removexattr>, but if C<path> is a symbolic "
12163 "link, then it removes an extended attribute of the link itself."
12167 #: ../src/guestfs-actions.pod:3706
12172 #: ../src/guestfs-actions.pod:3708
12176 " guestfs_ls (guestfs_h *g,\n"
12177 " const char *directory);\n"
12182 #: ../src/guestfs-actions.pod:3712 ../fish/guestfish-actions.pod:2569
12184 "List the files in C<directory> (relative to the root directory, there is no "
12185 "cwd). The '.' and '..' entries are not returned, but hidden files are shown."
12189 #: ../src/guestfs-actions.pod:3716
12191 "This command is mostly useful for interactive sessions. Programs should "
12192 "probably use C<guestfs_readdir> instead."
12196 #: ../src/guestfs-actions.pod:3725
12197 msgid "guestfs_lsetxattr"
12201 #: ../src/guestfs-actions.pod:3727
12205 " guestfs_lsetxattr (guestfs_h *g,\n"
12206 " const char *xattr,\n"
12207 " const char *val,\n"
12209 " const char *path);\n"
12214 #: ../src/guestfs-actions.pod:3734
12216 "This is the same as C<guestfs_setxattr>, but if C<path> is a symbolic link, "
12217 "then it sets an extended attribute of the link itself."
12221 #: ../src/guestfs-actions.pod:3742
12222 msgid "guestfs_lstat"
12226 #: ../src/guestfs-actions.pod:3744
12229 " struct guestfs_stat *\n"
12230 " guestfs_lstat (guestfs_h *g,\n"
12231 " const char *path);\n"
12236 #: ../src/guestfs-actions.pod:3748 ../src/guestfs-actions.pod:6306
12237 #: ../fish/guestfish-actions.pod:2588 ../fish/guestfish-actions.pod:4257
12238 msgid "Returns file information for the given C<path>."
12242 #: ../src/guestfs-actions.pod:3750
12244 "This is the same as C<guestfs_stat> except that if C<path> is a symbolic "
12245 "link, then the link is stat-ed, not the file it refers to."
12249 #: ../src/guestfs-actions.pod:3754 ../fish/guestfish-actions.pod:2594
12250 msgid "This is the same as the C<lstat(2)> system call."
12254 #: ../src/guestfs-actions.pod:3756 ../src/guestfs-actions.pod:6310
12256 "This function returns a C<struct guestfs_stat *>, or NULL if there was an "
12257 "error. I<The caller must call C<guestfs_free_stat> after use>."
12261 #: ../src/guestfs-actions.pod:3760 ../src/guestfs-actions.pod:6314
12262 #: ../src/guestfs-actions.pod:6332 ../src/guestfs-actions.pod:6713
12263 msgid "(Added in 0.9.2)"
12267 #: ../src/guestfs-actions.pod:3762
12268 msgid "guestfs_lstatlist"
12272 #: ../src/guestfs-actions.pod:3764
12275 " struct guestfs_stat_list *\n"
12276 " guestfs_lstatlist (guestfs_h *g,\n"
12277 " const char *path,\n"
12278 " char *const *names);\n"
12283 #: ../src/guestfs-actions.pod:3769
12285 "This call allows you to perform the C<guestfs_lstat> operation on multiple "
12286 "files, where all files are in the directory C<path>. C<names> is the list "
12287 "of files from this directory."
12291 #: ../src/guestfs-actions.pod:3773 ../fish/guestfish-actions.pod:2604
12293 "On return you get a list of stat structs, with a one-to-one correspondence "
12294 "to the C<names> list. If any name did not exist or could not be lstat'd, "
12295 "then the C<ino> field of that structure is set to C<-1>."
12299 #: ../src/guestfs-actions.pod:3778
12301 "This call is intended for programs that want to efficiently list a directory "
12302 "contents without making many round-trips. See also C<guestfs_lxattrlist> "
12303 "for a similarly efficient call for getting extended attributes. Very long "
12304 "directory listings might cause the protocol message size to be exceeded, "
12305 "causing this call to fail. The caller must split up such requests into "
12306 "smaller groups of names."
12310 #: ../src/guestfs-actions.pod:3786
12312 "This function returns a C<struct guestfs_stat_list *>, or NULL if there was "
12313 "an error. I<The caller must call C<guestfs_free_stat_list> after use>."
12317 #: ../src/guestfs-actions.pod:3792
12318 msgid "guestfs_luks_add_key"
12322 #: ../src/guestfs-actions.pod:3794
12326 " guestfs_luks_add_key (guestfs_h *g,\n"
12327 " const char *device,\n"
12328 " const char *key,\n"
12329 " const char *newkey,\n"
12335 #: ../src/guestfs-actions.pod:3801 ../fish/guestfish-actions.pod:2621
12337 "This command adds a new key on LUKS device C<device>. C<key> is any "
12338 "existing key, and is used to access the device. C<newkey> is the new key to "
12339 "add. C<keyslot> is the key slot that will be replaced."
12343 #: ../src/guestfs-actions.pod:3806
12345 "Note that if C<keyslot> already contains a key, then this command will "
12346 "fail. You have to use C<guestfs_luks_kill_slot> first to remove that key."
12350 #: ../src/guestfs-actions.pod:3812 ../src/guestfs-actions.pod:3852
12351 #: ../src/guestfs-actions.pod:3875 ../src/guestfs-actions.pod:3895
12352 #: ../src/guestfs-actions.pod:3927 ../src/guestfs-actions.pod:3946
12354 "This function takes a key or passphrase parameter which could contain "
12355 "sensitive material. Read the section L</KEYS AND PASSPHRASES> for more "
12360 #: ../src/guestfs-actions.pod:3816 ../src/guestfs-actions.pod:3856
12361 #: ../src/guestfs-actions.pod:3879 ../src/guestfs-actions.pod:3899
12362 msgid "(Added in 1.5.2)"
12366 #: ../src/guestfs-actions.pod:3818
12367 msgid "guestfs_luks_close"
12371 #: ../src/guestfs-actions.pod:3820
12375 " guestfs_luks_close (guestfs_h *g,\n"
12376 " const char *device);\n"
12381 #: ../src/guestfs-actions.pod:3824
12383 "This closes a LUKS device that was created earlier by C<guestfs_luks_open> "
12384 "or C<guestfs_luks_open_ro>. The C<device> parameter must be the name of the "
12385 "LUKS mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
12386 "underlying block device."
12390 #: ../src/guestfs-actions.pod:3832 ../src/guestfs-actions.pod:3931
12391 #: ../src/guestfs-actions.pod:3950 ../src/guestfs-actions.pod:4000
12392 #: ../src/guestfs-actions.pod:4048
12393 msgid "(Added in 1.5.1)"
12397 #: ../src/guestfs-actions.pod:3834
12398 msgid "guestfs_luks_format"
12402 #: ../src/guestfs-actions.pod:3836
12406 " guestfs_luks_format (guestfs_h *g,\n"
12407 " const char *device,\n"
12408 " const char *key,\n"
12414 #: ../src/guestfs-actions.pod:3842 ../fish/guestfish-actions.pod:2647
12416 "This command erases existing data on C<device> and formats the device as a "
12417 "LUKS encrypted device. C<key> is the initial key, which is added to key "
12418 "slot C<slot>. (LUKS supports 8 key slots, numbered 0-7)."
12422 #: ../src/guestfs-actions.pod:3849 ../src/guestfs-actions.pod:3872
12423 #: ../src/guestfs-actions.pod:4012 ../src/guestfs-actions.pod:4954
12424 #: ../src/guestfs-actions.pod:5734 ../src/guestfs-actions.pod:6141
12425 #: ../src/guestfs-actions.pod:6164 ../src/guestfs-actions.pod:6190
12426 #: ../src/guestfs-actions.pod:7350 ../fish/guestfish-actions.pod:2655
12427 #: ../fish/guestfish-actions.pod:2668 ../fish/guestfish-actions.pod:2752
12428 #: ../fish/guestfish-actions.pod:3326 ../fish/guestfish-actions.pod:3846
12429 #: ../fish/guestfish-actions.pod:4156 ../fish/guestfish-actions.pod:4172
12430 #: ../fish/guestfish-actions.pod:4187 ../fish/guestfish-actions.pod:4902
12432 "B<This command is dangerous. Without careful use you can easily destroy all "
12437 #: ../src/guestfs-actions.pod:3858
12438 msgid "guestfs_luks_format_cipher"
12442 #: ../src/guestfs-actions.pod:3860
12446 " guestfs_luks_format_cipher (guestfs_h *g,\n"
12447 " const char *device,\n"
12448 " const char *key,\n"
12450 " const char *cipher);\n"
12455 #: ../src/guestfs-actions.pod:3867
12457 "This command is the same as C<guestfs_luks_format> but it also allows you to "
12458 "set the C<cipher> used."
12462 #: ../src/guestfs-actions.pod:3881
12463 msgid "guestfs_luks_kill_slot"
12467 #: ../src/guestfs-actions.pod:3883
12471 " guestfs_luks_kill_slot (guestfs_h *g,\n"
12472 " const char *device,\n"
12473 " const char *key,\n"
12479 #: ../src/guestfs-actions.pod:3889 ../fish/guestfish-actions.pod:2675
12481 "This command deletes the key in key slot C<keyslot> from the encrypted LUKS "
12482 "device C<device>. C<key> must be one of the I<other> keys."
12486 #: ../src/guestfs-actions.pod:3901
12487 msgid "guestfs_luks_open"
12491 #: ../src/guestfs-actions.pod:3903
12495 " guestfs_luks_open (guestfs_h *g,\n"
12496 " const char *device,\n"
12497 " const char *key,\n"
12498 " const char *mapname);\n"
12503 #: ../src/guestfs-actions.pod:3909 ../fish/guestfish-actions.pod:2686
12505 "This command opens a block device which has been encrypted according to the "
12506 "Linux Unified Key Setup (LUKS) standard."
12510 #: ../src/guestfs-actions.pod:3912 ../fish/guestfish-actions.pod:2689
12511 msgid "C<device> is the encrypted block device or partition."
12515 #: ../src/guestfs-actions.pod:3914 ../fish/guestfish-actions.pod:2691
12517 "The caller must supply one of the keys associated with the LUKS block "
12518 "device, in the C<key> parameter."
12522 #: ../src/guestfs-actions.pod:3917 ../fish/guestfish-actions.pod:2694
12524 "This creates a new block device called C</dev/mapper/mapname>. Reads and "
12525 "writes to this block device are decrypted from and encrypted to the "
12526 "underlying C<device> respectively."
12530 #: ../src/guestfs-actions.pod:3921
12532 "If this block device contains LVM volume groups, then calling "
12533 "C<guestfs_vgscan> followed by C<guestfs_vg_activate_all> will make them "
12538 #: ../src/guestfs-actions.pod:3933
12539 msgid "guestfs_luks_open_ro"
12543 #: ../src/guestfs-actions.pod:3935
12547 " guestfs_luks_open_ro (guestfs_h *g,\n"
12548 " const char *device,\n"
12549 " const char *key,\n"
12550 " const char *mapname);\n"
12555 #: ../src/guestfs-actions.pod:3941
12557 "This is the same as C<guestfs_luks_open> except that a read-only mapping is "
12562 #: ../src/guestfs-actions.pod:3952
12563 msgid "guestfs_lvcreate"
12567 #: ../src/guestfs-actions.pod:3954
12571 " guestfs_lvcreate (guestfs_h *g,\n"
12572 " const char *logvol,\n"
12573 " const char *volgroup,\n"
12579 #: ../src/guestfs-actions.pod:3960 ../fish/guestfish-actions.pod:2719
12581 "This creates an LVM logical volume called C<logvol> on the volume group "
12582 "C<volgroup>, with C<size> megabytes."
12586 #: ../src/guestfs-actions.pod:3967
12587 msgid "guestfs_lvm_canonical_lv_name"
12591 #: ../src/guestfs-actions.pod:3969
12595 " guestfs_lvm_canonical_lv_name (guestfs_h *g,\n"
12596 " const char *lvname);\n"
12601 #: ../src/guestfs-actions.pod:3973 ../fish/guestfish-actions.pod:2726
12603 "This converts alternative naming schemes for LVs that you might find to the "
12604 "canonical name. For example, C</dev/mapper/VG-LV> is converted to C</dev/VG/"
12609 #: ../src/guestfs-actions.pod:3977 ../fish/guestfish-actions.pod:2730
12611 "This command returns an error if the C<lvname> parameter does not refer to a "
12616 #: ../src/guestfs-actions.pod:3980
12617 msgid "See also C<guestfs_is_lv>."
12621 #: ../src/guestfs-actions.pod:3985
12622 msgid "(Added in 1.5.24)"
12626 #: ../src/guestfs-actions.pod:3987
12627 msgid "guestfs_lvm_clear_filter"
12631 #: ../src/guestfs-actions.pod:3989
12635 " guestfs_lvm_clear_filter (guestfs_h *g);\n"
12640 #: ../src/guestfs-actions.pod:3992
12642 "This undoes the effect of C<guestfs_lvm_set_filter>. LVM will be able to "
12643 "see every block device."
12647 #: ../src/guestfs-actions.pod:3995 ../src/guestfs-actions.pod:4037
12648 #: ../fish/guestfish-actions.pod:2742 ../fish/guestfish-actions.pod:2773
12650 "This command also clears the LVM cache and performs a volume group scan."
12654 #: ../src/guestfs-actions.pod:4002
12655 msgid "guestfs_lvm_remove_all"
12659 #: ../src/guestfs-actions.pod:4004
12663 " guestfs_lvm_remove_all (guestfs_h *g);\n"
12668 #: ../src/guestfs-actions.pod:4007 ../fish/guestfish-actions.pod:2749
12670 "This command removes all LVM logical volumes, volume groups and physical "
12675 #: ../src/guestfs-actions.pod:4017
12676 msgid "guestfs_lvm_set_filter"
12680 #: ../src/guestfs-actions.pod:4019
12684 " guestfs_lvm_set_filter (guestfs_h *g,\n"
12685 " char *const *devices);\n"
12690 #: ../src/guestfs-actions.pod:4023 ../fish/guestfish-actions.pod:2759
12692 "This sets the LVM device filter so that LVM will only be able to \"see\" the "
12693 "block devices in the list C<devices>, and will ignore all other attached "
12698 #: ../src/guestfs-actions.pod:4027 ../fish/guestfish-actions.pod:2763
12700 "Where disk image(s) contain duplicate PVs or VGs, this command is useful to "
12701 "get LVM to ignore the duplicates, otherwise LVM can get confused. Note also "
12702 "there are two types of duplication possible: either cloned PVs/VGs which "
12703 "have identical UUIDs; or VGs that are not cloned but just happen to have the "
12704 "same name. In normal operation you cannot create this situation, but you "
12705 "can do it outside LVM, eg. by cloning disk images or by bit twiddling "
12706 "inside the LVM metadata."
12710 #: ../src/guestfs-actions.pod:4040 ../fish/guestfish-actions.pod:2776
12711 msgid "You can filter whole block devices or individual partitions."
12715 #: ../src/guestfs-actions.pod:4042 ../fish/guestfish-actions.pod:2778
12717 "You cannot use this if any VG is currently in use (eg. contains a mounted "
12718 "filesystem), even if you are not filtering out that VG."
12722 #: ../src/guestfs-actions.pod:4050
12723 msgid "guestfs_lvremove"
12727 #: ../src/guestfs-actions.pod:4052
12731 " guestfs_lvremove (guestfs_h *g,\n"
12732 " const char *device);\n"
12737 #: ../src/guestfs-actions.pod:4056 ../fish/guestfish-actions.pod:2786
12739 "Remove an LVM logical volume C<device>, where C<device> is the path to the "
12740 "LV, such as C</dev/VG/LV>."
12744 #: ../src/guestfs-actions.pod:4059 ../fish/guestfish-actions.pod:2789
12746 "You can also remove all LVs in a volume group by specifying the VG name, C</"
12751 #: ../src/guestfs-actions.pod:4064 ../src/guestfs-actions.pod:5300
12752 #: ../src/guestfs-actions.pod:7089
12753 msgid "(Added in 1.0.13)"
12757 #: ../src/guestfs-actions.pod:4066
12758 msgid "guestfs_lvrename"
12762 #: ../src/guestfs-actions.pod:4068
12766 " guestfs_lvrename (guestfs_h *g,\n"
12767 " const char *logvol,\n"
12768 " const char *newlogvol);\n"
12773 #: ../src/guestfs-actions.pod:4073 ../fish/guestfish-actions.pod:2796
12774 msgid "Rename a logical volume C<logvol> with the new name C<newlogvol>."
12778 #: ../src/guestfs-actions.pod:4077 ../src/guestfs-actions.pod:7102
12779 msgid "(Added in 1.0.83)"
12783 #: ../src/guestfs-actions.pod:4079
12784 msgid "guestfs_lvresize"
12788 #: ../src/guestfs-actions.pod:4081
12792 " guestfs_lvresize (guestfs_h *g,\n"
12793 " const char *device,\n"
12799 #: ../src/guestfs-actions.pod:4086 ../fish/guestfish-actions.pod:2802
12801 "This resizes (expands or shrinks) an existing LVM logical volume to "
12802 "C<mbytes>. When reducing, data in the reduced part is lost."
12806 #: ../src/guestfs-actions.pod:4094
12807 msgid "guestfs_lvresize_free"
12811 #: ../src/guestfs-actions.pod:4096
12815 " guestfs_lvresize_free (guestfs_h *g,\n"
12816 " const char *lv,\n"
12822 #: ../src/guestfs-actions.pod:4101 ../fish/guestfish-actions.pod:2810
12824 "This expands an existing logical volume C<lv> so that it fills C<pc>% of the "
12825 "remaining free space in the volume group. Commonly you would call this with "
12826 "pc = 100 which expands the logical volume as much as possible, using all "
12827 "remaining free space in the volume group."
12831 #: ../src/guestfs-actions.pod:4109
12832 msgid "(Added in 1.3.3)"
12836 #: ../src/guestfs-actions.pod:4111
12837 msgid "guestfs_lvs"
12841 #: ../src/guestfs-actions.pod:4113
12845 " guestfs_lvs (guestfs_h *g);\n"
12850 #: ../src/guestfs-actions.pod:4116 ../fish/guestfish-actions.pod:2820
12852 "List all the logical volumes detected. This is the equivalent of the L<lvs"
12857 #: ../src/guestfs-actions.pod:4119 ../fish/guestfish-actions.pod:2823
12859 "This returns a list of the logical volume device names (eg. C</dev/"
12860 "VolGroup00/LogVol00>)."
12864 #: ../src/guestfs-actions.pod:4122
12865 msgid "See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>."
12869 #: ../src/guestfs-actions.pod:4130
12870 msgid "guestfs_lvs_full"
12874 #: ../src/guestfs-actions.pod:4132
12877 " struct guestfs_lvm_lv_list *\n"
12878 " guestfs_lvs_full (guestfs_h *g);\n"
12883 #: ../src/guestfs-actions.pod:4135 ../fish/guestfish-actions.pod:2832
12885 "List all the logical volumes detected. This is the equivalent of the L<lvs"
12886 "(8)> command. The \"full\" version includes all fields."
12890 #: ../src/guestfs-actions.pod:4138
12892 "This function returns a C<struct guestfs_lvm_lv_list *>, or NULL if there "
12893 "was an error. I<The caller must call C<guestfs_free_lvm_lv_list> after use>."
12897 #: ../src/guestfs-actions.pod:4144
12898 msgid "guestfs_lvuuid"
12902 #: ../src/guestfs-actions.pod:4146
12906 " guestfs_lvuuid (guestfs_h *g,\n"
12907 " const char *device);\n"
12912 #: ../src/guestfs-actions.pod:4150 ../fish/guestfish-actions.pod:2839
12913 msgid "This command returns the UUID of the LVM LV C<device>."
12917 #: ../src/guestfs-actions.pod:4157
12918 msgid "guestfs_lxattrlist"
12922 #: ../src/guestfs-actions.pod:4159
12925 " struct guestfs_xattr_list *\n"
12926 " guestfs_lxattrlist (guestfs_h *g,\n"
12927 " const char *path,\n"
12928 " char *const *names);\n"
12933 #: ../src/guestfs-actions.pod:4164 ../fish/guestfish-actions.pod:2845
12935 "This call allows you to get the extended attributes of multiple files, where "
12936 "all files are in the directory C<path>. C<names> is the list of files from "
12941 #: ../src/guestfs-actions.pod:4168 ../fish/guestfish-actions.pod:2849
12943 "On return you get a flat list of xattr structs which must be interpreted "
12944 "sequentially. The first xattr struct always has a zero-length C<attrname>. "
12945 "C<attrval> in this struct is zero-length to indicate there was an error "
12946 "doing C<lgetxattr> for this file, I<or> is a C string which is a decimal "
12947 "number (the number of following attributes for this file, which could be C<"
12948 "\"0\">). Then after the first xattr struct are the zero or more attributes "
12949 "for the first named file. This repeats for the second and subsequent files."
12953 #: ../src/guestfs-actions.pod:4178
12955 "This call is intended for programs that want to efficiently list a directory "
12956 "contents without making many round-trips. See also C<guestfs_lstatlist> for "
12957 "a similarly efficient call for getting standard stats. Very long directory "
12958 "listings might cause the protocol message size to be exceeded, causing this "
12959 "call to fail. The caller must split up such requests into smaller groups of "
12964 #: ../src/guestfs-actions.pod:4192
12965 msgid "guestfs_mkdir"
12969 #: ../src/guestfs-actions.pod:4194
12973 " guestfs_mkdir (guestfs_h *g,\n"
12974 " const char *path);\n"
12979 #: ../src/guestfs-actions.pod:4198 ../fish/guestfish-actions.pod:2871
12980 msgid "Create a directory named C<path>."
12984 #: ../src/guestfs-actions.pod:4204
12985 msgid "guestfs_mkdir_mode"
12989 #: ../src/guestfs-actions.pod:4206
12993 " guestfs_mkdir_mode (guestfs_h *g,\n"
12994 " const char *path,\n"
13000 #: ../src/guestfs-actions.pod:4211 ../fish/guestfish-actions.pod:2877
13002 "This command creates a directory, setting the initial permissions of the "
13003 "directory to C<mode>."
13007 #: ../src/guestfs-actions.pod:4214 ../fish/guestfish-actions.pod:2880
13009 "For common Linux filesystems, the actual mode which is set will be C<mode & "
13010 "~umask & 01777>. Non-native-Linux filesystems may interpret the mode in "
13015 #: ../src/guestfs-actions.pod:4218
13016 msgid "See also C<guestfs_mkdir>, C<guestfs_umask>"
13020 #: ../src/guestfs-actions.pod:4224
13021 msgid "guestfs_mkdir_p"
13025 #: ../src/guestfs-actions.pod:4226
13029 " guestfs_mkdir_p (guestfs_h *g,\n"
13030 " const char *path);\n"
13035 #: ../src/guestfs-actions.pod:4230 ../fish/guestfish-actions.pod:2890
13037 "Create a directory named C<path>, creating any parent directories as "
13038 "necessary. This is like the C<mkdir -p> shell command."
13042 #: ../src/guestfs-actions.pod:4237
13043 msgid "guestfs_mkdtemp"
13047 #: ../src/guestfs-actions.pod:4239
13051 " guestfs_mkdtemp (guestfs_h *g,\n"
13052 " const char *template);\n"
13057 #: ../src/guestfs-actions.pod:4243 ../fish/guestfish-actions.pod:2897
13059 "This command creates a temporary directory. The C<template> parameter "
13060 "should be a full pathname for the temporary directory name with the final "
13061 "six characters being \"XXXXXX\"."
13065 #: ../src/guestfs-actions.pod:4248 ../fish/guestfish-actions.pod:2902
13067 "For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\", the second one "
13068 "being suitable for Windows filesystems."
13072 #: ../src/guestfs-actions.pod:4251 ../fish/guestfish-actions.pod:2905
13073 msgid "The name of the temporary directory that was created is returned."
13077 #: ../src/guestfs-actions.pod:4254 ../fish/guestfish-actions.pod:2908
13078 msgid "The temporary directory is created with mode 0700 and is owned by root."
13082 #: ../src/guestfs-actions.pod:4257 ../fish/guestfish-actions.pod:2911
13084 "The caller is responsible for deleting the temporary directory and its "
13085 "contents after use."
13089 #: ../src/guestfs-actions.pod:4260 ../fish/guestfish-actions.pod:2914
13090 msgid "See also: L<mkdtemp(3)>"
13094 #: ../src/guestfs-actions.pod:4267
13095 msgid "guestfs_mke2fs_J"
13099 #: ../src/guestfs-actions.pod:4269
13103 " guestfs_mke2fs_J (guestfs_h *g,\n"
13104 " const char *fstype,\n"
13105 " int blocksize,\n"
13106 " const char *device,\n"
13107 " const char *journal);\n"
13112 #: ../src/guestfs-actions.pod:4276 ../fish/guestfish-actions.pod:2920
13114 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
13115 "C<journal>. It is equivalent to the command:"
13119 #: ../src/guestfs-actions.pod:4280 ../fish/guestfish-actions.pod:2924
13122 " mke2fs -t fstype -b blocksize -J device=<journal> <device>\n"
13127 #: ../src/guestfs-actions.pod:4282
13128 msgid "See also C<guestfs_mke2journal>."
13132 #: ../src/guestfs-actions.pod:4286 ../src/guestfs-actions.pod:4304
13133 #: ../src/guestfs-actions.pod:4322 ../src/guestfs-actions.pod:4338
13134 #: ../src/guestfs-actions.pod:4352 ../src/guestfs-actions.pod:4366
13135 #: ../src/guestfs-actions.pod:4425 ../src/guestfs-actions.pod:4690
13136 msgid "(Added in 1.0.68)"
13140 #: ../src/guestfs-actions.pod:4288
13141 msgid "guestfs_mke2fs_JL"
13145 #: ../src/guestfs-actions.pod:4290
13149 " guestfs_mke2fs_JL (guestfs_h *g,\n"
13150 " const char *fstype,\n"
13151 " int blocksize,\n"
13152 " const char *device,\n"
13153 " const char *label);\n"
13158 #: ../src/guestfs-actions.pod:4297 ../fish/guestfish-actions.pod:2932
13160 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
13161 "the journal labeled C<label>."
13165 #: ../src/guestfs-actions.pod:4300
13166 msgid "See also C<guestfs_mke2journal_L>."
13170 #: ../src/guestfs-actions.pod:4306
13171 msgid "guestfs_mke2fs_JU"
13175 #: ../src/guestfs-actions.pod:4308
13179 " guestfs_mke2fs_JU (guestfs_h *g,\n"
13180 " const char *fstype,\n"
13181 " int blocksize,\n"
13182 " const char *device,\n"
13183 " const char *uuid);\n"
13188 #: ../src/guestfs-actions.pod:4315 ../fish/guestfish-actions.pod:2941
13190 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
13191 "the journal with UUID C<uuid>."
13195 #: ../src/guestfs-actions.pod:4318
13196 msgid "See also C<guestfs_mke2journal_U>."
13200 #: ../src/guestfs-actions.pod:4324
13201 msgid "guestfs_mke2journal"
13205 #: ../src/guestfs-actions.pod:4326
13209 " guestfs_mke2journal (guestfs_h *g,\n"
13210 " int blocksize,\n"
13211 " const char *device);\n"
13216 #: ../src/guestfs-actions.pod:4331 ../fish/guestfish-actions.pod:2950
13218 "This creates an ext2 external journal on C<device>. It is equivalent to the "
13223 #: ../src/guestfs-actions.pod:4334 ../fish/guestfish-actions.pod:2953
13226 " mke2fs -O journal_dev -b blocksize device\n"
13231 #: ../src/guestfs-actions.pod:4340
13232 msgid "guestfs_mke2journal_L"
13236 #: ../src/guestfs-actions.pod:4342
13240 " guestfs_mke2journal_L (guestfs_h *g,\n"
13241 " int blocksize,\n"
13242 " const char *label,\n"
13243 " const char *device);\n"
13248 #: ../src/guestfs-actions.pod:4348 ../fish/guestfish-actions.pod:2959
13249 msgid "This creates an ext2 external journal on C<device> with label C<label>."
13253 #: ../src/guestfs-actions.pod:4354
13254 msgid "guestfs_mke2journal_U"
13258 #: ../src/guestfs-actions.pod:4356
13262 " guestfs_mke2journal_U (guestfs_h *g,\n"
13263 " int blocksize,\n"
13264 " const char *uuid,\n"
13265 " const char *device);\n"
13270 #: ../src/guestfs-actions.pod:4362 ../fish/guestfish-actions.pod:2965
13271 msgid "This creates an ext2 external journal on C<device> with UUID C<uuid>."
13275 #: ../src/guestfs-actions.pod:4368
13276 msgid "guestfs_mkfifo"
13280 #: ../src/guestfs-actions.pod:4370
13284 " guestfs_mkfifo (guestfs_h *g,\n"
13286 " const char *path);\n"
13291 #: ../src/guestfs-actions.pod:4375
13293 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
13294 "is just a convenient wrapper around C<guestfs_mknod>."
13298 #: ../src/guestfs-actions.pod:4385
13299 msgid "guestfs_mkfs"
13303 #: ../src/guestfs-actions.pod:4387
13307 " guestfs_mkfs (guestfs_h *g,\n"
13308 " const char *fstype,\n"
13309 " const char *device);\n"
13314 #: ../src/guestfs-actions.pod:4392 ../fish/guestfish-actions.pod:2981
13316 "This creates a filesystem on C<device> (usually a partition or LVM logical "
13317 "volume). The filesystem type is C<fstype>, for example C<ext3>."
13321 #: ../src/guestfs-actions.pod:4400
13322 msgid "guestfs_mkfs_b"
13326 #: ../src/guestfs-actions.pod:4402
13330 " guestfs_mkfs_b (guestfs_h *g,\n"
13331 " const char *fstype,\n"
13332 " int blocksize,\n"
13333 " const char *device);\n"
13338 #: ../src/guestfs-actions.pod:4408
13340 "This call is similar to C<guestfs_mkfs>, but it allows you to control the "
13341 "block size of the resulting filesystem. Supported block sizes depend on the "
13342 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
13346 #: ../src/guestfs-actions.pod:4413 ../src/guestfs-actions.pod:4456
13347 #: ../fish/guestfish-actions.pod:2994 ../fish/guestfish-actions.pod:3021
13349 "For VFAT and NTFS the C<blocksize> parameter is treated as the requested "
13354 #: ../src/guestfs-actions.pod:4418 ../fish/guestfish-actions.pod:2997
13356 "This function is deprecated. In new code, use the C<mkfs_opts> call instead."
13360 #: ../src/guestfs-actions.pod:4427
13361 msgid "guestfs_mkfs_opts"
13365 #: ../src/guestfs-actions.pod:4429
13369 " guestfs_mkfs_opts (guestfs_h *g,\n"
13370 " const char *fstype,\n"
13371 " const char *device,\n"
13377 #: ../src/guestfs-actions.pod:4440
13380 " GUESTFS_MKFS_OPTS_BLOCKSIZE, int blocksize,\n"
13381 " GUESTFS_MKFS_OPTS_FEATURES, const char *features,\n"
13386 #: ../src/guestfs-actions.pod:4443 ../fish/guestfish-actions.pod:3008
13388 "This function creates a filesystem on C<device>. The filesystem type is "
13389 "C<fstype>, for example C<ext3>."
13393 #: ../src/guestfs-actions.pod:4450 ../fish/guestfish-actions.pod:3015
13394 msgid "C<blocksize>"
13398 #: ../src/guestfs-actions.pod:4452 ../fish/guestfish-actions.pod:3017
13400 "The filesystem block size. Supported block sizes depend on the filesystem "
13401 "type, but typically they are C<1024>, C<2048> or C<4096> for Linux ext2/3 "
13406 #: ../src/guestfs-actions.pod:4459 ../fish/guestfish-actions.pod:3024
13407 msgid "For UFS block sizes, please see L<mkfs.ufs(8)>."
13411 #: ../src/guestfs-actions.pod:4461 ../fish/guestfish-actions.pod:3026
13412 msgid "C<features>"
13416 #: ../src/guestfs-actions.pod:4463 ../fish/guestfish-actions.pod:3028
13417 msgid "This passes the C<-O> parameter to the external mkfs program."
13421 #: ../src/guestfs-actions.pod:4465 ../fish/guestfish-actions.pod:3030
13423 "For certain filesystem types, this allows extra filesystem features to be "
13424 "selected. See L<mke2fs(8)> and L<mkfs.ufs(8)> for more details."
13428 #: ../src/guestfs-actions.pod:4469 ../fish/guestfish-actions.pod:3034
13430 "You cannot use this optional parameter with the C<gfs> or C<gfs2> filesystem "
13435 #: ../src/guestfs-actions.pod:4476
13436 msgid "(Added in 1.7.19)"
13440 #: ../src/guestfs-actions.pod:4478
13441 msgid "guestfs_mkfs_opts_va"
13445 #: ../src/guestfs-actions.pod:4480
13449 " guestfs_mkfs_opts_va (guestfs_h *g,\n"
13450 " const char *fstype,\n"
13451 " const char *device,\n"
13452 " va_list args);\n"
13457 #: ../src/guestfs-actions.pod:4486
13458 msgid "This is the \"va_list variant\" of L</guestfs_mkfs_opts>."
13462 #: ../src/guestfs-actions.pod:4490
13463 msgid "guestfs_mkfs_opts_argv"
13467 #: ../src/guestfs-actions.pod:4492
13471 " guestfs_mkfs_opts_argv (guestfs_h *g,\n"
13472 " const char *fstype,\n"
13473 " const char *device,\n"
13474 " const struct guestfs_mkfs_opts_argv *optargs);\n"
13479 #: ../src/guestfs-actions.pod:4498
13480 msgid "This is the \"argv variant\" of L</guestfs_mkfs_opts>."
13484 #: ../src/guestfs-actions.pod:4502
13485 msgid "guestfs_mkmountpoint"
13489 #: ../src/guestfs-actions.pod:4504
13493 " guestfs_mkmountpoint (guestfs_h *g,\n"
13494 " const char *exemptpath);\n"
13499 #: ../src/guestfs-actions.pod:4508
13501 "C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are specialized calls "
13502 "that can be used to create extra mountpoints before mounting the first "
13507 #: ../src/guestfs-actions.pod:4512 ../fish/guestfish-actions.pod:3049
13509 "These calls are I<only> necessary in some very limited circumstances, mainly "
13510 "the case where you want to mount a mix of unrelated and/or read-only "
13511 "filesystems together."
13515 #: ../src/guestfs-actions.pod:4516 ../fish/guestfish-actions.pod:3053
13517 "For example, live CDs often contain a \"Russian doll\" nest of filesystems, "
13518 "an ISO outer layer, with a squashfs image inside, with an ext2/3 image "
13519 "inside that. You can unpack this as follows in guestfish:"
13523 #: ../src/guestfs-actions.pod:4521 ../fish/guestfish-actions.pod:3058
13526 " add-ro Fedora-11-i686-Live.iso\n"
13528 " mkmountpoint /cd\n"
13529 " mkmountpoint /sqsh\n"
13530 " mkmountpoint /ext3fs\n"
13531 " mount /dev/sda /cd\n"
13532 " mount-loop /cd/LiveOS/squashfs.img /sqsh\n"
13533 " mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs\n"
13538 #: ../src/guestfs-actions.pod:4530 ../fish/guestfish-actions.pod:3067
13539 msgid "The inner filesystem is now unpacked under the /ext3fs mountpoint."
13543 #: ../src/guestfs-actions.pod:4532
13545 "C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>. You "
13546 "may get unexpected errors if you try to mix these calls. It is safest to "
13547 "manually unmount filesystems and remove mountpoints after use."
13551 #: ../src/guestfs-actions.pod:4536
13553 "C<guestfs_umount_all> unmounts filesystems by sorting the paths longest "
13554 "first, so for this to work for manual mountpoints, you must ensure that the "
13555 "innermost mountpoints have the longest pathnames, as in the example code "
13560 #: ../src/guestfs-actions.pod:4541 ../fish/guestfish-actions.pod:3078
13562 "For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>"
13566 #: ../src/guestfs-actions.pod:4543
13568 "Autosync [see C<guestfs_set_autosync>, this is set by default on handles] "
13569 "can cause C<guestfs_umount_all> to be called when the handle is closed which "
13570 "can also trigger these issues."
13574 #: ../src/guestfs-actions.pod:4549 ../src/guestfs-actions.pod:4808
13575 #: ../src/guestfs-actions.pod:5718
13576 msgid "(Added in 1.0.62)"
13580 #: ../src/guestfs-actions.pod:4551
13581 msgid "guestfs_mknod"
13585 #: ../src/guestfs-actions.pod:4553
13589 " guestfs_mknod (guestfs_h *g,\n"
13593 " const char *path);\n"
13598 #: ../src/guestfs-actions.pod:4560 ../fish/guestfish-actions.pod:3088
13600 "This call creates block or character special devices, or named pipes (FIFOs)."
13604 #: ../src/guestfs-actions.pod:4563 ../fish/guestfish-actions.pod:3091
13606 "The C<mode> parameter should be the mode, using the standard constants. "
13607 "C<devmajor> and C<devminor> are the device major and minor numbers, only "
13608 "used when creating block and character special devices."
13612 #: ../src/guestfs-actions.pod:4568
13614 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
13615 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
13616 "regular file). These constants are available in the standard Linux header "
13617 "files, or you can use C<guestfs_mknod_b>, C<guestfs_mknod_c> or "
13618 "C<guestfs_mkfifo> which are wrappers around this command which bitwise OR in "
13619 "the appropriate constant for you."
13623 #: ../src/guestfs-actions.pod:4582
13624 msgid "guestfs_mknod_b"
13628 #: ../src/guestfs-actions.pod:4584
13632 " guestfs_mknod_b (guestfs_h *g,\n"
13636 " const char *path);\n"
13641 #: ../src/guestfs-actions.pod:4591
13643 "This call creates a block device node called C<path> with mode C<mode> and "
13644 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
13645 "wrapper around C<guestfs_mknod>."
13649 #: ../src/guestfs-actions.pod:4601
13650 msgid "guestfs_mknod_c"
13654 #: ../src/guestfs-actions.pod:4603
13658 " guestfs_mknod_c (guestfs_h *g,\n"
13662 " const char *path);\n"
13667 #: ../src/guestfs-actions.pod:4610
13669 "This call creates a char device node called C<path> with mode C<mode> and "
13670 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
13671 "wrapper around C<guestfs_mknod>."
13675 #: ../src/guestfs-actions.pod:4620
13676 msgid "guestfs_mkswap"
13680 #: ../src/guestfs-actions.pod:4622
13684 " guestfs_mkswap (guestfs_h *g,\n"
13685 " const char *device);\n"
13690 #: ../src/guestfs-actions.pod:4626 ../fish/guestfish-actions.pod:3130
13691 msgid "Create a swap partition on C<device>."
13695 #: ../src/guestfs-actions.pod:4632
13696 msgid "guestfs_mkswap_L"
13700 #: ../src/guestfs-actions.pod:4634
13704 " guestfs_mkswap_L (guestfs_h *g,\n"
13705 " const char *label,\n"
13706 " const char *device);\n"
13711 #: ../src/guestfs-actions.pod:4639 ../fish/guestfish-actions.pod:3136
13712 msgid "Create a swap partition on C<device> with label C<label>."
13716 #: ../src/guestfs-actions.pod:4641 ../fish/guestfish-actions.pod:3138
13718 "Note that you cannot attach a swap label to a block device (eg. C</dev/"
13719 "sda>), just to a partition. This appears to be a limitation of the kernel "
13724 #: ../src/guestfs-actions.pod:4649
13725 msgid "guestfs_mkswap_U"
13729 #: ../src/guestfs-actions.pod:4651
13733 " guestfs_mkswap_U (guestfs_h *g,\n"
13734 " const char *uuid,\n"
13735 " const char *device);\n"
13740 #: ../src/guestfs-actions.pod:4656 ../fish/guestfish-actions.pod:3146
13741 msgid "Create a swap partition on C<device> with UUID C<uuid>."
13745 #: ../src/guestfs-actions.pod:4662
13746 msgid "guestfs_mkswap_file"
13750 #: ../src/guestfs-actions.pod:4664
13754 " guestfs_mkswap_file (guestfs_h *g,\n"
13755 " const char *path);\n"
13760 #: ../src/guestfs-actions.pod:4668 ../fish/guestfish-actions.pod:3152
13761 msgid "Create a swap file."
13765 #: ../src/guestfs-actions.pod:4670
13767 "This command just writes a swap file signature to an existing file. To "
13768 "create the file itself, use something like C<guestfs_fallocate>."
13772 #: ../src/guestfs-actions.pod:4677
13773 msgid "guestfs_modprobe"
13777 #: ../src/guestfs-actions.pod:4679
13781 " guestfs_modprobe (guestfs_h *g,\n"
13782 " const char *modulename);\n"
13787 #: ../src/guestfs-actions.pod:4683 ../fish/guestfish-actions.pod:3161
13788 msgid "This loads a kernel module in the appliance."
13792 #: ../src/guestfs-actions.pod:4685 ../fish/guestfish-actions.pod:3163
13794 "The kernel module must have been whitelisted when libguestfs was built (see "
13795 "C<appliance/kmod.whitelist.in> in the source)."
13799 #: ../src/guestfs-actions.pod:4692
13800 msgid "guestfs_mount"
13804 #: ../src/guestfs-actions.pod:4694
13808 " guestfs_mount (guestfs_h *g,\n"
13809 " const char *device,\n"
13810 " const char *mountpoint);\n"
13815 #: ../src/guestfs-actions.pod:4699 ../fish/guestfish-actions.pod:3170
13817 "Mount a guest disk at a position in the filesystem. Block devices are named "
13818 "C</dev/sda>, C</dev/sdb> and so on, as they were added to the guest. If "
13819 "those block devices contain partitions, they will have the usual names (eg. "
13820 "C</dev/sda1>). Also LVM C</dev/VG/LV>-style names can be used."
13824 #: ../src/guestfs-actions.pod:4705 ../fish/guestfish-actions.pod:3176
13826 "The rules are the same as for L<mount(2)>: A filesystem must first be "
13827 "mounted on C</> before others can be mounted. Other filesystems can only be "
13828 "mounted on directories which already exist."
13832 #: ../src/guestfs-actions.pod:4710 ../fish/guestfish-actions.pod:3181
13834 "The mounted filesystem is writable, if we have sufficient permissions on the "
13835 "underlying device."
13839 #: ../src/guestfs-actions.pod:4713
13841 "B<Important note:> When you use this call, the filesystem options C<sync> "
13842 "and C<noatime> are set implicitly. This was originally done because we "
13843 "thought it would improve reliability, but it turns out that I<-o sync> has a "
13844 "very large negative performance impact and negligible effect on "
13845 "reliability. Therefore we recommend that you avoid using C<guestfs_mount> "
13846 "in any code that needs performance, and instead use C<guestfs_mount_options> "
13847 "(use an empty string for the first parameter if you don't want any options)."
13851 #: ../src/guestfs-actions.pod:4727
13852 msgid "guestfs_mount_loop"
13856 #: ../src/guestfs-actions.pod:4729
13860 " guestfs_mount_loop (guestfs_h *g,\n"
13861 " const char *file,\n"
13862 " const char *mountpoint);\n"
13867 #: ../src/guestfs-actions.pod:4734 ../fish/guestfish-actions.pod:3198
13869 "This command lets you mount C<file> (a filesystem image in a file) on a "
13870 "mount point. It is entirely equivalent to the command C<mount -o loop file "
13875 #: ../src/guestfs-actions.pod:4742
13876 msgid "guestfs_mount_options"
13880 #: ../src/guestfs-actions.pod:4744
13884 " guestfs_mount_options (guestfs_h *g,\n"
13885 " const char *options,\n"
13886 " const char *device,\n"
13887 " const char *mountpoint);\n"
13892 #: ../src/guestfs-actions.pod:4750
13894 "This is the same as the C<guestfs_mount> command, but it allows you to set "
13895 "the mount options as for the L<mount(8)> I<-o> flag."
13899 #: ../src/guestfs-actions.pod:4754 ../fish/guestfish-actions.pod:3210
13901 "If the C<options> parameter is an empty string, then no options are passed "
13902 "(all options default to whatever the filesystem uses)."
13906 #: ../src/guestfs-actions.pod:4760 ../src/guestfs-actions.pod:4774
13907 #: ../src/guestfs-actions.pod:4791
13908 msgid "(Added in 1.0.10)"
13912 #: ../src/guestfs-actions.pod:4762
13913 msgid "guestfs_mount_ro"
13917 #: ../src/guestfs-actions.pod:4764
13921 " guestfs_mount_ro (guestfs_h *g,\n"
13922 " const char *device,\n"
13923 " const char *mountpoint);\n"
13928 #: ../src/guestfs-actions.pod:4769
13930 "This is the same as the C<guestfs_mount> command, but it mounts the "
13931 "filesystem with the read-only (I<-o ro>) flag."
13935 #: ../src/guestfs-actions.pod:4776
13936 msgid "guestfs_mount_vfs"
13940 #: ../src/guestfs-actions.pod:4778
13944 " guestfs_mount_vfs (guestfs_h *g,\n"
13945 " const char *options,\n"
13946 " const char *vfstype,\n"
13947 " const char *device,\n"
13948 " const char *mountpoint);\n"
13953 #: ../src/guestfs-actions.pod:4785
13955 "This is the same as the C<guestfs_mount> command, but it allows you to set "
13956 "both the mount options and the vfstype as for the L<mount(8)> I<-o> and I<-"
13961 #: ../src/guestfs-actions.pod:4793
13962 msgid "guestfs_mountpoints"
13966 #: ../src/guestfs-actions.pod:4795
13970 " guestfs_mountpoints (guestfs_h *g);\n"
13975 #: ../src/guestfs-actions.pod:4798
13977 "This call is similar to C<guestfs_mounts>. That call returns a list of "
13978 "devices. This one returns a hash table (map) of device name to directory "
13979 "where the device is mounted."
13983 #: ../src/guestfs-actions.pod:4810
13984 msgid "guestfs_mounts"
13988 #: ../src/guestfs-actions.pod:4812
13992 " guestfs_mounts (guestfs_h *g);\n"
13997 #: ../src/guestfs-actions.pod:4815 ../fish/guestfish-actions.pod:3241
13999 "This returns the list of currently mounted filesystems. It returns the list "
14000 "of devices (eg. C</dev/sda1>, C</dev/VG/LV>)."
14004 #: ../src/guestfs-actions.pod:4818 ../fish/guestfish-actions.pod:3244
14005 msgid "Some internal mounts are not shown."
14009 #: ../src/guestfs-actions.pod:4820
14010 msgid "See also: C<guestfs_mountpoints>"
14014 #: ../src/guestfs-actions.pod:4828
14019 #: ../src/guestfs-actions.pod:4830
14023 " guestfs_mv (guestfs_h *g,\n"
14024 " const char *src,\n"
14025 " const char *dest);\n"
14030 #: ../src/guestfs-actions.pod:4835 ../fish/guestfish-actions.pod:3252
14032 "This moves a file from C<src> to C<dest> where C<dest> is either a "
14033 "destination filename or destination directory."
14037 #: ../src/guestfs-actions.pod:4842
14038 msgid "guestfs_ntfs_3g_probe"
14042 #: ../src/guestfs-actions.pod:4844
14046 " guestfs_ntfs_3g_probe (guestfs_h *g,\n"
14048 " const char *device);\n"
14053 #: ../src/guestfs-actions.pod:4849 ../fish/guestfish-actions.pod:3259
14055 "This command runs the L<ntfs-3g.probe(8)> command which probes an NTFS "
14056 "C<device> for mountability. (Not all NTFS volumes can be mounted read-"
14057 "write, and some cannot be mounted at all)."
14061 #: ../src/guestfs-actions.pod:4853 ../fish/guestfish-actions.pod:3263
14063 "C<rw> is a boolean flag. Set it to true if you want to test if the volume "
14064 "can be mounted read-write. Set it to false if you want to test if the "
14065 "volume can be mounted read-only."
14069 #: ../src/guestfs-actions.pod:4857 ../fish/guestfish-actions.pod:3267
14071 "The return value is an integer which C<0> if the operation would succeed, or "
14072 "some non-zero value documented in the L<ntfs-3g.probe(8)> manual page."
14076 #: ../src/guestfs-actions.pod:4863
14077 msgid "(Added in 1.0.43)"
14081 #: ../src/guestfs-actions.pod:4865
14082 msgid "guestfs_ntfsresize"
14086 #: ../src/guestfs-actions.pod:4867
14090 " guestfs_ntfsresize (guestfs_h *g,\n"
14091 " const char *device);\n"
14096 #: ../src/guestfs-actions.pod:4871 ../fish/guestfish-actions.pod:3275
14098 "This command resizes an NTFS filesystem, expanding or shrinking it to the "
14099 "size of the underlying device. See also L<ntfsresize(8)>."
14103 #: ../src/guestfs-actions.pod:4879
14104 msgid "guestfs_ntfsresize_size"
14108 #: ../src/guestfs-actions.pod:4881
14112 " guestfs_ntfsresize_size (guestfs_h *g,\n"
14113 " const char *device,\n"
14114 " int64_t size);\n"
14119 #: ../src/guestfs-actions.pod:4886
14121 "This command is the same as C<guestfs_ntfsresize> except that it allows you "
14122 "to specify the new size (in bytes) explicitly."
14126 #: ../src/guestfs-actions.pod:4891 ../src/guestfs-actions.pod:5327
14127 #: ../src/guestfs-actions.pod:5400 ../src/guestfs-actions.pod:5666
14128 #: ../src/guestfs-actions.pod:7237
14129 msgid "(Added in 1.3.14)"
14133 #: ../src/guestfs-actions.pod:4893
14134 msgid "guestfs_part_add"
14138 #: ../src/guestfs-actions.pod:4895
14142 " guestfs_part_add (guestfs_h *g,\n"
14143 " const char *device,\n"
14144 " const char *prlogex,\n"
14145 " int64_t startsect,\n"
14146 " int64_t endsect);\n"
14151 #: ../src/guestfs-actions.pod:4902
14153 "This command adds a partition to C<device>. If there is no partition table "
14154 "on the device, call C<guestfs_part_init> first."
14158 #: ../src/guestfs-actions.pod:4905 ../fish/guestfish-actions.pod:3293
14160 "The C<prlogex> parameter is the type of partition. Normally you should pass "
14161 "C<p> or C<primary> here, but MBR partition tables also support C<l> (or "
14162 "C<logical>) and C<e> (or C<extended>) partition types."
14166 #: ../src/guestfs-actions.pod:4910 ../fish/guestfish-actions.pod:3298
14168 "C<startsect> and C<endsect> are the start and end of the partition in "
14169 "I<sectors>. C<endsect> may be negative, which means it counts backwards "
14170 "from the end of the disk (C<-1> is the last sector)."
14174 #: ../src/guestfs-actions.pod:4914
14176 "Creating a partition which covers the whole disk is not so easy. Use "
14177 "C<guestfs_part_disk> to do that."
14181 #: ../src/guestfs-actions.pod:4919 ../src/guestfs-actions.pod:4957
14182 #: ../src/guestfs-actions.pod:5010 ../src/guestfs-actions.pod:5088
14183 #: ../src/guestfs-actions.pod:5126 ../src/guestfs-actions.pod:5145
14184 #: ../src/guestfs-actions.pod:5185
14185 msgid "(Added in 1.0.78)"
14189 #: ../src/guestfs-actions.pod:4921
14190 msgid "guestfs_part_del"
14194 #: ../src/guestfs-actions.pod:4923
14198 " guestfs_part_del (guestfs_h *g,\n"
14199 " const char *device,\n"
14205 #: ../src/guestfs-actions.pod:4928 ../fish/guestfish-actions.pod:3309
14206 msgid "This command deletes the partition numbered C<partnum> on C<device>."
14210 #: ../src/guestfs-actions.pod:4930 ../fish/guestfish-actions.pod:3311
14212 "Note that in the case of MBR partitioning, deleting an extended partition "
14213 "also deletes any logical partitions it contains."
14217 #: ../src/guestfs-actions.pod:4938
14218 msgid "guestfs_part_disk"
14222 #: ../src/guestfs-actions.pod:4940
14226 " guestfs_part_disk (guestfs_h *g,\n"
14227 " const char *device,\n"
14228 " const char *parttype);\n"
14233 #: ../src/guestfs-actions.pod:4945
14235 "This command is simply a combination of C<guestfs_part_init> followed by "
14236 "C<guestfs_part_add> to create a single primary partition covering the whole "
14241 #: ../src/guestfs-actions.pod:4949
14243 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
14244 "possible values are described in C<guestfs_part_init>."
14248 #: ../src/guestfs-actions.pod:4959
14249 msgid "guestfs_part_get_bootable"
14253 #: ../src/guestfs-actions.pod:4961
14257 " guestfs_part_get_bootable (guestfs_h *g,\n"
14258 " const char *device,\n"
14264 #: ../src/guestfs-actions.pod:4966 ../fish/guestfish-actions.pod:3333
14266 "This command returns true if the partition C<partnum> on C<device> has the "
14267 "bootable flag set."
14271 #: ../src/guestfs-actions.pod:4969
14272 msgid "See also C<guestfs_part_set_bootable>."
14276 #: ../src/guestfs-actions.pod:4975
14277 msgid "guestfs_part_get_mbr_id"
14281 #: ../src/guestfs-actions.pod:4977
14285 " guestfs_part_get_mbr_id (guestfs_h *g,\n"
14286 " const char *device,\n"
14292 #: ../src/guestfs-actions.pod:4982 ../fish/guestfish-actions.pod:3342
14294 "Returns the MBR type byte (also known as the ID byte) from the numbered "
14295 "partition C<partnum>."
14299 #: ../src/guestfs-actions.pod:4985 ../src/guestfs-actions.pod:5161
14301 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
14302 "undefined results for other partition table types (see "
14303 "C<guestfs_part_get_parttype>)."
14307 #: ../src/guestfs-actions.pod:4993
14308 msgid "guestfs_part_get_parttype"
14312 #: ../src/guestfs-actions.pod:4995
14316 " guestfs_part_get_parttype (guestfs_h *g,\n"
14317 " const char *device);\n"
14322 #: ../src/guestfs-actions.pod:4999 ../fish/guestfish-actions.pod:3353
14324 "This command examines the partition table on C<device> and returns the "
14325 "partition table type (format) being used."
14329 #: ../src/guestfs-actions.pod:5002
14331 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
14332 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
14333 "possible, although unusual. See C<guestfs_part_init> for a full list."
14337 #: ../src/guestfs-actions.pod:5012
14338 msgid "guestfs_part_init"
14342 #: ../src/guestfs-actions.pod:5014
14346 " guestfs_part_init (guestfs_h *g,\n"
14347 " const char *device,\n"
14348 " const char *parttype);\n"
14353 #: ../src/guestfs-actions.pod:5019 ../fish/guestfish-actions.pod:3365
14355 "This creates an empty partition table on C<device> of one of the partition "
14356 "types listed below. Usually C<parttype> should be either C<msdos> or C<gpt> "
14357 "(for large disks)."
14361 #: ../src/guestfs-actions.pod:5023
14363 "Initially there are no partitions. Following this, you should call "
14364 "C<guestfs_part_add> for each partition required."
14368 #: ../src/guestfs-actions.pod:5026 ../fish/guestfish-actions.pod:3372
14369 msgid "Possible values for C<parttype> are:"
14373 #: ../src/guestfs-actions.pod:5030 ../fish/guestfish-actions.pod:3376
14374 msgid "B<efi> | B<gpt>"
14378 #: ../src/guestfs-actions.pod:5032 ../fish/guestfish-actions.pod:3378
14379 msgid "Intel EFI / GPT partition table."
14383 #: ../src/guestfs-actions.pod:5034 ../fish/guestfish-actions.pod:3380
14385 "This is recommended for >= 2 TB partitions that will be accessed from Linux "
14386 "and Intel-based Mac OS X. It also has limited backwards compatibility with "
14387 "the C<mbr> format."
14391 #: ../src/guestfs-actions.pod:5038 ../fish/guestfish-actions.pod:3384
14392 msgid "B<mbr> | B<msdos>"
14396 #: ../src/guestfs-actions.pod:5040 ../fish/guestfish-actions.pod:3386
14398 "The standard PC \"Master Boot Record\" (MBR) format used by MS-DOS and "
14399 "Windows. This partition type will B<only> work for device sizes up to 2 "
14400 "TB. For large disks we recommend using C<gpt>."
14404 #: ../src/guestfs-actions.pod:5047 ../fish/guestfish-actions.pod:3393
14406 "Other partition table types that may work but are not supported include:"
14410 #: ../src/guestfs-actions.pod:5052 ../fish/guestfish-actions.pod:3398
14415 #: ../src/guestfs-actions.pod:5054 ../fish/guestfish-actions.pod:3400
14416 msgid "AIX disk labels."
14420 #: ../src/guestfs-actions.pod:5056 ../fish/guestfish-actions.pod:3402
14421 msgid "B<amiga> | B<rdb>"
14425 #: ../src/guestfs-actions.pod:5058 ../fish/guestfish-actions.pod:3404
14426 msgid "Amiga \"Rigid Disk Block\" format."
14430 #: ../src/guestfs-actions.pod:5060 ../fish/guestfish-actions.pod:3406
14435 #: ../src/guestfs-actions.pod:5062 ../fish/guestfish-actions.pod:3408
14436 msgid "BSD disk labels."
14440 #: ../src/guestfs-actions.pod:5064 ../fish/guestfish-actions.pod:3410
14445 #: ../src/guestfs-actions.pod:5066 ../fish/guestfish-actions.pod:3412
14446 msgid "DASD, used on IBM mainframes."
14450 #: ../src/guestfs-actions.pod:5068 ../fish/guestfish-actions.pod:3414
14455 #: ../src/guestfs-actions.pod:5070 ../fish/guestfish-actions.pod:3416
14456 msgid "MIPS/SGI volumes."
14460 #: ../src/guestfs-actions.pod:5072 ../fish/guestfish-actions.pod:3418
14465 #: ../src/guestfs-actions.pod:5074 ../fish/guestfish-actions.pod:3420
14466 msgid "Old Mac partition format. Modern Macs use C<gpt>."
14470 #: ../src/guestfs-actions.pod:5076 ../fish/guestfish-actions.pod:3422
14475 #: ../src/guestfs-actions.pod:5078 ../fish/guestfish-actions.pod:3424
14476 msgid "NEC PC-98 format, common in Japan apparently."
14480 #: ../src/guestfs-actions.pod:5080 ../fish/guestfish-actions.pod:3426
14485 #: ../src/guestfs-actions.pod:5082 ../fish/guestfish-actions.pod:3428
14486 msgid "Sun disk labels."
14490 #: ../src/guestfs-actions.pod:5090
14491 msgid "guestfs_part_list"
14495 #: ../src/guestfs-actions.pod:5092
14498 " struct guestfs_partition_list *\n"
14499 " guestfs_part_list (guestfs_h *g,\n"
14500 " const char *device);\n"
14505 #: ../src/guestfs-actions.pod:5096 ../fish/guestfish-actions.pod:3436
14507 "This command parses the partition table on C<device> and returns the list of "
14508 "partitions found."
14512 #: ../src/guestfs-actions.pod:5099 ../fish/guestfish-actions.pod:3439
14513 msgid "The fields in the returned structure are:"
14517 #: ../src/guestfs-actions.pod:5103 ../fish/guestfish-actions.pod:3443
14518 msgid "B<part_num>"
14522 #: ../src/guestfs-actions.pod:5105 ../fish/guestfish-actions.pod:3445
14523 msgid "Partition number, counting from 1."
14527 #: ../src/guestfs-actions.pod:5107 ../fish/guestfish-actions.pod:3447
14528 msgid "B<part_start>"
14532 #: ../src/guestfs-actions.pod:5109
14534 "Start of the partition I<in bytes>. To get sectors you have to divide by "
14535 "the device's sector size, see C<guestfs_blockdev_getss>."
14539 #: ../src/guestfs-actions.pod:5112 ../fish/guestfish-actions.pod:3452
14540 msgid "B<part_end>"
14544 #: ../src/guestfs-actions.pod:5114 ../fish/guestfish-actions.pod:3454
14545 msgid "End of the partition in bytes."
14549 #: ../src/guestfs-actions.pod:5116 ../fish/guestfish-actions.pod:3456
14550 msgid "B<part_size>"
14554 #: ../src/guestfs-actions.pod:5118 ../fish/guestfish-actions.pod:3458
14555 msgid "Size of the partition in bytes."
14559 #: ../src/guestfs-actions.pod:5122
14561 "This function returns a C<struct guestfs_partition_list *>, or NULL if there "
14562 "was an error. I<The caller must call C<guestfs_free_partition_list> after "
14567 #: ../src/guestfs-actions.pod:5128
14568 msgid "guestfs_part_set_bootable"
14572 #: ../src/guestfs-actions.pod:5130
14576 " guestfs_part_set_bootable (guestfs_h *g,\n"
14577 " const char *device,\n"
14579 " int bootable);\n"
14584 #: ../src/guestfs-actions.pod:5136 ../fish/guestfish-actions.pod:3466
14586 "This sets the bootable flag on partition numbered C<partnum> on device "
14587 "C<device>. Note that partitions are numbered from 1."
14591 #: ../src/guestfs-actions.pod:5139 ../fish/guestfish-actions.pod:3469
14593 "The bootable flag is used by some operating systems (notably Windows) to "
14594 "determine which partition to boot from. It is by no means universally "
14599 #: ../src/guestfs-actions.pod:5147
14600 msgid "guestfs_part_set_mbr_id"
14604 #: ../src/guestfs-actions.pod:5149
14608 " guestfs_part_set_mbr_id (guestfs_h *g,\n"
14609 " const char *device,\n"
14616 #: ../src/guestfs-actions.pod:5155 ../fish/guestfish-actions.pod:3477
14618 "Sets the MBR type byte (also known as the ID byte) of the numbered partition "
14619 "C<partnum> to C<idbyte>. Note that the type bytes quoted in most "
14620 "documentation are in fact hexadecimal numbers, but usually documented "
14621 "without any leading \"0x\" which might be confusing."
14625 #: ../src/guestfs-actions.pod:5169
14626 msgid "guestfs_part_set_name"
14630 #: ../src/guestfs-actions.pod:5171
14634 " guestfs_part_set_name (guestfs_h *g,\n"
14635 " const char *device,\n"
14637 " const char *name);\n"
14642 #: ../src/guestfs-actions.pod:5177 ../fish/guestfish-actions.pod:3491
14644 "This sets the partition name on partition numbered C<partnum> on device "
14645 "C<device>. Note that partitions are numbered from 1."
14649 #: ../src/guestfs-actions.pod:5180 ../fish/guestfish-actions.pod:3494
14651 "The partition name can only be set on certain types of partition table. "
14652 "This works on C<gpt> but not on C<mbr> partitions."
14656 #: ../src/guestfs-actions.pod:5187
14657 msgid "guestfs_part_to_dev"
14661 #: ../src/guestfs-actions.pod:5189
14665 " guestfs_part_to_dev (guestfs_h *g,\n"
14666 " const char *partition);\n"
14671 #: ../src/guestfs-actions.pod:5193 ../fish/guestfish-actions.pod:3501
14673 "This function takes a partition name (eg. \"/dev/sdb1\") and removes the "
14674 "partition number, returning the device name (eg. \"/dev/sdb\")."
14678 #: ../src/guestfs-actions.pod:5197
14680 "The named partition must exist, for example as a string returned from "
14681 "C<guestfs_list_partitions>."
14685 #: ../src/guestfs-actions.pod:5205
14686 msgid "guestfs_ping_daemon"
14690 #: ../src/guestfs-actions.pod:5207
14694 " guestfs_ping_daemon (guestfs_h *g);\n"
14699 #: ../src/guestfs-actions.pod:5210 ../fish/guestfish-actions.pod:3512
14701 "This is a test probe into the guestfs daemon running inside the qemu "
14702 "subprocess. Calling this function checks that the daemon responds to the "
14703 "ping message, without affecting the daemon or attached block device(s) in "
14708 #: ../src/guestfs-actions.pod:5219
14709 msgid "guestfs_pread"
14713 #: ../src/guestfs-actions.pod:5221
14717 " guestfs_pread (guestfs_h *g,\n"
14718 " const char *path,\n"
14720 " int64_t offset,\n"
14721 " size_t *size_r);\n"
14726 #: ../src/guestfs-actions.pod:5228 ../fish/guestfish-actions.pod:3521
14728 "This command lets you read part of a file. It reads C<count> bytes of the "
14729 "file, starting at C<offset>, from file C<path>."
14733 #: ../src/guestfs-actions.pod:5231 ../src/guestfs-actions.pod:5257
14734 #: ../fish/guestfish-actions.pod:3524 ../fish/guestfish-actions.pod:3539
14736 "This may read fewer bytes than requested. For further details see the "
14737 "L<pread(2)> system call."
14741 #: ../src/guestfs-actions.pod:5234
14742 msgid "See also C<guestfs_pwrite>, C<guestfs_pread_device>."
14746 #: ../src/guestfs-actions.pod:5245
14747 msgid "guestfs_pread_device"
14751 #: ../src/guestfs-actions.pod:5247
14755 " guestfs_pread_device (guestfs_h *g,\n"
14756 " const char *device,\n"
14758 " int64_t offset,\n"
14759 " size_t *size_r);\n"
14764 #: ../src/guestfs-actions.pod:5254 ../fish/guestfish-actions.pod:3536
14766 "This command lets you read part of a file. It reads C<count> bytes of "
14767 "C<device>, starting at C<offset>."
14771 #: ../src/guestfs-actions.pod:5260
14772 msgid "See also C<guestfs_pread>."
14776 #: ../src/guestfs-actions.pod:5269
14777 msgid "(Added in 1.5.21)"
14781 #: ../src/guestfs-actions.pod:5271
14782 msgid "guestfs_pvcreate"
14786 #: ../src/guestfs-actions.pod:5273
14790 " guestfs_pvcreate (guestfs_h *g,\n"
14791 " const char *device);\n"
14796 #: ../src/guestfs-actions.pod:5277 ../fish/guestfish-actions.pod:3551
14798 "This creates an LVM physical volume on the named C<device>, where C<device> "
14799 "should usually be a partition name such as C</dev/sda1>."
14803 #: ../src/guestfs-actions.pod:5285
14804 msgid "guestfs_pvremove"
14808 #: ../src/guestfs-actions.pod:5287
14812 " guestfs_pvremove (guestfs_h *g,\n"
14813 " const char *device);\n"
14818 #: ../src/guestfs-actions.pod:5291 ../fish/guestfish-actions.pod:3559
14820 "This wipes a physical volume C<device> so that LVM will no longer recognise "
14825 #: ../src/guestfs-actions.pod:5294 ../fish/guestfish-actions.pod:3562
14827 "The implementation uses the C<pvremove> command which refuses to wipe "
14828 "physical volumes that contain any volume groups, so you have to remove those "
14833 #: ../src/guestfs-actions.pod:5302
14834 msgid "guestfs_pvresize"
14838 #: ../src/guestfs-actions.pod:5304
14842 " guestfs_pvresize (guestfs_h *g,\n"
14843 " const char *device);\n"
14848 #: ../src/guestfs-actions.pod:5308 ../fish/guestfish-actions.pod:3570
14850 "This resizes (expands or shrinks) an existing LVM physical volume to match "
14851 "the new size of the underlying device."
14855 #: ../src/guestfs-actions.pod:5315
14856 msgid "guestfs_pvresize_size"
14860 #: ../src/guestfs-actions.pod:5317
14864 " guestfs_pvresize_size (guestfs_h *g,\n"
14865 " const char *device,\n"
14866 " int64_t size);\n"
14871 #: ../src/guestfs-actions.pod:5322
14873 "This command is the same as C<guestfs_pvresize> except that it allows you to "
14874 "specify the new size (in bytes) explicitly."
14878 #: ../src/guestfs-actions.pod:5329
14879 msgid "guestfs_pvs"
14883 #: ../src/guestfs-actions.pod:5331
14887 " guestfs_pvs (guestfs_h *g);\n"
14892 #: ../src/guestfs-actions.pod:5334 ../fish/guestfish-actions.pod:3584
14894 "List all the physical volumes detected. This is the equivalent of the L<pvs"
14899 #: ../src/guestfs-actions.pod:5337 ../fish/guestfish-actions.pod:3587
14901 "This returns a list of just the device names that contain PVs (eg. C</dev/"
14906 #: ../src/guestfs-actions.pod:5340
14907 msgid "See also C<guestfs_pvs_full>."
14911 #: ../src/guestfs-actions.pod:5348
14912 msgid "guestfs_pvs_full"
14916 #: ../src/guestfs-actions.pod:5350
14919 " struct guestfs_lvm_pv_list *\n"
14920 " guestfs_pvs_full (guestfs_h *g);\n"
14925 #: ../src/guestfs-actions.pod:5353 ../fish/guestfish-actions.pod:3596
14927 "List all the physical volumes detected. This is the equivalent of the L<pvs"
14928 "(8)> command. The \"full\" version includes all fields."
14932 #: ../src/guestfs-actions.pod:5356
14934 "This function returns a C<struct guestfs_lvm_pv_list *>, or NULL if there "
14935 "was an error. I<The caller must call C<guestfs_free_lvm_pv_list> after use>."
14939 #: ../src/guestfs-actions.pod:5362
14940 msgid "guestfs_pvuuid"
14944 #: ../src/guestfs-actions.pod:5364
14948 " guestfs_pvuuid (guestfs_h *g,\n"
14949 " const char *device);\n"
14954 #: ../src/guestfs-actions.pod:5368 ../fish/guestfish-actions.pod:3603
14955 msgid "This command returns the UUID of the LVM PV C<device>."
14959 #: ../src/guestfs-actions.pod:5375
14960 msgid "guestfs_pwrite"
14964 #: ../src/guestfs-actions.pod:5377
14968 " guestfs_pwrite (guestfs_h *g,\n"
14969 " const char *path,\n"
14970 " const char *content,\n"
14971 " size_t content_size,\n"
14972 " int64_t offset);\n"
14977 #: ../src/guestfs-actions.pod:5384 ../fish/guestfish-actions.pod:3609
14979 "This command writes to part of a file. It writes the data buffer C<content> "
14980 "to the file C<path> starting at offset C<offset>."
14984 #: ../src/guestfs-actions.pod:5387 ../fish/guestfish-actions.pod:3612
14986 "This command implements the L<pwrite(2)> system call, and like that system "
14987 "call it may not write the full data requested. The return value is the "
14988 "number of bytes that were actually written to the file. This could even be "
14989 "0, although short writes are unlikely for regular files in ordinary "
14994 #: ../src/guestfs-actions.pod:5393
14995 msgid "See also C<guestfs_pread>, C<guestfs_pwrite_device>."
14999 #: ../src/guestfs-actions.pod:5402
15000 msgid "guestfs_pwrite_device"
15004 #: ../src/guestfs-actions.pod:5404
15008 " guestfs_pwrite_device (guestfs_h *g,\n"
15009 " const char *device,\n"
15010 " const char *content,\n"
15011 " size_t content_size,\n"
15012 " int64_t offset);\n"
15017 #: ../src/guestfs-actions.pod:5411 ../fish/guestfish-actions.pod:3627
15019 "This command writes to part of a device. It writes the data buffer "
15020 "C<content> to C<device> starting at offset C<offset>."
15024 #: ../src/guestfs-actions.pod:5414 ../fish/guestfish-actions.pod:3630
15026 "This command implements the L<pwrite(2)> system call, and like that system "
15027 "call it may not write the full data requested (although short writes to disk "
15028 "devices and partitions are probably impossible with standard Linux kernels)."
15032 #: ../src/guestfs-actions.pod:5419
15033 msgid "See also C<guestfs_pwrite>."
15037 #: ../src/guestfs-actions.pod:5426
15038 msgid "(Added in 1.5.20)"
15042 #: ../src/guestfs-actions.pod:5428
15043 msgid "guestfs_read_file"
15047 #: ../src/guestfs-actions.pod:5430
15051 " guestfs_read_file (guestfs_h *g,\n"
15052 " const char *path,\n"
15053 " size_t *size_r);\n"
15058 #: ../src/guestfs-actions.pod:5435 ../fish/guestfish-actions.pod:3644
15059 msgid "This calls returns the contents of the file C<path> as a buffer."
15063 #: ../src/guestfs-actions.pod:5438
15065 "Unlike C<guestfs_cat>, this function can correctly handle files that contain "
15066 "embedded ASCII NUL characters. However unlike C<guestfs_download>, this "
15067 "function is limited in the total size of file that can be handled."
15071 #: ../src/guestfs-actions.pod:5450
15072 msgid "(Added in 1.0.63)"
15076 #: ../src/guestfs-actions.pod:5452
15077 msgid "guestfs_read_lines"
15081 #: ../src/guestfs-actions.pod:5454
15085 " guestfs_read_lines (guestfs_h *g,\n"
15086 " const char *path);\n"
15091 #: ../src/guestfs-actions.pod:5460 ../fish/guestfish-actions.pod:3661
15093 "The file contents are returned as a list of lines. Trailing C<LF> and "
15094 "C<CRLF> character sequences are I<not> returned."
15098 #: ../src/guestfs-actions.pod:5463
15100 "Note that this function cannot correctly handle binary files (specifically, "
15101 "files containing C<\\0> character which is treated as end of line). For "
15102 "those you need to use the C<guestfs_read_file> function which has a more "
15103 "complex interface."
15107 #: ../src/guestfs-actions.pod:5474
15108 msgid "guestfs_readdir"
15112 #: ../src/guestfs-actions.pod:5476
15115 " struct guestfs_dirent_list *\n"
15116 " guestfs_readdir (guestfs_h *g,\n"
15117 " const char *dir);\n"
15122 #: ../src/guestfs-actions.pod:5480 ../fish/guestfish-actions.pod:3673
15123 msgid "This returns the list of directory entries in directory C<dir>."
15127 #: ../src/guestfs-actions.pod:5482 ../fish/guestfish-actions.pod:3675
15129 "All entries in the directory are returned, including C<.> and C<..>. The "
15130 "entries are I<not> sorted, but returned in the same order as the underlying "
15135 #: ../src/guestfs-actions.pod:5486 ../fish/guestfish-actions.pod:3679
15137 "Also this call returns basic file type information about each file. The "
15138 "C<ftyp> field will contain one of the following characters:"
15142 #: ../src/guestfs-actions.pod:5491 ../fish/guestfish-actions.pod:3684
15147 #: ../src/guestfs-actions.pod:5493 ../fish/guestfish-actions.pod:3686
15148 msgid "Block special"
15152 #: ../src/guestfs-actions.pod:5495 ../fish/guestfish-actions.pod:3688
15157 #: ../src/guestfs-actions.pod:5497 ../fish/guestfish-actions.pod:3690
15158 msgid "Char special"
15162 #: ../src/guestfs-actions.pod:5499 ../fish/guestfish-actions.pod:3692
15167 #: ../src/guestfs-actions.pod:5501 ../fish/guestfish-actions.pod:3694
15172 #: ../src/guestfs-actions.pod:5503 ../fish/guestfish-actions.pod:3696
15177 #: ../src/guestfs-actions.pod:5505 ../fish/guestfish-actions.pod:3698
15178 msgid "FIFO (named pipe)"
15182 #: ../src/guestfs-actions.pod:5507 ../fish/guestfish-actions.pod:3700
15187 #: ../src/guestfs-actions.pod:5509 ../fish/guestfish-actions.pod:3702
15188 msgid "Symbolic link"
15192 #: ../src/guestfs-actions.pod:5511 ../fish/guestfish-actions.pod:3704
15197 #: ../src/guestfs-actions.pod:5513 ../fish/guestfish-actions.pod:3706
15198 msgid "Regular file"
15202 #: ../src/guestfs-actions.pod:5515 ../fish/guestfish-actions.pod:3708
15207 #: ../src/guestfs-actions.pod:5517 ../fish/guestfish-actions.pod:3710
15212 #: ../src/guestfs-actions.pod:5519 ../fish/guestfish-actions.pod:3712
15217 #: ../src/guestfs-actions.pod:5521 ../fish/guestfish-actions.pod:3714
15218 msgid "Unknown file type"
15222 #: ../src/guestfs-actions.pod:5523 ../fish/guestfish-actions.pod:3716
15227 #: ../src/guestfs-actions.pod:5525 ../fish/guestfish-actions.pod:3718
15229 "The L<readdir(3)> call returned a C<d_type> field with an unexpected value"
15233 #: ../src/guestfs-actions.pod:5530
15235 "This function is primarily intended for use by programs. To get a simple "
15236 "list of names, use C<guestfs_ls>. To get a printable directory for human "
15237 "consumption, use C<guestfs_ll>."
15241 #: ../src/guestfs-actions.pod:5534
15243 "This function returns a C<struct guestfs_dirent_list *>, or NULL if there "
15244 "was an error. I<The caller must call C<guestfs_free_dirent_list> after use>."
15248 #: ../src/guestfs-actions.pod:5540
15249 msgid "guestfs_readlink"
15253 #: ../src/guestfs-actions.pod:5542
15257 " guestfs_readlink (guestfs_h *g,\n"
15258 " const char *path);\n"
15263 #: ../src/guestfs-actions.pod:5546 ../fish/guestfish-actions.pod:3731
15264 msgid "This command reads the target of a symbolic link."
15268 #: ../src/guestfs-actions.pod:5553
15269 msgid "guestfs_readlinklist"
15273 #: ../src/guestfs-actions.pod:5555
15277 " guestfs_readlinklist (guestfs_h *g,\n"
15278 " const char *path,\n"
15279 " char *const *names);\n"
15284 #: ../src/guestfs-actions.pod:5560 ../fish/guestfish-actions.pod:3737
15286 "This call allows you to do a C<readlink> operation on multiple files, where "
15287 "all files are in the directory C<path>. C<names> is the list of files from "
15292 #: ../src/guestfs-actions.pod:5564 ../fish/guestfish-actions.pod:3741
15294 "On return you get a list of strings, with a one-to-one correspondence to the "
15295 "C<names> list. Each string is the value of the symbolic link."
15299 #: ../src/guestfs-actions.pod:5568 ../fish/guestfish-actions.pod:3745
15301 "If the C<readlink(2)> operation fails on any name, then the corresponding "
15302 "result string is the empty string C<\"\">. However the whole operation is "
15303 "completed even if there were C<readlink(2)> errors, and so you can call this "
15304 "function with names where you don't know if they are symbolic links already "
15305 "(albeit slightly less efficient)."
15309 #: ../src/guestfs-actions.pod:5575 ../fish/guestfish-actions.pod:3752
15311 "This call is intended for programs that want to efficiently list a directory "
15312 "contents without making many round-trips. Very long directory listings "
15313 "might cause the protocol message size to be exceeded, causing this call to "
15314 "fail. The caller must split up such requests into smaller groups of names."
15318 #: ../src/guestfs-actions.pod:5588
15319 msgid "guestfs_realpath"
15323 #: ../src/guestfs-actions.pod:5590
15327 " guestfs_realpath (guestfs_h *g,\n"
15328 " const char *path);\n"
15333 #: ../src/guestfs-actions.pod:5594 ../fish/guestfish-actions.pod:3763
15335 "Return the canonicalized absolute pathname of C<path>. The returned path "
15336 "has no C<.>, C<..> or symbolic link path elements."
15340 #: ../src/guestfs-actions.pod:5602
15341 msgid "guestfs_removexattr"
15345 #: ../src/guestfs-actions.pod:5604
15349 " guestfs_removexattr (guestfs_h *g,\n"
15350 " const char *xattr,\n"
15351 " const char *path);\n"
15356 #: ../src/guestfs-actions.pod:5609 ../fish/guestfish-actions.pod:3770
15358 "This call removes the extended attribute named C<xattr> of the file C<path>."
15362 #: ../src/guestfs-actions.pod:5612
15363 msgid "See also: C<guestfs_lremovexattr>, L<attr(5)>."
15367 #: ../src/guestfs-actions.pod:5618
15368 msgid "guestfs_resize2fs"
15372 #: ../src/guestfs-actions.pod:5620
15376 " guestfs_resize2fs (guestfs_h *g,\n"
15377 " const char *device);\n"
15382 #: ../src/guestfs-actions.pod:5624 ../fish/guestfish-actions.pod:3779
15384 "This resizes an ext2, ext3 or ext4 filesystem to match the size of the "
15385 "underlying device."
15389 #: ../src/guestfs-actions.pod:5627
15391 "I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f> on the "
15392 "C<device> before calling this command. For unknown reasons C<resize2fs> "
15393 "sometimes gives an error about this and sometimes not. In any case, it is "
15394 "always safe to call C<guestfs_e2fsck_f> before calling this function."
15398 #: ../src/guestfs-actions.pod:5637
15399 msgid "guestfs_resize2fs_M"
15403 #: ../src/guestfs-actions.pod:5639
15407 " guestfs_resize2fs_M (guestfs_h *g,\n"
15408 " const char *device);\n"
15413 #: ../src/guestfs-actions.pod:5643
15415 "This command is the same as C<guestfs_resize2fs>, but the filesystem is "
15416 "resized to its minimum size. This works like the C<-M> option to the "
15417 "C<resize2fs> command."
15421 #: ../src/guestfs-actions.pod:5647
15423 "To get the resulting size of the filesystem you should call "
15424 "C<guestfs_tune2fs_l> and read the C<Block size> and C<Block count> values. "
15425 "These two numbers, multiplied together, give the resulting size of the "
15426 "minimal filesystem in bytes."
15430 #: ../src/guestfs-actions.pod:5654
15431 msgid "guestfs_resize2fs_size"
15435 #: ../src/guestfs-actions.pod:5656
15439 " guestfs_resize2fs_size (guestfs_h *g,\n"
15440 " const char *device,\n"
15441 " int64_t size);\n"
15446 #: ../src/guestfs-actions.pod:5661
15448 "This command is the same as C<guestfs_resize2fs> except that it allows you "
15449 "to specify the new size (in bytes) explicitly."
15453 #: ../src/guestfs-actions.pod:5668
15458 #: ../src/guestfs-actions.pod:5670
15462 " guestfs_rm (guestfs_h *g,\n"
15463 " const char *path);\n"
15468 #: ../src/guestfs-actions.pod:5674 ../fish/guestfish-actions.pod:3812
15469 msgid "Remove the single file C<path>."
15473 #: ../src/guestfs-actions.pod:5680
15474 msgid "guestfs_rm_rf"
15478 #: ../src/guestfs-actions.pod:5682
15482 " guestfs_rm_rf (guestfs_h *g,\n"
15483 " const char *path);\n"
15488 #: ../src/guestfs-actions.pod:5686 ../fish/guestfish-actions.pod:3818
15490 "Remove the file or directory C<path>, recursively removing the contents if "
15491 "its a directory. This is like the C<rm -rf> shell command."
15495 #: ../src/guestfs-actions.pod:5694
15496 msgid "guestfs_rmdir"
15500 #: ../src/guestfs-actions.pod:5696
15504 " guestfs_rmdir (guestfs_h *g,\n"
15505 " const char *path);\n"
15510 #: ../src/guestfs-actions.pod:5700 ../fish/guestfish-actions.pod:3826
15511 msgid "Remove the single directory C<path>."
15515 #: ../src/guestfs-actions.pod:5706
15516 msgid "guestfs_rmmountpoint"
15520 #: ../src/guestfs-actions.pod:5708
15524 " guestfs_rmmountpoint (guestfs_h *g,\n"
15525 " const char *exemptpath);\n"
15530 #: ../src/guestfs-actions.pod:5712
15532 "This calls removes a mountpoint that was previously created with "
15533 "C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint> for full details."
15537 #: ../src/guestfs-actions.pod:5720
15538 msgid "guestfs_scrub_device"
15542 #: ../src/guestfs-actions.pod:5722
15546 " guestfs_scrub_device (guestfs_h *g,\n"
15547 " const char *device);\n"
15552 #: ../src/guestfs-actions.pod:5726 ../fish/guestfish-actions.pod:3840
15554 "This command writes patterns over C<device> to make data retrieval more "
15559 #: ../src/guestfs-actions.pod:5729 ../src/guestfs-actions.pod:5750
15560 #: ../src/guestfs-actions.pod:5769 ../fish/guestfish-actions.pod:3843
15561 #: ../fish/guestfish-actions.pod:3858 ../fish/guestfish-actions.pod:3871
15563 "It is an interface to the L<scrub(1)> program. See that manual page for "
15568 #: ../src/guestfs-actions.pod:5737 ../src/guestfs-actions.pod:5755
15569 #: ../src/guestfs-actions.pod:5774
15570 msgid "(Added in 1.0.52)"
15574 #: ../src/guestfs-actions.pod:5739
15575 msgid "guestfs_scrub_file"
15579 #: ../src/guestfs-actions.pod:5741
15583 " guestfs_scrub_file (guestfs_h *g,\n"
15584 " const char *file);\n"
15589 #: ../src/guestfs-actions.pod:5745 ../fish/guestfish-actions.pod:3853
15591 "This command writes patterns over a file to make data retrieval more "
15596 #: ../src/guestfs-actions.pod:5748 ../fish/guestfish-actions.pod:3856
15597 msgid "The file is I<removed> after scrubbing."
15601 #: ../src/guestfs-actions.pod:5757
15602 msgid "guestfs_scrub_freespace"
15606 #: ../src/guestfs-actions.pod:5759
15610 " guestfs_scrub_freespace (guestfs_h *g,\n"
15611 " const char *dir);\n"
15616 #: ../src/guestfs-actions.pod:5763
15618 "This command creates the directory C<dir> and then fills it with files until "
15619 "the filesystem is full, and scrubs the files as for C<guestfs_scrub_file>, "
15620 "and deletes them. The intention is to scrub any free space on the partition "
15621 "containing C<dir>."
15625 #: ../src/guestfs-actions.pod:5776
15626 msgid "guestfs_set_append"
15630 #: ../src/guestfs-actions.pod:5778
15634 " guestfs_set_append (guestfs_h *g,\n"
15635 " const char *append);\n"
15640 #: ../src/guestfs-actions.pod:5782 ../fish/guestfish-actions.pod:3880
15642 "This function is used to add additional options to the guest kernel command "
15647 #: ../src/guestfs-actions.pod:5785 ../fish/guestfish-actions.pod:3883
15649 "The default is C<NULL> unless overridden by setting C<LIBGUESTFS_APPEND> "
15650 "environment variable."
15654 #: ../src/guestfs-actions.pod:5788 ../fish/guestfish-actions.pod:3886
15656 "Setting C<append> to C<NULL> means I<no> additional options are passed "
15657 "(libguestfs always adds a few of its own)."
15661 #: ../src/guestfs-actions.pod:5795
15662 msgid "guestfs_set_attach_method"
15666 #: ../src/guestfs-actions.pod:5797
15670 " guestfs_set_attach_method (guestfs_h *g,\n"
15671 " const char *attachmethod);\n"
15676 #: ../src/guestfs-actions.pod:5801 ../fish/guestfish-actions.pod:3895
15678 "Set the method that libguestfs uses to connect to the back end guestfsd "
15679 "daemon. Possible methods are:"
15683 #: ../src/guestfs-actions.pod:5808 ../fish/guestfish-actions.pod:3902
15685 "Launch an appliance and connect to it. This is the ordinary method and the "
15690 #: ../src/guestfs-actions.pod:5811 ../fish/guestfish-actions.pod:3905
15691 msgid "C<unix:I<path>>"
15695 #: ../src/guestfs-actions.pod:5813 ../fish/guestfish-actions.pod:3907
15696 msgid "Connect to the Unix domain socket I<path>."
15700 #: ../src/guestfs-actions.pod:5815 ../fish/guestfish-actions.pod:3909
15702 "This method lets you connect to an existing daemon or (using virtio-serial) "
15703 "to a live guest. For more information, see L<guestfs(3)/ATTACHING TO "
15704 "RUNNING DAEMONS>."
15708 #: ../src/guestfs-actions.pod:5823
15709 msgid "guestfs_set_autosync"
15713 #: ../src/guestfs-actions.pod:5825
15717 " guestfs_set_autosync (guestfs_h *g,\n"
15718 " int autosync);\n"
15723 #: ../src/guestfs-actions.pod:5829 ../fish/guestfish-actions.pod:3921
15725 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
15726 "effort attempt to make filesystems consistent and synchronized when the "
15727 "handle is closed (also if the program exits without closing handles)."
15731 #: ../src/guestfs-actions.pod:5834 ../fish/guestfish-actions.pod:3926
15733 "This is enabled by default (since libguestfs 1.5.24, previously it was "
15734 "disabled by default)."
15738 #: ../src/guestfs-actions.pod:5841
15739 msgid "guestfs_set_direct"
15743 #: ../src/guestfs-actions.pod:5843
15747 " guestfs_set_direct (guestfs_h *g,\n"
15753 #: ../src/guestfs-actions.pod:5847 ../fish/guestfish-actions.pod:3935
15755 "If the direct appliance mode flag is enabled, then stdin and stdout are "
15756 "passed directly through to the appliance once it is launched."
15760 #: ../src/guestfs-actions.pod:5851
15762 "One consequence of this is that log messages aren't caught by the library "
15763 "and handled by C<guestfs_set_log_message_callback>, but go straight to "
15768 #: ../src/guestfs-actions.pod:5855 ../fish/guestfish-actions.pod:3943
15769 msgid "You probably don't want to use this unless you know what you are doing."
15773 #: ../src/guestfs-actions.pod:5858 ../fish/guestfish-actions.pod:3946
15774 msgid "The default is disabled."
15778 #: ../src/guestfs-actions.pod:5864
15779 msgid "guestfs_set_e2label"
15783 #: ../src/guestfs-actions.pod:5866
15787 " guestfs_set_e2label (guestfs_h *g,\n"
15788 " const char *device,\n"
15789 " const char *label);\n"
15794 #: ../src/guestfs-actions.pod:5871 ../fish/guestfish-actions.pod:3952
15796 "This sets the ext2/3/4 filesystem label of the filesystem on C<device> to "
15797 "C<label>. Filesystem labels are limited to 16 characters."
15801 #: ../src/guestfs-actions.pod:5875
15803 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label> to return "
15804 "the existing label on a filesystem."
15808 #: ../src/guestfs-actions.pod:5882
15809 msgid "guestfs_set_e2uuid"
15813 #: ../src/guestfs-actions.pod:5884
15817 " guestfs_set_e2uuid (guestfs_h *g,\n"
15818 " const char *device,\n"
15819 " const char *uuid);\n"
15824 #: ../src/guestfs-actions.pod:5889 ../fish/guestfish-actions.pod:3963
15826 "This sets the ext2/3/4 filesystem UUID of the filesystem on C<device> to "
15827 "C<uuid>. The format of the UUID and alternatives such as C<clear>, "
15828 "C<random> and C<time> are described in the L<tune2fs(8)> manpage."
15832 #: ../src/guestfs-actions.pod:5894
15834 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid> to return "
15835 "the existing UUID of a filesystem."
15839 #: ../src/guestfs-actions.pod:5901
15840 msgid "guestfs_set_memsize"
15844 #: ../src/guestfs-actions.pod:5903
15848 " guestfs_set_memsize (guestfs_h *g,\n"
15854 #: ../src/guestfs-actions.pod:5907
15856 "This sets the memory size in megabytes allocated to the qemu subprocess. "
15857 "This only has any effect if called before C<guestfs_launch>."
15861 #: ../src/guestfs-actions.pod:5911 ../fish/guestfish-actions.pod:3981
15863 "You can also change this by setting the environment variable "
15864 "C<LIBGUESTFS_MEMSIZE> before the handle is created."
15868 #: ../src/guestfs-actions.pod:5922
15869 msgid "guestfs_set_network"
15873 #: ../src/guestfs-actions.pod:5924
15877 " guestfs_set_network (guestfs_h *g,\n"
15883 #: ../src/guestfs-actions.pod:5928 ../fish/guestfish-actions.pod:3994
15885 "If C<network> is true, then the network is enabled in the libguestfs "
15886 "appliance. The default is false."
15890 #: ../src/guestfs-actions.pod:5931 ../fish/guestfish-actions.pod:3997
15892 "This affects whether commands are able to access the network (see L<guestfs"
15893 "(3)/RUNNING COMMANDS>)."
15897 #: ../src/guestfs-actions.pod:5934
15899 "You must call this before calling C<guestfs_launch>, otherwise it has no "
15904 #: ../src/guestfs-actions.pod:5941
15905 msgid "guestfs_set_path"
15909 #: ../src/guestfs-actions.pod:5943
15913 " guestfs_set_path (guestfs_h *g,\n"
15914 " const char *searchpath);\n"
15919 #: ../src/guestfs-actions.pod:5947 ../fish/guestfish-actions.pod:4009
15920 msgid "Set the path that libguestfs searches for kernel and initrd.img."
15924 #: ../src/guestfs-actions.pod:5949 ../fish/guestfish-actions.pod:4011
15926 "The default is C<$libdir/guestfs> unless overridden by setting "
15927 "C<LIBGUESTFS_PATH> environment variable."
15931 #: ../src/guestfs-actions.pod:5952 ../fish/guestfish-actions.pod:4014
15932 msgid "Setting C<path> to C<NULL> restores the default path."
15936 #: ../src/guestfs-actions.pod:5958
15937 msgid "guestfs_set_qemu"
15941 #: ../src/guestfs-actions.pod:5960
15945 " guestfs_set_qemu (guestfs_h *g,\n"
15946 " const char *qemu);\n"
15951 #: ../src/guestfs-actions.pod:5964 ../fish/guestfish-actions.pod:4022
15952 msgid "Set the qemu binary that we will use."
15956 #: ../src/guestfs-actions.pod:5966 ../fish/guestfish-actions.pod:4024
15958 "The default is chosen when the library was compiled by the configure script."
15962 #: ../src/guestfs-actions.pod:5969 ../fish/guestfish-actions.pod:4027
15964 "You can also override this by setting the C<LIBGUESTFS_QEMU> environment "
15969 #: ../src/guestfs-actions.pod:5972 ../fish/guestfish-actions.pod:4030
15970 msgid "Setting C<qemu> to C<NULL> restores the default qemu binary."
15974 #: ../src/guestfs-actions.pod:5974 ../fish/guestfish-actions.pod:4032
15976 "Note that you should call this function as early as possible after creating "
15977 "the handle. This is because some pre-launch operations depend on testing "
15978 "qemu features (by running C<qemu -help>). If the qemu binary changes, we "
15979 "don't retest features, and so you might see inconsistent results. Using the "
15980 "environment variable C<LIBGUESTFS_QEMU> is safest of all since that picks "
15981 "the qemu binary at the same time as the handle is created."
15985 #: ../src/guestfs-actions.pod:5986
15986 msgid "guestfs_set_recovery_proc"
15990 #: ../src/guestfs-actions.pod:5988
15994 " guestfs_set_recovery_proc (guestfs_h *g,\n"
15995 " int recoveryproc);\n"
16000 #: ../src/guestfs-actions.pod:5992
16002 "If this is called with the parameter C<false> then C<guestfs_launch> does "
16003 "not create a recovery process. The purpose of the recovery process is to "
16004 "stop runaway qemu processes in the case where the main program aborts "
16009 #: ../src/guestfs-actions.pod:5997
16011 "This only has any effect if called before C<guestfs_launch>, and the default "
16016 #: ../src/guestfs-actions.pod:6000 ../fish/guestfish-actions.pod:4054
16018 "About the only time when you would want to disable this is if the main "
16019 "process will fork itself into the background (\"daemonize\" itself). In "
16020 "this case the recovery process thinks that the main program has disappeared "
16021 "and so kills qemu, which is not very helpful."
16025 #: ../src/guestfs-actions.pod:6010
16026 msgid "guestfs_set_selinux"
16030 #: ../src/guestfs-actions.pod:6012
16034 " guestfs_set_selinux (guestfs_h *g,\n"
16040 #: ../src/guestfs-actions.pod:6016 ../fish/guestfish-actions.pod:4066
16042 "This sets the selinux flag that is passed to the appliance at boot time. "
16043 "The default is C<selinux=0> (disabled)."
16047 #: ../src/guestfs-actions.pod:6019 ../fish/guestfish-actions.pod:4069
16049 "Note that if SELinux is enabled, it is always in Permissive mode "
16050 "(C<enforcing=0>)."
16054 #: ../src/guestfs-actions.pod:6029
16055 msgid "guestfs_set_trace"
16059 #: ../src/guestfs-actions.pod:6031
16063 " guestfs_set_trace (guestfs_h *g,\n"
16069 #: ../src/guestfs-actions.pod:6035 ../fish/guestfish-actions.pod:4081
16071 "If the command trace flag is set to 1, then libguestfs calls, parameters and "
16072 "return values are traced."
16076 #: ../src/guestfs-actions.pod:6038 ../fish/guestfish-actions.pod:4084
16078 "If you want to trace C API calls into libguestfs (and other libraries) then "
16079 "possibly a better way is to use the external ltrace(1) command."
16083 #: ../src/guestfs-actions.pod:6042 ../fish/guestfish-actions.pod:4088
16085 "Command traces are disabled unless the environment variable "
16086 "C<LIBGUESTFS_TRACE> is defined and set to C<1>."
16090 #: ../src/guestfs-actions.pod:6045
16092 "Trace messages are normally sent to C<stderr>, unless you register a "
16093 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
16097 #: ../src/guestfs-actions.pod:6053
16098 msgid "guestfs_set_verbose"
16102 #: ../src/guestfs-actions.pod:6055
16106 " guestfs_set_verbose (guestfs_h *g,\n"
16112 #: ../src/guestfs-actions.pod:6059 ../fish/guestfish-actions.pod:4101
16113 msgid "If C<verbose> is true, this turns on verbose messages."
16117 #: ../src/guestfs-actions.pod:6061 ../fish/guestfish-actions.pod:4103
16119 "Verbose messages are disabled unless the environment variable "
16120 "C<LIBGUESTFS_DEBUG> is defined and set to C<1>."
16124 #: ../src/guestfs-actions.pod:6064
16126 "Verbose messages are normally sent to C<stderr>, unless you register a "
16127 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
16131 #: ../src/guestfs-actions.pod:6072
16132 msgid "guestfs_setcon"
16136 #: ../src/guestfs-actions.pod:6074
16140 " guestfs_setcon (guestfs_h *g,\n"
16141 " const char *context);\n"
16146 #: ../src/guestfs-actions.pod:6078 ../fish/guestfish-actions.pod:4114
16148 "This sets the SELinux security context of the daemon to the string "
16153 #: ../src/guestfs-actions.pod:6081 ../fish/guestfish-actions.pod:4117
16154 msgid "See the documentation about SELINUX in L<guestfs(3)>."
16158 #: ../src/guestfs-actions.pod:6087
16159 msgid "guestfs_setxattr"
16163 #: ../src/guestfs-actions.pod:6089
16167 " guestfs_setxattr (guestfs_h *g,\n"
16168 " const char *xattr,\n"
16169 " const char *val,\n"
16171 " const char *path);\n"
16176 #: ../src/guestfs-actions.pod:6096 ../fish/guestfish-actions.pod:4123
16178 "This call sets the extended attribute named C<xattr> of the file C<path> to "
16179 "the value C<val> (of length C<vallen>). The value is arbitrary 8 bit data."
16183 #: ../src/guestfs-actions.pod:6100
16184 msgid "See also: C<guestfs_lsetxattr>, L<attr(5)>."
16188 #: ../src/guestfs-actions.pod:6106
16189 msgid "guestfs_sfdisk"
16193 #: ../src/guestfs-actions.pod:6108
16197 " guestfs_sfdisk (guestfs_h *g,\n"
16198 " const char *device,\n"
16202 " char *const *lines);\n"
16207 #: ../src/guestfs-actions.pod:6116 ../fish/guestfish-actions.pod:4133
16209 "This is a direct interface to the L<sfdisk(8)> program for creating "
16210 "partitions on block devices."
16214 #: ../src/guestfs-actions.pod:6119 ../fish/guestfish-actions.pod:4136
16215 msgid "C<device> should be a block device, for example C</dev/sda>."
16219 #: ../src/guestfs-actions.pod:6121 ../fish/guestfish-actions.pod:4138
16221 "C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads and "
16222 "sectors on the device, which are passed directly to sfdisk as the I<-C>, I<-"
16223 "H> and I<-S> parameters. If you pass C<0> for any of these, then the "
16224 "corresponding parameter is omitted. Usually for 'large' disks, you can just "
16225 "pass C<0> for these, but for small (floppy-sized) disks, sfdisk (or rather, "
16226 "the kernel) cannot work out the right geometry and you will need to tell it."
16230 #: ../src/guestfs-actions.pod:6129 ../fish/guestfish-actions.pod:4146
16232 "C<lines> is a list of lines that we feed to C<sfdisk>. For more information "
16233 "refer to the L<sfdisk(8)> manpage."
16237 #: ../src/guestfs-actions.pod:6132 ../fish/guestfish-actions.pod:4149
16239 "To create a single partition occupying the whole disk, you would pass "
16240 "C<lines> as a single element list, when the single element being the string "
16245 #: ../src/guestfs-actions.pod:6136
16247 "See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>, C<guestfs_part_init>"
16251 #: ../src/guestfs-actions.pod:6146
16252 msgid "guestfs_sfdiskM"
16256 #: ../src/guestfs-actions.pod:6148
16260 " guestfs_sfdiskM (guestfs_h *g,\n"
16261 " const char *device,\n"
16262 " char *const *lines);\n"
16267 #: ../src/guestfs-actions.pod:6153
16269 "This is a simplified interface to the C<guestfs_sfdisk> command, where "
16270 "partition sizes are specified in megabytes only (rounded to the nearest "
16271 "cylinder) and you don't need to specify the cyls, heads and sectors "
16272 "parameters which were rarely if ever used anyway."
16276 #: ../src/guestfs-actions.pod:6159
16278 "See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage and "
16279 "C<guestfs_part_disk>"
16283 #: ../src/guestfs-actions.pod:6169
16284 msgid "guestfs_sfdisk_N"
16288 #: ../src/guestfs-actions.pod:6171
16292 " guestfs_sfdisk_N (guestfs_h *g,\n"
16293 " const char *device,\n"
16298 " const char *line);\n"
16303 #: ../src/guestfs-actions.pod:6180 ../fish/guestfish-actions.pod:4179
16305 "This runs L<sfdisk(8)> option to modify just the single partition C<n> "
16306 "(note: C<n> counts from 1)."
16310 #: ../src/guestfs-actions.pod:6183
16312 "For other parameters, see C<guestfs_sfdisk>. You should usually pass C<0> "
16313 "for the cyls/heads/sectors parameters."
16317 #: ../src/guestfs-actions.pod:6186
16318 msgid "See also: C<guestfs_part_add>"
16322 #: ../src/guestfs-actions.pod:6195
16323 msgid "guestfs_sfdisk_disk_geometry"
16327 #: ../src/guestfs-actions.pod:6197
16331 " guestfs_sfdisk_disk_geometry (guestfs_h *g,\n"
16332 " const char *device);\n"
16337 #: ../src/guestfs-actions.pod:6201
16339 "This displays the disk geometry of C<device> read from the partition table. "
16340 "Especially in the case where the underlying block device has been resized, "
16341 "this can be different from the kernel's idea of the geometry (see "
16342 "C<guestfs_sfdisk_kernel_geometry>)."
16346 #: ../src/guestfs-actions.pod:6206 ../src/guestfs-actions.pod:6222
16347 #: ../fish/guestfish-actions.pod:4199 ../fish/guestfish-actions.pod:4208
16348 msgid "The result is in human-readable format, and not designed to be parsed."
16352 #: ../src/guestfs-actions.pod:6214
16353 msgid "guestfs_sfdisk_kernel_geometry"
16357 #: ../src/guestfs-actions.pod:6216
16361 " guestfs_sfdisk_kernel_geometry (guestfs_h *g,\n"
16362 " const char *device);\n"
16367 #: ../src/guestfs-actions.pod:6220 ../fish/guestfish-actions.pod:4206
16368 msgid "This displays the kernel's idea of the geometry of C<device>."
16372 #: ../src/guestfs-actions.pod:6230
16373 msgid "guestfs_sfdisk_l"
16377 #: ../src/guestfs-actions.pod:6232
16381 " guestfs_sfdisk_l (guestfs_h *g,\n"
16382 " const char *device);\n"
16387 #: ../src/guestfs-actions.pod:6236 ../fish/guestfish-actions.pod:4215
16389 "This displays the partition table on C<device>, in the human-readable output "
16390 "of the L<sfdisk(8)> command. It is not intended to be parsed."
16394 #: ../src/guestfs-actions.pod:6240
16395 msgid "See also: C<guestfs_part_list>"
16399 #: ../src/guestfs-actions.pod:6247
16404 #: ../src/guestfs-actions.pod:6249
16408 " guestfs_sh (guestfs_h *g,\n"
16409 " const char *command);\n"
16414 #: ../src/guestfs-actions.pod:6253 ../fish/guestfish-actions.pod:4225
16416 "This call runs a command from the guest filesystem via the guest's C</bin/"
16421 #: ../src/guestfs-actions.pod:6256
16422 msgid "This is like C<guestfs_command>, but passes the command to:"
16426 #: ../src/guestfs-actions.pod:6258 ../fish/guestfish-actions.pod:4230
16429 " /bin/sh -c \"command\"\n"
16434 #: ../src/guestfs-actions.pod:6260 ../fish/guestfish-actions.pod:4232
16436 "Depending on the guest's shell, this usually results in wildcards being "
16437 "expanded, shell expressions being interpolated and so on."
16441 #: ../src/guestfs-actions.pod:6264
16442 msgid "All the provisos about C<guestfs_command> apply to this call."
16446 #: ../src/guestfs-actions.pod:6271
16447 msgid "guestfs_sh_lines"
16451 #: ../src/guestfs-actions.pod:6273
16455 " guestfs_sh_lines (guestfs_h *g,\n"
16456 " const char *command);\n"
16461 #: ../src/guestfs-actions.pod:6277
16463 "This is the same as C<guestfs_sh>, but splits the result into a list of "
16468 #: ../src/guestfs-actions.pod:6280
16469 msgid "See also: C<guestfs_command_lines>"
16473 #: ../src/guestfs-actions.pod:6288
16474 msgid "guestfs_sleep"
16478 #: ../src/guestfs-actions.pod:6290
16482 " guestfs_sleep (guestfs_h *g,\n"
16488 #: ../src/guestfs-actions.pod:6294 ../fish/guestfish-actions.pod:4251
16489 msgid "Sleep for C<secs> seconds."
16493 #: ../src/guestfs-actions.pod:6298
16494 msgid "(Added in 1.0.41)"
16498 #: ../src/guestfs-actions.pod:6300 ../src/guestfs-structs.pod:109
16499 msgid "guestfs_stat"
16503 #: ../src/guestfs-actions.pod:6302
16506 " struct guestfs_stat *\n"
16507 " guestfs_stat (guestfs_h *g,\n"
16508 " const char *path);\n"
16513 #: ../src/guestfs-actions.pod:6308 ../fish/guestfish-actions.pod:4259
16514 msgid "This is the same as the C<stat(2)> system call."
16518 #: ../src/guestfs-actions.pod:6316 ../src/guestfs-structs.pod:135
16519 msgid "guestfs_statvfs"
16523 #: ../src/guestfs-actions.pod:6318
16526 " struct guestfs_statvfs *\n"
16527 " guestfs_statvfs (guestfs_h *g,\n"
16528 " const char *path);\n"
16533 #: ../src/guestfs-actions.pod:6322 ../fish/guestfish-actions.pod:4265
16535 "Returns file system statistics for any mounted file system. C<path> should "
16536 "be a file or directory in the mounted file system (typically it is the mount "
16537 "point itself, but it doesn't need to be)."
16541 #: ../src/guestfs-actions.pod:6326 ../fish/guestfish-actions.pod:4269
16542 msgid "This is the same as the C<statvfs(2)> system call."
16546 #: ../src/guestfs-actions.pod:6328
16548 "This function returns a C<struct guestfs_statvfs *>, or NULL if there was an "
16549 "error. I<The caller must call C<guestfs_free_statvfs> after use>."
16553 #: ../src/guestfs-actions.pod:6334
16554 msgid "guestfs_strings"
16558 #: ../src/guestfs-actions.pod:6336
16562 " guestfs_strings (guestfs_h *g,\n"
16563 " const char *path);\n"
16568 #: ../src/guestfs-actions.pod:6340 ../fish/guestfish-actions.pod:4275
16570 "This runs the L<strings(1)> command on a file and returns the list of "
16571 "printable strings found."
16575 #: ../src/guestfs-actions.pod:6352
16576 msgid "guestfs_strings_e"
16580 #: ../src/guestfs-actions.pod:6354
16584 " guestfs_strings_e (guestfs_h *g,\n"
16585 " const char *encoding,\n"
16586 " const char *path);\n"
16591 #: ../src/guestfs-actions.pod:6359
16593 "This is like the C<guestfs_strings> command, but allows you to specify the "
16594 "encoding of strings that are looked for in the source file C<path>."
16598 #: ../src/guestfs-actions.pod:6363 ../fish/guestfish-actions.pod:4289
16599 msgid "Allowed encodings are:"
16603 #: ../src/guestfs-actions.pod:6367 ../fish/guestfish-actions.pod:4293
16608 #: ../src/guestfs-actions.pod:6369
16610 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
16611 "ISO-8859-X (this is what C<guestfs_strings> uses)."
16615 #: ../src/guestfs-actions.pod:6372 ../fish/guestfish-actions.pod:4298
16620 #: ../src/guestfs-actions.pod:6374 ../fish/guestfish-actions.pod:4300
16621 msgid "Single 8-bit-byte characters."
16625 #: ../src/guestfs-actions.pod:6376 ../fish/guestfish-actions.pod:4302
16630 #: ../src/guestfs-actions.pod:6378 ../fish/guestfish-actions.pod:4304
16631 msgid "16-bit big endian strings such as those encoded in UTF-16BE or UCS-2BE."
16635 #: ../src/guestfs-actions.pod:6381 ../fish/guestfish-actions.pod:4307
16636 msgid "l (lower case letter L)"
16640 #: ../src/guestfs-actions.pod:6383 ../fish/guestfish-actions.pod:4309
16642 "16-bit little endian such as UTF-16LE and UCS-2LE. This is useful for "
16643 "examining binaries in Windows guests."
16647 #: ../src/guestfs-actions.pod:6386 ../fish/guestfish-actions.pod:4312
16652 #: ../src/guestfs-actions.pod:6388 ../fish/guestfish-actions.pod:4314
16653 msgid "32-bit big endian such as UCS-4BE."
16657 #: ../src/guestfs-actions.pod:6390 ../fish/guestfish-actions.pod:4316
16662 #: ../src/guestfs-actions.pod:6392 ../fish/guestfish-actions.pod:4318
16663 msgid "32-bit little endian such as UCS-4LE."
16667 #: ../src/guestfs-actions.pod:6396 ../fish/guestfish-actions.pod:4322
16668 msgid "The returned strings are transcoded to UTF-8."
16672 #: ../src/guestfs-actions.pod:6407
16673 msgid "guestfs_swapoff_device"
16677 #: ../src/guestfs-actions.pod:6409
16681 " guestfs_swapoff_device (guestfs_h *g,\n"
16682 " const char *device);\n"
16687 #: ../src/guestfs-actions.pod:6413
16689 "This command disables the libguestfs appliance swap device or partition "
16690 "named C<device>. See C<guestfs_swapon_device>."
16694 #: ../src/guestfs-actions.pod:6421
16695 msgid "guestfs_swapoff_file"
16699 #: ../src/guestfs-actions.pod:6423
16703 " guestfs_swapoff_file (guestfs_h *g,\n"
16704 " const char *file);\n"
16709 #: ../src/guestfs-actions.pod:6427 ../fish/guestfish-actions.pod:4339
16710 msgid "This command disables the libguestfs appliance swap on file."
16714 #: ../src/guestfs-actions.pod:6433
16715 msgid "guestfs_swapoff_label"
16719 #: ../src/guestfs-actions.pod:6435
16723 " guestfs_swapoff_label (guestfs_h *g,\n"
16724 " const char *label);\n"
16729 #: ../src/guestfs-actions.pod:6439 ../fish/guestfish-actions.pod:4345
16731 "This command disables the libguestfs appliance swap on labeled swap "
16736 #: ../src/guestfs-actions.pod:6446
16737 msgid "guestfs_swapoff_uuid"
16741 #: ../src/guestfs-actions.pod:6448
16745 " guestfs_swapoff_uuid (guestfs_h *g,\n"
16746 " const char *uuid);\n"
16751 #: ../src/guestfs-actions.pod:6452 ../fish/guestfish-actions.pod:4352
16753 "This command disables the libguestfs appliance swap partition with the given "
16758 #: ../src/guestfs-actions.pod:6459
16759 msgid "guestfs_swapon_device"
16763 #: ../src/guestfs-actions.pod:6461
16767 " guestfs_swapon_device (guestfs_h *g,\n"
16768 " const char *device);\n"
16773 #: ../src/guestfs-actions.pod:6465
16775 "This command enables the libguestfs appliance to use the swap device or "
16776 "partition named C<device>. The increased memory is made available for all "
16777 "commands, for example those run using C<guestfs_command> or C<guestfs_sh>."
16781 #: ../src/guestfs-actions.pod:6470 ../fish/guestfish-actions.pod:4364
16783 "Note that you should not swap to existing guest swap partitions unless you "
16784 "know what you are doing. They may contain hibernation information, or other "
16785 "information that the guest doesn't want you to trash. You also risk leaking "
16786 "information about the host to the guest this way. Instead, attach a new "
16787 "host device to the guest and swap on that."
16791 #: ../src/guestfs-actions.pod:6481
16792 msgid "guestfs_swapon_file"
16796 #: ../src/guestfs-actions.pod:6483
16800 " guestfs_swapon_file (guestfs_h *g,\n"
16801 " const char *file);\n"
16806 #: ../src/guestfs-actions.pod:6487
16808 "This command enables swap to a file. See C<guestfs_swapon_device> for other "
16813 #: ../src/guestfs-actions.pod:6494
16814 msgid "guestfs_swapon_label"
16818 #: ../src/guestfs-actions.pod:6496
16822 " guestfs_swapon_label (guestfs_h *g,\n"
16823 " const char *label);\n"
16828 #: ../src/guestfs-actions.pod:6500
16830 "This command enables swap to a labeled swap partition. See "
16831 "C<guestfs_swapon_device> for other notes."
16835 #: ../src/guestfs-actions.pod:6507
16836 msgid "guestfs_swapon_uuid"
16840 #: ../src/guestfs-actions.pod:6509
16844 " guestfs_swapon_uuid (guestfs_h *g,\n"
16845 " const char *uuid);\n"
16850 #: ../src/guestfs-actions.pod:6513
16852 "This command enables swap to a swap partition with the given UUID. See "
16853 "C<guestfs_swapon_device> for other notes."
16857 #: ../src/guestfs-actions.pod:6520
16858 msgid "guestfs_sync"
16862 #: ../src/guestfs-actions.pod:6522
16866 " guestfs_sync (guestfs_h *g);\n"
16871 #: ../src/guestfs-actions.pod:6525 ../fish/guestfish-actions.pod:4396
16873 "This syncs the disk, so that any writes are flushed through to the "
16874 "underlying disk image."
16878 #: ../src/guestfs-actions.pod:6528 ../fish/guestfish-actions.pod:4399
16880 "You should always call this if you have modified a disk image, before "
16881 "closing the handle."
16885 #: ../src/guestfs-actions.pod:6535
16886 msgid "guestfs_tail"
16890 #: ../src/guestfs-actions.pod:6537
16894 " guestfs_tail (guestfs_h *g,\n"
16895 " const char *path);\n"
16900 #: ../src/guestfs-actions.pod:6541 ../fish/guestfish-actions.pod:4406
16902 "This command returns up to the last 10 lines of a file as a list of strings."
16906 #: ../src/guestfs-actions.pod:6553
16907 msgid "guestfs_tail_n"
16911 #: ../src/guestfs-actions.pod:6555
16915 " guestfs_tail_n (guestfs_h *g,\n"
16917 " const char *path);\n"
16922 #: ../src/guestfs-actions.pod:6560 ../fish/guestfish-actions.pod:4416
16924 "If the parameter C<nrlines> is a positive number, this returns the last "
16925 "C<nrlines> lines of the file C<path>."
16929 #: ../src/guestfs-actions.pod:6563 ../fish/guestfish-actions.pod:4419
16931 "If the parameter C<nrlines> is a negative number, this returns lines from "
16932 "the file C<path>, starting with the C<-nrlines>th line."
16936 #: ../src/guestfs-actions.pod:6577
16937 msgid "guestfs_tar_in"
16941 #: ../src/guestfs-actions.pod:6579
16945 " guestfs_tar_in (guestfs_h *g,\n"
16946 " const char *tarfile,\n"
16947 " const char *directory);\n"
16952 #: ../src/guestfs-actions.pod:6584 ../fish/guestfish-actions.pod:4431
16954 "This command uploads and unpacks local file C<tarfile> (an I<uncompressed> "
16955 "tar file) into C<directory>."
16959 #: ../src/guestfs-actions.pod:6587
16961 "To upload a compressed tarball, use C<guestfs_tgz_in> or C<guestfs_txz_in>."
16965 #: ../src/guestfs-actions.pod:6592 ../src/guestfs-actions.pod:6609
16966 #: ../src/guestfs-actions.pod:6625 ../src/guestfs-actions.pod:6641
16967 msgid "(Added in 1.0.3)"
16971 #: ../src/guestfs-actions.pod:6594
16972 msgid "guestfs_tar_out"
16976 #: ../src/guestfs-actions.pod:6596
16980 " guestfs_tar_out (guestfs_h *g,\n"
16981 " const char *directory,\n"
16982 " const char *tarfile);\n"
16987 #: ../src/guestfs-actions.pod:6601 ../fish/guestfish-actions.pod:4443
16989 "This command packs the contents of C<directory> and downloads it to local "
16994 #: ../src/guestfs-actions.pod:6604
16996 "To download a compressed tarball, use C<guestfs_tgz_out> or "
16997 "C<guestfs_txz_out>."
17001 #: ../src/guestfs-actions.pod:6611
17002 msgid "guestfs_tgz_in"
17006 #: ../src/guestfs-actions.pod:6613
17010 " guestfs_tgz_in (guestfs_h *g,\n"
17011 " const char *tarball,\n"
17012 " const char *directory);\n"
17017 #: ../src/guestfs-actions.pod:6618 ../fish/guestfish-actions.pod:4455
17019 "This command uploads and unpacks local file C<tarball> (a I<gzip compressed> "
17020 "tar file) into C<directory>."
17024 #: ../src/guestfs-actions.pod:6621
17025 msgid "To upload an uncompressed tarball, use C<guestfs_tar_in>."
17029 #: ../src/guestfs-actions.pod:6627
17030 msgid "guestfs_tgz_out"
17034 #: ../src/guestfs-actions.pod:6629
17038 " guestfs_tgz_out (guestfs_h *g,\n"
17039 " const char *directory,\n"
17040 " const char *tarball);\n"
17045 #: ../src/guestfs-actions.pod:6634 ../fish/guestfish-actions.pod:4466
17047 "This command packs the contents of C<directory> and downloads it to local "
17052 #: ../src/guestfs-actions.pod:6637
17053 msgid "To download an uncompressed tarball, use C<guestfs_tar_out>."
17057 #: ../src/guestfs-actions.pod:6643
17058 msgid "guestfs_touch"
17062 #: ../src/guestfs-actions.pod:6645
17066 " guestfs_touch (guestfs_h *g,\n"
17067 " const char *path);\n"
17072 #: ../src/guestfs-actions.pod:6649 ../fish/guestfish-actions.pod:4477
17074 "Touch acts like the L<touch(1)> command. It can be used to update the "
17075 "timestamps on a file, or, if the file does not exist, to create a new zero-"
17080 #: ../src/guestfs-actions.pod:6653 ../fish/guestfish-actions.pod:4481
17082 "This command only works on regular files, and will fail on other file types "
17083 "such as directories, symbolic links, block special etc."
17087 #: ../src/guestfs-actions.pod:6660
17088 msgid "guestfs_truncate"
17092 #: ../src/guestfs-actions.pod:6662
17096 " guestfs_truncate (guestfs_h *g,\n"
17097 " const char *path);\n"
17102 #: ../src/guestfs-actions.pod:6666 ../fish/guestfish-actions.pod:4488
17104 "This command truncates C<path> to a zero-length file. The file must exist "
17109 #: ../src/guestfs-actions.pod:6673
17110 msgid "guestfs_truncate_size"
17114 #: ../src/guestfs-actions.pod:6675
17118 " guestfs_truncate_size (guestfs_h *g,\n"
17119 " const char *path,\n"
17120 " int64_t size);\n"
17125 #: ../src/guestfs-actions.pod:6680 ../fish/guestfish-actions.pod:4495
17127 "This command truncates C<path> to size C<size> bytes. The file must exist "
17132 #: ../src/guestfs-actions.pod:6683
17134 "If the current file size is less than C<size> then the file is extended to "
17135 "the required size with zero bytes. This creates a sparse file (ie. disk "
17136 "blocks are not allocated for the file until you write to it). To create a "
17137 "non-sparse file of zeroes, use C<guestfs_fallocate64> instead."
17141 #: ../src/guestfs-actions.pod:6693
17142 msgid "guestfs_tune2fs_l"
17146 #: ../src/guestfs-actions.pod:6695
17150 " guestfs_tune2fs_l (guestfs_h *g,\n"
17151 " const char *device);\n"
17156 #: ../src/guestfs-actions.pod:6699 ../fish/guestfish-actions.pod:4508
17158 "This returns the contents of the ext2, ext3 or ext4 filesystem superblock on "
17163 #: ../src/guestfs-actions.pod:6702 ../fish/guestfish-actions.pod:4511
17165 "It is the same as running C<tune2fs -l device>. See L<tune2fs(8)> manpage "
17166 "for more details. The list of fields returned isn't clearly defined, and "
17167 "depends on both the version of C<tune2fs> that libguestfs was built against, "
17168 "and the filesystem itself."
17172 #: ../src/guestfs-actions.pod:6715
17173 msgid "guestfs_txz_in"
17177 #: ../src/guestfs-actions.pod:6717
17181 " guestfs_txz_in (guestfs_h *g,\n"
17182 " const char *tarball,\n"
17183 " const char *directory);\n"
17188 #: ../src/guestfs-actions.pod:6722 ../fish/guestfish-actions.pod:4520
17190 "This command uploads and unpacks local file C<tarball> (an I<xz compressed> "
17191 "tar file) into C<directory>."
17195 #: ../src/guestfs-actions.pod:6729
17196 msgid "guestfs_txz_out"
17200 #: ../src/guestfs-actions.pod:6731
17204 " guestfs_txz_out (guestfs_h *g,\n"
17205 " const char *directory,\n"
17206 " const char *tarball);\n"
17211 #: ../src/guestfs-actions.pod:6736 ../fish/guestfish-actions.pod:4529
17213 "This command packs the contents of C<directory> and downloads it to local "
17214 "file C<tarball> (as an xz compressed tar archive)."
17218 #: ../src/guestfs-actions.pod:6743
17219 msgid "guestfs_umask"
17223 #: ../src/guestfs-actions.pod:6745
17227 " guestfs_umask (guestfs_h *g,\n"
17233 #: ../src/guestfs-actions.pod:6749 ../fish/guestfish-actions.pod:4538
17235 "This function sets the mask used for creating new files and device nodes to "
17240 #: ../src/guestfs-actions.pod:6752 ../fish/guestfish-actions.pod:4541
17242 "Typical umask values would be C<022> which creates new files with "
17243 "permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and C<002> which creates "
17244 "new files with permissions like \"-rw-rw-r--\" or \"-rwxrwxr-x\"."
17248 #: ../src/guestfs-actions.pod:6757 ../fish/guestfish-actions.pod:4546
17250 "The default umask is C<022>. This is important because it means that "
17251 "directories and device nodes will be created with C<0644> or C<0755> mode "
17252 "even if you specify C<0777>."
17256 #: ../src/guestfs-actions.pod:6761
17258 "See also C<guestfs_get_umask>, L<umask(2)>, C<guestfs_mknod>, "
17259 "C<guestfs_mkdir>."
17263 #: ../src/guestfs-actions.pod:6764 ../fish/guestfish-actions.pod:4553
17264 msgid "This call returns the previous umask."
17268 #: ../src/guestfs-actions.pod:6770
17269 msgid "guestfs_umount"
17273 #: ../src/guestfs-actions.pod:6772
17277 " guestfs_umount (guestfs_h *g,\n"
17278 " const char *pathordevice);\n"
17283 #: ../src/guestfs-actions.pod:6776 ../fish/guestfish-actions.pod:4561
17285 "This unmounts the given filesystem. The filesystem may be specified either "
17286 "by its mountpoint (path) or the device which contains the filesystem."
17290 #: ../src/guestfs-actions.pod:6784
17291 msgid "guestfs_umount_all"
17295 #: ../src/guestfs-actions.pod:6786
17299 " guestfs_umount_all (guestfs_h *g);\n"
17304 #: ../src/guestfs-actions.pod:6789 ../fish/guestfish-actions.pod:4571
17305 msgid "This unmounts all mounted filesystems."
17309 #: ../src/guestfs-actions.pod:6791 ../fish/guestfish-actions.pod:4573
17310 msgid "Some internal mounts are not unmounted by this call."
17314 #: ../src/guestfs-actions.pod:6797
17315 msgid "guestfs_upload"
17319 #: ../src/guestfs-actions.pod:6799
17323 " guestfs_upload (guestfs_h *g,\n"
17324 " const char *filename,\n"
17325 " const char *remotefilename);\n"
17330 #: ../src/guestfs-actions.pod:6804 ../src/guestfs-actions.pod:6828
17331 #: ../fish/guestfish-actions.pod:4579 ../fish/guestfish-actions.pod:4592
17332 msgid "Upload local file C<filename> to C<remotefilename> on the filesystem."
17336 #: ../src/guestfs-actions.pod:6809
17337 msgid "See also C<guestfs_download>."
17341 #: ../src/guestfs-actions.pod:6820
17342 msgid "guestfs_upload_offset"
17346 #: ../src/guestfs-actions.pod:6822
17350 " guestfs_upload_offset (guestfs_h *g,\n"
17351 " const char *filename,\n"
17352 " const char *remotefilename,\n"
17353 " int64_t offset);\n"
17358 #: ../src/guestfs-actions.pod:6831 ../fish/guestfish-actions.pod:4595
17360 "C<remotefilename> is overwritten starting at the byte C<offset> specified. "
17361 "The intention is to overwrite parts of existing files or devices, although "
17362 "if a non-existant file is specified then it is created with a \"hole\" "
17363 "before C<offset>. The size of the data written is implicit in the size of "
17364 "the source C<filename>."
17368 #: ../src/guestfs-actions.pod:6838
17370 "Note that there is no limit on the amount of data that can be uploaded with "
17371 "this call, unlike with C<guestfs_pwrite>, and this call always writes the "
17372 "full amount unless an error occurs."
17376 #: ../src/guestfs-actions.pod:6843
17377 msgid "See also C<guestfs_upload>, C<guestfs_pwrite>."
17381 #: ../src/guestfs-actions.pod:6854
17382 msgid "guestfs_utimens"
17386 #: ../src/guestfs-actions.pod:6856
17390 " guestfs_utimens (guestfs_h *g,\n"
17391 " const char *path,\n"
17392 " int64_t atsecs,\n"
17393 " int64_t atnsecs,\n"
17394 " int64_t mtsecs,\n"
17395 " int64_t mtnsecs);\n"
17400 #: ../src/guestfs-actions.pod:6864 ../fish/guestfish-actions.pod:4615
17401 msgid "This command sets the timestamps of a file with nanosecond precision."
17405 #: ../src/guestfs-actions.pod:6867 ../fish/guestfish-actions.pod:4618
17407 "C<atsecs, atnsecs> are the last access time (atime) in secs and nanoseconds "
17412 #: ../src/guestfs-actions.pod:6870 ../fish/guestfish-actions.pod:4621
17414 "C<mtsecs, mtnsecs> are the last modification time (mtime) in secs and "
17415 "nanoseconds from the epoch."
17419 #: ../src/guestfs-actions.pod:6873 ../fish/guestfish-actions.pod:4624
17421 "If the C<*nsecs> field contains the special value C<-1> then the "
17422 "corresponding timestamp is set to the current time. (The C<*secs> field is "
17423 "ignored in this case)."
17427 #: ../src/guestfs-actions.pod:6877 ../fish/guestfish-actions.pod:4628
17429 "If the C<*nsecs> field contains the special value C<-2> then the "
17430 "corresponding timestamp is left unchanged. (The C<*secs> field is ignored "
17435 #: ../src/guestfs-actions.pod:6885 ../src/guestfs-structs.pod:175
17436 msgid "guestfs_version"
17440 #: ../src/guestfs-actions.pod:6887
17443 " struct guestfs_version *\n"
17444 " guestfs_version (guestfs_h *g);\n"
17449 #: ../src/guestfs-actions.pod:6890 ../fish/guestfish-actions.pod:4636
17451 "Return the libguestfs version number that the program is linked against."
17455 #: ../src/guestfs-actions.pod:6893 ../fish/guestfish-actions.pod:4639
17457 "Note that because of dynamic linking this is not necessarily the version of "
17458 "libguestfs that you compiled against. You can compile the program, and then "
17459 "at runtime dynamically link against a completely different C<libguestfs.so> "
17464 #: ../src/guestfs-actions.pod:6898 ../fish/guestfish-actions.pod:4644
17466 "This call was added in version C<1.0.58>. In previous versions of "
17467 "libguestfs there was no way to get the version number. From C code you can "
17468 "use dynamic linker functions to find out if this symbol exists (if it "
17469 "doesn't, then it's an earlier version)."
17473 #: ../src/guestfs-actions.pod:6904 ../fish/guestfish-actions.pod:4650
17475 "The call returns a structure with four elements. The first three (C<major>, "
17476 "C<minor> and C<release>) are numbers and correspond to the usual version "
17477 "triplet. The fourth element (C<extra>) is a string and is normally empty, "
17478 "but may be used for distro-specific information."
17482 #: ../src/guestfs-actions.pod:6910 ../fish/guestfish-actions.pod:4656
17484 "To construct the original version string: C<$major.$minor.$release$extra>"
17488 #: ../src/guestfs-actions.pod:6913 ../fish/guestfish-actions.pod:4659
17489 msgid "See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>."
17493 #: ../src/guestfs-actions.pod:6915
17495 "I<Note:> Don't use this call to test for availability of features. In "
17496 "enterprise distributions we backport features from later versions into "
17497 "earlier versions, making this an unreliable way to test for features. Use "
17498 "C<guestfs_available> instead."
17502 #: ../src/guestfs-actions.pod:6921
17504 "This function returns a C<struct guestfs_version *>, or NULL if there was an "
17505 "error. I<The caller must call C<guestfs_free_version> after use>."
17509 #: ../src/guestfs-actions.pod:6925
17510 msgid "(Added in 1.0.58)"
17514 #: ../src/guestfs-actions.pod:6927
17515 msgid "guestfs_vfs_label"
17519 #: ../src/guestfs-actions.pod:6929
17523 " guestfs_vfs_label (guestfs_h *g,\n"
17524 " const char *device);\n"
17529 #: ../src/guestfs-actions.pod:6933 ../fish/guestfish-actions.pod:4671
17530 msgid "This returns the filesystem label of the filesystem on C<device>."
17534 #: ../src/guestfs-actions.pod:6936 ../fish/guestfish-actions.pod:4674
17535 msgid "If the filesystem is unlabeled, this returns the empty string."
17539 #: ../src/guestfs-actions.pod:6938
17540 msgid "To find a filesystem from the label, use C<guestfs_findfs_label>."
17544 #: ../src/guestfs-actions.pod:6943 ../src/guestfs-actions.pod:6980
17545 msgid "(Added in 1.3.18)"
17549 #: ../src/guestfs-actions.pod:6945
17550 msgid "guestfs_vfs_type"
17554 #: ../src/guestfs-actions.pod:6947
17558 " guestfs_vfs_type (guestfs_h *g,\n"
17559 " const char *device);\n"
17564 #: ../src/guestfs-actions.pod:6951 ../fish/guestfish-actions.pod:4682
17566 "This command gets the filesystem type corresponding to the filesystem on "
17571 #: ../src/guestfs-actions.pod:6954 ../fish/guestfish-actions.pod:4685
17573 "For most filesystems, the result is the name of the Linux VFS module which "
17574 "would be used to mount this filesystem if you mounted it without specifying "
17575 "the filesystem type. For example a string such as C<ext3> or C<ntfs>."
17579 #: ../src/guestfs-actions.pod:6964
17580 msgid "guestfs_vfs_uuid"
17584 #: ../src/guestfs-actions.pod:6966
17588 " guestfs_vfs_uuid (guestfs_h *g,\n"
17589 " const char *device);\n"
17594 #: ../src/guestfs-actions.pod:6970 ../fish/guestfish-actions.pod:4694
17595 msgid "This returns the filesystem UUID of the filesystem on C<device>."
17599 #: ../src/guestfs-actions.pod:6973 ../fish/guestfish-actions.pod:4697
17600 msgid "If the filesystem does not have a UUID, this returns the empty string."
17604 #: ../src/guestfs-actions.pod:6975
17605 msgid "To find a filesystem from the UUID, use C<guestfs_findfs_uuid>."
17609 #: ../src/guestfs-actions.pod:6982
17610 msgid "guestfs_vg_activate"
17614 #: ../src/guestfs-actions.pod:6984
17618 " guestfs_vg_activate (guestfs_h *g,\n"
17620 " char *const *volgroups);\n"
17625 #: ../src/guestfs-actions.pod:6989 ../fish/guestfish-actions.pod:4705
17627 "This command activates or (if C<activate> is false) deactivates all logical "
17628 "volumes in the listed volume groups C<volgroups>. If activated, then they "
17629 "are made known to the kernel, ie. they appear as C</dev/mapper> devices. If "
17630 "deactivated, then those devices disappear."
17634 #: ../src/guestfs-actions.pod:6995 ../fish/guestfish-actions.pod:4711
17635 msgid "This command is the same as running C<vgchange -a y|n volgroups...>"
17639 #: ../src/guestfs-actions.pod:6997 ../fish/guestfish-actions.pod:4713
17641 "Note that if C<volgroups> is an empty list then B<all> volume groups are "
17642 "activated or deactivated."
17646 #: ../src/guestfs-actions.pod:7004
17647 msgid "guestfs_vg_activate_all"
17651 #: ../src/guestfs-actions.pod:7006
17655 " guestfs_vg_activate_all (guestfs_h *g,\n"
17656 " int activate);\n"
17661 #: ../src/guestfs-actions.pod:7010 ../fish/guestfish-actions.pod:4720
17663 "This command activates or (if C<activate> is false) deactivates all logical "
17664 "volumes in all volume groups. If activated, then they are made known to the "
17665 "kernel, ie. they appear as C</dev/mapper> devices. If deactivated, then "
17666 "those devices disappear."
17670 #: ../src/guestfs-actions.pod:7016 ../fish/guestfish-actions.pod:4726
17671 msgid "This command is the same as running C<vgchange -a y|n>"
17675 #: ../src/guestfs-actions.pod:7022
17676 msgid "guestfs_vgcreate"
17680 #: ../src/guestfs-actions.pod:7024
17684 " guestfs_vgcreate (guestfs_h *g,\n"
17685 " const char *volgroup,\n"
17686 " char *const *physvols);\n"
17691 #: ../src/guestfs-actions.pod:7029 ../fish/guestfish-actions.pod:4732
17693 "This creates an LVM volume group called C<volgroup> from the non-empty list "
17694 "of physical volumes C<physvols>."
17698 #: ../src/guestfs-actions.pod:7036
17699 msgid "guestfs_vglvuuids"
17703 #: ../src/guestfs-actions.pod:7038
17707 " guestfs_vglvuuids (guestfs_h *g,\n"
17708 " const char *vgname);\n"
17713 #: ../src/guestfs-actions.pod:7042 ../fish/guestfish-actions.pod:4739
17715 "Given a VG called C<vgname>, this returns the UUIDs of all the logical "
17716 "volumes created in this volume group."
17720 #: ../src/guestfs-actions.pod:7045
17722 "You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid> calls to "
17723 "associate logical volumes and volume groups."
17727 #: ../src/guestfs-actions.pod:7048
17728 msgid "See also C<guestfs_vgpvuuids>."
17732 #: ../src/guestfs-actions.pod:7056
17733 msgid "guestfs_vgpvuuids"
17737 #: ../src/guestfs-actions.pod:7058
17741 " guestfs_vgpvuuids (guestfs_h *g,\n"
17742 " const char *vgname);\n"
17747 #: ../src/guestfs-actions.pod:7062 ../fish/guestfish-actions.pod:4751
17749 "Given a VG called C<vgname>, this returns the UUIDs of all the physical "
17750 "volumes that this volume group resides on."
17754 #: ../src/guestfs-actions.pod:7065
17756 "You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid> calls to "
17757 "associate physical volumes and volume groups."
17761 #: ../src/guestfs-actions.pod:7068
17762 msgid "See also C<guestfs_vglvuuids>."
17766 #: ../src/guestfs-actions.pod:7076
17767 msgid "guestfs_vgremove"
17771 #: ../src/guestfs-actions.pod:7078
17775 " guestfs_vgremove (guestfs_h *g,\n"
17776 " const char *vgname);\n"
17781 #: ../src/guestfs-actions.pod:7082 ../fish/guestfish-actions.pod:4763
17782 msgid "Remove an LVM volume group C<vgname>, (for example C<VG>)."
17786 #: ../src/guestfs-actions.pod:7084 ../fish/guestfish-actions.pod:4765
17788 "This also forcibly removes all logical volumes in the volume group (if any)."
17792 #: ../src/guestfs-actions.pod:7091
17793 msgid "guestfs_vgrename"
17797 #: ../src/guestfs-actions.pod:7093
17801 " guestfs_vgrename (guestfs_h *g,\n"
17802 " const char *volgroup,\n"
17803 " const char *newvolgroup);\n"
17808 #: ../src/guestfs-actions.pod:7098 ../fish/guestfish-actions.pod:4772
17809 msgid "Rename a volume group C<volgroup> with the new name C<newvolgroup>."
17813 #: ../src/guestfs-actions.pod:7104
17814 msgid "guestfs_vgs"
17818 #: ../src/guestfs-actions.pod:7106
17822 " guestfs_vgs (guestfs_h *g);\n"
17827 #: ../src/guestfs-actions.pod:7109 ../fish/guestfish-actions.pod:4778
17829 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
17834 #: ../src/guestfs-actions.pod:7112 ../fish/guestfish-actions.pod:4781
17836 "This returns a list of just the volume group names that were detected (eg. "
17841 #: ../src/guestfs-actions.pod:7115
17842 msgid "See also C<guestfs_vgs_full>."
17846 #: ../src/guestfs-actions.pod:7123
17847 msgid "guestfs_vgs_full"
17851 #: ../src/guestfs-actions.pod:7125
17854 " struct guestfs_lvm_vg_list *\n"
17855 " guestfs_vgs_full (guestfs_h *g);\n"
17860 #: ../src/guestfs-actions.pod:7128 ../fish/guestfish-actions.pod:4790
17862 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
17863 "> command. The \"full\" version includes all fields."
17867 #: ../src/guestfs-actions.pod:7131
17869 "This function returns a C<struct guestfs_lvm_vg_list *>, or NULL if there "
17870 "was an error. I<The caller must call C<guestfs_free_lvm_vg_list> after use>."
17874 #: ../src/guestfs-actions.pod:7137
17875 msgid "guestfs_vgscan"
17879 #: ../src/guestfs-actions.pod:7139
17883 " guestfs_vgscan (guestfs_h *g);\n"
17888 #: ../src/guestfs-actions.pod:7142 ../fish/guestfish-actions.pod:4797
17890 "This rescans all block devices and rebuilds the list of LVM physical "
17891 "volumes, volume groups and logical volumes."
17895 #: ../src/guestfs-actions.pod:7149
17896 msgid "guestfs_vguuid"
17900 #: ../src/guestfs-actions.pod:7151
17904 " guestfs_vguuid (guestfs_h *g,\n"
17905 " const char *vgname);\n"
17910 #: ../src/guestfs-actions.pod:7155 ../fish/guestfish-actions.pod:4804
17911 msgid "This command returns the UUID of the LVM VG named C<vgname>."
17915 #: ../src/guestfs-actions.pod:7162
17916 msgid "guestfs_wait_ready"
17920 #: ../src/guestfs-actions.pod:7164
17924 " guestfs_wait_ready (guestfs_h *g);\n"
17929 #: ../src/guestfs-actions.pod:7167
17930 msgid "This function is a no op."
17934 #: ../src/guestfs-actions.pod:7169
17936 "In versions of the API E<lt> 1.0.71 you had to call this function just after "
17937 "calling C<guestfs_launch> to wait for the launch to complete. However this "
17938 "is no longer necessary because C<guestfs_launch> now does the waiting."
17942 #: ../src/guestfs-actions.pod:7174
17944 "If you see any calls to this function in code then you can just remove them, "
17945 "unless you want to retain compatibility with older versions of the API."
17949 #: ../src/guestfs-actions.pod:7182
17950 msgid "guestfs_wc_c"
17954 #: ../src/guestfs-actions.pod:7184
17958 " guestfs_wc_c (guestfs_h *g,\n"
17959 " const char *path);\n"
17964 #: ../src/guestfs-actions.pod:7188 ../fish/guestfish-actions.pod:4810
17966 "This command counts the characters in a file, using the C<wc -c> external "
17971 #: ../src/guestfs-actions.pod:7195
17972 msgid "guestfs_wc_l"
17976 #: ../src/guestfs-actions.pod:7197
17980 " guestfs_wc_l (guestfs_h *g,\n"
17981 " const char *path);\n"
17986 #: ../src/guestfs-actions.pod:7201 ../fish/guestfish-actions.pod:4817
17988 "This command counts the lines in a file, using the C<wc -l> external command."
17992 #: ../src/guestfs-actions.pod:7208
17993 msgid "guestfs_wc_w"
17997 #: ../src/guestfs-actions.pod:7210
18001 " guestfs_wc_w (guestfs_h *g,\n"
18002 " const char *path);\n"
18007 #: ../src/guestfs-actions.pod:7214 ../fish/guestfish-actions.pod:4824
18009 "This command counts the words in a file, using the C<wc -w> external command."
18013 #: ../src/guestfs-actions.pod:7221
18014 msgid "guestfs_write"
18018 #: ../src/guestfs-actions.pod:7223
18022 " guestfs_write (guestfs_h *g,\n"
18023 " const char *path,\n"
18024 " const char *content,\n"
18025 " size_t content_size);\n"
18030 #: ../src/guestfs-actions.pod:7229 ../fish/guestfish-actions.pod:4831
18032 "This call creates a file called C<path>. The content of the file is the "
18033 "string C<content> (which can contain any 8 bit data)."
18037 #: ../src/guestfs-actions.pod:7239
18038 msgid "guestfs_write_file"
18042 #: ../src/guestfs-actions.pod:7241
18046 " guestfs_write_file (guestfs_h *g,\n"
18047 " const char *path,\n"
18048 " const char *content,\n"
18054 #: ../src/guestfs-actions.pod:7247 ../fish/guestfish-actions.pod:4841
18056 "This call creates a file called C<path>. The contents of the file is the "
18057 "string C<content> (which can contain any 8 bit data), with length C<size>."
18061 #: ../src/guestfs-actions.pod:7251 ../fish/guestfish-actions.pod:4845
18063 "As a special case, if C<size> is C<0> then the length is calculated using "
18064 "C<strlen> (so in this case the content cannot contain embedded ASCII NULs)."
18068 #: ../src/guestfs-actions.pod:7255 ../fish/guestfish-actions.pod:4849
18070 "I<NB.> Owing to a bug, writing content containing ASCII NUL characters does "
18071 "I<not> work, even if the length is specified."
18075 #: ../src/guestfs-actions.pod:7263 ../fish/guestfish-actions.pod:4855
18077 "This function is deprecated. In new code, use the C<write> call instead."
18081 #: ../src/guestfs-actions.pod:7272
18082 msgid "guestfs_zegrep"
18086 #: ../src/guestfs-actions.pod:7274
18090 " guestfs_zegrep (guestfs_h *g,\n"
18091 " const char *regex,\n"
18092 " const char *path);\n"
18097 #: ../src/guestfs-actions.pod:7279 ../fish/guestfish-actions.pod:4866
18099 "This calls the external C<zegrep> program and returns the matching lines."
18103 #: ../src/guestfs-actions.pod:7291
18104 msgid "guestfs_zegrepi"
18108 #: ../src/guestfs-actions.pod:7293
18112 " guestfs_zegrepi (guestfs_h *g,\n"
18113 " const char *regex,\n"
18114 " const char *path);\n"
18119 #: ../src/guestfs-actions.pod:7298 ../fish/guestfish-actions.pod:4876
18121 "This calls the external C<zegrep -i> program and returns the matching lines."
18125 #: ../src/guestfs-actions.pod:7310
18126 msgid "guestfs_zero"
18130 #: ../src/guestfs-actions.pod:7312
18134 " guestfs_zero (guestfs_h *g,\n"
18135 " const char *device);\n"
18140 #: ../src/guestfs-actions.pod:7316 ../fish/guestfish-actions.pod:4886
18141 msgid "This command writes zeroes over the first few blocks of C<device>."
18145 #: ../src/guestfs-actions.pod:7318 ../fish/guestfish-actions.pod:4888
18147 "How many blocks are zeroed isn't specified (but it's I<not> enough to "
18148 "securely wipe the device). It should be sufficient to remove any partition "
18149 "tables, filesystem superblocks and so on."
18153 #: ../src/guestfs-actions.pod:7322
18154 msgid "See also: C<guestfs_zero_device>, C<guestfs_scrub_device>."
18158 #: ../src/guestfs-actions.pod:7333
18159 msgid "guestfs_zero_device"
18163 #: ../src/guestfs-actions.pod:7335
18167 " guestfs_zero_device (guestfs_h *g,\n"
18168 " const char *device);\n"
18173 #: ../src/guestfs-actions.pod:7339
18175 "This command writes zeroes over the entire C<device>. Compare with "
18176 "C<guestfs_zero> which just zeroes the first few blocks of a device."
18180 #: ../src/guestfs-actions.pod:7353
18181 msgid "(Added in 1.3.1)"
18185 #: ../src/guestfs-actions.pod:7355
18186 msgid "guestfs_zerofree"
18190 #: ../src/guestfs-actions.pod:7357
18194 " guestfs_zerofree (guestfs_h *g,\n"
18195 " const char *device);\n"
18200 #: ../src/guestfs-actions.pod:7361 ../fish/guestfish-actions.pod:4909
18202 "This runs the I<zerofree> program on C<device>. This program claims to zero "
18203 "unused inodes and disk blocks on an ext2/3 filesystem, thus making it "
18204 "possible to compress the filesystem more effectively."
18208 #: ../src/guestfs-actions.pod:7366 ../fish/guestfish-actions.pod:4914
18209 msgid "You should B<not> run this program if the filesystem is mounted."
18213 #: ../src/guestfs-actions.pod:7369 ../fish/guestfish-actions.pod:4917
18215 "It is possible that using this program can damage the filesystem or data on "
18220 #: ../src/guestfs-actions.pod:7376
18221 msgid "guestfs_zfgrep"
18225 #: ../src/guestfs-actions.pod:7378
18229 " guestfs_zfgrep (guestfs_h *g,\n"
18230 " const char *pattern,\n"
18231 " const char *path);\n"
18236 #: ../src/guestfs-actions.pod:7383 ../fish/guestfish-actions.pod:4924
18238 "This calls the external C<zfgrep> program and returns the matching lines."
18242 #: ../src/guestfs-actions.pod:7395
18243 msgid "guestfs_zfgrepi"
18247 #: ../src/guestfs-actions.pod:7397
18251 " guestfs_zfgrepi (guestfs_h *g,\n"
18252 " const char *pattern,\n"
18253 " const char *path);\n"
18258 #: ../src/guestfs-actions.pod:7402 ../fish/guestfish-actions.pod:4934
18260 "This calls the external C<zfgrep -i> program and returns the matching lines."
18264 #: ../src/guestfs-actions.pod:7414
18265 msgid "guestfs_zfile"
18269 #: ../src/guestfs-actions.pod:7416
18273 " guestfs_zfile (guestfs_h *g,\n"
18274 " const char *meth,\n"
18275 " const char *path);\n"
18280 #: ../src/guestfs-actions.pod:7421 ../fish/guestfish-actions.pod:4944
18282 "This command runs C<file> after first decompressing C<path> using C<method>."
18286 #: ../src/guestfs-actions.pod:7424 ../fish/guestfish-actions.pod:4947
18287 msgid "C<method> must be one of C<gzip>, C<compress> or C<bzip2>."
18291 #: ../src/guestfs-actions.pod:7426
18293 "Since 1.0.63, use C<guestfs_file> instead which can now process compressed "
18298 #: ../src/guestfs-actions.pod:7432 ../fish/guestfish-actions.pod:4952
18300 "This function is deprecated. In new code, use the C<file> call instead."
18304 #: ../src/guestfs-actions.pod:7441
18305 msgid "guestfs_zgrep"
18309 #: ../src/guestfs-actions.pod:7443
18313 " guestfs_zgrep (guestfs_h *g,\n"
18314 " const char *regex,\n"
18315 " const char *path);\n"
18320 #: ../src/guestfs-actions.pod:7448 ../fish/guestfish-actions.pod:4963
18322 "This calls the external C<zgrep> program and returns the matching lines."
18326 #: ../src/guestfs-actions.pod:7460
18327 msgid "guestfs_zgrepi"
18331 #: ../src/guestfs-actions.pod:7462
18335 " guestfs_zgrepi (guestfs_h *g,\n"
18336 " const char *regex,\n"
18337 " const char *path);\n"
18342 #: ../src/guestfs-actions.pod:7467 ../fish/guestfish-actions.pod:4973
18344 "This calls the external C<zgrep -i> program and returns the matching lines."
18348 #: ../src/guestfs-availability.pod:3
18353 #: ../src/guestfs-availability.pod:5
18355 "The following functions: L</guestfs_aug_clear> L</guestfs_aug_close> L</"
18356 "guestfs_aug_defnode> L</guestfs_aug_defvar> L</guestfs_aug_get> L</"
18357 "guestfs_aug_init> L</guestfs_aug_insert> L</guestfs_aug_load> L</"
18358 "guestfs_aug_ls> L</guestfs_aug_match> L</guestfs_aug_mv> L</guestfs_aug_rm> "
18359 "L</guestfs_aug_save> L</guestfs_aug_set>"
18363 #: ../src/guestfs-availability.pod:21
18368 #: ../src/guestfs-availability.pod:23
18370 "The following functions: L</guestfs_inotify_add_watch> L</"
18371 "guestfs_inotify_close> L</guestfs_inotify_files> L</guestfs_inotify_init> L</"
18372 "guestfs_inotify_read> L</guestfs_inotify_rm_watch>"
18376 #: ../src/guestfs-availability.pod:31
18377 msgid "B<linuxfsuuid>"
18381 #: ../src/guestfs-availability.pod:33
18383 "The following functions: L</guestfs_mke2fs_JU> L</guestfs_mke2journal_U> L</"
18384 "guestfs_mkswap_U> L</guestfs_swapoff_uuid> L</guestfs_swapon_uuid>"
18388 #: ../src/guestfs-availability.pod:40
18389 msgid "B<linuxmodules>"
18393 #: ../src/guestfs-availability.pod:42
18394 msgid "The following functions: L</guestfs_modprobe>"
18398 #: ../src/guestfs-availability.pod:45
18399 msgid "B<linuxxattrs>"
18403 #: ../src/guestfs-availability.pod:47
18405 "The following functions: L</guestfs_getxattr> L</guestfs_getxattrs> L</"
18406 "guestfs_lgetxattr> L</guestfs_lgetxattrs> L</guestfs_lremovexattr> L</"
18407 "guestfs_lsetxattr> L</guestfs_lxattrlist> L</guestfs_removexattr> L</"
18408 "guestfs_setxattr>"
18412 #: ../src/guestfs-availability.pod:58
18417 #: ../src/guestfs-availability.pod:60
18419 "The following functions: L</guestfs_luks_add_key> L</guestfs_luks_close> L</"
18420 "guestfs_luks_format> L</guestfs_luks_format_cipher> L</"
18421 "guestfs_luks_kill_slot> L</guestfs_luks_open> L</guestfs_luks_open_ro>"
18425 #: ../src/guestfs-availability.pod:69
18430 #: ../src/guestfs-availability.pod:71
18432 "The following functions: L</guestfs_is_lv> L</guestfs_lvcreate> L</"
18433 "guestfs_lvm_remove_all> L</guestfs_lvm_set_filter> L</guestfs_lvremove> L</"
18434 "guestfs_lvresize> L</guestfs_lvresize_free> L</guestfs_lvs> L</"
18435 "guestfs_lvs_full> L</guestfs_pvcreate> L</guestfs_pvremove> L</"
18436 "guestfs_pvresize> L</guestfs_pvresize_size> L</guestfs_pvs> L</"
18437 "guestfs_pvs_full> L</guestfs_vg_activate> L</guestfs_vg_activate_all> L</"
18438 "guestfs_vgcreate> L</guestfs_vgremove> L</guestfs_vgs> L</guestfs_vgs_full>"
18442 #: ../src/guestfs-availability.pod:94
18447 #: ../src/guestfs-availability.pod:96
18449 "The following functions: L</guestfs_mkfifo> L</guestfs_mknod> L</"
18450 "guestfs_mknod_b> L</guestfs_mknod_c>"
18454 #: ../src/guestfs-availability.pod:102
18459 #: ../src/guestfs-availability.pod:104
18460 msgid "The following functions: L</guestfs_ntfs_3g_probe>"
18464 #: ../src/guestfs-availability.pod:107
18465 msgid "B<ntfsprogs>"
18469 #: ../src/guestfs-availability.pod:109
18471 "The following functions: L</guestfs_ntfsresize> L</guestfs_ntfsresize_size>"
18475 #: ../src/guestfs-availability.pod:113
18476 msgid "B<realpath>"
18480 #: ../src/guestfs-availability.pod:115
18481 msgid "The following functions: L</guestfs_realpath>"
18485 #: ../src/guestfs-availability.pod:118
18490 #: ../src/guestfs-availability.pod:120
18492 "The following functions: L</guestfs_scrub_device> L</guestfs_scrub_file> L</"
18493 "guestfs_scrub_freespace>"
18497 #: ../src/guestfs-availability.pod:125
18502 #: ../src/guestfs-availability.pod:127
18503 msgid "The following functions: L</guestfs_getcon> L</guestfs_setcon>"
18507 #: ../src/guestfs-availability.pod:131
18512 #: ../src/guestfs-availability.pod:133
18513 msgid "The following functions: L</guestfs_txz_in> L</guestfs_txz_out>"
18517 #: ../src/guestfs-availability.pod:137
18518 msgid "B<zerofree>"
18522 #: ../src/guestfs-availability.pod:139
18523 msgid "The following functions: L</guestfs_zerofree>"
18527 #: ../src/guestfs-structs.pod:1
18528 msgid "guestfs_int_bool"
18532 #: ../src/guestfs-structs.pod:3
18535 " struct guestfs_int_bool {\n"
18543 #: ../src/guestfs-structs.pod:8
18546 " struct guestfs_int_bool_list {\n"
18547 " uint32_t len; /* Number of elements in list. */\n"
18548 " struct guestfs_int_bool *val; /* Elements. */\n"
18554 #: ../src/guestfs-structs.pod:13
18557 " void guestfs_free_int_bool (struct guestfs_free_int_bool *);\n"
18558 " void guestfs_free_int_bool_list (struct guestfs_free_int_bool_list *);\n"
18563 #: ../src/guestfs-structs.pod:16
18564 msgid "guestfs_lvm_pv"
18568 #: ../src/guestfs-structs.pod:18
18571 " struct guestfs_lvm_pv {\n"
18572 " char *pv_name;\n"
18573 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
18574 " char pv_uuid[32];\n"
18576 " uint64_t pv_size;\n"
18577 " uint64_t dev_size;\n"
18578 " uint64_t pv_free;\n"
18579 " uint64_t pv_used;\n"
18580 " char *pv_attr;\n"
18581 " int64_t pv_pe_count;\n"
18582 " int64_t pv_pe_alloc_count;\n"
18583 " char *pv_tags;\n"
18584 " uint64_t pe_start;\n"
18585 " int64_t pv_mda_count;\n"
18586 " uint64_t pv_mda_free;\n"
18592 #: ../src/guestfs-structs.pod:36
18595 " struct guestfs_lvm_pv_list {\n"
18596 " uint32_t len; /* Number of elements in list. */\n"
18597 " struct guestfs_lvm_pv *val; /* Elements. */\n"
18603 #: ../src/guestfs-structs.pod:41
18606 " void guestfs_free_lvm_pv (struct guestfs_free_lvm_pv *);\n"
18607 " void guestfs_free_lvm_pv_list (struct guestfs_free_lvm_pv_list *);\n"
18612 #: ../src/guestfs-structs.pod:44
18613 msgid "guestfs_lvm_vg"
18617 #: ../src/guestfs-structs.pod:46
18620 " struct guestfs_lvm_vg {\n"
18621 " char *vg_name;\n"
18622 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
18623 " char vg_uuid[32];\n"
18625 " char *vg_attr;\n"
18626 " uint64_t vg_size;\n"
18627 " uint64_t vg_free;\n"
18628 " char *vg_sysid;\n"
18629 " uint64_t vg_extent_size;\n"
18630 " int64_t vg_extent_count;\n"
18631 " int64_t vg_free_count;\n"
18632 " int64_t max_lv;\n"
18633 " int64_t max_pv;\n"
18634 " int64_t pv_count;\n"
18635 " int64_t lv_count;\n"
18636 " int64_t snap_count;\n"
18637 " int64_t vg_seqno;\n"
18638 " char *vg_tags;\n"
18639 " int64_t vg_mda_count;\n"
18640 " uint64_t vg_mda_free;\n"
18646 #: ../src/guestfs-structs.pod:69
18649 " struct guestfs_lvm_vg_list {\n"
18650 " uint32_t len; /* Number of elements in list. */\n"
18651 " struct guestfs_lvm_vg *val; /* Elements. */\n"
18657 #: ../src/guestfs-structs.pod:74
18660 " void guestfs_free_lvm_vg (struct guestfs_free_lvm_vg *);\n"
18661 " void guestfs_free_lvm_vg_list (struct guestfs_free_lvm_vg_list *);\n"
18666 #: ../src/guestfs-structs.pod:77
18667 msgid "guestfs_lvm_lv"
18671 #: ../src/guestfs-structs.pod:79
18674 " struct guestfs_lvm_lv {\n"
18675 " char *lv_name;\n"
18676 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
18677 " char lv_uuid[32];\n"
18678 " char *lv_attr;\n"
18679 " int64_t lv_major;\n"
18680 " int64_t lv_minor;\n"
18681 " int64_t lv_kernel_major;\n"
18682 " int64_t lv_kernel_minor;\n"
18683 " uint64_t lv_size;\n"
18684 " int64_t seg_count;\n"
18686 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
18687 " float snap_percent;\n"
18688 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
18689 " float copy_percent;\n"
18690 " char *move_pv;\n"
18691 " char *lv_tags;\n"
18692 " char *mirror_log;\n"
18693 " char *modules;\n"
18699 #: ../src/guestfs-structs.pod:101
18702 " struct guestfs_lvm_lv_list {\n"
18703 " uint32_t len; /* Number of elements in list. */\n"
18704 " struct guestfs_lvm_lv *val; /* Elements. */\n"
18710 #: ../src/guestfs-structs.pod:106
18713 " void guestfs_free_lvm_lv (struct guestfs_free_lvm_lv *);\n"
18714 " void guestfs_free_lvm_lv_list (struct guestfs_free_lvm_lv_list *);\n"
18719 #: ../src/guestfs-structs.pod:111
18722 " struct guestfs_stat {\n"
18726 " int64_t nlink;\n"
18731 " int64_t blksize;\n"
18732 " int64_t blocks;\n"
18733 " int64_t atime;\n"
18734 " int64_t mtime;\n"
18735 " int64_t ctime;\n"
18741 #: ../src/guestfs-structs.pod:127
18744 " struct guestfs_stat_list {\n"
18745 " uint32_t len; /* Number of elements in list. */\n"
18746 " struct guestfs_stat *val; /* Elements. */\n"
18752 #: ../src/guestfs-structs.pod:132
18755 " void guestfs_free_stat (struct guestfs_free_stat *);\n"
18756 " void guestfs_free_stat_list (struct guestfs_free_stat_list *);\n"
18761 #: ../src/guestfs-structs.pod:137
18764 " struct guestfs_statvfs {\n"
18765 " int64_t bsize;\n"
18766 " int64_t frsize;\n"
18767 " int64_t blocks;\n"
18768 " int64_t bfree;\n"
18769 " int64_t bavail;\n"
18770 " int64_t files;\n"
18771 " int64_t ffree;\n"
18772 " int64_t favail;\n"
18775 " int64_t namemax;\n"
18781 #: ../src/guestfs-structs.pod:151
18784 " struct guestfs_statvfs_list {\n"
18785 " uint32_t len; /* Number of elements in list. */\n"
18786 " struct guestfs_statvfs *val; /* Elements. */\n"
18792 #: ../src/guestfs-structs.pod:156
18795 " void guestfs_free_statvfs (struct guestfs_free_statvfs *);\n"
18796 " void guestfs_free_statvfs_list (struct guestfs_free_statvfs_list *);\n"
18801 #: ../src/guestfs-structs.pod:159
18802 msgid "guestfs_dirent"
18806 #: ../src/guestfs-structs.pod:161
18809 " struct guestfs_dirent {\n"
18818 #: ../src/guestfs-structs.pod:167
18821 " struct guestfs_dirent_list {\n"
18822 " uint32_t len; /* Number of elements in list. */\n"
18823 " struct guestfs_dirent *val; /* Elements. */\n"
18829 #: ../src/guestfs-structs.pod:172
18832 " void guestfs_free_dirent (struct guestfs_free_dirent *);\n"
18833 " void guestfs_free_dirent_list (struct guestfs_free_dirent_list *);\n"
18838 #: ../src/guestfs-structs.pod:177
18841 " struct guestfs_version {\n"
18842 " int64_t major;\n"
18843 " int64_t minor;\n"
18844 " int64_t release;\n"
18851 #: ../src/guestfs-structs.pod:184
18854 " struct guestfs_version_list {\n"
18855 " uint32_t len; /* Number of elements in list. */\n"
18856 " struct guestfs_version *val; /* Elements. */\n"
18862 #: ../src/guestfs-structs.pod:189
18865 " void guestfs_free_version (struct guestfs_free_version *);\n"
18866 " void guestfs_free_version_list (struct guestfs_free_version_list *);\n"
18871 #: ../src/guestfs-structs.pod:192
18872 msgid "guestfs_xattr"
18876 #: ../src/guestfs-structs.pod:194
18879 " struct guestfs_xattr {\n"
18880 " char *attrname;\n"
18881 " /* The next two fields describe a byte array. */\n"
18882 " uint32_t attrval_len;\n"
18883 " char *attrval;\n"
18889 #: ../src/guestfs-structs.pod:201
18892 " struct guestfs_xattr_list {\n"
18893 " uint32_t len; /* Number of elements in list. */\n"
18894 " struct guestfs_xattr *val; /* Elements. */\n"
18900 #: ../src/guestfs-structs.pod:206
18903 " void guestfs_free_xattr (struct guestfs_free_xattr *);\n"
18904 " void guestfs_free_xattr_list (struct guestfs_free_xattr_list *);\n"
18909 #: ../src/guestfs-structs.pod:209
18910 msgid "guestfs_inotify_event"
18914 #: ../src/guestfs-structs.pod:211
18917 " struct guestfs_inotify_event {\n"
18918 " int64_t in_wd;\n"
18919 " uint32_t in_mask;\n"
18920 " uint32_t in_cookie;\n"
18921 " char *in_name;\n"
18927 #: ../src/guestfs-structs.pod:218
18930 " struct guestfs_inotify_event_list {\n"
18931 " uint32_t len; /* Number of elements in list. */\n"
18932 " struct guestfs_inotify_event *val; /* Elements. */\n"
18938 #: ../src/guestfs-structs.pod:223
18941 " void guestfs_free_inotify_event (struct guestfs_free_inotify_event *);\n"
18942 " void guestfs_free_inotify_event_list (struct guestfs_free_inotify_event_list *);\n"
18947 #: ../src/guestfs-structs.pod:226
18948 msgid "guestfs_partition"
18952 #: ../src/guestfs-structs.pod:228
18955 " struct guestfs_partition {\n"
18956 " int32_t part_num;\n"
18957 " uint64_t part_start;\n"
18958 " uint64_t part_end;\n"
18959 " uint64_t part_size;\n"
18965 #: ../src/guestfs-structs.pod:235
18968 " struct guestfs_partition_list {\n"
18969 " uint32_t len; /* Number of elements in list. */\n"
18970 " struct guestfs_partition *val; /* Elements. */\n"
18976 #: ../src/guestfs-structs.pod:240
18979 " void guestfs_free_partition (struct guestfs_free_partition *);\n"
18980 " void guestfs_free_partition_list (struct guestfs_free_partition_list *);\n"
18985 #: ../src/guestfs-structs.pod:243
18986 msgid "guestfs_application"
18990 #: ../src/guestfs-structs.pod:245
18993 " struct guestfs_application {\n"
18994 " char *app_name;\n"
18995 " char *app_display_name;\n"
18996 " int32_t app_epoch;\n"
18997 " char *app_version;\n"
18998 " char *app_release;\n"
18999 " char *app_install_path;\n"
19000 " char *app_trans_path;\n"
19001 " char *app_publisher;\n"
19002 " char *app_url;\n"
19003 " char *app_source_package;\n"
19004 " char *app_summary;\n"
19005 " char *app_description;\n"
19011 #: ../src/guestfs-structs.pod:260
19014 " struct guestfs_application_list {\n"
19015 " uint32_t len; /* Number of elements in list. */\n"
19016 " struct guestfs_application *val; /* Elements. */\n"
19022 #: ../src/guestfs-structs.pod:265
19025 " void guestfs_free_application (struct guestfs_free_application *);\n"
19026 " void guestfs_free_application_list (struct guestfs_free_application_list *);\n"
19031 #: ../fish/guestfish.pod:5
19032 msgid "guestfish - the libguestfs Filesystem Interactive SHell"
19036 #: ../fish/guestfish.pod:9
19039 " guestfish [--options] [commands]\n"
19044 #: ../fish/guestfish.pod:11
19052 #: ../fish/guestfish.pod:13
19055 " guestfish [--ro|--rw] -a disk.img\n"
19060 #: ../fish/guestfish.pod:15
19063 " guestfish [--ro|--rw] -a disk.img -m dev[:mountpoint]\n"
19068 #: ../fish/guestfish.pod:17
19071 " guestfish -d libvirt-domain\n"
19076 #: ../fish/guestfish.pod:19
19079 " guestfish [--ro|--rw] -a disk.img -i\n"
19084 #: ../fish/guestfish.pod:21
19087 " guestfish -d libvirt-domain -i\n"
19092 #: ../fish/guestfish.pod:23 ../fuse/guestmount.pod:15 ../tools/virt-edit.pl:44
19093 #: ../tools/virt-win-reg.pl:51 ../tools/virt-tar.pl:64
19098 #: ../fish/guestfish.pod:25
19100 "Using guestfish in read/write mode on live virtual machines can be "
19101 "dangerous, potentially causing disk corruption. Use the I<--ro> (read-only) "
19102 "option to use guestfish safely if the disk image or virtual machine might be "
19107 #: ../fish/guestfish.pod:32
19109 "Guestfish is a shell and command-line tool for examining and modifying "
19110 "virtual machine filesystems. It uses libguestfs and exposes all of the "
19111 "functionality of the guestfs API, see L<guestfs(3)>."
19115 #: ../fish/guestfish.pod:36
19117 "Guestfish gives you structured access to the libguestfs API, from shell "
19118 "scripts or the command line or interactively. If you want to rescue a "
19119 "broken virtual machine image, you should look at the L<virt-rescue(1)> "
19124 #: ../fish/guestfish.pod:41 ../fish/guestfish.pod:942
19125 #: ../fuse/guestmount.pod:39 ../tools/virt-edit.pl:63 ../tools/virt-tar.pl:50
19130 #: ../fish/guestfish.pod:43
19131 msgid "As an interactive shell"
19135 #: ../fish/guestfish.pod:45
19143 #: ../fish/guestfish.pod:47
19146 " Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
19147 " editing virtual machine filesystems.\n"
19152 #: ../fish/guestfish.pod:50
19155 " Type: 'help' for a list of commands\n"
19156 " 'man' to read the manual\n"
19157 " 'quit' to quit the shell\n"
19162 #: ../fish/guestfish.pod:54
19165 " ><fs> add-ro disk.img\n"
19167 " ><fs> list-filesystems\n"
19168 " /dev/sda1: ext4\n"
19169 " /dev/vg_guest/lv_root: ext4\n"
19170 " /dev/vg_guest/lv_swap: swap\n"
19171 " ><fs> mount /dev/vg_guest/lv_root /\n"
19172 " ><fs> cat /etc/fstab\n"
19174 " # Created by anaconda\n"
19181 #: ../fish/guestfish.pod:67
19182 msgid "From shell scripts"
19186 #: ../fish/guestfish.pod:69
19187 msgid "Create a new C</etc/motd> file in a guest or disk image:"
19191 #: ../fish/guestfish.pod:71
19194 " guestfish <<_EOF_\n"
19197 " mount /dev/vg_guest/lv_root /\n"
19198 " write /etc/motd \"Welcome, new users\"\n"
19204 #: ../fish/guestfish.pod:78
19205 msgid "List the LVM logical volumes in a disk image:"
19209 #: ../fish/guestfish.pod:80
19212 " guestfish -a disk.img --ro <<_EOF_\n"
19220 #: ../fish/guestfish.pod:85
19221 msgid "List all the filesystems in a disk image:"
19225 #: ../fish/guestfish.pod:87
19228 " guestfish -a disk.img --ro <<_EOF_\n"
19230 " list-filesystems\n"
19236 #: ../fish/guestfish.pod:92
19237 msgid "On one command line"
19241 #: ../fish/guestfish.pod:94
19242 msgid "Update C</etc/resolv.conf> in a guest:"
19246 #: ../fish/guestfish.pod:96
19250 " add disk.img : run : mount /dev/vg_guest/lv_root / : \\\n"
19251 " write /etc/resolv.conf \"nameserver 1.2.3.4\"\n"
19256 #: ../fish/guestfish.pod:100
19257 msgid "Edit C</boot/grub/grub.conf> interactively:"
19261 #: ../fish/guestfish.pod:102
19264 " guestfish --rw --add disk.img \\\n"
19265 " --mount /dev/vg_guest/lv_root \\\n"
19266 " --mount /dev/sda1:/boot \\\n"
19267 " edit /boot/grub/grub.conf\n"
19272 #: ../fish/guestfish.pod:107
19273 msgid "Mount disks automatically"
19277 #: ../fish/guestfish.pod:109
19279 "Use the I<-i> option to automatically mount the disks from a virtual machine:"
19283 #: ../fish/guestfish.pod:112
19286 " guestfish --ro -a disk.img -i cat /etc/group\n"
19291 #: ../fish/guestfish.pod:114
19294 " guestfish --ro -d libvirt-domain -i cat /etc/group\n"
19299 #: ../fish/guestfish.pod:116
19300 msgid "Another way to edit C</boot/grub/grub.conf> interactively is:"
19304 #: ../fish/guestfish.pod:118
19307 " guestfish --rw -a disk.img -i edit /boot/grub/grub.conf\n"
19312 #: ../fish/guestfish.pod:120
19313 msgid "As a script interpreter"
19317 #: ../fish/guestfish.pod:122
19318 msgid "Create a 100MB disk containing an ext2-formatted partition:"
19322 #: ../fish/guestfish.pod:124
19325 " #!/usr/bin/guestfish -f\n"
19326 " sparse test1.img 100M\n"
19328 " part-disk /dev/sda mbr\n"
19329 " mkfs ext2 /dev/sda1\n"
19334 #: ../fish/guestfish.pod:130
19335 msgid "Start with a prepared disk"
19339 #: ../fish/guestfish.pod:132
19341 "An alternate way to create a 100MB disk called C<test1.img> containing a "
19342 "single ext2-formatted partition:"
19346 #: ../fish/guestfish.pod:135
19349 " guestfish -N fs\n"
19354 #: ../fish/guestfish.pod:137
19355 msgid "To list what is available do:"
19359 #: ../fish/guestfish.pod:139 ../fish/guestfish.pod:933
19362 " guestfish -N help | less\n"
19367 #: ../fish/guestfish.pod:141
19368 msgid "Remote control"
19372 #: ../fish/guestfish.pod:143
19375 " eval \"`guestfish --listen`\"\n"
19376 " guestfish --remote add-ro disk.img\n"
19377 " guestfish --remote run\n"
19378 " guestfish --remote lvs\n"
19383 #: ../fish/guestfish.pod:148 ../test-tool/libguestfs-test-tool.pod:37
19384 #: ../fuse/guestmount.pod:73 ../tools/virt-edit.pl:81
19385 #: ../tools/virt-win-reg.pl:96 ../tools/virt-list-filesystems.pl:53
19386 #: ../tools/virt-tar.pl:103 ../tools/virt-make-fs.pl:153
19387 #: ../tools/virt-list-partitions.pl:54
19392 #: ../fish/guestfish.pod:152 ../fuse/guestmount.pod:131
19393 #: ../tools/virt-edit.pl:89 ../tools/virt-win-reg.pl:104
19394 #: ../tools/virt-list-filesystems.pl:61 ../tools/virt-tar.pl:111
19395 #: ../tools/virt-make-fs.pl:161 ../tools/virt-list-partitions.pl:62
19400 #: ../fish/guestfish.pod:154
19401 msgid "Displays general help on options."
19405 #: ../fish/guestfish.pod:156
19410 #: ../fish/guestfish.pod:158
19411 msgid "B<--cmd-help>"
19415 #: ../fish/guestfish.pod:160
19416 msgid "Lists all available guestfish commands."
19420 #: ../fish/guestfish.pod:162
19425 #: ../fish/guestfish.pod:164
19426 msgid "B<--cmd-help cmd>"
19430 #: ../fish/guestfish.pod:166
19431 msgid "Displays detailed help on a single command C<cmd>."
19435 #: ../fish/guestfish.pod:168
19436 msgid "B<-a image>"
19440 #: ../fish/guestfish.pod:170
19441 msgid "B<--add image>"
19445 #: ../fish/guestfish.pod:172
19446 msgid "Add a block device or virtual machine image to the shell."
19450 #: ../fish/guestfish.pod:174 ../fuse/guestmount.pod:81
19452 "The format of the disk image is auto-detected. To override this and force a "
19453 "particular format use the I<--format=..> option."
19457 #: ../fish/guestfish.pod:177
19459 "Using this flag is mostly equivalent to using the C<add> command, with "
19460 "C<readonly:true> if the I<--ro> flag was given, and with C<format:...> if "
19461 "the I<--format:...> flag was given."
19465 #: ../fish/guestfish.pod:181
19470 #: ../fish/guestfish.pod:183
19471 msgid "B<--connect URI>"
19475 #: ../fish/guestfish.pod:185 ../fuse/guestmount.pod:86
19477 "When used in conjunction with the I<-d> option, this specifies the libvirt "
19478 "URI to use. The default is to use the default libvirt connection."
19482 #: ../fish/guestfish.pod:189
19487 #: ../fish/guestfish.pod:191
19489 "If using the I<--listen> option and a csh-like shell, use this option. See "
19490 "section L</REMOTE CONTROL AND CSH> below."
19494 #: ../fish/guestfish.pod:194
19495 msgid "B<-d libvirt-domain>"
19499 #: ../fish/guestfish.pod:196
19500 msgid "B<--domain libvirt-domain>"
19504 #: ../fish/guestfish.pod:198 ../fuse/guestmount.pod:92
19506 "Add disks from the named libvirt domain. If the I<--ro> option is also "
19507 "used, then any libvirt domain can be used. However in write mode, only "
19508 "libvirt domains which are shut down can be named here."
19512 #: ../fish/guestfish.pod:202
19514 "Using this flag is mostly equivalent to using the C<add-domain> command, "
19515 "with C<readonly:true> if the I<--ro> flag was given, and with C<format:...> "
19516 "if the I<--format:...> flag was given."
19520 #: ../fish/guestfish.pod:206
19525 #: ../fish/guestfish.pod:208
19526 msgid "B<--no-dest-paths>"
19530 #: ../fish/guestfish.pod:210
19532 "Don't tab-complete paths on the guest filesystem. It is useful to be able "
19533 "to hit the tab key to complete paths on the guest filesystem, but this "
19534 "causes extra \"hidden\" guestfs calls to be made, so this option is here to "
19535 "allow this feature to be disabled."
19539 #: ../fish/guestfish.pod:215 ../fuse/guestmount.pod:108
19540 msgid "B<--echo-keys>"
19544 #: ../fish/guestfish.pod:217 ../fuse/guestmount.pod:110
19546 "When prompting for keys and passphrases, guestfish normally turns echoing "
19547 "off so you cannot see what you are typing. If you are not worried about "
19548 "Tempest attacks and there is no one else in the room you can specify this "
19549 "flag to see what you are typing."
19553 #: ../fish/guestfish.pod:222
19558 #: ../fish/guestfish.pod:224
19559 msgid "B<--file file>"
19563 #: ../fish/guestfish.pod:226
19564 msgid "Read commands from C<file>. To write pure guestfish scripts, use:"
19568 #: ../fish/guestfish.pod:229
19571 " #!/usr/bin/guestfish -f\n"
19576 #: ../fish/guestfish.pod:231
19577 msgid "B<--format=raw|qcow2|..>"
19581 #: ../fish/guestfish.pod:233
19582 msgid "B<--format>"
19586 #: ../fish/guestfish.pod:235 ../fuse/guestmount.pod:117
19588 "The default for the I<-a> option is to auto-detect the format of the disk "
19589 "image. Using this forces the disk format for I<-a> options which follow on "
19590 "the command line. Using I<--format> with no argument switches back to auto-"
19591 "detection for subsequent I<-a> options."
19595 #: ../fish/guestfish.pod:242
19598 " guestfish --format=raw -a disk.img\n"
19603 #: ../fish/guestfish.pod:244
19604 msgid "forces raw format (no auto-detection) for C<disk.img>."
19608 #: ../fish/guestfish.pod:246
19611 " guestfish --format=raw -a disk.img --format -a another.img\n"
19616 #: ../fish/guestfish.pod:248
19618 "forces raw format (no auto-detection) for C<disk.img> and reverts to auto-"
19619 "detection for C<another.img>."
19623 #: ../fish/guestfish.pod:251
19625 "If you have untrusted raw-format guest disk images, you should use this "
19626 "option to specify the disk format. This avoids a possible security problem "
19627 "with malicious guests (CVE-2010-3851). See also L</add-drive-opts>."
19631 #: ../fish/guestfish.pod:256
19636 #: ../fish/guestfish.pod:258
19637 msgid "B<--inspector>"
19641 #: ../fish/guestfish.pod:260 ../fuse/guestmount.pod:137
19643 "Using L<virt-inspector(1)> code, inspect the disks looking for an operating "
19644 "system and mount filesystems as they would be mounted on the real virtual "
19649 #: ../fish/guestfish.pod:264
19650 msgid "Typical usage is either:"
19654 #: ../fish/guestfish.pod:266
19657 " guestfish -d myguest -i\n"
19662 #: ../fish/guestfish.pod:268
19663 msgid "(for an inactive libvirt domain called I<myguest>), or:"
19667 #: ../fish/guestfish.pod:270
19670 " guestfish --ro -d myguest -i\n"
19675 #: ../fish/guestfish.pod:272
19676 msgid "(for active domains, readonly), or specify the block device directly:"
19680 #: ../fish/guestfish.pod:274
19683 " guestfish --rw -a /dev/Guests/MyGuest -i\n"
19688 #: ../fish/guestfish.pod:276
19690 "Note that the command line syntax changed slightly over older versions of "
19691 "guestfish. You can still use the old syntax:"
19695 #: ../fish/guestfish.pod:279
19698 " guestfish [--ro] -i disk.img\n"
19703 #: ../fish/guestfish.pod:281
19706 " guestfish [--ro] -i libvirt-domain\n"
19711 #: ../fish/guestfish.pod:283
19713 "Using this flag is mostly equivalent to using the C<inspect-os> command and "
19714 "then using other commands to mount the filesystems that were found."
19718 #: ../fish/guestfish.pod:287 ../fuse/guestmount.pod:141
19719 msgid "B<--keys-from-stdin>"
19723 #: ../fish/guestfish.pod:289 ../fuse/guestmount.pod:143
19725 "Read key or passphrase parameters from stdin. The default is to try to read "
19726 "passphrases from the user by opening C</dev/tty>."
19730 #: ../fish/guestfish.pod:292
19731 msgid "B<--listen>"
19735 #: ../fish/guestfish.pod:294
19737 "Fork into the background and listen for remote commands. See section L</"
19738 "REMOTE CONTROL GUESTFISH OVER A SOCKET> below."
19742 #: ../fish/guestfish.pod:297 ../fuse/guestmount.pod:146
19747 #: ../fish/guestfish.pod:299 ../fuse/guestmount.pod:148
19749 "Connect to a live virtual machine. (Experimental, see L<guestfs(3)/"
19750 "ATTACHING TO RUNNING DAEMONS>)."
19754 #: ../fish/guestfish.pod:302 ../fuse/guestmount.pod:151
19755 msgid "B<-m dev[:mountpoint[:options]]>"
19759 #: ../fish/guestfish.pod:304 ../fuse/guestmount.pod:153
19760 msgid "B<--mount dev[:mountpoint[:options]]>"
19764 #: ../fish/guestfish.pod:306
19765 msgid "Mount the named partition or logical volume on the given mountpoint."
19769 #: ../fish/guestfish.pod:308
19770 msgid "If the mountpoint is omitted, it defaults to C</>."
19774 #: ../fish/guestfish.pod:310
19775 msgid "You have to mount something on C</> before most commands will work."
19779 #: ../fish/guestfish.pod:312
19781 "If any I<-m> or I<--mount> options are given, the guest is automatically "
19786 #: ../fish/guestfish.pod:315
19788 "If you don't know what filesystems a disk image contains, you can either run "
19789 "guestfish without this option, then list the partitions, filesystems and LVs "
19790 "available (see L</list-partitions>, L</list-filesystems> and L</lvs> "
19791 "commands), or you can use the L<virt-filesystems(1)> program."
19795 #: ../fish/guestfish.pod:321 ../fuse/guestmount.pod:161
19797 "The third (and rarely used) part of the mount parameter is the list of mount "
19798 "options used to mount the underlying filesystem. If this is not given, then "
19799 "the mount options are either the empty string or C<ro> (the latter if the "
19800 "I<--ro> flag is used). By specifying the mount options, you override this "
19801 "default choice. Probably the only time you would use this is to enable ACLs "
19802 "and/or extended attributes if the filesystem can support them:"
19806 #: ../fish/guestfish.pod:329 ../fuse/guestmount.pod:169
19809 " -m /dev/sda1:/:acl,user_xattr\n"
19814 #: ../fish/guestfish.pod:331
19815 msgid "Using this flag is equivalent to using the C<mount-options> command."
19819 #: ../fish/guestfish.pod:333
19824 #: ../fish/guestfish.pod:335
19825 msgid "B<--no-sync>"
19829 #: ../fish/guestfish.pod:337
19831 "Disable autosync. This is enabled by default. See the discussion of "
19832 "autosync in the L<guestfs(3)> manpage."
19836 #: ../fish/guestfish.pod:340
19841 #: ../fish/guestfish.pod:342
19842 msgid "B<--new type>"
19846 #: ../fish/guestfish.pod:344
19851 #: ../fish/guestfish.pod:346
19853 "Prepare a fresh disk image formatted as \"type\". This is an alternative to "
19854 "the I<-a> option: whereas I<-a> adds an existing disk, I<-N> creates a "
19855 "preformatted disk with a filesystem and adds it. See L</PREPARED DISK "
19860 #: ../fish/guestfish.pod:351
19861 msgid "B<--progress-bars>"
19865 #: ../fish/guestfish.pod:353
19866 msgid "Enable progress bars, even when guestfish is used non-interactively."
19870 #: ../fish/guestfish.pod:355
19872 "Progress bars are enabled by default when guestfish is used as an "
19873 "interactive shell."
19877 #: ../fish/guestfish.pod:358
19878 msgid "B<--no-progress-bars>"
19882 #: ../fish/guestfish.pod:360
19883 msgid "Disable progress bars."
19887 #: ../fish/guestfish.pod:362
19888 msgid "B<--remote[=pid]>"
19892 #: ../fish/guestfish.pod:364
19894 "Send remote commands to C<$GUESTFISH_PID> or C<pid>. See section L</REMOTE "
19895 "CONTROL GUESTFISH OVER A SOCKET> below."
19899 #: ../fish/guestfish.pod:367
19904 #: ../fish/guestfish.pod:369
19909 #: ../fish/guestfish.pod:371
19911 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
19912 "mounts are done read-only."
19916 #: ../fish/guestfish.pod:374
19918 "The option must always be used if the disk image or virtual machine might be "
19919 "running, and is generally recommended in cases where you don't need write "
19920 "access to the disk."
19924 #: ../fish/guestfish.pod:378
19926 "Note that prepared disk images created with I<-N> are not affected by this "
19927 "option. Also commands like C<add> are not affected - you have to specify "
19928 "the C<readonly:true> option explicitly if you need it."
19932 #: ../fish/guestfish.pod:382
19933 msgid "See also L</OPENING DISKS FOR READ AND WRITE> below."
19937 #: ../fish/guestfish.pod:384 ../fuse/guestmount.pod:225
19938 msgid "B<--selinux>"
19942 #: ../fish/guestfish.pod:386
19943 msgid "Enable SELinux support for the guest. See L<guestfs(3)/SELINUX>."
19947 #: ../fish/guestfish.pod:388
19952 #: ../fish/guestfish.pod:390
19953 msgid "B<--verbose>"
19957 #: ../fish/guestfish.pod:392
19959 "Enable very verbose messages. This is particularly useful if you find a bug."
19963 #: ../fish/guestfish.pod:395
19968 #: ../fish/guestfish.pod:397 ../tools/virt-edit.pl:97
19969 #: ../tools/virt-win-reg.pl:112 ../tools/virt-list-filesystems.pl:69
19970 #: ../tools/virt-tar.pl:119 ../tools/virt-make-fs.pl:169
19971 #: ../tools/virt-list-partitions.pl:70
19972 msgid "B<--version>"
19976 #: ../fish/guestfish.pod:399
19977 msgid "Display the guestfish / libguestfs version number and exit."
19981 #: ../fish/guestfish.pod:401
19986 #: ../fish/guestfish.pod:403
19991 #: ../fish/guestfish.pod:405 ../fuse/guestmount.pod:239
19993 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
19994 "mounts are done read-write."
19998 #: ../fish/guestfish.pod:408
19999 msgid "See L</OPENING DISKS FOR READ AND WRITE> below."
20003 #: ../fish/guestfish.pod:410
20008 #: ../fish/guestfish.pod:412
20009 msgid "Echo each command before executing it."
20013 #: ../fish/guestfish.pod:416
20014 msgid "COMMANDS ON COMMAND LINE"
20018 #: ../fish/guestfish.pod:418
20020 "Any additional (non-option) arguments are treated as commands to execute."
20024 #: ../fish/guestfish.pod:421
20026 "Commands to execute should be separated by a colon (C<:>), where the colon "
20027 "is a separate parameter. Thus:"
20031 #: ../fish/guestfish.pod:424
20034 " guestfish cmd [args...] : cmd [args...] : cmd [args...] ...\n"
20039 #: ../fish/guestfish.pod:426
20041 "If there are no additional arguments, then we enter a shell, either an "
20042 "interactive shell with a prompt (if the input is a terminal) or a non-"
20043 "interactive shell."
20047 #: ../fish/guestfish.pod:430
20049 "In either command line mode or non-interactive shell, the first command that "
20050 "gives an error causes the whole shell to exit. In interactive mode (with a "
20051 "prompt) if a command fails, you can continue to enter commands."
20055 #: ../fish/guestfish.pod:435
20056 msgid "USING launch (OR run)"
20060 #: ../fish/guestfish.pod:437
20062 "As with L<guestfs(3)>, you must first configure your guest by adding disks, "
20063 "then launch it, then mount any disks you need, and finally issue actions/"
20064 "commands. So the general order of the day is:"
20068 #: ../fish/guestfish.pod:445
20069 msgid "add or -a/--add"
20073 #: ../fish/guestfish.pod:449
20074 msgid "launch (aka run)"
20078 #: ../fish/guestfish.pod:453
20079 msgid "mount or -m/--mount"
20083 #: ../fish/guestfish.pod:457
20084 msgid "any other commands"
20088 #: ../fish/guestfish.pod:461
20090 "C<run> is a synonym for C<launch>. You must C<launch> (or C<run>) your "
20091 "guest before mounting or performing any other commands."
20095 #: ../fish/guestfish.pod:464
20097 "The only exception is that if any of the I<-i>, I<-m>, I<--mount>, I<-N> or "
20098 "I<--new> options were given then C<run> is done automatically, simply "
20099 "because guestfish can't perform the action you asked for without doing this."
20103 #: ../fish/guestfish.pod:469
20104 msgid "OPENING DISKS FOR READ AND WRITE"
20108 #: ../fish/guestfish.pod:471
20110 "The guestfish, L<guestmount(1)> and L<virt-rescue(1)> options I<--ro> and "
20111 "I<--rw> affect whether the other command line options I<-a>, I<-c>, I<-d>, "
20112 "I<-i> and I<-m> open disk images read-only or for writing."
20116 #: ../fish/guestfish.pod:476
20118 "In libguestfs E<le> 1.8, guestfish, guestmount and virt-rescue defaulted to "
20119 "opening disk images supplied on the command line for write. To open a disk "
20120 "image read-only you have to do I<-a image --ro>."
20124 #: ../fish/guestfish.pod:480
20126 "This matters: If you accidentally open a live VM disk image writable then "
20127 "you will cause irreversible disk corruption."
20131 #: ../fish/guestfish.pod:483
20133 "By libguestfs 1.10 we intend to change the default the other way. Disk "
20134 "images will be opened read-only. You will have to either specify "
20135 "I<guestfish --rw>, I<guestmount --rw>, I<virt-rescue --rw>, or change the "
20136 "configuration file C</etc/libguestfs-tools.conf> in order to get write "
20137 "access for disk images specified by those other command line options."
20141 #: ../fish/guestfish.pod:490
20143 "This version of guestfish, guestmount and virt-rescue has a I<--rw> option "
20144 "which does nothing (it is already the default). However it is highly "
20145 "recommended that you use this option to indicate that you need write access, "
20146 "and prepare your scripts for the day when this option will be required for "
20151 #: ../fish/guestfish.pod:496
20153 "B<Note:> This does I<not> affect commands like L</add> and L</mount>, or any "
20154 "other libguestfs program apart from guestfish and guestmount."
20158 #: ../fish/guestfish.pod:499
20163 #: ../fish/guestfish.pod:501
20165 "You can quote ordinary parameters using either single or double quotes. For "
20170 #: ../fish/guestfish.pod:504
20173 " add \"file with a space.img\"\n"
20178 #: ../fish/guestfish.pod:506
20181 " rm '/file name'\n"
20186 #: ../fish/guestfish.pod:508
20194 #: ../fish/guestfish.pod:510
20196 "A few commands require a list of strings to be passed. For these, use a "
20197 "whitespace-separated list, enclosed in quotes. Strings containing "
20198 "whitespace to be passed through must be enclosed in single quotes. A "
20199 "literal single quote must be escaped with a backslash."
20203 #: ../fish/guestfish.pod:515
20206 " vgcreate VG \"/dev/sda1 /dev/sdb1\"\n"
20207 " command \"/bin/echo 'foo bar'\"\n"
20208 " command \"/bin/echo \\'foo\\'\"\n"
20213 #: ../fish/guestfish.pod:519
20214 msgid "OPTIONAL ARGUMENTS"
20218 #: ../fish/guestfish.pod:521
20220 "Some commands take optional arguments. These arguments appear in this "
20221 "documentation as C<[argname:..]>. You can use them as in these examples:"
20225 #: ../fish/guestfish.pod:525
20228 " add-drive-opts filename\n"
20233 #: ../fish/guestfish.pod:527
20236 " add-drive-opts filename readonly:true\n"
20241 #: ../fish/guestfish.pod:529
20244 " add-drive-opts filename format:qcow2 readonly:false\n"
20249 #: ../fish/guestfish.pod:531
20251 "Each optional argument can appear at most once. All optional arguments must "
20252 "appear after the required ones."
20256 #: ../fish/guestfish.pod:534
20261 #: ../fish/guestfish.pod:536
20263 "This section applies to all commands which can take integers as parameters."
20267 #: ../fish/guestfish.pod:539
20268 msgid "SIZE SUFFIX"
20272 #: ../fish/guestfish.pod:541
20274 "When the command takes a parameter measured in bytes, you can use one of the "
20275 "following suffixes to specify kilobytes, megabytes and larger sizes:"
20279 #: ../fish/guestfish.pod:547
20280 msgid "B<k> or B<K> or B<KiB>"
20284 #: ../fish/guestfish.pod:549
20285 msgid "The size in kilobytes (multiplied by 1024)."
20289 #: ../fish/guestfish.pod:551
20294 #: ../fish/guestfish.pod:553
20295 msgid "The size in SI 1000 byte units."
20299 #: ../fish/guestfish.pod:555
20300 msgid "B<M> or B<MiB>"
20304 #: ../fish/guestfish.pod:557
20305 msgid "The size in megabytes (multiplied by 1048576)."
20309 #: ../fish/guestfish.pod:559
20314 #: ../fish/guestfish.pod:561
20315 msgid "The size in SI 1000000 byte units."
20319 #: ../fish/guestfish.pod:563
20320 msgid "B<G> or B<GiB>"
20324 #: ../fish/guestfish.pod:565
20325 msgid "The size in gigabytes (multiplied by 2**30)."
20329 #: ../fish/guestfish.pod:567
20334 #: ../fish/guestfish.pod:569
20335 msgid "The size in SI 10**9 byte units."
20339 #: ../fish/guestfish.pod:571
20340 msgid "B<T> or B<TiB>"
20344 #: ../fish/guestfish.pod:573
20345 msgid "The size in terabytes (multiplied by 2**40)."
20349 #: ../fish/guestfish.pod:575
20354 #: ../fish/guestfish.pod:577
20355 msgid "The size in SI 10**12 byte units."
20359 #: ../fish/guestfish.pod:579
20360 msgid "B<P> or B<PiB>"
20364 #: ../fish/guestfish.pod:581
20365 msgid "The size in petabytes (multiplied by 2**50)."
20369 #: ../fish/guestfish.pod:583
20374 #: ../fish/guestfish.pod:585
20375 msgid "The size in SI 10**15 byte units."
20379 #: ../fish/guestfish.pod:587
20380 msgid "B<E> or B<EiB>"
20384 #: ../fish/guestfish.pod:589
20385 msgid "The size in exabytes (multiplied by 2**60)."
20389 #: ../fish/guestfish.pod:591
20394 #: ../fish/guestfish.pod:593
20395 msgid "The size in SI 10**18 byte units."
20399 #: ../fish/guestfish.pod:595
20400 msgid "B<Z> or B<ZiB>"
20404 #: ../fish/guestfish.pod:597
20405 msgid "The size in zettabytes (multiplied by 2**70)."
20409 #: ../fish/guestfish.pod:599
20414 #: ../fish/guestfish.pod:601
20415 msgid "The size in SI 10**21 byte units."
20419 #: ../fish/guestfish.pod:603
20420 msgid "B<Y> or B<YiB>"
20424 #: ../fish/guestfish.pod:605
20425 msgid "The size in yottabytes (multiplied by 2**80)."
20429 #: ../fish/guestfish.pod:607
20434 #: ../fish/guestfish.pod:609
20435 msgid "The size in SI 10**24 byte units."
20439 #: ../fish/guestfish.pod:615
20442 " truncate-size /file 1G\n"
20447 #: ../fish/guestfish.pod:617
20448 msgid "would truncate the file to 1 gigabyte."
20452 #: ../fish/guestfish.pod:619
20454 "Be careful because a few commands take sizes in kilobytes or megabytes (eg. "
20455 "the parameter to L</memsize> is specified in megabytes already). Adding a "
20456 "suffix will probably not do what you expect."
20460 #: ../fish/guestfish.pod:623
20461 msgid "OCTAL AND HEXADECIMAL NUMBERS"
20465 #: ../fish/guestfish.pod:625
20467 "For specifying the radix (base) use the C convention: C<0> to prefix an "
20468 "octal number or C<0x> to prefix a hexadecimal number. For example:"
20472 #: ../fish/guestfish.pod:628
20475 " 1234 decimal number 1234\n"
20476 " 02322 octal number, equivalent to decimal 1234\n"
20477 " 0x4d2 hexadecimal number, equivalent to decimal 1234\n"
20482 #: ../fish/guestfish.pod:632
20484 "When using the C<chmod> command, you almost always want to specify an octal "
20485 "number for the mode, and you must prefix it with C<0> (unlike the Unix "
20486 "L<chmod(1)> program):"
20490 #: ../fish/guestfish.pod:636
20493 " chmod 0777 /public # OK\n"
20494 " chmod 777 /public # WRONG! This is mode 777 decimal = 01411 octal.\n"
20499 #: ../fish/guestfish.pod:639
20501 "Commands that return numbers usually print them in decimal, but some "
20502 "commands print numbers in other radices (eg. C<umask> prints the mode in "
20503 "octal, preceeded by C<0>)."
20507 #: ../fish/guestfish.pod:643
20508 msgid "WILDCARDS AND GLOBBING"
20512 #: ../fish/guestfish.pod:645
20514 "Neither guestfish nor the underlying guestfs API performs wildcard expansion "
20515 "(globbing) by default. So for example the following will not do what you "
20520 #: ../fish/guestfish.pod:649
20528 #: ../fish/guestfish.pod:651
20530 "Assuming you don't have a directory called literally C</home/*> then the "
20531 "above command will return an error."
20535 #: ../fish/guestfish.pod:654
20536 msgid "To perform wildcard expansion, use the C<glob> command."
20540 #: ../fish/guestfish.pod:656
20543 " glob rm-rf /home/*\n"
20548 #: ../fish/guestfish.pod:658
20550 "runs C<rm-rf> on each path that matches (ie. potentially running the command "
20551 "many times), equivalent to:"
20555 #: ../fish/guestfish.pod:661
20558 " rm-rf /home/jim\n"
20559 " rm-rf /home/joe\n"
20560 " rm-rf /home/mary\n"
20565 #: ../fish/guestfish.pod:665
20566 msgid "C<glob> only works on simple guest paths and not on device names."
20570 #: ../fish/guestfish.pod:667
20572 "If you have several parameters, each containing a wildcard, then glob will "
20573 "perform a Cartesian product."
20577 #: ../fish/guestfish.pod:670
20582 #: ../fish/guestfish.pod:672
20584 "Any line which starts with a I<#> character is treated as a comment and "
20585 "ignored. The I<#> can optionally be preceeded by whitespace, but B<not> by "
20586 "a command. For example:"
20590 #: ../fish/guestfish.pod:676
20593 " # this is a comment\n"
20594 " # this is a comment\n"
20595 " foo # NOT a comment\n"
20600 #: ../fish/guestfish.pod:680
20601 msgid "Blank lines are also ignored."
20605 #: ../fish/guestfish.pod:682
20606 msgid "RUNNING COMMANDS LOCALLY"
20610 #: ../fish/guestfish.pod:684
20612 "Any line which starts with a I<!> character is treated as a command sent to "
20613 "the local shell (C</bin/sh> or whatever L<system(3)> uses). For example:"
20617 #: ../fish/guestfish.pod:688
20621 " tgz-out /remote local/remote-data.tar.gz\n"
20626 #: ../fish/guestfish.pod:691
20628 "will create a directory C<local> on the host, and then export the contents "
20629 "of C</remote> on the mounted filesystem to C<local/remote-data.tar.gz>. "
20630 "(See C<tgz-out>)."
20634 #: ../fish/guestfish.pod:695
20636 "To change the local directory, use the C<lcd> command. C<!cd> will have no "
20637 "effect, due to the way that subprocesses work in Unix."
20641 #: ../fish/guestfish.pod:698
20642 msgid "LOCAL COMMANDS WITH INLINE EXECUTION"
20646 #: ../fish/guestfish.pod:700
20648 "If a line starts with I<E<lt>!> then the shell command is executed (as for "
20649 "I<!>), but subsequently any output (stdout) of the shell command is parsed "
20650 "and executed as guestfish commands."
20654 #: ../fish/guestfish.pod:704
20656 "Thus you can use shell script to construct arbitrary guestfish commands "
20657 "which are then parsed by guestfish."
20661 #: ../fish/guestfish.pod:707
20663 "For example it is tedious to create a sequence of files (eg. C</foo.1> "
20664 "through C</foo.100>) using guestfish commands alone. However this is simple "
20665 "if we use a shell script to create the guestfish commands for us:"
20669 #: ../fish/guestfish.pod:712
20672 " <! for n in `seq 1 100`; do echo write /foo.$n $n; done\n"
20677 #: ../fish/guestfish.pod:714
20678 msgid "or with names like C</foo.001>:"
20682 #: ../fish/guestfish.pod:716
20685 " <! for n in `seq 1 100`; do printf \"write /foo.%03d %d\\n\" $n $n; done\n"
20690 #: ../fish/guestfish.pod:718
20692 "When using guestfish interactively it can be helpful to just run the shell "
20693 "script first (ie. remove the initial C<E<lt>> character so it is just an "
20694 "ordinary I<!> local command), see what guestfish commands it would run, and "
20695 "when you are happy with those prepend the C<E<lt>> character to run the "
20696 "guestfish commands for real."
20700 #: ../fish/guestfish.pod:724
20705 #: ../fish/guestfish.pod:726
20707 "Use C<command E<lt>spaceE<gt> | command> to pipe the output of the first "
20708 "command (a guestfish command) to the second command (any host command). For "
20713 #: ../fish/guestfish.pod:730
20716 " cat /etc/passwd | awk -F: '$3 == 0 { print }'\n"
20721 #: ../fish/guestfish.pod:732
20723 "(where C<cat> is the guestfish cat command, but C<awk> is the host awk "
20724 "program). The above command would list all accounts in the guest filesystem "
20725 "which have UID 0, ie. root accounts including backdoors. Other examples:"
20729 #: ../fish/guestfish.pod:737
20732 " hexdump /bin/ls | head\n"
20733 " list-devices | tail -1\n"
20734 " tgz-out / - | tar ztf -\n"
20739 #: ../fish/guestfish.pod:741
20741 "The space before the pipe symbol is required, any space after the pipe "
20742 "symbol is optional. Everything after the pipe symbol is just passed "
20743 "straight to the host shell, so it can contain redirections, globs and "
20744 "anything else that makes sense on the host side."
20748 #: ../fish/guestfish.pod:746
20750 "To use a literal argument which begins with a pipe symbol, you have to quote "
20755 #: ../fish/guestfish.pod:749
20763 #: ../fish/guestfish.pod:751
20764 msgid "HOME DIRECTORIES"
20768 #: ../fish/guestfish.pod:753
20770 "If a parameter starts with the character C<~> then the tilde may be expanded "
20771 "as a home directory path (either C<~> for the current user's home directory, "
20772 "or C<~user> for another user)."
20776 #: ../fish/guestfish.pod:757
20778 "Note that home directory expansion happens for users known I<on the host>, "
20779 "not in the guest filesystem."
20783 #: ../fish/guestfish.pod:760
20785 "To use a literal argument which begins with a tilde, you have to quote it, "
20790 #: ../fish/guestfish.pod:763
20798 #: ../fish/guestfish.pod:767
20800 "Libguestfs has some support for Linux guests encrypted according to the "
20801 "Linux Unified Key Setup (LUKS) standard, which includes nearly all whole "
20802 "disk encryption systems used by modern Linux guests. Currently only LVM-on-"
20803 "LUKS is supported."
20807 #: ../fish/guestfish.pod:772
20808 msgid "Identify encrypted block devices and partitions using L</vfs-type>:"
20812 #: ../fish/guestfish.pod:774
20815 " ><fs> vfs-type /dev/sda2\n"
20821 #: ../fish/guestfish.pod:777
20823 "Then open those devices using L</luks-open>. This creates a device-mapper "
20824 "device called C</dev/mapper/luksdev>."
20828 #: ../fish/guestfish.pod:780
20831 " ><fs> luks-open /dev/sda2 luksdev\n"
20832 " Enter key or passphrase (\"key\"): <enter the passphrase>\n"
20837 #: ../fish/guestfish.pod:783
20839 "Finally you have to tell LVM to scan for volume groups on the newly created "
20844 #: ../fish/guestfish.pod:786
20848 " vg-activate-all true\n"
20853 #: ../fish/guestfish.pod:789
20854 msgid "The logical volume(s) can now be mounted in the usual way."
20858 #: ../fish/guestfish.pod:791
20860 "Before closing a LUKS device you must unmount any logical volumes on it and "
20861 "deactivate the volume groups by calling C<vg-activate false VG> on each "
20862 "one. Then you can close the mapper device:"
20866 #: ../fish/guestfish.pod:795
20869 " vg-activate false /dev/VG\n"
20870 " luks-close /dev/mapper/luksdev\n"
20875 #: ../fish/guestfish.pod:798 ../tools/virt-edit.pl:342
20876 msgid "WINDOWS PATHS"
20880 #: ../fish/guestfish.pod:800
20882 "If a path is prefixed with C<win:> then you can use Windows-style paths "
20883 "(with some limitations). The following commands are equivalent:"
20887 #: ../fish/guestfish.pod:803
20890 " file /WINDOWS/system32/config/system.LOG\n"
20895 #: ../fish/guestfish.pod:805
20898 " file win:/windows/system32/config/system.log\n"
20903 #: ../fish/guestfish.pod:807
20906 " file win:\\windows\\system32\\config\\system.log\n"
20911 #: ../fish/guestfish.pod:809
20914 " file WIN:C:\\Windows\\SYSTEM32\\conFIG\\SYSTEM.LOG\n"
20919 #: ../fish/guestfish.pod:811
20921 "This syntax implicitly calls C<case-sensitive-path> (q.v.) so it also "
20922 "handles case insensitivity like Windows would. This only works in argument "
20923 "positions that expect a path."
20927 #: ../fish/guestfish.pod:815
20928 msgid "UPLOADING AND DOWNLOADING FILES"
20932 #: ../fish/guestfish.pod:817
20934 "For commands such as C<upload>, C<download>, C<tar-in>, C<tar-out> and "
20935 "others which upload from or download to a local file, you can use the "
20936 "special filename C<-> to mean \"from stdin\" or \"to stdout\". For example:"
20940 #: ../fish/guestfish.pod:821
20948 #: ../fish/guestfish.pod:823
20950 "reads stdin and creates from that a file C</foo> in the disk image, and:"
20954 #: ../fish/guestfish.pod:826
20957 " tar-out /etc - | tar tf -\n"
20962 #: ../fish/guestfish.pod:828
20964 "writes the tarball to stdout and then pipes that into the external \"tar\" "
20965 "command (see L</PIPES>)."
20969 #: ../fish/guestfish.pod:831
20971 "When using C<-> to read from stdin, the input is read up to the end of "
20972 "stdin. You can also use a special \"heredoc\"-like syntax to read up to "
20973 "some arbitrary end marker:"
20977 #: ../fish/guestfish.pod:835
20980 " upload -<<END /foo\n"
20989 #: ../fish/guestfish.pod:841
20991 "Any string of characters can be used instead of C<END>. The end marker must "
20992 "appear on a line of its own, without any preceeding or following characters "
20993 "(not even spaces)."
20997 #: ../fish/guestfish.pod:845
20999 "Note that the C<-E<lt>E<lt>> syntax only applies to parameters used to "
21000 "upload local files (so-called \"FileIn\" parameters in the generator)."
21004 #: ../fish/guestfish.pod:848
21005 msgid "EXIT ON ERROR BEHAVIOUR"
21009 #: ../fish/guestfish.pod:850
21011 "By default, guestfish will ignore any errors when in interactive mode (ie. "
21012 "taking commands from a human over a tty), and will exit on the first error "
21013 "in non-interactive mode (scripts, commands given on the command line)."
21017 #: ../fish/guestfish.pod:855
21019 "If you prefix a command with a I<-> character, then that command will not "
21020 "cause guestfish to exit, even if that (one) command returns an error."
21024 #: ../fish/guestfish.pod:859
21025 msgid "REMOTE CONTROL GUESTFISH OVER A SOCKET"
21029 #: ../fish/guestfish.pod:861
21031 "Guestfish can be remote-controlled over a socket. This is useful "
21032 "particularly in shell scripts where you want to make several different "
21033 "changes to a filesystem, but you don't want the overhead of starting up a "
21034 "guestfish process each time."
21038 #: ../fish/guestfish.pod:866
21039 msgid "Start a guestfish server process using:"
21043 #: ../fish/guestfish.pod:868
21046 " eval \"`guestfish --listen`\"\n"
21051 #: ../fish/guestfish.pod:870
21052 msgid "and then send it commands by doing:"
21056 #: ../fish/guestfish.pod:872
21059 " guestfish --remote cmd [...]\n"
21064 #: ../fish/guestfish.pod:874
21065 msgid "To cause the server to exit, send it the exit command:"
21069 #: ../fish/guestfish.pod:876
21072 " guestfish --remote exit\n"
21077 #: ../fish/guestfish.pod:878
21079 "Note that the server will normally exit if there is an error in a command. "
21080 "You can change this in the usual way. See section L</EXIT ON ERROR "
21085 #: ../fish/guestfish.pod:882
21086 msgid "CONTROLLING MULTIPLE GUESTFISH PROCESSES"
21090 #: ../fish/guestfish.pod:884
21092 "The C<eval> statement sets the environment variable C<$GUESTFISH_PID>, which "
21093 "is how the I<--remote> option knows where to send the commands. You can "
21094 "have several guestfish listener processes running using:"
21098 #: ../fish/guestfish.pod:888
21101 " eval \"`guestfish --listen`\"\n"
21102 " pid1=$GUESTFISH_PID\n"
21103 " eval \"`guestfish --listen`\"\n"
21104 " pid2=$GUESTFISH_PID\n"
21106 " guestfish --remote=$pid1 cmd\n"
21107 " guestfish --remote=$pid2 cmd\n"
21112 #: ../fish/guestfish.pod:896
21113 msgid "REMOTE CONTROL AND CSH"
21117 #: ../fish/guestfish.pod:898
21119 "When using csh-like shells (csh, tcsh etc) you have to add the I<--csh> "
21124 #: ../fish/guestfish.pod:901
21127 " eval \"`guestfish --listen --csh`\"\n"
21132 #: ../fish/guestfish.pod:903
21133 msgid "REMOTE CONTROL DETAILS"
21137 #: ../fish/guestfish.pod:905
21139 "Remote control happens over a Unix domain socket called C</tmp/.guestfish-"
21140 "$UID/socket-$PID>, where C<$UID> is the effective user ID of the process, "
21141 "and C<$PID> is the process ID of the server."
21145 #: ../fish/guestfish.pod:909
21146 msgid "Guestfish client and server versions must match exactly."
21150 #: ../fish/guestfish.pod:911
21151 msgid "PREPARED DISK IMAGES"
21155 #: ../fish/guestfish.pod:913
21157 "Use the I<-N type> or I<--new type> parameter to select one of a set of "
21158 "preformatted disk images that guestfish can make for you to save typing. "
21159 "This is particularly useful for testing purposes. This option is used "
21160 "instead of the I<-a> option, and like I<-a> can appear multiple times (and "
21161 "can be mixed with I<-a>)."
21165 #: ../fish/guestfish.pod:919
21167 "The new disk is called C<test1.img> for the first I<-N>, C<test2.img> for "
21168 "the second and so on. Existing files in the current directory are "
21173 #: ../fish/guestfish.pod:923
21175 "The type briefly describes how the disk should be sized, partitioned, how "
21176 "filesystem(s) should be created, and how content should be added. "
21177 "Optionally the type can be followed by extra parameters, separated by C<:> "
21178 "(colon) characters. For example, I<-N fs> creates a default 100MB, sparsely-"
21179 "allocated disk, containing a single partition, with the partition formatted "
21180 "as ext2. I<-N fs:ext4:1G> is the same, but for an ext4 filesystem on a 1GB "
21185 #: ../fish/guestfish.pod:931
21186 msgid "To list the available types and any extra parameters they take, run:"
21190 #: ../fish/guestfish.pod:935
21192 "Note that the prepared filesystem is not mounted. You would usually have to "
21193 "use the C<mount /dev/sda1 /> command or add the I<-m /dev/sda1> option."
21197 #: ../fish/guestfish.pod:939
21199 "If any I<-N> or I<--new> options are given, the guest is automatically "
21204 #: ../fish/guestfish.pod:944
21205 msgid "Create a 100MB disk with an ext4-formatted partition:"
21209 #: ../fish/guestfish.pod:946
21212 " guestfish -N fs:ext4\n"
21217 #: ../fish/guestfish.pod:948
21218 msgid "Create a 32MB disk with a VFAT-formatted partition, and mount it:"
21222 #: ../fish/guestfish.pod:950
21225 " guestfish -N fs:vfat:32M -m /dev/sda1\n"
21230 #: ../fish/guestfish.pod:952
21231 msgid "Create a blank 200MB disk:"
21235 #: ../fish/guestfish.pod:954
21238 " guestfish -N disk:200M\n"
21243 #: ../fish/guestfish.pod:956
21244 msgid "PROGRESS BARS"
21248 #: ../fish/guestfish.pod:958
21250 "Some (not all) long-running commands send progress notification messages as "
21251 "they are running. Guestfish turns these messages into progress bars."
21255 #: ../fish/guestfish.pod:962
21257 "When a command that supports progress bars takes longer than two seconds to "
21258 "run, and if progress bars are enabled, then you will see one appearing below "
21263 #: ../fish/guestfish.pod:966
21266 " ><fs> copy-size /large-file /another-file 2048M\n"
21267 " / 10% [#####-----------------------------------------] 00:30\n"
21272 #: ../fish/guestfish.pod:969
21274 "The spinner on the left hand side moves round once for every progress "
21275 "notification received from the backend. This is a (reasonably) golden "
21276 "assurance that the command is \"doing something\" even if the progress bar "
21277 "is not moving, because the command is able to send the progress "
21278 "notifications. When the bar reaches 100% and the command finishes, the "
21279 "spinner disappears."
21283 #: ../fish/guestfish.pod:976
21285 "Progress bars are enabled by default when guestfish is used interactively. "
21286 "You can enable them even for non-interactive modes using I<--progress-bars>, "
21287 "and you can disable them completely using I<--no-progress-bars>."
21291 #: ../fish/guestfish.pod:981
21292 msgid "GUESTFISH COMMANDS"
21296 #: ../fish/guestfish.pod:983
21298 "The commands in this section are guestfish convenience commands, in other "
21299 "words, they are not part of the L<guestfs(3)> API."
21303 #: ../fish/guestfish.pod:986
21308 #: ../fish/guestfish.pod:988
21317 #: ../fish/guestfish.pod:991
21318 msgid "Without any parameter, this provides general help."
21322 #: ../fish/guestfish.pod:993
21323 msgid "With a C<cmd> parameter, this displays detailed help for that command."
21327 #: ../fish/guestfish.pod:995
21328 msgid "quit | exit"
21332 #: ../fish/guestfish.pod:997
21333 msgid "This exits guestfish. You can also use C<^D> key."
21337 #: ../fish/guestfish.pod:999
21338 msgid "@FISH_COMMANDS@"
21342 #: ../fish/guestfish.pod:1001
21347 #: ../fish/guestfish.pod:1005 ../test-tool/libguestfs-test-tool.pod:77
21352 #: ../fish/guestfish.pod:1007
21354 "guestfish returns 0 if the commands completed without error, or 1 if there "
21359 #: ../fish/guestfish.pod:1014
21364 #: ../fish/guestfish.pod:1016
21366 "The C<edit> command uses C<$EDITOR> as the editor. If not set, it uses "
21371 #: ../fish/guestfish.pod:1019
21372 msgid "GUESTFISH_PID"
21376 #: ../fish/guestfish.pod:1021
21378 "Used with the I<--remote> option to specify the remote guestfish process to "
21379 "control. See section L</REMOTE CONTROL GUESTFISH OVER A SOCKET>."
21383 #: ../fish/guestfish.pod:1025
21388 #: ../fish/guestfish.pod:1027
21390 "The L</hexedit> command uses C<$HEXEDITOR> as the external hex editor. If "
21391 "not specified, the external L<hexedit(1)> program is used."
21395 #: ../fish/guestfish.pod:1031
21400 #: ../fish/guestfish.pod:1033
21402 "If compiled with GNU readline support, various files in the home directory "
21403 "can be used. See L</FILES>."
21407 #: ../fish/guestfish.pod:1042
21409 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
21410 "effect as using the B<-v> option."
21414 #: ../fish/guestfish.pod:1054
21416 "Set the path that guestfish uses to search for kernel and initrd.img. See "
21417 "the discussion of paths in L<guestfs(3)>."
21421 #: ../fish/guestfish.pod:1065
21422 msgid "Set C<LIBGUESTFS_TRACE=1> to enable command traces."
21426 #: ../fish/guestfish.pod:1067
21431 #: ../fish/guestfish.pod:1069
21433 "The C<more> command uses C<$PAGER> as the pager. If not set, it uses "
21438 #: ../fish/guestfish.pod:1085 ../fuse/guestmount.pod:252
21443 #: ../fish/guestfish.pod:1089 ../fuse/guestmount.pod:256
21444 msgid "$HOME/.libguestfs-tools.rc"
21448 #: ../fish/guestfish.pod:1091 ../fuse/guestmount.pod:258
21449 msgid "/etc/libguestfs-tools.conf"
21453 #: ../fish/guestfish.pod:1093 ../fuse/guestmount.pod:260
21455 "This configuration file controls the default read-only or read-write mode "
21456 "(I<--ro> or I<--rw>)."
21460 #: ../fish/guestfish.pod:1096
21461 msgid "See L</OPENING DISKS FOR READ AND WRITE>."
21465 #: ../fish/guestfish.pod:1098
21466 msgid "$HOME/.guestfish"
21470 #: ../fish/guestfish.pod:1100
21472 "If compiled with GNU readline support, then the command history is saved in "
21477 #: ../fish/guestfish.pod:1103
21478 msgid "$HOME/.inputrc"
21482 #: ../fish/guestfish.pod:1105
21483 msgid "/etc/inputrc"
21487 #: ../fish/guestfish.pod:1107
21489 "If compiled with GNU readline support, then these files can be used to "
21490 "configure readline. For further information, please see L<readline(3)/"
21491 "INITIALIZATION FILE>."
21495 #: ../fish/guestfish.pod:1111
21496 msgid "To write rules which only apply to guestfish, use:"
21500 #: ../fish/guestfish.pod:1113
21510 #: ../fish/guestfish.pod:1117
21512 "Variables that you can set in inputrc that change the behaviour of guestfish "
21513 "in useful ways include:"
21517 #: ../fish/guestfish.pod:1122
21518 msgid "completion-ignore-case (default: on)"
21522 #: ../fish/guestfish.pod:1124
21524 "By default, guestfish will ignore case when tab-completing paths on the "
21529 #: ../fish/guestfish.pod:1127
21532 " set completion-ignore-case off\n"
21537 #: ../fish/guestfish.pod:1129
21538 msgid "to make guestfish case sensitive."
21542 #: ../fish/guestfish.pod:1133
21547 #: ../fish/guestfish.pod:1135
21548 msgid "test2.img (etc)"
21552 #: ../fish/guestfish.pod:1137
21554 "When using the C<-N> or C<--new> option, the prepared disk or filesystem "
21555 "will be created in the file C<test1.img> in the current directory. The "
21556 "second use of C<-N> will use C<test2.img> and so on. Any existing file with "
21557 "the same name will be overwritten."
21561 #: ../fish/guestfish.pod:1146
21563 "L<guestfs(3)>, L<http://libguestfs.org/>, L<virt-cat(1)>, L<virt-copy-in(1)"
21564 ">, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, L<virt-filesystems(1)"
21565 ">, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, L<virt-list-partitions"
21566 "(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, L<virt-rescue(1)>, L<virt-resize(1)"
21567 ">, L<virt-tar(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<virt-win-reg(1)"
21568 ">, L<hexedit(1)>."
21572 #: ../fish/guestfish.pod:1176 ../test-tool/libguestfs-test-tool.pod:102
21573 #: ../fuse/guestmount.pod:287 ../tools/virt-edit.pl:518
21574 #: ../tools/virt-win-reg.pl:606 ../tools/virt-list-filesystems.pl:210
21575 #: ../tools/virt-tar.pl:309 ../tools/virt-make-fs.pl:572
21576 #: ../tools/virt-list-partitions.pl:277
21578 "This program is free software; you can redistribute it and/or modify it "
21579 "under the terms of the GNU General Public License as published by the Free "
21580 "Software Foundation; either version 2 of the License, or (at your option) "
21581 "any later version."
21585 #: ../fish/guestfish.pod:1181 ../test-tool/libguestfs-test-tool.pod:107
21586 #: ../fuse/guestmount.pod:292 ../tools/virt-edit.pl:523
21587 #: ../tools/virt-win-reg.pl:611 ../tools/virt-list-filesystems.pl:215
21588 #: ../tools/virt-tar.pl:314 ../tools/virt-make-fs.pl:577
21589 #: ../tools/virt-list-partitions.pl:282
21591 "This program is distributed in the hope that it will be useful, but WITHOUT "
21592 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
21593 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for "
21598 #: ../fish/guestfish.pod:1186 ../test-tool/libguestfs-test-tool.pod:112
21599 #: ../fuse/guestmount.pod:297 ../tools/virt-edit.pl:528
21600 #: ../tools/virt-win-reg.pl:616 ../tools/virt-list-filesystems.pl:220
21601 #: ../tools/virt-tar.pl:319 ../tools/virt-make-fs.pl:582
21602 #: ../tools/virt-list-partitions.pl:287
21604 "You should have received a copy of the GNU General Public License along with "
21605 "this program; if not, write to the Free Software Foundation, Inc., 675 Mass "
21606 "Ave, Cambridge, MA 02139, USA."
21610 #: ../fish/guestfish-actions.pod:1
21615 #: ../fish/guestfish-actions.pod:3
21618 " add-cdrom filename\n"
21623 #: ../fish/guestfish-actions.pod:15
21625 "This call checks for the existence of C<filename>. This stops you from "
21626 "specifying other types of drive which are supported by qemu such as C<nbd:> "
21627 "and C<http:> URLs. To specify those, use the general L</config> call "
21632 #: ../fish/guestfish-actions.pod:22
21634 "If you just want to add an ISO file (often you use this as an efficient way "
21635 "to transfer large files into the guest), then you should probably use L</add-"
21636 "drive-ro> instead."
21640 #: ../fish/guestfish-actions.pod:35
21645 #: ../fish/guestfish-actions.pod:37
21650 #: ../fish/guestfish-actions.pod:39
21653 " add-domain dom [libvirturi:..] [readonly:..] [iface:..] [live:..]\n"
21658 #: ../fish/guestfish-actions.pod:41
21660 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
21661 "It works by connecting to libvirt, requesting the domain and domain XML from "
21662 "libvirt, parsing it for disks, and calling L</add-drive-opts> on each one."
21666 #: ../fish/guestfish-actions.pod:71
21668 "The other optional parameters are passed directly through to L</add-drive-"
21673 #: ../fish/guestfish-actions.pod:74 ../fish/guestfish-actions.pod:138
21674 #: ../fish/guestfish-actions.pod:3039
21676 "This command has one or more optional arguments. See L</OPTIONAL ARGUMENTS>."
21680 #: ../fish/guestfish-actions.pod:76
21685 #: ../fish/guestfish-actions.pod:78
21688 " add-drive filename\n"
21693 #: ../fish/guestfish-actions.pod:80
21695 "This function is the equivalent of calling L</add-drive-opts> with no "
21696 "optional parameters, so the disk is added writable, with the format being "
21697 "detected automatically."
21701 #: ../fish/guestfish-actions.pod:84
21703 "Automatic detection of the format opens you up to a potential security hole "
21704 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
21705 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
21706 "you should think about replacing calls to this function with calls to L</add-"
21707 "drive-opts>, and specifying the format."
21711 #: ../fish/guestfish-actions.pod:91
21712 msgid "add-drive-opts"
21716 #: ../fish/guestfish-actions.pod:93
21721 #: ../fish/guestfish-actions.pod:95
21724 " add-drive-opts filename [readonly:..] [format:..] [iface:..]\n"
21729 #: ../fish/guestfish-actions.pod:122
21731 "This forces the image format. If you omit this (or use L</add-drive> or L</"
21732 "add-drive-ro>) then the format is automatically detected. Possible formats "
21733 "include C<raw> and C<qcow2>."
21737 #: ../fish/guestfish-actions.pod:133
21739 "This rarely-used option lets you emulate the behaviour of the deprecated L</"
21740 "add-drive-with-if> call (q.v.)"
21744 #: ../fish/guestfish-actions.pod:140
21745 msgid "add-drive-ro"
21749 #: ../fish/guestfish-actions.pod:142
21754 #: ../fish/guestfish-actions.pod:144
21757 " add-drive-ro filename\n"
21762 #: ../fish/guestfish-actions.pod:146
21764 "This function is the equivalent of calling L</add-drive-opts> with the "
21765 "optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the disk "
21766 "is added read-only, with the format being detected automatically."
21770 #: ../fish/guestfish-actions.pod:151
21771 msgid "add-drive-ro-with-if"
21775 #: ../fish/guestfish-actions.pod:153
21778 " add-drive-ro-with-if filename iface\n"
21783 #: ../fish/guestfish-actions.pod:155
21785 "This is the same as L</add-drive-ro> but it allows you to specify the QEMU "
21786 "interface emulation to use at run time."
21790 #: ../fish/guestfish-actions.pod:165
21791 msgid "add-drive-with-if"
21795 #: ../fish/guestfish-actions.pod:167
21798 " add-drive-with-if filename iface\n"
21803 #: ../fish/guestfish-actions.pod:169
21805 "This is the same as L</add-drive> but it allows you to specify the QEMU "
21806 "interface emulation to use at run time."
21810 #: ../fish/guestfish-actions.pod:179
21815 #: ../fish/guestfish-actions.pod:181
21818 " aug-clear augpath\n"
21823 #: ../fish/guestfish-actions.pod:186
21828 #: ../fish/guestfish-actions.pod:188
21836 #: ../fish/guestfish-actions.pod:190
21838 "Close the current Augeas handle and free up any resources used by it. After "
21839 "calling this, you have to call L</aug-init> again before you can use any "
21840 "other Augeas functions."
21844 #: ../fish/guestfish-actions.pod:195
21845 msgid "aug-defnode"
21849 #: ../fish/guestfish-actions.pod:197
21852 " aug-defnode name expr val\n"
21857 #: ../fish/guestfish-actions.pod:202
21859 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
21860 "calling L</aug-set> C<expr>, C<value>. C<name> will be the nodeset "
21861 "containing that single node."
21865 #: ../fish/guestfish-actions.pod:210
21870 #: ../fish/guestfish-actions.pod:212
21873 " aug-defvar name expr\n"
21878 #: ../fish/guestfish-actions.pod:221
21883 #: ../fish/guestfish-actions.pod:223
21886 " aug-get augpath\n"
21891 #: ../fish/guestfish-actions.pod:228
21896 #: ../fish/guestfish-actions.pod:230
21899 " aug-init root flags\n"
21904 #: ../fish/guestfish-actions.pod:236
21905 msgid "You must call this before using any other L</aug-*> commands."
21909 #: ../fish/guestfish-actions.pod:271
21910 msgid "Do not load the tree in L</aug-init>."
21914 #: ../fish/guestfish-actions.pod:275
21915 msgid "To close the handle, you can call L</aug-close>."
21919 #: ../fish/guestfish-actions.pod:279
21924 #: ../fish/guestfish-actions.pod:281
21927 " aug-insert augpath label true|false\n"
21932 #: ../fish/guestfish-actions.pod:291
21937 #: ../fish/guestfish-actions.pod:293
21945 #: ../fish/guestfish-actions.pod:300
21950 #: ../fish/guestfish-actions.pod:302
21953 " aug-ls augpath\n"
21958 #: ../fish/guestfish-actions.pod:304
21960 "This is just a shortcut for listing L</aug-match> C<path/*> and sorting the "
21961 "resulting nodes into alphabetical order."
21965 #: ../fish/guestfish-actions.pod:307
21970 #: ../fish/guestfish-actions.pod:309
21973 " aug-match augpath\n"
21978 #: ../fish/guestfish-actions.pod:315
21983 #: ../fish/guestfish-actions.pod:317
21986 " aug-mv src dest\n"
21991 #: ../fish/guestfish-actions.pod:322
21996 #: ../fish/guestfish-actions.pod:324
21999 " aug-rm augpath\n"
22004 #: ../fish/guestfish-actions.pod:330
22009 #: ../fish/guestfish-actions.pod:332
22017 #: ../fish/guestfish-actions.pod:336
22019 "The flags which were passed to L</aug-init> affect exactly how files are "
22024 #: ../fish/guestfish-actions.pod:339
22029 #: ../fish/guestfish-actions.pod:341
22032 " aug-set augpath val\n"
22037 #: ../fish/guestfish-actions.pod:345
22039 "In the Augeas API, it is possible to clear a node by setting the value to "
22040 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
22041 "this call. Instead you must use the L</aug-clear> call."
22045 #: ../fish/guestfish-actions.pod:350
22050 #: ../fish/guestfish-actions.pod:352
22053 " available 'groups ...'\n"
22058 #: ../fish/guestfish-actions.pod:358
22060 "The libguestfs groups, and the functions that those groups correspond to, "
22061 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
22062 "runtime by calling L</available-all-groups>."
22066 #: ../fish/guestfish-actions.pod:382
22067 msgid "You must call L</launch> before calling this function."
22071 #: ../fish/guestfish-actions.pod:404
22073 "This call was added in version C<1.0.80>. In previous versions of "
22074 "libguestfs all you could do would be to speculatively execute a command to "
22075 "find out if the daemon implemented it. See also L</version>."
22079 #: ../fish/guestfish-actions.pod:411
22080 msgid "available-all-groups"
22084 #: ../fish/guestfish-actions.pod:413
22087 " available-all-groups\n"
22092 #: ../fish/guestfish-actions.pod:415
22094 "This command returns a list of all optional groups that this daemon knows "
22095 "about. Note this returns both supported and unsupported groups. To find "
22096 "out which ones the daemon can actually support you have to call L</"
22097 "available> on each member of the returned list."
22101 #: ../fish/guestfish-actions.pod:421
22102 msgid "See also L</available> and L<guestfs(3)/AVAILABILITY>."
22106 #: ../fish/guestfish-actions.pod:423
22111 #: ../fish/guestfish-actions.pod:425
22114 " base64-in (base64file|-) filename\n"
22119 #: ../fish/guestfish-actions.pod:430 ../fish/guestfish-actions.pod:439
22120 #: ../fish/guestfish-actions.pod:663 ../fish/guestfish-actions.pod:832
22121 #: ../fish/guestfish-actions.pod:851 ../fish/guestfish-actions.pod:1228
22122 #: ../fish/guestfish-actions.pod:4437 ../fish/guestfish-actions.pod:4449
22123 #: ../fish/guestfish-actions.pod:4460 ../fish/guestfish-actions.pod:4471
22124 #: ../fish/guestfish-actions.pod:4523 ../fish/guestfish-actions.pod:4532
22125 #: ../fish/guestfish-actions.pod:4586 ../fish/guestfish-actions.pod:4609
22126 msgid "Use C<-> instead of a filename to read/write from stdin/stdout."
22130 #: ../fish/guestfish-actions.pod:432
22135 #: ../fish/guestfish-actions.pod:434
22138 " base64-out filename (base64file|-)\n"
22143 #: ../fish/guestfish-actions.pod:441
22144 msgid "blockdev-flushbufs"
22148 #: ../fish/guestfish-actions.pod:443
22151 " blockdev-flushbufs device\n"
22156 #: ../fish/guestfish-actions.pod:450
22157 msgid "blockdev-getbsz"
22161 #: ../fish/guestfish-actions.pod:452
22164 " blockdev-getbsz device\n"
22169 #: ../fish/guestfish-actions.pod:461
22170 msgid "blockdev-getro"
22174 #: ../fish/guestfish-actions.pod:463
22177 " blockdev-getro device\n"
22182 #: ../fish/guestfish-actions.pod:470
22183 msgid "blockdev-getsize64"
22187 #: ../fish/guestfish-actions.pod:472
22190 " blockdev-getsize64 device\n"
22195 #: ../fish/guestfish-actions.pod:476
22196 msgid "See also L</blockdev-getsz>."
22200 #: ../fish/guestfish-actions.pod:480
22201 msgid "blockdev-getss"
22205 #: ../fish/guestfish-actions.pod:482
22208 " blockdev-getss device\n"
22213 #: ../fish/guestfish-actions.pod:487
22215 "(Note, this is not the size in sectors, use L</blockdev-getsz> for that)."
22219 #: ../fish/guestfish-actions.pod:492
22220 msgid "blockdev-getsz"
22224 #: ../fish/guestfish-actions.pod:494
22227 " blockdev-getsz device\n"
22232 #: ../fish/guestfish-actions.pod:499
22234 "See also L</blockdev-getss> for the real sector size of the device, and L</"
22235 "blockdev-getsize64> for the more useful I<size in bytes>."
22239 #: ../fish/guestfish-actions.pod:505
22240 msgid "blockdev-rereadpt"
22244 #: ../fish/guestfish-actions.pod:507
22247 " blockdev-rereadpt device\n"
22252 #: ../fish/guestfish-actions.pod:513
22253 msgid "blockdev-setbsz"
22257 #: ../fish/guestfish-actions.pod:515
22260 " blockdev-setbsz device blocksize\n"
22265 #: ../fish/guestfish-actions.pod:524
22266 msgid "blockdev-setro"
22270 #: ../fish/guestfish-actions.pod:526
22273 " blockdev-setro device\n"
22278 #: ../fish/guestfish-actions.pod:532
22279 msgid "blockdev-setrw"
22283 #: ../fish/guestfish-actions.pod:534
22286 " blockdev-setrw device\n"
22291 #: ../fish/guestfish-actions.pod:540
22292 msgid "case-sensitive-path"
22296 #: ../fish/guestfish-actions.pod:542
22299 " case-sensitive-path path\n"
22304 #: ../fish/guestfish-actions.pod:566
22306 "Thus L</case-sensitive-path> (\"/Windows/System32\") might return C<\"/"
22307 "WINDOWS/system32\"> (the exact return value would depend on details of how "
22308 "the directories were originally created under Windows)."
22312 #: ../fish/guestfish-actions.pod:574
22313 msgid "See also L</realpath>."
22317 #: ../fish/guestfish-actions.pod:576
22322 #: ../fish/guestfish-actions.pod:578
22330 #: ../fish/guestfish-actions.pod:582
22332 "Note that this function cannot correctly handle binary files (specifically, "
22333 "files containing C<\\0> character which is treated as end of string). For "
22334 "those you need to use the L</read-file> or L</download> functions which have "
22335 "a more complex interface."
22339 #: ../fish/guestfish-actions.pod:590
22344 #: ../fish/guestfish-actions.pod:592
22347 " checksum csumtype path\n"
22352 #: ../fish/guestfish-actions.pod:635
22353 msgid "To get the checksum for a device, use L</checksum-device>."
22357 #: ../fish/guestfish-actions.pod:637
22358 msgid "To get the checksums for many files, use L</checksums-out>."
22362 #: ../fish/guestfish-actions.pod:639
22363 msgid "checksum-device"
22367 #: ../fish/guestfish-actions.pod:641
22370 " checksum-device csumtype device\n"
22375 #: ../fish/guestfish-actions.pod:643
22377 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
22378 "device named C<device>. For the types of checksums supported see the L</"
22379 "checksum> command."
22383 #: ../fish/guestfish-actions.pod:647
22384 msgid "checksums-out"
22388 #: ../fish/guestfish-actions.pod:649
22391 " checksums-out csumtype directory (sumsfile|-)\n"
22396 #: ../fish/guestfish-actions.pod:665
22401 #: ../fish/guestfish-actions.pod:667
22404 " chmod mode path\n"
22409 #: ../fish/guestfish-actions.pod:678
22414 #: ../fish/guestfish-actions.pod:680
22417 " chown owner group path\n"
22422 #: ../fish/guestfish-actions.pod:688
22427 #: ../fish/guestfish-actions.pod:690
22430 " command 'arguments ...'\n"
22435 #: ../fish/guestfish-actions.pod:697
22437 "The single parameter is an argv-style list of arguments. The first element "
22438 "is the name of the program to run. Subsequent elements are parameters. The "
22439 "list must be non-empty (ie. must contain a program name). Note that the "
22440 "command runs directly, and is I<not> invoked via the shell (see L</sh>)."
22444 #: ../fish/guestfish-actions.pod:725
22445 msgid "command-lines"
22449 #: ../fish/guestfish-actions.pod:727
22452 " command-lines 'arguments ...'\n"
22457 #: ../fish/guestfish-actions.pod:729
22459 "This is the same as L</command>, but splits the result into a list of lines."
22463 #: ../fish/guestfish-actions.pod:732
22464 msgid "See also: L</sh-lines>"
22468 #: ../fish/guestfish-actions.pod:737
22473 #: ../fish/guestfish-actions.pod:739
22476 " config qemuparam qemuvalue\n"
22481 #: ../fish/guestfish-actions.pod:750
22486 #: ../fish/guestfish-actions.pod:752
22489 " copy-size src dest size\n"
22494 #: ../fish/guestfish-actions.pod:760
22499 #: ../fish/guestfish-actions.pod:762
22507 #: ../fish/guestfish-actions.pod:767
22512 #: ../fish/guestfish-actions.pod:769
22520 #: ../fish/guestfish-actions.pod:774
22525 #: ../fish/guestfish-actions.pod:776
22533 #: ../fish/guestfish-actions.pod:783
22535 "If the destination is a device, it must be as large or larger than the "
22536 "source file or device, otherwise the copy will fail. This command cannot do "
22537 "partial copies (see L</copy-size>)."
22541 #: ../fish/guestfish-actions.pod:787
22546 #: ../fish/guestfish-actions.pod:789
22554 #: ../fish/guestfish-actions.pod:793 ../fish/guestfish-actions.pod:804
22556 "This command is mostly useful for interactive sessions. It is I<not> "
22557 "intended that you try to parse the output string. Use L</statvfs> from "
22562 #: ../fish/guestfish-actions.pod:797
22567 #: ../fish/guestfish-actions.pod:799
22575 #: ../fish/guestfish-actions.pod:808
22580 #: ../fish/guestfish-actions.pod:810
22588 #: ../fish/guestfish-actions.pod:816
22590 "Another way to get the same information is to enable verbose messages with "
22591 "L</set-verbose> or by setting the environment variable C<LIBGUESTFS_DEBUG=1> "
22592 "before running the program."
22596 #: ../fish/guestfish-actions.pod:821
22601 #: ../fish/guestfish-actions.pod:823
22604 " download remotefilename (filename|-)\n"
22609 #: ../fish/guestfish-actions.pod:830
22610 msgid "See also L</upload>, L</cat>."
22614 #: ../fish/guestfish-actions.pod:834
22615 msgid "download-offset"
22619 #: ../fish/guestfish-actions.pod:836
22622 " download-offset remotefilename (filename|-) offset size\n"
22627 #: ../fish/guestfish-actions.pod:844
22629 "Note that there is no limit on the amount of data that can be downloaded "
22630 "with this call, unlike with L</pread>, and this call always reads the full "
22631 "amount unless an error occurs."
22635 #: ../fish/guestfish-actions.pod:849
22636 msgid "See also L</download>, L</pread>."
22640 #: ../fish/guestfish-actions.pod:853
22641 msgid "drop-caches"
22645 #: ../fish/guestfish-actions.pod:855
22648 " drop-caches whattodrop\n"
22653 #: ../fish/guestfish-actions.pod:867
22658 #: ../fish/guestfish-actions.pod:869
22666 #: ../fish/guestfish-actions.pod:881
22671 #: ../fish/guestfish-actions.pod:883
22674 " e2fsck-f device\n"
22679 #: ../fish/guestfish-actions.pod:889
22681 "This command is only needed because of L</resize2fs> (q.v.). Normally you "
22682 "should use L</fsck>."
22686 #: ../fish/guestfish-actions.pod:892
22687 msgid "echo-daemon"
22691 #: ../fish/guestfish-actions.pod:894
22694 " echo-daemon 'words ...'\n"
22699 #: ../fish/guestfish-actions.pod:901
22700 msgid "See also L</ping-daemon>."
22704 #: ../fish/guestfish-actions.pod:903
22709 #: ../fish/guestfish-actions.pod:905
22712 " egrep regex path\n"
22717 #: ../fish/guestfish-actions.pod:913
22722 #: ../fish/guestfish-actions.pod:915
22725 " egrepi regex path\n"
22730 #: ../fish/guestfish-actions.pod:923
22735 #: ../fish/guestfish-actions.pod:925
22738 " equal file1 file2\n"
22743 #: ../fish/guestfish-actions.pod:932
22748 #: ../fish/guestfish-actions.pod:934
22756 #: ../fish/guestfish-actions.pod:939
22757 msgid "See also L</is-file>, L</is-dir>, L</stat>."
22761 #: ../fish/guestfish-actions.pod:941
22766 #: ../fish/guestfish-actions.pod:943
22769 " fallocate path len\n"
22774 #: ../fish/guestfish-actions.pod:960
22775 msgid "fallocate64"
22779 #: ../fish/guestfish-actions.pod:962
22782 " fallocate64 path len\n"
22787 #: ../fish/guestfish-actions.pod:968
22789 "Note that this call allocates disk blocks for the file. To create a sparse "
22790 "file use L</truncate-size> instead."
22794 #: ../fish/guestfish-actions.pod:971
22796 "The deprecated call L</fallocate> does the same, but owing to an oversight "
22797 "it only allowed 30 bit lengths to be specified, effectively limiting the "
22798 "maximum size of files created through that call to 1GB."
22802 #: ../fish/guestfish-actions.pod:980
22807 #: ../fish/guestfish-actions.pod:982
22810 " fgrep pattern path\n"
22815 #: ../fish/guestfish-actions.pod:990
22820 #: ../fish/guestfish-actions.pod:992
22823 " fgrepi pattern path\n"
22828 #: ../fish/guestfish-actions.pod:1000
22833 #: ../fish/guestfish-actions.pod:1002
22841 #: ../fish/guestfish-actions.pod:1014
22843 "This command can also be used on C</dev/> devices (and partitions, LV "
22844 "names). You can for example use this to determine if a device contains a "
22845 "filesystem, although it's usually better to use L</vfs-type>."
22849 #: ../fish/guestfish-actions.pod:1024
22850 msgid "file-architecture"
22854 #: ../fish/guestfish-actions.pod:1026
22857 " file-architecture filename\n"
22862 #: ../fish/guestfish-actions.pod:1129
22867 #: ../fish/guestfish-actions.pod:1131
22875 #: ../fish/guestfish-actions.pod:1135
22877 "To get other stats about a file, use L</stat>, L</lstat>, L</is-dir>, L</is-"
22878 "file> etc. To get the size of block devices, use L</blockdev-getsize64>."
22882 #: ../fish/guestfish-actions.pod:1139
22887 #: ../fish/guestfish-actions.pod:1141
22890 " fill c len path\n"
22895 #: ../fish/guestfish-actions.pod:1147
22897 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
22898 "L</truncate-size>. To create a file with a pattern of repeating bytes use "
22899 "L</fill-pattern>."
22903 #: ../fish/guestfish-actions.pod:1152
22904 msgid "fill-pattern"
22908 #: ../fish/guestfish-actions.pod:1154
22911 " fill-pattern pattern len path\n"
22916 #: ../fish/guestfish-actions.pod:1156
22918 "This function is like L</fill> except that it creates a new file of length "
22919 "C<len> containing the repeating pattern of bytes in C<pattern>. The pattern "
22920 "is truncated if necessary to ensure the length of the file is exactly C<len> "
22925 #: ../fish/guestfish-actions.pod:1161
22930 #: ../fish/guestfish-actions.pod:1163
22933 " find directory\n"
22938 #: ../fish/guestfish-actions.pod:1177
22939 msgid "then the returned list from L</find> C</tmp> would be 4 elements:"
22943 #: ../fish/guestfish-actions.pod:1190
22944 msgid "See also L</find0>."
22948 #: ../fish/guestfish-actions.pod:1195
22953 #: ../fish/guestfish-actions.pod:1197
22956 " find0 directory (files|-)\n"
22961 #: ../fish/guestfish-actions.pod:1203
22963 "This command works the same way as L</find> with the following exceptions:"
22967 #: ../fish/guestfish-actions.pod:1230
22968 msgid "findfs-label"
22972 #: ../fish/guestfish-actions.pod:1232
22975 " findfs-label label\n"
22980 #: ../fish/guestfish-actions.pod:1238
22981 msgid "To find the label of a filesystem, use L</vfs-label>."
22985 #: ../fish/guestfish-actions.pod:1240
22986 msgid "findfs-uuid"
22990 #: ../fish/guestfish-actions.pod:1242
22993 " findfs-uuid uuid\n"
22998 #: ../fish/guestfish-actions.pod:1248
22999 msgid "To find the UUID of a filesystem, use L</vfs-uuid>."
23003 #: ../fish/guestfish-actions.pod:1250
23008 #: ../fish/guestfish-actions.pod:1252
23011 " fsck fstype device\n"
23016 #: ../fish/guestfish-actions.pod:1282
23021 #: ../fish/guestfish-actions.pod:1284
23029 #: ../fish/guestfish-actions.pod:1291
23030 msgid "get-attach-method"
23034 #: ../fish/guestfish-actions.pod:1293
23037 " get-attach-method\n"
23042 #: ../fish/guestfish-actions.pod:1295
23043 msgid "Return the current attach method. See L</set-attach-method>."
23047 #: ../fish/guestfish-actions.pod:1297
23048 msgid "get-autosync"
23052 #: ../fish/guestfish-actions.pod:1299
23060 #: ../fish/guestfish-actions.pod:1303
23065 #: ../fish/guestfish-actions.pod:1305
23073 #: ../fish/guestfish-actions.pod:1309
23074 msgid "get-e2label"
23078 #: ../fish/guestfish-actions.pod:1311
23081 " get-e2label device\n"
23086 #: ../fish/guestfish-actions.pod:1323
23091 #: ../fish/guestfish-actions.pod:1325
23094 " get-e2uuid device\n"
23099 #: ../fish/guestfish-actions.pod:1337
23100 msgid "get-memsize"
23104 #: ../fish/guestfish-actions.pod:1339
23112 #: ../fish/guestfish-actions.pod:1344
23114 "If L</set-memsize> was not called on this handle, and if "
23115 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
23116 "value for memsize."
23120 #: ../fish/guestfish-actions.pod:1351
23121 msgid "get-network"
23125 #: ../fish/guestfish-actions.pod:1353
23133 #: ../fish/guestfish-actions.pod:1357
23138 #: ../fish/guestfish-actions.pod:1359
23146 #: ../fish/guestfish-actions.pod:1366
23151 #: ../fish/guestfish-actions.pod:1368
23156 #: ../fish/guestfish-actions.pod:1370
23164 #: ../fish/guestfish-actions.pod:1377
23169 #: ../fish/guestfish-actions.pod:1379
23177 #: ../fish/guestfish-actions.pod:1386
23178 msgid "get-recovery-proc"
23182 #: ../fish/guestfish-actions.pod:1388
23185 " get-recovery-proc\n"
23190 #: ../fish/guestfish-actions.pod:1392
23191 msgid "get-selinux"
23195 #: ../fish/guestfish-actions.pod:1394
23203 #: ../fish/guestfish-actions.pod:1396
23205 "This returns the current setting of the selinux flag which is passed to the "
23206 "appliance at boot time. See L</set-selinux>."
23210 #: ../fish/guestfish-actions.pod:1402
23215 #: ../fish/guestfish-actions.pod:1404
23223 #: ../fish/guestfish-actions.pod:1411
23228 #: ../fish/guestfish-actions.pod:1413
23236 #: ../fish/guestfish-actions.pod:1417
23241 #: ../fish/guestfish-actions.pod:1419
23249 #: ../fish/guestfish-actions.pod:1421
23251 "Return the current umask. By default the umask is C<022> unless it has been "
23252 "set by calling L</umask>."
23256 #: ../fish/guestfish-actions.pod:1424
23257 msgid "get-verbose"
23261 #: ../fish/guestfish-actions.pod:1426
23269 #: ../fish/guestfish-actions.pod:1430
23274 #: ../fish/guestfish-actions.pod:1432
23282 #: ../fish/guestfish-actions.pod:1436
23283 msgid "See the documentation about SELINUX in L<guestfs(3)>, and L</setcon>"
23287 #: ../fish/guestfish-actions.pod:1439
23292 #: ../fish/guestfish-actions.pod:1441
23295 " getxattr path name\n"
23300 #: ../fish/guestfish-actions.pod:1443
23302 "Get a single extended attribute from file C<path> named C<name>. This call "
23303 "follows symlinks. If you want to lookup an extended attribute for the "
23304 "symlink itself, use L</lgetxattr>."
23308 #: ../fish/guestfish-actions.pod:1447 ../fish/guestfish-actions.pod:2445
23310 "Normally it is better to get all extended attributes from a file in one go "
23311 "by calling L</getxattrs>. However some Linux filesystem implementations are "
23312 "buggy and do not provide a way to list out attributes. For these "
23313 "filesystems (notably ntfs-3g) you have to know the names of the extended "
23314 "attributes you want in advance and call this function."
23318 #: ../fish/guestfish-actions.pod:1457
23319 msgid "See also: L</getxattrs>, L</lgetxattr>, L<attr(5)>."
23323 #: ../fish/guestfish-actions.pod:1459
23328 #: ../fish/guestfish-actions.pod:1461
23331 " getxattrs path\n"
23336 #: ../fish/guestfish-actions.pod:1469
23337 msgid "See also: L</lgetxattrs>, L<attr(5)>."
23341 #: ../fish/guestfish-actions.pod:1471
23342 msgid "glob-expand"
23346 #: ../fish/guestfish-actions.pod:1473
23349 " glob-expand pattern\n"
23354 #: ../fish/guestfish-actions.pod:1486
23359 #: ../fish/guestfish-actions.pod:1488
23362 " grep regex path\n"
23367 #: ../fish/guestfish-actions.pod:1496
23372 #: ../fish/guestfish-actions.pod:1498
23375 " grepi regex path\n"
23380 #: ../fish/guestfish-actions.pod:1506
23381 msgid "grub-install"
23385 #: ../fish/guestfish-actions.pod:1508
23388 " grub-install root device\n"
23393 #: ../fish/guestfish-actions.pod:1524
23398 #: ../fish/guestfish-actions.pod:1526
23406 #: ../fish/guestfish-actions.pod:1534
23411 #: ../fish/guestfish-actions.pod:1536
23414 " head-n nrlines path\n"
23419 #: ../fish/guestfish-actions.pod:1549
23424 #: ../fish/guestfish-actions.pod:1551
23432 #: ../fish/guestfish-actions.pod:1559
23437 #: ../fish/guestfish-actions.pod:1561
23440 " initrd-cat initrdpath filename\n"
23445 #: ../fish/guestfish-actions.pod:1573
23446 msgid "See also L</initrd-list>."
23450 #: ../fish/guestfish-actions.pod:1578
23451 msgid "initrd-list"
23455 #: ../fish/guestfish-actions.pod:1580
23458 " initrd-list path\n"
23463 #: ../fish/guestfish-actions.pod:1592
23464 msgid "inotify-add-watch"
23468 #: ../fish/guestfish-actions.pod:1594
23471 " inotify-add-watch path mask\n"
23476 #: ../fish/guestfish-actions.pod:1606
23477 msgid "inotify-close"
23481 #: ../fish/guestfish-actions.pod:1608
23489 #: ../fish/guestfish-actions.pod:1614
23490 msgid "inotify-files"
23494 #: ../fish/guestfish-actions.pod:1616
23502 #: ../fish/guestfish-actions.pod:1618
23504 "This function is a helpful wrapper around L</inotify-read> which just "
23505 "returns a list of pathnames of objects that were touched. The returned "
23506 "pathnames are sorted and deduplicated."
23510 #: ../fish/guestfish-actions.pod:1622
23511 msgid "inotify-init"
23515 #: ../fish/guestfish-actions.pod:1624
23518 " inotify-init maxevents\n"
23523 #: ../fish/guestfish-actions.pod:1630
23525 "C<maxevents> is the maximum number of events which will be queued up between "
23526 "calls to L</inotify-read> or L</inotify-files>. If this is passed as C<0>, "
23527 "then the kernel (or previously set) default is used. For Linux 2.6.29 the "
23528 "default was 16384 events. Beyond this limit, the kernel throws away events, "
23529 "but records the fact that it threw them away by setting a flag "
23530 "C<IN_Q_OVERFLOW> in the returned structure list (see L</inotify-read>)."
23534 #: ../fish/guestfish-actions.pod:1640
23536 "Before any events are generated, you have to add some watches to the "
23537 "internal watch list. See: L</inotify-add-watch>, L</inotify-rm-watch> and "
23538 "L</inotify-watch-all>."
23542 #: ../fish/guestfish-actions.pod:1646
23544 "Queued up events should be read periodically by calling L</inotify-read> (or "
23545 "L</inotify-files> which is just a helpful wrapper around L</inotify-read>). "
23546 "If you don't read the events out often enough then you risk the internal "
23547 "queue overflowing."
23551 #: ../fish/guestfish-actions.pod:1653
23553 "The handle should be closed after use by calling L</inotify-close>. This "
23554 "also removes any watches automatically."
23558 #: ../fish/guestfish-actions.pod:1662
23559 msgid "inotify-read"
23563 #: ../fish/guestfish-actions.pod:1664
23571 #: ../fish/guestfish-actions.pod:1677
23572 msgid "inotify-rm-watch"
23576 #: ../fish/guestfish-actions.pod:1679
23579 " inotify-rm-watch wd\n"
23584 #: ../fish/guestfish-actions.pod:1681
23585 msgid "Remove a previously defined inotify watch. See L</inotify-add-watch>."
23589 #: ../fish/guestfish-actions.pod:1684
23590 msgid "inspect-get-arch"
23594 #: ../fish/guestfish-actions.pod:1686
23597 " inspect-get-arch root\n"
23602 #: ../fish/guestfish-actions.pod:1688 ../fish/guestfish-actions.pod:1704
23603 #: ../fish/guestfish-actions.pod:1782 ../fish/guestfish-actions.pod:1818
23604 #: ../fish/guestfish-actions.pod:1836 ../fish/guestfish-actions.pod:1870
23605 #: ../fish/guestfish-actions.pod:1885 ../fish/guestfish-actions.pod:1906
23606 #: ../fish/guestfish-actions.pod:1921 ../fish/guestfish-actions.pod:1954
23607 #: ../fish/guestfish-actions.pod:1976 ../fish/guestfish-actions.pod:2000
23608 #: ../fish/guestfish-actions.pod:2017 ../fish/guestfish-actions.pod:2060
23609 #: ../fish/guestfish-actions.pod:2095 ../fish/guestfish-actions.pod:2111
23610 #: ../fish/guestfish-actions.pod:2127 ../fish/guestfish-actions.pod:2140
23611 #: ../fish/guestfish-actions.pod:2153 ../fish/guestfish-actions.pod:2168
23613 "This function should only be called with a root device string as returned by "
23618 #: ../fish/guestfish-actions.pod:1691
23620 "This returns the architecture of the inspected operating system. The "
23621 "possible return values are listed under L</file-architecture>."
23625 #: ../fish/guestfish-actions.pod:1700
23626 msgid "inspect-get-distro"
23630 #: ../fish/guestfish-actions.pod:1702
23633 " inspect-get-distro root\n"
23638 #: ../fish/guestfish-actions.pod:1778
23639 msgid "inspect-get-drive-mappings"
23643 #: ../fish/guestfish-actions.pod:1780
23646 " inspect-get-drive-mappings root\n"
23651 #: ../fish/guestfish-actions.pod:1810
23653 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
23654 "get-mountpoints>, L</inspect-get-filesystems>."
23658 #: ../fish/guestfish-actions.pod:1814
23659 msgid "inspect-get-filesystems"
23663 #: ../fish/guestfish-actions.pod:1816
23666 " inspect-get-filesystems root\n"
23671 #: ../fish/guestfish-actions.pod:1829
23673 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
23674 "get-mountpoints>."
23678 #: ../fish/guestfish-actions.pod:1832
23679 msgid "inspect-get-format"
23683 #: ../fish/guestfish-actions.pod:1834
23686 " inspect-get-format root\n"
23691 #: ../fish/guestfish-actions.pod:1866
23692 msgid "inspect-get-hostname"
23696 #: ../fish/guestfish-actions.pod:1868
23699 " inspect-get-hostname root\n"
23704 #: ../fish/guestfish-actions.pod:1881
23705 msgid "inspect-get-major-version"
23709 #: ../fish/guestfish-actions.pod:1883
23712 " inspect-get-major-version root\n"
23717 #: ../fish/guestfish-actions.pod:1902
23718 msgid "inspect-get-minor-version"
23722 #: ../fish/guestfish-actions.pod:1904
23725 " inspect-get-minor-version root\n"
23730 #: ../fish/guestfish-actions.pod:1914
23732 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
23733 "get-major-version>."
23737 #: ../fish/guestfish-actions.pod:1917
23738 msgid "inspect-get-mountpoints"
23742 #: ../fish/guestfish-actions.pod:1919
23745 " inspect-get-mountpoints root\n"
23750 #: ../fish/guestfish-actions.pod:1941
23752 "For operating systems like Windows which still use drive letters, this call "
23753 "will only return an entry for the first drive \"mounted on\" C</>. For "
23754 "information about the mapping of drive letters to partitions, see L</inspect-"
23755 "get-drive-mappings>."
23759 #: ../fish/guestfish-actions.pod:1947
23761 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
23762 "get-filesystems>."
23766 #: ../fish/guestfish-actions.pod:1950
23767 msgid "inspect-get-package-format"
23771 #: ../fish/guestfish-actions.pod:1952
23774 " inspect-get-package-format root\n"
23779 #: ../fish/guestfish-actions.pod:1957
23781 "This function and L</inspect-get-package-management> return the package "
23782 "format and package management tool used by the inspected operating system. "
23783 "For example for Fedora these functions would return C<rpm> (package format) "
23784 "and C<yum> (package management)."
23788 #: ../fish/guestfish-actions.pod:1972
23789 msgid "inspect-get-package-management"
23793 #: ../fish/guestfish-actions.pod:1974
23796 " inspect-get-package-management root\n"
23801 #: ../fish/guestfish-actions.pod:1979
23803 "L</inspect-get-package-format> and this function return the package format "
23804 "and package management tool used by the inspected operating system. For "
23805 "example for Fedora these functions would return C<rpm> (package format) and "
23806 "C<yum> (package management)."
23810 #: ../fish/guestfish-actions.pod:1996
23811 msgid "inspect-get-product-name"
23815 #: ../fish/guestfish-actions.pod:1998
23818 " inspect-get-product-name root\n"
23823 #: ../fish/guestfish-actions.pod:2013
23824 msgid "inspect-get-product-variant"
23828 #: ../fish/guestfish-actions.pod:2015
23831 " inspect-get-product-variant root\n"
23836 #: ../fish/guestfish-actions.pod:2039
23838 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
23839 "get-product-name>, L</inspect-get-major-version>."
23843 #: ../fish/guestfish-actions.pod:2043
23844 msgid "inspect-get-roots"
23848 #: ../fish/guestfish-actions.pod:2045
23851 " inspect-get-roots\n"
23856 #: ../fish/guestfish-actions.pod:2047
23858 "This function is a convenient way to get the list of root devices, as "
23859 "returned from a previous call to L</inspect-os>, but without redoing the "
23860 "whole inspection process."
23864 #: ../fish/guestfish-actions.pod:2051
23866 "This returns an empty list if either no root devices were found or the "
23867 "caller has not called L</inspect-os>."
23871 #: ../fish/guestfish-actions.pod:2056
23872 msgid "inspect-get-type"
23876 #: ../fish/guestfish-actions.pod:2058
23879 " inspect-get-type root\n"
23884 #: ../fish/guestfish-actions.pod:2091
23885 msgid "inspect-get-windows-current-control-set"
23889 #: ../fish/guestfish-actions.pod:2093
23892 " inspect-get-windows-current-control-set root\n"
23897 #: ../fish/guestfish-actions.pod:2107
23898 msgid "inspect-get-windows-systemroot"
23902 #: ../fish/guestfish-actions.pod:2109
23905 " inspect-get-windows-systemroot root\n"
23910 #: ../fish/guestfish-actions.pod:2123
23911 msgid "inspect-is-live"
23915 #: ../fish/guestfish-actions.pod:2125
23918 " inspect-is-live root\n"
23923 #: ../fish/guestfish-actions.pod:2130
23925 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
23926 "then this returns true if a live image was detected on the disk."
23930 #: ../fish/guestfish-actions.pod:2136
23931 msgid "inspect-is-multipart"
23935 #: ../fish/guestfish-actions.pod:2138
23938 " inspect-is-multipart root\n"
23943 #: ../fish/guestfish-actions.pod:2143
23945 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
23946 "then this returns true if the disk is part of a set."
23950 #: ../fish/guestfish-actions.pod:2149
23951 msgid "inspect-is-netinst"
23955 #: ../fish/guestfish-actions.pod:2151
23958 " inspect-is-netinst root\n"
23963 #: ../fish/guestfish-actions.pod:2156
23965 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
23966 "then this returns true if the disk is a network installer, ie. not a self-"
23967 "contained install CD but one which is likely to require network access to "
23968 "complete the install."
23972 #: ../fish/guestfish-actions.pod:2164
23973 msgid "inspect-list-applications"
23977 #: ../fish/guestfish-actions.pod:2166
23980 " inspect-list-applications root\n"
23985 #: ../fish/guestfish-actions.pod:2173
23987 "I<Note:> This call works differently from other parts of the inspection "
23988 "API. You have to call L</inspect-os>, then L</inspect-get-mountpoints>, "
23989 "then mount up the disks, before calling this. Listing applications is a "
23990 "significantly more difficult operation which requires access to the full "
23991 "filesystem. Also note that unlike the other L</inspect-get-*> calls which "
23992 "are just returning data cached in the libguestfs handle, this call actually "
23993 "reads parts of the mounted filesystems during the call."
23997 #: ../fish/guestfish-actions.pod:2263
24002 #: ../fish/guestfish-actions.pod:2265
24010 #: ../fish/guestfish-actions.pod:2280
24012 "You can pass the root string(s) returned to other L</inspect-get-*> "
24013 "functions in order to query further information about each operating system, "
24014 "such as the name and version."
24018 #: ../fish/guestfish-actions.pod:2285
24020 "This function uses other libguestfs features such as L</mount-ro> and L</"
24021 "umount-all> in order to mount and unmount filesystems and look at the "
24022 "contents. This should be called with no disks currently mounted. The "
24023 "function may also use Augeas, so any existing Augeas handle will be closed."
24027 #: ../fish/guestfish-actions.pod:2297 ../fish/guestfish-actions.pod:2473
24028 #: ../fish/guestfish-actions.pod:2519
24029 msgid "See also L</list-filesystems>."
24033 #: ../fish/guestfish-actions.pod:2299
24034 msgid "is-blockdev"
24038 #: ../fish/guestfish-actions.pod:2301
24041 " is-blockdev path\n"
24046 #: ../fish/guestfish-actions.pod:2306 ../fish/guestfish-actions.pod:2324
24047 #: ../fish/guestfish-actions.pod:2343 ../fish/guestfish-actions.pod:2352
24048 #: ../fish/guestfish-actions.pod:2362 ../fish/guestfish-actions.pod:2396
24049 #: ../fish/guestfish-actions.pod:2405
24050 msgid "See also L</stat>."
24054 #: ../fish/guestfish-actions.pod:2308
24059 #: ../fish/guestfish-actions.pod:2310
24067 #: ../fish/guestfish-actions.pod:2317
24072 #: ../fish/guestfish-actions.pod:2319
24075 " is-chardev path\n"
24080 #: ../fish/guestfish-actions.pod:2326
24085 #: ../fish/guestfish-actions.pod:2328
24093 #: ../fish/guestfish-actions.pod:2335
24098 #: ../fish/guestfish-actions.pod:2337
24106 #: ../fish/guestfish-actions.pod:2345
24111 #: ../fish/guestfish-actions.pod:2347
24119 #: ../fish/guestfish-actions.pod:2354
24124 #: ../fish/guestfish-actions.pod:2356
24132 #: ../fish/guestfish-actions.pod:2364
24133 msgid "is-launching"
24137 #: ../fish/guestfish-actions.pod:2366
24145 #: ../fish/guestfish-actions.pod:2373
24150 #: ../fish/guestfish-actions.pod:2375
24158 #: ../fish/guestfish-actions.pod:2380
24163 #: ../fish/guestfish-actions.pod:2382
24171 #: ../fish/guestfish-actions.pod:2389
24176 #: ../fish/guestfish-actions.pod:2391
24179 " is-socket path\n"
24184 #: ../fish/guestfish-actions.pod:2398
24189 #: ../fish/guestfish-actions.pod:2400
24192 " is-symlink path\n"
24197 #: ../fish/guestfish-actions.pod:2407
24198 msgid "kill-subprocess"
24202 #: ../fish/guestfish-actions.pod:2409
24205 " kill-subprocess\n"
24210 #: ../fish/guestfish-actions.pod:2413
24215 #: ../fish/guestfish-actions.pod:2415
24220 #: ../fish/guestfish-actions.pod:2417
24228 #: ../fish/guestfish-actions.pod:2425
24233 #: ../fish/guestfish-actions.pod:2427
24236 " lchown owner group path\n"
24241 #: ../fish/guestfish-actions.pod:2429
24243 "Change the file owner to C<owner> and group to C<group>. This is like L</"
24244 "chown> but if C<path> is a symlink then the link itself is changed, not the "
24249 #: ../fish/guestfish-actions.pod:2437
24254 #: ../fish/guestfish-actions.pod:2439
24257 " lgetxattr path name\n"
24262 #: ../fish/guestfish-actions.pod:2455
24263 msgid "See also: L</lgetxattrs>, L</getxattr>, L<attr(5)>."
24267 #: ../fish/guestfish-actions.pod:2457
24272 #: ../fish/guestfish-actions.pod:2459
24275 " lgetxattrs path\n"
24280 #: ../fish/guestfish-actions.pod:2461
24282 "This is the same as L</getxattrs>, but if C<path> is a symbolic link, then "
24283 "it returns the extended attributes of the link itself."
24287 #: ../fish/guestfish-actions.pod:2465
24288 msgid "list-devices"
24292 #: ../fish/guestfish-actions.pod:2467
24300 #: ../fish/guestfish-actions.pod:2475
24301 msgid "list-filesystems"
24305 #: ../fish/guestfish-actions.pod:2477
24308 " list-filesystems\n"
24313 #: ../fish/guestfish-actions.pod:2496
24315 "This command runs other libguestfs commands, which might include L</mount> "
24316 "and L</umount>, and therefore you should use this soon after launch and only "
24317 "when nothing is mounted."
24321 #: ../fish/guestfish-actions.pod:2500
24323 "Not all of the filesystems returned will be mountable. In particular, swap "
24324 "partitions are returned in the list. Also this command does not check that "
24325 "each filesystem found is valid and mountable, and some filesystems might be "
24326 "mountable but require special options. Filesystems may not all belong to a "
24327 "single logical operating system (use L</inspect-os> to look for OSes)."
24331 #: ../fish/guestfish-actions.pod:2508
24332 msgid "list-partitions"
24336 #: ../fish/guestfish-actions.pod:2510
24339 " list-partitions\n"
24344 #: ../fish/guestfish-actions.pod:2516
24346 "This does not return logical volumes. For that you will need to call L</"
24351 #: ../fish/guestfish-actions.pod:2521
24356 #: ../fish/guestfish-actions.pod:2523
24364 #: ../fish/guestfish-actions.pod:2531
24369 #: ../fish/guestfish-actions.pod:2533
24372 " ln target linkname\n"
24377 #: ../fish/guestfish-actions.pod:2537
24382 #: ../fish/guestfish-actions.pod:2539
24385 " ln-f target linkname\n"
24390 #: ../fish/guestfish-actions.pod:2544
24395 #: ../fish/guestfish-actions.pod:2546
24398 " ln-s target linkname\n"
24403 #: ../fish/guestfish-actions.pod:2550
24408 #: ../fish/guestfish-actions.pod:2552
24411 " ln-sf target linkname\n"
24416 #: ../fish/guestfish-actions.pod:2557
24417 msgid "lremovexattr"
24421 #: ../fish/guestfish-actions.pod:2559
24424 " lremovexattr xattr path\n"
24429 #: ../fish/guestfish-actions.pod:2561
24431 "This is the same as L</removexattr>, but if C<path> is a symbolic link, then "
24432 "it removes an extended attribute of the link itself."
24436 #: ../fish/guestfish-actions.pod:2565
24441 #: ../fish/guestfish-actions.pod:2567
24449 #: ../fish/guestfish-actions.pod:2573
24451 "This command is mostly useful for interactive sessions. Programs should "
24452 "probably use L</readdir> instead."
24456 #: ../fish/guestfish-actions.pod:2576
24461 #: ../fish/guestfish-actions.pod:2578
24464 " lsetxattr xattr val vallen path\n"
24469 #: ../fish/guestfish-actions.pod:2580
24471 "This is the same as L</setxattr>, but if C<path> is a symbolic link, then it "
24472 "sets an extended attribute of the link itself."
24476 #: ../fish/guestfish-actions.pod:2584
24481 #: ../fish/guestfish-actions.pod:2586
24489 #: ../fish/guestfish-actions.pod:2590
24491 "This is the same as L</stat> except that if C<path> is a symbolic link, then "
24492 "the link is stat-ed, not the file it refers to."
24496 #: ../fish/guestfish-actions.pod:2596
24501 #: ../fish/guestfish-actions.pod:2598
24504 " lstatlist path 'names ...'\n"
24509 #: ../fish/guestfish-actions.pod:2600
24511 "This call allows you to perform the L</lstat> operation on multiple files, "
24512 "where all files are in the directory C<path>. C<names> is the list of files "
24513 "from this directory."
24517 #: ../fish/guestfish-actions.pod:2609
24519 "This call is intended for programs that want to efficiently list a directory "
24520 "contents without making many round-trips. See also L</lxattrlist> for a "
24521 "similarly efficient call for getting extended attributes. Very long "
24522 "directory listings might cause the protocol message size to be exceeded, "
24523 "causing this call to fail. The caller must split up such requests into "
24524 "smaller groups of names."
24528 #: ../fish/guestfish-actions.pod:2617
24529 msgid "luks-add-key"
24533 #: ../fish/guestfish-actions.pod:2619
24536 " luks-add-key device keyslot\n"
24541 #: ../fish/guestfish-actions.pod:2626
24543 "Note that if C<keyslot> already contains a key, then this command will "
24544 "fail. You have to use L</luks-kill-slot> first to remove that key."
24548 #: ../fish/guestfish-actions.pod:2630 ../fish/guestfish-actions.pod:2652
24549 #: ../fish/guestfish-actions.pod:2665 ../fish/guestfish-actions.pod:2679
24550 #: ../fish/guestfish-actions.pod:2702 ../fish/guestfish-actions.pod:2712
24552 "This command has one or more key or passphrase parameters. Guestfish will "
24553 "prompt for these separately."
24557 #: ../fish/guestfish-actions.pod:2633
24562 #: ../fish/guestfish-actions.pod:2635
24565 " luks-close device\n"
24570 #: ../fish/guestfish-actions.pod:2637
24572 "This closes a LUKS device that was created earlier by L</luks-open> or L</"
24573 "luks-open-ro>. The C<device> parameter must be the name of the LUKS mapping "
24574 "device (ie. C</dev/mapper/mapname>) and I<not> the name of the underlying "
24579 #: ../fish/guestfish-actions.pod:2643
24580 msgid "luks-format"
24584 #: ../fish/guestfish-actions.pod:2645
24587 " luks-format device keyslot\n"
24592 #: ../fish/guestfish-actions.pod:2658
24593 msgid "luks-format-cipher"
24597 #: ../fish/guestfish-actions.pod:2660
24600 " luks-format-cipher device keyslot cipher\n"
24605 #: ../fish/guestfish-actions.pod:2662
24607 "This command is the same as L</luks-format> but it also allows you to set "
24608 "the C<cipher> used."
24612 #: ../fish/guestfish-actions.pod:2671
24613 msgid "luks-kill-slot"
24617 #: ../fish/guestfish-actions.pod:2673
24620 " luks-kill-slot device keyslot\n"
24625 #: ../fish/guestfish-actions.pod:2682
24630 #: ../fish/guestfish-actions.pod:2684
24633 " luks-open device mapname\n"
24638 #: ../fish/guestfish-actions.pod:2698
24640 "If this block device contains LVM volume groups, then calling L</vgscan> "
24641 "followed by L</vg-activate-all> will make them visible."
24645 #: ../fish/guestfish-actions.pod:2705
24646 msgid "luks-open-ro"
24650 #: ../fish/guestfish-actions.pod:2707
24653 " luks-open-ro device mapname\n"
24658 #: ../fish/guestfish-actions.pod:2709
24660 "This is the same as L</luks-open> except that a read-only mapping is created."
24664 #: ../fish/guestfish-actions.pod:2715
24669 #: ../fish/guestfish-actions.pod:2717
24672 " lvcreate logvol volgroup mbytes\n"
24677 #: ../fish/guestfish-actions.pod:2722
24678 msgid "lvm-canonical-lv-name"
24682 #: ../fish/guestfish-actions.pod:2724
24685 " lvm-canonical-lv-name lvname\n"
24690 #: ../fish/guestfish-actions.pod:2733
24691 msgid "See also L</is-lv>."
24695 #: ../fish/guestfish-actions.pod:2735
24696 msgid "lvm-clear-filter"
24700 #: ../fish/guestfish-actions.pod:2737
24703 " lvm-clear-filter\n"
24708 #: ../fish/guestfish-actions.pod:2739
24710 "This undoes the effect of L</lvm-set-filter>. LVM will be able to see every "
24715 #: ../fish/guestfish-actions.pod:2745
24716 msgid "lvm-remove-all"
24720 #: ../fish/guestfish-actions.pod:2747
24723 " lvm-remove-all\n"
24728 #: ../fish/guestfish-actions.pod:2755
24729 msgid "lvm-set-filter"
24733 #: ../fish/guestfish-actions.pod:2757
24736 " lvm-set-filter 'devices ...'\n"
24741 #: ../fish/guestfish-actions.pod:2782
24746 #: ../fish/guestfish-actions.pod:2784
24749 " lvremove device\n"
24754 #: ../fish/guestfish-actions.pod:2792
24759 #: ../fish/guestfish-actions.pod:2794
24762 " lvrename logvol newlogvol\n"
24767 #: ../fish/guestfish-actions.pod:2798
24772 #: ../fish/guestfish-actions.pod:2800
24775 " lvresize device mbytes\n"
24780 #: ../fish/guestfish-actions.pod:2806
24781 msgid "lvresize-free"
24785 #: ../fish/guestfish-actions.pod:2808
24788 " lvresize-free lv percent\n"
24793 #: ../fish/guestfish-actions.pod:2816
24798 #: ../fish/guestfish-actions.pod:2818
24806 #: ../fish/guestfish-actions.pod:2826
24807 msgid "See also L</lvs-full>, L</list-filesystems>."
24811 #: ../fish/guestfish-actions.pod:2828
24816 #: ../fish/guestfish-actions.pod:2830
24824 #: ../fish/guestfish-actions.pod:2835
24829 #: ../fish/guestfish-actions.pod:2837
24837 #: ../fish/guestfish-actions.pod:2841
24842 #: ../fish/guestfish-actions.pod:2843
24845 " lxattrlist path 'names ...'\n"
24850 #: ../fish/guestfish-actions.pod:2859
24852 "This call is intended for programs that want to efficiently list a directory "
24853 "contents without making many round-trips. See also L</lstatlist> for a "
24854 "similarly efficient call for getting standard stats. Very long directory "
24855 "listings might cause the protocol message size to be exceeded, causing this "
24856 "call to fail. The caller must split up such requests into smaller groups of "
24861 #: ../fish/guestfish-actions.pod:2867
24866 #: ../fish/guestfish-actions.pod:2869
24874 #: ../fish/guestfish-actions.pod:2873
24879 #: ../fish/guestfish-actions.pod:2875
24882 " mkdir-mode path mode\n"
24887 #: ../fish/guestfish-actions.pod:2884
24888 msgid "See also L</mkdir>, L</umask>"
24892 #: ../fish/guestfish-actions.pod:2886
24897 #: ../fish/guestfish-actions.pod:2888
24905 #: ../fish/guestfish-actions.pod:2893
24910 #: ../fish/guestfish-actions.pod:2895
24913 " mkdtemp template\n"
24918 #: ../fish/guestfish-actions.pod:2916
24923 #: ../fish/guestfish-actions.pod:2918
24926 " mke2fs-J fstype blocksize device journal\n"
24931 #: ../fish/guestfish-actions.pod:2926
24932 msgid "See also L</mke2journal>."
24936 #: ../fish/guestfish-actions.pod:2928
24941 #: ../fish/guestfish-actions.pod:2930
24944 " mke2fs-JL fstype blocksize device label\n"
24949 #: ../fish/guestfish-actions.pod:2935
24950 msgid "See also L</mke2journal-L>."
24954 #: ../fish/guestfish-actions.pod:2937
24959 #: ../fish/guestfish-actions.pod:2939
24962 " mke2fs-JU fstype blocksize device uuid\n"
24967 #: ../fish/guestfish-actions.pod:2944
24968 msgid "See also L</mke2journal-U>."
24972 #: ../fish/guestfish-actions.pod:2946
24973 msgid "mke2journal"
24977 #: ../fish/guestfish-actions.pod:2948
24980 " mke2journal blocksize device\n"
24985 #: ../fish/guestfish-actions.pod:2955
24986 msgid "mke2journal-L"
24990 #: ../fish/guestfish-actions.pod:2957
24993 " mke2journal-L blocksize label device\n"
24998 #: ../fish/guestfish-actions.pod:2961
24999 msgid "mke2journal-U"
25003 #: ../fish/guestfish-actions.pod:2963
25006 " mke2journal-U blocksize uuid device\n"
25011 #: ../fish/guestfish-actions.pod:2967
25016 #: ../fish/guestfish-actions.pod:2969
25019 " mkfifo mode path\n"
25024 #: ../fish/guestfish-actions.pod:2971
25026 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
25027 "is just a convenient wrapper around L</mknod>."
25031 #: ../fish/guestfish-actions.pod:2977
25036 #: ../fish/guestfish-actions.pod:2979
25039 " mkfs fstype device\n"
25044 #: ../fish/guestfish-actions.pod:2985
25049 #: ../fish/guestfish-actions.pod:2987
25052 " mkfs-b fstype blocksize device\n"
25057 #: ../fish/guestfish-actions.pod:2989
25059 "This call is similar to L</mkfs>, but it allows you to control the block "
25060 "size of the resulting filesystem. Supported block sizes depend on the "
25061 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
25065 #: ../fish/guestfish-actions.pod:3004
25070 #: ../fish/guestfish-actions.pod:3006
25073 " mkfs-opts fstype device [blocksize:..] [features:..]\n"
25078 #: ../fish/guestfish-actions.pod:3041
25079 msgid "mkmountpoint"
25083 #: ../fish/guestfish-actions.pod:3043
25086 " mkmountpoint exemptpath\n"
25091 #: ../fish/guestfish-actions.pod:3045
25093 "L</mkmountpoint> and L</rmmountpoint> are specialized calls that can be used "
25094 "to create extra mountpoints before mounting the first filesystem."
25098 #: ../fish/guestfish-actions.pod:3069
25100 "L</mkmountpoint> is not compatible with L</umount-all>. You may get "
25101 "unexpected errors if you try to mix these calls. It is safest to manually "
25102 "unmount filesystems and remove mountpoints after use."
25106 #: ../fish/guestfish-actions.pod:3073
25108 "L</umount-all> unmounts filesystems by sorting the paths longest first, so "
25109 "for this to work for manual mountpoints, you must ensure that the innermost "
25110 "mountpoints have the longest pathnames, as in the example code above."
25114 #: ../fish/guestfish-actions.pod:3080
25116 "Autosync [see L</set-autosync>, this is set by default on handles] can cause "
25117 "L</umount-all> to be called when the handle is closed which can also trigger "
25122 #: ../fish/guestfish-actions.pod:3084
25127 #: ../fish/guestfish-actions.pod:3086
25130 " mknod mode devmajor devminor path\n"
25135 #: ../fish/guestfish-actions.pod:3096
25137 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
25138 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
25139 "regular file). These constants are available in the standard Linux header "
25140 "files, or you can use L</mknod-b>, L</mknod-c> or L</mkfifo> which are "
25141 "wrappers around this command which bitwise OR in the appropriate constant "
25146 #: ../fish/guestfish-actions.pod:3106
25151 #: ../fish/guestfish-actions.pod:3108
25154 " mknod-b mode devmajor devminor path\n"
25159 #: ../fish/guestfish-actions.pod:3110
25161 "This call creates a block device node called C<path> with mode C<mode> and "
25162 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
25163 "wrapper around L</mknod>."
25167 #: ../fish/guestfish-actions.pod:3116
25172 #: ../fish/guestfish-actions.pod:3118
25175 " mknod-c mode devmajor devminor path\n"
25180 #: ../fish/guestfish-actions.pod:3120
25182 "This call creates a char device node called C<path> with mode C<mode> and "
25183 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
25184 "wrapper around L</mknod>."
25188 #: ../fish/guestfish-actions.pod:3126
25193 #: ../fish/guestfish-actions.pod:3128
25201 #: ../fish/guestfish-actions.pod:3132
25206 #: ../fish/guestfish-actions.pod:3134
25209 " mkswap-L label device\n"
25214 #: ../fish/guestfish-actions.pod:3142
25219 #: ../fish/guestfish-actions.pod:3144
25222 " mkswap-U uuid device\n"
25227 #: ../fish/guestfish-actions.pod:3148
25228 msgid "mkswap-file"
25232 #: ../fish/guestfish-actions.pod:3150
25235 " mkswap-file path\n"
25240 #: ../fish/guestfish-actions.pod:3154
25242 "This command just writes a swap file signature to an existing file. To "
25243 "create the file itself, use something like L</fallocate>."
25247 #: ../fish/guestfish-actions.pod:3157
25252 #: ../fish/guestfish-actions.pod:3159
25255 " modprobe modulename\n"
25260 #: ../fish/guestfish-actions.pod:3166
25265 #: ../fish/guestfish-actions.pod:3168
25268 " mount device mountpoint\n"
25273 #: ../fish/guestfish-actions.pod:3184
25275 "B<Important note:> When you use this call, the filesystem options C<sync> "
25276 "and C<noatime> are set implicitly. This was originally done because we "
25277 "thought it would improve reliability, but it turns out that I<-o sync> has a "
25278 "very large negative performance impact and negligible effect on "
25279 "reliability. Therefore we recommend that you avoid using L</mount> in any "
25280 "code that needs performance, and instead use L</mount-options> (use an empty "
25281 "string for the first parameter if you don't want any options)."
25285 #: ../fish/guestfish-actions.pod:3194
25290 #: ../fish/guestfish-actions.pod:3196
25293 " mount-loop file mountpoint\n"
25298 #: ../fish/guestfish-actions.pod:3202
25299 msgid "mount-options"
25303 #: ../fish/guestfish-actions.pod:3204
25306 " mount-options options device mountpoint\n"
25311 #: ../fish/guestfish-actions.pod:3206
25313 "This is the same as the L</mount> command, but it allows you to set the "
25314 "mount options as for the L<mount(8)> I<-o> flag."
25318 #: ../fish/guestfish-actions.pod:3214
25323 #: ../fish/guestfish-actions.pod:3216
25326 " mount-ro device mountpoint\n"
25331 #: ../fish/guestfish-actions.pod:3218
25333 "This is the same as the L</mount> command, but it mounts the filesystem with "
25334 "the read-only (I<-o ro>) flag."
25338 #: ../fish/guestfish-actions.pod:3221
25343 #: ../fish/guestfish-actions.pod:3223
25346 " mount-vfs options vfstype device mountpoint\n"
25351 #: ../fish/guestfish-actions.pod:3225
25353 "This is the same as the L</mount> command, but it allows you to set both the "
25354 "mount options and the vfstype as for the L<mount(8)> I<-o> and I<-t> flags."
25358 #: ../fish/guestfish-actions.pod:3229
25359 msgid "mountpoints"
25363 #: ../fish/guestfish-actions.pod:3231
25371 #: ../fish/guestfish-actions.pod:3233
25373 "This call is similar to L</mounts>. That call returns a list of devices. "
25374 "This one returns a hash table (map) of device name to directory where the "
25375 "device is mounted."
25379 #: ../fish/guestfish-actions.pod:3237
25384 #: ../fish/guestfish-actions.pod:3239
25392 #: ../fish/guestfish-actions.pod:3246
25393 msgid "See also: L</mountpoints>"
25397 #: ../fish/guestfish-actions.pod:3248
25402 #: ../fish/guestfish-actions.pod:3250
25410 #: ../fish/guestfish-actions.pod:3255
25411 msgid "ntfs-3g-probe"
25415 #: ../fish/guestfish-actions.pod:3257
25418 " ntfs-3g-probe true|false device\n"
25423 #: ../fish/guestfish-actions.pod:3271
25428 #: ../fish/guestfish-actions.pod:3273
25431 " ntfsresize device\n"
25436 #: ../fish/guestfish-actions.pod:3279
25437 msgid "ntfsresize-size"
25441 #: ../fish/guestfish-actions.pod:3281
25444 " ntfsresize-size device size\n"
25449 #: ../fish/guestfish-actions.pod:3283
25451 "This command is the same as L</ntfsresize> except that it allows you to "
25452 "specify the new size (in bytes) explicitly."
25456 #: ../fish/guestfish-actions.pod:3286
25461 #: ../fish/guestfish-actions.pod:3288
25464 " part-add device prlogex startsect endsect\n"
25469 #: ../fish/guestfish-actions.pod:3290
25471 "This command adds a partition to C<device>. If there is no partition table "
25472 "on the device, call L</part-init> first."
25476 #: ../fish/guestfish-actions.pod:3302
25478 "Creating a partition which covers the whole disk is not so easy. Use L</"
25479 "part-disk> to do that."
25483 #: ../fish/guestfish-actions.pod:3305
25488 #: ../fish/guestfish-actions.pod:3307
25491 " part-del device partnum\n"
25496 #: ../fish/guestfish-actions.pod:3315
25501 #: ../fish/guestfish-actions.pod:3317
25504 " part-disk device parttype\n"
25509 #: ../fish/guestfish-actions.pod:3319
25511 "This command is simply a combination of L</part-init> followed by L</part-"
25512 "add> to create a single primary partition covering the whole disk."
25516 #: ../fish/guestfish-actions.pod:3323
25518 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
25519 "possible values are described in L</part-init>."
25523 #: ../fish/guestfish-actions.pod:3329
25524 msgid "part-get-bootable"
25528 #: ../fish/guestfish-actions.pod:3331
25531 " part-get-bootable device partnum\n"
25536 #: ../fish/guestfish-actions.pod:3336
25537 msgid "See also L</part-set-bootable>."
25541 #: ../fish/guestfish-actions.pod:3338
25542 msgid "part-get-mbr-id"
25546 #: ../fish/guestfish-actions.pod:3340
25549 " part-get-mbr-id device partnum\n"
25554 #: ../fish/guestfish-actions.pod:3345 ../fish/guestfish-actions.pod:3483
25556 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
25557 "undefined results for other partition table types (see L</part-get-"
25562 #: ../fish/guestfish-actions.pod:3349
25563 msgid "part-get-parttype"
25567 #: ../fish/guestfish-actions.pod:3351
25570 " part-get-parttype device\n"
25575 #: ../fish/guestfish-actions.pod:3356
25577 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
25578 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
25579 "possible, although unusual. See L</part-init> for a full list."
25583 #: ../fish/guestfish-actions.pod:3361
25588 #: ../fish/guestfish-actions.pod:3363
25591 " part-init device parttype\n"
25596 #: ../fish/guestfish-actions.pod:3369
25598 "Initially there are no partitions. Following this, you should call L</part-"
25599 "add> for each partition required."
25603 #: ../fish/guestfish-actions.pod:3432
25608 #: ../fish/guestfish-actions.pod:3434
25611 " part-list device\n"
25616 #: ../fish/guestfish-actions.pod:3449
25618 "Start of the partition I<in bytes>. To get sectors you have to divide by "
25619 "the device's sector size, see L</blockdev-getss>."
25623 #: ../fish/guestfish-actions.pod:3462
25624 msgid "part-set-bootable"
25628 #: ../fish/guestfish-actions.pod:3464
25631 " part-set-bootable device partnum true|false\n"
25636 #: ../fish/guestfish-actions.pod:3473
25637 msgid "part-set-mbr-id"
25641 #: ../fish/guestfish-actions.pod:3475
25644 " part-set-mbr-id device partnum idbyte\n"
25649 #: ../fish/guestfish-actions.pod:3487
25650 msgid "part-set-name"
25654 #: ../fish/guestfish-actions.pod:3489
25657 " part-set-name device partnum name\n"
25662 #: ../fish/guestfish-actions.pod:3497
25663 msgid "part-to-dev"
25667 #: ../fish/guestfish-actions.pod:3499
25670 " part-to-dev partition\n"
25675 #: ../fish/guestfish-actions.pod:3505
25677 "The named partition must exist, for example as a string returned from L</"
25678 "list-partitions>."
25682 #: ../fish/guestfish-actions.pod:3508
25683 msgid "ping-daemon"
25687 #: ../fish/guestfish-actions.pod:3510
25695 #: ../fish/guestfish-actions.pod:3517
25700 #: ../fish/guestfish-actions.pod:3519
25703 " pread path count offset\n"
25708 #: ../fish/guestfish-actions.pod:3527
25709 msgid "See also L</pwrite>, L</pread-device>."
25713 #: ../fish/guestfish-actions.pod:3532
25714 msgid "pread-device"
25718 #: ../fish/guestfish-actions.pod:3534
25721 " pread-device device count offset\n"
25726 #: ../fish/guestfish-actions.pod:3542
25727 msgid "See also L</pread>."
25731 #: ../fish/guestfish-actions.pod:3547
25736 #: ../fish/guestfish-actions.pod:3549
25739 " pvcreate device\n"
25744 #: ../fish/guestfish-actions.pod:3555
25749 #: ../fish/guestfish-actions.pod:3557
25752 " pvremove device\n"
25757 #: ../fish/guestfish-actions.pod:3566
25762 #: ../fish/guestfish-actions.pod:3568
25765 " pvresize device\n"
25770 #: ../fish/guestfish-actions.pod:3573
25771 msgid "pvresize-size"
25775 #: ../fish/guestfish-actions.pod:3575
25778 " pvresize-size device size\n"
25783 #: ../fish/guestfish-actions.pod:3577
25785 "This command is the same as L</pvresize> except that it allows you to "
25786 "specify the new size (in bytes) explicitly."
25790 #: ../fish/guestfish-actions.pod:3580
25795 #: ../fish/guestfish-actions.pod:3582
25803 #: ../fish/guestfish-actions.pod:3590
25804 msgid "See also L</pvs-full>."
25808 #: ../fish/guestfish-actions.pod:3592
25813 #: ../fish/guestfish-actions.pod:3594
25821 #: ../fish/guestfish-actions.pod:3599
25826 #: ../fish/guestfish-actions.pod:3601
25834 #: ../fish/guestfish-actions.pod:3605
25839 #: ../fish/guestfish-actions.pod:3607
25842 " pwrite path content offset\n"
25847 #: ../fish/guestfish-actions.pod:3618
25848 msgid "See also L</pread>, L</pwrite-device>."
25852 #: ../fish/guestfish-actions.pod:3623
25853 msgid "pwrite-device"
25857 #: ../fish/guestfish-actions.pod:3625
25860 " pwrite-device device content offset\n"
25865 #: ../fish/guestfish-actions.pod:3635
25866 msgid "See also L</pwrite>."
25870 #: ../fish/guestfish-actions.pod:3640
25875 #: ../fish/guestfish-actions.pod:3642
25878 " read-file path\n"
25883 #: ../fish/guestfish-actions.pod:3647
25885 "Unlike L</cat>, this function can correctly handle files that contain "
25886 "embedded ASCII NUL characters. However unlike L</download>, this function "
25887 "is limited in the total size of file that can be handled."
25891 #: ../fish/guestfish-actions.pod:3655
25896 #: ../fish/guestfish-actions.pod:3657
25899 " read-lines path\n"
25904 #: ../fish/guestfish-actions.pod:3664
25906 "Note that this function cannot correctly handle binary files (specifically, "
25907 "files containing C<\\0> character which is treated as end of line). For "
25908 "those you need to use the L</read-file> function which has a more complex "
25913 #: ../fish/guestfish-actions.pod:3669
25918 #: ../fish/guestfish-actions.pod:3671
25926 #: ../fish/guestfish-actions.pod:3723
25928 "This function is primarily intended for use by programs. To get a simple "
25929 "list of names, use L</ls>. To get a printable directory for human "
25930 "consumption, use L</ll>."
25934 #: ../fish/guestfish-actions.pod:3727
25939 #: ../fish/guestfish-actions.pod:3729
25947 #: ../fish/guestfish-actions.pod:3733
25948 msgid "readlinklist"
25952 #: ../fish/guestfish-actions.pod:3735
25955 " readlinklist path 'names ...'\n"
25960 #: ../fish/guestfish-actions.pod:3759
25965 #: ../fish/guestfish-actions.pod:3761
25973 #: ../fish/guestfish-actions.pod:3766
25974 msgid "removexattr"
25978 #: ../fish/guestfish-actions.pod:3768
25981 " removexattr xattr path\n"
25986 #: ../fish/guestfish-actions.pod:3773
25987 msgid "See also: L</lremovexattr>, L<attr(5)>."
25991 #: ../fish/guestfish-actions.pod:3775
25996 #: ../fish/guestfish-actions.pod:3777
25999 " resize2fs device\n"
26004 #: ../fish/guestfish-actions.pod:3782
26006 "I<Note:> It is sometimes required that you run L</e2fsck-f> on the C<device> "
26007 "before calling this command. For unknown reasons C<resize2fs> sometimes "
26008 "gives an error about this and sometimes not. In any case, it is always safe "
26009 "to call L</e2fsck-f> before calling this function."
26013 #: ../fish/guestfish-actions.pod:3788
26014 msgid "resize2fs-M"
26018 #: ../fish/guestfish-actions.pod:3790
26021 " resize2fs-M device\n"
26026 #: ../fish/guestfish-actions.pod:3792
26028 "This command is the same as L</resize2fs>, but the filesystem is resized to "
26029 "its minimum size. This works like the C<-M> option to the C<resize2fs> "
26034 #: ../fish/guestfish-actions.pod:3796
26036 "To get the resulting size of the filesystem you should call L</tune2fs-l> "
26037 "and read the C<Block size> and C<Block count> values. These two numbers, "
26038 "multiplied together, give the resulting size of the minimal filesystem in "
26043 #: ../fish/guestfish-actions.pod:3801
26044 msgid "resize2fs-size"
26048 #: ../fish/guestfish-actions.pod:3803
26051 " resize2fs-size device size\n"
26056 #: ../fish/guestfish-actions.pod:3805
26058 "This command is the same as L</resize2fs> except that it allows you to "
26059 "specify the new size (in bytes) explicitly."
26063 #: ../fish/guestfish-actions.pod:3808
26068 #: ../fish/guestfish-actions.pod:3810
26076 #: ../fish/guestfish-actions.pod:3814
26081 #: ../fish/guestfish-actions.pod:3816
26089 #: ../fish/guestfish-actions.pod:3822
26094 #: ../fish/guestfish-actions.pod:3824
26102 #: ../fish/guestfish-actions.pod:3828
26103 msgid "rmmountpoint"
26107 #: ../fish/guestfish-actions.pod:3830
26110 " rmmountpoint exemptpath\n"
26115 #: ../fish/guestfish-actions.pod:3832
26117 "This calls removes a mountpoint that was previously created with L</"
26118 "mkmountpoint>. See L</mkmountpoint> for full details."
26122 #: ../fish/guestfish-actions.pod:3836
26123 msgid "scrub-device"
26127 #: ../fish/guestfish-actions.pod:3838
26130 " scrub-device device\n"
26135 #: ../fish/guestfish-actions.pod:3849
26140 #: ../fish/guestfish-actions.pod:3851
26143 " scrub-file file\n"
26148 #: ../fish/guestfish-actions.pod:3861
26149 msgid "scrub-freespace"
26153 #: ../fish/guestfish-actions.pod:3863
26156 " scrub-freespace dir\n"
26161 #: ../fish/guestfish-actions.pod:3865
26163 "This command creates the directory C<dir> and then fills it with files until "
26164 "the filesystem is full, and scrubs the files as for L</scrub-file>, and "
26165 "deletes them. The intention is to scrub any free space on the partition "
26166 "containing C<dir>."
26170 #: ../fish/guestfish-actions.pod:3874
26175 #: ../fish/guestfish-actions.pod:3876
26180 #: ../fish/guestfish-actions.pod:3878
26183 " set-append append\n"
26188 #: ../fish/guestfish-actions.pod:3889
26189 msgid "set-attach-method"
26193 #: ../fish/guestfish-actions.pod:3891
26194 msgid "attach-method"
26198 #: ../fish/guestfish-actions.pod:3893
26201 " set-attach-method attachmethod\n"
26206 #: ../fish/guestfish-actions.pod:3915
26207 msgid "set-autosync"
26211 #: ../fish/guestfish-actions.pod:3917
26216 #: ../fish/guestfish-actions.pod:3919
26219 " set-autosync true|false\n"
26224 #: ../fish/guestfish-actions.pod:3929
26229 #: ../fish/guestfish-actions.pod:3931
26234 #: ../fish/guestfish-actions.pod:3933
26237 " set-direct true|false\n"
26242 #: ../fish/guestfish-actions.pod:3939
26244 "One consequence of this is that log messages aren't caught by the library "
26245 "and handled by L</set-log-message-callback>, but go straight to stdout."
26249 #: ../fish/guestfish-actions.pod:3948
26250 msgid "set-e2label"
26254 #: ../fish/guestfish-actions.pod:3950
26257 " set-e2label device label\n"
26262 #: ../fish/guestfish-actions.pod:3956
26264 "You can use either L</tune2fs-l> or L</get-e2label> to return the existing "
26265 "label on a filesystem."
26269 #: ../fish/guestfish-actions.pod:3959
26274 #: ../fish/guestfish-actions.pod:3961
26277 " set-e2uuid device uuid\n"
26282 #: ../fish/guestfish-actions.pod:3968
26284 "You can use either L</tune2fs-l> or L</get-e2uuid> to return the existing "
26285 "UUID of a filesystem."
26289 #: ../fish/guestfish-actions.pod:3971
26290 msgid "set-memsize"
26294 #: ../fish/guestfish-actions.pod:3973
26299 #: ../fish/guestfish-actions.pod:3975
26302 " set-memsize memsize\n"
26307 #: ../fish/guestfish-actions.pod:3977
26309 "This sets the memory size in megabytes allocated to the qemu subprocess. "
26310 "This only has any effect if called before L</launch>."
26314 #: ../fish/guestfish-actions.pod:3988
26315 msgid "set-network"
26319 #: ../fish/guestfish-actions.pod:3990
26324 #: ../fish/guestfish-actions.pod:3992
26327 " set-network true|false\n"
26332 #: ../fish/guestfish-actions.pod:4000
26334 "You must call this before calling L</launch>, otherwise it has no effect."
26338 #: ../fish/guestfish-actions.pod:4003
26343 #: ../fish/guestfish-actions.pod:4005
26348 #: ../fish/guestfish-actions.pod:4007
26351 " set-path searchpath\n"
26356 #: ../fish/guestfish-actions.pod:4016
26361 #: ../fish/guestfish-actions.pod:4018
26366 #: ../fish/guestfish-actions.pod:4020
26374 #: ../fish/guestfish-actions.pod:4040
26375 msgid "set-recovery-proc"
26379 #: ../fish/guestfish-actions.pod:4042
26380 msgid "recovery-proc"
26384 #: ../fish/guestfish-actions.pod:4044
26387 " set-recovery-proc true|false\n"
26392 #: ../fish/guestfish-actions.pod:4046
26394 "If this is called with the parameter C<false> then L</launch> does not "
26395 "create a recovery process. The purpose of the recovery process is to stop "
26396 "runaway qemu processes in the case where the main program aborts abruptly."
26400 #: ../fish/guestfish-actions.pod:4051
26402 "This only has any effect if called before L</launch>, and the default is "
26407 #: ../fish/guestfish-actions.pod:4060
26408 msgid "set-selinux"
26412 #: ../fish/guestfish-actions.pod:4062
26417 #: ../fish/guestfish-actions.pod:4064
26420 " set-selinux true|false\n"
26425 #: ../fish/guestfish-actions.pod:4075
26430 #: ../fish/guestfish-actions.pod:4077
26435 #: ../fish/guestfish-actions.pod:4079
26438 " set-trace true|false\n"
26443 #: ../fish/guestfish-actions.pod:4091
26445 "Trace messages are normally sent to C<stderr>, unless you register a "
26446 "callback to send them somewhere else (see L</set-event-callback>)."
26450 #: ../fish/guestfish-actions.pod:4095
26451 msgid "set-verbose"
26455 #: ../fish/guestfish-actions.pod:4097
26460 #: ../fish/guestfish-actions.pod:4099
26463 " set-verbose true|false\n"
26468 #: ../fish/guestfish-actions.pod:4106
26470 "Verbose messages are normally sent to C<stderr>, unless you register a "
26471 "callback to send them somewhere else (see L</set-event-callback>)."
26475 #: ../fish/guestfish-actions.pod:4110
26480 #: ../fish/guestfish-actions.pod:4112
26483 " setcon context\n"
26488 #: ../fish/guestfish-actions.pod:4119
26493 #: ../fish/guestfish-actions.pod:4121
26496 " setxattr xattr val vallen path\n"
26501 #: ../fish/guestfish-actions.pod:4127
26502 msgid "See also: L</lsetxattr>, L<attr(5)>."
26506 #: ../fish/guestfish-actions.pod:4129
26511 #: ../fish/guestfish-actions.pod:4131
26514 " sfdisk device cyls heads sectors 'lines ...'\n"
26519 #: ../fish/guestfish-actions.pod:4153
26520 msgid "See also: L</sfdisk-l>, L</sfdisk-N>, L</part-init>"
26524 #: ../fish/guestfish-actions.pod:4159
26529 #: ../fish/guestfish-actions.pod:4161
26532 " sfdiskM device 'lines ...'\n"
26537 #: ../fish/guestfish-actions.pod:4163
26539 "This is a simplified interface to the L</sfdisk> command, where partition "
26540 "sizes are specified in megabytes only (rounded to the nearest cylinder) and "
26541 "you don't need to specify the cyls, heads and sectors parameters which were "
26542 "rarely if ever used anyway."
26546 #: ../fish/guestfish-actions.pod:4169
26547 msgid "See also: L</sfdisk>, the L<sfdisk(8)> manpage and L</part-disk>"
26551 #: ../fish/guestfish-actions.pod:4175
26556 #: ../fish/guestfish-actions.pod:4177
26559 " sfdisk-N device partnum cyls heads sectors line\n"
26564 #: ../fish/guestfish-actions.pod:4182
26566 "For other parameters, see L</sfdisk>. You should usually pass C<0> for the "
26567 "cyls/heads/sectors parameters."
26571 #: ../fish/guestfish-actions.pod:4185
26572 msgid "See also: L</part-add>"
26576 #: ../fish/guestfish-actions.pod:4190
26577 msgid "sfdisk-disk-geometry"
26581 #: ../fish/guestfish-actions.pod:4192
26584 " sfdisk-disk-geometry device\n"
26589 #: ../fish/guestfish-actions.pod:4194
26591 "This displays the disk geometry of C<device> read from the partition table. "
26592 "Especially in the case where the underlying block device has been resized, "
26593 "this can be different from the kernel's idea of the geometry (see L</sfdisk-"
26594 "kernel-geometry>)."
26598 #: ../fish/guestfish-actions.pod:4202
26599 msgid "sfdisk-kernel-geometry"
26603 #: ../fish/guestfish-actions.pod:4204
26606 " sfdisk-kernel-geometry device\n"
26611 #: ../fish/guestfish-actions.pod:4211
26616 #: ../fish/guestfish-actions.pod:4213
26619 " sfdisk-l device\n"
26624 #: ../fish/guestfish-actions.pod:4219
26625 msgid "See also: L</part-list>"
26629 #: ../fish/guestfish-actions.pod:4221
26634 #: ../fish/guestfish-actions.pod:4223
26642 #: ../fish/guestfish-actions.pod:4228
26643 msgid "This is like L</command>, but passes the command to:"
26647 #: ../fish/guestfish-actions.pod:4236
26648 msgid "All the provisos about L</command> apply to this call."
26652 #: ../fish/guestfish-actions.pod:4238
26657 #: ../fish/guestfish-actions.pod:4240
26660 " sh-lines command\n"
26665 #: ../fish/guestfish-actions.pod:4242
26666 msgid "This is the same as L</sh>, but splits the result into a list of lines."
26670 #: ../fish/guestfish-actions.pod:4245
26671 msgid "See also: L</command-lines>"
26675 #: ../fish/guestfish-actions.pod:4247
26680 #: ../fish/guestfish-actions.pod:4249
26688 #: ../fish/guestfish-actions.pod:4253
26693 #: ../fish/guestfish-actions.pod:4255
26701 #: ../fish/guestfish-actions.pod:4261
26706 #: ../fish/guestfish-actions.pod:4263
26714 #: ../fish/guestfish-actions.pod:4271
26719 #: ../fish/guestfish-actions.pod:4273
26727 #: ../fish/guestfish-actions.pod:4281
26732 #: ../fish/guestfish-actions.pod:4283
26735 " strings-e encoding path\n"
26740 #: ../fish/guestfish-actions.pod:4285
26742 "This is like the L</strings> command, but allows you to specify the encoding "
26743 "of strings that are looked for in the source file C<path>."
26747 #: ../fish/guestfish-actions.pod:4295
26749 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
26750 "ISO-8859-X (this is what L</strings> uses)."
26754 #: ../fish/guestfish-actions.pod:4327
26755 msgid "swapoff-device"
26759 #: ../fish/guestfish-actions.pod:4329
26762 " swapoff-device device\n"
26767 #: ../fish/guestfish-actions.pod:4331
26769 "This command disables the libguestfs appliance swap device or partition "
26770 "named C<device>. See L</swapon-device>."
26774 #: ../fish/guestfish-actions.pod:4335
26775 msgid "swapoff-file"
26779 #: ../fish/guestfish-actions.pod:4337
26782 " swapoff-file file\n"
26787 #: ../fish/guestfish-actions.pod:4341
26788 msgid "swapoff-label"
26792 #: ../fish/guestfish-actions.pod:4343
26795 " swapoff-label label\n"
26800 #: ../fish/guestfish-actions.pod:4348
26801 msgid "swapoff-uuid"
26805 #: ../fish/guestfish-actions.pod:4350
26808 " swapoff-uuid uuid\n"
26813 #: ../fish/guestfish-actions.pod:4355
26814 msgid "swapon-device"
26818 #: ../fish/guestfish-actions.pod:4357
26821 " swapon-device device\n"
26826 #: ../fish/guestfish-actions.pod:4359
26828 "This command enables the libguestfs appliance to use the swap device or "
26829 "partition named C<device>. The increased memory is made available for all "
26830 "commands, for example those run using L</command> or L</sh>."
26834 #: ../fish/guestfish-actions.pod:4371
26835 msgid "swapon-file"
26839 #: ../fish/guestfish-actions.pod:4373
26842 " swapon-file file\n"
26847 #: ../fish/guestfish-actions.pod:4375
26849 "This command enables swap to a file. See L</swapon-device> for other notes."
26853 #: ../fish/guestfish-actions.pod:4378
26854 msgid "swapon-label"
26858 #: ../fish/guestfish-actions.pod:4380
26861 " swapon-label label\n"
26866 #: ../fish/guestfish-actions.pod:4382
26868 "This command enables swap to a labeled swap partition. See L</swapon-"
26869 "device> for other notes."
26873 #: ../fish/guestfish-actions.pod:4385
26874 msgid "swapon-uuid"
26878 #: ../fish/guestfish-actions.pod:4387
26881 " swapon-uuid uuid\n"
26886 #: ../fish/guestfish-actions.pod:4389
26888 "This command enables swap to a swap partition with the given UUID. See L</"
26889 "swapon-device> for other notes."
26893 #: ../fish/guestfish-actions.pod:4392
26898 #: ../fish/guestfish-actions.pod:4394
26906 #: ../fish/guestfish-actions.pod:4402
26911 #: ../fish/guestfish-actions.pod:4404
26919 #: ../fish/guestfish-actions.pod:4412
26924 #: ../fish/guestfish-actions.pod:4414
26927 " tail-n nrlines path\n"
26932 #: ../fish/guestfish-actions.pod:4427
26937 #: ../fish/guestfish-actions.pod:4429
26940 " tar-in (tarfile|-) directory\n"
26945 #: ../fish/guestfish-actions.pod:4434
26946 msgid "To upload a compressed tarball, use L</tgz-in> or L</txz-in>."
26950 #: ../fish/guestfish-actions.pod:4439
26955 #: ../fish/guestfish-actions.pod:4441
26958 " tar-out directory (tarfile|-)\n"
26963 #: ../fish/guestfish-actions.pod:4446
26964 msgid "To download a compressed tarball, use L</tgz-out> or L</txz-out>."
26968 #: ../fish/guestfish-actions.pod:4451
26973 #: ../fish/guestfish-actions.pod:4453
26976 " tgz-in (tarball|-) directory\n"
26981 #: ../fish/guestfish-actions.pod:4458
26982 msgid "To upload an uncompressed tarball, use L</tar-in>."
26986 #: ../fish/guestfish-actions.pod:4462
26991 #: ../fish/guestfish-actions.pod:4464
26994 " tgz-out directory (tarball|-)\n"
26999 #: ../fish/guestfish-actions.pod:4469
27000 msgid "To download an uncompressed tarball, use L</tar-out>."
27004 #: ../fish/guestfish-actions.pod:4473
27009 #: ../fish/guestfish-actions.pod:4475
27017 #: ../fish/guestfish-actions.pod:4484
27022 #: ../fish/guestfish-actions.pod:4486
27030 #: ../fish/guestfish-actions.pod:4491
27031 msgid "truncate-size"
27035 #: ../fish/guestfish-actions.pod:4493
27038 " truncate-size path size\n"
27043 #: ../fish/guestfish-actions.pod:4498
27045 "If the current file size is less than C<size> then the file is extended to "
27046 "the required size with zero bytes. This creates a sparse file (ie. disk "
27047 "blocks are not allocated for the file until you write to it). To create a "
27048 "non-sparse file of zeroes, use L</fallocate64> instead."
27052 #: ../fish/guestfish-actions.pod:4504
27057 #: ../fish/guestfish-actions.pod:4506
27060 " tune2fs-l device\n"
27065 #: ../fish/guestfish-actions.pod:4516
27070 #: ../fish/guestfish-actions.pod:4518
27073 " txz-in (tarball|-) directory\n"
27078 #: ../fish/guestfish-actions.pod:4525
27083 #: ../fish/guestfish-actions.pod:4527
27086 " txz-out directory (tarball|-)\n"
27091 #: ../fish/guestfish-actions.pod:4534
27096 #: ../fish/guestfish-actions.pod:4536
27104 #: ../fish/guestfish-actions.pod:4550
27105 msgid "See also L</get-umask>, L<umask(2)>, L</mknod>, L</mkdir>."
27109 #: ../fish/guestfish-actions.pod:4555
27114 #: ../fish/guestfish-actions.pod:4557
27119 #: ../fish/guestfish-actions.pod:4559
27122 " umount pathordevice\n"
27127 #: ../fish/guestfish-actions.pod:4565
27132 #: ../fish/guestfish-actions.pod:4567
27133 msgid "unmount-all"
27137 #: ../fish/guestfish-actions.pod:4569
27145 #: ../fish/guestfish-actions.pod:4575
27150 #: ../fish/guestfish-actions.pod:4577
27153 " upload (filename|-) remotefilename\n"
27158 #: ../fish/guestfish-actions.pod:4584
27159 msgid "See also L</download>."
27163 #: ../fish/guestfish-actions.pod:4588
27164 msgid "upload-offset"
27168 #: ../fish/guestfish-actions.pod:4590
27171 " upload-offset (filename|-) remotefilename offset\n"
27176 #: ../fish/guestfish-actions.pod:4602
27178 "Note that there is no limit on the amount of data that can be uploaded with "
27179 "this call, unlike with L</pwrite>, and this call always writes the full "
27180 "amount unless an error occurs."
27184 #: ../fish/guestfish-actions.pod:4607
27185 msgid "See also L</upload>, L</pwrite>."
27189 #: ../fish/guestfish-actions.pod:4611
27194 #: ../fish/guestfish-actions.pod:4613
27197 " utimens path atsecs atnsecs mtsecs mtnsecs\n"
27202 #: ../fish/guestfish-actions.pod:4632
27207 #: ../fish/guestfish-actions.pod:4634
27215 #: ../fish/guestfish-actions.pod:4661
27217 "I<Note:> Don't use this call to test for availability of features. In "
27218 "enterprise distributions we backport features from later versions into "
27219 "earlier versions, making this an unreliable way to test for features. Use "
27220 "L</available> instead."
27224 #: ../fish/guestfish-actions.pod:4667
27229 #: ../fish/guestfish-actions.pod:4669
27232 " vfs-label device\n"
27237 #: ../fish/guestfish-actions.pod:4676
27238 msgid "To find a filesystem from the label, use L</findfs-label>."
27242 #: ../fish/guestfish-actions.pod:4678
27247 #: ../fish/guestfish-actions.pod:4680
27250 " vfs-type device\n"
27255 #: ../fish/guestfish-actions.pod:4690
27260 #: ../fish/guestfish-actions.pod:4692
27263 " vfs-uuid device\n"
27268 #: ../fish/guestfish-actions.pod:4699
27269 msgid "To find a filesystem from the UUID, use L</findfs-uuid>."
27273 #: ../fish/guestfish-actions.pod:4701
27274 msgid "vg-activate"
27278 #: ../fish/guestfish-actions.pod:4703
27281 " vg-activate true|false 'volgroups ...'\n"
27286 #: ../fish/guestfish-actions.pod:4716
27287 msgid "vg-activate-all"
27291 #: ../fish/guestfish-actions.pod:4718
27294 " vg-activate-all true|false\n"
27299 #: ../fish/guestfish-actions.pod:4728
27304 #: ../fish/guestfish-actions.pod:4730
27307 " vgcreate volgroup 'physvols ...'\n"
27312 #: ../fish/guestfish-actions.pod:4735
27317 #: ../fish/guestfish-actions.pod:4737
27320 " vglvuuids vgname\n"
27325 #: ../fish/guestfish-actions.pod:4742
27327 "You can use this along with L</lvs> and L</lvuuid> calls to associate "
27328 "logical volumes and volume groups."
27332 #: ../fish/guestfish-actions.pod:4745
27333 msgid "See also L</vgpvuuids>."
27337 #: ../fish/guestfish-actions.pod:4747
27342 #: ../fish/guestfish-actions.pod:4749
27345 " vgpvuuids vgname\n"
27350 #: ../fish/guestfish-actions.pod:4754
27352 "You can use this along with L</pvs> and L</pvuuid> calls to associate "
27353 "physical volumes and volume groups."
27357 #: ../fish/guestfish-actions.pod:4757
27358 msgid "See also L</vglvuuids>."
27362 #: ../fish/guestfish-actions.pod:4759
27367 #: ../fish/guestfish-actions.pod:4761
27370 " vgremove vgname\n"
27375 #: ../fish/guestfish-actions.pod:4768
27380 #: ../fish/guestfish-actions.pod:4770
27383 " vgrename volgroup newvolgroup\n"
27388 #: ../fish/guestfish-actions.pod:4774
27393 #: ../fish/guestfish-actions.pod:4776
27401 #: ../fish/guestfish-actions.pod:4784
27402 msgid "See also L</vgs-full>."
27406 #: ../fish/guestfish-actions.pod:4786
27411 #: ../fish/guestfish-actions.pod:4788
27419 #: ../fish/guestfish-actions.pod:4793
27424 #: ../fish/guestfish-actions.pod:4795
27432 #: ../fish/guestfish-actions.pod:4800
27437 #: ../fish/guestfish-actions.pod:4802
27445 #: ../fish/guestfish-actions.pod:4806
27450 #: ../fish/guestfish-actions.pod:4808
27458 #: ../fish/guestfish-actions.pod:4813
27463 #: ../fish/guestfish-actions.pod:4815
27471 #: ../fish/guestfish-actions.pod:4820
27476 #: ../fish/guestfish-actions.pod:4822
27484 #: ../fish/guestfish-actions.pod:4827
27489 #: ../fish/guestfish-actions.pod:4829
27492 " write path content\n"
27497 #: ../fish/guestfish-actions.pod:4837
27502 #: ../fish/guestfish-actions.pod:4839
27505 " write-file path content size\n"
27510 #: ../fish/guestfish-actions.pod:4862
27515 #: ../fish/guestfish-actions.pod:4864
27518 " zegrep regex path\n"
27523 #: ../fish/guestfish-actions.pod:4872
27528 #: ../fish/guestfish-actions.pod:4874
27531 " zegrepi regex path\n"
27536 #: ../fish/guestfish-actions.pod:4882
27541 #: ../fish/guestfish-actions.pod:4884
27549 #: ../fish/guestfish-actions.pod:4892
27550 msgid "See also: L</zero-device>, L</scrub-device>."
27554 #: ../fish/guestfish-actions.pod:4894
27555 msgid "zero-device"
27559 #: ../fish/guestfish-actions.pod:4896
27562 " zero-device device\n"
27567 #: ../fish/guestfish-actions.pod:4898
27569 "This command writes zeroes over the entire C<device>. Compare with L</zero> "
27570 "which just zeroes the first few blocks of a device."
27574 #: ../fish/guestfish-actions.pod:4905
27579 #: ../fish/guestfish-actions.pod:4907
27582 " zerofree device\n"
27587 #: ../fish/guestfish-actions.pod:4920
27592 #: ../fish/guestfish-actions.pod:4922
27595 " zfgrep pattern path\n"
27600 #: ../fish/guestfish-actions.pod:4930
27605 #: ../fish/guestfish-actions.pod:4932
27608 " zfgrepi pattern path\n"
27613 #: ../fish/guestfish-actions.pod:4940
27618 #: ../fish/guestfish-actions.pod:4942
27621 " zfile meth path\n"
27626 #: ../fish/guestfish-actions.pod:4949
27628 "Since 1.0.63, use L</file> instead which can now process compressed files."
27632 #: ../fish/guestfish-actions.pod:4959
27637 #: ../fish/guestfish-actions.pod:4961
27640 " zgrep regex path\n"
27645 #: ../fish/guestfish-actions.pod:4969
27650 #: ../fish/guestfish-actions.pod:4971
27653 " zgrepi regex path\n"
27658 #: ../fish/guestfish-commands.pod:1
27663 #: ../fish/guestfish-commands.pod:3
27668 #: ../fish/guestfish-commands.pod:5
27671 " alloc filename size\n"
27676 #: ../fish/guestfish-commands.pod:7
27678 "This creates an empty (zeroed) file of the given size, and then adds so it "
27679 "can be further examined."
27683 #: ../fish/guestfish-commands.pod:10 ../fish/guestfish-commands.pod:168
27684 msgid "For more advanced image creation, see L<qemu-img(1)> utility."
27688 #: ../fish/guestfish-commands.pod:12 ../fish/guestfish-commands.pod:170
27689 msgid "Size can be specified using standard suffixes, eg. C<1M>."
27693 #: ../fish/guestfish-commands.pod:14
27695 "To create a sparse file, use L</sparse> instead. To create a prepared disk "
27696 "image, see L</PREPARED DISK IMAGES>."
27700 #: ../fish/guestfish-commands.pod:17
27705 #: ../fish/guestfish-commands.pod:19
27708 " copy-in local [local ...] /remotedir\n"
27713 #: ../fish/guestfish-commands.pod:21
27715 "C<copy-in> copies local files or directories recursively into the disk "
27716 "image, placing them in the directory called C</remotedir> (which must "
27717 "exist). This guestfish meta-command turns into a sequence of L</tar-in> and "
27718 "other commands as necessary."
27722 #: ../fish/guestfish-commands.pod:26
27724 "Multiple local files and directories can be specified, but the last "
27725 "parameter must always be a remote directory. Wildcards cannot be used."
27729 #: ../fish/guestfish-commands.pod:30
27734 #: ../fish/guestfish-commands.pod:32
27737 " copy-out remote [remote ...] localdir\n"
27742 #: ../fish/guestfish-commands.pod:34
27744 "C<copy-out> copies remote files or directories recursively out of the disk "
27745 "image, placing them on the host disk in a local directory called C<localdir> "
27746 "(which must exist). This guestfish meta-command turns into a sequence of L</"
27747 "download>, L</tar-out> and other commands as necessary."
27751 #: ../fish/guestfish-commands.pod:40
27753 "Multiple remote files and directories can be specified, but the last "
27754 "parameter must always be a local directory. To download to the current "
27755 "directory, use C<.> as in:"
27759 #: ../fish/guestfish-commands.pod:44
27762 " copy-out /home .\n"
27767 #: ../fish/guestfish-commands.pod:46
27769 "Wildcards cannot be used in the ordinary command, but you can use them with "
27770 "the help of L</glob> like this:"
27774 #: ../fish/guestfish-commands.pod:49
27777 " glob copy-out /home/* .\n"
27782 #: ../fish/guestfish-commands.pod:51
27787 #: ../fish/guestfish-commands.pod:53
27790 " echo [params ...]\n"
27795 #: ../fish/guestfish-commands.pod:55
27796 msgid "This echos the parameters to the terminal."
27800 #: ../fish/guestfish-commands.pod:57
27805 #: ../fish/guestfish-commands.pod:59
27810 #: ../fish/guestfish-commands.pod:61
27815 #: ../fish/guestfish-commands.pod:63
27823 #: ../fish/guestfish-commands.pod:65
27825 "This is used to edit a file. It downloads the file, edits it locally using "
27826 "your editor, then uploads the result."
27830 #: ../fish/guestfish-commands.pod:68
27832 "The editor is C<$EDITOR>. However if you use the alternate commands C<vi> "
27833 "or C<emacs> you will get those corresponding editors."
27837 #: ../fish/guestfish-commands.pod:72
27842 #: ../fish/guestfish-commands.pod:74
27845 " glob command args...\n"
27850 #: ../fish/guestfish-commands.pod:76
27852 "Expand wildcards in any paths in the args list, and run C<command> "
27853 "repeatedly on each matching path."
27857 #: ../fish/guestfish-commands.pod:79
27858 msgid "See L</WILDCARDS AND GLOBBING>."
27862 #: ../fish/guestfish-commands.pod:81
27867 #: ../fish/guestfish-commands.pod:83
27870 " hexedit <filename|device>\n"
27871 " hexedit <filename|device> <max>\n"
27872 " hexedit <filename|device> <start> <max>\n"
27877 #: ../fish/guestfish-commands.pod:87
27879 "Use hexedit (a hex editor) to edit all or part of a binary file or block "
27884 #: ../fish/guestfish-commands.pod:90
27886 "This command works by downloading potentially the whole file or device, "
27887 "editing it locally, then uploading it. If the file or device is large, you "
27888 "have to specify which part you wish to edit by using C<max> and/or C<start> "
27889 "C<max> parameters. C<start> and C<max> are specified in bytes, with the "
27890 "usual modifiers allowed such as C<1M> (1 megabyte)."
27894 #: ../fish/guestfish-commands.pod:97
27895 msgid "For example to edit the first few sectors of a disk you might do:"
27899 #: ../fish/guestfish-commands.pod:100
27902 " hexedit /dev/sda 1M\n"
27907 #: ../fish/guestfish-commands.pod:102
27909 "which would allow you to edit anywhere within the first megabyte of the disk."
27913 #: ../fish/guestfish-commands.pod:105
27914 msgid "To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:"
27918 #: ../fish/guestfish-commands.pod:107
27921 " hexedit /dev/sda1 0x400 0x400\n"
27926 #: ../fish/guestfish-commands.pod:109
27927 msgid "(assuming the superblock is in the standard location)."
27931 #: ../fish/guestfish-commands.pod:111
27933 "This command requires the external L<hexedit(1)> program. You can specify "
27934 "another program to use by setting the C<HEXEDITOR> environment variable."
27938 #: ../fish/guestfish-commands.pod:115
27939 msgid "See also L</hexdump>."
27943 #: ../fish/guestfish-commands.pod:117
27948 #: ../fish/guestfish-commands.pod:119
27956 #: ../fish/guestfish-commands.pod:121
27958 "Change the local directory, ie. the current directory of guestfish itself."
27962 #: ../fish/guestfish-commands.pod:124
27963 msgid "Note that C<!cd> won't do what you might expect."
27967 #: ../fish/guestfish-commands.pod:126
27972 #: ../fish/guestfish-commands.pod:128
27977 #: ../fish/guestfish-commands.pod:130
27985 #: ../fish/guestfish-commands.pod:132
27986 msgid "Opens the manual page for guestfish."
27990 #: ../fish/guestfish-commands.pod:134
27995 #: ../fish/guestfish-commands.pod:136
28000 #: ../fish/guestfish-commands.pod:138
28008 #: ../fish/guestfish-commands.pod:140
28016 #: ../fish/guestfish-commands.pod:142
28017 msgid "This is used to view a file."
28021 #: ../fish/guestfish-commands.pod:144
28023 "The default viewer is C<$PAGER>. However if you use the alternate command "
28024 "C<less> you will get the C<less> command specifically."
28028 #: ../fish/guestfish-commands.pod:147
28033 #: ../fish/guestfish-commands.pod:149
28041 #: ../fish/guestfish-commands.pod:151
28043 "Close and reopen the libguestfs handle. It is not necessary to use this "
28044 "normally, because the handle is closed properly when guestfish exits. "
28045 "However this is occasionally useful for testing."
28049 #: ../fish/guestfish-commands.pod:155
28054 #: ../fish/guestfish-commands.pod:157
28057 " sparse filename size\n"
28062 #: ../fish/guestfish-commands.pod:159
28064 "This creates an empty sparse file of the given size, and then adds so it can "
28065 "be further examined."
28069 #: ../fish/guestfish-commands.pod:162
28071 "In all respects it works the same as the L</alloc> command, except that the "
28072 "image file is allocated sparsely, which means that disk blocks are not "
28073 "assigned to the file until they are needed. Sparse disk files only use "
28074 "space when written to, but they are slower and there is a danger you could "
28075 "run out of real disk space during a write operation."
28079 #: ../fish/guestfish-commands.pod:172
28084 #: ../fish/guestfish-commands.pod:174
28092 #: ../fish/guestfish-commands.pod:176
28094 "This command returns a list of the optional groups known to the daemon, and "
28095 "indicates which ones are supported by this build of the libguestfs appliance."
28099 #: ../fish/guestfish-commands.pod:180
28100 msgid "See also L<guestfs(3)/AVAILABILITY>."
28104 #: ../fish/guestfish-commands.pod:182
28109 #: ../fish/guestfish-commands.pod:184
28112 " time command args...\n"
28117 #: ../fish/guestfish-commands.pod:186
28119 "Run the command as usual, but print the elapsed time afterwards. This can "
28120 "be useful for benchmarking operations."
28124 #: ../test-tool/libguestfs-test-tool.pod:5
28125 msgid "libguestfs-test-tool - End user tests for libguestfs"
28129 #: ../test-tool/libguestfs-test-tool.pod:9
28132 " libguestfs-test-tool [--options]\n"
28137 #: ../test-tool/libguestfs-test-tool.pod:13
28139 "libguestfs-test-tool is a test program shipped with libguestfs to end users "
28140 "and developers, to allow them to check basic libguestfs functionality is "
28141 "working. This is needed because libguestfs occasionally breaks for reasons "
28142 "beyond our control: usually because of changes in the underlying qemu or "
28143 "kernel packages, or the host environment."
28147 #: ../test-tool/libguestfs-test-tool.pod:20
28148 msgid "If you suspect a problem in libguestfs, then just run:"
28152 #: ../test-tool/libguestfs-test-tool.pod:22
28155 " libguestfs-test-tool\n"
28160 #: ../test-tool/libguestfs-test-tool.pod:24
28161 msgid "It will print lots of diagnostic messages."
28165 #: ../test-tool/libguestfs-test-tool.pod:26
28166 msgid "If it runs to completion successfully, you will see this near the end:"
28170 #: ../test-tool/libguestfs-test-tool.pod:28
28173 " ===== TEST FINISHED OK =====\n"
28178 #: ../test-tool/libguestfs-test-tool.pod:30
28179 msgid "and the test tool will exit with code 0."
28183 #: ../test-tool/libguestfs-test-tool.pod:32
28185 "If it fails (and/or exits with non-zero error code), please paste the "
28186 "B<complete, unedited> output of the test tool into a bug report. More "
28187 "information about reporting bugs can be found on the L<http://libguestfs.org/"
28192 #: ../test-tool/libguestfs-test-tool.pod:41
28197 #: ../test-tool/libguestfs-test-tool.pod:43
28198 msgid "Display short usage information and exit."
28202 #: ../test-tool/libguestfs-test-tool.pod:45
28203 msgid "I<--qemu qemu_binary>"
28207 #: ../test-tool/libguestfs-test-tool.pod:47
28209 "If you have downloaded another qemu binary, point this option at the full "
28210 "path of the binary to try it."
28214 #: ../test-tool/libguestfs-test-tool.pod:50
28215 msgid "I<--qemudir qemu_source_dir>"
28219 #: ../test-tool/libguestfs-test-tool.pod:52
28221 "If you have compiled qemu from source, point this option at the source "
28222 "directory to try it."
28226 #: ../test-tool/libguestfs-test-tool.pod:55
28227 msgid "I<--timeout N>"
28231 #: ../test-tool/libguestfs-test-tool.pod:57
28233 "Set the launch timeout to C<N> seconds. The default is 120 seconds which "
28234 "does not usually need to be adjusted unless your machine is very slow."
28238 #: ../test-tool/libguestfs-test-tool.pod:63
28239 msgid "TRYING OUT A DIFFERENT VERSION OF QEMU"
28243 #: ../test-tool/libguestfs-test-tool.pod:65
28245 "If you have compiled another version of qemu from source and would like to "
28246 "try that, then you can use the I<--qemudir> option to point to the qemu "
28247 "source directory."
28251 #: ../test-tool/libguestfs-test-tool.pod:69
28253 "If you have downloaded a qemu binary from somewhere, use the I<--qemu> "
28254 "option to point to the binary."
28258 #: ../test-tool/libguestfs-test-tool.pod:72
28260 "When using an alternate qemu with libguestfs, usually you would need to "
28261 "write a qemu wrapper script (see section I<QEMU WRAPPERS> in L<guestfs(3)"
28262 ">). libguestfs-test-tool writes a temporary qemu wrapper script when you "
28263 "use either of the I<--qemudir> or I<--qemu> options."
28267 #: ../test-tool/libguestfs-test-tool.pod:79
28269 "libguestfs-test-tool returns I<0> if the tests completed without error, or "
28270 "I<1> if there was an error."
28274 #: ../test-tool/libguestfs-test-tool.pod:84
28276 "For the full list of environment variables which may affect libguestfs, "
28277 "please see the L<guestfs(3)> manual page."
28281 #: ../test-tool/libguestfs-test-tool.pod:89
28282 msgid "L<guestfs(3)>, L<http://libguestfs.org/>, L<http://qemu.org/>."
28286 #: ../fuse/guestmount.pod:5
28288 "guestmount - Mount a guest filesystem on the host using FUSE and libguestfs"
28292 #: ../fuse/guestmount.pod:9
28295 " guestmount [--options] -a disk.img -m device [--ro] mountpoint\n"
28300 #: ../fuse/guestmount.pod:11
28303 " guestmount [--options] -a disk.img -i [--ro] mountpoint\n"
28308 #: ../fuse/guestmount.pod:13
28311 " guestmount [--options] -d Guest -i [--ro] mountpoint\n"
28316 #: ../fuse/guestmount.pod:17
28318 "You must I<not> use C<guestmount> in read-write mode on live virtual "
28319 "machines. If you do this, you risk disk corruption in the VM."
28323 #: ../fuse/guestmount.pod:22
28325 "The guestmount program can be used to mount virtual machine filesystems and "
28326 "other disk images on the host. It uses libguestfs for access to the guest "
28327 "filesystem, and FUSE (the \"filesystem in userspace\") to make it appear as "
28328 "a mountable device."
28332 #: ../fuse/guestmount.pod:27
28334 "Along with other options, you have to give at least one device (I<-a> "
28335 "option) or libvirt domain (I<-d> option), and at least one mountpoint (I<-m> "
28336 "option) or use the I<-i> inspection option. How this works is better "
28337 "explained in the L<guestfish(1)> manual page, or by looking at the examples "
28342 #: ../fuse/guestmount.pod:33
28344 "FUSE lets you mount filesystems as non-root. The mountpoint must be owned "
28345 "by you, and the filesystem will not be visible to any other users unless you "
28346 "make certain global configuration changes to C</etc/fuse.conf>. To unmount "
28347 "the filesystem, use the C<fusermount -u> command."
28351 #: ../fuse/guestmount.pod:41
28353 "For a typical Windows guest which has its main filesystem on the first "
28358 #: ../fuse/guestmount.pod:44
28361 " guestmount -a windows.img -m /dev/sda1 --ro /mnt\n"
28366 #: ../fuse/guestmount.pod:46
28368 "For a typical Linux guest which has a /boot filesystem on the first "
28369 "partition, and the root filesystem on a logical volume:"
28373 #: ../fuse/guestmount.pod:49
28376 " guestmount -a linux.img -m /dev/VG/LV -m /dev/sda1:/boot --ro /mnt\n"
28381 #: ../fuse/guestmount.pod:51
28382 msgid "To get libguestfs to detect guest mountpoints for you:"
28386 #: ../fuse/guestmount.pod:53
28389 " guestmount -a guest.img -i --ro /mnt\n"
28394 #: ../fuse/guestmount.pod:55
28395 msgid "For a libvirt guest called \"Guest\" you could do:"
28399 #: ../fuse/guestmount.pod:57
28402 " guestmount -d Guest -i --ro /mnt\n"
28407 #: ../fuse/guestmount.pod:59
28409 "If you don't know what filesystems are contained in a guest or disk image, "
28410 "use L<virt-filesystems(1)> first:"
28414 #: ../fuse/guestmount.pod:62
28417 " virt-filesystems MyGuest\n"
28422 #: ../fuse/guestmount.pod:64
28424 "If you want to trace the libguestfs calls but without excessive debugging "
28425 "information, we recommend:"
28429 #: ../fuse/guestmount.pod:67
28432 " guestmount [...] --trace /mnt\n"
28437 #: ../fuse/guestmount.pod:69
28438 msgid "If you want to debug the program, we recommend:"
28442 #: ../fuse/guestmount.pod:71
28445 " guestmount [...] --trace --verbose /mnt\n"
28450 #: ../fuse/guestmount.pod:77
28451 msgid "B<-a image> | B<--add image>"
28455 #: ../fuse/guestmount.pod:79
28456 msgid "Add a block device or virtual machine image."
28460 #: ../fuse/guestmount.pod:84
28461 msgid "B<-c URI> | B<--connect URI>"
28465 #: ../fuse/guestmount.pod:90
28466 msgid "B<-d libvirt-domain> | B<--domain libvirt-domain>"
28470 #: ../fuse/guestmount.pod:96
28471 msgid "B<--dir-cache-timeout N>"
28475 #: ../fuse/guestmount.pod:98
28477 "Set the readdir cache timeout to I<N> seconds, the default being 60 "
28478 "seconds. The readdir cache [actually, there are several semi-independent "
28479 "caches] is populated after a readdir(2) call with the stat and extended "
28480 "attributes of the files in the directory, in anticipation that they will be "
28481 "requested soon after."
28485 #: ../fuse/guestmount.pod:104
28487 "There is also a different attribute cache implemented by FUSE (see the FUSE "
28488 "option I<-o attr_timeout>), but the FUSE cache does not anticipate future "
28489 "requests, only cache existing ones."
28493 #: ../fuse/guestmount.pod:115
28494 msgid "B<--format=raw|qcow2|..> | B<--format>"
28498 #: ../fuse/guestmount.pod:122
28500 "If you have untrusted raw-format guest disk images, you should use this "
28501 "option to specify the disk format. This avoids a possible security problem "
28502 "with malicious guests (CVE-2010-3851). See also L<guestfs(3)/"
28503 "guestfs_add_drive_opts>."
28507 #: ../fuse/guestmount.pod:127
28508 msgid "B<--fuse-help>"
28512 #: ../fuse/guestmount.pod:129
28513 msgid "Display help on special FUSE options (see I<-o> below)."
28517 #: ../fuse/guestmount.pod:133
28518 msgid "Display brief help and exit."
28522 #: ../fuse/guestmount.pod:135
28523 msgid "B<-i> | B<--inspector>"
28527 #: ../fuse/guestmount.pod:155
28529 "Mount the named partition or logical volume on the given mountpoint B<in the "
28530 "guest> (this has nothing to do with mountpoints in the host)."
28534 #: ../fuse/guestmount.pod:158
28536 "If the mountpoint is omitted, it defaults to C</>. You have to mount "
28537 "something on C</>."
28541 #: ../fuse/guestmount.pod:171
28542 msgid "B<-n> | B<--no-sync>"
28546 #: ../fuse/guestmount.pod:173
28548 "By default, we attempt to sync the guest disk when the FUSE mountpoint is "
28549 "unmounted. If you specify this option, then we don't attempt to sync the "
28550 "disk. See the discussion of autosync in the L<guestfs(3)> manpage."
28554 #: ../fuse/guestmount.pod:178
28555 msgid "B<-o option> | B<--option option>"
28559 #: ../fuse/guestmount.pod:180
28560 msgid "Pass extra options to FUSE."
28564 #: ../fuse/guestmount.pod:182
28566 "To get a list of all the extra options supported by FUSE, use the command "
28567 "below. Note that only the FUSE I<-o> options can be passed, and only some "
28568 "of them are a good idea."
28572 #: ../fuse/guestmount.pod:186
28575 " guestmount --fuse-help\n"
28580 #: ../fuse/guestmount.pod:188
28581 msgid "Some potentially useful FUSE options:"
28585 #: ../fuse/guestmount.pod:192
28586 msgid "B<-o allow_other>"
28590 #: ../fuse/guestmount.pod:194
28591 msgid "Allow other users to see the filesystem."
28595 #: ../fuse/guestmount.pod:196
28596 msgid "B<-o attr_timeout=N>"
28600 #: ../fuse/guestmount.pod:198
28601 msgid "Enable attribute caching by FUSE, and set the timeout to I<N> seconds."
28605 #: ../fuse/guestmount.pod:200
28606 msgid "B<-o kernel_cache>"
28610 #: ../fuse/guestmount.pod:202
28612 "Allow the kernel to cache files (reduces the number of reads that have to go "
28613 "through the L<guestfs(3)> API). This is generally a good idea if you can "
28614 "afford the extra memory usage."
28618 #: ../fuse/guestmount.pod:206
28619 msgid "B<-o uid=N> B<-o gid=N>"
28623 #: ../fuse/guestmount.pod:208
28625 "Use these options to map all UIDs and GIDs inside the guest filesystem to "
28626 "the chosen values."
28630 #: ../fuse/guestmount.pod:213
28631 msgid "B<-r> | B<--ro>"
28635 #: ../fuse/guestmount.pod:215
28637 "Add devices and mount everything read-only. Also disallow writes and make "
28638 "the disk appear read-only to FUSE."
28642 #: ../fuse/guestmount.pod:218
28644 "This is highly recommended if you are not going to edit the guest disk. If "
28645 "the guest is running and this option is I<not> supplied, then there is a "
28646 "strong risk of disk corruption in the guest. We try to prevent this from "
28647 "happening, but it is not always possible."
28651 #: ../fuse/guestmount.pod:223
28652 msgid "See also L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
28656 #: ../fuse/guestmount.pod:227
28657 msgid "Enable SELinux support for the guest."
28661 #: ../fuse/guestmount.pod:229
28662 msgid "B<-v> | B<--verbose>"
28666 #: ../fuse/guestmount.pod:231
28667 msgid "Enable verbose messages from underlying libguestfs."
28671 #: ../fuse/guestmount.pod:233
28672 msgid "B<-V> | B<--version>"
28676 #: ../fuse/guestmount.pod:235
28677 msgid "Display the program version and exit."
28681 #: ../fuse/guestmount.pod:237
28682 msgid "B<-w> | B<--rw>"
28686 #: ../fuse/guestmount.pod:242 ../fuse/guestmount.pod:263
28687 msgid "See L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
28691 #: ../fuse/guestmount.pod:244
28692 msgid "B<-x> | B<--trace>"
28696 #: ../fuse/guestmount.pod:246
28697 msgid "Trace libguestfs calls and entry into each FUSE function."
28701 #: ../fuse/guestmount.pod:248
28702 msgid "This also stops the daemon from forking into the background."
28706 #: ../fuse/guestmount.pod:269
28708 "L<guestfish(1)>, L<virt-inspector(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
28709 "L<virt-tar(1)>, L<guestfs(3)>, L<http://libguestfs.org/>, L<http://fuse.sf."
28714 #: ../fuse/guestmount.pod:284
28715 msgid "Copyright (C) 2009-2010 Red Hat Inc. L<http://libguestfs.org/>"
28719 #: ../tools/virt-edit.pl:34
28720 msgid "virt-edit - Edit a file in a virtual machine"
28724 #: ../tools/virt-edit.pl:38
28727 " virt-edit [--options] domname file\n"
28732 #: ../tools/virt-edit.pl:40
28735 " virt-edit [--options] disk.img [disk.img ...] file\n"
28740 #: ../tools/virt-edit.pl:42
28743 " virt-edit [domname|disk.img] file -e 'expr'\n"
28748 #: ../tools/virt-edit.pl:46
28750 "You must I<not> use C<virt-edit> on live virtual machines. If you do this, "
28751 "you risk disk corruption in the VM. C<virt-edit> tries to stop you from "
28752 "doing this, but doesn't catch all cases."
28756 #: ../tools/virt-edit.pl:52
28758 "C<virt-edit> is a command line tool to edit C<file> where C<file> exists in "
28759 "the named virtual machine (or disk image)."
28763 #: ../tools/virt-edit.pl:55
28764 msgid "If you want to just view a file, use L<virt-cat(1)>."
28768 #: ../tools/virt-edit.pl:57
28770 "For more complex cases you should look at the L<guestfish(1)> tool (see L</"
28771 "USING GUESTFISH> below)."
28775 #: ../tools/virt-edit.pl:60
28777 "C<virt-edit> cannot be used to create a new file, nor to edit multiple "
28778 "files. L<guestfish(1)> can do that and much more."
28782 #: ../tools/virt-edit.pl:65
28783 msgid "Edit the named files interactively:"
28787 #: ../tools/virt-edit.pl:67
28790 " virt-edit mydomain /boot/grub/grub.conf\n"
28795 #: ../tools/virt-edit.pl:69
28798 " virt-edit mydomain /etc/passwd\n"
28803 #: ../tools/virt-edit.pl:71
28804 msgid "For Windows guests, some Windows paths are understood:"
28808 #: ../tools/virt-edit.pl:73
28811 " virt-edit mywindomain 'c:\\autoexec.bat'\n"
28816 #: ../tools/virt-edit.pl:75
28818 "You can also edit files non-interactively (see L</NON-INTERACTIVE EDITING> "
28819 "below). To change the init default level to 5:"
28823 #: ../tools/virt-edit.pl:79
28826 " virt-edit mydomain /etc/inittab -e 's/^id:.*/id:5:initdefault:/'\n"
28831 #: ../tools/virt-edit.pl:91 ../tools/virt-win-reg.pl:106
28832 #: ../tools/virt-list-filesystems.pl:63 ../tools/virt-tar.pl:113
28833 #: ../tools/virt-make-fs.pl:163 ../tools/virt-list-partitions.pl:64
28834 msgid "Display brief help."
28838 #: ../tools/virt-edit.pl:99 ../tools/virt-win-reg.pl:114
28839 #: ../tools/virt-list-filesystems.pl:71 ../tools/virt-tar.pl:121
28840 #: ../tools/virt-make-fs.pl:171 ../tools/virt-list-partitions.pl:72
28841 msgid "Display version number and exit."
28845 #: ../tools/virt-edit.pl:105
28846 msgid "B<--backup extension> | B<-b extension>"
28850 #: ../tools/virt-edit.pl:107
28852 "Create a backup of the original file I<in the guest disk image>. The backup "
28853 "has the original filename with C<extension> added."
28857 #: ../tools/virt-edit.pl:110
28859 "Usually the first character of C<extension> would be a dot C<.> so you would "
28864 #: ../tools/virt-edit.pl:113
28867 " virt-edit -b .orig [etc]\n"
28872 #: ../tools/virt-edit.pl:115
28873 msgid "By default, no backup file is made."
28877 #: ../tools/virt-edit.pl:121 ../tools/virt-win-reg.pl:128
28878 #: ../tools/virt-list-filesystems.pl:77 ../tools/virt-tar.pl:127
28879 #: ../tools/virt-list-partitions.pl:78
28880 msgid "B<--connect URI> | B<-c URI>"
28884 #: ../tools/virt-edit.pl:123 ../tools/virt-win-reg.pl:130
28885 #: ../tools/virt-list-filesystems.pl:79 ../tools/virt-tar.pl:129
28886 #: ../tools/virt-list-partitions.pl:80
28888 "If using libvirt, connect to the given I<URI>. If omitted, then we connect "
28889 "to the default libvirt hypervisor."
28893 #: ../tools/virt-edit.pl:126 ../tools/virt-win-reg.pl:133
28894 #: ../tools/virt-list-filesystems.pl:82 ../tools/virt-tar.pl:132
28895 #: ../tools/virt-list-partitions.pl:83
28897 "If you specify guest block devices directly, then libvirt is not used at all."
28901 #: ../tools/virt-edit.pl:133 ../tools/virt-win-reg.pl:140
28902 #: ../tools/virt-list-filesystems.pl:89 ../tools/virt-tar.pl:139
28903 #: ../tools/virt-list-partitions.pl:90
28904 msgid "B<--format> raw"
28908 #: ../tools/virt-edit.pl:135 ../tools/virt-win-reg.pl:142
28909 #: ../tools/virt-list-filesystems.pl:91 ../tools/virt-tar.pl:141
28910 #: ../tools/virt-list-partitions.pl:92
28912 "Specify the format of disk images given on the command line. If this is "
28913 "omitted then the format is autodetected from the content of the disk image."
28917 #: ../tools/virt-edit.pl:139 ../tools/virt-win-reg.pl:146
28918 #: ../tools/virt-list-filesystems.pl:95 ../tools/virt-tar.pl:145
28919 #: ../tools/virt-list-partitions.pl:96
28921 "If disk images are requested from libvirt, then this program asks libvirt "
28922 "for this information. In this case, the value of the format parameter is "
28927 #: ../tools/virt-edit.pl:143 ../tools/virt-win-reg.pl:150
28928 #: ../tools/virt-list-filesystems.pl:99 ../tools/virt-tar.pl:149
28929 #: ../tools/virt-list-partitions.pl:100
28931 "If working with untrusted raw-format guest disk images, you should ensure "
28932 "the format is always specified."
28936 #: ../tools/virt-edit.pl:150
28937 msgid "B<--expr EXPR> | B<-e EXPR>"
28941 #: ../tools/virt-edit.pl:152
28943 "Instead of launching the external editor, non-interactively apply the Perl "
28944 "expression C<EXPR> to each line in the file. See L</NON-INTERACTIVE "
28949 #: ../tools/virt-edit.pl:156
28951 "Be careful to properly quote the expression to prevent it from being altered "
28956 #: ../tools/virt-edit.pl:280
28957 msgid "NON-INTERACTIVE EDITING"
28961 #: ../tools/virt-edit.pl:282
28963 "C<virt-edit> normally calls out to C<$EDITOR> (or vi) so the system "
28964 "administrator can interactively edit the file."
28968 #: ../tools/virt-edit.pl:285
28970 "There are two ways also to use C<virt-edit> from scripts in order to make "
28971 "automated edits to files. (Note that although you I<can> use C<virt-edit> "
28972 "like this, it's less error-prone to write scripts directly using the "
28973 "libguestfs API and Augeas for configuration file editing.)"
28977 #: ../tools/virt-edit.pl:291
28979 "The first method is to temporarily set C<$EDITOR> to any script or program "
28980 "you want to run. The script is invoked as C<$EDITOR tmpfile> and it should "
28981 "update C<tmpfile> in place however it likes."
28985 #: ../tools/virt-edit.pl:295
28987 "The second method is to use the C<-e> parameter of C<virt-edit> to run a "
28988 "short Perl snippet in the style of L<sed(1)>. For example to replace all "
28989 "instances of C<foo> with C<bar> in a file:"
28993 #: ../tools/virt-edit.pl:299
28996 " virt-edit domname filename -e 's/foo/bar/'\n"
29001 #: ../tools/virt-edit.pl:301
29003 "The full power of Perl regular expressions can be used (see L<perlre(1)>). "
29004 "For example to delete root's password you could do:"
29008 #: ../tools/virt-edit.pl:304
29011 " virt-edit domname /etc/passwd -e 's/^root:.*?:/root::/'\n"
29016 #: ../tools/virt-edit.pl:306
29018 "What really happens is that the snippet is evaluated as a Perl expression "
29019 "for each line of the file. The line, including the final C<\\n>, is passed "
29020 "in C<$_> and the expression should update C<$_> or leave it unchanged."
29024 #: ../tools/virt-edit.pl:311
29026 "To delete a line, set C<$_> to the empty string. For example, to delete the "
29027 "C<apache> user account from the password file you can do:"
29031 #: ../tools/virt-edit.pl:314
29034 " virt-edit mydomain /etc/passwd -e '$_ = \"\" if /^apache:/'\n"
29039 #: ../tools/virt-edit.pl:316
29041 "To insert a line, prepend or append it to C<$_>. However appending lines to "
29042 "the end of the file is rather difficult this way since there is no concept "
29043 "of \"last line of the file\" - your expression just doesn't get called "
29044 "again. You might want to use the first method (setting C<$EDITOR>) if you "
29049 #: ../tools/virt-edit.pl:322
29051 "The variable C<$lineno> contains the current line number. As is "
29052 "traditional, the first line in the file is number C<1>."
29056 #: ../tools/virt-edit.pl:325
29058 "The return value from the expression is ignored, but the expression may call "
29059 "C<die> in order to abort the whole program, leaving the original file "
29064 #: ../tools/virt-edit.pl:329
29066 "Remember when matching the end of a line that C<$_> may contain the final C<"
29067 "\\n>, or (for DOS files) C<\\r\\n>, or if the file does not end with a "
29068 "newline then neither of these. Thus to match or substitute some text at the "
29069 "end of a line, use this regular expression:"
29073 #: ../tools/virt-edit.pl:334
29076 " /some text(\\r?\\n)?$/\n"
29081 #: ../tools/virt-edit.pl:336
29083 "Alternately, use the perl C<chomp> function, being careful not to chomp C<"
29084 "$_> itself (since that would remove all newlines from the file):"
29088 #: ../tools/virt-edit.pl:340
29091 " my $m = $_; chomp $m; $m =~ /some text$/\n"
29096 #: ../tools/virt-edit.pl:344
29098 "C<virt-edit> has a limited ability to understand Windows drive letters and "
29099 "paths (eg. C<E:\\foo\\bar.txt>)."
29103 #: ../tools/virt-edit.pl:347
29104 msgid "If and only if the guest is running Windows then:"
29108 #: ../tools/virt-edit.pl:353
29110 "Drive letter prefixes like C<C:> are resolved against the Windows Registry "
29111 "to the correct filesystem."
29115 #: ../tools/virt-edit.pl:358
29117 "Any backslash (C<\\>) characters in the path are replaced with forward "
29118 "slashes so that libguestfs can process it."
29122 #: ../tools/virt-edit.pl:363
29124 "The path is resolved case insensitively to locate the file that should be "
29129 #: ../tools/virt-edit.pl:368
29130 msgid "There are some known shortcomings:"
29134 #: ../tools/virt-edit.pl:374
29135 msgid "Some NTFS symbolic links may not be followed correctly."
29139 #: ../tools/virt-edit.pl:378
29140 msgid "NTFS junction points that cross filesystems are not followed."
29144 #: ../tools/virt-edit.pl:435
29145 msgid "USING GUESTFISH"
29149 #: ../tools/virt-edit.pl:437
29151 "L<guestfish(1)> is a more powerful, lower level tool which you can use when "
29152 "C<virt-edit> doesn't work."
29156 #: ../tools/virt-edit.pl:440
29157 msgid "Using C<virt-edit> is approximately equivalent to doing:"
29161 #: ../tools/virt-edit.pl:442
29164 " guestfish --rw -i -d domname edit /file\n"
29169 #: ../tools/virt-edit.pl:444
29171 "where C<domname> is the name of the libvirt guest, and C</file> is the full "
29172 "path to the file."
29176 #: ../tools/virt-edit.pl:447
29178 "The command above uses libguestfs's guest inspection feature and so does not "
29179 "work on guests that libguestfs cannot inspect, or on things like arbitrary "
29180 "disk images that don't contain guests. To edit a file on a disk image "
29185 #: ../tools/virt-edit.pl:452
29188 " guestfish --rw -a disk.img -m /dev/sda1 edit /file\n"
29193 #: ../tools/virt-edit.pl:454
29195 "where C<disk.img> is the disk image, C</dev/sda1> is the filesystem within "
29196 "the disk image to edit, and C</file> is the full path to the file."
29200 #: ../tools/virt-edit.pl:458
29202 "C<virt-edit> cannot create new files. Use the guestfish commands C<touch>, "
29203 "C<write> or C<upload> instead:"
29207 #: ../tools/virt-edit.pl:461
29210 " guestfish --rw -i -d domname touch /newfile\n"
29215 #: ../tools/virt-edit.pl:463
29218 " guestfish --rw -i -d domname write /newfile \"new content\"\n"
29223 #: ../tools/virt-edit.pl:465
29226 " guestfish --rw -i -d domname upload localfile /newfile\n"
29231 #: ../tools/virt-edit.pl:467
29233 "C<virt-edit> cannot edit multiple files, but guestfish can do it like this:"
29237 #: ../tools/virt-edit.pl:470
29240 " guestfish --rw -i -d domname edit /file1 : edit /file2\n"
29245 #: ../tools/virt-edit.pl:480
29250 #: ../tools/virt-edit.pl:482
29252 "If set, this string is used as the editor. It may contain arguments, eg. C<"
29257 #: ../tools/virt-edit.pl:485
29258 msgid "If not set, C<vi> is used."
29262 #: ../tools/virt-edit.pl:489 ../tools/virt-win-reg.pl:559
29263 #: ../tools/virt-list-filesystems.pl:182 ../tools/virt-tar.pl:279
29264 #: ../tools/virt-make-fs.pl:532 ../tools/virt-list-partitions.pl:250
29265 msgid "SHELL QUOTING"
29269 #: ../tools/virt-edit.pl:491 ../tools/virt-win-reg.pl:567
29270 #: ../tools/virt-list-filesystems.pl:184 ../tools/virt-tar.pl:281
29271 #: ../tools/virt-make-fs.pl:534 ../tools/virt-list-partitions.pl:252
29273 "Libvirt guest names can contain arbitrary characters, some of which have "
29274 "meaning to the shell such as C<#> and space. You may need to quote or "
29275 "escape these characters on the command line. See the shell manual page L<sh"
29276 "(1)> for details."
29280 #: ../tools/virt-edit.pl:498
29282 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, L<virt-"
29283 "tar-in(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, "
29284 "L<http://libguestfs.org/>, L<perl(1)>, L<perlre(1)>."
29288 #: ../tools/virt-edit.pl:510 ../tools/virt-win-reg.pl:598
29289 #: ../tools/virt-list-filesystems.pl:202 ../tools/virt-tar.pl:301
29290 #: ../tools/virt-make-fs.pl:564 ../tools/virt-list-partitions.pl:269
29295 #: ../tools/virt-edit.pl:512 ../tools/virt-win-reg.pl:600
29296 #: ../tools/virt-list-filesystems.pl:204 ../tools/virt-tar.pl:303
29297 #: ../tools/virt-make-fs.pl:566 ../tools/virt-list-partitions.pl:271
29298 msgid "Richard W.M. Jones L<http://people.redhat.com/~rjones/>"
29302 #: ../tools/virt-edit.pl:516
29303 msgid "Copyright (C) 2009-2011 Red Hat Inc."
29307 #: ../tools/virt-win-reg.pl:37
29309 "virt-win-reg - Export and merge Windows Registry entries from a Windows guest"
29313 #: ../tools/virt-win-reg.pl:41
29316 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey'\n"
29321 #: ../tools/virt-win-reg.pl:43
29324 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' name\n"
29329 #: ../tools/virt-win-reg.pl:45
29332 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' @\n"
29337 #: ../tools/virt-win-reg.pl:47
29340 " virt-win-reg --merge domname [input.reg ...]\n"
29345 #: ../tools/virt-win-reg.pl:49
29348 " virt-win-reg [--options] disk.img ... # instead of domname\n"
29353 #: ../tools/virt-win-reg.pl:53
29355 "You must I<not> use C<virt-win-reg> with the C<--merge> option on live "
29356 "virtual machines. If you do this, you I<will> get irreversible disk "
29357 "corruption in the VM. C<virt-win-reg> tries to stop you from doing this, "
29358 "but doesn't catch all cases."
29362 #: ../tools/virt-win-reg.pl:58
29364 "Modifying the Windows Registry is an inherently risky operation. The format "
29365 "is deliberately obscure and undocumented, and Registry changes can leave the "
29366 "system unbootable. Therefore when using the C<--merge> option, make sure "
29367 "you have a reliable backup first."
29371 #: ../tools/virt-win-reg.pl:65
29373 "This program can export and merge Windows Registry entries from a Windows "
29378 #: ../tools/virt-win-reg.pl:68
29380 "The first parameter is the libvirt guest name or the raw disk image of a "
29385 #: ../tools/virt-win-reg.pl:71
29387 "If C<--merge> is I<not> specified, then the chosen registry key is displayed/"
29388 "exported (recursively). For example:"
29392 #: ../tools/virt-win-reg.pl:74
29395 " $ virt-win-reg Windows7 'HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft'\n"
29400 #: ../tools/virt-win-reg.pl:76
29402 "You can also display single values from within registry keys, for example:"
29406 #: ../tools/virt-win-reg.pl:79
29409 " $ cvkey='HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion'\n"
29410 " $ virt-win-reg Windows7 $cvkey ProductName\n"
29411 " Windows 7 Enterprise\n"
29416 #: ../tools/virt-win-reg.pl:83
29418 "With C<--merge>, you can merge a textual regedit file into the Windows "
29423 #: ../tools/virt-win-reg.pl:86
29426 " $ virt-win-reg --merge Windows7 changes.reg\n"
29431 #: ../tools/virt-win-reg.pl:88 ../tools/virt-tar.pl:45
29436 #: ../tools/virt-win-reg.pl:90
29438 "This program is only meant for simple access to the registry. If you want "
29439 "to do complicated things with the registry, we suggest you download the "
29440 "Registry hive files from the guest using L<libguestfs(3)> or L<guestfish(1)> "
29441 "and access them locally, eg. using L<hivex(3)>, L<hivexsh(1)> or "
29442 "L<hivexregedit(1)>."
29446 #: ../tools/virt-win-reg.pl:120 ../tools/virt-make-fs.pl:177
29451 #: ../tools/virt-win-reg.pl:122
29452 msgid "Enable debugging messages."
29456 #: ../tools/virt-win-reg.pl:157
29461 #: ../tools/virt-win-reg.pl:159
29463 "In merge mode, this merges a textual regedit file into the Windows Registry "
29464 "of the virtual machine. If this flag is I<not> given then virt-win-reg "
29465 "displays or exports Registry entries instead."
29469 #: ../tools/virt-win-reg.pl:163
29471 "Note that C<--merge> is I<unsafe> to use on live virtual machines, and will "
29472 "result in disk corruption. However exporting (without this flag) is always "
29477 #: ../tools/virt-win-reg.pl:171
29478 msgid "B<--encoding> UTF-16LE|ASCII"
29482 #: ../tools/virt-win-reg.pl:173
29484 "When merging (only), you may need to specify the encoding for strings to be "
29485 "used in the hive file. This is explained in detail in L<Win::Hivex::Regedit"
29486 "(3)/ENCODING STRINGS>."
29490 #: ../tools/virt-win-reg.pl:177
29492 "The default is to use UTF-16LE, which should work with recent versions of "
29497 #: ../tools/virt-win-reg.pl:402
29498 msgid "SUPPORTED SYSTEMS"
29502 #: ../tools/virt-win-reg.pl:404
29504 "The program currently supports Windows NT-derived guests starting with "
29505 "Windows XP through to at least Windows 7."
29509 #: ../tools/virt-win-reg.pl:407
29511 "Registry support is done for C<HKEY_LOCAL_MACHINE\\SAM>, C<HKEY_LOCAL_MACHINE"
29512 "\\SECURITY>, C<HKEY_LOCAL_MACHINE\\SOFTWARE>, C<HKEY_LOCAL_MACHINE\\SYSTEM> "
29513 "and C<HKEY_USERS\\.DEFAULT>."
29517 #: ../tools/virt-win-reg.pl:411
29519 "You can use C<HKLM> as a shorthand for C<HKEY_LOCAL_MACHINE>, and C<HKU> for "
29524 #: ../tools/virt-win-reg.pl:414
29526 "C<HKEY_USERS\\$SID> and C<HKEY_CURRENT_USER> are B<not> supported at this "
29531 #: ../tools/virt-win-reg.pl:417
29536 #: ../tools/virt-win-reg.pl:419
29538 "C<virt-win-reg> expects that regedit files have already been reencoded in "
29539 "the local encoding. Usually on Linux hosts, this means UTF-8 with Unix-"
29540 "style line endings. Since Windows regedit files are often in UTF-16LE with "
29541 "Windows-style line endings, you may need to reencode the whole file before "
29542 "or after processing."
29546 #: ../tools/virt-win-reg.pl:425
29548 "To reencode a file from Windows format to Linux (before processing it with "
29549 "the C<--merge> option), you would do something like this:"
29553 #: ../tools/virt-win-reg.pl:428
29556 " iconv -f utf-16le -t utf-8 < win.reg | dos2unix > linux.reg\n"
29561 #: ../tools/virt-win-reg.pl:430
29563 "To go in the opposite direction, after exporting and before sending the file "
29564 "to a Windows user, do something like this:"
29568 #: ../tools/virt-win-reg.pl:433
29571 " unix2dos linux.reg | iconv -f utf-8 -t utf-16le > win.reg\n"
29576 #: ../tools/virt-win-reg.pl:435
29577 msgid "For more information about encoding, see L<Win::Hivex::Regedit(3)>."
29581 #: ../tools/virt-win-reg.pl:437
29583 "If you are unsure about the current encoding, use the L<file(1)> command. "
29584 "Recent versions of Windows regedit.exe produce a UTF-16LE file with Windows-"
29585 "style (CRLF) line endings, like this:"
29589 #: ../tools/virt-win-reg.pl:441
29592 " $ file software.reg\n"
29593 " software.reg: Little-endian UTF-16 Unicode text, with very long lines,\n"
29594 " with CRLF line terminators\n"
29599 #: ../tools/virt-win-reg.pl:445
29600 msgid "This file would need conversion before you could C<--merge> it."
29604 #: ../tools/virt-win-reg.pl:447
29605 msgid "CurrentControlSet etc."
29609 #: ../tools/virt-win-reg.pl:449
29611 "Registry keys like C<CurrentControlSet> don't really exist in the Windows "
29612 "Registry at the level of the hive file, and therefore you cannot modify "
29617 #: ../tools/virt-win-reg.pl:453
29619 "C<CurrentControlSet> is usually an alias for C<ControlSet001>. In some "
29620 "circumstances it might refer to another control set. The way to find out is "
29621 "to look at the C<HKLM\\SYSTEM\\Select> key:"
29625 #: ../tools/virt-win-reg.pl:457
29628 " # virt-win-reg WindowsGuest 'HKLM\\SYSTEM\\Select'\n"
29629 " [HKEY_LOCAL_MACHINE\\SYSTEM\\Select]\n"
29630 " \"Current\"=dword:00000001\n"
29631 " \"Default\"=dword:00000001\n"
29632 " \"Failed\"=dword:00000000\n"
29633 " \"LastKnownGood\"=dword:00000002\n"
29638 #: ../tools/virt-win-reg.pl:464
29639 msgid "\"Current\" is the one which Windows will choose when it boots."
29643 #: ../tools/virt-win-reg.pl:466
29645 "Similarly, other C<Current...> keys in the path may need to be replaced."
29649 #: ../tools/virt-win-reg.pl:469
29650 msgid "WINDOWS TIPS"
29654 #: ../tools/virt-win-reg.pl:471
29656 "Note that some of these tips modify the guest disk image. The guest I<must> "
29657 "be shut off, else you will get disk corruption."
29661 #: ../tools/virt-win-reg.pl:474
29662 msgid "RUNNING A BATCH SCRIPT WHEN A USER LOGS IN"
29666 #: ../tools/virt-win-reg.pl:476
29668 "Prepare a DOS batch script, VBScript or executable. Upload this using "
29669 "L<guestfish(1)>. For this example the script is called C<test.bat> and it "
29670 "is uploaded into C<C:\\>:"
29674 #: ../tools/virt-win-reg.pl:480
29677 " guestfish -i -d WindowsGuest upload test.bat /test.bat\n"
29682 #: ../tools/virt-win-reg.pl:482
29683 msgid "Prepare a regedit file containing the registry change:"
29687 #: ../tools/virt-win-reg.pl:484
29690 " cat > test.reg <<'EOF'\n"
29691 " [HKLM\\Software\\Microsoft\\Windows\\CurrentVersion\\RunOnce]\n"
29692 " \"Test\"=\"c:\\\\test.bat\"\n"
29698 #: ../tools/virt-win-reg.pl:489
29700 "In this example we use the key C<RunOnce> which means that the script will "
29701 "run precisely once when the first user logs in. If you want it to run every "
29702 "time a user logs in, replace C<RunOnce> with C<Run>."
29706 #: ../tools/virt-win-reg.pl:493
29707 msgid "Now update the registry:"
29711 #: ../tools/virt-win-reg.pl:495
29714 " virt-win-reg --merge WindowsGuest test.reg\n"
29719 #: ../tools/virt-win-reg.pl:497
29720 msgid "INSTALLING A SERVICE"
29724 #: ../tools/virt-win-reg.pl:499
29726 "This section assumes you are familiar with Windows services, and you either "
29727 "have a program which handles the Windows Service Control Protocol directly "
29728 "or you want to run any program using a service wrapper like SrvAny or the "
29733 #: ../tools/virt-win-reg.pl:504
29735 "First upload the program and optionally the service wrapper. In this case "
29736 "the test program is called C<test.exe> and we are using the RHSrvAny wrapper:"
29740 #: ../tools/virt-win-reg.pl:508
29743 " guestfish -i -d WindowsGuest <<EOF\n"
29744 " upload rhsrvany.exe /rhsrvany.exe\n"
29745 " upload test.exe /test.exe\n"
29751 #: ../tools/virt-win-reg.pl:513
29753 "Prepare a regedit file containing the registry changes. In this example, "
29754 "the first registry change is needed for the service itself or the service "
29755 "wrapper (if used). The second registry change is only needed because I am "
29756 "using the RHSrvAny service wrapper."
29760 #: ../tools/virt-win-reg.pl:518
29763 " cat > service.reg <<'EOF'\n"
29764 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny]\n"
29765 " \"Type\"=dword:00000010\n"
29766 " \"Start\"=dword:00000002\n"
29767 " \"ErrorControl\"=dword:00000001\n"
29768 " \"ImagePath\"=\"c:\\\\rhsrvany.exe\"\n"
29769 " \"DisplayName\"=\"RHSrvAny\"\n"
29770 " \"ObjectName\"=\"NetworkService\"\n"
29775 #: ../tools/virt-win-reg.pl:527
29778 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny\\Parameters]\n"
29779 " \"CommandLine\"=\"c:\\\\test.exe\"\n"
29780 " \"PWD\"=\"c:\\\\Temp\"\n"
29786 #: ../tools/virt-win-reg.pl:538
29788 "For use of C<ControlSet001> see the section above in this manual page. You "
29789 "may need to adjust this according to the control set that is in use by the "
29794 #: ../tools/virt-win-reg.pl:544
29796 "C<\"ObjectName\"> controls the privileges that the service will have. An "
29797 "alternative is C<\"ObjectName\"=\"LocalSystem\"> which would be the most "
29798 "privileged account."
29802 #: ../tools/virt-win-reg.pl:550
29804 "For the meaning of the magic numbers, see this Microsoft KB article: "
29805 "L<http://support.microsoft.com/kb/103000>."
29809 #: ../tools/virt-win-reg.pl:555
29810 msgid "Update the registry:"
29814 #: ../tools/virt-win-reg.pl:557
29817 " virt-win-reg --merge WindowsGuest service.reg\n"
29822 #: ../tools/virt-win-reg.pl:561
29824 "Be careful when passing parameters containing C<\\> (backslash) in the "
29825 "shell. Usually you will have to use 'single quotes' or double backslashes "
29826 "(but not both) to protect them from the shell."
29830 #: ../tools/virt-win-reg.pl:565
29831 msgid "Paths and value names are case-insensitive."
29835 #: ../tools/virt-win-reg.pl:574
29837 "L<hivex(3)>, L<hivexsh(1)>, L<hivexregedit(1)>, L<guestfs(3)>, L<guestfish(1)"
29838 ">, L<virt-cat(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Win::Hivex"
29839 "(3)>, L<Win::Hivex::Regedit(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
29843 #: ../tools/virt-win-reg.pl:589 ../tools/virt-make-fs.pl:555
29845 "When reporting bugs, please enable debugging and capture the I<complete> "
29850 #: ../tools/virt-win-reg.pl:592
29853 " export LIBGUESTFS_DEBUG=1\n"
29854 " virt-win-reg --debug [... rest ...] > /tmp/virt-win-reg.log 2>&1\n"
29859 #: ../tools/virt-win-reg.pl:595
29861 "Attach /tmp/virt-win-reg.log to a new bug report at L<https://bugzilla."
29866 #: ../tools/virt-win-reg.pl:604 ../tools/virt-make-fs.pl:570
29867 msgid "Copyright (C) 2010 Red Hat Inc."
29871 #: ../tools/virt-list-filesystems.pl:32
29873 "virt-list-filesystems - List filesystems in a virtual machine or disk image"
29877 #: ../tools/virt-list-filesystems.pl:36
29880 " virt-list-filesystems [--options] domname\n"
29885 #: ../tools/virt-list-filesystems.pl:38
29888 " virt-list-filesystems [--options] disk.img [disk.img ...]\n"
29893 #: ../tools/virt-list-filesystems.pl:42 ../tools/virt-list-partitions.pl:42
29895 "This tool is obsolete. Use L<virt-filesystems(1)> as a more flexible "
29900 #: ../tools/virt-list-filesystems.pl:45
29902 "C<virt-list-filesystems> is a command line tool to list the filesystems that "
29903 "are contained in a virtual machine or disk image."
29907 #: ../tools/virt-list-filesystems.pl:49
29909 "C<virt-list-filesystems> is just a simple wrapper around L<libguestfs(3)> "
29910 "functionality. For more complex cases you should look at the L<guestfish(1)"
29915 #: ../tools/virt-list-filesystems.pl:106 ../tools/virt-list-partitions.pl:115
29916 msgid "B<-l> | B<--long>"
29920 #: ../tools/virt-list-filesystems.pl:108
29922 "With this option, C<virt-list-filesystems> displays the type of each "
29923 "filesystem too (where \"type\" means C<ext3>, C<xfs> etc.)"
29927 #: ../tools/virt-list-filesystems.pl:115
29928 msgid "B<-a> | B<--all>"
29932 #: ../tools/virt-list-filesystems.pl:117
29934 "Normally we only show mountable filesystems. If this option is given then "
29935 "swap devices are shown too."
29939 #: ../tools/virt-list-filesystems.pl:191
29941 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, L<virt-"
29942 "filesystems(1)>, L<virt-list-partitions(1)>, L<Sys::Guestfs(3)>, L<Sys::"
29943 "Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
29947 #: ../tools/virt-list-filesystems.pl:208 ../tools/virt-tar.pl:307
29948 msgid "Copyright (C) 2009 Red Hat Inc."
29952 #: ../tools/virt-tar.pl:33
29953 msgid "virt-tar - Extract or upload files to a virtual machine"
29957 #: ../tools/virt-tar.pl:37
29960 " virt-tar [--options] -x domname directory tarball\n"
29965 #: ../tools/virt-tar.pl:39
29968 " virt-tar [--options] -u domname tarball directory\n"
29973 #: ../tools/virt-tar.pl:41
29976 " virt-tar [--options] disk.img [disk.img ...] -x directory tarball\n"
29981 #: ../tools/virt-tar.pl:43
29984 " virt-tar [--options] disk.img [disk.img ...] -u tarball directory\n"
29989 #: ../tools/virt-tar.pl:47
29991 "This tool is obsolete. Use L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-"
29992 "tar-in(1)>, L<virt-tar-out(1)> as replacements."
29996 #: ../tools/virt-tar.pl:52
29997 msgid "Download C</home> from the VM into a local tarball:"
30001 #: ../tools/virt-tar.pl:54
30004 " virt-tar -x domname /home home.tar\n"
30009 #: ../tools/virt-tar.pl:56
30012 " virt-tar -zx domname /home home.tar.gz\n"
30017 #: ../tools/virt-tar.pl:58
30018 msgid "Upload a local tarball and unpack it inside C</tmp> in the VM:"
30022 #: ../tools/virt-tar.pl:60
30025 " virt-tar -u domname uploadstuff.tar /tmp\n"
30030 #: ../tools/virt-tar.pl:62
30033 " virt-tar -zu domname uploadstuff.tar.gz /tmp\n"
30038 #: ../tools/virt-tar.pl:66
30040 "You must I<not> use C<virt-tar> with the C<-u> option (upload) on live "
30041 "virtual machines. If you do this, you risk disk corruption in the VM. "
30042 "C<virt-tar> tries to stop you from doing this, but doesn't catch all cases."
30046 #: ../tools/virt-tar.pl:71
30048 "You can use C<-x> (extract) on live virtual machines, but you might get "
30049 "inconsistent results or errors if there is filesystem activity inside the "
30050 "VM. If the live VM is synched and quiescent, then C<virt-tar> will usually "
30051 "work, but the only way to guarantee consistent results is if the virtual "
30052 "machine is shut down."
30056 #: ../tools/virt-tar.pl:79
30058 "C<virt-tar> is a general purpose archive tool for downloading and uploading "
30059 "parts of a guest filesystem. There are many possibilities: making backups, "
30060 "uploading data files, snooping on guest activity, fixing or customizing "
30065 #: ../tools/virt-tar.pl:84
30067 "If you want to just view a single file, use L<virt-cat(1)>. If you just "
30068 "want to edit a single file, use L<virt-edit(1)>. For more complex cases you "
30069 "should look at the L<guestfish(1)> tool."
30073 #: ../tools/virt-tar.pl:88
30075 "There are two modes of operation: C<-x> (eXtract) downloads a directory and "
30076 "its contents (recursively) from the virtual machine into a local tarball. "
30077 "C<-u> uploads from a local tarball, unpacking it into a directory inside the "
30078 "virtual machine. You cannot use these two options together."
30082 #: ../tools/virt-tar.pl:94
30084 "In addition, you may need to use the C<-z> (gZip) option to enable "
30085 "compression. When uploading, you have to specify C<-z> if the upload file "
30086 "is compressed because virt-tar won't detect this on its own."
30090 #: ../tools/virt-tar.pl:98
30092 "C<virt-tar> can only handle tar (optionally gzipped) format tarballs. For "
30093 "example it cannot do PKZip files or bzip2 compression. If you want that "
30094 "then you'll have to rebuild the tarballs yourself. (This is a limitation of "
30095 "the L<libguestfs(3)> API)."
30099 #: ../tools/virt-tar.pl:156
30100 msgid "B<-x> | B<--extract> | B<--download>"
30104 #: ../tools/virt-tar.pl:158
30105 msgid "B<-u> | B<--upload>"
30109 #: ../tools/virt-tar.pl:160
30111 "Use C<-x> to extract (download) a directory from a virtual machine to a "
30116 #: ../tools/virt-tar.pl:163
30118 "Use C<-u> to upload and unpack from a local tarball into a virtual machine. "
30119 "Please read the L</WARNING> section above before using this option."
30123 #: ../tools/virt-tar.pl:167
30124 msgid "You must specify exactly one of these options."
30128 #: ../tools/virt-tar.pl:173
30129 msgid "B<-z> | B<--gzip>"
30133 #: ../tools/virt-tar.pl:175
30134 msgid "Specify that the input or output tarball is gzip-compressed."
30138 #: ../tools/virt-tar.pl:288
30140 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, L<virt-copy-"
30141 "in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<Sys::"
30142 "Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs."
30147 #: ../tools/virt-make-fs.pl:37
30148 msgid "virt-make-fs - Make a filesystem from a tar archive or files"
30152 #: ../tools/virt-make-fs.pl:41
30155 " virt-make-fs [--options] input.tar output.img\n"
30160 #: ../tools/virt-make-fs.pl:43
30163 " virt-make-fs [--options] input.tar.gz output.img\n"
30168 #: ../tools/virt-make-fs.pl:45
30171 " virt-make-fs [--options] directory output.img\n"
30176 #: ../tools/virt-make-fs.pl:49
30178 "Virt-make-fs is a command line tool for creating a filesystem from a tar "
30179 "archive or some files in a directory. It is similar to tools like L<mkisofs"
30180 "(1)>, L<genisoimage(1)> and L<mksquashfs(1)>. Unlike those tools, it can "
30181 "create common filesystem types like ext2/3 or NTFS, which can be useful if "
30182 "you want to attach these filesystems to existing virtual machines (eg. to "
30183 "import large amounts of read-only data to a VM)."
30187 #: ../tools/virt-make-fs.pl:57
30188 msgid "Basic usage is:"
30192 #: ../tools/virt-make-fs.pl:59
30195 " virt-make-fs input output\n"
30200 #: ../tools/virt-make-fs.pl:61
30202 "where C<input> is either a directory containing files that you want to add, "
30203 "or a tar archive (either uncompressed tar or gzip-compressed tar); and "
30204 "C<output> is a disk image. The input type is detected automatically. The "
30205 "output disk image defaults to a raw ext2 image unless you specify extra "
30206 "flags (see L</OPTIONS> below)."
30210 #: ../tools/virt-make-fs.pl:67
30211 msgid "EXTRA SPACE"
30215 #: ../tools/virt-make-fs.pl:69
30217 "Unlike formats such as tar and squashfs, a filesystem does not \"just fit\" "
30218 "the files that it contains, but might have extra space. Depending on how "
30219 "you are going to use the output, you might think this extra space is wasted "
30220 "and want to minimize it, or you might want to leave space so that more files "
30221 "can be added later. Virt-make-fs defaults to minimizing the extra space, "
30222 "but you can use the C<--size> flag to leave space in the filesystem if you "
30227 #: ../tools/virt-make-fs.pl:77
30229 "An alternative way to leave extra space but not make the output image any "
30230 "bigger is to use an alternative disk image format (instead of the default "
30231 "\"raw\" format). Using C<--format=qcow2> will use the native QEmu/KVM qcow2 "
30232 "image format (check your hypervisor supports this before using it). This "
30233 "allows you to choose a large C<--size> but the extra space won't actually be "
30234 "allocated in the image until you try to store something in it."
30238 #: ../tools/virt-make-fs.pl:85
30240 "Don't forget that you can also use local commands including L<resize2fs(8)> "
30241 "and L<virt-resize(1)> to resize existing filesystems, or rerun virt-make-fs "
30242 "to build another image from scratch."
30246 #: ../tools/virt-make-fs.pl:89 ../tools/virt-make-fs.pl:123
30247 #: ../tools/virt-make-fs.pl:142
30252 #: ../tools/virt-make-fs.pl:91
30255 " virt-make-fs --format=qcow2 --size=+200M input output.img\n"
30260 #: ../tools/virt-make-fs.pl:93
30261 msgid "FILESYSTEM TYPE"
30265 #: ../tools/virt-make-fs.pl:95
30267 "The default filesystem type is C<ext2>. Just about any filesystem type that "
30268 "libguestfs supports can be used (but I<not> read-only formats like "
30269 "ISO9660). Here are some of the more common choices:"
30273 #: ../tools/virt-make-fs.pl:101
30278 #: ../tools/virt-make-fs.pl:103
30280 "Note that ext3 filesystems contain a journal, typically 1-32 MB in size. If "
30281 "you are not going to use the filesystem in a way that requires the journal, "
30282 "then this is just wasted overhead."
30286 #: ../tools/virt-make-fs.pl:107
30287 msgid "I<ntfs> or I<vfat>"
30291 #: ../tools/virt-make-fs.pl:109
30292 msgid "Useful if exporting data to a Windows guest."
30296 #: ../tools/virt-make-fs.pl:111
30298 "I<Note for vfat>: The tar archive or local directory must only contain files "
30299 "which are owned by root (ie. UID:GID = 0:0). The reason is that the tar "
30300 "program running within libguestfs is unable to change the ownership of non-"
30301 "root files, since vfat itself does not support this."
30305 #: ../tools/virt-make-fs.pl:116
30310 #: ../tools/virt-make-fs.pl:118
30312 "Lower overhead than C<ext2>, but certain limitations on filename length and "
30313 "total filesystem size."
30317 #: ../tools/virt-make-fs.pl:125
30320 " virt-make-fs --type=minix input minixfs.img\n"
30325 #: ../tools/virt-make-fs.pl:127
30326 msgid "TO PARTITION OR NOT TO PARTITION"
30330 #: ../tools/virt-make-fs.pl:129
30331 msgid "Optionally virt-make-fs can add a partition table to the output disk."
30335 #: ../tools/virt-make-fs.pl:131
30337 "Adding a partition can make the disk image more compatible with certain "
30338 "virtualized operating systems which don't expect to see a filesystem "
30339 "directly located on a block device (Linux doesn't care and will happily "
30340 "handle both types)."
30344 #: ../tools/virt-make-fs.pl:136
30346 "On the other hand, if you have a partition table then the output image is no "
30347 "longer a straight filesystem. For example you cannot run L<fsck(8)> "
30348 "directly on a partitioned disk image. (However libguestfs tools such as "
30349 "L<guestfish(1)> and L<virt-resize(1)> can still be used)."
30353 #: ../tools/virt-make-fs.pl:144
30354 msgid "Add an MBR partition:"
30358 #: ../tools/virt-make-fs.pl:146
30361 " virt-make-fs --partition -- input disk.img\n"
30366 #: ../tools/virt-make-fs.pl:148
30368 "If the output disk image could be terabyte-sized or larger, it's better to "
30369 "use an EFI/GPT-compatible partition table:"
30373 #: ../tools/virt-make-fs.pl:151
30376 " virt-make-fs --partition=gpt --size=+4T --format=qcow2 input disk.img\n"
30381 #: ../tools/virt-make-fs.pl:179
30382 msgid "Enable debugging information."
30386 #: ../tools/virt-make-fs.pl:185
30387 msgid "B<--size=E<lt>NE<gt>>"
30391 #: ../tools/virt-make-fs.pl:187
30392 msgid "B<--size=+E<lt>NE<gt>>"
30396 #: ../tools/virt-make-fs.pl:189
30397 msgid "B<-s E<lt>NE<gt>>"
30401 #: ../tools/virt-make-fs.pl:191
30402 msgid "B<-s +E<lt>NE<gt>>"
30406 #: ../tools/virt-make-fs.pl:193
30408 "Use the C<--size> (or C<-s>) option to choose the size of the output image."
30412 #: ../tools/virt-make-fs.pl:196
30414 "If this option is I<not> given, then the output image will be just large "
30415 "enough to contain all the files, with not much wasted space."
30419 #: ../tools/virt-make-fs.pl:199
30421 "To choose a fixed size output disk, specify an absolute number followed by b/"
30422 "K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
30423 "Petabytes or Exabytes. This must be large enough to contain all the input "
30424 "files, else you will get an error."
30428 #: ../tools/virt-make-fs.pl:204
30430 "To leave extra space, specify C<+> (plus sign) and a number followed by b/K/"
30431 "M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
30432 "Petabytes or Exabytes. For example: C<--size=+200M> means enough space for "
30433 "the input files, and (approximately) an extra 200 MB free space."
30437 #: ../tools/virt-make-fs.pl:210
30439 "Note that virt-make-fs estimates free space, and therefore will not produce "
30440 "filesystems containing precisely the free space requested. (It is much more "
30441 "expensive and time-consuming to produce a filesystem which has precisely the "
30442 "desired free space)."
30446 #: ../tools/virt-make-fs.pl:219
30447 msgid "B<--format=E<lt>fmtE<gt>>"
30451 #: ../tools/virt-make-fs.pl:221
30452 msgid "B<-F E<lt>fmtE<gt>>"
30456 #: ../tools/virt-make-fs.pl:223
30457 msgid "Choose the output disk image format."
30461 #: ../tools/virt-make-fs.pl:225
30462 msgid "The default is C<raw> (raw disk image)."
30466 #: ../tools/virt-make-fs.pl:227
30468 "For other choices, see the L<qemu-img(1)> manpage. The only other choice "
30469 "that would really make sense here is C<qcow2>."
30473 #: ../tools/virt-make-fs.pl:234
30474 msgid "B<--type=E<lt>fsE<gt>>"
30478 #: ../tools/virt-make-fs.pl:236
30479 msgid "B<-t E<lt>fsE<gt>>"
30483 #: ../tools/virt-make-fs.pl:238
30484 msgid "Choose the output filesystem type."
30488 #: ../tools/virt-make-fs.pl:240
30489 msgid "The default is C<ext2>."
30493 #: ../tools/virt-make-fs.pl:242
30495 "Any filesystem which is supported read-write by libguestfs can be used here."
30499 #: ../tools/virt-make-fs.pl:249
30500 msgid "B<--partition>"
30504 #: ../tools/virt-make-fs.pl:251
30505 msgid "B<--partition=E<lt>parttypeE<gt>>"
30509 #: ../tools/virt-make-fs.pl:253
30511 "If specified, this flag adds an MBR partition table to the output disk image."
30515 #: ../tools/virt-make-fs.pl:256
30517 "You can change the partition table type, eg. C<--partition=gpt> for large "
30522 #: ../tools/virt-make-fs.pl:259
30524 "Note that if you just use a lonesome C<--partition>, the Perl option parser "
30525 "might consider the next parameter to be the partition type. For example:"
30529 #: ../tools/virt-make-fs.pl:263
30532 " virt-make-fs --partition input.tar ...\n"
30537 #: ../tools/virt-make-fs.pl:265
30539 "would cause virt-make-fs to think you wanted to use a partition type of "
30540 "C<input.tar> which is completely wrong. To avoid this, use C<--> (a double "
30541 "dash) between options and the input file argument:"
30545 #: ../tools/virt-make-fs.pl:269
30548 " virt-make-fs --partition -- input.tar ...\n"
30553 #: ../tools/virt-make-fs.pl:541
30555 "L<guestfish(1)>, L<virt-resize(1)>, L<virt-tar-in(1)>, L<mkisofs(1)>, "
30556 "L<genisoimage(1)>, L<mksquashfs(1)>, L<mke2fs(8)>, L<resize2fs(8)>, L<guestfs"
30557 "(3)>, L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
30561 #: ../tools/virt-make-fs.pl:558
30564 " export LIBGUESTFS_DEBUG=1\n"
30565 " virt-make-fs --debug [...] > /tmp/virt-make-fs.log 2>&1\n"
30570 #: ../tools/virt-make-fs.pl:561
30572 "Attach /tmp/virt-make-fs.log to a new bug report at L<https://bugzilla."
30577 #: ../tools/virt-list-partitions.pl:32
30579 "virt-list-partitions - List partitions in a virtual machine or disk image"
30583 #: ../tools/virt-list-partitions.pl:36
30586 " virt-list-partitions [--options] domname\n"
30591 #: ../tools/virt-list-partitions.pl:38
30594 " virt-list-partitions [--options] disk.img [disk.img ...]\n"
30599 #: ../tools/virt-list-partitions.pl:45
30601 "C<virt-list-partitions> is a command line tool to list the partitions that "
30602 "are contained in a virtual machine or disk image. It is mainly useful as a "
30603 "first step to using L<virt-resize(1)>."
30607 #: ../tools/virt-list-partitions.pl:50
30609 "C<virt-list-partitions> is just a simple wrapper around L<libguestfs(3)> "
30610 "functionality. For more complex cases you should look at the L<guestfish(1)"
30615 #: ../tools/virt-list-partitions.pl:107
30616 msgid "B<-h> | B<--human-readable>"
30620 #: ../tools/virt-list-partitions.pl:109
30621 msgid "Show sizes in human-readable form (eg. \"1G\")."
30625 #: ../tools/virt-list-partitions.pl:117
30627 "With this option, C<virt-list-partitions> displays the type and size of each "
30628 "partition too (where \"type\" means C<ext3>, C<pv> etc.)"
30632 #: ../tools/virt-list-partitions.pl:124
30633 msgid "B<-t> | B<--total>"
30637 #: ../tools/virt-list-partitions.pl:126
30639 "Display the total size of each block device (as a separate row or rows)."
30643 #: ../tools/virt-list-partitions.pl:259
30645 "L<guestfs(3)>, L<guestfish(1)>, L<virt-filesystems(1)>, L<virt-list-"
30646 "filesystems(1)>, L<virt-resize(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib"
30647 "(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
30651 #: ../tools/virt-list-partitions.pl:275
30652 msgid "Copyright (C) 2009-2010 Red Hat Inc."