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-09-16 16:55+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 file descriptor C<fd> by doing:"
794 #: ../src/guestfs.pod:359
798 " snprintf (devfd, sizeof devfd, \"/dev/fd/%d\", fd);\n"
799 " guestfs_tar_out (g, \"/\", devfd);\n"
804 #: ../src/guestfs.pod:363
805 msgid "LISTING FILES"
809 #: ../src/guestfs.pod:365
811 "L</guestfs_ll> is just designed for humans to read (mainly when using the "
812 "L<guestfish(1)>-equivalent command C<ll>)."
816 #: ../src/guestfs.pod:368
818 "L</guestfs_ls> is a quick way to get a list of files in a directory from "
819 "programs, as a flat list of strings."
823 #: ../src/guestfs.pod:371
825 "L</guestfs_readdir> is a programmatic way to get a list of files in a "
826 "directory, plus additional information about each one. It is more "
827 "equivalent to using the L<readdir(3)> call on a local filesystem."
831 #: ../src/guestfs.pod:375
833 "L</guestfs_find> and L</guestfs_find0> can be used to recursively list files."
837 #: ../src/guestfs.pod:378
838 msgid "RUNNING COMMANDS"
842 #: ../src/guestfs.pod:380
844 "Although libguestfs is primarily an API for manipulating files inside guest "
845 "images, we also provide some limited facilities for running commands inside "
850 #: ../src/guestfs.pod:384
851 msgid "There are many limitations to this:"
855 #: ../src/guestfs.pod:388 ../src/guestfs.pod:393 ../src/guestfs.pod:398
856 #: ../src/guestfs.pod:402 ../src/guestfs.pod:407 ../src/guestfs.pod:411
857 #: ../src/guestfs.pod:416 ../src/guestfs.pod:421 ../src/guestfs.pod:1064
858 #: ../src/guestfs.pod:1068 ../src/guestfs.pod:1072 ../src/guestfs.pod:1077
859 #: ../src/guestfs.pod:1085 ../src/guestfs.pod:1104 ../src/guestfs.pod:1112
860 #: ../src/guestfs.pod:1134 ../src/guestfs.pod:1138 ../src/guestfs.pod:1142
861 #: ../src/guestfs.pod:1146 ../src/guestfs.pod:1150 ../src/guestfs.pod:1154
862 #: ../src/guestfs.pod:1643 ../src/guestfs.pod:1648 ../src/guestfs.pod:1652
863 #: ../src/guestfs.pod:1753 ../src/guestfs.pod:1758 ../src/guestfs.pod:1762
864 #: ../src/guestfs.pod:1772 ../src/guestfs.pod:2007 ../src/guestfs.pod:2012
865 #: ../src/guestfs.pod:2018 ../src/guestfs.pod:2026 ../src/guestfs.pod:2380
866 #: ../src/guestfs.pod:2386 ../src/guestfs.pod:2391 ../src/guestfs.pod:2397
867 #: ../src/guestfs.pod:2968 ../src/guestfs.pod:2972 ../src/guestfs.pod:2976
868 #: ../src/guestfs.pod:2980 ../src/guestfs-actions.pod:15
869 #: ../src/guestfs-actions.pod:22 ../src/guestfs-actions.pod:582
870 #: ../src/guestfs-actions.pod:590 ../src/guestfs-actions.pod:597
871 #: ../src/guestfs-actions.pod:604 ../src/guestfs-actions.pod:1602
872 #: ../src/guestfs-actions.pod:1606 ../src/guestfs-actions.pod:1610
873 #: ../src/guestfs-actions.pod:1614 ../src/guestfs-actions.pod:1622
874 #: ../src/guestfs-actions.pod:1626 ../src/guestfs-actions.pod:1630
875 #: ../src/guestfs-actions.pod:1640 ../src/guestfs-actions.pod:1644
876 #: ../src/guestfs-actions.pod:1648 ../src/guestfs-actions.pod:1786
877 #: ../src/guestfs-actions.pod:1790 ../src/guestfs-actions.pod:1795
878 #: ../src/guestfs-actions.pod:1800 ../src/guestfs-actions.pod:1861
879 #: ../src/guestfs-actions.pod:1865 ../src/guestfs-actions.pod:1870
880 #: ../src/guestfs-actions.pod:2261 ../src/guestfs-actions.pod:2268
881 #: ../src/guestfs-actions.pod:2275 ../fish/guestfish.pod:443
882 #: ../fish/guestfish.pod:447 ../fish/guestfish.pod:451
883 #: ../fish/guestfish.pod:455 ../fish/guestfish-actions.pod:13
884 #: ../fish/guestfish-actions.pod:20 ../fish/guestfish-actions.pod:385
885 #: ../fish/guestfish-actions.pod:393 ../fish/guestfish-actions.pod:400
886 #: ../fish/guestfish-actions.pod:407 ../fish/guestfish-actions.pod:1074
887 #: ../fish/guestfish-actions.pod:1078 ../fish/guestfish-actions.pod:1082
888 #: ../fish/guestfish-actions.pod:1086 ../fish/guestfish-actions.pod:1094
889 #: ../fish/guestfish-actions.pod:1098 ../fish/guestfish-actions.pod:1102
890 #: ../fish/guestfish-actions.pod:1112 ../fish/guestfish-actions.pod:1116
891 #: ../fish/guestfish-actions.pod:1120 ../fish/guestfish-actions.pod:1210
892 #: ../fish/guestfish-actions.pod:1214 ../fish/guestfish-actions.pod:1219
893 #: ../fish/guestfish-actions.pod:1224 ../fish/guestfish-actions.pod:1266
894 #: ../fish/guestfish-actions.pod:1270 ../fish/guestfish-actions.pod:1275
895 #: ../fish/guestfish-actions.pod:1519 ../fish/guestfish-actions.pod:1526
896 #: ../fish/guestfish-actions.pod:1533 ../tools/virt-edit.pl:351
897 #: ../tools/virt-edit.pl:356 ../tools/virt-edit.pl:361
898 #: ../tools/virt-edit.pl:372 ../tools/virt-edit.pl:376
899 #: ../tools/virt-win-reg.pl:536 ../tools/virt-win-reg.pl:542
900 #: ../tools/virt-win-reg.pl:548
905 #: ../src/guestfs.pod:390
907 "The kernel version that the command runs under will be different from what "
912 #: ../src/guestfs.pod:395
914 "If the command needs to communicate with daemons, then most likely they "
919 #: ../src/guestfs.pod:400
920 msgid "The command will be running in limited memory."
924 #: ../src/guestfs.pod:404
926 "The network may not be available unless you enable it (see L</"
927 "guestfs_set_network>)."
931 #: ../src/guestfs.pod:409
932 msgid "Only supports Linux guests (not Windows, BSD, etc)."
936 #: ../src/guestfs.pod:413
938 "Architecture limitations (eg. won't work for a PPC guest on an X86 host)."
942 #: ../src/guestfs.pod:418
944 "For SELinux guests, you may need to enable SELinux and load policy first. "
945 "See L</SELINUX> in this manpage."
949 #: ../src/guestfs.pod:423
951 "I<Security:> It is not safe to run commands from untrusted, possibly "
952 "malicious guests. These commands may attempt to exploit your program by "
953 "sending unexpected output. They could also try to exploit the Linux kernel "
954 "or qemu provided by the libguestfs appliance. They could use the network "
955 "provided by the libguestfs appliance to bypass ordinary network partitions "
956 "and firewalls. They could use the elevated privileges or different SELinux "
957 "context of your program to their advantage."
961 #: ../src/guestfs.pod:432
963 "A secure alternative is to use libguestfs to install a \"firstboot\" script "
964 "(a script which runs when the guest next boots normally), and to have this "
965 "script run the commands you want in the normal context of the running guest, "
966 "network security and so on. For information about other security issues, "
971 #: ../src/guestfs.pod:440
973 "The two main API calls to run commands are L</guestfs_command> and L</"
974 "guestfs_sh> (there are also variations)."
978 #: ../src/guestfs.pod:443
980 "The difference is that L</guestfs_sh> runs commands using the shell, so any "
981 "shell globs, redirections, etc will work."
985 #: ../src/guestfs.pod:446
986 msgid "CONFIGURATION FILES"
987 msgstr "ФАЙЛИ НАЛАШТУВАННЯ"
990 #: ../src/guestfs.pod:448
992 "To read and write configuration files in Linux guest filesystems, we "
993 "strongly recommend using Augeas. For example, Augeas understands how to "
994 "read and write, say, a Linux shadow password file or X.org configuration "
995 "file, and so avoids you having to write that code."
999 #: ../src/guestfs.pod:453
1001 "The main Augeas calls are bound through the C<guestfs_aug_*> APIs. We don't "
1002 "document Augeas itself here because there is excellent documentation on the "
1003 "L<http://augeas.net/> website."
1007 #: ../src/guestfs.pod:457
1009 "If you don't want to use Augeas (you fool!) then try calling L</"
1010 "guestfs_read_lines> to get the file as a list of lines which you can iterate "
1015 #: ../src/guestfs.pod:461
1020 #: ../src/guestfs.pod:463
1022 "We support SELinux guests. To ensure that labeling happens correctly in "
1023 "SELinux guests, you need to enable SELinux and load the guest's policy:"
1027 #: ../src/guestfs.pod:469 ../src/guestfs.pod:1257 ../src/guestfs.pod:1395
1028 #: ../src/guestfs.pod:2425
1033 #: ../src/guestfs.pod:471
1034 msgid "Before launching, do:"
1038 #: ../src/guestfs.pod:473
1041 " guestfs_set_selinux (g, 1);\n"
1046 #: ../src/guestfs.pod:475 ../src/guestfs.pod:1261 ../src/guestfs.pod:1399
1047 #: ../src/guestfs.pod:2450
1052 #: ../src/guestfs.pod:477
1054 "After mounting the guest's filesystem(s), load the policy. This is best "
1055 "done by running the L<load_policy(8)> command in the guest itself:"
1059 #: ../src/guestfs.pod:481
1062 " guestfs_sh (g, \"/usr/sbin/load_policy\");\n"
1067 #: ../src/guestfs.pod:483
1069 "(Older versions of C<load_policy> require you to specify the name of the "
1074 #: ../src/guestfs.pod:486 ../src/guestfs.pod:1405
1079 #: ../src/guestfs.pod:488
1081 "Optionally, set the security context for the API. The correct security "
1082 "context to use can only be known by inspecting the guest. As an example:"
1086 #: ../src/guestfs.pod:492
1089 " guestfs_setcon (g, \"unconfined_u:unconfined_r:unconfined_t:s0\");\n"
1094 #: ../src/guestfs.pod:496
1095 msgid "This will work for running commands and editing existing files."
1099 #: ../src/guestfs.pod:498
1101 "When new files are created, you may need to label them explicitly, for "
1102 "example by running the external command C<restorecon pathname>."
1106 #: ../src/guestfs.pod:502
1111 #: ../src/guestfs.pod:504
1113 "Certain calls are affected by the current file mode creation mask (the "
1114 "\"umask\"). In particular ones which create files or directories, such as "
1115 "L</guestfs_touch>, L</guestfs_mknod> or L</guestfs_mkdir>. This affects "
1116 "either the default mode that the file is created with or modifies the mode "
1121 #: ../src/guestfs.pod:510
1123 "The default umask is C<022>, so files are created with modes such as C<0644> "
1124 "and directories with C<0755>."
1128 #: ../src/guestfs.pod:513
1130 "There are two ways to avoid being affected by umask. Either set umask to 0 "
1131 "(call C<guestfs_umask (g, 0)> early after launching). Or call L</"
1132 "guestfs_chmod> after creating each file or directory."
1136 #: ../src/guestfs.pod:517
1137 msgid "For more information about umask, see L<umask(2)>."
1141 #: ../src/guestfs.pod:519 ../fish/guestfish.pod:765
1142 msgid "ENCRYPTED DISKS"
1146 #: ../src/guestfs.pod:521
1148 "Libguestfs allows you to access Linux guests which have been encrypted using "
1149 "whole disk encryption that conforms to the Linux Unified Key Setup (LUKS) "
1150 "standard. This includes nearly all whole disk encryption systems used by "
1151 "modern Linux guests."
1155 #: ../src/guestfs.pod:527
1157 "Use L</guestfs_vfs_type> to identify LUKS-encrypted block devices (it "
1158 "returns the string C<crypto_LUKS>)."
1162 #: ../src/guestfs.pod:530
1164 "Then open these devices by calling L</guestfs_luks_open>. Obviously you "
1165 "will require the passphrase!"
1169 #: ../src/guestfs.pod:533
1171 "Opening a LUKS device creates a new device mapper device called C</dev/"
1172 "mapper/mapname> (where C<mapname> is the string you supply to L</"
1173 "guestfs_luks_open>). Reads and writes to this mapper device are decrypted "
1174 "from and encrypted to the underlying block device respectively."
1178 #: ../src/guestfs.pod:539
1180 "LVM volume groups on the device can be made visible by calling L</"
1181 "guestfs_vgscan> followed by L</guestfs_vg_activate_all>. The logical volume"
1182 "(s) can now be mounted in the usual way."
1186 #: ../src/guestfs.pod:543
1188 "Use the reverse process to close a LUKS device. Unmount any logical volumes "
1189 "on it, deactivate the volume groups by caling C<guestfs_vg_activate (g, 0, "
1190 "[\"/dev/VG\"])>. Then close the mapper device by calling L</"
1191 "guestfs_luks_close> on the C</dev/mapper/mapname> device (I<not> the "
1192 "underlying encrypted block device)."
1196 #: ../src/guestfs.pod:550
1201 #: ../src/guestfs.pod:552
1203 "Libguestfs has APIs for inspecting an unknown disk image to find out if it "
1204 "contains operating systems, an install CD or a live CD. (These APIs used to "
1205 "be in a separate Perl-only library called L<Sys::Guestfs::Lib(3)> but since "
1206 "version 1.5.3 the most frequently used part of this library has been "
1207 "rewritten in C and moved into the core code)."
1211 #: ../src/guestfs.pod:559
1213 "Add all disks belonging to the unknown virtual machine and call L</"
1214 "guestfs_launch> in the usual way."
1218 #: ../src/guestfs.pod:562
1220 "Then call L</guestfs_inspect_os>. This function uses other libguestfs calls "
1221 "and certain heuristics, and returns a list of operating systems that were "
1222 "found. An empty list means none were found. A single element is the root "
1223 "filesystem of the operating system. For dual- or multi-boot guests, "
1224 "multiple roots can be returned, each one corresponding to a separate "
1225 "operating system. (Multi-boot virtual machines are extremely rare in the "
1226 "world of virtualization, but since this scenario can happen, we have built "
1227 "libguestfs to deal with it.)"
1231 #: ../src/guestfs.pod:571
1233 "For each root, you can then call various C<guestfs_inspect_get_*> functions "
1234 "to get additional details about that operating system. For example, call L</"
1235 "guestfs_inspect_get_type> to return the string C<windows> or C<linux> for "
1236 "Windows and Linux-based operating systems respectively."
1240 #: ../src/guestfs.pod:577
1242 "Un*x-like and Linux-based operating systems usually consist of several "
1243 "filesystems which are mounted at boot time (for example, a separate boot "
1244 "partition mounted on C</boot>). The inspection rules are able to detect how "
1245 "filesystems correspond to mount points. Call "
1246 "C<guestfs_inspect_get_mountpoints> to get this mapping. It might return a "
1247 "hash table like this example:"
1251 #: ../src/guestfs.pod:584
1254 " /boot => /dev/sda1\n"
1255 " / => /dev/vg_guest/lv_root\n"
1256 " /usr => /dev/vg_guest/lv_usr\n"
1261 #: ../src/guestfs.pod:588
1263 "The caller can then make calls to L</guestfs_mount_options> to mount the "
1264 "filesystems as suggested."
1268 #: ../src/guestfs.pod:591
1270 "Be careful to mount filesystems in the right order (eg. C</> before C</"
1271 "usr>). Sorting the keys of the hash by length, shortest first, should work."
1275 #: ../src/guestfs.pod:595
1277 "Inspection currently only works for some common operating systems. "
1278 "Contributors are welcome to send patches for other operating systems that we "
1279 "currently cannot detect."
1283 #: ../src/guestfs.pod:599
1285 "Encrypted disks must be opened before inspection. See L</ENCRYPTED DISKS> "
1286 "for more details. The L</guestfs_inspect_os> function just ignores any "
1287 "encrypted devices."
1291 #: ../src/guestfs.pod:603
1293 "A note on the implementation: The call L</guestfs_inspect_os> performs "
1294 "inspection and caches the results in the guest handle. Subsequent calls to "
1295 "C<guestfs_inspect_get_*> return this cached information, but I<do not> re-"
1296 "read the disks. If you change the content of the guest disks, you can redo "
1297 "inspection by calling L</guestfs_inspect_os> again. (L</"
1298 "guestfs_inspect_list_applications> works a little differently from the other "
1299 "calls and does read the disks. See documentation for that function for "
1304 #: ../src/guestfs.pod:612
1305 msgid "INSPECTING INSTALL DISKS"
1309 #: ../src/guestfs.pod:614
1311 "Libguestfs (since 1.9.4) can detect some install disks, install CDs, live "
1316 #: ../src/guestfs.pod:617
1318 "Call L</guestfs_inspect_get_format> to return the format of the operating "
1319 "system, which currently can be C<installed> (a regular operating system) or "
1320 "C<installer> (some sort of install disk)."
1324 #: ../src/guestfs.pod:621
1326 "Further information is available about the operating system that can be "
1327 "installed using the regular inspection APIs like L</"
1328 "guestfs_inspect_get_product_name>, L</guestfs_inspect_get_major_version> etc."
1332 #: ../src/guestfs.pod:626
1334 "Some additional information specific to installer disks is also available "
1335 "from the L</guestfs_inspect_is_live>, L</guestfs_inspect_is_netinst> and L</"
1336 "guestfs_inspect_is_multipart> calls."
1340 #: ../src/guestfs.pod:631
1341 msgid "SPECIAL CONSIDERATIONS FOR WINDOWS GUESTS"
1345 #: ../src/guestfs.pod:633
1347 "Libguestfs can mount NTFS partitions. It does this using the L<http://www."
1348 "ntfs-3g.org/> driver."
1352 #: ../src/guestfs.pod:636
1353 msgid "DRIVE LETTERS AND PATHS"
1357 #: ../src/guestfs.pod:638
1359 "DOS and Windows still use drive letters, and the filesystems are always "
1360 "treated as case insensitive by Windows itself, and therefore you might find "
1361 "a Windows configuration file referring to a path like C<c:\\windows"
1362 "\\system32>. When the filesystem is mounted in libguestfs, that directory "
1363 "might be referred to as C</WINDOWS/System32>."
1367 #: ../src/guestfs.pod:644
1369 "Drive letter mappings can be found using inspection (see L</INSPECTION> and "
1370 "L</guestfs_inspect_get_drive_mappings>)"
1374 #: ../src/guestfs.pod:647
1376 "Dealing with separator characters (backslash vs forward slash) is outside "
1377 "the scope of libguestfs, but usually a simple character replacement will "
1382 #: ../src/guestfs.pod:651
1384 "To resolve the case insensitivity of paths, call L</"
1385 "guestfs_case_sensitive_path>."
1389 #: ../src/guestfs.pod:654
1390 msgid "ACCESSING THE WINDOWS REGISTRY"
1394 #: ../src/guestfs.pod:656
1396 "Libguestfs also provides some help for decoding Windows Registry \"hive\" "
1397 "files, through the library C<hivex> which is part of the libguestfs project "
1398 "although ships as a separate tarball. You have to locate and download the "
1399 "hive file(s) yourself, and then pass them to C<hivex> functions. See also "
1400 "the programs L<hivexml(1)>, L<hivexsh(1)>, L<hivexregedit(1)> and L<virt-win-"
1401 "reg(1)> for more help on this issue."
1405 #: ../src/guestfs.pod:664
1406 msgid "SYMLINKS ON NTFS-3G FILESYSTEMS"
1410 #: ../src/guestfs.pod:666
1412 "Ntfs-3g tries to rewrite \"Junction Points\" and NTFS \"symbolic links\" to "
1413 "provide something which looks like a Linux symlink. The way it tries to do "
1414 "the rewriting is described here:"
1418 #: ../src/guestfs.pod:670
1420 "L<http://www.tuxera.com/community/ntfs-3g-advanced/junction-points-and-"
1423 "L<http://www.tuxera.com/community/ntfs-3g-advanced/junction-points-and-"
1427 #: ../src/guestfs.pod:672
1429 "The essential problem is that ntfs-3g simply does not have enough "
1430 "information to do a correct job. NTFS links can contain drive letters and "
1431 "references to external device GUIDs that ntfs-3g has no way of resolving. "
1432 "It is almost certainly the case that libguestfs callers should ignore what "
1433 "ntfs-3g does (ie. don't use L</guestfs_readlink> on NTFS volumes)."
1437 #: ../src/guestfs.pod:679
1439 "Instead if you encounter a symbolic link on an ntfs-3g filesystem, use L</"
1440 "guestfs_lgetxattr> to read the C<system.ntfs_reparse_data> extended "
1441 "attribute, and read the raw reparse data from that (you can find the format "
1442 "documented in various places around the web)."
1446 #: ../src/guestfs.pod:684
1447 msgid "EXTENDED ATTRIBUTES ON NTFS-3G FILESYSTEMS"
1451 #: ../src/guestfs.pod:686
1453 "There are other useful extended attributes that can be read from ntfs-3g "
1454 "filesystems (using L</guestfs_getxattr>). See:"
1458 #: ../src/guestfs.pod:689
1460 "L<http://www.tuxera.com/community/ntfs-3g-advanced/extended-attributes/>"
1462 "L<http://www.tuxera.com/community/ntfs-3g-advanced/extended-attributes/>"
1465 #: ../src/guestfs.pod:691
1466 msgid "USING LIBGUESTFS WITH OTHER PROGRAMMING LANGUAGES"
1470 #: ../src/guestfs.pod:693
1472 "Although we don't want to discourage you from using the C API, we will "
1473 "mention here that the same API is also available in other languages."
1477 #: ../src/guestfs.pod:696
1479 "The API is broadly identical in all supported languages. This means that "
1480 "the C call C<guestfs_add_drive_ro(g,file)> is C<$g-E<gt>add_drive_ro($file)> "
1481 "in Perl, C<g.add_drive_ro(file)> in Python, and C<g#add_drive_ro file> in "
1482 "OCaml. In other words, a straightforward, predictable isomorphism between "
1487 #: ../src/guestfs.pod:702
1489 "Error messages are automatically transformed into exceptions if the language "
1494 #: ../src/guestfs.pod:705
1496 "We don't try to \"object orientify\" parts of the API in OO languages, "
1497 "although contributors are welcome to write higher level APIs above what we "
1498 "provide in their favourite languages if they wish."
1502 #: ../src/guestfs.pod:711
1507 #: ../src/guestfs.pod:713
1509 "You can use the I<guestfs.h> header file from C++ programs. The C++ API is "
1510 "identical to the C API. C++ classes and exceptions are not used."
1514 #: ../src/guestfs.pod:717
1519 #: ../src/guestfs.pod:719
1521 "The C# bindings are highly experimental. Please read the warnings at the "
1522 "top of C<csharp/Libguestfs.cs>."
1526 #: ../src/guestfs.pod:722
1531 #: ../src/guestfs.pod:724
1533 "This is the only language binding that is working but incomplete. Only "
1534 "calls which return simple integers have been bound in Haskell, and we are "
1535 "looking for help to complete this binding."
1539 #: ../src/guestfs.pod:728
1544 #: ../src/guestfs.pod:730
1546 "Full documentation is contained in the Javadoc which is distributed with "
1551 #: ../src/guestfs.pod:733
1556 #: ../src/guestfs.pod:735
1557 msgid "See L<guestfs-ocaml(3)>."
1558 msgstr "Див. L<guestfs-ocaml(3)>."
1561 #: ../src/guestfs.pod:737
1566 #: ../src/guestfs.pod:739
1567 msgid "See L<guestfs-perl(3)> and L<Sys::Guestfs(3)>."
1568 msgstr "Див. L<guestfs-perl(3)> та L<Sys::Guestfs(3)>."
1571 #: ../src/guestfs.pod:741
1576 #: ../src/guestfs.pod:743
1578 "For documentation see C<README-PHP> supplied with libguestfs sources or in "
1579 "the php-libguestfs package for your distribution."
1583 #: ../src/guestfs.pod:746
1584 msgid "The PHP binding only works correctly on 64 bit machines."
1588 #: ../src/guestfs.pod:748
1593 #: ../src/guestfs.pod:750
1594 msgid "See L<guestfs-python(3)>."
1595 msgstr "Див. L<guestfs-python(3)>."
1598 #: ../src/guestfs.pod:752
1603 #: ../src/guestfs.pod:754
1604 msgid "See L<guestfs-ruby(3)>."
1605 msgstr "Див. L<guestfs-ruby(3)>."
1608 #: ../src/guestfs.pod:756
1609 msgid "B<shell scripts>"
1610 msgstr "B<скрипти оболонки>"
1613 #: ../src/guestfs.pod:758
1614 msgid "See L<guestfish(1)>."
1615 msgstr "Див. L<guestfish(1)>."
1618 #: ../src/guestfs.pod:762
1619 msgid "LIBGUESTFS GOTCHAS"
1623 #: ../src/guestfs.pod:764
1625 "L<http://en.wikipedia.org/wiki/Gotcha_(programming)>: \"A feature of a "
1626 "system [...] that works in the way it is documented but is counterintuitive "
1627 "and almost invites mistakes.\""
1631 #: ../src/guestfs.pod:768
1633 "Since we developed libguestfs and the associated tools, there are several "
1634 "things we would have designed differently, but are now stuck with for "
1635 "backwards compatibility or other reasons. If there is ever a libguestfs 2.0 "
1636 "release, you can expect these to change. Beware of them."
1640 #: ../src/guestfs.pod:776
1641 msgid "Autosync / forgetting to sync."
1645 #: ../src/guestfs.pod:778
1647 "I<Update:> Autosync is enabled by default for all API users starting from "
1648 "libguestfs 1.5.24. This section only applies to older versions."
1652 #: ../src/guestfs.pod:781
1654 "When modifying a filesystem from C or another language, you B<must> unmount "
1655 "all filesystems and call L</guestfs_sync> explicitly before you close the "
1656 "libguestfs handle. You can also call:"
1660 #: ../src/guestfs.pod:785
1663 " guestfs_set_autosync (g, 1);\n"
1668 #: ../src/guestfs.pod:787
1670 "to have the unmount/sync done automatically for you when the handle 'g' is "
1671 "closed. (This feature is called \"autosync\", L</guestfs_set_autosync> q.v.)"
1675 #: ../src/guestfs.pod:791
1677 "If you forget to do this, then it is entirely possible that your changes "
1678 "won't be written out, or will be partially written, or (very rarely) that "
1679 "you'll get disk corruption."
1683 #: ../src/guestfs.pod:795
1685 "Note that in L<guestfish(3)> autosync is the default. So quick and dirty "
1686 "guestfish scripts that forget to sync will work just fine, which can make "
1687 "this very puzzling if you are trying to debug a problem."
1691 #: ../src/guestfs.pod:799
1692 msgid "Mount option C<-o sync> should not be the default."
1696 #: ../src/guestfs.pod:801
1698 "If you use L</guestfs_mount>, then C<-o sync,noatime> are added implicitly. "
1699 "However C<-o sync> does not add any reliability benefit, but does have a "
1700 "very large performance impact."
1704 #: ../src/guestfs.pod:805
1706 "The work around is to use L</guestfs_mount_options> and set the mount "
1707 "options that you actually want to use."
1711 #: ../src/guestfs.pod:808
1712 msgid "Read-only should be the default."
1716 #: ../src/guestfs.pod:810
1718 "In L<guestfish(3)>, I<--ro> should be the default, and you should have to "
1719 "specify I<--rw> if you want to make changes to the image."
1723 #: ../src/guestfs.pod:813
1724 msgid "This would reduce the potential to corrupt live VM images."
1728 #: ../src/guestfs.pod:815
1730 "Note that many filesystems change the disk when you just mount and unmount, "
1731 "even if you didn't perform any writes. You need to use L</"
1732 "guestfs_add_drive_ro> to guarantee that the disk is not changed."
1736 #: ../src/guestfs.pod:819
1737 msgid "guestfish command line is hard to use."
1741 #: ../src/guestfs.pod:821
1743 "C<guestfish disk.img> doesn't do what people expect (open C<disk.img> for "
1744 "examination). It tries to run a guestfish command C<disk.img> which doesn't "
1745 "exist, so it fails. In earlier versions of guestfish the error message was "
1746 "also unintuitive, but we have corrected this since. Like the Bourne shell, "
1747 "we should have used C<guestfish -c command> to run commands."
1751 #: ../src/guestfs.pod:828
1752 msgid "guestfish megabyte modifiers don't work right on all commands"
1756 #: ../src/guestfs.pod:830
1758 "In recent guestfish you can use C<1M> to mean 1 megabyte (and similarly for "
1759 "other modifiers). What guestfish actually does is to multiply the number "
1760 "part by the modifier part and pass the result to the C API. However this "
1761 "doesn't work for a few APIs which aren't expecting bytes, but are already "
1762 "expecting some other unit (eg. megabytes)."
1766 #: ../src/guestfs.pod:837
1767 msgid "The most common is L</guestfs_lvcreate>. The guestfish command:"
1771 #: ../src/guestfs.pod:839
1774 " lvcreate LV VG 100M\n"
1779 #: ../src/guestfs.pod:841
1781 "does not do what you might expect. Instead because L</guestfs_lvcreate> is "
1782 "already expecting megabytes, this tries to create a 100 I<terabyte> (100 "
1783 "megabytes * megabytes) logical volume. The error message you get from this "
1784 "is also a little obscure."
1788 #: ../src/guestfs.pod:846
1790 "This could be fixed in the generator by specially marking parameters and "
1791 "return values which take bytes or other units."
1795 #: ../src/guestfs.pod:849
1796 msgid "Ambiguity between devices and paths"
1800 #: ../src/guestfs.pod:851
1802 "There is a subtle ambiguity in the API between a device name (eg. C</dev/"
1803 "sdb2>) and a similar pathname. A file might just happen to be called "
1804 "C<sdb2> in the directory C</dev> (consider some non-Unix VM image)."
1808 #: ../src/guestfs.pod:856
1810 "In the current API we usually resolve this ambiguity by having two separate "
1811 "calls, for example L</guestfs_checksum> and L</guestfs_checksum_device>. "
1812 "Some API calls are ambiguous and (incorrectly) resolve the problem by "
1813 "detecting if the path supplied begins with C</dev/>."
1817 #: ../src/guestfs.pod:862
1819 "To avoid both the ambiguity and the need to duplicate some calls, we could "
1820 "make paths/devices into structured names. One way to do this would be to "
1821 "use a notation like grub (C<hd(0,0)>), although nobody really likes this "
1822 "aspect of grub. Another way would be to use a structured type, equivalent "
1823 "to this OCaml type:"
1827 #: ../src/guestfs.pod:868
1830 " type path = Path of string | Device of int | Partition of int * int\n"
1835 #: ../src/guestfs.pod:870
1836 msgid "which would allow you to pass arguments like:"
1840 #: ../src/guestfs.pod:872
1843 " Path \"/foo/bar\"\n"
1844 " Device 1 (* /dev/sdb, or perhaps /dev/sda *)\n"
1845 " Partition (1, 2) (* /dev/sdb2 (or is it /dev/sda2 or /dev/sdb3?) *)\n"
1846 " Path \"/dev/sdb2\" (* not a device *)\n"
1851 #: ../src/guestfs.pod:877
1853 "As you can see there are still problems to resolve even with this "
1854 "representation. Also consider how it might work in guestfish."
1858 #: ../src/guestfs.pod:882
1859 msgid "KEYS AND PASSPHRASES"
1863 #: ../src/guestfs.pod:884
1865 "Certain libguestfs calls take a parameter that contains sensitive key "
1866 "material, passed in as a C string."
1870 #: ../src/guestfs.pod:887
1872 "In the future we would hope to change the libguestfs implementation so that "
1873 "keys are L<mlock(2)>-ed into physical RAM, and thus can never end up in "
1874 "swap. However this is I<not> done at the moment, because of the complexity "
1875 "of such an implementation."
1879 #: ../src/guestfs.pod:892
1881 "Therefore you should be aware that any key parameter you pass to libguestfs "
1882 "might end up being written out to the swap partition. If this is a concern, "
1883 "scrub the swap partition or don't use libguestfs on encrypted devices."
1887 #: ../src/guestfs.pod:897
1888 msgid "MULTIPLE HANDLES AND MULTIPLE THREADS"
1892 #: ../src/guestfs.pod:899
1894 "All high-level libguestfs actions are synchronous. If you want to use "
1895 "libguestfs asynchronously then you must create a thread."
1899 #: ../src/guestfs.pod:902
1901 "Only use the handle from a single thread. Either use the handle exclusively "
1902 "from one thread, or provide your own mutex so that two threads cannot issue "
1903 "calls on the same handle at the same time."
1907 #: ../src/guestfs.pod:906
1909 "See the graphical program guestfs-browser for one possible architecture for "
1910 "multithreaded programs using libvirt and libguestfs."
1914 #: ../src/guestfs.pod:909
1919 #: ../src/guestfs.pod:911
1921 "Libguestfs needs a supermin appliance, which it finds by looking along an "
1926 #: ../src/guestfs.pod:914
1928 "By default it looks for these in the directory C<$libdir/guestfs> (eg. C</"
1929 "usr/local/lib/guestfs> or C</usr/lib64/guestfs>)."
1933 #: ../src/guestfs.pod:917
1935 "Use L</guestfs_set_path> or set the environment variable L</LIBGUESTFS_PATH> "
1936 "to change the directories that libguestfs will search in. The value is a "
1937 "colon-separated list of paths. The current directory is I<not> searched "
1938 "unless the path contains an empty element or C<.>. For example "
1939 "C<LIBGUESTFS_PATH=:/usr/lib/guestfs> would search the current directory and "
1940 "then C</usr/lib/guestfs>."
1944 #: ../src/guestfs.pod:924
1945 msgid "QEMU WRAPPERS"
1949 #: ../src/guestfs.pod:926
1951 "If you want to compile your own qemu, run qemu from a non-standard location, "
1952 "or pass extra arguments to qemu, then you can write a shell-script wrapper "
1957 #: ../src/guestfs.pod:930
1959 "There is one important rule to remember: you I<must C<exec qemu>> as the "
1960 "last command in the shell script (so that qemu replaces the shell and "
1961 "becomes the direct child of the libguestfs-using program). If you don't do "
1962 "this, then the qemu process won't be cleaned up correctly."
1966 #: ../src/guestfs.pod:935
1968 "Here is an example of a wrapper, where I have built my own copy of qemu from "
1973 #: ../src/guestfs.pod:938
1977 " qemudir=/home/rjones/d/qemu\n"
1978 " exec $qemudir/x86_64-softmmu/qemu-system-x86_64 -L $qemudir/pc-bios \"$@\"\n"
1983 #: ../src/guestfs.pod:942
1985 "Save this script as C</tmp/qemu.wrapper> (or wherever), C<chmod +x>, and "
1986 "then use it by setting the LIBGUESTFS_QEMU environment variable. For "
1991 #: ../src/guestfs.pod:946
1994 " LIBGUESTFS_QEMU=/tmp/qemu.wrapper guestfish\n"
1999 #: ../src/guestfs.pod:948
2001 "Note that libguestfs also calls qemu with the -help and -version options in "
2002 "order to determine features."
2006 #: ../src/guestfs.pod:951
2007 msgid "ATTACHING TO RUNNING DAEMONS"
2011 #: ../src/guestfs.pod:953
2013 "I<Note (1):> This is B<highly experimental> and has a tendency to eat "
2014 "babies. Use with caution."
2018 #: ../src/guestfs.pod:956
2020 "I<Note (2):> This section explains how to attach to a running daemon from a "
2021 "low level perspective. For most users, simply using virt tools such as "
2022 "L<guestfish(1)> with the I<--live> option will \"just work\"."
2026 #: ../src/guestfs.pod:960
2027 msgid "Using guestfs_set_attach_method"
2031 #: ../src/guestfs.pod:962
2033 "By calling L</guestfs_set_attach_method> you can change how the library "
2034 "connects to the C<guestfsd> daemon in L</guestfs_launch> (read L</"
2035 "ARCHITECTURE> for some background)."
2039 #: ../src/guestfs.pod:966
2041 "The normal attach method is C<appliance>, where a small appliance is created "
2042 "containing the daemon, and then the library connects to this."
2046 #: ../src/guestfs.pod:969
2048 "Setting attach method to C<unix:I<path>> (where I<path> is the path of a "
2049 "Unix domain socket) causes L</guestfs_launch> to connect to an existing "
2050 "daemon over the Unix domain socket."
2054 #: ../src/guestfs.pod:973
2056 "The normal use for this is to connect to a running virtual machine that "
2057 "contains a C<guestfsd> daemon, and send commands so you can read and write "
2058 "files inside the live virtual machine."
2062 #: ../src/guestfs.pod:977
2063 msgid "Using guestfs_add_domain with live flag"
2067 #: ../src/guestfs.pod:979
2069 "L</guestfs_add_domain> provides some help for getting the correct attach "
2070 "method. If you pass the C<live> option to this function, then (if the "
2071 "virtual machine is running) it will examine the libvirt XML looking for a "
2072 "virtio-serial channel to connect to:"
2076 #: ../src/guestfs.pod:985
2083 " <channel type='unix'>\n"
2084 " <source mode='bind' path='/path/to/socket'/>\n"
2085 " <target type='virtio' name='org.libguestfs.channel.0'/>\n"
2094 #: ../src/guestfs.pod:997
2096 "L</guestfs_add_domain> extracts C</path/to/socket> and sets the attach "
2097 "method to C<unix:/path/to/socket>."
2101 #: ../src/guestfs.pod:1000
2103 "Some of the libguestfs tools (including guestfish) support a I<--live> "
2104 "option which is passed through to L</guestfs_add_domain> thus allowing you "
2105 "to attach to and modify live virtual machines."
2109 #: ../src/guestfs.pod:1004
2111 "The virtual machine needs to have been set up beforehand so that it has the "
2112 "virtio-serial channel and so that guestfsd is running inside it."
2116 #: ../src/guestfs.pod:1008
2117 msgid "ABI GUARANTEE"
2121 #: ../src/guestfs.pod:1010
2123 "We guarantee the libguestfs ABI (binary interface), for public, high-level "
2124 "actions as outlined in this section. Although we will deprecate some "
2125 "actions, for example if they get replaced by newer calls, we will keep the "
2126 "old actions forever. This allows you the developer to program in confidence "
2127 "against the libguestfs API."
2131 #: ../src/guestfs.pod:1016
2132 msgid "BLOCK DEVICE NAMING"
2136 #: ../src/guestfs.pod:1018
2138 "In the kernel there is now quite a profusion of schemata for naming block "
2139 "devices (in this context, by I<block device> I mean a physical or virtual "
2140 "hard drive). The original Linux IDE driver used names starting with C</dev/"
2141 "hd*>. SCSI devices have historically used a different naming scheme, C</dev/"
2142 "sd*>. When the Linux kernel I<libata> driver became a popular replacement "
2143 "for the old IDE driver (particularly for SATA devices) those devices also "
2144 "used the C</dev/sd*> scheme. Additionally we now have virtual machines with "
2145 "paravirtualized drivers. This has created several different naming systems, "
2146 "such as C</dev/vd*> for virtio disks and C</dev/xvd*> for Xen PV disks."
2150 #: ../src/guestfs.pod:1030
2152 "As discussed above, libguestfs uses a qemu appliance running an embedded "
2153 "Linux kernel to access block devices. We can run a variety of appliances "
2154 "based on a variety of Linux kernels."
2158 #: ../src/guestfs.pod:1034
2160 "This causes a problem for libguestfs because many API calls use device or "
2161 "partition names. Working scripts and the recipe (example) scripts that we "
2162 "make available over the internet could fail if the naming scheme changes."
2166 #: ../src/guestfs.pod:1039
2168 "Therefore libguestfs defines C</dev/sd*> as the I<standard naming scheme>. "
2169 "Internally C</dev/sd*> names are translated, if necessary, to other names as "
2170 "required. For example, under RHEL 5 which uses the C</dev/hd*> scheme, any "
2171 "device parameter C</dev/sda2> is translated to C</dev/hda2> transparently."
2175 #: ../src/guestfs.pod:1045
2177 "Note that this I<only> applies to parameters. The L</guestfs_list_devices>, "
2178 "L</guestfs_list_partitions> and similar calls return the true names of the "
2179 "devices and partitions as known to the appliance."
2183 #: ../src/guestfs.pod:1050
2184 msgid "ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION"
2188 #: ../src/guestfs.pod:1052
2190 "Usually this translation is transparent. However in some (very rare) cases "
2191 "you may need to know the exact algorithm. Such cases include where you use "
2192 "L</guestfs_config> to add a mixture of virtio and IDE devices to the qemu-"
2193 "based appliance, so have a mixture of C</dev/sd*> and C</dev/vd*> devices."
2197 #: ../src/guestfs.pod:1058
2199 "The algorithm is applied only to I<parameters> which are known to be either "
2200 "device or partition names. Return values from functions such as L</"
2201 "guestfs_list_devices> are never changed."
2205 #: ../src/guestfs.pod:1066
2206 msgid "Is the string a parameter which is a device or partition name?"
2210 #: ../src/guestfs.pod:1070
2211 msgid "Does the string begin with C</dev/sd>?"
2215 #: ../src/guestfs.pod:1074
2217 "Does the named device exist? If so, we use that device. However if I<not> "
2218 "then we continue with this algorithm."
2222 #: ../src/guestfs.pod:1079
2223 msgid "Replace initial C</dev/sd> string with C</dev/hd>."
2227 #: ../src/guestfs.pod:1081
2228 msgid "For example, change C</dev/sda2> to C</dev/hda2>."
2232 #: ../src/guestfs.pod:1083
2233 msgid "If that named device exists, use it. If not, continue."
2237 #: ../src/guestfs.pod:1087
2238 msgid "Replace initial C</dev/sd> string with C</dev/vd>."
2242 #: ../src/guestfs.pod:1089
2243 msgid "If that named device exists, use it. If not, return an error."
2247 #: ../src/guestfs.pod:1093
2248 msgid "PORTABILITY CONCERNS WITH BLOCK DEVICE NAMING"
2252 #: ../src/guestfs.pod:1095
2254 "Although the standard naming scheme and automatic translation is useful for "
2255 "simple programs and guestfish scripts, for larger programs it is best not to "
2256 "rely on this mechanism."
2260 #: ../src/guestfs.pod:1099
2262 "Where possible for maximum future portability programs using libguestfs "
2263 "should use these future-proof techniques:"
2267 #: ../src/guestfs.pod:1106
2269 "Use L</guestfs_list_devices> or L</guestfs_list_partitions> to list actual "
2270 "device names, and then use those names directly."
2274 #: ../src/guestfs.pod:1109
2276 "Since those device names exist by definition, they will never be translated."
2280 #: ../src/guestfs.pod:1114
2282 "Use higher level ways to identify filesystems, such as LVM names, UUIDs and "
2283 "filesystem labels."
2287 #: ../src/guestfs.pod:1119
2292 #: ../src/guestfs.pod:1121
2294 "This section discusses security implications of using libguestfs, "
2295 "particularly with untrusted or malicious guests or disk images."
2299 #: ../src/guestfs.pod:1124
2300 msgid "GENERAL SECURITY CONSIDERATIONS"
2304 #: ../src/guestfs.pod:1126
2306 "Be careful with any files or data that you download from a guest (by "
2307 "\"download\" we mean not just the L</guestfs_download> command but any "
2308 "command that reads files, filenames, directories or anything else from a "
2309 "disk image). An attacker could manipulate the data to fool your program "
2310 "into doing the wrong thing. Consider cases such as:"
2314 #: ../src/guestfs.pod:1136
2315 msgid "the data (file etc) not being present"
2319 #: ../src/guestfs.pod:1140
2320 msgid "being present but empty"
2324 #: ../src/guestfs.pod:1144
2325 msgid "being much larger than normal"
2329 #: ../src/guestfs.pod:1148
2330 msgid "containing arbitrary 8 bit data"
2334 #: ../src/guestfs.pod:1152
2335 msgid "being in an unexpected character encoding"
2339 #: ../src/guestfs.pod:1156
2340 msgid "containing homoglyphs."
2344 #: ../src/guestfs.pod:1160
2345 msgid "SECURITY OF MOUNTING FILESYSTEMS"
2349 #: ../src/guestfs.pod:1162
2351 "When you mount a filesystem under Linux, mistakes in the kernel filesystem "
2352 "(VFS) module can sometimes be escalated into exploits by deliberately "
2353 "creating a malicious, malformed filesystem. These exploits are very severe "
2354 "for two reasons. Firstly there are very many filesystem drivers in the "
2355 "kernel, and many of them are infrequently used and not much developer "
2356 "attention has been paid to the code. Linux userspace helps potential "
2357 "crackers by detecting the filesystem type and automatically choosing the "
2358 "right VFS driver, even if that filesystem type is obscure or unexpected for "
2359 "the administrator. Secondly, a kernel-level exploit is like a local root "
2360 "exploit (worse in some ways), giving immediate and total access to the "
2361 "system right down to the hardware level."
2365 #: ../src/guestfs.pod:1175
2367 "That explains why you should never mount a filesystem from an untrusted "
2368 "guest on your host kernel. How about libguestfs? We run a Linux kernel "
2369 "inside a qemu virtual machine, usually running as a non-root user. The "
2370 "attacker would need to write a filesystem which first exploited the kernel, "
2371 "and then exploited either qemu virtualization (eg. a faulty qemu driver) or "
2372 "the libguestfs protocol, and finally to be as serious as the host kernel "
2373 "exploit it would need to escalate its privileges to root. This multi-step "
2374 "escalation, performed by a static piece of data, is thought to be extremely "
2375 "hard to do, although we never say 'never' about security issues."
2379 #: ../src/guestfs.pod:1186
2381 "In any case callers can reduce the attack surface by forcing the filesystem "
2382 "type when mounting (use L</guestfs_mount_vfs>)."
2386 #: ../src/guestfs.pod:1189
2387 msgid "PROTOCOL SECURITY"
2391 #: ../src/guestfs.pod:1191
2393 "The protocol is designed to be secure, being based on RFC 4506 (XDR) with a "
2394 "defined upper message size. However a program that uses libguestfs must "
2395 "also take care - for example you can write a program that downloads a binary "
2396 "from a disk image and executes it locally, and no amount of protocol "
2397 "security will save you from the consequences."
2401 #: ../src/guestfs.pod:1197
2402 msgid "INSPECTION SECURITY"
2406 #: ../src/guestfs.pod:1199
2408 "Parts of the inspection API (see L</INSPECTION>) return untrusted strings "
2409 "directly from the guest, and these could contain any 8 bit data. Callers "
2410 "should be careful to escape these before printing them to a structured file "
2411 "(for example, use HTML escaping if creating a web page)."
2415 #: ../src/guestfs.pod:1205
2417 "Guest configuration may be altered in unusual ways by the administrator of "
2418 "the virtual machine, and may not reflect reality (particularly for untrusted "
2419 "or actively malicious guests). For example we parse the hostname from "
2420 "configuration files like C</etc/sysconfig/network> that we find in the "
2421 "guest, but the guest administrator can easily manipulate these files to "
2422 "provide the wrong hostname."
2426 #: ../src/guestfs.pod:1213
2428 "The inspection API parses guest configuration using two external libraries: "
2429 "Augeas (Linux configuration) and hivex (Windows Registry). Both are "
2430 "designed to be robust in the face of malicious data, although denial of "
2431 "service attacks are still possible, for example with oversized configuration "
2436 #: ../src/guestfs.pod:1219
2437 msgid "RUNNING UNTRUSTED GUEST COMMANDS"
2441 #: ../src/guestfs.pod:1221
2443 "Be very cautious about running commands from the guest. By running a "
2444 "command in the guest, you are giving CPU time to a binary that you do not "
2445 "control, under the same user account as the library, albeit wrapped in qemu "
2446 "virtualization. More information and alternatives can be found in the "
2447 "section L</RUNNING COMMANDS>."
2451 #: ../src/guestfs.pod:1227
2452 msgid "CVE-2010-3851"
2453 msgstr "CVE-2010-3851"
2456 #: ../src/guestfs.pod:1229
2457 msgid "https://bugzilla.redhat.com/642934"
2458 msgstr "https://bugzilla.redhat.com/642934"
2461 #: ../src/guestfs.pod:1231
2463 "This security bug concerns the automatic disk format detection that qemu "
2464 "does on disk images."
2468 #: ../src/guestfs.pod:1234
2470 "A raw disk image is just the raw bytes, there is no header. Other disk "
2471 "images like qcow2 contain a special header. Qemu deals with this by looking "
2472 "for one of the known headers, and if none is found then assuming the disk "
2473 "image must be raw."
2477 #: ../src/guestfs.pod:1239
2479 "This allows a guest which has been given a raw disk image to write some "
2480 "other header. At next boot (or when the disk image is accessed by "
2481 "libguestfs) qemu would do autodetection and think the disk image format was, "
2482 "say, qcow2 based on the header written by the guest."
2486 #: ../src/guestfs.pod:1244
2488 "This in itself would not be a problem, but qcow2 offers many features, one "
2489 "of which is to allow a disk image to refer to another image (called the "
2490 "\"backing disk\"). It does this by placing the path to the backing disk "
2491 "into the qcow2 header. This path is not validated and could point to any "
2492 "host file (eg. \"/etc/passwd\"). The backing disk is then exposed through "
2493 "\"holes\" in the qcow2 disk image, which of course is completely under the "
2494 "control of the attacker."
2498 #: ../src/guestfs.pod:1252
2500 "In libguestfs this is rather hard to exploit except under two circumstances:"
2504 #: ../src/guestfs.pod:1259
2505 msgid "You have enabled the network or have opened the disk in write mode."
2509 #: ../src/guestfs.pod:1263
2511 "You are also running untrusted code from the guest (see L</RUNNING "
2516 #: ../src/guestfs.pod:1268
2518 "The way to avoid this is to specify the expected disk format when adding "
2519 "disks (the optional C<format> option to L</guestfs_add_drive_opts>). You "
2520 "should always do this if the disk is raw format, and it's a good idea for "
2525 #: ../src/guestfs.pod:1273
2527 "For disks added from libvirt using calls like L</guestfs_add_domain>, the "
2528 "format is fetched from libvirt and passed through."
2532 #: ../src/guestfs.pod:1276
2534 "For libguestfs tools, use the I<--format> command line parameter as "
2539 #: ../src/guestfs.pod:1279
2540 msgid "CONNECTION MANAGEMENT"
2544 #: ../src/guestfs.pod:1281
2549 #: ../src/guestfs.pod:1283
2551 "C<guestfs_h> is the opaque type representing a connection handle. Create a "
2552 "handle by calling L</guestfs_create>. Call L</guestfs_close> to free the "
2553 "handle and release all resources used."
2557 #: ../src/guestfs.pod:1287
2559 "For information on using multiple handles and threads, see the section L</"
2560 "MULTIPLE HANDLES AND MULTIPLE THREADS> above."
2564 #: ../src/guestfs.pod:1290
2565 msgid "guestfs_create"
2569 #: ../src/guestfs.pod:1292
2572 " guestfs_h *guestfs_create (void);\n"
2577 #: ../src/guestfs.pod:1294
2578 msgid "Create a connection handle."
2582 #: ../src/guestfs.pod:1296
2584 "On success this returns a non-NULL pointer to a handle. On error it returns "
2589 #: ../src/guestfs.pod:1299
2591 "You have to \"configure\" the handle after creating it. This includes "
2592 "calling L</guestfs_add_drive_opts> (or one of the equivalent calls) on the "
2593 "handle at least once."
2597 #: ../src/guestfs.pod:1303
2598 msgid "After configuring the handle, you have to call L</guestfs_launch>."
2602 #: ../src/guestfs.pod:1305
2604 "You may also want to configure error handling for the handle. See the L</"
2605 "ERROR HANDLING> section below."
2609 #: ../src/guestfs.pod:1308
2610 msgid "guestfs_close"
2614 #: ../src/guestfs.pod:1310
2617 " void guestfs_close (guestfs_h *g);\n"
2622 #: ../src/guestfs.pod:1312
2623 msgid "This closes the connection handle and frees up all resources used."
2627 #: ../src/guestfs.pod:1314
2629 "If autosync was set on the handle and the handle was launched, then this "
2630 "implicitly calls various functions to unmount filesystems and sync the "
2631 "disk. See L</guestfs_set_autosync> for more details."
2635 #: ../src/guestfs.pod:1318
2636 msgid "If a close callback was set on the handle, then it is called."
2640 #: ../src/guestfs.pod:1320
2641 msgid "ERROR HANDLING"
2642 msgstr "ОБРОБКА ПОМИЛОК"
2645 #: ../src/guestfs.pod:1322
2647 "API functions can return errors. For example, almost all functions that "
2648 "return C<int> will return C<-1> to indicate an error."
2652 #: ../src/guestfs.pod:1325
2654 "Additional information is available for errors: an error message string and "
2655 "optionally an error number (errno) if the thing that failed was a system "
2660 #: ../src/guestfs.pod:1329
2662 "You can get at the additional information about the last error on the handle "
2663 "by calling L</guestfs_last_error>, L</guestfs_last_errno>, and/or by setting "
2664 "up an error handler with L</guestfs_set_error_handler>."
2668 #: ../src/guestfs.pod:1334
2670 "When the handle is created, a default error handler is installed which "
2671 "prints the error message string to C<stderr>. For small short-running "
2672 "command line programs it is sufficient to do:"
2676 #: ../src/guestfs.pod:1338
2679 " if (guestfs_launch (g) == -1)\n"
2680 " exit (EXIT_FAILURE);\n"
2685 #: ../src/guestfs.pod:1341
2687 "since the default error handler will ensure that an error message has been "
2688 "printed to C<stderr> before the program exits."
2692 #: ../src/guestfs.pod:1344
2694 "For other programs the caller will almost certainly want to install an "
2695 "alternate error handler or do error handling in-line like this:"
2699 #: ../src/guestfs.pod:1347
2702 " g = guestfs_create ();\n"
2707 #: ../src/guestfs.pod:1349
2710 " /* This disables the default behaviour of printing errors\n"
2712 " guestfs_set_error_handler (g, NULL, NULL);\n"
2717 #: ../src/guestfs.pod:1353
2720 " if (guestfs_launch (g) == -1) {\n"
2721 " /* Examine the error message and print it etc. */\n"
2722 " char *msg = guestfs_last_error (g);\n"
2723 " int errnum = guestfs_last_errno (g);\n"
2724 " fprintf (stderr, \"%s\\n\", msg);\n"
2731 #: ../src/guestfs.pod:1361
2733 "Out of memory errors are handled differently. The default action is to call "
2734 "L<abort(3)>. If this is undesirable, then you can set a handler using L</"
2735 "guestfs_set_out_of_memory_handler>."
2739 #: ../src/guestfs.pod:1365
2741 "L</guestfs_create> returns C<NULL> if the handle cannot be created, and "
2742 "because there is no handle if this happens there is no way to get additional "
2743 "error information. However L</guestfs_create> is supposed to be a "
2744 "lightweight operation which can only fail because of insufficient memory (it "
2745 "returns NULL in this case)."
2749 #: ../src/guestfs.pod:1371
2750 msgid "guestfs_last_error"
2754 #: ../src/guestfs.pod:1373
2757 " const char *guestfs_last_error (guestfs_h *g);\n"
2762 #: ../src/guestfs.pod:1375
2764 "This returns the last error message that happened on C<g>. If there has not "
2765 "been an error since the handle was created, then this returns C<NULL>."
2769 #: ../src/guestfs.pod:1379
2771 "The lifetime of the returned string is until the next error occurs, or L</"
2772 "guestfs_close> is called."
2776 #: ../src/guestfs.pod:1382
2777 msgid "guestfs_last_errno"
2781 #: ../src/guestfs.pod:1384
2784 " int guestfs_last_errno (guestfs_h *g);\n"
2789 #: ../src/guestfs.pod:1386
2790 msgid "This returns the last error number (errno) that happened on C<g>."
2794 #: ../src/guestfs.pod:1388
2795 msgid "If successful, an errno integer not equal to zero is returned."
2799 #: ../src/guestfs.pod:1390
2801 "If no error, this returns 0. This call can return 0 in three situations:"
2805 #: ../src/guestfs.pod:1397
2806 msgid "There has not been any error on the handle."
2810 #: ../src/guestfs.pod:1401
2812 "There has been an error but the errno was meaningless. This corresponds to "
2813 "the case where the error did not come from a failed system call, but for "
2814 "some other reason."
2818 #: ../src/guestfs.pod:1407
2820 "There was an error from a failed system call, but for some reason the errno "
2821 "was not captured and returned. This usually indicates a bug in libguestfs."
2825 #: ../src/guestfs.pod:1413
2827 "Libguestfs tries to convert the errno from inside the applicance into a "
2828 "corresponding errno for the caller (not entirely trivial: the appliance "
2829 "might be running a completely different operating system from the library "
2830 "and error numbers are not standardized across Un*xen). If this could not be "
2831 "done, then the error is translated to C<EINVAL>. In practice this should "
2832 "only happen in very rare circumstances."
2836 #: ../src/guestfs.pod:1421
2837 msgid "guestfs_set_error_handler"
2841 #: ../src/guestfs.pod:1423
2844 " typedef void (*guestfs_error_handler_cb) (guestfs_h *g,\n"
2846 " const char *msg);\n"
2847 " void guestfs_set_error_handler (guestfs_h *g,\n"
2848 " guestfs_error_handler_cb cb,\n"
2854 #: ../src/guestfs.pod:1430
2856 "The callback C<cb> will be called if there is an error. The parameters "
2857 "passed to the callback are an opaque data pointer and the error message "
2862 #: ../src/guestfs.pod:1434
2864 "C<errno> is not passed to the callback. To get that the callback must call "
2865 "L</guestfs_last_errno>."
2869 #: ../src/guestfs.pod:1437
2871 "Note that the message string C<msg> is freed as soon as the callback "
2872 "function returns, so if you want to stash it somewhere you must make your "
2877 #: ../src/guestfs.pod:1441
2878 msgid "The default handler prints messages on C<stderr>."
2882 #: ../src/guestfs.pod:1443
2883 msgid "If you set C<cb> to C<NULL> then I<no> handler is called."
2887 #: ../src/guestfs.pod:1445
2888 msgid "guestfs_get_error_handler"
2892 #: ../src/guestfs.pod:1447
2895 " guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g,\n"
2896 " void **opaque_rtn);\n"
2901 #: ../src/guestfs.pod:1450
2902 msgid "Returns the current error handler callback."
2906 #: ../src/guestfs.pod:1452
2907 msgid "guestfs_set_out_of_memory_handler"
2911 #: ../src/guestfs.pod:1454
2914 " typedef void (*guestfs_abort_cb) (void);\n"
2915 " void guestfs_set_out_of_memory_handler (guestfs_h *g,\n"
2916 " guestfs_abort_cb);\n"
2921 #: ../src/guestfs.pod:1458
2923 "The callback C<cb> will be called if there is an out of memory situation. "
2924 "I<Note this callback must not return>."
2928 #: ../src/guestfs.pod:1461
2929 msgid "The default is to call L<abort(3)>."
2933 #: ../src/guestfs.pod:1463
2935 "You cannot set C<cb> to C<NULL>. You can't ignore out of memory situations."
2939 #: ../src/guestfs.pod:1466
2940 msgid "guestfs_get_out_of_memory_handler"
2944 #: ../src/guestfs.pod:1468
2947 " guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n"
2952 #: ../src/guestfs.pod:1470
2953 msgid "This returns the current out of memory handler."
2957 #: ../src/guestfs.pod:1472
2962 #: ../src/guestfs.pod:1474 ../fish/guestfish.pod:1019
2967 #: ../src/guestfs.pod:1476
2972 #: ../src/guestfs.pod:1478
2977 #: ../src/guestfs.pod:1480
2978 msgid "AVAILABILITY"
2982 #: ../src/guestfs.pod:1482
2983 msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE"
2987 #: ../src/guestfs.pod:1484
2989 "Using L</guestfs_available> you can test availability of the following "
2990 "groups of functions. This test queries the appliance to see if the "
2991 "appliance you are currently using supports the functionality."
2995 #: ../src/guestfs.pod:1489
2996 msgid "@AVAILABILITY@"
3000 #: ../src/guestfs.pod:1491
3001 msgid "GUESTFISH supported COMMAND"
3005 #: ../src/guestfs.pod:1493
3007 "In L<guestfish(3)> there is a handy interactive command C<supported> which "
3008 "prints out the available groups and whether they are supported by this build "
3009 "of libguestfs. Note however that you have to do C<run> first."
3013 #: ../src/guestfs.pod:1498
3014 msgid "SINGLE CALLS AT COMPILE TIME"
3018 #: ../src/guestfs.pod:1500
3020 "Since version 1.5.8, C<E<lt>guestfs.hE<gt>> defines symbols for each C API "
3021 "function, such as:"
3025 #: ../src/guestfs.pod:1503
3028 " #define LIBGUESTFS_HAVE_DD 1\n"
3033 #: ../src/guestfs.pod:1505
3034 msgid "if L</guestfs_dd> is available."
3038 #: ../src/guestfs.pod:1507
3040 "Before version 1.5.8, if you needed to test whether a single libguestfs "
3041 "function is available at compile time, we recommended using build tools such "
3042 "as autoconf or cmake. For example in autotools you could use:"
3046 #: ../src/guestfs.pod:1512
3049 " AC_CHECK_LIB([guestfs],[guestfs_create])\n"
3050 " AC_CHECK_FUNCS([guestfs_dd])\n"
3055 #: ../src/guestfs.pod:1515
3057 "which would result in C<HAVE_GUESTFS_DD> being either defined or not defined "
3062 #: ../src/guestfs.pod:1518
3063 msgid "SINGLE CALLS AT RUN TIME"
3067 #: ../src/guestfs.pod:1520
3069 "Testing at compile time doesn't guarantee that a function really exists in "
3070 "the library. The reason is that you might be dynamically linked against a "
3071 "previous I<libguestfs.so> (dynamic library) which doesn't have the call. "
3072 "This situation unfortunately results in a segmentation fault, which is a "
3073 "shortcoming of the C dynamic linking system itself."
3077 #: ../src/guestfs.pod:1527
3079 "You can use L<dlopen(3)> to test if a function is available at run time, as "
3080 "in this example program (note that you still need the compile time check as "
3085 #: ../src/guestfs.pod:1531
3088 " #include <stdio.h>\n"
3089 " #include <stdlib.h>\n"
3090 " #include <unistd.h>\n"
3091 " #include <dlfcn.h>\n"
3092 " #include <guestfs.h>\n"
3097 #: ../src/guestfs.pod:1537
3102 " #ifdef LIBGUESTFS_HAVE_DD\n"
3104 " int has_function;\n"
3109 #: ../src/guestfs.pod:1543
3112 " /* Test if the function guestfs_dd is really available. */\n"
3113 " dl = dlopen (NULL, RTLD_LAZY);\n"
3115 " fprintf (stderr, \"dlopen: %s\\n\", dlerror ());\n"
3116 " exit (EXIT_FAILURE);\n"
3118 " has_function = dlsym (dl, \"guestfs_dd\") != NULL;\n"
3124 #: ../src/guestfs.pod:1552
3127 " if (!has_function)\n"
3128 " printf (\"this libguestfs.so does NOT have guestfs_dd function\\n\");\n"
3130 " printf (\"this libguestfs.so has guestfs_dd function\\n\");\n"
3131 " /* Now it's safe to call\n"
3132 " guestfs_dd (g, \"foo\", \"bar\");\n"
3136 " printf (\"guestfs_dd function was not found at compile time\\n\");\n"
3143 #: ../src/guestfs.pod:1565
3145 "You may think the above is an awful lot of hassle, and it is. There are "
3146 "other ways outside of the C linking system to ensure that this kind of "
3147 "incompatibility never arises, such as using package versioning:"
3151 #: ../src/guestfs.pod:1570
3154 " Requires: libguestfs >= 1.0.80\n"
3159 #: ../src/guestfs.pod:1572
3160 msgid "CALLS WITH OPTIONAL ARGUMENTS"
3164 #: ../src/guestfs.pod:1574
3166 "A recent feature of the API is the introduction of calls which take optional "
3167 "arguments. In C these are declared 3 ways. The main way is as a call which "
3168 "takes variable arguments (ie. C<...>), as in this example:"
3172 #: ../src/guestfs.pod:1579
3175 " int guestfs_add_drive_opts (guestfs_h *g, const char *filename, ...);\n"
3180 #: ../src/guestfs.pod:1581
3182 "Call this with a list of optional arguments, terminated by C<-1>. So to "
3183 "call with no optional arguments specified:"
3187 #: ../src/guestfs.pod:1584
3190 " guestfs_add_drive_opts (g, filename, -1);\n"
3195 #: ../src/guestfs.pod:1586
3196 msgid "With a single optional argument:"
3200 #: ../src/guestfs.pod:1588
3203 " guestfs_add_drive_opts (g, filename,\n"
3204 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
3210 #: ../src/guestfs.pod:1592
3215 #: ../src/guestfs.pod:1594
3218 " guestfs_add_drive_opts (g, filename,\n"
3219 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
3220 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
3226 #: ../src/guestfs.pod:1599
3228 "and so forth. Don't forget the terminating C<-1> otherwise Bad Things will "
3233 #: ../src/guestfs.pod:1602
3234 msgid "USING va_list FOR OPTIONAL ARGUMENTS"
3238 #: ../src/guestfs.pod:1604
3240 "The second variant has the same name with the suffix C<_va>, which works the "
3241 "same way but takes a C<va_list>. See the C manual for details. For the "
3242 "example function, this is declared:"
3246 #: ../src/guestfs.pod:1608
3249 " int guestfs_add_drive_opts_va (guestfs_h *g, const char *filename,\n"
3255 #: ../src/guestfs.pod:1611
3256 msgid "CONSTRUCTING OPTIONAL ARGUMENTS"
3260 #: ../src/guestfs.pod:1613
3262 "The third variant is useful where you need to construct these calls. You "
3263 "pass in a structure where you fill in the optional fields. The structure "
3264 "has a bitmask as the first element which you must set to indicate which "
3265 "fields you have filled in. For our example function the structure and call "
3270 #: ../src/guestfs.pod:1619
3273 " struct guestfs_add_drive_opts_argv {\n"
3274 " uint64_t bitmask;\n"
3276 " const char *format;\n"
3279 " int guestfs_add_drive_opts_argv (guestfs_h *g, const char *filename,\n"
3280 " const struct guestfs_add_drive_opts_argv *optargs);\n"
3285 #: ../src/guestfs.pod:1628
3286 msgid "You could call it like this:"
3290 #: ../src/guestfs.pod:1630
3293 " struct guestfs_add_drive_opts_argv optargs = {\n"
3294 " .bitmask = GUESTFS_ADD_DRIVE_OPTS_READONLY_BITMASK |\n"
3295 " GUESTFS_ADD_DRIVE_OPTS_FORMAT_BITMASK,\n"
3297 " .format = \"qcow2\"\n"
3303 #: ../src/guestfs.pod:1637
3306 " guestfs_add_drive_opts_argv (g, filename, &optargs);\n"
3311 #: ../src/guestfs.pod:1639 ../src/guestfs-actions.pod:11
3312 #: ../src/guestfs-actions.pod:1857 ../src/guestfs-actions.pod:2257
3313 #: ../fish/guestfish-actions.pod:9 ../fish/guestfish-actions.pod:1262
3314 #: ../fish/guestfish-actions.pod:1515 ../tools/virt-win-reg.pl:532
3319 #: ../src/guestfs.pod:1645
3320 msgid "The C<_BITMASK> suffix on each option name when specifying the bitmask."
3324 #: ../src/guestfs.pod:1650
3325 msgid "You do not need to fill in all fields of the structure."
3329 #: ../src/guestfs.pod:1654
3331 "There must be a one-to-one correspondence between fields of the structure "
3332 "that are filled in, and bits set in the bitmask."
3336 #: ../src/guestfs.pod:1659
3337 msgid "OPTIONAL ARGUMENTS IN OTHER LANGUAGES"
3341 #: ../src/guestfs.pod:1661
3343 "In other languages, optional arguments are expressed in the way that is "
3344 "natural for that language. We refer you to the language-specific "
3345 "documentation for more details on that."
3349 #: ../src/guestfs.pod:1665
3350 msgid "For guestfish, see L<guestfish(1)/OPTIONAL ARGUMENTS>."
3354 #: ../src/guestfs.pod:1667
3355 msgid "SETTING CALLBACKS TO HANDLE EVENTS"
3359 #: ../src/guestfs.pod:1669
3361 "B<Note:> This section documents the generic event mechanism introduced in "
3362 "libguestfs 1.10, which you should use in new code if possible. The old "
3363 "functions C<guestfs_set_log_message_callback>, "
3364 "C<guestfs_set_subprocess_quit_callback>, "
3365 "C<guestfs_set_launch_done_callback>, C<guestfs_set_close_callback> and "
3366 "C<guestfs_set_progress_callback> are no longer documented in this manual "
3371 #: ../src/guestfs.pod:1677
3373 "Handles generate events when certain things happen, such as log messages "
3374 "being generated, progress messages during long-running operations, or the "
3375 "handle being closed. The API calls described below let you register a "
3376 "callback to be called when events happen. You can register multiple "
3377 "callbacks (for the same, different or overlapping sets of events), and "
3378 "individually remove callbacks. If callbacks are not removed, then they "
3379 "remain in force until the handle is closed."
3383 #: ../src/guestfs.pod:1685
3385 "In the current implementation, events are only generated synchronously: that "
3386 "means that events (and hence callbacks) can only happen while you are in the "
3387 "middle of making another libguestfs call. The callback is called in the "
3392 #: ../src/guestfs.pod:1690
3394 "Events may contain a payload, usually nothing (void), an array of 64 bit "
3395 "unsigned integers, or a message buffer. Payloads are discussed later on."
3399 #: ../src/guestfs.pod:1694
3400 msgid "CLASSES OF EVENTS"
3404 #: ../src/guestfs.pod:1698
3405 msgid "GUESTFS_EVENT_CLOSE (payload type: void)"
3409 #: ../src/guestfs.pod:1701
3411 "The callback function will be called while the handle is being closed "
3412 "(synchronously from L</guestfs_close>)."
3416 #: ../src/guestfs.pod:1704
3418 "Note that libguestfs installs an L<atexit(3)> handler to try to clean up "
3419 "handles that are open when the program exits. This means that this callback "
3420 "might be called indirectly from L<exit(3)>, which can cause unexpected "
3421 "problems in higher-level languages (eg. if your HLL interpreter has already "
3422 "been cleaned up by the time this is called, and if your callback then jumps "
3423 "into some HLL function)."
3427 #: ../src/guestfs.pod:1711
3429 "If no callback is registered: the handle is closed without any callback "
3434 #: ../src/guestfs.pod:1714
3435 msgid "GUESTFS_EVENT_SUBPROCESS_QUIT (payload type: void)"
3439 #: ../src/guestfs.pod:1717
3441 "The callback function will be called when the child process quits, either "
3442 "asynchronously or if killed by L</guestfs_kill_subprocess>. (This "
3443 "corresponds to a transition from any state to the CONFIG state)."
3447 #: ../src/guestfs.pod:1721 ../src/guestfs.pod:1730
3448 msgid "If no callback is registered: the event is ignored."
3452 #: ../src/guestfs.pod:1723
3453 msgid "GUESTFS_EVENT_LAUNCH_DONE (payload type: void)"
3457 #: ../src/guestfs.pod:1726
3459 "The callback function will be called when the child process becomes ready "
3460 "first time after it has been launched. (This corresponds to a transition "
3461 "from LAUNCHING to the READY state)."
3465 #: ../src/guestfs.pod:1732
3466 msgid "GUESTFS_EVENT_PROGRESS (payload type: array of 4 x uint64_t)"
3470 #: ../src/guestfs.pod:1735
3472 "Some long-running operations can generate progress messages. If this "
3473 "callback is registered, then it will be called each time a progress message "
3474 "is generated (usually two seconds after the operation started, and three "
3475 "times per second thereafter until it completes, although the frequency may "
3476 "change in future versions)."
3480 #: ../src/guestfs.pod:1741
3482 "The callback receives in the payload four unsigned 64 bit numbers which are "
3483 "(in order): C<proc_nr>, C<serial>, C<position>, C<total>."
3487 #: ../src/guestfs.pod:1744
3489 "The units of C<total> are not defined, although for some operations C<total> "
3490 "may relate in some way to the amount of data to be transferred (eg. in bytes "
3491 "or megabytes), and C<position> may be the portion which has been transferred."
3495 #: ../src/guestfs.pod:1749
3496 msgid "The only defined and stable parts of the API are:"
3500 #: ../src/guestfs.pod:1755
3502 "The callback can display to the user some type of progress bar or indicator "
3503 "which shows the ratio of C<position>:C<total>."
3507 #: ../src/guestfs.pod:1760
3508 msgid "0 E<lt>= C<position> E<lt>= C<total>"
3512 #: ../src/guestfs.pod:1764
3514 "If any progress notification is sent during a call, then a final progress "
3515 "notification is always sent when C<position> = C<total> (I<unless> the call "
3516 "fails with an error)."
3520 #: ../src/guestfs.pod:1768
3522 "This is to simplify caller code, so callers can easily set the progress "
3523 "indicator to \"100%\" at the end of the operation, without requiring special "
3524 "code to detect this case."
3528 #: ../src/guestfs.pod:1774
3530 "For some calls we are unable to estimate the progress of the call, but we "
3531 "can still generate progress messages to indicate activity. This is known as "
3532 "\"pulse mode\", and is directly supported by certain progress bar "
3533 "implementations (eg. GtkProgressBar)."
3537 #: ../src/guestfs.pod:1779
3539 "For these calls, zero or more progress messages are generated with "
3540 "C<position = 0> and C<total = 1>, followed by a final message with "
3541 "C<position = total = 1>."
3545 #: ../src/guestfs.pod:1783
3547 "As noted above, if the call fails with an error then the final message may "
3552 #: ../src/guestfs.pod:1788
3554 "The callback also receives the procedure number (C<proc_nr>) and serial "
3555 "number (C<serial>) of the call. These are only useful for debugging "
3556 "protocol issues, and the callback can normally ignore them. The callback "
3557 "may want to print these numbers in error messages or debugging messages."
3561 #: ../src/guestfs.pod:1794
3562 msgid "If no callback is registered: progress messages are discarded."
3566 #: ../src/guestfs.pod:1796
3567 msgid "GUESTFS_EVENT_APPLIANCE (payload type: message buffer)"
3571 #: ../src/guestfs.pod:1799
3573 "The callback function is called whenever a log message is generated by qemu, "
3574 "the appliance kernel, guestfsd (daemon), or utility programs."
3578 #: ../src/guestfs.pod:1802
3580 "If the verbose flag (L</guestfs_set_verbose>) is set before launch (L</"
3581 "guestfs_launch>) then additional debug messages are generated."
3585 #: ../src/guestfs.pod:1805 ../src/guestfs.pod:1819
3587 "If no callback is registered: the messages are discarded unless the verbose "
3588 "flag is set in which case they are sent to stderr. You can override the "
3589 "printing of verbose messages to stderr by setting up a callback."
3593 #: ../src/guestfs.pod:1810
3594 msgid "GUESTFS_EVENT_LIBRARY (payload type: message buffer)"
3598 #: ../src/guestfs.pod:1813
3600 "The callback function is called whenever a log message is generated by the "
3601 "library part of libguestfs."
3605 #: ../src/guestfs.pod:1816
3607 "If the verbose flag (L</guestfs_set_verbose>) is set then additional debug "
3608 "messages are generated."
3612 #: ../src/guestfs.pod:1824
3613 msgid "GUESTFS_EVENT_TRACE (payload type: message buffer)"
3617 #: ../src/guestfs.pod:1827
3619 "The callback function is called whenever a trace message is generated. This "
3620 "only applies if the trace flag (L</guestfs_set_trace>) is set."
3624 #: ../src/guestfs.pod:1830
3626 "If no callback is registered: the messages are sent to stderr. You can "
3627 "override the printing of trace messages to stderr by setting up a callback."
3631 #: ../src/guestfs.pod:1836
3632 msgid "guestfs_set_event_callback"
3636 #: ../src/guestfs.pod:1838
3639 " int guestfs_set_event_callback (guestfs_h *g,\n"
3640 " guestfs_event_callback cb,\n"
3641 " uint64_t event_bitmask,\n"
3648 #: ../src/guestfs.pod:1844
3650 "This function registers a callback (C<cb>) for all event classes in the "
3655 #: ../src/guestfs.pod:1847
3657 "For example, to register for all log message events, you could call this "
3658 "function with the bitmask C<GUESTFS_EVENT_APPLIANCE|GUESTFS_EVENT_LIBRARY>. "
3659 "To register a single callback for all possible classes of events, use "
3660 "C<GUESTFS_EVENT_ALL>."
3664 #: ../src/guestfs.pod:1853
3665 msgid "C<flags> should always be passed as 0."
3669 #: ../src/guestfs.pod:1855
3671 "C<opaque> is an opaque pointer which is passed to the callback. You can use "
3672 "it for any purpose."
3676 #: ../src/guestfs.pod:1858
3678 "The return value is the event handle (an integer) which you can use to "
3679 "delete the callback (see below)."
3683 #: ../src/guestfs.pod:1861
3685 "If there is an error, this function returns C<-1>, and sets the error in the "
3686 "handle in the usual way (see L</guestfs_last_error> etc.)"
3690 #: ../src/guestfs.pod:1864
3692 "Callbacks remain in effect until they are deleted, or until the handle is "
3697 #: ../src/guestfs.pod:1867
3699 "In the case where multiple callbacks are registered for a particular event "
3700 "class, all of the callbacks are called. The order in which multiple "
3701 "callbacks are called is not defined."
3705 #: ../src/guestfs.pod:1871
3706 msgid "guestfs_delete_event_callback"
3710 #: ../src/guestfs.pod:1873
3713 " void guestfs_delete_event_callback (guestfs_h *g, int event_handle);\n"
3718 #: ../src/guestfs.pod:1875
3720 "Delete a callback that was previously registered. C<event_handle> should be "
3721 "the integer that was returned by a previous call to "
3722 "C<guestfs_set_event_callback> on the same handle."
3726 #: ../src/guestfs.pod:1879
3727 msgid "guestfs_event_callback"
3731 #: ../src/guestfs.pod:1881
3734 " typedef void (*guestfs_event_callback) (\n"
3737 " uint64_t event,\n"
3738 " int event_handle,\n"
3740 " const char *buf, size_t buf_len,\n"
3741 " const uint64_t *array, size_t array_len);\n"
3746 #: ../src/guestfs.pod:1890
3748 "This is the type of the event callback function that you have to provide."
3752 #: ../src/guestfs.pod:1893
3754 "The basic parameters are: the handle (C<g>), the opaque user pointer "
3755 "(C<opaque>), the event class (eg. C<GUESTFS_EVENT_PROGRESS>), the event "
3756 "handle, and C<flags> which in the current API you should ignore."
3760 #: ../src/guestfs.pod:1897
3762 "The remaining parameters contain the event payload (if any). Each event may "
3763 "contain a payload, which usually relates to the event class, but for future "
3764 "proofing your code should be written to handle any payload for any event "
3769 #: ../src/guestfs.pod:1902
3771 "C<buf> and C<buf_len> contain a message buffer (if C<buf_len == 0>, then "
3772 "there is no message buffer). Note that this message buffer can contain "
3773 "arbitrary 8 bit data, including NUL bytes."
3777 #: ../src/guestfs.pod:1906
3779 "C<array> and C<array_len> is an array of 64 bit unsigned integers. At the "
3780 "moment this is only used for progress messages."
3784 #: ../src/guestfs.pod:1909
3785 msgid "EXAMPLE: CAPTURING LOG MESSAGES"
3789 #: ../src/guestfs.pod:1911
3791 "One motivation for the generic event API was to allow GUI programs to "
3792 "capture debug and other messages. In libguestfs E<le> 1.8 these were sent "
3793 "unconditionally to C<stderr>."
3797 #: ../src/guestfs.pod:1915
3799 "Events associated with log messages are: C<GUESTFS_EVENT_LIBRARY>, "
3800 "C<GUESTFS_EVENT_APPLIANCE> and C<GUESTFS_EVENT_TRACE>. (Note that error "
3801 "messages are not events; you must capture error messages separately)."
3805 #: ../src/guestfs.pod:1920
3807 "Programs have to set up a callback to capture the classes of events of "
3812 #: ../src/guestfs.pod:1923
3816 " guestfs_set_event_callback\n"
3817 " (g, message_callback,\n"
3818 " GUESTFS_EVENT_LIBRARY|GUESTFS_EVENT_APPLIANCE|\n"
3819 " GUESTFS_EVENT_TRACE,\n"
3820 " 0, NULL) == -1)\n"
3821 " if (eh == -1) {\n"
3822 " // handle error in the usual way\n"
3828 #: ../src/guestfs.pod:1933
3830 "The callback can then direct messages to the appropriate place. In this "
3831 "example, messages are directed to syslog:"
3835 #: ../src/guestfs.pod:1936
3839 " message_callback (\n"
3842 " uint64_t event,\n"
3843 " int event_handle,\n"
3845 " const char *buf, size_t buf_len,\n"
3846 " const uint64_t *array, size_t array_len)\n"
3848 " const int priority = LOG_USER|LOG_INFO;\n"
3849 " if (buf_len > 0)\n"
3850 " syslog (priority, \"event 0x%lx: %s\", event, buf);\n"
3856 #: ../src/guestfs.pod:1951
3857 msgid "PRIVATE DATA AREA"
3861 #: ../src/guestfs.pod:1953
3863 "You can attach named pieces of private data to the libguestfs handle, fetch "
3864 "them by name, and walk over them, for the lifetime of the handle. This is "
3865 "called the private data area and is only available from the C API."
3869 #: ../src/guestfs.pod:1958
3870 msgid "To attach a named piece of data, use the following call:"
3874 #: ../src/guestfs.pod:1960
3877 " void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n"
3882 #: ../src/guestfs.pod:1962
3884 "C<key> is the name to associate with this data, and C<data> is an arbitrary "
3885 "pointer (which can be C<NULL>). Any previous item with the same key is "
3890 #: ../src/guestfs.pod:1966
3892 "You can use any C<key> you want, but your key should I<not> start with an "
3893 "underscore character. Keys beginning with an underscore character are "
3894 "reserved for internal libguestfs purposes (eg. for implementing language "
3895 "bindings). It is recommended that you prefix the key with some unique "
3896 "string to avoid collisions with other users."
3900 #: ../src/guestfs.pod:1972
3901 msgid "To retrieve the pointer, use:"
3905 #: ../src/guestfs.pod:1974
3908 " void *guestfs_get_private (guestfs_h *g, const char *key);\n"
3913 #: ../src/guestfs.pod:1976
3915 "This function returns C<NULL> if either no data is found associated with "
3916 "C<key>, or if the user previously set the C<key>'s C<data> pointer to "
3921 #: ../src/guestfs.pod:1980
3923 "Libguestfs does not try to look at or interpret the C<data> pointer in any "
3924 "way. As far as libguestfs is concerned, it need not be a valid pointer at "
3925 "all. In particular, libguestfs does I<not> try to free the data when the "
3926 "handle is closed. If the data must be freed, then the caller must either "
3927 "free it before calling L</guestfs_close> or must set up a close callback to "
3928 "do it (see L</GUESTFS_EVENT_CLOSE>)."
3932 #: ../src/guestfs.pod:1987
3933 msgid "To walk over all entries, use these two functions:"
3937 #: ../src/guestfs.pod:1989
3940 " void *guestfs_first_private (guestfs_h *g, const char **key_rtn);\n"
3945 #: ../src/guestfs.pod:1991
3948 " void *guestfs_next_private (guestfs_h *g, const char **key_rtn);\n"
3953 #: ../src/guestfs.pod:1993
3955 "C<guestfs_first_private> returns the first key, pointer pair (\"first\" does "
3956 "not have any particular meaning -- keys are not returned in any defined "
3957 "order). A pointer to the key is returned in C<*key_rtn> and the "
3958 "corresponding data pointer is returned from the function. C<NULL> is "
3959 "returned if there are no keys stored in the handle."
3963 #: ../src/guestfs.pod:1999
3965 "C<guestfs_next_private> returns the next key, pointer pair. The return "
3966 "value of this function is also C<NULL> is there are no further entries to "
3971 #: ../src/guestfs.pod:2003
3972 msgid "Notes about walking over entries:"
3976 #: ../src/guestfs.pod:2009
3978 "You must not call C<guestfs_set_private> while walking over the entries."
3982 #: ../src/guestfs.pod:2014
3984 "The handle maintains an internal iterator which is reset when you call "
3985 "C<guestfs_first_private>. This internal iterator is invalidated when you "
3986 "call C<guestfs_set_private>."
3990 #: ../src/guestfs.pod:2020
3991 msgid "If you have set the data pointer associated with a key to C<NULL>, ie:"
3995 #: ../src/guestfs.pod:2022
3998 " guestfs_set_private (g, key, NULL);\n"
4003 #: ../src/guestfs.pod:2024
4004 msgid "then that C<key> is not returned when walking."
4008 #: ../src/guestfs.pod:2028
4010 "C<*key_rtn> is only valid until the next call to C<guestfs_first_private>, "
4011 "C<guestfs_next_private> or C<guestfs_set_private>."
4015 #: ../src/guestfs.pod:2034
4017 "The following example code shows how to print all keys and data pointers "
4018 "that are associated with the handle C<g>:"
4022 #: ../src/guestfs.pod:2037
4025 " const char *key;\n"
4026 " void *data = guestfs_first_private (g, &key);\n"
4027 " while (data != NULL)\n"
4029 " printf (\"key = %s, data = %p\\n\", key, data);\n"
4030 " data = guestfs_next_private (g, &key);\n"
4036 #: ../src/guestfs.pod:2045
4038 "More commonly you are only interested in keys that begin with an application-"
4039 "specific prefix C<foo_>. Modify the loop like so:"
4043 #: ../src/guestfs.pod:2048
4046 " const char *key;\n"
4047 " void *data = guestfs_first_private (g, &key);\n"
4048 " while (data != NULL)\n"
4050 " if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
4051 " printf (\"key = %s, data = %p\\n\", key, data);\n"
4052 " data = guestfs_next_private (g, &key);\n"
4058 #: ../src/guestfs.pod:2057
4060 "If you need to modify keys while walking, then you have to jump back to the "
4061 "beginning of the loop. For example, to delete all keys prefixed with "
4066 #: ../src/guestfs.pod:2061
4069 " const char *key;\n"
4072 " data = guestfs_first_private (g, &key);\n"
4073 " while (data != NULL)\n"
4075 " if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
4077 " guestfs_set_private (g, key, NULL);\n"
4078 " /* note that 'key' pointer is now invalid, and so is\n"
4079 " the internal iterator */\n"
4082 " data = guestfs_next_private (g, &key);\n"
4088 #: ../src/guestfs.pod:2077
4090 "Note that the above loop is guaranteed to terminate because the keys are "
4091 "being deleted, but other manipulations of keys within the loop might not "
4092 "terminate unless you also maintain an indication of which keys have been "
4097 #: ../src/guestfs.pod:2082 ../src/guestfs.pod:2087
4102 #: ../src/guestfs.pod:2084
4104 "<!-- old anchor for the next section --> <a name="
4105 "\"state_machine_and_low_level_event_api\"/>"
4107 "<!-- old anchor for the next section --> <a name="
4108 "\"state_machine_and_low_level_event_api\"/>"
4111 #: ../src/guestfs.pod:2089
4112 msgid "ARCHITECTURE"
4113 msgstr "АРХІТЕКТУРА"
4116 #: ../src/guestfs.pod:2091
4118 "Internally, libguestfs is implemented by running an appliance (a special "
4119 "type of small virtual machine) using L<qemu(1)>. Qemu runs as a child "
4120 "process of the main program."
4124 #: ../src/guestfs.pod:2095
4127 " ___________________\n"
4129 " | main program |\n"
4131 " | | child process / appliance\n"
4132 " | | __________________________\n"
4134 " +-------------------+ RPC | +-----------------+ |\n"
4135 " | libguestfs <--------------------> guestfsd | |\n"
4136 " | | | +-----------------+ |\n"
4137 " \\___________________/ | | Linux kernel | |\n"
4138 " | +--^--------------+ |\n"
4139 " \\_________|________________/\n"
4145 " \\______________/\n"
4150 #: ../src/guestfs.pod:2115
4152 "The library, linked to the main program, creates the child process and hence "
4153 "the appliance in the L</guestfs_launch> function."
4157 #: ../src/guestfs.pod:2118
4159 "Inside the appliance is a Linux kernel and a complete stack of userspace "
4160 "tools (such as LVM and ext2 programs) and a small controlling daemon called "
4161 "L</guestfsd>. The library talks to L</guestfsd> using remote procedure "
4162 "calls (RPC). There is a mostly one-to-one correspondence between libguestfs "
4163 "API calls and RPC calls to the daemon. Lastly the disk image(s) are "
4164 "attached to the qemu process which translates device access by the "
4165 "appliance's Linux kernel into accesses to the image."
4169 #: ../src/guestfs.pod:2127
4171 "A common misunderstanding is that the appliance \"is\" the virtual machine. "
4172 "Although the disk image you are attached to might also be used by some "
4173 "virtual machine, libguestfs doesn't know or care about this. (But you will "
4174 "care if both libguestfs's qemu process and your virtual machine are trying "
4175 "to update the disk image at the same time, since these usually results in "
4176 "massive disk corruption)."
4180 #: ../src/guestfs.pod:2134
4181 msgid "STATE MACHINE"
4182 msgstr "СКІНЧЕННИЙ АВТОМАТ"
4185 #: ../src/guestfs.pod:2136
4186 msgid "libguestfs uses a state machine to model the child process:"
4190 #: ../src/guestfs.pod:2138
4202 " / | \\ \\ guestfs_launch\n"
4203 " / | _\\__V______\n"
4205 " / | | LAUNCHING |\n"
4206 " / | \\___________/\n"
4208 " / | guestfs_launch\n"
4210 " ______ / __|____V\n"
4211 " / \\ ------> / \\\n"
4212 " | BUSY | | READY |\n"
4213 " \\______/ <------ \\________/\n"
4218 #: ../src/guestfs.pod:2160
4220 "The normal transitions are (1) CONFIG (when the handle is created, but there "
4221 "is no child process), (2) LAUNCHING (when the child process is booting up), "
4222 "(3) alternating between READY and BUSY as commands are issued to, and "
4223 "carried out by, the child process."
4227 #: ../src/guestfs.pod:2165
4229 "The guest may be killed by L</guestfs_kill_subprocess>, or may die "
4230 "asynchronously at any time (eg. due to some internal error), and that causes "
4231 "the state to transition back to CONFIG."
4235 #: ../src/guestfs.pod:2169
4237 "Configuration commands for qemu such as L</guestfs_add_drive> can only be "
4238 "issued when in the CONFIG state."
4242 #: ../src/guestfs.pod:2172
4244 "The API offers one call that goes from CONFIG through LAUNCHING to READY. "
4245 "L</guestfs_launch> blocks until the child process is READY to accept "
4246 "commands (or until some failure or timeout). L</guestfs_launch> internally "
4247 "moves the state from CONFIG to LAUNCHING while it is running."
4251 #: ../src/guestfs.pod:2178
4253 "API actions such as L</guestfs_mount> can only be issued when in the READY "
4254 "state. These API calls block waiting for the command to be carried out (ie. "
4255 "the state to transition to BUSY and then back to READY). There are no non-"
4256 "blocking versions, and no way to issue more than one command per handle at "
4261 #: ../src/guestfs.pod:2184
4263 "Finally, the child process sends asynchronous messages back to the main "
4264 "program, such as kernel log messages. You can register a callback to "
4265 "receive these messages."
4269 #: ../src/guestfs.pod:2188
4274 #: ../src/guestfs.pod:2190
4275 msgid "COMMUNICATION PROTOCOL"
4279 #: ../src/guestfs.pod:2192
4281 "Don't rely on using this protocol directly. This section documents how it "
4282 "currently works, but it may change at any time."
4286 #: ../src/guestfs.pod:2195
4288 "The protocol used to talk between the library and the daemon running inside "
4289 "the qemu virtual machine is a simple RPC mechanism built on top of XDR (RFC "
4290 "1014, RFC 1832, RFC 4506)."
4294 #: ../src/guestfs.pod:2199
4296 "The detailed format of structures is in C<src/guestfs_protocol.x> (note: "
4297 "this file is automatically generated)."
4301 #: ../src/guestfs.pod:2202
4303 "There are two broad cases, ordinary functions that don't have any C<FileIn> "
4304 "and C<FileOut> parameters, which are handled with very simple request/reply "
4305 "messages. Then there are functions that have any C<FileIn> or C<FileOut> "
4306 "parameters, which use the same request and reply messages, but they may also "
4307 "be followed by files sent using a chunked encoding."
4311 #: ../src/guestfs.pod:2209
4312 msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)"
4316 #: ../src/guestfs.pod:2211
4317 msgid "For ordinary functions, the request message is:"
4321 #: ../src/guestfs.pod:2213
4324 " total length (header + arguments,\n"
4325 " but not including the length word itself)\n"
4326 " struct guestfs_message_header (encoded as XDR)\n"
4327 " struct guestfs_<foo>_args (encoded as XDR)\n"
4332 #: ../src/guestfs.pod:2218
4334 "The total length field allows the daemon to allocate a fixed size buffer "
4335 "into which it slurps the rest of the message. As a result, the total length "
4336 "is limited to C<GUESTFS_MESSAGE_MAX> bytes (currently 4MB), which means the "
4337 "effective size of any request is limited to somewhere under this size."
4341 #: ../src/guestfs.pod:2224
4343 "Note also that many functions don't take any arguments, in which case the "
4344 "C<guestfs_I<foo>_args> is completely omitted."
4348 #: ../src/guestfs.pod:2227
4350 "The header contains the procedure number (C<guestfs_proc>) which is how the "
4351 "receiver knows what type of args structure to expect, or none at all."
4355 #: ../src/guestfs.pod:2231
4357 "For functions that take optional arguments, the optional arguments are "
4358 "encoded in the C<guestfs_I<foo>_args> structure in the same way as ordinary "
4359 "arguments. A bitmask in the header indicates which optional arguments are "
4360 "meaningful. The bitmask is also checked to see if it contains bits set "
4361 "which the daemon does not know about (eg. if more optional arguments were "
4362 "added in a later version of the library), and this causes the call to be "
4367 #: ../src/guestfs.pod:2239
4368 msgid "The reply message for ordinary functions is:"
4372 #: ../src/guestfs.pod:2241
4375 " total length (header + ret,\n"
4376 " but not including the length word itself)\n"
4377 " struct guestfs_message_header (encoded as XDR)\n"
4378 " struct guestfs_<foo>_ret (encoded as XDR)\n"
4383 #: ../src/guestfs.pod:2246
4385 "As above the C<guestfs_I<foo>_ret> structure may be completely omitted for "
4386 "functions that return no formal return values."
4390 #: ../src/guestfs.pod:2249
4392 "As above the total length of the reply is limited to C<GUESTFS_MESSAGE_MAX>."
4396 #: ../src/guestfs.pod:2252
4398 "In the case of an error, a flag is set in the header, and the reply message "
4399 "is slightly changed:"
4403 #: ../src/guestfs.pod:2255
4406 " total length (header + error,\n"
4407 " but not including the length word itself)\n"
4408 " struct guestfs_message_header (encoded as XDR)\n"
4409 " struct guestfs_message_error (encoded as XDR)\n"
4414 #: ../src/guestfs.pod:2260
4416 "The C<guestfs_message_error> structure contains the error message as a "
4421 #: ../src/guestfs.pod:2263
4422 msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS"
4426 #: ../src/guestfs.pod:2265
4428 "A C<FileIn> parameter indicates that we transfer a file I<into> the guest. "
4429 "The normal request message is sent (see above). However this is followed by "
4430 "a sequence of file chunks."
4434 #: ../src/guestfs.pod:2269
4437 " total length (header + arguments,\n"
4438 " but not including the length word itself,\n"
4439 " and not including the chunks)\n"
4440 " struct guestfs_message_header (encoded as XDR)\n"
4441 " struct guestfs_<foo>_args (encoded as XDR)\n"
4442 " sequence of chunks for FileIn param #0\n"
4443 " sequence of chunks for FileIn param #1 etc.\n"
4448 #: ../src/guestfs.pod:2277
4449 msgid "The \"sequence of chunks\" is:"
4453 #: ../src/guestfs.pod:2279
4456 " length of chunk (not including length word itself)\n"
4457 " struct guestfs_chunk (encoded as XDR)\n"
4458 " length of chunk\n"
4459 " struct guestfs_chunk (encoded as XDR)\n"
4461 " length of chunk\n"
4462 " struct guestfs_chunk (with data.data_len == 0)\n"
4467 #: ../src/guestfs.pod:2287
4469 "The final chunk has the C<data_len> field set to zero. Additionally a flag "
4470 "is set in the final chunk to indicate either successful completion or early "
4475 #: ../src/guestfs.pod:2291
4477 "At time of writing there are no functions that have more than one FileIn "
4478 "parameter. However this is (theoretically) supported, by sending the "
4479 "sequence of chunks for each FileIn parameter one after another (from left to "
4484 #: ../src/guestfs.pod:2296
4486 "Both the library (sender) I<and> the daemon (receiver) may cancel the "
4487 "transfer. The library does this by sending a chunk with a special flag set "
4488 "to indicate cancellation. When the daemon sees this, it cancels the whole "
4489 "RPC, does I<not> send any reply, and goes back to reading the next request."
4493 #: ../src/guestfs.pod:2302
4495 "The daemon may also cancel. It does this by writing a special word "
4496 "C<GUESTFS_CANCEL_FLAG> to the socket. The library listens for this during "
4497 "the transfer, and if it gets it, it will cancel the transfer (it sends a "
4498 "cancel chunk). The special word is chosen so that even if cancellation "
4499 "happens right at the end of the transfer (after the library has finished "
4500 "writing and has started listening for the reply), the \"spurious\" cancel "
4501 "flag will not be confused with the reply message."
4505 #: ../src/guestfs.pod:2311
4507 "This protocol allows the transfer of arbitrary sized files (no 32 bit "
4508 "limit), and also files where the size is not known in advance (eg. from "
4509 "pipes or sockets). However the chunks are rather small "
4510 "(C<GUESTFS_MAX_CHUNK_SIZE>), so that neither the library nor the daemon need "
4511 "to keep much in memory."
4515 #: ../src/guestfs.pod:2317
4516 msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS"
4520 #: ../src/guestfs.pod:2319
4522 "The protocol for FileOut parameters is exactly the same as for FileIn "
4523 "parameters, but with the roles of daemon and library reversed."
4527 #: ../src/guestfs.pod:2322
4530 " total length (header + ret,\n"
4531 " but not including the length word itself,\n"
4532 " and not including the chunks)\n"
4533 " struct guestfs_message_header (encoded as XDR)\n"
4534 " struct guestfs_<foo>_ret (encoded as XDR)\n"
4535 " sequence of chunks for FileOut param #0\n"
4536 " sequence of chunks for FileOut param #1 etc.\n"
4541 #: ../src/guestfs.pod:2330
4542 msgid "INITIAL MESSAGE"
4546 #: ../src/guestfs.pod:2332
4548 "When the daemon launches it sends an initial word (C<GUESTFS_LAUNCH_FLAG>) "
4549 "which indicates that the guest and daemon is alive. This is what L</"
4550 "guestfs_launch> waits for."
4554 #: ../src/guestfs.pod:2336
4555 msgid "PROGRESS NOTIFICATION MESSAGES"
4559 #: ../src/guestfs.pod:2338
4561 "The daemon may send progress notification messages at any time. These are "
4562 "distinguished by the normal length word being replaced by "
4563 "C<GUESTFS_PROGRESS_FLAG>, followed by a fixed size progress message."
4567 #: ../src/guestfs.pod:2342
4569 "The library turns them into progress callbacks (see L</"
4570 "GUESTFS_EVENT_PROGRESS>) if there is a callback registered, or discards them "
4575 #: ../src/guestfs.pod:2346
4577 "The daemon self-limits the frequency of progress messages it sends (see "
4578 "C<daemon/proto.c:notify_progress>). Not all calls generate progress "
4583 #: ../src/guestfs.pod:2350
4584 msgid "LIBGUESTFS VERSION NUMBERS"
4588 #: ../src/guestfs.pod:2352
4590 "Since April 2010, libguestfs has started to make separate development and "
4591 "stable releases, along with corresponding branches in our git repository. "
4592 "These separate releases can be identified by version number:"
4596 #: ../src/guestfs.pod:2357
4599 " even numbers for stable: 1.2.x, 1.4.x, ...\n"
4600 " .-------- odd numbers for development: 1.3.x, 1.5.x, ...\n"
4606 " | `-------- sub-version\n"
4608 " `------ always '1' because we don't change the ABI\n"
4613 #: ../src/guestfs.pod:2368
4614 msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"."
4618 #: ../src/guestfs.pod:2370
4620 "As time passes we cherry pick fixes from the development branch and backport "
4621 "those into the stable branch, the effect being that the stable branch should "
4622 "get more stable and less buggy over time. So the stable releases are ideal "
4623 "for people who don't need new features but would just like the software to "
4628 #: ../src/guestfs.pod:2376
4629 msgid "Our criteria for backporting changes are:"
4633 #: ../src/guestfs.pod:2382
4635 "Documentation changes which don't affect any code are backported unless the "
4636 "documentation refers to a future feature which is not in stable."
4640 #: ../src/guestfs.pod:2388
4642 "Bug fixes which are not controversial, fix obvious problems, and have been "
4643 "well tested are backported."
4647 #: ../src/guestfs.pod:2393
4649 "Simple rearrangements of code which shouldn't affect how it works get "
4650 "backported. This is so that the code in the two branches doesn't get too "
4651 "far out of step, allowing us to backport future fixes more easily."
4655 #: ../src/guestfs.pod:2399
4657 "We I<don't> backport new features, new APIs, new tools etc, except in one "
4658 "exceptional case: the new feature is required in order to implement an "
4659 "important bug fix."
4663 #: ../src/guestfs.pod:2405
4665 "A new stable branch starts when we think the new features in development are "
4666 "substantial and compelling enough over the current stable branch to warrant "
4667 "it. When that happens we create new stable and development versions 1.N.0 "
4668 "and 1.(N+1).0 [N is even]. The new dot-oh release won't necessarily be so "
4669 "stable at this point, but by backporting fixes from development, that branch "
4670 "will stabilize over time."
4674 #: ../src/guestfs.pod:2413
4675 msgid "EXTENDING LIBGUESTFS"
4679 #: ../src/guestfs.pod:2415
4680 msgid "ADDING A NEW API ACTION"
4684 #: ../src/guestfs.pod:2417
4686 "Large amounts of boilerplate code in libguestfs (RPC, bindings, "
4687 "documentation) are generated, and this makes it easy to extend the "
4692 #: ../src/guestfs.pod:2421
4693 msgid "To add a new API action there are two changes:"
4697 #: ../src/guestfs.pod:2427
4699 "You need to add a description of the call (name, parameters, return type, "
4700 "tests, documentation) to C<generator/generator_actions.ml>."
4704 #: ../src/guestfs.pod:2430
4706 "There are two sorts of API action, depending on whether the call goes "
4707 "through to the daemon in the appliance, or is serviced entirely by the "
4708 "library (see L</ARCHITECTURE> above). L</guestfs_sync> is an example of the "
4709 "former, since the sync is done in the appliance. L</guestfs_set_trace> is "
4710 "an example of the latter, since a trace flag is maintained in the handle and "
4711 "all tracing is done on the library side."
4715 #: ../src/guestfs.pod:2438
4717 "Most new actions are of the first type, and get added to the "
4718 "C<daemon_functions> list. Each function has a unique procedure number used "
4719 "in the RPC protocol which is assigned to that action when we publish "
4720 "libguestfs and cannot be reused. Take the latest procedure number and "
4725 #: ../src/guestfs.pod:2444
4727 "For library-only actions of the second type, add to the "
4728 "C<non_daemon_functions> list. Since these functions are serviced by the "
4729 "library and do not travel over the RPC mechanism to the daemon, these "
4730 "functions do not need a procedure number, and so the procedure number is set "
4735 #: ../src/guestfs.pod:2452
4736 msgid "Implement the action (in C):"
4740 #: ../src/guestfs.pod:2454
4742 "For daemon actions, implement the function C<do_E<lt>nameE<gt>> in the "
4743 "C<daemon/> directory."
4747 #: ../src/guestfs.pod:2457
4749 "For library actions, implement the function C<guestfs__E<lt>nameE<gt>> "
4750 "(note: double underscore) in the C<src/> directory."
4754 #: ../src/guestfs.pod:2460
4755 msgid "In either case, use another function as an example of what to do."
4759 #: ../src/guestfs.pod:2464
4760 msgid "After making these changes, use C<make> to compile."
4764 #: ../src/guestfs.pod:2466
4766 "Note that you don't need to implement the RPC, language bindings, manual "
4767 "pages or anything else. It's all automatically generated from the OCaml "
4772 #: ../src/guestfs.pod:2470
4773 msgid "ADDING TESTS FOR AN API ACTION"
4777 #: ../src/guestfs.pod:2472
4779 "You can supply zero or as many tests as you want per API call. The tests "
4780 "can either be added as part of the API description (C<generator/"
4781 "generator_actions.ml>), or in some rarer cases you may want to drop a script "
4782 "into C<regressions/>. Note that adding a script to C<regressions/> is "
4783 "slower, so if possible use the first method."
4787 #: ../src/guestfs.pod:2478
4789 "The following describes the test environment used when you add an API test "
4790 "in C<generator_actions.ml>."
4794 #: ../src/guestfs.pod:2481
4795 msgid "The test environment has 4 block devices:"
4799 #: ../src/guestfs.pod:2485
4800 msgid "C</dev/sda> 500MB"
4804 #: ../src/guestfs.pod:2487
4805 msgid "General block device for testing."
4809 #: ../src/guestfs.pod:2489
4810 msgid "C</dev/sdb> 50MB"
4814 #: ../src/guestfs.pod:2491
4816 "C</dev/sdb1> is an ext2 filesystem used for testing filesystem write "
4821 #: ../src/guestfs.pod:2494
4822 msgid "C</dev/sdc> 10MB"
4826 #: ../src/guestfs.pod:2496
4827 msgid "Used in a few tests where two block devices are needed."
4831 #: ../src/guestfs.pod:2498
4833 msgstr "C</dev/sdd>"
4836 #: ../src/guestfs.pod:2500
4837 msgid "ISO with fixed content (see C<images/test.iso>)."
4841 #: ../src/guestfs.pod:2504
4843 "To be able to run the tests in a reasonable amount of time, the libguestfs "
4844 "appliance and block devices are reused between tests. So don't try testing "
4845 "L</guestfs_kill_subprocess> :-x"
4849 #: ../src/guestfs.pod:2508
4851 "Each test starts with an initial scenario, selected using one of the "
4852 "C<Init*> expressions, described in C<generator/generator_types.ml>. These "
4853 "initialize the disks mentioned above in a particular way as documented in "
4854 "C<generator_types.ml>. You should not assume anything about the previous "
4855 "contents of other disks that are not initialized."
4859 #: ../src/guestfs.pod:2514
4861 "You can add a prerequisite clause to any individual test. This is a run-"
4862 "time check, which, if it fails, causes the test to be skipped. Useful if "
4863 "testing a command which might not work on all variations of libguestfs "
4864 "builds. A test that has prerequisite of C<Always> means to run "
4869 #: ../src/guestfs.pod:2520
4871 "In addition, packagers can skip individual tests by setting environment "
4872 "variables before running C<make check>."
4876 #: ../src/guestfs.pod:2523
4879 " SKIP_TEST_<CMD>_<NUM>=1\n"
4884 #: ../src/guestfs.pod:2525
4885 msgid "eg: C<SKIP_TEST_COMMAND_3=1> skips test #3 of L</guestfs_command>."
4889 #: ../src/guestfs.pod:2527
4894 #: ../src/guestfs.pod:2529
4897 " SKIP_TEST_<CMD>=1\n"
4902 #: ../src/guestfs.pod:2531
4903 msgid "eg: C<SKIP_TEST_ZEROFREE=1> skips all L</guestfs_zerofree> tests."
4907 #: ../src/guestfs.pod:2533
4908 msgid "Packagers can run only certain tests by setting for example:"
4912 #: ../src/guestfs.pod:2535
4915 " TEST_ONLY=\"vfs_type zerofree\"\n"
4920 #: ../src/guestfs.pod:2537
4922 "See C<capitests/tests.c> for more details of how these environment variables "
4927 #: ../src/guestfs.pod:2540
4928 msgid "DEBUGGING NEW API ACTIONS"
4932 #: ../src/guestfs.pod:2542
4933 msgid "Test new actions work before submitting them."
4937 #: ../src/guestfs.pod:2544
4938 msgid "You can use guestfish to try out new commands."
4942 #: ../src/guestfs.pod:2546
4944 "Debugging the daemon is a problem because it runs inside a minimal "
4945 "environment. However you can fprintf messages in the daemon to stderr, and "
4946 "they will show up if you use C<guestfish -v>."
4950 #: ../src/guestfs.pod:2550
4951 msgid "FORMATTING CODE AND OTHER CONVENTIONS"
4955 #: ../src/guestfs.pod:2552
4957 "Our C source code generally adheres to some basic code-formatting "
4958 "conventions. The existing code base is not totally consistent on this "
4959 "front, but we do prefer that contributed code be formatted similarly. In "
4960 "short, use spaces-not-TABs for indentation, use 2 spaces for each "
4961 "indentation level, and other than that, follow the K&R style."
4965 #: ../src/guestfs.pod:2558
4967 "If you use Emacs, add the following to one of one of your start-up files (e."
4968 "g., ~/.emacs), to help ensure that you get indentation right:"
4972 #: ../src/guestfs.pod:2561
4975 " ;;; In libguestfs, indent with spaces everywhere (not TABs).\n"
4976 " ;;; Exceptions: Makefile and ChangeLog modes.\n"
4977 " (add-hook 'find-file-hook\n"
4978 " '(lambda () (if (and buffer-file-name\n"
4979 " (string-match \"/libguestfs\\\\>\"\n"
4980 " (buffer-file-name))\n"
4981 " (not (string-equal mode-name \"Change Log\"))\n"
4982 " (not (string-equal mode-name \"Makefile\")))\n"
4983 " (setq indent-tabs-mode nil))))\n"
4988 #: ../src/guestfs.pod:2571
4991 " ;;; When editing C sources in libguestfs, use this style.\n"
4992 " (defun libguestfs-c-mode ()\n"
4993 " \"C mode with adjusted defaults for use with libguestfs.\"\n"
4995 " (c-set-style \"K&R\")\n"
4996 " (setq c-indent-level 2)\n"
4997 " (setq c-basic-offset 2))\n"
4998 " (add-hook 'c-mode-hook\n"
4999 " '(lambda () (if (string-match \"/libguestfs\\\\>\"\n"
5000 " (buffer-file-name))\n"
5001 " (libguestfs-c-mode))))\n"
5006 #: ../src/guestfs.pod:2583
5007 msgid "Enable warnings when compiling (and fix any problems this finds):"
5011 #: ../src/guestfs.pod:2586
5014 " ./configure --enable-gcc-warnings\n"
5019 #: ../src/guestfs.pod:2588
5020 msgid "Useful targets are:"
5024 #: ../src/guestfs.pod:2590
5027 " make syntax-check # checks the syntax of the C code\n"
5028 " make check # runs the test suite\n"
5033 #: ../src/guestfs.pod:2593
5034 msgid "DAEMON CUSTOM PRINTF FORMATTERS"
5038 #: ../src/guestfs.pod:2595
5040 "In the daemon code we have created custom printf formatters C<%Q> and C<%R>, "
5041 "which are used to do shell quoting."
5045 #: ../src/guestfs.pod:2600
5050 #: ../src/guestfs.pod:2602
5052 "Simple shell quoted string. Any spaces or other shell characters are "
5057 #: ../src/guestfs.pod:2605
5062 #: ../src/guestfs.pod:2607
5064 "Same as C<%Q> except the string is treated as a path which is prefixed by "
5069 #: ../src/guestfs.pod:2612 ../fish/guestfish.pod:240 ../fish/guestfish.pod:613
5070 msgid "For example:"
5074 #: ../src/guestfs.pod:2614
5077 " asprintf (&cmd, \"cat %R\", path);\n"
5082 #: ../src/guestfs.pod:2616
5083 msgid "would produce C<cat /sysroot/some\\ path\\ with\\ spaces>"
5087 #: ../src/guestfs.pod:2618
5089 "I<Note:> Do I<not> use these when you are passing parameters to the C<command"
5090 "{,r,v,rv}()> functions. These parameters do NOT need to be quoted because "
5091 "they are not passed via the shell (instead, straight to exec). You probably "
5092 "want to use the C<sysroot_path()> function however."
5096 #: ../src/guestfs.pod:2624
5097 msgid "SUBMITTING YOUR NEW API ACTIONS"
5101 #: ../src/guestfs.pod:2626
5103 "Submit patches to the mailing list: L<http://www.redhat.com/mailman/listinfo/"
5104 "libguestfs> and CC to L<rjones@redhat.com>."
5108 #: ../src/guestfs.pod:2630
5109 msgid "INTERNATIONALIZATION (I18N) SUPPORT"
5113 #: ../src/guestfs.pod:2632
5114 msgid "We support i18n (gettext anyhow) in the library."
5118 #: ../src/guestfs.pod:2634
5120 "However many messages come from the daemon, and we don't translate those at "
5121 "the moment. One reason is that the appliance generally has all locale files "
5122 "removed from it, because they take up a lot of space. So we'd have to readd "
5123 "some of those, as well as copying our PO files into the appliance."
5127 #: ../src/guestfs.pod:2640
5129 "Debugging messages are never translated, since they are intended for the "
5134 #: ../src/guestfs.pod:2643
5135 msgid "SOURCE CODE SUBDIRECTORIES"
5139 #: ../src/guestfs.pod:2647 ../src/guestfs-actions.pod:5854
5140 #: ../fish/guestfish-actions.pod:3948
5141 msgid "C<appliance>"
5142 msgstr "C<appliance>"
5145 #: ../src/guestfs.pod:2649
5146 msgid "The libguestfs appliance, build scripts and so on."
5150 #: ../src/guestfs.pod:2651
5151 msgid "C<capitests>"
5152 msgstr "C<capitests>"
5155 #: ../src/guestfs.pod:2653
5156 msgid "Automated tests of the C API."
5160 #: ../src/guestfs.pod:2655
5165 #: ../src/guestfs.pod:2657
5167 "The L<virt-cat(1)>, L<virt-filesystems(1)> and L<virt-ls(1)> commands and "
5172 #: ../src/guestfs.pod:2660
5179 #: ../src/guestfs.pod:2662
5181 "Safety and liveness tests of components that libguestfs depends upon (not of "
5182 "libguestfs itself). Mainly this is for qemu and the kernel."
5186 #: ../src/guestfs.pod:2665
5191 #: ../src/guestfs.pod:2667
5192 msgid "Outside contributions, experimental parts."
5196 #: ../src/guestfs.pod:2669
5201 #: ../src/guestfs.pod:2671
5203 "The daemon that runs inside the libguestfs appliance and carries out actions."
5207 #: ../src/guestfs.pod:2674
5212 #: ../src/guestfs.pod:2676
5213 msgid "L<virt-df(1)> command and documentation."
5217 #: ../src/guestfs.pod:2678
5219 msgstr "C<examples>"
5222 #: ../src/guestfs.pod:2680
5223 msgid "C API example code."
5224 msgstr "Код прикладів використання програмного інтерфейсу мовою C."
5227 #: ../src/guestfs.pod:2682
5232 #: ../src/guestfs.pod:2684
5234 "L<guestfish(1)>, the command-line shell, and various shell scripts built on "
5235 "top such as L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, "
5236 "L<virt-tar-out(1)>."
5240 #: ../src/guestfs.pod:2688
5245 #: ../src/guestfs.pod:2690
5247 "L<guestmount(1)>, FUSE (userspace filesystem) built on top of libguestfs."
5251 #: ../src/guestfs.pod:2692
5252 msgid "C<generator>"
5253 msgstr "C<generator>"
5256 #: ../src/guestfs.pod:2694
5258 "The crucially important generator, used to automatically generate large "
5259 "amounts of boilerplate C code for things like RPC and bindings."
5263 #: ../src/guestfs.pod:2697
5268 #: ../src/guestfs.pod:2699
5269 msgid "Files used by the test suite."
5273 #: ../src/guestfs.pod:2701
5274 msgid "Some \"phony\" guest images which we test against."
5278 #: ../src/guestfs.pod:2703
5279 msgid "C<inspector>"
5280 msgstr "C<inspector>"
5283 #: ../src/guestfs.pod:2705
5284 msgid "L<virt-inspector(1)>, the virtual machine image inspector."
5288 #: ../src/guestfs.pod:2707
5293 #: ../src/guestfs.pod:2709
5294 msgid "Logo used on the website. The fish is called Arthur by the way."
5298 #: ../src/guestfs.pod:2711
5303 #: ../src/guestfs.pod:2713
5304 msgid "M4 macros used by autoconf."
5308 #: ../src/guestfs.pod:2715
5313 #: ../src/guestfs.pod:2717
5314 msgid "Translations of simple gettext strings."
5315 msgstr "Переклади простих рядків gettext."
5318 #: ../src/guestfs.pod:2719
5323 #: ../src/guestfs.pod:2721
5325 "The build infrastructure and PO files for translations of manpages and POD "
5326 "files. Eventually this will be combined with the C<po> directory, but that "
5327 "is rather complicated."
5331 #: ../src/guestfs.pod:2725
5332 msgid "C<regressions>"
5333 msgstr "C<regressions>"
5336 #: ../src/guestfs.pod:2727
5337 msgid "Regression tests."
5338 msgstr "Тести на регресії."
5341 #: ../src/guestfs.pod:2729
5346 #: ../src/guestfs.pod:2731
5347 msgid "L<virt-rescue(1)> command and documentation."
5351 #: ../src/guestfs.pod:2733
5356 #: ../src/guestfs.pod:2735
5357 msgid "Source code to the C library."
5361 #: ../src/guestfs.pod:2737
5366 #: ../src/guestfs.pod:2739
5367 msgid "Command line tools written in Perl (L<virt-resize(1)> and many others)."
5371 #: ../src/guestfs.pod:2741
5372 msgid "C<test-tool>"
5373 msgstr "C<test-tool>"
5376 #: ../src/guestfs.pod:2743
5378 "Test tool for end users to test if their qemu/kernel combination will work "
5383 #: ../src/guestfs.pod:2746
5388 #: ../src/guestfs.pod:2748
5393 #: ../src/guestfs.pod:2750
5398 #: ../src/guestfs.pod:2752
5403 #: ../src/guestfs.pod:2754
5408 #: ../src/guestfs.pod:2756
5413 #: ../src/guestfs.pod:2758
5418 #: ../src/guestfs.pod:2760
5423 #: ../src/guestfs.pod:2762
5424 msgid "Language bindings."
5425 msgstr "Прив’язки до мов програмування."
5428 #: ../src/guestfs.pod:2766
5433 #: ../src/guestfs.pod:2768
5434 msgid "PROTOCOL LIMITS"
5438 #: ../src/guestfs.pod:2770
5440 "Internally libguestfs uses a message-based protocol to pass API calls and "
5441 "their responses to and from a small \"appliance\" (see L</INTERNALS> for "
5442 "plenty more detail about this). The maximum message size used by the "
5443 "protocol is slightly less than 4 MB. For some API calls you may need to be "
5444 "aware of this limit. The API calls which may be affected are individually "
5445 "documented, with a link back to this section of the documentation."
5449 #: ../src/guestfs.pod:2778
5451 "A simple call such as L</guestfs_cat> returns its result (the file data) in "
5452 "a simple string. Because this string is at some point internally encoded as "
5453 "a message, the maximum size that it can return is slightly under 4 MB. If "
5454 "the requested file is larger than this then you will get an error."
5458 #: ../src/guestfs.pod:2784
5460 "In order to transfer large files into and out of the guest filesystem, you "
5461 "need to use particular calls that support this. The sections L</UPLOADING> "
5462 "and L</DOWNLOADING> document how to do this."
5466 #: ../src/guestfs.pod:2788
5468 "You might also consider mounting the disk image using our FUSE filesystem "
5469 "support (L<guestmount(1)>)."
5473 #: ../src/guestfs.pod:2791
5474 msgid "MAXIMUM NUMBER OF DISKS"
5478 #: ../src/guestfs.pod:2793
5479 msgid "When using virtio disks (the default) the current limit is B<25> disks."
5483 #: ../src/guestfs.pod:2796
5485 "Virtio itself consumes 1 virtual PCI slot per disk, and PCI is limited to 31 "
5486 "slots. However febootstrap only understands disks with names C</dev/vda> "
5487 "through C</dev/vdz> (26 letters) and it reserves one disk for its own "
5492 #: ../src/guestfs.pod:2801
5494 "We are working to substantially raise this limit in future versions but it "
5495 "requires complex changes to qemu."
5499 #: ../src/guestfs.pod:2804
5501 "In future versions of libguestfs it should also be possible to \"hot plug\" "
5502 "disks (add and remove disks after calling L</guestfs_launch>). This also "
5503 "requires changes to qemu."
5507 #: ../src/guestfs.pod:2808
5508 msgid "MAXIMUM NUMBER OF PARTITIONS PER DISK"
5512 #: ../src/guestfs.pod:2810
5513 msgid "Virtio limits the maximum number of partitions per disk to B<15>."
5517 #: ../src/guestfs.pod:2812
5519 "This is because it reserves 4 bits for the minor device number (thus C</dev/"
5520 "vda>, and C</dev/vda1> through C</dev/vda15>)."
5524 #: ../src/guestfs.pod:2815
5526 "If you attach a disk with more than 15 partitions, the extra partitions are "
5527 "ignored by libguestfs."
5531 #: ../src/guestfs.pod:2818
5532 msgid "MAXIMUM SIZE OF A DISK"
5536 #: ../src/guestfs.pod:2820
5537 msgid "Probably the limit is between 2**63-1 and 2**64-1 bytes."
5541 #: ../src/guestfs.pod:2822
5543 "We have tested block devices up to 1 exabyte (2**60 or "
5544 "1,152,921,504,606,846,976 bytes) using sparse files backed by an XFS host "
5549 #: ../src/guestfs.pod:2826
5551 "Although libguestfs probably does not impose any limit, the underlying host "
5552 "storage will. If you store disk images on a host ext4 filesystem, then the "
5553 "maximum size will be limited by the maximum ext4 file size (currently 16 "
5554 "TB). If you store disk images as host logical volumes then you are limited "
5555 "by the maximum size of an LV."
5559 #: ../src/guestfs.pod:2832
5561 "For the hugest disk image files, we recommend using XFS on the host for "
5566 #: ../src/guestfs.pod:2835
5567 msgid "MAXIMUM SIZE OF A PARTITION"
5571 #: ../src/guestfs.pod:2837
5573 "The MBR (ie. classic MS-DOS) partitioning scheme uses 32 bit sector "
5574 "numbers. Assuming a 512 byte sector size, this means that MBR cannot "
5575 "address a partition located beyond 2 TB on the disk."
5579 #: ../src/guestfs.pod:2841
5581 "It is recommended that you use GPT partitions on disks which are larger than "
5582 "this size. GPT uses 64 bit sector numbers and so can address partitions "
5583 "which are theoretically larger than the largest disk we could support."
5587 #: ../src/guestfs.pod:2846
5588 msgid "MAXIMUM SIZE OF A FILESYSTEM, FILES, DIRECTORIES"
5592 #: ../src/guestfs.pod:2848
5594 "This depends on the filesystem type. libguestfs itself does not impose any "
5595 "known limit. Consult Wikipedia or the filesystem documentation to find out "
5596 "what these limits are."
5600 #: ../src/guestfs.pod:2852
5601 msgid "MAXIMUM UPLOAD AND DOWNLOAD"
5605 #: ../src/guestfs.pod:2854
5607 "The API functions L</guestfs_upload>, L</guestfs_download>, L</"
5608 "guestfs_tar_in>, L</guestfs_tar_out> and the like allow unlimited sized "
5609 "uploads and downloads."
5613 #: ../src/guestfs.pod:2858
5615 #| msgid "INSPECTION"
5616 msgid "INSPECTION LIMITS"
5620 #: ../src/guestfs.pod:2860
5622 "The inspection code has several arbitrary limits on things like the size of "
5623 "Windows Registry hive it will read, and the length of product name. These "
5624 "are intended to stop a malicious guest from consuming arbitrary amounts of "
5625 "memory and disk space on the host, and should not be reached in practice. "
5626 "See the source code for more information."
5630 #: ../src/guestfs.pod:2866 ../fish/guestfish.pod:1026
5631 #: ../test-tool/libguestfs-test-tool.pod:82 ../tools/virt-edit.pl:476
5632 msgid "ENVIRONMENT VARIABLES"
5633 msgstr "ЗМІННІ СЕРЕДОВИЩА"
5636 #: ../src/guestfs.pod:2870 ../fish/guestfish.pod:1052
5637 msgid "LIBGUESTFS_APPEND"
5641 #: ../src/guestfs.pod:2872 ../fish/guestfish.pod:1054
5642 msgid "Pass additional options to the guest kernel."
5646 #: ../src/guestfs.pod:2874 ../fish/guestfish.pod:1056
5647 msgid "LIBGUESTFS_DEBUG"
5651 #: ../src/guestfs.pod:2876
5653 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
5654 "effect as calling C<guestfs_set_verbose (g, 1)>."
5658 #: ../src/guestfs.pod:2879 ../fish/guestfish.pod:1061
5659 msgid "LIBGUESTFS_MEMSIZE"
5663 #: ../src/guestfs.pod:2881 ../fish/guestfish.pod:1063
5665 "Set the memory allocated to the qemu process, in megabytes. For example:"
5669 #: ../src/guestfs.pod:2884 ../fish/guestfish.pod:1066
5672 " LIBGUESTFS_MEMSIZE=700\n"
5677 #: ../src/guestfs.pod:2886 ../fish/guestfish.pod:1068
5678 msgid "LIBGUESTFS_PATH"
5682 #: ../src/guestfs.pod:2888
5684 "Set the path that libguestfs uses to search for a supermin appliance. See "
5685 "the discussion of paths in section L</PATH> above."
5689 #: ../src/guestfs.pod:2891 ../fish/guestfish.pod:1073
5690 msgid "LIBGUESTFS_QEMU"
5694 #: ../src/guestfs.pod:2893 ../fish/guestfish.pod:1075
5696 "Set the default qemu binary that libguestfs uses. If not set, then the qemu "
5697 "which was found at compile time by the configure script is used."
5701 #: ../src/guestfs.pod:2897
5702 msgid "See also L</QEMU WRAPPERS> above."
5706 #: ../src/guestfs.pod:2899 ../fish/guestfish.pod:1079
5707 msgid "LIBGUESTFS_TRACE"
5711 #: ../src/guestfs.pod:2901
5713 "Set C<LIBGUESTFS_TRACE=1> to enable command traces. This has the same "
5714 "effect as calling C<guestfs_set_trace (g, 1)>."
5718 #: ../src/guestfs.pod:2904 ../fish/guestfish.pod:1088
5723 #: ../src/guestfs.pod:2906 ../fish/guestfish.pod:1090
5725 "Location of temporary directory, defaults to C</tmp> except for the cached "
5726 "supermin appliance which defaults to C</var/tmp>."
5730 #: ../src/guestfs.pod:2909 ../fish/guestfish.pod:1093
5732 "If libguestfs was compiled to use the supermin appliance then the real "
5733 "appliance is cached in this directory, shared between all handles belonging "
5734 "to the same EUID. You can use C<$TMPDIR> to configure another directory to "
5735 "use in case C</var/tmp> is not large enough."
5739 #: ../src/guestfs.pod:2917 ../fish/guestfish.pod:1160
5740 #: ../test-tool/libguestfs-test-tool.pod:87 ../fuse/guestmount.pod:277
5741 #: ../tools/virt-edit.pl:496 ../tools/virt-win-reg.pl:572
5742 #: ../tools/virt-list-filesystems.pl:189 ../tools/virt-tar.pl:286
5743 #: ../tools/virt-make-fs.pl:539 ../tools/virt-list-partitions.pl:257
5745 msgstr "ТАКОЖ ПЕРЕГЛЯНЬТЕ"
5748 #: ../src/guestfs.pod:2919
5750 "L<guestfs-examples(3)>, L<guestfs-ocaml(3)>, L<guestfs-perl(3)>, L<guestfs-"
5751 "python(3)>, L<guestfs-ruby(3)>, L<guestfish(1)>, L<guestmount(1)>, L<virt-cat"
5752 "(1)>, L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)"
5753 ">, L<virt-filesystems(1)>, L<virt-inspector(1)>, L<virt-list-filesystems(1)"
5754 ">, L<virt-list-partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, L<virt-"
5755 "rescue(1)>, L<virt-tar(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<virt-"
5756 "win-reg(1)>, L<qemu(1)>, L<febootstrap(1)>, L<hivex(3)>, L<http://libguestfs."
5761 #: ../src/guestfs.pod:2947
5763 "Tools with a similar purpose: L<fdisk(8)>, L<parted(8)>, L<kpartx(8)>, L<lvm"
5764 "(8)>, L<disktype(1)>."
5768 #: ../src/guestfs.pod:2954 ../tools/virt-win-reg.pl:587
5769 #: ../tools/virt-make-fs.pl:553
5774 #: ../src/guestfs.pod:2956
5775 msgid "To get a list of bugs against libguestfs use this link:"
5777 "Щоб переглянути список відомих вад у libguestfs, скористайтеся таким "
5781 #: ../src/guestfs.pod:2958
5783 "L<https://bugzilla.redhat.com/buglist.cgi?"
5784 "component=libguestfs&product=Virtualization+Tools>"
5786 "L<https://bugzilla.redhat.com/buglist.cgi?"
5787 "component=libguestfs&product=Virtualization+Tools>"
5790 #: ../src/guestfs.pod:2960
5791 msgid "To report a new bug against libguestfs use this link:"
5792 msgstr "Для звітування щодо вад у libguestfs скористайтеся цим посиланням:"
5795 #: ../src/guestfs.pod:2962
5797 "L<https://bugzilla.redhat.com/enter_bug.cgi?"
5798 "component=libguestfs&product=Virtualization+Tools>"
5800 "L<https://bugzilla.redhat.com/enter_bug.cgi?"
5801 "component=libguestfs&product=Virtualization+Tools>"
5804 #: ../src/guestfs.pod:2964
5805 msgid "When reporting a bug, please check:"
5809 #: ../src/guestfs.pod:2970
5810 msgid "That the bug hasn't been reported already."
5814 #: ../src/guestfs.pod:2974
5815 msgid "That you are testing a recent version."
5819 #: ../src/guestfs.pod:2978
5820 msgid "Describe the bug accurately, and give a way to reproduce it."
5824 #: ../src/guestfs.pod:2982
5826 "Run libguestfs-test-tool and paste the B<complete, unedited> output into the "
5831 #: ../src/guestfs.pod:2987 ../fish/guestfish.pod:1183
5832 #: ../test-tool/libguestfs-test-tool.pod:93 ../fuse/guestmount.pod:288
5837 #: ../src/guestfs.pod:2989 ../fish/guestfish.pod:1185
5838 #: ../test-tool/libguestfs-test-tool.pod:95 ../fuse/guestmount.pod:290
5839 msgid "Richard W.M. Jones (C<rjones at redhat dot com>)"
5843 #: ../src/guestfs.pod:2991 ../fish/guestfish.pod:1187
5844 #: ../test-tool/libguestfs-test-tool.pod:97 ../fuse/guestmount.pod:292
5845 #: ../tools/virt-edit.pl:514 ../tools/virt-win-reg.pl:602
5846 #: ../tools/virt-list-filesystems.pl:206 ../tools/virt-tar.pl:305
5847 #: ../tools/virt-make-fs.pl:568 ../tools/virt-list-partitions.pl:273
5849 msgstr "АВТОРСЬКІ ПРАВА"
5852 #: ../src/guestfs.pod:2993 ../fish/guestfish.pod:1189
5853 #: ../test-tool/libguestfs-test-tool.pod:99
5854 msgid "Copyright (C) 2009-2011 Red Hat Inc. L<http://libguestfs.org/>"
5858 #: ../src/guestfs.pod:2996
5860 "This library is free software; you can redistribute it and/or modify it "
5861 "under the terms of the GNU Lesser General Public License as published by the "
5862 "Free Software Foundation; either version 2 of the License, or (at your "
5863 "option) any later version."
5867 #: ../src/guestfs.pod:3001
5869 "This library is distributed in the hope that it will be useful, but WITHOUT "
5870 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
5871 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License "
5876 #: ../src/guestfs.pod:3006
5878 "You should have received a copy of the GNU Lesser General Public License "
5879 "along with this library; if not, write to the Free Software Foundation, "
5880 "Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA"
5884 #: ../src/guestfs-actions.pod:1
5885 msgid "guestfs_add_cdrom"
5889 #: ../src/guestfs-actions.pod:3
5893 " guestfs_add_cdrom (guestfs_h *g,\n"
5894 " const char *filename);\n"
5899 #: ../src/guestfs-actions.pod:7 ../fish/guestfish-actions.pod:5
5900 msgid "This function adds a virtual CD-ROM disk image to the guest."
5904 #: ../src/guestfs-actions.pod:9 ../fish/guestfish-actions.pod:7
5905 msgid "This is equivalent to the qemu parameter I<-cdrom filename>."
5909 #: ../src/guestfs-actions.pod:17
5911 "This call checks for the existence of C<filename>. This stops you from "
5912 "specifying other types of drive which are supported by qemu such as C<nbd:> "
5913 "and C<http:> URLs. To specify those, use the general C<guestfs_config> call "
5918 #: ../src/guestfs-actions.pod:24
5920 "If you just want to add an ISO file (often you use this as an efficient way "
5921 "to transfer large files into the guest), then you should probably use "
5922 "C<guestfs_add_drive_ro> instead."
5926 #: ../src/guestfs-actions.pod:30 ../src/guestfs-actions.pod:134
5927 #: ../src/guestfs-actions.pod:195 ../src/guestfs-actions.pod:232
5928 #: ../src/guestfs-actions.pod:246 ../src/guestfs-actions.pod:267
5929 #: ../src/guestfs-actions.pod:287 ../src/guestfs-actions.pod:301
5930 #: ../src/guestfs-actions.pod:421 ../src/guestfs-actions.pod:441
5931 #: ../src/guestfs-actions.pod:455 ../src/guestfs-actions.pod:500
5932 #: ../src/guestfs-actions.pod:528 ../src/guestfs-actions.pod:546
5933 #: ../src/guestfs-actions.pod:613 ../src/guestfs-actions.pod:646
5934 #: ../src/guestfs-actions.pod:660 ../src/guestfs-actions.pod:675
5935 #: ../src/guestfs-actions.pod:774 ../src/guestfs-actions.pod:792
5936 #: ../src/guestfs-actions.pod:806 ../src/guestfs-actions.pod:820
5937 #: ../src/guestfs-actions.pod:981 ../src/guestfs-actions.pod:1001
5938 #: ../src/guestfs-actions.pod:1019 ../src/guestfs-actions.pod:1103
5939 #: ../src/guestfs-actions.pod:1121 ../src/guestfs-actions.pod:1140
5940 #: ../src/guestfs-actions.pod:1154 ../src/guestfs-actions.pod:1174
5941 #: ../src/guestfs-actions.pod:1244 ../src/guestfs-actions.pod:1275
5942 #: ../src/guestfs-actions.pod:1300 ../src/guestfs-actions.pod:1342
5943 #: ../src/guestfs-actions.pod:1448 ../src/guestfs-actions.pod:1482
5944 #: ../src/guestfs-actions.pod:1697 ../src/guestfs-actions.pod:1719
5945 #: ../src/guestfs-actions.pod:1806 ../src/guestfs-actions.pod:2290
5946 #: ../src/guestfs-actions.pod:2434 ../src/guestfs-actions.pod:2495
5947 #: ../src/guestfs-actions.pod:2530 ../src/guestfs-actions.pod:3483
5948 #: ../src/guestfs-actions.pod:3498 ../src/guestfs-actions.pod:3523
5949 #: ../src/guestfs-actions.pod:3678 ../src/guestfs-actions.pod:3692
5950 #: ../src/guestfs-actions.pod:3705 ../src/guestfs-actions.pod:3719
5951 #: ../src/guestfs-actions.pod:3734 ../src/guestfs-actions.pod:3770
5952 #: ../src/guestfs-actions.pod:3842 ../src/guestfs-actions.pod:3862
5953 #: ../src/guestfs-actions.pod:3879 ../src/guestfs-actions.pod:3902
5954 #: ../src/guestfs-actions.pod:3925 ../src/guestfs-actions.pod:3957
5955 #: ../src/guestfs-actions.pod:3976 ../src/guestfs-actions.pod:3995
5956 #: ../src/guestfs-actions.pod:4030 ../src/guestfs-actions.pod:4042
5957 #: ../src/guestfs-actions.pod:4078 ../src/guestfs-actions.pod:4094
5958 #: ../src/guestfs-actions.pod:4107 ../src/guestfs-actions.pod:4122
5959 #: ../src/guestfs-actions.pod:4139 ../src/guestfs-actions.pod:4232
5960 #: ../src/guestfs-actions.pod:4252 ../src/guestfs-actions.pod:4265
5961 #: ../src/guestfs-actions.pod:4316 ../src/guestfs-actions.pod:4334
5962 #: ../src/guestfs-actions.pod:4352 ../src/guestfs-actions.pod:4368
5963 #: ../src/guestfs-actions.pod:4382 ../src/guestfs-actions.pod:4396
5964 #: ../src/guestfs-actions.pod:4413 ../src/guestfs-actions.pod:4428
5965 #: ../src/guestfs-actions.pod:4448 ../src/guestfs-actions.pod:4506
5966 #: ../src/guestfs-actions.pod:4579 ../src/guestfs-actions.pod:4610
5967 #: ../src/guestfs-actions.pod:4629 ../src/guestfs-actions.pod:4648
5968 #: ../src/guestfs-actions.pod:4660 ../src/guestfs-actions.pod:4677
5969 #: ../src/guestfs-actions.pod:4690 ../src/guestfs-actions.pod:4705
5970 #: ../src/guestfs-actions.pod:4720 ../src/guestfs-actions.pod:4755
5971 #: ../src/guestfs-actions.pod:4777 ../src/guestfs-actions.pod:4797
5972 #: ../src/guestfs-actions.pod:4811 ../src/guestfs-actions.pod:4828
5973 #: ../src/guestfs-actions.pod:4877 ../src/guestfs-actions.pod:4923
5974 #: ../src/guestfs-actions.pod:4937 ../src/guestfs-actions.pod:4965
5975 #: ../src/guestfs-actions.pod:4982 ../src/guestfs-actions.pod:5000
5976 #: ../src/guestfs-actions.pod:5134 ../src/guestfs-actions.pod:5191
5977 #: ../src/guestfs-actions.pod:5213 ../src/guestfs-actions.pod:5231
5978 #: ../src/guestfs-actions.pod:5263 ../src/guestfs-actions.pod:5329
5979 #: ../src/guestfs-actions.pod:5346 ../src/guestfs-actions.pod:5359
5980 #: ../src/guestfs-actions.pod:5373 ../src/guestfs-actions.pod:5662
5981 #: ../src/guestfs-actions.pod:5681 ../src/guestfs-actions.pod:5700
5982 #: ../src/guestfs-actions.pod:5712 ../src/guestfs-actions.pod:5724
5983 #: ../src/guestfs-actions.pod:5738 ../src/guestfs-actions.pod:5750
5984 #: ../src/guestfs-actions.pod:5764 ../src/guestfs-actions.pod:5780
5985 #: ../src/guestfs-actions.pod:5801 ../src/guestfs-actions.pod:5820
5986 #: ../src/guestfs-actions.pod:5839 ../src/guestfs-actions.pod:5869
5987 #: ../src/guestfs-actions.pod:5885 ../src/guestfs-actions.pod:5908
5988 #: ../src/guestfs-actions.pod:5926 ../src/guestfs-actions.pod:5945
5989 #: ../src/guestfs-actions.pod:5966 ../src/guestfs-actions.pod:5985
5990 #: ../src/guestfs-actions.pod:6002 ../src/guestfs-actions.pod:6030
5991 #: ../src/guestfs-actions.pod:6054 ../src/guestfs-actions.pod:6073
5992 #: ../src/guestfs-actions.pod:6097 ../src/guestfs-actions.pod:6116
5993 #: ../src/guestfs-actions.pod:6131 ../src/guestfs-actions.pod:6150
5994 #: ../src/guestfs-actions.pod:6187 ../src/guestfs-actions.pod:6217
5995 #: ../src/guestfs-actions.pod:6250 ../src/guestfs-actions.pod:6372
5996 #: ../src/guestfs-actions.pod:6493 ../src/guestfs-actions.pod:6505
5997 #: ../src/guestfs-actions.pod:6518 ../src/guestfs-actions.pod:6531
5998 #: ../src/guestfs-actions.pod:6553 ../src/guestfs-actions.pod:6566
5999 #: ../src/guestfs-actions.pod:6579 ../src/guestfs-actions.pod:6592
6000 #: ../src/guestfs-actions.pod:6607 ../src/guestfs-actions.pod:6666
6001 #: ../src/guestfs-actions.pod:6683 ../src/guestfs-actions.pod:6699
6002 #: ../src/guestfs-actions.pod:6715 ../src/guestfs-actions.pod:6732
6003 #: ../src/guestfs-actions.pod:6745 ../src/guestfs-actions.pod:6765
6004 #: ../src/guestfs-actions.pod:6801 ../src/guestfs-actions.pod:6815
6005 #: ../src/guestfs-actions.pod:6856 ../src/guestfs-actions.pod:6869
6006 #: ../src/guestfs-actions.pod:6887 ../src/guestfs-actions.pod:6921
6007 #: ../src/guestfs-actions.pod:6957 ../src/guestfs-actions.pod:7076
6008 #: ../src/guestfs-actions.pod:7094 ../src/guestfs-actions.pod:7108
6009 #: ../src/guestfs-actions.pod:7163 ../src/guestfs-actions.pod:7176
6010 #: ../src/guestfs-actions.pod:7221 ../src/guestfs-actions.pod:7254
6011 #: ../src/guestfs-actions.pod:7315 ../src/guestfs-actions.pod:7341
6012 #: ../src/guestfs-actions.pod:7407 ../src/guestfs-actions.pod:7426
6013 #: ../src/guestfs-actions.pod:7455
6014 msgid "This function returns 0 on success or -1 on error."
6018 #: ../src/guestfs-actions.pod:32 ../src/guestfs-actions.pod:248
6019 #: ../src/guestfs-actions.pod:269
6021 "This function is deprecated. In new code, use the L</"
6022 "guestfs_add_drive_opts> call instead."
6026 #: ../src/guestfs-actions.pod:35 ../src/guestfs-actions.pod:251
6027 #: ../src/guestfs-actions.pod:272 ../src/guestfs-actions.pod:1453
6028 #: ../src/guestfs-actions.pod:1946 ../src/guestfs-actions.pod:1967
6029 #: ../src/guestfs-actions.pod:4453 ../src/guestfs-actions.pod:4760
6030 #: ../src/guestfs-actions.pod:6195 ../src/guestfs-actions.pod:6225
6031 #: ../src/guestfs-actions.pod:6258 ../src/guestfs-actions.pod:6317
6032 #: ../src/guestfs-actions.pod:7259 ../src/guestfs-actions.pod:7349
6033 #: ../src/guestfs-actions.pod:7518 ../fish/guestfish-actions.pod:31
6034 #: ../fish/guestfish-actions.pod:161 ../fish/guestfish-actions.pod:175
6035 #: ../fish/guestfish-actions.pod:961 ../fish/guestfish-actions.pod:1321
6036 #: ../fish/guestfish-actions.pod:1335 ../fish/guestfish-actions.pod:3032
6037 #: ../fish/guestfish-actions.pod:3229 ../fish/guestfish-actions.pod:4210
6038 #: ../fish/guestfish-actions.pod:4233 ../fish/guestfish-actions.pod:4255
6039 #: ../fish/guestfish-actions.pod:4293 ../fish/guestfish-actions.pod:4934
6040 #: ../fish/guestfish-actions.pod:5031
6042 "Deprecated functions will not be removed from the API, but the fact that "
6043 "they are deprecated indicates that there are problems with correct use of "
6048 #: ../src/guestfs-actions.pod:39 ../src/guestfs-actions.pod:136
6049 #: ../src/guestfs-actions.pod:1105 ../src/guestfs-actions.pod:1918
6050 #: ../src/guestfs-actions.pod:2016 ../src/guestfs-actions.pod:2119
6051 #: ../src/guestfs-actions.pod:3485 ../src/guestfs-actions.pod:3505
6052 #: ../src/guestfs-actions.pod:4764 ../src/guestfs-actions.pod:5887
6053 #: ../src/guestfs-actions.pod:6004 ../src/guestfs-actions.pod:6118
6054 #: ../src/guestfs-actions.pod:6609 ../src/guestfs-actions.pod:6734
6055 #: ../src/guestfs-actions.pod:7263
6056 msgid "(Added in 0.3)"
6060 #: ../src/guestfs-actions.pod:41
6061 msgid "guestfs_add_domain"
6065 #: ../src/guestfs-actions.pod:43
6069 " guestfs_add_domain (guestfs_h *g,\n"
6070 " const char *dom,\n"
6076 #: ../src/guestfs-actions.pod:48 ../src/guestfs-actions.pod:145
6077 #: ../src/guestfs-actions.pod:4467
6079 "You may supply a list of optional arguments to this call. Use zero or more "
6080 "of the following pairs of parameters, and terminate the list with C<-1> on "
6081 "its own. See L</CALLS WITH OPTIONAL ARGUMENTS>."
6085 #: ../src/guestfs-actions.pod:53
6088 " GUESTFS_ADD_DOMAIN_LIBVIRTURI, const char *libvirturi,\n"
6089 " GUESTFS_ADD_DOMAIN_READONLY, int readonly,\n"
6090 " GUESTFS_ADD_DOMAIN_IFACE, const char *iface,\n"
6091 " GUESTFS_ADD_DOMAIN_LIVE, int live,\n"
6096 #: ../src/guestfs-actions.pod:58
6098 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
6099 "It works by connecting to libvirt, requesting the domain and domain XML from "
6100 "libvirt, parsing it for disks, and calling C<guestfs_add_drive_opts> on each "
6105 #: ../src/guestfs-actions.pod:63 ../fish/guestfish-actions.pod:46
6107 "The number of disks added is returned. This operation is atomic: if an "
6108 "error is returned, then no disks are added."
6112 #: ../src/guestfs-actions.pod:66 ../fish/guestfish-actions.pod:49
6114 "This function does some minimal checks to make sure the libvirt domain is "
6115 "not running (unless C<readonly> is true). In a future version we will try "
6116 "to acquire the libvirt lock on each disk."
6120 #: ../src/guestfs-actions.pod:70 ../fish/guestfish-actions.pod:53
6122 "Disks must be accessible locally. This often means that adding disks from a "
6123 "remote libvirt connection (see L<http://libvirt.org/remote.html>) will fail "
6124 "unless those disks are accessible via the same device path locally too."
6128 #: ../src/guestfs-actions.pod:75 ../fish/guestfish-actions.pod:58
6130 "The optional C<libvirturi> parameter sets the libvirt URI (see L<http://"
6131 "libvirt.org/uri.html>). If this is not set then we connect to the default "
6132 "libvirt URI (or one set through an environment variable, see the libvirt "
6133 "documentation for full details)."
6137 #: ../src/guestfs-actions.pod:81 ../fish/guestfish-actions.pod:64
6139 "The optional C<live> flag controls whether this call will try to connect to "
6140 "a running virtual machine C<guestfsd> process if it sees a suitable "
6141 "E<lt>channelE<gt> element in the libvirt XML definition. The default (if "
6142 "the flag is omitted) is never to try. See L<guestfs(3)/ATTACHING TO RUNNING "
6143 "DAEMONS> for more information."
6147 #: ../src/guestfs-actions.pod:88
6149 "The other optional parameters are passed directly through to "
6150 "C<guestfs_add_drive_opts>."
6154 #: ../src/guestfs-actions.pod:91 ../src/guestfs-actions.pod:344
6155 #: ../src/guestfs-actions.pod:514 ../src/guestfs-actions.pod:692
6156 #: ../src/guestfs-actions.pod:723 ../src/guestfs-actions.pod:741
6157 #: ../src/guestfs-actions.pod:760 ../src/guestfs-actions.pod:1320
6158 #: ../src/guestfs-actions.pod:1676 ../src/guestfs-actions.pod:1879
6159 #: ../src/guestfs-actions.pod:1988 ../src/guestfs-actions.pod:2028
6160 #: ../src/guestfs-actions.pod:2083 ../src/guestfs-actions.pod:2106
6161 #: ../src/guestfs-actions.pod:2421 ../src/guestfs-actions.pod:2804
6162 #: ../src/guestfs-actions.pod:2825 ../src/guestfs-actions.pod:4900
6163 #: ../src/guestfs-actions.pod:5037 ../src/guestfs-actions.pod:5443
6164 #: ../src/guestfs-actions.pod:5469 ../src/guestfs-actions.pod:6842
6165 #: ../src/guestfs-actions.pod:7274 ../src/guestfs-actions.pod:7287
6166 #: ../src/guestfs-actions.pod:7300
6167 msgid "On error this function returns -1."
6171 #: ../src/guestfs-actions.pod:93
6172 msgid "(Added in 1.7.4)"
6176 #: ../src/guestfs-actions.pod:95
6177 msgid "guestfs_add_domain_va"
6181 #: ../src/guestfs-actions.pod:97
6185 " guestfs_add_domain_va (guestfs_h *g,\n"
6186 " const char *dom,\n"
6192 #: ../src/guestfs-actions.pod:102
6193 msgid "This is the \"va_list variant\" of L</guestfs_add_domain>."
6197 #: ../src/guestfs-actions.pod:104 ../src/guestfs-actions.pod:115
6198 #: ../src/guestfs-actions.pod:208 ../src/guestfs-actions.pod:219
6199 #: ../src/guestfs-actions.pod:4520 ../src/guestfs-actions.pod:4532
6200 msgid "See L</CALLS WITH OPTIONAL ARGUMENTS>."
6204 #: ../src/guestfs-actions.pod:106
6205 msgid "guestfs_add_domain_argv"
6209 #: ../src/guestfs-actions.pod:108
6213 " guestfs_add_domain_argv (guestfs_h *g,\n"
6214 " const char *dom,\n"
6215 " const struct guestfs_add_domain_argv *optargs);\n"
6220 #: ../src/guestfs-actions.pod:113
6221 msgid "This is the \"argv variant\" of L</guestfs_add_domain>."
6225 #: ../src/guestfs-actions.pod:117
6226 msgid "guestfs_add_drive"
6230 #: ../src/guestfs-actions.pod:119
6234 " guestfs_add_drive (guestfs_h *g,\n"
6235 " const char *filename);\n"
6240 #: ../src/guestfs-actions.pod:123
6242 "This function is the equivalent of calling C<guestfs_add_drive_opts> with no "
6243 "optional parameters, so the disk is added writable, with the format being "
6244 "detected automatically."
6248 #: ../src/guestfs-actions.pod:127
6250 "Automatic detection of the format opens you up to a potential security hole "
6251 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
6252 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
6253 "you should think about replacing calls to this function with calls to "
6254 "C<guestfs_add_drive_opts>, and specifying the format."
6258 #: ../src/guestfs-actions.pod:138
6259 msgid "guestfs_add_drive_opts"
6263 #: ../src/guestfs-actions.pod:140
6267 " guestfs_add_drive_opts (guestfs_h *g,\n"
6268 " const char *filename,\n"
6274 #: ../src/guestfs-actions.pod:150
6277 " GUESTFS_ADD_DRIVE_OPTS_READONLY, int readonly,\n"
6278 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, const char *format,\n"
6279 " GUESTFS_ADD_DRIVE_OPTS_IFACE, const char *iface,\n"
6284 #: ../src/guestfs-actions.pod:154 ../fish/guestfish-actions.pod:97
6286 "This function adds a virtual machine disk image C<filename> to libguestfs. "
6287 "The first time you call this function, the disk appears as C</dev/sda>, the "
6288 "second time as C</dev/sdb>, and so on."
6292 #: ../src/guestfs-actions.pod:159 ../fish/guestfish-actions.pod:102
6294 "You don't necessarily need to be root when using libguestfs. However you "
6295 "obviously do need sufficient permissions to access the filename for whatever "
6296 "operations you want to perform (ie. read access if you just want to read the "
6297 "image or write access if you want to modify the image)."
6301 #: ../src/guestfs-actions.pod:165 ../fish/guestfish-actions.pod:108
6302 msgid "This call checks that C<filename> exists."
6306 #: ../src/guestfs-actions.pod:167 ../src/guestfs-actions.pod:4478
6307 #: ../fish/guestfish-actions.pod:110 ../fish/guestfish-actions.pod:3043
6308 msgid "The optional arguments are:"
6312 #: ../src/guestfs-actions.pod:171 ../fish/guestfish-actions.pod:114
6314 msgstr "C<readonly>"
6317 #: ../src/guestfs-actions.pod:173 ../fish/guestfish-actions.pod:116
6319 "If true then the image is treated as read-only. Writes are still allowed, "
6320 "but they are stored in a temporary snapshot overlay which is discarded at "
6321 "the end. The disk that you add is not modified."
6325 #: ../src/guestfs-actions.pod:177 ../fish/guestfish-actions.pod:120
6330 #: ../src/guestfs-actions.pod:179
6332 "This forces the image format. If you omit this (or use C<guestfs_add_drive> "
6333 "or C<guestfs_add_drive_ro>) then the format is automatically detected. "
6334 "Possible formats include C<raw> and C<qcow2>."
6338 #: ../src/guestfs-actions.pod:183 ../fish/guestfish-actions.pod:126
6340 "Automatic detection of the format opens you up to a potential security hole "
6341 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
6342 "RHBZ#642934. Specifying the format closes this security hole."
6346 #: ../src/guestfs-actions.pod:188 ../fish/guestfish-actions.pod:131
6351 #: ../src/guestfs-actions.pod:190
6353 "This rarely-used option lets you emulate the behaviour of the deprecated "
6354 "C<guestfs_add_drive_with_if> call (q.v.)"
6358 #: ../src/guestfs-actions.pod:197
6359 msgid "(Added in 1.5.23)"
6363 #: ../src/guestfs-actions.pod:199
6364 msgid "guestfs_add_drive_opts_va"
6368 #: ../src/guestfs-actions.pod:201
6372 " guestfs_add_drive_opts_va (guestfs_h *g,\n"
6373 " const char *filename,\n"
6379 #: ../src/guestfs-actions.pod:206
6380 msgid "This is the \"va_list variant\" of L</guestfs_add_drive_opts>."
6384 #: ../src/guestfs-actions.pod:210
6385 msgid "guestfs_add_drive_opts_argv"
6389 #: ../src/guestfs-actions.pod:212
6393 " guestfs_add_drive_opts_argv (guestfs_h *g,\n"
6394 " const char *filename,\n"
6395 " const struct guestfs_add_drive_opts_argv *optargs);\n"
6400 #: ../src/guestfs-actions.pod:217
6401 msgid "This is the \"argv variant\" of L</guestfs_add_drive_opts>."
6405 #: ../src/guestfs-actions.pod:221
6406 msgid "guestfs_add_drive_ro"
6410 #: ../src/guestfs-actions.pod:223
6414 " guestfs_add_drive_ro (guestfs_h *g,\n"
6415 " const char *filename);\n"
6420 #: ../src/guestfs-actions.pod:227
6422 "This function is the equivalent of calling C<guestfs_add_drive_opts> with "
6423 "the optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the "
6424 "disk is added read-only, with the format being detected automatically."
6428 #: ../src/guestfs-actions.pod:234
6429 msgid "(Added in 1.0.38)"
6433 #: ../src/guestfs-actions.pod:236
6434 msgid "guestfs_add_drive_ro_with_if"
6438 #: ../src/guestfs-actions.pod:238
6442 " guestfs_add_drive_ro_with_if (guestfs_h *g,\n"
6443 " const char *filename,\n"
6444 " const char *iface);\n"
6449 #: ../src/guestfs-actions.pod:243
6451 "This is the same as C<guestfs_add_drive_ro> but it allows you to specify the "
6452 "QEMU interface emulation to use at run time."
6456 #: ../src/guestfs-actions.pod:255 ../src/guestfs-actions.pod:276
6457 #: ../src/guestfs-actions.pod:2380
6458 msgid "(Added in 1.0.84)"
6462 #: ../src/guestfs-actions.pod:257
6463 msgid "guestfs_add_drive_with_if"
6467 #: ../src/guestfs-actions.pod:259
6471 " guestfs_add_drive_with_if (guestfs_h *g,\n"
6472 " const char *filename,\n"
6473 " const char *iface);\n"
6478 #: ../src/guestfs-actions.pod:264
6480 "This is the same as C<guestfs_add_drive> but it allows you to specify the "
6481 "QEMU interface emulation to use at run time."
6485 #: ../src/guestfs-actions.pod:278
6486 msgid "guestfs_aug_clear"
6490 #: ../src/guestfs-actions.pod:280
6494 " guestfs_aug_clear (guestfs_h *g,\n"
6495 " const char *augpath);\n"
6500 #: ../src/guestfs-actions.pod:284 ../fish/guestfish-actions.pod:183
6502 "Set the value associated with C<path> to C<NULL>. This is the same as the "
6503 "L<augtool(1)> C<clear> command."
6507 #: ../src/guestfs-actions.pod:289 ../src/guestfs-actions.pod:2108
6508 msgid "(Added in 1.3.4)"
6512 #: ../src/guestfs-actions.pod:291
6513 msgid "guestfs_aug_close"
6517 #: ../src/guestfs-actions.pod:293
6521 " guestfs_aug_close (guestfs_h *g);\n"
6526 #: ../src/guestfs-actions.pod:296
6528 "Close the current Augeas handle and free up any resources used by it. After "
6529 "calling this, you have to call C<guestfs_aug_init> again before you can use "
6530 "any other Augeas functions."
6534 #: ../src/guestfs-actions.pod:303 ../src/guestfs-actions.pod:328
6535 #: ../src/guestfs-actions.pod:346 ../src/guestfs-actions.pod:360
6536 #: ../src/guestfs-actions.pod:423 ../src/guestfs-actions.pod:443
6537 #: ../src/guestfs-actions.pod:457 ../src/guestfs-actions.pod:488
6538 #: ../src/guestfs-actions.pod:502 ../src/guestfs-actions.pod:516
6539 #: ../src/guestfs-actions.pod:530 ../src/guestfs-actions.pod:548
6540 #: ../src/guestfs-actions.pod:5520
6541 msgid "(Added in 0.7)"
6545 #: ../src/guestfs-actions.pod:305
6546 msgid "guestfs_aug_defnode"
6550 #: ../src/guestfs-actions.pod:307
6553 " struct guestfs_int_bool *\n"
6554 " guestfs_aug_defnode (guestfs_h *g,\n"
6555 " const char *name,\n"
6556 " const char *expr,\n"
6557 " const char *val);\n"
6562 #: ../src/guestfs-actions.pod:313 ../fish/guestfish-actions.pod:199
6564 "Defines a variable C<name> whose value is the result of evaluating C<expr>."
6568 #: ../src/guestfs-actions.pod:316
6570 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
6571 "calling C<guestfs_aug_set> C<expr>, C<value>. C<name> will be the nodeset "
6572 "containing that single node."
6576 #: ../src/guestfs-actions.pod:320 ../fish/guestfish-actions.pod:206
6578 "On success this returns a pair containing the number of nodes in the "
6579 "nodeset, and a boolean flag if a node was created."
6583 #: ../src/guestfs-actions.pod:324
6585 "This function returns a C<struct guestfs_int_bool *>, or NULL if there was "
6586 "an error. I<The caller must call C<guestfs_free_int_bool> after use>."
6590 #: ../src/guestfs-actions.pod:330
6591 msgid "guestfs_aug_defvar"
6595 #: ../src/guestfs-actions.pod:332
6599 " guestfs_aug_defvar (guestfs_h *g,\n"
6600 " const char *name,\n"
6601 " const char *expr);\n"
6606 #: ../src/guestfs-actions.pod:337 ../fish/guestfish-actions.pod:214
6608 "Defines an Augeas variable C<name> whose value is the result of evaluating "
6609 "C<expr>. If C<expr> is NULL, then C<name> is undefined."
6613 #: ../src/guestfs-actions.pod:341 ../fish/guestfish-actions.pod:218
6615 "On success this returns the number of nodes in C<expr>, or C<0> if C<expr> "
6616 "evaluates to something which is not a nodeset."
6620 #: ../src/guestfs-actions.pod:348
6621 msgid "guestfs_aug_get"
6625 #: ../src/guestfs-actions.pod:350
6629 " guestfs_aug_get (guestfs_h *g,\n"
6630 " const char *augpath);\n"
6635 #: ../src/guestfs-actions.pod:354 ../fish/guestfish-actions.pod:225
6637 "Look up the value associated with C<path>. If C<path> matches exactly one "
6638 "node, the C<value> is returned."
6642 #: ../src/guestfs-actions.pod:357 ../src/guestfs-actions.pod:862
6643 #: ../src/guestfs-actions.pod:880 ../src/guestfs-actions.pod:940
6644 #: ../src/guestfs-actions.pod:956 ../src/guestfs-actions.pod:1059
6645 #: ../src/guestfs-actions.pod:1189 ../src/guestfs-actions.pod:1206
6646 #: ../src/guestfs-actions.pod:1225 ../src/guestfs-actions.pod:1359
6647 #: ../src/guestfs-actions.pod:1547 ../src/guestfs-actions.pod:1659
6648 #: ../src/guestfs-actions.pod:1822 ../src/guestfs-actions.pod:1839
6649 #: ../src/guestfs-actions.pod:1906 ../src/guestfs-actions.pod:1940
6650 #: ../src/guestfs-actions.pod:1961 ../src/guestfs-actions.pod:2131
6651 #: ../src/guestfs-actions.pod:2345 ../src/guestfs-actions.pod:2552
6652 #: ../src/guestfs-actions.pod:2645 ../src/guestfs-actions.pod:2756
6653 #: ../src/guestfs-actions.pod:2776 ../src/guestfs-actions.pod:2896
6654 #: ../src/guestfs-actions.pod:2927 ../src/guestfs-actions.pod:2951
6655 #: ../src/guestfs-actions.pod:2988 ../src/guestfs-actions.pod:3048
6656 #: ../src/guestfs-actions.pod:3071 ../src/guestfs-actions.pod:3092
6657 #: ../src/guestfs-actions.pod:3664 ../src/guestfs-actions.pod:4014
6658 #: ../src/guestfs-actions.pod:4184 ../src/guestfs-actions.pod:4294
6659 #: ../src/guestfs-actions.pod:5055 ../src/guestfs-actions.pod:5248
6660 #: ../src/guestfs-actions.pod:5418 ../src/guestfs-actions.pod:5596
6661 #: ../src/guestfs-actions.pod:5645 ../src/guestfs-actions.pod:6278
6662 #: ../src/guestfs-actions.pod:6294 ../src/guestfs-actions.pod:6311
6663 #: ../src/guestfs-actions.pod:6342 ../src/guestfs-actions.pod:7016
6664 #: ../src/guestfs-actions.pod:7035 ../src/guestfs-actions.pod:7053
6665 #: ../src/guestfs-actions.pod:7233 ../src/guestfs-actions.pod:7512
6667 "This function returns a string, or NULL on error. I<The caller must free "
6668 "the returned string after use>."
6672 #: ../src/guestfs-actions.pod:362
6673 msgid "guestfs_aug_init"
6677 #: ../src/guestfs-actions.pod:364
6681 " guestfs_aug_init (guestfs_h *g,\n"
6682 " const char *root,\n"
6688 #: ../src/guestfs-actions.pod:369 ../fish/guestfish-actions.pod:232
6690 "Create a new Augeas handle for editing configuration files. If there was "
6691 "any previous Augeas handle associated with this guestfs session, then it is "
6696 #: ../src/guestfs-actions.pod:373
6697 msgid "You must call this before using any other C<guestfs_aug_*> commands."
6701 #: ../src/guestfs-actions.pod:376 ../fish/guestfish-actions.pod:239
6703 "C<root> is the filesystem root. C<root> must not be NULL, use C</> instead."
6707 #: ../src/guestfs-actions.pod:379 ../fish/guestfish-actions.pod:242
6709 "The flags are the same as the flags defined in E<lt>augeas.hE<gt>, the "
6710 "logical I<or> of the following integers:"
6714 #: ../src/guestfs-actions.pod:385 ../fish/guestfish-actions.pod:248
6715 msgid "C<AUG_SAVE_BACKUP> = 1"
6716 msgstr "C<AUG_SAVE_BACKUP> = 1"
6719 #: ../src/guestfs-actions.pod:387 ../fish/guestfish-actions.pod:250
6720 msgid "Keep the original file with a C<.augsave> extension."
6724 #: ../src/guestfs-actions.pod:389 ../fish/guestfish-actions.pod:252
6725 msgid "C<AUG_SAVE_NEWFILE> = 2"
6726 msgstr "C<AUG_SAVE_NEWFILE> = 2"
6729 #: ../src/guestfs-actions.pod:391 ../fish/guestfish-actions.pod:254
6731 "Save changes into a file with extension C<.augnew>, and do not overwrite "
6732 "original. Overrides C<AUG_SAVE_BACKUP>."
6736 #: ../src/guestfs-actions.pod:394 ../fish/guestfish-actions.pod:257
6737 msgid "C<AUG_TYPE_CHECK> = 4"
6738 msgstr "C<AUG_TYPE_CHECK> = 4"
6741 #: ../src/guestfs-actions.pod:396 ../fish/guestfish-actions.pod:259
6742 msgid "Typecheck lenses."
6746 #: ../src/guestfs-actions.pod:398
6748 "This option is only useful when debugging Augeas lenses. Use of this option "
6749 "may require additional memory for the libguestfs appliance. You may need to "
6750 "set the C<LIBGUESTFS_MEMSIZE> environment variable or call "
6751 "C<guestfs_set_memsize>."
6755 #: ../src/guestfs-actions.pod:403 ../fish/guestfish-actions.pod:266
6756 msgid "C<AUG_NO_STDINC> = 8"
6757 msgstr "C<AUG_NO_STDINC> = 8"
6760 #: ../src/guestfs-actions.pod:405 ../fish/guestfish-actions.pod:268
6761 msgid "Do not use standard load path for modules."
6765 #: ../src/guestfs-actions.pod:407 ../fish/guestfish-actions.pod:270
6766 msgid "C<AUG_SAVE_NOOP> = 16"
6767 msgstr "C<AUG_SAVE_NOOP> = 16"
6770 #: ../src/guestfs-actions.pod:409 ../fish/guestfish-actions.pod:272
6771 msgid "Make save a no-op, just record what would have been changed."
6775 #: ../src/guestfs-actions.pod:411 ../fish/guestfish-actions.pod:274
6776 msgid "C<AUG_NO_LOAD> = 32"
6777 msgstr "C<AUG_NO_LOAD> = 32"
6780 #: ../src/guestfs-actions.pod:413
6781 msgid "Do not load the tree in C<guestfs_aug_init>."
6785 #: ../src/guestfs-actions.pod:417
6786 msgid "To close the handle, you can call C<guestfs_aug_close>."
6790 #: ../src/guestfs-actions.pod:419 ../fish/guestfish-actions.pod:282
6791 msgid "To find out more about Augeas, see L<http://augeas.net/>."
6795 #: ../src/guestfs-actions.pod:425
6796 msgid "guestfs_aug_insert"
6800 #: ../src/guestfs-actions.pod:427
6804 " guestfs_aug_insert (guestfs_h *g,\n"
6805 " const char *augpath,\n"
6806 " const char *label,\n"
6812 #: ../src/guestfs-actions.pod:433 ../fish/guestfish-actions.pod:288
6814 "Create a new sibling C<label> for C<path>, inserting it into the tree before "
6815 "or after C<path> (depending on the boolean flag C<before>)."
6819 #: ../src/guestfs-actions.pod:437 ../fish/guestfish-actions.pod:292
6821 "C<path> must match exactly one existing node in the tree, and C<label> must "
6822 "be a label, ie. not contain C</>, C<*> or end with a bracketed index C<[N]>."
6826 #: ../src/guestfs-actions.pod:445
6827 msgid "guestfs_aug_load"
6831 #: ../src/guestfs-actions.pod:447
6835 " guestfs_aug_load (guestfs_h *g);\n"
6840 #: ../src/guestfs-actions.pod:450 ../fish/guestfish-actions.pod:300
6841 msgid "Load files into the tree."
6842 msgstr "Завантажити файли до ієрархії."
6845 #: ../src/guestfs-actions.pod:452 ../fish/guestfish-actions.pod:302
6846 msgid "See C<aug_load> in the Augeas documentation for the full gory details."
6850 #: ../src/guestfs-actions.pod:459
6851 msgid "guestfs_aug_ls"
6855 #: ../src/guestfs-actions.pod:461
6859 " guestfs_aug_ls (guestfs_h *g,\n"
6860 " const char *augpath);\n"
6865 #: ../src/guestfs-actions.pod:465
6867 "This is just a shortcut for listing C<guestfs_aug_match> C<path/*> and "
6868 "sorting the resulting nodes into alphabetical order."
6872 #: ../src/guestfs-actions.pod:468 ../src/guestfs-actions.pod:484
6873 #: ../src/guestfs-actions.pod:630 ../src/guestfs-actions.pod:1078
6874 #: ../src/guestfs-actions.pod:1374 ../src/guestfs-actions.pod:1393
6875 #: ../src/guestfs-actions.pod:1496 ../src/guestfs-actions.pod:1515
6876 #: ../src/guestfs-actions.pod:1761 ../src/guestfs-actions.pod:2203
6877 #: ../src/guestfs-actions.pod:2219 ../src/guestfs-actions.pod:2238
6878 #: ../src/guestfs-actions.pod:2303 ../src/guestfs-actions.pod:2327
6879 #: ../src/guestfs-actions.pod:2398 ../src/guestfs-actions.pod:2447
6880 #: ../src/guestfs-actions.pod:2714 ../src/guestfs-actions.pod:3005
6881 #: ../src/guestfs-actions.pod:3294 ../src/guestfs-actions.pod:3584
6882 #: ../src/guestfs-actions.pod:3646 ../src/guestfs-actions.pod:3751
6883 #: ../src/guestfs-actions.pod:4156 ../src/guestfs-actions.pod:4861
6884 #: ../src/guestfs-actions.pod:5390 ../src/guestfs-actions.pod:5516
6885 #: ../src/guestfs-actions.pod:5630 ../src/guestfs-actions.pod:6358
6886 #: ../src/guestfs-actions.pod:6419 ../src/guestfs-actions.pod:6474
6887 #: ../src/guestfs-actions.pod:6620 ../src/guestfs-actions.pod:6644
6888 #: ../src/guestfs-actions.pod:7126 ../src/guestfs-actions.pod:7146
6889 #: ../src/guestfs-actions.pod:7193 ../src/guestfs-actions.pod:7365
6890 #: ../src/guestfs-actions.pod:7384 ../src/guestfs-actions.pod:7469
6891 #: ../src/guestfs-actions.pod:7488 ../src/guestfs-actions.pod:7534
6892 #: ../src/guestfs-actions.pod:7553
6894 "This function returns a NULL-terminated array of strings (like L<environ(3)"
6895 ">), or NULL if there was an error. I<The caller must free the strings and "
6896 "the array after use>."
6900 #: ../src/guestfs-actions.pod:472 ../src/guestfs-actions.pod:1003
6901 #: ../src/guestfs-actions.pod:1021 ../src/guestfs-actions.pod:1431
6902 #: ../src/guestfs-actions.pod:3372 ../src/guestfs-actions.pod:3403
6903 #: ../src/guestfs-actions.pod:3997 ../src/guestfs-actions.pod:4047
6904 #: ../src/guestfs-actions.pod:4234 ../src/guestfs-actions.pod:4267
6905 #: ../src/guestfs-actions.pod:4430 ../src/guestfs-actions.pod:4865
6906 #: ../src/guestfs-actions.pod:5331 ../src/guestfs-actions.pod:5726
6907 #: ../src/guestfs-actions.pod:5740 ../src/guestfs-actions.pod:5752
6908 #: ../src/guestfs-actions.pod:6199 ../src/guestfs-actions.pod:6858
6909 #: ../src/guestfs-actions.pod:6871 ../src/guestfs-actions.pod:7110
6910 #: ../src/guestfs-actions.pod:7353
6911 msgid "(Added in 0.8)"
6915 #: ../src/guestfs-actions.pod:474
6916 msgid "guestfs_aug_match"
6920 #: ../src/guestfs-actions.pod:476
6924 " guestfs_aug_match (guestfs_h *g,\n"
6925 " const char *augpath);\n"
6930 #: ../src/guestfs-actions.pod:480 ../fish/guestfish-actions.pod:316
6932 "Returns a list of paths which match the path expression C<path>. The "
6933 "returned paths are sufficiently qualified so that they match exactly one "
6934 "node in the current tree."
6938 #: ../src/guestfs-actions.pod:490
6939 msgid "guestfs_aug_mv"
6943 #: ../src/guestfs-actions.pod:492
6947 " guestfs_aug_mv (guestfs_h *g,\n"
6948 " const char *src,\n"
6949 " const char *dest);\n"
6954 #: ../src/guestfs-actions.pod:497 ../fish/guestfish-actions.pod:324
6956 "Move the node C<src> to C<dest>. C<src> must match exactly one node. "
6957 "C<dest> is overwritten if it exists."
6961 #: ../src/guestfs-actions.pod:504
6962 msgid "guestfs_aug_rm"
6966 #: ../src/guestfs-actions.pod:506
6970 " guestfs_aug_rm (guestfs_h *g,\n"
6971 " const char *augpath);\n"
6976 #: ../src/guestfs-actions.pod:510 ../fish/guestfish-actions.pod:331
6977 msgid "Remove C<path> and all of its children."
6981 #: ../src/guestfs-actions.pod:512 ../fish/guestfish-actions.pod:333
6982 msgid "On success this returns the number of entries which were removed."
6986 #: ../src/guestfs-actions.pod:518
6987 msgid "guestfs_aug_save"
6991 #: ../src/guestfs-actions.pod:520
6995 " guestfs_aug_save (guestfs_h *g);\n"
7000 #: ../src/guestfs-actions.pod:523 ../fish/guestfish-actions.pod:339
7001 msgid "This writes all pending changes to disk."
7005 #: ../src/guestfs-actions.pod:525
7007 "The flags which were passed to C<guestfs_aug_init> affect exactly how files "
7012 #: ../src/guestfs-actions.pod:532
7013 msgid "guestfs_aug_set"
7017 #: ../src/guestfs-actions.pod:534
7021 " guestfs_aug_set (guestfs_h *g,\n"
7022 " const char *augpath,\n"
7023 " const char *val);\n"
7028 #: ../src/guestfs-actions.pod:539 ../fish/guestfish-actions.pod:348
7029 msgid "Set the value associated with C<path> to C<val>."
7033 #: ../src/guestfs-actions.pod:541
7035 "In the Augeas API, it is possible to clear a node by setting the value to "
7036 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
7037 "this call. Instead you must use the C<guestfs_aug_clear> call."
7041 #: ../src/guestfs-actions.pod:550
7042 msgid "guestfs_available"
7046 #: ../src/guestfs-actions.pod:552
7050 " guestfs_available (guestfs_h *g,\n"
7051 " char *const *groups);\n"
7056 #: ../src/guestfs-actions.pod:556 ../fish/guestfish-actions.pod:359
7058 "This command is used to check the availability of some groups of "
7059 "functionality in the appliance, which not all builds of the libguestfs "
7060 "appliance will be able to provide."
7064 #: ../src/guestfs-actions.pod:560
7066 "The libguestfs groups, and the functions that those groups correspond to, "
7067 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
7068 "runtime by calling C<guestfs_available_all_groups>."
7072 #: ../src/guestfs-actions.pod:565 ../fish/guestfish-actions.pod:368
7074 "The argument C<groups> is a list of group names, eg: C<[\"inotify\", \"augeas"
7075 "\"]> would check for the availability of the Linux inotify functions and "
7076 "Augeas (configuration file editing) functions."
7080 #: ../src/guestfs-actions.pod:570 ../fish/guestfish-actions.pod:373
7081 msgid "The command returns no error if I<all> requested groups are available."
7085 #: ../src/guestfs-actions.pod:572 ../fish/guestfish-actions.pod:375
7087 "It fails with an error if one or more of the requested groups is unavailable "
7092 #: ../src/guestfs-actions.pod:575 ../fish/guestfish-actions.pod:378
7094 "If an unknown group name is included in the list of groups then an error is "
7099 #: ../src/guestfs-actions.pod:578 ../fish/guestfish-actions.pod:381
7101 msgstr "I<Нотатки:>"
7104 #: ../src/guestfs-actions.pod:584
7105 msgid "You must call C<guestfs_launch> before calling this function."
7109 #: ../src/guestfs-actions.pod:586 ../fish/guestfish-actions.pod:389
7111 "The reason is because we don't know what groups are supported by the "
7112 "appliance/daemon until it is running and can be queried."
7116 #: ../src/guestfs-actions.pod:592 ../fish/guestfish-actions.pod:395
7118 "If a group of functions is available, this does not necessarily mean that "
7119 "they will work. You still have to check for errors when calling individual "
7120 "API functions even if they are available."
7124 #: ../src/guestfs-actions.pod:599 ../fish/guestfish-actions.pod:402
7126 "It is usually the job of distro packagers to build complete functionality "
7127 "into the libguestfs appliance. Upstream libguestfs, if built from source "
7128 "with all requirements satisfied, will support everything."
7132 #: ../src/guestfs-actions.pod:606
7134 "This call was added in version C<1.0.80>. In previous versions of "
7135 "libguestfs all you could do would be to speculatively execute a command to "
7136 "find out if the daemon implemented it. See also C<guestfs_version>."
7140 #: ../src/guestfs-actions.pod:615 ../src/guestfs-actions.pod:1176
7141 msgid "(Added in 1.0.80)"
7145 #: ../src/guestfs-actions.pod:617
7146 msgid "guestfs_available_all_groups"
7150 #: ../src/guestfs-actions.pod:619
7154 " guestfs_available_all_groups (guestfs_h *g);\n"
7159 #: ../src/guestfs-actions.pod:622
7161 "This command returns a list of all optional groups that this daemon knows "
7162 "about. Note this returns both supported and unsupported groups. To find "
7163 "out which ones the daemon can actually support you have to call "
7164 "C<guestfs_available> on each member of the returned list."
7168 #: ../src/guestfs-actions.pod:628
7169 msgid "See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>."
7173 #: ../src/guestfs-actions.pod:634
7174 msgid "(Added in 1.3.15)"
7178 #: ../src/guestfs-actions.pod:636
7179 msgid "guestfs_base64_in"
7183 #: ../src/guestfs-actions.pod:638
7187 " guestfs_base64_in (guestfs_h *g,\n"
7188 " const char *base64file,\n"
7189 " const char *filename);\n"
7194 #: ../src/guestfs-actions.pod:643 ../fish/guestfish-actions.pod:432
7196 "This command uploads base64-encoded data from C<base64file> to C<filename>."
7200 #: ../src/guestfs-actions.pod:648 ../src/guestfs-actions.pod:662
7201 msgid "(Added in 1.3.5)"
7205 #: ../src/guestfs-actions.pod:650
7206 msgid "guestfs_base64_out"
7210 #: ../src/guestfs-actions.pod:652
7214 " guestfs_base64_out (guestfs_h *g,\n"
7215 " const char *filename,\n"
7216 " const char *base64file);\n"
7221 #: ../src/guestfs-actions.pod:657 ../fish/guestfish-actions.pod:441
7223 "This command downloads the contents of C<filename>, writing it out to local "
7224 "file C<base64file> encoded as base64."
7228 #: ../src/guestfs-actions.pod:664
7229 msgid "guestfs_blockdev_flushbufs"
7233 #: ../src/guestfs-actions.pod:666
7237 " guestfs_blockdev_flushbufs (guestfs_h *g,\n"
7238 " const char *device);\n"
7243 #: ../src/guestfs-actions.pod:670 ../fish/guestfish-actions.pod:450
7245 "This tells the kernel to flush internal buffers associated with C<device>."
7249 #: ../src/guestfs-actions.pod:673 ../src/guestfs-actions.pod:690
7250 #: ../src/guestfs-actions.pod:705 ../src/guestfs-actions.pod:721
7251 #: ../src/guestfs-actions.pod:739 ../src/guestfs-actions.pod:758
7252 #: ../src/guestfs-actions.pod:772 ../src/guestfs-actions.pod:790
7253 #: ../src/guestfs-actions.pod:804 ../src/guestfs-actions.pod:818
7254 #: ../fish/guestfish-actions.pod:453 ../fish/guestfish-actions.pod:464
7255 #: ../fish/guestfish-actions.pod:473 ../fish/guestfish-actions.pod:483
7256 #: ../fish/guestfish-actions.pod:495 ../fish/guestfish-actions.pod:508
7257 #: ../fish/guestfish-actions.pod:516 ../fish/guestfish-actions.pod:527
7258 #: ../fish/guestfish-actions.pod:535 ../fish/guestfish-actions.pod:543
7259 msgid "This uses the L<blockdev(8)> command."
7263 #: ../src/guestfs-actions.pod:677 ../src/guestfs-actions.pod:694
7264 #: ../src/guestfs-actions.pod:709 ../src/guestfs-actions.pod:725
7265 #: ../src/guestfs-actions.pod:743 ../src/guestfs-actions.pod:762
7266 #: ../src/guestfs-actions.pod:776 ../src/guestfs-actions.pod:794
7267 #: ../src/guestfs-actions.pod:808 ../src/guestfs-actions.pod:822
7268 msgid "(Added in 0.9.3)"
7272 #: ../src/guestfs-actions.pod:679
7273 msgid "guestfs_blockdev_getbsz"
7277 #: ../src/guestfs-actions.pod:681
7281 " guestfs_blockdev_getbsz (guestfs_h *g,\n"
7282 " const char *device);\n"
7287 #: ../src/guestfs-actions.pod:685 ../fish/guestfish-actions.pod:459
7288 msgid "This returns the block size of a device."
7292 #: ../src/guestfs-actions.pod:687 ../src/guestfs-actions.pod:787
7293 #: ../fish/guestfish-actions.pod:461 ../fish/guestfish-actions.pod:524
7295 "(Note this is different from both I<size in blocks> and I<filesystem block "
7300 #: ../src/guestfs-actions.pod:696
7301 msgid "guestfs_blockdev_getro"
7305 #: ../src/guestfs-actions.pod:698
7309 " guestfs_blockdev_getro (guestfs_h *g,\n"
7310 " const char *device);\n"
7315 #: ../src/guestfs-actions.pod:702 ../fish/guestfish-actions.pod:470
7317 "Returns a boolean indicating if the block device is read-only (true if read-"
7318 "only, false if not)."
7322 #: ../src/guestfs-actions.pod:707 ../src/guestfs-actions.pod:1414
7323 #: ../src/guestfs-actions.pod:1429 ../src/guestfs-actions.pod:1916
7324 #: ../src/guestfs-actions.pod:1927 ../src/guestfs-actions.pod:1999
7325 #: ../src/guestfs-actions.pod:2054 ../src/guestfs-actions.pod:2069
7326 #: ../src/guestfs-actions.pod:2094 ../src/guestfs-actions.pod:2117
7327 #: ../src/guestfs-actions.pod:3112 ../src/guestfs-actions.pod:3129
7328 #: ../src/guestfs-actions.pod:3148 ../src/guestfs-actions.pod:3311
7329 #: ../src/guestfs-actions.pod:3325 ../src/guestfs-actions.pod:3340
7330 #: ../src/guestfs-actions.pod:3354 ../src/guestfs-actions.pod:3370
7331 #: ../src/guestfs-actions.pod:3385 ../src/guestfs-actions.pod:3401
7332 #: ../src/guestfs-actions.pod:3415 ../src/guestfs-actions.pod:3428
7333 #: ../src/guestfs-actions.pod:3442 ../src/guestfs-actions.pod:3457
7334 #: ../src/guestfs-actions.pod:3472 ../src/guestfs-actions.pod:5019
7335 msgid "This function returns a C truth value on success or -1 on error."
7339 #: ../src/guestfs-actions.pod:711
7340 msgid "guestfs_blockdev_getsize64"
7344 #: ../src/guestfs-actions.pod:713
7348 " guestfs_blockdev_getsize64 (guestfs_h *g,\n"
7349 " const char *device);\n"
7354 #: ../src/guestfs-actions.pod:717 ../fish/guestfish-actions.pod:479
7355 msgid "This returns the size of the device in bytes."
7359 #: ../src/guestfs-actions.pod:719
7360 msgid "See also C<guestfs_blockdev_getsz>."
7364 #: ../src/guestfs-actions.pod:727
7365 msgid "guestfs_blockdev_getss"
7369 #: ../src/guestfs-actions.pod:729
7373 " guestfs_blockdev_getss (guestfs_h *g,\n"
7374 " const char *device);\n"
7379 #: ../src/guestfs-actions.pod:733 ../fish/guestfish-actions.pod:489
7381 "This returns the size of sectors on a block device. Usually 512, but can be "
7382 "larger for modern devices."
7386 #: ../src/guestfs-actions.pod:736
7388 "(Note, this is not the size in sectors, use C<guestfs_blockdev_getsz> for "
7393 #: ../src/guestfs-actions.pod:745
7394 msgid "guestfs_blockdev_getsz"
7398 #: ../src/guestfs-actions.pod:747
7402 " guestfs_blockdev_getsz (guestfs_h *g,\n"
7403 " const char *device);\n"
7408 #: ../src/guestfs-actions.pod:751 ../fish/guestfish-actions.pod:501
7410 "This returns the size of the device in units of 512-byte sectors (even if "
7411 "the sectorsize isn't 512 bytes ... weird)."
7415 #: ../src/guestfs-actions.pod:754
7417 "See also C<guestfs_blockdev_getss> for the real sector size of the device, "
7418 "and C<guestfs_blockdev_getsize64> for the more useful I<size in bytes>."
7422 #: ../src/guestfs-actions.pod:764
7423 msgid "guestfs_blockdev_rereadpt"
7427 #: ../src/guestfs-actions.pod:766
7431 " guestfs_blockdev_rereadpt (guestfs_h *g,\n"
7432 " const char *device);\n"
7437 #: ../src/guestfs-actions.pod:770 ../fish/guestfish-actions.pod:514
7438 msgid "Reread the partition table on C<device>."
7442 #: ../src/guestfs-actions.pod:778
7443 msgid "guestfs_blockdev_setbsz"
7447 #: ../src/guestfs-actions.pod:780
7451 " guestfs_blockdev_setbsz (guestfs_h *g,\n"
7452 " const char *device,\n"
7453 " int blocksize);\n"
7458 #: ../src/guestfs-actions.pod:785 ../fish/guestfish-actions.pod:522
7459 msgid "This sets the block size of a device."
7463 #: ../src/guestfs-actions.pod:796
7464 msgid "guestfs_blockdev_setro"
7468 #: ../src/guestfs-actions.pod:798
7472 " guestfs_blockdev_setro (guestfs_h *g,\n"
7473 " const char *device);\n"
7478 #: ../src/guestfs-actions.pod:802 ../fish/guestfish-actions.pod:533
7479 msgid "Sets the block device named C<device> to read-only."
7483 #: ../src/guestfs-actions.pod:810
7484 msgid "guestfs_blockdev_setrw"
7488 #: ../src/guestfs-actions.pod:812
7492 " guestfs_blockdev_setrw (guestfs_h *g,\n"
7493 " const char *device);\n"
7498 #: ../src/guestfs-actions.pod:816 ../fish/guestfish-actions.pod:541
7499 msgid "Sets the block device named C<device> to read-write."
7503 #: ../src/guestfs-actions.pod:824
7504 msgid "guestfs_case_sensitive_path"
7508 #: ../src/guestfs-actions.pod:826
7512 " guestfs_case_sensitive_path (guestfs_h *g,\n"
7513 " const char *path);\n"
7518 #: ../src/guestfs-actions.pod:830 ../fish/guestfish-actions.pod:549
7520 "This can be used to resolve case insensitive paths on a filesystem which is "
7521 "case sensitive. The use case is to resolve paths which you have read from "
7522 "Windows configuration files or the Windows Registry, to the true path."
7526 #: ../src/guestfs-actions.pod:835 ../fish/guestfish-actions.pod:554
7528 "The command handles a peculiarity of the Linux ntfs-3g filesystem driver "
7529 "(and probably others), which is that although the underlying filesystem is "
7530 "case-insensitive, the driver exports the filesystem to Linux as case-"
7535 #: ../src/guestfs-actions.pod:840 ../fish/guestfish-actions.pod:559
7537 "One consequence of this is that special directories such as C<c:\\windows> "
7538 "may appear as C</WINDOWS> or C</windows> (or other things) depending on the "
7539 "precise details of how they were created. In Windows itself this would not "
7544 #: ../src/guestfs-actions.pod:846 ../fish/guestfish-actions.pod:565
7546 "Bug or feature? You decide: L<http://www.tuxera.com/community/ntfs-3g-faq/"
7551 #: ../src/guestfs-actions.pod:849 ../fish/guestfish-actions.pod:568
7553 "This function resolves the true case of each element in the path and returns "
7554 "the case-sensitive path."
7558 #: ../src/guestfs-actions.pod:852
7560 "Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\") might return C<"
7561 "\"/WINDOWS/system32\"> (the exact return value would depend on details of "
7562 "how the directories were originally created under Windows)."
7566 #: ../src/guestfs-actions.pod:857 ../fish/guestfish-actions.pod:576
7567 msgid "I<Note>: This function does not handle drive names, backslashes etc."
7571 #: ../src/guestfs-actions.pod:860
7572 msgid "See also C<guestfs_realpath>."
7576 #: ../src/guestfs-actions.pod:865 ../src/guestfs-actions.pod:7038
7577 msgid "(Added in 1.0.75)"
7581 #: ../src/guestfs-actions.pod:867
7586 #: ../src/guestfs-actions.pod:869
7590 " guestfs_cat (guestfs_h *g,\n"
7591 " const char *path);\n"
7596 #: ../src/guestfs-actions.pod:873 ../src/guestfs-actions.pod:5506
7597 #: ../fish/guestfish-actions.pod:585 ../fish/guestfish-actions.pod:3707
7598 msgid "Return the contents of the file named C<path>."
7602 #: ../src/guestfs-actions.pod:875
7604 "Note that this function cannot correctly handle binary files (specifically, "
7605 "files containing C<\\0> character which is treated as end of string). For "
7606 "those you need to use the C<guestfs_read_file> or C<guestfs_download> "
7607 "functions which have a more complex interface."
7611 #: ../src/guestfs-actions.pod:883 ../src/guestfs-actions.pod:1062
7612 #: ../src/guestfs-actions.pod:1082 ../src/guestfs-actions.pod:1378
7613 #: ../src/guestfs-actions.pod:1397 ../src/guestfs-actions.pod:1500
7614 #: ../src/guestfs-actions.pod:1519 ../src/guestfs-actions.pod:1765
7615 #: ../src/guestfs-actions.pod:2223 ../src/guestfs-actions.pod:2242
7616 #: ../src/guestfs-actions.pod:2307 ../src/guestfs-actions.pod:2331
7617 #: ../src/guestfs-actions.pod:2348 ../src/guestfs-actions.pod:2377
7618 #: ../src/guestfs-actions.pod:5288 ../src/guestfs-actions.pod:5314
7619 #: ../src/guestfs-actions.pod:5445 ../src/guestfs-actions.pod:5471
7620 #: ../src/guestfs-actions.pod:5495 ../src/guestfs-actions.pod:6423
7621 #: ../src/guestfs-actions.pod:6478 ../src/guestfs-actions.pod:6624
7622 #: ../src/guestfs-actions.pod:6648 ../src/guestfs-actions.pod:7317
7623 #: ../src/guestfs-actions.pod:7343 ../src/guestfs-actions.pod:7369
7624 #: ../src/guestfs-actions.pod:7388 ../src/guestfs-actions.pod:7473
7625 #: ../src/guestfs-actions.pod:7492 ../src/guestfs-actions.pod:7538
7626 #: ../src/guestfs-actions.pod:7557 ../fish/guestfish-actions.pod:592
7627 #: ../fish/guestfish-actions.pod:727 ../fish/guestfish-actions.pod:739
7628 #: ../fish/guestfish-actions.pod:915 ../fish/guestfish-actions.pod:925
7629 #: ../fish/guestfish-actions.pod:992 ../fish/guestfish-actions.pod:1002
7630 #: ../fish/guestfish-actions.pod:1194 ../fish/guestfish-actions.pod:1495
7631 #: ../fish/guestfish-actions.pod:1505 ../fish/guestfish-actions.pod:1555
7632 #: ../fish/guestfish-actions.pod:1570 ../fish/guestfish-actions.pod:1580
7633 #: ../fish/guestfish-actions.pod:1599 ../fish/guestfish-actions.pod:3577
7634 #: ../fish/guestfish-actions.pod:3592 ../fish/guestfish-actions.pod:3668
7635 #: ../fish/guestfish-actions.pod:3685 ../fish/guestfish-actions.pod:3700
7636 #: ../fish/guestfish-actions.pod:4354 ../fish/guestfish-actions.pod:4400
7637 #: ../fish/guestfish-actions.pod:4485 ../fish/guestfish-actions.pod:4500
7638 #: ../fish/guestfish-actions.pod:4910 ../fish/guestfish-actions.pod:4928
7639 #: ../fish/guestfish-actions.pod:4945 ../fish/guestfish-actions.pod:4955
7640 #: ../fish/guestfish-actions.pod:5003 ../fish/guestfish-actions.pod:5013
7641 #: ../fish/guestfish-actions.pod:5042 ../fish/guestfish-actions.pod:5052
7643 "Because of the message protocol, there is a transfer limit of somewhere "
7644 "between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
7648 #: ../src/guestfs-actions.pod:886 ../src/guestfs-actions.pod:3588
7649 #: ../src/guestfs-actions.pod:3650 ../src/guestfs-actions.pod:3667
7650 #: ../src/guestfs-actions.pod:3755 ../src/guestfs-actions.pod:4160
7651 #: ../src/guestfs-actions.pod:4174 ../src/guestfs-actions.pod:5394
7652 #: ../src/guestfs-actions.pod:5408 ../src/guestfs-actions.pod:7197
7653 #: ../src/guestfs-actions.pod:7211
7654 msgid "(Added in 0.4)"
7658 #: ../src/guestfs-actions.pod:888
7659 msgid "guestfs_checksum"
7663 #: ../src/guestfs-actions.pod:890
7667 " guestfs_checksum (guestfs_h *g,\n"
7668 " const char *csumtype,\n"
7669 " const char *path);\n"
7674 #: ../src/guestfs-actions.pod:895 ../fish/guestfish-actions.pod:599
7676 "This call computes the MD5, SHAx or CRC checksum of the file named C<path>."
7680 #: ../src/guestfs-actions.pod:898 ../fish/guestfish-actions.pod:602
7682 "The type of checksum to compute is given by the C<csumtype> parameter which "
7683 "must have one of the following values:"
7687 #: ../src/guestfs-actions.pod:903 ../fish/guestfish-actions.pod:607
7692 #: ../src/guestfs-actions.pod:905 ../fish/guestfish-actions.pod:609
7694 "Compute the cyclic redundancy check (CRC) specified by POSIX for the "
7699 #: ../src/guestfs-actions.pod:908 ../fish/guestfish-actions.pod:612
7704 #: ../src/guestfs-actions.pod:910 ../fish/guestfish-actions.pod:614
7705 msgid "Compute the MD5 hash (using the C<md5sum> program)."
7709 #: ../src/guestfs-actions.pod:912 ../fish/guestfish-actions.pod:616
7714 #: ../src/guestfs-actions.pod:914 ../fish/guestfish-actions.pod:618
7715 msgid "Compute the SHA1 hash (using the C<sha1sum> program)."
7719 #: ../src/guestfs-actions.pod:916 ../fish/guestfish-actions.pod:620
7724 #: ../src/guestfs-actions.pod:918 ../fish/guestfish-actions.pod:622
7725 msgid "Compute the SHA224 hash (using the C<sha224sum> program)."
7729 #: ../src/guestfs-actions.pod:920 ../fish/guestfish-actions.pod:624
7734 #: ../src/guestfs-actions.pod:922 ../fish/guestfish-actions.pod:626
7735 msgid "Compute the SHA256 hash (using the C<sha256sum> program)."
7739 #: ../src/guestfs-actions.pod:924 ../fish/guestfish-actions.pod:628
7744 #: ../src/guestfs-actions.pod:926 ../fish/guestfish-actions.pod:630
7745 msgid "Compute the SHA384 hash (using the C<sha384sum> program)."
7749 #: ../src/guestfs-actions.pod:928 ../fish/guestfish-actions.pod:632
7754 #: ../src/guestfs-actions.pod:930 ../fish/guestfish-actions.pod:634
7755 msgid "Compute the SHA512 hash (using the C<sha512sum> program)."
7759 #: ../src/guestfs-actions.pod:934 ../fish/guestfish-actions.pod:638
7760 msgid "The checksum is returned as a printable string."
7764 #: ../src/guestfs-actions.pod:936
7765 msgid "To get the checksum for a device, use C<guestfs_checksum_device>."
7769 #: ../src/guestfs-actions.pod:938
7770 msgid "To get the checksums for many files, use C<guestfs_checksums_out>."
7774 #: ../src/guestfs-actions.pod:943 ../src/guestfs-actions.pod:1251
7775 #: ../src/guestfs-actions.pod:2085 ../src/guestfs-actions.pod:3327
7776 #: ../src/guestfs-actions.pod:3356 ../src/guestfs-actions.pod:3417
7777 #: ../src/guestfs-actions.pod:3444 ../src/guestfs-actions.pod:6894
7778 msgid "(Added in 1.0.2)"
7782 #: ../src/guestfs-actions.pod:945
7783 msgid "guestfs_checksum_device"
7787 #: ../src/guestfs-actions.pod:947
7791 " guestfs_checksum_device (guestfs_h *g,\n"
7792 " const char *csumtype,\n"
7793 " const char *device);\n"
7798 #: ../src/guestfs-actions.pod:952
7800 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
7801 "device named C<device>. For the types of checksums supported see the "
7802 "C<guestfs_checksum> command."
7806 #: ../src/guestfs-actions.pod:959 ../src/guestfs-actions.pod:4925
7807 #: ../src/guestfs-actions.pod:4984 ../src/guestfs-actions.pod:5021
7808 #: ../src/guestfs-actions.pod:5039 ../src/guestfs-actions.pod:5215
7809 #: ../src/guestfs-actions.pod:6803 ../src/guestfs-actions.pod:6817
7810 #: ../src/guestfs-actions.pod:7223
7811 msgid "(Added in 1.3.2)"
7815 #: ../src/guestfs-actions.pod:961
7816 msgid "guestfs_checksums_out"
7820 #: ../src/guestfs-actions.pod:963
7824 " guestfs_checksums_out (guestfs_h *g,\n"
7825 " const char *csumtype,\n"
7826 " const char *directory,\n"
7827 " const char *sumsfile);\n"
7832 #: ../src/guestfs-actions.pod:969 ../fish/guestfish-actions.pod:656
7834 "This command computes the checksums of all regular files in C<directory> and "
7835 "then emits a list of those checksums to the local output file C<sumsfile>."
7839 #: ../src/guestfs-actions.pod:973 ../fish/guestfish-actions.pod:660
7841 "This can be used for verifying the integrity of a virtual machine. However "
7842 "to be properly secure you should pay attention to the output of the checksum "
7843 "command (it uses the ones from GNU coreutils). In particular when the "
7844 "filename is not printable, coreutils uses a special backslash syntax. For "
7845 "more information, see the GNU coreutils info file."
7849 #: ../src/guestfs-actions.pod:983
7850 msgid "(Added in 1.3.7)"
7854 #: ../src/guestfs-actions.pod:985
7855 msgid "guestfs_chmod"
7859 #: ../src/guestfs-actions.pod:987
7863 " guestfs_chmod (guestfs_h *g,\n"
7865 " const char *path);\n"
7870 #: ../src/guestfs-actions.pod:992 ../fish/guestfish-actions.pod:674
7872 "Change the mode (permissions) of C<path> to C<mode>. Only numeric modes are "
7877 #: ../src/guestfs-actions.pod:995 ../fish/guestfish-actions.pod:677
7879 "I<Note>: When using this command from guestfish, C<mode> by default would be "
7880 "decimal, unless you prefix it with C<0> to get octal, ie. use C<0700> not "
7885 #: ../src/guestfs-actions.pod:999 ../src/guestfs-actions.pod:4411
7886 #: ../src/guestfs-actions.pod:4608 ../src/guestfs-actions.pod:4627
7887 #: ../src/guestfs-actions.pod:4646 ../fish/guestfish-actions.pod:681
7888 #: ../fish/guestfish-actions.pod:3007 ../fish/guestfish-actions.pod:3136
7889 #: ../fish/guestfish-actions.pod:3146 ../fish/guestfish-actions.pod:3156
7890 msgid "The mode actually set is affected by the umask."
7894 #: ../src/guestfs-actions.pod:1005
7895 msgid "guestfs_chown"
7899 #: ../src/guestfs-actions.pod:1007
7903 " guestfs_chown (guestfs_h *g,\n"
7906 " const char *path);\n"
7911 #: ../src/guestfs-actions.pod:1013 ../fish/guestfish-actions.pod:687
7912 msgid "Change the file owner to C<owner> and group to C<group>."
7916 #: ../src/guestfs-actions.pod:1015 ../src/guestfs-actions.pod:3519
7917 #: ../fish/guestfish-actions.pod:689 ../fish/guestfish-actions.pod:2465
7919 "Only numeric uid and gid are supported. If you want to use names, you will "
7920 "need to locate and parse the password file yourself (Augeas support makes "
7921 "this relatively easy)."
7925 #: ../src/guestfs-actions.pod:1023
7926 msgid "guestfs_command"
7930 #: ../src/guestfs-actions.pod:1025
7934 " guestfs_command (guestfs_h *g,\n"
7935 " char *const *arguments);\n"
7940 #: ../src/guestfs-actions.pod:1029 ../fish/guestfish-actions.pod:697
7942 "This call runs a command from the guest filesystem. The filesystem must be "
7943 "mounted, and must contain a compatible operating system (ie. something "
7944 "Linux, with the same or compatible processor architecture)."
7948 #: ../src/guestfs-actions.pod:1034
7950 "The single parameter is an argv-style list of arguments. The first element "
7951 "is the name of the program to run. Subsequent elements are parameters. The "
7952 "list must be non-empty (ie. must contain a program name). Note that the "
7953 "command runs directly, and is I<not> invoked via the shell (see "
7958 #: ../src/guestfs-actions.pod:1041 ../fish/guestfish-actions.pod:709
7959 msgid "The return value is anything printed to I<stdout> by the command."
7963 #: ../src/guestfs-actions.pod:1044 ../fish/guestfish-actions.pod:712
7965 "If the command returns a non-zero exit status, then this function returns an "
7966 "error message. The error message string is the content of I<stderr> from "
7971 #: ../src/guestfs-actions.pod:1048 ../fish/guestfish-actions.pod:716
7973 "The C<$PATH> environment variable will contain at least C</usr/bin> and C</"
7974 "bin>. If you require a program from another location, you should provide "
7975 "the full path in the first parameter."
7979 #: ../src/guestfs-actions.pod:1053 ../fish/guestfish-actions.pod:721
7981 "Shared libraries and data files required by the program must be available on "
7982 "filesystems which are mounted in the correct places. It is the caller's "
7983 "responsibility to ensure all filesystems that are needed are mounted at the "
7988 #: ../src/guestfs-actions.pod:1065 ../src/guestfs-actions.pod:1085
7989 #: ../src/guestfs-actions.pod:1550
7990 msgid "(Added in 0.9.1)"
7994 #: ../src/guestfs-actions.pod:1067
7995 msgid "guestfs_command_lines"
7999 #: ../src/guestfs-actions.pod:1069
8003 " guestfs_command_lines (guestfs_h *g,\n"
8004 " char *const *arguments);\n"
8009 #: ../src/guestfs-actions.pod:1073
8011 "This is the same as C<guestfs_command>, but splits the result into a list of "
8016 #: ../src/guestfs-actions.pod:1076
8017 msgid "See also: C<guestfs_sh_lines>"
8021 #: ../src/guestfs-actions.pod:1087
8022 msgid "guestfs_config"
8026 #: ../src/guestfs-actions.pod:1089
8030 " guestfs_config (guestfs_h *g,\n"
8031 " const char *qemuparam,\n"
8032 " const char *qemuvalue);\n"
8037 #: ../src/guestfs-actions.pod:1094 ../fish/guestfish-actions.pod:746
8039 "This can be used to add arbitrary qemu command line parameters of the form "
8040 "I<-param value>. Actually it's not quite arbitrary - we prevent you from "
8041 "setting some parameters which would interfere with parameters that we use."
8045 #: ../src/guestfs-actions.pod:1099 ../fish/guestfish-actions.pod:751
8046 msgid "The first character of C<param> string must be a C<-> (dash)."
8050 #: ../src/guestfs-actions.pod:1101 ../fish/guestfish-actions.pod:753
8051 msgid "C<value> can be NULL."
8055 #: ../src/guestfs-actions.pod:1107
8056 msgid "guestfs_copy_size"
8060 #: ../src/guestfs-actions.pod:1109
8064 " guestfs_copy_size (guestfs_h *g,\n"
8065 " const char *src,\n"
8066 " const char *dest,\n"
8072 #: ../src/guestfs-actions.pod:1115 ../fish/guestfish-actions.pod:759
8074 "This command copies exactly C<size> bytes from one source device or file "
8075 "C<src> to another destination device or file C<dest>."
8079 #: ../src/guestfs-actions.pod:1118 ../fish/guestfish-actions.pod:762
8081 "Note this will fail if the source is too short or if the destination is not "
8086 #: ../src/guestfs-actions.pod:1123 ../src/guestfs-actions.pod:1246
8087 #: ../src/guestfs-actions.pod:1277 ../src/guestfs-actions.pod:1322
8088 #: ../src/guestfs-actions.pod:1699 ../src/guestfs-actions.pod:1721
8089 #: ../src/guestfs-actions.pod:3500 ../src/guestfs-actions.pod:6889
8090 #: ../src/guestfs-actions.pod:6923 ../src/guestfs-actions.pod:7409
8091 #: ../src/guestfs-actions.pod:7428
8093 "This long-running command can generate progress notification messages so "
8094 "that the caller can display a progress bar or indicator. To receive these "
8095 "messages, the caller must register a progress event callback. See L<guestfs"
8096 "(3)/GUESTFS_EVENT_PROGRESS>."
8100 #: ../src/guestfs-actions.pod:1128 ../src/guestfs-actions.pod:4187
8101 #: ../src/guestfs-actions.pod:5421 ../src/guestfs-actions.pod:7130
8102 #: ../src/guestfs-actions.pod:7150 ../src/guestfs-actions.pod:7236
8103 msgid "(Added in 1.0.87)"
8107 #: ../src/guestfs-actions.pod:1130
8112 #: ../src/guestfs-actions.pod:1132
8116 " guestfs_cp (guestfs_h *g,\n"
8117 " const char *src,\n"
8118 " const char *dest);\n"
8123 #: ../src/guestfs-actions.pod:1137 ../fish/guestfish-actions.pod:769
8125 "This copies a file from C<src> to C<dest> where C<dest> is either a "
8126 "destination filename or destination directory."
8130 #: ../src/guestfs-actions.pod:1142 ../src/guestfs-actions.pod:1156
8131 #: ../src/guestfs-actions.pod:1228 ../src/guestfs-actions.pod:1302
8132 #: ../src/guestfs-actions.pod:1416 ../src/guestfs-actions.pod:4879
8133 #: ../src/guestfs-actions.pod:5265
8134 msgid "(Added in 1.0.18)"
8138 #: ../src/guestfs-actions.pod:1144
8139 msgid "guestfs_cp_a"
8143 #: ../src/guestfs-actions.pod:1146
8147 " guestfs_cp_a (guestfs_h *g,\n"
8148 " const char *src,\n"
8149 " const char *dest);\n"
8154 #: ../src/guestfs-actions.pod:1151 ../fish/guestfish-actions.pod:776
8156 "This copies a file or directory from C<src> to C<dest> recursively using the "
8161 #: ../src/guestfs-actions.pod:1158
8166 #: ../src/guestfs-actions.pod:1160
8170 " guestfs_dd (guestfs_h *g,\n"
8171 " const char *src,\n"
8172 " const char *dest);\n"
8177 #: ../src/guestfs-actions.pod:1165 ../fish/guestfish-actions.pod:783
8179 "This command copies from one source device or file C<src> to another "
8180 "destination device or file C<dest>. Normally you would use this to copy to "
8181 "or from a device or partition, for example to duplicate a filesystem."
8185 #: ../src/guestfs-actions.pod:1170
8187 "If the destination is a device, it must be as large or larger than the "
8188 "source file or device, otherwise the copy will fail. This command cannot do "
8189 "partial copies (see C<guestfs_copy_size>)."
8193 #: ../src/guestfs-actions.pod:1178
8198 #: ../src/guestfs-actions.pod:1180
8202 " guestfs_df (guestfs_h *g);\n"
8207 #: ../src/guestfs-actions.pod:1183 ../fish/guestfish-actions.pod:796
8208 msgid "This command runs the C<df> command to report disk space used."
8212 #: ../src/guestfs-actions.pod:1185 ../src/guestfs-actions.pod:1202
8214 "This command is mostly useful for interactive sessions. It is I<not> "
8215 "intended that you try to parse the output string. Use C<guestfs_statvfs> "
8220 #: ../src/guestfs-actions.pod:1192 ../src/guestfs-actions.pod:1209
8221 #: ../src/guestfs-actions.pod:1327 ../src/guestfs-actions.pod:2310
8222 #: ../src/guestfs-actions.pod:2334 ../src/guestfs-actions.pod:2402
8223 #: ../src/guestfs-actions.pod:4297 ../src/guestfs-actions.pod:4779
8224 #: ../src/guestfs-actions.pod:6627 ../src/guestfs-actions.pod:6651
8225 #: ../src/guestfs-actions.pod:7276 ../src/guestfs-actions.pod:7289
8226 #: ../src/guestfs-actions.pod:7302
8227 msgid "(Added in 1.0.54)"
8231 #: ../src/guestfs-actions.pod:1194
8232 msgid "guestfs_df_h"
8236 #: ../src/guestfs-actions.pod:1196
8240 " guestfs_df_h (guestfs_h *g);\n"
8245 #: ../src/guestfs-actions.pod:1199 ../fish/guestfish-actions.pod:806
8247 "This command runs the C<df -h> command to report disk space used in human-"
8252 #: ../src/guestfs-actions.pod:1211
8253 msgid "guestfs_dmesg"
8257 #: ../src/guestfs-actions.pod:1213
8261 " guestfs_dmesg (guestfs_h *g);\n"
8266 #: ../src/guestfs-actions.pod:1216 ../fish/guestfish-actions.pod:817
8268 "This returns the kernel messages (C<dmesg> output) from the guest kernel. "
8269 "This is sometimes useful for extended debugging of problems."
8273 #: ../src/guestfs-actions.pod:1220
8275 "Another way to get the same information is to enable verbose messages with "
8276 "C<guestfs_set_verbose> or by setting the environment variable "
8277 "C<LIBGUESTFS_DEBUG=1> before running the program."
8281 #: ../src/guestfs-actions.pod:1230
8282 msgid "guestfs_download"
8286 #: ../src/guestfs-actions.pod:1232
8290 " guestfs_download (guestfs_h *g,\n"
8291 " const char *remotefilename,\n"
8292 " const char *filename);\n"
8297 #: ../src/guestfs-actions.pod:1237 ../src/guestfs-actions.pod:1262
8298 #: ../fish/guestfish-actions.pod:830 ../fish/guestfish-actions.pod:843
8300 "Download file C<remotefilename> and save it as C<filename> on the local "
8305 #: ../src/guestfs-actions.pod:1240 ../src/guestfs-actions.pod:6883
8306 #: ../fish/guestfish-actions.pod:833 ../fish/guestfish-actions.pod:4658
8307 msgid "C<filename> can also be a named pipe."
8311 #: ../src/guestfs-actions.pod:1242
8312 msgid "See also C<guestfs_upload>, C<guestfs_cat>."
8316 #: ../src/guestfs-actions.pod:1253
8317 msgid "guestfs_download_offset"
8321 #: ../src/guestfs-actions.pod:1255
8325 " guestfs_download_offset (guestfs_h *g,\n"
8326 " const char *remotefilename,\n"
8327 " const char *filename,\n"
8328 " int64_t offset,\n"
8334 #: ../src/guestfs-actions.pod:1265 ../fish/guestfish-actions.pod:846
8336 "C<remotefilename> is read for C<size> bytes starting at C<offset> (this "
8337 "region must be within the file or device)."
8341 #: ../src/guestfs-actions.pod:1268
8343 "Note that there is no limit on the amount of data that can be downloaded "
8344 "with this call, unlike with C<guestfs_pread>, and this call always reads the "
8345 "full amount unless an error occurs."
8349 #: ../src/guestfs-actions.pod:1273
8350 msgid "See also C<guestfs_download>, C<guestfs_pread>."
8354 #: ../src/guestfs-actions.pod:1282 ../src/guestfs-actions.pod:6928
8355 msgid "(Added in 1.5.17)"
8359 #: ../src/guestfs-actions.pod:1284
8360 msgid "guestfs_drop_caches"
8364 #: ../src/guestfs-actions.pod:1286
8368 " guestfs_drop_caches (guestfs_h *g,\n"
8369 " int whattodrop);\n"
8374 #: ../src/guestfs-actions.pod:1290 ../fish/guestfish-actions.pod:862
8376 "This instructs the guest kernel to drop its page cache, and/or dentries and "
8377 "inode caches. The parameter C<whattodrop> tells the kernel what precisely "
8378 "to drop, see L<http://linux-mm.org/Drop_Caches>"
8382 #: ../src/guestfs-actions.pod:1295 ../fish/guestfish-actions.pod:867
8383 msgid "Setting C<whattodrop> to 3 should drop everything."
8387 #: ../src/guestfs-actions.pod:1297 ../fish/guestfish-actions.pod:869
8389 "This automatically calls L<sync(2)> before the operation, so that the "
8390 "maximum guest memory is freed."
8394 #: ../src/guestfs-actions.pod:1304
8399 #: ../src/guestfs-actions.pod:1306
8403 " guestfs_du (guestfs_h *g,\n"
8404 " const char *path);\n"
8409 #: ../src/guestfs-actions.pod:1310 ../fish/guestfish-actions.pod:876
8411 "This command runs the C<du -s> command to estimate file space usage for "
8416 #: ../src/guestfs-actions.pod:1313 ../fish/guestfish-actions.pod:879
8418 "C<path> can be a file or a directory. If C<path> is a directory then the "
8419 "estimate includes the contents of the directory and all subdirectories "
8424 #: ../src/guestfs-actions.pod:1317 ../fish/guestfish-actions.pod:883
8426 "The result is the estimated size in I<kilobytes> (ie. units of 1024 bytes)."
8430 #: ../src/guestfs-actions.pod:1329
8431 msgid "guestfs_e2fsck_f"
8435 #: ../src/guestfs-actions.pod:1331
8439 " guestfs_e2fsck_f (guestfs_h *g,\n"
8440 " const char *device);\n"
8445 #: ../src/guestfs-actions.pod:1335 ../fish/guestfish-actions.pod:890
8447 "This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3 filesystem checker "
8448 "on C<device>, noninteractively (I<-p>), even if the filesystem appears to be "
8453 #: ../src/guestfs-actions.pod:1339
8455 "This command is only needed because of C<guestfs_resize2fs> (q.v.). "
8456 "Normally you should use C<guestfs_fsck>."
8460 #: ../src/guestfs-actions.pod:1344
8461 msgid "(Added in 1.0.29)"
8465 #: ../src/guestfs-actions.pod:1346
8466 msgid "guestfs_echo_daemon"
8470 #: ../src/guestfs-actions.pod:1348
8474 " guestfs_echo_daemon (guestfs_h *g,\n"
8475 " char *const *words);\n"
8480 #: ../src/guestfs-actions.pod:1352 ../fish/guestfish-actions.pod:901
8482 "This command concatenates the list of C<words> passed with single spaces "
8483 "between them and returns the resulting string."
8487 #: ../src/guestfs-actions.pod:1355 ../fish/guestfish-actions.pod:904
8488 msgid "You can use this command to test the connection through to the daemon."
8492 #: ../src/guestfs-actions.pod:1357
8493 msgid "See also C<guestfs_ping_daemon>."
8497 #: ../src/guestfs-actions.pod:1362 ../src/guestfs-actions.pod:2096
8498 #: ../src/guestfs-actions.pod:6099
8499 msgid "(Added in 1.0.69)"
8503 #: ../src/guestfs-actions.pod:1364
8504 msgid "guestfs_egrep"
8508 #: ../src/guestfs-actions.pod:1366
8512 " guestfs_egrep (guestfs_h *g,\n"
8513 " const char *regex,\n"
8514 " const char *path);\n"
8519 #: ../src/guestfs-actions.pod:1371 ../fish/guestfish-actions.pod:912
8521 "This calls the external C<egrep> program and returns the matching lines."
8525 #: ../src/guestfs-actions.pod:1381 ../src/guestfs-actions.pod:1400
8526 #: ../src/guestfs-actions.pod:1457 ../src/guestfs-actions.pod:1503
8527 #: ../src/guestfs-actions.pod:1522 ../src/guestfs-actions.pod:2226
8528 #: ../src/guestfs-actions.pod:2245 ../src/guestfs-actions.pod:2423
8529 #: ../src/guestfs-actions.pod:2436 ../src/guestfs-actions.pod:2451
8530 #: ../src/guestfs-actions.pod:2497 ../src/guestfs-actions.pod:2519
8531 #: ../src/guestfs-actions.pod:2532 ../src/guestfs-actions.pod:3680
8532 #: ../src/guestfs-actions.pod:3694 ../src/guestfs-actions.pod:3707
8533 #: ../src/guestfs-actions.pod:3721 ../src/guestfs-actions.pod:4707
8534 #: ../src/guestfs-actions.pod:5599 ../src/guestfs-actions.pod:5648
8535 #: ../src/guestfs-actions.pod:6495 ../src/guestfs-actions.pod:6507
8536 #: ../src/guestfs-actions.pod:6520 ../src/guestfs-actions.pod:6533
8537 #: ../src/guestfs-actions.pod:6555 ../src/guestfs-actions.pod:6568
8538 #: ../src/guestfs-actions.pod:6581 ../src/guestfs-actions.pod:6594
8539 #: ../src/guestfs-actions.pod:7372 ../src/guestfs-actions.pod:7391
8540 #: ../src/guestfs-actions.pod:7476 ../src/guestfs-actions.pod:7495
8541 #: ../src/guestfs-actions.pod:7541 ../src/guestfs-actions.pod:7560
8542 msgid "(Added in 1.0.66)"
8546 #: ../src/guestfs-actions.pod:1383
8547 msgid "guestfs_egrepi"
8551 #: ../src/guestfs-actions.pod:1385
8555 " guestfs_egrepi (guestfs_h *g,\n"
8556 " const char *regex,\n"
8557 " const char *path);\n"
8562 #: ../src/guestfs-actions.pod:1390 ../fish/guestfish-actions.pod:922
8564 "This calls the external C<egrep -i> program and returns the matching lines."
8568 #: ../src/guestfs-actions.pod:1402
8569 msgid "guestfs_equal"
8573 #: ../src/guestfs-actions.pod:1404
8577 " guestfs_equal (guestfs_h *g,\n"
8578 " const char *file1,\n"
8579 " const char *file2);\n"
8584 #: ../src/guestfs-actions.pod:1409 ../fish/guestfish-actions.pod:932
8586 "This compares the two files C<file1> and C<file2> and returns true if their "
8587 "content is exactly equal, or false otherwise."
8591 #: ../src/guestfs-actions.pod:1412 ../fish/guestfish-actions.pod:935
8592 msgid "The external L<cmp(1)> program is used for the comparison."
8596 #: ../src/guestfs-actions.pod:1418
8597 msgid "guestfs_exists"
8601 #: ../src/guestfs-actions.pod:1420
8605 " guestfs_exists (guestfs_h *g,\n"
8606 " const char *path);\n"
8611 #: ../src/guestfs-actions.pod:1424 ../fish/guestfish-actions.pod:941
8613 "This returns C<true> if and only if there is a file, directory (or anything) "
8614 "with the given C<path> name."
8618 #: ../src/guestfs-actions.pod:1427
8619 msgid "See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>."
8623 #: ../src/guestfs-actions.pod:1433
8624 msgid "guestfs_fallocate"
8628 #: ../src/guestfs-actions.pod:1435
8632 " guestfs_fallocate (guestfs_h *g,\n"
8633 " const char *path,\n"
8639 #: ../src/guestfs-actions.pod:1440 ../src/guestfs-actions.pod:1466
8640 #: ../fish/guestfish-actions.pod:950 ../fish/guestfish-actions.pod:969
8642 "This command preallocates a file (containing zero bytes) named C<path> of "
8643 "size C<len> bytes. If the file exists already, it is overwritten."
8647 #: ../src/guestfs-actions.pod:1444 ../fish/guestfish-actions.pod:954
8649 "Do not confuse this with the guestfish-specific C<alloc> command which "
8650 "allocates a file in the host and attaches it as a device."
8654 #: ../src/guestfs-actions.pod:1450
8656 "This function is deprecated. In new code, use the L</guestfs_fallocate64> "
8661 #: ../src/guestfs-actions.pod:1459
8662 msgid "guestfs_fallocate64"
8666 #: ../src/guestfs-actions.pod:1461
8670 " guestfs_fallocate64 (guestfs_h *g,\n"
8671 " const char *path,\n"
8677 #: ../src/guestfs-actions.pod:1470
8679 "Note that this call allocates disk blocks for the file. To create a sparse "
8680 "file use C<guestfs_truncate_size> instead."
8684 #: ../src/guestfs-actions.pod:1473
8686 "The deprecated call C<guestfs_fallocate> does the same, but owing to an "
8687 "oversight it only allowed 30 bit lengths to be specified, effectively "
8688 "limiting the maximum size of files created through that call to 1GB."
8692 #: ../src/guestfs-actions.pod:1478 ../fish/guestfish-actions.pod:981
8694 "Do not confuse this with the guestfish-specific C<alloc> and C<sparse> "
8695 "commands which create a file in the host and attach it as a device."
8699 #: ../src/guestfs-actions.pod:1484
8700 msgid "(Added in 1.3.17)"
8704 #: ../src/guestfs-actions.pod:1486
8705 msgid "guestfs_fgrep"
8709 #: ../src/guestfs-actions.pod:1488
8713 " guestfs_fgrep (guestfs_h *g,\n"
8714 " const char *pattern,\n"
8715 " const char *path);\n"
8720 #: ../src/guestfs-actions.pod:1493 ../fish/guestfish-actions.pod:989
8722 "This calls the external C<fgrep> program and returns the matching lines."
8726 #: ../src/guestfs-actions.pod:1505
8727 msgid "guestfs_fgrepi"
8731 #: ../src/guestfs-actions.pod:1507
8735 " guestfs_fgrepi (guestfs_h *g,\n"
8736 " const char *pattern,\n"
8737 " const char *path);\n"
8742 #: ../src/guestfs-actions.pod:1512 ../fish/guestfish-actions.pod:999
8744 "This calls the external C<fgrep -i> program and returns the matching lines."
8748 #: ../src/guestfs-actions.pod:1524
8749 msgid "guestfs_file"
8753 #: ../src/guestfs-actions.pod:1526
8757 " guestfs_file (guestfs_h *g,\n"
8758 " const char *path);\n"
8763 #: ../src/guestfs-actions.pod:1530 ../fish/guestfish-actions.pod:1009
8765 "This call uses the standard L<file(1)> command to determine the type or "
8766 "contents of the file."
8770 #: ../src/guestfs-actions.pod:1533 ../fish/guestfish-actions.pod:1012
8772 "This call will also transparently look inside various types of compressed "
8777 #: ../src/guestfs-actions.pod:1536 ../fish/guestfish-actions.pod:1015
8779 "The exact command which runs is C<file -zb path>. Note in particular that "
8780 "the filename is not prepended to the output (the I<-b> option)."
8784 #: ../src/guestfs-actions.pod:1540 ../fish/guestfish-actions.pod:1019
8786 "The output depends on the output of the underlying L<file(1)> command and it "
8787 "can change in future in ways beyond our control. In other words, the output "
8788 "is not guaranteed by the ABI."
8792 #: ../src/guestfs-actions.pod:1544
8794 "See also: L<file(1)>, C<guestfs_vfs_type>, C<guestfs_lstat>, "
8795 "C<guestfs_is_file>, C<guestfs_is_blockdev> (etc)."
8799 #: ../src/guestfs-actions.pod:1552
8800 msgid "guestfs_file_architecture"
8804 #: ../src/guestfs-actions.pod:1554
8808 " guestfs_file_architecture (guestfs_h *g,\n"
8809 " const char *filename);\n"
8814 #: ../src/guestfs-actions.pod:1558 ../fish/guestfish-actions.pod:1030
8816 "This detects the architecture of the binary C<filename>, and returns it if "
8821 #: ../src/guestfs-actions.pod:1561 ../fish/guestfish-actions.pod:1033
8822 msgid "Currently defined architectures are:"
8826 #: ../src/guestfs-actions.pod:1565 ../fish/guestfish-actions.pod:1037
8831 #: ../src/guestfs-actions.pod:1567 ../fish/guestfish-actions.pod:1039
8833 "This string is returned for all 32 bit i386, i486, i586, i686 binaries "
8834 "irrespective of the precise processor requirements of the binary."
8838 #: ../src/guestfs-actions.pod:1570 ../fish/guestfish-actions.pod:1042
8843 #: ../src/guestfs-actions.pod:1572 ../fish/guestfish-actions.pod:1044
8844 msgid "64 bit x86-64."
8848 #: ../src/guestfs-actions.pod:1574 ../fish/guestfish-actions.pod:1046
8853 #: ../src/guestfs-actions.pod:1576 ../fish/guestfish-actions.pod:1048
8854 msgid "32 bit SPARC."
8858 #: ../src/guestfs-actions.pod:1578 ../fish/guestfish-actions.pod:1050
8863 #: ../src/guestfs-actions.pod:1580 ../fish/guestfish-actions.pod:1052
8864 msgid "64 bit SPARC V9 and above."
8868 #: ../src/guestfs-actions.pod:1582 ../fish/guestfish-actions.pod:1054
8873 #: ../src/guestfs-actions.pod:1584 ../fish/guestfish-actions.pod:1056
8874 msgid "Intel Itanium."
8875 msgstr "Intel Itanium."
8878 #: ../src/guestfs-actions.pod:1586 ../fish/guestfish-actions.pod:1058
8883 #: ../src/guestfs-actions.pod:1588 ../fish/guestfish-actions.pod:1060
8884 msgid "32 bit Power PC."
8888 #: ../src/guestfs-actions.pod:1590 ../fish/guestfish-actions.pod:1062
8893 #: ../src/guestfs-actions.pod:1592 ../fish/guestfish-actions.pod:1064
8894 msgid "64 bit Power PC."
8898 #: ../src/guestfs-actions.pod:1596 ../fish/guestfish-actions.pod:1068
8899 msgid "Libguestfs may return other architecture strings in future."
8903 #: ../src/guestfs-actions.pod:1598 ../fish/guestfish-actions.pod:1070
8904 msgid "The function works on at least the following types of files:"
8908 #: ../src/guestfs-actions.pod:1604 ../fish/guestfish-actions.pod:1076
8909 msgid "many types of Un*x and Linux binary"
8913 #: ../src/guestfs-actions.pod:1608 ../fish/guestfish-actions.pod:1080
8914 msgid "many types of Un*x and Linux shared library"
8918 #: ../src/guestfs-actions.pod:1612 ../fish/guestfish-actions.pod:1084
8919 msgid "Windows Win32 and Win64 binaries"
8923 #: ../src/guestfs-actions.pod:1616 ../fish/guestfish-actions.pod:1088
8924 msgid "Windows Win32 and Win64 DLLs"
8928 #: ../src/guestfs-actions.pod:1618 ../fish/guestfish-actions.pod:1090
8929 msgid "Win32 binaries and DLLs return C<i386>."
8933 #: ../src/guestfs-actions.pod:1620 ../fish/guestfish-actions.pod:1092
8934 msgid "Win64 binaries and DLLs return C<x86_64>."
8938 #: ../src/guestfs-actions.pod:1624 ../fish/guestfish-actions.pod:1096
8939 msgid "Linux kernel modules"
8943 #: ../src/guestfs-actions.pod:1628 ../fish/guestfish-actions.pod:1100
8944 msgid "Linux new-style initrd images"
8948 #: ../src/guestfs-actions.pod:1632 ../fish/guestfish-actions.pod:1104
8949 msgid "some non-x86 Linux vmlinuz kernels"
8953 #: ../src/guestfs-actions.pod:1636 ../fish/guestfish-actions.pod:1108
8954 msgid "What it can't do currently:"
8958 #: ../src/guestfs-actions.pod:1642 ../fish/guestfish-actions.pod:1114
8959 msgid "static libraries (libfoo.a)"
8963 #: ../src/guestfs-actions.pod:1646 ../fish/guestfish-actions.pod:1118
8964 msgid "Linux old-style initrd as compressed ext2 filesystem (RHEL 3)"
8968 #: ../src/guestfs-actions.pod:1650 ../fish/guestfish-actions.pod:1122
8969 msgid "x86 Linux vmlinuz kernels"
8973 #: ../src/guestfs-actions.pod:1652 ../fish/guestfish-actions.pod:1124
8975 "x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and "
8976 "compressed code, and are horribly hard to unpack. If you want to find the "
8977 "architecture of a kernel, use the architecture of the associated initrd or "
8978 "kernel module(s) instead."
8982 #: ../src/guestfs-actions.pod:1662 ../src/guestfs-actions.pod:1825
8983 #: ../src/guestfs-actions.pod:1842 ../src/guestfs-actions.pod:2555
8984 #: ../src/guestfs-actions.pod:2648 ../src/guestfs-actions.pod:2718
8985 #: ../src/guestfs-actions.pod:2806 ../src/guestfs-actions.pod:2827
8986 #: ../src/guestfs-actions.pod:2870 ../src/guestfs-actions.pod:2954
8987 #: ../src/guestfs-actions.pod:3051 ../src/guestfs-actions.pod:3298
8988 #: ../src/guestfs-actions.pod:3430
8989 msgid "(Added in 1.5.3)"
8993 #: ../src/guestfs-actions.pod:1664
8994 msgid "guestfs_filesize"
8998 #: ../src/guestfs-actions.pod:1666
9002 " guestfs_filesize (guestfs_h *g,\n"
9003 " const char *file);\n"
9008 #: ../src/guestfs-actions.pod:1670 ../fish/guestfish-actions.pod:1135
9009 msgid "This command returns the size of C<file> in bytes."
9013 #: ../src/guestfs-actions.pod:1672
9015 "To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>, "
9016 "C<guestfs_is_dir>, C<guestfs_is_file> etc. To get the size of block "
9017 "devices, use C<guestfs_blockdev_getsize64>."
9021 #: ../src/guestfs-actions.pod:1678
9022 msgid "(Added in 1.0.82)"
9026 #: ../src/guestfs-actions.pod:1680
9027 msgid "guestfs_fill"
9031 #: ../src/guestfs-actions.pod:1682
9035 " guestfs_fill (guestfs_h *g,\n"
9038 " const char *path);\n"
9043 #: ../src/guestfs-actions.pod:1688 ../fish/guestfish-actions.pod:1145
9045 "This command creates a new file called C<path>. The initial content of the "
9046 "file is C<len> octets of C<c>, where C<c> must be a number in the range C<"
9051 #: ../src/guestfs-actions.pod:1692
9053 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
9054 "C<guestfs_truncate_size>. To create a file with a pattern of repeating "
9055 "bytes use C<guestfs_fill_pattern>."
9059 #: ../src/guestfs-actions.pod:1704
9060 msgid "(Added in 1.0.79)"
9064 #: ../src/guestfs-actions.pod:1706
9065 msgid "guestfs_fill_pattern"
9069 #: ../src/guestfs-actions.pod:1708
9073 " guestfs_fill_pattern (guestfs_h *g,\n"
9074 " const char *pattern,\n"
9076 " const char *path);\n"
9081 #: ../src/guestfs-actions.pod:1714
9083 "This function is like C<guestfs_fill> except that it creates a new file of "
9084 "length C<len> containing the repeating pattern of bytes in C<pattern>. The "
9085 "pattern is truncated if necessary to ensure the length of the file is "
9086 "exactly C<len> bytes."
9090 #: ../src/guestfs-actions.pod:1726
9091 msgid "(Added in 1.3.12)"
9095 #: ../src/guestfs-actions.pod:1728
9096 msgid "guestfs_find"
9100 #: ../src/guestfs-actions.pod:1730
9104 " guestfs_find (guestfs_h *g,\n"
9105 " const char *directory);\n"
9110 #: ../src/guestfs-actions.pod:1734 ../fish/guestfish-actions.pod:1167
9112 "This command lists out all files and directories, recursively, starting at "
9113 "C<directory>. It is essentially equivalent to running the shell command "
9114 "C<find directory -print> but some post-processing happens on the output, "
9119 #: ../src/guestfs-actions.pod:1739 ../fish/guestfish-actions.pod:1172
9121 "This returns a list of strings I<without any prefix>. Thus if the directory "
9126 #: ../src/guestfs-actions.pod:1742 ../fish/guestfish-actions.pod:1175
9136 #: ../src/guestfs-actions.pod:1746
9138 "then the returned list from C<guestfs_find> C</tmp> would be 4 elements:"
9142 #: ../src/guestfs-actions.pod:1749 ../fish/guestfish-actions.pod:1182
9153 #: ../src/guestfs-actions.pod:1754 ../fish/guestfish-actions.pod:1187
9154 msgid "If C<directory> is not a directory, then this command returns an error."
9158 #: ../src/guestfs-actions.pod:1757 ../fish/guestfish-actions.pod:1190
9159 msgid "The returned list is sorted."
9163 #: ../src/guestfs-actions.pod:1759
9164 msgid "See also C<guestfs_find0>."
9168 #: ../src/guestfs-actions.pod:1768 ../src/guestfs-actions.pod:4124
9169 #: ../src/guestfs-actions.pod:5683
9170 msgid "(Added in 1.0.27)"
9174 #: ../src/guestfs-actions.pod:1770
9175 msgid "guestfs_find0"
9179 #: ../src/guestfs-actions.pod:1772
9183 " guestfs_find0 (guestfs_h *g,\n"
9184 " const char *directory,\n"
9185 " const char *files);\n"
9190 #: ../src/guestfs-actions.pod:1777 ../fish/guestfish-actions.pod:1201
9192 "This command lists out all files and directories, recursively, starting at "
9193 "C<directory>, placing the resulting list in the external file called "
9198 #: ../src/guestfs-actions.pod:1781
9200 "This command works the same way as C<guestfs_find> with the following "
9205 #: ../src/guestfs-actions.pod:1788 ../fish/guestfish-actions.pod:1212
9206 msgid "The resulting list is written to an external file."
9210 #: ../src/guestfs-actions.pod:1792 ../fish/guestfish-actions.pod:1216
9212 "Items (filenames) in the result are separated by C<\\0> characters. See "
9213 "L<find(1)> option I<-print0>."
9217 #: ../src/guestfs-actions.pod:1797 ../fish/guestfish-actions.pod:1221
9218 msgid "This command is not limited in the number of names that it can return."
9222 #: ../src/guestfs-actions.pod:1802 ../fish/guestfish-actions.pod:1226
9223 msgid "The result list is not sorted."
9227 #: ../src/guestfs-actions.pod:1808
9228 msgid "(Added in 1.0.74)"
9232 #: ../src/guestfs-actions.pod:1810
9233 msgid "guestfs_findfs_label"
9237 #: ../src/guestfs-actions.pod:1812
9241 " guestfs_findfs_label (guestfs_h *g,\n"
9242 " const char *label);\n"
9247 #: ../src/guestfs-actions.pod:1816 ../fish/guestfish-actions.pod:1236
9249 "This command searches the filesystems and returns the one which has the "
9250 "given label. An error is returned if no such filesystem can be found."
9254 #: ../src/guestfs-actions.pod:1820
9255 msgid "To find the label of a filesystem, use C<guestfs_vfs_label>."
9259 #: ../src/guestfs-actions.pod:1827
9260 msgid "guestfs_findfs_uuid"
9264 #: ../src/guestfs-actions.pod:1829
9268 " guestfs_findfs_uuid (guestfs_h *g,\n"
9269 " const char *uuid);\n"
9274 #: ../src/guestfs-actions.pod:1833 ../fish/guestfish-actions.pod:1246
9276 "This command searches the filesystems and returns the one which has the "
9277 "given UUID. An error is returned if no such filesystem can be found."
9281 #: ../src/guestfs-actions.pod:1837
9282 msgid "To find the UUID of a filesystem, use C<guestfs_vfs_uuid>."
9286 #: ../src/guestfs-actions.pod:1844
9287 msgid "guestfs_fsck"
9291 #: ../src/guestfs-actions.pod:1846
9295 " guestfs_fsck (guestfs_h *g,\n"
9296 " const char *fstype,\n"
9297 " const char *device);\n"
9302 #: ../src/guestfs-actions.pod:1851 ../fish/guestfish-actions.pod:1256
9304 "This runs the filesystem checker (fsck) on C<device> which should have "
9305 "filesystem type C<fstype>."
9309 #: ../src/guestfs-actions.pod:1854 ../fish/guestfish-actions.pod:1259
9311 "The returned integer is the status. See L<fsck(8)> for the list of status "
9312 "codes from C<fsck>."
9316 #: ../src/guestfs-actions.pod:1863 ../fish/guestfish-actions.pod:1268
9317 msgid "Multiple status codes can be summed together."
9321 #: ../src/guestfs-actions.pod:1867 ../fish/guestfish-actions.pod:1272
9323 "A non-zero return code can mean \"success\", for example if errors have been "
9324 "corrected on the filesystem."
9328 #: ../src/guestfs-actions.pod:1872 ../fish/guestfish-actions.pod:1277
9329 msgid "Checking or repairing NTFS volumes is not supported (by linux-ntfs)."
9333 #: ../src/guestfs-actions.pod:1877 ../fish/guestfish-actions.pod:1282
9335 "This command is entirely equivalent to running C<fsck -a -t fstype device>."
9339 #: ../src/guestfs-actions.pod:1881 ../src/guestfs-actions.pod:7414
9340 msgid "(Added in 1.0.16)"
9344 #: ../src/guestfs-actions.pod:1883
9345 msgid "guestfs_get_append"
9349 #: ../src/guestfs-actions.pod:1885
9353 " guestfs_get_append (guestfs_h *g);\n"
9358 #: ../src/guestfs-actions.pod:1888 ../fish/guestfish-actions.pod:1288
9360 "Return the additional kernel options which are added to the guest kernel "
9365 #: ../src/guestfs-actions.pod:1891 ../fish/guestfish-actions.pod:1291
9366 msgid "If C<NULL> then no options are added."
9370 #: ../src/guestfs-actions.pod:1893
9372 "This function returns a string which may be NULL. There is no way to return "
9373 "an error from this function. The string is owned by the guest handle and "
9374 "must I<not> be freed."
9378 #: ../src/guestfs-actions.pod:1897 ../src/guestfs-actions.pod:5361
9379 #: ../src/guestfs-actions.pod:5841 ../src/guestfs-actions.pod:6262
9380 #: ../src/guestfs-actions.pod:6281 ../src/guestfs-actions.pod:6297
9381 #: ../src/guestfs-actions.pod:6321 ../src/guestfs-actions.pod:7078
9382 #: ../src/guestfs-actions.pod:7096 ../src/guestfs-actions.pod:7457
9383 msgid "(Added in 1.0.26)"
9387 #: ../src/guestfs-actions.pod:1899
9388 msgid "guestfs_get_attach_method"
9392 #: ../src/guestfs-actions.pod:1901
9396 " guestfs_get_attach_method (guestfs_h *g);\n"
9401 #: ../src/guestfs-actions.pod:1904
9402 msgid "Return the current attach method. See C<guestfs_set_attach_method>."
9406 #: ../src/guestfs-actions.pod:1909
9407 msgid "guestfs_get_autosync"
9411 #: ../src/guestfs-actions.pod:1911
9415 " guestfs_get_autosync (guestfs_h *g);\n"
9420 #: ../src/guestfs-actions.pod:1914 ../fish/guestfish-actions.pod:1303
9421 msgid "Get the autosync flag."
9425 #: ../src/guestfs-actions.pod:1920
9426 msgid "guestfs_get_direct"
9430 #: ../src/guestfs-actions.pod:1922
9434 " guestfs_get_direct (guestfs_h *g);\n"
9439 #: ../src/guestfs-actions.pod:1925 ../fish/guestfish-actions.pod:1309
9440 msgid "Return the direct appliance mode flag."
9444 #: ../src/guestfs-actions.pod:1929 ../src/guestfs-actions.pod:5910
9445 msgid "(Added in 1.0.72)"
9449 #: ../src/guestfs-actions.pod:1931
9450 msgid "guestfs_get_e2label"
9454 #: ../src/guestfs-actions.pod:1933
9458 " guestfs_get_e2label (guestfs_h *g,\n"
9459 " const char *device);\n"
9464 #: ../src/guestfs-actions.pod:1937 ../fish/guestfish-actions.pod:1315
9466 "This returns the ext2/3/4 filesystem label of the filesystem on C<device>."
9470 #: ../src/guestfs-actions.pod:1943
9472 "This function is deprecated. In new code, use the L</guestfs_vfs_label> "
9477 #: ../src/guestfs-actions.pod:1950 ../src/guestfs-actions.pod:1971
9478 #: ../src/guestfs-actions.pod:5928 ../src/guestfs-actions.pod:5947
9479 msgid "(Added in 1.0.15)"
9483 #: ../src/guestfs-actions.pod:1952
9484 msgid "guestfs_get_e2uuid"
9488 #: ../src/guestfs-actions.pod:1954
9492 " guestfs_get_e2uuid (guestfs_h *g,\n"
9493 " const char *device);\n"
9498 #: ../src/guestfs-actions.pod:1958 ../fish/guestfish-actions.pod:1329
9500 "This returns the ext2/3/4 filesystem UUID of the filesystem on C<device>."
9504 #: ../src/guestfs-actions.pod:1964
9506 "This function is deprecated. In new code, use the L</guestfs_vfs_uuid> call "
9511 #: ../src/guestfs-actions.pod:1973
9512 msgid "guestfs_get_memsize"
9516 #: ../src/guestfs-actions.pod:1975
9520 " guestfs_get_memsize (guestfs_h *g);\n"
9525 #: ../src/guestfs-actions.pod:1978 ../fish/guestfish-actions.pod:1343
9527 "This gets the memory size in megabytes allocated to the qemu subprocess."
9531 #: ../src/guestfs-actions.pod:1981
9533 "If C<guestfs_set_memsize> was not called on this handle, and if "
9534 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
9535 "value for memsize."
9539 #: ../src/guestfs-actions.pod:1985 ../src/guestfs-actions.pod:2066
9540 #: ../src/guestfs-actions.pod:5963 ../src/guestfs-actions.pod:6070
9541 #: ../fish/guestfish-actions.pod:1350 ../fish/guestfish-actions.pod:1401
9542 #: ../fish/guestfish-actions.pod:4033 ../fish/guestfish-actions.pod:4120
9544 "For more information on the architecture of libguestfs, see L<guestfs(3)>."
9548 #: ../src/guestfs-actions.pod:1990 ../src/guestfs-actions.pod:4415
9549 #: ../src/guestfs-actions.pod:4612 ../src/guestfs-actions.pod:4631
9550 #: ../src/guestfs-actions.pod:4650 ../src/guestfs-actions.pod:4662
9551 #: ../src/guestfs-actions.pod:4679 ../src/guestfs-actions.pod:4692
9552 #: ../src/guestfs-actions.pod:5586 ../src/guestfs-actions.pod:5968
9553 #: ../src/guestfs-actions.pod:6229 ../src/guestfs-actions.pod:6844
9554 msgid "(Added in 1.0.55)"
9558 #: ../src/guestfs-actions.pod:1992
9559 msgid "guestfs_get_network"
9563 #: ../src/guestfs-actions.pod:1994
9567 " guestfs_get_network (guestfs_h *g);\n"
9572 #: ../src/guestfs-actions.pod:1997 ../fish/guestfish-actions.pod:1357
9573 msgid "This returns the enable network flag."
9577 #: ../src/guestfs-actions.pod:2001 ../src/guestfs-actions.pod:5987
9578 msgid "(Added in 1.5.4)"
9582 #: ../src/guestfs-actions.pod:2003
9583 msgid "guestfs_get_path"
9587 #: ../src/guestfs-actions.pod:2005
9591 " guestfs_get_path (guestfs_h *g);\n"
9596 #: ../src/guestfs-actions.pod:2008 ../fish/guestfish-actions.pod:1363
9597 msgid "Return the current search path."
9601 #: ../src/guestfs-actions.pod:2010 ../fish/guestfish-actions.pod:1365
9603 "This is always non-NULL. If it wasn't set already, then this will return "
9608 #: ../src/guestfs-actions.pod:2013 ../src/guestfs-actions.pod:2042
9610 "This function returns a string, or NULL on error. The string is owned by "
9611 "the guest handle and must I<not> be freed."
9615 #: ../src/guestfs-actions.pod:2018
9616 msgid "guestfs_get_pid"
9620 #: ../src/guestfs-actions.pod:2020
9624 " guestfs_get_pid (guestfs_h *g);\n"
9629 #: ../src/guestfs-actions.pod:2023 ../fish/guestfish-actions.pod:1374
9631 "Return the process ID of the qemu subprocess. If there is no qemu "
9632 "subprocess, then this will return an error."
9636 #: ../src/guestfs-actions.pod:2026 ../fish/guestfish-actions.pod:1377
9637 msgid "This is an internal call used for debugging and testing."
9641 #: ../src/guestfs-actions.pod:2030
9642 msgid "(Added in 1.0.56)"
9646 #: ../src/guestfs-actions.pod:2032
9647 msgid "guestfs_get_qemu"
9651 #: ../src/guestfs-actions.pod:2034
9655 " guestfs_get_qemu (guestfs_h *g);\n"
9660 #: ../src/guestfs-actions.pod:2037 ../fish/guestfish-actions.pod:1383
9661 msgid "Return the current qemu binary."
9665 #: ../src/guestfs-actions.pod:2039 ../fish/guestfish-actions.pod:1385
9667 "This is always non-NULL. If it wasn't set already, then this will return "
9668 "the default qemu binary name."
9672 #: ../src/guestfs-actions.pod:2045 ../src/guestfs-actions.pod:6032
9673 msgid "(Added in 1.0.6)"
9677 #: ../src/guestfs-actions.pod:2047
9678 msgid "guestfs_get_recovery_proc"
9682 #: ../src/guestfs-actions.pod:2049
9686 " guestfs_get_recovery_proc (guestfs_h *g);\n"
9691 #: ../src/guestfs-actions.pod:2052 ../fish/guestfish-actions.pod:1392
9692 msgid "Return the recovery process enabled flag."
9696 #: ../src/guestfs-actions.pod:2056 ../src/guestfs-actions.pod:3525
9697 #: ../src/guestfs-actions.pod:3822 ../src/guestfs-actions.pod:4222
9698 #: ../src/guestfs-actions.pod:4254 ../src/guestfs-actions.pod:5291
9699 #: ../src/guestfs-actions.pod:5634 ../src/guestfs-actions.pod:6056
9700 #: ../src/guestfs-actions.pod:6747 ../src/guestfs-actions.pod:6767
9701 #: ../src/guestfs-actions.pod:6959
9702 msgid "(Added in 1.0.77)"
9706 #: ../src/guestfs-actions.pod:2058
9707 msgid "guestfs_get_selinux"
9711 #: ../src/guestfs-actions.pod:2060
9715 " guestfs_get_selinux (guestfs_h *g);\n"
9720 #: ../src/guestfs-actions.pod:2063
9722 "This returns the current setting of the selinux flag which is passed to the "
9723 "appliance at boot time. See C<guestfs_set_selinux>."
9727 #: ../src/guestfs-actions.pod:2071 ../src/guestfs-actions.pod:2134
9728 #: ../src/guestfs-actions.pod:6075 ../src/guestfs-actions.pod:6133
9729 msgid "(Added in 1.0.67)"
9733 #: ../src/guestfs-actions.pod:2073
9734 msgid "guestfs_get_state"
9738 #: ../src/guestfs-actions.pod:2075
9742 " guestfs_get_state (guestfs_h *g);\n"
9747 #: ../src/guestfs-actions.pod:2078 ../fish/guestfish-actions.pod:1408
9749 "This returns the current state as an opaque integer. This is only useful "
9750 "for printing debug and internal error messages."
9754 #: ../src/guestfs-actions.pod:2081 ../src/guestfs-actions.pod:3323
9755 #: ../src/guestfs-actions.pod:3352 ../src/guestfs-actions.pod:3413
9756 #: ../src/guestfs-actions.pod:3440 ../fish/guestfish-actions.pod:1411
9757 #: ../fish/guestfish-actions.pod:2347 ../fish/guestfish-actions.pod:2365
9758 #: ../fish/guestfish-actions.pod:2403 ../fish/guestfish-actions.pod:2419
9759 msgid "For more information on states, see L<guestfs(3)>."
9763 #: ../src/guestfs-actions.pod:2087
9764 msgid "guestfs_get_trace"
9768 #: ../src/guestfs-actions.pod:2089
9772 " guestfs_get_trace (guestfs_h *g);\n"
9777 #: ../src/guestfs-actions.pod:2092 ../fish/guestfish-actions.pod:1417
9778 msgid "Return the command trace flag."
9782 #: ../src/guestfs-actions.pod:2098
9783 msgid "guestfs_get_umask"
9787 #: ../src/guestfs-actions.pod:2100
9791 " guestfs_get_umask (guestfs_h *g);\n"
9796 #: ../src/guestfs-actions.pod:2103
9798 "Return the current umask. By default the umask is C<022> unless it has been "
9799 "set by calling C<guestfs_umask>."
9803 #: ../src/guestfs-actions.pod:2110
9804 msgid "guestfs_get_verbose"
9808 #: ../src/guestfs-actions.pod:2112
9812 " guestfs_get_verbose (guestfs_h *g);\n"
9817 #: ../src/guestfs-actions.pod:2115 ../fish/guestfish-actions.pod:1430
9818 msgid "This returns the verbose messages flag."
9822 #: ../src/guestfs-actions.pod:2121
9823 msgid "guestfs_getcon"
9827 #: ../src/guestfs-actions.pod:2123
9831 " guestfs_getcon (guestfs_h *g);\n"
9836 #: ../src/guestfs-actions.pod:2126 ../fish/guestfish-actions.pod:1436
9837 msgid "This gets the SELinux security context of the daemon."
9841 #: ../src/guestfs-actions.pod:2128
9843 "See the documentation about SELINUX in L<guestfs(3)>, and C<guestfs_setcon>"
9847 #: ../src/guestfs-actions.pod:2136
9848 msgid "guestfs_getxattr"
9852 #: ../src/guestfs-actions.pod:2138
9856 " guestfs_getxattr (guestfs_h *g,\n"
9857 " const char *path,\n"
9858 " const char *name,\n"
9859 " size_t *size_r);\n"
9864 #: ../src/guestfs-actions.pod:2144
9866 "Get a single extended attribute from file C<path> named C<name>. This call "
9867 "follows symlinks. If you want to lookup an extended attribute for the "
9868 "symlink itself, use C<guestfs_lgetxattr>."
9872 #: ../src/guestfs-actions.pod:2148 ../src/guestfs-actions.pod:3539
9874 "Normally it is better to get all extended attributes from a file in one go "
9875 "by calling C<guestfs_getxattrs>. However some Linux filesystem "
9876 "implementations are buggy and do not provide a way to list out attributes. "
9877 "For these filesystems (notably ntfs-3g) you have to know the names of the "
9878 "extended attributes you want in advance and call this function."
9882 #: ../src/guestfs-actions.pod:2155 ../src/guestfs-actions.pod:3546
9883 #: ../fish/guestfish-actions.pod:1456 ../fish/guestfish-actions.pod:2484
9885 "Extended attribute values are blobs of binary data. If there is no extended "
9886 "attribute named C<name>, this returns an error."
9890 #: ../src/guestfs-actions.pod:2158
9891 msgid "See also: C<guestfs_getxattrs>, C<guestfs_lgetxattr>, L<attr(5)>."
9895 #: ../src/guestfs-actions.pod:2160 ../src/guestfs-actions.pod:2373
9896 #: ../src/guestfs-actions.pod:3551 ../src/guestfs-actions.pod:5284
9897 #: ../src/guestfs-actions.pod:5310 ../src/guestfs-actions.pod:5491
9899 "This function returns a buffer, or NULL on error. The size of the returned "
9900 "buffer is written to C<*size_r>. I<The caller must free the returned buffer "
9905 #: ../src/guestfs-actions.pod:2164 ../src/guestfs-actions.pod:3555
9906 msgid "(Added in 1.7.24)"
9910 #: ../src/guestfs-actions.pod:2166
9911 msgid "guestfs_getxattrs"
9915 #: ../src/guestfs-actions.pod:2168
9918 " struct guestfs_xattr_list *\n"
9919 " guestfs_getxattrs (guestfs_h *g,\n"
9920 " const char *path);\n"
9925 #: ../src/guestfs-actions.pod:2172 ../fish/guestfish-actions.pod:1465
9927 "This call lists the extended attributes of the file or directory C<path>."
9931 #: ../src/guestfs-actions.pod:2175 ../fish/guestfish-actions.pod:1468
9933 "At the system call level, this is a combination of the L<listxattr(2)> and "
9934 "L<getxattr(2)> calls."
9938 #: ../src/guestfs-actions.pod:2178
9939 msgid "See also: C<guestfs_lgetxattrs>, L<attr(5)>."
9943 #: ../src/guestfs-actions.pod:2180 ../src/guestfs-actions.pod:3567
9944 #: ../src/guestfs-actions.pod:4218
9946 "This function returns a C<struct guestfs_xattr_list *>, or NULL if there was "
9947 "an error. I<The caller must call C<guestfs_free_xattr_list> after use>."
9951 #: ../src/guestfs-actions.pod:2184 ../src/guestfs-actions.pod:3571
9952 #: ../src/guestfs-actions.pod:3736 ../src/guestfs-actions.pod:3772
9953 #: ../src/guestfs-actions.pod:5664 ../src/guestfs-actions.pod:6152
9954 #: ../src/guestfs-actions.pod:7522
9955 msgid "(Added in 1.0.59)"
9959 #: ../src/guestfs-actions.pod:2186
9960 msgid "guestfs_glob_expand"
9964 #: ../src/guestfs-actions.pod:2188
9968 " guestfs_glob_expand (guestfs_h *g,\n"
9969 " const char *pattern);\n"
9974 #: ../src/guestfs-actions.pod:2192 ../fish/guestfish-actions.pod:1477
9976 "This command searches for all the pathnames matching C<pattern> according to "
9977 "the wildcard expansion rules used by the shell."
9981 #: ../src/guestfs-actions.pod:2196 ../fish/guestfish-actions.pod:1481
9983 "If no paths match, then this returns an empty list (note: not an error)."
9987 #: ../src/guestfs-actions.pod:2199 ../fish/guestfish-actions.pod:1484
9989 "It is just a wrapper around the C L<glob(3)> function with flags C<GLOB_MARK|"
9990 "GLOB_BRACE>. See that manual page for more details."
9994 #: ../src/guestfs-actions.pod:2207 ../src/guestfs-actions.pod:6345
9995 #: ../src/guestfs-actions.pod:6362
9996 msgid "(Added in 1.0.50)"
10000 #: ../src/guestfs-actions.pod:2209
10001 msgid "guestfs_grep"
10005 #: ../src/guestfs-actions.pod:2211
10009 " guestfs_grep (guestfs_h *g,\n"
10010 " const char *regex,\n"
10011 " const char *path);\n"
10016 #: ../src/guestfs-actions.pod:2216 ../fish/guestfish-actions.pod:1492
10017 msgid "This calls the external C<grep> program and returns the matching lines."
10021 #: ../src/guestfs-actions.pod:2228
10022 msgid "guestfs_grepi"
10026 #: ../src/guestfs-actions.pod:2230
10030 " guestfs_grepi (guestfs_h *g,\n"
10031 " const char *regex,\n"
10032 " const char *path);\n"
10037 #: ../src/guestfs-actions.pod:2235 ../fish/guestfish-actions.pod:1502
10039 "This calls the external C<grep -i> program and returns the matching lines."
10043 #: ../src/guestfs-actions.pod:2247
10044 msgid "guestfs_grub_install"
10048 #: ../src/guestfs-actions.pod:2249
10052 " guestfs_grub_install (guestfs_h *g,\n"
10053 " const char *root,\n"
10054 " const char *device);\n"
10059 #: ../src/guestfs-actions.pod:2254 ../fish/guestfish-actions.pod:1512
10061 "This command installs GRUB 1 (the Grand Unified Bootloader) on C<device>, "
10062 "with the root directory being C<root>."
10066 #: ../src/guestfs-actions.pod:2263 ../fish/guestfish-actions.pod:1521
10068 "There is currently no way in the API to install grub2, which is used by most "
10069 "modern Linux guests. It is possible to run the grub2 command from the "
10070 "guest, although see the caveats in L<guestfs(3)/RUNNING COMMANDS>."
10074 #: ../src/guestfs-actions.pod:2270 ../fish/guestfish-actions.pod:1528
10076 "This uses C<grub-install> from the host. Unfortunately grub is not always "
10077 "compatible with itself, so this only works in rather narrow circumstances. "
10078 "Careful testing with each guest version is advisable."
10082 #: ../src/guestfs-actions.pod:2277 ../fish/guestfish-actions.pod:1535
10084 "If grub-install reports the error \"No suitable drive was found in the "
10085 "generated device map.\" it may be that you need to create a C</boot/grub/"
10086 "device.map> file first that contains the mapping between grub device names "
10087 "and Linux device names. It is usually sufficient to create a file "
10092 #: ../src/guestfs-actions.pod:2284 ../fish/guestfish-actions.pod:1542
10095 " (hd0) /dev/vda\n"
10100 #: ../src/guestfs-actions.pod:2286 ../fish/guestfish-actions.pod:1544
10101 msgid "replacing C</dev/vda> with the name of the installation device."
10105 #: ../src/guestfs-actions.pod:2292
10106 msgid "(Added in 1.0.17)"
10110 #: ../src/guestfs-actions.pod:2294
10111 msgid "guestfs_head"
10115 #: ../src/guestfs-actions.pod:2296
10119 " guestfs_head (guestfs_h *g,\n"
10120 " const char *path);\n"
10125 #: ../src/guestfs-actions.pod:2300 ../fish/guestfish-actions.pod:1552
10127 "This command returns up to the first 10 lines of a file as a list of strings."
10131 #: ../src/guestfs-actions.pod:2312
10132 msgid "guestfs_head_n"
10136 #: ../src/guestfs-actions.pod:2314
10140 " guestfs_head_n (guestfs_h *g,\n"
10142 " const char *path);\n"
10147 #: ../src/guestfs-actions.pod:2319 ../fish/guestfish-actions.pod:1562
10149 "If the parameter C<nrlines> is a positive number, this returns the first "
10150 "C<nrlines> lines of the file C<path>."
10154 #: ../src/guestfs-actions.pod:2322 ../fish/guestfish-actions.pod:1565
10156 "If the parameter C<nrlines> is a negative number, this returns lines from "
10157 "the file C<path>, excluding the last C<nrlines> lines."
10161 #: ../src/guestfs-actions.pod:2325 ../src/guestfs-actions.pod:6642
10162 #: ../fish/guestfish-actions.pod:1568 ../fish/guestfish-actions.pod:4498
10163 msgid "If the parameter C<nrlines> is zero, this returns an empty list."
10167 #: ../src/guestfs-actions.pod:2336
10168 msgid "guestfs_hexdump"
10172 #: ../src/guestfs-actions.pod:2338
10176 " guestfs_hexdump (guestfs_h *g,\n"
10177 " const char *path);\n"
10182 #: ../src/guestfs-actions.pod:2342 ../fish/guestfish-actions.pod:1577
10184 "This runs C<hexdump -C> on the given C<path>. The result is the human-"
10185 "readable, canonical hex dump of the file."
10189 #: ../src/guestfs-actions.pod:2351 ../src/guestfs-actions.pod:6426
10190 #: ../src/guestfs-actions.pod:6481
10191 msgid "(Added in 1.0.22)"
10195 #: ../src/guestfs-actions.pod:2353
10196 msgid "guestfs_initrd_cat"
10200 #: ../src/guestfs-actions.pod:2355
10204 " guestfs_initrd_cat (guestfs_h *g,\n"
10205 " const char *initrdpath,\n"
10206 " const char *filename,\n"
10207 " size_t *size_r);\n"
10212 #: ../src/guestfs-actions.pod:2361 ../fish/guestfish-actions.pod:1587
10214 "This command unpacks the file C<filename> from the initrd file called "
10215 "C<initrdpath>. The filename must be given I<without> the initial C</> "
10220 #: ../src/guestfs-actions.pod:2365 ../fish/guestfish-actions.pod:1591
10222 "For example, in guestfish you could use the following command to examine the "
10223 "boot script (usually called C</init>) contained in a Linux initrd or "
10228 #: ../src/guestfs-actions.pod:2369 ../fish/guestfish-actions.pod:1595
10231 " initrd-cat /boot/initrd-<version>.img init\n"
10236 #: ../src/guestfs-actions.pod:2371
10237 msgid "See also C<guestfs_initrd_list>."
10241 #: ../src/guestfs-actions.pod:2382
10242 msgid "guestfs_initrd_list"
10246 #: ../src/guestfs-actions.pod:2384
10250 " guestfs_initrd_list (guestfs_h *g,\n"
10251 " const char *path);\n"
10256 #: ../src/guestfs-actions.pod:2388 ../fish/guestfish-actions.pod:1606
10257 msgid "This command lists out files contained in an initrd."
10261 #: ../src/guestfs-actions.pod:2390 ../fish/guestfish-actions.pod:1608
10263 "The files are listed without any initial C</> character. The files are "
10264 "listed in the order they appear (not necessarily alphabetical). Directory "
10265 "names are listed as separate items."
10269 #: ../src/guestfs-actions.pod:2394 ../fish/guestfish-actions.pod:1612
10271 "Old Linux kernels (2.4 and earlier) used a compressed ext2 filesystem as "
10272 "initrd. We I<only> support the newer initramfs format (compressed cpio "
10277 #: ../src/guestfs-actions.pod:2404
10278 msgid "guestfs_inotify_add_watch"
10282 #: ../src/guestfs-actions.pod:2406
10286 " guestfs_inotify_add_watch (guestfs_h *g,\n"
10287 " const char *path,\n"
10293 #: ../src/guestfs-actions.pod:2411 ../fish/guestfish-actions.pod:1620
10294 msgid "Watch C<path> for the events listed in C<mask>."
10298 #: ../src/guestfs-actions.pod:2413 ../fish/guestfish-actions.pod:1622
10300 "Note that if C<path> is a directory then events within that directory are "
10301 "watched, but this does I<not> happen recursively (in subdirectories)."
10305 #: ../src/guestfs-actions.pod:2417 ../fish/guestfish-actions.pod:1626
10307 "Note for non-C or non-Linux callers: the inotify events are defined by the "
10308 "Linux kernel ABI and are listed in C</usr/include/sys/inotify.h>."
10312 #: ../src/guestfs-actions.pod:2425
10313 msgid "guestfs_inotify_close"
10317 #: ../src/guestfs-actions.pod:2427
10321 " guestfs_inotify_close (guestfs_h *g);\n"
10326 #: ../src/guestfs-actions.pod:2430 ../fish/guestfish-actions.pod:1634
10328 "This closes the inotify handle which was previously opened by inotify_init. "
10329 "It removes all watches, throws away any pending events, and deallocates all "
10334 #: ../src/guestfs-actions.pod:2438
10335 msgid "guestfs_inotify_files"
10339 #: ../src/guestfs-actions.pod:2440
10343 " guestfs_inotify_files (guestfs_h *g);\n"
10348 #: ../src/guestfs-actions.pod:2443
10350 "This function is a helpful wrapper around C<guestfs_inotify_read> which just "
10351 "returns a list of pathnames of objects that were touched. The returned "
10352 "pathnames are sorted and deduplicated."
10356 #: ../src/guestfs-actions.pod:2453
10357 msgid "guestfs_inotify_init"
10361 #: ../src/guestfs-actions.pod:2455
10365 " guestfs_inotify_init (guestfs_h *g,\n"
10366 " int maxevents);\n"
10371 #: ../src/guestfs-actions.pod:2459 ../fish/guestfish-actions.pod:1650
10373 "This command creates a new inotify handle. The inotify subsystem can be "
10374 "used to notify events which happen to objects in the guest filesystem."
10378 #: ../src/guestfs-actions.pod:2463
10380 "C<maxevents> is the maximum number of events which will be queued up between "
10381 "calls to C<guestfs_inotify_read> or C<guestfs_inotify_files>. If this is "
10382 "passed as C<0>, then the kernel (or previously set) default is used. For "
10383 "Linux 2.6.29 the default was 16384 events. Beyond this limit, the kernel "
10384 "throws away events, but records the fact that it threw them away by setting "
10385 "a flag C<IN_Q_OVERFLOW> in the returned structure list (see "
10386 "C<guestfs_inotify_read>)."
10390 #: ../src/guestfs-actions.pod:2473
10392 "Before any events are generated, you have to add some watches to the "
10393 "internal watch list. See: C<guestfs_inotify_add_watch>, "
10394 "C<guestfs_inotify_rm_watch> and C<guestfs_inotify_watch_all>."
10398 #: ../src/guestfs-actions.pod:2479
10400 "Queued up events should be read periodically by calling "
10401 "C<guestfs_inotify_read> (or C<guestfs_inotify_files> which is just a helpful "
10402 "wrapper around C<guestfs_inotify_read>). If you don't read the events out "
10403 "often enough then you risk the internal queue overflowing."
10407 #: ../src/guestfs-actions.pod:2486
10409 "The handle should be closed after use by calling C<guestfs_inotify_close>. "
10410 "This also removes any watches automatically."
10414 #: ../src/guestfs-actions.pod:2490 ../fish/guestfish-actions.pod:1681
10416 "See also L<inotify(7)> for an overview of the inotify interface as exposed "
10417 "by the Linux kernel, which is roughly what we expose via libguestfs. Note "
10418 "that there is one global inotify handle per libguestfs instance."
10422 #: ../src/guestfs-actions.pod:2499
10423 msgid "guestfs_inotify_read"
10427 #: ../src/guestfs-actions.pod:2501
10430 " struct guestfs_inotify_event_list *\n"
10431 " guestfs_inotify_read (guestfs_h *g);\n"
10436 #: ../src/guestfs-actions.pod:2504 ../fish/guestfish-actions.pod:1690
10438 "Return the complete queue of events that have happened since the previous "
10443 #: ../src/guestfs-actions.pod:2507 ../fish/guestfish-actions.pod:1693
10444 msgid "If no events have happened, this returns an empty list."
10448 #: ../src/guestfs-actions.pod:2509 ../fish/guestfish-actions.pod:1695
10450 "I<Note>: In order to make sure that all events have been read, you must call "
10451 "this function repeatedly until it returns an empty list. The reason is that "
10452 "the call will read events up to the maximum appliance-to-host message size "
10453 "and leave remaining events in the queue."
10457 #: ../src/guestfs-actions.pod:2515
10459 "This function returns a C<struct guestfs_inotify_event_list *>, or NULL if "
10460 "there was an error. I<The caller must call "
10461 "C<guestfs_free_inotify_event_list> after use>."
10465 #: ../src/guestfs-actions.pod:2521
10466 msgid "guestfs_inotify_rm_watch"
10470 #: ../src/guestfs-actions.pod:2523
10474 " guestfs_inotify_rm_watch (guestfs_h *g,\n"
10480 #: ../src/guestfs-actions.pod:2527
10482 "Remove a previously defined inotify watch. See C<guestfs_inotify_add_watch>."
10486 #: ../src/guestfs-actions.pod:2534
10487 msgid "guestfs_inspect_get_arch"
10491 #: ../src/guestfs-actions.pod:2536
10495 " guestfs_inspect_get_arch (guestfs_h *g,\n"
10496 " const char *root);\n"
10501 #: ../src/guestfs-actions.pod:2540 ../src/guestfs-actions.pod:2563
10502 #: ../src/guestfs-actions.pod:2656 ../src/guestfs-actions.pod:2700
10503 #: ../src/guestfs-actions.pod:2726 ../src/guestfs-actions.pod:2765
10504 #: ../src/guestfs-actions.pod:2787 ../src/guestfs-actions.pod:2814
10505 #: ../src/guestfs-actions.pod:2835 ../src/guestfs-actions.pod:2878
10506 #: ../src/guestfs-actions.pod:2907 ../src/guestfs-actions.pod:2938
10507 #: ../src/guestfs-actions.pod:2962 ../src/guestfs-actions.pod:3017
10508 #: ../src/guestfs-actions.pod:3059 ../src/guestfs-actions.pod:3080
10509 #: ../src/guestfs-actions.pod:3103 ../src/guestfs-actions.pod:3120
10510 #: ../src/guestfs-actions.pod:3137 ../src/guestfs-actions.pod:3156
10512 "This function should only be called with a root device string as returned by "
10513 "C<guestfs_inspect_os>."
10517 #: ../src/guestfs-actions.pod:2543
10519 "This returns the architecture of the inspected operating system. The "
10520 "possible return values are listed under C<guestfs_file_architecture>."
10524 #: ../src/guestfs-actions.pod:2547 ../fish/guestfish-actions.pod:1719
10526 "If the architecture could not be determined, then the string C<unknown> is "
10531 #: ../src/guestfs-actions.pod:2550 ../src/guestfs-actions.pod:2643
10532 #: ../src/guestfs-actions.pod:2754 ../src/guestfs-actions.pod:2774
10533 #: ../src/guestfs-actions.pod:2802 ../src/guestfs-actions.pod:2894
10534 #: ../src/guestfs-actions.pod:2925 ../src/guestfs-actions.pod:2949
10535 #: ../src/guestfs-actions.pod:3003 ../src/guestfs-actions.pod:3046
10536 #: ../src/guestfs-actions.pod:3069 ../src/guestfs-actions.pod:3090
10537 #: ../src/guestfs-actions.pod:3110 ../src/guestfs-actions.pod:3127
10538 #: ../src/guestfs-actions.pod:3146 ../src/guestfs-actions.pod:3249
10539 #: ../src/guestfs-actions.pod:3290 ../fish/guestfish-actions.pod:1722
10540 #: ../fish/guestfish-actions.pod:1808 ../fish/guestfish-actions.pod:1896
10541 #: ../fish/guestfish-actions.pod:1911 ../fish/guestfish-actions.pod:1932
10542 #: ../fish/guestfish-actions.pod:2002 ../fish/guestfish-actions.pod:2026
10543 #: ../fish/guestfish-actions.pod:2043 ../fish/guestfish-actions.pod:2086
10544 #: ../fish/guestfish-actions.pod:2121 ../fish/guestfish-actions.pod:2137
10545 #: ../fish/guestfish-actions.pod:2153 ../fish/guestfish-actions.pod:2166
10546 #: ../fish/guestfish-actions.pod:2179 ../fish/guestfish-actions.pod:2194
10547 #: ../fish/guestfish-actions.pod:2293 ../fish/guestfish-actions.pod:2327
10548 msgid "Please read L<guestfs(3)/INSPECTION> for more details."
10552 #: ../src/guestfs-actions.pod:2557
10553 msgid "guestfs_inspect_get_distro"
10557 #: ../src/guestfs-actions.pod:2559
10561 " guestfs_inspect_get_distro (guestfs_h *g,\n"
10562 " const char *root);\n"
10567 #: ../src/guestfs-actions.pod:2566 ../fish/guestfish-actions.pod:1731
10569 "This returns the distro (distribution) of the inspected operating system."
10573 #: ../src/guestfs-actions.pod:2569 ../fish/guestfish-actions.pod:1734
10574 msgid "Currently defined distros are:"
10578 #: ../src/guestfs-actions.pod:2573 ../fish/guestfish-actions.pod:1738
10579 msgid "\"archlinux\""
10580 msgstr "\"archlinux\""
10583 #: ../src/guestfs-actions.pod:2575 ../fish/guestfish-actions.pod:1740
10584 msgid "Arch Linux."
10585 msgstr "Arch Linux."
10588 #: ../src/guestfs-actions.pod:2577 ../fish/guestfish-actions.pod:1742
10590 #| msgid "\"gentoo\""
10592 msgstr "\"gentoo\""
10595 #: ../src/guestfs-actions.pod:2579 ../fish/guestfish-actions.pod:1744
10600 #: ../src/guestfs-actions.pod:2581 ../fish/guestfish-actions.pod:1746
10602 msgstr "\"debian\""
10605 #: ../src/guestfs-actions.pod:2583 ../fish/guestfish-actions.pod:1748
10610 #: ../src/guestfs-actions.pod:2585 ../fish/guestfish-actions.pod:1750
10612 msgstr "\"fedora\""
10615 #: ../src/guestfs-actions.pod:2587 ../fish/guestfish-actions.pod:1752
10620 #: ../src/guestfs-actions.pod:2589 ../fish/guestfish-actions.pod:1754
10622 msgstr "\"gentoo\""
10625 #: ../src/guestfs-actions.pod:2591 ../fish/guestfish-actions.pod:1756
10630 #: ../src/guestfs-actions.pod:2593 ../fish/guestfish-actions.pod:1758
10631 msgid "\"linuxmint\""
10632 msgstr "\"linuxmint\""
10635 #: ../src/guestfs-actions.pod:2595 ../fish/guestfish-actions.pod:1760
10636 msgid "Linux Mint."
10637 msgstr "Linux Mint."
10640 #: ../src/guestfs-actions.pod:2597 ../fish/guestfish-actions.pod:1762
10641 msgid "\"mandriva\""
10642 msgstr "\"mandriva\""
10645 #: ../src/guestfs-actions.pod:2599 ../fish/guestfish-actions.pod:1764
10650 #: ../src/guestfs-actions.pod:2601 ../fish/guestfish-actions.pod:1766
10655 #: ../src/guestfs-actions.pod:2603 ../fish/guestfish-actions.pod:1768
10660 #: ../src/guestfs-actions.pod:2605 ../fish/guestfish-actions.pod:1770
10662 msgstr "\"pardus\""
10665 #: ../src/guestfs-actions.pod:2607 ../fish/guestfish-actions.pod:1772
10670 #: ../src/guestfs-actions.pod:2609 ../fish/guestfish-actions.pod:1774
10671 msgid "\"redhat-based\""
10672 msgstr "\"redhat-based\""
10675 #: ../src/guestfs-actions.pod:2611 ../fish/guestfish-actions.pod:1776
10676 msgid "Some Red Hat-derived distro."
10677 msgstr "Дистрибутив, що походить від Red Hat."
10680 #: ../src/guestfs-actions.pod:2613 ../fish/guestfish-actions.pod:1778
10685 #: ../src/guestfs-actions.pod:2615 ../fish/guestfish-actions.pod:1780
10687 #| msgid "Red Hat Enterprise Linux and some derivatives."
10688 msgid "Red Hat Enterprise Linux."
10689 msgstr "Red Hat Enterprise Linux та деякі з похідних дистрибутивів."
10692 #: ../src/guestfs-actions.pod:2617 ../fish/guestfish-actions.pod:1782
10693 msgid "\"scientificlinux\""
10697 #: ../src/guestfs-actions.pod:2619 ../fish/guestfish-actions.pod:1784
10698 msgid "Scientific Linux."
10702 #: ../src/guestfs-actions.pod:2621 ../fish/guestfish-actions.pod:1786
10703 msgid "\"slackware\""
10707 #: ../src/guestfs-actions.pod:2623 ../fish/guestfish-actions.pod:1788
10712 #: ../src/guestfs-actions.pod:2625 ../fish/guestfish-actions.pod:1790
10714 msgstr "\"ubuntu\""
10717 #: ../src/guestfs-actions.pod:2627 ../fish/guestfish-actions.pod:1792
10722 #: ../src/guestfs-actions.pod:2629 ../src/guestfs-actions.pod:2745
10723 #: ../src/guestfs-actions.pod:3037 ../fish/guestfish-actions.pod:1794
10724 #: ../fish/guestfish-actions.pod:1887 ../fish/guestfish-actions.pod:2112
10725 msgid "\"unknown\""
10726 msgstr "\"unknown\""
10729 #: ../src/guestfs-actions.pod:2631 ../fish/guestfish-actions.pod:1796
10730 msgid "The distro could not be determined."
10731 msgstr "Дистрибутив, тип якого не вдалося визначити."
10734 #: ../src/guestfs-actions.pod:2633 ../src/guestfs-actions.pod:3029
10735 #: ../fish/guestfish-actions.pod:1798 ../fish/guestfish-actions.pod:2104
10736 msgid "\"windows\""
10737 msgstr "\"windows\""
10740 #: ../src/guestfs-actions.pod:2635 ../fish/guestfish-actions.pod:1800
10742 "Windows does not have distributions. This string is returned if the OS type "
10747 #: ../src/guestfs-actions.pod:2640 ../src/guestfs-actions.pod:2751
10748 #: ../src/guestfs-actions.pod:3043 ../fish/guestfish-actions.pod:1805
10749 #: ../fish/guestfish-actions.pod:1893 ../fish/guestfish-actions.pod:2118
10751 "Future versions of libguestfs may return other strings here. The caller "
10752 "should be prepared to handle any string."
10756 #: ../src/guestfs-actions.pod:2650
10757 msgid "guestfs_inspect_get_drive_mappings"
10761 #: ../src/guestfs-actions.pod:2652
10765 " guestfs_inspect_get_drive_mappings (guestfs_h *g,\n"
10766 " const char *root);\n"
10771 #: ../src/guestfs-actions.pod:2659 ../fish/guestfish-actions.pod:1817
10773 "This call is useful for Windows which uses a primitive system of assigning "
10774 "drive letters (like \"C:\") to partitions. This inspection API examines the "
10775 "Windows Registry to find out how disks/partitions are mapped to drive "
10776 "letters, and returns a hash table as in the example below:"
10780 #: ../src/guestfs-actions.pod:2665 ../fish/guestfish-actions.pod:1823
10783 " C => /dev/vda2\n"
10784 " E => /dev/vdb1\n"
10785 " F => /dev/vdc1\n"
10790 #: ../src/guestfs-actions.pod:2669 ../fish/guestfish-actions.pod:1827
10792 "Note that keys are drive letters. For Windows, the key is case insensitive "
10793 "and just contains the drive letter, without the customary colon separator "
10798 #: ../src/guestfs-actions.pod:2673 ../fish/guestfish-actions.pod:1831
10800 "In future we may support other operating systems that also used drive "
10801 "letters, but the keys for those might not be case insensitive and might be "
10802 "longer than 1 character. For example in OS-9, hard drives were named C<h0>, "
10807 #: ../src/guestfs-actions.pod:2678 ../fish/guestfish-actions.pod:1836
10809 "For Windows guests, currently only hard drive mappings are returned. "
10810 "Removable disks (eg. DVD-ROMs) are ignored."
10814 #: ../src/guestfs-actions.pod:2681 ../fish/guestfish-actions.pod:1839
10816 "For guests that do not use drive mappings, or if the drive mappings could "
10817 "not be determined, this returns an empty hash table."
10821 #: ../src/guestfs-actions.pod:2684
10823 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
10824 "C<guestfs_inspect_get_mountpoints>, C<guestfs_inspect_get_filesystems>."
10828 #: ../src/guestfs-actions.pod:2688 ../src/guestfs-actions.pod:2864
10829 #: ../src/guestfs-actions.pod:3624 ../src/guestfs-actions.pod:4841
10830 #: ../src/guestfs-actions.pod:6783
10832 "This function returns a NULL-terminated array of strings, or NULL if there "
10833 "was an error. The array of strings will always have length C<2n+1>, where "
10834 "C<n> keys and values alternate, followed by the trailing NULL entry. I<The "
10835 "caller must free the strings and the array after use>."
10839 #: ../src/guestfs-actions.pod:2694
10840 msgid "guestfs_inspect_get_filesystems"
10844 #: ../src/guestfs-actions.pod:2696
10848 " guestfs_inspect_get_filesystems (guestfs_h *g,\n"
10849 " const char *root);\n"
10854 #: ../src/guestfs-actions.pod:2703 ../fish/guestfish-actions.pod:1853
10856 "This returns a list of all the filesystems that we think are associated with "
10857 "this operating system. This includes the root filesystem, other ordinary "
10858 "filesystems, and non-mounted devices like swap partitions."
10862 #: ../src/guestfs-actions.pod:2708 ../fish/guestfish-actions.pod:1858
10864 "In the case of a multi-boot virtual machine, it is possible for a filesystem "
10865 "to be shared between operating systems."
10869 #: ../src/guestfs-actions.pod:2711
10871 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
10872 "C<guestfs_inspect_get_mountpoints>."
10876 #: ../src/guestfs-actions.pod:2720
10877 msgid "guestfs_inspect_get_format"
10881 #: ../src/guestfs-actions.pod:2722
10885 " guestfs_inspect_get_format (guestfs_h *g,\n"
10886 " const char *root);\n"
10891 #: ../src/guestfs-actions.pod:2729 ../fish/guestfish-actions.pod:1871
10893 "This returns the format of the inspected operating system. You can use it "
10894 "to detect install images, live CDs and similar."
10898 #: ../src/guestfs-actions.pod:2732 ../fish/guestfish-actions.pod:1874
10899 msgid "Currently defined formats are:"
10903 #: ../src/guestfs-actions.pod:2736 ../fish/guestfish-actions.pod:1878
10904 msgid "\"installed\""
10905 msgstr "\"installed\""
10908 #: ../src/guestfs-actions.pod:2738 ../fish/guestfish-actions.pod:1880
10909 msgid "This is an installed operating system."
10910 msgstr "Це встановлена операційна система."
10913 #: ../src/guestfs-actions.pod:2740 ../fish/guestfish-actions.pod:1882
10914 msgid "\"installer\""
10918 #: ../src/guestfs-actions.pod:2742 ../fish/guestfish-actions.pod:1884
10920 "The disk image being inspected is not an installed operating system, but a "
10921 "I<bootable> install disk, live CD, or similar."
10925 #: ../src/guestfs-actions.pod:2747 ../fish/guestfish-actions.pod:1889
10926 msgid "The format of this disk image is not known."
10930 #: ../src/guestfs-actions.pod:2759
10931 msgid "guestfs_inspect_get_hostname"
10935 #: ../src/guestfs-actions.pod:2761
10939 " guestfs_inspect_get_hostname (guestfs_h *g,\n"
10940 " const char *root);\n"
10945 #: ../src/guestfs-actions.pod:2768 ../fish/guestfish-actions.pod:1905
10947 "This function returns the hostname of the operating system as found by "
10948 "inspection of the guest's configuration files."
10952 #: ../src/guestfs-actions.pod:2771 ../fish/guestfish-actions.pod:1908
10954 "If the hostname could not be determined, then the string C<unknown> is "
10959 #: ../src/guestfs-actions.pod:2779
10960 msgid "(Added in 1.7.9)"
10964 #: ../src/guestfs-actions.pod:2781
10965 msgid "guestfs_inspect_get_major_version"
10969 #: ../src/guestfs-actions.pod:2783
10973 " guestfs_inspect_get_major_version (guestfs_h *g,\n"
10974 " const char *root);\n"
10979 #: ../src/guestfs-actions.pod:2790 ../fish/guestfish-actions.pod:1920
10981 "This returns the major version number of the inspected operating system."
10985 #: ../src/guestfs-actions.pod:2793 ../fish/guestfish-actions.pod:1923
10987 "Windows uses a consistent versioning scheme which is I<not> reflected in the "
10988 "popular public names used by the operating system. Notably the operating "
10989 "system known as \"Windows 7\" is really version 6.1 (ie. major = 6, minor = "
10990 "1). You can find out the real versions corresponding to releases of Windows "
10991 "by consulting Wikipedia or MSDN."
10995 #: ../src/guestfs-actions.pod:2800 ../src/guestfs-actions.pod:2820
10996 #: ../fish/guestfish-actions.pod:1930 ../fish/guestfish-actions.pod:1944
10997 msgid "If the version could not be determined, then C<0> is returned."
11001 #: ../src/guestfs-actions.pod:2808
11002 msgid "guestfs_inspect_get_minor_version"
11006 #: ../src/guestfs-actions.pod:2810
11010 " guestfs_inspect_get_minor_version (guestfs_h *g,\n"
11011 " const char *root);\n"
11016 #: ../src/guestfs-actions.pod:2817 ../fish/guestfish-actions.pod:1941
11018 "This returns the minor version number of the inspected operating system."
11022 #: ../src/guestfs-actions.pod:2822
11024 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
11025 "C<guestfs_inspect_get_major_version>."
11029 #: ../src/guestfs-actions.pod:2829
11030 msgid "guestfs_inspect_get_mountpoints"
11034 #: ../src/guestfs-actions.pod:2831
11038 " guestfs_inspect_get_mountpoints (guestfs_h *g,\n"
11039 " const char *root);\n"
11044 #: ../src/guestfs-actions.pod:2838 ../fish/guestfish-actions.pod:1956
11046 "This returns a hash of where we think the filesystems associated with this "
11047 "operating system should be mounted. Callers should note that this is at "
11048 "best an educated guess made by reading configuration files such as C</etc/"
11049 "fstab>. I<In particular note> that this may return filesystems which are "
11050 "non-existent or not mountable and callers should be prepared to handle or "
11051 "ignore failures if they try to mount them."
11055 #: ../src/guestfs-actions.pod:2847 ../fish/guestfish-actions.pod:1965
11057 "Each element in the returned hashtable has a key which is the path of the "
11058 "mountpoint (eg. C</boot>) and a value which is the filesystem that would be "
11059 "mounted there (eg. C</dev/sda1>)."
11063 #: ../src/guestfs-actions.pod:2852 ../fish/guestfish-actions.pod:1970
11065 "Non-mounted devices such as swap devices are I<not> returned in this list."
11069 #: ../src/guestfs-actions.pod:2855
11071 "For operating systems like Windows which still use drive letters, this call "
11072 "will only return an entry for the first drive \"mounted on\" C</>. For "
11073 "information about the mapping of drive letters to partitions, see "
11074 "C<guestfs_inspect_get_drive_mappings>."
11078 #: ../src/guestfs-actions.pod:2861
11080 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
11081 "C<guestfs_inspect_get_filesystems>."
11085 #: ../src/guestfs-actions.pod:2872
11086 msgid "guestfs_inspect_get_package_format"
11090 #: ../src/guestfs-actions.pod:2874
11094 " guestfs_inspect_get_package_format (guestfs_h *g,\n"
11095 " const char *root);\n"
11100 #: ../src/guestfs-actions.pod:2881
11102 "This function and C<guestfs_inspect_get_package_management> return the "
11103 "package format and package management tool used by the inspected operating "
11104 "system. For example for Fedora these functions would return C<rpm> (package "
11105 "format) and C<yum> (package management)."
11109 #: ../src/guestfs-actions.pod:2887 ../fish/guestfish-actions.pod:1995
11111 "This returns the string C<unknown> if we could not determine the package "
11112 "format I<or> if the operating system does not have a real packaging system "
11117 #: ../src/guestfs-actions.pod:2891 ../fish/guestfish-actions.pod:1999
11119 "Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>. "
11120 "Future versions of libguestfs may return other strings."
11124 #: ../src/guestfs-actions.pod:2899 ../src/guestfs-actions.pod:2930
11125 msgid "(Added in 1.7.5)"
11129 #: ../src/guestfs-actions.pod:2901
11130 msgid "guestfs_inspect_get_package_management"
11134 #: ../src/guestfs-actions.pod:2903
11138 " guestfs_inspect_get_package_management (guestfs_h *g,\n"
11139 " const char *root);\n"
11144 #: ../src/guestfs-actions.pod:2910
11146 "C<guestfs_inspect_get_package_format> and this function return the package "
11147 "format and package management tool used by the inspected operating system. "
11148 "For example for Fedora these functions would return C<rpm> (package format) "
11149 "and C<yum> (package management)."
11153 #: ../src/guestfs-actions.pod:2916 ../fish/guestfish-actions.pod:2017
11155 "This returns the string C<unknown> if we could not determine the package "
11156 "management tool I<or> if the operating system does not have a real packaging "
11157 "system (eg. Windows)."
11161 #: ../src/guestfs-actions.pod:2920 ../fish/guestfish-actions.pod:2021
11163 "Possible strings include: C<yum>, C<up2date>, C<apt> (for all Debian "
11164 "derivatives), C<portage>, C<pisi>, C<pacman>, C<urpmi>. Future versions of "
11165 "libguestfs may return other strings."
11169 #: ../src/guestfs-actions.pod:2932
11170 msgid "guestfs_inspect_get_product_name"
11174 #: ../src/guestfs-actions.pod:2934
11178 " guestfs_inspect_get_product_name (guestfs_h *g,\n"
11179 " const char *root);\n"
11184 #: ../src/guestfs-actions.pod:2941 ../fish/guestfish-actions.pod:2035
11186 "This returns the product name of the inspected operating system. The "
11187 "product name is generally some freeform string which can be displayed to the "
11188 "user, but should not be parsed by programs."
11192 #: ../src/guestfs-actions.pod:2946 ../fish/guestfish-actions.pod:2040
11194 "If the product name could not be determined, then the string C<unknown> is "
11199 #: ../src/guestfs-actions.pod:2956
11200 msgid "guestfs_inspect_get_product_variant"
11204 #: ../src/guestfs-actions.pod:2958
11208 " guestfs_inspect_get_product_variant (guestfs_h *g,\n"
11209 " const char *root);\n"
11214 #: ../src/guestfs-actions.pod:2965 ../fish/guestfish-actions.pod:2052
11216 #| msgid "This is an installed operating system."
11217 msgid "This returns the product variant of the inspected operating system."
11218 msgstr "Це встановлена операційна система."
11221 #: ../src/guestfs-actions.pod:2968 ../fish/guestfish-actions.pod:2055
11223 "For Windows guests, this returns the contents of the Registry key C<HKLM"
11224 "\\Software\\Microsoft\\Windows NT\\CurrentVersion> C<InstallationType> which "
11225 "is usually a string such as C<Client> or C<Server> (other values are "
11226 "possible). This can be used to distinguish consumer and enterprise versions "
11227 "of Windows that have the same version number (for example, Windows 7 and "
11228 "Windows 2008 Server are both version 6.1, but the former is C<Client> and "
11229 "the latter is C<Server>)."
11233 #: ../src/guestfs-actions.pod:2977 ../fish/guestfish-actions.pod:2064
11235 "For enterprise Linux guests, in future we intend this to return the product "
11236 "variant such as C<Desktop>, C<Server> and so on. But this is not "
11237 "implemented at present."
11241 #: ../src/guestfs-actions.pod:2981 ../fish/guestfish-actions.pod:2068
11243 "If the product variant could not be determined, then the string C<unknown> "
11248 #: ../src/guestfs-actions.pod:2984
11250 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
11251 "C<guestfs_inspect_get_product_name>, C<guestfs_inspect_get_major_version>."
11255 #: ../src/guestfs-actions.pod:2991
11256 msgid "guestfs_inspect_get_roots"
11260 #: ../src/guestfs-actions.pod:2993
11264 " guestfs_inspect_get_roots (guestfs_h *g);\n"
11269 #: ../src/guestfs-actions.pod:2996
11271 "This function is a convenient way to get the list of root devices, as "
11272 "returned from a previous call to C<guestfs_inspect_os>, but without redoing "
11273 "the whole inspection process."
11277 #: ../src/guestfs-actions.pod:3000
11279 "This returns an empty list if either no root devices were found or the "
11280 "caller has not called C<guestfs_inspect_os>."
11284 #: ../src/guestfs-actions.pod:3009
11285 msgid "(Added in 1.7.3)"
11289 #: ../src/guestfs-actions.pod:3011
11290 msgid "guestfs_inspect_get_type"
11294 #: ../src/guestfs-actions.pod:3013
11298 " guestfs_inspect_get_type (guestfs_h *g,\n"
11299 " const char *root);\n"
11304 #: ../src/guestfs-actions.pod:3020 ../fish/guestfish-actions.pod:2095
11306 "This returns the type of the inspected operating system. Currently defined "
11311 #: ../src/guestfs-actions.pod:3025 ../fish/guestfish-actions.pod:2100
11316 #: ../src/guestfs-actions.pod:3027 ../fish/guestfish-actions.pod:2102
11317 msgid "Any Linux-based operating system."
11321 #: ../src/guestfs-actions.pod:3031 ../fish/guestfish-actions.pod:2106
11322 msgid "Any Microsoft Windows operating system."
11326 #: ../src/guestfs-actions.pod:3033 ../fish/guestfish-actions.pod:2108
11327 msgid "\"freebsd\""
11328 msgstr "\"freebsd\""
11331 #: ../src/guestfs-actions.pod:3035 ../fish/guestfish-actions.pod:2110
11336 #: ../src/guestfs-actions.pod:3039 ../fish/guestfish-actions.pod:2114
11337 msgid "The operating system type could not be determined."
11341 #: ../src/guestfs-actions.pod:3053
11342 msgid "guestfs_inspect_get_windows_current_control_set"
11346 #: ../src/guestfs-actions.pod:3055
11350 " guestfs_inspect_get_windows_current_control_set (guestfs_h *g,\n"
11351 " const char *root);\n"
11356 #: ../src/guestfs-actions.pod:3062 ../fish/guestfish-actions.pod:2130
11358 "This returns the Windows CurrentControlSet of the inspected guest. The "
11359 "CurrentControlSet is a registry key name such as C<ControlSet001>."
11363 #: ../src/guestfs-actions.pod:3065 ../fish/guestfish-actions.pod:2133
11365 "This call assumes that the guest is Windows and that the Registry could be "
11366 "examined by inspection. If this is not the case then an error is returned."
11370 #: ../src/guestfs-actions.pod:3074
11371 msgid "guestfs_inspect_get_windows_systemroot"
11375 #: ../src/guestfs-actions.pod:3076
11379 " guestfs_inspect_get_windows_systemroot (guestfs_h *g,\n"
11380 " const char *root);\n"
11385 #: ../src/guestfs-actions.pod:3083 ../fish/guestfish-actions.pod:2146
11387 "This returns the Windows systemroot of the inspected guest. The systemroot "
11388 "is a directory path such as C</WINDOWS>."
11392 #: ../src/guestfs-actions.pod:3086 ../fish/guestfish-actions.pod:2149
11394 "This call assumes that the guest is Windows and that the systemroot could be "
11395 "determined by inspection. If this is not the case then an error is returned."
11399 #: ../src/guestfs-actions.pod:3095
11400 msgid "(Added in 1.5.25)"
11404 #: ../src/guestfs-actions.pod:3097
11405 msgid "guestfs_inspect_is_live"
11409 #: ../src/guestfs-actions.pod:3099
11413 " guestfs_inspect_is_live (guestfs_h *g,\n"
11414 " const char *root);\n"
11419 #: ../src/guestfs-actions.pod:3106
11421 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
11422 "disk), then this returns true if a live image was detected on the disk."
11426 #: ../src/guestfs-actions.pod:3114
11427 msgid "guestfs_inspect_is_multipart"
11431 #: ../src/guestfs-actions.pod:3116
11435 " guestfs_inspect_is_multipart (guestfs_h *g,\n"
11436 " const char *root);\n"
11441 #: ../src/guestfs-actions.pod:3123
11443 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
11444 "disk), then this returns true if the disk is part of a set."
11448 #: ../src/guestfs-actions.pod:3131
11449 msgid "guestfs_inspect_is_netinst"
11453 #: ../src/guestfs-actions.pod:3133
11457 " guestfs_inspect_is_netinst (guestfs_h *g,\n"
11458 " const char *root);\n"
11463 #: ../src/guestfs-actions.pod:3140
11465 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
11466 "disk), then this returns true if the disk is a network installer, ie. not a "
11467 "self-contained install CD but one which is likely to require network access "
11468 "to complete the install."
11472 #: ../src/guestfs-actions.pod:3150
11473 msgid "guestfs_inspect_list_applications"
11477 #: ../src/guestfs-actions.pod:3152
11480 " struct guestfs_application_list *\n"
11481 " guestfs_inspect_list_applications (guestfs_h *g,\n"
11482 " const char *root);\n"
11487 #: ../src/guestfs-actions.pod:3159 ../fish/guestfish-actions.pod:2203
11488 msgid "Return the list of applications installed in the operating system."
11492 #: ../src/guestfs-actions.pod:3161
11494 "I<Note:> This call works differently from other parts of the inspection "
11495 "API. You have to call C<guestfs_inspect_os>, then "
11496 "C<guestfs_inspect_get_mountpoints>, then mount up the disks, before calling "
11497 "this. Listing applications is a significantly more difficult operation "
11498 "which requires access to the full filesystem. Also note that unlike the "
11499 "other C<guestfs_inspect_get_*> calls which are just returning data cached in "
11500 "the libguestfs handle, this call actually reads parts of the mounted "
11501 "filesystems during the call."
11505 #: ../src/guestfs-actions.pod:3171 ../fish/guestfish-actions.pod:2215
11507 "This returns an empty list if the inspection code was not able to determine "
11508 "the list of applications."
11512 #: ../src/guestfs-actions.pod:3174 ../fish/guestfish-actions.pod:2218
11513 msgid "The application structure contains the following fields:"
11517 #: ../src/guestfs-actions.pod:3178 ../fish/guestfish-actions.pod:2222
11518 msgid "C<app_name>"
11519 msgstr "C<app_name>"
11522 #: ../src/guestfs-actions.pod:3180 ../fish/guestfish-actions.pod:2224
11524 "The name of the application. For Red Hat-derived and Debian-derived Linux "
11525 "guests, this is the package name."
11529 #: ../src/guestfs-actions.pod:3183 ../fish/guestfish-actions.pod:2227
11530 msgid "C<app_display_name>"
11531 msgstr "C<app_display_name>"
11534 #: ../src/guestfs-actions.pod:3185 ../fish/guestfish-actions.pod:2229
11536 "The display name of the application, sometimes localized to the install "
11537 "language of the guest operating system."
11541 #: ../src/guestfs-actions.pod:3188 ../fish/guestfish-actions.pod:2232
11543 "If unavailable this is returned as an empty string C<\"\">. Callers needing "
11544 "to display something can use C<app_name> instead."
11548 #: ../src/guestfs-actions.pod:3191 ../fish/guestfish-actions.pod:2235
11549 msgid "C<app_epoch>"
11550 msgstr "C<app_epoch>"
11553 #: ../src/guestfs-actions.pod:3193 ../fish/guestfish-actions.pod:2237
11555 "For package managers which use epochs, this contains the epoch of the "
11556 "package (an integer). If unavailable, this is returned as C<0>."
11560 #: ../src/guestfs-actions.pod:3196 ../fish/guestfish-actions.pod:2240
11561 msgid "C<app_version>"
11562 msgstr "C<app_version>"
11565 #: ../src/guestfs-actions.pod:3198 ../fish/guestfish-actions.pod:2242
11567 "The version string of the application or package. If unavailable this is "
11568 "returned as an empty string C<\"\">."
11572 #: ../src/guestfs-actions.pod:3201 ../fish/guestfish-actions.pod:2245
11573 msgid "C<app_release>"
11574 msgstr "C<app_release>"
11577 #: ../src/guestfs-actions.pod:3203 ../fish/guestfish-actions.pod:2247
11579 "The release string of the application or package, for package managers that "
11580 "use this. If unavailable this is returned as an empty string C<\"\">."
11584 #: ../src/guestfs-actions.pod:3207 ../fish/guestfish-actions.pod:2251
11585 msgid "C<app_install_path>"
11586 msgstr "C<app_install_path>"
11589 #: ../src/guestfs-actions.pod:3209 ../fish/guestfish-actions.pod:2253
11591 "The installation path of the application (on operating systems such as "
11592 "Windows which use installation paths). This path is in the format used by "
11593 "the guest operating system, it is not a libguestfs path."
11597 #: ../src/guestfs-actions.pod:3214 ../fish/guestfish-actions.pod:2258
11598 msgid "If unavailable this is returned as an empty string C<\"\">."
11602 #: ../src/guestfs-actions.pod:3216 ../fish/guestfish-actions.pod:2260
11603 msgid "C<app_trans_path>"
11604 msgstr "C<app_trans_path>"
11607 #: ../src/guestfs-actions.pod:3218 ../fish/guestfish-actions.pod:2262
11609 "The install path translated into a libguestfs path. If unavailable this is "
11610 "returned as an empty string C<\"\">."
11614 #: ../src/guestfs-actions.pod:3221 ../fish/guestfish-actions.pod:2265
11615 msgid "C<app_publisher>"
11616 msgstr "C<app_publisher>"
11619 #: ../src/guestfs-actions.pod:3223 ../fish/guestfish-actions.pod:2267
11621 "The name of the publisher of the application, for package managers that use "
11622 "this. If unavailable this is returned as an empty string C<\"\">."
11626 #: ../src/guestfs-actions.pod:3227 ../fish/guestfish-actions.pod:2271
11628 msgstr "C<app_url>"
11631 #: ../src/guestfs-actions.pod:3229 ../fish/guestfish-actions.pod:2273
11633 "The URL (eg. upstream URL) of the application. If unavailable this is "
11634 "returned as an empty string C<\"\">."
11638 #: ../src/guestfs-actions.pod:3232 ../fish/guestfish-actions.pod:2276
11639 msgid "C<app_source_package>"
11643 #: ../src/guestfs-actions.pod:3234 ../fish/guestfish-actions.pod:2278
11645 "For packaging systems which support this, the name of the source package. "
11646 "If unavailable this is returned as an empty string C<\"\">."
11650 #: ../src/guestfs-actions.pod:3237 ../fish/guestfish-actions.pod:2281
11651 msgid "C<app_summary>"
11655 #: ../src/guestfs-actions.pod:3239 ../fish/guestfish-actions.pod:2283
11657 "A short (usually one line) description of the application or package. If "
11658 "unavailable this is returned as an empty string C<\"\">."
11662 #: ../src/guestfs-actions.pod:3242 ../fish/guestfish-actions.pod:2286
11663 msgid "C<app_description>"
11667 #: ../src/guestfs-actions.pod:3244 ../fish/guestfish-actions.pod:2288
11669 "A longer description of the application or package. If unavailable this is "
11670 "returned as an empty string C<\"\">."
11674 #: ../src/guestfs-actions.pod:3251
11676 "This function returns a C<struct guestfs_application_list *>, or NULL if "
11677 "there was an error. I<The caller must call C<guestfs_free_application_list> "
11682 #: ../src/guestfs-actions.pod:3255
11683 msgid "(Added in 1.7.8)"
11687 #: ../src/guestfs-actions.pod:3257
11688 msgid "guestfs_inspect_os"
11692 #: ../src/guestfs-actions.pod:3259
11696 " guestfs_inspect_os (guestfs_h *g);\n"
11701 #: ../src/guestfs-actions.pod:3262 ../fish/guestfish-actions.pod:2299
11703 "This function uses other libguestfs functions and certain heuristics to "
11704 "inspect the disk(s) (usually disks belonging to a virtual machine), looking "
11705 "for operating systems."
11709 #: ../src/guestfs-actions.pod:3266 ../fish/guestfish-actions.pod:2303
11710 msgid "The list returned is empty if no operating systems were found."
11714 #: ../src/guestfs-actions.pod:3268 ../fish/guestfish-actions.pod:2305
11716 "If one operating system was found, then this returns a list with a single "
11717 "element, which is the name of the root filesystem of this operating system. "
11718 "It is also possible for this function to return a list containing more than "
11719 "one element, indicating a dual-boot or multi-boot virtual machine, with each "
11720 "element being the root filesystem of one of the operating systems."
11724 #: ../src/guestfs-actions.pod:3275
11726 "You can pass the root string(s) returned to other C<guestfs_inspect_get_*> "
11727 "functions in order to query further information about each operating system, "
11728 "such as the name and version."
11732 #: ../src/guestfs-actions.pod:3280
11734 "This function uses other libguestfs features such as C<guestfs_mount_ro> and "
11735 "C<guestfs_umount_all> in order to mount and unmount filesystems and look at "
11736 "the contents. This should be called with no disks currently mounted. The "
11737 "function may also use Augeas, so any existing Augeas handle will be closed."
11741 #: ../src/guestfs-actions.pod:3286 ../fish/guestfish-actions.pod:2323
11743 "This function cannot decrypt encrypted disks. The caller must do that first "
11744 "(supplying the necessary keys) if the disk is encrypted."
11748 #: ../src/guestfs-actions.pod:3292 ../src/guestfs-actions.pod:3582
11749 #: ../src/guestfs-actions.pod:3644
11750 msgid "See also C<guestfs_list_filesystems>."
11754 #: ../src/guestfs-actions.pod:3300
11755 msgid "guestfs_is_blockdev"
11759 #: ../src/guestfs-actions.pod:3302
11763 " guestfs_is_blockdev (guestfs_h *g,\n"
11764 " const char *path);\n"
11769 #: ../src/guestfs-actions.pod:3306 ../fish/guestfish-actions.pod:2335
11771 "This returns C<true> if and only if there is a block device with the given "
11776 #: ../src/guestfs-actions.pod:3309 ../src/guestfs-actions.pod:3338
11777 #: ../src/guestfs-actions.pod:3368 ../src/guestfs-actions.pod:3383
11778 #: ../src/guestfs-actions.pod:3399 ../src/guestfs-actions.pod:3455
11779 #: ../src/guestfs-actions.pod:3470
11780 msgid "See also C<guestfs_stat>."
11784 #: ../src/guestfs-actions.pod:3313 ../src/guestfs-actions.pod:3342
11785 #: ../src/guestfs-actions.pod:3387 ../src/guestfs-actions.pod:3459
11786 #: ../src/guestfs-actions.pod:3474
11787 msgid "(Added in 1.5.10)"
11791 #: ../src/guestfs-actions.pod:3315
11792 msgid "guestfs_is_busy"
11796 #: ../src/guestfs-actions.pod:3317
11800 " guestfs_is_busy (guestfs_h *g);\n"
11805 #: ../src/guestfs-actions.pod:3320 ../fish/guestfish-actions.pod:2344
11807 "This returns true iff this handle is busy processing a command (in the "
11812 #: ../src/guestfs-actions.pod:3329
11813 msgid "guestfs_is_chardev"
11817 #: ../src/guestfs-actions.pod:3331
11821 " guestfs_is_chardev (guestfs_h *g,\n"
11822 " const char *path);\n"
11827 #: ../src/guestfs-actions.pod:3335 ../fish/guestfish-actions.pod:2353
11829 "This returns C<true> if and only if there is a character device with the "
11830 "given C<path> name."
11834 #: ../src/guestfs-actions.pod:3344
11835 msgid "guestfs_is_config"
11839 #: ../src/guestfs-actions.pod:3346
11843 " guestfs_is_config (guestfs_h *g);\n"
11848 #: ../src/guestfs-actions.pod:3349 ../fish/guestfish-actions.pod:2362
11850 "This returns true iff this handle is being configured (in the C<CONFIG> "
11855 #: ../src/guestfs-actions.pod:3358
11856 msgid "guestfs_is_dir"
11860 #: ../src/guestfs-actions.pod:3360
11864 " guestfs_is_dir (guestfs_h *g,\n"
11865 " const char *path);\n"
11870 #: ../src/guestfs-actions.pod:3364 ../fish/guestfish-actions.pod:2371
11872 "This returns C<true> if and only if there is a directory with the given "
11873 "C<path> name. Note that it returns false for other objects like files."
11877 #: ../src/guestfs-actions.pod:3374
11878 msgid "guestfs_is_fifo"
11882 #: ../src/guestfs-actions.pod:3376
11886 " guestfs_is_fifo (guestfs_h *g,\n"
11887 " const char *path);\n"
11892 #: ../src/guestfs-actions.pod:3380 ../fish/guestfish-actions.pod:2381
11894 "This returns C<true> if and only if there is a FIFO (named pipe) with the "
11895 "given C<path> name."
11899 #: ../src/guestfs-actions.pod:3389
11900 msgid "guestfs_is_file"
11904 #: ../src/guestfs-actions.pod:3391
11908 " guestfs_is_file (guestfs_h *g,\n"
11909 " const char *path);\n"
11914 #: ../src/guestfs-actions.pod:3395 ../fish/guestfish-actions.pod:2390
11916 "This returns C<true> if and only if there is a regular file with the given "
11917 "C<path> name. Note that it returns false for other objects like directories."
11921 #: ../src/guestfs-actions.pod:3405
11922 msgid "guestfs_is_launching"
11926 #: ../src/guestfs-actions.pod:3407
11930 " guestfs_is_launching (guestfs_h *g);\n"
11935 #: ../src/guestfs-actions.pod:3410 ../fish/guestfish-actions.pod:2400
11937 "This returns true iff this handle is launching the subprocess (in the "
11938 "C<LAUNCHING> state)."
11942 #: ../src/guestfs-actions.pod:3419
11943 msgid "guestfs_is_lv"
11947 #: ../src/guestfs-actions.pod:3421
11951 " guestfs_is_lv (guestfs_h *g,\n"
11952 " const char *device);\n"
11957 #: ../src/guestfs-actions.pod:3425 ../fish/guestfish-actions.pod:2409
11959 "This command tests whether C<device> is a logical volume, and returns true "
11960 "iff this is the case."
11964 #: ../src/guestfs-actions.pod:3432
11965 msgid "guestfs_is_ready"
11969 #: ../src/guestfs-actions.pod:3434
11973 " guestfs_is_ready (guestfs_h *g);\n"
11978 #: ../src/guestfs-actions.pod:3437 ../fish/guestfish-actions.pod:2416
11980 "This returns true iff this handle is ready to accept commands (in the "
11985 #: ../src/guestfs-actions.pod:3446
11986 msgid "guestfs_is_socket"
11990 #: ../src/guestfs-actions.pod:3448
11994 " guestfs_is_socket (guestfs_h *g,\n"
11995 " const char *path);\n"
12000 #: ../src/guestfs-actions.pod:3452 ../fish/guestfish-actions.pod:2425
12002 "This returns C<true> if and only if there is a Unix domain socket with the "
12003 "given C<path> name."
12007 #: ../src/guestfs-actions.pod:3461
12008 msgid "guestfs_is_symlink"
12012 #: ../src/guestfs-actions.pod:3463
12016 " guestfs_is_symlink (guestfs_h *g,\n"
12017 " const char *path);\n"
12022 #: ../src/guestfs-actions.pod:3467 ../fish/guestfish-actions.pod:2434
12024 "This returns C<true> if and only if there is a symbolic link with the given "
12029 #: ../src/guestfs-actions.pod:3476
12030 msgid "guestfs_kill_subprocess"
12034 #: ../src/guestfs-actions.pod:3478
12038 " guestfs_kill_subprocess (guestfs_h *g);\n"
12043 #: ../src/guestfs-actions.pod:3481 ../fish/guestfish-actions.pod:2443
12044 msgid "This kills the qemu subprocess. You should never need to call this."
12048 #: ../src/guestfs-actions.pod:3487
12049 msgid "guestfs_launch"
12053 #: ../src/guestfs-actions.pod:3489
12057 " guestfs_launch (guestfs_h *g);\n"
12062 #: ../src/guestfs-actions.pod:3492 ../fish/guestfish-actions.pod:2451
12064 "Internally libguestfs is implemented by running a virtual machine using "
12069 #: ../src/guestfs-actions.pod:3495 ../fish/guestfish-actions.pod:2454
12071 "You should call this after configuring the handle (eg. adding drives) but "
12072 "before performing any actions."
12076 #: ../src/guestfs-actions.pod:3507
12077 msgid "guestfs_lchown"
12081 #: ../src/guestfs-actions.pod:3509
12085 " guestfs_lchown (guestfs_h *g,\n"
12088 " const char *path);\n"
12093 #: ../src/guestfs-actions.pod:3515
12095 "Change the file owner to C<owner> and group to C<group>. This is like "
12096 "C<guestfs_chown> but if C<path> is a symlink then the link itself is "
12097 "changed, not the target."
12101 #: ../src/guestfs-actions.pod:3527
12102 msgid "guestfs_lgetxattr"
12106 #: ../src/guestfs-actions.pod:3529
12110 " guestfs_lgetxattr (guestfs_h *g,\n"
12111 " const char *path,\n"
12112 " const char *name,\n"
12113 " size_t *size_r);\n"
12118 #: ../src/guestfs-actions.pod:3535 ../fish/guestfish-actions.pod:2473
12120 "Get a single extended attribute from file C<path> named C<name>. If C<path> "
12121 "is a symlink, then this call returns an extended attribute from the symlink."
12125 #: ../src/guestfs-actions.pod:3549
12126 msgid "See also: C<guestfs_lgetxattrs>, C<guestfs_getxattr>, L<attr(5)>."
12130 #: ../src/guestfs-actions.pod:3557
12131 msgid "guestfs_lgetxattrs"
12135 #: ../src/guestfs-actions.pod:3559
12138 " struct guestfs_xattr_list *\n"
12139 " guestfs_lgetxattrs (guestfs_h *g,\n"
12140 " const char *path);\n"
12145 #: ../src/guestfs-actions.pod:3563
12147 "This is the same as C<guestfs_getxattrs>, but if C<path> is a symbolic link, "
12148 "then it returns the extended attributes of the link itself."
12152 #: ../src/guestfs-actions.pod:3573
12153 msgid "guestfs_list_devices"
12157 #: ../src/guestfs-actions.pod:3575
12161 " guestfs_list_devices (guestfs_h *g);\n"
12166 #: ../src/guestfs-actions.pod:3578 ../fish/guestfish-actions.pod:2501
12167 msgid "List all the block devices."
12171 #: ../src/guestfs-actions.pod:3580 ../fish/guestfish-actions.pod:2503
12172 msgid "The full block device names are returned, eg. C</dev/sda>."
12176 #: ../src/guestfs-actions.pod:3590
12177 msgid "guestfs_list_filesystems"
12181 #: ../src/guestfs-actions.pod:3592
12185 " guestfs_list_filesystems (guestfs_h *g);\n"
12190 #: ../src/guestfs-actions.pod:3595 ../fish/guestfish-actions.pod:2511
12192 "This inspection command looks for filesystems on partitions, block devices "
12193 "and logical volumes, returning a list of devices containing filesystems and "
12198 #: ../src/guestfs-actions.pod:3599 ../fish/guestfish-actions.pod:2515
12200 "The return value is a hash, where the keys are the devices containing "
12201 "filesystems, and the values are the filesystem types. For example:"
12205 #: ../src/guestfs-actions.pod:3603 ../fish/guestfish-actions.pod:2519
12208 " \"/dev/sda1\" => \"ntfs\"\n"
12209 " \"/dev/sda2\" => \"ext2\"\n"
12210 " \"/dev/vg_guest/lv_root\" => \"ext4\"\n"
12211 " \"/dev/vg_guest/lv_swap\" => \"swap\"\n"
12216 #: ../src/guestfs-actions.pod:3608 ../fish/guestfish-actions.pod:2524
12218 "The value can have the special value \"unknown\", meaning the content of the "
12219 "device is undetermined or empty. \"swap\" means a Linux swap partition."
12223 #: ../src/guestfs-actions.pod:3612
12225 "This command runs other libguestfs commands, which might include "
12226 "C<guestfs_mount> and C<guestfs_umount>, and therefore you should use this "
12227 "soon after launch and only when nothing is mounted."
12231 #: ../src/guestfs-actions.pod:3616
12233 "Not all of the filesystems returned will be mountable. In particular, swap "
12234 "partitions are returned in the list. Also this command does not check that "
12235 "each filesystem found is valid and mountable, and some filesystems might be "
12236 "mountable but require special options. Filesystems may not all belong to a "
12237 "single logical operating system (use C<guestfs_inspect_os> to look for OSes)."
12241 #: ../src/guestfs-actions.pod:3630 ../src/guestfs-actions.pod:5251
12242 msgid "(Added in 1.5.15)"
12246 #: ../src/guestfs-actions.pod:3632
12247 msgid "guestfs_list_partitions"
12251 #: ../src/guestfs-actions.pod:3634
12255 " guestfs_list_partitions (guestfs_h *g);\n"
12260 #: ../src/guestfs-actions.pod:3637 ../fish/guestfish-actions.pod:2544
12261 msgid "List all the partitions detected on all block devices."
12265 #: ../src/guestfs-actions.pod:3639 ../fish/guestfish-actions.pod:2546
12266 msgid "The full partition device names are returned, eg. C</dev/sda1>"
12270 #: ../src/guestfs-actions.pod:3641
12272 "This does not return logical volumes. For that you will need to call "
12277 #: ../src/guestfs-actions.pod:3652
12282 #: ../src/guestfs-actions.pod:3654
12286 " guestfs_ll (guestfs_h *g,\n"
12287 " const char *directory);\n"
12292 #: ../src/guestfs-actions.pod:3658 ../fish/guestfish-actions.pod:2557
12294 "List the files in C<directory> (relative to the root directory, there is no "
12295 "cwd) in the format of 'ls -la'."
12299 #: ../src/guestfs-actions.pod:3661 ../fish/guestfish-actions.pod:2560
12301 "This command is mostly useful for interactive sessions. It is I<not> "
12302 "intended that you try to parse the output string."
12306 #: ../src/guestfs-actions.pod:3669
12311 #: ../src/guestfs-actions.pod:3671
12315 " guestfs_ln (guestfs_h *g,\n"
12316 " const char *target,\n"
12317 " const char *linkname);\n"
12322 #: ../src/guestfs-actions.pod:3676 ../fish/guestfish-actions.pod:2567
12323 msgid "This command creates a hard link using the C<ln> command."
12327 #: ../src/guestfs-actions.pod:3682
12328 msgid "guestfs_ln_f"
12332 #: ../src/guestfs-actions.pod:3684
12336 " guestfs_ln_f (guestfs_h *g,\n"
12337 " const char *target,\n"
12338 " const char *linkname);\n"
12343 #: ../src/guestfs-actions.pod:3689 ../fish/guestfish-actions.pod:2573
12345 "This command creates a hard link using the C<ln -f> command. The I<-f> "
12346 "option removes the link (C<linkname>) if it exists already."
12350 #: ../src/guestfs-actions.pod:3696
12351 msgid "guestfs_ln_s"
12355 #: ../src/guestfs-actions.pod:3698
12359 " guestfs_ln_s (guestfs_h *g,\n"
12360 " const char *target,\n"
12361 " const char *linkname);\n"
12366 #: ../src/guestfs-actions.pod:3703 ../fish/guestfish-actions.pod:2580
12367 msgid "This command creates a symbolic link using the C<ln -s> command."
12371 #: ../src/guestfs-actions.pod:3709
12372 msgid "guestfs_ln_sf"
12376 #: ../src/guestfs-actions.pod:3711
12380 " guestfs_ln_sf (guestfs_h *g,\n"
12381 " const char *target,\n"
12382 " const char *linkname);\n"
12387 #: ../src/guestfs-actions.pod:3716 ../fish/guestfish-actions.pod:2586
12389 "This command creates a symbolic link using the C<ln -sf> command, The I<-f> "
12390 "option removes the link (C<linkname>) if it exists already."
12394 #: ../src/guestfs-actions.pod:3723
12395 msgid "guestfs_lremovexattr"
12399 #: ../src/guestfs-actions.pod:3725
12403 " guestfs_lremovexattr (guestfs_h *g,\n"
12404 " const char *xattr,\n"
12405 " const char *path);\n"
12410 #: ../src/guestfs-actions.pod:3730
12412 "This is the same as C<guestfs_removexattr>, but if C<path> is a symbolic "
12413 "link, then it removes an extended attribute of the link itself."
12417 #: ../src/guestfs-actions.pod:3738
12422 #: ../src/guestfs-actions.pod:3740
12426 " guestfs_ls (guestfs_h *g,\n"
12427 " const char *directory);\n"
12432 #: ../src/guestfs-actions.pod:3744 ../fish/guestfish-actions.pod:2601
12434 "List the files in C<directory> (relative to the root directory, there is no "
12435 "cwd). The '.' and '..' entries are not returned, but hidden files are shown."
12439 #: ../src/guestfs-actions.pod:3748
12441 "This command is mostly useful for interactive sessions. Programs should "
12442 "probably use C<guestfs_readdir> instead."
12446 #: ../src/guestfs-actions.pod:3757
12447 msgid "guestfs_lsetxattr"
12451 #: ../src/guestfs-actions.pod:3759
12455 " guestfs_lsetxattr (guestfs_h *g,\n"
12456 " const char *xattr,\n"
12457 " const char *val,\n"
12459 " const char *path);\n"
12464 #: ../src/guestfs-actions.pod:3766
12466 "This is the same as C<guestfs_setxattr>, but if C<path> is a symbolic link, "
12467 "then it sets an extended attribute of the link itself."
12471 #: ../src/guestfs-actions.pod:3774
12472 msgid "guestfs_lstat"
12476 #: ../src/guestfs-actions.pod:3776
12479 " struct guestfs_stat *\n"
12480 " guestfs_lstat (guestfs_h *g,\n"
12481 " const char *path);\n"
12486 #: ../src/guestfs-actions.pod:3780 ../src/guestfs-actions.pod:6382
12487 #: ../fish/guestfish-actions.pod:2620 ../fish/guestfish-actions.pod:4333
12488 msgid "Returns file information for the given C<path>."
12492 #: ../src/guestfs-actions.pod:3782
12494 "This is the same as C<guestfs_stat> except that if C<path> is a symbolic "
12495 "link, then the link is stat-ed, not the file it refers to."
12499 #: ../src/guestfs-actions.pod:3786 ../fish/guestfish-actions.pod:2626
12500 msgid "This is the same as the C<lstat(2)> system call."
12504 #: ../src/guestfs-actions.pod:3788 ../src/guestfs-actions.pod:6386
12506 "This function returns a C<struct guestfs_stat *>, or NULL if there was an "
12507 "error. I<The caller must call C<guestfs_free_stat> after use>."
12511 #: ../src/guestfs-actions.pod:3792 ../src/guestfs-actions.pod:6390
12512 #: ../src/guestfs-actions.pod:6408 ../src/guestfs-actions.pod:6789
12513 msgid "(Added in 0.9.2)"
12517 #: ../src/guestfs-actions.pod:3794
12518 msgid "guestfs_lstatlist"
12522 #: ../src/guestfs-actions.pod:3796
12525 " struct guestfs_stat_list *\n"
12526 " guestfs_lstatlist (guestfs_h *g,\n"
12527 " const char *path,\n"
12528 " char *const *names);\n"
12533 #: ../src/guestfs-actions.pod:3801
12535 "This call allows you to perform the C<guestfs_lstat> operation on multiple "
12536 "files, where all files are in the directory C<path>. C<names> is the list "
12537 "of files from this directory."
12541 #: ../src/guestfs-actions.pod:3805 ../fish/guestfish-actions.pod:2636
12543 "On return you get a list of stat structs, with a one-to-one correspondence "
12544 "to the C<names> list. If any name did not exist or could not be lstat'd, "
12545 "then the C<ino> field of that structure is set to C<-1>."
12549 #: ../src/guestfs-actions.pod:3810
12551 "This call is intended for programs that want to efficiently list a directory "
12552 "contents without making many round-trips. See also C<guestfs_lxattrlist> "
12553 "for a similarly efficient call for getting extended attributes. Very long "
12554 "directory listings might cause the protocol message size to be exceeded, "
12555 "causing this call to fail. The caller must split up such requests into "
12556 "smaller groups of names."
12560 #: ../src/guestfs-actions.pod:3818
12562 "This function returns a C<struct guestfs_stat_list *>, or NULL if there was "
12563 "an error. I<The caller must call C<guestfs_free_stat_list> after use>."
12567 #: ../src/guestfs-actions.pod:3824
12568 msgid "guestfs_luks_add_key"
12572 #: ../src/guestfs-actions.pod:3826
12576 " guestfs_luks_add_key (guestfs_h *g,\n"
12577 " const char *device,\n"
12578 " const char *key,\n"
12579 " const char *newkey,\n"
12585 #: ../src/guestfs-actions.pod:3833 ../fish/guestfish-actions.pod:2653
12587 "This command adds a new key on LUKS device C<device>. C<key> is any "
12588 "existing key, and is used to access the device. C<newkey> is the new key to "
12589 "add. C<keyslot> is the key slot that will be replaced."
12593 #: ../src/guestfs-actions.pod:3838
12595 "Note that if C<keyslot> already contains a key, then this command will "
12596 "fail. You have to use C<guestfs_luks_kill_slot> first to remove that key."
12600 #: ../src/guestfs-actions.pod:3844 ../src/guestfs-actions.pod:3884
12601 #: ../src/guestfs-actions.pod:3907 ../src/guestfs-actions.pod:3927
12602 #: ../src/guestfs-actions.pod:3959 ../src/guestfs-actions.pod:3978
12604 "This function takes a key or passphrase parameter which could contain "
12605 "sensitive material. Read the section L</KEYS AND PASSPHRASES> for more "
12610 #: ../src/guestfs-actions.pod:3848 ../src/guestfs-actions.pod:3888
12611 #: ../src/guestfs-actions.pod:3911 ../src/guestfs-actions.pod:3931
12612 msgid "(Added in 1.5.2)"
12616 #: ../src/guestfs-actions.pod:3850
12617 msgid "guestfs_luks_close"
12621 #: ../src/guestfs-actions.pod:3852
12625 " guestfs_luks_close (guestfs_h *g,\n"
12626 " const char *device);\n"
12631 #: ../src/guestfs-actions.pod:3856
12633 "This closes a LUKS device that was created earlier by C<guestfs_luks_open> "
12634 "or C<guestfs_luks_open_ro>. The C<device> parameter must be the name of the "
12635 "LUKS mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
12636 "underlying block device."
12640 #: ../src/guestfs-actions.pod:3864 ../src/guestfs-actions.pod:3963
12641 #: ../src/guestfs-actions.pod:3982 ../src/guestfs-actions.pod:4032
12642 #: ../src/guestfs-actions.pod:4080
12643 msgid "(Added in 1.5.1)"
12647 #: ../src/guestfs-actions.pod:3866
12648 msgid "guestfs_luks_format"
12652 #: ../src/guestfs-actions.pod:3868
12656 " guestfs_luks_format (guestfs_h *g,\n"
12657 " const char *device,\n"
12658 " const char *key,\n"
12664 #: ../src/guestfs-actions.pod:3874 ../fish/guestfish-actions.pod:2679
12666 "This command erases existing data on C<device> and formats the device as a "
12667 "LUKS encrypted device. C<key> is the initial key, which is added to key "
12668 "slot C<slot>. (LUKS supports 8 key slots, numbered 0-7)."
12672 #: ../src/guestfs-actions.pod:3881 ../src/guestfs-actions.pod:3904
12673 #: ../src/guestfs-actions.pod:4044 ../src/guestfs-actions.pod:5002
12674 #: ../src/guestfs-actions.pod:5782 ../src/guestfs-actions.pod:6189
12675 #: ../src/guestfs-actions.pod:6219 ../src/guestfs-actions.pod:6252
12676 #: ../src/guestfs-actions.pod:7433 ../fish/guestfish-actions.pod:2687
12677 #: ../fish/guestfish-actions.pod:2700 ../fish/guestfish-actions.pod:2784
12678 #: ../fish/guestfish-actions.pod:3374 ../fish/guestfish-actions.pod:3894
12679 #: ../fish/guestfish-actions.pod:4204 ../fish/guestfish-actions.pod:4227
12680 #: ../fish/guestfish-actions.pod:4249 ../fish/guestfish-actions.pod:4978
12682 "B<This command is dangerous. Without careful use you can easily destroy all "
12687 #: ../src/guestfs-actions.pod:3890
12688 msgid "guestfs_luks_format_cipher"
12692 #: ../src/guestfs-actions.pod:3892
12696 " guestfs_luks_format_cipher (guestfs_h *g,\n"
12697 " const char *device,\n"
12698 " const char *key,\n"
12700 " const char *cipher);\n"
12705 #: ../src/guestfs-actions.pod:3899
12707 "This command is the same as C<guestfs_luks_format> but it also allows you to "
12708 "set the C<cipher> used."
12712 #: ../src/guestfs-actions.pod:3913
12713 msgid "guestfs_luks_kill_slot"
12717 #: ../src/guestfs-actions.pod:3915
12721 " guestfs_luks_kill_slot (guestfs_h *g,\n"
12722 " const char *device,\n"
12723 " const char *key,\n"
12729 #: ../src/guestfs-actions.pod:3921 ../fish/guestfish-actions.pod:2707
12731 "This command deletes the key in key slot C<keyslot> from the encrypted LUKS "
12732 "device C<device>. C<key> must be one of the I<other> keys."
12736 #: ../src/guestfs-actions.pod:3933
12737 msgid "guestfs_luks_open"
12741 #: ../src/guestfs-actions.pod:3935
12745 " guestfs_luks_open (guestfs_h *g,\n"
12746 " const char *device,\n"
12747 " const char *key,\n"
12748 " const char *mapname);\n"
12753 #: ../src/guestfs-actions.pod:3941 ../fish/guestfish-actions.pod:2718
12755 "This command opens a block device which has been encrypted according to the "
12756 "Linux Unified Key Setup (LUKS) standard."
12760 #: ../src/guestfs-actions.pod:3944 ../fish/guestfish-actions.pod:2721
12761 msgid "C<device> is the encrypted block device or partition."
12765 #: ../src/guestfs-actions.pod:3946 ../fish/guestfish-actions.pod:2723
12767 "The caller must supply one of the keys associated with the LUKS block "
12768 "device, in the C<key> parameter."
12772 #: ../src/guestfs-actions.pod:3949 ../fish/guestfish-actions.pod:2726
12774 "This creates a new block device called C</dev/mapper/mapname>. Reads and "
12775 "writes to this block device are decrypted from and encrypted to the "
12776 "underlying C<device> respectively."
12780 #: ../src/guestfs-actions.pod:3953
12782 "If this block device contains LVM volume groups, then calling "
12783 "C<guestfs_vgscan> followed by C<guestfs_vg_activate_all> will make them "
12788 #: ../src/guestfs-actions.pod:3965
12789 msgid "guestfs_luks_open_ro"
12793 #: ../src/guestfs-actions.pod:3967
12797 " guestfs_luks_open_ro (guestfs_h *g,\n"
12798 " const char *device,\n"
12799 " const char *key,\n"
12800 " const char *mapname);\n"
12805 #: ../src/guestfs-actions.pod:3973
12807 "This is the same as C<guestfs_luks_open> except that a read-only mapping is "
12812 #: ../src/guestfs-actions.pod:3984
12813 msgid "guestfs_lvcreate"
12817 #: ../src/guestfs-actions.pod:3986
12821 " guestfs_lvcreate (guestfs_h *g,\n"
12822 " const char *logvol,\n"
12823 " const char *volgroup,\n"
12829 #: ../src/guestfs-actions.pod:3992 ../fish/guestfish-actions.pod:2751
12831 "This creates an LVM logical volume called C<logvol> on the volume group "
12832 "C<volgroup>, with C<size> megabytes."
12836 #: ../src/guestfs-actions.pod:3999
12837 msgid "guestfs_lvm_canonical_lv_name"
12841 #: ../src/guestfs-actions.pod:4001
12845 " guestfs_lvm_canonical_lv_name (guestfs_h *g,\n"
12846 " const char *lvname);\n"
12851 #: ../src/guestfs-actions.pod:4005 ../fish/guestfish-actions.pod:2758
12853 "This converts alternative naming schemes for LVs that you might find to the "
12854 "canonical name. For example, C</dev/mapper/VG-LV> is converted to C</dev/VG/"
12859 #: ../src/guestfs-actions.pod:4009 ../fish/guestfish-actions.pod:2762
12861 "This command returns an error if the C<lvname> parameter does not refer to a "
12866 #: ../src/guestfs-actions.pod:4012
12867 msgid "See also C<guestfs_is_lv>."
12871 #: ../src/guestfs-actions.pod:4017
12872 msgid "(Added in 1.5.24)"
12876 #: ../src/guestfs-actions.pod:4019
12877 msgid "guestfs_lvm_clear_filter"
12881 #: ../src/guestfs-actions.pod:4021
12885 " guestfs_lvm_clear_filter (guestfs_h *g);\n"
12890 #: ../src/guestfs-actions.pod:4024
12892 "This undoes the effect of C<guestfs_lvm_set_filter>. LVM will be able to "
12893 "see every block device."
12897 #: ../src/guestfs-actions.pod:4027 ../src/guestfs-actions.pod:4069
12898 #: ../fish/guestfish-actions.pod:2774 ../fish/guestfish-actions.pod:2805
12900 "This command also clears the LVM cache and performs a volume group scan."
12904 #: ../src/guestfs-actions.pod:4034
12905 msgid "guestfs_lvm_remove_all"
12909 #: ../src/guestfs-actions.pod:4036
12913 " guestfs_lvm_remove_all (guestfs_h *g);\n"
12918 #: ../src/guestfs-actions.pod:4039 ../fish/guestfish-actions.pod:2781
12920 "This command removes all LVM logical volumes, volume groups and physical "
12925 #: ../src/guestfs-actions.pod:4049
12926 msgid "guestfs_lvm_set_filter"
12930 #: ../src/guestfs-actions.pod:4051
12934 " guestfs_lvm_set_filter (guestfs_h *g,\n"
12935 " char *const *devices);\n"
12940 #: ../src/guestfs-actions.pod:4055 ../fish/guestfish-actions.pod:2791
12942 "This sets the LVM device filter so that LVM will only be able to \"see\" the "
12943 "block devices in the list C<devices>, and will ignore all other attached "
12948 #: ../src/guestfs-actions.pod:4059 ../fish/guestfish-actions.pod:2795
12950 "Where disk image(s) contain duplicate PVs or VGs, this command is useful to "
12951 "get LVM to ignore the duplicates, otherwise LVM can get confused. Note also "
12952 "there are two types of duplication possible: either cloned PVs/VGs which "
12953 "have identical UUIDs; or VGs that are not cloned but just happen to have the "
12954 "same name. In normal operation you cannot create this situation, but you "
12955 "can do it outside LVM, eg. by cloning disk images or by bit twiddling "
12956 "inside the LVM metadata."
12960 #: ../src/guestfs-actions.pod:4072 ../fish/guestfish-actions.pod:2808
12961 msgid "You can filter whole block devices or individual partitions."
12965 #: ../src/guestfs-actions.pod:4074 ../fish/guestfish-actions.pod:2810
12967 "You cannot use this if any VG is currently in use (eg. contains a mounted "
12968 "filesystem), even if you are not filtering out that VG."
12972 #: ../src/guestfs-actions.pod:4082
12973 msgid "guestfs_lvremove"
12977 #: ../src/guestfs-actions.pod:4084
12981 " guestfs_lvremove (guestfs_h *g,\n"
12982 " const char *device);\n"
12987 #: ../src/guestfs-actions.pod:4088 ../fish/guestfish-actions.pod:2818
12989 "Remove an LVM logical volume C<device>, where C<device> is the path to the "
12990 "LV, such as C</dev/VG/LV>."
12994 #: ../src/guestfs-actions.pod:4091 ../fish/guestfish-actions.pod:2821
12996 "You can also remove all LVs in a volume group by specifying the VG name, C</"
13001 #: ../src/guestfs-actions.pod:4096 ../src/guestfs-actions.pod:5348
13002 #: ../src/guestfs-actions.pod:7165
13003 msgid "(Added in 1.0.13)"
13007 #: ../src/guestfs-actions.pod:4098
13008 msgid "guestfs_lvrename"
13012 #: ../src/guestfs-actions.pod:4100
13016 " guestfs_lvrename (guestfs_h *g,\n"
13017 " const char *logvol,\n"
13018 " const char *newlogvol);\n"
13023 #: ../src/guestfs-actions.pod:4105 ../fish/guestfish-actions.pod:2828
13024 msgid "Rename a logical volume C<logvol> with the new name C<newlogvol>."
13028 #: ../src/guestfs-actions.pod:4109 ../src/guestfs-actions.pod:7178
13029 msgid "(Added in 1.0.83)"
13033 #: ../src/guestfs-actions.pod:4111
13034 msgid "guestfs_lvresize"
13038 #: ../src/guestfs-actions.pod:4113
13042 " guestfs_lvresize (guestfs_h *g,\n"
13043 " const char *device,\n"
13049 #: ../src/guestfs-actions.pod:4118 ../fish/guestfish-actions.pod:2834
13051 "This resizes (expands or shrinks) an existing LVM logical volume to "
13052 "C<mbytes>. When reducing, data in the reduced part is lost."
13056 #: ../src/guestfs-actions.pod:4126
13057 msgid "guestfs_lvresize_free"
13061 #: ../src/guestfs-actions.pod:4128
13065 " guestfs_lvresize_free (guestfs_h *g,\n"
13066 " const char *lv,\n"
13072 #: ../src/guestfs-actions.pod:4133 ../fish/guestfish-actions.pod:2842
13074 "This expands an existing logical volume C<lv> so that it fills C<pc>% of the "
13075 "remaining free space in the volume group. Commonly you would call this with "
13076 "pc = 100 which expands the logical volume as much as possible, using all "
13077 "remaining free space in the volume group."
13081 #: ../src/guestfs-actions.pod:4141
13082 msgid "(Added in 1.3.3)"
13086 #: ../src/guestfs-actions.pod:4143
13087 msgid "guestfs_lvs"
13091 #: ../src/guestfs-actions.pod:4145
13095 " guestfs_lvs (guestfs_h *g);\n"
13100 #: ../src/guestfs-actions.pod:4148 ../fish/guestfish-actions.pod:2852
13102 "List all the logical volumes detected. This is the equivalent of the L<lvs"
13107 #: ../src/guestfs-actions.pod:4151 ../fish/guestfish-actions.pod:2855
13109 "This returns a list of the logical volume device names (eg. C</dev/"
13110 "VolGroup00/LogVol00>)."
13114 #: ../src/guestfs-actions.pod:4154
13115 msgid "See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>."
13119 #: ../src/guestfs-actions.pod:4162
13120 msgid "guestfs_lvs_full"
13124 #: ../src/guestfs-actions.pod:4164
13127 " struct guestfs_lvm_lv_list *\n"
13128 " guestfs_lvs_full (guestfs_h *g);\n"
13133 #: ../src/guestfs-actions.pod:4167 ../fish/guestfish-actions.pod:2864
13135 "List all the logical volumes detected. This is the equivalent of the L<lvs"
13136 "(8)> command. The \"full\" version includes all fields."
13140 #: ../src/guestfs-actions.pod:4170
13142 "This function returns a C<struct guestfs_lvm_lv_list *>, or NULL if there "
13143 "was an error. I<The caller must call C<guestfs_free_lvm_lv_list> after use>."
13147 #: ../src/guestfs-actions.pod:4176
13148 msgid "guestfs_lvuuid"
13152 #: ../src/guestfs-actions.pod:4178
13156 " guestfs_lvuuid (guestfs_h *g,\n"
13157 " const char *device);\n"
13162 #: ../src/guestfs-actions.pod:4182 ../fish/guestfish-actions.pod:2871
13163 msgid "This command returns the UUID of the LVM LV C<device>."
13167 #: ../src/guestfs-actions.pod:4189
13168 msgid "guestfs_lxattrlist"
13172 #: ../src/guestfs-actions.pod:4191
13175 " struct guestfs_xattr_list *\n"
13176 " guestfs_lxattrlist (guestfs_h *g,\n"
13177 " const char *path,\n"
13178 " char *const *names);\n"
13183 #: ../src/guestfs-actions.pod:4196 ../fish/guestfish-actions.pod:2877
13185 "This call allows you to get the extended attributes of multiple files, where "
13186 "all files are in the directory C<path>. C<names> is the list of files from "
13191 #: ../src/guestfs-actions.pod:4200 ../fish/guestfish-actions.pod:2881
13193 "On return you get a flat list of xattr structs which must be interpreted "
13194 "sequentially. The first xattr struct always has a zero-length C<attrname>. "
13195 "C<attrval> in this struct is zero-length to indicate there was an error "
13196 "doing C<lgetxattr> for this file, I<or> is a C string which is a decimal "
13197 "number (the number of following attributes for this file, which could be C<"
13198 "\"0\">). Then after the first xattr struct are the zero or more attributes "
13199 "for the first named file. This repeats for the second and subsequent files."
13203 #: ../src/guestfs-actions.pod:4210
13205 "This call is intended for programs that want to efficiently list a directory "
13206 "contents without making many round-trips. See also C<guestfs_lstatlist> for "
13207 "a similarly efficient call for getting standard stats. Very long directory "
13208 "listings might cause the protocol message size to be exceeded, causing this "
13209 "call to fail. The caller must split up such requests into smaller groups of "
13214 #: ../src/guestfs-actions.pod:4224
13215 msgid "guestfs_mkdir"
13219 #: ../src/guestfs-actions.pod:4226
13223 " guestfs_mkdir (guestfs_h *g,\n"
13224 " const char *path);\n"
13229 #: ../src/guestfs-actions.pod:4230 ../fish/guestfish-actions.pod:2903
13230 msgid "Create a directory named C<path>."
13234 #: ../src/guestfs-actions.pod:4236
13235 msgid "guestfs_mkdir_mode"
13239 #: ../src/guestfs-actions.pod:4238
13243 " guestfs_mkdir_mode (guestfs_h *g,\n"
13244 " const char *path,\n"
13250 #: ../src/guestfs-actions.pod:4243 ../fish/guestfish-actions.pod:2909
13252 "This command creates a directory, setting the initial permissions of the "
13253 "directory to C<mode>."
13257 #: ../src/guestfs-actions.pod:4246 ../fish/guestfish-actions.pod:2912
13259 "For common Linux filesystems, the actual mode which is set will be C<mode & "
13260 "~umask & 01777>. Non-native-Linux filesystems may interpret the mode in "
13265 #: ../src/guestfs-actions.pod:4250
13266 msgid "See also C<guestfs_mkdir>, C<guestfs_umask>"
13270 #: ../src/guestfs-actions.pod:4256
13271 msgid "guestfs_mkdir_p"
13275 #: ../src/guestfs-actions.pod:4258
13279 " guestfs_mkdir_p (guestfs_h *g,\n"
13280 " const char *path);\n"
13285 #: ../src/guestfs-actions.pod:4262 ../fish/guestfish-actions.pod:2922
13287 "Create a directory named C<path>, creating any parent directories as "
13288 "necessary. This is like the C<mkdir -p> shell command."
13292 #: ../src/guestfs-actions.pod:4269
13293 msgid "guestfs_mkdtemp"
13297 #: ../src/guestfs-actions.pod:4271
13301 " guestfs_mkdtemp (guestfs_h *g,\n"
13302 " const char *template);\n"
13307 #: ../src/guestfs-actions.pod:4275 ../fish/guestfish-actions.pod:2929
13309 "This command creates a temporary directory. The C<template> parameter "
13310 "should be a full pathname for the temporary directory name with the final "
13311 "six characters being \"XXXXXX\"."
13315 #: ../src/guestfs-actions.pod:4280 ../fish/guestfish-actions.pod:2934
13317 "For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\", the second one "
13318 "being suitable for Windows filesystems."
13322 #: ../src/guestfs-actions.pod:4283 ../fish/guestfish-actions.pod:2937
13323 msgid "The name of the temporary directory that was created is returned."
13327 #: ../src/guestfs-actions.pod:4286 ../fish/guestfish-actions.pod:2940
13328 msgid "The temporary directory is created with mode 0700 and is owned by root."
13332 #: ../src/guestfs-actions.pod:4289 ../fish/guestfish-actions.pod:2943
13334 "The caller is responsible for deleting the temporary directory and its "
13335 "contents after use."
13339 #: ../src/guestfs-actions.pod:4292 ../fish/guestfish-actions.pod:2946
13340 msgid "See also: L<mkdtemp(3)>"
13344 #: ../src/guestfs-actions.pod:4299
13345 msgid "guestfs_mke2fs_J"
13349 #: ../src/guestfs-actions.pod:4301
13353 " guestfs_mke2fs_J (guestfs_h *g,\n"
13354 " const char *fstype,\n"
13355 " int blocksize,\n"
13356 " const char *device,\n"
13357 " const char *journal);\n"
13362 #: ../src/guestfs-actions.pod:4308 ../fish/guestfish-actions.pod:2952
13364 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
13365 "C<journal>. It is equivalent to the command:"
13369 #: ../src/guestfs-actions.pod:4312 ../fish/guestfish-actions.pod:2956
13372 " mke2fs -t fstype -b blocksize -J device=<journal> <device>\n"
13377 #: ../src/guestfs-actions.pod:4314
13378 msgid "See also C<guestfs_mke2journal>."
13382 #: ../src/guestfs-actions.pod:4318 ../src/guestfs-actions.pod:4336
13383 #: ../src/guestfs-actions.pod:4354 ../src/guestfs-actions.pod:4370
13384 #: ../src/guestfs-actions.pod:4384 ../src/guestfs-actions.pod:4398
13385 #: ../src/guestfs-actions.pod:4457 ../src/guestfs-actions.pod:4722
13386 msgid "(Added in 1.0.68)"
13390 #: ../src/guestfs-actions.pod:4320
13391 msgid "guestfs_mke2fs_JL"
13395 #: ../src/guestfs-actions.pod:4322
13399 " guestfs_mke2fs_JL (guestfs_h *g,\n"
13400 " const char *fstype,\n"
13401 " int blocksize,\n"
13402 " const char *device,\n"
13403 " const char *label);\n"
13408 #: ../src/guestfs-actions.pod:4329 ../fish/guestfish-actions.pod:2964
13410 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
13411 "the journal labeled C<label>."
13415 #: ../src/guestfs-actions.pod:4332
13416 msgid "See also C<guestfs_mke2journal_L>."
13420 #: ../src/guestfs-actions.pod:4338
13421 msgid "guestfs_mke2fs_JU"
13425 #: ../src/guestfs-actions.pod:4340
13429 " guestfs_mke2fs_JU (guestfs_h *g,\n"
13430 " const char *fstype,\n"
13431 " int blocksize,\n"
13432 " const char *device,\n"
13433 " const char *uuid);\n"
13438 #: ../src/guestfs-actions.pod:4347 ../fish/guestfish-actions.pod:2973
13440 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
13441 "the journal with UUID C<uuid>."
13445 #: ../src/guestfs-actions.pod:4350
13446 msgid "See also C<guestfs_mke2journal_U>."
13450 #: ../src/guestfs-actions.pod:4356
13451 msgid "guestfs_mke2journal"
13455 #: ../src/guestfs-actions.pod:4358
13459 " guestfs_mke2journal (guestfs_h *g,\n"
13460 " int blocksize,\n"
13461 " const char *device);\n"
13466 #: ../src/guestfs-actions.pod:4363 ../fish/guestfish-actions.pod:2982
13468 "This creates an ext2 external journal on C<device>. It is equivalent to the "
13473 #: ../src/guestfs-actions.pod:4366 ../fish/guestfish-actions.pod:2985
13476 " mke2fs -O journal_dev -b blocksize device\n"
13481 #: ../src/guestfs-actions.pod:4372
13482 msgid "guestfs_mke2journal_L"
13486 #: ../src/guestfs-actions.pod:4374
13490 " guestfs_mke2journal_L (guestfs_h *g,\n"
13491 " int blocksize,\n"
13492 " const char *label,\n"
13493 " const char *device);\n"
13498 #: ../src/guestfs-actions.pod:4380 ../fish/guestfish-actions.pod:2991
13499 msgid "This creates an ext2 external journal on C<device> with label C<label>."
13503 #: ../src/guestfs-actions.pod:4386
13504 msgid "guestfs_mke2journal_U"
13508 #: ../src/guestfs-actions.pod:4388
13512 " guestfs_mke2journal_U (guestfs_h *g,\n"
13513 " int blocksize,\n"
13514 " const char *uuid,\n"
13515 " const char *device);\n"
13520 #: ../src/guestfs-actions.pod:4394 ../fish/guestfish-actions.pod:2997
13521 msgid "This creates an ext2 external journal on C<device> with UUID C<uuid>."
13525 #: ../src/guestfs-actions.pod:4400
13526 msgid "guestfs_mkfifo"
13530 #: ../src/guestfs-actions.pod:4402
13534 " guestfs_mkfifo (guestfs_h *g,\n"
13536 " const char *path);\n"
13541 #: ../src/guestfs-actions.pod:4407
13543 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
13544 "is just a convenient wrapper around C<guestfs_mknod>."
13548 #: ../src/guestfs-actions.pod:4417
13549 msgid "guestfs_mkfs"
13553 #: ../src/guestfs-actions.pod:4419
13557 " guestfs_mkfs (guestfs_h *g,\n"
13558 " const char *fstype,\n"
13559 " const char *device);\n"
13564 #: ../src/guestfs-actions.pod:4424 ../fish/guestfish-actions.pod:3013
13566 "This creates a filesystem on C<device> (usually a partition or LVM logical "
13567 "volume). The filesystem type is C<fstype>, for example C<ext3>."
13571 #: ../src/guestfs-actions.pod:4432
13572 msgid "guestfs_mkfs_b"
13576 #: ../src/guestfs-actions.pod:4434
13580 " guestfs_mkfs_b (guestfs_h *g,\n"
13581 " const char *fstype,\n"
13582 " int blocksize,\n"
13583 " const char *device);\n"
13588 #: ../src/guestfs-actions.pod:4440
13590 "This call is similar to C<guestfs_mkfs>, but it allows you to control the "
13591 "block size of the resulting filesystem. Supported block sizes depend on the "
13592 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
13596 #: ../src/guestfs-actions.pod:4445 ../src/guestfs-actions.pod:4488
13597 #: ../fish/guestfish-actions.pod:3026 ../fish/guestfish-actions.pod:3053
13599 "For VFAT and NTFS the C<blocksize> parameter is treated as the requested "
13604 #: ../src/guestfs-actions.pod:4450
13606 "This function is deprecated. In new code, use the L</guestfs_mkfs_opts> "
13611 #: ../src/guestfs-actions.pod:4459
13612 msgid "guestfs_mkfs_opts"
13616 #: ../src/guestfs-actions.pod:4461
13620 " guestfs_mkfs_opts (guestfs_h *g,\n"
13621 " const char *fstype,\n"
13622 " const char *device,\n"
13628 #: ../src/guestfs-actions.pod:4472
13631 " GUESTFS_MKFS_OPTS_BLOCKSIZE, int blocksize,\n"
13632 " GUESTFS_MKFS_OPTS_FEATURES, const char *features,\n"
13637 #: ../src/guestfs-actions.pod:4475 ../fish/guestfish-actions.pod:3040
13639 "This function creates a filesystem on C<device>. The filesystem type is "
13640 "C<fstype>, for example C<ext3>."
13644 #: ../src/guestfs-actions.pod:4482 ../fish/guestfish-actions.pod:3047
13645 msgid "C<blocksize>"
13649 #: ../src/guestfs-actions.pod:4484 ../fish/guestfish-actions.pod:3049
13651 "The filesystem block size. Supported block sizes depend on the filesystem "
13652 "type, but typically they are C<1024>, C<2048> or C<4096> for Linux ext2/3 "
13657 #: ../src/guestfs-actions.pod:4491 ../fish/guestfish-actions.pod:3056
13658 msgid "For UFS block sizes, please see L<mkfs.ufs(8)>."
13662 #: ../src/guestfs-actions.pod:4493 ../fish/guestfish-actions.pod:3058
13663 msgid "C<features>"
13667 #: ../src/guestfs-actions.pod:4495 ../fish/guestfish-actions.pod:3060
13668 msgid "This passes the I<-O> parameter to the external mkfs program."
13672 #: ../src/guestfs-actions.pod:4497 ../fish/guestfish-actions.pod:3062
13674 "For certain filesystem types, this allows extra filesystem features to be "
13675 "selected. See L<mke2fs(8)> and L<mkfs.ufs(8)> for more details."
13679 #: ../src/guestfs-actions.pod:4501 ../fish/guestfish-actions.pod:3066
13681 "You cannot use this optional parameter with the C<gfs> or C<gfs2> filesystem "
13686 #: ../src/guestfs-actions.pod:4508
13687 msgid "(Added in 1.7.19)"
13691 #: ../src/guestfs-actions.pod:4510
13692 msgid "guestfs_mkfs_opts_va"
13696 #: ../src/guestfs-actions.pod:4512
13700 " guestfs_mkfs_opts_va (guestfs_h *g,\n"
13701 " const char *fstype,\n"
13702 " const char *device,\n"
13703 " va_list args);\n"
13708 #: ../src/guestfs-actions.pod:4518
13709 msgid "This is the \"va_list variant\" of L</guestfs_mkfs_opts>."
13713 #: ../src/guestfs-actions.pod:4522
13714 msgid "guestfs_mkfs_opts_argv"
13718 #: ../src/guestfs-actions.pod:4524
13722 " guestfs_mkfs_opts_argv (guestfs_h *g,\n"
13723 " const char *fstype,\n"
13724 " const char *device,\n"
13725 " const struct guestfs_mkfs_opts_argv *optargs);\n"
13730 #: ../src/guestfs-actions.pod:4530
13731 msgid "This is the \"argv variant\" of L</guestfs_mkfs_opts>."
13735 #: ../src/guestfs-actions.pod:4534
13736 msgid "guestfs_mkmountpoint"
13740 #: ../src/guestfs-actions.pod:4536
13744 " guestfs_mkmountpoint (guestfs_h *g,\n"
13745 " const char *exemptpath);\n"
13750 #: ../src/guestfs-actions.pod:4540
13752 "C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are specialized calls "
13753 "that can be used to create extra mountpoints before mounting the first "
13758 #: ../src/guestfs-actions.pod:4544 ../fish/guestfish-actions.pod:3081
13760 "These calls are I<only> necessary in some very limited circumstances, mainly "
13761 "the case where you want to mount a mix of unrelated and/or read-only "
13762 "filesystems together."
13766 #: ../src/guestfs-actions.pod:4548 ../fish/guestfish-actions.pod:3085
13768 "For example, live CDs often contain a \"Russian doll\" nest of filesystems, "
13769 "an ISO outer layer, with a squashfs image inside, with an ext2/3 image "
13770 "inside that. You can unpack this as follows in guestfish:"
13774 #: ../src/guestfs-actions.pod:4553 ../fish/guestfish-actions.pod:3090
13777 " add-ro Fedora-11-i686-Live.iso\n"
13779 " mkmountpoint /cd\n"
13780 " mkmountpoint /sqsh\n"
13781 " mkmountpoint /ext3fs\n"
13782 " mount /dev/sda /cd\n"
13783 " mount-loop /cd/LiveOS/squashfs.img /sqsh\n"
13784 " mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs\n"
13789 #: ../src/guestfs-actions.pod:4562 ../fish/guestfish-actions.pod:3099
13790 msgid "The inner filesystem is now unpacked under the /ext3fs mountpoint."
13794 #: ../src/guestfs-actions.pod:4564
13796 "C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>. You "
13797 "may get unexpected errors if you try to mix these calls. It is safest to "
13798 "manually unmount filesystems and remove mountpoints after use."
13802 #: ../src/guestfs-actions.pod:4568
13804 "C<guestfs_umount_all> unmounts filesystems by sorting the paths longest "
13805 "first, so for this to work for manual mountpoints, you must ensure that the "
13806 "innermost mountpoints have the longest pathnames, as in the example code "
13811 #: ../src/guestfs-actions.pod:4573 ../fish/guestfish-actions.pod:3110
13813 "For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>"
13817 #: ../src/guestfs-actions.pod:4575
13819 "Autosync [see C<guestfs_set_autosync>, this is set by default on handles] "
13820 "can cause C<guestfs_umount_all> to be called when the handle is closed which "
13821 "can also trigger these issues."
13825 #: ../src/guestfs-actions.pod:4581 ../src/guestfs-actions.pod:4847
13826 #: ../src/guestfs-actions.pod:5766
13827 msgid "(Added in 1.0.62)"
13831 #: ../src/guestfs-actions.pod:4583
13832 msgid "guestfs_mknod"
13836 #: ../src/guestfs-actions.pod:4585
13840 " guestfs_mknod (guestfs_h *g,\n"
13844 " const char *path);\n"
13849 #: ../src/guestfs-actions.pod:4592 ../fish/guestfish-actions.pod:3120
13851 "This call creates block or character special devices, or named pipes (FIFOs)."
13855 #: ../src/guestfs-actions.pod:4595 ../fish/guestfish-actions.pod:3123
13857 "The C<mode> parameter should be the mode, using the standard constants. "
13858 "C<devmajor> and C<devminor> are the device major and minor numbers, only "
13859 "used when creating block and character special devices."
13863 #: ../src/guestfs-actions.pod:4600
13865 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
13866 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
13867 "regular file). These constants are available in the standard Linux header "
13868 "files, or you can use C<guestfs_mknod_b>, C<guestfs_mknod_c> or "
13869 "C<guestfs_mkfifo> which are wrappers around this command which bitwise OR in "
13870 "the appropriate constant for you."
13874 #: ../src/guestfs-actions.pod:4614
13875 msgid "guestfs_mknod_b"
13879 #: ../src/guestfs-actions.pod:4616
13883 " guestfs_mknod_b (guestfs_h *g,\n"
13887 " const char *path);\n"
13892 #: ../src/guestfs-actions.pod:4623
13894 "This call creates a block device node called C<path> with mode C<mode> and "
13895 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
13896 "wrapper around C<guestfs_mknod>."
13900 #: ../src/guestfs-actions.pod:4633
13901 msgid "guestfs_mknod_c"
13905 #: ../src/guestfs-actions.pod:4635
13909 " guestfs_mknod_c (guestfs_h *g,\n"
13913 " const char *path);\n"
13918 #: ../src/guestfs-actions.pod:4642
13920 "This call creates a char device node called C<path> with mode C<mode> and "
13921 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
13922 "wrapper around C<guestfs_mknod>."
13926 #: ../src/guestfs-actions.pod:4652
13927 msgid "guestfs_mkswap"
13931 #: ../src/guestfs-actions.pod:4654
13935 " guestfs_mkswap (guestfs_h *g,\n"
13936 " const char *device);\n"
13941 #: ../src/guestfs-actions.pod:4658 ../fish/guestfish-actions.pod:3162
13942 msgid "Create a swap partition on C<device>."
13946 #: ../src/guestfs-actions.pod:4664
13947 msgid "guestfs_mkswap_L"
13951 #: ../src/guestfs-actions.pod:4666
13955 " guestfs_mkswap_L (guestfs_h *g,\n"
13956 " const char *label,\n"
13957 " const char *device);\n"
13962 #: ../src/guestfs-actions.pod:4671 ../fish/guestfish-actions.pod:3168
13963 msgid "Create a swap partition on C<device> with label C<label>."
13967 #: ../src/guestfs-actions.pod:4673 ../fish/guestfish-actions.pod:3170
13969 "Note that you cannot attach a swap label to a block device (eg. C</dev/"
13970 "sda>), just to a partition. This appears to be a limitation of the kernel "
13975 #: ../src/guestfs-actions.pod:4681
13976 msgid "guestfs_mkswap_U"
13980 #: ../src/guestfs-actions.pod:4683
13984 " guestfs_mkswap_U (guestfs_h *g,\n"
13985 " const char *uuid,\n"
13986 " const char *device);\n"
13991 #: ../src/guestfs-actions.pod:4688 ../fish/guestfish-actions.pod:3178
13992 msgid "Create a swap partition on C<device> with UUID C<uuid>."
13996 #: ../src/guestfs-actions.pod:4694
13997 msgid "guestfs_mkswap_file"
14001 #: ../src/guestfs-actions.pod:4696
14005 " guestfs_mkswap_file (guestfs_h *g,\n"
14006 " const char *path);\n"
14011 #: ../src/guestfs-actions.pod:4700 ../fish/guestfish-actions.pod:3184
14012 msgid "Create a swap file."
14016 #: ../src/guestfs-actions.pod:4702
14018 "This command just writes a swap file signature to an existing file. To "
14019 "create the file itself, use something like C<guestfs_fallocate>."
14023 #: ../src/guestfs-actions.pod:4709
14024 msgid "guestfs_modprobe"
14028 #: ../src/guestfs-actions.pod:4711
14032 " guestfs_modprobe (guestfs_h *g,\n"
14033 " const char *modulename);\n"
14038 #: ../src/guestfs-actions.pod:4715 ../fish/guestfish-actions.pod:3193
14039 msgid "This loads a kernel module in the appliance."
14043 #: ../src/guestfs-actions.pod:4717 ../fish/guestfish-actions.pod:3195
14045 "The kernel module must have been whitelisted when libguestfs was built (see "
14046 "C<appliance/kmod.whitelist.in> in the source)."
14050 #: ../src/guestfs-actions.pod:4724
14051 msgid "guestfs_mount"
14055 #: ../src/guestfs-actions.pod:4726
14059 " guestfs_mount (guestfs_h *g,\n"
14060 " const char *device,\n"
14061 " const char *mountpoint);\n"
14066 #: ../src/guestfs-actions.pod:4731 ../fish/guestfish-actions.pod:3202
14068 "Mount a guest disk at a position in the filesystem. Block devices are named "
14069 "C</dev/sda>, C</dev/sdb> and so on, as they were added to the guest. If "
14070 "those block devices contain partitions, they will have the usual names (eg. "
14071 "C</dev/sda1>). Also LVM C</dev/VG/LV>-style names can be used."
14075 #: ../src/guestfs-actions.pod:4737 ../fish/guestfish-actions.pod:3208
14077 "The rules are the same as for L<mount(2)>: A filesystem must first be "
14078 "mounted on C</> before others can be mounted. Other filesystems can only be "
14079 "mounted on directories which already exist."
14083 #: ../src/guestfs-actions.pod:4742 ../fish/guestfish-actions.pod:3213
14085 "The mounted filesystem is writable, if we have sufficient permissions on the "
14086 "underlying device."
14090 #: ../src/guestfs-actions.pod:4745
14092 "B<Important note:> When you use this call, the filesystem options C<sync> "
14093 "and C<noatime> are set implicitly. This was originally done because we "
14094 "thought it would improve reliability, but it turns out that I<-o sync> has a "
14095 "very large negative performance impact and negligible effect on "
14096 "reliability. Therefore we recommend that you avoid using C<guestfs_mount> "
14097 "in any code that needs performance, and instead use C<guestfs_mount_options> "
14098 "(use an empty string for the first parameter if you don't want any options)."
14102 #: ../src/guestfs-actions.pod:4757
14104 "This function is deprecated. In new code, use the L</guestfs_mount_options> "
14109 #: ../src/guestfs-actions.pod:4766
14110 msgid "guestfs_mount_loop"
14114 #: ../src/guestfs-actions.pod:4768
14118 " guestfs_mount_loop (guestfs_h *g,\n"
14119 " const char *file,\n"
14120 " const char *mountpoint);\n"
14125 #: ../src/guestfs-actions.pod:4773 ../fish/guestfish-actions.pod:3237
14127 "This command lets you mount C<file> (a filesystem image in a file) on a "
14128 "mount point. It is entirely equivalent to the command C<mount -o loop file "
14133 #: ../src/guestfs-actions.pod:4781
14134 msgid "guestfs_mount_options"
14138 #: ../src/guestfs-actions.pod:4783
14142 " guestfs_mount_options (guestfs_h *g,\n"
14143 " const char *options,\n"
14144 " const char *device,\n"
14145 " const char *mountpoint);\n"
14150 #: ../src/guestfs-actions.pod:4789
14152 "This is the same as the C<guestfs_mount> command, but it allows you to set "
14153 "the mount options as for the L<mount(8)> I<-o> flag."
14157 #: ../src/guestfs-actions.pod:4793 ../fish/guestfish-actions.pod:3249
14159 "If the C<options> parameter is an empty string, then no options are passed "
14160 "(all options default to whatever the filesystem uses)."
14164 #: ../src/guestfs-actions.pod:4799 ../src/guestfs-actions.pod:4813
14165 #: ../src/guestfs-actions.pod:4830
14166 msgid "(Added in 1.0.10)"
14170 #: ../src/guestfs-actions.pod:4801
14171 msgid "guestfs_mount_ro"
14175 #: ../src/guestfs-actions.pod:4803
14179 " guestfs_mount_ro (guestfs_h *g,\n"
14180 " const char *device,\n"
14181 " const char *mountpoint);\n"
14186 #: ../src/guestfs-actions.pod:4808
14188 "This is the same as the C<guestfs_mount> command, but it mounts the "
14189 "filesystem with the read-only (I<-o ro>) flag."
14193 #: ../src/guestfs-actions.pod:4815
14194 msgid "guestfs_mount_vfs"
14198 #: ../src/guestfs-actions.pod:4817
14202 " guestfs_mount_vfs (guestfs_h *g,\n"
14203 " const char *options,\n"
14204 " const char *vfstype,\n"
14205 " const char *device,\n"
14206 " const char *mountpoint);\n"
14211 #: ../src/guestfs-actions.pod:4824
14213 "This is the same as the C<guestfs_mount> command, but it allows you to set "
14214 "both the mount options and the vfstype as for the L<mount(8)> I<-o> and I<-"
14219 #: ../src/guestfs-actions.pod:4832
14220 msgid "guestfs_mountpoints"
14224 #: ../src/guestfs-actions.pod:4834
14228 " guestfs_mountpoints (guestfs_h *g);\n"
14233 #: ../src/guestfs-actions.pod:4837
14235 "This call is similar to C<guestfs_mounts>. That call returns a list of "
14236 "devices. This one returns a hash table (map) of device name to directory "
14237 "where the device is mounted."
14241 #: ../src/guestfs-actions.pod:4849
14242 msgid "guestfs_mounts"
14246 #: ../src/guestfs-actions.pod:4851
14250 " guestfs_mounts (guestfs_h *g);\n"
14255 #: ../src/guestfs-actions.pod:4854 ../fish/guestfish-actions.pod:3280
14257 "This returns the list of currently mounted filesystems. It returns the list "
14258 "of devices (eg. C</dev/sda1>, C</dev/VG/LV>)."
14262 #: ../src/guestfs-actions.pod:4857 ../fish/guestfish-actions.pod:3283
14263 msgid "Some internal mounts are not shown."
14267 #: ../src/guestfs-actions.pod:4859
14268 msgid "See also: C<guestfs_mountpoints>"
14272 #: ../src/guestfs-actions.pod:4867
14277 #: ../src/guestfs-actions.pod:4869
14281 " guestfs_mv (guestfs_h *g,\n"
14282 " const char *src,\n"
14283 " const char *dest);\n"
14288 #: ../src/guestfs-actions.pod:4874 ../fish/guestfish-actions.pod:3291
14290 "This moves a file from C<src> to C<dest> where C<dest> is either a "
14291 "destination filename or destination directory."
14295 #: ../src/guestfs-actions.pod:4881
14296 msgid "guestfs_ntfs_3g_probe"
14300 #: ../src/guestfs-actions.pod:4883
14304 " guestfs_ntfs_3g_probe (guestfs_h *g,\n"
14306 " const char *device);\n"
14311 #: ../src/guestfs-actions.pod:4888 ../fish/guestfish-actions.pod:3298
14313 "This command runs the L<ntfs-3g.probe(8)> command which probes an NTFS "
14314 "C<device> for mountability. (Not all NTFS volumes can be mounted read-"
14315 "write, and some cannot be mounted at all)."
14319 #: ../src/guestfs-actions.pod:4892 ../fish/guestfish-actions.pod:3302
14321 "C<rw> is a boolean flag. Set it to true if you want to test if the volume "
14322 "can be mounted read-write. Set it to false if you want to test if the "
14323 "volume can be mounted read-only."
14327 #: ../src/guestfs-actions.pod:4896 ../fish/guestfish-actions.pod:3306
14329 "The return value is an integer which C<0> if the operation would succeed, or "
14330 "some non-zero value documented in the L<ntfs-3g.probe(8)> manual page."
14334 #: ../src/guestfs-actions.pod:4902
14335 msgid "(Added in 1.0.43)"
14339 #: ../src/guestfs-actions.pod:4904
14340 msgid "guestfs_ntfsresize"
14344 #: ../src/guestfs-actions.pod:4906
14348 " guestfs_ntfsresize (guestfs_h *g,\n"
14349 " const char *device);\n"
14354 #: ../src/guestfs-actions.pod:4910 ../fish/guestfish-actions.pod:3314
14356 "This command resizes an NTFS filesystem, expanding or shrinking it to the "
14357 "size of the underlying device."
14361 #: ../src/guestfs-actions.pod:4913 ../fish/guestfish-actions.pod:3317
14363 "I<Note:> After the resize operation, the filesystem is marked as requiring a "
14364 "consistency check (for safety). You have to boot into Windows to perform "
14365 "this check and clear this condition. Furthermore, ntfsresize refuses to "
14366 "resize filesystems which have been marked in this way. So in effect it is "
14367 "not possible to call ntfsresize multiple times on a single filesystem "
14368 "without booting into Windows between each resize."
14372 #: ../src/guestfs-actions.pod:4921 ../fish/guestfish-actions.pod:3325
14373 msgid "See also L<ntfsresize(8)>."
14377 #: ../src/guestfs-actions.pod:4927
14378 msgid "guestfs_ntfsresize_size"
14382 #: ../src/guestfs-actions.pod:4929
14386 " guestfs_ntfsresize_size (guestfs_h *g,\n"
14387 " const char *device,\n"
14388 " int64_t size);\n"
14393 #: ../src/guestfs-actions.pod:4934
14395 "This command is the same as C<guestfs_ntfsresize> except that it allows you "
14396 "to specify the new size (in bytes) explicitly."
14400 #: ../src/guestfs-actions.pod:4939 ../src/guestfs-actions.pod:5375
14401 #: ../src/guestfs-actions.pod:5448 ../src/guestfs-actions.pod:5714
14402 #: ../src/guestfs-actions.pod:7320
14403 msgid "(Added in 1.3.14)"
14407 #: ../src/guestfs-actions.pod:4941
14408 msgid "guestfs_part_add"
14412 #: ../src/guestfs-actions.pod:4943
14416 " guestfs_part_add (guestfs_h *g,\n"
14417 " const char *device,\n"
14418 " const char *prlogex,\n"
14419 " int64_t startsect,\n"
14420 " int64_t endsect);\n"
14425 #: ../src/guestfs-actions.pod:4950
14427 "This command adds a partition to C<device>. If there is no partition table "
14428 "on the device, call C<guestfs_part_init> first."
14432 #: ../src/guestfs-actions.pod:4953 ../fish/guestfish-actions.pod:3341
14434 "The C<prlogex> parameter is the type of partition. Normally you should pass "
14435 "C<p> or C<primary> here, but MBR partition tables also support C<l> (or "
14436 "C<logical>) and C<e> (or C<extended>) partition types."
14440 #: ../src/guestfs-actions.pod:4958 ../fish/guestfish-actions.pod:3346
14442 "C<startsect> and C<endsect> are the start and end of the partition in "
14443 "I<sectors>. C<endsect> may be negative, which means it counts backwards "
14444 "from the end of the disk (C<-1> is the last sector)."
14448 #: ../src/guestfs-actions.pod:4962
14450 "Creating a partition which covers the whole disk is not so easy. Use "
14451 "C<guestfs_part_disk> to do that."
14455 #: ../src/guestfs-actions.pod:4967 ../src/guestfs-actions.pod:5005
14456 #: ../src/guestfs-actions.pod:5058 ../src/guestfs-actions.pod:5136
14457 #: ../src/guestfs-actions.pod:5174 ../src/guestfs-actions.pod:5193
14458 #: ../src/guestfs-actions.pod:5233
14459 msgid "(Added in 1.0.78)"
14463 #: ../src/guestfs-actions.pod:4969
14464 msgid "guestfs_part_del"
14468 #: ../src/guestfs-actions.pod:4971
14472 " guestfs_part_del (guestfs_h *g,\n"
14473 " const char *device,\n"
14479 #: ../src/guestfs-actions.pod:4976 ../fish/guestfish-actions.pod:3357
14480 msgid "This command deletes the partition numbered C<partnum> on C<device>."
14484 #: ../src/guestfs-actions.pod:4978 ../fish/guestfish-actions.pod:3359
14486 "Note that in the case of MBR partitioning, deleting an extended partition "
14487 "also deletes any logical partitions it contains."
14491 #: ../src/guestfs-actions.pod:4986
14492 msgid "guestfs_part_disk"
14496 #: ../src/guestfs-actions.pod:4988
14500 " guestfs_part_disk (guestfs_h *g,\n"
14501 " const char *device,\n"
14502 " const char *parttype);\n"
14507 #: ../src/guestfs-actions.pod:4993
14509 "This command is simply a combination of C<guestfs_part_init> followed by "
14510 "C<guestfs_part_add> to create a single primary partition covering the whole "
14515 #: ../src/guestfs-actions.pod:4997
14517 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
14518 "possible values are described in C<guestfs_part_init>."
14522 #: ../src/guestfs-actions.pod:5007
14523 msgid "guestfs_part_get_bootable"
14527 #: ../src/guestfs-actions.pod:5009
14531 " guestfs_part_get_bootable (guestfs_h *g,\n"
14532 " const char *device,\n"
14538 #: ../src/guestfs-actions.pod:5014 ../fish/guestfish-actions.pod:3381
14540 "This command returns true if the partition C<partnum> on C<device> has the "
14541 "bootable flag set."
14545 #: ../src/guestfs-actions.pod:5017
14546 msgid "See also C<guestfs_part_set_bootable>."
14550 #: ../src/guestfs-actions.pod:5023
14551 msgid "guestfs_part_get_mbr_id"
14555 #: ../src/guestfs-actions.pod:5025
14559 " guestfs_part_get_mbr_id (guestfs_h *g,\n"
14560 " const char *device,\n"
14566 #: ../src/guestfs-actions.pod:5030 ../fish/guestfish-actions.pod:3390
14568 "Returns the MBR type byte (also known as the ID byte) from the numbered "
14569 "partition C<partnum>."
14573 #: ../src/guestfs-actions.pod:5033 ../src/guestfs-actions.pod:5209
14575 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
14576 "undefined results for other partition table types (see "
14577 "C<guestfs_part_get_parttype>)."
14581 #: ../src/guestfs-actions.pod:5041
14582 msgid "guestfs_part_get_parttype"
14586 #: ../src/guestfs-actions.pod:5043
14590 " guestfs_part_get_parttype (guestfs_h *g,\n"
14591 " const char *device);\n"
14596 #: ../src/guestfs-actions.pod:5047 ../fish/guestfish-actions.pod:3401
14598 "This command examines the partition table on C<device> and returns the "
14599 "partition table type (format) being used."
14603 #: ../src/guestfs-actions.pod:5050
14605 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
14606 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
14607 "possible, although unusual. See C<guestfs_part_init> for a full list."
14611 #: ../src/guestfs-actions.pod:5060
14612 msgid "guestfs_part_init"
14616 #: ../src/guestfs-actions.pod:5062
14620 " guestfs_part_init (guestfs_h *g,\n"
14621 " const char *device,\n"
14622 " const char *parttype);\n"
14627 #: ../src/guestfs-actions.pod:5067 ../fish/guestfish-actions.pod:3413
14629 "This creates an empty partition table on C<device> of one of the partition "
14630 "types listed below. Usually C<parttype> should be either C<msdos> or C<gpt> "
14631 "(for large disks)."
14635 #: ../src/guestfs-actions.pod:5071
14637 "Initially there are no partitions. Following this, you should call "
14638 "C<guestfs_part_add> for each partition required."
14642 #: ../src/guestfs-actions.pod:5074 ../fish/guestfish-actions.pod:3420
14643 msgid "Possible values for C<parttype> are:"
14647 #: ../src/guestfs-actions.pod:5078 ../fish/guestfish-actions.pod:3424
14648 msgid "B<efi> | B<gpt>"
14652 #: ../src/guestfs-actions.pod:5080 ../fish/guestfish-actions.pod:3426
14653 msgid "Intel EFI / GPT partition table."
14657 #: ../src/guestfs-actions.pod:5082 ../fish/guestfish-actions.pod:3428
14659 "This is recommended for >= 2 TB partitions that will be accessed from Linux "
14660 "and Intel-based Mac OS X. It also has limited backwards compatibility with "
14661 "the C<mbr> format."
14665 #: ../src/guestfs-actions.pod:5086 ../fish/guestfish-actions.pod:3432
14666 msgid "B<mbr> | B<msdos>"
14670 #: ../src/guestfs-actions.pod:5088 ../fish/guestfish-actions.pod:3434
14672 "The standard PC \"Master Boot Record\" (MBR) format used by MS-DOS and "
14673 "Windows. This partition type will B<only> work for device sizes up to 2 "
14674 "TB. For large disks we recommend using C<gpt>."
14678 #: ../src/guestfs-actions.pod:5095 ../fish/guestfish-actions.pod:3441
14680 "Other partition table types that may work but are not supported include:"
14684 #: ../src/guestfs-actions.pod:5100 ../fish/guestfish-actions.pod:3446
14689 #: ../src/guestfs-actions.pod:5102 ../fish/guestfish-actions.pod:3448
14690 msgid "AIX disk labels."
14694 #: ../src/guestfs-actions.pod:5104 ../fish/guestfish-actions.pod:3450
14695 msgid "B<amiga> | B<rdb>"
14699 #: ../src/guestfs-actions.pod:5106 ../fish/guestfish-actions.pod:3452
14700 msgid "Amiga \"Rigid Disk Block\" format."
14704 #: ../src/guestfs-actions.pod:5108 ../fish/guestfish-actions.pod:3454
14709 #: ../src/guestfs-actions.pod:5110 ../fish/guestfish-actions.pod:3456
14710 msgid "BSD disk labels."
14714 #: ../src/guestfs-actions.pod:5112 ../fish/guestfish-actions.pod:3458
14719 #: ../src/guestfs-actions.pod:5114 ../fish/guestfish-actions.pod:3460
14720 msgid "DASD, used on IBM mainframes."
14724 #: ../src/guestfs-actions.pod:5116 ../fish/guestfish-actions.pod:3462
14729 #: ../src/guestfs-actions.pod:5118 ../fish/guestfish-actions.pod:3464
14730 msgid "MIPS/SGI volumes."
14734 #: ../src/guestfs-actions.pod:5120 ../fish/guestfish-actions.pod:3466
14739 #: ../src/guestfs-actions.pod:5122 ../fish/guestfish-actions.pod:3468
14740 msgid "Old Mac partition format. Modern Macs use C<gpt>."
14744 #: ../src/guestfs-actions.pod:5124 ../fish/guestfish-actions.pod:3470
14749 #: ../src/guestfs-actions.pod:5126 ../fish/guestfish-actions.pod:3472
14750 msgid "NEC PC-98 format, common in Japan apparently."
14754 #: ../src/guestfs-actions.pod:5128 ../fish/guestfish-actions.pod:3474
14759 #: ../src/guestfs-actions.pod:5130 ../fish/guestfish-actions.pod:3476
14760 msgid "Sun disk labels."
14764 #: ../src/guestfs-actions.pod:5138
14765 msgid "guestfs_part_list"
14769 #: ../src/guestfs-actions.pod:5140
14772 " struct guestfs_partition_list *\n"
14773 " guestfs_part_list (guestfs_h *g,\n"
14774 " const char *device);\n"
14779 #: ../src/guestfs-actions.pod:5144 ../fish/guestfish-actions.pod:3484
14781 "This command parses the partition table on C<device> and returns the list of "
14782 "partitions found."
14786 #: ../src/guestfs-actions.pod:5147 ../fish/guestfish-actions.pod:3487
14787 msgid "The fields in the returned structure are:"
14791 #: ../src/guestfs-actions.pod:5151 ../fish/guestfish-actions.pod:3491
14792 msgid "B<part_num>"
14796 #: ../src/guestfs-actions.pod:5153 ../fish/guestfish-actions.pod:3493
14797 msgid "Partition number, counting from 1."
14801 #: ../src/guestfs-actions.pod:5155 ../fish/guestfish-actions.pod:3495
14802 msgid "B<part_start>"
14806 #: ../src/guestfs-actions.pod:5157
14808 "Start of the partition I<in bytes>. To get sectors you have to divide by "
14809 "the device's sector size, see C<guestfs_blockdev_getss>."
14813 #: ../src/guestfs-actions.pod:5160 ../fish/guestfish-actions.pod:3500
14814 msgid "B<part_end>"
14818 #: ../src/guestfs-actions.pod:5162 ../fish/guestfish-actions.pod:3502
14819 msgid "End of the partition in bytes."
14823 #: ../src/guestfs-actions.pod:5164 ../fish/guestfish-actions.pod:3504
14824 msgid "B<part_size>"
14828 #: ../src/guestfs-actions.pod:5166 ../fish/guestfish-actions.pod:3506
14829 msgid "Size of the partition in bytes."
14833 #: ../src/guestfs-actions.pod:5170
14835 "This function returns a C<struct guestfs_partition_list *>, or NULL if there "
14836 "was an error. I<The caller must call C<guestfs_free_partition_list> after "
14841 #: ../src/guestfs-actions.pod:5176
14842 msgid "guestfs_part_set_bootable"
14846 #: ../src/guestfs-actions.pod:5178
14850 " guestfs_part_set_bootable (guestfs_h *g,\n"
14851 " const char *device,\n"
14853 " int bootable);\n"
14858 #: ../src/guestfs-actions.pod:5184 ../fish/guestfish-actions.pod:3514
14860 "This sets the bootable flag on partition numbered C<partnum> on device "
14861 "C<device>. Note that partitions are numbered from 1."
14865 #: ../src/guestfs-actions.pod:5187 ../fish/guestfish-actions.pod:3517
14867 "The bootable flag is used by some operating systems (notably Windows) to "
14868 "determine which partition to boot from. It is by no means universally "
14873 #: ../src/guestfs-actions.pod:5195
14874 msgid "guestfs_part_set_mbr_id"
14878 #: ../src/guestfs-actions.pod:5197
14882 " guestfs_part_set_mbr_id (guestfs_h *g,\n"
14883 " const char *device,\n"
14890 #: ../src/guestfs-actions.pod:5203 ../fish/guestfish-actions.pod:3525
14892 "Sets the MBR type byte (also known as the ID byte) of the numbered partition "
14893 "C<partnum> to C<idbyte>. Note that the type bytes quoted in most "
14894 "documentation are in fact hexadecimal numbers, but usually documented "
14895 "without any leading \"0x\" which might be confusing."
14899 #: ../src/guestfs-actions.pod:5217
14900 msgid "guestfs_part_set_name"
14904 #: ../src/guestfs-actions.pod:5219
14908 " guestfs_part_set_name (guestfs_h *g,\n"
14909 " const char *device,\n"
14911 " const char *name);\n"
14916 #: ../src/guestfs-actions.pod:5225 ../fish/guestfish-actions.pod:3539
14918 "This sets the partition name on partition numbered C<partnum> on device "
14919 "C<device>. Note that partitions are numbered from 1."
14923 #: ../src/guestfs-actions.pod:5228 ../fish/guestfish-actions.pod:3542
14925 "The partition name can only be set on certain types of partition table. "
14926 "This works on C<gpt> but not on C<mbr> partitions."
14930 #: ../src/guestfs-actions.pod:5235
14931 msgid "guestfs_part_to_dev"
14935 #: ../src/guestfs-actions.pod:5237
14939 " guestfs_part_to_dev (guestfs_h *g,\n"
14940 " const char *partition);\n"
14945 #: ../src/guestfs-actions.pod:5241 ../fish/guestfish-actions.pod:3549
14947 "This function takes a partition name (eg. \"/dev/sdb1\") and removes the "
14948 "partition number, returning the device name (eg. \"/dev/sdb\")."
14952 #: ../src/guestfs-actions.pod:5245
14954 "The named partition must exist, for example as a string returned from "
14955 "C<guestfs_list_partitions>."
14959 #: ../src/guestfs-actions.pod:5253
14960 msgid "guestfs_ping_daemon"
14964 #: ../src/guestfs-actions.pod:5255
14968 " guestfs_ping_daemon (guestfs_h *g);\n"
14973 #: ../src/guestfs-actions.pod:5258 ../fish/guestfish-actions.pod:3560
14975 "This is a test probe into the guestfs daemon running inside the qemu "
14976 "subprocess. Calling this function checks that the daemon responds to the "
14977 "ping message, without affecting the daemon or attached block device(s) in "
14982 #: ../src/guestfs-actions.pod:5267
14983 msgid "guestfs_pread"
14987 #: ../src/guestfs-actions.pod:5269
14991 " guestfs_pread (guestfs_h *g,\n"
14992 " const char *path,\n"
14994 " int64_t offset,\n"
14995 " size_t *size_r);\n"
15000 #: ../src/guestfs-actions.pod:5276 ../fish/guestfish-actions.pod:3569
15002 "This command lets you read part of a file. It reads C<count> bytes of the "
15003 "file, starting at C<offset>, from file C<path>."
15007 #: ../src/guestfs-actions.pod:5279 ../src/guestfs-actions.pod:5305
15008 #: ../fish/guestfish-actions.pod:3572 ../fish/guestfish-actions.pod:3587
15010 "This may read fewer bytes than requested. For further details see the "
15011 "L<pread(2)> system call."
15015 #: ../src/guestfs-actions.pod:5282
15016 msgid "See also C<guestfs_pwrite>, C<guestfs_pread_device>."
15020 #: ../src/guestfs-actions.pod:5293
15021 msgid "guestfs_pread_device"
15025 #: ../src/guestfs-actions.pod:5295
15029 " guestfs_pread_device (guestfs_h *g,\n"
15030 " const char *device,\n"
15032 " int64_t offset,\n"
15033 " size_t *size_r);\n"
15038 #: ../src/guestfs-actions.pod:5302 ../fish/guestfish-actions.pod:3584
15040 "This command lets you read part of a file. It reads C<count> bytes of "
15041 "C<device>, starting at C<offset>."
15045 #: ../src/guestfs-actions.pod:5308
15046 msgid "See also C<guestfs_pread>."
15050 #: ../src/guestfs-actions.pod:5317
15051 msgid "(Added in 1.5.21)"
15055 #: ../src/guestfs-actions.pod:5319
15056 msgid "guestfs_pvcreate"
15060 #: ../src/guestfs-actions.pod:5321
15064 " guestfs_pvcreate (guestfs_h *g,\n"
15065 " const char *device);\n"
15070 #: ../src/guestfs-actions.pod:5325 ../fish/guestfish-actions.pod:3599
15072 "This creates an LVM physical volume on the named C<device>, where C<device> "
15073 "should usually be a partition name such as C</dev/sda1>."
15077 #: ../src/guestfs-actions.pod:5333
15078 msgid "guestfs_pvremove"
15082 #: ../src/guestfs-actions.pod:5335
15086 " guestfs_pvremove (guestfs_h *g,\n"
15087 " const char *device);\n"
15092 #: ../src/guestfs-actions.pod:5339 ../fish/guestfish-actions.pod:3607
15094 "This wipes a physical volume C<device> so that LVM will no longer recognise "
15099 #: ../src/guestfs-actions.pod:5342 ../fish/guestfish-actions.pod:3610
15101 "The implementation uses the C<pvremove> command which refuses to wipe "
15102 "physical volumes that contain any volume groups, so you have to remove those "
15107 #: ../src/guestfs-actions.pod:5350
15108 msgid "guestfs_pvresize"
15112 #: ../src/guestfs-actions.pod:5352
15116 " guestfs_pvresize (guestfs_h *g,\n"
15117 " const char *device);\n"
15122 #: ../src/guestfs-actions.pod:5356 ../fish/guestfish-actions.pod:3618
15124 "This resizes (expands or shrinks) an existing LVM physical volume to match "
15125 "the new size of the underlying device."
15129 #: ../src/guestfs-actions.pod:5363
15130 msgid "guestfs_pvresize_size"
15134 #: ../src/guestfs-actions.pod:5365
15138 " guestfs_pvresize_size (guestfs_h *g,\n"
15139 " const char *device,\n"
15140 " int64_t size);\n"
15145 #: ../src/guestfs-actions.pod:5370
15147 "This command is the same as C<guestfs_pvresize> except that it allows you to "
15148 "specify the new size (in bytes) explicitly."
15152 #: ../src/guestfs-actions.pod:5377
15153 msgid "guestfs_pvs"
15157 #: ../src/guestfs-actions.pod:5379
15161 " guestfs_pvs (guestfs_h *g);\n"
15166 #: ../src/guestfs-actions.pod:5382 ../fish/guestfish-actions.pod:3632
15168 "List all the physical volumes detected. This is the equivalent of the L<pvs"
15173 #: ../src/guestfs-actions.pod:5385 ../fish/guestfish-actions.pod:3635
15175 "This returns a list of just the device names that contain PVs (eg. C</dev/"
15180 #: ../src/guestfs-actions.pod:5388
15181 msgid "See also C<guestfs_pvs_full>."
15185 #: ../src/guestfs-actions.pod:5396
15186 msgid "guestfs_pvs_full"
15190 #: ../src/guestfs-actions.pod:5398
15193 " struct guestfs_lvm_pv_list *\n"
15194 " guestfs_pvs_full (guestfs_h *g);\n"
15199 #: ../src/guestfs-actions.pod:5401 ../fish/guestfish-actions.pod:3644
15201 "List all the physical volumes detected. This is the equivalent of the L<pvs"
15202 "(8)> command. The \"full\" version includes all fields."
15206 #: ../src/guestfs-actions.pod:5404
15208 "This function returns a C<struct guestfs_lvm_pv_list *>, or NULL if there "
15209 "was an error. I<The caller must call C<guestfs_free_lvm_pv_list> after use>."
15213 #: ../src/guestfs-actions.pod:5410
15214 msgid "guestfs_pvuuid"
15218 #: ../src/guestfs-actions.pod:5412
15222 " guestfs_pvuuid (guestfs_h *g,\n"
15223 " const char *device);\n"
15228 #: ../src/guestfs-actions.pod:5416 ../fish/guestfish-actions.pod:3651
15229 msgid "This command returns the UUID of the LVM PV C<device>."
15233 #: ../src/guestfs-actions.pod:5423
15234 msgid "guestfs_pwrite"
15238 #: ../src/guestfs-actions.pod:5425
15242 " guestfs_pwrite (guestfs_h *g,\n"
15243 " const char *path,\n"
15244 " const char *content,\n"
15245 " size_t content_size,\n"
15246 " int64_t offset);\n"
15251 #: ../src/guestfs-actions.pod:5432 ../fish/guestfish-actions.pod:3657
15253 "This command writes to part of a file. It writes the data buffer C<content> "
15254 "to the file C<path> starting at offset C<offset>."
15258 #: ../src/guestfs-actions.pod:5435 ../fish/guestfish-actions.pod:3660
15260 "This command implements the L<pwrite(2)> system call, and like that system "
15261 "call it may not write the full data requested. The return value is the "
15262 "number of bytes that were actually written to the file. This could even be "
15263 "0, although short writes are unlikely for regular files in ordinary "
15268 #: ../src/guestfs-actions.pod:5441
15269 msgid "See also C<guestfs_pread>, C<guestfs_pwrite_device>."
15273 #: ../src/guestfs-actions.pod:5450
15274 msgid "guestfs_pwrite_device"
15278 #: ../src/guestfs-actions.pod:5452
15282 " guestfs_pwrite_device (guestfs_h *g,\n"
15283 " const char *device,\n"
15284 " const char *content,\n"
15285 " size_t content_size,\n"
15286 " int64_t offset);\n"
15291 #: ../src/guestfs-actions.pod:5459 ../fish/guestfish-actions.pod:3675
15293 "This command writes to part of a device. It writes the data buffer "
15294 "C<content> to C<device> starting at offset C<offset>."
15298 #: ../src/guestfs-actions.pod:5462 ../fish/guestfish-actions.pod:3678
15300 "This command implements the L<pwrite(2)> system call, and like that system "
15301 "call it may not write the full data requested (although short writes to disk "
15302 "devices and partitions are probably impossible with standard Linux kernels)."
15306 #: ../src/guestfs-actions.pod:5467
15307 msgid "See also C<guestfs_pwrite>."
15311 #: ../src/guestfs-actions.pod:5474
15312 msgid "(Added in 1.5.20)"
15316 #: ../src/guestfs-actions.pod:5476
15317 msgid "guestfs_read_file"
15321 #: ../src/guestfs-actions.pod:5478
15325 " guestfs_read_file (guestfs_h *g,\n"
15326 " const char *path,\n"
15327 " size_t *size_r);\n"
15332 #: ../src/guestfs-actions.pod:5483 ../fish/guestfish-actions.pod:3692
15333 msgid "This calls returns the contents of the file C<path> as a buffer."
15337 #: ../src/guestfs-actions.pod:5486
15339 "Unlike C<guestfs_cat>, this function can correctly handle files that contain "
15340 "embedded ASCII NUL characters. However unlike C<guestfs_download>, this "
15341 "function is limited in the total size of file that can be handled."
15345 #: ../src/guestfs-actions.pod:5498
15346 msgid "(Added in 1.0.63)"
15350 #: ../src/guestfs-actions.pod:5500
15351 msgid "guestfs_read_lines"
15355 #: ../src/guestfs-actions.pod:5502
15359 " guestfs_read_lines (guestfs_h *g,\n"
15360 " const char *path);\n"
15365 #: ../src/guestfs-actions.pod:5508 ../fish/guestfish-actions.pod:3709
15367 "The file contents are returned as a list of lines. Trailing C<LF> and "
15368 "C<CRLF> character sequences are I<not> returned."
15372 #: ../src/guestfs-actions.pod:5511
15374 "Note that this function cannot correctly handle binary files (specifically, "
15375 "files containing C<\\0> character which is treated as end of line). For "
15376 "those you need to use the C<guestfs_read_file> function which has a more "
15377 "complex interface."
15381 #: ../src/guestfs-actions.pod:5522
15382 msgid "guestfs_readdir"
15386 #: ../src/guestfs-actions.pod:5524
15389 " struct guestfs_dirent_list *\n"
15390 " guestfs_readdir (guestfs_h *g,\n"
15391 " const char *dir);\n"
15396 #: ../src/guestfs-actions.pod:5528 ../fish/guestfish-actions.pod:3721
15397 msgid "This returns the list of directory entries in directory C<dir>."
15401 #: ../src/guestfs-actions.pod:5530 ../fish/guestfish-actions.pod:3723
15403 "All entries in the directory are returned, including C<.> and C<..>. The "
15404 "entries are I<not> sorted, but returned in the same order as the underlying "
15409 #: ../src/guestfs-actions.pod:5534 ../fish/guestfish-actions.pod:3727
15411 "Also this call returns basic file type information about each file. The "
15412 "C<ftyp> field will contain one of the following characters:"
15416 #: ../src/guestfs-actions.pod:5539 ../fish/guestfish-actions.pod:3732
15421 #: ../src/guestfs-actions.pod:5541 ../fish/guestfish-actions.pod:3734
15422 msgid "Block special"
15426 #: ../src/guestfs-actions.pod:5543 ../fish/guestfish-actions.pod:3736
15431 #: ../src/guestfs-actions.pod:5545 ../fish/guestfish-actions.pod:3738
15432 msgid "Char special"
15436 #: ../src/guestfs-actions.pod:5547 ../fish/guestfish-actions.pod:3740
15441 #: ../src/guestfs-actions.pod:5549 ../fish/guestfish-actions.pod:3742
15446 #: ../src/guestfs-actions.pod:5551 ../fish/guestfish-actions.pod:3744
15451 #: ../src/guestfs-actions.pod:5553 ../fish/guestfish-actions.pod:3746
15452 msgid "FIFO (named pipe)"
15456 #: ../src/guestfs-actions.pod:5555 ../fish/guestfish-actions.pod:3748
15461 #: ../src/guestfs-actions.pod:5557 ../fish/guestfish-actions.pod:3750
15462 msgid "Symbolic link"
15466 #: ../src/guestfs-actions.pod:5559 ../fish/guestfish-actions.pod:3752
15471 #: ../src/guestfs-actions.pod:5561 ../fish/guestfish-actions.pod:3754
15472 msgid "Regular file"
15476 #: ../src/guestfs-actions.pod:5563 ../fish/guestfish-actions.pod:3756
15481 #: ../src/guestfs-actions.pod:5565 ../fish/guestfish-actions.pod:3758
15486 #: ../src/guestfs-actions.pod:5567 ../fish/guestfish-actions.pod:3760
15491 #: ../src/guestfs-actions.pod:5569 ../fish/guestfish-actions.pod:3762
15492 msgid "Unknown file type"
15496 #: ../src/guestfs-actions.pod:5571 ../fish/guestfish-actions.pod:3764
15501 #: ../src/guestfs-actions.pod:5573 ../fish/guestfish-actions.pod:3766
15503 "The L<readdir(3)> call returned a C<d_type> field with an unexpected value"
15507 #: ../src/guestfs-actions.pod:5578
15509 "This function is primarily intended for use by programs. To get a simple "
15510 "list of names, use C<guestfs_ls>. To get a printable directory for human "
15511 "consumption, use C<guestfs_ll>."
15515 #: ../src/guestfs-actions.pod:5582
15517 "This function returns a C<struct guestfs_dirent_list *>, or NULL if there "
15518 "was an error. I<The caller must call C<guestfs_free_dirent_list> after use>."
15522 #: ../src/guestfs-actions.pod:5588
15523 msgid "guestfs_readlink"
15527 #: ../src/guestfs-actions.pod:5590
15531 " guestfs_readlink (guestfs_h *g,\n"
15532 " const char *path);\n"
15537 #: ../src/guestfs-actions.pod:5594 ../fish/guestfish-actions.pod:3779
15538 msgid "This command reads the target of a symbolic link."
15542 #: ../src/guestfs-actions.pod:5601
15543 msgid "guestfs_readlinklist"
15547 #: ../src/guestfs-actions.pod:5603
15551 " guestfs_readlinklist (guestfs_h *g,\n"
15552 " const char *path,\n"
15553 " char *const *names);\n"
15558 #: ../src/guestfs-actions.pod:5608 ../fish/guestfish-actions.pod:3785
15560 "This call allows you to do a C<readlink> operation on multiple files, where "
15561 "all files are in the directory C<path>. C<names> is the list of files from "
15566 #: ../src/guestfs-actions.pod:5612 ../fish/guestfish-actions.pod:3789
15568 "On return you get a list of strings, with a one-to-one correspondence to the "
15569 "C<names> list. Each string is the value of the symbolic link."
15573 #: ../src/guestfs-actions.pod:5616 ../fish/guestfish-actions.pod:3793
15575 "If the C<readlink(2)> operation fails on any name, then the corresponding "
15576 "result string is the empty string C<\"\">. However the whole operation is "
15577 "completed even if there were C<readlink(2)> errors, and so you can call this "
15578 "function with names where you don't know if they are symbolic links already "
15579 "(albeit slightly less efficient)."
15583 #: ../src/guestfs-actions.pod:5623 ../fish/guestfish-actions.pod:3800
15585 "This call is intended for programs that want to efficiently list a directory "
15586 "contents without making many round-trips. Very long directory listings "
15587 "might cause the protocol message size to be exceeded, causing this call to "
15588 "fail. The caller must split up such requests into smaller groups of names."
15592 #: ../src/guestfs-actions.pod:5636
15593 msgid "guestfs_realpath"
15597 #: ../src/guestfs-actions.pod:5638
15601 " guestfs_realpath (guestfs_h *g,\n"
15602 " const char *path);\n"
15607 #: ../src/guestfs-actions.pod:5642 ../fish/guestfish-actions.pod:3811
15609 "Return the canonicalized absolute pathname of C<path>. The returned path "
15610 "has no C<.>, C<..> or symbolic link path elements."
15614 #: ../src/guestfs-actions.pod:5650
15615 msgid "guestfs_removexattr"
15619 #: ../src/guestfs-actions.pod:5652
15623 " guestfs_removexattr (guestfs_h *g,\n"
15624 " const char *xattr,\n"
15625 " const char *path);\n"
15630 #: ../src/guestfs-actions.pod:5657 ../fish/guestfish-actions.pod:3818
15632 "This call removes the extended attribute named C<xattr> of the file C<path>."
15636 #: ../src/guestfs-actions.pod:5660
15637 msgid "See also: C<guestfs_lremovexattr>, L<attr(5)>."
15641 #: ../src/guestfs-actions.pod:5666
15642 msgid "guestfs_resize2fs"
15646 #: ../src/guestfs-actions.pod:5668
15650 " guestfs_resize2fs (guestfs_h *g,\n"
15651 " const char *device);\n"
15656 #: ../src/guestfs-actions.pod:5672 ../fish/guestfish-actions.pod:3827
15658 "This resizes an ext2, ext3 or ext4 filesystem to match the size of the "
15659 "underlying device."
15663 #: ../src/guestfs-actions.pod:5675
15665 "I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f> on the "
15666 "C<device> before calling this command. For unknown reasons C<resize2fs> "
15667 "sometimes gives an error about this and sometimes not. In any case, it is "
15668 "always safe to call C<guestfs_e2fsck_f> before calling this function."
15672 #: ../src/guestfs-actions.pod:5685
15673 msgid "guestfs_resize2fs_M"
15677 #: ../src/guestfs-actions.pod:5687
15681 " guestfs_resize2fs_M (guestfs_h *g,\n"
15682 " const char *device);\n"
15687 #: ../src/guestfs-actions.pod:5691
15689 "This command is the same as C<guestfs_resize2fs>, but the filesystem is "
15690 "resized to its minimum size. This works like the I<-M> option to the "
15691 "C<resize2fs> command."
15695 #: ../src/guestfs-actions.pod:5695
15697 "To get the resulting size of the filesystem you should call "
15698 "C<guestfs_tune2fs_l> and read the C<Block size> and C<Block count> values. "
15699 "These two numbers, multiplied together, give the resulting size of the "
15700 "minimal filesystem in bytes."
15704 #: ../src/guestfs-actions.pod:5702
15705 msgid "guestfs_resize2fs_size"
15709 #: ../src/guestfs-actions.pod:5704
15713 " guestfs_resize2fs_size (guestfs_h *g,\n"
15714 " const char *device,\n"
15715 " int64_t size);\n"
15720 #: ../src/guestfs-actions.pod:5709
15722 "This command is the same as C<guestfs_resize2fs> except that it allows you "
15723 "to specify the new size (in bytes) explicitly."
15727 #: ../src/guestfs-actions.pod:5716
15732 #: ../src/guestfs-actions.pod:5718
15736 " guestfs_rm (guestfs_h *g,\n"
15737 " const char *path);\n"
15742 #: ../src/guestfs-actions.pod:5722 ../fish/guestfish-actions.pod:3860
15743 msgid "Remove the single file C<path>."
15747 #: ../src/guestfs-actions.pod:5728
15748 msgid "guestfs_rm_rf"
15752 #: ../src/guestfs-actions.pod:5730
15756 " guestfs_rm_rf (guestfs_h *g,\n"
15757 " const char *path);\n"
15762 #: ../src/guestfs-actions.pod:5734 ../fish/guestfish-actions.pod:3866
15764 "Remove the file or directory C<path>, recursively removing the contents if "
15765 "its a directory. This is like the C<rm -rf> shell command."
15769 #: ../src/guestfs-actions.pod:5742
15770 msgid "guestfs_rmdir"
15774 #: ../src/guestfs-actions.pod:5744
15778 " guestfs_rmdir (guestfs_h *g,\n"
15779 " const char *path);\n"
15784 #: ../src/guestfs-actions.pod:5748 ../fish/guestfish-actions.pod:3874
15785 msgid "Remove the single directory C<path>."
15789 #: ../src/guestfs-actions.pod:5754
15790 msgid "guestfs_rmmountpoint"
15794 #: ../src/guestfs-actions.pod:5756
15798 " guestfs_rmmountpoint (guestfs_h *g,\n"
15799 " const char *exemptpath);\n"
15804 #: ../src/guestfs-actions.pod:5760
15806 "This calls removes a mountpoint that was previously created with "
15807 "C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint> for full details."
15811 #: ../src/guestfs-actions.pod:5768
15812 msgid "guestfs_scrub_device"
15816 #: ../src/guestfs-actions.pod:5770
15820 " guestfs_scrub_device (guestfs_h *g,\n"
15821 " const char *device);\n"
15826 #: ../src/guestfs-actions.pod:5774 ../fish/guestfish-actions.pod:3888
15828 "This command writes patterns over C<device> to make data retrieval more "
15833 #: ../src/guestfs-actions.pod:5777 ../src/guestfs-actions.pod:5798
15834 #: ../src/guestfs-actions.pod:5817 ../fish/guestfish-actions.pod:3891
15835 #: ../fish/guestfish-actions.pod:3906 ../fish/guestfish-actions.pod:3919
15837 "It is an interface to the L<scrub(1)> program. See that manual page for "
15842 #: ../src/guestfs-actions.pod:5785 ../src/guestfs-actions.pod:5803
15843 #: ../src/guestfs-actions.pod:5822
15844 msgid "(Added in 1.0.52)"
15848 #: ../src/guestfs-actions.pod:5787
15849 msgid "guestfs_scrub_file"
15853 #: ../src/guestfs-actions.pod:5789
15857 " guestfs_scrub_file (guestfs_h *g,\n"
15858 " const char *file);\n"
15863 #: ../src/guestfs-actions.pod:5793 ../fish/guestfish-actions.pod:3901
15865 "This command writes patterns over a file to make data retrieval more "
15870 #: ../src/guestfs-actions.pod:5796 ../fish/guestfish-actions.pod:3904
15871 msgid "The file is I<removed> after scrubbing."
15875 #: ../src/guestfs-actions.pod:5805
15876 msgid "guestfs_scrub_freespace"
15880 #: ../src/guestfs-actions.pod:5807
15884 " guestfs_scrub_freespace (guestfs_h *g,\n"
15885 " const char *dir);\n"
15890 #: ../src/guestfs-actions.pod:5811
15892 "This command creates the directory C<dir> and then fills it with files until "
15893 "the filesystem is full, and scrubs the files as for C<guestfs_scrub_file>, "
15894 "and deletes them. The intention is to scrub any free space on the partition "
15895 "containing C<dir>."
15899 #: ../src/guestfs-actions.pod:5824
15900 msgid "guestfs_set_append"
15904 #: ../src/guestfs-actions.pod:5826
15908 " guestfs_set_append (guestfs_h *g,\n"
15909 " const char *append);\n"
15914 #: ../src/guestfs-actions.pod:5830 ../fish/guestfish-actions.pod:3928
15916 "This function is used to add additional options to the guest kernel command "
15921 #: ../src/guestfs-actions.pod:5833 ../fish/guestfish-actions.pod:3931
15923 "The default is C<NULL> unless overridden by setting C<LIBGUESTFS_APPEND> "
15924 "environment variable."
15928 #: ../src/guestfs-actions.pod:5836 ../fish/guestfish-actions.pod:3934
15930 "Setting C<append> to C<NULL> means I<no> additional options are passed "
15931 "(libguestfs always adds a few of its own)."
15935 #: ../src/guestfs-actions.pod:5843
15936 msgid "guestfs_set_attach_method"
15940 #: ../src/guestfs-actions.pod:5845
15944 " guestfs_set_attach_method (guestfs_h *g,\n"
15945 " const char *attachmethod);\n"
15950 #: ../src/guestfs-actions.pod:5849 ../fish/guestfish-actions.pod:3943
15952 "Set the method that libguestfs uses to connect to the back end guestfsd "
15953 "daemon. Possible methods are:"
15957 #: ../src/guestfs-actions.pod:5856 ../fish/guestfish-actions.pod:3950
15959 "Launch an appliance and connect to it. This is the ordinary method and the "
15964 #: ../src/guestfs-actions.pod:5859 ../fish/guestfish-actions.pod:3953
15965 msgid "C<unix:I<path>>"
15969 #: ../src/guestfs-actions.pod:5861 ../fish/guestfish-actions.pod:3955
15970 msgid "Connect to the Unix domain socket I<path>."
15974 #: ../src/guestfs-actions.pod:5863 ../fish/guestfish-actions.pod:3957
15976 "This method lets you connect to an existing daemon or (using virtio-serial) "
15977 "to a live guest. For more information, see L<guestfs(3)/ATTACHING TO "
15978 "RUNNING DAEMONS>."
15982 #: ../src/guestfs-actions.pod:5871
15983 msgid "guestfs_set_autosync"
15987 #: ../src/guestfs-actions.pod:5873
15991 " guestfs_set_autosync (guestfs_h *g,\n"
15992 " int autosync);\n"
15997 #: ../src/guestfs-actions.pod:5877 ../fish/guestfish-actions.pod:3969
15999 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
16000 "effort attempt to make filesystems consistent and synchronized when the "
16001 "handle is closed (also if the program exits without closing handles)."
16005 #: ../src/guestfs-actions.pod:5882 ../fish/guestfish-actions.pod:3974
16007 "This is enabled by default (since libguestfs 1.5.24, previously it was "
16008 "disabled by default)."
16012 #: ../src/guestfs-actions.pod:5889
16013 msgid "guestfs_set_direct"
16017 #: ../src/guestfs-actions.pod:5891
16021 " guestfs_set_direct (guestfs_h *g,\n"
16027 #: ../src/guestfs-actions.pod:5895 ../fish/guestfish-actions.pod:3983
16029 "If the direct appliance mode flag is enabled, then stdin and stdout are "
16030 "passed directly through to the appliance once it is launched."
16034 #: ../src/guestfs-actions.pod:5899
16036 "One consequence of this is that log messages aren't caught by the library "
16037 "and handled by C<guestfs_set_log_message_callback>, but go straight to "
16042 #: ../src/guestfs-actions.pod:5903 ../fish/guestfish-actions.pod:3991
16043 msgid "You probably don't want to use this unless you know what you are doing."
16047 #: ../src/guestfs-actions.pod:5906 ../fish/guestfish-actions.pod:3994
16048 msgid "The default is disabled."
16052 #: ../src/guestfs-actions.pod:5912
16053 msgid "guestfs_set_e2label"
16057 #: ../src/guestfs-actions.pod:5914
16061 " guestfs_set_e2label (guestfs_h *g,\n"
16062 " const char *device,\n"
16063 " const char *label);\n"
16068 #: ../src/guestfs-actions.pod:5919 ../fish/guestfish-actions.pod:4000
16070 "This sets the ext2/3/4 filesystem label of the filesystem on C<device> to "
16071 "C<label>. Filesystem labels are limited to 16 characters."
16075 #: ../src/guestfs-actions.pod:5923
16077 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label> to return "
16078 "the existing label on a filesystem."
16082 #: ../src/guestfs-actions.pod:5930
16083 msgid "guestfs_set_e2uuid"
16087 #: ../src/guestfs-actions.pod:5932
16091 " guestfs_set_e2uuid (guestfs_h *g,\n"
16092 " const char *device,\n"
16093 " const char *uuid);\n"
16098 #: ../src/guestfs-actions.pod:5937 ../fish/guestfish-actions.pod:4011
16100 "This sets the ext2/3/4 filesystem UUID of the filesystem on C<device> to "
16101 "C<uuid>. The format of the UUID and alternatives such as C<clear>, "
16102 "C<random> and C<time> are described in the L<tune2fs(8)> manpage."
16106 #: ../src/guestfs-actions.pod:5942
16108 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid> to return "
16109 "the existing UUID of a filesystem."
16113 #: ../src/guestfs-actions.pod:5949
16114 msgid "guestfs_set_memsize"
16118 #: ../src/guestfs-actions.pod:5951
16122 " guestfs_set_memsize (guestfs_h *g,\n"
16128 #: ../src/guestfs-actions.pod:5955
16130 "This sets the memory size in megabytes allocated to the qemu subprocess. "
16131 "This only has any effect if called before C<guestfs_launch>."
16135 #: ../src/guestfs-actions.pod:5959 ../fish/guestfish-actions.pod:4029
16137 "You can also change this by setting the environment variable "
16138 "C<LIBGUESTFS_MEMSIZE> before the handle is created."
16142 #: ../src/guestfs-actions.pod:5970
16143 msgid "guestfs_set_network"
16147 #: ../src/guestfs-actions.pod:5972
16151 " guestfs_set_network (guestfs_h *g,\n"
16157 #: ../src/guestfs-actions.pod:5976 ../fish/guestfish-actions.pod:4042
16159 "If C<network> is true, then the network is enabled in the libguestfs "
16160 "appliance. The default is false."
16164 #: ../src/guestfs-actions.pod:5979 ../fish/guestfish-actions.pod:4045
16166 "This affects whether commands are able to access the network (see L<guestfs"
16167 "(3)/RUNNING COMMANDS>)."
16171 #: ../src/guestfs-actions.pod:5982
16173 "You must call this before calling C<guestfs_launch>, otherwise it has no "
16178 #: ../src/guestfs-actions.pod:5989
16179 msgid "guestfs_set_path"
16183 #: ../src/guestfs-actions.pod:5991
16187 " guestfs_set_path (guestfs_h *g,\n"
16188 " const char *searchpath);\n"
16193 #: ../src/guestfs-actions.pod:5995 ../fish/guestfish-actions.pod:4057
16194 msgid "Set the path that libguestfs searches for kernel and initrd.img."
16198 #: ../src/guestfs-actions.pod:5997 ../fish/guestfish-actions.pod:4059
16200 "The default is C<$libdir/guestfs> unless overridden by setting "
16201 "C<LIBGUESTFS_PATH> environment variable."
16205 #: ../src/guestfs-actions.pod:6000 ../fish/guestfish-actions.pod:4062
16206 msgid "Setting C<path> to C<NULL> restores the default path."
16210 #: ../src/guestfs-actions.pod:6006
16211 msgid "guestfs_set_qemu"
16215 #: ../src/guestfs-actions.pod:6008
16219 " guestfs_set_qemu (guestfs_h *g,\n"
16220 " const char *qemu);\n"
16225 #: ../src/guestfs-actions.pod:6012 ../fish/guestfish-actions.pod:4070
16226 msgid "Set the qemu binary that we will use."
16230 #: ../src/guestfs-actions.pod:6014 ../fish/guestfish-actions.pod:4072
16232 "The default is chosen when the library was compiled by the configure script."
16236 #: ../src/guestfs-actions.pod:6017 ../fish/guestfish-actions.pod:4075
16238 "You can also override this by setting the C<LIBGUESTFS_QEMU> environment "
16243 #: ../src/guestfs-actions.pod:6020 ../fish/guestfish-actions.pod:4078
16244 msgid "Setting C<qemu> to C<NULL> restores the default qemu binary."
16248 #: ../src/guestfs-actions.pod:6022 ../fish/guestfish-actions.pod:4080
16250 "Note that you should call this function as early as possible after creating "
16251 "the handle. This is because some pre-launch operations depend on testing "
16252 "qemu features (by running C<qemu -help>). If the qemu binary changes, we "
16253 "don't retest features, and so you might see inconsistent results. Using the "
16254 "environment variable C<LIBGUESTFS_QEMU> is safest of all since that picks "
16255 "the qemu binary at the same time as the handle is created."
16259 #: ../src/guestfs-actions.pod:6034
16260 msgid "guestfs_set_recovery_proc"
16264 #: ../src/guestfs-actions.pod:6036
16268 " guestfs_set_recovery_proc (guestfs_h *g,\n"
16269 " int recoveryproc);\n"
16274 #: ../src/guestfs-actions.pod:6040
16276 "If this is called with the parameter C<false> then C<guestfs_launch> does "
16277 "not create a recovery process. The purpose of the recovery process is to "
16278 "stop runaway qemu processes in the case where the main program aborts "
16283 #: ../src/guestfs-actions.pod:6045
16285 "This only has any effect if called before C<guestfs_launch>, and the default "
16290 #: ../src/guestfs-actions.pod:6048 ../fish/guestfish-actions.pod:4102
16292 "About the only time when you would want to disable this is if the main "
16293 "process will fork itself into the background (\"daemonize\" itself). In "
16294 "this case the recovery process thinks that the main program has disappeared "
16295 "and so kills qemu, which is not very helpful."
16299 #: ../src/guestfs-actions.pod:6058
16300 msgid "guestfs_set_selinux"
16304 #: ../src/guestfs-actions.pod:6060
16308 " guestfs_set_selinux (guestfs_h *g,\n"
16314 #: ../src/guestfs-actions.pod:6064 ../fish/guestfish-actions.pod:4114
16316 "This sets the selinux flag that is passed to the appliance at boot time. "
16317 "The default is C<selinux=0> (disabled)."
16321 #: ../src/guestfs-actions.pod:6067 ../fish/guestfish-actions.pod:4117
16323 "Note that if SELinux is enabled, it is always in Permissive mode "
16324 "(C<enforcing=0>)."
16328 #: ../src/guestfs-actions.pod:6077
16329 msgid "guestfs_set_trace"
16333 #: ../src/guestfs-actions.pod:6079
16337 " guestfs_set_trace (guestfs_h *g,\n"
16343 #: ../src/guestfs-actions.pod:6083 ../fish/guestfish-actions.pod:4129
16345 "If the command trace flag is set to 1, then libguestfs calls, parameters and "
16346 "return values are traced."
16350 #: ../src/guestfs-actions.pod:6086 ../fish/guestfish-actions.pod:4132
16352 "If you want to trace C API calls into libguestfs (and other libraries) then "
16353 "possibly a better way is to use the external ltrace(1) command."
16357 #: ../src/guestfs-actions.pod:6090 ../fish/guestfish-actions.pod:4136
16359 "Command traces are disabled unless the environment variable "
16360 "C<LIBGUESTFS_TRACE> is defined and set to C<1>."
16364 #: ../src/guestfs-actions.pod:6093
16366 "Trace messages are normally sent to C<stderr>, unless you register a "
16367 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
16371 #: ../src/guestfs-actions.pod:6101
16372 msgid "guestfs_set_verbose"
16376 #: ../src/guestfs-actions.pod:6103
16380 " guestfs_set_verbose (guestfs_h *g,\n"
16386 #: ../src/guestfs-actions.pod:6107 ../fish/guestfish-actions.pod:4149
16387 msgid "If C<verbose> is true, this turns on verbose messages."
16391 #: ../src/guestfs-actions.pod:6109 ../fish/guestfish-actions.pod:4151
16393 "Verbose messages are disabled unless the environment variable "
16394 "C<LIBGUESTFS_DEBUG> is defined and set to C<1>."
16398 #: ../src/guestfs-actions.pod:6112
16400 "Verbose messages are normally sent to C<stderr>, unless you register a "
16401 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
16405 #: ../src/guestfs-actions.pod:6120
16406 msgid "guestfs_setcon"
16410 #: ../src/guestfs-actions.pod:6122
16414 " guestfs_setcon (guestfs_h *g,\n"
16415 " const char *context);\n"
16420 #: ../src/guestfs-actions.pod:6126 ../fish/guestfish-actions.pod:4162
16422 "This sets the SELinux security context of the daemon to the string "
16427 #: ../src/guestfs-actions.pod:6129 ../fish/guestfish-actions.pod:4165
16428 msgid "See the documentation about SELINUX in L<guestfs(3)>."
16432 #: ../src/guestfs-actions.pod:6135
16433 msgid "guestfs_setxattr"
16437 #: ../src/guestfs-actions.pod:6137
16441 " guestfs_setxattr (guestfs_h *g,\n"
16442 " const char *xattr,\n"
16443 " const char *val,\n"
16445 " const char *path);\n"
16450 #: ../src/guestfs-actions.pod:6144 ../fish/guestfish-actions.pod:4171
16452 "This call sets the extended attribute named C<xattr> of the file C<path> to "
16453 "the value C<val> (of length C<vallen>). The value is arbitrary 8 bit data."
16457 #: ../src/guestfs-actions.pod:6148
16458 msgid "See also: C<guestfs_lsetxattr>, L<attr(5)>."
16462 #: ../src/guestfs-actions.pod:6154
16463 msgid "guestfs_sfdisk"
16467 #: ../src/guestfs-actions.pod:6156
16471 " guestfs_sfdisk (guestfs_h *g,\n"
16472 " const char *device,\n"
16476 " char *const *lines);\n"
16481 #: ../src/guestfs-actions.pod:6164 ../fish/guestfish-actions.pod:4181
16483 "This is a direct interface to the L<sfdisk(8)> program for creating "
16484 "partitions on block devices."
16488 #: ../src/guestfs-actions.pod:6167 ../fish/guestfish-actions.pod:4184
16489 msgid "C<device> should be a block device, for example C</dev/sda>."
16493 #: ../src/guestfs-actions.pod:6169 ../fish/guestfish-actions.pod:4186
16495 "C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads and "
16496 "sectors on the device, which are passed directly to sfdisk as the I<-C>, I<-"
16497 "H> and I<-S> parameters. If you pass C<0> for any of these, then the "
16498 "corresponding parameter is omitted. Usually for 'large' disks, you can just "
16499 "pass C<0> for these, but for small (floppy-sized) disks, sfdisk (or rather, "
16500 "the kernel) cannot work out the right geometry and you will need to tell it."
16504 #: ../src/guestfs-actions.pod:6177 ../fish/guestfish-actions.pod:4194
16506 "C<lines> is a list of lines that we feed to C<sfdisk>. For more information "
16507 "refer to the L<sfdisk(8)> manpage."
16511 #: ../src/guestfs-actions.pod:6180 ../fish/guestfish-actions.pod:4197
16513 "To create a single partition occupying the whole disk, you would pass "
16514 "C<lines> as a single element list, when the single element being the string "
16519 #: ../src/guestfs-actions.pod:6184
16521 "See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>, C<guestfs_part_init>"
16525 #: ../src/guestfs-actions.pod:6192 ../src/guestfs-actions.pod:6222
16526 #: ../src/guestfs-actions.pod:6255
16528 "This function is deprecated. In new code, use the L</guestfs_part_add> call "
16533 #: ../src/guestfs-actions.pod:6201
16534 msgid "guestfs_sfdiskM"
16538 #: ../src/guestfs-actions.pod:6203
16542 " guestfs_sfdiskM (guestfs_h *g,\n"
16543 " const char *device,\n"
16544 " char *const *lines);\n"
16549 #: ../src/guestfs-actions.pod:6208
16551 "This is a simplified interface to the C<guestfs_sfdisk> command, where "
16552 "partition sizes are specified in megabytes only (rounded to the nearest "
16553 "cylinder) and you don't need to specify the cyls, heads and sectors "
16554 "parameters which were rarely if ever used anyway."
16558 #: ../src/guestfs-actions.pod:6214
16560 "See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage and "
16561 "C<guestfs_part_disk>"
16565 #: ../src/guestfs-actions.pod:6231
16566 msgid "guestfs_sfdisk_N"
16570 #: ../src/guestfs-actions.pod:6233
16574 " guestfs_sfdisk_N (guestfs_h *g,\n"
16575 " const char *device,\n"
16580 " const char *line);\n"
16585 #: ../src/guestfs-actions.pod:6242 ../fish/guestfish-actions.pod:4241
16587 "This runs L<sfdisk(8)> option to modify just the single partition C<n> "
16588 "(note: C<n> counts from 1)."
16592 #: ../src/guestfs-actions.pod:6245
16594 "For other parameters, see C<guestfs_sfdisk>. You should usually pass C<0> "
16595 "for the cyls/heads/sectors parameters."
16599 #: ../src/guestfs-actions.pod:6248
16600 msgid "See also: C<guestfs_part_add>"
16604 #: ../src/guestfs-actions.pod:6264
16605 msgid "guestfs_sfdisk_disk_geometry"
16609 #: ../src/guestfs-actions.pod:6266
16613 " guestfs_sfdisk_disk_geometry (guestfs_h *g,\n"
16614 " const char *device);\n"
16619 #: ../src/guestfs-actions.pod:6270
16621 "This displays the disk geometry of C<device> read from the partition table. "
16622 "Especially in the case where the underlying block device has been resized, "
16623 "this can be different from the kernel's idea of the geometry (see "
16624 "C<guestfs_sfdisk_kernel_geometry>)."
16628 #: ../src/guestfs-actions.pod:6275 ../src/guestfs-actions.pod:6291
16629 #: ../fish/guestfish-actions.pod:4268 ../fish/guestfish-actions.pod:4277
16630 msgid "The result is in human-readable format, and not designed to be parsed."
16634 #: ../src/guestfs-actions.pod:6283
16635 msgid "guestfs_sfdisk_kernel_geometry"
16639 #: ../src/guestfs-actions.pod:6285
16643 " guestfs_sfdisk_kernel_geometry (guestfs_h *g,\n"
16644 " const char *device);\n"
16649 #: ../src/guestfs-actions.pod:6289 ../fish/guestfish-actions.pod:4275
16650 msgid "This displays the kernel's idea of the geometry of C<device>."
16654 #: ../src/guestfs-actions.pod:6299
16655 msgid "guestfs_sfdisk_l"
16659 #: ../src/guestfs-actions.pod:6301
16663 " guestfs_sfdisk_l (guestfs_h *g,\n"
16664 " const char *device);\n"
16669 #: ../src/guestfs-actions.pod:6305 ../fish/guestfish-actions.pod:4284
16671 "This displays the partition table on C<device>, in the human-readable output "
16672 "of the L<sfdisk(8)> command. It is not intended to be parsed."
16676 #: ../src/guestfs-actions.pod:6309
16677 msgid "See also: C<guestfs_part_list>"
16681 #: ../src/guestfs-actions.pod:6314
16683 "This function is deprecated. In new code, use the L</guestfs_part_list> "
16688 #: ../src/guestfs-actions.pod:6323
16693 #: ../src/guestfs-actions.pod:6325
16697 " guestfs_sh (guestfs_h *g,\n"
16698 " const char *command);\n"
16703 #: ../src/guestfs-actions.pod:6329 ../fish/guestfish-actions.pod:4301
16705 "This call runs a command from the guest filesystem via the guest's C</bin/"
16710 #: ../src/guestfs-actions.pod:6332
16711 msgid "This is like C<guestfs_command>, but passes the command to:"
16715 #: ../src/guestfs-actions.pod:6334 ../fish/guestfish-actions.pod:4306
16718 " /bin/sh -c \"command\"\n"
16723 #: ../src/guestfs-actions.pod:6336 ../fish/guestfish-actions.pod:4308
16725 "Depending on the guest's shell, this usually results in wildcards being "
16726 "expanded, shell expressions being interpolated and so on."
16730 #: ../src/guestfs-actions.pod:6340
16731 msgid "All the provisos about C<guestfs_command> apply to this call."
16735 #: ../src/guestfs-actions.pod:6347
16736 msgid "guestfs_sh_lines"
16740 #: ../src/guestfs-actions.pod:6349
16744 " guestfs_sh_lines (guestfs_h *g,\n"
16745 " const char *command);\n"
16750 #: ../src/guestfs-actions.pod:6353
16752 "This is the same as C<guestfs_sh>, but splits the result into a list of "
16757 #: ../src/guestfs-actions.pod:6356
16758 msgid "See also: C<guestfs_command_lines>"
16762 #: ../src/guestfs-actions.pod:6364
16763 msgid "guestfs_sleep"
16767 #: ../src/guestfs-actions.pod:6366
16771 " guestfs_sleep (guestfs_h *g,\n"
16777 #: ../src/guestfs-actions.pod:6370 ../fish/guestfish-actions.pod:4327
16778 msgid "Sleep for C<secs> seconds."
16782 #: ../src/guestfs-actions.pod:6374
16783 msgid "(Added in 1.0.41)"
16787 #: ../src/guestfs-actions.pod:6376 ../src/guestfs-structs.pod:109
16788 msgid "guestfs_stat"
16792 #: ../src/guestfs-actions.pod:6378
16795 " struct guestfs_stat *\n"
16796 " guestfs_stat (guestfs_h *g,\n"
16797 " const char *path);\n"
16802 #: ../src/guestfs-actions.pod:6384 ../fish/guestfish-actions.pod:4335
16803 msgid "This is the same as the C<stat(2)> system call."
16807 #: ../src/guestfs-actions.pod:6392 ../src/guestfs-structs.pod:135
16808 msgid "guestfs_statvfs"
16812 #: ../src/guestfs-actions.pod:6394
16815 " struct guestfs_statvfs *\n"
16816 " guestfs_statvfs (guestfs_h *g,\n"
16817 " const char *path);\n"
16822 #: ../src/guestfs-actions.pod:6398 ../fish/guestfish-actions.pod:4341
16824 "Returns file system statistics for any mounted file system. C<path> should "
16825 "be a file or directory in the mounted file system (typically it is the mount "
16826 "point itself, but it doesn't need to be)."
16830 #: ../src/guestfs-actions.pod:6402 ../fish/guestfish-actions.pod:4345
16831 msgid "This is the same as the C<statvfs(2)> system call."
16835 #: ../src/guestfs-actions.pod:6404
16837 "This function returns a C<struct guestfs_statvfs *>, or NULL if there was an "
16838 "error. I<The caller must call C<guestfs_free_statvfs> after use>."
16842 #: ../src/guestfs-actions.pod:6410
16843 msgid "guestfs_strings"
16847 #: ../src/guestfs-actions.pod:6412
16851 " guestfs_strings (guestfs_h *g,\n"
16852 " const char *path);\n"
16857 #: ../src/guestfs-actions.pod:6416 ../fish/guestfish-actions.pod:4351
16859 "This runs the L<strings(1)> command on a file and returns the list of "
16860 "printable strings found."
16864 #: ../src/guestfs-actions.pod:6428
16865 msgid "guestfs_strings_e"
16869 #: ../src/guestfs-actions.pod:6430
16873 " guestfs_strings_e (guestfs_h *g,\n"
16874 " const char *encoding,\n"
16875 " const char *path);\n"
16880 #: ../src/guestfs-actions.pod:6435
16882 "This is like the C<guestfs_strings> command, but allows you to specify the "
16883 "encoding of strings that are looked for in the source file C<path>."
16887 #: ../src/guestfs-actions.pod:6439 ../fish/guestfish-actions.pod:4365
16888 msgid "Allowed encodings are:"
16892 #: ../src/guestfs-actions.pod:6443 ../fish/guestfish-actions.pod:4369
16897 #: ../src/guestfs-actions.pod:6445
16899 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
16900 "ISO-8859-X (this is what C<guestfs_strings> uses)."
16904 #: ../src/guestfs-actions.pod:6448 ../fish/guestfish-actions.pod:4374
16909 #: ../src/guestfs-actions.pod:6450 ../fish/guestfish-actions.pod:4376
16910 msgid "Single 8-bit-byte characters."
16914 #: ../src/guestfs-actions.pod:6452 ../fish/guestfish-actions.pod:4378
16919 #: ../src/guestfs-actions.pod:6454 ../fish/guestfish-actions.pod:4380
16920 msgid "16-bit big endian strings such as those encoded in UTF-16BE or UCS-2BE."
16924 #: ../src/guestfs-actions.pod:6457 ../fish/guestfish-actions.pod:4383
16925 msgid "l (lower case letter L)"
16929 #: ../src/guestfs-actions.pod:6459 ../fish/guestfish-actions.pod:4385
16931 "16-bit little endian such as UTF-16LE and UCS-2LE. This is useful for "
16932 "examining binaries in Windows guests."
16936 #: ../src/guestfs-actions.pod:6462 ../fish/guestfish-actions.pod:4388
16941 #: ../src/guestfs-actions.pod:6464 ../fish/guestfish-actions.pod:4390
16942 msgid "32-bit big endian such as UCS-4BE."
16946 #: ../src/guestfs-actions.pod:6466 ../fish/guestfish-actions.pod:4392
16951 #: ../src/guestfs-actions.pod:6468 ../fish/guestfish-actions.pod:4394
16952 msgid "32-bit little endian such as UCS-4LE."
16956 #: ../src/guestfs-actions.pod:6472 ../fish/guestfish-actions.pod:4398
16957 msgid "The returned strings are transcoded to UTF-8."
16961 #: ../src/guestfs-actions.pod:6483
16962 msgid "guestfs_swapoff_device"
16966 #: ../src/guestfs-actions.pod:6485
16970 " guestfs_swapoff_device (guestfs_h *g,\n"
16971 " const char *device);\n"
16976 #: ../src/guestfs-actions.pod:6489
16978 "This command disables the libguestfs appliance swap device or partition "
16979 "named C<device>. See C<guestfs_swapon_device>."
16983 #: ../src/guestfs-actions.pod:6497
16984 msgid "guestfs_swapoff_file"
16988 #: ../src/guestfs-actions.pod:6499
16992 " guestfs_swapoff_file (guestfs_h *g,\n"
16993 " const char *file);\n"
16998 #: ../src/guestfs-actions.pod:6503 ../fish/guestfish-actions.pod:4415
16999 msgid "This command disables the libguestfs appliance swap on file."
17003 #: ../src/guestfs-actions.pod:6509
17004 msgid "guestfs_swapoff_label"
17008 #: ../src/guestfs-actions.pod:6511
17012 " guestfs_swapoff_label (guestfs_h *g,\n"
17013 " const char *label);\n"
17018 #: ../src/guestfs-actions.pod:6515 ../fish/guestfish-actions.pod:4421
17020 "This command disables the libguestfs appliance swap on labeled swap "
17025 #: ../src/guestfs-actions.pod:6522
17026 msgid "guestfs_swapoff_uuid"
17030 #: ../src/guestfs-actions.pod:6524
17034 " guestfs_swapoff_uuid (guestfs_h *g,\n"
17035 " const char *uuid);\n"
17040 #: ../src/guestfs-actions.pod:6528 ../fish/guestfish-actions.pod:4428
17042 "This command disables the libguestfs appliance swap partition with the given "
17047 #: ../src/guestfs-actions.pod:6535
17048 msgid "guestfs_swapon_device"
17052 #: ../src/guestfs-actions.pod:6537
17056 " guestfs_swapon_device (guestfs_h *g,\n"
17057 " const char *device);\n"
17062 #: ../src/guestfs-actions.pod:6541
17064 "This command enables the libguestfs appliance to use the swap device or "
17065 "partition named C<device>. The increased memory is made available for all "
17066 "commands, for example those run using C<guestfs_command> or C<guestfs_sh>."
17070 #: ../src/guestfs-actions.pod:6546 ../fish/guestfish-actions.pod:4440
17072 "Note that you should not swap to existing guest swap partitions unless you "
17073 "know what you are doing. They may contain hibernation information, or other "
17074 "information that the guest doesn't want you to trash. You also risk leaking "
17075 "information about the host to the guest this way. Instead, attach a new "
17076 "host device to the guest and swap on that."
17080 #: ../src/guestfs-actions.pod:6557
17081 msgid "guestfs_swapon_file"
17085 #: ../src/guestfs-actions.pod:6559
17089 " guestfs_swapon_file (guestfs_h *g,\n"
17090 " const char *file);\n"
17095 #: ../src/guestfs-actions.pod:6563
17097 "This command enables swap to a file. See C<guestfs_swapon_device> for other "
17102 #: ../src/guestfs-actions.pod:6570
17103 msgid "guestfs_swapon_label"
17107 #: ../src/guestfs-actions.pod:6572
17111 " guestfs_swapon_label (guestfs_h *g,\n"
17112 " const char *label);\n"
17117 #: ../src/guestfs-actions.pod:6576
17119 "This command enables swap to a labeled swap partition. See "
17120 "C<guestfs_swapon_device> for other notes."
17124 #: ../src/guestfs-actions.pod:6583
17125 msgid "guestfs_swapon_uuid"
17129 #: ../src/guestfs-actions.pod:6585
17133 " guestfs_swapon_uuid (guestfs_h *g,\n"
17134 " const char *uuid);\n"
17139 #: ../src/guestfs-actions.pod:6589
17141 "This command enables swap to a swap partition with the given UUID. See "
17142 "C<guestfs_swapon_device> for other notes."
17146 #: ../src/guestfs-actions.pod:6596
17147 msgid "guestfs_sync"
17151 #: ../src/guestfs-actions.pod:6598
17155 " guestfs_sync (guestfs_h *g);\n"
17160 #: ../src/guestfs-actions.pod:6601 ../fish/guestfish-actions.pod:4472
17162 "This syncs the disk, so that any writes are flushed through to the "
17163 "underlying disk image."
17167 #: ../src/guestfs-actions.pod:6604 ../fish/guestfish-actions.pod:4475
17169 "You should always call this if you have modified a disk image, before "
17170 "closing the handle."
17174 #: ../src/guestfs-actions.pod:6611
17175 msgid "guestfs_tail"
17179 #: ../src/guestfs-actions.pod:6613
17183 " guestfs_tail (guestfs_h *g,\n"
17184 " const char *path);\n"
17189 #: ../src/guestfs-actions.pod:6617 ../fish/guestfish-actions.pod:4482
17191 "This command returns up to the last 10 lines of a file as a list of strings."
17195 #: ../src/guestfs-actions.pod:6629
17196 msgid "guestfs_tail_n"
17200 #: ../src/guestfs-actions.pod:6631
17204 " guestfs_tail_n (guestfs_h *g,\n"
17206 " const char *path);\n"
17211 #: ../src/guestfs-actions.pod:6636 ../fish/guestfish-actions.pod:4492
17213 "If the parameter C<nrlines> is a positive number, this returns the last "
17214 "C<nrlines> lines of the file C<path>."
17218 #: ../src/guestfs-actions.pod:6639 ../fish/guestfish-actions.pod:4495
17220 "If the parameter C<nrlines> is a negative number, this returns lines from "
17221 "the file C<path>, starting with the C<-nrlines>th line."
17225 #: ../src/guestfs-actions.pod:6653
17226 msgid "guestfs_tar_in"
17230 #: ../src/guestfs-actions.pod:6655
17234 " guestfs_tar_in (guestfs_h *g,\n"
17235 " const char *tarfile,\n"
17236 " const char *directory);\n"
17241 #: ../src/guestfs-actions.pod:6660 ../fish/guestfish-actions.pod:4507
17243 "This command uploads and unpacks local file C<tarfile> (an I<uncompressed> "
17244 "tar file) into C<directory>."
17248 #: ../src/guestfs-actions.pod:6663
17250 "To upload a compressed tarball, use C<guestfs_tgz_in> or C<guestfs_txz_in>."
17254 #: ../src/guestfs-actions.pod:6668 ../src/guestfs-actions.pod:6685
17255 #: ../src/guestfs-actions.pod:6701 ../src/guestfs-actions.pod:6717
17256 msgid "(Added in 1.0.3)"
17260 #: ../src/guestfs-actions.pod:6670
17261 msgid "guestfs_tar_out"
17265 #: ../src/guestfs-actions.pod:6672
17269 " guestfs_tar_out (guestfs_h *g,\n"
17270 " const char *directory,\n"
17271 " const char *tarfile);\n"
17276 #: ../src/guestfs-actions.pod:6677 ../fish/guestfish-actions.pod:4519
17278 "This command packs the contents of C<directory> and downloads it to local "
17283 #: ../src/guestfs-actions.pod:6680
17285 "To download a compressed tarball, use C<guestfs_tgz_out> or "
17286 "C<guestfs_txz_out>."
17290 #: ../src/guestfs-actions.pod:6687
17291 msgid "guestfs_tgz_in"
17295 #: ../src/guestfs-actions.pod:6689
17299 " guestfs_tgz_in (guestfs_h *g,\n"
17300 " const char *tarball,\n"
17301 " const char *directory);\n"
17306 #: ../src/guestfs-actions.pod:6694 ../fish/guestfish-actions.pod:4531
17308 "This command uploads and unpacks local file C<tarball> (a I<gzip compressed> "
17309 "tar file) into C<directory>."
17313 #: ../src/guestfs-actions.pod:6697
17314 msgid "To upload an uncompressed tarball, use C<guestfs_tar_in>."
17318 #: ../src/guestfs-actions.pod:6703
17319 msgid "guestfs_tgz_out"
17323 #: ../src/guestfs-actions.pod:6705
17327 " guestfs_tgz_out (guestfs_h *g,\n"
17328 " const char *directory,\n"
17329 " const char *tarball);\n"
17334 #: ../src/guestfs-actions.pod:6710 ../fish/guestfish-actions.pod:4542
17336 "This command packs the contents of C<directory> and downloads it to local "
17341 #: ../src/guestfs-actions.pod:6713
17342 msgid "To download an uncompressed tarball, use C<guestfs_tar_out>."
17346 #: ../src/guestfs-actions.pod:6719
17347 msgid "guestfs_touch"
17351 #: ../src/guestfs-actions.pod:6721
17355 " guestfs_touch (guestfs_h *g,\n"
17356 " const char *path);\n"
17361 #: ../src/guestfs-actions.pod:6725 ../fish/guestfish-actions.pod:4553
17363 "Touch acts like the L<touch(1)> command. It can be used to update the "
17364 "timestamps on a file, or, if the file does not exist, to create a new zero-"
17369 #: ../src/guestfs-actions.pod:6729 ../fish/guestfish-actions.pod:4557
17371 "This command only works on regular files, and will fail on other file types "
17372 "such as directories, symbolic links, block special etc."
17376 #: ../src/guestfs-actions.pod:6736
17377 msgid "guestfs_truncate"
17381 #: ../src/guestfs-actions.pod:6738
17385 " guestfs_truncate (guestfs_h *g,\n"
17386 " const char *path);\n"
17391 #: ../src/guestfs-actions.pod:6742 ../fish/guestfish-actions.pod:4564
17393 "This command truncates C<path> to a zero-length file. The file must exist "
17398 #: ../src/guestfs-actions.pod:6749
17399 msgid "guestfs_truncate_size"
17403 #: ../src/guestfs-actions.pod:6751
17407 " guestfs_truncate_size (guestfs_h *g,\n"
17408 " const char *path,\n"
17409 " int64_t size);\n"
17414 #: ../src/guestfs-actions.pod:6756 ../fish/guestfish-actions.pod:4571
17416 "This command truncates C<path> to size C<size> bytes. The file must exist "
17421 #: ../src/guestfs-actions.pod:6759
17423 "If the current file size is less than C<size> then the file is extended to "
17424 "the required size with zero bytes. This creates a sparse file (ie. disk "
17425 "blocks are not allocated for the file until you write to it). To create a "
17426 "non-sparse file of zeroes, use C<guestfs_fallocate64> instead."
17430 #: ../src/guestfs-actions.pod:6769
17431 msgid "guestfs_tune2fs_l"
17435 #: ../src/guestfs-actions.pod:6771
17439 " guestfs_tune2fs_l (guestfs_h *g,\n"
17440 " const char *device);\n"
17445 #: ../src/guestfs-actions.pod:6775 ../fish/guestfish-actions.pod:4584
17447 "This returns the contents of the ext2, ext3 or ext4 filesystem superblock on "
17452 #: ../src/guestfs-actions.pod:6778 ../fish/guestfish-actions.pod:4587
17454 "It is the same as running C<tune2fs -l device>. See L<tune2fs(8)> manpage "
17455 "for more details. The list of fields returned isn't clearly defined, and "
17456 "depends on both the version of C<tune2fs> that libguestfs was built against, "
17457 "and the filesystem itself."
17461 #: ../src/guestfs-actions.pod:6791
17462 msgid "guestfs_txz_in"
17466 #: ../src/guestfs-actions.pod:6793
17470 " guestfs_txz_in (guestfs_h *g,\n"
17471 " const char *tarball,\n"
17472 " const char *directory);\n"
17477 #: ../src/guestfs-actions.pod:6798 ../fish/guestfish-actions.pod:4596
17479 "This command uploads and unpacks local file C<tarball> (an I<xz compressed> "
17480 "tar file) into C<directory>."
17484 #: ../src/guestfs-actions.pod:6805
17485 msgid "guestfs_txz_out"
17489 #: ../src/guestfs-actions.pod:6807
17493 " guestfs_txz_out (guestfs_h *g,\n"
17494 " const char *directory,\n"
17495 " const char *tarball);\n"
17500 #: ../src/guestfs-actions.pod:6812 ../fish/guestfish-actions.pod:4605
17502 "This command packs the contents of C<directory> and downloads it to local "
17503 "file C<tarball> (as an xz compressed tar archive)."
17507 #: ../src/guestfs-actions.pod:6819
17508 msgid "guestfs_umask"
17512 #: ../src/guestfs-actions.pod:6821
17516 " guestfs_umask (guestfs_h *g,\n"
17522 #: ../src/guestfs-actions.pod:6825 ../fish/guestfish-actions.pod:4614
17524 "This function sets the mask used for creating new files and device nodes to "
17529 #: ../src/guestfs-actions.pod:6828 ../fish/guestfish-actions.pod:4617
17531 "Typical umask values would be C<022> which creates new files with "
17532 "permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and C<002> which creates "
17533 "new files with permissions like \"-rw-rw-r--\" or \"-rwxrwxr-x\"."
17537 #: ../src/guestfs-actions.pod:6833 ../fish/guestfish-actions.pod:4622
17539 "The default umask is C<022>. This is important because it means that "
17540 "directories and device nodes will be created with C<0644> or C<0755> mode "
17541 "even if you specify C<0777>."
17545 #: ../src/guestfs-actions.pod:6837
17547 "See also C<guestfs_get_umask>, L<umask(2)>, C<guestfs_mknod>, "
17548 "C<guestfs_mkdir>."
17552 #: ../src/guestfs-actions.pod:6840 ../fish/guestfish-actions.pod:4629
17553 msgid "This call returns the previous umask."
17557 #: ../src/guestfs-actions.pod:6846
17558 msgid "guestfs_umount"
17562 #: ../src/guestfs-actions.pod:6848
17566 " guestfs_umount (guestfs_h *g,\n"
17567 " const char *pathordevice);\n"
17572 #: ../src/guestfs-actions.pod:6852 ../fish/guestfish-actions.pod:4637
17574 "This unmounts the given filesystem. The filesystem may be specified either "
17575 "by its mountpoint (path) or the device which contains the filesystem."
17579 #: ../src/guestfs-actions.pod:6860
17580 msgid "guestfs_umount_all"
17584 #: ../src/guestfs-actions.pod:6862
17588 " guestfs_umount_all (guestfs_h *g);\n"
17593 #: ../src/guestfs-actions.pod:6865 ../fish/guestfish-actions.pod:4647
17594 msgid "This unmounts all mounted filesystems."
17598 #: ../src/guestfs-actions.pod:6867 ../fish/guestfish-actions.pod:4649
17599 msgid "Some internal mounts are not unmounted by this call."
17603 #: ../src/guestfs-actions.pod:6873
17604 msgid "guestfs_upload"
17608 #: ../src/guestfs-actions.pod:6875
17612 " guestfs_upload (guestfs_h *g,\n"
17613 " const char *filename,\n"
17614 " const char *remotefilename);\n"
17619 #: ../src/guestfs-actions.pod:6880 ../src/guestfs-actions.pod:6904
17620 #: ../fish/guestfish-actions.pod:4655 ../fish/guestfish-actions.pod:4668
17621 msgid "Upload local file C<filename> to C<remotefilename> on the filesystem."
17625 #: ../src/guestfs-actions.pod:6885
17626 msgid "See also C<guestfs_download>."
17630 #: ../src/guestfs-actions.pod:6896
17631 msgid "guestfs_upload_offset"
17635 #: ../src/guestfs-actions.pod:6898
17639 " guestfs_upload_offset (guestfs_h *g,\n"
17640 " const char *filename,\n"
17641 " const char *remotefilename,\n"
17642 " int64_t offset);\n"
17647 #: ../src/guestfs-actions.pod:6907 ../fish/guestfish-actions.pod:4671
17649 "C<remotefilename> is overwritten starting at the byte C<offset> specified. "
17650 "The intention is to overwrite parts of existing files or devices, although "
17651 "if a non-existant file is specified then it is created with a \"hole\" "
17652 "before C<offset>. The size of the data written is implicit in the size of "
17653 "the source C<filename>."
17657 #: ../src/guestfs-actions.pod:6914
17659 "Note that there is no limit on the amount of data that can be uploaded with "
17660 "this call, unlike with C<guestfs_pwrite>, and this call always writes the "
17661 "full amount unless an error occurs."
17665 #: ../src/guestfs-actions.pod:6919
17666 msgid "See also C<guestfs_upload>, C<guestfs_pwrite>."
17670 #: ../src/guestfs-actions.pod:6930
17671 msgid "guestfs_utimens"
17675 #: ../src/guestfs-actions.pod:6932
17679 " guestfs_utimens (guestfs_h *g,\n"
17680 " const char *path,\n"
17681 " int64_t atsecs,\n"
17682 " int64_t atnsecs,\n"
17683 " int64_t mtsecs,\n"
17684 " int64_t mtnsecs);\n"
17689 #: ../src/guestfs-actions.pod:6940 ../fish/guestfish-actions.pod:4691
17690 msgid "This command sets the timestamps of a file with nanosecond precision."
17694 #: ../src/guestfs-actions.pod:6943 ../fish/guestfish-actions.pod:4694
17696 "C<atsecs, atnsecs> are the last access time (atime) in secs and nanoseconds "
17701 #: ../src/guestfs-actions.pod:6946 ../fish/guestfish-actions.pod:4697
17703 "C<mtsecs, mtnsecs> are the last modification time (mtime) in secs and "
17704 "nanoseconds from the epoch."
17708 #: ../src/guestfs-actions.pod:6949 ../fish/guestfish-actions.pod:4700
17710 "If the C<*nsecs> field contains the special value C<-1> then the "
17711 "corresponding timestamp is set to the current time. (The C<*secs> field is "
17712 "ignored in this case)."
17716 #: ../src/guestfs-actions.pod:6953 ../fish/guestfish-actions.pod:4704
17718 "If the C<*nsecs> field contains the special value C<-2> then the "
17719 "corresponding timestamp is left unchanged. (The C<*secs> field is ignored "
17724 #: ../src/guestfs-actions.pod:6961 ../src/guestfs-structs.pod:175
17725 msgid "guestfs_version"
17729 #: ../src/guestfs-actions.pod:6963
17732 " struct guestfs_version *\n"
17733 " guestfs_version (guestfs_h *g);\n"
17738 #: ../src/guestfs-actions.pod:6966 ../fish/guestfish-actions.pod:4712
17740 "Return the libguestfs version number that the program is linked against."
17744 #: ../src/guestfs-actions.pod:6969 ../fish/guestfish-actions.pod:4715
17746 "Note that because of dynamic linking this is not necessarily the version of "
17747 "libguestfs that you compiled against. You can compile the program, and then "
17748 "at runtime dynamically link against a completely different C<libguestfs.so> "
17753 #: ../src/guestfs-actions.pod:6974 ../fish/guestfish-actions.pod:4720
17755 "This call was added in version C<1.0.58>. In previous versions of "
17756 "libguestfs there was no way to get the version number. From C code you can "
17757 "use dynamic linker functions to find out if this symbol exists (if it "
17758 "doesn't, then it's an earlier version)."
17762 #: ../src/guestfs-actions.pod:6980 ../fish/guestfish-actions.pod:4726
17764 "The call returns a structure with four elements. The first three (C<major>, "
17765 "C<minor> and C<release>) are numbers and correspond to the usual version "
17766 "triplet. The fourth element (C<extra>) is a string and is normally empty, "
17767 "but may be used for distro-specific information."
17771 #: ../src/guestfs-actions.pod:6986 ../fish/guestfish-actions.pod:4732
17773 "To construct the original version string: C<$major.$minor.$release$extra>"
17777 #: ../src/guestfs-actions.pod:6989 ../fish/guestfish-actions.pod:4735
17778 msgid "See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>."
17782 #: ../src/guestfs-actions.pod:6991
17784 "I<Note:> Don't use this call to test for availability of features. In "
17785 "enterprise distributions we backport features from later versions into "
17786 "earlier versions, making this an unreliable way to test for features. Use "
17787 "C<guestfs_available> instead."
17791 #: ../src/guestfs-actions.pod:6997
17793 "This function returns a C<struct guestfs_version *>, or NULL if there was an "
17794 "error. I<The caller must call C<guestfs_free_version> after use>."
17798 #: ../src/guestfs-actions.pod:7001
17799 msgid "(Added in 1.0.58)"
17803 #: ../src/guestfs-actions.pod:7003
17804 msgid "guestfs_vfs_label"
17808 #: ../src/guestfs-actions.pod:7005
17812 " guestfs_vfs_label (guestfs_h *g,\n"
17813 " const char *device);\n"
17818 #: ../src/guestfs-actions.pod:7009 ../fish/guestfish-actions.pod:4747
17819 msgid "This returns the filesystem label of the filesystem on C<device>."
17823 #: ../src/guestfs-actions.pod:7012 ../fish/guestfish-actions.pod:4750
17824 msgid "If the filesystem is unlabeled, this returns the empty string."
17828 #: ../src/guestfs-actions.pod:7014
17829 msgid "To find a filesystem from the label, use C<guestfs_findfs_label>."
17833 #: ../src/guestfs-actions.pod:7019 ../src/guestfs-actions.pod:7056
17834 msgid "(Added in 1.3.18)"
17838 #: ../src/guestfs-actions.pod:7021
17839 msgid "guestfs_vfs_type"
17843 #: ../src/guestfs-actions.pod:7023
17847 " guestfs_vfs_type (guestfs_h *g,\n"
17848 " const char *device);\n"
17853 #: ../src/guestfs-actions.pod:7027 ../fish/guestfish-actions.pod:4758
17855 "This command gets the filesystem type corresponding to the filesystem on "
17860 #: ../src/guestfs-actions.pod:7030 ../fish/guestfish-actions.pod:4761
17862 "For most filesystems, the result is the name of the Linux VFS module which "
17863 "would be used to mount this filesystem if you mounted it without specifying "
17864 "the filesystem type. For example a string such as C<ext3> or C<ntfs>."
17868 #: ../src/guestfs-actions.pod:7040
17869 msgid "guestfs_vfs_uuid"
17873 #: ../src/guestfs-actions.pod:7042
17877 " guestfs_vfs_uuid (guestfs_h *g,\n"
17878 " const char *device);\n"
17883 #: ../src/guestfs-actions.pod:7046 ../fish/guestfish-actions.pod:4770
17884 msgid "This returns the filesystem UUID of the filesystem on C<device>."
17888 #: ../src/guestfs-actions.pod:7049 ../fish/guestfish-actions.pod:4773
17889 msgid "If the filesystem does not have a UUID, this returns the empty string."
17893 #: ../src/guestfs-actions.pod:7051
17894 msgid "To find a filesystem from the UUID, use C<guestfs_findfs_uuid>."
17898 #: ../src/guestfs-actions.pod:7058
17899 msgid "guestfs_vg_activate"
17903 #: ../src/guestfs-actions.pod:7060
17907 " guestfs_vg_activate (guestfs_h *g,\n"
17909 " char *const *volgroups);\n"
17914 #: ../src/guestfs-actions.pod:7065 ../fish/guestfish-actions.pod:4781
17916 "This command activates or (if C<activate> is false) deactivates all logical "
17917 "volumes in the listed volume groups C<volgroups>. If activated, then they "
17918 "are made known to the kernel, ie. they appear as C</dev/mapper> devices. If "
17919 "deactivated, then those devices disappear."
17923 #: ../src/guestfs-actions.pod:7071 ../fish/guestfish-actions.pod:4787
17924 msgid "This command is the same as running C<vgchange -a y|n volgroups...>"
17928 #: ../src/guestfs-actions.pod:7073 ../fish/guestfish-actions.pod:4789
17930 "Note that if C<volgroups> is an empty list then B<all> volume groups are "
17931 "activated or deactivated."
17935 #: ../src/guestfs-actions.pod:7080
17936 msgid "guestfs_vg_activate_all"
17940 #: ../src/guestfs-actions.pod:7082
17944 " guestfs_vg_activate_all (guestfs_h *g,\n"
17945 " int activate);\n"
17950 #: ../src/guestfs-actions.pod:7086 ../fish/guestfish-actions.pod:4796
17952 "This command activates or (if C<activate> is false) deactivates all logical "
17953 "volumes in all volume groups. If activated, then they are made known to the "
17954 "kernel, ie. they appear as C</dev/mapper> devices. If deactivated, then "
17955 "those devices disappear."
17959 #: ../src/guestfs-actions.pod:7092 ../fish/guestfish-actions.pod:4802
17960 msgid "This command is the same as running C<vgchange -a y|n>"
17964 #: ../src/guestfs-actions.pod:7098
17965 msgid "guestfs_vgcreate"
17969 #: ../src/guestfs-actions.pod:7100
17973 " guestfs_vgcreate (guestfs_h *g,\n"
17974 " const char *volgroup,\n"
17975 " char *const *physvols);\n"
17980 #: ../src/guestfs-actions.pod:7105 ../fish/guestfish-actions.pod:4808
17982 "This creates an LVM volume group called C<volgroup> from the non-empty list "
17983 "of physical volumes C<physvols>."
17987 #: ../src/guestfs-actions.pod:7112
17988 msgid "guestfs_vglvuuids"
17992 #: ../src/guestfs-actions.pod:7114
17996 " guestfs_vglvuuids (guestfs_h *g,\n"
17997 " const char *vgname);\n"
18002 #: ../src/guestfs-actions.pod:7118 ../fish/guestfish-actions.pod:4815
18004 "Given a VG called C<vgname>, this returns the UUIDs of all the logical "
18005 "volumes created in this volume group."
18009 #: ../src/guestfs-actions.pod:7121
18011 "You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid> calls to "
18012 "associate logical volumes and volume groups."
18016 #: ../src/guestfs-actions.pod:7124
18017 msgid "See also C<guestfs_vgpvuuids>."
18021 #: ../src/guestfs-actions.pod:7132
18022 msgid "guestfs_vgpvuuids"
18026 #: ../src/guestfs-actions.pod:7134
18030 " guestfs_vgpvuuids (guestfs_h *g,\n"
18031 " const char *vgname);\n"
18036 #: ../src/guestfs-actions.pod:7138 ../fish/guestfish-actions.pod:4827
18038 "Given a VG called C<vgname>, this returns the UUIDs of all the physical "
18039 "volumes that this volume group resides on."
18043 #: ../src/guestfs-actions.pod:7141
18045 "You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid> calls to "
18046 "associate physical volumes and volume groups."
18050 #: ../src/guestfs-actions.pod:7144
18051 msgid "See also C<guestfs_vglvuuids>."
18055 #: ../src/guestfs-actions.pod:7152
18056 msgid "guestfs_vgremove"
18060 #: ../src/guestfs-actions.pod:7154
18064 " guestfs_vgremove (guestfs_h *g,\n"
18065 " const char *vgname);\n"
18070 #: ../src/guestfs-actions.pod:7158 ../fish/guestfish-actions.pod:4839
18071 msgid "Remove an LVM volume group C<vgname>, (for example C<VG>)."
18075 #: ../src/guestfs-actions.pod:7160 ../fish/guestfish-actions.pod:4841
18077 "This also forcibly removes all logical volumes in the volume group (if any)."
18081 #: ../src/guestfs-actions.pod:7167
18082 msgid "guestfs_vgrename"
18086 #: ../src/guestfs-actions.pod:7169
18090 " guestfs_vgrename (guestfs_h *g,\n"
18091 " const char *volgroup,\n"
18092 " const char *newvolgroup);\n"
18097 #: ../src/guestfs-actions.pod:7174 ../fish/guestfish-actions.pod:4848
18098 msgid "Rename a volume group C<volgroup> with the new name C<newvolgroup>."
18102 #: ../src/guestfs-actions.pod:7180
18103 msgid "guestfs_vgs"
18107 #: ../src/guestfs-actions.pod:7182
18111 " guestfs_vgs (guestfs_h *g);\n"
18116 #: ../src/guestfs-actions.pod:7185 ../fish/guestfish-actions.pod:4854
18118 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
18123 #: ../src/guestfs-actions.pod:7188 ../fish/guestfish-actions.pod:4857
18125 "This returns a list of just the volume group names that were detected (eg. "
18130 #: ../src/guestfs-actions.pod:7191
18131 msgid "See also C<guestfs_vgs_full>."
18135 #: ../src/guestfs-actions.pod:7199
18136 msgid "guestfs_vgs_full"
18140 #: ../src/guestfs-actions.pod:7201
18143 " struct guestfs_lvm_vg_list *\n"
18144 " guestfs_vgs_full (guestfs_h *g);\n"
18149 #: ../src/guestfs-actions.pod:7204 ../fish/guestfish-actions.pod:4866
18151 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
18152 "> command. The \"full\" version includes all fields."
18156 #: ../src/guestfs-actions.pod:7207
18158 "This function returns a C<struct guestfs_lvm_vg_list *>, or NULL if there "
18159 "was an error. I<The caller must call C<guestfs_free_lvm_vg_list> after use>."
18163 #: ../src/guestfs-actions.pod:7213
18164 msgid "guestfs_vgscan"
18168 #: ../src/guestfs-actions.pod:7215
18172 " guestfs_vgscan (guestfs_h *g);\n"
18177 #: ../src/guestfs-actions.pod:7218 ../fish/guestfish-actions.pod:4873
18179 "This rescans all block devices and rebuilds the list of LVM physical "
18180 "volumes, volume groups and logical volumes."
18184 #: ../src/guestfs-actions.pod:7225
18185 msgid "guestfs_vguuid"
18189 #: ../src/guestfs-actions.pod:7227
18193 " guestfs_vguuid (guestfs_h *g,\n"
18194 " const char *vgname);\n"
18199 #: ../src/guestfs-actions.pod:7231 ../fish/guestfish-actions.pod:4880
18200 msgid "This command returns the UUID of the LVM VG named C<vgname>."
18204 #: ../src/guestfs-actions.pod:7238
18205 msgid "guestfs_wait_ready"
18209 #: ../src/guestfs-actions.pod:7240
18213 " guestfs_wait_ready (guestfs_h *g);\n"
18218 #: ../src/guestfs-actions.pod:7243
18219 msgid "This function is a no op."
18223 #: ../src/guestfs-actions.pod:7245
18225 "In versions of the API E<lt> 1.0.71 you had to call this function just after "
18226 "calling C<guestfs_launch> to wait for the launch to complete. However this "
18227 "is no longer necessary because C<guestfs_launch> now does the waiting."
18231 #: ../src/guestfs-actions.pod:7250
18233 "If you see any calls to this function in code then you can just remove them, "
18234 "unless you want to retain compatibility with older versions of the API."
18238 #: ../src/guestfs-actions.pod:7256
18240 "This function is deprecated. In new code, use the L</guestfs_launch> call "
18245 #: ../src/guestfs-actions.pod:7265
18246 msgid "guestfs_wc_c"
18250 #: ../src/guestfs-actions.pod:7267
18254 " guestfs_wc_c (guestfs_h *g,\n"
18255 " const char *path);\n"
18260 #: ../src/guestfs-actions.pod:7271 ../fish/guestfish-actions.pod:4886
18262 "This command counts the characters in a file, using the C<wc -c> external "
18267 #: ../src/guestfs-actions.pod:7278
18268 msgid "guestfs_wc_l"
18272 #: ../src/guestfs-actions.pod:7280
18276 " guestfs_wc_l (guestfs_h *g,\n"
18277 " const char *path);\n"
18282 #: ../src/guestfs-actions.pod:7284 ../fish/guestfish-actions.pod:4893
18284 "This command counts the lines in a file, using the C<wc -l> external command."
18288 #: ../src/guestfs-actions.pod:7291
18289 msgid "guestfs_wc_w"
18293 #: ../src/guestfs-actions.pod:7293
18297 " guestfs_wc_w (guestfs_h *g,\n"
18298 " const char *path);\n"
18303 #: ../src/guestfs-actions.pod:7297 ../fish/guestfish-actions.pod:4900
18305 "This command counts the words in a file, using the C<wc -w> external command."
18309 #: ../src/guestfs-actions.pod:7304
18310 msgid "guestfs_write"
18314 #: ../src/guestfs-actions.pod:7306
18318 " guestfs_write (guestfs_h *g,\n"
18319 " const char *path,\n"
18320 " const char *content,\n"
18321 " size_t content_size);\n"
18326 #: ../src/guestfs-actions.pod:7312 ../fish/guestfish-actions.pod:4907
18328 "This call creates a file called C<path>. The content of the file is the "
18329 "string C<content> (which can contain any 8 bit data)."
18333 #: ../src/guestfs-actions.pod:7322
18334 msgid "guestfs_write_file"
18338 #: ../src/guestfs-actions.pod:7324
18342 " guestfs_write_file (guestfs_h *g,\n"
18343 " const char *path,\n"
18344 " const char *content,\n"
18350 #: ../src/guestfs-actions.pod:7330 ../fish/guestfish-actions.pod:4917
18352 "This call creates a file called C<path>. The contents of the file is the "
18353 "string C<content> (which can contain any 8 bit data), with length C<size>."
18357 #: ../src/guestfs-actions.pod:7334 ../fish/guestfish-actions.pod:4921
18359 "As a special case, if C<size> is C<0> then the length is calculated using "
18360 "C<strlen> (so in this case the content cannot contain embedded ASCII NULs)."
18364 #: ../src/guestfs-actions.pod:7338 ../fish/guestfish-actions.pod:4925
18366 "I<NB.> Owing to a bug, writing content containing ASCII NUL characters does "
18367 "I<not> work, even if the length is specified."
18371 #: ../src/guestfs-actions.pod:7346
18373 "This function is deprecated. In new code, use the L</guestfs_write> call "
18378 #: ../src/guestfs-actions.pod:7355
18379 msgid "guestfs_zegrep"
18383 #: ../src/guestfs-actions.pod:7357
18387 " guestfs_zegrep (guestfs_h *g,\n"
18388 " const char *regex,\n"
18389 " const char *path);\n"
18394 #: ../src/guestfs-actions.pod:7362 ../fish/guestfish-actions.pod:4942
18396 "This calls the external C<zegrep> program and returns the matching lines."
18400 #: ../src/guestfs-actions.pod:7374
18401 msgid "guestfs_zegrepi"
18405 #: ../src/guestfs-actions.pod:7376
18409 " guestfs_zegrepi (guestfs_h *g,\n"
18410 " const char *regex,\n"
18411 " const char *path);\n"
18416 #: ../src/guestfs-actions.pod:7381 ../fish/guestfish-actions.pod:4952
18418 "This calls the external C<zegrep -i> program and returns the matching lines."
18422 #: ../src/guestfs-actions.pod:7393
18423 msgid "guestfs_zero"
18427 #: ../src/guestfs-actions.pod:7395
18431 " guestfs_zero (guestfs_h *g,\n"
18432 " const char *device);\n"
18437 #: ../src/guestfs-actions.pod:7399 ../fish/guestfish-actions.pod:4962
18438 msgid "This command writes zeroes over the first few blocks of C<device>."
18442 #: ../src/guestfs-actions.pod:7401 ../fish/guestfish-actions.pod:4964
18444 "How many blocks are zeroed isn't specified (but it's I<not> enough to "
18445 "securely wipe the device). It should be sufficient to remove any partition "
18446 "tables, filesystem superblocks and so on."
18450 #: ../src/guestfs-actions.pod:7405
18451 msgid "See also: C<guestfs_zero_device>, C<guestfs_scrub_device>."
18455 #: ../src/guestfs-actions.pod:7416
18456 msgid "guestfs_zero_device"
18460 #: ../src/guestfs-actions.pod:7418
18464 " guestfs_zero_device (guestfs_h *g,\n"
18465 " const char *device);\n"
18470 #: ../src/guestfs-actions.pod:7422
18472 "This command writes zeroes over the entire C<device>. Compare with "
18473 "C<guestfs_zero> which just zeroes the first few blocks of a device."
18477 #: ../src/guestfs-actions.pod:7436
18478 msgid "(Added in 1.3.1)"
18482 #: ../src/guestfs-actions.pod:7438
18483 msgid "guestfs_zerofree"
18487 #: ../src/guestfs-actions.pod:7440
18491 " guestfs_zerofree (guestfs_h *g,\n"
18492 " const char *device);\n"
18497 #: ../src/guestfs-actions.pod:7444 ../fish/guestfish-actions.pod:4985
18499 "This runs the I<zerofree> program on C<device>. This program claims to zero "
18500 "unused inodes and disk blocks on an ext2/3 filesystem, thus making it "
18501 "possible to compress the filesystem more effectively."
18505 #: ../src/guestfs-actions.pod:7449 ../fish/guestfish-actions.pod:4990
18506 msgid "You should B<not> run this program if the filesystem is mounted."
18510 #: ../src/guestfs-actions.pod:7452 ../fish/guestfish-actions.pod:4993
18512 "It is possible that using this program can damage the filesystem or data on "
18517 #: ../src/guestfs-actions.pod:7459
18518 msgid "guestfs_zfgrep"
18522 #: ../src/guestfs-actions.pod:7461
18526 " guestfs_zfgrep (guestfs_h *g,\n"
18527 " const char *pattern,\n"
18528 " const char *path);\n"
18533 #: ../src/guestfs-actions.pod:7466 ../fish/guestfish-actions.pod:5000
18535 "This calls the external C<zfgrep> program and returns the matching lines."
18539 #: ../src/guestfs-actions.pod:7478
18540 msgid "guestfs_zfgrepi"
18544 #: ../src/guestfs-actions.pod:7480
18548 " guestfs_zfgrepi (guestfs_h *g,\n"
18549 " const char *pattern,\n"
18550 " const char *path);\n"
18555 #: ../src/guestfs-actions.pod:7485 ../fish/guestfish-actions.pod:5010
18557 "This calls the external C<zfgrep -i> program and returns the matching lines."
18561 #: ../src/guestfs-actions.pod:7497
18562 msgid "guestfs_zfile"
18566 #: ../src/guestfs-actions.pod:7499
18570 " guestfs_zfile (guestfs_h *g,\n"
18571 " const char *meth,\n"
18572 " const char *path);\n"
18577 #: ../src/guestfs-actions.pod:7504 ../fish/guestfish-actions.pod:5020
18579 "This command runs C<file> after first decompressing C<path> using C<method>."
18583 #: ../src/guestfs-actions.pod:7507 ../fish/guestfish-actions.pod:5023
18584 msgid "C<method> must be one of C<gzip>, C<compress> or C<bzip2>."
18588 #: ../src/guestfs-actions.pod:7509
18590 "Since 1.0.63, use C<guestfs_file> instead which can now process compressed "
18595 #: ../src/guestfs-actions.pod:7515
18597 "This function is deprecated. In new code, use the L</guestfs_file> call "
18602 #: ../src/guestfs-actions.pod:7524
18603 msgid "guestfs_zgrep"
18607 #: ../src/guestfs-actions.pod:7526
18611 " guestfs_zgrep (guestfs_h *g,\n"
18612 " const char *regex,\n"
18613 " const char *path);\n"
18618 #: ../src/guestfs-actions.pod:7531 ../fish/guestfish-actions.pod:5039
18620 "This calls the external C<zgrep> program and returns the matching lines."
18624 #: ../src/guestfs-actions.pod:7543
18625 msgid "guestfs_zgrepi"
18629 #: ../src/guestfs-actions.pod:7545
18633 " guestfs_zgrepi (guestfs_h *g,\n"
18634 " const char *regex,\n"
18635 " const char *path);\n"
18640 #: ../src/guestfs-actions.pod:7550 ../fish/guestfish-actions.pod:5049
18642 "This calls the external C<zgrep -i> program and returns the matching lines."
18646 #: ../src/guestfs-availability.pod:3
18651 #: ../src/guestfs-availability.pod:5
18653 "The following functions: L</guestfs_aug_clear> L</guestfs_aug_close> L</"
18654 "guestfs_aug_defnode> L</guestfs_aug_defvar> L</guestfs_aug_get> L</"
18655 "guestfs_aug_init> L</guestfs_aug_insert> L</guestfs_aug_load> L</"
18656 "guestfs_aug_ls> L</guestfs_aug_match> L</guestfs_aug_mv> L</guestfs_aug_rm> "
18657 "L</guestfs_aug_save> L</guestfs_aug_set>"
18661 #: ../src/guestfs-availability.pod:21
18666 #: ../src/guestfs-availability.pod:23
18667 msgid "The following functions: L</guestfs_grub_install>"
18671 #: ../src/guestfs-availability.pod:26
18676 #: ../src/guestfs-availability.pod:28
18678 "The following functions: L</guestfs_inotify_add_watch> L</"
18679 "guestfs_inotify_close> L</guestfs_inotify_files> L</guestfs_inotify_init> L</"
18680 "guestfs_inotify_read> L</guestfs_inotify_rm_watch>"
18684 #: ../src/guestfs-availability.pod:36
18685 msgid "B<linuxfsuuid>"
18689 #: ../src/guestfs-availability.pod:38
18691 "The following functions: L</guestfs_mke2fs_JU> L</guestfs_mke2journal_U> L</"
18692 "guestfs_mkswap_U> L</guestfs_swapoff_uuid> L</guestfs_swapon_uuid>"
18696 #: ../src/guestfs-availability.pod:45
18697 msgid "B<linuxmodules>"
18701 #: ../src/guestfs-availability.pod:47
18702 msgid "The following functions: L</guestfs_modprobe>"
18706 #: ../src/guestfs-availability.pod:50
18707 msgid "B<linuxxattrs>"
18711 #: ../src/guestfs-availability.pod:52
18713 "The following functions: L</guestfs_getxattr> L</guestfs_getxattrs> L</"
18714 "guestfs_lgetxattr> L</guestfs_lgetxattrs> L</guestfs_lremovexattr> L</"
18715 "guestfs_lsetxattr> L</guestfs_lxattrlist> L</guestfs_removexattr> L</"
18716 "guestfs_setxattr>"
18720 #: ../src/guestfs-availability.pod:63
18725 #: ../src/guestfs-availability.pod:65
18727 "The following functions: L</guestfs_luks_add_key> L</guestfs_luks_close> L</"
18728 "guestfs_luks_format> L</guestfs_luks_format_cipher> L</"
18729 "guestfs_luks_kill_slot> L</guestfs_luks_open> L</guestfs_luks_open_ro>"
18733 #: ../src/guestfs-availability.pod:74
18738 #: ../src/guestfs-availability.pod:76
18740 "The following functions: L</guestfs_is_lv> L</guestfs_lvcreate> L</"
18741 "guestfs_lvm_remove_all> L</guestfs_lvm_set_filter> L</guestfs_lvremove> L</"
18742 "guestfs_lvresize> L</guestfs_lvresize_free> L</guestfs_lvs> L</"
18743 "guestfs_lvs_full> L</guestfs_pvcreate> L</guestfs_pvremove> L</"
18744 "guestfs_pvresize> L</guestfs_pvresize_size> L</guestfs_pvs> L</"
18745 "guestfs_pvs_full> L</guestfs_vg_activate> L</guestfs_vg_activate_all> L</"
18746 "guestfs_vgcreate> L</guestfs_vgremove> L</guestfs_vgs> L</guestfs_vgs_full>"
18750 #: ../src/guestfs-availability.pod:99
18755 #: ../src/guestfs-availability.pod:101
18757 "The following functions: L</guestfs_mkfifo> L</guestfs_mknod> L</"
18758 "guestfs_mknod_b> L</guestfs_mknod_c>"
18762 #: ../src/guestfs-availability.pod:107
18767 #: ../src/guestfs-availability.pod:109
18768 msgid "The following functions: L</guestfs_ntfs_3g_probe>"
18772 #: ../src/guestfs-availability.pod:112
18773 msgid "B<ntfsprogs>"
18777 #: ../src/guestfs-availability.pod:114
18779 "The following functions: L</guestfs_ntfsresize> L</guestfs_ntfsresize_size>"
18783 #: ../src/guestfs-availability.pod:118
18784 msgid "B<realpath>"
18788 #: ../src/guestfs-availability.pod:120
18789 msgid "The following functions: L</guestfs_realpath>"
18793 #: ../src/guestfs-availability.pod:123
18798 #: ../src/guestfs-availability.pod:125
18800 "The following functions: L</guestfs_scrub_device> L</guestfs_scrub_file> L</"
18801 "guestfs_scrub_freespace>"
18805 #: ../src/guestfs-availability.pod:130
18810 #: ../src/guestfs-availability.pod:132
18811 msgid "The following functions: L</guestfs_getcon> L</guestfs_setcon>"
18815 #: ../src/guestfs-availability.pod:136
18820 #: ../src/guestfs-availability.pod:138
18821 msgid "The following functions: L</guestfs_txz_in> L</guestfs_txz_out>"
18825 #: ../src/guestfs-availability.pod:142
18826 msgid "B<zerofree>"
18830 #: ../src/guestfs-availability.pod:144
18831 msgid "The following functions: L</guestfs_zerofree>"
18835 #: ../src/guestfs-structs.pod:1
18836 msgid "guestfs_int_bool"
18840 #: ../src/guestfs-structs.pod:3
18843 " struct guestfs_int_bool {\n"
18851 #: ../src/guestfs-structs.pod:8
18854 " struct guestfs_int_bool_list {\n"
18855 " uint32_t len; /* Number of elements in list. */\n"
18856 " struct guestfs_int_bool *val; /* Elements. */\n"
18862 #: ../src/guestfs-structs.pod:13
18865 " void guestfs_free_int_bool (struct guestfs_free_int_bool *);\n"
18866 " void guestfs_free_int_bool_list (struct guestfs_free_int_bool_list *);\n"
18871 #: ../src/guestfs-structs.pod:16
18872 msgid "guestfs_lvm_pv"
18876 #: ../src/guestfs-structs.pod:18
18879 " struct guestfs_lvm_pv {\n"
18880 " char *pv_name;\n"
18881 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
18882 " char pv_uuid[32];\n"
18884 " uint64_t pv_size;\n"
18885 " uint64_t dev_size;\n"
18886 " uint64_t pv_free;\n"
18887 " uint64_t pv_used;\n"
18888 " char *pv_attr;\n"
18889 " int64_t pv_pe_count;\n"
18890 " int64_t pv_pe_alloc_count;\n"
18891 " char *pv_tags;\n"
18892 " uint64_t pe_start;\n"
18893 " int64_t pv_mda_count;\n"
18894 " uint64_t pv_mda_free;\n"
18900 #: ../src/guestfs-structs.pod:36
18903 " struct guestfs_lvm_pv_list {\n"
18904 " uint32_t len; /* Number of elements in list. */\n"
18905 " struct guestfs_lvm_pv *val; /* Elements. */\n"
18911 #: ../src/guestfs-structs.pod:41
18914 " void guestfs_free_lvm_pv (struct guestfs_free_lvm_pv *);\n"
18915 " void guestfs_free_lvm_pv_list (struct guestfs_free_lvm_pv_list *);\n"
18920 #: ../src/guestfs-structs.pod:44
18921 msgid "guestfs_lvm_vg"
18925 #: ../src/guestfs-structs.pod:46
18928 " struct guestfs_lvm_vg {\n"
18929 " char *vg_name;\n"
18930 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
18931 " char vg_uuid[32];\n"
18933 " char *vg_attr;\n"
18934 " uint64_t vg_size;\n"
18935 " uint64_t vg_free;\n"
18936 " char *vg_sysid;\n"
18937 " uint64_t vg_extent_size;\n"
18938 " int64_t vg_extent_count;\n"
18939 " int64_t vg_free_count;\n"
18940 " int64_t max_lv;\n"
18941 " int64_t max_pv;\n"
18942 " int64_t pv_count;\n"
18943 " int64_t lv_count;\n"
18944 " int64_t snap_count;\n"
18945 " int64_t vg_seqno;\n"
18946 " char *vg_tags;\n"
18947 " int64_t vg_mda_count;\n"
18948 " uint64_t vg_mda_free;\n"
18954 #: ../src/guestfs-structs.pod:69
18957 " struct guestfs_lvm_vg_list {\n"
18958 " uint32_t len; /* Number of elements in list. */\n"
18959 " struct guestfs_lvm_vg *val; /* Elements. */\n"
18965 #: ../src/guestfs-structs.pod:74
18968 " void guestfs_free_lvm_vg (struct guestfs_free_lvm_vg *);\n"
18969 " void guestfs_free_lvm_vg_list (struct guestfs_free_lvm_vg_list *);\n"
18974 #: ../src/guestfs-structs.pod:77
18975 msgid "guestfs_lvm_lv"
18979 #: ../src/guestfs-structs.pod:79
18982 " struct guestfs_lvm_lv {\n"
18983 " char *lv_name;\n"
18984 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
18985 " char lv_uuid[32];\n"
18986 " char *lv_attr;\n"
18987 " int64_t lv_major;\n"
18988 " int64_t lv_minor;\n"
18989 " int64_t lv_kernel_major;\n"
18990 " int64_t lv_kernel_minor;\n"
18991 " uint64_t lv_size;\n"
18992 " int64_t seg_count;\n"
18994 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
18995 " float snap_percent;\n"
18996 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
18997 " float copy_percent;\n"
18998 " char *move_pv;\n"
18999 " char *lv_tags;\n"
19000 " char *mirror_log;\n"
19001 " char *modules;\n"
19007 #: ../src/guestfs-structs.pod:101
19010 " struct guestfs_lvm_lv_list {\n"
19011 " uint32_t len; /* Number of elements in list. */\n"
19012 " struct guestfs_lvm_lv *val; /* Elements. */\n"
19018 #: ../src/guestfs-structs.pod:106
19021 " void guestfs_free_lvm_lv (struct guestfs_free_lvm_lv *);\n"
19022 " void guestfs_free_lvm_lv_list (struct guestfs_free_lvm_lv_list *);\n"
19027 #: ../src/guestfs-structs.pod:111
19030 " struct guestfs_stat {\n"
19034 " int64_t nlink;\n"
19039 " int64_t blksize;\n"
19040 " int64_t blocks;\n"
19041 " int64_t atime;\n"
19042 " int64_t mtime;\n"
19043 " int64_t ctime;\n"
19049 #: ../src/guestfs-structs.pod:127
19052 " struct guestfs_stat_list {\n"
19053 " uint32_t len; /* Number of elements in list. */\n"
19054 " struct guestfs_stat *val; /* Elements. */\n"
19060 #: ../src/guestfs-structs.pod:132
19063 " void guestfs_free_stat (struct guestfs_free_stat *);\n"
19064 " void guestfs_free_stat_list (struct guestfs_free_stat_list *);\n"
19069 #: ../src/guestfs-structs.pod:137
19072 " struct guestfs_statvfs {\n"
19073 " int64_t bsize;\n"
19074 " int64_t frsize;\n"
19075 " int64_t blocks;\n"
19076 " int64_t bfree;\n"
19077 " int64_t bavail;\n"
19078 " int64_t files;\n"
19079 " int64_t ffree;\n"
19080 " int64_t favail;\n"
19083 " int64_t namemax;\n"
19089 #: ../src/guestfs-structs.pod:151
19092 " struct guestfs_statvfs_list {\n"
19093 " uint32_t len; /* Number of elements in list. */\n"
19094 " struct guestfs_statvfs *val; /* Elements. */\n"
19100 #: ../src/guestfs-structs.pod:156
19103 " void guestfs_free_statvfs (struct guestfs_free_statvfs *);\n"
19104 " void guestfs_free_statvfs_list (struct guestfs_free_statvfs_list *);\n"
19109 #: ../src/guestfs-structs.pod:159
19110 msgid "guestfs_dirent"
19114 #: ../src/guestfs-structs.pod:161
19117 " struct guestfs_dirent {\n"
19126 #: ../src/guestfs-structs.pod:167
19129 " struct guestfs_dirent_list {\n"
19130 " uint32_t len; /* Number of elements in list. */\n"
19131 " struct guestfs_dirent *val; /* Elements. */\n"
19137 #: ../src/guestfs-structs.pod:172
19140 " void guestfs_free_dirent (struct guestfs_free_dirent *);\n"
19141 " void guestfs_free_dirent_list (struct guestfs_free_dirent_list *);\n"
19146 #: ../src/guestfs-structs.pod:177
19149 " struct guestfs_version {\n"
19150 " int64_t major;\n"
19151 " int64_t minor;\n"
19152 " int64_t release;\n"
19159 #: ../src/guestfs-structs.pod:184
19162 " struct guestfs_version_list {\n"
19163 " uint32_t len; /* Number of elements in list. */\n"
19164 " struct guestfs_version *val; /* Elements. */\n"
19170 #: ../src/guestfs-structs.pod:189
19173 " void guestfs_free_version (struct guestfs_free_version *);\n"
19174 " void guestfs_free_version_list (struct guestfs_free_version_list *);\n"
19179 #: ../src/guestfs-structs.pod:192
19180 msgid "guestfs_xattr"
19184 #: ../src/guestfs-structs.pod:194
19187 " struct guestfs_xattr {\n"
19188 " char *attrname;\n"
19189 " /* The next two fields describe a byte array. */\n"
19190 " uint32_t attrval_len;\n"
19191 " char *attrval;\n"
19197 #: ../src/guestfs-structs.pod:201
19200 " struct guestfs_xattr_list {\n"
19201 " uint32_t len; /* Number of elements in list. */\n"
19202 " struct guestfs_xattr *val; /* Elements. */\n"
19208 #: ../src/guestfs-structs.pod:206
19211 " void guestfs_free_xattr (struct guestfs_free_xattr *);\n"
19212 " void guestfs_free_xattr_list (struct guestfs_free_xattr_list *);\n"
19217 #: ../src/guestfs-structs.pod:209
19218 msgid "guestfs_inotify_event"
19222 #: ../src/guestfs-structs.pod:211
19225 " struct guestfs_inotify_event {\n"
19226 " int64_t in_wd;\n"
19227 " uint32_t in_mask;\n"
19228 " uint32_t in_cookie;\n"
19229 " char *in_name;\n"
19235 #: ../src/guestfs-structs.pod:218
19238 " struct guestfs_inotify_event_list {\n"
19239 " uint32_t len; /* Number of elements in list. */\n"
19240 " struct guestfs_inotify_event *val; /* Elements. */\n"
19246 #: ../src/guestfs-structs.pod:223
19249 " void guestfs_free_inotify_event (struct guestfs_free_inotify_event *);\n"
19250 " void guestfs_free_inotify_event_list (struct guestfs_free_inotify_event_list *);\n"
19255 #: ../src/guestfs-structs.pod:226
19256 msgid "guestfs_partition"
19260 #: ../src/guestfs-structs.pod:228
19263 " struct guestfs_partition {\n"
19264 " int32_t part_num;\n"
19265 " uint64_t part_start;\n"
19266 " uint64_t part_end;\n"
19267 " uint64_t part_size;\n"
19273 #: ../src/guestfs-structs.pod:235
19276 " struct guestfs_partition_list {\n"
19277 " uint32_t len; /* Number of elements in list. */\n"
19278 " struct guestfs_partition *val; /* Elements. */\n"
19284 #: ../src/guestfs-structs.pod:240
19287 " void guestfs_free_partition (struct guestfs_free_partition *);\n"
19288 " void guestfs_free_partition_list (struct guestfs_free_partition_list *);\n"
19293 #: ../src/guestfs-structs.pod:243
19294 msgid "guestfs_application"
19298 #: ../src/guestfs-structs.pod:245
19301 " struct guestfs_application {\n"
19302 " char *app_name;\n"
19303 " char *app_display_name;\n"
19304 " int32_t app_epoch;\n"
19305 " char *app_version;\n"
19306 " char *app_release;\n"
19307 " char *app_install_path;\n"
19308 " char *app_trans_path;\n"
19309 " char *app_publisher;\n"
19310 " char *app_url;\n"
19311 " char *app_source_package;\n"
19312 " char *app_summary;\n"
19313 " char *app_description;\n"
19319 #: ../src/guestfs-structs.pod:260
19322 " struct guestfs_application_list {\n"
19323 " uint32_t len; /* Number of elements in list. */\n"
19324 " struct guestfs_application *val; /* Elements. */\n"
19330 #: ../src/guestfs-structs.pod:265
19333 " void guestfs_free_application (struct guestfs_free_application *);\n"
19334 " void guestfs_free_application_list (struct guestfs_free_application_list *);\n"
19339 #: ../fish/guestfish.pod:5
19340 msgid "guestfish - the libguestfs Filesystem Interactive SHell"
19344 #: ../fish/guestfish.pod:9
19347 " guestfish [--options] [commands]\n"
19352 #: ../fish/guestfish.pod:11
19360 #: ../fish/guestfish.pod:13
19363 " guestfish [--ro|--rw] -a disk.img\n"
19368 #: ../fish/guestfish.pod:15
19371 " guestfish [--ro|--rw] -a disk.img -m dev[:mountpoint]\n"
19376 #: ../fish/guestfish.pod:17
19379 " guestfish -d libvirt-domain\n"
19384 #: ../fish/guestfish.pod:19
19387 " guestfish [--ro|--rw] -a disk.img -i\n"
19392 #: ../fish/guestfish.pod:21
19395 " guestfish -d libvirt-domain -i\n"
19400 #: ../fish/guestfish.pod:23 ../fuse/guestmount.pod:15 ../tools/virt-edit.pl:44
19401 #: ../tools/virt-win-reg.pl:51 ../tools/virt-tar.pl:64
19406 #: ../fish/guestfish.pod:25
19408 "Using guestfish in read/write mode on live virtual machines can be "
19409 "dangerous, potentially causing disk corruption. Use the I<--ro> (read-only) "
19410 "option to use guestfish safely if the disk image or virtual machine might be "
19415 #: ../fish/guestfish.pod:32
19417 "Guestfish is a shell and command-line tool for examining and modifying "
19418 "virtual machine filesystems. It uses libguestfs and exposes all of the "
19419 "functionality of the guestfs API, see L<guestfs(3)>."
19423 #: ../fish/guestfish.pod:36
19425 "Guestfish gives you structured access to the libguestfs API, from shell "
19426 "scripts or the command line or interactively. If you want to rescue a "
19427 "broken virtual machine image, you should look at the L<virt-rescue(1)> "
19432 #: ../fish/guestfish.pod:41 ../fish/guestfish.pod:958
19433 #: ../fuse/guestmount.pod:39 ../tools/virt-edit.pl:63 ../tools/virt-tar.pl:50
19438 #: ../fish/guestfish.pod:43
19439 msgid "As an interactive shell"
19443 #: ../fish/guestfish.pod:45
19451 #: ../fish/guestfish.pod:47
19454 " Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
19455 " editing virtual machine filesystems.\n"
19460 #: ../fish/guestfish.pod:50
19463 " Type: 'help' for a list of commands\n"
19464 " 'man' to read the manual\n"
19465 " 'quit' to quit the shell\n"
19470 #: ../fish/guestfish.pod:54
19473 " ><fs> add-ro disk.img\n"
19475 " ><fs> list-filesystems\n"
19476 " /dev/sda1: ext4\n"
19477 " /dev/vg_guest/lv_root: ext4\n"
19478 " /dev/vg_guest/lv_swap: swap\n"
19479 " ><fs> mount /dev/vg_guest/lv_root /\n"
19480 " ><fs> cat /etc/fstab\n"
19482 " # Created by anaconda\n"
19489 #: ../fish/guestfish.pod:67
19490 msgid "From shell scripts"
19494 #: ../fish/guestfish.pod:69
19495 msgid "Create a new C</etc/motd> file in a guest or disk image:"
19499 #: ../fish/guestfish.pod:71
19502 " guestfish <<_EOF_\n"
19505 " mount /dev/vg_guest/lv_root /\n"
19506 " write /etc/motd \"Welcome, new users\"\n"
19512 #: ../fish/guestfish.pod:78
19513 msgid "List the LVM logical volumes in a disk image:"
19517 #: ../fish/guestfish.pod:80
19520 " guestfish -a disk.img --ro <<_EOF_\n"
19528 #: ../fish/guestfish.pod:85
19529 msgid "List all the filesystems in a disk image:"
19533 #: ../fish/guestfish.pod:87
19536 " guestfish -a disk.img --ro <<_EOF_\n"
19538 " list-filesystems\n"
19544 #: ../fish/guestfish.pod:92
19545 msgid "On one command line"
19549 #: ../fish/guestfish.pod:94
19550 msgid "Update C</etc/resolv.conf> in a guest:"
19554 #: ../fish/guestfish.pod:96
19558 " add disk.img : run : mount /dev/vg_guest/lv_root / : \\\n"
19559 " write /etc/resolv.conf \"nameserver 1.2.3.4\"\n"
19564 #: ../fish/guestfish.pod:100
19565 msgid "Edit C</boot/grub/grub.conf> interactively:"
19569 #: ../fish/guestfish.pod:102
19572 " guestfish --rw --add disk.img \\\n"
19573 " --mount /dev/vg_guest/lv_root \\\n"
19574 " --mount /dev/sda1:/boot \\\n"
19575 " edit /boot/grub/grub.conf\n"
19580 #: ../fish/guestfish.pod:107
19581 msgid "Mount disks automatically"
19585 #: ../fish/guestfish.pod:109
19587 "Use the I<-i> option to automatically mount the disks from a virtual machine:"
19591 #: ../fish/guestfish.pod:112
19594 " guestfish --ro -a disk.img -i cat /etc/group\n"
19599 #: ../fish/guestfish.pod:114
19602 " guestfish --ro -d libvirt-domain -i cat /etc/group\n"
19607 #: ../fish/guestfish.pod:116
19608 msgid "Another way to edit C</boot/grub/grub.conf> interactively is:"
19612 #: ../fish/guestfish.pod:118
19615 " guestfish --rw -a disk.img -i edit /boot/grub/grub.conf\n"
19620 #: ../fish/guestfish.pod:120
19621 msgid "As a script interpreter"
19625 #: ../fish/guestfish.pod:122
19626 msgid "Create a 100MB disk containing an ext2-formatted partition:"
19630 #: ../fish/guestfish.pod:124
19633 " #!/usr/bin/guestfish -f\n"
19634 " sparse test1.img 100M\n"
19636 " part-disk /dev/sda mbr\n"
19637 " mkfs ext2 /dev/sda1\n"
19642 #: ../fish/guestfish.pod:130
19643 msgid "Start with a prepared disk"
19647 #: ../fish/guestfish.pod:132
19649 "An alternate way to create a 100MB disk called C<test1.img> containing a "
19650 "single ext2-formatted partition:"
19654 #: ../fish/guestfish.pod:135
19657 " guestfish -N fs\n"
19662 #: ../fish/guestfish.pod:137
19663 msgid "To list what is available do:"
19667 #: ../fish/guestfish.pod:139 ../fish/guestfish.pod:949
19670 " guestfish -N help | less\n"
19675 #: ../fish/guestfish.pod:141
19676 msgid "Remote control"
19680 #: ../fish/guestfish.pod:143
19683 " eval \"`guestfish --listen`\"\n"
19684 " guestfish --remote add-ro disk.img\n"
19685 " guestfish --remote run\n"
19686 " guestfish --remote lvs\n"
19691 #: ../fish/guestfish.pod:148 ../test-tool/libguestfs-test-tool.pod:37
19692 #: ../fuse/guestmount.pod:83 ../tools/virt-edit.pl:81
19693 #: ../tools/virt-win-reg.pl:96 ../tools/virt-list-filesystems.pl:53
19694 #: ../tools/virt-tar.pl:103 ../tools/virt-make-fs.pl:153
19695 #: ../tools/virt-list-partitions.pl:54
19700 #: ../fish/guestfish.pod:152 ../fuse/guestmount.pod:141
19701 #: ../tools/virt-edit.pl:89 ../tools/virt-win-reg.pl:104
19702 #: ../tools/virt-list-filesystems.pl:61 ../tools/virt-tar.pl:111
19703 #: ../tools/virt-make-fs.pl:161 ../tools/virt-list-partitions.pl:62
19708 #: ../fish/guestfish.pod:154
19709 msgid "Displays general help on options."
19713 #: ../fish/guestfish.pod:156
19718 #: ../fish/guestfish.pod:158
19719 msgid "B<--cmd-help>"
19723 #: ../fish/guestfish.pod:160
19724 msgid "Lists all available guestfish commands."
19728 #: ../fish/guestfish.pod:162
19733 #: ../fish/guestfish.pod:164
19734 msgid "B<--cmd-help cmd>"
19738 #: ../fish/guestfish.pod:166
19739 msgid "Displays detailed help on a single command C<cmd>."
19743 #: ../fish/guestfish.pod:168
19744 msgid "B<-a image>"
19748 #: ../fish/guestfish.pod:170
19749 msgid "B<--add image>"
19753 #: ../fish/guestfish.pod:172
19754 msgid "Add a block device or virtual machine image to the shell."
19758 #: ../fish/guestfish.pod:174 ../fuse/guestmount.pod:91
19760 "The format of the disk image is auto-detected. To override this and force a "
19761 "particular format use the I<--format=..> option."
19765 #: ../fish/guestfish.pod:177
19767 "Using this flag is mostly equivalent to using the C<add> command, with "
19768 "C<readonly:true> if the I<--ro> flag was given, and with C<format:...> if "
19769 "the I<--format=...> flag was given."
19773 #: ../fish/guestfish.pod:181
19778 #: ../fish/guestfish.pod:183
19779 msgid "B<--connect URI>"
19783 #: ../fish/guestfish.pod:185 ../fuse/guestmount.pod:96
19785 "When used in conjunction with the I<-d> option, this specifies the libvirt "
19786 "URI to use. The default is to use the default libvirt connection."
19790 #: ../fish/guestfish.pod:189
19795 #: ../fish/guestfish.pod:191
19797 "If using the I<--listen> option and a csh-like shell, use this option. See "
19798 "section L</REMOTE CONTROL AND CSH> below."
19802 #: ../fish/guestfish.pod:194
19803 msgid "B<-d libvirt-domain>"
19807 #: ../fish/guestfish.pod:196
19808 msgid "B<--domain libvirt-domain>"
19812 #: ../fish/guestfish.pod:198 ../fuse/guestmount.pod:102
19814 "Add disks from the named libvirt domain. If the I<--ro> option is also "
19815 "used, then any libvirt domain can be used. However in write mode, only "
19816 "libvirt domains which are shut down can be named here."
19820 #: ../fish/guestfish.pod:202
19822 "Using this flag is mostly equivalent to using the C<add-domain> command, "
19823 "with C<readonly:true> if the I<--ro> flag was given, and with C<format:...> "
19824 "if the I<--format:...> flag was given."
19828 #: ../fish/guestfish.pod:206
19833 #: ../fish/guestfish.pod:208
19834 msgid "B<--no-dest-paths>"
19838 #: ../fish/guestfish.pod:210
19840 "Don't tab-complete paths on the guest filesystem. It is useful to be able "
19841 "to hit the tab key to complete paths on the guest filesystem, but this "
19842 "causes extra \"hidden\" guestfs calls to be made, so this option is here to "
19843 "allow this feature to be disabled."
19847 #: ../fish/guestfish.pod:215 ../fuse/guestmount.pod:118
19848 msgid "B<--echo-keys>"
19852 #: ../fish/guestfish.pod:217 ../fuse/guestmount.pod:120
19854 "When prompting for keys and passphrases, guestfish normally turns echoing "
19855 "off so you cannot see what you are typing. If you are not worried about "
19856 "Tempest attacks and there is no one else in the room you can specify this "
19857 "flag to see what you are typing."
19861 #: ../fish/guestfish.pod:222
19866 #: ../fish/guestfish.pod:224
19867 msgid "B<--file file>"
19871 #: ../fish/guestfish.pod:226
19872 msgid "Read commands from C<file>. To write pure guestfish scripts, use:"
19876 #: ../fish/guestfish.pod:229
19879 " #!/usr/bin/guestfish -f\n"
19884 #: ../fish/guestfish.pod:231
19885 msgid "B<--format=raw|qcow2|..>"
19889 #: ../fish/guestfish.pod:233
19890 msgid "B<--format>"
19894 #: ../fish/guestfish.pod:235 ../fuse/guestmount.pod:127
19896 "The default for the I<-a> option is to auto-detect the format of the disk "
19897 "image. Using this forces the disk format for I<-a> options which follow on "
19898 "the command line. Using I<--format> with no argument switches back to auto-"
19899 "detection for subsequent I<-a> options."
19903 #: ../fish/guestfish.pod:242
19906 " guestfish --format=raw -a disk.img\n"
19911 #: ../fish/guestfish.pod:244
19912 msgid "forces raw format (no auto-detection) for C<disk.img>."
19916 #: ../fish/guestfish.pod:246
19919 " guestfish --format=raw -a disk.img --format -a another.img\n"
19924 #: ../fish/guestfish.pod:248
19926 "forces raw format (no auto-detection) for C<disk.img> and reverts to auto-"
19927 "detection for C<another.img>."
19931 #: ../fish/guestfish.pod:251
19933 "If you have untrusted raw-format guest disk images, you should use this "
19934 "option to specify the disk format. This avoids a possible security problem "
19935 "with malicious guests (CVE-2010-3851). See also L</add-drive-opts>."
19939 #: ../fish/guestfish.pod:256
19944 #: ../fish/guestfish.pod:258
19945 msgid "B<--inspector>"
19949 #: ../fish/guestfish.pod:260 ../fuse/guestmount.pod:147
19951 "Using L<virt-inspector(1)> code, inspect the disks looking for an operating "
19952 "system and mount filesystems as they would be mounted on the real virtual "
19957 #: ../fish/guestfish.pod:264
19958 msgid "Typical usage is either:"
19962 #: ../fish/guestfish.pod:266
19965 " guestfish -d myguest -i\n"
19970 #: ../fish/guestfish.pod:268
19971 msgid "(for an inactive libvirt domain called I<myguest>), or:"
19975 #: ../fish/guestfish.pod:270
19978 " guestfish --ro -d myguest -i\n"
19983 #: ../fish/guestfish.pod:272
19984 msgid "(for active domains, readonly), or specify the block device directly:"
19988 #: ../fish/guestfish.pod:274
19991 " guestfish --rw -a /dev/Guests/MyGuest -i\n"
19996 #: ../fish/guestfish.pod:276
19998 "Note that the command line syntax changed slightly over older versions of "
19999 "guestfish. You can still use the old syntax:"
20003 #: ../fish/guestfish.pod:279
20006 " guestfish [--ro] -i disk.img\n"
20011 #: ../fish/guestfish.pod:281
20014 " guestfish [--ro] -i libvirt-domain\n"
20019 #: ../fish/guestfish.pod:283
20021 "Using this flag is mostly equivalent to using the C<inspect-os> command and "
20022 "then using other commands to mount the filesystems that were found."
20026 #: ../fish/guestfish.pod:287 ../fuse/guestmount.pod:151
20027 msgid "B<--keys-from-stdin>"
20031 #: ../fish/guestfish.pod:289 ../fuse/guestmount.pod:153
20033 "Read key or passphrase parameters from stdin. The default is to try to read "
20034 "passphrases from the user by opening C</dev/tty>."
20038 #: ../fish/guestfish.pod:292
20039 msgid "B<--listen>"
20043 #: ../fish/guestfish.pod:294
20045 "Fork into the background and listen for remote commands. See section L</"
20046 "REMOTE CONTROL GUESTFISH OVER A SOCKET> below."
20050 #: ../fish/guestfish.pod:297 ../fuse/guestmount.pod:156
20055 #: ../fish/guestfish.pod:299 ../fuse/guestmount.pod:158
20057 "Connect to a live virtual machine. (Experimental, see L<guestfs(3)/"
20058 "ATTACHING TO RUNNING DAEMONS>)."
20062 #: ../fish/guestfish.pod:302 ../fuse/guestmount.pod:161
20063 msgid "B<-m dev[:mountpoint[:options]]>"
20067 #: ../fish/guestfish.pod:304 ../fuse/guestmount.pod:163
20068 msgid "B<--mount dev[:mountpoint[:options]]>"
20072 #: ../fish/guestfish.pod:306
20073 msgid "Mount the named partition or logical volume on the given mountpoint."
20077 #: ../fish/guestfish.pod:308
20078 msgid "If the mountpoint is omitted, it defaults to C</>."
20082 #: ../fish/guestfish.pod:310
20083 msgid "You have to mount something on C</> before most commands will work."
20087 #: ../fish/guestfish.pod:312
20089 "If any I<-m> or I<--mount> options are given, the guest is automatically "
20094 #: ../fish/guestfish.pod:315
20096 "If you don't know what filesystems a disk image contains, you can either run "
20097 "guestfish without this option, then list the partitions, filesystems and LVs "
20098 "available (see L</list-partitions>, L</list-filesystems> and L</lvs> "
20099 "commands), or you can use the L<virt-filesystems(1)> program."
20103 #: ../fish/guestfish.pod:321 ../fuse/guestmount.pod:171
20105 "The third (and rarely used) part of the mount parameter is the list of mount "
20106 "options used to mount the underlying filesystem. If this is not given, then "
20107 "the mount options are either the empty string or C<ro> (the latter if the "
20108 "I<--ro> flag is used). By specifying the mount options, you override this "
20109 "default choice. Probably the only time you would use this is to enable ACLs "
20110 "and/or extended attributes if the filesystem can support them:"
20114 #: ../fish/guestfish.pod:329 ../fuse/guestmount.pod:179
20117 " -m /dev/sda1:/:acl,user_xattr\n"
20122 #: ../fish/guestfish.pod:331
20123 msgid "Using this flag is equivalent to using the C<mount-options> command."
20127 #: ../fish/guestfish.pod:333
20132 #: ../fish/guestfish.pod:335
20133 msgid "B<--no-sync>"
20137 #: ../fish/guestfish.pod:337
20139 "Disable autosync. This is enabled by default. See the discussion of "
20140 "autosync in the L<guestfs(3)> manpage."
20144 #: ../fish/guestfish.pod:340
20149 #: ../fish/guestfish.pod:342
20150 msgid "B<--new type>"
20154 #: ../fish/guestfish.pod:344
20159 #: ../fish/guestfish.pod:346
20161 "Prepare a fresh disk image formatted as \"type\". This is an alternative to "
20162 "the I<-a> option: whereas I<-a> adds an existing disk, I<-N> creates a "
20163 "preformatted disk with a filesystem and adds it. See L</PREPARED DISK "
20168 #: ../fish/guestfish.pod:351
20169 msgid "B<--progress-bars>"
20173 #: ../fish/guestfish.pod:353
20174 msgid "Enable progress bars, even when guestfish is used non-interactively."
20178 #: ../fish/guestfish.pod:355
20180 "Progress bars are enabled by default when guestfish is used as an "
20181 "interactive shell."
20185 #: ../fish/guestfish.pod:358
20186 msgid "B<--no-progress-bars>"
20190 #: ../fish/guestfish.pod:360
20191 msgid "Disable progress bars."
20195 #: ../fish/guestfish.pod:362
20196 msgid "B<--remote[=pid]>"
20200 #: ../fish/guestfish.pod:364
20202 "Send remote commands to C<$GUESTFISH_PID> or C<pid>. See section L</REMOTE "
20203 "CONTROL GUESTFISH OVER A SOCKET> below."
20207 #: ../fish/guestfish.pod:367
20212 #: ../fish/guestfish.pod:369
20217 #: ../fish/guestfish.pod:371
20219 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
20220 "mounts are done read-only."
20224 #: ../fish/guestfish.pod:374
20226 "The option must always be used if the disk image or virtual machine might be "
20227 "running, and is generally recommended in cases where you don't need write "
20228 "access to the disk."
20232 #: ../fish/guestfish.pod:378
20234 "Note that prepared disk images created with I<-N> are not affected by this "
20235 "option. Also commands like C<add> are not affected - you have to specify "
20236 "the C<readonly:true> option explicitly if you need it."
20240 #: ../fish/guestfish.pod:382
20241 msgid "See also L</OPENING DISKS FOR READ AND WRITE> below."
20245 #: ../fish/guestfish.pod:384 ../fuse/guestmount.pod:235
20246 msgid "B<--selinux>"
20250 #: ../fish/guestfish.pod:386
20251 msgid "Enable SELinux support for the guest. See L<guestfs(3)/SELINUX>."
20255 #: ../fish/guestfish.pod:388
20260 #: ../fish/guestfish.pod:390
20261 msgid "B<--verbose>"
20265 #: ../fish/guestfish.pod:392
20267 "Enable very verbose messages. This is particularly useful if you find a bug."
20271 #: ../fish/guestfish.pod:395
20276 #: ../fish/guestfish.pod:397 ../tools/virt-edit.pl:97
20277 #: ../tools/virt-win-reg.pl:112 ../tools/virt-list-filesystems.pl:69
20278 #: ../tools/virt-tar.pl:119 ../tools/virt-make-fs.pl:169
20279 #: ../tools/virt-list-partitions.pl:70
20280 msgid "B<--version>"
20284 #: ../fish/guestfish.pod:399
20285 msgid "Display the guestfish / libguestfs version number and exit."
20289 #: ../fish/guestfish.pod:401
20294 #: ../fish/guestfish.pod:403
20299 #: ../fish/guestfish.pod:405 ../fuse/guestmount.pod:249
20301 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
20302 "mounts are done read-write."
20306 #: ../fish/guestfish.pod:408
20307 msgid "See L</OPENING DISKS FOR READ AND WRITE> below."
20311 #: ../fish/guestfish.pod:410
20316 #: ../fish/guestfish.pod:412
20317 msgid "Echo each command before executing it."
20321 #: ../fish/guestfish.pod:416
20322 msgid "COMMANDS ON COMMAND LINE"
20326 #: ../fish/guestfish.pod:418
20328 "Any additional (non-option) arguments are treated as commands to execute."
20332 #: ../fish/guestfish.pod:421
20334 "Commands to execute should be separated by a colon (C<:>), where the colon "
20335 "is a separate parameter. Thus:"
20339 #: ../fish/guestfish.pod:424
20342 " guestfish cmd [args...] : cmd [args...] : cmd [args...] ...\n"
20347 #: ../fish/guestfish.pod:426
20349 "If there are no additional arguments, then we enter a shell, either an "
20350 "interactive shell with a prompt (if the input is a terminal) or a non-"
20351 "interactive shell."
20355 #: ../fish/guestfish.pod:430
20357 "In either command line mode or non-interactive shell, the first command that "
20358 "gives an error causes the whole shell to exit. In interactive mode (with a "
20359 "prompt) if a command fails, you can continue to enter commands."
20363 #: ../fish/guestfish.pod:435
20364 msgid "USING launch (OR run)"
20368 #: ../fish/guestfish.pod:437
20370 "As with L<guestfs(3)>, you must first configure your guest by adding disks, "
20371 "then launch it, then mount any disks you need, and finally issue actions/"
20372 "commands. So the general order of the day is:"
20376 #: ../fish/guestfish.pod:445
20377 msgid "add or -a/--add"
20381 #: ../fish/guestfish.pod:449
20382 msgid "launch (aka run)"
20386 #: ../fish/guestfish.pod:453
20387 msgid "mount or -m/--mount"
20391 #: ../fish/guestfish.pod:457
20392 msgid "any other commands"
20396 #: ../fish/guestfish.pod:461
20398 "C<run> is a synonym for C<launch>. You must C<launch> (or C<run>) your "
20399 "guest before mounting or performing any other commands."
20403 #: ../fish/guestfish.pod:464
20405 "The only exception is that if any of the I<-i>, I<-m>, I<--mount>, I<-N> or "
20406 "I<--new> options were given then C<run> is done automatically, simply "
20407 "because guestfish can't perform the action you asked for without doing this."
20411 #: ../fish/guestfish.pod:469
20412 msgid "OPENING DISKS FOR READ AND WRITE"
20416 #: ../fish/guestfish.pod:471
20418 "The guestfish, L<guestmount(1)> and L<virt-rescue(1)> options I<--ro> and "
20419 "I<--rw> affect whether the other command line options I<-a>, I<-c>, I<-d>, "
20420 "I<-i> and I<-m> open disk images read-only or for writing."
20424 #: ../fish/guestfish.pod:476
20426 "In libguestfs E<le> 1.10, guestfish, guestmount and virt-rescue defaulted to "
20427 "opening disk images supplied on the command line for write. To open a disk "
20428 "image read-only you have to do I<-a image --ro>."
20432 #: ../fish/guestfish.pod:480
20434 "This matters: If you accidentally open a live VM disk image writable then "
20435 "you will cause irreversible disk corruption."
20439 #: ../fish/guestfish.pod:483
20441 "By libguestfs 1.12 we intend to change the default the other way. Disk "
20442 "images will be opened read-only. You will have to either specify "
20443 "I<guestfish --rw>, I<guestmount --rw>, I<virt-rescue --rw>, or change the "
20444 "configuration file C</etc/libguestfs-tools.conf> in order to get write "
20445 "access for disk images specified by those other command line options."
20449 #: ../fish/guestfish.pod:490
20451 "This version of guestfish, guestmount and virt-rescue has a I<--rw> option "
20452 "which does nothing (it is already the default). However it is highly "
20453 "recommended that you use this option to indicate that you need write access, "
20454 "and prepare your scripts for the day when this option will be required for "
20459 #: ../fish/guestfish.pod:496
20461 "B<Note:> This does I<not> affect commands like L</add> and L</mount>, or any "
20462 "other libguestfs program apart from guestfish and guestmount."
20466 #: ../fish/guestfish.pod:499
20471 #: ../fish/guestfish.pod:501
20473 "You can quote ordinary parameters using either single or double quotes. For "
20478 #: ../fish/guestfish.pod:504
20481 " add \"file with a space.img\"\n"
20486 #: ../fish/guestfish.pod:506
20489 " rm '/file name'\n"
20494 #: ../fish/guestfish.pod:508
20502 #: ../fish/guestfish.pod:510
20504 "A few commands require a list of strings to be passed. For these, use a "
20505 "whitespace-separated list, enclosed in quotes. Strings containing "
20506 "whitespace to be passed through must be enclosed in single quotes. A "
20507 "literal single quote must be escaped with a backslash."
20511 #: ../fish/guestfish.pod:515
20514 " vgcreate VG \"/dev/sda1 /dev/sdb1\"\n"
20515 " command \"/bin/echo 'foo bar'\"\n"
20516 " command \"/bin/echo \\'foo\\'\"\n"
20521 #: ../fish/guestfish.pod:519
20522 msgid "OPTIONAL ARGUMENTS"
20526 #: ../fish/guestfish.pod:521
20528 "Some commands take optional arguments. These arguments appear in this "
20529 "documentation as C<[argname:..]>. You can use them as in these examples:"
20533 #: ../fish/guestfish.pod:525
20536 " add-drive-opts filename\n"
20541 #: ../fish/guestfish.pod:527
20544 " add-drive-opts filename readonly:true\n"
20549 #: ../fish/guestfish.pod:529
20552 " add-drive-opts filename format:qcow2 readonly:false\n"
20557 #: ../fish/guestfish.pod:531
20559 "Each optional argument can appear at most once. All optional arguments must "
20560 "appear after the required ones."
20564 #: ../fish/guestfish.pod:534
20569 #: ../fish/guestfish.pod:536
20571 "This section applies to all commands which can take integers as parameters."
20575 #: ../fish/guestfish.pod:539
20576 msgid "SIZE SUFFIX"
20580 #: ../fish/guestfish.pod:541
20582 "When the command takes a parameter measured in bytes, you can use one of the "
20583 "following suffixes to specify kilobytes, megabytes and larger sizes:"
20587 #: ../fish/guestfish.pod:547
20588 msgid "B<k> or B<K> or B<KiB>"
20592 #: ../fish/guestfish.pod:549
20593 msgid "The size in kilobytes (multiplied by 1024)."
20597 #: ../fish/guestfish.pod:551
20602 #: ../fish/guestfish.pod:553
20603 msgid "The size in SI 1000 byte units."
20607 #: ../fish/guestfish.pod:555
20608 msgid "B<M> or B<MiB>"
20612 #: ../fish/guestfish.pod:557
20613 msgid "The size in megabytes (multiplied by 1048576)."
20617 #: ../fish/guestfish.pod:559
20622 #: ../fish/guestfish.pod:561
20623 msgid "The size in SI 1000000 byte units."
20627 #: ../fish/guestfish.pod:563
20628 msgid "B<G> or B<GiB>"
20632 #: ../fish/guestfish.pod:565
20633 msgid "The size in gigabytes (multiplied by 2**30)."
20637 #: ../fish/guestfish.pod:567
20642 #: ../fish/guestfish.pod:569
20643 msgid "The size in SI 10**9 byte units."
20647 #: ../fish/guestfish.pod:571
20648 msgid "B<T> or B<TiB>"
20652 #: ../fish/guestfish.pod:573
20653 msgid "The size in terabytes (multiplied by 2**40)."
20657 #: ../fish/guestfish.pod:575
20662 #: ../fish/guestfish.pod:577
20663 msgid "The size in SI 10**12 byte units."
20667 #: ../fish/guestfish.pod:579
20668 msgid "B<P> or B<PiB>"
20672 #: ../fish/guestfish.pod:581
20673 msgid "The size in petabytes (multiplied by 2**50)."
20677 #: ../fish/guestfish.pod:583
20682 #: ../fish/guestfish.pod:585
20683 msgid "The size in SI 10**15 byte units."
20687 #: ../fish/guestfish.pod:587
20688 msgid "B<E> or B<EiB>"
20692 #: ../fish/guestfish.pod:589
20693 msgid "The size in exabytes (multiplied by 2**60)."
20697 #: ../fish/guestfish.pod:591
20702 #: ../fish/guestfish.pod:593
20703 msgid "The size in SI 10**18 byte units."
20707 #: ../fish/guestfish.pod:595
20708 msgid "B<Z> or B<ZiB>"
20712 #: ../fish/guestfish.pod:597
20713 msgid "The size in zettabytes (multiplied by 2**70)."
20717 #: ../fish/guestfish.pod:599
20722 #: ../fish/guestfish.pod:601
20723 msgid "The size in SI 10**21 byte units."
20727 #: ../fish/guestfish.pod:603
20728 msgid "B<Y> or B<YiB>"
20732 #: ../fish/guestfish.pod:605
20733 msgid "The size in yottabytes (multiplied by 2**80)."
20737 #: ../fish/guestfish.pod:607
20742 #: ../fish/guestfish.pod:609
20743 msgid "The size in SI 10**24 byte units."
20747 #: ../fish/guestfish.pod:615
20750 " truncate-size /file 1G\n"
20755 #: ../fish/guestfish.pod:617
20756 msgid "would truncate the file to 1 gigabyte."
20760 #: ../fish/guestfish.pod:619
20762 "Be careful because a few commands take sizes in kilobytes or megabytes (eg. "
20763 "the parameter to L</memsize> is specified in megabytes already). Adding a "
20764 "suffix will probably not do what you expect."
20768 #: ../fish/guestfish.pod:623
20769 msgid "OCTAL AND HEXADECIMAL NUMBERS"
20773 #: ../fish/guestfish.pod:625
20775 "For specifying the radix (base) use the C convention: C<0> to prefix an "
20776 "octal number or C<0x> to prefix a hexadecimal number. For example:"
20780 #: ../fish/guestfish.pod:628
20783 " 1234 decimal number 1234\n"
20784 " 02322 octal number, equivalent to decimal 1234\n"
20785 " 0x4d2 hexadecimal number, equivalent to decimal 1234\n"
20790 #: ../fish/guestfish.pod:632
20792 "When using the C<chmod> command, you almost always want to specify an octal "
20793 "number for the mode, and you must prefix it with C<0> (unlike the Unix "
20794 "L<chmod(1)> program):"
20798 #: ../fish/guestfish.pod:636
20801 " chmod 0777 /public # OK\n"
20802 " chmod 777 /public # WRONG! This is mode 777 decimal = 01411 octal.\n"
20807 #: ../fish/guestfish.pod:639
20809 "Commands that return numbers usually print them in decimal, but some "
20810 "commands print numbers in other radices (eg. C<umask> prints the mode in "
20811 "octal, preceeded by C<0>)."
20815 #: ../fish/guestfish.pod:643
20816 msgid "WILDCARDS AND GLOBBING"
20820 #: ../fish/guestfish.pod:645
20822 "Neither guestfish nor the underlying guestfs API performs wildcard expansion "
20823 "(globbing) by default. So for example the following will not do what you "
20828 #: ../fish/guestfish.pod:649
20836 #: ../fish/guestfish.pod:651
20838 "Assuming you don't have a directory called literally C</home/*> then the "
20839 "above command will return an error."
20843 #: ../fish/guestfish.pod:654
20844 msgid "To perform wildcard expansion, use the C<glob> command."
20848 #: ../fish/guestfish.pod:656
20851 " glob rm-rf /home/*\n"
20856 #: ../fish/guestfish.pod:658
20858 "runs C<rm-rf> on each path that matches (ie. potentially running the command "
20859 "many times), equivalent to:"
20863 #: ../fish/guestfish.pod:661
20866 " rm-rf /home/jim\n"
20867 " rm-rf /home/joe\n"
20868 " rm-rf /home/mary\n"
20873 #: ../fish/guestfish.pod:665
20874 msgid "C<glob> only works on simple guest paths and not on device names."
20878 #: ../fish/guestfish.pod:667
20880 "If you have several parameters, each containing a wildcard, then glob will "
20881 "perform a Cartesian product."
20885 #: ../fish/guestfish.pod:670
20890 #: ../fish/guestfish.pod:672
20892 "Any line which starts with a I<#> character is treated as a comment and "
20893 "ignored. The I<#> can optionally be preceeded by whitespace, but B<not> by "
20894 "a command. For example:"
20898 #: ../fish/guestfish.pod:676
20901 " # this is a comment\n"
20902 " # this is a comment\n"
20903 " foo # NOT a comment\n"
20908 #: ../fish/guestfish.pod:680
20909 msgid "Blank lines are also ignored."
20913 #: ../fish/guestfish.pod:682
20914 msgid "RUNNING COMMANDS LOCALLY"
20918 #: ../fish/guestfish.pod:684
20920 "Any line which starts with a I<!> character is treated as a command sent to "
20921 "the local shell (C</bin/sh> or whatever L<system(3)> uses). For example:"
20925 #: ../fish/guestfish.pod:688
20929 " tgz-out /remote local/remote-data.tar.gz\n"
20934 #: ../fish/guestfish.pod:691
20936 "will create a directory C<local> on the host, and then export the contents "
20937 "of C</remote> on the mounted filesystem to C<local/remote-data.tar.gz>. "
20938 "(See C<tgz-out>)."
20942 #: ../fish/guestfish.pod:695
20944 "To change the local directory, use the C<lcd> command. C<!cd> will have no "
20945 "effect, due to the way that subprocesses work in Unix."
20949 #: ../fish/guestfish.pod:698
20950 msgid "LOCAL COMMANDS WITH INLINE EXECUTION"
20954 #: ../fish/guestfish.pod:700
20956 "If a line starts with I<E<lt>!> then the shell command is executed (as for "
20957 "I<!>), but subsequently any output (stdout) of the shell command is parsed "
20958 "and executed as guestfish commands."
20962 #: ../fish/guestfish.pod:704
20964 "Thus you can use shell script to construct arbitrary guestfish commands "
20965 "which are then parsed by guestfish."
20969 #: ../fish/guestfish.pod:707
20971 "For example it is tedious to create a sequence of files (eg. C</foo.1> "
20972 "through C</foo.100>) using guestfish commands alone. However this is simple "
20973 "if we use a shell script to create the guestfish commands for us:"
20977 #: ../fish/guestfish.pod:712
20980 " <! for n in `seq 1 100`; do echo write /foo.$n $n; done\n"
20985 #: ../fish/guestfish.pod:714
20986 msgid "or with names like C</foo.001>:"
20990 #: ../fish/guestfish.pod:716
20993 " <! for n in `seq 1 100`; do printf \"write /foo.%03d %d\\n\" $n $n; done\n"
20998 #: ../fish/guestfish.pod:718
21000 "When using guestfish interactively it can be helpful to just run the shell "
21001 "script first (ie. remove the initial C<E<lt>> character so it is just an "
21002 "ordinary I<!> local command), see what guestfish commands it would run, and "
21003 "when you are happy with those prepend the C<E<lt>> character to run the "
21004 "guestfish commands for real."
21008 #: ../fish/guestfish.pod:724
21013 #: ../fish/guestfish.pod:726
21015 "Use C<command E<lt>spaceE<gt> | command> to pipe the output of the first "
21016 "command (a guestfish command) to the second command (any host command). For "
21021 #: ../fish/guestfish.pod:730
21024 " cat /etc/passwd | awk -F: '$3 == 0 { print }'\n"
21029 #: ../fish/guestfish.pod:732
21031 "(where C<cat> is the guestfish cat command, but C<awk> is the host awk "
21032 "program). The above command would list all accounts in the guest filesystem "
21033 "which have UID 0, ie. root accounts including backdoors. Other examples:"
21037 #: ../fish/guestfish.pod:737
21040 " hexdump /bin/ls | head\n"
21041 " list-devices | tail -1\n"
21042 " tgz-out / - | tar ztf -\n"
21047 #: ../fish/guestfish.pod:741
21049 "The space before the pipe symbol is required, any space after the pipe "
21050 "symbol is optional. Everything after the pipe symbol is just passed "
21051 "straight to the host shell, so it can contain redirections, globs and "
21052 "anything else that makes sense on the host side."
21056 #: ../fish/guestfish.pod:746
21058 "To use a literal argument which begins with a pipe symbol, you have to quote "
21063 #: ../fish/guestfish.pod:749
21071 #: ../fish/guestfish.pod:751
21072 msgid "HOME DIRECTORIES"
21076 #: ../fish/guestfish.pod:753
21078 "If a parameter starts with the character C<~> then the tilde may be expanded "
21079 "as a home directory path (either C<~> for the current user's home directory, "
21080 "or C<~user> for another user)."
21084 #: ../fish/guestfish.pod:757
21086 "Note that home directory expansion happens for users known I<on the host>, "
21087 "not in the guest filesystem."
21091 #: ../fish/guestfish.pod:760
21093 "To use a literal argument which begins with a tilde, you have to quote it, "
21098 #: ../fish/guestfish.pod:763
21106 #: ../fish/guestfish.pod:767
21108 "Libguestfs has some support for Linux guests encrypted according to the "
21109 "Linux Unified Key Setup (LUKS) standard, which includes nearly all whole "
21110 "disk encryption systems used by modern Linux guests. Currently only LVM-on-"
21111 "LUKS is supported."
21115 #: ../fish/guestfish.pod:772
21116 msgid "Identify encrypted block devices and partitions using L</vfs-type>:"
21120 #: ../fish/guestfish.pod:774
21123 " ><fs> vfs-type /dev/sda2\n"
21129 #: ../fish/guestfish.pod:777
21131 "Then open those devices using L</luks-open>. This creates a device-mapper "
21132 "device called C</dev/mapper/luksdev>."
21136 #: ../fish/guestfish.pod:780
21139 " ><fs> luks-open /dev/sda2 luksdev\n"
21140 " Enter key or passphrase (\"key\"): <enter the passphrase>\n"
21145 #: ../fish/guestfish.pod:783
21147 "Finally you have to tell LVM to scan for volume groups on the newly created "
21152 #: ../fish/guestfish.pod:786
21156 " vg-activate-all true\n"
21161 #: ../fish/guestfish.pod:789
21162 msgid "The logical volume(s) can now be mounted in the usual way."
21166 #: ../fish/guestfish.pod:791
21168 "Before closing a LUKS device you must unmount any logical volumes on it and "
21169 "deactivate the volume groups by calling C<vg-activate false VG> on each "
21170 "one. Then you can close the mapper device:"
21174 #: ../fish/guestfish.pod:795
21177 " vg-activate false /dev/VG\n"
21178 " luks-close /dev/mapper/luksdev\n"
21183 #: ../fish/guestfish.pod:798 ../tools/virt-edit.pl:342
21184 msgid "WINDOWS PATHS"
21188 #: ../fish/guestfish.pod:800
21190 "If a path is prefixed with C<win:> then you can use Windows-style drive "
21191 "letters and paths (with some limitations). The following commands are "
21196 #: ../fish/guestfish.pod:804
21199 " file /WINDOWS/system32/config/system.LOG\n"
21204 #: ../fish/guestfish.pod:806
21207 " file win:\\windows\\system32\\config\\system.log\n"
21212 #: ../fish/guestfish.pod:808
21215 " file WIN:C:\\Windows\\SYSTEM32\\CONFIG\\SYSTEM.LOG\n"
21220 #: ../fish/guestfish.pod:810
21222 "The parameter is rewritten \"behind the scenes\" by looking up the position "
21223 "where the drive is mounted, prepending that to the path, changing all "
21224 "backslash characters to forward slash, then resolving the result using L</"
21225 "case-sensitive-path>. For example if the E: drive was mounted on C</e> then "
21226 "the parameter might be rewritten like this:"
21230 #: ../fish/guestfish.pod:816
21233 " win:e:\\foo\\bar => /e/FOO/bar\n"
21238 #: ../fish/guestfish.pod:818
21239 msgid "This only works in argument positions that expect a path."
21243 #: ../fish/guestfish.pod:820
21244 msgid "UPLOADING AND DOWNLOADING FILES"
21248 #: ../fish/guestfish.pod:822
21250 "For commands such as C<upload>, C<download>, C<tar-in>, C<tar-out> and "
21251 "others which upload from or download to a local file, you can use the "
21252 "special filename C<-> to mean \"from stdin\" or \"to stdout\". For example:"
21256 #: ../fish/guestfish.pod:826
21264 #: ../fish/guestfish.pod:828
21266 "reads stdin and creates from that a file C</foo> in the disk image, and:"
21270 #: ../fish/guestfish.pod:831
21273 " tar-out /etc - | tar tf -\n"
21278 #: ../fish/guestfish.pod:833
21280 "writes the tarball to stdout and then pipes that into the external \"tar\" "
21281 "command (see L</PIPES>)."
21285 #: ../fish/guestfish.pod:836
21287 "When using C<-> to read from stdin, the input is read up to the end of "
21288 "stdin. You can also use a special \"heredoc\"-like syntax to read up to "
21289 "some arbitrary end marker:"
21293 #: ../fish/guestfish.pod:840
21296 " upload -<<END /foo\n"
21305 #: ../fish/guestfish.pod:846
21307 "Any string of characters can be used instead of C<END>. The end marker must "
21308 "appear on a line of its own, without any preceeding or following characters "
21309 "(not even spaces)."
21313 #: ../fish/guestfish.pod:850
21315 "Note that the C<-E<lt>E<lt>> syntax only applies to parameters used to "
21316 "upload local files (so-called \"FileIn\" parameters in the generator)."
21320 #: ../fish/guestfish.pod:853
21321 msgid "EXIT ON ERROR BEHAVIOUR"
21325 #: ../fish/guestfish.pod:855
21327 "By default, guestfish will ignore any errors when in interactive mode (ie. "
21328 "taking commands from a human over a tty), and will exit on the first error "
21329 "in non-interactive mode (scripts, commands given on the command line)."
21333 #: ../fish/guestfish.pod:860
21335 "If you prefix a command with a I<-> character, then that command will not "
21336 "cause guestfish to exit, even if that (one) command returns an error."
21340 #: ../fish/guestfish.pod:864
21341 msgid "REMOTE CONTROL GUESTFISH OVER A SOCKET"
21345 #: ../fish/guestfish.pod:866
21347 "Guestfish can be remote-controlled over a socket. This is useful "
21348 "particularly in shell scripts where you want to make several different "
21349 "changes to a filesystem, but you don't want the overhead of starting up a "
21350 "guestfish process each time."
21354 #: ../fish/guestfish.pod:871
21355 msgid "Start a guestfish server process using:"
21359 #: ../fish/guestfish.pod:873
21362 " eval \"`guestfish --listen`\"\n"
21367 #: ../fish/guestfish.pod:875
21368 msgid "and then send it commands by doing:"
21372 #: ../fish/guestfish.pod:877
21375 " guestfish --remote cmd [...]\n"
21380 #: ../fish/guestfish.pod:879
21381 msgid "To cause the server to exit, send it the exit command:"
21385 #: ../fish/guestfish.pod:881
21388 " guestfish --remote exit\n"
21393 #: ../fish/guestfish.pod:883
21395 "Note that the server will normally exit if there is an error in a command. "
21396 "You can change this in the usual way. See section L</EXIT ON ERROR "
21401 #: ../fish/guestfish.pod:887
21402 msgid "CONTROLLING MULTIPLE GUESTFISH PROCESSES"
21406 #: ../fish/guestfish.pod:889
21408 "The C<eval> statement sets the environment variable C<$GUESTFISH_PID>, which "
21409 "is how the I<--remote> option knows where to send the commands. You can "
21410 "have several guestfish listener processes running using:"
21414 #: ../fish/guestfish.pod:893
21417 " eval \"`guestfish --listen`\"\n"
21418 " pid1=$GUESTFISH_PID\n"
21419 " eval \"`guestfish --listen`\"\n"
21420 " pid2=$GUESTFISH_PID\n"
21422 " guestfish --remote=$pid1 cmd\n"
21423 " guestfish --remote=$pid2 cmd\n"
21428 #: ../fish/guestfish.pod:901
21429 msgid "REMOTE CONTROL AND CSH"
21433 #: ../fish/guestfish.pod:903
21435 "When using csh-like shells (csh, tcsh etc) you have to add the I<--csh> "
21440 #: ../fish/guestfish.pod:906
21443 " eval \"`guestfish --listen --csh`\"\n"
21448 #: ../fish/guestfish.pod:908
21449 msgid "REMOTE CONTROL DETAILS"
21453 #: ../fish/guestfish.pod:910
21455 "Remote control happens over a Unix domain socket called C</tmp/.guestfish-"
21456 "$UID/socket-$PID>, where C<$UID> is the effective user ID of the process, "
21457 "and C<$PID> is the process ID of the server."
21461 #: ../fish/guestfish.pod:914
21462 msgid "Guestfish client and server versions must match exactly."
21466 #: ../fish/guestfish.pod:916
21467 msgid "REMOTE CONTROL RUN COMMAND HANGING"
21471 #: ../fish/guestfish.pod:918
21473 "Using the C<run> (or C<launch>) command remotely in a command substitution "
21474 "context hangs, ie. don't do (note the backquotes):"
21478 #: ../fish/guestfish.pod:921
21481 " a=`guestfish --remote run`\n"
21486 #: ../fish/guestfish.pod:923
21488 "Since the C<run> command produces no output on stdout, this is not useful "
21489 "anyway. For further information see L<https://bugzilla.redhat.com/show_bug."
21494 #: ../fish/guestfish.pod:927
21495 msgid "PREPARED DISK IMAGES"
21499 #: ../fish/guestfish.pod:929
21501 "Use the I<-N type> or I<--new type> parameter to select one of a set of "
21502 "preformatted disk images that guestfish can make for you to save typing. "
21503 "This is particularly useful for testing purposes. This option is used "
21504 "instead of the I<-a> option, and like I<-a> can appear multiple times (and "
21505 "can be mixed with I<-a>)."
21509 #: ../fish/guestfish.pod:935
21511 "The new disk is called C<test1.img> for the first I<-N>, C<test2.img> for "
21512 "the second and so on. Existing files in the current directory are "
21517 #: ../fish/guestfish.pod:939
21519 "The type briefly describes how the disk should be sized, partitioned, how "
21520 "filesystem(s) should be created, and how content should be added. "
21521 "Optionally the type can be followed by extra parameters, separated by C<:> "
21522 "(colon) characters. For example, I<-N fs> creates a default 100MB, sparsely-"
21523 "allocated disk, containing a single partition, with the partition formatted "
21524 "as ext2. I<-N fs:ext4:1G> is the same, but for an ext4 filesystem on a 1GB "
21529 #: ../fish/guestfish.pod:947
21530 msgid "To list the available types and any extra parameters they take, run:"
21534 #: ../fish/guestfish.pod:951
21536 "Note that the prepared filesystem is not mounted. You would usually have to "
21537 "use the C<mount /dev/sda1 /> command or add the I<-m /dev/sda1> option."
21541 #: ../fish/guestfish.pod:955
21543 "If any I<-N> or I<--new> options are given, the guest is automatically "
21548 #: ../fish/guestfish.pod:960
21549 msgid "Create a 100MB disk with an ext4-formatted partition:"
21553 #: ../fish/guestfish.pod:962
21556 " guestfish -N fs:ext4\n"
21561 #: ../fish/guestfish.pod:964
21562 msgid "Create a 32MB disk with a VFAT-formatted partition, and mount it:"
21566 #: ../fish/guestfish.pod:966
21569 " guestfish -N fs:vfat:32M -m /dev/sda1\n"
21574 #: ../fish/guestfish.pod:968
21575 msgid "Create a blank 200MB disk:"
21579 #: ../fish/guestfish.pod:970
21582 " guestfish -N disk:200M\n"
21587 #: ../fish/guestfish.pod:972
21588 msgid "PROGRESS BARS"
21592 #: ../fish/guestfish.pod:974
21594 "Some (not all) long-running commands send progress notification messages as "
21595 "they are running. Guestfish turns these messages into progress bars."
21599 #: ../fish/guestfish.pod:978
21601 "When a command that supports progress bars takes longer than two seconds to "
21602 "run, and if progress bars are enabled, then you will see one appearing below "
21607 #: ../fish/guestfish.pod:982
21610 " ><fs> copy-size /large-file /another-file 2048M\n"
21611 " / 10% [#####-----------------------------------------] 00:30\n"
21616 #: ../fish/guestfish.pod:985
21618 "The spinner on the left hand side moves round once for every progress "
21619 "notification received from the backend. This is a (reasonably) golden "
21620 "assurance that the command is \"doing something\" even if the progress bar "
21621 "is not moving, because the command is able to send the progress "
21622 "notifications. When the bar reaches 100% and the command finishes, the "
21623 "spinner disappears."
21627 #: ../fish/guestfish.pod:992
21629 "Progress bars are enabled by default when guestfish is used interactively. "
21630 "You can enable them even for non-interactive modes using I<--progress-bars>, "
21631 "and you can disable them completely using I<--no-progress-bars>."
21635 #: ../fish/guestfish.pod:997
21636 msgid "GUESTFISH COMMANDS"
21640 #: ../fish/guestfish.pod:999
21642 "The commands in this section are guestfish convenience commands, in other "
21643 "words, they are not part of the L<guestfs(3)> API."
21647 #: ../fish/guestfish.pod:1002
21652 #: ../fish/guestfish.pod:1004
21661 #: ../fish/guestfish.pod:1007
21662 msgid "Without any parameter, this provides general help."
21666 #: ../fish/guestfish.pod:1009
21667 msgid "With a C<cmd> parameter, this displays detailed help for that command."
21671 #: ../fish/guestfish.pod:1011
21672 msgid "quit | exit"
21676 #: ../fish/guestfish.pod:1013
21677 msgid "This exits guestfish. You can also use C<^D> key."
21681 #: ../fish/guestfish.pod:1015
21682 msgid "@FISH_COMMANDS@"
21686 #: ../fish/guestfish.pod:1017
21691 #: ../fish/guestfish.pod:1021 ../test-tool/libguestfs-test-tool.pod:77
21696 #: ../fish/guestfish.pod:1023
21698 "guestfish returns 0 if the commands completed without error, or 1 if there "
21703 #: ../fish/guestfish.pod:1030
21708 #: ../fish/guestfish.pod:1032
21710 "The C<edit> command uses C<$EDITOR> as the editor. If not set, it uses "
21715 #: ../fish/guestfish.pod:1035
21716 msgid "GUESTFISH_PID"
21720 #: ../fish/guestfish.pod:1037
21722 "Used with the I<--remote> option to specify the remote guestfish process to "
21723 "control. See section L</REMOTE CONTROL GUESTFISH OVER A SOCKET>."
21727 #: ../fish/guestfish.pod:1041
21732 #: ../fish/guestfish.pod:1043
21734 "The L</hexedit> command uses C<$HEXEDITOR> as the external hex editor. If "
21735 "not specified, the external L<hexedit(1)> program is used."
21739 #: ../fish/guestfish.pod:1047
21744 #: ../fish/guestfish.pod:1049
21746 "If compiled with GNU readline support, various files in the home directory "
21747 "can be used. See L</FILES>."
21751 #: ../fish/guestfish.pod:1058
21753 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
21754 "effect as using the B<-v> option."
21758 #: ../fish/guestfish.pod:1070
21760 "Set the path that guestfish uses to search for kernel and initrd.img. See "
21761 "the discussion of paths in L<guestfs(3)>."
21765 #: ../fish/guestfish.pod:1081
21766 msgid "Set C<LIBGUESTFS_TRACE=1> to enable command traces."
21770 #: ../fish/guestfish.pod:1083
21775 #: ../fish/guestfish.pod:1085
21777 "The C<more> command uses C<$PAGER> as the pager. If not set, it uses "
21782 #: ../fish/guestfish.pod:1101 ../fuse/guestmount.pod:262
21787 #: ../fish/guestfish.pod:1105 ../fuse/guestmount.pod:266
21788 msgid "$HOME/.libguestfs-tools.rc"
21792 #: ../fish/guestfish.pod:1107 ../fuse/guestmount.pod:268
21793 msgid "/etc/libguestfs-tools.conf"
21797 #: ../fish/guestfish.pod:1109 ../fuse/guestmount.pod:270
21799 "This configuration file controls the default read-only or read-write mode "
21800 "(I<--ro> or I<--rw>)."
21804 #: ../fish/guestfish.pod:1112
21805 msgid "See L</OPENING DISKS FOR READ AND WRITE>."
21809 #: ../fish/guestfish.pod:1114
21810 msgid "$HOME/.guestfish"
21814 #: ../fish/guestfish.pod:1116
21816 "If compiled with GNU readline support, then the command history is saved in "
21821 #: ../fish/guestfish.pod:1119
21822 msgid "$HOME/.inputrc"
21826 #: ../fish/guestfish.pod:1121
21827 msgid "/etc/inputrc"
21831 #: ../fish/guestfish.pod:1123
21833 "If compiled with GNU readline support, then these files can be used to "
21834 "configure readline. For further information, please see L<readline(3)/"
21835 "INITIALIZATION FILE>."
21839 #: ../fish/guestfish.pod:1127
21840 msgid "To write rules which only apply to guestfish, use:"
21844 #: ../fish/guestfish.pod:1129
21854 #: ../fish/guestfish.pod:1133
21856 "Variables that you can set in inputrc that change the behaviour of guestfish "
21857 "in useful ways include:"
21861 #: ../fish/guestfish.pod:1138
21862 msgid "completion-ignore-case (default: on)"
21866 #: ../fish/guestfish.pod:1140
21868 "By default, guestfish will ignore case when tab-completing paths on the "
21873 #: ../fish/guestfish.pod:1143
21876 " set completion-ignore-case off\n"
21881 #: ../fish/guestfish.pod:1145
21882 msgid "to make guestfish case sensitive."
21886 #: ../fish/guestfish.pod:1149
21891 #: ../fish/guestfish.pod:1151
21892 msgid "test2.img (etc)"
21896 #: ../fish/guestfish.pod:1153
21898 "When using the I<-N> or I<--new> option, the prepared disk or filesystem "
21899 "will be created in the file C<test1.img> in the current directory. The "
21900 "second use of I<-N> will use C<test2.img> and so on. Any existing file with "
21901 "the same name will be overwritten."
21905 #: ../fish/guestfish.pod:1162
21907 "L<guestfs(3)>, L<http://libguestfs.org/>, L<virt-cat(1)>, L<virt-copy-in(1)"
21908 ">, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, L<virt-filesystems(1)"
21909 ">, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, L<virt-list-partitions"
21910 "(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, L<virt-rescue(1)>, L<virt-resize(1)"
21911 ">, L<virt-tar(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<virt-win-reg(1)"
21912 ">, L<hexedit(1)>."
21916 #: ../fish/guestfish.pod:1192 ../test-tool/libguestfs-test-tool.pod:102
21917 #: ../fuse/guestmount.pod:297 ../tools/virt-edit.pl:518
21918 #: ../tools/virt-win-reg.pl:606 ../tools/virt-list-filesystems.pl:210
21919 #: ../tools/virt-tar.pl:309 ../tools/virt-make-fs.pl:572
21920 #: ../tools/virt-list-partitions.pl:277
21922 "This program is free software; you can redistribute it and/or modify it "
21923 "under the terms of the GNU General Public License as published by the Free "
21924 "Software Foundation; either version 2 of the License, or (at your option) "
21925 "any later version."
21929 #: ../fish/guestfish.pod:1197 ../test-tool/libguestfs-test-tool.pod:107
21930 #: ../fuse/guestmount.pod:302 ../tools/virt-edit.pl:523
21931 #: ../tools/virt-win-reg.pl:611 ../tools/virt-list-filesystems.pl:215
21932 #: ../tools/virt-tar.pl:314 ../tools/virt-make-fs.pl:577
21933 #: ../tools/virt-list-partitions.pl:282
21935 "This program is distributed in the hope that it will be useful, but WITHOUT "
21936 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
21937 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for "
21942 #: ../fish/guestfish.pod:1202 ../test-tool/libguestfs-test-tool.pod:112
21943 #: ../fuse/guestmount.pod:307 ../tools/virt-edit.pl:528
21944 #: ../tools/virt-win-reg.pl:616 ../tools/virt-list-filesystems.pl:220
21945 #: ../tools/virt-tar.pl:319 ../tools/virt-make-fs.pl:582
21946 #: ../tools/virt-list-partitions.pl:287
21948 "You should have received a copy of the GNU General Public License along with "
21949 "this program; if not, write to the Free Software Foundation, Inc., 675 Mass "
21950 "Ave, Cambridge, MA 02139, USA."
21954 #: ../fish/guestfish-actions.pod:1
21959 #: ../fish/guestfish-actions.pod:3
21962 " add-cdrom filename\n"
21967 #: ../fish/guestfish-actions.pod:15
21969 "This call checks for the existence of C<filename>. This stops you from "
21970 "specifying other types of drive which are supported by qemu such as C<nbd:> "
21971 "and C<http:> URLs. To specify those, use the general L</config> call "
21976 #: ../fish/guestfish-actions.pod:22
21978 "If you just want to add an ISO file (often you use this as an efficient way "
21979 "to transfer large files into the guest), then you should probably use L</add-"
21980 "drive-ro> instead."
21984 #: ../fish/guestfish-actions.pod:28 ../fish/guestfish-actions.pod:158
21985 #: ../fish/guestfish-actions.pod:172
21987 "This function is deprecated. In new code, use the L</add_drive_opts> call "
21992 #: ../fish/guestfish-actions.pod:35
21997 #: ../fish/guestfish-actions.pod:37
22002 #: ../fish/guestfish-actions.pod:39
22005 " add-domain dom [libvirturi:..] [readonly:..] [iface:..] [live:..]\n"
22010 #: ../fish/guestfish-actions.pod:41
22012 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
22013 "It works by connecting to libvirt, requesting the domain and domain XML from "
22014 "libvirt, parsing it for disks, and calling L</add-drive-opts> on each one."
22018 #: ../fish/guestfish-actions.pod:71
22020 "The other optional parameters are passed directly through to L</add-drive-"
22025 #: ../fish/guestfish-actions.pod:74 ../fish/guestfish-actions.pod:138
22026 #: ../fish/guestfish-actions.pod:3071
22028 "This command has one or more optional arguments. See L</OPTIONAL ARGUMENTS>."
22032 #: ../fish/guestfish-actions.pod:76
22037 #: ../fish/guestfish-actions.pod:78
22040 " add-drive filename\n"
22045 #: ../fish/guestfish-actions.pod:80
22047 "This function is the equivalent of calling L</add-drive-opts> with no "
22048 "optional parameters, so the disk is added writable, with the format being "
22049 "detected automatically."
22053 #: ../fish/guestfish-actions.pod:84
22055 "Automatic detection of the format opens you up to a potential security hole "
22056 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
22057 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
22058 "you should think about replacing calls to this function with calls to L</add-"
22059 "drive-opts>, and specifying the format."
22063 #: ../fish/guestfish-actions.pod:91
22064 msgid "add-drive-opts"
22068 #: ../fish/guestfish-actions.pod:93
22073 #: ../fish/guestfish-actions.pod:95
22076 " add-drive-opts filename [readonly:..] [format:..] [iface:..]\n"
22081 #: ../fish/guestfish-actions.pod:122
22083 "This forces the image format. If you omit this (or use L</add-drive> or L</"
22084 "add-drive-ro>) then the format is automatically detected. Possible formats "
22085 "include C<raw> and C<qcow2>."
22089 #: ../fish/guestfish-actions.pod:133
22091 "This rarely-used option lets you emulate the behaviour of the deprecated L</"
22092 "add-drive-with-if> call (q.v.)"
22096 #: ../fish/guestfish-actions.pod:140
22097 msgid "add-drive-ro"
22101 #: ../fish/guestfish-actions.pod:142
22106 #: ../fish/guestfish-actions.pod:144
22109 " add-drive-ro filename\n"
22114 #: ../fish/guestfish-actions.pod:146
22116 "This function is the equivalent of calling L</add-drive-opts> with the "
22117 "optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the disk "
22118 "is added read-only, with the format being detected automatically."
22122 #: ../fish/guestfish-actions.pod:151
22123 msgid "add-drive-ro-with-if"
22127 #: ../fish/guestfish-actions.pod:153
22130 " add-drive-ro-with-if filename iface\n"
22135 #: ../fish/guestfish-actions.pod:155
22137 "This is the same as L</add-drive-ro> but it allows you to specify the QEMU "
22138 "interface emulation to use at run time."
22142 #: ../fish/guestfish-actions.pod:165
22143 msgid "add-drive-with-if"
22147 #: ../fish/guestfish-actions.pod:167
22150 " add-drive-with-if filename iface\n"
22155 #: ../fish/guestfish-actions.pod:169
22157 "This is the same as L</add-drive> but it allows you to specify the QEMU "
22158 "interface emulation to use at run time."
22162 #: ../fish/guestfish-actions.pod:179
22167 #: ../fish/guestfish-actions.pod:181
22170 " aug-clear augpath\n"
22175 #: ../fish/guestfish-actions.pod:186
22180 #: ../fish/guestfish-actions.pod:188
22188 #: ../fish/guestfish-actions.pod:190
22190 "Close the current Augeas handle and free up any resources used by it. After "
22191 "calling this, you have to call L</aug-init> again before you can use any "
22192 "other Augeas functions."
22196 #: ../fish/guestfish-actions.pod:195
22197 msgid "aug-defnode"
22201 #: ../fish/guestfish-actions.pod:197
22204 " aug-defnode name expr val\n"
22209 #: ../fish/guestfish-actions.pod:202
22211 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
22212 "calling L</aug-set> C<expr>, C<value>. C<name> will be the nodeset "
22213 "containing that single node."
22217 #: ../fish/guestfish-actions.pod:210
22222 #: ../fish/guestfish-actions.pod:212
22225 " aug-defvar name expr\n"
22230 #: ../fish/guestfish-actions.pod:221
22235 #: ../fish/guestfish-actions.pod:223
22238 " aug-get augpath\n"
22243 #: ../fish/guestfish-actions.pod:228
22248 #: ../fish/guestfish-actions.pod:230
22251 " aug-init root flags\n"
22256 #: ../fish/guestfish-actions.pod:236
22257 msgid "You must call this before using any other L</aug-*> commands."
22261 #: ../fish/guestfish-actions.pod:261
22263 "This option is only useful when debugging Augeas lenses. Use of this option "
22264 "may require additional memory for the libguestfs appliance. You may need to "
22265 "set the C<LIBGUESTFS_MEMSIZE> environment variable or call L</set-memsize>."
22269 #: ../fish/guestfish-actions.pod:276
22270 msgid "Do not load the tree in L</aug-init>."
22274 #: ../fish/guestfish-actions.pod:280
22275 msgid "To close the handle, you can call L</aug-close>."
22279 #: ../fish/guestfish-actions.pod:284
22284 #: ../fish/guestfish-actions.pod:286
22287 " aug-insert augpath label true|false\n"
22292 #: ../fish/guestfish-actions.pod:296
22297 #: ../fish/guestfish-actions.pod:298
22305 #: ../fish/guestfish-actions.pod:305
22310 #: ../fish/guestfish-actions.pod:307
22313 " aug-ls augpath\n"
22318 #: ../fish/guestfish-actions.pod:309
22320 "This is just a shortcut for listing L</aug-match> C<path/*> and sorting the "
22321 "resulting nodes into alphabetical order."
22325 #: ../fish/guestfish-actions.pod:312
22330 #: ../fish/guestfish-actions.pod:314
22333 " aug-match augpath\n"
22338 #: ../fish/guestfish-actions.pod:320
22343 #: ../fish/guestfish-actions.pod:322
22346 " aug-mv src dest\n"
22351 #: ../fish/guestfish-actions.pod:327
22356 #: ../fish/guestfish-actions.pod:329
22359 " aug-rm augpath\n"
22364 #: ../fish/guestfish-actions.pod:335
22369 #: ../fish/guestfish-actions.pod:337
22377 #: ../fish/guestfish-actions.pod:341
22379 "The flags which were passed to L</aug-init> affect exactly how files are "
22384 #: ../fish/guestfish-actions.pod:344
22389 #: ../fish/guestfish-actions.pod:346
22392 " aug-set augpath val\n"
22397 #: ../fish/guestfish-actions.pod:350
22399 "In the Augeas API, it is possible to clear a node by setting the value to "
22400 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
22401 "this call. Instead you must use the L</aug-clear> call."
22405 #: ../fish/guestfish-actions.pod:355
22410 #: ../fish/guestfish-actions.pod:357
22413 " available 'groups ...'\n"
22418 #: ../fish/guestfish-actions.pod:363
22420 "The libguestfs groups, and the functions that those groups correspond to, "
22421 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
22422 "runtime by calling L</available-all-groups>."
22426 #: ../fish/guestfish-actions.pod:387
22427 msgid "You must call L</launch> before calling this function."
22431 #: ../fish/guestfish-actions.pod:409
22433 "This call was added in version C<1.0.80>. In previous versions of "
22434 "libguestfs all you could do would be to speculatively execute a command to "
22435 "find out if the daemon implemented it. See also L</version>."
22439 #: ../fish/guestfish-actions.pod:416
22440 msgid "available-all-groups"
22444 #: ../fish/guestfish-actions.pod:418
22447 " available-all-groups\n"
22452 #: ../fish/guestfish-actions.pod:420
22454 "This command returns a list of all optional groups that this daemon knows "
22455 "about. Note this returns both supported and unsupported groups. To find "
22456 "out which ones the daemon can actually support you have to call L</"
22457 "available> on each member of the returned list."
22461 #: ../fish/guestfish-actions.pod:426
22462 msgid "See also L</available> and L<guestfs(3)/AVAILABILITY>."
22466 #: ../fish/guestfish-actions.pod:428
22471 #: ../fish/guestfish-actions.pod:430
22474 " base64-in (base64file|-) filename\n"
22479 #: ../fish/guestfish-actions.pod:435 ../fish/guestfish-actions.pod:444
22480 #: ../fish/guestfish-actions.pod:668 ../fish/guestfish-actions.pod:837
22481 #: ../fish/guestfish-actions.pod:856 ../fish/guestfish-actions.pod:1230
22482 #: ../fish/guestfish-actions.pod:4513 ../fish/guestfish-actions.pod:4525
22483 #: ../fish/guestfish-actions.pod:4536 ../fish/guestfish-actions.pod:4547
22484 #: ../fish/guestfish-actions.pod:4599 ../fish/guestfish-actions.pod:4608
22485 #: ../fish/guestfish-actions.pod:4662 ../fish/guestfish-actions.pod:4685
22486 msgid "Use C<-> instead of a filename to read/write from stdin/stdout."
22490 #: ../fish/guestfish-actions.pod:437
22495 #: ../fish/guestfish-actions.pod:439
22498 " base64-out filename (base64file|-)\n"
22503 #: ../fish/guestfish-actions.pod:446
22504 msgid "blockdev-flushbufs"
22508 #: ../fish/guestfish-actions.pod:448
22511 " blockdev-flushbufs device\n"
22516 #: ../fish/guestfish-actions.pod:455
22517 msgid "blockdev-getbsz"
22521 #: ../fish/guestfish-actions.pod:457
22524 " blockdev-getbsz device\n"
22529 #: ../fish/guestfish-actions.pod:466
22530 msgid "blockdev-getro"
22534 #: ../fish/guestfish-actions.pod:468
22537 " blockdev-getro device\n"
22542 #: ../fish/guestfish-actions.pod:475
22543 msgid "blockdev-getsize64"
22547 #: ../fish/guestfish-actions.pod:477
22550 " blockdev-getsize64 device\n"
22555 #: ../fish/guestfish-actions.pod:481
22556 msgid "See also L</blockdev-getsz>."
22560 #: ../fish/guestfish-actions.pod:485
22561 msgid "blockdev-getss"
22565 #: ../fish/guestfish-actions.pod:487
22568 " blockdev-getss device\n"
22573 #: ../fish/guestfish-actions.pod:492
22575 "(Note, this is not the size in sectors, use L</blockdev-getsz> for that)."
22579 #: ../fish/guestfish-actions.pod:497
22580 msgid "blockdev-getsz"
22584 #: ../fish/guestfish-actions.pod:499
22587 " blockdev-getsz device\n"
22592 #: ../fish/guestfish-actions.pod:504
22594 "See also L</blockdev-getss> for the real sector size of the device, and L</"
22595 "blockdev-getsize64> for the more useful I<size in bytes>."
22599 #: ../fish/guestfish-actions.pod:510
22600 msgid "blockdev-rereadpt"
22604 #: ../fish/guestfish-actions.pod:512
22607 " blockdev-rereadpt device\n"
22612 #: ../fish/guestfish-actions.pod:518
22613 msgid "blockdev-setbsz"
22617 #: ../fish/guestfish-actions.pod:520
22620 " blockdev-setbsz device blocksize\n"
22625 #: ../fish/guestfish-actions.pod:529
22626 msgid "blockdev-setro"
22630 #: ../fish/guestfish-actions.pod:531
22633 " blockdev-setro device\n"
22638 #: ../fish/guestfish-actions.pod:537
22639 msgid "blockdev-setrw"
22643 #: ../fish/guestfish-actions.pod:539
22646 " blockdev-setrw device\n"
22651 #: ../fish/guestfish-actions.pod:545
22652 msgid "case-sensitive-path"
22656 #: ../fish/guestfish-actions.pod:547
22659 " case-sensitive-path path\n"
22664 #: ../fish/guestfish-actions.pod:571
22666 "Thus L</case-sensitive-path> (\"/Windows/System32\") might return C<\"/"
22667 "WINDOWS/system32\"> (the exact return value would depend on details of how "
22668 "the directories were originally created under Windows)."
22672 #: ../fish/guestfish-actions.pod:579
22673 msgid "See also L</realpath>."
22677 #: ../fish/guestfish-actions.pod:581
22682 #: ../fish/guestfish-actions.pod:583
22690 #: ../fish/guestfish-actions.pod:587
22692 "Note that this function cannot correctly handle binary files (specifically, "
22693 "files containing C<\\0> character which is treated as end of string). For "
22694 "those you need to use the L</read-file> or L</download> functions which have "
22695 "a more complex interface."
22699 #: ../fish/guestfish-actions.pod:595
22704 #: ../fish/guestfish-actions.pod:597
22707 " checksum csumtype path\n"
22712 #: ../fish/guestfish-actions.pod:640
22713 msgid "To get the checksum for a device, use L</checksum-device>."
22717 #: ../fish/guestfish-actions.pod:642
22718 msgid "To get the checksums for many files, use L</checksums-out>."
22722 #: ../fish/guestfish-actions.pod:644
22723 msgid "checksum-device"
22727 #: ../fish/guestfish-actions.pod:646
22730 " checksum-device csumtype device\n"
22735 #: ../fish/guestfish-actions.pod:648
22737 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
22738 "device named C<device>. For the types of checksums supported see the L</"
22739 "checksum> command."
22743 #: ../fish/guestfish-actions.pod:652
22744 msgid "checksums-out"
22748 #: ../fish/guestfish-actions.pod:654
22751 " checksums-out csumtype directory (sumsfile|-)\n"
22756 #: ../fish/guestfish-actions.pod:670
22761 #: ../fish/guestfish-actions.pod:672
22764 " chmod mode path\n"
22769 #: ../fish/guestfish-actions.pod:683
22774 #: ../fish/guestfish-actions.pod:685
22777 " chown owner group path\n"
22782 #: ../fish/guestfish-actions.pod:693
22787 #: ../fish/guestfish-actions.pod:695
22790 " command 'arguments ...'\n"
22795 #: ../fish/guestfish-actions.pod:702
22797 "The single parameter is an argv-style list of arguments. The first element "
22798 "is the name of the program to run. Subsequent elements are parameters. The "
22799 "list must be non-empty (ie. must contain a program name). Note that the "
22800 "command runs directly, and is I<not> invoked via the shell (see L</sh>)."
22804 #: ../fish/guestfish-actions.pod:730
22805 msgid "command-lines"
22809 #: ../fish/guestfish-actions.pod:732
22812 " command-lines 'arguments ...'\n"
22817 #: ../fish/guestfish-actions.pod:734
22819 "This is the same as L</command>, but splits the result into a list of lines."
22823 #: ../fish/guestfish-actions.pod:737
22824 msgid "See also: L</sh-lines>"
22828 #: ../fish/guestfish-actions.pod:742
22833 #: ../fish/guestfish-actions.pod:744
22836 " config qemuparam qemuvalue\n"
22841 #: ../fish/guestfish-actions.pod:755
22846 #: ../fish/guestfish-actions.pod:757
22849 " copy-size src dest size\n"
22854 #: ../fish/guestfish-actions.pod:765
22859 #: ../fish/guestfish-actions.pod:767
22867 #: ../fish/guestfish-actions.pod:772
22872 #: ../fish/guestfish-actions.pod:774
22880 #: ../fish/guestfish-actions.pod:779
22885 #: ../fish/guestfish-actions.pod:781
22893 #: ../fish/guestfish-actions.pod:788
22895 "If the destination is a device, it must be as large or larger than the "
22896 "source file or device, otherwise the copy will fail. This command cannot do "
22897 "partial copies (see L</copy-size>)."
22901 #: ../fish/guestfish-actions.pod:792
22906 #: ../fish/guestfish-actions.pod:794
22914 #: ../fish/guestfish-actions.pod:798 ../fish/guestfish-actions.pod:809
22916 "This command is mostly useful for interactive sessions. It is I<not> "
22917 "intended that you try to parse the output string. Use L</statvfs> from "
22922 #: ../fish/guestfish-actions.pod:802
22927 #: ../fish/guestfish-actions.pod:804
22935 #: ../fish/guestfish-actions.pod:813
22940 #: ../fish/guestfish-actions.pod:815
22948 #: ../fish/guestfish-actions.pod:821
22950 "Another way to get the same information is to enable verbose messages with "
22951 "L</set-verbose> or by setting the environment variable C<LIBGUESTFS_DEBUG=1> "
22952 "before running the program."
22956 #: ../fish/guestfish-actions.pod:826
22961 #: ../fish/guestfish-actions.pod:828
22964 " download remotefilename (filename|-)\n"
22969 #: ../fish/guestfish-actions.pod:835
22970 msgid "See also L</upload>, L</cat>."
22974 #: ../fish/guestfish-actions.pod:839
22975 msgid "download-offset"
22979 #: ../fish/guestfish-actions.pod:841
22982 " download-offset remotefilename (filename|-) offset size\n"
22987 #: ../fish/guestfish-actions.pod:849
22989 "Note that there is no limit on the amount of data that can be downloaded "
22990 "with this call, unlike with L</pread>, and this call always reads the full "
22991 "amount unless an error occurs."
22995 #: ../fish/guestfish-actions.pod:854
22996 msgid "See also L</download>, L</pread>."
23000 #: ../fish/guestfish-actions.pod:858
23001 msgid "drop-caches"
23005 #: ../fish/guestfish-actions.pod:860
23008 " drop-caches whattodrop\n"
23013 #: ../fish/guestfish-actions.pod:872
23018 #: ../fish/guestfish-actions.pod:874
23026 #: ../fish/guestfish-actions.pod:886
23031 #: ../fish/guestfish-actions.pod:888
23034 " e2fsck-f device\n"
23039 #: ../fish/guestfish-actions.pod:894
23041 "This command is only needed because of L</resize2fs> (q.v.). Normally you "
23042 "should use L</fsck>."
23046 #: ../fish/guestfish-actions.pod:897
23047 msgid "echo-daemon"
23051 #: ../fish/guestfish-actions.pod:899
23054 " echo-daemon 'words ...'\n"
23059 #: ../fish/guestfish-actions.pod:906
23060 msgid "See also L</ping-daemon>."
23064 #: ../fish/guestfish-actions.pod:908
23069 #: ../fish/guestfish-actions.pod:910
23072 " egrep regex path\n"
23077 #: ../fish/guestfish-actions.pod:918
23082 #: ../fish/guestfish-actions.pod:920
23085 " egrepi regex path\n"
23090 #: ../fish/guestfish-actions.pod:928
23095 #: ../fish/guestfish-actions.pod:930
23098 " equal file1 file2\n"
23103 #: ../fish/guestfish-actions.pod:937
23108 #: ../fish/guestfish-actions.pod:939
23116 #: ../fish/guestfish-actions.pod:944
23117 msgid "See also L</is-file>, L</is-dir>, L</stat>."
23121 #: ../fish/guestfish-actions.pod:946
23126 #: ../fish/guestfish-actions.pod:948
23129 " fallocate path len\n"
23134 #: ../fish/guestfish-actions.pod:958
23136 "This function is deprecated. In new code, use the L</fallocate64> call "
23141 #: ../fish/guestfish-actions.pod:965
23142 msgid "fallocate64"
23146 #: ../fish/guestfish-actions.pod:967
23149 " fallocate64 path len\n"
23154 #: ../fish/guestfish-actions.pod:973
23156 "Note that this call allocates disk blocks for the file. To create a sparse "
23157 "file use L</truncate-size> instead."
23161 #: ../fish/guestfish-actions.pod:976
23163 "The deprecated call L</fallocate> does the same, but owing to an oversight "
23164 "it only allowed 30 bit lengths to be specified, effectively limiting the "
23165 "maximum size of files created through that call to 1GB."
23169 #: ../fish/guestfish-actions.pod:985
23174 #: ../fish/guestfish-actions.pod:987
23177 " fgrep pattern path\n"
23182 #: ../fish/guestfish-actions.pod:995
23187 #: ../fish/guestfish-actions.pod:997
23190 " fgrepi pattern path\n"
23195 #: ../fish/guestfish-actions.pod:1005
23200 #: ../fish/guestfish-actions.pod:1007
23208 #: ../fish/guestfish-actions.pod:1023
23210 "See also: L<file(1)>, L</vfs-type>, L</lstat>, L</is-file>, L</is-blockdev> "
23215 #: ../fish/guestfish-actions.pod:1026
23216 msgid "file-architecture"
23220 #: ../fish/guestfish-actions.pod:1028
23223 " file-architecture filename\n"
23228 #: ../fish/guestfish-actions.pod:1131
23233 #: ../fish/guestfish-actions.pod:1133
23241 #: ../fish/guestfish-actions.pod:1137
23243 "To get other stats about a file, use L</stat>, L</lstat>, L</is-dir>, L</is-"
23244 "file> etc. To get the size of block devices, use L</blockdev-getsize64>."
23248 #: ../fish/guestfish-actions.pod:1141
23253 #: ../fish/guestfish-actions.pod:1143
23256 " fill c len path\n"
23261 #: ../fish/guestfish-actions.pod:1149
23263 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
23264 "L</truncate-size>. To create a file with a pattern of repeating bytes use "
23265 "L</fill-pattern>."
23269 #: ../fish/guestfish-actions.pod:1154
23270 msgid "fill-pattern"
23274 #: ../fish/guestfish-actions.pod:1156
23277 " fill-pattern pattern len path\n"
23282 #: ../fish/guestfish-actions.pod:1158
23284 "This function is like L</fill> except that it creates a new file of length "
23285 "C<len> containing the repeating pattern of bytes in C<pattern>. The pattern "
23286 "is truncated if necessary to ensure the length of the file is exactly C<len> "
23291 #: ../fish/guestfish-actions.pod:1163
23296 #: ../fish/guestfish-actions.pod:1165
23299 " find directory\n"
23304 #: ../fish/guestfish-actions.pod:1179
23305 msgid "then the returned list from L</find> C</tmp> would be 4 elements:"
23309 #: ../fish/guestfish-actions.pod:1192
23310 msgid "See also L</find0>."
23314 #: ../fish/guestfish-actions.pod:1197
23319 #: ../fish/guestfish-actions.pod:1199
23322 " find0 directory (files|-)\n"
23327 #: ../fish/guestfish-actions.pod:1205
23329 "This command works the same way as L</find> with the following exceptions:"
23333 #: ../fish/guestfish-actions.pod:1232
23334 msgid "findfs-label"
23338 #: ../fish/guestfish-actions.pod:1234
23341 " findfs-label label\n"
23346 #: ../fish/guestfish-actions.pod:1240
23347 msgid "To find the label of a filesystem, use L</vfs-label>."
23351 #: ../fish/guestfish-actions.pod:1242
23352 msgid "findfs-uuid"
23356 #: ../fish/guestfish-actions.pod:1244
23359 " findfs-uuid uuid\n"
23364 #: ../fish/guestfish-actions.pod:1250
23365 msgid "To find the UUID of a filesystem, use L</vfs-uuid>."
23369 #: ../fish/guestfish-actions.pod:1252
23374 #: ../fish/guestfish-actions.pod:1254
23377 " fsck fstype device\n"
23382 #: ../fish/guestfish-actions.pod:1284
23387 #: ../fish/guestfish-actions.pod:1286
23395 #: ../fish/guestfish-actions.pod:1293
23396 msgid "get-attach-method"
23400 #: ../fish/guestfish-actions.pod:1295
23403 " get-attach-method\n"
23408 #: ../fish/guestfish-actions.pod:1297
23409 msgid "Return the current attach method. See L</set-attach-method>."
23413 #: ../fish/guestfish-actions.pod:1299
23414 msgid "get-autosync"
23418 #: ../fish/guestfish-actions.pod:1301
23426 #: ../fish/guestfish-actions.pod:1305
23431 #: ../fish/guestfish-actions.pod:1307
23439 #: ../fish/guestfish-actions.pod:1311
23440 msgid "get-e2label"
23444 #: ../fish/guestfish-actions.pod:1313
23447 " get-e2label device\n"
23452 #: ../fish/guestfish-actions.pod:1318
23454 "This function is deprecated. In new code, use the L</vfs_label> call "
23459 #: ../fish/guestfish-actions.pod:1325
23464 #: ../fish/guestfish-actions.pod:1327
23467 " get-e2uuid device\n"
23472 #: ../fish/guestfish-actions.pod:1332
23474 "This function is deprecated. In new code, use the L</vfs_uuid> call instead."
23478 #: ../fish/guestfish-actions.pod:1339
23479 msgid "get-memsize"
23483 #: ../fish/guestfish-actions.pod:1341
23491 #: ../fish/guestfish-actions.pod:1346
23493 "If L</set-memsize> was not called on this handle, and if "
23494 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
23495 "value for memsize."
23499 #: ../fish/guestfish-actions.pod:1353
23500 msgid "get-network"
23504 #: ../fish/guestfish-actions.pod:1355
23512 #: ../fish/guestfish-actions.pod:1359
23517 #: ../fish/guestfish-actions.pod:1361
23525 #: ../fish/guestfish-actions.pod:1368
23530 #: ../fish/guestfish-actions.pod:1370
23535 #: ../fish/guestfish-actions.pod:1372
23543 #: ../fish/guestfish-actions.pod:1379
23548 #: ../fish/guestfish-actions.pod:1381
23556 #: ../fish/guestfish-actions.pod:1388
23557 msgid "get-recovery-proc"
23561 #: ../fish/guestfish-actions.pod:1390
23564 " get-recovery-proc\n"
23569 #: ../fish/guestfish-actions.pod:1394
23570 msgid "get-selinux"
23574 #: ../fish/guestfish-actions.pod:1396
23582 #: ../fish/guestfish-actions.pod:1398
23584 "This returns the current setting of the selinux flag which is passed to the "
23585 "appliance at boot time. See L</set-selinux>."
23589 #: ../fish/guestfish-actions.pod:1404
23594 #: ../fish/guestfish-actions.pod:1406
23602 #: ../fish/guestfish-actions.pod:1413
23607 #: ../fish/guestfish-actions.pod:1415
23615 #: ../fish/guestfish-actions.pod:1419
23620 #: ../fish/guestfish-actions.pod:1421
23628 #: ../fish/guestfish-actions.pod:1423
23630 "Return the current umask. By default the umask is C<022> unless it has been "
23631 "set by calling L</umask>."
23635 #: ../fish/guestfish-actions.pod:1426
23636 msgid "get-verbose"
23640 #: ../fish/guestfish-actions.pod:1428
23648 #: ../fish/guestfish-actions.pod:1432
23653 #: ../fish/guestfish-actions.pod:1434
23661 #: ../fish/guestfish-actions.pod:1438
23662 msgid "See the documentation about SELINUX in L<guestfs(3)>, and L</setcon>"
23666 #: ../fish/guestfish-actions.pod:1441
23671 #: ../fish/guestfish-actions.pod:1443
23674 " getxattr path name\n"
23679 #: ../fish/guestfish-actions.pod:1445
23681 "Get a single extended attribute from file C<path> named C<name>. This call "
23682 "follows symlinks. If you want to lookup an extended attribute for the "
23683 "symlink itself, use L</lgetxattr>."
23687 #: ../fish/guestfish-actions.pod:1449 ../fish/guestfish-actions.pod:2477
23689 "Normally it is better to get all extended attributes from a file in one go "
23690 "by calling L</getxattrs>. However some Linux filesystem implementations are "
23691 "buggy and do not provide a way to list out attributes. For these "
23692 "filesystems (notably ntfs-3g) you have to know the names of the extended "
23693 "attributes you want in advance and call this function."
23697 #: ../fish/guestfish-actions.pod:1459
23698 msgid "See also: L</getxattrs>, L</lgetxattr>, L<attr(5)>."
23702 #: ../fish/guestfish-actions.pod:1461
23707 #: ../fish/guestfish-actions.pod:1463
23710 " getxattrs path\n"
23715 #: ../fish/guestfish-actions.pod:1471
23716 msgid "See also: L</lgetxattrs>, L<attr(5)>."
23720 #: ../fish/guestfish-actions.pod:1473
23721 msgid "glob-expand"
23725 #: ../fish/guestfish-actions.pod:1475
23728 " glob-expand pattern\n"
23733 #: ../fish/guestfish-actions.pod:1488
23738 #: ../fish/guestfish-actions.pod:1490
23741 " grep regex path\n"
23746 #: ../fish/guestfish-actions.pod:1498
23751 #: ../fish/guestfish-actions.pod:1500
23754 " grepi regex path\n"
23759 #: ../fish/guestfish-actions.pod:1508
23760 msgid "grub-install"
23764 #: ../fish/guestfish-actions.pod:1510
23767 " grub-install root device\n"
23772 #: ../fish/guestfish-actions.pod:1548
23777 #: ../fish/guestfish-actions.pod:1550
23785 #: ../fish/guestfish-actions.pod:1558
23790 #: ../fish/guestfish-actions.pod:1560
23793 " head-n nrlines path\n"
23798 #: ../fish/guestfish-actions.pod:1573
23803 #: ../fish/guestfish-actions.pod:1575
23811 #: ../fish/guestfish-actions.pod:1583
23816 #: ../fish/guestfish-actions.pod:1585
23819 " initrd-cat initrdpath filename\n"
23824 #: ../fish/guestfish-actions.pod:1597
23825 msgid "See also L</initrd-list>."
23829 #: ../fish/guestfish-actions.pod:1602
23830 msgid "initrd-list"
23834 #: ../fish/guestfish-actions.pod:1604
23837 " initrd-list path\n"
23842 #: ../fish/guestfish-actions.pod:1616
23843 msgid "inotify-add-watch"
23847 #: ../fish/guestfish-actions.pod:1618
23850 " inotify-add-watch path mask\n"
23855 #: ../fish/guestfish-actions.pod:1630
23856 msgid "inotify-close"
23860 #: ../fish/guestfish-actions.pod:1632
23868 #: ../fish/guestfish-actions.pod:1638
23869 msgid "inotify-files"
23873 #: ../fish/guestfish-actions.pod:1640
23881 #: ../fish/guestfish-actions.pod:1642
23883 "This function is a helpful wrapper around L</inotify-read> which just "
23884 "returns a list of pathnames of objects that were touched. The returned "
23885 "pathnames are sorted and deduplicated."
23889 #: ../fish/guestfish-actions.pod:1646
23890 msgid "inotify-init"
23894 #: ../fish/guestfish-actions.pod:1648
23897 " inotify-init maxevents\n"
23902 #: ../fish/guestfish-actions.pod:1654
23904 "C<maxevents> is the maximum number of events which will be queued up between "
23905 "calls to L</inotify-read> or L</inotify-files>. If this is passed as C<0>, "
23906 "then the kernel (or previously set) default is used. For Linux 2.6.29 the "
23907 "default was 16384 events. Beyond this limit, the kernel throws away events, "
23908 "but records the fact that it threw them away by setting a flag "
23909 "C<IN_Q_OVERFLOW> in the returned structure list (see L</inotify-read>)."
23913 #: ../fish/guestfish-actions.pod:1664
23915 "Before any events are generated, you have to add some watches to the "
23916 "internal watch list. See: L</inotify-add-watch>, L</inotify-rm-watch> and "
23917 "L</inotify-watch-all>."
23921 #: ../fish/guestfish-actions.pod:1670
23923 "Queued up events should be read periodically by calling L</inotify-read> (or "
23924 "L</inotify-files> which is just a helpful wrapper around L</inotify-read>). "
23925 "If you don't read the events out often enough then you risk the internal "
23926 "queue overflowing."
23930 #: ../fish/guestfish-actions.pod:1677
23932 "The handle should be closed after use by calling L</inotify-close>. This "
23933 "also removes any watches automatically."
23937 #: ../fish/guestfish-actions.pod:1686
23938 msgid "inotify-read"
23942 #: ../fish/guestfish-actions.pod:1688
23950 #: ../fish/guestfish-actions.pod:1701
23951 msgid "inotify-rm-watch"
23955 #: ../fish/guestfish-actions.pod:1703
23958 " inotify-rm-watch wd\n"
23963 #: ../fish/guestfish-actions.pod:1705
23964 msgid "Remove a previously defined inotify watch. See L</inotify-add-watch>."
23968 #: ../fish/guestfish-actions.pod:1708
23969 msgid "inspect-get-arch"
23973 #: ../fish/guestfish-actions.pod:1710
23976 " inspect-get-arch root\n"
23981 #: ../fish/guestfish-actions.pod:1712 ../fish/guestfish-actions.pod:1728
23982 #: ../fish/guestfish-actions.pod:1814 ../fish/guestfish-actions.pod:1850
23983 #: ../fish/guestfish-actions.pod:1868 ../fish/guestfish-actions.pod:1902
23984 #: ../fish/guestfish-actions.pod:1917 ../fish/guestfish-actions.pod:1938
23985 #: ../fish/guestfish-actions.pod:1953 ../fish/guestfish-actions.pod:1986
23986 #: ../fish/guestfish-actions.pod:2008 ../fish/guestfish-actions.pod:2032
23987 #: ../fish/guestfish-actions.pod:2049 ../fish/guestfish-actions.pod:2092
23988 #: ../fish/guestfish-actions.pod:2127 ../fish/guestfish-actions.pod:2143
23989 #: ../fish/guestfish-actions.pod:2159 ../fish/guestfish-actions.pod:2172
23990 #: ../fish/guestfish-actions.pod:2185 ../fish/guestfish-actions.pod:2200
23992 "This function should only be called with a root device string as returned by "
23997 #: ../fish/guestfish-actions.pod:1715
23999 "This returns the architecture of the inspected operating system. The "
24000 "possible return values are listed under L</file-architecture>."
24004 #: ../fish/guestfish-actions.pod:1724
24005 msgid "inspect-get-distro"
24009 #: ../fish/guestfish-actions.pod:1726
24012 " inspect-get-distro root\n"
24017 #: ../fish/guestfish-actions.pod:1810
24018 msgid "inspect-get-drive-mappings"
24022 #: ../fish/guestfish-actions.pod:1812
24025 " inspect-get-drive-mappings root\n"
24030 #: ../fish/guestfish-actions.pod:1842
24032 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
24033 "get-mountpoints>, L</inspect-get-filesystems>."
24037 #: ../fish/guestfish-actions.pod:1846
24038 msgid "inspect-get-filesystems"
24042 #: ../fish/guestfish-actions.pod:1848
24045 " inspect-get-filesystems root\n"
24050 #: ../fish/guestfish-actions.pod:1861
24052 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
24053 "get-mountpoints>."
24057 #: ../fish/guestfish-actions.pod:1864
24058 msgid "inspect-get-format"
24062 #: ../fish/guestfish-actions.pod:1866
24065 " inspect-get-format root\n"
24070 #: ../fish/guestfish-actions.pod:1898
24071 msgid "inspect-get-hostname"
24075 #: ../fish/guestfish-actions.pod:1900
24078 " inspect-get-hostname root\n"
24083 #: ../fish/guestfish-actions.pod:1913
24084 msgid "inspect-get-major-version"
24088 #: ../fish/guestfish-actions.pod:1915
24091 " inspect-get-major-version root\n"
24096 #: ../fish/guestfish-actions.pod:1934
24097 msgid "inspect-get-minor-version"
24101 #: ../fish/guestfish-actions.pod:1936
24104 " inspect-get-minor-version root\n"
24109 #: ../fish/guestfish-actions.pod:1946
24111 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
24112 "get-major-version>."
24116 #: ../fish/guestfish-actions.pod:1949
24117 msgid "inspect-get-mountpoints"
24121 #: ../fish/guestfish-actions.pod:1951
24124 " inspect-get-mountpoints root\n"
24129 #: ../fish/guestfish-actions.pod:1973
24131 "For operating systems like Windows which still use drive letters, this call "
24132 "will only return an entry for the first drive \"mounted on\" C</>. For "
24133 "information about the mapping of drive letters to partitions, see L</inspect-"
24134 "get-drive-mappings>."
24138 #: ../fish/guestfish-actions.pod:1979
24140 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
24141 "get-filesystems>."
24145 #: ../fish/guestfish-actions.pod:1982
24146 msgid "inspect-get-package-format"
24150 #: ../fish/guestfish-actions.pod:1984
24153 " inspect-get-package-format root\n"
24158 #: ../fish/guestfish-actions.pod:1989
24160 "This function and L</inspect-get-package-management> return the package "
24161 "format and package management tool used by the inspected operating system. "
24162 "For example for Fedora these functions would return C<rpm> (package format) "
24163 "and C<yum> (package management)."
24167 #: ../fish/guestfish-actions.pod:2004
24168 msgid "inspect-get-package-management"
24172 #: ../fish/guestfish-actions.pod:2006
24175 " inspect-get-package-management root\n"
24180 #: ../fish/guestfish-actions.pod:2011
24182 "L</inspect-get-package-format> and this function return the package format "
24183 "and package management tool used by the inspected operating system. For "
24184 "example for Fedora these functions would return C<rpm> (package format) and "
24185 "C<yum> (package management)."
24189 #: ../fish/guestfish-actions.pod:2028
24190 msgid "inspect-get-product-name"
24194 #: ../fish/guestfish-actions.pod:2030
24197 " inspect-get-product-name root\n"
24202 #: ../fish/guestfish-actions.pod:2045
24203 msgid "inspect-get-product-variant"
24207 #: ../fish/guestfish-actions.pod:2047
24210 " inspect-get-product-variant root\n"
24215 #: ../fish/guestfish-actions.pod:2071
24217 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
24218 "get-product-name>, L</inspect-get-major-version>."
24222 #: ../fish/guestfish-actions.pod:2075
24223 msgid "inspect-get-roots"
24227 #: ../fish/guestfish-actions.pod:2077
24230 " inspect-get-roots\n"
24235 #: ../fish/guestfish-actions.pod:2079
24237 "This function is a convenient way to get the list of root devices, as "
24238 "returned from a previous call to L</inspect-os>, but without redoing the "
24239 "whole inspection process."
24243 #: ../fish/guestfish-actions.pod:2083
24245 "This returns an empty list if either no root devices were found or the "
24246 "caller has not called L</inspect-os>."
24250 #: ../fish/guestfish-actions.pod:2088
24251 msgid "inspect-get-type"
24255 #: ../fish/guestfish-actions.pod:2090
24258 " inspect-get-type root\n"
24263 #: ../fish/guestfish-actions.pod:2123
24264 msgid "inspect-get-windows-current-control-set"
24268 #: ../fish/guestfish-actions.pod:2125
24271 " inspect-get-windows-current-control-set root\n"
24276 #: ../fish/guestfish-actions.pod:2139
24277 msgid "inspect-get-windows-systemroot"
24281 #: ../fish/guestfish-actions.pod:2141
24284 " inspect-get-windows-systemroot root\n"
24289 #: ../fish/guestfish-actions.pod:2155
24290 msgid "inspect-is-live"
24294 #: ../fish/guestfish-actions.pod:2157
24297 " inspect-is-live root\n"
24302 #: ../fish/guestfish-actions.pod:2162
24304 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
24305 "then this returns true if a live image was detected on the disk."
24309 #: ../fish/guestfish-actions.pod:2168
24310 msgid "inspect-is-multipart"
24314 #: ../fish/guestfish-actions.pod:2170
24317 " inspect-is-multipart root\n"
24322 #: ../fish/guestfish-actions.pod:2175
24324 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
24325 "then this returns true if the disk is part of a set."
24329 #: ../fish/guestfish-actions.pod:2181
24330 msgid "inspect-is-netinst"
24334 #: ../fish/guestfish-actions.pod:2183
24337 " inspect-is-netinst root\n"
24342 #: ../fish/guestfish-actions.pod:2188
24344 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
24345 "then this returns true if the disk is a network installer, ie. not a self-"
24346 "contained install CD but one which is likely to require network access to "
24347 "complete the install."
24351 #: ../fish/guestfish-actions.pod:2196
24352 msgid "inspect-list-applications"
24356 #: ../fish/guestfish-actions.pod:2198
24359 " inspect-list-applications root\n"
24364 #: ../fish/guestfish-actions.pod:2205
24366 "I<Note:> This call works differently from other parts of the inspection "
24367 "API. You have to call L</inspect-os>, then L</inspect-get-mountpoints>, "
24368 "then mount up the disks, before calling this. Listing applications is a "
24369 "significantly more difficult operation which requires access to the full "
24370 "filesystem. Also note that unlike the other L</inspect-get-*> calls which "
24371 "are just returning data cached in the libguestfs handle, this call actually "
24372 "reads parts of the mounted filesystems during the call."
24376 #: ../fish/guestfish-actions.pod:2295
24381 #: ../fish/guestfish-actions.pod:2297
24389 #: ../fish/guestfish-actions.pod:2312
24391 "You can pass the root string(s) returned to other L</inspect-get-*> "
24392 "functions in order to query further information about each operating system, "
24393 "such as the name and version."
24397 #: ../fish/guestfish-actions.pod:2317
24399 "This function uses other libguestfs features such as L</mount-ro> and L</"
24400 "umount-all> in order to mount and unmount filesystems and look at the "
24401 "contents. This should be called with no disks currently mounted. The "
24402 "function may also use Augeas, so any existing Augeas handle will be closed."
24406 #: ../fish/guestfish-actions.pod:2329 ../fish/guestfish-actions.pod:2505
24407 #: ../fish/guestfish-actions.pod:2551
24408 msgid "See also L</list-filesystems>."
24412 #: ../fish/guestfish-actions.pod:2331
24413 msgid "is-blockdev"
24417 #: ../fish/guestfish-actions.pod:2333
24420 " is-blockdev path\n"
24425 #: ../fish/guestfish-actions.pod:2338 ../fish/guestfish-actions.pod:2356
24426 #: ../fish/guestfish-actions.pod:2375 ../fish/guestfish-actions.pod:2384
24427 #: ../fish/guestfish-actions.pod:2394 ../fish/guestfish-actions.pod:2428
24428 #: ../fish/guestfish-actions.pod:2437
24429 msgid "See also L</stat>."
24433 #: ../fish/guestfish-actions.pod:2340
24438 #: ../fish/guestfish-actions.pod:2342
24446 #: ../fish/guestfish-actions.pod:2349
24451 #: ../fish/guestfish-actions.pod:2351
24454 " is-chardev path\n"
24459 #: ../fish/guestfish-actions.pod:2358
24464 #: ../fish/guestfish-actions.pod:2360
24472 #: ../fish/guestfish-actions.pod:2367
24477 #: ../fish/guestfish-actions.pod:2369
24485 #: ../fish/guestfish-actions.pod:2377
24490 #: ../fish/guestfish-actions.pod:2379
24498 #: ../fish/guestfish-actions.pod:2386
24503 #: ../fish/guestfish-actions.pod:2388
24511 #: ../fish/guestfish-actions.pod:2396
24512 msgid "is-launching"
24516 #: ../fish/guestfish-actions.pod:2398
24524 #: ../fish/guestfish-actions.pod:2405
24529 #: ../fish/guestfish-actions.pod:2407
24537 #: ../fish/guestfish-actions.pod:2412
24542 #: ../fish/guestfish-actions.pod:2414
24550 #: ../fish/guestfish-actions.pod:2421
24555 #: ../fish/guestfish-actions.pod:2423
24558 " is-socket path\n"
24563 #: ../fish/guestfish-actions.pod:2430
24568 #: ../fish/guestfish-actions.pod:2432
24571 " is-symlink path\n"
24576 #: ../fish/guestfish-actions.pod:2439
24577 msgid "kill-subprocess"
24581 #: ../fish/guestfish-actions.pod:2441
24584 " kill-subprocess\n"
24589 #: ../fish/guestfish-actions.pod:2445
24594 #: ../fish/guestfish-actions.pod:2447
24599 #: ../fish/guestfish-actions.pod:2449
24607 #: ../fish/guestfish-actions.pod:2457
24612 #: ../fish/guestfish-actions.pod:2459
24615 " lchown owner group path\n"
24620 #: ../fish/guestfish-actions.pod:2461
24622 "Change the file owner to C<owner> and group to C<group>. This is like L</"
24623 "chown> but if C<path> is a symlink then the link itself is changed, not the "
24628 #: ../fish/guestfish-actions.pod:2469
24633 #: ../fish/guestfish-actions.pod:2471
24636 " lgetxattr path name\n"
24641 #: ../fish/guestfish-actions.pod:2487
24642 msgid "See also: L</lgetxattrs>, L</getxattr>, L<attr(5)>."
24646 #: ../fish/guestfish-actions.pod:2489
24651 #: ../fish/guestfish-actions.pod:2491
24654 " lgetxattrs path\n"
24659 #: ../fish/guestfish-actions.pod:2493
24661 "This is the same as L</getxattrs>, but if C<path> is a symbolic link, then "
24662 "it returns the extended attributes of the link itself."
24666 #: ../fish/guestfish-actions.pod:2497
24667 msgid "list-devices"
24671 #: ../fish/guestfish-actions.pod:2499
24679 #: ../fish/guestfish-actions.pod:2507
24680 msgid "list-filesystems"
24684 #: ../fish/guestfish-actions.pod:2509
24687 " list-filesystems\n"
24692 #: ../fish/guestfish-actions.pod:2528
24694 "This command runs other libguestfs commands, which might include L</mount> "
24695 "and L</umount>, and therefore you should use this soon after launch and only "
24696 "when nothing is mounted."
24700 #: ../fish/guestfish-actions.pod:2532
24702 "Not all of the filesystems returned will be mountable. In particular, swap "
24703 "partitions are returned in the list. Also this command does not check that "
24704 "each filesystem found is valid and mountable, and some filesystems might be "
24705 "mountable but require special options. Filesystems may not all belong to a "
24706 "single logical operating system (use L</inspect-os> to look for OSes)."
24710 #: ../fish/guestfish-actions.pod:2540
24711 msgid "list-partitions"
24715 #: ../fish/guestfish-actions.pod:2542
24718 " list-partitions\n"
24723 #: ../fish/guestfish-actions.pod:2548
24725 "This does not return logical volumes. For that you will need to call L</"
24730 #: ../fish/guestfish-actions.pod:2553
24735 #: ../fish/guestfish-actions.pod:2555
24743 #: ../fish/guestfish-actions.pod:2563
24748 #: ../fish/guestfish-actions.pod:2565
24751 " ln target linkname\n"
24756 #: ../fish/guestfish-actions.pod:2569
24761 #: ../fish/guestfish-actions.pod:2571
24764 " ln-f target linkname\n"
24769 #: ../fish/guestfish-actions.pod:2576
24774 #: ../fish/guestfish-actions.pod:2578
24777 " ln-s target linkname\n"
24782 #: ../fish/guestfish-actions.pod:2582
24787 #: ../fish/guestfish-actions.pod:2584
24790 " ln-sf target linkname\n"
24795 #: ../fish/guestfish-actions.pod:2589
24796 msgid "lremovexattr"
24800 #: ../fish/guestfish-actions.pod:2591
24803 " lremovexattr xattr path\n"
24808 #: ../fish/guestfish-actions.pod:2593
24810 "This is the same as L</removexattr>, but if C<path> is a symbolic link, then "
24811 "it removes an extended attribute of the link itself."
24815 #: ../fish/guestfish-actions.pod:2597
24820 #: ../fish/guestfish-actions.pod:2599
24828 #: ../fish/guestfish-actions.pod:2605
24830 "This command is mostly useful for interactive sessions. Programs should "
24831 "probably use L</readdir> instead."
24835 #: ../fish/guestfish-actions.pod:2608
24840 #: ../fish/guestfish-actions.pod:2610
24843 " lsetxattr xattr val vallen path\n"
24848 #: ../fish/guestfish-actions.pod:2612
24850 "This is the same as L</setxattr>, but if C<path> is a symbolic link, then it "
24851 "sets an extended attribute of the link itself."
24855 #: ../fish/guestfish-actions.pod:2616
24860 #: ../fish/guestfish-actions.pod:2618
24868 #: ../fish/guestfish-actions.pod:2622
24870 "This is the same as L</stat> except that if C<path> is a symbolic link, then "
24871 "the link is stat-ed, not the file it refers to."
24875 #: ../fish/guestfish-actions.pod:2628
24880 #: ../fish/guestfish-actions.pod:2630
24883 " lstatlist path 'names ...'\n"
24888 #: ../fish/guestfish-actions.pod:2632
24890 "This call allows you to perform the L</lstat> operation on multiple files, "
24891 "where all files are in the directory C<path>. C<names> is the list of files "
24892 "from this directory."
24896 #: ../fish/guestfish-actions.pod:2641
24898 "This call is intended for programs that want to efficiently list a directory "
24899 "contents without making many round-trips. See also L</lxattrlist> for a "
24900 "similarly efficient call for getting extended attributes. Very long "
24901 "directory listings might cause the protocol message size to be exceeded, "
24902 "causing this call to fail. The caller must split up such requests into "
24903 "smaller groups of names."
24907 #: ../fish/guestfish-actions.pod:2649
24908 msgid "luks-add-key"
24912 #: ../fish/guestfish-actions.pod:2651
24915 " luks-add-key device keyslot\n"
24920 #: ../fish/guestfish-actions.pod:2658
24922 "Note that if C<keyslot> already contains a key, then this command will "
24923 "fail. You have to use L</luks-kill-slot> first to remove that key."
24927 #: ../fish/guestfish-actions.pod:2662 ../fish/guestfish-actions.pod:2684
24928 #: ../fish/guestfish-actions.pod:2697 ../fish/guestfish-actions.pod:2711
24929 #: ../fish/guestfish-actions.pod:2734 ../fish/guestfish-actions.pod:2744
24931 "This command has one or more key or passphrase parameters. Guestfish will "
24932 "prompt for these separately."
24936 #: ../fish/guestfish-actions.pod:2665
24941 #: ../fish/guestfish-actions.pod:2667
24944 " luks-close device\n"
24949 #: ../fish/guestfish-actions.pod:2669
24951 "This closes a LUKS device that was created earlier by L</luks-open> or L</"
24952 "luks-open-ro>. The C<device> parameter must be the name of the LUKS mapping "
24953 "device (ie. C</dev/mapper/mapname>) and I<not> the name of the underlying "
24958 #: ../fish/guestfish-actions.pod:2675
24959 msgid "luks-format"
24963 #: ../fish/guestfish-actions.pod:2677
24966 " luks-format device keyslot\n"
24971 #: ../fish/guestfish-actions.pod:2690
24972 msgid "luks-format-cipher"
24976 #: ../fish/guestfish-actions.pod:2692
24979 " luks-format-cipher device keyslot cipher\n"
24984 #: ../fish/guestfish-actions.pod:2694
24986 "This command is the same as L</luks-format> but it also allows you to set "
24987 "the C<cipher> used."
24991 #: ../fish/guestfish-actions.pod:2703
24992 msgid "luks-kill-slot"
24996 #: ../fish/guestfish-actions.pod:2705
24999 " luks-kill-slot device keyslot\n"
25004 #: ../fish/guestfish-actions.pod:2714
25009 #: ../fish/guestfish-actions.pod:2716
25012 " luks-open device mapname\n"
25017 #: ../fish/guestfish-actions.pod:2730
25019 "If this block device contains LVM volume groups, then calling L</vgscan> "
25020 "followed by L</vg-activate-all> will make them visible."
25024 #: ../fish/guestfish-actions.pod:2737
25025 msgid "luks-open-ro"
25029 #: ../fish/guestfish-actions.pod:2739
25032 " luks-open-ro device mapname\n"
25037 #: ../fish/guestfish-actions.pod:2741
25039 "This is the same as L</luks-open> except that a read-only mapping is created."
25043 #: ../fish/guestfish-actions.pod:2747
25048 #: ../fish/guestfish-actions.pod:2749
25051 " lvcreate logvol volgroup mbytes\n"
25056 #: ../fish/guestfish-actions.pod:2754
25057 msgid "lvm-canonical-lv-name"
25061 #: ../fish/guestfish-actions.pod:2756
25064 " lvm-canonical-lv-name lvname\n"
25069 #: ../fish/guestfish-actions.pod:2765
25070 msgid "See also L</is-lv>."
25074 #: ../fish/guestfish-actions.pod:2767
25075 msgid "lvm-clear-filter"
25079 #: ../fish/guestfish-actions.pod:2769
25082 " lvm-clear-filter\n"
25087 #: ../fish/guestfish-actions.pod:2771
25089 "This undoes the effect of L</lvm-set-filter>. LVM will be able to see every "
25094 #: ../fish/guestfish-actions.pod:2777
25095 msgid "lvm-remove-all"
25099 #: ../fish/guestfish-actions.pod:2779
25102 " lvm-remove-all\n"
25107 #: ../fish/guestfish-actions.pod:2787
25108 msgid "lvm-set-filter"
25112 #: ../fish/guestfish-actions.pod:2789
25115 " lvm-set-filter 'devices ...'\n"
25120 #: ../fish/guestfish-actions.pod:2814
25125 #: ../fish/guestfish-actions.pod:2816
25128 " lvremove device\n"
25133 #: ../fish/guestfish-actions.pod:2824
25138 #: ../fish/guestfish-actions.pod:2826
25141 " lvrename logvol newlogvol\n"
25146 #: ../fish/guestfish-actions.pod:2830
25151 #: ../fish/guestfish-actions.pod:2832
25154 " lvresize device mbytes\n"
25159 #: ../fish/guestfish-actions.pod:2838
25160 msgid "lvresize-free"
25164 #: ../fish/guestfish-actions.pod:2840
25167 " lvresize-free lv percent\n"
25172 #: ../fish/guestfish-actions.pod:2848
25177 #: ../fish/guestfish-actions.pod:2850
25185 #: ../fish/guestfish-actions.pod:2858
25186 msgid "See also L</lvs-full>, L</list-filesystems>."
25190 #: ../fish/guestfish-actions.pod:2860
25195 #: ../fish/guestfish-actions.pod:2862
25203 #: ../fish/guestfish-actions.pod:2867
25208 #: ../fish/guestfish-actions.pod:2869
25216 #: ../fish/guestfish-actions.pod:2873
25221 #: ../fish/guestfish-actions.pod:2875
25224 " lxattrlist path 'names ...'\n"
25229 #: ../fish/guestfish-actions.pod:2891
25231 "This call is intended for programs that want to efficiently list a directory "
25232 "contents without making many round-trips. See also L</lstatlist> for a "
25233 "similarly efficient call for getting standard stats. Very long directory "
25234 "listings might cause the protocol message size to be exceeded, causing this "
25235 "call to fail. The caller must split up such requests into smaller groups of "
25240 #: ../fish/guestfish-actions.pod:2899
25245 #: ../fish/guestfish-actions.pod:2901
25253 #: ../fish/guestfish-actions.pod:2905
25258 #: ../fish/guestfish-actions.pod:2907
25261 " mkdir-mode path mode\n"
25266 #: ../fish/guestfish-actions.pod:2916
25267 msgid "See also L</mkdir>, L</umask>"
25271 #: ../fish/guestfish-actions.pod:2918
25276 #: ../fish/guestfish-actions.pod:2920
25284 #: ../fish/guestfish-actions.pod:2925
25289 #: ../fish/guestfish-actions.pod:2927
25292 " mkdtemp template\n"
25297 #: ../fish/guestfish-actions.pod:2948
25302 #: ../fish/guestfish-actions.pod:2950
25305 " mke2fs-J fstype blocksize device journal\n"
25310 #: ../fish/guestfish-actions.pod:2958
25311 msgid "See also L</mke2journal>."
25315 #: ../fish/guestfish-actions.pod:2960
25320 #: ../fish/guestfish-actions.pod:2962
25323 " mke2fs-JL fstype blocksize device label\n"
25328 #: ../fish/guestfish-actions.pod:2967
25329 msgid "See also L</mke2journal-L>."
25333 #: ../fish/guestfish-actions.pod:2969
25338 #: ../fish/guestfish-actions.pod:2971
25341 " mke2fs-JU fstype blocksize device uuid\n"
25346 #: ../fish/guestfish-actions.pod:2976
25347 msgid "See also L</mke2journal-U>."
25351 #: ../fish/guestfish-actions.pod:2978
25352 msgid "mke2journal"
25356 #: ../fish/guestfish-actions.pod:2980
25359 " mke2journal blocksize device\n"
25364 #: ../fish/guestfish-actions.pod:2987
25365 msgid "mke2journal-L"
25369 #: ../fish/guestfish-actions.pod:2989
25372 " mke2journal-L blocksize label device\n"
25377 #: ../fish/guestfish-actions.pod:2993
25378 msgid "mke2journal-U"
25382 #: ../fish/guestfish-actions.pod:2995
25385 " mke2journal-U blocksize uuid device\n"
25390 #: ../fish/guestfish-actions.pod:2999
25395 #: ../fish/guestfish-actions.pod:3001
25398 " mkfifo mode path\n"
25403 #: ../fish/guestfish-actions.pod:3003
25405 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
25406 "is just a convenient wrapper around L</mknod>."
25410 #: ../fish/guestfish-actions.pod:3009
25415 #: ../fish/guestfish-actions.pod:3011
25418 " mkfs fstype device\n"
25423 #: ../fish/guestfish-actions.pod:3017
25428 #: ../fish/guestfish-actions.pod:3019
25431 " mkfs-b fstype blocksize device\n"
25436 #: ../fish/guestfish-actions.pod:3021
25438 "This call is similar to L</mkfs>, but it allows you to control the block "
25439 "size of the resulting filesystem. Supported block sizes depend on the "
25440 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
25444 #: ../fish/guestfish-actions.pod:3029
25446 "This function is deprecated. In new code, use the L</mkfs_opts> call "
25451 #: ../fish/guestfish-actions.pod:3036
25456 #: ../fish/guestfish-actions.pod:3038
25459 " mkfs-opts fstype device [blocksize:..] [features:..]\n"
25464 #: ../fish/guestfish-actions.pod:3073
25465 msgid "mkmountpoint"
25469 #: ../fish/guestfish-actions.pod:3075
25472 " mkmountpoint exemptpath\n"
25477 #: ../fish/guestfish-actions.pod:3077
25479 "L</mkmountpoint> and L</rmmountpoint> are specialized calls that can be used "
25480 "to create extra mountpoints before mounting the first filesystem."
25484 #: ../fish/guestfish-actions.pod:3101
25486 "L</mkmountpoint> is not compatible with L</umount-all>. You may get "
25487 "unexpected errors if you try to mix these calls. It is safest to manually "
25488 "unmount filesystems and remove mountpoints after use."
25492 #: ../fish/guestfish-actions.pod:3105
25494 "L</umount-all> unmounts filesystems by sorting the paths longest first, so "
25495 "for this to work for manual mountpoints, you must ensure that the innermost "
25496 "mountpoints have the longest pathnames, as in the example code above."
25500 #: ../fish/guestfish-actions.pod:3112
25502 "Autosync [see L</set-autosync>, this is set by default on handles] can cause "
25503 "L</umount-all> to be called when the handle is closed which can also trigger "
25508 #: ../fish/guestfish-actions.pod:3116
25513 #: ../fish/guestfish-actions.pod:3118
25516 " mknod mode devmajor devminor path\n"
25521 #: ../fish/guestfish-actions.pod:3128
25523 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
25524 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
25525 "regular file). These constants are available in the standard Linux header "
25526 "files, or you can use L</mknod-b>, L</mknod-c> or L</mkfifo> which are "
25527 "wrappers around this command which bitwise OR in the appropriate constant "
25532 #: ../fish/guestfish-actions.pod:3138
25537 #: ../fish/guestfish-actions.pod:3140
25540 " mknod-b mode devmajor devminor path\n"
25545 #: ../fish/guestfish-actions.pod:3142
25547 "This call creates a block device node called C<path> with mode C<mode> and "
25548 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
25549 "wrapper around L</mknod>."
25553 #: ../fish/guestfish-actions.pod:3148
25558 #: ../fish/guestfish-actions.pod:3150
25561 " mknod-c mode devmajor devminor path\n"
25566 #: ../fish/guestfish-actions.pod:3152
25568 "This call creates a char device node called C<path> with mode C<mode> and "
25569 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
25570 "wrapper around L</mknod>."
25574 #: ../fish/guestfish-actions.pod:3158
25579 #: ../fish/guestfish-actions.pod:3160
25587 #: ../fish/guestfish-actions.pod:3164
25592 #: ../fish/guestfish-actions.pod:3166
25595 " mkswap-L label device\n"
25600 #: ../fish/guestfish-actions.pod:3174
25605 #: ../fish/guestfish-actions.pod:3176
25608 " mkswap-U uuid device\n"
25613 #: ../fish/guestfish-actions.pod:3180
25614 msgid "mkswap-file"
25618 #: ../fish/guestfish-actions.pod:3182
25621 " mkswap-file path\n"
25626 #: ../fish/guestfish-actions.pod:3186
25628 "This command just writes a swap file signature to an existing file. To "
25629 "create the file itself, use something like L</fallocate>."
25633 #: ../fish/guestfish-actions.pod:3189
25638 #: ../fish/guestfish-actions.pod:3191
25641 " modprobe modulename\n"
25646 #: ../fish/guestfish-actions.pod:3198
25651 #: ../fish/guestfish-actions.pod:3200
25654 " mount device mountpoint\n"
25659 #: ../fish/guestfish-actions.pod:3216
25661 "B<Important note:> When you use this call, the filesystem options C<sync> "
25662 "and C<noatime> are set implicitly. This was originally done because we "
25663 "thought it would improve reliability, but it turns out that I<-o sync> has a "
25664 "very large negative performance impact and negligible effect on "
25665 "reliability. Therefore we recommend that you avoid using L</mount> in any "
25666 "code that needs performance, and instead use L</mount-options> (use an empty "
25667 "string for the first parameter if you don't want any options)."
25671 #: ../fish/guestfish-actions.pod:3226
25673 "This function is deprecated. In new code, use the L</mount_options> call "
25678 #: ../fish/guestfish-actions.pod:3233
25683 #: ../fish/guestfish-actions.pod:3235
25686 " mount-loop file mountpoint\n"
25691 #: ../fish/guestfish-actions.pod:3241
25692 msgid "mount-options"
25696 #: ../fish/guestfish-actions.pod:3243
25699 " mount-options options device mountpoint\n"
25704 #: ../fish/guestfish-actions.pod:3245
25706 "This is the same as the L</mount> command, but it allows you to set the "
25707 "mount options as for the L<mount(8)> I<-o> flag."
25711 #: ../fish/guestfish-actions.pod:3253
25716 #: ../fish/guestfish-actions.pod:3255
25719 " mount-ro device mountpoint\n"
25724 #: ../fish/guestfish-actions.pod:3257
25726 "This is the same as the L</mount> command, but it mounts the filesystem with "
25727 "the read-only (I<-o ro>) flag."
25731 #: ../fish/guestfish-actions.pod:3260
25736 #: ../fish/guestfish-actions.pod:3262
25739 " mount-vfs options vfstype device mountpoint\n"
25744 #: ../fish/guestfish-actions.pod:3264
25746 "This is the same as the L</mount> command, but it allows you to set both the "
25747 "mount options and the vfstype as for the L<mount(8)> I<-o> and I<-t> flags."
25751 #: ../fish/guestfish-actions.pod:3268
25752 msgid "mountpoints"
25756 #: ../fish/guestfish-actions.pod:3270
25764 #: ../fish/guestfish-actions.pod:3272
25766 "This call is similar to L</mounts>. That call returns a list of devices. "
25767 "This one returns a hash table (map) of device name to directory where the "
25768 "device is mounted."
25772 #: ../fish/guestfish-actions.pod:3276
25777 #: ../fish/guestfish-actions.pod:3278
25785 #: ../fish/guestfish-actions.pod:3285
25786 msgid "See also: L</mountpoints>"
25790 #: ../fish/guestfish-actions.pod:3287
25795 #: ../fish/guestfish-actions.pod:3289
25803 #: ../fish/guestfish-actions.pod:3294
25804 msgid "ntfs-3g-probe"
25808 #: ../fish/guestfish-actions.pod:3296
25811 " ntfs-3g-probe true|false device\n"
25816 #: ../fish/guestfish-actions.pod:3310
25821 #: ../fish/guestfish-actions.pod:3312
25824 " ntfsresize device\n"
25829 #: ../fish/guestfish-actions.pod:3327
25830 msgid "ntfsresize-size"
25834 #: ../fish/guestfish-actions.pod:3329
25837 " ntfsresize-size device size\n"
25842 #: ../fish/guestfish-actions.pod:3331
25844 "This command is the same as L</ntfsresize> except that it allows you to "
25845 "specify the new size (in bytes) explicitly."
25849 #: ../fish/guestfish-actions.pod:3334
25854 #: ../fish/guestfish-actions.pod:3336
25857 " part-add device prlogex startsect endsect\n"
25862 #: ../fish/guestfish-actions.pod:3338
25864 "This command adds a partition to C<device>. If there is no partition table "
25865 "on the device, call L</part-init> first."
25869 #: ../fish/guestfish-actions.pod:3350
25871 "Creating a partition which covers the whole disk is not so easy. Use L</"
25872 "part-disk> to do that."
25876 #: ../fish/guestfish-actions.pod:3353
25881 #: ../fish/guestfish-actions.pod:3355
25884 " part-del device partnum\n"
25889 #: ../fish/guestfish-actions.pod:3363
25894 #: ../fish/guestfish-actions.pod:3365
25897 " part-disk device parttype\n"
25902 #: ../fish/guestfish-actions.pod:3367
25904 "This command is simply a combination of L</part-init> followed by L</part-"
25905 "add> to create a single primary partition covering the whole disk."
25909 #: ../fish/guestfish-actions.pod:3371
25911 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
25912 "possible values are described in L</part-init>."
25916 #: ../fish/guestfish-actions.pod:3377
25917 msgid "part-get-bootable"
25921 #: ../fish/guestfish-actions.pod:3379
25924 " part-get-bootable device partnum\n"
25929 #: ../fish/guestfish-actions.pod:3384
25930 msgid "See also L</part-set-bootable>."
25934 #: ../fish/guestfish-actions.pod:3386
25935 msgid "part-get-mbr-id"
25939 #: ../fish/guestfish-actions.pod:3388
25942 " part-get-mbr-id device partnum\n"
25947 #: ../fish/guestfish-actions.pod:3393 ../fish/guestfish-actions.pod:3531
25949 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
25950 "undefined results for other partition table types (see L</part-get-"
25955 #: ../fish/guestfish-actions.pod:3397
25956 msgid "part-get-parttype"
25960 #: ../fish/guestfish-actions.pod:3399
25963 " part-get-parttype device\n"
25968 #: ../fish/guestfish-actions.pod:3404
25970 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
25971 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
25972 "possible, although unusual. See L</part-init> for a full list."
25976 #: ../fish/guestfish-actions.pod:3409
25981 #: ../fish/guestfish-actions.pod:3411
25984 " part-init device parttype\n"
25989 #: ../fish/guestfish-actions.pod:3417
25991 "Initially there are no partitions. Following this, you should call L</part-"
25992 "add> for each partition required."
25996 #: ../fish/guestfish-actions.pod:3480
26001 #: ../fish/guestfish-actions.pod:3482
26004 " part-list device\n"
26009 #: ../fish/guestfish-actions.pod:3497
26011 "Start of the partition I<in bytes>. To get sectors you have to divide by "
26012 "the device's sector size, see L</blockdev-getss>."
26016 #: ../fish/guestfish-actions.pod:3510
26017 msgid "part-set-bootable"
26021 #: ../fish/guestfish-actions.pod:3512
26024 " part-set-bootable device partnum true|false\n"
26029 #: ../fish/guestfish-actions.pod:3521
26030 msgid "part-set-mbr-id"
26034 #: ../fish/guestfish-actions.pod:3523
26037 " part-set-mbr-id device partnum idbyte\n"
26042 #: ../fish/guestfish-actions.pod:3535
26043 msgid "part-set-name"
26047 #: ../fish/guestfish-actions.pod:3537
26050 " part-set-name device partnum name\n"
26055 #: ../fish/guestfish-actions.pod:3545
26056 msgid "part-to-dev"
26060 #: ../fish/guestfish-actions.pod:3547
26063 " part-to-dev partition\n"
26068 #: ../fish/guestfish-actions.pod:3553
26070 "The named partition must exist, for example as a string returned from L</"
26071 "list-partitions>."
26075 #: ../fish/guestfish-actions.pod:3556
26076 msgid "ping-daemon"
26080 #: ../fish/guestfish-actions.pod:3558
26088 #: ../fish/guestfish-actions.pod:3565
26093 #: ../fish/guestfish-actions.pod:3567
26096 " pread path count offset\n"
26101 #: ../fish/guestfish-actions.pod:3575
26102 msgid "See also L</pwrite>, L</pread-device>."
26106 #: ../fish/guestfish-actions.pod:3580
26107 msgid "pread-device"
26111 #: ../fish/guestfish-actions.pod:3582
26114 " pread-device device count offset\n"
26119 #: ../fish/guestfish-actions.pod:3590
26120 msgid "See also L</pread>."
26124 #: ../fish/guestfish-actions.pod:3595
26129 #: ../fish/guestfish-actions.pod:3597
26132 " pvcreate device\n"
26137 #: ../fish/guestfish-actions.pod:3603
26142 #: ../fish/guestfish-actions.pod:3605
26145 " pvremove device\n"
26150 #: ../fish/guestfish-actions.pod:3614
26155 #: ../fish/guestfish-actions.pod:3616
26158 " pvresize device\n"
26163 #: ../fish/guestfish-actions.pod:3621
26164 msgid "pvresize-size"
26168 #: ../fish/guestfish-actions.pod:3623
26171 " pvresize-size device size\n"
26176 #: ../fish/guestfish-actions.pod:3625
26178 "This command is the same as L</pvresize> except that it allows you to "
26179 "specify the new size (in bytes) explicitly."
26183 #: ../fish/guestfish-actions.pod:3628
26188 #: ../fish/guestfish-actions.pod:3630
26196 #: ../fish/guestfish-actions.pod:3638
26197 msgid "See also L</pvs-full>."
26201 #: ../fish/guestfish-actions.pod:3640
26206 #: ../fish/guestfish-actions.pod:3642
26214 #: ../fish/guestfish-actions.pod:3647
26219 #: ../fish/guestfish-actions.pod:3649
26227 #: ../fish/guestfish-actions.pod:3653
26232 #: ../fish/guestfish-actions.pod:3655
26235 " pwrite path content offset\n"
26240 #: ../fish/guestfish-actions.pod:3666
26241 msgid "See also L</pread>, L</pwrite-device>."
26245 #: ../fish/guestfish-actions.pod:3671
26246 msgid "pwrite-device"
26250 #: ../fish/guestfish-actions.pod:3673
26253 " pwrite-device device content offset\n"
26258 #: ../fish/guestfish-actions.pod:3683
26259 msgid "See also L</pwrite>."
26263 #: ../fish/guestfish-actions.pod:3688
26268 #: ../fish/guestfish-actions.pod:3690
26271 " read-file path\n"
26276 #: ../fish/guestfish-actions.pod:3695
26278 "Unlike L</cat>, this function can correctly handle files that contain "
26279 "embedded ASCII NUL characters. However unlike L</download>, this function "
26280 "is limited in the total size of file that can be handled."
26284 #: ../fish/guestfish-actions.pod:3703
26289 #: ../fish/guestfish-actions.pod:3705
26292 " read-lines path\n"
26297 #: ../fish/guestfish-actions.pod:3712
26299 "Note that this function cannot correctly handle binary files (specifically, "
26300 "files containing C<\\0> character which is treated as end of line). For "
26301 "those you need to use the L</read-file> function which has a more complex "
26306 #: ../fish/guestfish-actions.pod:3717
26311 #: ../fish/guestfish-actions.pod:3719
26319 #: ../fish/guestfish-actions.pod:3771
26321 "This function is primarily intended for use by programs. To get a simple "
26322 "list of names, use L</ls>. To get a printable directory for human "
26323 "consumption, use L</ll>."
26327 #: ../fish/guestfish-actions.pod:3775
26332 #: ../fish/guestfish-actions.pod:3777
26340 #: ../fish/guestfish-actions.pod:3781
26341 msgid "readlinklist"
26345 #: ../fish/guestfish-actions.pod:3783
26348 " readlinklist path 'names ...'\n"
26353 #: ../fish/guestfish-actions.pod:3807
26358 #: ../fish/guestfish-actions.pod:3809
26366 #: ../fish/guestfish-actions.pod:3814
26367 msgid "removexattr"
26371 #: ../fish/guestfish-actions.pod:3816
26374 " removexattr xattr path\n"
26379 #: ../fish/guestfish-actions.pod:3821
26380 msgid "See also: L</lremovexattr>, L<attr(5)>."
26384 #: ../fish/guestfish-actions.pod:3823
26389 #: ../fish/guestfish-actions.pod:3825
26392 " resize2fs device\n"
26397 #: ../fish/guestfish-actions.pod:3830
26399 "I<Note:> It is sometimes required that you run L</e2fsck-f> on the C<device> "
26400 "before calling this command. For unknown reasons C<resize2fs> sometimes "
26401 "gives an error about this and sometimes not. In any case, it is always safe "
26402 "to call L</e2fsck-f> before calling this function."
26406 #: ../fish/guestfish-actions.pod:3836
26407 msgid "resize2fs-M"
26411 #: ../fish/guestfish-actions.pod:3838
26414 " resize2fs-M device\n"
26419 #: ../fish/guestfish-actions.pod:3840
26421 "This command is the same as L</resize2fs>, but the filesystem is resized to "
26422 "its minimum size. This works like the I<-M> option to the C<resize2fs> "
26427 #: ../fish/guestfish-actions.pod:3844
26429 "To get the resulting size of the filesystem you should call L</tune2fs-l> "
26430 "and read the C<Block size> and C<Block count> values. These two numbers, "
26431 "multiplied together, give the resulting size of the minimal filesystem in "
26436 #: ../fish/guestfish-actions.pod:3849
26437 msgid "resize2fs-size"
26441 #: ../fish/guestfish-actions.pod:3851
26444 " resize2fs-size device size\n"
26449 #: ../fish/guestfish-actions.pod:3853
26451 "This command is the same as L</resize2fs> except that it allows you to "
26452 "specify the new size (in bytes) explicitly."
26456 #: ../fish/guestfish-actions.pod:3856
26461 #: ../fish/guestfish-actions.pod:3858
26469 #: ../fish/guestfish-actions.pod:3862
26474 #: ../fish/guestfish-actions.pod:3864
26482 #: ../fish/guestfish-actions.pod:3870
26487 #: ../fish/guestfish-actions.pod:3872
26495 #: ../fish/guestfish-actions.pod:3876
26496 msgid "rmmountpoint"
26500 #: ../fish/guestfish-actions.pod:3878
26503 " rmmountpoint exemptpath\n"
26508 #: ../fish/guestfish-actions.pod:3880
26510 "This calls removes a mountpoint that was previously created with L</"
26511 "mkmountpoint>. See L</mkmountpoint> for full details."
26515 #: ../fish/guestfish-actions.pod:3884
26516 msgid "scrub-device"
26520 #: ../fish/guestfish-actions.pod:3886
26523 " scrub-device device\n"
26528 #: ../fish/guestfish-actions.pod:3897
26533 #: ../fish/guestfish-actions.pod:3899
26536 " scrub-file file\n"
26541 #: ../fish/guestfish-actions.pod:3909
26542 msgid "scrub-freespace"
26546 #: ../fish/guestfish-actions.pod:3911
26549 " scrub-freespace dir\n"
26554 #: ../fish/guestfish-actions.pod:3913
26556 "This command creates the directory C<dir> and then fills it with files until "
26557 "the filesystem is full, and scrubs the files as for L</scrub-file>, and "
26558 "deletes them. The intention is to scrub any free space on the partition "
26559 "containing C<dir>."
26563 #: ../fish/guestfish-actions.pod:3922
26568 #: ../fish/guestfish-actions.pod:3924
26573 #: ../fish/guestfish-actions.pod:3926
26576 " set-append append\n"
26581 #: ../fish/guestfish-actions.pod:3937
26582 msgid "set-attach-method"
26586 #: ../fish/guestfish-actions.pod:3939
26587 msgid "attach-method"
26591 #: ../fish/guestfish-actions.pod:3941
26594 " set-attach-method attachmethod\n"
26599 #: ../fish/guestfish-actions.pod:3963
26600 msgid "set-autosync"
26604 #: ../fish/guestfish-actions.pod:3965
26609 #: ../fish/guestfish-actions.pod:3967
26612 " set-autosync true|false\n"
26617 #: ../fish/guestfish-actions.pod:3977
26622 #: ../fish/guestfish-actions.pod:3979
26627 #: ../fish/guestfish-actions.pod:3981
26630 " set-direct true|false\n"
26635 #: ../fish/guestfish-actions.pod:3987
26637 "One consequence of this is that log messages aren't caught by the library "
26638 "and handled by L</set-log-message-callback>, but go straight to stdout."
26642 #: ../fish/guestfish-actions.pod:3996
26643 msgid "set-e2label"
26647 #: ../fish/guestfish-actions.pod:3998
26650 " set-e2label device label\n"
26655 #: ../fish/guestfish-actions.pod:4004
26657 "You can use either L</tune2fs-l> or L</get-e2label> to return the existing "
26658 "label on a filesystem."
26662 #: ../fish/guestfish-actions.pod:4007
26667 #: ../fish/guestfish-actions.pod:4009
26670 " set-e2uuid device uuid\n"
26675 #: ../fish/guestfish-actions.pod:4016
26677 "You can use either L</tune2fs-l> or L</get-e2uuid> to return the existing "
26678 "UUID of a filesystem."
26682 #: ../fish/guestfish-actions.pod:4019
26683 msgid "set-memsize"
26687 #: ../fish/guestfish-actions.pod:4021
26692 #: ../fish/guestfish-actions.pod:4023
26695 " set-memsize memsize\n"
26700 #: ../fish/guestfish-actions.pod:4025
26702 "This sets the memory size in megabytes allocated to the qemu subprocess. "
26703 "This only has any effect if called before L</launch>."
26707 #: ../fish/guestfish-actions.pod:4036
26708 msgid "set-network"
26712 #: ../fish/guestfish-actions.pod:4038
26717 #: ../fish/guestfish-actions.pod:4040
26720 " set-network true|false\n"
26725 #: ../fish/guestfish-actions.pod:4048
26727 "You must call this before calling L</launch>, otherwise it has no effect."
26731 #: ../fish/guestfish-actions.pod:4051
26736 #: ../fish/guestfish-actions.pod:4053
26741 #: ../fish/guestfish-actions.pod:4055
26744 " set-path searchpath\n"
26749 #: ../fish/guestfish-actions.pod:4064
26754 #: ../fish/guestfish-actions.pod:4066
26759 #: ../fish/guestfish-actions.pod:4068
26767 #: ../fish/guestfish-actions.pod:4088
26768 msgid "set-recovery-proc"
26772 #: ../fish/guestfish-actions.pod:4090
26773 msgid "recovery-proc"
26777 #: ../fish/guestfish-actions.pod:4092
26780 " set-recovery-proc true|false\n"
26785 #: ../fish/guestfish-actions.pod:4094
26787 "If this is called with the parameter C<false> then L</launch> does not "
26788 "create a recovery process. The purpose of the recovery process is to stop "
26789 "runaway qemu processes in the case where the main program aborts abruptly."
26793 #: ../fish/guestfish-actions.pod:4099
26795 "This only has any effect if called before L</launch>, and the default is "
26800 #: ../fish/guestfish-actions.pod:4108
26801 msgid "set-selinux"
26805 #: ../fish/guestfish-actions.pod:4110
26810 #: ../fish/guestfish-actions.pod:4112
26813 " set-selinux true|false\n"
26818 #: ../fish/guestfish-actions.pod:4123
26823 #: ../fish/guestfish-actions.pod:4125
26828 #: ../fish/guestfish-actions.pod:4127
26831 " set-trace true|false\n"
26836 #: ../fish/guestfish-actions.pod:4139
26838 "Trace messages are normally sent to C<stderr>, unless you register a "
26839 "callback to send them somewhere else (see L</set-event-callback>)."
26843 #: ../fish/guestfish-actions.pod:4143
26844 msgid "set-verbose"
26848 #: ../fish/guestfish-actions.pod:4145
26853 #: ../fish/guestfish-actions.pod:4147
26856 " set-verbose true|false\n"
26861 #: ../fish/guestfish-actions.pod:4154
26863 "Verbose messages are normally sent to C<stderr>, unless you register a "
26864 "callback to send them somewhere else (see L</set-event-callback>)."
26868 #: ../fish/guestfish-actions.pod:4158
26873 #: ../fish/guestfish-actions.pod:4160
26876 " setcon context\n"
26881 #: ../fish/guestfish-actions.pod:4167
26886 #: ../fish/guestfish-actions.pod:4169
26889 " setxattr xattr val vallen path\n"
26894 #: ../fish/guestfish-actions.pod:4175
26895 msgid "See also: L</lsetxattr>, L<attr(5)>."
26899 #: ../fish/guestfish-actions.pod:4177
26904 #: ../fish/guestfish-actions.pod:4179
26907 " sfdisk device cyls heads sectors 'lines ...'\n"
26912 #: ../fish/guestfish-actions.pod:4201
26913 msgid "See also: L</sfdisk-l>, L</sfdisk-N>, L</part-init>"
26917 #: ../fish/guestfish-actions.pod:4207 ../fish/guestfish-actions.pod:4230
26918 #: ../fish/guestfish-actions.pod:4252
26920 "This function is deprecated. In new code, use the L</part_add> call instead."
26924 #: ../fish/guestfish-actions.pod:4214
26929 #: ../fish/guestfish-actions.pod:4216
26932 " sfdiskM device 'lines ...'\n"
26937 #: ../fish/guestfish-actions.pod:4218
26939 "This is a simplified interface to the L</sfdisk> command, where partition "
26940 "sizes are specified in megabytes only (rounded to the nearest cylinder) and "
26941 "you don't need to specify the cyls, heads and sectors parameters which were "
26942 "rarely if ever used anyway."
26946 #: ../fish/guestfish-actions.pod:4224
26947 msgid "See also: L</sfdisk>, the L<sfdisk(8)> manpage and L</part-disk>"
26951 #: ../fish/guestfish-actions.pod:4237
26956 #: ../fish/guestfish-actions.pod:4239
26959 " sfdisk-N device partnum cyls heads sectors line\n"
26964 #: ../fish/guestfish-actions.pod:4244
26966 "For other parameters, see L</sfdisk>. You should usually pass C<0> for the "
26967 "cyls/heads/sectors parameters."
26971 #: ../fish/guestfish-actions.pod:4247
26972 msgid "See also: L</part-add>"
26976 #: ../fish/guestfish-actions.pod:4259
26977 msgid "sfdisk-disk-geometry"
26981 #: ../fish/guestfish-actions.pod:4261
26984 " sfdisk-disk-geometry device\n"
26989 #: ../fish/guestfish-actions.pod:4263
26991 "This displays the disk geometry of C<device> read from the partition table. "
26992 "Especially in the case where the underlying block device has been resized, "
26993 "this can be different from the kernel's idea of the geometry (see L</sfdisk-"
26994 "kernel-geometry>)."
26998 #: ../fish/guestfish-actions.pod:4271
26999 msgid "sfdisk-kernel-geometry"
27003 #: ../fish/guestfish-actions.pod:4273
27006 " sfdisk-kernel-geometry device\n"
27011 #: ../fish/guestfish-actions.pod:4280
27016 #: ../fish/guestfish-actions.pod:4282
27019 " sfdisk-l device\n"
27024 #: ../fish/guestfish-actions.pod:4288
27025 msgid "See also: L</part-list>"
27029 #: ../fish/guestfish-actions.pod:4290
27031 "This function is deprecated. In new code, use the L</part_list> call "
27036 #: ../fish/guestfish-actions.pod:4297
27041 #: ../fish/guestfish-actions.pod:4299
27049 #: ../fish/guestfish-actions.pod:4304
27050 msgid "This is like L</command>, but passes the command to:"
27054 #: ../fish/guestfish-actions.pod:4312
27055 msgid "All the provisos about L</command> apply to this call."
27059 #: ../fish/guestfish-actions.pod:4314
27064 #: ../fish/guestfish-actions.pod:4316
27067 " sh-lines command\n"
27072 #: ../fish/guestfish-actions.pod:4318
27073 msgid "This is the same as L</sh>, but splits the result into a list of lines."
27077 #: ../fish/guestfish-actions.pod:4321
27078 msgid "See also: L</command-lines>"
27082 #: ../fish/guestfish-actions.pod:4323
27087 #: ../fish/guestfish-actions.pod:4325
27095 #: ../fish/guestfish-actions.pod:4329
27100 #: ../fish/guestfish-actions.pod:4331
27108 #: ../fish/guestfish-actions.pod:4337
27113 #: ../fish/guestfish-actions.pod:4339
27121 #: ../fish/guestfish-actions.pod:4347
27126 #: ../fish/guestfish-actions.pod:4349
27134 #: ../fish/guestfish-actions.pod:4357
27139 #: ../fish/guestfish-actions.pod:4359
27142 " strings-e encoding path\n"
27147 #: ../fish/guestfish-actions.pod:4361
27149 "This is like the L</strings> command, but allows you to specify the encoding "
27150 "of strings that are looked for in the source file C<path>."
27154 #: ../fish/guestfish-actions.pod:4371
27156 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
27157 "ISO-8859-X (this is what L</strings> uses)."
27161 #: ../fish/guestfish-actions.pod:4403
27162 msgid "swapoff-device"
27166 #: ../fish/guestfish-actions.pod:4405
27169 " swapoff-device device\n"
27174 #: ../fish/guestfish-actions.pod:4407
27176 "This command disables the libguestfs appliance swap device or partition "
27177 "named C<device>. See L</swapon-device>."
27181 #: ../fish/guestfish-actions.pod:4411
27182 msgid "swapoff-file"
27186 #: ../fish/guestfish-actions.pod:4413
27189 " swapoff-file file\n"
27194 #: ../fish/guestfish-actions.pod:4417
27195 msgid "swapoff-label"
27199 #: ../fish/guestfish-actions.pod:4419
27202 " swapoff-label label\n"
27207 #: ../fish/guestfish-actions.pod:4424
27208 msgid "swapoff-uuid"
27212 #: ../fish/guestfish-actions.pod:4426
27215 " swapoff-uuid uuid\n"
27220 #: ../fish/guestfish-actions.pod:4431
27221 msgid "swapon-device"
27225 #: ../fish/guestfish-actions.pod:4433
27228 " swapon-device device\n"
27233 #: ../fish/guestfish-actions.pod:4435
27235 "This command enables the libguestfs appliance to use the swap device or "
27236 "partition named C<device>. The increased memory is made available for all "
27237 "commands, for example those run using L</command> or L</sh>."
27241 #: ../fish/guestfish-actions.pod:4447
27242 msgid "swapon-file"
27246 #: ../fish/guestfish-actions.pod:4449
27249 " swapon-file file\n"
27254 #: ../fish/guestfish-actions.pod:4451
27256 "This command enables swap to a file. See L</swapon-device> for other notes."
27260 #: ../fish/guestfish-actions.pod:4454
27261 msgid "swapon-label"
27265 #: ../fish/guestfish-actions.pod:4456
27268 " swapon-label label\n"
27273 #: ../fish/guestfish-actions.pod:4458
27275 "This command enables swap to a labeled swap partition. See L</swapon-"
27276 "device> for other notes."
27280 #: ../fish/guestfish-actions.pod:4461
27281 msgid "swapon-uuid"
27285 #: ../fish/guestfish-actions.pod:4463
27288 " swapon-uuid uuid\n"
27293 #: ../fish/guestfish-actions.pod:4465
27295 "This command enables swap to a swap partition with the given UUID. See L</"
27296 "swapon-device> for other notes."
27300 #: ../fish/guestfish-actions.pod:4468
27305 #: ../fish/guestfish-actions.pod:4470
27313 #: ../fish/guestfish-actions.pod:4478
27318 #: ../fish/guestfish-actions.pod:4480
27326 #: ../fish/guestfish-actions.pod:4488
27331 #: ../fish/guestfish-actions.pod:4490
27334 " tail-n nrlines path\n"
27339 #: ../fish/guestfish-actions.pod:4503
27344 #: ../fish/guestfish-actions.pod:4505
27347 " tar-in (tarfile|-) directory\n"
27352 #: ../fish/guestfish-actions.pod:4510
27353 msgid "To upload a compressed tarball, use L</tgz-in> or L</txz-in>."
27357 #: ../fish/guestfish-actions.pod:4515
27362 #: ../fish/guestfish-actions.pod:4517
27365 " tar-out directory (tarfile|-)\n"
27370 #: ../fish/guestfish-actions.pod:4522
27371 msgid "To download a compressed tarball, use L</tgz-out> or L</txz-out>."
27375 #: ../fish/guestfish-actions.pod:4527
27380 #: ../fish/guestfish-actions.pod:4529
27383 " tgz-in (tarball|-) directory\n"
27388 #: ../fish/guestfish-actions.pod:4534
27389 msgid "To upload an uncompressed tarball, use L</tar-in>."
27393 #: ../fish/guestfish-actions.pod:4538
27398 #: ../fish/guestfish-actions.pod:4540
27401 " tgz-out directory (tarball|-)\n"
27406 #: ../fish/guestfish-actions.pod:4545
27407 msgid "To download an uncompressed tarball, use L</tar-out>."
27411 #: ../fish/guestfish-actions.pod:4549
27416 #: ../fish/guestfish-actions.pod:4551
27424 #: ../fish/guestfish-actions.pod:4560
27429 #: ../fish/guestfish-actions.pod:4562
27437 #: ../fish/guestfish-actions.pod:4567
27438 msgid "truncate-size"
27442 #: ../fish/guestfish-actions.pod:4569
27445 " truncate-size path size\n"
27450 #: ../fish/guestfish-actions.pod:4574
27452 "If the current file size is less than C<size> then the file is extended to "
27453 "the required size with zero bytes. This creates a sparse file (ie. disk "
27454 "blocks are not allocated for the file until you write to it). To create a "
27455 "non-sparse file of zeroes, use L</fallocate64> instead."
27459 #: ../fish/guestfish-actions.pod:4580
27464 #: ../fish/guestfish-actions.pod:4582
27467 " tune2fs-l device\n"
27472 #: ../fish/guestfish-actions.pod:4592
27477 #: ../fish/guestfish-actions.pod:4594
27480 " txz-in (tarball|-) directory\n"
27485 #: ../fish/guestfish-actions.pod:4601
27490 #: ../fish/guestfish-actions.pod:4603
27493 " txz-out directory (tarball|-)\n"
27498 #: ../fish/guestfish-actions.pod:4610
27503 #: ../fish/guestfish-actions.pod:4612
27511 #: ../fish/guestfish-actions.pod:4626
27512 msgid "See also L</get-umask>, L<umask(2)>, L</mknod>, L</mkdir>."
27516 #: ../fish/guestfish-actions.pod:4631
27521 #: ../fish/guestfish-actions.pod:4633
27526 #: ../fish/guestfish-actions.pod:4635
27529 " umount pathordevice\n"
27534 #: ../fish/guestfish-actions.pod:4641
27539 #: ../fish/guestfish-actions.pod:4643
27540 msgid "unmount-all"
27544 #: ../fish/guestfish-actions.pod:4645
27552 #: ../fish/guestfish-actions.pod:4651
27557 #: ../fish/guestfish-actions.pod:4653
27560 " upload (filename|-) remotefilename\n"
27565 #: ../fish/guestfish-actions.pod:4660
27566 msgid "See also L</download>."
27570 #: ../fish/guestfish-actions.pod:4664
27571 msgid "upload-offset"
27575 #: ../fish/guestfish-actions.pod:4666
27578 " upload-offset (filename|-) remotefilename offset\n"
27583 #: ../fish/guestfish-actions.pod:4678
27585 "Note that there is no limit on the amount of data that can be uploaded with "
27586 "this call, unlike with L</pwrite>, and this call always writes the full "
27587 "amount unless an error occurs."
27591 #: ../fish/guestfish-actions.pod:4683
27592 msgid "See also L</upload>, L</pwrite>."
27596 #: ../fish/guestfish-actions.pod:4687
27601 #: ../fish/guestfish-actions.pod:4689
27604 " utimens path atsecs atnsecs mtsecs mtnsecs\n"
27609 #: ../fish/guestfish-actions.pod:4708
27614 #: ../fish/guestfish-actions.pod:4710
27622 #: ../fish/guestfish-actions.pod:4737
27624 "I<Note:> Don't use this call to test for availability of features. In "
27625 "enterprise distributions we backport features from later versions into "
27626 "earlier versions, making this an unreliable way to test for features. Use "
27627 "L</available> instead."
27631 #: ../fish/guestfish-actions.pod:4743
27636 #: ../fish/guestfish-actions.pod:4745
27639 " vfs-label device\n"
27644 #: ../fish/guestfish-actions.pod:4752
27645 msgid "To find a filesystem from the label, use L</findfs-label>."
27649 #: ../fish/guestfish-actions.pod:4754
27654 #: ../fish/guestfish-actions.pod:4756
27657 " vfs-type device\n"
27662 #: ../fish/guestfish-actions.pod:4766
27667 #: ../fish/guestfish-actions.pod:4768
27670 " vfs-uuid device\n"
27675 #: ../fish/guestfish-actions.pod:4775
27676 msgid "To find a filesystem from the UUID, use L</findfs-uuid>."
27680 #: ../fish/guestfish-actions.pod:4777
27681 msgid "vg-activate"
27685 #: ../fish/guestfish-actions.pod:4779
27688 " vg-activate true|false 'volgroups ...'\n"
27693 #: ../fish/guestfish-actions.pod:4792
27694 msgid "vg-activate-all"
27698 #: ../fish/guestfish-actions.pod:4794
27701 " vg-activate-all true|false\n"
27706 #: ../fish/guestfish-actions.pod:4804
27711 #: ../fish/guestfish-actions.pod:4806
27714 " vgcreate volgroup 'physvols ...'\n"
27719 #: ../fish/guestfish-actions.pod:4811
27724 #: ../fish/guestfish-actions.pod:4813
27727 " vglvuuids vgname\n"
27732 #: ../fish/guestfish-actions.pod:4818
27734 "You can use this along with L</lvs> and L</lvuuid> calls to associate "
27735 "logical volumes and volume groups."
27739 #: ../fish/guestfish-actions.pod:4821
27740 msgid "See also L</vgpvuuids>."
27744 #: ../fish/guestfish-actions.pod:4823
27749 #: ../fish/guestfish-actions.pod:4825
27752 " vgpvuuids vgname\n"
27757 #: ../fish/guestfish-actions.pod:4830
27759 "You can use this along with L</pvs> and L</pvuuid> calls to associate "
27760 "physical volumes and volume groups."
27764 #: ../fish/guestfish-actions.pod:4833
27765 msgid "See also L</vglvuuids>."
27769 #: ../fish/guestfish-actions.pod:4835
27774 #: ../fish/guestfish-actions.pod:4837
27777 " vgremove vgname\n"
27782 #: ../fish/guestfish-actions.pod:4844
27787 #: ../fish/guestfish-actions.pod:4846
27790 " vgrename volgroup newvolgroup\n"
27795 #: ../fish/guestfish-actions.pod:4850
27800 #: ../fish/guestfish-actions.pod:4852
27808 #: ../fish/guestfish-actions.pod:4860
27809 msgid "See also L</vgs-full>."
27813 #: ../fish/guestfish-actions.pod:4862
27818 #: ../fish/guestfish-actions.pod:4864
27826 #: ../fish/guestfish-actions.pod:4869
27831 #: ../fish/guestfish-actions.pod:4871
27839 #: ../fish/guestfish-actions.pod:4876
27844 #: ../fish/guestfish-actions.pod:4878
27852 #: ../fish/guestfish-actions.pod:4882
27857 #: ../fish/guestfish-actions.pod:4884
27865 #: ../fish/guestfish-actions.pod:4889
27870 #: ../fish/guestfish-actions.pod:4891
27878 #: ../fish/guestfish-actions.pod:4896
27883 #: ../fish/guestfish-actions.pod:4898
27891 #: ../fish/guestfish-actions.pod:4903
27896 #: ../fish/guestfish-actions.pod:4905
27899 " write path content\n"
27904 #: ../fish/guestfish-actions.pod:4913
27909 #: ../fish/guestfish-actions.pod:4915
27912 " write-file path content size\n"
27917 #: ../fish/guestfish-actions.pod:4931
27919 "This function is deprecated. In new code, use the L</write> call instead."
27923 #: ../fish/guestfish-actions.pod:4938
27928 #: ../fish/guestfish-actions.pod:4940
27931 " zegrep regex path\n"
27936 #: ../fish/guestfish-actions.pod:4948
27941 #: ../fish/guestfish-actions.pod:4950
27944 " zegrepi regex path\n"
27949 #: ../fish/guestfish-actions.pod:4958
27954 #: ../fish/guestfish-actions.pod:4960
27962 #: ../fish/guestfish-actions.pod:4968
27963 msgid "See also: L</zero-device>, L</scrub-device>."
27967 #: ../fish/guestfish-actions.pod:4970
27968 msgid "zero-device"
27972 #: ../fish/guestfish-actions.pod:4972
27975 " zero-device device\n"
27980 #: ../fish/guestfish-actions.pod:4974
27982 "This command writes zeroes over the entire C<device>. Compare with L</zero> "
27983 "which just zeroes the first few blocks of a device."
27987 #: ../fish/guestfish-actions.pod:4981
27992 #: ../fish/guestfish-actions.pod:4983
27995 " zerofree device\n"
28000 #: ../fish/guestfish-actions.pod:4996
28005 #: ../fish/guestfish-actions.pod:4998
28008 " zfgrep pattern path\n"
28013 #: ../fish/guestfish-actions.pod:5006
28018 #: ../fish/guestfish-actions.pod:5008
28021 " zfgrepi pattern path\n"
28026 #: ../fish/guestfish-actions.pod:5016
28031 #: ../fish/guestfish-actions.pod:5018
28034 " zfile meth path\n"
28039 #: ../fish/guestfish-actions.pod:5025
28041 "Since 1.0.63, use L</file> instead which can now process compressed files."
28045 #: ../fish/guestfish-actions.pod:5028
28047 "This function is deprecated. In new code, use the L</file> call instead."
28051 #: ../fish/guestfish-actions.pod:5035
28056 #: ../fish/guestfish-actions.pod:5037
28059 " zgrep regex path\n"
28064 #: ../fish/guestfish-actions.pod:5045
28069 #: ../fish/guestfish-actions.pod:5047
28072 " zgrepi regex path\n"
28077 #: ../fish/guestfish-commands.pod:1
28082 #: ../fish/guestfish-commands.pod:3
28087 #: ../fish/guestfish-commands.pod:5
28090 " alloc filename size\n"
28095 #: ../fish/guestfish-commands.pod:7
28097 "This creates an empty (zeroed) file of the given size, and then adds so it "
28098 "can be further examined."
28102 #: ../fish/guestfish-commands.pod:10 ../fish/guestfish-commands.pod:168
28103 msgid "For more advanced image creation, see L<qemu-img(1)> utility."
28107 #: ../fish/guestfish-commands.pod:12 ../fish/guestfish-commands.pod:170
28108 msgid "Size can be specified using standard suffixes, eg. C<1M>."
28112 #: ../fish/guestfish-commands.pod:14
28114 "To create a sparse file, use L</sparse> instead. To create a prepared disk "
28115 "image, see L</PREPARED DISK IMAGES>."
28119 #: ../fish/guestfish-commands.pod:17
28124 #: ../fish/guestfish-commands.pod:19
28127 " copy-in local [local ...] /remotedir\n"
28132 #: ../fish/guestfish-commands.pod:21
28134 "C<copy-in> copies local files or directories recursively into the disk "
28135 "image, placing them in the directory called C</remotedir> (which must "
28136 "exist). This guestfish meta-command turns into a sequence of L</tar-in> and "
28137 "other commands as necessary."
28141 #: ../fish/guestfish-commands.pod:26
28143 "Multiple local files and directories can be specified, but the last "
28144 "parameter must always be a remote directory. Wildcards cannot be used."
28148 #: ../fish/guestfish-commands.pod:30
28153 #: ../fish/guestfish-commands.pod:32
28156 " copy-out remote [remote ...] localdir\n"
28161 #: ../fish/guestfish-commands.pod:34
28163 "C<copy-out> copies remote files or directories recursively out of the disk "
28164 "image, placing them on the host disk in a local directory called C<localdir> "
28165 "(which must exist). This guestfish meta-command turns into a sequence of L</"
28166 "download>, L</tar-out> and other commands as necessary."
28170 #: ../fish/guestfish-commands.pod:40
28172 "Multiple remote files and directories can be specified, but the last "
28173 "parameter must always be a local directory. To download to the current "
28174 "directory, use C<.> as in:"
28178 #: ../fish/guestfish-commands.pod:44
28181 " copy-out /home .\n"
28186 #: ../fish/guestfish-commands.pod:46
28188 "Wildcards cannot be used in the ordinary command, but you can use them with "
28189 "the help of L</glob> like this:"
28193 #: ../fish/guestfish-commands.pod:49
28196 " glob copy-out /home/* .\n"
28201 #: ../fish/guestfish-commands.pod:51
28206 #: ../fish/guestfish-commands.pod:53
28209 " echo [params ...]\n"
28214 #: ../fish/guestfish-commands.pod:55
28215 msgid "This echos the parameters to the terminal."
28219 #: ../fish/guestfish-commands.pod:57
28224 #: ../fish/guestfish-commands.pod:59
28229 #: ../fish/guestfish-commands.pod:61
28234 #: ../fish/guestfish-commands.pod:63
28242 #: ../fish/guestfish-commands.pod:65
28244 "This is used to edit a file. It downloads the file, edits it locally using "
28245 "your editor, then uploads the result."
28249 #: ../fish/guestfish-commands.pod:68
28251 "The editor is C<$EDITOR>. However if you use the alternate commands C<vi> "
28252 "or C<emacs> you will get those corresponding editors."
28256 #: ../fish/guestfish-commands.pod:72
28261 #: ../fish/guestfish-commands.pod:74
28264 " glob command args...\n"
28269 #: ../fish/guestfish-commands.pod:76
28271 "Expand wildcards in any paths in the args list, and run C<command> "
28272 "repeatedly on each matching path."
28276 #: ../fish/guestfish-commands.pod:79
28277 msgid "See L</WILDCARDS AND GLOBBING>."
28281 #: ../fish/guestfish-commands.pod:81
28286 #: ../fish/guestfish-commands.pod:83
28289 " hexedit <filename|device>\n"
28290 " hexedit <filename|device> <max>\n"
28291 " hexedit <filename|device> <start> <max>\n"
28296 #: ../fish/guestfish-commands.pod:87
28298 "Use hexedit (a hex editor) to edit all or part of a binary file or block "
28303 #: ../fish/guestfish-commands.pod:90
28305 "This command works by downloading potentially the whole file or device, "
28306 "editing it locally, then uploading it. If the file or device is large, you "
28307 "have to specify which part you wish to edit by using C<max> and/or C<start> "
28308 "C<max> parameters. C<start> and C<max> are specified in bytes, with the "
28309 "usual modifiers allowed such as C<1M> (1 megabyte)."
28313 #: ../fish/guestfish-commands.pod:97
28314 msgid "For example to edit the first few sectors of a disk you might do:"
28318 #: ../fish/guestfish-commands.pod:100
28321 " hexedit /dev/sda 1M\n"
28326 #: ../fish/guestfish-commands.pod:102
28328 "which would allow you to edit anywhere within the first megabyte of the disk."
28332 #: ../fish/guestfish-commands.pod:105
28333 msgid "To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:"
28337 #: ../fish/guestfish-commands.pod:107
28340 " hexedit /dev/sda1 0x400 0x400\n"
28345 #: ../fish/guestfish-commands.pod:109
28346 msgid "(assuming the superblock is in the standard location)."
28350 #: ../fish/guestfish-commands.pod:111
28352 "This command requires the external L<hexedit(1)> program. You can specify "
28353 "another program to use by setting the C<HEXEDITOR> environment variable."
28357 #: ../fish/guestfish-commands.pod:115
28358 msgid "See also L</hexdump>."
28362 #: ../fish/guestfish-commands.pod:117
28367 #: ../fish/guestfish-commands.pod:119
28375 #: ../fish/guestfish-commands.pod:121
28377 "Change the local directory, ie. the current directory of guestfish itself."
28381 #: ../fish/guestfish-commands.pod:124
28382 msgid "Note that C<!cd> won't do what you might expect."
28386 #: ../fish/guestfish-commands.pod:126
28391 #: ../fish/guestfish-commands.pod:128
28396 #: ../fish/guestfish-commands.pod:130
28404 #: ../fish/guestfish-commands.pod:132
28405 msgid "Opens the manual page for guestfish."
28409 #: ../fish/guestfish-commands.pod:134
28414 #: ../fish/guestfish-commands.pod:136
28419 #: ../fish/guestfish-commands.pod:138
28427 #: ../fish/guestfish-commands.pod:140
28435 #: ../fish/guestfish-commands.pod:142
28436 msgid "This is used to view a file."
28440 #: ../fish/guestfish-commands.pod:144
28442 "The default viewer is C<$PAGER>. However if you use the alternate command "
28443 "C<less> you will get the C<less> command specifically."
28447 #: ../fish/guestfish-commands.pod:147
28452 #: ../fish/guestfish-commands.pod:149
28460 #: ../fish/guestfish-commands.pod:151
28462 "Close and reopen the libguestfs handle. It is not necessary to use this "
28463 "normally, because the handle is closed properly when guestfish exits. "
28464 "However this is occasionally useful for testing."
28468 #: ../fish/guestfish-commands.pod:155
28473 #: ../fish/guestfish-commands.pod:157
28476 " sparse filename size\n"
28481 #: ../fish/guestfish-commands.pod:159
28483 "This creates an empty sparse file of the given size, and then adds so it can "
28484 "be further examined."
28488 #: ../fish/guestfish-commands.pod:162
28490 "In all respects it works the same as the L</alloc> command, except that the "
28491 "image file is allocated sparsely, which means that disk blocks are not "
28492 "assigned to the file until they are needed. Sparse disk files only use "
28493 "space when written to, but they are slower and there is a danger you could "
28494 "run out of real disk space during a write operation."
28498 #: ../fish/guestfish-commands.pod:172
28503 #: ../fish/guestfish-commands.pod:174
28511 #: ../fish/guestfish-commands.pod:176
28513 "This command returns a list of the optional groups known to the daemon, and "
28514 "indicates which ones are supported by this build of the libguestfs appliance."
28518 #: ../fish/guestfish-commands.pod:180
28519 msgid "See also L<guestfs(3)/AVAILABILITY>."
28523 #: ../fish/guestfish-commands.pod:182
28528 #: ../fish/guestfish-commands.pod:184
28531 " time command args...\n"
28536 #: ../fish/guestfish-commands.pod:186
28538 "Run the command as usual, but print the elapsed time afterwards. This can "
28539 "be useful for benchmarking operations."
28543 #: ../test-tool/libguestfs-test-tool.pod:5
28544 msgid "libguestfs-test-tool - End user tests for libguestfs"
28548 #: ../test-tool/libguestfs-test-tool.pod:9
28551 " libguestfs-test-tool [--options]\n"
28556 #: ../test-tool/libguestfs-test-tool.pod:13
28558 "libguestfs-test-tool is a test program shipped with libguestfs to end users "
28559 "and developers, to allow them to check basic libguestfs functionality is "
28560 "working. This is needed because libguestfs occasionally breaks for reasons "
28561 "beyond our control: usually because of changes in the underlying qemu or "
28562 "kernel packages, or the host environment."
28566 #: ../test-tool/libguestfs-test-tool.pod:20
28567 msgid "If you suspect a problem in libguestfs, then just run:"
28571 #: ../test-tool/libguestfs-test-tool.pod:22
28574 " libguestfs-test-tool\n"
28579 #: ../test-tool/libguestfs-test-tool.pod:24
28580 msgid "It will print lots of diagnostic messages."
28584 #: ../test-tool/libguestfs-test-tool.pod:26
28585 msgid "If it runs to completion successfully, you will see this near the end:"
28589 #: ../test-tool/libguestfs-test-tool.pod:28
28592 " ===== TEST FINISHED OK =====\n"
28597 #: ../test-tool/libguestfs-test-tool.pod:30
28598 msgid "and the test tool will exit with code 0."
28602 #: ../test-tool/libguestfs-test-tool.pod:32
28604 "If it fails (and/or exits with non-zero error code), please paste the "
28605 "B<complete, unedited> output of the test tool into a bug report. More "
28606 "information about reporting bugs can be found on the L<http://libguestfs.org/"
28611 #: ../test-tool/libguestfs-test-tool.pod:41
28616 #: ../test-tool/libguestfs-test-tool.pod:43
28617 msgid "Display short usage information and exit."
28621 #: ../test-tool/libguestfs-test-tool.pod:45
28622 msgid "I<--qemu qemu_binary>"
28626 #: ../test-tool/libguestfs-test-tool.pod:47
28628 "If you have downloaded another qemu binary, point this option at the full "
28629 "path of the binary to try it."
28633 #: ../test-tool/libguestfs-test-tool.pod:50
28634 msgid "I<--qemudir qemu_source_dir>"
28638 #: ../test-tool/libguestfs-test-tool.pod:52
28640 "If you have compiled qemu from source, point this option at the source "
28641 "directory to try it."
28645 #: ../test-tool/libguestfs-test-tool.pod:55
28646 msgid "I<--timeout N>"
28650 #: ../test-tool/libguestfs-test-tool.pod:57
28652 "Set the launch timeout to C<N> seconds. The default is 120 seconds which "
28653 "does not usually need to be adjusted unless your machine is very slow."
28657 #: ../test-tool/libguestfs-test-tool.pod:63
28658 msgid "TRYING OUT A DIFFERENT VERSION OF QEMU"
28662 #: ../test-tool/libguestfs-test-tool.pod:65
28664 "If you have compiled another version of qemu from source and would like to "
28665 "try that, then you can use the I<--qemudir> option to point to the qemu "
28666 "source directory."
28670 #: ../test-tool/libguestfs-test-tool.pod:69
28672 "If you have downloaded a qemu binary from somewhere, use the I<--qemu> "
28673 "option to point to the binary."
28677 #: ../test-tool/libguestfs-test-tool.pod:72
28679 "When using an alternate qemu with libguestfs, usually you would need to "
28680 "write a qemu wrapper script (see section I<QEMU WRAPPERS> in L<guestfs(3)"
28681 ">). libguestfs-test-tool writes a temporary qemu wrapper script when you "
28682 "use either of the I<--qemudir> or I<--qemu> options."
28686 #: ../test-tool/libguestfs-test-tool.pod:79
28688 "libguestfs-test-tool returns I<0> if the tests completed without error, or "
28689 "I<1> if there was an error."
28693 #: ../test-tool/libguestfs-test-tool.pod:84
28695 "For the full list of environment variables which may affect libguestfs, "
28696 "please see the L<guestfs(3)> manual page."
28700 #: ../test-tool/libguestfs-test-tool.pod:89
28701 msgid "L<guestfs(3)>, L<http://libguestfs.org/>, L<http://qemu.org/>."
28705 #: ../fuse/guestmount.pod:5
28707 "guestmount - Mount a guest filesystem on the host using FUSE and libguestfs"
28711 #: ../fuse/guestmount.pod:9
28714 " guestmount [--options] -a disk.img -m device [--ro] mountpoint\n"
28719 #: ../fuse/guestmount.pod:11
28722 " guestmount [--options] -a disk.img -i [--ro] mountpoint\n"
28727 #: ../fuse/guestmount.pod:13
28730 " guestmount [--options] -d Guest -i [--ro] mountpoint\n"
28735 #: ../fuse/guestmount.pod:17
28737 "You must I<not> use C<guestmount> in read-write mode on live virtual "
28738 "machines. If you do this, you risk disk corruption in the VM."
28742 #: ../fuse/guestmount.pod:22
28744 "The guestmount program can be used to mount virtual machine filesystems and "
28745 "other disk images on the host. It uses libguestfs for access to the guest "
28746 "filesystem, and FUSE (the \"filesystem in userspace\") to make it appear as "
28747 "a mountable device."
28751 #: ../fuse/guestmount.pod:27
28753 "Along with other options, you have to give at least one device (I<-a> "
28754 "option) or libvirt domain (I<-d> option), and at least one mountpoint (I<-m> "
28755 "option) or use the I<-i> inspection option. How this works is better "
28756 "explained in the L<guestfish(1)> manual page, or by looking at the examples "
28761 #: ../fuse/guestmount.pod:33
28763 "FUSE lets you mount filesystems as non-root. The mountpoint must be owned "
28764 "by you, and the filesystem will not be visible to any other users unless you "
28765 "make certain global configuration changes to C</etc/fuse.conf>. To unmount "
28766 "the filesystem, use the C<fusermount -u> command."
28770 #: ../fuse/guestmount.pod:41
28772 "For a typical Windows guest which has its main filesystem on the first "
28777 #: ../fuse/guestmount.pod:44
28780 " guestmount -a windows.img -m /dev/sda1 --ro /mnt\n"
28785 #: ../fuse/guestmount.pod:46
28787 "For a typical Linux guest which has a /boot filesystem on the first "
28788 "partition, and the root filesystem on a logical volume:"
28792 #: ../fuse/guestmount.pod:49
28795 " guestmount -a linux.img -m /dev/VG/LV -m /dev/sda1:/boot --ro /mnt\n"
28800 #: ../fuse/guestmount.pod:51
28801 msgid "To get libguestfs to detect guest mountpoints for you:"
28805 #: ../fuse/guestmount.pod:53
28808 " guestmount -a guest.img -i --ro /mnt\n"
28813 #: ../fuse/guestmount.pod:55
28814 msgid "For a libvirt guest called \"Guest\" you could do:"
28818 #: ../fuse/guestmount.pod:57
28821 " guestmount -d Guest -i --ro /mnt\n"
28826 #: ../fuse/guestmount.pod:59
28828 "If you don't know what filesystems are contained in a guest or disk image, "
28829 "use L<virt-filesystems(1)> first:"
28833 #: ../fuse/guestmount.pod:62
28836 " virt-filesystems MyGuest\n"
28841 #: ../fuse/guestmount.pod:64
28843 "If you want to trace the libguestfs calls but without excessive debugging "
28844 "information, we recommend:"
28848 #: ../fuse/guestmount.pod:67
28851 " guestmount [...] --trace /mnt\n"
28856 #: ../fuse/guestmount.pod:69
28857 msgid "If you want to debug the program, we recommend:"
28861 #: ../fuse/guestmount.pod:71
28864 " guestmount [...] --trace --verbose /mnt\n"
28869 #: ../fuse/guestmount.pod:73
28874 #: ../fuse/guestmount.pod:75
28875 msgid "Other users cannot see the filesystem by default"
28879 #: ../fuse/guestmount.pod:77
28881 "If you mount a filesystem as one user (eg. root), then other users will not "
28882 "be able to see it by default. The fix is to add the FUSE C<allow_other> "
28883 "option when mounting:"
28887 #: ../fuse/guestmount.pod:81
28890 " sudo guestmount [...] -o allow_other /mnt\n"
28895 #: ../fuse/guestmount.pod:87
28896 msgid "B<-a image> | B<--add image>"
28900 #: ../fuse/guestmount.pod:89
28901 msgid "Add a block device or virtual machine image."
28905 #: ../fuse/guestmount.pod:94
28906 msgid "B<-c URI> | B<--connect URI>"
28910 #: ../fuse/guestmount.pod:100
28911 msgid "B<-d libvirt-domain> | B<--domain libvirt-domain>"
28915 #: ../fuse/guestmount.pod:106
28916 msgid "B<--dir-cache-timeout N>"
28920 #: ../fuse/guestmount.pod:108
28922 "Set the readdir cache timeout to I<N> seconds, the default being 60 "
28923 "seconds. The readdir cache [actually, there are several semi-independent "
28924 "caches] is populated after a readdir(2) call with the stat and extended "
28925 "attributes of the files in the directory, in anticipation that they will be "
28926 "requested soon after."
28930 #: ../fuse/guestmount.pod:114
28932 "There is also a different attribute cache implemented by FUSE (see the FUSE "
28933 "option I<-o attr_timeout>), but the FUSE cache does not anticipate future "
28934 "requests, only cache existing ones."
28938 #: ../fuse/guestmount.pod:125
28939 msgid "B<--format=raw|qcow2|..> | B<--format>"
28943 #: ../fuse/guestmount.pod:132
28945 "If you have untrusted raw-format guest disk images, you should use this "
28946 "option to specify the disk format. This avoids a possible security problem "
28947 "with malicious guests (CVE-2010-3851). See also L<guestfs(3)/"
28948 "guestfs_add_drive_opts>."
28952 #: ../fuse/guestmount.pod:137
28953 msgid "B<--fuse-help>"
28957 #: ../fuse/guestmount.pod:139
28958 msgid "Display help on special FUSE options (see I<-o> below)."
28962 #: ../fuse/guestmount.pod:143
28963 msgid "Display brief help and exit."
28967 #: ../fuse/guestmount.pod:145
28968 msgid "B<-i> | B<--inspector>"
28972 #: ../fuse/guestmount.pod:165
28974 "Mount the named partition or logical volume on the given mountpoint B<in the "
28975 "guest> (this has nothing to do with mountpoints in the host)."
28979 #: ../fuse/guestmount.pod:168
28981 "If the mountpoint is omitted, it defaults to C</>. You have to mount "
28982 "something on C</>."
28986 #: ../fuse/guestmount.pod:181
28987 msgid "B<-n> | B<--no-sync>"
28991 #: ../fuse/guestmount.pod:183
28993 "By default, we attempt to sync the guest disk when the FUSE mountpoint is "
28994 "unmounted. If you specify this option, then we don't attempt to sync the "
28995 "disk. See the discussion of autosync in the L<guestfs(3)> manpage."
28999 #: ../fuse/guestmount.pod:188
29000 msgid "B<-o option> | B<--option option>"
29004 #: ../fuse/guestmount.pod:190
29005 msgid "Pass extra options to FUSE."
29009 #: ../fuse/guestmount.pod:192
29011 "To get a list of all the extra options supported by FUSE, use the command "
29012 "below. Note that only the FUSE I<-o> options can be passed, and only some "
29013 "of them are a good idea."
29017 #: ../fuse/guestmount.pod:196
29020 " guestmount --fuse-help\n"
29025 #: ../fuse/guestmount.pod:198
29026 msgid "Some potentially useful FUSE options:"
29030 #: ../fuse/guestmount.pod:202
29031 msgid "B<-o allow_other>"
29035 #: ../fuse/guestmount.pod:204
29036 msgid "Allow other users to see the filesystem."
29040 #: ../fuse/guestmount.pod:206
29041 msgid "B<-o attr_timeout=N>"
29045 #: ../fuse/guestmount.pod:208
29046 msgid "Enable attribute caching by FUSE, and set the timeout to I<N> seconds."
29050 #: ../fuse/guestmount.pod:210
29051 msgid "B<-o kernel_cache>"
29055 #: ../fuse/guestmount.pod:212
29057 "Allow the kernel to cache files (reduces the number of reads that have to go "
29058 "through the L<guestfs(3)> API). This is generally a good idea if you can "
29059 "afford the extra memory usage."
29063 #: ../fuse/guestmount.pod:216
29064 msgid "B<-o uid=N> B<-o gid=N>"
29068 #: ../fuse/guestmount.pod:218
29070 "Use these options to map all UIDs and GIDs inside the guest filesystem to "
29071 "the chosen values."
29075 #: ../fuse/guestmount.pod:223
29076 msgid "B<-r> | B<--ro>"
29080 #: ../fuse/guestmount.pod:225
29082 "Add devices and mount everything read-only. Also disallow writes and make "
29083 "the disk appear read-only to FUSE."
29087 #: ../fuse/guestmount.pod:228
29089 "This is highly recommended if you are not going to edit the guest disk. If "
29090 "the guest is running and this option is I<not> supplied, then there is a "
29091 "strong risk of disk corruption in the guest. We try to prevent this from "
29092 "happening, but it is not always possible."
29096 #: ../fuse/guestmount.pod:233
29097 msgid "See also L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
29101 #: ../fuse/guestmount.pod:237
29102 msgid "Enable SELinux support for the guest."
29106 #: ../fuse/guestmount.pod:239
29107 msgid "B<-v> | B<--verbose>"
29111 #: ../fuse/guestmount.pod:241
29112 msgid "Enable verbose messages from underlying libguestfs."
29116 #: ../fuse/guestmount.pod:243
29117 msgid "B<-V> | B<--version>"
29121 #: ../fuse/guestmount.pod:245
29122 msgid "Display the program version and exit."
29126 #: ../fuse/guestmount.pod:247
29127 msgid "B<-w> | B<--rw>"
29131 #: ../fuse/guestmount.pod:252 ../fuse/guestmount.pod:273
29132 msgid "See L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
29136 #: ../fuse/guestmount.pod:254
29137 msgid "B<-x> | B<--trace>"
29141 #: ../fuse/guestmount.pod:256
29142 msgid "Trace libguestfs calls and entry into each FUSE function."
29146 #: ../fuse/guestmount.pod:258
29147 msgid "This also stops the daemon from forking into the background."
29151 #: ../fuse/guestmount.pod:279
29153 "L<guestfish(1)>, L<virt-inspector(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
29154 "L<virt-tar(1)>, L<guestfs(3)>, L<http://libguestfs.org/>, L<http://fuse.sf."
29159 #: ../fuse/guestmount.pod:294
29160 msgid "Copyright (C) 2009-2010 Red Hat Inc. L<http://libguestfs.org/>"
29164 #: ../tools/virt-edit.pl:34
29165 msgid "virt-edit - Edit a file in a virtual machine"
29169 #: ../tools/virt-edit.pl:38
29172 " virt-edit [--options] domname file\n"
29177 #: ../tools/virt-edit.pl:40
29180 " virt-edit [--options] disk.img [disk.img ...] file\n"
29185 #: ../tools/virt-edit.pl:42
29188 " virt-edit [domname|disk.img] file -e 'expr'\n"
29193 #: ../tools/virt-edit.pl:46
29195 "You must I<not> use C<virt-edit> on live virtual machines. If you do this, "
29196 "you risk disk corruption in the VM. C<virt-edit> tries to stop you from "
29197 "doing this, but doesn't catch all cases."
29201 #: ../tools/virt-edit.pl:52
29203 "C<virt-edit> is a command line tool to edit C<file> where C<file> exists in "
29204 "the named virtual machine (or disk image)."
29208 #: ../tools/virt-edit.pl:55
29209 msgid "If you want to just view a file, use L<virt-cat(1)>."
29213 #: ../tools/virt-edit.pl:57
29215 "For more complex cases you should look at the L<guestfish(1)> tool (see L</"
29216 "USING GUESTFISH> below)."
29220 #: ../tools/virt-edit.pl:60
29222 "C<virt-edit> cannot be used to create a new file, nor to edit multiple "
29223 "files. L<guestfish(1)> can do that and much more."
29227 #: ../tools/virt-edit.pl:65
29228 msgid "Edit the named files interactively:"
29232 #: ../tools/virt-edit.pl:67
29235 " virt-edit mydomain /boot/grub/grub.conf\n"
29240 #: ../tools/virt-edit.pl:69
29243 " virt-edit mydomain /etc/passwd\n"
29248 #: ../tools/virt-edit.pl:71
29249 msgid "For Windows guests, some Windows paths are understood:"
29253 #: ../tools/virt-edit.pl:73
29256 " virt-edit mywindomain 'c:\\autoexec.bat'\n"
29261 #: ../tools/virt-edit.pl:75
29263 "You can also edit files non-interactively (see L</NON-INTERACTIVE EDITING> "
29264 "below). To change the init default level to 5:"
29268 #: ../tools/virt-edit.pl:79
29271 " virt-edit mydomain /etc/inittab -e 's/^id:.*/id:5:initdefault:/'\n"
29276 #: ../tools/virt-edit.pl:91 ../tools/virt-win-reg.pl:106
29277 #: ../tools/virt-list-filesystems.pl:63 ../tools/virt-tar.pl:113
29278 #: ../tools/virt-make-fs.pl:163 ../tools/virt-list-partitions.pl:64
29279 msgid "Display brief help."
29283 #: ../tools/virt-edit.pl:99 ../tools/virt-win-reg.pl:114
29284 #: ../tools/virt-list-filesystems.pl:71 ../tools/virt-tar.pl:121
29285 #: ../tools/virt-make-fs.pl:171 ../tools/virt-list-partitions.pl:72
29286 msgid "Display version number and exit."
29290 #: ../tools/virt-edit.pl:105
29291 msgid "B<--backup extension> | B<-b extension>"
29295 #: ../tools/virt-edit.pl:107
29297 "Create a backup of the original file I<in the guest disk image>. The backup "
29298 "has the original filename with C<extension> added."
29302 #: ../tools/virt-edit.pl:110
29304 "Usually the first character of C<extension> would be a dot C<.> so you would "
29309 #: ../tools/virt-edit.pl:113
29312 " virt-edit -b .orig [etc]\n"
29317 #: ../tools/virt-edit.pl:115
29318 msgid "By default, no backup file is made."
29322 #: ../tools/virt-edit.pl:121 ../tools/virt-win-reg.pl:128
29323 #: ../tools/virt-list-filesystems.pl:77 ../tools/virt-tar.pl:127
29324 #: ../tools/virt-list-partitions.pl:78
29325 msgid "B<--connect URI> | B<-c URI>"
29329 #: ../tools/virt-edit.pl:123 ../tools/virt-win-reg.pl:130
29330 #: ../tools/virt-list-filesystems.pl:79 ../tools/virt-tar.pl:129
29331 #: ../tools/virt-list-partitions.pl:80
29333 "If using libvirt, connect to the given I<URI>. If omitted, then we connect "
29334 "to the default libvirt hypervisor."
29338 #: ../tools/virt-edit.pl:126 ../tools/virt-win-reg.pl:133
29339 #: ../tools/virt-list-filesystems.pl:82 ../tools/virt-tar.pl:132
29340 #: ../tools/virt-list-partitions.pl:83
29342 "If you specify guest block devices directly, then libvirt is not used at all."
29346 #: ../tools/virt-edit.pl:133 ../tools/virt-win-reg.pl:140
29347 #: ../tools/virt-list-filesystems.pl:89 ../tools/virt-tar.pl:139
29348 #: ../tools/virt-list-partitions.pl:90
29349 msgid "B<--format> raw"
29353 #: ../tools/virt-edit.pl:135 ../tools/virt-win-reg.pl:142
29354 #: ../tools/virt-list-filesystems.pl:91 ../tools/virt-tar.pl:141
29355 #: ../tools/virt-list-partitions.pl:92
29357 "Specify the format of disk images given on the command line. If this is "
29358 "omitted then the format is autodetected from the content of the disk image."
29362 #: ../tools/virt-edit.pl:139 ../tools/virt-win-reg.pl:146
29363 #: ../tools/virt-list-filesystems.pl:95 ../tools/virt-tar.pl:145
29364 #: ../tools/virt-list-partitions.pl:96
29366 "If disk images are requested from libvirt, then this program asks libvirt "
29367 "for this information. In this case, the value of the format parameter is "
29372 #: ../tools/virt-edit.pl:143 ../tools/virt-win-reg.pl:150
29373 #: ../tools/virt-list-filesystems.pl:99 ../tools/virt-tar.pl:149
29374 #: ../tools/virt-list-partitions.pl:100
29376 "If working with untrusted raw-format guest disk images, you should ensure "
29377 "the format is always specified."
29381 #: ../tools/virt-edit.pl:150
29382 msgid "B<--expr EXPR> | B<-e EXPR>"
29386 #: ../tools/virt-edit.pl:152
29388 "Instead of launching the external editor, non-interactively apply the Perl "
29389 "expression C<EXPR> to each line in the file. See L</NON-INTERACTIVE "
29394 #: ../tools/virt-edit.pl:156
29396 "Be careful to properly quote the expression to prevent it from being altered "
29401 #: ../tools/virt-edit.pl:280
29402 msgid "NON-INTERACTIVE EDITING"
29406 #: ../tools/virt-edit.pl:282
29408 "C<virt-edit> normally calls out to C<$EDITOR> (or vi) so the system "
29409 "administrator can interactively edit the file."
29413 #: ../tools/virt-edit.pl:285
29415 "There are two ways also to use C<virt-edit> from scripts in order to make "
29416 "automated edits to files. (Note that although you I<can> use C<virt-edit> "
29417 "like this, it's less error-prone to write scripts directly using the "
29418 "libguestfs API and Augeas for configuration file editing.)"
29422 #: ../tools/virt-edit.pl:291
29424 "The first method is to temporarily set C<$EDITOR> to any script or program "
29425 "you want to run. The script is invoked as C<$EDITOR tmpfile> and it should "
29426 "update C<tmpfile> in place however it likes."
29430 #: ../tools/virt-edit.pl:295
29432 "The second method is to use the I<-e> parameter of C<virt-edit> to run a "
29433 "short Perl snippet in the style of L<sed(1)>. For example to replace all "
29434 "instances of C<foo> with C<bar> in a file:"
29438 #: ../tools/virt-edit.pl:299
29441 " virt-edit domname filename -e 's/foo/bar/'\n"
29446 #: ../tools/virt-edit.pl:301
29448 "The full power of Perl regular expressions can be used (see L<perlre(1)>). "
29449 "For example to delete root's password you could do:"
29453 #: ../tools/virt-edit.pl:304
29456 " virt-edit domname /etc/passwd -e 's/^root:.*?:/root::/'\n"
29461 #: ../tools/virt-edit.pl:306
29463 "What really happens is that the snippet is evaluated as a Perl expression "
29464 "for each line of the file. The line, including the final C<\\n>, is passed "
29465 "in C<$_> and the expression should update C<$_> or leave it unchanged."
29469 #: ../tools/virt-edit.pl:311
29471 "To delete a line, set C<$_> to the empty string. For example, to delete the "
29472 "C<apache> user account from the password file you can do:"
29476 #: ../tools/virt-edit.pl:314
29479 " virt-edit mydomain /etc/passwd -e '$_ = \"\" if /^apache:/'\n"
29484 #: ../tools/virt-edit.pl:316
29486 "To insert a line, prepend or append it to C<$_>. However appending lines to "
29487 "the end of the file is rather difficult this way since there is no concept "
29488 "of \"last line of the file\" - your expression just doesn't get called "
29489 "again. You might want to use the first method (setting C<$EDITOR>) if you "
29494 #: ../tools/virt-edit.pl:322
29496 "The variable C<$lineno> contains the current line number. As is "
29497 "traditional, the first line in the file is number C<1>."
29501 #: ../tools/virt-edit.pl:325
29503 "The return value from the expression is ignored, but the expression may call "
29504 "C<die> in order to abort the whole program, leaving the original file "
29509 #: ../tools/virt-edit.pl:329
29511 "Remember when matching the end of a line that C<$_> may contain the final C<"
29512 "\\n>, or (for DOS files) C<\\r\\n>, or if the file does not end with a "
29513 "newline then neither of these. Thus to match or substitute some text at the "
29514 "end of a line, use this regular expression:"
29518 #: ../tools/virt-edit.pl:334
29521 " /some text(\\r?\\n)?$/\n"
29526 #: ../tools/virt-edit.pl:336
29528 "Alternately, use the perl C<chomp> function, being careful not to chomp C<"
29529 "$_> itself (since that would remove all newlines from the file):"
29533 #: ../tools/virt-edit.pl:340
29536 " my $m = $_; chomp $m; $m =~ /some text$/\n"
29541 #: ../tools/virt-edit.pl:344
29543 "C<virt-edit> has a limited ability to understand Windows drive letters and "
29544 "paths (eg. C<E:\\foo\\bar.txt>)."
29548 #: ../tools/virt-edit.pl:347
29549 msgid "If and only if the guest is running Windows then:"
29553 #: ../tools/virt-edit.pl:353
29555 "Drive letter prefixes like C<C:> are resolved against the Windows Registry "
29556 "to the correct filesystem."
29560 #: ../tools/virt-edit.pl:358
29562 "Any backslash (C<\\>) characters in the path are replaced with forward "
29563 "slashes so that libguestfs can process it."
29567 #: ../tools/virt-edit.pl:363
29569 "The path is resolved case insensitively to locate the file that should be "
29574 #: ../tools/virt-edit.pl:368
29575 msgid "There are some known shortcomings:"
29579 #: ../tools/virt-edit.pl:374
29580 msgid "Some NTFS symbolic links may not be followed correctly."
29584 #: ../tools/virt-edit.pl:378
29585 msgid "NTFS junction points that cross filesystems are not followed."
29589 #: ../tools/virt-edit.pl:435
29590 msgid "USING GUESTFISH"
29594 #: ../tools/virt-edit.pl:437
29596 "L<guestfish(1)> is a more powerful, lower level tool which you can use when "
29597 "C<virt-edit> doesn't work."
29601 #: ../tools/virt-edit.pl:440
29602 msgid "Using C<virt-edit> is approximately equivalent to doing:"
29606 #: ../tools/virt-edit.pl:442
29609 " guestfish --rw -i -d domname edit /file\n"
29614 #: ../tools/virt-edit.pl:444
29616 "where C<domname> is the name of the libvirt guest, and C</file> is the full "
29617 "path to the file."
29621 #: ../tools/virt-edit.pl:447
29623 "The command above uses libguestfs's guest inspection feature and so does not "
29624 "work on guests that libguestfs cannot inspect, or on things like arbitrary "
29625 "disk images that don't contain guests. To edit a file on a disk image "
29630 #: ../tools/virt-edit.pl:452
29633 " guestfish --rw -a disk.img -m /dev/sda1 edit /file\n"
29638 #: ../tools/virt-edit.pl:454
29640 "where C<disk.img> is the disk image, C</dev/sda1> is the filesystem within "
29641 "the disk image to edit, and C</file> is the full path to the file."
29645 #: ../tools/virt-edit.pl:458
29647 "C<virt-edit> cannot create new files. Use the guestfish commands C<touch>, "
29648 "C<write> or C<upload> instead:"
29652 #: ../tools/virt-edit.pl:461
29655 " guestfish --rw -i -d domname touch /newfile\n"
29660 #: ../tools/virt-edit.pl:463
29663 " guestfish --rw -i -d domname write /newfile \"new content\"\n"
29668 #: ../tools/virt-edit.pl:465
29671 " guestfish --rw -i -d domname upload localfile /newfile\n"
29676 #: ../tools/virt-edit.pl:467
29678 "C<virt-edit> cannot edit multiple files, but guestfish can do it like this:"
29682 #: ../tools/virt-edit.pl:470
29685 " guestfish --rw -i -d domname edit /file1 : edit /file2\n"
29690 #: ../tools/virt-edit.pl:480
29695 #: ../tools/virt-edit.pl:482
29697 "If set, this string is used as the editor. It may contain arguments, eg. C<"
29702 #: ../tools/virt-edit.pl:485
29703 msgid "If not set, C<vi> is used."
29707 #: ../tools/virt-edit.pl:489 ../tools/virt-win-reg.pl:559
29708 #: ../tools/virt-list-filesystems.pl:182 ../tools/virt-tar.pl:279
29709 #: ../tools/virt-make-fs.pl:532 ../tools/virt-list-partitions.pl:250
29710 msgid "SHELL QUOTING"
29714 #: ../tools/virt-edit.pl:491 ../tools/virt-win-reg.pl:567
29715 #: ../tools/virt-list-filesystems.pl:184 ../tools/virt-tar.pl:281
29716 #: ../tools/virt-make-fs.pl:534 ../tools/virt-list-partitions.pl:252
29718 "Libvirt guest names can contain arbitrary characters, some of which have "
29719 "meaning to the shell such as C<#> and space. You may need to quote or "
29720 "escape these characters on the command line. See the shell manual page L<sh"
29721 "(1)> for details."
29725 #: ../tools/virt-edit.pl:498
29727 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, L<virt-"
29728 "tar-in(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, "
29729 "L<http://libguestfs.org/>, L<perl(1)>, L<perlre(1)>."
29733 #: ../tools/virt-edit.pl:510 ../tools/virt-win-reg.pl:598
29734 #: ../tools/virt-list-filesystems.pl:202 ../tools/virt-tar.pl:301
29735 #: ../tools/virt-make-fs.pl:564 ../tools/virt-list-partitions.pl:269
29740 #: ../tools/virt-edit.pl:512 ../tools/virt-win-reg.pl:600
29741 #: ../tools/virt-list-filesystems.pl:204 ../tools/virt-tar.pl:303
29742 #: ../tools/virt-make-fs.pl:566 ../tools/virt-list-partitions.pl:271
29743 msgid "Richard W.M. Jones L<http://people.redhat.com/~rjones/>"
29747 #: ../tools/virt-edit.pl:516
29748 msgid "Copyright (C) 2009-2011 Red Hat Inc."
29752 #: ../tools/virt-win-reg.pl:37
29754 "virt-win-reg - Export and merge Windows Registry entries from a Windows guest"
29758 #: ../tools/virt-win-reg.pl:41
29761 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey'\n"
29766 #: ../tools/virt-win-reg.pl:43
29769 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' name\n"
29774 #: ../tools/virt-win-reg.pl:45
29777 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' @\n"
29782 #: ../tools/virt-win-reg.pl:47
29785 " virt-win-reg --merge domname [input.reg ...]\n"
29790 #: ../tools/virt-win-reg.pl:49
29793 " virt-win-reg [--options] disk.img ... # instead of domname\n"
29798 #: ../tools/virt-win-reg.pl:53
29800 "You must I<not> use C<virt-win-reg> with the I<--merge> option on live "
29801 "virtual machines. If you do this, you I<will> get irreversible disk "
29802 "corruption in the VM. C<virt-win-reg> tries to stop you from doing this, "
29803 "but doesn't catch all cases."
29807 #: ../tools/virt-win-reg.pl:58
29809 "Modifying the Windows Registry is an inherently risky operation. The format "
29810 "is deliberately obscure and undocumented, and Registry changes can leave the "
29811 "system unbootable. Therefore when using the I<--merge> option, make sure "
29812 "you have a reliable backup first."
29816 #: ../tools/virt-win-reg.pl:65
29818 "This program can export and merge Windows Registry entries from a Windows "
29823 #: ../tools/virt-win-reg.pl:68
29825 "The first parameter is the libvirt guest name or the raw disk image of a "
29830 #: ../tools/virt-win-reg.pl:71
29832 "If I<--merge> is I<not> specified, then the chosen registry key is displayed/"
29833 "exported (recursively). For example:"
29837 #: ../tools/virt-win-reg.pl:74
29840 " $ virt-win-reg Windows7 'HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft'\n"
29845 #: ../tools/virt-win-reg.pl:76
29847 "You can also display single values from within registry keys, for example:"
29851 #: ../tools/virt-win-reg.pl:79
29854 " $ cvkey='HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion'\n"
29855 " $ virt-win-reg Windows7 $cvkey ProductName\n"
29856 " Windows 7 Enterprise\n"
29861 #: ../tools/virt-win-reg.pl:83
29863 "With I<--merge>, you can merge a textual regedit file into the Windows "
29868 #: ../tools/virt-win-reg.pl:86
29871 " $ virt-win-reg --merge Windows7 changes.reg\n"
29876 #: ../tools/virt-win-reg.pl:88 ../tools/virt-tar.pl:45
29881 #: ../tools/virt-win-reg.pl:90
29883 "This program is only meant for simple access to the registry. If you want "
29884 "to do complicated things with the registry, we suggest you download the "
29885 "Registry hive files from the guest using L<libguestfs(3)> or L<guestfish(1)> "
29886 "and access them locally, eg. using L<hivex(3)>, L<hivexsh(1)> or "
29887 "L<hivexregedit(1)>."
29891 #: ../tools/virt-win-reg.pl:120 ../tools/virt-make-fs.pl:177
29896 #: ../tools/virt-win-reg.pl:122
29897 msgid "Enable debugging messages."
29901 #: ../tools/virt-win-reg.pl:157
29906 #: ../tools/virt-win-reg.pl:159
29908 "In merge mode, this merges a textual regedit file into the Windows Registry "
29909 "of the virtual machine. If this flag is I<not> given then virt-win-reg "
29910 "displays or exports Registry entries instead."
29914 #: ../tools/virt-win-reg.pl:163
29916 "Note that I<--merge> is I<unsafe> to use on live virtual machines, and will "
29917 "result in disk corruption. However exporting (without this flag) is always "
29922 #: ../tools/virt-win-reg.pl:171
29923 msgid "B<--encoding> UTF-16LE|ASCII"
29927 #: ../tools/virt-win-reg.pl:173
29929 "When merging (only), you may need to specify the encoding for strings to be "
29930 "used in the hive file. This is explained in detail in L<Win::Hivex::Regedit"
29931 "(3)/ENCODING STRINGS>."
29935 #: ../tools/virt-win-reg.pl:177
29937 "The default is to use UTF-16LE, which should work with recent versions of "
29942 #: ../tools/virt-win-reg.pl:402
29943 msgid "SUPPORTED SYSTEMS"
29947 #: ../tools/virt-win-reg.pl:404
29949 "The program currently supports Windows NT-derived guests starting with "
29950 "Windows XP through to at least Windows 7."
29954 #: ../tools/virt-win-reg.pl:407
29956 "Registry support is done for C<HKEY_LOCAL_MACHINE\\SAM>, C<HKEY_LOCAL_MACHINE"
29957 "\\SECURITY>, C<HKEY_LOCAL_MACHINE\\SOFTWARE>, C<HKEY_LOCAL_MACHINE\\SYSTEM> "
29958 "and C<HKEY_USERS\\.DEFAULT>."
29962 #: ../tools/virt-win-reg.pl:411
29964 "You can use C<HKLM> as a shorthand for C<HKEY_LOCAL_MACHINE>, and C<HKU> for "
29969 #: ../tools/virt-win-reg.pl:414
29971 "C<HKEY_USERS\\$SID> and C<HKEY_CURRENT_USER> are B<not> supported at this "
29976 #: ../tools/virt-win-reg.pl:417
29981 #: ../tools/virt-win-reg.pl:419
29983 "C<virt-win-reg> expects that regedit files have already been reencoded in "
29984 "the local encoding. Usually on Linux hosts, this means UTF-8 with Unix-"
29985 "style line endings. Since Windows regedit files are often in UTF-16LE with "
29986 "Windows-style line endings, you may need to reencode the whole file before "
29987 "or after processing."
29991 #: ../tools/virt-win-reg.pl:425
29993 "To reencode a file from Windows format to Linux (before processing it with "
29994 "the I<--merge> option), you would do something like this:"
29998 #: ../tools/virt-win-reg.pl:428
30001 " iconv -f utf-16le -t utf-8 < win.reg | dos2unix > linux.reg\n"
30006 #: ../tools/virt-win-reg.pl:430
30008 "To go in the opposite direction, after exporting and before sending the file "
30009 "to a Windows user, do something like this:"
30013 #: ../tools/virt-win-reg.pl:433
30016 " unix2dos linux.reg | iconv -f utf-8 -t utf-16le > win.reg\n"
30021 #: ../tools/virt-win-reg.pl:435
30022 msgid "For more information about encoding, see L<Win::Hivex::Regedit(3)>."
30026 #: ../tools/virt-win-reg.pl:437
30028 "If you are unsure about the current encoding, use the L<file(1)> command. "
30029 "Recent versions of Windows regedit.exe produce a UTF-16LE file with Windows-"
30030 "style (CRLF) line endings, like this:"
30034 #: ../tools/virt-win-reg.pl:441
30037 " $ file software.reg\n"
30038 " software.reg: Little-endian UTF-16 Unicode text, with very long lines,\n"
30039 " with CRLF line terminators\n"
30044 #: ../tools/virt-win-reg.pl:445
30045 msgid "This file would need conversion before you could I<--merge> it."
30049 #: ../tools/virt-win-reg.pl:447
30050 msgid "CurrentControlSet etc."
30054 #: ../tools/virt-win-reg.pl:449
30056 "Registry keys like C<CurrentControlSet> don't really exist in the Windows "
30057 "Registry at the level of the hive file, and therefore you cannot modify "
30062 #: ../tools/virt-win-reg.pl:453
30064 "C<CurrentControlSet> is usually an alias for C<ControlSet001>. In some "
30065 "circumstances it might refer to another control set. The way to find out is "
30066 "to look at the C<HKLM\\SYSTEM\\Select> key:"
30070 #: ../tools/virt-win-reg.pl:457
30073 " # virt-win-reg WindowsGuest 'HKLM\\SYSTEM\\Select'\n"
30074 " [HKEY_LOCAL_MACHINE\\SYSTEM\\Select]\n"
30075 " \"Current\"=dword:00000001\n"
30076 " \"Default\"=dword:00000001\n"
30077 " \"Failed\"=dword:00000000\n"
30078 " \"LastKnownGood\"=dword:00000002\n"
30083 #: ../tools/virt-win-reg.pl:464
30084 msgid "\"Current\" is the one which Windows will choose when it boots."
30088 #: ../tools/virt-win-reg.pl:466
30090 "Similarly, other C<Current...> keys in the path may need to be replaced."
30094 #: ../tools/virt-win-reg.pl:469
30095 msgid "WINDOWS TIPS"
30099 #: ../tools/virt-win-reg.pl:471
30101 "Note that some of these tips modify the guest disk image. The guest I<must> "
30102 "be shut off, else you will get disk corruption."
30106 #: ../tools/virt-win-reg.pl:474
30107 msgid "RUNNING A BATCH SCRIPT WHEN A USER LOGS IN"
30111 #: ../tools/virt-win-reg.pl:476
30113 "Prepare a DOS batch script, VBScript or executable. Upload this using "
30114 "L<guestfish(1)>. For this example the script is called C<test.bat> and it "
30115 "is uploaded into C<C:\\>:"
30119 #: ../tools/virt-win-reg.pl:480
30122 " guestfish -i -d WindowsGuest upload test.bat /test.bat\n"
30127 #: ../tools/virt-win-reg.pl:482
30128 msgid "Prepare a regedit file containing the registry change:"
30132 #: ../tools/virt-win-reg.pl:484
30135 " cat > test.reg <<'EOF'\n"
30136 " [HKLM\\Software\\Microsoft\\Windows\\CurrentVersion\\RunOnce]\n"
30137 " \"Test\"=\"c:\\\\test.bat\"\n"
30143 #: ../tools/virt-win-reg.pl:489
30145 "In this example we use the key C<RunOnce> which means that the script will "
30146 "run precisely once when the first user logs in. If you want it to run every "
30147 "time a user logs in, replace C<RunOnce> with C<Run>."
30151 #: ../tools/virt-win-reg.pl:493
30152 msgid "Now update the registry:"
30156 #: ../tools/virt-win-reg.pl:495
30159 " virt-win-reg --merge WindowsGuest test.reg\n"
30164 #: ../tools/virt-win-reg.pl:497
30165 msgid "INSTALLING A SERVICE"
30169 #: ../tools/virt-win-reg.pl:499
30171 "This section assumes you are familiar with Windows services, and you either "
30172 "have a program which handles the Windows Service Control Protocol directly "
30173 "or you want to run any program using a service wrapper like SrvAny or the "
30178 #: ../tools/virt-win-reg.pl:504
30180 "First upload the program and optionally the service wrapper. In this case "
30181 "the test program is called C<test.exe> and we are using the RHSrvAny wrapper:"
30185 #: ../tools/virt-win-reg.pl:508
30188 " guestfish -i -d WindowsGuest <<EOF\n"
30189 " upload rhsrvany.exe /rhsrvany.exe\n"
30190 " upload test.exe /test.exe\n"
30196 #: ../tools/virt-win-reg.pl:513
30198 "Prepare a regedit file containing the registry changes. In this example, "
30199 "the first registry change is needed for the service itself or the service "
30200 "wrapper (if used). The second registry change is only needed because I am "
30201 "using the RHSrvAny service wrapper."
30205 #: ../tools/virt-win-reg.pl:518
30208 " cat > service.reg <<'EOF'\n"
30209 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny]\n"
30210 " \"Type\"=dword:00000010\n"
30211 " \"Start\"=dword:00000002\n"
30212 " \"ErrorControl\"=dword:00000001\n"
30213 " \"ImagePath\"=\"c:\\\\rhsrvany.exe\"\n"
30214 " \"DisplayName\"=\"RHSrvAny\"\n"
30215 " \"ObjectName\"=\"NetworkService\"\n"
30220 #: ../tools/virt-win-reg.pl:527
30223 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny\\Parameters]\n"
30224 " \"CommandLine\"=\"c:\\\\test.exe\"\n"
30225 " \"PWD\"=\"c:\\\\Temp\"\n"
30231 #: ../tools/virt-win-reg.pl:538
30233 "For use of C<ControlSet001> see the section above in this manual page. You "
30234 "may need to adjust this according to the control set that is in use by the "
30239 #: ../tools/virt-win-reg.pl:544
30241 "C<\"ObjectName\"> controls the privileges that the service will have. An "
30242 "alternative is C<\"ObjectName\"=\"LocalSystem\"> which would be the most "
30243 "privileged account."
30247 #: ../tools/virt-win-reg.pl:550
30249 "For the meaning of the magic numbers, see this Microsoft KB article: "
30250 "L<http://support.microsoft.com/kb/103000>."
30254 #: ../tools/virt-win-reg.pl:555
30255 msgid "Update the registry:"
30259 #: ../tools/virt-win-reg.pl:557
30262 " virt-win-reg --merge WindowsGuest service.reg\n"
30267 #: ../tools/virt-win-reg.pl:561
30269 "Be careful when passing parameters containing C<\\> (backslash) in the "
30270 "shell. Usually you will have to use 'single quotes' or double backslashes "
30271 "(but not both) to protect them from the shell."
30275 #: ../tools/virt-win-reg.pl:565
30276 msgid "Paths and value names are case-insensitive."
30280 #: ../tools/virt-win-reg.pl:574
30282 "L<hivex(3)>, L<hivexsh(1)>, L<hivexregedit(1)>, L<guestfs(3)>, L<guestfish(1)"
30283 ">, L<virt-cat(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Win::Hivex"
30284 "(3)>, L<Win::Hivex::Regedit(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
30288 #: ../tools/virt-win-reg.pl:589 ../tools/virt-make-fs.pl:555
30290 "When reporting bugs, please enable debugging and capture the I<complete> "
30295 #: ../tools/virt-win-reg.pl:592
30298 " export LIBGUESTFS_DEBUG=1\n"
30299 " virt-win-reg --debug [... rest ...] > /tmp/virt-win-reg.log 2>&1\n"
30304 #: ../tools/virt-win-reg.pl:595
30306 "Attach /tmp/virt-win-reg.log to a new bug report at L<https://bugzilla."
30311 #: ../tools/virt-win-reg.pl:604 ../tools/virt-make-fs.pl:570
30312 msgid "Copyright (C) 2010 Red Hat Inc."
30316 #: ../tools/virt-list-filesystems.pl:32
30318 "virt-list-filesystems - List filesystems in a virtual machine or disk image"
30322 #: ../tools/virt-list-filesystems.pl:36
30325 " virt-list-filesystems [--options] domname\n"
30330 #: ../tools/virt-list-filesystems.pl:38
30333 " virt-list-filesystems [--options] disk.img [disk.img ...]\n"
30338 #: ../tools/virt-list-filesystems.pl:42 ../tools/virt-list-partitions.pl:42
30340 "This tool is obsolete. Use L<virt-filesystems(1)> as a more flexible "
30345 #: ../tools/virt-list-filesystems.pl:45
30347 "C<virt-list-filesystems> is a command line tool to list the filesystems that "
30348 "are contained in a virtual machine or disk image."
30352 #: ../tools/virt-list-filesystems.pl:49
30354 "C<virt-list-filesystems> is just a simple wrapper around L<libguestfs(3)> "
30355 "functionality. For more complex cases you should look at the L<guestfish(1)"
30360 #: ../tools/virt-list-filesystems.pl:106 ../tools/virt-list-partitions.pl:115
30361 msgid "B<-l> | B<--long>"
30365 #: ../tools/virt-list-filesystems.pl:108
30367 "With this option, C<virt-list-filesystems> displays the type of each "
30368 "filesystem too (where \"type\" means C<ext3>, C<xfs> etc.)"
30372 #: ../tools/virt-list-filesystems.pl:115
30373 msgid "B<-a> | B<--all>"
30377 #: ../tools/virt-list-filesystems.pl:117
30379 "Normally we only show mountable filesystems. If this option is given then "
30380 "swap devices are shown too."
30384 #: ../tools/virt-list-filesystems.pl:191
30386 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, L<virt-"
30387 "filesystems(1)>, L<virt-list-partitions(1)>, L<Sys::Guestfs(3)>, L<Sys::"
30388 "Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
30392 #: ../tools/virt-list-filesystems.pl:208 ../tools/virt-tar.pl:307
30393 msgid "Copyright (C) 2009 Red Hat Inc."
30397 #: ../tools/virt-tar.pl:33
30398 msgid "virt-tar - Extract or upload files to a virtual machine"
30402 #: ../tools/virt-tar.pl:37
30405 " virt-tar [--options] -x domname directory tarball\n"
30410 #: ../tools/virt-tar.pl:39
30413 " virt-tar [--options] -u domname tarball directory\n"
30418 #: ../tools/virt-tar.pl:41
30421 " virt-tar [--options] disk.img [disk.img ...] -x directory tarball\n"
30426 #: ../tools/virt-tar.pl:43
30429 " virt-tar [--options] disk.img [disk.img ...] -u tarball directory\n"
30434 #: ../tools/virt-tar.pl:47
30436 "This tool is obsolete. Use L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-"
30437 "tar-in(1)>, L<virt-tar-out(1)> as replacements."
30441 #: ../tools/virt-tar.pl:52
30442 msgid "Download C</home> from the VM into a local tarball:"
30446 #: ../tools/virt-tar.pl:54
30449 " virt-tar -x domname /home home.tar\n"
30454 #: ../tools/virt-tar.pl:56
30457 " virt-tar -zx domname /home home.tar.gz\n"
30462 #: ../tools/virt-tar.pl:58
30463 msgid "Upload a local tarball and unpack it inside C</tmp> in the VM:"
30467 #: ../tools/virt-tar.pl:60
30470 " virt-tar -u domname uploadstuff.tar /tmp\n"
30475 #: ../tools/virt-tar.pl:62
30478 " virt-tar -zu domname uploadstuff.tar.gz /tmp\n"
30483 #: ../tools/virt-tar.pl:66
30485 "You must I<not> use C<virt-tar> with the I<-u> option (upload) on live "
30486 "virtual machines. If you do this, you risk disk corruption in the VM. "
30487 "C<virt-tar> tries to stop you from doing this, but doesn't catch all cases."
30491 #: ../tools/virt-tar.pl:71
30493 "You can use I<-x> (extract) on live virtual machines, but you might get "
30494 "inconsistent results or errors if there is filesystem activity inside the "
30495 "VM. If the live VM is synched and quiescent, then C<virt-tar> will usually "
30496 "work, but the only way to guarantee consistent results is if the virtual "
30497 "machine is shut down."
30501 #: ../tools/virt-tar.pl:79
30503 "C<virt-tar> is a general purpose archive tool for downloading and uploading "
30504 "parts of a guest filesystem. There are many possibilities: making backups, "
30505 "uploading data files, snooping on guest activity, fixing or customizing "
30510 #: ../tools/virt-tar.pl:84
30512 "If you want to just view a single file, use L<virt-cat(1)>. If you just "
30513 "want to edit a single file, use L<virt-edit(1)>. For more complex cases you "
30514 "should look at the L<guestfish(1)> tool."
30518 #: ../tools/virt-tar.pl:88
30520 "There are two modes of operation: I<-x> (eXtract) downloads a directory and "
30521 "its contents (recursively) from the virtual machine into a local tarball. "
30522 "I<-u> uploads from a local tarball, unpacking it into a directory inside the "
30523 "virtual machine. You cannot use these two options together."
30527 #: ../tools/virt-tar.pl:94
30529 "In addition, you may need to use the I<-z> (gZip) option to enable "
30530 "compression. When uploading, you have to specify I<-z> if the upload file "
30531 "is compressed because virt-tar won't detect this on its own."
30535 #: ../tools/virt-tar.pl:98
30537 "C<virt-tar> can only handle tar (optionally gzipped) format tarballs. For "
30538 "example it cannot do PKZip files or bzip2 compression. If you want that "
30539 "then you'll have to rebuild the tarballs yourself. (This is a limitation of "
30540 "the L<libguestfs(3)> API)."
30544 #: ../tools/virt-tar.pl:156
30545 msgid "B<-x> | B<--extract> | B<--download>"
30549 #: ../tools/virt-tar.pl:158
30550 msgid "B<-u> | B<--upload>"
30554 #: ../tools/virt-tar.pl:160
30556 "Use I<-x> to extract (download) a directory from a virtual machine to a "
30561 #: ../tools/virt-tar.pl:163
30563 "Use I<-u> to upload and unpack from a local tarball into a virtual machine. "
30564 "Please read the L</WARNING> section above before using this option."
30568 #: ../tools/virt-tar.pl:167
30569 msgid "You must specify exactly one of these options."
30573 #: ../tools/virt-tar.pl:173
30574 msgid "B<-z> | B<--gzip>"
30578 #: ../tools/virt-tar.pl:175
30579 msgid "Specify that the input or output tarball is gzip-compressed."
30583 #: ../tools/virt-tar.pl:288
30585 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, L<virt-copy-"
30586 "in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<Sys::"
30587 "Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs."
30592 #: ../tools/virt-make-fs.pl:37
30593 msgid "virt-make-fs - Make a filesystem from a tar archive or files"
30597 #: ../tools/virt-make-fs.pl:41
30600 " virt-make-fs [--options] input.tar output.img\n"
30605 #: ../tools/virt-make-fs.pl:43
30608 " virt-make-fs [--options] input.tar.gz output.img\n"
30613 #: ../tools/virt-make-fs.pl:45
30616 " virt-make-fs [--options] directory output.img\n"
30621 #: ../tools/virt-make-fs.pl:49
30623 "Virt-make-fs is a command line tool for creating a filesystem from a tar "
30624 "archive or some files in a directory. It is similar to tools like L<mkisofs"
30625 "(1)>, L<genisoimage(1)> and L<mksquashfs(1)>. Unlike those tools, it can "
30626 "create common filesystem types like ext2/3 or NTFS, which can be useful if "
30627 "you want to attach these filesystems to existing virtual machines (eg. to "
30628 "import large amounts of read-only data to a VM)."
30632 #: ../tools/virt-make-fs.pl:57
30633 msgid "Basic usage is:"
30637 #: ../tools/virt-make-fs.pl:59
30640 " virt-make-fs input output\n"
30645 #: ../tools/virt-make-fs.pl:61
30647 "where C<input> is either a directory containing files that you want to add, "
30648 "or a tar archive (either uncompressed tar or gzip-compressed tar); and "
30649 "C<output> is a disk image. The input type is detected automatically. The "
30650 "output disk image defaults to a raw ext2 image unless you specify extra "
30651 "flags (see L</OPTIONS> below)."
30655 #: ../tools/virt-make-fs.pl:67
30656 msgid "EXTRA SPACE"
30660 #: ../tools/virt-make-fs.pl:69
30662 "Unlike formats such as tar and squashfs, a filesystem does not \"just fit\" "
30663 "the files that it contains, but might have extra space. Depending on how "
30664 "you are going to use the output, you might think this extra space is wasted "
30665 "and want to minimize it, or you might want to leave space so that more files "
30666 "can be added later. Virt-make-fs defaults to minimizing the extra space, "
30667 "but you can use the I<--size> flag to leave space in the filesystem if you "
30672 #: ../tools/virt-make-fs.pl:77
30674 "An alternative way to leave extra space but not make the output image any "
30675 "bigger is to use an alternative disk image format (instead of the default "
30676 "\"raw\" format). Using I<--format=qcow2> will use the native QEmu/KVM qcow2 "
30677 "image format (check your hypervisor supports this before using it). This "
30678 "allows you to choose a large I<--size> but the extra space won't actually be "
30679 "allocated in the image until you try to store something in it."
30683 #: ../tools/virt-make-fs.pl:85
30685 "Don't forget that you can also use local commands including L<resize2fs(8)> "
30686 "and L<virt-resize(1)> to resize existing filesystems, or rerun virt-make-fs "
30687 "to build another image from scratch."
30691 #: ../tools/virt-make-fs.pl:89 ../tools/virt-make-fs.pl:123
30692 #: ../tools/virt-make-fs.pl:142
30697 #: ../tools/virt-make-fs.pl:91
30700 " virt-make-fs --format=qcow2 --size=+200M input output.img\n"
30705 #: ../tools/virt-make-fs.pl:93
30706 msgid "FILESYSTEM TYPE"
30710 #: ../tools/virt-make-fs.pl:95
30712 "The default filesystem type is C<ext2>. Just about any filesystem type that "
30713 "libguestfs supports can be used (but I<not> read-only formats like "
30714 "ISO9660). Here are some of the more common choices:"
30718 #: ../tools/virt-make-fs.pl:101
30723 #: ../tools/virt-make-fs.pl:103
30725 "Note that ext3 filesystems contain a journal, typically 1-32 MB in size. If "
30726 "you are not going to use the filesystem in a way that requires the journal, "
30727 "then this is just wasted overhead."
30731 #: ../tools/virt-make-fs.pl:107
30732 msgid "I<ntfs> or I<vfat>"
30736 #: ../tools/virt-make-fs.pl:109
30737 msgid "Useful if exporting data to a Windows guest."
30741 #: ../tools/virt-make-fs.pl:111
30743 "I<Note for vfat>: The tar archive or local directory must only contain files "
30744 "which are owned by root (ie. UID:GID = 0:0). The reason is that the tar "
30745 "program running within libguestfs is unable to change the ownership of non-"
30746 "root files, since vfat itself does not support this."
30750 #: ../tools/virt-make-fs.pl:116
30755 #: ../tools/virt-make-fs.pl:118
30757 "Lower overhead than C<ext2>, but certain limitations on filename length and "
30758 "total filesystem size."
30762 #: ../tools/virt-make-fs.pl:125
30765 " virt-make-fs --type=minix input minixfs.img\n"
30770 #: ../tools/virt-make-fs.pl:127
30771 msgid "TO PARTITION OR NOT TO PARTITION"
30775 #: ../tools/virt-make-fs.pl:129
30776 msgid "Optionally virt-make-fs can add a partition table to the output disk."
30780 #: ../tools/virt-make-fs.pl:131
30782 "Adding a partition can make the disk image more compatible with certain "
30783 "virtualized operating systems which don't expect to see a filesystem "
30784 "directly located on a block device (Linux doesn't care and will happily "
30785 "handle both types)."
30789 #: ../tools/virt-make-fs.pl:136
30791 "On the other hand, if you have a partition table then the output image is no "
30792 "longer a straight filesystem. For example you cannot run L<fsck(8)> "
30793 "directly on a partitioned disk image. (However libguestfs tools such as "
30794 "L<guestfish(1)> and L<virt-resize(1)> can still be used)."
30798 #: ../tools/virt-make-fs.pl:144
30799 msgid "Add an MBR partition:"
30803 #: ../tools/virt-make-fs.pl:146
30806 " virt-make-fs --partition -- input disk.img\n"
30811 #: ../tools/virt-make-fs.pl:148
30813 "If the output disk image could be terabyte-sized or larger, it's better to "
30814 "use an EFI/GPT-compatible partition table:"
30818 #: ../tools/virt-make-fs.pl:151
30821 " virt-make-fs --partition=gpt --size=+4T --format=qcow2 input disk.img\n"
30826 #: ../tools/virt-make-fs.pl:179
30827 msgid "Enable debugging information."
30831 #: ../tools/virt-make-fs.pl:185
30832 msgid "B<--size=E<lt>NE<gt>>"
30836 #: ../tools/virt-make-fs.pl:187
30837 msgid "B<--size=+E<lt>NE<gt>>"
30841 #: ../tools/virt-make-fs.pl:189
30842 msgid "B<-s E<lt>NE<gt>>"
30846 #: ../tools/virt-make-fs.pl:191
30847 msgid "B<-s +E<lt>NE<gt>>"
30851 #: ../tools/virt-make-fs.pl:193
30853 "Use the I<--size> (or I<-s>) option to choose the size of the output image."
30857 #: ../tools/virt-make-fs.pl:196
30859 "If this option is I<not> given, then the output image will be just large "
30860 "enough to contain all the files, with not much wasted space."
30864 #: ../tools/virt-make-fs.pl:199
30866 "To choose a fixed size output disk, specify an absolute number followed by b/"
30867 "K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
30868 "Petabytes or Exabytes. This must be large enough to contain all the input "
30869 "files, else you will get an error."
30873 #: ../tools/virt-make-fs.pl:204
30875 "To leave extra space, specify C<+> (plus sign) and a number followed by b/K/"
30876 "M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
30877 "Petabytes or Exabytes. For example: I<--size=+200M> means enough space for "
30878 "the input files, and (approximately) an extra 200 MB free space."
30882 #: ../tools/virt-make-fs.pl:210
30884 "Note that virt-make-fs estimates free space, and therefore will not produce "
30885 "filesystems containing precisely the free space requested. (It is much more "
30886 "expensive and time-consuming to produce a filesystem which has precisely the "
30887 "desired free space)."
30891 #: ../tools/virt-make-fs.pl:219
30892 msgid "B<--format=E<lt>fmtE<gt>>"
30896 #: ../tools/virt-make-fs.pl:221
30897 msgid "B<-F E<lt>fmtE<gt>>"
30901 #: ../tools/virt-make-fs.pl:223
30902 msgid "Choose the output disk image format."
30906 #: ../tools/virt-make-fs.pl:225
30907 msgid "The default is C<raw> (raw disk image)."
30911 #: ../tools/virt-make-fs.pl:227
30913 "For other choices, see the L<qemu-img(1)> manpage. The only other choice "
30914 "that would really make sense here is C<qcow2>."
30918 #: ../tools/virt-make-fs.pl:234
30919 msgid "B<--type=E<lt>fsE<gt>>"
30923 #: ../tools/virt-make-fs.pl:236
30924 msgid "B<-t E<lt>fsE<gt>>"
30928 #: ../tools/virt-make-fs.pl:238
30929 msgid "Choose the output filesystem type."
30933 #: ../tools/virt-make-fs.pl:240
30934 msgid "The default is C<ext2>."
30938 #: ../tools/virt-make-fs.pl:242
30940 "Any filesystem which is supported read-write by libguestfs can be used here."
30944 #: ../tools/virt-make-fs.pl:249
30945 msgid "B<--partition>"
30949 #: ../tools/virt-make-fs.pl:251
30950 msgid "B<--partition=E<lt>parttypeE<gt>>"
30954 #: ../tools/virt-make-fs.pl:253
30956 "If specified, this flag adds an MBR partition table to the output disk image."
30960 #: ../tools/virt-make-fs.pl:256
30962 "You can change the partition table type, eg. I<--partition=gpt> for large "
30967 #: ../tools/virt-make-fs.pl:259
30969 "Note that if you just use a lonesome I<--partition>, the Perl option parser "
30970 "might consider the next parameter to be the partition type. For example:"
30974 #: ../tools/virt-make-fs.pl:263
30977 " virt-make-fs --partition input.tar ...\n"
30982 #: ../tools/virt-make-fs.pl:265
30984 "would cause virt-make-fs to think you wanted to use a partition type of "
30985 "C<input.tar> which is completely wrong. To avoid this, use I<--> (a double "
30986 "dash) between options and the input file argument:"
30990 #: ../tools/virt-make-fs.pl:269
30993 " virt-make-fs --partition -- input.tar ...\n"
30998 #: ../tools/virt-make-fs.pl:541
31000 "L<guestfish(1)>, L<virt-resize(1)>, L<virt-tar-in(1)>, L<mkisofs(1)>, "
31001 "L<genisoimage(1)>, L<mksquashfs(1)>, L<mke2fs(8)>, L<resize2fs(8)>, L<guestfs"
31002 "(3)>, L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
31006 #: ../tools/virt-make-fs.pl:558
31009 " export LIBGUESTFS_DEBUG=1\n"
31010 " virt-make-fs --debug [...] > /tmp/virt-make-fs.log 2>&1\n"
31015 #: ../tools/virt-make-fs.pl:561
31017 "Attach /tmp/virt-make-fs.log to a new bug report at L<https://bugzilla."
31022 #: ../tools/virt-list-partitions.pl:32
31024 "virt-list-partitions - List partitions in a virtual machine or disk image"
31028 #: ../tools/virt-list-partitions.pl:36
31031 " virt-list-partitions [--options] domname\n"
31036 #: ../tools/virt-list-partitions.pl:38
31039 " virt-list-partitions [--options] disk.img [disk.img ...]\n"
31044 #: ../tools/virt-list-partitions.pl:45
31046 "C<virt-list-partitions> is a command line tool to list the partitions that "
31047 "are contained in a virtual machine or disk image. It is mainly useful as a "
31048 "first step to using L<virt-resize(1)>."
31052 #: ../tools/virt-list-partitions.pl:50
31054 "C<virt-list-partitions> is just a simple wrapper around L<libguestfs(3)> "
31055 "functionality. For more complex cases you should look at the L<guestfish(1)"
31060 #: ../tools/virt-list-partitions.pl:107
31061 msgid "B<-h> | B<--human-readable>"
31065 #: ../tools/virt-list-partitions.pl:109
31066 msgid "Show sizes in human-readable form (eg. \"1G\")."
31070 #: ../tools/virt-list-partitions.pl:117
31072 "With this option, C<virt-list-partitions> displays the type and size of each "
31073 "partition too (where \"type\" means C<ext3>, C<pv> etc.)"
31077 #: ../tools/virt-list-partitions.pl:124
31078 msgid "B<-t> | B<--total>"
31082 #: ../tools/virt-list-partitions.pl:126
31084 "Display the total size of each block device (as a separate row or rows)."
31088 #: ../tools/virt-list-partitions.pl:259
31090 "L<guestfs(3)>, L<guestfish(1)>, L<virt-filesystems(1)>, L<virt-list-"
31091 "filesystems(1)>, L<virt-resize(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib"
31092 "(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
31096 #: ../tools/virt-list-partitions.pl:275
31097 msgid "Copyright (C) 2009-2010 Red Hat Inc."