1 # SOME DESCRIPTIVE TITLE
2 # Copyright (C) YEAR Red Hat Inc.
3 # This file is distributed under the same license as the libguestfs package.
4 # FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
8 "Project-Id-Version: libguestfs\n"
9 "Report-Msgid-Bugs-To: libguestfs@redhat.com\n"
10 "POT-Creation-Date: 2011-04-24 09:52+0200\n"
11 "PO-Revision-Date: 2011-04-01 15:39+0000\n"
12 "Last-Translator: yurchor <yurchor@ukr.net>\n"
13 "Language-Team: Ukrainian <trans-uk@lists.fedoraproject.org>\n"
16 "Content-Type: text/plain; charset=UTF-8\n"
17 "Content-Transfer-Encoding: 8bit\n"
18 "Plural-Forms: nplurals=3; plural=(n%10==1 && n%100!=11 ? 0 : n%10>=2 && n"
19 "%10<=4 && (n%100<10 || n%100>=20) ? 1 : 2)\n"
22 #: ../src/guestfs.pod:3 ../fish/guestfish.pod:3
23 #: ../test-tool/libguestfs-test-tool.pod:3 ../fuse/guestmount.pod:3
24 #: ../tools/virt-edit.pl:32 ../tools/virt-win-reg.pl:35
25 #: ../tools/virt-list-filesystems.pl:30 ../tools/virt-tar.pl:31
26 #: ../tools/virt-make-fs.pl:35 ../tools/virt-list-partitions.pl:30
31 #: ../src/guestfs.pod:5
32 msgid "guestfs - Library for accessing and modifying virtual machine images"
34 "guestfs — бібліотека для доступу та внесення змін до образів віртуальних "
38 #: ../src/guestfs.pod:7 ../fish/guestfish.pod:7
39 #: ../test-tool/libguestfs-test-tool.pod:7 ../fuse/guestmount.pod:7
40 #: ../tools/virt-edit.pl:36 ../tools/virt-win-reg.pl:39
41 #: ../tools/virt-list-filesystems.pl:34 ../tools/virt-tar.pl:35
42 #: ../tools/virt-make-fs.pl:39 ../tools/virt-list-partitions.pl:34
44 msgstr "КОРОТКИЙ ОПИС"
47 #: ../src/guestfs.pod:9
50 " #include <guestfs.h>\n"
53 " #include <guestfs.h>\n"
57 #: ../src/guestfs.pod:11
60 " guestfs_h *g = guestfs_create ();\n"
61 " guestfs_add_drive (g, \"guest.img\");\n"
62 " guestfs_launch (g);\n"
63 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
64 " guestfs_touch (g, \"/hello\");\n"
65 " guestfs_umount (g, \"/\");\n"
66 " guestfs_close (g);\n"
69 " guestfs_h *g = guestfs_create ();\n"
70 " guestfs_add_drive (g, \"guest.img\");\n"
71 " guestfs_launch (g);\n"
72 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
73 " guestfs_touch (g, \"/hello\");\n"
74 " guestfs_umount (g, \"/\");\n"
75 " guestfs_close (g);\n"
79 #: ../src/guestfs.pod:19
82 " cc prog.c -o prog -lguestfs\n"
84 " cc prog.c -o prog `pkg-config libguestfs --cflags --libs`\n"
87 " cc prog.c -o prog -lguestfs\n"
89 " cc prog.c -o prog `pkg-config libguestfs --cflags --libs`\n"
93 #: ../src/guestfs.pod:23 ../fish/guestfish.pod:30
94 #: ../test-tool/libguestfs-test-tool.pod:11 ../fuse/guestmount.pod:20
95 #: ../tools/virt-edit.pl:50 ../tools/virt-win-reg.pl:63
96 #: ../tools/virt-list-filesystems.pl:40 ../tools/virt-tar.pl:77
97 #: ../tools/virt-make-fs.pl:47 ../tools/virt-list-partitions.pl:40
102 #: ../src/guestfs.pod:25
104 "Libguestfs is a library for accessing and modifying guest disk images. "
105 "Amongst the things this is good for: making batch configuration changes to "
106 "guests, getting disk used/free statistics (see also: virt-df), migrating "
107 "between virtualization systems (see also: virt-p2v), performing partial "
108 "backups, performing partial guest clones, cloning guests and changing "
109 "registry/UUID/hostname info, and much else besides."
113 #: ../src/guestfs.pod:33
115 "Libguestfs uses Linux kernel and qemu code, and can access any type of guest "
116 "filesystem that Linux and qemu can, including but not limited to: ext2/3/4, "
117 "btrfs, FAT and NTFS, LVM, many different disk partition schemes, qcow, "
122 #: ../src/guestfs.pod:38
124 "Libguestfs provides ways to enumerate guest storage (eg. partitions, LVs, "
125 "what filesystem is in each LV, etc.). It can also run commands in the "
126 "context of the guest. Also you can access filesystems over FUSE."
130 #: ../src/guestfs.pod:43
132 "Libguestfs is a library that can be linked with C and C++ management "
133 "programs (or management programs written in OCaml, Perl, Python, Ruby, Java, "
134 "PHP, Haskell or C#). You can also use it from shell scripts or the command "
139 #: ../src/guestfs.pod:48
141 "You don't need to be root to use libguestfs, although obviously you do need "
142 "enough permissions to access the disk images."
146 #: ../src/guestfs.pod:51
148 "Libguestfs is a large API because it can do many things. For a gentle "
149 "introduction, please read the L</API OVERVIEW> section next."
153 #: ../src/guestfs.pod:54
155 "There are also some example programs in the L<guestfs-examples(3)> manual "
160 #: ../src/guestfs.pod:57
165 #: ../src/guestfs.pod:59
167 "This section provides a gentler overview of the libguestfs API. We also try "
168 "to group API calls together, where that may not be obvious from reading "
169 "about the individual calls in the main section of this manual."
173 #: ../src/guestfs.pod:64
178 #: ../src/guestfs.pod:66
180 "Before you can use libguestfs calls, you have to create a handle. Then you "
181 "must add at least one disk image to the handle, followed by launching the "
182 "handle, then performing whatever operations you want, and finally closing "
183 "the handle. By convention we use the single letter C<g> for the name of the "
184 "handle variable, although of course you can use any name you want."
188 #: ../src/guestfs.pod:73
189 msgid "The general structure of all libguestfs-using programs looks like this:"
193 #: ../src/guestfs.pod:76
196 " guestfs_h *g = guestfs_create ();\n"
199 " guestfs_h *g = guestfs_create ();\n"
203 #: ../src/guestfs.pod:78
206 " /* Call guestfs_add_drive additional times if there are\n"
207 " * multiple disk images.\n"
209 " guestfs_add_drive (g, \"guest.img\");\n"
214 #: ../src/guestfs.pod:83
217 " /* Most manipulation calls won't work until you've launched\n"
218 " * the handle 'g'. You have to do this _after_ adding drives\n"
219 " * and _before_ other commands.\n"
221 " guestfs_launch (g);\n"
226 #: ../src/guestfs.pod:89
229 " /* Now you can examine what partitions, LVs etc are available.\n"
231 " char **partitions = guestfs_list_partitions (g);\n"
232 " char **logvols = guestfs_lvs (g);\n"
237 #: ../src/guestfs.pod:94
240 " /* To access a filesystem in the image, you must mount it.\n"
242 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
245 " /* Щоб отримати доступ до файлової системи на образі, вам слід його змонтувати.\n"
247 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
251 #: ../src/guestfs.pod:98
254 #| " /* Now you can perform filesystem actions on the guest\n"
255 #| " * disk image.\n"
257 #| " guestfs_touch (g, \"/hello\");\n"
260 " /* Now you can perform filesystem actions on the guest\n"
263 " guestfs_touch (g, \"/hello\");\n"
266 " /* Тепер ви можете виконувати дії з файловою системою на\n"
267 " * образі диска операційної системи.\n"
269 " guestfs_touch (g, \"/hello\");\n"
273 #: ../src/guestfs.pod:103
276 " /* This is only needed for libguestfs < 1.5.24. Since then\n"
277 " * it is done automatically when you close the handle. See\n"
278 " * discussion of autosync in this page.\n"
280 " guestfs_sync (g);\n"
285 #: ../src/guestfs.pod:109
288 " /* Close the handle 'g'. */\n"
289 " guestfs_close (g);\n"
294 #: ../src/guestfs.pod:112
296 "The code above doesn't include any error checking. In real code you should "
297 "check return values carefully for errors. In general all functions that "
298 "return integers return C<-1> on error, and all functions that return "
299 "pointers return C<NULL> on error. See section L</ERROR HANDLING> below for "
300 "how to handle errors, and consult the documentation for each function call "
301 "below to see precisely how they return error indications. See L<guestfs-"
302 "examples(3)> for fully worked examples."
306 #: ../src/guestfs.pod:121
311 #: ../src/guestfs.pod:123
313 "The image filename (C<\"guest.img\"> in the example above) could be a disk "
314 "image from a virtual machine, a L<dd(1)> copy of a physical hard disk, an "
315 "actual block device, or simply an empty file of zeroes that you have created "
316 "through L<posix_fallocate(3)>. Libguestfs lets you do useful things to all "
321 #: ../src/guestfs.pod:129
323 "The call you should use in modern code for adding drives is L</"
324 "guestfs_add_drive_opts>. To add a disk image, allowing writes, and "
325 "specifying that the format is raw, do:"
329 #: ../src/guestfs.pod:133
332 " guestfs_add_drive_opts (g, filename,\n"
333 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
339 #: ../src/guestfs.pod:137
340 msgid "You can add a disk read-only using:"
344 #: ../src/guestfs.pod:139
347 " guestfs_add_drive_opts (g, filename,\n"
348 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
349 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
355 #: ../src/guestfs.pod:144
357 "or by calling the older function L</guestfs_add_drive_ro>. In either case "
358 "libguestfs won't modify the file."
362 #: ../src/guestfs.pod:147
364 "Be extremely cautious if the disk image is in use, eg. if it is being used "
365 "by a virtual machine. Adding it read-write will almost certainly cause disk "
366 "corruption, but adding it read-only is safe."
370 #: ../src/guestfs.pod:151
372 "You must add at least one disk image, and you may add multiple disk images. "
373 "In the API, the disk images are usually referred to as C</dev/sda> (for the "
374 "first one you added), C</dev/sdb> (for the second one you added), etc."
378 #: ../src/guestfs.pod:156
380 "Once L</guestfs_launch> has been called you cannot add any more images. You "
381 "can call L</guestfs_list_devices> to get a list of the device names, in the "
382 "order that you added them. See also L</BLOCK DEVICE NAMING> below."
386 #: ../src/guestfs.pod:161
391 #: ../src/guestfs.pod:163
393 "Before you can read or write files, create directories and so on in a disk "
394 "image that contains filesystems, you have to mount those filesystems using "
395 "L</guestfs_mount_options> or L</guestfs_mount_ro>. If you already know that "
396 "a disk image contains (for example) one partition with a filesystem on that "
397 "partition, then you can mount it directly:"
401 #: ../src/guestfs.pod:170
404 " guestfs_mount_options (g, \"\", \"/dev/sda1\", \"/\");\n"
409 #: ../src/guestfs.pod:172
411 "where C</dev/sda1> means literally the first partition (C<1>) of the first "
412 "disk image that we added (C</dev/sda>). If the disk contains Linux LVM2 "
413 "logical volumes you could refer to those instead (eg. C</dev/VG/LV>). Note "
414 "that these are libguestfs virtual devices, and are nothing to do with host "
419 #: ../src/guestfs.pod:178
421 "If you are given a disk image and you don't know what it contains then you "
422 "have to find out. Libguestfs can do that too: use L</"
423 "guestfs_list_partitions> and L</guestfs_lvs> to list possible partitions and "
424 "LVs, and either try mounting each to see what is mountable, or else examine "
425 "them with L</guestfs_vfs_type> or L</guestfs_file>. To list just "
426 "filesystems, use L</guestfs_list_filesystems>."
430 #: ../src/guestfs.pod:186
432 "Libguestfs also has a set of APIs for inspection of unknown disk images (see "
433 "L</INSPECTION> below). But you might find it easier to look at higher level "
434 "programs built on top of libguestfs, in particular L<virt-inspector(1)>."
438 #: ../src/guestfs.pod:191
440 "To mount a filesystem read-only, use L</guestfs_mount_ro>. There are "
441 "several other variations of the C<guestfs_mount_*> call."
445 #: ../src/guestfs.pod:194
446 msgid "FILESYSTEM ACCESS AND MODIFICATION"
450 #: ../src/guestfs.pod:196
452 "The majority of the libguestfs API consists of fairly low-level calls for "
453 "accessing and modifying the files, directories, symlinks etc on mounted "
454 "filesystems. There are over a hundred such calls which you can find listed "
455 "in detail below in this man page, and we don't even pretend to cover them "
456 "all in this overview."
460 #: ../src/guestfs.pod:202
462 "Specify filenames as full paths, starting with C<\"/\"> and including the "
467 #: ../src/guestfs.pod:205
469 "For example, if you mounted a filesystem at C<\"/\"> and you want to read "
470 "the file called C<\"etc/passwd\"> then you could do:"
474 #: ../src/guestfs.pod:208
477 " char *data = guestfs_cat (g, \"/etc/passwd\");\n"
482 #: ../src/guestfs.pod:210
484 "This would return C<data> as a newly allocated buffer containing the full "
485 "content of that file (with some conditions: see also L</DOWNLOADING> below), "
486 "or C<NULL> if there was an error."
490 #: ../src/guestfs.pod:214
492 "As another example, to create a top-level directory on that filesystem "
493 "called C<\"var\"> you would do:"
497 #: ../src/guestfs.pod:217
500 " guestfs_mkdir (g, \"/var\");\n"
505 #: ../src/guestfs.pod:219
506 msgid "To create a symlink you could do:"
510 #: ../src/guestfs.pod:221
513 " guestfs_ln_s (g, \"/etc/init.d/portmap\",\n"
514 " \"/etc/rc3.d/S30portmap\");\n"
519 #: ../src/guestfs.pod:224
521 "Libguestfs will reject attempts to use relative paths and there is no "
522 "concept of a current working directory."
526 #: ../src/guestfs.pod:227
528 "Libguestfs can return errors in many situations: for example if the "
529 "filesystem isn't writable, or if a file or directory that you requested "
530 "doesn't exist. If you are using the C API (documented here) you have to "
531 "check for those error conditions after each call. (Other language bindings "
532 "turn these errors into exceptions)."
536 #: ../src/guestfs.pod:233
538 "File writes are affected by the per-handle umask, set by calling L</"
539 "guestfs_umask> and defaulting to 022. See L</UMASK>."
543 #: ../src/guestfs.pod:236
545 msgstr "ПОДІЛ НА РОЗДІЛИ"
548 #: ../src/guestfs.pod:238
550 "Libguestfs contains API calls to read, create and modify partition tables on "
555 #: ../src/guestfs.pod:241
557 "In the common case where you want to create a single partition covering the "
558 "whole disk, you should use the L</guestfs_part_disk> call:"
562 #: ../src/guestfs.pod:245
565 " const char *parttype = \"mbr\";\n"
566 " if (disk_is_larger_than_2TB)\n"
567 " parttype = \"gpt\";\n"
568 " guestfs_part_disk (g, \"/dev/sda\", parttype);\n"
573 #: ../src/guestfs.pod:250
575 "Obviously this effectively wipes anything that was on that disk image before."
579 #: ../src/guestfs.pod:253
584 #: ../src/guestfs.pod:255
586 "Libguestfs provides access to a large part of the LVM2 API, such as L</"
587 "guestfs_lvcreate> and L</guestfs_vgremove>. It won't make much sense unless "
588 "you familiarize yourself with the concepts of physical volumes, volume "
589 "groups and logical volumes."
593 #: ../src/guestfs.pod:260
595 "This author strongly recommends reading the LVM HOWTO, online at L<http://"
596 "tldp.org/HOWTO/LVM-HOWTO/>."
600 #: ../src/guestfs.pod:263
605 #: ../src/guestfs.pod:265
607 "Use L</guestfs_cat> to download small, text only files. This call is "
608 "limited to files which are less than 2 MB and which cannot contain any ASCII "
609 "NUL (C<\\0>) characters. However the API is very simple to use."
613 #: ../src/guestfs.pod:269
615 "L</guestfs_read_file> can be used to read files which contain arbitrary 8 "
616 "bit data, since it returns a (pointer, size) pair. However it is still "
617 "limited to \"small\" files, less than 2 MB."
621 #: ../src/guestfs.pod:273
623 "L</guestfs_download> can be used to download any file, with no limits on "
624 "content or size (even files larger than 4 GB)."
628 #: ../src/guestfs.pod:276
630 "To download multiple files, see L</guestfs_tar_out> and L</guestfs_tgz_out>."
634 #: ../src/guestfs.pod:279
636 msgstr "ВИВАНТАЖЕННЯ"
639 #: ../src/guestfs.pod:281
641 "It's often the case that you want to write a file or files to the disk image."
645 #: ../src/guestfs.pod:284
647 "To write a small file with fixed content, use L</guestfs_write>. To create "
648 "a file of all zeroes, use L</guestfs_truncate_size> (sparse) or L</"
649 "guestfs_fallocate64> (with all disk blocks allocated). There are a variety "
650 "of other functions for creating test files, for example L</guestfs_fill> and "
651 "L</guestfs_fill_pattern>."
655 #: ../src/guestfs.pod:290
657 "To upload a single file, use L</guestfs_upload>. This call has no limits on "
658 "file content or size (even files larger than 4 GB)."
662 #: ../src/guestfs.pod:293
664 "To upload multiple files, see L</guestfs_tar_in> and L</guestfs_tgz_in>."
668 #: ../src/guestfs.pod:295
670 "However the fastest way to upload I<large numbers of arbitrary files> is to "
671 "turn them into a squashfs or CD ISO (see L<mksquashfs(8)> and L<mkisofs(8)"
672 ">), then attach this using L</guestfs_add_drive_ro>. If you add the drive "
673 "in a predictable way (eg. adding it last after all other drives) then you "
674 "can get the device name from L</guestfs_list_devices> and mount it directly "
675 "using L</guestfs_mount_ro>. Note that squashfs images are sometimes non-"
676 "portable between kernel versions, and they don't support labels or UUIDs. "
677 "If you want to pre-build an image or you need to mount it using a label or "
678 "UUID, use an ISO image instead."
682 #: ../src/guestfs.pod:306
687 #: ../src/guestfs.pod:308
689 "There are various different commands for copying between files and devices "
690 "and in and out of the guest filesystem. These are summarised in the table "
695 #: ../src/guestfs.pod:314
696 msgid "B<file> to B<file>"
700 #: ../src/guestfs.pod:316
702 "Use L</guestfs_cp> to copy a single file, or L</guestfs_cp_a> to copy "
703 "directories recursively."
707 #: ../src/guestfs.pod:319
708 msgid "B<file or device> to B<file or device>"
712 #: ../src/guestfs.pod:321
714 "Use L</guestfs_dd> which efficiently uses L<dd(1)> to copy between files and "
715 "devices in the guest."
719 #: ../src/guestfs.pod:324
720 msgid "Example: duplicate the contents of an LV:"
724 #: ../src/guestfs.pod:326
727 " guestfs_dd (g, \"/dev/VG/Original\", \"/dev/VG/Copy\");\n"
732 #: ../src/guestfs.pod:328
734 "The destination (C</dev/VG/Copy>) must be at least as large as the source "
735 "(C</dev/VG/Original>). To copy less than the whole source device, use L</"
736 "guestfs_copy_size>."
740 #: ../src/guestfs.pod:332
741 msgid "B<file on the host> to B<file or device>"
745 #: ../src/guestfs.pod:334
746 msgid "Use L</guestfs_upload>. See L</UPLOADING> above."
750 #: ../src/guestfs.pod:336
751 msgid "B<file or device> to B<file on the host>"
755 #: ../src/guestfs.pod:338
756 msgid "Use L</guestfs_download>. See L</DOWNLOADING> above."
760 #: ../src/guestfs.pod:342
761 msgid "UPLOADING AND DOWNLOADING TO PIPES AND FILE DESCRIPTORS"
765 #: ../src/guestfs.pod:344
767 "Calls like L</guestfs_upload>, L</guestfs_download>, L</guestfs_tar_in>, L</"
768 "guestfs_tar_out> etc appear to only take filenames as arguments, so it "
769 "appears you can only upload and download to files. However many Un*x-like "
770 "hosts let you use the special device files C</dev/stdin>, C</dev/stdout>, C</"
771 "dev/stderr> and C</dev/fd/N> to read and write from stdin, stdout, stderr, "
772 "and arbitrary file descriptor N."
776 #: ../src/guestfs.pod:352
777 msgid "For example, L<virt-cat(1)> writes its output to stdout by doing:"
781 #: ../src/guestfs.pod:355
784 " guestfs_download (g, filename, \"/dev/stdout\");\n"
789 #: ../src/guestfs.pod:357
790 msgid "and you can write tar output to a pipe C<fd> by doing:"
794 #: ../src/guestfs.pod:359
798 " snprintf (devfd, sizeof devfd, \"/dev/fd/%d\", fd);\n"
799 " guestfs_tar_out (g, \"/\", devfd);\n"
804 #: ../src/guestfs.pod:363
805 msgid "LISTING FILES"
809 #: ../src/guestfs.pod:365
811 "L</guestfs_ll> is just designed for humans to read (mainly when using the "
812 "L<guestfish(1)>-equivalent command C<ll>)."
816 #: ../src/guestfs.pod:368
818 "L</guestfs_ls> is a quick way to get a list of files in a directory from "
819 "programs, as a flat list of strings."
823 #: ../src/guestfs.pod:371
825 "L</guestfs_readdir> is a programmatic way to get a list of files in a "
826 "directory, plus additional information about each one. It is more "
827 "equivalent to using the L<readdir(3)> call on a local filesystem."
831 #: ../src/guestfs.pod:375
833 "L</guestfs_find> and L</guestfs_find0> can be used to recursively list files."
837 #: ../src/guestfs.pod:378
838 msgid "RUNNING COMMANDS"
842 #: ../src/guestfs.pod:380
844 "Although libguestfs is primarily an API for manipulating files inside guest "
845 "images, we also provide some limited facilities for running commands inside "
850 #: ../src/guestfs.pod:384
851 msgid "There are many limitations to this:"
855 #: ../src/guestfs.pod:388 ../src/guestfs.pod:393 ../src/guestfs.pod:398
856 #: ../src/guestfs.pod:402 ../src/guestfs.pod:407 ../src/guestfs.pod:411
857 #: ../src/guestfs.pod:416 ../src/guestfs.pod:421 ../src/guestfs.pod:1087
858 #: ../src/guestfs.pod:1091 ../src/guestfs.pod:1095 ../src/guestfs.pod:1100
859 #: ../src/guestfs.pod:1108 ../src/guestfs.pod:1127 ../src/guestfs.pod:1135
860 #: ../src/guestfs.pod:1157 ../src/guestfs.pod:1161 ../src/guestfs.pod:1165
861 #: ../src/guestfs.pod:1169 ../src/guestfs.pod:1173 ../src/guestfs.pod:1177
862 #: ../src/guestfs.pod:1659 ../src/guestfs.pod:1664 ../src/guestfs.pod:1668
863 #: ../src/guestfs.pod:1769 ../src/guestfs.pod:1774 ../src/guestfs.pod:1778
864 #: ../src/guestfs.pod:1788 ../src/guestfs.pod:2022 ../src/guestfs.pod:2027
865 #: ../src/guestfs.pod:2033 ../src/guestfs.pod:2041 ../src/guestfs.pod:2395
866 #: ../src/guestfs.pod:2401 ../src/guestfs.pod:2406 ../src/guestfs.pod:2412
867 #: ../src/guestfs.pod:2877 ../src/guestfs.pod:2881 ../src/guestfs.pod:2885
868 #: ../src/guestfs.pod:2889 ../src/guestfs-actions.pod:15
869 #: ../src/guestfs-actions.pod:22 ../src/guestfs-actions.pod:577
870 #: ../src/guestfs-actions.pod:585 ../src/guestfs-actions.pod:592
871 #: ../src/guestfs-actions.pod:599 ../src/guestfs-actions.pod:1600
872 #: ../src/guestfs-actions.pod:1604 ../src/guestfs-actions.pod:1608
873 #: ../src/guestfs-actions.pod:1612 ../src/guestfs-actions.pod:1620
874 #: ../src/guestfs-actions.pod:1624 ../src/guestfs-actions.pod:1628
875 #: ../src/guestfs-actions.pod:1638 ../src/guestfs-actions.pod:1642
876 #: ../src/guestfs-actions.pod:1646 ../src/guestfs-actions.pod:1784
877 #: ../src/guestfs-actions.pod:1788 ../src/guestfs-actions.pod:1793
878 #: ../src/guestfs-actions.pod:1798 ../src/guestfs-actions.pod:1859
879 #: ../src/guestfs-actions.pod:1863 ../src/guestfs-actions.pod:1868
880 #: ../fish/guestfish.pod:443 ../fish/guestfish.pod:447
881 #: ../fish/guestfish.pod:451 ../fish/guestfish.pod:455
882 #: ../fish/guestfish-actions.pod:13 ../fish/guestfish-actions.pod:20
883 #: ../fish/guestfish-actions.pod:380 ../fish/guestfish-actions.pod:388
884 #: ../fish/guestfish-actions.pod:395 ../fish/guestfish-actions.pod:402
885 #: ../fish/guestfish-actions.pod:1072 ../fish/guestfish-actions.pod:1076
886 #: ../fish/guestfish-actions.pod:1080 ../fish/guestfish-actions.pod:1084
887 #: ../fish/guestfish-actions.pod:1092 ../fish/guestfish-actions.pod:1096
888 #: ../fish/guestfish-actions.pod:1100 ../fish/guestfish-actions.pod:1110
889 #: ../fish/guestfish-actions.pod:1114 ../fish/guestfish-actions.pod:1118
890 #: ../fish/guestfish-actions.pod:1208 ../fish/guestfish-actions.pod:1212
891 #: ../fish/guestfish-actions.pod:1217 ../fish/guestfish-actions.pod:1222
892 #: ../fish/guestfish-actions.pod:1264 ../fish/guestfish-actions.pod:1268
893 #: ../fish/guestfish-actions.pod:1273 ../tools/virt-edit.pl:351
894 #: ../tools/virt-edit.pl:356 ../tools/virt-edit.pl:361
895 #: ../tools/virt-edit.pl:372 ../tools/virt-edit.pl:376
896 #: ../tools/virt-win-reg.pl:536 ../tools/virt-win-reg.pl:542
897 #: ../tools/virt-win-reg.pl:548
902 #: ../src/guestfs.pod:390
904 "The kernel version that the command runs under will be different from what "
909 #: ../src/guestfs.pod:395
911 "If the command needs to communicate with daemons, then most likely they "
916 #: ../src/guestfs.pod:400
917 msgid "The command will be running in limited memory."
921 #: ../src/guestfs.pod:404
923 "The network may not be available unless you enable it (see L</"
924 "guestfs_set_network>)."
928 #: ../src/guestfs.pod:409
929 msgid "Only supports Linux guests (not Windows, BSD, etc)."
933 #: ../src/guestfs.pod:413
935 "Architecture limitations (eg. won't work for a PPC guest on an X86 host)."
939 #: ../src/guestfs.pod:418
941 "For SELinux guests, you may need to enable SELinux and load policy first. "
942 "See L</SELINUX> in this manpage."
946 #: ../src/guestfs.pod:423
948 "I<Security:> It is not safe to run commands from untrusted, possibly "
949 "malicious guests. These commands may attempt to exploit your program by "
950 "sending unexpected output. They could also try to exploit the Linux kernel "
951 "or qemu provided by the libguestfs appliance. They could use the network "
952 "provided by the libguestfs appliance to bypass ordinary network partitions "
953 "and firewalls. They could use the elevated privileges or different SELinux "
954 "context of your program to their advantage."
958 #: ../src/guestfs.pod:432
960 "A secure alternative is to use libguestfs to install a \"firstboot\" script "
961 "(a script which runs when the guest next boots normally), and to have this "
962 "script run the commands you want in the normal context of the running guest, "
963 "network security and so on. For information about other security issues, "
968 #: ../src/guestfs.pod:440
970 "The two main API calls to run commands are L</guestfs_command> and L</"
971 "guestfs_sh> (there are also variations)."
975 #: ../src/guestfs.pod:443
977 "The difference is that L</guestfs_sh> runs commands using the shell, so any "
978 "shell globs, redirections, etc will work."
982 #: ../src/guestfs.pod:446
983 msgid "CONFIGURATION FILES"
984 msgstr "ФАЙЛИ НАЛАШТУВАННЯ"
987 #: ../src/guestfs.pod:448
989 "To read and write configuration files in Linux guest filesystems, we "
990 "strongly recommend using Augeas. For example, Augeas understands how to "
991 "read and write, say, a Linux shadow password file or X.org configuration "
992 "file, and so avoids you having to write that code."
996 #: ../src/guestfs.pod:453
998 "The main Augeas calls are bound through the C<guestfs_aug_*> APIs. We don't "
999 "document Augeas itself here because there is excellent documentation on the "
1000 "L<http://augeas.net/> website."
1004 #: ../src/guestfs.pod:457
1006 "If you don't want to use Augeas (you fool!) then try calling L</"
1007 "guestfs_read_lines> to get the file as a list of lines which you can iterate "
1012 #: ../src/guestfs.pod:461
1017 #: ../src/guestfs.pod:463
1019 "We support SELinux guests. To ensure that labeling happens correctly in "
1020 "SELinux guests, you need to enable SELinux and load the guest's policy:"
1024 #: ../src/guestfs.pod:469 ../src/guestfs.pod:1280 ../src/guestfs.pod:1411
1025 #: ../src/guestfs.pod:2440
1030 #: ../src/guestfs.pod:471
1031 msgid "Before launching, do:"
1035 #: ../src/guestfs.pod:473
1038 " guestfs_set_selinux (g, 1);\n"
1043 #: ../src/guestfs.pod:475 ../src/guestfs.pod:1284 ../src/guestfs.pod:1415
1044 #: ../src/guestfs.pod:2465
1049 #: ../src/guestfs.pod:477
1051 "After mounting the guest's filesystem(s), load the policy. This is best "
1052 "done by running the L<load_policy(8)> command in the guest itself:"
1056 #: ../src/guestfs.pod:481
1059 " guestfs_sh (g, \"/usr/sbin/load_policy\");\n"
1064 #: ../src/guestfs.pod:483
1066 "(Older versions of C<load_policy> require you to specify the name of the "
1071 #: ../src/guestfs.pod:486 ../src/guestfs.pod:1421
1076 #: ../src/guestfs.pod:488
1078 "Optionally, set the security context for the API. The correct security "
1079 "context to use can only be known by inspecting the guest. As an example:"
1083 #: ../src/guestfs.pod:492
1086 " guestfs_setcon (g, \"unconfined_u:unconfined_r:unconfined_t:s0\");\n"
1091 #: ../src/guestfs.pod:496
1092 msgid "This will work for running commands and editing existing files."
1096 #: ../src/guestfs.pod:498
1098 "When new files are created, you may need to label them explicitly, for "
1099 "example by running the external command C<restorecon pathname>."
1103 #: ../src/guestfs.pod:502
1108 #: ../src/guestfs.pod:504
1110 "Certain calls are affected by the current file mode creation mask (the "
1111 "\"umask\"). In particular ones which create files or directories, such as "
1112 "L</guestfs_touch>, L</guestfs_mknod> or L</guestfs_mkdir>. This affects "
1113 "either the default mode that the file is created with or modifies the mode "
1118 #: ../src/guestfs.pod:510
1120 "The default umask is C<022>, so files are created with modes such as C<0644> "
1121 "and directories with C<0755>."
1125 #: ../src/guestfs.pod:513
1127 "There are two ways to avoid being affected by umask. Either set umask to 0 "
1128 "(call C<guestfs_umask (g, 0)> early after launching). Or call L</"
1129 "guestfs_chmod> after creating each file or directory."
1133 #: ../src/guestfs.pod:517
1134 msgid "For more information about umask, see L<umask(2)>."
1138 #: ../src/guestfs.pod:519 ../fish/guestfish.pod:765
1139 msgid "ENCRYPTED DISKS"
1143 #: ../src/guestfs.pod:521
1145 "Libguestfs allows you to access Linux guests which have been encrypted using "
1146 "whole disk encryption that conforms to the Linux Unified Key Setup (LUKS) "
1147 "standard. This includes nearly all whole disk encryption systems used by "
1148 "modern Linux guests."
1152 #: ../src/guestfs.pod:527
1154 "Use L</guestfs_vfs_type> to identify LUKS-encrypted block devices (it "
1155 "returns the string C<crypto_LUKS>)."
1159 #: ../src/guestfs.pod:530
1161 "Then open these devices by calling L</guestfs_luks_open>. Obviously you "
1162 "will require the passphrase!"
1166 #: ../src/guestfs.pod:533
1168 "Opening a LUKS device creates a new device mapper device called C</dev/"
1169 "mapper/mapname> (where C<mapname> is the string you supply to L</"
1170 "guestfs_luks_open>). Reads and writes to this mapper device are decrypted "
1171 "from and encrypted to the underlying block device respectively."
1175 #: ../src/guestfs.pod:539
1177 "LVM volume groups on the device can be made visible by calling L</"
1178 "guestfs_vgscan> followed by L</guestfs_vg_activate_all>. The logical volume"
1179 "(s) can now be mounted in the usual way."
1183 #: ../src/guestfs.pod:543
1185 "Use the reverse process to close a LUKS device. Unmount any logical volumes "
1186 "on it, deactivate the volume groups by caling C<guestfs_vg_activate (g, 0, "
1187 "[\"/dev/VG\"])>. Then close the mapper device by calling L</"
1188 "guestfs_luks_close> on the C</dev/mapper/mapname> device (I<not> the "
1189 "underlying encrypted block device)."
1193 #: ../src/guestfs.pod:550
1198 #: ../src/guestfs.pod:552
1200 "Libguestfs has APIs for inspecting an unknown disk image to find out if it "
1201 "contains operating systems, an install CD or a live CD. (These APIs used to "
1202 "be in a separate Perl-only library called L<Sys::Guestfs::Lib(3)> but since "
1203 "version 1.5.3 the most frequently used part of this library has been "
1204 "rewritten in C and moved into the core code)."
1208 #: ../src/guestfs.pod:559
1210 "Add all disks belonging to the unknown virtual machine and call L</"
1211 "guestfs_launch> in the usual way."
1215 #: ../src/guestfs.pod:562
1217 "Then call L</guestfs_inspect_os>. This function uses other libguestfs calls "
1218 "and certain heuristics, and returns a list of operating systems that were "
1219 "found. An empty list means none were found. A single element is the root "
1220 "filesystem of the operating system. For dual- or multi-boot guests, "
1221 "multiple roots can be returned, each one corresponding to a separate "
1222 "operating system. (Multi-boot virtual machines are extremely rare in the "
1223 "world of virtualization, but since this scenario can happen, we have built "
1224 "libguestfs to deal with it.)"
1228 #: ../src/guestfs.pod:571
1230 "For each root, you can then call various C<guestfs_inspect_get_*> functions "
1231 "to get additional details about that operating system. For example, call L</"
1232 "guestfs_inspect_get_type> to return the string C<windows> or C<linux> for "
1233 "Windows and Linux-based operating systems respectively."
1237 #: ../src/guestfs.pod:577
1239 "Un*x-like and Linux-based operating systems usually consist of several "
1240 "filesystems which are mounted at boot time (for example, a separate boot "
1241 "partition mounted on C</boot>). The inspection rules are able to detect how "
1242 "filesystems correspond to mount points. Call "
1243 "C<guestfs_inspect_get_mountpoints> to get this mapping. It might return a "
1244 "hash table like this example:"
1248 #: ../src/guestfs.pod:584
1251 " /boot => /dev/sda1\n"
1252 " / => /dev/vg_guest/lv_root\n"
1253 " /usr => /dev/vg_guest/lv_usr\n"
1258 #: ../src/guestfs.pod:588
1260 "The caller can then make calls to L</guestfs_mount_options> to mount the "
1261 "filesystems as suggested."
1265 #: ../src/guestfs.pod:591
1267 "Be careful to mount filesystems in the right order (eg. C</> before C</"
1268 "usr>). Sorting the keys of the hash by length, shortest first, should work."
1272 #: ../src/guestfs.pod:595
1274 "Inspection currently only works for some common operating systems. "
1275 "Contributors are welcome to send patches for other operating systems that we "
1276 "currently cannot detect."
1280 #: ../src/guestfs.pod:599
1282 "Encrypted disks must be opened before inspection. See L</ENCRYPTED DISKS> "
1283 "for more details. The L</guestfs_inspect_os> function just ignores any "
1284 "encrypted devices."
1288 #: ../src/guestfs.pod:603
1290 "A note on the implementation: The call L</guestfs_inspect_os> performs "
1291 "inspection and caches the results in the guest handle. Subsequent calls to "
1292 "C<guestfs_inspect_get_*> return this cached information, but I<do not> re-"
1293 "read the disks. If you change the content of the guest disks, you can redo "
1294 "inspection by calling L</guestfs_inspect_os> again. (L</"
1295 "guestfs_inspect_list_applications> works a little differently from the other "
1296 "calls and does read the disks. See documentation for that function for "
1301 #: ../src/guestfs.pod:612
1302 msgid "INSPECTING INSTALL DISKS"
1306 #: ../src/guestfs.pod:614
1308 "Libguestfs (since 1.9.4) can detect some install disks, install CDs, live "
1313 #: ../src/guestfs.pod:617
1315 "Call L</guestfs_inspect_get_format> to return the format of the operating "
1316 "system, which currently can be C<installed> (a regular operating system) or "
1317 "C<installer> (some sort of install disk)."
1321 #: ../src/guestfs.pod:621
1323 "Further information is available about the operating system that can be "
1324 "installed using the regular inspection APIs like L</"
1325 "guestfs_inspect_get_product_name>, L</guestfs_inspect_get_major_version> etc."
1329 #: ../src/guestfs.pod:626
1331 "Some additional information specific to installer disks is also available "
1332 "from the L</guestfs_inspect_is_live>, L</guestfs_inspect_is_netinst> and L</"
1333 "guestfs_inspect_is_multipart> calls."
1337 #: ../src/guestfs.pod:631
1338 msgid "SPECIAL CONSIDERATIONS FOR WINDOWS GUESTS"
1342 #: ../src/guestfs.pod:633
1344 "Libguestfs can mount NTFS partitions. It does this using the L<http://www."
1345 "ntfs-3g.org/> driver."
1349 #: ../src/guestfs.pod:636
1350 msgid "DRIVE LETTERS AND PATHS"
1354 #: ../src/guestfs.pod:638
1356 "DOS and Windows still use drive letters, and the filesystems are always "
1357 "treated as case insensitive by Windows itself, and therefore you might find "
1358 "a Windows configuration file referring to a path like C<c:\\windows"
1359 "\\system32>. When the filesystem is mounted in libguestfs, that directory "
1360 "might be referred to as C</WINDOWS/System32>."
1364 #: ../src/guestfs.pod:644
1366 "Drive letter mappings can be found using inspection (see L</INSPECTION> and "
1367 "L</guestfs_inspect_get_drive_mappings>)"
1371 #: ../src/guestfs.pod:647
1373 "Dealing with separator characters (backslash vs forward slash) is outside "
1374 "the scope of libguestfs, but usually a simple character replacement will "
1379 #: ../src/guestfs.pod:651
1381 "To resolve the case insensitivity of paths, call L</"
1382 "guestfs_case_sensitive_path>."
1386 #: ../src/guestfs.pod:654
1387 msgid "ACCESSING THE WINDOWS REGISTRY"
1391 #: ../src/guestfs.pod:656
1393 "Libguestfs also provides some help for decoding Windows Registry \"hive\" "
1394 "files, through the library C<hivex> which is part of the libguestfs project "
1395 "although ships as a separate tarball. You have to locate and download the "
1396 "hive file(s) yourself, and then pass them to C<hivex> functions. See also "
1397 "the programs L<hivexml(1)>, L<hivexsh(1)>, L<hivexregedit(1)> and L<virt-win-"
1398 "reg(1)> for more help on this issue."
1402 #: ../src/guestfs.pod:664
1403 msgid "SYMLINKS ON NTFS-3G FILESYSTEMS"
1407 #: ../src/guestfs.pod:666
1409 "Ntfs-3g tries to rewrite \"Junction Points\" and NTFS \"symbolic links\" to "
1410 "provide something which looks like a Linux symlink. The way it tries to do "
1411 "the rewriting is described here:"
1415 #: ../src/guestfs.pod:670
1417 "L<http://www.tuxera.com/community/ntfs-3g-advanced/junction-points-and-"
1420 "L<http://www.tuxera.com/community/ntfs-3g-advanced/junction-points-and-"
1424 #: ../src/guestfs.pod:672
1426 "The essential problem is that ntfs-3g simply does not have enough "
1427 "information to do a correct job. NTFS links can contain drive letters and "
1428 "references to external device GUIDs that ntfs-3g has no way of resolving. "
1429 "It is almost certainly the case that libguestfs callers should ignore what "
1430 "ntfs-3g does (ie. don't use L</guestfs_readlink> on NTFS volumes)."
1434 #: ../src/guestfs.pod:679
1436 "Instead if you encounter a symbolic link on an ntfs-3g filesystem, use L</"
1437 "guestfs_lgetxattr> to read the C<system.ntfs_reparse_data> extended "
1438 "attribute, and read the raw reparse data from that (you can find the format "
1439 "documented in various places around the web)."
1443 #: ../src/guestfs.pod:684
1444 msgid "EXTENDED ATTRIBUTES ON NTFS-3G FILESYSTEMS"
1448 #: ../src/guestfs.pod:686
1450 "There are other useful extended attributes that can be read from ntfs-3g "
1451 "filesystems (using L</guestfs_getxattr>). See:"
1455 #: ../src/guestfs.pod:689
1457 "L<http://www.tuxera.com/community/ntfs-3g-advanced/extended-attributes/>"
1459 "L<http://www.tuxera.com/community/ntfs-3g-advanced/extended-attributes/>"
1462 #: ../src/guestfs.pod:691
1463 msgid "USING LIBGUESTFS WITH OTHER PROGRAMMING LANGUAGES"
1467 #: ../src/guestfs.pod:693
1469 "Although we don't want to discourage you from using the C API, we will "
1470 "mention here that the same API is also available in other languages."
1474 #: ../src/guestfs.pod:696
1476 "The API is broadly identical in all supported languages. This means that "
1477 "the C call C<guestfs_add_drive_ro(g,file)> is C<$g-E<gt>add_drive_ro($file)> "
1478 "in Perl, C<g.add_drive_ro(file)> in Python, and C<g#add_drive_ro file> in "
1479 "OCaml. In other words, a straightforward, predictable isomorphism between "
1484 #: ../src/guestfs.pod:702
1486 "Error messages are automatically transformed into exceptions if the language "
1491 #: ../src/guestfs.pod:705
1493 "We don't try to \"object orientify\" parts of the API in OO languages, "
1494 "although contributors are welcome to write higher level APIs above what we "
1495 "provide in their favourite languages if they wish."
1499 #: ../src/guestfs.pod:711
1504 #: ../src/guestfs.pod:713
1506 "You can use the I<guestfs.h> header file from C++ programs. The C++ API is "
1507 "identical to the C API. C++ classes and exceptions are not used."
1511 #: ../src/guestfs.pod:717
1516 #: ../src/guestfs.pod:719
1518 "The C# bindings are highly experimental. Please read the warnings at the "
1519 "top of C<csharp/Libguestfs.cs>."
1523 #: ../src/guestfs.pod:722
1528 #: ../src/guestfs.pod:724
1530 "This is the only language binding that is working but incomplete. Only "
1531 "calls which return simple integers have been bound in Haskell, and we are "
1532 "looking for help to complete this binding."
1536 #: ../src/guestfs.pod:728
1541 #: ../src/guestfs.pod:730
1543 "Full documentation is contained in the Javadoc which is distributed with "
1548 #: ../src/guestfs.pod:733
1553 #: ../src/guestfs.pod:735
1554 msgid "See L<guestfs-ocaml(3)>."
1555 msgstr "Див. L<guestfs-ocaml(3)>."
1558 #: ../src/guestfs.pod:737
1563 #: ../src/guestfs.pod:739
1564 msgid "See L<guestfs-perl(3)> and L<Sys::Guestfs(3)>."
1565 msgstr "Див. L<guestfs-perl(3)> та L<Sys::Guestfs(3)>."
1568 #: ../src/guestfs.pod:741
1573 #: ../src/guestfs.pod:743
1575 "For documentation see C<README-PHP> supplied with libguestfs sources or in "
1576 "the php-libguestfs package for your distribution."
1580 #: ../src/guestfs.pod:746
1581 msgid "The PHP binding only works correctly on 64 bit machines."
1585 #: ../src/guestfs.pod:748
1590 #: ../src/guestfs.pod:750
1591 msgid "See L<guestfs-python(3)>."
1592 msgstr "Див. L<guestfs-python(3)>."
1595 #: ../src/guestfs.pod:752
1600 #: ../src/guestfs.pod:754
1601 msgid "See L<guestfs-ruby(3)>."
1602 msgstr "Див. L<guestfs-ruby(3)>."
1605 #: ../src/guestfs.pod:756
1606 msgid "B<shell scripts>"
1607 msgstr "B<скрипти оболонки>"
1610 #: ../src/guestfs.pod:758
1611 msgid "See L<guestfish(1)>."
1612 msgstr "Див. L<guestfish(1)>."
1615 #: ../src/guestfs.pod:762
1616 msgid "LIBGUESTFS GOTCHAS"
1620 #: ../src/guestfs.pod:764
1622 "L<http://en.wikipedia.org/wiki/Gotcha_(programming)>: \"A feature of a "
1623 "system [...] that works in the way it is documented but is counterintuitive "
1624 "and almost invites mistakes.\""
1628 #: ../src/guestfs.pod:768
1630 "Since we developed libguestfs and the associated tools, there are several "
1631 "things we would have designed differently, but are now stuck with for "
1632 "backwards compatibility or other reasons. If there is ever a libguestfs 2.0 "
1633 "release, you can expect these to change. Beware of them."
1637 #: ../src/guestfs.pod:776
1638 msgid "Autosync / forgetting to sync."
1642 #: ../src/guestfs.pod:778
1644 "When modifying a filesystem from C or another language, you B<must> unmount "
1645 "all filesystems and call L</guestfs_sync> explicitly before you close the "
1646 "libguestfs handle. You can also call:"
1650 #: ../src/guestfs.pod:782
1653 " guestfs_set_autosync (g, 1);\n"
1658 #: ../src/guestfs.pod:784
1660 "to have the unmount/sync done automatically for you when the handle 'g' is "
1661 "closed. (This feature is called \"autosync\", L</guestfs_set_autosync> q.v.)"
1665 #: ../src/guestfs.pod:788
1667 "If you forget to do this, then it is entirely possible that your changes "
1668 "won't be written out, or will be partially written, or (very rarely) that "
1669 "you'll get disk corruption."
1673 #: ../src/guestfs.pod:792
1675 "Note that in L<guestfish(3)> autosync is the default. So quick and dirty "
1676 "guestfish scripts that forget to sync will work just fine, which can make "
1677 "this very puzzling if you are trying to debug a problem."
1681 #: ../src/guestfs.pod:796
1683 "Update: Autosync is enabled by default for all API users starting from "
1684 "libguestfs 1.5.24."
1688 #: ../src/guestfs.pod:799
1689 msgid "Mount option C<-o sync> should not be the default."
1693 #: ../src/guestfs.pod:801
1695 "If you use L</guestfs_mount>, then C<-o sync,noatime> are added implicitly. "
1696 "However C<-o sync> does not add any reliability benefit, but does have a "
1697 "very large performance impact."
1701 #: ../src/guestfs.pod:805
1703 "The work around is to use L</guestfs_mount_options> and set the mount "
1704 "options that you actually want to use."
1708 #: ../src/guestfs.pod:808
1709 msgid "Read-only should be the default."
1713 #: ../src/guestfs.pod:810
1715 "In L<guestfish(3)>, I<--ro> should be the default, and you should have to "
1716 "specify I<--rw> if you want to make changes to the image."
1720 #: ../src/guestfs.pod:813
1721 msgid "This would reduce the potential to corrupt live VM images."
1725 #: ../src/guestfs.pod:815
1727 "Note that many filesystems change the disk when you just mount and unmount, "
1728 "even if you didn't perform any writes. You need to use L</"
1729 "guestfs_add_drive_ro> to guarantee that the disk is not changed."
1733 #: ../src/guestfs.pod:819
1734 msgid "guestfish command line is hard to use."
1738 #: ../src/guestfs.pod:821
1740 "C<guestfish disk.img> doesn't do what people expect (open C<disk.img> for "
1741 "examination). It tries to run a guestfish command C<disk.img> which doesn't "
1742 "exist, so it fails. In earlier versions of guestfish the error message was "
1743 "also unintuitive, but we have corrected this since. Like the Bourne shell, "
1744 "we should have used C<guestfish -c command> to run commands."
1748 #: ../src/guestfs.pod:828
1749 msgid "guestfish megabyte modifiers don't work right on all commands"
1753 #: ../src/guestfs.pod:830
1755 "In recent guestfish you can use C<1M> to mean 1 megabyte (and similarly for "
1756 "other modifiers). What guestfish actually does is to multiply the number "
1757 "part by the modifier part and pass the result to the C API. However this "
1758 "doesn't work for a few APIs which aren't expecting bytes, but are already "
1759 "expecting some other unit (eg. megabytes)."
1763 #: ../src/guestfs.pod:837
1764 msgid "The most common is L</guestfs_lvcreate>. The guestfish command:"
1768 #: ../src/guestfs.pod:839
1771 " lvcreate LV VG 100M\n"
1776 #: ../src/guestfs.pod:841
1778 "does not do what you might expect. Instead because L</guestfs_lvcreate> is "
1779 "already expecting megabytes, this tries to create a 100 I<terabyte> (100 "
1780 "megabytes * megabytes) logical volume. The error message you get from this "
1781 "is also a little obscure."
1785 #: ../src/guestfs.pod:846
1787 "This could be fixed in the generator by specially marking parameters and "
1788 "return values which take bytes or other units."
1792 #: ../src/guestfs.pod:849
1793 msgid "Ambiguity between devices and paths"
1797 #: ../src/guestfs.pod:851
1799 "There is a subtle ambiguity in the API between a device name (eg. C</dev/"
1800 "sdb2>) and a similar pathname. A file might just happen to be called "
1801 "C<sdb2> in the directory C</dev> (consider some non-Unix VM image)."
1805 #: ../src/guestfs.pod:856
1807 "In the current API we usually resolve this ambiguity by having two separate "
1808 "calls, for example L</guestfs_checksum> and L</guestfs_checksum_device>. "
1809 "Some API calls are ambiguous and (incorrectly) resolve the problem by "
1810 "detecting if the path supplied begins with C</dev/>."
1814 #: ../src/guestfs.pod:862
1816 "To avoid both the ambiguity and the need to duplicate some calls, we could "
1817 "make paths/devices into structured names. One way to do this would be to "
1818 "use a notation like grub (C<hd(0,0)>), although nobody really likes this "
1819 "aspect of grub. Another way would be to use a structured type, equivalent "
1820 "to this OCaml type:"
1824 #: ../src/guestfs.pod:868
1827 " type path = Path of string | Device of int | Partition of int * int\n"
1832 #: ../src/guestfs.pod:870
1833 msgid "which would allow you to pass arguments like:"
1837 #: ../src/guestfs.pod:872
1840 " Path \"/foo/bar\"\n"
1841 " Device 1 (* /dev/sdb, or perhaps /dev/sda *)\n"
1842 " Partition (1, 2) (* /dev/sdb2 (or is it /dev/sda2 or /dev/sdb3?) *)\n"
1843 " Path \"/dev/sdb2\" (* not a device *)\n"
1848 #: ../src/guestfs.pod:877
1850 "As you can see there are still problems to resolve even with this "
1851 "representation. Also consider how it might work in guestfish."
1855 #: ../src/guestfs.pod:882
1856 msgid "PROTOCOL LIMITS"
1860 #: ../src/guestfs.pod:884
1862 "Internally libguestfs uses a message-based protocol to pass API calls and "
1863 "their responses to and from a small \"appliance\" (see L</INTERNALS> for "
1864 "plenty more detail about this). The maximum message size used by the "
1865 "protocol is slightly less than 4 MB. For some API calls you may need to be "
1866 "aware of this limit. The API calls which may be affected are individually "
1867 "documented, with a link back to this section of the documentation."
1871 #: ../src/guestfs.pod:892
1873 "A simple call such as L</guestfs_cat> returns its result (the file data) in "
1874 "a simple string. Because this string is at some point internally encoded as "
1875 "a message, the maximum size that it can return is slightly under 4 MB. If "
1876 "the requested file is larger than this then you will get an error."
1880 #: ../src/guestfs.pod:898
1882 "In order to transfer large files into and out of the guest filesystem, you "
1883 "need to use particular calls that support this. The sections L</UPLOADING> "
1884 "and L</DOWNLOADING> document how to do this."
1888 #: ../src/guestfs.pod:902
1890 "You might also consider mounting the disk image using our FUSE filesystem "
1891 "support (L<guestmount(1)>)."
1895 #: ../src/guestfs.pod:905
1896 msgid "KEYS AND PASSPHRASES"
1900 #: ../src/guestfs.pod:907
1902 "Certain libguestfs calls take a parameter that contains sensitive key "
1903 "material, passed in as a C string."
1907 #: ../src/guestfs.pod:910
1909 "In the future we would hope to change the libguestfs implementation so that "
1910 "keys are L<mlock(2)>-ed into physical RAM, and thus can never end up in "
1911 "swap. However this is I<not> done at the moment, because of the complexity "
1912 "of such an implementation."
1916 #: ../src/guestfs.pod:915
1918 "Therefore you should be aware that any key parameter you pass to libguestfs "
1919 "might end up being written out to the swap partition. If this is a concern, "
1920 "scrub the swap partition or don't use libguestfs on encrypted devices."
1924 #: ../src/guestfs.pod:920
1925 msgid "MULTIPLE HANDLES AND MULTIPLE THREADS"
1929 #: ../src/guestfs.pod:922
1931 "All high-level libguestfs actions are synchronous. If you want to use "
1932 "libguestfs asynchronously then you must create a thread."
1936 #: ../src/guestfs.pod:925
1938 "Only use the handle from a single thread. Either use the handle exclusively "
1939 "from one thread, or provide your own mutex so that two threads cannot issue "
1940 "calls on the same handle at the same time."
1944 #: ../src/guestfs.pod:929
1946 "See the graphical program guestfs-browser for one possible architecture for "
1947 "multithreaded programs using libvirt and libguestfs."
1951 #: ../src/guestfs.pod:932
1956 #: ../src/guestfs.pod:934
1958 "Libguestfs needs a supermin appliance, which it finds by looking along an "
1963 #: ../src/guestfs.pod:937
1965 "By default it looks for these in the directory C<$libdir/guestfs> (eg. C</"
1966 "usr/local/lib/guestfs> or C</usr/lib64/guestfs>)."
1970 #: ../src/guestfs.pod:940
1972 "Use L</guestfs_set_path> or set the environment variable L</LIBGUESTFS_PATH> "
1973 "to change the directories that libguestfs will search in. The value is a "
1974 "colon-separated list of paths. The current directory is I<not> searched "
1975 "unless the path contains an empty element or C<.>. For example "
1976 "C<LIBGUESTFS_PATH=:/usr/lib/guestfs> would search the current directory and "
1977 "then C</usr/lib/guestfs>."
1981 #: ../src/guestfs.pod:947
1982 msgid "QEMU WRAPPERS"
1986 #: ../src/guestfs.pod:949
1988 "If you want to compile your own qemu, run qemu from a non-standard location, "
1989 "or pass extra arguments to qemu, then you can write a shell-script wrapper "
1994 #: ../src/guestfs.pod:953
1996 "There is one important rule to remember: you I<must C<exec qemu>> as the "
1997 "last command in the shell script (so that qemu replaces the shell and "
1998 "becomes the direct child of the libguestfs-using program). If you don't do "
1999 "this, then the qemu process won't be cleaned up correctly."
2003 #: ../src/guestfs.pod:958
2005 "Here is an example of a wrapper, where I have built my own copy of qemu from "
2010 #: ../src/guestfs.pod:961
2014 " qemudir=/home/rjones/d/qemu\n"
2015 " exec $qemudir/x86_64-softmmu/qemu-system-x86_64 -L $qemudir/pc-bios \"$@\"\n"
2020 #: ../src/guestfs.pod:965
2022 "Save this script as C</tmp/qemu.wrapper> (or wherever), C<chmod +x>, and "
2023 "then use it by setting the LIBGUESTFS_QEMU environment variable. For "
2028 #: ../src/guestfs.pod:969
2031 " LIBGUESTFS_QEMU=/tmp/qemu.wrapper guestfish\n"
2036 #: ../src/guestfs.pod:971
2038 "Note that libguestfs also calls qemu with the -help and -version options in "
2039 "order to determine features."
2043 #: ../src/guestfs.pod:974
2044 msgid "ATTACHING TO RUNNING DAEMONS"
2048 #: ../src/guestfs.pod:976
2050 "I<Note (1):> This is B<highly experimental> and has a tendency to eat "
2051 "babies. Use with caution."
2055 #: ../src/guestfs.pod:979
2057 "I<Note (2):> This section explains how to attach to a running daemon from a "
2058 "low level perspective. For most users, simply using virt tools such as "
2059 "L<guestfish(1)> with the I<--live> option will \"just work\"."
2063 #: ../src/guestfs.pod:983
2064 msgid "Using guestfs_set_attach_method"
2068 #: ../src/guestfs.pod:985
2070 "By calling L</guestfs_set_attach_method> you can change how the library "
2071 "connects to the C<guestfsd> daemon in L</guestfs_launch> (read L</"
2072 "ARCHITECTURE> for some background)."
2076 #: ../src/guestfs.pod:989
2078 "The normal attach method is C<appliance>, where a small appliance is created "
2079 "containing the daemon, and then the library connects to this."
2083 #: ../src/guestfs.pod:992
2085 "Setting attach method to C<unix:I<path>> (where I<path> is the path of a "
2086 "Unix domain socket) causes L</guestfs_launch> to connect to an existing "
2087 "daemon over the Unix domain socket."
2091 #: ../src/guestfs.pod:996
2093 "The normal use for this is to connect to a running virtual machine that "
2094 "contains a C<guestfsd> daemon, and send commands so you can read and write "
2095 "files inside the live virtual machine."
2099 #: ../src/guestfs.pod:1000
2100 msgid "Using guestfs_add_domain with live flag"
2104 #: ../src/guestfs.pod:1002
2106 "L</guestfs_add_domain> provides some help for getting the correct attach "
2107 "method. If you pass the C<live> option to this function, then (if the "
2108 "virtual machine is running) it will examine the libvirt XML looking for a "
2109 "virtio-serial channel to connect to:"
2113 #: ../src/guestfs.pod:1008
2120 " <channel type='unix'>\n"
2121 " <source mode='bind' path='/path/to/socket'/>\n"
2122 " <target type='virtio' name='org.libguestfs.channel.0'/>\n"
2131 #: ../src/guestfs.pod:1020
2133 "L</guestfs_add_domain> extracts C</path/to/socket> and sets the attach "
2134 "method to C<unix:/path/to/socket>."
2138 #: ../src/guestfs.pod:1023
2140 "Some of the libguestfs tools (including guestfish) support a I<--live> "
2141 "option which is passed through to L</guestfs_add_domain> thus allowing you "
2142 "to attach to and modify live virtual machines."
2146 #: ../src/guestfs.pod:1027
2148 "The virtual machine needs to have been set up beforehand so that it has the "
2149 "virtio-serial channel and so that guestfsd is running inside it."
2153 #: ../src/guestfs.pod:1031
2154 msgid "ABI GUARANTEE"
2158 #: ../src/guestfs.pod:1033
2160 "We guarantee the libguestfs ABI (binary interface), for public, high-level "
2161 "actions as outlined in this section. Although we will deprecate some "
2162 "actions, for example if they get replaced by newer calls, we will keep the "
2163 "old actions forever. This allows you the developer to program in confidence "
2164 "against the libguestfs API."
2168 #: ../src/guestfs.pod:1039
2169 msgid "BLOCK DEVICE NAMING"
2173 #: ../src/guestfs.pod:1041
2175 "In the kernel there is now quite a profusion of schemata for naming block "
2176 "devices (in this context, by I<block device> I mean a physical or virtual "
2177 "hard drive). The original Linux IDE driver used names starting with C</dev/"
2178 "hd*>. SCSI devices have historically used a different naming scheme, C</dev/"
2179 "sd*>. When the Linux kernel I<libata> driver became a popular replacement "
2180 "for the old IDE driver (particularly for SATA devices) those devices also "
2181 "used the C</dev/sd*> scheme. Additionally we now have virtual machines with "
2182 "paravirtualized drivers. This has created several different naming systems, "
2183 "such as C</dev/vd*> for virtio disks and C</dev/xvd*> for Xen PV disks."
2187 #: ../src/guestfs.pod:1053
2189 "As discussed above, libguestfs uses a qemu appliance running an embedded "
2190 "Linux kernel to access block devices. We can run a variety of appliances "
2191 "based on a variety of Linux kernels."
2195 #: ../src/guestfs.pod:1057
2197 "This causes a problem for libguestfs because many API calls use device or "
2198 "partition names. Working scripts and the recipe (example) scripts that we "
2199 "make available over the internet could fail if the naming scheme changes."
2203 #: ../src/guestfs.pod:1062
2205 "Therefore libguestfs defines C</dev/sd*> as the I<standard naming scheme>. "
2206 "Internally C</dev/sd*> names are translated, if necessary, to other names as "
2207 "required. For example, under RHEL 5 which uses the C</dev/hd*> scheme, any "
2208 "device parameter C</dev/sda2> is translated to C</dev/hda2> transparently."
2212 #: ../src/guestfs.pod:1068
2214 "Note that this I<only> applies to parameters. The L</guestfs_list_devices>, "
2215 "L</guestfs_list_partitions> and similar calls return the true names of the "
2216 "devices and partitions as known to the appliance."
2220 #: ../src/guestfs.pod:1073
2221 msgid "ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION"
2225 #: ../src/guestfs.pod:1075
2227 "Usually this translation is transparent. However in some (very rare) cases "
2228 "you may need to know the exact algorithm. Such cases include where you use "
2229 "L</guestfs_config> to add a mixture of virtio and IDE devices to the qemu-"
2230 "based appliance, so have a mixture of C</dev/sd*> and C</dev/vd*> devices."
2234 #: ../src/guestfs.pod:1081
2236 "The algorithm is applied only to I<parameters> which are known to be either "
2237 "device or partition names. Return values from functions such as L</"
2238 "guestfs_list_devices> are never changed."
2242 #: ../src/guestfs.pod:1089
2243 msgid "Is the string a parameter which is a device or partition name?"
2247 #: ../src/guestfs.pod:1093
2248 msgid "Does the string begin with C</dev/sd>?"
2252 #: ../src/guestfs.pod:1097
2254 "Does the named device exist? If so, we use that device. However if I<not> "
2255 "then we continue with this algorithm."
2259 #: ../src/guestfs.pod:1102
2260 msgid "Replace initial C</dev/sd> string with C</dev/hd>."
2264 #: ../src/guestfs.pod:1104
2265 msgid "For example, change C</dev/sda2> to C</dev/hda2>."
2269 #: ../src/guestfs.pod:1106
2270 msgid "If that named device exists, use it. If not, continue."
2274 #: ../src/guestfs.pod:1110
2275 msgid "Replace initial C</dev/sd> string with C</dev/vd>."
2279 #: ../src/guestfs.pod:1112
2280 msgid "If that named device exists, use it. If not, return an error."
2284 #: ../src/guestfs.pod:1116
2285 msgid "PORTABILITY CONCERNS WITH BLOCK DEVICE NAMING"
2289 #: ../src/guestfs.pod:1118
2291 "Although the standard naming scheme and automatic translation is useful for "
2292 "simple programs and guestfish scripts, for larger programs it is best not to "
2293 "rely on this mechanism."
2297 #: ../src/guestfs.pod:1122
2299 "Where possible for maximum future portability programs using libguestfs "
2300 "should use these future-proof techniques:"
2304 #: ../src/guestfs.pod:1129
2306 "Use L</guestfs_list_devices> or L</guestfs_list_partitions> to list actual "
2307 "device names, and then use those names directly."
2311 #: ../src/guestfs.pod:1132
2313 "Since those device names exist by definition, they will never be translated."
2317 #: ../src/guestfs.pod:1137
2319 "Use higher level ways to identify filesystems, such as LVM names, UUIDs and "
2320 "filesystem labels."
2324 #: ../src/guestfs.pod:1142
2329 #: ../src/guestfs.pod:1144
2331 "This section discusses security implications of using libguestfs, "
2332 "particularly with untrusted or malicious guests or disk images."
2336 #: ../src/guestfs.pod:1147
2337 msgid "GENERAL SECURITY CONSIDERATIONS"
2341 #: ../src/guestfs.pod:1149
2343 "Be careful with any files or data that you download from a guest (by "
2344 "\"download\" we mean not just the L</guestfs_download> command but any "
2345 "command that reads files, filenames, directories or anything else from a "
2346 "disk image). An attacker could manipulate the data to fool your program "
2347 "into doing the wrong thing. Consider cases such as:"
2351 #: ../src/guestfs.pod:1159
2352 msgid "the data (file etc) not being present"
2356 #: ../src/guestfs.pod:1163
2357 msgid "being present but empty"
2361 #: ../src/guestfs.pod:1167
2362 msgid "being much larger than normal"
2366 #: ../src/guestfs.pod:1171
2367 msgid "containing arbitrary 8 bit data"
2371 #: ../src/guestfs.pod:1175
2372 msgid "being in an unexpected character encoding"
2376 #: ../src/guestfs.pod:1179
2377 msgid "containing homoglyphs."
2381 #: ../src/guestfs.pod:1183
2382 msgid "SECURITY OF MOUNTING FILESYSTEMS"
2386 #: ../src/guestfs.pod:1185
2388 "When you mount a filesystem under Linux, mistakes in the kernel filesystem "
2389 "(VFS) module can sometimes be escalated into exploits by deliberately "
2390 "creating a malicious, malformed filesystem. These exploits are very severe "
2391 "for two reasons. Firstly there are very many filesystem drivers in the "
2392 "kernel, and many of them are infrequently used and not much developer "
2393 "attention has been paid to the code. Linux userspace helps potential "
2394 "crackers by detecting the filesystem type and automatically choosing the "
2395 "right VFS driver, even if that filesystem type is obscure or unexpected for "
2396 "the administrator. Secondly, a kernel-level exploit is like a local root "
2397 "exploit (worse in some ways), giving immediate and total access to the "
2398 "system right down to the hardware level."
2402 #: ../src/guestfs.pod:1198
2404 "That explains why you should never mount a filesystem from an untrusted "
2405 "guest on your host kernel. How about libguestfs? We run a Linux kernel "
2406 "inside a qemu virtual machine, usually running as a non-root user. The "
2407 "attacker would need to write a filesystem which first exploited the kernel, "
2408 "and then exploited either qemu virtualization (eg. a faulty qemu driver) or "
2409 "the libguestfs protocol, and finally to be as serious as the host kernel "
2410 "exploit it would need to escalate its privileges to root. This multi-step "
2411 "escalation, performed by a static piece of data, is thought to be extremely "
2412 "hard to do, although we never say 'never' about security issues."
2416 #: ../src/guestfs.pod:1209
2418 "In any case callers can reduce the attack surface by forcing the filesystem "
2419 "type when mounting (use L</guestfs_mount_vfs>)."
2423 #: ../src/guestfs.pod:1212
2424 msgid "PROTOCOL SECURITY"
2428 #: ../src/guestfs.pod:1214
2430 "The protocol is designed to be secure, being based on RFC 4506 (XDR) with a "
2431 "defined upper message size. However a program that uses libguestfs must "
2432 "also take care - for example you can write a program that downloads a binary "
2433 "from a disk image and executes it locally, and no amount of protocol "
2434 "security will save you from the consequences."
2438 #: ../src/guestfs.pod:1220
2439 msgid "INSPECTION SECURITY"
2443 #: ../src/guestfs.pod:1222
2445 "Parts of the inspection API (see L</INSPECTION>) return untrusted strings "
2446 "directly from the guest, and these could contain any 8 bit data. Callers "
2447 "should be careful to escape these before printing them to a structured file "
2448 "(for example, use HTML escaping if creating a web page)."
2452 #: ../src/guestfs.pod:1228
2454 "Guest configuration may be altered in unusual ways by the administrator of "
2455 "the virtual machine, and may not reflect reality (particularly for untrusted "
2456 "or actively malicious guests). For example we parse the hostname from "
2457 "configuration files like C</etc/sysconfig/network> that we find in the "
2458 "guest, but the guest administrator can easily manipulate these files to "
2459 "provide the wrong hostname."
2463 #: ../src/guestfs.pod:1236
2465 "The inspection API parses guest configuration using two external libraries: "
2466 "Augeas (Linux configuration) and hivex (Windows Registry). Both are "
2467 "designed to be robust in the face of malicious data, although denial of "
2468 "service attacks are still possible, for example with oversized configuration "
2473 #: ../src/guestfs.pod:1242
2474 msgid "RUNNING UNTRUSTED GUEST COMMANDS"
2478 #: ../src/guestfs.pod:1244
2480 "Be very cautious about running commands from the guest. By running a "
2481 "command in the guest, you are giving CPU time to a binary that you do not "
2482 "control, under the same user account as the library, albeit wrapped in qemu "
2483 "virtualization. More information and alternatives can be found in the "
2484 "section L</RUNNING COMMANDS>."
2488 #: ../src/guestfs.pod:1250
2489 msgid "CVE-2010-3851"
2490 msgstr "CVE-2010-3851"
2493 #: ../src/guestfs.pod:1252
2494 msgid "https://bugzilla.redhat.com/642934"
2495 msgstr "https://bugzilla.redhat.com/642934"
2498 #: ../src/guestfs.pod:1254
2500 "This security bug concerns the automatic disk format detection that qemu "
2501 "does on disk images."
2505 #: ../src/guestfs.pod:1257
2507 "A raw disk image is just the raw bytes, there is no header. Other disk "
2508 "images like qcow2 contain a special header. Qemu deals with this by looking "
2509 "for one of the known headers, and if none is found then assuming the disk "
2510 "image must be raw."
2514 #: ../src/guestfs.pod:1262
2516 "This allows a guest which has been given a raw disk image to write some "
2517 "other header. At next boot (or when the disk image is accessed by "
2518 "libguestfs) qemu would do autodetection and think the disk image format was, "
2519 "say, qcow2 based on the header written by the guest."
2523 #: ../src/guestfs.pod:1267
2525 "This in itself would not be a problem, but qcow2 offers many features, one "
2526 "of which is to allow a disk image to refer to another image (called the "
2527 "\"backing disk\"). It does this by placing the path to the backing disk "
2528 "into the qcow2 header. This path is not validated and could point to any "
2529 "host file (eg. \"/etc/passwd\"). The backing disk is then exposed through "
2530 "\"holes\" in the qcow2 disk image, which of course is completely under the "
2531 "control of the attacker."
2535 #: ../src/guestfs.pod:1275
2537 "In libguestfs this is rather hard to exploit except under two circumstances:"
2541 #: ../src/guestfs.pod:1282
2542 msgid "You have enabled the network or have opened the disk in write mode."
2546 #: ../src/guestfs.pod:1286
2548 "You are also running untrusted code from the guest (see L</RUNNING "
2553 #: ../src/guestfs.pod:1291
2555 "The way to avoid this is to specify the expected disk format when adding "
2556 "disks (the optional C<format> option to L</guestfs_add_drive_opts>). You "
2557 "should always do this if the disk is raw format, and it's a good idea for "
2562 #: ../src/guestfs.pod:1296
2564 "For disks added from libvirt using calls like L</guestfs_add_domain>, the "
2565 "format is fetched from libvirt and passed through."
2569 #: ../src/guestfs.pod:1299
2571 "For libguestfs tools, use the I<--format> command line parameter as "
2576 #: ../src/guestfs.pod:1302
2577 msgid "CONNECTION MANAGEMENT"
2581 #: ../src/guestfs.pod:1304
2586 #: ../src/guestfs.pod:1306
2588 "C<guestfs_h> is the opaque type representing a connection handle. Create a "
2589 "handle by calling L</guestfs_create>. Call L</guestfs_close> to free the "
2590 "handle and release all resources used."
2594 #: ../src/guestfs.pod:1310
2596 "For information on using multiple handles and threads, see the section L</"
2597 "MULTIPLE HANDLES AND MULTIPLE THREADS> below."
2601 #: ../src/guestfs.pod:1313
2602 msgid "guestfs_create"
2606 #: ../src/guestfs.pod:1315
2609 " guestfs_h *guestfs_create (void);\n"
2614 #: ../src/guestfs.pod:1317
2615 msgid "Create a connection handle."
2619 #: ../src/guestfs.pod:1319
2621 "You have to call L</guestfs_add_drive_opts> (or one of the equivalent calls) "
2622 "on the handle at least once."
2626 #: ../src/guestfs.pod:1322
2628 "This function returns a non-NULL pointer to a handle on success or NULL on "
2633 #: ../src/guestfs.pod:1325
2634 msgid "After configuring the handle, you have to call L</guestfs_launch>."
2638 #: ../src/guestfs.pod:1327
2640 "You may also want to configure error handling for the handle. See L</ERROR "
2641 "HANDLING> section below."
2645 #: ../src/guestfs.pod:1330
2646 msgid "guestfs_close"
2650 #: ../src/guestfs.pod:1332
2653 " void guestfs_close (guestfs_h *g);\n"
2658 #: ../src/guestfs.pod:1334
2659 msgid "This closes the connection handle and frees up all resources used."
2663 #: ../src/guestfs.pod:1336
2664 msgid "ERROR HANDLING"
2665 msgstr "ОБРОБКА ПОМИЛОК"
2668 #: ../src/guestfs.pod:1338
2670 "API functions can return errors. For example, almost all functions that "
2671 "return C<int> will return C<-1> to indicate an error."
2675 #: ../src/guestfs.pod:1341
2677 "Additional information is available for errors: an error message string and "
2678 "optionally an error number (errno) if the thing that failed was a system "
2683 #: ../src/guestfs.pod:1345
2685 "You can get at the additional information about the last error on the handle "
2686 "by calling L</guestfs_last_error>, L</guestfs_last_errno>, and/or by setting "
2687 "up an error handler with L</guestfs_set_error_handler>."
2691 #: ../src/guestfs.pod:1350
2693 "When the handle is created, a default error handler is installed which "
2694 "prints the error message string to C<stderr>. For small short-running "
2695 "command line programs it is sufficient to do:"
2699 #: ../src/guestfs.pod:1354
2702 " if (guestfs_launch (g) == -1)\n"
2703 " exit (EXIT_FAILURE);\n"
2708 #: ../src/guestfs.pod:1357
2710 "since the default error handler will ensure that an error message has been "
2711 "printed to C<stderr> before the program exits."
2715 #: ../src/guestfs.pod:1360
2717 "For other programs the caller will almost certainly want to install an "
2718 "alternate error handler or do error handling in-line like this:"
2722 #: ../src/guestfs.pod:1363
2725 " g = guestfs_create ();\n"
2730 #: ../src/guestfs.pod:1365
2733 " /* This disables the default behaviour of printing errors\n"
2735 " guestfs_set_error_handler (g, NULL, NULL);\n"
2740 #: ../src/guestfs.pod:1369
2743 " if (guestfs_launch (g) == -1) {\n"
2744 " /* Examine the error message and print it etc. */\n"
2745 " char *msg = guestfs_last_error (g);\n"
2746 " int errnum = guestfs_last_errno (g);\n"
2747 " fprintf (stderr, \"%s\\n\", msg);\n"
2754 #: ../src/guestfs.pod:1377
2756 "Out of memory errors are handled differently. The default action is to call "
2757 "L<abort(3)>. If this is undesirable, then you can set a handler using L</"
2758 "guestfs_set_out_of_memory_handler>."
2762 #: ../src/guestfs.pod:1381
2764 "L</guestfs_create> returns C<NULL> if the handle cannot be created, and "
2765 "because there is no handle if this happens there is no way to get additional "
2766 "error information. However L</guestfs_create> is supposed to be a "
2767 "lightweight operation which can only fail because of insufficient memory (it "
2768 "returns NULL in this case)."
2772 #: ../src/guestfs.pod:1387
2773 msgid "guestfs_last_error"
2777 #: ../src/guestfs.pod:1389
2780 " const char *guestfs_last_error (guestfs_h *g);\n"
2785 #: ../src/guestfs.pod:1391
2787 "This returns the last error message that happened on C<g>. If there has not "
2788 "been an error since the handle was created, then this returns C<NULL>."
2792 #: ../src/guestfs.pod:1395
2794 "The lifetime of the returned string is until the next error occurs, or L</"
2795 "guestfs_close> is called."
2799 #: ../src/guestfs.pod:1398
2800 msgid "guestfs_last_errno"
2804 #: ../src/guestfs.pod:1400
2807 " int guestfs_last_errno (guestfs_h *g);\n"
2812 #: ../src/guestfs.pod:1402
2813 msgid "This returns the last error number (errno) that happened on C<g>."
2817 #: ../src/guestfs.pod:1404
2818 msgid "If successful, an errno integer not equal to zero is returned."
2822 #: ../src/guestfs.pod:1406
2824 "If no error, this returns 0. This call can return 0 in three situations:"
2828 #: ../src/guestfs.pod:1413
2829 msgid "There has not been any error on the handle."
2833 #: ../src/guestfs.pod:1417
2835 "There has been an error but the errno was meaningless. This corresponds to "
2836 "the case where the error did not come from a failed system call, but for "
2837 "some other reason."
2841 #: ../src/guestfs.pod:1423
2843 "There was an error from a failed system call, but for some reason the errno "
2844 "was not captured and returned. This usually indicates a bug in libguestfs."
2848 #: ../src/guestfs.pod:1429
2850 "Libguestfs tries to convert the errno from inside the applicance into a "
2851 "corresponding errno for the caller (not entirely trivial: the appliance "
2852 "might be running a completely different operating system from the library "
2853 "and error numbers are not standardized across Un*xen). If this could not be "
2854 "done, then the error is translated to C<EINVAL>. In practice this should "
2855 "only happen in very rare circumstances."
2859 #: ../src/guestfs.pod:1437
2860 msgid "guestfs_set_error_handler"
2864 #: ../src/guestfs.pod:1439
2867 " typedef void (*guestfs_error_handler_cb) (guestfs_h *g,\n"
2869 " const char *msg);\n"
2870 " void guestfs_set_error_handler (guestfs_h *g,\n"
2871 " guestfs_error_handler_cb cb,\n"
2877 #: ../src/guestfs.pod:1446
2879 "The callback C<cb> will be called if there is an error. The parameters "
2880 "passed to the callback are an opaque data pointer and the error message "
2885 #: ../src/guestfs.pod:1450
2887 "C<errno> is not passed to the callback. To get that the callback must call "
2888 "L</guestfs_last_errno>."
2892 #: ../src/guestfs.pod:1453
2894 "Note that the message string C<msg> is freed as soon as the callback "
2895 "function returns, so if you want to stash it somewhere you must make your "
2900 #: ../src/guestfs.pod:1457
2901 msgid "The default handler prints messages on C<stderr>."
2905 #: ../src/guestfs.pod:1459
2906 msgid "If you set C<cb> to C<NULL> then I<no> handler is called."
2910 #: ../src/guestfs.pod:1461
2911 msgid "guestfs_get_error_handler"
2915 #: ../src/guestfs.pod:1463
2918 " guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g,\n"
2919 " void **opaque_rtn);\n"
2924 #: ../src/guestfs.pod:1466
2925 msgid "Returns the current error handler callback."
2929 #: ../src/guestfs.pod:1468
2930 msgid "guestfs_set_out_of_memory_handler"
2934 #: ../src/guestfs.pod:1470
2937 " typedef void (*guestfs_abort_cb) (void);\n"
2938 " int guestfs_set_out_of_memory_handler (guestfs_h *g,\n"
2939 " guestfs_abort_cb);\n"
2944 #: ../src/guestfs.pod:1474
2946 "The callback C<cb> will be called if there is an out of memory situation. "
2947 "I<Note this callback must not return>."
2951 #: ../src/guestfs.pod:1477
2952 msgid "The default is to call L<abort(3)>."
2956 #: ../src/guestfs.pod:1479
2958 "You cannot set C<cb> to C<NULL>. You can't ignore out of memory situations."
2962 #: ../src/guestfs.pod:1482
2963 msgid "guestfs_get_out_of_memory_handler"
2967 #: ../src/guestfs.pod:1484
2970 " guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n"
2975 #: ../src/guestfs.pod:1486
2976 msgid "This returns the current out of memory handler."
2980 #: ../src/guestfs.pod:1488
2985 #: ../src/guestfs.pod:1490 ../fish/guestfish.pod:1008
2990 #: ../src/guestfs.pod:1492
2995 #: ../src/guestfs.pod:1494
3000 #: ../src/guestfs.pod:1496
3001 msgid "AVAILABILITY"
3005 #: ../src/guestfs.pod:1498
3006 msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE"
3010 #: ../src/guestfs.pod:1500
3012 "Using L</guestfs_available> you can test availability of the following "
3013 "groups of functions. This test queries the appliance to see if the "
3014 "appliance you are currently using supports the functionality."
3018 #: ../src/guestfs.pod:1505
3019 msgid "@AVAILABILITY@"
3023 #: ../src/guestfs.pod:1507
3024 msgid "GUESTFISH supported COMMAND"
3028 #: ../src/guestfs.pod:1509
3030 "In L<guestfish(3)> there is a handy interactive command C<supported> which "
3031 "prints out the available groups and whether they are supported by this build "
3032 "of libguestfs. Note however that you have to do C<run> first."
3036 #: ../src/guestfs.pod:1514
3037 msgid "SINGLE CALLS AT COMPILE TIME"
3041 #: ../src/guestfs.pod:1516
3043 "Since version 1.5.8, C<E<lt>guestfs.hE<gt>> defines symbols for each C API "
3044 "function, such as:"
3048 #: ../src/guestfs.pod:1519
3051 " #define LIBGUESTFS_HAVE_DD 1\n"
3056 #: ../src/guestfs.pod:1521
3057 msgid "if L</guestfs_dd> is available."
3061 #: ../src/guestfs.pod:1523
3063 "Before version 1.5.8, if you needed to test whether a single libguestfs "
3064 "function is available at compile time, we recommended using build tools such "
3065 "as autoconf or cmake. For example in autotools you could use:"
3069 #: ../src/guestfs.pod:1528
3072 " AC_CHECK_LIB([guestfs],[guestfs_create])\n"
3073 " AC_CHECK_FUNCS([guestfs_dd])\n"
3078 #: ../src/guestfs.pod:1531
3080 "which would result in C<HAVE_GUESTFS_DD> being either defined or not defined "
3085 #: ../src/guestfs.pod:1534
3086 msgid "SINGLE CALLS AT RUN TIME"
3090 #: ../src/guestfs.pod:1536
3092 "Testing at compile time doesn't guarantee that a function really exists in "
3093 "the library. The reason is that you might be dynamically linked against a "
3094 "previous I<libguestfs.so> (dynamic library) which doesn't have the call. "
3095 "This situation unfortunately results in a segmentation fault, which is a "
3096 "shortcoming of the C dynamic linking system itself."
3100 #: ../src/guestfs.pod:1543
3102 "You can use L<dlopen(3)> to test if a function is available at run time, as "
3103 "in this example program (note that you still need the compile time check as "
3108 #: ../src/guestfs.pod:1547
3111 " #include <stdio.h>\n"
3112 " #include <stdlib.h>\n"
3113 " #include <unistd.h>\n"
3114 " #include <dlfcn.h>\n"
3115 " #include <guestfs.h>\n"
3120 #: ../src/guestfs.pod:1553
3125 " #ifdef LIBGUESTFS_HAVE_DD\n"
3127 " int has_function;\n"
3132 #: ../src/guestfs.pod:1559
3135 " /* Test if the function guestfs_dd is really available. */\n"
3136 " dl = dlopen (NULL, RTLD_LAZY);\n"
3138 " fprintf (stderr, \"dlopen: %s\\n\", dlerror ());\n"
3139 " exit (EXIT_FAILURE);\n"
3141 " has_function = dlsym (dl, \"guestfs_dd\") != NULL;\n"
3147 #: ../src/guestfs.pod:1568
3150 " if (!has_function)\n"
3151 " printf (\"this libguestfs.so does NOT have guestfs_dd function\\n\");\n"
3153 " printf (\"this libguestfs.so has guestfs_dd function\\n\");\n"
3154 " /* Now it's safe to call\n"
3155 " guestfs_dd (g, \"foo\", \"bar\");\n"
3159 " printf (\"guestfs_dd function was not found at compile time\\n\");\n"
3166 #: ../src/guestfs.pod:1581
3168 "You may think the above is an awful lot of hassle, and it is. There are "
3169 "other ways outside of the C linking system to ensure that this kind of "
3170 "incompatibility never arises, such as using package versioning:"
3174 #: ../src/guestfs.pod:1586
3177 " Requires: libguestfs >= 1.0.80\n"
3182 #: ../src/guestfs.pod:1588
3183 msgid "CALLS WITH OPTIONAL ARGUMENTS"
3187 #: ../src/guestfs.pod:1590
3189 "A recent feature of the API is the introduction of calls which take optional "
3190 "arguments. In C these are declared 3 ways. The main way is as a call which "
3191 "takes variable arguments (ie. C<...>), as in this example:"
3195 #: ../src/guestfs.pod:1595
3198 " int guestfs_add_drive_opts (guestfs_h *g, const char *filename, ...);\n"
3203 #: ../src/guestfs.pod:1597
3205 "Call this with a list of optional arguments, terminated by C<-1>. So to "
3206 "call with no optional arguments specified:"
3210 #: ../src/guestfs.pod:1600
3213 " guestfs_add_drive_opts (g, filename, -1);\n"
3218 #: ../src/guestfs.pod:1602
3219 msgid "With a single optional argument:"
3223 #: ../src/guestfs.pod:1604
3226 " guestfs_add_drive_opts (g, filename,\n"
3227 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
3233 #: ../src/guestfs.pod:1608
3238 #: ../src/guestfs.pod:1610
3241 " guestfs_add_drive_opts (g, filename,\n"
3242 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
3243 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
3249 #: ../src/guestfs.pod:1615
3251 "and so forth. Don't forget the terminating C<-1> otherwise Bad Things will "
3256 #: ../src/guestfs.pod:1618
3257 msgid "USING va_list FOR OPTIONAL ARGUMENTS"
3261 #: ../src/guestfs.pod:1620
3263 "The second variant has the same name with the suffix C<_va>, which works the "
3264 "same way but takes a C<va_list>. See the C manual for details. For the "
3265 "example function, this is declared:"
3269 #: ../src/guestfs.pod:1624
3272 " int guestfs_add_drive_opts_va (guestfs_h *g, const char *filename,\n"
3278 #: ../src/guestfs.pod:1627
3279 msgid "CONSTRUCTING OPTIONAL ARGUMENTS"
3283 #: ../src/guestfs.pod:1629
3285 "The third variant is useful where you need to construct these calls. You "
3286 "pass in a structure where you fill in the optional fields. The structure "
3287 "has a bitmask as the first element which you must set to indicate which "
3288 "fields you have filled in. For our example function the structure and call "
3293 #: ../src/guestfs.pod:1635
3296 " struct guestfs_add_drive_opts_argv {\n"
3297 " uint64_t bitmask;\n"
3299 " const char *format;\n"
3302 " int guestfs_add_drive_opts_argv (guestfs_h *g, const char *filename,\n"
3303 " const struct guestfs_add_drive_opts_argv *optargs);\n"
3308 #: ../src/guestfs.pod:1644
3309 msgid "You could call it like this:"
3313 #: ../src/guestfs.pod:1646
3316 " struct guestfs_add_drive_opts_argv optargs = {\n"
3317 " .bitmask = GUESTFS_ADD_DRIVE_OPTS_READONLY_BITMASK |\n"
3318 " GUESTFS_ADD_DRIVE_OPTS_FORMAT_BITMASK,\n"
3320 " .format = \"qcow2\"\n"
3326 #: ../src/guestfs.pod:1653
3329 " guestfs_add_drive_opts_argv (g, filename, &optargs);\n"
3334 #: ../src/guestfs.pod:1655 ../src/guestfs-actions.pod:11
3335 #: ../src/guestfs-actions.pod:1855 ../fish/guestfish-actions.pod:9
3336 #: ../fish/guestfish-actions.pod:1260 ../tools/virt-win-reg.pl:532
3341 #: ../src/guestfs.pod:1661
3342 msgid "The C<_BITMASK> suffix on each option name when specifying the bitmask."
3346 #: ../src/guestfs.pod:1666
3347 msgid "You do not need to fill in all fields of the structure."
3351 #: ../src/guestfs.pod:1670
3353 "There must be a one-to-one correspondence between fields of the structure "
3354 "that are filled in, and bits set in the bitmask."
3358 #: ../src/guestfs.pod:1675
3359 msgid "OPTIONAL ARGUMENTS IN OTHER LANGUAGES"
3363 #: ../src/guestfs.pod:1677
3365 "In other languages, optional arguments are expressed in the way that is "
3366 "natural for that language. We refer you to the language-specific "
3367 "documentation for more details on that."
3371 #: ../src/guestfs.pod:1681
3372 msgid "For guestfish, see L<guestfish(1)/OPTIONAL ARGUMENTS>."
3376 #: ../src/guestfs.pod:1683
3377 msgid "SETTING CALLBACKS TO HANDLE EVENTS"
3381 #: ../src/guestfs.pod:1685
3383 "B<Note:> This section documents the generic event mechanism introduced in "
3384 "libguestfs 1.10, which you should use in new code if possible. The old "
3385 "functions C<guestfs_set_log_message_callback>, "
3386 "C<guestfs_set_subprocess_quit_callback>, "
3387 "C<guestfs_set_launch_done_callback>, C<guestfs_set_close_callback> and "
3388 "C<guestfs_set_progress_callback> are no longer documented in this manual "
3393 #: ../src/guestfs.pod:1693
3395 "Handles generate events when certain things happen, such as log messages "
3396 "being generated, progress messages during long-running operations, or the "
3397 "handle being closed. The API calls described below let you register a "
3398 "callback to be called when events happen. You can register multiple "
3399 "callbacks (for the same, different or overlapping sets of events), and "
3400 "individually remove callbacks. If callbacks are not removed, then they "
3401 "remain in force until the handle is closed."
3405 #: ../src/guestfs.pod:1701
3407 "In the current implementation, events are only generated synchronously: that "
3408 "means that events (and hence callbacks) can only happen while you are in the "
3409 "middle of making another libguestfs call. The callback is called in the "
3414 #: ../src/guestfs.pod:1706
3416 "Events may contain a payload, usually nothing (void), an array of 64 bit "
3417 "unsigned integers, or a message buffer. Payloads are discussed later on."
3421 #: ../src/guestfs.pod:1710
3422 msgid "CLASSES OF EVENTS"
3426 #: ../src/guestfs.pod:1714
3427 msgid "GUESTFS_EVENT_CLOSE (payload type: void)"
3431 #: ../src/guestfs.pod:1717
3433 "The callback function will be called while the handle is being closed "
3434 "(synchronously from L</guestfs_close>)."
3438 #: ../src/guestfs.pod:1720
3440 "Note that libguestfs installs an L<atexit(3)> handler to try to clean up "
3441 "handles that are open when the program exits. This means that this callback "
3442 "might be called indirectly from L<exit(3)>, which can cause unexpected "
3443 "problems in higher-level languages (eg. if your HLL interpreter has already "
3444 "been cleaned up by the time this is called, and if your callback then jumps "
3445 "into some HLL function)."
3449 #: ../src/guestfs.pod:1727
3451 "If no callback is registered: the handle is closed without any callback "
3456 #: ../src/guestfs.pod:1730
3457 msgid "GUESTFS_EVENT_SUBPROCESS_QUIT (payload type: void)"
3461 #: ../src/guestfs.pod:1733
3463 "The callback function will be called when the child process quits, either "
3464 "asynchronously or if killed by L</guestfs_kill_subprocess>. (This "
3465 "corresponds to a transition from any state to the CONFIG state)."
3469 #: ../src/guestfs.pod:1737 ../src/guestfs.pod:1746
3470 msgid "If no callback is registered: the event is ignored."
3474 #: ../src/guestfs.pod:1739
3475 msgid "GUESTFS_EVENT_LAUNCH_DONE (payload type: void)"
3479 #: ../src/guestfs.pod:1742
3481 "The callback function will be called when the child process becomes ready "
3482 "first time after it has been launched. (This corresponds to a transition "
3483 "from LAUNCHING to the READY state)."
3487 #: ../src/guestfs.pod:1748
3488 msgid "GUESTFS_EVENT_PROGRESS (payload type: array of 4 x uint64_t)"
3492 #: ../src/guestfs.pod:1751
3494 "Some long-running operations can generate progress messages. If this "
3495 "callback is registered, then it will be called each time a progress message "
3496 "is generated (usually two seconds after the operation started, and three "
3497 "times per second thereafter until it completes, although the frequency may "
3498 "change in future versions)."
3502 #: ../src/guestfs.pod:1757
3504 "The callback receives in the payload four unsigned 64 bit numbers which are "
3505 "(in order): C<proc_nr>, C<serial>, C<position>, C<total>."
3509 #: ../src/guestfs.pod:1760
3511 "The units of C<total> are not defined, although for some operations C<total> "
3512 "may relate in some way to the amount of data to be transferred (eg. in bytes "
3513 "or megabytes), and C<position> may be the portion which has been transferred."
3517 #: ../src/guestfs.pod:1765
3518 msgid "The only defined and stable parts of the API are:"
3522 #: ../src/guestfs.pod:1771
3524 "The callback can display to the user some type of progress bar or indicator "
3525 "which shows the ratio of C<position>:C<total>."
3529 #: ../src/guestfs.pod:1776
3530 msgid "0 E<lt>= C<position> E<lt>= C<total>"
3534 #: ../src/guestfs.pod:1780
3536 "If any progress notification is sent during a call, then a final progress "
3537 "notification is always sent when C<position> = C<total> (I<unless> the call "
3538 "fails with an error)."
3542 #: ../src/guestfs.pod:1784
3544 "This is to simplify caller code, so callers can easily set the progress "
3545 "indicator to \"100%\" at the end of the operation, without requiring special "
3546 "code to detect this case."
3550 #: ../src/guestfs.pod:1790
3552 "For some calls we are unable to estimate the progress of the call, but we "
3553 "can still generate progress messages to indicate activity. This is known as "
3554 "\"pulse mode\", and is directly supported by certain progress bar "
3555 "implementations (eg. GtkProgressBar)."
3559 #: ../src/guestfs.pod:1795
3561 "For these calls, zero or more progress messages are generated with "
3562 "C<position = 0> and C<total = 1>, followed by a final message with "
3563 "C<position = total = 1>."
3567 #: ../src/guestfs.pod:1799
3569 "As noted above, if the call fails with an error then the final message may "
3574 #: ../src/guestfs.pod:1804
3576 "The callback also receives the procedure number (C<proc_nr>) and serial "
3577 "number (C<serial>) of the call. These are only useful for debugging "
3578 "protocol issues, and the callback can normally ignore them. The callback "
3579 "may want to print these numbers in error messages or debugging messages."
3583 #: ../src/guestfs.pod:1810
3584 msgid "If no callback is registered: progress messages are discarded."
3588 #: ../src/guestfs.pod:1812
3589 msgid "GUESTFS_EVENT_APPLIANCE (payload type: message buffer)"
3593 #: ../src/guestfs.pod:1815
3595 "The callback function is called whenever a log message is generated by qemu, "
3596 "the appliance kernel, guestfsd (daemon), or utility programs."
3600 #: ../src/guestfs.pod:1818
3602 "If the verbose flag (L</guestfs_set_verbose>) is set before launch (L</"
3603 "guestfs_launch>) then additional debug messages are generated."
3607 #: ../src/guestfs.pod:1821 ../src/guestfs.pod:1835
3609 "If no callback is registered: the messages are discarded unless the verbose "
3610 "flag is set in which case they are sent to stderr. You can override the "
3611 "printing of verbose messages to stderr by setting up a callback."
3615 #: ../src/guestfs.pod:1826
3616 msgid "GUESTFS_EVENT_LIBRARY (payload type: message buffer)"
3620 #: ../src/guestfs.pod:1829
3622 "The callback function is called whenever a log message is generated by the "
3623 "library part of libguestfs."
3627 #: ../src/guestfs.pod:1832
3629 "If the verbose flag (L</guestfs_set_verbose>) is set then additional debug "
3630 "messages are generated."
3634 #: ../src/guestfs.pod:1840
3635 msgid "GUESTFS_EVENT_TRACE (payload type: message buffer)"
3639 #: ../src/guestfs.pod:1843
3641 "The callback function is called whenever a trace message is generated. This "
3642 "only applies if the trace flag (L</guestfs_set_trace>) is set."
3646 #: ../src/guestfs.pod:1846
3648 "If no callback is registered: the messages are sent to stderr. You can "
3649 "override the printing of trace messages to stderr by setting up a callback."
3653 #: ../src/guestfs.pod:1852
3654 msgid "guestfs_set_event_callback"
3658 #: ../src/guestfs.pod:1854
3661 " int guestfs_set_event_callback (guestfs_h *g,\n"
3662 " guestfs_event_callback cb,\n"
3663 " uint64_t event_bitmask,\n"
3670 #: ../src/guestfs.pod:1860
3672 "This function registers a callback (C<cb>) for all event classes in the "
3677 #: ../src/guestfs.pod:1863
3679 "For example, to register for all log message events, you could call this "
3680 "function with the bitmask C<GUESTFS_EVENT_APPLIANCE|GUESTFS_EVENT_LIBRARY>. "
3681 "To register a single callback for all possible classes of events, use "
3682 "C<GUESTFS_EVENT_ALL>."
3686 #: ../src/guestfs.pod:1869
3687 msgid "C<flags> should always be passed as 0."
3691 #: ../src/guestfs.pod:1871
3693 "C<opaque> is an opaque pointer which is passed to the callback. You can use "
3694 "it for any purpose."
3698 #: ../src/guestfs.pod:1874
3700 "The return value is the event handle (an integer) which you can use to "
3701 "delete the callback (see below)."
3705 #: ../src/guestfs.pod:1877
3707 "If there is an error, this function returns C<-1>, and sets the error in the "
3708 "handle in the usual way (see L</guestfs_last_error> etc.)"
3712 #: ../src/guestfs.pod:1880
3714 "Callbacks remain in effect until they are deleted, or until the handle is "
3719 #: ../src/guestfs.pod:1883
3721 "In the case where multiple callbacks are registered for a particular event "
3722 "class, all of the callbacks are called. The order in which multiple "
3723 "callbacks are called is not defined."
3727 #: ../src/guestfs.pod:1887
3728 msgid "guestfs_delete_event_callback"
3732 #: ../src/guestfs.pod:1889
3735 " void guestfs_delete_event_callback (guestfs_h *g, int event_handle);\n"
3740 #: ../src/guestfs.pod:1891
3742 "Delete a callback that was previously registered. C<event_handle> should be "
3743 "the integer that was returned by a previous call to "
3744 "C<guestfs_set_event_callback> on the same handle."
3748 #: ../src/guestfs.pod:1895
3749 msgid "guestfs_event_callback"
3753 #: ../src/guestfs.pod:1897
3756 " typedef void (*guestfs_event_callback) (\n"
3759 " uint64_t event,\n"
3760 " int event_handle,\n"
3762 " const char *buf, size_t buf_len,\n"
3763 " const uint64_t *array, size_t array_len);\n"
3768 #: ../src/guestfs.pod:1906
3770 "This is the type of the event callback function that you have to provide."
3774 #: ../src/guestfs.pod:1909
3776 "The basic parameters are: the handle (C<g>), the opaque user pointer "
3777 "(C<opaque>), the event class (eg. C<GUESTFS_EVENT_PROGRESS>), the event "
3778 "handle, and C<flags> which in the current API you should ignore."
3782 #: ../src/guestfs.pod:1913
3784 "The remaining parameters contain the event payload (if any). Each event may "
3785 "contain a payload, which usually relates to the event class, but for future "
3786 "proofing your code should be written to handle any payload for any event "
3791 #: ../src/guestfs.pod:1918
3793 "C<buf> and C<buf_len> contain a message buffer (if C<buf_len == 0>, then "
3794 "there is no message buffer). Note that this message buffer can contain "
3795 "arbitrary 8 bit data, including NUL bytes."
3799 #: ../src/guestfs.pod:1922
3801 "C<array> and C<array_len> is an array of 64 bit unsigned integers. At the "
3802 "moment this is only used for progress messages."
3806 #: ../src/guestfs.pod:1925
3807 msgid "EXAMPLE: CAPTURING LOG MESSAGES"
3811 #: ../src/guestfs.pod:1927
3813 "One motivation for the generic event API was to allow GUI programs to "
3814 "capture debug and other messages. In libguestfs E<le> 1.8 these were sent "
3815 "unconditionally to C<stderr>."
3819 #: ../src/guestfs.pod:1931
3821 "Events associated with log messages are: C<GUESTFS_EVENT_LIBRARY>, "
3822 "C<GUESTFS_EVENT_APPLIANCE> and C<GUESTFS_EVENT_TRACE>. (Note that error "
3823 "messages are not events; you must capture error messages separately)."
3827 #: ../src/guestfs.pod:1936
3829 "Programs have to set up a callback to capture the classes of events of "
3834 #: ../src/guestfs.pod:1939
3838 " guestfs_set_event_callback\n"
3839 " (g, message_callback,\n"
3840 " GUESTFS_EVENT_LIBRARY|GUESTFS_EVENT_APPLIANCE|\n"
3841 " GUESTFS_EVENT_TRACE,\n"
3842 " 0, NULL) == -1)\n"
3843 " if (eh == -1) {\n"
3844 " // handle error in the usual way\n"
3850 #: ../src/guestfs.pod:1949
3852 "The callback can then direct messages to the appropriate place. In this "
3853 "example, messages are directed to syslog:"
3857 #: ../src/guestfs.pod:1952
3861 " message_callback (\n"
3864 " uint64_t event,\n"
3865 " int event_handle,\n"
3867 " const char *buf, size_t buf_len,\n"
3868 " const uint64_t *array, size_t array_len)\n"
3870 " const int priority = LOG_USER|LOG_INFO;\n"
3871 " if (buf_len > 0)\n"
3872 " syslog (priority, \"event 0x%lx: %s\", event, buf);\n"
3878 #: ../src/guestfs.pod:1967
3879 msgid "PRIVATE DATA AREA"
3883 #: ../src/guestfs.pod:1969
3885 "You can attach named pieces of private data to the libguestfs handle, fetch "
3886 "them by name, and walk over them, for the lifetime of the handle. This is "
3887 "called the private data area and is only available from the C API."
3891 #: ../src/guestfs.pod:1974
3892 msgid "To attach a named piece of data, use the following call:"
3896 #: ../src/guestfs.pod:1976
3899 " void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n"
3904 #: ../src/guestfs.pod:1978
3906 "C<key> is the name to associate with this data, and C<data> is an arbitrary "
3907 "pointer (which can be C<NULL>). Any previous item with the same name is "
3912 #: ../src/guestfs.pod:1982
3914 "You can use any C<key> you want, but names beginning with an underscore "
3915 "character are reserved for internal libguestfs purposes (for implementing "
3916 "language bindings). It is recommended to prefix the name with some unique "
3917 "string to avoid collisions with other users."
3921 #: ../src/guestfs.pod:1987
3922 msgid "To retrieve the pointer, use:"
3926 #: ../src/guestfs.pod:1989
3929 " void *guestfs_get_private (guestfs_h *g, const char *key);\n"
3934 #: ../src/guestfs.pod:1991
3936 "This function returns C<NULL> if either no data is found associated with "
3937 "C<key>, or if the user previously set the C<key>'s C<data> pointer to "
3942 #: ../src/guestfs.pod:1995
3944 "Libguestfs does not try to look at or interpret the C<data> pointer in any "
3945 "way. As far as libguestfs is concerned, it need not be a valid pointer at "
3946 "all. In particular, libguestfs does I<not> try to free the data when the "
3947 "handle is closed. If the data must be freed, then the caller must either "
3948 "free it before calling L</guestfs_close> or must set up a close callback to "
3949 "do it (see L</GUESTFS_EVENT_CLOSE>)."
3953 #: ../src/guestfs.pod:2002
3954 msgid "To walk over all entries, use these two functions:"
3958 #: ../src/guestfs.pod:2004
3961 " void *guestfs_first_private (guestfs_h *g, const char **key_rtn);\n"
3966 #: ../src/guestfs.pod:2006
3969 " void *guestfs_next_private (guestfs_h *g, const char **key_rtn);\n"
3974 #: ../src/guestfs.pod:2008
3976 "C<guestfs_first_private> returns the first key, pointer pair (\"first\" does "
3977 "not have any particular meaning -- keys are not returned in any defined "
3978 "order). A pointer to the key is returned in C<*key_rtn> and the "
3979 "corresponding data pointer is returned from the function. C<NULL> is "
3980 "returned if there are no keys stored in the handle."
3984 #: ../src/guestfs.pod:2014
3986 "C<guestfs_next_private> returns the next key, pointer pair. The return "
3987 "value of this function is also C<NULL> is there are no further entries to "
3992 #: ../src/guestfs.pod:2018
3993 msgid "Notes about walking over entries:"
3997 #: ../src/guestfs.pod:2024
3999 "You must not call C<guestfs_set_private> while walking over the entries."
4003 #: ../src/guestfs.pod:2029
4005 "The handle maintains an internal iterator which is reset when you call "
4006 "C<guestfs_first_private>. This internal iterator is invalidated when you "
4007 "call C<guestfs_set_private>."
4011 #: ../src/guestfs.pod:2035
4012 msgid "If you have set the data pointer associated with a key to C<NULL>, ie:"
4016 #: ../src/guestfs.pod:2037
4019 " guestfs_set_private (g, key, NULL);\n"
4024 #: ../src/guestfs.pod:2039
4025 msgid "then that C<key> is not returned when walking."
4029 #: ../src/guestfs.pod:2043
4031 "C<*key_rtn> is only valid until the next call to C<guestfs_first_private>, "
4032 "C<guestfs_next_private> or C<guestfs_set_private>."
4036 #: ../src/guestfs.pod:2049
4038 "The following example code shows how to print all keys and data pointers "
4039 "that are associated with the handle C<g>:"
4043 #: ../src/guestfs.pod:2052
4046 " const char *key;\n"
4047 " void *data = guestfs_first_private (g, &key);\n"
4048 " while (data != NULL)\n"
4050 " printf (\"key = %s, data = %p\\n\", key, data);\n"
4051 " data = guestfs_next_private (g, &key);\n"
4057 #: ../src/guestfs.pod:2060
4059 "More commonly you are only interested in keys that begin with an application-"
4060 "specific prefix C<foo_>. Modify the loop like so:"
4064 #: ../src/guestfs.pod:2063
4067 " const char *key;\n"
4068 " void *data = guestfs_first_private (g, &key);\n"
4069 " while (data != NULL)\n"
4071 " if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
4072 " printf (\"key = %s, data = %p\\n\", key, data);\n"
4073 " data = guestfs_next_private (g, &key);\n"
4079 #: ../src/guestfs.pod:2072
4081 "If you need to modify keys while walking, then you have to jump back to the "
4082 "beginning of the loop. For example, to delete all keys prefixed with "
4087 #: ../src/guestfs.pod:2076
4090 " const char *key;\n"
4093 " data = guestfs_first_private (g, &key);\n"
4094 " while (data != NULL)\n"
4096 " if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
4098 " guestfs_set_private (g, key, NULL);\n"
4099 " /* note that 'key' pointer is now invalid, and so is\n"
4100 " the internal iterator */\n"
4103 " data = guestfs_next_private (g, &key);\n"
4109 #: ../src/guestfs.pod:2092
4111 "Note that the above loop is guaranteed to terminate because the keys are "
4112 "being deleted, but other manipulations of keys within the loop might not "
4113 "terminate unless you also maintain an indication of which keys have been "
4118 #: ../src/guestfs.pod:2097 ../src/guestfs.pod:2102
4123 #: ../src/guestfs.pod:2099
4125 "<!-- old anchor for the next section --> <a name="
4126 "\"state_machine_and_low_level_event_api\"/>"
4128 "<!-- old anchor for the next section --> <a name="
4129 "\"state_machine_and_low_level_event_api\"/>"
4132 #: ../src/guestfs.pod:2104
4133 msgid "ARCHITECTURE"
4134 msgstr "АРХІТЕКТУРА"
4137 #: ../src/guestfs.pod:2106
4139 "Internally, libguestfs is implemented by running an appliance (a special "
4140 "type of small virtual machine) using L<qemu(1)>. Qemu runs as a child "
4141 "process of the main program."
4145 #: ../src/guestfs.pod:2110
4148 " ___________________\n"
4150 " | main program |\n"
4152 " | | child process / appliance\n"
4153 " | | __________________________\n"
4155 " +-------------------+ RPC | +-----------------+ |\n"
4156 " | libguestfs <--------------------> guestfsd | |\n"
4157 " | | | +-----------------+ |\n"
4158 " \\___________________/ | | Linux kernel | |\n"
4159 " | +--^--------------+ |\n"
4160 " \\_________|________________/\n"
4166 " \\______________/\n"
4171 #: ../src/guestfs.pod:2130
4173 "The library, linked to the main program, creates the child process and hence "
4174 "the appliance in the L</guestfs_launch> function."
4178 #: ../src/guestfs.pod:2133
4180 "Inside the appliance is a Linux kernel and a complete stack of userspace "
4181 "tools (such as LVM and ext2 programs) and a small controlling daemon called "
4182 "L</guestfsd>. The library talks to L</guestfsd> using remote procedure "
4183 "calls (RPC). There is a mostly one-to-one correspondence between libguestfs "
4184 "API calls and RPC calls to the daemon. Lastly the disk image(s) are "
4185 "attached to the qemu process which translates device access by the "
4186 "appliance's Linux kernel into accesses to the image."
4190 #: ../src/guestfs.pod:2142
4192 "A common misunderstanding is that the appliance \"is\" the virtual machine. "
4193 "Although the disk image you are attached to might also be used by some "
4194 "virtual machine, libguestfs doesn't know or care about this. (But you will "
4195 "care if both libguestfs's qemu process and your virtual machine are trying "
4196 "to update the disk image at the same time, since these usually results in "
4197 "massive disk corruption)."
4201 #: ../src/guestfs.pod:2149
4202 msgid "STATE MACHINE"
4203 msgstr "СКІНЧЕННИЙ АВТОМАТ"
4206 #: ../src/guestfs.pod:2151
4207 msgid "libguestfs uses a state machine to model the child process:"
4211 #: ../src/guestfs.pod:2153
4223 " / | \\ \\ guestfs_launch\n"
4224 " / | _\\__V______\n"
4226 " / | | LAUNCHING |\n"
4227 " / | \\___________/\n"
4229 " / | guestfs_launch\n"
4231 " ______ / __|____V\n"
4232 " / \\ ------> / \\\n"
4233 " | BUSY | | READY |\n"
4234 " \\______/ <------ \\________/\n"
4239 #: ../src/guestfs.pod:2175
4241 "The normal transitions are (1) CONFIG (when the handle is created, but there "
4242 "is no child process), (2) LAUNCHING (when the child process is booting up), "
4243 "(3) alternating between READY and BUSY as commands are issued to, and "
4244 "carried out by, the child process."
4248 #: ../src/guestfs.pod:2180
4250 "The guest may be killed by L</guestfs_kill_subprocess>, or may die "
4251 "asynchronously at any time (eg. due to some internal error), and that causes "
4252 "the state to transition back to CONFIG."
4256 #: ../src/guestfs.pod:2184
4258 "Configuration commands for qemu such as L</guestfs_add_drive> can only be "
4259 "issued when in the CONFIG state."
4263 #: ../src/guestfs.pod:2187
4265 "The API offers one call that goes from CONFIG through LAUNCHING to READY. "
4266 "L</guestfs_launch> blocks until the child process is READY to accept "
4267 "commands (or until some failure or timeout). L</guestfs_launch> internally "
4268 "moves the state from CONFIG to LAUNCHING while it is running."
4272 #: ../src/guestfs.pod:2193
4274 "API actions such as L</guestfs_mount> can only be issued when in the READY "
4275 "state. These API calls block waiting for the command to be carried out (ie. "
4276 "the state to transition to BUSY and then back to READY). There are no non-"
4277 "blocking versions, and no way to issue more than one command per handle at "
4282 #: ../src/guestfs.pod:2199
4284 "Finally, the child process sends asynchronous messages back to the main "
4285 "program, such as kernel log messages. You can register a callback to "
4286 "receive these messages."
4290 #: ../src/guestfs.pod:2203
4295 #: ../src/guestfs.pod:2205
4296 msgid "COMMUNICATION PROTOCOL"
4300 #: ../src/guestfs.pod:2207
4302 "Don't rely on using this protocol directly. This section documents how it "
4303 "currently works, but it may change at any time."
4307 #: ../src/guestfs.pod:2210
4309 "The protocol used to talk between the library and the daemon running inside "
4310 "the qemu virtual machine is a simple RPC mechanism built on top of XDR (RFC "
4311 "1014, RFC 1832, RFC 4506)."
4315 #: ../src/guestfs.pod:2214
4317 "The detailed format of structures is in C<src/guestfs_protocol.x> (note: "
4318 "this file is automatically generated)."
4322 #: ../src/guestfs.pod:2217
4324 "There are two broad cases, ordinary functions that don't have any C<FileIn> "
4325 "and C<FileOut> parameters, which are handled with very simple request/reply "
4326 "messages. Then there are functions that have any C<FileIn> or C<FileOut> "
4327 "parameters, which use the same request and reply messages, but they may also "
4328 "be followed by files sent using a chunked encoding."
4332 #: ../src/guestfs.pod:2224
4333 msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)"
4337 #: ../src/guestfs.pod:2226
4338 msgid "For ordinary functions, the request message is:"
4342 #: ../src/guestfs.pod:2228
4345 " total length (header + arguments,\n"
4346 " but not including the length word itself)\n"
4347 " struct guestfs_message_header (encoded as XDR)\n"
4348 " struct guestfs_<foo>_args (encoded as XDR)\n"
4353 #: ../src/guestfs.pod:2233
4355 "The total length field allows the daemon to allocate a fixed size buffer "
4356 "into which it slurps the rest of the message. As a result, the total length "
4357 "is limited to C<GUESTFS_MESSAGE_MAX> bytes (currently 4MB), which means the "
4358 "effective size of any request is limited to somewhere under this size."
4362 #: ../src/guestfs.pod:2239
4364 "Note also that many functions don't take any arguments, in which case the "
4365 "C<guestfs_I<foo>_args> is completely omitted."
4369 #: ../src/guestfs.pod:2242
4371 "The header contains the procedure number (C<guestfs_proc>) which is how the "
4372 "receiver knows what type of args structure to expect, or none at all."
4376 #: ../src/guestfs.pod:2246
4378 "For functions that take optional arguments, the optional arguments are "
4379 "encoded in the C<guestfs_I<foo>_args> structure in the same way as ordinary "
4380 "arguments. A bitmask in the header indicates which optional arguments are "
4381 "meaningful. The bitmask is also checked to see if it contains bits set "
4382 "which the daemon does not know about (eg. if more optional arguments were "
4383 "added in a later version of the library), and this causes the call to be "
4388 #: ../src/guestfs.pod:2254
4389 msgid "The reply message for ordinary functions is:"
4393 #: ../src/guestfs.pod:2256
4396 " total length (header + ret,\n"
4397 " but not including the length word itself)\n"
4398 " struct guestfs_message_header (encoded as XDR)\n"
4399 " struct guestfs_<foo>_ret (encoded as XDR)\n"
4404 #: ../src/guestfs.pod:2261
4406 "As above the C<guestfs_I<foo>_ret> structure may be completely omitted for "
4407 "functions that return no formal return values."
4411 #: ../src/guestfs.pod:2264
4413 "As above the total length of the reply is limited to C<GUESTFS_MESSAGE_MAX>."
4417 #: ../src/guestfs.pod:2267
4419 "In the case of an error, a flag is set in the header, and the reply message "
4420 "is slightly changed:"
4424 #: ../src/guestfs.pod:2270
4427 " total length (header + error,\n"
4428 " but not including the length word itself)\n"
4429 " struct guestfs_message_header (encoded as XDR)\n"
4430 " struct guestfs_message_error (encoded as XDR)\n"
4435 #: ../src/guestfs.pod:2275
4437 "The C<guestfs_message_error> structure contains the error message as a "
4442 #: ../src/guestfs.pod:2278
4443 msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS"
4447 #: ../src/guestfs.pod:2280
4449 "A C<FileIn> parameter indicates that we transfer a file I<into> the guest. "
4450 "The normal request message is sent (see above). However this is followed by "
4451 "a sequence of file chunks."
4455 #: ../src/guestfs.pod:2284
4458 " total length (header + arguments,\n"
4459 " but not including the length word itself,\n"
4460 " and not including the chunks)\n"
4461 " struct guestfs_message_header (encoded as XDR)\n"
4462 " struct guestfs_<foo>_args (encoded as XDR)\n"
4463 " sequence of chunks for FileIn param #0\n"
4464 " sequence of chunks for FileIn param #1 etc.\n"
4469 #: ../src/guestfs.pod:2292
4470 msgid "The \"sequence of chunks\" is:"
4474 #: ../src/guestfs.pod:2294
4477 " length of chunk (not including length word itself)\n"
4478 " struct guestfs_chunk (encoded as XDR)\n"
4479 " length of chunk\n"
4480 " struct guestfs_chunk (encoded as XDR)\n"
4482 " length of chunk\n"
4483 " struct guestfs_chunk (with data.data_len == 0)\n"
4488 #: ../src/guestfs.pod:2302
4490 "The final chunk has the C<data_len> field set to zero. Additionally a flag "
4491 "is set in the final chunk to indicate either successful completion or early "
4496 #: ../src/guestfs.pod:2306
4498 "At time of writing there are no functions that have more than one FileIn "
4499 "parameter. However this is (theoretically) supported, by sending the "
4500 "sequence of chunks for each FileIn parameter one after another (from left to "
4505 #: ../src/guestfs.pod:2311
4507 "Both the library (sender) I<and> the daemon (receiver) may cancel the "
4508 "transfer. The library does this by sending a chunk with a special flag set "
4509 "to indicate cancellation. When the daemon sees this, it cancels the whole "
4510 "RPC, does I<not> send any reply, and goes back to reading the next request."
4514 #: ../src/guestfs.pod:2317
4516 "The daemon may also cancel. It does this by writing a special word "
4517 "C<GUESTFS_CANCEL_FLAG> to the socket. The library listens for this during "
4518 "the transfer, and if it gets it, it will cancel the transfer (it sends a "
4519 "cancel chunk). The special word is chosen so that even if cancellation "
4520 "happens right at the end of the transfer (after the library has finished "
4521 "writing and has started listening for the reply), the \"spurious\" cancel "
4522 "flag will not be confused with the reply message."
4526 #: ../src/guestfs.pod:2326
4528 "This protocol allows the transfer of arbitrary sized files (no 32 bit "
4529 "limit), and also files where the size is not known in advance (eg. from "
4530 "pipes or sockets). However the chunks are rather small "
4531 "(C<GUESTFS_MAX_CHUNK_SIZE>), so that neither the library nor the daemon need "
4532 "to keep much in memory."
4536 #: ../src/guestfs.pod:2332
4537 msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS"
4541 #: ../src/guestfs.pod:2334
4543 "The protocol for FileOut parameters is exactly the same as for FileIn "
4544 "parameters, but with the roles of daemon and library reversed."
4548 #: ../src/guestfs.pod:2337
4551 " total length (header + ret,\n"
4552 " but not including the length word itself,\n"
4553 " and not including the chunks)\n"
4554 " struct guestfs_message_header (encoded as XDR)\n"
4555 " struct guestfs_<foo>_ret (encoded as XDR)\n"
4556 " sequence of chunks for FileOut param #0\n"
4557 " sequence of chunks for FileOut param #1 etc.\n"
4562 #: ../src/guestfs.pod:2345
4563 msgid "INITIAL MESSAGE"
4567 #: ../src/guestfs.pod:2347
4569 "When the daemon launches it sends an initial word (C<GUESTFS_LAUNCH_FLAG>) "
4570 "which indicates that the guest and daemon is alive. This is what L</"
4571 "guestfs_launch> waits for."
4575 #: ../src/guestfs.pod:2351
4576 msgid "PROGRESS NOTIFICATION MESSAGES"
4580 #: ../src/guestfs.pod:2353
4582 "The daemon may send progress notification messages at any time. These are "
4583 "distinguished by the normal length word being replaced by "
4584 "C<GUESTFS_PROGRESS_FLAG>, followed by a fixed size progress message."
4588 #: ../src/guestfs.pod:2357
4590 "The library turns them into progress callbacks (see L</"
4591 "GUESTFS_EVENT_PROGRESS>) if there is a callback registered, or discards them "
4596 #: ../src/guestfs.pod:2361
4598 "The daemon self-limits the frequency of progress messages it sends (see "
4599 "C<daemon/proto.c:notify_progress>). Not all calls generate progress "
4604 #: ../src/guestfs.pod:2365
4605 msgid "LIBGUESTFS VERSION NUMBERS"
4609 #: ../src/guestfs.pod:2367
4611 "Since April 2010, libguestfs has started to make separate development and "
4612 "stable releases, along with corresponding branches in our git repository. "
4613 "These separate releases can be identified by version number:"
4617 #: ../src/guestfs.pod:2372
4620 " even numbers for stable: 1.2.x, 1.4.x, ...\n"
4621 " .-------- odd numbers for development: 1.3.x, 1.5.x, ...\n"
4627 " | `-------- sub-version\n"
4629 " `------ always '1' because we don't change the ABI\n"
4634 #: ../src/guestfs.pod:2383
4635 msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"."
4639 #: ../src/guestfs.pod:2385
4641 "As time passes we cherry pick fixes from the development branch and backport "
4642 "those into the stable branch, the effect being that the stable branch should "
4643 "get more stable and less buggy over time. So the stable releases are ideal "
4644 "for people who don't need new features but would just like the software to "
4649 #: ../src/guestfs.pod:2391
4650 msgid "Our criteria for backporting changes are:"
4654 #: ../src/guestfs.pod:2397
4656 "Documentation changes which don't affect any code are backported unless the "
4657 "documentation refers to a future feature which is not in stable."
4661 #: ../src/guestfs.pod:2403
4663 "Bug fixes which are not controversial, fix obvious problems, and have been "
4664 "well tested are backported."
4668 #: ../src/guestfs.pod:2408
4670 "Simple rearrangements of code which shouldn't affect how it works get "
4671 "backported. This is so that the code in the two branches doesn't get too "
4672 "far out of step, allowing us to backport future fixes more easily."
4676 #: ../src/guestfs.pod:2414
4678 "We I<don't> backport new features, new APIs, new tools etc, except in one "
4679 "exceptional case: the new feature is required in order to implement an "
4680 "important bug fix."
4684 #: ../src/guestfs.pod:2420
4686 "A new stable branch starts when we think the new features in development are "
4687 "substantial and compelling enough over the current stable branch to warrant "
4688 "it. When that happens we create new stable and development versions 1.N.0 "
4689 "and 1.(N+1).0 [N is even]. The new dot-oh release won't necessarily be so "
4690 "stable at this point, but by backporting fixes from development, that branch "
4691 "will stabilize over time."
4695 #: ../src/guestfs.pod:2428
4696 msgid "EXTENDING LIBGUESTFS"
4700 #: ../src/guestfs.pod:2430
4701 msgid "ADDING A NEW API ACTION"
4705 #: ../src/guestfs.pod:2432
4707 "Large amounts of boilerplate code in libguestfs (RPC, bindings, "
4708 "documentation) are generated, and this makes it easy to extend the "
4713 #: ../src/guestfs.pod:2436
4714 msgid "To add a new API action there are two changes:"
4718 #: ../src/guestfs.pod:2442
4720 "You need to add a description of the call (name, parameters, return type, "
4721 "tests, documentation) to C<generator/generator_actions.ml>."
4725 #: ../src/guestfs.pod:2445
4727 "There are two sorts of API action, depending on whether the call goes "
4728 "through to the daemon in the appliance, or is serviced entirely by the "
4729 "library (see L</ARCHITECTURE> above). L</guestfs_sync> is an example of the "
4730 "former, since the sync is done in the appliance. L</guestfs_set_trace> is "
4731 "an example of the latter, since a trace flag is maintained in the handle and "
4732 "all tracing is done on the library side."
4736 #: ../src/guestfs.pod:2453
4738 "Most new actions are of the first type, and get added to the "
4739 "C<daemon_functions> list. Each function has a unique procedure number used "
4740 "in the RPC protocol which is assigned to that action when we publish "
4741 "libguestfs and cannot be reused. Take the latest procedure number and "
4746 #: ../src/guestfs.pod:2459
4748 "For library-only actions of the second type, add to the "
4749 "C<non_daemon_functions> list. Since these functions are serviced by the "
4750 "library and do not travel over the RPC mechanism to the daemon, these "
4751 "functions do not need a procedure number, and so the procedure number is set "
4756 #: ../src/guestfs.pod:2467
4757 msgid "Implement the action (in C):"
4761 #: ../src/guestfs.pod:2469
4763 "For daemon actions, implement the function C<do_E<lt>nameE<gt>> in the "
4764 "C<daemon/> directory."
4768 #: ../src/guestfs.pod:2472
4770 "For library actions, implement the function C<guestfs__E<lt>nameE<gt>> "
4771 "(note: double underscore) in the C<src/> directory."
4775 #: ../src/guestfs.pod:2475
4776 msgid "In either case, use another function as an example of what to do."
4780 #: ../src/guestfs.pod:2479
4781 msgid "After making these changes, use C<make> to compile."
4785 #: ../src/guestfs.pod:2481
4787 "Note that you don't need to implement the RPC, language bindings, manual "
4788 "pages or anything else. It's all automatically generated from the OCaml "
4793 #: ../src/guestfs.pod:2485
4794 msgid "ADDING TESTS FOR AN API ACTION"
4798 #: ../src/guestfs.pod:2487
4800 "You can supply zero or as many tests as you want per API call. The tests "
4801 "can either be added as part of the API description (C<generator/"
4802 "generator_actions.ml>), or in some rarer cases you may want to drop a script "
4803 "into C<regressions/>. Note that adding a script to C<regressions/> is "
4804 "slower, so if possible use the first method."
4808 #: ../src/guestfs.pod:2493
4810 "The following describes the test environment used when you add an API test "
4811 "in C<generator_actions.ml>."
4815 #: ../src/guestfs.pod:2496
4816 msgid "The test environment has 4 block devices:"
4820 #: ../src/guestfs.pod:2500
4821 msgid "C</dev/sda> 500MB"
4825 #: ../src/guestfs.pod:2502
4826 msgid "General block device for testing."
4830 #: ../src/guestfs.pod:2504
4831 msgid "C</dev/sdb> 50MB"
4835 #: ../src/guestfs.pod:2506
4837 "C</dev/sdb1> is an ext2 filesystem used for testing filesystem write "
4842 #: ../src/guestfs.pod:2509
4843 msgid "C</dev/sdc> 10MB"
4847 #: ../src/guestfs.pod:2511
4848 msgid "Used in a few tests where two block devices are needed."
4852 #: ../src/guestfs.pod:2513
4854 msgstr "C</dev/sdd>"
4857 #: ../src/guestfs.pod:2515
4858 msgid "ISO with fixed content (see C<images/test.iso>)."
4862 #: ../src/guestfs.pod:2519
4864 "To be able to run the tests in a reasonable amount of time, the libguestfs "
4865 "appliance and block devices are reused between tests. So don't try testing "
4866 "L</guestfs_kill_subprocess> :-x"
4870 #: ../src/guestfs.pod:2523
4872 "Each test starts with an initial scenario, selected using one of the "
4873 "C<Init*> expressions, described in C<generator/generator_types.ml>. These "
4874 "initialize the disks mentioned above in a particular way as documented in "
4875 "C<generator_types.ml>. You should not assume anything about the previous "
4876 "contents of other disks that are not initialized."
4880 #: ../src/guestfs.pod:2529
4882 "You can add a prerequisite clause to any individual test. This is a run-"
4883 "time check, which, if it fails, causes the test to be skipped. Useful if "
4884 "testing a command which might not work on all variations of libguestfs "
4885 "builds. A test that has prerequisite of C<Always> means to run "
4890 #: ../src/guestfs.pod:2535
4892 "In addition, packagers can skip individual tests by setting environment "
4893 "variables before running C<make check>."
4897 #: ../src/guestfs.pod:2538
4900 " SKIP_TEST_<CMD>_<NUM>=1\n"
4905 #: ../src/guestfs.pod:2540
4906 msgid "eg: C<SKIP_TEST_COMMAND_3=1> skips test #3 of L</guestfs_command>."
4910 #: ../src/guestfs.pod:2542
4915 #: ../src/guestfs.pod:2544
4918 " SKIP_TEST_<CMD>=1\n"
4923 #: ../src/guestfs.pod:2546
4924 msgid "eg: C<SKIP_TEST_ZEROFREE=1> skips all L</guestfs_zerofree> tests."
4928 #: ../src/guestfs.pod:2548
4929 msgid "Packagers can run only certain tests by setting for example:"
4933 #: ../src/guestfs.pod:2550
4936 " TEST_ONLY=\"vfs_type zerofree\"\n"
4941 #: ../src/guestfs.pod:2552
4943 "See C<capitests/tests.c> for more details of how these environment variables "
4948 #: ../src/guestfs.pod:2555
4949 msgid "DEBUGGING NEW API ACTIONS"
4953 #: ../src/guestfs.pod:2557
4954 msgid "Test new actions work before submitting them."
4958 #: ../src/guestfs.pod:2559
4959 msgid "You can use guestfish to try out new commands."
4963 #: ../src/guestfs.pod:2561
4965 "Debugging the daemon is a problem because it runs inside a minimal "
4966 "environment. However you can fprintf messages in the daemon to stderr, and "
4967 "they will show up if you use C<guestfish -v>."
4971 #: ../src/guestfs.pod:2565
4972 msgid "FORMATTING CODE AND OTHER CONVENTIONS"
4976 #: ../src/guestfs.pod:2567
4978 "Our C source code generally adheres to some basic code-formatting "
4979 "conventions. The existing code base is not totally consistent on this "
4980 "front, but we do prefer that contributed code be formatted similarly. In "
4981 "short, use spaces-not-TABs for indentation, use 2 spaces for each "
4982 "indentation level, and other than that, follow the K&R style."
4986 #: ../src/guestfs.pod:2573
4988 "If you use Emacs, add the following to one of one of your start-up files (e."
4989 "g., ~/.emacs), to help ensure that you get indentation right:"
4993 #: ../src/guestfs.pod:2576
4996 " ;;; In libguestfs, indent with spaces everywhere (not TABs).\n"
4997 " ;;; Exceptions: Makefile and ChangeLog modes.\n"
4998 " (add-hook 'find-file-hook\n"
4999 " '(lambda () (if (and buffer-file-name\n"
5000 " (string-match \"/libguestfs\\\\>\"\n"
5001 " (buffer-file-name))\n"
5002 " (not (string-equal mode-name \"Change Log\"))\n"
5003 " (not (string-equal mode-name \"Makefile\")))\n"
5004 " (setq indent-tabs-mode nil))))\n"
5009 #: ../src/guestfs.pod:2586
5012 " ;;; When editing C sources in libguestfs, use this style.\n"
5013 " (defun libguestfs-c-mode ()\n"
5014 " \"C mode with adjusted defaults for use with libguestfs.\"\n"
5016 " (c-set-style \"K&R\")\n"
5017 " (setq c-indent-level 2)\n"
5018 " (setq c-basic-offset 2))\n"
5019 " (add-hook 'c-mode-hook\n"
5020 " '(lambda () (if (string-match \"/libguestfs\\\\>\"\n"
5021 " (buffer-file-name))\n"
5022 " (libguestfs-c-mode))))\n"
5027 #: ../src/guestfs.pod:2598
5028 msgid "Enable warnings when compiling (and fix any problems this finds):"
5032 #: ../src/guestfs.pod:2601
5035 " ./configure --enable-gcc-warnings\n"
5040 #: ../src/guestfs.pod:2603
5041 msgid "Useful targets are:"
5045 #: ../src/guestfs.pod:2605
5048 " make syntax-check # checks the syntax of the C code\n"
5049 " make check # runs the test suite\n"
5054 #: ../src/guestfs.pod:2608
5055 msgid "DAEMON CUSTOM PRINTF FORMATTERS"
5059 #: ../src/guestfs.pod:2610
5061 "In the daemon code we have created custom printf formatters C<%Q> and C<%R>, "
5062 "which are used to do shell quoting."
5066 #: ../src/guestfs.pod:2615
5071 #: ../src/guestfs.pod:2617
5073 "Simple shell quoted string. Any spaces or other shell characters are "
5078 #: ../src/guestfs.pod:2620
5083 #: ../src/guestfs.pod:2622
5085 "Same as C<%Q> except the string is treated as a path which is prefixed by "
5090 #: ../src/guestfs.pod:2627 ../fish/guestfish.pod:240 ../fish/guestfish.pod:613
5091 msgid "For example:"
5095 #: ../src/guestfs.pod:2629
5098 " asprintf (&cmd, \"cat %R\", path);\n"
5103 #: ../src/guestfs.pod:2631
5104 msgid "would produce C<cat /sysroot/some\\ path\\ with\\ spaces>"
5108 #: ../src/guestfs.pod:2633
5110 "I<Note:> Do I<not> use these when you are passing parameters to the C<command"
5111 "{,r,v,rv}()> functions. These parameters do NOT need to be quoted because "
5112 "they are not passed via the shell (instead, straight to exec). You probably "
5113 "want to use the C<sysroot_path()> function however."
5117 #: ../src/guestfs.pod:2639
5118 msgid "SUBMITTING YOUR NEW API ACTIONS"
5122 #: ../src/guestfs.pod:2641
5124 "Submit patches to the mailing list: L<http://www.redhat.com/mailman/listinfo/"
5125 "libguestfs> and CC to L<rjones@redhat.com>."
5129 #: ../src/guestfs.pod:2645
5130 msgid "INTERNATIONALIZATION (I18N) SUPPORT"
5134 #: ../src/guestfs.pod:2647
5135 msgid "We support i18n (gettext anyhow) in the library."
5139 #: ../src/guestfs.pod:2649
5141 "However many messages come from the daemon, and we don't translate those at "
5142 "the moment. One reason is that the appliance generally has all locale files "
5143 "removed from it, because they take up a lot of space. So we'd have to readd "
5144 "some of those, as well as copying our PO files into the appliance."
5148 #: ../src/guestfs.pod:2655
5150 "Debugging messages are never translated, since they are intended for the "
5155 #: ../src/guestfs.pod:2658
5156 msgid "SOURCE CODE SUBDIRECTORIES"
5160 #: ../src/guestfs.pod:2662 ../src/guestfs-actions.pod:5814
5161 #: ../fish/guestfish-actions.pod:3908
5162 msgid "C<appliance>"
5163 msgstr "C<appliance>"
5166 #: ../src/guestfs.pod:2664
5167 msgid "The libguestfs appliance, build scripts and so on."
5171 #: ../src/guestfs.pod:2666
5172 msgid "C<capitests>"
5173 msgstr "C<capitests>"
5176 #: ../src/guestfs.pod:2668
5177 msgid "Automated tests of the C API."
5181 #: ../src/guestfs.pod:2670
5186 #: ../src/guestfs.pod:2672
5188 "The L<virt-cat(1)>, L<virt-filesystems(1)> and L<virt-ls(1)> commands and "
5193 #: ../src/guestfs.pod:2675
5198 #: ../src/guestfs.pod:2677
5199 msgid "Outside contributions, experimental parts."
5203 #: ../src/guestfs.pod:2679
5208 #: ../src/guestfs.pod:2681
5210 "The daemon that runs inside the libguestfs appliance and carries out actions."
5214 #: ../src/guestfs.pod:2684
5219 #: ../src/guestfs.pod:2686
5220 msgid "L<virt-df(1)> command and documentation."
5224 #: ../src/guestfs.pod:2688
5226 msgstr "C<examples>"
5229 #: ../src/guestfs.pod:2690
5230 msgid "C API example code."
5231 msgstr "Код прикладів використання програмного інтерфейсу мовою C."
5234 #: ../src/guestfs.pod:2692
5239 #: ../src/guestfs.pod:2694
5241 "L<guestfish(1)>, the command-line shell, and various shell scripts built on "
5242 "top such as L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, "
5243 "L<virt-tar-out(1)>."
5247 #: ../src/guestfs.pod:2698
5252 #: ../src/guestfs.pod:2700
5254 "L<guestmount(1)>, FUSE (userspace filesystem) built on top of libguestfs."
5258 #: ../src/guestfs.pod:2702
5259 msgid "C<generator>"
5260 msgstr "C<generator>"
5263 #: ../src/guestfs.pod:2704
5265 "The crucially important generator, used to automatically generate large "
5266 "amounts of boilerplate C code for things like RPC and bindings."
5270 #: ../src/guestfs.pod:2707
5275 #: ../src/guestfs.pod:2709
5276 msgid "Files used by the test suite."
5280 #: ../src/guestfs.pod:2711
5281 msgid "Some \"phony\" guest images which we test against."
5285 #: ../src/guestfs.pod:2713
5286 msgid "C<inspector>"
5287 msgstr "C<inspector>"
5290 #: ../src/guestfs.pod:2715
5291 msgid "L<virt-inspector(1)>, the virtual machine image inspector."
5295 #: ../src/guestfs.pod:2717
5300 #: ../src/guestfs.pod:2719
5301 msgid "Logo used on the website. The fish is called Arthur by the way."
5305 #: ../src/guestfs.pod:2721
5310 #: ../src/guestfs.pod:2723
5311 msgid "M4 macros used by autoconf."
5315 #: ../src/guestfs.pod:2725
5320 #: ../src/guestfs.pod:2727
5321 msgid "Translations of simple gettext strings."
5322 msgstr "Переклади простих рядків gettext."
5325 #: ../src/guestfs.pod:2729
5330 #: ../src/guestfs.pod:2731
5332 "The build infrastructure and PO files for translations of manpages and POD "
5333 "files. Eventually this will be combined with the C<po> directory, but that "
5334 "is rather complicated."
5338 #: ../src/guestfs.pod:2735
5339 msgid "C<regressions>"
5340 msgstr "C<regressions>"
5343 #: ../src/guestfs.pod:2737
5344 msgid "Regression tests."
5345 msgstr "Тести на регресії."
5348 #: ../src/guestfs.pod:2739
5353 #: ../src/guestfs.pod:2741
5354 msgid "L<virt-rescue(1)> command and documentation."
5358 #: ../src/guestfs.pod:2743
5363 #: ../src/guestfs.pod:2745
5364 msgid "Source code to the C library."
5368 #: ../src/guestfs.pod:2747
5373 #: ../src/guestfs.pod:2749
5374 msgid "Command line tools written in Perl (L<virt-resize(1)> and many others)."
5378 #: ../src/guestfs.pod:2751
5379 msgid "C<test-tool>"
5380 msgstr "C<test-tool>"
5383 #: ../src/guestfs.pod:2753
5385 "Test tool for end users to test if their qemu/kernel combination will work "
5390 #: ../src/guestfs.pod:2756
5395 #: ../src/guestfs.pod:2758
5400 #: ../src/guestfs.pod:2760
5405 #: ../src/guestfs.pod:2762
5410 #: ../src/guestfs.pod:2764
5415 #: ../src/guestfs.pod:2766
5420 #: ../src/guestfs.pod:2768
5425 #: ../src/guestfs.pod:2770
5430 #: ../src/guestfs.pod:2772
5431 msgid "Language bindings."
5432 msgstr "Прив’язки до мов програмування."
5435 #: ../src/guestfs.pod:2776 ../fish/guestfish.pod:1015
5436 #: ../test-tool/libguestfs-test-tool.pod:82 ../tools/virt-edit.pl:476
5437 msgid "ENVIRONMENT VARIABLES"
5438 msgstr "ЗМІННІ СЕРЕДОВИЩА"
5441 #: ../src/guestfs.pod:2780 ../fish/guestfish.pod:1041
5442 msgid "LIBGUESTFS_APPEND"
5446 #: ../src/guestfs.pod:2782 ../fish/guestfish.pod:1043
5447 msgid "Pass additional options to the guest kernel."
5451 #: ../src/guestfs.pod:2784 ../fish/guestfish.pod:1045
5452 msgid "LIBGUESTFS_DEBUG"
5456 #: ../src/guestfs.pod:2786
5458 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
5459 "effect as calling C<guestfs_set_verbose (g, 1)>."
5463 #: ../src/guestfs.pod:2789 ../fish/guestfish.pod:1050
5464 msgid "LIBGUESTFS_MEMSIZE"
5468 #: ../src/guestfs.pod:2791 ../fish/guestfish.pod:1052
5470 "Set the memory allocated to the qemu process, in megabytes. For example:"
5474 #: ../src/guestfs.pod:2794 ../fish/guestfish.pod:1055
5477 " LIBGUESTFS_MEMSIZE=700\n"
5482 #: ../src/guestfs.pod:2796 ../fish/guestfish.pod:1057
5483 msgid "LIBGUESTFS_PATH"
5487 #: ../src/guestfs.pod:2798
5489 "Set the path that libguestfs uses to search for a supermin appliance. See "
5490 "the discussion of paths in section L</PATH> above."
5494 #: ../src/guestfs.pod:2801 ../fish/guestfish.pod:1062
5495 msgid "LIBGUESTFS_QEMU"
5499 #: ../src/guestfs.pod:2803 ../fish/guestfish.pod:1064
5501 "Set the default qemu binary that libguestfs uses. If not set, then the qemu "
5502 "which was found at compile time by the configure script is used."
5506 #: ../src/guestfs.pod:2807
5507 msgid "See also L</QEMU WRAPPERS> above."
5511 #: ../src/guestfs.pod:2809 ../fish/guestfish.pod:1068
5512 msgid "LIBGUESTFS_TRACE"
5516 #: ../src/guestfs.pod:2811
5518 "Set C<LIBGUESTFS_TRACE=1> to enable command traces. This has the same "
5519 "effect as calling C<guestfs_set_trace (g, 1)>."
5523 #: ../src/guestfs.pod:2814 ../fish/guestfish.pod:1077
5528 #: ../src/guestfs.pod:2816 ../fish/guestfish.pod:1079
5530 "Location of temporary directory, defaults to C</tmp> except for the cached "
5531 "supermin appliance which defaults to C</var/tmp>."
5535 #: ../src/guestfs.pod:2819 ../fish/guestfish.pod:1082
5537 "If libguestfs was compiled to use the supermin appliance then the real "
5538 "appliance is cached in this directory, shared between all handles belonging "
5539 "to the same EUID. You can use C<$TMPDIR> to configure another directory to "
5540 "use in case C</var/tmp> is not large enough."
5544 #: ../src/guestfs.pod:2827 ../fish/guestfish.pod:1149
5545 #: ../test-tool/libguestfs-test-tool.pod:87 ../fuse/guestmount.pod:267
5546 #: ../tools/virt-edit.pl:496 ../tools/virt-win-reg.pl:572
5547 #: ../tools/virt-list-filesystems.pl:189 ../tools/virt-tar.pl:286
5548 #: ../tools/virt-make-fs.pl:539 ../tools/virt-list-partitions.pl:257
5550 msgstr "ТАКОЖ ПЕРЕГЛЯНЬТЕ"
5553 #: ../src/guestfs.pod:2829
5555 "L<guestfs-examples(3)>, L<guestfs-ocaml(3)>, L<guestfs-python(3)>, L<guestfs-"
5556 "ruby(3)>, L<guestfish(1)>, L<guestmount(1)>, L<virt-cat(1)>, L<virt-copy-in"
5557 "(1)>, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, L<virt-filesystems"
5558 "(1)>, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, L<virt-list-"
5559 "partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, L<virt-rescue(1)>, L<virt-"
5560 "tar(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<virt-win-reg(1)>, L<qemu(1)"
5561 ">, L<febootstrap(1)>, L<hivex(3)>, L<http://libguestfs.org/>."
5565 #: ../src/guestfs.pod:2856
5567 "Tools with a similar purpose: L<fdisk(8)>, L<parted(8)>, L<kpartx(8)>, L<lvm"
5568 "(8)>, L<disktype(1)>."
5572 #: ../src/guestfs.pod:2863 ../tools/virt-win-reg.pl:587
5573 #: ../tools/virt-make-fs.pl:553
5578 #: ../src/guestfs.pod:2865
5579 msgid "To get a list of bugs against libguestfs use this link:"
5581 "Щоб переглянути список відомих вад у libguestfs, скористайтеся таким "
5585 #: ../src/guestfs.pod:2867
5587 "L<https://bugzilla.redhat.com/buglist.cgi?"
5588 "component=libguestfs&product=Virtualization+Tools>"
5590 "L<https://bugzilla.redhat.com/buglist.cgi?"
5591 "component=libguestfs&product=Virtualization+Tools>"
5594 #: ../src/guestfs.pod:2869
5595 msgid "To report a new bug against libguestfs use this link:"
5596 msgstr "Для звітування щодо вад у libguestfs скористайтеся цим посиланням:"
5599 #: ../src/guestfs.pod:2871
5601 "L<https://bugzilla.redhat.com/enter_bug.cgi?"
5602 "component=libguestfs&product=Virtualization+Tools>"
5604 "L<https://bugzilla.redhat.com/enter_bug.cgi?"
5605 "component=libguestfs&product=Virtualization+Tools>"
5608 #: ../src/guestfs.pod:2873
5609 msgid "When reporting a bug, please check:"
5613 #: ../src/guestfs.pod:2879
5614 msgid "That the bug hasn't been reported already."
5618 #: ../src/guestfs.pod:2883
5619 msgid "That you are testing a recent version."
5623 #: ../src/guestfs.pod:2887
5624 msgid "Describe the bug accurately, and give a way to reproduce it."
5628 #: ../src/guestfs.pod:2891
5630 "Run libguestfs-test-tool and paste the B<complete, unedited> output into the "
5635 #: ../src/guestfs.pod:2896 ../fish/guestfish.pod:1172
5636 #: ../test-tool/libguestfs-test-tool.pod:93 ../fuse/guestmount.pod:278
5641 #: ../src/guestfs.pod:2898 ../fish/guestfish.pod:1174
5642 #: ../test-tool/libguestfs-test-tool.pod:95 ../fuse/guestmount.pod:280
5643 msgid "Richard W.M. Jones (C<rjones at redhat dot com>)"
5647 #: ../src/guestfs.pod:2900 ../fish/guestfish.pod:1176
5648 #: ../test-tool/libguestfs-test-tool.pod:97 ../fuse/guestmount.pod:282
5649 #: ../tools/virt-edit.pl:514 ../tools/virt-win-reg.pl:602
5650 #: ../tools/virt-list-filesystems.pl:206 ../tools/virt-tar.pl:305
5651 #: ../tools/virt-make-fs.pl:568 ../tools/virt-list-partitions.pl:273
5653 msgstr "АВТОРСЬКІ ПРАВА"
5656 #: ../src/guestfs.pod:2902 ../fish/guestfish.pod:1178
5657 #: ../test-tool/libguestfs-test-tool.pod:99
5658 msgid "Copyright (C) 2009-2011 Red Hat Inc. L<http://libguestfs.org/>"
5662 #: ../src/guestfs.pod:2905
5664 "This library is free software; you can redistribute it and/or modify it "
5665 "under the terms of the GNU Lesser General Public License as published by the "
5666 "Free Software Foundation; either version 2 of the License, or (at your "
5667 "option) any later version."
5671 #: ../src/guestfs.pod:2910
5673 "This library is distributed in the hope that it will be useful, but WITHOUT "
5674 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
5675 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License "
5680 #: ../src/guestfs.pod:2915
5682 "You should have received a copy of the GNU Lesser General Public License "
5683 "along with this library; if not, write to the Free Software Foundation, "
5684 "Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA"
5688 #: ../src/guestfs-actions.pod:1
5689 msgid "guestfs_add_cdrom"
5693 #: ../src/guestfs-actions.pod:3
5697 " guestfs_add_cdrom (guestfs_h *g,\n"
5698 " const char *filename);\n"
5703 #: ../src/guestfs-actions.pod:7 ../fish/guestfish-actions.pod:5
5704 msgid "This function adds a virtual CD-ROM disk image to the guest."
5708 #: ../src/guestfs-actions.pod:9 ../fish/guestfish-actions.pod:7
5709 msgid "This is equivalent to the qemu parameter C<-cdrom filename>."
5713 #: ../src/guestfs-actions.pod:17
5715 "This call checks for the existence of C<filename>. This stops you from "
5716 "specifying other types of drive which are supported by qemu such as C<nbd:> "
5717 "and C<http:> URLs. To specify those, use the general C<guestfs_config> call "
5722 #: ../src/guestfs-actions.pod:24
5724 "If you just want to add an ISO file (often you use this as an efficient way "
5725 "to transfer large files into the guest), then you should probably use "
5726 "C<guestfs_add_drive_ro> instead."
5730 #: ../src/guestfs-actions.pod:30 ../src/guestfs-actions.pod:134
5731 #: ../src/guestfs-actions.pod:195 ../src/guestfs-actions.pod:232
5732 #: ../src/guestfs-actions.pod:246 ../src/guestfs-actions.pod:267
5733 #: ../src/guestfs-actions.pod:287 ../src/guestfs-actions.pod:301
5734 #: ../src/guestfs-actions.pod:416 ../src/guestfs-actions.pod:436
5735 #: ../src/guestfs-actions.pod:450 ../src/guestfs-actions.pod:495
5736 #: ../src/guestfs-actions.pod:523 ../src/guestfs-actions.pod:541
5737 #: ../src/guestfs-actions.pod:608 ../src/guestfs-actions.pod:641
5738 #: ../src/guestfs-actions.pod:655 ../src/guestfs-actions.pod:670
5739 #: ../src/guestfs-actions.pod:769 ../src/guestfs-actions.pod:787
5740 #: ../src/guestfs-actions.pod:801 ../src/guestfs-actions.pod:815
5741 #: ../src/guestfs-actions.pod:976 ../src/guestfs-actions.pod:996
5742 #: ../src/guestfs-actions.pod:1014 ../src/guestfs-actions.pod:1098
5743 #: ../src/guestfs-actions.pod:1116 ../src/guestfs-actions.pod:1135
5744 #: ../src/guestfs-actions.pod:1149 ../src/guestfs-actions.pod:1169
5745 #: ../src/guestfs-actions.pod:1239 ../src/guestfs-actions.pod:1270
5746 #: ../src/guestfs-actions.pod:1295 ../src/guestfs-actions.pod:1337
5747 #: ../src/guestfs-actions.pod:1443 ../src/guestfs-actions.pod:1477
5748 #: ../src/guestfs-actions.pod:1695 ../src/guestfs-actions.pod:1717
5749 #: ../src/guestfs-actions.pod:1804 ../src/guestfs-actions.pod:2266
5750 #: ../src/guestfs-actions.pod:2410 ../src/guestfs-actions.pod:2471
5751 #: ../src/guestfs-actions.pod:2506 ../src/guestfs-actions.pod:3459
5752 #: ../src/guestfs-actions.pod:3474 ../src/guestfs-actions.pod:3499
5753 #: ../src/guestfs-actions.pod:3654 ../src/guestfs-actions.pod:3668
5754 #: ../src/guestfs-actions.pod:3681 ../src/guestfs-actions.pod:3695
5755 #: ../src/guestfs-actions.pod:3710 ../src/guestfs-actions.pod:3746
5756 #: ../src/guestfs-actions.pod:3818 ../src/guestfs-actions.pod:3838
5757 #: ../src/guestfs-actions.pod:3855 ../src/guestfs-actions.pod:3878
5758 #: ../src/guestfs-actions.pod:3901 ../src/guestfs-actions.pod:3933
5759 #: ../src/guestfs-actions.pod:3952 ../src/guestfs-actions.pod:3971
5760 #: ../src/guestfs-actions.pod:4006 ../src/guestfs-actions.pod:4018
5761 #: ../src/guestfs-actions.pod:4054 ../src/guestfs-actions.pod:4070
5762 #: ../src/guestfs-actions.pod:4083 ../src/guestfs-actions.pod:4098
5763 #: ../src/guestfs-actions.pod:4115 ../src/guestfs-actions.pod:4208
5764 #: ../src/guestfs-actions.pod:4228 ../src/guestfs-actions.pod:4241
5765 #: ../src/guestfs-actions.pod:4292 ../src/guestfs-actions.pod:4310
5766 #: ../src/guestfs-actions.pod:4328 ../src/guestfs-actions.pod:4344
5767 #: ../src/guestfs-actions.pod:4358 ../src/guestfs-actions.pod:4372
5768 #: ../src/guestfs-actions.pod:4389 ../src/guestfs-actions.pod:4404
5769 #: ../src/guestfs-actions.pod:4424 ../src/guestfs-actions.pod:4482
5770 #: ../src/guestfs-actions.pod:4555 ../src/guestfs-actions.pod:4586
5771 #: ../src/guestfs-actions.pod:4605 ../src/guestfs-actions.pod:4624
5772 #: ../src/guestfs-actions.pod:4636 ../src/guestfs-actions.pod:4653
5773 #: ../src/guestfs-actions.pod:4666 ../src/guestfs-actions.pod:4681
5774 #: ../src/guestfs-actions.pod:4696 ../src/guestfs-actions.pod:4731
5775 #: ../src/guestfs-actions.pod:4746 ../src/guestfs-actions.pod:4766
5776 #: ../src/guestfs-actions.pod:4780 ../src/guestfs-actions.pod:4797
5777 #: ../src/guestfs-actions.pod:4846 ../src/guestfs-actions.pod:4883
5778 #: ../src/guestfs-actions.pod:4897 ../src/guestfs-actions.pod:4925
5779 #: ../src/guestfs-actions.pod:4942 ../src/guestfs-actions.pod:4960
5780 #: ../src/guestfs-actions.pod:5094 ../src/guestfs-actions.pod:5151
5781 #: ../src/guestfs-actions.pod:5173 ../src/guestfs-actions.pod:5191
5782 #: ../src/guestfs-actions.pod:5223 ../src/guestfs-actions.pod:5289
5783 #: ../src/guestfs-actions.pod:5306 ../src/guestfs-actions.pod:5319
5784 #: ../src/guestfs-actions.pod:5333 ../src/guestfs-actions.pod:5622
5785 #: ../src/guestfs-actions.pod:5641 ../src/guestfs-actions.pod:5660
5786 #: ../src/guestfs-actions.pod:5672 ../src/guestfs-actions.pod:5684
5787 #: ../src/guestfs-actions.pod:5698 ../src/guestfs-actions.pod:5710
5788 #: ../src/guestfs-actions.pod:5724 ../src/guestfs-actions.pod:5740
5789 #: ../src/guestfs-actions.pod:5761 ../src/guestfs-actions.pod:5780
5790 #: ../src/guestfs-actions.pod:5799 ../src/guestfs-actions.pod:5829
5791 #: ../src/guestfs-actions.pod:5845 ../src/guestfs-actions.pod:5868
5792 #: ../src/guestfs-actions.pod:5886 ../src/guestfs-actions.pod:5905
5793 #: ../src/guestfs-actions.pod:5926 ../src/guestfs-actions.pod:5945
5794 #: ../src/guestfs-actions.pod:5962 ../src/guestfs-actions.pod:5990
5795 #: ../src/guestfs-actions.pod:6014 ../src/guestfs-actions.pod:6033
5796 #: ../src/guestfs-actions.pod:6057 ../src/guestfs-actions.pod:6076
5797 #: ../src/guestfs-actions.pod:6091 ../src/guestfs-actions.pod:6110
5798 #: ../src/guestfs-actions.pod:6147 ../src/guestfs-actions.pod:6170
5799 #: ../src/guestfs-actions.pod:6196 ../src/guestfs-actions.pod:6304
5800 #: ../src/guestfs-actions.pod:6425 ../src/guestfs-actions.pod:6437
5801 #: ../src/guestfs-actions.pod:6450 ../src/guestfs-actions.pod:6463
5802 #: ../src/guestfs-actions.pod:6485 ../src/guestfs-actions.pod:6498
5803 #: ../src/guestfs-actions.pod:6511 ../src/guestfs-actions.pod:6524
5804 #: ../src/guestfs-actions.pod:6539 ../src/guestfs-actions.pod:6598
5805 #: ../src/guestfs-actions.pod:6615 ../src/guestfs-actions.pod:6631
5806 #: ../src/guestfs-actions.pod:6647 ../src/guestfs-actions.pod:6664
5807 #: ../src/guestfs-actions.pod:6677 ../src/guestfs-actions.pod:6697
5808 #: ../src/guestfs-actions.pod:6733 ../src/guestfs-actions.pod:6747
5809 #: ../src/guestfs-actions.pod:6788 ../src/guestfs-actions.pod:6801
5810 #: ../src/guestfs-actions.pod:6819 ../src/guestfs-actions.pod:6853
5811 #: ../src/guestfs-actions.pod:6889 ../src/guestfs-actions.pod:7008
5812 #: ../src/guestfs-actions.pod:7026 ../src/guestfs-actions.pod:7040
5813 #: ../src/guestfs-actions.pod:7095 ../src/guestfs-actions.pod:7108
5814 #: ../src/guestfs-actions.pod:7153 ../src/guestfs-actions.pod:7186
5815 #: ../src/guestfs-actions.pod:7240 ../src/guestfs-actions.pod:7266
5816 #: ../src/guestfs-actions.pod:7332 ../src/guestfs-actions.pod:7351
5817 #: ../src/guestfs-actions.pod:7380
5818 msgid "This function returns 0 on success or -1 on error."
5822 #: ../src/guestfs-actions.pod:32 ../src/guestfs-actions.pod:248
5823 #: ../src/guestfs-actions.pod:269 ../fish/guestfish-actions.pod:28
5824 #: ../fish/guestfish-actions.pod:158 ../fish/guestfish-actions.pod:172
5826 "This function is deprecated. In new code, use the C<add_drive_opts> call "
5831 #: ../src/guestfs-actions.pod:35 ../src/guestfs-actions.pod:251
5832 #: ../src/guestfs-actions.pod:272 ../src/guestfs-actions.pod:1448
5833 #: ../src/guestfs-actions.pod:1944 ../src/guestfs-actions.pod:1965
5834 #: ../src/guestfs-actions.pod:4429 ../src/guestfs-actions.pod:7274
5835 #: ../src/guestfs-actions.pod:7443 ../fish/guestfish-actions.pod:31
5836 #: ../fish/guestfish-actions.pod:161 ../fish/guestfish-actions.pod:175
5837 #: ../fish/guestfish-actions.pod:956 ../fish/guestfish-actions.pod:1319
5838 #: ../fish/guestfish-actions.pod:1333 ../fish/guestfish-actions.pod:3008
5839 #: ../fish/guestfish-actions.pod:4866 ../fish/guestfish-actions.pod:4963
5841 "Deprecated functions will not be removed from the API, but the fact that "
5842 "they are deprecated indicates that there are problems with correct use of "
5847 #: ../src/guestfs-actions.pod:39 ../src/guestfs-actions.pod:136
5848 #: ../src/guestfs-actions.pod:1100 ../src/guestfs-actions.pod:1916
5849 #: ../src/guestfs-actions.pod:2014 ../src/guestfs-actions.pod:2117
5850 #: ../src/guestfs-actions.pod:3461 ../src/guestfs-actions.pod:3481
5851 #: ../src/guestfs-actions.pod:4733 ../src/guestfs-actions.pod:5847
5852 #: ../src/guestfs-actions.pod:5964 ../src/guestfs-actions.pod:6078
5853 #: ../src/guestfs-actions.pod:6541 ../src/guestfs-actions.pod:6666
5854 #: ../src/guestfs-actions.pod:7188
5855 msgid "(Added in 0.3)"
5859 #: ../src/guestfs-actions.pod:41
5860 msgid "guestfs_add_domain"
5864 #: ../src/guestfs-actions.pod:43
5868 " guestfs_add_domain (guestfs_h *g,\n"
5869 " const char *dom,\n"
5875 #: ../src/guestfs-actions.pod:48 ../src/guestfs-actions.pod:145
5876 #: ../src/guestfs-actions.pod:4443
5878 "You may supply a list of optional arguments to this call. Use zero or more "
5879 "of the following pairs of parameters, and terminate the list with C<-1> on "
5880 "its own. See L</CALLS WITH OPTIONAL ARGUMENTS>."
5884 #: ../src/guestfs-actions.pod:53
5887 " GUESTFS_ADD_DOMAIN_LIBVIRTURI, const char *libvirturi,\n"
5888 " GUESTFS_ADD_DOMAIN_READONLY, int readonly,\n"
5889 " GUESTFS_ADD_DOMAIN_IFACE, const char *iface,\n"
5890 " GUESTFS_ADD_DOMAIN_LIVE, int live,\n"
5895 #: ../src/guestfs-actions.pod:58
5897 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
5898 "It works by connecting to libvirt, requesting the domain and domain XML from "
5899 "libvirt, parsing it for disks, and calling C<guestfs_add_drive_opts> on each "
5904 #: ../src/guestfs-actions.pod:63 ../fish/guestfish-actions.pod:46
5906 "The number of disks added is returned. This operation is atomic: if an "
5907 "error is returned, then no disks are added."
5911 #: ../src/guestfs-actions.pod:66 ../fish/guestfish-actions.pod:49
5913 "This function does some minimal checks to make sure the libvirt domain is "
5914 "not running (unless C<readonly> is true). In a future version we will try "
5915 "to acquire the libvirt lock on each disk."
5919 #: ../src/guestfs-actions.pod:70 ../fish/guestfish-actions.pod:53
5921 "Disks must be accessible locally. This often means that adding disks from a "
5922 "remote libvirt connection (see L<http://libvirt.org/remote.html>) will fail "
5923 "unless those disks are accessible via the same device path locally too."
5927 #: ../src/guestfs-actions.pod:75 ../fish/guestfish-actions.pod:58
5929 "The optional C<libvirturi> parameter sets the libvirt URI (see L<http://"
5930 "libvirt.org/uri.html>). If this is not set then we connect to the default "
5931 "libvirt URI (or one set through an environment variable, see the libvirt "
5932 "documentation for full details)."
5936 #: ../src/guestfs-actions.pod:81 ../fish/guestfish-actions.pod:64
5938 "The optional C<live> flag controls whether this call will try to connect to "
5939 "a running virtual machine C<guestfsd> process if it sees a suitable "
5940 "E<lt>channelE<gt> element in the libvirt XML definition. The default (if "
5941 "the flag is omitted) is never to try. See L<guestfs(3)/ATTACHING TO RUNNING "
5942 "DAEMONS> for more information."
5946 #: ../src/guestfs-actions.pod:88
5948 "The other optional parameters are passed directly through to "
5949 "C<guestfs_add_drive_opts>."
5953 #: ../src/guestfs-actions.pod:91 ../src/guestfs-actions.pod:344
5954 #: ../src/guestfs-actions.pod:509 ../src/guestfs-actions.pod:687
5955 #: ../src/guestfs-actions.pod:718 ../src/guestfs-actions.pod:736
5956 #: ../src/guestfs-actions.pod:755 ../src/guestfs-actions.pod:1315
5957 #: ../src/guestfs-actions.pod:1674 ../src/guestfs-actions.pod:1877
5958 #: ../src/guestfs-actions.pod:1986 ../src/guestfs-actions.pod:2026
5959 #: ../src/guestfs-actions.pod:2081 ../src/guestfs-actions.pod:2104
5960 #: ../src/guestfs-actions.pod:2397 ../src/guestfs-actions.pod:2780
5961 #: ../src/guestfs-actions.pod:2801 ../src/guestfs-actions.pod:4869
5962 #: ../src/guestfs-actions.pod:4997 ../src/guestfs-actions.pod:5403
5963 #: ../src/guestfs-actions.pod:5429 ../src/guestfs-actions.pod:6774
5964 #: ../src/guestfs-actions.pod:7199 ../src/guestfs-actions.pod:7212
5965 #: ../src/guestfs-actions.pod:7225
5966 msgid "On error this function returns -1."
5970 #: ../src/guestfs-actions.pod:93
5971 msgid "(Added in 1.7.4)"
5975 #: ../src/guestfs-actions.pod:95
5976 msgid "guestfs_add_domain_va"
5980 #: ../src/guestfs-actions.pod:97
5984 " guestfs_add_domain_va (guestfs_h *g,\n"
5985 " const char *dom,\n"
5991 #: ../src/guestfs-actions.pod:102
5992 msgid "This is the \"va_list variant\" of L</guestfs_add_domain>."
5996 #: ../src/guestfs-actions.pod:104 ../src/guestfs-actions.pod:115
5997 #: ../src/guestfs-actions.pod:208 ../src/guestfs-actions.pod:219
5998 #: ../src/guestfs-actions.pod:4496 ../src/guestfs-actions.pod:4508
5999 msgid "See L</CALLS WITH OPTIONAL ARGUMENTS>."
6003 #: ../src/guestfs-actions.pod:106
6004 msgid "guestfs_add_domain_argv"
6008 #: ../src/guestfs-actions.pod:108
6012 " guestfs_add_domain_argv (guestfs_h *g,\n"
6013 " const char *dom,\n"
6014 " const struct guestfs_add_domain_argv *optargs);\n"
6019 #: ../src/guestfs-actions.pod:113
6020 msgid "This is the \"argv variant\" of L</guestfs_add_domain>."
6024 #: ../src/guestfs-actions.pod:117
6025 msgid "guestfs_add_drive"
6029 #: ../src/guestfs-actions.pod:119
6033 " guestfs_add_drive (guestfs_h *g,\n"
6034 " const char *filename);\n"
6039 #: ../src/guestfs-actions.pod:123
6041 "This function is the equivalent of calling C<guestfs_add_drive_opts> with no "
6042 "optional parameters, so the disk is added writable, with the format being "
6043 "detected automatically."
6047 #: ../src/guestfs-actions.pod:127
6049 "Automatic detection of the format opens you up to a potential security hole "
6050 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
6051 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
6052 "you should think about replacing calls to this function with calls to "
6053 "C<guestfs_add_drive_opts>, and specifying the format."
6057 #: ../src/guestfs-actions.pod:138
6058 msgid "guestfs_add_drive_opts"
6062 #: ../src/guestfs-actions.pod:140
6066 " guestfs_add_drive_opts (guestfs_h *g,\n"
6067 " const char *filename,\n"
6073 #: ../src/guestfs-actions.pod:150
6076 " GUESTFS_ADD_DRIVE_OPTS_READONLY, int readonly,\n"
6077 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, const char *format,\n"
6078 " GUESTFS_ADD_DRIVE_OPTS_IFACE, const char *iface,\n"
6083 #: ../src/guestfs-actions.pod:154 ../fish/guestfish-actions.pod:97
6085 "This function adds a virtual machine disk image C<filename> to libguestfs. "
6086 "The first time you call this function, the disk appears as C</dev/sda>, the "
6087 "second time as C</dev/sdb>, and so on."
6091 #: ../src/guestfs-actions.pod:159 ../fish/guestfish-actions.pod:102
6093 "You don't necessarily need to be root when using libguestfs. However you "
6094 "obviously do need sufficient permissions to access the filename for whatever "
6095 "operations you want to perform (ie. read access if you just want to read the "
6096 "image or write access if you want to modify the image)."
6100 #: ../src/guestfs-actions.pod:165 ../fish/guestfish-actions.pod:108
6101 msgid "This call checks that C<filename> exists."
6105 #: ../src/guestfs-actions.pod:167 ../src/guestfs-actions.pod:4454
6106 #: ../fish/guestfish-actions.pod:110 ../fish/guestfish-actions.pod:3019
6107 msgid "The optional arguments are:"
6111 #: ../src/guestfs-actions.pod:171 ../fish/guestfish-actions.pod:114
6113 msgstr "C<readonly>"
6116 #: ../src/guestfs-actions.pod:173 ../fish/guestfish-actions.pod:116
6118 "If true then the image is treated as read-only. Writes are still allowed, "
6119 "but they are stored in a temporary snapshot overlay which is discarded at "
6120 "the end. The disk that you add is not modified."
6124 #: ../src/guestfs-actions.pod:177 ../fish/guestfish-actions.pod:120
6129 #: ../src/guestfs-actions.pod:179
6131 "This forces the image format. If you omit this (or use C<guestfs_add_drive> "
6132 "or C<guestfs_add_drive_ro>) then the format is automatically detected. "
6133 "Possible formats include C<raw> and C<qcow2>."
6137 #: ../src/guestfs-actions.pod:183 ../fish/guestfish-actions.pod:126
6139 "Automatic detection of the format opens you up to a potential security hole "
6140 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
6141 "RHBZ#642934. Specifying the format closes this security hole."
6145 #: ../src/guestfs-actions.pod:188 ../fish/guestfish-actions.pod:131
6150 #: ../src/guestfs-actions.pod:190
6152 "This rarely-used option lets you emulate the behaviour of the deprecated "
6153 "C<guestfs_add_drive_with_if> call (q.v.)"
6157 #: ../src/guestfs-actions.pod:197
6158 msgid "(Added in 1.5.23)"
6162 #: ../src/guestfs-actions.pod:199
6163 msgid "guestfs_add_drive_opts_va"
6167 #: ../src/guestfs-actions.pod:201
6171 " guestfs_add_drive_opts_va (guestfs_h *g,\n"
6172 " const char *filename,\n"
6178 #: ../src/guestfs-actions.pod:206
6179 msgid "This is the \"va_list variant\" of L</guestfs_add_drive_opts>."
6183 #: ../src/guestfs-actions.pod:210
6184 msgid "guestfs_add_drive_opts_argv"
6188 #: ../src/guestfs-actions.pod:212
6192 " guestfs_add_drive_opts_argv (guestfs_h *g,\n"
6193 " const char *filename,\n"
6194 " const struct guestfs_add_drive_opts_argv *optargs);\n"
6199 #: ../src/guestfs-actions.pod:217
6200 msgid "This is the \"argv variant\" of L</guestfs_add_drive_opts>."
6204 #: ../src/guestfs-actions.pod:221
6205 msgid "guestfs_add_drive_ro"
6209 #: ../src/guestfs-actions.pod:223
6213 " guestfs_add_drive_ro (guestfs_h *g,\n"
6214 " const char *filename);\n"
6219 #: ../src/guestfs-actions.pod:227
6221 "This function is the equivalent of calling C<guestfs_add_drive_opts> with "
6222 "the optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the "
6223 "disk is added read-only, with the format being detected automatically."
6227 #: ../src/guestfs-actions.pod:234
6228 msgid "(Added in 1.0.38)"
6232 #: ../src/guestfs-actions.pod:236
6233 msgid "guestfs_add_drive_ro_with_if"
6237 #: ../src/guestfs-actions.pod:238
6241 " guestfs_add_drive_ro_with_if (guestfs_h *g,\n"
6242 " const char *filename,\n"
6243 " const char *iface);\n"
6248 #: ../src/guestfs-actions.pod:243
6250 "This is the same as C<guestfs_add_drive_ro> but it allows you to specify the "
6251 "QEMU interface emulation to use at run time."
6255 #: ../src/guestfs-actions.pod:255 ../src/guestfs-actions.pod:276
6256 #: ../src/guestfs-actions.pod:2356
6257 msgid "(Added in 1.0.84)"
6261 #: ../src/guestfs-actions.pod:257
6262 msgid "guestfs_add_drive_with_if"
6266 #: ../src/guestfs-actions.pod:259
6270 " guestfs_add_drive_with_if (guestfs_h *g,\n"
6271 " const char *filename,\n"
6272 " const char *iface);\n"
6277 #: ../src/guestfs-actions.pod:264
6279 "This is the same as C<guestfs_add_drive> but it allows you to specify the "
6280 "QEMU interface emulation to use at run time."
6284 #: ../src/guestfs-actions.pod:278
6285 msgid "guestfs_aug_clear"
6289 #: ../src/guestfs-actions.pod:280
6293 " guestfs_aug_clear (guestfs_h *g,\n"
6294 " const char *augpath);\n"
6299 #: ../src/guestfs-actions.pod:284 ../fish/guestfish-actions.pod:183
6301 "Set the value associated with C<path> to C<NULL>. This is the same as the "
6302 "L<augtool(1)> C<clear> command."
6306 #: ../src/guestfs-actions.pod:289 ../src/guestfs-actions.pod:2106
6307 msgid "(Added in 1.3.4)"
6311 #: ../src/guestfs-actions.pod:291
6312 msgid "guestfs_aug_close"
6316 #: ../src/guestfs-actions.pod:293
6320 " guestfs_aug_close (guestfs_h *g);\n"
6325 #: ../src/guestfs-actions.pod:296
6327 "Close the current Augeas handle and free up any resources used by it. After "
6328 "calling this, you have to call C<guestfs_aug_init> again before you can use "
6329 "any other Augeas functions."
6333 #: ../src/guestfs-actions.pod:303 ../src/guestfs-actions.pod:328
6334 #: ../src/guestfs-actions.pod:346 ../src/guestfs-actions.pod:360
6335 #: ../src/guestfs-actions.pod:418 ../src/guestfs-actions.pod:438
6336 #: ../src/guestfs-actions.pod:452 ../src/guestfs-actions.pod:483
6337 #: ../src/guestfs-actions.pod:497 ../src/guestfs-actions.pod:511
6338 #: ../src/guestfs-actions.pod:525 ../src/guestfs-actions.pod:543
6339 #: ../src/guestfs-actions.pod:5480
6340 msgid "(Added in 0.7)"
6344 #: ../src/guestfs-actions.pod:305
6345 msgid "guestfs_aug_defnode"
6349 #: ../src/guestfs-actions.pod:307
6352 " struct guestfs_int_bool *\n"
6353 " guestfs_aug_defnode (guestfs_h *g,\n"
6354 " const char *name,\n"
6355 " const char *expr,\n"
6356 " const char *val);\n"
6361 #: ../src/guestfs-actions.pod:313 ../fish/guestfish-actions.pod:199
6363 "Defines a variable C<name> whose value is the result of evaluating C<expr>."
6367 #: ../src/guestfs-actions.pod:316
6369 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
6370 "calling C<guestfs_aug_set> C<expr>, C<value>. C<name> will be the nodeset "
6371 "containing that single node."
6375 #: ../src/guestfs-actions.pod:320 ../fish/guestfish-actions.pod:206
6377 "On success this returns a pair containing the number of nodes in the "
6378 "nodeset, and a boolean flag if a node was created."
6382 #: ../src/guestfs-actions.pod:324
6384 "This function returns a C<struct guestfs_int_bool *>, or NULL if there was "
6385 "an error. I<The caller must call C<guestfs_free_int_bool> after use>."
6389 #: ../src/guestfs-actions.pod:330
6390 msgid "guestfs_aug_defvar"
6394 #: ../src/guestfs-actions.pod:332
6398 " guestfs_aug_defvar (guestfs_h *g,\n"
6399 " const char *name,\n"
6400 " const char *expr);\n"
6405 #: ../src/guestfs-actions.pod:337 ../fish/guestfish-actions.pod:214
6407 "Defines an Augeas variable C<name> whose value is the result of evaluating "
6408 "C<expr>. If C<expr> is NULL, then C<name> is undefined."
6412 #: ../src/guestfs-actions.pod:341 ../fish/guestfish-actions.pod:218
6414 "On success this returns the number of nodes in C<expr>, or C<0> if C<expr> "
6415 "evaluates to something which is not a nodeset."
6419 #: ../src/guestfs-actions.pod:348
6420 msgid "guestfs_aug_get"
6424 #: ../src/guestfs-actions.pod:350
6428 " guestfs_aug_get (guestfs_h *g,\n"
6429 " const char *augpath);\n"
6434 #: ../src/guestfs-actions.pod:354 ../fish/guestfish-actions.pod:225
6436 "Look up the value associated with C<path>. If C<path> matches exactly one "
6437 "node, the C<value> is returned."
6441 #: ../src/guestfs-actions.pod:357 ../src/guestfs-actions.pod:857
6442 #: ../src/guestfs-actions.pod:875 ../src/guestfs-actions.pod:935
6443 #: ../src/guestfs-actions.pod:951 ../src/guestfs-actions.pod:1054
6444 #: ../src/guestfs-actions.pod:1184 ../src/guestfs-actions.pod:1201
6445 #: ../src/guestfs-actions.pod:1220 ../src/guestfs-actions.pod:1354
6446 #: ../src/guestfs-actions.pod:1545 ../src/guestfs-actions.pod:1657
6447 #: ../src/guestfs-actions.pod:1820 ../src/guestfs-actions.pod:1837
6448 #: ../src/guestfs-actions.pod:1904 ../src/guestfs-actions.pod:1938
6449 #: ../src/guestfs-actions.pod:1959 ../src/guestfs-actions.pod:2129
6450 #: ../src/guestfs-actions.pod:2321 ../src/guestfs-actions.pod:2528
6451 #: ../src/guestfs-actions.pod:2621 ../src/guestfs-actions.pod:2732
6452 #: ../src/guestfs-actions.pod:2752 ../src/guestfs-actions.pod:2872
6453 #: ../src/guestfs-actions.pod:2903 ../src/guestfs-actions.pod:2927
6454 #: ../src/guestfs-actions.pod:2964 ../src/guestfs-actions.pod:3024
6455 #: ../src/guestfs-actions.pod:3047 ../src/guestfs-actions.pod:3068
6456 #: ../src/guestfs-actions.pod:3640 ../src/guestfs-actions.pod:3990
6457 #: ../src/guestfs-actions.pod:4160 ../src/guestfs-actions.pod:4270
6458 #: ../src/guestfs-actions.pod:5015 ../src/guestfs-actions.pod:5208
6459 #: ../src/guestfs-actions.pod:5378 ../src/guestfs-actions.pod:5556
6460 #: ../src/guestfs-actions.pod:5605 ../src/guestfs-actions.pod:6217
6461 #: ../src/guestfs-actions.pod:6233 ../src/guestfs-actions.pod:6250
6462 #: ../src/guestfs-actions.pod:6274 ../src/guestfs-actions.pod:6948
6463 #: ../src/guestfs-actions.pod:6967 ../src/guestfs-actions.pod:6985
6464 #: ../src/guestfs-actions.pod:7165 ../src/guestfs-actions.pod:7437
6466 "This function returns a string, or NULL on error. I<The caller must free "
6467 "the returned string after use>."
6471 #: ../src/guestfs-actions.pod:362
6472 msgid "guestfs_aug_init"
6476 #: ../src/guestfs-actions.pod:364
6480 " guestfs_aug_init (guestfs_h *g,\n"
6481 " const char *root,\n"
6487 #: ../src/guestfs-actions.pod:369 ../fish/guestfish-actions.pod:232
6489 "Create a new Augeas handle for editing configuration files. If there was "
6490 "any previous Augeas handle associated with this guestfs session, then it is "
6495 #: ../src/guestfs-actions.pod:373
6496 msgid "You must call this before using any other C<guestfs_aug_*> commands."
6500 #: ../src/guestfs-actions.pod:376 ../fish/guestfish-actions.pod:239
6502 "C<root> is the filesystem root. C<root> must not be NULL, use C</> instead."
6506 #: ../src/guestfs-actions.pod:379 ../fish/guestfish-actions.pod:242
6508 "The flags are the same as the flags defined in E<lt>augeas.hE<gt>, the "
6509 "logical I<or> of the following integers:"
6513 #: ../src/guestfs-actions.pod:385 ../fish/guestfish-actions.pod:248
6514 msgid "C<AUG_SAVE_BACKUP> = 1"
6515 msgstr "C<AUG_SAVE_BACKUP> = 1"
6518 #: ../src/guestfs-actions.pod:387 ../fish/guestfish-actions.pod:250
6519 msgid "Keep the original file with a C<.augsave> extension."
6523 #: ../src/guestfs-actions.pod:389 ../fish/guestfish-actions.pod:252
6524 msgid "C<AUG_SAVE_NEWFILE> = 2"
6525 msgstr "C<AUG_SAVE_NEWFILE> = 2"
6528 #: ../src/guestfs-actions.pod:391 ../fish/guestfish-actions.pod:254
6530 "Save changes into a file with extension C<.augnew>, and do not overwrite "
6531 "original. Overrides C<AUG_SAVE_BACKUP>."
6535 #: ../src/guestfs-actions.pod:394 ../fish/guestfish-actions.pod:257
6536 msgid "C<AUG_TYPE_CHECK> = 4"
6537 msgstr "C<AUG_TYPE_CHECK> = 4"
6540 #: ../src/guestfs-actions.pod:396 ../fish/guestfish-actions.pod:259
6541 msgid "Typecheck lenses (can be expensive)."
6545 #: ../src/guestfs-actions.pod:398 ../fish/guestfish-actions.pod:261
6546 msgid "C<AUG_NO_STDINC> = 8"
6547 msgstr "C<AUG_NO_STDINC> = 8"
6550 #: ../src/guestfs-actions.pod:400 ../fish/guestfish-actions.pod:263
6551 msgid "Do not use standard load path for modules."
6555 #: ../src/guestfs-actions.pod:402 ../fish/guestfish-actions.pod:265
6556 msgid "C<AUG_SAVE_NOOP> = 16"
6557 msgstr "C<AUG_SAVE_NOOP> = 16"
6560 #: ../src/guestfs-actions.pod:404 ../fish/guestfish-actions.pod:267
6561 msgid "Make save a no-op, just record what would have been changed."
6565 #: ../src/guestfs-actions.pod:406 ../fish/guestfish-actions.pod:269
6566 msgid "C<AUG_NO_LOAD> = 32"
6567 msgstr "C<AUG_NO_LOAD> = 32"
6570 #: ../src/guestfs-actions.pod:408
6571 msgid "Do not load the tree in C<guestfs_aug_init>."
6575 #: ../src/guestfs-actions.pod:412
6576 msgid "To close the handle, you can call C<guestfs_aug_close>."
6580 #: ../src/guestfs-actions.pod:414 ../fish/guestfish-actions.pod:277
6581 msgid "To find out more about Augeas, see L<http://augeas.net/>."
6585 #: ../src/guestfs-actions.pod:420
6586 msgid "guestfs_aug_insert"
6590 #: ../src/guestfs-actions.pod:422
6594 " guestfs_aug_insert (guestfs_h *g,\n"
6595 " const char *augpath,\n"
6596 " const char *label,\n"
6602 #: ../src/guestfs-actions.pod:428 ../fish/guestfish-actions.pod:283
6604 "Create a new sibling C<label> for C<path>, inserting it into the tree before "
6605 "or after C<path> (depending on the boolean flag C<before>)."
6609 #: ../src/guestfs-actions.pod:432 ../fish/guestfish-actions.pod:287
6611 "C<path> must match exactly one existing node in the tree, and C<label> must "
6612 "be a label, ie. not contain C</>, C<*> or end with a bracketed index C<[N]>."
6616 #: ../src/guestfs-actions.pod:440
6617 msgid "guestfs_aug_load"
6621 #: ../src/guestfs-actions.pod:442
6625 " guestfs_aug_load (guestfs_h *g);\n"
6630 #: ../src/guestfs-actions.pod:445 ../fish/guestfish-actions.pod:295
6631 msgid "Load files into the tree."
6632 msgstr "Завантажити файли до ієрархії."
6635 #: ../src/guestfs-actions.pod:447 ../fish/guestfish-actions.pod:297
6636 msgid "See C<aug_load> in the Augeas documentation for the full gory details."
6640 #: ../src/guestfs-actions.pod:454
6641 msgid "guestfs_aug_ls"
6645 #: ../src/guestfs-actions.pod:456
6649 " guestfs_aug_ls (guestfs_h *g,\n"
6650 " const char *augpath);\n"
6655 #: ../src/guestfs-actions.pod:460
6657 "This is just a shortcut for listing C<guestfs_aug_match> C<path/*> and "
6658 "sorting the resulting nodes into alphabetical order."
6662 #: ../src/guestfs-actions.pod:463 ../src/guestfs-actions.pod:479
6663 #: ../src/guestfs-actions.pod:625 ../src/guestfs-actions.pod:1073
6664 #: ../src/guestfs-actions.pod:1369 ../src/guestfs-actions.pod:1388
6665 #: ../src/guestfs-actions.pod:1491 ../src/guestfs-actions.pod:1510
6666 #: ../src/guestfs-actions.pod:1759 ../src/guestfs-actions.pod:2201
6667 #: ../src/guestfs-actions.pod:2217 ../src/guestfs-actions.pod:2236
6668 #: ../src/guestfs-actions.pod:2279 ../src/guestfs-actions.pod:2303
6669 #: ../src/guestfs-actions.pod:2374 ../src/guestfs-actions.pod:2423
6670 #: ../src/guestfs-actions.pod:2690 ../src/guestfs-actions.pod:2981
6671 #: ../src/guestfs-actions.pod:3270 ../src/guestfs-actions.pod:3560
6672 #: ../src/guestfs-actions.pod:3622 ../src/guestfs-actions.pod:3727
6673 #: ../src/guestfs-actions.pod:4132 ../src/guestfs-actions.pod:4830
6674 #: ../src/guestfs-actions.pod:5350 ../src/guestfs-actions.pod:5476
6675 #: ../src/guestfs-actions.pod:5590 ../src/guestfs-actions.pod:6290
6676 #: ../src/guestfs-actions.pod:6351 ../src/guestfs-actions.pod:6406
6677 #: ../src/guestfs-actions.pod:6552 ../src/guestfs-actions.pod:6576
6678 #: ../src/guestfs-actions.pod:7058 ../src/guestfs-actions.pod:7078
6679 #: ../src/guestfs-actions.pod:7125 ../src/guestfs-actions.pod:7290
6680 #: ../src/guestfs-actions.pod:7309 ../src/guestfs-actions.pod:7394
6681 #: ../src/guestfs-actions.pod:7413 ../src/guestfs-actions.pod:7459
6682 #: ../src/guestfs-actions.pod:7478
6684 "This function returns a NULL-terminated array of strings (like L<environ(3)"
6685 ">), or NULL if there was an error. I<The caller must free the strings and "
6686 "the array after use>."
6690 #: ../src/guestfs-actions.pod:467 ../src/guestfs-actions.pod:998
6691 #: ../src/guestfs-actions.pod:1016 ../src/guestfs-actions.pod:1426
6692 #: ../src/guestfs-actions.pod:3348 ../src/guestfs-actions.pod:3379
6693 #: ../src/guestfs-actions.pod:3973 ../src/guestfs-actions.pod:4023
6694 #: ../src/guestfs-actions.pod:4210 ../src/guestfs-actions.pod:4243
6695 #: ../src/guestfs-actions.pod:4406 ../src/guestfs-actions.pod:4834
6696 #: ../src/guestfs-actions.pod:5291 ../src/guestfs-actions.pod:5686
6697 #: ../src/guestfs-actions.pod:5700 ../src/guestfs-actions.pod:5712
6698 #: ../src/guestfs-actions.pod:6152 ../src/guestfs-actions.pod:6790
6699 #: ../src/guestfs-actions.pod:6803 ../src/guestfs-actions.pod:7042
6700 #: ../src/guestfs-actions.pod:7278
6701 msgid "(Added in 0.8)"
6705 #: ../src/guestfs-actions.pod:469
6706 msgid "guestfs_aug_match"
6710 #: ../src/guestfs-actions.pod:471
6714 " guestfs_aug_match (guestfs_h *g,\n"
6715 " const char *augpath);\n"
6720 #: ../src/guestfs-actions.pod:475 ../fish/guestfish-actions.pod:311
6722 "Returns a list of paths which match the path expression C<path>. The "
6723 "returned paths are sufficiently qualified so that they match exactly one "
6724 "node in the current tree."
6728 #: ../src/guestfs-actions.pod:485
6729 msgid "guestfs_aug_mv"
6733 #: ../src/guestfs-actions.pod:487
6737 " guestfs_aug_mv (guestfs_h *g,\n"
6738 " const char *src,\n"
6739 " const char *dest);\n"
6744 #: ../src/guestfs-actions.pod:492 ../fish/guestfish-actions.pod:319
6746 "Move the node C<src> to C<dest>. C<src> must match exactly one node. "
6747 "C<dest> is overwritten if it exists."
6751 #: ../src/guestfs-actions.pod:499
6752 msgid "guestfs_aug_rm"
6756 #: ../src/guestfs-actions.pod:501
6760 " guestfs_aug_rm (guestfs_h *g,\n"
6761 " const char *augpath);\n"
6766 #: ../src/guestfs-actions.pod:505 ../fish/guestfish-actions.pod:326
6767 msgid "Remove C<path> and all of its children."
6771 #: ../src/guestfs-actions.pod:507 ../fish/guestfish-actions.pod:328
6772 msgid "On success this returns the number of entries which were removed."
6776 #: ../src/guestfs-actions.pod:513
6777 msgid "guestfs_aug_save"
6781 #: ../src/guestfs-actions.pod:515
6785 " guestfs_aug_save (guestfs_h *g);\n"
6790 #: ../src/guestfs-actions.pod:518 ../fish/guestfish-actions.pod:334
6791 msgid "This writes all pending changes to disk."
6795 #: ../src/guestfs-actions.pod:520
6797 "The flags which were passed to C<guestfs_aug_init> affect exactly how files "
6802 #: ../src/guestfs-actions.pod:527
6803 msgid "guestfs_aug_set"
6807 #: ../src/guestfs-actions.pod:529
6811 " guestfs_aug_set (guestfs_h *g,\n"
6812 " const char *augpath,\n"
6813 " const char *val);\n"
6818 #: ../src/guestfs-actions.pod:534 ../fish/guestfish-actions.pod:343
6819 msgid "Set the value associated with C<path> to C<val>."
6823 #: ../src/guestfs-actions.pod:536
6825 "In the Augeas API, it is possible to clear a node by setting the value to "
6826 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
6827 "this call. Instead you must use the C<guestfs_aug_clear> call."
6831 #: ../src/guestfs-actions.pod:545
6832 msgid "guestfs_available"
6836 #: ../src/guestfs-actions.pod:547
6840 " guestfs_available (guestfs_h *g,\n"
6841 " char *const *groups);\n"
6846 #: ../src/guestfs-actions.pod:551 ../fish/guestfish-actions.pod:354
6848 "This command is used to check the availability of some groups of "
6849 "functionality in the appliance, which not all builds of the libguestfs "
6850 "appliance will be able to provide."
6854 #: ../src/guestfs-actions.pod:555
6856 "The libguestfs groups, and the functions that those groups correspond to, "
6857 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
6858 "runtime by calling C<guestfs_available_all_groups>."
6862 #: ../src/guestfs-actions.pod:560 ../fish/guestfish-actions.pod:363
6864 "The argument C<groups> is a list of group names, eg: C<[\"inotify\", \"augeas"
6865 "\"]> would check for the availability of the Linux inotify functions and "
6866 "Augeas (configuration file editing) functions."
6870 #: ../src/guestfs-actions.pod:565 ../fish/guestfish-actions.pod:368
6871 msgid "The command returns no error if I<all> requested groups are available."
6875 #: ../src/guestfs-actions.pod:567 ../fish/guestfish-actions.pod:370
6877 "It fails with an error if one or more of the requested groups is unavailable "
6882 #: ../src/guestfs-actions.pod:570 ../fish/guestfish-actions.pod:373
6884 "If an unknown group name is included in the list of groups then an error is "
6889 #: ../src/guestfs-actions.pod:573 ../fish/guestfish-actions.pod:376
6891 msgstr "I<Нотатки:>"
6894 #: ../src/guestfs-actions.pod:579
6895 msgid "You must call C<guestfs_launch> before calling this function."
6899 #: ../src/guestfs-actions.pod:581 ../fish/guestfish-actions.pod:384
6901 "The reason is because we don't know what groups are supported by the "
6902 "appliance/daemon until it is running and can be queried."
6906 #: ../src/guestfs-actions.pod:587 ../fish/guestfish-actions.pod:390
6908 "If a group of functions is available, this does not necessarily mean that "
6909 "they will work. You still have to check for errors when calling individual "
6910 "API functions even if they are available."
6914 #: ../src/guestfs-actions.pod:594 ../fish/guestfish-actions.pod:397
6916 "It is usually the job of distro packagers to build complete functionality "
6917 "into the libguestfs appliance. Upstream libguestfs, if built from source "
6918 "with all requirements satisfied, will support everything."
6922 #: ../src/guestfs-actions.pod:601
6924 "This call was added in version C<1.0.80>. In previous versions of "
6925 "libguestfs all you could do would be to speculatively execute a command to "
6926 "find out if the daemon implemented it. See also C<guestfs_version>."
6930 #: ../src/guestfs-actions.pod:610 ../src/guestfs-actions.pod:1171
6931 msgid "(Added in 1.0.80)"
6935 #: ../src/guestfs-actions.pod:612
6936 msgid "guestfs_available_all_groups"
6940 #: ../src/guestfs-actions.pod:614
6944 " guestfs_available_all_groups (guestfs_h *g);\n"
6949 #: ../src/guestfs-actions.pod:617
6951 "This command returns a list of all optional groups that this daemon knows "
6952 "about. Note this returns both supported and unsupported groups. To find "
6953 "out which ones the daemon can actually support you have to call "
6954 "C<guestfs_available> on each member of the returned list."
6958 #: ../src/guestfs-actions.pod:623
6959 msgid "See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>."
6963 #: ../src/guestfs-actions.pod:629
6964 msgid "(Added in 1.3.15)"
6968 #: ../src/guestfs-actions.pod:631
6969 msgid "guestfs_base64_in"
6973 #: ../src/guestfs-actions.pod:633
6977 " guestfs_base64_in (guestfs_h *g,\n"
6978 " const char *base64file,\n"
6979 " const char *filename);\n"
6984 #: ../src/guestfs-actions.pod:638 ../fish/guestfish-actions.pod:427
6986 "This command uploads base64-encoded data from C<base64file> to C<filename>."
6990 #: ../src/guestfs-actions.pod:643 ../src/guestfs-actions.pod:657
6991 msgid "(Added in 1.3.5)"
6995 #: ../src/guestfs-actions.pod:645
6996 msgid "guestfs_base64_out"
7000 #: ../src/guestfs-actions.pod:647
7004 " guestfs_base64_out (guestfs_h *g,\n"
7005 " const char *filename,\n"
7006 " const char *base64file);\n"
7011 #: ../src/guestfs-actions.pod:652 ../fish/guestfish-actions.pod:436
7013 "This command downloads the contents of C<filename>, writing it out to local "
7014 "file C<base64file> encoded as base64."
7018 #: ../src/guestfs-actions.pod:659
7019 msgid "guestfs_blockdev_flushbufs"
7023 #: ../src/guestfs-actions.pod:661
7027 " guestfs_blockdev_flushbufs (guestfs_h *g,\n"
7028 " const char *device);\n"
7033 #: ../src/guestfs-actions.pod:665 ../fish/guestfish-actions.pod:445
7035 "This tells the kernel to flush internal buffers associated with C<device>."
7039 #: ../src/guestfs-actions.pod:668 ../src/guestfs-actions.pod:685
7040 #: ../src/guestfs-actions.pod:700 ../src/guestfs-actions.pod:716
7041 #: ../src/guestfs-actions.pod:734 ../src/guestfs-actions.pod:753
7042 #: ../src/guestfs-actions.pod:767 ../src/guestfs-actions.pod:785
7043 #: ../src/guestfs-actions.pod:799 ../src/guestfs-actions.pod:813
7044 #: ../fish/guestfish-actions.pod:448 ../fish/guestfish-actions.pod:459
7045 #: ../fish/guestfish-actions.pod:468 ../fish/guestfish-actions.pod:478
7046 #: ../fish/guestfish-actions.pod:490 ../fish/guestfish-actions.pod:503
7047 #: ../fish/guestfish-actions.pod:511 ../fish/guestfish-actions.pod:522
7048 #: ../fish/guestfish-actions.pod:530 ../fish/guestfish-actions.pod:538
7049 msgid "This uses the L<blockdev(8)> command."
7053 #: ../src/guestfs-actions.pod:672 ../src/guestfs-actions.pod:689
7054 #: ../src/guestfs-actions.pod:704 ../src/guestfs-actions.pod:720
7055 #: ../src/guestfs-actions.pod:738 ../src/guestfs-actions.pod:757
7056 #: ../src/guestfs-actions.pod:771 ../src/guestfs-actions.pod:789
7057 #: ../src/guestfs-actions.pod:803 ../src/guestfs-actions.pod:817
7058 msgid "(Added in 0.9.3)"
7062 #: ../src/guestfs-actions.pod:674
7063 msgid "guestfs_blockdev_getbsz"
7067 #: ../src/guestfs-actions.pod:676
7071 " guestfs_blockdev_getbsz (guestfs_h *g,\n"
7072 " const char *device);\n"
7077 #: ../src/guestfs-actions.pod:680 ../fish/guestfish-actions.pod:454
7078 msgid "This returns the block size of a device."
7082 #: ../src/guestfs-actions.pod:682 ../src/guestfs-actions.pod:782
7083 #: ../fish/guestfish-actions.pod:456 ../fish/guestfish-actions.pod:519
7085 "(Note this is different from both I<size in blocks> and I<filesystem block "
7090 #: ../src/guestfs-actions.pod:691
7091 msgid "guestfs_blockdev_getro"
7095 #: ../src/guestfs-actions.pod:693
7099 " guestfs_blockdev_getro (guestfs_h *g,\n"
7100 " const char *device);\n"
7105 #: ../src/guestfs-actions.pod:697 ../fish/guestfish-actions.pod:465
7107 "Returns a boolean indicating if the block device is read-only (true if read-"
7108 "only, false if not)."
7112 #: ../src/guestfs-actions.pod:702 ../src/guestfs-actions.pod:1409
7113 #: ../src/guestfs-actions.pod:1424 ../src/guestfs-actions.pod:1914
7114 #: ../src/guestfs-actions.pod:1925 ../src/guestfs-actions.pod:1997
7115 #: ../src/guestfs-actions.pod:2052 ../src/guestfs-actions.pod:2067
7116 #: ../src/guestfs-actions.pod:2092 ../src/guestfs-actions.pod:2115
7117 #: ../src/guestfs-actions.pod:3088 ../src/guestfs-actions.pod:3105
7118 #: ../src/guestfs-actions.pod:3124 ../src/guestfs-actions.pod:3287
7119 #: ../src/guestfs-actions.pod:3301 ../src/guestfs-actions.pod:3316
7120 #: ../src/guestfs-actions.pod:3330 ../src/guestfs-actions.pod:3346
7121 #: ../src/guestfs-actions.pod:3361 ../src/guestfs-actions.pod:3377
7122 #: ../src/guestfs-actions.pod:3391 ../src/guestfs-actions.pod:3404
7123 #: ../src/guestfs-actions.pod:3418 ../src/guestfs-actions.pod:3433
7124 #: ../src/guestfs-actions.pod:3448 ../src/guestfs-actions.pod:4979
7125 msgid "This function returns a C truth value on success or -1 on error."
7129 #: ../src/guestfs-actions.pod:706
7130 msgid "guestfs_blockdev_getsize64"
7134 #: ../src/guestfs-actions.pod:708
7138 " guestfs_blockdev_getsize64 (guestfs_h *g,\n"
7139 " const char *device);\n"
7144 #: ../src/guestfs-actions.pod:712 ../fish/guestfish-actions.pod:474
7145 msgid "This returns the size of the device in bytes."
7149 #: ../src/guestfs-actions.pod:714
7150 msgid "See also C<guestfs_blockdev_getsz>."
7154 #: ../src/guestfs-actions.pod:722
7155 msgid "guestfs_blockdev_getss"
7159 #: ../src/guestfs-actions.pod:724
7163 " guestfs_blockdev_getss (guestfs_h *g,\n"
7164 " const char *device);\n"
7169 #: ../src/guestfs-actions.pod:728 ../fish/guestfish-actions.pod:484
7171 "This returns the size of sectors on a block device. Usually 512, but can be "
7172 "larger for modern devices."
7176 #: ../src/guestfs-actions.pod:731
7178 "(Note, this is not the size in sectors, use C<guestfs_blockdev_getsz> for "
7183 #: ../src/guestfs-actions.pod:740
7184 msgid "guestfs_blockdev_getsz"
7188 #: ../src/guestfs-actions.pod:742
7192 " guestfs_blockdev_getsz (guestfs_h *g,\n"
7193 " const char *device);\n"
7198 #: ../src/guestfs-actions.pod:746 ../fish/guestfish-actions.pod:496
7200 "This returns the size of the device in units of 512-byte sectors (even if "
7201 "the sectorsize isn't 512 bytes ... weird)."
7205 #: ../src/guestfs-actions.pod:749
7207 "See also C<guestfs_blockdev_getss> for the real sector size of the device, "
7208 "and C<guestfs_blockdev_getsize64> for the more useful I<size in bytes>."
7212 #: ../src/guestfs-actions.pod:759
7213 msgid "guestfs_blockdev_rereadpt"
7217 #: ../src/guestfs-actions.pod:761
7221 " guestfs_blockdev_rereadpt (guestfs_h *g,\n"
7222 " const char *device);\n"
7227 #: ../src/guestfs-actions.pod:765 ../fish/guestfish-actions.pod:509
7228 msgid "Reread the partition table on C<device>."
7232 #: ../src/guestfs-actions.pod:773
7233 msgid "guestfs_blockdev_setbsz"
7237 #: ../src/guestfs-actions.pod:775
7241 " guestfs_blockdev_setbsz (guestfs_h *g,\n"
7242 " const char *device,\n"
7243 " int blocksize);\n"
7248 #: ../src/guestfs-actions.pod:780 ../fish/guestfish-actions.pod:517
7249 msgid "This sets the block size of a device."
7253 #: ../src/guestfs-actions.pod:791
7254 msgid "guestfs_blockdev_setro"
7258 #: ../src/guestfs-actions.pod:793
7262 " guestfs_blockdev_setro (guestfs_h *g,\n"
7263 " const char *device);\n"
7268 #: ../src/guestfs-actions.pod:797 ../fish/guestfish-actions.pod:528
7269 msgid "Sets the block device named C<device> to read-only."
7273 #: ../src/guestfs-actions.pod:805
7274 msgid "guestfs_blockdev_setrw"
7278 #: ../src/guestfs-actions.pod:807
7282 " guestfs_blockdev_setrw (guestfs_h *g,\n"
7283 " const char *device);\n"
7288 #: ../src/guestfs-actions.pod:811 ../fish/guestfish-actions.pod:536
7289 msgid "Sets the block device named C<device> to read-write."
7293 #: ../src/guestfs-actions.pod:819
7294 msgid "guestfs_case_sensitive_path"
7298 #: ../src/guestfs-actions.pod:821
7302 " guestfs_case_sensitive_path (guestfs_h *g,\n"
7303 " const char *path);\n"
7308 #: ../src/guestfs-actions.pod:825 ../fish/guestfish-actions.pod:544
7310 "This can be used to resolve case insensitive paths on a filesystem which is "
7311 "case sensitive. The use case is to resolve paths which you have read from "
7312 "Windows configuration files or the Windows Registry, to the true path."
7316 #: ../src/guestfs-actions.pod:830 ../fish/guestfish-actions.pod:549
7318 "The command handles a peculiarity of the Linux ntfs-3g filesystem driver "
7319 "(and probably others), which is that although the underlying filesystem is "
7320 "case-insensitive, the driver exports the filesystem to Linux as case-"
7325 #: ../src/guestfs-actions.pod:835 ../fish/guestfish-actions.pod:554
7327 "One consequence of this is that special directories such as C<c:\\windows> "
7328 "may appear as C</WINDOWS> or C</windows> (or other things) depending on the "
7329 "precise details of how they were created. In Windows itself this would not "
7334 #: ../src/guestfs-actions.pod:841 ../fish/guestfish-actions.pod:560
7336 "Bug or feature? You decide: L<http://www.tuxera.com/community/ntfs-3g-faq/"
7341 #: ../src/guestfs-actions.pod:844 ../fish/guestfish-actions.pod:563
7343 "This function resolves the true case of each element in the path and returns "
7344 "the case-sensitive path."
7348 #: ../src/guestfs-actions.pod:847
7350 "Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\") might return C<"
7351 "\"/WINDOWS/system32\"> (the exact return value would depend on details of "
7352 "how the directories were originally created under Windows)."
7356 #: ../src/guestfs-actions.pod:852 ../fish/guestfish-actions.pod:571
7357 msgid "I<Note>: This function does not handle drive names, backslashes etc."
7361 #: ../src/guestfs-actions.pod:855
7362 msgid "See also C<guestfs_realpath>."
7366 #: ../src/guestfs-actions.pod:860 ../src/guestfs-actions.pod:6970
7367 msgid "(Added in 1.0.75)"
7371 #: ../src/guestfs-actions.pod:862
7376 #: ../src/guestfs-actions.pod:864
7380 " guestfs_cat (guestfs_h *g,\n"
7381 " const char *path);\n"
7386 #: ../src/guestfs-actions.pod:868 ../src/guestfs-actions.pod:5466
7387 #: ../fish/guestfish-actions.pod:580 ../fish/guestfish-actions.pod:3667
7388 msgid "Return the contents of the file named C<path>."
7392 #: ../src/guestfs-actions.pod:870
7394 "Note that this function cannot correctly handle binary files (specifically, "
7395 "files containing C<\\0> character which is treated as end of string). For "
7396 "those you need to use the C<guestfs_read_file> or C<guestfs_download> "
7397 "functions which have a more complex interface."
7401 #: ../src/guestfs-actions.pod:878 ../src/guestfs-actions.pod:1057
7402 #: ../src/guestfs-actions.pod:1077 ../src/guestfs-actions.pod:1373
7403 #: ../src/guestfs-actions.pod:1392 ../src/guestfs-actions.pod:1495
7404 #: ../src/guestfs-actions.pod:1514 ../src/guestfs-actions.pod:1763
7405 #: ../src/guestfs-actions.pod:2221 ../src/guestfs-actions.pod:2240
7406 #: ../src/guestfs-actions.pod:2283 ../src/guestfs-actions.pod:2307
7407 #: ../src/guestfs-actions.pod:2324 ../src/guestfs-actions.pod:2353
7408 #: ../src/guestfs-actions.pod:5248 ../src/guestfs-actions.pod:5274
7409 #: ../src/guestfs-actions.pod:5405 ../src/guestfs-actions.pod:5431
7410 #: ../src/guestfs-actions.pod:5455 ../src/guestfs-actions.pod:6355
7411 #: ../src/guestfs-actions.pod:6410 ../src/guestfs-actions.pod:6556
7412 #: ../src/guestfs-actions.pod:6580 ../src/guestfs-actions.pod:7242
7413 #: ../src/guestfs-actions.pod:7268 ../src/guestfs-actions.pod:7294
7414 #: ../src/guestfs-actions.pod:7313 ../src/guestfs-actions.pod:7398
7415 #: ../src/guestfs-actions.pod:7417 ../src/guestfs-actions.pod:7463
7416 #: ../src/guestfs-actions.pod:7482 ../fish/guestfish-actions.pod:587
7417 #: ../fish/guestfish-actions.pod:722 ../fish/guestfish-actions.pod:734
7418 #: ../fish/guestfish-actions.pod:910 ../fish/guestfish-actions.pod:920
7419 #: ../fish/guestfish-actions.pod:987 ../fish/guestfish-actions.pod:997
7420 #: ../fish/guestfish-actions.pod:1192 ../fish/guestfish-actions.pod:1493
7421 #: ../fish/guestfish-actions.pod:1503 ../fish/guestfish-actions.pod:1531
7422 #: ../fish/guestfish-actions.pod:1546 ../fish/guestfish-actions.pod:1556
7423 #: ../fish/guestfish-actions.pod:1575 ../fish/guestfish-actions.pod:3537
7424 #: ../fish/guestfish-actions.pod:3552 ../fish/guestfish-actions.pod:3628
7425 #: ../fish/guestfish-actions.pod:3645 ../fish/guestfish-actions.pod:3660
7426 #: ../fish/guestfish-actions.pod:4286 ../fish/guestfish-actions.pod:4332
7427 #: ../fish/guestfish-actions.pod:4417 ../fish/guestfish-actions.pod:4432
7428 #: ../fish/guestfish-actions.pod:4842 ../fish/guestfish-actions.pod:4860
7429 #: ../fish/guestfish-actions.pod:4877 ../fish/guestfish-actions.pod:4887
7430 #: ../fish/guestfish-actions.pod:4935 ../fish/guestfish-actions.pod:4945
7431 #: ../fish/guestfish-actions.pod:4974 ../fish/guestfish-actions.pod:4984
7433 "Because of the message protocol, there is a transfer limit of somewhere "
7434 "between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
7438 #: ../src/guestfs-actions.pod:881 ../src/guestfs-actions.pod:3564
7439 #: ../src/guestfs-actions.pod:3626 ../src/guestfs-actions.pod:3643
7440 #: ../src/guestfs-actions.pod:3731 ../src/guestfs-actions.pod:4136
7441 #: ../src/guestfs-actions.pod:4150 ../src/guestfs-actions.pod:5354
7442 #: ../src/guestfs-actions.pod:5368 ../src/guestfs-actions.pod:7129
7443 #: ../src/guestfs-actions.pod:7143
7444 msgid "(Added in 0.4)"
7448 #: ../src/guestfs-actions.pod:883
7449 msgid "guestfs_checksum"
7453 #: ../src/guestfs-actions.pod:885
7457 " guestfs_checksum (guestfs_h *g,\n"
7458 " const char *csumtype,\n"
7459 " const char *path);\n"
7464 #: ../src/guestfs-actions.pod:890 ../fish/guestfish-actions.pod:594
7466 "This call computes the MD5, SHAx or CRC checksum of the file named C<path>."
7470 #: ../src/guestfs-actions.pod:893 ../fish/guestfish-actions.pod:597
7472 "The type of checksum to compute is given by the C<csumtype> parameter which "
7473 "must have one of the following values:"
7477 #: ../src/guestfs-actions.pod:898 ../fish/guestfish-actions.pod:602
7482 #: ../src/guestfs-actions.pod:900 ../fish/guestfish-actions.pod:604
7484 "Compute the cyclic redundancy check (CRC) specified by POSIX for the "
7489 #: ../src/guestfs-actions.pod:903 ../fish/guestfish-actions.pod:607
7494 #: ../src/guestfs-actions.pod:905 ../fish/guestfish-actions.pod:609
7495 msgid "Compute the MD5 hash (using the C<md5sum> program)."
7499 #: ../src/guestfs-actions.pod:907 ../fish/guestfish-actions.pod:611
7504 #: ../src/guestfs-actions.pod:909 ../fish/guestfish-actions.pod:613
7505 msgid "Compute the SHA1 hash (using the C<sha1sum> program)."
7509 #: ../src/guestfs-actions.pod:911 ../fish/guestfish-actions.pod:615
7514 #: ../src/guestfs-actions.pod:913 ../fish/guestfish-actions.pod:617
7515 msgid "Compute the SHA224 hash (using the C<sha224sum> program)."
7519 #: ../src/guestfs-actions.pod:915 ../fish/guestfish-actions.pod:619
7524 #: ../src/guestfs-actions.pod:917 ../fish/guestfish-actions.pod:621
7525 msgid "Compute the SHA256 hash (using the C<sha256sum> program)."
7529 #: ../src/guestfs-actions.pod:919 ../fish/guestfish-actions.pod:623
7534 #: ../src/guestfs-actions.pod:921 ../fish/guestfish-actions.pod:625
7535 msgid "Compute the SHA384 hash (using the C<sha384sum> program)."
7539 #: ../src/guestfs-actions.pod:923 ../fish/guestfish-actions.pod:627
7544 #: ../src/guestfs-actions.pod:925 ../fish/guestfish-actions.pod:629
7545 msgid "Compute the SHA512 hash (using the C<sha512sum> program)."
7549 #: ../src/guestfs-actions.pod:929 ../fish/guestfish-actions.pod:633
7550 msgid "The checksum is returned as a printable string."
7554 #: ../src/guestfs-actions.pod:931
7555 msgid "To get the checksum for a device, use C<guestfs_checksum_device>."
7559 #: ../src/guestfs-actions.pod:933
7560 msgid "To get the checksums for many files, use C<guestfs_checksums_out>."
7564 #: ../src/guestfs-actions.pod:938 ../src/guestfs-actions.pod:1246
7565 #: ../src/guestfs-actions.pod:2083 ../src/guestfs-actions.pod:3303
7566 #: ../src/guestfs-actions.pod:3332 ../src/guestfs-actions.pod:3393
7567 #: ../src/guestfs-actions.pod:3420 ../src/guestfs-actions.pod:6826
7568 msgid "(Added in 1.0.2)"
7572 #: ../src/guestfs-actions.pod:940
7573 msgid "guestfs_checksum_device"
7577 #: ../src/guestfs-actions.pod:942
7581 " guestfs_checksum_device (guestfs_h *g,\n"
7582 " const char *csumtype,\n"
7583 " const char *device);\n"
7588 #: ../src/guestfs-actions.pod:947
7590 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
7591 "device named C<device>. For the types of checksums supported see the "
7592 "C<guestfs_checksum> command."
7596 #: ../src/guestfs-actions.pod:954 ../src/guestfs-actions.pod:4885
7597 #: ../src/guestfs-actions.pod:4944 ../src/guestfs-actions.pod:4981
7598 #: ../src/guestfs-actions.pod:4999 ../src/guestfs-actions.pod:5175
7599 #: ../src/guestfs-actions.pod:6735 ../src/guestfs-actions.pod:6749
7600 #: ../src/guestfs-actions.pod:7155
7601 msgid "(Added in 1.3.2)"
7605 #: ../src/guestfs-actions.pod:956
7606 msgid "guestfs_checksums_out"
7610 #: ../src/guestfs-actions.pod:958
7614 " guestfs_checksums_out (guestfs_h *g,\n"
7615 " const char *csumtype,\n"
7616 " const char *directory,\n"
7617 " const char *sumsfile);\n"
7622 #: ../src/guestfs-actions.pod:964 ../fish/guestfish-actions.pod:651
7624 "This command computes the checksums of all regular files in C<directory> and "
7625 "then emits a list of those checksums to the local output file C<sumsfile>."
7629 #: ../src/guestfs-actions.pod:968 ../fish/guestfish-actions.pod:655
7631 "This can be used for verifying the integrity of a virtual machine. However "
7632 "to be properly secure you should pay attention to the output of the checksum "
7633 "command (it uses the ones from GNU coreutils). In particular when the "
7634 "filename is not printable, coreutils uses a special backslash syntax. For "
7635 "more information, see the GNU coreutils info file."
7639 #: ../src/guestfs-actions.pod:978
7640 msgid "(Added in 1.3.7)"
7644 #: ../src/guestfs-actions.pod:980
7645 msgid "guestfs_chmod"
7649 #: ../src/guestfs-actions.pod:982
7653 " guestfs_chmod (guestfs_h *g,\n"
7655 " const char *path);\n"
7660 #: ../src/guestfs-actions.pod:987 ../fish/guestfish-actions.pod:669
7662 "Change the mode (permissions) of C<path> to C<mode>. Only numeric modes are "
7667 #: ../src/guestfs-actions.pod:990 ../fish/guestfish-actions.pod:672
7669 "I<Note>: When using this command from guestfish, C<mode> by default would be "
7670 "decimal, unless you prefix it with C<0> to get octal, ie. use C<0700> not "
7675 #: ../src/guestfs-actions.pod:994 ../src/guestfs-actions.pod:4387
7676 #: ../src/guestfs-actions.pod:4584 ../src/guestfs-actions.pod:4603
7677 #: ../src/guestfs-actions.pod:4622 ../fish/guestfish-actions.pod:676
7678 #: ../fish/guestfish-actions.pod:2983 ../fish/guestfish-actions.pod:3112
7679 #: ../fish/guestfish-actions.pod:3122 ../fish/guestfish-actions.pod:3132
7680 msgid "The mode actually set is affected by the umask."
7684 #: ../src/guestfs-actions.pod:1000
7685 msgid "guestfs_chown"
7689 #: ../src/guestfs-actions.pod:1002
7693 " guestfs_chown (guestfs_h *g,\n"
7696 " const char *path);\n"
7701 #: ../src/guestfs-actions.pod:1008 ../fish/guestfish-actions.pod:682
7702 msgid "Change the file owner to C<owner> and group to C<group>."
7706 #: ../src/guestfs-actions.pod:1010 ../src/guestfs-actions.pod:3495
7707 #: ../fish/guestfish-actions.pod:684 ../fish/guestfish-actions.pod:2441
7709 "Only numeric uid and gid are supported. If you want to use names, you will "
7710 "need to locate and parse the password file yourself (Augeas support makes "
7711 "this relatively easy)."
7715 #: ../src/guestfs-actions.pod:1018
7716 msgid "guestfs_command"
7720 #: ../src/guestfs-actions.pod:1020
7724 " guestfs_command (guestfs_h *g,\n"
7725 " char *const *arguments);\n"
7730 #: ../src/guestfs-actions.pod:1024 ../fish/guestfish-actions.pod:692
7732 "This call runs a command from the guest filesystem. The filesystem must be "
7733 "mounted, and must contain a compatible operating system (ie. something "
7734 "Linux, with the same or compatible processor architecture)."
7738 #: ../src/guestfs-actions.pod:1029
7740 "The single parameter is an argv-style list of arguments. The first element "
7741 "is the name of the program to run. Subsequent elements are parameters. The "
7742 "list must be non-empty (ie. must contain a program name). Note that the "
7743 "command runs directly, and is I<not> invoked via the shell (see "
7748 #: ../src/guestfs-actions.pod:1036 ../fish/guestfish-actions.pod:704
7749 msgid "The return value is anything printed to I<stdout> by the command."
7753 #: ../src/guestfs-actions.pod:1039 ../fish/guestfish-actions.pod:707
7755 "If the command returns a non-zero exit status, then this function returns an "
7756 "error message. The error message string is the content of I<stderr> from "
7761 #: ../src/guestfs-actions.pod:1043 ../fish/guestfish-actions.pod:711
7763 "The C<$PATH> environment variable will contain at least C</usr/bin> and C</"
7764 "bin>. If you require a program from another location, you should provide "
7765 "the full path in the first parameter."
7769 #: ../src/guestfs-actions.pod:1048 ../fish/guestfish-actions.pod:716
7771 "Shared libraries and data files required by the program must be available on "
7772 "filesystems which are mounted in the correct places. It is the caller's "
7773 "responsibility to ensure all filesystems that are needed are mounted at the "
7778 #: ../src/guestfs-actions.pod:1060 ../src/guestfs-actions.pod:1080
7779 #: ../src/guestfs-actions.pod:1548
7780 msgid "(Added in 0.9.1)"
7784 #: ../src/guestfs-actions.pod:1062
7785 msgid "guestfs_command_lines"
7789 #: ../src/guestfs-actions.pod:1064
7793 " guestfs_command_lines (guestfs_h *g,\n"
7794 " char *const *arguments);\n"
7799 #: ../src/guestfs-actions.pod:1068
7801 "This is the same as C<guestfs_command>, but splits the result into a list of "
7806 #: ../src/guestfs-actions.pod:1071
7807 msgid "See also: C<guestfs_sh_lines>"
7811 #: ../src/guestfs-actions.pod:1082
7812 msgid "guestfs_config"
7816 #: ../src/guestfs-actions.pod:1084
7820 " guestfs_config (guestfs_h *g,\n"
7821 " const char *qemuparam,\n"
7822 " const char *qemuvalue);\n"
7827 #: ../src/guestfs-actions.pod:1089 ../fish/guestfish-actions.pod:741
7829 "This can be used to add arbitrary qemu command line parameters of the form "
7830 "C<-param value>. Actually it's not quite arbitrary - we prevent you from "
7831 "setting some parameters which would interfere with parameters that we use."
7835 #: ../src/guestfs-actions.pod:1094 ../fish/guestfish-actions.pod:746
7836 msgid "The first character of C<param> string must be a C<-> (dash)."
7840 #: ../src/guestfs-actions.pod:1096 ../fish/guestfish-actions.pod:748
7841 msgid "C<value> can be NULL."
7845 #: ../src/guestfs-actions.pod:1102
7846 msgid "guestfs_copy_size"
7850 #: ../src/guestfs-actions.pod:1104
7854 " guestfs_copy_size (guestfs_h *g,\n"
7855 " const char *src,\n"
7856 " const char *dest,\n"
7862 #: ../src/guestfs-actions.pod:1110 ../fish/guestfish-actions.pod:754
7864 "This command copies exactly C<size> bytes from one source device or file "
7865 "C<src> to another destination device or file C<dest>."
7869 #: ../src/guestfs-actions.pod:1113 ../fish/guestfish-actions.pod:757
7871 "Note this will fail if the source is too short or if the destination is not "
7876 #: ../src/guestfs-actions.pod:1118 ../src/guestfs-actions.pod:1241
7877 #: ../src/guestfs-actions.pod:1272 ../src/guestfs-actions.pod:1317
7878 #: ../src/guestfs-actions.pod:1697 ../src/guestfs-actions.pod:1719
7879 #: ../src/guestfs-actions.pod:3476 ../src/guestfs-actions.pod:6821
7880 #: ../src/guestfs-actions.pod:6855 ../src/guestfs-actions.pod:7334
7881 #: ../src/guestfs-actions.pod:7353
7883 "This long-running command can generate progress notification messages so "
7884 "that the caller can display a progress bar or indicator. To receive these "
7885 "messages, the caller must register a progress event callback. See L<guestfs"
7886 "(3)/GUESTFS_EVENT_PROGRESS>."
7890 #: ../src/guestfs-actions.pod:1123 ../src/guestfs-actions.pod:4163
7891 #: ../src/guestfs-actions.pod:5381 ../src/guestfs-actions.pod:7062
7892 #: ../src/guestfs-actions.pod:7082 ../src/guestfs-actions.pod:7168
7893 msgid "(Added in 1.0.87)"
7897 #: ../src/guestfs-actions.pod:1125
7902 #: ../src/guestfs-actions.pod:1127
7906 " guestfs_cp (guestfs_h *g,\n"
7907 " const char *src,\n"
7908 " const char *dest);\n"
7913 #: ../src/guestfs-actions.pod:1132 ../fish/guestfish-actions.pod:764
7915 "This copies a file from C<src> to C<dest> where C<dest> is either a "
7916 "destination filename or destination directory."
7920 #: ../src/guestfs-actions.pod:1137 ../src/guestfs-actions.pod:1151
7921 #: ../src/guestfs-actions.pod:1223 ../src/guestfs-actions.pod:1297
7922 #: ../src/guestfs-actions.pod:1411 ../src/guestfs-actions.pod:4848
7923 #: ../src/guestfs-actions.pod:5225
7924 msgid "(Added in 1.0.18)"
7928 #: ../src/guestfs-actions.pod:1139
7929 msgid "guestfs_cp_a"
7933 #: ../src/guestfs-actions.pod:1141
7937 " guestfs_cp_a (guestfs_h *g,\n"
7938 " const char *src,\n"
7939 " const char *dest);\n"
7944 #: ../src/guestfs-actions.pod:1146 ../fish/guestfish-actions.pod:771
7946 "This copies a file or directory from C<src> to C<dest> recursively using the "
7951 #: ../src/guestfs-actions.pod:1153
7956 #: ../src/guestfs-actions.pod:1155
7960 " guestfs_dd (guestfs_h *g,\n"
7961 " const char *src,\n"
7962 " const char *dest);\n"
7967 #: ../src/guestfs-actions.pod:1160 ../fish/guestfish-actions.pod:778
7969 "This command copies from one source device or file C<src> to another "
7970 "destination device or file C<dest>. Normally you would use this to copy to "
7971 "or from a device or partition, for example to duplicate a filesystem."
7975 #: ../src/guestfs-actions.pod:1165
7977 "If the destination is a device, it must be as large or larger than the "
7978 "source file or device, otherwise the copy will fail. This command cannot do "
7979 "partial copies (see C<guestfs_copy_size>)."
7983 #: ../src/guestfs-actions.pod:1173
7988 #: ../src/guestfs-actions.pod:1175
7992 " guestfs_df (guestfs_h *g);\n"
7997 #: ../src/guestfs-actions.pod:1178 ../fish/guestfish-actions.pod:791
7998 msgid "This command runs the C<df> command to report disk space used."
8002 #: ../src/guestfs-actions.pod:1180 ../src/guestfs-actions.pod:1197
8004 "This command is mostly useful for interactive sessions. It is I<not> "
8005 "intended that you try to parse the output string. Use C<guestfs_statvfs> "
8010 #: ../src/guestfs-actions.pod:1187 ../src/guestfs-actions.pod:1204
8011 #: ../src/guestfs-actions.pod:1322 ../src/guestfs-actions.pod:2286
8012 #: ../src/guestfs-actions.pod:2310 ../src/guestfs-actions.pod:2378
8013 #: ../src/guestfs-actions.pod:4273 ../src/guestfs-actions.pod:4748
8014 #: ../src/guestfs-actions.pod:6559 ../src/guestfs-actions.pod:6583
8015 #: ../src/guestfs-actions.pod:7201 ../src/guestfs-actions.pod:7214
8016 #: ../src/guestfs-actions.pod:7227
8017 msgid "(Added in 1.0.54)"
8021 #: ../src/guestfs-actions.pod:1189
8022 msgid "guestfs_df_h"
8026 #: ../src/guestfs-actions.pod:1191
8030 " guestfs_df_h (guestfs_h *g);\n"
8035 #: ../src/guestfs-actions.pod:1194 ../fish/guestfish-actions.pod:801
8037 "This command runs the C<df -h> command to report disk space used in human-"
8042 #: ../src/guestfs-actions.pod:1206
8043 msgid "guestfs_dmesg"
8047 #: ../src/guestfs-actions.pod:1208
8051 " guestfs_dmesg (guestfs_h *g);\n"
8056 #: ../src/guestfs-actions.pod:1211 ../fish/guestfish-actions.pod:812
8058 "This returns the kernel messages (C<dmesg> output) from the guest kernel. "
8059 "This is sometimes useful for extended debugging of problems."
8063 #: ../src/guestfs-actions.pod:1215
8065 "Another way to get the same information is to enable verbose messages with "
8066 "C<guestfs_set_verbose> or by setting the environment variable "
8067 "C<LIBGUESTFS_DEBUG=1> before running the program."
8071 #: ../src/guestfs-actions.pod:1225
8072 msgid "guestfs_download"
8076 #: ../src/guestfs-actions.pod:1227
8080 " guestfs_download (guestfs_h *g,\n"
8081 " const char *remotefilename,\n"
8082 " const char *filename);\n"
8087 #: ../src/guestfs-actions.pod:1232 ../src/guestfs-actions.pod:1257
8088 #: ../fish/guestfish-actions.pod:825 ../fish/guestfish-actions.pod:838
8090 "Download file C<remotefilename> and save it as C<filename> on the local "
8095 #: ../src/guestfs-actions.pod:1235 ../src/guestfs-actions.pod:6815
8096 #: ../fish/guestfish-actions.pod:828 ../fish/guestfish-actions.pod:4590
8097 msgid "C<filename> can also be a named pipe."
8101 #: ../src/guestfs-actions.pod:1237
8102 msgid "See also C<guestfs_upload>, C<guestfs_cat>."
8106 #: ../src/guestfs-actions.pod:1248
8107 msgid "guestfs_download_offset"
8111 #: ../src/guestfs-actions.pod:1250
8115 " guestfs_download_offset (guestfs_h *g,\n"
8116 " const char *remotefilename,\n"
8117 " const char *filename,\n"
8118 " int64_t offset,\n"
8124 #: ../src/guestfs-actions.pod:1260 ../fish/guestfish-actions.pod:841
8126 "C<remotefilename> is read for C<size> bytes starting at C<offset> (this "
8127 "region must be within the file or device)."
8131 #: ../src/guestfs-actions.pod:1263
8133 "Note that there is no limit on the amount of data that can be downloaded "
8134 "with this call, unlike with C<guestfs_pread>, and this call always reads the "
8135 "full amount unless an error occurs."
8139 #: ../src/guestfs-actions.pod:1268
8140 msgid "See also C<guestfs_download>, C<guestfs_pread>."
8144 #: ../src/guestfs-actions.pod:1277 ../src/guestfs-actions.pod:6860
8145 msgid "(Added in 1.5.17)"
8149 #: ../src/guestfs-actions.pod:1279
8150 msgid "guestfs_drop_caches"
8154 #: ../src/guestfs-actions.pod:1281
8158 " guestfs_drop_caches (guestfs_h *g,\n"
8159 " int whattodrop);\n"
8164 #: ../src/guestfs-actions.pod:1285 ../fish/guestfish-actions.pod:857
8166 "This instructs the guest kernel to drop its page cache, and/or dentries and "
8167 "inode caches. The parameter C<whattodrop> tells the kernel what precisely "
8168 "to drop, see L<http://linux-mm.org/Drop_Caches>"
8172 #: ../src/guestfs-actions.pod:1290 ../fish/guestfish-actions.pod:862
8173 msgid "Setting C<whattodrop> to 3 should drop everything."
8177 #: ../src/guestfs-actions.pod:1292 ../fish/guestfish-actions.pod:864
8179 "This automatically calls L<sync(2)> before the operation, so that the "
8180 "maximum guest memory is freed."
8184 #: ../src/guestfs-actions.pod:1299
8189 #: ../src/guestfs-actions.pod:1301
8193 " guestfs_du (guestfs_h *g,\n"
8194 " const char *path);\n"
8199 #: ../src/guestfs-actions.pod:1305 ../fish/guestfish-actions.pod:871
8201 "This command runs the C<du -s> command to estimate file space usage for "
8206 #: ../src/guestfs-actions.pod:1308 ../fish/guestfish-actions.pod:874
8208 "C<path> can be a file or a directory. If C<path> is a directory then the "
8209 "estimate includes the contents of the directory and all subdirectories "
8214 #: ../src/guestfs-actions.pod:1312 ../fish/guestfish-actions.pod:878
8216 "The result is the estimated size in I<kilobytes> (ie. units of 1024 bytes)."
8220 #: ../src/guestfs-actions.pod:1324
8221 msgid "guestfs_e2fsck_f"
8225 #: ../src/guestfs-actions.pod:1326
8229 " guestfs_e2fsck_f (guestfs_h *g,\n"
8230 " const char *device);\n"
8235 #: ../src/guestfs-actions.pod:1330 ../fish/guestfish-actions.pod:885
8237 "This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3 filesystem checker "
8238 "on C<device>, noninteractively (C<-p>), even if the filesystem appears to be "
8243 #: ../src/guestfs-actions.pod:1334
8245 "This command is only needed because of C<guestfs_resize2fs> (q.v.). "
8246 "Normally you should use C<guestfs_fsck>."
8250 #: ../src/guestfs-actions.pod:1339
8251 msgid "(Added in 1.0.29)"
8255 #: ../src/guestfs-actions.pod:1341
8256 msgid "guestfs_echo_daemon"
8260 #: ../src/guestfs-actions.pod:1343
8264 " guestfs_echo_daemon (guestfs_h *g,\n"
8265 " char *const *words);\n"
8270 #: ../src/guestfs-actions.pod:1347 ../fish/guestfish-actions.pod:896
8272 "This command concatenates the list of C<words> passed with single spaces "
8273 "between them and returns the resulting string."
8277 #: ../src/guestfs-actions.pod:1350 ../fish/guestfish-actions.pod:899
8278 msgid "You can use this command to test the connection through to the daemon."
8282 #: ../src/guestfs-actions.pod:1352
8283 msgid "See also C<guestfs_ping_daemon>."
8287 #: ../src/guestfs-actions.pod:1357 ../src/guestfs-actions.pod:2094
8288 #: ../src/guestfs-actions.pod:6059
8289 msgid "(Added in 1.0.69)"
8293 #: ../src/guestfs-actions.pod:1359
8294 msgid "guestfs_egrep"
8298 #: ../src/guestfs-actions.pod:1361
8302 " guestfs_egrep (guestfs_h *g,\n"
8303 " const char *regex,\n"
8304 " const char *path);\n"
8309 #: ../src/guestfs-actions.pod:1366 ../fish/guestfish-actions.pod:907
8311 "This calls the external C<egrep> program and returns the matching lines."
8315 #: ../src/guestfs-actions.pod:1376 ../src/guestfs-actions.pod:1395
8316 #: ../src/guestfs-actions.pod:1452 ../src/guestfs-actions.pod:1498
8317 #: ../src/guestfs-actions.pod:1517 ../src/guestfs-actions.pod:2224
8318 #: ../src/guestfs-actions.pod:2243 ../src/guestfs-actions.pod:2399
8319 #: ../src/guestfs-actions.pod:2412 ../src/guestfs-actions.pod:2427
8320 #: ../src/guestfs-actions.pod:2473 ../src/guestfs-actions.pod:2495
8321 #: ../src/guestfs-actions.pod:2508 ../src/guestfs-actions.pod:3656
8322 #: ../src/guestfs-actions.pod:3670 ../src/guestfs-actions.pod:3683
8323 #: ../src/guestfs-actions.pod:3697 ../src/guestfs-actions.pod:4683
8324 #: ../src/guestfs-actions.pod:5559 ../src/guestfs-actions.pod:5608
8325 #: ../src/guestfs-actions.pod:6427 ../src/guestfs-actions.pod:6439
8326 #: ../src/guestfs-actions.pod:6452 ../src/guestfs-actions.pod:6465
8327 #: ../src/guestfs-actions.pod:6487 ../src/guestfs-actions.pod:6500
8328 #: ../src/guestfs-actions.pod:6513 ../src/guestfs-actions.pod:6526
8329 #: ../src/guestfs-actions.pod:7297 ../src/guestfs-actions.pod:7316
8330 #: ../src/guestfs-actions.pod:7401 ../src/guestfs-actions.pod:7420
8331 #: ../src/guestfs-actions.pod:7466 ../src/guestfs-actions.pod:7485
8332 msgid "(Added in 1.0.66)"
8336 #: ../src/guestfs-actions.pod:1378
8337 msgid "guestfs_egrepi"
8341 #: ../src/guestfs-actions.pod:1380
8345 " guestfs_egrepi (guestfs_h *g,\n"
8346 " const char *regex,\n"
8347 " const char *path);\n"
8352 #: ../src/guestfs-actions.pod:1385 ../fish/guestfish-actions.pod:917
8354 "This calls the external C<egrep -i> program and returns the matching lines."
8358 #: ../src/guestfs-actions.pod:1397
8359 msgid "guestfs_equal"
8363 #: ../src/guestfs-actions.pod:1399
8367 " guestfs_equal (guestfs_h *g,\n"
8368 " const char *file1,\n"
8369 " const char *file2);\n"
8374 #: ../src/guestfs-actions.pod:1404 ../fish/guestfish-actions.pod:927
8376 "This compares the two files C<file1> and C<file2> and returns true if their "
8377 "content is exactly equal, or false otherwise."
8381 #: ../src/guestfs-actions.pod:1407 ../fish/guestfish-actions.pod:930
8382 msgid "The external L<cmp(1)> program is used for the comparison."
8386 #: ../src/guestfs-actions.pod:1413
8387 msgid "guestfs_exists"
8391 #: ../src/guestfs-actions.pod:1415
8395 " guestfs_exists (guestfs_h *g,\n"
8396 " const char *path);\n"
8401 #: ../src/guestfs-actions.pod:1419 ../fish/guestfish-actions.pod:936
8403 "This returns C<true> if and only if there is a file, directory (or anything) "
8404 "with the given C<path> name."
8408 #: ../src/guestfs-actions.pod:1422
8409 msgid "See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>."
8413 #: ../src/guestfs-actions.pod:1428
8414 msgid "guestfs_fallocate"
8418 #: ../src/guestfs-actions.pod:1430
8422 " guestfs_fallocate (guestfs_h *g,\n"
8423 " const char *path,\n"
8429 #: ../src/guestfs-actions.pod:1435 ../src/guestfs-actions.pod:1461
8430 #: ../fish/guestfish-actions.pod:945 ../fish/guestfish-actions.pod:964
8432 "This command preallocates a file (containing zero bytes) named C<path> of "
8433 "size C<len> bytes. If the file exists already, it is overwritten."
8437 #: ../src/guestfs-actions.pod:1439 ../fish/guestfish-actions.pod:949
8439 "Do not confuse this with the guestfish-specific C<alloc> command which "
8440 "allocates a file in the host and attaches it as a device."
8444 #: ../src/guestfs-actions.pod:1445 ../fish/guestfish-actions.pod:953
8446 "This function is deprecated. In new code, use the C<fallocate64> call "
8451 #: ../src/guestfs-actions.pod:1454
8452 msgid "guestfs_fallocate64"
8456 #: ../src/guestfs-actions.pod:1456
8460 " guestfs_fallocate64 (guestfs_h *g,\n"
8461 " const char *path,\n"
8467 #: ../src/guestfs-actions.pod:1465
8469 "Note that this call allocates disk blocks for the file. To create a sparse "
8470 "file use C<guestfs_truncate_size> instead."
8474 #: ../src/guestfs-actions.pod:1468
8476 "The deprecated call C<guestfs_fallocate> does the same, but owing to an "
8477 "oversight it only allowed 30 bit lengths to be specified, effectively "
8478 "limiting the maximum size of files created through that call to 1GB."
8482 #: ../src/guestfs-actions.pod:1473 ../fish/guestfish-actions.pod:976
8484 "Do not confuse this with the guestfish-specific C<alloc> and C<sparse> "
8485 "commands which create a file in the host and attach it as a device."
8489 #: ../src/guestfs-actions.pod:1479
8490 msgid "(Added in 1.3.17)"
8494 #: ../src/guestfs-actions.pod:1481
8495 msgid "guestfs_fgrep"
8499 #: ../src/guestfs-actions.pod:1483
8503 " guestfs_fgrep (guestfs_h *g,\n"
8504 " const char *pattern,\n"
8505 " const char *path);\n"
8510 #: ../src/guestfs-actions.pod:1488 ../fish/guestfish-actions.pod:984
8512 "This calls the external C<fgrep> program and returns the matching lines."
8516 #: ../src/guestfs-actions.pod:1500
8517 msgid "guestfs_fgrepi"
8521 #: ../src/guestfs-actions.pod:1502
8525 " guestfs_fgrepi (guestfs_h *g,\n"
8526 " const char *pattern,\n"
8527 " const char *path);\n"
8532 #: ../src/guestfs-actions.pod:1507 ../fish/guestfish-actions.pod:994
8534 "This calls the external C<fgrep -i> program and returns the matching lines."
8538 #: ../src/guestfs-actions.pod:1519
8539 msgid "guestfs_file"
8543 #: ../src/guestfs-actions.pod:1521
8547 " guestfs_file (guestfs_h *g,\n"
8548 " const char *path);\n"
8553 #: ../src/guestfs-actions.pod:1525 ../fish/guestfish-actions.pod:1004
8555 "This call uses the standard L<file(1)> command to determine the type or "
8556 "contents of the file."
8560 #: ../src/guestfs-actions.pod:1528 ../fish/guestfish-actions.pod:1007
8562 "This call will also transparently look inside various types of compressed "
8567 #: ../src/guestfs-actions.pod:1531 ../fish/guestfish-actions.pod:1010
8569 "The exact command which runs is C<file -zb path>. Note in particular that "
8570 "the filename is not prepended to the output (the C<-b> option)."
8574 #: ../src/guestfs-actions.pod:1535
8576 "This command can also be used on C</dev/> devices (and partitions, LV "
8577 "names). You can for example use this to determine if a device contains a "
8578 "filesystem, although it's usually better to use C<guestfs_vfs_type>."
8582 #: ../src/guestfs-actions.pod:1540 ../fish/guestfish-actions.pod:1019
8584 "If the C<path> does not begin with C</dev/> then this command only works for "
8585 "the content of regular files. For other file types (directory, symbolic "
8586 "link etc) it will just return the string C<directory> etc."
8590 #: ../src/guestfs-actions.pod:1550
8591 msgid "guestfs_file_architecture"
8595 #: ../src/guestfs-actions.pod:1552
8599 " guestfs_file_architecture (guestfs_h *g,\n"
8600 " const char *filename);\n"
8605 #: ../src/guestfs-actions.pod:1556 ../fish/guestfish-actions.pod:1028
8607 "This detects the architecture of the binary C<filename>, and returns it if "
8612 #: ../src/guestfs-actions.pod:1559 ../fish/guestfish-actions.pod:1031
8613 msgid "Currently defined architectures are:"
8617 #: ../src/guestfs-actions.pod:1563 ../fish/guestfish-actions.pod:1035
8622 #: ../src/guestfs-actions.pod:1565 ../fish/guestfish-actions.pod:1037
8624 "This string is returned for all 32 bit i386, i486, i586, i686 binaries "
8625 "irrespective of the precise processor requirements of the binary."
8629 #: ../src/guestfs-actions.pod:1568 ../fish/guestfish-actions.pod:1040
8634 #: ../src/guestfs-actions.pod:1570 ../fish/guestfish-actions.pod:1042
8635 msgid "64 bit x86-64."
8639 #: ../src/guestfs-actions.pod:1572 ../fish/guestfish-actions.pod:1044
8644 #: ../src/guestfs-actions.pod:1574 ../fish/guestfish-actions.pod:1046
8645 msgid "32 bit SPARC."
8649 #: ../src/guestfs-actions.pod:1576 ../fish/guestfish-actions.pod:1048
8654 #: ../src/guestfs-actions.pod:1578 ../fish/guestfish-actions.pod:1050
8655 msgid "64 bit SPARC V9 and above."
8659 #: ../src/guestfs-actions.pod:1580 ../fish/guestfish-actions.pod:1052
8664 #: ../src/guestfs-actions.pod:1582 ../fish/guestfish-actions.pod:1054
8665 msgid "Intel Itanium."
8666 msgstr "Intel Itanium."
8669 #: ../src/guestfs-actions.pod:1584 ../fish/guestfish-actions.pod:1056
8674 #: ../src/guestfs-actions.pod:1586 ../fish/guestfish-actions.pod:1058
8675 msgid "32 bit Power PC."
8679 #: ../src/guestfs-actions.pod:1588 ../fish/guestfish-actions.pod:1060
8684 #: ../src/guestfs-actions.pod:1590 ../fish/guestfish-actions.pod:1062
8685 msgid "64 bit Power PC."
8689 #: ../src/guestfs-actions.pod:1594 ../fish/guestfish-actions.pod:1066
8690 msgid "Libguestfs may return other architecture strings in future."
8694 #: ../src/guestfs-actions.pod:1596 ../fish/guestfish-actions.pod:1068
8695 msgid "The function works on at least the following types of files:"
8699 #: ../src/guestfs-actions.pod:1602 ../fish/guestfish-actions.pod:1074
8700 msgid "many types of Un*x and Linux binary"
8704 #: ../src/guestfs-actions.pod:1606 ../fish/guestfish-actions.pod:1078
8705 msgid "many types of Un*x and Linux shared library"
8709 #: ../src/guestfs-actions.pod:1610 ../fish/guestfish-actions.pod:1082
8710 msgid "Windows Win32 and Win64 binaries"
8714 #: ../src/guestfs-actions.pod:1614 ../fish/guestfish-actions.pod:1086
8715 msgid "Windows Win32 and Win64 DLLs"
8719 #: ../src/guestfs-actions.pod:1616 ../fish/guestfish-actions.pod:1088
8720 msgid "Win32 binaries and DLLs return C<i386>."
8724 #: ../src/guestfs-actions.pod:1618 ../fish/guestfish-actions.pod:1090
8725 msgid "Win64 binaries and DLLs return C<x86_64>."
8729 #: ../src/guestfs-actions.pod:1622 ../fish/guestfish-actions.pod:1094
8730 msgid "Linux kernel modules"
8734 #: ../src/guestfs-actions.pod:1626 ../fish/guestfish-actions.pod:1098
8735 msgid "Linux new-style initrd images"
8739 #: ../src/guestfs-actions.pod:1630 ../fish/guestfish-actions.pod:1102
8740 msgid "some non-x86 Linux vmlinuz kernels"
8744 #: ../src/guestfs-actions.pod:1634 ../fish/guestfish-actions.pod:1106
8745 msgid "What it can't do currently:"
8749 #: ../src/guestfs-actions.pod:1640 ../fish/guestfish-actions.pod:1112
8750 msgid "static libraries (libfoo.a)"
8754 #: ../src/guestfs-actions.pod:1644 ../fish/guestfish-actions.pod:1116
8755 msgid "Linux old-style initrd as compressed ext2 filesystem (RHEL 3)"
8759 #: ../src/guestfs-actions.pod:1648 ../fish/guestfish-actions.pod:1120
8760 msgid "x86 Linux vmlinuz kernels"
8764 #: ../src/guestfs-actions.pod:1650 ../fish/guestfish-actions.pod:1122
8766 "x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and "
8767 "compressed code, and are horribly hard to unpack. If you want to find the "
8768 "architecture of a kernel, use the architecture of the associated initrd or "
8769 "kernel module(s) instead."
8773 #: ../src/guestfs-actions.pod:1660 ../src/guestfs-actions.pod:1823
8774 #: ../src/guestfs-actions.pod:1840 ../src/guestfs-actions.pod:2531
8775 #: ../src/guestfs-actions.pod:2624 ../src/guestfs-actions.pod:2694
8776 #: ../src/guestfs-actions.pod:2782 ../src/guestfs-actions.pod:2803
8777 #: ../src/guestfs-actions.pod:2846 ../src/guestfs-actions.pod:2930
8778 #: ../src/guestfs-actions.pod:3027 ../src/guestfs-actions.pod:3274
8779 #: ../src/guestfs-actions.pod:3406
8780 msgid "(Added in 1.5.3)"
8784 #: ../src/guestfs-actions.pod:1662
8785 msgid "guestfs_filesize"
8789 #: ../src/guestfs-actions.pod:1664
8793 " guestfs_filesize (guestfs_h *g,\n"
8794 " const char *file);\n"
8799 #: ../src/guestfs-actions.pod:1668 ../fish/guestfish-actions.pod:1133
8800 msgid "This command returns the size of C<file> in bytes."
8804 #: ../src/guestfs-actions.pod:1670
8806 "To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>, "
8807 "C<guestfs_is_dir>, C<guestfs_is_file> etc. To get the size of block "
8808 "devices, use C<guestfs_blockdev_getsize64>."
8812 #: ../src/guestfs-actions.pod:1676
8813 msgid "(Added in 1.0.82)"
8817 #: ../src/guestfs-actions.pod:1678
8818 msgid "guestfs_fill"
8822 #: ../src/guestfs-actions.pod:1680
8826 " guestfs_fill (guestfs_h *g,\n"
8829 " const char *path);\n"
8834 #: ../src/guestfs-actions.pod:1686 ../fish/guestfish-actions.pod:1143
8836 "This command creates a new file called C<path>. The initial content of the "
8837 "file is C<len> octets of C<c>, where C<c> must be a number in the range C<"
8842 #: ../src/guestfs-actions.pod:1690
8844 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
8845 "C<guestfs_truncate_size>. To create a file with a pattern of repeating "
8846 "bytes use C<guestfs_fill_pattern>."
8850 #: ../src/guestfs-actions.pod:1702
8851 msgid "(Added in 1.0.79)"
8855 #: ../src/guestfs-actions.pod:1704
8856 msgid "guestfs_fill_pattern"
8860 #: ../src/guestfs-actions.pod:1706
8864 " guestfs_fill_pattern (guestfs_h *g,\n"
8865 " const char *pattern,\n"
8867 " const char *path);\n"
8872 #: ../src/guestfs-actions.pod:1712
8874 "This function is like C<guestfs_fill> except that it creates a new file of "
8875 "length C<len> containing the repeating pattern of bytes in C<pattern>. The "
8876 "pattern is truncated if necessary to ensure the length of the file is "
8877 "exactly C<len> bytes."
8881 #: ../src/guestfs-actions.pod:1724
8882 msgid "(Added in 1.3.12)"
8886 #: ../src/guestfs-actions.pod:1726
8887 msgid "guestfs_find"
8891 #: ../src/guestfs-actions.pod:1728
8895 " guestfs_find (guestfs_h *g,\n"
8896 " const char *directory);\n"
8901 #: ../src/guestfs-actions.pod:1732 ../fish/guestfish-actions.pod:1165
8903 "This command lists out all files and directories, recursively, starting at "
8904 "C<directory>. It is essentially equivalent to running the shell command "
8905 "C<find directory -print> but some post-processing happens on the output, "
8910 #: ../src/guestfs-actions.pod:1737 ../fish/guestfish-actions.pod:1170
8912 "This returns a list of strings I<without any prefix>. Thus if the directory "
8917 #: ../src/guestfs-actions.pod:1740 ../fish/guestfish-actions.pod:1173
8927 #: ../src/guestfs-actions.pod:1744
8929 "then the returned list from C<guestfs_find> C</tmp> would be 4 elements:"
8933 #: ../src/guestfs-actions.pod:1747 ../fish/guestfish-actions.pod:1180
8944 #: ../src/guestfs-actions.pod:1752 ../fish/guestfish-actions.pod:1185
8945 msgid "If C<directory> is not a directory, then this command returns an error."
8949 #: ../src/guestfs-actions.pod:1755 ../fish/guestfish-actions.pod:1188
8950 msgid "The returned list is sorted."
8954 #: ../src/guestfs-actions.pod:1757
8955 msgid "See also C<guestfs_find0>."
8959 #: ../src/guestfs-actions.pod:1766 ../src/guestfs-actions.pod:4100
8960 #: ../src/guestfs-actions.pod:5643
8961 msgid "(Added in 1.0.27)"
8965 #: ../src/guestfs-actions.pod:1768
8966 msgid "guestfs_find0"
8970 #: ../src/guestfs-actions.pod:1770
8974 " guestfs_find0 (guestfs_h *g,\n"
8975 " const char *directory,\n"
8976 " const char *files);\n"
8981 #: ../src/guestfs-actions.pod:1775 ../fish/guestfish-actions.pod:1199
8983 "This command lists out all files and directories, recursively, starting at "
8984 "C<directory>, placing the resulting list in the external file called "
8989 #: ../src/guestfs-actions.pod:1779
8991 "This command works the same way as C<guestfs_find> with the following "
8996 #: ../src/guestfs-actions.pod:1786 ../fish/guestfish-actions.pod:1210
8997 msgid "The resulting list is written to an external file."
9001 #: ../src/guestfs-actions.pod:1790 ../fish/guestfish-actions.pod:1214
9003 "Items (filenames) in the result are separated by C<\\0> characters. See "
9004 "L<find(1)> option I<-print0>."
9008 #: ../src/guestfs-actions.pod:1795 ../fish/guestfish-actions.pod:1219
9009 msgid "This command is not limited in the number of names that it can return."
9013 #: ../src/guestfs-actions.pod:1800 ../fish/guestfish-actions.pod:1224
9014 msgid "The result list is not sorted."
9018 #: ../src/guestfs-actions.pod:1806
9019 msgid "(Added in 1.0.74)"
9023 #: ../src/guestfs-actions.pod:1808
9024 msgid "guestfs_findfs_label"
9028 #: ../src/guestfs-actions.pod:1810
9032 " guestfs_findfs_label (guestfs_h *g,\n"
9033 " const char *label);\n"
9038 #: ../src/guestfs-actions.pod:1814 ../fish/guestfish-actions.pod:1234
9040 "This command searches the filesystems and returns the one which has the "
9041 "given label. An error is returned if no such filesystem can be found."
9045 #: ../src/guestfs-actions.pod:1818
9046 msgid "To find the label of a filesystem, use C<guestfs_vfs_label>."
9050 #: ../src/guestfs-actions.pod:1825
9051 msgid "guestfs_findfs_uuid"
9055 #: ../src/guestfs-actions.pod:1827
9059 " guestfs_findfs_uuid (guestfs_h *g,\n"
9060 " const char *uuid);\n"
9065 #: ../src/guestfs-actions.pod:1831 ../fish/guestfish-actions.pod:1244
9067 "This command searches the filesystems and returns the one which has the "
9068 "given UUID. An error is returned if no such filesystem can be found."
9072 #: ../src/guestfs-actions.pod:1835
9073 msgid "To find the UUID of a filesystem, use C<guestfs_vfs_uuid>."
9077 #: ../src/guestfs-actions.pod:1842
9078 msgid "guestfs_fsck"
9082 #: ../src/guestfs-actions.pod:1844
9086 " guestfs_fsck (guestfs_h *g,\n"
9087 " const char *fstype,\n"
9088 " const char *device);\n"
9093 #: ../src/guestfs-actions.pod:1849 ../fish/guestfish-actions.pod:1254
9095 "This runs the filesystem checker (fsck) on C<device> which should have "
9096 "filesystem type C<fstype>."
9100 #: ../src/guestfs-actions.pod:1852 ../fish/guestfish-actions.pod:1257
9102 "The returned integer is the status. See L<fsck(8)> for the list of status "
9103 "codes from C<fsck>."
9107 #: ../src/guestfs-actions.pod:1861 ../fish/guestfish-actions.pod:1266
9108 msgid "Multiple status codes can be summed together."
9112 #: ../src/guestfs-actions.pod:1865 ../fish/guestfish-actions.pod:1270
9114 "A non-zero return code can mean \"success\", for example if errors have been "
9115 "corrected on the filesystem."
9119 #: ../src/guestfs-actions.pod:1870 ../fish/guestfish-actions.pod:1275
9120 msgid "Checking or repairing NTFS volumes is not supported (by linux-ntfs)."
9124 #: ../src/guestfs-actions.pod:1875 ../fish/guestfish-actions.pod:1280
9126 "This command is entirely equivalent to running C<fsck -a -t fstype device>."
9130 #: ../src/guestfs-actions.pod:1879 ../src/guestfs-actions.pod:7339
9131 msgid "(Added in 1.0.16)"
9135 #: ../src/guestfs-actions.pod:1881
9136 msgid "guestfs_get_append"
9140 #: ../src/guestfs-actions.pod:1883
9144 " guestfs_get_append (guestfs_h *g);\n"
9149 #: ../src/guestfs-actions.pod:1886 ../fish/guestfish-actions.pod:1286
9151 "Return the additional kernel options which are added to the guest kernel "
9156 #: ../src/guestfs-actions.pod:1889 ../fish/guestfish-actions.pod:1289
9157 msgid "If C<NULL> then no options are added."
9161 #: ../src/guestfs-actions.pod:1891
9163 "This function returns a string which may be NULL. There is no way to return "
9164 "an error from this function. The string is owned by the guest handle and "
9165 "must I<not> be freed."
9169 #: ../src/guestfs-actions.pod:1895 ../src/guestfs-actions.pod:5321
9170 #: ../src/guestfs-actions.pod:5801 ../src/guestfs-actions.pod:6201
9171 #: ../src/guestfs-actions.pod:6220 ../src/guestfs-actions.pod:6236
9172 #: ../src/guestfs-actions.pod:6253 ../src/guestfs-actions.pod:7010
9173 #: ../src/guestfs-actions.pod:7028 ../src/guestfs-actions.pod:7382
9174 msgid "(Added in 1.0.26)"
9178 #: ../src/guestfs-actions.pod:1897
9179 msgid "guestfs_get_attach_method"
9183 #: ../src/guestfs-actions.pod:1899
9187 " guestfs_get_attach_method (guestfs_h *g);\n"
9192 #: ../src/guestfs-actions.pod:1902
9193 msgid "Return the current attach method. See C<guestfs_set_attach_method>."
9197 #: ../src/guestfs-actions.pod:1907
9198 msgid "guestfs_get_autosync"
9202 #: ../src/guestfs-actions.pod:1909
9206 " guestfs_get_autosync (guestfs_h *g);\n"
9211 #: ../src/guestfs-actions.pod:1912 ../fish/guestfish-actions.pod:1301
9212 msgid "Get the autosync flag."
9216 #: ../src/guestfs-actions.pod:1918
9217 msgid "guestfs_get_direct"
9221 #: ../src/guestfs-actions.pod:1920
9225 " guestfs_get_direct (guestfs_h *g);\n"
9230 #: ../src/guestfs-actions.pod:1923 ../fish/guestfish-actions.pod:1307
9231 msgid "Return the direct appliance mode flag."
9235 #: ../src/guestfs-actions.pod:1927 ../src/guestfs-actions.pod:5870
9236 msgid "(Added in 1.0.72)"
9240 #: ../src/guestfs-actions.pod:1929
9241 msgid "guestfs_get_e2label"
9245 #: ../src/guestfs-actions.pod:1931
9249 " guestfs_get_e2label (guestfs_h *g,\n"
9250 " const char *device);\n"
9255 #: ../src/guestfs-actions.pod:1935 ../fish/guestfish-actions.pod:1313
9257 "This returns the ext2/3/4 filesystem label of the filesystem on C<device>."
9261 #: ../src/guestfs-actions.pod:1941 ../fish/guestfish-actions.pod:1316
9263 "This function is deprecated. In new code, use the C<vfs_label> call instead."
9267 #: ../src/guestfs-actions.pod:1948 ../src/guestfs-actions.pod:1969
9268 #: ../src/guestfs-actions.pod:5888 ../src/guestfs-actions.pod:5907
9269 msgid "(Added in 1.0.15)"
9273 #: ../src/guestfs-actions.pod:1950
9274 msgid "guestfs_get_e2uuid"
9278 #: ../src/guestfs-actions.pod:1952
9282 " guestfs_get_e2uuid (guestfs_h *g,\n"
9283 " const char *device);\n"
9288 #: ../src/guestfs-actions.pod:1956 ../fish/guestfish-actions.pod:1327
9290 "This returns the ext2/3/4 filesystem UUID of the filesystem on C<device>."
9294 #: ../src/guestfs-actions.pod:1962 ../fish/guestfish-actions.pod:1330
9296 "This function is deprecated. In new code, use the C<vfs_uuid> call instead."
9300 #: ../src/guestfs-actions.pod:1971
9301 msgid "guestfs_get_memsize"
9305 #: ../src/guestfs-actions.pod:1973
9309 " guestfs_get_memsize (guestfs_h *g);\n"
9314 #: ../src/guestfs-actions.pod:1976 ../fish/guestfish-actions.pod:1341
9316 "This gets the memory size in megabytes allocated to the qemu subprocess."
9320 #: ../src/guestfs-actions.pod:1979
9322 "If C<guestfs_set_memsize> was not called on this handle, and if "
9323 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
9324 "value for memsize."
9328 #: ../src/guestfs-actions.pod:1983 ../src/guestfs-actions.pod:2064
9329 #: ../src/guestfs-actions.pod:5923 ../src/guestfs-actions.pod:6030
9330 #: ../fish/guestfish-actions.pod:1348 ../fish/guestfish-actions.pod:1399
9331 #: ../fish/guestfish-actions.pod:3993 ../fish/guestfish-actions.pod:4080
9333 "For more information on the architecture of libguestfs, see L<guestfs(3)>."
9337 #: ../src/guestfs-actions.pod:1988 ../src/guestfs-actions.pod:4391
9338 #: ../src/guestfs-actions.pod:4588 ../src/guestfs-actions.pod:4607
9339 #: ../src/guestfs-actions.pod:4626 ../src/guestfs-actions.pod:4638
9340 #: ../src/guestfs-actions.pod:4655 ../src/guestfs-actions.pod:4668
9341 #: ../src/guestfs-actions.pod:5546 ../src/guestfs-actions.pod:5928
9342 #: ../src/guestfs-actions.pod:6175 ../src/guestfs-actions.pod:6776
9343 msgid "(Added in 1.0.55)"
9347 #: ../src/guestfs-actions.pod:1990
9348 msgid "guestfs_get_network"
9352 #: ../src/guestfs-actions.pod:1992
9356 " guestfs_get_network (guestfs_h *g);\n"
9361 #: ../src/guestfs-actions.pod:1995 ../fish/guestfish-actions.pod:1355
9362 msgid "This returns the enable network flag."
9366 #: ../src/guestfs-actions.pod:1999 ../src/guestfs-actions.pod:5947
9367 msgid "(Added in 1.5.4)"
9371 #: ../src/guestfs-actions.pod:2001
9372 msgid "guestfs_get_path"
9376 #: ../src/guestfs-actions.pod:2003
9380 " guestfs_get_path (guestfs_h *g);\n"
9385 #: ../src/guestfs-actions.pod:2006 ../fish/guestfish-actions.pod:1361
9386 msgid "Return the current search path."
9390 #: ../src/guestfs-actions.pod:2008 ../fish/guestfish-actions.pod:1363
9392 "This is always non-NULL. If it wasn't set already, then this will return "
9397 #: ../src/guestfs-actions.pod:2011 ../src/guestfs-actions.pod:2040
9399 "This function returns a string, or NULL on error. The string is owned by "
9400 "the guest handle and must I<not> be freed."
9404 #: ../src/guestfs-actions.pod:2016
9405 msgid "guestfs_get_pid"
9409 #: ../src/guestfs-actions.pod:2018
9413 " guestfs_get_pid (guestfs_h *g);\n"
9418 #: ../src/guestfs-actions.pod:2021 ../fish/guestfish-actions.pod:1372
9420 "Return the process ID of the qemu subprocess. If there is no qemu "
9421 "subprocess, then this will return an error."
9425 #: ../src/guestfs-actions.pod:2024 ../fish/guestfish-actions.pod:1375
9426 msgid "This is an internal call used for debugging and testing."
9430 #: ../src/guestfs-actions.pod:2028
9431 msgid "(Added in 1.0.56)"
9435 #: ../src/guestfs-actions.pod:2030
9436 msgid "guestfs_get_qemu"
9440 #: ../src/guestfs-actions.pod:2032
9444 " guestfs_get_qemu (guestfs_h *g);\n"
9449 #: ../src/guestfs-actions.pod:2035 ../fish/guestfish-actions.pod:1381
9450 msgid "Return the current qemu binary."
9454 #: ../src/guestfs-actions.pod:2037 ../fish/guestfish-actions.pod:1383
9456 "This is always non-NULL. If it wasn't set already, then this will return "
9457 "the default qemu binary name."
9461 #: ../src/guestfs-actions.pod:2043 ../src/guestfs-actions.pod:5992
9462 msgid "(Added in 1.0.6)"
9466 #: ../src/guestfs-actions.pod:2045
9467 msgid "guestfs_get_recovery_proc"
9471 #: ../src/guestfs-actions.pod:2047
9475 " guestfs_get_recovery_proc (guestfs_h *g);\n"
9480 #: ../src/guestfs-actions.pod:2050 ../fish/guestfish-actions.pod:1390
9481 msgid "Return the recovery process enabled flag."
9485 #: ../src/guestfs-actions.pod:2054 ../src/guestfs-actions.pod:3501
9486 #: ../src/guestfs-actions.pod:3798 ../src/guestfs-actions.pod:4198
9487 #: ../src/guestfs-actions.pod:4230 ../src/guestfs-actions.pod:5251
9488 #: ../src/guestfs-actions.pod:5594 ../src/guestfs-actions.pod:6016
9489 #: ../src/guestfs-actions.pod:6679 ../src/guestfs-actions.pod:6699
9490 #: ../src/guestfs-actions.pod:6891
9491 msgid "(Added in 1.0.77)"
9495 #: ../src/guestfs-actions.pod:2056
9496 msgid "guestfs_get_selinux"
9500 #: ../src/guestfs-actions.pod:2058
9504 " guestfs_get_selinux (guestfs_h *g);\n"
9509 #: ../src/guestfs-actions.pod:2061
9511 "This returns the current setting of the selinux flag which is passed to the "
9512 "appliance at boot time. See C<guestfs_set_selinux>."
9516 #: ../src/guestfs-actions.pod:2069 ../src/guestfs-actions.pod:2132
9517 #: ../src/guestfs-actions.pod:6035 ../src/guestfs-actions.pod:6093
9518 msgid "(Added in 1.0.67)"
9522 #: ../src/guestfs-actions.pod:2071
9523 msgid "guestfs_get_state"
9527 #: ../src/guestfs-actions.pod:2073
9531 " guestfs_get_state (guestfs_h *g);\n"
9536 #: ../src/guestfs-actions.pod:2076 ../fish/guestfish-actions.pod:1406
9538 "This returns the current state as an opaque integer. This is only useful "
9539 "for printing debug and internal error messages."
9543 #: ../src/guestfs-actions.pod:2079 ../src/guestfs-actions.pod:3299
9544 #: ../src/guestfs-actions.pod:3328 ../src/guestfs-actions.pod:3389
9545 #: ../src/guestfs-actions.pod:3416 ../fish/guestfish-actions.pod:1409
9546 #: ../fish/guestfish-actions.pod:2323 ../fish/guestfish-actions.pod:2341
9547 #: ../fish/guestfish-actions.pod:2379 ../fish/guestfish-actions.pod:2395
9548 msgid "For more information on states, see L<guestfs(3)>."
9552 #: ../src/guestfs-actions.pod:2085
9553 msgid "guestfs_get_trace"
9557 #: ../src/guestfs-actions.pod:2087
9561 " guestfs_get_trace (guestfs_h *g);\n"
9566 #: ../src/guestfs-actions.pod:2090 ../fish/guestfish-actions.pod:1415
9567 msgid "Return the command trace flag."
9571 #: ../src/guestfs-actions.pod:2096
9572 msgid "guestfs_get_umask"
9576 #: ../src/guestfs-actions.pod:2098
9580 " guestfs_get_umask (guestfs_h *g);\n"
9585 #: ../src/guestfs-actions.pod:2101
9587 "Return the current umask. By default the umask is C<022> unless it has been "
9588 "set by calling C<guestfs_umask>."
9592 #: ../src/guestfs-actions.pod:2108
9593 msgid "guestfs_get_verbose"
9597 #: ../src/guestfs-actions.pod:2110
9601 " guestfs_get_verbose (guestfs_h *g);\n"
9606 #: ../src/guestfs-actions.pod:2113 ../fish/guestfish-actions.pod:1428
9607 msgid "This returns the verbose messages flag."
9611 #: ../src/guestfs-actions.pod:2119
9612 msgid "guestfs_getcon"
9616 #: ../src/guestfs-actions.pod:2121
9620 " guestfs_getcon (guestfs_h *g);\n"
9625 #: ../src/guestfs-actions.pod:2124 ../fish/guestfish-actions.pod:1434
9626 msgid "This gets the SELinux security context of the daemon."
9630 #: ../src/guestfs-actions.pod:2126
9632 "See the documentation about SELINUX in L<guestfs(3)>, and C<guestfs_setcon>"
9636 #: ../src/guestfs-actions.pod:2134
9637 msgid "guestfs_getxattr"
9641 #: ../src/guestfs-actions.pod:2136
9645 " guestfs_getxattr (guestfs_h *g,\n"
9646 " const char *path,\n"
9647 " const char *name,\n"
9648 " size_t *size_r);\n"
9653 #: ../src/guestfs-actions.pod:2142
9655 "Get a single extended attribute from file C<path> named C<name>. This call "
9656 "follows symlinks. If you want to lookup an extended attribute for the "
9657 "symlink itself, use C<guestfs_lgetxattr>."
9661 #: ../src/guestfs-actions.pod:2146 ../src/guestfs-actions.pod:3515
9663 "Normally it is better to get all extended attributes from a file in one go "
9664 "by calling C<guestfs_getxattrs>. However some Linux filesystem "
9665 "implementations are buggy and do not provide a way to list out attributes. "
9666 "For these filesystems (notably ntfs-3g) you have to know the names of the "
9667 "extended attributes you want in advance and call this function."
9671 #: ../src/guestfs-actions.pod:2153 ../src/guestfs-actions.pod:3522
9672 #: ../fish/guestfish-actions.pod:1454 ../fish/guestfish-actions.pod:2460
9674 "Extended attribute values are blobs of binary data. If there is no extended "
9675 "attribute named C<name>, this returns an error."
9679 #: ../src/guestfs-actions.pod:2156
9680 msgid "See also: C<guestfs_getxattrs>, C<guestfs_lgetxattr>, L<attr(5)>."
9684 #: ../src/guestfs-actions.pod:2158 ../src/guestfs-actions.pod:2349
9685 #: ../src/guestfs-actions.pod:3527 ../src/guestfs-actions.pod:5244
9686 #: ../src/guestfs-actions.pod:5270 ../src/guestfs-actions.pod:5451
9688 "This function returns a buffer, or NULL on error. The size of the returned "
9689 "buffer is written to C<*size_r>. I<The caller must free the returned buffer "
9694 #: ../src/guestfs-actions.pod:2162 ../src/guestfs-actions.pod:3531
9695 msgid "(Added in 1.7.24)"
9699 #: ../src/guestfs-actions.pod:2164
9700 msgid "guestfs_getxattrs"
9704 #: ../src/guestfs-actions.pod:2166
9707 " struct guestfs_xattr_list *\n"
9708 " guestfs_getxattrs (guestfs_h *g,\n"
9709 " const char *path);\n"
9714 #: ../src/guestfs-actions.pod:2170 ../fish/guestfish-actions.pod:1463
9716 "This call lists the extended attributes of the file or directory C<path>."
9720 #: ../src/guestfs-actions.pod:2173 ../fish/guestfish-actions.pod:1466
9722 "At the system call level, this is a combination of the L<listxattr(2)> and "
9723 "L<getxattr(2)> calls."
9727 #: ../src/guestfs-actions.pod:2176
9728 msgid "See also: C<guestfs_lgetxattrs>, L<attr(5)>."
9732 #: ../src/guestfs-actions.pod:2178 ../src/guestfs-actions.pod:3543
9733 #: ../src/guestfs-actions.pod:4194
9735 "This function returns a C<struct guestfs_xattr_list *>, or NULL if there was "
9736 "an error. I<The caller must call C<guestfs_free_xattr_list> after use>."
9740 #: ../src/guestfs-actions.pod:2182 ../src/guestfs-actions.pod:3547
9741 #: ../src/guestfs-actions.pod:3712 ../src/guestfs-actions.pod:3748
9742 #: ../src/guestfs-actions.pod:5624 ../src/guestfs-actions.pod:6112
9743 #: ../src/guestfs-actions.pod:7447
9744 msgid "(Added in 1.0.59)"
9748 #: ../src/guestfs-actions.pod:2184
9749 msgid "guestfs_glob_expand"
9753 #: ../src/guestfs-actions.pod:2186
9757 " guestfs_glob_expand (guestfs_h *g,\n"
9758 " const char *pattern);\n"
9763 #: ../src/guestfs-actions.pod:2190 ../fish/guestfish-actions.pod:1475
9765 "This command searches for all the pathnames matching C<pattern> according to "
9766 "the wildcard expansion rules used by the shell."
9770 #: ../src/guestfs-actions.pod:2194 ../fish/guestfish-actions.pod:1479
9772 "If no paths match, then this returns an empty list (note: not an error)."
9776 #: ../src/guestfs-actions.pod:2197 ../fish/guestfish-actions.pod:1482
9778 "It is just a wrapper around the C L<glob(3)> function with flags C<GLOB_MARK|"
9779 "GLOB_BRACE>. See that manual page for more details."
9783 #: ../src/guestfs-actions.pod:2205 ../src/guestfs-actions.pod:6277
9784 #: ../src/guestfs-actions.pod:6294
9785 msgid "(Added in 1.0.50)"
9789 #: ../src/guestfs-actions.pod:2207
9790 msgid "guestfs_grep"
9794 #: ../src/guestfs-actions.pod:2209
9798 " guestfs_grep (guestfs_h *g,\n"
9799 " const char *regex,\n"
9800 " const char *path);\n"
9805 #: ../src/guestfs-actions.pod:2214 ../fish/guestfish-actions.pod:1490
9806 msgid "This calls the external C<grep> program and returns the matching lines."
9810 #: ../src/guestfs-actions.pod:2226
9811 msgid "guestfs_grepi"
9815 #: ../src/guestfs-actions.pod:2228
9819 " guestfs_grepi (guestfs_h *g,\n"
9820 " const char *regex,\n"
9821 " const char *path);\n"
9826 #: ../src/guestfs-actions.pod:2233 ../fish/guestfish-actions.pod:1500
9828 "This calls the external C<grep -i> program and returns the matching lines."
9832 #: ../src/guestfs-actions.pod:2245
9833 msgid "guestfs_grub_install"
9837 #: ../src/guestfs-actions.pod:2247
9841 " guestfs_grub_install (guestfs_h *g,\n"
9842 " const char *root,\n"
9843 " const char *device);\n"
9848 #: ../src/guestfs-actions.pod:2252 ../fish/guestfish-actions.pod:1510
9850 "This command installs GRUB (the Grand Unified Bootloader) on C<device>, with "
9851 "the root directory being C<root>."
9855 #: ../src/guestfs-actions.pod:2255 ../fish/guestfish-actions.pod:1513
9857 "Note: If grub-install reports the error \"No suitable drive was found in the "
9858 "generated device map.\" it may be that you need to create a C</boot/grub/"
9859 "device.map> file first that contains the mapping between grub device names "
9860 "and Linux device names. It is usually sufficient to create a file "
9865 #: ../src/guestfs-actions.pod:2262 ../fish/guestfish-actions.pod:1520
9873 #: ../src/guestfs-actions.pod:2264 ../fish/guestfish-actions.pod:1522
9874 msgid "replacing C</dev/vda> with the name of the installation device."
9878 #: ../src/guestfs-actions.pod:2268
9879 msgid "(Added in 1.0.17)"
9883 #: ../src/guestfs-actions.pod:2270
9884 msgid "guestfs_head"
9888 #: ../src/guestfs-actions.pod:2272
9892 " guestfs_head (guestfs_h *g,\n"
9893 " const char *path);\n"
9898 #: ../src/guestfs-actions.pod:2276 ../fish/guestfish-actions.pod:1528
9900 "This command returns up to the first 10 lines of a file as a list of strings."
9904 #: ../src/guestfs-actions.pod:2288
9905 msgid "guestfs_head_n"
9909 #: ../src/guestfs-actions.pod:2290
9913 " guestfs_head_n (guestfs_h *g,\n"
9915 " const char *path);\n"
9920 #: ../src/guestfs-actions.pod:2295 ../fish/guestfish-actions.pod:1538
9922 "If the parameter C<nrlines> is a positive number, this returns the first "
9923 "C<nrlines> lines of the file C<path>."
9927 #: ../src/guestfs-actions.pod:2298 ../fish/guestfish-actions.pod:1541
9929 "If the parameter C<nrlines> is a negative number, this returns lines from "
9930 "the file C<path>, excluding the last C<nrlines> lines."
9934 #: ../src/guestfs-actions.pod:2301 ../src/guestfs-actions.pod:6574
9935 #: ../fish/guestfish-actions.pod:1544 ../fish/guestfish-actions.pod:4430
9936 msgid "If the parameter C<nrlines> is zero, this returns an empty list."
9940 #: ../src/guestfs-actions.pod:2312
9941 msgid "guestfs_hexdump"
9945 #: ../src/guestfs-actions.pod:2314
9949 " guestfs_hexdump (guestfs_h *g,\n"
9950 " const char *path);\n"
9955 #: ../src/guestfs-actions.pod:2318 ../fish/guestfish-actions.pod:1553
9957 "This runs C<hexdump -C> on the given C<path>. The result is the human-"
9958 "readable, canonical hex dump of the file."
9962 #: ../src/guestfs-actions.pod:2327 ../src/guestfs-actions.pod:6358
9963 #: ../src/guestfs-actions.pod:6413
9964 msgid "(Added in 1.0.22)"
9968 #: ../src/guestfs-actions.pod:2329
9969 msgid "guestfs_initrd_cat"
9973 #: ../src/guestfs-actions.pod:2331
9977 " guestfs_initrd_cat (guestfs_h *g,\n"
9978 " const char *initrdpath,\n"
9979 " const char *filename,\n"
9980 " size_t *size_r);\n"
9985 #: ../src/guestfs-actions.pod:2337 ../fish/guestfish-actions.pod:1563
9987 "This command unpacks the file C<filename> from the initrd file called "
9988 "C<initrdpath>. The filename must be given I<without> the initial C</> "
9993 #: ../src/guestfs-actions.pod:2341 ../fish/guestfish-actions.pod:1567
9995 "For example, in guestfish you could use the following command to examine the "
9996 "boot script (usually called C</init>) contained in a Linux initrd or "
10001 #: ../src/guestfs-actions.pod:2345 ../fish/guestfish-actions.pod:1571
10004 " initrd-cat /boot/initrd-<version>.img init\n"
10009 #: ../src/guestfs-actions.pod:2347
10010 msgid "See also C<guestfs_initrd_list>."
10014 #: ../src/guestfs-actions.pod:2358
10015 msgid "guestfs_initrd_list"
10019 #: ../src/guestfs-actions.pod:2360
10023 " guestfs_initrd_list (guestfs_h *g,\n"
10024 " const char *path);\n"
10029 #: ../src/guestfs-actions.pod:2364 ../fish/guestfish-actions.pod:1582
10030 msgid "This command lists out files contained in an initrd."
10034 #: ../src/guestfs-actions.pod:2366 ../fish/guestfish-actions.pod:1584
10036 "The files are listed without any initial C</> character. The files are "
10037 "listed in the order they appear (not necessarily alphabetical). Directory "
10038 "names are listed as separate items."
10042 #: ../src/guestfs-actions.pod:2370 ../fish/guestfish-actions.pod:1588
10044 "Old Linux kernels (2.4 and earlier) used a compressed ext2 filesystem as "
10045 "initrd. We I<only> support the newer initramfs format (compressed cpio "
10050 #: ../src/guestfs-actions.pod:2380
10051 msgid "guestfs_inotify_add_watch"
10055 #: ../src/guestfs-actions.pod:2382
10059 " guestfs_inotify_add_watch (guestfs_h *g,\n"
10060 " const char *path,\n"
10066 #: ../src/guestfs-actions.pod:2387 ../fish/guestfish-actions.pod:1596
10067 msgid "Watch C<path> for the events listed in C<mask>."
10071 #: ../src/guestfs-actions.pod:2389 ../fish/guestfish-actions.pod:1598
10073 "Note that if C<path> is a directory then events within that directory are "
10074 "watched, but this does I<not> happen recursively (in subdirectories)."
10078 #: ../src/guestfs-actions.pod:2393 ../fish/guestfish-actions.pod:1602
10080 "Note for non-C or non-Linux callers: the inotify events are defined by the "
10081 "Linux kernel ABI and are listed in C</usr/include/sys/inotify.h>."
10085 #: ../src/guestfs-actions.pod:2401
10086 msgid "guestfs_inotify_close"
10090 #: ../src/guestfs-actions.pod:2403
10094 " guestfs_inotify_close (guestfs_h *g);\n"
10099 #: ../src/guestfs-actions.pod:2406 ../fish/guestfish-actions.pod:1610
10101 "This closes the inotify handle which was previously opened by inotify_init. "
10102 "It removes all watches, throws away any pending events, and deallocates all "
10107 #: ../src/guestfs-actions.pod:2414
10108 msgid "guestfs_inotify_files"
10112 #: ../src/guestfs-actions.pod:2416
10116 " guestfs_inotify_files (guestfs_h *g);\n"
10121 #: ../src/guestfs-actions.pod:2419
10123 "This function is a helpful wrapper around C<guestfs_inotify_read> which just "
10124 "returns a list of pathnames of objects that were touched. The returned "
10125 "pathnames are sorted and deduplicated."
10129 #: ../src/guestfs-actions.pod:2429
10130 msgid "guestfs_inotify_init"
10134 #: ../src/guestfs-actions.pod:2431
10138 " guestfs_inotify_init (guestfs_h *g,\n"
10139 " int maxevents);\n"
10144 #: ../src/guestfs-actions.pod:2435 ../fish/guestfish-actions.pod:1626
10146 "This command creates a new inotify handle. The inotify subsystem can be "
10147 "used to notify events which happen to objects in the guest filesystem."
10151 #: ../src/guestfs-actions.pod:2439
10153 "C<maxevents> is the maximum number of events which will be queued up between "
10154 "calls to C<guestfs_inotify_read> or C<guestfs_inotify_files>. If this is "
10155 "passed as C<0>, then the kernel (or previously set) default is used. For "
10156 "Linux 2.6.29 the default was 16384 events. Beyond this limit, the kernel "
10157 "throws away events, but records the fact that it threw them away by setting "
10158 "a flag C<IN_Q_OVERFLOW> in the returned structure list (see "
10159 "C<guestfs_inotify_read>)."
10163 #: ../src/guestfs-actions.pod:2449
10165 "Before any events are generated, you have to add some watches to the "
10166 "internal watch list. See: C<guestfs_inotify_add_watch>, "
10167 "C<guestfs_inotify_rm_watch> and C<guestfs_inotify_watch_all>."
10171 #: ../src/guestfs-actions.pod:2455
10173 "Queued up events should be read periodically by calling "
10174 "C<guestfs_inotify_read> (or C<guestfs_inotify_files> which is just a helpful "
10175 "wrapper around C<guestfs_inotify_read>). If you don't read the events out "
10176 "often enough then you risk the internal queue overflowing."
10180 #: ../src/guestfs-actions.pod:2462
10182 "The handle should be closed after use by calling C<guestfs_inotify_close>. "
10183 "This also removes any watches automatically."
10187 #: ../src/guestfs-actions.pod:2466 ../fish/guestfish-actions.pod:1657
10189 "See also L<inotify(7)> for an overview of the inotify interface as exposed "
10190 "by the Linux kernel, which is roughly what we expose via libguestfs. Note "
10191 "that there is one global inotify handle per libguestfs instance."
10195 #: ../src/guestfs-actions.pod:2475
10196 msgid "guestfs_inotify_read"
10200 #: ../src/guestfs-actions.pod:2477
10203 " struct guestfs_inotify_event_list *\n"
10204 " guestfs_inotify_read (guestfs_h *g);\n"
10209 #: ../src/guestfs-actions.pod:2480 ../fish/guestfish-actions.pod:1666
10211 "Return the complete queue of events that have happened since the previous "
10216 #: ../src/guestfs-actions.pod:2483 ../fish/guestfish-actions.pod:1669
10217 msgid "If no events have happened, this returns an empty list."
10221 #: ../src/guestfs-actions.pod:2485 ../fish/guestfish-actions.pod:1671
10223 "I<Note>: In order to make sure that all events have been read, you must call "
10224 "this function repeatedly until it returns an empty list. The reason is that "
10225 "the call will read events up to the maximum appliance-to-host message size "
10226 "and leave remaining events in the queue."
10230 #: ../src/guestfs-actions.pod:2491
10232 "This function returns a C<struct guestfs_inotify_event_list *>, or NULL if "
10233 "there was an error. I<The caller must call "
10234 "C<guestfs_free_inotify_event_list> after use>."
10238 #: ../src/guestfs-actions.pod:2497
10239 msgid "guestfs_inotify_rm_watch"
10243 #: ../src/guestfs-actions.pod:2499
10247 " guestfs_inotify_rm_watch (guestfs_h *g,\n"
10253 #: ../src/guestfs-actions.pod:2503
10255 "Remove a previously defined inotify watch. See C<guestfs_inotify_add_watch>."
10259 #: ../src/guestfs-actions.pod:2510
10260 msgid "guestfs_inspect_get_arch"
10264 #: ../src/guestfs-actions.pod:2512
10268 " guestfs_inspect_get_arch (guestfs_h *g,\n"
10269 " const char *root);\n"
10274 #: ../src/guestfs-actions.pod:2516 ../src/guestfs-actions.pod:2539
10275 #: ../src/guestfs-actions.pod:2632 ../src/guestfs-actions.pod:2676
10276 #: ../src/guestfs-actions.pod:2702 ../src/guestfs-actions.pod:2741
10277 #: ../src/guestfs-actions.pod:2763 ../src/guestfs-actions.pod:2790
10278 #: ../src/guestfs-actions.pod:2811 ../src/guestfs-actions.pod:2854
10279 #: ../src/guestfs-actions.pod:2883 ../src/guestfs-actions.pod:2914
10280 #: ../src/guestfs-actions.pod:2938 ../src/guestfs-actions.pod:2993
10281 #: ../src/guestfs-actions.pod:3035 ../src/guestfs-actions.pod:3056
10282 #: ../src/guestfs-actions.pod:3079 ../src/guestfs-actions.pod:3096
10283 #: ../src/guestfs-actions.pod:3113 ../src/guestfs-actions.pod:3132
10285 "This function should only be called with a root device string as returned by "
10286 "C<guestfs_inspect_os>."
10290 #: ../src/guestfs-actions.pod:2519
10292 "This returns the architecture of the inspected operating system. The "
10293 "possible return values are listed under C<guestfs_file_architecture>."
10297 #: ../src/guestfs-actions.pod:2523 ../fish/guestfish-actions.pod:1695
10299 "If the architecture could not be determined, then the string C<unknown> is "
10304 #: ../src/guestfs-actions.pod:2526 ../src/guestfs-actions.pod:2619
10305 #: ../src/guestfs-actions.pod:2730 ../src/guestfs-actions.pod:2750
10306 #: ../src/guestfs-actions.pod:2778 ../src/guestfs-actions.pod:2870
10307 #: ../src/guestfs-actions.pod:2901 ../src/guestfs-actions.pod:2925
10308 #: ../src/guestfs-actions.pod:2979 ../src/guestfs-actions.pod:3022
10309 #: ../src/guestfs-actions.pod:3045 ../src/guestfs-actions.pod:3066
10310 #: ../src/guestfs-actions.pod:3086 ../src/guestfs-actions.pod:3103
10311 #: ../src/guestfs-actions.pod:3122 ../src/guestfs-actions.pod:3225
10312 #: ../src/guestfs-actions.pod:3266 ../fish/guestfish-actions.pod:1698
10313 #: ../fish/guestfish-actions.pod:1784 ../fish/guestfish-actions.pod:1872
10314 #: ../fish/guestfish-actions.pod:1887 ../fish/guestfish-actions.pod:1908
10315 #: ../fish/guestfish-actions.pod:1978 ../fish/guestfish-actions.pod:2002
10316 #: ../fish/guestfish-actions.pod:2019 ../fish/guestfish-actions.pod:2062
10317 #: ../fish/guestfish-actions.pod:2097 ../fish/guestfish-actions.pod:2113
10318 #: ../fish/guestfish-actions.pod:2129 ../fish/guestfish-actions.pod:2142
10319 #: ../fish/guestfish-actions.pod:2155 ../fish/guestfish-actions.pod:2170
10320 #: ../fish/guestfish-actions.pod:2269 ../fish/guestfish-actions.pod:2303
10321 msgid "Please read L<guestfs(3)/INSPECTION> for more details."
10325 #: ../src/guestfs-actions.pod:2533
10326 msgid "guestfs_inspect_get_distro"
10330 #: ../src/guestfs-actions.pod:2535
10334 " guestfs_inspect_get_distro (guestfs_h *g,\n"
10335 " const char *root);\n"
10340 #: ../src/guestfs-actions.pod:2542 ../fish/guestfish-actions.pod:1707
10342 "This returns the distro (distribution) of the inspected operating system."
10346 #: ../src/guestfs-actions.pod:2545 ../fish/guestfish-actions.pod:1710
10347 msgid "Currently defined distros are:"
10351 #: ../src/guestfs-actions.pod:2549 ../fish/guestfish-actions.pod:1714
10352 msgid "\"archlinux\""
10353 msgstr "\"archlinux\""
10356 #: ../src/guestfs-actions.pod:2551 ../fish/guestfish-actions.pod:1716
10357 msgid "Arch Linux."
10358 msgstr "Arch Linux."
10361 #: ../src/guestfs-actions.pod:2553 ../fish/guestfish-actions.pod:1718
10363 #| msgid "\"gentoo\""
10365 msgstr "\"gentoo\""
10368 #: ../src/guestfs-actions.pod:2555 ../fish/guestfish-actions.pod:1720
10373 #: ../src/guestfs-actions.pod:2557 ../fish/guestfish-actions.pod:1722
10375 msgstr "\"debian\""
10378 #: ../src/guestfs-actions.pod:2559 ../fish/guestfish-actions.pod:1724
10383 #: ../src/guestfs-actions.pod:2561 ../fish/guestfish-actions.pod:1726
10385 msgstr "\"fedora\""
10388 #: ../src/guestfs-actions.pod:2563 ../fish/guestfish-actions.pod:1728
10393 #: ../src/guestfs-actions.pod:2565 ../fish/guestfish-actions.pod:1730
10395 msgstr "\"gentoo\""
10398 #: ../src/guestfs-actions.pod:2567 ../fish/guestfish-actions.pod:1732
10403 #: ../src/guestfs-actions.pod:2569 ../fish/guestfish-actions.pod:1734
10404 msgid "\"linuxmint\""
10405 msgstr "\"linuxmint\""
10408 #: ../src/guestfs-actions.pod:2571 ../fish/guestfish-actions.pod:1736
10409 msgid "Linux Mint."
10410 msgstr "Linux Mint."
10413 #: ../src/guestfs-actions.pod:2573 ../fish/guestfish-actions.pod:1738
10414 msgid "\"mandriva\""
10415 msgstr "\"mandriva\""
10418 #: ../src/guestfs-actions.pod:2575 ../fish/guestfish-actions.pod:1740
10423 #: ../src/guestfs-actions.pod:2577 ../fish/guestfish-actions.pod:1742
10428 #: ../src/guestfs-actions.pod:2579 ../fish/guestfish-actions.pod:1744
10433 #: ../src/guestfs-actions.pod:2581 ../fish/guestfish-actions.pod:1746
10435 msgstr "\"pardus\""
10438 #: ../src/guestfs-actions.pod:2583 ../fish/guestfish-actions.pod:1748
10443 #: ../src/guestfs-actions.pod:2585 ../fish/guestfish-actions.pod:1750
10444 msgid "\"redhat-based\""
10445 msgstr "\"redhat-based\""
10448 #: ../src/guestfs-actions.pod:2587 ../fish/guestfish-actions.pod:1752
10449 msgid "Some Red Hat-derived distro."
10450 msgstr "Дистрибутив, що походить від Red Hat."
10453 #: ../src/guestfs-actions.pod:2589 ../fish/guestfish-actions.pod:1754
10458 #: ../src/guestfs-actions.pod:2591 ../fish/guestfish-actions.pod:1756
10460 #| msgid "Red Hat Enterprise Linux and some derivatives."
10461 msgid "Red Hat Enterprise Linux."
10462 msgstr "Red Hat Enterprise Linux та деякі з похідних дистрибутивів."
10465 #: ../src/guestfs-actions.pod:2593 ../fish/guestfish-actions.pod:1758
10466 msgid "\"scientificlinux\""
10470 #: ../src/guestfs-actions.pod:2595 ../fish/guestfish-actions.pod:1760
10471 msgid "Scientific Linux."
10475 #: ../src/guestfs-actions.pod:2597 ../fish/guestfish-actions.pod:1762
10476 msgid "\"slackware\""
10480 #: ../src/guestfs-actions.pod:2599 ../fish/guestfish-actions.pod:1764
10485 #: ../src/guestfs-actions.pod:2601 ../fish/guestfish-actions.pod:1766
10487 msgstr "\"ubuntu\""
10490 #: ../src/guestfs-actions.pod:2603 ../fish/guestfish-actions.pod:1768
10495 #: ../src/guestfs-actions.pod:2605 ../src/guestfs-actions.pod:2721
10496 #: ../src/guestfs-actions.pod:3013 ../fish/guestfish-actions.pod:1770
10497 #: ../fish/guestfish-actions.pod:1863 ../fish/guestfish-actions.pod:2088
10498 msgid "\"unknown\""
10499 msgstr "\"unknown\""
10502 #: ../src/guestfs-actions.pod:2607 ../fish/guestfish-actions.pod:1772
10503 msgid "The distro could not be determined."
10504 msgstr "Дистрибутив, тип якого не вдалося визначити."
10507 #: ../src/guestfs-actions.pod:2609 ../src/guestfs-actions.pod:3005
10508 #: ../fish/guestfish-actions.pod:1774 ../fish/guestfish-actions.pod:2080
10509 msgid "\"windows\""
10510 msgstr "\"windows\""
10513 #: ../src/guestfs-actions.pod:2611 ../fish/guestfish-actions.pod:1776
10515 "Windows does not have distributions. This string is returned if the OS type "
10520 #: ../src/guestfs-actions.pod:2616 ../src/guestfs-actions.pod:2727
10521 #: ../src/guestfs-actions.pod:3019 ../fish/guestfish-actions.pod:1781
10522 #: ../fish/guestfish-actions.pod:1869 ../fish/guestfish-actions.pod:2094
10524 "Future versions of libguestfs may return other strings here. The caller "
10525 "should be prepared to handle any string."
10529 #: ../src/guestfs-actions.pod:2626
10530 msgid "guestfs_inspect_get_drive_mappings"
10534 #: ../src/guestfs-actions.pod:2628
10538 " guestfs_inspect_get_drive_mappings (guestfs_h *g,\n"
10539 " const char *root);\n"
10544 #: ../src/guestfs-actions.pod:2635 ../fish/guestfish-actions.pod:1793
10546 "This call is useful for Windows which uses a primitive system of assigning "
10547 "drive letters (like \"C:\") to partitions. This inspection API examines the "
10548 "Windows Registry to find out how disks/partitions are mapped to drive "
10549 "letters, and returns a hash table as in the example below:"
10553 #: ../src/guestfs-actions.pod:2641 ../fish/guestfish-actions.pod:1799
10556 " C => /dev/vda2\n"
10557 " E => /dev/vdb1\n"
10558 " F => /dev/vdc1\n"
10563 #: ../src/guestfs-actions.pod:2645 ../fish/guestfish-actions.pod:1803
10565 "Note that keys are drive letters. For Windows, the key is case insensitive "
10566 "and just contains the drive letter, without the customary colon separator "
10571 #: ../src/guestfs-actions.pod:2649 ../fish/guestfish-actions.pod:1807
10573 "In future we may support other operating systems that also used drive "
10574 "letters, but the keys for those might not be case insensitive and might be "
10575 "longer than 1 character. For example in OS-9, hard drives were named C<h0>, "
10580 #: ../src/guestfs-actions.pod:2654 ../fish/guestfish-actions.pod:1812
10582 "For Windows guests, currently only hard drive mappings are returned. "
10583 "Removable disks (eg. DVD-ROMs) are ignored."
10587 #: ../src/guestfs-actions.pod:2657 ../fish/guestfish-actions.pod:1815
10589 "For guests that do not use drive mappings, or if the drive mappings could "
10590 "not be determined, this returns an empty hash table."
10594 #: ../src/guestfs-actions.pod:2660
10596 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
10597 "C<guestfs_inspect_get_mountpoints>, C<guestfs_inspect_get_filesystems>."
10601 #: ../src/guestfs-actions.pod:2664 ../src/guestfs-actions.pod:2840
10602 #: ../src/guestfs-actions.pod:3600 ../src/guestfs-actions.pod:4810
10603 #: ../src/guestfs-actions.pod:6715
10605 "This function returns a NULL-terminated array of strings, or NULL if there "
10606 "was an error. The array of strings will always have length C<2n+1>, where "
10607 "C<n> keys and values alternate, followed by the trailing NULL entry. I<The "
10608 "caller must free the strings and the array after use>."
10612 #: ../src/guestfs-actions.pod:2670
10613 msgid "guestfs_inspect_get_filesystems"
10617 #: ../src/guestfs-actions.pod:2672
10621 " guestfs_inspect_get_filesystems (guestfs_h *g,\n"
10622 " const char *root);\n"
10627 #: ../src/guestfs-actions.pod:2679 ../fish/guestfish-actions.pod:1829
10629 "This returns a list of all the filesystems that we think are associated with "
10630 "this operating system. This includes the root filesystem, other ordinary "
10631 "filesystems, and non-mounted devices like swap partitions."
10635 #: ../src/guestfs-actions.pod:2684 ../fish/guestfish-actions.pod:1834
10637 "In the case of a multi-boot virtual machine, it is possible for a filesystem "
10638 "to be shared between operating systems."
10642 #: ../src/guestfs-actions.pod:2687
10644 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
10645 "C<guestfs_inspect_get_mountpoints>."
10649 #: ../src/guestfs-actions.pod:2696
10650 msgid "guestfs_inspect_get_format"
10654 #: ../src/guestfs-actions.pod:2698
10658 " guestfs_inspect_get_format (guestfs_h *g,\n"
10659 " const char *root);\n"
10664 #: ../src/guestfs-actions.pod:2705 ../fish/guestfish-actions.pod:1847
10666 "This returns the format of the inspected operating system. You can use it "
10667 "to detect install images, live CDs and similar."
10671 #: ../src/guestfs-actions.pod:2708 ../fish/guestfish-actions.pod:1850
10672 msgid "Currently defined formats are:"
10676 #: ../src/guestfs-actions.pod:2712 ../fish/guestfish-actions.pod:1854
10677 msgid "\"installed\""
10678 msgstr "\"installed\""
10681 #: ../src/guestfs-actions.pod:2714 ../fish/guestfish-actions.pod:1856
10682 msgid "This is an installed operating system."
10683 msgstr "Це встановлена операційна система."
10686 #: ../src/guestfs-actions.pod:2716 ../fish/guestfish-actions.pod:1858
10687 msgid "\"installer\""
10691 #: ../src/guestfs-actions.pod:2718 ../fish/guestfish-actions.pod:1860
10693 "The disk image being inspected is not an installed operating system, but a "
10694 "I<bootable> install disk, live CD, or similar."
10698 #: ../src/guestfs-actions.pod:2723 ../fish/guestfish-actions.pod:1865
10699 msgid "The format of this disk image is not known."
10703 #: ../src/guestfs-actions.pod:2735
10704 msgid "guestfs_inspect_get_hostname"
10708 #: ../src/guestfs-actions.pod:2737
10712 " guestfs_inspect_get_hostname (guestfs_h *g,\n"
10713 " const char *root);\n"
10718 #: ../src/guestfs-actions.pod:2744 ../fish/guestfish-actions.pod:1881
10720 "This function returns the hostname of the operating system as found by "
10721 "inspection of the guest's configuration files."
10725 #: ../src/guestfs-actions.pod:2747 ../fish/guestfish-actions.pod:1884
10727 "If the hostname could not be determined, then the string C<unknown> is "
10732 #: ../src/guestfs-actions.pod:2755
10733 msgid "(Added in 1.7.9)"
10737 #: ../src/guestfs-actions.pod:2757
10738 msgid "guestfs_inspect_get_major_version"
10742 #: ../src/guestfs-actions.pod:2759
10746 " guestfs_inspect_get_major_version (guestfs_h *g,\n"
10747 " const char *root);\n"
10752 #: ../src/guestfs-actions.pod:2766 ../fish/guestfish-actions.pod:1896
10754 "This returns the major version number of the inspected operating system."
10758 #: ../src/guestfs-actions.pod:2769 ../fish/guestfish-actions.pod:1899
10760 "Windows uses a consistent versioning scheme which is I<not> reflected in the "
10761 "popular public names used by the operating system. Notably the operating "
10762 "system known as \"Windows 7\" is really version 6.1 (ie. major = 6, minor = "
10763 "1). You can find out the real versions corresponding to releases of Windows "
10764 "by consulting Wikipedia or MSDN."
10768 #: ../src/guestfs-actions.pod:2776 ../src/guestfs-actions.pod:2796
10769 #: ../fish/guestfish-actions.pod:1906 ../fish/guestfish-actions.pod:1920
10770 msgid "If the version could not be determined, then C<0> is returned."
10774 #: ../src/guestfs-actions.pod:2784
10775 msgid "guestfs_inspect_get_minor_version"
10779 #: ../src/guestfs-actions.pod:2786
10783 " guestfs_inspect_get_minor_version (guestfs_h *g,\n"
10784 " const char *root);\n"
10789 #: ../src/guestfs-actions.pod:2793 ../fish/guestfish-actions.pod:1917
10791 "This returns the minor version number of the inspected operating system."
10795 #: ../src/guestfs-actions.pod:2798
10797 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
10798 "C<guestfs_inspect_get_major_version>."
10802 #: ../src/guestfs-actions.pod:2805
10803 msgid "guestfs_inspect_get_mountpoints"
10807 #: ../src/guestfs-actions.pod:2807
10811 " guestfs_inspect_get_mountpoints (guestfs_h *g,\n"
10812 " const char *root);\n"
10817 #: ../src/guestfs-actions.pod:2814 ../fish/guestfish-actions.pod:1932
10819 "This returns a hash of where we think the filesystems associated with this "
10820 "operating system should be mounted. Callers should note that this is at "
10821 "best an educated guess made by reading configuration files such as C</etc/"
10822 "fstab>. I<In particular note> that this may return filesystems which are "
10823 "non-existent or not mountable and callers should be prepared to handle or "
10824 "ignore failures if they try to mount them."
10828 #: ../src/guestfs-actions.pod:2823 ../fish/guestfish-actions.pod:1941
10830 "Each element in the returned hashtable has a key which is the path of the "
10831 "mountpoint (eg. C</boot>) and a value which is the filesystem that would be "
10832 "mounted there (eg. C</dev/sda1>)."
10836 #: ../src/guestfs-actions.pod:2828 ../fish/guestfish-actions.pod:1946
10838 "Non-mounted devices such as swap devices are I<not> returned in this list."
10842 #: ../src/guestfs-actions.pod:2831
10844 "For operating systems like Windows which still use drive letters, this call "
10845 "will only return an entry for the first drive \"mounted on\" C</>. For "
10846 "information about the mapping of drive letters to partitions, see "
10847 "C<guestfs_inspect_get_drive_mappings>."
10851 #: ../src/guestfs-actions.pod:2837
10853 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
10854 "C<guestfs_inspect_get_filesystems>."
10858 #: ../src/guestfs-actions.pod:2848
10859 msgid "guestfs_inspect_get_package_format"
10863 #: ../src/guestfs-actions.pod:2850
10867 " guestfs_inspect_get_package_format (guestfs_h *g,\n"
10868 " const char *root);\n"
10873 #: ../src/guestfs-actions.pod:2857
10875 "This function and C<guestfs_inspect_get_package_management> return the "
10876 "package format and package management tool used by the inspected operating "
10877 "system. For example for Fedora these functions would return C<rpm> (package "
10878 "format) and C<yum> (package management)."
10882 #: ../src/guestfs-actions.pod:2863 ../fish/guestfish-actions.pod:1971
10884 "This returns the string C<unknown> if we could not determine the package "
10885 "format I<or> if the operating system does not have a real packaging system "
10890 #: ../src/guestfs-actions.pod:2867 ../fish/guestfish-actions.pod:1975
10892 "Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>. "
10893 "Future versions of libguestfs may return other strings."
10897 #: ../src/guestfs-actions.pod:2875 ../src/guestfs-actions.pod:2906
10898 msgid "(Added in 1.7.5)"
10902 #: ../src/guestfs-actions.pod:2877
10903 msgid "guestfs_inspect_get_package_management"
10907 #: ../src/guestfs-actions.pod:2879
10911 " guestfs_inspect_get_package_management (guestfs_h *g,\n"
10912 " const char *root);\n"
10917 #: ../src/guestfs-actions.pod:2886
10919 "C<guestfs_inspect_get_package_format> and this function return the package "
10920 "format and package management tool used by the inspected operating system. "
10921 "For example for Fedora these functions would return C<rpm> (package format) "
10922 "and C<yum> (package management)."
10926 #: ../src/guestfs-actions.pod:2892 ../fish/guestfish-actions.pod:1993
10928 "This returns the string C<unknown> if we could not determine the package "
10929 "management tool I<or> if the operating system does not have a real packaging "
10930 "system (eg. Windows)."
10934 #: ../src/guestfs-actions.pod:2896 ../fish/guestfish-actions.pod:1997
10936 "Possible strings include: C<yum>, C<up2date>, C<apt> (for all Debian "
10937 "derivatives), C<portage>, C<pisi>, C<pacman>, C<urpmi>. Future versions of "
10938 "libguestfs may return other strings."
10942 #: ../src/guestfs-actions.pod:2908
10943 msgid "guestfs_inspect_get_product_name"
10947 #: ../src/guestfs-actions.pod:2910
10951 " guestfs_inspect_get_product_name (guestfs_h *g,\n"
10952 " const char *root);\n"
10957 #: ../src/guestfs-actions.pod:2917 ../fish/guestfish-actions.pod:2011
10959 "This returns the product name of the inspected operating system. The "
10960 "product name is generally some freeform string which can be displayed to the "
10961 "user, but should not be parsed by programs."
10965 #: ../src/guestfs-actions.pod:2922 ../fish/guestfish-actions.pod:2016
10967 "If the product name could not be determined, then the string C<unknown> is "
10972 #: ../src/guestfs-actions.pod:2932
10973 msgid "guestfs_inspect_get_product_variant"
10977 #: ../src/guestfs-actions.pod:2934
10981 " guestfs_inspect_get_product_variant (guestfs_h *g,\n"
10982 " const char *root);\n"
10987 #: ../src/guestfs-actions.pod:2941 ../fish/guestfish-actions.pod:2028
10989 #| msgid "This is an installed operating system."
10990 msgid "This returns the product variant of the inspected operating system."
10991 msgstr "Це встановлена операційна система."
10994 #: ../src/guestfs-actions.pod:2944 ../fish/guestfish-actions.pod:2031
10996 "For Windows guests, this returns the contents of the Registry key C<HKLM"
10997 "\\Software\\Microsoft\\Windows NT\\CurrentVersion> C<InstallationType> which "
10998 "is usually a string such as C<Client> or C<Server> (other values are "
10999 "possible). This can be used to distinguish consumer and enterprise versions "
11000 "of Windows that have the same version number (for example, Windows 7 and "
11001 "Windows 2008 Server are both version 6.1, but the former is C<Client> and "
11002 "the latter is C<Server>)."
11006 #: ../src/guestfs-actions.pod:2953 ../fish/guestfish-actions.pod:2040
11008 "For enterprise Linux guests, in future we intend this to return the product "
11009 "variant such as C<Desktop>, C<Server> and so on. But this is not "
11010 "implemented at present."
11014 #: ../src/guestfs-actions.pod:2957 ../fish/guestfish-actions.pod:2044
11016 "If the product variant could not be determined, then the string C<unknown> "
11021 #: ../src/guestfs-actions.pod:2960
11023 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
11024 "C<guestfs_inspect_get_product_name>, C<guestfs_inspect_get_major_version>."
11028 #: ../src/guestfs-actions.pod:2967
11029 msgid "guestfs_inspect_get_roots"
11033 #: ../src/guestfs-actions.pod:2969
11037 " guestfs_inspect_get_roots (guestfs_h *g);\n"
11042 #: ../src/guestfs-actions.pod:2972
11044 "This function is a convenient way to get the list of root devices, as "
11045 "returned from a previous call to C<guestfs_inspect_os>, but without redoing "
11046 "the whole inspection process."
11050 #: ../src/guestfs-actions.pod:2976
11052 "This returns an empty list if either no root devices were found or the "
11053 "caller has not called C<guestfs_inspect_os>."
11057 #: ../src/guestfs-actions.pod:2985
11058 msgid "(Added in 1.7.3)"
11062 #: ../src/guestfs-actions.pod:2987
11063 msgid "guestfs_inspect_get_type"
11067 #: ../src/guestfs-actions.pod:2989
11071 " guestfs_inspect_get_type (guestfs_h *g,\n"
11072 " const char *root);\n"
11077 #: ../src/guestfs-actions.pod:2996 ../fish/guestfish-actions.pod:2071
11079 "This returns the type of the inspected operating system. Currently defined "
11084 #: ../src/guestfs-actions.pod:3001 ../fish/guestfish-actions.pod:2076
11089 #: ../src/guestfs-actions.pod:3003 ../fish/guestfish-actions.pod:2078
11090 msgid "Any Linux-based operating system."
11094 #: ../src/guestfs-actions.pod:3007 ../fish/guestfish-actions.pod:2082
11095 msgid "Any Microsoft Windows operating system."
11099 #: ../src/guestfs-actions.pod:3009 ../fish/guestfish-actions.pod:2084
11100 msgid "\"freebsd\""
11101 msgstr "\"freebsd\""
11104 #: ../src/guestfs-actions.pod:3011 ../fish/guestfish-actions.pod:2086
11109 #: ../src/guestfs-actions.pod:3015 ../fish/guestfish-actions.pod:2090
11110 msgid "The operating system type could not be determined."
11114 #: ../src/guestfs-actions.pod:3029
11115 msgid "guestfs_inspect_get_windows_current_control_set"
11119 #: ../src/guestfs-actions.pod:3031
11123 " guestfs_inspect_get_windows_current_control_set (guestfs_h *g,\n"
11124 " const char *root);\n"
11129 #: ../src/guestfs-actions.pod:3038 ../fish/guestfish-actions.pod:2106
11131 "This returns the Windows CurrentControlSet of the inspected guest. The "
11132 "CurrentControlSet is a registry key name such as C<ControlSet001>."
11136 #: ../src/guestfs-actions.pod:3041 ../fish/guestfish-actions.pod:2109
11138 "This call assumes that the guest is Windows and that the Registry could be "
11139 "examined by inspection. If this is not the case then an error is returned."
11143 #: ../src/guestfs-actions.pod:3050
11144 msgid "guestfs_inspect_get_windows_systemroot"
11148 #: ../src/guestfs-actions.pod:3052
11152 " guestfs_inspect_get_windows_systemroot (guestfs_h *g,\n"
11153 " const char *root);\n"
11158 #: ../src/guestfs-actions.pod:3059 ../fish/guestfish-actions.pod:2122
11160 "This returns the Windows systemroot of the inspected guest. The systemroot "
11161 "is a directory path such as C</WINDOWS>."
11165 #: ../src/guestfs-actions.pod:3062 ../fish/guestfish-actions.pod:2125
11167 "This call assumes that the guest is Windows and that the systemroot could be "
11168 "determined by inspection. If this is not the case then an error is returned."
11172 #: ../src/guestfs-actions.pod:3071
11173 msgid "(Added in 1.5.25)"
11177 #: ../src/guestfs-actions.pod:3073
11178 msgid "guestfs_inspect_is_live"
11182 #: ../src/guestfs-actions.pod:3075
11186 " guestfs_inspect_is_live (guestfs_h *g,\n"
11187 " const char *root);\n"
11192 #: ../src/guestfs-actions.pod:3082
11194 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
11195 "disk), then this returns true if a live image was detected on the disk."
11199 #: ../src/guestfs-actions.pod:3090
11200 msgid "guestfs_inspect_is_multipart"
11204 #: ../src/guestfs-actions.pod:3092
11208 " guestfs_inspect_is_multipart (guestfs_h *g,\n"
11209 " const char *root);\n"
11214 #: ../src/guestfs-actions.pod:3099
11216 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
11217 "disk), then this returns true if the disk is part of a set."
11221 #: ../src/guestfs-actions.pod:3107
11222 msgid "guestfs_inspect_is_netinst"
11226 #: ../src/guestfs-actions.pod:3109
11230 " guestfs_inspect_is_netinst (guestfs_h *g,\n"
11231 " const char *root);\n"
11236 #: ../src/guestfs-actions.pod:3116
11238 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
11239 "disk), then this returns true if the disk is a network installer, ie. not a "
11240 "self-contained install CD but one which is likely to require network access "
11241 "to complete the install."
11245 #: ../src/guestfs-actions.pod:3126
11246 msgid "guestfs_inspect_list_applications"
11250 #: ../src/guestfs-actions.pod:3128
11253 " struct guestfs_application_list *\n"
11254 " guestfs_inspect_list_applications (guestfs_h *g,\n"
11255 " const char *root);\n"
11260 #: ../src/guestfs-actions.pod:3135 ../fish/guestfish-actions.pod:2179
11261 msgid "Return the list of applications installed in the operating system."
11265 #: ../src/guestfs-actions.pod:3137
11267 "I<Note:> This call works differently from other parts of the inspection "
11268 "API. You have to call C<guestfs_inspect_os>, then "
11269 "C<guestfs_inspect_get_mountpoints>, then mount up the disks, before calling "
11270 "this. Listing applications is a significantly more difficult operation "
11271 "which requires access to the full filesystem. Also note that unlike the "
11272 "other C<guestfs_inspect_get_*> calls which are just returning data cached in "
11273 "the libguestfs handle, this call actually reads parts of the mounted "
11274 "filesystems during the call."
11278 #: ../src/guestfs-actions.pod:3147 ../fish/guestfish-actions.pod:2191
11280 "This returns an empty list if the inspection code was not able to determine "
11281 "the list of applications."
11285 #: ../src/guestfs-actions.pod:3150 ../fish/guestfish-actions.pod:2194
11286 msgid "The application structure contains the following fields:"
11290 #: ../src/guestfs-actions.pod:3154 ../fish/guestfish-actions.pod:2198
11291 msgid "C<app_name>"
11292 msgstr "C<app_name>"
11295 #: ../src/guestfs-actions.pod:3156 ../fish/guestfish-actions.pod:2200
11297 "The name of the application. For Red Hat-derived and Debian-derived Linux "
11298 "guests, this is the package name."
11302 #: ../src/guestfs-actions.pod:3159 ../fish/guestfish-actions.pod:2203
11303 msgid "C<app_display_name>"
11304 msgstr "C<app_display_name>"
11307 #: ../src/guestfs-actions.pod:3161 ../fish/guestfish-actions.pod:2205
11309 "The display name of the application, sometimes localized to the install "
11310 "language of the guest operating system."
11314 #: ../src/guestfs-actions.pod:3164 ../fish/guestfish-actions.pod:2208
11316 "If unavailable this is returned as an empty string C<\"\">. Callers needing "
11317 "to display something can use C<app_name> instead."
11321 #: ../src/guestfs-actions.pod:3167 ../fish/guestfish-actions.pod:2211
11322 msgid "C<app_epoch>"
11323 msgstr "C<app_epoch>"
11326 #: ../src/guestfs-actions.pod:3169 ../fish/guestfish-actions.pod:2213
11328 "For package managers which use epochs, this contains the epoch of the "
11329 "package (an integer). If unavailable, this is returned as C<0>."
11333 #: ../src/guestfs-actions.pod:3172 ../fish/guestfish-actions.pod:2216
11334 msgid "C<app_version>"
11335 msgstr "C<app_version>"
11338 #: ../src/guestfs-actions.pod:3174 ../fish/guestfish-actions.pod:2218
11340 "The version string of the application or package. If unavailable this is "
11341 "returned as an empty string C<\"\">."
11345 #: ../src/guestfs-actions.pod:3177 ../fish/guestfish-actions.pod:2221
11346 msgid "C<app_release>"
11347 msgstr "C<app_release>"
11350 #: ../src/guestfs-actions.pod:3179 ../fish/guestfish-actions.pod:2223
11352 "The release string of the application or package, for package managers that "
11353 "use this. If unavailable this is returned as an empty string C<\"\">."
11357 #: ../src/guestfs-actions.pod:3183 ../fish/guestfish-actions.pod:2227
11358 msgid "C<app_install_path>"
11359 msgstr "C<app_install_path>"
11362 #: ../src/guestfs-actions.pod:3185 ../fish/guestfish-actions.pod:2229
11364 "The installation path of the application (on operating systems such as "
11365 "Windows which use installation paths). This path is in the format used by "
11366 "the guest operating system, it is not a libguestfs path."
11370 #: ../src/guestfs-actions.pod:3190 ../fish/guestfish-actions.pod:2234
11371 msgid "If unavailable this is returned as an empty string C<\"\">."
11375 #: ../src/guestfs-actions.pod:3192 ../fish/guestfish-actions.pod:2236
11376 msgid "C<app_trans_path>"
11377 msgstr "C<app_trans_path>"
11380 #: ../src/guestfs-actions.pod:3194 ../fish/guestfish-actions.pod:2238
11382 "The install path translated into a libguestfs path. If unavailable this is "
11383 "returned as an empty string C<\"\">."
11387 #: ../src/guestfs-actions.pod:3197 ../fish/guestfish-actions.pod:2241
11388 msgid "C<app_publisher>"
11389 msgstr "C<app_publisher>"
11392 #: ../src/guestfs-actions.pod:3199 ../fish/guestfish-actions.pod:2243
11394 "The name of the publisher of the application, for package managers that use "
11395 "this. If unavailable this is returned as an empty string C<\"\">."
11399 #: ../src/guestfs-actions.pod:3203 ../fish/guestfish-actions.pod:2247
11401 msgstr "C<app_url>"
11404 #: ../src/guestfs-actions.pod:3205 ../fish/guestfish-actions.pod:2249
11406 "The URL (eg. upstream URL) of the application. If unavailable this is "
11407 "returned as an empty string C<\"\">."
11411 #: ../src/guestfs-actions.pod:3208 ../fish/guestfish-actions.pod:2252
11412 msgid "C<app_source_package>"
11416 #: ../src/guestfs-actions.pod:3210 ../fish/guestfish-actions.pod:2254
11418 "For packaging systems which support this, the name of the source package. "
11419 "If unavailable this is returned as an empty string C<\"\">."
11423 #: ../src/guestfs-actions.pod:3213 ../fish/guestfish-actions.pod:2257
11424 msgid "C<app_summary>"
11428 #: ../src/guestfs-actions.pod:3215 ../fish/guestfish-actions.pod:2259
11430 "A short (usually one line) description of the application or package. If "
11431 "unavailable this is returned as an empty string C<\"\">."
11435 #: ../src/guestfs-actions.pod:3218 ../fish/guestfish-actions.pod:2262
11436 msgid "C<app_description>"
11440 #: ../src/guestfs-actions.pod:3220 ../fish/guestfish-actions.pod:2264
11442 "A longer description of the application or package. If unavailable this is "
11443 "returned as an empty string C<\"\">."
11447 #: ../src/guestfs-actions.pod:3227
11449 "This function returns a C<struct guestfs_application_list *>, or NULL if "
11450 "there was an error. I<The caller must call C<guestfs_free_application_list> "
11455 #: ../src/guestfs-actions.pod:3231
11456 msgid "(Added in 1.7.8)"
11460 #: ../src/guestfs-actions.pod:3233
11461 msgid "guestfs_inspect_os"
11465 #: ../src/guestfs-actions.pod:3235
11469 " guestfs_inspect_os (guestfs_h *g);\n"
11474 #: ../src/guestfs-actions.pod:3238 ../fish/guestfish-actions.pod:2275
11476 "This function uses other libguestfs functions and certain heuristics to "
11477 "inspect the disk(s) (usually disks belonging to a virtual machine), looking "
11478 "for operating systems."
11482 #: ../src/guestfs-actions.pod:3242 ../fish/guestfish-actions.pod:2279
11483 msgid "The list returned is empty if no operating systems were found."
11487 #: ../src/guestfs-actions.pod:3244 ../fish/guestfish-actions.pod:2281
11489 "If one operating system was found, then this returns a list with a single "
11490 "element, which is the name of the root filesystem of this operating system. "
11491 "It is also possible for this function to return a list containing more than "
11492 "one element, indicating a dual-boot or multi-boot virtual machine, with each "
11493 "element being the root filesystem of one of the operating systems."
11497 #: ../src/guestfs-actions.pod:3251
11499 "You can pass the root string(s) returned to other C<guestfs_inspect_get_*> "
11500 "functions in order to query further information about each operating system, "
11501 "such as the name and version."
11505 #: ../src/guestfs-actions.pod:3256
11507 "This function uses other libguestfs features such as C<guestfs_mount_ro> and "
11508 "C<guestfs_umount_all> in order to mount and unmount filesystems and look at "
11509 "the contents. This should be called with no disks currently mounted. The "
11510 "function may also use Augeas, so any existing Augeas handle will be closed."
11514 #: ../src/guestfs-actions.pod:3262 ../fish/guestfish-actions.pod:2299
11516 "This function cannot decrypt encrypted disks. The caller must do that first "
11517 "(supplying the necessary keys) if the disk is encrypted."
11521 #: ../src/guestfs-actions.pod:3268 ../src/guestfs-actions.pod:3558
11522 #: ../src/guestfs-actions.pod:3620
11523 msgid "See also C<guestfs_list_filesystems>."
11527 #: ../src/guestfs-actions.pod:3276
11528 msgid "guestfs_is_blockdev"
11532 #: ../src/guestfs-actions.pod:3278
11536 " guestfs_is_blockdev (guestfs_h *g,\n"
11537 " const char *path);\n"
11542 #: ../src/guestfs-actions.pod:3282 ../fish/guestfish-actions.pod:2311
11544 "This returns C<true> if and only if there is a block device with the given "
11549 #: ../src/guestfs-actions.pod:3285 ../src/guestfs-actions.pod:3314
11550 #: ../src/guestfs-actions.pod:3344 ../src/guestfs-actions.pod:3359
11551 #: ../src/guestfs-actions.pod:3375 ../src/guestfs-actions.pod:3431
11552 #: ../src/guestfs-actions.pod:3446
11553 msgid "See also C<guestfs_stat>."
11557 #: ../src/guestfs-actions.pod:3289 ../src/guestfs-actions.pod:3318
11558 #: ../src/guestfs-actions.pod:3363 ../src/guestfs-actions.pod:3435
11559 #: ../src/guestfs-actions.pod:3450
11560 msgid "(Added in 1.5.10)"
11564 #: ../src/guestfs-actions.pod:3291
11565 msgid "guestfs_is_busy"
11569 #: ../src/guestfs-actions.pod:3293
11573 " guestfs_is_busy (guestfs_h *g);\n"
11578 #: ../src/guestfs-actions.pod:3296 ../fish/guestfish-actions.pod:2320
11580 "This returns true iff this handle is busy processing a command (in the "
11585 #: ../src/guestfs-actions.pod:3305
11586 msgid "guestfs_is_chardev"
11590 #: ../src/guestfs-actions.pod:3307
11594 " guestfs_is_chardev (guestfs_h *g,\n"
11595 " const char *path);\n"
11600 #: ../src/guestfs-actions.pod:3311 ../fish/guestfish-actions.pod:2329
11602 "This returns C<true> if and only if there is a character device with the "
11603 "given C<path> name."
11607 #: ../src/guestfs-actions.pod:3320
11608 msgid "guestfs_is_config"
11612 #: ../src/guestfs-actions.pod:3322
11616 " guestfs_is_config (guestfs_h *g);\n"
11621 #: ../src/guestfs-actions.pod:3325 ../fish/guestfish-actions.pod:2338
11623 "This returns true iff this handle is being configured (in the C<CONFIG> "
11628 #: ../src/guestfs-actions.pod:3334
11629 msgid "guestfs_is_dir"
11633 #: ../src/guestfs-actions.pod:3336
11637 " guestfs_is_dir (guestfs_h *g,\n"
11638 " const char *path);\n"
11643 #: ../src/guestfs-actions.pod:3340 ../fish/guestfish-actions.pod:2347
11645 "This returns C<true> if and only if there is a directory with the given "
11646 "C<path> name. Note that it returns false for other objects like files."
11650 #: ../src/guestfs-actions.pod:3350
11651 msgid "guestfs_is_fifo"
11655 #: ../src/guestfs-actions.pod:3352
11659 " guestfs_is_fifo (guestfs_h *g,\n"
11660 " const char *path);\n"
11665 #: ../src/guestfs-actions.pod:3356 ../fish/guestfish-actions.pod:2357
11667 "This returns C<true> if and only if there is a FIFO (named pipe) with the "
11668 "given C<path> name."
11672 #: ../src/guestfs-actions.pod:3365
11673 msgid "guestfs_is_file"
11677 #: ../src/guestfs-actions.pod:3367
11681 " guestfs_is_file (guestfs_h *g,\n"
11682 " const char *path);\n"
11687 #: ../src/guestfs-actions.pod:3371 ../fish/guestfish-actions.pod:2366
11689 "This returns C<true> if and only if there is a regular file with the given "
11690 "C<path> name. Note that it returns false for other objects like directories."
11694 #: ../src/guestfs-actions.pod:3381
11695 msgid "guestfs_is_launching"
11699 #: ../src/guestfs-actions.pod:3383
11703 " guestfs_is_launching (guestfs_h *g);\n"
11708 #: ../src/guestfs-actions.pod:3386 ../fish/guestfish-actions.pod:2376
11710 "This returns true iff this handle is launching the subprocess (in the "
11711 "C<LAUNCHING> state)."
11715 #: ../src/guestfs-actions.pod:3395
11716 msgid "guestfs_is_lv"
11720 #: ../src/guestfs-actions.pod:3397
11724 " guestfs_is_lv (guestfs_h *g,\n"
11725 " const char *device);\n"
11730 #: ../src/guestfs-actions.pod:3401 ../fish/guestfish-actions.pod:2385
11732 "This command tests whether C<device> is a logical volume, and returns true "
11733 "iff this is the case."
11737 #: ../src/guestfs-actions.pod:3408
11738 msgid "guestfs_is_ready"
11742 #: ../src/guestfs-actions.pod:3410
11746 " guestfs_is_ready (guestfs_h *g);\n"
11751 #: ../src/guestfs-actions.pod:3413 ../fish/guestfish-actions.pod:2392
11753 "This returns true iff this handle is ready to accept commands (in the "
11758 #: ../src/guestfs-actions.pod:3422
11759 msgid "guestfs_is_socket"
11763 #: ../src/guestfs-actions.pod:3424
11767 " guestfs_is_socket (guestfs_h *g,\n"
11768 " const char *path);\n"
11773 #: ../src/guestfs-actions.pod:3428 ../fish/guestfish-actions.pod:2401
11775 "This returns C<true> if and only if there is a Unix domain socket with the "
11776 "given C<path> name."
11780 #: ../src/guestfs-actions.pod:3437
11781 msgid "guestfs_is_symlink"
11785 #: ../src/guestfs-actions.pod:3439
11789 " guestfs_is_symlink (guestfs_h *g,\n"
11790 " const char *path);\n"
11795 #: ../src/guestfs-actions.pod:3443 ../fish/guestfish-actions.pod:2410
11797 "This returns C<true> if and only if there is a symbolic link with the given "
11802 #: ../src/guestfs-actions.pod:3452
11803 msgid "guestfs_kill_subprocess"
11807 #: ../src/guestfs-actions.pod:3454
11811 " guestfs_kill_subprocess (guestfs_h *g);\n"
11816 #: ../src/guestfs-actions.pod:3457 ../fish/guestfish-actions.pod:2419
11817 msgid "This kills the qemu subprocess. You should never need to call this."
11821 #: ../src/guestfs-actions.pod:3463
11822 msgid "guestfs_launch"
11826 #: ../src/guestfs-actions.pod:3465
11830 " guestfs_launch (guestfs_h *g);\n"
11835 #: ../src/guestfs-actions.pod:3468 ../fish/guestfish-actions.pod:2427
11837 "Internally libguestfs is implemented by running a virtual machine using "
11842 #: ../src/guestfs-actions.pod:3471 ../fish/guestfish-actions.pod:2430
11844 "You should call this after configuring the handle (eg. adding drives) but "
11845 "before performing any actions."
11849 #: ../src/guestfs-actions.pod:3483
11850 msgid "guestfs_lchown"
11854 #: ../src/guestfs-actions.pod:3485
11858 " guestfs_lchown (guestfs_h *g,\n"
11861 " const char *path);\n"
11866 #: ../src/guestfs-actions.pod:3491
11868 "Change the file owner to C<owner> and group to C<group>. This is like "
11869 "C<guestfs_chown> but if C<path> is a symlink then the link itself is "
11870 "changed, not the target."
11874 #: ../src/guestfs-actions.pod:3503
11875 msgid "guestfs_lgetxattr"
11879 #: ../src/guestfs-actions.pod:3505
11883 " guestfs_lgetxattr (guestfs_h *g,\n"
11884 " const char *path,\n"
11885 " const char *name,\n"
11886 " size_t *size_r);\n"
11891 #: ../src/guestfs-actions.pod:3511 ../fish/guestfish-actions.pod:2449
11893 "Get a single extended attribute from file C<path> named C<name>. If C<path> "
11894 "is a symlink, then this call returns an extended attribute from the symlink."
11898 #: ../src/guestfs-actions.pod:3525
11899 msgid "See also: C<guestfs_lgetxattrs>, C<guestfs_getxattr>, L<attr(5)>."
11903 #: ../src/guestfs-actions.pod:3533
11904 msgid "guestfs_lgetxattrs"
11908 #: ../src/guestfs-actions.pod:3535
11911 " struct guestfs_xattr_list *\n"
11912 " guestfs_lgetxattrs (guestfs_h *g,\n"
11913 " const char *path);\n"
11918 #: ../src/guestfs-actions.pod:3539
11920 "This is the same as C<guestfs_getxattrs>, but if C<path> is a symbolic link, "
11921 "then it returns the extended attributes of the link itself."
11925 #: ../src/guestfs-actions.pod:3549
11926 msgid "guestfs_list_devices"
11930 #: ../src/guestfs-actions.pod:3551
11934 " guestfs_list_devices (guestfs_h *g);\n"
11939 #: ../src/guestfs-actions.pod:3554 ../fish/guestfish-actions.pod:2477
11940 msgid "List all the block devices."
11944 #: ../src/guestfs-actions.pod:3556 ../fish/guestfish-actions.pod:2479
11945 msgid "The full block device names are returned, eg. C</dev/sda>."
11949 #: ../src/guestfs-actions.pod:3566
11950 msgid "guestfs_list_filesystems"
11954 #: ../src/guestfs-actions.pod:3568
11958 " guestfs_list_filesystems (guestfs_h *g);\n"
11963 #: ../src/guestfs-actions.pod:3571 ../fish/guestfish-actions.pod:2487
11965 "This inspection command looks for filesystems on partitions, block devices "
11966 "and logical volumes, returning a list of devices containing filesystems and "
11971 #: ../src/guestfs-actions.pod:3575 ../fish/guestfish-actions.pod:2491
11973 "The return value is a hash, where the keys are the devices containing "
11974 "filesystems, and the values are the filesystem types. For example:"
11978 #: ../src/guestfs-actions.pod:3579 ../fish/guestfish-actions.pod:2495
11981 " \"/dev/sda1\" => \"ntfs\"\n"
11982 " \"/dev/sda2\" => \"ext2\"\n"
11983 " \"/dev/vg_guest/lv_root\" => \"ext4\"\n"
11984 " \"/dev/vg_guest/lv_swap\" => \"swap\"\n"
11989 #: ../src/guestfs-actions.pod:3584 ../fish/guestfish-actions.pod:2500
11991 "The value can have the special value \"unknown\", meaning the content of the "
11992 "device is undetermined or empty. \"swap\" means a Linux swap partition."
11996 #: ../src/guestfs-actions.pod:3588
11998 "This command runs other libguestfs commands, which might include "
11999 "C<guestfs_mount> and C<guestfs_umount>, and therefore you should use this "
12000 "soon after launch and only when nothing is mounted."
12004 #: ../src/guestfs-actions.pod:3592
12006 "Not all of the filesystems returned will be mountable. In particular, swap "
12007 "partitions are returned in the list. Also this command does not check that "
12008 "each filesystem found is valid and mountable, and some filesystems might be "
12009 "mountable but require special options. Filesystems may not all belong to a "
12010 "single logical operating system (use C<guestfs_inspect_os> to look for OSes)."
12014 #: ../src/guestfs-actions.pod:3606 ../src/guestfs-actions.pod:5211
12015 msgid "(Added in 1.5.15)"
12019 #: ../src/guestfs-actions.pod:3608
12020 msgid "guestfs_list_partitions"
12024 #: ../src/guestfs-actions.pod:3610
12028 " guestfs_list_partitions (guestfs_h *g);\n"
12033 #: ../src/guestfs-actions.pod:3613 ../fish/guestfish-actions.pod:2520
12034 msgid "List all the partitions detected on all block devices."
12038 #: ../src/guestfs-actions.pod:3615 ../fish/guestfish-actions.pod:2522
12039 msgid "The full partition device names are returned, eg. C</dev/sda1>"
12043 #: ../src/guestfs-actions.pod:3617
12045 "This does not return logical volumes. For that you will need to call "
12050 #: ../src/guestfs-actions.pod:3628
12055 #: ../src/guestfs-actions.pod:3630
12059 " guestfs_ll (guestfs_h *g,\n"
12060 " const char *directory);\n"
12065 #: ../src/guestfs-actions.pod:3634 ../fish/guestfish-actions.pod:2533
12067 "List the files in C<directory> (relative to the root directory, there is no "
12068 "cwd) in the format of 'ls -la'."
12072 #: ../src/guestfs-actions.pod:3637 ../fish/guestfish-actions.pod:2536
12074 "This command is mostly useful for interactive sessions. It is I<not> "
12075 "intended that you try to parse the output string."
12079 #: ../src/guestfs-actions.pod:3645
12084 #: ../src/guestfs-actions.pod:3647
12088 " guestfs_ln (guestfs_h *g,\n"
12089 " const char *target,\n"
12090 " const char *linkname);\n"
12095 #: ../src/guestfs-actions.pod:3652 ../fish/guestfish-actions.pod:2543
12096 msgid "This command creates a hard link using the C<ln> command."
12100 #: ../src/guestfs-actions.pod:3658
12101 msgid "guestfs_ln_f"
12105 #: ../src/guestfs-actions.pod:3660
12109 " guestfs_ln_f (guestfs_h *g,\n"
12110 " const char *target,\n"
12111 " const char *linkname);\n"
12116 #: ../src/guestfs-actions.pod:3665 ../fish/guestfish-actions.pod:2549
12118 "This command creates a hard link using the C<ln -f> command. The C<-f> "
12119 "option removes the link (C<linkname>) if it exists already."
12123 #: ../src/guestfs-actions.pod:3672
12124 msgid "guestfs_ln_s"
12128 #: ../src/guestfs-actions.pod:3674
12132 " guestfs_ln_s (guestfs_h *g,\n"
12133 " const char *target,\n"
12134 " const char *linkname);\n"
12139 #: ../src/guestfs-actions.pod:3679 ../fish/guestfish-actions.pod:2556
12140 msgid "This command creates a symbolic link using the C<ln -s> command."
12144 #: ../src/guestfs-actions.pod:3685
12145 msgid "guestfs_ln_sf"
12149 #: ../src/guestfs-actions.pod:3687
12153 " guestfs_ln_sf (guestfs_h *g,\n"
12154 " const char *target,\n"
12155 " const char *linkname);\n"
12160 #: ../src/guestfs-actions.pod:3692 ../fish/guestfish-actions.pod:2562
12162 "This command creates a symbolic link using the C<ln -sf> command, The C<-f> "
12163 "option removes the link (C<linkname>) if it exists already."
12167 #: ../src/guestfs-actions.pod:3699
12168 msgid "guestfs_lremovexattr"
12172 #: ../src/guestfs-actions.pod:3701
12176 " guestfs_lremovexattr (guestfs_h *g,\n"
12177 " const char *xattr,\n"
12178 " const char *path);\n"
12183 #: ../src/guestfs-actions.pod:3706
12185 "This is the same as C<guestfs_removexattr>, but if C<path> is a symbolic "
12186 "link, then it removes an extended attribute of the link itself."
12190 #: ../src/guestfs-actions.pod:3714
12195 #: ../src/guestfs-actions.pod:3716
12199 " guestfs_ls (guestfs_h *g,\n"
12200 " const char *directory);\n"
12205 #: ../src/guestfs-actions.pod:3720 ../fish/guestfish-actions.pod:2577
12207 "List the files in C<directory> (relative to the root directory, there is no "
12208 "cwd). The '.' and '..' entries are not returned, but hidden files are shown."
12212 #: ../src/guestfs-actions.pod:3724
12214 "This command is mostly useful for interactive sessions. Programs should "
12215 "probably use C<guestfs_readdir> instead."
12219 #: ../src/guestfs-actions.pod:3733
12220 msgid "guestfs_lsetxattr"
12224 #: ../src/guestfs-actions.pod:3735
12228 " guestfs_lsetxattr (guestfs_h *g,\n"
12229 " const char *xattr,\n"
12230 " const char *val,\n"
12232 " const char *path);\n"
12237 #: ../src/guestfs-actions.pod:3742
12239 "This is the same as C<guestfs_setxattr>, but if C<path> is a symbolic link, "
12240 "then it sets an extended attribute of the link itself."
12244 #: ../src/guestfs-actions.pod:3750
12245 msgid "guestfs_lstat"
12249 #: ../src/guestfs-actions.pod:3752
12252 " struct guestfs_stat *\n"
12253 " guestfs_lstat (guestfs_h *g,\n"
12254 " const char *path);\n"
12259 #: ../src/guestfs-actions.pod:3756 ../src/guestfs-actions.pod:6314
12260 #: ../fish/guestfish-actions.pod:2596 ../fish/guestfish-actions.pod:4265
12261 msgid "Returns file information for the given C<path>."
12265 #: ../src/guestfs-actions.pod:3758
12267 "This is the same as C<guestfs_stat> except that if C<path> is a symbolic "
12268 "link, then the link is stat-ed, not the file it refers to."
12272 #: ../src/guestfs-actions.pod:3762 ../fish/guestfish-actions.pod:2602
12273 msgid "This is the same as the C<lstat(2)> system call."
12277 #: ../src/guestfs-actions.pod:3764 ../src/guestfs-actions.pod:6318
12279 "This function returns a C<struct guestfs_stat *>, or NULL if there was an "
12280 "error. I<The caller must call C<guestfs_free_stat> after use>."
12284 #: ../src/guestfs-actions.pod:3768 ../src/guestfs-actions.pod:6322
12285 #: ../src/guestfs-actions.pod:6340 ../src/guestfs-actions.pod:6721
12286 msgid "(Added in 0.9.2)"
12290 #: ../src/guestfs-actions.pod:3770
12291 msgid "guestfs_lstatlist"
12295 #: ../src/guestfs-actions.pod:3772
12298 " struct guestfs_stat_list *\n"
12299 " guestfs_lstatlist (guestfs_h *g,\n"
12300 " const char *path,\n"
12301 " char *const *names);\n"
12306 #: ../src/guestfs-actions.pod:3777
12308 "This call allows you to perform the C<guestfs_lstat> operation on multiple "
12309 "files, where all files are in the directory C<path>. C<names> is the list "
12310 "of files from this directory."
12314 #: ../src/guestfs-actions.pod:3781 ../fish/guestfish-actions.pod:2612
12316 "On return you get a list of stat structs, with a one-to-one correspondence "
12317 "to the C<names> list. If any name did not exist or could not be lstat'd, "
12318 "then the C<ino> field of that structure is set to C<-1>."
12322 #: ../src/guestfs-actions.pod:3786
12324 "This call is intended for programs that want to efficiently list a directory "
12325 "contents without making many round-trips. See also C<guestfs_lxattrlist> "
12326 "for a similarly efficient call for getting extended attributes. Very long "
12327 "directory listings might cause the protocol message size to be exceeded, "
12328 "causing this call to fail. The caller must split up such requests into "
12329 "smaller groups of names."
12333 #: ../src/guestfs-actions.pod:3794
12335 "This function returns a C<struct guestfs_stat_list *>, or NULL if there was "
12336 "an error. I<The caller must call C<guestfs_free_stat_list> after use>."
12340 #: ../src/guestfs-actions.pod:3800
12341 msgid "guestfs_luks_add_key"
12345 #: ../src/guestfs-actions.pod:3802
12349 " guestfs_luks_add_key (guestfs_h *g,\n"
12350 " const char *device,\n"
12351 " const char *key,\n"
12352 " const char *newkey,\n"
12358 #: ../src/guestfs-actions.pod:3809 ../fish/guestfish-actions.pod:2629
12360 "This command adds a new key on LUKS device C<device>. C<key> is any "
12361 "existing key, and is used to access the device. C<newkey> is the new key to "
12362 "add. C<keyslot> is the key slot that will be replaced."
12366 #: ../src/guestfs-actions.pod:3814
12368 "Note that if C<keyslot> already contains a key, then this command will "
12369 "fail. You have to use C<guestfs_luks_kill_slot> first to remove that key."
12373 #: ../src/guestfs-actions.pod:3820 ../src/guestfs-actions.pod:3860
12374 #: ../src/guestfs-actions.pod:3883 ../src/guestfs-actions.pod:3903
12375 #: ../src/guestfs-actions.pod:3935 ../src/guestfs-actions.pod:3954
12377 "This function takes a key or passphrase parameter which could contain "
12378 "sensitive material. Read the section L</KEYS AND PASSPHRASES> for more "
12383 #: ../src/guestfs-actions.pod:3824 ../src/guestfs-actions.pod:3864
12384 #: ../src/guestfs-actions.pod:3887 ../src/guestfs-actions.pod:3907
12385 msgid "(Added in 1.5.2)"
12389 #: ../src/guestfs-actions.pod:3826
12390 msgid "guestfs_luks_close"
12394 #: ../src/guestfs-actions.pod:3828
12398 " guestfs_luks_close (guestfs_h *g,\n"
12399 " const char *device);\n"
12404 #: ../src/guestfs-actions.pod:3832
12406 "This closes a LUKS device that was created earlier by C<guestfs_luks_open> "
12407 "or C<guestfs_luks_open_ro>. The C<device> parameter must be the name of the "
12408 "LUKS mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
12409 "underlying block device."
12413 #: ../src/guestfs-actions.pod:3840 ../src/guestfs-actions.pod:3939
12414 #: ../src/guestfs-actions.pod:3958 ../src/guestfs-actions.pod:4008
12415 #: ../src/guestfs-actions.pod:4056
12416 msgid "(Added in 1.5.1)"
12420 #: ../src/guestfs-actions.pod:3842
12421 msgid "guestfs_luks_format"
12425 #: ../src/guestfs-actions.pod:3844
12429 " guestfs_luks_format (guestfs_h *g,\n"
12430 " const char *device,\n"
12431 " const char *key,\n"
12437 #: ../src/guestfs-actions.pod:3850 ../fish/guestfish-actions.pod:2655
12439 "This command erases existing data on C<device> and formats the device as a "
12440 "LUKS encrypted device. C<key> is the initial key, which is added to key "
12441 "slot C<slot>. (LUKS supports 8 key slots, numbered 0-7)."
12445 #: ../src/guestfs-actions.pod:3857 ../src/guestfs-actions.pod:3880
12446 #: ../src/guestfs-actions.pod:4020 ../src/guestfs-actions.pod:4962
12447 #: ../src/guestfs-actions.pod:5742 ../src/guestfs-actions.pod:6149
12448 #: ../src/guestfs-actions.pod:6172 ../src/guestfs-actions.pod:6198
12449 #: ../src/guestfs-actions.pod:7358 ../fish/guestfish-actions.pod:2663
12450 #: ../fish/guestfish-actions.pod:2676 ../fish/guestfish-actions.pod:2760
12451 #: ../fish/guestfish-actions.pod:3334 ../fish/guestfish-actions.pod:3854
12452 #: ../fish/guestfish-actions.pod:4164 ../fish/guestfish-actions.pod:4180
12453 #: ../fish/guestfish-actions.pod:4195 ../fish/guestfish-actions.pod:4910
12455 "B<This command is dangerous. Without careful use you can easily destroy all "
12460 #: ../src/guestfs-actions.pod:3866
12461 msgid "guestfs_luks_format_cipher"
12465 #: ../src/guestfs-actions.pod:3868
12469 " guestfs_luks_format_cipher (guestfs_h *g,\n"
12470 " const char *device,\n"
12471 " const char *key,\n"
12473 " const char *cipher);\n"
12478 #: ../src/guestfs-actions.pod:3875
12480 "This command is the same as C<guestfs_luks_format> but it also allows you to "
12481 "set the C<cipher> used."
12485 #: ../src/guestfs-actions.pod:3889
12486 msgid "guestfs_luks_kill_slot"
12490 #: ../src/guestfs-actions.pod:3891
12494 " guestfs_luks_kill_slot (guestfs_h *g,\n"
12495 " const char *device,\n"
12496 " const char *key,\n"
12502 #: ../src/guestfs-actions.pod:3897 ../fish/guestfish-actions.pod:2683
12504 "This command deletes the key in key slot C<keyslot> from the encrypted LUKS "
12505 "device C<device>. C<key> must be one of the I<other> keys."
12509 #: ../src/guestfs-actions.pod:3909
12510 msgid "guestfs_luks_open"
12514 #: ../src/guestfs-actions.pod:3911
12518 " guestfs_luks_open (guestfs_h *g,\n"
12519 " const char *device,\n"
12520 " const char *key,\n"
12521 " const char *mapname);\n"
12526 #: ../src/guestfs-actions.pod:3917 ../fish/guestfish-actions.pod:2694
12528 "This command opens a block device which has been encrypted according to the "
12529 "Linux Unified Key Setup (LUKS) standard."
12533 #: ../src/guestfs-actions.pod:3920 ../fish/guestfish-actions.pod:2697
12534 msgid "C<device> is the encrypted block device or partition."
12538 #: ../src/guestfs-actions.pod:3922 ../fish/guestfish-actions.pod:2699
12540 "The caller must supply one of the keys associated with the LUKS block "
12541 "device, in the C<key> parameter."
12545 #: ../src/guestfs-actions.pod:3925 ../fish/guestfish-actions.pod:2702
12547 "This creates a new block device called C</dev/mapper/mapname>. Reads and "
12548 "writes to this block device are decrypted from and encrypted to the "
12549 "underlying C<device> respectively."
12553 #: ../src/guestfs-actions.pod:3929
12555 "If this block device contains LVM volume groups, then calling "
12556 "C<guestfs_vgscan> followed by C<guestfs_vg_activate_all> will make them "
12561 #: ../src/guestfs-actions.pod:3941
12562 msgid "guestfs_luks_open_ro"
12566 #: ../src/guestfs-actions.pod:3943
12570 " guestfs_luks_open_ro (guestfs_h *g,\n"
12571 " const char *device,\n"
12572 " const char *key,\n"
12573 " const char *mapname);\n"
12578 #: ../src/guestfs-actions.pod:3949
12580 "This is the same as C<guestfs_luks_open> except that a read-only mapping is "
12585 #: ../src/guestfs-actions.pod:3960
12586 msgid "guestfs_lvcreate"
12590 #: ../src/guestfs-actions.pod:3962
12594 " guestfs_lvcreate (guestfs_h *g,\n"
12595 " const char *logvol,\n"
12596 " const char *volgroup,\n"
12602 #: ../src/guestfs-actions.pod:3968 ../fish/guestfish-actions.pod:2727
12604 "This creates an LVM logical volume called C<logvol> on the volume group "
12605 "C<volgroup>, with C<size> megabytes."
12609 #: ../src/guestfs-actions.pod:3975
12610 msgid "guestfs_lvm_canonical_lv_name"
12614 #: ../src/guestfs-actions.pod:3977
12618 " guestfs_lvm_canonical_lv_name (guestfs_h *g,\n"
12619 " const char *lvname);\n"
12624 #: ../src/guestfs-actions.pod:3981 ../fish/guestfish-actions.pod:2734
12626 "This converts alternative naming schemes for LVs that you might find to the "
12627 "canonical name. For example, C</dev/mapper/VG-LV> is converted to C</dev/VG/"
12632 #: ../src/guestfs-actions.pod:3985 ../fish/guestfish-actions.pod:2738
12634 "This command returns an error if the C<lvname> parameter does not refer to a "
12639 #: ../src/guestfs-actions.pod:3988
12640 msgid "See also C<guestfs_is_lv>."
12644 #: ../src/guestfs-actions.pod:3993
12645 msgid "(Added in 1.5.24)"
12649 #: ../src/guestfs-actions.pod:3995
12650 msgid "guestfs_lvm_clear_filter"
12654 #: ../src/guestfs-actions.pod:3997
12658 " guestfs_lvm_clear_filter (guestfs_h *g);\n"
12663 #: ../src/guestfs-actions.pod:4000
12665 "This undoes the effect of C<guestfs_lvm_set_filter>. LVM will be able to "
12666 "see every block device."
12670 #: ../src/guestfs-actions.pod:4003 ../src/guestfs-actions.pod:4045
12671 #: ../fish/guestfish-actions.pod:2750 ../fish/guestfish-actions.pod:2781
12673 "This command also clears the LVM cache and performs a volume group scan."
12677 #: ../src/guestfs-actions.pod:4010
12678 msgid "guestfs_lvm_remove_all"
12682 #: ../src/guestfs-actions.pod:4012
12686 " guestfs_lvm_remove_all (guestfs_h *g);\n"
12691 #: ../src/guestfs-actions.pod:4015 ../fish/guestfish-actions.pod:2757
12693 "This command removes all LVM logical volumes, volume groups and physical "
12698 #: ../src/guestfs-actions.pod:4025
12699 msgid "guestfs_lvm_set_filter"
12703 #: ../src/guestfs-actions.pod:4027
12707 " guestfs_lvm_set_filter (guestfs_h *g,\n"
12708 " char *const *devices);\n"
12713 #: ../src/guestfs-actions.pod:4031 ../fish/guestfish-actions.pod:2767
12715 "This sets the LVM device filter so that LVM will only be able to \"see\" the "
12716 "block devices in the list C<devices>, and will ignore all other attached "
12721 #: ../src/guestfs-actions.pod:4035 ../fish/guestfish-actions.pod:2771
12723 "Where disk image(s) contain duplicate PVs or VGs, this command is useful to "
12724 "get LVM to ignore the duplicates, otherwise LVM can get confused. Note also "
12725 "there are two types of duplication possible: either cloned PVs/VGs which "
12726 "have identical UUIDs; or VGs that are not cloned but just happen to have the "
12727 "same name. In normal operation you cannot create this situation, but you "
12728 "can do it outside LVM, eg. by cloning disk images or by bit twiddling "
12729 "inside the LVM metadata."
12733 #: ../src/guestfs-actions.pod:4048 ../fish/guestfish-actions.pod:2784
12734 msgid "You can filter whole block devices or individual partitions."
12738 #: ../src/guestfs-actions.pod:4050 ../fish/guestfish-actions.pod:2786
12740 "You cannot use this if any VG is currently in use (eg. contains a mounted "
12741 "filesystem), even if you are not filtering out that VG."
12745 #: ../src/guestfs-actions.pod:4058
12746 msgid "guestfs_lvremove"
12750 #: ../src/guestfs-actions.pod:4060
12754 " guestfs_lvremove (guestfs_h *g,\n"
12755 " const char *device);\n"
12760 #: ../src/guestfs-actions.pod:4064 ../fish/guestfish-actions.pod:2794
12762 "Remove an LVM logical volume C<device>, where C<device> is the path to the "
12763 "LV, such as C</dev/VG/LV>."
12767 #: ../src/guestfs-actions.pod:4067 ../fish/guestfish-actions.pod:2797
12769 "You can also remove all LVs in a volume group by specifying the VG name, C</"
12774 #: ../src/guestfs-actions.pod:4072 ../src/guestfs-actions.pod:5308
12775 #: ../src/guestfs-actions.pod:7097
12776 msgid "(Added in 1.0.13)"
12780 #: ../src/guestfs-actions.pod:4074
12781 msgid "guestfs_lvrename"
12785 #: ../src/guestfs-actions.pod:4076
12789 " guestfs_lvrename (guestfs_h *g,\n"
12790 " const char *logvol,\n"
12791 " const char *newlogvol);\n"
12796 #: ../src/guestfs-actions.pod:4081 ../fish/guestfish-actions.pod:2804
12797 msgid "Rename a logical volume C<logvol> with the new name C<newlogvol>."
12801 #: ../src/guestfs-actions.pod:4085 ../src/guestfs-actions.pod:7110
12802 msgid "(Added in 1.0.83)"
12806 #: ../src/guestfs-actions.pod:4087
12807 msgid "guestfs_lvresize"
12811 #: ../src/guestfs-actions.pod:4089
12815 " guestfs_lvresize (guestfs_h *g,\n"
12816 " const char *device,\n"
12822 #: ../src/guestfs-actions.pod:4094 ../fish/guestfish-actions.pod:2810
12824 "This resizes (expands or shrinks) an existing LVM logical volume to "
12825 "C<mbytes>. When reducing, data in the reduced part is lost."
12829 #: ../src/guestfs-actions.pod:4102
12830 msgid "guestfs_lvresize_free"
12834 #: ../src/guestfs-actions.pod:4104
12838 " guestfs_lvresize_free (guestfs_h *g,\n"
12839 " const char *lv,\n"
12845 #: ../src/guestfs-actions.pod:4109 ../fish/guestfish-actions.pod:2818
12847 "This expands an existing logical volume C<lv> so that it fills C<pc>% of the "
12848 "remaining free space in the volume group. Commonly you would call this with "
12849 "pc = 100 which expands the logical volume as much as possible, using all "
12850 "remaining free space in the volume group."
12854 #: ../src/guestfs-actions.pod:4117
12855 msgid "(Added in 1.3.3)"
12859 #: ../src/guestfs-actions.pod:4119
12860 msgid "guestfs_lvs"
12864 #: ../src/guestfs-actions.pod:4121
12868 " guestfs_lvs (guestfs_h *g);\n"
12873 #: ../src/guestfs-actions.pod:4124 ../fish/guestfish-actions.pod:2828
12875 "List all the logical volumes detected. This is the equivalent of the L<lvs"
12880 #: ../src/guestfs-actions.pod:4127 ../fish/guestfish-actions.pod:2831
12882 "This returns a list of the logical volume device names (eg. C</dev/"
12883 "VolGroup00/LogVol00>)."
12887 #: ../src/guestfs-actions.pod:4130
12888 msgid "See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>."
12892 #: ../src/guestfs-actions.pod:4138
12893 msgid "guestfs_lvs_full"
12897 #: ../src/guestfs-actions.pod:4140
12900 " struct guestfs_lvm_lv_list *\n"
12901 " guestfs_lvs_full (guestfs_h *g);\n"
12906 #: ../src/guestfs-actions.pod:4143 ../fish/guestfish-actions.pod:2840
12908 "List all the logical volumes detected. This is the equivalent of the L<lvs"
12909 "(8)> command. The \"full\" version includes all fields."
12913 #: ../src/guestfs-actions.pod:4146
12915 "This function returns a C<struct guestfs_lvm_lv_list *>, or NULL if there "
12916 "was an error. I<The caller must call C<guestfs_free_lvm_lv_list> after use>."
12920 #: ../src/guestfs-actions.pod:4152
12921 msgid "guestfs_lvuuid"
12925 #: ../src/guestfs-actions.pod:4154
12929 " guestfs_lvuuid (guestfs_h *g,\n"
12930 " const char *device);\n"
12935 #: ../src/guestfs-actions.pod:4158 ../fish/guestfish-actions.pod:2847
12936 msgid "This command returns the UUID of the LVM LV C<device>."
12940 #: ../src/guestfs-actions.pod:4165
12941 msgid "guestfs_lxattrlist"
12945 #: ../src/guestfs-actions.pod:4167
12948 " struct guestfs_xattr_list *\n"
12949 " guestfs_lxattrlist (guestfs_h *g,\n"
12950 " const char *path,\n"
12951 " char *const *names);\n"
12956 #: ../src/guestfs-actions.pod:4172 ../fish/guestfish-actions.pod:2853
12958 "This call allows you to get the extended attributes of multiple files, where "
12959 "all files are in the directory C<path>. C<names> is the list of files from "
12964 #: ../src/guestfs-actions.pod:4176 ../fish/guestfish-actions.pod:2857
12966 "On return you get a flat list of xattr structs which must be interpreted "
12967 "sequentially. The first xattr struct always has a zero-length C<attrname>. "
12968 "C<attrval> in this struct is zero-length to indicate there was an error "
12969 "doing C<lgetxattr> for this file, I<or> is a C string which is a decimal "
12970 "number (the number of following attributes for this file, which could be C<"
12971 "\"0\">). Then after the first xattr struct are the zero or more attributes "
12972 "for the first named file. This repeats for the second and subsequent files."
12976 #: ../src/guestfs-actions.pod:4186
12978 "This call is intended for programs that want to efficiently list a directory "
12979 "contents without making many round-trips. See also C<guestfs_lstatlist> for "
12980 "a similarly efficient call for getting standard stats. Very long directory "
12981 "listings might cause the protocol message size to be exceeded, causing this "
12982 "call to fail. The caller must split up such requests into smaller groups of "
12987 #: ../src/guestfs-actions.pod:4200
12988 msgid "guestfs_mkdir"
12992 #: ../src/guestfs-actions.pod:4202
12996 " guestfs_mkdir (guestfs_h *g,\n"
12997 " const char *path);\n"
13002 #: ../src/guestfs-actions.pod:4206 ../fish/guestfish-actions.pod:2879
13003 msgid "Create a directory named C<path>."
13007 #: ../src/guestfs-actions.pod:4212
13008 msgid "guestfs_mkdir_mode"
13012 #: ../src/guestfs-actions.pod:4214
13016 " guestfs_mkdir_mode (guestfs_h *g,\n"
13017 " const char *path,\n"
13023 #: ../src/guestfs-actions.pod:4219 ../fish/guestfish-actions.pod:2885
13025 "This command creates a directory, setting the initial permissions of the "
13026 "directory to C<mode>."
13030 #: ../src/guestfs-actions.pod:4222 ../fish/guestfish-actions.pod:2888
13032 "For common Linux filesystems, the actual mode which is set will be C<mode & "
13033 "~umask & 01777>. Non-native-Linux filesystems may interpret the mode in "
13038 #: ../src/guestfs-actions.pod:4226
13039 msgid "See also C<guestfs_mkdir>, C<guestfs_umask>"
13043 #: ../src/guestfs-actions.pod:4232
13044 msgid "guestfs_mkdir_p"
13048 #: ../src/guestfs-actions.pod:4234
13052 " guestfs_mkdir_p (guestfs_h *g,\n"
13053 " const char *path);\n"
13058 #: ../src/guestfs-actions.pod:4238 ../fish/guestfish-actions.pod:2898
13060 "Create a directory named C<path>, creating any parent directories as "
13061 "necessary. This is like the C<mkdir -p> shell command."
13065 #: ../src/guestfs-actions.pod:4245
13066 msgid "guestfs_mkdtemp"
13070 #: ../src/guestfs-actions.pod:4247
13074 " guestfs_mkdtemp (guestfs_h *g,\n"
13075 " const char *template);\n"
13080 #: ../src/guestfs-actions.pod:4251 ../fish/guestfish-actions.pod:2905
13082 "This command creates a temporary directory. The C<template> parameter "
13083 "should be a full pathname for the temporary directory name with the final "
13084 "six characters being \"XXXXXX\"."
13088 #: ../src/guestfs-actions.pod:4256 ../fish/guestfish-actions.pod:2910
13090 "For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\", the second one "
13091 "being suitable for Windows filesystems."
13095 #: ../src/guestfs-actions.pod:4259 ../fish/guestfish-actions.pod:2913
13096 msgid "The name of the temporary directory that was created is returned."
13100 #: ../src/guestfs-actions.pod:4262 ../fish/guestfish-actions.pod:2916
13101 msgid "The temporary directory is created with mode 0700 and is owned by root."
13105 #: ../src/guestfs-actions.pod:4265 ../fish/guestfish-actions.pod:2919
13107 "The caller is responsible for deleting the temporary directory and its "
13108 "contents after use."
13112 #: ../src/guestfs-actions.pod:4268 ../fish/guestfish-actions.pod:2922
13113 msgid "See also: L<mkdtemp(3)>"
13117 #: ../src/guestfs-actions.pod:4275
13118 msgid "guestfs_mke2fs_J"
13122 #: ../src/guestfs-actions.pod:4277
13126 " guestfs_mke2fs_J (guestfs_h *g,\n"
13127 " const char *fstype,\n"
13128 " int blocksize,\n"
13129 " const char *device,\n"
13130 " const char *journal);\n"
13135 #: ../src/guestfs-actions.pod:4284 ../fish/guestfish-actions.pod:2928
13137 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
13138 "C<journal>. It is equivalent to the command:"
13142 #: ../src/guestfs-actions.pod:4288 ../fish/guestfish-actions.pod:2932
13145 " mke2fs -t fstype -b blocksize -J device=<journal> <device>\n"
13150 #: ../src/guestfs-actions.pod:4290
13151 msgid "See also C<guestfs_mke2journal>."
13155 #: ../src/guestfs-actions.pod:4294 ../src/guestfs-actions.pod:4312
13156 #: ../src/guestfs-actions.pod:4330 ../src/guestfs-actions.pod:4346
13157 #: ../src/guestfs-actions.pod:4360 ../src/guestfs-actions.pod:4374
13158 #: ../src/guestfs-actions.pod:4433 ../src/guestfs-actions.pod:4698
13159 msgid "(Added in 1.0.68)"
13163 #: ../src/guestfs-actions.pod:4296
13164 msgid "guestfs_mke2fs_JL"
13168 #: ../src/guestfs-actions.pod:4298
13172 " guestfs_mke2fs_JL (guestfs_h *g,\n"
13173 " const char *fstype,\n"
13174 " int blocksize,\n"
13175 " const char *device,\n"
13176 " const char *label);\n"
13181 #: ../src/guestfs-actions.pod:4305 ../fish/guestfish-actions.pod:2940
13183 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
13184 "the journal labeled C<label>."
13188 #: ../src/guestfs-actions.pod:4308
13189 msgid "See also C<guestfs_mke2journal_L>."
13193 #: ../src/guestfs-actions.pod:4314
13194 msgid "guestfs_mke2fs_JU"
13198 #: ../src/guestfs-actions.pod:4316
13202 " guestfs_mke2fs_JU (guestfs_h *g,\n"
13203 " const char *fstype,\n"
13204 " int blocksize,\n"
13205 " const char *device,\n"
13206 " const char *uuid);\n"
13211 #: ../src/guestfs-actions.pod:4323 ../fish/guestfish-actions.pod:2949
13213 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
13214 "the journal with UUID C<uuid>."
13218 #: ../src/guestfs-actions.pod:4326
13219 msgid "See also C<guestfs_mke2journal_U>."
13223 #: ../src/guestfs-actions.pod:4332
13224 msgid "guestfs_mke2journal"
13228 #: ../src/guestfs-actions.pod:4334
13232 " guestfs_mke2journal (guestfs_h *g,\n"
13233 " int blocksize,\n"
13234 " const char *device);\n"
13239 #: ../src/guestfs-actions.pod:4339 ../fish/guestfish-actions.pod:2958
13241 "This creates an ext2 external journal on C<device>. It is equivalent to the "
13246 #: ../src/guestfs-actions.pod:4342 ../fish/guestfish-actions.pod:2961
13249 " mke2fs -O journal_dev -b blocksize device\n"
13254 #: ../src/guestfs-actions.pod:4348
13255 msgid "guestfs_mke2journal_L"
13259 #: ../src/guestfs-actions.pod:4350
13263 " guestfs_mke2journal_L (guestfs_h *g,\n"
13264 " int blocksize,\n"
13265 " const char *label,\n"
13266 " const char *device);\n"
13271 #: ../src/guestfs-actions.pod:4356 ../fish/guestfish-actions.pod:2967
13272 msgid "This creates an ext2 external journal on C<device> with label C<label>."
13276 #: ../src/guestfs-actions.pod:4362
13277 msgid "guestfs_mke2journal_U"
13281 #: ../src/guestfs-actions.pod:4364
13285 " guestfs_mke2journal_U (guestfs_h *g,\n"
13286 " int blocksize,\n"
13287 " const char *uuid,\n"
13288 " const char *device);\n"
13293 #: ../src/guestfs-actions.pod:4370 ../fish/guestfish-actions.pod:2973
13294 msgid "This creates an ext2 external journal on C<device> with UUID C<uuid>."
13298 #: ../src/guestfs-actions.pod:4376
13299 msgid "guestfs_mkfifo"
13303 #: ../src/guestfs-actions.pod:4378
13307 " guestfs_mkfifo (guestfs_h *g,\n"
13309 " const char *path);\n"
13314 #: ../src/guestfs-actions.pod:4383
13316 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
13317 "is just a convenient wrapper around C<guestfs_mknod>."
13321 #: ../src/guestfs-actions.pod:4393
13322 msgid "guestfs_mkfs"
13326 #: ../src/guestfs-actions.pod:4395
13330 " guestfs_mkfs (guestfs_h *g,\n"
13331 " const char *fstype,\n"
13332 " const char *device);\n"
13337 #: ../src/guestfs-actions.pod:4400 ../fish/guestfish-actions.pod:2989
13339 "This creates a filesystem on C<device> (usually a partition or LVM logical "
13340 "volume). The filesystem type is C<fstype>, for example C<ext3>."
13344 #: ../src/guestfs-actions.pod:4408
13345 msgid "guestfs_mkfs_b"
13349 #: ../src/guestfs-actions.pod:4410
13353 " guestfs_mkfs_b (guestfs_h *g,\n"
13354 " const char *fstype,\n"
13355 " int blocksize,\n"
13356 " const char *device);\n"
13361 #: ../src/guestfs-actions.pod:4416
13363 "This call is similar to C<guestfs_mkfs>, but it allows you to control the "
13364 "block size of the resulting filesystem. Supported block sizes depend on the "
13365 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
13369 #: ../src/guestfs-actions.pod:4421 ../src/guestfs-actions.pod:4464
13370 #: ../fish/guestfish-actions.pod:3002 ../fish/guestfish-actions.pod:3029
13372 "For VFAT and NTFS the C<blocksize> parameter is treated as the requested "
13377 #: ../src/guestfs-actions.pod:4426 ../fish/guestfish-actions.pod:3005
13379 "This function is deprecated. In new code, use the C<mkfs_opts> call instead."
13383 #: ../src/guestfs-actions.pod:4435
13384 msgid "guestfs_mkfs_opts"
13388 #: ../src/guestfs-actions.pod:4437
13392 " guestfs_mkfs_opts (guestfs_h *g,\n"
13393 " const char *fstype,\n"
13394 " const char *device,\n"
13400 #: ../src/guestfs-actions.pod:4448
13403 " GUESTFS_MKFS_OPTS_BLOCKSIZE, int blocksize,\n"
13404 " GUESTFS_MKFS_OPTS_FEATURES, const char *features,\n"
13409 #: ../src/guestfs-actions.pod:4451 ../fish/guestfish-actions.pod:3016
13411 "This function creates a filesystem on C<device>. The filesystem type is "
13412 "C<fstype>, for example C<ext3>."
13416 #: ../src/guestfs-actions.pod:4458 ../fish/guestfish-actions.pod:3023
13417 msgid "C<blocksize>"
13421 #: ../src/guestfs-actions.pod:4460 ../fish/guestfish-actions.pod:3025
13423 "The filesystem block size. Supported block sizes depend on the filesystem "
13424 "type, but typically they are C<1024>, C<2048> or C<4096> for Linux ext2/3 "
13429 #: ../src/guestfs-actions.pod:4467 ../fish/guestfish-actions.pod:3032
13430 msgid "For UFS block sizes, please see L<mkfs.ufs(8)>."
13434 #: ../src/guestfs-actions.pod:4469 ../fish/guestfish-actions.pod:3034
13435 msgid "C<features>"
13439 #: ../src/guestfs-actions.pod:4471 ../fish/guestfish-actions.pod:3036
13440 msgid "This passes the C<-O> parameter to the external mkfs program."
13444 #: ../src/guestfs-actions.pod:4473 ../fish/guestfish-actions.pod:3038
13446 "For certain filesystem types, this allows extra filesystem features to be "
13447 "selected. See L<mke2fs(8)> and L<mkfs.ufs(8)> for more details."
13451 #: ../src/guestfs-actions.pod:4477 ../fish/guestfish-actions.pod:3042
13453 "You cannot use this optional parameter with the C<gfs> or C<gfs2> filesystem "
13458 #: ../src/guestfs-actions.pod:4484
13459 msgid "(Added in 1.7.19)"
13463 #: ../src/guestfs-actions.pod:4486
13464 msgid "guestfs_mkfs_opts_va"
13468 #: ../src/guestfs-actions.pod:4488
13472 " guestfs_mkfs_opts_va (guestfs_h *g,\n"
13473 " const char *fstype,\n"
13474 " const char *device,\n"
13475 " va_list args);\n"
13480 #: ../src/guestfs-actions.pod:4494
13481 msgid "This is the \"va_list variant\" of L</guestfs_mkfs_opts>."
13485 #: ../src/guestfs-actions.pod:4498
13486 msgid "guestfs_mkfs_opts_argv"
13490 #: ../src/guestfs-actions.pod:4500
13494 " guestfs_mkfs_opts_argv (guestfs_h *g,\n"
13495 " const char *fstype,\n"
13496 " const char *device,\n"
13497 " const struct guestfs_mkfs_opts_argv *optargs);\n"
13502 #: ../src/guestfs-actions.pod:4506
13503 msgid "This is the \"argv variant\" of L</guestfs_mkfs_opts>."
13507 #: ../src/guestfs-actions.pod:4510
13508 msgid "guestfs_mkmountpoint"
13512 #: ../src/guestfs-actions.pod:4512
13516 " guestfs_mkmountpoint (guestfs_h *g,\n"
13517 " const char *exemptpath);\n"
13522 #: ../src/guestfs-actions.pod:4516
13524 "C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are specialized calls "
13525 "that can be used to create extra mountpoints before mounting the first "
13530 #: ../src/guestfs-actions.pod:4520 ../fish/guestfish-actions.pod:3057
13532 "These calls are I<only> necessary in some very limited circumstances, mainly "
13533 "the case where you want to mount a mix of unrelated and/or read-only "
13534 "filesystems together."
13538 #: ../src/guestfs-actions.pod:4524 ../fish/guestfish-actions.pod:3061
13540 "For example, live CDs often contain a \"Russian doll\" nest of filesystems, "
13541 "an ISO outer layer, with a squashfs image inside, with an ext2/3 image "
13542 "inside that. You can unpack this as follows in guestfish:"
13546 #: ../src/guestfs-actions.pod:4529 ../fish/guestfish-actions.pod:3066
13549 " add-ro Fedora-11-i686-Live.iso\n"
13551 " mkmountpoint /cd\n"
13552 " mkmountpoint /sqsh\n"
13553 " mkmountpoint /ext3fs\n"
13554 " mount /dev/sda /cd\n"
13555 " mount-loop /cd/LiveOS/squashfs.img /sqsh\n"
13556 " mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs\n"
13561 #: ../src/guestfs-actions.pod:4538 ../fish/guestfish-actions.pod:3075
13562 msgid "The inner filesystem is now unpacked under the /ext3fs mountpoint."
13566 #: ../src/guestfs-actions.pod:4540
13568 "C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>. You "
13569 "may get unexpected errors if you try to mix these calls. It is safest to "
13570 "manually unmount filesystems and remove mountpoints after use."
13574 #: ../src/guestfs-actions.pod:4544
13576 "C<guestfs_umount_all> unmounts filesystems by sorting the paths longest "
13577 "first, so for this to work for manual mountpoints, you must ensure that the "
13578 "innermost mountpoints have the longest pathnames, as in the example code "
13583 #: ../src/guestfs-actions.pod:4549 ../fish/guestfish-actions.pod:3086
13585 "For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>"
13589 #: ../src/guestfs-actions.pod:4551
13591 "Autosync [see C<guestfs_set_autosync>, this is set by default on handles] "
13592 "can cause C<guestfs_umount_all> to be called when the handle is closed which "
13593 "can also trigger these issues."
13597 #: ../src/guestfs-actions.pod:4557 ../src/guestfs-actions.pod:4816
13598 #: ../src/guestfs-actions.pod:5726
13599 msgid "(Added in 1.0.62)"
13603 #: ../src/guestfs-actions.pod:4559
13604 msgid "guestfs_mknod"
13608 #: ../src/guestfs-actions.pod:4561
13612 " guestfs_mknod (guestfs_h *g,\n"
13616 " const char *path);\n"
13621 #: ../src/guestfs-actions.pod:4568 ../fish/guestfish-actions.pod:3096
13623 "This call creates block or character special devices, or named pipes (FIFOs)."
13627 #: ../src/guestfs-actions.pod:4571 ../fish/guestfish-actions.pod:3099
13629 "The C<mode> parameter should be the mode, using the standard constants. "
13630 "C<devmajor> and C<devminor> are the device major and minor numbers, only "
13631 "used when creating block and character special devices."
13635 #: ../src/guestfs-actions.pod:4576
13637 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
13638 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
13639 "regular file). These constants are available in the standard Linux header "
13640 "files, or you can use C<guestfs_mknod_b>, C<guestfs_mknod_c> or "
13641 "C<guestfs_mkfifo> which are wrappers around this command which bitwise OR in "
13642 "the appropriate constant for you."
13646 #: ../src/guestfs-actions.pod:4590
13647 msgid "guestfs_mknod_b"
13651 #: ../src/guestfs-actions.pod:4592
13655 " guestfs_mknod_b (guestfs_h *g,\n"
13659 " const char *path);\n"
13664 #: ../src/guestfs-actions.pod:4599
13666 "This call creates a block device node called C<path> with mode C<mode> and "
13667 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
13668 "wrapper around C<guestfs_mknod>."
13672 #: ../src/guestfs-actions.pod:4609
13673 msgid "guestfs_mknod_c"
13677 #: ../src/guestfs-actions.pod:4611
13681 " guestfs_mknod_c (guestfs_h *g,\n"
13685 " const char *path);\n"
13690 #: ../src/guestfs-actions.pod:4618
13692 "This call creates a char device node called C<path> with mode C<mode> and "
13693 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
13694 "wrapper around C<guestfs_mknod>."
13698 #: ../src/guestfs-actions.pod:4628
13699 msgid "guestfs_mkswap"
13703 #: ../src/guestfs-actions.pod:4630
13707 " guestfs_mkswap (guestfs_h *g,\n"
13708 " const char *device);\n"
13713 #: ../src/guestfs-actions.pod:4634 ../fish/guestfish-actions.pod:3138
13714 msgid "Create a swap partition on C<device>."
13718 #: ../src/guestfs-actions.pod:4640
13719 msgid "guestfs_mkswap_L"
13723 #: ../src/guestfs-actions.pod:4642
13727 " guestfs_mkswap_L (guestfs_h *g,\n"
13728 " const char *label,\n"
13729 " const char *device);\n"
13734 #: ../src/guestfs-actions.pod:4647 ../fish/guestfish-actions.pod:3144
13735 msgid "Create a swap partition on C<device> with label C<label>."
13739 #: ../src/guestfs-actions.pod:4649 ../fish/guestfish-actions.pod:3146
13741 "Note that you cannot attach a swap label to a block device (eg. C</dev/"
13742 "sda>), just to a partition. This appears to be a limitation of the kernel "
13747 #: ../src/guestfs-actions.pod:4657
13748 msgid "guestfs_mkswap_U"
13752 #: ../src/guestfs-actions.pod:4659
13756 " guestfs_mkswap_U (guestfs_h *g,\n"
13757 " const char *uuid,\n"
13758 " const char *device);\n"
13763 #: ../src/guestfs-actions.pod:4664 ../fish/guestfish-actions.pod:3154
13764 msgid "Create a swap partition on C<device> with UUID C<uuid>."
13768 #: ../src/guestfs-actions.pod:4670
13769 msgid "guestfs_mkswap_file"
13773 #: ../src/guestfs-actions.pod:4672
13777 " guestfs_mkswap_file (guestfs_h *g,\n"
13778 " const char *path);\n"
13783 #: ../src/guestfs-actions.pod:4676 ../fish/guestfish-actions.pod:3160
13784 msgid "Create a swap file."
13788 #: ../src/guestfs-actions.pod:4678
13790 "This command just writes a swap file signature to an existing file. To "
13791 "create the file itself, use something like C<guestfs_fallocate>."
13795 #: ../src/guestfs-actions.pod:4685
13796 msgid "guestfs_modprobe"
13800 #: ../src/guestfs-actions.pod:4687
13804 " guestfs_modprobe (guestfs_h *g,\n"
13805 " const char *modulename);\n"
13810 #: ../src/guestfs-actions.pod:4691 ../fish/guestfish-actions.pod:3169
13811 msgid "This loads a kernel module in the appliance."
13815 #: ../src/guestfs-actions.pod:4693 ../fish/guestfish-actions.pod:3171
13817 "The kernel module must have been whitelisted when libguestfs was built (see "
13818 "C<appliance/kmod.whitelist.in> in the source)."
13822 #: ../src/guestfs-actions.pod:4700
13823 msgid "guestfs_mount"
13827 #: ../src/guestfs-actions.pod:4702
13831 " guestfs_mount (guestfs_h *g,\n"
13832 " const char *device,\n"
13833 " const char *mountpoint);\n"
13838 #: ../src/guestfs-actions.pod:4707 ../fish/guestfish-actions.pod:3178
13840 "Mount a guest disk at a position in the filesystem. Block devices are named "
13841 "C</dev/sda>, C</dev/sdb> and so on, as they were added to the guest. If "
13842 "those block devices contain partitions, they will have the usual names (eg. "
13843 "C</dev/sda1>). Also LVM C</dev/VG/LV>-style names can be used."
13847 #: ../src/guestfs-actions.pod:4713 ../fish/guestfish-actions.pod:3184
13849 "The rules are the same as for L<mount(2)>: A filesystem must first be "
13850 "mounted on C</> before others can be mounted. Other filesystems can only be "
13851 "mounted on directories which already exist."
13855 #: ../src/guestfs-actions.pod:4718 ../fish/guestfish-actions.pod:3189
13857 "The mounted filesystem is writable, if we have sufficient permissions on the "
13858 "underlying device."
13862 #: ../src/guestfs-actions.pod:4721
13864 "B<Important note:> When you use this call, the filesystem options C<sync> "
13865 "and C<noatime> are set implicitly. This was originally done because we "
13866 "thought it would improve reliability, but it turns out that I<-o sync> has a "
13867 "very large negative performance impact and negligible effect on "
13868 "reliability. Therefore we recommend that you avoid using C<guestfs_mount> "
13869 "in any code that needs performance, and instead use C<guestfs_mount_options> "
13870 "(use an empty string for the first parameter if you don't want any options)."
13874 #: ../src/guestfs-actions.pod:4735
13875 msgid "guestfs_mount_loop"
13879 #: ../src/guestfs-actions.pod:4737
13883 " guestfs_mount_loop (guestfs_h *g,\n"
13884 " const char *file,\n"
13885 " const char *mountpoint);\n"
13890 #: ../src/guestfs-actions.pod:4742 ../fish/guestfish-actions.pod:3206
13892 "This command lets you mount C<file> (a filesystem image in a file) on a "
13893 "mount point. It is entirely equivalent to the command C<mount -o loop file "
13898 #: ../src/guestfs-actions.pod:4750
13899 msgid "guestfs_mount_options"
13903 #: ../src/guestfs-actions.pod:4752
13907 " guestfs_mount_options (guestfs_h *g,\n"
13908 " const char *options,\n"
13909 " const char *device,\n"
13910 " const char *mountpoint);\n"
13915 #: ../src/guestfs-actions.pod:4758
13917 "This is the same as the C<guestfs_mount> command, but it allows you to set "
13918 "the mount options as for the L<mount(8)> I<-o> flag."
13922 #: ../src/guestfs-actions.pod:4762 ../fish/guestfish-actions.pod:3218
13924 "If the C<options> parameter is an empty string, then no options are passed "
13925 "(all options default to whatever the filesystem uses)."
13929 #: ../src/guestfs-actions.pod:4768 ../src/guestfs-actions.pod:4782
13930 #: ../src/guestfs-actions.pod:4799
13931 msgid "(Added in 1.0.10)"
13935 #: ../src/guestfs-actions.pod:4770
13936 msgid "guestfs_mount_ro"
13940 #: ../src/guestfs-actions.pod:4772
13944 " guestfs_mount_ro (guestfs_h *g,\n"
13945 " const char *device,\n"
13946 " const char *mountpoint);\n"
13951 #: ../src/guestfs-actions.pod:4777
13953 "This is the same as the C<guestfs_mount> command, but it mounts the "
13954 "filesystem with the read-only (I<-o ro>) flag."
13958 #: ../src/guestfs-actions.pod:4784
13959 msgid "guestfs_mount_vfs"
13963 #: ../src/guestfs-actions.pod:4786
13967 " guestfs_mount_vfs (guestfs_h *g,\n"
13968 " const char *options,\n"
13969 " const char *vfstype,\n"
13970 " const char *device,\n"
13971 " const char *mountpoint);\n"
13976 #: ../src/guestfs-actions.pod:4793
13978 "This is the same as the C<guestfs_mount> command, but it allows you to set "
13979 "both the mount options and the vfstype as for the L<mount(8)> I<-o> and I<-"
13984 #: ../src/guestfs-actions.pod:4801
13985 msgid "guestfs_mountpoints"
13989 #: ../src/guestfs-actions.pod:4803
13993 " guestfs_mountpoints (guestfs_h *g);\n"
13998 #: ../src/guestfs-actions.pod:4806
14000 "This call is similar to C<guestfs_mounts>. That call returns a list of "
14001 "devices. This one returns a hash table (map) of device name to directory "
14002 "where the device is mounted."
14006 #: ../src/guestfs-actions.pod:4818
14007 msgid "guestfs_mounts"
14011 #: ../src/guestfs-actions.pod:4820
14015 " guestfs_mounts (guestfs_h *g);\n"
14020 #: ../src/guestfs-actions.pod:4823 ../fish/guestfish-actions.pod:3249
14022 "This returns the list of currently mounted filesystems. It returns the list "
14023 "of devices (eg. C</dev/sda1>, C</dev/VG/LV>)."
14027 #: ../src/guestfs-actions.pod:4826 ../fish/guestfish-actions.pod:3252
14028 msgid "Some internal mounts are not shown."
14032 #: ../src/guestfs-actions.pod:4828
14033 msgid "See also: C<guestfs_mountpoints>"
14037 #: ../src/guestfs-actions.pod:4836
14042 #: ../src/guestfs-actions.pod:4838
14046 " guestfs_mv (guestfs_h *g,\n"
14047 " const char *src,\n"
14048 " const char *dest);\n"
14053 #: ../src/guestfs-actions.pod:4843 ../fish/guestfish-actions.pod:3260
14055 "This moves a file from C<src> to C<dest> where C<dest> is either a "
14056 "destination filename or destination directory."
14060 #: ../src/guestfs-actions.pod:4850
14061 msgid "guestfs_ntfs_3g_probe"
14065 #: ../src/guestfs-actions.pod:4852
14069 " guestfs_ntfs_3g_probe (guestfs_h *g,\n"
14071 " const char *device);\n"
14076 #: ../src/guestfs-actions.pod:4857 ../fish/guestfish-actions.pod:3267
14078 "This command runs the L<ntfs-3g.probe(8)> command which probes an NTFS "
14079 "C<device> for mountability. (Not all NTFS volumes can be mounted read-"
14080 "write, and some cannot be mounted at all)."
14084 #: ../src/guestfs-actions.pod:4861 ../fish/guestfish-actions.pod:3271
14086 "C<rw> is a boolean flag. Set it to true if you want to test if the volume "
14087 "can be mounted read-write. Set it to false if you want to test if the "
14088 "volume can be mounted read-only."
14092 #: ../src/guestfs-actions.pod:4865 ../fish/guestfish-actions.pod:3275
14094 "The return value is an integer which C<0> if the operation would succeed, or "
14095 "some non-zero value documented in the L<ntfs-3g.probe(8)> manual page."
14099 #: ../src/guestfs-actions.pod:4871
14100 msgid "(Added in 1.0.43)"
14104 #: ../src/guestfs-actions.pod:4873
14105 msgid "guestfs_ntfsresize"
14109 #: ../src/guestfs-actions.pod:4875
14113 " guestfs_ntfsresize (guestfs_h *g,\n"
14114 " const char *device);\n"
14119 #: ../src/guestfs-actions.pod:4879 ../fish/guestfish-actions.pod:3283
14121 "This command resizes an NTFS filesystem, expanding or shrinking it to the "
14122 "size of the underlying device. See also L<ntfsresize(8)>."
14126 #: ../src/guestfs-actions.pod:4887
14127 msgid "guestfs_ntfsresize_size"
14131 #: ../src/guestfs-actions.pod:4889
14135 " guestfs_ntfsresize_size (guestfs_h *g,\n"
14136 " const char *device,\n"
14137 " int64_t size);\n"
14142 #: ../src/guestfs-actions.pod:4894
14144 "This command is the same as C<guestfs_ntfsresize> except that it allows you "
14145 "to specify the new size (in bytes) explicitly."
14149 #: ../src/guestfs-actions.pod:4899 ../src/guestfs-actions.pod:5335
14150 #: ../src/guestfs-actions.pod:5408 ../src/guestfs-actions.pod:5674
14151 #: ../src/guestfs-actions.pod:7245
14152 msgid "(Added in 1.3.14)"
14156 #: ../src/guestfs-actions.pod:4901
14157 msgid "guestfs_part_add"
14161 #: ../src/guestfs-actions.pod:4903
14165 " guestfs_part_add (guestfs_h *g,\n"
14166 " const char *device,\n"
14167 " const char *prlogex,\n"
14168 " int64_t startsect,\n"
14169 " int64_t endsect);\n"
14174 #: ../src/guestfs-actions.pod:4910
14176 "This command adds a partition to C<device>. If there is no partition table "
14177 "on the device, call C<guestfs_part_init> first."
14181 #: ../src/guestfs-actions.pod:4913 ../fish/guestfish-actions.pod:3301
14183 "The C<prlogex> parameter is the type of partition. Normally you should pass "
14184 "C<p> or C<primary> here, but MBR partition tables also support C<l> (or "
14185 "C<logical>) and C<e> (or C<extended>) partition types."
14189 #: ../src/guestfs-actions.pod:4918 ../fish/guestfish-actions.pod:3306
14191 "C<startsect> and C<endsect> are the start and end of the partition in "
14192 "I<sectors>. C<endsect> may be negative, which means it counts backwards "
14193 "from the end of the disk (C<-1> is the last sector)."
14197 #: ../src/guestfs-actions.pod:4922
14199 "Creating a partition which covers the whole disk is not so easy. Use "
14200 "C<guestfs_part_disk> to do that."
14204 #: ../src/guestfs-actions.pod:4927 ../src/guestfs-actions.pod:4965
14205 #: ../src/guestfs-actions.pod:5018 ../src/guestfs-actions.pod:5096
14206 #: ../src/guestfs-actions.pod:5134 ../src/guestfs-actions.pod:5153
14207 #: ../src/guestfs-actions.pod:5193
14208 msgid "(Added in 1.0.78)"
14212 #: ../src/guestfs-actions.pod:4929
14213 msgid "guestfs_part_del"
14217 #: ../src/guestfs-actions.pod:4931
14221 " guestfs_part_del (guestfs_h *g,\n"
14222 " const char *device,\n"
14228 #: ../src/guestfs-actions.pod:4936 ../fish/guestfish-actions.pod:3317
14229 msgid "This command deletes the partition numbered C<partnum> on C<device>."
14233 #: ../src/guestfs-actions.pod:4938 ../fish/guestfish-actions.pod:3319
14235 "Note that in the case of MBR partitioning, deleting an extended partition "
14236 "also deletes any logical partitions it contains."
14240 #: ../src/guestfs-actions.pod:4946
14241 msgid "guestfs_part_disk"
14245 #: ../src/guestfs-actions.pod:4948
14249 " guestfs_part_disk (guestfs_h *g,\n"
14250 " const char *device,\n"
14251 " const char *parttype);\n"
14256 #: ../src/guestfs-actions.pod:4953
14258 "This command is simply a combination of C<guestfs_part_init> followed by "
14259 "C<guestfs_part_add> to create a single primary partition covering the whole "
14264 #: ../src/guestfs-actions.pod:4957
14266 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
14267 "possible values are described in C<guestfs_part_init>."
14271 #: ../src/guestfs-actions.pod:4967
14272 msgid "guestfs_part_get_bootable"
14276 #: ../src/guestfs-actions.pod:4969
14280 " guestfs_part_get_bootable (guestfs_h *g,\n"
14281 " const char *device,\n"
14287 #: ../src/guestfs-actions.pod:4974 ../fish/guestfish-actions.pod:3341
14289 "This command returns true if the partition C<partnum> on C<device> has the "
14290 "bootable flag set."
14294 #: ../src/guestfs-actions.pod:4977
14295 msgid "See also C<guestfs_part_set_bootable>."
14299 #: ../src/guestfs-actions.pod:4983
14300 msgid "guestfs_part_get_mbr_id"
14304 #: ../src/guestfs-actions.pod:4985
14308 " guestfs_part_get_mbr_id (guestfs_h *g,\n"
14309 " const char *device,\n"
14315 #: ../src/guestfs-actions.pod:4990 ../fish/guestfish-actions.pod:3350
14317 "Returns the MBR type byte (also known as the ID byte) from the numbered "
14318 "partition C<partnum>."
14322 #: ../src/guestfs-actions.pod:4993 ../src/guestfs-actions.pod:5169
14324 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
14325 "undefined results for other partition table types (see "
14326 "C<guestfs_part_get_parttype>)."
14330 #: ../src/guestfs-actions.pod:5001
14331 msgid "guestfs_part_get_parttype"
14335 #: ../src/guestfs-actions.pod:5003
14339 " guestfs_part_get_parttype (guestfs_h *g,\n"
14340 " const char *device);\n"
14345 #: ../src/guestfs-actions.pod:5007 ../fish/guestfish-actions.pod:3361
14347 "This command examines the partition table on C<device> and returns the "
14348 "partition table type (format) being used."
14352 #: ../src/guestfs-actions.pod:5010
14354 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
14355 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
14356 "possible, although unusual. See C<guestfs_part_init> for a full list."
14360 #: ../src/guestfs-actions.pod:5020
14361 msgid "guestfs_part_init"
14365 #: ../src/guestfs-actions.pod:5022
14369 " guestfs_part_init (guestfs_h *g,\n"
14370 " const char *device,\n"
14371 " const char *parttype);\n"
14376 #: ../src/guestfs-actions.pod:5027 ../fish/guestfish-actions.pod:3373
14378 "This creates an empty partition table on C<device> of one of the partition "
14379 "types listed below. Usually C<parttype> should be either C<msdos> or C<gpt> "
14380 "(for large disks)."
14384 #: ../src/guestfs-actions.pod:5031
14386 "Initially there are no partitions. Following this, you should call "
14387 "C<guestfs_part_add> for each partition required."
14391 #: ../src/guestfs-actions.pod:5034 ../fish/guestfish-actions.pod:3380
14392 msgid "Possible values for C<parttype> are:"
14396 #: ../src/guestfs-actions.pod:5038 ../fish/guestfish-actions.pod:3384
14397 msgid "B<efi> | B<gpt>"
14401 #: ../src/guestfs-actions.pod:5040 ../fish/guestfish-actions.pod:3386
14402 msgid "Intel EFI / GPT partition table."
14406 #: ../src/guestfs-actions.pod:5042 ../fish/guestfish-actions.pod:3388
14408 "This is recommended for >= 2 TB partitions that will be accessed from Linux "
14409 "and Intel-based Mac OS X. It also has limited backwards compatibility with "
14410 "the C<mbr> format."
14414 #: ../src/guestfs-actions.pod:5046 ../fish/guestfish-actions.pod:3392
14415 msgid "B<mbr> | B<msdos>"
14419 #: ../src/guestfs-actions.pod:5048 ../fish/guestfish-actions.pod:3394
14421 "The standard PC \"Master Boot Record\" (MBR) format used by MS-DOS and "
14422 "Windows. This partition type will B<only> work for device sizes up to 2 "
14423 "TB. For large disks we recommend using C<gpt>."
14427 #: ../src/guestfs-actions.pod:5055 ../fish/guestfish-actions.pod:3401
14429 "Other partition table types that may work but are not supported include:"
14433 #: ../src/guestfs-actions.pod:5060 ../fish/guestfish-actions.pod:3406
14438 #: ../src/guestfs-actions.pod:5062 ../fish/guestfish-actions.pod:3408
14439 msgid "AIX disk labels."
14443 #: ../src/guestfs-actions.pod:5064 ../fish/guestfish-actions.pod:3410
14444 msgid "B<amiga> | B<rdb>"
14448 #: ../src/guestfs-actions.pod:5066 ../fish/guestfish-actions.pod:3412
14449 msgid "Amiga \"Rigid Disk Block\" format."
14453 #: ../src/guestfs-actions.pod:5068 ../fish/guestfish-actions.pod:3414
14458 #: ../src/guestfs-actions.pod:5070 ../fish/guestfish-actions.pod:3416
14459 msgid "BSD disk labels."
14463 #: ../src/guestfs-actions.pod:5072 ../fish/guestfish-actions.pod:3418
14468 #: ../src/guestfs-actions.pod:5074 ../fish/guestfish-actions.pod:3420
14469 msgid "DASD, used on IBM mainframes."
14473 #: ../src/guestfs-actions.pod:5076 ../fish/guestfish-actions.pod:3422
14478 #: ../src/guestfs-actions.pod:5078 ../fish/guestfish-actions.pod:3424
14479 msgid "MIPS/SGI volumes."
14483 #: ../src/guestfs-actions.pod:5080 ../fish/guestfish-actions.pod:3426
14488 #: ../src/guestfs-actions.pod:5082 ../fish/guestfish-actions.pod:3428
14489 msgid "Old Mac partition format. Modern Macs use C<gpt>."
14493 #: ../src/guestfs-actions.pod:5084 ../fish/guestfish-actions.pod:3430
14498 #: ../src/guestfs-actions.pod:5086 ../fish/guestfish-actions.pod:3432
14499 msgid "NEC PC-98 format, common in Japan apparently."
14503 #: ../src/guestfs-actions.pod:5088 ../fish/guestfish-actions.pod:3434
14508 #: ../src/guestfs-actions.pod:5090 ../fish/guestfish-actions.pod:3436
14509 msgid "Sun disk labels."
14513 #: ../src/guestfs-actions.pod:5098
14514 msgid "guestfs_part_list"
14518 #: ../src/guestfs-actions.pod:5100
14521 " struct guestfs_partition_list *\n"
14522 " guestfs_part_list (guestfs_h *g,\n"
14523 " const char *device);\n"
14528 #: ../src/guestfs-actions.pod:5104 ../fish/guestfish-actions.pod:3444
14530 "This command parses the partition table on C<device> and returns the list of "
14531 "partitions found."
14535 #: ../src/guestfs-actions.pod:5107 ../fish/guestfish-actions.pod:3447
14536 msgid "The fields in the returned structure are:"
14540 #: ../src/guestfs-actions.pod:5111 ../fish/guestfish-actions.pod:3451
14541 msgid "B<part_num>"
14545 #: ../src/guestfs-actions.pod:5113 ../fish/guestfish-actions.pod:3453
14546 msgid "Partition number, counting from 1."
14550 #: ../src/guestfs-actions.pod:5115 ../fish/guestfish-actions.pod:3455
14551 msgid "B<part_start>"
14555 #: ../src/guestfs-actions.pod:5117
14557 "Start of the partition I<in bytes>. To get sectors you have to divide by "
14558 "the device's sector size, see C<guestfs_blockdev_getss>."
14562 #: ../src/guestfs-actions.pod:5120 ../fish/guestfish-actions.pod:3460
14563 msgid "B<part_end>"
14567 #: ../src/guestfs-actions.pod:5122 ../fish/guestfish-actions.pod:3462
14568 msgid "End of the partition in bytes."
14572 #: ../src/guestfs-actions.pod:5124 ../fish/guestfish-actions.pod:3464
14573 msgid "B<part_size>"
14577 #: ../src/guestfs-actions.pod:5126 ../fish/guestfish-actions.pod:3466
14578 msgid "Size of the partition in bytes."
14582 #: ../src/guestfs-actions.pod:5130
14584 "This function returns a C<struct guestfs_partition_list *>, or NULL if there "
14585 "was an error. I<The caller must call C<guestfs_free_partition_list> after "
14590 #: ../src/guestfs-actions.pod:5136
14591 msgid "guestfs_part_set_bootable"
14595 #: ../src/guestfs-actions.pod:5138
14599 " guestfs_part_set_bootable (guestfs_h *g,\n"
14600 " const char *device,\n"
14602 " int bootable);\n"
14607 #: ../src/guestfs-actions.pod:5144 ../fish/guestfish-actions.pod:3474
14609 "This sets the bootable flag on partition numbered C<partnum> on device "
14610 "C<device>. Note that partitions are numbered from 1."
14614 #: ../src/guestfs-actions.pod:5147 ../fish/guestfish-actions.pod:3477
14616 "The bootable flag is used by some operating systems (notably Windows) to "
14617 "determine which partition to boot from. It is by no means universally "
14622 #: ../src/guestfs-actions.pod:5155
14623 msgid "guestfs_part_set_mbr_id"
14627 #: ../src/guestfs-actions.pod:5157
14631 " guestfs_part_set_mbr_id (guestfs_h *g,\n"
14632 " const char *device,\n"
14639 #: ../src/guestfs-actions.pod:5163 ../fish/guestfish-actions.pod:3485
14641 "Sets the MBR type byte (also known as the ID byte) of the numbered partition "
14642 "C<partnum> to C<idbyte>. Note that the type bytes quoted in most "
14643 "documentation are in fact hexadecimal numbers, but usually documented "
14644 "without any leading \"0x\" which might be confusing."
14648 #: ../src/guestfs-actions.pod:5177
14649 msgid "guestfs_part_set_name"
14653 #: ../src/guestfs-actions.pod:5179
14657 " guestfs_part_set_name (guestfs_h *g,\n"
14658 " const char *device,\n"
14660 " const char *name);\n"
14665 #: ../src/guestfs-actions.pod:5185 ../fish/guestfish-actions.pod:3499
14667 "This sets the partition name on partition numbered C<partnum> on device "
14668 "C<device>. Note that partitions are numbered from 1."
14672 #: ../src/guestfs-actions.pod:5188 ../fish/guestfish-actions.pod:3502
14674 "The partition name can only be set on certain types of partition table. "
14675 "This works on C<gpt> but not on C<mbr> partitions."
14679 #: ../src/guestfs-actions.pod:5195
14680 msgid "guestfs_part_to_dev"
14684 #: ../src/guestfs-actions.pod:5197
14688 " guestfs_part_to_dev (guestfs_h *g,\n"
14689 " const char *partition);\n"
14694 #: ../src/guestfs-actions.pod:5201 ../fish/guestfish-actions.pod:3509
14696 "This function takes a partition name (eg. \"/dev/sdb1\") and removes the "
14697 "partition number, returning the device name (eg. \"/dev/sdb\")."
14701 #: ../src/guestfs-actions.pod:5205
14703 "The named partition must exist, for example as a string returned from "
14704 "C<guestfs_list_partitions>."
14708 #: ../src/guestfs-actions.pod:5213
14709 msgid "guestfs_ping_daemon"
14713 #: ../src/guestfs-actions.pod:5215
14717 " guestfs_ping_daemon (guestfs_h *g);\n"
14722 #: ../src/guestfs-actions.pod:5218 ../fish/guestfish-actions.pod:3520
14724 "This is a test probe into the guestfs daemon running inside the qemu "
14725 "subprocess. Calling this function checks that the daemon responds to the "
14726 "ping message, without affecting the daemon or attached block device(s) in "
14731 #: ../src/guestfs-actions.pod:5227
14732 msgid "guestfs_pread"
14736 #: ../src/guestfs-actions.pod:5229
14740 " guestfs_pread (guestfs_h *g,\n"
14741 " const char *path,\n"
14743 " int64_t offset,\n"
14744 " size_t *size_r);\n"
14749 #: ../src/guestfs-actions.pod:5236 ../fish/guestfish-actions.pod:3529
14751 "This command lets you read part of a file. It reads C<count> bytes of the "
14752 "file, starting at C<offset>, from file C<path>."
14756 #: ../src/guestfs-actions.pod:5239 ../src/guestfs-actions.pod:5265
14757 #: ../fish/guestfish-actions.pod:3532 ../fish/guestfish-actions.pod:3547
14759 "This may read fewer bytes than requested. For further details see the "
14760 "L<pread(2)> system call."
14764 #: ../src/guestfs-actions.pod:5242
14765 msgid "See also C<guestfs_pwrite>, C<guestfs_pread_device>."
14769 #: ../src/guestfs-actions.pod:5253
14770 msgid "guestfs_pread_device"
14774 #: ../src/guestfs-actions.pod:5255
14778 " guestfs_pread_device (guestfs_h *g,\n"
14779 " const char *device,\n"
14781 " int64_t offset,\n"
14782 " size_t *size_r);\n"
14787 #: ../src/guestfs-actions.pod:5262 ../fish/guestfish-actions.pod:3544
14789 "This command lets you read part of a file. It reads C<count> bytes of "
14790 "C<device>, starting at C<offset>."
14794 #: ../src/guestfs-actions.pod:5268
14795 msgid "See also C<guestfs_pread>."
14799 #: ../src/guestfs-actions.pod:5277
14800 msgid "(Added in 1.5.21)"
14804 #: ../src/guestfs-actions.pod:5279
14805 msgid "guestfs_pvcreate"
14809 #: ../src/guestfs-actions.pod:5281
14813 " guestfs_pvcreate (guestfs_h *g,\n"
14814 " const char *device);\n"
14819 #: ../src/guestfs-actions.pod:5285 ../fish/guestfish-actions.pod:3559
14821 "This creates an LVM physical volume on the named C<device>, where C<device> "
14822 "should usually be a partition name such as C</dev/sda1>."
14826 #: ../src/guestfs-actions.pod:5293
14827 msgid "guestfs_pvremove"
14831 #: ../src/guestfs-actions.pod:5295
14835 " guestfs_pvremove (guestfs_h *g,\n"
14836 " const char *device);\n"
14841 #: ../src/guestfs-actions.pod:5299 ../fish/guestfish-actions.pod:3567
14843 "This wipes a physical volume C<device> so that LVM will no longer recognise "
14848 #: ../src/guestfs-actions.pod:5302 ../fish/guestfish-actions.pod:3570
14850 "The implementation uses the C<pvremove> command which refuses to wipe "
14851 "physical volumes that contain any volume groups, so you have to remove those "
14856 #: ../src/guestfs-actions.pod:5310
14857 msgid "guestfs_pvresize"
14861 #: ../src/guestfs-actions.pod:5312
14865 " guestfs_pvresize (guestfs_h *g,\n"
14866 " const char *device);\n"
14871 #: ../src/guestfs-actions.pod:5316 ../fish/guestfish-actions.pod:3578
14873 "This resizes (expands or shrinks) an existing LVM physical volume to match "
14874 "the new size of the underlying device."
14878 #: ../src/guestfs-actions.pod:5323
14879 msgid "guestfs_pvresize_size"
14883 #: ../src/guestfs-actions.pod:5325
14887 " guestfs_pvresize_size (guestfs_h *g,\n"
14888 " const char *device,\n"
14889 " int64_t size);\n"
14894 #: ../src/guestfs-actions.pod:5330
14896 "This command is the same as C<guestfs_pvresize> except that it allows you to "
14897 "specify the new size (in bytes) explicitly."
14901 #: ../src/guestfs-actions.pod:5337
14902 msgid "guestfs_pvs"
14906 #: ../src/guestfs-actions.pod:5339
14910 " guestfs_pvs (guestfs_h *g);\n"
14915 #: ../src/guestfs-actions.pod:5342 ../fish/guestfish-actions.pod:3592
14917 "List all the physical volumes detected. This is the equivalent of the L<pvs"
14922 #: ../src/guestfs-actions.pod:5345 ../fish/guestfish-actions.pod:3595
14924 "This returns a list of just the device names that contain PVs (eg. C</dev/"
14929 #: ../src/guestfs-actions.pod:5348
14930 msgid "See also C<guestfs_pvs_full>."
14934 #: ../src/guestfs-actions.pod:5356
14935 msgid "guestfs_pvs_full"
14939 #: ../src/guestfs-actions.pod:5358
14942 " struct guestfs_lvm_pv_list *\n"
14943 " guestfs_pvs_full (guestfs_h *g);\n"
14948 #: ../src/guestfs-actions.pod:5361 ../fish/guestfish-actions.pod:3604
14950 "List all the physical volumes detected. This is the equivalent of the L<pvs"
14951 "(8)> command. The \"full\" version includes all fields."
14955 #: ../src/guestfs-actions.pod:5364
14957 "This function returns a C<struct guestfs_lvm_pv_list *>, or NULL if there "
14958 "was an error. I<The caller must call C<guestfs_free_lvm_pv_list> after use>."
14962 #: ../src/guestfs-actions.pod:5370
14963 msgid "guestfs_pvuuid"
14967 #: ../src/guestfs-actions.pod:5372
14971 " guestfs_pvuuid (guestfs_h *g,\n"
14972 " const char *device);\n"
14977 #: ../src/guestfs-actions.pod:5376 ../fish/guestfish-actions.pod:3611
14978 msgid "This command returns the UUID of the LVM PV C<device>."
14982 #: ../src/guestfs-actions.pod:5383
14983 msgid "guestfs_pwrite"
14987 #: ../src/guestfs-actions.pod:5385
14991 " guestfs_pwrite (guestfs_h *g,\n"
14992 " const char *path,\n"
14993 " const char *content,\n"
14994 " size_t content_size,\n"
14995 " int64_t offset);\n"
15000 #: ../src/guestfs-actions.pod:5392 ../fish/guestfish-actions.pod:3617
15002 "This command writes to part of a file. It writes the data buffer C<content> "
15003 "to the file C<path> starting at offset C<offset>."
15007 #: ../src/guestfs-actions.pod:5395 ../fish/guestfish-actions.pod:3620
15009 "This command implements the L<pwrite(2)> system call, and like that system "
15010 "call it may not write the full data requested. The return value is the "
15011 "number of bytes that were actually written to the file. This could even be "
15012 "0, although short writes are unlikely for regular files in ordinary "
15017 #: ../src/guestfs-actions.pod:5401
15018 msgid "See also C<guestfs_pread>, C<guestfs_pwrite_device>."
15022 #: ../src/guestfs-actions.pod:5410
15023 msgid "guestfs_pwrite_device"
15027 #: ../src/guestfs-actions.pod:5412
15031 " guestfs_pwrite_device (guestfs_h *g,\n"
15032 " const char *device,\n"
15033 " const char *content,\n"
15034 " size_t content_size,\n"
15035 " int64_t offset);\n"
15040 #: ../src/guestfs-actions.pod:5419 ../fish/guestfish-actions.pod:3635
15042 "This command writes to part of a device. It writes the data buffer "
15043 "C<content> to C<device> starting at offset C<offset>."
15047 #: ../src/guestfs-actions.pod:5422 ../fish/guestfish-actions.pod:3638
15049 "This command implements the L<pwrite(2)> system call, and like that system "
15050 "call it may not write the full data requested (although short writes to disk "
15051 "devices and partitions are probably impossible with standard Linux kernels)."
15055 #: ../src/guestfs-actions.pod:5427
15056 msgid "See also C<guestfs_pwrite>."
15060 #: ../src/guestfs-actions.pod:5434
15061 msgid "(Added in 1.5.20)"
15065 #: ../src/guestfs-actions.pod:5436
15066 msgid "guestfs_read_file"
15070 #: ../src/guestfs-actions.pod:5438
15074 " guestfs_read_file (guestfs_h *g,\n"
15075 " const char *path,\n"
15076 " size_t *size_r);\n"
15081 #: ../src/guestfs-actions.pod:5443 ../fish/guestfish-actions.pod:3652
15082 msgid "This calls returns the contents of the file C<path> as a buffer."
15086 #: ../src/guestfs-actions.pod:5446
15088 "Unlike C<guestfs_cat>, this function can correctly handle files that contain "
15089 "embedded ASCII NUL characters. However unlike C<guestfs_download>, this "
15090 "function is limited in the total size of file that can be handled."
15094 #: ../src/guestfs-actions.pod:5458
15095 msgid "(Added in 1.0.63)"
15099 #: ../src/guestfs-actions.pod:5460
15100 msgid "guestfs_read_lines"
15104 #: ../src/guestfs-actions.pod:5462
15108 " guestfs_read_lines (guestfs_h *g,\n"
15109 " const char *path);\n"
15114 #: ../src/guestfs-actions.pod:5468 ../fish/guestfish-actions.pod:3669
15116 "The file contents are returned as a list of lines. Trailing C<LF> and "
15117 "C<CRLF> character sequences are I<not> returned."
15121 #: ../src/guestfs-actions.pod:5471
15123 "Note that this function cannot correctly handle binary files (specifically, "
15124 "files containing C<\\0> character which is treated as end of line). For "
15125 "those you need to use the C<guestfs_read_file> function which has a more "
15126 "complex interface."
15130 #: ../src/guestfs-actions.pod:5482
15131 msgid "guestfs_readdir"
15135 #: ../src/guestfs-actions.pod:5484
15138 " struct guestfs_dirent_list *\n"
15139 " guestfs_readdir (guestfs_h *g,\n"
15140 " const char *dir);\n"
15145 #: ../src/guestfs-actions.pod:5488 ../fish/guestfish-actions.pod:3681
15146 msgid "This returns the list of directory entries in directory C<dir>."
15150 #: ../src/guestfs-actions.pod:5490 ../fish/guestfish-actions.pod:3683
15152 "All entries in the directory are returned, including C<.> and C<..>. The "
15153 "entries are I<not> sorted, but returned in the same order as the underlying "
15158 #: ../src/guestfs-actions.pod:5494 ../fish/guestfish-actions.pod:3687
15160 "Also this call returns basic file type information about each file. The "
15161 "C<ftyp> field will contain one of the following characters:"
15165 #: ../src/guestfs-actions.pod:5499 ../fish/guestfish-actions.pod:3692
15170 #: ../src/guestfs-actions.pod:5501 ../fish/guestfish-actions.pod:3694
15171 msgid "Block special"
15175 #: ../src/guestfs-actions.pod:5503 ../fish/guestfish-actions.pod:3696
15180 #: ../src/guestfs-actions.pod:5505 ../fish/guestfish-actions.pod:3698
15181 msgid "Char special"
15185 #: ../src/guestfs-actions.pod:5507 ../fish/guestfish-actions.pod:3700
15190 #: ../src/guestfs-actions.pod:5509 ../fish/guestfish-actions.pod:3702
15195 #: ../src/guestfs-actions.pod:5511 ../fish/guestfish-actions.pod:3704
15200 #: ../src/guestfs-actions.pod:5513 ../fish/guestfish-actions.pod:3706
15201 msgid "FIFO (named pipe)"
15205 #: ../src/guestfs-actions.pod:5515 ../fish/guestfish-actions.pod:3708
15210 #: ../src/guestfs-actions.pod:5517 ../fish/guestfish-actions.pod:3710
15211 msgid "Symbolic link"
15215 #: ../src/guestfs-actions.pod:5519 ../fish/guestfish-actions.pod:3712
15220 #: ../src/guestfs-actions.pod:5521 ../fish/guestfish-actions.pod:3714
15221 msgid "Regular file"
15225 #: ../src/guestfs-actions.pod:5523 ../fish/guestfish-actions.pod:3716
15230 #: ../src/guestfs-actions.pod:5525 ../fish/guestfish-actions.pod:3718
15235 #: ../src/guestfs-actions.pod:5527 ../fish/guestfish-actions.pod:3720
15240 #: ../src/guestfs-actions.pod:5529 ../fish/guestfish-actions.pod:3722
15241 msgid "Unknown file type"
15245 #: ../src/guestfs-actions.pod:5531 ../fish/guestfish-actions.pod:3724
15250 #: ../src/guestfs-actions.pod:5533 ../fish/guestfish-actions.pod:3726
15252 "The L<readdir(3)> call returned a C<d_type> field with an unexpected value"
15256 #: ../src/guestfs-actions.pod:5538
15258 "This function is primarily intended for use by programs. To get a simple "
15259 "list of names, use C<guestfs_ls>. To get a printable directory for human "
15260 "consumption, use C<guestfs_ll>."
15264 #: ../src/guestfs-actions.pod:5542
15266 "This function returns a C<struct guestfs_dirent_list *>, or NULL if there "
15267 "was an error. I<The caller must call C<guestfs_free_dirent_list> after use>."
15271 #: ../src/guestfs-actions.pod:5548
15272 msgid "guestfs_readlink"
15276 #: ../src/guestfs-actions.pod:5550
15280 " guestfs_readlink (guestfs_h *g,\n"
15281 " const char *path);\n"
15286 #: ../src/guestfs-actions.pod:5554 ../fish/guestfish-actions.pod:3739
15287 msgid "This command reads the target of a symbolic link."
15291 #: ../src/guestfs-actions.pod:5561
15292 msgid "guestfs_readlinklist"
15296 #: ../src/guestfs-actions.pod:5563
15300 " guestfs_readlinklist (guestfs_h *g,\n"
15301 " const char *path,\n"
15302 " char *const *names);\n"
15307 #: ../src/guestfs-actions.pod:5568 ../fish/guestfish-actions.pod:3745
15309 "This call allows you to do a C<readlink> operation on multiple files, where "
15310 "all files are in the directory C<path>. C<names> is the list of files from "
15315 #: ../src/guestfs-actions.pod:5572 ../fish/guestfish-actions.pod:3749
15317 "On return you get a list of strings, with a one-to-one correspondence to the "
15318 "C<names> list. Each string is the value of the symbolic link."
15322 #: ../src/guestfs-actions.pod:5576 ../fish/guestfish-actions.pod:3753
15324 "If the C<readlink(2)> operation fails on any name, then the corresponding "
15325 "result string is the empty string C<\"\">. However the whole operation is "
15326 "completed even if there were C<readlink(2)> errors, and so you can call this "
15327 "function with names where you don't know if they are symbolic links already "
15328 "(albeit slightly less efficient)."
15332 #: ../src/guestfs-actions.pod:5583 ../fish/guestfish-actions.pod:3760
15334 "This call is intended for programs that want to efficiently list a directory "
15335 "contents without making many round-trips. Very long directory listings "
15336 "might cause the protocol message size to be exceeded, causing this call to "
15337 "fail. The caller must split up such requests into smaller groups of names."
15341 #: ../src/guestfs-actions.pod:5596
15342 msgid "guestfs_realpath"
15346 #: ../src/guestfs-actions.pod:5598
15350 " guestfs_realpath (guestfs_h *g,\n"
15351 " const char *path);\n"
15356 #: ../src/guestfs-actions.pod:5602 ../fish/guestfish-actions.pod:3771
15358 "Return the canonicalized absolute pathname of C<path>. The returned path "
15359 "has no C<.>, C<..> or symbolic link path elements."
15363 #: ../src/guestfs-actions.pod:5610
15364 msgid "guestfs_removexattr"
15368 #: ../src/guestfs-actions.pod:5612
15372 " guestfs_removexattr (guestfs_h *g,\n"
15373 " const char *xattr,\n"
15374 " const char *path);\n"
15379 #: ../src/guestfs-actions.pod:5617 ../fish/guestfish-actions.pod:3778
15381 "This call removes the extended attribute named C<xattr> of the file C<path>."
15385 #: ../src/guestfs-actions.pod:5620
15386 msgid "See also: C<guestfs_lremovexattr>, L<attr(5)>."
15390 #: ../src/guestfs-actions.pod:5626
15391 msgid "guestfs_resize2fs"
15395 #: ../src/guestfs-actions.pod:5628
15399 " guestfs_resize2fs (guestfs_h *g,\n"
15400 " const char *device);\n"
15405 #: ../src/guestfs-actions.pod:5632 ../fish/guestfish-actions.pod:3787
15407 "This resizes an ext2, ext3 or ext4 filesystem to match the size of the "
15408 "underlying device."
15412 #: ../src/guestfs-actions.pod:5635
15414 "I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f> on the "
15415 "C<device> before calling this command. For unknown reasons C<resize2fs> "
15416 "sometimes gives an error about this and sometimes not. In any case, it is "
15417 "always safe to call C<guestfs_e2fsck_f> before calling this function."
15421 #: ../src/guestfs-actions.pod:5645
15422 msgid "guestfs_resize2fs_M"
15426 #: ../src/guestfs-actions.pod:5647
15430 " guestfs_resize2fs_M (guestfs_h *g,\n"
15431 " const char *device);\n"
15436 #: ../src/guestfs-actions.pod:5651
15438 "This command is the same as C<guestfs_resize2fs>, but the filesystem is "
15439 "resized to its minimum size. This works like the C<-M> option to the "
15440 "C<resize2fs> command."
15444 #: ../src/guestfs-actions.pod:5655
15446 "To get the resulting size of the filesystem you should call "
15447 "C<guestfs_tune2fs_l> and read the C<Block size> and C<Block count> values. "
15448 "These two numbers, multiplied together, give the resulting size of the "
15449 "minimal filesystem in bytes."
15453 #: ../src/guestfs-actions.pod:5662
15454 msgid "guestfs_resize2fs_size"
15458 #: ../src/guestfs-actions.pod:5664
15462 " guestfs_resize2fs_size (guestfs_h *g,\n"
15463 " const char *device,\n"
15464 " int64_t size);\n"
15469 #: ../src/guestfs-actions.pod:5669
15471 "This command is the same as C<guestfs_resize2fs> except that it allows you "
15472 "to specify the new size (in bytes) explicitly."
15476 #: ../src/guestfs-actions.pod:5676
15481 #: ../src/guestfs-actions.pod:5678
15485 " guestfs_rm (guestfs_h *g,\n"
15486 " const char *path);\n"
15491 #: ../src/guestfs-actions.pod:5682 ../fish/guestfish-actions.pod:3820
15492 msgid "Remove the single file C<path>."
15496 #: ../src/guestfs-actions.pod:5688
15497 msgid "guestfs_rm_rf"
15501 #: ../src/guestfs-actions.pod:5690
15505 " guestfs_rm_rf (guestfs_h *g,\n"
15506 " const char *path);\n"
15511 #: ../src/guestfs-actions.pod:5694 ../fish/guestfish-actions.pod:3826
15513 "Remove the file or directory C<path>, recursively removing the contents if "
15514 "its a directory. This is like the C<rm -rf> shell command."
15518 #: ../src/guestfs-actions.pod:5702
15519 msgid "guestfs_rmdir"
15523 #: ../src/guestfs-actions.pod:5704
15527 " guestfs_rmdir (guestfs_h *g,\n"
15528 " const char *path);\n"
15533 #: ../src/guestfs-actions.pod:5708 ../fish/guestfish-actions.pod:3834
15534 msgid "Remove the single directory C<path>."
15538 #: ../src/guestfs-actions.pod:5714
15539 msgid "guestfs_rmmountpoint"
15543 #: ../src/guestfs-actions.pod:5716
15547 " guestfs_rmmountpoint (guestfs_h *g,\n"
15548 " const char *exemptpath);\n"
15553 #: ../src/guestfs-actions.pod:5720
15555 "This calls removes a mountpoint that was previously created with "
15556 "C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint> for full details."
15560 #: ../src/guestfs-actions.pod:5728
15561 msgid "guestfs_scrub_device"
15565 #: ../src/guestfs-actions.pod:5730
15569 " guestfs_scrub_device (guestfs_h *g,\n"
15570 " const char *device);\n"
15575 #: ../src/guestfs-actions.pod:5734 ../fish/guestfish-actions.pod:3848
15577 "This command writes patterns over C<device> to make data retrieval more "
15582 #: ../src/guestfs-actions.pod:5737 ../src/guestfs-actions.pod:5758
15583 #: ../src/guestfs-actions.pod:5777 ../fish/guestfish-actions.pod:3851
15584 #: ../fish/guestfish-actions.pod:3866 ../fish/guestfish-actions.pod:3879
15586 "It is an interface to the L<scrub(1)> program. See that manual page for "
15591 #: ../src/guestfs-actions.pod:5745 ../src/guestfs-actions.pod:5763
15592 #: ../src/guestfs-actions.pod:5782
15593 msgid "(Added in 1.0.52)"
15597 #: ../src/guestfs-actions.pod:5747
15598 msgid "guestfs_scrub_file"
15602 #: ../src/guestfs-actions.pod:5749
15606 " guestfs_scrub_file (guestfs_h *g,\n"
15607 " const char *file);\n"
15612 #: ../src/guestfs-actions.pod:5753 ../fish/guestfish-actions.pod:3861
15614 "This command writes patterns over a file to make data retrieval more "
15619 #: ../src/guestfs-actions.pod:5756 ../fish/guestfish-actions.pod:3864
15620 msgid "The file is I<removed> after scrubbing."
15624 #: ../src/guestfs-actions.pod:5765
15625 msgid "guestfs_scrub_freespace"
15629 #: ../src/guestfs-actions.pod:5767
15633 " guestfs_scrub_freespace (guestfs_h *g,\n"
15634 " const char *dir);\n"
15639 #: ../src/guestfs-actions.pod:5771
15641 "This command creates the directory C<dir> and then fills it with files until "
15642 "the filesystem is full, and scrubs the files as for C<guestfs_scrub_file>, "
15643 "and deletes them. The intention is to scrub any free space on the partition "
15644 "containing C<dir>."
15648 #: ../src/guestfs-actions.pod:5784
15649 msgid "guestfs_set_append"
15653 #: ../src/guestfs-actions.pod:5786
15657 " guestfs_set_append (guestfs_h *g,\n"
15658 " const char *append);\n"
15663 #: ../src/guestfs-actions.pod:5790 ../fish/guestfish-actions.pod:3888
15665 "This function is used to add additional options to the guest kernel command "
15670 #: ../src/guestfs-actions.pod:5793 ../fish/guestfish-actions.pod:3891
15672 "The default is C<NULL> unless overridden by setting C<LIBGUESTFS_APPEND> "
15673 "environment variable."
15677 #: ../src/guestfs-actions.pod:5796 ../fish/guestfish-actions.pod:3894
15679 "Setting C<append> to C<NULL> means I<no> additional options are passed "
15680 "(libguestfs always adds a few of its own)."
15684 #: ../src/guestfs-actions.pod:5803
15685 msgid "guestfs_set_attach_method"
15689 #: ../src/guestfs-actions.pod:5805
15693 " guestfs_set_attach_method (guestfs_h *g,\n"
15694 " const char *attachmethod);\n"
15699 #: ../src/guestfs-actions.pod:5809 ../fish/guestfish-actions.pod:3903
15701 "Set the method that libguestfs uses to connect to the back end guestfsd "
15702 "daemon. Possible methods are:"
15706 #: ../src/guestfs-actions.pod:5816 ../fish/guestfish-actions.pod:3910
15708 "Launch an appliance and connect to it. This is the ordinary method and the "
15713 #: ../src/guestfs-actions.pod:5819 ../fish/guestfish-actions.pod:3913
15714 msgid "C<unix:I<path>>"
15718 #: ../src/guestfs-actions.pod:5821 ../fish/guestfish-actions.pod:3915
15719 msgid "Connect to the Unix domain socket I<path>."
15723 #: ../src/guestfs-actions.pod:5823 ../fish/guestfish-actions.pod:3917
15725 "This method lets you connect to an existing daemon or (using virtio-serial) "
15726 "to a live guest. For more information, see L<guestfs(3)/ATTACHING TO "
15727 "RUNNING DAEMONS>."
15731 #: ../src/guestfs-actions.pod:5831
15732 msgid "guestfs_set_autosync"
15736 #: ../src/guestfs-actions.pod:5833
15740 " guestfs_set_autosync (guestfs_h *g,\n"
15741 " int autosync);\n"
15746 #: ../src/guestfs-actions.pod:5837 ../fish/guestfish-actions.pod:3929
15748 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
15749 "effort attempt to make filesystems consistent and synchronized when the "
15750 "handle is closed (also if the program exits without closing handles)."
15754 #: ../src/guestfs-actions.pod:5842 ../fish/guestfish-actions.pod:3934
15756 "This is enabled by default (since libguestfs 1.5.24, previously it was "
15757 "disabled by default)."
15761 #: ../src/guestfs-actions.pod:5849
15762 msgid "guestfs_set_direct"
15766 #: ../src/guestfs-actions.pod:5851
15770 " guestfs_set_direct (guestfs_h *g,\n"
15776 #: ../src/guestfs-actions.pod:5855 ../fish/guestfish-actions.pod:3943
15778 "If the direct appliance mode flag is enabled, then stdin and stdout are "
15779 "passed directly through to the appliance once it is launched."
15783 #: ../src/guestfs-actions.pod:5859
15785 "One consequence of this is that log messages aren't caught by the library "
15786 "and handled by C<guestfs_set_log_message_callback>, but go straight to "
15791 #: ../src/guestfs-actions.pod:5863 ../fish/guestfish-actions.pod:3951
15792 msgid "You probably don't want to use this unless you know what you are doing."
15796 #: ../src/guestfs-actions.pod:5866 ../fish/guestfish-actions.pod:3954
15797 msgid "The default is disabled."
15801 #: ../src/guestfs-actions.pod:5872
15802 msgid "guestfs_set_e2label"
15806 #: ../src/guestfs-actions.pod:5874
15810 " guestfs_set_e2label (guestfs_h *g,\n"
15811 " const char *device,\n"
15812 " const char *label);\n"
15817 #: ../src/guestfs-actions.pod:5879 ../fish/guestfish-actions.pod:3960
15819 "This sets the ext2/3/4 filesystem label of the filesystem on C<device> to "
15820 "C<label>. Filesystem labels are limited to 16 characters."
15824 #: ../src/guestfs-actions.pod:5883
15826 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label> to return "
15827 "the existing label on a filesystem."
15831 #: ../src/guestfs-actions.pod:5890
15832 msgid "guestfs_set_e2uuid"
15836 #: ../src/guestfs-actions.pod:5892
15840 " guestfs_set_e2uuid (guestfs_h *g,\n"
15841 " const char *device,\n"
15842 " const char *uuid);\n"
15847 #: ../src/guestfs-actions.pod:5897 ../fish/guestfish-actions.pod:3971
15849 "This sets the ext2/3/4 filesystem UUID of the filesystem on C<device> to "
15850 "C<uuid>. The format of the UUID and alternatives such as C<clear>, "
15851 "C<random> and C<time> are described in the L<tune2fs(8)> manpage."
15855 #: ../src/guestfs-actions.pod:5902
15857 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid> to return "
15858 "the existing UUID of a filesystem."
15862 #: ../src/guestfs-actions.pod:5909
15863 msgid "guestfs_set_memsize"
15867 #: ../src/guestfs-actions.pod:5911
15871 " guestfs_set_memsize (guestfs_h *g,\n"
15877 #: ../src/guestfs-actions.pod:5915
15879 "This sets the memory size in megabytes allocated to the qemu subprocess. "
15880 "This only has any effect if called before C<guestfs_launch>."
15884 #: ../src/guestfs-actions.pod:5919 ../fish/guestfish-actions.pod:3989
15886 "You can also change this by setting the environment variable "
15887 "C<LIBGUESTFS_MEMSIZE> before the handle is created."
15891 #: ../src/guestfs-actions.pod:5930
15892 msgid "guestfs_set_network"
15896 #: ../src/guestfs-actions.pod:5932
15900 " guestfs_set_network (guestfs_h *g,\n"
15906 #: ../src/guestfs-actions.pod:5936 ../fish/guestfish-actions.pod:4002
15908 "If C<network> is true, then the network is enabled in the libguestfs "
15909 "appliance. The default is false."
15913 #: ../src/guestfs-actions.pod:5939 ../fish/guestfish-actions.pod:4005
15915 "This affects whether commands are able to access the network (see L<guestfs"
15916 "(3)/RUNNING COMMANDS>)."
15920 #: ../src/guestfs-actions.pod:5942
15922 "You must call this before calling C<guestfs_launch>, otherwise it has no "
15927 #: ../src/guestfs-actions.pod:5949
15928 msgid "guestfs_set_path"
15932 #: ../src/guestfs-actions.pod:5951
15936 " guestfs_set_path (guestfs_h *g,\n"
15937 " const char *searchpath);\n"
15942 #: ../src/guestfs-actions.pod:5955 ../fish/guestfish-actions.pod:4017
15943 msgid "Set the path that libguestfs searches for kernel and initrd.img."
15947 #: ../src/guestfs-actions.pod:5957 ../fish/guestfish-actions.pod:4019
15949 "The default is C<$libdir/guestfs> unless overridden by setting "
15950 "C<LIBGUESTFS_PATH> environment variable."
15954 #: ../src/guestfs-actions.pod:5960 ../fish/guestfish-actions.pod:4022
15955 msgid "Setting C<path> to C<NULL> restores the default path."
15959 #: ../src/guestfs-actions.pod:5966
15960 msgid "guestfs_set_qemu"
15964 #: ../src/guestfs-actions.pod:5968
15968 " guestfs_set_qemu (guestfs_h *g,\n"
15969 " const char *qemu);\n"
15974 #: ../src/guestfs-actions.pod:5972 ../fish/guestfish-actions.pod:4030
15975 msgid "Set the qemu binary that we will use."
15979 #: ../src/guestfs-actions.pod:5974 ../fish/guestfish-actions.pod:4032
15981 "The default is chosen when the library was compiled by the configure script."
15985 #: ../src/guestfs-actions.pod:5977 ../fish/guestfish-actions.pod:4035
15987 "You can also override this by setting the C<LIBGUESTFS_QEMU> environment "
15992 #: ../src/guestfs-actions.pod:5980 ../fish/guestfish-actions.pod:4038
15993 msgid "Setting C<qemu> to C<NULL> restores the default qemu binary."
15997 #: ../src/guestfs-actions.pod:5982 ../fish/guestfish-actions.pod:4040
15999 "Note that you should call this function as early as possible after creating "
16000 "the handle. This is because some pre-launch operations depend on testing "
16001 "qemu features (by running C<qemu -help>). If the qemu binary changes, we "
16002 "don't retest features, and so you might see inconsistent results. Using the "
16003 "environment variable C<LIBGUESTFS_QEMU> is safest of all since that picks "
16004 "the qemu binary at the same time as the handle is created."
16008 #: ../src/guestfs-actions.pod:5994
16009 msgid "guestfs_set_recovery_proc"
16013 #: ../src/guestfs-actions.pod:5996
16017 " guestfs_set_recovery_proc (guestfs_h *g,\n"
16018 " int recoveryproc);\n"
16023 #: ../src/guestfs-actions.pod:6000
16025 "If this is called with the parameter C<false> then C<guestfs_launch> does "
16026 "not create a recovery process. The purpose of the recovery process is to "
16027 "stop runaway qemu processes in the case where the main program aborts "
16032 #: ../src/guestfs-actions.pod:6005
16034 "This only has any effect if called before C<guestfs_launch>, and the default "
16039 #: ../src/guestfs-actions.pod:6008 ../fish/guestfish-actions.pod:4062
16041 "About the only time when you would want to disable this is if the main "
16042 "process will fork itself into the background (\"daemonize\" itself). In "
16043 "this case the recovery process thinks that the main program has disappeared "
16044 "and so kills qemu, which is not very helpful."
16048 #: ../src/guestfs-actions.pod:6018
16049 msgid "guestfs_set_selinux"
16053 #: ../src/guestfs-actions.pod:6020
16057 " guestfs_set_selinux (guestfs_h *g,\n"
16063 #: ../src/guestfs-actions.pod:6024 ../fish/guestfish-actions.pod:4074
16065 "This sets the selinux flag that is passed to the appliance at boot time. "
16066 "The default is C<selinux=0> (disabled)."
16070 #: ../src/guestfs-actions.pod:6027 ../fish/guestfish-actions.pod:4077
16072 "Note that if SELinux is enabled, it is always in Permissive mode "
16073 "(C<enforcing=0>)."
16077 #: ../src/guestfs-actions.pod:6037
16078 msgid "guestfs_set_trace"
16082 #: ../src/guestfs-actions.pod:6039
16086 " guestfs_set_trace (guestfs_h *g,\n"
16092 #: ../src/guestfs-actions.pod:6043 ../fish/guestfish-actions.pod:4089
16094 "If the command trace flag is set to 1, then libguestfs calls, parameters and "
16095 "return values are traced."
16099 #: ../src/guestfs-actions.pod:6046 ../fish/guestfish-actions.pod:4092
16101 "If you want to trace C API calls into libguestfs (and other libraries) then "
16102 "possibly a better way is to use the external ltrace(1) command."
16106 #: ../src/guestfs-actions.pod:6050 ../fish/guestfish-actions.pod:4096
16108 "Command traces are disabled unless the environment variable "
16109 "C<LIBGUESTFS_TRACE> is defined and set to C<1>."
16113 #: ../src/guestfs-actions.pod:6053
16115 "Trace messages are normally sent to C<stderr>, unless you register a "
16116 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
16120 #: ../src/guestfs-actions.pod:6061
16121 msgid "guestfs_set_verbose"
16125 #: ../src/guestfs-actions.pod:6063
16129 " guestfs_set_verbose (guestfs_h *g,\n"
16135 #: ../src/guestfs-actions.pod:6067 ../fish/guestfish-actions.pod:4109
16136 msgid "If C<verbose> is true, this turns on verbose messages."
16140 #: ../src/guestfs-actions.pod:6069 ../fish/guestfish-actions.pod:4111
16142 "Verbose messages are disabled unless the environment variable "
16143 "C<LIBGUESTFS_DEBUG> is defined and set to C<1>."
16147 #: ../src/guestfs-actions.pod:6072
16149 "Verbose messages are normally sent to C<stderr>, unless you register a "
16150 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
16154 #: ../src/guestfs-actions.pod:6080
16155 msgid "guestfs_setcon"
16159 #: ../src/guestfs-actions.pod:6082
16163 " guestfs_setcon (guestfs_h *g,\n"
16164 " const char *context);\n"
16169 #: ../src/guestfs-actions.pod:6086 ../fish/guestfish-actions.pod:4122
16171 "This sets the SELinux security context of the daemon to the string "
16176 #: ../src/guestfs-actions.pod:6089 ../fish/guestfish-actions.pod:4125
16177 msgid "See the documentation about SELINUX in L<guestfs(3)>."
16181 #: ../src/guestfs-actions.pod:6095
16182 msgid "guestfs_setxattr"
16186 #: ../src/guestfs-actions.pod:6097
16190 " guestfs_setxattr (guestfs_h *g,\n"
16191 " const char *xattr,\n"
16192 " const char *val,\n"
16194 " const char *path);\n"
16199 #: ../src/guestfs-actions.pod:6104 ../fish/guestfish-actions.pod:4131
16201 "This call sets the extended attribute named C<xattr> of the file C<path> to "
16202 "the value C<val> (of length C<vallen>). The value is arbitrary 8 bit data."
16206 #: ../src/guestfs-actions.pod:6108
16207 msgid "See also: C<guestfs_lsetxattr>, L<attr(5)>."
16211 #: ../src/guestfs-actions.pod:6114
16212 msgid "guestfs_sfdisk"
16216 #: ../src/guestfs-actions.pod:6116
16220 " guestfs_sfdisk (guestfs_h *g,\n"
16221 " const char *device,\n"
16225 " char *const *lines);\n"
16230 #: ../src/guestfs-actions.pod:6124 ../fish/guestfish-actions.pod:4141
16232 "This is a direct interface to the L<sfdisk(8)> program for creating "
16233 "partitions on block devices."
16237 #: ../src/guestfs-actions.pod:6127 ../fish/guestfish-actions.pod:4144
16238 msgid "C<device> should be a block device, for example C</dev/sda>."
16242 #: ../src/guestfs-actions.pod:6129 ../fish/guestfish-actions.pod:4146
16244 "C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads and "
16245 "sectors on the device, which are passed directly to sfdisk as the I<-C>, I<-"
16246 "H> and I<-S> parameters. If you pass C<0> for any of these, then the "
16247 "corresponding parameter is omitted. Usually for 'large' disks, you can just "
16248 "pass C<0> for these, but for small (floppy-sized) disks, sfdisk (or rather, "
16249 "the kernel) cannot work out the right geometry and you will need to tell it."
16253 #: ../src/guestfs-actions.pod:6137 ../fish/guestfish-actions.pod:4154
16255 "C<lines> is a list of lines that we feed to C<sfdisk>. For more information "
16256 "refer to the L<sfdisk(8)> manpage."
16260 #: ../src/guestfs-actions.pod:6140 ../fish/guestfish-actions.pod:4157
16262 "To create a single partition occupying the whole disk, you would pass "
16263 "C<lines> as a single element list, when the single element being the string "
16268 #: ../src/guestfs-actions.pod:6144
16270 "See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>, C<guestfs_part_init>"
16274 #: ../src/guestfs-actions.pod:6154
16275 msgid "guestfs_sfdiskM"
16279 #: ../src/guestfs-actions.pod:6156
16283 " guestfs_sfdiskM (guestfs_h *g,\n"
16284 " const char *device,\n"
16285 " char *const *lines);\n"
16290 #: ../src/guestfs-actions.pod:6161
16292 "This is a simplified interface to the C<guestfs_sfdisk> command, where "
16293 "partition sizes are specified in megabytes only (rounded to the nearest "
16294 "cylinder) and you don't need to specify the cyls, heads and sectors "
16295 "parameters which were rarely if ever used anyway."
16299 #: ../src/guestfs-actions.pod:6167
16301 "See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage and "
16302 "C<guestfs_part_disk>"
16306 #: ../src/guestfs-actions.pod:6177
16307 msgid "guestfs_sfdisk_N"
16311 #: ../src/guestfs-actions.pod:6179
16315 " guestfs_sfdisk_N (guestfs_h *g,\n"
16316 " const char *device,\n"
16321 " const char *line);\n"
16326 #: ../src/guestfs-actions.pod:6188 ../fish/guestfish-actions.pod:4187
16328 "This runs L<sfdisk(8)> option to modify just the single partition C<n> "
16329 "(note: C<n> counts from 1)."
16333 #: ../src/guestfs-actions.pod:6191
16335 "For other parameters, see C<guestfs_sfdisk>. You should usually pass C<0> "
16336 "for the cyls/heads/sectors parameters."
16340 #: ../src/guestfs-actions.pod:6194
16341 msgid "See also: C<guestfs_part_add>"
16345 #: ../src/guestfs-actions.pod:6203
16346 msgid "guestfs_sfdisk_disk_geometry"
16350 #: ../src/guestfs-actions.pod:6205
16354 " guestfs_sfdisk_disk_geometry (guestfs_h *g,\n"
16355 " const char *device);\n"
16360 #: ../src/guestfs-actions.pod:6209
16362 "This displays the disk geometry of C<device> read from the partition table. "
16363 "Especially in the case where the underlying block device has been resized, "
16364 "this can be different from the kernel's idea of the geometry (see "
16365 "C<guestfs_sfdisk_kernel_geometry>)."
16369 #: ../src/guestfs-actions.pod:6214 ../src/guestfs-actions.pod:6230
16370 #: ../fish/guestfish-actions.pod:4207 ../fish/guestfish-actions.pod:4216
16371 msgid "The result is in human-readable format, and not designed to be parsed."
16375 #: ../src/guestfs-actions.pod:6222
16376 msgid "guestfs_sfdisk_kernel_geometry"
16380 #: ../src/guestfs-actions.pod:6224
16384 " guestfs_sfdisk_kernel_geometry (guestfs_h *g,\n"
16385 " const char *device);\n"
16390 #: ../src/guestfs-actions.pod:6228 ../fish/guestfish-actions.pod:4214
16391 msgid "This displays the kernel's idea of the geometry of C<device>."
16395 #: ../src/guestfs-actions.pod:6238
16396 msgid "guestfs_sfdisk_l"
16400 #: ../src/guestfs-actions.pod:6240
16404 " guestfs_sfdisk_l (guestfs_h *g,\n"
16405 " const char *device);\n"
16410 #: ../src/guestfs-actions.pod:6244 ../fish/guestfish-actions.pod:4223
16412 "This displays the partition table on C<device>, in the human-readable output "
16413 "of the L<sfdisk(8)> command. It is not intended to be parsed."
16417 #: ../src/guestfs-actions.pod:6248
16418 msgid "See also: C<guestfs_part_list>"
16422 #: ../src/guestfs-actions.pod:6255
16427 #: ../src/guestfs-actions.pod:6257
16431 " guestfs_sh (guestfs_h *g,\n"
16432 " const char *command);\n"
16437 #: ../src/guestfs-actions.pod:6261 ../fish/guestfish-actions.pod:4233
16439 "This call runs a command from the guest filesystem via the guest's C</bin/"
16444 #: ../src/guestfs-actions.pod:6264
16445 msgid "This is like C<guestfs_command>, but passes the command to:"
16449 #: ../src/guestfs-actions.pod:6266 ../fish/guestfish-actions.pod:4238
16452 " /bin/sh -c \"command\"\n"
16457 #: ../src/guestfs-actions.pod:6268 ../fish/guestfish-actions.pod:4240
16459 "Depending on the guest's shell, this usually results in wildcards being "
16460 "expanded, shell expressions being interpolated and so on."
16464 #: ../src/guestfs-actions.pod:6272
16465 msgid "All the provisos about C<guestfs_command> apply to this call."
16469 #: ../src/guestfs-actions.pod:6279
16470 msgid "guestfs_sh_lines"
16474 #: ../src/guestfs-actions.pod:6281
16478 " guestfs_sh_lines (guestfs_h *g,\n"
16479 " const char *command);\n"
16484 #: ../src/guestfs-actions.pod:6285
16486 "This is the same as C<guestfs_sh>, but splits the result into a list of "
16491 #: ../src/guestfs-actions.pod:6288
16492 msgid "See also: C<guestfs_command_lines>"
16496 #: ../src/guestfs-actions.pod:6296
16497 msgid "guestfs_sleep"
16501 #: ../src/guestfs-actions.pod:6298
16505 " guestfs_sleep (guestfs_h *g,\n"
16511 #: ../src/guestfs-actions.pod:6302 ../fish/guestfish-actions.pod:4259
16512 msgid "Sleep for C<secs> seconds."
16516 #: ../src/guestfs-actions.pod:6306
16517 msgid "(Added in 1.0.41)"
16521 #: ../src/guestfs-actions.pod:6308 ../src/guestfs-structs.pod:109
16522 msgid "guestfs_stat"
16526 #: ../src/guestfs-actions.pod:6310
16529 " struct guestfs_stat *\n"
16530 " guestfs_stat (guestfs_h *g,\n"
16531 " const char *path);\n"
16536 #: ../src/guestfs-actions.pod:6316 ../fish/guestfish-actions.pod:4267
16537 msgid "This is the same as the C<stat(2)> system call."
16541 #: ../src/guestfs-actions.pod:6324 ../src/guestfs-structs.pod:135
16542 msgid "guestfs_statvfs"
16546 #: ../src/guestfs-actions.pod:6326
16549 " struct guestfs_statvfs *\n"
16550 " guestfs_statvfs (guestfs_h *g,\n"
16551 " const char *path);\n"
16556 #: ../src/guestfs-actions.pod:6330 ../fish/guestfish-actions.pod:4273
16558 "Returns file system statistics for any mounted file system. C<path> should "
16559 "be a file or directory in the mounted file system (typically it is the mount "
16560 "point itself, but it doesn't need to be)."
16564 #: ../src/guestfs-actions.pod:6334 ../fish/guestfish-actions.pod:4277
16565 msgid "This is the same as the C<statvfs(2)> system call."
16569 #: ../src/guestfs-actions.pod:6336
16571 "This function returns a C<struct guestfs_statvfs *>, or NULL if there was an "
16572 "error. I<The caller must call C<guestfs_free_statvfs> after use>."
16576 #: ../src/guestfs-actions.pod:6342
16577 msgid "guestfs_strings"
16581 #: ../src/guestfs-actions.pod:6344
16585 " guestfs_strings (guestfs_h *g,\n"
16586 " const char *path);\n"
16591 #: ../src/guestfs-actions.pod:6348 ../fish/guestfish-actions.pod:4283
16593 "This runs the L<strings(1)> command on a file and returns the list of "
16594 "printable strings found."
16598 #: ../src/guestfs-actions.pod:6360
16599 msgid "guestfs_strings_e"
16603 #: ../src/guestfs-actions.pod:6362
16607 " guestfs_strings_e (guestfs_h *g,\n"
16608 " const char *encoding,\n"
16609 " const char *path);\n"
16614 #: ../src/guestfs-actions.pod:6367
16616 "This is like the C<guestfs_strings> command, but allows you to specify the "
16617 "encoding of strings that are looked for in the source file C<path>."
16621 #: ../src/guestfs-actions.pod:6371 ../fish/guestfish-actions.pod:4297
16622 msgid "Allowed encodings are:"
16626 #: ../src/guestfs-actions.pod:6375 ../fish/guestfish-actions.pod:4301
16631 #: ../src/guestfs-actions.pod:6377
16633 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
16634 "ISO-8859-X (this is what C<guestfs_strings> uses)."
16638 #: ../src/guestfs-actions.pod:6380 ../fish/guestfish-actions.pod:4306
16643 #: ../src/guestfs-actions.pod:6382 ../fish/guestfish-actions.pod:4308
16644 msgid "Single 8-bit-byte characters."
16648 #: ../src/guestfs-actions.pod:6384 ../fish/guestfish-actions.pod:4310
16653 #: ../src/guestfs-actions.pod:6386 ../fish/guestfish-actions.pod:4312
16654 msgid "16-bit big endian strings such as those encoded in UTF-16BE or UCS-2BE."
16658 #: ../src/guestfs-actions.pod:6389 ../fish/guestfish-actions.pod:4315
16659 msgid "l (lower case letter L)"
16663 #: ../src/guestfs-actions.pod:6391 ../fish/guestfish-actions.pod:4317
16665 "16-bit little endian such as UTF-16LE and UCS-2LE. This is useful for "
16666 "examining binaries in Windows guests."
16670 #: ../src/guestfs-actions.pod:6394 ../fish/guestfish-actions.pod:4320
16675 #: ../src/guestfs-actions.pod:6396 ../fish/guestfish-actions.pod:4322
16676 msgid "32-bit big endian such as UCS-4BE."
16680 #: ../src/guestfs-actions.pod:6398 ../fish/guestfish-actions.pod:4324
16685 #: ../src/guestfs-actions.pod:6400 ../fish/guestfish-actions.pod:4326
16686 msgid "32-bit little endian such as UCS-4LE."
16690 #: ../src/guestfs-actions.pod:6404 ../fish/guestfish-actions.pod:4330
16691 msgid "The returned strings are transcoded to UTF-8."
16695 #: ../src/guestfs-actions.pod:6415
16696 msgid "guestfs_swapoff_device"
16700 #: ../src/guestfs-actions.pod:6417
16704 " guestfs_swapoff_device (guestfs_h *g,\n"
16705 " const char *device);\n"
16710 #: ../src/guestfs-actions.pod:6421
16712 "This command disables the libguestfs appliance swap device or partition "
16713 "named C<device>. See C<guestfs_swapon_device>."
16717 #: ../src/guestfs-actions.pod:6429
16718 msgid "guestfs_swapoff_file"
16722 #: ../src/guestfs-actions.pod:6431
16726 " guestfs_swapoff_file (guestfs_h *g,\n"
16727 " const char *file);\n"
16732 #: ../src/guestfs-actions.pod:6435 ../fish/guestfish-actions.pod:4347
16733 msgid "This command disables the libguestfs appliance swap on file."
16737 #: ../src/guestfs-actions.pod:6441
16738 msgid "guestfs_swapoff_label"
16742 #: ../src/guestfs-actions.pod:6443
16746 " guestfs_swapoff_label (guestfs_h *g,\n"
16747 " const char *label);\n"
16752 #: ../src/guestfs-actions.pod:6447 ../fish/guestfish-actions.pod:4353
16754 "This command disables the libguestfs appliance swap on labeled swap "
16759 #: ../src/guestfs-actions.pod:6454
16760 msgid "guestfs_swapoff_uuid"
16764 #: ../src/guestfs-actions.pod:6456
16768 " guestfs_swapoff_uuid (guestfs_h *g,\n"
16769 " const char *uuid);\n"
16774 #: ../src/guestfs-actions.pod:6460 ../fish/guestfish-actions.pod:4360
16776 "This command disables the libguestfs appliance swap partition with the given "
16781 #: ../src/guestfs-actions.pod:6467
16782 msgid "guestfs_swapon_device"
16786 #: ../src/guestfs-actions.pod:6469
16790 " guestfs_swapon_device (guestfs_h *g,\n"
16791 " const char *device);\n"
16796 #: ../src/guestfs-actions.pod:6473
16798 "This command enables the libguestfs appliance to use the swap device or "
16799 "partition named C<device>. The increased memory is made available for all "
16800 "commands, for example those run using C<guestfs_command> or C<guestfs_sh>."
16804 #: ../src/guestfs-actions.pod:6478 ../fish/guestfish-actions.pod:4372
16806 "Note that you should not swap to existing guest swap partitions unless you "
16807 "know what you are doing. They may contain hibernation information, or other "
16808 "information that the guest doesn't want you to trash. You also risk leaking "
16809 "information about the host to the guest this way. Instead, attach a new "
16810 "host device to the guest and swap on that."
16814 #: ../src/guestfs-actions.pod:6489
16815 msgid "guestfs_swapon_file"
16819 #: ../src/guestfs-actions.pod:6491
16823 " guestfs_swapon_file (guestfs_h *g,\n"
16824 " const char *file);\n"
16829 #: ../src/guestfs-actions.pod:6495
16831 "This command enables swap to a file. See C<guestfs_swapon_device> for other "
16836 #: ../src/guestfs-actions.pod:6502
16837 msgid "guestfs_swapon_label"
16841 #: ../src/guestfs-actions.pod:6504
16845 " guestfs_swapon_label (guestfs_h *g,\n"
16846 " const char *label);\n"
16851 #: ../src/guestfs-actions.pod:6508
16853 "This command enables swap to a labeled swap partition. See "
16854 "C<guestfs_swapon_device> for other notes."
16858 #: ../src/guestfs-actions.pod:6515
16859 msgid "guestfs_swapon_uuid"
16863 #: ../src/guestfs-actions.pod:6517
16867 " guestfs_swapon_uuid (guestfs_h *g,\n"
16868 " const char *uuid);\n"
16873 #: ../src/guestfs-actions.pod:6521
16875 "This command enables swap to a swap partition with the given UUID. See "
16876 "C<guestfs_swapon_device> for other notes."
16880 #: ../src/guestfs-actions.pod:6528
16881 msgid "guestfs_sync"
16885 #: ../src/guestfs-actions.pod:6530
16889 " guestfs_sync (guestfs_h *g);\n"
16894 #: ../src/guestfs-actions.pod:6533 ../fish/guestfish-actions.pod:4404
16896 "This syncs the disk, so that any writes are flushed through to the "
16897 "underlying disk image."
16901 #: ../src/guestfs-actions.pod:6536 ../fish/guestfish-actions.pod:4407
16903 "You should always call this if you have modified a disk image, before "
16904 "closing the handle."
16908 #: ../src/guestfs-actions.pod:6543
16909 msgid "guestfs_tail"
16913 #: ../src/guestfs-actions.pod:6545
16917 " guestfs_tail (guestfs_h *g,\n"
16918 " const char *path);\n"
16923 #: ../src/guestfs-actions.pod:6549 ../fish/guestfish-actions.pod:4414
16925 "This command returns up to the last 10 lines of a file as a list of strings."
16929 #: ../src/guestfs-actions.pod:6561
16930 msgid "guestfs_tail_n"
16934 #: ../src/guestfs-actions.pod:6563
16938 " guestfs_tail_n (guestfs_h *g,\n"
16940 " const char *path);\n"
16945 #: ../src/guestfs-actions.pod:6568 ../fish/guestfish-actions.pod:4424
16947 "If the parameter C<nrlines> is a positive number, this returns the last "
16948 "C<nrlines> lines of the file C<path>."
16952 #: ../src/guestfs-actions.pod:6571 ../fish/guestfish-actions.pod:4427
16954 "If the parameter C<nrlines> is a negative number, this returns lines from "
16955 "the file C<path>, starting with the C<-nrlines>th line."
16959 #: ../src/guestfs-actions.pod:6585
16960 msgid "guestfs_tar_in"
16964 #: ../src/guestfs-actions.pod:6587
16968 " guestfs_tar_in (guestfs_h *g,\n"
16969 " const char *tarfile,\n"
16970 " const char *directory);\n"
16975 #: ../src/guestfs-actions.pod:6592 ../fish/guestfish-actions.pod:4439
16977 "This command uploads and unpacks local file C<tarfile> (an I<uncompressed> "
16978 "tar file) into C<directory>."
16982 #: ../src/guestfs-actions.pod:6595
16984 "To upload a compressed tarball, use C<guestfs_tgz_in> or C<guestfs_txz_in>."
16988 #: ../src/guestfs-actions.pod:6600 ../src/guestfs-actions.pod:6617
16989 #: ../src/guestfs-actions.pod:6633 ../src/guestfs-actions.pod:6649
16990 msgid "(Added in 1.0.3)"
16994 #: ../src/guestfs-actions.pod:6602
16995 msgid "guestfs_tar_out"
16999 #: ../src/guestfs-actions.pod:6604
17003 " guestfs_tar_out (guestfs_h *g,\n"
17004 " const char *directory,\n"
17005 " const char *tarfile);\n"
17010 #: ../src/guestfs-actions.pod:6609 ../fish/guestfish-actions.pod:4451
17012 "This command packs the contents of C<directory> and downloads it to local "
17017 #: ../src/guestfs-actions.pod:6612
17019 "To download a compressed tarball, use C<guestfs_tgz_out> or "
17020 "C<guestfs_txz_out>."
17024 #: ../src/guestfs-actions.pod:6619
17025 msgid "guestfs_tgz_in"
17029 #: ../src/guestfs-actions.pod:6621
17033 " guestfs_tgz_in (guestfs_h *g,\n"
17034 " const char *tarball,\n"
17035 " const char *directory);\n"
17040 #: ../src/guestfs-actions.pod:6626 ../fish/guestfish-actions.pod:4463
17042 "This command uploads and unpacks local file C<tarball> (a I<gzip compressed> "
17043 "tar file) into C<directory>."
17047 #: ../src/guestfs-actions.pod:6629
17048 msgid "To upload an uncompressed tarball, use C<guestfs_tar_in>."
17052 #: ../src/guestfs-actions.pod:6635
17053 msgid "guestfs_tgz_out"
17057 #: ../src/guestfs-actions.pod:6637
17061 " guestfs_tgz_out (guestfs_h *g,\n"
17062 " const char *directory,\n"
17063 " const char *tarball);\n"
17068 #: ../src/guestfs-actions.pod:6642 ../fish/guestfish-actions.pod:4474
17070 "This command packs the contents of C<directory> and downloads it to local "
17075 #: ../src/guestfs-actions.pod:6645
17076 msgid "To download an uncompressed tarball, use C<guestfs_tar_out>."
17080 #: ../src/guestfs-actions.pod:6651
17081 msgid "guestfs_touch"
17085 #: ../src/guestfs-actions.pod:6653
17089 " guestfs_touch (guestfs_h *g,\n"
17090 " const char *path);\n"
17095 #: ../src/guestfs-actions.pod:6657 ../fish/guestfish-actions.pod:4485
17097 "Touch acts like the L<touch(1)> command. It can be used to update the "
17098 "timestamps on a file, or, if the file does not exist, to create a new zero-"
17103 #: ../src/guestfs-actions.pod:6661 ../fish/guestfish-actions.pod:4489
17105 "This command only works on regular files, and will fail on other file types "
17106 "such as directories, symbolic links, block special etc."
17110 #: ../src/guestfs-actions.pod:6668
17111 msgid "guestfs_truncate"
17115 #: ../src/guestfs-actions.pod:6670
17119 " guestfs_truncate (guestfs_h *g,\n"
17120 " const char *path);\n"
17125 #: ../src/guestfs-actions.pod:6674 ../fish/guestfish-actions.pod:4496
17127 "This command truncates C<path> to a zero-length file. The file must exist "
17132 #: ../src/guestfs-actions.pod:6681
17133 msgid "guestfs_truncate_size"
17137 #: ../src/guestfs-actions.pod:6683
17141 " guestfs_truncate_size (guestfs_h *g,\n"
17142 " const char *path,\n"
17143 " int64_t size);\n"
17148 #: ../src/guestfs-actions.pod:6688 ../fish/guestfish-actions.pod:4503
17150 "This command truncates C<path> to size C<size> bytes. The file must exist "
17155 #: ../src/guestfs-actions.pod:6691
17157 "If the current file size is less than C<size> then the file is extended to "
17158 "the required size with zero bytes. This creates a sparse file (ie. disk "
17159 "blocks are not allocated for the file until you write to it). To create a "
17160 "non-sparse file of zeroes, use C<guestfs_fallocate64> instead."
17164 #: ../src/guestfs-actions.pod:6701
17165 msgid "guestfs_tune2fs_l"
17169 #: ../src/guestfs-actions.pod:6703
17173 " guestfs_tune2fs_l (guestfs_h *g,\n"
17174 " const char *device);\n"
17179 #: ../src/guestfs-actions.pod:6707 ../fish/guestfish-actions.pod:4516
17181 "This returns the contents of the ext2, ext3 or ext4 filesystem superblock on "
17186 #: ../src/guestfs-actions.pod:6710 ../fish/guestfish-actions.pod:4519
17188 "It is the same as running C<tune2fs -l device>. See L<tune2fs(8)> manpage "
17189 "for more details. The list of fields returned isn't clearly defined, and "
17190 "depends on both the version of C<tune2fs> that libguestfs was built against, "
17191 "and the filesystem itself."
17195 #: ../src/guestfs-actions.pod:6723
17196 msgid "guestfs_txz_in"
17200 #: ../src/guestfs-actions.pod:6725
17204 " guestfs_txz_in (guestfs_h *g,\n"
17205 " const char *tarball,\n"
17206 " const char *directory);\n"
17211 #: ../src/guestfs-actions.pod:6730 ../fish/guestfish-actions.pod:4528
17213 "This command uploads and unpacks local file C<tarball> (an I<xz compressed> "
17214 "tar file) into C<directory>."
17218 #: ../src/guestfs-actions.pod:6737
17219 msgid "guestfs_txz_out"
17223 #: ../src/guestfs-actions.pod:6739
17227 " guestfs_txz_out (guestfs_h *g,\n"
17228 " const char *directory,\n"
17229 " const char *tarball);\n"
17234 #: ../src/guestfs-actions.pod:6744 ../fish/guestfish-actions.pod:4537
17236 "This command packs the contents of C<directory> and downloads it to local "
17237 "file C<tarball> (as an xz compressed tar archive)."
17241 #: ../src/guestfs-actions.pod:6751
17242 msgid "guestfs_umask"
17246 #: ../src/guestfs-actions.pod:6753
17250 " guestfs_umask (guestfs_h *g,\n"
17256 #: ../src/guestfs-actions.pod:6757 ../fish/guestfish-actions.pod:4546
17258 "This function sets the mask used for creating new files and device nodes to "
17263 #: ../src/guestfs-actions.pod:6760 ../fish/guestfish-actions.pod:4549
17265 "Typical umask values would be C<022> which creates new files with "
17266 "permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and C<002> which creates "
17267 "new files with permissions like \"-rw-rw-r--\" or \"-rwxrwxr-x\"."
17271 #: ../src/guestfs-actions.pod:6765 ../fish/guestfish-actions.pod:4554
17273 "The default umask is C<022>. This is important because it means that "
17274 "directories and device nodes will be created with C<0644> or C<0755> mode "
17275 "even if you specify C<0777>."
17279 #: ../src/guestfs-actions.pod:6769
17281 "See also C<guestfs_get_umask>, L<umask(2)>, C<guestfs_mknod>, "
17282 "C<guestfs_mkdir>."
17286 #: ../src/guestfs-actions.pod:6772 ../fish/guestfish-actions.pod:4561
17287 msgid "This call returns the previous umask."
17291 #: ../src/guestfs-actions.pod:6778
17292 msgid "guestfs_umount"
17296 #: ../src/guestfs-actions.pod:6780
17300 " guestfs_umount (guestfs_h *g,\n"
17301 " const char *pathordevice);\n"
17306 #: ../src/guestfs-actions.pod:6784 ../fish/guestfish-actions.pod:4569
17308 "This unmounts the given filesystem. The filesystem may be specified either "
17309 "by its mountpoint (path) or the device which contains the filesystem."
17313 #: ../src/guestfs-actions.pod:6792
17314 msgid "guestfs_umount_all"
17318 #: ../src/guestfs-actions.pod:6794
17322 " guestfs_umount_all (guestfs_h *g);\n"
17327 #: ../src/guestfs-actions.pod:6797 ../fish/guestfish-actions.pod:4579
17328 msgid "This unmounts all mounted filesystems."
17332 #: ../src/guestfs-actions.pod:6799 ../fish/guestfish-actions.pod:4581
17333 msgid "Some internal mounts are not unmounted by this call."
17337 #: ../src/guestfs-actions.pod:6805
17338 msgid "guestfs_upload"
17342 #: ../src/guestfs-actions.pod:6807
17346 " guestfs_upload (guestfs_h *g,\n"
17347 " const char *filename,\n"
17348 " const char *remotefilename);\n"
17353 #: ../src/guestfs-actions.pod:6812 ../src/guestfs-actions.pod:6836
17354 #: ../fish/guestfish-actions.pod:4587 ../fish/guestfish-actions.pod:4600
17355 msgid "Upload local file C<filename> to C<remotefilename> on the filesystem."
17359 #: ../src/guestfs-actions.pod:6817
17360 msgid "See also C<guestfs_download>."
17364 #: ../src/guestfs-actions.pod:6828
17365 msgid "guestfs_upload_offset"
17369 #: ../src/guestfs-actions.pod:6830
17373 " guestfs_upload_offset (guestfs_h *g,\n"
17374 " const char *filename,\n"
17375 " const char *remotefilename,\n"
17376 " int64_t offset);\n"
17381 #: ../src/guestfs-actions.pod:6839 ../fish/guestfish-actions.pod:4603
17383 "C<remotefilename> is overwritten starting at the byte C<offset> specified. "
17384 "The intention is to overwrite parts of existing files or devices, although "
17385 "if a non-existant file is specified then it is created with a \"hole\" "
17386 "before C<offset>. The size of the data written is implicit in the size of "
17387 "the source C<filename>."
17391 #: ../src/guestfs-actions.pod:6846
17393 "Note that there is no limit on the amount of data that can be uploaded with "
17394 "this call, unlike with C<guestfs_pwrite>, and this call always writes the "
17395 "full amount unless an error occurs."
17399 #: ../src/guestfs-actions.pod:6851
17400 msgid "See also C<guestfs_upload>, C<guestfs_pwrite>."
17404 #: ../src/guestfs-actions.pod:6862
17405 msgid "guestfs_utimens"
17409 #: ../src/guestfs-actions.pod:6864
17413 " guestfs_utimens (guestfs_h *g,\n"
17414 " const char *path,\n"
17415 " int64_t atsecs,\n"
17416 " int64_t atnsecs,\n"
17417 " int64_t mtsecs,\n"
17418 " int64_t mtnsecs);\n"
17423 #: ../src/guestfs-actions.pod:6872 ../fish/guestfish-actions.pod:4623
17424 msgid "This command sets the timestamps of a file with nanosecond precision."
17428 #: ../src/guestfs-actions.pod:6875 ../fish/guestfish-actions.pod:4626
17430 "C<atsecs, atnsecs> are the last access time (atime) in secs and nanoseconds "
17435 #: ../src/guestfs-actions.pod:6878 ../fish/guestfish-actions.pod:4629
17437 "C<mtsecs, mtnsecs> are the last modification time (mtime) in secs and "
17438 "nanoseconds from the epoch."
17442 #: ../src/guestfs-actions.pod:6881 ../fish/guestfish-actions.pod:4632
17444 "If the C<*nsecs> field contains the special value C<-1> then the "
17445 "corresponding timestamp is set to the current time. (The C<*secs> field is "
17446 "ignored in this case)."
17450 #: ../src/guestfs-actions.pod:6885 ../fish/guestfish-actions.pod:4636
17452 "If the C<*nsecs> field contains the special value C<-2> then the "
17453 "corresponding timestamp is left unchanged. (The C<*secs> field is ignored "
17458 #: ../src/guestfs-actions.pod:6893 ../src/guestfs-structs.pod:175
17459 msgid "guestfs_version"
17463 #: ../src/guestfs-actions.pod:6895
17466 " struct guestfs_version *\n"
17467 " guestfs_version (guestfs_h *g);\n"
17472 #: ../src/guestfs-actions.pod:6898 ../fish/guestfish-actions.pod:4644
17474 "Return the libguestfs version number that the program is linked against."
17478 #: ../src/guestfs-actions.pod:6901 ../fish/guestfish-actions.pod:4647
17480 "Note that because of dynamic linking this is not necessarily the version of "
17481 "libguestfs that you compiled against. You can compile the program, and then "
17482 "at runtime dynamically link against a completely different C<libguestfs.so> "
17487 #: ../src/guestfs-actions.pod:6906 ../fish/guestfish-actions.pod:4652
17489 "This call was added in version C<1.0.58>. In previous versions of "
17490 "libguestfs there was no way to get the version number. From C code you can "
17491 "use dynamic linker functions to find out if this symbol exists (if it "
17492 "doesn't, then it's an earlier version)."
17496 #: ../src/guestfs-actions.pod:6912 ../fish/guestfish-actions.pod:4658
17498 "The call returns a structure with four elements. The first three (C<major>, "
17499 "C<minor> and C<release>) are numbers and correspond to the usual version "
17500 "triplet. The fourth element (C<extra>) is a string and is normally empty, "
17501 "but may be used for distro-specific information."
17505 #: ../src/guestfs-actions.pod:6918 ../fish/guestfish-actions.pod:4664
17507 "To construct the original version string: C<$major.$minor.$release$extra>"
17511 #: ../src/guestfs-actions.pod:6921 ../fish/guestfish-actions.pod:4667
17512 msgid "See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>."
17516 #: ../src/guestfs-actions.pod:6923
17518 "I<Note:> Don't use this call to test for availability of features. In "
17519 "enterprise distributions we backport features from later versions into "
17520 "earlier versions, making this an unreliable way to test for features. Use "
17521 "C<guestfs_available> instead."
17525 #: ../src/guestfs-actions.pod:6929
17527 "This function returns a C<struct guestfs_version *>, or NULL if there was an "
17528 "error. I<The caller must call C<guestfs_free_version> after use>."
17532 #: ../src/guestfs-actions.pod:6933
17533 msgid "(Added in 1.0.58)"
17537 #: ../src/guestfs-actions.pod:6935
17538 msgid "guestfs_vfs_label"
17542 #: ../src/guestfs-actions.pod:6937
17546 " guestfs_vfs_label (guestfs_h *g,\n"
17547 " const char *device);\n"
17552 #: ../src/guestfs-actions.pod:6941 ../fish/guestfish-actions.pod:4679
17553 msgid "This returns the filesystem label of the filesystem on C<device>."
17557 #: ../src/guestfs-actions.pod:6944 ../fish/guestfish-actions.pod:4682
17558 msgid "If the filesystem is unlabeled, this returns the empty string."
17562 #: ../src/guestfs-actions.pod:6946
17563 msgid "To find a filesystem from the label, use C<guestfs_findfs_label>."
17567 #: ../src/guestfs-actions.pod:6951 ../src/guestfs-actions.pod:6988
17568 msgid "(Added in 1.3.18)"
17572 #: ../src/guestfs-actions.pod:6953
17573 msgid "guestfs_vfs_type"
17577 #: ../src/guestfs-actions.pod:6955
17581 " guestfs_vfs_type (guestfs_h *g,\n"
17582 " const char *device);\n"
17587 #: ../src/guestfs-actions.pod:6959 ../fish/guestfish-actions.pod:4690
17589 "This command gets the filesystem type corresponding to the filesystem on "
17594 #: ../src/guestfs-actions.pod:6962 ../fish/guestfish-actions.pod:4693
17596 "For most filesystems, the result is the name of the Linux VFS module which "
17597 "would be used to mount this filesystem if you mounted it without specifying "
17598 "the filesystem type. For example a string such as C<ext3> or C<ntfs>."
17602 #: ../src/guestfs-actions.pod:6972
17603 msgid "guestfs_vfs_uuid"
17607 #: ../src/guestfs-actions.pod:6974
17611 " guestfs_vfs_uuid (guestfs_h *g,\n"
17612 " const char *device);\n"
17617 #: ../src/guestfs-actions.pod:6978 ../fish/guestfish-actions.pod:4702
17618 msgid "This returns the filesystem UUID of the filesystem on C<device>."
17622 #: ../src/guestfs-actions.pod:6981 ../fish/guestfish-actions.pod:4705
17623 msgid "If the filesystem does not have a UUID, this returns the empty string."
17627 #: ../src/guestfs-actions.pod:6983
17628 msgid "To find a filesystem from the UUID, use C<guestfs_findfs_uuid>."
17632 #: ../src/guestfs-actions.pod:6990
17633 msgid "guestfs_vg_activate"
17637 #: ../src/guestfs-actions.pod:6992
17641 " guestfs_vg_activate (guestfs_h *g,\n"
17643 " char *const *volgroups);\n"
17648 #: ../src/guestfs-actions.pod:6997 ../fish/guestfish-actions.pod:4713
17650 "This command activates or (if C<activate> is false) deactivates all logical "
17651 "volumes in the listed volume groups C<volgroups>. If activated, then they "
17652 "are made known to the kernel, ie. they appear as C</dev/mapper> devices. If "
17653 "deactivated, then those devices disappear."
17657 #: ../src/guestfs-actions.pod:7003 ../fish/guestfish-actions.pod:4719
17658 msgid "This command is the same as running C<vgchange -a y|n volgroups...>"
17662 #: ../src/guestfs-actions.pod:7005 ../fish/guestfish-actions.pod:4721
17664 "Note that if C<volgroups> is an empty list then B<all> volume groups are "
17665 "activated or deactivated."
17669 #: ../src/guestfs-actions.pod:7012
17670 msgid "guestfs_vg_activate_all"
17674 #: ../src/guestfs-actions.pod:7014
17678 " guestfs_vg_activate_all (guestfs_h *g,\n"
17679 " int activate);\n"
17684 #: ../src/guestfs-actions.pod:7018 ../fish/guestfish-actions.pod:4728
17686 "This command activates or (if C<activate> is false) deactivates all logical "
17687 "volumes in all volume groups. If activated, then they are made known to the "
17688 "kernel, ie. they appear as C</dev/mapper> devices. If deactivated, then "
17689 "those devices disappear."
17693 #: ../src/guestfs-actions.pod:7024 ../fish/guestfish-actions.pod:4734
17694 msgid "This command is the same as running C<vgchange -a y|n>"
17698 #: ../src/guestfs-actions.pod:7030
17699 msgid "guestfs_vgcreate"
17703 #: ../src/guestfs-actions.pod:7032
17707 " guestfs_vgcreate (guestfs_h *g,\n"
17708 " const char *volgroup,\n"
17709 " char *const *physvols);\n"
17714 #: ../src/guestfs-actions.pod:7037 ../fish/guestfish-actions.pod:4740
17716 "This creates an LVM volume group called C<volgroup> from the non-empty list "
17717 "of physical volumes C<physvols>."
17721 #: ../src/guestfs-actions.pod:7044
17722 msgid "guestfs_vglvuuids"
17726 #: ../src/guestfs-actions.pod:7046
17730 " guestfs_vglvuuids (guestfs_h *g,\n"
17731 " const char *vgname);\n"
17736 #: ../src/guestfs-actions.pod:7050 ../fish/guestfish-actions.pod:4747
17738 "Given a VG called C<vgname>, this returns the UUIDs of all the logical "
17739 "volumes created in this volume group."
17743 #: ../src/guestfs-actions.pod:7053
17745 "You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid> calls to "
17746 "associate logical volumes and volume groups."
17750 #: ../src/guestfs-actions.pod:7056
17751 msgid "See also C<guestfs_vgpvuuids>."
17755 #: ../src/guestfs-actions.pod:7064
17756 msgid "guestfs_vgpvuuids"
17760 #: ../src/guestfs-actions.pod:7066
17764 " guestfs_vgpvuuids (guestfs_h *g,\n"
17765 " const char *vgname);\n"
17770 #: ../src/guestfs-actions.pod:7070 ../fish/guestfish-actions.pod:4759
17772 "Given a VG called C<vgname>, this returns the UUIDs of all the physical "
17773 "volumes that this volume group resides on."
17777 #: ../src/guestfs-actions.pod:7073
17779 "You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid> calls to "
17780 "associate physical volumes and volume groups."
17784 #: ../src/guestfs-actions.pod:7076
17785 msgid "See also C<guestfs_vglvuuids>."
17789 #: ../src/guestfs-actions.pod:7084
17790 msgid "guestfs_vgremove"
17794 #: ../src/guestfs-actions.pod:7086
17798 " guestfs_vgremove (guestfs_h *g,\n"
17799 " const char *vgname);\n"
17804 #: ../src/guestfs-actions.pod:7090 ../fish/guestfish-actions.pod:4771
17805 msgid "Remove an LVM volume group C<vgname>, (for example C<VG>)."
17809 #: ../src/guestfs-actions.pod:7092 ../fish/guestfish-actions.pod:4773
17811 "This also forcibly removes all logical volumes in the volume group (if any)."
17815 #: ../src/guestfs-actions.pod:7099
17816 msgid "guestfs_vgrename"
17820 #: ../src/guestfs-actions.pod:7101
17824 " guestfs_vgrename (guestfs_h *g,\n"
17825 " const char *volgroup,\n"
17826 " const char *newvolgroup);\n"
17831 #: ../src/guestfs-actions.pod:7106 ../fish/guestfish-actions.pod:4780
17832 msgid "Rename a volume group C<volgroup> with the new name C<newvolgroup>."
17836 #: ../src/guestfs-actions.pod:7112
17837 msgid "guestfs_vgs"
17841 #: ../src/guestfs-actions.pod:7114
17845 " guestfs_vgs (guestfs_h *g);\n"
17850 #: ../src/guestfs-actions.pod:7117 ../fish/guestfish-actions.pod:4786
17852 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
17857 #: ../src/guestfs-actions.pod:7120 ../fish/guestfish-actions.pod:4789
17859 "This returns a list of just the volume group names that were detected (eg. "
17864 #: ../src/guestfs-actions.pod:7123
17865 msgid "See also C<guestfs_vgs_full>."
17869 #: ../src/guestfs-actions.pod:7131
17870 msgid "guestfs_vgs_full"
17874 #: ../src/guestfs-actions.pod:7133
17877 " struct guestfs_lvm_vg_list *\n"
17878 " guestfs_vgs_full (guestfs_h *g);\n"
17883 #: ../src/guestfs-actions.pod:7136 ../fish/guestfish-actions.pod:4798
17885 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
17886 "> command. The \"full\" version includes all fields."
17890 #: ../src/guestfs-actions.pod:7139
17892 "This function returns a C<struct guestfs_lvm_vg_list *>, or NULL if there "
17893 "was an error. I<The caller must call C<guestfs_free_lvm_vg_list> after use>."
17897 #: ../src/guestfs-actions.pod:7145
17898 msgid "guestfs_vgscan"
17902 #: ../src/guestfs-actions.pod:7147
17906 " guestfs_vgscan (guestfs_h *g);\n"
17911 #: ../src/guestfs-actions.pod:7150 ../fish/guestfish-actions.pod:4805
17913 "This rescans all block devices and rebuilds the list of LVM physical "
17914 "volumes, volume groups and logical volumes."
17918 #: ../src/guestfs-actions.pod:7157
17919 msgid "guestfs_vguuid"
17923 #: ../src/guestfs-actions.pod:7159
17927 " guestfs_vguuid (guestfs_h *g,\n"
17928 " const char *vgname);\n"
17933 #: ../src/guestfs-actions.pod:7163 ../fish/guestfish-actions.pod:4812
17934 msgid "This command returns the UUID of the LVM VG named C<vgname>."
17938 #: ../src/guestfs-actions.pod:7170
17939 msgid "guestfs_wait_ready"
17943 #: ../src/guestfs-actions.pod:7172
17947 " guestfs_wait_ready (guestfs_h *g);\n"
17952 #: ../src/guestfs-actions.pod:7175
17953 msgid "This function is a no op."
17957 #: ../src/guestfs-actions.pod:7177
17959 "In versions of the API E<lt> 1.0.71 you had to call this function just after "
17960 "calling C<guestfs_launch> to wait for the launch to complete. However this "
17961 "is no longer necessary because C<guestfs_launch> now does the waiting."
17965 #: ../src/guestfs-actions.pod:7182
17967 "If you see any calls to this function in code then you can just remove them, "
17968 "unless you want to retain compatibility with older versions of the API."
17972 #: ../src/guestfs-actions.pod:7190
17973 msgid "guestfs_wc_c"
17977 #: ../src/guestfs-actions.pod:7192
17981 " guestfs_wc_c (guestfs_h *g,\n"
17982 " const char *path);\n"
17987 #: ../src/guestfs-actions.pod:7196 ../fish/guestfish-actions.pod:4818
17989 "This command counts the characters in a file, using the C<wc -c> external "
17994 #: ../src/guestfs-actions.pod:7203
17995 msgid "guestfs_wc_l"
17999 #: ../src/guestfs-actions.pod:7205
18003 " guestfs_wc_l (guestfs_h *g,\n"
18004 " const char *path);\n"
18009 #: ../src/guestfs-actions.pod:7209 ../fish/guestfish-actions.pod:4825
18011 "This command counts the lines in a file, using the C<wc -l> external command."
18015 #: ../src/guestfs-actions.pod:7216
18016 msgid "guestfs_wc_w"
18020 #: ../src/guestfs-actions.pod:7218
18024 " guestfs_wc_w (guestfs_h *g,\n"
18025 " const char *path);\n"
18030 #: ../src/guestfs-actions.pod:7222 ../fish/guestfish-actions.pod:4832
18032 "This command counts the words in a file, using the C<wc -w> external command."
18036 #: ../src/guestfs-actions.pod:7229
18037 msgid "guestfs_write"
18041 #: ../src/guestfs-actions.pod:7231
18045 " guestfs_write (guestfs_h *g,\n"
18046 " const char *path,\n"
18047 " const char *content,\n"
18048 " size_t content_size);\n"
18053 #: ../src/guestfs-actions.pod:7237 ../fish/guestfish-actions.pod:4839
18055 "This call creates a file called C<path>. The content of the file is the "
18056 "string C<content> (which can contain any 8 bit data)."
18060 #: ../src/guestfs-actions.pod:7247
18061 msgid "guestfs_write_file"
18065 #: ../src/guestfs-actions.pod:7249
18069 " guestfs_write_file (guestfs_h *g,\n"
18070 " const char *path,\n"
18071 " const char *content,\n"
18077 #: ../src/guestfs-actions.pod:7255 ../fish/guestfish-actions.pod:4849
18079 "This call creates a file called C<path>. The contents of the file is the "
18080 "string C<content> (which can contain any 8 bit data), with length C<size>."
18084 #: ../src/guestfs-actions.pod:7259 ../fish/guestfish-actions.pod:4853
18086 "As a special case, if C<size> is C<0> then the length is calculated using "
18087 "C<strlen> (so in this case the content cannot contain embedded ASCII NULs)."
18091 #: ../src/guestfs-actions.pod:7263 ../fish/guestfish-actions.pod:4857
18093 "I<NB.> Owing to a bug, writing content containing ASCII NUL characters does "
18094 "I<not> work, even if the length is specified."
18098 #: ../src/guestfs-actions.pod:7271 ../fish/guestfish-actions.pod:4863
18100 "This function is deprecated. In new code, use the C<write> call instead."
18104 #: ../src/guestfs-actions.pod:7280
18105 msgid "guestfs_zegrep"
18109 #: ../src/guestfs-actions.pod:7282
18113 " guestfs_zegrep (guestfs_h *g,\n"
18114 " const char *regex,\n"
18115 " const char *path);\n"
18120 #: ../src/guestfs-actions.pod:7287 ../fish/guestfish-actions.pod:4874
18122 "This calls the external C<zegrep> program and returns the matching lines."
18126 #: ../src/guestfs-actions.pod:7299
18127 msgid "guestfs_zegrepi"
18131 #: ../src/guestfs-actions.pod:7301
18135 " guestfs_zegrepi (guestfs_h *g,\n"
18136 " const char *regex,\n"
18137 " const char *path);\n"
18142 #: ../src/guestfs-actions.pod:7306 ../fish/guestfish-actions.pod:4884
18144 "This calls the external C<zegrep -i> program and returns the matching lines."
18148 #: ../src/guestfs-actions.pod:7318
18149 msgid "guestfs_zero"
18153 #: ../src/guestfs-actions.pod:7320
18157 " guestfs_zero (guestfs_h *g,\n"
18158 " const char *device);\n"
18163 #: ../src/guestfs-actions.pod:7324 ../fish/guestfish-actions.pod:4894
18164 msgid "This command writes zeroes over the first few blocks of C<device>."
18168 #: ../src/guestfs-actions.pod:7326 ../fish/guestfish-actions.pod:4896
18170 "How many blocks are zeroed isn't specified (but it's I<not> enough to "
18171 "securely wipe the device). It should be sufficient to remove any partition "
18172 "tables, filesystem superblocks and so on."
18176 #: ../src/guestfs-actions.pod:7330
18177 msgid "See also: C<guestfs_zero_device>, C<guestfs_scrub_device>."
18181 #: ../src/guestfs-actions.pod:7341
18182 msgid "guestfs_zero_device"
18186 #: ../src/guestfs-actions.pod:7343
18190 " guestfs_zero_device (guestfs_h *g,\n"
18191 " const char *device);\n"
18196 #: ../src/guestfs-actions.pod:7347
18198 "This command writes zeroes over the entire C<device>. Compare with "
18199 "C<guestfs_zero> which just zeroes the first few blocks of a device."
18203 #: ../src/guestfs-actions.pod:7361
18204 msgid "(Added in 1.3.1)"
18208 #: ../src/guestfs-actions.pod:7363
18209 msgid "guestfs_zerofree"
18213 #: ../src/guestfs-actions.pod:7365
18217 " guestfs_zerofree (guestfs_h *g,\n"
18218 " const char *device);\n"
18223 #: ../src/guestfs-actions.pod:7369 ../fish/guestfish-actions.pod:4917
18225 "This runs the I<zerofree> program on C<device>. This program claims to zero "
18226 "unused inodes and disk blocks on an ext2/3 filesystem, thus making it "
18227 "possible to compress the filesystem more effectively."
18231 #: ../src/guestfs-actions.pod:7374 ../fish/guestfish-actions.pod:4922
18232 msgid "You should B<not> run this program if the filesystem is mounted."
18236 #: ../src/guestfs-actions.pod:7377 ../fish/guestfish-actions.pod:4925
18238 "It is possible that using this program can damage the filesystem or data on "
18243 #: ../src/guestfs-actions.pod:7384
18244 msgid "guestfs_zfgrep"
18248 #: ../src/guestfs-actions.pod:7386
18252 " guestfs_zfgrep (guestfs_h *g,\n"
18253 " const char *pattern,\n"
18254 " const char *path);\n"
18259 #: ../src/guestfs-actions.pod:7391 ../fish/guestfish-actions.pod:4932
18261 "This calls the external C<zfgrep> program and returns the matching lines."
18265 #: ../src/guestfs-actions.pod:7403
18266 msgid "guestfs_zfgrepi"
18270 #: ../src/guestfs-actions.pod:7405
18274 " guestfs_zfgrepi (guestfs_h *g,\n"
18275 " const char *pattern,\n"
18276 " const char *path);\n"
18281 #: ../src/guestfs-actions.pod:7410 ../fish/guestfish-actions.pod:4942
18283 "This calls the external C<zfgrep -i> program and returns the matching lines."
18287 #: ../src/guestfs-actions.pod:7422
18288 msgid "guestfs_zfile"
18292 #: ../src/guestfs-actions.pod:7424
18296 " guestfs_zfile (guestfs_h *g,\n"
18297 " const char *meth,\n"
18298 " const char *path);\n"
18303 #: ../src/guestfs-actions.pod:7429 ../fish/guestfish-actions.pod:4952
18305 "This command runs C<file> after first decompressing C<path> using C<method>."
18309 #: ../src/guestfs-actions.pod:7432 ../fish/guestfish-actions.pod:4955
18310 msgid "C<method> must be one of C<gzip>, C<compress> or C<bzip2>."
18314 #: ../src/guestfs-actions.pod:7434
18316 "Since 1.0.63, use C<guestfs_file> instead which can now process compressed "
18321 #: ../src/guestfs-actions.pod:7440 ../fish/guestfish-actions.pod:4960
18323 "This function is deprecated. In new code, use the C<file> call instead."
18327 #: ../src/guestfs-actions.pod:7449
18328 msgid "guestfs_zgrep"
18332 #: ../src/guestfs-actions.pod:7451
18336 " guestfs_zgrep (guestfs_h *g,\n"
18337 " const char *regex,\n"
18338 " const char *path);\n"
18343 #: ../src/guestfs-actions.pod:7456 ../fish/guestfish-actions.pod:4971
18345 "This calls the external C<zgrep> program and returns the matching lines."
18349 #: ../src/guestfs-actions.pod:7468
18350 msgid "guestfs_zgrepi"
18354 #: ../src/guestfs-actions.pod:7470
18358 " guestfs_zgrepi (guestfs_h *g,\n"
18359 " const char *regex,\n"
18360 " const char *path);\n"
18365 #: ../src/guestfs-actions.pod:7475 ../fish/guestfish-actions.pod:4981
18367 "This calls the external C<zgrep -i> program and returns the matching lines."
18371 #: ../src/guestfs-availability.pod:3
18376 #: ../src/guestfs-availability.pod:5
18378 "The following functions: L</guestfs_aug_clear> L</guestfs_aug_close> L</"
18379 "guestfs_aug_defnode> L</guestfs_aug_defvar> L</guestfs_aug_get> L</"
18380 "guestfs_aug_init> L</guestfs_aug_insert> L</guestfs_aug_load> L</"
18381 "guestfs_aug_ls> L</guestfs_aug_match> L</guestfs_aug_mv> L</guestfs_aug_rm> "
18382 "L</guestfs_aug_save> L</guestfs_aug_set>"
18386 #: ../src/guestfs-availability.pod:21
18391 #: ../src/guestfs-availability.pod:23
18393 "The following functions: L</guestfs_inotify_add_watch> L</"
18394 "guestfs_inotify_close> L</guestfs_inotify_files> L</guestfs_inotify_init> L</"
18395 "guestfs_inotify_read> L</guestfs_inotify_rm_watch>"
18399 #: ../src/guestfs-availability.pod:31
18400 msgid "B<linuxfsuuid>"
18404 #: ../src/guestfs-availability.pod:33
18406 "The following functions: L</guestfs_mke2fs_JU> L</guestfs_mke2journal_U> L</"
18407 "guestfs_mkswap_U> L</guestfs_swapoff_uuid> L</guestfs_swapon_uuid>"
18411 #: ../src/guestfs-availability.pod:40
18412 msgid "B<linuxmodules>"
18416 #: ../src/guestfs-availability.pod:42
18417 msgid "The following functions: L</guestfs_modprobe>"
18421 #: ../src/guestfs-availability.pod:45
18422 msgid "B<linuxxattrs>"
18426 #: ../src/guestfs-availability.pod:47
18428 "The following functions: L</guestfs_getxattr> L</guestfs_getxattrs> L</"
18429 "guestfs_lgetxattr> L</guestfs_lgetxattrs> L</guestfs_lremovexattr> L</"
18430 "guestfs_lsetxattr> L</guestfs_lxattrlist> L</guestfs_removexattr> L</"
18431 "guestfs_setxattr>"
18435 #: ../src/guestfs-availability.pod:58
18440 #: ../src/guestfs-availability.pod:60
18442 "The following functions: L</guestfs_luks_add_key> L</guestfs_luks_close> L</"
18443 "guestfs_luks_format> L</guestfs_luks_format_cipher> L</"
18444 "guestfs_luks_kill_slot> L</guestfs_luks_open> L</guestfs_luks_open_ro>"
18448 #: ../src/guestfs-availability.pod:69
18453 #: ../src/guestfs-availability.pod:71
18455 "The following functions: L</guestfs_is_lv> L</guestfs_lvcreate> L</"
18456 "guestfs_lvm_remove_all> L</guestfs_lvm_set_filter> L</guestfs_lvremove> L</"
18457 "guestfs_lvresize> L</guestfs_lvresize_free> L</guestfs_lvs> L</"
18458 "guestfs_lvs_full> L</guestfs_pvcreate> L</guestfs_pvremove> L</"
18459 "guestfs_pvresize> L</guestfs_pvresize_size> L</guestfs_pvs> L</"
18460 "guestfs_pvs_full> L</guestfs_vg_activate> L</guestfs_vg_activate_all> L</"
18461 "guestfs_vgcreate> L</guestfs_vgremove> L</guestfs_vgs> L</guestfs_vgs_full>"
18465 #: ../src/guestfs-availability.pod:94
18470 #: ../src/guestfs-availability.pod:96
18472 "The following functions: L</guestfs_mkfifo> L</guestfs_mknod> L</"
18473 "guestfs_mknod_b> L</guestfs_mknod_c>"
18477 #: ../src/guestfs-availability.pod:102
18482 #: ../src/guestfs-availability.pod:104
18483 msgid "The following functions: L</guestfs_ntfs_3g_probe>"
18487 #: ../src/guestfs-availability.pod:107
18488 msgid "B<ntfsprogs>"
18492 #: ../src/guestfs-availability.pod:109
18494 "The following functions: L</guestfs_ntfsresize> L</guestfs_ntfsresize_size>"
18498 #: ../src/guestfs-availability.pod:113
18499 msgid "B<realpath>"
18503 #: ../src/guestfs-availability.pod:115
18504 msgid "The following functions: L</guestfs_realpath>"
18508 #: ../src/guestfs-availability.pod:118
18513 #: ../src/guestfs-availability.pod:120
18515 "The following functions: L</guestfs_scrub_device> L</guestfs_scrub_file> L</"
18516 "guestfs_scrub_freespace>"
18520 #: ../src/guestfs-availability.pod:125
18525 #: ../src/guestfs-availability.pod:127
18526 msgid "The following functions: L</guestfs_getcon> L</guestfs_setcon>"
18530 #: ../src/guestfs-availability.pod:131
18535 #: ../src/guestfs-availability.pod:133
18536 msgid "The following functions: L</guestfs_txz_in> L</guestfs_txz_out>"
18540 #: ../src/guestfs-availability.pod:137
18541 msgid "B<zerofree>"
18545 #: ../src/guestfs-availability.pod:139
18546 msgid "The following functions: L</guestfs_zerofree>"
18550 #: ../src/guestfs-structs.pod:1
18551 msgid "guestfs_int_bool"
18555 #: ../src/guestfs-structs.pod:3
18558 " struct guestfs_int_bool {\n"
18566 #: ../src/guestfs-structs.pod:8
18569 " struct guestfs_int_bool_list {\n"
18570 " uint32_t len; /* Number of elements in list. */\n"
18571 " struct guestfs_int_bool *val; /* Elements. */\n"
18577 #: ../src/guestfs-structs.pod:13
18580 " void guestfs_free_int_bool (struct guestfs_free_int_bool *);\n"
18581 " void guestfs_free_int_bool_list (struct guestfs_free_int_bool_list *);\n"
18586 #: ../src/guestfs-structs.pod:16
18587 msgid "guestfs_lvm_pv"
18591 #: ../src/guestfs-structs.pod:18
18594 " struct guestfs_lvm_pv {\n"
18595 " char *pv_name;\n"
18596 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
18597 " char pv_uuid[32];\n"
18599 " uint64_t pv_size;\n"
18600 " uint64_t dev_size;\n"
18601 " uint64_t pv_free;\n"
18602 " uint64_t pv_used;\n"
18603 " char *pv_attr;\n"
18604 " int64_t pv_pe_count;\n"
18605 " int64_t pv_pe_alloc_count;\n"
18606 " char *pv_tags;\n"
18607 " uint64_t pe_start;\n"
18608 " int64_t pv_mda_count;\n"
18609 " uint64_t pv_mda_free;\n"
18615 #: ../src/guestfs-structs.pod:36
18618 " struct guestfs_lvm_pv_list {\n"
18619 " uint32_t len; /* Number of elements in list. */\n"
18620 " struct guestfs_lvm_pv *val; /* Elements. */\n"
18626 #: ../src/guestfs-structs.pod:41
18629 " void guestfs_free_lvm_pv (struct guestfs_free_lvm_pv *);\n"
18630 " void guestfs_free_lvm_pv_list (struct guestfs_free_lvm_pv_list *);\n"
18635 #: ../src/guestfs-structs.pod:44
18636 msgid "guestfs_lvm_vg"
18640 #: ../src/guestfs-structs.pod:46
18643 " struct guestfs_lvm_vg {\n"
18644 " char *vg_name;\n"
18645 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
18646 " char vg_uuid[32];\n"
18648 " char *vg_attr;\n"
18649 " uint64_t vg_size;\n"
18650 " uint64_t vg_free;\n"
18651 " char *vg_sysid;\n"
18652 " uint64_t vg_extent_size;\n"
18653 " int64_t vg_extent_count;\n"
18654 " int64_t vg_free_count;\n"
18655 " int64_t max_lv;\n"
18656 " int64_t max_pv;\n"
18657 " int64_t pv_count;\n"
18658 " int64_t lv_count;\n"
18659 " int64_t snap_count;\n"
18660 " int64_t vg_seqno;\n"
18661 " char *vg_tags;\n"
18662 " int64_t vg_mda_count;\n"
18663 " uint64_t vg_mda_free;\n"
18669 #: ../src/guestfs-structs.pod:69
18672 " struct guestfs_lvm_vg_list {\n"
18673 " uint32_t len; /* Number of elements in list. */\n"
18674 " struct guestfs_lvm_vg *val; /* Elements. */\n"
18680 #: ../src/guestfs-structs.pod:74
18683 " void guestfs_free_lvm_vg (struct guestfs_free_lvm_vg *);\n"
18684 " void guestfs_free_lvm_vg_list (struct guestfs_free_lvm_vg_list *);\n"
18689 #: ../src/guestfs-structs.pod:77
18690 msgid "guestfs_lvm_lv"
18694 #: ../src/guestfs-structs.pod:79
18697 " struct guestfs_lvm_lv {\n"
18698 " char *lv_name;\n"
18699 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
18700 " char lv_uuid[32];\n"
18701 " char *lv_attr;\n"
18702 " int64_t lv_major;\n"
18703 " int64_t lv_minor;\n"
18704 " int64_t lv_kernel_major;\n"
18705 " int64_t lv_kernel_minor;\n"
18706 " uint64_t lv_size;\n"
18707 " int64_t seg_count;\n"
18709 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
18710 " float snap_percent;\n"
18711 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
18712 " float copy_percent;\n"
18713 " char *move_pv;\n"
18714 " char *lv_tags;\n"
18715 " char *mirror_log;\n"
18716 " char *modules;\n"
18722 #: ../src/guestfs-structs.pod:101
18725 " struct guestfs_lvm_lv_list {\n"
18726 " uint32_t len; /* Number of elements in list. */\n"
18727 " struct guestfs_lvm_lv *val; /* Elements. */\n"
18733 #: ../src/guestfs-structs.pod:106
18736 " void guestfs_free_lvm_lv (struct guestfs_free_lvm_lv *);\n"
18737 " void guestfs_free_lvm_lv_list (struct guestfs_free_lvm_lv_list *);\n"
18742 #: ../src/guestfs-structs.pod:111
18745 " struct guestfs_stat {\n"
18749 " int64_t nlink;\n"
18754 " int64_t blksize;\n"
18755 " int64_t blocks;\n"
18756 " int64_t atime;\n"
18757 " int64_t mtime;\n"
18758 " int64_t ctime;\n"
18764 #: ../src/guestfs-structs.pod:127
18767 " struct guestfs_stat_list {\n"
18768 " uint32_t len; /* Number of elements in list. */\n"
18769 " struct guestfs_stat *val; /* Elements. */\n"
18775 #: ../src/guestfs-structs.pod:132
18778 " void guestfs_free_stat (struct guestfs_free_stat *);\n"
18779 " void guestfs_free_stat_list (struct guestfs_free_stat_list *);\n"
18784 #: ../src/guestfs-structs.pod:137
18787 " struct guestfs_statvfs {\n"
18788 " int64_t bsize;\n"
18789 " int64_t frsize;\n"
18790 " int64_t blocks;\n"
18791 " int64_t bfree;\n"
18792 " int64_t bavail;\n"
18793 " int64_t files;\n"
18794 " int64_t ffree;\n"
18795 " int64_t favail;\n"
18798 " int64_t namemax;\n"
18804 #: ../src/guestfs-structs.pod:151
18807 " struct guestfs_statvfs_list {\n"
18808 " uint32_t len; /* Number of elements in list. */\n"
18809 " struct guestfs_statvfs *val; /* Elements. */\n"
18815 #: ../src/guestfs-structs.pod:156
18818 " void guestfs_free_statvfs (struct guestfs_free_statvfs *);\n"
18819 " void guestfs_free_statvfs_list (struct guestfs_free_statvfs_list *);\n"
18824 #: ../src/guestfs-structs.pod:159
18825 msgid "guestfs_dirent"
18829 #: ../src/guestfs-structs.pod:161
18832 " struct guestfs_dirent {\n"
18841 #: ../src/guestfs-structs.pod:167
18844 " struct guestfs_dirent_list {\n"
18845 " uint32_t len; /* Number of elements in list. */\n"
18846 " struct guestfs_dirent *val; /* Elements. */\n"
18852 #: ../src/guestfs-structs.pod:172
18855 " void guestfs_free_dirent (struct guestfs_free_dirent *);\n"
18856 " void guestfs_free_dirent_list (struct guestfs_free_dirent_list *);\n"
18861 #: ../src/guestfs-structs.pod:177
18864 " struct guestfs_version {\n"
18865 " int64_t major;\n"
18866 " int64_t minor;\n"
18867 " int64_t release;\n"
18874 #: ../src/guestfs-structs.pod:184
18877 " struct guestfs_version_list {\n"
18878 " uint32_t len; /* Number of elements in list. */\n"
18879 " struct guestfs_version *val; /* Elements. */\n"
18885 #: ../src/guestfs-structs.pod:189
18888 " void guestfs_free_version (struct guestfs_free_version *);\n"
18889 " void guestfs_free_version_list (struct guestfs_free_version_list *);\n"
18894 #: ../src/guestfs-structs.pod:192
18895 msgid "guestfs_xattr"
18899 #: ../src/guestfs-structs.pod:194
18902 " struct guestfs_xattr {\n"
18903 " char *attrname;\n"
18904 " /* The next two fields describe a byte array. */\n"
18905 " uint32_t attrval_len;\n"
18906 " char *attrval;\n"
18912 #: ../src/guestfs-structs.pod:201
18915 " struct guestfs_xattr_list {\n"
18916 " uint32_t len; /* Number of elements in list. */\n"
18917 " struct guestfs_xattr *val; /* Elements. */\n"
18923 #: ../src/guestfs-structs.pod:206
18926 " void guestfs_free_xattr (struct guestfs_free_xattr *);\n"
18927 " void guestfs_free_xattr_list (struct guestfs_free_xattr_list *);\n"
18932 #: ../src/guestfs-structs.pod:209
18933 msgid "guestfs_inotify_event"
18937 #: ../src/guestfs-structs.pod:211
18940 " struct guestfs_inotify_event {\n"
18941 " int64_t in_wd;\n"
18942 " uint32_t in_mask;\n"
18943 " uint32_t in_cookie;\n"
18944 " char *in_name;\n"
18950 #: ../src/guestfs-structs.pod:218
18953 " struct guestfs_inotify_event_list {\n"
18954 " uint32_t len; /* Number of elements in list. */\n"
18955 " struct guestfs_inotify_event *val; /* Elements. */\n"
18961 #: ../src/guestfs-structs.pod:223
18964 " void guestfs_free_inotify_event (struct guestfs_free_inotify_event *);\n"
18965 " void guestfs_free_inotify_event_list (struct guestfs_free_inotify_event_list *);\n"
18970 #: ../src/guestfs-structs.pod:226
18971 msgid "guestfs_partition"
18975 #: ../src/guestfs-structs.pod:228
18978 " struct guestfs_partition {\n"
18979 " int32_t part_num;\n"
18980 " uint64_t part_start;\n"
18981 " uint64_t part_end;\n"
18982 " uint64_t part_size;\n"
18988 #: ../src/guestfs-structs.pod:235
18991 " struct guestfs_partition_list {\n"
18992 " uint32_t len; /* Number of elements in list. */\n"
18993 " struct guestfs_partition *val; /* Elements. */\n"
18999 #: ../src/guestfs-structs.pod:240
19002 " void guestfs_free_partition (struct guestfs_free_partition *);\n"
19003 " void guestfs_free_partition_list (struct guestfs_free_partition_list *);\n"
19008 #: ../src/guestfs-structs.pod:243
19009 msgid "guestfs_application"
19013 #: ../src/guestfs-structs.pod:245
19016 " struct guestfs_application {\n"
19017 " char *app_name;\n"
19018 " char *app_display_name;\n"
19019 " int32_t app_epoch;\n"
19020 " char *app_version;\n"
19021 " char *app_release;\n"
19022 " char *app_install_path;\n"
19023 " char *app_trans_path;\n"
19024 " char *app_publisher;\n"
19025 " char *app_url;\n"
19026 " char *app_source_package;\n"
19027 " char *app_summary;\n"
19028 " char *app_description;\n"
19034 #: ../src/guestfs-structs.pod:260
19037 " struct guestfs_application_list {\n"
19038 " uint32_t len; /* Number of elements in list. */\n"
19039 " struct guestfs_application *val; /* Elements. */\n"
19045 #: ../src/guestfs-structs.pod:265
19048 " void guestfs_free_application (struct guestfs_free_application *);\n"
19049 " void guestfs_free_application_list (struct guestfs_free_application_list *);\n"
19054 #: ../fish/guestfish.pod:5
19055 msgid "guestfish - the libguestfs Filesystem Interactive SHell"
19059 #: ../fish/guestfish.pod:9
19062 " guestfish [--options] [commands]\n"
19067 #: ../fish/guestfish.pod:11
19075 #: ../fish/guestfish.pod:13
19078 " guestfish [--ro|--rw] -a disk.img\n"
19083 #: ../fish/guestfish.pod:15
19086 " guestfish [--ro|--rw] -a disk.img -m dev[:mountpoint]\n"
19091 #: ../fish/guestfish.pod:17
19094 " guestfish -d libvirt-domain\n"
19099 #: ../fish/guestfish.pod:19
19102 " guestfish [--ro|--rw] -a disk.img -i\n"
19107 #: ../fish/guestfish.pod:21
19110 " guestfish -d libvirt-domain -i\n"
19115 #: ../fish/guestfish.pod:23 ../fuse/guestmount.pod:15 ../tools/virt-edit.pl:44
19116 #: ../tools/virt-win-reg.pl:51 ../tools/virt-tar.pl:64
19121 #: ../fish/guestfish.pod:25
19123 "Using guestfish in read/write mode on live virtual machines can be "
19124 "dangerous, potentially causing disk corruption. Use the I<--ro> (read-only) "
19125 "option to use guestfish safely if the disk image or virtual machine might be "
19130 #: ../fish/guestfish.pod:32
19132 "Guestfish is a shell and command-line tool for examining and modifying "
19133 "virtual machine filesystems. It uses libguestfs and exposes all of the "
19134 "functionality of the guestfs API, see L<guestfs(3)>."
19138 #: ../fish/guestfish.pod:36
19140 "Guestfish gives you structured access to the libguestfs API, from shell "
19141 "scripts or the command line or interactively. If you want to rescue a "
19142 "broken virtual machine image, you should look at the L<virt-rescue(1)> "
19147 #: ../fish/guestfish.pod:41 ../fish/guestfish.pod:947
19148 #: ../fuse/guestmount.pod:39 ../tools/virt-edit.pl:63 ../tools/virt-tar.pl:50
19153 #: ../fish/guestfish.pod:43
19154 msgid "As an interactive shell"
19158 #: ../fish/guestfish.pod:45
19166 #: ../fish/guestfish.pod:47
19169 " Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
19170 " editing virtual machine filesystems.\n"
19175 #: ../fish/guestfish.pod:50
19178 " Type: 'help' for a list of commands\n"
19179 " 'man' to read the manual\n"
19180 " 'quit' to quit the shell\n"
19185 #: ../fish/guestfish.pod:54
19188 " ><fs> add-ro disk.img\n"
19190 " ><fs> list-filesystems\n"
19191 " /dev/sda1: ext4\n"
19192 " /dev/vg_guest/lv_root: ext4\n"
19193 " /dev/vg_guest/lv_swap: swap\n"
19194 " ><fs> mount /dev/vg_guest/lv_root /\n"
19195 " ><fs> cat /etc/fstab\n"
19197 " # Created by anaconda\n"
19204 #: ../fish/guestfish.pod:67
19205 msgid "From shell scripts"
19209 #: ../fish/guestfish.pod:69
19210 msgid "Create a new C</etc/motd> file in a guest or disk image:"
19214 #: ../fish/guestfish.pod:71
19217 " guestfish <<_EOF_\n"
19220 " mount /dev/vg_guest/lv_root /\n"
19221 " write /etc/motd \"Welcome, new users\"\n"
19227 #: ../fish/guestfish.pod:78
19228 msgid "List the LVM logical volumes in a disk image:"
19232 #: ../fish/guestfish.pod:80
19235 " guestfish -a disk.img --ro <<_EOF_\n"
19243 #: ../fish/guestfish.pod:85
19244 msgid "List all the filesystems in a disk image:"
19248 #: ../fish/guestfish.pod:87
19251 " guestfish -a disk.img --ro <<_EOF_\n"
19253 " list-filesystems\n"
19259 #: ../fish/guestfish.pod:92
19260 msgid "On one command line"
19264 #: ../fish/guestfish.pod:94
19265 msgid "Update C</etc/resolv.conf> in a guest:"
19269 #: ../fish/guestfish.pod:96
19273 " add disk.img : run : mount /dev/vg_guest/lv_root / : \\\n"
19274 " write /etc/resolv.conf \"nameserver 1.2.3.4\"\n"
19279 #: ../fish/guestfish.pod:100
19280 msgid "Edit C</boot/grub/grub.conf> interactively:"
19284 #: ../fish/guestfish.pod:102
19287 " guestfish --rw --add disk.img \\\n"
19288 " --mount /dev/vg_guest/lv_root \\\n"
19289 " --mount /dev/sda1:/boot \\\n"
19290 " edit /boot/grub/grub.conf\n"
19295 #: ../fish/guestfish.pod:107
19296 msgid "Mount disks automatically"
19300 #: ../fish/guestfish.pod:109
19302 "Use the I<-i> option to automatically mount the disks from a virtual machine:"
19306 #: ../fish/guestfish.pod:112
19309 " guestfish --ro -a disk.img -i cat /etc/group\n"
19314 #: ../fish/guestfish.pod:114
19317 " guestfish --ro -d libvirt-domain -i cat /etc/group\n"
19322 #: ../fish/guestfish.pod:116
19323 msgid "Another way to edit C</boot/grub/grub.conf> interactively is:"
19327 #: ../fish/guestfish.pod:118
19330 " guestfish --rw -a disk.img -i edit /boot/grub/grub.conf\n"
19335 #: ../fish/guestfish.pod:120
19336 msgid "As a script interpreter"
19340 #: ../fish/guestfish.pod:122
19341 msgid "Create a 100MB disk containing an ext2-formatted partition:"
19345 #: ../fish/guestfish.pod:124
19348 " #!/usr/bin/guestfish -f\n"
19349 " sparse test1.img 100M\n"
19351 " part-disk /dev/sda mbr\n"
19352 " mkfs ext2 /dev/sda1\n"
19357 #: ../fish/guestfish.pod:130
19358 msgid "Start with a prepared disk"
19362 #: ../fish/guestfish.pod:132
19364 "An alternate way to create a 100MB disk called C<test1.img> containing a "
19365 "single ext2-formatted partition:"
19369 #: ../fish/guestfish.pod:135
19372 " guestfish -N fs\n"
19377 #: ../fish/guestfish.pod:137
19378 msgid "To list what is available do:"
19382 #: ../fish/guestfish.pod:139 ../fish/guestfish.pod:938
19385 " guestfish -N help | less\n"
19390 #: ../fish/guestfish.pod:141
19391 msgid "Remote control"
19395 #: ../fish/guestfish.pod:143
19398 " eval \"`guestfish --listen`\"\n"
19399 " guestfish --remote add-ro disk.img\n"
19400 " guestfish --remote run\n"
19401 " guestfish --remote lvs\n"
19406 #: ../fish/guestfish.pod:148 ../test-tool/libguestfs-test-tool.pod:37
19407 #: ../fuse/guestmount.pod:73 ../tools/virt-edit.pl:81
19408 #: ../tools/virt-win-reg.pl:96 ../tools/virt-list-filesystems.pl:53
19409 #: ../tools/virt-tar.pl:103 ../tools/virt-make-fs.pl:153
19410 #: ../tools/virt-list-partitions.pl:54
19415 #: ../fish/guestfish.pod:152 ../fuse/guestmount.pod:131
19416 #: ../tools/virt-edit.pl:89 ../tools/virt-win-reg.pl:104
19417 #: ../tools/virt-list-filesystems.pl:61 ../tools/virt-tar.pl:111
19418 #: ../tools/virt-make-fs.pl:161 ../tools/virt-list-partitions.pl:62
19423 #: ../fish/guestfish.pod:154
19424 msgid "Displays general help on options."
19428 #: ../fish/guestfish.pod:156
19433 #: ../fish/guestfish.pod:158
19434 msgid "B<--cmd-help>"
19438 #: ../fish/guestfish.pod:160
19439 msgid "Lists all available guestfish commands."
19443 #: ../fish/guestfish.pod:162
19448 #: ../fish/guestfish.pod:164
19449 msgid "B<--cmd-help cmd>"
19453 #: ../fish/guestfish.pod:166
19454 msgid "Displays detailed help on a single command C<cmd>."
19458 #: ../fish/guestfish.pod:168
19459 msgid "B<-a image>"
19463 #: ../fish/guestfish.pod:170
19464 msgid "B<--add image>"
19468 #: ../fish/guestfish.pod:172
19469 msgid "Add a block device or virtual machine image to the shell."
19473 #: ../fish/guestfish.pod:174 ../fuse/guestmount.pod:81
19475 "The format of the disk image is auto-detected. To override this and force a "
19476 "particular format use the I<--format=..> option."
19480 #: ../fish/guestfish.pod:177
19482 "Using this flag is mostly equivalent to using the C<add> command, with "
19483 "C<readonly:true> if the I<--ro> flag was given, and with C<format:...> if "
19484 "the I<--format=...> flag was given."
19488 #: ../fish/guestfish.pod:181
19493 #: ../fish/guestfish.pod:183
19494 msgid "B<--connect URI>"
19498 #: ../fish/guestfish.pod:185 ../fuse/guestmount.pod:86
19500 "When used in conjunction with the I<-d> option, this specifies the libvirt "
19501 "URI to use. The default is to use the default libvirt connection."
19505 #: ../fish/guestfish.pod:189
19510 #: ../fish/guestfish.pod:191
19512 "If using the I<--listen> option and a csh-like shell, use this option. See "
19513 "section L</REMOTE CONTROL AND CSH> below."
19517 #: ../fish/guestfish.pod:194
19518 msgid "B<-d libvirt-domain>"
19522 #: ../fish/guestfish.pod:196
19523 msgid "B<--domain libvirt-domain>"
19527 #: ../fish/guestfish.pod:198 ../fuse/guestmount.pod:92
19529 "Add disks from the named libvirt domain. If the I<--ro> option is also "
19530 "used, then any libvirt domain can be used. However in write mode, only "
19531 "libvirt domains which are shut down can be named here."
19535 #: ../fish/guestfish.pod:202
19537 "Using this flag is mostly equivalent to using the C<add-domain> command, "
19538 "with C<readonly:true> if the I<--ro> flag was given, and with C<format:...> "
19539 "if the I<--format:...> flag was given."
19543 #: ../fish/guestfish.pod:206
19548 #: ../fish/guestfish.pod:208
19549 msgid "B<--no-dest-paths>"
19553 #: ../fish/guestfish.pod:210
19555 "Don't tab-complete paths on the guest filesystem. It is useful to be able "
19556 "to hit the tab key to complete paths on the guest filesystem, but this "
19557 "causes extra \"hidden\" guestfs calls to be made, so this option is here to "
19558 "allow this feature to be disabled."
19562 #: ../fish/guestfish.pod:215 ../fuse/guestmount.pod:108
19563 msgid "B<--echo-keys>"
19567 #: ../fish/guestfish.pod:217 ../fuse/guestmount.pod:110
19569 "When prompting for keys and passphrases, guestfish normally turns echoing "
19570 "off so you cannot see what you are typing. If you are not worried about "
19571 "Tempest attacks and there is no one else in the room you can specify this "
19572 "flag to see what you are typing."
19576 #: ../fish/guestfish.pod:222
19581 #: ../fish/guestfish.pod:224
19582 msgid "B<--file file>"
19586 #: ../fish/guestfish.pod:226
19587 msgid "Read commands from C<file>. To write pure guestfish scripts, use:"
19591 #: ../fish/guestfish.pod:229
19594 " #!/usr/bin/guestfish -f\n"
19599 #: ../fish/guestfish.pod:231
19600 msgid "B<--format=raw|qcow2|..>"
19604 #: ../fish/guestfish.pod:233
19605 msgid "B<--format>"
19609 #: ../fish/guestfish.pod:235 ../fuse/guestmount.pod:117
19611 "The default for the I<-a> option is to auto-detect the format of the disk "
19612 "image. Using this forces the disk format for I<-a> options which follow on "
19613 "the command line. Using I<--format> with no argument switches back to auto-"
19614 "detection for subsequent I<-a> options."
19618 #: ../fish/guestfish.pod:242
19621 " guestfish --format=raw -a disk.img\n"
19626 #: ../fish/guestfish.pod:244
19627 msgid "forces raw format (no auto-detection) for C<disk.img>."
19631 #: ../fish/guestfish.pod:246
19634 " guestfish --format=raw -a disk.img --format -a another.img\n"
19639 #: ../fish/guestfish.pod:248
19641 "forces raw format (no auto-detection) for C<disk.img> and reverts to auto-"
19642 "detection for C<another.img>."
19646 #: ../fish/guestfish.pod:251
19648 "If you have untrusted raw-format guest disk images, you should use this "
19649 "option to specify the disk format. This avoids a possible security problem "
19650 "with malicious guests (CVE-2010-3851). See also L</add-drive-opts>."
19654 #: ../fish/guestfish.pod:256
19659 #: ../fish/guestfish.pod:258
19660 msgid "B<--inspector>"
19664 #: ../fish/guestfish.pod:260 ../fuse/guestmount.pod:137
19666 "Using L<virt-inspector(1)> code, inspect the disks looking for an operating "
19667 "system and mount filesystems as they would be mounted on the real virtual "
19672 #: ../fish/guestfish.pod:264
19673 msgid "Typical usage is either:"
19677 #: ../fish/guestfish.pod:266
19680 " guestfish -d myguest -i\n"
19685 #: ../fish/guestfish.pod:268
19686 msgid "(for an inactive libvirt domain called I<myguest>), or:"
19690 #: ../fish/guestfish.pod:270
19693 " guestfish --ro -d myguest -i\n"
19698 #: ../fish/guestfish.pod:272
19699 msgid "(for active domains, readonly), or specify the block device directly:"
19703 #: ../fish/guestfish.pod:274
19706 " guestfish --rw -a /dev/Guests/MyGuest -i\n"
19711 #: ../fish/guestfish.pod:276
19713 "Note that the command line syntax changed slightly over older versions of "
19714 "guestfish. You can still use the old syntax:"
19718 #: ../fish/guestfish.pod:279
19721 " guestfish [--ro] -i disk.img\n"
19726 #: ../fish/guestfish.pod:281
19729 " guestfish [--ro] -i libvirt-domain\n"
19734 #: ../fish/guestfish.pod:283
19736 "Using this flag is mostly equivalent to using the C<inspect-os> command and "
19737 "then using other commands to mount the filesystems that were found."
19741 #: ../fish/guestfish.pod:287 ../fuse/guestmount.pod:141
19742 msgid "B<--keys-from-stdin>"
19746 #: ../fish/guestfish.pod:289 ../fuse/guestmount.pod:143
19748 "Read key or passphrase parameters from stdin. The default is to try to read "
19749 "passphrases from the user by opening C</dev/tty>."
19753 #: ../fish/guestfish.pod:292
19754 msgid "B<--listen>"
19758 #: ../fish/guestfish.pod:294
19760 "Fork into the background and listen for remote commands. See section L</"
19761 "REMOTE CONTROL GUESTFISH OVER A SOCKET> below."
19765 #: ../fish/guestfish.pod:297 ../fuse/guestmount.pod:146
19770 #: ../fish/guestfish.pod:299 ../fuse/guestmount.pod:148
19772 "Connect to a live virtual machine. (Experimental, see L<guestfs(3)/"
19773 "ATTACHING TO RUNNING DAEMONS>)."
19777 #: ../fish/guestfish.pod:302 ../fuse/guestmount.pod:151
19778 msgid "B<-m dev[:mountpoint[:options]]>"
19782 #: ../fish/guestfish.pod:304 ../fuse/guestmount.pod:153
19783 msgid "B<--mount dev[:mountpoint[:options]]>"
19787 #: ../fish/guestfish.pod:306
19788 msgid "Mount the named partition or logical volume on the given mountpoint."
19792 #: ../fish/guestfish.pod:308
19793 msgid "If the mountpoint is omitted, it defaults to C</>."
19797 #: ../fish/guestfish.pod:310
19798 msgid "You have to mount something on C</> before most commands will work."
19802 #: ../fish/guestfish.pod:312
19804 "If any I<-m> or I<--mount> options are given, the guest is automatically "
19809 #: ../fish/guestfish.pod:315
19811 "If you don't know what filesystems a disk image contains, you can either run "
19812 "guestfish without this option, then list the partitions, filesystems and LVs "
19813 "available (see L</list-partitions>, L</list-filesystems> and L</lvs> "
19814 "commands), or you can use the L<virt-filesystems(1)> program."
19818 #: ../fish/guestfish.pod:321 ../fuse/guestmount.pod:161
19820 "The third (and rarely used) part of the mount parameter is the list of mount "
19821 "options used to mount the underlying filesystem. If this is not given, then "
19822 "the mount options are either the empty string or C<ro> (the latter if the "
19823 "I<--ro> flag is used). By specifying the mount options, you override this "
19824 "default choice. Probably the only time you would use this is to enable ACLs "
19825 "and/or extended attributes if the filesystem can support them:"
19829 #: ../fish/guestfish.pod:329 ../fuse/guestmount.pod:169
19832 " -m /dev/sda1:/:acl,user_xattr\n"
19837 #: ../fish/guestfish.pod:331
19838 msgid "Using this flag is equivalent to using the C<mount-options> command."
19842 #: ../fish/guestfish.pod:333
19847 #: ../fish/guestfish.pod:335
19848 msgid "B<--no-sync>"
19852 #: ../fish/guestfish.pod:337
19854 "Disable autosync. This is enabled by default. See the discussion of "
19855 "autosync in the L<guestfs(3)> manpage."
19859 #: ../fish/guestfish.pod:340
19864 #: ../fish/guestfish.pod:342
19865 msgid "B<--new type>"
19869 #: ../fish/guestfish.pod:344
19874 #: ../fish/guestfish.pod:346
19876 "Prepare a fresh disk image formatted as \"type\". This is an alternative to "
19877 "the I<-a> option: whereas I<-a> adds an existing disk, I<-N> creates a "
19878 "preformatted disk with a filesystem and adds it. See L</PREPARED DISK "
19883 #: ../fish/guestfish.pod:351
19884 msgid "B<--progress-bars>"
19888 #: ../fish/guestfish.pod:353
19889 msgid "Enable progress bars, even when guestfish is used non-interactively."
19893 #: ../fish/guestfish.pod:355
19895 "Progress bars are enabled by default when guestfish is used as an "
19896 "interactive shell."
19900 #: ../fish/guestfish.pod:358
19901 msgid "B<--no-progress-bars>"
19905 #: ../fish/guestfish.pod:360
19906 msgid "Disable progress bars."
19910 #: ../fish/guestfish.pod:362
19911 msgid "B<--remote[=pid]>"
19915 #: ../fish/guestfish.pod:364
19917 "Send remote commands to C<$GUESTFISH_PID> or C<pid>. See section L</REMOTE "
19918 "CONTROL GUESTFISH OVER A SOCKET> below."
19922 #: ../fish/guestfish.pod:367
19927 #: ../fish/guestfish.pod:369
19932 #: ../fish/guestfish.pod:371
19934 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
19935 "mounts are done read-only."
19939 #: ../fish/guestfish.pod:374
19941 "The option must always be used if the disk image or virtual machine might be "
19942 "running, and is generally recommended in cases where you don't need write "
19943 "access to the disk."
19947 #: ../fish/guestfish.pod:378
19949 "Note that prepared disk images created with I<-N> are not affected by this "
19950 "option. Also commands like C<add> are not affected - you have to specify "
19951 "the C<readonly:true> option explicitly if you need it."
19955 #: ../fish/guestfish.pod:382
19956 msgid "See also L</OPENING DISKS FOR READ AND WRITE> below."
19960 #: ../fish/guestfish.pod:384 ../fuse/guestmount.pod:225
19961 msgid "B<--selinux>"
19965 #: ../fish/guestfish.pod:386
19966 msgid "Enable SELinux support for the guest. See L<guestfs(3)/SELINUX>."
19970 #: ../fish/guestfish.pod:388
19975 #: ../fish/guestfish.pod:390
19976 msgid "B<--verbose>"
19980 #: ../fish/guestfish.pod:392
19982 "Enable very verbose messages. This is particularly useful if you find a bug."
19986 #: ../fish/guestfish.pod:395
19991 #: ../fish/guestfish.pod:397 ../tools/virt-edit.pl:97
19992 #: ../tools/virt-win-reg.pl:112 ../tools/virt-list-filesystems.pl:69
19993 #: ../tools/virt-tar.pl:119 ../tools/virt-make-fs.pl:169
19994 #: ../tools/virt-list-partitions.pl:70
19995 msgid "B<--version>"
19999 #: ../fish/guestfish.pod:399
20000 msgid "Display the guestfish / libguestfs version number and exit."
20004 #: ../fish/guestfish.pod:401
20009 #: ../fish/guestfish.pod:403
20014 #: ../fish/guestfish.pod:405 ../fuse/guestmount.pod:239
20016 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
20017 "mounts are done read-write."
20021 #: ../fish/guestfish.pod:408
20022 msgid "See L</OPENING DISKS FOR READ AND WRITE> below."
20026 #: ../fish/guestfish.pod:410
20031 #: ../fish/guestfish.pod:412
20032 msgid "Echo each command before executing it."
20036 #: ../fish/guestfish.pod:416
20037 msgid "COMMANDS ON COMMAND LINE"
20041 #: ../fish/guestfish.pod:418
20043 "Any additional (non-option) arguments are treated as commands to execute."
20047 #: ../fish/guestfish.pod:421
20049 "Commands to execute should be separated by a colon (C<:>), where the colon "
20050 "is a separate parameter. Thus:"
20054 #: ../fish/guestfish.pod:424
20057 " guestfish cmd [args...] : cmd [args...] : cmd [args...] ...\n"
20062 #: ../fish/guestfish.pod:426
20064 "If there are no additional arguments, then we enter a shell, either an "
20065 "interactive shell with a prompt (if the input is a terminal) or a non-"
20066 "interactive shell."
20070 #: ../fish/guestfish.pod:430
20072 "In either command line mode or non-interactive shell, the first command that "
20073 "gives an error causes the whole shell to exit. In interactive mode (with a "
20074 "prompt) if a command fails, you can continue to enter commands."
20078 #: ../fish/guestfish.pod:435
20079 msgid "USING launch (OR run)"
20083 #: ../fish/guestfish.pod:437
20085 "As with L<guestfs(3)>, you must first configure your guest by adding disks, "
20086 "then launch it, then mount any disks you need, and finally issue actions/"
20087 "commands. So the general order of the day is:"
20091 #: ../fish/guestfish.pod:445
20092 msgid "add or -a/--add"
20096 #: ../fish/guestfish.pod:449
20097 msgid "launch (aka run)"
20101 #: ../fish/guestfish.pod:453
20102 msgid "mount or -m/--mount"
20106 #: ../fish/guestfish.pod:457
20107 msgid "any other commands"
20111 #: ../fish/guestfish.pod:461
20113 "C<run> is a synonym for C<launch>. You must C<launch> (or C<run>) your "
20114 "guest before mounting or performing any other commands."
20118 #: ../fish/guestfish.pod:464
20120 "The only exception is that if any of the I<-i>, I<-m>, I<--mount>, I<-N> or "
20121 "I<--new> options were given then C<run> is done automatically, simply "
20122 "because guestfish can't perform the action you asked for without doing this."
20126 #: ../fish/guestfish.pod:469
20127 msgid "OPENING DISKS FOR READ AND WRITE"
20131 #: ../fish/guestfish.pod:471
20133 "The guestfish, L<guestmount(1)> and L<virt-rescue(1)> options I<--ro> and "
20134 "I<--rw> affect whether the other command line options I<-a>, I<-c>, I<-d>, "
20135 "I<-i> and I<-m> open disk images read-only or for writing."
20139 #: ../fish/guestfish.pod:476
20141 "In libguestfs E<le> 1.10, guestfish, guestmount and virt-rescue defaulted to "
20142 "opening disk images supplied on the command line for write. To open a disk "
20143 "image read-only you have to do I<-a image --ro>."
20147 #: ../fish/guestfish.pod:480
20149 "This matters: If you accidentally open a live VM disk image writable then "
20150 "you will cause irreversible disk corruption."
20154 #: ../fish/guestfish.pod:483
20156 "By libguestfs 1.12 we intend to change the default the other way. Disk "
20157 "images will be opened read-only. You will have to either specify "
20158 "I<guestfish --rw>, I<guestmount --rw>, I<virt-rescue --rw>, or change the "
20159 "configuration file C</etc/libguestfs-tools.conf> in order to get write "
20160 "access for disk images specified by those other command line options."
20164 #: ../fish/guestfish.pod:490
20166 "This version of guestfish, guestmount and virt-rescue has a I<--rw> option "
20167 "which does nothing (it is already the default). However it is highly "
20168 "recommended that you use this option to indicate that you need write access, "
20169 "and prepare your scripts for the day when this option will be required for "
20174 #: ../fish/guestfish.pod:496
20176 "B<Note:> This does I<not> affect commands like L</add> and L</mount>, or any "
20177 "other libguestfs program apart from guestfish and guestmount."
20181 #: ../fish/guestfish.pod:499
20186 #: ../fish/guestfish.pod:501
20188 "You can quote ordinary parameters using either single or double quotes. For "
20193 #: ../fish/guestfish.pod:504
20196 " add \"file with a space.img\"\n"
20201 #: ../fish/guestfish.pod:506
20204 " rm '/file name'\n"
20209 #: ../fish/guestfish.pod:508
20217 #: ../fish/guestfish.pod:510
20219 "A few commands require a list of strings to be passed. For these, use a "
20220 "whitespace-separated list, enclosed in quotes. Strings containing "
20221 "whitespace to be passed through must be enclosed in single quotes. A "
20222 "literal single quote must be escaped with a backslash."
20226 #: ../fish/guestfish.pod:515
20229 " vgcreate VG \"/dev/sda1 /dev/sdb1\"\n"
20230 " command \"/bin/echo 'foo bar'\"\n"
20231 " command \"/bin/echo \\'foo\\'\"\n"
20236 #: ../fish/guestfish.pod:519
20237 msgid "OPTIONAL ARGUMENTS"
20241 #: ../fish/guestfish.pod:521
20243 "Some commands take optional arguments. These arguments appear in this "
20244 "documentation as C<[argname:..]>. You can use them as in these examples:"
20248 #: ../fish/guestfish.pod:525
20251 " add-drive-opts filename\n"
20256 #: ../fish/guestfish.pod:527
20259 " add-drive-opts filename readonly:true\n"
20264 #: ../fish/guestfish.pod:529
20267 " add-drive-opts filename format:qcow2 readonly:false\n"
20272 #: ../fish/guestfish.pod:531
20274 "Each optional argument can appear at most once. All optional arguments must "
20275 "appear after the required ones."
20279 #: ../fish/guestfish.pod:534
20284 #: ../fish/guestfish.pod:536
20286 "This section applies to all commands which can take integers as parameters."
20290 #: ../fish/guestfish.pod:539
20291 msgid "SIZE SUFFIX"
20295 #: ../fish/guestfish.pod:541
20297 "When the command takes a parameter measured in bytes, you can use one of the "
20298 "following suffixes to specify kilobytes, megabytes and larger sizes:"
20302 #: ../fish/guestfish.pod:547
20303 msgid "B<k> or B<K> or B<KiB>"
20307 #: ../fish/guestfish.pod:549
20308 msgid "The size in kilobytes (multiplied by 1024)."
20312 #: ../fish/guestfish.pod:551
20317 #: ../fish/guestfish.pod:553
20318 msgid "The size in SI 1000 byte units."
20322 #: ../fish/guestfish.pod:555
20323 msgid "B<M> or B<MiB>"
20327 #: ../fish/guestfish.pod:557
20328 msgid "The size in megabytes (multiplied by 1048576)."
20332 #: ../fish/guestfish.pod:559
20337 #: ../fish/guestfish.pod:561
20338 msgid "The size in SI 1000000 byte units."
20342 #: ../fish/guestfish.pod:563
20343 msgid "B<G> or B<GiB>"
20347 #: ../fish/guestfish.pod:565
20348 msgid "The size in gigabytes (multiplied by 2**30)."
20352 #: ../fish/guestfish.pod:567
20357 #: ../fish/guestfish.pod:569
20358 msgid "The size in SI 10**9 byte units."
20362 #: ../fish/guestfish.pod:571
20363 msgid "B<T> or B<TiB>"
20367 #: ../fish/guestfish.pod:573
20368 msgid "The size in terabytes (multiplied by 2**40)."
20372 #: ../fish/guestfish.pod:575
20377 #: ../fish/guestfish.pod:577
20378 msgid "The size in SI 10**12 byte units."
20382 #: ../fish/guestfish.pod:579
20383 msgid "B<P> or B<PiB>"
20387 #: ../fish/guestfish.pod:581
20388 msgid "The size in petabytes (multiplied by 2**50)."
20392 #: ../fish/guestfish.pod:583
20397 #: ../fish/guestfish.pod:585
20398 msgid "The size in SI 10**15 byte units."
20402 #: ../fish/guestfish.pod:587
20403 msgid "B<E> or B<EiB>"
20407 #: ../fish/guestfish.pod:589
20408 msgid "The size in exabytes (multiplied by 2**60)."
20412 #: ../fish/guestfish.pod:591
20417 #: ../fish/guestfish.pod:593
20418 msgid "The size in SI 10**18 byte units."
20422 #: ../fish/guestfish.pod:595
20423 msgid "B<Z> or B<ZiB>"
20427 #: ../fish/guestfish.pod:597
20428 msgid "The size in zettabytes (multiplied by 2**70)."
20432 #: ../fish/guestfish.pod:599
20437 #: ../fish/guestfish.pod:601
20438 msgid "The size in SI 10**21 byte units."
20442 #: ../fish/guestfish.pod:603
20443 msgid "B<Y> or B<YiB>"
20447 #: ../fish/guestfish.pod:605
20448 msgid "The size in yottabytes (multiplied by 2**80)."
20452 #: ../fish/guestfish.pod:607
20457 #: ../fish/guestfish.pod:609
20458 msgid "The size in SI 10**24 byte units."
20462 #: ../fish/guestfish.pod:615
20465 " truncate-size /file 1G\n"
20470 #: ../fish/guestfish.pod:617
20471 msgid "would truncate the file to 1 gigabyte."
20475 #: ../fish/guestfish.pod:619
20477 "Be careful because a few commands take sizes in kilobytes or megabytes (eg. "
20478 "the parameter to L</memsize> is specified in megabytes already). Adding a "
20479 "suffix will probably not do what you expect."
20483 #: ../fish/guestfish.pod:623
20484 msgid "OCTAL AND HEXADECIMAL NUMBERS"
20488 #: ../fish/guestfish.pod:625
20490 "For specifying the radix (base) use the C convention: C<0> to prefix an "
20491 "octal number or C<0x> to prefix a hexadecimal number. For example:"
20495 #: ../fish/guestfish.pod:628
20498 " 1234 decimal number 1234\n"
20499 " 02322 octal number, equivalent to decimal 1234\n"
20500 " 0x4d2 hexadecimal number, equivalent to decimal 1234\n"
20505 #: ../fish/guestfish.pod:632
20507 "When using the C<chmod> command, you almost always want to specify an octal "
20508 "number for the mode, and you must prefix it with C<0> (unlike the Unix "
20509 "L<chmod(1)> program):"
20513 #: ../fish/guestfish.pod:636
20516 " chmod 0777 /public # OK\n"
20517 " chmod 777 /public # WRONG! This is mode 777 decimal = 01411 octal.\n"
20522 #: ../fish/guestfish.pod:639
20524 "Commands that return numbers usually print them in decimal, but some "
20525 "commands print numbers in other radices (eg. C<umask> prints the mode in "
20526 "octal, preceeded by C<0>)."
20530 #: ../fish/guestfish.pod:643
20531 msgid "WILDCARDS AND GLOBBING"
20535 #: ../fish/guestfish.pod:645
20537 "Neither guestfish nor the underlying guestfs API performs wildcard expansion "
20538 "(globbing) by default. So for example the following will not do what you "
20543 #: ../fish/guestfish.pod:649
20551 #: ../fish/guestfish.pod:651
20553 "Assuming you don't have a directory called literally C</home/*> then the "
20554 "above command will return an error."
20558 #: ../fish/guestfish.pod:654
20559 msgid "To perform wildcard expansion, use the C<glob> command."
20563 #: ../fish/guestfish.pod:656
20566 " glob rm-rf /home/*\n"
20571 #: ../fish/guestfish.pod:658
20573 "runs C<rm-rf> on each path that matches (ie. potentially running the command "
20574 "many times), equivalent to:"
20578 #: ../fish/guestfish.pod:661
20581 " rm-rf /home/jim\n"
20582 " rm-rf /home/joe\n"
20583 " rm-rf /home/mary\n"
20588 #: ../fish/guestfish.pod:665
20589 msgid "C<glob> only works on simple guest paths and not on device names."
20593 #: ../fish/guestfish.pod:667
20595 "If you have several parameters, each containing a wildcard, then glob will "
20596 "perform a Cartesian product."
20600 #: ../fish/guestfish.pod:670
20605 #: ../fish/guestfish.pod:672
20607 "Any line which starts with a I<#> character is treated as a comment and "
20608 "ignored. The I<#> can optionally be preceeded by whitespace, but B<not> by "
20609 "a command. For example:"
20613 #: ../fish/guestfish.pod:676
20616 " # this is a comment\n"
20617 " # this is a comment\n"
20618 " foo # NOT a comment\n"
20623 #: ../fish/guestfish.pod:680
20624 msgid "Blank lines are also ignored."
20628 #: ../fish/guestfish.pod:682
20629 msgid "RUNNING COMMANDS LOCALLY"
20633 #: ../fish/guestfish.pod:684
20635 "Any line which starts with a I<!> character is treated as a command sent to "
20636 "the local shell (C</bin/sh> or whatever L<system(3)> uses). For example:"
20640 #: ../fish/guestfish.pod:688
20644 " tgz-out /remote local/remote-data.tar.gz\n"
20649 #: ../fish/guestfish.pod:691
20651 "will create a directory C<local> on the host, and then export the contents "
20652 "of C</remote> on the mounted filesystem to C<local/remote-data.tar.gz>. "
20653 "(See C<tgz-out>)."
20657 #: ../fish/guestfish.pod:695
20659 "To change the local directory, use the C<lcd> command. C<!cd> will have no "
20660 "effect, due to the way that subprocesses work in Unix."
20664 #: ../fish/guestfish.pod:698
20665 msgid "LOCAL COMMANDS WITH INLINE EXECUTION"
20669 #: ../fish/guestfish.pod:700
20671 "If a line starts with I<E<lt>!> then the shell command is executed (as for "
20672 "I<!>), but subsequently any output (stdout) of the shell command is parsed "
20673 "and executed as guestfish commands."
20677 #: ../fish/guestfish.pod:704
20679 "Thus you can use shell script to construct arbitrary guestfish commands "
20680 "which are then parsed by guestfish."
20684 #: ../fish/guestfish.pod:707
20686 "For example it is tedious to create a sequence of files (eg. C</foo.1> "
20687 "through C</foo.100>) using guestfish commands alone. However this is simple "
20688 "if we use a shell script to create the guestfish commands for us:"
20692 #: ../fish/guestfish.pod:712
20695 " <! for n in `seq 1 100`; do echo write /foo.$n $n; done\n"
20700 #: ../fish/guestfish.pod:714
20701 msgid "or with names like C</foo.001>:"
20705 #: ../fish/guestfish.pod:716
20708 " <! for n in `seq 1 100`; do printf \"write /foo.%03d %d\\n\" $n $n; done\n"
20713 #: ../fish/guestfish.pod:718
20715 "When using guestfish interactively it can be helpful to just run the shell "
20716 "script first (ie. remove the initial C<E<lt>> character so it is just an "
20717 "ordinary I<!> local command), see what guestfish commands it would run, and "
20718 "when you are happy with those prepend the C<E<lt>> character to run the "
20719 "guestfish commands for real."
20723 #: ../fish/guestfish.pod:724
20728 #: ../fish/guestfish.pod:726
20730 "Use C<command E<lt>spaceE<gt> | command> to pipe the output of the first "
20731 "command (a guestfish command) to the second command (any host command). For "
20736 #: ../fish/guestfish.pod:730
20739 " cat /etc/passwd | awk -F: '$3 == 0 { print }'\n"
20744 #: ../fish/guestfish.pod:732
20746 "(where C<cat> is the guestfish cat command, but C<awk> is the host awk "
20747 "program). The above command would list all accounts in the guest filesystem "
20748 "which have UID 0, ie. root accounts including backdoors. Other examples:"
20752 #: ../fish/guestfish.pod:737
20755 " hexdump /bin/ls | head\n"
20756 " list-devices | tail -1\n"
20757 " tgz-out / - | tar ztf -\n"
20762 #: ../fish/guestfish.pod:741
20764 "The space before the pipe symbol is required, any space after the pipe "
20765 "symbol is optional. Everything after the pipe symbol is just passed "
20766 "straight to the host shell, so it can contain redirections, globs and "
20767 "anything else that makes sense on the host side."
20771 #: ../fish/guestfish.pod:746
20773 "To use a literal argument which begins with a pipe symbol, you have to quote "
20778 #: ../fish/guestfish.pod:749
20786 #: ../fish/guestfish.pod:751
20787 msgid "HOME DIRECTORIES"
20791 #: ../fish/guestfish.pod:753
20793 "If a parameter starts with the character C<~> then the tilde may be expanded "
20794 "as a home directory path (either C<~> for the current user's home directory, "
20795 "or C<~user> for another user)."
20799 #: ../fish/guestfish.pod:757
20801 "Note that home directory expansion happens for users known I<on the host>, "
20802 "not in the guest filesystem."
20806 #: ../fish/guestfish.pod:760
20808 "To use a literal argument which begins with a tilde, you have to quote it, "
20813 #: ../fish/guestfish.pod:763
20821 #: ../fish/guestfish.pod:767
20823 "Libguestfs has some support for Linux guests encrypted according to the "
20824 "Linux Unified Key Setup (LUKS) standard, which includes nearly all whole "
20825 "disk encryption systems used by modern Linux guests. Currently only LVM-on-"
20826 "LUKS is supported."
20830 #: ../fish/guestfish.pod:772
20831 msgid "Identify encrypted block devices and partitions using L</vfs-type>:"
20835 #: ../fish/guestfish.pod:774
20838 " ><fs> vfs-type /dev/sda2\n"
20844 #: ../fish/guestfish.pod:777
20846 "Then open those devices using L</luks-open>. This creates a device-mapper "
20847 "device called C</dev/mapper/luksdev>."
20851 #: ../fish/guestfish.pod:780
20854 " ><fs> luks-open /dev/sda2 luksdev\n"
20855 " Enter key or passphrase (\"key\"): <enter the passphrase>\n"
20860 #: ../fish/guestfish.pod:783
20862 "Finally you have to tell LVM to scan for volume groups on the newly created "
20867 #: ../fish/guestfish.pod:786
20871 " vg-activate-all true\n"
20876 #: ../fish/guestfish.pod:789
20877 msgid "The logical volume(s) can now be mounted in the usual way."
20881 #: ../fish/guestfish.pod:791
20883 "Before closing a LUKS device you must unmount any logical volumes on it and "
20884 "deactivate the volume groups by calling C<vg-activate false VG> on each "
20885 "one. Then you can close the mapper device:"
20889 #: ../fish/guestfish.pod:795
20892 " vg-activate false /dev/VG\n"
20893 " luks-close /dev/mapper/luksdev\n"
20898 #: ../fish/guestfish.pod:798 ../tools/virt-edit.pl:342
20899 msgid "WINDOWS PATHS"
20903 #: ../fish/guestfish.pod:800
20905 "If a path is prefixed with C<win:> then you can use Windows-style drive "
20906 "letters and paths (with some limitations). The following commands are "
20911 #: ../fish/guestfish.pod:804
20914 " file /WINDOWS/system32/config/system.LOG\n"
20919 #: ../fish/guestfish.pod:806
20922 " file win:\\windows\\system32\\config\\system.log\n"
20927 #: ../fish/guestfish.pod:808
20930 " file WIN:C:\\Windows\\SYSTEM32\\CONFIG\\SYSTEM.LOG\n"
20935 #: ../fish/guestfish.pod:810
20937 "The parameter is rewritten \"behind the scenes\" by looking up the position "
20938 "where the drive is mounted, prepending that to the path, changing all "
20939 "backslash characters to forward slash, then resolving the result using L</"
20940 "case-sensitive-path>. For example if the E: drive was mounted on C</e> then "
20941 "the parameter might be rewritten like this:"
20945 #: ../fish/guestfish.pod:816
20948 " win:e:\\foo\\bar => /e/FOO/bar\n"
20953 #: ../fish/guestfish.pod:818
20954 msgid "This only works in argument positions that expect a path."
20958 #: ../fish/guestfish.pod:820
20959 msgid "UPLOADING AND DOWNLOADING FILES"
20963 #: ../fish/guestfish.pod:822
20965 "For commands such as C<upload>, C<download>, C<tar-in>, C<tar-out> and "
20966 "others which upload from or download to a local file, you can use the "
20967 "special filename C<-> to mean \"from stdin\" or \"to stdout\". For example:"
20971 #: ../fish/guestfish.pod:826
20979 #: ../fish/guestfish.pod:828
20981 "reads stdin and creates from that a file C</foo> in the disk image, and:"
20985 #: ../fish/guestfish.pod:831
20988 " tar-out /etc - | tar tf -\n"
20993 #: ../fish/guestfish.pod:833
20995 "writes the tarball to stdout and then pipes that into the external \"tar\" "
20996 "command (see L</PIPES>)."
21000 #: ../fish/guestfish.pod:836
21002 "When using C<-> to read from stdin, the input is read up to the end of "
21003 "stdin. You can also use a special \"heredoc\"-like syntax to read up to "
21004 "some arbitrary end marker:"
21008 #: ../fish/guestfish.pod:840
21011 " upload -<<END /foo\n"
21020 #: ../fish/guestfish.pod:846
21022 "Any string of characters can be used instead of C<END>. The end marker must "
21023 "appear on a line of its own, without any preceeding or following characters "
21024 "(not even spaces)."
21028 #: ../fish/guestfish.pod:850
21030 "Note that the C<-E<lt>E<lt>> syntax only applies to parameters used to "
21031 "upload local files (so-called \"FileIn\" parameters in the generator)."
21035 #: ../fish/guestfish.pod:853
21036 msgid "EXIT ON ERROR BEHAVIOUR"
21040 #: ../fish/guestfish.pod:855
21042 "By default, guestfish will ignore any errors when in interactive mode (ie. "
21043 "taking commands from a human over a tty), and will exit on the first error "
21044 "in non-interactive mode (scripts, commands given on the command line)."
21048 #: ../fish/guestfish.pod:860
21050 "If you prefix a command with a I<-> character, then that command will not "
21051 "cause guestfish to exit, even if that (one) command returns an error."
21055 #: ../fish/guestfish.pod:864
21056 msgid "REMOTE CONTROL GUESTFISH OVER A SOCKET"
21060 #: ../fish/guestfish.pod:866
21062 "Guestfish can be remote-controlled over a socket. This is useful "
21063 "particularly in shell scripts where you want to make several different "
21064 "changes to a filesystem, but you don't want the overhead of starting up a "
21065 "guestfish process each time."
21069 #: ../fish/guestfish.pod:871
21070 msgid "Start a guestfish server process using:"
21074 #: ../fish/guestfish.pod:873
21077 " eval \"`guestfish --listen`\"\n"
21082 #: ../fish/guestfish.pod:875
21083 msgid "and then send it commands by doing:"
21087 #: ../fish/guestfish.pod:877
21090 " guestfish --remote cmd [...]\n"
21095 #: ../fish/guestfish.pod:879
21096 msgid "To cause the server to exit, send it the exit command:"
21100 #: ../fish/guestfish.pod:881
21103 " guestfish --remote exit\n"
21108 #: ../fish/guestfish.pod:883
21110 "Note that the server will normally exit if there is an error in a command. "
21111 "You can change this in the usual way. See section L</EXIT ON ERROR "
21116 #: ../fish/guestfish.pod:887
21117 msgid "CONTROLLING MULTIPLE GUESTFISH PROCESSES"
21121 #: ../fish/guestfish.pod:889
21123 "The C<eval> statement sets the environment variable C<$GUESTFISH_PID>, which "
21124 "is how the I<--remote> option knows where to send the commands. You can "
21125 "have several guestfish listener processes running using:"
21129 #: ../fish/guestfish.pod:893
21132 " eval \"`guestfish --listen`\"\n"
21133 " pid1=$GUESTFISH_PID\n"
21134 " eval \"`guestfish --listen`\"\n"
21135 " pid2=$GUESTFISH_PID\n"
21137 " guestfish --remote=$pid1 cmd\n"
21138 " guestfish --remote=$pid2 cmd\n"
21143 #: ../fish/guestfish.pod:901
21144 msgid "REMOTE CONTROL AND CSH"
21148 #: ../fish/guestfish.pod:903
21150 "When using csh-like shells (csh, tcsh etc) you have to add the I<--csh> "
21155 #: ../fish/guestfish.pod:906
21158 " eval \"`guestfish --listen --csh`\"\n"
21163 #: ../fish/guestfish.pod:908
21164 msgid "REMOTE CONTROL DETAILS"
21168 #: ../fish/guestfish.pod:910
21170 "Remote control happens over a Unix domain socket called C</tmp/.guestfish-"
21171 "$UID/socket-$PID>, where C<$UID> is the effective user ID of the process, "
21172 "and C<$PID> is the process ID of the server."
21176 #: ../fish/guestfish.pod:914
21177 msgid "Guestfish client and server versions must match exactly."
21181 #: ../fish/guestfish.pod:916
21182 msgid "PREPARED DISK IMAGES"
21186 #: ../fish/guestfish.pod:918
21188 "Use the I<-N type> or I<--new type> parameter to select one of a set of "
21189 "preformatted disk images that guestfish can make for you to save typing. "
21190 "This is particularly useful for testing purposes. This option is used "
21191 "instead of the I<-a> option, and like I<-a> can appear multiple times (and "
21192 "can be mixed with I<-a>)."
21196 #: ../fish/guestfish.pod:924
21198 "The new disk is called C<test1.img> for the first I<-N>, C<test2.img> for "
21199 "the second and so on. Existing files in the current directory are "
21204 #: ../fish/guestfish.pod:928
21206 "The type briefly describes how the disk should be sized, partitioned, how "
21207 "filesystem(s) should be created, and how content should be added. "
21208 "Optionally the type can be followed by extra parameters, separated by C<:> "
21209 "(colon) characters. For example, I<-N fs> creates a default 100MB, sparsely-"
21210 "allocated disk, containing a single partition, with the partition formatted "
21211 "as ext2. I<-N fs:ext4:1G> is the same, but for an ext4 filesystem on a 1GB "
21216 #: ../fish/guestfish.pod:936
21217 msgid "To list the available types and any extra parameters they take, run:"
21221 #: ../fish/guestfish.pod:940
21223 "Note that the prepared filesystem is not mounted. You would usually have to "
21224 "use the C<mount /dev/sda1 /> command or add the I<-m /dev/sda1> option."
21228 #: ../fish/guestfish.pod:944
21230 "If any I<-N> or I<--new> options are given, the guest is automatically "
21235 #: ../fish/guestfish.pod:949
21236 msgid "Create a 100MB disk with an ext4-formatted partition:"
21240 #: ../fish/guestfish.pod:951
21243 " guestfish -N fs:ext4\n"
21248 #: ../fish/guestfish.pod:953
21249 msgid "Create a 32MB disk with a VFAT-formatted partition, and mount it:"
21253 #: ../fish/guestfish.pod:955
21256 " guestfish -N fs:vfat:32M -m /dev/sda1\n"
21261 #: ../fish/guestfish.pod:957
21262 msgid "Create a blank 200MB disk:"
21266 #: ../fish/guestfish.pod:959
21269 " guestfish -N disk:200M\n"
21274 #: ../fish/guestfish.pod:961
21275 msgid "PROGRESS BARS"
21279 #: ../fish/guestfish.pod:963
21281 "Some (not all) long-running commands send progress notification messages as "
21282 "they are running. Guestfish turns these messages into progress bars."
21286 #: ../fish/guestfish.pod:967
21288 "When a command that supports progress bars takes longer than two seconds to "
21289 "run, and if progress bars are enabled, then you will see one appearing below "
21294 #: ../fish/guestfish.pod:971
21297 " ><fs> copy-size /large-file /another-file 2048M\n"
21298 " / 10% [#####-----------------------------------------] 00:30\n"
21303 #: ../fish/guestfish.pod:974
21305 "The spinner on the left hand side moves round once for every progress "
21306 "notification received from the backend. This is a (reasonably) golden "
21307 "assurance that the command is \"doing something\" even if the progress bar "
21308 "is not moving, because the command is able to send the progress "
21309 "notifications. When the bar reaches 100% and the command finishes, the "
21310 "spinner disappears."
21314 #: ../fish/guestfish.pod:981
21316 "Progress bars are enabled by default when guestfish is used interactively. "
21317 "You can enable them even for non-interactive modes using I<--progress-bars>, "
21318 "and you can disable them completely using I<--no-progress-bars>."
21322 #: ../fish/guestfish.pod:986
21323 msgid "GUESTFISH COMMANDS"
21327 #: ../fish/guestfish.pod:988
21329 "The commands in this section are guestfish convenience commands, in other "
21330 "words, they are not part of the L<guestfs(3)> API."
21334 #: ../fish/guestfish.pod:991
21339 #: ../fish/guestfish.pod:993
21348 #: ../fish/guestfish.pod:996
21349 msgid "Without any parameter, this provides general help."
21353 #: ../fish/guestfish.pod:998
21354 msgid "With a C<cmd> parameter, this displays detailed help for that command."
21358 #: ../fish/guestfish.pod:1000
21359 msgid "quit | exit"
21363 #: ../fish/guestfish.pod:1002
21364 msgid "This exits guestfish. You can also use C<^D> key."
21368 #: ../fish/guestfish.pod:1004
21369 msgid "@FISH_COMMANDS@"
21373 #: ../fish/guestfish.pod:1006
21378 #: ../fish/guestfish.pod:1010 ../test-tool/libguestfs-test-tool.pod:77
21383 #: ../fish/guestfish.pod:1012
21385 "guestfish returns 0 if the commands completed without error, or 1 if there "
21390 #: ../fish/guestfish.pod:1019
21395 #: ../fish/guestfish.pod:1021
21397 "The C<edit> command uses C<$EDITOR> as the editor. If not set, it uses "
21402 #: ../fish/guestfish.pod:1024
21403 msgid "GUESTFISH_PID"
21407 #: ../fish/guestfish.pod:1026
21409 "Used with the I<--remote> option to specify the remote guestfish process to "
21410 "control. See section L</REMOTE CONTROL GUESTFISH OVER A SOCKET>."
21414 #: ../fish/guestfish.pod:1030
21419 #: ../fish/guestfish.pod:1032
21421 "The L</hexedit> command uses C<$HEXEDITOR> as the external hex editor. If "
21422 "not specified, the external L<hexedit(1)> program is used."
21426 #: ../fish/guestfish.pod:1036
21431 #: ../fish/guestfish.pod:1038
21433 "If compiled with GNU readline support, various files in the home directory "
21434 "can be used. See L</FILES>."
21438 #: ../fish/guestfish.pod:1047
21440 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
21441 "effect as using the B<-v> option."
21445 #: ../fish/guestfish.pod:1059
21447 "Set the path that guestfish uses to search for kernel and initrd.img. See "
21448 "the discussion of paths in L<guestfs(3)>."
21452 #: ../fish/guestfish.pod:1070
21453 msgid "Set C<LIBGUESTFS_TRACE=1> to enable command traces."
21457 #: ../fish/guestfish.pod:1072
21462 #: ../fish/guestfish.pod:1074
21464 "The C<more> command uses C<$PAGER> as the pager. If not set, it uses "
21469 #: ../fish/guestfish.pod:1090 ../fuse/guestmount.pod:252
21474 #: ../fish/guestfish.pod:1094 ../fuse/guestmount.pod:256
21475 msgid "$HOME/.libguestfs-tools.rc"
21479 #: ../fish/guestfish.pod:1096 ../fuse/guestmount.pod:258
21480 msgid "/etc/libguestfs-tools.conf"
21484 #: ../fish/guestfish.pod:1098 ../fuse/guestmount.pod:260
21486 "This configuration file controls the default read-only or read-write mode "
21487 "(I<--ro> or I<--rw>)."
21491 #: ../fish/guestfish.pod:1101
21492 msgid "See L</OPENING DISKS FOR READ AND WRITE>."
21496 #: ../fish/guestfish.pod:1103
21497 msgid "$HOME/.guestfish"
21501 #: ../fish/guestfish.pod:1105
21503 "If compiled with GNU readline support, then the command history is saved in "
21508 #: ../fish/guestfish.pod:1108
21509 msgid "$HOME/.inputrc"
21513 #: ../fish/guestfish.pod:1110
21514 msgid "/etc/inputrc"
21518 #: ../fish/guestfish.pod:1112
21520 "If compiled with GNU readline support, then these files can be used to "
21521 "configure readline. For further information, please see L<readline(3)/"
21522 "INITIALIZATION FILE>."
21526 #: ../fish/guestfish.pod:1116
21527 msgid "To write rules which only apply to guestfish, use:"
21531 #: ../fish/guestfish.pod:1118
21541 #: ../fish/guestfish.pod:1122
21543 "Variables that you can set in inputrc that change the behaviour of guestfish "
21544 "in useful ways include:"
21548 #: ../fish/guestfish.pod:1127
21549 msgid "completion-ignore-case (default: on)"
21553 #: ../fish/guestfish.pod:1129
21555 "By default, guestfish will ignore case when tab-completing paths on the "
21560 #: ../fish/guestfish.pod:1132
21563 " set completion-ignore-case off\n"
21568 #: ../fish/guestfish.pod:1134
21569 msgid "to make guestfish case sensitive."
21573 #: ../fish/guestfish.pod:1138
21578 #: ../fish/guestfish.pod:1140
21579 msgid "test2.img (etc)"
21583 #: ../fish/guestfish.pod:1142
21585 "When using the C<-N> or C<--new> option, the prepared disk or filesystem "
21586 "will be created in the file C<test1.img> in the current directory. The "
21587 "second use of C<-N> will use C<test2.img> and so on. Any existing file with "
21588 "the same name will be overwritten."
21592 #: ../fish/guestfish.pod:1151
21594 "L<guestfs(3)>, L<http://libguestfs.org/>, L<virt-cat(1)>, L<virt-copy-in(1)"
21595 ">, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, L<virt-filesystems(1)"
21596 ">, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, L<virt-list-partitions"
21597 "(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, L<virt-rescue(1)>, L<virt-resize(1)"
21598 ">, L<virt-tar(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<virt-win-reg(1)"
21599 ">, L<hexedit(1)>."
21603 #: ../fish/guestfish.pod:1181 ../test-tool/libguestfs-test-tool.pod:102
21604 #: ../fuse/guestmount.pod:287 ../tools/virt-edit.pl:518
21605 #: ../tools/virt-win-reg.pl:606 ../tools/virt-list-filesystems.pl:210
21606 #: ../tools/virt-tar.pl:309 ../tools/virt-make-fs.pl:572
21607 #: ../tools/virt-list-partitions.pl:277
21609 "This program is free software; you can redistribute it and/or modify it "
21610 "under the terms of the GNU General Public License as published by the Free "
21611 "Software Foundation; either version 2 of the License, or (at your option) "
21612 "any later version."
21616 #: ../fish/guestfish.pod:1186 ../test-tool/libguestfs-test-tool.pod:107
21617 #: ../fuse/guestmount.pod:292 ../tools/virt-edit.pl:523
21618 #: ../tools/virt-win-reg.pl:611 ../tools/virt-list-filesystems.pl:215
21619 #: ../tools/virt-tar.pl:314 ../tools/virt-make-fs.pl:577
21620 #: ../tools/virt-list-partitions.pl:282
21622 "This program is distributed in the hope that it will be useful, but WITHOUT "
21623 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
21624 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for "
21629 #: ../fish/guestfish.pod:1191 ../test-tool/libguestfs-test-tool.pod:112
21630 #: ../fuse/guestmount.pod:297 ../tools/virt-edit.pl:528
21631 #: ../tools/virt-win-reg.pl:616 ../tools/virt-list-filesystems.pl:220
21632 #: ../tools/virt-tar.pl:319 ../tools/virt-make-fs.pl:582
21633 #: ../tools/virt-list-partitions.pl:287
21635 "You should have received a copy of the GNU General Public License along with "
21636 "this program; if not, write to the Free Software Foundation, Inc., 675 Mass "
21637 "Ave, Cambridge, MA 02139, USA."
21641 #: ../fish/guestfish-actions.pod:1
21646 #: ../fish/guestfish-actions.pod:3
21649 " add-cdrom filename\n"
21654 #: ../fish/guestfish-actions.pod:15
21656 "This call checks for the existence of C<filename>. This stops you from "
21657 "specifying other types of drive which are supported by qemu such as C<nbd:> "
21658 "and C<http:> URLs. To specify those, use the general L</config> call "
21663 #: ../fish/guestfish-actions.pod:22
21665 "If you just want to add an ISO file (often you use this as an efficient way "
21666 "to transfer large files into the guest), then you should probably use L</add-"
21667 "drive-ro> instead."
21671 #: ../fish/guestfish-actions.pod:35
21676 #: ../fish/guestfish-actions.pod:37
21681 #: ../fish/guestfish-actions.pod:39
21684 " add-domain dom [libvirturi:..] [readonly:..] [iface:..] [live:..]\n"
21689 #: ../fish/guestfish-actions.pod:41
21691 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
21692 "It works by connecting to libvirt, requesting the domain and domain XML from "
21693 "libvirt, parsing it for disks, and calling L</add-drive-opts> on each one."
21697 #: ../fish/guestfish-actions.pod:71
21699 "The other optional parameters are passed directly through to L</add-drive-"
21704 #: ../fish/guestfish-actions.pod:74 ../fish/guestfish-actions.pod:138
21705 #: ../fish/guestfish-actions.pod:3047
21707 "This command has one or more optional arguments. See L</OPTIONAL ARGUMENTS>."
21711 #: ../fish/guestfish-actions.pod:76
21716 #: ../fish/guestfish-actions.pod:78
21719 " add-drive filename\n"
21724 #: ../fish/guestfish-actions.pod:80
21726 "This function is the equivalent of calling L</add-drive-opts> with no "
21727 "optional parameters, so the disk is added writable, with the format being "
21728 "detected automatically."
21732 #: ../fish/guestfish-actions.pod:84
21734 "Automatic detection of the format opens you up to a potential security hole "
21735 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
21736 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
21737 "you should think about replacing calls to this function with calls to L</add-"
21738 "drive-opts>, and specifying the format."
21742 #: ../fish/guestfish-actions.pod:91
21743 msgid "add-drive-opts"
21747 #: ../fish/guestfish-actions.pod:93
21752 #: ../fish/guestfish-actions.pod:95
21755 " add-drive-opts filename [readonly:..] [format:..] [iface:..]\n"
21760 #: ../fish/guestfish-actions.pod:122
21762 "This forces the image format. If you omit this (or use L</add-drive> or L</"
21763 "add-drive-ro>) then the format is automatically detected. Possible formats "
21764 "include C<raw> and C<qcow2>."
21768 #: ../fish/guestfish-actions.pod:133
21770 "This rarely-used option lets you emulate the behaviour of the deprecated L</"
21771 "add-drive-with-if> call (q.v.)"
21775 #: ../fish/guestfish-actions.pod:140
21776 msgid "add-drive-ro"
21780 #: ../fish/guestfish-actions.pod:142
21785 #: ../fish/guestfish-actions.pod:144
21788 " add-drive-ro filename\n"
21793 #: ../fish/guestfish-actions.pod:146
21795 "This function is the equivalent of calling L</add-drive-opts> with the "
21796 "optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the disk "
21797 "is added read-only, with the format being detected automatically."
21801 #: ../fish/guestfish-actions.pod:151
21802 msgid "add-drive-ro-with-if"
21806 #: ../fish/guestfish-actions.pod:153
21809 " add-drive-ro-with-if filename iface\n"
21814 #: ../fish/guestfish-actions.pod:155
21816 "This is the same as L</add-drive-ro> but it allows you to specify the QEMU "
21817 "interface emulation to use at run time."
21821 #: ../fish/guestfish-actions.pod:165
21822 msgid "add-drive-with-if"
21826 #: ../fish/guestfish-actions.pod:167
21829 " add-drive-with-if filename iface\n"
21834 #: ../fish/guestfish-actions.pod:169
21836 "This is the same as L</add-drive> but it allows you to specify the QEMU "
21837 "interface emulation to use at run time."
21841 #: ../fish/guestfish-actions.pod:179
21846 #: ../fish/guestfish-actions.pod:181
21849 " aug-clear augpath\n"
21854 #: ../fish/guestfish-actions.pod:186
21859 #: ../fish/guestfish-actions.pod:188
21867 #: ../fish/guestfish-actions.pod:190
21869 "Close the current Augeas handle and free up any resources used by it. After "
21870 "calling this, you have to call L</aug-init> again before you can use any "
21871 "other Augeas functions."
21875 #: ../fish/guestfish-actions.pod:195
21876 msgid "aug-defnode"
21880 #: ../fish/guestfish-actions.pod:197
21883 " aug-defnode name expr val\n"
21888 #: ../fish/guestfish-actions.pod:202
21890 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
21891 "calling L</aug-set> C<expr>, C<value>. C<name> will be the nodeset "
21892 "containing that single node."
21896 #: ../fish/guestfish-actions.pod:210
21901 #: ../fish/guestfish-actions.pod:212
21904 " aug-defvar name expr\n"
21909 #: ../fish/guestfish-actions.pod:221
21914 #: ../fish/guestfish-actions.pod:223
21917 " aug-get augpath\n"
21922 #: ../fish/guestfish-actions.pod:228
21927 #: ../fish/guestfish-actions.pod:230
21930 " aug-init root flags\n"
21935 #: ../fish/guestfish-actions.pod:236
21936 msgid "You must call this before using any other L</aug-*> commands."
21940 #: ../fish/guestfish-actions.pod:271
21941 msgid "Do not load the tree in L</aug-init>."
21945 #: ../fish/guestfish-actions.pod:275
21946 msgid "To close the handle, you can call L</aug-close>."
21950 #: ../fish/guestfish-actions.pod:279
21955 #: ../fish/guestfish-actions.pod:281
21958 " aug-insert augpath label true|false\n"
21963 #: ../fish/guestfish-actions.pod:291
21968 #: ../fish/guestfish-actions.pod:293
21976 #: ../fish/guestfish-actions.pod:300
21981 #: ../fish/guestfish-actions.pod:302
21984 " aug-ls augpath\n"
21989 #: ../fish/guestfish-actions.pod:304
21991 "This is just a shortcut for listing L</aug-match> C<path/*> and sorting the "
21992 "resulting nodes into alphabetical order."
21996 #: ../fish/guestfish-actions.pod:307
22001 #: ../fish/guestfish-actions.pod:309
22004 " aug-match augpath\n"
22009 #: ../fish/guestfish-actions.pod:315
22014 #: ../fish/guestfish-actions.pod:317
22017 " aug-mv src dest\n"
22022 #: ../fish/guestfish-actions.pod:322
22027 #: ../fish/guestfish-actions.pod:324
22030 " aug-rm augpath\n"
22035 #: ../fish/guestfish-actions.pod:330
22040 #: ../fish/guestfish-actions.pod:332
22048 #: ../fish/guestfish-actions.pod:336
22050 "The flags which were passed to L</aug-init> affect exactly how files are "
22055 #: ../fish/guestfish-actions.pod:339
22060 #: ../fish/guestfish-actions.pod:341
22063 " aug-set augpath val\n"
22068 #: ../fish/guestfish-actions.pod:345
22070 "In the Augeas API, it is possible to clear a node by setting the value to "
22071 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
22072 "this call. Instead you must use the L</aug-clear> call."
22076 #: ../fish/guestfish-actions.pod:350
22081 #: ../fish/guestfish-actions.pod:352
22084 " available 'groups ...'\n"
22089 #: ../fish/guestfish-actions.pod:358
22091 "The libguestfs groups, and the functions that those groups correspond to, "
22092 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
22093 "runtime by calling L</available-all-groups>."
22097 #: ../fish/guestfish-actions.pod:382
22098 msgid "You must call L</launch> before calling this function."
22102 #: ../fish/guestfish-actions.pod:404
22104 "This call was added in version C<1.0.80>. In previous versions of "
22105 "libguestfs all you could do would be to speculatively execute a command to "
22106 "find out if the daemon implemented it. See also L</version>."
22110 #: ../fish/guestfish-actions.pod:411
22111 msgid "available-all-groups"
22115 #: ../fish/guestfish-actions.pod:413
22118 " available-all-groups\n"
22123 #: ../fish/guestfish-actions.pod:415
22125 "This command returns a list of all optional groups that this daemon knows "
22126 "about. Note this returns both supported and unsupported groups. To find "
22127 "out which ones the daemon can actually support you have to call L</"
22128 "available> on each member of the returned list."
22132 #: ../fish/guestfish-actions.pod:421
22133 msgid "See also L</available> and L<guestfs(3)/AVAILABILITY>."
22137 #: ../fish/guestfish-actions.pod:423
22142 #: ../fish/guestfish-actions.pod:425
22145 " base64-in (base64file|-) filename\n"
22150 #: ../fish/guestfish-actions.pod:430 ../fish/guestfish-actions.pod:439
22151 #: ../fish/guestfish-actions.pod:663 ../fish/guestfish-actions.pod:832
22152 #: ../fish/guestfish-actions.pod:851 ../fish/guestfish-actions.pod:1228
22153 #: ../fish/guestfish-actions.pod:4445 ../fish/guestfish-actions.pod:4457
22154 #: ../fish/guestfish-actions.pod:4468 ../fish/guestfish-actions.pod:4479
22155 #: ../fish/guestfish-actions.pod:4531 ../fish/guestfish-actions.pod:4540
22156 #: ../fish/guestfish-actions.pod:4594 ../fish/guestfish-actions.pod:4617
22157 msgid "Use C<-> instead of a filename to read/write from stdin/stdout."
22161 #: ../fish/guestfish-actions.pod:432
22166 #: ../fish/guestfish-actions.pod:434
22169 " base64-out filename (base64file|-)\n"
22174 #: ../fish/guestfish-actions.pod:441
22175 msgid "blockdev-flushbufs"
22179 #: ../fish/guestfish-actions.pod:443
22182 " blockdev-flushbufs device\n"
22187 #: ../fish/guestfish-actions.pod:450
22188 msgid "blockdev-getbsz"
22192 #: ../fish/guestfish-actions.pod:452
22195 " blockdev-getbsz device\n"
22200 #: ../fish/guestfish-actions.pod:461
22201 msgid "blockdev-getro"
22205 #: ../fish/guestfish-actions.pod:463
22208 " blockdev-getro device\n"
22213 #: ../fish/guestfish-actions.pod:470
22214 msgid "blockdev-getsize64"
22218 #: ../fish/guestfish-actions.pod:472
22221 " blockdev-getsize64 device\n"
22226 #: ../fish/guestfish-actions.pod:476
22227 msgid "See also L</blockdev-getsz>."
22231 #: ../fish/guestfish-actions.pod:480
22232 msgid "blockdev-getss"
22236 #: ../fish/guestfish-actions.pod:482
22239 " blockdev-getss device\n"
22244 #: ../fish/guestfish-actions.pod:487
22246 "(Note, this is not the size in sectors, use L</blockdev-getsz> for that)."
22250 #: ../fish/guestfish-actions.pod:492
22251 msgid "blockdev-getsz"
22255 #: ../fish/guestfish-actions.pod:494
22258 " blockdev-getsz device\n"
22263 #: ../fish/guestfish-actions.pod:499
22265 "See also L</blockdev-getss> for the real sector size of the device, and L</"
22266 "blockdev-getsize64> for the more useful I<size in bytes>."
22270 #: ../fish/guestfish-actions.pod:505
22271 msgid "blockdev-rereadpt"
22275 #: ../fish/guestfish-actions.pod:507
22278 " blockdev-rereadpt device\n"
22283 #: ../fish/guestfish-actions.pod:513
22284 msgid "blockdev-setbsz"
22288 #: ../fish/guestfish-actions.pod:515
22291 " blockdev-setbsz device blocksize\n"
22296 #: ../fish/guestfish-actions.pod:524
22297 msgid "blockdev-setro"
22301 #: ../fish/guestfish-actions.pod:526
22304 " blockdev-setro device\n"
22309 #: ../fish/guestfish-actions.pod:532
22310 msgid "blockdev-setrw"
22314 #: ../fish/guestfish-actions.pod:534
22317 " blockdev-setrw device\n"
22322 #: ../fish/guestfish-actions.pod:540
22323 msgid "case-sensitive-path"
22327 #: ../fish/guestfish-actions.pod:542
22330 " case-sensitive-path path\n"
22335 #: ../fish/guestfish-actions.pod:566
22337 "Thus L</case-sensitive-path> (\"/Windows/System32\") might return C<\"/"
22338 "WINDOWS/system32\"> (the exact return value would depend on details of how "
22339 "the directories were originally created under Windows)."
22343 #: ../fish/guestfish-actions.pod:574
22344 msgid "See also L</realpath>."
22348 #: ../fish/guestfish-actions.pod:576
22353 #: ../fish/guestfish-actions.pod:578
22361 #: ../fish/guestfish-actions.pod:582
22363 "Note that this function cannot correctly handle binary files (specifically, "
22364 "files containing C<\\0> character which is treated as end of string). For "
22365 "those you need to use the L</read-file> or L</download> functions which have "
22366 "a more complex interface."
22370 #: ../fish/guestfish-actions.pod:590
22375 #: ../fish/guestfish-actions.pod:592
22378 " checksum csumtype path\n"
22383 #: ../fish/guestfish-actions.pod:635
22384 msgid "To get the checksum for a device, use L</checksum-device>."
22388 #: ../fish/guestfish-actions.pod:637
22389 msgid "To get the checksums for many files, use L</checksums-out>."
22393 #: ../fish/guestfish-actions.pod:639
22394 msgid "checksum-device"
22398 #: ../fish/guestfish-actions.pod:641
22401 " checksum-device csumtype device\n"
22406 #: ../fish/guestfish-actions.pod:643
22408 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
22409 "device named C<device>. For the types of checksums supported see the L</"
22410 "checksum> command."
22414 #: ../fish/guestfish-actions.pod:647
22415 msgid "checksums-out"
22419 #: ../fish/guestfish-actions.pod:649
22422 " checksums-out csumtype directory (sumsfile|-)\n"
22427 #: ../fish/guestfish-actions.pod:665
22432 #: ../fish/guestfish-actions.pod:667
22435 " chmod mode path\n"
22440 #: ../fish/guestfish-actions.pod:678
22445 #: ../fish/guestfish-actions.pod:680
22448 " chown owner group path\n"
22453 #: ../fish/guestfish-actions.pod:688
22458 #: ../fish/guestfish-actions.pod:690
22461 " command 'arguments ...'\n"
22466 #: ../fish/guestfish-actions.pod:697
22468 "The single parameter is an argv-style list of arguments. The first element "
22469 "is the name of the program to run. Subsequent elements are parameters. The "
22470 "list must be non-empty (ie. must contain a program name). Note that the "
22471 "command runs directly, and is I<not> invoked via the shell (see L</sh>)."
22475 #: ../fish/guestfish-actions.pod:725
22476 msgid "command-lines"
22480 #: ../fish/guestfish-actions.pod:727
22483 " command-lines 'arguments ...'\n"
22488 #: ../fish/guestfish-actions.pod:729
22490 "This is the same as L</command>, but splits the result into a list of lines."
22494 #: ../fish/guestfish-actions.pod:732
22495 msgid "See also: L</sh-lines>"
22499 #: ../fish/guestfish-actions.pod:737
22504 #: ../fish/guestfish-actions.pod:739
22507 " config qemuparam qemuvalue\n"
22512 #: ../fish/guestfish-actions.pod:750
22517 #: ../fish/guestfish-actions.pod:752
22520 " copy-size src dest size\n"
22525 #: ../fish/guestfish-actions.pod:760
22530 #: ../fish/guestfish-actions.pod:762
22538 #: ../fish/guestfish-actions.pod:767
22543 #: ../fish/guestfish-actions.pod:769
22551 #: ../fish/guestfish-actions.pod:774
22556 #: ../fish/guestfish-actions.pod:776
22564 #: ../fish/guestfish-actions.pod:783
22566 "If the destination is a device, it must be as large or larger than the "
22567 "source file or device, otherwise the copy will fail. This command cannot do "
22568 "partial copies (see L</copy-size>)."
22572 #: ../fish/guestfish-actions.pod:787
22577 #: ../fish/guestfish-actions.pod:789
22585 #: ../fish/guestfish-actions.pod:793 ../fish/guestfish-actions.pod:804
22587 "This command is mostly useful for interactive sessions. It is I<not> "
22588 "intended that you try to parse the output string. Use L</statvfs> from "
22593 #: ../fish/guestfish-actions.pod:797
22598 #: ../fish/guestfish-actions.pod:799
22606 #: ../fish/guestfish-actions.pod:808
22611 #: ../fish/guestfish-actions.pod:810
22619 #: ../fish/guestfish-actions.pod:816
22621 "Another way to get the same information is to enable verbose messages with "
22622 "L</set-verbose> or by setting the environment variable C<LIBGUESTFS_DEBUG=1> "
22623 "before running the program."
22627 #: ../fish/guestfish-actions.pod:821
22632 #: ../fish/guestfish-actions.pod:823
22635 " download remotefilename (filename|-)\n"
22640 #: ../fish/guestfish-actions.pod:830
22641 msgid "See also L</upload>, L</cat>."
22645 #: ../fish/guestfish-actions.pod:834
22646 msgid "download-offset"
22650 #: ../fish/guestfish-actions.pod:836
22653 " download-offset remotefilename (filename|-) offset size\n"
22658 #: ../fish/guestfish-actions.pod:844
22660 "Note that there is no limit on the amount of data that can be downloaded "
22661 "with this call, unlike with L</pread>, and this call always reads the full "
22662 "amount unless an error occurs."
22666 #: ../fish/guestfish-actions.pod:849
22667 msgid "See also L</download>, L</pread>."
22671 #: ../fish/guestfish-actions.pod:853
22672 msgid "drop-caches"
22676 #: ../fish/guestfish-actions.pod:855
22679 " drop-caches whattodrop\n"
22684 #: ../fish/guestfish-actions.pod:867
22689 #: ../fish/guestfish-actions.pod:869
22697 #: ../fish/guestfish-actions.pod:881
22702 #: ../fish/guestfish-actions.pod:883
22705 " e2fsck-f device\n"
22710 #: ../fish/guestfish-actions.pod:889
22712 "This command is only needed because of L</resize2fs> (q.v.). Normally you "
22713 "should use L</fsck>."
22717 #: ../fish/guestfish-actions.pod:892
22718 msgid "echo-daemon"
22722 #: ../fish/guestfish-actions.pod:894
22725 " echo-daemon 'words ...'\n"
22730 #: ../fish/guestfish-actions.pod:901
22731 msgid "See also L</ping-daemon>."
22735 #: ../fish/guestfish-actions.pod:903
22740 #: ../fish/guestfish-actions.pod:905
22743 " egrep regex path\n"
22748 #: ../fish/guestfish-actions.pod:913
22753 #: ../fish/guestfish-actions.pod:915
22756 " egrepi regex path\n"
22761 #: ../fish/guestfish-actions.pod:923
22766 #: ../fish/guestfish-actions.pod:925
22769 " equal file1 file2\n"
22774 #: ../fish/guestfish-actions.pod:932
22779 #: ../fish/guestfish-actions.pod:934
22787 #: ../fish/guestfish-actions.pod:939
22788 msgid "See also L</is-file>, L</is-dir>, L</stat>."
22792 #: ../fish/guestfish-actions.pod:941
22797 #: ../fish/guestfish-actions.pod:943
22800 " fallocate path len\n"
22805 #: ../fish/guestfish-actions.pod:960
22806 msgid "fallocate64"
22810 #: ../fish/guestfish-actions.pod:962
22813 " fallocate64 path len\n"
22818 #: ../fish/guestfish-actions.pod:968
22820 "Note that this call allocates disk blocks for the file. To create a sparse "
22821 "file use L</truncate-size> instead."
22825 #: ../fish/guestfish-actions.pod:971
22827 "The deprecated call L</fallocate> does the same, but owing to an oversight "
22828 "it only allowed 30 bit lengths to be specified, effectively limiting the "
22829 "maximum size of files created through that call to 1GB."
22833 #: ../fish/guestfish-actions.pod:980
22838 #: ../fish/guestfish-actions.pod:982
22841 " fgrep pattern path\n"
22846 #: ../fish/guestfish-actions.pod:990
22851 #: ../fish/guestfish-actions.pod:992
22854 " fgrepi pattern path\n"
22859 #: ../fish/guestfish-actions.pod:1000
22864 #: ../fish/guestfish-actions.pod:1002
22872 #: ../fish/guestfish-actions.pod:1014
22874 "This command can also be used on C</dev/> devices (and partitions, LV "
22875 "names). You can for example use this to determine if a device contains a "
22876 "filesystem, although it's usually better to use L</vfs-type>."
22880 #: ../fish/guestfish-actions.pod:1024
22881 msgid "file-architecture"
22885 #: ../fish/guestfish-actions.pod:1026
22888 " file-architecture filename\n"
22893 #: ../fish/guestfish-actions.pod:1129
22898 #: ../fish/guestfish-actions.pod:1131
22906 #: ../fish/guestfish-actions.pod:1135
22908 "To get other stats about a file, use L</stat>, L</lstat>, L</is-dir>, L</is-"
22909 "file> etc. To get the size of block devices, use L</blockdev-getsize64>."
22913 #: ../fish/guestfish-actions.pod:1139
22918 #: ../fish/guestfish-actions.pod:1141
22921 " fill c len path\n"
22926 #: ../fish/guestfish-actions.pod:1147
22928 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
22929 "L</truncate-size>. To create a file with a pattern of repeating bytes use "
22930 "L</fill-pattern>."
22934 #: ../fish/guestfish-actions.pod:1152
22935 msgid "fill-pattern"
22939 #: ../fish/guestfish-actions.pod:1154
22942 " fill-pattern pattern len path\n"
22947 #: ../fish/guestfish-actions.pod:1156
22949 "This function is like L</fill> except that it creates a new file of length "
22950 "C<len> containing the repeating pattern of bytes in C<pattern>. The pattern "
22951 "is truncated if necessary to ensure the length of the file is exactly C<len> "
22956 #: ../fish/guestfish-actions.pod:1161
22961 #: ../fish/guestfish-actions.pod:1163
22964 " find directory\n"
22969 #: ../fish/guestfish-actions.pod:1177
22970 msgid "then the returned list from L</find> C</tmp> would be 4 elements:"
22974 #: ../fish/guestfish-actions.pod:1190
22975 msgid "See also L</find0>."
22979 #: ../fish/guestfish-actions.pod:1195
22984 #: ../fish/guestfish-actions.pod:1197
22987 " find0 directory (files|-)\n"
22992 #: ../fish/guestfish-actions.pod:1203
22994 "This command works the same way as L</find> with the following exceptions:"
22998 #: ../fish/guestfish-actions.pod:1230
22999 msgid "findfs-label"
23003 #: ../fish/guestfish-actions.pod:1232
23006 " findfs-label label\n"
23011 #: ../fish/guestfish-actions.pod:1238
23012 msgid "To find the label of a filesystem, use L</vfs-label>."
23016 #: ../fish/guestfish-actions.pod:1240
23017 msgid "findfs-uuid"
23021 #: ../fish/guestfish-actions.pod:1242
23024 " findfs-uuid uuid\n"
23029 #: ../fish/guestfish-actions.pod:1248
23030 msgid "To find the UUID of a filesystem, use L</vfs-uuid>."
23034 #: ../fish/guestfish-actions.pod:1250
23039 #: ../fish/guestfish-actions.pod:1252
23042 " fsck fstype device\n"
23047 #: ../fish/guestfish-actions.pod:1282
23052 #: ../fish/guestfish-actions.pod:1284
23060 #: ../fish/guestfish-actions.pod:1291
23061 msgid "get-attach-method"
23065 #: ../fish/guestfish-actions.pod:1293
23068 " get-attach-method\n"
23073 #: ../fish/guestfish-actions.pod:1295
23074 msgid "Return the current attach method. See L</set-attach-method>."
23078 #: ../fish/guestfish-actions.pod:1297
23079 msgid "get-autosync"
23083 #: ../fish/guestfish-actions.pod:1299
23091 #: ../fish/guestfish-actions.pod:1303
23096 #: ../fish/guestfish-actions.pod:1305
23104 #: ../fish/guestfish-actions.pod:1309
23105 msgid "get-e2label"
23109 #: ../fish/guestfish-actions.pod:1311
23112 " get-e2label device\n"
23117 #: ../fish/guestfish-actions.pod:1323
23122 #: ../fish/guestfish-actions.pod:1325
23125 " get-e2uuid device\n"
23130 #: ../fish/guestfish-actions.pod:1337
23131 msgid "get-memsize"
23135 #: ../fish/guestfish-actions.pod:1339
23143 #: ../fish/guestfish-actions.pod:1344
23145 "If L</set-memsize> was not called on this handle, and if "
23146 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
23147 "value for memsize."
23151 #: ../fish/guestfish-actions.pod:1351
23152 msgid "get-network"
23156 #: ../fish/guestfish-actions.pod:1353
23164 #: ../fish/guestfish-actions.pod:1357
23169 #: ../fish/guestfish-actions.pod:1359
23177 #: ../fish/guestfish-actions.pod:1366
23182 #: ../fish/guestfish-actions.pod:1368
23187 #: ../fish/guestfish-actions.pod:1370
23195 #: ../fish/guestfish-actions.pod:1377
23200 #: ../fish/guestfish-actions.pod:1379
23208 #: ../fish/guestfish-actions.pod:1386
23209 msgid "get-recovery-proc"
23213 #: ../fish/guestfish-actions.pod:1388
23216 " get-recovery-proc\n"
23221 #: ../fish/guestfish-actions.pod:1392
23222 msgid "get-selinux"
23226 #: ../fish/guestfish-actions.pod:1394
23234 #: ../fish/guestfish-actions.pod:1396
23236 "This returns the current setting of the selinux flag which is passed to the "
23237 "appliance at boot time. See L</set-selinux>."
23241 #: ../fish/guestfish-actions.pod:1402
23246 #: ../fish/guestfish-actions.pod:1404
23254 #: ../fish/guestfish-actions.pod:1411
23259 #: ../fish/guestfish-actions.pod:1413
23267 #: ../fish/guestfish-actions.pod:1417
23272 #: ../fish/guestfish-actions.pod:1419
23280 #: ../fish/guestfish-actions.pod:1421
23282 "Return the current umask. By default the umask is C<022> unless it has been "
23283 "set by calling L</umask>."
23287 #: ../fish/guestfish-actions.pod:1424
23288 msgid "get-verbose"
23292 #: ../fish/guestfish-actions.pod:1426
23300 #: ../fish/guestfish-actions.pod:1430
23305 #: ../fish/guestfish-actions.pod:1432
23313 #: ../fish/guestfish-actions.pod:1436
23314 msgid "See the documentation about SELINUX in L<guestfs(3)>, and L</setcon>"
23318 #: ../fish/guestfish-actions.pod:1439
23323 #: ../fish/guestfish-actions.pod:1441
23326 " getxattr path name\n"
23331 #: ../fish/guestfish-actions.pod:1443
23333 "Get a single extended attribute from file C<path> named C<name>. This call "
23334 "follows symlinks. If you want to lookup an extended attribute for the "
23335 "symlink itself, use L</lgetxattr>."
23339 #: ../fish/guestfish-actions.pod:1447 ../fish/guestfish-actions.pod:2453
23341 "Normally it is better to get all extended attributes from a file in one go "
23342 "by calling L</getxattrs>. However some Linux filesystem implementations are "
23343 "buggy and do not provide a way to list out attributes. For these "
23344 "filesystems (notably ntfs-3g) you have to know the names of the extended "
23345 "attributes you want in advance and call this function."
23349 #: ../fish/guestfish-actions.pod:1457
23350 msgid "See also: L</getxattrs>, L</lgetxattr>, L<attr(5)>."
23354 #: ../fish/guestfish-actions.pod:1459
23359 #: ../fish/guestfish-actions.pod:1461
23362 " getxattrs path\n"
23367 #: ../fish/guestfish-actions.pod:1469
23368 msgid "See also: L</lgetxattrs>, L<attr(5)>."
23372 #: ../fish/guestfish-actions.pod:1471
23373 msgid "glob-expand"
23377 #: ../fish/guestfish-actions.pod:1473
23380 " glob-expand pattern\n"
23385 #: ../fish/guestfish-actions.pod:1486
23390 #: ../fish/guestfish-actions.pod:1488
23393 " grep regex path\n"
23398 #: ../fish/guestfish-actions.pod:1496
23403 #: ../fish/guestfish-actions.pod:1498
23406 " grepi regex path\n"
23411 #: ../fish/guestfish-actions.pod:1506
23412 msgid "grub-install"
23416 #: ../fish/guestfish-actions.pod:1508
23419 " grub-install root device\n"
23424 #: ../fish/guestfish-actions.pod:1524
23429 #: ../fish/guestfish-actions.pod:1526
23437 #: ../fish/guestfish-actions.pod:1534
23442 #: ../fish/guestfish-actions.pod:1536
23445 " head-n nrlines path\n"
23450 #: ../fish/guestfish-actions.pod:1549
23455 #: ../fish/guestfish-actions.pod:1551
23463 #: ../fish/guestfish-actions.pod:1559
23468 #: ../fish/guestfish-actions.pod:1561
23471 " initrd-cat initrdpath filename\n"
23476 #: ../fish/guestfish-actions.pod:1573
23477 msgid "See also L</initrd-list>."
23481 #: ../fish/guestfish-actions.pod:1578
23482 msgid "initrd-list"
23486 #: ../fish/guestfish-actions.pod:1580
23489 " initrd-list path\n"
23494 #: ../fish/guestfish-actions.pod:1592
23495 msgid "inotify-add-watch"
23499 #: ../fish/guestfish-actions.pod:1594
23502 " inotify-add-watch path mask\n"
23507 #: ../fish/guestfish-actions.pod:1606
23508 msgid "inotify-close"
23512 #: ../fish/guestfish-actions.pod:1608
23520 #: ../fish/guestfish-actions.pod:1614
23521 msgid "inotify-files"
23525 #: ../fish/guestfish-actions.pod:1616
23533 #: ../fish/guestfish-actions.pod:1618
23535 "This function is a helpful wrapper around L</inotify-read> which just "
23536 "returns a list of pathnames of objects that were touched. The returned "
23537 "pathnames are sorted and deduplicated."
23541 #: ../fish/guestfish-actions.pod:1622
23542 msgid "inotify-init"
23546 #: ../fish/guestfish-actions.pod:1624
23549 " inotify-init maxevents\n"
23554 #: ../fish/guestfish-actions.pod:1630
23556 "C<maxevents> is the maximum number of events which will be queued up between "
23557 "calls to L</inotify-read> or L</inotify-files>. If this is passed as C<0>, "
23558 "then the kernel (or previously set) default is used. For Linux 2.6.29 the "
23559 "default was 16384 events. Beyond this limit, the kernel throws away events, "
23560 "but records the fact that it threw them away by setting a flag "
23561 "C<IN_Q_OVERFLOW> in the returned structure list (see L</inotify-read>)."
23565 #: ../fish/guestfish-actions.pod:1640
23567 "Before any events are generated, you have to add some watches to the "
23568 "internal watch list. See: L</inotify-add-watch>, L</inotify-rm-watch> and "
23569 "L</inotify-watch-all>."
23573 #: ../fish/guestfish-actions.pod:1646
23575 "Queued up events should be read periodically by calling L</inotify-read> (or "
23576 "L</inotify-files> which is just a helpful wrapper around L</inotify-read>). "
23577 "If you don't read the events out often enough then you risk the internal "
23578 "queue overflowing."
23582 #: ../fish/guestfish-actions.pod:1653
23584 "The handle should be closed after use by calling L</inotify-close>. This "
23585 "also removes any watches automatically."
23589 #: ../fish/guestfish-actions.pod:1662
23590 msgid "inotify-read"
23594 #: ../fish/guestfish-actions.pod:1664
23602 #: ../fish/guestfish-actions.pod:1677
23603 msgid "inotify-rm-watch"
23607 #: ../fish/guestfish-actions.pod:1679
23610 " inotify-rm-watch wd\n"
23615 #: ../fish/guestfish-actions.pod:1681
23616 msgid "Remove a previously defined inotify watch. See L</inotify-add-watch>."
23620 #: ../fish/guestfish-actions.pod:1684
23621 msgid "inspect-get-arch"
23625 #: ../fish/guestfish-actions.pod:1686
23628 " inspect-get-arch root\n"
23633 #: ../fish/guestfish-actions.pod:1688 ../fish/guestfish-actions.pod:1704
23634 #: ../fish/guestfish-actions.pod:1790 ../fish/guestfish-actions.pod:1826
23635 #: ../fish/guestfish-actions.pod:1844 ../fish/guestfish-actions.pod:1878
23636 #: ../fish/guestfish-actions.pod:1893 ../fish/guestfish-actions.pod:1914
23637 #: ../fish/guestfish-actions.pod:1929 ../fish/guestfish-actions.pod:1962
23638 #: ../fish/guestfish-actions.pod:1984 ../fish/guestfish-actions.pod:2008
23639 #: ../fish/guestfish-actions.pod:2025 ../fish/guestfish-actions.pod:2068
23640 #: ../fish/guestfish-actions.pod:2103 ../fish/guestfish-actions.pod:2119
23641 #: ../fish/guestfish-actions.pod:2135 ../fish/guestfish-actions.pod:2148
23642 #: ../fish/guestfish-actions.pod:2161 ../fish/guestfish-actions.pod:2176
23644 "This function should only be called with a root device string as returned by "
23649 #: ../fish/guestfish-actions.pod:1691
23651 "This returns the architecture of the inspected operating system. The "
23652 "possible return values are listed under L</file-architecture>."
23656 #: ../fish/guestfish-actions.pod:1700
23657 msgid "inspect-get-distro"
23661 #: ../fish/guestfish-actions.pod:1702
23664 " inspect-get-distro root\n"
23669 #: ../fish/guestfish-actions.pod:1786
23670 msgid "inspect-get-drive-mappings"
23674 #: ../fish/guestfish-actions.pod:1788
23677 " inspect-get-drive-mappings root\n"
23682 #: ../fish/guestfish-actions.pod:1818
23684 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
23685 "get-mountpoints>, L</inspect-get-filesystems>."
23689 #: ../fish/guestfish-actions.pod:1822
23690 msgid "inspect-get-filesystems"
23694 #: ../fish/guestfish-actions.pod:1824
23697 " inspect-get-filesystems root\n"
23702 #: ../fish/guestfish-actions.pod:1837
23704 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
23705 "get-mountpoints>."
23709 #: ../fish/guestfish-actions.pod:1840
23710 msgid "inspect-get-format"
23714 #: ../fish/guestfish-actions.pod:1842
23717 " inspect-get-format root\n"
23722 #: ../fish/guestfish-actions.pod:1874
23723 msgid "inspect-get-hostname"
23727 #: ../fish/guestfish-actions.pod:1876
23730 " inspect-get-hostname root\n"
23735 #: ../fish/guestfish-actions.pod:1889
23736 msgid "inspect-get-major-version"
23740 #: ../fish/guestfish-actions.pod:1891
23743 " inspect-get-major-version root\n"
23748 #: ../fish/guestfish-actions.pod:1910
23749 msgid "inspect-get-minor-version"
23753 #: ../fish/guestfish-actions.pod:1912
23756 " inspect-get-minor-version root\n"
23761 #: ../fish/guestfish-actions.pod:1922
23763 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
23764 "get-major-version>."
23768 #: ../fish/guestfish-actions.pod:1925
23769 msgid "inspect-get-mountpoints"
23773 #: ../fish/guestfish-actions.pod:1927
23776 " inspect-get-mountpoints root\n"
23781 #: ../fish/guestfish-actions.pod:1949
23783 "For operating systems like Windows which still use drive letters, this call "
23784 "will only return an entry for the first drive \"mounted on\" C</>. For "
23785 "information about the mapping of drive letters to partitions, see L</inspect-"
23786 "get-drive-mappings>."
23790 #: ../fish/guestfish-actions.pod:1955
23792 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
23793 "get-filesystems>."
23797 #: ../fish/guestfish-actions.pod:1958
23798 msgid "inspect-get-package-format"
23802 #: ../fish/guestfish-actions.pod:1960
23805 " inspect-get-package-format root\n"
23810 #: ../fish/guestfish-actions.pod:1965
23812 "This function and L</inspect-get-package-management> return the package "
23813 "format and package management tool used by the inspected operating system. "
23814 "For example for Fedora these functions would return C<rpm> (package format) "
23815 "and C<yum> (package management)."
23819 #: ../fish/guestfish-actions.pod:1980
23820 msgid "inspect-get-package-management"
23824 #: ../fish/guestfish-actions.pod:1982
23827 " inspect-get-package-management root\n"
23832 #: ../fish/guestfish-actions.pod:1987
23834 "L</inspect-get-package-format> and this function return the package format "
23835 "and package management tool used by the inspected operating system. For "
23836 "example for Fedora these functions would return C<rpm> (package format) and "
23837 "C<yum> (package management)."
23841 #: ../fish/guestfish-actions.pod:2004
23842 msgid "inspect-get-product-name"
23846 #: ../fish/guestfish-actions.pod:2006
23849 " inspect-get-product-name root\n"
23854 #: ../fish/guestfish-actions.pod:2021
23855 msgid "inspect-get-product-variant"
23859 #: ../fish/guestfish-actions.pod:2023
23862 " inspect-get-product-variant root\n"
23867 #: ../fish/guestfish-actions.pod:2047
23869 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
23870 "get-product-name>, L</inspect-get-major-version>."
23874 #: ../fish/guestfish-actions.pod:2051
23875 msgid "inspect-get-roots"
23879 #: ../fish/guestfish-actions.pod:2053
23882 " inspect-get-roots\n"
23887 #: ../fish/guestfish-actions.pod:2055
23889 "This function is a convenient way to get the list of root devices, as "
23890 "returned from a previous call to L</inspect-os>, but without redoing the "
23891 "whole inspection process."
23895 #: ../fish/guestfish-actions.pod:2059
23897 "This returns an empty list if either no root devices were found or the "
23898 "caller has not called L</inspect-os>."
23902 #: ../fish/guestfish-actions.pod:2064
23903 msgid "inspect-get-type"
23907 #: ../fish/guestfish-actions.pod:2066
23910 " inspect-get-type root\n"
23915 #: ../fish/guestfish-actions.pod:2099
23916 msgid "inspect-get-windows-current-control-set"
23920 #: ../fish/guestfish-actions.pod:2101
23923 " inspect-get-windows-current-control-set root\n"
23928 #: ../fish/guestfish-actions.pod:2115
23929 msgid "inspect-get-windows-systemroot"
23933 #: ../fish/guestfish-actions.pod:2117
23936 " inspect-get-windows-systemroot root\n"
23941 #: ../fish/guestfish-actions.pod:2131
23942 msgid "inspect-is-live"
23946 #: ../fish/guestfish-actions.pod:2133
23949 " inspect-is-live root\n"
23954 #: ../fish/guestfish-actions.pod:2138
23956 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
23957 "then this returns true if a live image was detected on the disk."
23961 #: ../fish/guestfish-actions.pod:2144
23962 msgid "inspect-is-multipart"
23966 #: ../fish/guestfish-actions.pod:2146
23969 " inspect-is-multipart root\n"
23974 #: ../fish/guestfish-actions.pod:2151
23976 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
23977 "then this returns true if the disk is part of a set."
23981 #: ../fish/guestfish-actions.pod:2157
23982 msgid "inspect-is-netinst"
23986 #: ../fish/guestfish-actions.pod:2159
23989 " inspect-is-netinst root\n"
23994 #: ../fish/guestfish-actions.pod:2164
23996 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
23997 "then this returns true if the disk is a network installer, ie. not a self-"
23998 "contained install CD but one which is likely to require network access to "
23999 "complete the install."
24003 #: ../fish/guestfish-actions.pod:2172
24004 msgid "inspect-list-applications"
24008 #: ../fish/guestfish-actions.pod:2174
24011 " inspect-list-applications root\n"
24016 #: ../fish/guestfish-actions.pod:2181
24018 "I<Note:> This call works differently from other parts of the inspection "
24019 "API. You have to call L</inspect-os>, then L</inspect-get-mountpoints>, "
24020 "then mount up the disks, before calling this. Listing applications is a "
24021 "significantly more difficult operation which requires access to the full "
24022 "filesystem. Also note that unlike the other L</inspect-get-*> calls which "
24023 "are just returning data cached in the libguestfs handle, this call actually "
24024 "reads parts of the mounted filesystems during the call."
24028 #: ../fish/guestfish-actions.pod:2271
24033 #: ../fish/guestfish-actions.pod:2273
24041 #: ../fish/guestfish-actions.pod:2288
24043 "You can pass the root string(s) returned to other L</inspect-get-*> "
24044 "functions in order to query further information about each operating system, "
24045 "such as the name and version."
24049 #: ../fish/guestfish-actions.pod:2293
24051 "This function uses other libguestfs features such as L</mount-ro> and L</"
24052 "umount-all> in order to mount and unmount filesystems and look at the "
24053 "contents. This should be called with no disks currently mounted. The "
24054 "function may also use Augeas, so any existing Augeas handle will be closed."
24058 #: ../fish/guestfish-actions.pod:2305 ../fish/guestfish-actions.pod:2481
24059 #: ../fish/guestfish-actions.pod:2527
24060 msgid "See also L</list-filesystems>."
24064 #: ../fish/guestfish-actions.pod:2307
24065 msgid "is-blockdev"
24069 #: ../fish/guestfish-actions.pod:2309
24072 " is-blockdev path\n"
24077 #: ../fish/guestfish-actions.pod:2314 ../fish/guestfish-actions.pod:2332
24078 #: ../fish/guestfish-actions.pod:2351 ../fish/guestfish-actions.pod:2360
24079 #: ../fish/guestfish-actions.pod:2370 ../fish/guestfish-actions.pod:2404
24080 #: ../fish/guestfish-actions.pod:2413
24081 msgid "See also L</stat>."
24085 #: ../fish/guestfish-actions.pod:2316
24090 #: ../fish/guestfish-actions.pod:2318
24098 #: ../fish/guestfish-actions.pod:2325
24103 #: ../fish/guestfish-actions.pod:2327
24106 " is-chardev path\n"
24111 #: ../fish/guestfish-actions.pod:2334
24116 #: ../fish/guestfish-actions.pod:2336
24124 #: ../fish/guestfish-actions.pod:2343
24129 #: ../fish/guestfish-actions.pod:2345
24137 #: ../fish/guestfish-actions.pod:2353
24142 #: ../fish/guestfish-actions.pod:2355
24150 #: ../fish/guestfish-actions.pod:2362
24155 #: ../fish/guestfish-actions.pod:2364
24163 #: ../fish/guestfish-actions.pod:2372
24164 msgid "is-launching"
24168 #: ../fish/guestfish-actions.pod:2374
24176 #: ../fish/guestfish-actions.pod:2381
24181 #: ../fish/guestfish-actions.pod:2383
24189 #: ../fish/guestfish-actions.pod:2388
24194 #: ../fish/guestfish-actions.pod:2390
24202 #: ../fish/guestfish-actions.pod:2397
24207 #: ../fish/guestfish-actions.pod:2399
24210 " is-socket path\n"
24215 #: ../fish/guestfish-actions.pod:2406
24220 #: ../fish/guestfish-actions.pod:2408
24223 " is-symlink path\n"
24228 #: ../fish/guestfish-actions.pod:2415
24229 msgid "kill-subprocess"
24233 #: ../fish/guestfish-actions.pod:2417
24236 " kill-subprocess\n"
24241 #: ../fish/guestfish-actions.pod:2421
24246 #: ../fish/guestfish-actions.pod:2423
24251 #: ../fish/guestfish-actions.pod:2425
24259 #: ../fish/guestfish-actions.pod:2433
24264 #: ../fish/guestfish-actions.pod:2435
24267 " lchown owner group path\n"
24272 #: ../fish/guestfish-actions.pod:2437
24274 "Change the file owner to C<owner> and group to C<group>. This is like L</"
24275 "chown> but if C<path> is a symlink then the link itself is changed, not the "
24280 #: ../fish/guestfish-actions.pod:2445
24285 #: ../fish/guestfish-actions.pod:2447
24288 " lgetxattr path name\n"
24293 #: ../fish/guestfish-actions.pod:2463
24294 msgid "See also: L</lgetxattrs>, L</getxattr>, L<attr(5)>."
24298 #: ../fish/guestfish-actions.pod:2465
24303 #: ../fish/guestfish-actions.pod:2467
24306 " lgetxattrs path\n"
24311 #: ../fish/guestfish-actions.pod:2469
24313 "This is the same as L</getxattrs>, but if C<path> is a symbolic link, then "
24314 "it returns the extended attributes of the link itself."
24318 #: ../fish/guestfish-actions.pod:2473
24319 msgid "list-devices"
24323 #: ../fish/guestfish-actions.pod:2475
24331 #: ../fish/guestfish-actions.pod:2483
24332 msgid "list-filesystems"
24336 #: ../fish/guestfish-actions.pod:2485
24339 " list-filesystems\n"
24344 #: ../fish/guestfish-actions.pod:2504
24346 "This command runs other libguestfs commands, which might include L</mount> "
24347 "and L</umount>, and therefore you should use this soon after launch and only "
24348 "when nothing is mounted."
24352 #: ../fish/guestfish-actions.pod:2508
24354 "Not all of the filesystems returned will be mountable. In particular, swap "
24355 "partitions are returned in the list. Also this command does not check that "
24356 "each filesystem found is valid and mountable, and some filesystems might be "
24357 "mountable but require special options. Filesystems may not all belong to a "
24358 "single logical operating system (use L</inspect-os> to look for OSes)."
24362 #: ../fish/guestfish-actions.pod:2516
24363 msgid "list-partitions"
24367 #: ../fish/guestfish-actions.pod:2518
24370 " list-partitions\n"
24375 #: ../fish/guestfish-actions.pod:2524
24377 "This does not return logical volumes. For that you will need to call L</"
24382 #: ../fish/guestfish-actions.pod:2529
24387 #: ../fish/guestfish-actions.pod:2531
24395 #: ../fish/guestfish-actions.pod:2539
24400 #: ../fish/guestfish-actions.pod:2541
24403 " ln target linkname\n"
24408 #: ../fish/guestfish-actions.pod:2545
24413 #: ../fish/guestfish-actions.pod:2547
24416 " ln-f target linkname\n"
24421 #: ../fish/guestfish-actions.pod:2552
24426 #: ../fish/guestfish-actions.pod:2554
24429 " ln-s target linkname\n"
24434 #: ../fish/guestfish-actions.pod:2558
24439 #: ../fish/guestfish-actions.pod:2560
24442 " ln-sf target linkname\n"
24447 #: ../fish/guestfish-actions.pod:2565
24448 msgid "lremovexattr"
24452 #: ../fish/guestfish-actions.pod:2567
24455 " lremovexattr xattr path\n"
24460 #: ../fish/guestfish-actions.pod:2569
24462 "This is the same as L</removexattr>, but if C<path> is a symbolic link, then "
24463 "it removes an extended attribute of the link itself."
24467 #: ../fish/guestfish-actions.pod:2573
24472 #: ../fish/guestfish-actions.pod:2575
24480 #: ../fish/guestfish-actions.pod:2581
24482 "This command is mostly useful for interactive sessions. Programs should "
24483 "probably use L</readdir> instead."
24487 #: ../fish/guestfish-actions.pod:2584
24492 #: ../fish/guestfish-actions.pod:2586
24495 " lsetxattr xattr val vallen path\n"
24500 #: ../fish/guestfish-actions.pod:2588
24502 "This is the same as L</setxattr>, but if C<path> is a symbolic link, then it "
24503 "sets an extended attribute of the link itself."
24507 #: ../fish/guestfish-actions.pod:2592
24512 #: ../fish/guestfish-actions.pod:2594
24520 #: ../fish/guestfish-actions.pod:2598
24522 "This is the same as L</stat> except that if C<path> is a symbolic link, then "
24523 "the link is stat-ed, not the file it refers to."
24527 #: ../fish/guestfish-actions.pod:2604
24532 #: ../fish/guestfish-actions.pod:2606
24535 " lstatlist path 'names ...'\n"
24540 #: ../fish/guestfish-actions.pod:2608
24542 "This call allows you to perform the L</lstat> operation on multiple files, "
24543 "where all files are in the directory C<path>. C<names> is the list of files "
24544 "from this directory."
24548 #: ../fish/guestfish-actions.pod:2617
24550 "This call is intended for programs that want to efficiently list a directory "
24551 "contents without making many round-trips. See also L</lxattrlist> for a "
24552 "similarly efficient call for getting extended attributes. Very long "
24553 "directory listings might cause the protocol message size to be exceeded, "
24554 "causing this call to fail. The caller must split up such requests into "
24555 "smaller groups of names."
24559 #: ../fish/guestfish-actions.pod:2625
24560 msgid "luks-add-key"
24564 #: ../fish/guestfish-actions.pod:2627
24567 " luks-add-key device keyslot\n"
24572 #: ../fish/guestfish-actions.pod:2634
24574 "Note that if C<keyslot> already contains a key, then this command will "
24575 "fail. You have to use L</luks-kill-slot> first to remove that key."
24579 #: ../fish/guestfish-actions.pod:2638 ../fish/guestfish-actions.pod:2660
24580 #: ../fish/guestfish-actions.pod:2673 ../fish/guestfish-actions.pod:2687
24581 #: ../fish/guestfish-actions.pod:2710 ../fish/guestfish-actions.pod:2720
24583 "This command has one or more key or passphrase parameters. Guestfish will "
24584 "prompt for these separately."
24588 #: ../fish/guestfish-actions.pod:2641
24593 #: ../fish/guestfish-actions.pod:2643
24596 " luks-close device\n"
24601 #: ../fish/guestfish-actions.pod:2645
24603 "This closes a LUKS device that was created earlier by L</luks-open> or L</"
24604 "luks-open-ro>. The C<device> parameter must be the name of the LUKS mapping "
24605 "device (ie. C</dev/mapper/mapname>) and I<not> the name of the underlying "
24610 #: ../fish/guestfish-actions.pod:2651
24611 msgid "luks-format"
24615 #: ../fish/guestfish-actions.pod:2653
24618 " luks-format device keyslot\n"
24623 #: ../fish/guestfish-actions.pod:2666
24624 msgid "luks-format-cipher"
24628 #: ../fish/guestfish-actions.pod:2668
24631 " luks-format-cipher device keyslot cipher\n"
24636 #: ../fish/guestfish-actions.pod:2670
24638 "This command is the same as L</luks-format> but it also allows you to set "
24639 "the C<cipher> used."
24643 #: ../fish/guestfish-actions.pod:2679
24644 msgid "luks-kill-slot"
24648 #: ../fish/guestfish-actions.pod:2681
24651 " luks-kill-slot device keyslot\n"
24656 #: ../fish/guestfish-actions.pod:2690
24661 #: ../fish/guestfish-actions.pod:2692
24664 " luks-open device mapname\n"
24669 #: ../fish/guestfish-actions.pod:2706
24671 "If this block device contains LVM volume groups, then calling L</vgscan> "
24672 "followed by L</vg-activate-all> will make them visible."
24676 #: ../fish/guestfish-actions.pod:2713
24677 msgid "luks-open-ro"
24681 #: ../fish/guestfish-actions.pod:2715
24684 " luks-open-ro device mapname\n"
24689 #: ../fish/guestfish-actions.pod:2717
24691 "This is the same as L</luks-open> except that a read-only mapping is created."
24695 #: ../fish/guestfish-actions.pod:2723
24700 #: ../fish/guestfish-actions.pod:2725
24703 " lvcreate logvol volgroup mbytes\n"
24708 #: ../fish/guestfish-actions.pod:2730
24709 msgid "lvm-canonical-lv-name"
24713 #: ../fish/guestfish-actions.pod:2732
24716 " lvm-canonical-lv-name lvname\n"
24721 #: ../fish/guestfish-actions.pod:2741
24722 msgid "See also L</is-lv>."
24726 #: ../fish/guestfish-actions.pod:2743
24727 msgid "lvm-clear-filter"
24731 #: ../fish/guestfish-actions.pod:2745
24734 " lvm-clear-filter\n"
24739 #: ../fish/guestfish-actions.pod:2747
24741 "This undoes the effect of L</lvm-set-filter>. LVM will be able to see every "
24746 #: ../fish/guestfish-actions.pod:2753
24747 msgid "lvm-remove-all"
24751 #: ../fish/guestfish-actions.pod:2755
24754 " lvm-remove-all\n"
24759 #: ../fish/guestfish-actions.pod:2763
24760 msgid "lvm-set-filter"
24764 #: ../fish/guestfish-actions.pod:2765
24767 " lvm-set-filter 'devices ...'\n"
24772 #: ../fish/guestfish-actions.pod:2790
24777 #: ../fish/guestfish-actions.pod:2792
24780 " lvremove device\n"
24785 #: ../fish/guestfish-actions.pod:2800
24790 #: ../fish/guestfish-actions.pod:2802
24793 " lvrename logvol newlogvol\n"
24798 #: ../fish/guestfish-actions.pod:2806
24803 #: ../fish/guestfish-actions.pod:2808
24806 " lvresize device mbytes\n"
24811 #: ../fish/guestfish-actions.pod:2814
24812 msgid "lvresize-free"
24816 #: ../fish/guestfish-actions.pod:2816
24819 " lvresize-free lv percent\n"
24824 #: ../fish/guestfish-actions.pod:2824
24829 #: ../fish/guestfish-actions.pod:2826
24837 #: ../fish/guestfish-actions.pod:2834
24838 msgid "See also L</lvs-full>, L</list-filesystems>."
24842 #: ../fish/guestfish-actions.pod:2836
24847 #: ../fish/guestfish-actions.pod:2838
24855 #: ../fish/guestfish-actions.pod:2843
24860 #: ../fish/guestfish-actions.pod:2845
24868 #: ../fish/guestfish-actions.pod:2849
24873 #: ../fish/guestfish-actions.pod:2851
24876 " lxattrlist path 'names ...'\n"
24881 #: ../fish/guestfish-actions.pod:2867
24883 "This call is intended for programs that want to efficiently list a directory "
24884 "contents without making many round-trips. See also L</lstatlist> for a "
24885 "similarly efficient call for getting standard stats. Very long directory "
24886 "listings might cause the protocol message size to be exceeded, causing this "
24887 "call to fail. The caller must split up such requests into smaller groups of "
24892 #: ../fish/guestfish-actions.pod:2875
24897 #: ../fish/guestfish-actions.pod:2877
24905 #: ../fish/guestfish-actions.pod:2881
24910 #: ../fish/guestfish-actions.pod:2883
24913 " mkdir-mode path mode\n"
24918 #: ../fish/guestfish-actions.pod:2892
24919 msgid "See also L</mkdir>, L</umask>"
24923 #: ../fish/guestfish-actions.pod:2894
24928 #: ../fish/guestfish-actions.pod:2896
24936 #: ../fish/guestfish-actions.pod:2901
24941 #: ../fish/guestfish-actions.pod:2903
24944 " mkdtemp template\n"
24949 #: ../fish/guestfish-actions.pod:2924
24954 #: ../fish/guestfish-actions.pod:2926
24957 " mke2fs-J fstype blocksize device journal\n"
24962 #: ../fish/guestfish-actions.pod:2934
24963 msgid "See also L</mke2journal>."
24967 #: ../fish/guestfish-actions.pod:2936
24972 #: ../fish/guestfish-actions.pod:2938
24975 " mke2fs-JL fstype blocksize device label\n"
24980 #: ../fish/guestfish-actions.pod:2943
24981 msgid "See also L</mke2journal-L>."
24985 #: ../fish/guestfish-actions.pod:2945
24990 #: ../fish/guestfish-actions.pod:2947
24993 " mke2fs-JU fstype blocksize device uuid\n"
24998 #: ../fish/guestfish-actions.pod:2952
24999 msgid "See also L</mke2journal-U>."
25003 #: ../fish/guestfish-actions.pod:2954
25004 msgid "mke2journal"
25008 #: ../fish/guestfish-actions.pod:2956
25011 " mke2journal blocksize device\n"
25016 #: ../fish/guestfish-actions.pod:2963
25017 msgid "mke2journal-L"
25021 #: ../fish/guestfish-actions.pod:2965
25024 " mke2journal-L blocksize label device\n"
25029 #: ../fish/guestfish-actions.pod:2969
25030 msgid "mke2journal-U"
25034 #: ../fish/guestfish-actions.pod:2971
25037 " mke2journal-U blocksize uuid device\n"
25042 #: ../fish/guestfish-actions.pod:2975
25047 #: ../fish/guestfish-actions.pod:2977
25050 " mkfifo mode path\n"
25055 #: ../fish/guestfish-actions.pod:2979
25057 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
25058 "is just a convenient wrapper around L</mknod>."
25062 #: ../fish/guestfish-actions.pod:2985
25067 #: ../fish/guestfish-actions.pod:2987
25070 " mkfs fstype device\n"
25075 #: ../fish/guestfish-actions.pod:2993
25080 #: ../fish/guestfish-actions.pod:2995
25083 " mkfs-b fstype blocksize device\n"
25088 #: ../fish/guestfish-actions.pod:2997
25090 "This call is similar to L</mkfs>, but it allows you to control the block "
25091 "size of the resulting filesystem. Supported block sizes depend on the "
25092 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
25096 #: ../fish/guestfish-actions.pod:3012
25101 #: ../fish/guestfish-actions.pod:3014
25104 " mkfs-opts fstype device [blocksize:..] [features:..]\n"
25109 #: ../fish/guestfish-actions.pod:3049
25110 msgid "mkmountpoint"
25114 #: ../fish/guestfish-actions.pod:3051
25117 " mkmountpoint exemptpath\n"
25122 #: ../fish/guestfish-actions.pod:3053
25124 "L</mkmountpoint> and L</rmmountpoint> are specialized calls that can be used "
25125 "to create extra mountpoints before mounting the first filesystem."
25129 #: ../fish/guestfish-actions.pod:3077
25131 "L</mkmountpoint> is not compatible with L</umount-all>. You may get "
25132 "unexpected errors if you try to mix these calls. It is safest to manually "
25133 "unmount filesystems and remove mountpoints after use."
25137 #: ../fish/guestfish-actions.pod:3081
25139 "L</umount-all> unmounts filesystems by sorting the paths longest first, so "
25140 "for this to work for manual mountpoints, you must ensure that the innermost "
25141 "mountpoints have the longest pathnames, as in the example code above."
25145 #: ../fish/guestfish-actions.pod:3088
25147 "Autosync [see L</set-autosync>, this is set by default on handles] can cause "
25148 "L</umount-all> to be called when the handle is closed which can also trigger "
25153 #: ../fish/guestfish-actions.pod:3092
25158 #: ../fish/guestfish-actions.pod:3094
25161 " mknod mode devmajor devminor path\n"
25166 #: ../fish/guestfish-actions.pod:3104
25168 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
25169 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
25170 "regular file). These constants are available in the standard Linux header "
25171 "files, or you can use L</mknod-b>, L</mknod-c> or L</mkfifo> which are "
25172 "wrappers around this command which bitwise OR in the appropriate constant "
25177 #: ../fish/guestfish-actions.pod:3114
25182 #: ../fish/guestfish-actions.pod:3116
25185 " mknod-b mode devmajor devminor path\n"
25190 #: ../fish/guestfish-actions.pod:3118
25192 "This call creates a block device node called C<path> with mode C<mode> and "
25193 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
25194 "wrapper around L</mknod>."
25198 #: ../fish/guestfish-actions.pod:3124
25203 #: ../fish/guestfish-actions.pod:3126
25206 " mknod-c mode devmajor devminor path\n"
25211 #: ../fish/guestfish-actions.pod:3128
25213 "This call creates a char device node called C<path> with mode C<mode> and "
25214 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
25215 "wrapper around L</mknod>."
25219 #: ../fish/guestfish-actions.pod:3134
25224 #: ../fish/guestfish-actions.pod:3136
25232 #: ../fish/guestfish-actions.pod:3140
25237 #: ../fish/guestfish-actions.pod:3142
25240 " mkswap-L label device\n"
25245 #: ../fish/guestfish-actions.pod:3150
25250 #: ../fish/guestfish-actions.pod:3152
25253 " mkswap-U uuid device\n"
25258 #: ../fish/guestfish-actions.pod:3156
25259 msgid "mkswap-file"
25263 #: ../fish/guestfish-actions.pod:3158
25266 " mkswap-file path\n"
25271 #: ../fish/guestfish-actions.pod:3162
25273 "This command just writes a swap file signature to an existing file. To "
25274 "create the file itself, use something like L</fallocate>."
25278 #: ../fish/guestfish-actions.pod:3165
25283 #: ../fish/guestfish-actions.pod:3167
25286 " modprobe modulename\n"
25291 #: ../fish/guestfish-actions.pod:3174
25296 #: ../fish/guestfish-actions.pod:3176
25299 " mount device mountpoint\n"
25304 #: ../fish/guestfish-actions.pod:3192
25306 "B<Important note:> When you use this call, the filesystem options C<sync> "
25307 "and C<noatime> are set implicitly. This was originally done because we "
25308 "thought it would improve reliability, but it turns out that I<-o sync> has a "
25309 "very large negative performance impact and negligible effect on "
25310 "reliability. Therefore we recommend that you avoid using L</mount> in any "
25311 "code that needs performance, and instead use L</mount-options> (use an empty "
25312 "string for the first parameter if you don't want any options)."
25316 #: ../fish/guestfish-actions.pod:3202
25321 #: ../fish/guestfish-actions.pod:3204
25324 " mount-loop file mountpoint\n"
25329 #: ../fish/guestfish-actions.pod:3210
25330 msgid "mount-options"
25334 #: ../fish/guestfish-actions.pod:3212
25337 " mount-options options device mountpoint\n"
25342 #: ../fish/guestfish-actions.pod:3214
25344 "This is the same as the L</mount> command, but it allows you to set the "
25345 "mount options as for the L<mount(8)> I<-o> flag."
25349 #: ../fish/guestfish-actions.pod:3222
25354 #: ../fish/guestfish-actions.pod:3224
25357 " mount-ro device mountpoint\n"
25362 #: ../fish/guestfish-actions.pod:3226
25364 "This is the same as the L</mount> command, but it mounts the filesystem with "
25365 "the read-only (I<-o ro>) flag."
25369 #: ../fish/guestfish-actions.pod:3229
25374 #: ../fish/guestfish-actions.pod:3231
25377 " mount-vfs options vfstype device mountpoint\n"
25382 #: ../fish/guestfish-actions.pod:3233
25384 "This is the same as the L</mount> command, but it allows you to set both the "
25385 "mount options and the vfstype as for the L<mount(8)> I<-o> and I<-t> flags."
25389 #: ../fish/guestfish-actions.pod:3237
25390 msgid "mountpoints"
25394 #: ../fish/guestfish-actions.pod:3239
25402 #: ../fish/guestfish-actions.pod:3241
25404 "This call is similar to L</mounts>. That call returns a list of devices. "
25405 "This one returns a hash table (map) of device name to directory where the "
25406 "device is mounted."
25410 #: ../fish/guestfish-actions.pod:3245
25415 #: ../fish/guestfish-actions.pod:3247
25423 #: ../fish/guestfish-actions.pod:3254
25424 msgid "See also: L</mountpoints>"
25428 #: ../fish/guestfish-actions.pod:3256
25433 #: ../fish/guestfish-actions.pod:3258
25441 #: ../fish/guestfish-actions.pod:3263
25442 msgid "ntfs-3g-probe"
25446 #: ../fish/guestfish-actions.pod:3265
25449 " ntfs-3g-probe true|false device\n"
25454 #: ../fish/guestfish-actions.pod:3279
25459 #: ../fish/guestfish-actions.pod:3281
25462 " ntfsresize device\n"
25467 #: ../fish/guestfish-actions.pod:3287
25468 msgid "ntfsresize-size"
25472 #: ../fish/guestfish-actions.pod:3289
25475 " ntfsresize-size device size\n"
25480 #: ../fish/guestfish-actions.pod:3291
25482 "This command is the same as L</ntfsresize> except that it allows you to "
25483 "specify the new size (in bytes) explicitly."
25487 #: ../fish/guestfish-actions.pod:3294
25492 #: ../fish/guestfish-actions.pod:3296
25495 " part-add device prlogex startsect endsect\n"
25500 #: ../fish/guestfish-actions.pod:3298
25502 "This command adds a partition to C<device>. If there is no partition table "
25503 "on the device, call L</part-init> first."
25507 #: ../fish/guestfish-actions.pod:3310
25509 "Creating a partition which covers the whole disk is not so easy. Use L</"
25510 "part-disk> to do that."
25514 #: ../fish/guestfish-actions.pod:3313
25519 #: ../fish/guestfish-actions.pod:3315
25522 " part-del device partnum\n"
25527 #: ../fish/guestfish-actions.pod:3323
25532 #: ../fish/guestfish-actions.pod:3325
25535 " part-disk device parttype\n"
25540 #: ../fish/guestfish-actions.pod:3327
25542 "This command is simply a combination of L</part-init> followed by L</part-"
25543 "add> to create a single primary partition covering the whole disk."
25547 #: ../fish/guestfish-actions.pod:3331
25549 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
25550 "possible values are described in L</part-init>."
25554 #: ../fish/guestfish-actions.pod:3337
25555 msgid "part-get-bootable"
25559 #: ../fish/guestfish-actions.pod:3339
25562 " part-get-bootable device partnum\n"
25567 #: ../fish/guestfish-actions.pod:3344
25568 msgid "See also L</part-set-bootable>."
25572 #: ../fish/guestfish-actions.pod:3346
25573 msgid "part-get-mbr-id"
25577 #: ../fish/guestfish-actions.pod:3348
25580 " part-get-mbr-id device partnum\n"
25585 #: ../fish/guestfish-actions.pod:3353 ../fish/guestfish-actions.pod:3491
25587 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
25588 "undefined results for other partition table types (see L</part-get-"
25593 #: ../fish/guestfish-actions.pod:3357
25594 msgid "part-get-parttype"
25598 #: ../fish/guestfish-actions.pod:3359
25601 " part-get-parttype device\n"
25606 #: ../fish/guestfish-actions.pod:3364
25608 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
25609 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
25610 "possible, although unusual. See L</part-init> for a full list."
25614 #: ../fish/guestfish-actions.pod:3369
25619 #: ../fish/guestfish-actions.pod:3371
25622 " part-init device parttype\n"
25627 #: ../fish/guestfish-actions.pod:3377
25629 "Initially there are no partitions. Following this, you should call L</part-"
25630 "add> for each partition required."
25634 #: ../fish/guestfish-actions.pod:3440
25639 #: ../fish/guestfish-actions.pod:3442
25642 " part-list device\n"
25647 #: ../fish/guestfish-actions.pod:3457
25649 "Start of the partition I<in bytes>. To get sectors you have to divide by "
25650 "the device's sector size, see L</blockdev-getss>."
25654 #: ../fish/guestfish-actions.pod:3470
25655 msgid "part-set-bootable"
25659 #: ../fish/guestfish-actions.pod:3472
25662 " part-set-bootable device partnum true|false\n"
25667 #: ../fish/guestfish-actions.pod:3481
25668 msgid "part-set-mbr-id"
25672 #: ../fish/guestfish-actions.pod:3483
25675 " part-set-mbr-id device partnum idbyte\n"
25680 #: ../fish/guestfish-actions.pod:3495
25681 msgid "part-set-name"
25685 #: ../fish/guestfish-actions.pod:3497
25688 " part-set-name device partnum name\n"
25693 #: ../fish/guestfish-actions.pod:3505
25694 msgid "part-to-dev"
25698 #: ../fish/guestfish-actions.pod:3507
25701 " part-to-dev partition\n"
25706 #: ../fish/guestfish-actions.pod:3513
25708 "The named partition must exist, for example as a string returned from L</"
25709 "list-partitions>."
25713 #: ../fish/guestfish-actions.pod:3516
25714 msgid "ping-daemon"
25718 #: ../fish/guestfish-actions.pod:3518
25726 #: ../fish/guestfish-actions.pod:3525
25731 #: ../fish/guestfish-actions.pod:3527
25734 " pread path count offset\n"
25739 #: ../fish/guestfish-actions.pod:3535
25740 msgid "See also L</pwrite>, L</pread-device>."
25744 #: ../fish/guestfish-actions.pod:3540
25745 msgid "pread-device"
25749 #: ../fish/guestfish-actions.pod:3542
25752 " pread-device device count offset\n"
25757 #: ../fish/guestfish-actions.pod:3550
25758 msgid "See also L</pread>."
25762 #: ../fish/guestfish-actions.pod:3555
25767 #: ../fish/guestfish-actions.pod:3557
25770 " pvcreate device\n"
25775 #: ../fish/guestfish-actions.pod:3563
25780 #: ../fish/guestfish-actions.pod:3565
25783 " pvremove device\n"
25788 #: ../fish/guestfish-actions.pod:3574
25793 #: ../fish/guestfish-actions.pod:3576
25796 " pvresize device\n"
25801 #: ../fish/guestfish-actions.pod:3581
25802 msgid "pvresize-size"
25806 #: ../fish/guestfish-actions.pod:3583
25809 " pvresize-size device size\n"
25814 #: ../fish/guestfish-actions.pod:3585
25816 "This command is the same as L</pvresize> except that it allows you to "
25817 "specify the new size (in bytes) explicitly."
25821 #: ../fish/guestfish-actions.pod:3588
25826 #: ../fish/guestfish-actions.pod:3590
25834 #: ../fish/guestfish-actions.pod:3598
25835 msgid "See also L</pvs-full>."
25839 #: ../fish/guestfish-actions.pod:3600
25844 #: ../fish/guestfish-actions.pod:3602
25852 #: ../fish/guestfish-actions.pod:3607
25857 #: ../fish/guestfish-actions.pod:3609
25865 #: ../fish/guestfish-actions.pod:3613
25870 #: ../fish/guestfish-actions.pod:3615
25873 " pwrite path content offset\n"
25878 #: ../fish/guestfish-actions.pod:3626
25879 msgid "See also L</pread>, L</pwrite-device>."
25883 #: ../fish/guestfish-actions.pod:3631
25884 msgid "pwrite-device"
25888 #: ../fish/guestfish-actions.pod:3633
25891 " pwrite-device device content offset\n"
25896 #: ../fish/guestfish-actions.pod:3643
25897 msgid "See also L</pwrite>."
25901 #: ../fish/guestfish-actions.pod:3648
25906 #: ../fish/guestfish-actions.pod:3650
25909 " read-file path\n"
25914 #: ../fish/guestfish-actions.pod:3655
25916 "Unlike L</cat>, this function can correctly handle files that contain "
25917 "embedded ASCII NUL characters. However unlike L</download>, this function "
25918 "is limited in the total size of file that can be handled."
25922 #: ../fish/guestfish-actions.pod:3663
25927 #: ../fish/guestfish-actions.pod:3665
25930 " read-lines path\n"
25935 #: ../fish/guestfish-actions.pod:3672
25937 "Note that this function cannot correctly handle binary files (specifically, "
25938 "files containing C<\\0> character which is treated as end of line). For "
25939 "those you need to use the L</read-file> function which has a more complex "
25944 #: ../fish/guestfish-actions.pod:3677
25949 #: ../fish/guestfish-actions.pod:3679
25957 #: ../fish/guestfish-actions.pod:3731
25959 "This function is primarily intended for use by programs. To get a simple "
25960 "list of names, use L</ls>. To get a printable directory for human "
25961 "consumption, use L</ll>."
25965 #: ../fish/guestfish-actions.pod:3735
25970 #: ../fish/guestfish-actions.pod:3737
25978 #: ../fish/guestfish-actions.pod:3741
25979 msgid "readlinklist"
25983 #: ../fish/guestfish-actions.pod:3743
25986 " readlinklist path 'names ...'\n"
25991 #: ../fish/guestfish-actions.pod:3767
25996 #: ../fish/guestfish-actions.pod:3769
26004 #: ../fish/guestfish-actions.pod:3774
26005 msgid "removexattr"
26009 #: ../fish/guestfish-actions.pod:3776
26012 " removexattr xattr path\n"
26017 #: ../fish/guestfish-actions.pod:3781
26018 msgid "See also: L</lremovexattr>, L<attr(5)>."
26022 #: ../fish/guestfish-actions.pod:3783
26027 #: ../fish/guestfish-actions.pod:3785
26030 " resize2fs device\n"
26035 #: ../fish/guestfish-actions.pod:3790
26037 "I<Note:> It is sometimes required that you run L</e2fsck-f> on the C<device> "
26038 "before calling this command. For unknown reasons C<resize2fs> sometimes "
26039 "gives an error about this and sometimes not. In any case, it is always safe "
26040 "to call L</e2fsck-f> before calling this function."
26044 #: ../fish/guestfish-actions.pod:3796
26045 msgid "resize2fs-M"
26049 #: ../fish/guestfish-actions.pod:3798
26052 " resize2fs-M device\n"
26057 #: ../fish/guestfish-actions.pod:3800
26059 "This command is the same as L</resize2fs>, but the filesystem is resized to "
26060 "its minimum size. This works like the C<-M> option to the C<resize2fs> "
26065 #: ../fish/guestfish-actions.pod:3804
26067 "To get the resulting size of the filesystem you should call L</tune2fs-l> "
26068 "and read the C<Block size> and C<Block count> values. These two numbers, "
26069 "multiplied together, give the resulting size of the minimal filesystem in "
26074 #: ../fish/guestfish-actions.pod:3809
26075 msgid "resize2fs-size"
26079 #: ../fish/guestfish-actions.pod:3811
26082 " resize2fs-size device size\n"
26087 #: ../fish/guestfish-actions.pod:3813
26089 "This command is the same as L</resize2fs> except that it allows you to "
26090 "specify the new size (in bytes) explicitly."
26094 #: ../fish/guestfish-actions.pod:3816
26099 #: ../fish/guestfish-actions.pod:3818
26107 #: ../fish/guestfish-actions.pod:3822
26112 #: ../fish/guestfish-actions.pod:3824
26120 #: ../fish/guestfish-actions.pod:3830
26125 #: ../fish/guestfish-actions.pod:3832
26133 #: ../fish/guestfish-actions.pod:3836
26134 msgid "rmmountpoint"
26138 #: ../fish/guestfish-actions.pod:3838
26141 " rmmountpoint exemptpath\n"
26146 #: ../fish/guestfish-actions.pod:3840
26148 "This calls removes a mountpoint that was previously created with L</"
26149 "mkmountpoint>. See L</mkmountpoint> for full details."
26153 #: ../fish/guestfish-actions.pod:3844
26154 msgid "scrub-device"
26158 #: ../fish/guestfish-actions.pod:3846
26161 " scrub-device device\n"
26166 #: ../fish/guestfish-actions.pod:3857
26171 #: ../fish/guestfish-actions.pod:3859
26174 " scrub-file file\n"
26179 #: ../fish/guestfish-actions.pod:3869
26180 msgid "scrub-freespace"
26184 #: ../fish/guestfish-actions.pod:3871
26187 " scrub-freespace dir\n"
26192 #: ../fish/guestfish-actions.pod:3873
26194 "This command creates the directory C<dir> and then fills it with files until "
26195 "the filesystem is full, and scrubs the files as for L</scrub-file>, and "
26196 "deletes them. The intention is to scrub any free space on the partition "
26197 "containing C<dir>."
26201 #: ../fish/guestfish-actions.pod:3882
26206 #: ../fish/guestfish-actions.pod:3884
26211 #: ../fish/guestfish-actions.pod:3886
26214 " set-append append\n"
26219 #: ../fish/guestfish-actions.pod:3897
26220 msgid "set-attach-method"
26224 #: ../fish/guestfish-actions.pod:3899
26225 msgid "attach-method"
26229 #: ../fish/guestfish-actions.pod:3901
26232 " set-attach-method attachmethod\n"
26237 #: ../fish/guestfish-actions.pod:3923
26238 msgid "set-autosync"
26242 #: ../fish/guestfish-actions.pod:3925
26247 #: ../fish/guestfish-actions.pod:3927
26250 " set-autosync true|false\n"
26255 #: ../fish/guestfish-actions.pod:3937
26260 #: ../fish/guestfish-actions.pod:3939
26265 #: ../fish/guestfish-actions.pod:3941
26268 " set-direct true|false\n"
26273 #: ../fish/guestfish-actions.pod:3947
26275 "One consequence of this is that log messages aren't caught by the library "
26276 "and handled by L</set-log-message-callback>, but go straight to stdout."
26280 #: ../fish/guestfish-actions.pod:3956
26281 msgid "set-e2label"
26285 #: ../fish/guestfish-actions.pod:3958
26288 " set-e2label device label\n"
26293 #: ../fish/guestfish-actions.pod:3964
26295 "You can use either L</tune2fs-l> or L</get-e2label> to return the existing "
26296 "label on a filesystem."
26300 #: ../fish/guestfish-actions.pod:3967
26305 #: ../fish/guestfish-actions.pod:3969
26308 " set-e2uuid device uuid\n"
26313 #: ../fish/guestfish-actions.pod:3976
26315 "You can use either L</tune2fs-l> or L</get-e2uuid> to return the existing "
26316 "UUID of a filesystem."
26320 #: ../fish/guestfish-actions.pod:3979
26321 msgid "set-memsize"
26325 #: ../fish/guestfish-actions.pod:3981
26330 #: ../fish/guestfish-actions.pod:3983
26333 " set-memsize memsize\n"
26338 #: ../fish/guestfish-actions.pod:3985
26340 "This sets the memory size in megabytes allocated to the qemu subprocess. "
26341 "This only has any effect if called before L</launch>."
26345 #: ../fish/guestfish-actions.pod:3996
26346 msgid "set-network"
26350 #: ../fish/guestfish-actions.pod:3998
26355 #: ../fish/guestfish-actions.pod:4000
26358 " set-network true|false\n"
26363 #: ../fish/guestfish-actions.pod:4008
26365 "You must call this before calling L</launch>, otherwise it has no effect."
26369 #: ../fish/guestfish-actions.pod:4011
26374 #: ../fish/guestfish-actions.pod:4013
26379 #: ../fish/guestfish-actions.pod:4015
26382 " set-path searchpath\n"
26387 #: ../fish/guestfish-actions.pod:4024
26392 #: ../fish/guestfish-actions.pod:4026
26397 #: ../fish/guestfish-actions.pod:4028
26405 #: ../fish/guestfish-actions.pod:4048
26406 msgid "set-recovery-proc"
26410 #: ../fish/guestfish-actions.pod:4050
26411 msgid "recovery-proc"
26415 #: ../fish/guestfish-actions.pod:4052
26418 " set-recovery-proc true|false\n"
26423 #: ../fish/guestfish-actions.pod:4054
26425 "If this is called with the parameter C<false> then L</launch> does not "
26426 "create a recovery process. The purpose of the recovery process is to stop "
26427 "runaway qemu processes in the case where the main program aborts abruptly."
26431 #: ../fish/guestfish-actions.pod:4059
26433 "This only has any effect if called before L</launch>, and the default is "
26438 #: ../fish/guestfish-actions.pod:4068
26439 msgid "set-selinux"
26443 #: ../fish/guestfish-actions.pod:4070
26448 #: ../fish/guestfish-actions.pod:4072
26451 " set-selinux true|false\n"
26456 #: ../fish/guestfish-actions.pod:4083
26461 #: ../fish/guestfish-actions.pod:4085
26466 #: ../fish/guestfish-actions.pod:4087
26469 " set-trace true|false\n"
26474 #: ../fish/guestfish-actions.pod:4099
26476 "Trace messages are normally sent to C<stderr>, unless you register a "
26477 "callback to send them somewhere else (see L</set-event-callback>)."
26481 #: ../fish/guestfish-actions.pod:4103
26482 msgid "set-verbose"
26486 #: ../fish/guestfish-actions.pod:4105
26491 #: ../fish/guestfish-actions.pod:4107
26494 " set-verbose true|false\n"
26499 #: ../fish/guestfish-actions.pod:4114
26501 "Verbose messages are normally sent to C<stderr>, unless you register a "
26502 "callback to send them somewhere else (see L</set-event-callback>)."
26506 #: ../fish/guestfish-actions.pod:4118
26511 #: ../fish/guestfish-actions.pod:4120
26514 " setcon context\n"
26519 #: ../fish/guestfish-actions.pod:4127
26524 #: ../fish/guestfish-actions.pod:4129
26527 " setxattr xattr val vallen path\n"
26532 #: ../fish/guestfish-actions.pod:4135
26533 msgid "See also: L</lsetxattr>, L<attr(5)>."
26537 #: ../fish/guestfish-actions.pod:4137
26542 #: ../fish/guestfish-actions.pod:4139
26545 " sfdisk device cyls heads sectors 'lines ...'\n"
26550 #: ../fish/guestfish-actions.pod:4161
26551 msgid "See also: L</sfdisk-l>, L</sfdisk-N>, L</part-init>"
26555 #: ../fish/guestfish-actions.pod:4167
26560 #: ../fish/guestfish-actions.pod:4169
26563 " sfdiskM device 'lines ...'\n"
26568 #: ../fish/guestfish-actions.pod:4171
26570 "This is a simplified interface to the L</sfdisk> command, where partition "
26571 "sizes are specified in megabytes only (rounded to the nearest cylinder) and "
26572 "you don't need to specify the cyls, heads and sectors parameters which were "
26573 "rarely if ever used anyway."
26577 #: ../fish/guestfish-actions.pod:4177
26578 msgid "See also: L</sfdisk>, the L<sfdisk(8)> manpage and L</part-disk>"
26582 #: ../fish/guestfish-actions.pod:4183
26587 #: ../fish/guestfish-actions.pod:4185
26590 " sfdisk-N device partnum cyls heads sectors line\n"
26595 #: ../fish/guestfish-actions.pod:4190
26597 "For other parameters, see L</sfdisk>. You should usually pass C<0> for the "
26598 "cyls/heads/sectors parameters."
26602 #: ../fish/guestfish-actions.pod:4193
26603 msgid "See also: L</part-add>"
26607 #: ../fish/guestfish-actions.pod:4198
26608 msgid "sfdisk-disk-geometry"
26612 #: ../fish/guestfish-actions.pod:4200
26615 " sfdisk-disk-geometry device\n"
26620 #: ../fish/guestfish-actions.pod:4202
26622 "This displays the disk geometry of C<device> read from the partition table. "
26623 "Especially in the case where the underlying block device has been resized, "
26624 "this can be different from the kernel's idea of the geometry (see L</sfdisk-"
26625 "kernel-geometry>)."
26629 #: ../fish/guestfish-actions.pod:4210
26630 msgid "sfdisk-kernel-geometry"
26634 #: ../fish/guestfish-actions.pod:4212
26637 " sfdisk-kernel-geometry device\n"
26642 #: ../fish/guestfish-actions.pod:4219
26647 #: ../fish/guestfish-actions.pod:4221
26650 " sfdisk-l device\n"
26655 #: ../fish/guestfish-actions.pod:4227
26656 msgid "See also: L</part-list>"
26660 #: ../fish/guestfish-actions.pod:4229
26665 #: ../fish/guestfish-actions.pod:4231
26673 #: ../fish/guestfish-actions.pod:4236
26674 msgid "This is like L</command>, but passes the command to:"
26678 #: ../fish/guestfish-actions.pod:4244
26679 msgid "All the provisos about L</command> apply to this call."
26683 #: ../fish/guestfish-actions.pod:4246
26688 #: ../fish/guestfish-actions.pod:4248
26691 " sh-lines command\n"
26696 #: ../fish/guestfish-actions.pod:4250
26697 msgid "This is the same as L</sh>, but splits the result into a list of lines."
26701 #: ../fish/guestfish-actions.pod:4253
26702 msgid "See also: L</command-lines>"
26706 #: ../fish/guestfish-actions.pod:4255
26711 #: ../fish/guestfish-actions.pod:4257
26719 #: ../fish/guestfish-actions.pod:4261
26724 #: ../fish/guestfish-actions.pod:4263
26732 #: ../fish/guestfish-actions.pod:4269
26737 #: ../fish/guestfish-actions.pod:4271
26745 #: ../fish/guestfish-actions.pod:4279
26750 #: ../fish/guestfish-actions.pod:4281
26758 #: ../fish/guestfish-actions.pod:4289
26763 #: ../fish/guestfish-actions.pod:4291
26766 " strings-e encoding path\n"
26771 #: ../fish/guestfish-actions.pod:4293
26773 "This is like the L</strings> command, but allows you to specify the encoding "
26774 "of strings that are looked for in the source file C<path>."
26778 #: ../fish/guestfish-actions.pod:4303
26780 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
26781 "ISO-8859-X (this is what L</strings> uses)."
26785 #: ../fish/guestfish-actions.pod:4335
26786 msgid "swapoff-device"
26790 #: ../fish/guestfish-actions.pod:4337
26793 " swapoff-device device\n"
26798 #: ../fish/guestfish-actions.pod:4339
26800 "This command disables the libguestfs appliance swap device or partition "
26801 "named C<device>. See L</swapon-device>."
26805 #: ../fish/guestfish-actions.pod:4343
26806 msgid "swapoff-file"
26810 #: ../fish/guestfish-actions.pod:4345
26813 " swapoff-file file\n"
26818 #: ../fish/guestfish-actions.pod:4349
26819 msgid "swapoff-label"
26823 #: ../fish/guestfish-actions.pod:4351
26826 " swapoff-label label\n"
26831 #: ../fish/guestfish-actions.pod:4356
26832 msgid "swapoff-uuid"
26836 #: ../fish/guestfish-actions.pod:4358
26839 " swapoff-uuid uuid\n"
26844 #: ../fish/guestfish-actions.pod:4363
26845 msgid "swapon-device"
26849 #: ../fish/guestfish-actions.pod:4365
26852 " swapon-device device\n"
26857 #: ../fish/guestfish-actions.pod:4367
26859 "This command enables the libguestfs appliance to use the swap device or "
26860 "partition named C<device>. The increased memory is made available for all "
26861 "commands, for example those run using L</command> or L</sh>."
26865 #: ../fish/guestfish-actions.pod:4379
26866 msgid "swapon-file"
26870 #: ../fish/guestfish-actions.pod:4381
26873 " swapon-file file\n"
26878 #: ../fish/guestfish-actions.pod:4383
26880 "This command enables swap to a file. See L</swapon-device> for other notes."
26884 #: ../fish/guestfish-actions.pod:4386
26885 msgid "swapon-label"
26889 #: ../fish/guestfish-actions.pod:4388
26892 " swapon-label label\n"
26897 #: ../fish/guestfish-actions.pod:4390
26899 "This command enables swap to a labeled swap partition. See L</swapon-"
26900 "device> for other notes."
26904 #: ../fish/guestfish-actions.pod:4393
26905 msgid "swapon-uuid"
26909 #: ../fish/guestfish-actions.pod:4395
26912 " swapon-uuid uuid\n"
26917 #: ../fish/guestfish-actions.pod:4397
26919 "This command enables swap to a swap partition with the given UUID. See L</"
26920 "swapon-device> for other notes."
26924 #: ../fish/guestfish-actions.pod:4400
26929 #: ../fish/guestfish-actions.pod:4402
26937 #: ../fish/guestfish-actions.pod:4410
26942 #: ../fish/guestfish-actions.pod:4412
26950 #: ../fish/guestfish-actions.pod:4420
26955 #: ../fish/guestfish-actions.pod:4422
26958 " tail-n nrlines path\n"
26963 #: ../fish/guestfish-actions.pod:4435
26968 #: ../fish/guestfish-actions.pod:4437
26971 " tar-in (tarfile|-) directory\n"
26976 #: ../fish/guestfish-actions.pod:4442
26977 msgid "To upload a compressed tarball, use L</tgz-in> or L</txz-in>."
26981 #: ../fish/guestfish-actions.pod:4447
26986 #: ../fish/guestfish-actions.pod:4449
26989 " tar-out directory (tarfile|-)\n"
26994 #: ../fish/guestfish-actions.pod:4454
26995 msgid "To download a compressed tarball, use L</tgz-out> or L</txz-out>."
26999 #: ../fish/guestfish-actions.pod:4459
27004 #: ../fish/guestfish-actions.pod:4461
27007 " tgz-in (tarball|-) directory\n"
27012 #: ../fish/guestfish-actions.pod:4466
27013 msgid "To upload an uncompressed tarball, use L</tar-in>."
27017 #: ../fish/guestfish-actions.pod:4470
27022 #: ../fish/guestfish-actions.pod:4472
27025 " tgz-out directory (tarball|-)\n"
27030 #: ../fish/guestfish-actions.pod:4477
27031 msgid "To download an uncompressed tarball, use L</tar-out>."
27035 #: ../fish/guestfish-actions.pod:4481
27040 #: ../fish/guestfish-actions.pod:4483
27048 #: ../fish/guestfish-actions.pod:4492
27053 #: ../fish/guestfish-actions.pod:4494
27061 #: ../fish/guestfish-actions.pod:4499
27062 msgid "truncate-size"
27066 #: ../fish/guestfish-actions.pod:4501
27069 " truncate-size path size\n"
27074 #: ../fish/guestfish-actions.pod:4506
27076 "If the current file size is less than C<size> then the file is extended to "
27077 "the required size with zero bytes. This creates a sparse file (ie. disk "
27078 "blocks are not allocated for the file until you write to it). To create a "
27079 "non-sparse file of zeroes, use L</fallocate64> instead."
27083 #: ../fish/guestfish-actions.pod:4512
27088 #: ../fish/guestfish-actions.pod:4514
27091 " tune2fs-l device\n"
27096 #: ../fish/guestfish-actions.pod:4524
27101 #: ../fish/guestfish-actions.pod:4526
27104 " txz-in (tarball|-) directory\n"
27109 #: ../fish/guestfish-actions.pod:4533
27114 #: ../fish/guestfish-actions.pod:4535
27117 " txz-out directory (tarball|-)\n"
27122 #: ../fish/guestfish-actions.pod:4542
27127 #: ../fish/guestfish-actions.pod:4544
27135 #: ../fish/guestfish-actions.pod:4558
27136 msgid "See also L</get-umask>, L<umask(2)>, L</mknod>, L</mkdir>."
27140 #: ../fish/guestfish-actions.pod:4563
27145 #: ../fish/guestfish-actions.pod:4565
27150 #: ../fish/guestfish-actions.pod:4567
27153 " umount pathordevice\n"
27158 #: ../fish/guestfish-actions.pod:4573
27163 #: ../fish/guestfish-actions.pod:4575
27164 msgid "unmount-all"
27168 #: ../fish/guestfish-actions.pod:4577
27176 #: ../fish/guestfish-actions.pod:4583
27181 #: ../fish/guestfish-actions.pod:4585
27184 " upload (filename|-) remotefilename\n"
27189 #: ../fish/guestfish-actions.pod:4592
27190 msgid "See also L</download>."
27194 #: ../fish/guestfish-actions.pod:4596
27195 msgid "upload-offset"
27199 #: ../fish/guestfish-actions.pod:4598
27202 " upload-offset (filename|-) remotefilename offset\n"
27207 #: ../fish/guestfish-actions.pod:4610
27209 "Note that there is no limit on the amount of data that can be uploaded with "
27210 "this call, unlike with L</pwrite>, and this call always writes the full "
27211 "amount unless an error occurs."
27215 #: ../fish/guestfish-actions.pod:4615
27216 msgid "See also L</upload>, L</pwrite>."
27220 #: ../fish/guestfish-actions.pod:4619
27225 #: ../fish/guestfish-actions.pod:4621
27228 " utimens path atsecs atnsecs mtsecs mtnsecs\n"
27233 #: ../fish/guestfish-actions.pod:4640
27238 #: ../fish/guestfish-actions.pod:4642
27246 #: ../fish/guestfish-actions.pod:4669
27248 "I<Note:> Don't use this call to test for availability of features. In "
27249 "enterprise distributions we backport features from later versions into "
27250 "earlier versions, making this an unreliable way to test for features. Use "
27251 "L</available> instead."
27255 #: ../fish/guestfish-actions.pod:4675
27260 #: ../fish/guestfish-actions.pod:4677
27263 " vfs-label device\n"
27268 #: ../fish/guestfish-actions.pod:4684
27269 msgid "To find a filesystem from the label, use L</findfs-label>."
27273 #: ../fish/guestfish-actions.pod:4686
27278 #: ../fish/guestfish-actions.pod:4688
27281 " vfs-type device\n"
27286 #: ../fish/guestfish-actions.pod:4698
27291 #: ../fish/guestfish-actions.pod:4700
27294 " vfs-uuid device\n"
27299 #: ../fish/guestfish-actions.pod:4707
27300 msgid "To find a filesystem from the UUID, use L</findfs-uuid>."
27304 #: ../fish/guestfish-actions.pod:4709
27305 msgid "vg-activate"
27309 #: ../fish/guestfish-actions.pod:4711
27312 " vg-activate true|false 'volgroups ...'\n"
27317 #: ../fish/guestfish-actions.pod:4724
27318 msgid "vg-activate-all"
27322 #: ../fish/guestfish-actions.pod:4726
27325 " vg-activate-all true|false\n"
27330 #: ../fish/guestfish-actions.pod:4736
27335 #: ../fish/guestfish-actions.pod:4738
27338 " vgcreate volgroup 'physvols ...'\n"
27343 #: ../fish/guestfish-actions.pod:4743
27348 #: ../fish/guestfish-actions.pod:4745
27351 " vglvuuids vgname\n"
27356 #: ../fish/guestfish-actions.pod:4750
27358 "You can use this along with L</lvs> and L</lvuuid> calls to associate "
27359 "logical volumes and volume groups."
27363 #: ../fish/guestfish-actions.pod:4753
27364 msgid "See also L</vgpvuuids>."
27368 #: ../fish/guestfish-actions.pod:4755
27373 #: ../fish/guestfish-actions.pod:4757
27376 " vgpvuuids vgname\n"
27381 #: ../fish/guestfish-actions.pod:4762
27383 "You can use this along with L</pvs> and L</pvuuid> calls to associate "
27384 "physical volumes and volume groups."
27388 #: ../fish/guestfish-actions.pod:4765
27389 msgid "See also L</vglvuuids>."
27393 #: ../fish/guestfish-actions.pod:4767
27398 #: ../fish/guestfish-actions.pod:4769
27401 " vgremove vgname\n"
27406 #: ../fish/guestfish-actions.pod:4776
27411 #: ../fish/guestfish-actions.pod:4778
27414 " vgrename volgroup newvolgroup\n"
27419 #: ../fish/guestfish-actions.pod:4782
27424 #: ../fish/guestfish-actions.pod:4784
27432 #: ../fish/guestfish-actions.pod:4792
27433 msgid "See also L</vgs-full>."
27437 #: ../fish/guestfish-actions.pod:4794
27442 #: ../fish/guestfish-actions.pod:4796
27450 #: ../fish/guestfish-actions.pod:4801
27455 #: ../fish/guestfish-actions.pod:4803
27463 #: ../fish/guestfish-actions.pod:4808
27468 #: ../fish/guestfish-actions.pod:4810
27476 #: ../fish/guestfish-actions.pod:4814
27481 #: ../fish/guestfish-actions.pod:4816
27489 #: ../fish/guestfish-actions.pod:4821
27494 #: ../fish/guestfish-actions.pod:4823
27502 #: ../fish/guestfish-actions.pod:4828
27507 #: ../fish/guestfish-actions.pod:4830
27515 #: ../fish/guestfish-actions.pod:4835
27520 #: ../fish/guestfish-actions.pod:4837
27523 " write path content\n"
27528 #: ../fish/guestfish-actions.pod:4845
27533 #: ../fish/guestfish-actions.pod:4847
27536 " write-file path content size\n"
27541 #: ../fish/guestfish-actions.pod:4870
27546 #: ../fish/guestfish-actions.pod:4872
27549 " zegrep regex path\n"
27554 #: ../fish/guestfish-actions.pod:4880
27559 #: ../fish/guestfish-actions.pod:4882
27562 " zegrepi regex path\n"
27567 #: ../fish/guestfish-actions.pod:4890
27572 #: ../fish/guestfish-actions.pod:4892
27580 #: ../fish/guestfish-actions.pod:4900
27581 msgid "See also: L</zero-device>, L</scrub-device>."
27585 #: ../fish/guestfish-actions.pod:4902
27586 msgid "zero-device"
27590 #: ../fish/guestfish-actions.pod:4904
27593 " zero-device device\n"
27598 #: ../fish/guestfish-actions.pod:4906
27600 "This command writes zeroes over the entire C<device>. Compare with L</zero> "
27601 "which just zeroes the first few blocks of a device."
27605 #: ../fish/guestfish-actions.pod:4913
27610 #: ../fish/guestfish-actions.pod:4915
27613 " zerofree device\n"
27618 #: ../fish/guestfish-actions.pod:4928
27623 #: ../fish/guestfish-actions.pod:4930
27626 " zfgrep pattern path\n"
27631 #: ../fish/guestfish-actions.pod:4938
27636 #: ../fish/guestfish-actions.pod:4940
27639 " zfgrepi pattern path\n"
27644 #: ../fish/guestfish-actions.pod:4948
27649 #: ../fish/guestfish-actions.pod:4950
27652 " zfile meth path\n"
27657 #: ../fish/guestfish-actions.pod:4957
27659 "Since 1.0.63, use L</file> instead which can now process compressed files."
27663 #: ../fish/guestfish-actions.pod:4967
27668 #: ../fish/guestfish-actions.pod:4969
27671 " zgrep regex path\n"
27676 #: ../fish/guestfish-actions.pod:4977
27681 #: ../fish/guestfish-actions.pod:4979
27684 " zgrepi regex path\n"
27689 #: ../fish/guestfish-commands.pod:1
27694 #: ../fish/guestfish-commands.pod:3
27699 #: ../fish/guestfish-commands.pod:5
27702 " alloc filename size\n"
27707 #: ../fish/guestfish-commands.pod:7
27709 "This creates an empty (zeroed) file of the given size, and then adds so it "
27710 "can be further examined."
27714 #: ../fish/guestfish-commands.pod:10 ../fish/guestfish-commands.pod:168
27715 msgid "For more advanced image creation, see L<qemu-img(1)> utility."
27719 #: ../fish/guestfish-commands.pod:12 ../fish/guestfish-commands.pod:170
27720 msgid "Size can be specified using standard suffixes, eg. C<1M>."
27724 #: ../fish/guestfish-commands.pod:14
27726 "To create a sparse file, use L</sparse> instead. To create a prepared disk "
27727 "image, see L</PREPARED DISK IMAGES>."
27731 #: ../fish/guestfish-commands.pod:17
27736 #: ../fish/guestfish-commands.pod:19
27739 " copy-in local [local ...] /remotedir\n"
27744 #: ../fish/guestfish-commands.pod:21
27746 "C<copy-in> copies local files or directories recursively into the disk "
27747 "image, placing them in the directory called C</remotedir> (which must "
27748 "exist). This guestfish meta-command turns into a sequence of L</tar-in> and "
27749 "other commands as necessary."
27753 #: ../fish/guestfish-commands.pod:26
27755 "Multiple local files and directories can be specified, but the last "
27756 "parameter must always be a remote directory. Wildcards cannot be used."
27760 #: ../fish/guestfish-commands.pod:30
27765 #: ../fish/guestfish-commands.pod:32
27768 " copy-out remote [remote ...] localdir\n"
27773 #: ../fish/guestfish-commands.pod:34
27775 "C<copy-out> copies remote files or directories recursively out of the disk "
27776 "image, placing them on the host disk in a local directory called C<localdir> "
27777 "(which must exist). This guestfish meta-command turns into a sequence of L</"
27778 "download>, L</tar-out> and other commands as necessary."
27782 #: ../fish/guestfish-commands.pod:40
27784 "Multiple remote files and directories can be specified, but the last "
27785 "parameter must always be a local directory. To download to the current "
27786 "directory, use C<.> as in:"
27790 #: ../fish/guestfish-commands.pod:44
27793 " copy-out /home .\n"
27798 #: ../fish/guestfish-commands.pod:46
27800 "Wildcards cannot be used in the ordinary command, but you can use them with "
27801 "the help of L</glob> like this:"
27805 #: ../fish/guestfish-commands.pod:49
27808 " glob copy-out /home/* .\n"
27813 #: ../fish/guestfish-commands.pod:51
27818 #: ../fish/guestfish-commands.pod:53
27821 " echo [params ...]\n"
27826 #: ../fish/guestfish-commands.pod:55
27827 msgid "This echos the parameters to the terminal."
27831 #: ../fish/guestfish-commands.pod:57
27836 #: ../fish/guestfish-commands.pod:59
27841 #: ../fish/guestfish-commands.pod:61
27846 #: ../fish/guestfish-commands.pod:63
27854 #: ../fish/guestfish-commands.pod:65
27856 "This is used to edit a file. It downloads the file, edits it locally using "
27857 "your editor, then uploads the result."
27861 #: ../fish/guestfish-commands.pod:68
27863 "The editor is C<$EDITOR>. However if you use the alternate commands C<vi> "
27864 "or C<emacs> you will get those corresponding editors."
27868 #: ../fish/guestfish-commands.pod:72
27873 #: ../fish/guestfish-commands.pod:74
27876 " glob command args...\n"
27881 #: ../fish/guestfish-commands.pod:76
27883 "Expand wildcards in any paths in the args list, and run C<command> "
27884 "repeatedly on each matching path."
27888 #: ../fish/guestfish-commands.pod:79
27889 msgid "See L</WILDCARDS AND GLOBBING>."
27893 #: ../fish/guestfish-commands.pod:81
27898 #: ../fish/guestfish-commands.pod:83
27901 " hexedit <filename|device>\n"
27902 " hexedit <filename|device> <max>\n"
27903 " hexedit <filename|device> <start> <max>\n"
27908 #: ../fish/guestfish-commands.pod:87
27910 "Use hexedit (a hex editor) to edit all or part of a binary file or block "
27915 #: ../fish/guestfish-commands.pod:90
27917 "This command works by downloading potentially the whole file or device, "
27918 "editing it locally, then uploading it. If the file or device is large, you "
27919 "have to specify which part you wish to edit by using C<max> and/or C<start> "
27920 "C<max> parameters. C<start> and C<max> are specified in bytes, with the "
27921 "usual modifiers allowed such as C<1M> (1 megabyte)."
27925 #: ../fish/guestfish-commands.pod:97
27926 msgid "For example to edit the first few sectors of a disk you might do:"
27930 #: ../fish/guestfish-commands.pod:100
27933 " hexedit /dev/sda 1M\n"
27938 #: ../fish/guestfish-commands.pod:102
27940 "which would allow you to edit anywhere within the first megabyte of the disk."
27944 #: ../fish/guestfish-commands.pod:105
27945 msgid "To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:"
27949 #: ../fish/guestfish-commands.pod:107
27952 " hexedit /dev/sda1 0x400 0x400\n"
27957 #: ../fish/guestfish-commands.pod:109
27958 msgid "(assuming the superblock is in the standard location)."
27962 #: ../fish/guestfish-commands.pod:111
27964 "This command requires the external L<hexedit(1)> program. You can specify "
27965 "another program to use by setting the C<HEXEDITOR> environment variable."
27969 #: ../fish/guestfish-commands.pod:115
27970 msgid "See also L</hexdump>."
27974 #: ../fish/guestfish-commands.pod:117
27979 #: ../fish/guestfish-commands.pod:119
27987 #: ../fish/guestfish-commands.pod:121
27989 "Change the local directory, ie. the current directory of guestfish itself."
27993 #: ../fish/guestfish-commands.pod:124
27994 msgid "Note that C<!cd> won't do what you might expect."
27998 #: ../fish/guestfish-commands.pod:126
28003 #: ../fish/guestfish-commands.pod:128
28008 #: ../fish/guestfish-commands.pod:130
28016 #: ../fish/guestfish-commands.pod:132
28017 msgid "Opens the manual page for guestfish."
28021 #: ../fish/guestfish-commands.pod:134
28026 #: ../fish/guestfish-commands.pod:136
28031 #: ../fish/guestfish-commands.pod:138
28039 #: ../fish/guestfish-commands.pod:140
28047 #: ../fish/guestfish-commands.pod:142
28048 msgid "This is used to view a file."
28052 #: ../fish/guestfish-commands.pod:144
28054 "The default viewer is C<$PAGER>. However if you use the alternate command "
28055 "C<less> you will get the C<less> command specifically."
28059 #: ../fish/guestfish-commands.pod:147
28064 #: ../fish/guestfish-commands.pod:149
28072 #: ../fish/guestfish-commands.pod:151
28074 "Close and reopen the libguestfs handle. It is not necessary to use this "
28075 "normally, because the handle is closed properly when guestfish exits. "
28076 "However this is occasionally useful for testing."
28080 #: ../fish/guestfish-commands.pod:155
28085 #: ../fish/guestfish-commands.pod:157
28088 " sparse filename size\n"
28093 #: ../fish/guestfish-commands.pod:159
28095 "This creates an empty sparse file of the given size, and then adds so it can "
28096 "be further examined."
28100 #: ../fish/guestfish-commands.pod:162
28102 "In all respects it works the same as the L</alloc> command, except that the "
28103 "image file is allocated sparsely, which means that disk blocks are not "
28104 "assigned to the file until they are needed. Sparse disk files only use "
28105 "space when written to, but they are slower and there is a danger you could "
28106 "run out of real disk space during a write operation."
28110 #: ../fish/guestfish-commands.pod:172
28115 #: ../fish/guestfish-commands.pod:174
28123 #: ../fish/guestfish-commands.pod:176
28125 "This command returns a list of the optional groups known to the daemon, and "
28126 "indicates which ones are supported by this build of the libguestfs appliance."
28130 #: ../fish/guestfish-commands.pod:180
28131 msgid "See also L<guestfs(3)/AVAILABILITY>."
28135 #: ../fish/guestfish-commands.pod:182
28140 #: ../fish/guestfish-commands.pod:184
28143 " time command args...\n"
28148 #: ../fish/guestfish-commands.pod:186
28150 "Run the command as usual, but print the elapsed time afterwards. This can "
28151 "be useful for benchmarking operations."
28155 #: ../test-tool/libguestfs-test-tool.pod:5
28156 msgid "libguestfs-test-tool - End user tests for libguestfs"
28160 #: ../test-tool/libguestfs-test-tool.pod:9
28163 " libguestfs-test-tool [--options]\n"
28168 #: ../test-tool/libguestfs-test-tool.pod:13
28170 "libguestfs-test-tool is a test program shipped with libguestfs to end users "
28171 "and developers, to allow them to check basic libguestfs functionality is "
28172 "working. This is needed because libguestfs occasionally breaks for reasons "
28173 "beyond our control: usually because of changes in the underlying qemu or "
28174 "kernel packages, or the host environment."
28178 #: ../test-tool/libguestfs-test-tool.pod:20
28179 msgid "If you suspect a problem in libguestfs, then just run:"
28183 #: ../test-tool/libguestfs-test-tool.pod:22
28186 " libguestfs-test-tool\n"
28191 #: ../test-tool/libguestfs-test-tool.pod:24
28192 msgid "It will print lots of diagnostic messages."
28196 #: ../test-tool/libguestfs-test-tool.pod:26
28197 msgid "If it runs to completion successfully, you will see this near the end:"
28201 #: ../test-tool/libguestfs-test-tool.pod:28
28204 " ===== TEST FINISHED OK =====\n"
28209 #: ../test-tool/libguestfs-test-tool.pod:30
28210 msgid "and the test tool will exit with code 0."
28214 #: ../test-tool/libguestfs-test-tool.pod:32
28216 "If it fails (and/or exits with non-zero error code), please paste the "
28217 "B<complete, unedited> output of the test tool into a bug report. More "
28218 "information about reporting bugs can be found on the L<http://libguestfs.org/"
28223 #: ../test-tool/libguestfs-test-tool.pod:41
28228 #: ../test-tool/libguestfs-test-tool.pod:43
28229 msgid "Display short usage information and exit."
28233 #: ../test-tool/libguestfs-test-tool.pod:45
28234 msgid "I<--qemu qemu_binary>"
28238 #: ../test-tool/libguestfs-test-tool.pod:47
28240 "If you have downloaded another qemu binary, point this option at the full "
28241 "path of the binary to try it."
28245 #: ../test-tool/libguestfs-test-tool.pod:50
28246 msgid "I<--qemudir qemu_source_dir>"
28250 #: ../test-tool/libguestfs-test-tool.pod:52
28252 "If you have compiled qemu from source, point this option at the source "
28253 "directory to try it."
28257 #: ../test-tool/libguestfs-test-tool.pod:55
28258 msgid "I<--timeout N>"
28262 #: ../test-tool/libguestfs-test-tool.pod:57
28264 "Set the launch timeout to C<N> seconds. The default is 120 seconds which "
28265 "does not usually need to be adjusted unless your machine is very slow."
28269 #: ../test-tool/libguestfs-test-tool.pod:63
28270 msgid "TRYING OUT A DIFFERENT VERSION OF QEMU"
28274 #: ../test-tool/libguestfs-test-tool.pod:65
28276 "If you have compiled another version of qemu from source and would like to "
28277 "try that, then you can use the I<--qemudir> option to point to the qemu "
28278 "source directory."
28282 #: ../test-tool/libguestfs-test-tool.pod:69
28284 "If you have downloaded a qemu binary from somewhere, use the I<--qemu> "
28285 "option to point to the binary."
28289 #: ../test-tool/libguestfs-test-tool.pod:72
28291 "When using an alternate qemu with libguestfs, usually you would need to "
28292 "write a qemu wrapper script (see section I<QEMU WRAPPERS> in L<guestfs(3)"
28293 ">). libguestfs-test-tool writes a temporary qemu wrapper script when you "
28294 "use either of the I<--qemudir> or I<--qemu> options."
28298 #: ../test-tool/libguestfs-test-tool.pod:79
28300 "libguestfs-test-tool returns I<0> if the tests completed without error, or "
28301 "I<1> if there was an error."
28305 #: ../test-tool/libguestfs-test-tool.pod:84
28307 "For the full list of environment variables which may affect libguestfs, "
28308 "please see the L<guestfs(3)> manual page."
28312 #: ../test-tool/libguestfs-test-tool.pod:89
28313 msgid "L<guestfs(3)>, L<http://libguestfs.org/>, L<http://qemu.org/>."
28317 #: ../fuse/guestmount.pod:5
28319 "guestmount - Mount a guest filesystem on the host using FUSE and libguestfs"
28323 #: ../fuse/guestmount.pod:9
28326 " guestmount [--options] -a disk.img -m device [--ro] mountpoint\n"
28331 #: ../fuse/guestmount.pod:11
28334 " guestmount [--options] -a disk.img -i [--ro] mountpoint\n"
28339 #: ../fuse/guestmount.pod:13
28342 " guestmount [--options] -d Guest -i [--ro] mountpoint\n"
28347 #: ../fuse/guestmount.pod:17
28349 "You must I<not> use C<guestmount> in read-write mode on live virtual "
28350 "machines. If you do this, you risk disk corruption in the VM."
28354 #: ../fuse/guestmount.pod:22
28356 "The guestmount program can be used to mount virtual machine filesystems and "
28357 "other disk images on the host. It uses libguestfs for access to the guest "
28358 "filesystem, and FUSE (the \"filesystem in userspace\") to make it appear as "
28359 "a mountable device."
28363 #: ../fuse/guestmount.pod:27
28365 "Along with other options, you have to give at least one device (I<-a> "
28366 "option) or libvirt domain (I<-d> option), and at least one mountpoint (I<-m> "
28367 "option) or use the I<-i> inspection option. How this works is better "
28368 "explained in the L<guestfish(1)> manual page, or by looking at the examples "
28373 #: ../fuse/guestmount.pod:33
28375 "FUSE lets you mount filesystems as non-root. The mountpoint must be owned "
28376 "by you, and the filesystem will not be visible to any other users unless you "
28377 "make certain global configuration changes to C</etc/fuse.conf>. To unmount "
28378 "the filesystem, use the C<fusermount -u> command."
28382 #: ../fuse/guestmount.pod:41
28384 "For a typical Windows guest which has its main filesystem on the first "
28389 #: ../fuse/guestmount.pod:44
28392 " guestmount -a windows.img -m /dev/sda1 --ro /mnt\n"
28397 #: ../fuse/guestmount.pod:46
28399 "For a typical Linux guest which has a /boot filesystem on the first "
28400 "partition, and the root filesystem on a logical volume:"
28404 #: ../fuse/guestmount.pod:49
28407 " guestmount -a linux.img -m /dev/VG/LV -m /dev/sda1:/boot --ro /mnt\n"
28412 #: ../fuse/guestmount.pod:51
28413 msgid "To get libguestfs to detect guest mountpoints for you:"
28417 #: ../fuse/guestmount.pod:53
28420 " guestmount -a guest.img -i --ro /mnt\n"
28425 #: ../fuse/guestmount.pod:55
28426 msgid "For a libvirt guest called \"Guest\" you could do:"
28430 #: ../fuse/guestmount.pod:57
28433 " guestmount -d Guest -i --ro /mnt\n"
28438 #: ../fuse/guestmount.pod:59
28440 "If you don't know what filesystems are contained in a guest or disk image, "
28441 "use L<virt-filesystems(1)> first:"
28445 #: ../fuse/guestmount.pod:62
28448 " virt-filesystems MyGuest\n"
28453 #: ../fuse/guestmount.pod:64
28455 "If you want to trace the libguestfs calls but without excessive debugging "
28456 "information, we recommend:"
28460 #: ../fuse/guestmount.pod:67
28463 " guestmount [...] --trace /mnt\n"
28468 #: ../fuse/guestmount.pod:69
28469 msgid "If you want to debug the program, we recommend:"
28473 #: ../fuse/guestmount.pod:71
28476 " guestmount [...] --trace --verbose /mnt\n"
28481 #: ../fuse/guestmount.pod:77
28482 msgid "B<-a image> | B<--add image>"
28486 #: ../fuse/guestmount.pod:79
28487 msgid "Add a block device or virtual machine image."
28491 #: ../fuse/guestmount.pod:84
28492 msgid "B<-c URI> | B<--connect URI>"
28496 #: ../fuse/guestmount.pod:90
28497 msgid "B<-d libvirt-domain> | B<--domain libvirt-domain>"
28501 #: ../fuse/guestmount.pod:96
28502 msgid "B<--dir-cache-timeout N>"
28506 #: ../fuse/guestmount.pod:98
28508 "Set the readdir cache timeout to I<N> seconds, the default being 60 "
28509 "seconds. The readdir cache [actually, there are several semi-independent "
28510 "caches] is populated after a readdir(2) call with the stat and extended "
28511 "attributes of the files in the directory, in anticipation that they will be "
28512 "requested soon after."
28516 #: ../fuse/guestmount.pod:104
28518 "There is also a different attribute cache implemented by FUSE (see the FUSE "
28519 "option I<-o attr_timeout>), but the FUSE cache does not anticipate future "
28520 "requests, only cache existing ones."
28524 #: ../fuse/guestmount.pod:115
28525 msgid "B<--format=raw|qcow2|..> | B<--format>"
28529 #: ../fuse/guestmount.pod:122
28531 "If you have untrusted raw-format guest disk images, you should use this "
28532 "option to specify the disk format. This avoids a possible security problem "
28533 "with malicious guests (CVE-2010-3851). See also L<guestfs(3)/"
28534 "guestfs_add_drive_opts>."
28538 #: ../fuse/guestmount.pod:127
28539 msgid "B<--fuse-help>"
28543 #: ../fuse/guestmount.pod:129
28544 msgid "Display help on special FUSE options (see I<-o> below)."
28548 #: ../fuse/guestmount.pod:133
28549 msgid "Display brief help and exit."
28553 #: ../fuse/guestmount.pod:135
28554 msgid "B<-i> | B<--inspector>"
28558 #: ../fuse/guestmount.pod:155
28560 "Mount the named partition or logical volume on the given mountpoint B<in the "
28561 "guest> (this has nothing to do with mountpoints in the host)."
28565 #: ../fuse/guestmount.pod:158
28567 "If the mountpoint is omitted, it defaults to C</>. You have to mount "
28568 "something on C</>."
28572 #: ../fuse/guestmount.pod:171
28573 msgid "B<-n> | B<--no-sync>"
28577 #: ../fuse/guestmount.pod:173
28579 "By default, we attempt to sync the guest disk when the FUSE mountpoint is "
28580 "unmounted. If you specify this option, then we don't attempt to sync the "
28581 "disk. See the discussion of autosync in the L<guestfs(3)> manpage."
28585 #: ../fuse/guestmount.pod:178
28586 msgid "B<-o option> | B<--option option>"
28590 #: ../fuse/guestmount.pod:180
28591 msgid "Pass extra options to FUSE."
28595 #: ../fuse/guestmount.pod:182
28597 "To get a list of all the extra options supported by FUSE, use the command "
28598 "below. Note that only the FUSE I<-o> options can be passed, and only some "
28599 "of them are a good idea."
28603 #: ../fuse/guestmount.pod:186
28606 " guestmount --fuse-help\n"
28611 #: ../fuse/guestmount.pod:188
28612 msgid "Some potentially useful FUSE options:"
28616 #: ../fuse/guestmount.pod:192
28617 msgid "B<-o allow_other>"
28621 #: ../fuse/guestmount.pod:194
28622 msgid "Allow other users to see the filesystem."
28626 #: ../fuse/guestmount.pod:196
28627 msgid "B<-o attr_timeout=N>"
28631 #: ../fuse/guestmount.pod:198
28632 msgid "Enable attribute caching by FUSE, and set the timeout to I<N> seconds."
28636 #: ../fuse/guestmount.pod:200
28637 msgid "B<-o kernel_cache>"
28641 #: ../fuse/guestmount.pod:202
28643 "Allow the kernel to cache files (reduces the number of reads that have to go "
28644 "through the L<guestfs(3)> API). This is generally a good idea if you can "
28645 "afford the extra memory usage."
28649 #: ../fuse/guestmount.pod:206
28650 msgid "B<-o uid=N> B<-o gid=N>"
28654 #: ../fuse/guestmount.pod:208
28656 "Use these options to map all UIDs and GIDs inside the guest filesystem to "
28657 "the chosen values."
28661 #: ../fuse/guestmount.pod:213
28662 msgid "B<-r> | B<--ro>"
28666 #: ../fuse/guestmount.pod:215
28668 "Add devices and mount everything read-only. Also disallow writes and make "
28669 "the disk appear read-only to FUSE."
28673 #: ../fuse/guestmount.pod:218
28675 "This is highly recommended if you are not going to edit the guest disk. If "
28676 "the guest is running and this option is I<not> supplied, then there is a "
28677 "strong risk of disk corruption in the guest. We try to prevent this from "
28678 "happening, but it is not always possible."
28682 #: ../fuse/guestmount.pod:223
28683 msgid "See also L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
28687 #: ../fuse/guestmount.pod:227
28688 msgid "Enable SELinux support for the guest."
28692 #: ../fuse/guestmount.pod:229
28693 msgid "B<-v> | B<--verbose>"
28697 #: ../fuse/guestmount.pod:231
28698 msgid "Enable verbose messages from underlying libguestfs."
28702 #: ../fuse/guestmount.pod:233
28703 msgid "B<-V> | B<--version>"
28707 #: ../fuse/guestmount.pod:235
28708 msgid "Display the program version and exit."
28712 #: ../fuse/guestmount.pod:237
28713 msgid "B<-w> | B<--rw>"
28717 #: ../fuse/guestmount.pod:242 ../fuse/guestmount.pod:263
28718 msgid "See L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
28722 #: ../fuse/guestmount.pod:244
28723 msgid "B<-x> | B<--trace>"
28727 #: ../fuse/guestmount.pod:246
28728 msgid "Trace libguestfs calls and entry into each FUSE function."
28732 #: ../fuse/guestmount.pod:248
28733 msgid "This also stops the daemon from forking into the background."
28737 #: ../fuse/guestmount.pod:269
28739 "L<guestfish(1)>, L<virt-inspector(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
28740 "L<virt-tar(1)>, L<guestfs(3)>, L<http://libguestfs.org/>, L<http://fuse.sf."
28745 #: ../fuse/guestmount.pod:284
28746 msgid "Copyright (C) 2009-2010 Red Hat Inc. L<http://libguestfs.org/>"
28750 #: ../tools/virt-edit.pl:34
28751 msgid "virt-edit - Edit a file in a virtual machine"
28755 #: ../tools/virt-edit.pl:38
28758 " virt-edit [--options] domname file\n"
28763 #: ../tools/virt-edit.pl:40
28766 " virt-edit [--options] disk.img [disk.img ...] file\n"
28771 #: ../tools/virt-edit.pl:42
28774 " virt-edit [domname|disk.img] file -e 'expr'\n"
28779 #: ../tools/virt-edit.pl:46
28781 "You must I<not> use C<virt-edit> on live virtual machines. If you do this, "
28782 "you risk disk corruption in the VM. C<virt-edit> tries to stop you from "
28783 "doing this, but doesn't catch all cases."
28787 #: ../tools/virt-edit.pl:52
28789 "C<virt-edit> is a command line tool to edit C<file> where C<file> exists in "
28790 "the named virtual machine (or disk image)."
28794 #: ../tools/virt-edit.pl:55
28795 msgid "If you want to just view a file, use L<virt-cat(1)>."
28799 #: ../tools/virt-edit.pl:57
28801 "For more complex cases you should look at the L<guestfish(1)> tool (see L</"
28802 "USING GUESTFISH> below)."
28806 #: ../tools/virt-edit.pl:60
28808 "C<virt-edit> cannot be used to create a new file, nor to edit multiple "
28809 "files. L<guestfish(1)> can do that and much more."
28813 #: ../tools/virt-edit.pl:65
28814 msgid "Edit the named files interactively:"
28818 #: ../tools/virt-edit.pl:67
28821 " virt-edit mydomain /boot/grub/grub.conf\n"
28826 #: ../tools/virt-edit.pl:69
28829 " virt-edit mydomain /etc/passwd\n"
28834 #: ../tools/virt-edit.pl:71
28835 msgid "For Windows guests, some Windows paths are understood:"
28839 #: ../tools/virt-edit.pl:73
28842 " virt-edit mywindomain 'c:\\autoexec.bat'\n"
28847 #: ../tools/virt-edit.pl:75
28849 "You can also edit files non-interactively (see L</NON-INTERACTIVE EDITING> "
28850 "below). To change the init default level to 5:"
28854 #: ../tools/virt-edit.pl:79
28857 " virt-edit mydomain /etc/inittab -e 's/^id:.*/id:5:initdefault:/'\n"
28862 #: ../tools/virt-edit.pl:91 ../tools/virt-win-reg.pl:106
28863 #: ../tools/virt-list-filesystems.pl:63 ../tools/virt-tar.pl:113
28864 #: ../tools/virt-make-fs.pl:163 ../tools/virt-list-partitions.pl:64
28865 msgid "Display brief help."
28869 #: ../tools/virt-edit.pl:99 ../tools/virt-win-reg.pl:114
28870 #: ../tools/virt-list-filesystems.pl:71 ../tools/virt-tar.pl:121
28871 #: ../tools/virt-make-fs.pl:171 ../tools/virt-list-partitions.pl:72
28872 msgid "Display version number and exit."
28876 #: ../tools/virt-edit.pl:105
28877 msgid "B<--backup extension> | B<-b extension>"
28881 #: ../tools/virt-edit.pl:107
28883 "Create a backup of the original file I<in the guest disk image>. The backup "
28884 "has the original filename with C<extension> added."
28888 #: ../tools/virt-edit.pl:110
28890 "Usually the first character of C<extension> would be a dot C<.> so you would "
28895 #: ../tools/virt-edit.pl:113
28898 " virt-edit -b .orig [etc]\n"
28903 #: ../tools/virt-edit.pl:115
28904 msgid "By default, no backup file is made."
28908 #: ../tools/virt-edit.pl:121 ../tools/virt-win-reg.pl:128
28909 #: ../tools/virt-list-filesystems.pl:77 ../tools/virt-tar.pl:127
28910 #: ../tools/virt-list-partitions.pl:78
28911 msgid "B<--connect URI> | B<-c URI>"
28915 #: ../tools/virt-edit.pl:123 ../tools/virt-win-reg.pl:130
28916 #: ../tools/virt-list-filesystems.pl:79 ../tools/virt-tar.pl:129
28917 #: ../tools/virt-list-partitions.pl:80
28919 "If using libvirt, connect to the given I<URI>. If omitted, then we connect "
28920 "to the default libvirt hypervisor."
28924 #: ../tools/virt-edit.pl:126 ../tools/virt-win-reg.pl:133
28925 #: ../tools/virt-list-filesystems.pl:82 ../tools/virt-tar.pl:132
28926 #: ../tools/virt-list-partitions.pl:83
28928 "If you specify guest block devices directly, then libvirt is not used at all."
28932 #: ../tools/virt-edit.pl:133 ../tools/virt-win-reg.pl:140
28933 #: ../tools/virt-list-filesystems.pl:89 ../tools/virt-tar.pl:139
28934 #: ../tools/virt-list-partitions.pl:90
28935 msgid "B<--format> raw"
28939 #: ../tools/virt-edit.pl:135 ../tools/virt-win-reg.pl:142
28940 #: ../tools/virt-list-filesystems.pl:91 ../tools/virt-tar.pl:141
28941 #: ../tools/virt-list-partitions.pl:92
28943 "Specify the format of disk images given on the command line. If this is "
28944 "omitted then the format is autodetected from the content of the disk image."
28948 #: ../tools/virt-edit.pl:139 ../tools/virt-win-reg.pl:146
28949 #: ../tools/virt-list-filesystems.pl:95 ../tools/virt-tar.pl:145
28950 #: ../tools/virt-list-partitions.pl:96
28952 "If disk images are requested from libvirt, then this program asks libvirt "
28953 "for this information. In this case, the value of the format parameter is "
28958 #: ../tools/virt-edit.pl:143 ../tools/virt-win-reg.pl:150
28959 #: ../tools/virt-list-filesystems.pl:99 ../tools/virt-tar.pl:149
28960 #: ../tools/virt-list-partitions.pl:100
28962 "If working with untrusted raw-format guest disk images, you should ensure "
28963 "the format is always specified."
28967 #: ../tools/virt-edit.pl:150
28968 msgid "B<--expr EXPR> | B<-e EXPR>"
28972 #: ../tools/virt-edit.pl:152
28974 "Instead of launching the external editor, non-interactively apply the Perl "
28975 "expression C<EXPR> to each line in the file. See L</NON-INTERACTIVE "
28980 #: ../tools/virt-edit.pl:156
28982 "Be careful to properly quote the expression to prevent it from being altered "
28987 #: ../tools/virt-edit.pl:280
28988 msgid "NON-INTERACTIVE EDITING"
28992 #: ../tools/virt-edit.pl:282
28994 "C<virt-edit> normally calls out to C<$EDITOR> (or vi) so the system "
28995 "administrator can interactively edit the file."
28999 #: ../tools/virt-edit.pl:285
29001 "There are two ways also to use C<virt-edit> from scripts in order to make "
29002 "automated edits to files. (Note that although you I<can> use C<virt-edit> "
29003 "like this, it's less error-prone to write scripts directly using the "
29004 "libguestfs API and Augeas for configuration file editing.)"
29008 #: ../tools/virt-edit.pl:291
29010 "The first method is to temporarily set C<$EDITOR> to any script or program "
29011 "you want to run. The script is invoked as C<$EDITOR tmpfile> and it should "
29012 "update C<tmpfile> in place however it likes."
29016 #: ../tools/virt-edit.pl:295
29018 "The second method is to use the C<-e> parameter of C<virt-edit> to run a "
29019 "short Perl snippet in the style of L<sed(1)>. For example to replace all "
29020 "instances of C<foo> with C<bar> in a file:"
29024 #: ../tools/virt-edit.pl:299
29027 " virt-edit domname filename -e 's/foo/bar/'\n"
29032 #: ../tools/virt-edit.pl:301
29034 "The full power of Perl regular expressions can be used (see L<perlre(1)>). "
29035 "For example to delete root's password you could do:"
29039 #: ../tools/virt-edit.pl:304
29042 " virt-edit domname /etc/passwd -e 's/^root:.*?:/root::/'\n"
29047 #: ../tools/virt-edit.pl:306
29049 "What really happens is that the snippet is evaluated as a Perl expression "
29050 "for each line of the file. The line, including the final C<\\n>, is passed "
29051 "in C<$_> and the expression should update C<$_> or leave it unchanged."
29055 #: ../tools/virt-edit.pl:311
29057 "To delete a line, set C<$_> to the empty string. For example, to delete the "
29058 "C<apache> user account from the password file you can do:"
29062 #: ../tools/virt-edit.pl:314
29065 " virt-edit mydomain /etc/passwd -e '$_ = \"\" if /^apache:/'\n"
29070 #: ../tools/virt-edit.pl:316
29072 "To insert a line, prepend or append it to C<$_>. However appending lines to "
29073 "the end of the file is rather difficult this way since there is no concept "
29074 "of \"last line of the file\" - your expression just doesn't get called "
29075 "again. You might want to use the first method (setting C<$EDITOR>) if you "
29080 #: ../tools/virt-edit.pl:322
29082 "The variable C<$lineno> contains the current line number. As is "
29083 "traditional, the first line in the file is number C<1>."
29087 #: ../tools/virt-edit.pl:325
29089 "The return value from the expression is ignored, but the expression may call "
29090 "C<die> in order to abort the whole program, leaving the original file "
29095 #: ../tools/virt-edit.pl:329
29097 "Remember when matching the end of a line that C<$_> may contain the final C<"
29098 "\\n>, or (for DOS files) C<\\r\\n>, or if the file does not end with a "
29099 "newline then neither of these. Thus to match or substitute some text at the "
29100 "end of a line, use this regular expression:"
29104 #: ../tools/virt-edit.pl:334
29107 " /some text(\\r?\\n)?$/\n"
29112 #: ../tools/virt-edit.pl:336
29114 "Alternately, use the perl C<chomp> function, being careful not to chomp C<"
29115 "$_> itself (since that would remove all newlines from the file):"
29119 #: ../tools/virt-edit.pl:340
29122 " my $m = $_; chomp $m; $m =~ /some text$/\n"
29127 #: ../tools/virt-edit.pl:344
29129 "C<virt-edit> has a limited ability to understand Windows drive letters and "
29130 "paths (eg. C<E:\\foo\\bar.txt>)."
29134 #: ../tools/virt-edit.pl:347
29135 msgid "If and only if the guest is running Windows then:"
29139 #: ../tools/virt-edit.pl:353
29141 "Drive letter prefixes like C<C:> are resolved against the Windows Registry "
29142 "to the correct filesystem."
29146 #: ../tools/virt-edit.pl:358
29148 "Any backslash (C<\\>) characters in the path are replaced with forward "
29149 "slashes so that libguestfs can process it."
29153 #: ../tools/virt-edit.pl:363
29155 "The path is resolved case insensitively to locate the file that should be "
29160 #: ../tools/virt-edit.pl:368
29161 msgid "There are some known shortcomings:"
29165 #: ../tools/virt-edit.pl:374
29166 msgid "Some NTFS symbolic links may not be followed correctly."
29170 #: ../tools/virt-edit.pl:378
29171 msgid "NTFS junction points that cross filesystems are not followed."
29175 #: ../tools/virt-edit.pl:435
29176 msgid "USING GUESTFISH"
29180 #: ../tools/virt-edit.pl:437
29182 "L<guestfish(1)> is a more powerful, lower level tool which you can use when "
29183 "C<virt-edit> doesn't work."
29187 #: ../tools/virt-edit.pl:440
29188 msgid "Using C<virt-edit> is approximately equivalent to doing:"
29192 #: ../tools/virt-edit.pl:442
29195 " guestfish --rw -i -d domname edit /file\n"
29200 #: ../tools/virt-edit.pl:444
29202 "where C<domname> is the name of the libvirt guest, and C</file> is the full "
29203 "path to the file."
29207 #: ../tools/virt-edit.pl:447
29209 "The command above uses libguestfs's guest inspection feature and so does not "
29210 "work on guests that libguestfs cannot inspect, or on things like arbitrary "
29211 "disk images that don't contain guests. To edit a file on a disk image "
29216 #: ../tools/virt-edit.pl:452
29219 " guestfish --rw -a disk.img -m /dev/sda1 edit /file\n"
29224 #: ../tools/virt-edit.pl:454
29226 "where C<disk.img> is the disk image, C</dev/sda1> is the filesystem within "
29227 "the disk image to edit, and C</file> is the full path to the file."
29231 #: ../tools/virt-edit.pl:458
29233 "C<virt-edit> cannot create new files. Use the guestfish commands C<touch>, "
29234 "C<write> or C<upload> instead:"
29238 #: ../tools/virt-edit.pl:461
29241 " guestfish --rw -i -d domname touch /newfile\n"
29246 #: ../tools/virt-edit.pl:463
29249 " guestfish --rw -i -d domname write /newfile \"new content\"\n"
29254 #: ../tools/virt-edit.pl:465
29257 " guestfish --rw -i -d domname upload localfile /newfile\n"
29262 #: ../tools/virt-edit.pl:467
29264 "C<virt-edit> cannot edit multiple files, but guestfish can do it like this:"
29268 #: ../tools/virt-edit.pl:470
29271 " guestfish --rw -i -d domname edit /file1 : edit /file2\n"
29276 #: ../tools/virt-edit.pl:480
29281 #: ../tools/virt-edit.pl:482
29283 "If set, this string is used as the editor. It may contain arguments, eg. C<"
29288 #: ../tools/virt-edit.pl:485
29289 msgid "If not set, C<vi> is used."
29293 #: ../tools/virt-edit.pl:489 ../tools/virt-win-reg.pl:559
29294 #: ../tools/virt-list-filesystems.pl:182 ../tools/virt-tar.pl:279
29295 #: ../tools/virt-make-fs.pl:532 ../tools/virt-list-partitions.pl:250
29296 msgid "SHELL QUOTING"
29300 #: ../tools/virt-edit.pl:491 ../tools/virt-win-reg.pl:567
29301 #: ../tools/virt-list-filesystems.pl:184 ../tools/virt-tar.pl:281
29302 #: ../tools/virt-make-fs.pl:534 ../tools/virt-list-partitions.pl:252
29304 "Libvirt guest names can contain arbitrary characters, some of which have "
29305 "meaning to the shell such as C<#> and space. You may need to quote or "
29306 "escape these characters on the command line. See the shell manual page L<sh"
29307 "(1)> for details."
29311 #: ../tools/virt-edit.pl:498
29313 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, L<virt-"
29314 "tar-in(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, "
29315 "L<http://libguestfs.org/>, L<perl(1)>, L<perlre(1)>."
29319 #: ../tools/virt-edit.pl:510 ../tools/virt-win-reg.pl:598
29320 #: ../tools/virt-list-filesystems.pl:202 ../tools/virt-tar.pl:301
29321 #: ../tools/virt-make-fs.pl:564 ../tools/virt-list-partitions.pl:269
29326 #: ../tools/virt-edit.pl:512 ../tools/virt-win-reg.pl:600
29327 #: ../tools/virt-list-filesystems.pl:204 ../tools/virt-tar.pl:303
29328 #: ../tools/virt-make-fs.pl:566 ../tools/virt-list-partitions.pl:271
29329 msgid "Richard W.M. Jones L<http://people.redhat.com/~rjones/>"
29333 #: ../tools/virt-edit.pl:516
29334 msgid "Copyright (C) 2009-2011 Red Hat Inc."
29338 #: ../tools/virt-win-reg.pl:37
29340 "virt-win-reg - Export and merge Windows Registry entries from a Windows guest"
29344 #: ../tools/virt-win-reg.pl:41
29347 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey'\n"
29352 #: ../tools/virt-win-reg.pl:43
29355 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' name\n"
29360 #: ../tools/virt-win-reg.pl:45
29363 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' @\n"
29368 #: ../tools/virt-win-reg.pl:47
29371 " virt-win-reg --merge domname [input.reg ...]\n"
29376 #: ../tools/virt-win-reg.pl:49
29379 " virt-win-reg [--options] disk.img ... # instead of domname\n"
29384 #: ../tools/virt-win-reg.pl:53
29386 "You must I<not> use C<virt-win-reg> with the C<--merge> option on live "
29387 "virtual machines. If you do this, you I<will> get irreversible disk "
29388 "corruption in the VM. C<virt-win-reg> tries to stop you from doing this, "
29389 "but doesn't catch all cases."
29393 #: ../tools/virt-win-reg.pl:58
29395 "Modifying the Windows Registry is an inherently risky operation. The format "
29396 "is deliberately obscure and undocumented, and Registry changes can leave the "
29397 "system unbootable. Therefore when using the C<--merge> option, make sure "
29398 "you have a reliable backup first."
29402 #: ../tools/virt-win-reg.pl:65
29404 "This program can export and merge Windows Registry entries from a Windows "
29409 #: ../tools/virt-win-reg.pl:68
29411 "The first parameter is the libvirt guest name or the raw disk image of a "
29416 #: ../tools/virt-win-reg.pl:71
29418 "If C<--merge> is I<not> specified, then the chosen registry key is displayed/"
29419 "exported (recursively). For example:"
29423 #: ../tools/virt-win-reg.pl:74
29426 " $ virt-win-reg Windows7 'HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft'\n"
29431 #: ../tools/virt-win-reg.pl:76
29433 "You can also display single values from within registry keys, for example:"
29437 #: ../tools/virt-win-reg.pl:79
29440 " $ cvkey='HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion'\n"
29441 " $ virt-win-reg Windows7 $cvkey ProductName\n"
29442 " Windows 7 Enterprise\n"
29447 #: ../tools/virt-win-reg.pl:83
29449 "With C<--merge>, you can merge a textual regedit file into the Windows "
29454 #: ../tools/virt-win-reg.pl:86
29457 " $ virt-win-reg --merge Windows7 changes.reg\n"
29462 #: ../tools/virt-win-reg.pl:88 ../tools/virt-tar.pl:45
29467 #: ../tools/virt-win-reg.pl:90
29469 "This program is only meant for simple access to the registry. If you want "
29470 "to do complicated things with the registry, we suggest you download the "
29471 "Registry hive files from the guest using L<libguestfs(3)> or L<guestfish(1)> "
29472 "and access them locally, eg. using L<hivex(3)>, L<hivexsh(1)> or "
29473 "L<hivexregedit(1)>."
29477 #: ../tools/virt-win-reg.pl:120 ../tools/virt-make-fs.pl:177
29482 #: ../tools/virt-win-reg.pl:122
29483 msgid "Enable debugging messages."
29487 #: ../tools/virt-win-reg.pl:157
29492 #: ../tools/virt-win-reg.pl:159
29494 "In merge mode, this merges a textual regedit file into the Windows Registry "
29495 "of the virtual machine. If this flag is I<not> given then virt-win-reg "
29496 "displays or exports Registry entries instead."
29500 #: ../tools/virt-win-reg.pl:163
29502 "Note that C<--merge> is I<unsafe> to use on live virtual machines, and will "
29503 "result in disk corruption. However exporting (without this flag) is always "
29508 #: ../tools/virt-win-reg.pl:171
29509 msgid "B<--encoding> UTF-16LE|ASCII"
29513 #: ../tools/virt-win-reg.pl:173
29515 "When merging (only), you may need to specify the encoding for strings to be "
29516 "used in the hive file. This is explained in detail in L<Win::Hivex::Regedit"
29517 "(3)/ENCODING STRINGS>."
29521 #: ../tools/virt-win-reg.pl:177
29523 "The default is to use UTF-16LE, which should work with recent versions of "
29528 #: ../tools/virt-win-reg.pl:402
29529 msgid "SUPPORTED SYSTEMS"
29533 #: ../tools/virt-win-reg.pl:404
29535 "The program currently supports Windows NT-derived guests starting with "
29536 "Windows XP through to at least Windows 7."
29540 #: ../tools/virt-win-reg.pl:407
29542 "Registry support is done for C<HKEY_LOCAL_MACHINE\\SAM>, C<HKEY_LOCAL_MACHINE"
29543 "\\SECURITY>, C<HKEY_LOCAL_MACHINE\\SOFTWARE>, C<HKEY_LOCAL_MACHINE\\SYSTEM> "
29544 "and C<HKEY_USERS\\.DEFAULT>."
29548 #: ../tools/virt-win-reg.pl:411
29550 "You can use C<HKLM> as a shorthand for C<HKEY_LOCAL_MACHINE>, and C<HKU> for "
29555 #: ../tools/virt-win-reg.pl:414
29557 "C<HKEY_USERS\\$SID> and C<HKEY_CURRENT_USER> are B<not> supported at this "
29562 #: ../tools/virt-win-reg.pl:417
29567 #: ../tools/virt-win-reg.pl:419
29569 "C<virt-win-reg> expects that regedit files have already been reencoded in "
29570 "the local encoding. Usually on Linux hosts, this means UTF-8 with Unix-"
29571 "style line endings. Since Windows regedit files are often in UTF-16LE with "
29572 "Windows-style line endings, you may need to reencode the whole file before "
29573 "or after processing."
29577 #: ../tools/virt-win-reg.pl:425
29579 "To reencode a file from Windows format to Linux (before processing it with "
29580 "the C<--merge> option), you would do something like this:"
29584 #: ../tools/virt-win-reg.pl:428
29587 " iconv -f utf-16le -t utf-8 < win.reg | dos2unix > linux.reg\n"
29592 #: ../tools/virt-win-reg.pl:430
29594 "To go in the opposite direction, after exporting and before sending the file "
29595 "to a Windows user, do something like this:"
29599 #: ../tools/virt-win-reg.pl:433
29602 " unix2dos linux.reg | iconv -f utf-8 -t utf-16le > win.reg\n"
29607 #: ../tools/virt-win-reg.pl:435
29608 msgid "For more information about encoding, see L<Win::Hivex::Regedit(3)>."
29612 #: ../tools/virt-win-reg.pl:437
29614 "If you are unsure about the current encoding, use the L<file(1)> command. "
29615 "Recent versions of Windows regedit.exe produce a UTF-16LE file with Windows-"
29616 "style (CRLF) line endings, like this:"
29620 #: ../tools/virt-win-reg.pl:441
29623 " $ file software.reg\n"
29624 " software.reg: Little-endian UTF-16 Unicode text, with very long lines,\n"
29625 " with CRLF line terminators\n"
29630 #: ../tools/virt-win-reg.pl:445
29631 msgid "This file would need conversion before you could C<--merge> it."
29635 #: ../tools/virt-win-reg.pl:447
29636 msgid "CurrentControlSet etc."
29640 #: ../tools/virt-win-reg.pl:449
29642 "Registry keys like C<CurrentControlSet> don't really exist in the Windows "
29643 "Registry at the level of the hive file, and therefore you cannot modify "
29648 #: ../tools/virt-win-reg.pl:453
29650 "C<CurrentControlSet> is usually an alias for C<ControlSet001>. In some "
29651 "circumstances it might refer to another control set. The way to find out is "
29652 "to look at the C<HKLM\\SYSTEM\\Select> key:"
29656 #: ../tools/virt-win-reg.pl:457
29659 " # virt-win-reg WindowsGuest 'HKLM\\SYSTEM\\Select'\n"
29660 " [HKEY_LOCAL_MACHINE\\SYSTEM\\Select]\n"
29661 " \"Current\"=dword:00000001\n"
29662 " \"Default\"=dword:00000001\n"
29663 " \"Failed\"=dword:00000000\n"
29664 " \"LastKnownGood\"=dword:00000002\n"
29669 #: ../tools/virt-win-reg.pl:464
29670 msgid "\"Current\" is the one which Windows will choose when it boots."
29674 #: ../tools/virt-win-reg.pl:466
29676 "Similarly, other C<Current...> keys in the path may need to be replaced."
29680 #: ../tools/virt-win-reg.pl:469
29681 msgid "WINDOWS TIPS"
29685 #: ../tools/virt-win-reg.pl:471
29687 "Note that some of these tips modify the guest disk image. The guest I<must> "
29688 "be shut off, else you will get disk corruption."
29692 #: ../tools/virt-win-reg.pl:474
29693 msgid "RUNNING A BATCH SCRIPT WHEN A USER LOGS IN"
29697 #: ../tools/virt-win-reg.pl:476
29699 "Prepare a DOS batch script, VBScript or executable. Upload this using "
29700 "L<guestfish(1)>. For this example the script is called C<test.bat> and it "
29701 "is uploaded into C<C:\\>:"
29705 #: ../tools/virt-win-reg.pl:480
29708 " guestfish -i -d WindowsGuest upload test.bat /test.bat\n"
29713 #: ../tools/virt-win-reg.pl:482
29714 msgid "Prepare a regedit file containing the registry change:"
29718 #: ../tools/virt-win-reg.pl:484
29721 " cat > test.reg <<'EOF'\n"
29722 " [HKLM\\Software\\Microsoft\\Windows\\CurrentVersion\\RunOnce]\n"
29723 " \"Test\"=\"c:\\\\test.bat\"\n"
29729 #: ../tools/virt-win-reg.pl:489
29731 "In this example we use the key C<RunOnce> which means that the script will "
29732 "run precisely once when the first user logs in. If you want it to run every "
29733 "time a user logs in, replace C<RunOnce> with C<Run>."
29737 #: ../tools/virt-win-reg.pl:493
29738 msgid "Now update the registry:"
29742 #: ../tools/virt-win-reg.pl:495
29745 " virt-win-reg --merge WindowsGuest test.reg\n"
29750 #: ../tools/virt-win-reg.pl:497
29751 msgid "INSTALLING A SERVICE"
29755 #: ../tools/virt-win-reg.pl:499
29757 "This section assumes you are familiar with Windows services, and you either "
29758 "have a program which handles the Windows Service Control Protocol directly "
29759 "or you want to run any program using a service wrapper like SrvAny or the "
29764 #: ../tools/virt-win-reg.pl:504
29766 "First upload the program and optionally the service wrapper. In this case "
29767 "the test program is called C<test.exe> and we are using the RHSrvAny wrapper:"
29771 #: ../tools/virt-win-reg.pl:508
29774 " guestfish -i -d WindowsGuest <<EOF\n"
29775 " upload rhsrvany.exe /rhsrvany.exe\n"
29776 " upload test.exe /test.exe\n"
29782 #: ../tools/virt-win-reg.pl:513
29784 "Prepare a regedit file containing the registry changes. In this example, "
29785 "the first registry change is needed for the service itself or the service "
29786 "wrapper (if used). The second registry change is only needed because I am "
29787 "using the RHSrvAny service wrapper."
29791 #: ../tools/virt-win-reg.pl:518
29794 " cat > service.reg <<'EOF'\n"
29795 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny]\n"
29796 " \"Type\"=dword:00000010\n"
29797 " \"Start\"=dword:00000002\n"
29798 " \"ErrorControl\"=dword:00000001\n"
29799 " \"ImagePath\"=\"c:\\\\rhsrvany.exe\"\n"
29800 " \"DisplayName\"=\"RHSrvAny\"\n"
29801 " \"ObjectName\"=\"NetworkService\"\n"
29806 #: ../tools/virt-win-reg.pl:527
29809 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny\\Parameters]\n"
29810 " \"CommandLine\"=\"c:\\\\test.exe\"\n"
29811 " \"PWD\"=\"c:\\\\Temp\"\n"
29817 #: ../tools/virt-win-reg.pl:538
29819 "For use of C<ControlSet001> see the section above in this manual page. You "
29820 "may need to adjust this according to the control set that is in use by the "
29825 #: ../tools/virt-win-reg.pl:544
29827 "C<\"ObjectName\"> controls the privileges that the service will have. An "
29828 "alternative is C<\"ObjectName\"=\"LocalSystem\"> which would be the most "
29829 "privileged account."
29833 #: ../tools/virt-win-reg.pl:550
29835 "For the meaning of the magic numbers, see this Microsoft KB article: "
29836 "L<http://support.microsoft.com/kb/103000>."
29840 #: ../tools/virt-win-reg.pl:555
29841 msgid "Update the registry:"
29845 #: ../tools/virt-win-reg.pl:557
29848 " virt-win-reg --merge WindowsGuest service.reg\n"
29853 #: ../tools/virt-win-reg.pl:561
29855 "Be careful when passing parameters containing C<\\> (backslash) in the "
29856 "shell. Usually you will have to use 'single quotes' or double backslashes "
29857 "(but not both) to protect them from the shell."
29861 #: ../tools/virt-win-reg.pl:565
29862 msgid "Paths and value names are case-insensitive."
29866 #: ../tools/virt-win-reg.pl:574
29868 "L<hivex(3)>, L<hivexsh(1)>, L<hivexregedit(1)>, L<guestfs(3)>, L<guestfish(1)"
29869 ">, L<virt-cat(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Win::Hivex"
29870 "(3)>, L<Win::Hivex::Regedit(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
29874 #: ../tools/virt-win-reg.pl:589 ../tools/virt-make-fs.pl:555
29876 "When reporting bugs, please enable debugging and capture the I<complete> "
29881 #: ../tools/virt-win-reg.pl:592
29884 " export LIBGUESTFS_DEBUG=1\n"
29885 " virt-win-reg --debug [... rest ...] > /tmp/virt-win-reg.log 2>&1\n"
29890 #: ../tools/virt-win-reg.pl:595
29892 "Attach /tmp/virt-win-reg.log to a new bug report at L<https://bugzilla."
29897 #: ../tools/virt-win-reg.pl:604 ../tools/virt-make-fs.pl:570
29898 msgid "Copyright (C) 2010 Red Hat Inc."
29902 #: ../tools/virt-list-filesystems.pl:32
29904 "virt-list-filesystems - List filesystems in a virtual machine or disk image"
29908 #: ../tools/virt-list-filesystems.pl:36
29911 " virt-list-filesystems [--options] domname\n"
29916 #: ../tools/virt-list-filesystems.pl:38
29919 " virt-list-filesystems [--options] disk.img [disk.img ...]\n"
29924 #: ../tools/virt-list-filesystems.pl:42 ../tools/virt-list-partitions.pl:42
29926 "This tool is obsolete. Use L<virt-filesystems(1)> as a more flexible "
29931 #: ../tools/virt-list-filesystems.pl:45
29933 "C<virt-list-filesystems> is a command line tool to list the filesystems that "
29934 "are contained in a virtual machine or disk image."
29938 #: ../tools/virt-list-filesystems.pl:49
29940 "C<virt-list-filesystems> is just a simple wrapper around L<libguestfs(3)> "
29941 "functionality. For more complex cases you should look at the L<guestfish(1)"
29946 #: ../tools/virt-list-filesystems.pl:106 ../tools/virt-list-partitions.pl:115
29947 msgid "B<-l> | B<--long>"
29951 #: ../tools/virt-list-filesystems.pl:108
29953 "With this option, C<virt-list-filesystems> displays the type of each "
29954 "filesystem too (where \"type\" means C<ext3>, C<xfs> etc.)"
29958 #: ../tools/virt-list-filesystems.pl:115
29959 msgid "B<-a> | B<--all>"
29963 #: ../tools/virt-list-filesystems.pl:117
29965 "Normally we only show mountable filesystems. If this option is given then "
29966 "swap devices are shown too."
29970 #: ../tools/virt-list-filesystems.pl:191
29972 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, L<virt-"
29973 "filesystems(1)>, L<virt-list-partitions(1)>, L<Sys::Guestfs(3)>, L<Sys::"
29974 "Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
29978 #: ../tools/virt-list-filesystems.pl:208 ../tools/virt-tar.pl:307
29979 msgid "Copyright (C) 2009 Red Hat Inc."
29983 #: ../tools/virt-tar.pl:33
29984 msgid "virt-tar - Extract or upload files to a virtual machine"
29988 #: ../tools/virt-tar.pl:37
29991 " virt-tar [--options] -x domname directory tarball\n"
29996 #: ../tools/virt-tar.pl:39
29999 " virt-tar [--options] -u domname tarball directory\n"
30004 #: ../tools/virt-tar.pl:41
30007 " virt-tar [--options] disk.img [disk.img ...] -x directory tarball\n"
30012 #: ../tools/virt-tar.pl:43
30015 " virt-tar [--options] disk.img [disk.img ...] -u tarball directory\n"
30020 #: ../tools/virt-tar.pl:47
30022 "This tool is obsolete. Use L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-"
30023 "tar-in(1)>, L<virt-tar-out(1)> as replacements."
30027 #: ../tools/virt-tar.pl:52
30028 msgid "Download C</home> from the VM into a local tarball:"
30032 #: ../tools/virt-tar.pl:54
30035 " virt-tar -x domname /home home.tar\n"
30040 #: ../tools/virt-tar.pl:56
30043 " virt-tar -zx domname /home home.tar.gz\n"
30048 #: ../tools/virt-tar.pl:58
30049 msgid "Upload a local tarball and unpack it inside C</tmp> in the VM:"
30053 #: ../tools/virt-tar.pl:60
30056 " virt-tar -u domname uploadstuff.tar /tmp\n"
30061 #: ../tools/virt-tar.pl:62
30064 " virt-tar -zu domname uploadstuff.tar.gz /tmp\n"
30069 #: ../tools/virt-tar.pl:66
30071 "You must I<not> use C<virt-tar> with the C<-u> option (upload) on live "
30072 "virtual machines. If you do this, you risk disk corruption in the VM. "
30073 "C<virt-tar> tries to stop you from doing this, but doesn't catch all cases."
30077 #: ../tools/virt-tar.pl:71
30079 "You can use C<-x> (extract) on live virtual machines, but you might get "
30080 "inconsistent results or errors if there is filesystem activity inside the "
30081 "VM. If the live VM is synched and quiescent, then C<virt-tar> will usually "
30082 "work, but the only way to guarantee consistent results is if the virtual "
30083 "machine is shut down."
30087 #: ../tools/virt-tar.pl:79
30089 "C<virt-tar> is a general purpose archive tool for downloading and uploading "
30090 "parts of a guest filesystem. There are many possibilities: making backups, "
30091 "uploading data files, snooping on guest activity, fixing or customizing "
30096 #: ../tools/virt-tar.pl:84
30098 "If you want to just view a single file, use L<virt-cat(1)>. If you just "
30099 "want to edit a single file, use L<virt-edit(1)>. For more complex cases you "
30100 "should look at the L<guestfish(1)> tool."
30104 #: ../tools/virt-tar.pl:88
30106 "There are two modes of operation: C<-x> (eXtract) downloads a directory and "
30107 "its contents (recursively) from the virtual machine into a local tarball. "
30108 "C<-u> uploads from a local tarball, unpacking it into a directory inside the "
30109 "virtual machine. You cannot use these two options together."
30113 #: ../tools/virt-tar.pl:94
30115 "In addition, you may need to use the C<-z> (gZip) option to enable "
30116 "compression. When uploading, you have to specify C<-z> if the upload file "
30117 "is compressed because virt-tar won't detect this on its own."
30121 #: ../tools/virt-tar.pl:98
30123 "C<virt-tar> can only handle tar (optionally gzipped) format tarballs. For "
30124 "example it cannot do PKZip files or bzip2 compression. If you want that "
30125 "then you'll have to rebuild the tarballs yourself. (This is a limitation of "
30126 "the L<libguestfs(3)> API)."
30130 #: ../tools/virt-tar.pl:156
30131 msgid "B<-x> | B<--extract> | B<--download>"
30135 #: ../tools/virt-tar.pl:158
30136 msgid "B<-u> | B<--upload>"
30140 #: ../tools/virt-tar.pl:160
30142 "Use C<-x> to extract (download) a directory from a virtual machine to a "
30147 #: ../tools/virt-tar.pl:163
30149 "Use C<-u> to upload and unpack from a local tarball into a virtual machine. "
30150 "Please read the L</WARNING> section above before using this option."
30154 #: ../tools/virt-tar.pl:167
30155 msgid "You must specify exactly one of these options."
30159 #: ../tools/virt-tar.pl:173
30160 msgid "B<-z> | B<--gzip>"
30164 #: ../tools/virt-tar.pl:175
30165 msgid "Specify that the input or output tarball is gzip-compressed."
30169 #: ../tools/virt-tar.pl:288
30171 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, L<virt-copy-"
30172 "in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<Sys::"
30173 "Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs."
30178 #: ../tools/virt-make-fs.pl:37
30179 msgid "virt-make-fs - Make a filesystem from a tar archive or files"
30183 #: ../tools/virt-make-fs.pl:41
30186 " virt-make-fs [--options] input.tar output.img\n"
30191 #: ../tools/virt-make-fs.pl:43
30194 " virt-make-fs [--options] input.tar.gz output.img\n"
30199 #: ../tools/virt-make-fs.pl:45
30202 " virt-make-fs [--options] directory output.img\n"
30207 #: ../tools/virt-make-fs.pl:49
30209 "Virt-make-fs is a command line tool for creating a filesystem from a tar "
30210 "archive or some files in a directory. It is similar to tools like L<mkisofs"
30211 "(1)>, L<genisoimage(1)> and L<mksquashfs(1)>. Unlike those tools, it can "
30212 "create common filesystem types like ext2/3 or NTFS, which can be useful if "
30213 "you want to attach these filesystems to existing virtual machines (eg. to "
30214 "import large amounts of read-only data to a VM)."
30218 #: ../tools/virt-make-fs.pl:57
30219 msgid "Basic usage is:"
30223 #: ../tools/virt-make-fs.pl:59
30226 " virt-make-fs input output\n"
30231 #: ../tools/virt-make-fs.pl:61
30233 "where C<input> is either a directory containing files that you want to add, "
30234 "or a tar archive (either uncompressed tar or gzip-compressed tar); and "
30235 "C<output> is a disk image. The input type is detected automatically. The "
30236 "output disk image defaults to a raw ext2 image unless you specify extra "
30237 "flags (see L</OPTIONS> below)."
30241 #: ../tools/virt-make-fs.pl:67
30242 msgid "EXTRA SPACE"
30246 #: ../tools/virt-make-fs.pl:69
30248 "Unlike formats such as tar and squashfs, a filesystem does not \"just fit\" "
30249 "the files that it contains, but might have extra space. Depending on how "
30250 "you are going to use the output, you might think this extra space is wasted "
30251 "and want to minimize it, or you might want to leave space so that more files "
30252 "can be added later. Virt-make-fs defaults to minimizing the extra space, "
30253 "but you can use the C<--size> flag to leave space in the filesystem if you "
30258 #: ../tools/virt-make-fs.pl:77
30260 "An alternative way to leave extra space but not make the output image any "
30261 "bigger is to use an alternative disk image format (instead of the default "
30262 "\"raw\" format). Using C<--format=qcow2> will use the native QEmu/KVM qcow2 "
30263 "image format (check your hypervisor supports this before using it). This "
30264 "allows you to choose a large C<--size> but the extra space won't actually be "
30265 "allocated in the image until you try to store something in it."
30269 #: ../tools/virt-make-fs.pl:85
30271 "Don't forget that you can also use local commands including L<resize2fs(8)> "
30272 "and L<virt-resize(1)> to resize existing filesystems, or rerun virt-make-fs "
30273 "to build another image from scratch."
30277 #: ../tools/virt-make-fs.pl:89 ../tools/virt-make-fs.pl:123
30278 #: ../tools/virt-make-fs.pl:142
30283 #: ../tools/virt-make-fs.pl:91
30286 " virt-make-fs --format=qcow2 --size=+200M input output.img\n"
30291 #: ../tools/virt-make-fs.pl:93
30292 msgid "FILESYSTEM TYPE"
30296 #: ../tools/virt-make-fs.pl:95
30298 "The default filesystem type is C<ext2>. Just about any filesystem type that "
30299 "libguestfs supports can be used (but I<not> read-only formats like "
30300 "ISO9660). Here are some of the more common choices:"
30304 #: ../tools/virt-make-fs.pl:101
30309 #: ../tools/virt-make-fs.pl:103
30311 "Note that ext3 filesystems contain a journal, typically 1-32 MB in size. If "
30312 "you are not going to use the filesystem in a way that requires the journal, "
30313 "then this is just wasted overhead."
30317 #: ../tools/virt-make-fs.pl:107
30318 msgid "I<ntfs> or I<vfat>"
30322 #: ../tools/virt-make-fs.pl:109
30323 msgid "Useful if exporting data to a Windows guest."
30327 #: ../tools/virt-make-fs.pl:111
30329 "I<Note for vfat>: The tar archive or local directory must only contain files "
30330 "which are owned by root (ie. UID:GID = 0:0). The reason is that the tar "
30331 "program running within libguestfs is unable to change the ownership of non-"
30332 "root files, since vfat itself does not support this."
30336 #: ../tools/virt-make-fs.pl:116
30341 #: ../tools/virt-make-fs.pl:118
30343 "Lower overhead than C<ext2>, but certain limitations on filename length and "
30344 "total filesystem size."
30348 #: ../tools/virt-make-fs.pl:125
30351 " virt-make-fs --type=minix input minixfs.img\n"
30356 #: ../tools/virt-make-fs.pl:127
30357 msgid "TO PARTITION OR NOT TO PARTITION"
30361 #: ../tools/virt-make-fs.pl:129
30362 msgid "Optionally virt-make-fs can add a partition table to the output disk."
30366 #: ../tools/virt-make-fs.pl:131
30368 "Adding a partition can make the disk image more compatible with certain "
30369 "virtualized operating systems which don't expect to see a filesystem "
30370 "directly located on a block device (Linux doesn't care and will happily "
30371 "handle both types)."
30375 #: ../tools/virt-make-fs.pl:136
30377 "On the other hand, if you have a partition table then the output image is no "
30378 "longer a straight filesystem. For example you cannot run L<fsck(8)> "
30379 "directly on a partitioned disk image. (However libguestfs tools such as "
30380 "L<guestfish(1)> and L<virt-resize(1)> can still be used)."
30384 #: ../tools/virt-make-fs.pl:144
30385 msgid "Add an MBR partition:"
30389 #: ../tools/virt-make-fs.pl:146
30392 " virt-make-fs --partition -- input disk.img\n"
30397 #: ../tools/virt-make-fs.pl:148
30399 "If the output disk image could be terabyte-sized or larger, it's better to "
30400 "use an EFI/GPT-compatible partition table:"
30404 #: ../tools/virt-make-fs.pl:151
30407 " virt-make-fs --partition=gpt --size=+4T --format=qcow2 input disk.img\n"
30412 #: ../tools/virt-make-fs.pl:179
30413 msgid "Enable debugging information."
30417 #: ../tools/virt-make-fs.pl:185
30418 msgid "B<--size=E<lt>NE<gt>>"
30422 #: ../tools/virt-make-fs.pl:187
30423 msgid "B<--size=+E<lt>NE<gt>>"
30427 #: ../tools/virt-make-fs.pl:189
30428 msgid "B<-s E<lt>NE<gt>>"
30432 #: ../tools/virt-make-fs.pl:191
30433 msgid "B<-s +E<lt>NE<gt>>"
30437 #: ../tools/virt-make-fs.pl:193
30439 "Use the C<--size> (or C<-s>) option to choose the size of the output image."
30443 #: ../tools/virt-make-fs.pl:196
30445 "If this option is I<not> given, then the output image will be just large "
30446 "enough to contain all the files, with not much wasted space."
30450 #: ../tools/virt-make-fs.pl:199
30452 "To choose a fixed size output disk, specify an absolute number followed by b/"
30453 "K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
30454 "Petabytes or Exabytes. This must be large enough to contain all the input "
30455 "files, else you will get an error."
30459 #: ../tools/virt-make-fs.pl:204
30461 "To leave extra space, specify C<+> (plus sign) and a number followed by b/K/"
30462 "M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
30463 "Petabytes or Exabytes. For example: C<--size=+200M> means enough space for "
30464 "the input files, and (approximately) an extra 200 MB free space."
30468 #: ../tools/virt-make-fs.pl:210
30470 "Note that virt-make-fs estimates free space, and therefore will not produce "
30471 "filesystems containing precisely the free space requested. (It is much more "
30472 "expensive and time-consuming to produce a filesystem which has precisely the "
30473 "desired free space)."
30477 #: ../tools/virt-make-fs.pl:219
30478 msgid "B<--format=E<lt>fmtE<gt>>"
30482 #: ../tools/virt-make-fs.pl:221
30483 msgid "B<-F E<lt>fmtE<gt>>"
30487 #: ../tools/virt-make-fs.pl:223
30488 msgid "Choose the output disk image format."
30492 #: ../tools/virt-make-fs.pl:225
30493 msgid "The default is C<raw> (raw disk image)."
30497 #: ../tools/virt-make-fs.pl:227
30499 "For other choices, see the L<qemu-img(1)> manpage. The only other choice "
30500 "that would really make sense here is C<qcow2>."
30504 #: ../tools/virt-make-fs.pl:234
30505 msgid "B<--type=E<lt>fsE<gt>>"
30509 #: ../tools/virt-make-fs.pl:236
30510 msgid "B<-t E<lt>fsE<gt>>"
30514 #: ../tools/virt-make-fs.pl:238
30515 msgid "Choose the output filesystem type."
30519 #: ../tools/virt-make-fs.pl:240
30520 msgid "The default is C<ext2>."
30524 #: ../tools/virt-make-fs.pl:242
30526 "Any filesystem which is supported read-write by libguestfs can be used here."
30530 #: ../tools/virt-make-fs.pl:249
30531 msgid "B<--partition>"
30535 #: ../tools/virt-make-fs.pl:251
30536 msgid "B<--partition=E<lt>parttypeE<gt>>"
30540 #: ../tools/virt-make-fs.pl:253
30542 "If specified, this flag adds an MBR partition table to the output disk image."
30546 #: ../tools/virt-make-fs.pl:256
30548 "You can change the partition table type, eg. C<--partition=gpt> for large "
30553 #: ../tools/virt-make-fs.pl:259
30555 "Note that if you just use a lonesome C<--partition>, the Perl option parser "
30556 "might consider the next parameter to be the partition type. For example:"
30560 #: ../tools/virt-make-fs.pl:263
30563 " virt-make-fs --partition input.tar ...\n"
30568 #: ../tools/virt-make-fs.pl:265
30570 "would cause virt-make-fs to think you wanted to use a partition type of "
30571 "C<input.tar> which is completely wrong. To avoid this, use C<--> (a double "
30572 "dash) between options and the input file argument:"
30576 #: ../tools/virt-make-fs.pl:269
30579 " virt-make-fs --partition -- input.tar ...\n"
30584 #: ../tools/virt-make-fs.pl:541
30586 "L<guestfish(1)>, L<virt-resize(1)>, L<virt-tar-in(1)>, L<mkisofs(1)>, "
30587 "L<genisoimage(1)>, L<mksquashfs(1)>, L<mke2fs(8)>, L<resize2fs(8)>, L<guestfs"
30588 "(3)>, L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
30592 #: ../tools/virt-make-fs.pl:558
30595 " export LIBGUESTFS_DEBUG=1\n"
30596 " virt-make-fs --debug [...] > /tmp/virt-make-fs.log 2>&1\n"
30601 #: ../tools/virt-make-fs.pl:561
30603 "Attach /tmp/virt-make-fs.log to a new bug report at L<https://bugzilla."
30608 #: ../tools/virt-list-partitions.pl:32
30610 "virt-list-partitions - List partitions in a virtual machine or disk image"
30614 #: ../tools/virt-list-partitions.pl:36
30617 " virt-list-partitions [--options] domname\n"
30622 #: ../tools/virt-list-partitions.pl:38
30625 " virt-list-partitions [--options] disk.img [disk.img ...]\n"
30630 #: ../tools/virt-list-partitions.pl:45
30632 "C<virt-list-partitions> is a command line tool to list the partitions that "
30633 "are contained in a virtual machine or disk image. It is mainly useful as a "
30634 "first step to using L<virt-resize(1)>."
30638 #: ../tools/virt-list-partitions.pl:50
30640 "C<virt-list-partitions> is just a simple wrapper around L<libguestfs(3)> "
30641 "functionality. For more complex cases you should look at the L<guestfish(1)"
30646 #: ../tools/virt-list-partitions.pl:107
30647 msgid "B<-h> | B<--human-readable>"
30651 #: ../tools/virt-list-partitions.pl:109
30652 msgid "Show sizes in human-readable form (eg. \"1G\")."
30656 #: ../tools/virt-list-partitions.pl:117
30658 "With this option, C<virt-list-partitions> displays the type and size of each "
30659 "partition too (where \"type\" means C<ext3>, C<pv> etc.)"
30663 #: ../tools/virt-list-partitions.pl:124
30664 msgid "B<-t> | B<--total>"
30668 #: ../tools/virt-list-partitions.pl:126
30670 "Display the total size of each block device (as a separate row or rows)."
30674 #: ../tools/virt-list-partitions.pl:259
30676 "L<guestfs(3)>, L<guestfish(1)>, L<virt-filesystems(1)>, L<virt-list-"
30677 "filesystems(1)>, L<virt-resize(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib"
30678 "(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
30682 #: ../tools/virt-list-partitions.pl:275
30683 msgid "Copyright (C) 2009-2010 Red Hat Inc."