1 # SOME DESCRIPTIVE TITLE
2 # Copyright (C) YEAR Red Hat Inc.
3 # This file is distributed under the same license as the libguestfs package.
4 # FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
8 "Project-Id-Version: libguestfs\n"
9 "Report-Msgid-Bugs-To: libguestfs@redhat.com\n"
10 "POT-Creation-Date: 2011-07-15 17:18+0200\n"
11 "PO-Revision-Date: 2011-04-01 15:39+0000\n"
12 "Last-Translator: yurchor <yurchor@ukr.net>\n"
13 "Language-Team: Ukrainian <trans-uk@lists.fedoraproject.org>\n"
16 "Content-Type: text/plain; charset=UTF-8\n"
17 "Content-Transfer-Encoding: 8bit\n"
18 "Plural-Forms: nplurals=3; plural=(n%10==1 && n%100!=11 ? 0 : n%10>=2 && n"
19 "%10<=4 && (n%100<10 || n%100>=20) ? 1 : 2)\n"
22 #: ../src/guestfs.pod:3 ../fish/guestfish.pod:3
23 #: ../test-tool/libguestfs-test-tool.pod:3 ../fuse/guestmount.pod:3
24 #: ../tools/virt-win-reg.pl:35 ../tools/virt-list-filesystems.pl:30
25 #: ../tools/virt-tar.pl:31 ../tools/virt-make-fs.pl:35
26 #: ../tools/virt-list-partitions.pl:30
31 #: ../src/guestfs.pod:5
32 msgid "guestfs - Library for accessing and modifying virtual machine images"
34 "guestfs — бібліотека для доступу та внесення змін до образів віртуальних "
38 #: ../src/guestfs.pod:7 ../fish/guestfish.pod:7
39 #: ../test-tool/libguestfs-test-tool.pod:7 ../fuse/guestmount.pod:7
40 #: ../tools/virt-win-reg.pl:39 ../tools/virt-list-filesystems.pl:34
41 #: ../tools/virt-tar.pl:35 ../tools/virt-make-fs.pl:39
42 #: ../tools/virt-list-partitions.pl:34
44 msgstr "КОРОТКИЙ ОПИС"
47 #: ../src/guestfs.pod:9
50 " #include <guestfs.h>\n"
53 " #include <guestfs.h>\n"
57 #: ../src/guestfs.pod:11
60 " guestfs_h *g = guestfs_create ();\n"
61 " guestfs_add_drive (g, \"guest.img\");\n"
62 " guestfs_launch (g);\n"
63 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
64 " guestfs_touch (g, \"/hello\");\n"
65 " guestfs_umount (g, \"/\");\n"
66 " guestfs_close (g);\n"
69 " guestfs_h *g = guestfs_create ();\n"
70 " guestfs_add_drive (g, \"guest.img\");\n"
71 " guestfs_launch (g);\n"
72 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
73 " guestfs_touch (g, \"/hello\");\n"
74 " guestfs_umount (g, \"/\");\n"
75 " guestfs_close (g);\n"
79 #: ../src/guestfs.pod:19
82 " cc prog.c -o prog -lguestfs\n"
84 " cc prog.c -o prog `pkg-config libguestfs --cflags --libs`\n"
87 " cc prog.c -o prog -lguestfs\n"
89 " cc prog.c -o prog `pkg-config libguestfs --cflags --libs`\n"
93 #: ../src/guestfs.pod:23 ../fish/guestfish.pod:30
94 #: ../test-tool/libguestfs-test-tool.pod:11 ../fuse/guestmount.pod:20
95 #: ../tools/virt-win-reg.pl:63 ../tools/virt-list-filesystems.pl:40
96 #: ../tools/virt-tar.pl:77 ../tools/virt-make-fs.pl:47
97 #: ../tools/virt-list-partitions.pl:40
102 #: ../src/guestfs.pod:25
104 "Libguestfs is a library for accessing and modifying guest disk images. "
105 "Amongst the things this is good for: making batch configuration changes to "
106 "guests, getting disk used/free statistics (see also: virt-df), migrating "
107 "between virtualization systems (see also: virt-p2v), performing partial "
108 "backups, performing partial guest clones, cloning guests and changing "
109 "registry/UUID/hostname info, and much else besides."
113 #: ../src/guestfs.pod:33
115 "Libguestfs uses Linux kernel and qemu code, and can access any type of guest "
116 "filesystem that Linux and qemu can, including but not limited to: ext2/3/4, "
117 "btrfs, FAT and NTFS, LVM, many different disk partition schemes, qcow, "
122 #: ../src/guestfs.pod:38
124 "Libguestfs provides ways to enumerate guest storage (eg. partitions, LVs, "
125 "what filesystem is in each LV, etc.). It can also run commands in the "
126 "context of the guest. Also you can access filesystems over FUSE."
130 #: ../src/guestfs.pod:43
132 "Libguestfs is a library that can be linked with C and C++ management "
133 "programs (or management programs written in OCaml, Perl, Python, Ruby, Java, "
134 "PHP, Haskell or C#). You can also use it from shell scripts or the command "
139 #: ../src/guestfs.pod:48
141 "You don't need to be root to use libguestfs, although obviously you do need "
142 "enough permissions to access the disk images."
146 #: ../src/guestfs.pod:51
148 "Libguestfs is a large API because it can do many things. For a gentle "
149 "introduction, please read the L</API OVERVIEW> section next."
153 #: ../src/guestfs.pod:54
155 "There are also some example programs in the L<guestfs-examples(3)> manual "
160 #: ../src/guestfs.pod:57
165 #: ../src/guestfs.pod:59
167 "This section provides a gentler overview of the libguestfs API. We also try "
168 "to group API calls together, where that may not be obvious from reading "
169 "about the individual calls in the main section of this manual."
173 #: ../src/guestfs.pod:64
178 #: ../src/guestfs.pod:66
180 "Before you can use libguestfs calls, you have to create a handle. Then you "
181 "must add at least one disk image to the handle, followed by launching the "
182 "handle, then performing whatever operations you want, and finally closing "
183 "the handle. By convention we use the single letter C<g> for the name of the "
184 "handle variable, although of course you can use any name you want."
188 #: ../src/guestfs.pod:73
189 msgid "The general structure of all libguestfs-using programs looks like this:"
193 #: ../src/guestfs.pod:76
196 " guestfs_h *g = guestfs_create ();\n"
199 " guestfs_h *g = guestfs_create ();\n"
203 #: ../src/guestfs.pod:78
206 " /* Call guestfs_add_drive additional times if there are\n"
207 " * multiple disk images.\n"
209 " guestfs_add_drive (g, \"guest.img\");\n"
214 #: ../src/guestfs.pod:83
217 " /* Most manipulation calls won't work until you've launched\n"
218 " * the handle 'g'. You have to do this _after_ adding drives\n"
219 " * and _before_ other commands.\n"
221 " guestfs_launch (g);\n"
226 #: ../src/guestfs.pod:89
229 " /* Now you can examine what partitions, LVs etc are available.\n"
231 " char **partitions = guestfs_list_partitions (g);\n"
232 " char **logvols = guestfs_lvs (g);\n"
237 #: ../src/guestfs.pod:94
240 " /* To access a filesystem in the image, you must mount it.\n"
242 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
245 " /* Щоб отримати доступ до файлової системи на образі, вам слід його змонтувати.\n"
247 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
251 #: ../src/guestfs.pod:98
254 #| " /* Now you can perform filesystem actions on the guest\n"
255 #| " * disk image.\n"
257 #| " guestfs_touch (g, \"/hello\");\n"
260 " /* Now you can perform filesystem actions on the guest\n"
263 " guestfs_touch (g, \"/hello\");\n"
266 " /* Тепер ви можете виконувати дії з файловою системою на\n"
267 " * образі диска операційної системи.\n"
269 " guestfs_touch (g, \"/hello\");\n"
273 #: ../src/guestfs.pod:103
276 " /* This is only needed for libguestfs < 1.5.24. Since then\n"
277 " * it is done automatically when you close the handle. See\n"
278 " * discussion of autosync in this page.\n"
280 " guestfs_sync (g);\n"
285 #: ../src/guestfs.pod:109
288 " /* Close the handle 'g'. */\n"
289 " guestfs_close (g);\n"
294 #: ../src/guestfs.pod:112
296 "The code above doesn't include any error checking. In real code you should "
297 "check return values carefully for errors. In general all functions that "
298 "return integers return C<-1> on error, and all functions that return "
299 "pointers return C<NULL> on error. See section L</ERROR HANDLING> below for "
300 "how to handle errors, and consult the documentation for each function call "
301 "below to see precisely how they return error indications. See L<guestfs-"
302 "examples(3)> for fully worked examples."
306 #: ../src/guestfs.pod:121
311 #: ../src/guestfs.pod:123
313 "The image filename (C<\"guest.img\"> in the example above) could be a disk "
314 "image from a virtual machine, a L<dd(1)> copy of a physical hard disk, an "
315 "actual block device, or simply an empty file of zeroes that you have created "
316 "through L<posix_fallocate(3)>. Libguestfs lets you do useful things to all "
321 #: ../src/guestfs.pod:129
323 "The call you should use in modern code for adding drives is L</"
324 "guestfs_add_drive_opts>. To add a disk image, allowing writes, and "
325 "specifying that the format is raw, do:"
329 #: ../src/guestfs.pod:133
332 " guestfs_add_drive_opts (g, filename,\n"
333 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
339 #: ../src/guestfs.pod:137
340 msgid "You can add a disk read-only using:"
344 #: ../src/guestfs.pod:139
347 " guestfs_add_drive_opts (g, filename,\n"
348 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
349 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
355 #: ../src/guestfs.pod:144
357 "or by calling the older function L</guestfs_add_drive_ro>. In either case "
358 "libguestfs won't modify the file."
362 #: ../src/guestfs.pod:147
364 "Be extremely cautious if the disk image is in use, eg. if it is being used "
365 "by a virtual machine. Adding it read-write will almost certainly cause disk "
366 "corruption, but adding it read-only is safe."
370 #: ../src/guestfs.pod:151
372 "You must add at least one disk image, and you may add multiple disk images. "
373 "In the API, the disk images are usually referred to as C</dev/sda> (for the "
374 "first one you added), C</dev/sdb> (for the second one you added), etc."
378 #: ../src/guestfs.pod:156
380 "Once L</guestfs_launch> has been called you cannot add any more images. You "
381 "can call L</guestfs_list_devices> to get a list of the device names, in the "
382 "order that you added them. See also L</BLOCK DEVICE NAMING> below."
386 #: ../src/guestfs.pod:161
391 #: ../src/guestfs.pod:163
393 "Before you can read or write files, create directories and so on in a disk "
394 "image that contains filesystems, you have to mount those filesystems using "
395 "L</guestfs_mount_options> or L</guestfs_mount_ro>. If you already know that "
396 "a disk image contains (for example) one partition with a filesystem on that "
397 "partition, then you can mount it directly:"
401 #: ../src/guestfs.pod:170
404 " guestfs_mount_options (g, \"\", \"/dev/sda1\", \"/\");\n"
409 #: ../src/guestfs.pod:172
411 "where C</dev/sda1> means literally the first partition (C<1>) of the first "
412 "disk image that we added (C</dev/sda>). If the disk contains Linux LVM2 "
413 "logical volumes you could refer to those instead (eg. C</dev/VG/LV>). Note "
414 "that these are libguestfs virtual devices, and are nothing to do with host "
419 #: ../src/guestfs.pod:178
421 "If you are given a disk image and you don't know what it contains then you "
422 "have to find out. Libguestfs can do that too: use L</"
423 "guestfs_list_partitions> and L</guestfs_lvs> to list possible partitions and "
424 "LVs, and either try mounting each to see what is mountable, or else examine "
425 "them with L</guestfs_vfs_type> or L</guestfs_file>. To list just "
426 "filesystems, use L</guestfs_list_filesystems>."
430 #: ../src/guestfs.pod:186
432 "Libguestfs also has a set of APIs for inspection of unknown disk images (see "
433 "L</INSPECTION> below). But you might find it easier to look at higher level "
434 "programs built on top of libguestfs, in particular L<virt-inspector(1)>."
438 #: ../src/guestfs.pod:191
440 "To mount a filesystem read-only, use L</guestfs_mount_ro>. There are "
441 "several other variations of the C<guestfs_mount_*> call."
445 #: ../src/guestfs.pod:194
446 msgid "FILESYSTEM ACCESS AND MODIFICATION"
450 #: ../src/guestfs.pod:196
452 "The majority of the libguestfs API consists of fairly low-level calls for "
453 "accessing and modifying the files, directories, symlinks etc on mounted "
454 "filesystems. There are over a hundred such calls which you can find listed "
455 "in detail below in this man page, and we don't even pretend to cover them "
456 "all in this overview."
460 #: ../src/guestfs.pod:202
462 "Specify filenames as full paths, starting with C<\"/\"> and including the "
467 #: ../src/guestfs.pod:205
469 "For example, if you mounted a filesystem at C<\"/\"> and you want to read "
470 "the file called C<\"etc/passwd\"> then you could do:"
474 #: ../src/guestfs.pod:208
477 " char *data = guestfs_cat (g, \"/etc/passwd\");\n"
482 #: ../src/guestfs.pod:210
484 "This would return C<data> as a newly allocated buffer containing the full "
485 "content of that file (with some conditions: see also L</DOWNLOADING> below), "
486 "or C<NULL> if there was an error."
490 #: ../src/guestfs.pod:214
492 "As another example, to create a top-level directory on that filesystem "
493 "called C<\"var\"> you would do:"
497 #: ../src/guestfs.pod:217
500 " guestfs_mkdir (g, \"/var\");\n"
505 #: ../src/guestfs.pod:219
506 msgid "To create a symlink you could do:"
510 #: ../src/guestfs.pod:221
513 " guestfs_ln_s (g, \"/etc/init.d/portmap\",\n"
514 " \"/etc/rc3.d/S30portmap\");\n"
519 #: ../src/guestfs.pod:224
521 "Libguestfs will reject attempts to use relative paths and there is no "
522 "concept of a current working directory."
526 #: ../src/guestfs.pod:227
528 "Libguestfs can return errors in many situations: for example if the "
529 "filesystem isn't writable, or if a file or directory that you requested "
530 "doesn't exist. If you are using the C API (documented here) you have to "
531 "check for those error conditions after each call. (Other language bindings "
532 "turn these errors into exceptions)."
536 #: ../src/guestfs.pod:233
538 "File writes are affected by the per-handle umask, set by calling L</"
539 "guestfs_umask> and defaulting to 022. See L</UMASK>."
543 #: ../src/guestfs.pod:236
545 msgstr "ПОДІЛ НА РОЗДІЛИ"
548 #: ../src/guestfs.pod:238
550 "Libguestfs contains API calls to read, create and modify partition tables on "
555 #: ../src/guestfs.pod:241
557 "In the common case where you want to create a single partition covering the "
558 "whole disk, you should use the L</guestfs_part_disk> call:"
562 #: ../src/guestfs.pod:245
565 " const char *parttype = \"mbr\";\n"
566 " if (disk_is_larger_than_2TB)\n"
567 " parttype = \"gpt\";\n"
568 " guestfs_part_disk (g, \"/dev/sda\", parttype);\n"
573 #: ../src/guestfs.pod:250
575 "Obviously this effectively wipes anything that was on that disk image before."
579 #: ../src/guestfs.pod:253
584 #: ../src/guestfs.pod:255
586 "Libguestfs provides access to a large part of the LVM2 API, such as L</"
587 "guestfs_lvcreate> and L</guestfs_vgremove>. It won't make much sense unless "
588 "you familiarize yourself with the concepts of physical volumes, volume "
589 "groups and logical volumes."
593 #: ../src/guestfs.pod:260
595 "This author strongly recommends reading the LVM HOWTO, online at L<http://"
596 "tldp.org/HOWTO/LVM-HOWTO/>."
600 #: ../src/guestfs.pod:263
605 #: ../src/guestfs.pod:265
607 "Use L</guestfs_cat> to download small, text only files. This call is "
608 "limited to files which are less than 2 MB and which cannot contain any ASCII "
609 "NUL (C<\\0>) characters. However the API is very simple to use."
613 #: ../src/guestfs.pod:269
615 "L</guestfs_read_file> can be used to read files which contain arbitrary 8 "
616 "bit data, since it returns a (pointer, size) pair. However it is still "
617 "limited to \"small\" files, less than 2 MB."
621 #: ../src/guestfs.pod:273
623 "L</guestfs_download> can be used to download any file, with no limits on "
624 "content or size (even files larger than 4 GB)."
628 #: ../src/guestfs.pod:276
630 "To download multiple files, see L</guestfs_tar_out> and L</guestfs_tgz_out>."
634 #: ../src/guestfs.pod:279
636 msgstr "ВИВАНТАЖЕННЯ"
639 #: ../src/guestfs.pod:281
641 "It's often the case that you want to write a file or files to the disk image."
645 #: ../src/guestfs.pod:284
647 "To write a small file with fixed content, use L</guestfs_write>. To create "
648 "a file of all zeroes, use L</guestfs_truncate_size> (sparse) or L</"
649 "guestfs_fallocate64> (with all disk blocks allocated). There are a variety "
650 "of other functions for creating test files, for example L</guestfs_fill> and "
651 "L</guestfs_fill_pattern>."
655 #: ../src/guestfs.pod:290
657 "To upload a single file, use L</guestfs_upload>. This call has no limits on "
658 "file content or size (even files larger than 4 GB)."
662 #: ../src/guestfs.pod:293
664 "To upload multiple files, see L</guestfs_tar_in> and L</guestfs_tgz_in>."
668 #: ../src/guestfs.pod:295
670 "However the fastest way to upload I<large numbers of arbitrary files> is to "
671 "turn them into a squashfs or CD ISO (see L<mksquashfs(8)> and L<mkisofs(8)"
672 ">), then attach this using L</guestfs_add_drive_ro>. If you add the drive "
673 "in a predictable way (eg. adding it last after all other drives) then you "
674 "can get the device name from L</guestfs_list_devices> and mount it directly "
675 "using L</guestfs_mount_ro>. Note that squashfs images are sometimes non-"
676 "portable between kernel versions, and they don't support labels or UUIDs. "
677 "If you want to pre-build an image or you need to mount it using a label or "
678 "UUID, use an ISO image instead."
682 #: ../src/guestfs.pod:306
687 #: ../src/guestfs.pod:308
689 "There are various different commands for copying between files and devices "
690 "and in and out of the guest filesystem. These are summarised in the table "
695 #: ../src/guestfs.pod:314
696 msgid "B<file> to B<file>"
700 #: ../src/guestfs.pod:316
702 "Use L</guestfs_cp> to copy a single file, or L</guestfs_cp_a> to copy "
703 "directories recursively."
707 #: ../src/guestfs.pod:319
708 msgid "B<file or device> to B<file or device>"
712 #: ../src/guestfs.pod:321
714 "Use L</guestfs_dd> which efficiently uses L<dd(1)> to copy between files and "
715 "devices in the guest."
719 #: ../src/guestfs.pod:324
720 msgid "Example: duplicate the contents of an LV:"
724 #: ../src/guestfs.pod:326
727 " guestfs_dd (g, \"/dev/VG/Original\", \"/dev/VG/Copy\");\n"
732 #: ../src/guestfs.pod:328
734 "The destination (C</dev/VG/Copy>) must be at least as large as the source "
735 "(C</dev/VG/Original>). To copy less than the whole source device, use L</"
736 "guestfs_copy_size>."
740 #: ../src/guestfs.pod:332
741 msgid "B<file on the host> to B<file or device>"
745 #: ../src/guestfs.pod:334
746 msgid "Use L</guestfs_upload>. See L</UPLOADING> above."
750 #: ../src/guestfs.pod:336
751 msgid "B<file or device> to B<file on the host>"
755 #: ../src/guestfs.pod:338
756 msgid "Use L</guestfs_download>. See L</DOWNLOADING> above."
760 #: ../src/guestfs.pod:342
761 msgid "UPLOADING AND DOWNLOADING TO PIPES AND FILE DESCRIPTORS"
765 #: ../src/guestfs.pod:344
767 "Calls like L</guestfs_upload>, L</guestfs_download>, L</guestfs_tar_in>, L</"
768 "guestfs_tar_out> etc appear to only take filenames as arguments, so it "
769 "appears you can only upload and download to files. However many Un*x-like "
770 "hosts let you use the special device files C</dev/stdin>, C</dev/stdout>, C</"
771 "dev/stderr> and C</dev/fd/N> to read and write from stdin, stdout, stderr, "
772 "and arbitrary file descriptor N."
776 #: ../src/guestfs.pod:352
777 msgid "For example, L<virt-cat(1)> writes its output to stdout by doing:"
781 #: ../src/guestfs.pod:355
784 " guestfs_download (g, filename, \"/dev/stdout\");\n"
789 #: ../src/guestfs.pod:357
790 msgid "and you can write tar output to a file descriptor C<fd> by doing:"
794 #: ../src/guestfs.pod:359
798 " snprintf (devfd, sizeof devfd, \"/dev/fd/%d\", fd);\n"
799 " guestfs_tar_out (g, \"/\", devfd);\n"
804 #: ../src/guestfs.pod:363
805 msgid "LISTING FILES"
809 #: ../src/guestfs.pod:365
811 "L</guestfs_ll> is just designed for humans to read (mainly when using the "
812 "L<guestfish(1)>-equivalent command C<ll>)."
816 #: ../src/guestfs.pod:368
818 "L</guestfs_ls> is a quick way to get a list of files in a directory from "
819 "programs, as a flat list of strings."
823 #: ../src/guestfs.pod:371
825 "L</guestfs_readdir> is a programmatic way to get a list of files in a "
826 "directory, plus additional information about each one. It is more "
827 "equivalent to using the L<readdir(3)> call on a local filesystem."
831 #: ../src/guestfs.pod:375
833 "L</guestfs_find> and L</guestfs_find0> can be used to recursively list files."
837 #: ../src/guestfs.pod:378
838 msgid "RUNNING COMMANDS"
842 #: ../src/guestfs.pod:380
844 "Although libguestfs is primarily an API for manipulating files inside guest "
845 "images, we also provide some limited facilities for running commands inside "
850 #: ../src/guestfs.pod:384
851 msgid "There are many limitations to this:"
855 #: ../src/guestfs.pod:388 ../src/guestfs.pod:393 ../src/guestfs.pod:398
856 #: ../src/guestfs.pod:402 ../src/guestfs.pod:407 ../src/guestfs.pod:411
857 #: ../src/guestfs.pod:416 ../src/guestfs.pod:421 ../src/guestfs.pod:1064
858 #: ../src/guestfs.pod:1068 ../src/guestfs.pod:1072 ../src/guestfs.pod:1077
859 #: ../src/guestfs.pod:1085 ../src/guestfs.pod:1104 ../src/guestfs.pod:1112
860 #: ../src/guestfs.pod:1134 ../src/guestfs.pod:1138 ../src/guestfs.pod:1142
861 #: ../src/guestfs.pod:1146 ../src/guestfs.pod:1150 ../src/guestfs.pod:1154
862 #: ../src/guestfs.pod:1643 ../src/guestfs.pod:1648 ../src/guestfs.pod:1652
863 #: ../src/guestfs.pod:1754 ../src/guestfs.pod:1759 ../src/guestfs.pod:1763
864 #: ../src/guestfs.pod:1773 ../src/guestfs.pod:2047 ../src/guestfs.pod:2052
865 #: ../src/guestfs.pod:2058 ../src/guestfs.pod:2066 ../src/guestfs.pod:2420
866 #: ../src/guestfs.pod:2426 ../src/guestfs.pod:2431 ../src/guestfs.pod:2437
867 #: ../src/guestfs.pod:3011 ../src/guestfs.pod:3015 ../src/guestfs.pod:3019
868 #: ../src/guestfs.pod:3023 ../src/guestfs-actions.pod:15
869 #: ../src/guestfs-actions.pod:22 ../src/guestfs-actions.pod:583
870 #: ../src/guestfs-actions.pod:591 ../src/guestfs-actions.pod:598
871 #: ../src/guestfs-actions.pod:605 ../src/guestfs-actions.pod:1662
872 #: ../src/guestfs-actions.pod:1666 ../src/guestfs-actions.pod:1670
873 #: ../src/guestfs-actions.pod:1674 ../src/guestfs-actions.pod:1682
874 #: ../src/guestfs-actions.pod:1686 ../src/guestfs-actions.pod:1690
875 #: ../src/guestfs-actions.pod:1700 ../src/guestfs-actions.pod:1704
876 #: ../src/guestfs-actions.pod:1708 ../src/guestfs-actions.pod:1846
877 #: ../src/guestfs-actions.pod:1850 ../src/guestfs-actions.pod:1855
878 #: ../src/guestfs-actions.pod:1860 ../src/guestfs-actions.pod:1921
879 #: ../src/guestfs-actions.pod:1925 ../src/guestfs-actions.pod:1930
880 #: ../src/guestfs-actions.pod:2857 ../src/guestfs-actions.pod:2863
881 #: ../src/guestfs-actions.pod:2871 ../src/guestfs-actions.pod:2878
882 #: ../src/guestfs-actions.pod:2885 ../fish/guestfish.pod:445
883 #: ../fish/guestfish.pod:449 ../fish/guestfish.pod:453
884 #: ../fish/guestfish.pod:457 ../fish/guestfish-actions.pod:13
885 #: ../fish/guestfish-actions.pod:20 ../fish/guestfish-actions.pod:385
886 #: ../fish/guestfish-actions.pod:393 ../fish/guestfish-actions.pod:400
887 #: ../fish/guestfish-actions.pod:407 ../fish/guestfish-actions.pod:1099
888 #: ../fish/guestfish-actions.pod:1103 ../fish/guestfish-actions.pod:1107
889 #: ../fish/guestfish-actions.pod:1111 ../fish/guestfish-actions.pod:1119
890 #: ../fish/guestfish-actions.pod:1123 ../fish/guestfish-actions.pod:1127
891 #: ../fish/guestfish-actions.pod:1137 ../fish/guestfish-actions.pod:1141
892 #: ../fish/guestfish-actions.pod:1145 ../fish/guestfish-actions.pod:1235
893 #: ../fish/guestfish-actions.pod:1239 ../fish/guestfish-actions.pod:1244
894 #: ../fish/guestfish-actions.pod:1249 ../fish/guestfish-actions.pod:1291
895 #: ../fish/guestfish-actions.pod:1295 ../fish/guestfish-actions.pod:1300
896 #: ../fish/guestfish-actions.pod:1933 ../fish/guestfish-actions.pod:1939
897 #: ../fish/guestfish-actions.pod:1947 ../fish/guestfish-actions.pod:1954
898 #: ../fish/guestfish-actions.pod:1961 ../tools/virt-win-reg.pl:195
899 #: ../tools/virt-win-reg.pl:200 ../tools/virt-win-reg.pl:206
900 #: ../tools/virt-win-reg.pl:708 ../tools/virt-win-reg.pl:714
901 #: ../tools/virt-win-reg.pl:720
906 #: ../src/guestfs.pod:390
908 "The kernel version that the command runs under will be different from what "
913 #: ../src/guestfs.pod:395
915 "If the command needs to communicate with daemons, then most likely they "
920 #: ../src/guestfs.pod:400
921 msgid "The command will be running in limited memory."
925 #: ../src/guestfs.pod:404
927 "The network may not be available unless you enable it (see L</"
928 "guestfs_set_network>)."
932 #: ../src/guestfs.pod:409
933 msgid "Only supports Linux guests (not Windows, BSD, etc)."
937 #: ../src/guestfs.pod:413
939 "Architecture limitations (eg. won't work for a PPC guest on an X86 host)."
943 #: ../src/guestfs.pod:418
945 "For SELinux guests, you may need to enable SELinux and load policy first. "
946 "See L</SELINUX> in this manpage."
950 #: ../src/guestfs.pod:423
952 "I<Security:> It is not safe to run commands from untrusted, possibly "
953 "malicious guests. These commands may attempt to exploit your program by "
954 "sending unexpected output. They could also try to exploit the Linux kernel "
955 "or qemu provided by the libguestfs appliance. They could use the network "
956 "provided by the libguestfs appliance to bypass ordinary network partitions "
957 "and firewalls. They could use the elevated privileges or different SELinux "
958 "context of your program to their advantage."
962 #: ../src/guestfs.pod:432
964 "A secure alternative is to use libguestfs to install a \"firstboot\" script "
965 "(a script which runs when the guest next boots normally), and to have this "
966 "script run the commands you want in the normal context of the running guest, "
967 "network security and so on. For information about other security issues, "
972 #: ../src/guestfs.pod:440
974 "The two main API calls to run commands are L</guestfs_command> and L</"
975 "guestfs_sh> (there are also variations)."
979 #: ../src/guestfs.pod:443
981 "The difference is that L</guestfs_sh> runs commands using the shell, so any "
982 "shell globs, redirections, etc will work."
986 #: ../src/guestfs.pod:446
987 msgid "CONFIGURATION FILES"
988 msgstr "ФАЙЛИ НАЛАШТУВАННЯ"
991 #: ../src/guestfs.pod:448
993 "To read and write configuration files in Linux guest filesystems, we "
994 "strongly recommend using Augeas. For example, Augeas understands how to "
995 "read and write, say, a Linux shadow password file or X.org configuration "
996 "file, and so avoids you having to write that code."
1000 #: ../src/guestfs.pod:453
1002 "The main Augeas calls are bound through the C<guestfs_aug_*> APIs. We don't "
1003 "document Augeas itself here because there is excellent documentation on the "
1004 "L<http://augeas.net/> website."
1008 #: ../src/guestfs.pod:457
1010 "If you don't want to use Augeas (you fool!) then try calling L</"
1011 "guestfs_read_lines> to get the file as a list of lines which you can iterate "
1016 #: ../src/guestfs.pod:461
1021 #: ../src/guestfs.pod:463
1023 "We support SELinux guests. To ensure that labeling happens correctly in "
1024 "SELinux guests, you need to enable SELinux and load the guest's policy:"
1028 #: ../src/guestfs.pod:469 ../src/guestfs.pod:1257 ../src/guestfs.pod:1395
1029 #: ../src/guestfs.pod:2465
1034 #: ../src/guestfs.pod:471
1035 msgid "Before launching, do:"
1039 #: ../src/guestfs.pod:473
1042 " guestfs_set_selinux (g, 1);\n"
1047 #: ../src/guestfs.pod:475 ../src/guestfs.pod:1261 ../src/guestfs.pod:1399
1048 #: ../src/guestfs.pod:2490
1053 #: ../src/guestfs.pod:477
1055 "After mounting the guest's filesystem(s), load the policy. This is best "
1056 "done by running the L<load_policy(8)> command in the guest itself:"
1060 #: ../src/guestfs.pod:481
1063 " guestfs_sh (g, \"/usr/sbin/load_policy\");\n"
1068 #: ../src/guestfs.pod:483
1070 "(Older versions of C<load_policy> require you to specify the name of the "
1075 #: ../src/guestfs.pod:486 ../src/guestfs.pod:1405
1080 #: ../src/guestfs.pod:488
1082 "Optionally, set the security context for the API. The correct security "
1083 "context to use can only be known by inspecting the guest. As an example:"
1087 #: ../src/guestfs.pod:492
1090 " guestfs_setcon (g, \"unconfined_u:unconfined_r:unconfined_t:s0\");\n"
1095 #: ../src/guestfs.pod:496
1096 msgid "This will work for running commands and editing existing files."
1100 #: ../src/guestfs.pod:498
1102 "When new files are created, you may need to label them explicitly, for "
1103 "example by running the external command C<restorecon pathname>."
1107 #: ../src/guestfs.pod:502
1112 #: ../src/guestfs.pod:504
1114 "Certain calls are affected by the current file mode creation mask (the "
1115 "\"umask\"). In particular ones which create files or directories, such as "
1116 "L</guestfs_touch>, L</guestfs_mknod> or L</guestfs_mkdir>. This affects "
1117 "either the default mode that the file is created with or modifies the mode "
1122 #: ../src/guestfs.pod:510
1124 "The default umask is C<022>, so files are created with modes such as C<0644> "
1125 "and directories with C<0755>."
1129 #: ../src/guestfs.pod:513
1131 "There are two ways to avoid being affected by umask. Either set umask to 0 "
1132 "(call C<guestfs_umask (g, 0)> early after launching). Or call L</"
1133 "guestfs_chmod> after creating each file or directory."
1137 #: ../src/guestfs.pod:517
1138 msgid "For more information about umask, see L<umask(2)>."
1142 #: ../src/guestfs.pod:519 ../fish/guestfish.pod:825
1143 msgid "ENCRYPTED DISKS"
1147 #: ../src/guestfs.pod:521
1149 "Libguestfs allows you to access Linux guests which have been encrypted using "
1150 "whole disk encryption that conforms to the Linux Unified Key Setup (LUKS) "
1151 "standard. This includes nearly all whole disk encryption systems used by "
1152 "modern Linux guests."
1156 #: ../src/guestfs.pod:527
1158 "Use L</guestfs_vfs_type> to identify LUKS-encrypted block devices (it "
1159 "returns the string C<crypto_LUKS>)."
1163 #: ../src/guestfs.pod:530
1165 "Then open these devices by calling L</guestfs_luks_open>. Obviously you "
1166 "will require the passphrase!"
1170 #: ../src/guestfs.pod:533
1172 "Opening a LUKS device creates a new device mapper device called C</dev/"
1173 "mapper/mapname> (where C<mapname> is the string you supply to L</"
1174 "guestfs_luks_open>). Reads and writes to this mapper device are decrypted "
1175 "from and encrypted to the underlying block device respectively."
1179 #: ../src/guestfs.pod:539
1181 "LVM volume groups on the device can be made visible by calling L</"
1182 "guestfs_vgscan> followed by L</guestfs_vg_activate_all>. The logical volume"
1183 "(s) can now be mounted in the usual way."
1187 #: ../src/guestfs.pod:543
1189 "Use the reverse process to close a LUKS device. Unmount any logical volumes "
1190 "on it, deactivate the volume groups by caling C<guestfs_vg_activate (g, 0, "
1191 "[\"/dev/VG\"])>. Then close the mapper device by calling L</"
1192 "guestfs_luks_close> on the C</dev/mapper/mapname> device (I<not> the "
1193 "underlying encrypted block device)."
1197 #: ../src/guestfs.pod:550
1202 #: ../src/guestfs.pod:552
1204 "Libguestfs has APIs for inspecting an unknown disk image to find out if it "
1205 "contains operating systems, an install CD or a live CD. (These APIs used to "
1206 "be in a separate Perl-only library called L<Sys::Guestfs::Lib(3)> but since "
1207 "version 1.5.3 the most frequently used part of this library has been "
1208 "rewritten in C and moved into the core code)."
1212 #: ../src/guestfs.pod:559
1214 "Add all disks belonging to the unknown virtual machine and call L</"
1215 "guestfs_launch> in the usual way."
1219 #: ../src/guestfs.pod:562
1221 "Then call L</guestfs_inspect_os>. This function uses other libguestfs calls "
1222 "and certain heuristics, and returns a list of operating systems that were "
1223 "found. An empty list means none were found. A single element is the root "
1224 "filesystem of the operating system. For dual- or multi-boot guests, "
1225 "multiple roots can be returned, each one corresponding to a separate "
1226 "operating system. (Multi-boot virtual machines are extremely rare in the "
1227 "world of virtualization, but since this scenario can happen, we have built "
1228 "libguestfs to deal with it.)"
1232 #: ../src/guestfs.pod:571
1234 "For each root, you can then call various C<guestfs_inspect_get_*> functions "
1235 "to get additional details about that operating system. For example, call L</"
1236 "guestfs_inspect_get_type> to return the string C<windows> or C<linux> for "
1237 "Windows and Linux-based operating systems respectively."
1241 #: ../src/guestfs.pod:577
1243 "Un*x-like and Linux-based operating systems usually consist of several "
1244 "filesystems which are mounted at boot time (for example, a separate boot "
1245 "partition mounted on C</boot>). The inspection rules are able to detect how "
1246 "filesystems correspond to mount points. Call "
1247 "C<guestfs_inspect_get_mountpoints> to get this mapping. It might return a "
1248 "hash table like this example:"
1252 #: ../src/guestfs.pod:584
1255 " /boot => /dev/sda1\n"
1256 " / => /dev/vg_guest/lv_root\n"
1257 " /usr => /dev/vg_guest/lv_usr\n"
1262 #: ../src/guestfs.pod:588
1264 "The caller can then make calls to L</guestfs_mount_options> to mount the "
1265 "filesystems as suggested."
1269 #: ../src/guestfs.pod:591
1271 "Be careful to mount filesystems in the right order (eg. C</> before C</"
1272 "usr>). Sorting the keys of the hash by length, shortest first, should work."
1276 #: ../src/guestfs.pod:595
1278 "Inspection currently only works for some common operating systems. "
1279 "Contributors are welcome to send patches for other operating systems that we "
1280 "currently cannot detect."
1284 #: ../src/guestfs.pod:599
1286 "Encrypted disks must be opened before inspection. See L</ENCRYPTED DISKS> "
1287 "for more details. The L</guestfs_inspect_os> function just ignores any "
1288 "encrypted devices."
1292 #: ../src/guestfs.pod:603
1294 "A note on the implementation: The call L</guestfs_inspect_os> performs "
1295 "inspection and caches the results in the guest handle. Subsequent calls to "
1296 "C<guestfs_inspect_get_*> return this cached information, but I<do not> re-"
1297 "read the disks. If you change the content of the guest disks, you can redo "
1298 "inspection by calling L</guestfs_inspect_os> again. (L</"
1299 "guestfs_inspect_list_applications> works a little differently from the other "
1300 "calls and does read the disks. See documentation for that function for "
1305 #: ../src/guestfs.pod:612
1306 msgid "INSPECTING INSTALL DISKS"
1310 #: ../src/guestfs.pod:614
1312 "Libguestfs (since 1.9.4) can detect some install disks, install CDs, live "
1317 #: ../src/guestfs.pod:617
1319 "Call L</guestfs_inspect_get_format> to return the format of the operating "
1320 "system, which currently can be C<installed> (a regular operating system) or "
1321 "C<installer> (some sort of install disk)."
1325 #: ../src/guestfs.pod:621
1327 "Further information is available about the operating system that can be "
1328 "installed using the regular inspection APIs like L</"
1329 "guestfs_inspect_get_product_name>, L</guestfs_inspect_get_major_version> etc."
1333 #: ../src/guestfs.pod:626
1335 "Some additional information specific to installer disks is also available "
1336 "from the L</guestfs_inspect_is_live>, L</guestfs_inspect_is_netinst> and L</"
1337 "guestfs_inspect_is_multipart> calls."
1341 #: ../src/guestfs.pod:631
1342 msgid "SPECIAL CONSIDERATIONS FOR WINDOWS GUESTS"
1346 #: ../src/guestfs.pod:633
1348 "Libguestfs can mount NTFS partitions. It does this using the L<http://www."
1349 "ntfs-3g.org/> driver."
1353 #: ../src/guestfs.pod:636
1354 msgid "DRIVE LETTERS AND PATHS"
1358 #: ../src/guestfs.pod:638
1360 "DOS and Windows still use drive letters, and the filesystems are always "
1361 "treated as case insensitive by Windows itself, and therefore you might find "
1362 "a Windows configuration file referring to a path like C<c:\\windows"
1363 "\\system32>. When the filesystem is mounted in libguestfs, that directory "
1364 "might be referred to as C</WINDOWS/System32>."
1368 #: ../src/guestfs.pod:644
1370 "Drive letter mappings can be found using inspection (see L</INSPECTION> and "
1371 "L</guestfs_inspect_get_drive_mappings>)"
1375 #: ../src/guestfs.pod:647
1377 "Dealing with separator characters (backslash vs forward slash) is outside "
1378 "the scope of libguestfs, but usually a simple character replacement will "
1383 #: ../src/guestfs.pod:651
1385 "To resolve the case insensitivity of paths, call L</"
1386 "guestfs_case_sensitive_path>."
1390 #: ../src/guestfs.pod:654
1391 msgid "ACCESSING THE WINDOWS REGISTRY"
1395 #: ../src/guestfs.pod:656
1397 "Libguestfs also provides some help for decoding Windows Registry \"hive\" "
1398 "files, through the library C<hivex> which is part of the libguestfs project "
1399 "although ships as a separate tarball. You have to locate and download the "
1400 "hive file(s) yourself, and then pass them to C<hivex> functions. See also "
1401 "the programs L<hivexml(1)>, L<hivexsh(1)>, L<hivexregedit(1)> and L<virt-win-"
1402 "reg(1)> for more help on this issue."
1406 #: ../src/guestfs.pod:664
1407 msgid "SYMLINKS ON NTFS-3G FILESYSTEMS"
1411 #: ../src/guestfs.pod:666
1413 "Ntfs-3g tries to rewrite \"Junction Points\" and NTFS \"symbolic links\" to "
1414 "provide something which looks like a Linux symlink. The way it tries to do "
1415 "the rewriting is described here:"
1419 #: ../src/guestfs.pod:670
1421 "L<http://www.tuxera.com/community/ntfs-3g-advanced/junction-points-and-"
1424 "L<http://www.tuxera.com/community/ntfs-3g-advanced/junction-points-and-"
1428 #: ../src/guestfs.pod:672
1430 "The essential problem is that ntfs-3g simply does not have enough "
1431 "information to do a correct job. NTFS links can contain drive letters and "
1432 "references to external device GUIDs that ntfs-3g has no way of resolving. "
1433 "It is almost certainly the case that libguestfs callers should ignore what "
1434 "ntfs-3g does (ie. don't use L</guestfs_readlink> on NTFS volumes)."
1438 #: ../src/guestfs.pod:679
1440 "Instead if you encounter a symbolic link on an ntfs-3g filesystem, use L</"
1441 "guestfs_lgetxattr> to read the C<system.ntfs_reparse_data> extended "
1442 "attribute, and read the raw reparse data from that (you can find the format "
1443 "documented in various places around the web)."
1447 #: ../src/guestfs.pod:684
1448 msgid "EXTENDED ATTRIBUTES ON NTFS-3G FILESYSTEMS"
1452 #: ../src/guestfs.pod:686
1454 "There are other useful extended attributes that can be read from ntfs-3g "
1455 "filesystems (using L</guestfs_getxattr>). See:"
1459 #: ../src/guestfs.pod:689
1461 "L<http://www.tuxera.com/community/ntfs-3g-advanced/extended-attributes/>"
1463 "L<http://www.tuxera.com/community/ntfs-3g-advanced/extended-attributes/>"
1466 #: ../src/guestfs.pod:691
1467 msgid "USING LIBGUESTFS WITH OTHER PROGRAMMING LANGUAGES"
1471 #: ../src/guestfs.pod:693
1473 "Although we don't want to discourage you from using the C API, we will "
1474 "mention here that the same API is also available in other languages."
1478 #: ../src/guestfs.pod:696
1480 "The API is broadly identical in all supported languages. This means that "
1481 "the C call C<guestfs_add_drive_ro(g,file)> is C<$g-E<gt>add_drive_ro($file)> "
1482 "in Perl, C<g.add_drive_ro(file)> in Python, and C<g#add_drive_ro file> in "
1483 "OCaml. In other words, a straightforward, predictable isomorphism between "
1488 #: ../src/guestfs.pod:702
1490 "Error messages are automatically transformed into exceptions if the language "
1495 #: ../src/guestfs.pod:705
1497 "We don't try to \"object orientify\" parts of the API in OO languages, "
1498 "although contributors are welcome to write higher level APIs above what we "
1499 "provide in their favourite languages if they wish."
1503 #: ../src/guestfs.pod:711
1508 #: ../src/guestfs.pod:713
1510 "You can use the I<guestfs.h> header file from C++ programs. The C++ API is "
1511 "identical to the C API. C++ classes and exceptions are not used."
1515 #: ../src/guestfs.pod:717
1520 #: ../src/guestfs.pod:719
1522 "The C# bindings are highly experimental. Please read the warnings at the "
1523 "top of C<csharp/Libguestfs.cs>."
1527 #: ../src/guestfs.pod:722
1532 #: ../src/guestfs.pod:724
1534 "This is the only language binding that is working but incomplete. Only "
1535 "calls which return simple integers have been bound in Haskell, and we are "
1536 "looking for help to complete this binding."
1540 #: ../src/guestfs.pod:728
1545 #: ../src/guestfs.pod:730
1547 "Full documentation is contained in the Javadoc which is distributed with "
1552 #: ../src/guestfs.pod:733
1557 #: ../src/guestfs.pod:735
1558 msgid "See L<guestfs-ocaml(3)>."
1559 msgstr "Див. L<guestfs-ocaml(3)>."
1562 #: ../src/guestfs.pod:737
1567 #: ../src/guestfs.pod:739
1568 msgid "See L<guestfs-perl(3)> and L<Sys::Guestfs(3)>."
1569 msgstr "Див. L<guestfs-perl(3)> та L<Sys::Guestfs(3)>."
1572 #: ../src/guestfs.pod:741
1577 #: ../src/guestfs.pod:743
1579 "For documentation see C<README-PHP> supplied with libguestfs sources or in "
1580 "the php-libguestfs package for your distribution."
1584 #: ../src/guestfs.pod:746
1585 msgid "The PHP binding only works correctly on 64 bit machines."
1589 #: ../src/guestfs.pod:748
1594 #: ../src/guestfs.pod:750
1595 msgid "See L<guestfs-python(3)>."
1596 msgstr "Див. L<guestfs-python(3)>."
1599 #: ../src/guestfs.pod:752
1604 #: ../src/guestfs.pod:754
1605 msgid "See L<guestfs-ruby(3)>."
1606 msgstr "Див. L<guestfs-ruby(3)>."
1609 #: ../src/guestfs.pod:756
1610 msgid "B<shell scripts>"
1611 msgstr "B<скрипти оболонки>"
1614 #: ../src/guestfs.pod:758
1615 msgid "See L<guestfish(1)>."
1616 msgstr "Див. L<guestfish(1)>."
1619 #: ../src/guestfs.pod:762
1620 msgid "LIBGUESTFS GOTCHAS"
1624 #: ../src/guestfs.pod:764
1626 "L<http://en.wikipedia.org/wiki/Gotcha_(programming)>: \"A feature of a "
1627 "system [...] that works in the way it is documented but is counterintuitive "
1628 "and almost invites mistakes.\""
1632 #: ../src/guestfs.pod:768
1634 "Since we developed libguestfs and the associated tools, there are several "
1635 "things we would have designed differently, but are now stuck with for "
1636 "backwards compatibility or other reasons. If there is ever a libguestfs 2.0 "
1637 "release, you can expect these to change. Beware of them."
1641 #: ../src/guestfs.pod:776
1642 msgid "Autosync / forgetting to sync."
1646 #: ../src/guestfs.pod:778
1648 "I<Update:> Autosync is enabled by default for all API users starting from "
1649 "libguestfs 1.5.24. This section only applies to older versions."
1653 #: ../src/guestfs.pod:781
1655 "When modifying a filesystem from C or another language, you B<must> unmount "
1656 "all filesystems and call L</guestfs_sync> explicitly before you close the "
1657 "libguestfs handle. You can also call:"
1661 #: ../src/guestfs.pod:785
1664 " guestfs_set_autosync (g, 1);\n"
1669 #: ../src/guestfs.pod:787
1671 "to have the unmount/sync done automatically for you when the handle 'g' is "
1672 "closed. (This feature is called \"autosync\", L</guestfs_set_autosync> q.v.)"
1676 #: ../src/guestfs.pod:791
1678 "If you forget to do this, then it is entirely possible that your changes "
1679 "won't be written out, or will be partially written, or (very rarely) that "
1680 "you'll get disk corruption."
1684 #: ../src/guestfs.pod:795
1686 "Note that in L<guestfish(3)> autosync is the default. So quick and dirty "
1687 "guestfish scripts that forget to sync will work just fine, which can make "
1688 "this very puzzling if you are trying to debug a problem."
1692 #: ../src/guestfs.pod:799
1693 msgid "Mount option C<-o sync> should not be the default."
1697 #: ../src/guestfs.pod:801
1699 "If you use L</guestfs_mount>, then C<-o sync,noatime> are added implicitly. "
1700 "However C<-o sync> does not add any reliability benefit, but does have a "
1701 "very large performance impact."
1705 #: ../src/guestfs.pod:805
1707 "The work around is to use L</guestfs_mount_options> and set the mount "
1708 "options that you actually want to use."
1712 #: ../src/guestfs.pod:808
1713 msgid "Read-only should be the default."
1717 #: ../src/guestfs.pod:810
1719 "In L<guestfish(3)>, I<--ro> should be the default, and you should have to "
1720 "specify I<--rw> if you want to make changes to the image."
1724 #: ../src/guestfs.pod:813
1725 msgid "This would reduce the potential to corrupt live VM images."
1729 #: ../src/guestfs.pod:815
1731 "Note that many filesystems change the disk when you just mount and unmount, "
1732 "even if you didn't perform any writes. You need to use L</"
1733 "guestfs_add_drive_ro> to guarantee that the disk is not changed."
1737 #: ../src/guestfs.pod:819
1738 msgid "guestfish command line is hard to use."
1742 #: ../src/guestfs.pod:821
1744 "C<guestfish disk.img> doesn't do what people expect (open C<disk.img> for "
1745 "examination). It tries to run a guestfish command C<disk.img> which doesn't "
1746 "exist, so it fails. In earlier versions of guestfish the error message was "
1747 "also unintuitive, but we have corrected this since. Like the Bourne shell, "
1748 "we should have used C<guestfish -c command> to run commands."
1752 #: ../src/guestfs.pod:828
1753 msgid "guestfish megabyte modifiers don't work right on all commands"
1757 #: ../src/guestfs.pod:830
1759 "In recent guestfish you can use C<1M> to mean 1 megabyte (and similarly for "
1760 "other modifiers). What guestfish actually does is to multiply the number "
1761 "part by the modifier part and pass the result to the C API. However this "
1762 "doesn't work for a few APIs which aren't expecting bytes, but are already "
1763 "expecting some other unit (eg. megabytes)."
1767 #: ../src/guestfs.pod:837
1768 msgid "The most common is L</guestfs_lvcreate>. The guestfish command:"
1772 #: ../src/guestfs.pod:839
1775 " lvcreate LV VG 100M\n"
1780 #: ../src/guestfs.pod:841
1782 "does not do what you might expect. Instead because L</guestfs_lvcreate> is "
1783 "already expecting megabytes, this tries to create a 100 I<terabyte> (100 "
1784 "megabytes * megabytes) logical volume. The error message you get from this "
1785 "is also a little obscure."
1789 #: ../src/guestfs.pod:846
1791 "This could be fixed in the generator by specially marking parameters and "
1792 "return values which take bytes or other units."
1796 #: ../src/guestfs.pod:849
1797 msgid "Ambiguity between devices and paths"
1801 #: ../src/guestfs.pod:851
1803 "There is a subtle ambiguity in the API between a device name (eg. C</dev/"
1804 "sdb2>) and a similar pathname. A file might just happen to be called "
1805 "C<sdb2> in the directory C</dev> (consider some non-Unix VM image)."
1809 #: ../src/guestfs.pod:856
1811 "In the current API we usually resolve this ambiguity by having two separate "
1812 "calls, for example L</guestfs_checksum> and L</guestfs_checksum_device>. "
1813 "Some API calls are ambiguous and (incorrectly) resolve the problem by "
1814 "detecting if the path supplied begins with C</dev/>."
1818 #: ../src/guestfs.pod:862
1820 "To avoid both the ambiguity and the need to duplicate some calls, we could "
1821 "make paths/devices into structured names. One way to do this would be to "
1822 "use a notation like grub (C<hd(0,0)>), although nobody really likes this "
1823 "aspect of grub. Another way would be to use a structured type, equivalent "
1824 "to this OCaml type:"
1828 #: ../src/guestfs.pod:868
1831 " type path = Path of string | Device of int | Partition of int * int\n"
1836 #: ../src/guestfs.pod:870
1837 msgid "which would allow you to pass arguments like:"
1841 #: ../src/guestfs.pod:872
1844 " Path \"/foo/bar\"\n"
1845 " Device 1 (* /dev/sdb, or perhaps /dev/sda *)\n"
1846 " Partition (1, 2) (* /dev/sdb2 (or is it /dev/sda2 or /dev/sdb3?) *)\n"
1847 " Path \"/dev/sdb2\" (* not a device *)\n"
1852 #: ../src/guestfs.pod:877
1854 "As you can see there are still problems to resolve even with this "
1855 "representation. Also consider how it might work in guestfish."
1859 #: ../src/guestfs.pod:882
1860 msgid "KEYS AND PASSPHRASES"
1864 #: ../src/guestfs.pod:884
1866 "Certain libguestfs calls take a parameter that contains sensitive key "
1867 "material, passed in as a C string."
1871 #: ../src/guestfs.pod:887
1873 "In the future we would hope to change the libguestfs implementation so that "
1874 "keys are L<mlock(2)>-ed into physical RAM, and thus can never end up in "
1875 "swap. However this is I<not> done at the moment, because of the complexity "
1876 "of such an implementation."
1880 #: ../src/guestfs.pod:892
1882 "Therefore you should be aware that any key parameter you pass to libguestfs "
1883 "might end up being written out to the swap partition. If this is a concern, "
1884 "scrub the swap partition or don't use libguestfs on encrypted devices."
1888 #: ../src/guestfs.pod:897
1889 msgid "MULTIPLE HANDLES AND MULTIPLE THREADS"
1893 #: ../src/guestfs.pod:899
1895 "All high-level libguestfs actions are synchronous. If you want to use "
1896 "libguestfs asynchronously then you must create a thread."
1900 #: ../src/guestfs.pod:902
1902 "Only use the handle from a single thread. Either use the handle exclusively "
1903 "from one thread, or provide your own mutex so that two threads cannot issue "
1904 "calls on the same handle at the same time."
1908 #: ../src/guestfs.pod:906
1910 "See the graphical program guestfs-browser for one possible architecture for "
1911 "multithreaded programs using libvirt and libguestfs."
1915 #: ../src/guestfs.pod:909
1920 #: ../src/guestfs.pod:911
1922 "Libguestfs needs a supermin appliance, which it finds by looking along an "
1927 #: ../src/guestfs.pod:914
1929 "By default it looks for these in the directory C<$libdir/guestfs> (eg. C</"
1930 "usr/local/lib/guestfs> or C</usr/lib64/guestfs>)."
1934 #: ../src/guestfs.pod:917
1936 "Use L</guestfs_set_path> or set the environment variable L</LIBGUESTFS_PATH> "
1937 "to change the directories that libguestfs will search in. The value is a "
1938 "colon-separated list of paths. The current directory is I<not> searched "
1939 "unless the path contains an empty element or C<.>. For example "
1940 "C<LIBGUESTFS_PATH=:/usr/lib/guestfs> would search the current directory and "
1941 "then C</usr/lib/guestfs>."
1945 #: ../src/guestfs.pod:924
1946 msgid "QEMU WRAPPERS"
1950 #: ../src/guestfs.pod:926
1952 "If you want to compile your own qemu, run qemu from a non-standard location, "
1953 "or pass extra arguments to qemu, then you can write a shell-script wrapper "
1958 #: ../src/guestfs.pod:930
1960 "There is one important rule to remember: you I<must C<exec qemu>> as the "
1961 "last command in the shell script (so that qemu replaces the shell and "
1962 "becomes the direct child of the libguestfs-using program). If you don't do "
1963 "this, then the qemu process won't be cleaned up correctly."
1967 #: ../src/guestfs.pod:935
1969 "Here is an example of a wrapper, where I have built my own copy of qemu from "
1974 #: ../src/guestfs.pod:938
1978 " qemudir=/home/rjones/d/qemu\n"
1979 " exec $qemudir/x86_64-softmmu/qemu-system-x86_64 -L $qemudir/pc-bios \"$@\"\n"
1984 #: ../src/guestfs.pod:942
1986 "Save this script as C</tmp/qemu.wrapper> (or wherever), C<chmod +x>, and "
1987 "then use it by setting the LIBGUESTFS_QEMU environment variable. For "
1992 #: ../src/guestfs.pod:946
1995 " LIBGUESTFS_QEMU=/tmp/qemu.wrapper guestfish\n"
2000 #: ../src/guestfs.pod:948
2002 "Note that libguestfs also calls qemu with the -help and -version options in "
2003 "order to determine features."
2007 #: ../src/guestfs.pod:951
2008 msgid "ATTACHING TO RUNNING DAEMONS"
2012 #: ../src/guestfs.pod:953
2014 "I<Note (1):> This is B<highly experimental> and has a tendency to eat "
2015 "babies. Use with caution."
2019 #: ../src/guestfs.pod:956
2021 "I<Note (2):> This section explains how to attach to a running daemon from a "
2022 "low level perspective. For most users, simply using virt tools such as "
2023 "L<guestfish(1)> with the I<--live> option will \"just work\"."
2027 #: ../src/guestfs.pod:960
2028 msgid "Using guestfs_set_attach_method"
2032 #: ../src/guestfs.pod:962
2034 "By calling L</guestfs_set_attach_method> you can change how the library "
2035 "connects to the C<guestfsd> daemon in L</guestfs_launch> (read L</"
2036 "ARCHITECTURE> for some background)."
2040 #: ../src/guestfs.pod:966
2042 "The normal attach method is C<appliance>, where a small appliance is created "
2043 "containing the daemon, and then the library connects to this."
2047 #: ../src/guestfs.pod:969
2049 "Setting attach method to C<unix:I<path>> (where I<path> is the path of a "
2050 "Unix domain socket) causes L</guestfs_launch> to connect to an existing "
2051 "daemon over the Unix domain socket."
2055 #: ../src/guestfs.pod:973
2057 "The normal use for this is to connect to a running virtual machine that "
2058 "contains a C<guestfsd> daemon, and send commands so you can read and write "
2059 "files inside the live virtual machine."
2063 #: ../src/guestfs.pod:977
2064 msgid "Using guestfs_add_domain with live flag"
2068 #: ../src/guestfs.pod:979
2070 "L</guestfs_add_domain> provides some help for getting the correct attach "
2071 "method. If you pass the C<live> option to this function, then (if the "
2072 "virtual machine is running) it will examine the libvirt XML looking for a "
2073 "virtio-serial channel to connect to:"
2077 #: ../src/guestfs.pod:985
2084 " <channel type='unix'>\n"
2085 " <source mode='bind' path='/path/to/socket'/>\n"
2086 " <target type='virtio' name='org.libguestfs.channel.0'/>\n"
2095 #: ../src/guestfs.pod:997
2097 "L</guestfs_add_domain> extracts C</path/to/socket> and sets the attach "
2098 "method to C<unix:/path/to/socket>."
2102 #: ../src/guestfs.pod:1000
2104 "Some of the libguestfs tools (including guestfish) support a I<--live> "
2105 "option which is passed through to L</guestfs_add_domain> thus allowing you "
2106 "to attach to and modify live virtual machines."
2110 #: ../src/guestfs.pod:1004
2112 "The virtual machine needs to have been set up beforehand so that it has the "
2113 "virtio-serial channel and so that guestfsd is running inside it."
2117 #: ../src/guestfs.pod:1008
2118 msgid "ABI GUARANTEE"
2122 #: ../src/guestfs.pod:1010
2124 "We guarantee the libguestfs ABI (binary interface), for public, high-level "
2125 "actions as outlined in this section. Although we will deprecate some "
2126 "actions, for example if they get replaced by newer calls, we will keep the "
2127 "old actions forever. This allows you the developer to program in confidence "
2128 "against the libguestfs API."
2132 #: ../src/guestfs.pod:1016
2133 msgid "BLOCK DEVICE NAMING"
2137 #: ../src/guestfs.pod:1018
2139 "In the kernel there is now quite a profusion of schemata for naming block "
2140 "devices (in this context, by I<block device> I mean a physical or virtual "
2141 "hard drive). The original Linux IDE driver used names starting with C</dev/"
2142 "hd*>. SCSI devices have historically used a different naming scheme, C</dev/"
2143 "sd*>. When the Linux kernel I<libata> driver became a popular replacement "
2144 "for the old IDE driver (particularly for SATA devices) those devices also "
2145 "used the C</dev/sd*> scheme. Additionally we now have virtual machines with "
2146 "paravirtualized drivers. This has created several different naming systems, "
2147 "such as C</dev/vd*> for virtio disks and C</dev/xvd*> for Xen PV disks."
2151 #: ../src/guestfs.pod:1030
2153 "As discussed above, libguestfs uses a qemu appliance running an embedded "
2154 "Linux kernel to access block devices. We can run a variety of appliances "
2155 "based on a variety of Linux kernels."
2159 #: ../src/guestfs.pod:1034
2161 "This causes a problem for libguestfs because many API calls use device or "
2162 "partition names. Working scripts and the recipe (example) scripts that we "
2163 "make available over the internet could fail if the naming scheme changes."
2167 #: ../src/guestfs.pod:1039
2169 "Therefore libguestfs defines C</dev/sd*> as the I<standard naming scheme>. "
2170 "Internally C</dev/sd*> names are translated, if necessary, to other names as "
2171 "required. For example, under RHEL 5 which uses the C</dev/hd*> scheme, any "
2172 "device parameter C</dev/sda2> is translated to C</dev/hda2> transparently."
2176 #: ../src/guestfs.pod:1045
2178 "Note that this I<only> applies to parameters. The L</guestfs_list_devices>, "
2179 "L</guestfs_list_partitions> and similar calls return the true names of the "
2180 "devices and partitions as known to the appliance."
2184 #: ../src/guestfs.pod:1050
2185 msgid "ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION"
2189 #: ../src/guestfs.pod:1052
2191 "Usually this translation is transparent. However in some (very rare) cases "
2192 "you may need to know the exact algorithm. Such cases include where you use "
2193 "L</guestfs_config> to add a mixture of virtio and IDE devices to the qemu-"
2194 "based appliance, so have a mixture of C</dev/sd*> and C</dev/vd*> devices."
2198 #: ../src/guestfs.pod:1058
2200 "The algorithm is applied only to I<parameters> which are known to be either "
2201 "device or partition names. Return values from functions such as L</"
2202 "guestfs_list_devices> are never changed."
2206 #: ../src/guestfs.pod:1066
2207 msgid "Is the string a parameter which is a device or partition name?"
2211 #: ../src/guestfs.pod:1070
2212 msgid "Does the string begin with C</dev/sd>?"
2216 #: ../src/guestfs.pod:1074
2218 "Does the named device exist? If so, we use that device. However if I<not> "
2219 "then we continue with this algorithm."
2223 #: ../src/guestfs.pod:1079
2224 msgid "Replace initial C</dev/sd> string with C</dev/hd>."
2228 #: ../src/guestfs.pod:1081
2229 msgid "For example, change C</dev/sda2> to C</dev/hda2>."
2233 #: ../src/guestfs.pod:1083
2234 msgid "If that named device exists, use it. If not, continue."
2238 #: ../src/guestfs.pod:1087
2239 msgid "Replace initial C</dev/sd> string with C</dev/vd>."
2243 #: ../src/guestfs.pod:1089
2244 msgid "If that named device exists, use it. If not, return an error."
2248 #: ../src/guestfs.pod:1093
2249 msgid "PORTABILITY CONCERNS WITH BLOCK DEVICE NAMING"
2253 #: ../src/guestfs.pod:1095
2255 "Although the standard naming scheme and automatic translation is useful for "
2256 "simple programs and guestfish scripts, for larger programs it is best not to "
2257 "rely on this mechanism."
2261 #: ../src/guestfs.pod:1099
2263 "Where possible for maximum future portability programs using libguestfs "
2264 "should use these future-proof techniques:"
2268 #: ../src/guestfs.pod:1106
2270 "Use L</guestfs_list_devices> or L</guestfs_list_partitions> to list actual "
2271 "device names, and then use those names directly."
2275 #: ../src/guestfs.pod:1109
2277 "Since those device names exist by definition, they will never be translated."
2281 #: ../src/guestfs.pod:1114
2283 "Use higher level ways to identify filesystems, such as LVM names, UUIDs and "
2284 "filesystem labels."
2288 #: ../src/guestfs.pod:1119
2293 #: ../src/guestfs.pod:1121
2295 "This section discusses security implications of using libguestfs, "
2296 "particularly with untrusted or malicious guests or disk images."
2300 #: ../src/guestfs.pod:1124
2301 msgid "GENERAL SECURITY CONSIDERATIONS"
2305 #: ../src/guestfs.pod:1126
2307 "Be careful with any files or data that you download from a guest (by "
2308 "\"download\" we mean not just the L</guestfs_download> command but any "
2309 "command that reads files, filenames, directories or anything else from a "
2310 "disk image). An attacker could manipulate the data to fool your program "
2311 "into doing the wrong thing. Consider cases such as:"
2315 #: ../src/guestfs.pod:1136
2316 msgid "the data (file etc) not being present"
2320 #: ../src/guestfs.pod:1140
2321 msgid "being present but empty"
2325 #: ../src/guestfs.pod:1144
2326 msgid "being much larger than normal"
2330 #: ../src/guestfs.pod:1148
2331 msgid "containing arbitrary 8 bit data"
2335 #: ../src/guestfs.pod:1152
2336 msgid "being in an unexpected character encoding"
2340 #: ../src/guestfs.pod:1156
2341 msgid "containing homoglyphs."
2345 #: ../src/guestfs.pod:1160
2346 msgid "SECURITY OF MOUNTING FILESYSTEMS"
2350 #: ../src/guestfs.pod:1162
2352 "When you mount a filesystem under Linux, mistakes in the kernel filesystem "
2353 "(VFS) module can sometimes be escalated into exploits by deliberately "
2354 "creating a malicious, malformed filesystem. These exploits are very severe "
2355 "for two reasons. Firstly there are very many filesystem drivers in the "
2356 "kernel, and many of them are infrequently used and not much developer "
2357 "attention has been paid to the code. Linux userspace helps potential "
2358 "crackers by detecting the filesystem type and automatically choosing the "
2359 "right VFS driver, even if that filesystem type is obscure or unexpected for "
2360 "the administrator. Secondly, a kernel-level exploit is like a local root "
2361 "exploit (worse in some ways), giving immediate and total access to the "
2362 "system right down to the hardware level."
2366 #: ../src/guestfs.pod:1175
2368 "That explains why you should never mount a filesystem from an untrusted "
2369 "guest on your host kernel. How about libguestfs? We run a Linux kernel "
2370 "inside a qemu virtual machine, usually running as a non-root user. The "
2371 "attacker would need to write a filesystem which first exploited the kernel, "
2372 "and then exploited either qemu virtualization (eg. a faulty qemu driver) or "
2373 "the libguestfs protocol, and finally to be as serious as the host kernel "
2374 "exploit it would need to escalate its privileges to root. This multi-step "
2375 "escalation, performed by a static piece of data, is thought to be extremely "
2376 "hard to do, although we never say 'never' about security issues."
2380 #: ../src/guestfs.pod:1186
2382 "In any case callers can reduce the attack surface by forcing the filesystem "
2383 "type when mounting (use L</guestfs_mount_vfs>)."
2387 #: ../src/guestfs.pod:1189
2388 msgid "PROTOCOL SECURITY"
2392 #: ../src/guestfs.pod:1191
2394 "The protocol is designed to be secure, being based on RFC 4506 (XDR) with a "
2395 "defined upper message size. However a program that uses libguestfs must "
2396 "also take care - for example you can write a program that downloads a binary "
2397 "from a disk image and executes it locally, and no amount of protocol "
2398 "security will save you from the consequences."
2402 #: ../src/guestfs.pod:1197
2403 msgid "INSPECTION SECURITY"
2407 #: ../src/guestfs.pod:1199
2409 "Parts of the inspection API (see L</INSPECTION>) return untrusted strings "
2410 "directly from the guest, and these could contain any 8 bit data. Callers "
2411 "should be careful to escape these before printing them to a structured file "
2412 "(for example, use HTML escaping if creating a web page)."
2416 #: ../src/guestfs.pod:1205
2418 "Guest configuration may be altered in unusual ways by the administrator of "
2419 "the virtual machine, and may not reflect reality (particularly for untrusted "
2420 "or actively malicious guests). For example we parse the hostname from "
2421 "configuration files like C</etc/sysconfig/network> that we find in the "
2422 "guest, but the guest administrator can easily manipulate these files to "
2423 "provide the wrong hostname."
2427 #: ../src/guestfs.pod:1213
2429 "The inspection API parses guest configuration using two external libraries: "
2430 "Augeas (Linux configuration) and hivex (Windows Registry). Both are "
2431 "designed to be robust in the face of malicious data, although denial of "
2432 "service attacks are still possible, for example with oversized configuration "
2437 #: ../src/guestfs.pod:1219
2438 msgid "RUNNING UNTRUSTED GUEST COMMANDS"
2442 #: ../src/guestfs.pod:1221
2444 "Be very cautious about running commands from the guest. By running a "
2445 "command in the guest, you are giving CPU time to a binary that you do not "
2446 "control, under the same user account as the library, albeit wrapped in qemu "
2447 "virtualization. More information and alternatives can be found in the "
2448 "section L</RUNNING COMMANDS>."
2452 #: ../src/guestfs.pod:1227
2453 msgid "CVE-2010-3851"
2454 msgstr "CVE-2010-3851"
2457 #: ../src/guestfs.pod:1229
2458 msgid "https://bugzilla.redhat.com/642934"
2459 msgstr "https://bugzilla.redhat.com/642934"
2462 #: ../src/guestfs.pod:1231
2464 "This security bug concerns the automatic disk format detection that qemu "
2465 "does on disk images."
2469 #: ../src/guestfs.pod:1234
2471 "A raw disk image is just the raw bytes, there is no header. Other disk "
2472 "images like qcow2 contain a special header. Qemu deals with this by looking "
2473 "for one of the known headers, and if none is found then assuming the disk "
2474 "image must be raw."
2478 #: ../src/guestfs.pod:1239
2480 "This allows a guest which has been given a raw disk image to write some "
2481 "other header. At next boot (or when the disk image is accessed by "
2482 "libguestfs) qemu would do autodetection and think the disk image format was, "
2483 "say, qcow2 based on the header written by the guest."
2487 #: ../src/guestfs.pod:1244
2489 "This in itself would not be a problem, but qcow2 offers many features, one "
2490 "of which is to allow a disk image to refer to another image (called the "
2491 "\"backing disk\"). It does this by placing the path to the backing disk "
2492 "into the qcow2 header. This path is not validated and could point to any "
2493 "host file (eg. \"/etc/passwd\"). The backing disk is then exposed through "
2494 "\"holes\" in the qcow2 disk image, which of course is completely under the "
2495 "control of the attacker."
2499 #: ../src/guestfs.pod:1252
2501 "In libguestfs this is rather hard to exploit except under two circumstances:"
2505 #: ../src/guestfs.pod:1259
2506 msgid "You have enabled the network or have opened the disk in write mode."
2510 #: ../src/guestfs.pod:1263
2512 "You are also running untrusted code from the guest (see L</RUNNING "
2517 #: ../src/guestfs.pod:1268
2519 "The way to avoid this is to specify the expected disk format when adding "
2520 "disks (the optional C<format> option to L</guestfs_add_drive_opts>). You "
2521 "should always do this if the disk is raw format, and it's a good idea for "
2526 #: ../src/guestfs.pod:1273
2528 "For disks added from libvirt using calls like L</guestfs_add_domain>, the "
2529 "format is fetched from libvirt and passed through."
2533 #: ../src/guestfs.pod:1276
2535 "For libguestfs tools, use the I<--format> command line parameter as "
2540 #: ../src/guestfs.pod:1279
2541 msgid "CONNECTION MANAGEMENT"
2545 #: ../src/guestfs.pod:1281
2550 #: ../src/guestfs.pod:1283
2552 "C<guestfs_h> is the opaque type representing a connection handle. Create a "
2553 "handle by calling L</guestfs_create>. Call L</guestfs_close> to free the "
2554 "handle and release all resources used."
2558 #: ../src/guestfs.pod:1287
2560 "For information on using multiple handles and threads, see the section L</"
2561 "MULTIPLE HANDLES AND MULTIPLE THREADS> above."
2565 #: ../src/guestfs.pod:1290
2566 msgid "guestfs_create"
2570 #: ../src/guestfs.pod:1292
2573 " guestfs_h *guestfs_create (void);\n"
2578 #: ../src/guestfs.pod:1294
2579 msgid "Create a connection handle."
2583 #: ../src/guestfs.pod:1296
2585 "On success this returns a non-NULL pointer to a handle. On error it returns "
2590 #: ../src/guestfs.pod:1299
2592 "You have to \"configure\" the handle after creating it. This includes "
2593 "calling L</guestfs_add_drive_opts> (or one of the equivalent calls) on the "
2594 "handle at least once."
2598 #: ../src/guestfs.pod:1303
2599 msgid "After configuring the handle, you have to call L</guestfs_launch>."
2603 #: ../src/guestfs.pod:1305
2605 "You may also want to configure error handling for the handle. See the L</"
2606 "ERROR HANDLING> section below."
2610 #: ../src/guestfs.pod:1308
2611 msgid "guestfs_close"
2615 #: ../src/guestfs.pod:1310
2618 " void guestfs_close (guestfs_h *g);\n"
2623 #: ../src/guestfs.pod:1312
2624 msgid "This closes the connection handle and frees up all resources used."
2628 #: ../src/guestfs.pod:1314
2630 "If autosync was set on the handle and the handle was launched, then this "
2631 "implicitly calls various functions to unmount filesystems and sync the "
2632 "disk. See L</guestfs_set_autosync> for more details."
2636 #: ../src/guestfs.pod:1318
2637 msgid "If a close callback was set on the handle, then it is called."
2641 #: ../src/guestfs.pod:1320
2642 msgid "ERROR HANDLING"
2643 msgstr "ОБРОБКА ПОМИЛОК"
2646 #: ../src/guestfs.pod:1322
2648 "API functions can return errors. For example, almost all functions that "
2649 "return C<int> will return C<-1> to indicate an error."
2653 #: ../src/guestfs.pod:1325
2655 "Additional information is available for errors: an error message string and "
2656 "optionally an error number (errno) if the thing that failed was a system "
2661 #: ../src/guestfs.pod:1329
2663 "You can get at the additional information about the last error on the handle "
2664 "by calling L</guestfs_last_error>, L</guestfs_last_errno>, and/or by setting "
2665 "up an error handler with L</guestfs_set_error_handler>."
2669 #: ../src/guestfs.pod:1334
2671 "When the handle is created, a default error handler is installed which "
2672 "prints the error message string to C<stderr>. For small short-running "
2673 "command line programs it is sufficient to do:"
2677 #: ../src/guestfs.pod:1338
2680 " if (guestfs_launch (g) == -1)\n"
2681 " exit (EXIT_FAILURE);\n"
2686 #: ../src/guestfs.pod:1341
2688 "since the default error handler will ensure that an error message has been "
2689 "printed to C<stderr> before the program exits."
2693 #: ../src/guestfs.pod:1344
2695 "For other programs the caller will almost certainly want to install an "
2696 "alternate error handler or do error handling in-line like this:"
2700 #: ../src/guestfs.pod:1347
2703 " g = guestfs_create ();\n"
2708 #: ../src/guestfs.pod:1349
2711 " /* This disables the default behaviour of printing errors\n"
2713 " guestfs_set_error_handler (g, NULL, NULL);\n"
2718 #: ../src/guestfs.pod:1353
2721 " if (guestfs_launch (g) == -1) {\n"
2722 " /* Examine the error message and print it etc. */\n"
2723 " char *msg = guestfs_last_error (g);\n"
2724 " int errnum = guestfs_last_errno (g);\n"
2725 " fprintf (stderr, \"%s\\n\", msg);\n"
2732 #: ../src/guestfs.pod:1361
2734 "Out of memory errors are handled differently. The default action is to call "
2735 "L<abort(3)>. If this is undesirable, then you can set a handler using L</"
2736 "guestfs_set_out_of_memory_handler>."
2740 #: ../src/guestfs.pod:1365
2742 "L</guestfs_create> returns C<NULL> if the handle cannot be created, and "
2743 "because there is no handle if this happens there is no way to get additional "
2744 "error information. However L</guestfs_create> is supposed to be a "
2745 "lightweight operation which can only fail because of insufficient memory (it "
2746 "returns NULL in this case)."
2750 #: ../src/guestfs.pod:1371
2751 msgid "guestfs_last_error"
2755 #: ../src/guestfs.pod:1373
2758 " const char *guestfs_last_error (guestfs_h *g);\n"
2763 #: ../src/guestfs.pod:1375
2765 "This returns the last error message that happened on C<g>. If there has not "
2766 "been an error since the handle was created, then this returns C<NULL>."
2770 #: ../src/guestfs.pod:1379
2772 "The lifetime of the returned string is until the next error occurs, or L</"
2773 "guestfs_close> is called."
2777 #: ../src/guestfs.pod:1382
2778 msgid "guestfs_last_errno"
2782 #: ../src/guestfs.pod:1384
2785 " int guestfs_last_errno (guestfs_h *g);\n"
2790 #: ../src/guestfs.pod:1386
2791 msgid "This returns the last error number (errno) that happened on C<g>."
2795 #: ../src/guestfs.pod:1388
2796 msgid "If successful, an errno integer not equal to zero is returned."
2800 #: ../src/guestfs.pod:1390
2802 "If no error, this returns 0. This call can return 0 in three situations:"
2806 #: ../src/guestfs.pod:1397
2807 msgid "There has not been any error on the handle."
2811 #: ../src/guestfs.pod:1401
2813 "There has been an error but the errno was meaningless. This corresponds to "
2814 "the case where the error did not come from a failed system call, but for "
2815 "some other reason."
2819 #: ../src/guestfs.pod:1407
2821 "There was an error from a failed system call, but for some reason the errno "
2822 "was not captured and returned. This usually indicates a bug in libguestfs."
2826 #: ../src/guestfs.pod:1413
2828 "Libguestfs tries to convert the errno from inside the applicance into a "
2829 "corresponding errno for the caller (not entirely trivial: the appliance "
2830 "might be running a completely different operating system from the library "
2831 "and error numbers are not standardized across Un*xen). If this could not be "
2832 "done, then the error is translated to C<EINVAL>. In practice this should "
2833 "only happen in very rare circumstances."
2837 #: ../src/guestfs.pod:1421
2838 msgid "guestfs_set_error_handler"
2842 #: ../src/guestfs.pod:1423
2845 " typedef void (*guestfs_error_handler_cb) (guestfs_h *g,\n"
2847 " const char *msg);\n"
2848 " void guestfs_set_error_handler (guestfs_h *g,\n"
2849 " guestfs_error_handler_cb cb,\n"
2855 #: ../src/guestfs.pod:1430
2857 "The callback C<cb> will be called if there is an error. The parameters "
2858 "passed to the callback are an opaque data pointer and the error message "
2863 #: ../src/guestfs.pod:1434
2865 "C<errno> is not passed to the callback. To get that the callback must call "
2866 "L</guestfs_last_errno>."
2870 #: ../src/guestfs.pod:1437
2872 "Note that the message string C<msg> is freed as soon as the callback "
2873 "function returns, so if you want to stash it somewhere you must make your "
2878 #: ../src/guestfs.pod:1441
2879 msgid "The default handler prints messages on C<stderr>."
2883 #: ../src/guestfs.pod:1443
2884 msgid "If you set C<cb> to C<NULL> then I<no> handler is called."
2888 #: ../src/guestfs.pod:1445
2889 msgid "guestfs_get_error_handler"
2893 #: ../src/guestfs.pod:1447
2896 " guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g,\n"
2897 " void **opaque_rtn);\n"
2902 #: ../src/guestfs.pod:1450
2903 msgid "Returns the current error handler callback."
2907 #: ../src/guestfs.pod:1452
2908 msgid "guestfs_set_out_of_memory_handler"
2912 #: ../src/guestfs.pod:1454
2915 " typedef void (*guestfs_abort_cb) (void);\n"
2916 " int guestfs_set_out_of_memory_handler (guestfs_h *g,\n"
2917 " guestfs_abort_cb);\n"
2922 #: ../src/guestfs.pod:1458
2924 "The callback C<cb> will be called if there is an out of memory situation. "
2925 "I<Note this callback must not return>."
2929 #: ../src/guestfs.pod:1461
2930 msgid "The default is to call L<abort(3)>."
2934 #: ../src/guestfs.pod:1463
2936 "You cannot set C<cb> to C<NULL>. You can't ignore out of memory situations."
2940 #: ../src/guestfs.pod:1466
2941 msgid "guestfs_get_out_of_memory_handler"
2945 #: ../src/guestfs.pod:1468
2948 " guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n"
2953 #: ../src/guestfs.pod:1470
2954 msgid "This returns the current out of memory handler."
2958 #: ../src/guestfs.pod:1472
2963 #: ../src/guestfs.pod:1474 ../fish/guestfish.pod:1068
2968 #: ../src/guestfs.pod:1476
2973 #: ../src/guestfs.pod:1478
2978 #: ../src/guestfs.pod:1480
2979 msgid "AVAILABILITY"
2983 #: ../src/guestfs.pod:1482
2984 msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE"
2988 #: ../src/guestfs.pod:1484
2990 "Using L</guestfs_available> you can test availability of the following "
2991 "groups of functions. This test queries the appliance to see if the "
2992 "appliance you are currently using supports the functionality."
2996 #: ../src/guestfs.pod:1489
2997 msgid "@AVAILABILITY@"
3001 #: ../src/guestfs.pod:1491
3002 msgid "GUESTFISH supported COMMAND"
3006 #: ../src/guestfs.pod:1493
3008 "In L<guestfish(3)> there is a handy interactive command C<supported> which "
3009 "prints out the available groups and whether they are supported by this build "
3010 "of libguestfs. Note however that you have to do C<run> first."
3014 #: ../src/guestfs.pod:1498
3015 msgid "SINGLE CALLS AT COMPILE TIME"
3019 #: ../src/guestfs.pod:1500
3021 "Since version 1.5.8, C<E<lt>guestfs.hE<gt>> defines symbols for each C API "
3022 "function, such as:"
3026 #: ../src/guestfs.pod:1503
3029 " #define LIBGUESTFS_HAVE_DD 1\n"
3034 #: ../src/guestfs.pod:1505
3035 msgid "if L</guestfs_dd> is available."
3039 #: ../src/guestfs.pod:1507
3041 "Before version 1.5.8, if you needed to test whether a single libguestfs "
3042 "function is available at compile time, we recommended using build tools such "
3043 "as autoconf or cmake. For example in autotools you could use:"
3047 #: ../src/guestfs.pod:1512
3050 " AC_CHECK_LIB([guestfs],[guestfs_create])\n"
3051 " AC_CHECK_FUNCS([guestfs_dd])\n"
3056 #: ../src/guestfs.pod:1515
3058 "which would result in C<HAVE_GUESTFS_DD> being either defined or not defined "
3063 #: ../src/guestfs.pod:1518
3064 msgid "SINGLE CALLS AT RUN TIME"
3068 #: ../src/guestfs.pod:1520
3070 "Testing at compile time doesn't guarantee that a function really exists in "
3071 "the library. The reason is that you might be dynamically linked against a "
3072 "previous I<libguestfs.so> (dynamic library) which doesn't have the call. "
3073 "This situation unfortunately results in a segmentation fault, which is a "
3074 "shortcoming of the C dynamic linking system itself."
3078 #: ../src/guestfs.pod:1527
3080 "You can use L<dlopen(3)> to test if a function is available at run time, as "
3081 "in this example program (note that you still need the compile time check as "
3086 #: ../src/guestfs.pod:1531
3089 " #include <stdio.h>\n"
3090 " #include <stdlib.h>\n"
3091 " #include <unistd.h>\n"
3092 " #include <dlfcn.h>\n"
3093 " #include <guestfs.h>\n"
3098 #: ../src/guestfs.pod:1537
3103 " #ifdef LIBGUESTFS_HAVE_DD\n"
3105 " int has_function;\n"
3110 #: ../src/guestfs.pod:1543
3113 " /* Test if the function guestfs_dd is really available. */\n"
3114 " dl = dlopen (NULL, RTLD_LAZY);\n"
3116 " fprintf (stderr, \"dlopen: %s\\n\", dlerror ());\n"
3117 " exit (EXIT_FAILURE);\n"
3119 " has_function = dlsym (dl, \"guestfs_dd\") != NULL;\n"
3125 #: ../src/guestfs.pod:1552
3128 " if (!has_function)\n"
3129 " printf (\"this libguestfs.so does NOT have guestfs_dd function\\n\");\n"
3131 " printf (\"this libguestfs.so has guestfs_dd function\\n\");\n"
3132 " /* Now it's safe to call\n"
3133 " guestfs_dd (g, \"foo\", \"bar\");\n"
3137 " printf (\"guestfs_dd function was not found at compile time\\n\");\n"
3144 #: ../src/guestfs.pod:1565
3146 "You may think the above is an awful lot of hassle, and it is. There are "
3147 "other ways outside of the C linking system to ensure that this kind of "
3148 "incompatibility never arises, such as using package versioning:"
3152 #: ../src/guestfs.pod:1570
3155 " Requires: libguestfs >= 1.0.80\n"
3160 #: ../src/guestfs.pod:1572
3161 msgid "CALLS WITH OPTIONAL ARGUMENTS"
3165 #: ../src/guestfs.pod:1574
3167 "A recent feature of the API is the introduction of calls which take optional "
3168 "arguments. In C these are declared 3 ways. The main way is as a call which "
3169 "takes variable arguments (ie. C<...>), as in this example:"
3173 #: ../src/guestfs.pod:1579
3176 " int guestfs_add_drive_opts (guestfs_h *g, const char *filename, ...);\n"
3181 #: ../src/guestfs.pod:1581
3183 "Call this with a list of optional arguments, terminated by C<-1>. So to "
3184 "call with no optional arguments specified:"
3188 #: ../src/guestfs.pod:1584
3191 " guestfs_add_drive_opts (g, filename, -1);\n"
3196 #: ../src/guestfs.pod:1586
3197 msgid "With a single optional argument:"
3201 #: ../src/guestfs.pod:1588
3204 " guestfs_add_drive_opts (g, filename,\n"
3205 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
3211 #: ../src/guestfs.pod:1592
3216 #: ../src/guestfs.pod:1594
3219 " guestfs_add_drive_opts (g, filename,\n"
3220 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
3221 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
3227 #: ../src/guestfs.pod:1599
3229 "and so forth. Don't forget the terminating C<-1> otherwise Bad Things will "
3234 #: ../src/guestfs.pod:1602
3235 msgid "USING va_list FOR OPTIONAL ARGUMENTS"
3239 #: ../src/guestfs.pod:1604
3241 "The second variant has the same name with the suffix C<_va>, which works the "
3242 "same way but takes a C<va_list>. See the C manual for details. For the "
3243 "example function, this is declared:"
3247 #: ../src/guestfs.pod:1608
3250 " int guestfs_add_drive_opts_va (guestfs_h *g, const char *filename,\n"
3256 #: ../src/guestfs.pod:1611
3257 msgid "CONSTRUCTING OPTIONAL ARGUMENTS"
3261 #: ../src/guestfs.pod:1613
3263 "The third variant is useful where you need to construct these calls. You "
3264 "pass in a structure where you fill in the optional fields. The structure "
3265 "has a bitmask as the first element which you must set to indicate which "
3266 "fields you have filled in. For our example function the structure and call "
3271 #: ../src/guestfs.pod:1619
3274 " struct guestfs_add_drive_opts_argv {\n"
3275 " uint64_t bitmask;\n"
3277 " const char *format;\n"
3280 " int guestfs_add_drive_opts_argv (guestfs_h *g, const char *filename,\n"
3281 " const struct guestfs_add_drive_opts_argv *optargs);\n"
3286 #: ../src/guestfs.pod:1628
3287 msgid "You could call it like this:"
3291 #: ../src/guestfs.pod:1630
3294 " struct guestfs_add_drive_opts_argv optargs = {\n"
3295 " .bitmask = GUESTFS_ADD_DRIVE_OPTS_READONLY_BITMASK |\n"
3296 " GUESTFS_ADD_DRIVE_OPTS_FORMAT_BITMASK,\n"
3298 " .format = \"qcow2\"\n"
3304 #: ../src/guestfs.pod:1637
3307 " guestfs_add_drive_opts_argv (g, filename, &optargs);\n"
3312 #: ../src/guestfs.pod:1639 ../src/guestfs-actions.pod:11
3313 #: ../src/guestfs-actions.pod:1917 ../src/guestfs-actions.pod:2853
3314 #: ../fish/guestfish-actions.pod:9 ../fish/guestfish-actions.pod:1287
3315 #: ../fish/guestfish-actions.pod:1929 ../tools/virt-win-reg.pl:704
3320 #: ../src/guestfs.pod:1645
3321 msgid "The C<_BITMASK> suffix on each option name when specifying the bitmask."
3325 #: ../src/guestfs.pod:1650
3326 msgid "You do not need to fill in all fields of the structure."
3330 #: ../src/guestfs.pod:1654
3332 "There must be a one-to-one correspondence between fields of the structure "
3333 "that are filled in, and bits set in the bitmask."
3337 #: ../src/guestfs.pod:1659
3338 msgid "OPTIONAL ARGUMENTS IN OTHER LANGUAGES"
3342 #: ../src/guestfs.pod:1661
3344 "In other languages, optional arguments are expressed in the way that is "
3345 "natural for that language. We refer you to the language-specific "
3346 "documentation for more details on that."
3350 #: ../src/guestfs.pod:1665
3351 msgid "For guestfish, see L<guestfish(1)/OPTIONAL ARGUMENTS>."
3355 #: ../src/guestfs.pod:1667
3356 msgid "SETTING CALLBACKS TO HANDLE EVENTS"
3360 #: ../src/guestfs.pod:1669
3362 "B<Note:> This section documents the generic event mechanism introduced in "
3363 "libguestfs 1.10, which you should use in new code if possible. The old "
3364 "functions C<guestfs_set_log_message_callback>, "
3365 "C<guestfs_set_subprocess_quit_callback>, "
3366 "C<guestfs_set_launch_done_callback>, C<guestfs_set_close_callback> and "
3367 "C<guestfs_set_progress_callback> are no longer documented in this manual "
3368 "page. Because of the ABI guarantee, the old functions continue to work."
3372 #: ../src/guestfs.pod:1678
3374 "Handles generate events when certain things happen, such as log messages "
3375 "being generated, progress messages during long-running operations, or the "
3376 "handle being closed. The API calls described below let you register a "
3377 "callback to be called when events happen. You can register multiple "
3378 "callbacks (for the same, different or overlapping sets of events), and "
3379 "individually remove callbacks. If callbacks are not removed, then they "
3380 "remain in force until the handle is closed."
3384 #: ../src/guestfs.pod:1686
3386 "In the current implementation, events are only generated synchronously: that "
3387 "means that events (and hence callbacks) can only happen while you are in the "
3388 "middle of making another libguestfs call. The callback is called in the "
3393 #: ../src/guestfs.pod:1691
3395 "Events may contain a payload, usually nothing (void), an array of 64 bit "
3396 "unsigned integers, or a message buffer. Payloads are discussed later on."
3400 #: ../src/guestfs.pod:1695
3401 msgid "CLASSES OF EVENTS"
3405 #: ../src/guestfs.pod:1699
3406 msgid "GUESTFS_EVENT_CLOSE (payload type: void)"
3410 #: ../src/guestfs.pod:1702
3412 "The callback function will be called while the handle is being closed "
3413 "(synchronously from L</guestfs_close>)."
3417 #: ../src/guestfs.pod:1705
3419 "Note that libguestfs installs an L<atexit(3)> handler to try to clean up "
3420 "handles that are open when the program exits. This means that this callback "
3421 "might be called indirectly from L<exit(3)>, which can cause unexpected "
3422 "problems in higher-level languages (eg. if your HLL interpreter has already "
3423 "been cleaned up by the time this is called, and if your callback then jumps "
3424 "into some HLL function)."
3428 #: ../src/guestfs.pod:1712
3430 "If no callback is registered: the handle is closed without any callback "
3435 #: ../src/guestfs.pod:1715
3436 msgid "GUESTFS_EVENT_SUBPROCESS_QUIT (payload type: void)"
3440 #: ../src/guestfs.pod:1718
3442 "The callback function will be called when the child process quits, either "
3443 "asynchronously or if killed by L</guestfs_kill_subprocess>. (This "
3444 "corresponds to a transition from any state to the CONFIG state)."
3448 #: ../src/guestfs.pod:1722 ../src/guestfs.pod:1731
3449 msgid "If no callback is registered: the event is ignored."
3453 #: ../src/guestfs.pod:1724
3454 msgid "GUESTFS_EVENT_LAUNCH_DONE (payload type: void)"
3458 #: ../src/guestfs.pod:1727
3460 "The callback function will be called when the child process becomes ready "
3461 "first time after it has been launched. (This corresponds to a transition "
3462 "from LAUNCHING to the READY state)."
3466 #: ../src/guestfs.pod:1733
3467 msgid "GUESTFS_EVENT_PROGRESS (payload type: array of 4 x uint64_t)"
3471 #: ../src/guestfs.pod:1736
3473 "Some long-running operations can generate progress messages. If this "
3474 "callback is registered, then it will be called each time a progress message "
3475 "is generated (usually two seconds after the operation started, and three "
3476 "times per second thereafter until it completes, although the frequency may "
3477 "change in future versions)."
3481 #: ../src/guestfs.pod:1742
3483 "The callback receives in the payload four unsigned 64 bit numbers which are "
3484 "(in order): C<proc_nr>, C<serial>, C<position>, C<total>."
3488 #: ../src/guestfs.pod:1745
3490 "The units of C<total> are not defined, although for some operations C<total> "
3491 "may relate in some way to the amount of data to be transferred (eg. in bytes "
3492 "or megabytes), and C<position> may be the portion which has been transferred."
3496 #: ../src/guestfs.pod:1750
3497 msgid "The only defined and stable parts of the API are:"
3501 #: ../src/guestfs.pod:1756
3503 "The callback can display to the user some type of progress bar or indicator "
3504 "which shows the ratio of C<position>:C<total>."
3508 #: ../src/guestfs.pod:1761
3509 msgid "0 E<lt>= C<position> E<lt>= C<total>"
3513 #: ../src/guestfs.pod:1765
3515 "If any progress notification is sent during a call, then a final progress "
3516 "notification is always sent when C<position> = C<total> (I<unless> the call "
3517 "fails with an error)."
3521 #: ../src/guestfs.pod:1769
3523 "This is to simplify caller code, so callers can easily set the progress "
3524 "indicator to \"100%\" at the end of the operation, without requiring special "
3525 "code to detect this case."
3529 #: ../src/guestfs.pod:1775
3531 "For some calls we are unable to estimate the progress of the call, but we "
3532 "can still generate progress messages to indicate activity. This is known as "
3533 "\"pulse mode\", and is directly supported by certain progress bar "
3534 "implementations (eg. GtkProgressBar)."
3538 #: ../src/guestfs.pod:1780
3540 "For these calls, zero or more progress messages are generated with "
3541 "C<position = 0> and C<total = 1>, followed by a final message with "
3542 "C<position = total = 1>."
3546 #: ../src/guestfs.pod:1784
3548 "As noted above, if the call fails with an error then the final message may "
3553 #: ../src/guestfs.pod:1789
3555 "The callback also receives the procedure number (C<proc_nr>) and serial "
3556 "number (C<serial>) of the call. These are only useful for debugging "
3557 "protocol issues, and the callback can normally ignore them. The callback "
3558 "may want to print these numbers in error messages or debugging messages."
3562 #: ../src/guestfs.pod:1795
3563 msgid "If no callback is registered: progress messages are discarded."
3567 #: ../src/guestfs.pod:1797
3568 msgid "GUESTFS_EVENT_APPLIANCE (payload type: message buffer)"
3572 #: ../src/guestfs.pod:1800
3574 "The callback function is called whenever a log message is generated by qemu, "
3575 "the appliance kernel, guestfsd (daemon), or utility programs."
3579 #: ../src/guestfs.pod:1803
3581 "If the verbose flag (L</guestfs_set_verbose>) is set before launch (L</"
3582 "guestfs_launch>) then additional debug messages are generated."
3586 #: ../src/guestfs.pod:1806 ../src/guestfs.pod:1820
3588 "If no callback is registered: the messages are discarded unless the verbose "
3589 "flag is set in which case they are sent to stderr. You can override the "
3590 "printing of verbose messages to stderr by setting up a callback."
3594 #: ../src/guestfs.pod:1811
3595 msgid "GUESTFS_EVENT_LIBRARY (payload type: message buffer)"
3599 #: ../src/guestfs.pod:1814
3601 "The callback function is called whenever a log message is generated by the "
3602 "library part of libguestfs."
3606 #: ../src/guestfs.pod:1817
3608 "If the verbose flag (L</guestfs_set_verbose>) is set then additional debug "
3609 "messages are generated."
3613 #: ../src/guestfs.pod:1825
3614 msgid "GUESTFS_EVENT_TRACE (payload type: message buffer)"
3618 #: ../src/guestfs.pod:1828
3620 "The callback function is called whenever a trace message is generated. This "
3621 "only applies if the trace flag (L</guestfs_set_trace>) is set."
3625 #: ../src/guestfs.pod:1831
3627 "If no callback is registered: the messages are sent to stderr. You can "
3628 "override the printing of trace messages to stderr by setting up a callback."
3632 #: ../src/guestfs.pod:1837
3633 msgid "guestfs_set_event_callback"
3637 #: ../src/guestfs.pod:1839
3640 " int guestfs_set_event_callback (guestfs_h *g,\n"
3641 " guestfs_event_callback cb,\n"
3642 " uint64_t event_bitmask,\n"
3649 #: ../src/guestfs.pod:1845
3651 "This function registers a callback (C<cb>) for all event classes in the "
3656 #: ../src/guestfs.pod:1848
3658 "For example, to register for all log message events, you could call this "
3659 "function with the bitmask C<GUESTFS_EVENT_APPLIANCE|GUESTFS_EVENT_LIBRARY>. "
3660 "To register a single callback for all possible classes of events, use "
3661 "C<GUESTFS_EVENT_ALL>."
3665 #: ../src/guestfs.pod:1854
3666 msgid "C<flags> should always be passed as 0."
3670 #: ../src/guestfs.pod:1856
3672 "C<opaque> is an opaque pointer which is passed to the callback. You can use "
3673 "it for any purpose."
3677 #: ../src/guestfs.pod:1859
3679 "The return value is the event handle (an integer) which you can use to "
3680 "delete the callback (see below)."
3684 #: ../src/guestfs.pod:1862
3686 "If there is an error, this function returns C<-1>, and sets the error in the "
3687 "handle in the usual way (see L</guestfs_last_error> etc.)"
3691 #: ../src/guestfs.pod:1865
3693 "Callbacks remain in effect until they are deleted, or until the handle is "
3698 #: ../src/guestfs.pod:1868
3700 "In the case where multiple callbacks are registered for a particular event "
3701 "class, all of the callbacks are called. The order in which multiple "
3702 "callbacks are called is not defined."
3706 #: ../src/guestfs.pod:1872
3707 msgid "guestfs_delete_event_callback"
3711 #: ../src/guestfs.pod:1874
3714 " void guestfs_delete_event_callback (guestfs_h *g, int event_handle);\n"
3719 #: ../src/guestfs.pod:1876
3721 "Delete a callback that was previously registered. C<event_handle> should be "
3722 "the integer that was returned by a previous call to "
3723 "C<guestfs_set_event_callback> on the same handle."
3727 #: ../src/guestfs.pod:1880
3728 msgid "guestfs_event_callback"
3732 #: ../src/guestfs.pod:1882
3735 " typedef void (*guestfs_event_callback) (\n"
3738 " uint64_t event,\n"
3739 " int event_handle,\n"
3741 " const char *buf, size_t buf_len,\n"
3742 " const uint64_t *array, size_t array_len);\n"
3747 #: ../src/guestfs.pod:1891
3749 "This is the type of the event callback function that you have to provide."
3753 #: ../src/guestfs.pod:1894
3755 "The basic parameters are: the handle (C<g>), the opaque user pointer "
3756 "(C<opaque>), the event class (eg. C<GUESTFS_EVENT_PROGRESS>), the event "
3757 "handle, and C<flags> which in the current API you should ignore."
3761 #: ../src/guestfs.pod:1898
3763 "The remaining parameters contain the event payload (if any). Each event may "
3764 "contain a payload, which usually relates to the event class, but for future "
3765 "proofing your code should be written to handle any payload for any event "
3770 #: ../src/guestfs.pod:1903
3772 "C<buf> and C<buf_len> contain a message buffer (if C<buf_len == 0>, then "
3773 "there is no message buffer). Note that this message buffer can contain "
3774 "arbitrary 8 bit data, including NUL bytes."
3778 #: ../src/guestfs.pod:1907
3780 "C<array> and C<array_len> is an array of 64 bit unsigned integers. At the "
3781 "moment this is only used for progress messages."
3785 #: ../src/guestfs.pod:1910
3786 msgid "EXAMPLE: CAPTURING LOG MESSAGES"
3790 #: ../src/guestfs.pod:1912
3792 "One motivation for the generic event API was to allow GUI programs to "
3793 "capture debug and other messages. In libguestfs E<le> 1.8 these were sent "
3794 "unconditionally to C<stderr>."
3798 #: ../src/guestfs.pod:1916
3800 "Events associated with log messages are: C<GUESTFS_EVENT_LIBRARY>, "
3801 "C<GUESTFS_EVENT_APPLIANCE> and C<GUESTFS_EVENT_TRACE>. (Note that error "
3802 "messages are not events; you must capture error messages separately)."
3806 #: ../src/guestfs.pod:1921
3808 "Programs have to set up a callback to capture the classes of events of "
3813 #: ../src/guestfs.pod:1924
3817 " guestfs_set_event_callback\n"
3818 " (g, message_callback,\n"
3819 " GUESTFS_EVENT_LIBRARY|GUESTFS_EVENT_APPLIANCE|\n"
3820 " GUESTFS_EVENT_TRACE,\n"
3821 " 0, NULL) == -1)\n"
3822 " if (eh == -1) {\n"
3823 " // handle error in the usual way\n"
3829 #: ../src/guestfs.pod:1934
3831 "The callback can then direct messages to the appropriate place. In this "
3832 "example, messages are directed to syslog:"
3836 #: ../src/guestfs.pod:1937
3840 " message_callback (\n"
3843 " uint64_t event,\n"
3844 " int event_handle,\n"
3846 " const char *buf, size_t buf_len,\n"
3847 " const uint64_t *array, size_t array_len)\n"
3849 " const int priority = LOG_USER|LOG_INFO;\n"
3850 " if (buf_len > 0)\n"
3851 " syslog (priority, \"event 0x%lx: %s\", event, buf);\n"
3857 #: ../src/guestfs.pod:1952
3858 msgid "CANCELLING LONG TRANSFERS"
3862 #: ../src/guestfs.pod:1954
3864 "Some operations can be cancelled by the caller while they are in progress. "
3865 "Currently only operations that involve uploading or downloading data can be "
3866 "cancelled (technically: operations that have C<FileIn> or C<FileOut> "
3867 "parameters in the generator)."
3871 #: ../src/guestfs.pod:1959
3872 msgid "guestfs_user_cancel"
3876 #: ../src/guestfs.pod:1961
3879 " void guestfs_user_cancel (guestfs_h *g);\n"
3884 #: ../src/guestfs.pod:1963
3886 "C<guestfs_user_cancel> cancels the current upload or download operation."
3890 #: ../src/guestfs.pod:1966
3892 "Unlike most other libguestfs calls, this function is signal safe and thread "
3893 "safe. You can call it from a signal handler or from another thread, without "
3894 "needing to do any locking."
3898 #: ../src/guestfs.pod:1970
3900 "The transfer that was in progress (if there is one) will stop shortly "
3901 "afterwards, and will return an error. The errno (see L</"
3902 "guestfs_last_errno>) is set to C<EINTR>, so you can test for this to find "
3903 "out if the operation was cancelled or failed because of another error."
3907 #: ../src/guestfs.pod:1976
3909 "No cleanup is performed: for example, if a file was being uploaded then "
3910 "after cancellation there may be a partially uploaded file. It is the "
3911 "caller's responsibility to clean up if necessary."
3915 #: ../src/guestfs.pod:1980
3916 msgid "There are two common places that you might call C<guestfs_user_cancel>."
3920 #: ../src/guestfs.pod:1982
3922 "In an interactive text-based program, you might call it from a C<SIGINT> "
3923 "signal handler so that pressing C<^C> cancels the current operation. (You "
3924 "also need to call L</guestfs_set_pgroup> so that child processes don't "
3925 "receive the C<^C> signal)."
3929 #: ../src/guestfs.pod:1987
3931 "In a graphical program, when the main thread is displaying a progress bar "
3932 "with a cancel button, wire up the cancel button to call this function."
3936 #: ../src/guestfs.pod:1991
3937 msgid "PRIVATE DATA AREA"
3941 #: ../src/guestfs.pod:1993
3943 "You can attach named pieces of private data to the libguestfs handle, fetch "
3944 "them by name, and walk over them, for the lifetime of the handle. This is "
3945 "called the private data area and is only available from the C API."
3949 #: ../src/guestfs.pod:1998
3950 msgid "To attach a named piece of data, use the following call:"
3954 #: ../src/guestfs.pod:2000
3957 " void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n"
3962 #: ../src/guestfs.pod:2002
3964 "C<key> is the name to associate with this data, and C<data> is an arbitrary "
3965 "pointer (which can be C<NULL>). Any previous item with the same key is "
3970 #: ../src/guestfs.pod:2006
3972 "You can use any C<key> you want, but your key should I<not> start with an "
3973 "underscore character. Keys beginning with an underscore character are "
3974 "reserved for internal libguestfs purposes (eg. for implementing language "
3975 "bindings). It is recommended that you prefix the key with some unique "
3976 "string to avoid collisions with other users."
3980 #: ../src/guestfs.pod:2012
3981 msgid "To retrieve the pointer, use:"
3985 #: ../src/guestfs.pod:2014
3988 " void *guestfs_get_private (guestfs_h *g, const char *key);\n"
3993 #: ../src/guestfs.pod:2016
3995 "This function returns C<NULL> if either no data is found associated with "
3996 "C<key>, or if the user previously set the C<key>'s C<data> pointer to "
4001 #: ../src/guestfs.pod:2020
4003 "Libguestfs does not try to look at or interpret the C<data> pointer in any "
4004 "way. As far as libguestfs is concerned, it need not be a valid pointer at "
4005 "all. In particular, libguestfs does I<not> try to free the data when the "
4006 "handle is closed. If the data must be freed, then the caller must either "
4007 "free it before calling L</guestfs_close> or must set up a close callback to "
4008 "do it (see L</GUESTFS_EVENT_CLOSE>)."
4012 #: ../src/guestfs.pod:2027
4013 msgid "To walk over all entries, use these two functions:"
4017 #: ../src/guestfs.pod:2029
4020 " void *guestfs_first_private (guestfs_h *g, const char **key_rtn);\n"
4025 #: ../src/guestfs.pod:2031
4028 " void *guestfs_next_private (guestfs_h *g, const char **key_rtn);\n"
4033 #: ../src/guestfs.pod:2033
4035 "C<guestfs_first_private> returns the first key, pointer pair (\"first\" does "
4036 "not have any particular meaning -- keys are not returned in any defined "
4037 "order). A pointer to the key is returned in C<*key_rtn> and the "
4038 "corresponding data pointer is returned from the function. C<NULL> is "
4039 "returned if there are no keys stored in the handle."
4043 #: ../src/guestfs.pod:2039
4045 "C<guestfs_next_private> returns the next key, pointer pair. The return "
4046 "value of this function is also C<NULL> is there are no further entries to "
4051 #: ../src/guestfs.pod:2043
4052 msgid "Notes about walking over entries:"
4056 #: ../src/guestfs.pod:2049
4058 "You must not call C<guestfs_set_private> while walking over the entries."
4062 #: ../src/guestfs.pod:2054
4064 "The handle maintains an internal iterator which is reset when you call "
4065 "C<guestfs_first_private>. This internal iterator is invalidated when you "
4066 "call C<guestfs_set_private>."
4070 #: ../src/guestfs.pod:2060
4071 msgid "If you have set the data pointer associated with a key to C<NULL>, ie:"
4075 #: ../src/guestfs.pod:2062
4078 " guestfs_set_private (g, key, NULL);\n"
4083 #: ../src/guestfs.pod:2064
4084 msgid "then that C<key> is not returned when walking."
4088 #: ../src/guestfs.pod:2068
4090 "C<*key_rtn> is only valid until the next call to C<guestfs_first_private>, "
4091 "C<guestfs_next_private> or C<guestfs_set_private>."
4095 #: ../src/guestfs.pod:2074
4097 "The following example code shows how to print all keys and data pointers "
4098 "that are associated with the handle C<g>:"
4102 #: ../src/guestfs.pod:2077
4105 " const char *key;\n"
4106 " void *data = guestfs_first_private (g, &key);\n"
4107 " while (data != NULL)\n"
4109 " printf (\"key = %s, data = %p\\n\", key, data);\n"
4110 " data = guestfs_next_private (g, &key);\n"
4116 #: ../src/guestfs.pod:2085
4118 "More commonly you are only interested in keys that begin with an application-"
4119 "specific prefix C<foo_>. Modify the loop like so:"
4123 #: ../src/guestfs.pod:2088
4126 " const char *key;\n"
4127 " void *data = guestfs_first_private (g, &key);\n"
4128 " while (data != NULL)\n"
4130 " if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
4131 " printf (\"key = %s, data = %p\\n\", key, data);\n"
4132 " data = guestfs_next_private (g, &key);\n"
4138 #: ../src/guestfs.pod:2097
4140 "If you need to modify keys while walking, then you have to jump back to the "
4141 "beginning of the loop. For example, to delete all keys prefixed with "
4146 #: ../src/guestfs.pod:2101
4149 " const char *key;\n"
4152 " data = guestfs_first_private (g, &key);\n"
4153 " while (data != NULL)\n"
4155 " if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
4157 " guestfs_set_private (g, key, NULL);\n"
4158 " /* note that 'key' pointer is now invalid, and so is\n"
4159 " the internal iterator */\n"
4162 " data = guestfs_next_private (g, &key);\n"
4168 #: ../src/guestfs.pod:2117
4170 "Note that the above loop is guaranteed to terminate because the keys are "
4171 "being deleted, but other manipulations of keys within the loop might not "
4172 "terminate unless you also maintain an indication of which keys have been "
4177 #: ../src/guestfs.pod:2122 ../src/guestfs.pod:2127
4182 #: ../src/guestfs.pod:2124
4184 "<!-- old anchor for the next section --> <a name="
4185 "\"state_machine_and_low_level_event_api\"/>"
4187 "<!-- old anchor for the next section --> <a name="
4188 "\"state_machine_and_low_level_event_api\"/>"
4191 #: ../src/guestfs.pod:2129
4192 msgid "ARCHITECTURE"
4193 msgstr "АРХІТЕКТУРА"
4196 #: ../src/guestfs.pod:2131
4198 "Internally, libguestfs is implemented by running an appliance (a special "
4199 "type of small virtual machine) using L<qemu(1)>. Qemu runs as a child "
4200 "process of the main program."
4204 #: ../src/guestfs.pod:2135
4207 " ___________________\n"
4209 " | main program |\n"
4211 " | | child process / appliance\n"
4212 " | | __________________________\n"
4214 " +-------------------+ RPC | +-----------------+ |\n"
4215 " | libguestfs <--------------------> guestfsd | |\n"
4216 " | | | +-----------------+ |\n"
4217 " \\___________________/ | | Linux kernel | |\n"
4218 " | +--^--------------+ |\n"
4219 " \\_________|________________/\n"
4225 " \\______________/\n"
4230 #: ../src/guestfs.pod:2155
4232 "The library, linked to the main program, creates the child process and hence "
4233 "the appliance in the L</guestfs_launch> function."
4237 #: ../src/guestfs.pod:2158
4239 "Inside the appliance is a Linux kernel and a complete stack of userspace "
4240 "tools (such as LVM and ext2 programs) and a small controlling daemon called "
4241 "L</guestfsd>. The library talks to L</guestfsd> using remote procedure "
4242 "calls (RPC). There is a mostly one-to-one correspondence between libguestfs "
4243 "API calls and RPC calls to the daemon. Lastly the disk image(s) are "
4244 "attached to the qemu process which translates device access by the "
4245 "appliance's Linux kernel into accesses to the image."
4249 #: ../src/guestfs.pod:2167
4251 "A common misunderstanding is that the appliance \"is\" the virtual machine. "
4252 "Although the disk image you are attached to might also be used by some "
4253 "virtual machine, libguestfs doesn't know or care about this. (But you will "
4254 "care if both libguestfs's qemu process and your virtual machine are trying "
4255 "to update the disk image at the same time, since these usually results in "
4256 "massive disk corruption)."
4260 #: ../src/guestfs.pod:2174
4261 msgid "STATE MACHINE"
4262 msgstr "СКІНЧЕННИЙ АВТОМАТ"
4265 #: ../src/guestfs.pod:2176
4266 msgid "libguestfs uses a state machine to model the child process:"
4270 #: ../src/guestfs.pod:2178
4282 " / | \\ \\ guestfs_launch\n"
4283 " / | _\\__V______\n"
4285 " / | | LAUNCHING |\n"
4286 " / | \\___________/\n"
4288 " / | guestfs_launch\n"
4290 " ______ / __|____V\n"
4291 " / \\ ------> / \\\n"
4292 " | BUSY | | READY |\n"
4293 " \\______/ <------ \\________/\n"
4298 #: ../src/guestfs.pod:2200
4300 "The normal transitions are (1) CONFIG (when the handle is created, but there "
4301 "is no child process), (2) LAUNCHING (when the child process is booting up), "
4302 "(3) alternating between READY and BUSY as commands are issued to, and "
4303 "carried out by, the child process."
4307 #: ../src/guestfs.pod:2205
4309 "The guest may be killed by L</guestfs_kill_subprocess>, or may die "
4310 "asynchronously at any time (eg. due to some internal error), and that causes "
4311 "the state to transition back to CONFIG."
4315 #: ../src/guestfs.pod:2209
4317 "Configuration commands for qemu such as L</guestfs_add_drive> can only be "
4318 "issued when in the CONFIG state."
4322 #: ../src/guestfs.pod:2212
4324 "The API offers one call that goes from CONFIG through LAUNCHING to READY. "
4325 "L</guestfs_launch> blocks until the child process is READY to accept "
4326 "commands (or until some failure or timeout). L</guestfs_launch> internally "
4327 "moves the state from CONFIG to LAUNCHING while it is running."
4331 #: ../src/guestfs.pod:2218
4333 "API actions such as L</guestfs_mount> can only be issued when in the READY "
4334 "state. These API calls block waiting for the command to be carried out (ie. "
4335 "the state to transition to BUSY and then back to READY). There are no non-"
4336 "blocking versions, and no way to issue more than one command per handle at "
4341 #: ../src/guestfs.pod:2224
4343 "Finally, the child process sends asynchronous messages back to the main "
4344 "program, such as kernel log messages. You can register a callback to "
4345 "receive these messages."
4349 #: ../src/guestfs.pod:2228
4354 #: ../src/guestfs.pod:2230
4355 msgid "COMMUNICATION PROTOCOL"
4359 #: ../src/guestfs.pod:2232
4361 "Don't rely on using this protocol directly. This section documents how it "
4362 "currently works, but it may change at any time."
4366 #: ../src/guestfs.pod:2235
4368 "The protocol used to talk between the library and the daemon running inside "
4369 "the qemu virtual machine is a simple RPC mechanism built on top of XDR (RFC "
4370 "1014, RFC 1832, RFC 4506)."
4374 #: ../src/guestfs.pod:2239
4376 "The detailed format of structures is in C<src/guestfs_protocol.x> (note: "
4377 "this file is automatically generated)."
4381 #: ../src/guestfs.pod:2242
4383 "There are two broad cases, ordinary functions that don't have any C<FileIn> "
4384 "and C<FileOut> parameters, which are handled with very simple request/reply "
4385 "messages. Then there are functions that have any C<FileIn> or C<FileOut> "
4386 "parameters, which use the same request and reply messages, but they may also "
4387 "be followed by files sent using a chunked encoding."
4391 #: ../src/guestfs.pod:2249
4392 msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)"
4396 #: ../src/guestfs.pod:2251
4397 msgid "For ordinary functions, the request message is:"
4401 #: ../src/guestfs.pod:2253
4404 " total length (header + arguments,\n"
4405 " but not including the length word itself)\n"
4406 " struct guestfs_message_header (encoded as XDR)\n"
4407 " struct guestfs_<foo>_args (encoded as XDR)\n"
4412 #: ../src/guestfs.pod:2258
4414 "The total length field allows the daemon to allocate a fixed size buffer "
4415 "into which it slurps the rest of the message. As a result, the total length "
4416 "is limited to C<GUESTFS_MESSAGE_MAX> bytes (currently 4MB), which means the "
4417 "effective size of any request is limited to somewhere under this size."
4421 #: ../src/guestfs.pod:2264
4423 "Note also that many functions don't take any arguments, in which case the "
4424 "C<guestfs_I<foo>_args> is completely omitted."
4428 #: ../src/guestfs.pod:2267
4430 "The header contains the procedure number (C<guestfs_proc>) which is how the "
4431 "receiver knows what type of args structure to expect, or none at all."
4435 #: ../src/guestfs.pod:2271
4437 "For functions that take optional arguments, the optional arguments are "
4438 "encoded in the C<guestfs_I<foo>_args> structure in the same way as ordinary "
4439 "arguments. A bitmask in the header indicates which optional arguments are "
4440 "meaningful. The bitmask is also checked to see if it contains bits set "
4441 "which the daemon does not know about (eg. if more optional arguments were "
4442 "added in a later version of the library), and this causes the call to be "
4447 #: ../src/guestfs.pod:2279
4448 msgid "The reply message for ordinary functions is:"
4452 #: ../src/guestfs.pod:2281
4455 " total length (header + ret,\n"
4456 " but not including the length word itself)\n"
4457 " struct guestfs_message_header (encoded as XDR)\n"
4458 " struct guestfs_<foo>_ret (encoded as XDR)\n"
4463 #: ../src/guestfs.pod:2286
4465 "As above the C<guestfs_I<foo>_ret> structure may be completely omitted for "
4466 "functions that return no formal return values."
4470 #: ../src/guestfs.pod:2289
4472 "As above the total length of the reply is limited to C<GUESTFS_MESSAGE_MAX>."
4476 #: ../src/guestfs.pod:2292
4478 "In the case of an error, a flag is set in the header, and the reply message "
4479 "is slightly changed:"
4483 #: ../src/guestfs.pod:2295
4486 " total length (header + error,\n"
4487 " but not including the length word itself)\n"
4488 " struct guestfs_message_header (encoded as XDR)\n"
4489 " struct guestfs_message_error (encoded as XDR)\n"
4494 #: ../src/guestfs.pod:2300
4496 "The C<guestfs_message_error> structure contains the error message as a "
4501 #: ../src/guestfs.pod:2303
4502 msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS"
4506 #: ../src/guestfs.pod:2305
4508 "A C<FileIn> parameter indicates that we transfer a file I<into> the guest. "
4509 "The normal request message is sent (see above). However this is followed by "
4510 "a sequence of file chunks."
4514 #: ../src/guestfs.pod:2309
4517 " total length (header + arguments,\n"
4518 " but not including the length word itself,\n"
4519 " and not including the chunks)\n"
4520 " struct guestfs_message_header (encoded as XDR)\n"
4521 " struct guestfs_<foo>_args (encoded as XDR)\n"
4522 " sequence of chunks for FileIn param #0\n"
4523 " sequence of chunks for FileIn param #1 etc.\n"
4528 #: ../src/guestfs.pod:2317
4529 msgid "The \"sequence of chunks\" is:"
4533 #: ../src/guestfs.pod:2319
4536 " length of chunk (not including length word itself)\n"
4537 " struct guestfs_chunk (encoded as XDR)\n"
4538 " length of chunk\n"
4539 " struct guestfs_chunk (encoded as XDR)\n"
4541 " length of chunk\n"
4542 " struct guestfs_chunk (with data.data_len == 0)\n"
4547 #: ../src/guestfs.pod:2327
4549 "The final chunk has the C<data_len> field set to zero. Additionally a flag "
4550 "is set in the final chunk to indicate either successful completion or early "
4555 #: ../src/guestfs.pod:2331
4557 "At time of writing there are no functions that have more than one FileIn "
4558 "parameter. However this is (theoretically) supported, by sending the "
4559 "sequence of chunks for each FileIn parameter one after another (from left to "
4564 #: ../src/guestfs.pod:2336
4566 "Both the library (sender) I<and> the daemon (receiver) may cancel the "
4567 "transfer. The library does this by sending a chunk with a special flag set "
4568 "to indicate cancellation. When the daemon sees this, it cancels the whole "
4569 "RPC, does I<not> send any reply, and goes back to reading the next request."
4573 #: ../src/guestfs.pod:2342
4575 "The daemon may also cancel. It does this by writing a special word "
4576 "C<GUESTFS_CANCEL_FLAG> to the socket. The library listens for this during "
4577 "the transfer, and if it gets it, it will cancel the transfer (it sends a "
4578 "cancel chunk). The special word is chosen so that even if cancellation "
4579 "happens right at the end of the transfer (after the library has finished "
4580 "writing and has started listening for the reply), the \"spurious\" cancel "
4581 "flag will not be confused with the reply message."
4585 #: ../src/guestfs.pod:2351
4587 "This protocol allows the transfer of arbitrary sized files (no 32 bit "
4588 "limit), and also files where the size is not known in advance (eg. from "
4589 "pipes or sockets). However the chunks are rather small "
4590 "(C<GUESTFS_MAX_CHUNK_SIZE>), so that neither the library nor the daemon need "
4591 "to keep much in memory."
4595 #: ../src/guestfs.pod:2357
4596 msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS"
4600 #: ../src/guestfs.pod:2359
4602 "The protocol for FileOut parameters is exactly the same as for FileIn "
4603 "parameters, but with the roles of daemon and library reversed."
4607 #: ../src/guestfs.pod:2362
4610 " total length (header + ret,\n"
4611 " but not including the length word itself,\n"
4612 " and not including the chunks)\n"
4613 " struct guestfs_message_header (encoded as XDR)\n"
4614 " struct guestfs_<foo>_ret (encoded as XDR)\n"
4615 " sequence of chunks for FileOut param #0\n"
4616 " sequence of chunks for FileOut param #1 etc.\n"
4621 #: ../src/guestfs.pod:2370
4622 msgid "INITIAL MESSAGE"
4626 #: ../src/guestfs.pod:2372
4628 "When the daemon launches it sends an initial word (C<GUESTFS_LAUNCH_FLAG>) "
4629 "which indicates that the guest and daemon is alive. This is what L</"
4630 "guestfs_launch> waits for."
4634 #: ../src/guestfs.pod:2376
4635 msgid "PROGRESS NOTIFICATION MESSAGES"
4639 #: ../src/guestfs.pod:2378
4641 "The daemon may send progress notification messages at any time. These are "
4642 "distinguished by the normal length word being replaced by "
4643 "C<GUESTFS_PROGRESS_FLAG>, followed by a fixed size progress message."
4647 #: ../src/guestfs.pod:2382
4649 "The library turns them into progress callbacks (see L</"
4650 "GUESTFS_EVENT_PROGRESS>) if there is a callback registered, or discards them "
4655 #: ../src/guestfs.pod:2386
4657 "The daemon self-limits the frequency of progress messages it sends (see "
4658 "C<daemon/proto.c:notify_progress>). Not all calls generate progress "
4663 #: ../src/guestfs.pod:2390
4664 msgid "LIBGUESTFS VERSION NUMBERS"
4668 #: ../src/guestfs.pod:2392
4670 "Since April 2010, libguestfs has started to make separate development and "
4671 "stable releases, along with corresponding branches in our git repository. "
4672 "These separate releases can be identified by version number:"
4676 #: ../src/guestfs.pod:2397
4679 " even numbers for stable: 1.2.x, 1.4.x, ...\n"
4680 " .-------- odd numbers for development: 1.3.x, 1.5.x, ...\n"
4686 " | `-------- sub-version\n"
4688 " `------ always '1' because we don't change the ABI\n"
4693 #: ../src/guestfs.pod:2408
4694 msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"."
4698 #: ../src/guestfs.pod:2410
4700 "As time passes we cherry pick fixes from the development branch and backport "
4701 "those into the stable branch, the effect being that the stable branch should "
4702 "get more stable and less buggy over time. So the stable releases are ideal "
4703 "for people who don't need new features but would just like the software to "
4708 #: ../src/guestfs.pod:2416
4709 msgid "Our criteria for backporting changes are:"
4713 #: ../src/guestfs.pod:2422
4715 "Documentation changes which don't affect any code are backported unless the "
4716 "documentation refers to a future feature which is not in stable."
4720 #: ../src/guestfs.pod:2428
4722 "Bug fixes which are not controversial, fix obvious problems, and have been "
4723 "well tested are backported."
4727 #: ../src/guestfs.pod:2433
4729 "Simple rearrangements of code which shouldn't affect how it works get "
4730 "backported. This is so that the code in the two branches doesn't get too "
4731 "far out of step, allowing us to backport future fixes more easily."
4735 #: ../src/guestfs.pod:2439
4737 "We I<don't> backport new features, new APIs, new tools etc, except in one "
4738 "exceptional case: the new feature is required in order to implement an "
4739 "important bug fix."
4743 #: ../src/guestfs.pod:2445
4745 "A new stable branch starts when we think the new features in development are "
4746 "substantial and compelling enough over the current stable branch to warrant "
4747 "it. When that happens we create new stable and development versions 1.N.0 "
4748 "and 1.(N+1).0 [N is even]. The new dot-oh release won't necessarily be so "
4749 "stable at this point, but by backporting fixes from development, that branch "
4750 "will stabilize over time."
4754 #: ../src/guestfs.pod:2453
4755 msgid "EXTENDING LIBGUESTFS"
4759 #: ../src/guestfs.pod:2455
4760 msgid "ADDING A NEW API ACTION"
4764 #: ../src/guestfs.pod:2457
4766 "Large amounts of boilerplate code in libguestfs (RPC, bindings, "
4767 "documentation) are generated, and this makes it easy to extend the "
4772 #: ../src/guestfs.pod:2461
4773 msgid "To add a new API action there are two changes:"
4777 #: ../src/guestfs.pod:2467
4779 "You need to add a description of the call (name, parameters, return type, "
4780 "tests, documentation) to C<generator/generator_actions.ml>."
4784 #: ../src/guestfs.pod:2470
4786 "There are two sorts of API action, depending on whether the call goes "
4787 "through to the daemon in the appliance, or is serviced entirely by the "
4788 "library (see L</ARCHITECTURE> above). L</guestfs_sync> is an example of the "
4789 "former, since the sync is done in the appliance. L</guestfs_set_trace> is "
4790 "an example of the latter, since a trace flag is maintained in the handle and "
4791 "all tracing is done on the library side."
4795 #: ../src/guestfs.pod:2478
4797 "Most new actions are of the first type, and get added to the "
4798 "C<daemon_functions> list. Each function has a unique procedure number used "
4799 "in the RPC protocol which is assigned to that action when we publish "
4800 "libguestfs and cannot be reused. Take the latest procedure number and "
4805 #: ../src/guestfs.pod:2484
4807 "For library-only actions of the second type, add to the "
4808 "C<non_daemon_functions> list. Since these functions are serviced by the "
4809 "library and do not travel over the RPC mechanism to the daemon, these "
4810 "functions do not need a procedure number, and so the procedure number is set "
4815 #: ../src/guestfs.pod:2492
4816 msgid "Implement the action (in C):"
4820 #: ../src/guestfs.pod:2494
4822 "For daemon actions, implement the function C<do_E<lt>nameE<gt>> in the "
4823 "C<daemon/> directory."
4827 #: ../src/guestfs.pod:2497
4829 "For library actions, implement the function C<guestfs__E<lt>nameE<gt>> "
4830 "(note: double underscore) in the C<src/> directory."
4834 #: ../src/guestfs.pod:2500
4835 msgid "In either case, use another function as an example of what to do."
4839 #: ../src/guestfs.pod:2504
4840 msgid "After making these changes, use C<make> to compile."
4844 #: ../src/guestfs.pod:2506
4846 "Note that you don't need to implement the RPC, language bindings, manual "
4847 "pages or anything else. It's all automatically generated from the OCaml "
4852 #: ../src/guestfs.pod:2510
4853 msgid "ADDING TESTS FOR AN API ACTION"
4857 #: ../src/guestfs.pod:2512
4859 "You can supply zero or as many tests as you want per API call. The tests "
4860 "can either be added as part of the API description (C<generator/"
4861 "generator_actions.ml>), or in some rarer cases you may want to drop a script "
4862 "into C<regressions/>. Note that adding a script to C<regressions/> is "
4863 "slower, so if possible use the first method."
4867 #: ../src/guestfs.pod:2518
4869 "The following describes the test environment used when you add an API test "
4870 "in C<generator_actions.ml>."
4874 #: ../src/guestfs.pod:2521
4875 msgid "The test environment has 4 block devices:"
4879 #: ../src/guestfs.pod:2525
4880 msgid "C</dev/sda> 500MB"
4884 #: ../src/guestfs.pod:2527
4885 msgid "General block device for testing."
4889 #: ../src/guestfs.pod:2529
4890 msgid "C</dev/sdb> 50MB"
4894 #: ../src/guestfs.pod:2531
4896 "C</dev/sdb1> is an ext2 filesystem used for testing filesystem write "
4901 #: ../src/guestfs.pod:2534
4902 msgid "C</dev/sdc> 10MB"
4906 #: ../src/guestfs.pod:2536
4907 msgid "Used in a few tests where two block devices are needed."
4911 #: ../src/guestfs.pod:2538
4913 msgstr "C</dev/sdd>"
4916 #: ../src/guestfs.pod:2540
4917 msgid "ISO with fixed content (see C<images/test.iso>)."
4921 #: ../src/guestfs.pod:2544
4923 "To be able to run the tests in a reasonable amount of time, the libguestfs "
4924 "appliance and block devices are reused between tests. So don't try testing "
4925 "L</guestfs_kill_subprocess> :-x"
4929 #: ../src/guestfs.pod:2548
4931 "Each test starts with an initial scenario, selected using one of the "
4932 "C<Init*> expressions, described in C<generator/generator_types.ml>. These "
4933 "initialize the disks mentioned above in a particular way as documented in "
4934 "C<generator_types.ml>. You should not assume anything about the previous "
4935 "contents of other disks that are not initialized."
4939 #: ../src/guestfs.pod:2554
4941 "You can add a prerequisite clause to any individual test. This is a run-"
4942 "time check, which, if it fails, causes the test to be skipped. Useful if "
4943 "testing a command which might not work on all variations of libguestfs "
4944 "builds. A test that has prerequisite of C<Always> means to run "
4949 #: ../src/guestfs.pod:2560
4951 "In addition, packagers can skip individual tests by setting environment "
4952 "variables before running C<make check>."
4956 #: ../src/guestfs.pod:2563
4959 " SKIP_TEST_<CMD>_<NUM>=1\n"
4964 #: ../src/guestfs.pod:2565
4965 msgid "eg: C<SKIP_TEST_COMMAND_3=1> skips test #3 of L</guestfs_command>."
4969 #: ../src/guestfs.pod:2567
4974 #: ../src/guestfs.pod:2569
4977 " SKIP_TEST_<CMD>=1\n"
4982 #: ../src/guestfs.pod:2571
4983 msgid "eg: C<SKIP_TEST_ZEROFREE=1> skips all L</guestfs_zerofree> tests."
4987 #: ../src/guestfs.pod:2573
4988 msgid "Packagers can run only certain tests by setting for example:"
4992 #: ../src/guestfs.pod:2575
4995 " TEST_ONLY=\"vfs_type zerofree\"\n"
5000 #: ../src/guestfs.pod:2577
5002 "See C<capitests/tests.c> for more details of how these environment variables "
5007 #: ../src/guestfs.pod:2580
5008 msgid "DEBUGGING NEW API ACTIONS"
5012 #: ../src/guestfs.pod:2582
5013 msgid "Test new actions work before submitting them."
5017 #: ../src/guestfs.pod:2584
5018 msgid "You can use guestfish to try out new commands."
5022 #: ../src/guestfs.pod:2586
5024 "Debugging the daemon is a problem because it runs inside a minimal "
5025 "environment. However you can fprintf messages in the daemon to stderr, and "
5026 "they will show up if you use C<guestfish -v>."
5030 #: ../src/guestfs.pod:2590
5031 msgid "FORMATTING CODE AND OTHER CONVENTIONS"
5035 #: ../src/guestfs.pod:2592
5037 "Our C source code generally adheres to some basic code-formatting "
5038 "conventions. The existing code base is not totally consistent on this "
5039 "front, but we do prefer that contributed code be formatted similarly. In "
5040 "short, use spaces-not-TABs for indentation, use 2 spaces for each "
5041 "indentation level, and other than that, follow the K&R style."
5045 #: ../src/guestfs.pod:2598
5047 "If you use Emacs, add the following to one of one of your start-up files (e."
5048 "g., ~/.emacs), to help ensure that you get indentation right:"
5052 #: ../src/guestfs.pod:2601
5055 " ;;; In libguestfs, indent with spaces everywhere (not TABs).\n"
5056 " ;;; Exceptions: Makefile and ChangeLog modes.\n"
5057 " (add-hook 'find-file-hook\n"
5058 " '(lambda () (if (and buffer-file-name\n"
5059 " (string-match \"/libguestfs\\\\>\"\n"
5060 " (buffer-file-name))\n"
5061 " (not (string-equal mode-name \"Change Log\"))\n"
5062 " (not (string-equal mode-name \"Makefile\")))\n"
5063 " (setq indent-tabs-mode nil))))\n"
5068 #: ../src/guestfs.pod:2611
5071 " ;;; When editing C sources in libguestfs, use this style.\n"
5072 " (defun libguestfs-c-mode ()\n"
5073 " \"C mode with adjusted defaults for use with libguestfs.\"\n"
5075 " (c-set-style \"K&R\")\n"
5076 " (setq c-indent-level 2)\n"
5077 " (setq c-basic-offset 2))\n"
5078 " (add-hook 'c-mode-hook\n"
5079 " '(lambda () (if (string-match \"/libguestfs\\\\>\"\n"
5080 " (buffer-file-name))\n"
5081 " (libguestfs-c-mode))))\n"
5086 #: ../src/guestfs.pod:2623
5087 msgid "Enable warnings when compiling (and fix any problems this finds):"
5091 #: ../src/guestfs.pod:2626
5094 " ./configure --enable-gcc-warnings\n"
5099 #: ../src/guestfs.pod:2628
5100 msgid "Useful targets are:"
5104 #: ../src/guestfs.pod:2630
5107 " make syntax-check # checks the syntax of the C code\n"
5108 " make check # runs the test suite\n"
5113 #: ../src/guestfs.pod:2633
5114 msgid "DAEMON CUSTOM PRINTF FORMATTERS"
5118 #: ../src/guestfs.pod:2635
5120 "In the daemon code we have created custom printf formatters C<%Q> and C<%R>, "
5121 "which are used to do shell quoting."
5125 #: ../src/guestfs.pod:2640
5130 #: ../src/guestfs.pod:2642
5132 "Simple shell quoted string. Any spaces or other shell characters are "
5137 #: ../src/guestfs.pod:2645
5142 #: ../src/guestfs.pod:2647
5144 "Same as C<%Q> except the string is treated as a path which is prefixed by "
5149 #: ../src/guestfs.pod:2652 ../fish/guestfish.pod:242 ../fish/guestfish.pod:673
5150 msgid "For example:"
5154 #: ../src/guestfs.pod:2654
5157 " asprintf (&cmd, \"cat %R\", path);\n"
5162 #: ../src/guestfs.pod:2656
5163 msgid "would produce C<cat /sysroot/some\\ path\\ with\\ spaces>"
5167 #: ../src/guestfs.pod:2658
5169 "I<Note:> Do I<not> use these when you are passing parameters to the C<command"
5170 "{,r,v,rv}()> functions. These parameters do NOT need to be quoted because "
5171 "they are not passed via the shell (instead, straight to exec). You probably "
5172 "want to use the C<sysroot_path()> function however."
5176 #: ../src/guestfs.pod:2664
5177 msgid "SUBMITTING YOUR NEW API ACTIONS"
5181 #: ../src/guestfs.pod:2666
5183 "Submit patches to the mailing list: L<http://www.redhat.com/mailman/listinfo/"
5184 "libguestfs> and CC to L<rjones@redhat.com>."
5188 #: ../src/guestfs.pod:2670
5189 msgid "INTERNATIONALIZATION (I18N) SUPPORT"
5193 #: ../src/guestfs.pod:2672
5194 msgid "We support i18n (gettext anyhow) in the library."
5198 #: ../src/guestfs.pod:2674
5200 "However many messages come from the daemon, and we don't translate those at "
5201 "the moment. One reason is that the appliance generally has all locale files "
5202 "removed from it, because they take up a lot of space. So we'd have to readd "
5203 "some of those, as well as copying our PO files into the appliance."
5207 #: ../src/guestfs.pod:2680
5209 "Debugging messages are never translated, since they are intended for the "
5214 #: ../src/guestfs.pod:2683
5215 msgid "SOURCE CODE SUBDIRECTORIES"
5219 #: ../src/guestfs.pod:2687 ../src/guestfs-actions.pod:6174
5220 #: ../fish/guestfish-actions.pod:4072
5221 msgid "C<appliance>"
5222 msgstr "C<appliance>"
5225 #: ../src/guestfs.pod:2689
5226 msgid "The libguestfs appliance, build scripts and so on."
5230 #: ../src/guestfs.pod:2691
5231 msgid "C<capitests>"
5232 msgstr "C<capitests>"
5235 #: ../src/guestfs.pod:2693
5236 msgid "Automated tests of the C API."
5240 #: ../src/guestfs.pod:2695
5245 #: ../src/guestfs.pod:2697
5247 "The L<virt-cat(1)>, L<virt-filesystems(1)> and L<virt-ls(1)> commands and "
5252 #: ../src/guestfs.pod:2700
5259 #: ../src/guestfs.pod:2702
5261 "Safety and liveness tests of components that libguestfs depends upon (not of "
5262 "libguestfs itself). Mainly this is for qemu and the kernel."
5266 #: ../src/guestfs.pod:2705
5271 #: ../src/guestfs.pod:2707
5272 msgid "Outside contributions, experimental parts."
5276 #: ../src/guestfs.pod:2709
5281 #: ../src/guestfs.pod:2711
5283 "The daemon that runs inside the libguestfs appliance and carries out actions."
5287 #: ../src/guestfs.pod:2714
5292 #: ../src/guestfs.pod:2716
5293 msgid "L<virt-df(1)> command and documentation."
5297 #: ../src/guestfs.pod:2718
5302 #: ../src/guestfs.pod:2720
5303 msgid "L<virt-edit(1)> command and documentation."
5307 #: ../src/guestfs.pod:2722
5309 msgstr "C<examples>"
5312 #: ../src/guestfs.pod:2724
5313 msgid "C API example code."
5314 msgstr "Код прикладів використання програмного інтерфейсу мовою C."
5317 #: ../src/guestfs.pod:2726
5322 #: ../src/guestfs.pod:2728
5324 "L<guestfish(1)>, the command-line shell, and various shell scripts built on "
5325 "top such as L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, "
5326 "L<virt-tar-out(1)>."
5330 #: ../src/guestfs.pod:2732
5335 #: ../src/guestfs.pod:2734
5337 "L<guestmount(1)>, FUSE (userspace filesystem) built on top of libguestfs."
5341 #: ../src/guestfs.pod:2736
5342 msgid "C<generator>"
5343 msgstr "C<generator>"
5346 #: ../src/guestfs.pod:2738
5348 "The crucially important generator, used to automatically generate large "
5349 "amounts of boilerplate C code for things like RPC and bindings."
5353 #: ../src/guestfs.pod:2741
5358 #: ../src/guestfs.pod:2743
5359 msgid "Files used by the test suite."
5363 #: ../src/guestfs.pod:2745
5364 msgid "Some \"phony\" guest images which we test against."
5368 #: ../src/guestfs.pod:2747
5369 msgid "C<inspector>"
5370 msgstr "C<inspector>"
5373 #: ../src/guestfs.pod:2749
5374 msgid "L<virt-inspector(1)>, the virtual machine image inspector."
5378 #: ../src/guestfs.pod:2751
5383 #: ../src/guestfs.pod:2753
5384 msgid "Logo used on the website. The fish is called Arthur by the way."
5388 #: ../src/guestfs.pod:2755
5393 #: ../src/guestfs.pod:2757
5394 msgid "M4 macros used by autoconf."
5398 #: ../src/guestfs.pod:2759
5403 #: ../src/guestfs.pod:2761
5404 msgid "Translations of simple gettext strings."
5405 msgstr "Переклади простих рядків gettext."
5408 #: ../src/guestfs.pod:2763
5413 #: ../src/guestfs.pod:2765
5415 "The build infrastructure and PO files for translations of manpages and POD "
5416 "files. Eventually this will be combined with the C<po> directory, but that "
5417 "is rather complicated."
5421 #: ../src/guestfs.pod:2769
5422 msgid "C<regressions>"
5423 msgstr "C<regressions>"
5426 #: ../src/guestfs.pod:2771
5427 msgid "Regression tests."
5428 msgstr "Тести на регресії."
5431 #: ../src/guestfs.pod:2773
5436 #: ../src/guestfs.pod:2775
5437 msgid "L<virt-rescue(1)> command and documentation."
5441 #: ../src/guestfs.pod:2777
5446 #: ../src/guestfs.pod:2779
5447 msgid "Source code to the C library."
5451 #: ../src/guestfs.pod:2781
5456 #: ../src/guestfs.pod:2783
5457 msgid "Command line tools written in Perl (L<virt-resize(1)> and many others)."
5461 #: ../src/guestfs.pod:2785
5462 msgid "C<test-tool>"
5463 msgstr "C<test-tool>"
5466 #: ../src/guestfs.pod:2787
5468 "Test tool for end users to test if their qemu/kernel combination will work "
5473 #: ../src/guestfs.pod:2790
5478 #: ../src/guestfs.pod:2792
5483 #: ../src/guestfs.pod:2794
5488 #: ../src/guestfs.pod:2796
5493 #: ../src/guestfs.pod:2798
5498 #: ../src/guestfs.pod:2800
5503 #: ../src/guestfs.pod:2802
5508 #: ../src/guestfs.pod:2804
5513 #: ../src/guestfs.pod:2806
5514 msgid "Language bindings."
5515 msgstr "Прив’язки до мов програмування."
5518 #: ../src/guestfs.pod:2810
5523 #: ../src/guestfs.pod:2812
5524 msgid "PROTOCOL LIMITS"
5528 #: ../src/guestfs.pod:2814
5530 "Internally libguestfs uses a message-based protocol to pass API calls and "
5531 "their responses to and from a small \"appliance\" (see L</INTERNALS> for "
5532 "plenty more detail about this). The maximum message size used by the "
5533 "protocol is slightly less than 4 MB. For some API calls you may need to be "
5534 "aware of this limit. The API calls which may be affected are individually "
5535 "documented, with a link back to this section of the documentation."
5539 #: ../src/guestfs.pod:2822
5541 "A simple call such as L</guestfs_cat> returns its result (the file data) in "
5542 "a simple string. Because this string is at some point internally encoded as "
5543 "a message, the maximum size that it can return is slightly under 4 MB. If "
5544 "the requested file is larger than this then you will get an error."
5548 #: ../src/guestfs.pod:2828
5550 "In order to transfer large files into and out of the guest filesystem, you "
5551 "need to use particular calls that support this. The sections L</UPLOADING> "
5552 "and L</DOWNLOADING> document how to do this."
5556 #: ../src/guestfs.pod:2832
5558 "You might also consider mounting the disk image using our FUSE filesystem "
5559 "support (L<guestmount(1)>)."
5563 #: ../src/guestfs.pod:2835
5564 msgid "MAXIMUM NUMBER OF DISKS"
5568 #: ../src/guestfs.pod:2837
5569 msgid "When using virtio disks (the default) the current limit is B<25> disks."
5573 #: ../src/guestfs.pod:2840
5575 "Virtio itself consumes 1 virtual PCI slot per disk, and PCI is limited to 31 "
5576 "slots. However febootstrap only understands disks with names C</dev/vda> "
5577 "through C</dev/vdz> (26 letters) and it reserves one disk for its own "
5582 #: ../src/guestfs.pod:2845
5584 "We are working to substantially raise this limit in future versions but it "
5585 "requires complex changes to qemu."
5589 #: ../src/guestfs.pod:2848
5591 "In future versions of libguestfs it should also be possible to \"hot plug\" "
5592 "disks (add and remove disks after calling L</guestfs_launch>). This also "
5593 "requires changes to qemu."
5597 #: ../src/guestfs.pod:2852
5598 msgid "MAXIMUM NUMBER OF PARTITIONS PER DISK"
5602 #: ../src/guestfs.pod:2854
5603 msgid "Virtio limits the maximum number of partitions per disk to B<15>."
5607 #: ../src/guestfs.pod:2856
5609 "This is because it reserves 4 bits for the minor device number (thus C</dev/"
5610 "vda>, and C</dev/vda1> through C</dev/vda15>)."
5614 #: ../src/guestfs.pod:2859
5616 "If you attach a disk with more than 15 partitions, the extra partitions are "
5617 "ignored by libguestfs."
5621 #: ../src/guestfs.pod:2862
5622 msgid "MAXIMUM SIZE OF A DISK"
5626 #: ../src/guestfs.pod:2864
5627 msgid "Probably the limit is between 2**63-1 and 2**64-1 bytes."
5631 #: ../src/guestfs.pod:2866
5633 "We have tested block devices up to 1 exabyte (2**60 or "
5634 "1,152,921,504,606,846,976 bytes) using sparse files backed by an XFS host "
5639 #: ../src/guestfs.pod:2870
5641 "Although libguestfs probably does not impose any limit, the underlying host "
5642 "storage will. If you store disk images on a host ext4 filesystem, then the "
5643 "maximum size will be limited by the maximum ext4 file size (currently 16 "
5644 "TB). If you store disk images as host logical volumes then you are limited "
5645 "by the maximum size of an LV."
5649 #: ../src/guestfs.pod:2876
5651 "For the hugest disk image files, we recommend using XFS on the host for "
5656 #: ../src/guestfs.pod:2879
5657 msgid "MAXIMUM SIZE OF A PARTITION"
5661 #: ../src/guestfs.pod:2881
5663 "The MBR (ie. classic MS-DOS) partitioning scheme uses 32 bit sector "
5664 "numbers. Assuming a 512 byte sector size, this means that MBR cannot "
5665 "address a partition located beyond 2 TB on the disk."
5669 #: ../src/guestfs.pod:2885
5671 "It is recommended that you use GPT partitions on disks which are larger than "
5672 "this size. GPT uses 64 bit sector numbers and so can address partitions "
5673 "which are theoretically larger than the largest disk we could support."
5677 #: ../src/guestfs.pod:2890
5678 msgid "MAXIMUM SIZE OF A FILESYSTEM, FILES, DIRECTORIES"
5682 #: ../src/guestfs.pod:2892
5684 "This depends on the filesystem type. libguestfs itself does not impose any "
5685 "known limit. Consult Wikipedia or the filesystem documentation to find out "
5686 "what these limits are."
5690 #: ../src/guestfs.pod:2896
5691 msgid "MAXIMUM UPLOAD AND DOWNLOAD"
5695 #: ../src/guestfs.pod:2898
5697 "The API functions L</guestfs_upload>, L</guestfs_download>, L</"
5698 "guestfs_tar_in>, L</guestfs_tar_out> and the like allow unlimited sized "
5699 "uploads and downloads."
5703 #: ../src/guestfs.pod:2902
5705 #| msgid "INSPECTION"
5706 msgid "INSPECTION LIMITS"
5710 #: ../src/guestfs.pod:2904
5712 "The inspection code has several arbitrary limits on things like the size of "
5713 "Windows Registry hive it will read, and the length of product name. These "
5714 "are intended to stop a malicious guest from consuming arbitrary amounts of "
5715 "memory and disk space on the host, and should not be reached in practice. "
5716 "See the source code for more information."
5720 #: ../src/guestfs.pod:2910 ../fish/guestfish.pod:1075
5721 #: ../test-tool/libguestfs-test-tool.pod:82
5722 msgid "ENVIRONMENT VARIABLES"
5723 msgstr "ЗМІННІ СЕРЕДОВИЩА"
5726 #: ../src/guestfs.pod:2914 ../fish/guestfish.pod:1106
5727 msgid "LIBGUESTFS_APPEND"
5731 #: ../src/guestfs.pod:2916 ../fish/guestfish.pod:1108
5732 msgid "Pass additional options to the guest kernel."
5736 #: ../src/guestfs.pod:2918 ../fish/guestfish.pod:1110
5737 msgid "LIBGUESTFS_DEBUG"
5741 #: ../src/guestfs.pod:2920
5743 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
5744 "effect as calling C<guestfs_set_verbose (g, 1)>."
5748 #: ../src/guestfs.pod:2923 ../fish/guestfish.pod:1115
5749 msgid "LIBGUESTFS_MEMSIZE"
5753 #: ../src/guestfs.pod:2925 ../fish/guestfish.pod:1117
5755 "Set the memory allocated to the qemu process, in megabytes. For example:"
5759 #: ../src/guestfs.pod:2928 ../fish/guestfish.pod:1120
5762 " LIBGUESTFS_MEMSIZE=700\n"
5767 #: ../src/guestfs.pod:2930 ../fish/guestfish.pod:1122
5768 msgid "LIBGUESTFS_PATH"
5772 #: ../src/guestfs.pod:2932
5774 "Set the path that libguestfs uses to search for a supermin appliance. See "
5775 "the discussion of paths in section L</PATH> above."
5779 #: ../src/guestfs.pod:2935 ../fish/guestfish.pod:1127
5780 msgid "LIBGUESTFS_QEMU"
5784 #: ../src/guestfs.pod:2937 ../fish/guestfish.pod:1129
5786 "Set the default qemu binary that libguestfs uses. If not set, then the qemu "
5787 "which was found at compile time by the configure script is used."
5791 #: ../src/guestfs.pod:2941
5792 msgid "See also L</QEMU WRAPPERS> above."
5796 #: ../src/guestfs.pod:2943 ../fish/guestfish.pod:1133
5797 msgid "LIBGUESTFS_TRACE"
5801 #: ../src/guestfs.pod:2945
5803 "Set C<LIBGUESTFS_TRACE=1> to enable command traces. This has the same "
5804 "effect as calling C<guestfs_set_trace (g, 1)>."
5808 #: ../src/guestfs.pod:2948 ../fish/guestfish.pod:1142
5813 #: ../src/guestfs.pod:2950 ../fish/guestfish.pod:1144
5815 "Location of temporary directory, defaults to C</tmp> except for the cached "
5816 "supermin appliance which defaults to C</var/tmp>."
5820 #: ../src/guestfs.pod:2953 ../fish/guestfish.pod:1147
5822 "If libguestfs was compiled to use the supermin appliance then the real "
5823 "appliance is cached in this directory, shared between all handles belonging "
5824 "to the same EUID. You can use C<$TMPDIR> to configure another directory to "
5825 "use in case C</var/tmp> is not large enough."
5829 #: ../src/guestfs.pod:2961 ../fish/guestfish.pod:1214
5830 #: ../test-tool/libguestfs-test-tool.pod:87 ../fuse/guestmount.pod:279
5831 #: ../tools/virt-win-reg.pl:744 ../tools/virt-list-filesystems.pl:189
5832 #: ../tools/virt-tar.pl:286 ../tools/virt-make-fs.pl:539
5833 #: ../tools/virt-list-partitions.pl:257
5835 msgstr "ТАКОЖ ПЕРЕГЛЯНЬТЕ"
5838 #: ../src/guestfs.pod:2963
5840 "L<guestfs-examples(3)>, L<guestfs-ocaml(3)>, L<guestfs-python(3)>, L<guestfs-"
5841 "ruby(3)>, L<guestfish(1)>, L<guestmount(1)>, L<virt-cat(1)>, L<virt-copy-in"
5842 "(1)>, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, L<virt-filesystems"
5843 "(1)>, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, L<virt-list-"
5844 "partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, L<virt-rescue(1)>, L<virt-"
5845 "tar(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<virt-win-reg(1)>, L<qemu(1)"
5846 ">, L<febootstrap(1)>, L<hivex(3)>, L<http://libguestfs.org/>."
5850 #: ../src/guestfs.pod:2990
5852 "Tools with a similar purpose: L<fdisk(8)>, L<parted(8)>, L<kpartx(8)>, L<lvm"
5853 "(8)>, L<disktype(1)>."
5857 #: ../src/guestfs.pod:2997 ../tools/virt-win-reg.pl:759
5858 #: ../tools/virt-make-fs.pl:553
5863 #: ../src/guestfs.pod:2999
5864 msgid "To get a list of bugs against libguestfs use this link:"
5866 "Щоб переглянути список відомих вад у libguestfs, скористайтеся таким "
5870 #: ../src/guestfs.pod:3001
5872 "L<https://bugzilla.redhat.com/buglist.cgi?"
5873 "component=libguestfs&product=Virtualization+Tools>"
5875 "L<https://bugzilla.redhat.com/buglist.cgi?"
5876 "component=libguestfs&product=Virtualization+Tools>"
5879 #: ../src/guestfs.pod:3003
5880 msgid "To report a new bug against libguestfs use this link:"
5881 msgstr "Для звітування щодо вад у libguestfs скористайтеся цим посиланням:"
5884 #: ../src/guestfs.pod:3005
5886 "L<https://bugzilla.redhat.com/enter_bug.cgi?"
5887 "component=libguestfs&product=Virtualization+Tools>"
5889 "L<https://bugzilla.redhat.com/enter_bug.cgi?"
5890 "component=libguestfs&product=Virtualization+Tools>"
5893 #: ../src/guestfs.pod:3007
5894 msgid "When reporting a bug, please check:"
5898 #: ../src/guestfs.pod:3013
5899 msgid "That the bug hasn't been reported already."
5903 #: ../src/guestfs.pod:3017
5904 msgid "That you are testing a recent version."
5908 #: ../src/guestfs.pod:3021
5909 msgid "Describe the bug accurately, and give a way to reproduce it."
5913 #: ../src/guestfs.pod:3025
5915 "Run libguestfs-test-tool and paste the B<complete, unedited> output into the "
5920 #: ../src/guestfs.pod:3030 ../fish/guestfish.pod:1238
5921 #: ../test-tool/libguestfs-test-tool.pod:93 ../fuse/guestmount.pod:290
5926 #: ../src/guestfs.pod:3032 ../fish/guestfish.pod:1240
5927 #: ../test-tool/libguestfs-test-tool.pod:95 ../fuse/guestmount.pod:292
5928 msgid "Richard W.M. Jones (C<rjones at redhat dot com>)"
5932 #: ../src/guestfs.pod:3034 ../fish/guestfish.pod:1242
5933 #: ../test-tool/libguestfs-test-tool.pod:97 ../fuse/guestmount.pod:294
5934 #: ../tools/virt-win-reg.pl:774 ../tools/virt-list-filesystems.pl:206
5935 #: ../tools/virt-tar.pl:305 ../tools/virt-make-fs.pl:568
5936 #: ../tools/virt-list-partitions.pl:273
5938 msgstr "АВТОРСЬКІ ПРАВА"
5941 #: ../src/guestfs.pod:3036 ../fish/guestfish.pod:1244
5942 #: ../test-tool/libguestfs-test-tool.pod:99
5943 msgid "Copyright (C) 2009-2011 Red Hat Inc. L<http://libguestfs.org/>"
5947 #: ../src/guestfs.pod:3039
5949 "This library is free software; you can redistribute it and/or modify it "
5950 "under the terms of the GNU Lesser General Public License as published by the "
5951 "Free Software Foundation; either version 2 of the License, or (at your "
5952 "option) any later version."
5956 #: ../src/guestfs.pod:3044
5958 "This library is distributed in the hope that it will be useful, but WITHOUT "
5959 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
5960 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License "
5965 #: ../src/guestfs.pod:3049
5967 "You should have received a copy of the GNU Lesser General Public License "
5968 "along with this library; if not, write to the Free Software Foundation, "
5969 "Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA"
5973 #: ../src/guestfs-actions.pod:1
5974 msgid "guestfs_add_cdrom"
5978 #: ../src/guestfs-actions.pod:3
5982 " guestfs_add_cdrom (guestfs_h *g,\n"
5983 " const char *filename);\n"
5988 #: ../src/guestfs-actions.pod:7 ../fish/guestfish-actions.pod:5
5989 msgid "This function adds a virtual CD-ROM disk image to the guest."
5993 #: ../src/guestfs-actions.pod:9 ../fish/guestfish-actions.pod:7
5994 msgid "This is equivalent to the qemu parameter I<-cdrom filename>."
5998 #: ../src/guestfs-actions.pod:17
6000 "This call checks for the existence of C<filename>. This stops you from "
6001 "specifying other types of drive which are supported by qemu such as C<nbd:> "
6002 "and C<http:> URLs. To specify those, use the general C<guestfs_config> call "
6007 #: ../src/guestfs-actions.pod:24
6009 "If you just want to add an ISO file (often you use this as an efficient way "
6010 "to transfer large files into the guest), then you should probably use "
6011 "C<guestfs_add_drive_ro> instead."
6015 #: ../src/guestfs-actions.pod:30 ../src/guestfs-actions.pod:140
6016 #: ../src/guestfs-actions.pod:201 ../src/guestfs-actions.pod:238
6017 #: ../src/guestfs-actions.pod:252 ../src/guestfs-actions.pod:273
6018 #: ../src/guestfs-actions.pod:293 ../src/guestfs-actions.pod:307
6019 #: ../src/guestfs-actions.pod:422 ../src/guestfs-actions.pod:442
6020 #: ../src/guestfs-actions.pod:456 ../src/guestfs-actions.pod:501
6021 #: ../src/guestfs-actions.pod:529 ../src/guestfs-actions.pod:547
6022 #: ../src/guestfs-actions.pod:614 ../src/guestfs-actions.pod:647
6023 #: ../src/guestfs-actions.pod:661 ../src/guestfs-actions.pod:676
6024 #: ../src/guestfs-actions.pod:775 ../src/guestfs-actions.pod:793
6025 #: ../src/guestfs-actions.pod:807 ../src/guestfs-actions.pod:821
6026 #: ../src/guestfs-actions.pod:858 ../src/guestfs-actions.pod:1041
6027 #: ../src/guestfs-actions.pod:1061 ../src/guestfs-actions.pod:1079
6028 #: ../src/guestfs-actions.pod:1163 ../src/guestfs-actions.pod:1181
6029 #: ../src/guestfs-actions.pod:1200 ../src/guestfs-actions.pod:1214
6030 #: ../src/guestfs-actions.pod:1234 ../src/guestfs-actions.pod:1304
6031 #: ../src/guestfs-actions.pod:1335 ../src/guestfs-actions.pod:1360
6032 #: ../src/guestfs-actions.pod:1402 ../src/guestfs-actions.pod:1508
6033 #: ../src/guestfs-actions.pod:1542 ../src/guestfs-actions.pod:1757
6034 #: ../src/guestfs-actions.pod:1779 ../src/guestfs-actions.pod:1866
6035 #: ../src/guestfs-actions.pod:2339 ../src/guestfs-actions.pod:2483
6036 #: ../src/guestfs-actions.pod:2544 ../src/guestfs-actions.pod:2579
6037 #: ../src/guestfs-actions.pod:3619 ../src/guestfs-actions.pod:3634
6038 #: ../src/guestfs-actions.pod:3659 ../src/guestfs-actions.pod:3848
6039 #: ../src/guestfs-actions.pod:3862 ../src/guestfs-actions.pod:3875
6040 #: ../src/guestfs-actions.pod:3889 ../src/guestfs-actions.pod:3904
6041 #: ../src/guestfs-actions.pod:3940 ../src/guestfs-actions.pod:4012
6042 #: ../src/guestfs-actions.pod:4032 ../src/guestfs-actions.pod:4049
6043 #: ../src/guestfs-actions.pod:4072 ../src/guestfs-actions.pod:4095
6044 #: ../src/guestfs-actions.pod:4130 ../src/guestfs-actions.pod:4149
6045 #: ../src/guestfs-actions.pod:4168 ../src/guestfs-actions.pod:4203
6046 #: ../src/guestfs-actions.pod:4215 ../src/guestfs-actions.pod:4251
6047 #: ../src/guestfs-actions.pod:4267 ../src/guestfs-actions.pod:4280
6048 #: ../src/guestfs-actions.pod:4295 ../src/guestfs-actions.pod:4312
6049 #: ../src/guestfs-actions.pod:4405 ../src/guestfs-actions.pod:4425
6050 #: ../src/guestfs-actions.pod:4438 ../src/guestfs-actions.pod:4489
6051 #: ../src/guestfs-actions.pod:4507 ../src/guestfs-actions.pod:4525
6052 #: ../src/guestfs-actions.pod:4541 ../src/guestfs-actions.pod:4555
6053 #: ../src/guestfs-actions.pod:4569 ../src/guestfs-actions.pod:4586
6054 #: ../src/guestfs-actions.pod:4601 ../src/guestfs-actions.pod:4621
6055 #: ../src/guestfs-actions.pod:4691 ../src/guestfs-actions.pod:4764
6056 #: ../src/guestfs-actions.pod:4795 ../src/guestfs-actions.pod:4814
6057 #: ../src/guestfs-actions.pod:4833 ../src/guestfs-actions.pod:4845
6058 #: ../src/guestfs-actions.pod:4862 ../src/guestfs-actions.pod:4875
6059 #: ../src/guestfs-actions.pod:4890 ../src/guestfs-actions.pod:4905
6060 #: ../src/guestfs-actions.pod:4940 ../src/guestfs-actions.pod:4973
6061 #: ../src/guestfs-actions.pod:5012 ../src/guestfs-actions.pod:5032
6062 #: ../src/guestfs-actions.pod:5046 ../src/guestfs-actions.pod:5063
6063 #: ../src/guestfs-actions.pod:5112 ../src/guestfs-actions.pod:5158
6064 #: ../src/guestfs-actions.pod:5212 ../src/guestfs-actions.pod:5248
6065 #: ../src/guestfs-actions.pod:5283 ../src/guestfs-actions.pod:5300
6066 #: ../src/guestfs-actions.pod:5318 ../src/guestfs-actions.pod:5452
6067 #: ../src/guestfs-actions.pod:5509 ../src/guestfs-actions.pod:5531
6068 #: ../src/guestfs-actions.pod:5549 ../src/guestfs-actions.pod:5581
6069 #: ../src/guestfs-actions.pod:5647 ../src/guestfs-actions.pod:5664
6070 #: ../src/guestfs-actions.pod:5677 ../src/guestfs-actions.pod:5691
6071 #: ../src/guestfs-actions.pod:5980 ../src/guestfs-actions.pod:5999
6072 #: ../src/guestfs-actions.pod:6018 ../src/guestfs-actions.pod:6032
6073 #: ../src/guestfs-actions.pod:6044 ../src/guestfs-actions.pod:6058
6074 #: ../src/guestfs-actions.pod:6070 ../src/guestfs-actions.pod:6084
6075 #: ../src/guestfs-actions.pod:6100 ../src/guestfs-actions.pod:6121
6076 #: ../src/guestfs-actions.pod:6140 ../src/guestfs-actions.pod:6159
6077 #: ../src/guestfs-actions.pod:6189 ../src/guestfs-actions.pod:6207
6078 #: ../src/guestfs-actions.pod:6230 ../src/guestfs-actions.pod:6248
6079 #: ../src/guestfs-actions.pod:6267 ../src/guestfs-actions.pod:6288
6080 #: ../src/guestfs-actions.pod:6307 ../src/guestfs-actions.pod:6324
6081 #: ../src/guestfs-actions.pod:6343 ../src/guestfs-actions.pod:6369
6082 #: ../src/guestfs-actions.pod:6393 ../src/guestfs-actions.pod:6412
6083 #: ../src/guestfs-actions.pod:6436 ../src/guestfs-actions.pod:6455
6084 #: ../src/guestfs-actions.pod:6470 ../src/guestfs-actions.pod:6489
6085 #: ../src/guestfs-actions.pod:6526 ../src/guestfs-actions.pod:6556
6086 #: ../src/guestfs-actions.pod:6589 ../src/guestfs-actions.pod:6711
6087 #: ../src/guestfs-actions.pod:6832 ../src/guestfs-actions.pod:6844
6088 #: ../src/guestfs-actions.pod:6857 ../src/guestfs-actions.pod:6870
6089 #: ../src/guestfs-actions.pod:6892 ../src/guestfs-actions.pod:6905
6090 #: ../src/guestfs-actions.pod:6918 ../src/guestfs-actions.pod:6931
6091 #: ../src/guestfs-actions.pod:6946 ../src/guestfs-actions.pod:7005
6092 #: ../src/guestfs-actions.pod:7022 ../src/guestfs-actions.pod:7038
6093 #: ../src/guestfs-actions.pod:7054 ../src/guestfs-actions.pod:7071
6094 #: ../src/guestfs-actions.pod:7084 ../src/guestfs-actions.pod:7104
6095 #: ../src/guestfs-actions.pod:7140 ../src/guestfs-actions.pod:7154
6096 #: ../src/guestfs-actions.pod:7195 ../src/guestfs-actions.pod:7208
6097 #: ../src/guestfs-actions.pod:7226 ../src/guestfs-actions.pod:7260
6098 #: ../src/guestfs-actions.pod:7296 ../src/guestfs-actions.pod:7412
6099 #: ../src/guestfs-actions.pod:7427 ../src/guestfs-actions.pod:7441
6100 #: ../src/guestfs-actions.pod:7496 ../src/guestfs-actions.pod:7509
6101 #: ../src/guestfs-actions.pod:7554 ../src/guestfs-actions.pod:7587
6102 #: ../src/guestfs-actions.pod:7650 ../src/guestfs-actions.pod:7670
6103 #: ../src/guestfs-actions.pod:7694 ../src/guestfs-actions.pod:7761
6104 #: ../src/guestfs-actions.pod:7780 ../src/guestfs-actions.pod:7809
6105 msgid "This function returns 0 on success or -1 on error."
6109 #: ../src/guestfs-actions.pod:32 ../src/guestfs-actions.pod:254
6110 #: ../src/guestfs-actions.pod:275 ../fish/guestfish-actions.pod:28
6111 #: ../fish/guestfish-actions.pod:163 ../fish/guestfish-actions.pod:177
6113 "This function is deprecated. In new code, use the C<add_drive_opts> call "
6118 #: ../src/guestfs-actions.pod:35 ../src/guestfs-actions.pod:257
6119 #: ../src/guestfs-actions.pod:278 ../src/guestfs-actions.pod:1513
6120 #: ../src/guestfs-actions.pod:2008 ../src/guestfs-actions.pod:2029
6121 #: ../src/guestfs-actions.pod:4626 ../src/guestfs-actions.pod:4945
6122 #: ../src/guestfs-actions.pod:5163 ../src/guestfs-actions.pod:5253
6123 #: ../src/guestfs-actions.pod:6534 ../src/guestfs-actions.pod:6564
6124 #: ../src/guestfs-actions.pod:6597 ../src/guestfs-actions.pod:6656
6125 #: ../src/guestfs-actions.pod:7592 ../src/guestfs-actions.pod:7702
6126 #: ../src/guestfs-actions.pod:7872 ../fish/guestfish-actions.pod:31
6127 #: ../fish/guestfish-actions.pod:166 ../fish/guestfish-actions.pod:180
6128 #: ../fish/guestfish-actions.pod:986 ../fish/guestfish-actions.pod:1346
6129 #: ../fish/guestfish-actions.pod:1360 ../fish/guestfish-actions.pod:3085
6130 #: ../fish/guestfish-actions.pod:3292 ../fish/guestfish-actions.pod:3406
6131 #: ../fish/guestfish-actions.pod:3454 ../fish/guestfish-actions.pod:4349
6132 #: ../fish/guestfish-actions.pod:4372 ../fish/guestfish-actions.pod:4394
6133 #: ../fish/guestfish-actions.pod:4432 ../fish/guestfish-actions.pod:5081
6134 #: ../fish/guestfish-actions.pod:5179
6136 "Deprecated functions will not be removed from the API, but the fact that "
6137 "they are deprecated indicates that there are problems with correct use of "
6142 #: ../src/guestfs-actions.pod:39 ../src/guestfs-actions.pod:142
6143 #: ../src/guestfs-actions.pod:1165 ../src/guestfs-actions.pod:1980
6144 #: ../src/guestfs-actions.pod:2078 ../src/guestfs-actions.pod:2190
6145 #: ../src/guestfs-actions.pod:3621 ../src/guestfs-actions.pod:3641
6146 #: ../src/guestfs-actions.pod:4949 ../src/guestfs-actions.pod:6209
6147 #: ../src/guestfs-actions.pod:6326 ../src/guestfs-actions.pod:6457
6148 #: ../src/guestfs-actions.pod:6948 ../src/guestfs-actions.pod:7073
6149 #: ../src/guestfs-actions.pod:7596
6150 msgid "(Added in 0.3)"
6154 #: ../src/guestfs-actions.pod:41
6155 msgid "guestfs_add_domain"
6159 #: ../src/guestfs-actions.pod:43
6163 " guestfs_add_domain (guestfs_h *g,\n"
6164 " const char *dom,\n"
6170 #: ../src/guestfs-actions.pod:48 ../src/guestfs-actions.pod:151
6171 #: ../src/guestfs-actions.pod:832 ../src/guestfs-actions.pod:2824
6172 #: ../src/guestfs-actions.pod:4640 ../src/guestfs-actions.pod:4959
6173 #: ../src/guestfs-actions.pod:5176
6175 "You may supply a list of optional arguments to this call. Use zero or more "
6176 "of the following pairs of parameters, and terminate the list with C<-1> on "
6177 "its own. See L</CALLS WITH OPTIONAL ARGUMENTS>."
6181 #: ../src/guestfs-actions.pod:53
6184 " GUESTFS_ADD_DOMAIN_LIBVIRTURI, const char *libvirturi,\n"
6185 " GUESTFS_ADD_DOMAIN_READONLY, int readonly,\n"
6186 " GUESTFS_ADD_DOMAIN_IFACE, const char *iface,\n"
6187 " GUESTFS_ADD_DOMAIN_LIVE, int live,\n"
6188 " GUESTFS_ADD_DOMAIN_ALLOWUUID, int allowuuid,\n"
6193 #: ../src/guestfs-actions.pod:59
6195 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
6196 "It works by connecting to libvirt, requesting the domain and domain XML from "
6197 "libvirt, parsing it for disks, and calling C<guestfs_add_drive_opts> on each "
6202 #: ../src/guestfs-actions.pod:64 ../fish/guestfish-actions.pod:46
6204 "The number of disks added is returned. This operation is atomic: if an "
6205 "error is returned, then no disks are added."
6209 #: ../src/guestfs-actions.pod:67 ../fish/guestfish-actions.pod:49
6211 "This function does some minimal checks to make sure the libvirt domain is "
6212 "not running (unless C<readonly> is true). In a future version we will try "
6213 "to acquire the libvirt lock on each disk."
6217 #: ../src/guestfs-actions.pod:71 ../fish/guestfish-actions.pod:53
6219 "Disks must be accessible locally. This often means that adding disks from a "
6220 "remote libvirt connection (see L<http://libvirt.org/remote.html>) will fail "
6221 "unless those disks are accessible via the same device path locally too."
6225 #: ../src/guestfs-actions.pod:76 ../fish/guestfish-actions.pod:58
6227 "The optional C<libvirturi> parameter sets the libvirt URI (see L<http://"
6228 "libvirt.org/uri.html>). If this is not set then we connect to the default "
6229 "libvirt URI (or one set through an environment variable, see the libvirt "
6230 "documentation for full details)."
6234 #: ../src/guestfs-actions.pod:82 ../fish/guestfish-actions.pod:64
6236 "The optional C<live> flag controls whether this call will try to connect to "
6237 "a running virtual machine C<guestfsd> process if it sees a suitable "
6238 "E<lt>channelE<gt> element in the libvirt XML definition. The default (if "
6239 "the flag is omitted) is never to try. See L<guestfs(3)/ATTACHING TO RUNNING "
6240 "DAEMONS> for more information."
6244 #: ../src/guestfs-actions.pod:89 ../fish/guestfish-actions.pod:71
6246 "If the C<allowuuid> flag is true (default is false) then a UUID I<may> be "
6247 "passed instead of the domain name. The C<dom> string is treated as a UUID "
6248 "first and looked up, and if that lookup fails then we treat C<dom> as a name "
6253 #: ../src/guestfs-actions.pod:94
6255 "The other optional parameters are passed directly through to "
6256 "C<guestfs_add_drive_opts>."
6260 #: ../src/guestfs-actions.pod:97 ../src/guestfs-actions.pod:350
6261 #: ../src/guestfs-actions.pod:515 ../src/guestfs-actions.pod:693
6262 #: ../src/guestfs-actions.pod:724 ../src/guestfs-actions.pod:742
6263 #: ../src/guestfs-actions.pod:761 ../src/guestfs-actions.pod:1380
6264 #: ../src/guestfs-actions.pod:1736 ../src/guestfs-actions.pod:1939
6265 #: ../src/guestfs-actions.pod:2050 ../src/guestfs-actions.pod:2099
6266 #: ../src/guestfs-actions.pod:2154 ../src/guestfs-actions.pod:2177
6267 #: ../src/guestfs-actions.pod:2470 ../src/guestfs-actions.pod:2942
6268 #: ../src/guestfs-actions.pod:2960 ../src/guestfs-actions.pod:5135
6269 #: ../src/guestfs-actions.pod:5355 ../src/guestfs-actions.pod:5761
6270 #: ../src/guestfs-actions.pod:5787 ../src/guestfs-actions.pod:7181
6271 #: ../src/guestfs-actions.pod:7607 ../src/guestfs-actions.pod:7620
6272 #: ../src/guestfs-actions.pod:7633
6273 msgid "On error this function returns -1."
6277 #: ../src/guestfs-actions.pod:99
6278 msgid "(Added in 1.7.4)"
6282 #: ../src/guestfs-actions.pod:101
6283 msgid "guestfs_add_domain_va"
6287 #: ../src/guestfs-actions.pod:103
6291 " guestfs_add_domain_va (guestfs_h *g,\n"
6292 " const char *dom,\n"
6298 #: ../src/guestfs-actions.pod:108
6299 msgid "This is the \"va_list variant\" of L</guestfs_add_domain>."
6303 #: ../src/guestfs-actions.pod:110 ../src/guestfs-actions.pod:121
6304 #: ../src/guestfs-actions.pod:214 ../src/guestfs-actions.pod:225
6305 #: ../src/guestfs-actions.pod:871 ../src/guestfs-actions.pod:882
6306 #: ../src/guestfs-actions.pod:2908 ../src/guestfs-actions.pod:2920
6307 #: ../src/guestfs-actions.pod:4705 ../src/guestfs-actions.pod:4717
6308 #: ../src/guestfs-actions.pod:4987 ../src/guestfs-actions.pod:4999
6309 #: ../src/guestfs-actions.pod:5225 ../src/guestfs-actions.pod:5236
6310 msgid "See L</CALLS WITH OPTIONAL ARGUMENTS>."
6314 #: ../src/guestfs-actions.pod:112
6315 msgid "guestfs_add_domain_argv"
6319 #: ../src/guestfs-actions.pod:114
6323 " guestfs_add_domain_argv (guestfs_h *g,\n"
6324 " const char *dom,\n"
6325 " const struct guestfs_add_domain_argv *optargs);\n"
6330 #: ../src/guestfs-actions.pod:119
6331 msgid "This is the \"argv variant\" of L</guestfs_add_domain>."
6335 #: ../src/guestfs-actions.pod:123
6336 msgid "guestfs_add_drive"
6340 #: ../src/guestfs-actions.pod:125
6344 " guestfs_add_drive (guestfs_h *g,\n"
6345 " const char *filename);\n"
6350 #: ../src/guestfs-actions.pod:129
6352 "This function is the equivalent of calling C<guestfs_add_drive_opts> with no "
6353 "optional parameters, so the disk is added writable, with the format being "
6354 "detected automatically."
6358 #: ../src/guestfs-actions.pod:133
6360 "Automatic detection of the format opens you up to a potential security hole "
6361 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
6362 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
6363 "you should think about replacing calls to this function with calls to "
6364 "C<guestfs_add_drive_opts>, and specifying the format."
6368 #: ../src/guestfs-actions.pod:144
6369 msgid "guestfs_add_drive_opts"
6373 #: ../src/guestfs-actions.pod:146
6377 " guestfs_add_drive_opts (guestfs_h *g,\n"
6378 " const char *filename,\n"
6384 #: ../src/guestfs-actions.pod:156
6387 " GUESTFS_ADD_DRIVE_OPTS_READONLY, int readonly,\n"
6388 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, const char *format,\n"
6389 " GUESTFS_ADD_DRIVE_OPTS_IFACE, const char *iface,\n"
6394 #: ../src/guestfs-actions.pod:160 ../fish/guestfish-actions.pod:102
6396 "This function adds a virtual machine disk image C<filename> to libguestfs. "
6397 "The first time you call this function, the disk appears as C</dev/sda>, the "
6398 "second time as C</dev/sdb>, and so on."
6402 #: ../src/guestfs-actions.pod:165 ../fish/guestfish-actions.pod:107
6404 "You don't necessarily need to be root when using libguestfs. However you "
6405 "obviously do need sufficient permissions to access the filename for whatever "
6406 "operations you want to perform (ie. read access if you just want to read the "
6407 "image or write access if you want to modify the image)."
6411 #: ../src/guestfs-actions.pod:171 ../fish/guestfish-actions.pod:113
6412 msgid "This call checks that C<filename> exists."
6416 #: ../src/guestfs-actions.pod:173 ../src/guestfs-actions.pod:4653
6417 #: ../fish/guestfish-actions.pod:115 ../fish/guestfish-actions.pod:3096
6418 msgid "The optional arguments are:"
6422 #: ../src/guestfs-actions.pod:177 ../fish/guestfish-actions.pod:119
6424 msgstr "C<readonly>"
6427 #: ../src/guestfs-actions.pod:179 ../fish/guestfish-actions.pod:121
6429 "If true then the image is treated as read-only. Writes are still allowed, "
6430 "but they are stored in a temporary snapshot overlay which is discarded at "
6431 "the end. The disk that you add is not modified."
6435 #: ../src/guestfs-actions.pod:183 ../fish/guestfish-actions.pod:125
6440 #: ../src/guestfs-actions.pod:185
6442 "This forces the image format. If you omit this (or use C<guestfs_add_drive> "
6443 "or C<guestfs_add_drive_ro>) then the format is automatically detected. "
6444 "Possible formats include C<raw> and C<qcow2>."
6448 #: ../src/guestfs-actions.pod:189 ../fish/guestfish-actions.pod:131
6450 "Automatic detection of the format opens you up to a potential security hole "
6451 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
6452 "RHBZ#642934. Specifying the format closes this security hole."
6456 #: ../src/guestfs-actions.pod:194 ../fish/guestfish-actions.pod:136
6461 #: ../src/guestfs-actions.pod:196
6463 "This rarely-used option lets you emulate the behaviour of the deprecated "
6464 "C<guestfs_add_drive_with_if> call (q.v.)"
6468 #: ../src/guestfs-actions.pod:203
6469 msgid "(Added in 1.5.23)"
6473 #: ../src/guestfs-actions.pod:205
6474 msgid "guestfs_add_drive_opts_va"
6478 #: ../src/guestfs-actions.pod:207
6482 " guestfs_add_drive_opts_va (guestfs_h *g,\n"
6483 " const char *filename,\n"
6489 #: ../src/guestfs-actions.pod:212
6490 msgid "This is the \"va_list variant\" of L</guestfs_add_drive_opts>."
6494 #: ../src/guestfs-actions.pod:216
6495 msgid "guestfs_add_drive_opts_argv"
6499 #: ../src/guestfs-actions.pod:218
6503 " guestfs_add_drive_opts_argv (guestfs_h *g,\n"
6504 " const char *filename,\n"
6505 " const struct guestfs_add_drive_opts_argv *optargs);\n"
6510 #: ../src/guestfs-actions.pod:223
6511 msgid "This is the \"argv variant\" of L</guestfs_add_drive_opts>."
6515 #: ../src/guestfs-actions.pod:227
6516 msgid "guestfs_add_drive_ro"
6520 #: ../src/guestfs-actions.pod:229
6524 " guestfs_add_drive_ro (guestfs_h *g,\n"
6525 " const char *filename);\n"
6530 #: ../src/guestfs-actions.pod:233
6532 "This function is the equivalent of calling C<guestfs_add_drive_opts> with "
6533 "the optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the "
6534 "disk is added read-only, with the format being detected automatically."
6538 #: ../src/guestfs-actions.pod:240
6539 msgid "(Added in 1.0.38)"
6543 #: ../src/guestfs-actions.pod:242
6544 msgid "guestfs_add_drive_ro_with_if"
6548 #: ../src/guestfs-actions.pod:244
6552 " guestfs_add_drive_ro_with_if (guestfs_h *g,\n"
6553 " const char *filename,\n"
6554 " const char *iface);\n"
6559 #: ../src/guestfs-actions.pod:249
6561 "This is the same as C<guestfs_add_drive_ro> but it allows you to specify the "
6562 "QEMU interface emulation to use at run time."
6566 #: ../src/guestfs-actions.pod:261 ../src/guestfs-actions.pod:282
6567 #: ../src/guestfs-actions.pod:2429
6568 msgid "(Added in 1.0.84)"
6572 #: ../src/guestfs-actions.pod:263
6573 msgid "guestfs_add_drive_with_if"
6577 #: ../src/guestfs-actions.pod:265
6581 " guestfs_add_drive_with_if (guestfs_h *g,\n"
6582 " const char *filename,\n"
6583 " const char *iface);\n"
6588 #: ../src/guestfs-actions.pod:270
6590 "This is the same as C<guestfs_add_drive> but it allows you to specify the "
6591 "QEMU interface emulation to use at run time."
6595 #: ../src/guestfs-actions.pod:284
6596 msgid "guestfs_aug_clear"
6600 #: ../src/guestfs-actions.pod:286
6604 " guestfs_aug_clear (guestfs_h *g,\n"
6605 " const char *augpath);\n"
6610 #: ../src/guestfs-actions.pod:290 ../fish/guestfish-actions.pod:188
6612 "Set the value associated with C<path> to C<NULL>. This is the same as the "
6613 "L<augtool(1)> C<clear> command."
6617 #: ../src/guestfs-actions.pod:295 ../src/guestfs-actions.pod:2179
6618 msgid "(Added in 1.3.4)"
6622 #: ../src/guestfs-actions.pod:297
6623 msgid "guestfs_aug_close"
6627 #: ../src/guestfs-actions.pod:299
6631 " guestfs_aug_close (guestfs_h *g);\n"
6636 #: ../src/guestfs-actions.pod:302
6638 "Close the current Augeas handle and free up any resources used by it. After "
6639 "calling this, you have to call C<guestfs_aug_init> again before you can use "
6640 "any other Augeas functions."
6644 #: ../src/guestfs-actions.pod:309 ../src/guestfs-actions.pod:334
6645 #: ../src/guestfs-actions.pod:352 ../src/guestfs-actions.pod:366
6646 #: ../src/guestfs-actions.pod:424 ../src/guestfs-actions.pod:444
6647 #: ../src/guestfs-actions.pod:458 ../src/guestfs-actions.pod:489
6648 #: ../src/guestfs-actions.pod:503 ../src/guestfs-actions.pod:517
6649 #: ../src/guestfs-actions.pod:531 ../src/guestfs-actions.pod:549
6650 #: ../src/guestfs-actions.pod:5838
6651 msgid "(Added in 0.7)"
6655 #: ../src/guestfs-actions.pod:311
6656 msgid "guestfs_aug_defnode"
6660 #: ../src/guestfs-actions.pod:313
6663 " struct guestfs_int_bool *\n"
6664 " guestfs_aug_defnode (guestfs_h *g,\n"
6665 " const char *name,\n"
6666 " const char *expr,\n"
6667 " const char *val);\n"
6672 #: ../src/guestfs-actions.pod:319 ../fish/guestfish-actions.pod:204
6674 "Defines a variable C<name> whose value is the result of evaluating C<expr>."
6678 #: ../src/guestfs-actions.pod:322
6680 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
6681 "calling C<guestfs_aug_set> C<expr>, C<value>. C<name> will be the nodeset "
6682 "containing that single node."
6686 #: ../src/guestfs-actions.pod:326 ../fish/guestfish-actions.pod:211
6688 "On success this returns a pair containing the number of nodes in the "
6689 "nodeset, and a boolean flag if a node was created."
6693 #: ../src/guestfs-actions.pod:330
6695 "This function returns a C<struct guestfs_int_bool *>, or NULL if there was "
6696 "an error. I<The caller must call C<guestfs_free_int_bool> after use>."
6700 #: ../src/guestfs-actions.pod:336
6701 msgid "guestfs_aug_defvar"
6705 #: ../src/guestfs-actions.pod:338
6709 " guestfs_aug_defvar (guestfs_h *g,\n"
6710 " const char *name,\n"
6711 " const char *expr);\n"
6716 #: ../src/guestfs-actions.pod:343 ../fish/guestfish-actions.pod:219
6718 "Defines an Augeas variable C<name> whose value is the result of evaluating "
6719 "C<expr>. If C<expr> is NULL, then C<name> is undefined."
6723 #: ../src/guestfs-actions.pod:347 ../fish/guestfish-actions.pod:223
6725 "On success this returns the number of nodes in C<expr>, or C<0> if C<expr> "
6726 "evaluates to something which is not a nodeset."
6730 #: ../src/guestfs-actions.pod:354
6731 msgid "guestfs_aug_get"
6735 #: ../src/guestfs-actions.pod:356
6739 " guestfs_aug_get (guestfs_h *g,\n"
6740 " const char *augpath);\n"
6745 #: ../src/guestfs-actions.pod:360 ../fish/guestfish-actions.pod:230
6747 "Look up the value associated with C<path>. If C<path> matches exactly one "
6748 "node, the C<value> is returned."
6752 #: ../src/guestfs-actions.pod:363 ../src/guestfs-actions.pod:922
6753 #: ../src/guestfs-actions.pod:940 ../src/guestfs-actions.pod:1000
6754 #: ../src/guestfs-actions.pod:1016 ../src/guestfs-actions.pod:1119
6755 #: ../src/guestfs-actions.pod:1249 ../src/guestfs-actions.pod:1266
6756 #: ../src/guestfs-actions.pod:1285 ../src/guestfs-actions.pod:1419
6757 #: ../src/guestfs-actions.pod:1607 ../src/guestfs-actions.pod:1719
6758 #: ../src/guestfs-actions.pod:1882 ../src/guestfs-actions.pod:1899
6759 #: ../src/guestfs-actions.pod:1966 ../src/guestfs-actions.pod:2002
6760 #: ../src/guestfs-actions.pod:2023 ../src/guestfs-actions.pod:2202
6761 #: ../src/guestfs-actions.pod:2394 ../src/guestfs-actions.pod:2598
6762 #: ../src/guestfs-actions.pod:2688 ../src/guestfs-actions.pod:2792
6763 #: ../src/guestfs-actions.pod:2811 ../src/guestfs-actions.pod:3025
6764 #: ../src/guestfs-actions.pod:3053 ../src/guestfs-actions.pod:3074
6765 #: ../src/guestfs-actions.pod:3108 ../src/guestfs-actions.pod:3167
6766 #: ../src/guestfs-actions.pod:3187 ../src/guestfs-actions.pod:3207
6767 #: ../src/guestfs-actions.pod:3834 ../src/guestfs-actions.pod:4187
6768 #: ../src/guestfs-actions.pod:4357 ../src/guestfs-actions.pod:4467
6769 #: ../src/guestfs-actions.pod:5373 ../src/guestfs-actions.pod:5566
6770 #: ../src/guestfs-actions.pod:5736 ../src/guestfs-actions.pod:5914
6771 #: ../src/guestfs-actions.pod:5963 ../src/guestfs-actions.pod:6617
6772 #: ../src/guestfs-actions.pod:6633 ../src/guestfs-actions.pod:6650
6773 #: ../src/guestfs-actions.pod:6681 ../src/guestfs-actions.pod:7355
6774 #: ../src/guestfs-actions.pod:7374 ../src/guestfs-actions.pod:7392
6775 #: ../src/guestfs-actions.pod:7566 ../src/guestfs-actions.pod:7866
6777 "This function returns a string, or NULL on error. I<The caller must free "
6778 "the returned string after use>."
6782 #: ../src/guestfs-actions.pod:368
6783 msgid "guestfs_aug_init"
6787 #: ../src/guestfs-actions.pod:370
6791 " guestfs_aug_init (guestfs_h *g,\n"
6792 " const char *root,\n"
6798 #: ../src/guestfs-actions.pod:375 ../fish/guestfish-actions.pod:237
6800 "Create a new Augeas handle for editing configuration files. If there was "
6801 "any previous Augeas handle associated with this guestfs session, then it is "
6806 #: ../src/guestfs-actions.pod:379
6807 msgid "You must call this before using any other C<guestfs_aug_*> commands."
6811 #: ../src/guestfs-actions.pod:382 ../fish/guestfish-actions.pod:244
6813 "C<root> is the filesystem root. C<root> must not be NULL, use C</> instead."
6817 #: ../src/guestfs-actions.pod:385 ../fish/guestfish-actions.pod:247
6819 "The flags are the same as the flags defined in E<lt>augeas.hE<gt>, the "
6820 "logical I<or> of the following integers:"
6824 #: ../src/guestfs-actions.pod:391 ../fish/guestfish-actions.pod:253
6825 msgid "C<AUG_SAVE_BACKUP> = 1"
6826 msgstr "C<AUG_SAVE_BACKUP> = 1"
6829 #: ../src/guestfs-actions.pod:393 ../fish/guestfish-actions.pod:255
6830 msgid "Keep the original file with a C<.augsave> extension."
6834 #: ../src/guestfs-actions.pod:395 ../fish/guestfish-actions.pod:257
6835 msgid "C<AUG_SAVE_NEWFILE> = 2"
6836 msgstr "C<AUG_SAVE_NEWFILE> = 2"
6839 #: ../src/guestfs-actions.pod:397 ../fish/guestfish-actions.pod:259
6841 "Save changes into a file with extension C<.augnew>, and do not overwrite "
6842 "original. Overrides C<AUG_SAVE_BACKUP>."
6846 #: ../src/guestfs-actions.pod:400 ../fish/guestfish-actions.pod:262
6847 msgid "C<AUG_TYPE_CHECK> = 4"
6848 msgstr "C<AUG_TYPE_CHECK> = 4"
6851 #: ../src/guestfs-actions.pod:402 ../fish/guestfish-actions.pod:264
6852 msgid "Typecheck lenses (can be expensive)."
6856 #: ../src/guestfs-actions.pod:404 ../fish/guestfish-actions.pod:266
6857 msgid "C<AUG_NO_STDINC> = 8"
6858 msgstr "C<AUG_NO_STDINC> = 8"
6861 #: ../src/guestfs-actions.pod:406 ../fish/guestfish-actions.pod:268
6862 msgid "Do not use standard load path for modules."
6866 #: ../src/guestfs-actions.pod:408 ../fish/guestfish-actions.pod:270
6867 msgid "C<AUG_SAVE_NOOP> = 16"
6868 msgstr "C<AUG_SAVE_NOOP> = 16"
6871 #: ../src/guestfs-actions.pod:410 ../fish/guestfish-actions.pod:272
6872 msgid "Make save a no-op, just record what would have been changed."
6876 #: ../src/guestfs-actions.pod:412 ../fish/guestfish-actions.pod:274
6877 msgid "C<AUG_NO_LOAD> = 32"
6878 msgstr "C<AUG_NO_LOAD> = 32"
6881 #: ../src/guestfs-actions.pod:414
6882 msgid "Do not load the tree in C<guestfs_aug_init>."
6886 #: ../src/guestfs-actions.pod:418
6887 msgid "To close the handle, you can call C<guestfs_aug_close>."
6891 #: ../src/guestfs-actions.pod:420 ../fish/guestfish-actions.pod:282
6892 msgid "To find out more about Augeas, see L<http://augeas.net/>."
6896 #: ../src/guestfs-actions.pod:426
6897 msgid "guestfs_aug_insert"
6901 #: ../src/guestfs-actions.pod:428
6905 " guestfs_aug_insert (guestfs_h *g,\n"
6906 " const char *augpath,\n"
6907 " const char *label,\n"
6913 #: ../src/guestfs-actions.pod:434 ../fish/guestfish-actions.pod:288
6915 "Create a new sibling C<label> for C<path>, inserting it into the tree before "
6916 "or after C<path> (depending on the boolean flag C<before>)."
6920 #: ../src/guestfs-actions.pod:438 ../fish/guestfish-actions.pod:292
6922 "C<path> must match exactly one existing node in the tree, and C<label> must "
6923 "be a label, ie. not contain C</>, C<*> or end with a bracketed index C<[N]>."
6927 #: ../src/guestfs-actions.pod:446
6928 msgid "guestfs_aug_load"
6932 #: ../src/guestfs-actions.pod:448
6936 " guestfs_aug_load (guestfs_h *g);\n"
6941 #: ../src/guestfs-actions.pod:451 ../fish/guestfish-actions.pod:300
6942 msgid "Load files into the tree."
6943 msgstr "Завантажити файли до ієрархії."
6946 #: ../src/guestfs-actions.pod:453 ../fish/guestfish-actions.pod:302
6947 msgid "See C<aug_load> in the Augeas documentation for the full gory details."
6951 #: ../src/guestfs-actions.pod:460
6952 msgid "guestfs_aug_ls"
6956 #: ../src/guestfs-actions.pod:462
6960 " guestfs_aug_ls (guestfs_h *g,\n"
6961 " const char *augpath);\n"
6966 #: ../src/guestfs-actions.pod:466
6968 "This is just a shortcut for listing C<guestfs_aug_match> C<path/*> and "
6969 "sorting the resulting nodes into alphabetical order."
6973 #: ../src/guestfs-actions.pod:469 ../src/guestfs-actions.pod:485
6974 #: ../src/guestfs-actions.pod:631 ../src/guestfs-actions.pod:1138
6975 #: ../src/guestfs-actions.pod:1434 ../src/guestfs-actions.pod:1453
6976 #: ../src/guestfs-actions.pod:1556 ../src/guestfs-actions.pod:1575
6977 #: ../src/guestfs-actions.pod:1821 ../src/guestfs-actions.pod:2274
6978 #: ../src/guestfs-actions.pod:2290 ../src/guestfs-actions.pod:2309
6979 #: ../src/guestfs-actions.pod:2352 ../src/guestfs-actions.pod:2376
6980 #: ../src/guestfs-actions.pod:2447 ../src/guestfs-actions.pod:2496
6981 #: ../src/guestfs-actions.pod:2753 ../src/guestfs-actions.pod:3127
6982 #: ../src/guestfs-actions.pod:3403 ../src/guestfs-actions.pod:3717
6983 #: ../src/guestfs-actions.pod:3734 ../src/guestfs-actions.pod:3754
6984 #: ../src/guestfs-actions.pod:3816 ../src/guestfs-actions.pod:3921
6985 #: ../src/guestfs-actions.pod:4329 ../src/guestfs-actions.pod:5096
6986 #: ../src/guestfs-actions.pod:5708 ../src/guestfs-actions.pod:5834
6987 #: ../src/guestfs-actions.pod:5948 ../src/guestfs-actions.pod:6697
6988 #: ../src/guestfs-actions.pod:6758 ../src/guestfs-actions.pod:6813
6989 #: ../src/guestfs-actions.pod:6959 ../src/guestfs-actions.pod:6983
6990 #: ../src/guestfs-actions.pod:7459 ../src/guestfs-actions.pod:7479
6991 #: ../src/guestfs-actions.pod:7526 ../src/guestfs-actions.pod:7718
6992 #: ../src/guestfs-actions.pod:7737 ../src/guestfs-actions.pod:7823
6993 #: ../src/guestfs-actions.pod:7842 ../src/guestfs-actions.pod:7888
6994 #: ../src/guestfs-actions.pod:7907
6996 "This function returns a NULL-terminated array of strings (like L<environ(3)"
6997 ">), or NULL if there was an error. I<The caller must free the strings and "
6998 "the array after use>."
7002 #: ../src/guestfs-actions.pod:473 ../src/guestfs-actions.pod:1063
7003 #: ../src/guestfs-actions.pod:1081 ../src/guestfs-actions.pod:1491
7004 #: ../src/guestfs-actions.pod:3481 ../src/guestfs-actions.pod:3512
7005 #: ../src/guestfs-actions.pod:4170 ../src/guestfs-actions.pod:4220
7006 #: ../src/guestfs-actions.pod:4407 ../src/guestfs-actions.pod:4440
7007 #: ../src/guestfs-actions.pod:4603 ../src/guestfs-actions.pod:5100
7008 #: ../src/guestfs-actions.pod:5649 ../src/guestfs-actions.pod:6046
7009 #: ../src/guestfs-actions.pod:6060 ../src/guestfs-actions.pod:6072
7010 #: ../src/guestfs-actions.pod:6538 ../src/guestfs-actions.pod:7197
7011 #: ../src/guestfs-actions.pod:7210 ../src/guestfs-actions.pod:7443
7012 #: ../src/guestfs-actions.pod:7706
7013 msgid "(Added in 0.8)"
7017 #: ../src/guestfs-actions.pod:475
7018 msgid "guestfs_aug_match"
7022 #: ../src/guestfs-actions.pod:477
7026 " guestfs_aug_match (guestfs_h *g,\n"
7027 " const char *augpath);\n"
7032 #: ../src/guestfs-actions.pod:481 ../fish/guestfish-actions.pod:316
7034 "Returns a list of paths which match the path expression C<path>. The "
7035 "returned paths are sufficiently qualified so that they match exactly one "
7036 "node in the current tree."
7040 #: ../src/guestfs-actions.pod:491
7041 msgid "guestfs_aug_mv"
7045 #: ../src/guestfs-actions.pod:493
7049 " guestfs_aug_mv (guestfs_h *g,\n"
7050 " const char *src,\n"
7051 " const char *dest);\n"
7056 #: ../src/guestfs-actions.pod:498 ../fish/guestfish-actions.pod:324
7058 "Move the node C<src> to C<dest>. C<src> must match exactly one node. "
7059 "C<dest> is overwritten if it exists."
7063 #: ../src/guestfs-actions.pod:505
7064 msgid "guestfs_aug_rm"
7068 #: ../src/guestfs-actions.pod:507
7072 " guestfs_aug_rm (guestfs_h *g,\n"
7073 " const char *augpath);\n"
7078 #: ../src/guestfs-actions.pod:511 ../fish/guestfish-actions.pod:331
7079 msgid "Remove C<path> and all of its children."
7083 #: ../src/guestfs-actions.pod:513 ../fish/guestfish-actions.pod:333
7084 msgid "On success this returns the number of entries which were removed."
7088 #: ../src/guestfs-actions.pod:519
7089 msgid "guestfs_aug_save"
7093 #: ../src/guestfs-actions.pod:521
7097 " guestfs_aug_save (guestfs_h *g);\n"
7102 #: ../src/guestfs-actions.pod:524 ../fish/guestfish-actions.pod:339
7103 msgid "This writes all pending changes to disk."
7107 #: ../src/guestfs-actions.pod:526
7109 "The flags which were passed to C<guestfs_aug_init> affect exactly how files "
7114 #: ../src/guestfs-actions.pod:533
7115 msgid "guestfs_aug_set"
7119 #: ../src/guestfs-actions.pod:535
7123 " guestfs_aug_set (guestfs_h *g,\n"
7124 " const char *augpath,\n"
7125 " const char *val);\n"
7130 #: ../src/guestfs-actions.pod:540 ../fish/guestfish-actions.pod:348
7131 msgid "Set the value associated with C<path> to C<val>."
7135 #: ../src/guestfs-actions.pod:542
7137 "In the Augeas API, it is possible to clear a node by setting the value to "
7138 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
7139 "this call. Instead you must use the C<guestfs_aug_clear> call."
7143 #: ../src/guestfs-actions.pod:551
7144 msgid "guestfs_available"
7148 #: ../src/guestfs-actions.pod:553
7152 " guestfs_available (guestfs_h *g,\n"
7153 " char *const *groups);\n"
7158 #: ../src/guestfs-actions.pod:557 ../fish/guestfish-actions.pod:359
7160 "This command is used to check the availability of some groups of "
7161 "functionality in the appliance, which not all builds of the libguestfs "
7162 "appliance will be able to provide."
7166 #: ../src/guestfs-actions.pod:561
7168 "The libguestfs groups, and the functions that those groups correspond to, "
7169 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
7170 "runtime by calling C<guestfs_available_all_groups>."
7174 #: ../src/guestfs-actions.pod:566 ../fish/guestfish-actions.pod:368
7176 "The argument C<groups> is a list of group names, eg: C<[\"inotify\", \"augeas"
7177 "\"]> would check for the availability of the Linux inotify functions and "
7178 "Augeas (configuration file editing) functions."
7182 #: ../src/guestfs-actions.pod:571 ../fish/guestfish-actions.pod:373
7183 msgid "The command returns no error if I<all> requested groups are available."
7187 #: ../src/guestfs-actions.pod:573 ../fish/guestfish-actions.pod:375
7189 "It fails with an error if one or more of the requested groups is unavailable "
7194 #: ../src/guestfs-actions.pod:576 ../fish/guestfish-actions.pod:378
7196 "If an unknown group name is included in the list of groups then an error is "
7201 #: ../src/guestfs-actions.pod:579 ../fish/guestfish-actions.pod:381
7203 msgstr "I<Нотатки:>"
7206 #: ../src/guestfs-actions.pod:585
7207 msgid "You must call C<guestfs_launch> before calling this function."
7211 #: ../src/guestfs-actions.pod:587 ../fish/guestfish-actions.pod:389
7213 "The reason is because we don't know what groups are supported by the "
7214 "appliance/daemon until it is running and can be queried."
7218 #: ../src/guestfs-actions.pod:593 ../fish/guestfish-actions.pod:395
7220 "If a group of functions is available, this does not necessarily mean that "
7221 "they will work. You still have to check for errors when calling individual "
7222 "API functions even if they are available."
7226 #: ../src/guestfs-actions.pod:600 ../fish/guestfish-actions.pod:402
7228 "It is usually the job of distro packagers to build complete functionality "
7229 "into the libguestfs appliance. Upstream libguestfs, if built from source "
7230 "with all requirements satisfied, will support everything."
7234 #: ../src/guestfs-actions.pod:607
7236 "This call was added in version C<1.0.80>. In previous versions of "
7237 "libguestfs all you could do would be to speculatively execute a command to "
7238 "find out if the daemon implemented it. See also C<guestfs_version>."
7242 #: ../src/guestfs-actions.pod:616 ../src/guestfs-actions.pod:1236
7243 msgid "(Added in 1.0.80)"
7247 #: ../src/guestfs-actions.pod:618
7248 msgid "guestfs_available_all_groups"
7252 #: ../src/guestfs-actions.pod:620
7256 " guestfs_available_all_groups (guestfs_h *g);\n"
7261 #: ../src/guestfs-actions.pod:623
7263 "This command returns a list of all optional groups that this daemon knows "
7264 "about. Note this returns both supported and unsupported groups. To find "
7265 "out which ones the daemon can actually support you have to call "
7266 "C<guestfs_available> on each member of the returned list."
7270 #: ../src/guestfs-actions.pod:629
7271 msgid "See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>."
7275 #: ../src/guestfs-actions.pod:635
7276 msgid "(Added in 1.3.15)"
7280 #: ../src/guestfs-actions.pod:637
7281 msgid "guestfs_base64_in"
7285 #: ../src/guestfs-actions.pod:639
7289 " guestfs_base64_in (guestfs_h *g,\n"
7290 " const char *base64file,\n"
7291 " const char *filename);\n"
7296 #: ../src/guestfs-actions.pod:644 ../fish/guestfish-actions.pod:432
7298 "This command uploads base64-encoded data from C<base64file> to C<filename>."
7302 #: ../src/guestfs-actions.pod:649 ../src/guestfs-actions.pod:663
7303 msgid "(Added in 1.3.5)"
7307 #: ../src/guestfs-actions.pod:651
7308 msgid "guestfs_base64_out"
7312 #: ../src/guestfs-actions.pod:653
7316 " guestfs_base64_out (guestfs_h *g,\n"
7317 " const char *filename,\n"
7318 " const char *base64file);\n"
7323 #: ../src/guestfs-actions.pod:658 ../fish/guestfish-actions.pod:441
7325 "This command downloads the contents of C<filename>, writing it out to local "
7326 "file C<base64file> encoded as base64."
7330 #: ../src/guestfs-actions.pod:665
7331 msgid "guestfs_blockdev_flushbufs"
7335 #: ../src/guestfs-actions.pod:667
7339 " guestfs_blockdev_flushbufs (guestfs_h *g,\n"
7340 " const char *device);\n"
7345 #: ../src/guestfs-actions.pod:671 ../fish/guestfish-actions.pod:450
7347 "This tells the kernel to flush internal buffers associated with C<device>."
7351 #: ../src/guestfs-actions.pod:674 ../src/guestfs-actions.pod:691
7352 #: ../src/guestfs-actions.pod:706 ../src/guestfs-actions.pod:722
7353 #: ../src/guestfs-actions.pod:740 ../src/guestfs-actions.pod:759
7354 #: ../src/guestfs-actions.pod:773 ../src/guestfs-actions.pod:791
7355 #: ../src/guestfs-actions.pod:805 ../src/guestfs-actions.pod:819
7356 #: ../fish/guestfish-actions.pod:453 ../fish/guestfish-actions.pod:464
7357 #: ../fish/guestfish-actions.pod:473 ../fish/guestfish-actions.pod:483
7358 #: ../fish/guestfish-actions.pod:495 ../fish/guestfish-actions.pod:508
7359 #: ../fish/guestfish-actions.pod:516 ../fish/guestfish-actions.pod:527
7360 #: ../fish/guestfish-actions.pod:535 ../fish/guestfish-actions.pod:543
7361 msgid "This uses the L<blockdev(8)> command."
7365 #: ../src/guestfs-actions.pod:678 ../src/guestfs-actions.pod:695
7366 #: ../src/guestfs-actions.pod:710 ../src/guestfs-actions.pod:726
7367 #: ../src/guestfs-actions.pod:744 ../src/guestfs-actions.pod:763
7368 #: ../src/guestfs-actions.pod:777 ../src/guestfs-actions.pod:795
7369 #: ../src/guestfs-actions.pod:809 ../src/guestfs-actions.pod:823
7370 msgid "(Added in 0.9.3)"
7374 #: ../src/guestfs-actions.pod:680
7375 msgid "guestfs_blockdev_getbsz"
7379 #: ../src/guestfs-actions.pod:682
7383 " guestfs_blockdev_getbsz (guestfs_h *g,\n"
7384 " const char *device);\n"
7389 #: ../src/guestfs-actions.pod:686 ../fish/guestfish-actions.pod:459
7390 msgid "This returns the block size of a device."
7394 #: ../src/guestfs-actions.pod:688 ../src/guestfs-actions.pod:788
7395 #: ../fish/guestfish-actions.pod:461 ../fish/guestfish-actions.pod:524
7397 "(Note this is different from both I<size in blocks> and I<filesystem block "
7402 #: ../src/guestfs-actions.pod:697
7403 msgid "guestfs_blockdev_getro"
7407 #: ../src/guestfs-actions.pod:699
7411 " guestfs_blockdev_getro (guestfs_h *g,\n"
7412 " const char *device);\n"
7417 #: ../src/guestfs-actions.pod:703 ../fish/guestfish-actions.pod:470
7419 "Returns a boolean indicating if the block device is read-only (true if read-"
7420 "only, false if not)."
7424 #: ../src/guestfs-actions.pod:708 ../src/guestfs-actions.pod:1474
7425 #: ../src/guestfs-actions.pod:1489 ../src/guestfs-actions.pod:1978
7426 #: ../src/guestfs-actions.pod:1989 ../src/guestfs-actions.pod:2061
7427 #: ../src/guestfs-actions.pod:2087 ../src/guestfs-actions.pod:2125
7428 #: ../src/guestfs-actions.pod:2140 ../src/guestfs-actions.pod:2165
7429 #: ../src/guestfs-actions.pod:2188 ../src/guestfs-actions.pod:3224
7430 #: ../src/guestfs-actions.pod:3240 ../src/guestfs-actions.pod:3258
7431 #: ../src/guestfs-actions.pod:3420 ../src/guestfs-actions.pod:3434
7432 #: ../src/guestfs-actions.pod:3449 ../src/guestfs-actions.pod:3463
7433 #: ../src/guestfs-actions.pod:3479 ../src/guestfs-actions.pod:3494
7434 #: ../src/guestfs-actions.pod:3510 ../src/guestfs-actions.pod:3524
7435 #: ../src/guestfs-actions.pod:3537 ../src/guestfs-actions.pod:3551
7436 #: ../src/guestfs-actions.pod:3566 ../src/guestfs-actions.pod:3581
7437 #: ../src/guestfs-actions.pod:3594 ../src/guestfs-actions.pod:3608
7438 #: ../src/guestfs-actions.pod:5337
7439 msgid "This function returns a C truth value on success or -1 on error."
7443 #: ../src/guestfs-actions.pod:712
7444 msgid "guestfs_blockdev_getsize64"
7448 #: ../src/guestfs-actions.pod:714
7452 " guestfs_blockdev_getsize64 (guestfs_h *g,\n"
7453 " const char *device);\n"
7458 #: ../src/guestfs-actions.pod:718 ../fish/guestfish-actions.pod:479
7459 msgid "This returns the size of the device in bytes."
7463 #: ../src/guestfs-actions.pod:720
7464 msgid "See also C<guestfs_blockdev_getsz>."
7468 #: ../src/guestfs-actions.pod:728
7469 msgid "guestfs_blockdev_getss"
7473 #: ../src/guestfs-actions.pod:730
7477 " guestfs_blockdev_getss (guestfs_h *g,\n"
7478 " const char *device);\n"
7483 #: ../src/guestfs-actions.pod:734 ../fish/guestfish-actions.pod:489
7485 "This returns the size of sectors on a block device. Usually 512, but can be "
7486 "larger for modern devices."
7490 #: ../src/guestfs-actions.pod:737
7492 "(Note, this is not the size in sectors, use C<guestfs_blockdev_getsz> for "
7497 #: ../src/guestfs-actions.pod:746
7498 msgid "guestfs_blockdev_getsz"
7502 #: ../src/guestfs-actions.pod:748
7506 " guestfs_blockdev_getsz (guestfs_h *g,\n"
7507 " const char *device);\n"
7512 #: ../src/guestfs-actions.pod:752 ../fish/guestfish-actions.pod:501
7514 "This returns the size of the device in units of 512-byte sectors (even if "
7515 "the sectorsize isn't 512 bytes ... weird)."
7519 #: ../src/guestfs-actions.pod:755
7521 "See also C<guestfs_blockdev_getss> for the real sector size of the device, "
7522 "and C<guestfs_blockdev_getsize64> for the more useful I<size in bytes>."
7526 #: ../src/guestfs-actions.pod:765
7527 msgid "guestfs_blockdev_rereadpt"
7531 #: ../src/guestfs-actions.pod:767
7535 " guestfs_blockdev_rereadpt (guestfs_h *g,\n"
7536 " const char *device);\n"
7541 #: ../src/guestfs-actions.pod:771 ../fish/guestfish-actions.pod:514
7542 msgid "Reread the partition table on C<device>."
7546 #: ../src/guestfs-actions.pod:779
7547 msgid "guestfs_blockdev_setbsz"
7551 #: ../src/guestfs-actions.pod:781
7555 " guestfs_blockdev_setbsz (guestfs_h *g,\n"
7556 " const char *device,\n"
7557 " int blocksize);\n"
7562 #: ../src/guestfs-actions.pod:786 ../fish/guestfish-actions.pod:522
7563 msgid "This sets the block size of a device."
7567 #: ../src/guestfs-actions.pod:797
7568 msgid "guestfs_blockdev_setro"
7572 #: ../src/guestfs-actions.pod:799
7576 " guestfs_blockdev_setro (guestfs_h *g,\n"
7577 " const char *device);\n"
7582 #: ../src/guestfs-actions.pod:803 ../fish/guestfish-actions.pod:533
7583 msgid "Sets the block device named C<device> to read-only."
7587 #: ../src/guestfs-actions.pod:811
7588 msgid "guestfs_blockdev_setrw"
7592 #: ../src/guestfs-actions.pod:813
7596 " guestfs_blockdev_setrw (guestfs_h *g,\n"
7597 " const char *device);\n"
7602 #: ../src/guestfs-actions.pod:817 ../fish/guestfish-actions.pod:541
7603 msgid "Sets the block device named C<device> to read-write."
7607 #: ../src/guestfs-actions.pod:825
7608 msgid "guestfs_btrfs_filesystem_resize"
7612 #: ../src/guestfs-actions.pod:827
7616 " guestfs_btrfs_filesystem_resize (guestfs_h *g,\n"
7617 " const char *mountpoint,\n"
7623 #: ../src/guestfs-actions.pod:837
7626 " GUESTFS_BTRFS_FILESYSTEM_RESIZE_SIZE, int64_t size,\n"
7631 #: ../src/guestfs-actions.pod:839 ../fish/guestfish-actions.pod:549
7632 msgid "This command resizes a btrfs filesystem."
7636 #: ../src/guestfs-actions.pod:841 ../fish/guestfish-actions.pod:551
7638 "Note that unlike other resize calls, the filesystem has to be mounted and "
7639 "the parameter is the mountpoint not the device (this is a requirement of "
7644 #: ../src/guestfs-actions.pod:845 ../src/guestfs-actions.pod:5187
7645 #: ../fish/guestfish-actions.pod:555 ../fish/guestfish-actions.pod:3417
7646 msgid "The optional parameters are:"
7650 #: ../src/guestfs-actions.pod:849 ../src/guestfs-actions.pod:5191
7651 #: ../fish/guestfish-actions.pod:559 ../fish/guestfish-actions.pod:3421
7653 #| msgid "C<inspector>"
7655 msgstr "C<inspector>"
7658 #: ../src/guestfs-actions.pod:851 ../fish/guestfish-actions.pod:561
7660 "The new size (in bytes) of the filesystem. If omitted, the filesystem is "
7661 "resized to the maximum size."
7665 #: ../src/guestfs-actions.pod:856 ../fish/guestfish-actions.pod:566
7667 #| msgid "See L<guestfish(1)>."
7668 msgid "See also L<btrfs(8)>."
7669 msgstr "Див. L<guestfish(1)>."
7672 #: ../src/guestfs-actions.pod:860
7673 msgid "(Added in 1.11.17)"
7677 #: ../src/guestfs-actions.pod:862
7678 msgid "guestfs_btrfs_filesystem_resize_va"
7682 #: ../src/guestfs-actions.pod:864
7686 " guestfs_btrfs_filesystem_resize_va (guestfs_h *g,\n"
7687 " const char *mountpoint,\n"
7693 #: ../src/guestfs-actions.pod:869
7694 msgid "This is the \"va_list variant\" of L</guestfs_btrfs_filesystem_resize>."
7698 #: ../src/guestfs-actions.pod:873
7699 msgid "guestfs_btrfs_filesystem_resize_argv"
7703 #: ../src/guestfs-actions.pod:875
7707 " guestfs_btrfs_filesystem_resize_argv (guestfs_h *g,\n"
7708 " const char *mountpoint,\n"
7709 " const struct guestfs_btrfs_filesystem_resize_argv *optargs);\n"
7714 #: ../src/guestfs-actions.pod:880
7715 msgid "This is the \"argv variant\" of L</guestfs_btrfs_filesystem_resize>."
7719 #: ../src/guestfs-actions.pod:884
7720 msgid "guestfs_case_sensitive_path"
7724 #: ../src/guestfs-actions.pod:886
7728 " guestfs_case_sensitive_path (guestfs_h *g,\n"
7729 " const char *path);\n"
7734 #: ../src/guestfs-actions.pod:890 ../fish/guestfish-actions.pod:574
7736 "This can be used to resolve case insensitive paths on a filesystem which is "
7737 "case sensitive. The use case is to resolve paths which you have read from "
7738 "Windows configuration files or the Windows Registry, to the true path."
7742 #: ../src/guestfs-actions.pod:895 ../fish/guestfish-actions.pod:579
7744 "The command handles a peculiarity of the Linux ntfs-3g filesystem driver "
7745 "(and probably others), which is that although the underlying filesystem is "
7746 "case-insensitive, the driver exports the filesystem to Linux as case-"
7751 #: ../src/guestfs-actions.pod:900 ../fish/guestfish-actions.pod:584
7753 "One consequence of this is that special directories such as C<c:\\windows> "
7754 "may appear as C</WINDOWS> or C</windows> (or other things) depending on the "
7755 "precise details of how they were created. In Windows itself this would not "
7760 #: ../src/guestfs-actions.pod:906 ../fish/guestfish-actions.pod:590
7762 "Bug or feature? You decide: L<http://www.tuxera.com/community/ntfs-3g-faq/"
7767 #: ../src/guestfs-actions.pod:909 ../fish/guestfish-actions.pod:593
7769 "This function resolves the true case of each element in the path and returns "
7770 "the case-sensitive path."
7774 #: ../src/guestfs-actions.pod:912
7776 "Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\") might return C<"
7777 "\"/WINDOWS/system32\"> (the exact return value would depend on details of "
7778 "how the directories were originally created under Windows)."
7782 #: ../src/guestfs-actions.pod:917 ../fish/guestfish-actions.pod:601
7783 msgid "I<Note>: This function does not handle drive names, backslashes etc."
7787 #: ../src/guestfs-actions.pod:920
7788 msgid "See also C<guestfs_realpath>."
7792 #: ../src/guestfs-actions.pod:925 ../src/guestfs-actions.pod:7377
7793 msgid "(Added in 1.0.75)"
7797 #: ../src/guestfs-actions.pod:927
7802 #: ../src/guestfs-actions.pod:929
7806 " guestfs_cat (guestfs_h *g,\n"
7807 " const char *path);\n"
7812 #: ../src/guestfs-actions.pod:933 ../src/guestfs-actions.pod:5824
7813 #: ../fish/guestfish-actions.pod:610 ../fish/guestfish-actions.pod:3831
7814 msgid "Return the contents of the file named C<path>."
7818 #: ../src/guestfs-actions.pod:935
7820 "Note that this function cannot correctly handle binary files (specifically, "
7821 "files containing C<\\0> character which is treated as end of string). For "
7822 "those you need to use the C<guestfs_read_file> or C<guestfs_download> "
7823 "functions which have a more complex interface."
7827 #: ../src/guestfs-actions.pod:943 ../src/guestfs-actions.pod:1122
7828 #: ../src/guestfs-actions.pod:1142 ../src/guestfs-actions.pod:1438
7829 #: ../src/guestfs-actions.pod:1457 ../src/guestfs-actions.pod:1560
7830 #: ../src/guestfs-actions.pod:1579 ../src/guestfs-actions.pod:1825
7831 #: ../src/guestfs-actions.pod:2294 ../src/guestfs-actions.pod:2313
7832 #: ../src/guestfs-actions.pod:2356 ../src/guestfs-actions.pod:2380
7833 #: ../src/guestfs-actions.pod:2397 ../src/guestfs-actions.pod:2426
7834 #: ../src/guestfs-actions.pod:5606 ../src/guestfs-actions.pod:5632
7835 #: ../src/guestfs-actions.pod:5763 ../src/guestfs-actions.pod:5789
7836 #: ../src/guestfs-actions.pod:5813 ../src/guestfs-actions.pod:6762
7837 #: ../src/guestfs-actions.pod:6817 ../src/guestfs-actions.pod:6963
7838 #: ../src/guestfs-actions.pod:6987 ../src/guestfs-actions.pod:7652
7839 #: ../src/guestfs-actions.pod:7672 ../src/guestfs-actions.pod:7696
7840 #: ../src/guestfs-actions.pod:7722 ../src/guestfs-actions.pod:7741
7841 #: ../src/guestfs-actions.pod:7827 ../src/guestfs-actions.pod:7846
7842 #: ../src/guestfs-actions.pod:7892 ../src/guestfs-actions.pod:7911
7843 #: ../fish/guestfish-actions.pod:617 ../fish/guestfish-actions.pod:752
7844 #: ../fish/guestfish-actions.pod:764 ../fish/guestfish-actions.pod:940
7845 #: ../fish/guestfish-actions.pod:950 ../fish/guestfish-actions.pod:1017
7846 #: ../fish/guestfish-actions.pod:1027 ../fish/guestfish-actions.pod:1219
7847 #: ../fish/guestfish-actions.pod:1526 ../fish/guestfish-actions.pod:1536
7848 #: ../fish/guestfish-actions.pod:1564 ../fish/guestfish-actions.pod:1579
7849 #: ../fish/guestfish-actions.pod:1589 ../fish/guestfish-actions.pod:1608
7850 #: ../fish/guestfish-actions.pod:3701 ../fish/guestfish-actions.pod:3716
7851 #: ../fish/guestfish-actions.pod:3792 ../fish/guestfish-actions.pod:3809
7852 #: ../fish/guestfish-actions.pod:3824 ../fish/guestfish-actions.pod:4493
7853 #: ../fish/guestfish-actions.pod:4539 ../fish/guestfish-actions.pod:4624
7854 #: ../fish/guestfish-actions.pod:4639 ../fish/guestfish-actions.pod:5045
7855 #: ../fish/guestfish-actions.pod:5057 ../fish/guestfish-actions.pod:5075
7856 #: ../fish/guestfish-actions.pod:5092 ../fish/guestfish-actions.pod:5102
7857 #: ../fish/guestfish-actions.pod:5151 ../fish/guestfish-actions.pod:5161
7858 #: ../fish/guestfish-actions.pod:5190 ../fish/guestfish-actions.pod:5200
7860 "Because of the message protocol, there is a transfer limit of somewhere "
7861 "between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
7865 #: ../src/guestfs-actions.pod:946 ../src/guestfs-actions.pod:3738
7866 #: ../src/guestfs-actions.pod:3820 ../src/guestfs-actions.pod:3837
7867 #: ../src/guestfs-actions.pod:3925 ../src/guestfs-actions.pod:4333
7868 #: ../src/guestfs-actions.pod:4347 ../src/guestfs-actions.pod:5712
7869 #: ../src/guestfs-actions.pod:5726 ../src/guestfs-actions.pod:7530
7870 #: ../src/guestfs-actions.pod:7544
7871 msgid "(Added in 0.4)"
7875 #: ../src/guestfs-actions.pod:948
7876 msgid "guestfs_checksum"
7880 #: ../src/guestfs-actions.pod:950
7884 " guestfs_checksum (guestfs_h *g,\n"
7885 " const char *csumtype,\n"
7886 " const char *path);\n"
7891 #: ../src/guestfs-actions.pod:955 ../fish/guestfish-actions.pod:624
7893 "This call computes the MD5, SHAx or CRC checksum of the file named C<path>."
7897 #: ../src/guestfs-actions.pod:958 ../fish/guestfish-actions.pod:627
7899 "The type of checksum to compute is given by the C<csumtype> parameter which "
7900 "must have one of the following values:"
7904 #: ../src/guestfs-actions.pod:963 ../fish/guestfish-actions.pod:632
7909 #: ../src/guestfs-actions.pod:965 ../fish/guestfish-actions.pod:634
7911 "Compute the cyclic redundancy check (CRC) specified by POSIX for the "
7916 #: ../src/guestfs-actions.pod:968 ../fish/guestfish-actions.pod:637
7921 #: ../src/guestfs-actions.pod:970 ../fish/guestfish-actions.pod:639
7922 msgid "Compute the MD5 hash (using the C<md5sum> program)."
7926 #: ../src/guestfs-actions.pod:972 ../fish/guestfish-actions.pod:641
7931 #: ../src/guestfs-actions.pod:974 ../fish/guestfish-actions.pod:643
7932 msgid "Compute the SHA1 hash (using the C<sha1sum> program)."
7936 #: ../src/guestfs-actions.pod:976 ../fish/guestfish-actions.pod:645
7941 #: ../src/guestfs-actions.pod:978 ../fish/guestfish-actions.pod:647
7942 msgid "Compute the SHA224 hash (using the C<sha224sum> program)."
7946 #: ../src/guestfs-actions.pod:980 ../fish/guestfish-actions.pod:649
7951 #: ../src/guestfs-actions.pod:982 ../fish/guestfish-actions.pod:651
7952 msgid "Compute the SHA256 hash (using the C<sha256sum> program)."
7956 #: ../src/guestfs-actions.pod:984 ../fish/guestfish-actions.pod:653
7961 #: ../src/guestfs-actions.pod:986 ../fish/guestfish-actions.pod:655
7962 msgid "Compute the SHA384 hash (using the C<sha384sum> program)."
7966 #: ../src/guestfs-actions.pod:988 ../fish/guestfish-actions.pod:657
7971 #: ../src/guestfs-actions.pod:990 ../fish/guestfish-actions.pod:659
7972 msgid "Compute the SHA512 hash (using the C<sha512sum> program)."
7976 #: ../src/guestfs-actions.pod:994 ../fish/guestfish-actions.pod:663
7977 msgid "The checksum is returned as a printable string."
7981 #: ../src/guestfs-actions.pod:996
7982 msgid "To get the checksum for a device, use C<guestfs_checksum_device>."
7986 #: ../src/guestfs-actions.pod:998
7987 msgid "To get the checksums for many files, use C<guestfs_checksums_out>."
7991 #: ../src/guestfs-actions.pod:1003 ../src/guestfs-actions.pod:1311
7992 #: ../src/guestfs-actions.pod:2156 ../src/guestfs-actions.pod:3436
7993 #: ../src/guestfs-actions.pod:3465 ../src/guestfs-actions.pod:3526
7994 #: ../src/guestfs-actions.pod:3553 ../src/guestfs-actions.pod:7233
7995 msgid "(Added in 1.0.2)"
7999 #: ../src/guestfs-actions.pod:1005
8000 msgid "guestfs_checksum_device"
8004 #: ../src/guestfs-actions.pod:1007
8008 " guestfs_checksum_device (guestfs_h *g,\n"
8009 " const char *csumtype,\n"
8010 " const char *device);\n"
8015 #: ../src/guestfs-actions.pod:1012
8017 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
8018 "device named C<device>. For the types of checksums supported see the "
8019 "C<guestfs_checksum> command."
8023 #: ../src/guestfs-actions.pod:1019 ../src/guestfs-actions.pod:5167
8024 #: ../src/guestfs-actions.pod:5302 ../src/guestfs-actions.pod:5339
8025 #: ../src/guestfs-actions.pod:5357 ../src/guestfs-actions.pod:5533
8026 #: ../src/guestfs-actions.pod:7142 ../src/guestfs-actions.pod:7156
8027 #: ../src/guestfs-actions.pod:7556
8028 msgid "(Added in 1.3.2)"
8032 #: ../src/guestfs-actions.pod:1021
8033 msgid "guestfs_checksums_out"
8037 #: ../src/guestfs-actions.pod:1023
8041 " guestfs_checksums_out (guestfs_h *g,\n"
8042 " const char *csumtype,\n"
8043 " const char *directory,\n"
8044 " const char *sumsfile);\n"
8049 #: ../src/guestfs-actions.pod:1029 ../fish/guestfish-actions.pod:681
8051 "This command computes the checksums of all regular files in C<directory> and "
8052 "then emits a list of those checksums to the local output file C<sumsfile>."
8056 #: ../src/guestfs-actions.pod:1033 ../fish/guestfish-actions.pod:685
8058 "This can be used for verifying the integrity of a virtual machine. However "
8059 "to be properly secure you should pay attention to the output of the checksum "
8060 "command (it uses the ones from GNU coreutils). In particular when the "
8061 "filename is not printable, coreutils uses a special backslash syntax. For "
8062 "more information, see the GNU coreutils info file."
8066 #: ../src/guestfs-actions.pod:1043
8067 msgid "(Added in 1.3.7)"
8071 #: ../src/guestfs-actions.pod:1045
8072 msgid "guestfs_chmod"
8076 #: ../src/guestfs-actions.pod:1047
8080 " guestfs_chmod (guestfs_h *g,\n"
8082 " const char *path);\n"
8087 #: ../src/guestfs-actions.pod:1052 ../fish/guestfish-actions.pod:699
8089 "Change the mode (permissions) of C<path> to C<mode>. Only numeric modes are "
8094 #: ../src/guestfs-actions.pod:1055 ../fish/guestfish-actions.pod:702
8096 "I<Note>: When using this command from guestfish, C<mode> by default would be "
8097 "decimal, unless you prefix it with C<0> to get octal, ie. use C<0700> not "
8102 #: ../src/guestfs-actions.pod:1059 ../src/guestfs-actions.pod:4584
8103 #: ../src/guestfs-actions.pod:4793 ../src/guestfs-actions.pod:4812
8104 #: ../src/guestfs-actions.pod:4831 ../fish/guestfish-actions.pod:706
8105 #: ../fish/guestfish-actions.pod:3060 ../fish/guestfish-actions.pod:3199
8106 #: ../fish/guestfish-actions.pod:3209 ../fish/guestfish-actions.pod:3219
8107 msgid "The mode actually set is affected by the umask."
8111 #: ../src/guestfs-actions.pod:1065
8112 msgid "guestfs_chown"
8116 #: ../src/guestfs-actions.pod:1067
8120 " guestfs_chown (guestfs_h *g,\n"
8123 " const char *path);\n"
8128 #: ../src/guestfs-actions.pod:1073 ../fish/guestfish-actions.pod:712
8129 msgid "Change the file owner to C<owner> and group to C<group>."
8133 #: ../src/guestfs-actions.pod:1075 ../src/guestfs-actions.pod:3655
8134 #: ../fish/guestfish-actions.pod:714 ../fish/guestfish-actions.pod:2495
8136 "Only numeric uid and gid are supported. If you want to use names, you will "
8137 "need to locate and parse the password file yourself (Augeas support makes "
8138 "this relatively easy)."
8142 #: ../src/guestfs-actions.pod:1083
8143 msgid "guestfs_command"
8147 #: ../src/guestfs-actions.pod:1085
8151 " guestfs_command (guestfs_h *g,\n"
8152 " char *const *arguments);\n"
8157 #: ../src/guestfs-actions.pod:1089 ../fish/guestfish-actions.pod:722
8159 "This call runs a command from the guest filesystem. The filesystem must be "
8160 "mounted, and must contain a compatible operating system (ie. something "
8161 "Linux, with the same or compatible processor architecture)."
8165 #: ../src/guestfs-actions.pod:1094
8167 "The single parameter is an argv-style list of arguments. The first element "
8168 "is the name of the program to run. Subsequent elements are parameters. The "
8169 "list must be non-empty (ie. must contain a program name). Note that the "
8170 "command runs directly, and is I<not> invoked via the shell (see "
8175 #: ../src/guestfs-actions.pod:1101 ../fish/guestfish-actions.pod:734
8176 msgid "The return value is anything printed to I<stdout> by the command."
8180 #: ../src/guestfs-actions.pod:1104 ../fish/guestfish-actions.pod:737
8182 "If the command returns a non-zero exit status, then this function returns an "
8183 "error message. The error message string is the content of I<stderr> from "
8188 #: ../src/guestfs-actions.pod:1108 ../fish/guestfish-actions.pod:741
8190 "The C<$PATH> environment variable will contain at least C</usr/bin> and C</"
8191 "bin>. If you require a program from another location, you should provide "
8192 "the full path in the first parameter."
8196 #: ../src/guestfs-actions.pod:1113 ../fish/guestfish-actions.pod:746
8198 "Shared libraries and data files required by the program must be available on "
8199 "filesystems which are mounted in the correct places. It is the caller's "
8200 "responsibility to ensure all filesystems that are needed are mounted at the "
8205 #: ../src/guestfs-actions.pod:1125 ../src/guestfs-actions.pod:1145
8206 #: ../src/guestfs-actions.pod:1610
8207 msgid "(Added in 0.9.1)"
8211 #: ../src/guestfs-actions.pod:1127
8212 msgid "guestfs_command_lines"
8216 #: ../src/guestfs-actions.pod:1129
8220 " guestfs_command_lines (guestfs_h *g,\n"
8221 " char *const *arguments);\n"
8226 #: ../src/guestfs-actions.pod:1133
8228 "This is the same as C<guestfs_command>, but splits the result into a list of "
8233 #: ../src/guestfs-actions.pod:1136
8234 msgid "See also: C<guestfs_sh_lines>"
8238 #: ../src/guestfs-actions.pod:1147
8239 msgid "guestfs_config"
8243 #: ../src/guestfs-actions.pod:1149
8247 " guestfs_config (guestfs_h *g,\n"
8248 " const char *qemuparam,\n"
8249 " const char *qemuvalue);\n"
8254 #: ../src/guestfs-actions.pod:1154 ../fish/guestfish-actions.pod:771
8256 "This can be used to add arbitrary qemu command line parameters of the form "
8257 "I<-param value>. Actually it's not quite arbitrary - we prevent you from "
8258 "setting some parameters which would interfere with parameters that we use."
8262 #: ../src/guestfs-actions.pod:1159 ../fish/guestfish-actions.pod:776
8263 msgid "The first character of C<param> string must be a C<-> (dash)."
8267 #: ../src/guestfs-actions.pod:1161 ../fish/guestfish-actions.pod:778
8268 msgid "C<value> can be NULL."
8272 #: ../src/guestfs-actions.pod:1167
8273 msgid "guestfs_copy_size"
8277 #: ../src/guestfs-actions.pod:1169
8281 " guestfs_copy_size (guestfs_h *g,\n"
8282 " const char *src,\n"
8283 " const char *dest,\n"
8289 #: ../src/guestfs-actions.pod:1175 ../fish/guestfish-actions.pod:784
8291 "This command copies exactly C<size> bytes from one source device or file "
8292 "C<src> to another destination device or file C<dest>."
8296 #: ../src/guestfs-actions.pod:1178 ../fish/guestfish-actions.pod:787
8298 "Note this will fail if the source is too short or if the destination is not "
8303 #: ../src/guestfs-actions.pod:1183 ../src/guestfs-actions.pod:1306
8304 #: ../src/guestfs-actions.pod:1337 ../src/guestfs-actions.pod:1382
8305 #: ../src/guestfs-actions.pod:1759 ../src/guestfs-actions.pod:1781
8306 #: ../src/guestfs-actions.pod:3636 ../src/guestfs-actions.pod:7228
8307 #: ../src/guestfs-actions.pod:7262 ../src/guestfs-actions.pod:7763
8308 #: ../src/guestfs-actions.pod:7782
8310 "This long-running command can generate progress notification messages so "
8311 "that the caller can display a progress bar or indicator. To receive these "
8312 "messages, the caller must register a progress event callback. See L<guestfs"
8313 "(3)/GUESTFS_EVENT_PROGRESS>."
8317 #: ../src/guestfs-actions.pod:1188 ../src/guestfs-actions.pod:4360
8318 #: ../src/guestfs-actions.pod:5739 ../src/guestfs-actions.pod:7463
8319 #: ../src/guestfs-actions.pod:7483 ../src/guestfs-actions.pod:7569
8320 msgid "(Added in 1.0.87)"
8324 #: ../src/guestfs-actions.pod:1190
8329 #: ../src/guestfs-actions.pod:1192
8333 " guestfs_cp (guestfs_h *g,\n"
8334 " const char *src,\n"
8335 " const char *dest);\n"
8340 #: ../src/guestfs-actions.pod:1197 ../fish/guestfish-actions.pod:794
8342 "This copies a file from C<src> to C<dest> where C<dest> is either a "
8343 "destination filename or destination directory."
8347 #: ../src/guestfs-actions.pod:1202 ../src/guestfs-actions.pod:1216
8348 #: ../src/guestfs-actions.pod:1288 ../src/guestfs-actions.pod:1362
8349 #: ../src/guestfs-actions.pod:1476 ../src/guestfs-actions.pod:5114
8350 #: ../src/guestfs-actions.pod:5583
8351 msgid "(Added in 1.0.18)"
8355 #: ../src/guestfs-actions.pod:1204
8356 msgid "guestfs_cp_a"
8360 #: ../src/guestfs-actions.pod:1206
8364 " guestfs_cp_a (guestfs_h *g,\n"
8365 " const char *src,\n"
8366 " const char *dest);\n"
8371 #: ../src/guestfs-actions.pod:1211 ../fish/guestfish-actions.pod:801
8373 "This copies a file or directory from C<src> to C<dest> recursively using the "
8378 #: ../src/guestfs-actions.pod:1218
8383 #: ../src/guestfs-actions.pod:1220
8387 " guestfs_dd (guestfs_h *g,\n"
8388 " const char *src,\n"
8389 " const char *dest);\n"
8394 #: ../src/guestfs-actions.pod:1225 ../fish/guestfish-actions.pod:808
8396 "This command copies from one source device or file C<src> to another "
8397 "destination device or file C<dest>. Normally you would use this to copy to "
8398 "or from a device or partition, for example to duplicate a filesystem."
8402 #: ../src/guestfs-actions.pod:1230
8404 "If the destination is a device, it must be as large or larger than the "
8405 "source file or device, otherwise the copy will fail. This command cannot do "
8406 "partial copies (see C<guestfs_copy_size>)."
8410 #: ../src/guestfs-actions.pod:1238
8415 #: ../src/guestfs-actions.pod:1240
8419 " guestfs_df (guestfs_h *g);\n"
8424 #: ../src/guestfs-actions.pod:1243 ../fish/guestfish-actions.pod:821
8425 msgid "This command runs the C<df> command to report disk space used."
8429 #: ../src/guestfs-actions.pod:1245 ../src/guestfs-actions.pod:1262
8431 "This command is mostly useful for interactive sessions. It is I<not> "
8432 "intended that you try to parse the output string. Use C<guestfs_statvfs> "
8437 #: ../src/guestfs-actions.pod:1252 ../src/guestfs-actions.pod:1269
8438 #: ../src/guestfs-actions.pod:1387 ../src/guestfs-actions.pod:2359
8439 #: ../src/guestfs-actions.pod:2383 ../src/guestfs-actions.pod:2451
8440 #: ../src/guestfs-actions.pod:4470 ../src/guestfs-actions.pod:5014
8441 #: ../src/guestfs-actions.pod:6966 ../src/guestfs-actions.pod:6990
8442 #: ../src/guestfs-actions.pod:7609 ../src/guestfs-actions.pod:7622
8443 #: ../src/guestfs-actions.pod:7635
8444 msgid "(Added in 1.0.54)"
8448 #: ../src/guestfs-actions.pod:1254
8449 msgid "guestfs_df_h"
8453 #: ../src/guestfs-actions.pod:1256
8457 " guestfs_df_h (guestfs_h *g);\n"
8462 #: ../src/guestfs-actions.pod:1259 ../fish/guestfish-actions.pod:831
8464 "This command runs the C<df -h> command to report disk space used in human-"
8469 #: ../src/guestfs-actions.pod:1271
8470 msgid "guestfs_dmesg"
8474 #: ../src/guestfs-actions.pod:1273
8478 " guestfs_dmesg (guestfs_h *g);\n"
8483 #: ../src/guestfs-actions.pod:1276 ../fish/guestfish-actions.pod:842
8485 "This returns the kernel messages (C<dmesg> output) from the guest kernel. "
8486 "This is sometimes useful for extended debugging of problems."
8490 #: ../src/guestfs-actions.pod:1280
8492 "Another way to get the same information is to enable verbose messages with "
8493 "C<guestfs_set_verbose> or by setting the environment variable "
8494 "C<LIBGUESTFS_DEBUG=1> before running the program."
8498 #: ../src/guestfs-actions.pod:1290
8499 msgid "guestfs_download"
8503 #: ../src/guestfs-actions.pod:1292
8507 " guestfs_download (guestfs_h *g,\n"
8508 " const char *remotefilename,\n"
8509 " const char *filename);\n"
8514 #: ../src/guestfs-actions.pod:1297 ../src/guestfs-actions.pod:1322
8515 #: ../fish/guestfish-actions.pod:855 ../fish/guestfish-actions.pod:868
8517 "Download file C<remotefilename> and save it as C<filename> on the local "
8522 #: ../src/guestfs-actions.pod:1300 ../src/guestfs-actions.pod:7222
8523 #: ../fish/guestfish-actions.pod:858 ../fish/guestfish-actions.pod:4797
8524 msgid "C<filename> can also be a named pipe."
8528 #: ../src/guestfs-actions.pod:1302
8529 msgid "See also C<guestfs_upload>, C<guestfs_cat>."
8533 #: ../src/guestfs-actions.pod:1313
8534 msgid "guestfs_download_offset"
8538 #: ../src/guestfs-actions.pod:1315
8542 " guestfs_download_offset (guestfs_h *g,\n"
8543 " const char *remotefilename,\n"
8544 " const char *filename,\n"
8545 " int64_t offset,\n"
8551 #: ../src/guestfs-actions.pod:1325 ../fish/guestfish-actions.pod:871
8553 "C<remotefilename> is read for C<size> bytes starting at C<offset> (this "
8554 "region must be within the file or device)."
8558 #: ../src/guestfs-actions.pod:1328
8560 "Note that there is no limit on the amount of data that can be downloaded "
8561 "with this call, unlike with C<guestfs_pread>, and this call always reads the "
8562 "full amount unless an error occurs."
8566 #: ../src/guestfs-actions.pod:1333
8567 msgid "See also C<guestfs_download>, C<guestfs_pread>."
8571 #: ../src/guestfs-actions.pod:1342 ../src/guestfs-actions.pod:7267
8572 msgid "(Added in 1.5.17)"
8576 #: ../src/guestfs-actions.pod:1344
8577 msgid "guestfs_drop_caches"
8581 #: ../src/guestfs-actions.pod:1346
8585 " guestfs_drop_caches (guestfs_h *g,\n"
8586 " int whattodrop);\n"
8591 #: ../src/guestfs-actions.pod:1350 ../fish/guestfish-actions.pod:887
8593 "This instructs the guest kernel to drop its page cache, and/or dentries and "
8594 "inode caches. The parameter C<whattodrop> tells the kernel what precisely "
8595 "to drop, see L<http://linux-mm.org/Drop_Caches>"
8599 #: ../src/guestfs-actions.pod:1355 ../fish/guestfish-actions.pod:892
8600 msgid "Setting C<whattodrop> to 3 should drop everything."
8604 #: ../src/guestfs-actions.pod:1357 ../fish/guestfish-actions.pod:894
8606 "This automatically calls L<sync(2)> before the operation, so that the "
8607 "maximum guest memory is freed."
8611 #: ../src/guestfs-actions.pod:1364
8616 #: ../src/guestfs-actions.pod:1366
8620 " guestfs_du (guestfs_h *g,\n"
8621 " const char *path);\n"
8626 #: ../src/guestfs-actions.pod:1370 ../fish/guestfish-actions.pod:901
8628 "This command runs the C<du -s> command to estimate file space usage for "
8633 #: ../src/guestfs-actions.pod:1373 ../fish/guestfish-actions.pod:904
8635 "C<path> can be a file or a directory. If C<path> is a directory then the "
8636 "estimate includes the contents of the directory and all subdirectories "
8641 #: ../src/guestfs-actions.pod:1377 ../fish/guestfish-actions.pod:908
8643 "The result is the estimated size in I<kilobytes> (ie. units of 1024 bytes)."
8647 #: ../src/guestfs-actions.pod:1389
8648 msgid "guestfs_e2fsck_f"
8652 #: ../src/guestfs-actions.pod:1391
8656 " guestfs_e2fsck_f (guestfs_h *g,\n"
8657 " const char *device);\n"
8662 #: ../src/guestfs-actions.pod:1395 ../fish/guestfish-actions.pod:915
8664 "This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3 filesystem checker "
8665 "on C<device>, noninteractively (I<-p>), even if the filesystem appears to be "
8670 #: ../src/guestfs-actions.pod:1399
8672 "This command is only needed because of C<guestfs_resize2fs> (q.v.). "
8673 "Normally you should use C<guestfs_fsck>."
8677 #: ../src/guestfs-actions.pod:1404
8678 msgid "(Added in 1.0.29)"
8682 #: ../src/guestfs-actions.pod:1406
8683 msgid "guestfs_echo_daemon"
8687 #: ../src/guestfs-actions.pod:1408
8691 " guestfs_echo_daemon (guestfs_h *g,\n"
8692 " char *const *words);\n"
8697 #: ../src/guestfs-actions.pod:1412 ../fish/guestfish-actions.pod:926
8699 "This command concatenates the list of C<words> passed with single spaces "
8700 "between them and returns the resulting string."
8704 #: ../src/guestfs-actions.pod:1415 ../fish/guestfish-actions.pod:929
8705 msgid "You can use this command to test the connection through to the daemon."
8709 #: ../src/guestfs-actions.pod:1417
8710 msgid "See also C<guestfs_ping_daemon>."
8714 #: ../src/guestfs-actions.pod:1422 ../src/guestfs-actions.pod:2167
8715 #: ../src/guestfs-actions.pod:6438
8716 msgid "(Added in 1.0.69)"
8720 #: ../src/guestfs-actions.pod:1424
8721 msgid "guestfs_egrep"
8725 #: ../src/guestfs-actions.pod:1426
8729 " guestfs_egrep (guestfs_h *g,\n"
8730 " const char *regex,\n"
8731 " const char *path);\n"
8736 #: ../src/guestfs-actions.pod:1431 ../fish/guestfish-actions.pod:937
8738 "This calls the external C<egrep> program and returns the matching lines."
8742 #: ../src/guestfs-actions.pod:1441 ../src/guestfs-actions.pod:1460
8743 #: ../src/guestfs-actions.pod:1517 ../src/guestfs-actions.pod:1563
8744 #: ../src/guestfs-actions.pod:1582 ../src/guestfs-actions.pod:2297
8745 #: ../src/guestfs-actions.pod:2316 ../src/guestfs-actions.pod:2472
8746 #: ../src/guestfs-actions.pod:2485 ../src/guestfs-actions.pod:2500
8747 #: ../src/guestfs-actions.pod:2546 ../src/guestfs-actions.pod:2568
8748 #: ../src/guestfs-actions.pod:2581 ../src/guestfs-actions.pod:3850
8749 #: ../src/guestfs-actions.pod:3864 ../src/guestfs-actions.pod:3877
8750 #: ../src/guestfs-actions.pod:3891 ../src/guestfs-actions.pod:4892
8751 #: ../src/guestfs-actions.pod:5917 ../src/guestfs-actions.pod:5966
8752 #: ../src/guestfs-actions.pod:6834 ../src/guestfs-actions.pod:6846
8753 #: ../src/guestfs-actions.pod:6859 ../src/guestfs-actions.pod:6872
8754 #: ../src/guestfs-actions.pod:6894 ../src/guestfs-actions.pod:6907
8755 #: ../src/guestfs-actions.pod:6920 ../src/guestfs-actions.pod:6933
8756 #: ../src/guestfs-actions.pod:7725 ../src/guestfs-actions.pod:7744
8757 #: ../src/guestfs-actions.pod:7830 ../src/guestfs-actions.pod:7849
8758 #: ../src/guestfs-actions.pod:7895 ../src/guestfs-actions.pod:7914
8759 msgid "(Added in 1.0.66)"
8763 #: ../src/guestfs-actions.pod:1443
8764 msgid "guestfs_egrepi"
8768 #: ../src/guestfs-actions.pod:1445
8772 " guestfs_egrepi (guestfs_h *g,\n"
8773 " const char *regex,\n"
8774 " const char *path);\n"
8779 #: ../src/guestfs-actions.pod:1450 ../fish/guestfish-actions.pod:947
8781 "This calls the external C<egrep -i> program and returns the matching lines."
8785 #: ../src/guestfs-actions.pod:1462
8786 msgid "guestfs_equal"
8790 #: ../src/guestfs-actions.pod:1464
8794 " guestfs_equal (guestfs_h *g,\n"
8795 " const char *file1,\n"
8796 " const char *file2);\n"
8801 #: ../src/guestfs-actions.pod:1469 ../fish/guestfish-actions.pod:957
8803 "This compares the two files C<file1> and C<file2> and returns true if their "
8804 "content is exactly equal, or false otherwise."
8808 #: ../src/guestfs-actions.pod:1472 ../fish/guestfish-actions.pod:960
8809 msgid "The external L<cmp(1)> program is used for the comparison."
8813 #: ../src/guestfs-actions.pod:1478
8814 msgid "guestfs_exists"
8818 #: ../src/guestfs-actions.pod:1480
8822 " guestfs_exists (guestfs_h *g,\n"
8823 " const char *path);\n"
8828 #: ../src/guestfs-actions.pod:1484 ../fish/guestfish-actions.pod:966
8830 "This returns C<true> if and only if there is a file, directory (or anything) "
8831 "with the given C<path> name."
8835 #: ../src/guestfs-actions.pod:1487
8836 msgid "See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>."
8840 #: ../src/guestfs-actions.pod:1493
8841 msgid "guestfs_fallocate"
8845 #: ../src/guestfs-actions.pod:1495
8849 " guestfs_fallocate (guestfs_h *g,\n"
8850 " const char *path,\n"
8856 #: ../src/guestfs-actions.pod:1500 ../src/guestfs-actions.pod:1526
8857 #: ../fish/guestfish-actions.pod:975 ../fish/guestfish-actions.pod:994
8859 "This command preallocates a file (containing zero bytes) named C<path> of "
8860 "size C<len> bytes. If the file exists already, it is overwritten."
8864 #: ../src/guestfs-actions.pod:1504 ../fish/guestfish-actions.pod:979
8866 "Do not confuse this with the guestfish-specific C<alloc> command which "
8867 "allocates a file in the host and attaches it as a device."
8871 #: ../src/guestfs-actions.pod:1510 ../fish/guestfish-actions.pod:983
8873 "This function is deprecated. In new code, use the C<fallocate64> call "
8878 #: ../src/guestfs-actions.pod:1519
8879 msgid "guestfs_fallocate64"
8883 #: ../src/guestfs-actions.pod:1521
8887 " guestfs_fallocate64 (guestfs_h *g,\n"
8888 " const char *path,\n"
8894 #: ../src/guestfs-actions.pod:1530
8896 "Note that this call allocates disk blocks for the file. To create a sparse "
8897 "file use C<guestfs_truncate_size> instead."
8901 #: ../src/guestfs-actions.pod:1533
8903 "The deprecated call C<guestfs_fallocate> does the same, but owing to an "
8904 "oversight it only allowed 30 bit lengths to be specified, effectively "
8905 "limiting the maximum size of files created through that call to 1GB."
8909 #: ../src/guestfs-actions.pod:1538 ../fish/guestfish-actions.pod:1006
8911 "Do not confuse this with the guestfish-specific C<alloc> and C<sparse> "
8912 "commands which create a file in the host and attach it as a device."
8916 #: ../src/guestfs-actions.pod:1544
8917 msgid "(Added in 1.3.17)"
8921 #: ../src/guestfs-actions.pod:1546
8922 msgid "guestfs_fgrep"
8926 #: ../src/guestfs-actions.pod:1548
8930 " guestfs_fgrep (guestfs_h *g,\n"
8931 " const char *pattern,\n"
8932 " const char *path);\n"
8937 #: ../src/guestfs-actions.pod:1553 ../fish/guestfish-actions.pod:1014
8939 "This calls the external C<fgrep> program and returns the matching lines."
8943 #: ../src/guestfs-actions.pod:1565
8944 msgid "guestfs_fgrepi"
8948 #: ../src/guestfs-actions.pod:1567
8952 " guestfs_fgrepi (guestfs_h *g,\n"
8953 " const char *pattern,\n"
8954 " const char *path);\n"
8959 #: ../src/guestfs-actions.pod:1572 ../fish/guestfish-actions.pod:1024
8961 "This calls the external C<fgrep -i> program and returns the matching lines."
8965 #: ../src/guestfs-actions.pod:1584
8966 msgid "guestfs_file"
8970 #: ../src/guestfs-actions.pod:1586
8974 " guestfs_file (guestfs_h *g,\n"
8975 " const char *path);\n"
8980 #: ../src/guestfs-actions.pod:1590 ../fish/guestfish-actions.pod:1034
8982 "This call uses the standard L<file(1)> command to determine the type or "
8983 "contents of the file."
8987 #: ../src/guestfs-actions.pod:1593 ../fish/guestfish-actions.pod:1037
8989 "This call will also transparently look inside various types of compressed "
8994 #: ../src/guestfs-actions.pod:1596 ../fish/guestfish-actions.pod:1040
8996 "The exact command which runs is C<file -zb path>. Note in particular that "
8997 "the filename is not prepended to the output (the I<-b> option)."
9001 #: ../src/guestfs-actions.pod:1600 ../fish/guestfish-actions.pod:1044
9003 "The output depends on the output of the underlying L<file(1)> command and it "
9004 "can change in future in ways beyond our control. In other words, the output "
9005 "is not guaranteed by the ABI."
9009 #: ../src/guestfs-actions.pod:1604
9011 "See also: L<file(1)>, C<guestfs_vfs_type>, C<guestfs_lstat>, "
9012 "C<guestfs_is_file>, C<guestfs_is_blockdev> (etc), C<guestfs_is_zero>."
9016 #: ../src/guestfs-actions.pod:1612
9017 msgid "guestfs_file_architecture"
9021 #: ../src/guestfs-actions.pod:1614
9025 " guestfs_file_architecture (guestfs_h *g,\n"
9026 " const char *filename);\n"
9031 #: ../src/guestfs-actions.pod:1618 ../fish/guestfish-actions.pod:1055
9033 "This detects the architecture of the binary C<filename>, and returns it if "
9038 #: ../src/guestfs-actions.pod:1621 ../fish/guestfish-actions.pod:1058
9039 msgid "Currently defined architectures are:"
9043 #: ../src/guestfs-actions.pod:1625 ../fish/guestfish-actions.pod:1062
9048 #: ../src/guestfs-actions.pod:1627 ../fish/guestfish-actions.pod:1064
9050 "This string is returned for all 32 bit i386, i486, i586, i686 binaries "
9051 "irrespective of the precise processor requirements of the binary."
9055 #: ../src/guestfs-actions.pod:1630 ../fish/guestfish-actions.pod:1067
9060 #: ../src/guestfs-actions.pod:1632 ../fish/guestfish-actions.pod:1069
9061 msgid "64 bit x86-64."
9065 #: ../src/guestfs-actions.pod:1634 ../fish/guestfish-actions.pod:1071
9070 #: ../src/guestfs-actions.pod:1636 ../fish/guestfish-actions.pod:1073
9071 msgid "32 bit SPARC."
9075 #: ../src/guestfs-actions.pod:1638 ../fish/guestfish-actions.pod:1075
9080 #: ../src/guestfs-actions.pod:1640 ../fish/guestfish-actions.pod:1077
9081 msgid "64 bit SPARC V9 and above."
9085 #: ../src/guestfs-actions.pod:1642 ../fish/guestfish-actions.pod:1079
9090 #: ../src/guestfs-actions.pod:1644 ../fish/guestfish-actions.pod:1081
9091 msgid "Intel Itanium."
9092 msgstr "Intel Itanium."
9095 #: ../src/guestfs-actions.pod:1646 ../fish/guestfish-actions.pod:1083
9100 #: ../src/guestfs-actions.pod:1648 ../fish/guestfish-actions.pod:1085
9101 msgid "32 bit Power PC."
9105 #: ../src/guestfs-actions.pod:1650 ../fish/guestfish-actions.pod:1087
9110 #: ../src/guestfs-actions.pod:1652 ../fish/guestfish-actions.pod:1089
9111 msgid "64 bit Power PC."
9115 #: ../src/guestfs-actions.pod:1656 ../fish/guestfish-actions.pod:1093
9116 msgid "Libguestfs may return other architecture strings in future."
9120 #: ../src/guestfs-actions.pod:1658 ../fish/guestfish-actions.pod:1095
9121 msgid "The function works on at least the following types of files:"
9125 #: ../src/guestfs-actions.pod:1664 ../fish/guestfish-actions.pod:1101
9126 msgid "many types of Un*x and Linux binary"
9130 #: ../src/guestfs-actions.pod:1668 ../fish/guestfish-actions.pod:1105
9131 msgid "many types of Un*x and Linux shared library"
9135 #: ../src/guestfs-actions.pod:1672 ../fish/guestfish-actions.pod:1109
9136 msgid "Windows Win32 and Win64 binaries"
9140 #: ../src/guestfs-actions.pod:1676 ../fish/guestfish-actions.pod:1113
9141 msgid "Windows Win32 and Win64 DLLs"
9145 #: ../src/guestfs-actions.pod:1678 ../fish/guestfish-actions.pod:1115
9146 msgid "Win32 binaries and DLLs return C<i386>."
9150 #: ../src/guestfs-actions.pod:1680 ../fish/guestfish-actions.pod:1117
9151 msgid "Win64 binaries and DLLs return C<x86_64>."
9155 #: ../src/guestfs-actions.pod:1684 ../fish/guestfish-actions.pod:1121
9156 msgid "Linux kernel modules"
9160 #: ../src/guestfs-actions.pod:1688 ../fish/guestfish-actions.pod:1125
9161 msgid "Linux new-style initrd images"
9165 #: ../src/guestfs-actions.pod:1692 ../fish/guestfish-actions.pod:1129
9166 msgid "some non-x86 Linux vmlinuz kernels"
9170 #: ../src/guestfs-actions.pod:1696 ../fish/guestfish-actions.pod:1133
9171 msgid "What it can't do currently:"
9175 #: ../src/guestfs-actions.pod:1702 ../fish/guestfish-actions.pod:1139
9176 msgid "static libraries (libfoo.a)"
9180 #: ../src/guestfs-actions.pod:1706 ../fish/guestfish-actions.pod:1143
9181 msgid "Linux old-style initrd as compressed ext2 filesystem (RHEL 3)"
9185 #: ../src/guestfs-actions.pod:1710 ../fish/guestfish-actions.pod:1147
9186 msgid "x86 Linux vmlinuz kernels"
9190 #: ../src/guestfs-actions.pod:1712 ../fish/guestfish-actions.pod:1149
9192 "x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and "
9193 "compressed code, and are horribly hard to unpack. If you want to find the "
9194 "architecture of a kernel, use the architecture of the associated initrd or "
9195 "kernel module(s) instead."
9199 #: ../src/guestfs-actions.pod:1722 ../src/guestfs-actions.pod:1885
9200 #: ../src/guestfs-actions.pod:1902 ../src/guestfs-actions.pod:2601
9201 #: ../src/guestfs-actions.pod:2691 ../src/guestfs-actions.pod:2757
9202 #: ../src/guestfs-actions.pod:2944 ../src/guestfs-actions.pod:2962
9203 #: ../src/guestfs-actions.pod:3002 ../src/guestfs-actions.pod:3077
9204 #: ../src/guestfs-actions.pod:3170 ../src/guestfs-actions.pod:3407
9205 #: ../src/guestfs-actions.pod:3539
9206 msgid "(Added in 1.5.3)"
9210 #: ../src/guestfs-actions.pod:1724
9211 msgid "guestfs_filesize"
9215 #: ../src/guestfs-actions.pod:1726
9219 " guestfs_filesize (guestfs_h *g,\n"
9220 " const char *file);\n"
9225 #: ../src/guestfs-actions.pod:1730 ../fish/guestfish-actions.pod:1160
9226 msgid "This command returns the size of C<file> in bytes."
9230 #: ../src/guestfs-actions.pod:1732
9232 "To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>, "
9233 "C<guestfs_is_dir>, C<guestfs_is_file> etc. To get the size of block "
9234 "devices, use C<guestfs_blockdev_getsize64>."
9238 #: ../src/guestfs-actions.pod:1738
9239 msgid "(Added in 1.0.82)"
9243 #: ../src/guestfs-actions.pod:1740
9244 msgid "guestfs_fill"
9248 #: ../src/guestfs-actions.pod:1742
9252 " guestfs_fill (guestfs_h *g,\n"
9255 " const char *path);\n"
9260 #: ../src/guestfs-actions.pod:1748 ../fish/guestfish-actions.pod:1170
9262 "This command creates a new file called C<path>. The initial content of the "
9263 "file is C<len> octets of C<c>, where C<c> must be a number in the range C<"
9268 #: ../src/guestfs-actions.pod:1752
9270 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
9271 "C<guestfs_truncate_size>. To create a file with a pattern of repeating "
9272 "bytes use C<guestfs_fill_pattern>."
9276 #: ../src/guestfs-actions.pod:1764
9277 msgid "(Added in 1.0.79)"
9281 #: ../src/guestfs-actions.pod:1766
9282 msgid "guestfs_fill_pattern"
9286 #: ../src/guestfs-actions.pod:1768
9290 " guestfs_fill_pattern (guestfs_h *g,\n"
9291 " const char *pattern,\n"
9293 " const char *path);\n"
9298 #: ../src/guestfs-actions.pod:1774
9300 "This function is like C<guestfs_fill> except that it creates a new file of "
9301 "length C<len> containing the repeating pattern of bytes in C<pattern>. The "
9302 "pattern is truncated if necessary to ensure the length of the file is "
9303 "exactly C<len> bytes."
9307 #: ../src/guestfs-actions.pod:1786
9308 msgid "(Added in 1.3.12)"
9312 #: ../src/guestfs-actions.pod:1788
9313 msgid "guestfs_find"
9317 #: ../src/guestfs-actions.pod:1790
9321 " guestfs_find (guestfs_h *g,\n"
9322 " const char *directory);\n"
9327 #: ../src/guestfs-actions.pod:1794 ../fish/guestfish-actions.pod:1192
9329 "This command lists out all files and directories, recursively, starting at "
9330 "C<directory>. It is essentially equivalent to running the shell command "
9331 "C<find directory -print> but some post-processing happens on the output, "
9336 #: ../src/guestfs-actions.pod:1799 ../fish/guestfish-actions.pod:1197
9338 "This returns a list of strings I<without any prefix>. Thus if the directory "
9343 #: ../src/guestfs-actions.pod:1802 ../fish/guestfish-actions.pod:1200
9353 #: ../src/guestfs-actions.pod:1806
9355 "then the returned list from C<guestfs_find> C</tmp> would be 4 elements:"
9359 #: ../src/guestfs-actions.pod:1809 ../fish/guestfish-actions.pod:1207
9370 #: ../src/guestfs-actions.pod:1814 ../fish/guestfish-actions.pod:1212
9371 msgid "If C<directory> is not a directory, then this command returns an error."
9375 #: ../src/guestfs-actions.pod:1817 ../fish/guestfish-actions.pod:1215
9376 msgid "The returned list is sorted."
9380 #: ../src/guestfs-actions.pod:1819
9381 msgid "See also C<guestfs_find0>."
9385 #: ../src/guestfs-actions.pod:1828 ../src/guestfs-actions.pod:4297
9386 #: ../src/guestfs-actions.pod:6001
9387 msgid "(Added in 1.0.27)"
9391 #: ../src/guestfs-actions.pod:1830
9392 msgid "guestfs_find0"
9396 #: ../src/guestfs-actions.pod:1832
9400 " guestfs_find0 (guestfs_h *g,\n"
9401 " const char *directory,\n"
9402 " const char *files);\n"
9407 #: ../src/guestfs-actions.pod:1837 ../fish/guestfish-actions.pod:1226
9409 "This command lists out all files and directories, recursively, starting at "
9410 "C<directory>, placing the resulting list in the external file called "
9415 #: ../src/guestfs-actions.pod:1841
9417 "This command works the same way as C<guestfs_find> with the following "
9422 #: ../src/guestfs-actions.pod:1848 ../fish/guestfish-actions.pod:1237
9423 msgid "The resulting list is written to an external file."
9427 #: ../src/guestfs-actions.pod:1852 ../fish/guestfish-actions.pod:1241
9429 "Items (filenames) in the result are separated by C<\\0> characters. See "
9430 "L<find(1)> option I<-print0>."
9434 #: ../src/guestfs-actions.pod:1857 ../fish/guestfish-actions.pod:1246
9435 msgid "This command is not limited in the number of names that it can return."
9439 #: ../src/guestfs-actions.pod:1862 ../fish/guestfish-actions.pod:1251
9440 msgid "The result list is not sorted."
9444 #: ../src/guestfs-actions.pod:1868
9445 msgid "(Added in 1.0.74)"
9449 #: ../src/guestfs-actions.pod:1870
9450 msgid "guestfs_findfs_label"
9454 #: ../src/guestfs-actions.pod:1872
9458 " guestfs_findfs_label (guestfs_h *g,\n"
9459 " const char *label);\n"
9464 #: ../src/guestfs-actions.pod:1876 ../fish/guestfish-actions.pod:1261
9466 "This command searches the filesystems and returns the one which has the "
9467 "given label. An error is returned if no such filesystem can be found."
9471 #: ../src/guestfs-actions.pod:1880
9472 msgid "To find the label of a filesystem, use C<guestfs_vfs_label>."
9476 #: ../src/guestfs-actions.pod:1887
9477 msgid "guestfs_findfs_uuid"
9481 #: ../src/guestfs-actions.pod:1889
9485 " guestfs_findfs_uuid (guestfs_h *g,\n"
9486 " const char *uuid);\n"
9491 #: ../src/guestfs-actions.pod:1893 ../fish/guestfish-actions.pod:1271
9493 "This command searches the filesystems and returns the one which has the "
9494 "given UUID. An error is returned if no such filesystem can be found."
9498 #: ../src/guestfs-actions.pod:1897
9499 msgid "To find the UUID of a filesystem, use C<guestfs_vfs_uuid>."
9503 #: ../src/guestfs-actions.pod:1904
9504 msgid "guestfs_fsck"
9508 #: ../src/guestfs-actions.pod:1906
9512 " guestfs_fsck (guestfs_h *g,\n"
9513 " const char *fstype,\n"
9514 " const char *device);\n"
9519 #: ../src/guestfs-actions.pod:1911 ../fish/guestfish-actions.pod:1281
9521 "This runs the filesystem checker (fsck) on C<device> which should have "
9522 "filesystem type C<fstype>."
9526 #: ../src/guestfs-actions.pod:1914 ../fish/guestfish-actions.pod:1284
9528 "The returned integer is the status. See L<fsck(8)> for the list of status "
9529 "codes from C<fsck>."
9533 #: ../src/guestfs-actions.pod:1923 ../fish/guestfish-actions.pod:1293
9534 msgid "Multiple status codes can be summed together."
9538 #: ../src/guestfs-actions.pod:1927 ../fish/guestfish-actions.pod:1297
9540 "A non-zero return code can mean \"success\", for example if errors have been "
9541 "corrected on the filesystem."
9545 #: ../src/guestfs-actions.pod:1932 ../fish/guestfish-actions.pod:1302
9546 msgid "Checking or repairing NTFS volumes is not supported (by linux-ntfs)."
9550 #: ../src/guestfs-actions.pod:1937 ../fish/guestfish-actions.pod:1307
9552 "This command is entirely equivalent to running C<fsck -a -t fstype device>."
9556 #: ../src/guestfs-actions.pod:1941 ../src/guestfs-actions.pod:7768
9557 msgid "(Added in 1.0.16)"
9561 #: ../src/guestfs-actions.pod:1943
9562 msgid "guestfs_get_append"
9566 #: ../src/guestfs-actions.pod:1945
9570 " guestfs_get_append (guestfs_h *g);\n"
9575 #: ../src/guestfs-actions.pod:1948 ../fish/guestfish-actions.pod:1313
9577 "Return the additional kernel options which are added to the guest kernel "
9582 #: ../src/guestfs-actions.pod:1951 ../fish/guestfish-actions.pod:1316
9583 msgid "If C<NULL> then no options are added."
9587 #: ../src/guestfs-actions.pod:1953
9589 "This function returns a string which may be NULL. There is no way to return "
9590 "an error from this function. The string is owned by the guest handle and "
9591 "must I<not> be freed."
9595 #: ../src/guestfs-actions.pod:1957 ../src/guestfs-actions.pod:5679
9596 #: ../src/guestfs-actions.pod:6161 ../src/guestfs-actions.pod:6601
9597 #: ../src/guestfs-actions.pod:6620 ../src/guestfs-actions.pod:6636
9598 #: ../src/guestfs-actions.pod:6660 ../src/guestfs-actions.pod:7414
9599 #: ../src/guestfs-actions.pod:7429 ../src/guestfs-actions.pod:7811
9600 msgid "(Added in 1.0.26)"
9604 #: ../src/guestfs-actions.pod:1959
9605 msgid "guestfs_get_attach_method"
9609 #: ../src/guestfs-actions.pod:1961
9613 " guestfs_get_attach_method (guestfs_h *g);\n"
9618 #: ../src/guestfs-actions.pod:1964
9619 msgid "Return the current attach method. See C<guestfs_set_attach_method>."
9623 #: ../src/guestfs-actions.pod:1969 ../src/guestfs-actions.pod:6191
9624 msgid "(Added in 1.9.8)"
9628 #: ../src/guestfs-actions.pod:1971
9629 msgid "guestfs_get_autosync"
9633 #: ../src/guestfs-actions.pod:1973
9637 " guestfs_get_autosync (guestfs_h *g);\n"
9642 #: ../src/guestfs-actions.pod:1976 ../fish/guestfish-actions.pod:1328
9643 msgid "Get the autosync flag."
9647 #: ../src/guestfs-actions.pod:1982
9648 msgid "guestfs_get_direct"
9652 #: ../src/guestfs-actions.pod:1984
9656 " guestfs_get_direct (guestfs_h *g);\n"
9661 #: ../src/guestfs-actions.pod:1987 ../fish/guestfish-actions.pod:1334
9662 msgid "Return the direct appliance mode flag."
9666 #: ../src/guestfs-actions.pod:1991 ../src/guestfs-actions.pod:6232
9667 msgid "(Added in 1.0.72)"
9671 #: ../src/guestfs-actions.pod:1993
9672 msgid "guestfs_get_e2label"
9676 #: ../src/guestfs-actions.pod:1995
9680 " guestfs_get_e2label (guestfs_h *g,\n"
9681 " const char *device);\n"
9686 #: ../src/guestfs-actions.pod:1999 ../fish/guestfish-actions.pod:1340
9688 "This returns the ext2/3/4 filesystem label of the filesystem on C<device>."
9692 #: ../src/guestfs-actions.pod:2005 ../fish/guestfish-actions.pod:1343
9694 "This function is deprecated. In new code, use the C<vfs_label> call instead."
9698 #: ../src/guestfs-actions.pod:2012 ../src/guestfs-actions.pod:2033
9699 #: ../src/guestfs-actions.pod:6250 ../src/guestfs-actions.pod:6269
9700 msgid "(Added in 1.0.15)"
9704 #: ../src/guestfs-actions.pod:2014
9705 msgid "guestfs_get_e2uuid"
9709 #: ../src/guestfs-actions.pod:2016
9713 " guestfs_get_e2uuid (guestfs_h *g,\n"
9714 " const char *device);\n"
9719 #: ../src/guestfs-actions.pod:2020 ../fish/guestfish-actions.pod:1354
9721 "This returns the ext2/3/4 filesystem UUID of the filesystem on C<device>."
9725 #: ../src/guestfs-actions.pod:2026 ../fish/guestfish-actions.pod:1357
9727 "This function is deprecated. In new code, use the C<vfs_uuid> call instead."
9731 #: ../src/guestfs-actions.pod:2035
9732 msgid "guestfs_get_memsize"
9736 #: ../src/guestfs-actions.pod:2037
9740 " guestfs_get_memsize (guestfs_h *g);\n"
9745 #: ../src/guestfs-actions.pod:2040 ../fish/guestfish-actions.pod:1368
9747 "This gets the memory size in megabytes allocated to the qemu subprocess."
9751 #: ../src/guestfs-actions.pod:2043
9753 "If C<guestfs_set_memsize> was not called on this handle, and if "
9754 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
9755 "value for memsize."
9759 #: ../src/guestfs-actions.pod:2047 ../src/guestfs-actions.pod:2137
9760 #: ../src/guestfs-actions.pod:6285 ../src/guestfs-actions.pod:6409
9761 #: ../fish/guestfish-actions.pod:1375 ../fish/guestfish-actions.pod:1432
9762 #: ../fish/guestfish-actions.pod:4157 ../fish/guestfish-actions.pod:4259
9764 "For more information on the architecture of libguestfs, see L<guestfs(3)>."
9768 #: ../src/guestfs-actions.pod:2052 ../src/guestfs-actions.pod:4588
9769 #: ../src/guestfs-actions.pod:4797 ../src/guestfs-actions.pod:4816
9770 #: ../src/guestfs-actions.pod:4835 ../src/guestfs-actions.pod:4847
9771 #: ../src/guestfs-actions.pod:4864 ../src/guestfs-actions.pod:4877
9772 #: ../src/guestfs-actions.pod:5904 ../src/guestfs-actions.pod:6290
9773 #: ../src/guestfs-actions.pod:6568 ../src/guestfs-actions.pod:7183
9774 msgid "(Added in 1.0.55)"
9778 #: ../src/guestfs-actions.pod:2054
9779 msgid "guestfs_get_network"
9783 #: ../src/guestfs-actions.pod:2056
9787 " guestfs_get_network (guestfs_h *g);\n"
9792 #: ../src/guestfs-actions.pod:2059 ../fish/guestfish-actions.pod:1382
9793 msgid "This returns the enable network flag."
9797 #: ../src/guestfs-actions.pod:2063 ../src/guestfs-actions.pod:6309
9798 msgid "(Added in 1.5.4)"
9802 #: ../src/guestfs-actions.pod:2065
9803 msgid "guestfs_get_path"
9807 #: ../src/guestfs-actions.pod:2067
9811 " guestfs_get_path (guestfs_h *g);\n"
9816 #: ../src/guestfs-actions.pod:2070 ../fish/guestfish-actions.pod:1388
9817 msgid "Return the current search path."
9821 #: ../src/guestfs-actions.pod:2072 ../fish/guestfish-actions.pod:1390
9823 "This is always non-NULL. If it wasn't set already, then this will return "
9828 #: ../src/guestfs-actions.pod:2075 ../src/guestfs-actions.pod:2113
9830 "This function returns a string, or NULL on error. The string is owned by "
9831 "the guest handle and must I<not> be freed."
9835 #: ../src/guestfs-actions.pod:2080
9836 msgid "guestfs_get_pgroup"
9840 #: ../src/guestfs-actions.pod:2082
9843 #| " guestfs_h *g = guestfs_create ();\n"
9847 " guestfs_get_pgroup (guestfs_h *g);\n"
9850 " guestfs_h *g = guestfs_create ();\n"
9854 #: ../src/guestfs-actions.pod:2085 ../fish/guestfish-actions.pod:1397
9855 msgid "This returns the process group flag."
9859 #: ../src/guestfs-actions.pod:2089
9860 msgid "guestfs_get_pid"
9864 #: ../src/guestfs-actions.pod:2091
9868 " guestfs_get_pid (guestfs_h *g);\n"
9873 #: ../src/guestfs-actions.pod:2094 ../fish/guestfish-actions.pod:1405
9875 "Return the process ID of the qemu subprocess. If there is no qemu "
9876 "subprocess, then this will return an error."
9880 #: ../src/guestfs-actions.pod:2097 ../fish/guestfish-actions.pod:1408
9881 msgid "This is an internal call used for debugging and testing."
9885 #: ../src/guestfs-actions.pod:2101
9886 msgid "(Added in 1.0.56)"
9890 #: ../src/guestfs-actions.pod:2103
9891 msgid "guestfs_get_qemu"
9895 #: ../src/guestfs-actions.pod:2105
9899 " guestfs_get_qemu (guestfs_h *g);\n"
9904 #: ../src/guestfs-actions.pod:2108 ../fish/guestfish-actions.pod:1414
9905 msgid "Return the current qemu binary."
9909 #: ../src/guestfs-actions.pod:2110 ../fish/guestfish-actions.pod:1416
9911 "This is always non-NULL. If it wasn't set already, then this will return "
9912 "the default qemu binary name."
9916 #: ../src/guestfs-actions.pod:2116 ../src/guestfs-actions.pod:6371
9917 msgid "(Added in 1.0.6)"
9921 #: ../src/guestfs-actions.pod:2118
9922 msgid "guestfs_get_recovery_proc"
9926 #: ../src/guestfs-actions.pod:2120
9930 " guestfs_get_recovery_proc (guestfs_h *g);\n"
9935 #: ../src/guestfs-actions.pod:2123 ../fish/guestfish-actions.pod:1423
9936 msgid "Return the recovery process enabled flag."
9940 #: ../src/guestfs-actions.pod:2127 ../src/guestfs-actions.pod:3661
9941 #: ../src/guestfs-actions.pod:3992 ../src/guestfs-actions.pod:4395
9942 #: ../src/guestfs-actions.pod:4427 ../src/guestfs-actions.pod:5609
9943 #: ../src/guestfs-actions.pod:5952 ../src/guestfs-actions.pod:6395
9944 #: ../src/guestfs-actions.pod:7086 ../src/guestfs-actions.pod:7106
9945 #: ../src/guestfs-actions.pod:7298
9946 msgid "(Added in 1.0.77)"
9950 #: ../src/guestfs-actions.pod:2129
9951 msgid "guestfs_get_selinux"
9955 #: ../src/guestfs-actions.pod:2131
9959 " guestfs_get_selinux (guestfs_h *g);\n"
9964 #: ../src/guestfs-actions.pod:2134
9966 "This returns the current setting of the selinux flag which is passed to the "
9967 "appliance at boot time. See C<guestfs_set_selinux>."
9971 #: ../src/guestfs-actions.pod:2142 ../src/guestfs-actions.pod:2205
9972 #: ../src/guestfs-actions.pod:6414 ../src/guestfs-actions.pod:6472
9973 msgid "(Added in 1.0.67)"
9977 #: ../src/guestfs-actions.pod:2144
9978 msgid "guestfs_get_state"
9982 #: ../src/guestfs-actions.pod:2146
9986 " guestfs_get_state (guestfs_h *g);\n"
9991 #: ../src/guestfs-actions.pod:2149 ../fish/guestfish-actions.pod:1439
9993 "This returns the current state as an opaque integer. This is only useful "
9994 "for printing debug and internal error messages."
9998 #: ../src/guestfs-actions.pod:2152 ../src/guestfs-actions.pod:3432
9999 #: ../src/guestfs-actions.pod:3461 ../src/guestfs-actions.pod:3522
10000 #: ../src/guestfs-actions.pod:3549 ../fish/guestfish-actions.pod:1442
10001 #: ../fish/guestfish-actions.pod:2362 ../fish/guestfish-actions.pod:2380
10002 #: ../fish/guestfish-actions.pod:2418 ../fish/guestfish-actions.pod:2434
10003 msgid "For more information on states, see L<guestfs(3)>."
10007 #: ../src/guestfs-actions.pod:2158
10008 msgid "guestfs_get_trace"
10012 #: ../src/guestfs-actions.pod:2160
10016 " guestfs_get_trace (guestfs_h *g);\n"
10021 #: ../src/guestfs-actions.pod:2163 ../fish/guestfish-actions.pod:1448
10022 msgid "Return the command trace flag."
10026 #: ../src/guestfs-actions.pod:2169
10027 msgid "guestfs_get_umask"
10031 #: ../src/guestfs-actions.pod:2171
10035 " guestfs_get_umask (guestfs_h *g);\n"
10040 #: ../src/guestfs-actions.pod:2174
10042 "Return the current umask. By default the umask is C<022> unless it has been "
10043 "set by calling C<guestfs_umask>."
10047 #: ../src/guestfs-actions.pod:2181
10048 msgid "guestfs_get_verbose"
10052 #: ../src/guestfs-actions.pod:2183
10056 " guestfs_get_verbose (guestfs_h *g);\n"
10061 #: ../src/guestfs-actions.pod:2186 ../fish/guestfish-actions.pod:1461
10062 msgid "This returns the verbose messages flag."
10066 #: ../src/guestfs-actions.pod:2192
10067 msgid "guestfs_getcon"
10071 #: ../src/guestfs-actions.pod:2194
10075 " guestfs_getcon (guestfs_h *g);\n"
10080 #: ../src/guestfs-actions.pod:2197 ../fish/guestfish-actions.pod:1467
10081 msgid "This gets the SELinux security context of the daemon."
10085 #: ../src/guestfs-actions.pod:2199
10087 "See the documentation about SELINUX in L<guestfs(3)>, and C<guestfs_setcon>"
10091 #: ../src/guestfs-actions.pod:2207
10092 msgid "guestfs_getxattr"
10096 #: ../src/guestfs-actions.pod:2209
10100 " guestfs_getxattr (guestfs_h *g,\n"
10101 " const char *path,\n"
10102 " const char *name,\n"
10103 " size_t *size_r);\n"
10108 #: ../src/guestfs-actions.pod:2215
10110 "Get a single extended attribute from file C<path> named C<name>. This call "
10111 "follows symlinks. If you want to lookup an extended attribute for the "
10112 "symlink itself, use C<guestfs_lgetxattr>."
10116 #: ../src/guestfs-actions.pod:2219 ../src/guestfs-actions.pod:3675
10118 "Normally it is better to get all extended attributes from a file in one go "
10119 "by calling C<guestfs_getxattrs>. However some Linux filesystem "
10120 "implementations are buggy and do not provide a way to list out attributes. "
10121 "For these filesystems (notably ntfs-3g) you have to know the names of the "
10122 "extended attributes you want in advance and call this function."
10126 #: ../src/guestfs-actions.pod:2226 ../src/guestfs-actions.pod:3682
10127 #: ../fish/guestfish-actions.pod:1487 ../fish/guestfish-actions.pod:2514
10129 "Extended attribute values are blobs of binary data. If there is no extended "
10130 "attribute named C<name>, this returns an error."
10134 #: ../src/guestfs-actions.pod:2229
10135 msgid "See also: C<guestfs_getxattrs>, C<guestfs_lgetxattr>, L<attr(5)>."
10139 #: ../src/guestfs-actions.pod:2231 ../src/guestfs-actions.pod:2422
10140 #: ../src/guestfs-actions.pod:2892 ../src/guestfs-actions.pod:3687
10141 #: ../src/guestfs-actions.pod:5602 ../src/guestfs-actions.pod:5628
10142 #: ../src/guestfs-actions.pod:5809
10144 "This function returns a buffer, or NULL on error. The size of the returned "
10145 "buffer is written to C<*size_r>. I<The caller must free the returned buffer "
10150 #: ../src/guestfs-actions.pod:2235 ../src/guestfs-actions.pod:3691
10151 msgid "(Added in 1.7.24)"
10155 #: ../src/guestfs-actions.pod:2237
10156 msgid "guestfs_getxattrs"
10160 #: ../src/guestfs-actions.pod:2239
10163 " struct guestfs_xattr_list *\n"
10164 " guestfs_getxattrs (guestfs_h *g,\n"
10165 " const char *path);\n"
10170 #: ../src/guestfs-actions.pod:2243 ../fish/guestfish-actions.pod:1496
10172 "This call lists the extended attributes of the file or directory C<path>."
10176 #: ../src/guestfs-actions.pod:2246 ../fish/guestfish-actions.pod:1499
10178 "At the system call level, this is a combination of the L<listxattr(2)> and "
10179 "L<getxattr(2)> calls."
10183 #: ../src/guestfs-actions.pod:2249
10184 msgid "See also: C<guestfs_lgetxattrs>, L<attr(5)>."
10188 #: ../src/guestfs-actions.pod:2251 ../src/guestfs-actions.pod:3703
10189 #: ../src/guestfs-actions.pod:4391
10191 "This function returns a C<struct guestfs_xattr_list *>, or NULL if there was "
10192 "an error. I<The caller must call C<guestfs_free_xattr_list> after use>."
10196 #: ../src/guestfs-actions.pod:2255 ../src/guestfs-actions.pod:3707
10197 #: ../src/guestfs-actions.pod:3906 ../src/guestfs-actions.pod:3942
10198 #: ../src/guestfs-actions.pod:5982 ../src/guestfs-actions.pod:6491
10199 #: ../src/guestfs-actions.pod:7876
10200 msgid "(Added in 1.0.59)"
10204 #: ../src/guestfs-actions.pod:2257
10205 msgid "guestfs_glob_expand"
10209 #: ../src/guestfs-actions.pod:2259
10213 " guestfs_glob_expand (guestfs_h *g,\n"
10214 " const char *pattern);\n"
10219 #: ../src/guestfs-actions.pod:2263 ../fish/guestfish-actions.pod:1508
10221 "This command searches for all the pathnames matching C<pattern> according to "
10222 "the wildcard expansion rules used by the shell."
10226 #: ../src/guestfs-actions.pod:2267 ../fish/guestfish-actions.pod:1512
10228 "If no paths match, then this returns an empty list (note: not an error)."
10232 #: ../src/guestfs-actions.pod:2270 ../fish/guestfish-actions.pod:1515
10234 "It is just a wrapper around the C L<glob(3)> function with flags C<GLOB_MARK|"
10235 "GLOB_BRACE>. See that manual page for more details."
10239 #: ../src/guestfs-actions.pod:2278 ../src/guestfs-actions.pod:6684
10240 #: ../src/guestfs-actions.pod:6701
10241 msgid "(Added in 1.0.50)"
10245 #: ../src/guestfs-actions.pod:2280
10246 msgid "guestfs_grep"
10250 #: ../src/guestfs-actions.pod:2282
10254 " guestfs_grep (guestfs_h *g,\n"
10255 " const char *regex,\n"
10256 " const char *path);\n"
10261 #: ../src/guestfs-actions.pod:2287 ../fish/guestfish-actions.pod:1523
10262 msgid "This calls the external C<grep> program and returns the matching lines."
10266 #: ../src/guestfs-actions.pod:2299
10267 msgid "guestfs_grepi"
10271 #: ../src/guestfs-actions.pod:2301
10275 " guestfs_grepi (guestfs_h *g,\n"
10276 " const char *regex,\n"
10277 " const char *path);\n"
10282 #: ../src/guestfs-actions.pod:2306 ../fish/guestfish-actions.pod:1533
10284 "This calls the external C<grep -i> program and returns the matching lines."
10288 #: ../src/guestfs-actions.pod:2318
10289 msgid "guestfs_grub_install"
10293 #: ../src/guestfs-actions.pod:2320
10297 " guestfs_grub_install (guestfs_h *g,\n"
10298 " const char *root,\n"
10299 " const char *device);\n"
10304 #: ../src/guestfs-actions.pod:2325 ../fish/guestfish-actions.pod:1543
10306 "This command installs GRUB (the Grand Unified Bootloader) on C<device>, with "
10307 "the root directory being C<root>."
10311 #: ../src/guestfs-actions.pod:2328 ../fish/guestfish-actions.pod:1546
10313 "Note: If grub-install reports the error \"No suitable drive was found in the "
10314 "generated device map.\" it may be that you need to create a C</boot/grub/"
10315 "device.map> file first that contains the mapping between grub device names "
10316 "and Linux device names. It is usually sufficient to create a file "
10321 #: ../src/guestfs-actions.pod:2335 ../fish/guestfish-actions.pod:1553
10324 " (hd0) /dev/vda\n"
10329 #: ../src/guestfs-actions.pod:2337 ../fish/guestfish-actions.pod:1555
10330 msgid "replacing C</dev/vda> with the name of the installation device."
10334 #: ../src/guestfs-actions.pod:2341
10335 msgid "(Added in 1.0.17)"
10339 #: ../src/guestfs-actions.pod:2343
10340 msgid "guestfs_head"
10344 #: ../src/guestfs-actions.pod:2345
10348 " guestfs_head (guestfs_h *g,\n"
10349 " const char *path);\n"
10354 #: ../src/guestfs-actions.pod:2349 ../fish/guestfish-actions.pod:1561
10356 "This command returns up to the first 10 lines of a file as a list of strings."
10360 #: ../src/guestfs-actions.pod:2361
10361 msgid "guestfs_head_n"
10365 #: ../src/guestfs-actions.pod:2363
10369 " guestfs_head_n (guestfs_h *g,\n"
10371 " const char *path);\n"
10376 #: ../src/guestfs-actions.pod:2368 ../fish/guestfish-actions.pod:1571
10378 "If the parameter C<nrlines> is a positive number, this returns the first "
10379 "C<nrlines> lines of the file C<path>."
10383 #: ../src/guestfs-actions.pod:2371 ../fish/guestfish-actions.pod:1574
10385 "If the parameter C<nrlines> is a negative number, this returns lines from "
10386 "the file C<path>, excluding the last C<nrlines> lines."
10390 #: ../src/guestfs-actions.pod:2374 ../src/guestfs-actions.pod:6981
10391 #: ../fish/guestfish-actions.pod:1577 ../fish/guestfish-actions.pod:4637
10392 msgid "If the parameter C<nrlines> is zero, this returns an empty list."
10396 #: ../src/guestfs-actions.pod:2385
10397 msgid "guestfs_hexdump"
10401 #: ../src/guestfs-actions.pod:2387
10405 " guestfs_hexdump (guestfs_h *g,\n"
10406 " const char *path);\n"
10411 #: ../src/guestfs-actions.pod:2391 ../fish/guestfish-actions.pod:1586
10413 "This runs C<hexdump -C> on the given C<path>. The result is the human-"
10414 "readable, canonical hex dump of the file."
10418 #: ../src/guestfs-actions.pod:2400 ../src/guestfs-actions.pod:6765
10419 #: ../src/guestfs-actions.pod:6820
10420 msgid "(Added in 1.0.22)"
10424 #: ../src/guestfs-actions.pod:2402
10425 msgid "guestfs_initrd_cat"
10429 #: ../src/guestfs-actions.pod:2404
10433 " guestfs_initrd_cat (guestfs_h *g,\n"
10434 " const char *initrdpath,\n"
10435 " const char *filename,\n"
10436 " size_t *size_r);\n"
10441 #: ../src/guestfs-actions.pod:2410 ../fish/guestfish-actions.pod:1596
10443 "This command unpacks the file C<filename> from the initrd file called "
10444 "C<initrdpath>. The filename must be given I<without> the initial C</> "
10449 #: ../src/guestfs-actions.pod:2414 ../fish/guestfish-actions.pod:1600
10451 "For example, in guestfish you could use the following command to examine the "
10452 "boot script (usually called C</init>) contained in a Linux initrd or "
10457 #: ../src/guestfs-actions.pod:2418 ../fish/guestfish-actions.pod:1604
10460 " initrd-cat /boot/initrd-<version>.img init\n"
10465 #: ../src/guestfs-actions.pod:2420
10466 msgid "See also C<guestfs_initrd_list>."
10470 #: ../src/guestfs-actions.pod:2431
10471 msgid "guestfs_initrd_list"
10475 #: ../src/guestfs-actions.pod:2433
10479 " guestfs_initrd_list (guestfs_h *g,\n"
10480 " const char *path);\n"
10485 #: ../src/guestfs-actions.pod:2437 ../fish/guestfish-actions.pod:1615
10486 msgid "This command lists out files contained in an initrd."
10490 #: ../src/guestfs-actions.pod:2439 ../fish/guestfish-actions.pod:1617
10492 "The files are listed without any initial C</> character. The files are "
10493 "listed in the order they appear (not necessarily alphabetical). Directory "
10494 "names are listed as separate items."
10498 #: ../src/guestfs-actions.pod:2443 ../fish/guestfish-actions.pod:1621
10500 "Old Linux kernels (2.4 and earlier) used a compressed ext2 filesystem as "
10501 "initrd. We I<only> support the newer initramfs format (compressed cpio "
10506 #: ../src/guestfs-actions.pod:2453
10507 msgid "guestfs_inotify_add_watch"
10511 #: ../src/guestfs-actions.pod:2455
10515 " guestfs_inotify_add_watch (guestfs_h *g,\n"
10516 " const char *path,\n"
10522 #: ../src/guestfs-actions.pod:2460 ../fish/guestfish-actions.pod:1629
10523 msgid "Watch C<path> for the events listed in C<mask>."
10527 #: ../src/guestfs-actions.pod:2462 ../fish/guestfish-actions.pod:1631
10529 "Note that if C<path> is a directory then events within that directory are "
10530 "watched, but this does I<not> happen recursively (in subdirectories)."
10534 #: ../src/guestfs-actions.pod:2466 ../fish/guestfish-actions.pod:1635
10536 "Note for non-C or non-Linux callers: the inotify events are defined by the "
10537 "Linux kernel ABI and are listed in C</usr/include/sys/inotify.h>."
10541 #: ../src/guestfs-actions.pod:2474
10542 msgid "guestfs_inotify_close"
10546 #: ../src/guestfs-actions.pod:2476
10550 " guestfs_inotify_close (guestfs_h *g);\n"
10555 #: ../src/guestfs-actions.pod:2479 ../fish/guestfish-actions.pod:1643
10557 "This closes the inotify handle which was previously opened by inotify_init. "
10558 "It removes all watches, throws away any pending events, and deallocates all "
10563 #: ../src/guestfs-actions.pod:2487
10564 msgid "guestfs_inotify_files"
10568 #: ../src/guestfs-actions.pod:2489
10572 " guestfs_inotify_files (guestfs_h *g);\n"
10577 #: ../src/guestfs-actions.pod:2492
10579 "This function is a helpful wrapper around C<guestfs_inotify_read> which just "
10580 "returns a list of pathnames of objects that were touched. The returned "
10581 "pathnames are sorted and deduplicated."
10585 #: ../src/guestfs-actions.pod:2502
10586 msgid "guestfs_inotify_init"
10590 #: ../src/guestfs-actions.pod:2504
10594 " guestfs_inotify_init (guestfs_h *g,\n"
10595 " int maxevents);\n"
10600 #: ../src/guestfs-actions.pod:2508 ../fish/guestfish-actions.pod:1659
10602 "This command creates a new inotify handle. The inotify subsystem can be "
10603 "used to notify events which happen to objects in the guest filesystem."
10607 #: ../src/guestfs-actions.pod:2512
10609 "C<maxevents> is the maximum number of events which will be queued up between "
10610 "calls to C<guestfs_inotify_read> or C<guestfs_inotify_files>. If this is "
10611 "passed as C<0>, then the kernel (or previously set) default is used. For "
10612 "Linux 2.6.29 the default was 16384 events. Beyond this limit, the kernel "
10613 "throws away events, but records the fact that it threw them away by setting "
10614 "a flag C<IN_Q_OVERFLOW> in the returned structure list (see "
10615 "C<guestfs_inotify_read>)."
10619 #: ../src/guestfs-actions.pod:2522
10621 "Before any events are generated, you have to add some watches to the "
10622 "internal watch list. See: C<guestfs_inotify_add_watch>, "
10623 "C<guestfs_inotify_rm_watch> and C<guestfs_inotify_watch_all>."
10627 #: ../src/guestfs-actions.pod:2528
10629 "Queued up events should be read periodically by calling "
10630 "C<guestfs_inotify_read> (or C<guestfs_inotify_files> which is just a helpful "
10631 "wrapper around C<guestfs_inotify_read>). If you don't read the events out "
10632 "often enough then you risk the internal queue overflowing."
10636 #: ../src/guestfs-actions.pod:2535
10638 "The handle should be closed after use by calling C<guestfs_inotify_close>. "
10639 "This also removes any watches automatically."
10643 #: ../src/guestfs-actions.pod:2539 ../fish/guestfish-actions.pod:1690
10645 "See also L<inotify(7)> for an overview of the inotify interface as exposed "
10646 "by the Linux kernel, which is roughly what we expose via libguestfs. Note "
10647 "that there is one global inotify handle per libguestfs instance."
10651 #: ../src/guestfs-actions.pod:2548
10652 msgid "guestfs_inotify_read"
10656 #: ../src/guestfs-actions.pod:2550
10659 " struct guestfs_inotify_event_list *\n"
10660 " guestfs_inotify_read (guestfs_h *g);\n"
10665 #: ../src/guestfs-actions.pod:2553 ../fish/guestfish-actions.pod:1699
10667 "Return the complete queue of events that have happened since the previous "
10672 #: ../src/guestfs-actions.pod:2556 ../fish/guestfish-actions.pod:1702
10673 msgid "If no events have happened, this returns an empty list."
10677 #: ../src/guestfs-actions.pod:2558 ../fish/guestfish-actions.pod:1704
10679 "I<Note>: In order to make sure that all events have been read, you must call "
10680 "this function repeatedly until it returns an empty list. The reason is that "
10681 "the call will read events up to the maximum appliance-to-host message size "
10682 "and leave remaining events in the queue."
10686 #: ../src/guestfs-actions.pod:2564
10688 "This function returns a C<struct guestfs_inotify_event_list *>, or NULL if "
10689 "there was an error. I<The caller must call "
10690 "C<guestfs_free_inotify_event_list> after use>."
10694 #: ../src/guestfs-actions.pod:2570
10695 msgid "guestfs_inotify_rm_watch"
10699 #: ../src/guestfs-actions.pod:2572
10703 " guestfs_inotify_rm_watch (guestfs_h *g,\n"
10709 #: ../src/guestfs-actions.pod:2576
10711 "Remove a previously defined inotify watch. See C<guestfs_inotify_add_watch>."
10715 #: ../src/guestfs-actions.pod:2583
10716 msgid "guestfs_inspect_get_arch"
10720 #: ../src/guestfs-actions.pod:2585
10724 " guestfs_inspect_get_arch (guestfs_h *g,\n"
10725 " const char *root);\n"
10730 #: ../src/guestfs-actions.pod:2589
10732 "This returns the architecture of the inspected operating system. The "
10733 "possible return values are listed under C<guestfs_file_architecture>."
10737 #: ../src/guestfs-actions.pod:2593 ../fish/guestfish-actions.pod:1725
10739 "If the architecture could not be determined, then the string C<unknown> is "
10744 #: ../src/guestfs-actions.pod:2596 ../src/guestfs-actions.pod:2686
10745 #: ../src/guestfs-actions.pod:2790 ../src/guestfs-actions.pod:2809
10746 #: ../src/guestfs-actions.pod:2940 ../src/guestfs-actions.pod:3023
10747 #: ../src/guestfs-actions.pod:3051 ../src/guestfs-actions.pod:3072
10748 #: ../src/guestfs-actions.pod:3125 ../src/guestfs-actions.pod:3165
10749 #: ../src/guestfs-actions.pod:3185 ../src/guestfs-actions.pod:3205
10750 #: ../src/guestfs-actions.pod:3222 ../src/guestfs-actions.pod:3238
10751 #: ../src/guestfs-actions.pod:3256 ../src/guestfs-actions.pod:3358
10752 #: ../src/guestfs-actions.pod:3399 ../fish/guestfish-actions.pod:1728
10753 #: ../fish/guestfish-actions.pod:1811 ../fish/guestfish-actions.pod:1890
10754 #: ../fish/guestfish-actions.pod:1902 ../fish/guestfish-actions.pod:1986
10755 #: ../fish/guestfish-actions.pod:2047 ../fish/guestfish-actions.pod:2068
10756 #: ../fish/guestfish-actions.pod:2082 ../fish/guestfish-actions.pod:2122
10757 #: ../fish/guestfish-actions.pod:2154 ../fish/guestfish-actions.pod:2167
10758 #: ../fish/guestfish-actions.pod:2180 ../fish/guestfish-actions.pod:2190
10759 #: ../fish/guestfish-actions.pod:2200 ../fish/guestfish-actions.pod:2212
10760 #: ../fish/guestfish-actions.pod:2308 ../fish/guestfish-actions.pod:2342
10761 msgid "Please read L<guestfs(3)/INSPECTION> for more details."
10765 #: ../src/guestfs-actions.pod:2603
10766 msgid "guestfs_inspect_get_distro"
10770 #: ../src/guestfs-actions.pod:2605
10774 " guestfs_inspect_get_distro (guestfs_h *g,\n"
10775 " const char *root);\n"
10780 #: ../src/guestfs-actions.pod:2609 ../fish/guestfish-actions.pod:1734
10782 "This returns the distro (distribution) of the inspected operating system."
10786 #: ../src/guestfs-actions.pod:2612 ../fish/guestfish-actions.pod:1737
10787 msgid "Currently defined distros are:"
10791 #: ../src/guestfs-actions.pod:2616 ../fish/guestfish-actions.pod:1741
10792 msgid "\"archlinux\""
10793 msgstr "\"archlinux\""
10796 #: ../src/guestfs-actions.pod:2618 ../fish/guestfish-actions.pod:1743
10797 msgid "Arch Linux."
10798 msgstr "Arch Linux."
10801 #: ../src/guestfs-actions.pod:2620 ../fish/guestfish-actions.pod:1745
10803 #| msgid "\"gentoo\""
10805 msgstr "\"gentoo\""
10808 #: ../src/guestfs-actions.pod:2622 ../fish/guestfish-actions.pod:1747
10813 #: ../src/guestfs-actions.pod:2624 ../fish/guestfish-actions.pod:1749
10815 msgstr "\"debian\""
10818 #: ../src/guestfs-actions.pod:2626 ../fish/guestfish-actions.pod:1751
10823 #: ../src/guestfs-actions.pod:2628 ../fish/guestfish-actions.pod:1753
10825 msgstr "\"fedora\""
10828 #: ../src/guestfs-actions.pod:2630 ../fish/guestfish-actions.pod:1755
10833 #: ../src/guestfs-actions.pod:2632 ../fish/guestfish-actions.pod:1757
10835 msgstr "\"gentoo\""
10838 #: ../src/guestfs-actions.pod:2634 ../fish/guestfish-actions.pod:1759
10843 #: ../src/guestfs-actions.pod:2636 ../fish/guestfish-actions.pod:1761
10844 msgid "\"linuxmint\""
10845 msgstr "\"linuxmint\""
10848 #: ../src/guestfs-actions.pod:2638 ../fish/guestfish-actions.pod:1763
10849 msgid "Linux Mint."
10850 msgstr "Linux Mint."
10853 #: ../src/guestfs-actions.pod:2640 ../fish/guestfish-actions.pod:1765
10854 msgid "\"mandriva\""
10855 msgstr "\"mandriva\""
10858 #: ../src/guestfs-actions.pod:2642 ../fish/guestfish-actions.pod:1767
10863 #: ../src/guestfs-actions.pod:2644 ../fish/guestfish-actions.pod:1769
10868 #: ../src/guestfs-actions.pod:2646 ../fish/guestfish-actions.pod:1771
10873 #: ../src/guestfs-actions.pod:2648 ../fish/guestfish-actions.pod:1773
10875 msgstr "\"pardus\""
10878 #: ../src/guestfs-actions.pod:2650 ../fish/guestfish-actions.pod:1775
10883 #: ../src/guestfs-actions.pod:2652 ../fish/guestfish-actions.pod:1777
10884 msgid "\"redhat-based\""
10885 msgstr "\"redhat-based\""
10888 #: ../src/guestfs-actions.pod:2654 ../fish/guestfish-actions.pod:1779
10889 msgid "Some Red Hat-derived distro."
10890 msgstr "Дистрибутив, що походить від Red Hat."
10893 #: ../src/guestfs-actions.pod:2656 ../fish/guestfish-actions.pod:1781
10898 #: ../src/guestfs-actions.pod:2658 ../fish/guestfish-actions.pod:1783
10900 #| msgid "Red Hat Enterprise Linux and some derivatives."
10901 msgid "Red Hat Enterprise Linux."
10902 msgstr "Red Hat Enterprise Linux та деякі з похідних дистрибутивів."
10905 #: ../src/guestfs-actions.pod:2660 ../fish/guestfish-actions.pod:1785
10906 msgid "\"scientificlinux\""
10910 #: ../src/guestfs-actions.pod:2662 ../fish/guestfish-actions.pod:1787
10911 msgid "Scientific Linux."
10915 #: ../src/guestfs-actions.pod:2664 ../fish/guestfish-actions.pod:1789
10916 msgid "\"slackware\""
10920 #: ../src/guestfs-actions.pod:2666 ../fish/guestfish-actions.pod:1791
10925 #: ../src/guestfs-actions.pod:2668 ../fish/guestfish-actions.pod:1793
10927 msgstr "\"ubuntu\""
10930 #: ../src/guestfs-actions.pod:2670 ../fish/guestfish-actions.pod:1795
10935 #: ../src/guestfs-actions.pod:2672 ../src/guestfs-actions.pod:2781
10936 #: ../src/guestfs-actions.pod:3156 ../fish/guestfish-actions.pod:1797
10937 #: ../fish/guestfish-actions.pod:1881 ../fish/guestfish-actions.pod:2145
10938 msgid "\"unknown\""
10939 msgstr "\"unknown\""
10942 #: ../src/guestfs-actions.pod:2674 ../fish/guestfish-actions.pod:1799
10943 msgid "The distro could not be determined."
10944 msgstr "Дистрибутив, тип якого не вдалося визначити."
10947 #: ../src/guestfs-actions.pod:2676 ../src/guestfs-actions.pod:3148
10948 #: ../fish/guestfish-actions.pod:1801 ../fish/guestfish-actions.pod:2137
10949 msgid "\"windows\""
10950 msgstr "\"windows\""
10953 #: ../src/guestfs-actions.pod:2678 ../fish/guestfish-actions.pod:1803
10955 "Windows does not have distributions. This string is returned if the OS type "
10960 #: ../src/guestfs-actions.pod:2683 ../src/guestfs-actions.pod:2787
10961 #: ../src/guestfs-actions.pod:3162 ../fish/guestfish-actions.pod:1808
10962 #: ../fish/guestfish-actions.pod:1887 ../fish/guestfish-actions.pod:2151
10964 "Future versions of libguestfs may return other strings here. The caller "
10965 "should be prepared to handle any string."
10969 #: ../src/guestfs-actions.pod:2693
10970 msgid "guestfs_inspect_get_drive_mappings"
10974 #: ../src/guestfs-actions.pod:2695
10978 " guestfs_inspect_get_drive_mappings (guestfs_h *g,\n"
10979 " const char *root);\n"
10984 #: ../src/guestfs-actions.pod:2699 ../fish/guestfish-actions.pod:1817
10986 "This call is useful for Windows which uses a primitive system of assigning "
10987 "drive letters (like \"C:\") to partitions. This inspection API examines the "
10988 "Windows Registry to find out how disks/partitions are mapped to drive "
10989 "letters, and returns a hash table as in the example below:"
10993 #: ../src/guestfs-actions.pod:2705 ../fish/guestfish-actions.pod:1823
10996 " C => /dev/vda2\n"
10997 " E => /dev/vdb1\n"
10998 " F => /dev/vdc1\n"
11003 #: ../src/guestfs-actions.pod:2709 ../fish/guestfish-actions.pod:1827
11005 "Note that keys are drive letters. For Windows, the key is case insensitive "
11006 "and just contains the drive letter, without the customary colon separator "
11011 #: ../src/guestfs-actions.pod:2713 ../fish/guestfish-actions.pod:1831
11013 "In future we may support other operating systems that also used drive "
11014 "letters, but the keys for those might not be case insensitive and might be "
11015 "longer than 1 character. For example in OS-9, hard drives were named C<h0>, "
11020 #: ../src/guestfs-actions.pod:2718 ../fish/guestfish-actions.pod:1836
11022 "For Windows guests, currently only hard drive mappings are returned. "
11023 "Removable disks (eg. DVD-ROMs) are ignored."
11027 #: ../src/guestfs-actions.pod:2721 ../fish/guestfish-actions.pod:1839
11029 "For guests that do not use drive mappings, or if the drive mappings could "
11030 "not be determined, this returns an empty hash table."
11034 #: ../src/guestfs-actions.pod:2724
11036 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
11037 "C<guestfs_inspect_get_mountpoints>, C<guestfs_inspect_get_filesystems>."
11041 #: ../src/guestfs-actions.pod:2728 ../src/guestfs-actions.pod:2996
11042 #: ../src/guestfs-actions.pod:3794 ../src/guestfs-actions.pod:5076
11043 #: ../src/guestfs-actions.pod:7122
11045 "This function returns a NULL-terminated array of strings, or NULL if there "
11046 "was an error. The array of strings will always have length C<2n+1>, where "
11047 "C<n> keys and values alternate, followed by the trailing NULL entry. I<The "
11048 "caller must free the strings and the array after use>."
11052 #: ../src/guestfs-actions.pod:2734 ../src/guestfs-actions.pod:3190
11053 msgid "(Added in 1.9.17)"
11057 #: ../src/guestfs-actions.pod:2736
11058 msgid "guestfs_inspect_get_filesystems"
11062 #: ../src/guestfs-actions.pod:2738
11066 " guestfs_inspect_get_filesystems (guestfs_h *g,\n"
11067 " const char *root);\n"
11072 #: ../src/guestfs-actions.pod:2742 ../fish/guestfish-actions.pod:1850
11074 "This returns a list of all the filesystems that we think are associated with "
11075 "this operating system. This includes the root filesystem, other ordinary "
11076 "filesystems, and non-mounted devices like swap partitions."
11080 #: ../src/guestfs-actions.pod:2747 ../fish/guestfish-actions.pod:1855
11082 "In the case of a multi-boot virtual machine, it is possible for a filesystem "
11083 "to be shared between operating systems."
11087 #: ../src/guestfs-actions.pod:2750
11089 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
11090 "C<guestfs_inspect_get_mountpoints>."
11094 #: ../src/guestfs-actions.pod:2759
11095 msgid "guestfs_inspect_get_format"
11099 #: ../src/guestfs-actions.pod:2761
11103 " guestfs_inspect_get_format (guestfs_h *g,\n"
11104 " const char *root);\n"
11109 #: ../src/guestfs-actions.pod:2765 ../fish/guestfish-actions.pod:1865
11111 "This returns the format of the inspected operating system. You can use it "
11112 "to detect install images, live CDs and similar."
11116 #: ../src/guestfs-actions.pod:2768 ../fish/guestfish-actions.pod:1868
11117 msgid "Currently defined formats are:"
11121 #: ../src/guestfs-actions.pod:2772 ../fish/guestfish-actions.pod:1872
11122 msgid "\"installed\""
11123 msgstr "\"installed\""
11126 #: ../src/guestfs-actions.pod:2774 ../fish/guestfish-actions.pod:1874
11127 msgid "This is an installed operating system."
11128 msgstr "Це встановлена операційна система."
11131 #: ../src/guestfs-actions.pod:2776 ../fish/guestfish-actions.pod:1876
11132 msgid "\"installer\""
11136 #: ../src/guestfs-actions.pod:2778 ../fish/guestfish-actions.pod:1878
11138 "The disk image being inspected is not an installed operating system, but a "
11139 "I<bootable> install disk, live CD, or similar."
11143 #: ../src/guestfs-actions.pod:2783 ../fish/guestfish-actions.pod:1883
11144 msgid "The format of this disk image is not known."
11148 #: ../src/guestfs-actions.pod:2795 ../src/guestfs-actions.pod:3226
11149 #: ../src/guestfs-actions.pod:3242 ../src/guestfs-actions.pod:3260
11150 #: ../src/guestfs-actions.pod:6020
11151 msgid "(Added in 1.9.4)"
11155 #: ../src/guestfs-actions.pod:2797
11156 msgid "guestfs_inspect_get_hostname"
11160 #: ../src/guestfs-actions.pod:2799
11164 " guestfs_inspect_get_hostname (guestfs_h *g,\n"
11165 " const char *root);\n"
11170 #: ../src/guestfs-actions.pod:2803 ../fish/guestfish-actions.pod:1896
11172 "This function returns the hostname of the operating system as found by "
11173 "inspection of the guest's configuration files."
11177 #: ../src/guestfs-actions.pod:2806 ../fish/guestfish-actions.pod:1899
11179 "If the hostname could not be determined, then the string C<unknown> is "
11184 #: ../src/guestfs-actions.pod:2814
11185 msgid "(Added in 1.7.9)"
11189 #: ../src/guestfs-actions.pod:2816
11190 msgid "guestfs_inspect_get_icon"
11194 #: ../src/guestfs-actions.pod:2818
11198 " guestfs_inspect_get_icon (guestfs_h *g,\n"
11199 " const char *root,\n"
11200 " size_t *size_r,\n"
11206 #: ../src/guestfs-actions.pod:2829
11209 " GUESTFS_INSPECT_GET_ICON_FAVICON, int favicon,\n"
11210 " GUESTFS_INSPECT_GET_ICON_HIGHQUALITY, int highquality,\n"
11215 #: ../src/guestfs-actions.pod:2832 ../fish/guestfish-actions.pod:1908
11217 "This function returns an icon corresponding to the inspected operating "
11218 "system. The icon is returned as a buffer containing a PNG image (re-encoded "
11219 "to PNG if necessary)."
11223 #: ../src/guestfs-actions.pod:2836 ../fish/guestfish-actions.pod:1912
11225 "If it was not possible to get an icon this function returns a zero-length "
11226 "(non-NULL) buffer. I<Callers must check for this case>."
11230 #: ../src/guestfs-actions.pod:2839 ../fish/guestfish-actions.pod:1915
11232 "Libguestfs will start by looking for a file called C</etc/favicon.png> or "
11233 "C<C:\\etc\\favicon.png> and if it has the correct format, the contents of "
11234 "this file will be returned. You can disable favicons by passing the "
11235 "optional C<favicon> boolean as false (default is true)."
11239 #: ../src/guestfs-actions.pod:2845 ../fish/guestfish-actions.pod:1921
11241 "If finding the favicon fails, then we look in other places in the guest for "
11246 #: ../src/guestfs-actions.pod:2848 ../fish/guestfish-actions.pod:1924
11248 "If the optional C<highquality> boolean is true then only high quality icons "
11249 "are returned, which means only icons of high resolution with an alpha "
11250 "channel. The default (false) is to return any icon we can, even if it is of "
11251 "substandard quality."
11255 #: ../src/guestfs-actions.pod:2859 ../fish/guestfish-actions.pod:1935
11257 "Unlike most other inspection API calls, the guest's disks must be mounted up "
11258 "before you call this, since it needs to read information from the guest "
11259 "filesystem during the call."
11263 #: ../src/guestfs-actions.pod:2865 ../fish/guestfish-actions.pod:1941
11265 "B<Security:> The icon data comes from the untrusted guest, and should be "
11266 "treated with caution. PNG files have been known to contain exploits. "
11267 "Ensure that libpng (or other relevant libraries) are fully up to date before "
11268 "trying to process or display the icon."
11272 #: ../src/guestfs-actions.pod:2873 ../fish/guestfish-actions.pod:1949
11274 "The PNG image returned can be any size. It might not be square. Libguestfs "
11275 "tries to return the largest, highest quality icon available. The "
11276 "application must scale the icon to the required size."
11280 #: ../src/guestfs-actions.pod:2880 ../fish/guestfish-actions.pod:1956
11282 "Extracting icons from Windows guests requires the external C<wrestool> "
11283 "program from the C<icoutils> package, and several programs (C<bmptopnm>, "
11284 "C<pnmtopng>, C<pamcut>) from the C<netpbm> package. These must be "
11285 "installed separately."
11289 #: ../src/guestfs-actions.pod:2887 ../fish/guestfish-actions.pod:1963
11291 "Operating system icons are usually trademarks. Seek legal advice before "
11292 "using trademarks in applications."
11296 #: ../src/guestfs-actions.pod:2896 ../src/guestfs-actions.pod:3721
11297 #: ../src/guestfs-actions.pod:4975
11298 msgid "(Added in 1.11.12)"
11302 #: ../src/guestfs-actions.pod:2898
11303 msgid "guestfs_inspect_get_icon_va"
11307 #: ../src/guestfs-actions.pod:2900
11311 " guestfs_inspect_get_icon_va (guestfs_h *g,\n"
11312 " const char *root,\n"
11313 " size_t *size_r,\n"
11314 " va_list args);\n"
11319 #: ../src/guestfs-actions.pod:2906
11320 msgid "This is the \"va_list variant\" of L</guestfs_inspect_get_icon>."
11324 #: ../src/guestfs-actions.pod:2910
11325 msgid "guestfs_inspect_get_icon_argv"
11329 #: ../src/guestfs-actions.pod:2912
11333 " guestfs_inspect_get_icon_argv (guestfs_h *g,\n"
11334 " const char *root,\n"
11335 " size_t *size_r,\n"
11336 " const struct guestfs_inspect_get_icon_argv *optargs);\n"
11341 #: ../src/guestfs-actions.pod:2918
11342 msgid "This is the \"argv variant\" of L</guestfs_inspect_get_icon>."
11346 #: ../src/guestfs-actions.pod:2922
11347 msgid "guestfs_inspect_get_major_version"
11351 #: ../src/guestfs-actions.pod:2924
11355 " guestfs_inspect_get_major_version (guestfs_h *g,\n"
11356 " const char *root);\n"
11361 #: ../src/guestfs-actions.pod:2928 ../fish/guestfish-actions.pod:1974
11363 "This returns the major version number of the inspected operating system."
11367 #: ../src/guestfs-actions.pod:2931 ../fish/guestfish-actions.pod:1977
11369 "Windows uses a consistent versioning scheme which is I<not> reflected in the "
11370 "popular public names used by the operating system. Notably the operating "
11371 "system known as \"Windows 7\" is really version 6.1 (ie. major = 6, minor = "
11372 "1). You can find out the real versions corresponding to releases of Windows "
11373 "by consulting Wikipedia or MSDN."
11377 #: ../src/guestfs-actions.pod:2938 ../src/guestfs-actions.pod:2955
11378 #: ../fish/guestfish-actions.pod:1984 ../fish/guestfish-actions.pod:1995
11379 msgid "If the version could not be determined, then C<0> is returned."
11383 #: ../src/guestfs-actions.pod:2946
11384 msgid "guestfs_inspect_get_minor_version"
11388 #: ../src/guestfs-actions.pod:2948
11392 " guestfs_inspect_get_minor_version (guestfs_h *g,\n"
11393 " const char *root);\n"
11398 #: ../src/guestfs-actions.pod:2952 ../fish/guestfish-actions.pod:1992
11400 "This returns the minor version number of the inspected operating system."
11404 #: ../src/guestfs-actions.pod:2957
11406 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
11407 "C<guestfs_inspect_get_major_version>."
11411 #: ../src/guestfs-actions.pod:2964
11412 msgid "guestfs_inspect_get_mountpoints"
11416 #: ../src/guestfs-actions.pod:2966
11420 " guestfs_inspect_get_mountpoints (guestfs_h *g,\n"
11421 " const char *root);\n"
11426 #: ../src/guestfs-actions.pod:2970 ../fish/guestfish-actions.pod:2004
11428 "This returns a hash of where we think the filesystems associated with this "
11429 "operating system should be mounted. Callers should note that this is at "
11430 "best an educated guess made by reading configuration files such as C</etc/"
11431 "fstab>. I<In particular note> that this may return filesystems which are "
11432 "non-existent or not mountable and callers should be prepared to handle or "
11433 "ignore failures if they try to mount them."
11437 #: ../src/guestfs-actions.pod:2979 ../fish/guestfish-actions.pod:2013
11439 "Each element in the returned hashtable has a key which is the path of the "
11440 "mountpoint (eg. C</boot>) and a value which is the filesystem that would be "
11441 "mounted there (eg. C</dev/sda1>)."
11445 #: ../src/guestfs-actions.pod:2984 ../fish/guestfish-actions.pod:2018
11447 "Non-mounted devices such as swap devices are I<not> returned in this list."
11451 #: ../src/guestfs-actions.pod:2987
11453 "For operating systems like Windows which still use drive letters, this call "
11454 "will only return an entry for the first drive \"mounted on\" C</>. For "
11455 "information about the mapping of drive letters to partitions, see "
11456 "C<guestfs_inspect_get_drive_mappings>."
11460 #: ../src/guestfs-actions.pod:2993
11462 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
11463 "C<guestfs_inspect_get_filesystems>."
11467 #: ../src/guestfs-actions.pod:3004
11468 msgid "guestfs_inspect_get_package_format"
11472 #: ../src/guestfs-actions.pod:3006
11476 " guestfs_inspect_get_package_format (guestfs_h *g,\n"
11477 " const char *root);\n"
11482 #: ../src/guestfs-actions.pod:3010
11484 "This function and C<guestfs_inspect_get_package_management> return the "
11485 "package format and package management tool used by the inspected operating "
11486 "system. For example for Fedora these functions would return C<rpm> (package "
11487 "format) and C<yum> (package management)."
11491 #: ../src/guestfs-actions.pod:3016 ../fish/guestfish-actions.pod:2040
11493 "This returns the string C<unknown> if we could not determine the package "
11494 "format I<or> if the operating system does not have a real packaging system "
11499 #: ../src/guestfs-actions.pod:3020 ../fish/guestfish-actions.pod:2044
11501 "Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>. "
11502 "Future versions of libguestfs may return other strings."
11506 #: ../src/guestfs-actions.pod:3028 ../src/guestfs-actions.pod:3056
11507 msgid "(Added in 1.7.5)"
11511 #: ../src/guestfs-actions.pod:3030
11512 msgid "guestfs_inspect_get_package_management"
11516 #: ../src/guestfs-actions.pod:3032
11520 " guestfs_inspect_get_package_management (guestfs_h *g,\n"
11521 " const char *root);\n"
11526 #: ../src/guestfs-actions.pod:3036
11528 "C<guestfs_inspect_get_package_format> and this function return the package "
11529 "format and package management tool used by the inspected operating system. "
11530 "For example for Fedora these functions would return C<rpm> (package format) "
11531 "and C<yum> (package management)."
11535 #: ../src/guestfs-actions.pod:3042 ../fish/guestfish-actions.pod:2059
11537 "This returns the string C<unknown> if we could not determine the package "
11538 "management tool I<or> if the operating system does not have a real packaging "
11539 "system (eg. Windows)."
11543 #: ../src/guestfs-actions.pod:3046 ../fish/guestfish-actions.pod:2063
11545 "Possible strings include: C<yum>, C<up2date>, C<apt> (for all Debian "
11546 "derivatives), C<portage>, C<pisi>, C<pacman>, C<urpmi>. Future versions of "
11547 "libguestfs may return other strings."
11551 #: ../src/guestfs-actions.pod:3058
11552 msgid "guestfs_inspect_get_product_name"
11556 #: ../src/guestfs-actions.pod:3060
11560 " guestfs_inspect_get_product_name (guestfs_h *g,\n"
11561 " const char *root);\n"
11566 #: ../src/guestfs-actions.pod:3064 ../fish/guestfish-actions.pod:2074
11568 "This returns the product name of the inspected operating system. The "
11569 "product name is generally some freeform string which can be displayed to the "
11570 "user, but should not be parsed by programs."
11574 #: ../src/guestfs-actions.pod:3069 ../fish/guestfish-actions.pod:2079
11576 "If the product name could not be determined, then the string C<unknown> is "
11581 #: ../src/guestfs-actions.pod:3079
11582 msgid "guestfs_inspect_get_product_variant"
11586 #: ../src/guestfs-actions.pod:3081
11590 " guestfs_inspect_get_product_variant (guestfs_h *g,\n"
11591 " const char *root);\n"
11596 #: ../src/guestfs-actions.pod:3085 ../fish/guestfish-actions.pod:2088
11598 #| msgid "This is an installed operating system."
11599 msgid "This returns the product variant of the inspected operating system."
11600 msgstr "Це встановлена операційна система."
11603 #: ../src/guestfs-actions.pod:3088 ../fish/guestfish-actions.pod:2091
11605 "For Windows guests, this returns the contents of the Registry key C<HKLM"
11606 "\\Software\\Microsoft\\Windows NT\\CurrentVersion> C<InstallationType> which "
11607 "is usually a string such as C<Client> or C<Server> (other values are "
11608 "possible). This can be used to distinguish consumer and enterprise versions "
11609 "of Windows that have the same version number (for example, Windows 7 and "
11610 "Windows 2008 Server are both version 6.1, but the former is C<Client> and "
11611 "the latter is C<Server>)."
11615 #: ../src/guestfs-actions.pod:3097 ../fish/guestfish-actions.pod:2100
11617 "For enterprise Linux guests, in future we intend this to return the product "
11618 "variant such as C<Desktop>, C<Server> and so on. But this is not "
11619 "implemented at present."
11623 #: ../src/guestfs-actions.pod:3101 ../fish/guestfish-actions.pod:2104
11625 "If the product variant could not be determined, then the string C<unknown> "
11630 #: ../src/guestfs-actions.pod:3104
11632 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
11633 "C<guestfs_inspect_get_product_name>, C<guestfs_inspect_get_major_version>."
11637 #: ../src/guestfs-actions.pod:3111
11638 msgid "(Added in 1.9.13)"
11642 #: ../src/guestfs-actions.pod:3113
11643 msgid "guestfs_inspect_get_roots"
11647 #: ../src/guestfs-actions.pod:3115
11651 " guestfs_inspect_get_roots (guestfs_h *g);\n"
11656 #: ../src/guestfs-actions.pod:3118
11658 "This function is a convenient way to get the list of root devices, as "
11659 "returned from a previous call to C<guestfs_inspect_os>, but without redoing "
11660 "the whole inspection process."
11664 #: ../src/guestfs-actions.pod:3122
11666 "This returns an empty list if either no root devices were found or the "
11667 "caller has not called C<guestfs_inspect_os>."
11671 #: ../src/guestfs-actions.pod:3131
11672 msgid "(Added in 1.7.3)"
11676 #: ../src/guestfs-actions.pod:3133
11677 msgid "guestfs_inspect_get_type"
11681 #: ../src/guestfs-actions.pod:3135
11685 " guestfs_inspect_get_type (guestfs_h *g,\n"
11686 " const char *root);\n"
11691 #: ../src/guestfs-actions.pod:3139 ../fish/guestfish-actions.pod:2128
11693 "This returns the type of the inspected operating system. Currently defined "
11698 #: ../src/guestfs-actions.pod:3144 ../fish/guestfish-actions.pod:2133
11703 #: ../src/guestfs-actions.pod:3146 ../fish/guestfish-actions.pod:2135
11704 msgid "Any Linux-based operating system."
11708 #: ../src/guestfs-actions.pod:3150 ../fish/guestfish-actions.pod:2139
11709 msgid "Any Microsoft Windows operating system."
11713 #: ../src/guestfs-actions.pod:3152 ../fish/guestfish-actions.pod:2141
11714 msgid "\"freebsd\""
11715 msgstr "\"freebsd\""
11718 #: ../src/guestfs-actions.pod:3154 ../fish/guestfish-actions.pod:2143
11723 #: ../src/guestfs-actions.pod:3158 ../fish/guestfish-actions.pod:2147
11724 msgid "The operating system type could not be determined."
11728 #: ../src/guestfs-actions.pod:3172
11729 msgid "guestfs_inspect_get_windows_current_control_set"
11733 #: ../src/guestfs-actions.pod:3174
11737 " guestfs_inspect_get_windows_current_control_set (guestfs_h *g,\n"
11738 " const char *root);\n"
11743 #: ../src/guestfs-actions.pod:3178 ../fish/guestfish-actions.pod:2160
11745 "This returns the Windows CurrentControlSet of the inspected guest. The "
11746 "CurrentControlSet is a registry key name such as C<ControlSet001>."
11750 #: ../src/guestfs-actions.pod:3181 ../fish/guestfish-actions.pod:2163
11752 "This call assumes that the guest is Windows and that the Registry could be "
11753 "examined by inspection. If this is not the case then an error is returned."
11757 #: ../src/guestfs-actions.pod:3192
11758 msgid "guestfs_inspect_get_windows_systemroot"
11762 #: ../src/guestfs-actions.pod:3194
11766 " guestfs_inspect_get_windows_systemroot (guestfs_h *g,\n"
11767 " const char *root);\n"
11772 #: ../src/guestfs-actions.pod:3198 ../fish/guestfish-actions.pod:2173
11774 "This returns the Windows systemroot of the inspected guest. The systemroot "
11775 "is a directory path such as C</WINDOWS>."
11779 #: ../src/guestfs-actions.pod:3201 ../fish/guestfish-actions.pod:2176
11781 "This call assumes that the guest is Windows and that the systemroot could be "
11782 "determined by inspection. If this is not the case then an error is returned."
11786 #: ../src/guestfs-actions.pod:3210
11787 msgid "(Added in 1.5.25)"
11791 #: ../src/guestfs-actions.pod:3212
11792 msgid "guestfs_inspect_is_live"
11796 #: ../src/guestfs-actions.pod:3214
11800 " guestfs_inspect_is_live (guestfs_h *g,\n"
11801 " const char *root);\n"
11806 #: ../src/guestfs-actions.pod:3218
11808 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
11809 "disk), then this returns true if a live image was detected on the disk."
11813 #: ../src/guestfs-actions.pod:3228
11814 msgid "guestfs_inspect_is_multipart"
11818 #: ../src/guestfs-actions.pod:3230
11822 " guestfs_inspect_is_multipart (guestfs_h *g,\n"
11823 " const char *root);\n"
11828 #: ../src/guestfs-actions.pod:3234
11830 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
11831 "disk), then this returns true if the disk is part of a set."
11835 #: ../src/guestfs-actions.pod:3244
11836 msgid "guestfs_inspect_is_netinst"
11840 #: ../src/guestfs-actions.pod:3246
11844 " guestfs_inspect_is_netinst (guestfs_h *g,\n"
11845 " const char *root);\n"
11850 #: ../src/guestfs-actions.pod:3250
11852 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
11853 "disk), then this returns true if the disk is a network installer, ie. not a "
11854 "self-contained install CD but one which is likely to require network access "
11855 "to complete the install."
11859 #: ../src/guestfs-actions.pod:3262
11860 msgid "guestfs_inspect_list_applications"
11864 #: ../src/guestfs-actions.pod:3264
11867 " struct guestfs_application_list *\n"
11868 " guestfs_inspect_list_applications (guestfs_h *g,\n"
11869 " const char *root);\n"
11874 #: ../src/guestfs-actions.pod:3268 ../fish/guestfish-actions.pod:2218
11875 msgid "Return the list of applications installed in the operating system."
11879 #: ../src/guestfs-actions.pod:3270
11881 "I<Note:> This call works differently from other parts of the inspection "
11882 "API. You have to call C<guestfs_inspect_os>, then "
11883 "C<guestfs_inspect_get_mountpoints>, then mount up the disks, before calling "
11884 "this. Listing applications is a significantly more difficult operation "
11885 "which requires access to the full filesystem. Also note that unlike the "
11886 "other C<guestfs_inspect_get_*> calls which are just returning data cached in "
11887 "the libguestfs handle, this call actually reads parts of the mounted "
11888 "filesystems during the call."
11892 #: ../src/guestfs-actions.pod:3280 ../fish/guestfish-actions.pod:2230
11894 "This returns an empty list if the inspection code was not able to determine "
11895 "the list of applications."
11899 #: ../src/guestfs-actions.pod:3283 ../fish/guestfish-actions.pod:2233
11900 msgid "The application structure contains the following fields:"
11904 #: ../src/guestfs-actions.pod:3287 ../fish/guestfish-actions.pod:2237
11905 msgid "C<app_name>"
11906 msgstr "C<app_name>"
11909 #: ../src/guestfs-actions.pod:3289 ../fish/guestfish-actions.pod:2239
11911 "The name of the application. For Red Hat-derived and Debian-derived Linux "
11912 "guests, this is the package name."
11916 #: ../src/guestfs-actions.pod:3292 ../fish/guestfish-actions.pod:2242
11917 msgid "C<app_display_name>"
11918 msgstr "C<app_display_name>"
11921 #: ../src/guestfs-actions.pod:3294 ../fish/guestfish-actions.pod:2244
11923 "The display name of the application, sometimes localized to the install "
11924 "language of the guest operating system."
11928 #: ../src/guestfs-actions.pod:3297 ../fish/guestfish-actions.pod:2247
11930 "If unavailable this is returned as an empty string C<\"\">. Callers needing "
11931 "to display something can use C<app_name> instead."
11935 #: ../src/guestfs-actions.pod:3300 ../fish/guestfish-actions.pod:2250
11936 msgid "C<app_epoch>"
11937 msgstr "C<app_epoch>"
11940 #: ../src/guestfs-actions.pod:3302 ../fish/guestfish-actions.pod:2252
11942 "For package managers which use epochs, this contains the epoch of the "
11943 "package (an integer). If unavailable, this is returned as C<0>."
11947 #: ../src/guestfs-actions.pod:3305 ../fish/guestfish-actions.pod:2255
11948 msgid "C<app_version>"
11949 msgstr "C<app_version>"
11952 #: ../src/guestfs-actions.pod:3307 ../fish/guestfish-actions.pod:2257
11954 "The version string of the application or package. If unavailable this is "
11955 "returned as an empty string C<\"\">."
11959 #: ../src/guestfs-actions.pod:3310 ../fish/guestfish-actions.pod:2260
11960 msgid "C<app_release>"
11961 msgstr "C<app_release>"
11964 #: ../src/guestfs-actions.pod:3312 ../fish/guestfish-actions.pod:2262
11966 "The release string of the application or package, for package managers that "
11967 "use this. If unavailable this is returned as an empty string C<\"\">."
11971 #: ../src/guestfs-actions.pod:3316 ../fish/guestfish-actions.pod:2266
11972 msgid "C<app_install_path>"
11973 msgstr "C<app_install_path>"
11976 #: ../src/guestfs-actions.pod:3318 ../fish/guestfish-actions.pod:2268
11978 "The installation path of the application (on operating systems such as "
11979 "Windows which use installation paths). This path is in the format used by "
11980 "the guest operating system, it is not a libguestfs path."
11984 #: ../src/guestfs-actions.pod:3323 ../fish/guestfish-actions.pod:2273
11985 msgid "If unavailable this is returned as an empty string C<\"\">."
11989 #: ../src/guestfs-actions.pod:3325 ../fish/guestfish-actions.pod:2275
11990 msgid "C<app_trans_path>"
11991 msgstr "C<app_trans_path>"
11994 #: ../src/guestfs-actions.pod:3327 ../fish/guestfish-actions.pod:2277
11996 "The install path translated into a libguestfs path. If unavailable this is "
11997 "returned as an empty string C<\"\">."
12001 #: ../src/guestfs-actions.pod:3330 ../fish/guestfish-actions.pod:2280
12002 msgid "C<app_publisher>"
12003 msgstr "C<app_publisher>"
12006 #: ../src/guestfs-actions.pod:3332 ../fish/guestfish-actions.pod:2282
12008 "The name of the publisher of the application, for package managers that use "
12009 "this. If unavailable this is returned as an empty string C<\"\">."
12013 #: ../src/guestfs-actions.pod:3336 ../fish/guestfish-actions.pod:2286
12015 msgstr "C<app_url>"
12018 #: ../src/guestfs-actions.pod:3338 ../fish/guestfish-actions.pod:2288
12020 "The URL (eg. upstream URL) of the application. If unavailable this is "
12021 "returned as an empty string C<\"\">."
12025 #: ../src/guestfs-actions.pod:3341 ../fish/guestfish-actions.pod:2291
12026 msgid "C<app_source_package>"
12030 #: ../src/guestfs-actions.pod:3343 ../fish/guestfish-actions.pod:2293
12032 "For packaging systems which support this, the name of the source package. "
12033 "If unavailable this is returned as an empty string C<\"\">."
12037 #: ../src/guestfs-actions.pod:3346 ../fish/guestfish-actions.pod:2296
12038 msgid "C<app_summary>"
12042 #: ../src/guestfs-actions.pod:3348 ../fish/guestfish-actions.pod:2298
12044 "A short (usually one line) description of the application or package. If "
12045 "unavailable this is returned as an empty string C<\"\">."
12049 #: ../src/guestfs-actions.pod:3351 ../fish/guestfish-actions.pod:2301
12050 msgid "C<app_description>"
12054 #: ../src/guestfs-actions.pod:3353 ../fish/guestfish-actions.pod:2303
12056 "A longer description of the application or package. If unavailable this is "
12057 "returned as an empty string C<\"\">."
12061 #: ../src/guestfs-actions.pod:3360
12063 "This function returns a C<struct guestfs_application_list *>, or NULL if "
12064 "there was an error. I<The caller must call C<guestfs_free_application_list> "
12069 #: ../src/guestfs-actions.pod:3364
12070 msgid "(Added in 1.7.8)"
12074 #: ../src/guestfs-actions.pod:3366
12075 msgid "guestfs_inspect_os"
12079 #: ../src/guestfs-actions.pod:3368
12083 " guestfs_inspect_os (guestfs_h *g);\n"
12088 #: ../src/guestfs-actions.pod:3371 ../fish/guestfish-actions.pod:2314
12090 "This function uses other libguestfs functions and certain heuristics to "
12091 "inspect the disk(s) (usually disks belonging to a virtual machine), looking "
12092 "for operating systems."
12096 #: ../src/guestfs-actions.pod:3375 ../fish/guestfish-actions.pod:2318
12097 msgid "The list returned is empty if no operating systems were found."
12101 #: ../src/guestfs-actions.pod:3377 ../fish/guestfish-actions.pod:2320
12103 "If one operating system was found, then this returns a list with a single "
12104 "element, which is the name of the root filesystem of this operating system. "
12105 "It is also possible for this function to return a list containing more than "
12106 "one element, indicating a dual-boot or multi-boot virtual machine, with each "
12107 "element being the root filesystem of one of the operating systems."
12111 #: ../src/guestfs-actions.pod:3384
12113 "You can pass the root string(s) returned to other C<guestfs_inspect_get_*> "
12114 "functions in order to query further information about each operating system, "
12115 "such as the name and version."
12119 #: ../src/guestfs-actions.pod:3389
12121 "This function uses other libguestfs features such as C<guestfs_mount_ro> and "
12122 "C<guestfs_umount_all> in order to mount and unmount filesystems and look at "
12123 "the contents. This should be called with no disks currently mounted. The "
12124 "function may also use Augeas, so any existing Augeas handle will be closed."
12128 #: ../src/guestfs-actions.pod:3395 ../fish/guestfish-actions.pod:2338
12130 "This function cannot decrypt encrypted disks. The caller must do that first "
12131 "(supplying the necessary keys) if the disk is encrypted."
12135 #: ../src/guestfs-actions.pod:3401 ../src/guestfs-actions.pod:3732
12136 #: ../src/guestfs-actions.pod:3814
12137 msgid "See also C<guestfs_list_filesystems>."
12141 #: ../src/guestfs-actions.pod:3409
12142 msgid "guestfs_is_blockdev"
12146 #: ../src/guestfs-actions.pod:3411
12150 " guestfs_is_blockdev (guestfs_h *g,\n"
12151 " const char *path);\n"
12156 #: ../src/guestfs-actions.pod:3415 ../fish/guestfish-actions.pod:2350
12158 "This returns C<true> if and only if there is a block device with the given "
12163 #: ../src/guestfs-actions.pod:3418 ../src/guestfs-actions.pod:3447
12164 #: ../src/guestfs-actions.pod:3477 ../src/guestfs-actions.pod:3492
12165 #: ../src/guestfs-actions.pod:3508 ../src/guestfs-actions.pod:3564
12166 #: ../src/guestfs-actions.pod:3579
12167 msgid "See also C<guestfs_stat>."
12171 #: ../src/guestfs-actions.pod:3422 ../src/guestfs-actions.pod:3451
12172 #: ../src/guestfs-actions.pod:3496 ../src/guestfs-actions.pod:3568
12173 #: ../src/guestfs-actions.pod:3583
12174 msgid "(Added in 1.5.10)"
12178 #: ../src/guestfs-actions.pod:3424
12179 msgid "guestfs_is_busy"
12183 #: ../src/guestfs-actions.pod:3426
12187 " guestfs_is_busy (guestfs_h *g);\n"
12192 #: ../src/guestfs-actions.pod:3429 ../fish/guestfish-actions.pod:2359
12194 "This returns true iff this handle is busy processing a command (in the "
12199 #: ../src/guestfs-actions.pod:3438
12200 msgid "guestfs_is_chardev"
12204 #: ../src/guestfs-actions.pod:3440
12208 " guestfs_is_chardev (guestfs_h *g,\n"
12209 " const char *path);\n"
12214 #: ../src/guestfs-actions.pod:3444 ../fish/guestfish-actions.pod:2368
12216 "This returns C<true> if and only if there is a character device with the "
12217 "given C<path> name."
12221 #: ../src/guestfs-actions.pod:3453
12222 msgid "guestfs_is_config"
12226 #: ../src/guestfs-actions.pod:3455
12230 " guestfs_is_config (guestfs_h *g);\n"
12235 #: ../src/guestfs-actions.pod:3458 ../fish/guestfish-actions.pod:2377
12237 "This returns true iff this handle is being configured (in the C<CONFIG> "
12242 #: ../src/guestfs-actions.pod:3467
12243 msgid "guestfs_is_dir"
12247 #: ../src/guestfs-actions.pod:3469
12251 " guestfs_is_dir (guestfs_h *g,\n"
12252 " const char *path);\n"
12257 #: ../src/guestfs-actions.pod:3473 ../fish/guestfish-actions.pod:2386
12259 "This returns C<true> if and only if there is a directory with the given "
12260 "C<path> name. Note that it returns false for other objects like files."
12264 #: ../src/guestfs-actions.pod:3483
12265 msgid "guestfs_is_fifo"
12269 #: ../src/guestfs-actions.pod:3485
12273 " guestfs_is_fifo (guestfs_h *g,\n"
12274 " const char *path);\n"
12279 #: ../src/guestfs-actions.pod:3489 ../fish/guestfish-actions.pod:2396
12281 "This returns C<true> if and only if there is a FIFO (named pipe) with the "
12282 "given C<path> name."
12286 #: ../src/guestfs-actions.pod:3498
12287 msgid "guestfs_is_file"
12291 #: ../src/guestfs-actions.pod:3500
12295 " guestfs_is_file (guestfs_h *g,\n"
12296 " const char *path);\n"
12301 #: ../src/guestfs-actions.pod:3504 ../fish/guestfish-actions.pod:2405
12303 "This returns C<true> if and only if there is a regular file with the given "
12304 "C<path> name. Note that it returns false for other objects like directories."
12308 #: ../src/guestfs-actions.pod:3514
12309 msgid "guestfs_is_launching"
12313 #: ../src/guestfs-actions.pod:3516
12317 " guestfs_is_launching (guestfs_h *g);\n"
12322 #: ../src/guestfs-actions.pod:3519 ../fish/guestfish-actions.pod:2415
12324 "This returns true iff this handle is launching the subprocess (in the "
12325 "C<LAUNCHING> state)."
12329 #: ../src/guestfs-actions.pod:3528
12330 msgid "guestfs_is_lv"
12334 #: ../src/guestfs-actions.pod:3530
12338 " guestfs_is_lv (guestfs_h *g,\n"
12339 " const char *device);\n"
12344 #: ../src/guestfs-actions.pod:3534 ../fish/guestfish-actions.pod:2424
12346 "This command tests whether C<device> is a logical volume, and returns true "
12347 "iff this is the case."
12351 #: ../src/guestfs-actions.pod:3541
12352 msgid "guestfs_is_ready"
12356 #: ../src/guestfs-actions.pod:3543
12360 " guestfs_is_ready (guestfs_h *g);\n"
12365 #: ../src/guestfs-actions.pod:3546 ../fish/guestfish-actions.pod:2431
12367 "This returns true iff this handle is ready to accept commands (in the "
12372 #: ../src/guestfs-actions.pod:3555
12373 msgid "guestfs_is_socket"
12377 #: ../src/guestfs-actions.pod:3557
12381 " guestfs_is_socket (guestfs_h *g,\n"
12382 " const char *path);\n"
12387 #: ../src/guestfs-actions.pod:3561 ../fish/guestfish-actions.pod:2440
12389 "This returns C<true> if and only if there is a Unix domain socket with the "
12390 "given C<path> name."
12394 #: ../src/guestfs-actions.pod:3570
12395 msgid "guestfs_is_symlink"
12399 #: ../src/guestfs-actions.pod:3572
12403 " guestfs_is_symlink (guestfs_h *g,\n"
12404 " const char *path);\n"
12409 #: ../src/guestfs-actions.pod:3576 ../fish/guestfish-actions.pod:2449
12411 "This returns C<true> if and only if there is a symbolic link with the given "
12416 #: ../src/guestfs-actions.pod:3585
12417 msgid "guestfs_is_zero"
12421 #: ../src/guestfs-actions.pod:3587
12425 " guestfs_is_zero (guestfs_h *g,\n"
12426 " const char *path);\n"
12431 #: ../src/guestfs-actions.pod:3591 ../fish/guestfish-actions.pod:2458
12433 "This returns true iff the file exists and the file is empty or it contains "
12438 #: ../src/guestfs-actions.pod:3596 ../src/guestfs-actions.pod:3610
12439 msgid "(Added in 1.11.8)"
12443 #: ../src/guestfs-actions.pod:3598
12444 msgid "guestfs_is_zero_device"
12448 #: ../src/guestfs-actions.pod:3600
12452 " guestfs_is_zero_device (guestfs_h *g,\n"
12453 " const char *device);\n"
12458 #: ../src/guestfs-actions.pod:3604 ../fish/guestfish-actions.pod:2465
12459 msgid "This returns true iff the device exists and contains all zero bytes."
12463 #: ../src/guestfs-actions.pod:3606 ../fish/guestfish-actions.pod:2467
12464 msgid "Note that for large devices this can take a long time to run."
12468 #: ../src/guestfs-actions.pod:3612
12469 msgid "guestfs_kill_subprocess"
12473 #: ../src/guestfs-actions.pod:3614
12477 " guestfs_kill_subprocess (guestfs_h *g);\n"
12482 #: ../src/guestfs-actions.pod:3617 ../fish/guestfish-actions.pod:2473
12483 msgid "This kills the qemu subprocess. You should never need to call this."
12487 #: ../src/guestfs-actions.pod:3623
12488 msgid "guestfs_launch"
12492 #: ../src/guestfs-actions.pod:3625
12496 " guestfs_launch (guestfs_h *g);\n"
12501 #: ../src/guestfs-actions.pod:3628 ../fish/guestfish-actions.pod:2481
12503 "Internally libguestfs is implemented by running a virtual machine using "
12508 #: ../src/guestfs-actions.pod:3631 ../fish/guestfish-actions.pod:2484
12510 "You should call this after configuring the handle (eg. adding drives) but "
12511 "before performing any actions."
12515 #: ../src/guestfs-actions.pod:3643
12516 msgid "guestfs_lchown"
12520 #: ../src/guestfs-actions.pod:3645
12524 " guestfs_lchown (guestfs_h *g,\n"
12527 " const char *path);\n"
12532 #: ../src/guestfs-actions.pod:3651
12534 "Change the file owner to C<owner> and group to C<group>. This is like "
12535 "C<guestfs_chown> but if C<path> is a symlink then the link itself is "
12536 "changed, not the target."
12540 #: ../src/guestfs-actions.pod:3663
12541 msgid "guestfs_lgetxattr"
12545 #: ../src/guestfs-actions.pod:3665
12549 " guestfs_lgetxattr (guestfs_h *g,\n"
12550 " const char *path,\n"
12551 " const char *name,\n"
12552 " size_t *size_r);\n"
12557 #: ../src/guestfs-actions.pod:3671 ../fish/guestfish-actions.pod:2503
12559 "Get a single extended attribute from file C<path> named C<name>. If C<path> "
12560 "is a symlink, then this call returns an extended attribute from the symlink."
12564 #: ../src/guestfs-actions.pod:3685
12565 msgid "See also: C<guestfs_lgetxattrs>, C<guestfs_getxattr>, L<attr(5)>."
12569 #: ../src/guestfs-actions.pod:3693
12570 msgid "guestfs_lgetxattrs"
12574 #: ../src/guestfs-actions.pod:3695
12577 " struct guestfs_xattr_list *\n"
12578 " guestfs_lgetxattrs (guestfs_h *g,\n"
12579 " const char *path);\n"
12584 #: ../src/guestfs-actions.pod:3699
12586 "This is the same as C<guestfs_getxattrs>, but if C<path> is a symbolic link, "
12587 "then it returns the extended attributes of the link itself."
12591 #: ../src/guestfs-actions.pod:3709
12592 msgid "guestfs_list_9p"
12596 #: ../src/guestfs-actions.pod:3711
12600 " guestfs_list_9p (guestfs_h *g);\n"
12605 #: ../src/guestfs-actions.pod:3714 ../fish/guestfish-actions.pod:2531
12607 "List all 9p filesystems attached to the guest. A list of mount tags is "
12612 #: ../src/guestfs-actions.pod:3723
12613 msgid "guestfs_list_devices"
12617 #: ../src/guestfs-actions.pod:3725
12621 " guestfs_list_devices (guestfs_h *g);\n"
12626 #: ../src/guestfs-actions.pod:3728 ../fish/guestfish-actions.pod:2538
12627 msgid "List all the block devices."
12631 #: ../src/guestfs-actions.pod:3730 ../fish/guestfish-actions.pod:2540
12632 msgid "The full block device names are returned, eg. C</dev/sda>."
12636 #: ../src/guestfs-actions.pod:3740
12637 msgid "guestfs_list_dm_devices"
12641 #: ../src/guestfs-actions.pod:3742
12645 " guestfs_list_dm_devices (guestfs_h *g);\n"
12650 #: ../src/guestfs-actions.pod:3745 ../fish/guestfish-actions.pod:2548
12651 msgid "List all device mapper devices."
12655 #: ../src/guestfs-actions.pod:3747
12657 "The returned list contains C</dev/mapper/*> devices, eg. ones created by a "
12658 "previous call to C<guestfs_luks_open>."
12662 #: ../src/guestfs-actions.pod:3750
12664 "Device mapper devices which correspond to logical volumes are I<not> "
12665 "returned in this list. Call C<guestfs_lvs> if you want to list logical "
12670 #: ../src/guestfs-actions.pod:3758 ../src/guestfs-actions.pod:5214
12671 msgid "(Added in 1.11.15)"
12675 #: ../src/guestfs-actions.pod:3760
12676 msgid "guestfs_list_filesystems"
12680 #: ../src/guestfs-actions.pod:3762
12684 " guestfs_list_filesystems (guestfs_h *g);\n"
12689 #: ../src/guestfs-actions.pod:3765 ../fish/guestfish-actions.pod:2561
12691 "This inspection command looks for filesystems on partitions, block devices "
12692 "and logical volumes, returning a list of devices containing filesystems and "
12697 #: ../src/guestfs-actions.pod:3769 ../fish/guestfish-actions.pod:2565
12699 "The return value is a hash, where the keys are the devices containing "
12700 "filesystems, and the values are the filesystem types. For example:"
12704 #: ../src/guestfs-actions.pod:3773 ../fish/guestfish-actions.pod:2569
12707 " \"/dev/sda1\" => \"ntfs\"\n"
12708 " \"/dev/sda2\" => \"ext2\"\n"
12709 " \"/dev/vg_guest/lv_root\" => \"ext4\"\n"
12710 " \"/dev/vg_guest/lv_swap\" => \"swap\"\n"
12715 #: ../src/guestfs-actions.pod:3778 ../fish/guestfish-actions.pod:2574
12717 "The value can have the special value \"unknown\", meaning the content of the "
12718 "device is undetermined or empty. \"swap\" means a Linux swap partition."
12722 #: ../src/guestfs-actions.pod:3782
12724 "This command runs other libguestfs commands, which might include "
12725 "C<guestfs_mount> and C<guestfs_umount>, and therefore you should use this "
12726 "soon after launch and only when nothing is mounted."
12730 #: ../src/guestfs-actions.pod:3786
12732 "Not all of the filesystems returned will be mountable. In particular, swap "
12733 "partitions are returned in the list. Also this command does not check that "
12734 "each filesystem found is valid and mountable, and some filesystems might be "
12735 "mountable but require special options. Filesystems may not all belong to a "
12736 "single logical operating system (use C<guestfs_inspect_os> to look for OSes)."
12740 #: ../src/guestfs-actions.pod:3800 ../src/guestfs-actions.pod:5569
12741 msgid "(Added in 1.5.15)"
12745 #: ../src/guestfs-actions.pod:3802
12746 msgid "guestfs_list_partitions"
12750 #: ../src/guestfs-actions.pod:3804
12754 " guestfs_list_partitions (guestfs_h *g);\n"
12759 #: ../src/guestfs-actions.pod:3807 ../fish/guestfish-actions.pod:2594
12760 msgid "List all the partitions detected on all block devices."
12764 #: ../src/guestfs-actions.pod:3809 ../fish/guestfish-actions.pod:2596
12765 msgid "The full partition device names are returned, eg. C</dev/sda1>"
12769 #: ../src/guestfs-actions.pod:3811
12771 "This does not return logical volumes. For that you will need to call "
12776 #: ../src/guestfs-actions.pod:3822
12781 #: ../src/guestfs-actions.pod:3824
12785 " guestfs_ll (guestfs_h *g,\n"
12786 " const char *directory);\n"
12791 #: ../src/guestfs-actions.pod:3828 ../fish/guestfish-actions.pod:2607
12793 "List the files in C<directory> (relative to the root directory, there is no "
12794 "cwd) in the format of 'ls -la'."
12798 #: ../src/guestfs-actions.pod:3831 ../fish/guestfish-actions.pod:2610
12800 "This command is mostly useful for interactive sessions. It is I<not> "
12801 "intended that you try to parse the output string."
12805 #: ../src/guestfs-actions.pod:3839
12810 #: ../src/guestfs-actions.pod:3841
12814 " guestfs_ln (guestfs_h *g,\n"
12815 " const char *target,\n"
12816 " const char *linkname);\n"
12821 #: ../src/guestfs-actions.pod:3846 ../fish/guestfish-actions.pod:2617
12822 msgid "This command creates a hard link using the C<ln> command."
12826 #: ../src/guestfs-actions.pod:3852
12827 msgid "guestfs_ln_f"
12831 #: ../src/guestfs-actions.pod:3854
12835 " guestfs_ln_f (guestfs_h *g,\n"
12836 " const char *target,\n"
12837 " const char *linkname);\n"
12842 #: ../src/guestfs-actions.pod:3859 ../fish/guestfish-actions.pod:2623
12844 "This command creates a hard link using the C<ln -f> command. The I<-f> "
12845 "option removes the link (C<linkname>) if it exists already."
12849 #: ../src/guestfs-actions.pod:3866
12850 msgid "guestfs_ln_s"
12854 #: ../src/guestfs-actions.pod:3868
12858 " guestfs_ln_s (guestfs_h *g,\n"
12859 " const char *target,\n"
12860 " const char *linkname);\n"
12865 #: ../src/guestfs-actions.pod:3873 ../fish/guestfish-actions.pod:2630
12866 msgid "This command creates a symbolic link using the C<ln -s> command."
12870 #: ../src/guestfs-actions.pod:3879
12871 msgid "guestfs_ln_sf"
12875 #: ../src/guestfs-actions.pod:3881
12879 " guestfs_ln_sf (guestfs_h *g,\n"
12880 " const char *target,\n"
12881 " const char *linkname);\n"
12886 #: ../src/guestfs-actions.pod:3886 ../fish/guestfish-actions.pod:2636
12888 "This command creates a symbolic link using the C<ln -sf> command, The I<-f> "
12889 "option removes the link (C<linkname>) if it exists already."
12893 #: ../src/guestfs-actions.pod:3893
12894 msgid "guestfs_lremovexattr"
12898 #: ../src/guestfs-actions.pod:3895
12902 " guestfs_lremovexattr (guestfs_h *g,\n"
12903 " const char *xattr,\n"
12904 " const char *path);\n"
12909 #: ../src/guestfs-actions.pod:3900
12911 "This is the same as C<guestfs_removexattr>, but if C<path> is a symbolic "
12912 "link, then it removes an extended attribute of the link itself."
12916 #: ../src/guestfs-actions.pod:3908
12921 #: ../src/guestfs-actions.pod:3910
12925 " guestfs_ls (guestfs_h *g,\n"
12926 " const char *directory);\n"
12931 #: ../src/guestfs-actions.pod:3914 ../fish/guestfish-actions.pod:2651
12933 "List the files in C<directory> (relative to the root directory, there is no "
12934 "cwd). The '.' and '..' entries are not returned, but hidden files are shown."
12938 #: ../src/guestfs-actions.pod:3918
12940 "This command is mostly useful for interactive sessions. Programs should "
12941 "probably use C<guestfs_readdir> instead."
12945 #: ../src/guestfs-actions.pod:3927
12946 msgid "guestfs_lsetxattr"
12950 #: ../src/guestfs-actions.pod:3929
12954 " guestfs_lsetxattr (guestfs_h *g,\n"
12955 " const char *xattr,\n"
12956 " const char *val,\n"
12958 " const char *path);\n"
12963 #: ../src/guestfs-actions.pod:3936
12965 "This is the same as C<guestfs_setxattr>, but if C<path> is a symbolic link, "
12966 "then it sets an extended attribute of the link itself."
12970 #: ../src/guestfs-actions.pod:3944
12971 msgid "guestfs_lstat"
12975 #: ../src/guestfs-actions.pod:3946
12978 " struct guestfs_stat *\n"
12979 " guestfs_lstat (guestfs_h *g,\n"
12980 " const char *path);\n"
12985 #: ../src/guestfs-actions.pod:3950 ../src/guestfs-actions.pod:6721
12986 #: ../fish/guestfish-actions.pod:2670 ../fish/guestfish-actions.pod:4472
12987 msgid "Returns file information for the given C<path>."
12991 #: ../src/guestfs-actions.pod:3952
12993 "This is the same as C<guestfs_stat> except that if C<path> is a symbolic "
12994 "link, then the link is stat-ed, not the file it refers to."
12998 #: ../src/guestfs-actions.pod:3956 ../fish/guestfish-actions.pod:2676
12999 msgid "This is the same as the C<lstat(2)> system call."
13003 #: ../src/guestfs-actions.pod:3958 ../src/guestfs-actions.pod:6725
13005 "This function returns a C<struct guestfs_stat *>, or NULL if there was an "
13006 "error. I<The caller must call C<guestfs_free_stat> after use>."
13010 #: ../src/guestfs-actions.pod:3962 ../src/guestfs-actions.pod:6729
13011 #: ../src/guestfs-actions.pod:6747 ../src/guestfs-actions.pod:7128
13012 msgid "(Added in 0.9.2)"
13016 #: ../src/guestfs-actions.pod:3964
13017 msgid "guestfs_lstatlist"
13021 #: ../src/guestfs-actions.pod:3966
13024 " struct guestfs_stat_list *\n"
13025 " guestfs_lstatlist (guestfs_h *g,\n"
13026 " const char *path,\n"
13027 " char *const *names);\n"
13032 #: ../src/guestfs-actions.pod:3971
13034 "This call allows you to perform the C<guestfs_lstat> operation on multiple "
13035 "files, where all files are in the directory C<path>. C<names> is the list "
13036 "of files from this directory."
13040 #: ../src/guestfs-actions.pod:3975 ../fish/guestfish-actions.pod:2686
13042 "On return you get a list of stat structs, with a one-to-one correspondence "
13043 "to the C<names> list. If any name did not exist or could not be lstat'd, "
13044 "then the C<ino> field of that structure is set to C<-1>."
13048 #: ../src/guestfs-actions.pod:3980
13050 "This call is intended for programs that want to efficiently list a directory "
13051 "contents without making many round-trips. See also C<guestfs_lxattrlist> "
13052 "for a similarly efficient call for getting extended attributes. Very long "
13053 "directory listings might cause the protocol message size to be exceeded, "
13054 "causing this call to fail. The caller must split up such requests into "
13055 "smaller groups of names."
13059 #: ../src/guestfs-actions.pod:3988
13061 "This function returns a C<struct guestfs_stat_list *>, or NULL if there was "
13062 "an error. I<The caller must call C<guestfs_free_stat_list> after use>."
13066 #: ../src/guestfs-actions.pod:3994
13067 msgid "guestfs_luks_add_key"
13071 #: ../src/guestfs-actions.pod:3996
13075 " guestfs_luks_add_key (guestfs_h *g,\n"
13076 " const char *device,\n"
13077 " const char *key,\n"
13078 " const char *newkey,\n"
13084 #: ../src/guestfs-actions.pod:4003 ../fish/guestfish-actions.pod:2703
13086 "This command adds a new key on LUKS device C<device>. C<key> is any "
13087 "existing key, and is used to access the device. C<newkey> is the new key to "
13088 "add. C<keyslot> is the key slot that will be replaced."
13092 #: ../src/guestfs-actions.pod:4008
13094 "Note that if C<keyslot> already contains a key, then this command will "
13095 "fail. You have to use C<guestfs_luks_kill_slot> first to remove that key."
13099 #: ../src/guestfs-actions.pod:4014 ../src/guestfs-actions.pod:4054
13100 #: ../src/guestfs-actions.pod:4077 ../src/guestfs-actions.pod:4097
13101 #: ../src/guestfs-actions.pod:4132 ../src/guestfs-actions.pod:4151
13103 "This function takes a key or passphrase parameter which could contain "
13104 "sensitive material. Read the section L</KEYS AND PASSPHRASES> for more "
13109 #: ../src/guestfs-actions.pod:4018 ../src/guestfs-actions.pod:4058
13110 #: ../src/guestfs-actions.pod:4081 ../src/guestfs-actions.pod:4101
13111 msgid "(Added in 1.5.2)"
13115 #: ../src/guestfs-actions.pod:4020
13116 msgid "guestfs_luks_close"
13120 #: ../src/guestfs-actions.pod:4022
13124 " guestfs_luks_close (guestfs_h *g,\n"
13125 " const char *device);\n"
13130 #: ../src/guestfs-actions.pod:4026
13132 "This closes a LUKS device that was created earlier by C<guestfs_luks_open> "
13133 "or C<guestfs_luks_open_ro>. The C<device> parameter must be the name of the "
13134 "LUKS mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
13135 "underlying block device."
13139 #: ../src/guestfs-actions.pod:4034 ../src/guestfs-actions.pod:4136
13140 #: ../src/guestfs-actions.pod:4155 ../src/guestfs-actions.pod:4205
13141 #: ../src/guestfs-actions.pod:4253
13142 msgid "(Added in 1.5.1)"
13146 #: ../src/guestfs-actions.pod:4036
13147 msgid "guestfs_luks_format"
13151 #: ../src/guestfs-actions.pod:4038
13155 " guestfs_luks_format (guestfs_h *g,\n"
13156 " const char *device,\n"
13157 " const char *key,\n"
13163 #: ../src/guestfs-actions.pod:4044 ../fish/guestfish-actions.pod:2729
13165 "This command erases existing data on C<device> and formats the device as a "
13166 "LUKS encrypted device. C<key> is the initial key, which is added to key "
13167 "slot C<slot>. (LUKS supports 8 key slots, numbered 0-7)."
13171 #: ../src/guestfs-actions.pod:4051 ../src/guestfs-actions.pod:4074
13172 #: ../src/guestfs-actions.pod:4217 ../src/guestfs-actions.pod:5320
13173 #: ../src/guestfs-actions.pod:6102 ../src/guestfs-actions.pod:6528
13174 #: ../src/guestfs-actions.pod:6558 ../src/guestfs-actions.pod:6591
13175 #: ../src/guestfs-actions.pod:7787 ../fish/guestfish-actions.pod:2737
13176 #: ../fish/guestfish-actions.pod:2750 ../fish/guestfish-actions.pod:2837
13177 #: ../fish/guestfish-actions.pod:3498 ../fish/guestfish-actions.pod:4018
13178 #: ../fish/guestfish-actions.pod:4343 ../fish/guestfish-actions.pod:4366
13179 #: ../fish/guestfish-actions.pod:4388 ../fish/guestfish-actions.pod:5126
13181 "B<This command is dangerous. Without careful use you can easily destroy all "
13186 #: ../src/guestfs-actions.pod:4060
13187 msgid "guestfs_luks_format_cipher"
13191 #: ../src/guestfs-actions.pod:4062
13195 " guestfs_luks_format_cipher (guestfs_h *g,\n"
13196 " const char *device,\n"
13197 " const char *key,\n"
13199 " const char *cipher);\n"
13204 #: ../src/guestfs-actions.pod:4069
13206 "This command is the same as C<guestfs_luks_format> but it also allows you to "
13207 "set the C<cipher> used."
13211 #: ../src/guestfs-actions.pod:4083
13212 msgid "guestfs_luks_kill_slot"
13216 #: ../src/guestfs-actions.pod:4085
13220 " guestfs_luks_kill_slot (guestfs_h *g,\n"
13221 " const char *device,\n"
13222 " const char *key,\n"
13228 #: ../src/guestfs-actions.pod:4091 ../fish/guestfish-actions.pod:2757
13230 "This command deletes the key in key slot C<keyslot> from the encrypted LUKS "
13231 "device C<device>. C<key> must be one of the I<other> keys."
13235 #: ../src/guestfs-actions.pod:4103
13236 msgid "guestfs_luks_open"
13240 #: ../src/guestfs-actions.pod:4105
13244 " guestfs_luks_open (guestfs_h *g,\n"
13245 " const char *device,\n"
13246 " const char *key,\n"
13247 " const char *mapname);\n"
13252 #: ../src/guestfs-actions.pod:4111 ../fish/guestfish-actions.pod:2768
13254 "This command opens a block device which has been encrypted according to the "
13255 "Linux Unified Key Setup (LUKS) standard."
13259 #: ../src/guestfs-actions.pod:4114 ../fish/guestfish-actions.pod:2771
13260 msgid "C<device> is the encrypted block device or partition."
13264 #: ../src/guestfs-actions.pod:4116 ../fish/guestfish-actions.pod:2773
13266 "The caller must supply one of the keys associated with the LUKS block "
13267 "device, in the C<key> parameter."
13271 #: ../src/guestfs-actions.pod:4119 ../fish/guestfish-actions.pod:2776
13273 "This creates a new block device called C</dev/mapper/mapname>. Reads and "
13274 "writes to this block device are decrypted from and encrypted to the "
13275 "underlying C<device> respectively."
13279 #: ../src/guestfs-actions.pod:4123
13281 "If this block device contains LVM volume groups, then calling "
13282 "C<guestfs_vgscan> followed by C<guestfs_vg_activate_all> will make them "
13287 #: ../src/guestfs-actions.pod:4127
13288 msgid "Use C<guestfs_list_dm_devices> to list all device mapper devices."
13292 #: ../src/guestfs-actions.pod:4138
13293 msgid "guestfs_luks_open_ro"
13297 #: ../src/guestfs-actions.pod:4140
13301 " guestfs_luks_open_ro (guestfs_h *g,\n"
13302 " const char *device,\n"
13303 " const char *key,\n"
13304 " const char *mapname);\n"
13309 #: ../src/guestfs-actions.pod:4146
13311 "This is the same as C<guestfs_luks_open> except that a read-only mapping is "
13316 #: ../src/guestfs-actions.pod:4157
13317 msgid "guestfs_lvcreate"
13321 #: ../src/guestfs-actions.pod:4159
13325 " guestfs_lvcreate (guestfs_h *g,\n"
13326 " const char *logvol,\n"
13327 " const char *volgroup,\n"
13333 #: ../src/guestfs-actions.pod:4165 ../fish/guestfish-actions.pod:2804
13335 "This creates an LVM logical volume called C<logvol> on the volume group "
13336 "C<volgroup>, with C<size> megabytes."
13340 #: ../src/guestfs-actions.pod:4172
13341 msgid "guestfs_lvm_canonical_lv_name"
13345 #: ../src/guestfs-actions.pod:4174
13349 " guestfs_lvm_canonical_lv_name (guestfs_h *g,\n"
13350 " const char *lvname);\n"
13355 #: ../src/guestfs-actions.pod:4178 ../fish/guestfish-actions.pod:2811
13357 "This converts alternative naming schemes for LVs that you might find to the "
13358 "canonical name. For example, C</dev/mapper/VG-LV> is converted to C</dev/VG/"
13363 #: ../src/guestfs-actions.pod:4182 ../fish/guestfish-actions.pod:2815
13365 "This command returns an error if the C<lvname> parameter does not refer to a "
13370 #: ../src/guestfs-actions.pod:4185
13371 msgid "See also C<guestfs_is_lv>."
13375 #: ../src/guestfs-actions.pod:4190
13376 msgid "(Added in 1.5.24)"
13380 #: ../src/guestfs-actions.pod:4192
13381 msgid "guestfs_lvm_clear_filter"
13385 #: ../src/guestfs-actions.pod:4194
13389 " guestfs_lvm_clear_filter (guestfs_h *g);\n"
13394 #: ../src/guestfs-actions.pod:4197
13396 "This undoes the effect of C<guestfs_lvm_set_filter>. LVM will be able to "
13397 "see every block device."
13401 #: ../src/guestfs-actions.pod:4200 ../src/guestfs-actions.pod:4242
13402 #: ../fish/guestfish-actions.pod:2827 ../fish/guestfish-actions.pod:2858
13404 "This command also clears the LVM cache and performs a volume group scan."
13408 #: ../src/guestfs-actions.pod:4207
13409 msgid "guestfs_lvm_remove_all"
13413 #: ../src/guestfs-actions.pod:4209
13417 " guestfs_lvm_remove_all (guestfs_h *g);\n"
13422 #: ../src/guestfs-actions.pod:4212 ../fish/guestfish-actions.pod:2834
13424 "This command removes all LVM logical volumes, volume groups and physical "
13429 #: ../src/guestfs-actions.pod:4222
13430 msgid "guestfs_lvm_set_filter"
13434 #: ../src/guestfs-actions.pod:4224
13438 " guestfs_lvm_set_filter (guestfs_h *g,\n"
13439 " char *const *devices);\n"
13444 #: ../src/guestfs-actions.pod:4228 ../fish/guestfish-actions.pod:2844
13446 "This sets the LVM device filter so that LVM will only be able to \"see\" the "
13447 "block devices in the list C<devices>, and will ignore all other attached "
13452 #: ../src/guestfs-actions.pod:4232 ../fish/guestfish-actions.pod:2848
13454 "Where disk image(s) contain duplicate PVs or VGs, this command is useful to "
13455 "get LVM to ignore the duplicates, otherwise LVM can get confused. Note also "
13456 "there are two types of duplication possible: either cloned PVs/VGs which "
13457 "have identical UUIDs; or VGs that are not cloned but just happen to have the "
13458 "same name. In normal operation you cannot create this situation, but you "
13459 "can do it outside LVM, eg. by cloning disk images or by bit twiddling "
13460 "inside the LVM metadata."
13464 #: ../src/guestfs-actions.pod:4245 ../fish/guestfish-actions.pod:2861
13465 msgid "You can filter whole block devices or individual partitions."
13469 #: ../src/guestfs-actions.pod:4247 ../fish/guestfish-actions.pod:2863
13471 "You cannot use this if any VG is currently in use (eg. contains a mounted "
13472 "filesystem), even if you are not filtering out that VG."
13476 #: ../src/guestfs-actions.pod:4255
13477 msgid "guestfs_lvremove"
13481 #: ../src/guestfs-actions.pod:4257
13485 " guestfs_lvremove (guestfs_h *g,\n"
13486 " const char *device);\n"
13491 #: ../src/guestfs-actions.pod:4261 ../fish/guestfish-actions.pod:2871
13493 "Remove an LVM logical volume C<device>, where C<device> is the path to the "
13494 "LV, such as C</dev/VG/LV>."
13498 #: ../src/guestfs-actions.pod:4264 ../fish/guestfish-actions.pod:2874
13500 "You can also remove all LVs in a volume group by specifying the VG name, C</"
13505 #: ../src/guestfs-actions.pod:4269 ../src/guestfs-actions.pod:5666
13506 #: ../src/guestfs-actions.pod:7498
13507 msgid "(Added in 1.0.13)"
13511 #: ../src/guestfs-actions.pod:4271
13512 msgid "guestfs_lvrename"
13516 #: ../src/guestfs-actions.pod:4273
13520 " guestfs_lvrename (guestfs_h *g,\n"
13521 " const char *logvol,\n"
13522 " const char *newlogvol);\n"
13527 #: ../src/guestfs-actions.pod:4278 ../fish/guestfish-actions.pod:2881
13528 msgid "Rename a logical volume C<logvol> with the new name C<newlogvol>."
13532 #: ../src/guestfs-actions.pod:4282 ../src/guestfs-actions.pod:7511
13533 msgid "(Added in 1.0.83)"
13537 #: ../src/guestfs-actions.pod:4284
13538 msgid "guestfs_lvresize"
13542 #: ../src/guestfs-actions.pod:4286
13546 " guestfs_lvresize (guestfs_h *g,\n"
13547 " const char *device,\n"
13553 #: ../src/guestfs-actions.pod:4291 ../fish/guestfish-actions.pod:2887
13555 "This resizes (expands or shrinks) an existing LVM logical volume to "
13556 "C<mbytes>. When reducing, data in the reduced part is lost."
13560 #: ../src/guestfs-actions.pod:4299
13561 msgid "guestfs_lvresize_free"
13565 #: ../src/guestfs-actions.pod:4301
13569 " guestfs_lvresize_free (guestfs_h *g,\n"
13570 " const char *lv,\n"
13576 #: ../src/guestfs-actions.pod:4306 ../fish/guestfish-actions.pod:2895
13578 "This expands an existing logical volume C<lv> so that it fills C<pc>% of the "
13579 "remaining free space in the volume group. Commonly you would call this with "
13580 "pc = 100 which expands the logical volume as much as possible, using all "
13581 "remaining free space in the volume group."
13585 #: ../src/guestfs-actions.pod:4314
13586 msgid "(Added in 1.3.3)"
13590 #: ../src/guestfs-actions.pod:4316
13591 msgid "guestfs_lvs"
13595 #: ../src/guestfs-actions.pod:4318
13599 " guestfs_lvs (guestfs_h *g);\n"
13604 #: ../src/guestfs-actions.pod:4321 ../fish/guestfish-actions.pod:2905
13606 "List all the logical volumes detected. This is the equivalent of the L<lvs"
13611 #: ../src/guestfs-actions.pod:4324 ../fish/guestfish-actions.pod:2908
13613 "This returns a list of the logical volume device names (eg. C</dev/"
13614 "VolGroup00/LogVol00>)."
13618 #: ../src/guestfs-actions.pod:4327
13619 msgid "See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>."
13623 #: ../src/guestfs-actions.pod:4335
13624 msgid "guestfs_lvs_full"
13628 #: ../src/guestfs-actions.pod:4337
13631 " struct guestfs_lvm_lv_list *\n"
13632 " guestfs_lvs_full (guestfs_h *g);\n"
13637 #: ../src/guestfs-actions.pod:4340 ../fish/guestfish-actions.pod:2917
13639 "List all the logical volumes detected. This is the equivalent of the L<lvs"
13640 "(8)> command. The \"full\" version includes all fields."
13644 #: ../src/guestfs-actions.pod:4343
13646 "This function returns a C<struct guestfs_lvm_lv_list *>, or NULL if there "
13647 "was an error. I<The caller must call C<guestfs_free_lvm_lv_list> after use>."
13651 #: ../src/guestfs-actions.pod:4349
13652 msgid "guestfs_lvuuid"
13656 #: ../src/guestfs-actions.pod:4351
13660 " guestfs_lvuuid (guestfs_h *g,\n"
13661 " const char *device);\n"
13666 #: ../src/guestfs-actions.pod:4355 ../fish/guestfish-actions.pod:2924
13667 msgid "This command returns the UUID of the LVM LV C<device>."
13671 #: ../src/guestfs-actions.pod:4362
13672 msgid "guestfs_lxattrlist"
13676 #: ../src/guestfs-actions.pod:4364
13679 " struct guestfs_xattr_list *\n"
13680 " guestfs_lxattrlist (guestfs_h *g,\n"
13681 " const char *path,\n"
13682 " char *const *names);\n"
13687 #: ../src/guestfs-actions.pod:4369 ../fish/guestfish-actions.pod:2930
13689 "This call allows you to get the extended attributes of multiple files, where "
13690 "all files are in the directory C<path>. C<names> is the list of files from "
13695 #: ../src/guestfs-actions.pod:4373 ../fish/guestfish-actions.pod:2934
13697 "On return you get a flat list of xattr structs which must be interpreted "
13698 "sequentially. The first xattr struct always has a zero-length C<attrname>. "
13699 "C<attrval> in this struct is zero-length to indicate there was an error "
13700 "doing C<lgetxattr> for this file, I<or> is a C string which is a decimal "
13701 "number (the number of following attributes for this file, which could be C<"
13702 "\"0\">). Then after the first xattr struct are the zero or more attributes "
13703 "for the first named file. This repeats for the second and subsequent files."
13707 #: ../src/guestfs-actions.pod:4383
13709 "This call is intended for programs that want to efficiently list a directory "
13710 "contents without making many round-trips. See also C<guestfs_lstatlist> for "
13711 "a similarly efficient call for getting standard stats. Very long directory "
13712 "listings might cause the protocol message size to be exceeded, causing this "
13713 "call to fail. The caller must split up such requests into smaller groups of "
13718 #: ../src/guestfs-actions.pod:4397
13719 msgid "guestfs_mkdir"
13723 #: ../src/guestfs-actions.pod:4399
13727 " guestfs_mkdir (guestfs_h *g,\n"
13728 " const char *path);\n"
13733 #: ../src/guestfs-actions.pod:4403 ../fish/guestfish-actions.pod:2956
13734 msgid "Create a directory named C<path>."
13738 #: ../src/guestfs-actions.pod:4409
13739 msgid "guestfs_mkdir_mode"
13743 #: ../src/guestfs-actions.pod:4411
13747 " guestfs_mkdir_mode (guestfs_h *g,\n"
13748 " const char *path,\n"
13754 #: ../src/guestfs-actions.pod:4416 ../fish/guestfish-actions.pod:2962
13756 "This command creates a directory, setting the initial permissions of the "
13757 "directory to C<mode>."
13761 #: ../src/guestfs-actions.pod:4419 ../fish/guestfish-actions.pod:2965
13763 "For common Linux filesystems, the actual mode which is set will be C<mode & "
13764 "~umask & 01777>. Non-native-Linux filesystems may interpret the mode in "
13769 #: ../src/guestfs-actions.pod:4423
13770 msgid "See also C<guestfs_mkdir>, C<guestfs_umask>"
13774 #: ../src/guestfs-actions.pod:4429
13775 msgid "guestfs_mkdir_p"
13779 #: ../src/guestfs-actions.pod:4431
13783 " guestfs_mkdir_p (guestfs_h *g,\n"
13784 " const char *path);\n"
13789 #: ../src/guestfs-actions.pod:4435 ../fish/guestfish-actions.pod:2975
13791 "Create a directory named C<path>, creating any parent directories as "
13792 "necessary. This is like the C<mkdir -p> shell command."
13796 #: ../src/guestfs-actions.pod:4442
13797 msgid "guestfs_mkdtemp"
13801 #: ../src/guestfs-actions.pod:4444
13805 " guestfs_mkdtemp (guestfs_h *g,\n"
13806 " const char *template);\n"
13811 #: ../src/guestfs-actions.pod:4448 ../fish/guestfish-actions.pod:2982
13813 "This command creates a temporary directory. The C<template> parameter "
13814 "should be a full pathname for the temporary directory name with the final "
13815 "six characters being \"XXXXXX\"."
13819 #: ../src/guestfs-actions.pod:4453 ../fish/guestfish-actions.pod:2987
13821 "For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\", the second one "
13822 "being suitable for Windows filesystems."
13826 #: ../src/guestfs-actions.pod:4456 ../fish/guestfish-actions.pod:2990
13827 msgid "The name of the temporary directory that was created is returned."
13831 #: ../src/guestfs-actions.pod:4459 ../fish/guestfish-actions.pod:2993
13832 msgid "The temporary directory is created with mode 0700 and is owned by root."
13836 #: ../src/guestfs-actions.pod:4462 ../fish/guestfish-actions.pod:2996
13838 "The caller is responsible for deleting the temporary directory and its "
13839 "contents after use."
13843 #: ../src/guestfs-actions.pod:4465 ../fish/guestfish-actions.pod:2999
13844 msgid "See also: L<mkdtemp(3)>"
13848 #: ../src/guestfs-actions.pod:4472
13849 msgid "guestfs_mke2fs_J"
13853 #: ../src/guestfs-actions.pod:4474
13857 " guestfs_mke2fs_J (guestfs_h *g,\n"
13858 " const char *fstype,\n"
13859 " int blocksize,\n"
13860 " const char *device,\n"
13861 " const char *journal);\n"
13866 #: ../src/guestfs-actions.pod:4481 ../fish/guestfish-actions.pod:3005
13868 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
13869 "C<journal>. It is equivalent to the command:"
13873 #: ../src/guestfs-actions.pod:4485 ../fish/guestfish-actions.pod:3009
13876 " mke2fs -t fstype -b blocksize -J device=<journal> <device>\n"
13881 #: ../src/guestfs-actions.pod:4487
13882 msgid "See also C<guestfs_mke2journal>."
13886 #: ../src/guestfs-actions.pod:4491 ../src/guestfs-actions.pod:4509
13887 #: ../src/guestfs-actions.pod:4527 ../src/guestfs-actions.pod:4543
13888 #: ../src/guestfs-actions.pod:4557 ../src/guestfs-actions.pod:4571
13889 #: ../src/guestfs-actions.pod:4630 ../src/guestfs-actions.pod:4907
13890 msgid "(Added in 1.0.68)"
13894 #: ../src/guestfs-actions.pod:4493
13895 msgid "guestfs_mke2fs_JL"
13899 #: ../src/guestfs-actions.pod:4495
13903 " guestfs_mke2fs_JL (guestfs_h *g,\n"
13904 " const char *fstype,\n"
13905 " int blocksize,\n"
13906 " const char *device,\n"
13907 " const char *label);\n"
13912 #: ../src/guestfs-actions.pod:4502 ../fish/guestfish-actions.pod:3017
13914 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
13915 "the journal labeled C<label>."
13919 #: ../src/guestfs-actions.pod:4505
13920 msgid "See also C<guestfs_mke2journal_L>."
13924 #: ../src/guestfs-actions.pod:4511
13925 msgid "guestfs_mke2fs_JU"
13929 #: ../src/guestfs-actions.pod:4513
13933 " guestfs_mke2fs_JU (guestfs_h *g,\n"
13934 " const char *fstype,\n"
13935 " int blocksize,\n"
13936 " const char *device,\n"
13937 " const char *uuid);\n"
13942 #: ../src/guestfs-actions.pod:4520 ../fish/guestfish-actions.pod:3026
13944 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
13945 "the journal with UUID C<uuid>."
13949 #: ../src/guestfs-actions.pod:4523
13950 msgid "See also C<guestfs_mke2journal_U>."
13954 #: ../src/guestfs-actions.pod:4529
13955 msgid "guestfs_mke2journal"
13959 #: ../src/guestfs-actions.pod:4531
13963 " guestfs_mke2journal (guestfs_h *g,\n"
13964 " int blocksize,\n"
13965 " const char *device);\n"
13970 #: ../src/guestfs-actions.pod:4536 ../fish/guestfish-actions.pod:3035
13972 "This creates an ext2 external journal on C<device>. It is equivalent to the "
13977 #: ../src/guestfs-actions.pod:4539 ../fish/guestfish-actions.pod:3038
13980 " mke2fs -O journal_dev -b blocksize device\n"
13985 #: ../src/guestfs-actions.pod:4545
13986 msgid "guestfs_mke2journal_L"
13990 #: ../src/guestfs-actions.pod:4547
13994 " guestfs_mke2journal_L (guestfs_h *g,\n"
13995 " int blocksize,\n"
13996 " const char *label,\n"
13997 " const char *device);\n"
14002 #: ../src/guestfs-actions.pod:4553 ../fish/guestfish-actions.pod:3044
14003 msgid "This creates an ext2 external journal on C<device> with label C<label>."
14007 #: ../src/guestfs-actions.pod:4559
14008 msgid "guestfs_mke2journal_U"
14012 #: ../src/guestfs-actions.pod:4561
14016 " guestfs_mke2journal_U (guestfs_h *g,\n"
14017 " int blocksize,\n"
14018 " const char *uuid,\n"
14019 " const char *device);\n"
14024 #: ../src/guestfs-actions.pod:4567 ../fish/guestfish-actions.pod:3050
14025 msgid "This creates an ext2 external journal on C<device> with UUID C<uuid>."
14029 #: ../src/guestfs-actions.pod:4573
14030 msgid "guestfs_mkfifo"
14034 #: ../src/guestfs-actions.pod:4575
14038 " guestfs_mkfifo (guestfs_h *g,\n"
14040 " const char *path);\n"
14045 #: ../src/guestfs-actions.pod:4580
14047 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
14048 "is just a convenient wrapper around C<guestfs_mknod>."
14052 #: ../src/guestfs-actions.pod:4590
14053 msgid "guestfs_mkfs"
14057 #: ../src/guestfs-actions.pod:4592
14061 " guestfs_mkfs (guestfs_h *g,\n"
14062 " const char *fstype,\n"
14063 " const char *device);\n"
14068 #: ../src/guestfs-actions.pod:4597 ../fish/guestfish-actions.pod:3066
14070 "This creates a filesystem on C<device> (usually a partition or LVM logical "
14071 "volume). The filesystem type is C<fstype>, for example C<ext3>."
14075 #: ../src/guestfs-actions.pod:4605
14076 msgid "guestfs_mkfs_b"
14080 #: ../src/guestfs-actions.pod:4607
14084 " guestfs_mkfs_b (guestfs_h *g,\n"
14085 " const char *fstype,\n"
14086 " int blocksize,\n"
14087 " const char *device);\n"
14092 #: ../src/guestfs-actions.pod:4613
14094 "This call is similar to C<guestfs_mkfs>, but it allows you to control the "
14095 "block size of the resulting filesystem. Supported block sizes depend on the "
14096 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
14100 #: ../src/guestfs-actions.pod:4618 ../src/guestfs-actions.pod:4663
14101 #: ../fish/guestfish-actions.pod:3079 ../fish/guestfish-actions.pod:3106
14103 "For VFAT and NTFS the C<blocksize> parameter is treated as the requested "
14108 #: ../src/guestfs-actions.pod:4623 ../fish/guestfish-actions.pod:3082
14110 "This function is deprecated. In new code, use the C<mkfs_opts> call instead."
14114 #: ../src/guestfs-actions.pod:4632
14115 msgid "guestfs_mkfs_opts"
14119 #: ../src/guestfs-actions.pod:4634
14123 " guestfs_mkfs_opts (guestfs_h *g,\n"
14124 " const char *fstype,\n"
14125 " const char *device,\n"
14131 #: ../src/guestfs-actions.pod:4645
14134 " GUESTFS_MKFS_OPTS_BLOCKSIZE, int blocksize,\n"
14135 " GUESTFS_MKFS_OPTS_FEATURES, const char *features,\n"
14136 " GUESTFS_MKFS_OPTS_INODE, int inode,\n"
14137 " GUESTFS_MKFS_OPTS_SECTORSIZE, int sectorsize,\n"
14142 #: ../src/guestfs-actions.pod:4650 ../fish/guestfish-actions.pod:3093
14144 "This function creates a filesystem on C<device>. The filesystem type is "
14145 "C<fstype>, for example C<ext3>."
14149 #: ../src/guestfs-actions.pod:4657 ../fish/guestfish-actions.pod:3100
14150 msgid "C<blocksize>"
14154 #: ../src/guestfs-actions.pod:4659 ../fish/guestfish-actions.pod:3102
14156 "The filesystem block size. Supported block sizes depend on the filesystem "
14157 "type, but typically they are C<1024>, C<2048> or C<4096> for Linux ext2/3 "
14162 #: ../src/guestfs-actions.pod:4666 ../fish/guestfish-actions.pod:3109
14163 msgid "For UFS block sizes, please see L<mkfs.ufs(8)>."
14167 #: ../src/guestfs-actions.pod:4668 ../fish/guestfish-actions.pod:3111
14168 msgid "C<features>"
14172 #: ../src/guestfs-actions.pod:4670 ../fish/guestfish-actions.pod:3113
14173 msgid "This passes the I<-O> parameter to the external mkfs program."
14177 #: ../src/guestfs-actions.pod:4672 ../fish/guestfish-actions.pod:3115
14179 "For certain filesystem types, this allows extra filesystem features to be "
14180 "selected. See L<mke2fs(8)> and L<mkfs.ufs(8)> for more details."
14184 #: ../src/guestfs-actions.pod:4676 ../fish/guestfish-actions.pod:3119
14186 "You cannot use this optional parameter with the C<gfs> or C<gfs2> filesystem "
14191 #: ../src/guestfs-actions.pod:4679 ../fish/guestfish-actions.pod:3122
14193 #| msgid "C<inspector>"
14195 msgstr "C<inspector>"
14198 #: ../src/guestfs-actions.pod:4681 ../fish/guestfish-actions.pod:3124
14200 "This passes the I<-I> parameter to the external L<mke2fs(8)> program which "
14201 "sets the inode size (only for ext2/3/4 filesystems at present)."
14205 #: ../src/guestfs-actions.pod:4684 ../fish/guestfish-actions.pod:3127
14207 #| msgid "C<inspector>"
14208 msgid "C<sectorsize>"
14209 msgstr "C<inspector>"
14212 #: ../src/guestfs-actions.pod:4686 ../fish/guestfish-actions.pod:3129
14214 "This passes the I<-S> parameter to external L<mkfs.ufs(8)> program, which "
14215 "sets sector size for ufs filesystem."
14219 #: ../src/guestfs-actions.pod:4693
14220 msgid "(Added in 1.7.19)"
14224 #: ../src/guestfs-actions.pod:4695
14225 msgid "guestfs_mkfs_opts_va"
14229 #: ../src/guestfs-actions.pod:4697
14233 " guestfs_mkfs_opts_va (guestfs_h *g,\n"
14234 " const char *fstype,\n"
14235 " const char *device,\n"
14236 " va_list args);\n"
14241 #: ../src/guestfs-actions.pod:4703
14242 msgid "This is the \"va_list variant\" of L</guestfs_mkfs_opts>."
14246 #: ../src/guestfs-actions.pod:4707
14247 msgid "guestfs_mkfs_opts_argv"
14251 #: ../src/guestfs-actions.pod:4709
14255 " guestfs_mkfs_opts_argv (guestfs_h *g,\n"
14256 " const char *fstype,\n"
14257 " const char *device,\n"
14258 " const struct guestfs_mkfs_opts_argv *optargs);\n"
14263 #: ../src/guestfs-actions.pod:4715
14264 msgid "This is the \"argv variant\" of L</guestfs_mkfs_opts>."
14268 #: ../src/guestfs-actions.pod:4719
14269 msgid "guestfs_mkmountpoint"
14273 #: ../src/guestfs-actions.pod:4721
14277 " guestfs_mkmountpoint (guestfs_h *g,\n"
14278 " const char *exemptpath);\n"
14283 #: ../src/guestfs-actions.pod:4725
14285 "C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are specialized calls "
14286 "that can be used to create extra mountpoints before mounting the first "
14291 #: ../src/guestfs-actions.pod:4729 ../fish/guestfish-actions.pod:3144
14293 "These calls are I<only> necessary in some very limited circumstances, mainly "
14294 "the case where you want to mount a mix of unrelated and/or read-only "
14295 "filesystems together."
14299 #: ../src/guestfs-actions.pod:4733 ../fish/guestfish-actions.pod:3148
14301 "For example, live CDs often contain a \"Russian doll\" nest of filesystems, "
14302 "an ISO outer layer, with a squashfs image inside, with an ext2/3 image "
14303 "inside that. You can unpack this as follows in guestfish:"
14307 #: ../src/guestfs-actions.pod:4738 ../fish/guestfish-actions.pod:3153
14310 " add-ro Fedora-11-i686-Live.iso\n"
14312 " mkmountpoint /cd\n"
14313 " mkmountpoint /sqsh\n"
14314 " mkmountpoint /ext3fs\n"
14315 " mount /dev/sda /cd\n"
14316 " mount-loop /cd/LiveOS/squashfs.img /sqsh\n"
14317 " mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs\n"
14322 #: ../src/guestfs-actions.pod:4747 ../fish/guestfish-actions.pod:3162
14323 msgid "The inner filesystem is now unpacked under the /ext3fs mountpoint."
14327 #: ../src/guestfs-actions.pod:4749
14329 "C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>. You "
14330 "may get unexpected errors if you try to mix these calls. It is safest to "
14331 "manually unmount filesystems and remove mountpoints after use."
14335 #: ../src/guestfs-actions.pod:4753
14337 "C<guestfs_umount_all> unmounts filesystems by sorting the paths longest "
14338 "first, so for this to work for manual mountpoints, you must ensure that the "
14339 "innermost mountpoints have the longest pathnames, as in the example code "
14344 #: ../src/guestfs-actions.pod:4758 ../fish/guestfish-actions.pod:3173
14346 "For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>"
14350 #: ../src/guestfs-actions.pod:4760
14352 "Autosync [see C<guestfs_set_autosync>, this is set by default on handles] "
14353 "can cause C<guestfs_umount_all> to be called when the handle is closed which "
14354 "can also trigger these issues."
14358 #: ../src/guestfs-actions.pod:4766 ../src/guestfs-actions.pod:5082
14359 #: ../src/guestfs-actions.pod:6086
14360 msgid "(Added in 1.0.62)"
14364 #: ../src/guestfs-actions.pod:4768
14365 msgid "guestfs_mknod"
14369 #: ../src/guestfs-actions.pod:4770
14373 " guestfs_mknod (guestfs_h *g,\n"
14377 " const char *path);\n"
14382 #: ../src/guestfs-actions.pod:4777 ../fish/guestfish-actions.pod:3183
14384 "This call creates block or character special devices, or named pipes (FIFOs)."
14388 #: ../src/guestfs-actions.pod:4780 ../fish/guestfish-actions.pod:3186
14390 "The C<mode> parameter should be the mode, using the standard constants. "
14391 "C<devmajor> and C<devminor> are the device major and minor numbers, only "
14392 "used when creating block and character special devices."
14396 #: ../src/guestfs-actions.pod:4785
14398 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
14399 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
14400 "regular file). These constants are available in the standard Linux header "
14401 "files, or you can use C<guestfs_mknod_b>, C<guestfs_mknod_c> or "
14402 "C<guestfs_mkfifo> which are wrappers around this command which bitwise OR in "
14403 "the appropriate constant for you."
14407 #: ../src/guestfs-actions.pod:4799
14408 msgid "guestfs_mknod_b"
14412 #: ../src/guestfs-actions.pod:4801
14416 " guestfs_mknod_b (guestfs_h *g,\n"
14420 " const char *path);\n"
14425 #: ../src/guestfs-actions.pod:4808
14427 "This call creates a block device node called C<path> with mode C<mode> and "
14428 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
14429 "wrapper around C<guestfs_mknod>."
14433 #: ../src/guestfs-actions.pod:4818
14434 msgid "guestfs_mknod_c"
14438 #: ../src/guestfs-actions.pod:4820
14442 " guestfs_mknod_c (guestfs_h *g,\n"
14446 " const char *path);\n"
14451 #: ../src/guestfs-actions.pod:4827
14453 "This call creates a char device node called C<path> with mode C<mode> and "
14454 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
14455 "wrapper around C<guestfs_mknod>."
14459 #: ../src/guestfs-actions.pod:4837
14460 msgid "guestfs_mkswap"
14464 #: ../src/guestfs-actions.pod:4839
14468 " guestfs_mkswap (guestfs_h *g,\n"
14469 " const char *device);\n"
14474 #: ../src/guestfs-actions.pod:4843 ../fish/guestfish-actions.pod:3225
14475 msgid "Create a swap partition on C<device>."
14479 #: ../src/guestfs-actions.pod:4849
14480 msgid "guestfs_mkswap_L"
14484 #: ../src/guestfs-actions.pod:4851
14488 " guestfs_mkswap_L (guestfs_h *g,\n"
14489 " const char *label,\n"
14490 " const char *device);\n"
14495 #: ../src/guestfs-actions.pod:4856 ../fish/guestfish-actions.pod:3231
14496 msgid "Create a swap partition on C<device> with label C<label>."
14500 #: ../src/guestfs-actions.pod:4858 ../fish/guestfish-actions.pod:3233
14502 "Note that you cannot attach a swap label to a block device (eg. C</dev/"
14503 "sda>), just to a partition. This appears to be a limitation of the kernel "
14508 #: ../src/guestfs-actions.pod:4866
14509 msgid "guestfs_mkswap_U"
14513 #: ../src/guestfs-actions.pod:4868
14517 " guestfs_mkswap_U (guestfs_h *g,\n"
14518 " const char *uuid,\n"
14519 " const char *device);\n"
14524 #: ../src/guestfs-actions.pod:4873 ../fish/guestfish-actions.pod:3241
14525 msgid "Create a swap partition on C<device> with UUID C<uuid>."
14529 #: ../src/guestfs-actions.pod:4879
14530 msgid "guestfs_mkswap_file"
14534 #: ../src/guestfs-actions.pod:4881
14538 " guestfs_mkswap_file (guestfs_h *g,\n"
14539 " const char *path);\n"
14544 #: ../src/guestfs-actions.pod:4885 ../fish/guestfish-actions.pod:3247
14545 msgid "Create a swap file."
14549 #: ../src/guestfs-actions.pod:4887
14551 "This command just writes a swap file signature to an existing file. To "
14552 "create the file itself, use something like C<guestfs_fallocate>."
14556 #: ../src/guestfs-actions.pod:4894
14557 msgid "guestfs_modprobe"
14561 #: ../src/guestfs-actions.pod:4896
14565 " guestfs_modprobe (guestfs_h *g,\n"
14566 " const char *modulename);\n"
14571 #: ../src/guestfs-actions.pod:4900 ../fish/guestfish-actions.pod:3256
14572 msgid "This loads a kernel module in the appliance."
14576 #: ../src/guestfs-actions.pod:4902 ../fish/guestfish-actions.pod:3258
14578 "The kernel module must have been whitelisted when libguestfs was built (see "
14579 "C<appliance/kmod.whitelist.in> in the source)."
14583 #: ../src/guestfs-actions.pod:4909
14584 msgid "guestfs_mount"
14588 #: ../src/guestfs-actions.pod:4911
14592 " guestfs_mount (guestfs_h *g,\n"
14593 " const char *device,\n"
14594 " const char *mountpoint);\n"
14599 #: ../src/guestfs-actions.pod:4916 ../fish/guestfish-actions.pod:3265
14601 "Mount a guest disk at a position in the filesystem. Block devices are named "
14602 "C</dev/sda>, C</dev/sdb> and so on, as they were added to the guest. If "
14603 "those block devices contain partitions, they will have the usual names (eg. "
14604 "C</dev/sda1>). Also LVM C</dev/VG/LV>-style names can be used."
14608 #: ../src/guestfs-actions.pod:4922 ../fish/guestfish-actions.pod:3271
14610 "The rules are the same as for L<mount(2)>: A filesystem must first be "
14611 "mounted on C</> before others can be mounted. Other filesystems can only be "
14612 "mounted on directories which already exist."
14616 #: ../src/guestfs-actions.pod:4927 ../fish/guestfish-actions.pod:3276
14618 "The mounted filesystem is writable, if we have sufficient permissions on the "
14619 "underlying device."
14623 #: ../src/guestfs-actions.pod:4930
14625 "B<Important note:> When you use this call, the filesystem options C<sync> "
14626 "and C<noatime> are set implicitly. This was originally done because we "
14627 "thought it would improve reliability, but it turns out that I<-o sync> has a "
14628 "very large negative performance impact and negligible effect on "
14629 "reliability. Therefore we recommend that you avoid using C<guestfs_mount> "
14630 "in any code that needs performance, and instead use C<guestfs_mount_options> "
14631 "(use an empty string for the first parameter if you don't want any options)."
14635 #: ../src/guestfs-actions.pod:4942 ../fish/guestfish-actions.pod:3289
14637 "This function is deprecated. In new code, use the C<mount_options> call "
14642 #: ../src/guestfs-actions.pod:4951
14643 msgid "guestfs_mount_9p"
14647 #: ../src/guestfs-actions.pod:4953
14651 " guestfs_mount_9p (guestfs_h *g,\n"
14652 " const char *mounttag,\n"
14653 " const char *mountpoint,\n"
14659 #: ../src/guestfs-actions.pod:4964
14662 " GUESTFS_MOUNT_9P_OPTIONS, const char *options,\n"
14667 #: ../src/guestfs-actions.pod:4966 ../fish/guestfish-actions.pod:3300
14669 "Mount the virtio-9p filesystem with the tag C<mounttag> on the directory "
14674 #: ../src/guestfs-actions.pod:4969 ../fish/guestfish-actions.pod:3303
14676 "If required, C<trans=virtio> will be automatically added to the options. "
14677 "Any other options required can be passed in the optional C<options> "
14682 #: ../src/guestfs-actions.pod:4977
14683 msgid "guestfs_mount_9p_va"
14687 #: ../src/guestfs-actions.pod:4979
14691 " guestfs_mount_9p_va (guestfs_h *g,\n"
14692 " const char *mounttag,\n"
14693 " const char *mountpoint,\n"
14694 " va_list args);\n"
14699 #: ../src/guestfs-actions.pod:4985
14700 msgid "This is the \"va_list variant\" of L</guestfs_mount_9p>."
14704 #: ../src/guestfs-actions.pod:4989
14705 msgid "guestfs_mount_9p_argv"
14709 #: ../src/guestfs-actions.pod:4991
14713 " guestfs_mount_9p_argv (guestfs_h *g,\n"
14714 " const char *mounttag,\n"
14715 " const char *mountpoint,\n"
14716 " const struct guestfs_mount_9p_argv *optargs);\n"
14721 #: ../src/guestfs-actions.pod:4997
14722 msgid "This is the \"argv variant\" of L</guestfs_mount_9p>."
14726 #: ../src/guestfs-actions.pod:5001
14727 msgid "guestfs_mount_loop"
14731 #: ../src/guestfs-actions.pod:5003
14735 " guestfs_mount_loop (guestfs_h *g,\n"
14736 " const char *file,\n"
14737 " const char *mountpoint);\n"
14742 #: ../src/guestfs-actions.pod:5008 ../fish/guestfish-actions.pod:3313
14744 "This command lets you mount C<file> (a filesystem image in a file) on a "
14745 "mount point. It is entirely equivalent to the command C<mount -o loop file "
14750 #: ../src/guestfs-actions.pod:5016
14751 msgid "guestfs_mount_options"
14755 #: ../src/guestfs-actions.pod:5018
14759 " guestfs_mount_options (guestfs_h *g,\n"
14760 " const char *options,\n"
14761 " const char *device,\n"
14762 " const char *mountpoint);\n"
14767 #: ../src/guestfs-actions.pod:5024
14769 "This is the same as the C<guestfs_mount> command, but it allows you to set "
14770 "the mount options as for the L<mount(8)> I<-o> flag."
14774 #: ../src/guestfs-actions.pod:5028 ../fish/guestfish-actions.pod:3325
14776 "If the C<options> parameter is an empty string, then no options are passed "
14777 "(all options default to whatever the filesystem uses)."
14781 #: ../src/guestfs-actions.pod:5034 ../src/guestfs-actions.pod:5048
14782 #: ../src/guestfs-actions.pod:5065
14783 msgid "(Added in 1.0.10)"
14787 #: ../src/guestfs-actions.pod:5036
14788 msgid "guestfs_mount_ro"
14792 #: ../src/guestfs-actions.pod:5038
14796 " guestfs_mount_ro (guestfs_h *g,\n"
14797 " const char *device,\n"
14798 " const char *mountpoint);\n"
14803 #: ../src/guestfs-actions.pod:5043
14805 "This is the same as the C<guestfs_mount> command, but it mounts the "
14806 "filesystem with the read-only (I<-o ro>) flag."
14810 #: ../src/guestfs-actions.pod:5050
14811 msgid "guestfs_mount_vfs"
14815 #: ../src/guestfs-actions.pod:5052
14819 " guestfs_mount_vfs (guestfs_h *g,\n"
14820 " const char *options,\n"
14821 " const char *vfstype,\n"
14822 " const char *device,\n"
14823 " const char *mountpoint);\n"
14828 #: ../src/guestfs-actions.pod:5059
14830 "This is the same as the C<guestfs_mount> command, but it allows you to set "
14831 "both the mount options and the vfstype as for the L<mount(8)> I<-o> and I<-"
14836 #: ../src/guestfs-actions.pod:5067
14837 msgid "guestfs_mountpoints"
14841 #: ../src/guestfs-actions.pod:5069
14845 " guestfs_mountpoints (guestfs_h *g);\n"
14850 #: ../src/guestfs-actions.pod:5072
14852 "This call is similar to C<guestfs_mounts>. That call returns a list of "
14853 "devices. This one returns a hash table (map) of device name to directory "
14854 "where the device is mounted."
14858 #: ../src/guestfs-actions.pod:5084
14859 msgid "guestfs_mounts"
14863 #: ../src/guestfs-actions.pod:5086
14867 " guestfs_mounts (guestfs_h *g);\n"
14872 #: ../src/guestfs-actions.pod:5089 ../fish/guestfish-actions.pod:3356
14874 "This returns the list of currently mounted filesystems. It returns the list "
14875 "of devices (eg. C</dev/sda1>, C</dev/VG/LV>)."
14879 #: ../src/guestfs-actions.pod:5092 ../fish/guestfish-actions.pod:3359
14880 msgid "Some internal mounts are not shown."
14884 #: ../src/guestfs-actions.pod:5094
14885 msgid "See also: C<guestfs_mountpoints>"
14889 #: ../src/guestfs-actions.pod:5102
14894 #: ../src/guestfs-actions.pod:5104
14898 " guestfs_mv (guestfs_h *g,\n"
14899 " const char *src,\n"
14900 " const char *dest);\n"
14905 #: ../src/guestfs-actions.pod:5109 ../fish/guestfish-actions.pod:3367
14907 "This moves a file from C<src> to C<dest> where C<dest> is either a "
14908 "destination filename or destination directory."
14912 #: ../src/guestfs-actions.pod:5116
14913 msgid "guestfs_ntfs_3g_probe"
14917 #: ../src/guestfs-actions.pod:5118
14921 " guestfs_ntfs_3g_probe (guestfs_h *g,\n"
14923 " const char *device);\n"
14928 #: ../src/guestfs-actions.pod:5123 ../fish/guestfish-actions.pod:3374
14930 "This command runs the L<ntfs-3g.probe(8)> command which probes an NTFS "
14931 "C<device> for mountability. (Not all NTFS volumes can be mounted read-"
14932 "write, and some cannot be mounted at all)."
14936 #: ../src/guestfs-actions.pod:5127 ../fish/guestfish-actions.pod:3378
14938 "C<rw> is a boolean flag. Set it to true if you want to test if the volume "
14939 "can be mounted read-write. Set it to false if you want to test if the "
14940 "volume can be mounted read-only."
14944 #: ../src/guestfs-actions.pod:5131 ../fish/guestfish-actions.pod:3382
14946 "The return value is an integer which C<0> if the operation would succeed, or "
14947 "some non-zero value documented in the L<ntfs-3g.probe(8)> manual page."
14951 #: ../src/guestfs-actions.pod:5137
14952 msgid "(Added in 1.0.43)"
14956 #: ../src/guestfs-actions.pod:5139
14957 msgid "guestfs_ntfsresize"
14961 #: ../src/guestfs-actions.pod:5141
14965 " guestfs_ntfsresize (guestfs_h *g,\n"
14966 " const char *device);\n"
14971 #: ../src/guestfs-actions.pod:5145 ../src/guestfs-actions.pod:5184
14972 #: ../fish/guestfish-actions.pod:3390 ../fish/guestfish-actions.pod:3414
14974 "This command resizes an NTFS filesystem, expanding or shrinking it to the "
14975 "size of the underlying device."
14979 #: ../src/guestfs-actions.pod:5148 ../fish/guestfish-actions.pod:3393
14981 "I<Note:> After the resize operation, the filesystem is marked as requiring a "
14982 "consistency check (for safety). You have to boot into Windows to perform "
14983 "this check and clear this condition. Furthermore, ntfsresize refuses to "
14984 "resize filesystems which have been marked in this way. So in effect it is "
14985 "not possible to call ntfsresize multiple times on a single filesystem "
14986 "without booting into Windows between each resize."
14990 #: ../src/guestfs-actions.pod:5156 ../src/guestfs-actions.pod:5210
14991 #: ../fish/guestfish-actions.pod:3401 ../fish/guestfish-actions.pod:3440
14993 #| msgid "See L<guestfish(1)>."
14994 msgid "See also L<ntfsresize(8)>."
14995 msgstr "Див. L<guestfish(1)>."
14998 #: ../src/guestfs-actions.pod:5160 ../src/guestfs-actions.pod:5250
14999 #: ../fish/guestfish-actions.pod:3403 ../fish/guestfish-actions.pod:3451
15001 "This function is deprecated. In new code, use the C<ntfsresize_opts> call "
15006 #: ../src/guestfs-actions.pod:5169
15007 msgid "guestfs_ntfsresize_opts"
15011 #: ../src/guestfs-actions.pod:5171
15015 " guestfs_ntfsresize_opts (guestfs_h *g,\n"
15016 " const char *device,\n"
15022 #: ../src/guestfs-actions.pod:5181
15025 " GUESTFS_NTFSRESIZE_OPTS_SIZE, int64_t size,\n"
15026 " GUESTFS_NTFSRESIZE_OPTS_FORCE, int force,\n"
15031 #: ../src/guestfs-actions.pod:5193 ../fish/guestfish-actions.pod:3423
15033 "The new size (in bytes) of the filesystem. If omitted, the filesystem is "
15034 "resized to fit the container (eg. partition)."
15038 #: ../src/guestfs-actions.pod:5196 ../fish/guestfish-actions.pod:3426
15040 #| msgid "C<format>"
15045 #: ../src/guestfs-actions.pod:5198 ../fish/guestfish-actions.pod:3428
15047 "If this option is true, then force the resize of the filesystem even if the "
15048 "filesystem is marked as requiring a consistency check."
15052 #: ../src/guestfs-actions.pod:5201
15054 "After the resize operation, the filesystem is always marked as requiring a "
15055 "consistency check (for safety). You have to boot into Windows to perform "
15056 "this check and clear this condition. If you I<don't> set the C<force> "
15057 "option then it is not possible to call C<guestfs_ntfsresize_opts> multiple "
15058 "times on a single filesystem without booting into Windows between each "
15063 #: ../src/guestfs-actions.pod:5216
15064 msgid "guestfs_ntfsresize_opts_va"
15068 #: ../src/guestfs-actions.pod:5218
15072 " guestfs_ntfsresize_opts_va (guestfs_h *g,\n"
15073 " const char *device,\n"
15074 " va_list args);\n"
15079 #: ../src/guestfs-actions.pod:5223
15080 msgid "This is the \"va_list variant\" of L</guestfs_ntfsresize_opts>."
15084 #: ../src/guestfs-actions.pod:5227
15085 msgid "guestfs_ntfsresize_opts_argv"
15089 #: ../src/guestfs-actions.pod:5229
15093 " guestfs_ntfsresize_opts_argv (guestfs_h *g,\n"
15094 " const char *device,\n"
15095 " const struct guestfs_ntfsresize_opts_argv *optargs);\n"
15100 #: ../src/guestfs-actions.pod:5234
15101 msgid "This is the \"argv variant\" of L</guestfs_ntfsresize_opts>."
15105 #: ../src/guestfs-actions.pod:5238
15106 msgid "guestfs_ntfsresize_size"
15110 #: ../src/guestfs-actions.pod:5240
15114 " guestfs_ntfsresize_size (guestfs_h *g,\n"
15115 " const char *device,\n"
15116 " int64_t size);\n"
15121 #: ../src/guestfs-actions.pod:5245
15123 "This command is the same as C<guestfs_ntfsresize> except that it allows you "
15124 "to specify the new size (in bytes) explicitly."
15128 #: ../src/guestfs-actions.pod:5257 ../src/guestfs-actions.pod:5693
15129 #: ../src/guestfs-actions.pod:5766 ../src/guestfs-actions.pod:6034
15130 #: ../src/guestfs-actions.pod:7655
15131 msgid "(Added in 1.3.14)"
15135 #: ../src/guestfs-actions.pod:5259
15136 msgid "guestfs_part_add"
15140 #: ../src/guestfs-actions.pod:5261
15144 " guestfs_part_add (guestfs_h *g,\n"
15145 " const char *device,\n"
15146 " const char *prlogex,\n"
15147 " int64_t startsect,\n"
15148 " int64_t endsect);\n"
15153 #: ../src/guestfs-actions.pod:5268
15155 "This command adds a partition to C<device>. If there is no partition table "
15156 "on the device, call C<guestfs_part_init> first."
15160 #: ../src/guestfs-actions.pod:5271 ../fish/guestfish-actions.pod:3465
15162 "The C<prlogex> parameter is the type of partition. Normally you should pass "
15163 "C<p> or C<primary> here, but MBR partition tables also support C<l> (or "
15164 "C<logical>) and C<e> (or C<extended>) partition types."
15168 #: ../src/guestfs-actions.pod:5276 ../fish/guestfish-actions.pod:3470
15170 "C<startsect> and C<endsect> are the start and end of the partition in "
15171 "I<sectors>. C<endsect> may be negative, which means it counts backwards "
15172 "from the end of the disk (C<-1> is the last sector)."
15176 #: ../src/guestfs-actions.pod:5280
15178 "Creating a partition which covers the whole disk is not so easy. Use "
15179 "C<guestfs_part_disk> to do that."
15183 #: ../src/guestfs-actions.pod:5285 ../src/guestfs-actions.pod:5323
15184 #: ../src/guestfs-actions.pod:5376 ../src/guestfs-actions.pod:5454
15185 #: ../src/guestfs-actions.pod:5492 ../src/guestfs-actions.pod:5511
15186 #: ../src/guestfs-actions.pod:5551
15187 msgid "(Added in 1.0.78)"
15191 #: ../src/guestfs-actions.pod:5287
15192 msgid "guestfs_part_del"
15196 #: ../src/guestfs-actions.pod:5289
15200 " guestfs_part_del (guestfs_h *g,\n"
15201 " const char *device,\n"
15207 #: ../src/guestfs-actions.pod:5294 ../fish/guestfish-actions.pod:3481
15208 msgid "This command deletes the partition numbered C<partnum> on C<device>."
15212 #: ../src/guestfs-actions.pod:5296 ../fish/guestfish-actions.pod:3483
15214 "Note that in the case of MBR partitioning, deleting an extended partition "
15215 "also deletes any logical partitions it contains."
15219 #: ../src/guestfs-actions.pod:5304
15220 msgid "guestfs_part_disk"
15224 #: ../src/guestfs-actions.pod:5306
15228 " guestfs_part_disk (guestfs_h *g,\n"
15229 " const char *device,\n"
15230 " const char *parttype);\n"
15235 #: ../src/guestfs-actions.pod:5311
15237 "This command is simply a combination of C<guestfs_part_init> followed by "
15238 "C<guestfs_part_add> to create a single primary partition covering the whole "
15243 #: ../src/guestfs-actions.pod:5315
15245 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
15246 "possible values are described in C<guestfs_part_init>."
15250 #: ../src/guestfs-actions.pod:5325
15251 msgid "guestfs_part_get_bootable"
15255 #: ../src/guestfs-actions.pod:5327
15259 " guestfs_part_get_bootable (guestfs_h *g,\n"
15260 " const char *device,\n"
15266 #: ../src/guestfs-actions.pod:5332 ../fish/guestfish-actions.pod:3505
15268 "This command returns true if the partition C<partnum> on C<device> has the "
15269 "bootable flag set."
15273 #: ../src/guestfs-actions.pod:5335
15274 msgid "See also C<guestfs_part_set_bootable>."
15278 #: ../src/guestfs-actions.pod:5341
15279 msgid "guestfs_part_get_mbr_id"
15283 #: ../src/guestfs-actions.pod:5343
15287 " guestfs_part_get_mbr_id (guestfs_h *g,\n"
15288 " const char *device,\n"
15294 #: ../src/guestfs-actions.pod:5348 ../fish/guestfish-actions.pod:3514
15296 "Returns the MBR type byte (also known as the ID byte) from the numbered "
15297 "partition C<partnum>."
15301 #: ../src/guestfs-actions.pod:5351 ../src/guestfs-actions.pod:5527
15303 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
15304 "undefined results for other partition table types (see "
15305 "C<guestfs_part_get_parttype>)."
15309 #: ../src/guestfs-actions.pod:5359
15310 msgid "guestfs_part_get_parttype"
15314 #: ../src/guestfs-actions.pod:5361
15318 " guestfs_part_get_parttype (guestfs_h *g,\n"
15319 " const char *device);\n"
15324 #: ../src/guestfs-actions.pod:5365 ../fish/guestfish-actions.pod:3525
15326 "This command examines the partition table on C<device> and returns the "
15327 "partition table type (format) being used."
15331 #: ../src/guestfs-actions.pod:5368
15333 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
15334 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
15335 "possible, although unusual. See C<guestfs_part_init> for a full list."
15339 #: ../src/guestfs-actions.pod:5378
15340 msgid "guestfs_part_init"
15344 #: ../src/guestfs-actions.pod:5380
15348 " guestfs_part_init (guestfs_h *g,\n"
15349 " const char *device,\n"
15350 " const char *parttype);\n"
15355 #: ../src/guestfs-actions.pod:5385 ../fish/guestfish-actions.pod:3537
15357 "This creates an empty partition table on C<device> of one of the partition "
15358 "types listed below. Usually C<parttype> should be either C<msdos> or C<gpt> "
15359 "(for large disks)."
15363 #: ../src/guestfs-actions.pod:5389
15365 "Initially there are no partitions. Following this, you should call "
15366 "C<guestfs_part_add> for each partition required."
15370 #: ../src/guestfs-actions.pod:5392 ../fish/guestfish-actions.pod:3544
15371 msgid "Possible values for C<parttype> are:"
15375 #: ../src/guestfs-actions.pod:5396 ../fish/guestfish-actions.pod:3548
15376 msgid "B<efi> | B<gpt>"
15380 #: ../src/guestfs-actions.pod:5398 ../fish/guestfish-actions.pod:3550
15381 msgid "Intel EFI / GPT partition table."
15385 #: ../src/guestfs-actions.pod:5400 ../fish/guestfish-actions.pod:3552
15387 "This is recommended for >= 2 TB partitions that will be accessed from Linux "
15388 "and Intel-based Mac OS X. It also has limited backwards compatibility with "
15389 "the C<mbr> format."
15393 #: ../src/guestfs-actions.pod:5404 ../fish/guestfish-actions.pod:3556
15394 msgid "B<mbr> | B<msdos>"
15398 #: ../src/guestfs-actions.pod:5406 ../fish/guestfish-actions.pod:3558
15400 "The standard PC \"Master Boot Record\" (MBR) format used by MS-DOS and "
15401 "Windows. This partition type will B<only> work for device sizes up to 2 "
15402 "TB. For large disks we recommend using C<gpt>."
15406 #: ../src/guestfs-actions.pod:5413 ../fish/guestfish-actions.pod:3565
15408 "Other partition table types that may work but are not supported include:"
15412 #: ../src/guestfs-actions.pod:5418 ../fish/guestfish-actions.pod:3570
15417 #: ../src/guestfs-actions.pod:5420 ../fish/guestfish-actions.pod:3572
15418 msgid "AIX disk labels."
15422 #: ../src/guestfs-actions.pod:5422 ../fish/guestfish-actions.pod:3574
15423 msgid "B<amiga> | B<rdb>"
15427 #: ../src/guestfs-actions.pod:5424 ../fish/guestfish-actions.pod:3576
15428 msgid "Amiga \"Rigid Disk Block\" format."
15432 #: ../src/guestfs-actions.pod:5426 ../fish/guestfish-actions.pod:3578
15437 #: ../src/guestfs-actions.pod:5428 ../fish/guestfish-actions.pod:3580
15438 msgid "BSD disk labels."
15442 #: ../src/guestfs-actions.pod:5430 ../fish/guestfish-actions.pod:3582
15447 #: ../src/guestfs-actions.pod:5432 ../fish/guestfish-actions.pod:3584
15448 msgid "DASD, used on IBM mainframes."
15452 #: ../src/guestfs-actions.pod:5434 ../fish/guestfish-actions.pod:3586
15457 #: ../src/guestfs-actions.pod:5436 ../fish/guestfish-actions.pod:3588
15458 msgid "MIPS/SGI volumes."
15462 #: ../src/guestfs-actions.pod:5438 ../fish/guestfish-actions.pod:3590
15467 #: ../src/guestfs-actions.pod:5440 ../fish/guestfish-actions.pod:3592
15468 msgid "Old Mac partition format. Modern Macs use C<gpt>."
15472 #: ../src/guestfs-actions.pod:5442 ../fish/guestfish-actions.pod:3594
15477 #: ../src/guestfs-actions.pod:5444 ../fish/guestfish-actions.pod:3596
15478 msgid "NEC PC-98 format, common in Japan apparently."
15482 #: ../src/guestfs-actions.pod:5446 ../fish/guestfish-actions.pod:3598
15487 #: ../src/guestfs-actions.pod:5448 ../fish/guestfish-actions.pod:3600
15488 msgid "Sun disk labels."
15492 #: ../src/guestfs-actions.pod:5456
15493 msgid "guestfs_part_list"
15497 #: ../src/guestfs-actions.pod:5458
15500 " struct guestfs_partition_list *\n"
15501 " guestfs_part_list (guestfs_h *g,\n"
15502 " const char *device);\n"
15507 #: ../src/guestfs-actions.pod:5462 ../fish/guestfish-actions.pod:3608
15509 "This command parses the partition table on C<device> and returns the list of "
15510 "partitions found."
15514 #: ../src/guestfs-actions.pod:5465 ../fish/guestfish-actions.pod:3611
15515 msgid "The fields in the returned structure are:"
15519 #: ../src/guestfs-actions.pod:5469 ../fish/guestfish-actions.pod:3615
15520 msgid "B<part_num>"
15524 #: ../src/guestfs-actions.pod:5471 ../fish/guestfish-actions.pod:3617
15525 msgid "Partition number, counting from 1."
15529 #: ../src/guestfs-actions.pod:5473 ../fish/guestfish-actions.pod:3619
15530 msgid "B<part_start>"
15534 #: ../src/guestfs-actions.pod:5475
15536 "Start of the partition I<in bytes>. To get sectors you have to divide by "
15537 "the device's sector size, see C<guestfs_blockdev_getss>."
15541 #: ../src/guestfs-actions.pod:5478 ../fish/guestfish-actions.pod:3624
15542 msgid "B<part_end>"
15546 #: ../src/guestfs-actions.pod:5480 ../fish/guestfish-actions.pod:3626
15547 msgid "End of the partition in bytes."
15551 #: ../src/guestfs-actions.pod:5482 ../fish/guestfish-actions.pod:3628
15552 msgid "B<part_size>"
15556 #: ../src/guestfs-actions.pod:5484 ../fish/guestfish-actions.pod:3630
15557 msgid "Size of the partition in bytes."
15561 #: ../src/guestfs-actions.pod:5488
15563 "This function returns a C<struct guestfs_partition_list *>, or NULL if there "
15564 "was an error. I<The caller must call C<guestfs_free_partition_list> after "
15569 #: ../src/guestfs-actions.pod:5494
15570 msgid "guestfs_part_set_bootable"
15574 #: ../src/guestfs-actions.pod:5496
15578 " guestfs_part_set_bootable (guestfs_h *g,\n"
15579 " const char *device,\n"
15581 " int bootable);\n"
15586 #: ../src/guestfs-actions.pod:5502 ../fish/guestfish-actions.pod:3638
15588 "This sets the bootable flag on partition numbered C<partnum> on device "
15589 "C<device>. Note that partitions are numbered from 1."
15593 #: ../src/guestfs-actions.pod:5505 ../fish/guestfish-actions.pod:3641
15595 "The bootable flag is used by some operating systems (notably Windows) to "
15596 "determine which partition to boot from. It is by no means universally "
15601 #: ../src/guestfs-actions.pod:5513
15602 msgid "guestfs_part_set_mbr_id"
15606 #: ../src/guestfs-actions.pod:5515
15610 " guestfs_part_set_mbr_id (guestfs_h *g,\n"
15611 " const char *device,\n"
15618 #: ../src/guestfs-actions.pod:5521 ../fish/guestfish-actions.pod:3649
15620 "Sets the MBR type byte (also known as the ID byte) of the numbered partition "
15621 "C<partnum> to C<idbyte>. Note that the type bytes quoted in most "
15622 "documentation are in fact hexadecimal numbers, but usually documented "
15623 "without any leading \"0x\" which might be confusing."
15627 #: ../src/guestfs-actions.pod:5535
15628 msgid "guestfs_part_set_name"
15632 #: ../src/guestfs-actions.pod:5537
15636 " guestfs_part_set_name (guestfs_h *g,\n"
15637 " const char *device,\n"
15639 " const char *name);\n"
15644 #: ../src/guestfs-actions.pod:5543 ../fish/guestfish-actions.pod:3663
15646 "This sets the partition name on partition numbered C<partnum> on device "
15647 "C<device>. Note that partitions are numbered from 1."
15651 #: ../src/guestfs-actions.pod:5546 ../fish/guestfish-actions.pod:3666
15653 "The partition name can only be set on certain types of partition table. "
15654 "This works on C<gpt> but not on C<mbr> partitions."
15658 #: ../src/guestfs-actions.pod:5553
15659 msgid "guestfs_part_to_dev"
15663 #: ../src/guestfs-actions.pod:5555
15667 " guestfs_part_to_dev (guestfs_h *g,\n"
15668 " const char *partition);\n"
15673 #: ../src/guestfs-actions.pod:5559 ../fish/guestfish-actions.pod:3673
15675 "This function takes a partition name (eg. \"/dev/sdb1\") and removes the "
15676 "partition number, returning the device name (eg. \"/dev/sdb\")."
15680 #: ../src/guestfs-actions.pod:5563
15682 "The named partition must exist, for example as a string returned from "
15683 "C<guestfs_list_partitions>."
15687 #: ../src/guestfs-actions.pod:5571
15688 msgid "guestfs_ping_daemon"
15692 #: ../src/guestfs-actions.pod:5573
15696 " guestfs_ping_daemon (guestfs_h *g);\n"
15701 #: ../src/guestfs-actions.pod:5576 ../fish/guestfish-actions.pod:3684
15703 "This is a test probe into the guestfs daemon running inside the qemu "
15704 "subprocess. Calling this function checks that the daemon responds to the "
15705 "ping message, without affecting the daemon or attached block device(s) in "
15710 #: ../src/guestfs-actions.pod:5585
15711 msgid "guestfs_pread"
15715 #: ../src/guestfs-actions.pod:5587
15719 " guestfs_pread (guestfs_h *g,\n"
15720 " const char *path,\n"
15722 " int64_t offset,\n"
15723 " size_t *size_r);\n"
15728 #: ../src/guestfs-actions.pod:5594 ../fish/guestfish-actions.pod:3693
15730 "This command lets you read part of a file. It reads C<count> bytes of the "
15731 "file, starting at C<offset>, from file C<path>."
15735 #: ../src/guestfs-actions.pod:5597 ../src/guestfs-actions.pod:5623
15736 #: ../fish/guestfish-actions.pod:3696 ../fish/guestfish-actions.pod:3711
15738 "This may read fewer bytes than requested. For further details see the "
15739 "L<pread(2)> system call."
15743 #: ../src/guestfs-actions.pod:5600
15744 msgid "See also C<guestfs_pwrite>, C<guestfs_pread_device>."
15748 #: ../src/guestfs-actions.pod:5611
15749 msgid "guestfs_pread_device"
15753 #: ../src/guestfs-actions.pod:5613
15757 " guestfs_pread_device (guestfs_h *g,\n"
15758 " const char *device,\n"
15760 " int64_t offset,\n"
15761 " size_t *size_r);\n"
15766 #: ../src/guestfs-actions.pod:5620 ../fish/guestfish-actions.pod:3708
15768 "This command lets you read part of a file. It reads C<count> bytes of "
15769 "C<device>, starting at C<offset>."
15773 #: ../src/guestfs-actions.pod:5626
15774 msgid "See also C<guestfs_pread>."
15778 #: ../src/guestfs-actions.pod:5635
15779 msgid "(Added in 1.5.21)"
15783 #: ../src/guestfs-actions.pod:5637
15784 msgid "guestfs_pvcreate"
15788 #: ../src/guestfs-actions.pod:5639
15792 " guestfs_pvcreate (guestfs_h *g,\n"
15793 " const char *device);\n"
15798 #: ../src/guestfs-actions.pod:5643 ../fish/guestfish-actions.pod:3723
15800 "This creates an LVM physical volume on the named C<device>, where C<device> "
15801 "should usually be a partition name such as C</dev/sda1>."
15805 #: ../src/guestfs-actions.pod:5651
15806 msgid "guestfs_pvremove"
15810 #: ../src/guestfs-actions.pod:5653
15814 " guestfs_pvremove (guestfs_h *g,\n"
15815 " const char *device);\n"
15820 #: ../src/guestfs-actions.pod:5657 ../fish/guestfish-actions.pod:3731
15822 "This wipes a physical volume C<device> so that LVM will no longer recognise "
15827 #: ../src/guestfs-actions.pod:5660 ../fish/guestfish-actions.pod:3734
15829 "The implementation uses the C<pvremove> command which refuses to wipe "
15830 "physical volumes that contain any volume groups, so you have to remove those "
15835 #: ../src/guestfs-actions.pod:5668
15836 msgid "guestfs_pvresize"
15840 #: ../src/guestfs-actions.pod:5670
15844 " guestfs_pvresize (guestfs_h *g,\n"
15845 " const char *device);\n"
15850 #: ../src/guestfs-actions.pod:5674 ../fish/guestfish-actions.pod:3742
15852 "This resizes (expands or shrinks) an existing LVM physical volume to match "
15853 "the new size of the underlying device."
15857 #: ../src/guestfs-actions.pod:5681
15858 msgid "guestfs_pvresize_size"
15862 #: ../src/guestfs-actions.pod:5683
15866 " guestfs_pvresize_size (guestfs_h *g,\n"
15867 " const char *device,\n"
15868 " int64_t size);\n"
15873 #: ../src/guestfs-actions.pod:5688
15875 "This command is the same as C<guestfs_pvresize> except that it allows you to "
15876 "specify the new size (in bytes) explicitly."
15880 #: ../src/guestfs-actions.pod:5695
15881 msgid "guestfs_pvs"
15885 #: ../src/guestfs-actions.pod:5697
15889 " guestfs_pvs (guestfs_h *g);\n"
15894 #: ../src/guestfs-actions.pod:5700 ../fish/guestfish-actions.pod:3756
15896 "List all the physical volumes detected. This is the equivalent of the L<pvs"
15901 #: ../src/guestfs-actions.pod:5703 ../fish/guestfish-actions.pod:3759
15903 "This returns a list of just the device names that contain PVs (eg. C</dev/"
15908 #: ../src/guestfs-actions.pod:5706
15909 msgid "See also C<guestfs_pvs_full>."
15913 #: ../src/guestfs-actions.pod:5714
15914 msgid "guestfs_pvs_full"
15918 #: ../src/guestfs-actions.pod:5716
15921 " struct guestfs_lvm_pv_list *\n"
15922 " guestfs_pvs_full (guestfs_h *g);\n"
15927 #: ../src/guestfs-actions.pod:5719 ../fish/guestfish-actions.pod:3768
15929 "List all the physical volumes detected. This is the equivalent of the L<pvs"
15930 "(8)> command. The \"full\" version includes all fields."
15934 #: ../src/guestfs-actions.pod:5722
15936 "This function returns a C<struct guestfs_lvm_pv_list *>, or NULL if there "
15937 "was an error. I<The caller must call C<guestfs_free_lvm_pv_list> after use>."
15941 #: ../src/guestfs-actions.pod:5728
15942 msgid "guestfs_pvuuid"
15946 #: ../src/guestfs-actions.pod:5730
15950 " guestfs_pvuuid (guestfs_h *g,\n"
15951 " const char *device);\n"
15956 #: ../src/guestfs-actions.pod:5734 ../fish/guestfish-actions.pod:3775
15957 msgid "This command returns the UUID of the LVM PV C<device>."
15961 #: ../src/guestfs-actions.pod:5741
15962 msgid "guestfs_pwrite"
15966 #: ../src/guestfs-actions.pod:5743
15970 " guestfs_pwrite (guestfs_h *g,\n"
15971 " const char *path,\n"
15972 " const char *content,\n"
15973 " size_t content_size,\n"
15974 " int64_t offset);\n"
15979 #: ../src/guestfs-actions.pod:5750 ../fish/guestfish-actions.pod:3781
15981 "This command writes to part of a file. It writes the data buffer C<content> "
15982 "to the file C<path> starting at offset C<offset>."
15986 #: ../src/guestfs-actions.pod:5753 ../fish/guestfish-actions.pod:3784
15988 "This command implements the L<pwrite(2)> system call, and like that system "
15989 "call it may not write the full data requested. The return value is the "
15990 "number of bytes that were actually written to the file. This could even be "
15991 "0, although short writes are unlikely for regular files in ordinary "
15996 #: ../src/guestfs-actions.pod:5759
15997 msgid "See also C<guestfs_pread>, C<guestfs_pwrite_device>."
16001 #: ../src/guestfs-actions.pod:5768
16002 msgid "guestfs_pwrite_device"
16006 #: ../src/guestfs-actions.pod:5770
16010 " guestfs_pwrite_device (guestfs_h *g,\n"
16011 " const char *device,\n"
16012 " const char *content,\n"
16013 " size_t content_size,\n"
16014 " int64_t offset);\n"
16019 #: ../src/guestfs-actions.pod:5777 ../fish/guestfish-actions.pod:3799
16021 "This command writes to part of a device. It writes the data buffer "
16022 "C<content> to C<device> starting at offset C<offset>."
16026 #: ../src/guestfs-actions.pod:5780 ../fish/guestfish-actions.pod:3802
16028 "This command implements the L<pwrite(2)> system call, and like that system "
16029 "call it may not write the full data requested (although short writes to disk "
16030 "devices and partitions are probably impossible with standard Linux kernels)."
16034 #: ../src/guestfs-actions.pod:5785
16035 msgid "See also C<guestfs_pwrite>."
16039 #: ../src/guestfs-actions.pod:5792
16040 msgid "(Added in 1.5.20)"
16044 #: ../src/guestfs-actions.pod:5794
16045 msgid "guestfs_read_file"
16049 #: ../src/guestfs-actions.pod:5796
16053 " guestfs_read_file (guestfs_h *g,\n"
16054 " const char *path,\n"
16055 " size_t *size_r);\n"
16060 #: ../src/guestfs-actions.pod:5801 ../fish/guestfish-actions.pod:3816
16061 msgid "This calls returns the contents of the file C<path> as a buffer."
16065 #: ../src/guestfs-actions.pod:5804
16067 "Unlike C<guestfs_cat>, this function can correctly handle files that contain "
16068 "embedded ASCII NUL characters. However unlike C<guestfs_download>, this "
16069 "function is limited in the total size of file that can be handled."
16073 #: ../src/guestfs-actions.pod:5816
16074 msgid "(Added in 1.0.63)"
16078 #: ../src/guestfs-actions.pod:5818
16079 msgid "guestfs_read_lines"
16083 #: ../src/guestfs-actions.pod:5820
16087 " guestfs_read_lines (guestfs_h *g,\n"
16088 " const char *path);\n"
16093 #: ../src/guestfs-actions.pod:5826 ../fish/guestfish-actions.pod:3833
16095 "The file contents are returned as a list of lines. Trailing C<LF> and "
16096 "C<CRLF> character sequences are I<not> returned."
16100 #: ../src/guestfs-actions.pod:5829
16102 "Note that this function cannot correctly handle binary files (specifically, "
16103 "files containing C<\\0> character which is treated as end of line). For "
16104 "those you need to use the C<guestfs_read_file> function which has a more "
16105 "complex interface."
16109 #: ../src/guestfs-actions.pod:5840
16110 msgid "guestfs_readdir"
16114 #: ../src/guestfs-actions.pod:5842
16117 " struct guestfs_dirent_list *\n"
16118 " guestfs_readdir (guestfs_h *g,\n"
16119 " const char *dir);\n"
16124 #: ../src/guestfs-actions.pod:5846 ../fish/guestfish-actions.pod:3845
16125 msgid "This returns the list of directory entries in directory C<dir>."
16129 #: ../src/guestfs-actions.pod:5848 ../fish/guestfish-actions.pod:3847
16131 "All entries in the directory are returned, including C<.> and C<..>. The "
16132 "entries are I<not> sorted, but returned in the same order as the underlying "
16137 #: ../src/guestfs-actions.pod:5852 ../fish/guestfish-actions.pod:3851
16139 "Also this call returns basic file type information about each file. The "
16140 "C<ftyp> field will contain one of the following characters:"
16144 #: ../src/guestfs-actions.pod:5857 ../fish/guestfish-actions.pod:3856
16149 #: ../src/guestfs-actions.pod:5859 ../fish/guestfish-actions.pod:3858
16150 msgid "Block special"
16154 #: ../src/guestfs-actions.pod:5861 ../fish/guestfish-actions.pod:3860
16159 #: ../src/guestfs-actions.pod:5863 ../fish/guestfish-actions.pod:3862
16160 msgid "Char special"
16164 #: ../src/guestfs-actions.pod:5865 ../fish/guestfish-actions.pod:3864
16169 #: ../src/guestfs-actions.pod:5867 ../fish/guestfish-actions.pod:3866
16174 #: ../src/guestfs-actions.pod:5869 ../fish/guestfish-actions.pod:3868
16179 #: ../src/guestfs-actions.pod:5871 ../fish/guestfish-actions.pod:3870
16180 msgid "FIFO (named pipe)"
16184 #: ../src/guestfs-actions.pod:5873 ../fish/guestfish-actions.pod:3872
16189 #: ../src/guestfs-actions.pod:5875 ../fish/guestfish-actions.pod:3874
16190 msgid "Symbolic link"
16194 #: ../src/guestfs-actions.pod:5877 ../fish/guestfish-actions.pod:3876
16199 #: ../src/guestfs-actions.pod:5879 ../fish/guestfish-actions.pod:3878
16200 msgid "Regular file"
16204 #: ../src/guestfs-actions.pod:5881 ../fish/guestfish-actions.pod:3880
16209 #: ../src/guestfs-actions.pod:5883 ../fish/guestfish-actions.pod:3882
16214 #: ../src/guestfs-actions.pod:5885 ../fish/guestfish-actions.pod:3884
16219 #: ../src/guestfs-actions.pod:5887 ../fish/guestfish-actions.pod:3886
16220 msgid "Unknown file type"
16224 #: ../src/guestfs-actions.pod:5889 ../fish/guestfish-actions.pod:3888
16229 #: ../src/guestfs-actions.pod:5891 ../fish/guestfish-actions.pod:3890
16231 "The L<readdir(3)> call returned a C<d_type> field with an unexpected value"
16235 #: ../src/guestfs-actions.pod:5896
16237 "This function is primarily intended for use by programs. To get a simple "
16238 "list of names, use C<guestfs_ls>. To get a printable directory for human "
16239 "consumption, use C<guestfs_ll>."
16243 #: ../src/guestfs-actions.pod:5900
16245 "This function returns a C<struct guestfs_dirent_list *>, or NULL if there "
16246 "was an error. I<The caller must call C<guestfs_free_dirent_list> after use>."
16250 #: ../src/guestfs-actions.pod:5906
16251 msgid "guestfs_readlink"
16255 #: ../src/guestfs-actions.pod:5908
16259 " guestfs_readlink (guestfs_h *g,\n"
16260 " const char *path);\n"
16265 #: ../src/guestfs-actions.pod:5912 ../fish/guestfish-actions.pod:3903
16266 msgid "This command reads the target of a symbolic link."
16270 #: ../src/guestfs-actions.pod:5919
16271 msgid "guestfs_readlinklist"
16275 #: ../src/guestfs-actions.pod:5921
16279 " guestfs_readlinklist (guestfs_h *g,\n"
16280 " const char *path,\n"
16281 " char *const *names);\n"
16286 #: ../src/guestfs-actions.pod:5926 ../fish/guestfish-actions.pod:3909
16288 "This call allows you to do a C<readlink> operation on multiple files, where "
16289 "all files are in the directory C<path>. C<names> is the list of files from "
16294 #: ../src/guestfs-actions.pod:5930 ../fish/guestfish-actions.pod:3913
16296 "On return you get a list of strings, with a one-to-one correspondence to the "
16297 "C<names> list. Each string is the value of the symbolic link."
16301 #: ../src/guestfs-actions.pod:5934 ../fish/guestfish-actions.pod:3917
16303 "If the C<readlink(2)> operation fails on any name, then the corresponding "
16304 "result string is the empty string C<\"\">. However the whole operation is "
16305 "completed even if there were C<readlink(2)> errors, and so you can call this "
16306 "function with names where you don't know if they are symbolic links already "
16307 "(albeit slightly less efficient)."
16311 #: ../src/guestfs-actions.pod:5941 ../fish/guestfish-actions.pod:3924
16313 "This call is intended for programs that want to efficiently list a directory "
16314 "contents without making many round-trips. Very long directory listings "
16315 "might cause the protocol message size to be exceeded, causing this call to "
16316 "fail. The caller must split up such requests into smaller groups of names."
16320 #: ../src/guestfs-actions.pod:5954
16321 msgid "guestfs_realpath"
16325 #: ../src/guestfs-actions.pod:5956
16329 " guestfs_realpath (guestfs_h *g,\n"
16330 " const char *path);\n"
16335 #: ../src/guestfs-actions.pod:5960 ../fish/guestfish-actions.pod:3935
16337 "Return the canonicalized absolute pathname of C<path>. The returned path "
16338 "has no C<.>, C<..> or symbolic link path elements."
16342 #: ../src/guestfs-actions.pod:5968
16343 msgid "guestfs_removexattr"
16347 #: ../src/guestfs-actions.pod:5970
16351 " guestfs_removexattr (guestfs_h *g,\n"
16352 " const char *xattr,\n"
16353 " const char *path);\n"
16358 #: ../src/guestfs-actions.pod:5975 ../fish/guestfish-actions.pod:3942
16360 "This call removes the extended attribute named C<xattr> of the file C<path>."
16364 #: ../src/guestfs-actions.pod:5978
16365 msgid "See also: C<guestfs_lremovexattr>, L<attr(5)>."
16369 #: ../src/guestfs-actions.pod:5984
16370 msgid "guestfs_resize2fs"
16374 #: ../src/guestfs-actions.pod:5986
16378 " guestfs_resize2fs (guestfs_h *g,\n"
16379 " const char *device);\n"
16384 #: ../src/guestfs-actions.pod:5990 ../fish/guestfish-actions.pod:3951
16386 "This resizes an ext2, ext3 or ext4 filesystem to match the size of the "
16387 "underlying device."
16391 #: ../src/guestfs-actions.pod:5993
16393 "I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f> on the "
16394 "C<device> before calling this command. For unknown reasons C<resize2fs> "
16395 "sometimes gives an error about this and sometimes not. In any case, it is "
16396 "always safe to call C<guestfs_e2fsck_f> before calling this function."
16400 #: ../src/guestfs-actions.pod:6003
16401 msgid "guestfs_resize2fs_M"
16405 #: ../src/guestfs-actions.pod:6005
16409 " guestfs_resize2fs_M (guestfs_h *g,\n"
16410 " const char *device);\n"
16415 #: ../src/guestfs-actions.pod:6009
16417 "This command is the same as C<guestfs_resize2fs>, but the filesystem is "
16418 "resized to its minimum size. This works like the I<-M> option to the "
16419 "C<resize2fs> command."
16423 #: ../src/guestfs-actions.pod:6013
16425 "To get the resulting size of the filesystem you should call "
16426 "C<guestfs_tune2fs_l> and read the C<Block size> and C<Block count> values. "
16427 "These two numbers, multiplied together, give the resulting size of the "
16428 "minimal filesystem in bytes."
16432 #: ../src/guestfs-actions.pod:6022
16433 msgid "guestfs_resize2fs_size"
16437 #: ../src/guestfs-actions.pod:6024
16441 " guestfs_resize2fs_size (guestfs_h *g,\n"
16442 " const char *device,\n"
16443 " int64_t size);\n"
16448 #: ../src/guestfs-actions.pod:6029
16450 "This command is the same as C<guestfs_resize2fs> except that it allows you "
16451 "to specify the new size (in bytes) explicitly."
16455 #: ../src/guestfs-actions.pod:6036
16460 #: ../src/guestfs-actions.pod:6038
16464 " guestfs_rm (guestfs_h *g,\n"
16465 " const char *path);\n"
16470 #: ../src/guestfs-actions.pod:6042 ../fish/guestfish-actions.pod:3984
16471 msgid "Remove the single file C<path>."
16475 #: ../src/guestfs-actions.pod:6048
16476 msgid "guestfs_rm_rf"
16480 #: ../src/guestfs-actions.pod:6050
16484 " guestfs_rm_rf (guestfs_h *g,\n"
16485 " const char *path);\n"
16490 #: ../src/guestfs-actions.pod:6054 ../fish/guestfish-actions.pod:3990
16492 "Remove the file or directory C<path>, recursively removing the contents if "
16493 "its a directory. This is like the C<rm -rf> shell command."
16497 #: ../src/guestfs-actions.pod:6062
16498 msgid "guestfs_rmdir"
16502 #: ../src/guestfs-actions.pod:6064
16506 " guestfs_rmdir (guestfs_h *g,\n"
16507 " const char *path);\n"
16512 #: ../src/guestfs-actions.pod:6068 ../fish/guestfish-actions.pod:3998
16513 msgid "Remove the single directory C<path>."
16517 #: ../src/guestfs-actions.pod:6074
16518 msgid "guestfs_rmmountpoint"
16522 #: ../src/guestfs-actions.pod:6076
16526 " guestfs_rmmountpoint (guestfs_h *g,\n"
16527 " const char *exemptpath);\n"
16532 #: ../src/guestfs-actions.pod:6080
16534 "This calls removes a mountpoint that was previously created with "
16535 "C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint> for full details."
16539 #: ../src/guestfs-actions.pod:6088
16540 msgid "guestfs_scrub_device"
16544 #: ../src/guestfs-actions.pod:6090
16548 " guestfs_scrub_device (guestfs_h *g,\n"
16549 " const char *device);\n"
16554 #: ../src/guestfs-actions.pod:6094 ../fish/guestfish-actions.pod:4012
16556 "This command writes patterns over C<device> to make data retrieval more "
16561 #: ../src/guestfs-actions.pod:6097 ../src/guestfs-actions.pod:6118
16562 #: ../src/guestfs-actions.pod:6137 ../fish/guestfish-actions.pod:4015
16563 #: ../fish/guestfish-actions.pod:4030 ../fish/guestfish-actions.pod:4043
16565 "It is an interface to the L<scrub(1)> program. See that manual page for "
16570 #: ../src/guestfs-actions.pod:6105 ../src/guestfs-actions.pod:6123
16571 #: ../src/guestfs-actions.pod:6142
16572 msgid "(Added in 1.0.52)"
16576 #: ../src/guestfs-actions.pod:6107
16577 msgid "guestfs_scrub_file"
16581 #: ../src/guestfs-actions.pod:6109
16585 " guestfs_scrub_file (guestfs_h *g,\n"
16586 " const char *file);\n"
16591 #: ../src/guestfs-actions.pod:6113 ../fish/guestfish-actions.pod:4025
16593 "This command writes patterns over a file to make data retrieval more "
16598 #: ../src/guestfs-actions.pod:6116 ../fish/guestfish-actions.pod:4028
16599 msgid "The file is I<removed> after scrubbing."
16603 #: ../src/guestfs-actions.pod:6125
16604 msgid "guestfs_scrub_freespace"
16608 #: ../src/guestfs-actions.pod:6127
16612 " guestfs_scrub_freespace (guestfs_h *g,\n"
16613 " const char *dir);\n"
16618 #: ../src/guestfs-actions.pod:6131
16620 "This command creates the directory C<dir> and then fills it with files until "
16621 "the filesystem is full, and scrubs the files as for C<guestfs_scrub_file>, "
16622 "and deletes them. The intention is to scrub any free space on the partition "
16623 "containing C<dir>."
16627 #: ../src/guestfs-actions.pod:6144
16628 msgid "guestfs_set_append"
16632 #: ../src/guestfs-actions.pod:6146
16636 " guestfs_set_append (guestfs_h *g,\n"
16637 " const char *append);\n"
16642 #: ../src/guestfs-actions.pod:6150 ../fish/guestfish-actions.pod:4052
16644 "This function is used to add additional options to the guest kernel command "
16649 #: ../src/guestfs-actions.pod:6153 ../fish/guestfish-actions.pod:4055
16651 "The default is C<NULL> unless overridden by setting C<LIBGUESTFS_APPEND> "
16652 "environment variable."
16656 #: ../src/guestfs-actions.pod:6156 ../fish/guestfish-actions.pod:4058
16658 "Setting C<append> to C<NULL> means I<no> additional options are passed "
16659 "(libguestfs always adds a few of its own)."
16663 #: ../src/guestfs-actions.pod:6163
16664 msgid "guestfs_set_attach_method"
16668 #: ../src/guestfs-actions.pod:6165
16672 " guestfs_set_attach_method (guestfs_h *g,\n"
16673 " const char *attachmethod);\n"
16678 #: ../src/guestfs-actions.pod:6169 ../fish/guestfish-actions.pod:4067
16680 "Set the method that libguestfs uses to connect to the back end guestfsd "
16681 "daemon. Possible methods are:"
16685 #: ../src/guestfs-actions.pod:6176 ../fish/guestfish-actions.pod:4074
16687 "Launch an appliance and connect to it. This is the ordinary method and the "
16692 #: ../src/guestfs-actions.pod:6179 ../fish/guestfish-actions.pod:4077
16693 msgid "C<unix:I<path>>"
16697 #: ../src/guestfs-actions.pod:6181 ../fish/guestfish-actions.pod:4079
16698 msgid "Connect to the Unix domain socket I<path>."
16702 #: ../src/guestfs-actions.pod:6183 ../fish/guestfish-actions.pod:4081
16704 "This method lets you connect to an existing daemon or (using virtio-serial) "
16705 "to a live guest. For more information, see L<guestfs(3)/ATTACHING TO "
16706 "RUNNING DAEMONS>."
16710 #: ../src/guestfs-actions.pod:6193
16711 msgid "guestfs_set_autosync"
16715 #: ../src/guestfs-actions.pod:6195
16719 " guestfs_set_autosync (guestfs_h *g,\n"
16720 " int autosync);\n"
16725 #: ../src/guestfs-actions.pod:6199 ../fish/guestfish-actions.pod:4093
16727 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
16728 "effort attempt to make filesystems consistent and synchronized when the "
16729 "handle is closed (also if the program exits without closing handles)."
16733 #: ../src/guestfs-actions.pod:6204 ../fish/guestfish-actions.pod:4098
16735 "This is enabled by default (since libguestfs 1.5.24, previously it was "
16736 "disabled by default)."
16740 #: ../src/guestfs-actions.pod:6211
16741 msgid "guestfs_set_direct"
16745 #: ../src/guestfs-actions.pod:6213
16749 " guestfs_set_direct (guestfs_h *g,\n"
16755 #: ../src/guestfs-actions.pod:6217 ../fish/guestfish-actions.pod:4107
16757 "If the direct appliance mode flag is enabled, then stdin and stdout are "
16758 "passed directly through to the appliance once it is launched."
16762 #: ../src/guestfs-actions.pod:6221
16764 "One consequence of this is that log messages aren't caught by the library "
16765 "and handled by C<guestfs_set_log_message_callback>, but go straight to "
16770 #: ../src/guestfs-actions.pod:6225 ../fish/guestfish-actions.pod:4115
16771 msgid "You probably don't want to use this unless you know what you are doing."
16775 #: ../src/guestfs-actions.pod:6228 ../fish/guestfish-actions.pod:4118
16776 msgid "The default is disabled."
16780 #: ../src/guestfs-actions.pod:6234
16781 msgid "guestfs_set_e2label"
16785 #: ../src/guestfs-actions.pod:6236
16789 " guestfs_set_e2label (guestfs_h *g,\n"
16790 " const char *device,\n"
16791 " const char *label);\n"
16796 #: ../src/guestfs-actions.pod:6241 ../fish/guestfish-actions.pod:4124
16798 "This sets the ext2/3/4 filesystem label of the filesystem on C<device> to "
16799 "C<label>. Filesystem labels are limited to 16 characters."
16803 #: ../src/guestfs-actions.pod:6245
16805 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label> to return "
16806 "the existing label on a filesystem."
16810 #: ../src/guestfs-actions.pod:6252
16811 msgid "guestfs_set_e2uuid"
16815 #: ../src/guestfs-actions.pod:6254
16819 " guestfs_set_e2uuid (guestfs_h *g,\n"
16820 " const char *device,\n"
16821 " const char *uuid);\n"
16826 #: ../src/guestfs-actions.pod:6259 ../fish/guestfish-actions.pod:4135
16828 "This sets the ext2/3/4 filesystem UUID of the filesystem on C<device> to "
16829 "C<uuid>. The format of the UUID and alternatives such as C<clear>, "
16830 "C<random> and C<time> are described in the L<tune2fs(8)> manpage."
16834 #: ../src/guestfs-actions.pod:6264
16836 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid> to return "
16837 "the existing UUID of a filesystem."
16841 #: ../src/guestfs-actions.pod:6271
16842 msgid "guestfs_set_memsize"
16846 #: ../src/guestfs-actions.pod:6273
16850 " guestfs_set_memsize (guestfs_h *g,\n"
16856 #: ../src/guestfs-actions.pod:6277
16858 "This sets the memory size in megabytes allocated to the qemu subprocess. "
16859 "This only has any effect if called before C<guestfs_launch>."
16863 #: ../src/guestfs-actions.pod:6281 ../fish/guestfish-actions.pod:4153
16865 "You can also change this by setting the environment variable "
16866 "C<LIBGUESTFS_MEMSIZE> before the handle is created."
16870 #: ../src/guestfs-actions.pod:6292
16871 msgid "guestfs_set_network"
16875 #: ../src/guestfs-actions.pod:6294
16879 " guestfs_set_network (guestfs_h *g,\n"
16885 #: ../src/guestfs-actions.pod:6298 ../fish/guestfish-actions.pod:4166
16887 "If C<network> is true, then the network is enabled in the libguestfs "
16888 "appliance. The default is false."
16892 #: ../src/guestfs-actions.pod:6301 ../fish/guestfish-actions.pod:4169
16894 "This affects whether commands are able to access the network (see L<guestfs"
16895 "(3)/RUNNING COMMANDS>)."
16899 #: ../src/guestfs-actions.pod:6304
16901 "You must call this before calling C<guestfs_launch>, otherwise it has no "
16906 #: ../src/guestfs-actions.pod:6311
16907 msgid "guestfs_set_path"
16911 #: ../src/guestfs-actions.pod:6313
16915 " guestfs_set_path (guestfs_h *g,\n"
16916 " const char *searchpath);\n"
16921 #: ../src/guestfs-actions.pod:6317 ../fish/guestfish-actions.pod:4181
16922 msgid "Set the path that libguestfs searches for kernel and initrd.img."
16926 #: ../src/guestfs-actions.pod:6319 ../fish/guestfish-actions.pod:4183
16928 "The default is C<$libdir/guestfs> unless overridden by setting "
16929 "C<LIBGUESTFS_PATH> environment variable."
16933 #: ../src/guestfs-actions.pod:6322 ../fish/guestfish-actions.pod:4186
16934 msgid "Setting C<path> to C<NULL> restores the default path."
16938 #: ../src/guestfs-actions.pod:6328
16939 msgid "guestfs_set_pgroup"
16943 #: ../src/guestfs-actions.pod:6330
16947 " guestfs_set_pgroup (guestfs_h *g,\n"
16953 #: ../src/guestfs-actions.pod:6334 ../fish/guestfish-actions.pod:4194
16955 "If C<pgroup> is true, child processes are placed into their own process "
16960 #: ../src/guestfs-actions.pod:6337 ../fish/guestfish-actions.pod:4197
16962 "The practical upshot of this is that signals like C<SIGINT> (from users "
16963 "pressing C<^C>) won't be received by the child process."
16967 #: ../src/guestfs-actions.pod:6340 ../fish/guestfish-actions.pod:4200
16969 "The default for this flag is false, because usually you want C<^C> to kill "
16974 #: ../src/guestfs-actions.pod:6345
16975 msgid "guestfs_set_qemu"
16979 #: ../src/guestfs-actions.pod:6347
16983 " guestfs_set_qemu (guestfs_h *g,\n"
16984 " const char *qemu);\n"
16989 #: ../src/guestfs-actions.pod:6351 ../fish/guestfish-actions.pod:4209
16990 msgid "Set the qemu binary that we will use."
16994 #: ../src/guestfs-actions.pod:6353 ../fish/guestfish-actions.pod:4211
16996 "The default is chosen when the library was compiled by the configure script."
17000 #: ../src/guestfs-actions.pod:6356 ../fish/guestfish-actions.pod:4214
17002 "You can also override this by setting the C<LIBGUESTFS_QEMU> environment "
17007 #: ../src/guestfs-actions.pod:6359 ../fish/guestfish-actions.pod:4217
17008 msgid "Setting C<qemu> to C<NULL> restores the default qemu binary."
17012 #: ../src/guestfs-actions.pod:6361 ../fish/guestfish-actions.pod:4219
17014 "Note that you should call this function as early as possible after creating "
17015 "the handle. This is because some pre-launch operations depend on testing "
17016 "qemu features (by running C<qemu -help>). If the qemu binary changes, we "
17017 "don't retest features, and so you might see inconsistent results. Using the "
17018 "environment variable C<LIBGUESTFS_QEMU> is safest of all since that picks "
17019 "the qemu binary at the same time as the handle is created."
17023 #: ../src/guestfs-actions.pod:6373
17024 msgid "guestfs_set_recovery_proc"
17028 #: ../src/guestfs-actions.pod:6375
17032 " guestfs_set_recovery_proc (guestfs_h *g,\n"
17033 " int recoveryproc);\n"
17038 #: ../src/guestfs-actions.pod:6379
17040 "If this is called with the parameter C<false> then C<guestfs_launch> does "
17041 "not create a recovery process. The purpose of the recovery process is to "
17042 "stop runaway qemu processes in the case where the main program aborts "
17047 #: ../src/guestfs-actions.pod:6384
17049 "This only has any effect if called before C<guestfs_launch>, and the default "
17054 #: ../src/guestfs-actions.pod:6387 ../fish/guestfish-actions.pod:4241
17056 "About the only time when you would want to disable this is if the main "
17057 "process will fork itself into the background (\"daemonize\" itself). In "
17058 "this case the recovery process thinks that the main program has disappeared "
17059 "and so kills qemu, which is not very helpful."
17063 #: ../src/guestfs-actions.pod:6397
17064 msgid "guestfs_set_selinux"
17068 #: ../src/guestfs-actions.pod:6399
17072 " guestfs_set_selinux (guestfs_h *g,\n"
17078 #: ../src/guestfs-actions.pod:6403 ../fish/guestfish-actions.pod:4253
17080 "This sets the selinux flag that is passed to the appliance at boot time. "
17081 "The default is C<selinux=0> (disabled)."
17085 #: ../src/guestfs-actions.pod:6406 ../fish/guestfish-actions.pod:4256
17087 "Note that if SELinux is enabled, it is always in Permissive mode "
17088 "(C<enforcing=0>)."
17092 #: ../src/guestfs-actions.pod:6416
17093 msgid "guestfs_set_trace"
17097 #: ../src/guestfs-actions.pod:6418
17101 " guestfs_set_trace (guestfs_h *g,\n"
17107 #: ../src/guestfs-actions.pod:6422 ../fish/guestfish-actions.pod:4268
17109 "If the command trace flag is set to 1, then libguestfs calls, parameters and "
17110 "return values are traced."
17114 #: ../src/guestfs-actions.pod:6425 ../fish/guestfish-actions.pod:4271
17116 "If you want to trace C API calls into libguestfs (and other libraries) then "
17117 "possibly a better way is to use the external ltrace(1) command."
17121 #: ../src/guestfs-actions.pod:6429 ../fish/guestfish-actions.pod:4275
17123 "Command traces are disabled unless the environment variable "
17124 "C<LIBGUESTFS_TRACE> is defined and set to C<1>."
17128 #: ../src/guestfs-actions.pod:6432
17130 "Trace messages are normally sent to C<stderr>, unless you register a "
17131 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
17135 #: ../src/guestfs-actions.pod:6440
17136 msgid "guestfs_set_verbose"
17140 #: ../src/guestfs-actions.pod:6442
17144 " guestfs_set_verbose (guestfs_h *g,\n"
17150 #: ../src/guestfs-actions.pod:6446 ../fish/guestfish-actions.pod:4288
17151 msgid "If C<verbose> is true, this turns on verbose messages."
17155 #: ../src/guestfs-actions.pod:6448 ../fish/guestfish-actions.pod:4290
17157 "Verbose messages are disabled unless the environment variable "
17158 "C<LIBGUESTFS_DEBUG> is defined and set to C<1>."
17162 #: ../src/guestfs-actions.pod:6451
17164 "Verbose messages are normally sent to C<stderr>, unless you register a "
17165 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
17169 #: ../src/guestfs-actions.pod:6459
17170 msgid "guestfs_setcon"
17174 #: ../src/guestfs-actions.pod:6461
17178 " guestfs_setcon (guestfs_h *g,\n"
17179 " const char *context);\n"
17184 #: ../src/guestfs-actions.pod:6465 ../fish/guestfish-actions.pod:4301
17186 "This sets the SELinux security context of the daemon to the string "
17191 #: ../src/guestfs-actions.pod:6468 ../fish/guestfish-actions.pod:4304
17192 msgid "See the documentation about SELINUX in L<guestfs(3)>."
17196 #: ../src/guestfs-actions.pod:6474
17197 msgid "guestfs_setxattr"
17201 #: ../src/guestfs-actions.pod:6476
17205 " guestfs_setxattr (guestfs_h *g,\n"
17206 " const char *xattr,\n"
17207 " const char *val,\n"
17209 " const char *path);\n"
17214 #: ../src/guestfs-actions.pod:6483 ../fish/guestfish-actions.pod:4310
17216 "This call sets the extended attribute named C<xattr> of the file C<path> to "
17217 "the value C<val> (of length C<vallen>). The value is arbitrary 8 bit data."
17221 #: ../src/guestfs-actions.pod:6487
17222 msgid "See also: C<guestfs_lsetxattr>, L<attr(5)>."
17226 #: ../src/guestfs-actions.pod:6493
17227 msgid "guestfs_sfdisk"
17231 #: ../src/guestfs-actions.pod:6495
17235 " guestfs_sfdisk (guestfs_h *g,\n"
17236 " const char *device,\n"
17240 " char *const *lines);\n"
17245 #: ../src/guestfs-actions.pod:6503 ../fish/guestfish-actions.pod:4320
17247 "This is a direct interface to the L<sfdisk(8)> program for creating "
17248 "partitions on block devices."
17252 #: ../src/guestfs-actions.pod:6506 ../fish/guestfish-actions.pod:4323
17253 msgid "C<device> should be a block device, for example C</dev/sda>."
17257 #: ../src/guestfs-actions.pod:6508 ../fish/guestfish-actions.pod:4325
17259 "C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads and "
17260 "sectors on the device, which are passed directly to sfdisk as the I<-C>, I<-"
17261 "H> and I<-S> parameters. If you pass C<0> for any of these, then the "
17262 "corresponding parameter is omitted. Usually for 'large' disks, you can just "
17263 "pass C<0> for these, but for small (floppy-sized) disks, sfdisk (or rather, "
17264 "the kernel) cannot work out the right geometry and you will need to tell it."
17268 #: ../src/guestfs-actions.pod:6516 ../fish/guestfish-actions.pod:4333
17270 "C<lines> is a list of lines that we feed to C<sfdisk>. For more information "
17271 "refer to the L<sfdisk(8)> manpage."
17275 #: ../src/guestfs-actions.pod:6519 ../fish/guestfish-actions.pod:4336
17277 "To create a single partition occupying the whole disk, you would pass "
17278 "C<lines> as a single element list, when the single element being the string "
17283 #: ../src/guestfs-actions.pod:6523
17285 "See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>, C<guestfs_part_init>"
17289 #: ../src/guestfs-actions.pod:6531 ../src/guestfs-actions.pod:6561
17290 #: ../src/guestfs-actions.pod:6594 ../fish/guestfish-actions.pod:4346
17291 #: ../fish/guestfish-actions.pod:4369 ../fish/guestfish-actions.pod:4391
17293 "This function is deprecated. In new code, use the C<part_add> call instead."
17297 #: ../src/guestfs-actions.pod:6540
17298 msgid "guestfs_sfdiskM"
17302 #: ../src/guestfs-actions.pod:6542
17306 " guestfs_sfdiskM (guestfs_h *g,\n"
17307 " const char *device,\n"
17308 " char *const *lines);\n"
17313 #: ../src/guestfs-actions.pod:6547
17315 "This is a simplified interface to the C<guestfs_sfdisk> command, where "
17316 "partition sizes are specified in megabytes only (rounded to the nearest "
17317 "cylinder) and you don't need to specify the cyls, heads and sectors "
17318 "parameters which were rarely if ever used anyway."
17322 #: ../src/guestfs-actions.pod:6553
17324 "See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage and "
17325 "C<guestfs_part_disk>"
17329 #: ../src/guestfs-actions.pod:6570
17330 msgid "guestfs_sfdisk_N"
17334 #: ../src/guestfs-actions.pod:6572
17338 " guestfs_sfdisk_N (guestfs_h *g,\n"
17339 " const char *device,\n"
17344 " const char *line);\n"
17349 #: ../src/guestfs-actions.pod:6581 ../fish/guestfish-actions.pod:4380
17351 "This runs L<sfdisk(8)> option to modify just the single partition C<n> "
17352 "(note: C<n> counts from 1)."
17356 #: ../src/guestfs-actions.pod:6584
17358 "For other parameters, see C<guestfs_sfdisk>. You should usually pass C<0> "
17359 "for the cyls/heads/sectors parameters."
17363 #: ../src/guestfs-actions.pod:6587
17364 msgid "See also: C<guestfs_part_add>"
17368 #: ../src/guestfs-actions.pod:6603
17369 msgid "guestfs_sfdisk_disk_geometry"
17373 #: ../src/guestfs-actions.pod:6605
17377 " guestfs_sfdisk_disk_geometry (guestfs_h *g,\n"
17378 " const char *device);\n"
17383 #: ../src/guestfs-actions.pod:6609
17385 "This displays the disk geometry of C<device> read from the partition table. "
17386 "Especially in the case where the underlying block device has been resized, "
17387 "this can be different from the kernel's idea of the geometry (see "
17388 "C<guestfs_sfdisk_kernel_geometry>)."
17392 #: ../src/guestfs-actions.pod:6614 ../src/guestfs-actions.pod:6630
17393 #: ../fish/guestfish-actions.pod:4407 ../fish/guestfish-actions.pod:4416
17394 msgid "The result is in human-readable format, and not designed to be parsed."
17398 #: ../src/guestfs-actions.pod:6622
17399 msgid "guestfs_sfdisk_kernel_geometry"
17403 #: ../src/guestfs-actions.pod:6624
17407 " guestfs_sfdisk_kernel_geometry (guestfs_h *g,\n"
17408 " const char *device);\n"
17413 #: ../src/guestfs-actions.pod:6628 ../fish/guestfish-actions.pod:4414
17414 msgid "This displays the kernel's idea of the geometry of C<device>."
17418 #: ../src/guestfs-actions.pod:6638
17419 msgid "guestfs_sfdisk_l"
17423 #: ../src/guestfs-actions.pod:6640
17427 " guestfs_sfdisk_l (guestfs_h *g,\n"
17428 " const char *device);\n"
17433 #: ../src/guestfs-actions.pod:6644 ../fish/guestfish-actions.pod:4423
17435 "This displays the partition table on C<device>, in the human-readable output "
17436 "of the L<sfdisk(8)> command. It is not intended to be parsed."
17440 #: ../src/guestfs-actions.pod:6648
17441 msgid "See also: C<guestfs_part_list>"
17445 #: ../src/guestfs-actions.pod:6653 ../fish/guestfish-actions.pod:4429
17447 "This function is deprecated. In new code, use the C<part_list> call instead."
17451 #: ../src/guestfs-actions.pod:6662
17456 #: ../src/guestfs-actions.pod:6664
17460 " guestfs_sh (guestfs_h *g,\n"
17461 " const char *command);\n"
17466 #: ../src/guestfs-actions.pod:6668 ../fish/guestfish-actions.pod:4440
17468 "This call runs a command from the guest filesystem via the guest's C</bin/"
17473 #: ../src/guestfs-actions.pod:6671
17474 msgid "This is like C<guestfs_command>, but passes the command to:"
17478 #: ../src/guestfs-actions.pod:6673 ../fish/guestfish-actions.pod:4445
17481 " /bin/sh -c \"command\"\n"
17486 #: ../src/guestfs-actions.pod:6675 ../fish/guestfish-actions.pod:4447
17488 "Depending on the guest's shell, this usually results in wildcards being "
17489 "expanded, shell expressions being interpolated and so on."
17493 #: ../src/guestfs-actions.pod:6679
17494 msgid "All the provisos about C<guestfs_command> apply to this call."
17498 #: ../src/guestfs-actions.pod:6686
17499 msgid "guestfs_sh_lines"
17503 #: ../src/guestfs-actions.pod:6688
17507 " guestfs_sh_lines (guestfs_h *g,\n"
17508 " const char *command);\n"
17513 #: ../src/guestfs-actions.pod:6692
17515 "This is the same as C<guestfs_sh>, but splits the result into a list of "
17520 #: ../src/guestfs-actions.pod:6695
17521 msgid "See also: C<guestfs_command_lines>"
17525 #: ../src/guestfs-actions.pod:6703
17526 msgid "guestfs_sleep"
17530 #: ../src/guestfs-actions.pod:6705
17534 " guestfs_sleep (guestfs_h *g,\n"
17540 #: ../src/guestfs-actions.pod:6709 ../fish/guestfish-actions.pod:4466
17541 msgid "Sleep for C<secs> seconds."
17545 #: ../src/guestfs-actions.pod:6713
17546 msgid "(Added in 1.0.41)"
17550 #: ../src/guestfs-actions.pod:6715 ../src/guestfs-structs.pod:109
17551 msgid "guestfs_stat"
17555 #: ../src/guestfs-actions.pod:6717
17558 " struct guestfs_stat *\n"
17559 " guestfs_stat (guestfs_h *g,\n"
17560 " const char *path);\n"
17565 #: ../src/guestfs-actions.pod:6723 ../fish/guestfish-actions.pod:4474
17566 msgid "This is the same as the C<stat(2)> system call."
17570 #: ../src/guestfs-actions.pod:6731 ../src/guestfs-structs.pod:135
17571 msgid "guestfs_statvfs"
17575 #: ../src/guestfs-actions.pod:6733
17578 " struct guestfs_statvfs *\n"
17579 " guestfs_statvfs (guestfs_h *g,\n"
17580 " const char *path);\n"
17585 #: ../src/guestfs-actions.pod:6737 ../fish/guestfish-actions.pod:4480
17587 "Returns file system statistics for any mounted file system. C<path> should "
17588 "be a file or directory in the mounted file system (typically it is the mount "
17589 "point itself, but it doesn't need to be)."
17593 #: ../src/guestfs-actions.pod:6741 ../fish/guestfish-actions.pod:4484
17594 msgid "This is the same as the C<statvfs(2)> system call."
17598 #: ../src/guestfs-actions.pod:6743
17600 "This function returns a C<struct guestfs_statvfs *>, or NULL if there was an "
17601 "error. I<The caller must call C<guestfs_free_statvfs> after use>."
17605 #: ../src/guestfs-actions.pod:6749
17606 msgid "guestfs_strings"
17610 #: ../src/guestfs-actions.pod:6751
17614 " guestfs_strings (guestfs_h *g,\n"
17615 " const char *path);\n"
17620 #: ../src/guestfs-actions.pod:6755 ../fish/guestfish-actions.pod:4490
17622 "This runs the L<strings(1)> command on a file and returns the list of "
17623 "printable strings found."
17627 #: ../src/guestfs-actions.pod:6767
17628 msgid "guestfs_strings_e"
17632 #: ../src/guestfs-actions.pod:6769
17636 " guestfs_strings_e (guestfs_h *g,\n"
17637 " const char *encoding,\n"
17638 " const char *path);\n"
17643 #: ../src/guestfs-actions.pod:6774
17645 "This is like the C<guestfs_strings> command, but allows you to specify the "
17646 "encoding of strings that are looked for in the source file C<path>."
17650 #: ../src/guestfs-actions.pod:6778 ../fish/guestfish-actions.pod:4504
17651 msgid "Allowed encodings are:"
17655 #: ../src/guestfs-actions.pod:6782 ../fish/guestfish-actions.pod:4508
17660 #: ../src/guestfs-actions.pod:6784
17662 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
17663 "ISO-8859-X (this is what C<guestfs_strings> uses)."
17667 #: ../src/guestfs-actions.pod:6787 ../fish/guestfish-actions.pod:4513
17672 #: ../src/guestfs-actions.pod:6789 ../fish/guestfish-actions.pod:4515
17673 msgid "Single 8-bit-byte characters."
17677 #: ../src/guestfs-actions.pod:6791 ../fish/guestfish-actions.pod:4517
17682 #: ../src/guestfs-actions.pod:6793 ../fish/guestfish-actions.pod:4519
17683 msgid "16-bit big endian strings such as those encoded in UTF-16BE or UCS-2BE."
17687 #: ../src/guestfs-actions.pod:6796 ../fish/guestfish-actions.pod:4522
17688 msgid "l (lower case letter L)"
17692 #: ../src/guestfs-actions.pod:6798 ../fish/guestfish-actions.pod:4524
17694 "16-bit little endian such as UTF-16LE and UCS-2LE. This is useful for "
17695 "examining binaries in Windows guests."
17699 #: ../src/guestfs-actions.pod:6801 ../fish/guestfish-actions.pod:4527
17704 #: ../src/guestfs-actions.pod:6803 ../fish/guestfish-actions.pod:4529
17705 msgid "32-bit big endian such as UCS-4BE."
17709 #: ../src/guestfs-actions.pod:6805 ../fish/guestfish-actions.pod:4531
17714 #: ../src/guestfs-actions.pod:6807 ../fish/guestfish-actions.pod:4533
17715 msgid "32-bit little endian such as UCS-4LE."
17719 #: ../src/guestfs-actions.pod:6811 ../fish/guestfish-actions.pod:4537
17720 msgid "The returned strings are transcoded to UTF-8."
17724 #: ../src/guestfs-actions.pod:6822
17725 msgid "guestfs_swapoff_device"
17729 #: ../src/guestfs-actions.pod:6824
17733 " guestfs_swapoff_device (guestfs_h *g,\n"
17734 " const char *device);\n"
17739 #: ../src/guestfs-actions.pod:6828
17741 "This command disables the libguestfs appliance swap device or partition "
17742 "named C<device>. See C<guestfs_swapon_device>."
17746 #: ../src/guestfs-actions.pod:6836
17747 msgid "guestfs_swapoff_file"
17751 #: ../src/guestfs-actions.pod:6838
17755 " guestfs_swapoff_file (guestfs_h *g,\n"
17756 " const char *file);\n"
17761 #: ../src/guestfs-actions.pod:6842 ../fish/guestfish-actions.pod:4554
17762 msgid "This command disables the libguestfs appliance swap on file."
17766 #: ../src/guestfs-actions.pod:6848
17767 msgid "guestfs_swapoff_label"
17771 #: ../src/guestfs-actions.pod:6850
17775 " guestfs_swapoff_label (guestfs_h *g,\n"
17776 " const char *label);\n"
17781 #: ../src/guestfs-actions.pod:6854 ../fish/guestfish-actions.pod:4560
17783 "This command disables the libguestfs appliance swap on labeled swap "
17788 #: ../src/guestfs-actions.pod:6861
17789 msgid "guestfs_swapoff_uuid"
17793 #: ../src/guestfs-actions.pod:6863
17797 " guestfs_swapoff_uuid (guestfs_h *g,\n"
17798 " const char *uuid);\n"
17803 #: ../src/guestfs-actions.pod:6867 ../fish/guestfish-actions.pod:4567
17805 "This command disables the libguestfs appliance swap partition with the given "
17810 #: ../src/guestfs-actions.pod:6874
17811 msgid "guestfs_swapon_device"
17815 #: ../src/guestfs-actions.pod:6876
17819 " guestfs_swapon_device (guestfs_h *g,\n"
17820 " const char *device);\n"
17825 #: ../src/guestfs-actions.pod:6880
17827 "This command enables the libguestfs appliance to use the swap device or "
17828 "partition named C<device>. The increased memory is made available for all "
17829 "commands, for example those run using C<guestfs_command> or C<guestfs_sh>."
17833 #: ../src/guestfs-actions.pod:6885 ../fish/guestfish-actions.pod:4579
17835 "Note that you should not swap to existing guest swap partitions unless you "
17836 "know what you are doing. They may contain hibernation information, or other "
17837 "information that the guest doesn't want you to trash. You also risk leaking "
17838 "information about the host to the guest this way. Instead, attach a new "
17839 "host device to the guest and swap on that."
17843 #: ../src/guestfs-actions.pod:6896
17844 msgid "guestfs_swapon_file"
17848 #: ../src/guestfs-actions.pod:6898
17852 " guestfs_swapon_file (guestfs_h *g,\n"
17853 " const char *file);\n"
17858 #: ../src/guestfs-actions.pod:6902
17860 "This command enables swap to a file. See C<guestfs_swapon_device> for other "
17865 #: ../src/guestfs-actions.pod:6909
17866 msgid "guestfs_swapon_label"
17870 #: ../src/guestfs-actions.pod:6911
17874 " guestfs_swapon_label (guestfs_h *g,\n"
17875 " const char *label);\n"
17880 #: ../src/guestfs-actions.pod:6915
17882 "This command enables swap to a labeled swap partition. See "
17883 "C<guestfs_swapon_device> for other notes."
17887 #: ../src/guestfs-actions.pod:6922
17888 msgid "guestfs_swapon_uuid"
17892 #: ../src/guestfs-actions.pod:6924
17896 " guestfs_swapon_uuid (guestfs_h *g,\n"
17897 " const char *uuid);\n"
17902 #: ../src/guestfs-actions.pod:6928
17904 "This command enables swap to a swap partition with the given UUID. See "
17905 "C<guestfs_swapon_device> for other notes."
17909 #: ../src/guestfs-actions.pod:6935
17910 msgid "guestfs_sync"
17914 #: ../src/guestfs-actions.pod:6937
17918 " guestfs_sync (guestfs_h *g);\n"
17923 #: ../src/guestfs-actions.pod:6940 ../fish/guestfish-actions.pod:4611
17925 "This syncs the disk, so that any writes are flushed through to the "
17926 "underlying disk image."
17930 #: ../src/guestfs-actions.pod:6943 ../fish/guestfish-actions.pod:4614
17932 "You should always call this if you have modified a disk image, before "
17933 "closing the handle."
17937 #: ../src/guestfs-actions.pod:6950
17938 msgid "guestfs_tail"
17942 #: ../src/guestfs-actions.pod:6952
17946 " guestfs_tail (guestfs_h *g,\n"
17947 " const char *path);\n"
17952 #: ../src/guestfs-actions.pod:6956 ../fish/guestfish-actions.pod:4621
17954 "This command returns up to the last 10 lines of a file as a list of strings."
17958 #: ../src/guestfs-actions.pod:6968
17959 msgid "guestfs_tail_n"
17963 #: ../src/guestfs-actions.pod:6970
17967 " guestfs_tail_n (guestfs_h *g,\n"
17969 " const char *path);\n"
17974 #: ../src/guestfs-actions.pod:6975 ../fish/guestfish-actions.pod:4631
17976 "If the parameter C<nrlines> is a positive number, this returns the last "
17977 "C<nrlines> lines of the file C<path>."
17981 #: ../src/guestfs-actions.pod:6978 ../fish/guestfish-actions.pod:4634
17983 "If the parameter C<nrlines> is a negative number, this returns lines from "
17984 "the file C<path>, starting with the C<-nrlines>th line."
17988 #: ../src/guestfs-actions.pod:6992
17989 msgid "guestfs_tar_in"
17993 #: ../src/guestfs-actions.pod:6994
17997 " guestfs_tar_in (guestfs_h *g,\n"
17998 " const char *tarfile,\n"
17999 " const char *directory);\n"
18004 #: ../src/guestfs-actions.pod:6999 ../fish/guestfish-actions.pod:4646
18006 "This command uploads and unpacks local file C<tarfile> (an I<uncompressed> "
18007 "tar file) into C<directory>."
18011 #: ../src/guestfs-actions.pod:7002
18013 "To upload a compressed tarball, use C<guestfs_tgz_in> or C<guestfs_txz_in>."
18017 #: ../src/guestfs-actions.pod:7007 ../src/guestfs-actions.pod:7024
18018 #: ../src/guestfs-actions.pod:7040 ../src/guestfs-actions.pod:7056
18019 msgid "(Added in 1.0.3)"
18023 #: ../src/guestfs-actions.pod:7009
18024 msgid "guestfs_tar_out"
18028 #: ../src/guestfs-actions.pod:7011
18032 " guestfs_tar_out (guestfs_h *g,\n"
18033 " const char *directory,\n"
18034 " const char *tarfile);\n"
18039 #: ../src/guestfs-actions.pod:7016 ../fish/guestfish-actions.pod:4658
18041 "This command packs the contents of C<directory> and downloads it to local "
18046 #: ../src/guestfs-actions.pod:7019
18048 "To download a compressed tarball, use C<guestfs_tgz_out> or "
18049 "C<guestfs_txz_out>."
18053 #: ../src/guestfs-actions.pod:7026
18054 msgid "guestfs_tgz_in"
18058 #: ../src/guestfs-actions.pod:7028
18062 " guestfs_tgz_in (guestfs_h *g,\n"
18063 " const char *tarball,\n"
18064 " const char *directory);\n"
18069 #: ../src/guestfs-actions.pod:7033 ../fish/guestfish-actions.pod:4670
18071 "This command uploads and unpacks local file C<tarball> (a I<gzip compressed> "
18072 "tar file) into C<directory>."
18076 #: ../src/guestfs-actions.pod:7036
18077 msgid "To upload an uncompressed tarball, use C<guestfs_tar_in>."
18081 #: ../src/guestfs-actions.pod:7042
18082 msgid "guestfs_tgz_out"
18086 #: ../src/guestfs-actions.pod:7044
18090 " guestfs_tgz_out (guestfs_h *g,\n"
18091 " const char *directory,\n"
18092 " const char *tarball);\n"
18097 #: ../src/guestfs-actions.pod:7049 ../fish/guestfish-actions.pod:4681
18099 "This command packs the contents of C<directory> and downloads it to local "
18104 #: ../src/guestfs-actions.pod:7052
18105 msgid "To download an uncompressed tarball, use C<guestfs_tar_out>."
18109 #: ../src/guestfs-actions.pod:7058
18110 msgid "guestfs_touch"
18114 #: ../src/guestfs-actions.pod:7060
18118 " guestfs_touch (guestfs_h *g,\n"
18119 " const char *path);\n"
18124 #: ../src/guestfs-actions.pod:7064 ../fish/guestfish-actions.pod:4692
18126 "Touch acts like the L<touch(1)> command. It can be used to update the "
18127 "timestamps on a file, or, if the file does not exist, to create a new zero-"
18132 #: ../src/guestfs-actions.pod:7068 ../fish/guestfish-actions.pod:4696
18134 "This command only works on regular files, and will fail on other file types "
18135 "such as directories, symbolic links, block special etc."
18139 #: ../src/guestfs-actions.pod:7075
18140 msgid "guestfs_truncate"
18144 #: ../src/guestfs-actions.pod:7077
18148 " guestfs_truncate (guestfs_h *g,\n"
18149 " const char *path);\n"
18154 #: ../src/guestfs-actions.pod:7081 ../fish/guestfish-actions.pod:4703
18156 "This command truncates C<path> to a zero-length file. The file must exist "
18161 #: ../src/guestfs-actions.pod:7088
18162 msgid "guestfs_truncate_size"
18166 #: ../src/guestfs-actions.pod:7090
18170 " guestfs_truncate_size (guestfs_h *g,\n"
18171 " const char *path,\n"
18172 " int64_t size);\n"
18177 #: ../src/guestfs-actions.pod:7095 ../fish/guestfish-actions.pod:4710
18179 "This command truncates C<path> to size C<size> bytes. The file must exist "
18184 #: ../src/guestfs-actions.pod:7098
18186 "If the current file size is less than C<size> then the file is extended to "
18187 "the required size with zero bytes. This creates a sparse file (ie. disk "
18188 "blocks are not allocated for the file until you write to it). To create a "
18189 "non-sparse file of zeroes, use C<guestfs_fallocate64> instead."
18193 #: ../src/guestfs-actions.pod:7108
18194 msgid "guestfs_tune2fs_l"
18198 #: ../src/guestfs-actions.pod:7110
18202 " guestfs_tune2fs_l (guestfs_h *g,\n"
18203 " const char *device);\n"
18208 #: ../src/guestfs-actions.pod:7114 ../fish/guestfish-actions.pod:4723
18210 "This returns the contents of the ext2, ext3 or ext4 filesystem superblock on "
18215 #: ../src/guestfs-actions.pod:7117 ../fish/guestfish-actions.pod:4726
18217 "It is the same as running C<tune2fs -l device>. See L<tune2fs(8)> manpage "
18218 "for more details. The list of fields returned isn't clearly defined, and "
18219 "depends on both the version of C<tune2fs> that libguestfs was built against, "
18220 "and the filesystem itself."
18224 #: ../src/guestfs-actions.pod:7130
18225 msgid "guestfs_txz_in"
18229 #: ../src/guestfs-actions.pod:7132
18233 " guestfs_txz_in (guestfs_h *g,\n"
18234 " const char *tarball,\n"
18235 " const char *directory);\n"
18240 #: ../src/guestfs-actions.pod:7137 ../fish/guestfish-actions.pod:4735
18242 "This command uploads and unpacks local file C<tarball> (an I<xz compressed> "
18243 "tar file) into C<directory>."
18247 #: ../src/guestfs-actions.pod:7144
18248 msgid "guestfs_txz_out"
18252 #: ../src/guestfs-actions.pod:7146
18256 " guestfs_txz_out (guestfs_h *g,\n"
18257 " const char *directory,\n"
18258 " const char *tarball);\n"
18263 #: ../src/guestfs-actions.pod:7151 ../fish/guestfish-actions.pod:4744
18265 "This command packs the contents of C<directory> and downloads it to local "
18266 "file C<tarball> (as an xz compressed tar archive)."
18270 #: ../src/guestfs-actions.pod:7158
18271 msgid "guestfs_umask"
18275 #: ../src/guestfs-actions.pod:7160
18279 " guestfs_umask (guestfs_h *g,\n"
18285 #: ../src/guestfs-actions.pod:7164 ../fish/guestfish-actions.pod:4753
18287 "This function sets the mask used for creating new files and device nodes to "
18292 #: ../src/guestfs-actions.pod:7167 ../fish/guestfish-actions.pod:4756
18294 "Typical umask values would be C<022> which creates new files with "
18295 "permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and C<002> which creates "
18296 "new files with permissions like \"-rw-rw-r--\" or \"-rwxrwxr-x\"."
18300 #: ../src/guestfs-actions.pod:7172 ../fish/guestfish-actions.pod:4761
18302 "The default umask is C<022>. This is important because it means that "
18303 "directories and device nodes will be created with C<0644> or C<0755> mode "
18304 "even if you specify C<0777>."
18308 #: ../src/guestfs-actions.pod:7176
18310 "See also C<guestfs_get_umask>, L<umask(2)>, C<guestfs_mknod>, "
18311 "C<guestfs_mkdir>."
18315 #: ../src/guestfs-actions.pod:7179 ../fish/guestfish-actions.pod:4768
18316 msgid "This call returns the previous umask."
18320 #: ../src/guestfs-actions.pod:7185
18321 msgid "guestfs_umount"
18325 #: ../src/guestfs-actions.pod:7187
18329 " guestfs_umount (guestfs_h *g,\n"
18330 " const char *pathordevice);\n"
18335 #: ../src/guestfs-actions.pod:7191 ../fish/guestfish-actions.pod:4776
18337 "This unmounts the given filesystem. The filesystem may be specified either "
18338 "by its mountpoint (path) or the device which contains the filesystem."
18342 #: ../src/guestfs-actions.pod:7199
18343 msgid "guestfs_umount_all"
18347 #: ../src/guestfs-actions.pod:7201
18351 " guestfs_umount_all (guestfs_h *g);\n"
18356 #: ../src/guestfs-actions.pod:7204 ../fish/guestfish-actions.pod:4786
18357 msgid "This unmounts all mounted filesystems."
18361 #: ../src/guestfs-actions.pod:7206 ../fish/guestfish-actions.pod:4788
18362 msgid "Some internal mounts are not unmounted by this call."
18366 #: ../src/guestfs-actions.pod:7212
18367 msgid "guestfs_upload"
18371 #: ../src/guestfs-actions.pod:7214
18375 " guestfs_upload (guestfs_h *g,\n"
18376 " const char *filename,\n"
18377 " const char *remotefilename);\n"
18382 #: ../src/guestfs-actions.pod:7219 ../src/guestfs-actions.pod:7243
18383 #: ../fish/guestfish-actions.pod:4794 ../fish/guestfish-actions.pod:4807
18384 msgid "Upload local file C<filename> to C<remotefilename> on the filesystem."
18388 #: ../src/guestfs-actions.pod:7224
18389 msgid "See also C<guestfs_download>."
18393 #: ../src/guestfs-actions.pod:7235
18394 msgid "guestfs_upload_offset"
18398 #: ../src/guestfs-actions.pod:7237
18402 " guestfs_upload_offset (guestfs_h *g,\n"
18403 " const char *filename,\n"
18404 " const char *remotefilename,\n"
18405 " int64_t offset);\n"
18410 #: ../src/guestfs-actions.pod:7246 ../fish/guestfish-actions.pod:4810
18412 "C<remotefilename> is overwritten starting at the byte C<offset> specified. "
18413 "The intention is to overwrite parts of existing files or devices, although "
18414 "if a non-existant file is specified then it is created with a \"hole\" "
18415 "before C<offset>. The size of the data written is implicit in the size of "
18416 "the source C<filename>."
18420 #: ../src/guestfs-actions.pod:7253
18422 "Note that there is no limit on the amount of data that can be uploaded with "
18423 "this call, unlike with C<guestfs_pwrite>, and this call always writes the "
18424 "full amount unless an error occurs."
18428 #: ../src/guestfs-actions.pod:7258
18429 msgid "See also C<guestfs_upload>, C<guestfs_pwrite>."
18433 #: ../src/guestfs-actions.pod:7269
18434 msgid "guestfs_utimens"
18438 #: ../src/guestfs-actions.pod:7271
18442 " guestfs_utimens (guestfs_h *g,\n"
18443 " const char *path,\n"
18444 " int64_t atsecs,\n"
18445 " int64_t atnsecs,\n"
18446 " int64_t mtsecs,\n"
18447 " int64_t mtnsecs);\n"
18452 #: ../src/guestfs-actions.pod:7279 ../fish/guestfish-actions.pod:4830
18453 msgid "This command sets the timestamps of a file with nanosecond precision."
18457 #: ../src/guestfs-actions.pod:7282 ../fish/guestfish-actions.pod:4833
18459 "C<atsecs, atnsecs> are the last access time (atime) in secs and nanoseconds "
18464 #: ../src/guestfs-actions.pod:7285 ../fish/guestfish-actions.pod:4836
18466 "C<mtsecs, mtnsecs> are the last modification time (mtime) in secs and "
18467 "nanoseconds from the epoch."
18471 #: ../src/guestfs-actions.pod:7288 ../fish/guestfish-actions.pod:4839
18473 "If the C<*nsecs> field contains the special value C<-1> then the "
18474 "corresponding timestamp is set to the current time. (The C<*secs> field is "
18475 "ignored in this case)."
18479 #: ../src/guestfs-actions.pod:7292 ../fish/guestfish-actions.pod:4843
18481 "If the C<*nsecs> field contains the special value C<-2> then the "
18482 "corresponding timestamp is left unchanged. (The C<*secs> field is ignored "
18487 #: ../src/guestfs-actions.pod:7300 ../src/guestfs-structs.pod:175
18488 msgid "guestfs_version"
18492 #: ../src/guestfs-actions.pod:7302
18495 " struct guestfs_version *\n"
18496 " guestfs_version (guestfs_h *g);\n"
18501 #: ../src/guestfs-actions.pod:7305 ../fish/guestfish-actions.pod:4851
18503 "Return the libguestfs version number that the program is linked against."
18507 #: ../src/guestfs-actions.pod:7308 ../fish/guestfish-actions.pod:4854
18509 "Note that because of dynamic linking this is not necessarily the version of "
18510 "libguestfs that you compiled against. You can compile the program, and then "
18511 "at runtime dynamically link against a completely different C<libguestfs.so> "
18516 #: ../src/guestfs-actions.pod:7313 ../fish/guestfish-actions.pod:4859
18518 "This call was added in version C<1.0.58>. In previous versions of "
18519 "libguestfs there was no way to get the version number. From C code you can "
18520 "use dynamic linker functions to find out if this symbol exists (if it "
18521 "doesn't, then it's an earlier version)."
18525 #: ../src/guestfs-actions.pod:7319 ../fish/guestfish-actions.pod:4865
18527 "The call returns a structure with four elements. The first three (C<major>, "
18528 "C<minor> and C<release>) are numbers and correspond to the usual version "
18529 "triplet. The fourth element (C<extra>) is a string and is normally empty, "
18530 "but may be used for distro-specific information."
18534 #: ../src/guestfs-actions.pod:7325 ../fish/guestfish-actions.pod:4871
18536 "To construct the original version string: C<$major.$minor.$release$extra>"
18540 #: ../src/guestfs-actions.pod:7328 ../fish/guestfish-actions.pod:4874
18541 msgid "See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>."
18545 #: ../src/guestfs-actions.pod:7330
18547 "I<Note:> Don't use this call to test for availability of features. In "
18548 "enterprise distributions we backport features from later versions into "
18549 "earlier versions, making this an unreliable way to test for features. Use "
18550 "C<guestfs_available> instead."
18554 #: ../src/guestfs-actions.pod:7336
18556 "This function returns a C<struct guestfs_version *>, or NULL if there was an "
18557 "error. I<The caller must call C<guestfs_free_version> after use>."
18561 #: ../src/guestfs-actions.pod:7340
18562 msgid "(Added in 1.0.58)"
18566 #: ../src/guestfs-actions.pod:7342
18567 msgid "guestfs_vfs_label"
18571 #: ../src/guestfs-actions.pod:7344
18575 " guestfs_vfs_label (guestfs_h *g,\n"
18576 " const char *device);\n"
18581 #: ../src/guestfs-actions.pod:7348 ../fish/guestfish-actions.pod:4886
18582 msgid "This returns the filesystem label of the filesystem on C<device>."
18586 #: ../src/guestfs-actions.pod:7351 ../fish/guestfish-actions.pod:4889
18587 msgid "If the filesystem is unlabeled, this returns the empty string."
18591 #: ../src/guestfs-actions.pod:7353
18592 msgid "To find a filesystem from the label, use C<guestfs_findfs_label>."
18596 #: ../src/guestfs-actions.pod:7358 ../src/guestfs-actions.pod:7395
18597 msgid "(Added in 1.3.18)"
18601 #: ../src/guestfs-actions.pod:7360
18602 msgid "guestfs_vfs_type"
18606 #: ../src/guestfs-actions.pod:7362
18610 " guestfs_vfs_type (guestfs_h *g,\n"
18611 " const char *device);\n"
18616 #: ../src/guestfs-actions.pod:7366 ../fish/guestfish-actions.pod:4897
18618 "This command gets the filesystem type corresponding to the filesystem on "
18623 #: ../src/guestfs-actions.pod:7369 ../fish/guestfish-actions.pod:4900
18625 "For most filesystems, the result is the name of the Linux VFS module which "
18626 "would be used to mount this filesystem if you mounted it without specifying "
18627 "the filesystem type. For example a string such as C<ext3> or C<ntfs>."
18631 #: ../src/guestfs-actions.pod:7379
18632 msgid "guestfs_vfs_uuid"
18636 #: ../src/guestfs-actions.pod:7381
18640 " guestfs_vfs_uuid (guestfs_h *g,\n"
18641 " const char *device);\n"
18646 #: ../src/guestfs-actions.pod:7385 ../fish/guestfish-actions.pod:4909
18647 msgid "This returns the filesystem UUID of the filesystem on C<device>."
18651 #: ../src/guestfs-actions.pod:7388 ../fish/guestfish-actions.pod:4912
18652 msgid "If the filesystem does not have a UUID, this returns the empty string."
18656 #: ../src/guestfs-actions.pod:7390
18657 msgid "To find a filesystem from the UUID, use C<guestfs_findfs_uuid>."
18661 #: ../src/guestfs-actions.pod:7397
18662 msgid "guestfs_vg_activate"
18666 #: ../src/guestfs-actions.pod:7399
18670 " guestfs_vg_activate (guestfs_h *g,\n"
18672 " char *const *volgroups);\n"
18677 #: ../src/guestfs-actions.pod:7404 ../fish/guestfish-actions.pod:4920
18679 "This command activates or (if C<activate> is false) deactivates all logical "
18680 "volumes in the listed volume groups C<volgroups>."
18684 #: ../src/guestfs-actions.pod:7407 ../fish/guestfish-actions.pod:4923
18685 msgid "This command is the same as running C<vgchange -a y|n volgroups...>"
18689 #: ../src/guestfs-actions.pod:7409 ../fish/guestfish-actions.pod:4925
18691 "Note that if C<volgroups> is an empty list then B<all> volume groups are "
18692 "activated or deactivated."
18696 #: ../src/guestfs-actions.pod:7416
18697 msgid "guestfs_vg_activate_all"
18701 #: ../src/guestfs-actions.pod:7418
18705 " guestfs_vg_activate_all (guestfs_h *g,\n"
18706 " int activate);\n"
18711 #: ../src/guestfs-actions.pod:7422 ../fish/guestfish-actions.pod:4932
18713 "This command activates or (if C<activate> is false) deactivates all logical "
18714 "volumes in all volume groups."
18718 #: ../src/guestfs-actions.pod:7425 ../fish/guestfish-actions.pod:4935
18719 msgid "This command is the same as running C<vgchange -a y|n>"
18723 #: ../src/guestfs-actions.pod:7431
18724 msgid "guestfs_vgcreate"
18728 #: ../src/guestfs-actions.pod:7433
18732 " guestfs_vgcreate (guestfs_h *g,\n"
18733 " const char *volgroup,\n"
18734 " char *const *physvols);\n"
18739 #: ../src/guestfs-actions.pod:7438 ../fish/guestfish-actions.pod:4941
18741 "This creates an LVM volume group called C<volgroup> from the non-empty list "
18742 "of physical volumes C<physvols>."
18746 #: ../src/guestfs-actions.pod:7445
18747 msgid "guestfs_vglvuuids"
18751 #: ../src/guestfs-actions.pod:7447
18755 " guestfs_vglvuuids (guestfs_h *g,\n"
18756 " const char *vgname);\n"
18761 #: ../src/guestfs-actions.pod:7451 ../fish/guestfish-actions.pod:4948
18763 "Given a VG called C<vgname>, this returns the UUIDs of all the logical "
18764 "volumes created in this volume group."
18768 #: ../src/guestfs-actions.pod:7454
18770 "You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid> calls to "
18771 "associate logical volumes and volume groups."
18775 #: ../src/guestfs-actions.pod:7457
18776 msgid "See also C<guestfs_vgpvuuids>."
18780 #: ../src/guestfs-actions.pod:7465
18781 msgid "guestfs_vgpvuuids"
18785 #: ../src/guestfs-actions.pod:7467
18789 " guestfs_vgpvuuids (guestfs_h *g,\n"
18790 " const char *vgname);\n"
18795 #: ../src/guestfs-actions.pod:7471 ../fish/guestfish-actions.pod:4960
18797 "Given a VG called C<vgname>, this returns the UUIDs of all the physical "
18798 "volumes that this volume group resides on."
18802 #: ../src/guestfs-actions.pod:7474
18804 "You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid> calls to "
18805 "associate physical volumes and volume groups."
18809 #: ../src/guestfs-actions.pod:7477
18810 msgid "See also C<guestfs_vglvuuids>."
18814 #: ../src/guestfs-actions.pod:7485
18815 msgid "guestfs_vgremove"
18819 #: ../src/guestfs-actions.pod:7487
18823 " guestfs_vgremove (guestfs_h *g,\n"
18824 " const char *vgname);\n"
18829 #: ../src/guestfs-actions.pod:7491 ../fish/guestfish-actions.pod:4972
18830 msgid "Remove an LVM volume group C<vgname>, (for example C<VG>)."
18834 #: ../src/guestfs-actions.pod:7493 ../fish/guestfish-actions.pod:4974
18836 "This also forcibly removes all logical volumes in the volume group (if any)."
18840 #: ../src/guestfs-actions.pod:7500
18841 msgid "guestfs_vgrename"
18845 #: ../src/guestfs-actions.pod:7502
18849 " guestfs_vgrename (guestfs_h *g,\n"
18850 " const char *volgroup,\n"
18851 " const char *newvolgroup);\n"
18856 #: ../src/guestfs-actions.pod:7507 ../fish/guestfish-actions.pod:4981
18857 msgid "Rename a volume group C<volgroup> with the new name C<newvolgroup>."
18861 #: ../src/guestfs-actions.pod:7513
18862 msgid "guestfs_vgs"
18866 #: ../src/guestfs-actions.pod:7515
18870 " guestfs_vgs (guestfs_h *g);\n"
18875 #: ../src/guestfs-actions.pod:7518 ../fish/guestfish-actions.pod:4987
18877 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
18882 #: ../src/guestfs-actions.pod:7521 ../fish/guestfish-actions.pod:4990
18884 "This returns a list of just the volume group names that were detected (eg. "
18889 #: ../src/guestfs-actions.pod:7524
18890 msgid "See also C<guestfs_vgs_full>."
18894 #: ../src/guestfs-actions.pod:7532
18895 msgid "guestfs_vgs_full"
18899 #: ../src/guestfs-actions.pod:7534
18902 " struct guestfs_lvm_vg_list *\n"
18903 " guestfs_vgs_full (guestfs_h *g);\n"
18908 #: ../src/guestfs-actions.pod:7537 ../fish/guestfish-actions.pod:4999
18910 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
18911 "> command. The \"full\" version includes all fields."
18915 #: ../src/guestfs-actions.pod:7540
18917 "This function returns a C<struct guestfs_lvm_vg_list *>, or NULL if there "
18918 "was an error. I<The caller must call C<guestfs_free_lvm_vg_list> after use>."
18922 #: ../src/guestfs-actions.pod:7546
18923 msgid "guestfs_vgscan"
18927 #: ../src/guestfs-actions.pod:7548
18931 " guestfs_vgscan (guestfs_h *g);\n"
18936 #: ../src/guestfs-actions.pod:7551 ../fish/guestfish-actions.pod:5006
18938 "This rescans all block devices and rebuilds the list of LVM physical "
18939 "volumes, volume groups and logical volumes."
18943 #: ../src/guestfs-actions.pod:7558
18944 msgid "guestfs_vguuid"
18948 #: ../src/guestfs-actions.pod:7560
18952 " guestfs_vguuid (guestfs_h *g,\n"
18953 " const char *vgname);\n"
18958 #: ../src/guestfs-actions.pod:7564 ../fish/guestfish-actions.pod:5013
18959 msgid "This command returns the UUID of the LVM VG named C<vgname>."
18963 #: ../src/guestfs-actions.pod:7571
18964 msgid "guestfs_wait_ready"
18968 #: ../src/guestfs-actions.pod:7573
18972 " guestfs_wait_ready (guestfs_h *g);\n"
18977 #: ../src/guestfs-actions.pod:7576
18978 msgid "This function is a no op."
18982 #: ../src/guestfs-actions.pod:7578
18984 "In versions of the API E<lt> 1.0.71 you had to call this function just after "
18985 "calling C<guestfs_launch> to wait for the launch to complete. However this "
18986 "is no longer necessary because C<guestfs_launch> now does the waiting."
18990 #: ../src/guestfs-actions.pod:7583
18992 "If you see any calls to this function in code then you can just remove them, "
18993 "unless you want to retain compatibility with older versions of the API."
18997 #: ../src/guestfs-actions.pod:7589
18999 "This function is deprecated. In new code, use the C<launch> call instead."
19003 #: ../src/guestfs-actions.pod:7598
19004 msgid "guestfs_wc_c"
19008 #: ../src/guestfs-actions.pod:7600
19012 " guestfs_wc_c (guestfs_h *g,\n"
19013 " const char *path);\n"
19018 #: ../src/guestfs-actions.pod:7604 ../fish/guestfish-actions.pod:5019
19020 "This command counts the characters in a file, using the C<wc -c> external "
19025 #: ../src/guestfs-actions.pod:7611
19026 msgid "guestfs_wc_l"
19030 #: ../src/guestfs-actions.pod:7613
19034 " guestfs_wc_l (guestfs_h *g,\n"
19035 " const char *path);\n"
19040 #: ../src/guestfs-actions.pod:7617 ../fish/guestfish-actions.pod:5026
19042 "This command counts the lines in a file, using the C<wc -l> external command."
19046 #: ../src/guestfs-actions.pod:7624
19047 msgid "guestfs_wc_w"
19051 #: ../src/guestfs-actions.pod:7626
19055 " guestfs_wc_w (guestfs_h *g,\n"
19056 " const char *path);\n"
19061 #: ../src/guestfs-actions.pod:7630 ../fish/guestfish-actions.pod:5033
19063 "This command counts the words in a file, using the C<wc -w> external command."
19067 #: ../src/guestfs-actions.pod:7637
19068 msgid "guestfs_write"
19072 #: ../src/guestfs-actions.pod:7639
19076 " guestfs_write (guestfs_h *g,\n"
19077 " const char *path,\n"
19078 " const char *content,\n"
19079 " size_t content_size);\n"
19084 #: ../src/guestfs-actions.pod:7645 ../fish/guestfish-actions.pod:5040
19086 "This call creates a file called C<path>. The content of the file is the "
19087 "string C<content> (which can contain any 8 bit data)."
19091 #: ../src/guestfs-actions.pod:7648
19093 #| msgid "See L<guestfish(1)>."
19094 msgid "See also C<guestfs_write_append>."
19095 msgstr "Див. L<guestfish(1)>."
19098 #: ../src/guestfs-actions.pod:7657
19099 msgid "guestfs_write_append"
19103 #: ../src/guestfs-actions.pod:7659
19107 " guestfs_write_append (guestfs_h *g,\n"
19108 " const char *path,\n"
19109 " const char *content,\n"
19110 " size_t content_size);\n"
19115 #: ../src/guestfs-actions.pod:7665 ../fish/guestfish-actions.pod:5052
19117 "This call appends C<content> to the end of file C<path>. If C<path> does "
19118 "not exist, then a new file is created."
19122 #: ../src/guestfs-actions.pod:7668
19124 #| msgid "See L<guestfish(1)>."
19125 msgid "See also C<guestfs_write>."
19126 msgstr "Див. L<guestfish(1)>."
19129 #: ../src/guestfs-actions.pod:7675
19130 msgid "guestfs_write_file"
19134 #: ../src/guestfs-actions.pod:7677
19138 " guestfs_write_file (guestfs_h *g,\n"
19139 " const char *path,\n"
19140 " const char *content,\n"
19146 #: ../src/guestfs-actions.pod:7683 ../fish/guestfish-actions.pod:5064
19148 "This call creates a file called C<path>. The contents of the file is the "
19149 "string C<content> (which can contain any 8 bit data), with length C<size>."
19153 #: ../src/guestfs-actions.pod:7687 ../fish/guestfish-actions.pod:5068
19155 "As a special case, if C<size> is C<0> then the length is calculated using "
19156 "C<strlen> (so in this case the content cannot contain embedded ASCII NULs)."
19160 #: ../src/guestfs-actions.pod:7691 ../fish/guestfish-actions.pod:5072
19162 "I<NB.> Owing to a bug, writing content containing ASCII NUL characters does "
19163 "I<not> work, even if the length is specified."
19167 #: ../src/guestfs-actions.pod:7699 ../fish/guestfish-actions.pod:5078
19169 "This function is deprecated. In new code, use the C<write> call instead."
19173 #: ../src/guestfs-actions.pod:7708
19174 msgid "guestfs_zegrep"
19178 #: ../src/guestfs-actions.pod:7710
19182 " guestfs_zegrep (guestfs_h *g,\n"
19183 " const char *regex,\n"
19184 " const char *path);\n"
19189 #: ../src/guestfs-actions.pod:7715 ../fish/guestfish-actions.pod:5089
19191 "This calls the external C<zegrep> program and returns the matching lines."
19195 #: ../src/guestfs-actions.pod:7727
19196 msgid "guestfs_zegrepi"
19200 #: ../src/guestfs-actions.pod:7729
19204 " guestfs_zegrepi (guestfs_h *g,\n"
19205 " const char *regex,\n"
19206 " const char *path);\n"
19211 #: ../src/guestfs-actions.pod:7734 ../fish/guestfish-actions.pod:5099
19213 "This calls the external C<zegrep -i> program and returns the matching lines."
19217 #: ../src/guestfs-actions.pod:7746
19218 msgid "guestfs_zero"
19222 #: ../src/guestfs-actions.pod:7748
19226 " guestfs_zero (guestfs_h *g,\n"
19227 " const char *device);\n"
19232 #: ../src/guestfs-actions.pod:7752 ../fish/guestfish-actions.pod:5109
19233 msgid "This command writes zeroes over the first few blocks of C<device>."
19237 #: ../src/guestfs-actions.pod:7754 ../fish/guestfish-actions.pod:5111
19239 "How many blocks are zeroed isn't specified (but it's I<not> enough to "
19240 "securely wipe the device). It should be sufficient to remove any partition "
19241 "tables, filesystem superblocks and so on."
19245 #: ../src/guestfs-actions.pod:7758
19247 "See also: C<guestfs_zero_device>, C<guestfs_scrub_device>, "
19248 "C<guestfs_is_zero_device>"
19252 #: ../src/guestfs-actions.pod:7770
19253 msgid "guestfs_zero_device"
19257 #: ../src/guestfs-actions.pod:7772
19261 " guestfs_zero_device (guestfs_h *g,\n"
19262 " const char *device);\n"
19267 #: ../src/guestfs-actions.pod:7776
19269 "This command writes zeroes over the entire C<device>. Compare with "
19270 "C<guestfs_zero> which just zeroes the first few blocks of a device."
19274 #: ../src/guestfs-actions.pod:7790
19275 msgid "(Added in 1.3.1)"
19279 #: ../src/guestfs-actions.pod:7792
19280 msgid "guestfs_zerofree"
19284 #: ../src/guestfs-actions.pod:7794
19288 " guestfs_zerofree (guestfs_h *g,\n"
19289 " const char *device);\n"
19294 #: ../src/guestfs-actions.pod:7798 ../fish/guestfish-actions.pod:5133
19296 "This runs the I<zerofree> program on C<device>. This program claims to zero "
19297 "unused inodes and disk blocks on an ext2/3 filesystem, thus making it "
19298 "possible to compress the filesystem more effectively."
19302 #: ../src/guestfs-actions.pod:7803 ../fish/guestfish-actions.pod:5138
19303 msgid "You should B<not> run this program if the filesystem is mounted."
19307 #: ../src/guestfs-actions.pod:7806 ../fish/guestfish-actions.pod:5141
19309 "It is possible that using this program can damage the filesystem or data on "
19314 #: ../src/guestfs-actions.pod:7813
19315 msgid "guestfs_zfgrep"
19319 #: ../src/guestfs-actions.pod:7815
19323 " guestfs_zfgrep (guestfs_h *g,\n"
19324 " const char *pattern,\n"
19325 " const char *path);\n"
19330 #: ../src/guestfs-actions.pod:7820 ../fish/guestfish-actions.pod:5148
19332 "This calls the external C<zfgrep> program and returns the matching lines."
19336 #: ../src/guestfs-actions.pod:7832
19337 msgid "guestfs_zfgrepi"
19341 #: ../src/guestfs-actions.pod:7834
19345 " guestfs_zfgrepi (guestfs_h *g,\n"
19346 " const char *pattern,\n"
19347 " const char *path);\n"
19352 #: ../src/guestfs-actions.pod:7839 ../fish/guestfish-actions.pod:5158
19354 "This calls the external C<zfgrep -i> program and returns the matching lines."
19358 #: ../src/guestfs-actions.pod:7851
19359 msgid "guestfs_zfile"
19363 #: ../src/guestfs-actions.pod:7853
19367 " guestfs_zfile (guestfs_h *g,\n"
19368 " const char *meth,\n"
19369 " const char *path);\n"
19374 #: ../src/guestfs-actions.pod:7858 ../fish/guestfish-actions.pod:5168
19376 "This command runs C<file> after first decompressing C<path> using C<method>."
19380 #: ../src/guestfs-actions.pod:7861 ../fish/guestfish-actions.pod:5171
19381 msgid "C<method> must be one of C<gzip>, C<compress> or C<bzip2>."
19385 #: ../src/guestfs-actions.pod:7863
19387 "Since 1.0.63, use C<guestfs_file> instead which can now process compressed "
19392 #: ../src/guestfs-actions.pod:7869 ../fish/guestfish-actions.pod:5176
19394 "This function is deprecated. In new code, use the C<file> call instead."
19398 #: ../src/guestfs-actions.pod:7878
19399 msgid "guestfs_zgrep"
19403 #: ../src/guestfs-actions.pod:7880
19407 " guestfs_zgrep (guestfs_h *g,\n"
19408 " const char *regex,\n"
19409 " const char *path);\n"
19414 #: ../src/guestfs-actions.pod:7885 ../fish/guestfish-actions.pod:5187
19416 "This calls the external C<zgrep> program and returns the matching lines."
19420 #: ../src/guestfs-actions.pod:7897
19421 msgid "guestfs_zgrepi"
19425 #: ../src/guestfs-actions.pod:7899
19429 " guestfs_zgrepi (guestfs_h *g,\n"
19430 " const char *regex,\n"
19431 " const char *path);\n"
19436 #: ../src/guestfs-actions.pod:7904 ../fish/guestfish-actions.pod:5197
19438 "This calls the external C<zgrep -i> program and returns the matching lines."
19442 #: ../src/guestfs-availability.pod:3
19447 #: ../src/guestfs-availability.pod:5
19449 "The following functions: L</guestfs_aug_clear> L</guestfs_aug_close> L</"
19450 "guestfs_aug_defnode> L</guestfs_aug_defvar> L</guestfs_aug_get> L</"
19451 "guestfs_aug_init> L</guestfs_aug_insert> L</guestfs_aug_load> L</"
19452 "guestfs_aug_ls> L</guestfs_aug_match> L</guestfs_aug_mv> L</guestfs_aug_rm> "
19453 "L</guestfs_aug_save> L</guestfs_aug_set>"
19457 #: ../src/guestfs-availability.pod:21
19462 #: ../src/guestfs-availability.pod:23
19463 msgid "The following functions: L</guestfs_btrfs_filesystem_resize>"
19467 #: ../src/guestfs-availability.pod:26
19472 #: ../src/guestfs-availability.pod:28
19474 "The following functions: L</guestfs_inotify_add_watch> L</"
19475 "guestfs_inotify_close> L</guestfs_inotify_files> L</guestfs_inotify_init> L</"
19476 "guestfs_inotify_read> L</guestfs_inotify_rm_watch>"
19480 #: ../src/guestfs-availability.pod:36
19481 msgid "B<linuxfsuuid>"
19485 #: ../src/guestfs-availability.pod:38
19487 "The following functions: L</guestfs_mke2fs_JU> L</guestfs_mke2journal_U> L</"
19488 "guestfs_mkswap_U> L</guestfs_swapoff_uuid> L</guestfs_swapon_uuid>"
19492 #: ../src/guestfs-availability.pod:45
19493 msgid "B<linuxmodules>"
19497 #: ../src/guestfs-availability.pod:47
19498 msgid "The following functions: L</guestfs_modprobe>"
19502 #: ../src/guestfs-availability.pod:50
19503 msgid "B<linuxxattrs>"
19507 #: ../src/guestfs-availability.pod:52
19509 "The following functions: L</guestfs_getxattr> L</guestfs_getxattrs> L</"
19510 "guestfs_lgetxattr> L</guestfs_lgetxattrs> L</guestfs_lremovexattr> L</"
19511 "guestfs_lsetxattr> L</guestfs_lxattrlist> L</guestfs_removexattr> L</"
19512 "guestfs_setxattr>"
19516 #: ../src/guestfs-availability.pod:63
19521 #: ../src/guestfs-availability.pod:65
19523 "The following functions: L</guestfs_luks_add_key> L</guestfs_luks_close> L</"
19524 "guestfs_luks_format> L</guestfs_luks_format_cipher> L</"
19525 "guestfs_luks_kill_slot> L</guestfs_luks_open> L</guestfs_luks_open_ro>"
19529 #: ../src/guestfs-availability.pod:74
19534 #: ../src/guestfs-availability.pod:76
19536 "The following functions: L</guestfs_is_lv> L</guestfs_lvcreate> L</"
19537 "guestfs_lvm_remove_all> L</guestfs_lvm_set_filter> L</guestfs_lvremove> L</"
19538 "guestfs_lvresize> L</guestfs_lvresize_free> L</guestfs_lvs> L</"
19539 "guestfs_lvs_full> L</guestfs_pvcreate> L</guestfs_pvremove> L</"
19540 "guestfs_pvresize> L</guestfs_pvresize_size> L</guestfs_pvs> L</"
19541 "guestfs_pvs_full> L</guestfs_vg_activate> L</guestfs_vg_activate_all> L</"
19542 "guestfs_vgcreate> L</guestfs_vgremove> L</guestfs_vgs> L</guestfs_vgs_full>"
19546 #: ../src/guestfs-availability.pod:99
19551 #: ../src/guestfs-availability.pod:101
19553 "The following functions: L</guestfs_mkfifo> L</guestfs_mknod> L</"
19554 "guestfs_mknod_b> L</guestfs_mknod_c>"
19558 #: ../src/guestfs-availability.pod:107
19563 #: ../src/guestfs-availability.pod:109
19564 msgid "The following functions: L</guestfs_ntfs_3g_probe>"
19568 #: ../src/guestfs-availability.pod:112
19569 msgid "B<ntfsprogs>"
19573 #: ../src/guestfs-availability.pod:114
19575 "The following functions: L</guestfs_ntfsresize> L</guestfs_ntfsresize_opts> "
19576 "L</guestfs_ntfsresize_size>"
19580 #: ../src/guestfs-availability.pod:119
19581 msgid "B<realpath>"
19585 #: ../src/guestfs-availability.pod:121
19586 msgid "The following functions: L</guestfs_realpath>"
19590 #: ../src/guestfs-availability.pod:124
19595 #: ../src/guestfs-availability.pod:126
19597 "The following functions: L</guestfs_scrub_device> L</guestfs_scrub_file> L</"
19598 "guestfs_scrub_freespace>"
19602 #: ../src/guestfs-availability.pod:131
19607 #: ../src/guestfs-availability.pod:133
19608 msgid "The following functions: L</guestfs_getcon> L</guestfs_setcon>"
19612 #: ../src/guestfs-availability.pod:137
19617 #: ../src/guestfs-availability.pod:139
19618 msgid "The following functions: L</guestfs_txz_in> L</guestfs_txz_out>"
19622 #: ../src/guestfs-availability.pod:143
19623 msgid "B<zerofree>"
19627 #: ../src/guestfs-availability.pod:145
19628 msgid "The following functions: L</guestfs_zerofree>"
19632 #: ../src/guestfs-structs.pod:1
19633 msgid "guestfs_int_bool"
19637 #: ../src/guestfs-structs.pod:3
19640 " struct guestfs_int_bool {\n"
19648 #: ../src/guestfs-structs.pod:8
19651 " struct guestfs_int_bool_list {\n"
19652 " uint32_t len; /* Number of elements in list. */\n"
19653 " struct guestfs_int_bool *val; /* Elements. */\n"
19659 #: ../src/guestfs-structs.pod:13
19662 " void guestfs_free_int_bool (struct guestfs_free_int_bool *);\n"
19663 " void guestfs_free_int_bool_list (struct guestfs_free_int_bool_list *);\n"
19668 #: ../src/guestfs-structs.pod:16
19669 msgid "guestfs_lvm_pv"
19673 #: ../src/guestfs-structs.pod:18
19676 " struct guestfs_lvm_pv {\n"
19677 " char *pv_name;\n"
19678 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
19679 " char pv_uuid[32];\n"
19681 " uint64_t pv_size;\n"
19682 " uint64_t dev_size;\n"
19683 " uint64_t pv_free;\n"
19684 " uint64_t pv_used;\n"
19685 " char *pv_attr;\n"
19686 " int64_t pv_pe_count;\n"
19687 " int64_t pv_pe_alloc_count;\n"
19688 " char *pv_tags;\n"
19689 " uint64_t pe_start;\n"
19690 " int64_t pv_mda_count;\n"
19691 " uint64_t pv_mda_free;\n"
19697 #: ../src/guestfs-structs.pod:36
19700 " struct guestfs_lvm_pv_list {\n"
19701 " uint32_t len; /* Number of elements in list. */\n"
19702 " struct guestfs_lvm_pv *val; /* Elements. */\n"
19708 #: ../src/guestfs-structs.pod:41
19711 " void guestfs_free_lvm_pv (struct guestfs_free_lvm_pv *);\n"
19712 " void guestfs_free_lvm_pv_list (struct guestfs_free_lvm_pv_list *);\n"
19717 #: ../src/guestfs-structs.pod:44
19718 msgid "guestfs_lvm_vg"
19722 #: ../src/guestfs-structs.pod:46
19725 " struct guestfs_lvm_vg {\n"
19726 " char *vg_name;\n"
19727 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
19728 " char vg_uuid[32];\n"
19730 " char *vg_attr;\n"
19731 " uint64_t vg_size;\n"
19732 " uint64_t vg_free;\n"
19733 " char *vg_sysid;\n"
19734 " uint64_t vg_extent_size;\n"
19735 " int64_t vg_extent_count;\n"
19736 " int64_t vg_free_count;\n"
19737 " int64_t max_lv;\n"
19738 " int64_t max_pv;\n"
19739 " int64_t pv_count;\n"
19740 " int64_t lv_count;\n"
19741 " int64_t snap_count;\n"
19742 " int64_t vg_seqno;\n"
19743 " char *vg_tags;\n"
19744 " int64_t vg_mda_count;\n"
19745 " uint64_t vg_mda_free;\n"
19751 #: ../src/guestfs-structs.pod:69
19754 " struct guestfs_lvm_vg_list {\n"
19755 " uint32_t len; /* Number of elements in list. */\n"
19756 " struct guestfs_lvm_vg *val; /* Elements. */\n"
19762 #: ../src/guestfs-structs.pod:74
19765 " void guestfs_free_lvm_vg (struct guestfs_free_lvm_vg *);\n"
19766 " void guestfs_free_lvm_vg_list (struct guestfs_free_lvm_vg_list *);\n"
19771 #: ../src/guestfs-structs.pod:77
19772 msgid "guestfs_lvm_lv"
19776 #: ../src/guestfs-structs.pod:79
19779 " struct guestfs_lvm_lv {\n"
19780 " char *lv_name;\n"
19781 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
19782 " char lv_uuid[32];\n"
19783 " char *lv_attr;\n"
19784 " int64_t lv_major;\n"
19785 " int64_t lv_minor;\n"
19786 " int64_t lv_kernel_major;\n"
19787 " int64_t lv_kernel_minor;\n"
19788 " uint64_t lv_size;\n"
19789 " int64_t seg_count;\n"
19791 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
19792 " float snap_percent;\n"
19793 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
19794 " float copy_percent;\n"
19795 " char *move_pv;\n"
19796 " char *lv_tags;\n"
19797 " char *mirror_log;\n"
19798 " char *modules;\n"
19804 #: ../src/guestfs-structs.pod:101
19807 " struct guestfs_lvm_lv_list {\n"
19808 " uint32_t len; /* Number of elements in list. */\n"
19809 " struct guestfs_lvm_lv *val; /* Elements. */\n"
19815 #: ../src/guestfs-structs.pod:106
19818 " void guestfs_free_lvm_lv (struct guestfs_free_lvm_lv *);\n"
19819 " void guestfs_free_lvm_lv_list (struct guestfs_free_lvm_lv_list *);\n"
19824 #: ../src/guestfs-structs.pod:111
19827 " struct guestfs_stat {\n"
19831 " int64_t nlink;\n"
19836 " int64_t blksize;\n"
19837 " int64_t blocks;\n"
19838 " int64_t atime;\n"
19839 " int64_t mtime;\n"
19840 " int64_t ctime;\n"
19846 #: ../src/guestfs-structs.pod:127
19849 " struct guestfs_stat_list {\n"
19850 " uint32_t len; /* Number of elements in list. */\n"
19851 " struct guestfs_stat *val; /* Elements. */\n"
19857 #: ../src/guestfs-structs.pod:132
19860 " void guestfs_free_stat (struct guestfs_free_stat *);\n"
19861 " void guestfs_free_stat_list (struct guestfs_free_stat_list *);\n"
19866 #: ../src/guestfs-structs.pod:137
19869 " struct guestfs_statvfs {\n"
19870 " int64_t bsize;\n"
19871 " int64_t frsize;\n"
19872 " int64_t blocks;\n"
19873 " int64_t bfree;\n"
19874 " int64_t bavail;\n"
19875 " int64_t files;\n"
19876 " int64_t ffree;\n"
19877 " int64_t favail;\n"
19880 " int64_t namemax;\n"
19886 #: ../src/guestfs-structs.pod:151
19889 " struct guestfs_statvfs_list {\n"
19890 " uint32_t len; /* Number of elements in list. */\n"
19891 " struct guestfs_statvfs *val; /* Elements. */\n"
19897 #: ../src/guestfs-structs.pod:156
19900 " void guestfs_free_statvfs (struct guestfs_free_statvfs *);\n"
19901 " void guestfs_free_statvfs_list (struct guestfs_free_statvfs_list *);\n"
19906 #: ../src/guestfs-structs.pod:159
19907 msgid "guestfs_dirent"
19911 #: ../src/guestfs-structs.pod:161
19914 " struct guestfs_dirent {\n"
19923 #: ../src/guestfs-structs.pod:167
19926 " struct guestfs_dirent_list {\n"
19927 " uint32_t len; /* Number of elements in list. */\n"
19928 " struct guestfs_dirent *val; /* Elements. */\n"
19934 #: ../src/guestfs-structs.pod:172
19937 " void guestfs_free_dirent (struct guestfs_free_dirent *);\n"
19938 " void guestfs_free_dirent_list (struct guestfs_free_dirent_list *);\n"
19943 #: ../src/guestfs-structs.pod:177
19946 " struct guestfs_version {\n"
19947 " int64_t major;\n"
19948 " int64_t minor;\n"
19949 " int64_t release;\n"
19956 #: ../src/guestfs-structs.pod:184
19959 " struct guestfs_version_list {\n"
19960 " uint32_t len; /* Number of elements in list. */\n"
19961 " struct guestfs_version *val; /* Elements. */\n"
19967 #: ../src/guestfs-structs.pod:189
19970 " void guestfs_free_version (struct guestfs_free_version *);\n"
19971 " void guestfs_free_version_list (struct guestfs_free_version_list *);\n"
19976 #: ../src/guestfs-structs.pod:192
19977 msgid "guestfs_xattr"
19981 #: ../src/guestfs-structs.pod:194
19984 " struct guestfs_xattr {\n"
19985 " char *attrname;\n"
19986 " /* The next two fields describe a byte array. */\n"
19987 " uint32_t attrval_len;\n"
19988 " char *attrval;\n"
19994 #: ../src/guestfs-structs.pod:201
19997 " struct guestfs_xattr_list {\n"
19998 " uint32_t len; /* Number of elements in list. */\n"
19999 " struct guestfs_xattr *val; /* Elements. */\n"
20005 #: ../src/guestfs-structs.pod:206
20008 " void guestfs_free_xattr (struct guestfs_free_xattr *);\n"
20009 " void guestfs_free_xattr_list (struct guestfs_free_xattr_list *);\n"
20014 #: ../src/guestfs-structs.pod:209
20015 msgid "guestfs_inotify_event"
20019 #: ../src/guestfs-structs.pod:211
20022 " struct guestfs_inotify_event {\n"
20023 " int64_t in_wd;\n"
20024 " uint32_t in_mask;\n"
20025 " uint32_t in_cookie;\n"
20026 " char *in_name;\n"
20032 #: ../src/guestfs-structs.pod:218
20035 " struct guestfs_inotify_event_list {\n"
20036 " uint32_t len; /* Number of elements in list. */\n"
20037 " struct guestfs_inotify_event *val; /* Elements. */\n"
20043 #: ../src/guestfs-structs.pod:223
20046 " void guestfs_free_inotify_event (struct guestfs_free_inotify_event *);\n"
20047 " void guestfs_free_inotify_event_list (struct guestfs_free_inotify_event_list *);\n"
20052 #: ../src/guestfs-structs.pod:226
20053 msgid "guestfs_partition"
20057 #: ../src/guestfs-structs.pod:228
20060 " struct guestfs_partition {\n"
20061 " int32_t part_num;\n"
20062 " uint64_t part_start;\n"
20063 " uint64_t part_end;\n"
20064 " uint64_t part_size;\n"
20070 #: ../src/guestfs-structs.pod:235
20073 " struct guestfs_partition_list {\n"
20074 " uint32_t len; /* Number of elements in list. */\n"
20075 " struct guestfs_partition *val; /* Elements. */\n"
20081 #: ../src/guestfs-structs.pod:240
20084 " void guestfs_free_partition (struct guestfs_free_partition *);\n"
20085 " void guestfs_free_partition_list (struct guestfs_free_partition_list *);\n"
20090 #: ../src/guestfs-structs.pod:243
20091 msgid "guestfs_application"
20095 #: ../src/guestfs-structs.pod:245
20098 " struct guestfs_application {\n"
20099 " char *app_name;\n"
20100 " char *app_display_name;\n"
20101 " int32_t app_epoch;\n"
20102 " char *app_version;\n"
20103 " char *app_release;\n"
20104 " char *app_install_path;\n"
20105 " char *app_trans_path;\n"
20106 " char *app_publisher;\n"
20107 " char *app_url;\n"
20108 " char *app_source_package;\n"
20109 " char *app_summary;\n"
20110 " char *app_description;\n"
20116 #: ../src/guestfs-structs.pod:260
20119 " struct guestfs_application_list {\n"
20120 " uint32_t len; /* Number of elements in list. */\n"
20121 " struct guestfs_application *val; /* Elements. */\n"
20127 #: ../src/guestfs-structs.pod:265
20130 " void guestfs_free_application (struct guestfs_free_application *);\n"
20131 " void guestfs_free_application_list (struct guestfs_free_application_list *);\n"
20136 #: ../fish/guestfish.pod:5
20137 msgid "guestfish - the libguestfs Filesystem Interactive SHell"
20141 #: ../fish/guestfish.pod:9
20144 " guestfish [--options] [commands]\n"
20149 #: ../fish/guestfish.pod:11
20157 #: ../fish/guestfish.pod:13
20160 " guestfish [--ro|--rw] -a disk.img\n"
20165 #: ../fish/guestfish.pod:15
20168 " guestfish [--ro|--rw] -a disk.img -m dev[:mountpoint]\n"
20173 #: ../fish/guestfish.pod:17
20176 " guestfish -d libvirt-domain\n"
20181 #: ../fish/guestfish.pod:19
20184 " guestfish [--ro|--rw] -a disk.img -i\n"
20189 #: ../fish/guestfish.pod:21
20192 " guestfish -d libvirt-domain -i\n"
20197 #: ../fish/guestfish.pod:23 ../fuse/guestmount.pod:15
20198 #: ../tools/virt-win-reg.pl:51 ../tools/virt-tar.pl:64
20203 #: ../fish/guestfish.pod:25
20205 "Using guestfish in read/write mode on live virtual machines can be "
20206 "dangerous, potentially causing disk corruption. Use the I<--ro> (read-only) "
20207 "option to use guestfish safely if the disk image or virtual machine might be "
20212 #: ../fish/guestfish.pod:32
20214 "Guestfish is a shell and command-line tool for examining and modifying "
20215 "virtual machine filesystems. It uses libguestfs and exposes all of the "
20216 "functionality of the guestfs API, see L<guestfs(3)>."
20220 #: ../fish/guestfish.pod:36
20222 "Guestfish gives you structured access to the libguestfs API, from shell "
20223 "scripts or the command line or interactively. If you want to rescue a "
20224 "broken virtual machine image, you should look at the L<virt-rescue(1)> "
20229 #: ../fish/guestfish.pod:41 ../fish/guestfish.pod:1007
20230 #: ../fuse/guestmount.pod:39 ../tools/virt-tar.pl:50
20235 #: ../fish/guestfish.pod:43
20236 msgid "As an interactive shell"
20240 #: ../fish/guestfish.pod:45
20248 #: ../fish/guestfish.pod:47
20251 " Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
20252 " editing virtual machine filesystems.\n"
20257 #: ../fish/guestfish.pod:50
20260 " Type: 'help' for a list of commands\n"
20261 " 'man' to read the manual\n"
20262 " 'quit' to quit the shell\n"
20267 #: ../fish/guestfish.pod:54
20270 " ><fs> add-ro disk.img\n"
20272 " ><fs> list-filesystems\n"
20273 " /dev/sda1: ext4\n"
20274 " /dev/vg_guest/lv_root: ext4\n"
20275 " /dev/vg_guest/lv_swap: swap\n"
20276 " ><fs> mount /dev/vg_guest/lv_root /\n"
20277 " ><fs> cat /etc/fstab\n"
20279 " # Created by anaconda\n"
20286 #: ../fish/guestfish.pod:67
20287 msgid "From shell scripts"
20291 #: ../fish/guestfish.pod:69
20292 msgid "Create a new C</etc/motd> file in a guest or disk image:"
20296 #: ../fish/guestfish.pod:71
20299 " guestfish <<_EOF_\n"
20302 " mount /dev/vg_guest/lv_root /\n"
20303 " write /etc/motd \"Welcome, new users\"\n"
20309 #: ../fish/guestfish.pod:78
20310 msgid "List the LVM logical volumes in a disk image:"
20314 #: ../fish/guestfish.pod:80
20317 " guestfish -a disk.img --ro <<_EOF_\n"
20325 #: ../fish/guestfish.pod:85
20326 msgid "List all the filesystems in a disk image:"
20330 #: ../fish/guestfish.pod:87
20333 " guestfish -a disk.img --ro <<_EOF_\n"
20335 " list-filesystems\n"
20341 #: ../fish/guestfish.pod:92
20342 msgid "On one command line"
20346 #: ../fish/guestfish.pod:94
20347 msgid "Update C</etc/resolv.conf> in a guest:"
20351 #: ../fish/guestfish.pod:96
20355 " add disk.img : run : mount /dev/vg_guest/lv_root / : \\\n"
20356 " write /etc/resolv.conf \"nameserver 1.2.3.4\"\n"
20361 #: ../fish/guestfish.pod:100
20362 msgid "Edit C</boot/grub/grub.conf> interactively:"
20366 #: ../fish/guestfish.pod:102
20369 " guestfish --rw --add disk.img \\\n"
20370 " --mount /dev/vg_guest/lv_root \\\n"
20371 " --mount /dev/sda1:/boot \\\n"
20372 " edit /boot/grub/grub.conf\n"
20377 #: ../fish/guestfish.pod:107
20378 msgid "Mount disks automatically"
20382 #: ../fish/guestfish.pod:109
20384 "Use the I<-i> option to automatically mount the disks from a virtual machine:"
20388 #: ../fish/guestfish.pod:112
20391 " guestfish --ro -a disk.img -i cat /etc/group\n"
20396 #: ../fish/guestfish.pod:114
20399 " guestfish --ro -d libvirt-domain -i cat /etc/group\n"
20404 #: ../fish/guestfish.pod:116
20405 msgid "Another way to edit C</boot/grub/grub.conf> interactively is:"
20409 #: ../fish/guestfish.pod:118
20412 " guestfish --rw -a disk.img -i edit /boot/grub/grub.conf\n"
20417 #: ../fish/guestfish.pod:120
20418 msgid "As a script interpreter"
20422 #: ../fish/guestfish.pod:122
20423 msgid "Create a 100MB disk containing an ext2-formatted partition:"
20427 #: ../fish/guestfish.pod:124
20430 " #!/usr/bin/guestfish -f\n"
20431 " sparse test1.img 100M\n"
20433 " part-disk /dev/sda mbr\n"
20434 " mkfs ext2 /dev/sda1\n"
20439 #: ../fish/guestfish.pod:130
20440 msgid "Start with a prepared disk"
20444 #: ../fish/guestfish.pod:132
20446 "An alternate way to create a 100MB disk called C<test1.img> containing a "
20447 "single ext2-formatted partition:"
20451 #: ../fish/guestfish.pod:135
20454 " guestfish -N fs\n"
20459 #: ../fish/guestfish.pod:137
20460 msgid "To list what is available do:"
20464 #: ../fish/guestfish.pod:139 ../fish/guestfish.pod:998
20467 " guestfish -N help | less\n"
20472 #: ../fish/guestfish.pod:141
20473 msgid "Remote control"
20477 #: ../fish/guestfish.pod:143
20480 " eval \"`guestfish --listen`\"\n"
20481 " guestfish --remote add-ro disk.img\n"
20482 " guestfish --remote run\n"
20483 " guestfish --remote lvs\n"
20488 #: ../fish/guestfish.pod:148 ../test-tool/libguestfs-test-tool.pod:37
20489 #: ../fuse/guestmount.pod:83 ../tools/virt-win-reg.pl:96
20490 #: ../tools/virt-list-filesystems.pl:53 ../tools/virt-tar.pl:103
20491 #: ../tools/virt-make-fs.pl:153 ../tools/virt-list-partitions.pl:54
20496 #: ../fish/guestfish.pod:152 ../fuse/guestmount.pod:143
20497 #: ../tools/virt-win-reg.pl:104 ../tools/virt-list-filesystems.pl:61
20498 #: ../tools/virt-tar.pl:111 ../tools/virt-make-fs.pl:161
20499 #: ../tools/virt-list-partitions.pl:62
20504 #: ../fish/guestfish.pod:154
20505 msgid "Displays general help on options."
20509 #: ../fish/guestfish.pod:156
20514 #: ../fish/guestfish.pod:158
20515 msgid "B<--cmd-help>"
20519 #: ../fish/guestfish.pod:160
20520 msgid "Lists all available guestfish commands."
20524 #: ../fish/guestfish.pod:162
20529 #: ../fish/guestfish.pod:164
20530 msgid "B<--cmd-help cmd>"
20534 #: ../fish/guestfish.pod:166
20535 msgid "Displays detailed help on a single command C<cmd>."
20539 #: ../fish/guestfish.pod:168
20540 msgid "B<-a image>"
20544 #: ../fish/guestfish.pod:170
20545 msgid "B<--add image>"
20549 #: ../fish/guestfish.pod:172
20550 msgid "Add a block device or virtual machine image to the shell."
20554 #: ../fish/guestfish.pod:174 ../fuse/guestmount.pod:91
20556 "The format of the disk image is auto-detected. To override this and force a "
20557 "particular format use the I<--format=..> option."
20561 #: ../fish/guestfish.pod:177
20563 "Using this flag is mostly equivalent to using the C<add> command, with "
20564 "C<readonly:true> if the I<--ro> flag was given, and with C<format:...> if "
20565 "the I<--format=...> flag was given."
20569 #: ../fish/guestfish.pod:181
20574 #: ../fish/guestfish.pod:183
20575 msgid "B<--connect URI>"
20579 #: ../fish/guestfish.pod:185 ../fuse/guestmount.pod:96
20581 "When used in conjunction with the I<-d> option, this specifies the libvirt "
20582 "URI to use. The default is to use the default libvirt connection."
20586 #: ../fish/guestfish.pod:189
20591 #: ../fish/guestfish.pod:191
20593 "If using the I<--listen> option and a csh-like shell, use this option. See "
20594 "section L</REMOTE CONTROL AND CSH> below."
20598 #: ../fish/guestfish.pod:194
20599 msgid "B<-d libvirt-domain>"
20603 #: ../fish/guestfish.pod:196
20604 msgid "B<--domain libvirt-domain>"
20608 #: ../fish/guestfish.pod:198 ../fuse/guestmount.pod:102
20610 "Add disks from the named libvirt domain. If the I<--ro> option is also "
20611 "used, then any libvirt domain can be used. However in write mode, only "
20612 "libvirt domains which are shut down can be named here."
20616 #: ../fish/guestfish.pod:202 ../fuse/guestmount.pod:106
20617 msgid "Domain UUIDs can be used instead of names."
20621 #: ../fish/guestfish.pod:204
20623 "Using this flag is mostly equivalent to using the C<add-domain> command, "
20624 "with C<readonly:true> if the I<--ro> flag was given, and with C<format:...> "
20625 "if the I<--format:...> flag was given."
20629 #: ../fish/guestfish.pod:208
20634 #: ../fish/guestfish.pod:210
20635 msgid "B<--no-dest-paths>"
20639 #: ../fish/guestfish.pod:212
20641 "Don't tab-complete paths on the guest filesystem. It is useful to be able "
20642 "to hit the tab key to complete paths on the guest filesystem, but this "
20643 "causes extra \"hidden\" guestfs calls to be made, so this option is here to "
20644 "allow this feature to be disabled."
20648 #: ../fish/guestfish.pod:217 ../fuse/guestmount.pod:120
20649 msgid "B<--echo-keys>"
20653 #: ../fish/guestfish.pod:219 ../fuse/guestmount.pod:122
20655 "When prompting for keys and passphrases, guestfish normally turns echoing "
20656 "off so you cannot see what you are typing. If you are not worried about "
20657 "Tempest attacks and there is no one else in the room you can specify this "
20658 "flag to see what you are typing."
20662 #: ../fish/guestfish.pod:224
20667 #: ../fish/guestfish.pod:226
20668 msgid "B<--file file>"
20672 #: ../fish/guestfish.pod:228
20673 msgid "Read commands from C<file>. To write pure guestfish scripts, use:"
20677 #: ../fish/guestfish.pod:231
20680 " #!/usr/bin/guestfish -f\n"
20685 #: ../fish/guestfish.pod:233
20686 msgid "B<--format=raw|qcow2|..>"
20690 #: ../fish/guestfish.pod:235
20691 msgid "B<--format>"
20695 #: ../fish/guestfish.pod:237 ../fuse/guestmount.pod:129
20697 "The default for the I<-a> option is to auto-detect the format of the disk "
20698 "image. Using this forces the disk format for I<-a> options which follow on "
20699 "the command line. Using I<--format> with no argument switches back to auto-"
20700 "detection for subsequent I<-a> options."
20704 #: ../fish/guestfish.pod:244
20707 " guestfish --format=raw -a disk.img\n"
20712 #: ../fish/guestfish.pod:246
20713 msgid "forces raw format (no auto-detection) for C<disk.img>."
20717 #: ../fish/guestfish.pod:248
20720 " guestfish --format=raw -a disk.img --format -a another.img\n"
20725 #: ../fish/guestfish.pod:250
20727 "forces raw format (no auto-detection) for C<disk.img> and reverts to auto-"
20728 "detection for C<another.img>."
20732 #: ../fish/guestfish.pod:253
20734 "If you have untrusted raw-format guest disk images, you should use this "
20735 "option to specify the disk format. This avoids a possible security problem "
20736 "with malicious guests (CVE-2010-3851). See also L</add-drive-opts>."
20740 #: ../fish/guestfish.pod:258
20745 #: ../fish/guestfish.pod:260
20746 msgid "B<--inspector>"
20750 #: ../fish/guestfish.pod:262 ../fuse/guestmount.pod:149
20752 "Using L<virt-inspector(1)> code, inspect the disks looking for an operating "
20753 "system and mount filesystems as they would be mounted on the real virtual "
20758 #: ../fish/guestfish.pod:266
20759 msgid "Typical usage is either:"
20763 #: ../fish/guestfish.pod:268
20766 " guestfish -d myguest -i\n"
20771 #: ../fish/guestfish.pod:270
20772 msgid "(for an inactive libvirt domain called I<myguest>), or:"
20776 #: ../fish/guestfish.pod:272
20779 " guestfish --ro -d myguest -i\n"
20784 #: ../fish/guestfish.pod:274
20785 msgid "(for active domains, readonly), or specify the block device directly:"
20789 #: ../fish/guestfish.pod:276
20792 " guestfish --rw -a /dev/Guests/MyGuest -i\n"
20797 #: ../fish/guestfish.pod:278
20799 "Note that the command line syntax changed slightly over older versions of "
20800 "guestfish. You can still use the old syntax:"
20804 #: ../fish/guestfish.pod:281
20807 " guestfish [--ro] -i disk.img\n"
20812 #: ../fish/guestfish.pod:283
20815 " guestfish [--ro] -i libvirt-domain\n"
20820 #: ../fish/guestfish.pod:285
20822 "Using this flag is mostly equivalent to using the C<inspect-os> command and "
20823 "then using other commands to mount the filesystems that were found."
20827 #: ../fish/guestfish.pod:289 ../fuse/guestmount.pod:153
20828 msgid "B<--keys-from-stdin>"
20832 #: ../fish/guestfish.pod:291 ../fuse/guestmount.pod:155
20834 "Read key or passphrase parameters from stdin. The default is to try to read "
20835 "passphrases from the user by opening C</dev/tty>."
20839 #: ../fish/guestfish.pod:294
20840 msgid "B<--listen>"
20844 #: ../fish/guestfish.pod:296
20846 "Fork into the background and listen for remote commands. See section L</"
20847 "REMOTE CONTROL GUESTFISH OVER A SOCKET> below."
20851 #: ../fish/guestfish.pod:299 ../fuse/guestmount.pod:158
20856 #: ../fish/guestfish.pod:301 ../fuse/guestmount.pod:160
20858 "Connect to a live virtual machine. (Experimental, see L<guestfs(3)/"
20859 "ATTACHING TO RUNNING DAEMONS>)."
20863 #: ../fish/guestfish.pod:304 ../fuse/guestmount.pod:163
20864 msgid "B<-m dev[:mountpoint[:options]]>"
20868 #: ../fish/guestfish.pod:306 ../fuse/guestmount.pod:165
20869 msgid "B<--mount dev[:mountpoint[:options]]>"
20873 #: ../fish/guestfish.pod:308
20874 msgid "Mount the named partition or logical volume on the given mountpoint."
20878 #: ../fish/guestfish.pod:310
20879 msgid "If the mountpoint is omitted, it defaults to C</>."
20883 #: ../fish/guestfish.pod:312
20884 msgid "You have to mount something on C</> before most commands will work."
20888 #: ../fish/guestfish.pod:314
20890 "If any I<-m> or I<--mount> options are given, the guest is automatically "
20895 #: ../fish/guestfish.pod:317
20897 "If you don't know what filesystems a disk image contains, you can either run "
20898 "guestfish without this option, then list the partitions, filesystems and LVs "
20899 "available (see L</list-partitions>, L</list-filesystems> and L</lvs> "
20900 "commands), or you can use the L<virt-filesystems(1)> program."
20904 #: ../fish/guestfish.pod:323 ../fuse/guestmount.pod:173
20906 "The third (and rarely used) part of the mount parameter is the list of mount "
20907 "options used to mount the underlying filesystem. If this is not given, then "
20908 "the mount options are either the empty string or C<ro> (the latter if the "
20909 "I<--ro> flag is used). By specifying the mount options, you override this "
20910 "default choice. Probably the only time you would use this is to enable ACLs "
20911 "and/or extended attributes if the filesystem can support them:"
20915 #: ../fish/guestfish.pod:331 ../fuse/guestmount.pod:181
20918 " -m /dev/sda1:/:acl,user_xattr\n"
20923 #: ../fish/guestfish.pod:333
20924 msgid "Using this flag is equivalent to using the C<mount-options> command."
20928 #: ../fish/guestfish.pod:335
20933 #: ../fish/guestfish.pod:337
20934 msgid "B<--no-sync>"
20938 #: ../fish/guestfish.pod:339
20940 "Disable autosync. This is enabled by default. See the discussion of "
20941 "autosync in the L<guestfs(3)> manpage."
20945 #: ../fish/guestfish.pod:342
20950 #: ../fish/guestfish.pod:344
20951 msgid "B<--new type>"
20955 #: ../fish/guestfish.pod:346
20960 #: ../fish/guestfish.pod:348
20962 "Prepare a fresh disk image formatted as \"type\". This is an alternative to "
20963 "the I<-a> option: whereas I<-a> adds an existing disk, I<-N> creates a "
20964 "preformatted disk with a filesystem and adds it. See L</PREPARED DISK "
20969 #: ../fish/guestfish.pod:353
20970 msgid "B<--progress-bars>"
20974 #: ../fish/guestfish.pod:355
20975 msgid "Enable progress bars, even when guestfish is used non-interactively."
20979 #: ../fish/guestfish.pod:357
20981 "Progress bars are enabled by default when guestfish is used as an "
20982 "interactive shell."
20986 #: ../fish/guestfish.pod:360
20987 msgid "B<--no-progress-bars>"
20991 #: ../fish/guestfish.pod:362
20992 msgid "Disable progress bars."
20996 #: ../fish/guestfish.pod:364
20997 msgid "B<--remote[=pid]>"
21001 #: ../fish/guestfish.pod:366
21003 "Send remote commands to C<$GUESTFISH_PID> or C<pid>. See section L</REMOTE "
21004 "CONTROL GUESTFISH OVER A SOCKET> below."
21008 #: ../fish/guestfish.pod:369
21013 #: ../fish/guestfish.pod:371
21018 #: ../fish/guestfish.pod:373
21020 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
21021 "mounts are done read-only."
21025 #: ../fish/guestfish.pod:376
21027 "The option must always be used if the disk image or virtual machine might be "
21028 "running, and is generally recommended in cases where you don't need write "
21029 "access to the disk."
21033 #: ../fish/guestfish.pod:380
21035 "Note that prepared disk images created with I<-N> are not affected by this "
21036 "option. Also commands like C<add> are not affected - you have to specify "
21037 "the C<readonly:true> option explicitly if you need it."
21041 #: ../fish/guestfish.pod:384
21042 msgid "See also L</OPENING DISKS FOR READ AND WRITE> below."
21046 #: ../fish/guestfish.pod:386 ../fuse/guestmount.pod:237
21047 msgid "B<--selinux>"
21051 #: ../fish/guestfish.pod:388
21052 msgid "Enable SELinux support for the guest. See L<guestfs(3)/SELINUX>."
21056 #: ../fish/guestfish.pod:390
21061 #: ../fish/guestfish.pod:392
21062 msgid "B<--verbose>"
21066 #: ../fish/guestfish.pod:394
21068 "Enable very verbose messages. This is particularly useful if you find a bug."
21072 #: ../fish/guestfish.pod:397
21077 #: ../fish/guestfish.pod:399 ../tools/virt-win-reg.pl:112
21078 #: ../tools/virt-list-filesystems.pl:69 ../tools/virt-tar.pl:119
21079 #: ../tools/virt-make-fs.pl:169 ../tools/virt-list-partitions.pl:70
21080 msgid "B<--version>"
21084 #: ../fish/guestfish.pod:401
21085 msgid "Display the guestfish / libguestfs version number and exit."
21089 #: ../fish/guestfish.pod:403
21094 #: ../fish/guestfish.pod:405
21099 #: ../fish/guestfish.pod:407 ../fuse/guestmount.pod:251
21101 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
21102 "mounts are done read-write."
21106 #: ../fish/guestfish.pod:410
21107 msgid "See L</OPENING DISKS FOR READ AND WRITE> below."
21111 #: ../fish/guestfish.pod:412
21116 #: ../fish/guestfish.pod:414
21117 msgid "Echo each command before executing it."
21121 #: ../fish/guestfish.pod:418
21122 msgid "COMMANDS ON COMMAND LINE"
21126 #: ../fish/guestfish.pod:420
21128 "Any additional (non-option) arguments are treated as commands to execute."
21132 #: ../fish/guestfish.pod:423
21134 "Commands to execute should be separated by a colon (C<:>), where the colon "
21135 "is a separate parameter. Thus:"
21139 #: ../fish/guestfish.pod:426
21142 " guestfish cmd [args...] : cmd [args...] : cmd [args...] ...\n"
21147 #: ../fish/guestfish.pod:428
21149 "If there are no additional arguments, then we enter a shell, either an "
21150 "interactive shell with a prompt (if the input is a terminal) or a non-"
21151 "interactive shell."
21155 #: ../fish/guestfish.pod:432
21157 "In either command line mode or non-interactive shell, the first command that "
21158 "gives an error causes the whole shell to exit. In interactive mode (with a "
21159 "prompt) if a command fails, you can continue to enter commands."
21163 #: ../fish/guestfish.pod:437
21164 msgid "USING launch (OR run)"
21168 #: ../fish/guestfish.pod:439
21170 "As with L<guestfs(3)>, you must first configure your guest by adding disks, "
21171 "then launch it, then mount any disks you need, and finally issue actions/"
21172 "commands. So the general order of the day is:"
21176 #: ../fish/guestfish.pod:447
21177 msgid "add or -a/--add"
21181 #: ../fish/guestfish.pod:451
21182 msgid "launch (aka run)"
21186 #: ../fish/guestfish.pod:455
21187 msgid "mount or -m/--mount"
21191 #: ../fish/guestfish.pod:459
21192 msgid "any other commands"
21196 #: ../fish/guestfish.pod:463
21198 "C<run> is a synonym for C<launch>. You must C<launch> (or C<run>) your "
21199 "guest before mounting or performing any other commands."
21203 #: ../fish/guestfish.pod:466
21205 "The only exception is that if any of the I<-i>, I<-m>, I<--mount>, I<-N> or "
21206 "I<--new> options were given then C<run> is done automatically, simply "
21207 "because guestfish can't perform the action you asked for without doing this."
21211 #: ../fish/guestfish.pod:471
21212 msgid "OPENING DISKS FOR READ AND WRITE"
21216 #: ../fish/guestfish.pod:473
21218 "The guestfish, L<guestmount(1)> and L<virt-rescue(1)> options I<--ro> and "
21219 "I<--rw> affect whether the other command line options I<-a>, I<-c>, I<-d>, "
21220 "I<-i> and I<-m> open disk images read-only or for writing."
21224 #: ../fish/guestfish.pod:478
21226 "In libguestfs E<le> 1.10, guestfish, guestmount and virt-rescue defaulted to "
21227 "opening disk images supplied on the command line for write. To open a disk "
21228 "image read-only you have to do I<-a image --ro>."
21232 #: ../fish/guestfish.pod:482
21234 "This matters: If you accidentally open a live VM disk image writable then "
21235 "you will cause irreversible disk corruption."
21239 #: ../fish/guestfish.pod:485
21241 "By libguestfs 1.12 we intend to change the default the other way. Disk "
21242 "images will be opened read-only. You will have to either specify "
21243 "I<guestfish --rw>, I<guestmount --rw>, I<virt-rescue --rw>, or change the "
21244 "configuration file C</etc/libguestfs-tools.conf> in order to get write "
21245 "access for disk images specified by those other command line options."
21249 #: ../fish/guestfish.pod:492
21251 "This version of guestfish, guestmount and virt-rescue has a I<--rw> option "
21252 "which does nothing (it is already the default). However it is highly "
21253 "recommended that you use this option to indicate that you need write access, "
21254 "and prepare your scripts for the day when this option will be required for "
21259 #: ../fish/guestfish.pod:498
21261 "B<Note:> This does I<not> affect commands like L</add> and L</mount>, or any "
21262 "other libguestfs program apart from guestfish and guestmount."
21266 #: ../fish/guestfish.pod:501
21271 #: ../fish/guestfish.pod:503
21273 "You can quote ordinary parameters using either single or double quotes. For "
21278 #: ../fish/guestfish.pod:506
21281 " add \"file with a space.img\"\n"
21286 #: ../fish/guestfish.pod:508
21289 " rm '/file name'\n"
21294 #: ../fish/guestfish.pod:510
21302 #: ../fish/guestfish.pod:512
21304 "A few commands require a list of strings to be passed. For these, use a "
21305 "whitespace-separated list, enclosed in quotes. Strings containing "
21306 "whitespace to be passed through must be enclosed in single quotes. A "
21307 "literal single quote must be escaped with a backslash."
21311 #: ../fish/guestfish.pod:517
21314 " vgcreate VG \"/dev/sda1 /dev/sdb1\"\n"
21315 " command \"/bin/echo 'foo bar'\"\n"
21316 " command \"/bin/echo \\'foo\\'\"\n"
21321 #: ../fish/guestfish.pod:521
21322 msgid "ESCAPE SEQUENCES IN DOUBLE QUOTED ARGUMENTS"
21326 #: ../fish/guestfish.pod:523
21328 "In double-quoted arguments (only) use backslash to insert special characters:"
21332 #: ../fish/guestfish.pod:528
21337 #: ../fish/guestfish.pod:530
21338 msgid "Alert (bell) character."
21342 #: ../fish/guestfish.pod:532
21347 #: ../fish/guestfish.pod:534
21348 msgid "Backspace character."
21352 #: ../fish/guestfish.pod:536
21357 #: ../fish/guestfish.pod:538
21358 msgid "Form feed character."
21362 #: ../fish/guestfish.pod:540
21367 #: ../fish/guestfish.pod:542
21368 msgid "Newline character."
21372 #: ../fish/guestfish.pod:544
21377 #: ../fish/guestfish.pod:546
21378 msgid "Carriage return character."
21382 #: ../fish/guestfish.pod:548
21387 #: ../fish/guestfish.pod:550
21388 msgid "Horizontal tab character."
21392 #: ../fish/guestfish.pod:552
21397 #: ../fish/guestfish.pod:554
21398 msgid "Vertical tab character."
21402 #: ../fish/guestfish.pod:556
21407 #: ../fish/guestfish.pod:558
21408 msgid "A literal double quote character."
21412 #: ../fish/guestfish.pod:560
21417 #: ../fish/guestfish.pod:562
21419 "A character with octal value I<ooo>. There must be precisely 3 octal digits "
21424 #: ../fish/guestfish.pod:565
21429 #: ../fish/guestfish.pod:567
21431 "A character with hex value I<hh>. There must be precisely 2 hex digits."
21435 #: ../fish/guestfish.pod:570
21437 "In the current implementation C<\\000> and C<\\x00> cannot be used in "
21442 #: ../fish/guestfish.pod:573
21447 #: ../fish/guestfish.pod:575
21448 msgid "A literal backslash character."
21452 #: ../fish/guestfish.pod:579
21453 msgid "OPTIONAL ARGUMENTS"
21457 #: ../fish/guestfish.pod:581
21459 "Some commands take optional arguments. These arguments appear in this "
21460 "documentation as C<[argname:..]>. You can use them as in these examples:"
21464 #: ../fish/guestfish.pod:585
21467 " add-drive-opts filename\n"
21472 #: ../fish/guestfish.pod:587
21475 " add-drive-opts filename readonly:true\n"
21480 #: ../fish/guestfish.pod:589
21483 " add-drive-opts filename format:qcow2 readonly:false\n"
21488 #: ../fish/guestfish.pod:591
21490 "Each optional argument can appear at most once. All optional arguments must "
21491 "appear after the required ones."
21495 #: ../fish/guestfish.pod:594
21500 #: ../fish/guestfish.pod:596
21502 "This section applies to all commands which can take integers as parameters."
21506 #: ../fish/guestfish.pod:599
21507 msgid "SIZE SUFFIX"
21511 #: ../fish/guestfish.pod:601
21513 "When the command takes a parameter measured in bytes, you can use one of the "
21514 "following suffixes to specify kilobytes, megabytes and larger sizes:"
21518 #: ../fish/guestfish.pod:607
21519 msgid "B<k> or B<K> or B<KiB>"
21523 #: ../fish/guestfish.pod:609
21524 msgid "The size in kilobytes (multiplied by 1024)."
21528 #: ../fish/guestfish.pod:611
21533 #: ../fish/guestfish.pod:613
21534 msgid "The size in SI 1000 byte units."
21538 #: ../fish/guestfish.pod:615
21539 msgid "B<M> or B<MiB>"
21543 #: ../fish/guestfish.pod:617
21544 msgid "The size in megabytes (multiplied by 1048576)."
21548 #: ../fish/guestfish.pod:619
21553 #: ../fish/guestfish.pod:621
21554 msgid "The size in SI 1000000 byte units."
21558 #: ../fish/guestfish.pod:623
21559 msgid "B<G> or B<GiB>"
21563 #: ../fish/guestfish.pod:625
21564 msgid "The size in gigabytes (multiplied by 2**30)."
21568 #: ../fish/guestfish.pod:627
21573 #: ../fish/guestfish.pod:629
21574 msgid "The size in SI 10**9 byte units."
21578 #: ../fish/guestfish.pod:631
21579 msgid "B<T> or B<TiB>"
21583 #: ../fish/guestfish.pod:633
21584 msgid "The size in terabytes (multiplied by 2**40)."
21588 #: ../fish/guestfish.pod:635
21593 #: ../fish/guestfish.pod:637
21594 msgid "The size in SI 10**12 byte units."
21598 #: ../fish/guestfish.pod:639
21599 msgid "B<P> or B<PiB>"
21603 #: ../fish/guestfish.pod:641
21604 msgid "The size in petabytes (multiplied by 2**50)."
21608 #: ../fish/guestfish.pod:643
21613 #: ../fish/guestfish.pod:645
21614 msgid "The size in SI 10**15 byte units."
21618 #: ../fish/guestfish.pod:647
21619 msgid "B<E> or B<EiB>"
21623 #: ../fish/guestfish.pod:649
21624 msgid "The size in exabytes (multiplied by 2**60)."
21628 #: ../fish/guestfish.pod:651
21633 #: ../fish/guestfish.pod:653
21634 msgid "The size in SI 10**18 byte units."
21638 #: ../fish/guestfish.pod:655
21639 msgid "B<Z> or B<ZiB>"
21643 #: ../fish/guestfish.pod:657
21644 msgid "The size in zettabytes (multiplied by 2**70)."
21648 #: ../fish/guestfish.pod:659
21653 #: ../fish/guestfish.pod:661
21654 msgid "The size in SI 10**21 byte units."
21658 #: ../fish/guestfish.pod:663
21659 msgid "B<Y> or B<YiB>"
21663 #: ../fish/guestfish.pod:665
21664 msgid "The size in yottabytes (multiplied by 2**80)."
21668 #: ../fish/guestfish.pod:667
21673 #: ../fish/guestfish.pod:669
21674 msgid "The size in SI 10**24 byte units."
21678 #: ../fish/guestfish.pod:675
21681 " truncate-size /file 1G\n"
21686 #: ../fish/guestfish.pod:677
21687 msgid "would truncate the file to 1 gigabyte."
21691 #: ../fish/guestfish.pod:679
21693 "Be careful because a few commands take sizes in kilobytes or megabytes (eg. "
21694 "the parameter to L</memsize> is specified in megabytes already). Adding a "
21695 "suffix will probably not do what you expect."
21699 #: ../fish/guestfish.pod:683
21700 msgid "OCTAL AND HEXADECIMAL NUMBERS"
21704 #: ../fish/guestfish.pod:685
21706 "For specifying the radix (base) use the C convention: C<0> to prefix an "
21707 "octal number or C<0x> to prefix a hexadecimal number. For example:"
21711 #: ../fish/guestfish.pod:688
21714 " 1234 decimal number 1234\n"
21715 " 02322 octal number, equivalent to decimal 1234\n"
21716 " 0x4d2 hexadecimal number, equivalent to decimal 1234\n"
21721 #: ../fish/guestfish.pod:692
21723 "When using the C<chmod> command, you almost always want to specify an octal "
21724 "number for the mode, and you must prefix it with C<0> (unlike the Unix "
21725 "L<chmod(1)> program):"
21729 #: ../fish/guestfish.pod:696
21732 " chmod 0777 /public # OK\n"
21733 " chmod 777 /public # WRONG! This is mode 777 decimal = 01411 octal.\n"
21738 #: ../fish/guestfish.pod:699
21740 "Commands that return numbers usually print them in decimal, but some "
21741 "commands print numbers in other radices (eg. C<umask> prints the mode in "
21742 "octal, preceeded by C<0>)."
21746 #: ../fish/guestfish.pod:703
21747 msgid "WILDCARDS AND GLOBBING"
21751 #: ../fish/guestfish.pod:705
21753 "Neither guestfish nor the underlying guestfs API performs wildcard expansion "
21754 "(globbing) by default. So for example the following will not do what you "
21759 #: ../fish/guestfish.pod:709
21767 #: ../fish/guestfish.pod:711
21769 "Assuming you don't have a directory called literally C</home/*> then the "
21770 "above command will return an error."
21774 #: ../fish/guestfish.pod:714
21775 msgid "To perform wildcard expansion, use the C<glob> command."
21779 #: ../fish/guestfish.pod:716
21782 " glob rm-rf /home/*\n"
21787 #: ../fish/guestfish.pod:718
21789 "runs C<rm-rf> on each path that matches (ie. potentially running the command "
21790 "many times), equivalent to:"
21794 #: ../fish/guestfish.pod:721
21797 " rm-rf /home/jim\n"
21798 " rm-rf /home/joe\n"
21799 " rm-rf /home/mary\n"
21804 #: ../fish/guestfish.pod:725
21805 msgid "C<glob> only works on simple guest paths and not on device names."
21809 #: ../fish/guestfish.pod:727
21811 "If you have several parameters, each containing a wildcard, then glob will "
21812 "perform a Cartesian product."
21816 #: ../fish/guestfish.pod:730
21821 #: ../fish/guestfish.pod:732
21823 "Any line which starts with a I<#> character is treated as a comment and "
21824 "ignored. The I<#> can optionally be preceeded by whitespace, but B<not> by "
21825 "a command. For example:"
21829 #: ../fish/guestfish.pod:736
21832 " # this is a comment\n"
21833 " # this is a comment\n"
21834 " foo # NOT a comment\n"
21839 #: ../fish/guestfish.pod:740
21840 msgid "Blank lines are also ignored."
21844 #: ../fish/guestfish.pod:742
21845 msgid "RUNNING COMMANDS LOCALLY"
21849 #: ../fish/guestfish.pod:744
21851 "Any line which starts with a I<!> character is treated as a command sent to "
21852 "the local shell (C</bin/sh> or whatever L<system(3)> uses). For example:"
21856 #: ../fish/guestfish.pod:748
21860 " tgz-out /remote local/remote-data.tar.gz\n"
21865 #: ../fish/guestfish.pod:751
21867 "will create a directory C<local> on the host, and then export the contents "
21868 "of C</remote> on the mounted filesystem to C<local/remote-data.tar.gz>. "
21869 "(See C<tgz-out>)."
21873 #: ../fish/guestfish.pod:755
21875 "To change the local directory, use the C<lcd> command. C<!cd> will have no "
21876 "effect, due to the way that subprocesses work in Unix."
21880 #: ../fish/guestfish.pod:758
21881 msgid "LOCAL COMMANDS WITH INLINE EXECUTION"
21885 #: ../fish/guestfish.pod:760
21887 "If a line starts with I<E<lt>!> then the shell command is executed (as for "
21888 "I<!>), but subsequently any output (stdout) of the shell command is parsed "
21889 "and executed as guestfish commands."
21893 #: ../fish/guestfish.pod:764
21895 "Thus you can use shell script to construct arbitrary guestfish commands "
21896 "which are then parsed by guestfish."
21900 #: ../fish/guestfish.pod:767
21902 "For example it is tedious to create a sequence of files (eg. C</foo.1> "
21903 "through C</foo.100>) using guestfish commands alone. However this is simple "
21904 "if we use a shell script to create the guestfish commands for us:"
21908 #: ../fish/guestfish.pod:772
21911 " <! for n in `seq 1 100`; do echo write /foo.$n $n; done\n"
21916 #: ../fish/guestfish.pod:774
21917 msgid "or with names like C</foo.001>:"
21921 #: ../fish/guestfish.pod:776
21924 " <! for n in `seq 1 100`; do printf \"write /foo.%03d %d\\n\" $n $n; done\n"
21929 #: ../fish/guestfish.pod:778
21931 "When using guestfish interactively it can be helpful to just run the shell "
21932 "script first (ie. remove the initial C<E<lt>> character so it is just an "
21933 "ordinary I<!> local command), see what guestfish commands it would run, and "
21934 "when you are happy with those prepend the C<E<lt>> character to run the "
21935 "guestfish commands for real."
21939 #: ../fish/guestfish.pod:784
21944 #: ../fish/guestfish.pod:786
21946 "Use C<command E<lt>spaceE<gt> | command> to pipe the output of the first "
21947 "command (a guestfish command) to the second command (any host command). For "
21952 #: ../fish/guestfish.pod:790
21955 " cat /etc/passwd | awk -F: '$3 == 0 { print }'\n"
21960 #: ../fish/guestfish.pod:792
21962 "(where C<cat> is the guestfish cat command, but C<awk> is the host awk "
21963 "program). The above command would list all accounts in the guest filesystem "
21964 "which have UID 0, ie. root accounts including backdoors. Other examples:"
21968 #: ../fish/guestfish.pod:797
21971 " hexdump /bin/ls | head\n"
21972 " list-devices | tail -1\n"
21973 " tgz-out / - | tar ztf -\n"
21978 #: ../fish/guestfish.pod:801
21980 "The space before the pipe symbol is required, any space after the pipe "
21981 "symbol is optional. Everything after the pipe symbol is just passed "
21982 "straight to the host shell, so it can contain redirections, globs and "
21983 "anything else that makes sense on the host side."
21987 #: ../fish/guestfish.pod:806
21989 "To use a literal argument which begins with a pipe symbol, you have to quote "
21994 #: ../fish/guestfish.pod:809
22002 #: ../fish/guestfish.pod:811
22003 msgid "HOME DIRECTORIES"
22007 #: ../fish/guestfish.pod:813
22009 "If a parameter starts with the character C<~> then the tilde may be expanded "
22010 "as a home directory path (either C<~> for the current user's home directory, "
22011 "or C<~user> for another user)."
22015 #: ../fish/guestfish.pod:817
22017 "Note that home directory expansion happens for users known I<on the host>, "
22018 "not in the guest filesystem."
22022 #: ../fish/guestfish.pod:820
22024 "To use a literal argument which begins with a tilde, you have to quote it, "
22029 #: ../fish/guestfish.pod:823
22037 #: ../fish/guestfish.pod:827
22039 "Libguestfs has some support for Linux guests encrypted according to the "
22040 "Linux Unified Key Setup (LUKS) standard, which includes nearly all whole "
22041 "disk encryption systems used by modern Linux guests. Currently only LVM-on-"
22042 "LUKS is supported."
22046 #: ../fish/guestfish.pod:832
22047 msgid "Identify encrypted block devices and partitions using L</vfs-type>:"
22051 #: ../fish/guestfish.pod:834
22054 " ><fs> vfs-type /dev/sda2\n"
22060 #: ../fish/guestfish.pod:837
22062 "Then open those devices using L</luks-open>. This creates a device-mapper "
22063 "device called C</dev/mapper/luksdev>."
22067 #: ../fish/guestfish.pod:840
22070 " ><fs> luks-open /dev/sda2 luksdev\n"
22071 " Enter key or passphrase (\"key\"): <enter the passphrase>\n"
22076 #: ../fish/guestfish.pod:843
22078 "Finally you have to tell LVM to scan for volume groups on the newly created "
22083 #: ../fish/guestfish.pod:846
22087 " vg-activate-all true\n"
22092 #: ../fish/guestfish.pod:849
22093 msgid "The logical volume(s) can now be mounted in the usual way."
22097 #: ../fish/guestfish.pod:851
22099 "Before closing a LUKS device you must unmount any logical volumes on it and "
22100 "deactivate the volume groups by calling C<vg-activate false VG> on each "
22101 "one. Then you can close the mapper device:"
22105 #: ../fish/guestfish.pod:855
22108 " vg-activate false /dev/VG\n"
22109 " luks-close /dev/mapper/luksdev\n"
22114 #: ../fish/guestfish.pod:858
22115 msgid "WINDOWS PATHS"
22119 #: ../fish/guestfish.pod:860
22121 "If a path is prefixed with C<win:> then you can use Windows-style drive "
22122 "letters and paths (with some limitations). The following commands are "
22127 #: ../fish/guestfish.pod:864
22130 " file /WINDOWS/system32/config/system.LOG\n"
22135 #: ../fish/guestfish.pod:866
22138 " file win:\\windows\\system32\\config\\system.log\n"
22143 #: ../fish/guestfish.pod:868
22146 " file WIN:C:\\Windows\\SYSTEM32\\CONFIG\\SYSTEM.LOG\n"
22151 #: ../fish/guestfish.pod:870
22153 "The parameter is rewritten \"behind the scenes\" by looking up the position "
22154 "where the drive is mounted, prepending that to the path, changing all "
22155 "backslash characters to forward slash, then resolving the result using L</"
22156 "case-sensitive-path>. For example if the E: drive was mounted on C</e> then "
22157 "the parameter might be rewritten like this:"
22161 #: ../fish/guestfish.pod:876
22164 " win:e:\\foo\\bar => /e/FOO/bar\n"
22169 #: ../fish/guestfish.pod:878
22170 msgid "This only works in argument positions that expect a path."
22174 #: ../fish/guestfish.pod:880
22175 msgid "UPLOADING AND DOWNLOADING FILES"
22179 #: ../fish/guestfish.pod:882
22181 "For commands such as C<upload>, C<download>, C<tar-in>, C<tar-out> and "
22182 "others which upload from or download to a local file, you can use the "
22183 "special filename C<-> to mean \"from stdin\" or \"to stdout\". For example:"
22187 #: ../fish/guestfish.pod:886
22195 #: ../fish/guestfish.pod:888
22197 "reads stdin and creates from that a file C</foo> in the disk image, and:"
22201 #: ../fish/guestfish.pod:891
22204 " tar-out /etc - | tar tf -\n"
22209 #: ../fish/guestfish.pod:893
22211 "writes the tarball to stdout and then pipes that into the external \"tar\" "
22212 "command (see L</PIPES>)."
22216 #: ../fish/guestfish.pod:896
22218 "When using C<-> to read from stdin, the input is read up to the end of "
22219 "stdin. You can also use a special \"heredoc\"-like syntax to read up to "
22220 "some arbitrary end marker:"
22224 #: ../fish/guestfish.pod:900
22227 " upload -<<END /foo\n"
22236 #: ../fish/guestfish.pod:906
22238 "Any string of characters can be used instead of C<END>. The end marker must "
22239 "appear on a line of its own, without any preceeding or following characters "
22240 "(not even spaces)."
22244 #: ../fish/guestfish.pod:910
22246 "Note that the C<-E<lt>E<lt>> syntax only applies to parameters used to "
22247 "upload local files (so-called \"FileIn\" parameters in the generator)."
22251 #: ../fish/guestfish.pod:913
22252 msgid "EXIT ON ERROR BEHAVIOUR"
22256 #: ../fish/guestfish.pod:915
22258 "By default, guestfish will ignore any errors when in interactive mode (ie. "
22259 "taking commands from a human over a tty), and will exit on the first error "
22260 "in non-interactive mode (scripts, commands given on the command line)."
22264 #: ../fish/guestfish.pod:920
22266 "If you prefix a command with a I<-> character, then that command will not "
22267 "cause guestfish to exit, even if that (one) command returns an error."
22271 #: ../fish/guestfish.pod:924
22272 msgid "REMOTE CONTROL GUESTFISH OVER A SOCKET"
22276 #: ../fish/guestfish.pod:926
22278 "Guestfish can be remote-controlled over a socket. This is useful "
22279 "particularly in shell scripts where you want to make several different "
22280 "changes to a filesystem, but you don't want the overhead of starting up a "
22281 "guestfish process each time."
22285 #: ../fish/guestfish.pod:931
22286 msgid "Start a guestfish server process using:"
22290 #: ../fish/guestfish.pod:933
22293 " eval \"`guestfish --listen`\"\n"
22298 #: ../fish/guestfish.pod:935
22299 msgid "and then send it commands by doing:"
22303 #: ../fish/guestfish.pod:937
22306 " guestfish --remote cmd [...]\n"
22311 #: ../fish/guestfish.pod:939
22312 msgid "To cause the server to exit, send it the exit command:"
22316 #: ../fish/guestfish.pod:941
22319 " guestfish --remote exit\n"
22324 #: ../fish/guestfish.pod:943
22326 "Note that the server will normally exit if there is an error in a command. "
22327 "You can change this in the usual way. See section L</EXIT ON ERROR "
22332 #: ../fish/guestfish.pod:947
22333 msgid "CONTROLLING MULTIPLE GUESTFISH PROCESSES"
22337 #: ../fish/guestfish.pod:949
22339 "The C<eval> statement sets the environment variable C<$GUESTFISH_PID>, which "
22340 "is how the I<--remote> option knows where to send the commands. You can "
22341 "have several guestfish listener processes running using:"
22345 #: ../fish/guestfish.pod:953
22348 " eval \"`guestfish --listen`\"\n"
22349 " pid1=$GUESTFISH_PID\n"
22350 " eval \"`guestfish --listen`\"\n"
22351 " pid2=$GUESTFISH_PID\n"
22353 " guestfish --remote=$pid1 cmd\n"
22354 " guestfish --remote=$pid2 cmd\n"
22359 #: ../fish/guestfish.pod:961
22360 msgid "REMOTE CONTROL AND CSH"
22364 #: ../fish/guestfish.pod:963
22366 "When using csh-like shells (csh, tcsh etc) you have to add the I<--csh> "
22371 #: ../fish/guestfish.pod:966
22374 " eval \"`guestfish --listen --csh`\"\n"
22379 #: ../fish/guestfish.pod:968
22380 msgid "REMOTE CONTROL DETAILS"
22384 #: ../fish/guestfish.pod:970
22386 "Remote control happens over a Unix domain socket called C</tmp/.guestfish-"
22387 "$UID/socket-$PID>, where C<$UID> is the effective user ID of the process, "
22388 "and C<$PID> is the process ID of the server."
22392 #: ../fish/guestfish.pod:974
22393 msgid "Guestfish client and server versions must match exactly."
22397 #: ../fish/guestfish.pod:976
22398 msgid "PREPARED DISK IMAGES"
22402 #: ../fish/guestfish.pod:978
22404 "Use the I<-N type> or I<--new type> parameter to select one of a set of "
22405 "preformatted disk images that guestfish can make for you to save typing. "
22406 "This is particularly useful for testing purposes. This option is used "
22407 "instead of the I<-a> option, and like I<-a> can appear multiple times (and "
22408 "can be mixed with I<-a>)."
22412 #: ../fish/guestfish.pod:984
22414 "The new disk is called C<test1.img> for the first I<-N>, C<test2.img> for "
22415 "the second and so on. Existing files in the current directory are "
22420 #: ../fish/guestfish.pod:988
22422 "The type briefly describes how the disk should be sized, partitioned, how "
22423 "filesystem(s) should be created, and how content should be added. "
22424 "Optionally the type can be followed by extra parameters, separated by C<:> "
22425 "(colon) characters. For example, I<-N fs> creates a default 100MB, sparsely-"
22426 "allocated disk, containing a single partition, with the partition formatted "
22427 "as ext2. I<-N fs:ext4:1G> is the same, but for an ext4 filesystem on a 1GB "
22432 #: ../fish/guestfish.pod:996
22433 msgid "To list the available types and any extra parameters they take, run:"
22437 #: ../fish/guestfish.pod:1000
22439 "Note that the prepared filesystem is not mounted. You would usually have to "
22440 "use the C<mount /dev/sda1 /> command or add the I<-m /dev/sda1> option."
22444 #: ../fish/guestfish.pod:1004
22446 "If any I<-N> or I<--new> options are given, the guest is automatically "
22451 #: ../fish/guestfish.pod:1009
22452 msgid "Create a 100MB disk with an ext4-formatted partition:"
22456 #: ../fish/guestfish.pod:1011
22459 " guestfish -N fs:ext4\n"
22464 #: ../fish/guestfish.pod:1013
22465 msgid "Create a 32MB disk with a VFAT-formatted partition, and mount it:"
22469 #: ../fish/guestfish.pod:1015
22472 " guestfish -N fs:vfat:32M -m /dev/sda1\n"
22477 #: ../fish/guestfish.pod:1017
22478 msgid "Create a blank 200MB disk:"
22482 #: ../fish/guestfish.pod:1019
22485 " guestfish -N disk:200M\n"
22490 #: ../fish/guestfish.pod:1021
22491 msgid "PROGRESS BARS"
22495 #: ../fish/guestfish.pod:1023
22497 "Some (not all) long-running commands send progress notification messages as "
22498 "they are running. Guestfish turns these messages into progress bars."
22502 #: ../fish/guestfish.pod:1027
22504 "When a command that supports progress bars takes longer than two seconds to "
22505 "run, and if progress bars are enabled, then you will see one appearing below "
22510 #: ../fish/guestfish.pod:1031
22513 " ><fs> copy-size /large-file /another-file 2048M\n"
22514 " / 10% [#####-----------------------------------------] 00:30\n"
22519 #: ../fish/guestfish.pod:1034
22521 "The spinner on the left hand side moves round once for every progress "
22522 "notification received from the backend. This is a (reasonably) golden "
22523 "assurance that the command is \"doing something\" even if the progress bar "
22524 "is not moving, because the command is able to send the progress "
22525 "notifications. When the bar reaches 100% and the command finishes, the "
22526 "spinner disappears."
22530 #: ../fish/guestfish.pod:1041
22532 "Progress bars are enabled by default when guestfish is used interactively. "
22533 "You can enable them even for non-interactive modes using I<--progress-bars>, "
22534 "and you can disable them completely using I<--no-progress-bars>."
22538 #: ../fish/guestfish.pod:1046
22539 msgid "GUESTFISH COMMANDS"
22543 #: ../fish/guestfish.pod:1048
22545 "The commands in this section are guestfish convenience commands, in other "
22546 "words, they are not part of the L<guestfs(3)> API."
22550 #: ../fish/guestfish.pod:1051
22555 #: ../fish/guestfish.pod:1053
22564 #: ../fish/guestfish.pod:1056
22565 msgid "Without any parameter, this provides general help."
22569 #: ../fish/guestfish.pod:1058
22570 msgid "With a C<cmd> parameter, this displays detailed help for that command."
22574 #: ../fish/guestfish.pod:1060
22575 msgid "quit | exit"
22579 #: ../fish/guestfish.pod:1062
22580 msgid "This exits guestfish. You can also use C<^D> key."
22584 #: ../fish/guestfish.pod:1064
22585 msgid "@FISH_COMMANDS@"
22589 #: ../fish/guestfish.pod:1066
22594 #: ../fish/guestfish.pod:1070 ../test-tool/libguestfs-test-tool.pod:77
22599 #: ../fish/guestfish.pod:1072
22601 "guestfish returns 0 if the commands completed without error, or 1 if there "
22606 #: ../fish/guestfish.pod:1079
22611 #: ../fish/guestfish.pod:1081
22613 "The C<edit> command uses C<$EDITOR> as the editor. If not set, it uses "
22618 #: ../fish/guestfish.pod:1084
22619 msgid "GUESTFISH_DISPLAY_IMAGE"
22623 #: ../fish/guestfish.pod:1086
22625 "The C<display> command uses C<$GUESTFISH_DISPLAY_IMAGE> to display images. "
22626 "If not set, it uses L<display(1)>."
22630 #: ../fish/guestfish.pod:1089
22631 msgid "GUESTFISH_PID"
22635 #: ../fish/guestfish.pod:1091
22637 "Used with the I<--remote> option to specify the remote guestfish process to "
22638 "control. See section L</REMOTE CONTROL GUESTFISH OVER A SOCKET>."
22642 #: ../fish/guestfish.pod:1095
22647 #: ../fish/guestfish.pod:1097
22649 "The L</hexedit> command uses C<$HEXEDITOR> as the external hex editor. If "
22650 "not specified, the external L<hexedit(1)> program is used."
22654 #: ../fish/guestfish.pod:1101
22659 #: ../fish/guestfish.pod:1103
22661 "If compiled with GNU readline support, various files in the home directory "
22662 "can be used. See L</FILES>."
22666 #: ../fish/guestfish.pod:1112
22668 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
22669 "effect as using the B<-v> option."
22673 #: ../fish/guestfish.pod:1124
22675 "Set the path that guestfish uses to search for kernel and initrd.img. See "
22676 "the discussion of paths in L<guestfs(3)>."
22680 #: ../fish/guestfish.pod:1135
22681 msgid "Set C<LIBGUESTFS_TRACE=1> to enable command traces."
22685 #: ../fish/guestfish.pod:1137
22690 #: ../fish/guestfish.pod:1139
22692 "The C<more> command uses C<$PAGER> as the pager. If not set, it uses "
22697 #: ../fish/guestfish.pod:1155 ../fuse/guestmount.pod:264
22702 #: ../fish/guestfish.pod:1159 ../fuse/guestmount.pod:268
22703 msgid "$HOME/.libguestfs-tools.rc"
22707 #: ../fish/guestfish.pod:1161 ../fuse/guestmount.pod:270
22708 msgid "/etc/libguestfs-tools.conf"
22712 #: ../fish/guestfish.pod:1163 ../fuse/guestmount.pod:272
22714 "This configuration file controls the default read-only or read-write mode "
22715 "(I<--ro> or I<--rw>)."
22719 #: ../fish/guestfish.pod:1166
22720 msgid "See L</OPENING DISKS FOR READ AND WRITE>."
22724 #: ../fish/guestfish.pod:1168
22725 msgid "$HOME/.guestfish"
22729 #: ../fish/guestfish.pod:1170
22731 "If compiled with GNU readline support, then the command history is saved in "
22736 #: ../fish/guestfish.pod:1173
22737 msgid "$HOME/.inputrc"
22741 #: ../fish/guestfish.pod:1175
22742 msgid "/etc/inputrc"
22746 #: ../fish/guestfish.pod:1177
22748 "If compiled with GNU readline support, then these files can be used to "
22749 "configure readline. For further information, please see L<readline(3)/"
22750 "INITIALIZATION FILE>."
22754 #: ../fish/guestfish.pod:1181
22755 msgid "To write rules which only apply to guestfish, use:"
22759 #: ../fish/guestfish.pod:1183
22769 #: ../fish/guestfish.pod:1187
22771 "Variables that you can set in inputrc that change the behaviour of guestfish "
22772 "in useful ways include:"
22776 #: ../fish/guestfish.pod:1192
22777 msgid "completion-ignore-case (default: on)"
22781 #: ../fish/guestfish.pod:1194
22783 "By default, guestfish will ignore case when tab-completing paths on the "
22788 #: ../fish/guestfish.pod:1197
22791 " set completion-ignore-case off\n"
22796 #: ../fish/guestfish.pod:1199
22797 msgid "to make guestfish case sensitive."
22801 #: ../fish/guestfish.pod:1203
22806 #: ../fish/guestfish.pod:1205
22807 msgid "test2.img (etc)"
22811 #: ../fish/guestfish.pod:1207
22813 "When using the I<-N> or I<--new> option, the prepared disk or filesystem "
22814 "will be created in the file C<test1.img> in the current directory. The "
22815 "second use of I<-N> will use C<test2.img> and so on. Any existing file with "
22816 "the same name will be overwritten."
22820 #: ../fish/guestfish.pod:1216
22822 "L<guestfs(3)>, L<http://libguestfs.org/>, L<virt-cat(1)>, L<virt-copy-in(1)"
22823 ">, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, L<virt-filesystems(1)"
22824 ">, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, L<virt-list-partitions"
22825 "(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, L<virt-rescue(1)>, L<virt-resize(1)"
22826 ">, L<virt-tar(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<virt-win-reg(1)"
22827 ">, L<display(1)>, L<hexedit(1)>."
22831 #: ../fish/guestfish.pod:1247 ../test-tool/libguestfs-test-tool.pod:102
22832 #: ../fuse/guestmount.pod:299 ../tools/virt-win-reg.pl:778
22833 #: ../tools/virt-list-filesystems.pl:210 ../tools/virt-tar.pl:309
22834 #: ../tools/virt-make-fs.pl:572 ../tools/virt-list-partitions.pl:277
22836 "This program is free software; you can redistribute it and/or modify it "
22837 "under the terms of the GNU General Public License as published by the Free "
22838 "Software Foundation; either version 2 of the License, or (at your option) "
22839 "any later version."
22843 #: ../fish/guestfish.pod:1252 ../test-tool/libguestfs-test-tool.pod:107
22844 #: ../fuse/guestmount.pod:304 ../tools/virt-win-reg.pl:783
22845 #: ../tools/virt-list-filesystems.pl:215 ../tools/virt-tar.pl:314
22846 #: ../tools/virt-make-fs.pl:577 ../tools/virt-list-partitions.pl:282
22848 "This program is distributed in the hope that it will be useful, but WITHOUT "
22849 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
22850 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for "
22855 #: ../fish/guestfish.pod:1257 ../test-tool/libguestfs-test-tool.pod:112
22856 #: ../fuse/guestmount.pod:309 ../tools/virt-win-reg.pl:788
22857 #: ../tools/virt-list-filesystems.pl:220 ../tools/virt-tar.pl:319
22858 #: ../tools/virt-make-fs.pl:582 ../tools/virt-list-partitions.pl:287
22860 "You should have received a copy of the GNU General Public License along with "
22861 "this program; if not, write to the Free Software Foundation, Inc., 675 Mass "
22862 "Ave, Cambridge, MA 02139, USA."
22866 #: ../fish/guestfish-actions.pod:1
22871 #: ../fish/guestfish-actions.pod:3
22874 " add-cdrom filename\n"
22879 #: ../fish/guestfish-actions.pod:15
22881 "This call checks for the existence of C<filename>. This stops you from "
22882 "specifying other types of drive which are supported by qemu such as C<nbd:> "
22883 "and C<http:> URLs. To specify those, use the general L</config> call "
22888 #: ../fish/guestfish-actions.pod:22
22890 "If you just want to add an ISO file (often you use this as an efficient way "
22891 "to transfer large files into the guest), then you should probably use L</add-"
22892 "drive-ro> instead."
22896 #: ../fish/guestfish-actions.pod:35
22901 #: ../fish/guestfish-actions.pod:37
22906 #: ../fish/guestfish-actions.pod:39
22909 " add-domain dom [libvirturi:..] [readonly:..] [iface:..] [live:..] [allowuuid:..]\n"
22914 #: ../fish/guestfish-actions.pod:41
22916 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
22917 "It works by connecting to libvirt, requesting the domain and domain XML from "
22918 "libvirt, parsing it for disks, and calling L</add-drive-opts> on each one."
22922 #: ../fish/guestfish-actions.pod:76
22924 "The other optional parameters are passed directly through to L</add-drive-"
22929 #: ../fish/guestfish-actions.pod:79 ../fish/guestfish-actions.pod:143
22930 #: ../fish/guestfish-actions.pod:568 ../fish/guestfish-actions.pod:1968
22931 #: ../fish/guestfish-actions.pod:3134 ../fish/guestfish-actions.pod:3307
22932 #: ../fish/guestfish-actions.pod:3442
22934 "This command has one or more optional arguments. See L</OPTIONAL ARGUMENTS>."
22938 #: ../fish/guestfish-actions.pod:81
22943 #: ../fish/guestfish-actions.pod:83
22946 " add-drive filename\n"
22951 #: ../fish/guestfish-actions.pod:85
22953 "This function is the equivalent of calling L</add-drive-opts> with no "
22954 "optional parameters, so the disk is added writable, with the format being "
22955 "detected automatically."
22959 #: ../fish/guestfish-actions.pod:89
22961 "Automatic detection of the format opens you up to a potential security hole "
22962 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
22963 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
22964 "you should think about replacing calls to this function with calls to L</add-"
22965 "drive-opts>, and specifying the format."
22969 #: ../fish/guestfish-actions.pod:96
22970 msgid "add-drive-opts"
22974 #: ../fish/guestfish-actions.pod:98
22979 #: ../fish/guestfish-actions.pod:100
22982 " add-drive-opts filename [readonly:..] [format:..] [iface:..]\n"
22987 #: ../fish/guestfish-actions.pod:127
22989 "This forces the image format. If you omit this (or use L</add-drive> or L</"
22990 "add-drive-ro>) then the format is automatically detected. Possible formats "
22991 "include C<raw> and C<qcow2>."
22995 #: ../fish/guestfish-actions.pod:138
22997 "This rarely-used option lets you emulate the behaviour of the deprecated L</"
22998 "add-drive-with-if> call (q.v.)"
23002 #: ../fish/guestfish-actions.pod:145
23003 msgid "add-drive-ro"
23007 #: ../fish/guestfish-actions.pod:147
23012 #: ../fish/guestfish-actions.pod:149
23015 " add-drive-ro filename\n"
23020 #: ../fish/guestfish-actions.pod:151
23022 "This function is the equivalent of calling L</add-drive-opts> with the "
23023 "optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the disk "
23024 "is added read-only, with the format being detected automatically."
23028 #: ../fish/guestfish-actions.pod:156
23029 msgid "add-drive-ro-with-if"
23033 #: ../fish/guestfish-actions.pod:158
23036 " add-drive-ro-with-if filename iface\n"
23041 #: ../fish/guestfish-actions.pod:160
23043 "This is the same as L</add-drive-ro> but it allows you to specify the QEMU "
23044 "interface emulation to use at run time."
23048 #: ../fish/guestfish-actions.pod:170
23049 msgid "add-drive-with-if"
23053 #: ../fish/guestfish-actions.pod:172
23056 " add-drive-with-if filename iface\n"
23061 #: ../fish/guestfish-actions.pod:174
23063 "This is the same as L</add-drive> but it allows you to specify the QEMU "
23064 "interface emulation to use at run time."
23068 #: ../fish/guestfish-actions.pod:184
23073 #: ../fish/guestfish-actions.pod:186
23076 " aug-clear augpath\n"
23081 #: ../fish/guestfish-actions.pod:191
23086 #: ../fish/guestfish-actions.pod:193
23094 #: ../fish/guestfish-actions.pod:195
23096 "Close the current Augeas handle and free up any resources used by it. After "
23097 "calling this, you have to call L</aug-init> again before you can use any "
23098 "other Augeas functions."
23102 #: ../fish/guestfish-actions.pod:200
23103 msgid "aug-defnode"
23107 #: ../fish/guestfish-actions.pod:202
23110 " aug-defnode name expr val\n"
23115 #: ../fish/guestfish-actions.pod:207
23117 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
23118 "calling L</aug-set> C<expr>, C<value>. C<name> will be the nodeset "
23119 "containing that single node."
23123 #: ../fish/guestfish-actions.pod:215
23128 #: ../fish/guestfish-actions.pod:217
23131 " aug-defvar name expr\n"
23136 #: ../fish/guestfish-actions.pod:226
23141 #: ../fish/guestfish-actions.pod:228
23144 " aug-get augpath\n"
23149 #: ../fish/guestfish-actions.pod:233
23154 #: ../fish/guestfish-actions.pod:235
23157 " aug-init root flags\n"
23162 #: ../fish/guestfish-actions.pod:241
23163 msgid "You must call this before using any other L</aug-*> commands."
23167 #: ../fish/guestfish-actions.pod:276
23168 msgid "Do not load the tree in L</aug-init>."
23172 #: ../fish/guestfish-actions.pod:280
23173 msgid "To close the handle, you can call L</aug-close>."
23177 #: ../fish/guestfish-actions.pod:284
23182 #: ../fish/guestfish-actions.pod:286
23185 " aug-insert augpath label true|false\n"
23190 #: ../fish/guestfish-actions.pod:296
23195 #: ../fish/guestfish-actions.pod:298
23203 #: ../fish/guestfish-actions.pod:305
23208 #: ../fish/guestfish-actions.pod:307
23211 " aug-ls augpath\n"
23216 #: ../fish/guestfish-actions.pod:309
23218 "This is just a shortcut for listing L</aug-match> C<path/*> and sorting the "
23219 "resulting nodes into alphabetical order."
23223 #: ../fish/guestfish-actions.pod:312
23228 #: ../fish/guestfish-actions.pod:314
23231 " aug-match augpath\n"
23236 #: ../fish/guestfish-actions.pod:320
23241 #: ../fish/guestfish-actions.pod:322
23244 " aug-mv src dest\n"
23249 #: ../fish/guestfish-actions.pod:327
23254 #: ../fish/guestfish-actions.pod:329
23257 " aug-rm augpath\n"
23262 #: ../fish/guestfish-actions.pod:335
23267 #: ../fish/guestfish-actions.pod:337
23275 #: ../fish/guestfish-actions.pod:341
23277 "The flags which were passed to L</aug-init> affect exactly how files are "
23282 #: ../fish/guestfish-actions.pod:344
23287 #: ../fish/guestfish-actions.pod:346
23290 " aug-set augpath val\n"
23295 #: ../fish/guestfish-actions.pod:350
23297 "In the Augeas API, it is possible to clear a node by setting the value to "
23298 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
23299 "this call. Instead you must use the L</aug-clear> call."
23303 #: ../fish/guestfish-actions.pod:355
23308 #: ../fish/guestfish-actions.pod:357
23311 " available 'groups ...'\n"
23316 #: ../fish/guestfish-actions.pod:363
23318 "The libguestfs groups, and the functions that those groups correspond to, "
23319 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
23320 "runtime by calling L</available-all-groups>."
23324 #: ../fish/guestfish-actions.pod:387
23325 msgid "You must call L</launch> before calling this function."
23329 #: ../fish/guestfish-actions.pod:409
23331 "This call was added in version C<1.0.80>. In previous versions of "
23332 "libguestfs all you could do would be to speculatively execute a command to "
23333 "find out if the daemon implemented it. See also L</version>."
23337 #: ../fish/guestfish-actions.pod:416
23338 msgid "available-all-groups"
23342 #: ../fish/guestfish-actions.pod:418
23345 " available-all-groups\n"
23350 #: ../fish/guestfish-actions.pod:420
23352 "This command returns a list of all optional groups that this daemon knows "
23353 "about. Note this returns both supported and unsupported groups. To find "
23354 "out which ones the daemon can actually support you have to call L</"
23355 "available> on each member of the returned list."
23359 #: ../fish/guestfish-actions.pod:426
23360 msgid "See also L</available> and L<guestfs(3)/AVAILABILITY>."
23364 #: ../fish/guestfish-actions.pod:428
23369 #: ../fish/guestfish-actions.pod:430
23372 " base64-in (base64file|-) filename\n"
23377 #: ../fish/guestfish-actions.pod:435 ../fish/guestfish-actions.pod:444
23378 #: ../fish/guestfish-actions.pod:693 ../fish/guestfish-actions.pod:862
23379 #: ../fish/guestfish-actions.pod:881 ../fish/guestfish-actions.pod:1255
23380 #: ../fish/guestfish-actions.pod:4652 ../fish/guestfish-actions.pod:4664
23381 #: ../fish/guestfish-actions.pod:4675 ../fish/guestfish-actions.pod:4686
23382 #: ../fish/guestfish-actions.pod:4738 ../fish/guestfish-actions.pod:4747
23383 #: ../fish/guestfish-actions.pod:4801 ../fish/guestfish-actions.pod:4824
23384 msgid "Use C<-> instead of a filename to read/write from stdin/stdout."
23388 #: ../fish/guestfish-actions.pod:437
23393 #: ../fish/guestfish-actions.pod:439
23396 " base64-out filename (base64file|-)\n"
23401 #: ../fish/guestfish-actions.pod:446
23402 msgid "blockdev-flushbufs"
23406 #: ../fish/guestfish-actions.pod:448
23409 " blockdev-flushbufs device\n"
23414 #: ../fish/guestfish-actions.pod:455
23415 msgid "blockdev-getbsz"
23419 #: ../fish/guestfish-actions.pod:457
23422 " blockdev-getbsz device\n"
23427 #: ../fish/guestfish-actions.pod:466
23428 msgid "blockdev-getro"
23432 #: ../fish/guestfish-actions.pod:468
23435 " blockdev-getro device\n"
23440 #: ../fish/guestfish-actions.pod:475
23441 msgid "blockdev-getsize64"
23445 #: ../fish/guestfish-actions.pod:477
23448 " blockdev-getsize64 device\n"
23453 #: ../fish/guestfish-actions.pod:481
23454 msgid "See also L</blockdev-getsz>."
23458 #: ../fish/guestfish-actions.pod:485
23459 msgid "blockdev-getss"
23463 #: ../fish/guestfish-actions.pod:487
23466 " blockdev-getss device\n"
23471 #: ../fish/guestfish-actions.pod:492
23473 "(Note, this is not the size in sectors, use L</blockdev-getsz> for that)."
23477 #: ../fish/guestfish-actions.pod:497
23478 msgid "blockdev-getsz"
23482 #: ../fish/guestfish-actions.pod:499
23485 " blockdev-getsz device\n"
23490 #: ../fish/guestfish-actions.pod:504
23492 "See also L</blockdev-getss> for the real sector size of the device, and L</"
23493 "blockdev-getsize64> for the more useful I<size in bytes>."
23497 #: ../fish/guestfish-actions.pod:510
23498 msgid "blockdev-rereadpt"
23502 #: ../fish/guestfish-actions.pod:512
23505 " blockdev-rereadpt device\n"
23510 #: ../fish/guestfish-actions.pod:518
23511 msgid "blockdev-setbsz"
23515 #: ../fish/guestfish-actions.pod:520
23518 " blockdev-setbsz device blocksize\n"
23523 #: ../fish/guestfish-actions.pod:529
23524 msgid "blockdev-setro"
23528 #: ../fish/guestfish-actions.pod:531
23531 " blockdev-setro device\n"
23536 #: ../fish/guestfish-actions.pod:537
23537 msgid "blockdev-setrw"
23541 #: ../fish/guestfish-actions.pod:539
23544 " blockdev-setrw device\n"
23549 #: ../fish/guestfish-actions.pod:545
23550 msgid "btrfs-filesystem-resize"
23554 #: ../fish/guestfish-actions.pod:547
23557 " btrfs-filesystem-resize mountpoint [size:..]\n"
23562 #: ../fish/guestfish-actions.pod:570
23563 msgid "case-sensitive-path"
23567 #: ../fish/guestfish-actions.pod:572
23570 " case-sensitive-path path\n"
23575 #: ../fish/guestfish-actions.pod:596
23577 "Thus L</case-sensitive-path> (\"/Windows/System32\") might return C<\"/"
23578 "WINDOWS/system32\"> (the exact return value would depend on details of how "
23579 "the directories were originally created under Windows)."
23583 #: ../fish/guestfish-actions.pod:604
23584 msgid "See also L</realpath>."
23588 #: ../fish/guestfish-actions.pod:606
23593 #: ../fish/guestfish-actions.pod:608
23601 #: ../fish/guestfish-actions.pod:612
23603 "Note that this function cannot correctly handle binary files (specifically, "
23604 "files containing C<\\0> character which is treated as end of string). For "
23605 "those you need to use the L</read-file> or L</download> functions which have "
23606 "a more complex interface."
23610 #: ../fish/guestfish-actions.pod:620
23615 #: ../fish/guestfish-actions.pod:622
23618 " checksum csumtype path\n"
23623 #: ../fish/guestfish-actions.pod:665
23624 msgid "To get the checksum for a device, use L</checksum-device>."
23628 #: ../fish/guestfish-actions.pod:667
23629 msgid "To get the checksums for many files, use L</checksums-out>."
23633 #: ../fish/guestfish-actions.pod:669
23634 msgid "checksum-device"
23638 #: ../fish/guestfish-actions.pod:671
23641 " checksum-device csumtype device\n"
23646 #: ../fish/guestfish-actions.pod:673
23648 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
23649 "device named C<device>. For the types of checksums supported see the L</"
23650 "checksum> command."
23654 #: ../fish/guestfish-actions.pod:677
23655 msgid "checksums-out"
23659 #: ../fish/guestfish-actions.pod:679
23662 " checksums-out csumtype directory (sumsfile|-)\n"
23667 #: ../fish/guestfish-actions.pod:695
23672 #: ../fish/guestfish-actions.pod:697
23675 " chmod mode path\n"
23680 #: ../fish/guestfish-actions.pod:708
23685 #: ../fish/guestfish-actions.pod:710
23688 " chown owner group path\n"
23693 #: ../fish/guestfish-actions.pod:718
23698 #: ../fish/guestfish-actions.pod:720
23701 " command 'arguments ...'\n"
23706 #: ../fish/guestfish-actions.pod:727
23708 "The single parameter is an argv-style list of arguments. The first element "
23709 "is the name of the program to run. Subsequent elements are parameters. The "
23710 "list must be non-empty (ie. must contain a program name). Note that the "
23711 "command runs directly, and is I<not> invoked via the shell (see L</sh>)."
23715 #: ../fish/guestfish-actions.pod:755
23716 msgid "command-lines"
23720 #: ../fish/guestfish-actions.pod:757
23723 " command-lines 'arguments ...'\n"
23728 #: ../fish/guestfish-actions.pod:759
23730 "This is the same as L</command>, but splits the result into a list of lines."
23734 #: ../fish/guestfish-actions.pod:762
23735 msgid "See also: L</sh-lines>"
23739 #: ../fish/guestfish-actions.pod:767
23744 #: ../fish/guestfish-actions.pod:769
23747 " config qemuparam qemuvalue\n"
23752 #: ../fish/guestfish-actions.pod:780
23757 #: ../fish/guestfish-actions.pod:782
23760 " copy-size src dest size\n"
23765 #: ../fish/guestfish-actions.pod:790
23770 #: ../fish/guestfish-actions.pod:792
23778 #: ../fish/guestfish-actions.pod:797
23783 #: ../fish/guestfish-actions.pod:799
23791 #: ../fish/guestfish-actions.pod:804
23796 #: ../fish/guestfish-actions.pod:806
23804 #: ../fish/guestfish-actions.pod:813
23806 "If the destination is a device, it must be as large or larger than the "
23807 "source file or device, otherwise the copy will fail. This command cannot do "
23808 "partial copies (see L</copy-size>)."
23812 #: ../fish/guestfish-actions.pod:817
23817 #: ../fish/guestfish-actions.pod:819
23825 #: ../fish/guestfish-actions.pod:823 ../fish/guestfish-actions.pod:834
23827 "This command is mostly useful for interactive sessions. It is I<not> "
23828 "intended that you try to parse the output string. Use L</statvfs> from "
23833 #: ../fish/guestfish-actions.pod:827
23838 #: ../fish/guestfish-actions.pod:829
23846 #: ../fish/guestfish-actions.pod:838
23851 #: ../fish/guestfish-actions.pod:840
23859 #: ../fish/guestfish-actions.pod:846
23861 "Another way to get the same information is to enable verbose messages with "
23862 "L</set-verbose> or by setting the environment variable C<LIBGUESTFS_DEBUG=1> "
23863 "before running the program."
23867 #: ../fish/guestfish-actions.pod:851
23872 #: ../fish/guestfish-actions.pod:853
23875 " download remotefilename (filename|-)\n"
23880 #: ../fish/guestfish-actions.pod:860
23881 msgid "See also L</upload>, L</cat>."
23885 #: ../fish/guestfish-actions.pod:864
23886 msgid "download-offset"
23890 #: ../fish/guestfish-actions.pod:866
23893 " download-offset remotefilename (filename|-) offset size\n"
23898 #: ../fish/guestfish-actions.pod:874
23900 "Note that there is no limit on the amount of data that can be downloaded "
23901 "with this call, unlike with L</pread>, and this call always reads the full "
23902 "amount unless an error occurs."
23906 #: ../fish/guestfish-actions.pod:879
23907 msgid "See also L</download>, L</pread>."
23911 #: ../fish/guestfish-actions.pod:883
23912 msgid "drop-caches"
23916 #: ../fish/guestfish-actions.pod:885
23919 " drop-caches whattodrop\n"
23924 #: ../fish/guestfish-actions.pod:897
23929 #: ../fish/guestfish-actions.pod:899
23937 #: ../fish/guestfish-actions.pod:911
23942 #: ../fish/guestfish-actions.pod:913
23945 " e2fsck-f device\n"
23950 #: ../fish/guestfish-actions.pod:919
23952 "This command is only needed because of L</resize2fs> (q.v.). Normally you "
23953 "should use L</fsck>."
23957 #: ../fish/guestfish-actions.pod:922
23958 msgid "echo-daemon"
23962 #: ../fish/guestfish-actions.pod:924
23965 " echo-daemon 'words ...'\n"
23970 #: ../fish/guestfish-actions.pod:931
23971 msgid "See also L</ping-daemon>."
23975 #: ../fish/guestfish-actions.pod:933
23980 #: ../fish/guestfish-actions.pod:935
23983 " egrep regex path\n"
23988 #: ../fish/guestfish-actions.pod:943
23993 #: ../fish/guestfish-actions.pod:945
23996 " egrepi regex path\n"
24001 #: ../fish/guestfish-actions.pod:953
24006 #: ../fish/guestfish-actions.pod:955
24009 " equal file1 file2\n"
24014 #: ../fish/guestfish-actions.pod:962
24019 #: ../fish/guestfish-actions.pod:964
24027 #: ../fish/guestfish-actions.pod:969
24028 msgid "See also L</is-file>, L</is-dir>, L</stat>."
24032 #: ../fish/guestfish-actions.pod:971
24037 #: ../fish/guestfish-actions.pod:973
24040 " fallocate path len\n"
24045 #: ../fish/guestfish-actions.pod:990
24046 msgid "fallocate64"
24050 #: ../fish/guestfish-actions.pod:992
24053 " fallocate64 path len\n"
24058 #: ../fish/guestfish-actions.pod:998
24060 "Note that this call allocates disk blocks for the file. To create a sparse "
24061 "file use L</truncate-size> instead."
24065 #: ../fish/guestfish-actions.pod:1001
24067 "The deprecated call L</fallocate> does the same, but owing to an oversight "
24068 "it only allowed 30 bit lengths to be specified, effectively limiting the "
24069 "maximum size of files created through that call to 1GB."
24073 #: ../fish/guestfish-actions.pod:1010
24078 #: ../fish/guestfish-actions.pod:1012
24081 " fgrep pattern path\n"
24086 #: ../fish/guestfish-actions.pod:1020
24091 #: ../fish/guestfish-actions.pod:1022
24094 " fgrepi pattern path\n"
24099 #: ../fish/guestfish-actions.pod:1030
24104 #: ../fish/guestfish-actions.pod:1032
24112 #: ../fish/guestfish-actions.pod:1048
24114 "See also: L<file(1)>, L</vfs-type>, L</lstat>, L</is-file>, L</is-blockdev> "
24115 "(etc), L</is-zero>."
24119 #: ../fish/guestfish-actions.pod:1051
24120 msgid "file-architecture"
24124 #: ../fish/guestfish-actions.pod:1053
24127 " file-architecture filename\n"
24132 #: ../fish/guestfish-actions.pod:1156
24137 #: ../fish/guestfish-actions.pod:1158
24145 #: ../fish/guestfish-actions.pod:1162
24147 "To get other stats about a file, use L</stat>, L</lstat>, L</is-dir>, L</is-"
24148 "file> etc. To get the size of block devices, use L</blockdev-getsize64>."
24152 #: ../fish/guestfish-actions.pod:1166
24157 #: ../fish/guestfish-actions.pod:1168
24160 " fill c len path\n"
24165 #: ../fish/guestfish-actions.pod:1174
24167 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
24168 "L</truncate-size>. To create a file with a pattern of repeating bytes use "
24169 "L</fill-pattern>."
24173 #: ../fish/guestfish-actions.pod:1179
24174 msgid "fill-pattern"
24178 #: ../fish/guestfish-actions.pod:1181
24181 " fill-pattern pattern len path\n"
24186 #: ../fish/guestfish-actions.pod:1183
24188 "This function is like L</fill> except that it creates a new file of length "
24189 "C<len> containing the repeating pattern of bytes in C<pattern>. The pattern "
24190 "is truncated if necessary to ensure the length of the file is exactly C<len> "
24195 #: ../fish/guestfish-actions.pod:1188
24200 #: ../fish/guestfish-actions.pod:1190
24203 " find directory\n"
24208 #: ../fish/guestfish-actions.pod:1204
24209 msgid "then the returned list from L</find> C</tmp> would be 4 elements:"
24213 #: ../fish/guestfish-actions.pod:1217
24214 msgid "See also L</find0>."
24218 #: ../fish/guestfish-actions.pod:1222
24223 #: ../fish/guestfish-actions.pod:1224
24226 " find0 directory (files|-)\n"
24231 #: ../fish/guestfish-actions.pod:1230
24233 "This command works the same way as L</find> with the following exceptions:"
24237 #: ../fish/guestfish-actions.pod:1257
24238 msgid "findfs-label"
24242 #: ../fish/guestfish-actions.pod:1259
24245 " findfs-label label\n"
24250 #: ../fish/guestfish-actions.pod:1265
24251 msgid "To find the label of a filesystem, use L</vfs-label>."
24255 #: ../fish/guestfish-actions.pod:1267
24256 msgid "findfs-uuid"
24260 #: ../fish/guestfish-actions.pod:1269
24263 " findfs-uuid uuid\n"
24268 #: ../fish/guestfish-actions.pod:1275
24269 msgid "To find the UUID of a filesystem, use L</vfs-uuid>."
24273 #: ../fish/guestfish-actions.pod:1277
24278 #: ../fish/guestfish-actions.pod:1279
24281 " fsck fstype device\n"
24286 #: ../fish/guestfish-actions.pod:1309
24291 #: ../fish/guestfish-actions.pod:1311
24299 #: ../fish/guestfish-actions.pod:1318
24300 msgid "get-attach-method"
24304 #: ../fish/guestfish-actions.pod:1320
24307 " get-attach-method\n"
24312 #: ../fish/guestfish-actions.pod:1322
24313 msgid "Return the current attach method. See L</set-attach-method>."
24317 #: ../fish/guestfish-actions.pod:1324
24318 msgid "get-autosync"
24322 #: ../fish/guestfish-actions.pod:1326
24330 #: ../fish/guestfish-actions.pod:1330
24335 #: ../fish/guestfish-actions.pod:1332
24343 #: ../fish/guestfish-actions.pod:1336
24344 msgid "get-e2label"
24348 #: ../fish/guestfish-actions.pod:1338
24351 " get-e2label device\n"
24356 #: ../fish/guestfish-actions.pod:1350
24361 #: ../fish/guestfish-actions.pod:1352
24364 " get-e2uuid device\n"
24369 #: ../fish/guestfish-actions.pod:1364
24370 msgid "get-memsize"
24374 #: ../fish/guestfish-actions.pod:1366
24382 #: ../fish/guestfish-actions.pod:1371
24384 "If L</set-memsize> was not called on this handle, and if "
24385 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
24386 "value for memsize."
24390 #: ../fish/guestfish-actions.pod:1378
24391 msgid "get-network"
24395 #: ../fish/guestfish-actions.pod:1380
24403 #: ../fish/guestfish-actions.pod:1384
24408 #: ../fish/guestfish-actions.pod:1386
24416 #: ../fish/guestfish-actions.pod:1393
24421 #: ../fish/guestfish-actions.pod:1395
24429 #: ../fish/guestfish-actions.pod:1399
24434 #: ../fish/guestfish-actions.pod:1401
24439 #: ../fish/guestfish-actions.pod:1403
24447 #: ../fish/guestfish-actions.pod:1410
24452 #: ../fish/guestfish-actions.pod:1412
24460 #: ../fish/guestfish-actions.pod:1419
24461 msgid "get-recovery-proc"
24465 #: ../fish/guestfish-actions.pod:1421
24468 " get-recovery-proc\n"
24473 #: ../fish/guestfish-actions.pod:1425
24474 msgid "get-selinux"
24478 #: ../fish/guestfish-actions.pod:1427
24486 #: ../fish/guestfish-actions.pod:1429
24488 "This returns the current setting of the selinux flag which is passed to the "
24489 "appliance at boot time. See L</set-selinux>."
24493 #: ../fish/guestfish-actions.pod:1435
24498 #: ../fish/guestfish-actions.pod:1437
24506 #: ../fish/guestfish-actions.pod:1444
24511 #: ../fish/guestfish-actions.pod:1446
24519 #: ../fish/guestfish-actions.pod:1450
24524 #: ../fish/guestfish-actions.pod:1452
24532 #: ../fish/guestfish-actions.pod:1454
24534 "Return the current umask. By default the umask is C<022> unless it has been "
24535 "set by calling L</umask>."
24539 #: ../fish/guestfish-actions.pod:1457
24540 msgid "get-verbose"
24544 #: ../fish/guestfish-actions.pod:1459
24552 #: ../fish/guestfish-actions.pod:1463
24557 #: ../fish/guestfish-actions.pod:1465
24565 #: ../fish/guestfish-actions.pod:1469
24566 msgid "See the documentation about SELINUX in L<guestfs(3)>, and L</setcon>"
24570 #: ../fish/guestfish-actions.pod:1472
24575 #: ../fish/guestfish-actions.pod:1474
24578 " getxattr path name\n"
24583 #: ../fish/guestfish-actions.pod:1476
24585 "Get a single extended attribute from file C<path> named C<name>. This call "
24586 "follows symlinks. If you want to lookup an extended attribute for the "
24587 "symlink itself, use L</lgetxattr>."
24591 #: ../fish/guestfish-actions.pod:1480 ../fish/guestfish-actions.pod:2507
24593 "Normally it is better to get all extended attributes from a file in one go "
24594 "by calling L</getxattrs>. However some Linux filesystem implementations are "
24595 "buggy and do not provide a way to list out attributes. For these "
24596 "filesystems (notably ntfs-3g) you have to know the names of the extended "
24597 "attributes you want in advance and call this function."
24601 #: ../fish/guestfish-actions.pod:1490
24602 msgid "See also: L</getxattrs>, L</lgetxattr>, L<attr(5)>."
24606 #: ../fish/guestfish-actions.pod:1492
24611 #: ../fish/guestfish-actions.pod:1494
24614 " getxattrs path\n"
24619 #: ../fish/guestfish-actions.pod:1502
24620 msgid "See also: L</lgetxattrs>, L<attr(5)>."
24624 #: ../fish/guestfish-actions.pod:1504
24625 msgid "glob-expand"
24629 #: ../fish/guestfish-actions.pod:1506
24632 " glob-expand pattern\n"
24637 #: ../fish/guestfish-actions.pod:1519
24642 #: ../fish/guestfish-actions.pod:1521
24645 " grep regex path\n"
24650 #: ../fish/guestfish-actions.pod:1529
24655 #: ../fish/guestfish-actions.pod:1531
24658 " grepi regex path\n"
24663 #: ../fish/guestfish-actions.pod:1539
24664 msgid "grub-install"
24668 #: ../fish/guestfish-actions.pod:1541
24671 " grub-install root device\n"
24676 #: ../fish/guestfish-actions.pod:1557
24681 #: ../fish/guestfish-actions.pod:1559
24689 #: ../fish/guestfish-actions.pod:1567
24694 #: ../fish/guestfish-actions.pod:1569
24697 " head-n nrlines path\n"
24702 #: ../fish/guestfish-actions.pod:1582
24707 #: ../fish/guestfish-actions.pod:1584
24715 #: ../fish/guestfish-actions.pod:1592
24720 #: ../fish/guestfish-actions.pod:1594
24723 " initrd-cat initrdpath filename\n"
24728 #: ../fish/guestfish-actions.pod:1606
24729 msgid "See also L</initrd-list>."
24733 #: ../fish/guestfish-actions.pod:1611
24734 msgid "initrd-list"
24738 #: ../fish/guestfish-actions.pod:1613
24741 " initrd-list path\n"
24746 #: ../fish/guestfish-actions.pod:1625
24747 msgid "inotify-add-watch"
24751 #: ../fish/guestfish-actions.pod:1627
24754 " inotify-add-watch path mask\n"
24759 #: ../fish/guestfish-actions.pod:1639
24760 msgid "inotify-close"
24764 #: ../fish/guestfish-actions.pod:1641
24772 #: ../fish/guestfish-actions.pod:1647
24773 msgid "inotify-files"
24777 #: ../fish/guestfish-actions.pod:1649
24785 #: ../fish/guestfish-actions.pod:1651
24787 "This function is a helpful wrapper around L</inotify-read> which just "
24788 "returns a list of pathnames of objects that were touched. The returned "
24789 "pathnames are sorted and deduplicated."
24793 #: ../fish/guestfish-actions.pod:1655
24794 msgid "inotify-init"
24798 #: ../fish/guestfish-actions.pod:1657
24801 " inotify-init maxevents\n"
24806 #: ../fish/guestfish-actions.pod:1663
24808 "C<maxevents> is the maximum number of events which will be queued up between "
24809 "calls to L</inotify-read> or L</inotify-files>. If this is passed as C<0>, "
24810 "then the kernel (or previously set) default is used. For Linux 2.6.29 the "
24811 "default was 16384 events. Beyond this limit, the kernel throws away events, "
24812 "but records the fact that it threw them away by setting a flag "
24813 "C<IN_Q_OVERFLOW> in the returned structure list (see L</inotify-read>)."
24817 #: ../fish/guestfish-actions.pod:1673
24819 "Before any events are generated, you have to add some watches to the "
24820 "internal watch list. See: L</inotify-add-watch>, L</inotify-rm-watch> and "
24821 "L</inotify-watch-all>."
24825 #: ../fish/guestfish-actions.pod:1679
24827 "Queued up events should be read periodically by calling L</inotify-read> (or "
24828 "L</inotify-files> which is just a helpful wrapper around L</inotify-read>). "
24829 "If you don't read the events out often enough then you risk the internal "
24830 "queue overflowing."
24834 #: ../fish/guestfish-actions.pod:1686
24836 "The handle should be closed after use by calling L</inotify-close>. This "
24837 "also removes any watches automatically."
24841 #: ../fish/guestfish-actions.pod:1695
24842 msgid "inotify-read"
24846 #: ../fish/guestfish-actions.pod:1697
24854 #: ../fish/guestfish-actions.pod:1710
24855 msgid "inotify-rm-watch"
24859 #: ../fish/guestfish-actions.pod:1712
24862 " inotify-rm-watch wd\n"
24867 #: ../fish/guestfish-actions.pod:1714
24868 msgid "Remove a previously defined inotify watch. See L</inotify-add-watch>."
24872 #: ../fish/guestfish-actions.pod:1717
24873 msgid "inspect-get-arch"
24877 #: ../fish/guestfish-actions.pod:1719
24880 " inspect-get-arch root\n"
24885 #: ../fish/guestfish-actions.pod:1721
24887 "This returns the architecture of the inspected operating system. The "
24888 "possible return values are listed under L</file-architecture>."
24892 #: ../fish/guestfish-actions.pod:1730
24893 msgid "inspect-get-distro"
24897 #: ../fish/guestfish-actions.pod:1732
24900 " inspect-get-distro root\n"
24905 #: ../fish/guestfish-actions.pod:1813
24906 msgid "inspect-get-drive-mappings"
24910 #: ../fish/guestfish-actions.pod:1815
24913 " inspect-get-drive-mappings root\n"
24918 #: ../fish/guestfish-actions.pod:1842
24920 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
24921 "get-mountpoints>, L</inspect-get-filesystems>."
24925 #: ../fish/guestfish-actions.pod:1846
24926 msgid "inspect-get-filesystems"
24930 #: ../fish/guestfish-actions.pod:1848
24933 " inspect-get-filesystems root\n"
24938 #: ../fish/guestfish-actions.pod:1858
24940 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
24941 "get-mountpoints>."
24945 #: ../fish/guestfish-actions.pod:1861
24946 msgid "inspect-get-format"
24950 #: ../fish/guestfish-actions.pod:1863
24953 " inspect-get-format root\n"
24958 #: ../fish/guestfish-actions.pod:1892
24959 msgid "inspect-get-hostname"
24963 #: ../fish/guestfish-actions.pod:1894
24966 " inspect-get-hostname root\n"
24971 #: ../fish/guestfish-actions.pod:1904
24972 msgid "inspect-get-icon"
24976 #: ../fish/guestfish-actions.pod:1906
24979 " inspect-get-icon root [favicon:..] [highquality:..]\n"
24984 #: ../fish/guestfish-actions.pod:1970
24985 msgid "inspect-get-major-version"
24989 #: ../fish/guestfish-actions.pod:1972
24992 " inspect-get-major-version root\n"
24997 #: ../fish/guestfish-actions.pod:1988
24998 msgid "inspect-get-minor-version"
25002 #: ../fish/guestfish-actions.pod:1990
25005 " inspect-get-minor-version root\n"
25010 #: ../fish/guestfish-actions.pod:1997
25012 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
25013 "get-major-version>."
25017 #: ../fish/guestfish-actions.pod:2000
25018 msgid "inspect-get-mountpoints"
25022 #: ../fish/guestfish-actions.pod:2002
25025 " inspect-get-mountpoints root\n"
25030 #: ../fish/guestfish-actions.pod:2021
25032 "For operating systems like Windows which still use drive letters, this call "
25033 "will only return an entry for the first drive \"mounted on\" C</>. For "
25034 "information about the mapping of drive letters to partitions, see L</inspect-"
25035 "get-drive-mappings>."
25039 #: ../fish/guestfish-actions.pod:2027
25041 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
25042 "get-filesystems>."
25046 #: ../fish/guestfish-actions.pod:2030
25047 msgid "inspect-get-package-format"
25051 #: ../fish/guestfish-actions.pod:2032
25054 " inspect-get-package-format root\n"
25059 #: ../fish/guestfish-actions.pod:2034
25061 "This function and L</inspect-get-package-management> return the package "
25062 "format and package management tool used by the inspected operating system. "
25063 "For example for Fedora these functions would return C<rpm> (package format) "
25064 "and C<yum> (package management)."
25068 #: ../fish/guestfish-actions.pod:2049
25069 msgid "inspect-get-package-management"
25073 #: ../fish/guestfish-actions.pod:2051
25076 " inspect-get-package-management root\n"
25081 #: ../fish/guestfish-actions.pod:2053
25083 "L</inspect-get-package-format> and this function return the package format "
25084 "and package management tool used by the inspected operating system. For "
25085 "example for Fedora these functions would return C<rpm> (package format) and "
25086 "C<yum> (package management)."
25090 #: ../fish/guestfish-actions.pod:2070
25091 msgid "inspect-get-product-name"
25095 #: ../fish/guestfish-actions.pod:2072
25098 " inspect-get-product-name root\n"
25103 #: ../fish/guestfish-actions.pod:2084
25104 msgid "inspect-get-product-variant"
25108 #: ../fish/guestfish-actions.pod:2086
25111 " inspect-get-product-variant root\n"
25116 #: ../fish/guestfish-actions.pod:2107
25118 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
25119 "get-product-name>, L</inspect-get-major-version>."
25123 #: ../fish/guestfish-actions.pod:2111
25124 msgid "inspect-get-roots"
25128 #: ../fish/guestfish-actions.pod:2113
25131 " inspect-get-roots\n"
25136 #: ../fish/guestfish-actions.pod:2115
25138 "This function is a convenient way to get the list of root devices, as "
25139 "returned from a previous call to L</inspect-os>, but without redoing the "
25140 "whole inspection process."
25144 #: ../fish/guestfish-actions.pod:2119
25146 "This returns an empty list if either no root devices were found or the "
25147 "caller has not called L</inspect-os>."
25151 #: ../fish/guestfish-actions.pod:2124
25152 msgid "inspect-get-type"
25156 #: ../fish/guestfish-actions.pod:2126
25159 " inspect-get-type root\n"
25164 #: ../fish/guestfish-actions.pod:2156
25165 msgid "inspect-get-windows-current-control-set"
25169 #: ../fish/guestfish-actions.pod:2158
25172 " inspect-get-windows-current-control-set root\n"
25177 #: ../fish/guestfish-actions.pod:2169
25178 msgid "inspect-get-windows-systemroot"
25182 #: ../fish/guestfish-actions.pod:2171
25185 " inspect-get-windows-systemroot root\n"
25190 #: ../fish/guestfish-actions.pod:2182
25191 msgid "inspect-is-live"
25195 #: ../fish/guestfish-actions.pod:2184
25198 " inspect-is-live root\n"
25203 #: ../fish/guestfish-actions.pod:2186
25205 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
25206 "then this returns true if a live image was detected on the disk."
25210 #: ../fish/guestfish-actions.pod:2192
25211 msgid "inspect-is-multipart"
25215 #: ../fish/guestfish-actions.pod:2194
25218 " inspect-is-multipart root\n"
25223 #: ../fish/guestfish-actions.pod:2196
25225 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
25226 "then this returns true if the disk is part of a set."
25230 #: ../fish/guestfish-actions.pod:2202
25231 msgid "inspect-is-netinst"
25235 #: ../fish/guestfish-actions.pod:2204
25238 " inspect-is-netinst root\n"
25243 #: ../fish/guestfish-actions.pod:2206
25245 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
25246 "then this returns true if the disk is a network installer, ie. not a self-"
25247 "contained install CD but one which is likely to require network access to "
25248 "complete the install."
25252 #: ../fish/guestfish-actions.pod:2214
25253 msgid "inspect-list-applications"
25257 #: ../fish/guestfish-actions.pod:2216
25260 " inspect-list-applications root\n"
25265 #: ../fish/guestfish-actions.pod:2220
25267 "I<Note:> This call works differently from other parts of the inspection "
25268 "API. You have to call L</inspect-os>, then L</inspect-get-mountpoints>, "
25269 "then mount up the disks, before calling this. Listing applications is a "
25270 "significantly more difficult operation which requires access to the full "
25271 "filesystem. Also note that unlike the other L</inspect-get-*> calls which "
25272 "are just returning data cached in the libguestfs handle, this call actually "
25273 "reads parts of the mounted filesystems during the call."
25277 #: ../fish/guestfish-actions.pod:2310
25282 #: ../fish/guestfish-actions.pod:2312
25290 #: ../fish/guestfish-actions.pod:2327
25292 "You can pass the root string(s) returned to other L</inspect-get-*> "
25293 "functions in order to query further information about each operating system, "
25294 "such as the name and version."
25298 #: ../fish/guestfish-actions.pod:2332
25300 "This function uses other libguestfs features such as L</mount-ro> and L</"
25301 "umount-all> in order to mount and unmount filesystems and look at the "
25302 "contents. This should be called with no disks currently mounted. The "
25303 "function may also use Augeas, so any existing Augeas handle will be closed."
25307 #: ../fish/guestfish-actions.pod:2344 ../fish/guestfish-actions.pod:2542
25308 #: ../fish/guestfish-actions.pod:2601
25309 msgid "See also L</list-filesystems>."
25313 #: ../fish/guestfish-actions.pod:2346
25314 msgid "is-blockdev"
25318 #: ../fish/guestfish-actions.pod:2348
25321 " is-blockdev path\n"
25326 #: ../fish/guestfish-actions.pod:2353 ../fish/guestfish-actions.pod:2371
25327 #: ../fish/guestfish-actions.pod:2390 ../fish/guestfish-actions.pod:2399
25328 #: ../fish/guestfish-actions.pod:2409 ../fish/guestfish-actions.pod:2443
25329 #: ../fish/guestfish-actions.pod:2452
25330 msgid "See also L</stat>."
25334 #: ../fish/guestfish-actions.pod:2355
25339 #: ../fish/guestfish-actions.pod:2357
25347 #: ../fish/guestfish-actions.pod:2364
25352 #: ../fish/guestfish-actions.pod:2366
25355 " is-chardev path\n"
25360 #: ../fish/guestfish-actions.pod:2373
25365 #: ../fish/guestfish-actions.pod:2375
25373 #: ../fish/guestfish-actions.pod:2382
25378 #: ../fish/guestfish-actions.pod:2384
25386 #: ../fish/guestfish-actions.pod:2392
25391 #: ../fish/guestfish-actions.pod:2394
25399 #: ../fish/guestfish-actions.pod:2401
25404 #: ../fish/guestfish-actions.pod:2403
25412 #: ../fish/guestfish-actions.pod:2411
25413 msgid "is-launching"
25417 #: ../fish/guestfish-actions.pod:2413
25425 #: ../fish/guestfish-actions.pod:2420
25430 #: ../fish/guestfish-actions.pod:2422
25438 #: ../fish/guestfish-actions.pod:2427
25443 #: ../fish/guestfish-actions.pod:2429
25451 #: ../fish/guestfish-actions.pod:2436
25456 #: ../fish/guestfish-actions.pod:2438
25459 " is-socket path\n"
25464 #: ../fish/guestfish-actions.pod:2445
25469 #: ../fish/guestfish-actions.pod:2447
25472 " is-symlink path\n"
25477 #: ../fish/guestfish-actions.pod:2454
25482 #: ../fish/guestfish-actions.pod:2456
25490 #: ../fish/guestfish-actions.pod:2461
25491 msgid "is-zero-device"
25495 #: ../fish/guestfish-actions.pod:2463
25498 " is-zero-device device\n"
25503 #: ../fish/guestfish-actions.pod:2469
25504 msgid "kill-subprocess"
25508 #: ../fish/guestfish-actions.pod:2471
25511 " kill-subprocess\n"
25516 #: ../fish/guestfish-actions.pod:2475
25521 #: ../fish/guestfish-actions.pod:2477
25526 #: ../fish/guestfish-actions.pod:2479
25534 #: ../fish/guestfish-actions.pod:2487
25539 #: ../fish/guestfish-actions.pod:2489
25542 " lchown owner group path\n"
25547 #: ../fish/guestfish-actions.pod:2491
25549 "Change the file owner to C<owner> and group to C<group>. This is like L</"
25550 "chown> but if C<path> is a symlink then the link itself is changed, not the "
25555 #: ../fish/guestfish-actions.pod:2499
25560 #: ../fish/guestfish-actions.pod:2501
25563 " lgetxattr path name\n"
25568 #: ../fish/guestfish-actions.pod:2517
25569 msgid "See also: L</lgetxattrs>, L</getxattr>, L<attr(5)>."
25573 #: ../fish/guestfish-actions.pod:2519
25578 #: ../fish/guestfish-actions.pod:2521
25581 " lgetxattrs path\n"
25586 #: ../fish/guestfish-actions.pod:2523
25588 "This is the same as L</getxattrs>, but if C<path> is a symbolic link, then "
25589 "it returns the extended attributes of the link itself."
25593 #: ../fish/guestfish-actions.pod:2527
25598 #: ../fish/guestfish-actions.pod:2529
25606 #: ../fish/guestfish-actions.pod:2534
25607 msgid "list-devices"
25611 #: ../fish/guestfish-actions.pod:2536
25619 #: ../fish/guestfish-actions.pod:2544
25620 msgid "list-dm-devices"
25624 #: ../fish/guestfish-actions.pod:2546
25627 " list-dm-devices\n"
25632 #: ../fish/guestfish-actions.pod:2550
25634 "The returned list contains C</dev/mapper/*> devices, eg. ones created by a "
25635 "previous call to L</luks-open>."
25639 #: ../fish/guestfish-actions.pod:2553
25641 "Device mapper devices which correspond to logical volumes are I<not> "
25642 "returned in this list. Call L</lvs> if you want to list logical volumes."
25646 #: ../fish/guestfish-actions.pod:2557
25647 msgid "list-filesystems"
25651 #: ../fish/guestfish-actions.pod:2559
25654 " list-filesystems\n"
25659 #: ../fish/guestfish-actions.pod:2578
25661 "This command runs other libguestfs commands, which might include L</mount> "
25662 "and L</umount>, and therefore you should use this soon after launch and only "
25663 "when nothing is mounted."
25667 #: ../fish/guestfish-actions.pod:2582
25669 "Not all of the filesystems returned will be mountable. In particular, swap "
25670 "partitions are returned in the list. Also this command does not check that "
25671 "each filesystem found is valid and mountable, and some filesystems might be "
25672 "mountable but require special options. Filesystems may not all belong to a "
25673 "single logical operating system (use L</inspect-os> to look for OSes)."
25677 #: ../fish/guestfish-actions.pod:2590
25678 msgid "list-partitions"
25682 #: ../fish/guestfish-actions.pod:2592
25685 " list-partitions\n"
25690 #: ../fish/guestfish-actions.pod:2598
25692 "This does not return logical volumes. For that you will need to call L</"
25697 #: ../fish/guestfish-actions.pod:2603
25702 #: ../fish/guestfish-actions.pod:2605
25710 #: ../fish/guestfish-actions.pod:2613
25715 #: ../fish/guestfish-actions.pod:2615
25718 " ln target linkname\n"
25723 #: ../fish/guestfish-actions.pod:2619
25728 #: ../fish/guestfish-actions.pod:2621
25731 " ln-f target linkname\n"
25736 #: ../fish/guestfish-actions.pod:2626
25741 #: ../fish/guestfish-actions.pod:2628
25744 " ln-s target linkname\n"
25749 #: ../fish/guestfish-actions.pod:2632
25754 #: ../fish/guestfish-actions.pod:2634
25757 " ln-sf target linkname\n"
25762 #: ../fish/guestfish-actions.pod:2639
25763 msgid "lremovexattr"
25767 #: ../fish/guestfish-actions.pod:2641
25770 " lremovexattr xattr path\n"
25775 #: ../fish/guestfish-actions.pod:2643
25777 "This is the same as L</removexattr>, but if C<path> is a symbolic link, then "
25778 "it removes an extended attribute of the link itself."
25782 #: ../fish/guestfish-actions.pod:2647
25787 #: ../fish/guestfish-actions.pod:2649
25795 #: ../fish/guestfish-actions.pod:2655
25797 "This command is mostly useful for interactive sessions. Programs should "
25798 "probably use L</readdir> instead."
25802 #: ../fish/guestfish-actions.pod:2658
25807 #: ../fish/guestfish-actions.pod:2660
25810 " lsetxattr xattr val vallen path\n"
25815 #: ../fish/guestfish-actions.pod:2662
25817 "This is the same as L</setxattr>, but if C<path> is a symbolic link, then it "
25818 "sets an extended attribute of the link itself."
25822 #: ../fish/guestfish-actions.pod:2666
25827 #: ../fish/guestfish-actions.pod:2668
25835 #: ../fish/guestfish-actions.pod:2672
25837 "This is the same as L</stat> except that if C<path> is a symbolic link, then "
25838 "the link is stat-ed, not the file it refers to."
25842 #: ../fish/guestfish-actions.pod:2678
25847 #: ../fish/guestfish-actions.pod:2680
25850 " lstatlist path 'names ...'\n"
25855 #: ../fish/guestfish-actions.pod:2682
25857 "This call allows you to perform the L</lstat> operation on multiple files, "
25858 "where all files are in the directory C<path>. C<names> is the list of files "
25859 "from this directory."
25863 #: ../fish/guestfish-actions.pod:2691
25865 "This call is intended for programs that want to efficiently list a directory "
25866 "contents without making many round-trips. See also L</lxattrlist> for a "
25867 "similarly efficient call for getting extended attributes. Very long "
25868 "directory listings might cause the protocol message size to be exceeded, "
25869 "causing this call to fail. The caller must split up such requests into "
25870 "smaller groups of names."
25874 #: ../fish/guestfish-actions.pod:2699
25875 msgid "luks-add-key"
25879 #: ../fish/guestfish-actions.pod:2701
25882 " luks-add-key device keyslot\n"
25887 #: ../fish/guestfish-actions.pod:2708
25889 "Note that if C<keyslot> already contains a key, then this command will "
25890 "fail. You have to use L</luks-kill-slot> first to remove that key."
25894 #: ../fish/guestfish-actions.pod:2712 ../fish/guestfish-actions.pod:2734
25895 #: ../fish/guestfish-actions.pod:2747 ../fish/guestfish-actions.pod:2761
25896 #: ../fish/guestfish-actions.pod:2787 ../fish/guestfish-actions.pod:2797
25898 "This command has one or more key or passphrase parameters. Guestfish will "
25899 "prompt for these separately."
25903 #: ../fish/guestfish-actions.pod:2715
25908 #: ../fish/guestfish-actions.pod:2717
25911 " luks-close device\n"
25916 #: ../fish/guestfish-actions.pod:2719
25918 "This closes a LUKS device that was created earlier by L</luks-open> or L</"
25919 "luks-open-ro>. The C<device> parameter must be the name of the LUKS mapping "
25920 "device (ie. C</dev/mapper/mapname>) and I<not> the name of the underlying "
25925 #: ../fish/guestfish-actions.pod:2725
25926 msgid "luks-format"
25930 #: ../fish/guestfish-actions.pod:2727
25933 " luks-format device keyslot\n"
25938 #: ../fish/guestfish-actions.pod:2740
25939 msgid "luks-format-cipher"
25943 #: ../fish/guestfish-actions.pod:2742
25946 " luks-format-cipher device keyslot cipher\n"
25951 #: ../fish/guestfish-actions.pod:2744
25953 "This command is the same as L</luks-format> but it also allows you to set "
25954 "the C<cipher> used."
25958 #: ../fish/guestfish-actions.pod:2753
25959 msgid "luks-kill-slot"
25963 #: ../fish/guestfish-actions.pod:2755
25966 " luks-kill-slot device keyslot\n"
25971 #: ../fish/guestfish-actions.pod:2764
25976 #: ../fish/guestfish-actions.pod:2766
25979 " luks-open device mapname\n"
25984 #: ../fish/guestfish-actions.pod:2780
25986 "If this block device contains LVM volume groups, then calling L</vgscan> "
25987 "followed by L</vg-activate-all> will make them visible."
25991 #: ../fish/guestfish-actions.pod:2784
25992 msgid "Use L</list-dm-devices> to list all device mapper devices."
25996 #: ../fish/guestfish-actions.pod:2790
25997 msgid "luks-open-ro"
26001 #: ../fish/guestfish-actions.pod:2792
26004 " luks-open-ro device mapname\n"
26009 #: ../fish/guestfish-actions.pod:2794
26011 "This is the same as L</luks-open> except that a read-only mapping is created."
26015 #: ../fish/guestfish-actions.pod:2800
26020 #: ../fish/guestfish-actions.pod:2802
26023 " lvcreate logvol volgroup mbytes\n"
26028 #: ../fish/guestfish-actions.pod:2807
26029 msgid "lvm-canonical-lv-name"
26033 #: ../fish/guestfish-actions.pod:2809
26036 " lvm-canonical-lv-name lvname\n"
26041 #: ../fish/guestfish-actions.pod:2818
26042 msgid "See also L</is-lv>."
26046 #: ../fish/guestfish-actions.pod:2820
26047 msgid "lvm-clear-filter"
26051 #: ../fish/guestfish-actions.pod:2822
26054 " lvm-clear-filter\n"
26059 #: ../fish/guestfish-actions.pod:2824
26061 "This undoes the effect of L</lvm-set-filter>. LVM will be able to see every "
26066 #: ../fish/guestfish-actions.pod:2830
26067 msgid "lvm-remove-all"
26071 #: ../fish/guestfish-actions.pod:2832
26074 " lvm-remove-all\n"
26079 #: ../fish/guestfish-actions.pod:2840
26080 msgid "lvm-set-filter"
26084 #: ../fish/guestfish-actions.pod:2842
26087 " lvm-set-filter 'devices ...'\n"
26092 #: ../fish/guestfish-actions.pod:2867
26097 #: ../fish/guestfish-actions.pod:2869
26100 " lvremove device\n"
26105 #: ../fish/guestfish-actions.pod:2877
26110 #: ../fish/guestfish-actions.pod:2879
26113 " lvrename logvol newlogvol\n"
26118 #: ../fish/guestfish-actions.pod:2883
26123 #: ../fish/guestfish-actions.pod:2885
26126 " lvresize device mbytes\n"
26131 #: ../fish/guestfish-actions.pod:2891
26132 msgid "lvresize-free"
26136 #: ../fish/guestfish-actions.pod:2893
26139 " lvresize-free lv percent\n"
26144 #: ../fish/guestfish-actions.pod:2901
26149 #: ../fish/guestfish-actions.pod:2903
26157 #: ../fish/guestfish-actions.pod:2911
26158 msgid "See also L</lvs-full>, L</list-filesystems>."
26162 #: ../fish/guestfish-actions.pod:2913
26167 #: ../fish/guestfish-actions.pod:2915
26175 #: ../fish/guestfish-actions.pod:2920
26180 #: ../fish/guestfish-actions.pod:2922
26188 #: ../fish/guestfish-actions.pod:2926
26193 #: ../fish/guestfish-actions.pod:2928
26196 " lxattrlist path 'names ...'\n"
26201 #: ../fish/guestfish-actions.pod:2944
26203 "This call is intended for programs that want to efficiently list a directory "
26204 "contents without making many round-trips. See also L</lstatlist> for a "
26205 "similarly efficient call for getting standard stats. Very long directory "
26206 "listings might cause the protocol message size to be exceeded, causing this "
26207 "call to fail. The caller must split up such requests into smaller groups of "
26212 #: ../fish/guestfish-actions.pod:2952
26217 #: ../fish/guestfish-actions.pod:2954
26225 #: ../fish/guestfish-actions.pod:2958
26230 #: ../fish/guestfish-actions.pod:2960
26233 " mkdir-mode path mode\n"
26238 #: ../fish/guestfish-actions.pod:2969
26239 msgid "See also L</mkdir>, L</umask>"
26243 #: ../fish/guestfish-actions.pod:2971
26248 #: ../fish/guestfish-actions.pod:2973
26256 #: ../fish/guestfish-actions.pod:2978
26261 #: ../fish/guestfish-actions.pod:2980
26264 " mkdtemp template\n"
26269 #: ../fish/guestfish-actions.pod:3001
26274 #: ../fish/guestfish-actions.pod:3003
26277 " mke2fs-J fstype blocksize device journal\n"
26282 #: ../fish/guestfish-actions.pod:3011
26283 msgid "See also L</mke2journal>."
26287 #: ../fish/guestfish-actions.pod:3013
26292 #: ../fish/guestfish-actions.pod:3015
26295 " mke2fs-JL fstype blocksize device label\n"
26300 #: ../fish/guestfish-actions.pod:3020
26301 msgid "See also L</mke2journal-L>."
26305 #: ../fish/guestfish-actions.pod:3022
26310 #: ../fish/guestfish-actions.pod:3024
26313 " mke2fs-JU fstype blocksize device uuid\n"
26318 #: ../fish/guestfish-actions.pod:3029
26319 msgid "See also L</mke2journal-U>."
26323 #: ../fish/guestfish-actions.pod:3031
26324 msgid "mke2journal"
26328 #: ../fish/guestfish-actions.pod:3033
26331 " mke2journal blocksize device\n"
26336 #: ../fish/guestfish-actions.pod:3040
26337 msgid "mke2journal-L"
26341 #: ../fish/guestfish-actions.pod:3042
26344 " mke2journal-L blocksize label device\n"
26349 #: ../fish/guestfish-actions.pod:3046
26350 msgid "mke2journal-U"
26354 #: ../fish/guestfish-actions.pod:3048
26357 " mke2journal-U blocksize uuid device\n"
26362 #: ../fish/guestfish-actions.pod:3052
26367 #: ../fish/guestfish-actions.pod:3054
26370 " mkfifo mode path\n"
26375 #: ../fish/guestfish-actions.pod:3056
26377 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
26378 "is just a convenient wrapper around L</mknod>."
26382 #: ../fish/guestfish-actions.pod:3062
26387 #: ../fish/guestfish-actions.pod:3064
26390 " mkfs fstype device\n"
26395 #: ../fish/guestfish-actions.pod:3070
26400 #: ../fish/guestfish-actions.pod:3072
26403 " mkfs-b fstype blocksize device\n"
26408 #: ../fish/guestfish-actions.pod:3074
26410 "This call is similar to L</mkfs>, but it allows you to control the block "
26411 "size of the resulting filesystem. Supported block sizes depend on the "
26412 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
26416 #: ../fish/guestfish-actions.pod:3089
26421 #: ../fish/guestfish-actions.pod:3091
26424 " mkfs-opts fstype device [blocksize:..] [features:..] [inode:..] [sectorsize:..]\n"
26429 #: ../fish/guestfish-actions.pod:3136
26430 msgid "mkmountpoint"
26434 #: ../fish/guestfish-actions.pod:3138
26437 " mkmountpoint exemptpath\n"
26442 #: ../fish/guestfish-actions.pod:3140
26444 "L</mkmountpoint> and L</rmmountpoint> are specialized calls that can be used "
26445 "to create extra mountpoints before mounting the first filesystem."
26449 #: ../fish/guestfish-actions.pod:3164
26451 "L</mkmountpoint> is not compatible with L</umount-all>. You may get "
26452 "unexpected errors if you try to mix these calls. It is safest to manually "
26453 "unmount filesystems and remove mountpoints after use."
26457 #: ../fish/guestfish-actions.pod:3168
26459 "L</umount-all> unmounts filesystems by sorting the paths longest first, so "
26460 "for this to work for manual mountpoints, you must ensure that the innermost "
26461 "mountpoints have the longest pathnames, as in the example code above."
26465 #: ../fish/guestfish-actions.pod:3175
26467 "Autosync [see L</set-autosync>, this is set by default on handles] can cause "
26468 "L</umount-all> to be called when the handle is closed which can also trigger "
26473 #: ../fish/guestfish-actions.pod:3179
26478 #: ../fish/guestfish-actions.pod:3181
26481 " mknod mode devmajor devminor path\n"
26486 #: ../fish/guestfish-actions.pod:3191
26488 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
26489 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
26490 "regular file). These constants are available in the standard Linux header "
26491 "files, or you can use L</mknod-b>, L</mknod-c> or L</mkfifo> which are "
26492 "wrappers around this command which bitwise OR in the appropriate constant "
26497 #: ../fish/guestfish-actions.pod:3201
26502 #: ../fish/guestfish-actions.pod:3203
26505 " mknod-b mode devmajor devminor path\n"
26510 #: ../fish/guestfish-actions.pod:3205
26512 "This call creates a block device node called C<path> with mode C<mode> and "
26513 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
26514 "wrapper around L</mknod>."
26518 #: ../fish/guestfish-actions.pod:3211
26523 #: ../fish/guestfish-actions.pod:3213
26526 " mknod-c mode devmajor devminor path\n"
26531 #: ../fish/guestfish-actions.pod:3215
26533 "This call creates a char device node called C<path> with mode C<mode> and "
26534 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
26535 "wrapper around L</mknod>."
26539 #: ../fish/guestfish-actions.pod:3221
26544 #: ../fish/guestfish-actions.pod:3223
26552 #: ../fish/guestfish-actions.pod:3227
26557 #: ../fish/guestfish-actions.pod:3229
26560 " mkswap-L label device\n"
26565 #: ../fish/guestfish-actions.pod:3237
26570 #: ../fish/guestfish-actions.pod:3239
26573 " mkswap-U uuid device\n"
26578 #: ../fish/guestfish-actions.pod:3243
26579 msgid "mkswap-file"
26583 #: ../fish/guestfish-actions.pod:3245
26586 " mkswap-file path\n"
26591 #: ../fish/guestfish-actions.pod:3249
26593 "This command just writes a swap file signature to an existing file. To "
26594 "create the file itself, use something like L</fallocate>."
26598 #: ../fish/guestfish-actions.pod:3252
26603 #: ../fish/guestfish-actions.pod:3254
26606 " modprobe modulename\n"
26611 #: ../fish/guestfish-actions.pod:3261
26616 #: ../fish/guestfish-actions.pod:3263
26619 " mount device mountpoint\n"
26624 #: ../fish/guestfish-actions.pod:3279
26626 "B<Important note:> When you use this call, the filesystem options C<sync> "
26627 "and C<noatime> are set implicitly. This was originally done because we "
26628 "thought it would improve reliability, but it turns out that I<-o sync> has a "
26629 "very large negative performance impact and negligible effect on "
26630 "reliability. Therefore we recommend that you avoid using L</mount> in any "
26631 "code that needs performance, and instead use L</mount-options> (use an empty "
26632 "string for the first parameter if you don't want any options)."
26636 #: ../fish/guestfish-actions.pod:3296
26641 #: ../fish/guestfish-actions.pod:3298
26644 " mount-9p mounttag mountpoint [options:..]\n"
26649 #: ../fish/guestfish-actions.pod:3309
26654 #: ../fish/guestfish-actions.pod:3311
26657 " mount-loop file mountpoint\n"
26662 #: ../fish/guestfish-actions.pod:3317
26663 msgid "mount-options"
26667 #: ../fish/guestfish-actions.pod:3319
26670 " mount-options options device mountpoint\n"
26675 #: ../fish/guestfish-actions.pod:3321
26677 "This is the same as the L</mount> command, but it allows you to set the "
26678 "mount options as for the L<mount(8)> I<-o> flag."
26682 #: ../fish/guestfish-actions.pod:3329
26687 #: ../fish/guestfish-actions.pod:3331
26690 " mount-ro device mountpoint\n"
26695 #: ../fish/guestfish-actions.pod:3333
26697 "This is the same as the L</mount> command, but it mounts the filesystem with "
26698 "the read-only (I<-o ro>) flag."
26702 #: ../fish/guestfish-actions.pod:3336
26707 #: ../fish/guestfish-actions.pod:3338
26710 " mount-vfs options vfstype device mountpoint\n"
26715 #: ../fish/guestfish-actions.pod:3340
26717 "This is the same as the L</mount> command, but it allows you to set both the "
26718 "mount options and the vfstype as for the L<mount(8)> I<-o> and I<-t> flags."
26722 #: ../fish/guestfish-actions.pod:3344
26723 msgid "mountpoints"
26727 #: ../fish/guestfish-actions.pod:3346
26735 #: ../fish/guestfish-actions.pod:3348
26737 "This call is similar to L</mounts>. That call returns a list of devices. "
26738 "This one returns a hash table (map) of device name to directory where the "
26739 "device is mounted."
26743 #: ../fish/guestfish-actions.pod:3352
26748 #: ../fish/guestfish-actions.pod:3354
26756 #: ../fish/guestfish-actions.pod:3361
26757 msgid "See also: L</mountpoints>"
26761 #: ../fish/guestfish-actions.pod:3363
26766 #: ../fish/guestfish-actions.pod:3365
26774 #: ../fish/guestfish-actions.pod:3370
26775 msgid "ntfs-3g-probe"
26779 #: ../fish/guestfish-actions.pod:3372
26782 " ntfs-3g-probe true|false device\n"
26787 #: ../fish/guestfish-actions.pod:3386
26792 #: ../fish/guestfish-actions.pod:3388
26795 " ntfsresize device\n"
26800 #: ../fish/guestfish-actions.pod:3410
26801 msgid "ntfsresize-opts"
26805 #: ../fish/guestfish-actions.pod:3412
26808 " ntfsresize-opts device [size:..] [force:..]\n"
26813 #: ../fish/guestfish-actions.pod:3431
26815 "After the resize operation, the filesystem is always marked as requiring a "
26816 "consistency check (for safety). You have to boot into Windows to perform "
26817 "this check and clear this condition. If you I<don't> set the C<force> "
26818 "option then it is not possible to call L</ntfsresize-opts> multiple times on "
26819 "a single filesystem without booting into Windows between each resize."
26823 #: ../fish/guestfish-actions.pod:3444
26824 msgid "ntfsresize-size"
26828 #: ../fish/guestfish-actions.pod:3446
26831 " ntfsresize-size device size\n"
26836 #: ../fish/guestfish-actions.pod:3448
26838 "This command is the same as L</ntfsresize> except that it allows you to "
26839 "specify the new size (in bytes) explicitly."
26843 #: ../fish/guestfish-actions.pod:3458
26848 #: ../fish/guestfish-actions.pod:3460
26851 " part-add device prlogex startsect endsect\n"
26856 #: ../fish/guestfish-actions.pod:3462
26858 "This command adds a partition to C<device>. If there is no partition table "
26859 "on the device, call L</part-init> first."
26863 #: ../fish/guestfish-actions.pod:3474
26865 "Creating a partition which covers the whole disk is not so easy. Use L</"
26866 "part-disk> to do that."
26870 #: ../fish/guestfish-actions.pod:3477
26875 #: ../fish/guestfish-actions.pod:3479
26878 " part-del device partnum\n"
26883 #: ../fish/guestfish-actions.pod:3487
26888 #: ../fish/guestfish-actions.pod:3489
26891 " part-disk device parttype\n"
26896 #: ../fish/guestfish-actions.pod:3491
26898 "This command is simply a combination of L</part-init> followed by L</part-"
26899 "add> to create a single primary partition covering the whole disk."
26903 #: ../fish/guestfish-actions.pod:3495
26905 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
26906 "possible values are described in L</part-init>."
26910 #: ../fish/guestfish-actions.pod:3501
26911 msgid "part-get-bootable"
26915 #: ../fish/guestfish-actions.pod:3503
26918 " part-get-bootable device partnum\n"
26923 #: ../fish/guestfish-actions.pod:3508
26924 msgid "See also L</part-set-bootable>."
26928 #: ../fish/guestfish-actions.pod:3510
26929 msgid "part-get-mbr-id"
26933 #: ../fish/guestfish-actions.pod:3512
26936 " part-get-mbr-id device partnum\n"
26941 #: ../fish/guestfish-actions.pod:3517 ../fish/guestfish-actions.pod:3655
26943 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
26944 "undefined results for other partition table types (see L</part-get-"
26949 #: ../fish/guestfish-actions.pod:3521
26950 msgid "part-get-parttype"
26954 #: ../fish/guestfish-actions.pod:3523
26957 " part-get-parttype device\n"
26962 #: ../fish/guestfish-actions.pod:3528
26964 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
26965 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
26966 "possible, although unusual. See L</part-init> for a full list."
26970 #: ../fish/guestfish-actions.pod:3533
26975 #: ../fish/guestfish-actions.pod:3535
26978 " part-init device parttype\n"
26983 #: ../fish/guestfish-actions.pod:3541
26985 "Initially there are no partitions. Following this, you should call L</part-"
26986 "add> for each partition required."
26990 #: ../fish/guestfish-actions.pod:3604
26995 #: ../fish/guestfish-actions.pod:3606
26998 " part-list device\n"
27003 #: ../fish/guestfish-actions.pod:3621
27005 "Start of the partition I<in bytes>. To get sectors you have to divide by "
27006 "the device's sector size, see L</blockdev-getss>."
27010 #: ../fish/guestfish-actions.pod:3634
27011 msgid "part-set-bootable"
27015 #: ../fish/guestfish-actions.pod:3636
27018 " part-set-bootable device partnum true|false\n"
27023 #: ../fish/guestfish-actions.pod:3645
27024 msgid "part-set-mbr-id"
27028 #: ../fish/guestfish-actions.pod:3647
27031 " part-set-mbr-id device partnum idbyte\n"
27036 #: ../fish/guestfish-actions.pod:3659
27037 msgid "part-set-name"
27041 #: ../fish/guestfish-actions.pod:3661
27044 " part-set-name device partnum name\n"
27049 #: ../fish/guestfish-actions.pod:3669
27050 msgid "part-to-dev"
27054 #: ../fish/guestfish-actions.pod:3671
27057 " part-to-dev partition\n"
27062 #: ../fish/guestfish-actions.pod:3677
27064 "The named partition must exist, for example as a string returned from L</"
27065 "list-partitions>."
27069 #: ../fish/guestfish-actions.pod:3680
27070 msgid "ping-daemon"
27074 #: ../fish/guestfish-actions.pod:3682
27082 #: ../fish/guestfish-actions.pod:3689
27087 #: ../fish/guestfish-actions.pod:3691
27090 " pread path count offset\n"
27095 #: ../fish/guestfish-actions.pod:3699
27096 msgid "See also L</pwrite>, L</pread-device>."
27100 #: ../fish/guestfish-actions.pod:3704
27101 msgid "pread-device"
27105 #: ../fish/guestfish-actions.pod:3706
27108 " pread-device device count offset\n"
27113 #: ../fish/guestfish-actions.pod:3714
27114 msgid "See also L</pread>."
27118 #: ../fish/guestfish-actions.pod:3719
27123 #: ../fish/guestfish-actions.pod:3721
27126 " pvcreate device\n"
27131 #: ../fish/guestfish-actions.pod:3727
27136 #: ../fish/guestfish-actions.pod:3729
27139 " pvremove device\n"
27144 #: ../fish/guestfish-actions.pod:3738
27149 #: ../fish/guestfish-actions.pod:3740
27152 " pvresize device\n"
27157 #: ../fish/guestfish-actions.pod:3745
27158 msgid "pvresize-size"
27162 #: ../fish/guestfish-actions.pod:3747
27165 " pvresize-size device size\n"
27170 #: ../fish/guestfish-actions.pod:3749
27172 "This command is the same as L</pvresize> except that it allows you to "
27173 "specify the new size (in bytes) explicitly."
27177 #: ../fish/guestfish-actions.pod:3752
27182 #: ../fish/guestfish-actions.pod:3754
27190 #: ../fish/guestfish-actions.pod:3762
27191 msgid "See also L</pvs-full>."
27195 #: ../fish/guestfish-actions.pod:3764
27200 #: ../fish/guestfish-actions.pod:3766
27208 #: ../fish/guestfish-actions.pod:3771
27213 #: ../fish/guestfish-actions.pod:3773
27221 #: ../fish/guestfish-actions.pod:3777
27226 #: ../fish/guestfish-actions.pod:3779
27229 " pwrite path content offset\n"
27234 #: ../fish/guestfish-actions.pod:3790
27235 msgid "See also L</pread>, L</pwrite-device>."
27239 #: ../fish/guestfish-actions.pod:3795
27240 msgid "pwrite-device"
27244 #: ../fish/guestfish-actions.pod:3797
27247 " pwrite-device device content offset\n"
27252 #: ../fish/guestfish-actions.pod:3807
27253 msgid "See also L</pwrite>."
27257 #: ../fish/guestfish-actions.pod:3812
27262 #: ../fish/guestfish-actions.pod:3814
27265 " read-file path\n"
27270 #: ../fish/guestfish-actions.pod:3819
27272 "Unlike L</cat>, this function can correctly handle files that contain "
27273 "embedded ASCII NUL characters. However unlike L</download>, this function "
27274 "is limited in the total size of file that can be handled."
27278 #: ../fish/guestfish-actions.pod:3827
27283 #: ../fish/guestfish-actions.pod:3829
27286 " read-lines path\n"
27291 #: ../fish/guestfish-actions.pod:3836
27293 "Note that this function cannot correctly handle binary files (specifically, "
27294 "files containing C<\\0> character which is treated as end of line). For "
27295 "those you need to use the L</read-file> function which has a more complex "
27300 #: ../fish/guestfish-actions.pod:3841
27305 #: ../fish/guestfish-actions.pod:3843
27313 #: ../fish/guestfish-actions.pod:3895
27315 "This function is primarily intended for use by programs. To get a simple "
27316 "list of names, use L</ls>. To get a printable directory for human "
27317 "consumption, use L</ll>."
27321 #: ../fish/guestfish-actions.pod:3899
27326 #: ../fish/guestfish-actions.pod:3901
27334 #: ../fish/guestfish-actions.pod:3905
27335 msgid "readlinklist"
27339 #: ../fish/guestfish-actions.pod:3907
27342 " readlinklist path 'names ...'\n"
27347 #: ../fish/guestfish-actions.pod:3931
27352 #: ../fish/guestfish-actions.pod:3933
27360 #: ../fish/guestfish-actions.pod:3938
27361 msgid "removexattr"
27365 #: ../fish/guestfish-actions.pod:3940
27368 " removexattr xattr path\n"
27373 #: ../fish/guestfish-actions.pod:3945
27374 msgid "See also: L</lremovexattr>, L<attr(5)>."
27378 #: ../fish/guestfish-actions.pod:3947
27383 #: ../fish/guestfish-actions.pod:3949
27386 " resize2fs device\n"
27391 #: ../fish/guestfish-actions.pod:3954
27393 "I<Note:> It is sometimes required that you run L</e2fsck-f> on the C<device> "
27394 "before calling this command. For unknown reasons C<resize2fs> sometimes "
27395 "gives an error about this and sometimes not. In any case, it is always safe "
27396 "to call L</e2fsck-f> before calling this function."
27400 #: ../fish/guestfish-actions.pod:3960
27401 msgid "resize2fs-M"
27405 #: ../fish/guestfish-actions.pod:3962
27408 " resize2fs-M device\n"
27413 #: ../fish/guestfish-actions.pod:3964
27415 "This command is the same as L</resize2fs>, but the filesystem is resized to "
27416 "its minimum size. This works like the I<-M> option to the C<resize2fs> "
27421 #: ../fish/guestfish-actions.pod:3968
27423 "To get the resulting size of the filesystem you should call L</tune2fs-l> "
27424 "and read the C<Block size> and C<Block count> values. These two numbers, "
27425 "multiplied together, give the resulting size of the minimal filesystem in "
27430 #: ../fish/guestfish-actions.pod:3973
27431 msgid "resize2fs-size"
27435 #: ../fish/guestfish-actions.pod:3975
27438 " resize2fs-size device size\n"
27443 #: ../fish/guestfish-actions.pod:3977
27445 "This command is the same as L</resize2fs> except that it allows you to "
27446 "specify the new size (in bytes) explicitly."
27450 #: ../fish/guestfish-actions.pod:3980
27455 #: ../fish/guestfish-actions.pod:3982
27463 #: ../fish/guestfish-actions.pod:3986
27468 #: ../fish/guestfish-actions.pod:3988
27476 #: ../fish/guestfish-actions.pod:3994
27481 #: ../fish/guestfish-actions.pod:3996
27489 #: ../fish/guestfish-actions.pod:4000
27490 msgid "rmmountpoint"
27494 #: ../fish/guestfish-actions.pod:4002
27497 " rmmountpoint exemptpath\n"
27502 #: ../fish/guestfish-actions.pod:4004
27504 "This calls removes a mountpoint that was previously created with L</"
27505 "mkmountpoint>. See L</mkmountpoint> for full details."
27509 #: ../fish/guestfish-actions.pod:4008
27510 msgid "scrub-device"
27514 #: ../fish/guestfish-actions.pod:4010
27517 " scrub-device device\n"
27522 #: ../fish/guestfish-actions.pod:4021
27527 #: ../fish/guestfish-actions.pod:4023
27530 " scrub-file file\n"
27535 #: ../fish/guestfish-actions.pod:4033
27536 msgid "scrub-freespace"
27540 #: ../fish/guestfish-actions.pod:4035
27543 " scrub-freespace dir\n"
27548 #: ../fish/guestfish-actions.pod:4037
27550 "This command creates the directory C<dir> and then fills it with files until "
27551 "the filesystem is full, and scrubs the files as for L</scrub-file>, and "
27552 "deletes them. The intention is to scrub any free space on the partition "
27553 "containing C<dir>."
27557 #: ../fish/guestfish-actions.pod:4046
27562 #: ../fish/guestfish-actions.pod:4048
27567 #: ../fish/guestfish-actions.pod:4050
27570 " set-append append\n"
27575 #: ../fish/guestfish-actions.pod:4061
27576 msgid "set-attach-method"
27580 #: ../fish/guestfish-actions.pod:4063
27581 msgid "attach-method"
27585 #: ../fish/guestfish-actions.pod:4065
27588 " set-attach-method attachmethod\n"
27593 #: ../fish/guestfish-actions.pod:4087
27594 msgid "set-autosync"
27598 #: ../fish/guestfish-actions.pod:4089
27603 #: ../fish/guestfish-actions.pod:4091
27606 " set-autosync true|false\n"
27611 #: ../fish/guestfish-actions.pod:4101
27616 #: ../fish/guestfish-actions.pod:4103
27621 #: ../fish/guestfish-actions.pod:4105
27624 " set-direct true|false\n"
27629 #: ../fish/guestfish-actions.pod:4111
27631 "One consequence of this is that log messages aren't caught by the library "
27632 "and handled by L</set-log-message-callback>, but go straight to stdout."
27636 #: ../fish/guestfish-actions.pod:4120
27637 msgid "set-e2label"
27641 #: ../fish/guestfish-actions.pod:4122
27644 " set-e2label device label\n"
27649 #: ../fish/guestfish-actions.pod:4128
27651 "You can use either L</tune2fs-l> or L</get-e2label> to return the existing "
27652 "label on a filesystem."
27656 #: ../fish/guestfish-actions.pod:4131
27661 #: ../fish/guestfish-actions.pod:4133
27664 " set-e2uuid device uuid\n"
27669 #: ../fish/guestfish-actions.pod:4140
27671 "You can use either L</tune2fs-l> or L</get-e2uuid> to return the existing "
27672 "UUID of a filesystem."
27676 #: ../fish/guestfish-actions.pod:4143
27677 msgid "set-memsize"
27681 #: ../fish/guestfish-actions.pod:4145
27686 #: ../fish/guestfish-actions.pod:4147
27689 " set-memsize memsize\n"
27694 #: ../fish/guestfish-actions.pod:4149
27696 "This sets the memory size in megabytes allocated to the qemu subprocess. "
27697 "This only has any effect if called before L</launch>."
27701 #: ../fish/guestfish-actions.pod:4160
27702 msgid "set-network"
27706 #: ../fish/guestfish-actions.pod:4162
27711 #: ../fish/guestfish-actions.pod:4164
27714 " set-network true|false\n"
27719 #: ../fish/guestfish-actions.pod:4172
27721 "You must call this before calling L</launch>, otherwise it has no effect."
27725 #: ../fish/guestfish-actions.pod:4175
27730 #: ../fish/guestfish-actions.pod:4177
27735 #: ../fish/guestfish-actions.pod:4179
27738 " set-path searchpath\n"
27743 #: ../fish/guestfish-actions.pod:4188
27748 #: ../fish/guestfish-actions.pod:4190
27753 #: ../fish/guestfish-actions.pod:4192
27756 " set-pgroup true|false\n"
27761 #: ../fish/guestfish-actions.pod:4203
27766 #: ../fish/guestfish-actions.pod:4205
27771 #: ../fish/guestfish-actions.pod:4207
27779 #: ../fish/guestfish-actions.pod:4227
27780 msgid "set-recovery-proc"
27784 #: ../fish/guestfish-actions.pod:4229
27785 msgid "recovery-proc"
27789 #: ../fish/guestfish-actions.pod:4231
27792 " set-recovery-proc true|false\n"
27797 #: ../fish/guestfish-actions.pod:4233
27799 "If this is called with the parameter C<false> then L</launch> does not "
27800 "create a recovery process. The purpose of the recovery process is to stop "
27801 "runaway qemu processes in the case where the main program aborts abruptly."
27805 #: ../fish/guestfish-actions.pod:4238
27807 "This only has any effect if called before L</launch>, and the default is "
27812 #: ../fish/guestfish-actions.pod:4247
27813 msgid "set-selinux"
27817 #: ../fish/guestfish-actions.pod:4249
27822 #: ../fish/guestfish-actions.pod:4251
27825 " set-selinux true|false\n"
27830 #: ../fish/guestfish-actions.pod:4262
27835 #: ../fish/guestfish-actions.pod:4264
27840 #: ../fish/guestfish-actions.pod:4266
27843 " set-trace true|false\n"
27848 #: ../fish/guestfish-actions.pod:4278
27850 "Trace messages are normally sent to C<stderr>, unless you register a "
27851 "callback to send them somewhere else (see L</set-event-callback>)."
27855 #: ../fish/guestfish-actions.pod:4282
27856 msgid "set-verbose"
27860 #: ../fish/guestfish-actions.pod:4284
27865 #: ../fish/guestfish-actions.pod:4286
27868 " set-verbose true|false\n"
27873 #: ../fish/guestfish-actions.pod:4293
27875 "Verbose messages are normally sent to C<stderr>, unless you register a "
27876 "callback to send them somewhere else (see L</set-event-callback>)."
27880 #: ../fish/guestfish-actions.pod:4297
27885 #: ../fish/guestfish-actions.pod:4299
27888 " setcon context\n"
27893 #: ../fish/guestfish-actions.pod:4306
27898 #: ../fish/guestfish-actions.pod:4308
27901 " setxattr xattr val vallen path\n"
27906 #: ../fish/guestfish-actions.pod:4314
27907 msgid "See also: L</lsetxattr>, L<attr(5)>."
27911 #: ../fish/guestfish-actions.pod:4316
27916 #: ../fish/guestfish-actions.pod:4318
27919 " sfdisk device cyls heads sectors 'lines ...'\n"
27924 #: ../fish/guestfish-actions.pod:4340
27925 msgid "See also: L</sfdisk-l>, L</sfdisk-N>, L</part-init>"
27929 #: ../fish/guestfish-actions.pod:4353
27934 #: ../fish/guestfish-actions.pod:4355
27937 " sfdiskM device 'lines ...'\n"
27942 #: ../fish/guestfish-actions.pod:4357
27944 "This is a simplified interface to the L</sfdisk> command, where partition "
27945 "sizes are specified in megabytes only (rounded to the nearest cylinder) and "
27946 "you don't need to specify the cyls, heads and sectors parameters which were "
27947 "rarely if ever used anyway."
27951 #: ../fish/guestfish-actions.pod:4363
27952 msgid "See also: L</sfdisk>, the L<sfdisk(8)> manpage and L</part-disk>"
27956 #: ../fish/guestfish-actions.pod:4376
27961 #: ../fish/guestfish-actions.pod:4378
27964 " sfdisk-N device partnum cyls heads sectors line\n"
27969 #: ../fish/guestfish-actions.pod:4383
27971 "For other parameters, see L</sfdisk>. You should usually pass C<0> for the "
27972 "cyls/heads/sectors parameters."
27976 #: ../fish/guestfish-actions.pod:4386
27977 msgid "See also: L</part-add>"
27981 #: ../fish/guestfish-actions.pod:4398
27982 msgid "sfdisk-disk-geometry"
27986 #: ../fish/guestfish-actions.pod:4400
27989 " sfdisk-disk-geometry device\n"
27994 #: ../fish/guestfish-actions.pod:4402
27996 "This displays the disk geometry of C<device> read from the partition table. "
27997 "Especially in the case where the underlying block device has been resized, "
27998 "this can be different from the kernel's idea of the geometry (see L</sfdisk-"
27999 "kernel-geometry>)."
28003 #: ../fish/guestfish-actions.pod:4410
28004 msgid "sfdisk-kernel-geometry"
28008 #: ../fish/guestfish-actions.pod:4412
28011 " sfdisk-kernel-geometry device\n"
28016 #: ../fish/guestfish-actions.pod:4419
28021 #: ../fish/guestfish-actions.pod:4421
28024 " sfdisk-l device\n"
28029 #: ../fish/guestfish-actions.pod:4427
28030 msgid "See also: L</part-list>"
28034 #: ../fish/guestfish-actions.pod:4436
28039 #: ../fish/guestfish-actions.pod:4438
28047 #: ../fish/guestfish-actions.pod:4443
28048 msgid "This is like L</command>, but passes the command to:"
28052 #: ../fish/guestfish-actions.pod:4451
28053 msgid "All the provisos about L</command> apply to this call."
28057 #: ../fish/guestfish-actions.pod:4453
28062 #: ../fish/guestfish-actions.pod:4455
28065 " sh-lines command\n"
28070 #: ../fish/guestfish-actions.pod:4457
28071 msgid "This is the same as L</sh>, but splits the result into a list of lines."
28075 #: ../fish/guestfish-actions.pod:4460
28076 msgid "See also: L</command-lines>"
28080 #: ../fish/guestfish-actions.pod:4462
28085 #: ../fish/guestfish-actions.pod:4464
28093 #: ../fish/guestfish-actions.pod:4468
28098 #: ../fish/guestfish-actions.pod:4470
28106 #: ../fish/guestfish-actions.pod:4476
28111 #: ../fish/guestfish-actions.pod:4478
28119 #: ../fish/guestfish-actions.pod:4486
28124 #: ../fish/guestfish-actions.pod:4488
28132 #: ../fish/guestfish-actions.pod:4496
28137 #: ../fish/guestfish-actions.pod:4498
28140 " strings-e encoding path\n"
28145 #: ../fish/guestfish-actions.pod:4500
28147 "This is like the L</strings> command, but allows you to specify the encoding "
28148 "of strings that are looked for in the source file C<path>."
28152 #: ../fish/guestfish-actions.pod:4510
28154 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
28155 "ISO-8859-X (this is what L</strings> uses)."
28159 #: ../fish/guestfish-actions.pod:4542
28160 msgid "swapoff-device"
28164 #: ../fish/guestfish-actions.pod:4544
28167 " swapoff-device device\n"
28172 #: ../fish/guestfish-actions.pod:4546
28174 "This command disables the libguestfs appliance swap device or partition "
28175 "named C<device>. See L</swapon-device>."
28179 #: ../fish/guestfish-actions.pod:4550
28180 msgid "swapoff-file"
28184 #: ../fish/guestfish-actions.pod:4552
28187 " swapoff-file file\n"
28192 #: ../fish/guestfish-actions.pod:4556
28193 msgid "swapoff-label"
28197 #: ../fish/guestfish-actions.pod:4558
28200 " swapoff-label label\n"
28205 #: ../fish/guestfish-actions.pod:4563
28206 msgid "swapoff-uuid"
28210 #: ../fish/guestfish-actions.pod:4565
28213 " swapoff-uuid uuid\n"
28218 #: ../fish/guestfish-actions.pod:4570
28219 msgid "swapon-device"
28223 #: ../fish/guestfish-actions.pod:4572
28226 " swapon-device device\n"
28231 #: ../fish/guestfish-actions.pod:4574
28233 "This command enables the libguestfs appliance to use the swap device or "
28234 "partition named C<device>. The increased memory is made available for all "
28235 "commands, for example those run using L</command> or L</sh>."
28239 #: ../fish/guestfish-actions.pod:4586
28240 msgid "swapon-file"
28244 #: ../fish/guestfish-actions.pod:4588
28247 " swapon-file file\n"
28252 #: ../fish/guestfish-actions.pod:4590
28254 "This command enables swap to a file. See L</swapon-device> for other notes."
28258 #: ../fish/guestfish-actions.pod:4593
28259 msgid "swapon-label"
28263 #: ../fish/guestfish-actions.pod:4595
28266 " swapon-label label\n"
28271 #: ../fish/guestfish-actions.pod:4597
28273 "This command enables swap to a labeled swap partition. See L</swapon-"
28274 "device> for other notes."
28278 #: ../fish/guestfish-actions.pod:4600
28279 msgid "swapon-uuid"
28283 #: ../fish/guestfish-actions.pod:4602
28286 " swapon-uuid uuid\n"
28291 #: ../fish/guestfish-actions.pod:4604
28293 "This command enables swap to a swap partition with the given UUID. See L</"
28294 "swapon-device> for other notes."
28298 #: ../fish/guestfish-actions.pod:4607
28303 #: ../fish/guestfish-actions.pod:4609
28311 #: ../fish/guestfish-actions.pod:4617
28316 #: ../fish/guestfish-actions.pod:4619
28324 #: ../fish/guestfish-actions.pod:4627
28329 #: ../fish/guestfish-actions.pod:4629
28332 " tail-n nrlines path\n"
28337 #: ../fish/guestfish-actions.pod:4642
28342 #: ../fish/guestfish-actions.pod:4644
28345 " tar-in (tarfile|-) directory\n"
28350 #: ../fish/guestfish-actions.pod:4649
28351 msgid "To upload a compressed tarball, use L</tgz-in> or L</txz-in>."
28355 #: ../fish/guestfish-actions.pod:4654
28360 #: ../fish/guestfish-actions.pod:4656
28363 " tar-out directory (tarfile|-)\n"
28368 #: ../fish/guestfish-actions.pod:4661
28369 msgid "To download a compressed tarball, use L</tgz-out> or L</txz-out>."
28373 #: ../fish/guestfish-actions.pod:4666
28378 #: ../fish/guestfish-actions.pod:4668
28381 " tgz-in (tarball|-) directory\n"
28386 #: ../fish/guestfish-actions.pod:4673
28387 msgid "To upload an uncompressed tarball, use L</tar-in>."
28391 #: ../fish/guestfish-actions.pod:4677
28396 #: ../fish/guestfish-actions.pod:4679
28399 " tgz-out directory (tarball|-)\n"
28404 #: ../fish/guestfish-actions.pod:4684
28405 msgid "To download an uncompressed tarball, use L</tar-out>."
28409 #: ../fish/guestfish-actions.pod:4688
28414 #: ../fish/guestfish-actions.pod:4690
28422 #: ../fish/guestfish-actions.pod:4699
28427 #: ../fish/guestfish-actions.pod:4701
28435 #: ../fish/guestfish-actions.pod:4706
28436 msgid "truncate-size"
28440 #: ../fish/guestfish-actions.pod:4708
28443 " truncate-size path size\n"
28448 #: ../fish/guestfish-actions.pod:4713
28450 "If the current file size is less than C<size> then the file is extended to "
28451 "the required size with zero bytes. This creates a sparse file (ie. disk "
28452 "blocks are not allocated for the file until you write to it). To create a "
28453 "non-sparse file of zeroes, use L</fallocate64> instead."
28457 #: ../fish/guestfish-actions.pod:4719
28462 #: ../fish/guestfish-actions.pod:4721
28465 " tune2fs-l device\n"
28470 #: ../fish/guestfish-actions.pod:4731
28475 #: ../fish/guestfish-actions.pod:4733
28478 " txz-in (tarball|-) directory\n"
28483 #: ../fish/guestfish-actions.pod:4740
28488 #: ../fish/guestfish-actions.pod:4742
28491 " txz-out directory (tarball|-)\n"
28496 #: ../fish/guestfish-actions.pod:4749
28501 #: ../fish/guestfish-actions.pod:4751
28509 #: ../fish/guestfish-actions.pod:4765
28510 msgid "See also L</get-umask>, L<umask(2)>, L</mknod>, L</mkdir>."
28514 #: ../fish/guestfish-actions.pod:4770
28519 #: ../fish/guestfish-actions.pod:4772
28524 #: ../fish/guestfish-actions.pod:4774
28527 " umount pathordevice\n"
28532 #: ../fish/guestfish-actions.pod:4780
28537 #: ../fish/guestfish-actions.pod:4782
28538 msgid "unmount-all"
28542 #: ../fish/guestfish-actions.pod:4784
28550 #: ../fish/guestfish-actions.pod:4790
28555 #: ../fish/guestfish-actions.pod:4792
28558 " upload (filename|-) remotefilename\n"
28563 #: ../fish/guestfish-actions.pod:4799
28564 msgid "See also L</download>."
28568 #: ../fish/guestfish-actions.pod:4803
28569 msgid "upload-offset"
28573 #: ../fish/guestfish-actions.pod:4805
28576 " upload-offset (filename|-) remotefilename offset\n"
28581 #: ../fish/guestfish-actions.pod:4817
28583 "Note that there is no limit on the amount of data that can be uploaded with "
28584 "this call, unlike with L</pwrite>, and this call always writes the full "
28585 "amount unless an error occurs."
28589 #: ../fish/guestfish-actions.pod:4822
28590 msgid "See also L</upload>, L</pwrite>."
28594 #: ../fish/guestfish-actions.pod:4826
28599 #: ../fish/guestfish-actions.pod:4828
28602 " utimens path atsecs atnsecs mtsecs mtnsecs\n"
28607 #: ../fish/guestfish-actions.pod:4847
28612 #: ../fish/guestfish-actions.pod:4849
28620 #: ../fish/guestfish-actions.pod:4876
28622 "I<Note:> Don't use this call to test for availability of features. In "
28623 "enterprise distributions we backport features from later versions into "
28624 "earlier versions, making this an unreliable way to test for features. Use "
28625 "L</available> instead."
28629 #: ../fish/guestfish-actions.pod:4882
28634 #: ../fish/guestfish-actions.pod:4884
28637 " vfs-label device\n"
28642 #: ../fish/guestfish-actions.pod:4891
28643 msgid "To find a filesystem from the label, use L</findfs-label>."
28647 #: ../fish/guestfish-actions.pod:4893
28652 #: ../fish/guestfish-actions.pod:4895
28655 " vfs-type device\n"
28660 #: ../fish/guestfish-actions.pod:4905
28665 #: ../fish/guestfish-actions.pod:4907
28668 " vfs-uuid device\n"
28673 #: ../fish/guestfish-actions.pod:4914
28674 msgid "To find a filesystem from the UUID, use L</findfs-uuid>."
28678 #: ../fish/guestfish-actions.pod:4916
28679 msgid "vg-activate"
28683 #: ../fish/guestfish-actions.pod:4918
28686 " vg-activate true|false 'volgroups ...'\n"
28691 #: ../fish/guestfish-actions.pod:4928
28692 msgid "vg-activate-all"
28696 #: ../fish/guestfish-actions.pod:4930
28699 " vg-activate-all true|false\n"
28704 #: ../fish/guestfish-actions.pod:4937
28709 #: ../fish/guestfish-actions.pod:4939
28712 " vgcreate volgroup 'physvols ...'\n"
28717 #: ../fish/guestfish-actions.pod:4944
28722 #: ../fish/guestfish-actions.pod:4946
28725 " vglvuuids vgname\n"
28730 #: ../fish/guestfish-actions.pod:4951
28732 "You can use this along with L</lvs> and L</lvuuid> calls to associate "
28733 "logical volumes and volume groups."
28737 #: ../fish/guestfish-actions.pod:4954
28738 msgid "See also L</vgpvuuids>."
28742 #: ../fish/guestfish-actions.pod:4956
28747 #: ../fish/guestfish-actions.pod:4958
28750 " vgpvuuids vgname\n"
28755 #: ../fish/guestfish-actions.pod:4963
28757 "You can use this along with L</pvs> and L</pvuuid> calls to associate "
28758 "physical volumes and volume groups."
28762 #: ../fish/guestfish-actions.pod:4966
28763 msgid "See also L</vglvuuids>."
28767 #: ../fish/guestfish-actions.pod:4968
28772 #: ../fish/guestfish-actions.pod:4970
28775 " vgremove vgname\n"
28780 #: ../fish/guestfish-actions.pod:4977
28785 #: ../fish/guestfish-actions.pod:4979
28788 " vgrename volgroup newvolgroup\n"
28793 #: ../fish/guestfish-actions.pod:4983
28798 #: ../fish/guestfish-actions.pod:4985
28806 #: ../fish/guestfish-actions.pod:4993
28807 msgid "See also L</vgs-full>."
28811 #: ../fish/guestfish-actions.pod:4995
28816 #: ../fish/guestfish-actions.pod:4997
28824 #: ../fish/guestfish-actions.pod:5002
28829 #: ../fish/guestfish-actions.pod:5004
28837 #: ../fish/guestfish-actions.pod:5009
28842 #: ../fish/guestfish-actions.pod:5011
28850 #: ../fish/guestfish-actions.pod:5015
28855 #: ../fish/guestfish-actions.pod:5017
28863 #: ../fish/guestfish-actions.pod:5022
28868 #: ../fish/guestfish-actions.pod:5024
28876 #: ../fish/guestfish-actions.pod:5029
28881 #: ../fish/guestfish-actions.pod:5031
28889 #: ../fish/guestfish-actions.pod:5036
28894 #: ../fish/guestfish-actions.pod:5038
28897 " write path content\n"
28902 #: ../fish/guestfish-actions.pod:5043
28904 #| msgid "See L<guestfish(1)>."
28905 msgid "See also L</write-append>."
28906 msgstr "Див. L<guestfish(1)>."
28909 #: ../fish/guestfish-actions.pod:5048
28910 msgid "write-append"
28914 #: ../fish/guestfish-actions.pod:5050
28917 " write-append path content\n"
28922 #: ../fish/guestfish-actions.pod:5055
28924 #| msgid "See L<guestfish(1)>."
28925 msgid "See also L</write>."
28926 msgstr "Див. L<guestfish(1)>."
28929 #: ../fish/guestfish-actions.pod:5060
28934 #: ../fish/guestfish-actions.pod:5062
28937 " write-file path content size\n"
28942 #: ../fish/guestfish-actions.pod:5085
28947 #: ../fish/guestfish-actions.pod:5087
28950 " zegrep regex path\n"
28955 #: ../fish/guestfish-actions.pod:5095
28960 #: ../fish/guestfish-actions.pod:5097
28963 " zegrepi regex path\n"
28968 #: ../fish/guestfish-actions.pod:5105
28973 #: ../fish/guestfish-actions.pod:5107
28981 #: ../fish/guestfish-actions.pod:5115
28982 msgid "See also: L</zero-device>, L</scrub-device>, L</is-zero-device>"
28986 #: ../fish/guestfish-actions.pod:5118
28987 msgid "zero-device"
28991 #: ../fish/guestfish-actions.pod:5120
28994 " zero-device device\n"
28999 #: ../fish/guestfish-actions.pod:5122
29001 "This command writes zeroes over the entire C<device>. Compare with L</zero> "
29002 "which just zeroes the first few blocks of a device."
29006 #: ../fish/guestfish-actions.pod:5129
29011 #: ../fish/guestfish-actions.pod:5131
29014 " zerofree device\n"
29019 #: ../fish/guestfish-actions.pod:5144
29024 #: ../fish/guestfish-actions.pod:5146
29027 " zfgrep pattern path\n"
29032 #: ../fish/guestfish-actions.pod:5154
29037 #: ../fish/guestfish-actions.pod:5156
29040 " zfgrepi pattern path\n"
29045 #: ../fish/guestfish-actions.pod:5164
29050 #: ../fish/guestfish-actions.pod:5166
29053 " zfile meth path\n"
29058 #: ../fish/guestfish-actions.pod:5173
29060 "Since 1.0.63, use L</file> instead which can now process compressed files."
29064 #: ../fish/guestfish-actions.pod:5183
29069 #: ../fish/guestfish-actions.pod:5185
29072 " zgrep regex path\n"
29077 #: ../fish/guestfish-actions.pod:5193
29082 #: ../fish/guestfish-actions.pod:5195
29085 " zgrepi regex path\n"
29090 #: ../fish/guestfish-commands.pod:1
29095 #: ../fish/guestfish-commands.pod:3
29100 #: ../fish/guestfish-commands.pod:5
29103 " alloc filename size\n"
29108 #: ../fish/guestfish-commands.pod:7
29110 "This creates an empty (zeroed) file of the given size, and then adds so it "
29111 "can be further examined."
29115 #: ../fish/guestfish-commands.pod:10 ../fish/guestfish-commands.pod:182
29116 msgid "For more advanced image creation, see L<qemu-img(1)> utility."
29120 #: ../fish/guestfish-commands.pod:12 ../fish/guestfish-commands.pod:184
29121 msgid "Size can be specified using standard suffixes, eg. C<1M>."
29125 #: ../fish/guestfish-commands.pod:14
29127 "To create a sparse file, use L</sparse> instead. To create a prepared disk "
29128 "image, see L</PREPARED DISK IMAGES>."
29132 #: ../fish/guestfish-commands.pod:17
29137 #: ../fish/guestfish-commands.pod:19
29140 " copy-in local [local ...] /remotedir\n"
29145 #: ../fish/guestfish-commands.pod:21
29147 "C<copy-in> copies local files or directories recursively into the disk "
29148 "image, placing them in the directory called C</remotedir> (which must "
29149 "exist). This guestfish meta-command turns into a sequence of L</tar-in> and "
29150 "other commands as necessary."
29154 #: ../fish/guestfish-commands.pod:26
29156 "Multiple local files and directories can be specified, but the last "
29157 "parameter must always be a remote directory. Wildcards cannot be used."
29161 #: ../fish/guestfish-commands.pod:30
29166 #: ../fish/guestfish-commands.pod:32
29169 " copy-out remote [remote ...] localdir\n"
29174 #: ../fish/guestfish-commands.pod:34
29176 "C<copy-out> copies remote files or directories recursively out of the disk "
29177 "image, placing them on the host disk in a local directory called C<localdir> "
29178 "(which must exist). This guestfish meta-command turns into a sequence of L</"
29179 "download>, L</tar-out> and other commands as necessary."
29183 #: ../fish/guestfish-commands.pod:40
29185 "Multiple remote files and directories can be specified, but the last "
29186 "parameter must always be a local directory. To download to the current "
29187 "directory, use C<.> as in:"
29191 #: ../fish/guestfish-commands.pod:44
29194 " copy-out /home .\n"
29199 #: ../fish/guestfish-commands.pod:46
29201 "Wildcards cannot be used in the ordinary command, but you can use them with "
29202 "the help of L</glob> like this:"
29206 #: ../fish/guestfish-commands.pod:49
29209 " glob copy-out /home/* .\n"
29214 #: ../fish/guestfish-commands.pod:51
29219 #: ../fish/guestfish-commands.pod:53
29222 " display filename\n"
29227 #: ../fish/guestfish-commands.pod:55
29229 "Use C<display> (a graphical display program) to display an image file. It "
29230 "downloads the file, and runs C<display> on it."
29234 #: ../fish/guestfish-commands.pod:58
29236 "To use an alternative program, set the C<GUESTFISH_DISPLAY_IMAGE> "
29237 "environment variable. For example to use the GNOME display program:"
29241 #: ../fish/guestfish-commands.pod:61
29244 " export GUESTFISH_DISPLAY_IMAGE=eog\n"
29249 #: ../fish/guestfish-commands.pod:63
29251 #| msgid "See L<guestfish(1)>."
29252 msgid "See also L<display(1)>."
29253 msgstr "Див. L<guestfish(1)>."
29256 #: ../fish/guestfish-commands.pod:65
29261 #: ../fish/guestfish-commands.pod:67
29264 " echo [params ...]\n"
29269 #: ../fish/guestfish-commands.pod:69
29270 msgid "This echos the parameters to the terminal."
29274 #: ../fish/guestfish-commands.pod:71
29279 #: ../fish/guestfish-commands.pod:73
29284 #: ../fish/guestfish-commands.pod:75
29289 #: ../fish/guestfish-commands.pod:77
29297 #: ../fish/guestfish-commands.pod:79
29299 "This is used to edit a file. It downloads the file, edits it locally using "
29300 "your editor, then uploads the result."
29304 #: ../fish/guestfish-commands.pod:82
29306 "The editor is C<$EDITOR>. However if you use the alternate commands C<vi> "
29307 "or C<emacs> you will get those corresponding editors."
29311 #: ../fish/guestfish-commands.pod:86
29316 #: ../fish/guestfish-commands.pod:88
29319 " glob command args...\n"
29324 #: ../fish/guestfish-commands.pod:90
29326 "Expand wildcards in any paths in the args list, and run C<command> "
29327 "repeatedly on each matching path."
29331 #: ../fish/guestfish-commands.pod:93
29332 msgid "See L</WILDCARDS AND GLOBBING>."
29336 #: ../fish/guestfish-commands.pod:95
29341 #: ../fish/guestfish-commands.pod:97
29344 " hexedit <filename|device>\n"
29345 " hexedit <filename|device> <max>\n"
29346 " hexedit <filename|device> <start> <max>\n"
29351 #: ../fish/guestfish-commands.pod:101
29353 "Use hexedit (a hex editor) to edit all or part of a binary file or block "
29358 #: ../fish/guestfish-commands.pod:104
29360 "This command works by downloading potentially the whole file or device, "
29361 "editing it locally, then uploading it. If the file or device is large, you "
29362 "have to specify which part you wish to edit by using C<max> and/or C<start> "
29363 "C<max> parameters. C<start> and C<max> are specified in bytes, with the "
29364 "usual modifiers allowed such as C<1M> (1 megabyte)."
29368 #: ../fish/guestfish-commands.pod:111
29369 msgid "For example to edit the first few sectors of a disk you might do:"
29373 #: ../fish/guestfish-commands.pod:114
29376 " hexedit /dev/sda 1M\n"
29381 #: ../fish/guestfish-commands.pod:116
29383 "which would allow you to edit anywhere within the first megabyte of the disk."
29387 #: ../fish/guestfish-commands.pod:119
29388 msgid "To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:"
29392 #: ../fish/guestfish-commands.pod:121
29395 " hexedit /dev/sda1 0x400 0x400\n"
29400 #: ../fish/guestfish-commands.pod:123
29401 msgid "(assuming the superblock is in the standard location)."
29405 #: ../fish/guestfish-commands.pod:125
29407 "This command requires the external L<hexedit(1)> program. You can specify "
29408 "another program to use by setting the C<HEXEDITOR> environment variable."
29412 #: ../fish/guestfish-commands.pod:129
29413 msgid "See also L</hexdump>."
29417 #: ../fish/guestfish-commands.pod:131
29422 #: ../fish/guestfish-commands.pod:133
29430 #: ../fish/guestfish-commands.pod:135
29432 "Change the local directory, ie. the current directory of guestfish itself."
29436 #: ../fish/guestfish-commands.pod:138
29437 msgid "Note that C<!cd> won't do what you might expect."
29441 #: ../fish/guestfish-commands.pod:140
29446 #: ../fish/guestfish-commands.pod:142
29451 #: ../fish/guestfish-commands.pod:144
29459 #: ../fish/guestfish-commands.pod:146
29460 msgid "Opens the manual page for guestfish."
29464 #: ../fish/guestfish-commands.pod:148
29469 #: ../fish/guestfish-commands.pod:150
29474 #: ../fish/guestfish-commands.pod:152
29482 #: ../fish/guestfish-commands.pod:154
29490 #: ../fish/guestfish-commands.pod:156
29491 msgid "This is used to view a file."
29495 #: ../fish/guestfish-commands.pod:158
29497 "The default viewer is C<$PAGER>. However if you use the alternate command "
29498 "C<less> you will get the C<less> command specifically."
29502 #: ../fish/guestfish-commands.pod:161
29507 #: ../fish/guestfish-commands.pod:163
29515 #: ../fish/guestfish-commands.pod:165
29517 "Close and reopen the libguestfs handle. It is not necessary to use this "
29518 "normally, because the handle is closed properly when guestfish exits. "
29519 "However this is occasionally useful for testing."
29523 #: ../fish/guestfish-commands.pod:169
29528 #: ../fish/guestfish-commands.pod:171
29531 " sparse filename size\n"
29536 #: ../fish/guestfish-commands.pod:173
29538 "This creates an empty sparse file of the given size, and then adds so it can "
29539 "be further examined."
29543 #: ../fish/guestfish-commands.pod:176
29545 "In all respects it works the same as the L</alloc> command, except that the "
29546 "image file is allocated sparsely, which means that disk blocks are not "
29547 "assigned to the file until they are needed. Sparse disk files only use "
29548 "space when written to, but they are slower and there is a danger you could "
29549 "run out of real disk space during a write operation."
29553 #: ../fish/guestfish-commands.pod:186
29558 #: ../fish/guestfish-commands.pod:188
29566 #: ../fish/guestfish-commands.pod:190
29568 "This command returns a list of the optional groups known to the daemon, and "
29569 "indicates which ones are supported by this build of the libguestfs appliance."
29573 #: ../fish/guestfish-commands.pod:194
29574 msgid "See also L<guestfs(3)/AVAILABILITY>."
29578 #: ../fish/guestfish-commands.pod:196
29583 #: ../fish/guestfish-commands.pod:198
29586 " time command args...\n"
29591 #: ../fish/guestfish-commands.pod:200
29593 "Run the command as usual, but print the elapsed time afterwards. This can "
29594 "be useful for benchmarking operations."
29598 #: ../test-tool/libguestfs-test-tool.pod:5
29599 msgid "libguestfs-test-tool - End user tests for libguestfs"
29603 #: ../test-tool/libguestfs-test-tool.pod:9
29606 " libguestfs-test-tool [--options]\n"
29611 #: ../test-tool/libguestfs-test-tool.pod:13
29613 "libguestfs-test-tool is a test program shipped with libguestfs to end users "
29614 "and developers, to allow them to check basic libguestfs functionality is "
29615 "working. This is needed because libguestfs occasionally breaks for reasons "
29616 "beyond our control: usually because of changes in the underlying qemu or "
29617 "kernel packages, or the host environment."
29621 #: ../test-tool/libguestfs-test-tool.pod:20
29622 msgid "If you suspect a problem in libguestfs, then just run:"
29626 #: ../test-tool/libguestfs-test-tool.pod:22
29629 " libguestfs-test-tool\n"
29634 #: ../test-tool/libguestfs-test-tool.pod:24
29635 msgid "It will print lots of diagnostic messages."
29639 #: ../test-tool/libguestfs-test-tool.pod:26
29640 msgid "If it runs to completion successfully, you will see this near the end:"
29644 #: ../test-tool/libguestfs-test-tool.pod:28
29647 " ===== TEST FINISHED OK =====\n"
29652 #: ../test-tool/libguestfs-test-tool.pod:30
29653 msgid "and the test tool will exit with code 0."
29657 #: ../test-tool/libguestfs-test-tool.pod:32
29659 "If it fails (and/or exits with non-zero error code), please paste the "
29660 "B<complete, unedited> output of the test tool into a bug report. More "
29661 "information about reporting bugs can be found on the L<http://libguestfs.org/"
29666 #: ../test-tool/libguestfs-test-tool.pod:41
29671 #: ../test-tool/libguestfs-test-tool.pod:43
29672 msgid "Display short usage information and exit."
29676 #: ../test-tool/libguestfs-test-tool.pod:45
29677 msgid "I<--qemu qemu_binary>"
29681 #: ../test-tool/libguestfs-test-tool.pod:47
29683 "If you have downloaded another qemu binary, point this option at the full "
29684 "path of the binary to try it."
29688 #: ../test-tool/libguestfs-test-tool.pod:50
29689 msgid "I<--qemudir qemu_source_dir>"
29693 #: ../test-tool/libguestfs-test-tool.pod:52
29695 "If you have compiled qemu from source, point this option at the source "
29696 "directory to try it."
29700 #: ../test-tool/libguestfs-test-tool.pod:55
29701 msgid "I<--timeout N>"
29705 #: ../test-tool/libguestfs-test-tool.pod:57
29707 "Set the launch timeout to C<N> seconds. The default is 120 seconds which "
29708 "does not usually need to be adjusted unless your machine is very slow."
29712 #: ../test-tool/libguestfs-test-tool.pod:63
29713 msgid "TRYING OUT A DIFFERENT VERSION OF QEMU"
29717 #: ../test-tool/libguestfs-test-tool.pod:65
29719 "If you have compiled another version of qemu from source and would like to "
29720 "try that, then you can use the I<--qemudir> option to point to the qemu "
29721 "source directory."
29725 #: ../test-tool/libguestfs-test-tool.pod:69
29727 "If you have downloaded a qemu binary from somewhere, use the I<--qemu> "
29728 "option to point to the binary."
29732 #: ../test-tool/libguestfs-test-tool.pod:72
29734 "When using an alternate qemu with libguestfs, usually you would need to "
29735 "write a qemu wrapper script (see section I<QEMU WRAPPERS> in L<guestfs(3)"
29736 ">). libguestfs-test-tool writes a temporary qemu wrapper script when you "
29737 "use either of the I<--qemudir> or I<--qemu> options."
29741 #: ../test-tool/libguestfs-test-tool.pod:79
29743 "libguestfs-test-tool returns I<0> if the tests completed without error, or "
29744 "I<1> if there was an error."
29748 #: ../test-tool/libguestfs-test-tool.pod:84
29750 "For the full list of environment variables which may affect libguestfs, "
29751 "please see the L<guestfs(3)> manual page."
29755 #: ../test-tool/libguestfs-test-tool.pod:89
29756 msgid "L<guestfs(3)>, L<http://libguestfs.org/>, L<http://qemu.org/>."
29760 #: ../fuse/guestmount.pod:5
29762 "guestmount - Mount a guest filesystem on the host using FUSE and libguestfs"
29766 #: ../fuse/guestmount.pod:9
29769 " guestmount [--options] -a disk.img -m device [--ro] mountpoint\n"
29774 #: ../fuse/guestmount.pod:11
29777 " guestmount [--options] -a disk.img -i [--ro] mountpoint\n"
29782 #: ../fuse/guestmount.pod:13
29785 " guestmount [--options] -d Guest -i [--ro] mountpoint\n"
29790 #: ../fuse/guestmount.pod:17
29792 "You must I<not> use C<guestmount> in read-write mode on live virtual "
29793 "machines. If you do this, you risk disk corruption in the VM."
29797 #: ../fuse/guestmount.pod:22
29799 "The guestmount program can be used to mount virtual machine filesystems and "
29800 "other disk images on the host. It uses libguestfs for access to the guest "
29801 "filesystem, and FUSE (the \"filesystem in userspace\") to make it appear as "
29802 "a mountable device."
29806 #: ../fuse/guestmount.pod:27
29808 "Along with other options, you have to give at least one device (I<-a> "
29809 "option) or libvirt domain (I<-d> option), and at least one mountpoint (I<-m> "
29810 "option) or use the I<-i> inspection option. How this works is better "
29811 "explained in the L<guestfish(1)> manual page, or by looking at the examples "
29816 #: ../fuse/guestmount.pod:33
29818 "FUSE lets you mount filesystems as non-root. The mountpoint must be owned "
29819 "by you, and the filesystem will not be visible to any other users unless you "
29820 "make certain global configuration changes to C</etc/fuse.conf>. To unmount "
29821 "the filesystem, use the C<fusermount -u> command."
29825 #: ../fuse/guestmount.pod:41
29827 "For a typical Windows guest which has its main filesystem on the first "
29832 #: ../fuse/guestmount.pod:44
29835 " guestmount -a windows.img -m /dev/sda1 --ro /mnt\n"
29840 #: ../fuse/guestmount.pod:46
29842 "For a typical Linux guest which has a /boot filesystem on the first "
29843 "partition, and the root filesystem on a logical volume:"
29847 #: ../fuse/guestmount.pod:49
29850 " guestmount -a linux.img -m /dev/VG/LV -m /dev/sda1:/boot --ro /mnt\n"
29855 #: ../fuse/guestmount.pod:51
29856 msgid "To get libguestfs to detect guest mountpoints for you:"
29860 #: ../fuse/guestmount.pod:53
29863 " guestmount -a guest.img -i --ro /mnt\n"
29868 #: ../fuse/guestmount.pod:55
29869 msgid "For a libvirt guest called \"Guest\" you could do:"
29873 #: ../fuse/guestmount.pod:57
29876 " guestmount -d Guest -i --ro /mnt\n"
29881 #: ../fuse/guestmount.pod:59
29883 "If you don't know what filesystems are contained in a guest or disk image, "
29884 "use L<virt-filesystems(1)> first:"
29888 #: ../fuse/guestmount.pod:62
29891 " virt-filesystems MyGuest\n"
29896 #: ../fuse/guestmount.pod:64
29898 "If you want to trace the libguestfs calls but without excessive debugging "
29899 "information, we recommend:"
29903 #: ../fuse/guestmount.pod:67
29906 " guestmount [...] --trace /mnt\n"
29911 #: ../fuse/guestmount.pod:69
29912 msgid "If you want to debug the program, we recommend:"
29916 #: ../fuse/guestmount.pod:71
29919 " guestmount [...] --trace --verbose /mnt\n"
29924 #: ../fuse/guestmount.pod:73
29929 #: ../fuse/guestmount.pod:75
29930 msgid "Other users cannot see the filesystem by default"
29934 #: ../fuse/guestmount.pod:77
29936 "If you mount a filesystem as one user (eg. root), then other users will not "
29937 "be able to see it by default. The fix is to add the FUSE C<allow_other> "
29938 "option when mounting:"
29942 #: ../fuse/guestmount.pod:81
29945 " sudo guestmount [...] -o allow_other /mnt\n"
29950 #: ../fuse/guestmount.pod:87
29951 msgid "B<-a image> | B<--add image>"
29955 #: ../fuse/guestmount.pod:89
29956 msgid "Add a block device or virtual machine image."
29960 #: ../fuse/guestmount.pod:94
29961 msgid "B<-c URI> | B<--connect URI>"
29965 #: ../fuse/guestmount.pod:100
29966 msgid "B<-d libvirt-domain> | B<--domain libvirt-domain>"
29970 #: ../fuse/guestmount.pod:108
29971 msgid "B<--dir-cache-timeout N>"
29975 #: ../fuse/guestmount.pod:110
29977 "Set the readdir cache timeout to I<N> seconds, the default being 60 "
29978 "seconds. The readdir cache [actually, there are several semi-independent "
29979 "caches] is populated after a readdir(2) call with the stat and extended "
29980 "attributes of the files in the directory, in anticipation that they will be "
29981 "requested soon after."
29985 #: ../fuse/guestmount.pod:116
29987 "There is also a different attribute cache implemented by FUSE (see the FUSE "
29988 "option I<-o attr_timeout>), but the FUSE cache does not anticipate future "
29989 "requests, only cache existing ones."
29993 #: ../fuse/guestmount.pod:127
29994 msgid "B<--format=raw|qcow2|..> | B<--format>"
29998 #: ../fuse/guestmount.pod:134
30000 "If you have untrusted raw-format guest disk images, you should use this "
30001 "option to specify the disk format. This avoids a possible security problem "
30002 "with malicious guests (CVE-2010-3851). See also L<guestfs(3)/"
30003 "guestfs_add_drive_opts>."
30007 #: ../fuse/guestmount.pod:139
30008 msgid "B<--fuse-help>"
30012 #: ../fuse/guestmount.pod:141
30013 msgid "Display help on special FUSE options (see I<-o> below)."
30017 #: ../fuse/guestmount.pod:145
30018 msgid "Display brief help and exit."
30022 #: ../fuse/guestmount.pod:147
30023 msgid "B<-i> | B<--inspector>"
30027 #: ../fuse/guestmount.pod:167
30029 "Mount the named partition or logical volume on the given mountpoint B<in the "
30030 "guest> (this has nothing to do with mountpoints in the host)."
30034 #: ../fuse/guestmount.pod:170
30036 "If the mountpoint is omitted, it defaults to C</>. You have to mount "
30037 "something on C</>."
30041 #: ../fuse/guestmount.pod:183
30042 msgid "B<-n> | B<--no-sync>"
30046 #: ../fuse/guestmount.pod:185
30048 "By default, we attempt to sync the guest disk when the FUSE mountpoint is "
30049 "unmounted. If you specify this option, then we don't attempt to sync the "
30050 "disk. See the discussion of autosync in the L<guestfs(3)> manpage."
30054 #: ../fuse/guestmount.pod:190
30055 msgid "B<-o option> | B<--option option>"
30059 #: ../fuse/guestmount.pod:192
30060 msgid "Pass extra options to FUSE."
30064 #: ../fuse/guestmount.pod:194
30066 "To get a list of all the extra options supported by FUSE, use the command "
30067 "below. Note that only the FUSE I<-o> options can be passed, and only some "
30068 "of them are a good idea."
30072 #: ../fuse/guestmount.pod:198
30075 " guestmount --fuse-help\n"
30080 #: ../fuse/guestmount.pod:200
30081 msgid "Some potentially useful FUSE options:"
30085 #: ../fuse/guestmount.pod:204
30086 msgid "B<-o allow_other>"
30090 #: ../fuse/guestmount.pod:206
30091 msgid "Allow other users to see the filesystem."
30095 #: ../fuse/guestmount.pod:208
30096 msgid "B<-o attr_timeout=N>"
30100 #: ../fuse/guestmount.pod:210
30101 msgid "Enable attribute caching by FUSE, and set the timeout to I<N> seconds."
30105 #: ../fuse/guestmount.pod:212
30106 msgid "B<-o kernel_cache>"
30110 #: ../fuse/guestmount.pod:214
30112 "Allow the kernel to cache files (reduces the number of reads that have to go "
30113 "through the L<guestfs(3)> API). This is generally a good idea if you can "
30114 "afford the extra memory usage."
30118 #: ../fuse/guestmount.pod:218
30119 msgid "B<-o uid=N> B<-o gid=N>"
30123 #: ../fuse/guestmount.pod:220
30125 "Use these options to map all UIDs and GIDs inside the guest filesystem to "
30126 "the chosen values."
30130 #: ../fuse/guestmount.pod:225
30131 msgid "B<-r> | B<--ro>"
30135 #: ../fuse/guestmount.pod:227
30137 "Add devices and mount everything read-only. Also disallow writes and make "
30138 "the disk appear read-only to FUSE."
30142 #: ../fuse/guestmount.pod:230
30144 "This is highly recommended if you are not going to edit the guest disk. If "
30145 "the guest is running and this option is I<not> supplied, then there is a "
30146 "strong risk of disk corruption in the guest. We try to prevent this from "
30147 "happening, but it is not always possible."
30151 #: ../fuse/guestmount.pod:235
30152 msgid "See also L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
30156 #: ../fuse/guestmount.pod:239
30157 msgid "Enable SELinux support for the guest."
30161 #: ../fuse/guestmount.pod:241
30162 msgid "B<-v> | B<--verbose>"
30166 #: ../fuse/guestmount.pod:243
30167 msgid "Enable verbose messages from underlying libguestfs."
30171 #: ../fuse/guestmount.pod:245
30172 msgid "B<-V> | B<--version>"
30176 #: ../fuse/guestmount.pod:247
30177 msgid "Display the program version and exit."
30181 #: ../fuse/guestmount.pod:249
30182 msgid "B<-w> | B<--rw>"
30186 #: ../fuse/guestmount.pod:254 ../fuse/guestmount.pod:275
30187 msgid "See L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
30191 #: ../fuse/guestmount.pod:256
30192 msgid "B<-x> | B<--trace>"
30196 #: ../fuse/guestmount.pod:258
30197 msgid "Trace libguestfs calls and entry into each FUSE function."
30201 #: ../fuse/guestmount.pod:260
30202 msgid "This also stops the daemon from forking into the background."
30206 #: ../fuse/guestmount.pod:281
30208 "L<guestfish(1)>, L<virt-inspector(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
30209 "L<virt-tar(1)>, L<guestfs(3)>, L<http://libguestfs.org/>, L<http://fuse.sf."
30214 #: ../fuse/guestmount.pod:296
30215 msgid "Copyright (C) 2009-2010 Red Hat Inc. L<http://libguestfs.org/>"
30219 #: ../tools/virt-win-reg.pl:37
30221 "virt-win-reg - Export and merge Windows Registry entries from a Windows guest"
30225 #: ../tools/virt-win-reg.pl:41
30228 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey'\n"
30233 #: ../tools/virt-win-reg.pl:43
30236 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' name\n"
30241 #: ../tools/virt-win-reg.pl:45
30244 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' @\n"
30249 #: ../tools/virt-win-reg.pl:47
30252 " virt-win-reg --merge domname [input.reg ...]\n"
30257 #: ../tools/virt-win-reg.pl:49
30260 " virt-win-reg [--options] disk.img ... # instead of domname\n"
30265 #: ../tools/virt-win-reg.pl:53
30267 "You must I<not> use C<virt-win-reg> with the I<--merge> option on live "
30268 "virtual machines. If you do this, you I<will> get irreversible disk "
30269 "corruption in the VM. C<virt-win-reg> tries to stop you from doing this, "
30270 "but doesn't catch all cases."
30274 #: ../tools/virt-win-reg.pl:58
30276 "Modifying the Windows Registry is an inherently risky operation. The format "
30277 "is deliberately obscure and undocumented, and Registry changes can leave the "
30278 "system unbootable. Therefore when using the I<--merge> option, make sure "
30279 "you have a reliable backup first."
30283 #: ../tools/virt-win-reg.pl:65
30285 "This program can export and merge Windows Registry entries from a Windows "
30290 #: ../tools/virt-win-reg.pl:68
30292 "The first parameter is the libvirt guest name or the raw disk image of a "
30297 #: ../tools/virt-win-reg.pl:71
30299 "If I<--merge> is I<not> specified, then the chosen registry key is displayed/"
30300 "exported (recursively). For example:"
30304 #: ../tools/virt-win-reg.pl:74
30307 " $ virt-win-reg Windows7 'HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft'\n"
30312 #: ../tools/virt-win-reg.pl:76
30314 "You can also display single values from within registry keys, for example:"
30318 #: ../tools/virt-win-reg.pl:79
30321 " $ cvkey='HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion'\n"
30322 " $ virt-win-reg Windows7 $cvkey ProductName\n"
30323 " Windows 7 Enterprise\n"
30328 #: ../tools/virt-win-reg.pl:83
30330 "With I<--merge>, you can merge a textual regedit file into the Windows "
30335 #: ../tools/virt-win-reg.pl:86
30338 " $ virt-win-reg --merge Windows7 changes.reg\n"
30343 #: ../tools/virt-win-reg.pl:88 ../tools/virt-tar.pl:45
30348 #: ../tools/virt-win-reg.pl:90
30350 "This program is only meant for simple access to the registry. If you want "
30351 "to do complicated things with the registry, we suggest you download the "
30352 "Registry hive files from the guest using L<libguestfs(3)> or L<guestfish(1)> "
30353 "and access them locally, eg. using L<hivex(3)>, L<hivexsh(1)> or "
30354 "L<hivexregedit(1)>."
30358 #: ../tools/virt-win-reg.pl:106 ../tools/virt-list-filesystems.pl:63
30359 #: ../tools/virt-tar.pl:113 ../tools/virt-make-fs.pl:163
30360 #: ../tools/virt-list-partitions.pl:64
30361 msgid "Display brief help."
30365 #: ../tools/virt-win-reg.pl:114 ../tools/virt-list-filesystems.pl:71
30366 #: ../tools/virt-tar.pl:121 ../tools/virt-make-fs.pl:171
30367 #: ../tools/virt-list-partitions.pl:72
30368 msgid "Display version number and exit."
30372 #: ../tools/virt-win-reg.pl:120 ../tools/virt-make-fs.pl:177
30377 #: ../tools/virt-win-reg.pl:122
30378 msgid "Enable debugging messages."
30382 #: ../tools/virt-win-reg.pl:128 ../tools/virt-list-filesystems.pl:77
30383 #: ../tools/virt-tar.pl:127 ../tools/virt-list-partitions.pl:78
30384 msgid "B<--connect URI> | B<-c URI>"
30388 #: ../tools/virt-win-reg.pl:130 ../tools/virt-list-filesystems.pl:79
30389 #: ../tools/virt-tar.pl:129 ../tools/virt-list-partitions.pl:80
30391 "If using libvirt, connect to the given I<URI>. If omitted, then we connect "
30392 "to the default libvirt hypervisor."
30396 #: ../tools/virt-win-reg.pl:133 ../tools/virt-list-filesystems.pl:82
30397 #: ../tools/virt-tar.pl:132 ../tools/virt-list-partitions.pl:83
30399 "If you specify guest block devices directly, then libvirt is not used at all."
30403 #: ../tools/virt-win-reg.pl:140 ../tools/virt-list-filesystems.pl:89
30404 #: ../tools/virt-tar.pl:139 ../tools/virt-list-partitions.pl:90
30405 msgid "B<--format> raw"
30409 #: ../tools/virt-win-reg.pl:142 ../tools/virt-list-filesystems.pl:91
30410 #: ../tools/virt-tar.pl:141 ../tools/virt-list-partitions.pl:92
30412 "Specify the format of disk images given on the command line. If this is "
30413 "omitted then the format is autodetected from the content of the disk image."
30417 #: ../tools/virt-win-reg.pl:146 ../tools/virt-list-filesystems.pl:95
30418 #: ../tools/virt-tar.pl:145 ../tools/virt-list-partitions.pl:96
30420 "If disk images are requested from libvirt, then this program asks libvirt "
30421 "for this information. In this case, the value of the format parameter is "
30426 #: ../tools/virt-win-reg.pl:150 ../tools/virt-list-filesystems.pl:99
30427 #: ../tools/virt-tar.pl:149 ../tools/virt-list-partitions.pl:100
30429 "If working with untrusted raw-format guest disk images, you should ensure "
30430 "the format is always specified."
30434 #: ../tools/virt-win-reg.pl:157
30439 #: ../tools/virt-win-reg.pl:159
30441 "In merge mode, this merges a textual regedit file into the Windows Registry "
30442 "of the virtual machine. If this flag is I<not> given then virt-win-reg "
30443 "displays or exports Registry entries instead."
30447 #: ../tools/virt-win-reg.pl:163
30449 "Note that I<--merge> is I<unsafe> to use on live virtual machines, and will "
30450 "result in disk corruption. However exporting (without this flag) is always "
30455 #: ../tools/virt-win-reg.pl:171
30456 msgid "B<--encoding> UTF-16LE|ASCII"
30460 #: ../tools/virt-win-reg.pl:173
30462 "When merging (only), you may need to specify the encoding for strings to be "
30463 "used in the hive file. This is explained in detail in L<Win::Hivex::Regedit"
30464 "(3)/ENCODING STRINGS>."
30468 #: ../tools/virt-win-reg.pl:177
30470 "The default is to use UTF-16LE, which should work with recent versions of "
30475 #: ../tools/virt-win-reg.pl:184
30476 msgid "B<--unsafe-printable-strings>"
30480 #: ../tools/virt-win-reg.pl:186
30482 "When exporting (only), assume strings are UTF-16LE and print them as strings "
30483 "instead of hex sequences. Remove the final zero codepoint from strings if "
30488 #: ../tools/virt-win-reg.pl:190
30490 "This is unsafe and does not preserve the fidelity of strings in the original "
30491 "Registry for various reasons:"
30495 #: ../tools/virt-win-reg.pl:197
30497 "Assumes the original encoding is UTF-16LE. ASCII strings and strings in "
30498 "other encodings will be corrupted by this transformation."
30502 #: ../tools/virt-win-reg.pl:202
30504 "Assumes that everything which has type 1 or 2 is really a string and that "
30505 "everything else is not a string, but the type field in real Registries is "
30510 #: ../tools/virt-win-reg.pl:208
30512 "Loses information about whether a zero codepoint followed the string in the "
30517 #: ../tools/virt-win-reg.pl:213
30519 "This all happens because the Registry itself contains no information about "
30520 "how strings are encoded (see L<Win::Hivex::Regedit(3)/ENCODING STRINGS>)."
30524 #: ../tools/virt-win-reg.pl:217
30526 "You should only use this option for quick hacking and debugging of the "
30527 "Registry contents, and I<never> use it if the output is going to be passed "
30528 "into another program or stored in another Registry."
30532 #: ../tools/virt-win-reg.pl:554
30533 msgid "SUPPORTED SYSTEMS"
30537 #: ../tools/virt-win-reg.pl:556
30539 "The program currently supports Windows NT-derived guests starting with "
30540 "Windows XP through to at least Windows 7."
30544 #: ../tools/virt-win-reg.pl:559
30545 msgid "The following Registry keys are supported:"
30549 #: ../tools/virt-win-reg.pl:563
30550 msgid "C<HKEY_LOCAL_MACHINE\\SAM>"
30554 #: ../tools/virt-win-reg.pl:565
30555 msgid "C<HKEY_LOCAL_MACHINE\\SECURITY>"
30559 #: ../tools/virt-win-reg.pl:567
30560 msgid "C<HKEY_LOCAL_MACHINE\\SOFTWARE>"
30564 #: ../tools/virt-win-reg.pl:569
30565 msgid "C<HKEY_LOCAL_MACHINE\\SYSTEM>"
30569 #: ../tools/virt-win-reg.pl:571
30570 msgid "C<HKEY_USERS\\.DEFAULT>"
30574 #: ../tools/virt-win-reg.pl:573
30575 msgid "C<HKEY_USERS\\I<SID>>"
30579 #: ../tools/virt-win-reg.pl:575
30580 msgid "where I<SID> is a Windows User SID (eg. C<S-1-5-18>)."
30584 #: ../tools/virt-win-reg.pl:577
30585 msgid "C<HKEY_USERS\\I<username>>"
30589 #: ../tools/virt-win-reg.pl:579
30591 "where I<username> is a local user name (this is a libguestfs extension)."
30595 #: ../tools/virt-win-reg.pl:583
30597 "You can use C<HKLM> as a shorthand for C<HKEY_LOCAL_MACHINE>, and C<HKU> for "
30602 #: ../tools/virt-win-reg.pl:586
30604 "The literal keys C<HKEY_USERS\\$SID> and C<HKEY_CURRENT_USER> are not "
30605 "supported (there is no \"current user\")."
30609 #: ../tools/virt-win-reg.pl:589
30614 #: ../tools/virt-win-reg.pl:591
30616 "C<virt-win-reg> expects that regedit files have already been reencoded in "
30617 "the local encoding. Usually on Linux hosts, this means UTF-8 with Unix-"
30618 "style line endings. Since Windows regedit files are often in UTF-16LE with "
30619 "Windows-style line endings, you may need to reencode the whole file before "
30620 "or after processing."
30624 #: ../tools/virt-win-reg.pl:597
30626 "To reencode a file from Windows format to Linux (before processing it with "
30627 "the I<--merge> option), you would do something like this:"
30631 #: ../tools/virt-win-reg.pl:600
30634 " iconv -f utf-16le -t utf-8 < win.reg | dos2unix > linux.reg\n"
30639 #: ../tools/virt-win-reg.pl:602
30641 "To go in the opposite direction, after exporting and before sending the file "
30642 "to a Windows user, do something like this:"
30646 #: ../tools/virt-win-reg.pl:605
30649 " unix2dos linux.reg | iconv -f utf-8 -t utf-16le > win.reg\n"
30654 #: ../tools/virt-win-reg.pl:607
30655 msgid "For more information about encoding, see L<Win::Hivex::Regedit(3)>."
30659 #: ../tools/virt-win-reg.pl:609
30661 "If you are unsure about the current encoding, use the L<file(1)> command. "
30662 "Recent versions of Windows regedit.exe produce a UTF-16LE file with Windows-"
30663 "style (CRLF) line endings, like this:"
30667 #: ../tools/virt-win-reg.pl:613
30670 " $ file software.reg\n"
30671 " software.reg: Little-endian UTF-16 Unicode text, with very long lines,\n"
30672 " with CRLF line terminators\n"
30677 #: ../tools/virt-win-reg.pl:617
30678 msgid "This file would need conversion before you could I<--merge> it."
30682 #: ../tools/virt-win-reg.pl:619
30683 msgid "CurrentControlSet etc."
30687 #: ../tools/virt-win-reg.pl:621
30689 "Registry keys like C<CurrentControlSet> don't really exist in the Windows "
30690 "Registry at the level of the hive file, and therefore you cannot modify "
30695 #: ../tools/virt-win-reg.pl:625
30697 "C<CurrentControlSet> is usually an alias for C<ControlSet001>. In some "
30698 "circumstances it might refer to another control set. The way to find out is "
30699 "to look at the C<HKLM\\SYSTEM\\Select> key:"
30703 #: ../tools/virt-win-reg.pl:629
30706 " # virt-win-reg WindowsGuest 'HKLM\\SYSTEM\\Select'\n"
30707 " [HKEY_LOCAL_MACHINE\\SYSTEM\\Select]\n"
30708 " \"Current\"=dword:00000001\n"
30709 " \"Default\"=dword:00000001\n"
30710 " \"Failed\"=dword:00000000\n"
30711 " \"LastKnownGood\"=dword:00000002\n"
30716 #: ../tools/virt-win-reg.pl:636
30717 msgid "\"Current\" is the one which Windows will choose when it boots."
30721 #: ../tools/virt-win-reg.pl:638
30723 "Similarly, other C<Current...> keys in the path may need to be replaced."
30727 #: ../tools/virt-win-reg.pl:641
30728 msgid "WINDOWS TIPS"
30732 #: ../tools/virt-win-reg.pl:643
30734 "Note that some of these tips modify the guest disk image. The guest I<must> "
30735 "be shut off, else you will get disk corruption."
30739 #: ../tools/virt-win-reg.pl:646
30740 msgid "RUNNING A BATCH SCRIPT WHEN A USER LOGS IN"
30744 #: ../tools/virt-win-reg.pl:648
30746 "Prepare a DOS batch script, VBScript or executable. Upload this using "
30747 "L<guestfish(1)>. For this example the script is called C<test.bat> and it "
30748 "is uploaded into C<C:\\>:"
30752 #: ../tools/virt-win-reg.pl:652
30755 " guestfish -i -d WindowsGuest upload test.bat /test.bat\n"
30760 #: ../tools/virt-win-reg.pl:654
30761 msgid "Prepare a regedit file containing the registry change:"
30765 #: ../tools/virt-win-reg.pl:656
30768 " cat > test.reg <<'EOF'\n"
30769 " [HKLM\\Software\\Microsoft\\Windows\\CurrentVersion\\RunOnce]\n"
30770 " \"Test\"=\"c:\\\\test.bat\"\n"
30776 #: ../tools/virt-win-reg.pl:661
30778 "In this example we use the key C<RunOnce> which means that the script will "
30779 "run precisely once when the first user logs in. If you want it to run every "
30780 "time a user logs in, replace C<RunOnce> with C<Run>."
30784 #: ../tools/virt-win-reg.pl:665
30785 msgid "Now update the registry:"
30789 #: ../tools/virt-win-reg.pl:667
30792 " virt-win-reg --merge WindowsGuest test.reg\n"
30797 #: ../tools/virt-win-reg.pl:669
30798 msgid "INSTALLING A SERVICE"
30802 #: ../tools/virt-win-reg.pl:671
30804 "This section assumes you are familiar with Windows services, and you either "
30805 "have a program which handles the Windows Service Control Protocol directly "
30806 "or you want to run any program using a service wrapper like SrvAny or the "
30811 #: ../tools/virt-win-reg.pl:676
30813 "First upload the program and optionally the service wrapper. In this case "
30814 "the test program is called C<test.exe> and we are using the RHSrvAny wrapper:"
30818 #: ../tools/virt-win-reg.pl:680
30821 " guestfish -i -d WindowsGuest <<EOF\n"
30822 " upload rhsrvany.exe /rhsrvany.exe\n"
30823 " upload test.exe /test.exe\n"
30829 #: ../tools/virt-win-reg.pl:685
30831 "Prepare a regedit file containing the registry changes. In this example, "
30832 "the first registry change is needed for the service itself or the service "
30833 "wrapper (if used). The second registry change is only needed because I am "
30834 "using the RHSrvAny service wrapper."
30838 #: ../tools/virt-win-reg.pl:690
30841 " cat > service.reg <<'EOF'\n"
30842 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny]\n"
30843 " \"Type\"=dword:00000010\n"
30844 " \"Start\"=dword:00000002\n"
30845 " \"ErrorControl\"=dword:00000001\n"
30846 " \"ImagePath\"=\"c:\\\\rhsrvany.exe\"\n"
30847 " \"DisplayName\"=\"RHSrvAny\"\n"
30848 " \"ObjectName\"=\"NetworkService\"\n"
30853 #: ../tools/virt-win-reg.pl:699
30856 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny\\Parameters]\n"
30857 " \"CommandLine\"=\"c:\\\\test.exe\"\n"
30858 " \"PWD\"=\"c:\\\\Temp\"\n"
30864 #: ../tools/virt-win-reg.pl:710
30866 "For use of C<ControlSet001> see the section above in this manual page. You "
30867 "may need to adjust this according to the control set that is in use by the "
30872 #: ../tools/virt-win-reg.pl:716
30874 "C<\"ObjectName\"> controls the privileges that the service will have. An "
30875 "alternative is C<\"ObjectName\"=\"LocalSystem\"> which would be the most "
30876 "privileged account."
30880 #: ../tools/virt-win-reg.pl:722
30882 "For the meaning of the magic numbers, see this Microsoft KB article: "
30883 "L<http://support.microsoft.com/kb/103000>."
30887 #: ../tools/virt-win-reg.pl:727
30888 msgid "Update the registry:"
30892 #: ../tools/virt-win-reg.pl:729
30895 " virt-win-reg --merge WindowsGuest service.reg\n"
30900 #: ../tools/virt-win-reg.pl:731 ../tools/virt-list-filesystems.pl:182
30901 #: ../tools/virt-tar.pl:279 ../tools/virt-make-fs.pl:532
30902 #: ../tools/virt-list-partitions.pl:250
30903 msgid "SHELL QUOTING"
30907 #: ../tools/virt-win-reg.pl:733
30909 "Be careful when passing parameters containing C<\\> (backslash) in the "
30910 "shell. Usually you will have to use 'single quotes' or double backslashes "
30911 "(but not both) to protect them from the shell."
30915 #: ../tools/virt-win-reg.pl:737
30916 msgid "Paths and value names are case-insensitive."
30920 #: ../tools/virt-win-reg.pl:739 ../tools/virt-list-filesystems.pl:184
30921 #: ../tools/virt-tar.pl:281 ../tools/virt-make-fs.pl:534
30922 #: ../tools/virt-list-partitions.pl:252
30924 "Libvirt guest names can contain arbitrary characters, some of which have "
30925 "meaning to the shell such as C<#> and space. You may need to quote or "
30926 "escape these characters on the command line. See the shell manual page L<sh"
30927 "(1)> for details."
30931 #: ../tools/virt-win-reg.pl:746
30933 "L<hivex(3)>, L<hivexsh(1)>, L<hivexregedit(1)>, L<guestfs(3)>, L<guestfish(1)"
30934 ">, L<virt-cat(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Win::Hivex"
30935 "(3)>, L<Win::Hivex::Regedit(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
30939 #: ../tools/virt-win-reg.pl:761 ../tools/virt-make-fs.pl:555
30941 "When reporting bugs, please enable debugging and capture the I<complete> "
30946 #: ../tools/virt-win-reg.pl:764
30949 " export LIBGUESTFS_DEBUG=1\n"
30950 " virt-win-reg --debug [... rest ...] > /tmp/virt-win-reg.log 2>&1\n"
30955 #: ../tools/virt-win-reg.pl:767
30957 "Attach /tmp/virt-win-reg.log to a new bug report at L<https://bugzilla."
30962 #: ../tools/virt-win-reg.pl:770 ../tools/virt-list-filesystems.pl:202
30963 #: ../tools/virt-tar.pl:301 ../tools/virt-make-fs.pl:564
30964 #: ../tools/virt-list-partitions.pl:269
30969 #: ../tools/virt-win-reg.pl:772 ../tools/virt-list-filesystems.pl:204
30970 #: ../tools/virt-tar.pl:303 ../tools/virt-make-fs.pl:566
30971 #: ../tools/virt-list-partitions.pl:271
30972 msgid "Richard W.M. Jones L<http://people.redhat.com/~rjones/>"
30976 #: ../tools/virt-win-reg.pl:776 ../tools/virt-make-fs.pl:570
30977 msgid "Copyright (C) 2010 Red Hat Inc."
30981 #: ../tools/virt-list-filesystems.pl:32
30983 "virt-list-filesystems - List filesystems in a virtual machine or disk image"
30987 #: ../tools/virt-list-filesystems.pl:36
30990 " virt-list-filesystems [--options] domname\n"
30995 #: ../tools/virt-list-filesystems.pl:38
30998 " virt-list-filesystems [--options] disk.img [disk.img ...]\n"
31003 #: ../tools/virt-list-filesystems.pl:42 ../tools/virt-list-partitions.pl:42
31005 "This tool is obsolete. Use L<virt-filesystems(1)> as a more flexible "
31010 #: ../tools/virt-list-filesystems.pl:45
31012 "C<virt-list-filesystems> is a command line tool to list the filesystems that "
31013 "are contained in a virtual machine or disk image."
31017 #: ../tools/virt-list-filesystems.pl:49
31019 "C<virt-list-filesystems> is just a simple wrapper around L<libguestfs(3)> "
31020 "functionality. For more complex cases you should look at the L<guestfish(1)"
31025 #: ../tools/virt-list-filesystems.pl:106 ../tools/virt-list-partitions.pl:115
31026 msgid "B<-l> | B<--long>"
31030 #: ../tools/virt-list-filesystems.pl:108
31032 "With this option, C<virt-list-filesystems> displays the type of each "
31033 "filesystem too (where \"type\" means C<ext3>, C<xfs> etc.)"
31037 #: ../tools/virt-list-filesystems.pl:115
31038 msgid "B<-a> | B<--all>"
31042 #: ../tools/virt-list-filesystems.pl:117
31044 "Normally we only show mountable filesystems. If this option is given then "
31045 "swap devices are shown too."
31049 #: ../tools/virt-list-filesystems.pl:191
31051 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, L<virt-"
31052 "filesystems(1)>, L<virt-list-partitions(1)>, L<Sys::Guestfs(3)>, L<Sys::"
31053 "Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
31057 #: ../tools/virt-list-filesystems.pl:208 ../tools/virt-tar.pl:307
31058 msgid "Copyright (C) 2009 Red Hat Inc."
31062 #: ../tools/virt-tar.pl:33
31063 msgid "virt-tar - Extract or upload files to a virtual machine"
31067 #: ../tools/virt-tar.pl:37
31070 " virt-tar [--options] -x domname directory tarball\n"
31075 #: ../tools/virt-tar.pl:39
31078 " virt-tar [--options] -u domname tarball directory\n"
31083 #: ../tools/virt-tar.pl:41
31086 " virt-tar [--options] disk.img [disk.img ...] -x directory tarball\n"
31091 #: ../tools/virt-tar.pl:43
31094 " virt-tar [--options] disk.img [disk.img ...] -u tarball directory\n"
31099 #: ../tools/virt-tar.pl:47
31101 "This tool is obsolete. Use L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-"
31102 "tar-in(1)>, L<virt-tar-out(1)> as replacements."
31106 #: ../tools/virt-tar.pl:52
31107 msgid "Download C</home> from the VM into a local tarball:"
31111 #: ../tools/virt-tar.pl:54
31114 " virt-tar -x domname /home home.tar\n"
31119 #: ../tools/virt-tar.pl:56
31122 " virt-tar -zx domname /home home.tar.gz\n"
31127 #: ../tools/virt-tar.pl:58
31128 msgid "Upload a local tarball and unpack it inside C</tmp> in the VM:"
31132 #: ../tools/virt-tar.pl:60
31135 " virt-tar -u domname uploadstuff.tar /tmp\n"
31140 #: ../tools/virt-tar.pl:62
31143 " virt-tar -zu domname uploadstuff.tar.gz /tmp\n"
31148 #: ../tools/virt-tar.pl:66
31150 "You must I<not> use C<virt-tar> with the I<-u> option (upload) on live "
31151 "virtual machines. If you do this, you risk disk corruption in the VM. "
31152 "C<virt-tar> tries to stop you from doing this, but doesn't catch all cases."
31156 #: ../tools/virt-tar.pl:71
31158 "You can use I<-x> (extract) on live virtual machines, but you might get "
31159 "inconsistent results or errors if there is filesystem activity inside the "
31160 "VM. If the live VM is synched and quiescent, then C<virt-tar> will usually "
31161 "work, but the only way to guarantee consistent results is if the virtual "
31162 "machine is shut down."
31166 #: ../tools/virt-tar.pl:79
31168 "C<virt-tar> is a general purpose archive tool for downloading and uploading "
31169 "parts of a guest filesystem. There are many possibilities: making backups, "
31170 "uploading data files, snooping on guest activity, fixing or customizing "
31175 #: ../tools/virt-tar.pl:84
31177 "If you want to just view a single file, use L<virt-cat(1)>. If you just "
31178 "want to edit a single file, use L<virt-edit(1)>. For more complex cases you "
31179 "should look at the L<guestfish(1)> tool."
31183 #: ../tools/virt-tar.pl:88
31185 "There are two modes of operation: I<-x> (eXtract) downloads a directory and "
31186 "its contents (recursively) from the virtual machine into a local tarball. "
31187 "I<-u> uploads from a local tarball, unpacking it into a directory inside the "
31188 "virtual machine. You cannot use these two options together."
31192 #: ../tools/virt-tar.pl:94
31194 "In addition, you may need to use the I<-z> (gZip) option to enable "
31195 "compression. When uploading, you have to specify I<-z> if the upload file "
31196 "is compressed because virt-tar won't detect this on its own."
31200 #: ../tools/virt-tar.pl:98
31202 "C<virt-tar> can only handle tar (optionally gzipped) format tarballs. For "
31203 "example it cannot do PKZip files or bzip2 compression. If you want that "
31204 "then you'll have to rebuild the tarballs yourself. (This is a limitation of "
31205 "the L<libguestfs(3)> API)."
31209 #: ../tools/virt-tar.pl:156
31210 msgid "B<-x> | B<--extract> | B<--download>"
31214 #: ../tools/virt-tar.pl:158
31215 msgid "B<-u> | B<--upload>"
31219 #: ../tools/virt-tar.pl:160
31221 "Use I<-x> to extract (download) a directory from a virtual machine to a "
31226 #: ../tools/virt-tar.pl:163
31228 "Use I<-u> to upload and unpack from a local tarball into a virtual machine. "
31229 "Please read the L</WARNING> section above before using this option."
31233 #: ../tools/virt-tar.pl:167
31234 msgid "You must specify exactly one of these options."
31238 #: ../tools/virt-tar.pl:173
31239 msgid "B<-z> | B<--gzip>"
31243 #: ../tools/virt-tar.pl:175
31244 msgid "Specify that the input or output tarball is gzip-compressed."
31248 #: ../tools/virt-tar.pl:288
31250 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, L<virt-copy-"
31251 "in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<Sys::"
31252 "Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs."
31257 #: ../tools/virt-make-fs.pl:37
31258 msgid "virt-make-fs - Make a filesystem from a tar archive or files"
31262 #: ../tools/virt-make-fs.pl:41
31265 " virt-make-fs [--options] input.tar output.img\n"
31270 #: ../tools/virt-make-fs.pl:43
31273 " virt-make-fs [--options] input.tar.gz output.img\n"
31278 #: ../tools/virt-make-fs.pl:45
31281 " virt-make-fs [--options] directory output.img\n"
31286 #: ../tools/virt-make-fs.pl:49
31288 "Virt-make-fs is a command line tool for creating a filesystem from a tar "
31289 "archive or some files in a directory. It is similar to tools like L<mkisofs"
31290 "(1)>, L<genisoimage(1)> and L<mksquashfs(1)>. Unlike those tools, it can "
31291 "create common filesystem types like ext2/3 or NTFS, which can be useful if "
31292 "you want to attach these filesystems to existing virtual machines (eg. to "
31293 "import large amounts of read-only data to a VM)."
31297 #: ../tools/virt-make-fs.pl:57
31298 msgid "Basic usage is:"
31302 #: ../tools/virt-make-fs.pl:59
31305 " virt-make-fs input output\n"
31310 #: ../tools/virt-make-fs.pl:61
31312 "where C<input> is either a directory containing files that you want to add, "
31313 "or a tar archive (either uncompressed tar or gzip-compressed tar); and "
31314 "C<output> is a disk image. The input type is detected automatically. The "
31315 "output disk image defaults to a raw ext2 image unless you specify extra "
31316 "flags (see L</OPTIONS> below)."
31320 #: ../tools/virt-make-fs.pl:67
31321 msgid "EXTRA SPACE"
31325 #: ../tools/virt-make-fs.pl:69
31327 "Unlike formats such as tar and squashfs, a filesystem does not \"just fit\" "
31328 "the files that it contains, but might have extra space. Depending on how "
31329 "you are going to use the output, you might think this extra space is wasted "
31330 "and want to minimize it, or you might want to leave space so that more files "
31331 "can be added later. Virt-make-fs defaults to minimizing the extra space, "
31332 "but you can use the I<--size> flag to leave space in the filesystem if you "
31337 #: ../tools/virt-make-fs.pl:77
31339 "An alternative way to leave extra space but not make the output image any "
31340 "bigger is to use an alternative disk image format (instead of the default "
31341 "\"raw\" format). Using I<--format=qcow2> will use the native QEmu/KVM qcow2 "
31342 "image format (check your hypervisor supports this before using it). This "
31343 "allows you to choose a large I<--size> but the extra space won't actually be "
31344 "allocated in the image until you try to store something in it."
31348 #: ../tools/virt-make-fs.pl:85
31350 "Don't forget that you can also use local commands including L<resize2fs(8)> "
31351 "and L<virt-resize(1)> to resize existing filesystems, or rerun virt-make-fs "
31352 "to build another image from scratch."
31356 #: ../tools/virt-make-fs.pl:89 ../tools/virt-make-fs.pl:123
31357 #: ../tools/virt-make-fs.pl:142
31362 #: ../tools/virt-make-fs.pl:91
31365 " virt-make-fs --format=qcow2 --size=+200M input output.img\n"
31370 #: ../tools/virt-make-fs.pl:93
31371 msgid "FILESYSTEM TYPE"
31375 #: ../tools/virt-make-fs.pl:95
31377 "The default filesystem type is C<ext2>. Just about any filesystem type that "
31378 "libguestfs supports can be used (but I<not> read-only formats like "
31379 "ISO9660). Here are some of the more common choices:"
31383 #: ../tools/virt-make-fs.pl:101
31388 #: ../tools/virt-make-fs.pl:103
31390 "Note that ext3 filesystems contain a journal, typically 1-32 MB in size. If "
31391 "you are not going to use the filesystem in a way that requires the journal, "
31392 "then this is just wasted overhead."
31396 #: ../tools/virt-make-fs.pl:107
31397 msgid "I<ntfs> or I<vfat>"
31401 #: ../tools/virt-make-fs.pl:109
31402 msgid "Useful if exporting data to a Windows guest."
31406 #: ../tools/virt-make-fs.pl:111
31408 "I<Note for vfat>: The tar archive or local directory must only contain files "
31409 "which are owned by root (ie. UID:GID = 0:0). The reason is that the tar "
31410 "program running within libguestfs is unable to change the ownership of non-"
31411 "root files, since vfat itself does not support this."
31415 #: ../tools/virt-make-fs.pl:116
31420 #: ../tools/virt-make-fs.pl:118
31422 "Lower overhead than C<ext2>, but certain limitations on filename length and "
31423 "total filesystem size."
31427 #: ../tools/virt-make-fs.pl:125
31430 " virt-make-fs --type=minix input minixfs.img\n"
31435 #: ../tools/virt-make-fs.pl:127
31436 msgid "TO PARTITION OR NOT TO PARTITION"
31440 #: ../tools/virt-make-fs.pl:129
31441 msgid "Optionally virt-make-fs can add a partition table to the output disk."
31445 #: ../tools/virt-make-fs.pl:131
31447 "Adding a partition can make the disk image more compatible with certain "
31448 "virtualized operating systems which don't expect to see a filesystem "
31449 "directly located on a block device (Linux doesn't care and will happily "
31450 "handle both types)."
31454 #: ../tools/virt-make-fs.pl:136
31456 "On the other hand, if you have a partition table then the output image is no "
31457 "longer a straight filesystem. For example you cannot run L<fsck(8)> "
31458 "directly on a partitioned disk image. (However libguestfs tools such as "
31459 "L<guestfish(1)> and L<virt-resize(1)> can still be used)."
31463 #: ../tools/virt-make-fs.pl:144
31464 msgid "Add an MBR partition:"
31468 #: ../tools/virt-make-fs.pl:146
31471 " virt-make-fs --partition -- input disk.img\n"
31476 #: ../tools/virt-make-fs.pl:148
31478 "If the output disk image could be terabyte-sized or larger, it's better to "
31479 "use an EFI/GPT-compatible partition table:"
31483 #: ../tools/virt-make-fs.pl:151
31486 " virt-make-fs --partition=gpt --size=+4T --format=qcow2 input disk.img\n"
31491 #: ../tools/virt-make-fs.pl:179
31492 msgid "Enable debugging information."
31496 #: ../tools/virt-make-fs.pl:185
31497 msgid "B<--size=E<lt>NE<gt>>"
31501 #: ../tools/virt-make-fs.pl:187
31502 msgid "B<--size=+E<lt>NE<gt>>"
31506 #: ../tools/virt-make-fs.pl:189
31507 msgid "B<-s E<lt>NE<gt>>"
31511 #: ../tools/virt-make-fs.pl:191
31512 msgid "B<-s +E<lt>NE<gt>>"
31516 #: ../tools/virt-make-fs.pl:193
31518 "Use the I<--size> (or I<-s>) option to choose the size of the output image."
31522 #: ../tools/virt-make-fs.pl:196
31524 "If this option is I<not> given, then the output image will be just large "
31525 "enough to contain all the files, with not much wasted space."
31529 #: ../tools/virt-make-fs.pl:199
31531 "To choose a fixed size output disk, specify an absolute number followed by b/"
31532 "K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
31533 "Petabytes or Exabytes. This must be large enough to contain all the input "
31534 "files, else you will get an error."
31538 #: ../tools/virt-make-fs.pl:204
31540 "To leave extra space, specify C<+> (plus sign) and a number followed by b/K/"
31541 "M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
31542 "Petabytes or Exabytes. For example: I<--size=+200M> means enough space for "
31543 "the input files, and (approximately) an extra 200 MB free space."
31547 #: ../tools/virt-make-fs.pl:210
31549 "Note that virt-make-fs estimates free space, and therefore will not produce "
31550 "filesystems containing precisely the free space requested. (It is much more "
31551 "expensive and time-consuming to produce a filesystem which has precisely the "
31552 "desired free space)."
31556 #: ../tools/virt-make-fs.pl:219
31557 msgid "B<--format=E<lt>fmtE<gt>>"
31561 #: ../tools/virt-make-fs.pl:221
31562 msgid "B<-F E<lt>fmtE<gt>>"
31566 #: ../tools/virt-make-fs.pl:223
31567 msgid "Choose the output disk image format."
31571 #: ../tools/virt-make-fs.pl:225
31572 msgid "The default is C<raw> (raw disk image)."
31576 #: ../tools/virt-make-fs.pl:227
31578 "For other choices, see the L<qemu-img(1)> manpage. The only other choice "
31579 "that would really make sense here is C<qcow2>."
31583 #: ../tools/virt-make-fs.pl:234
31584 msgid "B<--type=E<lt>fsE<gt>>"
31588 #: ../tools/virt-make-fs.pl:236
31589 msgid "B<-t E<lt>fsE<gt>>"
31593 #: ../tools/virt-make-fs.pl:238
31594 msgid "Choose the output filesystem type."
31598 #: ../tools/virt-make-fs.pl:240
31599 msgid "The default is C<ext2>."
31603 #: ../tools/virt-make-fs.pl:242
31605 "Any filesystem which is supported read-write by libguestfs can be used here."
31609 #: ../tools/virt-make-fs.pl:249
31610 msgid "B<--partition>"
31614 #: ../tools/virt-make-fs.pl:251
31615 msgid "B<--partition=E<lt>parttypeE<gt>>"
31619 #: ../tools/virt-make-fs.pl:253
31621 "If specified, this flag adds an MBR partition table to the output disk image."
31625 #: ../tools/virt-make-fs.pl:256
31627 "You can change the partition table type, eg. I<--partition=gpt> for large "
31632 #: ../tools/virt-make-fs.pl:259
31634 "Note that if you just use a lonesome I<--partition>, the Perl option parser "
31635 "might consider the next parameter to be the partition type. For example:"
31639 #: ../tools/virt-make-fs.pl:263
31642 " virt-make-fs --partition input.tar ...\n"
31647 #: ../tools/virt-make-fs.pl:265
31649 "would cause virt-make-fs to think you wanted to use a partition type of "
31650 "C<input.tar> which is completely wrong. To avoid this, use I<--> (a double "
31651 "dash) between options and the input file argument:"
31655 #: ../tools/virt-make-fs.pl:269
31658 " virt-make-fs --partition -- input.tar ...\n"
31663 #: ../tools/virt-make-fs.pl:541
31665 "L<guestfish(1)>, L<virt-resize(1)>, L<virt-tar-in(1)>, L<mkisofs(1)>, "
31666 "L<genisoimage(1)>, L<mksquashfs(1)>, L<mke2fs(8)>, L<resize2fs(8)>, L<guestfs"
31667 "(3)>, L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
31671 #: ../tools/virt-make-fs.pl:558
31674 " export LIBGUESTFS_DEBUG=1\n"
31675 " virt-make-fs --debug [...] > /tmp/virt-make-fs.log 2>&1\n"
31680 #: ../tools/virt-make-fs.pl:561
31682 "Attach /tmp/virt-make-fs.log to a new bug report at L<https://bugzilla."
31687 #: ../tools/virt-list-partitions.pl:32
31689 "virt-list-partitions - List partitions in a virtual machine or disk image"
31693 #: ../tools/virt-list-partitions.pl:36
31696 " virt-list-partitions [--options] domname\n"
31701 #: ../tools/virt-list-partitions.pl:38
31704 " virt-list-partitions [--options] disk.img [disk.img ...]\n"
31709 #: ../tools/virt-list-partitions.pl:45
31711 "C<virt-list-partitions> is a command line tool to list the partitions that "
31712 "are contained in a virtual machine or disk image. It is mainly useful as a "
31713 "first step to using L<virt-resize(1)>."
31717 #: ../tools/virt-list-partitions.pl:50
31719 "C<virt-list-partitions> is just a simple wrapper around L<libguestfs(3)> "
31720 "functionality. For more complex cases you should look at the L<guestfish(1)"
31725 #: ../tools/virt-list-partitions.pl:107
31726 msgid "B<-h> | B<--human-readable>"
31730 #: ../tools/virt-list-partitions.pl:109
31731 msgid "Show sizes in human-readable form (eg. \"1G\")."
31735 #: ../tools/virt-list-partitions.pl:117
31737 "With this option, C<virt-list-partitions> displays the type and size of each "
31738 "partition too (where \"type\" means C<ext3>, C<pv> etc.)"
31742 #: ../tools/virt-list-partitions.pl:124
31743 msgid "B<-t> | B<--total>"
31747 #: ../tools/virt-list-partitions.pl:126
31749 "Display the total size of each block device (as a separate row or rows)."
31753 #: ../tools/virt-list-partitions.pl:259
31755 "L<guestfs(3)>, L<guestfish(1)>, L<virt-filesystems(1)>, L<virt-list-"
31756 "filesystems(1)>, L<virt-resize(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib"
31757 "(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
31761 #: ../tools/virt-list-partitions.pl:275
31762 msgid "Copyright (C) 2009-2010 Red Hat Inc."