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-08-17 13: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 #: ../fish/guestfish.pod:443 ../fish/guestfish.pod:447
881 #: ../fish/guestfish.pod:451 ../fish/guestfish.pod:455
882 #: ../fish/guestfish-actions.pod:13 ../fish/guestfish-actions.pod:20
883 #: ../fish/guestfish-actions.pod:385 ../fish/guestfish-actions.pod:393
884 #: ../fish/guestfish-actions.pod:400 ../fish/guestfish-actions.pod:407
885 #: ../fish/guestfish-actions.pod:1074 ../fish/guestfish-actions.pod:1078
886 #: ../fish/guestfish-actions.pod:1082 ../fish/guestfish-actions.pod:1086
887 #: ../fish/guestfish-actions.pod:1094 ../fish/guestfish-actions.pod:1098
888 #: ../fish/guestfish-actions.pod:1102 ../fish/guestfish-actions.pod:1112
889 #: ../fish/guestfish-actions.pod:1116 ../fish/guestfish-actions.pod:1120
890 #: ../fish/guestfish-actions.pod:1210 ../fish/guestfish-actions.pod:1214
891 #: ../fish/guestfish-actions.pod:1219 ../fish/guestfish-actions.pod:1224
892 #: ../fish/guestfish-actions.pod:1266 ../fish/guestfish-actions.pod:1270
893 #: ../fish/guestfish-actions.pod:1275 ../tools/virt-edit.pl:351
894 #: ../tools/virt-edit.pl:356 ../tools/virt-edit.pl:361
895 #: ../tools/virt-edit.pl:372 ../tools/virt-edit.pl:376
896 #: ../tools/virt-win-reg.pl:536 ../tools/virt-win-reg.pl:542
897 #: ../tools/virt-win-reg.pl:548
902 #: ../src/guestfs.pod:390
904 "The kernel version that the command runs under will be different from what "
909 #: ../src/guestfs.pod:395
911 "If the command needs to communicate with daemons, then most likely they "
916 #: ../src/guestfs.pod:400
917 msgid "The command will be running in limited memory."
921 #: ../src/guestfs.pod:404
923 "The network may not be available unless you enable it (see L</"
924 "guestfs_set_network>)."
928 #: ../src/guestfs.pod:409
929 msgid "Only supports Linux guests (not Windows, BSD, etc)."
933 #: ../src/guestfs.pod:413
935 "Architecture limitations (eg. won't work for a PPC guest on an X86 host)."
939 #: ../src/guestfs.pod:418
941 "For SELinux guests, you may need to enable SELinux and load policy first. "
942 "See L</SELINUX> in this manpage."
946 #: ../src/guestfs.pod:423
948 "I<Security:> It is not safe to run commands from untrusted, possibly "
949 "malicious guests. These commands may attempt to exploit your program by "
950 "sending unexpected output. They could also try to exploit the Linux kernel "
951 "or qemu provided by the libguestfs appliance. They could use the network "
952 "provided by the libguestfs appliance to bypass ordinary network partitions "
953 "and firewalls. They could use the elevated privileges or different SELinux "
954 "context of your program to their advantage."
958 #: ../src/guestfs.pod:432
960 "A secure alternative is to use libguestfs to install a \"firstboot\" script "
961 "(a script which runs when the guest next boots normally), and to have this "
962 "script run the commands you want in the normal context of the running guest, "
963 "network security and so on. For information about other security issues, "
968 #: ../src/guestfs.pod:440
970 "The two main API calls to run commands are L</guestfs_command> and L</"
971 "guestfs_sh> (there are also variations)."
975 #: ../src/guestfs.pod:443
977 "The difference is that L</guestfs_sh> runs commands using the shell, so any "
978 "shell globs, redirections, etc will work."
982 #: ../src/guestfs.pod:446
983 msgid "CONFIGURATION FILES"
984 msgstr "ФАЙЛИ НАЛАШТУВАННЯ"
987 #: ../src/guestfs.pod:448
989 "To read and write configuration files in Linux guest filesystems, we "
990 "strongly recommend using Augeas. For example, Augeas understands how to "
991 "read and write, say, a Linux shadow password file or X.org configuration "
992 "file, and so avoids you having to write that code."
996 #: ../src/guestfs.pod:453
998 "The main Augeas calls are bound through the C<guestfs_aug_*> APIs. We don't "
999 "document Augeas itself here because there is excellent documentation on the "
1000 "L<http://augeas.net/> website."
1004 #: ../src/guestfs.pod:457
1006 "If you don't want to use Augeas (you fool!) then try calling L</"
1007 "guestfs_read_lines> to get the file as a list of lines which you can iterate "
1012 #: ../src/guestfs.pod:461
1017 #: ../src/guestfs.pod:463
1019 "We support SELinux guests. To ensure that labeling happens correctly in "
1020 "SELinux guests, you need to enable SELinux and load the guest's policy:"
1024 #: ../src/guestfs.pod:469 ../src/guestfs.pod:1257 ../src/guestfs.pod:1395
1025 #: ../src/guestfs.pod:2425
1030 #: ../src/guestfs.pod:471
1031 msgid "Before launching, do:"
1035 #: ../src/guestfs.pod:473
1038 " guestfs_set_selinux (g, 1);\n"
1043 #: ../src/guestfs.pod:475 ../src/guestfs.pod:1261 ../src/guestfs.pod:1399
1044 #: ../src/guestfs.pod:2450
1049 #: ../src/guestfs.pod:477
1051 "After mounting the guest's filesystem(s), load the policy. This is best "
1052 "done by running the L<load_policy(8)> command in the guest itself:"
1056 #: ../src/guestfs.pod:481
1059 " guestfs_sh (g, \"/usr/sbin/load_policy\");\n"
1064 #: ../src/guestfs.pod:483
1066 "(Older versions of C<load_policy> require you to specify the name of the "
1071 #: ../src/guestfs.pod:486 ../src/guestfs.pod:1405
1076 #: ../src/guestfs.pod:488
1078 "Optionally, set the security context for the API. The correct security "
1079 "context to use can only be known by inspecting the guest. As an example:"
1083 #: ../src/guestfs.pod:492
1086 " guestfs_setcon (g, \"unconfined_u:unconfined_r:unconfined_t:s0\");\n"
1091 #: ../src/guestfs.pod:496
1092 msgid "This will work for running commands and editing existing files."
1096 #: ../src/guestfs.pod:498
1098 "When new files are created, you may need to label them explicitly, for "
1099 "example by running the external command C<restorecon pathname>."
1103 #: ../src/guestfs.pod:502
1108 #: ../src/guestfs.pod:504
1110 "Certain calls are affected by the current file mode creation mask (the "
1111 "\"umask\"). In particular ones which create files or directories, such as "
1112 "L</guestfs_touch>, L</guestfs_mknod> or L</guestfs_mkdir>. This affects "
1113 "either the default mode that the file is created with or modifies the mode "
1118 #: ../src/guestfs.pod:510
1120 "The default umask is C<022>, so files are created with modes such as C<0644> "
1121 "and directories with C<0755>."
1125 #: ../src/guestfs.pod:513
1127 "There are two ways to avoid being affected by umask. Either set umask to 0 "
1128 "(call C<guestfs_umask (g, 0)> early after launching). Or call L</"
1129 "guestfs_chmod> after creating each file or directory."
1133 #: ../src/guestfs.pod:517
1134 msgid "For more information about umask, see L<umask(2)>."
1138 #: ../src/guestfs.pod:519 ../fish/guestfish.pod:765
1139 msgid "ENCRYPTED DISKS"
1143 #: ../src/guestfs.pod:521
1145 "Libguestfs allows you to access Linux guests which have been encrypted using "
1146 "whole disk encryption that conforms to the Linux Unified Key Setup (LUKS) "
1147 "standard. This includes nearly all whole disk encryption systems used by "
1148 "modern Linux guests."
1152 #: ../src/guestfs.pod:527
1154 "Use L</guestfs_vfs_type> to identify LUKS-encrypted block devices (it "
1155 "returns the string C<crypto_LUKS>)."
1159 #: ../src/guestfs.pod:530
1161 "Then open these devices by calling L</guestfs_luks_open>. Obviously you "
1162 "will require the passphrase!"
1166 #: ../src/guestfs.pod:533
1168 "Opening a LUKS device creates a new device mapper device called C</dev/"
1169 "mapper/mapname> (where C<mapname> is the string you supply to L</"
1170 "guestfs_luks_open>). Reads and writes to this mapper device are decrypted "
1171 "from and encrypted to the underlying block device respectively."
1175 #: ../src/guestfs.pod:539
1177 "LVM volume groups on the device can be made visible by calling L</"
1178 "guestfs_vgscan> followed by L</guestfs_vg_activate_all>. The logical volume"
1179 "(s) can now be mounted in the usual way."
1183 #: ../src/guestfs.pod:543
1185 "Use the reverse process to close a LUKS device. Unmount any logical volumes "
1186 "on it, deactivate the volume groups by caling C<guestfs_vg_activate (g, 0, "
1187 "[\"/dev/VG\"])>. Then close the mapper device by calling L</"
1188 "guestfs_luks_close> on the C</dev/mapper/mapname> device (I<not> the "
1189 "underlying encrypted block device)."
1193 #: ../src/guestfs.pod:550
1198 #: ../src/guestfs.pod:552
1200 "Libguestfs has APIs for inspecting an unknown disk image to find out if it "
1201 "contains operating systems, an install CD or a live CD. (These APIs used to "
1202 "be in a separate Perl-only library called L<Sys::Guestfs::Lib(3)> but since "
1203 "version 1.5.3 the most frequently used part of this library has been "
1204 "rewritten in C and moved into the core code)."
1208 #: ../src/guestfs.pod:559
1210 "Add all disks belonging to the unknown virtual machine and call L</"
1211 "guestfs_launch> in the usual way."
1215 #: ../src/guestfs.pod:562
1217 "Then call L</guestfs_inspect_os>. This function uses other libguestfs calls "
1218 "and certain heuristics, and returns a list of operating systems that were "
1219 "found. An empty list means none were found. A single element is the root "
1220 "filesystem of the operating system. For dual- or multi-boot guests, "
1221 "multiple roots can be returned, each one corresponding to a separate "
1222 "operating system. (Multi-boot virtual machines are extremely rare in the "
1223 "world of virtualization, but since this scenario can happen, we have built "
1224 "libguestfs to deal with it.)"
1228 #: ../src/guestfs.pod:571
1230 "For each root, you can then call various C<guestfs_inspect_get_*> functions "
1231 "to get additional details about that operating system. For example, call L</"
1232 "guestfs_inspect_get_type> to return the string C<windows> or C<linux> for "
1233 "Windows and Linux-based operating systems respectively."
1237 #: ../src/guestfs.pod:577
1239 "Un*x-like and Linux-based operating systems usually consist of several "
1240 "filesystems which are mounted at boot time (for example, a separate boot "
1241 "partition mounted on C</boot>). The inspection rules are able to detect how "
1242 "filesystems correspond to mount points. Call "
1243 "C<guestfs_inspect_get_mountpoints> to get this mapping. It might return a "
1244 "hash table like this example:"
1248 #: ../src/guestfs.pod:584
1251 " /boot => /dev/sda1\n"
1252 " / => /dev/vg_guest/lv_root\n"
1253 " /usr => /dev/vg_guest/lv_usr\n"
1258 #: ../src/guestfs.pod:588
1260 "The caller can then make calls to L</guestfs_mount_options> to mount the "
1261 "filesystems as suggested."
1265 #: ../src/guestfs.pod:591
1267 "Be careful to mount filesystems in the right order (eg. C</> before C</"
1268 "usr>). Sorting the keys of the hash by length, shortest first, should work."
1272 #: ../src/guestfs.pod:595
1274 "Inspection currently only works for some common operating systems. "
1275 "Contributors are welcome to send patches for other operating systems that we "
1276 "currently cannot detect."
1280 #: ../src/guestfs.pod:599
1282 "Encrypted disks must be opened before inspection. See L</ENCRYPTED DISKS> "
1283 "for more details. The L</guestfs_inspect_os> function just ignores any "
1284 "encrypted devices."
1288 #: ../src/guestfs.pod:603
1290 "A note on the implementation: The call L</guestfs_inspect_os> performs "
1291 "inspection and caches the results in the guest handle. Subsequent calls to "
1292 "C<guestfs_inspect_get_*> return this cached information, but I<do not> re-"
1293 "read the disks. If you change the content of the guest disks, you can redo "
1294 "inspection by calling L</guestfs_inspect_os> again. (L</"
1295 "guestfs_inspect_list_applications> works a little differently from the other "
1296 "calls and does read the disks. See documentation for that function for "
1301 #: ../src/guestfs.pod:612
1302 msgid "INSPECTING INSTALL DISKS"
1306 #: ../src/guestfs.pod:614
1308 "Libguestfs (since 1.9.4) can detect some install disks, install CDs, live "
1313 #: ../src/guestfs.pod:617
1315 "Call L</guestfs_inspect_get_format> to return the format of the operating "
1316 "system, which currently can be C<installed> (a regular operating system) or "
1317 "C<installer> (some sort of install disk)."
1321 #: ../src/guestfs.pod:621
1323 "Further information is available about the operating system that can be "
1324 "installed using the regular inspection APIs like L</"
1325 "guestfs_inspect_get_product_name>, L</guestfs_inspect_get_major_version> etc."
1329 #: ../src/guestfs.pod:626
1331 "Some additional information specific to installer disks is also available "
1332 "from the L</guestfs_inspect_is_live>, L</guestfs_inspect_is_netinst> and L</"
1333 "guestfs_inspect_is_multipart> calls."
1337 #: ../src/guestfs.pod:631
1338 msgid "SPECIAL CONSIDERATIONS FOR WINDOWS GUESTS"
1342 #: ../src/guestfs.pod:633
1344 "Libguestfs can mount NTFS partitions. It does this using the L<http://www."
1345 "ntfs-3g.org/> driver."
1349 #: ../src/guestfs.pod:636
1350 msgid "DRIVE LETTERS AND PATHS"
1354 #: ../src/guestfs.pod:638
1356 "DOS and Windows still use drive letters, and the filesystems are always "
1357 "treated as case insensitive by Windows itself, and therefore you might find "
1358 "a Windows configuration file referring to a path like C<c:\\windows"
1359 "\\system32>. When the filesystem is mounted in libguestfs, that directory "
1360 "might be referred to as C</WINDOWS/System32>."
1364 #: ../src/guestfs.pod:644
1366 "Drive letter mappings can be found using inspection (see L</INSPECTION> and "
1367 "L</guestfs_inspect_get_drive_mappings>)"
1371 #: ../src/guestfs.pod:647
1373 "Dealing with separator characters (backslash vs forward slash) is outside "
1374 "the scope of libguestfs, but usually a simple character replacement will "
1379 #: ../src/guestfs.pod:651
1381 "To resolve the case insensitivity of paths, call L</"
1382 "guestfs_case_sensitive_path>."
1386 #: ../src/guestfs.pod:654
1387 msgid "ACCESSING THE WINDOWS REGISTRY"
1391 #: ../src/guestfs.pod:656
1393 "Libguestfs also provides some help for decoding Windows Registry \"hive\" "
1394 "files, through the library C<hivex> which is part of the libguestfs project "
1395 "although ships as a separate tarball. You have to locate and download the "
1396 "hive file(s) yourself, and then pass them to C<hivex> functions. See also "
1397 "the programs L<hivexml(1)>, L<hivexsh(1)>, L<hivexregedit(1)> and L<virt-win-"
1398 "reg(1)> for more help on this issue."
1402 #: ../src/guestfs.pod:664
1403 msgid "SYMLINKS ON NTFS-3G FILESYSTEMS"
1407 #: ../src/guestfs.pod:666
1409 "Ntfs-3g tries to rewrite \"Junction Points\" and NTFS \"symbolic links\" to "
1410 "provide something which looks like a Linux symlink. The way it tries to do "
1411 "the rewriting is described here:"
1415 #: ../src/guestfs.pod:670
1417 "L<http://www.tuxera.com/community/ntfs-3g-advanced/junction-points-and-"
1420 "L<http://www.tuxera.com/community/ntfs-3g-advanced/junction-points-and-"
1424 #: ../src/guestfs.pod:672
1426 "The essential problem is that ntfs-3g simply does not have enough "
1427 "information to do a correct job. NTFS links can contain drive letters and "
1428 "references to external device GUIDs that ntfs-3g has no way of resolving. "
1429 "It is almost certainly the case that libguestfs callers should ignore what "
1430 "ntfs-3g does (ie. don't use L</guestfs_readlink> on NTFS volumes)."
1434 #: ../src/guestfs.pod:679
1436 "Instead if you encounter a symbolic link on an ntfs-3g filesystem, use L</"
1437 "guestfs_lgetxattr> to read the C<system.ntfs_reparse_data> extended "
1438 "attribute, and read the raw reparse data from that (you can find the format "
1439 "documented in various places around the web)."
1443 #: ../src/guestfs.pod:684
1444 msgid "EXTENDED ATTRIBUTES ON NTFS-3G FILESYSTEMS"
1448 #: ../src/guestfs.pod:686
1450 "There are other useful extended attributes that can be read from ntfs-3g "
1451 "filesystems (using L</guestfs_getxattr>). See:"
1455 #: ../src/guestfs.pod:689
1457 "L<http://www.tuxera.com/community/ntfs-3g-advanced/extended-attributes/>"
1459 "L<http://www.tuxera.com/community/ntfs-3g-advanced/extended-attributes/>"
1462 #: ../src/guestfs.pod:691
1463 msgid "USING LIBGUESTFS WITH OTHER PROGRAMMING LANGUAGES"
1467 #: ../src/guestfs.pod:693
1469 "Although we don't want to discourage you from using the C API, we will "
1470 "mention here that the same API is also available in other languages."
1474 #: ../src/guestfs.pod:696
1476 "The API is broadly identical in all supported languages. This means that "
1477 "the C call C<guestfs_add_drive_ro(g,file)> is C<$g-E<gt>add_drive_ro($file)> "
1478 "in Perl, C<g.add_drive_ro(file)> in Python, and C<g#add_drive_ro file> in "
1479 "OCaml. In other words, a straightforward, predictable isomorphism between "
1484 #: ../src/guestfs.pod:702
1486 "Error messages are automatically transformed into exceptions if the language "
1491 #: ../src/guestfs.pod:705
1493 "We don't try to \"object orientify\" parts of the API in OO languages, "
1494 "although contributors are welcome to write higher level APIs above what we "
1495 "provide in their favourite languages if they wish."
1499 #: ../src/guestfs.pod:711
1504 #: ../src/guestfs.pod:713
1506 "You can use the I<guestfs.h> header file from C++ programs. The C++ API is "
1507 "identical to the C API. C++ classes and exceptions are not used."
1511 #: ../src/guestfs.pod:717
1516 #: ../src/guestfs.pod:719
1518 "The C# bindings are highly experimental. Please read the warnings at the "
1519 "top of C<csharp/Libguestfs.cs>."
1523 #: ../src/guestfs.pod:722
1528 #: ../src/guestfs.pod:724
1530 "This is the only language binding that is working but incomplete. Only "
1531 "calls which return simple integers have been bound in Haskell, and we are "
1532 "looking for help to complete this binding."
1536 #: ../src/guestfs.pod:728
1541 #: ../src/guestfs.pod:730
1543 "Full documentation is contained in the Javadoc which is distributed with "
1548 #: ../src/guestfs.pod:733
1553 #: ../src/guestfs.pod:735
1554 msgid "See L<guestfs-ocaml(3)>."
1555 msgstr "Див. L<guestfs-ocaml(3)>."
1558 #: ../src/guestfs.pod:737
1563 #: ../src/guestfs.pod:739
1564 msgid "See L<guestfs-perl(3)> and L<Sys::Guestfs(3)>."
1565 msgstr "Див. L<guestfs-perl(3)> та L<Sys::Guestfs(3)>."
1568 #: ../src/guestfs.pod:741
1573 #: ../src/guestfs.pod:743
1575 "For documentation see C<README-PHP> supplied with libguestfs sources or in "
1576 "the php-libguestfs package for your distribution."
1580 #: ../src/guestfs.pod:746
1581 msgid "The PHP binding only works correctly on 64 bit machines."
1585 #: ../src/guestfs.pod:748
1590 #: ../src/guestfs.pod:750
1591 msgid "See L<guestfs-python(3)>."
1592 msgstr "Див. L<guestfs-python(3)>."
1595 #: ../src/guestfs.pod:752
1600 #: ../src/guestfs.pod:754
1601 msgid "See L<guestfs-ruby(3)>."
1602 msgstr "Див. L<guestfs-ruby(3)>."
1605 #: ../src/guestfs.pod:756
1606 msgid "B<shell scripts>"
1607 msgstr "B<скрипти оболонки>"
1610 #: ../src/guestfs.pod:758
1611 msgid "See L<guestfish(1)>."
1612 msgstr "Див. L<guestfish(1)>."
1615 #: ../src/guestfs.pod:762
1616 msgid "LIBGUESTFS GOTCHAS"
1620 #: ../src/guestfs.pod:764
1622 "L<http://en.wikipedia.org/wiki/Gotcha_(programming)>: \"A feature of a "
1623 "system [...] that works in the way it is documented but is counterintuitive "
1624 "and almost invites mistakes.\""
1628 #: ../src/guestfs.pod:768
1630 "Since we developed libguestfs and the associated tools, there are several "
1631 "things we would have designed differently, but are now stuck with for "
1632 "backwards compatibility or other reasons. If there is ever a libguestfs 2.0 "
1633 "release, you can expect these to change. Beware of them."
1637 #: ../src/guestfs.pod:776
1638 msgid "Autosync / forgetting to sync."
1642 #: ../src/guestfs.pod:778
1644 "I<Update:> Autosync is enabled by default for all API users starting from "
1645 "libguestfs 1.5.24. This section only applies to older versions."
1649 #: ../src/guestfs.pod:781
1651 "When modifying a filesystem from C or another language, you B<must> unmount "
1652 "all filesystems and call L</guestfs_sync> explicitly before you close the "
1653 "libguestfs handle. You can also call:"
1657 #: ../src/guestfs.pod:785
1660 " guestfs_set_autosync (g, 1);\n"
1665 #: ../src/guestfs.pod:787
1667 "to have the unmount/sync done automatically for you when the handle 'g' is "
1668 "closed. (This feature is called \"autosync\", L</guestfs_set_autosync> q.v.)"
1672 #: ../src/guestfs.pod:791
1674 "If you forget to do this, then it is entirely possible that your changes "
1675 "won't be written out, or will be partially written, or (very rarely) that "
1676 "you'll get disk corruption."
1680 #: ../src/guestfs.pod:795
1682 "Note that in L<guestfish(3)> autosync is the default. So quick and dirty "
1683 "guestfish scripts that forget to sync will work just fine, which can make "
1684 "this very puzzling if you are trying to debug a problem."
1688 #: ../src/guestfs.pod:799
1689 msgid "Mount option C<-o sync> should not be the default."
1693 #: ../src/guestfs.pod:801
1695 "If you use L</guestfs_mount>, then C<-o sync,noatime> are added implicitly. "
1696 "However C<-o sync> does not add any reliability benefit, but does have a "
1697 "very large performance impact."
1701 #: ../src/guestfs.pod:805
1703 "The work around is to use L</guestfs_mount_options> and set the mount "
1704 "options that you actually want to use."
1708 #: ../src/guestfs.pod:808
1709 msgid "Read-only should be the default."
1713 #: ../src/guestfs.pod:810
1715 "In L<guestfish(3)>, I<--ro> should be the default, and you should have to "
1716 "specify I<--rw> if you want to make changes to the image."
1720 #: ../src/guestfs.pod:813
1721 msgid "This would reduce the potential to corrupt live VM images."
1725 #: ../src/guestfs.pod:815
1727 "Note that many filesystems change the disk when you just mount and unmount, "
1728 "even if you didn't perform any writes. You need to use L</"
1729 "guestfs_add_drive_ro> to guarantee that the disk is not changed."
1733 #: ../src/guestfs.pod:819
1734 msgid "guestfish command line is hard to use."
1738 #: ../src/guestfs.pod:821
1740 "C<guestfish disk.img> doesn't do what people expect (open C<disk.img> for "
1741 "examination). It tries to run a guestfish command C<disk.img> which doesn't "
1742 "exist, so it fails. In earlier versions of guestfish the error message was "
1743 "also unintuitive, but we have corrected this since. Like the Bourne shell, "
1744 "we should have used C<guestfish -c command> to run commands."
1748 #: ../src/guestfs.pod:828
1749 msgid "guestfish megabyte modifiers don't work right on all commands"
1753 #: ../src/guestfs.pod:830
1755 "In recent guestfish you can use C<1M> to mean 1 megabyte (and similarly for "
1756 "other modifiers). What guestfish actually does is to multiply the number "
1757 "part by the modifier part and pass the result to the C API. However this "
1758 "doesn't work for a few APIs which aren't expecting bytes, but are already "
1759 "expecting some other unit (eg. megabytes)."
1763 #: ../src/guestfs.pod:837
1764 msgid "The most common is L</guestfs_lvcreate>. The guestfish command:"
1768 #: ../src/guestfs.pod:839
1771 " lvcreate LV VG 100M\n"
1776 #: ../src/guestfs.pod:841
1778 "does not do what you might expect. Instead because L</guestfs_lvcreate> is "
1779 "already expecting megabytes, this tries to create a 100 I<terabyte> (100 "
1780 "megabytes * megabytes) logical volume. The error message you get from this "
1781 "is also a little obscure."
1785 #: ../src/guestfs.pod:846
1787 "This could be fixed in the generator by specially marking parameters and "
1788 "return values which take bytes or other units."
1792 #: ../src/guestfs.pod:849
1793 msgid "Ambiguity between devices and paths"
1797 #: ../src/guestfs.pod:851
1799 "There is a subtle ambiguity in the API between a device name (eg. C</dev/"
1800 "sdb2>) and a similar pathname. A file might just happen to be called "
1801 "C<sdb2> in the directory C</dev> (consider some non-Unix VM image)."
1805 #: ../src/guestfs.pod:856
1807 "In the current API we usually resolve this ambiguity by having two separate "
1808 "calls, for example L</guestfs_checksum> and L</guestfs_checksum_device>. "
1809 "Some API calls are ambiguous and (incorrectly) resolve the problem by "
1810 "detecting if the path supplied begins with C</dev/>."
1814 #: ../src/guestfs.pod:862
1816 "To avoid both the ambiguity and the need to duplicate some calls, we could "
1817 "make paths/devices into structured names. One way to do this would be to "
1818 "use a notation like grub (C<hd(0,0)>), although nobody really likes this "
1819 "aspect of grub. Another way would be to use a structured type, equivalent "
1820 "to this OCaml type:"
1824 #: ../src/guestfs.pod:868
1827 " type path = Path of string | Device of int | Partition of int * int\n"
1832 #: ../src/guestfs.pod:870
1833 msgid "which would allow you to pass arguments like:"
1837 #: ../src/guestfs.pod:872
1840 " Path \"/foo/bar\"\n"
1841 " Device 1 (* /dev/sdb, or perhaps /dev/sda *)\n"
1842 " Partition (1, 2) (* /dev/sdb2 (or is it /dev/sda2 or /dev/sdb3?) *)\n"
1843 " Path \"/dev/sdb2\" (* not a device *)\n"
1848 #: ../src/guestfs.pod:877
1850 "As you can see there are still problems to resolve even with this "
1851 "representation. Also consider how it might work in guestfish."
1855 #: ../src/guestfs.pod:882
1856 msgid "KEYS AND PASSPHRASES"
1860 #: ../src/guestfs.pod:884
1862 "Certain libguestfs calls take a parameter that contains sensitive key "
1863 "material, passed in as a C string."
1867 #: ../src/guestfs.pod:887
1869 "In the future we would hope to change the libguestfs implementation so that "
1870 "keys are L<mlock(2)>-ed into physical RAM, and thus can never end up in "
1871 "swap. However this is I<not> done at the moment, because of the complexity "
1872 "of such an implementation."
1876 #: ../src/guestfs.pod:892
1878 "Therefore you should be aware that any key parameter you pass to libguestfs "
1879 "might end up being written out to the swap partition. If this is a concern, "
1880 "scrub the swap partition or don't use libguestfs on encrypted devices."
1884 #: ../src/guestfs.pod:897
1885 msgid "MULTIPLE HANDLES AND MULTIPLE THREADS"
1889 #: ../src/guestfs.pod:899
1891 "All high-level libguestfs actions are synchronous. If you want to use "
1892 "libguestfs asynchronously then you must create a thread."
1896 #: ../src/guestfs.pod:902
1898 "Only use the handle from a single thread. Either use the handle exclusively "
1899 "from one thread, or provide your own mutex so that two threads cannot issue "
1900 "calls on the same handle at the same time."
1904 #: ../src/guestfs.pod:906
1906 "See the graphical program guestfs-browser for one possible architecture for "
1907 "multithreaded programs using libvirt and libguestfs."
1911 #: ../src/guestfs.pod:909
1916 #: ../src/guestfs.pod:911
1918 "Libguestfs needs a supermin appliance, which it finds by looking along an "
1923 #: ../src/guestfs.pod:914
1925 "By default it looks for these in the directory C<$libdir/guestfs> (eg. C</"
1926 "usr/local/lib/guestfs> or C</usr/lib64/guestfs>)."
1930 #: ../src/guestfs.pod:917
1932 "Use L</guestfs_set_path> or set the environment variable L</LIBGUESTFS_PATH> "
1933 "to change the directories that libguestfs will search in. The value is a "
1934 "colon-separated list of paths. The current directory is I<not> searched "
1935 "unless the path contains an empty element or C<.>. For example "
1936 "C<LIBGUESTFS_PATH=:/usr/lib/guestfs> would search the current directory and "
1937 "then C</usr/lib/guestfs>."
1941 #: ../src/guestfs.pod:924
1942 msgid "QEMU WRAPPERS"
1946 #: ../src/guestfs.pod:926
1948 "If you want to compile your own qemu, run qemu from a non-standard location, "
1949 "or pass extra arguments to qemu, then you can write a shell-script wrapper "
1954 #: ../src/guestfs.pod:930
1956 "There is one important rule to remember: you I<must C<exec qemu>> as the "
1957 "last command in the shell script (so that qemu replaces the shell and "
1958 "becomes the direct child of the libguestfs-using program). If you don't do "
1959 "this, then the qemu process won't be cleaned up correctly."
1963 #: ../src/guestfs.pod:935
1965 "Here is an example of a wrapper, where I have built my own copy of qemu from "
1970 #: ../src/guestfs.pod:938
1974 " qemudir=/home/rjones/d/qemu\n"
1975 " exec $qemudir/x86_64-softmmu/qemu-system-x86_64 -L $qemudir/pc-bios \"$@\"\n"
1980 #: ../src/guestfs.pod:942
1982 "Save this script as C</tmp/qemu.wrapper> (or wherever), C<chmod +x>, and "
1983 "then use it by setting the LIBGUESTFS_QEMU environment variable. For "
1988 #: ../src/guestfs.pod:946
1991 " LIBGUESTFS_QEMU=/tmp/qemu.wrapper guestfish\n"
1996 #: ../src/guestfs.pod:948
1998 "Note that libguestfs also calls qemu with the -help and -version options in "
1999 "order to determine features."
2003 #: ../src/guestfs.pod:951
2004 msgid "ATTACHING TO RUNNING DAEMONS"
2008 #: ../src/guestfs.pod:953
2010 "I<Note (1):> This is B<highly experimental> and has a tendency to eat "
2011 "babies. Use with caution."
2015 #: ../src/guestfs.pod:956
2017 "I<Note (2):> This section explains how to attach to a running daemon from a "
2018 "low level perspective. For most users, simply using virt tools such as "
2019 "L<guestfish(1)> with the I<--live> option will \"just work\"."
2023 #: ../src/guestfs.pod:960
2024 msgid "Using guestfs_set_attach_method"
2028 #: ../src/guestfs.pod:962
2030 "By calling L</guestfs_set_attach_method> you can change how the library "
2031 "connects to the C<guestfsd> daemon in L</guestfs_launch> (read L</"
2032 "ARCHITECTURE> for some background)."
2036 #: ../src/guestfs.pod:966
2038 "The normal attach method is C<appliance>, where a small appliance is created "
2039 "containing the daemon, and then the library connects to this."
2043 #: ../src/guestfs.pod:969
2045 "Setting attach method to C<unix:I<path>> (where I<path> is the path of a "
2046 "Unix domain socket) causes L</guestfs_launch> to connect to an existing "
2047 "daemon over the Unix domain socket."
2051 #: ../src/guestfs.pod:973
2053 "The normal use for this is to connect to a running virtual machine that "
2054 "contains a C<guestfsd> daemon, and send commands so you can read and write "
2055 "files inside the live virtual machine."
2059 #: ../src/guestfs.pod:977
2060 msgid "Using guestfs_add_domain with live flag"
2064 #: ../src/guestfs.pod:979
2066 "L</guestfs_add_domain> provides some help for getting the correct attach "
2067 "method. If you pass the C<live> option to this function, then (if the "
2068 "virtual machine is running) it will examine the libvirt XML looking for a "
2069 "virtio-serial channel to connect to:"
2073 #: ../src/guestfs.pod:985
2080 " <channel type='unix'>\n"
2081 " <source mode='bind' path='/path/to/socket'/>\n"
2082 " <target type='virtio' name='org.libguestfs.channel.0'/>\n"
2091 #: ../src/guestfs.pod:997
2093 "L</guestfs_add_domain> extracts C</path/to/socket> and sets the attach "
2094 "method to C<unix:/path/to/socket>."
2098 #: ../src/guestfs.pod:1000
2100 "Some of the libguestfs tools (including guestfish) support a I<--live> "
2101 "option which is passed through to L</guestfs_add_domain> thus allowing you "
2102 "to attach to and modify live virtual machines."
2106 #: ../src/guestfs.pod:1004
2108 "The virtual machine needs to have been set up beforehand so that it has the "
2109 "virtio-serial channel and so that guestfsd is running inside it."
2113 #: ../src/guestfs.pod:1008
2114 msgid "ABI GUARANTEE"
2118 #: ../src/guestfs.pod:1010
2120 "We guarantee the libguestfs ABI (binary interface), for public, high-level "
2121 "actions as outlined in this section. Although we will deprecate some "
2122 "actions, for example if they get replaced by newer calls, we will keep the "
2123 "old actions forever. This allows you the developer to program in confidence "
2124 "against the libguestfs API."
2128 #: ../src/guestfs.pod:1016
2129 msgid "BLOCK DEVICE NAMING"
2133 #: ../src/guestfs.pod:1018
2135 "In the kernel there is now quite a profusion of schemata for naming block "
2136 "devices (in this context, by I<block device> I mean a physical or virtual "
2137 "hard drive). The original Linux IDE driver used names starting with C</dev/"
2138 "hd*>. SCSI devices have historically used a different naming scheme, C</dev/"
2139 "sd*>. When the Linux kernel I<libata> driver became a popular replacement "
2140 "for the old IDE driver (particularly for SATA devices) those devices also "
2141 "used the C</dev/sd*> scheme. Additionally we now have virtual machines with "
2142 "paravirtualized drivers. This has created several different naming systems, "
2143 "such as C</dev/vd*> for virtio disks and C</dev/xvd*> for Xen PV disks."
2147 #: ../src/guestfs.pod:1030
2149 "As discussed above, libguestfs uses a qemu appliance running an embedded "
2150 "Linux kernel to access block devices. We can run a variety of appliances "
2151 "based on a variety of Linux kernels."
2155 #: ../src/guestfs.pod:1034
2157 "This causes a problem for libguestfs because many API calls use device or "
2158 "partition names. Working scripts and the recipe (example) scripts that we "
2159 "make available over the internet could fail if the naming scheme changes."
2163 #: ../src/guestfs.pod:1039
2165 "Therefore libguestfs defines C</dev/sd*> as the I<standard naming scheme>. "
2166 "Internally C</dev/sd*> names are translated, if necessary, to other names as "
2167 "required. For example, under RHEL 5 which uses the C</dev/hd*> scheme, any "
2168 "device parameter C</dev/sda2> is translated to C</dev/hda2> transparently."
2172 #: ../src/guestfs.pod:1045
2174 "Note that this I<only> applies to parameters. The L</guestfs_list_devices>, "
2175 "L</guestfs_list_partitions> and similar calls return the true names of the "
2176 "devices and partitions as known to the appliance."
2180 #: ../src/guestfs.pod:1050
2181 msgid "ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION"
2185 #: ../src/guestfs.pod:1052
2187 "Usually this translation is transparent. However in some (very rare) cases "
2188 "you may need to know the exact algorithm. Such cases include where you use "
2189 "L</guestfs_config> to add a mixture of virtio and IDE devices to the qemu-"
2190 "based appliance, so have a mixture of C</dev/sd*> and C</dev/vd*> devices."
2194 #: ../src/guestfs.pod:1058
2196 "The algorithm is applied only to I<parameters> which are known to be either "
2197 "device or partition names. Return values from functions such as L</"
2198 "guestfs_list_devices> are never changed."
2202 #: ../src/guestfs.pod:1066
2203 msgid "Is the string a parameter which is a device or partition name?"
2207 #: ../src/guestfs.pod:1070
2208 msgid "Does the string begin with C</dev/sd>?"
2212 #: ../src/guestfs.pod:1074
2214 "Does the named device exist? If so, we use that device. However if I<not> "
2215 "then we continue with this algorithm."
2219 #: ../src/guestfs.pod:1079
2220 msgid "Replace initial C</dev/sd> string with C</dev/hd>."
2224 #: ../src/guestfs.pod:1081
2225 msgid "For example, change C</dev/sda2> to C</dev/hda2>."
2229 #: ../src/guestfs.pod:1083
2230 msgid "If that named device exists, use it. If not, continue."
2234 #: ../src/guestfs.pod:1087
2235 msgid "Replace initial C</dev/sd> string with C</dev/vd>."
2239 #: ../src/guestfs.pod:1089
2240 msgid "If that named device exists, use it. If not, return an error."
2244 #: ../src/guestfs.pod:1093
2245 msgid "PORTABILITY CONCERNS WITH BLOCK DEVICE NAMING"
2249 #: ../src/guestfs.pod:1095
2251 "Although the standard naming scheme and automatic translation is useful for "
2252 "simple programs and guestfish scripts, for larger programs it is best not to "
2253 "rely on this mechanism."
2257 #: ../src/guestfs.pod:1099
2259 "Where possible for maximum future portability programs using libguestfs "
2260 "should use these future-proof techniques:"
2264 #: ../src/guestfs.pod:1106
2266 "Use L</guestfs_list_devices> or L</guestfs_list_partitions> to list actual "
2267 "device names, and then use those names directly."
2271 #: ../src/guestfs.pod:1109
2273 "Since those device names exist by definition, they will never be translated."
2277 #: ../src/guestfs.pod:1114
2279 "Use higher level ways to identify filesystems, such as LVM names, UUIDs and "
2280 "filesystem labels."
2284 #: ../src/guestfs.pod:1119
2289 #: ../src/guestfs.pod:1121
2291 "This section discusses security implications of using libguestfs, "
2292 "particularly with untrusted or malicious guests or disk images."
2296 #: ../src/guestfs.pod:1124
2297 msgid "GENERAL SECURITY CONSIDERATIONS"
2301 #: ../src/guestfs.pod:1126
2303 "Be careful with any files or data that you download from a guest (by "
2304 "\"download\" we mean not just the L</guestfs_download> command but any "
2305 "command that reads files, filenames, directories or anything else from a "
2306 "disk image). An attacker could manipulate the data to fool your program "
2307 "into doing the wrong thing. Consider cases such as:"
2311 #: ../src/guestfs.pod:1136
2312 msgid "the data (file etc) not being present"
2316 #: ../src/guestfs.pod:1140
2317 msgid "being present but empty"
2321 #: ../src/guestfs.pod:1144
2322 msgid "being much larger than normal"
2326 #: ../src/guestfs.pod:1148
2327 msgid "containing arbitrary 8 bit data"
2331 #: ../src/guestfs.pod:1152
2332 msgid "being in an unexpected character encoding"
2336 #: ../src/guestfs.pod:1156
2337 msgid "containing homoglyphs."
2341 #: ../src/guestfs.pod:1160
2342 msgid "SECURITY OF MOUNTING FILESYSTEMS"
2346 #: ../src/guestfs.pod:1162
2348 "When you mount a filesystem under Linux, mistakes in the kernel filesystem "
2349 "(VFS) module can sometimes be escalated into exploits by deliberately "
2350 "creating a malicious, malformed filesystem. These exploits are very severe "
2351 "for two reasons. Firstly there are very many filesystem drivers in the "
2352 "kernel, and many of them are infrequently used and not much developer "
2353 "attention has been paid to the code. Linux userspace helps potential "
2354 "crackers by detecting the filesystem type and automatically choosing the "
2355 "right VFS driver, even if that filesystem type is obscure or unexpected for "
2356 "the administrator. Secondly, a kernel-level exploit is like a local root "
2357 "exploit (worse in some ways), giving immediate and total access to the "
2358 "system right down to the hardware level."
2362 #: ../src/guestfs.pod:1175
2364 "That explains why you should never mount a filesystem from an untrusted "
2365 "guest on your host kernel. How about libguestfs? We run a Linux kernel "
2366 "inside a qemu virtual machine, usually running as a non-root user. The "
2367 "attacker would need to write a filesystem which first exploited the kernel, "
2368 "and then exploited either qemu virtualization (eg. a faulty qemu driver) or "
2369 "the libguestfs protocol, and finally to be as serious as the host kernel "
2370 "exploit it would need to escalate its privileges to root. This multi-step "
2371 "escalation, performed by a static piece of data, is thought to be extremely "
2372 "hard to do, although we never say 'never' about security issues."
2376 #: ../src/guestfs.pod:1186
2378 "In any case callers can reduce the attack surface by forcing the filesystem "
2379 "type when mounting (use L</guestfs_mount_vfs>)."
2383 #: ../src/guestfs.pod:1189
2384 msgid "PROTOCOL SECURITY"
2388 #: ../src/guestfs.pod:1191
2390 "The protocol is designed to be secure, being based on RFC 4506 (XDR) with a "
2391 "defined upper message size. However a program that uses libguestfs must "
2392 "also take care - for example you can write a program that downloads a binary "
2393 "from a disk image and executes it locally, and no amount of protocol "
2394 "security will save you from the consequences."
2398 #: ../src/guestfs.pod:1197
2399 msgid "INSPECTION SECURITY"
2403 #: ../src/guestfs.pod:1199
2405 "Parts of the inspection API (see L</INSPECTION>) return untrusted strings "
2406 "directly from the guest, and these could contain any 8 bit data. Callers "
2407 "should be careful to escape these before printing them to a structured file "
2408 "(for example, use HTML escaping if creating a web page)."
2412 #: ../src/guestfs.pod:1205
2414 "Guest configuration may be altered in unusual ways by the administrator of "
2415 "the virtual machine, and may not reflect reality (particularly for untrusted "
2416 "or actively malicious guests). For example we parse the hostname from "
2417 "configuration files like C</etc/sysconfig/network> that we find in the "
2418 "guest, but the guest administrator can easily manipulate these files to "
2419 "provide the wrong hostname."
2423 #: ../src/guestfs.pod:1213
2425 "The inspection API parses guest configuration using two external libraries: "
2426 "Augeas (Linux configuration) and hivex (Windows Registry). Both are "
2427 "designed to be robust in the face of malicious data, although denial of "
2428 "service attacks are still possible, for example with oversized configuration "
2433 #: ../src/guestfs.pod:1219
2434 msgid "RUNNING UNTRUSTED GUEST COMMANDS"
2438 #: ../src/guestfs.pod:1221
2440 "Be very cautious about running commands from the guest. By running a "
2441 "command in the guest, you are giving CPU time to a binary that you do not "
2442 "control, under the same user account as the library, albeit wrapped in qemu "
2443 "virtualization. More information and alternatives can be found in the "
2444 "section L</RUNNING COMMANDS>."
2448 #: ../src/guestfs.pod:1227
2449 msgid "CVE-2010-3851"
2450 msgstr "CVE-2010-3851"
2453 #: ../src/guestfs.pod:1229
2454 msgid "https://bugzilla.redhat.com/642934"
2455 msgstr "https://bugzilla.redhat.com/642934"
2458 #: ../src/guestfs.pod:1231
2460 "This security bug concerns the automatic disk format detection that qemu "
2461 "does on disk images."
2465 #: ../src/guestfs.pod:1234
2467 "A raw disk image is just the raw bytes, there is no header. Other disk "
2468 "images like qcow2 contain a special header. Qemu deals with this by looking "
2469 "for one of the known headers, and if none is found then assuming the disk "
2470 "image must be raw."
2474 #: ../src/guestfs.pod:1239
2476 "This allows a guest which has been given a raw disk image to write some "
2477 "other header. At next boot (or when the disk image is accessed by "
2478 "libguestfs) qemu would do autodetection and think the disk image format was, "
2479 "say, qcow2 based on the header written by the guest."
2483 #: ../src/guestfs.pod:1244
2485 "This in itself would not be a problem, but qcow2 offers many features, one "
2486 "of which is to allow a disk image to refer to another image (called the "
2487 "\"backing disk\"). It does this by placing the path to the backing disk "
2488 "into the qcow2 header. This path is not validated and could point to any "
2489 "host file (eg. \"/etc/passwd\"). The backing disk is then exposed through "
2490 "\"holes\" in the qcow2 disk image, which of course is completely under the "
2491 "control of the attacker."
2495 #: ../src/guestfs.pod:1252
2497 "In libguestfs this is rather hard to exploit except under two circumstances:"
2501 #: ../src/guestfs.pod:1259
2502 msgid "You have enabled the network or have opened the disk in write mode."
2506 #: ../src/guestfs.pod:1263
2508 "You are also running untrusted code from the guest (see L</RUNNING "
2513 #: ../src/guestfs.pod:1268
2515 "The way to avoid this is to specify the expected disk format when adding "
2516 "disks (the optional C<format> option to L</guestfs_add_drive_opts>). You "
2517 "should always do this if the disk is raw format, and it's a good idea for "
2522 #: ../src/guestfs.pod:1273
2524 "For disks added from libvirt using calls like L</guestfs_add_domain>, the "
2525 "format is fetched from libvirt and passed through."
2529 #: ../src/guestfs.pod:1276
2531 "For libguestfs tools, use the I<--format> command line parameter as "
2536 #: ../src/guestfs.pod:1279
2537 msgid "CONNECTION MANAGEMENT"
2541 #: ../src/guestfs.pod:1281
2546 #: ../src/guestfs.pod:1283
2548 "C<guestfs_h> is the opaque type representing a connection handle. Create a "
2549 "handle by calling L</guestfs_create>. Call L</guestfs_close> to free the "
2550 "handle and release all resources used."
2554 #: ../src/guestfs.pod:1287
2556 "For information on using multiple handles and threads, see the section L</"
2557 "MULTIPLE HANDLES AND MULTIPLE THREADS> above."
2561 #: ../src/guestfs.pod:1290
2562 msgid "guestfs_create"
2566 #: ../src/guestfs.pod:1292
2569 " guestfs_h *guestfs_create (void);\n"
2574 #: ../src/guestfs.pod:1294
2575 msgid "Create a connection handle."
2579 #: ../src/guestfs.pod:1296
2581 "On success this returns a non-NULL pointer to a handle. On error it returns "
2586 #: ../src/guestfs.pod:1299
2588 "You have to \"configure\" the handle after creating it. This includes "
2589 "calling L</guestfs_add_drive_opts> (or one of the equivalent calls) on the "
2590 "handle at least once."
2594 #: ../src/guestfs.pod:1303
2595 msgid "After configuring the handle, you have to call L</guestfs_launch>."
2599 #: ../src/guestfs.pod:1305
2601 "You may also want to configure error handling for the handle. See the L</"
2602 "ERROR HANDLING> section below."
2606 #: ../src/guestfs.pod:1308
2607 msgid "guestfs_close"
2611 #: ../src/guestfs.pod:1310
2614 " void guestfs_close (guestfs_h *g);\n"
2619 #: ../src/guestfs.pod:1312
2620 msgid "This closes the connection handle and frees up all resources used."
2624 #: ../src/guestfs.pod:1314
2626 "If autosync was set on the handle and the handle was launched, then this "
2627 "implicitly calls various functions to unmount filesystems and sync the "
2628 "disk. See L</guestfs_set_autosync> for more details."
2632 #: ../src/guestfs.pod:1318
2633 msgid "If a close callback was set on the handle, then it is called."
2637 #: ../src/guestfs.pod:1320
2638 msgid "ERROR HANDLING"
2639 msgstr "ОБРОБКА ПОМИЛОК"
2642 #: ../src/guestfs.pod:1322
2644 "API functions can return errors. For example, almost all functions that "
2645 "return C<int> will return C<-1> to indicate an error."
2649 #: ../src/guestfs.pod:1325
2651 "Additional information is available for errors: an error message string and "
2652 "optionally an error number (errno) if the thing that failed was a system "
2657 #: ../src/guestfs.pod:1329
2659 "You can get at the additional information about the last error on the handle "
2660 "by calling L</guestfs_last_error>, L</guestfs_last_errno>, and/or by setting "
2661 "up an error handler with L</guestfs_set_error_handler>."
2665 #: ../src/guestfs.pod:1334
2667 "When the handle is created, a default error handler is installed which "
2668 "prints the error message string to C<stderr>. For small short-running "
2669 "command line programs it is sufficient to do:"
2673 #: ../src/guestfs.pod:1338
2676 " if (guestfs_launch (g) == -1)\n"
2677 " exit (EXIT_FAILURE);\n"
2682 #: ../src/guestfs.pod:1341
2684 "since the default error handler will ensure that an error message has been "
2685 "printed to C<stderr> before the program exits."
2689 #: ../src/guestfs.pod:1344
2691 "For other programs the caller will almost certainly want to install an "
2692 "alternate error handler or do error handling in-line like this:"
2696 #: ../src/guestfs.pod:1347
2699 " g = guestfs_create ();\n"
2704 #: ../src/guestfs.pod:1349
2707 " /* This disables the default behaviour of printing errors\n"
2709 " guestfs_set_error_handler (g, NULL, NULL);\n"
2714 #: ../src/guestfs.pod:1353
2717 " if (guestfs_launch (g) == -1) {\n"
2718 " /* Examine the error message and print it etc. */\n"
2719 " char *msg = guestfs_last_error (g);\n"
2720 " int errnum = guestfs_last_errno (g);\n"
2721 " fprintf (stderr, \"%s\\n\", msg);\n"
2728 #: ../src/guestfs.pod:1361
2730 "Out of memory errors are handled differently. The default action is to call "
2731 "L<abort(3)>. If this is undesirable, then you can set a handler using L</"
2732 "guestfs_set_out_of_memory_handler>."
2736 #: ../src/guestfs.pod:1365
2738 "L</guestfs_create> returns C<NULL> if the handle cannot be created, and "
2739 "because there is no handle if this happens there is no way to get additional "
2740 "error information. However L</guestfs_create> is supposed to be a "
2741 "lightweight operation which can only fail because of insufficient memory (it "
2742 "returns NULL in this case)."
2746 #: ../src/guestfs.pod:1371
2747 msgid "guestfs_last_error"
2751 #: ../src/guestfs.pod:1373
2754 " const char *guestfs_last_error (guestfs_h *g);\n"
2759 #: ../src/guestfs.pod:1375
2761 "This returns the last error message that happened on C<g>. If there has not "
2762 "been an error since the handle was created, then this returns C<NULL>."
2766 #: ../src/guestfs.pod:1379
2768 "The lifetime of the returned string is until the next error occurs, or L</"
2769 "guestfs_close> is called."
2773 #: ../src/guestfs.pod:1382
2774 msgid "guestfs_last_errno"
2778 #: ../src/guestfs.pod:1384
2781 " int guestfs_last_errno (guestfs_h *g);\n"
2786 #: ../src/guestfs.pod:1386
2787 msgid "This returns the last error number (errno) that happened on C<g>."
2791 #: ../src/guestfs.pod:1388
2792 msgid "If successful, an errno integer not equal to zero is returned."
2796 #: ../src/guestfs.pod:1390
2798 "If no error, this returns 0. This call can return 0 in three situations:"
2802 #: ../src/guestfs.pod:1397
2803 msgid "There has not been any error on the handle."
2807 #: ../src/guestfs.pod:1401
2809 "There has been an error but the errno was meaningless. This corresponds to "
2810 "the case where the error did not come from a failed system call, but for "
2811 "some other reason."
2815 #: ../src/guestfs.pod:1407
2817 "There was an error from a failed system call, but for some reason the errno "
2818 "was not captured and returned. This usually indicates a bug in libguestfs."
2822 #: ../src/guestfs.pod:1413
2824 "Libguestfs tries to convert the errno from inside the applicance into a "
2825 "corresponding errno for the caller (not entirely trivial: the appliance "
2826 "might be running a completely different operating system from the library "
2827 "and error numbers are not standardized across Un*xen). If this could not be "
2828 "done, then the error is translated to C<EINVAL>. In practice this should "
2829 "only happen in very rare circumstances."
2833 #: ../src/guestfs.pod:1421
2834 msgid "guestfs_set_error_handler"
2838 #: ../src/guestfs.pod:1423
2841 " typedef void (*guestfs_error_handler_cb) (guestfs_h *g,\n"
2843 " const char *msg);\n"
2844 " void guestfs_set_error_handler (guestfs_h *g,\n"
2845 " guestfs_error_handler_cb cb,\n"
2851 #: ../src/guestfs.pod:1430
2853 "The callback C<cb> will be called if there is an error. The parameters "
2854 "passed to the callback are an opaque data pointer and the error message "
2859 #: ../src/guestfs.pod:1434
2861 "C<errno> is not passed to the callback. To get that the callback must call "
2862 "L</guestfs_last_errno>."
2866 #: ../src/guestfs.pod:1437
2868 "Note that the message string C<msg> is freed as soon as the callback "
2869 "function returns, so if you want to stash it somewhere you must make your "
2874 #: ../src/guestfs.pod:1441
2875 msgid "The default handler prints messages on C<stderr>."
2879 #: ../src/guestfs.pod:1443
2880 msgid "If you set C<cb> to C<NULL> then I<no> handler is called."
2884 #: ../src/guestfs.pod:1445
2885 msgid "guestfs_get_error_handler"
2889 #: ../src/guestfs.pod:1447
2892 " guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g,\n"
2893 " void **opaque_rtn);\n"
2898 #: ../src/guestfs.pod:1450
2899 msgid "Returns the current error handler callback."
2903 #: ../src/guestfs.pod:1452
2904 msgid "guestfs_set_out_of_memory_handler"
2908 #: ../src/guestfs.pod:1454
2911 " typedef void (*guestfs_abort_cb) (void);\n"
2912 " void guestfs_set_out_of_memory_handler (guestfs_h *g,\n"
2913 " guestfs_abort_cb);\n"
2918 #: ../src/guestfs.pod:1458
2920 "The callback C<cb> will be called if there is an out of memory situation. "
2921 "I<Note this callback must not return>."
2925 #: ../src/guestfs.pod:1461
2926 msgid "The default is to call L<abort(3)>."
2930 #: ../src/guestfs.pod:1463
2932 "You cannot set C<cb> to C<NULL>. You can't ignore out of memory situations."
2936 #: ../src/guestfs.pod:1466
2937 msgid "guestfs_get_out_of_memory_handler"
2941 #: ../src/guestfs.pod:1468
2944 " guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n"
2949 #: ../src/guestfs.pod:1470
2950 msgid "This returns the current out of memory handler."
2954 #: ../src/guestfs.pod:1472
2959 #: ../src/guestfs.pod:1474 ../fish/guestfish.pod:1019
2964 #: ../src/guestfs.pod:1476
2969 #: ../src/guestfs.pod:1478
2974 #: ../src/guestfs.pod:1480
2975 msgid "AVAILABILITY"
2979 #: ../src/guestfs.pod:1482
2980 msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE"
2984 #: ../src/guestfs.pod:1484
2986 "Using L</guestfs_available> you can test availability of the following "
2987 "groups of functions. This test queries the appliance to see if the "
2988 "appliance you are currently using supports the functionality."
2992 #: ../src/guestfs.pod:1489
2993 msgid "@AVAILABILITY@"
2997 #: ../src/guestfs.pod:1491
2998 msgid "GUESTFISH supported COMMAND"
3002 #: ../src/guestfs.pod:1493
3004 "In L<guestfish(3)> there is a handy interactive command C<supported> which "
3005 "prints out the available groups and whether they are supported by this build "
3006 "of libguestfs. Note however that you have to do C<run> first."
3010 #: ../src/guestfs.pod:1498
3011 msgid "SINGLE CALLS AT COMPILE TIME"
3015 #: ../src/guestfs.pod:1500
3017 "Since version 1.5.8, C<E<lt>guestfs.hE<gt>> defines symbols for each C API "
3018 "function, such as:"
3022 #: ../src/guestfs.pod:1503
3025 " #define LIBGUESTFS_HAVE_DD 1\n"
3030 #: ../src/guestfs.pod:1505
3031 msgid "if L</guestfs_dd> is available."
3035 #: ../src/guestfs.pod:1507
3037 "Before version 1.5.8, if you needed to test whether a single libguestfs "
3038 "function is available at compile time, we recommended using build tools such "
3039 "as autoconf or cmake. For example in autotools you could use:"
3043 #: ../src/guestfs.pod:1512
3046 " AC_CHECK_LIB([guestfs],[guestfs_create])\n"
3047 " AC_CHECK_FUNCS([guestfs_dd])\n"
3052 #: ../src/guestfs.pod:1515
3054 "which would result in C<HAVE_GUESTFS_DD> being either defined or not defined "
3059 #: ../src/guestfs.pod:1518
3060 msgid "SINGLE CALLS AT RUN TIME"
3064 #: ../src/guestfs.pod:1520
3066 "Testing at compile time doesn't guarantee that a function really exists in "
3067 "the library. The reason is that you might be dynamically linked against a "
3068 "previous I<libguestfs.so> (dynamic library) which doesn't have the call. "
3069 "This situation unfortunately results in a segmentation fault, which is a "
3070 "shortcoming of the C dynamic linking system itself."
3074 #: ../src/guestfs.pod:1527
3076 "You can use L<dlopen(3)> to test if a function is available at run time, as "
3077 "in this example program (note that you still need the compile time check as "
3082 #: ../src/guestfs.pod:1531
3085 " #include <stdio.h>\n"
3086 " #include <stdlib.h>\n"
3087 " #include <unistd.h>\n"
3088 " #include <dlfcn.h>\n"
3089 " #include <guestfs.h>\n"
3094 #: ../src/guestfs.pod:1537
3099 " #ifdef LIBGUESTFS_HAVE_DD\n"
3101 " int has_function;\n"
3106 #: ../src/guestfs.pod:1543
3109 " /* Test if the function guestfs_dd is really available. */\n"
3110 " dl = dlopen (NULL, RTLD_LAZY);\n"
3112 " fprintf (stderr, \"dlopen: %s\\n\", dlerror ());\n"
3113 " exit (EXIT_FAILURE);\n"
3115 " has_function = dlsym (dl, \"guestfs_dd\") != NULL;\n"
3121 #: ../src/guestfs.pod:1552
3124 " if (!has_function)\n"
3125 " printf (\"this libguestfs.so does NOT have guestfs_dd function\\n\");\n"
3127 " printf (\"this libguestfs.so has guestfs_dd function\\n\");\n"
3128 " /* Now it's safe to call\n"
3129 " guestfs_dd (g, \"foo\", \"bar\");\n"
3133 " printf (\"guestfs_dd function was not found at compile time\\n\");\n"
3140 #: ../src/guestfs.pod:1565
3142 "You may think the above is an awful lot of hassle, and it is. There are "
3143 "other ways outside of the C linking system to ensure that this kind of "
3144 "incompatibility never arises, such as using package versioning:"
3148 #: ../src/guestfs.pod:1570
3151 " Requires: libguestfs >= 1.0.80\n"
3156 #: ../src/guestfs.pod:1572
3157 msgid "CALLS WITH OPTIONAL ARGUMENTS"
3161 #: ../src/guestfs.pod:1574
3163 "A recent feature of the API is the introduction of calls which take optional "
3164 "arguments. In C these are declared 3 ways. The main way is as a call which "
3165 "takes variable arguments (ie. C<...>), as in this example:"
3169 #: ../src/guestfs.pod:1579
3172 " int guestfs_add_drive_opts (guestfs_h *g, const char *filename, ...);\n"
3177 #: ../src/guestfs.pod:1581
3179 "Call this with a list of optional arguments, terminated by C<-1>. So to "
3180 "call with no optional arguments specified:"
3184 #: ../src/guestfs.pod:1584
3187 " guestfs_add_drive_opts (g, filename, -1);\n"
3192 #: ../src/guestfs.pod:1586
3193 msgid "With a single optional argument:"
3197 #: ../src/guestfs.pod:1588
3200 " guestfs_add_drive_opts (g, filename,\n"
3201 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
3207 #: ../src/guestfs.pod:1592
3212 #: ../src/guestfs.pod:1594
3215 " guestfs_add_drive_opts (g, filename,\n"
3216 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
3217 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
3223 #: ../src/guestfs.pod:1599
3225 "and so forth. Don't forget the terminating C<-1> otherwise Bad Things will "
3230 #: ../src/guestfs.pod:1602
3231 msgid "USING va_list FOR OPTIONAL ARGUMENTS"
3235 #: ../src/guestfs.pod:1604
3237 "The second variant has the same name with the suffix C<_va>, which works the "
3238 "same way but takes a C<va_list>. See the C manual for details. For the "
3239 "example function, this is declared:"
3243 #: ../src/guestfs.pod:1608
3246 " int guestfs_add_drive_opts_va (guestfs_h *g, const char *filename,\n"
3252 #: ../src/guestfs.pod:1611
3253 msgid "CONSTRUCTING OPTIONAL ARGUMENTS"
3257 #: ../src/guestfs.pod:1613
3259 "The third variant is useful where you need to construct these calls. You "
3260 "pass in a structure where you fill in the optional fields. The structure "
3261 "has a bitmask as the first element which you must set to indicate which "
3262 "fields you have filled in. For our example function the structure and call "
3267 #: ../src/guestfs.pod:1619
3270 " struct guestfs_add_drive_opts_argv {\n"
3271 " uint64_t bitmask;\n"
3273 " const char *format;\n"
3276 " int guestfs_add_drive_opts_argv (guestfs_h *g, const char *filename,\n"
3277 " const struct guestfs_add_drive_opts_argv *optargs);\n"
3282 #: ../src/guestfs.pod:1628
3283 msgid "You could call it like this:"
3287 #: ../src/guestfs.pod:1630
3290 " struct guestfs_add_drive_opts_argv optargs = {\n"
3291 " .bitmask = GUESTFS_ADD_DRIVE_OPTS_READONLY_BITMASK |\n"
3292 " GUESTFS_ADD_DRIVE_OPTS_FORMAT_BITMASK,\n"
3294 " .format = \"qcow2\"\n"
3300 #: ../src/guestfs.pod:1637
3303 " guestfs_add_drive_opts_argv (g, filename, &optargs);\n"
3308 #: ../src/guestfs.pod:1639 ../src/guestfs-actions.pod:11
3309 #: ../src/guestfs-actions.pod:1857 ../fish/guestfish-actions.pod:9
3310 #: ../fish/guestfish-actions.pod:1262 ../tools/virt-win-reg.pl:532
3315 #: ../src/guestfs.pod:1645
3316 msgid "The C<_BITMASK> suffix on each option name when specifying the bitmask."
3320 #: ../src/guestfs.pod:1650
3321 msgid "You do not need to fill in all fields of the structure."
3325 #: ../src/guestfs.pod:1654
3327 "There must be a one-to-one correspondence between fields of the structure "
3328 "that are filled in, and bits set in the bitmask."
3332 #: ../src/guestfs.pod:1659
3333 msgid "OPTIONAL ARGUMENTS IN OTHER LANGUAGES"
3337 #: ../src/guestfs.pod:1661
3339 "In other languages, optional arguments are expressed in the way that is "
3340 "natural for that language. We refer you to the language-specific "
3341 "documentation for more details on that."
3345 #: ../src/guestfs.pod:1665
3346 msgid "For guestfish, see L<guestfish(1)/OPTIONAL ARGUMENTS>."
3350 #: ../src/guestfs.pod:1667
3351 msgid "SETTING CALLBACKS TO HANDLE EVENTS"
3355 #: ../src/guestfs.pod:1669
3357 "B<Note:> This section documents the generic event mechanism introduced in "
3358 "libguestfs 1.10, which you should use in new code if possible. The old "
3359 "functions C<guestfs_set_log_message_callback>, "
3360 "C<guestfs_set_subprocess_quit_callback>, "
3361 "C<guestfs_set_launch_done_callback>, C<guestfs_set_close_callback> and "
3362 "C<guestfs_set_progress_callback> are no longer documented in this manual "
3367 #: ../src/guestfs.pod:1677
3369 "Handles generate events when certain things happen, such as log messages "
3370 "being generated, progress messages during long-running operations, or the "
3371 "handle being closed. The API calls described below let you register a "
3372 "callback to be called when events happen. You can register multiple "
3373 "callbacks (for the same, different or overlapping sets of events), and "
3374 "individually remove callbacks. If callbacks are not removed, then they "
3375 "remain in force until the handle is closed."
3379 #: ../src/guestfs.pod:1685
3381 "In the current implementation, events are only generated synchronously: that "
3382 "means that events (and hence callbacks) can only happen while you are in the "
3383 "middle of making another libguestfs call. The callback is called in the "
3388 #: ../src/guestfs.pod:1690
3390 "Events may contain a payload, usually nothing (void), an array of 64 bit "
3391 "unsigned integers, or a message buffer. Payloads are discussed later on."
3395 #: ../src/guestfs.pod:1694
3396 msgid "CLASSES OF EVENTS"
3400 #: ../src/guestfs.pod:1698
3401 msgid "GUESTFS_EVENT_CLOSE (payload type: void)"
3405 #: ../src/guestfs.pod:1701
3407 "The callback function will be called while the handle is being closed "
3408 "(synchronously from L</guestfs_close>)."
3412 #: ../src/guestfs.pod:1704
3414 "Note that libguestfs installs an L<atexit(3)> handler to try to clean up "
3415 "handles that are open when the program exits. This means that this callback "
3416 "might be called indirectly from L<exit(3)>, which can cause unexpected "
3417 "problems in higher-level languages (eg. if your HLL interpreter has already "
3418 "been cleaned up by the time this is called, and if your callback then jumps "
3419 "into some HLL function)."
3423 #: ../src/guestfs.pod:1711
3425 "If no callback is registered: the handle is closed without any callback "
3430 #: ../src/guestfs.pod:1714
3431 msgid "GUESTFS_EVENT_SUBPROCESS_QUIT (payload type: void)"
3435 #: ../src/guestfs.pod:1717
3437 "The callback function will be called when the child process quits, either "
3438 "asynchronously or if killed by L</guestfs_kill_subprocess>. (This "
3439 "corresponds to a transition from any state to the CONFIG state)."
3443 #: ../src/guestfs.pod:1721 ../src/guestfs.pod:1730
3444 msgid "If no callback is registered: the event is ignored."
3448 #: ../src/guestfs.pod:1723
3449 msgid "GUESTFS_EVENT_LAUNCH_DONE (payload type: void)"
3453 #: ../src/guestfs.pod:1726
3455 "The callback function will be called when the child process becomes ready "
3456 "first time after it has been launched. (This corresponds to a transition "
3457 "from LAUNCHING to the READY state)."
3461 #: ../src/guestfs.pod:1732
3462 msgid "GUESTFS_EVENT_PROGRESS (payload type: array of 4 x uint64_t)"
3466 #: ../src/guestfs.pod:1735
3468 "Some long-running operations can generate progress messages. If this "
3469 "callback is registered, then it will be called each time a progress message "
3470 "is generated (usually two seconds after the operation started, and three "
3471 "times per second thereafter until it completes, although the frequency may "
3472 "change in future versions)."
3476 #: ../src/guestfs.pod:1741
3478 "The callback receives in the payload four unsigned 64 bit numbers which are "
3479 "(in order): C<proc_nr>, C<serial>, C<position>, C<total>."
3483 #: ../src/guestfs.pod:1744
3485 "The units of C<total> are not defined, although for some operations C<total> "
3486 "may relate in some way to the amount of data to be transferred (eg. in bytes "
3487 "or megabytes), and C<position> may be the portion which has been transferred."
3491 #: ../src/guestfs.pod:1749
3492 msgid "The only defined and stable parts of the API are:"
3496 #: ../src/guestfs.pod:1755
3498 "The callback can display to the user some type of progress bar or indicator "
3499 "which shows the ratio of C<position>:C<total>."
3503 #: ../src/guestfs.pod:1760
3504 msgid "0 E<lt>= C<position> E<lt>= C<total>"
3508 #: ../src/guestfs.pod:1764
3510 "If any progress notification is sent during a call, then a final progress "
3511 "notification is always sent when C<position> = C<total> (I<unless> the call "
3512 "fails with an error)."
3516 #: ../src/guestfs.pod:1768
3518 "This is to simplify caller code, so callers can easily set the progress "
3519 "indicator to \"100%\" at the end of the operation, without requiring special "
3520 "code to detect this case."
3524 #: ../src/guestfs.pod:1774
3526 "For some calls we are unable to estimate the progress of the call, but we "
3527 "can still generate progress messages to indicate activity. This is known as "
3528 "\"pulse mode\", and is directly supported by certain progress bar "
3529 "implementations (eg. GtkProgressBar)."
3533 #: ../src/guestfs.pod:1779
3535 "For these calls, zero or more progress messages are generated with "
3536 "C<position = 0> and C<total = 1>, followed by a final message with "
3537 "C<position = total = 1>."
3541 #: ../src/guestfs.pod:1783
3543 "As noted above, if the call fails with an error then the final message may "
3548 #: ../src/guestfs.pod:1788
3550 "The callback also receives the procedure number (C<proc_nr>) and serial "
3551 "number (C<serial>) of the call. These are only useful for debugging "
3552 "protocol issues, and the callback can normally ignore them. The callback "
3553 "may want to print these numbers in error messages or debugging messages."
3557 #: ../src/guestfs.pod:1794
3558 msgid "If no callback is registered: progress messages are discarded."
3562 #: ../src/guestfs.pod:1796
3563 msgid "GUESTFS_EVENT_APPLIANCE (payload type: message buffer)"
3567 #: ../src/guestfs.pod:1799
3569 "The callback function is called whenever a log message is generated by qemu, "
3570 "the appliance kernel, guestfsd (daemon), or utility programs."
3574 #: ../src/guestfs.pod:1802
3576 "If the verbose flag (L</guestfs_set_verbose>) is set before launch (L</"
3577 "guestfs_launch>) then additional debug messages are generated."
3581 #: ../src/guestfs.pod:1805 ../src/guestfs.pod:1819
3583 "If no callback is registered: the messages are discarded unless the verbose "
3584 "flag is set in which case they are sent to stderr. You can override the "
3585 "printing of verbose messages to stderr by setting up a callback."
3589 #: ../src/guestfs.pod:1810
3590 msgid "GUESTFS_EVENT_LIBRARY (payload type: message buffer)"
3594 #: ../src/guestfs.pod:1813
3596 "The callback function is called whenever a log message is generated by the "
3597 "library part of libguestfs."
3601 #: ../src/guestfs.pod:1816
3603 "If the verbose flag (L</guestfs_set_verbose>) is set then additional debug "
3604 "messages are generated."
3608 #: ../src/guestfs.pod:1824
3609 msgid "GUESTFS_EVENT_TRACE (payload type: message buffer)"
3613 #: ../src/guestfs.pod:1827
3615 "The callback function is called whenever a trace message is generated. This "
3616 "only applies if the trace flag (L</guestfs_set_trace>) is set."
3620 #: ../src/guestfs.pod:1830
3622 "If no callback is registered: the messages are sent to stderr. You can "
3623 "override the printing of trace messages to stderr by setting up a callback."
3627 #: ../src/guestfs.pod:1836
3628 msgid "guestfs_set_event_callback"
3632 #: ../src/guestfs.pod:1838
3635 " int guestfs_set_event_callback (guestfs_h *g,\n"
3636 " guestfs_event_callback cb,\n"
3637 " uint64_t event_bitmask,\n"
3644 #: ../src/guestfs.pod:1844
3646 "This function registers a callback (C<cb>) for all event classes in the "
3651 #: ../src/guestfs.pod:1847
3653 "For example, to register for all log message events, you could call this "
3654 "function with the bitmask C<GUESTFS_EVENT_APPLIANCE|GUESTFS_EVENT_LIBRARY>. "
3655 "To register a single callback for all possible classes of events, use "
3656 "C<GUESTFS_EVENT_ALL>."
3660 #: ../src/guestfs.pod:1853
3661 msgid "C<flags> should always be passed as 0."
3665 #: ../src/guestfs.pod:1855
3667 "C<opaque> is an opaque pointer which is passed to the callback. You can use "
3668 "it for any purpose."
3672 #: ../src/guestfs.pod:1858
3674 "The return value is the event handle (an integer) which you can use to "
3675 "delete the callback (see below)."
3679 #: ../src/guestfs.pod:1861
3681 "If there is an error, this function returns C<-1>, and sets the error in the "
3682 "handle in the usual way (see L</guestfs_last_error> etc.)"
3686 #: ../src/guestfs.pod:1864
3688 "Callbacks remain in effect until they are deleted, or until the handle is "
3693 #: ../src/guestfs.pod:1867
3695 "In the case where multiple callbacks are registered for a particular event "
3696 "class, all of the callbacks are called. The order in which multiple "
3697 "callbacks are called is not defined."
3701 #: ../src/guestfs.pod:1871
3702 msgid "guestfs_delete_event_callback"
3706 #: ../src/guestfs.pod:1873
3709 " void guestfs_delete_event_callback (guestfs_h *g, int event_handle);\n"
3714 #: ../src/guestfs.pod:1875
3716 "Delete a callback that was previously registered. C<event_handle> should be "
3717 "the integer that was returned by a previous call to "
3718 "C<guestfs_set_event_callback> on the same handle."
3722 #: ../src/guestfs.pod:1879
3723 msgid "guestfs_event_callback"
3727 #: ../src/guestfs.pod:1881
3730 " typedef void (*guestfs_event_callback) (\n"
3733 " uint64_t event,\n"
3734 " int event_handle,\n"
3736 " const char *buf, size_t buf_len,\n"
3737 " const uint64_t *array, size_t array_len);\n"
3742 #: ../src/guestfs.pod:1890
3744 "This is the type of the event callback function that you have to provide."
3748 #: ../src/guestfs.pod:1893
3750 "The basic parameters are: the handle (C<g>), the opaque user pointer "
3751 "(C<opaque>), the event class (eg. C<GUESTFS_EVENT_PROGRESS>), the event "
3752 "handle, and C<flags> which in the current API you should ignore."
3756 #: ../src/guestfs.pod:1897
3758 "The remaining parameters contain the event payload (if any). Each event may "
3759 "contain a payload, which usually relates to the event class, but for future "
3760 "proofing your code should be written to handle any payload for any event "
3765 #: ../src/guestfs.pod:1902
3767 "C<buf> and C<buf_len> contain a message buffer (if C<buf_len == 0>, then "
3768 "there is no message buffer). Note that this message buffer can contain "
3769 "arbitrary 8 bit data, including NUL bytes."
3773 #: ../src/guestfs.pod:1906
3775 "C<array> and C<array_len> is an array of 64 bit unsigned integers. At the "
3776 "moment this is only used for progress messages."
3780 #: ../src/guestfs.pod:1909
3781 msgid "EXAMPLE: CAPTURING LOG MESSAGES"
3785 #: ../src/guestfs.pod:1911
3787 "One motivation for the generic event API was to allow GUI programs to "
3788 "capture debug and other messages. In libguestfs E<le> 1.8 these were sent "
3789 "unconditionally to C<stderr>."
3793 #: ../src/guestfs.pod:1915
3795 "Events associated with log messages are: C<GUESTFS_EVENT_LIBRARY>, "
3796 "C<GUESTFS_EVENT_APPLIANCE> and C<GUESTFS_EVENT_TRACE>. (Note that error "
3797 "messages are not events; you must capture error messages separately)."
3801 #: ../src/guestfs.pod:1920
3803 "Programs have to set up a callback to capture the classes of events of "
3808 #: ../src/guestfs.pod:1923
3812 " guestfs_set_event_callback\n"
3813 " (g, message_callback,\n"
3814 " GUESTFS_EVENT_LIBRARY|GUESTFS_EVENT_APPLIANCE|\n"
3815 " GUESTFS_EVENT_TRACE,\n"
3816 " 0, NULL) == -1)\n"
3817 " if (eh == -1) {\n"
3818 " // handle error in the usual way\n"
3824 #: ../src/guestfs.pod:1933
3826 "The callback can then direct messages to the appropriate place. In this "
3827 "example, messages are directed to syslog:"
3831 #: ../src/guestfs.pod:1936
3835 " message_callback (\n"
3838 " uint64_t event,\n"
3839 " int event_handle,\n"
3841 " const char *buf, size_t buf_len,\n"
3842 " const uint64_t *array, size_t array_len)\n"
3844 " const int priority = LOG_USER|LOG_INFO;\n"
3845 " if (buf_len > 0)\n"
3846 " syslog (priority, \"event 0x%lx: %s\", event, buf);\n"
3852 #: ../src/guestfs.pod:1951
3853 msgid "PRIVATE DATA AREA"
3857 #: ../src/guestfs.pod:1953
3859 "You can attach named pieces of private data to the libguestfs handle, fetch "
3860 "them by name, and walk over them, for the lifetime of the handle. This is "
3861 "called the private data area and is only available from the C API."
3865 #: ../src/guestfs.pod:1958
3866 msgid "To attach a named piece of data, use the following call:"
3870 #: ../src/guestfs.pod:1960
3873 " void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n"
3878 #: ../src/guestfs.pod:1962
3880 "C<key> is the name to associate with this data, and C<data> is an arbitrary "
3881 "pointer (which can be C<NULL>). Any previous item with the same key is "
3886 #: ../src/guestfs.pod:1966
3888 "You can use any C<key> you want, but your key should I<not> start with an "
3889 "underscore character. Keys beginning with an underscore character are "
3890 "reserved for internal libguestfs purposes (eg. for implementing language "
3891 "bindings). It is recommended that you prefix the key with some unique "
3892 "string to avoid collisions with other users."
3896 #: ../src/guestfs.pod:1972
3897 msgid "To retrieve the pointer, use:"
3901 #: ../src/guestfs.pod:1974
3904 " void *guestfs_get_private (guestfs_h *g, const char *key);\n"
3909 #: ../src/guestfs.pod:1976
3911 "This function returns C<NULL> if either no data is found associated with "
3912 "C<key>, or if the user previously set the C<key>'s C<data> pointer to "
3917 #: ../src/guestfs.pod:1980
3919 "Libguestfs does not try to look at or interpret the C<data> pointer in any "
3920 "way. As far as libguestfs is concerned, it need not be a valid pointer at "
3921 "all. In particular, libguestfs does I<not> try to free the data when the "
3922 "handle is closed. If the data must be freed, then the caller must either "
3923 "free it before calling L</guestfs_close> or must set up a close callback to "
3924 "do it (see L</GUESTFS_EVENT_CLOSE>)."
3928 #: ../src/guestfs.pod:1987
3929 msgid "To walk over all entries, use these two functions:"
3933 #: ../src/guestfs.pod:1989
3936 " void *guestfs_first_private (guestfs_h *g, const char **key_rtn);\n"
3941 #: ../src/guestfs.pod:1991
3944 " void *guestfs_next_private (guestfs_h *g, const char **key_rtn);\n"
3949 #: ../src/guestfs.pod:1993
3951 "C<guestfs_first_private> returns the first key, pointer pair (\"first\" does "
3952 "not have any particular meaning -- keys are not returned in any defined "
3953 "order). A pointer to the key is returned in C<*key_rtn> and the "
3954 "corresponding data pointer is returned from the function. C<NULL> is "
3955 "returned if there are no keys stored in the handle."
3959 #: ../src/guestfs.pod:1999
3961 "C<guestfs_next_private> returns the next key, pointer pair. The return "
3962 "value of this function is also C<NULL> is there are no further entries to "
3967 #: ../src/guestfs.pod:2003
3968 msgid "Notes about walking over entries:"
3972 #: ../src/guestfs.pod:2009
3974 "You must not call C<guestfs_set_private> while walking over the entries."
3978 #: ../src/guestfs.pod:2014
3980 "The handle maintains an internal iterator which is reset when you call "
3981 "C<guestfs_first_private>. This internal iterator is invalidated when you "
3982 "call C<guestfs_set_private>."
3986 #: ../src/guestfs.pod:2020
3987 msgid "If you have set the data pointer associated with a key to C<NULL>, ie:"
3991 #: ../src/guestfs.pod:2022
3994 " guestfs_set_private (g, key, NULL);\n"
3999 #: ../src/guestfs.pod:2024
4000 msgid "then that C<key> is not returned when walking."
4004 #: ../src/guestfs.pod:2028
4006 "C<*key_rtn> is only valid until the next call to C<guestfs_first_private>, "
4007 "C<guestfs_next_private> or C<guestfs_set_private>."
4011 #: ../src/guestfs.pod:2034
4013 "The following example code shows how to print all keys and data pointers "
4014 "that are associated with the handle C<g>:"
4018 #: ../src/guestfs.pod:2037
4021 " const char *key;\n"
4022 " void *data = guestfs_first_private (g, &key);\n"
4023 " while (data != NULL)\n"
4025 " printf (\"key = %s, data = %p\\n\", key, data);\n"
4026 " data = guestfs_next_private (g, &key);\n"
4032 #: ../src/guestfs.pod:2045
4034 "More commonly you are only interested in keys that begin with an application-"
4035 "specific prefix C<foo_>. Modify the loop like so:"
4039 #: ../src/guestfs.pod:2048
4042 " const char *key;\n"
4043 " void *data = guestfs_first_private (g, &key);\n"
4044 " while (data != NULL)\n"
4046 " if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
4047 " printf (\"key = %s, data = %p\\n\", key, data);\n"
4048 " data = guestfs_next_private (g, &key);\n"
4054 #: ../src/guestfs.pod:2057
4056 "If you need to modify keys while walking, then you have to jump back to the "
4057 "beginning of the loop. For example, to delete all keys prefixed with "
4062 #: ../src/guestfs.pod:2061
4065 " const char *key;\n"
4068 " data = guestfs_first_private (g, &key);\n"
4069 " while (data != NULL)\n"
4071 " if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
4073 " guestfs_set_private (g, key, NULL);\n"
4074 " /* note that 'key' pointer is now invalid, and so is\n"
4075 " the internal iterator */\n"
4078 " data = guestfs_next_private (g, &key);\n"
4084 #: ../src/guestfs.pod:2077
4086 "Note that the above loop is guaranteed to terminate because the keys are "
4087 "being deleted, but other manipulations of keys within the loop might not "
4088 "terminate unless you also maintain an indication of which keys have been "
4093 #: ../src/guestfs.pod:2082 ../src/guestfs.pod:2087
4098 #: ../src/guestfs.pod:2084
4100 "<!-- old anchor for the next section --> <a name="
4101 "\"state_machine_and_low_level_event_api\"/>"
4103 "<!-- old anchor for the next section --> <a name="
4104 "\"state_machine_and_low_level_event_api\"/>"
4107 #: ../src/guestfs.pod:2089
4108 msgid "ARCHITECTURE"
4109 msgstr "АРХІТЕКТУРА"
4112 #: ../src/guestfs.pod:2091
4114 "Internally, libguestfs is implemented by running an appliance (a special "
4115 "type of small virtual machine) using L<qemu(1)>. Qemu runs as a child "
4116 "process of the main program."
4120 #: ../src/guestfs.pod:2095
4123 " ___________________\n"
4125 " | main program |\n"
4127 " | | child process / appliance\n"
4128 " | | __________________________\n"
4130 " +-------------------+ RPC | +-----------------+ |\n"
4131 " | libguestfs <--------------------> guestfsd | |\n"
4132 " | | | +-----------------+ |\n"
4133 " \\___________________/ | | Linux kernel | |\n"
4134 " | +--^--------------+ |\n"
4135 " \\_________|________________/\n"
4141 " \\______________/\n"
4146 #: ../src/guestfs.pod:2115
4148 "The library, linked to the main program, creates the child process and hence "
4149 "the appliance in the L</guestfs_launch> function."
4153 #: ../src/guestfs.pod:2118
4155 "Inside the appliance is a Linux kernel and a complete stack of userspace "
4156 "tools (such as LVM and ext2 programs) and a small controlling daemon called "
4157 "L</guestfsd>. The library talks to L</guestfsd> using remote procedure "
4158 "calls (RPC). There is a mostly one-to-one correspondence between libguestfs "
4159 "API calls and RPC calls to the daemon. Lastly the disk image(s) are "
4160 "attached to the qemu process which translates device access by the "
4161 "appliance's Linux kernel into accesses to the image."
4165 #: ../src/guestfs.pod:2127
4167 "A common misunderstanding is that the appliance \"is\" the virtual machine. "
4168 "Although the disk image you are attached to might also be used by some "
4169 "virtual machine, libguestfs doesn't know or care about this. (But you will "
4170 "care if both libguestfs's qemu process and your virtual machine are trying "
4171 "to update the disk image at the same time, since these usually results in "
4172 "massive disk corruption)."
4176 #: ../src/guestfs.pod:2134
4177 msgid "STATE MACHINE"
4178 msgstr "СКІНЧЕННИЙ АВТОМАТ"
4181 #: ../src/guestfs.pod:2136
4182 msgid "libguestfs uses a state machine to model the child process:"
4186 #: ../src/guestfs.pod:2138
4198 " / | \\ \\ guestfs_launch\n"
4199 " / | _\\__V______\n"
4201 " / | | LAUNCHING |\n"
4202 " / | \\___________/\n"
4204 " / | guestfs_launch\n"
4206 " ______ / __|____V\n"
4207 " / \\ ------> / \\\n"
4208 " | BUSY | | READY |\n"
4209 " \\______/ <------ \\________/\n"
4214 #: ../src/guestfs.pod:2160
4216 "The normal transitions are (1) CONFIG (when the handle is created, but there "
4217 "is no child process), (2) LAUNCHING (when the child process is booting up), "
4218 "(3) alternating between READY and BUSY as commands are issued to, and "
4219 "carried out by, the child process."
4223 #: ../src/guestfs.pod:2165
4225 "The guest may be killed by L</guestfs_kill_subprocess>, or may die "
4226 "asynchronously at any time (eg. due to some internal error), and that causes "
4227 "the state to transition back to CONFIG."
4231 #: ../src/guestfs.pod:2169
4233 "Configuration commands for qemu such as L</guestfs_add_drive> can only be "
4234 "issued when in the CONFIG state."
4238 #: ../src/guestfs.pod:2172
4240 "The API offers one call that goes from CONFIG through LAUNCHING to READY. "
4241 "L</guestfs_launch> blocks until the child process is READY to accept "
4242 "commands (or until some failure or timeout). L</guestfs_launch> internally "
4243 "moves the state from CONFIG to LAUNCHING while it is running."
4247 #: ../src/guestfs.pod:2178
4249 "API actions such as L</guestfs_mount> can only be issued when in the READY "
4250 "state. These API calls block waiting for the command to be carried out (ie. "
4251 "the state to transition to BUSY and then back to READY). There are no non-"
4252 "blocking versions, and no way to issue more than one command per handle at "
4257 #: ../src/guestfs.pod:2184
4259 "Finally, the child process sends asynchronous messages back to the main "
4260 "program, such as kernel log messages. You can register a callback to "
4261 "receive these messages."
4265 #: ../src/guestfs.pod:2188
4270 #: ../src/guestfs.pod:2190
4271 msgid "COMMUNICATION PROTOCOL"
4275 #: ../src/guestfs.pod:2192
4277 "Don't rely on using this protocol directly. This section documents how it "
4278 "currently works, but it may change at any time."
4282 #: ../src/guestfs.pod:2195
4284 "The protocol used to talk between the library and the daemon running inside "
4285 "the qemu virtual machine is a simple RPC mechanism built on top of XDR (RFC "
4286 "1014, RFC 1832, RFC 4506)."
4290 #: ../src/guestfs.pod:2199
4292 "The detailed format of structures is in C<src/guestfs_protocol.x> (note: "
4293 "this file is automatically generated)."
4297 #: ../src/guestfs.pod:2202
4299 "There are two broad cases, ordinary functions that don't have any C<FileIn> "
4300 "and C<FileOut> parameters, which are handled with very simple request/reply "
4301 "messages. Then there are functions that have any C<FileIn> or C<FileOut> "
4302 "parameters, which use the same request and reply messages, but they may also "
4303 "be followed by files sent using a chunked encoding."
4307 #: ../src/guestfs.pod:2209
4308 msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)"
4312 #: ../src/guestfs.pod:2211
4313 msgid "For ordinary functions, the request message is:"
4317 #: ../src/guestfs.pod:2213
4320 " total length (header + arguments,\n"
4321 " but not including the length word itself)\n"
4322 " struct guestfs_message_header (encoded as XDR)\n"
4323 " struct guestfs_<foo>_args (encoded as XDR)\n"
4328 #: ../src/guestfs.pod:2218
4330 "The total length field allows the daemon to allocate a fixed size buffer "
4331 "into which it slurps the rest of the message. As a result, the total length "
4332 "is limited to C<GUESTFS_MESSAGE_MAX> bytes (currently 4MB), which means the "
4333 "effective size of any request is limited to somewhere under this size."
4337 #: ../src/guestfs.pod:2224
4339 "Note also that many functions don't take any arguments, in which case the "
4340 "C<guestfs_I<foo>_args> is completely omitted."
4344 #: ../src/guestfs.pod:2227
4346 "The header contains the procedure number (C<guestfs_proc>) which is how the "
4347 "receiver knows what type of args structure to expect, or none at all."
4351 #: ../src/guestfs.pod:2231
4353 "For functions that take optional arguments, the optional arguments are "
4354 "encoded in the C<guestfs_I<foo>_args> structure in the same way as ordinary "
4355 "arguments. A bitmask in the header indicates which optional arguments are "
4356 "meaningful. The bitmask is also checked to see if it contains bits set "
4357 "which the daemon does not know about (eg. if more optional arguments were "
4358 "added in a later version of the library), and this causes the call to be "
4363 #: ../src/guestfs.pod:2239
4364 msgid "The reply message for ordinary functions is:"
4368 #: ../src/guestfs.pod:2241
4371 " total length (header + ret,\n"
4372 " but not including the length word itself)\n"
4373 " struct guestfs_message_header (encoded as XDR)\n"
4374 " struct guestfs_<foo>_ret (encoded as XDR)\n"
4379 #: ../src/guestfs.pod:2246
4381 "As above the C<guestfs_I<foo>_ret> structure may be completely omitted for "
4382 "functions that return no formal return values."
4386 #: ../src/guestfs.pod:2249
4388 "As above the total length of the reply is limited to C<GUESTFS_MESSAGE_MAX>."
4392 #: ../src/guestfs.pod:2252
4394 "In the case of an error, a flag is set in the header, and the reply message "
4395 "is slightly changed:"
4399 #: ../src/guestfs.pod:2255
4402 " total length (header + error,\n"
4403 " but not including the length word itself)\n"
4404 " struct guestfs_message_header (encoded as XDR)\n"
4405 " struct guestfs_message_error (encoded as XDR)\n"
4410 #: ../src/guestfs.pod:2260
4412 "The C<guestfs_message_error> structure contains the error message as a "
4417 #: ../src/guestfs.pod:2263
4418 msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS"
4422 #: ../src/guestfs.pod:2265
4424 "A C<FileIn> parameter indicates that we transfer a file I<into> the guest. "
4425 "The normal request message is sent (see above). However this is followed by "
4426 "a sequence of file chunks."
4430 #: ../src/guestfs.pod:2269
4433 " total length (header + arguments,\n"
4434 " but not including the length word itself,\n"
4435 " and not including the chunks)\n"
4436 " struct guestfs_message_header (encoded as XDR)\n"
4437 " struct guestfs_<foo>_args (encoded as XDR)\n"
4438 " sequence of chunks for FileIn param #0\n"
4439 " sequence of chunks for FileIn param #1 etc.\n"
4444 #: ../src/guestfs.pod:2277
4445 msgid "The \"sequence of chunks\" is:"
4449 #: ../src/guestfs.pod:2279
4452 " length of chunk (not including length word itself)\n"
4453 " struct guestfs_chunk (encoded as XDR)\n"
4454 " length of chunk\n"
4455 " struct guestfs_chunk (encoded as XDR)\n"
4457 " length of chunk\n"
4458 " struct guestfs_chunk (with data.data_len == 0)\n"
4463 #: ../src/guestfs.pod:2287
4465 "The final chunk has the C<data_len> field set to zero. Additionally a flag "
4466 "is set in the final chunk to indicate either successful completion or early "
4471 #: ../src/guestfs.pod:2291
4473 "At time of writing there are no functions that have more than one FileIn "
4474 "parameter. However this is (theoretically) supported, by sending the "
4475 "sequence of chunks for each FileIn parameter one after another (from left to "
4480 #: ../src/guestfs.pod:2296
4482 "Both the library (sender) I<and> the daemon (receiver) may cancel the "
4483 "transfer. The library does this by sending a chunk with a special flag set "
4484 "to indicate cancellation. When the daemon sees this, it cancels the whole "
4485 "RPC, does I<not> send any reply, and goes back to reading the next request."
4489 #: ../src/guestfs.pod:2302
4491 "The daemon may also cancel. It does this by writing a special word "
4492 "C<GUESTFS_CANCEL_FLAG> to the socket. The library listens for this during "
4493 "the transfer, and if it gets it, it will cancel the transfer (it sends a "
4494 "cancel chunk). The special word is chosen so that even if cancellation "
4495 "happens right at the end of the transfer (after the library has finished "
4496 "writing and has started listening for the reply), the \"spurious\" cancel "
4497 "flag will not be confused with the reply message."
4501 #: ../src/guestfs.pod:2311
4503 "This protocol allows the transfer of arbitrary sized files (no 32 bit "
4504 "limit), and also files where the size is not known in advance (eg. from "
4505 "pipes or sockets). However the chunks are rather small "
4506 "(C<GUESTFS_MAX_CHUNK_SIZE>), so that neither the library nor the daemon need "
4507 "to keep much in memory."
4511 #: ../src/guestfs.pod:2317
4512 msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS"
4516 #: ../src/guestfs.pod:2319
4518 "The protocol for FileOut parameters is exactly the same as for FileIn "
4519 "parameters, but with the roles of daemon and library reversed."
4523 #: ../src/guestfs.pod:2322
4526 " total length (header + ret,\n"
4527 " but not including the length word itself,\n"
4528 " and not including the chunks)\n"
4529 " struct guestfs_message_header (encoded as XDR)\n"
4530 " struct guestfs_<foo>_ret (encoded as XDR)\n"
4531 " sequence of chunks for FileOut param #0\n"
4532 " sequence of chunks for FileOut param #1 etc.\n"
4537 #: ../src/guestfs.pod:2330
4538 msgid "INITIAL MESSAGE"
4542 #: ../src/guestfs.pod:2332
4544 "When the daemon launches it sends an initial word (C<GUESTFS_LAUNCH_FLAG>) "
4545 "which indicates that the guest and daemon is alive. This is what L</"
4546 "guestfs_launch> waits for."
4550 #: ../src/guestfs.pod:2336
4551 msgid "PROGRESS NOTIFICATION MESSAGES"
4555 #: ../src/guestfs.pod:2338
4557 "The daemon may send progress notification messages at any time. These are "
4558 "distinguished by the normal length word being replaced by "
4559 "C<GUESTFS_PROGRESS_FLAG>, followed by a fixed size progress message."
4563 #: ../src/guestfs.pod:2342
4565 "The library turns them into progress callbacks (see L</"
4566 "GUESTFS_EVENT_PROGRESS>) if there is a callback registered, or discards them "
4571 #: ../src/guestfs.pod:2346
4573 "The daemon self-limits the frequency of progress messages it sends (see "
4574 "C<daemon/proto.c:notify_progress>). Not all calls generate progress "
4579 #: ../src/guestfs.pod:2350
4580 msgid "LIBGUESTFS VERSION NUMBERS"
4584 #: ../src/guestfs.pod:2352
4586 "Since April 2010, libguestfs has started to make separate development and "
4587 "stable releases, along with corresponding branches in our git repository. "
4588 "These separate releases can be identified by version number:"
4592 #: ../src/guestfs.pod:2357
4595 " even numbers for stable: 1.2.x, 1.4.x, ...\n"
4596 " .-------- odd numbers for development: 1.3.x, 1.5.x, ...\n"
4602 " | `-------- sub-version\n"
4604 " `------ always '1' because we don't change the ABI\n"
4609 #: ../src/guestfs.pod:2368
4610 msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"."
4614 #: ../src/guestfs.pod:2370
4616 "As time passes we cherry pick fixes from the development branch and backport "
4617 "those into the stable branch, the effect being that the stable branch should "
4618 "get more stable and less buggy over time. So the stable releases are ideal "
4619 "for people who don't need new features but would just like the software to "
4624 #: ../src/guestfs.pod:2376
4625 msgid "Our criteria for backporting changes are:"
4629 #: ../src/guestfs.pod:2382
4631 "Documentation changes which don't affect any code are backported unless the "
4632 "documentation refers to a future feature which is not in stable."
4636 #: ../src/guestfs.pod:2388
4638 "Bug fixes which are not controversial, fix obvious problems, and have been "
4639 "well tested are backported."
4643 #: ../src/guestfs.pod:2393
4645 "Simple rearrangements of code which shouldn't affect how it works get "
4646 "backported. This is so that the code in the two branches doesn't get too "
4647 "far out of step, allowing us to backport future fixes more easily."
4651 #: ../src/guestfs.pod:2399
4653 "We I<don't> backport new features, new APIs, new tools etc, except in one "
4654 "exceptional case: the new feature is required in order to implement an "
4655 "important bug fix."
4659 #: ../src/guestfs.pod:2405
4661 "A new stable branch starts when we think the new features in development are "
4662 "substantial and compelling enough over the current stable branch to warrant "
4663 "it. When that happens we create new stable and development versions 1.N.0 "
4664 "and 1.(N+1).0 [N is even]. The new dot-oh release won't necessarily be so "
4665 "stable at this point, but by backporting fixes from development, that branch "
4666 "will stabilize over time."
4670 #: ../src/guestfs.pod:2413
4671 msgid "EXTENDING LIBGUESTFS"
4675 #: ../src/guestfs.pod:2415
4676 msgid "ADDING A NEW API ACTION"
4680 #: ../src/guestfs.pod:2417
4682 "Large amounts of boilerplate code in libguestfs (RPC, bindings, "
4683 "documentation) are generated, and this makes it easy to extend the "
4688 #: ../src/guestfs.pod:2421
4689 msgid "To add a new API action there are two changes:"
4693 #: ../src/guestfs.pod:2427
4695 "You need to add a description of the call (name, parameters, return type, "
4696 "tests, documentation) to C<generator/generator_actions.ml>."
4700 #: ../src/guestfs.pod:2430
4702 "There are two sorts of API action, depending on whether the call goes "
4703 "through to the daemon in the appliance, or is serviced entirely by the "
4704 "library (see L</ARCHITECTURE> above). L</guestfs_sync> is an example of the "
4705 "former, since the sync is done in the appliance. L</guestfs_set_trace> is "
4706 "an example of the latter, since a trace flag is maintained in the handle and "
4707 "all tracing is done on the library side."
4711 #: ../src/guestfs.pod:2438
4713 "Most new actions are of the first type, and get added to the "
4714 "C<daemon_functions> list. Each function has a unique procedure number used "
4715 "in the RPC protocol which is assigned to that action when we publish "
4716 "libguestfs and cannot be reused. Take the latest procedure number and "
4721 #: ../src/guestfs.pod:2444
4723 "For library-only actions of the second type, add to the "
4724 "C<non_daemon_functions> list. Since these functions are serviced by the "
4725 "library and do not travel over the RPC mechanism to the daemon, these "
4726 "functions do not need a procedure number, and so the procedure number is set "
4731 #: ../src/guestfs.pod:2452
4732 msgid "Implement the action (in C):"
4736 #: ../src/guestfs.pod:2454
4738 "For daemon actions, implement the function C<do_E<lt>nameE<gt>> in the "
4739 "C<daemon/> directory."
4743 #: ../src/guestfs.pod:2457
4745 "For library actions, implement the function C<guestfs__E<lt>nameE<gt>> "
4746 "(note: double underscore) in the C<src/> directory."
4750 #: ../src/guestfs.pod:2460
4751 msgid "In either case, use another function as an example of what to do."
4755 #: ../src/guestfs.pod:2464
4756 msgid "After making these changes, use C<make> to compile."
4760 #: ../src/guestfs.pod:2466
4762 "Note that you don't need to implement the RPC, language bindings, manual "
4763 "pages or anything else. It's all automatically generated from the OCaml "
4768 #: ../src/guestfs.pod:2470
4769 msgid "ADDING TESTS FOR AN API ACTION"
4773 #: ../src/guestfs.pod:2472
4775 "You can supply zero or as many tests as you want per API call. The tests "
4776 "can either be added as part of the API description (C<generator/"
4777 "generator_actions.ml>), or in some rarer cases you may want to drop a script "
4778 "into C<regressions/>. Note that adding a script to C<regressions/> is "
4779 "slower, so if possible use the first method."
4783 #: ../src/guestfs.pod:2478
4785 "The following describes the test environment used when you add an API test "
4786 "in C<generator_actions.ml>."
4790 #: ../src/guestfs.pod:2481
4791 msgid "The test environment has 4 block devices:"
4795 #: ../src/guestfs.pod:2485
4796 msgid "C</dev/sda> 500MB"
4800 #: ../src/guestfs.pod:2487
4801 msgid "General block device for testing."
4805 #: ../src/guestfs.pod:2489
4806 msgid "C</dev/sdb> 50MB"
4810 #: ../src/guestfs.pod:2491
4812 "C</dev/sdb1> is an ext2 filesystem used for testing filesystem write "
4817 #: ../src/guestfs.pod:2494
4818 msgid "C</dev/sdc> 10MB"
4822 #: ../src/guestfs.pod:2496
4823 msgid "Used in a few tests where two block devices are needed."
4827 #: ../src/guestfs.pod:2498
4829 msgstr "C</dev/sdd>"
4832 #: ../src/guestfs.pod:2500
4833 msgid "ISO with fixed content (see C<images/test.iso>)."
4837 #: ../src/guestfs.pod:2504
4839 "To be able to run the tests in a reasonable amount of time, the libguestfs "
4840 "appliance and block devices are reused between tests. So don't try testing "
4841 "L</guestfs_kill_subprocess> :-x"
4845 #: ../src/guestfs.pod:2508
4847 "Each test starts with an initial scenario, selected using one of the "
4848 "C<Init*> expressions, described in C<generator/generator_types.ml>. These "
4849 "initialize the disks mentioned above in a particular way as documented in "
4850 "C<generator_types.ml>. You should not assume anything about the previous "
4851 "contents of other disks that are not initialized."
4855 #: ../src/guestfs.pod:2514
4857 "You can add a prerequisite clause to any individual test. This is a run-"
4858 "time check, which, if it fails, causes the test to be skipped. Useful if "
4859 "testing a command which might not work on all variations of libguestfs "
4860 "builds. A test that has prerequisite of C<Always> means to run "
4865 #: ../src/guestfs.pod:2520
4867 "In addition, packagers can skip individual tests by setting environment "
4868 "variables before running C<make check>."
4872 #: ../src/guestfs.pod:2523
4875 " SKIP_TEST_<CMD>_<NUM>=1\n"
4880 #: ../src/guestfs.pod:2525
4881 msgid "eg: C<SKIP_TEST_COMMAND_3=1> skips test #3 of L</guestfs_command>."
4885 #: ../src/guestfs.pod:2527
4890 #: ../src/guestfs.pod:2529
4893 " SKIP_TEST_<CMD>=1\n"
4898 #: ../src/guestfs.pod:2531
4899 msgid "eg: C<SKIP_TEST_ZEROFREE=1> skips all L</guestfs_zerofree> tests."
4903 #: ../src/guestfs.pod:2533
4904 msgid "Packagers can run only certain tests by setting for example:"
4908 #: ../src/guestfs.pod:2535
4911 " TEST_ONLY=\"vfs_type zerofree\"\n"
4916 #: ../src/guestfs.pod:2537
4918 "See C<capitests/tests.c> for more details of how these environment variables "
4923 #: ../src/guestfs.pod:2540
4924 msgid "DEBUGGING NEW API ACTIONS"
4928 #: ../src/guestfs.pod:2542
4929 msgid "Test new actions work before submitting them."
4933 #: ../src/guestfs.pod:2544
4934 msgid "You can use guestfish to try out new commands."
4938 #: ../src/guestfs.pod:2546
4940 "Debugging the daemon is a problem because it runs inside a minimal "
4941 "environment. However you can fprintf messages in the daemon to stderr, and "
4942 "they will show up if you use C<guestfish -v>."
4946 #: ../src/guestfs.pod:2550
4947 msgid "FORMATTING CODE AND OTHER CONVENTIONS"
4951 #: ../src/guestfs.pod:2552
4953 "Our C source code generally adheres to some basic code-formatting "
4954 "conventions. The existing code base is not totally consistent on this "
4955 "front, but we do prefer that contributed code be formatted similarly. In "
4956 "short, use spaces-not-TABs for indentation, use 2 spaces for each "
4957 "indentation level, and other than that, follow the K&R style."
4961 #: ../src/guestfs.pod:2558
4963 "If you use Emacs, add the following to one of one of your start-up files (e."
4964 "g., ~/.emacs), to help ensure that you get indentation right:"
4968 #: ../src/guestfs.pod:2561
4971 " ;;; In libguestfs, indent with spaces everywhere (not TABs).\n"
4972 " ;;; Exceptions: Makefile and ChangeLog modes.\n"
4973 " (add-hook 'find-file-hook\n"
4974 " '(lambda () (if (and buffer-file-name\n"
4975 " (string-match \"/libguestfs\\\\>\"\n"
4976 " (buffer-file-name))\n"
4977 " (not (string-equal mode-name \"Change Log\"))\n"
4978 " (not (string-equal mode-name \"Makefile\")))\n"
4979 " (setq indent-tabs-mode nil))))\n"
4984 #: ../src/guestfs.pod:2571
4987 " ;;; When editing C sources in libguestfs, use this style.\n"
4988 " (defun libguestfs-c-mode ()\n"
4989 " \"C mode with adjusted defaults for use with libguestfs.\"\n"
4991 " (c-set-style \"K&R\")\n"
4992 " (setq c-indent-level 2)\n"
4993 " (setq c-basic-offset 2))\n"
4994 " (add-hook 'c-mode-hook\n"
4995 " '(lambda () (if (string-match \"/libguestfs\\\\>\"\n"
4996 " (buffer-file-name))\n"
4997 " (libguestfs-c-mode))))\n"
5002 #: ../src/guestfs.pod:2583
5003 msgid "Enable warnings when compiling (and fix any problems this finds):"
5007 #: ../src/guestfs.pod:2586
5010 " ./configure --enable-gcc-warnings\n"
5015 #: ../src/guestfs.pod:2588
5016 msgid "Useful targets are:"
5020 #: ../src/guestfs.pod:2590
5023 " make syntax-check # checks the syntax of the C code\n"
5024 " make check # runs the test suite\n"
5029 #: ../src/guestfs.pod:2593
5030 msgid "DAEMON CUSTOM PRINTF FORMATTERS"
5034 #: ../src/guestfs.pod:2595
5036 "In the daemon code we have created custom printf formatters C<%Q> and C<%R>, "
5037 "which are used to do shell quoting."
5041 #: ../src/guestfs.pod:2600
5046 #: ../src/guestfs.pod:2602
5048 "Simple shell quoted string. Any spaces or other shell characters are "
5053 #: ../src/guestfs.pod:2605
5058 #: ../src/guestfs.pod:2607
5060 "Same as C<%Q> except the string is treated as a path which is prefixed by "
5065 #: ../src/guestfs.pod:2612 ../fish/guestfish.pod:240 ../fish/guestfish.pod:613
5066 msgid "For example:"
5070 #: ../src/guestfs.pod:2614
5073 " asprintf (&cmd, \"cat %R\", path);\n"
5078 #: ../src/guestfs.pod:2616
5079 msgid "would produce C<cat /sysroot/some\\ path\\ with\\ spaces>"
5083 #: ../src/guestfs.pod:2618
5085 "I<Note:> Do I<not> use these when you are passing parameters to the C<command"
5086 "{,r,v,rv}()> functions. These parameters do NOT need to be quoted because "
5087 "they are not passed via the shell (instead, straight to exec). You probably "
5088 "want to use the C<sysroot_path()> function however."
5092 #: ../src/guestfs.pod:2624
5093 msgid "SUBMITTING YOUR NEW API ACTIONS"
5097 #: ../src/guestfs.pod:2626
5099 "Submit patches to the mailing list: L<http://www.redhat.com/mailman/listinfo/"
5100 "libguestfs> and CC to L<rjones@redhat.com>."
5104 #: ../src/guestfs.pod:2630
5105 msgid "INTERNATIONALIZATION (I18N) SUPPORT"
5109 #: ../src/guestfs.pod:2632
5110 msgid "We support i18n (gettext anyhow) in the library."
5114 #: ../src/guestfs.pod:2634
5116 "However many messages come from the daemon, and we don't translate those at "
5117 "the moment. One reason is that the appliance generally has all locale files "
5118 "removed from it, because they take up a lot of space. So we'd have to readd "
5119 "some of those, as well as copying our PO files into the appliance."
5123 #: ../src/guestfs.pod:2640
5125 "Debugging messages are never translated, since they are intended for the "
5130 #: ../src/guestfs.pod:2643
5131 msgid "SOURCE CODE SUBDIRECTORIES"
5135 #: ../src/guestfs.pod:2647 ../src/guestfs-actions.pod:5832
5136 #: ../fish/guestfish-actions.pod:3926
5137 msgid "C<appliance>"
5138 msgstr "C<appliance>"
5141 #: ../src/guestfs.pod:2649
5142 msgid "The libguestfs appliance, build scripts and so on."
5146 #: ../src/guestfs.pod:2651
5147 msgid "C<capitests>"
5148 msgstr "C<capitests>"
5151 #: ../src/guestfs.pod:2653
5152 msgid "Automated tests of the C API."
5156 #: ../src/guestfs.pod:2655
5161 #: ../src/guestfs.pod:2657
5163 "The L<virt-cat(1)>, L<virt-filesystems(1)> and L<virt-ls(1)> commands and "
5168 #: ../src/guestfs.pod:2660
5175 #: ../src/guestfs.pod:2662
5177 "Safety and liveness tests of components that libguestfs depends upon (not of "
5178 "libguestfs itself). Mainly this is for qemu and the kernel."
5182 #: ../src/guestfs.pod:2665
5187 #: ../src/guestfs.pod:2667
5188 msgid "Outside contributions, experimental parts."
5192 #: ../src/guestfs.pod:2669
5197 #: ../src/guestfs.pod:2671
5199 "The daemon that runs inside the libguestfs appliance and carries out actions."
5203 #: ../src/guestfs.pod:2674
5208 #: ../src/guestfs.pod:2676
5209 msgid "L<virt-df(1)> command and documentation."
5213 #: ../src/guestfs.pod:2678
5215 msgstr "C<examples>"
5218 #: ../src/guestfs.pod:2680
5219 msgid "C API example code."
5220 msgstr "Код прикладів використання програмного інтерфейсу мовою C."
5223 #: ../src/guestfs.pod:2682
5228 #: ../src/guestfs.pod:2684
5230 "L<guestfish(1)>, the command-line shell, and various shell scripts built on "
5231 "top such as L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, "
5232 "L<virt-tar-out(1)>."
5236 #: ../src/guestfs.pod:2688
5241 #: ../src/guestfs.pod:2690
5243 "L<guestmount(1)>, FUSE (userspace filesystem) built on top of libguestfs."
5247 #: ../src/guestfs.pod:2692
5248 msgid "C<generator>"
5249 msgstr "C<generator>"
5252 #: ../src/guestfs.pod:2694
5254 "The crucially important generator, used to automatically generate large "
5255 "amounts of boilerplate C code for things like RPC and bindings."
5259 #: ../src/guestfs.pod:2697
5264 #: ../src/guestfs.pod:2699
5265 msgid "Files used by the test suite."
5269 #: ../src/guestfs.pod:2701
5270 msgid "Some \"phony\" guest images which we test against."
5274 #: ../src/guestfs.pod:2703
5275 msgid "C<inspector>"
5276 msgstr "C<inspector>"
5279 #: ../src/guestfs.pod:2705
5280 msgid "L<virt-inspector(1)>, the virtual machine image inspector."
5284 #: ../src/guestfs.pod:2707
5289 #: ../src/guestfs.pod:2709
5290 msgid "Logo used on the website. The fish is called Arthur by the way."
5294 #: ../src/guestfs.pod:2711
5299 #: ../src/guestfs.pod:2713
5300 msgid "M4 macros used by autoconf."
5304 #: ../src/guestfs.pod:2715
5309 #: ../src/guestfs.pod:2717
5310 msgid "Translations of simple gettext strings."
5311 msgstr "Переклади простих рядків gettext."
5314 #: ../src/guestfs.pod:2719
5319 #: ../src/guestfs.pod:2721
5321 "The build infrastructure and PO files for translations of manpages and POD "
5322 "files. Eventually this will be combined with the C<po> directory, but that "
5323 "is rather complicated."
5327 #: ../src/guestfs.pod:2725
5328 msgid "C<regressions>"
5329 msgstr "C<regressions>"
5332 #: ../src/guestfs.pod:2727
5333 msgid "Regression tests."
5334 msgstr "Тести на регресії."
5337 #: ../src/guestfs.pod:2729
5342 #: ../src/guestfs.pod:2731
5343 msgid "L<virt-rescue(1)> command and documentation."
5347 #: ../src/guestfs.pod:2733
5352 #: ../src/guestfs.pod:2735
5353 msgid "Source code to the C library."
5357 #: ../src/guestfs.pod:2737
5362 #: ../src/guestfs.pod:2739
5363 msgid "Command line tools written in Perl (L<virt-resize(1)> and many others)."
5367 #: ../src/guestfs.pod:2741
5368 msgid "C<test-tool>"
5369 msgstr "C<test-tool>"
5372 #: ../src/guestfs.pod:2743
5374 "Test tool for end users to test if their qemu/kernel combination will work "
5379 #: ../src/guestfs.pod:2746
5384 #: ../src/guestfs.pod:2748
5389 #: ../src/guestfs.pod:2750
5394 #: ../src/guestfs.pod:2752
5399 #: ../src/guestfs.pod:2754
5404 #: ../src/guestfs.pod:2756
5409 #: ../src/guestfs.pod:2758
5414 #: ../src/guestfs.pod:2760
5419 #: ../src/guestfs.pod:2762
5420 msgid "Language bindings."
5421 msgstr "Прив’язки до мов програмування."
5424 #: ../src/guestfs.pod:2766
5429 #: ../src/guestfs.pod:2768
5430 msgid "PROTOCOL LIMITS"
5434 #: ../src/guestfs.pod:2770
5436 "Internally libguestfs uses a message-based protocol to pass API calls and "
5437 "their responses to and from a small \"appliance\" (see L</INTERNALS> for "
5438 "plenty more detail about this). The maximum message size used by the "
5439 "protocol is slightly less than 4 MB. For some API calls you may need to be "
5440 "aware of this limit. The API calls which may be affected are individually "
5441 "documented, with a link back to this section of the documentation."
5445 #: ../src/guestfs.pod:2778
5447 "A simple call such as L</guestfs_cat> returns its result (the file data) in "
5448 "a simple string. Because this string is at some point internally encoded as "
5449 "a message, the maximum size that it can return is slightly under 4 MB. If "
5450 "the requested file is larger than this then you will get an error."
5454 #: ../src/guestfs.pod:2784
5456 "In order to transfer large files into and out of the guest filesystem, you "
5457 "need to use particular calls that support this. The sections L</UPLOADING> "
5458 "and L</DOWNLOADING> document how to do this."
5462 #: ../src/guestfs.pod:2788
5464 "You might also consider mounting the disk image using our FUSE filesystem "
5465 "support (L<guestmount(1)>)."
5469 #: ../src/guestfs.pod:2791
5470 msgid "MAXIMUM NUMBER OF DISKS"
5474 #: ../src/guestfs.pod:2793
5475 msgid "When using virtio disks (the default) the current limit is B<25> disks."
5479 #: ../src/guestfs.pod:2796
5481 "Virtio itself consumes 1 virtual PCI slot per disk, and PCI is limited to 31 "
5482 "slots. However febootstrap only understands disks with names C</dev/vda> "
5483 "through C</dev/vdz> (26 letters) and it reserves one disk for its own "
5488 #: ../src/guestfs.pod:2801
5490 "We are working to substantially raise this limit in future versions but it "
5491 "requires complex changes to qemu."
5495 #: ../src/guestfs.pod:2804
5497 "In future versions of libguestfs it should also be possible to \"hot plug\" "
5498 "disks (add and remove disks after calling L</guestfs_launch>). This also "
5499 "requires changes to qemu."
5503 #: ../src/guestfs.pod:2808
5504 msgid "MAXIMUM NUMBER OF PARTITIONS PER DISK"
5508 #: ../src/guestfs.pod:2810
5509 msgid "Virtio limits the maximum number of partitions per disk to B<15>."
5513 #: ../src/guestfs.pod:2812
5515 "This is because it reserves 4 bits for the minor device number (thus C</dev/"
5516 "vda>, and C</dev/vda1> through C</dev/vda15>)."
5520 #: ../src/guestfs.pod:2815
5522 "If you attach a disk with more than 15 partitions, the extra partitions are "
5523 "ignored by libguestfs."
5527 #: ../src/guestfs.pod:2818
5528 msgid "MAXIMUM SIZE OF A DISK"
5532 #: ../src/guestfs.pod:2820
5533 msgid "Probably the limit is between 2**63-1 and 2**64-1 bytes."
5537 #: ../src/guestfs.pod:2822
5539 "We have tested block devices up to 1 exabyte (2**60 or "
5540 "1,152,921,504,606,846,976 bytes) using sparse files backed by an XFS host "
5545 #: ../src/guestfs.pod:2826
5547 "Although libguestfs probably does not impose any limit, the underlying host "
5548 "storage will. If you store disk images on a host ext4 filesystem, then the "
5549 "maximum size will be limited by the maximum ext4 file size (currently 16 "
5550 "TB). If you store disk images as host logical volumes then you are limited "
5551 "by the maximum size of an LV."
5555 #: ../src/guestfs.pod:2832
5557 "For the hugest disk image files, we recommend using XFS on the host for "
5562 #: ../src/guestfs.pod:2835
5563 msgid "MAXIMUM SIZE OF A PARTITION"
5567 #: ../src/guestfs.pod:2837
5569 "The MBR (ie. classic MS-DOS) partitioning scheme uses 32 bit sector "
5570 "numbers. Assuming a 512 byte sector size, this means that MBR cannot "
5571 "address a partition located beyond 2 TB on the disk."
5575 #: ../src/guestfs.pod:2841
5577 "It is recommended that you use GPT partitions on disks which are larger than "
5578 "this size. GPT uses 64 bit sector numbers and so can address partitions "
5579 "which are theoretically larger than the largest disk we could support."
5583 #: ../src/guestfs.pod:2846
5584 msgid "MAXIMUM SIZE OF A FILESYSTEM, FILES, DIRECTORIES"
5588 #: ../src/guestfs.pod:2848
5590 "This depends on the filesystem type. libguestfs itself does not impose any "
5591 "known limit. Consult Wikipedia or the filesystem documentation to find out "
5592 "what these limits are."
5596 #: ../src/guestfs.pod:2852
5597 msgid "MAXIMUM UPLOAD AND DOWNLOAD"
5601 #: ../src/guestfs.pod:2854
5603 "The API functions L</guestfs_upload>, L</guestfs_download>, L</"
5604 "guestfs_tar_in>, L</guestfs_tar_out> and the like allow unlimited sized "
5605 "uploads and downloads."
5609 #: ../src/guestfs.pod:2858
5611 #| msgid "INSPECTION"
5612 msgid "INSPECTION LIMITS"
5616 #: ../src/guestfs.pod:2860
5618 "The inspection code has several arbitrary limits on things like the size of "
5619 "Windows Registry hive it will read, and the length of product name. These "
5620 "are intended to stop a malicious guest from consuming arbitrary amounts of "
5621 "memory and disk space on the host, and should not be reached in practice. "
5622 "See the source code for more information."
5626 #: ../src/guestfs.pod:2866 ../fish/guestfish.pod:1026
5627 #: ../test-tool/libguestfs-test-tool.pod:82 ../tools/virt-edit.pl:476
5628 msgid "ENVIRONMENT VARIABLES"
5629 msgstr "ЗМІННІ СЕРЕДОВИЩА"
5632 #: ../src/guestfs.pod:2870 ../fish/guestfish.pod:1052
5633 msgid "LIBGUESTFS_APPEND"
5637 #: ../src/guestfs.pod:2872 ../fish/guestfish.pod:1054
5638 msgid "Pass additional options to the guest kernel."
5642 #: ../src/guestfs.pod:2874 ../fish/guestfish.pod:1056
5643 msgid "LIBGUESTFS_DEBUG"
5647 #: ../src/guestfs.pod:2876
5649 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
5650 "effect as calling C<guestfs_set_verbose (g, 1)>."
5654 #: ../src/guestfs.pod:2879 ../fish/guestfish.pod:1061
5655 msgid "LIBGUESTFS_MEMSIZE"
5659 #: ../src/guestfs.pod:2881 ../fish/guestfish.pod:1063
5661 "Set the memory allocated to the qemu process, in megabytes. For example:"
5665 #: ../src/guestfs.pod:2884 ../fish/guestfish.pod:1066
5668 " LIBGUESTFS_MEMSIZE=700\n"
5673 #: ../src/guestfs.pod:2886 ../fish/guestfish.pod:1068
5674 msgid "LIBGUESTFS_PATH"
5678 #: ../src/guestfs.pod:2888
5680 "Set the path that libguestfs uses to search for a supermin appliance. See "
5681 "the discussion of paths in section L</PATH> above."
5685 #: ../src/guestfs.pod:2891 ../fish/guestfish.pod:1073
5686 msgid "LIBGUESTFS_QEMU"
5690 #: ../src/guestfs.pod:2893 ../fish/guestfish.pod:1075
5692 "Set the default qemu binary that libguestfs uses. If not set, then the qemu "
5693 "which was found at compile time by the configure script is used."
5697 #: ../src/guestfs.pod:2897
5698 msgid "See also L</QEMU WRAPPERS> above."
5702 #: ../src/guestfs.pod:2899 ../fish/guestfish.pod:1079
5703 msgid "LIBGUESTFS_TRACE"
5707 #: ../src/guestfs.pod:2901
5709 "Set C<LIBGUESTFS_TRACE=1> to enable command traces. This has the same "
5710 "effect as calling C<guestfs_set_trace (g, 1)>."
5714 #: ../src/guestfs.pod:2904 ../fish/guestfish.pod:1088
5719 #: ../src/guestfs.pod:2906 ../fish/guestfish.pod:1090
5721 "Location of temporary directory, defaults to C</tmp> except for the cached "
5722 "supermin appliance which defaults to C</var/tmp>."
5726 #: ../src/guestfs.pod:2909 ../fish/guestfish.pod:1093
5728 "If libguestfs was compiled to use the supermin appliance then the real "
5729 "appliance is cached in this directory, shared between all handles belonging "
5730 "to the same EUID. You can use C<$TMPDIR> to configure another directory to "
5731 "use in case C</var/tmp> is not large enough."
5735 #: ../src/guestfs.pod:2917 ../fish/guestfish.pod:1160
5736 #: ../test-tool/libguestfs-test-tool.pod:87 ../fuse/guestmount.pod:277
5737 #: ../tools/virt-edit.pl:496 ../tools/virt-win-reg.pl:572
5738 #: ../tools/virt-list-filesystems.pl:189 ../tools/virt-tar.pl:286
5739 #: ../tools/virt-make-fs.pl:539 ../tools/virt-list-partitions.pl:257
5741 msgstr "ТАКОЖ ПЕРЕГЛЯНЬТЕ"
5744 #: ../src/guestfs.pod:2919
5746 "L<guestfs-examples(3)>, L<guestfs-ocaml(3)>, L<guestfs-perl(3)>, L<guestfs-"
5747 "python(3)>, L<guestfs-ruby(3)>, L<guestfish(1)>, L<guestmount(1)>, L<virt-cat"
5748 "(1)>, L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)"
5749 ">, L<virt-filesystems(1)>, L<virt-inspector(1)>, L<virt-list-filesystems(1)"
5750 ">, L<virt-list-partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, L<virt-"
5751 "rescue(1)>, L<virt-tar(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<virt-"
5752 "win-reg(1)>, L<qemu(1)>, L<febootstrap(1)>, L<hivex(3)>, L<http://libguestfs."
5757 #: ../src/guestfs.pod:2947
5759 "Tools with a similar purpose: L<fdisk(8)>, L<parted(8)>, L<kpartx(8)>, L<lvm"
5760 "(8)>, L<disktype(1)>."
5764 #: ../src/guestfs.pod:2954 ../tools/virt-win-reg.pl:587
5765 #: ../tools/virt-make-fs.pl:553
5770 #: ../src/guestfs.pod:2956
5771 msgid "To get a list of bugs against libguestfs use this link:"
5773 "Щоб переглянути список відомих вад у libguestfs, скористайтеся таким "
5777 #: ../src/guestfs.pod:2958
5779 "L<https://bugzilla.redhat.com/buglist.cgi?"
5780 "component=libguestfs&product=Virtualization+Tools>"
5782 "L<https://bugzilla.redhat.com/buglist.cgi?"
5783 "component=libguestfs&product=Virtualization+Tools>"
5786 #: ../src/guestfs.pod:2960
5787 msgid "To report a new bug against libguestfs use this link:"
5788 msgstr "Для звітування щодо вад у libguestfs скористайтеся цим посиланням:"
5791 #: ../src/guestfs.pod:2962
5793 "L<https://bugzilla.redhat.com/enter_bug.cgi?"
5794 "component=libguestfs&product=Virtualization+Tools>"
5796 "L<https://bugzilla.redhat.com/enter_bug.cgi?"
5797 "component=libguestfs&product=Virtualization+Tools>"
5800 #: ../src/guestfs.pod:2964
5801 msgid "When reporting a bug, please check:"
5805 #: ../src/guestfs.pod:2970
5806 msgid "That the bug hasn't been reported already."
5810 #: ../src/guestfs.pod:2974
5811 msgid "That you are testing a recent version."
5815 #: ../src/guestfs.pod:2978
5816 msgid "Describe the bug accurately, and give a way to reproduce it."
5820 #: ../src/guestfs.pod:2982
5822 "Run libguestfs-test-tool and paste the B<complete, unedited> output into the "
5827 #: ../src/guestfs.pod:2987 ../fish/guestfish.pod:1183
5828 #: ../test-tool/libguestfs-test-tool.pod:93 ../fuse/guestmount.pod:288
5833 #: ../src/guestfs.pod:2989 ../fish/guestfish.pod:1185
5834 #: ../test-tool/libguestfs-test-tool.pod:95 ../fuse/guestmount.pod:290
5835 msgid "Richard W.M. Jones (C<rjones at redhat dot com>)"
5839 #: ../src/guestfs.pod:2991 ../fish/guestfish.pod:1187
5840 #: ../test-tool/libguestfs-test-tool.pod:97 ../fuse/guestmount.pod:292
5841 #: ../tools/virt-edit.pl:514 ../tools/virt-win-reg.pl:602
5842 #: ../tools/virt-list-filesystems.pl:206 ../tools/virt-tar.pl:305
5843 #: ../tools/virt-make-fs.pl:568 ../tools/virt-list-partitions.pl:273
5845 msgstr "АВТОРСЬКІ ПРАВА"
5848 #: ../src/guestfs.pod:2993 ../fish/guestfish.pod:1189
5849 #: ../test-tool/libguestfs-test-tool.pod:99
5850 msgid "Copyright (C) 2009-2011 Red Hat Inc. L<http://libguestfs.org/>"
5854 #: ../src/guestfs.pod:2996
5856 "This library is free software; you can redistribute it and/or modify it "
5857 "under the terms of the GNU Lesser General Public License as published by the "
5858 "Free Software Foundation; either version 2 of the License, or (at your "
5859 "option) any later version."
5863 #: ../src/guestfs.pod:3001
5865 "This library is distributed in the hope that it will be useful, but WITHOUT "
5866 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
5867 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License "
5872 #: ../src/guestfs.pod:3006
5874 "You should have received a copy of the GNU Lesser General Public License "
5875 "along with this library; if not, write to the Free Software Foundation, "
5876 "Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA"
5880 #: ../src/guestfs-actions.pod:1
5881 msgid "guestfs_add_cdrom"
5885 #: ../src/guestfs-actions.pod:3
5889 " guestfs_add_cdrom (guestfs_h *g,\n"
5890 " const char *filename);\n"
5895 #: ../src/guestfs-actions.pod:7 ../fish/guestfish-actions.pod:5
5896 msgid "This function adds a virtual CD-ROM disk image to the guest."
5900 #: ../src/guestfs-actions.pod:9 ../fish/guestfish-actions.pod:7
5901 msgid "This is equivalent to the qemu parameter I<-cdrom filename>."
5905 #: ../src/guestfs-actions.pod:17
5907 "This call checks for the existence of C<filename>. This stops you from "
5908 "specifying other types of drive which are supported by qemu such as C<nbd:> "
5909 "and C<http:> URLs. To specify those, use the general C<guestfs_config> call "
5914 #: ../src/guestfs-actions.pod:24
5916 "If you just want to add an ISO file (often you use this as an efficient way "
5917 "to transfer large files into the guest), then you should probably use "
5918 "C<guestfs_add_drive_ro> instead."
5922 #: ../src/guestfs-actions.pod:30 ../src/guestfs-actions.pod:134
5923 #: ../src/guestfs-actions.pod:195 ../src/guestfs-actions.pod:232
5924 #: ../src/guestfs-actions.pod:246 ../src/guestfs-actions.pod:267
5925 #: ../src/guestfs-actions.pod:287 ../src/guestfs-actions.pod:301
5926 #: ../src/guestfs-actions.pod:421 ../src/guestfs-actions.pod:441
5927 #: ../src/guestfs-actions.pod:455 ../src/guestfs-actions.pod:500
5928 #: ../src/guestfs-actions.pod:528 ../src/guestfs-actions.pod:546
5929 #: ../src/guestfs-actions.pod:613 ../src/guestfs-actions.pod:646
5930 #: ../src/guestfs-actions.pod:660 ../src/guestfs-actions.pod:675
5931 #: ../src/guestfs-actions.pod:774 ../src/guestfs-actions.pod:792
5932 #: ../src/guestfs-actions.pod:806 ../src/guestfs-actions.pod:820
5933 #: ../src/guestfs-actions.pod:981 ../src/guestfs-actions.pod:1001
5934 #: ../src/guestfs-actions.pod:1019 ../src/guestfs-actions.pod:1103
5935 #: ../src/guestfs-actions.pod:1121 ../src/guestfs-actions.pod:1140
5936 #: ../src/guestfs-actions.pod:1154 ../src/guestfs-actions.pod:1174
5937 #: ../src/guestfs-actions.pod:1244 ../src/guestfs-actions.pod:1275
5938 #: ../src/guestfs-actions.pod:1300 ../src/guestfs-actions.pod:1342
5939 #: ../src/guestfs-actions.pod:1448 ../src/guestfs-actions.pod:1482
5940 #: ../src/guestfs-actions.pod:1697 ../src/guestfs-actions.pod:1719
5941 #: ../src/guestfs-actions.pod:1806 ../src/guestfs-actions.pod:2268
5942 #: ../src/guestfs-actions.pod:2412 ../src/guestfs-actions.pod:2473
5943 #: ../src/guestfs-actions.pod:2508 ../src/guestfs-actions.pod:3461
5944 #: ../src/guestfs-actions.pod:3476 ../src/guestfs-actions.pod:3501
5945 #: ../src/guestfs-actions.pod:3656 ../src/guestfs-actions.pod:3670
5946 #: ../src/guestfs-actions.pod:3683 ../src/guestfs-actions.pod:3697
5947 #: ../src/guestfs-actions.pod:3712 ../src/guestfs-actions.pod:3748
5948 #: ../src/guestfs-actions.pod:3820 ../src/guestfs-actions.pod:3840
5949 #: ../src/guestfs-actions.pod:3857 ../src/guestfs-actions.pod:3880
5950 #: ../src/guestfs-actions.pod:3903 ../src/guestfs-actions.pod:3935
5951 #: ../src/guestfs-actions.pod:3954 ../src/guestfs-actions.pod:3973
5952 #: ../src/guestfs-actions.pod:4008 ../src/guestfs-actions.pod:4020
5953 #: ../src/guestfs-actions.pod:4056 ../src/guestfs-actions.pod:4072
5954 #: ../src/guestfs-actions.pod:4085 ../src/guestfs-actions.pod:4100
5955 #: ../src/guestfs-actions.pod:4117 ../src/guestfs-actions.pod:4210
5956 #: ../src/guestfs-actions.pod:4230 ../src/guestfs-actions.pod:4243
5957 #: ../src/guestfs-actions.pod:4294 ../src/guestfs-actions.pod:4312
5958 #: ../src/guestfs-actions.pod:4330 ../src/guestfs-actions.pod:4346
5959 #: ../src/guestfs-actions.pod:4360 ../src/guestfs-actions.pod:4374
5960 #: ../src/guestfs-actions.pod:4391 ../src/guestfs-actions.pod:4406
5961 #: ../src/guestfs-actions.pod:4426 ../src/guestfs-actions.pod:4484
5962 #: ../src/guestfs-actions.pod:4557 ../src/guestfs-actions.pod:4588
5963 #: ../src/guestfs-actions.pod:4607 ../src/guestfs-actions.pod:4626
5964 #: ../src/guestfs-actions.pod:4638 ../src/guestfs-actions.pod:4655
5965 #: ../src/guestfs-actions.pod:4668 ../src/guestfs-actions.pod:4683
5966 #: ../src/guestfs-actions.pod:4698 ../src/guestfs-actions.pod:4733
5967 #: ../src/guestfs-actions.pod:4755 ../src/guestfs-actions.pod:4775
5968 #: ../src/guestfs-actions.pod:4789 ../src/guestfs-actions.pod:4806
5969 #: ../src/guestfs-actions.pod:4855 ../src/guestfs-actions.pod:4901
5970 #: ../src/guestfs-actions.pod:4915 ../src/guestfs-actions.pod:4943
5971 #: ../src/guestfs-actions.pod:4960 ../src/guestfs-actions.pod:4978
5972 #: ../src/guestfs-actions.pod:5112 ../src/guestfs-actions.pod:5169
5973 #: ../src/guestfs-actions.pod:5191 ../src/guestfs-actions.pod:5209
5974 #: ../src/guestfs-actions.pod:5241 ../src/guestfs-actions.pod:5307
5975 #: ../src/guestfs-actions.pod:5324 ../src/guestfs-actions.pod:5337
5976 #: ../src/guestfs-actions.pod:5351 ../src/guestfs-actions.pod:5640
5977 #: ../src/guestfs-actions.pod:5659 ../src/guestfs-actions.pod:5678
5978 #: ../src/guestfs-actions.pod:5690 ../src/guestfs-actions.pod:5702
5979 #: ../src/guestfs-actions.pod:5716 ../src/guestfs-actions.pod:5728
5980 #: ../src/guestfs-actions.pod:5742 ../src/guestfs-actions.pod:5758
5981 #: ../src/guestfs-actions.pod:5779 ../src/guestfs-actions.pod:5798
5982 #: ../src/guestfs-actions.pod:5817 ../src/guestfs-actions.pod:5847
5983 #: ../src/guestfs-actions.pod:5863 ../src/guestfs-actions.pod:5886
5984 #: ../src/guestfs-actions.pod:5904 ../src/guestfs-actions.pod:5923
5985 #: ../src/guestfs-actions.pod:5944 ../src/guestfs-actions.pod:5963
5986 #: ../src/guestfs-actions.pod:5980 ../src/guestfs-actions.pod:6008
5987 #: ../src/guestfs-actions.pod:6032 ../src/guestfs-actions.pod:6051
5988 #: ../src/guestfs-actions.pod:6075 ../src/guestfs-actions.pod:6094
5989 #: ../src/guestfs-actions.pod:6109 ../src/guestfs-actions.pod:6128
5990 #: ../src/guestfs-actions.pod:6165 ../src/guestfs-actions.pod:6195
5991 #: ../src/guestfs-actions.pod:6228 ../src/guestfs-actions.pod:6350
5992 #: ../src/guestfs-actions.pod:6471 ../src/guestfs-actions.pod:6483
5993 #: ../src/guestfs-actions.pod:6496 ../src/guestfs-actions.pod:6509
5994 #: ../src/guestfs-actions.pod:6531 ../src/guestfs-actions.pod:6544
5995 #: ../src/guestfs-actions.pod:6557 ../src/guestfs-actions.pod:6570
5996 #: ../src/guestfs-actions.pod:6585 ../src/guestfs-actions.pod:6644
5997 #: ../src/guestfs-actions.pod:6661 ../src/guestfs-actions.pod:6677
5998 #: ../src/guestfs-actions.pod:6693 ../src/guestfs-actions.pod:6710
5999 #: ../src/guestfs-actions.pod:6723 ../src/guestfs-actions.pod:6743
6000 #: ../src/guestfs-actions.pod:6779 ../src/guestfs-actions.pod:6793
6001 #: ../src/guestfs-actions.pod:6834 ../src/guestfs-actions.pod:6847
6002 #: ../src/guestfs-actions.pod:6865 ../src/guestfs-actions.pod:6899
6003 #: ../src/guestfs-actions.pod:6935 ../src/guestfs-actions.pod:7054
6004 #: ../src/guestfs-actions.pod:7072 ../src/guestfs-actions.pod:7086
6005 #: ../src/guestfs-actions.pod:7141 ../src/guestfs-actions.pod:7154
6006 #: ../src/guestfs-actions.pod:7199 ../src/guestfs-actions.pod:7232
6007 #: ../src/guestfs-actions.pod:7293 ../src/guestfs-actions.pod:7319
6008 #: ../src/guestfs-actions.pod:7385 ../src/guestfs-actions.pod:7404
6009 #: ../src/guestfs-actions.pod:7433
6010 msgid "This function returns 0 on success or -1 on error."
6014 #: ../src/guestfs-actions.pod:32 ../src/guestfs-actions.pod:248
6015 #: ../src/guestfs-actions.pod:269
6017 "This function is deprecated. In new code, use the L</"
6018 "guestfs_add_drive_opts> call instead."
6022 #: ../src/guestfs-actions.pod:35 ../src/guestfs-actions.pod:251
6023 #: ../src/guestfs-actions.pod:272 ../src/guestfs-actions.pod:1453
6024 #: ../src/guestfs-actions.pod:1946 ../src/guestfs-actions.pod:1967
6025 #: ../src/guestfs-actions.pod:4431 ../src/guestfs-actions.pod:4738
6026 #: ../src/guestfs-actions.pod:6173 ../src/guestfs-actions.pod:6203
6027 #: ../src/guestfs-actions.pod:6236 ../src/guestfs-actions.pod:6295
6028 #: ../src/guestfs-actions.pod:7237 ../src/guestfs-actions.pod:7327
6029 #: ../src/guestfs-actions.pod:7496 ../fish/guestfish-actions.pod:31
6030 #: ../fish/guestfish-actions.pod:161 ../fish/guestfish-actions.pod:175
6031 #: ../fish/guestfish-actions.pod:961 ../fish/guestfish-actions.pod:1321
6032 #: ../fish/guestfish-actions.pod:1335 ../fish/guestfish-actions.pod:3010
6033 #: ../fish/guestfish-actions.pod:3207 ../fish/guestfish-actions.pod:4188
6034 #: ../fish/guestfish-actions.pod:4211 ../fish/guestfish-actions.pod:4233
6035 #: ../fish/guestfish-actions.pod:4271 ../fish/guestfish-actions.pod:4912
6036 #: ../fish/guestfish-actions.pod:5009
6038 "Deprecated functions will not be removed from the API, but the fact that "
6039 "they are deprecated indicates that there are problems with correct use of "
6044 #: ../src/guestfs-actions.pod:39 ../src/guestfs-actions.pod:136
6045 #: ../src/guestfs-actions.pod:1105 ../src/guestfs-actions.pod:1918
6046 #: ../src/guestfs-actions.pod:2016 ../src/guestfs-actions.pod:2119
6047 #: ../src/guestfs-actions.pod:3463 ../src/guestfs-actions.pod:3483
6048 #: ../src/guestfs-actions.pod:4742 ../src/guestfs-actions.pod:5865
6049 #: ../src/guestfs-actions.pod:5982 ../src/guestfs-actions.pod:6096
6050 #: ../src/guestfs-actions.pod:6587 ../src/guestfs-actions.pod:6712
6051 #: ../src/guestfs-actions.pod:7241
6052 msgid "(Added in 0.3)"
6056 #: ../src/guestfs-actions.pod:41
6057 msgid "guestfs_add_domain"
6061 #: ../src/guestfs-actions.pod:43
6065 " guestfs_add_domain (guestfs_h *g,\n"
6066 " const char *dom,\n"
6072 #: ../src/guestfs-actions.pod:48 ../src/guestfs-actions.pod:145
6073 #: ../src/guestfs-actions.pod:4445
6075 "You may supply a list of optional arguments to this call. Use zero or more "
6076 "of the following pairs of parameters, and terminate the list with C<-1> on "
6077 "its own. See L</CALLS WITH OPTIONAL ARGUMENTS>."
6081 #: ../src/guestfs-actions.pod:53
6084 " GUESTFS_ADD_DOMAIN_LIBVIRTURI, const char *libvirturi,\n"
6085 " GUESTFS_ADD_DOMAIN_READONLY, int readonly,\n"
6086 " GUESTFS_ADD_DOMAIN_IFACE, const char *iface,\n"
6087 " GUESTFS_ADD_DOMAIN_LIVE, int live,\n"
6092 #: ../src/guestfs-actions.pod:58
6094 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
6095 "It works by connecting to libvirt, requesting the domain and domain XML from "
6096 "libvirt, parsing it for disks, and calling C<guestfs_add_drive_opts> on each "
6101 #: ../src/guestfs-actions.pod:63 ../fish/guestfish-actions.pod:46
6103 "The number of disks added is returned. This operation is atomic: if an "
6104 "error is returned, then no disks are added."
6108 #: ../src/guestfs-actions.pod:66 ../fish/guestfish-actions.pod:49
6110 "This function does some minimal checks to make sure the libvirt domain is "
6111 "not running (unless C<readonly> is true). In a future version we will try "
6112 "to acquire the libvirt lock on each disk."
6116 #: ../src/guestfs-actions.pod:70 ../fish/guestfish-actions.pod:53
6118 "Disks must be accessible locally. This often means that adding disks from a "
6119 "remote libvirt connection (see L<http://libvirt.org/remote.html>) will fail "
6120 "unless those disks are accessible via the same device path locally too."
6124 #: ../src/guestfs-actions.pod:75 ../fish/guestfish-actions.pod:58
6126 "The optional C<libvirturi> parameter sets the libvirt URI (see L<http://"
6127 "libvirt.org/uri.html>). If this is not set then we connect to the default "
6128 "libvirt URI (or one set through an environment variable, see the libvirt "
6129 "documentation for full details)."
6133 #: ../src/guestfs-actions.pod:81 ../fish/guestfish-actions.pod:64
6135 "The optional C<live> flag controls whether this call will try to connect to "
6136 "a running virtual machine C<guestfsd> process if it sees a suitable "
6137 "E<lt>channelE<gt> element in the libvirt XML definition. The default (if "
6138 "the flag is omitted) is never to try. See L<guestfs(3)/ATTACHING TO RUNNING "
6139 "DAEMONS> for more information."
6143 #: ../src/guestfs-actions.pod:88
6145 "The other optional parameters are passed directly through to "
6146 "C<guestfs_add_drive_opts>."
6150 #: ../src/guestfs-actions.pod:91 ../src/guestfs-actions.pod:344
6151 #: ../src/guestfs-actions.pod:514 ../src/guestfs-actions.pod:692
6152 #: ../src/guestfs-actions.pod:723 ../src/guestfs-actions.pod:741
6153 #: ../src/guestfs-actions.pod:760 ../src/guestfs-actions.pod:1320
6154 #: ../src/guestfs-actions.pod:1676 ../src/guestfs-actions.pod:1879
6155 #: ../src/guestfs-actions.pod:1988 ../src/guestfs-actions.pod:2028
6156 #: ../src/guestfs-actions.pod:2083 ../src/guestfs-actions.pod:2106
6157 #: ../src/guestfs-actions.pod:2399 ../src/guestfs-actions.pod:2782
6158 #: ../src/guestfs-actions.pod:2803 ../src/guestfs-actions.pod:4878
6159 #: ../src/guestfs-actions.pod:5015 ../src/guestfs-actions.pod:5421
6160 #: ../src/guestfs-actions.pod:5447 ../src/guestfs-actions.pod:6820
6161 #: ../src/guestfs-actions.pod:7252 ../src/guestfs-actions.pod:7265
6162 #: ../src/guestfs-actions.pod:7278
6163 msgid "On error this function returns -1."
6167 #: ../src/guestfs-actions.pod:93
6168 msgid "(Added in 1.7.4)"
6172 #: ../src/guestfs-actions.pod:95
6173 msgid "guestfs_add_domain_va"
6177 #: ../src/guestfs-actions.pod:97
6181 " guestfs_add_domain_va (guestfs_h *g,\n"
6182 " const char *dom,\n"
6188 #: ../src/guestfs-actions.pod:102
6189 msgid "This is the \"va_list variant\" of L</guestfs_add_domain>."
6193 #: ../src/guestfs-actions.pod:104 ../src/guestfs-actions.pod:115
6194 #: ../src/guestfs-actions.pod:208 ../src/guestfs-actions.pod:219
6195 #: ../src/guestfs-actions.pod:4498 ../src/guestfs-actions.pod:4510
6196 msgid "See L</CALLS WITH OPTIONAL ARGUMENTS>."
6200 #: ../src/guestfs-actions.pod:106
6201 msgid "guestfs_add_domain_argv"
6205 #: ../src/guestfs-actions.pod:108
6209 " guestfs_add_domain_argv (guestfs_h *g,\n"
6210 " const char *dom,\n"
6211 " const struct guestfs_add_domain_argv *optargs);\n"
6216 #: ../src/guestfs-actions.pod:113
6217 msgid "This is the \"argv variant\" of L</guestfs_add_domain>."
6221 #: ../src/guestfs-actions.pod:117
6222 msgid "guestfs_add_drive"
6226 #: ../src/guestfs-actions.pod:119
6230 " guestfs_add_drive (guestfs_h *g,\n"
6231 " const char *filename);\n"
6236 #: ../src/guestfs-actions.pod:123
6238 "This function is the equivalent of calling C<guestfs_add_drive_opts> with no "
6239 "optional parameters, so the disk is added writable, with the format being "
6240 "detected automatically."
6244 #: ../src/guestfs-actions.pod:127
6246 "Automatic detection of the format opens you up to a potential security hole "
6247 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
6248 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
6249 "you should think about replacing calls to this function with calls to "
6250 "C<guestfs_add_drive_opts>, and specifying the format."
6254 #: ../src/guestfs-actions.pod:138
6255 msgid "guestfs_add_drive_opts"
6259 #: ../src/guestfs-actions.pod:140
6263 " guestfs_add_drive_opts (guestfs_h *g,\n"
6264 " const char *filename,\n"
6270 #: ../src/guestfs-actions.pod:150
6273 " GUESTFS_ADD_DRIVE_OPTS_READONLY, int readonly,\n"
6274 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, const char *format,\n"
6275 " GUESTFS_ADD_DRIVE_OPTS_IFACE, const char *iface,\n"
6280 #: ../src/guestfs-actions.pod:154 ../fish/guestfish-actions.pod:97
6282 "This function adds a virtual machine disk image C<filename> to libguestfs. "
6283 "The first time you call this function, the disk appears as C</dev/sda>, the "
6284 "second time as C</dev/sdb>, and so on."
6288 #: ../src/guestfs-actions.pod:159 ../fish/guestfish-actions.pod:102
6290 "You don't necessarily need to be root when using libguestfs. However you "
6291 "obviously do need sufficient permissions to access the filename for whatever "
6292 "operations you want to perform (ie. read access if you just want to read the "
6293 "image or write access if you want to modify the image)."
6297 #: ../src/guestfs-actions.pod:165 ../fish/guestfish-actions.pod:108
6298 msgid "This call checks that C<filename> exists."
6302 #: ../src/guestfs-actions.pod:167 ../src/guestfs-actions.pod:4456
6303 #: ../fish/guestfish-actions.pod:110 ../fish/guestfish-actions.pod:3021
6304 msgid "The optional arguments are:"
6308 #: ../src/guestfs-actions.pod:171 ../fish/guestfish-actions.pod:114
6310 msgstr "C<readonly>"
6313 #: ../src/guestfs-actions.pod:173 ../fish/guestfish-actions.pod:116
6315 "If true then the image is treated as read-only. Writes are still allowed, "
6316 "but they are stored in a temporary snapshot overlay which is discarded at "
6317 "the end. The disk that you add is not modified."
6321 #: ../src/guestfs-actions.pod:177 ../fish/guestfish-actions.pod:120
6326 #: ../src/guestfs-actions.pod:179
6328 "This forces the image format. If you omit this (or use C<guestfs_add_drive> "
6329 "or C<guestfs_add_drive_ro>) then the format is automatically detected. "
6330 "Possible formats include C<raw> and C<qcow2>."
6334 #: ../src/guestfs-actions.pod:183 ../fish/guestfish-actions.pod:126
6336 "Automatic detection of the format opens you up to a potential security hole "
6337 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
6338 "RHBZ#642934. Specifying the format closes this security hole."
6342 #: ../src/guestfs-actions.pod:188 ../fish/guestfish-actions.pod:131
6347 #: ../src/guestfs-actions.pod:190
6349 "This rarely-used option lets you emulate the behaviour of the deprecated "
6350 "C<guestfs_add_drive_with_if> call (q.v.)"
6354 #: ../src/guestfs-actions.pod:197
6355 msgid "(Added in 1.5.23)"
6359 #: ../src/guestfs-actions.pod:199
6360 msgid "guestfs_add_drive_opts_va"
6364 #: ../src/guestfs-actions.pod:201
6368 " guestfs_add_drive_opts_va (guestfs_h *g,\n"
6369 " const char *filename,\n"
6375 #: ../src/guestfs-actions.pod:206
6376 msgid "This is the \"va_list variant\" of L</guestfs_add_drive_opts>."
6380 #: ../src/guestfs-actions.pod:210
6381 msgid "guestfs_add_drive_opts_argv"
6385 #: ../src/guestfs-actions.pod:212
6389 " guestfs_add_drive_opts_argv (guestfs_h *g,\n"
6390 " const char *filename,\n"
6391 " const struct guestfs_add_drive_opts_argv *optargs);\n"
6396 #: ../src/guestfs-actions.pod:217
6397 msgid "This is the \"argv variant\" of L</guestfs_add_drive_opts>."
6401 #: ../src/guestfs-actions.pod:221
6402 msgid "guestfs_add_drive_ro"
6406 #: ../src/guestfs-actions.pod:223
6410 " guestfs_add_drive_ro (guestfs_h *g,\n"
6411 " const char *filename);\n"
6416 #: ../src/guestfs-actions.pod:227
6418 "This function is the equivalent of calling C<guestfs_add_drive_opts> with "
6419 "the optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the "
6420 "disk is added read-only, with the format being detected automatically."
6424 #: ../src/guestfs-actions.pod:234
6425 msgid "(Added in 1.0.38)"
6429 #: ../src/guestfs-actions.pod:236
6430 msgid "guestfs_add_drive_ro_with_if"
6434 #: ../src/guestfs-actions.pod:238
6438 " guestfs_add_drive_ro_with_if (guestfs_h *g,\n"
6439 " const char *filename,\n"
6440 " const char *iface);\n"
6445 #: ../src/guestfs-actions.pod:243
6447 "This is the same as C<guestfs_add_drive_ro> but it allows you to specify the "
6448 "QEMU interface emulation to use at run time."
6452 #: ../src/guestfs-actions.pod:255 ../src/guestfs-actions.pod:276
6453 #: ../src/guestfs-actions.pod:2358
6454 msgid "(Added in 1.0.84)"
6458 #: ../src/guestfs-actions.pod:257
6459 msgid "guestfs_add_drive_with_if"
6463 #: ../src/guestfs-actions.pod:259
6467 " guestfs_add_drive_with_if (guestfs_h *g,\n"
6468 " const char *filename,\n"
6469 " const char *iface);\n"
6474 #: ../src/guestfs-actions.pod:264
6476 "This is the same as C<guestfs_add_drive> but it allows you to specify the "
6477 "QEMU interface emulation to use at run time."
6481 #: ../src/guestfs-actions.pod:278
6482 msgid "guestfs_aug_clear"
6486 #: ../src/guestfs-actions.pod:280
6490 " guestfs_aug_clear (guestfs_h *g,\n"
6491 " const char *augpath);\n"
6496 #: ../src/guestfs-actions.pod:284 ../fish/guestfish-actions.pod:183
6498 "Set the value associated with C<path> to C<NULL>. This is the same as the "
6499 "L<augtool(1)> C<clear> command."
6503 #: ../src/guestfs-actions.pod:289 ../src/guestfs-actions.pod:2108
6504 msgid "(Added in 1.3.4)"
6508 #: ../src/guestfs-actions.pod:291
6509 msgid "guestfs_aug_close"
6513 #: ../src/guestfs-actions.pod:293
6517 " guestfs_aug_close (guestfs_h *g);\n"
6522 #: ../src/guestfs-actions.pod:296
6524 "Close the current Augeas handle and free up any resources used by it. After "
6525 "calling this, you have to call C<guestfs_aug_init> again before you can use "
6526 "any other Augeas functions."
6530 #: ../src/guestfs-actions.pod:303 ../src/guestfs-actions.pod:328
6531 #: ../src/guestfs-actions.pod:346 ../src/guestfs-actions.pod:360
6532 #: ../src/guestfs-actions.pod:423 ../src/guestfs-actions.pod:443
6533 #: ../src/guestfs-actions.pod:457 ../src/guestfs-actions.pod:488
6534 #: ../src/guestfs-actions.pod:502 ../src/guestfs-actions.pod:516
6535 #: ../src/guestfs-actions.pod:530 ../src/guestfs-actions.pod:548
6536 #: ../src/guestfs-actions.pod:5498
6537 msgid "(Added in 0.7)"
6541 #: ../src/guestfs-actions.pod:305
6542 msgid "guestfs_aug_defnode"
6546 #: ../src/guestfs-actions.pod:307
6549 " struct guestfs_int_bool *\n"
6550 " guestfs_aug_defnode (guestfs_h *g,\n"
6551 " const char *name,\n"
6552 " const char *expr,\n"
6553 " const char *val);\n"
6558 #: ../src/guestfs-actions.pod:313 ../fish/guestfish-actions.pod:199
6560 "Defines a variable C<name> whose value is the result of evaluating C<expr>."
6564 #: ../src/guestfs-actions.pod:316
6566 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
6567 "calling C<guestfs_aug_set> C<expr>, C<value>. C<name> will be the nodeset "
6568 "containing that single node."
6572 #: ../src/guestfs-actions.pod:320 ../fish/guestfish-actions.pod:206
6574 "On success this returns a pair containing the number of nodes in the "
6575 "nodeset, and a boolean flag if a node was created."
6579 #: ../src/guestfs-actions.pod:324
6581 "This function returns a C<struct guestfs_int_bool *>, or NULL if there was "
6582 "an error. I<The caller must call C<guestfs_free_int_bool> after use>."
6586 #: ../src/guestfs-actions.pod:330
6587 msgid "guestfs_aug_defvar"
6591 #: ../src/guestfs-actions.pod:332
6595 " guestfs_aug_defvar (guestfs_h *g,\n"
6596 " const char *name,\n"
6597 " const char *expr);\n"
6602 #: ../src/guestfs-actions.pod:337 ../fish/guestfish-actions.pod:214
6604 "Defines an Augeas variable C<name> whose value is the result of evaluating "
6605 "C<expr>. If C<expr> is NULL, then C<name> is undefined."
6609 #: ../src/guestfs-actions.pod:341 ../fish/guestfish-actions.pod:218
6611 "On success this returns the number of nodes in C<expr>, or C<0> if C<expr> "
6612 "evaluates to something which is not a nodeset."
6616 #: ../src/guestfs-actions.pod:348
6617 msgid "guestfs_aug_get"
6621 #: ../src/guestfs-actions.pod:350
6625 " guestfs_aug_get (guestfs_h *g,\n"
6626 " const char *augpath);\n"
6631 #: ../src/guestfs-actions.pod:354 ../fish/guestfish-actions.pod:225
6633 "Look up the value associated with C<path>. If C<path> matches exactly one "
6634 "node, the C<value> is returned."
6638 #: ../src/guestfs-actions.pod:357 ../src/guestfs-actions.pod:862
6639 #: ../src/guestfs-actions.pod:880 ../src/guestfs-actions.pod:940
6640 #: ../src/guestfs-actions.pod:956 ../src/guestfs-actions.pod:1059
6641 #: ../src/guestfs-actions.pod:1189 ../src/guestfs-actions.pod:1206
6642 #: ../src/guestfs-actions.pod:1225 ../src/guestfs-actions.pod:1359
6643 #: ../src/guestfs-actions.pod:1547 ../src/guestfs-actions.pod:1659
6644 #: ../src/guestfs-actions.pod:1822 ../src/guestfs-actions.pod:1839
6645 #: ../src/guestfs-actions.pod:1906 ../src/guestfs-actions.pod:1940
6646 #: ../src/guestfs-actions.pod:1961 ../src/guestfs-actions.pod:2131
6647 #: ../src/guestfs-actions.pod:2323 ../src/guestfs-actions.pod:2530
6648 #: ../src/guestfs-actions.pod:2623 ../src/guestfs-actions.pod:2734
6649 #: ../src/guestfs-actions.pod:2754 ../src/guestfs-actions.pod:2874
6650 #: ../src/guestfs-actions.pod:2905 ../src/guestfs-actions.pod:2929
6651 #: ../src/guestfs-actions.pod:2966 ../src/guestfs-actions.pod:3026
6652 #: ../src/guestfs-actions.pod:3049 ../src/guestfs-actions.pod:3070
6653 #: ../src/guestfs-actions.pod:3642 ../src/guestfs-actions.pod:3992
6654 #: ../src/guestfs-actions.pod:4162 ../src/guestfs-actions.pod:4272
6655 #: ../src/guestfs-actions.pod:5033 ../src/guestfs-actions.pod:5226
6656 #: ../src/guestfs-actions.pod:5396 ../src/guestfs-actions.pod:5574
6657 #: ../src/guestfs-actions.pod:5623 ../src/guestfs-actions.pod:6256
6658 #: ../src/guestfs-actions.pod:6272 ../src/guestfs-actions.pod:6289
6659 #: ../src/guestfs-actions.pod:6320 ../src/guestfs-actions.pod:6994
6660 #: ../src/guestfs-actions.pod:7013 ../src/guestfs-actions.pod:7031
6661 #: ../src/guestfs-actions.pod:7211 ../src/guestfs-actions.pod:7490
6663 "This function returns a string, or NULL on error. I<The caller must free "
6664 "the returned string after use>."
6668 #: ../src/guestfs-actions.pod:362
6669 msgid "guestfs_aug_init"
6673 #: ../src/guestfs-actions.pod:364
6677 " guestfs_aug_init (guestfs_h *g,\n"
6678 " const char *root,\n"
6684 #: ../src/guestfs-actions.pod:369 ../fish/guestfish-actions.pod:232
6686 "Create a new Augeas handle for editing configuration files. If there was "
6687 "any previous Augeas handle associated with this guestfs session, then it is "
6692 #: ../src/guestfs-actions.pod:373
6693 msgid "You must call this before using any other C<guestfs_aug_*> commands."
6697 #: ../src/guestfs-actions.pod:376 ../fish/guestfish-actions.pod:239
6699 "C<root> is the filesystem root. C<root> must not be NULL, use C</> instead."
6703 #: ../src/guestfs-actions.pod:379 ../fish/guestfish-actions.pod:242
6705 "The flags are the same as the flags defined in E<lt>augeas.hE<gt>, the "
6706 "logical I<or> of the following integers:"
6710 #: ../src/guestfs-actions.pod:385 ../fish/guestfish-actions.pod:248
6711 msgid "C<AUG_SAVE_BACKUP> = 1"
6712 msgstr "C<AUG_SAVE_BACKUP> = 1"
6715 #: ../src/guestfs-actions.pod:387 ../fish/guestfish-actions.pod:250
6716 msgid "Keep the original file with a C<.augsave> extension."
6720 #: ../src/guestfs-actions.pod:389 ../fish/guestfish-actions.pod:252
6721 msgid "C<AUG_SAVE_NEWFILE> = 2"
6722 msgstr "C<AUG_SAVE_NEWFILE> = 2"
6725 #: ../src/guestfs-actions.pod:391 ../fish/guestfish-actions.pod:254
6727 "Save changes into a file with extension C<.augnew>, and do not overwrite "
6728 "original. Overrides C<AUG_SAVE_BACKUP>."
6732 #: ../src/guestfs-actions.pod:394 ../fish/guestfish-actions.pod:257
6733 msgid "C<AUG_TYPE_CHECK> = 4"
6734 msgstr "C<AUG_TYPE_CHECK> = 4"
6737 #: ../src/guestfs-actions.pod:396 ../fish/guestfish-actions.pod:259
6738 msgid "Typecheck lenses."
6742 #: ../src/guestfs-actions.pod:398
6744 "This option is only useful when debugging Augeas lenses. Use of this option "
6745 "may require additional memory for the libguestfs appliance. You may need to "
6746 "set the C<LIBGUESTFS_MEMSIZE> environment variable or call "
6747 "C<guestfs_set_memsize>."
6751 #: ../src/guestfs-actions.pod:403 ../fish/guestfish-actions.pod:266
6752 msgid "C<AUG_NO_STDINC> = 8"
6753 msgstr "C<AUG_NO_STDINC> = 8"
6756 #: ../src/guestfs-actions.pod:405 ../fish/guestfish-actions.pod:268
6757 msgid "Do not use standard load path for modules."
6761 #: ../src/guestfs-actions.pod:407 ../fish/guestfish-actions.pod:270
6762 msgid "C<AUG_SAVE_NOOP> = 16"
6763 msgstr "C<AUG_SAVE_NOOP> = 16"
6766 #: ../src/guestfs-actions.pod:409 ../fish/guestfish-actions.pod:272
6767 msgid "Make save a no-op, just record what would have been changed."
6771 #: ../src/guestfs-actions.pod:411 ../fish/guestfish-actions.pod:274
6772 msgid "C<AUG_NO_LOAD> = 32"
6773 msgstr "C<AUG_NO_LOAD> = 32"
6776 #: ../src/guestfs-actions.pod:413
6777 msgid "Do not load the tree in C<guestfs_aug_init>."
6781 #: ../src/guestfs-actions.pod:417
6782 msgid "To close the handle, you can call C<guestfs_aug_close>."
6786 #: ../src/guestfs-actions.pod:419 ../fish/guestfish-actions.pod:282
6787 msgid "To find out more about Augeas, see L<http://augeas.net/>."
6791 #: ../src/guestfs-actions.pod:425
6792 msgid "guestfs_aug_insert"
6796 #: ../src/guestfs-actions.pod:427
6800 " guestfs_aug_insert (guestfs_h *g,\n"
6801 " const char *augpath,\n"
6802 " const char *label,\n"
6808 #: ../src/guestfs-actions.pod:433 ../fish/guestfish-actions.pod:288
6810 "Create a new sibling C<label> for C<path>, inserting it into the tree before "
6811 "or after C<path> (depending on the boolean flag C<before>)."
6815 #: ../src/guestfs-actions.pod:437 ../fish/guestfish-actions.pod:292
6817 "C<path> must match exactly one existing node in the tree, and C<label> must "
6818 "be a label, ie. not contain C</>, C<*> or end with a bracketed index C<[N]>."
6822 #: ../src/guestfs-actions.pod:445
6823 msgid "guestfs_aug_load"
6827 #: ../src/guestfs-actions.pod:447
6831 " guestfs_aug_load (guestfs_h *g);\n"
6836 #: ../src/guestfs-actions.pod:450 ../fish/guestfish-actions.pod:300
6837 msgid "Load files into the tree."
6838 msgstr "Завантажити файли до ієрархії."
6841 #: ../src/guestfs-actions.pod:452 ../fish/guestfish-actions.pod:302
6842 msgid "See C<aug_load> in the Augeas documentation for the full gory details."
6846 #: ../src/guestfs-actions.pod:459
6847 msgid "guestfs_aug_ls"
6851 #: ../src/guestfs-actions.pod:461
6855 " guestfs_aug_ls (guestfs_h *g,\n"
6856 " const char *augpath);\n"
6861 #: ../src/guestfs-actions.pod:465
6863 "This is just a shortcut for listing C<guestfs_aug_match> C<path/*> and "
6864 "sorting the resulting nodes into alphabetical order."
6868 #: ../src/guestfs-actions.pod:468 ../src/guestfs-actions.pod:484
6869 #: ../src/guestfs-actions.pod:630 ../src/guestfs-actions.pod:1078
6870 #: ../src/guestfs-actions.pod:1374 ../src/guestfs-actions.pod:1393
6871 #: ../src/guestfs-actions.pod:1496 ../src/guestfs-actions.pod:1515
6872 #: ../src/guestfs-actions.pod:1761 ../src/guestfs-actions.pod:2203
6873 #: ../src/guestfs-actions.pod:2219 ../src/guestfs-actions.pod:2238
6874 #: ../src/guestfs-actions.pod:2281 ../src/guestfs-actions.pod:2305
6875 #: ../src/guestfs-actions.pod:2376 ../src/guestfs-actions.pod:2425
6876 #: ../src/guestfs-actions.pod:2692 ../src/guestfs-actions.pod:2983
6877 #: ../src/guestfs-actions.pod:3272 ../src/guestfs-actions.pod:3562
6878 #: ../src/guestfs-actions.pod:3624 ../src/guestfs-actions.pod:3729
6879 #: ../src/guestfs-actions.pod:4134 ../src/guestfs-actions.pod:4839
6880 #: ../src/guestfs-actions.pod:5368 ../src/guestfs-actions.pod:5494
6881 #: ../src/guestfs-actions.pod:5608 ../src/guestfs-actions.pod:6336
6882 #: ../src/guestfs-actions.pod:6397 ../src/guestfs-actions.pod:6452
6883 #: ../src/guestfs-actions.pod:6598 ../src/guestfs-actions.pod:6622
6884 #: ../src/guestfs-actions.pod:7104 ../src/guestfs-actions.pod:7124
6885 #: ../src/guestfs-actions.pod:7171 ../src/guestfs-actions.pod:7343
6886 #: ../src/guestfs-actions.pod:7362 ../src/guestfs-actions.pod:7447
6887 #: ../src/guestfs-actions.pod:7466 ../src/guestfs-actions.pod:7512
6888 #: ../src/guestfs-actions.pod:7531
6890 "This function returns a NULL-terminated array of strings (like L<environ(3)"
6891 ">), or NULL if there was an error. I<The caller must free the strings and "
6892 "the array after use>."
6896 #: ../src/guestfs-actions.pod:472 ../src/guestfs-actions.pod:1003
6897 #: ../src/guestfs-actions.pod:1021 ../src/guestfs-actions.pod:1431
6898 #: ../src/guestfs-actions.pod:3350 ../src/guestfs-actions.pod:3381
6899 #: ../src/guestfs-actions.pod:3975 ../src/guestfs-actions.pod:4025
6900 #: ../src/guestfs-actions.pod:4212 ../src/guestfs-actions.pod:4245
6901 #: ../src/guestfs-actions.pod:4408 ../src/guestfs-actions.pod:4843
6902 #: ../src/guestfs-actions.pod:5309 ../src/guestfs-actions.pod:5704
6903 #: ../src/guestfs-actions.pod:5718 ../src/guestfs-actions.pod:5730
6904 #: ../src/guestfs-actions.pod:6177 ../src/guestfs-actions.pod:6836
6905 #: ../src/guestfs-actions.pod:6849 ../src/guestfs-actions.pod:7088
6906 #: ../src/guestfs-actions.pod:7331
6907 msgid "(Added in 0.8)"
6911 #: ../src/guestfs-actions.pod:474
6912 msgid "guestfs_aug_match"
6916 #: ../src/guestfs-actions.pod:476
6920 " guestfs_aug_match (guestfs_h *g,\n"
6921 " const char *augpath);\n"
6926 #: ../src/guestfs-actions.pod:480 ../fish/guestfish-actions.pod:316
6928 "Returns a list of paths which match the path expression C<path>. The "
6929 "returned paths are sufficiently qualified so that they match exactly one "
6930 "node in the current tree."
6934 #: ../src/guestfs-actions.pod:490
6935 msgid "guestfs_aug_mv"
6939 #: ../src/guestfs-actions.pod:492
6943 " guestfs_aug_mv (guestfs_h *g,\n"
6944 " const char *src,\n"
6945 " const char *dest);\n"
6950 #: ../src/guestfs-actions.pod:497 ../fish/guestfish-actions.pod:324
6952 "Move the node C<src> to C<dest>. C<src> must match exactly one node. "
6953 "C<dest> is overwritten if it exists."
6957 #: ../src/guestfs-actions.pod:504
6958 msgid "guestfs_aug_rm"
6962 #: ../src/guestfs-actions.pod:506
6966 " guestfs_aug_rm (guestfs_h *g,\n"
6967 " const char *augpath);\n"
6972 #: ../src/guestfs-actions.pod:510 ../fish/guestfish-actions.pod:331
6973 msgid "Remove C<path> and all of its children."
6977 #: ../src/guestfs-actions.pod:512 ../fish/guestfish-actions.pod:333
6978 msgid "On success this returns the number of entries which were removed."
6982 #: ../src/guestfs-actions.pod:518
6983 msgid "guestfs_aug_save"
6987 #: ../src/guestfs-actions.pod:520
6991 " guestfs_aug_save (guestfs_h *g);\n"
6996 #: ../src/guestfs-actions.pod:523 ../fish/guestfish-actions.pod:339
6997 msgid "This writes all pending changes to disk."
7001 #: ../src/guestfs-actions.pod:525
7003 "The flags which were passed to C<guestfs_aug_init> affect exactly how files "
7008 #: ../src/guestfs-actions.pod:532
7009 msgid "guestfs_aug_set"
7013 #: ../src/guestfs-actions.pod:534
7017 " guestfs_aug_set (guestfs_h *g,\n"
7018 " const char *augpath,\n"
7019 " const char *val);\n"
7024 #: ../src/guestfs-actions.pod:539 ../fish/guestfish-actions.pod:348
7025 msgid "Set the value associated with C<path> to C<val>."
7029 #: ../src/guestfs-actions.pod:541
7031 "In the Augeas API, it is possible to clear a node by setting the value to "
7032 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
7033 "this call. Instead you must use the C<guestfs_aug_clear> call."
7037 #: ../src/guestfs-actions.pod:550
7038 msgid "guestfs_available"
7042 #: ../src/guestfs-actions.pod:552
7046 " guestfs_available (guestfs_h *g,\n"
7047 " char *const *groups);\n"
7052 #: ../src/guestfs-actions.pod:556 ../fish/guestfish-actions.pod:359
7054 "This command is used to check the availability of some groups of "
7055 "functionality in the appliance, which not all builds of the libguestfs "
7056 "appliance will be able to provide."
7060 #: ../src/guestfs-actions.pod:560
7062 "The libguestfs groups, and the functions that those groups correspond to, "
7063 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
7064 "runtime by calling C<guestfs_available_all_groups>."
7068 #: ../src/guestfs-actions.pod:565 ../fish/guestfish-actions.pod:368
7070 "The argument C<groups> is a list of group names, eg: C<[\"inotify\", \"augeas"
7071 "\"]> would check for the availability of the Linux inotify functions and "
7072 "Augeas (configuration file editing) functions."
7076 #: ../src/guestfs-actions.pod:570 ../fish/guestfish-actions.pod:373
7077 msgid "The command returns no error if I<all> requested groups are available."
7081 #: ../src/guestfs-actions.pod:572 ../fish/guestfish-actions.pod:375
7083 "It fails with an error if one or more of the requested groups is unavailable "
7088 #: ../src/guestfs-actions.pod:575 ../fish/guestfish-actions.pod:378
7090 "If an unknown group name is included in the list of groups then an error is "
7095 #: ../src/guestfs-actions.pod:578 ../fish/guestfish-actions.pod:381
7097 msgstr "I<Нотатки:>"
7100 #: ../src/guestfs-actions.pod:584
7101 msgid "You must call C<guestfs_launch> before calling this function."
7105 #: ../src/guestfs-actions.pod:586 ../fish/guestfish-actions.pod:389
7107 "The reason is because we don't know what groups are supported by the "
7108 "appliance/daemon until it is running and can be queried."
7112 #: ../src/guestfs-actions.pod:592 ../fish/guestfish-actions.pod:395
7114 "If a group of functions is available, this does not necessarily mean that "
7115 "they will work. You still have to check for errors when calling individual "
7116 "API functions even if they are available."
7120 #: ../src/guestfs-actions.pod:599 ../fish/guestfish-actions.pod:402
7122 "It is usually the job of distro packagers to build complete functionality "
7123 "into the libguestfs appliance. Upstream libguestfs, if built from source "
7124 "with all requirements satisfied, will support everything."
7128 #: ../src/guestfs-actions.pod:606
7130 "This call was added in version C<1.0.80>. In previous versions of "
7131 "libguestfs all you could do would be to speculatively execute a command to "
7132 "find out if the daemon implemented it. See also C<guestfs_version>."
7136 #: ../src/guestfs-actions.pod:615 ../src/guestfs-actions.pod:1176
7137 msgid "(Added in 1.0.80)"
7141 #: ../src/guestfs-actions.pod:617
7142 msgid "guestfs_available_all_groups"
7146 #: ../src/guestfs-actions.pod:619
7150 " guestfs_available_all_groups (guestfs_h *g);\n"
7155 #: ../src/guestfs-actions.pod:622
7157 "This command returns a list of all optional groups that this daemon knows "
7158 "about. Note this returns both supported and unsupported groups. To find "
7159 "out which ones the daemon can actually support you have to call "
7160 "C<guestfs_available> on each member of the returned list."
7164 #: ../src/guestfs-actions.pod:628
7165 msgid "See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>."
7169 #: ../src/guestfs-actions.pod:634
7170 msgid "(Added in 1.3.15)"
7174 #: ../src/guestfs-actions.pod:636
7175 msgid "guestfs_base64_in"
7179 #: ../src/guestfs-actions.pod:638
7183 " guestfs_base64_in (guestfs_h *g,\n"
7184 " const char *base64file,\n"
7185 " const char *filename);\n"
7190 #: ../src/guestfs-actions.pod:643 ../fish/guestfish-actions.pod:432
7192 "This command uploads base64-encoded data from C<base64file> to C<filename>."
7196 #: ../src/guestfs-actions.pod:648 ../src/guestfs-actions.pod:662
7197 msgid "(Added in 1.3.5)"
7201 #: ../src/guestfs-actions.pod:650
7202 msgid "guestfs_base64_out"
7206 #: ../src/guestfs-actions.pod:652
7210 " guestfs_base64_out (guestfs_h *g,\n"
7211 " const char *filename,\n"
7212 " const char *base64file);\n"
7217 #: ../src/guestfs-actions.pod:657 ../fish/guestfish-actions.pod:441
7219 "This command downloads the contents of C<filename>, writing it out to local "
7220 "file C<base64file> encoded as base64."
7224 #: ../src/guestfs-actions.pod:664
7225 msgid "guestfs_blockdev_flushbufs"
7229 #: ../src/guestfs-actions.pod:666
7233 " guestfs_blockdev_flushbufs (guestfs_h *g,\n"
7234 " const char *device);\n"
7239 #: ../src/guestfs-actions.pod:670 ../fish/guestfish-actions.pod:450
7241 "This tells the kernel to flush internal buffers associated with C<device>."
7245 #: ../src/guestfs-actions.pod:673 ../src/guestfs-actions.pod:690
7246 #: ../src/guestfs-actions.pod:705 ../src/guestfs-actions.pod:721
7247 #: ../src/guestfs-actions.pod:739 ../src/guestfs-actions.pod:758
7248 #: ../src/guestfs-actions.pod:772 ../src/guestfs-actions.pod:790
7249 #: ../src/guestfs-actions.pod:804 ../src/guestfs-actions.pod:818
7250 #: ../fish/guestfish-actions.pod:453 ../fish/guestfish-actions.pod:464
7251 #: ../fish/guestfish-actions.pod:473 ../fish/guestfish-actions.pod:483
7252 #: ../fish/guestfish-actions.pod:495 ../fish/guestfish-actions.pod:508
7253 #: ../fish/guestfish-actions.pod:516 ../fish/guestfish-actions.pod:527
7254 #: ../fish/guestfish-actions.pod:535 ../fish/guestfish-actions.pod:543
7255 msgid "This uses the L<blockdev(8)> command."
7259 #: ../src/guestfs-actions.pod:677 ../src/guestfs-actions.pod:694
7260 #: ../src/guestfs-actions.pod:709 ../src/guestfs-actions.pod:725
7261 #: ../src/guestfs-actions.pod:743 ../src/guestfs-actions.pod:762
7262 #: ../src/guestfs-actions.pod:776 ../src/guestfs-actions.pod:794
7263 #: ../src/guestfs-actions.pod:808 ../src/guestfs-actions.pod:822
7264 msgid "(Added in 0.9.3)"
7268 #: ../src/guestfs-actions.pod:679
7269 msgid "guestfs_blockdev_getbsz"
7273 #: ../src/guestfs-actions.pod:681
7277 " guestfs_blockdev_getbsz (guestfs_h *g,\n"
7278 " const char *device);\n"
7283 #: ../src/guestfs-actions.pod:685 ../fish/guestfish-actions.pod:459
7284 msgid "This returns the block size of a device."
7288 #: ../src/guestfs-actions.pod:687 ../src/guestfs-actions.pod:787
7289 #: ../fish/guestfish-actions.pod:461 ../fish/guestfish-actions.pod:524
7291 "(Note this is different from both I<size in blocks> and I<filesystem block "
7296 #: ../src/guestfs-actions.pod:696
7297 msgid "guestfs_blockdev_getro"
7301 #: ../src/guestfs-actions.pod:698
7305 " guestfs_blockdev_getro (guestfs_h *g,\n"
7306 " const char *device);\n"
7311 #: ../src/guestfs-actions.pod:702 ../fish/guestfish-actions.pod:470
7313 "Returns a boolean indicating if the block device is read-only (true if read-"
7314 "only, false if not)."
7318 #: ../src/guestfs-actions.pod:707 ../src/guestfs-actions.pod:1414
7319 #: ../src/guestfs-actions.pod:1429 ../src/guestfs-actions.pod:1916
7320 #: ../src/guestfs-actions.pod:1927 ../src/guestfs-actions.pod:1999
7321 #: ../src/guestfs-actions.pod:2054 ../src/guestfs-actions.pod:2069
7322 #: ../src/guestfs-actions.pod:2094 ../src/guestfs-actions.pod:2117
7323 #: ../src/guestfs-actions.pod:3090 ../src/guestfs-actions.pod:3107
7324 #: ../src/guestfs-actions.pod:3126 ../src/guestfs-actions.pod:3289
7325 #: ../src/guestfs-actions.pod:3303 ../src/guestfs-actions.pod:3318
7326 #: ../src/guestfs-actions.pod:3332 ../src/guestfs-actions.pod:3348
7327 #: ../src/guestfs-actions.pod:3363 ../src/guestfs-actions.pod:3379
7328 #: ../src/guestfs-actions.pod:3393 ../src/guestfs-actions.pod:3406
7329 #: ../src/guestfs-actions.pod:3420 ../src/guestfs-actions.pod:3435
7330 #: ../src/guestfs-actions.pod:3450 ../src/guestfs-actions.pod:4997
7331 msgid "This function returns a C truth value on success or -1 on error."
7335 #: ../src/guestfs-actions.pod:711
7336 msgid "guestfs_blockdev_getsize64"
7340 #: ../src/guestfs-actions.pod:713
7344 " guestfs_blockdev_getsize64 (guestfs_h *g,\n"
7345 " const char *device);\n"
7350 #: ../src/guestfs-actions.pod:717 ../fish/guestfish-actions.pod:479
7351 msgid "This returns the size of the device in bytes."
7355 #: ../src/guestfs-actions.pod:719
7356 msgid "See also C<guestfs_blockdev_getsz>."
7360 #: ../src/guestfs-actions.pod:727
7361 msgid "guestfs_blockdev_getss"
7365 #: ../src/guestfs-actions.pod:729
7369 " guestfs_blockdev_getss (guestfs_h *g,\n"
7370 " const char *device);\n"
7375 #: ../src/guestfs-actions.pod:733 ../fish/guestfish-actions.pod:489
7377 "This returns the size of sectors on a block device. Usually 512, but can be "
7378 "larger for modern devices."
7382 #: ../src/guestfs-actions.pod:736
7384 "(Note, this is not the size in sectors, use C<guestfs_blockdev_getsz> for "
7389 #: ../src/guestfs-actions.pod:745
7390 msgid "guestfs_blockdev_getsz"
7394 #: ../src/guestfs-actions.pod:747
7398 " guestfs_blockdev_getsz (guestfs_h *g,\n"
7399 " const char *device);\n"
7404 #: ../src/guestfs-actions.pod:751 ../fish/guestfish-actions.pod:501
7406 "This returns the size of the device in units of 512-byte sectors (even if "
7407 "the sectorsize isn't 512 bytes ... weird)."
7411 #: ../src/guestfs-actions.pod:754
7413 "See also C<guestfs_blockdev_getss> for the real sector size of the device, "
7414 "and C<guestfs_blockdev_getsize64> for the more useful I<size in bytes>."
7418 #: ../src/guestfs-actions.pod:764
7419 msgid "guestfs_blockdev_rereadpt"
7423 #: ../src/guestfs-actions.pod:766
7427 " guestfs_blockdev_rereadpt (guestfs_h *g,\n"
7428 " const char *device);\n"
7433 #: ../src/guestfs-actions.pod:770 ../fish/guestfish-actions.pod:514
7434 msgid "Reread the partition table on C<device>."
7438 #: ../src/guestfs-actions.pod:778
7439 msgid "guestfs_blockdev_setbsz"
7443 #: ../src/guestfs-actions.pod:780
7447 " guestfs_blockdev_setbsz (guestfs_h *g,\n"
7448 " const char *device,\n"
7449 " int blocksize);\n"
7454 #: ../src/guestfs-actions.pod:785 ../fish/guestfish-actions.pod:522
7455 msgid "This sets the block size of a device."
7459 #: ../src/guestfs-actions.pod:796
7460 msgid "guestfs_blockdev_setro"
7464 #: ../src/guestfs-actions.pod:798
7468 " guestfs_blockdev_setro (guestfs_h *g,\n"
7469 " const char *device);\n"
7474 #: ../src/guestfs-actions.pod:802 ../fish/guestfish-actions.pod:533
7475 msgid "Sets the block device named C<device> to read-only."
7479 #: ../src/guestfs-actions.pod:810
7480 msgid "guestfs_blockdev_setrw"
7484 #: ../src/guestfs-actions.pod:812
7488 " guestfs_blockdev_setrw (guestfs_h *g,\n"
7489 " const char *device);\n"
7494 #: ../src/guestfs-actions.pod:816 ../fish/guestfish-actions.pod:541
7495 msgid "Sets the block device named C<device> to read-write."
7499 #: ../src/guestfs-actions.pod:824
7500 msgid "guestfs_case_sensitive_path"
7504 #: ../src/guestfs-actions.pod:826
7508 " guestfs_case_sensitive_path (guestfs_h *g,\n"
7509 " const char *path);\n"
7514 #: ../src/guestfs-actions.pod:830 ../fish/guestfish-actions.pod:549
7516 "This can be used to resolve case insensitive paths on a filesystem which is "
7517 "case sensitive. The use case is to resolve paths which you have read from "
7518 "Windows configuration files or the Windows Registry, to the true path."
7522 #: ../src/guestfs-actions.pod:835 ../fish/guestfish-actions.pod:554
7524 "The command handles a peculiarity of the Linux ntfs-3g filesystem driver "
7525 "(and probably others), which is that although the underlying filesystem is "
7526 "case-insensitive, the driver exports the filesystem to Linux as case-"
7531 #: ../src/guestfs-actions.pod:840 ../fish/guestfish-actions.pod:559
7533 "One consequence of this is that special directories such as C<c:\\windows> "
7534 "may appear as C</WINDOWS> or C</windows> (or other things) depending on the "
7535 "precise details of how they were created. In Windows itself this would not "
7540 #: ../src/guestfs-actions.pod:846 ../fish/guestfish-actions.pod:565
7542 "Bug or feature? You decide: L<http://www.tuxera.com/community/ntfs-3g-faq/"
7547 #: ../src/guestfs-actions.pod:849 ../fish/guestfish-actions.pod:568
7549 "This function resolves the true case of each element in the path and returns "
7550 "the case-sensitive path."
7554 #: ../src/guestfs-actions.pod:852
7556 "Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\") might return C<"
7557 "\"/WINDOWS/system32\"> (the exact return value would depend on details of "
7558 "how the directories were originally created under Windows)."
7562 #: ../src/guestfs-actions.pod:857 ../fish/guestfish-actions.pod:576
7563 msgid "I<Note>: This function does not handle drive names, backslashes etc."
7567 #: ../src/guestfs-actions.pod:860
7568 msgid "See also C<guestfs_realpath>."
7572 #: ../src/guestfs-actions.pod:865 ../src/guestfs-actions.pod:7016
7573 msgid "(Added in 1.0.75)"
7577 #: ../src/guestfs-actions.pod:867
7582 #: ../src/guestfs-actions.pod:869
7586 " guestfs_cat (guestfs_h *g,\n"
7587 " const char *path);\n"
7592 #: ../src/guestfs-actions.pod:873 ../src/guestfs-actions.pod:5484
7593 #: ../fish/guestfish-actions.pod:585 ../fish/guestfish-actions.pod:3685
7594 msgid "Return the contents of the file named C<path>."
7598 #: ../src/guestfs-actions.pod:875
7600 "Note that this function cannot correctly handle binary files (specifically, "
7601 "files containing C<\\0> character which is treated as end of string). For "
7602 "those you need to use the C<guestfs_read_file> or C<guestfs_download> "
7603 "functions which have a more complex interface."
7607 #: ../src/guestfs-actions.pod:883 ../src/guestfs-actions.pod:1062
7608 #: ../src/guestfs-actions.pod:1082 ../src/guestfs-actions.pod:1378
7609 #: ../src/guestfs-actions.pod:1397 ../src/guestfs-actions.pod:1500
7610 #: ../src/guestfs-actions.pod:1519 ../src/guestfs-actions.pod:1765
7611 #: ../src/guestfs-actions.pod:2223 ../src/guestfs-actions.pod:2242
7612 #: ../src/guestfs-actions.pod:2285 ../src/guestfs-actions.pod:2309
7613 #: ../src/guestfs-actions.pod:2326 ../src/guestfs-actions.pod:2355
7614 #: ../src/guestfs-actions.pod:5266 ../src/guestfs-actions.pod:5292
7615 #: ../src/guestfs-actions.pod:5423 ../src/guestfs-actions.pod:5449
7616 #: ../src/guestfs-actions.pod:5473 ../src/guestfs-actions.pod:6401
7617 #: ../src/guestfs-actions.pod:6456 ../src/guestfs-actions.pod:6602
7618 #: ../src/guestfs-actions.pod:6626 ../src/guestfs-actions.pod:7295
7619 #: ../src/guestfs-actions.pod:7321 ../src/guestfs-actions.pod:7347
7620 #: ../src/guestfs-actions.pod:7366 ../src/guestfs-actions.pod:7451
7621 #: ../src/guestfs-actions.pod:7470 ../src/guestfs-actions.pod:7516
7622 #: ../src/guestfs-actions.pod:7535 ../fish/guestfish-actions.pod:592
7623 #: ../fish/guestfish-actions.pod:727 ../fish/guestfish-actions.pod:739
7624 #: ../fish/guestfish-actions.pod:915 ../fish/guestfish-actions.pod:925
7625 #: ../fish/guestfish-actions.pod:992 ../fish/guestfish-actions.pod:1002
7626 #: ../fish/guestfish-actions.pod:1194 ../fish/guestfish-actions.pod:1495
7627 #: ../fish/guestfish-actions.pod:1505 ../fish/guestfish-actions.pod:1533
7628 #: ../fish/guestfish-actions.pod:1548 ../fish/guestfish-actions.pod:1558
7629 #: ../fish/guestfish-actions.pod:1577 ../fish/guestfish-actions.pod:3555
7630 #: ../fish/guestfish-actions.pod:3570 ../fish/guestfish-actions.pod:3646
7631 #: ../fish/guestfish-actions.pod:3663 ../fish/guestfish-actions.pod:3678
7632 #: ../fish/guestfish-actions.pod:4332 ../fish/guestfish-actions.pod:4378
7633 #: ../fish/guestfish-actions.pod:4463 ../fish/guestfish-actions.pod:4478
7634 #: ../fish/guestfish-actions.pod:4888 ../fish/guestfish-actions.pod:4906
7635 #: ../fish/guestfish-actions.pod:4923 ../fish/guestfish-actions.pod:4933
7636 #: ../fish/guestfish-actions.pod:4981 ../fish/guestfish-actions.pod:4991
7637 #: ../fish/guestfish-actions.pod:5020 ../fish/guestfish-actions.pod:5030
7639 "Because of the message protocol, there is a transfer limit of somewhere "
7640 "between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
7644 #: ../src/guestfs-actions.pod:886 ../src/guestfs-actions.pod:3566
7645 #: ../src/guestfs-actions.pod:3628 ../src/guestfs-actions.pod:3645
7646 #: ../src/guestfs-actions.pod:3733 ../src/guestfs-actions.pod:4138
7647 #: ../src/guestfs-actions.pod:4152 ../src/guestfs-actions.pod:5372
7648 #: ../src/guestfs-actions.pod:5386 ../src/guestfs-actions.pod:7175
7649 #: ../src/guestfs-actions.pod:7189
7650 msgid "(Added in 0.4)"
7654 #: ../src/guestfs-actions.pod:888
7655 msgid "guestfs_checksum"
7659 #: ../src/guestfs-actions.pod:890
7663 " guestfs_checksum (guestfs_h *g,\n"
7664 " const char *csumtype,\n"
7665 " const char *path);\n"
7670 #: ../src/guestfs-actions.pod:895 ../fish/guestfish-actions.pod:599
7672 "This call computes the MD5, SHAx or CRC checksum of the file named C<path>."
7676 #: ../src/guestfs-actions.pod:898 ../fish/guestfish-actions.pod:602
7678 "The type of checksum to compute is given by the C<csumtype> parameter which "
7679 "must have one of the following values:"
7683 #: ../src/guestfs-actions.pod:903 ../fish/guestfish-actions.pod:607
7688 #: ../src/guestfs-actions.pod:905 ../fish/guestfish-actions.pod:609
7690 "Compute the cyclic redundancy check (CRC) specified by POSIX for the "
7695 #: ../src/guestfs-actions.pod:908 ../fish/guestfish-actions.pod:612
7700 #: ../src/guestfs-actions.pod:910 ../fish/guestfish-actions.pod:614
7701 msgid "Compute the MD5 hash (using the C<md5sum> program)."
7705 #: ../src/guestfs-actions.pod:912 ../fish/guestfish-actions.pod:616
7710 #: ../src/guestfs-actions.pod:914 ../fish/guestfish-actions.pod:618
7711 msgid "Compute the SHA1 hash (using the C<sha1sum> program)."
7715 #: ../src/guestfs-actions.pod:916 ../fish/guestfish-actions.pod:620
7720 #: ../src/guestfs-actions.pod:918 ../fish/guestfish-actions.pod:622
7721 msgid "Compute the SHA224 hash (using the C<sha224sum> program)."
7725 #: ../src/guestfs-actions.pod:920 ../fish/guestfish-actions.pod:624
7730 #: ../src/guestfs-actions.pod:922 ../fish/guestfish-actions.pod:626
7731 msgid "Compute the SHA256 hash (using the C<sha256sum> program)."
7735 #: ../src/guestfs-actions.pod:924 ../fish/guestfish-actions.pod:628
7740 #: ../src/guestfs-actions.pod:926 ../fish/guestfish-actions.pod:630
7741 msgid "Compute the SHA384 hash (using the C<sha384sum> program)."
7745 #: ../src/guestfs-actions.pod:928 ../fish/guestfish-actions.pod:632
7750 #: ../src/guestfs-actions.pod:930 ../fish/guestfish-actions.pod:634
7751 msgid "Compute the SHA512 hash (using the C<sha512sum> program)."
7755 #: ../src/guestfs-actions.pod:934 ../fish/guestfish-actions.pod:638
7756 msgid "The checksum is returned as a printable string."
7760 #: ../src/guestfs-actions.pod:936
7761 msgid "To get the checksum for a device, use C<guestfs_checksum_device>."
7765 #: ../src/guestfs-actions.pod:938
7766 msgid "To get the checksums for many files, use C<guestfs_checksums_out>."
7770 #: ../src/guestfs-actions.pod:943 ../src/guestfs-actions.pod:1251
7771 #: ../src/guestfs-actions.pod:2085 ../src/guestfs-actions.pod:3305
7772 #: ../src/guestfs-actions.pod:3334 ../src/guestfs-actions.pod:3395
7773 #: ../src/guestfs-actions.pod:3422 ../src/guestfs-actions.pod:6872
7774 msgid "(Added in 1.0.2)"
7778 #: ../src/guestfs-actions.pod:945
7779 msgid "guestfs_checksum_device"
7783 #: ../src/guestfs-actions.pod:947
7787 " guestfs_checksum_device (guestfs_h *g,\n"
7788 " const char *csumtype,\n"
7789 " const char *device);\n"
7794 #: ../src/guestfs-actions.pod:952
7796 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
7797 "device named C<device>. For the types of checksums supported see the "
7798 "C<guestfs_checksum> command."
7802 #: ../src/guestfs-actions.pod:959 ../src/guestfs-actions.pod:4903
7803 #: ../src/guestfs-actions.pod:4962 ../src/guestfs-actions.pod:4999
7804 #: ../src/guestfs-actions.pod:5017 ../src/guestfs-actions.pod:5193
7805 #: ../src/guestfs-actions.pod:6781 ../src/guestfs-actions.pod:6795
7806 #: ../src/guestfs-actions.pod:7201
7807 msgid "(Added in 1.3.2)"
7811 #: ../src/guestfs-actions.pod:961
7812 msgid "guestfs_checksums_out"
7816 #: ../src/guestfs-actions.pod:963
7820 " guestfs_checksums_out (guestfs_h *g,\n"
7821 " const char *csumtype,\n"
7822 " const char *directory,\n"
7823 " const char *sumsfile);\n"
7828 #: ../src/guestfs-actions.pod:969 ../fish/guestfish-actions.pod:656
7830 "This command computes the checksums of all regular files in C<directory> and "
7831 "then emits a list of those checksums to the local output file C<sumsfile>."
7835 #: ../src/guestfs-actions.pod:973 ../fish/guestfish-actions.pod:660
7837 "This can be used for verifying the integrity of a virtual machine. However "
7838 "to be properly secure you should pay attention to the output of the checksum "
7839 "command (it uses the ones from GNU coreutils). In particular when the "
7840 "filename is not printable, coreutils uses a special backslash syntax. For "
7841 "more information, see the GNU coreutils info file."
7845 #: ../src/guestfs-actions.pod:983
7846 msgid "(Added in 1.3.7)"
7850 #: ../src/guestfs-actions.pod:985
7851 msgid "guestfs_chmod"
7855 #: ../src/guestfs-actions.pod:987
7859 " guestfs_chmod (guestfs_h *g,\n"
7861 " const char *path);\n"
7866 #: ../src/guestfs-actions.pod:992 ../fish/guestfish-actions.pod:674
7868 "Change the mode (permissions) of C<path> to C<mode>. Only numeric modes are "
7873 #: ../src/guestfs-actions.pod:995 ../fish/guestfish-actions.pod:677
7875 "I<Note>: When using this command from guestfish, C<mode> by default would be "
7876 "decimal, unless you prefix it with C<0> to get octal, ie. use C<0700> not "
7881 #: ../src/guestfs-actions.pod:999 ../src/guestfs-actions.pod:4389
7882 #: ../src/guestfs-actions.pod:4586 ../src/guestfs-actions.pod:4605
7883 #: ../src/guestfs-actions.pod:4624 ../fish/guestfish-actions.pod:681
7884 #: ../fish/guestfish-actions.pod:2985 ../fish/guestfish-actions.pod:3114
7885 #: ../fish/guestfish-actions.pod:3124 ../fish/guestfish-actions.pod:3134
7886 msgid "The mode actually set is affected by the umask."
7890 #: ../src/guestfs-actions.pod:1005
7891 msgid "guestfs_chown"
7895 #: ../src/guestfs-actions.pod:1007
7899 " guestfs_chown (guestfs_h *g,\n"
7902 " const char *path);\n"
7907 #: ../src/guestfs-actions.pod:1013 ../fish/guestfish-actions.pod:687
7908 msgid "Change the file owner to C<owner> and group to C<group>."
7912 #: ../src/guestfs-actions.pod:1015 ../src/guestfs-actions.pod:3497
7913 #: ../fish/guestfish-actions.pod:689 ../fish/guestfish-actions.pod:2443
7915 "Only numeric uid and gid are supported. If you want to use names, you will "
7916 "need to locate and parse the password file yourself (Augeas support makes "
7917 "this relatively easy)."
7921 #: ../src/guestfs-actions.pod:1023
7922 msgid "guestfs_command"
7926 #: ../src/guestfs-actions.pod:1025
7930 " guestfs_command (guestfs_h *g,\n"
7931 " char *const *arguments);\n"
7936 #: ../src/guestfs-actions.pod:1029 ../fish/guestfish-actions.pod:697
7938 "This call runs a command from the guest filesystem. The filesystem must be "
7939 "mounted, and must contain a compatible operating system (ie. something "
7940 "Linux, with the same or compatible processor architecture)."
7944 #: ../src/guestfs-actions.pod:1034
7946 "The single parameter is an argv-style list of arguments. The first element "
7947 "is the name of the program to run. Subsequent elements are parameters. The "
7948 "list must be non-empty (ie. must contain a program name). Note that the "
7949 "command runs directly, and is I<not> invoked via the shell (see "
7954 #: ../src/guestfs-actions.pod:1041 ../fish/guestfish-actions.pod:709
7955 msgid "The return value is anything printed to I<stdout> by the command."
7959 #: ../src/guestfs-actions.pod:1044 ../fish/guestfish-actions.pod:712
7961 "If the command returns a non-zero exit status, then this function returns an "
7962 "error message. The error message string is the content of I<stderr> from "
7967 #: ../src/guestfs-actions.pod:1048 ../fish/guestfish-actions.pod:716
7969 "The C<$PATH> environment variable will contain at least C</usr/bin> and C</"
7970 "bin>. If you require a program from another location, you should provide "
7971 "the full path in the first parameter."
7975 #: ../src/guestfs-actions.pod:1053 ../fish/guestfish-actions.pod:721
7977 "Shared libraries and data files required by the program must be available on "
7978 "filesystems which are mounted in the correct places. It is the caller's "
7979 "responsibility to ensure all filesystems that are needed are mounted at the "
7984 #: ../src/guestfs-actions.pod:1065 ../src/guestfs-actions.pod:1085
7985 #: ../src/guestfs-actions.pod:1550
7986 msgid "(Added in 0.9.1)"
7990 #: ../src/guestfs-actions.pod:1067
7991 msgid "guestfs_command_lines"
7995 #: ../src/guestfs-actions.pod:1069
7999 " guestfs_command_lines (guestfs_h *g,\n"
8000 " char *const *arguments);\n"
8005 #: ../src/guestfs-actions.pod:1073
8007 "This is the same as C<guestfs_command>, but splits the result into a list of "
8012 #: ../src/guestfs-actions.pod:1076
8013 msgid "See also: C<guestfs_sh_lines>"
8017 #: ../src/guestfs-actions.pod:1087
8018 msgid "guestfs_config"
8022 #: ../src/guestfs-actions.pod:1089
8026 " guestfs_config (guestfs_h *g,\n"
8027 " const char *qemuparam,\n"
8028 " const char *qemuvalue);\n"
8033 #: ../src/guestfs-actions.pod:1094 ../fish/guestfish-actions.pod:746
8035 "This can be used to add arbitrary qemu command line parameters of the form "
8036 "I<-param value>. Actually it's not quite arbitrary - we prevent you from "
8037 "setting some parameters which would interfere with parameters that we use."
8041 #: ../src/guestfs-actions.pod:1099 ../fish/guestfish-actions.pod:751
8042 msgid "The first character of C<param> string must be a C<-> (dash)."
8046 #: ../src/guestfs-actions.pod:1101 ../fish/guestfish-actions.pod:753
8047 msgid "C<value> can be NULL."
8051 #: ../src/guestfs-actions.pod:1107
8052 msgid "guestfs_copy_size"
8056 #: ../src/guestfs-actions.pod:1109
8060 " guestfs_copy_size (guestfs_h *g,\n"
8061 " const char *src,\n"
8062 " const char *dest,\n"
8068 #: ../src/guestfs-actions.pod:1115 ../fish/guestfish-actions.pod:759
8070 "This command copies exactly C<size> bytes from one source device or file "
8071 "C<src> to another destination device or file C<dest>."
8075 #: ../src/guestfs-actions.pod:1118 ../fish/guestfish-actions.pod:762
8077 "Note this will fail if the source is too short or if the destination is not "
8082 #: ../src/guestfs-actions.pod:1123 ../src/guestfs-actions.pod:1246
8083 #: ../src/guestfs-actions.pod:1277 ../src/guestfs-actions.pod:1322
8084 #: ../src/guestfs-actions.pod:1699 ../src/guestfs-actions.pod:1721
8085 #: ../src/guestfs-actions.pod:3478 ../src/guestfs-actions.pod:6867
8086 #: ../src/guestfs-actions.pod:6901 ../src/guestfs-actions.pod:7387
8087 #: ../src/guestfs-actions.pod:7406
8089 "This long-running command can generate progress notification messages so "
8090 "that the caller can display a progress bar or indicator. To receive these "
8091 "messages, the caller must register a progress event callback. See L<guestfs"
8092 "(3)/GUESTFS_EVENT_PROGRESS>."
8096 #: ../src/guestfs-actions.pod:1128 ../src/guestfs-actions.pod:4165
8097 #: ../src/guestfs-actions.pod:5399 ../src/guestfs-actions.pod:7108
8098 #: ../src/guestfs-actions.pod:7128 ../src/guestfs-actions.pod:7214
8099 msgid "(Added in 1.0.87)"
8103 #: ../src/guestfs-actions.pod:1130
8108 #: ../src/guestfs-actions.pod:1132
8112 " guestfs_cp (guestfs_h *g,\n"
8113 " const char *src,\n"
8114 " const char *dest);\n"
8119 #: ../src/guestfs-actions.pod:1137 ../fish/guestfish-actions.pod:769
8121 "This copies a file from C<src> to C<dest> where C<dest> is either a "
8122 "destination filename or destination directory."
8126 #: ../src/guestfs-actions.pod:1142 ../src/guestfs-actions.pod:1156
8127 #: ../src/guestfs-actions.pod:1228 ../src/guestfs-actions.pod:1302
8128 #: ../src/guestfs-actions.pod:1416 ../src/guestfs-actions.pod:4857
8129 #: ../src/guestfs-actions.pod:5243
8130 msgid "(Added in 1.0.18)"
8134 #: ../src/guestfs-actions.pod:1144
8135 msgid "guestfs_cp_a"
8139 #: ../src/guestfs-actions.pod:1146
8143 " guestfs_cp_a (guestfs_h *g,\n"
8144 " const char *src,\n"
8145 " const char *dest);\n"
8150 #: ../src/guestfs-actions.pod:1151 ../fish/guestfish-actions.pod:776
8152 "This copies a file or directory from C<src> to C<dest> recursively using the "
8157 #: ../src/guestfs-actions.pod:1158
8162 #: ../src/guestfs-actions.pod:1160
8166 " guestfs_dd (guestfs_h *g,\n"
8167 " const char *src,\n"
8168 " const char *dest);\n"
8173 #: ../src/guestfs-actions.pod:1165 ../fish/guestfish-actions.pod:783
8175 "This command copies from one source device or file C<src> to another "
8176 "destination device or file C<dest>. Normally you would use this to copy to "
8177 "or from a device or partition, for example to duplicate a filesystem."
8181 #: ../src/guestfs-actions.pod:1170
8183 "If the destination is a device, it must be as large or larger than the "
8184 "source file or device, otherwise the copy will fail. This command cannot do "
8185 "partial copies (see C<guestfs_copy_size>)."
8189 #: ../src/guestfs-actions.pod:1178
8194 #: ../src/guestfs-actions.pod:1180
8198 " guestfs_df (guestfs_h *g);\n"
8203 #: ../src/guestfs-actions.pod:1183 ../fish/guestfish-actions.pod:796
8204 msgid "This command runs the C<df> command to report disk space used."
8208 #: ../src/guestfs-actions.pod:1185 ../src/guestfs-actions.pod:1202
8210 "This command is mostly useful for interactive sessions. It is I<not> "
8211 "intended that you try to parse the output string. Use C<guestfs_statvfs> "
8216 #: ../src/guestfs-actions.pod:1192 ../src/guestfs-actions.pod:1209
8217 #: ../src/guestfs-actions.pod:1327 ../src/guestfs-actions.pod:2288
8218 #: ../src/guestfs-actions.pod:2312 ../src/guestfs-actions.pod:2380
8219 #: ../src/guestfs-actions.pod:4275 ../src/guestfs-actions.pod:4757
8220 #: ../src/guestfs-actions.pod:6605 ../src/guestfs-actions.pod:6629
8221 #: ../src/guestfs-actions.pod:7254 ../src/guestfs-actions.pod:7267
8222 #: ../src/guestfs-actions.pod:7280
8223 msgid "(Added in 1.0.54)"
8227 #: ../src/guestfs-actions.pod:1194
8228 msgid "guestfs_df_h"
8232 #: ../src/guestfs-actions.pod:1196
8236 " guestfs_df_h (guestfs_h *g);\n"
8241 #: ../src/guestfs-actions.pod:1199 ../fish/guestfish-actions.pod:806
8243 "This command runs the C<df -h> command to report disk space used in human-"
8248 #: ../src/guestfs-actions.pod:1211
8249 msgid "guestfs_dmesg"
8253 #: ../src/guestfs-actions.pod:1213
8257 " guestfs_dmesg (guestfs_h *g);\n"
8262 #: ../src/guestfs-actions.pod:1216 ../fish/guestfish-actions.pod:817
8264 "This returns the kernel messages (C<dmesg> output) from the guest kernel. "
8265 "This is sometimes useful for extended debugging of problems."
8269 #: ../src/guestfs-actions.pod:1220
8271 "Another way to get the same information is to enable verbose messages with "
8272 "C<guestfs_set_verbose> or by setting the environment variable "
8273 "C<LIBGUESTFS_DEBUG=1> before running the program."
8277 #: ../src/guestfs-actions.pod:1230
8278 msgid "guestfs_download"
8282 #: ../src/guestfs-actions.pod:1232
8286 " guestfs_download (guestfs_h *g,\n"
8287 " const char *remotefilename,\n"
8288 " const char *filename);\n"
8293 #: ../src/guestfs-actions.pod:1237 ../src/guestfs-actions.pod:1262
8294 #: ../fish/guestfish-actions.pod:830 ../fish/guestfish-actions.pod:843
8296 "Download file C<remotefilename> and save it as C<filename> on the local "
8301 #: ../src/guestfs-actions.pod:1240 ../src/guestfs-actions.pod:6861
8302 #: ../fish/guestfish-actions.pod:833 ../fish/guestfish-actions.pod:4636
8303 msgid "C<filename> can also be a named pipe."
8307 #: ../src/guestfs-actions.pod:1242
8308 msgid "See also C<guestfs_upload>, C<guestfs_cat>."
8312 #: ../src/guestfs-actions.pod:1253
8313 msgid "guestfs_download_offset"
8317 #: ../src/guestfs-actions.pod:1255
8321 " guestfs_download_offset (guestfs_h *g,\n"
8322 " const char *remotefilename,\n"
8323 " const char *filename,\n"
8324 " int64_t offset,\n"
8330 #: ../src/guestfs-actions.pod:1265 ../fish/guestfish-actions.pod:846
8332 "C<remotefilename> is read for C<size> bytes starting at C<offset> (this "
8333 "region must be within the file or device)."
8337 #: ../src/guestfs-actions.pod:1268
8339 "Note that there is no limit on the amount of data that can be downloaded "
8340 "with this call, unlike with C<guestfs_pread>, and this call always reads the "
8341 "full amount unless an error occurs."
8345 #: ../src/guestfs-actions.pod:1273
8346 msgid "See also C<guestfs_download>, C<guestfs_pread>."
8350 #: ../src/guestfs-actions.pod:1282 ../src/guestfs-actions.pod:6906
8351 msgid "(Added in 1.5.17)"
8355 #: ../src/guestfs-actions.pod:1284
8356 msgid "guestfs_drop_caches"
8360 #: ../src/guestfs-actions.pod:1286
8364 " guestfs_drop_caches (guestfs_h *g,\n"
8365 " int whattodrop);\n"
8370 #: ../src/guestfs-actions.pod:1290 ../fish/guestfish-actions.pod:862
8372 "This instructs the guest kernel to drop its page cache, and/or dentries and "
8373 "inode caches. The parameter C<whattodrop> tells the kernel what precisely "
8374 "to drop, see L<http://linux-mm.org/Drop_Caches>"
8378 #: ../src/guestfs-actions.pod:1295 ../fish/guestfish-actions.pod:867
8379 msgid "Setting C<whattodrop> to 3 should drop everything."
8383 #: ../src/guestfs-actions.pod:1297 ../fish/guestfish-actions.pod:869
8385 "This automatically calls L<sync(2)> before the operation, so that the "
8386 "maximum guest memory is freed."
8390 #: ../src/guestfs-actions.pod:1304
8395 #: ../src/guestfs-actions.pod:1306
8399 " guestfs_du (guestfs_h *g,\n"
8400 " const char *path);\n"
8405 #: ../src/guestfs-actions.pod:1310 ../fish/guestfish-actions.pod:876
8407 "This command runs the C<du -s> command to estimate file space usage for "
8412 #: ../src/guestfs-actions.pod:1313 ../fish/guestfish-actions.pod:879
8414 "C<path> can be a file or a directory. If C<path> is a directory then the "
8415 "estimate includes the contents of the directory and all subdirectories "
8420 #: ../src/guestfs-actions.pod:1317 ../fish/guestfish-actions.pod:883
8422 "The result is the estimated size in I<kilobytes> (ie. units of 1024 bytes)."
8426 #: ../src/guestfs-actions.pod:1329
8427 msgid "guestfs_e2fsck_f"
8431 #: ../src/guestfs-actions.pod:1331
8435 " guestfs_e2fsck_f (guestfs_h *g,\n"
8436 " const char *device);\n"
8441 #: ../src/guestfs-actions.pod:1335 ../fish/guestfish-actions.pod:890
8443 "This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3 filesystem checker "
8444 "on C<device>, noninteractively (I<-p>), even if the filesystem appears to be "
8449 #: ../src/guestfs-actions.pod:1339
8451 "This command is only needed because of C<guestfs_resize2fs> (q.v.). "
8452 "Normally you should use C<guestfs_fsck>."
8456 #: ../src/guestfs-actions.pod:1344
8457 msgid "(Added in 1.0.29)"
8461 #: ../src/guestfs-actions.pod:1346
8462 msgid "guestfs_echo_daemon"
8466 #: ../src/guestfs-actions.pod:1348
8470 " guestfs_echo_daemon (guestfs_h *g,\n"
8471 " char *const *words);\n"
8476 #: ../src/guestfs-actions.pod:1352 ../fish/guestfish-actions.pod:901
8478 "This command concatenates the list of C<words> passed with single spaces "
8479 "between them and returns the resulting string."
8483 #: ../src/guestfs-actions.pod:1355 ../fish/guestfish-actions.pod:904
8484 msgid "You can use this command to test the connection through to the daemon."
8488 #: ../src/guestfs-actions.pod:1357
8489 msgid "See also C<guestfs_ping_daemon>."
8493 #: ../src/guestfs-actions.pod:1362 ../src/guestfs-actions.pod:2096
8494 #: ../src/guestfs-actions.pod:6077
8495 msgid "(Added in 1.0.69)"
8499 #: ../src/guestfs-actions.pod:1364
8500 msgid "guestfs_egrep"
8504 #: ../src/guestfs-actions.pod:1366
8508 " guestfs_egrep (guestfs_h *g,\n"
8509 " const char *regex,\n"
8510 " const char *path);\n"
8515 #: ../src/guestfs-actions.pod:1371 ../fish/guestfish-actions.pod:912
8517 "This calls the external C<egrep> program and returns the matching lines."
8521 #: ../src/guestfs-actions.pod:1381 ../src/guestfs-actions.pod:1400
8522 #: ../src/guestfs-actions.pod:1457 ../src/guestfs-actions.pod:1503
8523 #: ../src/guestfs-actions.pod:1522 ../src/guestfs-actions.pod:2226
8524 #: ../src/guestfs-actions.pod:2245 ../src/guestfs-actions.pod:2401
8525 #: ../src/guestfs-actions.pod:2414 ../src/guestfs-actions.pod:2429
8526 #: ../src/guestfs-actions.pod:2475 ../src/guestfs-actions.pod:2497
8527 #: ../src/guestfs-actions.pod:2510 ../src/guestfs-actions.pod:3658
8528 #: ../src/guestfs-actions.pod:3672 ../src/guestfs-actions.pod:3685
8529 #: ../src/guestfs-actions.pod:3699 ../src/guestfs-actions.pod:4685
8530 #: ../src/guestfs-actions.pod:5577 ../src/guestfs-actions.pod:5626
8531 #: ../src/guestfs-actions.pod:6473 ../src/guestfs-actions.pod:6485
8532 #: ../src/guestfs-actions.pod:6498 ../src/guestfs-actions.pod:6511
8533 #: ../src/guestfs-actions.pod:6533 ../src/guestfs-actions.pod:6546
8534 #: ../src/guestfs-actions.pod:6559 ../src/guestfs-actions.pod:6572
8535 #: ../src/guestfs-actions.pod:7350 ../src/guestfs-actions.pod:7369
8536 #: ../src/guestfs-actions.pod:7454 ../src/guestfs-actions.pod:7473
8537 #: ../src/guestfs-actions.pod:7519 ../src/guestfs-actions.pod:7538
8538 msgid "(Added in 1.0.66)"
8542 #: ../src/guestfs-actions.pod:1383
8543 msgid "guestfs_egrepi"
8547 #: ../src/guestfs-actions.pod:1385
8551 " guestfs_egrepi (guestfs_h *g,\n"
8552 " const char *regex,\n"
8553 " const char *path);\n"
8558 #: ../src/guestfs-actions.pod:1390 ../fish/guestfish-actions.pod:922
8560 "This calls the external C<egrep -i> program and returns the matching lines."
8564 #: ../src/guestfs-actions.pod:1402
8565 msgid "guestfs_equal"
8569 #: ../src/guestfs-actions.pod:1404
8573 " guestfs_equal (guestfs_h *g,\n"
8574 " const char *file1,\n"
8575 " const char *file2);\n"
8580 #: ../src/guestfs-actions.pod:1409 ../fish/guestfish-actions.pod:932
8582 "This compares the two files C<file1> and C<file2> and returns true if their "
8583 "content is exactly equal, or false otherwise."
8587 #: ../src/guestfs-actions.pod:1412 ../fish/guestfish-actions.pod:935
8588 msgid "The external L<cmp(1)> program is used for the comparison."
8592 #: ../src/guestfs-actions.pod:1418
8593 msgid "guestfs_exists"
8597 #: ../src/guestfs-actions.pod:1420
8601 " guestfs_exists (guestfs_h *g,\n"
8602 " const char *path);\n"
8607 #: ../src/guestfs-actions.pod:1424 ../fish/guestfish-actions.pod:941
8609 "This returns C<true> if and only if there is a file, directory (or anything) "
8610 "with the given C<path> name."
8614 #: ../src/guestfs-actions.pod:1427
8615 msgid "See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>."
8619 #: ../src/guestfs-actions.pod:1433
8620 msgid "guestfs_fallocate"
8624 #: ../src/guestfs-actions.pod:1435
8628 " guestfs_fallocate (guestfs_h *g,\n"
8629 " const char *path,\n"
8635 #: ../src/guestfs-actions.pod:1440 ../src/guestfs-actions.pod:1466
8636 #: ../fish/guestfish-actions.pod:950 ../fish/guestfish-actions.pod:969
8638 "This command preallocates a file (containing zero bytes) named C<path> of "
8639 "size C<len> bytes. If the file exists already, it is overwritten."
8643 #: ../src/guestfs-actions.pod:1444 ../fish/guestfish-actions.pod:954
8645 "Do not confuse this with the guestfish-specific C<alloc> command which "
8646 "allocates a file in the host and attaches it as a device."
8650 #: ../src/guestfs-actions.pod:1450
8652 "This function is deprecated. In new code, use the L</guestfs_fallocate64> "
8657 #: ../src/guestfs-actions.pod:1459
8658 msgid "guestfs_fallocate64"
8662 #: ../src/guestfs-actions.pod:1461
8666 " guestfs_fallocate64 (guestfs_h *g,\n"
8667 " const char *path,\n"
8673 #: ../src/guestfs-actions.pod:1470
8675 "Note that this call allocates disk blocks for the file. To create a sparse "
8676 "file use C<guestfs_truncate_size> instead."
8680 #: ../src/guestfs-actions.pod:1473
8682 "The deprecated call C<guestfs_fallocate> does the same, but owing to an "
8683 "oversight it only allowed 30 bit lengths to be specified, effectively "
8684 "limiting the maximum size of files created through that call to 1GB."
8688 #: ../src/guestfs-actions.pod:1478 ../fish/guestfish-actions.pod:981
8690 "Do not confuse this with the guestfish-specific C<alloc> and C<sparse> "
8691 "commands which create a file in the host and attach it as a device."
8695 #: ../src/guestfs-actions.pod:1484
8696 msgid "(Added in 1.3.17)"
8700 #: ../src/guestfs-actions.pod:1486
8701 msgid "guestfs_fgrep"
8705 #: ../src/guestfs-actions.pod:1488
8709 " guestfs_fgrep (guestfs_h *g,\n"
8710 " const char *pattern,\n"
8711 " const char *path);\n"
8716 #: ../src/guestfs-actions.pod:1493 ../fish/guestfish-actions.pod:989
8718 "This calls the external C<fgrep> program and returns the matching lines."
8722 #: ../src/guestfs-actions.pod:1505
8723 msgid "guestfs_fgrepi"
8727 #: ../src/guestfs-actions.pod:1507
8731 " guestfs_fgrepi (guestfs_h *g,\n"
8732 " const char *pattern,\n"
8733 " const char *path);\n"
8738 #: ../src/guestfs-actions.pod:1512 ../fish/guestfish-actions.pod:999
8740 "This calls the external C<fgrep -i> program and returns the matching lines."
8744 #: ../src/guestfs-actions.pod:1524
8745 msgid "guestfs_file"
8749 #: ../src/guestfs-actions.pod:1526
8753 " guestfs_file (guestfs_h *g,\n"
8754 " const char *path);\n"
8759 #: ../src/guestfs-actions.pod:1530 ../fish/guestfish-actions.pod:1009
8761 "This call uses the standard L<file(1)> command to determine the type or "
8762 "contents of the file."
8766 #: ../src/guestfs-actions.pod:1533 ../fish/guestfish-actions.pod:1012
8768 "This call will also transparently look inside various types of compressed "
8773 #: ../src/guestfs-actions.pod:1536 ../fish/guestfish-actions.pod:1015
8775 "The exact command which runs is C<file -zb path>. Note in particular that "
8776 "the filename is not prepended to the output (the I<-b> option)."
8780 #: ../src/guestfs-actions.pod:1540 ../fish/guestfish-actions.pod:1019
8782 "The output depends on the output of the underlying L<file(1)> command and it "
8783 "can change in future in ways beyond our control. In other words, the output "
8784 "is not guaranteed by the ABI."
8788 #: ../src/guestfs-actions.pod:1544
8790 "See also: L<file(1)>, C<guestfs_vfs_type>, C<guestfs_lstat>, "
8791 "C<guestfs_is_file>, C<guestfs_is_blockdev> (etc)."
8795 #: ../src/guestfs-actions.pod:1552
8796 msgid "guestfs_file_architecture"
8800 #: ../src/guestfs-actions.pod:1554
8804 " guestfs_file_architecture (guestfs_h *g,\n"
8805 " const char *filename);\n"
8810 #: ../src/guestfs-actions.pod:1558 ../fish/guestfish-actions.pod:1030
8812 "This detects the architecture of the binary C<filename>, and returns it if "
8817 #: ../src/guestfs-actions.pod:1561 ../fish/guestfish-actions.pod:1033
8818 msgid "Currently defined architectures are:"
8822 #: ../src/guestfs-actions.pod:1565 ../fish/guestfish-actions.pod:1037
8827 #: ../src/guestfs-actions.pod:1567 ../fish/guestfish-actions.pod:1039
8829 "This string is returned for all 32 bit i386, i486, i586, i686 binaries "
8830 "irrespective of the precise processor requirements of the binary."
8834 #: ../src/guestfs-actions.pod:1570 ../fish/guestfish-actions.pod:1042
8839 #: ../src/guestfs-actions.pod:1572 ../fish/guestfish-actions.pod:1044
8840 msgid "64 bit x86-64."
8844 #: ../src/guestfs-actions.pod:1574 ../fish/guestfish-actions.pod:1046
8849 #: ../src/guestfs-actions.pod:1576 ../fish/guestfish-actions.pod:1048
8850 msgid "32 bit SPARC."
8854 #: ../src/guestfs-actions.pod:1578 ../fish/guestfish-actions.pod:1050
8859 #: ../src/guestfs-actions.pod:1580 ../fish/guestfish-actions.pod:1052
8860 msgid "64 bit SPARC V9 and above."
8864 #: ../src/guestfs-actions.pod:1582 ../fish/guestfish-actions.pod:1054
8869 #: ../src/guestfs-actions.pod:1584 ../fish/guestfish-actions.pod:1056
8870 msgid "Intel Itanium."
8871 msgstr "Intel Itanium."
8874 #: ../src/guestfs-actions.pod:1586 ../fish/guestfish-actions.pod:1058
8879 #: ../src/guestfs-actions.pod:1588 ../fish/guestfish-actions.pod:1060
8880 msgid "32 bit Power PC."
8884 #: ../src/guestfs-actions.pod:1590 ../fish/guestfish-actions.pod:1062
8889 #: ../src/guestfs-actions.pod:1592 ../fish/guestfish-actions.pod:1064
8890 msgid "64 bit Power PC."
8894 #: ../src/guestfs-actions.pod:1596 ../fish/guestfish-actions.pod:1068
8895 msgid "Libguestfs may return other architecture strings in future."
8899 #: ../src/guestfs-actions.pod:1598 ../fish/guestfish-actions.pod:1070
8900 msgid "The function works on at least the following types of files:"
8904 #: ../src/guestfs-actions.pod:1604 ../fish/guestfish-actions.pod:1076
8905 msgid "many types of Un*x and Linux binary"
8909 #: ../src/guestfs-actions.pod:1608 ../fish/guestfish-actions.pod:1080
8910 msgid "many types of Un*x and Linux shared library"
8914 #: ../src/guestfs-actions.pod:1612 ../fish/guestfish-actions.pod:1084
8915 msgid "Windows Win32 and Win64 binaries"
8919 #: ../src/guestfs-actions.pod:1616 ../fish/guestfish-actions.pod:1088
8920 msgid "Windows Win32 and Win64 DLLs"
8924 #: ../src/guestfs-actions.pod:1618 ../fish/guestfish-actions.pod:1090
8925 msgid "Win32 binaries and DLLs return C<i386>."
8929 #: ../src/guestfs-actions.pod:1620 ../fish/guestfish-actions.pod:1092
8930 msgid "Win64 binaries and DLLs return C<x86_64>."
8934 #: ../src/guestfs-actions.pod:1624 ../fish/guestfish-actions.pod:1096
8935 msgid "Linux kernel modules"
8939 #: ../src/guestfs-actions.pod:1628 ../fish/guestfish-actions.pod:1100
8940 msgid "Linux new-style initrd images"
8944 #: ../src/guestfs-actions.pod:1632 ../fish/guestfish-actions.pod:1104
8945 msgid "some non-x86 Linux vmlinuz kernels"
8949 #: ../src/guestfs-actions.pod:1636 ../fish/guestfish-actions.pod:1108
8950 msgid "What it can't do currently:"
8954 #: ../src/guestfs-actions.pod:1642 ../fish/guestfish-actions.pod:1114
8955 msgid "static libraries (libfoo.a)"
8959 #: ../src/guestfs-actions.pod:1646 ../fish/guestfish-actions.pod:1118
8960 msgid "Linux old-style initrd as compressed ext2 filesystem (RHEL 3)"
8964 #: ../src/guestfs-actions.pod:1650 ../fish/guestfish-actions.pod:1122
8965 msgid "x86 Linux vmlinuz kernels"
8969 #: ../src/guestfs-actions.pod:1652 ../fish/guestfish-actions.pod:1124
8971 "x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and "
8972 "compressed code, and are horribly hard to unpack. If you want to find the "
8973 "architecture of a kernel, use the architecture of the associated initrd or "
8974 "kernel module(s) instead."
8978 #: ../src/guestfs-actions.pod:1662 ../src/guestfs-actions.pod:1825
8979 #: ../src/guestfs-actions.pod:1842 ../src/guestfs-actions.pod:2533
8980 #: ../src/guestfs-actions.pod:2626 ../src/guestfs-actions.pod:2696
8981 #: ../src/guestfs-actions.pod:2784 ../src/guestfs-actions.pod:2805
8982 #: ../src/guestfs-actions.pod:2848 ../src/guestfs-actions.pod:2932
8983 #: ../src/guestfs-actions.pod:3029 ../src/guestfs-actions.pod:3276
8984 #: ../src/guestfs-actions.pod:3408
8985 msgid "(Added in 1.5.3)"
8989 #: ../src/guestfs-actions.pod:1664
8990 msgid "guestfs_filesize"
8994 #: ../src/guestfs-actions.pod:1666
8998 " guestfs_filesize (guestfs_h *g,\n"
8999 " const char *file);\n"
9004 #: ../src/guestfs-actions.pod:1670 ../fish/guestfish-actions.pod:1135
9005 msgid "This command returns the size of C<file> in bytes."
9009 #: ../src/guestfs-actions.pod:1672
9011 "To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>, "
9012 "C<guestfs_is_dir>, C<guestfs_is_file> etc. To get the size of block "
9013 "devices, use C<guestfs_blockdev_getsize64>."
9017 #: ../src/guestfs-actions.pod:1678
9018 msgid "(Added in 1.0.82)"
9022 #: ../src/guestfs-actions.pod:1680
9023 msgid "guestfs_fill"
9027 #: ../src/guestfs-actions.pod:1682
9031 " guestfs_fill (guestfs_h *g,\n"
9034 " const char *path);\n"
9039 #: ../src/guestfs-actions.pod:1688 ../fish/guestfish-actions.pod:1145
9041 "This command creates a new file called C<path>. The initial content of the "
9042 "file is C<len> octets of C<c>, where C<c> must be a number in the range C<"
9047 #: ../src/guestfs-actions.pod:1692
9049 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
9050 "C<guestfs_truncate_size>. To create a file with a pattern of repeating "
9051 "bytes use C<guestfs_fill_pattern>."
9055 #: ../src/guestfs-actions.pod:1704
9056 msgid "(Added in 1.0.79)"
9060 #: ../src/guestfs-actions.pod:1706
9061 msgid "guestfs_fill_pattern"
9065 #: ../src/guestfs-actions.pod:1708
9069 " guestfs_fill_pattern (guestfs_h *g,\n"
9070 " const char *pattern,\n"
9072 " const char *path);\n"
9077 #: ../src/guestfs-actions.pod:1714
9079 "This function is like C<guestfs_fill> except that it creates a new file of "
9080 "length C<len> containing the repeating pattern of bytes in C<pattern>. The "
9081 "pattern is truncated if necessary to ensure the length of the file is "
9082 "exactly C<len> bytes."
9086 #: ../src/guestfs-actions.pod:1726
9087 msgid "(Added in 1.3.12)"
9091 #: ../src/guestfs-actions.pod:1728
9092 msgid "guestfs_find"
9096 #: ../src/guestfs-actions.pod:1730
9100 " guestfs_find (guestfs_h *g,\n"
9101 " const char *directory);\n"
9106 #: ../src/guestfs-actions.pod:1734 ../fish/guestfish-actions.pod:1167
9108 "This command lists out all files and directories, recursively, starting at "
9109 "C<directory>. It is essentially equivalent to running the shell command "
9110 "C<find directory -print> but some post-processing happens on the output, "
9115 #: ../src/guestfs-actions.pod:1739 ../fish/guestfish-actions.pod:1172
9117 "This returns a list of strings I<without any prefix>. Thus if the directory "
9122 #: ../src/guestfs-actions.pod:1742 ../fish/guestfish-actions.pod:1175
9132 #: ../src/guestfs-actions.pod:1746
9134 "then the returned list from C<guestfs_find> C</tmp> would be 4 elements:"
9138 #: ../src/guestfs-actions.pod:1749 ../fish/guestfish-actions.pod:1182
9149 #: ../src/guestfs-actions.pod:1754 ../fish/guestfish-actions.pod:1187
9150 msgid "If C<directory> is not a directory, then this command returns an error."
9154 #: ../src/guestfs-actions.pod:1757 ../fish/guestfish-actions.pod:1190
9155 msgid "The returned list is sorted."
9159 #: ../src/guestfs-actions.pod:1759
9160 msgid "See also C<guestfs_find0>."
9164 #: ../src/guestfs-actions.pod:1768 ../src/guestfs-actions.pod:4102
9165 #: ../src/guestfs-actions.pod:5661
9166 msgid "(Added in 1.0.27)"
9170 #: ../src/guestfs-actions.pod:1770
9171 msgid "guestfs_find0"
9175 #: ../src/guestfs-actions.pod:1772
9179 " guestfs_find0 (guestfs_h *g,\n"
9180 " const char *directory,\n"
9181 " const char *files);\n"
9186 #: ../src/guestfs-actions.pod:1777 ../fish/guestfish-actions.pod:1201
9188 "This command lists out all files and directories, recursively, starting at "
9189 "C<directory>, placing the resulting list in the external file called "
9194 #: ../src/guestfs-actions.pod:1781
9196 "This command works the same way as C<guestfs_find> with the following "
9201 #: ../src/guestfs-actions.pod:1788 ../fish/guestfish-actions.pod:1212
9202 msgid "The resulting list is written to an external file."
9206 #: ../src/guestfs-actions.pod:1792 ../fish/guestfish-actions.pod:1216
9208 "Items (filenames) in the result are separated by C<\\0> characters. See "
9209 "L<find(1)> option I<-print0>."
9213 #: ../src/guestfs-actions.pod:1797 ../fish/guestfish-actions.pod:1221
9214 msgid "This command is not limited in the number of names that it can return."
9218 #: ../src/guestfs-actions.pod:1802 ../fish/guestfish-actions.pod:1226
9219 msgid "The result list is not sorted."
9223 #: ../src/guestfs-actions.pod:1808
9224 msgid "(Added in 1.0.74)"
9228 #: ../src/guestfs-actions.pod:1810
9229 msgid "guestfs_findfs_label"
9233 #: ../src/guestfs-actions.pod:1812
9237 " guestfs_findfs_label (guestfs_h *g,\n"
9238 " const char *label);\n"
9243 #: ../src/guestfs-actions.pod:1816 ../fish/guestfish-actions.pod:1236
9245 "This command searches the filesystems and returns the one which has the "
9246 "given label. An error is returned if no such filesystem can be found."
9250 #: ../src/guestfs-actions.pod:1820
9251 msgid "To find the label of a filesystem, use C<guestfs_vfs_label>."
9255 #: ../src/guestfs-actions.pod:1827
9256 msgid "guestfs_findfs_uuid"
9260 #: ../src/guestfs-actions.pod:1829
9264 " guestfs_findfs_uuid (guestfs_h *g,\n"
9265 " const char *uuid);\n"
9270 #: ../src/guestfs-actions.pod:1833 ../fish/guestfish-actions.pod:1246
9272 "This command searches the filesystems and returns the one which has the "
9273 "given UUID. An error is returned if no such filesystem can be found."
9277 #: ../src/guestfs-actions.pod:1837
9278 msgid "To find the UUID of a filesystem, use C<guestfs_vfs_uuid>."
9282 #: ../src/guestfs-actions.pod:1844
9283 msgid "guestfs_fsck"
9287 #: ../src/guestfs-actions.pod:1846
9291 " guestfs_fsck (guestfs_h *g,\n"
9292 " const char *fstype,\n"
9293 " const char *device);\n"
9298 #: ../src/guestfs-actions.pod:1851 ../fish/guestfish-actions.pod:1256
9300 "This runs the filesystem checker (fsck) on C<device> which should have "
9301 "filesystem type C<fstype>."
9305 #: ../src/guestfs-actions.pod:1854 ../fish/guestfish-actions.pod:1259
9307 "The returned integer is the status. See L<fsck(8)> for the list of status "
9308 "codes from C<fsck>."
9312 #: ../src/guestfs-actions.pod:1863 ../fish/guestfish-actions.pod:1268
9313 msgid "Multiple status codes can be summed together."
9317 #: ../src/guestfs-actions.pod:1867 ../fish/guestfish-actions.pod:1272
9319 "A non-zero return code can mean \"success\", for example if errors have been "
9320 "corrected on the filesystem."
9324 #: ../src/guestfs-actions.pod:1872 ../fish/guestfish-actions.pod:1277
9325 msgid "Checking or repairing NTFS volumes is not supported (by linux-ntfs)."
9329 #: ../src/guestfs-actions.pod:1877 ../fish/guestfish-actions.pod:1282
9331 "This command is entirely equivalent to running C<fsck -a -t fstype device>."
9335 #: ../src/guestfs-actions.pod:1881 ../src/guestfs-actions.pod:7392
9336 msgid "(Added in 1.0.16)"
9340 #: ../src/guestfs-actions.pod:1883
9341 msgid "guestfs_get_append"
9345 #: ../src/guestfs-actions.pod:1885
9349 " guestfs_get_append (guestfs_h *g);\n"
9354 #: ../src/guestfs-actions.pod:1888 ../fish/guestfish-actions.pod:1288
9356 "Return the additional kernel options which are added to the guest kernel "
9361 #: ../src/guestfs-actions.pod:1891 ../fish/guestfish-actions.pod:1291
9362 msgid "If C<NULL> then no options are added."
9366 #: ../src/guestfs-actions.pod:1893
9368 "This function returns a string which may be NULL. There is no way to return "
9369 "an error from this function. The string is owned by the guest handle and "
9370 "must I<not> be freed."
9374 #: ../src/guestfs-actions.pod:1897 ../src/guestfs-actions.pod:5339
9375 #: ../src/guestfs-actions.pod:5819 ../src/guestfs-actions.pod:6240
9376 #: ../src/guestfs-actions.pod:6259 ../src/guestfs-actions.pod:6275
9377 #: ../src/guestfs-actions.pod:6299 ../src/guestfs-actions.pod:7056
9378 #: ../src/guestfs-actions.pod:7074 ../src/guestfs-actions.pod:7435
9379 msgid "(Added in 1.0.26)"
9383 #: ../src/guestfs-actions.pod:1899
9384 msgid "guestfs_get_attach_method"
9388 #: ../src/guestfs-actions.pod:1901
9392 " guestfs_get_attach_method (guestfs_h *g);\n"
9397 #: ../src/guestfs-actions.pod:1904
9398 msgid "Return the current attach method. See C<guestfs_set_attach_method>."
9402 #: ../src/guestfs-actions.pod:1909
9403 msgid "guestfs_get_autosync"
9407 #: ../src/guestfs-actions.pod:1911
9411 " guestfs_get_autosync (guestfs_h *g);\n"
9416 #: ../src/guestfs-actions.pod:1914 ../fish/guestfish-actions.pod:1303
9417 msgid "Get the autosync flag."
9421 #: ../src/guestfs-actions.pod:1920
9422 msgid "guestfs_get_direct"
9426 #: ../src/guestfs-actions.pod:1922
9430 " guestfs_get_direct (guestfs_h *g);\n"
9435 #: ../src/guestfs-actions.pod:1925 ../fish/guestfish-actions.pod:1309
9436 msgid "Return the direct appliance mode flag."
9440 #: ../src/guestfs-actions.pod:1929 ../src/guestfs-actions.pod:5888
9441 msgid "(Added in 1.0.72)"
9445 #: ../src/guestfs-actions.pod:1931
9446 msgid "guestfs_get_e2label"
9450 #: ../src/guestfs-actions.pod:1933
9454 " guestfs_get_e2label (guestfs_h *g,\n"
9455 " const char *device);\n"
9460 #: ../src/guestfs-actions.pod:1937 ../fish/guestfish-actions.pod:1315
9462 "This returns the ext2/3/4 filesystem label of the filesystem on C<device>."
9466 #: ../src/guestfs-actions.pod:1943
9468 "This function is deprecated. In new code, use the L</guestfs_vfs_label> "
9473 #: ../src/guestfs-actions.pod:1950 ../src/guestfs-actions.pod:1971
9474 #: ../src/guestfs-actions.pod:5906 ../src/guestfs-actions.pod:5925
9475 msgid "(Added in 1.0.15)"
9479 #: ../src/guestfs-actions.pod:1952
9480 msgid "guestfs_get_e2uuid"
9484 #: ../src/guestfs-actions.pod:1954
9488 " guestfs_get_e2uuid (guestfs_h *g,\n"
9489 " const char *device);\n"
9494 #: ../src/guestfs-actions.pod:1958 ../fish/guestfish-actions.pod:1329
9496 "This returns the ext2/3/4 filesystem UUID of the filesystem on C<device>."
9500 #: ../src/guestfs-actions.pod:1964
9502 "This function is deprecated. In new code, use the L</guestfs_vfs_uuid> call "
9507 #: ../src/guestfs-actions.pod:1973
9508 msgid "guestfs_get_memsize"
9512 #: ../src/guestfs-actions.pod:1975
9516 " guestfs_get_memsize (guestfs_h *g);\n"
9521 #: ../src/guestfs-actions.pod:1978 ../fish/guestfish-actions.pod:1343
9523 "This gets the memory size in megabytes allocated to the qemu subprocess."
9527 #: ../src/guestfs-actions.pod:1981
9529 "If C<guestfs_set_memsize> was not called on this handle, and if "
9530 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
9531 "value for memsize."
9535 #: ../src/guestfs-actions.pod:1985 ../src/guestfs-actions.pod:2066
9536 #: ../src/guestfs-actions.pod:5941 ../src/guestfs-actions.pod:6048
9537 #: ../fish/guestfish-actions.pod:1350 ../fish/guestfish-actions.pod:1401
9538 #: ../fish/guestfish-actions.pod:4011 ../fish/guestfish-actions.pod:4098
9540 "For more information on the architecture of libguestfs, see L<guestfs(3)>."
9544 #: ../src/guestfs-actions.pod:1990 ../src/guestfs-actions.pod:4393
9545 #: ../src/guestfs-actions.pod:4590 ../src/guestfs-actions.pod:4609
9546 #: ../src/guestfs-actions.pod:4628 ../src/guestfs-actions.pod:4640
9547 #: ../src/guestfs-actions.pod:4657 ../src/guestfs-actions.pod:4670
9548 #: ../src/guestfs-actions.pod:5564 ../src/guestfs-actions.pod:5946
9549 #: ../src/guestfs-actions.pod:6207 ../src/guestfs-actions.pod:6822
9550 msgid "(Added in 1.0.55)"
9554 #: ../src/guestfs-actions.pod:1992
9555 msgid "guestfs_get_network"
9559 #: ../src/guestfs-actions.pod:1994
9563 " guestfs_get_network (guestfs_h *g);\n"
9568 #: ../src/guestfs-actions.pod:1997 ../fish/guestfish-actions.pod:1357
9569 msgid "This returns the enable network flag."
9573 #: ../src/guestfs-actions.pod:2001 ../src/guestfs-actions.pod:5965
9574 msgid "(Added in 1.5.4)"
9578 #: ../src/guestfs-actions.pod:2003
9579 msgid "guestfs_get_path"
9583 #: ../src/guestfs-actions.pod:2005
9587 " guestfs_get_path (guestfs_h *g);\n"
9592 #: ../src/guestfs-actions.pod:2008 ../fish/guestfish-actions.pod:1363
9593 msgid "Return the current search path."
9597 #: ../src/guestfs-actions.pod:2010 ../fish/guestfish-actions.pod:1365
9599 "This is always non-NULL. If it wasn't set already, then this will return "
9604 #: ../src/guestfs-actions.pod:2013 ../src/guestfs-actions.pod:2042
9606 "This function returns a string, or NULL on error. The string is owned by "
9607 "the guest handle and must I<not> be freed."
9611 #: ../src/guestfs-actions.pod:2018
9612 msgid "guestfs_get_pid"
9616 #: ../src/guestfs-actions.pod:2020
9620 " guestfs_get_pid (guestfs_h *g);\n"
9625 #: ../src/guestfs-actions.pod:2023 ../fish/guestfish-actions.pod:1374
9627 "Return the process ID of the qemu subprocess. If there is no qemu "
9628 "subprocess, then this will return an error."
9632 #: ../src/guestfs-actions.pod:2026 ../fish/guestfish-actions.pod:1377
9633 msgid "This is an internal call used for debugging and testing."
9637 #: ../src/guestfs-actions.pod:2030
9638 msgid "(Added in 1.0.56)"
9642 #: ../src/guestfs-actions.pod:2032
9643 msgid "guestfs_get_qemu"
9647 #: ../src/guestfs-actions.pod:2034
9651 " guestfs_get_qemu (guestfs_h *g);\n"
9656 #: ../src/guestfs-actions.pod:2037 ../fish/guestfish-actions.pod:1383
9657 msgid "Return the current qemu binary."
9661 #: ../src/guestfs-actions.pod:2039 ../fish/guestfish-actions.pod:1385
9663 "This is always non-NULL. If it wasn't set already, then this will return "
9664 "the default qemu binary name."
9668 #: ../src/guestfs-actions.pod:2045 ../src/guestfs-actions.pod:6010
9669 msgid "(Added in 1.0.6)"
9673 #: ../src/guestfs-actions.pod:2047
9674 msgid "guestfs_get_recovery_proc"
9678 #: ../src/guestfs-actions.pod:2049
9682 " guestfs_get_recovery_proc (guestfs_h *g);\n"
9687 #: ../src/guestfs-actions.pod:2052 ../fish/guestfish-actions.pod:1392
9688 msgid "Return the recovery process enabled flag."
9692 #: ../src/guestfs-actions.pod:2056 ../src/guestfs-actions.pod:3503
9693 #: ../src/guestfs-actions.pod:3800 ../src/guestfs-actions.pod:4200
9694 #: ../src/guestfs-actions.pod:4232 ../src/guestfs-actions.pod:5269
9695 #: ../src/guestfs-actions.pod:5612 ../src/guestfs-actions.pod:6034
9696 #: ../src/guestfs-actions.pod:6725 ../src/guestfs-actions.pod:6745
9697 #: ../src/guestfs-actions.pod:6937
9698 msgid "(Added in 1.0.77)"
9702 #: ../src/guestfs-actions.pod:2058
9703 msgid "guestfs_get_selinux"
9707 #: ../src/guestfs-actions.pod:2060
9711 " guestfs_get_selinux (guestfs_h *g);\n"
9716 #: ../src/guestfs-actions.pod:2063
9718 "This returns the current setting of the selinux flag which is passed to the "
9719 "appliance at boot time. See C<guestfs_set_selinux>."
9723 #: ../src/guestfs-actions.pod:2071 ../src/guestfs-actions.pod:2134
9724 #: ../src/guestfs-actions.pod:6053 ../src/guestfs-actions.pod:6111
9725 msgid "(Added in 1.0.67)"
9729 #: ../src/guestfs-actions.pod:2073
9730 msgid "guestfs_get_state"
9734 #: ../src/guestfs-actions.pod:2075
9738 " guestfs_get_state (guestfs_h *g);\n"
9743 #: ../src/guestfs-actions.pod:2078 ../fish/guestfish-actions.pod:1408
9745 "This returns the current state as an opaque integer. This is only useful "
9746 "for printing debug and internal error messages."
9750 #: ../src/guestfs-actions.pod:2081 ../src/guestfs-actions.pod:3301
9751 #: ../src/guestfs-actions.pod:3330 ../src/guestfs-actions.pod:3391
9752 #: ../src/guestfs-actions.pod:3418 ../fish/guestfish-actions.pod:1411
9753 #: ../fish/guestfish-actions.pod:2325 ../fish/guestfish-actions.pod:2343
9754 #: ../fish/guestfish-actions.pod:2381 ../fish/guestfish-actions.pod:2397
9755 msgid "For more information on states, see L<guestfs(3)>."
9759 #: ../src/guestfs-actions.pod:2087
9760 msgid "guestfs_get_trace"
9764 #: ../src/guestfs-actions.pod:2089
9768 " guestfs_get_trace (guestfs_h *g);\n"
9773 #: ../src/guestfs-actions.pod:2092 ../fish/guestfish-actions.pod:1417
9774 msgid "Return the command trace flag."
9778 #: ../src/guestfs-actions.pod:2098
9779 msgid "guestfs_get_umask"
9783 #: ../src/guestfs-actions.pod:2100
9787 " guestfs_get_umask (guestfs_h *g);\n"
9792 #: ../src/guestfs-actions.pod:2103
9794 "Return the current umask. By default the umask is C<022> unless it has been "
9795 "set by calling C<guestfs_umask>."
9799 #: ../src/guestfs-actions.pod:2110
9800 msgid "guestfs_get_verbose"
9804 #: ../src/guestfs-actions.pod:2112
9808 " guestfs_get_verbose (guestfs_h *g);\n"
9813 #: ../src/guestfs-actions.pod:2115 ../fish/guestfish-actions.pod:1430
9814 msgid "This returns the verbose messages flag."
9818 #: ../src/guestfs-actions.pod:2121
9819 msgid "guestfs_getcon"
9823 #: ../src/guestfs-actions.pod:2123
9827 " guestfs_getcon (guestfs_h *g);\n"
9832 #: ../src/guestfs-actions.pod:2126 ../fish/guestfish-actions.pod:1436
9833 msgid "This gets the SELinux security context of the daemon."
9837 #: ../src/guestfs-actions.pod:2128
9839 "See the documentation about SELINUX in L<guestfs(3)>, and C<guestfs_setcon>"
9843 #: ../src/guestfs-actions.pod:2136
9844 msgid "guestfs_getxattr"
9848 #: ../src/guestfs-actions.pod:2138
9852 " guestfs_getxattr (guestfs_h *g,\n"
9853 " const char *path,\n"
9854 " const char *name,\n"
9855 " size_t *size_r);\n"
9860 #: ../src/guestfs-actions.pod:2144
9862 "Get a single extended attribute from file C<path> named C<name>. This call "
9863 "follows symlinks. If you want to lookup an extended attribute for the "
9864 "symlink itself, use C<guestfs_lgetxattr>."
9868 #: ../src/guestfs-actions.pod:2148 ../src/guestfs-actions.pod:3517
9870 "Normally it is better to get all extended attributes from a file in one go "
9871 "by calling C<guestfs_getxattrs>. However some Linux filesystem "
9872 "implementations are buggy and do not provide a way to list out attributes. "
9873 "For these filesystems (notably ntfs-3g) you have to know the names of the "
9874 "extended attributes you want in advance and call this function."
9878 #: ../src/guestfs-actions.pod:2155 ../src/guestfs-actions.pod:3524
9879 #: ../fish/guestfish-actions.pod:1456 ../fish/guestfish-actions.pod:2462
9881 "Extended attribute values are blobs of binary data. If there is no extended "
9882 "attribute named C<name>, this returns an error."
9886 #: ../src/guestfs-actions.pod:2158
9887 msgid "See also: C<guestfs_getxattrs>, C<guestfs_lgetxattr>, L<attr(5)>."
9891 #: ../src/guestfs-actions.pod:2160 ../src/guestfs-actions.pod:2351
9892 #: ../src/guestfs-actions.pod:3529 ../src/guestfs-actions.pod:5262
9893 #: ../src/guestfs-actions.pod:5288 ../src/guestfs-actions.pod:5469
9895 "This function returns a buffer, or NULL on error. The size of the returned "
9896 "buffer is written to C<*size_r>. I<The caller must free the returned buffer "
9901 #: ../src/guestfs-actions.pod:2164 ../src/guestfs-actions.pod:3533
9902 msgid "(Added in 1.7.24)"
9906 #: ../src/guestfs-actions.pod:2166
9907 msgid "guestfs_getxattrs"
9911 #: ../src/guestfs-actions.pod:2168
9914 " struct guestfs_xattr_list *\n"
9915 " guestfs_getxattrs (guestfs_h *g,\n"
9916 " const char *path);\n"
9921 #: ../src/guestfs-actions.pod:2172 ../fish/guestfish-actions.pod:1465
9923 "This call lists the extended attributes of the file or directory C<path>."
9927 #: ../src/guestfs-actions.pod:2175 ../fish/guestfish-actions.pod:1468
9929 "At the system call level, this is a combination of the L<listxattr(2)> and "
9930 "L<getxattr(2)> calls."
9934 #: ../src/guestfs-actions.pod:2178
9935 msgid "See also: C<guestfs_lgetxattrs>, L<attr(5)>."
9939 #: ../src/guestfs-actions.pod:2180 ../src/guestfs-actions.pod:3545
9940 #: ../src/guestfs-actions.pod:4196
9942 "This function returns a C<struct guestfs_xattr_list *>, or NULL if there was "
9943 "an error. I<The caller must call C<guestfs_free_xattr_list> after use>."
9947 #: ../src/guestfs-actions.pod:2184 ../src/guestfs-actions.pod:3549
9948 #: ../src/guestfs-actions.pod:3714 ../src/guestfs-actions.pod:3750
9949 #: ../src/guestfs-actions.pod:5642 ../src/guestfs-actions.pod:6130
9950 #: ../src/guestfs-actions.pod:7500
9951 msgid "(Added in 1.0.59)"
9955 #: ../src/guestfs-actions.pod:2186
9956 msgid "guestfs_glob_expand"
9960 #: ../src/guestfs-actions.pod:2188
9964 " guestfs_glob_expand (guestfs_h *g,\n"
9965 " const char *pattern);\n"
9970 #: ../src/guestfs-actions.pod:2192 ../fish/guestfish-actions.pod:1477
9972 "This command searches for all the pathnames matching C<pattern> according to "
9973 "the wildcard expansion rules used by the shell."
9977 #: ../src/guestfs-actions.pod:2196 ../fish/guestfish-actions.pod:1481
9979 "If no paths match, then this returns an empty list (note: not an error)."
9983 #: ../src/guestfs-actions.pod:2199 ../fish/guestfish-actions.pod:1484
9985 "It is just a wrapper around the C L<glob(3)> function with flags C<GLOB_MARK|"
9986 "GLOB_BRACE>. See that manual page for more details."
9990 #: ../src/guestfs-actions.pod:2207 ../src/guestfs-actions.pod:6323
9991 #: ../src/guestfs-actions.pod:6340
9992 msgid "(Added in 1.0.50)"
9996 #: ../src/guestfs-actions.pod:2209
9997 msgid "guestfs_grep"
10001 #: ../src/guestfs-actions.pod:2211
10005 " guestfs_grep (guestfs_h *g,\n"
10006 " const char *regex,\n"
10007 " const char *path);\n"
10012 #: ../src/guestfs-actions.pod:2216 ../fish/guestfish-actions.pod:1492
10013 msgid "This calls the external C<grep> program and returns the matching lines."
10017 #: ../src/guestfs-actions.pod:2228
10018 msgid "guestfs_grepi"
10022 #: ../src/guestfs-actions.pod:2230
10026 " guestfs_grepi (guestfs_h *g,\n"
10027 " const char *regex,\n"
10028 " const char *path);\n"
10033 #: ../src/guestfs-actions.pod:2235 ../fish/guestfish-actions.pod:1502
10035 "This calls the external C<grep -i> program and returns the matching lines."
10039 #: ../src/guestfs-actions.pod:2247
10040 msgid "guestfs_grub_install"
10044 #: ../src/guestfs-actions.pod:2249
10048 " guestfs_grub_install (guestfs_h *g,\n"
10049 " const char *root,\n"
10050 " const char *device);\n"
10055 #: ../src/guestfs-actions.pod:2254 ../fish/guestfish-actions.pod:1512
10057 "This command installs GRUB (the Grand Unified Bootloader) on C<device>, with "
10058 "the root directory being C<root>."
10062 #: ../src/guestfs-actions.pod:2257 ../fish/guestfish-actions.pod:1515
10064 "Note: If grub-install reports the error \"No suitable drive was found in the "
10065 "generated device map.\" it may be that you need to create a C</boot/grub/"
10066 "device.map> file first that contains the mapping between grub device names "
10067 "and Linux device names. It is usually sufficient to create a file "
10072 #: ../src/guestfs-actions.pod:2264 ../fish/guestfish-actions.pod:1522
10075 " (hd0) /dev/vda\n"
10080 #: ../src/guestfs-actions.pod:2266 ../fish/guestfish-actions.pod:1524
10081 msgid "replacing C</dev/vda> with the name of the installation device."
10085 #: ../src/guestfs-actions.pod:2270
10086 msgid "(Added in 1.0.17)"
10090 #: ../src/guestfs-actions.pod:2272
10091 msgid "guestfs_head"
10095 #: ../src/guestfs-actions.pod:2274
10099 " guestfs_head (guestfs_h *g,\n"
10100 " const char *path);\n"
10105 #: ../src/guestfs-actions.pod:2278 ../fish/guestfish-actions.pod:1530
10107 "This command returns up to the first 10 lines of a file as a list of strings."
10111 #: ../src/guestfs-actions.pod:2290
10112 msgid "guestfs_head_n"
10116 #: ../src/guestfs-actions.pod:2292
10120 " guestfs_head_n (guestfs_h *g,\n"
10122 " const char *path);\n"
10127 #: ../src/guestfs-actions.pod:2297 ../fish/guestfish-actions.pod:1540
10129 "If the parameter C<nrlines> is a positive number, this returns the first "
10130 "C<nrlines> lines of the file C<path>."
10134 #: ../src/guestfs-actions.pod:2300 ../fish/guestfish-actions.pod:1543
10136 "If the parameter C<nrlines> is a negative number, this returns lines from "
10137 "the file C<path>, excluding the last C<nrlines> lines."
10141 #: ../src/guestfs-actions.pod:2303 ../src/guestfs-actions.pod:6620
10142 #: ../fish/guestfish-actions.pod:1546 ../fish/guestfish-actions.pod:4476
10143 msgid "If the parameter C<nrlines> is zero, this returns an empty list."
10147 #: ../src/guestfs-actions.pod:2314
10148 msgid "guestfs_hexdump"
10152 #: ../src/guestfs-actions.pod:2316
10156 " guestfs_hexdump (guestfs_h *g,\n"
10157 " const char *path);\n"
10162 #: ../src/guestfs-actions.pod:2320 ../fish/guestfish-actions.pod:1555
10164 "This runs C<hexdump -C> on the given C<path>. The result is the human-"
10165 "readable, canonical hex dump of the file."
10169 #: ../src/guestfs-actions.pod:2329 ../src/guestfs-actions.pod:6404
10170 #: ../src/guestfs-actions.pod:6459
10171 msgid "(Added in 1.0.22)"
10175 #: ../src/guestfs-actions.pod:2331
10176 msgid "guestfs_initrd_cat"
10180 #: ../src/guestfs-actions.pod:2333
10184 " guestfs_initrd_cat (guestfs_h *g,\n"
10185 " const char *initrdpath,\n"
10186 " const char *filename,\n"
10187 " size_t *size_r);\n"
10192 #: ../src/guestfs-actions.pod:2339 ../fish/guestfish-actions.pod:1565
10194 "This command unpacks the file C<filename> from the initrd file called "
10195 "C<initrdpath>. The filename must be given I<without> the initial C</> "
10200 #: ../src/guestfs-actions.pod:2343 ../fish/guestfish-actions.pod:1569
10202 "For example, in guestfish you could use the following command to examine the "
10203 "boot script (usually called C</init>) contained in a Linux initrd or "
10208 #: ../src/guestfs-actions.pod:2347 ../fish/guestfish-actions.pod:1573
10211 " initrd-cat /boot/initrd-<version>.img init\n"
10216 #: ../src/guestfs-actions.pod:2349
10217 msgid "See also C<guestfs_initrd_list>."
10221 #: ../src/guestfs-actions.pod:2360
10222 msgid "guestfs_initrd_list"
10226 #: ../src/guestfs-actions.pod:2362
10230 " guestfs_initrd_list (guestfs_h *g,\n"
10231 " const char *path);\n"
10236 #: ../src/guestfs-actions.pod:2366 ../fish/guestfish-actions.pod:1584
10237 msgid "This command lists out files contained in an initrd."
10241 #: ../src/guestfs-actions.pod:2368 ../fish/guestfish-actions.pod:1586
10243 "The files are listed without any initial C</> character. The files are "
10244 "listed in the order they appear (not necessarily alphabetical). Directory "
10245 "names are listed as separate items."
10249 #: ../src/guestfs-actions.pod:2372 ../fish/guestfish-actions.pod:1590
10251 "Old Linux kernels (2.4 and earlier) used a compressed ext2 filesystem as "
10252 "initrd. We I<only> support the newer initramfs format (compressed cpio "
10257 #: ../src/guestfs-actions.pod:2382
10258 msgid "guestfs_inotify_add_watch"
10262 #: ../src/guestfs-actions.pod:2384
10266 " guestfs_inotify_add_watch (guestfs_h *g,\n"
10267 " const char *path,\n"
10273 #: ../src/guestfs-actions.pod:2389 ../fish/guestfish-actions.pod:1598
10274 msgid "Watch C<path> for the events listed in C<mask>."
10278 #: ../src/guestfs-actions.pod:2391 ../fish/guestfish-actions.pod:1600
10280 "Note that if C<path> is a directory then events within that directory are "
10281 "watched, but this does I<not> happen recursively (in subdirectories)."
10285 #: ../src/guestfs-actions.pod:2395 ../fish/guestfish-actions.pod:1604
10287 "Note for non-C or non-Linux callers: the inotify events are defined by the "
10288 "Linux kernel ABI and are listed in C</usr/include/sys/inotify.h>."
10292 #: ../src/guestfs-actions.pod:2403
10293 msgid "guestfs_inotify_close"
10297 #: ../src/guestfs-actions.pod:2405
10301 " guestfs_inotify_close (guestfs_h *g);\n"
10306 #: ../src/guestfs-actions.pod:2408 ../fish/guestfish-actions.pod:1612
10308 "This closes the inotify handle which was previously opened by inotify_init. "
10309 "It removes all watches, throws away any pending events, and deallocates all "
10314 #: ../src/guestfs-actions.pod:2416
10315 msgid "guestfs_inotify_files"
10319 #: ../src/guestfs-actions.pod:2418
10323 " guestfs_inotify_files (guestfs_h *g);\n"
10328 #: ../src/guestfs-actions.pod:2421
10330 "This function is a helpful wrapper around C<guestfs_inotify_read> which just "
10331 "returns a list of pathnames of objects that were touched. The returned "
10332 "pathnames are sorted and deduplicated."
10336 #: ../src/guestfs-actions.pod:2431
10337 msgid "guestfs_inotify_init"
10341 #: ../src/guestfs-actions.pod:2433
10345 " guestfs_inotify_init (guestfs_h *g,\n"
10346 " int maxevents);\n"
10351 #: ../src/guestfs-actions.pod:2437 ../fish/guestfish-actions.pod:1628
10353 "This command creates a new inotify handle. The inotify subsystem can be "
10354 "used to notify events which happen to objects in the guest filesystem."
10358 #: ../src/guestfs-actions.pod:2441
10360 "C<maxevents> is the maximum number of events which will be queued up between "
10361 "calls to C<guestfs_inotify_read> or C<guestfs_inotify_files>. If this is "
10362 "passed as C<0>, then the kernel (or previously set) default is used. For "
10363 "Linux 2.6.29 the default was 16384 events. Beyond this limit, the kernel "
10364 "throws away events, but records the fact that it threw them away by setting "
10365 "a flag C<IN_Q_OVERFLOW> in the returned structure list (see "
10366 "C<guestfs_inotify_read>)."
10370 #: ../src/guestfs-actions.pod:2451
10372 "Before any events are generated, you have to add some watches to the "
10373 "internal watch list. See: C<guestfs_inotify_add_watch>, "
10374 "C<guestfs_inotify_rm_watch> and C<guestfs_inotify_watch_all>."
10378 #: ../src/guestfs-actions.pod:2457
10380 "Queued up events should be read periodically by calling "
10381 "C<guestfs_inotify_read> (or C<guestfs_inotify_files> which is just a helpful "
10382 "wrapper around C<guestfs_inotify_read>). If you don't read the events out "
10383 "often enough then you risk the internal queue overflowing."
10387 #: ../src/guestfs-actions.pod:2464
10389 "The handle should be closed after use by calling C<guestfs_inotify_close>. "
10390 "This also removes any watches automatically."
10394 #: ../src/guestfs-actions.pod:2468 ../fish/guestfish-actions.pod:1659
10396 "See also L<inotify(7)> for an overview of the inotify interface as exposed "
10397 "by the Linux kernel, which is roughly what we expose via libguestfs. Note "
10398 "that there is one global inotify handle per libguestfs instance."
10402 #: ../src/guestfs-actions.pod:2477
10403 msgid "guestfs_inotify_read"
10407 #: ../src/guestfs-actions.pod:2479
10410 " struct guestfs_inotify_event_list *\n"
10411 " guestfs_inotify_read (guestfs_h *g);\n"
10416 #: ../src/guestfs-actions.pod:2482 ../fish/guestfish-actions.pod:1668
10418 "Return the complete queue of events that have happened since the previous "
10423 #: ../src/guestfs-actions.pod:2485 ../fish/guestfish-actions.pod:1671
10424 msgid "If no events have happened, this returns an empty list."
10428 #: ../src/guestfs-actions.pod:2487 ../fish/guestfish-actions.pod:1673
10430 "I<Note>: In order to make sure that all events have been read, you must call "
10431 "this function repeatedly until it returns an empty list. The reason is that "
10432 "the call will read events up to the maximum appliance-to-host message size "
10433 "and leave remaining events in the queue."
10437 #: ../src/guestfs-actions.pod:2493
10439 "This function returns a C<struct guestfs_inotify_event_list *>, or NULL if "
10440 "there was an error. I<The caller must call "
10441 "C<guestfs_free_inotify_event_list> after use>."
10445 #: ../src/guestfs-actions.pod:2499
10446 msgid "guestfs_inotify_rm_watch"
10450 #: ../src/guestfs-actions.pod:2501
10454 " guestfs_inotify_rm_watch (guestfs_h *g,\n"
10460 #: ../src/guestfs-actions.pod:2505
10462 "Remove a previously defined inotify watch. See C<guestfs_inotify_add_watch>."
10466 #: ../src/guestfs-actions.pod:2512
10467 msgid "guestfs_inspect_get_arch"
10471 #: ../src/guestfs-actions.pod:2514
10475 " guestfs_inspect_get_arch (guestfs_h *g,\n"
10476 " const char *root);\n"
10481 #: ../src/guestfs-actions.pod:2518 ../src/guestfs-actions.pod:2541
10482 #: ../src/guestfs-actions.pod:2634 ../src/guestfs-actions.pod:2678
10483 #: ../src/guestfs-actions.pod:2704 ../src/guestfs-actions.pod:2743
10484 #: ../src/guestfs-actions.pod:2765 ../src/guestfs-actions.pod:2792
10485 #: ../src/guestfs-actions.pod:2813 ../src/guestfs-actions.pod:2856
10486 #: ../src/guestfs-actions.pod:2885 ../src/guestfs-actions.pod:2916
10487 #: ../src/guestfs-actions.pod:2940 ../src/guestfs-actions.pod:2995
10488 #: ../src/guestfs-actions.pod:3037 ../src/guestfs-actions.pod:3058
10489 #: ../src/guestfs-actions.pod:3081 ../src/guestfs-actions.pod:3098
10490 #: ../src/guestfs-actions.pod:3115 ../src/guestfs-actions.pod:3134
10492 "This function should only be called with a root device string as returned by "
10493 "C<guestfs_inspect_os>."
10497 #: ../src/guestfs-actions.pod:2521
10499 "This returns the architecture of the inspected operating system. The "
10500 "possible return values are listed under C<guestfs_file_architecture>."
10504 #: ../src/guestfs-actions.pod:2525 ../fish/guestfish-actions.pod:1697
10506 "If the architecture could not be determined, then the string C<unknown> is "
10511 #: ../src/guestfs-actions.pod:2528 ../src/guestfs-actions.pod:2621
10512 #: ../src/guestfs-actions.pod:2732 ../src/guestfs-actions.pod:2752
10513 #: ../src/guestfs-actions.pod:2780 ../src/guestfs-actions.pod:2872
10514 #: ../src/guestfs-actions.pod:2903 ../src/guestfs-actions.pod:2927
10515 #: ../src/guestfs-actions.pod:2981 ../src/guestfs-actions.pod:3024
10516 #: ../src/guestfs-actions.pod:3047 ../src/guestfs-actions.pod:3068
10517 #: ../src/guestfs-actions.pod:3088 ../src/guestfs-actions.pod:3105
10518 #: ../src/guestfs-actions.pod:3124 ../src/guestfs-actions.pod:3227
10519 #: ../src/guestfs-actions.pod:3268 ../fish/guestfish-actions.pod:1700
10520 #: ../fish/guestfish-actions.pod:1786 ../fish/guestfish-actions.pod:1874
10521 #: ../fish/guestfish-actions.pod:1889 ../fish/guestfish-actions.pod:1910
10522 #: ../fish/guestfish-actions.pod:1980 ../fish/guestfish-actions.pod:2004
10523 #: ../fish/guestfish-actions.pod:2021 ../fish/guestfish-actions.pod:2064
10524 #: ../fish/guestfish-actions.pod:2099 ../fish/guestfish-actions.pod:2115
10525 #: ../fish/guestfish-actions.pod:2131 ../fish/guestfish-actions.pod:2144
10526 #: ../fish/guestfish-actions.pod:2157 ../fish/guestfish-actions.pod:2172
10527 #: ../fish/guestfish-actions.pod:2271 ../fish/guestfish-actions.pod:2305
10528 msgid "Please read L<guestfs(3)/INSPECTION> for more details."
10532 #: ../src/guestfs-actions.pod:2535
10533 msgid "guestfs_inspect_get_distro"
10537 #: ../src/guestfs-actions.pod:2537
10541 " guestfs_inspect_get_distro (guestfs_h *g,\n"
10542 " const char *root);\n"
10547 #: ../src/guestfs-actions.pod:2544 ../fish/guestfish-actions.pod:1709
10549 "This returns the distro (distribution) of the inspected operating system."
10553 #: ../src/guestfs-actions.pod:2547 ../fish/guestfish-actions.pod:1712
10554 msgid "Currently defined distros are:"
10558 #: ../src/guestfs-actions.pod:2551 ../fish/guestfish-actions.pod:1716
10559 msgid "\"archlinux\""
10560 msgstr "\"archlinux\""
10563 #: ../src/guestfs-actions.pod:2553 ../fish/guestfish-actions.pod:1718
10564 msgid "Arch Linux."
10565 msgstr "Arch Linux."
10568 #: ../src/guestfs-actions.pod:2555 ../fish/guestfish-actions.pod:1720
10570 #| msgid "\"gentoo\""
10572 msgstr "\"gentoo\""
10575 #: ../src/guestfs-actions.pod:2557 ../fish/guestfish-actions.pod:1722
10580 #: ../src/guestfs-actions.pod:2559 ../fish/guestfish-actions.pod:1724
10582 msgstr "\"debian\""
10585 #: ../src/guestfs-actions.pod:2561 ../fish/guestfish-actions.pod:1726
10590 #: ../src/guestfs-actions.pod:2563 ../fish/guestfish-actions.pod:1728
10592 msgstr "\"fedora\""
10595 #: ../src/guestfs-actions.pod:2565 ../fish/guestfish-actions.pod:1730
10600 #: ../src/guestfs-actions.pod:2567 ../fish/guestfish-actions.pod:1732
10602 msgstr "\"gentoo\""
10605 #: ../src/guestfs-actions.pod:2569 ../fish/guestfish-actions.pod:1734
10610 #: ../src/guestfs-actions.pod:2571 ../fish/guestfish-actions.pod:1736
10611 msgid "\"linuxmint\""
10612 msgstr "\"linuxmint\""
10615 #: ../src/guestfs-actions.pod:2573 ../fish/guestfish-actions.pod:1738
10616 msgid "Linux Mint."
10617 msgstr "Linux Mint."
10620 #: ../src/guestfs-actions.pod:2575 ../fish/guestfish-actions.pod:1740
10621 msgid "\"mandriva\""
10622 msgstr "\"mandriva\""
10625 #: ../src/guestfs-actions.pod:2577 ../fish/guestfish-actions.pod:1742
10630 #: ../src/guestfs-actions.pod:2579 ../fish/guestfish-actions.pod:1744
10635 #: ../src/guestfs-actions.pod:2581 ../fish/guestfish-actions.pod:1746
10640 #: ../src/guestfs-actions.pod:2583 ../fish/guestfish-actions.pod:1748
10642 msgstr "\"pardus\""
10645 #: ../src/guestfs-actions.pod:2585 ../fish/guestfish-actions.pod:1750
10650 #: ../src/guestfs-actions.pod:2587 ../fish/guestfish-actions.pod:1752
10651 msgid "\"redhat-based\""
10652 msgstr "\"redhat-based\""
10655 #: ../src/guestfs-actions.pod:2589 ../fish/guestfish-actions.pod:1754
10656 msgid "Some Red Hat-derived distro."
10657 msgstr "Дистрибутив, що походить від Red Hat."
10660 #: ../src/guestfs-actions.pod:2591 ../fish/guestfish-actions.pod:1756
10665 #: ../src/guestfs-actions.pod:2593 ../fish/guestfish-actions.pod:1758
10667 #| msgid "Red Hat Enterprise Linux and some derivatives."
10668 msgid "Red Hat Enterprise Linux."
10669 msgstr "Red Hat Enterprise Linux та деякі з похідних дистрибутивів."
10672 #: ../src/guestfs-actions.pod:2595 ../fish/guestfish-actions.pod:1760
10673 msgid "\"scientificlinux\""
10677 #: ../src/guestfs-actions.pod:2597 ../fish/guestfish-actions.pod:1762
10678 msgid "Scientific Linux."
10682 #: ../src/guestfs-actions.pod:2599 ../fish/guestfish-actions.pod:1764
10683 msgid "\"slackware\""
10687 #: ../src/guestfs-actions.pod:2601 ../fish/guestfish-actions.pod:1766
10692 #: ../src/guestfs-actions.pod:2603 ../fish/guestfish-actions.pod:1768
10694 msgstr "\"ubuntu\""
10697 #: ../src/guestfs-actions.pod:2605 ../fish/guestfish-actions.pod:1770
10702 #: ../src/guestfs-actions.pod:2607 ../src/guestfs-actions.pod:2723
10703 #: ../src/guestfs-actions.pod:3015 ../fish/guestfish-actions.pod:1772
10704 #: ../fish/guestfish-actions.pod:1865 ../fish/guestfish-actions.pod:2090
10705 msgid "\"unknown\""
10706 msgstr "\"unknown\""
10709 #: ../src/guestfs-actions.pod:2609 ../fish/guestfish-actions.pod:1774
10710 msgid "The distro could not be determined."
10711 msgstr "Дистрибутив, тип якого не вдалося визначити."
10714 #: ../src/guestfs-actions.pod:2611 ../src/guestfs-actions.pod:3007
10715 #: ../fish/guestfish-actions.pod:1776 ../fish/guestfish-actions.pod:2082
10716 msgid "\"windows\""
10717 msgstr "\"windows\""
10720 #: ../src/guestfs-actions.pod:2613 ../fish/guestfish-actions.pod:1778
10722 "Windows does not have distributions. This string is returned if the OS type "
10727 #: ../src/guestfs-actions.pod:2618 ../src/guestfs-actions.pod:2729
10728 #: ../src/guestfs-actions.pod:3021 ../fish/guestfish-actions.pod:1783
10729 #: ../fish/guestfish-actions.pod:1871 ../fish/guestfish-actions.pod:2096
10731 "Future versions of libguestfs may return other strings here. The caller "
10732 "should be prepared to handle any string."
10736 #: ../src/guestfs-actions.pod:2628
10737 msgid "guestfs_inspect_get_drive_mappings"
10741 #: ../src/guestfs-actions.pod:2630
10745 " guestfs_inspect_get_drive_mappings (guestfs_h *g,\n"
10746 " const char *root);\n"
10751 #: ../src/guestfs-actions.pod:2637 ../fish/guestfish-actions.pod:1795
10753 "This call is useful for Windows which uses a primitive system of assigning "
10754 "drive letters (like \"C:\") to partitions. This inspection API examines the "
10755 "Windows Registry to find out how disks/partitions are mapped to drive "
10756 "letters, and returns a hash table as in the example below:"
10760 #: ../src/guestfs-actions.pod:2643 ../fish/guestfish-actions.pod:1801
10763 " C => /dev/vda2\n"
10764 " E => /dev/vdb1\n"
10765 " F => /dev/vdc1\n"
10770 #: ../src/guestfs-actions.pod:2647 ../fish/guestfish-actions.pod:1805
10772 "Note that keys are drive letters. For Windows, the key is case insensitive "
10773 "and just contains the drive letter, without the customary colon separator "
10778 #: ../src/guestfs-actions.pod:2651 ../fish/guestfish-actions.pod:1809
10780 "In future we may support other operating systems that also used drive "
10781 "letters, but the keys for those might not be case insensitive and might be "
10782 "longer than 1 character. For example in OS-9, hard drives were named C<h0>, "
10787 #: ../src/guestfs-actions.pod:2656 ../fish/guestfish-actions.pod:1814
10789 "For Windows guests, currently only hard drive mappings are returned. "
10790 "Removable disks (eg. DVD-ROMs) are ignored."
10794 #: ../src/guestfs-actions.pod:2659 ../fish/guestfish-actions.pod:1817
10796 "For guests that do not use drive mappings, or if the drive mappings could "
10797 "not be determined, this returns an empty hash table."
10801 #: ../src/guestfs-actions.pod:2662
10803 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
10804 "C<guestfs_inspect_get_mountpoints>, C<guestfs_inspect_get_filesystems>."
10808 #: ../src/guestfs-actions.pod:2666 ../src/guestfs-actions.pod:2842
10809 #: ../src/guestfs-actions.pod:3602 ../src/guestfs-actions.pod:4819
10810 #: ../src/guestfs-actions.pod:6761
10812 "This function returns a NULL-terminated array of strings, or NULL if there "
10813 "was an error. The array of strings will always have length C<2n+1>, where "
10814 "C<n> keys and values alternate, followed by the trailing NULL entry. I<The "
10815 "caller must free the strings and the array after use>."
10819 #: ../src/guestfs-actions.pod:2672
10820 msgid "guestfs_inspect_get_filesystems"
10824 #: ../src/guestfs-actions.pod:2674
10828 " guestfs_inspect_get_filesystems (guestfs_h *g,\n"
10829 " const char *root);\n"
10834 #: ../src/guestfs-actions.pod:2681 ../fish/guestfish-actions.pod:1831
10836 "This returns a list of all the filesystems that we think are associated with "
10837 "this operating system. This includes the root filesystem, other ordinary "
10838 "filesystems, and non-mounted devices like swap partitions."
10842 #: ../src/guestfs-actions.pod:2686 ../fish/guestfish-actions.pod:1836
10844 "In the case of a multi-boot virtual machine, it is possible for a filesystem "
10845 "to be shared between operating systems."
10849 #: ../src/guestfs-actions.pod:2689
10851 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
10852 "C<guestfs_inspect_get_mountpoints>."
10856 #: ../src/guestfs-actions.pod:2698
10857 msgid "guestfs_inspect_get_format"
10861 #: ../src/guestfs-actions.pod:2700
10865 " guestfs_inspect_get_format (guestfs_h *g,\n"
10866 " const char *root);\n"
10871 #: ../src/guestfs-actions.pod:2707 ../fish/guestfish-actions.pod:1849
10873 "This returns the format of the inspected operating system. You can use it "
10874 "to detect install images, live CDs and similar."
10878 #: ../src/guestfs-actions.pod:2710 ../fish/guestfish-actions.pod:1852
10879 msgid "Currently defined formats are:"
10883 #: ../src/guestfs-actions.pod:2714 ../fish/guestfish-actions.pod:1856
10884 msgid "\"installed\""
10885 msgstr "\"installed\""
10888 #: ../src/guestfs-actions.pod:2716 ../fish/guestfish-actions.pod:1858
10889 msgid "This is an installed operating system."
10890 msgstr "Це встановлена операційна система."
10893 #: ../src/guestfs-actions.pod:2718 ../fish/guestfish-actions.pod:1860
10894 msgid "\"installer\""
10898 #: ../src/guestfs-actions.pod:2720 ../fish/guestfish-actions.pod:1862
10900 "The disk image being inspected is not an installed operating system, but a "
10901 "I<bootable> install disk, live CD, or similar."
10905 #: ../src/guestfs-actions.pod:2725 ../fish/guestfish-actions.pod:1867
10906 msgid "The format of this disk image is not known."
10910 #: ../src/guestfs-actions.pod:2737
10911 msgid "guestfs_inspect_get_hostname"
10915 #: ../src/guestfs-actions.pod:2739
10919 " guestfs_inspect_get_hostname (guestfs_h *g,\n"
10920 " const char *root);\n"
10925 #: ../src/guestfs-actions.pod:2746 ../fish/guestfish-actions.pod:1883
10927 "This function returns the hostname of the operating system as found by "
10928 "inspection of the guest's configuration files."
10932 #: ../src/guestfs-actions.pod:2749 ../fish/guestfish-actions.pod:1886
10934 "If the hostname could not be determined, then the string C<unknown> is "
10939 #: ../src/guestfs-actions.pod:2757
10940 msgid "(Added in 1.7.9)"
10944 #: ../src/guestfs-actions.pod:2759
10945 msgid "guestfs_inspect_get_major_version"
10949 #: ../src/guestfs-actions.pod:2761
10953 " guestfs_inspect_get_major_version (guestfs_h *g,\n"
10954 " const char *root);\n"
10959 #: ../src/guestfs-actions.pod:2768 ../fish/guestfish-actions.pod:1898
10961 "This returns the major version number of the inspected operating system."
10965 #: ../src/guestfs-actions.pod:2771 ../fish/guestfish-actions.pod:1901
10967 "Windows uses a consistent versioning scheme which is I<not> reflected in the "
10968 "popular public names used by the operating system. Notably the operating "
10969 "system known as \"Windows 7\" is really version 6.1 (ie. major = 6, minor = "
10970 "1). You can find out the real versions corresponding to releases of Windows "
10971 "by consulting Wikipedia or MSDN."
10975 #: ../src/guestfs-actions.pod:2778 ../src/guestfs-actions.pod:2798
10976 #: ../fish/guestfish-actions.pod:1908 ../fish/guestfish-actions.pod:1922
10977 msgid "If the version could not be determined, then C<0> is returned."
10981 #: ../src/guestfs-actions.pod:2786
10982 msgid "guestfs_inspect_get_minor_version"
10986 #: ../src/guestfs-actions.pod:2788
10990 " guestfs_inspect_get_minor_version (guestfs_h *g,\n"
10991 " const char *root);\n"
10996 #: ../src/guestfs-actions.pod:2795 ../fish/guestfish-actions.pod:1919
10998 "This returns the minor version number of the inspected operating system."
11002 #: ../src/guestfs-actions.pod:2800
11004 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
11005 "C<guestfs_inspect_get_major_version>."
11009 #: ../src/guestfs-actions.pod:2807
11010 msgid "guestfs_inspect_get_mountpoints"
11014 #: ../src/guestfs-actions.pod:2809
11018 " guestfs_inspect_get_mountpoints (guestfs_h *g,\n"
11019 " const char *root);\n"
11024 #: ../src/guestfs-actions.pod:2816 ../fish/guestfish-actions.pod:1934
11026 "This returns a hash of where we think the filesystems associated with this "
11027 "operating system should be mounted. Callers should note that this is at "
11028 "best an educated guess made by reading configuration files such as C</etc/"
11029 "fstab>. I<In particular note> that this may return filesystems which are "
11030 "non-existent or not mountable and callers should be prepared to handle or "
11031 "ignore failures if they try to mount them."
11035 #: ../src/guestfs-actions.pod:2825 ../fish/guestfish-actions.pod:1943
11037 "Each element in the returned hashtable has a key which is the path of the "
11038 "mountpoint (eg. C</boot>) and a value which is the filesystem that would be "
11039 "mounted there (eg. C</dev/sda1>)."
11043 #: ../src/guestfs-actions.pod:2830 ../fish/guestfish-actions.pod:1948
11045 "Non-mounted devices such as swap devices are I<not> returned in this list."
11049 #: ../src/guestfs-actions.pod:2833
11051 "For operating systems like Windows which still use drive letters, this call "
11052 "will only return an entry for the first drive \"mounted on\" C</>. For "
11053 "information about the mapping of drive letters to partitions, see "
11054 "C<guestfs_inspect_get_drive_mappings>."
11058 #: ../src/guestfs-actions.pod:2839
11060 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
11061 "C<guestfs_inspect_get_filesystems>."
11065 #: ../src/guestfs-actions.pod:2850
11066 msgid "guestfs_inspect_get_package_format"
11070 #: ../src/guestfs-actions.pod:2852
11074 " guestfs_inspect_get_package_format (guestfs_h *g,\n"
11075 " const char *root);\n"
11080 #: ../src/guestfs-actions.pod:2859
11082 "This function and C<guestfs_inspect_get_package_management> return the "
11083 "package format and package management tool used by the inspected operating "
11084 "system. For example for Fedora these functions would return C<rpm> (package "
11085 "format) and C<yum> (package management)."
11089 #: ../src/guestfs-actions.pod:2865 ../fish/guestfish-actions.pod:1973
11091 "This returns the string C<unknown> if we could not determine the package "
11092 "format I<or> if the operating system does not have a real packaging system "
11097 #: ../src/guestfs-actions.pod:2869 ../fish/guestfish-actions.pod:1977
11099 "Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>. "
11100 "Future versions of libguestfs may return other strings."
11104 #: ../src/guestfs-actions.pod:2877 ../src/guestfs-actions.pod:2908
11105 msgid "(Added in 1.7.5)"
11109 #: ../src/guestfs-actions.pod:2879
11110 msgid "guestfs_inspect_get_package_management"
11114 #: ../src/guestfs-actions.pod:2881
11118 " guestfs_inspect_get_package_management (guestfs_h *g,\n"
11119 " const char *root);\n"
11124 #: ../src/guestfs-actions.pod:2888
11126 "C<guestfs_inspect_get_package_format> and this function return the package "
11127 "format and package management tool used by the inspected operating system. "
11128 "For example for Fedora these functions would return C<rpm> (package format) "
11129 "and C<yum> (package management)."
11133 #: ../src/guestfs-actions.pod:2894 ../fish/guestfish-actions.pod:1995
11135 "This returns the string C<unknown> if we could not determine the package "
11136 "management tool I<or> if the operating system does not have a real packaging "
11137 "system (eg. Windows)."
11141 #: ../src/guestfs-actions.pod:2898 ../fish/guestfish-actions.pod:1999
11143 "Possible strings include: C<yum>, C<up2date>, C<apt> (for all Debian "
11144 "derivatives), C<portage>, C<pisi>, C<pacman>, C<urpmi>. Future versions of "
11145 "libguestfs may return other strings."
11149 #: ../src/guestfs-actions.pod:2910
11150 msgid "guestfs_inspect_get_product_name"
11154 #: ../src/guestfs-actions.pod:2912
11158 " guestfs_inspect_get_product_name (guestfs_h *g,\n"
11159 " const char *root);\n"
11164 #: ../src/guestfs-actions.pod:2919 ../fish/guestfish-actions.pod:2013
11166 "This returns the product name of the inspected operating system. The "
11167 "product name is generally some freeform string which can be displayed to the "
11168 "user, but should not be parsed by programs."
11172 #: ../src/guestfs-actions.pod:2924 ../fish/guestfish-actions.pod:2018
11174 "If the product name could not be determined, then the string C<unknown> is "
11179 #: ../src/guestfs-actions.pod:2934
11180 msgid "guestfs_inspect_get_product_variant"
11184 #: ../src/guestfs-actions.pod:2936
11188 " guestfs_inspect_get_product_variant (guestfs_h *g,\n"
11189 " const char *root);\n"
11194 #: ../src/guestfs-actions.pod:2943 ../fish/guestfish-actions.pod:2030
11196 #| msgid "This is an installed operating system."
11197 msgid "This returns the product variant of the inspected operating system."
11198 msgstr "Це встановлена операційна система."
11201 #: ../src/guestfs-actions.pod:2946 ../fish/guestfish-actions.pod:2033
11203 "For Windows guests, this returns the contents of the Registry key C<HKLM"
11204 "\\Software\\Microsoft\\Windows NT\\CurrentVersion> C<InstallationType> which "
11205 "is usually a string such as C<Client> or C<Server> (other values are "
11206 "possible). This can be used to distinguish consumer and enterprise versions "
11207 "of Windows that have the same version number (for example, Windows 7 and "
11208 "Windows 2008 Server are both version 6.1, but the former is C<Client> and "
11209 "the latter is C<Server>)."
11213 #: ../src/guestfs-actions.pod:2955 ../fish/guestfish-actions.pod:2042
11215 "For enterprise Linux guests, in future we intend this to return the product "
11216 "variant such as C<Desktop>, C<Server> and so on. But this is not "
11217 "implemented at present."
11221 #: ../src/guestfs-actions.pod:2959 ../fish/guestfish-actions.pod:2046
11223 "If the product variant could not be determined, then the string C<unknown> "
11228 #: ../src/guestfs-actions.pod:2962
11230 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
11231 "C<guestfs_inspect_get_product_name>, C<guestfs_inspect_get_major_version>."
11235 #: ../src/guestfs-actions.pod:2969
11236 msgid "guestfs_inspect_get_roots"
11240 #: ../src/guestfs-actions.pod:2971
11244 " guestfs_inspect_get_roots (guestfs_h *g);\n"
11249 #: ../src/guestfs-actions.pod:2974
11251 "This function is a convenient way to get the list of root devices, as "
11252 "returned from a previous call to C<guestfs_inspect_os>, but without redoing "
11253 "the whole inspection process."
11257 #: ../src/guestfs-actions.pod:2978
11259 "This returns an empty list if either no root devices were found or the "
11260 "caller has not called C<guestfs_inspect_os>."
11264 #: ../src/guestfs-actions.pod:2987
11265 msgid "(Added in 1.7.3)"
11269 #: ../src/guestfs-actions.pod:2989
11270 msgid "guestfs_inspect_get_type"
11274 #: ../src/guestfs-actions.pod:2991
11278 " guestfs_inspect_get_type (guestfs_h *g,\n"
11279 " const char *root);\n"
11284 #: ../src/guestfs-actions.pod:2998 ../fish/guestfish-actions.pod:2073
11286 "This returns the type of the inspected operating system. Currently defined "
11291 #: ../src/guestfs-actions.pod:3003 ../fish/guestfish-actions.pod:2078
11296 #: ../src/guestfs-actions.pod:3005 ../fish/guestfish-actions.pod:2080
11297 msgid "Any Linux-based operating system."
11301 #: ../src/guestfs-actions.pod:3009 ../fish/guestfish-actions.pod:2084
11302 msgid "Any Microsoft Windows operating system."
11306 #: ../src/guestfs-actions.pod:3011 ../fish/guestfish-actions.pod:2086
11307 msgid "\"freebsd\""
11308 msgstr "\"freebsd\""
11311 #: ../src/guestfs-actions.pod:3013 ../fish/guestfish-actions.pod:2088
11316 #: ../src/guestfs-actions.pod:3017 ../fish/guestfish-actions.pod:2092
11317 msgid "The operating system type could not be determined."
11321 #: ../src/guestfs-actions.pod:3031
11322 msgid "guestfs_inspect_get_windows_current_control_set"
11326 #: ../src/guestfs-actions.pod:3033
11330 " guestfs_inspect_get_windows_current_control_set (guestfs_h *g,\n"
11331 " const char *root);\n"
11336 #: ../src/guestfs-actions.pod:3040 ../fish/guestfish-actions.pod:2108
11338 "This returns the Windows CurrentControlSet of the inspected guest. The "
11339 "CurrentControlSet is a registry key name such as C<ControlSet001>."
11343 #: ../src/guestfs-actions.pod:3043 ../fish/guestfish-actions.pod:2111
11345 "This call assumes that the guest is Windows and that the Registry could be "
11346 "examined by inspection. If this is not the case then an error is returned."
11350 #: ../src/guestfs-actions.pod:3052
11351 msgid "guestfs_inspect_get_windows_systemroot"
11355 #: ../src/guestfs-actions.pod:3054
11359 " guestfs_inspect_get_windows_systemroot (guestfs_h *g,\n"
11360 " const char *root);\n"
11365 #: ../src/guestfs-actions.pod:3061 ../fish/guestfish-actions.pod:2124
11367 "This returns the Windows systemroot of the inspected guest. The systemroot "
11368 "is a directory path such as C</WINDOWS>."
11372 #: ../src/guestfs-actions.pod:3064 ../fish/guestfish-actions.pod:2127
11374 "This call assumes that the guest is Windows and that the systemroot could be "
11375 "determined by inspection. If this is not the case then an error is returned."
11379 #: ../src/guestfs-actions.pod:3073
11380 msgid "(Added in 1.5.25)"
11384 #: ../src/guestfs-actions.pod:3075
11385 msgid "guestfs_inspect_is_live"
11389 #: ../src/guestfs-actions.pod:3077
11393 " guestfs_inspect_is_live (guestfs_h *g,\n"
11394 " const char *root);\n"
11399 #: ../src/guestfs-actions.pod:3084
11401 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
11402 "disk), then this returns true if a live image was detected on the disk."
11406 #: ../src/guestfs-actions.pod:3092
11407 msgid "guestfs_inspect_is_multipart"
11411 #: ../src/guestfs-actions.pod:3094
11415 " guestfs_inspect_is_multipart (guestfs_h *g,\n"
11416 " const char *root);\n"
11421 #: ../src/guestfs-actions.pod:3101
11423 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
11424 "disk), then this returns true if the disk is part of a set."
11428 #: ../src/guestfs-actions.pod:3109
11429 msgid "guestfs_inspect_is_netinst"
11433 #: ../src/guestfs-actions.pod:3111
11437 " guestfs_inspect_is_netinst (guestfs_h *g,\n"
11438 " const char *root);\n"
11443 #: ../src/guestfs-actions.pod:3118
11445 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
11446 "disk), then this returns true if the disk is a network installer, ie. not a "
11447 "self-contained install CD but one which is likely to require network access "
11448 "to complete the install."
11452 #: ../src/guestfs-actions.pod:3128
11453 msgid "guestfs_inspect_list_applications"
11457 #: ../src/guestfs-actions.pod:3130
11460 " struct guestfs_application_list *\n"
11461 " guestfs_inspect_list_applications (guestfs_h *g,\n"
11462 " const char *root);\n"
11467 #: ../src/guestfs-actions.pod:3137 ../fish/guestfish-actions.pod:2181
11468 msgid "Return the list of applications installed in the operating system."
11472 #: ../src/guestfs-actions.pod:3139
11474 "I<Note:> This call works differently from other parts of the inspection "
11475 "API. You have to call C<guestfs_inspect_os>, then "
11476 "C<guestfs_inspect_get_mountpoints>, then mount up the disks, before calling "
11477 "this. Listing applications is a significantly more difficult operation "
11478 "which requires access to the full filesystem. Also note that unlike the "
11479 "other C<guestfs_inspect_get_*> calls which are just returning data cached in "
11480 "the libguestfs handle, this call actually reads parts of the mounted "
11481 "filesystems during the call."
11485 #: ../src/guestfs-actions.pod:3149 ../fish/guestfish-actions.pod:2193
11487 "This returns an empty list if the inspection code was not able to determine "
11488 "the list of applications."
11492 #: ../src/guestfs-actions.pod:3152 ../fish/guestfish-actions.pod:2196
11493 msgid "The application structure contains the following fields:"
11497 #: ../src/guestfs-actions.pod:3156 ../fish/guestfish-actions.pod:2200
11498 msgid "C<app_name>"
11499 msgstr "C<app_name>"
11502 #: ../src/guestfs-actions.pod:3158 ../fish/guestfish-actions.pod:2202
11504 "The name of the application. For Red Hat-derived and Debian-derived Linux "
11505 "guests, this is the package name."
11509 #: ../src/guestfs-actions.pod:3161 ../fish/guestfish-actions.pod:2205
11510 msgid "C<app_display_name>"
11511 msgstr "C<app_display_name>"
11514 #: ../src/guestfs-actions.pod:3163 ../fish/guestfish-actions.pod:2207
11516 "The display name of the application, sometimes localized to the install "
11517 "language of the guest operating system."
11521 #: ../src/guestfs-actions.pod:3166 ../fish/guestfish-actions.pod:2210
11523 "If unavailable this is returned as an empty string C<\"\">. Callers needing "
11524 "to display something can use C<app_name> instead."
11528 #: ../src/guestfs-actions.pod:3169 ../fish/guestfish-actions.pod:2213
11529 msgid "C<app_epoch>"
11530 msgstr "C<app_epoch>"
11533 #: ../src/guestfs-actions.pod:3171 ../fish/guestfish-actions.pod:2215
11535 "For package managers which use epochs, this contains the epoch of the "
11536 "package (an integer). If unavailable, this is returned as C<0>."
11540 #: ../src/guestfs-actions.pod:3174 ../fish/guestfish-actions.pod:2218
11541 msgid "C<app_version>"
11542 msgstr "C<app_version>"
11545 #: ../src/guestfs-actions.pod:3176 ../fish/guestfish-actions.pod:2220
11547 "The version string of the application or package. If unavailable this is "
11548 "returned as an empty string C<\"\">."
11552 #: ../src/guestfs-actions.pod:3179 ../fish/guestfish-actions.pod:2223
11553 msgid "C<app_release>"
11554 msgstr "C<app_release>"
11557 #: ../src/guestfs-actions.pod:3181 ../fish/guestfish-actions.pod:2225
11559 "The release string of the application or package, for package managers that "
11560 "use this. If unavailable this is returned as an empty string C<\"\">."
11564 #: ../src/guestfs-actions.pod:3185 ../fish/guestfish-actions.pod:2229
11565 msgid "C<app_install_path>"
11566 msgstr "C<app_install_path>"
11569 #: ../src/guestfs-actions.pod:3187 ../fish/guestfish-actions.pod:2231
11571 "The installation path of the application (on operating systems such as "
11572 "Windows which use installation paths). This path is in the format used by "
11573 "the guest operating system, it is not a libguestfs path."
11577 #: ../src/guestfs-actions.pod:3192 ../fish/guestfish-actions.pod:2236
11578 msgid "If unavailable this is returned as an empty string C<\"\">."
11582 #: ../src/guestfs-actions.pod:3194 ../fish/guestfish-actions.pod:2238
11583 msgid "C<app_trans_path>"
11584 msgstr "C<app_trans_path>"
11587 #: ../src/guestfs-actions.pod:3196 ../fish/guestfish-actions.pod:2240
11589 "The install path translated into a libguestfs path. If unavailable this is "
11590 "returned as an empty string C<\"\">."
11594 #: ../src/guestfs-actions.pod:3199 ../fish/guestfish-actions.pod:2243
11595 msgid "C<app_publisher>"
11596 msgstr "C<app_publisher>"
11599 #: ../src/guestfs-actions.pod:3201 ../fish/guestfish-actions.pod:2245
11601 "The name of the publisher of the application, for package managers that use "
11602 "this. If unavailable this is returned as an empty string C<\"\">."
11606 #: ../src/guestfs-actions.pod:3205 ../fish/guestfish-actions.pod:2249
11608 msgstr "C<app_url>"
11611 #: ../src/guestfs-actions.pod:3207 ../fish/guestfish-actions.pod:2251
11613 "The URL (eg. upstream URL) of the application. If unavailable this is "
11614 "returned as an empty string C<\"\">."
11618 #: ../src/guestfs-actions.pod:3210 ../fish/guestfish-actions.pod:2254
11619 msgid "C<app_source_package>"
11623 #: ../src/guestfs-actions.pod:3212 ../fish/guestfish-actions.pod:2256
11625 "For packaging systems which support this, the name of the source package. "
11626 "If unavailable this is returned as an empty string C<\"\">."
11630 #: ../src/guestfs-actions.pod:3215 ../fish/guestfish-actions.pod:2259
11631 msgid "C<app_summary>"
11635 #: ../src/guestfs-actions.pod:3217 ../fish/guestfish-actions.pod:2261
11637 "A short (usually one line) description of the application or package. If "
11638 "unavailable this is returned as an empty string C<\"\">."
11642 #: ../src/guestfs-actions.pod:3220 ../fish/guestfish-actions.pod:2264
11643 msgid "C<app_description>"
11647 #: ../src/guestfs-actions.pod:3222 ../fish/guestfish-actions.pod:2266
11649 "A longer description of the application or package. If unavailable this is "
11650 "returned as an empty string C<\"\">."
11654 #: ../src/guestfs-actions.pod:3229
11656 "This function returns a C<struct guestfs_application_list *>, or NULL if "
11657 "there was an error. I<The caller must call C<guestfs_free_application_list> "
11662 #: ../src/guestfs-actions.pod:3233
11663 msgid "(Added in 1.7.8)"
11667 #: ../src/guestfs-actions.pod:3235
11668 msgid "guestfs_inspect_os"
11672 #: ../src/guestfs-actions.pod:3237
11676 " guestfs_inspect_os (guestfs_h *g);\n"
11681 #: ../src/guestfs-actions.pod:3240 ../fish/guestfish-actions.pod:2277
11683 "This function uses other libguestfs functions and certain heuristics to "
11684 "inspect the disk(s) (usually disks belonging to a virtual machine), looking "
11685 "for operating systems."
11689 #: ../src/guestfs-actions.pod:3244 ../fish/guestfish-actions.pod:2281
11690 msgid "The list returned is empty if no operating systems were found."
11694 #: ../src/guestfs-actions.pod:3246 ../fish/guestfish-actions.pod:2283
11696 "If one operating system was found, then this returns a list with a single "
11697 "element, which is the name of the root filesystem of this operating system. "
11698 "It is also possible for this function to return a list containing more than "
11699 "one element, indicating a dual-boot or multi-boot virtual machine, with each "
11700 "element being the root filesystem of one of the operating systems."
11704 #: ../src/guestfs-actions.pod:3253
11706 "You can pass the root string(s) returned to other C<guestfs_inspect_get_*> "
11707 "functions in order to query further information about each operating system, "
11708 "such as the name and version."
11712 #: ../src/guestfs-actions.pod:3258
11714 "This function uses other libguestfs features such as C<guestfs_mount_ro> and "
11715 "C<guestfs_umount_all> in order to mount and unmount filesystems and look at "
11716 "the contents. This should be called with no disks currently mounted. The "
11717 "function may also use Augeas, so any existing Augeas handle will be closed."
11721 #: ../src/guestfs-actions.pod:3264 ../fish/guestfish-actions.pod:2301
11723 "This function cannot decrypt encrypted disks. The caller must do that first "
11724 "(supplying the necessary keys) if the disk is encrypted."
11728 #: ../src/guestfs-actions.pod:3270 ../src/guestfs-actions.pod:3560
11729 #: ../src/guestfs-actions.pod:3622
11730 msgid "See also C<guestfs_list_filesystems>."
11734 #: ../src/guestfs-actions.pod:3278
11735 msgid "guestfs_is_blockdev"
11739 #: ../src/guestfs-actions.pod:3280
11743 " guestfs_is_blockdev (guestfs_h *g,\n"
11744 " const char *path);\n"
11749 #: ../src/guestfs-actions.pod:3284 ../fish/guestfish-actions.pod:2313
11751 "This returns C<true> if and only if there is a block device with the given "
11756 #: ../src/guestfs-actions.pod:3287 ../src/guestfs-actions.pod:3316
11757 #: ../src/guestfs-actions.pod:3346 ../src/guestfs-actions.pod:3361
11758 #: ../src/guestfs-actions.pod:3377 ../src/guestfs-actions.pod:3433
11759 #: ../src/guestfs-actions.pod:3448
11760 msgid "See also C<guestfs_stat>."
11764 #: ../src/guestfs-actions.pod:3291 ../src/guestfs-actions.pod:3320
11765 #: ../src/guestfs-actions.pod:3365 ../src/guestfs-actions.pod:3437
11766 #: ../src/guestfs-actions.pod:3452
11767 msgid "(Added in 1.5.10)"
11771 #: ../src/guestfs-actions.pod:3293
11772 msgid "guestfs_is_busy"
11776 #: ../src/guestfs-actions.pod:3295
11780 " guestfs_is_busy (guestfs_h *g);\n"
11785 #: ../src/guestfs-actions.pod:3298 ../fish/guestfish-actions.pod:2322
11787 "This returns true iff this handle is busy processing a command (in the "
11792 #: ../src/guestfs-actions.pod:3307
11793 msgid "guestfs_is_chardev"
11797 #: ../src/guestfs-actions.pod:3309
11801 " guestfs_is_chardev (guestfs_h *g,\n"
11802 " const char *path);\n"
11807 #: ../src/guestfs-actions.pod:3313 ../fish/guestfish-actions.pod:2331
11809 "This returns C<true> if and only if there is a character device with the "
11810 "given C<path> name."
11814 #: ../src/guestfs-actions.pod:3322
11815 msgid "guestfs_is_config"
11819 #: ../src/guestfs-actions.pod:3324
11823 " guestfs_is_config (guestfs_h *g);\n"
11828 #: ../src/guestfs-actions.pod:3327 ../fish/guestfish-actions.pod:2340
11830 "This returns true iff this handle is being configured (in the C<CONFIG> "
11835 #: ../src/guestfs-actions.pod:3336
11836 msgid "guestfs_is_dir"
11840 #: ../src/guestfs-actions.pod:3338
11844 " guestfs_is_dir (guestfs_h *g,\n"
11845 " const char *path);\n"
11850 #: ../src/guestfs-actions.pod:3342 ../fish/guestfish-actions.pod:2349
11852 "This returns C<true> if and only if there is a directory with the given "
11853 "C<path> name. Note that it returns false for other objects like files."
11857 #: ../src/guestfs-actions.pod:3352
11858 msgid "guestfs_is_fifo"
11862 #: ../src/guestfs-actions.pod:3354
11866 " guestfs_is_fifo (guestfs_h *g,\n"
11867 " const char *path);\n"
11872 #: ../src/guestfs-actions.pod:3358 ../fish/guestfish-actions.pod:2359
11874 "This returns C<true> if and only if there is a FIFO (named pipe) with the "
11875 "given C<path> name."
11879 #: ../src/guestfs-actions.pod:3367
11880 msgid "guestfs_is_file"
11884 #: ../src/guestfs-actions.pod:3369
11888 " guestfs_is_file (guestfs_h *g,\n"
11889 " const char *path);\n"
11894 #: ../src/guestfs-actions.pod:3373 ../fish/guestfish-actions.pod:2368
11896 "This returns C<true> if and only if there is a regular file with the given "
11897 "C<path> name. Note that it returns false for other objects like directories."
11901 #: ../src/guestfs-actions.pod:3383
11902 msgid "guestfs_is_launching"
11906 #: ../src/guestfs-actions.pod:3385
11910 " guestfs_is_launching (guestfs_h *g);\n"
11915 #: ../src/guestfs-actions.pod:3388 ../fish/guestfish-actions.pod:2378
11917 "This returns true iff this handle is launching the subprocess (in the "
11918 "C<LAUNCHING> state)."
11922 #: ../src/guestfs-actions.pod:3397
11923 msgid "guestfs_is_lv"
11927 #: ../src/guestfs-actions.pod:3399
11931 " guestfs_is_lv (guestfs_h *g,\n"
11932 " const char *device);\n"
11937 #: ../src/guestfs-actions.pod:3403 ../fish/guestfish-actions.pod:2387
11939 "This command tests whether C<device> is a logical volume, and returns true "
11940 "iff this is the case."
11944 #: ../src/guestfs-actions.pod:3410
11945 msgid "guestfs_is_ready"
11949 #: ../src/guestfs-actions.pod:3412
11953 " guestfs_is_ready (guestfs_h *g);\n"
11958 #: ../src/guestfs-actions.pod:3415 ../fish/guestfish-actions.pod:2394
11960 "This returns true iff this handle is ready to accept commands (in the "
11965 #: ../src/guestfs-actions.pod:3424
11966 msgid "guestfs_is_socket"
11970 #: ../src/guestfs-actions.pod:3426
11974 " guestfs_is_socket (guestfs_h *g,\n"
11975 " const char *path);\n"
11980 #: ../src/guestfs-actions.pod:3430 ../fish/guestfish-actions.pod:2403
11982 "This returns C<true> if and only if there is a Unix domain socket with the "
11983 "given C<path> name."
11987 #: ../src/guestfs-actions.pod:3439
11988 msgid "guestfs_is_symlink"
11992 #: ../src/guestfs-actions.pod:3441
11996 " guestfs_is_symlink (guestfs_h *g,\n"
11997 " const char *path);\n"
12002 #: ../src/guestfs-actions.pod:3445 ../fish/guestfish-actions.pod:2412
12004 "This returns C<true> if and only if there is a symbolic link with the given "
12009 #: ../src/guestfs-actions.pod:3454
12010 msgid "guestfs_kill_subprocess"
12014 #: ../src/guestfs-actions.pod:3456
12018 " guestfs_kill_subprocess (guestfs_h *g);\n"
12023 #: ../src/guestfs-actions.pod:3459 ../fish/guestfish-actions.pod:2421
12024 msgid "This kills the qemu subprocess. You should never need to call this."
12028 #: ../src/guestfs-actions.pod:3465
12029 msgid "guestfs_launch"
12033 #: ../src/guestfs-actions.pod:3467
12037 " guestfs_launch (guestfs_h *g);\n"
12042 #: ../src/guestfs-actions.pod:3470 ../fish/guestfish-actions.pod:2429
12044 "Internally libguestfs is implemented by running a virtual machine using "
12049 #: ../src/guestfs-actions.pod:3473 ../fish/guestfish-actions.pod:2432
12051 "You should call this after configuring the handle (eg. adding drives) but "
12052 "before performing any actions."
12056 #: ../src/guestfs-actions.pod:3485
12057 msgid "guestfs_lchown"
12061 #: ../src/guestfs-actions.pod:3487
12065 " guestfs_lchown (guestfs_h *g,\n"
12068 " const char *path);\n"
12073 #: ../src/guestfs-actions.pod:3493
12075 "Change the file owner to C<owner> and group to C<group>. This is like "
12076 "C<guestfs_chown> but if C<path> is a symlink then the link itself is "
12077 "changed, not the target."
12081 #: ../src/guestfs-actions.pod:3505
12082 msgid "guestfs_lgetxattr"
12086 #: ../src/guestfs-actions.pod:3507
12090 " guestfs_lgetxattr (guestfs_h *g,\n"
12091 " const char *path,\n"
12092 " const char *name,\n"
12093 " size_t *size_r);\n"
12098 #: ../src/guestfs-actions.pod:3513 ../fish/guestfish-actions.pod:2451
12100 "Get a single extended attribute from file C<path> named C<name>. If C<path> "
12101 "is a symlink, then this call returns an extended attribute from the symlink."
12105 #: ../src/guestfs-actions.pod:3527
12106 msgid "See also: C<guestfs_lgetxattrs>, C<guestfs_getxattr>, L<attr(5)>."
12110 #: ../src/guestfs-actions.pod:3535
12111 msgid "guestfs_lgetxattrs"
12115 #: ../src/guestfs-actions.pod:3537
12118 " struct guestfs_xattr_list *\n"
12119 " guestfs_lgetxattrs (guestfs_h *g,\n"
12120 " const char *path);\n"
12125 #: ../src/guestfs-actions.pod:3541
12127 "This is the same as C<guestfs_getxattrs>, but if C<path> is a symbolic link, "
12128 "then it returns the extended attributes of the link itself."
12132 #: ../src/guestfs-actions.pod:3551
12133 msgid "guestfs_list_devices"
12137 #: ../src/guestfs-actions.pod:3553
12141 " guestfs_list_devices (guestfs_h *g);\n"
12146 #: ../src/guestfs-actions.pod:3556 ../fish/guestfish-actions.pod:2479
12147 msgid "List all the block devices."
12151 #: ../src/guestfs-actions.pod:3558 ../fish/guestfish-actions.pod:2481
12152 msgid "The full block device names are returned, eg. C</dev/sda>."
12156 #: ../src/guestfs-actions.pod:3568
12157 msgid "guestfs_list_filesystems"
12161 #: ../src/guestfs-actions.pod:3570
12165 " guestfs_list_filesystems (guestfs_h *g);\n"
12170 #: ../src/guestfs-actions.pod:3573 ../fish/guestfish-actions.pod:2489
12172 "This inspection command looks for filesystems on partitions, block devices "
12173 "and logical volumes, returning a list of devices containing filesystems and "
12178 #: ../src/guestfs-actions.pod:3577 ../fish/guestfish-actions.pod:2493
12180 "The return value is a hash, where the keys are the devices containing "
12181 "filesystems, and the values are the filesystem types. For example:"
12185 #: ../src/guestfs-actions.pod:3581 ../fish/guestfish-actions.pod:2497
12188 " \"/dev/sda1\" => \"ntfs\"\n"
12189 " \"/dev/sda2\" => \"ext2\"\n"
12190 " \"/dev/vg_guest/lv_root\" => \"ext4\"\n"
12191 " \"/dev/vg_guest/lv_swap\" => \"swap\"\n"
12196 #: ../src/guestfs-actions.pod:3586 ../fish/guestfish-actions.pod:2502
12198 "The value can have the special value \"unknown\", meaning the content of the "
12199 "device is undetermined or empty. \"swap\" means a Linux swap partition."
12203 #: ../src/guestfs-actions.pod:3590
12205 "This command runs other libguestfs commands, which might include "
12206 "C<guestfs_mount> and C<guestfs_umount>, and therefore you should use this "
12207 "soon after launch and only when nothing is mounted."
12211 #: ../src/guestfs-actions.pod:3594
12213 "Not all of the filesystems returned will be mountable. In particular, swap "
12214 "partitions are returned in the list. Also this command does not check that "
12215 "each filesystem found is valid and mountable, and some filesystems might be "
12216 "mountable but require special options. Filesystems may not all belong to a "
12217 "single logical operating system (use C<guestfs_inspect_os> to look for OSes)."
12221 #: ../src/guestfs-actions.pod:3608 ../src/guestfs-actions.pod:5229
12222 msgid "(Added in 1.5.15)"
12226 #: ../src/guestfs-actions.pod:3610
12227 msgid "guestfs_list_partitions"
12231 #: ../src/guestfs-actions.pod:3612
12235 " guestfs_list_partitions (guestfs_h *g);\n"
12240 #: ../src/guestfs-actions.pod:3615 ../fish/guestfish-actions.pod:2522
12241 msgid "List all the partitions detected on all block devices."
12245 #: ../src/guestfs-actions.pod:3617 ../fish/guestfish-actions.pod:2524
12246 msgid "The full partition device names are returned, eg. C</dev/sda1>"
12250 #: ../src/guestfs-actions.pod:3619
12252 "This does not return logical volumes. For that you will need to call "
12257 #: ../src/guestfs-actions.pod:3630
12262 #: ../src/guestfs-actions.pod:3632
12266 " guestfs_ll (guestfs_h *g,\n"
12267 " const char *directory);\n"
12272 #: ../src/guestfs-actions.pod:3636 ../fish/guestfish-actions.pod:2535
12274 "List the files in C<directory> (relative to the root directory, there is no "
12275 "cwd) in the format of 'ls -la'."
12279 #: ../src/guestfs-actions.pod:3639 ../fish/guestfish-actions.pod:2538
12281 "This command is mostly useful for interactive sessions. It is I<not> "
12282 "intended that you try to parse the output string."
12286 #: ../src/guestfs-actions.pod:3647
12291 #: ../src/guestfs-actions.pod:3649
12295 " guestfs_ln (guestfs_h *g,\n"
12296 " const char *target,\n"
12297 " const char *linkname);\n"
12302 #: ../src/guestfs-actions.pod:3654 ../fish/guestfish-actions.pod:2545
12303 msgid "This command creates a hard link using the C<ln> command."
12307 #: ../src/guestfs-actions.pod:3660
12308 msgid "guestfs_ln_f"
12312 #: ../src/guestfs-actions.pod:3662
12316 " guestfs_ln_f (guestfs_h *g,\n"
12317 " const char *target,\n"
12318 " const char *linkname);\n"
12323 #: ../src/guestfs-actions.pod:3667 ../fish/guestfish-actions.pod:2551
12325 "This command creates a hard link using the C<ln -f> command. The I<-f> "
12326 "option removes the link (C<linkname>) if it exists already."
12330 #: ../src/guestfs-actions.pod:3674
12331 msgid "guestfs_ln_s"
12335 #: ../src/guestfs-actions.pod:3676
12339 " guestfs_ln_s (guestfs_h *g,\n"
12340 " const char *target,\n"
12341 " const char *linkname);\n"
12346 #: ../src/guestfs-actions.pod:3681 ../fish/guestfish-actions.pod:2558
12347 msgid "This command creates a symbolic link using the C<ln -s> command."
12351 #: ../src/guestfs-actions.pod:3687
12352 msgid "guestfs_ln_sf"
12356 #: ../src/guestfs-actions.pod:3689
12360 " guestfs_ln_sf (guestfs_h *g,\n"
12361 " const char *target,\n"
12362 " const char *linkname);\n"
12367 #: ../src/guestfs-actions.pod:3694 ../fish/guestfish-actions.pod:2564
12369 "This command creates a symbolic link using the C<ln -sf> command, The I<-f> "
12370 "option removes the link (C<linkname>) if it exists already."
12374 #: ../src/guestfs-actions.pod:3701
12375 msgid "guestfs_lremovexattr"
12379 #: ../src/guestfs-actions.pod:3703
12383 " guestfs_lremovexattr (guestfs_h *g,\n"
12384 " const char *xattr,\n"
12385 " const char *path);\n"
12390 #: ../src/guestfs-actions.pod:3708
12392 "This is the same as C<guestfs_removexattr>, but if C<path> is a symbolic "
12393 "link, then it removes an extended attribute of the link itself."
12397 #: ../src/guestfs-actions.pod:3716
12402 #: ../src/guestfs-actions.pod:3718
12406 " guestfs_ls (guestfs_h *g,\n"
12407 " const char *directory);\n"
12412 #: ../src/guestfs-actions.pod:3722 ../fish/guestfish-actions.pod:2579
12414 "List the files in C<directory> (relative to the root directory, there is no "
12415 "cwd). The '.' and '..' entries are not returned, but hidden files are shown."
12419 #: ../src/guestfs-actions.pod:3726
12421 "This command is mostly useful for interactive sessions. Programs should "
12422 "probably use C<guestfs_readdir> instead."
12426 #: ../src/guestfs-actions.pod:3735
12427 msgid "guestfs_lsetxattr"
12431 #: ../src/guestfs-actions.pod:3737
12435 " guestfs_lsetxattr (guestfs_h *g,\n"
12436 " const char *xattr,\n"
12437 " const char *val,\n"
12439 " const char *path);\n"
12444 #: ../src/guestfs-actions.pod:3744
12446 "This is the same as C<guestfs_setxattr>, but if C<path> is a symbolic link, "
12447 "then it sets an extended attribute of the link itself."
12451 #: ../src/guestfs-actions.pod:3752
12452 msgid "guestfs_lstat"
12456 #: ../src/guestfs-actions.pod:3754
12459 " struct guestfs_stat *\n"
12460 " guestfs_lstat (guestfs_h *g,\n"
12461 " const char *path);\n"
12466 #: ../src/guestfs-actions.pod:3758 ../src/guestfs-actions.pod:6360
12467 #: ../fish/guestfish-actions.pod:2598 ../fish/guestfish-actions.pod:4311
12468 msgid "Returns file information for the given C<path>."
12472 #: ../src/guestfs-actions.pod:3760
12474 "This is the same as C<guestfs_stat> except that if C<path> is a symbolic "
12475 "link, then the link is stat-ed, not the file it refers to."
12479 #: ../src/guestfs-actions.pod:3764 ../fish/guestfish-actions.pod:2604
12480 msgid "This is the same as the C<lstat(2)> system call."
12484 #: ../src/guestfs-actions.pod:3766 ../src/guestfs-actions.pod:6364
12486 "This function returns a C<struct guestfs_stat *>, or NULL if there was an "
12487 "error. I<The caller must call C<guestfs_free_stat> after use>."
12491 #: ../src/guestfs-actions.pod:3770 ../src/guestfs-actions.pod:6368
12492 #: ../src/guestfs-actions.pod:6386 ../src/guestfs-actions.pod:6767
12493 msgid "(Added in 0.9.2)"
12497 #: ../src/guestfs-actions.pod:3772
12498 msgid "guestfs_lstatlist"
12502 #: ../src/guestfs-actions.pod:3774
12505 " struct guestfs_stat_list *\n"
12506 " guestfs_lstatlist (guestfs_h *g,\n"
12507 " const char *path,\n"
12508 " char *const *names);\n"
12513 #: ../src/guestfs-actions.pod:3779
12515 "This call allows you to perform the C<guestfs_lstat> operation on multiple "
12516 "files, where all files are in the directory C<path>. C<names> is the list "
12517 "of files from this directory."
12521 #: ../src/guestfs-actions.pod:3783 ../fish/guestfish-actions.pod:2614
12523 "On return you get a list of stat structs, with a one-to-one correspondence "
12524 "to the C<names> list. If any name did not exist or could not be lstat'd, "
12525 "then the C<ino> field of that structure is set to C<-1>."
12529 #: ../src/guestfs-actions.pod:3788
12531 "This call is intended for programs that want to efficiently list a directory "
12532 "contents without making many round-trips. See also C<guestfs_lxattrlist> "
12533 "for a similarly efficient call for getting extended attributes. Very long "
12534 "directory listings might cause the protocol message size to be exceeded, "
12535 "causing this call to fail. The caller must split up such requests into "
12536 "smaller groups of names."
12540 #: ../src/guestfs-actions.pod:3796
12542 "This function returns a C<struct guestfs_stat_list *>, or NULL if there was "
12543 "an error. I<The caller must call C<guestfs_free_stat_list> after use>."
12547 #: ../src/guestfs-actions.pod:3802
12548 msgid "guestfs_luks_add_key"
12552 #: ../src/guestfs-actions.pod:3804
12556 " guestfs_luks_add_key (guestfs_h *g,\n"
12557 " const char *device,\n"
12558 " const char *key,\n"
12559 " const char *newkey,\n"
12565 #: ../src/guestfs-actions.pod:3811 ../fish/guestfish-actions.pod:2631
12567 "This command adds a new key on LUKS device C<device>. C<key> is any "
12568 "existing key, and is used to access the device. C<newkey> is the new key to "
12569 "add. C<keyslot> is the key slot that will be replaced."
12573 #: ../src/guestfs-actions.pod:3816
12575 "Note that if C<keyslot> already contains a key, then this command will "
12576 "fail. You have to use C<guestfs_luks_kill_slot> first to remove that key."
12580 #: ../src/guestfs-actions.pod:3822 ../src/guestfs-actions.pod:3862
12581 #: ../src/guestfs-actions.pod:3885 ../src/guestfs-actions.pod:3905
12582 #: ../src/guestfs-actions.pod:3937 ../src/guestfs-actions.pod:3956
12584 "This function takes a key or passphrase parameter which could contain "
12585 "sensitive material. Read the section L</KEYS AND PASSPHRASES> for more "
12590 #: ../src/guestfs-actions.pod:3826 ../src/guestfs-actions.pod:3866
12591 #: ../src/guestfs-actions.pod:3889 ../src/guestfs-actions.pod:3909
12592 msgid "(Added in 1.5.2)"
12596 #: ../src/guestfs-actions.pod:3828
12597 msgid "guestfs_luks_close"
12601 #: ../src/guestfs-actions.pod:3830
12605 " guestfs_luks_close (guestfs_h *g,\n"
12606 " const char *device);\n"
12611 #: ../src/guestfs-actions.pod:3834
12613 "This closes a LUKS device that was created earlier by C<guestfs_luks_open> "
12614 "or C<guestfs_luks_open_ro>. The C<device> parameter must be the name of the "
12615 "LUKS mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
12616 "underlying block device."
12620 #: ../src/guestfs-actions.pod:3842 ../src/guestfs-actions.pod:3941
12621 #: ../src/guestfs-actions.pod:3960 ../src/guestfs-actions.pod:4010
12622 #: ../src/guestfs-actions.pod:4058
12623 msgid "(Added in 1.5.1)"
12627 #: ../src/guestfs-actions.pod:3844
12628 msgid "guestfs_luks_format"
12632 #: ../src/guestfs-actions.pod:3846
12636 " guestfs_luks_format (guestfs_h *g,\n"
12637 " const char *device,\n"
12638 " const char *key,\n"
12644 #: ../src/guestfs-actions.pod:3852 ../fish/guestfish-actions.pod:2657
12646 "This command erases existing data on C<device> and formats the device as a "
12647 "LUKS encrypted device. C<key> is the initial key, which is added to key "
12648 "slot C<slot>. (LUKS supports 8 key slots, numbered 0-7)."
12652 #: ../src/guestfs-actions.pod:3859 ../src/guestfs-actions.pod:3882
12653 #: ../src/guestfs-actions.pod:4022 ../src/guestfs-actions.pod:4980
12654 #: ../src/guestfs-actions.pod:5760 ../src/guestfs-actions.pod:6167
12655 #: ../src/guestfs-actions.pod:6197 ../src/guestfs-actions.pod:6230
12656 #: ../src/guestfs-actions.pod:7411 ../fish/guestfish-actions.pod:2665
12657 #: ../fish/guestfish-actions.pod:2678 ../fish/guestfish-actions.pod:2762
12658 #: ../fish/guestfish-actions.pod:3352 ../fish/guestfish-actions.pod:3872
12659 #: ../fish/guestfish-actions.pod:4182 ../fish/guestfish-actions.pod:4205
12660 #: ../fish/guestfish-actions.pod:4227 ../fish/guestfish-actions.pod:4956
12662 "B<This command is dangerous. Without careful use you can easily destroy all "
12667 #: ../src/guestfs-actions.pod:3868
12668 msgid "guestfs_luks_format_cipher"
12672 #: ../src/guestfs-actions.pod:3870
12676 " guestfs_luks_format_cipher (guestfs_h *g,\n"
12677 " const char *device,\n"
12678 " const char *key,\n"
12680 " const char *cipher);\n"
12685 #: ../src/guestfs-actions.pod:3877
12687 "This command is the same as C<guestfs_luks_format> but it also allows you to "
12688 "set the C<cipher> used."
12692 #: ../src/guestfs-actions.pod:3891
12693 msgid "guestfs_luks_kill_slot"
12697 #: ../src/guestfs-actions.pod:3893
12701 " guestfs_luks_kill_slot (guestfs_h *g,\n"
12702 " const char *device,\n"
12703 " const char *key,\n"
12709 #: ../src/guestfs-actions.pod:3899 ../fish/guestfish-actions.pod:2685
12711 "This command deletes the key in key slot C<keyslot> from the encrypted LUKS "
12712 "device C<device>. C<key> must be one of the I<other> keys."
12716 #: ../src/guestfs-actions.pod:3911
12717 msgid "guestfs_luks_open"
12721 #: ../src/guestfs-actions.pod:3913
12725 " guestfs_luks_open (guestfs_h *g,\n"
12726 " const char *device,\n"
12727 " const char *key,\n"
12728 " const char *mapname);\n"
12733 #: ../src/guestfs-actions.pod:3919 ../fish/guestfish-actions.pod:2696
12735 "This command opens a block device which has been encrypted according to the "
12736 "Linux Unified Key Setup (LUKS) standard."
12740 #: ../src/guestfs-actions.pod:3922 ../fish/guestfish-actions.pod:2699
12741 msgid "C<device> is the encrypted block device or partition."
12745 #: ../src/guestfs-actions.pod:3924 ../fish/guestfish-actions.pod:2701
12747 "The caller must supply one of the keys associated with the LUKS block "
12748 "device, in the C<key> parameter."
12752 #: ../src/guestfs-actions.pod:3927 ../fish/guestfish-actions.pod:2704
12754 "This creates a new block device called C</dev/mapper/mapname>. Reads and "
12755 "writes to this block device are decrypted from and encrypted to the "
12756 "underlying C<device> respectively."
12760 #: ../src/guestfs-actions.pod:3931
12762 "If this block device contains LVM volume groups, then calling "
12763 "C<guestfs_vgscan> followed by C<guestfs_vg_activate_all> will make them "
12768 #: ../src/guestfs-actions.pod:3943
12769 msgid "guestfs_luks_open_ro"
12773 #: ../src/guestfs-actions.pod:3945
12777 " guestfs_luks_open_ro (guestfs_h *g,\n"
12778 " const char *device,\n"
12779 " const char *key,\n"
12780 " const char *mapname);\n"
12785 #: ../src/guestfs-actions.pod:3951
12787 "This is the same as C<guestfs_luks_open> except that a read-only mapping is "
12792 #: ../src/guestfs-actions.pod:3962
12793 msgid "guestfs_lvcreate"
12797 #: ../src/guestfs-actions.pod:3964
12801 " guestfs_lvcreate (guestfs_h *g,\n"
12802 " const char *logvol,\n"
12803 " const char *volgroup,\n"
12809 #: ../src/guestfs-actions.pod:3970 ../fish/guestfish-actions.pod:2729
12811 "This creates an LVM logical volume called C<logvol> on the volume group "
12812 "C<volgroup>, with C<size> megabytes."
12816 #: ../src/guestfs-actions.pod:3977
12817 msgid "guestfs_lvm_canonical_lv_name"
12821 #: ../src/guestfs-actions.pod:3979
12825 " guestfs_lvm_canonical_lv_name (guestfs_h *g,\n"
12826 " const char *lvname);\n"
12831 #: ../src/guestfs-actions.pod:3983 ../fish/guestfish-actions.pod:2736
12833 "This converts alternative naming schemes for LVs that you might find to the "
12834 "canonical name. For example, C</dev/mapper/VG-LV> is converted to C</dev/VG/"
12839 #: ../src/guestfs-actions.pod:3987 ../fish/guestfish-actions.pod:2740
12841 "This command returns an error if the C<lvname> parameter does not refer to a "
12846 #: ../src/guestfs-actions.pod:3990
12847 msgid "See also C<guestfs_is_lv>."
12851 #: ../src/guestfs-actions.pod:3995
12852 msgid "(Added in 1.5.24)"
12856 #: ../src/guestfs-actions.pod:3997
12857 msgid "guestfs_lvm_clear_filter"
12861 #: ../src/guestfs-actions.pod:3999
12865 " guestfs_lvm_clear_filter (guestfs_h *g);\n"
12870 #: ../src/guestfs-actions.pod:4002
12872 "This undoes the effect of C<guestfs_lvm_set_filter>. LVM will be able to "
12873 "see every block device."
12877 #: ../src/guestfs-actions.pod:4005 ../src/guestfs-actions.pod:4047
12878 #: ../fish/guestfish-actions.pod:2752 ../fish/guestfish-actions.pod:2783
12880 "This command also clears the LVM cache and performs a volume group scan."
12884 #: ../src/guestfs-actions.pod:4012
12885 msgid "guestfs_lvm_remove_all"
12889 #: ../src/guestfs-actions.pod:4014
12893 " guestfs_lvm_remove_all (guestfs_h *g);\n"
12898 #: ../src/guestfs-actions.pod:4017 ../fish/guestfish-actions.pod:2759
12900 "This command removes all LVM logical volumes, volume groups and physical "
12905 #: ../src/guestfs-actions.pod:4027
12906 msgid "guestfs_lvm_set_filter"
12910 #: ../src/guestfs-actions.pod:4029
12914 " guestfs_lvm_set_filter (guestfs_h *g,\n"
12915 " char *const *devices);\n"
12920 #: ../src/guestfs-actions.pod:4033 ../fish/guestfish-actions.pod:2769
12922 "This sets the LVM device filter so that LVM will only be able to \"see\" the "
12923 "block devices in the list C<devices>, and will ignore all other attached "
12928 #: ../src/guestfs-actions.pod:4037 ../fish/guestfish-actions.pod:2773
12930 "Where disk image(s) contain duplicate PVs or VGs, this command is useful to "
12931 "get LVM to ignore the duplicates, otherwise LVM can get confused. Note also "
12932 "there are two types of duplication possible: either cloned PVs/VGs which "
12933 "have identical UUIDs; or VGs that are not cloned but just happen to have the "
12934 "same name. In normal operation you cannot create this situation, but you "
12935 "can do it outside LVM, eg. by cloning disk images or by bit twiddling "
12936 "inside the LVM metadata."
12940 #: ../src/guestfs-actions.pod:4050 ../fish/guestfish-actions.pod:2786
12941 msgid "You can filter whole block devices or individual partitions."
12945 #: ../src/guestfs-actions.pod:4052 ../fish/guestfish-actions.pod:2788
12947 "You cannot use this if any VG is currently in use (eg. contains a mounted "
12948 "filesystem), even if you are not filtering out that VG."
12952 #: ../src/guestfs-actions.pod:4060
12953 msgid "guestfs_lvremove"
12957 #: ../src/guestfs-actions.pod:4062
12961 " guestfs_lvremove (guestfs_h *g,\n"
12962 " const char *device);\n"
12967 #: ../src/guestfs-actions.pod:4066 ../fish/guestfish-actions.pod:2796
12969 "Remove an LVM logical volume C<device>, where C<device> is the path to the "
12970 "LV, such as C</dev/VG/LV>."
12974 #: ../src/guestfs-actions.pod:4069 ../fish/guestfish-actions.pod:2799
12976 "You can also remove all LVs in a volume group by specifying the VG name, C</"
12981 #: ../src/guestfs-actions.pod:4074 ../src/guestfs-actions.pod:5326
12982 #: ../src/guestfs-actions.pod:7143
12983 msgid "(Added in 1.0.13)"
12987 #: ../src/guestfs-actions.pod:4076
12988 msgid "guestfs_lvrename"
12992 #: ../src/guestfs-actions.pod:4078
12996 " guestfs_lvrename (guestfs_h *g,\n"
12997 " const char *logvol,\n"
12998 " const char *newlogvol);\n"
13003 #: ../src/guestfs-actions.pod:4083 ../fish/guestfish-actions.pod:2806
13004 msgid "Rename a logical volume C<logvol> with the new name C<newlogvol>."
13008 #: ../src/guestfs-actions.pod:4087 ../src/guestfs-actions.pod:7156
13009 msgid "(Added in 1.0.83)"
13013 #: ../src/guestfs-actions.pod:4089
13014 msgid "guestfs_lvresize"
13018 #: ../src/guestfs-actions.pod:4091
13022 " guestfs_lvresize (guestfs_h *g,\n"
13023 " const char *device,\n"
13029 #: ../src/guestfs-actions.pod:4096 ../fish/guestfish-actions.pod:2812
13031 "This resizes (expands or shrinks) an existing LVM logical volume to "
13032 "C<mbytes>. When reducing, data in the reduced part is lost."
13036 #: ../src/guestfs-actions.pod:4104
13037 msgid "guestfs_lvresize_free"
13041 #: ../src/guestfs-actions.pod:4106
13045 " guestfs_lvresize_free (guestfs_h *g,\n"
13046 " const char *lv,\n"
13052 #: ../src/guestfs-actions.pod:4111 ../fish/guestfish-actions.pod:2820
13054 "This expands an existing logical volume C<lv> so that it fills C<pc>% of the "
13055 "remaining free space in the volume group. Commonly you would call this with "
13056 "pc = 100 which expands the logical volume as much as possible, using all "
13057 "remaining free space in the volume group."
13061 #: ../src/guestfs-actions.pod:4119
13062 msgid "(Added in 1.3.3)"
13066 #: ../src/guestfs-actions.pod:4121
13067 msgid "guestfs_lvs"
13071 #: ../src/guestfs-actions.pod:4123
13075 " guestfs_lvs (guestfs_h *g);\n"
13080 #: ../src/guestfs-actions.pod:4126 ../fish/guestfish-actions.pod:2830
13082 "List all the logical volumes detected. This is the equivalent of the L<lvs"
13087 #: ../src/guestfs-actions.pod:4129 ../fish/guestfish-actions.pod:2833
13089 "This returns a list of the logical volume device names (eg. C</dev/"
13090 "VolGroup00/LogVol00>)."
13094 #: ../src/guestfs-actions.pod:4132
13095 msgid "See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>."
13099 #: ../src/guestfs-actions.pod:4140
13100 msgid "guestfs_lvs_full"
13104 #: ../src/guestfs-actions.pod:4142
13107 " struct guestfs_lvm_lv_list *\n"
13108 " guestfs_lvs_full (guestfs_h *g);\n"
13113 #: ../src/guestfs-actions.pod:4145 ../fish/guestfish-actions.pod:2842
13115 "List all the logical volumes detected. This is the equivalent of the L<lvs"
13116 "(8)> command. The \"full\" version includes all fields."
13120 #: ../src/guestfs-actions.pod:4148
13122 "This function returns a C<struct guestfs_lvm_lv_list *>, or NULL if there "
13123 "was an error. I<The caller must call C<guestfs_free_lvm_lv_list> after use>."
13127 #: ../src/guestfs-actions.pod:4154
13128 msgid "guestfs_lvuuid"
13132 #: ../src/guestfs-actions.pod:4156
13136 " guestfs_lvuuid (guestfs_h *g,\n"
13137 " const char *device);\n"
13142 #: ../src/guestfs-actions.pod:4160 ../fish/guestfish-actions.pod:2849
13143 msgid "This command returns the UUID of the LVM LV C<device>."
13147 #: ../src/guestfs-actions.pod:4167
13148 msgid "guestfs_lxattrlist"
13152 #: ../src/guestfs-actions.pod:4169
13155 " struct guestfs_xattr_list *\n"
13156 " guestfs_lxattrlist (guestfs_h *g,\n"
13157 " const char *path,\n"
13158 " char *const *names);\n"
13163 #: ../src/guestfs-actions.pod:4174 ../fish/guestfish-actions.pod:2855
13165 "This call allows you to get the extended attributes of multiple files, where "
13166 "all files are in the directory C<path>. C<names> is the list of files from "
13171 #: ../src/guestfs-actions.pod:4178 ../fish/guestfish-actions.pod:2859
13173 "On return you get a flat list of xattr structs which must be interpreted "
13174 "sequentially. The first xattr struct always has a zero-length C<attrname>. "
13175 "C<attrval> in this struct is zero-length to indicate there was an error "
13176 "doing C<lgetxattr> for this file, I<or> is a C string which is a decimal "
13177 "number (the number of following attributes for this file, which could be C<"
13178 "\"0\">). Then after the first xattr struct are the zero or more attributes "
13179 "for the first named file. This repeats for the second and subsequent files."
13183 #: ../src/guestfs-actions.pod:4188
13185 "This call is intended for programs that want to efficiently list a directory "
13186 "contents without making many round-trips. See also C<guestfs_lstatlist> for "
13187 "a similarly efficient call for getting standard stats. Very long directory "
13188 "listings might cause the protocol message size to be exceeded, causing this "
13189 "call to fail. The caller must split up such requests into smaller groups of "
13194 #: ../src/guestfs-actions.pod:4202
13195 msgid "guestfs_mkdir"
13199 #: ../src/guestfs-actions.pod:4204
13203 " guestfs_mkdir (guestfs_h *g,\n"
13204 " const char *path);\n"
13209 #: ../src/guestfs-actions.pod:4208 ../fish/guestfish-actions.pod:2881
13210 msgid "Create a directory named C<path>."
13214 #: ../src/guestfs-actions.pod:4214
13215 msgid "guestfs_mkdir_mode"
13219 #: ../src/guestfs-actions.pod:4216
13223 " guestfs_mkdir_mode (guestfs_h *g,\n"
13224 " const char *path,\n"
13230 #: ../src/guestfs-actions.pod:4221 ../fish/guestfish-actions.pod:2887
13232 "This command creates a directory, setting the initial permissions of the "
13233 "directory to C<mode>."
13237 #: ../src/guestfs-actions.pod:4224 ../fish/guestfish-actions.pod:2890
13239 "For common Linux filesystems, the actual mode which is set will be C<mode & "
13240 "~umask & 01777>. Non-native-Linux filesystems may interpret the mode in "
13245 #: ../src/guestfs-actions.pod:4228
13246 msgid "See also C<guestfs_mkdir>, C<guestfs_umask>"
13250 #: ../src/guestfs-actions.pod:4234
13251 msgid "guestfs_mkdir_p"
13255 #: ../src/guestfs-actions.pod:4236
13259 " guestfs_mkdir_p (guestfs_h *g,\n"
13260 " const char *path);\n"
13265 #: ../src/guestfs-actions.pod:4240 ../fish/guestfish-actions.pod:2900
13267 "Create a directory named C<path>, creating any parent directories as "
13268 "necessary. This is like the C<mkdir -p> shell command."
13272 #: ../src/guestfs-actions.pod:4247
13273 msgid "guestfs_mkdtemp"
13277 #: ../src/guestfs-actions.pod:4249
13281 " guestfs_mkdtemp (guestfs_h *g,\n"
13282 " const char *template);\n"
13287 #: ../src/guestfs-actions.pod:4253 ../fish/guestfish-actions.pod:2907
13289 "This command creates a temporary directory. The C<template> parameter "
13290 "should be a full pathname for the temporary directory name with the final "
13291 "six characters being \"XXXXXX\"."
13295 #: ../src/guestfs-actions.pod:4258 ../fish/guestfish-actions.pod:2912
13297 "For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\", the second one "
13298 "being suitable for Windows filesystems."
13302 #: ../src/guestfs-actions.pod:4261 ../fish/guestfish-actions.pod:2915
13303 msgid "The name of the temporary directory that was created is returned."
13307 #: ../src/guestfs-actions.pod:4264 ../fish/guestfish-actions.pod:2918
13308 msgid "The temporary directory is created with mode 0700 and is owned by root."
13312 #: ../src/guestfs-actions.pod:4267 ../fish/guestfish-actions.pod:2921
13314 "The caller is responsible for deleting the temporary directory and its "
13315 "contents after use."
13319 #: ../src/guestfs-actions.pod:4270 ../fish/guestfish-actions.pod:2924
13320 msgid "See also: L<mkdtemp(3)>"
13324 #: ../src/guestfs-actions.pod:4277
13325 msgid "guestfs_mke2fs_J"
13329 #: ../src/guestfs-actions.pod:4279
13333 " guestfs_mke2fs_J (guestfs_h *g,\n"
13334 " const char *fstype,\n"
13335 " int blocksize,\n"
13336 " const char *device,\n"
13337 " const char *journal);\n"
13342 #: ../src/guestfs-actions.pod:4286 ../fish/guestfish-actions.pod:2930
13344 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
13345 "C<journal>. It is equivalent to the command:"
13349 #: ../src/guestfs-actions.pod:4290 ../fish/guestfish-actions.pod:2934
13352 " mke2fs -t fstype -b blocksize -J device=<journal> <device>\n"
13357 #: ../src/guestfs-actions.pod:4292
13358 msgid "See also C<guestfs_mke2journal>."
13362 #: ../src/guestfs-actions.pod:4296 ../src/guestfs-actions.pod:4314
13363 #: ../src/guestfs-actions.pod:4332 ../src/guestfs-actions.pod:4348
13364 #: ../src/guestfs-actions.pod:4362 ../src/guestfs-actions.pod:4376
13365 #: ../src/guestfs-actions.pod:4435 ../src/guestfs-actions.pod:4700
13366 msgid "(Added in 1.0.68)"
13370 #: ../src/guestfs-actions.pod:4298
13371 msgid "guestfs_mke2fs_JL"
13375 #: ../src/guestfs-actions.pod:4300
13379 " guestfs_mke2fs_JL (guestfs_h *g,\n"
13380 " const char *fstype,\n"
13381 " int blocksize,\n"
13382 " const char *device,\n"
13383 " const char *label);\n"
13388 #: ../src/guestfs-actions.pod:4307 ../fish/guestfish-actions.pod:2942
13390 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
13391 "the journal labeled C<label>."
13395 #: ../src/guestfs-actions.pod:4310
13396 msgid "See also C<guestfs_mke2journal_L>."
13400 #: ../src/guestfs-actions.pod:4316
13401 msgid "guestfs_mke2fs_JU"
13405 #: ../src/guestfs-actions.pod:4318
13409 " guestfs_mke2fs_JU (guestfs_h *g,\n"
13410 " const char *fstype,\n"
13411 " int blocksize,\n"
13412 " const char *device,\n"
13413 " const char *uuid);\n"
13418 #: ../src/guestfs-actions.pod:4325 ../fish/guestfish-actions.pod:2951
13420 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
13421 "the journal with UUID C<uuid>."
13425 #: ../src/guestfs-actions.pod:4328
13426 msgid "See also C<guestfs_mke2journal_U>."
13430 #: ../src/guestfs-actions.pod:4334
13431 msgid "guestfs_mke2journal"
13435 #: ../src/guestfs-actions.pod:4336
13439 " guestfs_mke2journal (guestfs_h *g,\n"
13440 " int blocksize,\n"
13441 " const char *device);\n"
13446 #: ../src/guestfs-actions.pod:4341 ../fish/guestfish-actions.pod:2960
13448 "This creates an ext2 external journal on C<device>. It is equivalent to the "
13453 #: ../src/guestfs-actions.pod:4344 ../fish/guestfish-actions.pod:2963
13456 " mke2fs -O journal_dev -b blocksize device\n"
13461 #: ../src/guestfs-actions.pod:4350
13462 msgid "guestfs_mke2journal_L"
13466 #: ../src/guestfs-actions.pod:4352
13470 " guestfs_mke2journal_L (guestfs_h *g,\n"
13471 " int blocksize,\n"
13472 " const char *label,\n"
13473 " const char *device);\n"
13478 #: ../src/guestfs-actions.pod:4358 ../fish/guestfish-actions.pod:2969
13479 msgid "This creates an ext2 external journal on C<device> with label C<label>."
13483 #: ../src/guestfs-actions.pod:4364
13484 msgid "guestfs_mke2journal_U"
13488 #: ../src/guestfs-actions.pod:4366
13492 " guestfs_mke2journal_U (guestfs_h *g,\n"
13493 " int blocksize,\n"
13494 " const char *uuid,\n"
13495 " const char *device);\n"
13500 #: ../src/guestfs-actions.pod:4372 ../fish/guestfish-actions.pod:2975
13501 msgid "This creates an ext2 external journal on C<device> with UUID C<uuid>."
13505 #: ../src/guestfs-actions.pod:4378
13506 msgid "guestfs_mkfifo"
13510 #: ../src/guestfs-actions.pod:4380
13514 " guestfs_mkfifo (guestfs_h *g,\n"
13516 " const char *path);\n"
13521 #: ../src/guestfs-actions.pod:4385
13523 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
13524 "is just a convenient wrapper around C<guestfs_mknod>."
13528 #: ../src/guestfs-actions.pod:4395
13529 msgid "guestfs_mkfs"
13533 #: ../src/guestfs-actions.pod:4397
13537 " guestfs_mkfs (guestfs_h *g,\n"
13538 " const char *fstype,\n"
13539 " const char *device);\n"
13544 #: ../src/guestfs-actions.pod:4402 ../fish/guestfish-actions.pod:2991
13546 "This creates a filesystem on C<device> (usually a partition or LVM logical "
13547 "volume). The filesystem type is C<fstype>, for example C<ext3>."
13551 #: ../src/guestfs-actions.pod:4410
13552 msgid "guestfs_mkfs_b"
13556 #: ../src/guestfs-actions.pod:4412
13560 " guestfs_mkfs_b (guestfs_h *g,\n"
13561 " const char *fstype,\n"
13562 " int blocksize,\n"
13563 " const char *device);\n"
13568 #: ../src/guestfs-actions.pod:4418
13570 "This call is similar to C<guestfs_mkfs>, but it allows you to control the "
13571 "block size of the resulting filesystem. Supported block sizes depend on the "
13572 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
13576 #: ../src/guestfs-actions.pod:4423 ../src/guestfs-actions.pod:4466
13577 #: ../fish/guestfish-actions.pod:3004 ../fish/guestfish-actions.pod:3031
13579 "For VFAT and NTFS the C<blocksize> parameter is treated as the requested "
13584 #: ../src/guestfs-actions.pod:4428
13586 "This function is deprecated. In new code, use the L</guestfs_mkfs_opts> "
13591 #: ../src/guestfs-actions.pod:4437
13592 msgid "guestfs_mkfs_opts"
13596 #: ../src/guestfs-actions.pod:4439
13600 " guestfs_mkfs_opts (guestfs_h *g,\n"
13601 " const char *fstype,\n"
13602 " const char *device,\n"
13608 #: ../src/guestfs-actions.pod:4450
13611 " GUESTFS_MKFS_OPTS_BLOCKSIZE, int blocksize,\n"
13612 " GUESTFS_MKFS_OPTS_FEATURES, const char *features,\n"
13617 #: ../src/guestfs-actions.pod:4453 ../fish/guestfish-actions.pod:3018
13619 "This function creates a filesystem on C<device>. The filesystem type is "
13620 "C<fstype>, for example C<ext3>."
13624 #: ../src/guestfs-actions.pod:4460 ../fish/guestfish-actions.pod:3025
13625 msgid "C<blocksize>"
13629 #: ../src/guestfs-actions.pod:4462 ../fish/guestfish-actions.pod:3027
13631 "The filesystem block size. Supported block sizes depend on the filesystem "
13632 "type, but typically they are C<1024>, C<2048> or C<4096> for Linux ext2/3 "
13637 #: ../src/guestfs-actions.pod:4469 ../fish/guestfish-actions.pod:3034
13638 msgid "For UFS block sizes, please see L<mkfs.ufs(8)>."
13642 #: ../src/guestfs-actions.pod:4471 ../fish/guestfish-actions.pod:3036
13643 msgid "C<features>"
13647 #: ../src/guestfs-actions.pod:4473 ../fish/guestfish-actions.pod:3038
13648 msgid "This passes the I<-O> parameter to the external mkfs program."
13652 #: ../src/guestfs-actions.pod:4475 ../fish/guestfish-actions.pod:3040
13654 "For certain filesystem types, this allows extra filesystem features to be "
13655 "selected. See L<mke2fs(8)> and L<mkfs.ufs(8)> for more details."
13659 #: ../src/guestfs-actions.pod:4479 ../fish/guestfish-actions.pod:3044
13661 "You cannot use this optional parameter with the C<gfs> or C<gfs2> filesystem "
13666 #: ../src/guestfs-actions.pod:4486
13667 msgid "(Added in 1.7.19)"
13671 #: ../src/guestfs-actions.pod:4488
13672 msgid "guestfs_mkfs_opts_va"
13676 #: ../src/guestfs-actions.pod:4490
13680 " guestfs_mkfs_opts_va (guestfs_h *g,\n"
13681 " const char *fstype,\n"
13682 " const char *device,\n"
13683 " va_list args);\n"
13688 #: ../src/guestfs-actions.pod:4496
13689 msgid "This is the \"va_list variant\" of L</guestfs_mkfs_opts>."
13693 #: ../src/guestfs-actions.pod:4500
13694 msgid "guestfs_mkfs_opts_argv"
13698 #: ../src/guestfs-actions.pod:4502
13702 " guestfs_mkfs_opts_argv (guestfs_h *g,\n"
13703 " const char *fstype,\n"
13704 " const char *device,\n"
13705 " const struct guestfs_mkfs_opts_argv *optargs);\n"
13710 #: ../src/guestfs-actions.pod:4508
13711 msgid "This is the \"argv variant\" of L</guestfs_mkfs_opts>."
13715 #: ../src/guestfs-actions.pod:4512
13716 msgid "guestfs_mkmountpoint"
13720 #: ../src/guestfs-actions.pod:4514
13724 " guestfs_mkmountpoint (guestfs_h *g,\n"
13725 " const char *exemptpath);\n"
13730 #: ../src/guestfs-actions.pod:4518
13732 "C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are specialized calls "
13733 "that can be used to create extra mountpoints before mounting the first "
13738 #: ../src/guestfs-actions.pod:4522 ../fish/guestfish-actions.pod:3059
13740 "These calls are I<only> necessary in some very limited circumstances, mainly "
13741 "the case where you want to mount a mix of unrelated and/or read-only "
13742 "filesystems together."
13746 #: ../src/guestfs-actions.pod:4526 ../fish/guestfish-actions.pod:3063
13748 "For example, live CDs often contain a \"Russian doll\" nest of filesystems, "
13749 "an ISO outer layer, with a squashfs image inside, with an ext2/3 image "
13750 "inside that. You can unpack this as follows in guestfish:"
13754 #: ../src/guestfs-actions.pod:4531 ../fish/guestfish-actions.pod:3068
13757 " add-ro Fedora-11-i686-Live.iso\n"
13759 " mkmountpoint /cd\n"
13760 " mkmountpoint /sqsh\n"
13761 " mkmountpoint /ext3fs\n"
13762 " mount /dev/sda /cd\n"
13763 " mount-loop /cd/LiveOS/squashfs.img /sqsh\n"
13764 " mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs\n"
13769 #: ../src/guestfs-actions.pod:4540 ../fish/guestfish-actions.pod:3077
13770 msgid "The inner filesystem is now unpacked under the /ext3fs mountpoint."
13774 #: ../src/guestfs-actions.pod:4542
13776 "C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>. You "
13777 "may get unexpected errors if you try to mix these calls. It is safest to "
13778 "manually unmount filesystems and remove mountpoints after use."
13782 #: ../src/guestfs-actions.pod:4546
13784 "C<guestfs_umount_all> unmounts filesystems by sorting the paths longest "
13785 "first, so for this to work for manual mountpoints, you must ensure that the "
13786 "innermost mountpoints have the longest pathnames, as in the example code "
13791 #: ../src/guestfs-actions.pod:4551 ../fish/guestfish-actions.pod:3088
13793 "For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>"
13797 #: ../src/guestfs-actions.pod:4553
13799 "Autosync [see C<guestfs_set_autosync>, this is set by default on handles] "
13800 "can cause C<guestfs_umount_all> to be called when the handle is closed which "
13801 "can also trigger these issues."
13805 #: ../src/guestfs-actions.pod:4559 ../src/guestfs-actions.pod:4825
13806 #: ../src/guestfs-actions.pod:5744
13807 msgid "(Added in 1.0.62)"
13811 #: ../src/guestfs-actions.pod:4561
13812 msgid "guestfs_mknod"
13816 #: ../src/guestfs-actions.pod:4563
13820 " guestfs_mknod (guestfs_h *g,\n"
13824 " const char *path);\n"
13829 #: ../src/guestfs-actions.pod:4570 ../fish/guestfish-actions.pod:3098
13831 "This call creates block or character special devices, or named pipes (FIFOs)."
13835 #: ../src/guestfs-actions.pod:4573 ../fish/guestfish-actions.pod:3101
13837 "The C<mode> parameter should be the mode, using the standard constants. "
13838 "C<devmajor> and C<devminor> are the device major and minor numbers, only "
13839 "used when creating block and character special devices."
13843 #: ../src/guestfs-actions.pod:4578
13845 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
13846 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
13847 "regular file). These constants are available in the standard Linux header "
13848 "files, or you can use C<guestfs_mknod_b>, C<guestfs_mknod_c> or "
13849 "C<guestfs_mkfifo> which are wrappers around this command which bitwise OR in "
13850 "the appropriate constant for you."
13854 #: ../src/guestfs-actions.pod:4592
13855 msgid "guestfs_mknod_b"
13859 #: ../src/guestfs-actions.pod:4594
13863 " guestfs_mknod_b (guestfs_h *g,\n"
13867 " const char *path);\n"
13872 #: ../src/guestfs-actions.pod:4601
13874 "This call creates a block device node called C<path> with mode C<mode> and "
13875 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
13876 "wrapper around C<guestfs_mknod>."
13880 #: ../src/guestfs-actions.pod:4611
13881 msgid "guestfs_mknod_c"
13885 #: ../src/guestfs-actions.pod:4613
13889 " guestfs_mknod_c (guestfs_h *g,\n"
13893 " const char *path);\n"
13898 #: ../src/guestfs-actions.pod:4620
13900 "This call creates a char device node called C<path> with mode C<mode> and "
13901 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
13902 "wrapper around C<guestfs_mknod>."
13906 #: ../src/guestfs-actions.pod:4630
13907 msgid "guestfs_mkswap"
13911 #: ../src/guestfs-actions.pod:4632
13915 " guestfs_mkswap (guestfs_h *g,\n"
13916 " const char *device);\n"
13921 #: ../src/guestfs-actions.pod:4636 ../fish/guestfish-actions.pod:3140
13922 msgid "Create a swap partition on C<device>."
13926 #: ../src/guestfs-actions.pod:4642
13927 msgid "guestfs_mkswap_L"
13931 #: ../src/guestfs-actions.pod:4644
13935 " guestfs_mkswap_L (guestfs_h *g,\n"
13936 " const char *label,\n"
13937 " const char *device);\n"
13942 #: ../src/guestfs-actions.pod:4649 ../fish/guestfish-actions.pod:3146
13943 msgid "Create a swap partition on C<device> with label C<label>."
13947 #: ../src/guestfs-actions.pod:4651 ../fish/guestfish-actions.pod:3148
13949 "Note that you cannot attach a swap label to a block device (eg. C</dev/"
13950 "sda>), just to a partition. This appears to be a limitation of the kernel "
13955 #: ../src/guestfs-actions.pod:4659
13956 msgid "guestfs_mkswap_U"
13960 #: ../src/guestfs-actions.pod:4661
13964 " guestfs_mkswap_U (guestfs_h *g,\n"
13965 " const char *uuid,\n"
13966 " const char *device);\n"
13971 #: ../src/guestfs-actions.pod:4666 ../fish/guestfish-actions.pod:3156
13972 msgid "Create a swap partition on C<device> with UUID C<uuid>."
13976 #: ../src/guestfs-actions.pod:4672
13977 msgid "guestfs_mkswap_file"
13981 #: ../src/guestfs-actions.pod:4674
13985 " guestfs_mkswap_file (guestfs_h *g,\n"
13986 " const char *path);\n"
13991 #: ../src/guestfs-actions.pod:4678 ../fish/guestfish-actions.pod:3162
13992 msgid "Create a swap file."
13996 #: ../src/guestfs-actions.pod:4680
13998 "This command just writes a swap file signature to an existing file. To "
13999 "create the file itself, use something like C<guestfs_fallocate>."
14003 #: ../src/guestfs-actions.pod:4687
14004 msgid "guestfs_modprobe"
14008 #: ../src/guestfs-actions.pod:4689
14012 " guestfs_modprobe (guestfs_h *g,\n"
14013 " const char *modulename);\n"
14018 #: ../src/guestfs-actions.pod:4693 ../fish/guestfish-actions.pod:3171
14019 msgid "This loads a kernel module in the appliance."
14023 #: ../src/guestfs-actions.pod:4695 ../fish/guestfish-actions.pod:3173
14025 "The kernel module must have been whitelisted when libguestfs was built (see "
14026 "C<appliance/kmod.whitelist.in> in the source)."
14030 #: ../src/guestfs-actions.pod:4702
14031 msgid "guestfs_mount"
14035 #: ../src/guestfs-actions.pod:4704
14039 " guestfs_mount (guestfs_h *g,\n"
14040 " const char *device,\n"
14041 " const char *mountpoint);\n"
14046 #: ../src/guestfs-actions.pod:4709 ../fish/guestfish-actions.pod:3180
14048 "Mount a guest disk at a position in the filesystem. Block devices are named "
14049 "C</dev/sda>, C</dev/sdb> and so on, as they were added to the guest. If "
14050 "those block devices contain partitions, they will have the usual names (eg. "
14051 "C</dev/sda1>). Also LVM C</dev/VG/LV>-style names can be used."
14055 #: ../src/guestfs-actions.pod:4715 ../fish/guestfish-actions.pod:3186
14057 "The rules are the same as for L<mount(2)>: A filesystem must first be "
14058 "mounted on C</> before others can be mounted. Other filesystems can only be "
14059 "mounted on directories which already exist."
14063 #: ../src/guestfs-actions.pod:4720 ../fish/guestfish-actions.pod:3191
14065 "The mounted filesystem is writable, if we have sufficient permissions on the "
14066 "underlying device."
14070 #: ../src/guestfs-actions.pod:4723
14072 "B<Important note:> When you use this call, the filesystem options C<sync> "
14073 "and C<noatime> are set implicitly. This was originally done because we "
14074 "thought it would improve reliability, but it turns out that I<-o sync> has a "
14075 "very large negative performance impact and negligible effect on "
14076 "reliability. Therefore we recommend that you avoid using C<guestfs_mount> "
14077 "in any code that needs performance, and instead use C<guestfs_mount_options> "
14078 "(use an empty string for the first parameter if you don't want any options)."
14082 #: ../src/guestfs-actions.pod:4735
14084 "This function is deprecated. In new code, use the L</guestfs_mount_options> "
14089 #: ../src/guestfs-actions.pod:4744
14090 msgid "guestfs_mount_loop"
14094 #: ../src/guestfs-actions.pod:4746
14098 " guestfs_mount_loop (guestfs_h *g,\n"
14099 " const char *file,\n"
14100 " const char *mountpoint);\n"
14105 #: ../src/guestfs-actions.pod:4751 ../fish/guestfish-actions.pod:3215
14107 "This command lets you mount C<file> (a filesystem image in a file) on a "
14108 "mount point. It is entirely equivalent to the command C<mount -o loop file "
14113 #: ../src/guestfs-actions.pod:4759
14114 msgid "guestfs_mount_options"
14118 #: ../src/guestfs-actions.pod:4761
14122 " guestfs_mount_options (guestfs_h *g,\n"
14123 " const char *options,\n"
14124 " const char *device,\n"
14125 " const char *mountpoint);\n"
14130 #: ../src/guestfs-actions.pod:4767
14132 "This is the same as the C<guestfs_mount> command, but it allows you to set "
14133 "the mount options as for the L<mount(8)> I<-o> flag."
14137 #: ../src/guestfs-actions.pod:4771 ../fish/guestfish-actions.pod:3227
14139 "If the C<options> parameter is an empty string, then no options are passed "
14140 "(all options default to whatever the filesystem uses)."
14144 #: ../src/guestfs-actions.pod:4777 ../src/guestfs-actions.pod:4791
14145 #: ../src/guestfs-actions.pod:4808
14146 msgid "(Added in 1.0.10)"
14150 #: ../src/guestfs-actions.pod:4779
14151 msgid "guestfs_mount_ro"
14155 #: ../src/guestfs-actions.pod:4781
14159 " guestfs_mount_ro (guestfs_h *g,\n"
14160 " const char *device,\n"
14161 " const char *mountpoint);\n"
14166 #: ../src/guestfs-actions.pod:4786
14168 "This is the same as the C<guestfs_mount> command, but it mounts the "
14169 "filesystem with the read-only (I<-o ro>) flag."
14173 #: ../src/guestfs-actions.pod:4793
14174 msgid "guestfs_mount_vfs"
14178 #: ../src/guestfs-actions.pod:4795
14182 " guestfs_mount_vfs (guestfs_h *g,\n"
14183 " const char *options,\n"
14184 " const char *vfstype,\n"
14185 " const char *device,\n"
14186 " const char *mountpoint);\n"
14191 #: ../src/guestfs-actions.pod:4802
14193 "This is the same as the C<guestfs_mount> command, but it allows you to set "
14194 "both the mount options and the vfstype as for the L<mount(8)> I<-o> and I<-"
14199 #: ../src/guestfs-actions.pod:4810
14200 msgid "guestfs_mountpoints"
14204 #: ../src/guestfs-actions.pod:4812
14208 " guestfs_mountpoints (guestfs_h *g);\n"
14213 #: ../src/guestfs-actions.pod:4815
14215 "This call is similar to C<guestfs_mounts>. That call returns a list of "
14216 "devices. This one returns a hash table (map) of device name to directory "
14217 "where the device is mounted."
14221 #: ../src/guestfs-actions.pod:4827
14222 msgid "guestfs_mounts"
14226 #: ../src/guestfs-actions.pod:4829
14230 " guestfs_mounts (guestfs_h *g);\n"
14235 #: ../src/guestfs-actions.pod:4832 ../fish/guestfish-actions.pod:3258
14237 "This returns the list of currently mounted filesystems. It returns the list "
14238 "of devices (eg. C</dev/sda1>, C</dev/VG/LV>)."
14242 #: ../src/guestfs-actions.pod:4835 ../fish/guestfish-actions.pod:3261
14243 msgid "Some internal mounts are not shown."
14247 #: ../src/guestfs-actions.pod:4837
14248 msgid "See also: C<guestfs_mountpoints>"
14252 #: ../src/guestfs-actions.pod:4845
14257 #: ../src/guestfs-actions.pod:4847
14261 " guestfs_mv (guestfs_h *g,\n"
14262 " const char *src,\n"
14263 " const char *dest);\n"
14268 #: ../src/guestfs-actions.pod:4852 ../fish/guestfish-actions.pod:3269
14270 "This moves a file from C<src> to C<dest> where C<dest> is either a "
14271 "destination filename or destination directory."
14275 #: ../src/guestfs-actions.pod:4859
14276 msgid "guestfs_ntfs_3g_probe"
14280 #: ../src/guestfs-actions.pod:4861
14284 " guestfs_ntfs_3g_probe (guestfs_h *g,\n"
14286 " const char *device);\n"
14291 #: ../src/guestfs-actions.pod:4866 ../fish/guestfish-actions.pod:3276
14293 "This command runs the L<ntfs-3g.probe(8)> command which probes an NTFS "
14294 "C<device> for mountability. (Not all NTFS volumes can be mounted read-"
14295 "write, and some cannot be mounted at all)."
14299 #: ../src/guestfs-actions.pod:4870 ../fish/guestfish-actions.pod:3280
14301 "C<rw> is a boolean flag. Set it to true if you want to test if the volume "
14302 "can be mounted read-write. Set it to false if you want to test if the "
14303 "volume can be mounted read-only."
14307 #: ../src/guestfs-actions.pod:4874 ../fish/guestfish-actions.pod:3284
14309 "The return value is an integer which C<0> if the operation would succeed, or "
14310 "some non-zero value documented in the L<ntfs-3g.probe(8)> manual page."
14314 #: ../src/guestfs-actions.pod:4880
14315 msgid "(Added in 1.0.43)"
14319 #: ../src/guestfs-actions.pod:4882
14320 msgid "guestfs_ntfsresize"
14324 #: ../src/guestfs-actions.pod:4884
14328 " guestfs_ntfsresize (guestfs_h *g,\n"
14329 " const char *device);\n"
14334 #: ../src/guestfs-actions.pod:4888 ../fish/guestfish-actions.pod:3292
14336 "This command resizes an NTFS filesystem, expanding or shrinking it to the "
14337 "size of the underlying device."
14341 #: ../src/guestfs-actions.pod:4891 ../fish/guestfish-actions.pod:3295
14343 "I<Note:> After the resize operation, the filesystem is marked as requiring a "
14344 "consistency check (for safety). You have to boot into Windows to perform "
14345 "this check and clear this condition. Furthermore, ntfsresize refuses to "
14346 "resize filesystems which have been marked in this way. So in effect it is "
14347 "not possible to call ntfsresize multiple times on a single filesystem "
14348 "without booting into Windows between each resize."
14352 #: ../src/guestfs-actions.pod:4899 ../fish/guestfish-actions.pod:3303
14353 msgid "See also L<ntfsresize(8)>."
14357 #: ../src/guestfs-actions.pod:4905
14358 msgid "guestfs_ntfsresize_size"
14362 #: ../src/guestfs-actions.pod:4907
14366 " guestfs_ntfsresize_size (guestfs_h *g,\n"
14367 " const char *device,\n"
14368 " int64_t size);\n"
14373 #: ../src/guestfs-actions.pod:4912
14375 "This command is the same as C<guestfs_ntfsresize> except that it allows you "
14376 "to specify the new size (in bytes) explicitly."
14380 #: ../src/guestfs-actions.pod:4917 ../src/guestfs-actions.pod:5353
14381 #: ../src/guestfs-actions.pod:5426 ../src/guestfs-actions.pod:5692
14382 #: ../src/guestfs-actions.pod:7298
14383 msgid "(Added in 1.3.14)"
14387 #: ../src/guestfs-actions.pod:4919
14388 msgid "guestfs_part_add"
14392 #: ../src/guestfs-actions.pod:4921
14396 " guestfs_part_add (guestfs_h *g,\n"
14397 " const char *device,\n"
14398 " const char *prlogex,\n"
14399 " int64_t startsect,\n"
14400 " int64_t endsect);\n"
14405 #: ../src/guestfs-actions.pod:4928
14407 "This command adds a partition to C<device>. If there is no partition table "
14408 "on the device, call C<guestfs_part_init> first."
14412 #: ../src/guestfs-actions.pod:4931 ../fish/guestfish-actions.pod:3319
14414 "The C<prlogex> parameter is the type of partition. Normally you should pass "
14415 "C<p> or C<primary> here, but MBR partition tables also support C<l> (or "
14416 "C<logical>) and C<e> (or C<extended>) partition types."
14420 #: ../src/guestfs-actions.pod:4936 ../fish/guestfish-actions.pod:3324
14422 "C<startsect> and C<endsect> are the start and end of the partition in "
14423 "I<sectors>. C<endsect> may be negative, which means it counts backwards "
14424 "from the end of the disk (C<-1> is the last sector)."
14428 #: ../src/guestfs-actions.pod:4940
14430 "Creating a partition which covers the whole disk is not so easy. Use "
14431 "C<guestfs_part_disk> to do that."
14435 #: ../src/guestfs-actions.pod:4945 ../src/guestfs-actions.pod:4983
14436 #: ../src/guestfs-actions.pod:5036 ../src/guestfs-actions.pod:5114
14437 #: ../src/guestfs-actions.pod:5152 ../src/guestfs-actions.pod:5171
14438 #: ../src/guestfs-actions.pod:5211
14439 msgid "(Added in 1.0.78)"
14443 #: ../src/guestfs-actions.pod:4947
14444 msgid "guestfs_part_del"
14448 #: ../src/guestfs-actions.pod:4949
14452 " guestfs_part_del (guestfs_h *g,\n"
14453 " const char *device,\n"
14459 #: ../src/guestfs-actions.pod:4954 ../fish/guestfish-actions.pod:3335
14460 msgid "This command deletes the partition numbered C<partnum> on C<device>."
14464 #: ../src/guestfs-actions.pod:4956 ../fish/guestfish-actions.pod:3337
14466 "Note that in the case of MBR partitioning, deleting an extended partition "
14467 "also deletes any logical partitions it contains."
14471 #: ../src/guestfs-actions.pod:4964
14472 msgid "guestfs_part_disk"
14476 #: ../src/guestfs-actions.pod:4966
14480 " guestfs_part_disk (guestfs_h *g,\n"
14481 " const char *device,\n"
14482 " const char *parttype);\n"
14487 #: ../src/guestfs-actions.pod:4971
14489 "This command is simply a combination of C<guestfs_part_init> followed by "
14490 "C<guestfs_part_add> to create a single primary partition covering the whole "
14495 #: ../src/guestfs-actions.pod:4975
14497 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
14498 "possible values are described in C<guestfs_part_init>."
14502 #: ../src/guestfs-actions.pod:4985
14503 msgid "guestfs_part_get_bootable"
14507 #: ../src/guestfs-actions.pod:4987
14511 " guestfs_part_get_bootable (guestfs_h *g,\n"
14512 " const char *device,\n"
14518 #: ../src/guestfs-actions.pod:4992 ../fish/guestfish-actions.pod:3359
14520 "This command returns true if the partition C<partnum> on C<device> has the "
14521 "bootable flag set."
14525 #: ../src/guestfs-actions.pod:4995
14526 msgid "See also C<guestfs_part_set_bootable>."
14530 #: ../src/guestfs-actions.pod:5001
14531 msgid "guestfs_part_get_mbr_id"
14535 #: ../src/guestfs-actions.pod:5003
14539 " guestfs_part_get_mbr_id (guestfs_h *g,\n"
14540 " const char *device,\n"
14546 #: ../src/guestfs-actions.pod:5008 ../fish/guestfish-actions.pod:3368
14548 "Returns the MBR type byte (also known as the ID byte) from the numbered "
14549 "partition C<partnum>."
14553 #: ../src/guestfs-actions.pod:5011 ../src/guestfs-actions.pod:5187
14555 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
14556 "undefined results for other partition table types (see "
14557 "C<guestfs_part_get_parttype>)."
14561 #: ../src/guestfs-actions.pod:5019
14562 msgid "guestfs_part_get_parttype"
14566 #: ../src/guestfs-actions.pod:5021
14570 " guestfs_part_get_parttype (guestfs_h *g,\n"
14571 " const char *device);\n"
14576 #: ../src/guestfs-actions.pod:5025 ../fish/guestfish-actions.pod:3379
14578 "This command examines the partition table on C<device> and returns the "
14579 "partition table type (format) being used."
14583 #: ../src/guestfs-actions.pod:5028
14585 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
14586 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
14587 "possible, although unusual. See C<guestfs_part_init> for a full list."
14591 #: ../src/guestfs-actions.pod:5038
14592 msgid "guestfs_part_init"
14596 #: ../src/guestfs-actions.pod:5040
14600 " guestfs_part_init (guestfs_h *g,\n"
14601 " const char *device,\n"
14602 " const char *parttype);\n"
14607 #: ../src/guestfs-actions.pod:5045 ../fish/guestfish-actions.pod:3391
14609 "This creates an empty partition table on C<device> of one of the partition "
14610 "types listed below. Usually C<parttype> should be either C<msdos> or C<gpt> "
14611 "(for large disks)."
14615 #: ../src/guestfs-actions.pod:5049
14617 "Initially there are no partitions. Following this, you should call "
14618 "C<guestfs_part_add> for each partition required."
14622 #: ../src/guestfs-actions.pod:5052 ../fish/guestfish-actions.pod:3398
14623 msgid "Possible values for C<parttype> are:"
14627 #: ../src/guestfs-actions.pod:5056 ../fish/guestfish-actions.pod:3402
14628 msgid "B<efi> | B<gpt>"
14632 #: ../src/guestfs-actions.pod:5058 ../fish/guestfish-actions.pod:3404
14633 msgid "Intel EFI / GPT partition table."
14637 #: ../src/guestfs-actions.pod:5060 ../fish/guestfish-actions.pod:3406
14639 "This is recommended for >= 2 TB partitions that will be accessed from Linux "
14640 "and Intel-based Mac OS X. It also has limited backwards compatibility with "
14641 "the C<mbr> format."
14645 #: ../src/guestfs-actions.pod:5064 ../fish/guestfish-actions.pod:3410
14646 msgid "B<mbr> | B<msdos>"
14650 #: ../src/guestfs-actions.pod:5066 ../fish/guestfish-actions.pod:3412
14652 "The standard PC \"Master Boot Record\" (MBR) format used by MS-DOS and "
14653 "Windows. This partition type will B<only> work for device sizes up to 2 "
14654 "TB. For large disks we recommend using C<gpt>."
14658 #: ../src/guestfs-actions.pod:5073 ../fish/guestfish-actions.pod:3419
14660 "Other partition table types that may work but are not supported include:"
14664 #: ../src/guestfs-actions.pod:5078 ../fish/guestfish-actions.pod:3424
14669 #: ../src/guestfs-actions.pod:5080 ../fish/guestfish-actions.pod:3426
14670 msgid "AIX disk labels."
14674 #: ../src/guestfs-actions.pod:5082 ../fish/guestfish-actions.pod:3428
14675 msgid "B<amiga> | B<rdb>"
14679 #: ../src/guestfs-actions.pod:5084 ../fish/guestfish-actions.pod:3430
14680 msgid "Amiga \"Rigid Disk Block\" format."
14684 #: ../src/guestfs-actions.pod:5086 ../fish/guestfish-actions.pod:3432
14689 #: ../src/guestfs-actions.pod:5088 ../fish/guestfish-actions.pod:3434
14690 msgid "BSD disk labels."
14694 #: ../src/guestfs-actions.pod:5090 ../fish/guestfish-actions.pod:3436
14699 #: ../src/guestfs-actions.pod:5092 ../fish/guestfish-actions.pod:3438
14700 msgid "DASD, used on IBM mainframes."
14704 #: ../src/guestfs-actions.pod:5094 ../fish/guestfish-actions.pod:3440
14709 #: ../src/guestfs-actions.pod:5096 ../fish/guestfish-actions.pod:3442
14710 msgid "MIPS/SGI volumes."
14714 #: ../src/guestfs-actions.pod:5098 ../fish/guestfish-actions.pod:3444
14719 #: ../src/guestfs-actions.pod:5100 ../fish/guestfish-actions.pod:3446
14720 msgid "Old Mac partition format. Modern Macs use C<gpt>."
14724 #: ../src/guestfs-actions.pod:5102 ../fish/guestfish-actions.pod:3448
14729 #: ../src/guestfs-actions.pod:5104 ../fish/guestfish-actions.pod:3450
14730 msgid "NEC PC-98 format, common in Japan apparently."
14734 #: ../src/guestfs-actions.pod:5106 ../fish/guestfish-actions.pod:3452
14739 #: ../src/guestfs-actions.pod:5108 ../fish/guestfish-actions.pod:3454
14740 msgid "Sun disk labels."
14744 #: ../src/guestfs-actions.pod:5116
14745 msgid "guestfs_part_list"
14749 #: ../src/guestfs-actions.pod:5118
14752 " struct guestfs_partition_list *\n"
14753 " guestfs_part_list (guestfs_h *g,\n"
14754 " const char *device);\n"
14759 #: ../src/guestfs-actions.pod:5122 ../fish/guestfish-actions.pod:3462
14761 "This command parses the partition table on C<device> and returns the list of "
14762 "partitions found."
14766 #: ../src/guestfs-actions.pod:5125 ../fish/guestfish-actions.pod:3465
14767 msgid "The fields in the returned structure are:"
14771 #: ../src/guestfs-actions.pod:5129 ../fish/guestfish-actions.pod:3469
14772 msgid "B<part_num>"
14776 #: ../src/guestfs-actions.pod:5131 ../fish/guestfish-actions.pod:3471
14777 msgid "Partition number, counting from 1."
14781 #: ../src/guestfs-actions.pod:5133 ../fish/guestfish-actions.pod:3473
14782 msgid "B<part_start>"
14786 #: ../src/guestfs-actions.pod:5135
14788 "Start of the partition I<in bytes>. To get sectors you have to divide by "
14789 "the device's sector size, see C<guestfs_blockdev_getss>."
14793 #: ../src/guestfs-actions.pod:5138 ../fish/guestfish-actions.pod:3478
14794 msgid "B<part_end>"
14798 #: ../src/guestfs-actions.pod:5140 ../fish/guestfish-actions.pod:3480
14799 msgid "End of the partition in bytes."
14803 #: ../src/guestfs-actions.pod:5142 ../fish/guestfish-actions.pod:3482
14804 msgid "B<part_size>"
14808 #: ../src/guestfs-actions.pod:5144 ../fish/guestfish-actions.pod:3484
14809 msgid "Size of the partition in bytes."
14813 #: ../src/guestfs-actions.pod:5148
14815 "This function returns a C<struct guestfs_partition_list *>, or NULL if there "
14816 "was an error. I<The caller must call C<guestfs_free_partition_list> after "
14821 #: ../src/guestfs-actions.pod:5154
14822 msgid "guestfs_part_set_bootable"
14826 #: ../src/guestfs-actions.pod:5156
14830 " guestfs_part_set_bootable (guestfs_h *g,\n"
14831 " const char *device,\n"
14833 " int bootable);\n"
14838 #: ../src/guestfs-actions.pod:5162 ../fish/guestfish-actions.pod:3492
14840 "This sets the bootable flag on partition numbered C<partnum> on device "
14841 "C<device>. Note that partitions are numbered from 1."
14845 #: ../src/guestfs-actions.pod:5165 ../fish/guestfish-actions.pod:3495
14847 "The bootable flag is used by some operating systems (notably Windows) to "
14848 "determine which partition to boot from. It is by no means universally "
14853 #: ../src/guestfs-actions.pod:5173
14854 msgid "guestfs_part_set_mbr_id"
14858 #: ../src/guestfs-actions.pod:5175
14862 " guestfs_part_set_mbr_id (guestfs_h *g,\n"
14863 " const char *device,\n"
14870 #: ../src/guestfs-actions.pod:5181 ../fish/guestfish-actions.pod:3503
14872 "Sets the MBR type byte (also known as the ID byte) of the numbered partition "
14873 "C<partnum> to C<idbyte>. Note that the type bytes quoted in most "
14874 "documentation are in fact hexadecimal numbers, but usually documented "
14875 "without any leading \"0x\" which might be confusing."
14879 #: ../src/guestfs-actions.pod:5195
14880 msgid "guestfs_part_set_name"
14884 #: ../src/guestfs-actions.pod:5197
14888 " guestfs_part_set_name (guestfs_h *g,\n"
14889 " const char *device,\n"
14891 " const char *name);\n"
14896 #: ../src/guestfs-actions.pod:5203 ../fish/guestfish-actions.pod:3517
14898 "This sets the partition name on partition numbered C<partnum> on device "
14899 "C<device>. Note that partitions are numbered from 1."
14903 #: ../src/guestfs-actions.pod:5206 ../fish/guestfish-actions.pod:3520
14905 "The partition name can only be set on certain types of partition table. "
14906 "This works on C<gpt> but not on C<mbr> partitions."
14910 #: ../src/guestfs-actions.pod:5213
14911 msgid "guestfs_part_to_dev"
14915 #: ../src/guestfs-actions.pod:5215
14919 " guestfs_part_to_dev (guestfs_h *g,\n"
14920 " const char *partition);\n"
14925 #: ../src/guestfs-actions.pod:5219 ../fish/guestfish-actions.pod:3527
14927 "This function takes a partition name (eg. \"/dev/sdb1\") and removes the "
14928 "partition number, returning the device name (eg. \"/dev/sdb\")."
14932 #: ../src/guestfs-actions.pod:5223
14934 "The named partition must exist, for example as a string returned from "
14935 "C<guestfs_list_partitions>."
14939 #: ../src/guestfs-actions.pod:5231
14940 msgid "guestfs_ping_daemon"
14944 #: ../src/guestfs-actions.pod:5233
14948 " guestfs_ping_daemon (guestfs_h *g);\n"
14953 #: ../src/guestfs-actions.pod:5236 ../fish/guestfish-actions.pod:3538
14955 "This is a test probe into the guestfs daemon running inside the qemu "
14956 "subprocess. Calling this function checks that the daemon responds to the "
14957 "ping message, without affecting the daemon or attached block device(s) in "
14962 #: ../src/guestfs-actions.pod:5245
14963 msgid "guestfs_pread"
14967 #: ../src/guestfs-actions.pod:5247
14971 " guestfs_pread (guestfs_h *g,\n"
14972 " const char *path,\n"
14974 " int64_t offset,\n"
14975 " size_t *size_r);\n"
14980 #: ../src/guestfs-actions.pod:5254 ../fish/guestfish-actions.pod:3547
14982 "This command lets you read part of a file. It reads C<count> bytes of the "
14983 "file, starting at C<offset>, from file C<path>."
14987 #: ../src/guestfs-actions.pod:5257 ../src/guestfs-actions.pod:5283
14988 #: ../fish/guestfish-actions.pod:3550 ../fish/guestfish-actions.pod:3565
14990 "This may read fewer bytes than requested. For further details see the "
14991 "L<pread(2)> system call."
14995 #: ../src/guestfs-actions.pod:5260
14996 msgid "See also C<guestfs_pwrite>, C<guestfs_pread_device>."
15000 #: ../src/guestfs-actions.pod:5271
15001 msgid "guestfs_pread_device"
15005 #: ../src/guestfs-actions.pod:5273
15009 " guestfs_pread_device (guestfs_h *g,\n"
15010 " const char *device,\n"
15012 " int64_t offset,\n"
15013 " size_t *size_r);\n"
15018 #: ../src/guestfs-actions.pod:5280 ../fish/guestfish-actions.pod:3562
15020 "This command lets you read part of a file. It reads C<count> bytes of "
15021 "C<device>, starting at C<offset>."
15025 #: ../src/guestfs-actions.pod:5286
15026 msgid "See also C<guestfs_pread>."
15030 #: ../src/guestfs-actions.pod:5295
15031 msgid "(Added in 1.5.21)"
15035 #: ../src/guestfs-actions.pod:5297
15036 msgid "guestfs_pvcreate"
15040 #: ../src/guestfs-actions.pod:5299
15044 " guestfs_pvcreate (guestfs_h *g,\n"
15045 " const char *device);\n"
15050 #: ../src/guestfs-actions.pod:5303 ../fish/guestfish-actions.pod:3577
15052 "This creates an LVM physical volume on the named C<device>, where C<device> "
15053 "should usually be a partition name such as C</dev/sda1>."
15057 #: ../src/guestfs-actions.pod:5311
15058 msgid "guestfs_pvremove"
15062 #: ../src/guestfs-actions.pod:5313
15066 " guestfs_pvremove (guestfs_h *g,\n"
15067 " const char *device);\n"
15072 #: ../src/guestfs-actions.pod:5317 ../fish/guestfish-actions.pod:3585
15074 "This wipes a physical volume C<device> so that LVM will no longer recognise "
15079 #: ../src/guestfs-actions.pod:5320 ../fish/guestfish-actions.pod:3588
15081 "The implementation uses the C<pvremove> command which refuses to wipe "
15082 "physical volumes that contain any volume groups, so you have to remove those "
15087 #: ../src/guestfs-actions.pod:5328
15088 msgid "guestfs_pvresize"
15092 #: ../src/guestfs-actions.pod:5330
15096 " guestfs_pvresize (guestfs_h *g,\n"
15097 " const char *device);\n"
15102 #: ../src/guestfs-actions.pod:5334 ../fish/guestfish-actions.pod:3596
15104 "This resizes (expands or shrinks) an existing LVM physical volume to match "
15105 "the new size of the underlying device."
15109 #: ../src/guestfs-actions.pod:5341
15110 msgid "guestfs_pvresize_size"
15114 #: ../src/guestfs-actions.pod:5343
15118 " guestfs_pvresize_size (guestfs_h *g,\n"
15119 " const char *device,\n"
15120 " int64_t size);\n"
15125 #: ../src/guestfs-actions.pod:5348
15127 "This command is the same as C<guestfs_pvresize> except that it allows you to "
15128 "specify the new size (in bytes) explicitly."
15132 #: ../src/guestfs-actions.pod:5355
15133 msgid "guestfs_pvs"
15137 #: ../src/guestfs-actions.pod:5357
15141 " guestfs_pvs (guestfs_h *g);\n"
15146 #: ../src/guestfs-actions.pod:5360 ../fish/guestfish-actions.pod:3610
15148 "List all the physical volumes detected. This is the equivalent of the L<pvs"
15153 #: ../src/guestfs-actions.pod:5363 ../fish/guestfish-actions.pod:3613
15155 "This returns a list of just the device names that contain PVs (eg. C</dev/"
15160 #: ../src/guestfs-actions.pod:5366
15161 msgid "See also C<guestfs_pvs_full>."
15165 #: ../src/guestfs-actions.pod:5374
15166 msgid "guestfs_pvs_full"
15170 #: ../src/guestfs-actions.pod:5376
15173 " struct guestfs_lvm_pv_list *\n"
15174 " guestfs_pvs_full (guestfs_h *g);\n"
15179 #: ../src/guestfs-actions.pod:5379 ../fish/guestfish-actions.pod:3622
15181 "List all the physical volumes detected. This is the equivalent of the L<pvs"
15182 "(8)> command. The \"full\" version includes all fields."
15186 #: ../src/guestfs-actions.pod:5382
15188 "This function returns a C<struct guestfs_lvm_pv_list *>, or NULL if there "
15189 "was an error. I<The caller must call C<guestfs_free_lvm_pv_list> after use>."
15193 #: ../src/guestfs-actions.pod:5388
15194 msgid "guestfs_pvuuid"
15198 #: ../src/guestfs-actions.pod:5390
15202 " guestfs_pvuuid (guestfs_h *g,\n"
15203 " const char *device);\n"
15208 #: ../src/guestfs-actions.pod:5394 ../fish/guestfish-actions.pod:3629
15209 msgid "This command returns the UUID of the LVM PV C<device>."
15213 #: ../src/guestfs-actions.pod:5401
15214 msgid "guestfs_pwrite"
15218 #: ../src/guestfs-actions.pod:5403
15222 " guestfs_pwrite (guestfs_h *g,\n"
15223 " const char *path,\n"
15224 " const char *content,\n"
15225 " size_t content_size,\n"
15226 " int64_t offset);\n"
15231 #: ../src/guestfs-actions.pod:5410 ../fish/guestfish-actions.pod:3635
15233 "This command writes to part of a file. It writes the data buffer C<content> "
15234 "to the file C<path> starting at offset C<offset>."
15238 #: ../src/guestfs-actions.pod:5413 ../fish/guestfish-actions.pod:3638
15240 "This command implements the L<pwrite(2)> system call, and like that system "
15241 "call it may not write the full data requested. The return value is the "
15242 "number of bytes that were actually written to the file. This could even be "
15243 "0, although short writes are unlikely for regular files in ordinary "
15248 #: ../src/guestfs-actions.pod:5419
15249 msgid "See also C<guestfs_pread>, C<guestfs_pwrite_device>."
15253 #: ../src/guestfs-actions.pod:5428
15254 msgid "guestfs_pwrite_device"
15258 #: ../src/guestfs-actions.pod:5430
15262 " guestfs_pwrite_device (guestfs_h *g,\n"
15263 " const char *device,\n"
15264 " const char *content,\n"
15265 " size_t content_size,\n"
15266 " int64_t offset);\n"
15271 #: ../src/guestfs-actions.pod:5437 ../fish/guestfish-actions.pod:3653
15273 "This command writes to part of a device. It writes the data buffer "
15274 "C<content> to C<device> starting at offset C<offset>."
15278 #: ../src/guestfs-actions.pod:5440 ../fish/guestfish-actions.pod:3656
15280 "This command implements the L<pwrite(2)> system call, and like that system "
15281 "call it may not write the full data requested (although short writes to disk "
15282 "devices and partitions are probably impossible with standard Linux kernels)."
15286 #: ../src/guestfs-actions.pod:5445
15287 msgid "See also C<guestfs_pwrite>."
15291 #: ../src/guestfs-actions.pod:5452
15292 msgid "(Added in 1.5.20)"
15296 #: ../src/guestfs-actions.pod:5454
15297 msgid "guestfs_read_file"
15301 #: ../src/guestfs-actions.pod:5456
15305 " guestfs_read_file (guestfs_h *g,\n"
15306 " const char *path,\n"
15307 " size_t *size_r);\n"
15312 #: ../src/guestfs-actions.pod:5461 ../fish/guestfish-actions.pod:3670
15313 msgid "This calls returns the contents of the file C<path> as a buffer."
15317 #: ../src/guestfs-actions.pod:5464
15319 "Unlike C<guestfs_cat>, this function can correctly handle files that contain "
15320 "embedded ASCII NUL characters. However unlike C<guestfs_download>, this "
15321 "function is limited in the total size of file that can be handled."
15325 #: ../src/guestfs-actions.pod:5476
15326 msgid "(Added in 1.0.63)"
15330 #: ../src/guestfs-actions.pod:5478
15331 msgid "guestfs_read_lines"
15335 #: ../src/guestfs-actions.pod:5480
15339 " guestfs_read_lines (guestfs_h *g,\n"
15340 " const char *path);\n"
15345 #: ../src/guestfs-actions.pod:5486 ../fish/guestfish-actions.pod:3687
15347 "The file contents are returned as a list of lines. Trailing C<LF> and "
15348 "C<CRLF> character sequences are I<not> returned."
15352 #: ../src/guestfs-actions.pod:5489
15354 "Note that this function cannot correctly handle binary files (specifically, "
15355 "files containing C<\\0> character which is treated as end of line). For "
15356 "those you need to use the C<guestfs_read_file> function which has a more "
15357 "complex interface."
15361 #: ../src/guestfs-actions.pod:5500
15362 msgid "guestfs_readdir"
15366 #: ../src/guestfs-actions.pod:5502
15369 " struct guestfs_dirent_list *\n"
15370 " guestfs_readdir (guestfs_h *g,\n"
15371 " const char *dir);\n"
15376 #: ../src/guestfs-actions.pod:5506 ../fish/guestfish-actions.pod:3699
15377 msgid "This returns the list of directory entries in directory C<dir>."
15381 #: ../src/guestfs-actions.pod:5508 ../fish/guestfish-actions.pod:3701
15383 "All entries in the directory are returned, including C<.> and C<..>. The "
15384 "entries are I<not> sorted, but returned in the same order as the underlying "
15389 #: ../src/guestfs-actions.pod:5512 ../fish/guestfish-actions.pod:3705
15391 "Also this call returns basic file type information about each file. The "
15392 "C<ftyp> field will contain one of the following characters:"
15396 #: ../src/guestfs-actions.pod:5517 ../fish/guestfish-actions.pod:3710
15401 #: ../src/guestfs-actions.pod:5519 ../fish/guestfish-actions.pod:3712
15402 msgid "Block special"
15406 #: ../src/guestfs-actions.pod:5521 ../fish/guestfish-actions.pod:3714
15411 #: ../src/guestfs-actions.pod:5523 ../fish/guestfish-actions.pod:3716
15412 msgid "Char special"
15416 #: ../src/guestfs-actions.pod:5525 ../fish/guestfish-actions.pod:3718
15421 #: ../src/guestfs-actions.pod:5527 ../fish/guestfish-actions.pod:3720
15426 #: ../src/guestfs-actions.pod:5529 ../fish/guestfish-actions.pod:3722
15431 #: ../src/guestfs-actions.pod:5531 ../fish/guestfish-actions.pod:3724
15432 msgid "FIFO (named pipe)"
15436 #: ../src/guestfs-actions.pod:5533 ../fish/guestfish-actions.pod:3726
15441 #: ../src/guestfs-actions.pod:5535 ../fish/guestfish-actions.pod:3728
15442 msgid "Symbolic link"
15446 #: ../src/guestfs-actions.pod:5537 ../fish/guestfish-actions.pod:3730
15451 #: ../src/guestfs-actions.pod:5539 ../fish/guestfish-actions.pod:3732
15452 msgid "Regular file"
15456 #: ../src/guestfs-actions.pod:5541 ../fish/guestfish-actions.pod:3734
15461 #: ../src/guestfs-actions.pod:5543 ../fish/guestfish-actions.pod:3736
15466 #: ../src/guestfs-actions.pod:5545 ../fish/guestfish-actions.pod:3738
15471 #: ../src/guestfs-actions.pod:5547 ../fish/guestfish-actions.pod:3740
15472 msgid "Unknown file type"
15476 #: ../src/guestfs-actions.pod:5549 ../fish/guestfish-actions.pod:3742
15481 #: ../src/guestfs-actions.pod:5551 ../fish/guestfish-actions.pod:3744
15483 "The L<readdir(3)> call returned a C<d_type> field with an unexpected value"
15487 #: ../src/guestfs-actions.pod:5556
15489 "This function is primarily intended for use by programs. To get a simple "
15490 "list of names, use C<guestfs_ls>. To get a printable directory for human "
15491 "consumption, use C<guestfs_ll>."
15495 #: ../src/guestfs-actions.pod:5560
15497 "This function returns a C<struct guestfs_dirent_list *>, or NULL if there "
15498 "was an error. I<The caller must call C<guestfs_free_dirent_list> after use>."
15502 #: ../src/guestfs-actions.pod:5566
15503 msgid "guestfs_readlink"
15507 #: ../src/guestfs-actions.pod:5568
15511 " guestfs_readlink (guestfs_h *g,\n"
15512 " const char *path);\n"
15517 #: ../src/guestfs-actions.pod:5572 ../fish/guestfish-actions.pod:3757
15518 msgid "This command reads the target of a symbolic link."
15522 #: ../src/guestfs-actions.pod:5579
15523 msgid "guestfs_readlinklist"
15527 #: ../src/guestfs-actions.pod:5581
15531 " guestfs_readlinklist (guestfs_h *g,\n"
15532 " const char *path,\n"
15533 " char *const *names);\n"
15538 #: ../src/guestfs-actions.pod:5586 ../fish/guestfish-actions.pod:3763
15540 "This call allows you to do a C<readlink> operation on multiple files, where "
15541 "all files are in the directory C<path>. C<names> is the list of files from "
15546 #: ../src/guestfs-actions.pod:5590 ../fish/guestfish-actions.pod:3767
15548 "On return you get a list of strings, with a one-to-one correspondence to the "
15549 "C<names> list. Each string is the value of the symbolic link."
15553 #: ../src/guestfs-actions.pod:5594 ../fish/guestfish-actions.pod:3771
15555 "If the C<readlink(2)> operation fails on any name, then the corresponding "
15556 "result string is the empty string C<\"\">. However the whole operation is "
15557 "completed even if there were C<readlink(2)> errors, and so you can call this "
15558 "function with names where you don't know if they are symbolic links already "
15559 "(albeit slightly less efficient)."
15563 #: ../src/guestfs-actions.pod:5601 ../fish/guestfish-actions.pod:3778
15565 "This call is intended for programs that want to efficiently list a directory "
15566 "contents without making many round-trips. Very long directory listings "
15567 "might cause the protocol message size to be exceeded, causing this call to "
15568 "fail. The caller must split up such requests into smaller groups of names."
15572 #: ../src/guestfs-actions.pod:5614
15573 msgid "guestfs_realpath"
15577 #: ../src/guestfs-actions.pod:5616
15581 " guestfs_realpath (guestfs_h *g,\n"
15582 " const char *path);\n"
15587 #: ../src/guestfs-actions.pod:5620 ../fish/guestfish-actions.pod:3789
15589 "Return the canonicalized absolute pathname of C<path>. The returned path "
15590 "has no C<.>, C<..> or symbolic link path elements."
15594 #: ../src/guestfs-actions.pod:5628
15595 msgid "guestfs_removexattr"
15599 #: ../src/guestfs-actions.pod:5630
15603 " guestfs_removexattr (guestfs_h *g,\n"
15604 " const char *xattr,\n"
15605 " const char *path);\n"
15610 #: ../src/guestfs-actions.pod:5635 ../fish/guestfish-actions.pod:3796
15612 "This call removes the extended attribute named C<xattr> of the file C<path>."
15616 #: ../src/guestfs-actions.pod:5638
15617 msgid "See also: C<guestfs_lremovexattr>, L<attr(5)>."
15621 #: ../src/guestfs-actions.pod:5644
15622 msgid "guestfs_resize2fs"
15626 #: ../src/guestfs-actions.pod:5646
15630 " guestfs_resize2fs (guestfs_h *g,\n"
15631 " const char *device);\n"
15636 #: ../src/guestfs-actions.pod:5650 ../fish/guestfish-actions.pod:3805
15638 "This resizes an ext2, ext3 or ext4 filesystem to match the size of the "
15639 "underlying device."
15643 #: ../src/guestfs-actions.pod:5653
15645 "I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f> on the "
15646 "C<device> before calling this command. For unknown reasons C<resize2fs> "
15647 "sometimes gives an error about this and sometimes not. In any case, it is "
15648 "always safe to call C<guestfs_e2fsck_f> before calling this function."
15652 #: ../src/guestfs-actions.pod:5663
15653 msgid "guestfs_resize2fs_M"
15657 #: ../src/guestfs-actions.pod:5665
15661 " guestfs_resize2fs_M (guestfs_h *g,\n"
15662 " const char *device);\n"
15667 #: ../src/guestfs-actions.pod:5669
15669 "This command is the same as C<guestfs_resize2fs>, but the filesystem is "
15670 "resized to its minimum size. This works like the I<-M> option to the "
15671 "C<resize2fs> command."
15675 #: ../src/guestfs-actions.pod:5673
15677 "To get the resulting size of the filesystem you should call "
15678 "C<guestfs_tune2fs_l> and read the C<Block size> and C<Block count> values. "
15679 "These two numbers, multiplied together, give the resulting size of the "
15680 "minimal filesystem in bytes."
15684 #: ../src/guestfs-actions.pod:5680
15685 msgid "guestfs_resize2fs_size"
15689 #: ../src/guestfs-actions.pod:5682
15693 " guestfs_resize2fs_size (guestfs_h *g,\n"
15694 " const char *device,\n"
15695 " int64_t size);\n"
15700 #: ../src/guestfs-actions.pod:5687
15702 "This command is the same as C<guestfs_resize2fs> except that it allows you "
15703 "to specify the new size (in bytes) explicitly."
15707 #: ../src/guestfs-actions.pod:5694
15712 #: ../src/guestfs-actions.pod:5696
15716 " guestfs_rm (guestfs_h *g,\n"
15717 " const char *path);\n"
15722 #: ../src/guestfs-actions.pod:5700 ../fish/guestfish-actions.pod:3838
15723 msgid "Remove the single file C<path>."
15727 #: ../src/guestfs-actions.pod:5706
15728 msgid "guestfs_rm_rf"
15732 #: ../src/guestfs-actions.pod:5708
15736 " guestfs_rm_rf (guestfs_h *g,\n"
15737 " const char *path);\n"
15742 #: ../src/guestfs-actions.pod:5712 ../fish/guestfish-actions.pod:3844
15744 "Remove the file or directory C<path>, recursively removing the contents if "
15745 "its a directory. This is like the C<rm -rf> shell command."
15749 #: ../src/guestfs-actions.pod:5720
15750 msgid "guestfs_rmdir"
15754 #: ../src/guestfs-actions.pod:5722
15758 " guestfs_rmdir (guestfs_h *g,\n"
15759 " const char *path);\n"
15764 #: ../src/guestfs-actions.pod:5726 ../fish/guestfish-actions.pod:3852
15765 msgid "Remove the single directory C<path>."
15769 #: ../src/guestfs-actions.pod:5732
15770 msgid "guestfs_rmmountpoint"
15774 #: ../src/guestfs-actions.pod:5734
15778 " guestfs_rmmountpoint (guestfs_h *g,\n"
15779 " const char *exemptpath);\n"
15784 #: ../src/guestfs-actions.pod:5738
15786 "This calls removes a mountpoint that was previously created with "
15787 "C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint> for full details."
15791 #: ../src/guestfs-actions.pod:5746
15792 msgid "guestfs_scrub_device"
15796 #: ../src/guestfs-actions.pod:5748
15800 " guestfs_scrub_device (guestfs_h *g,\n"
15801 " const char *device);\n"
15806 #: ../src/guestfs-actions.pod:5752 ../fish/guestfish-actions.pod:3866
15808 "This command writes patterns over C<device> to make data retrieval more "
15813 #: ../src/guestfs-actions.pod:5755 ../src/guestfs-actions.pod:5776
15814 #: ../src/guestfs-actions.pod:5795 ../fish/guestfish-actions.pod:3869
15815 #: ../fish/guestfish-actions.pod:3884 ../fish/guestfish-actions.pod:3897
15817 "It is an interface to the L<scrub(1)> program. See that manual page for "
15822 #: ../src/guestfs-actions.pod:5763 ../src/guestfs-actions.pod:5781
15823 #: ../src/guestfs-actions.pod:5800
15824 msgid "(Added in 1.0.52)"
15828 #: ../src/guestfs-actions.pod:5765
15829 msgid "guestfs_scrub_file"
15833 #: ../src/guestfs-actions.pod:5767
15837 " guestfs_scrub_file (guestfs_h *g,\n"
15838 " const char *file);\n"
15843 #: ../src/guestfs-actions.pod:5771 ../fish/guestfish-actions.pod:3879
15845 "This command writes patterns over a file to make data retrieval more "
15850 #: ../src/guestfs-actions.pod:5774 ../fish/guestfish-actions.pod:3882
15851 msgid "The file is I<removed> after scrubbing."
15855 #: ../src/guestfs-actions.pod:5783
15856 msgid "guestfs_scrub_freespace"
15860 #: ../src/guestfs-actions.pod:5785
15864 " guestfs_scrub_freespace (guestfs_h *g,\n"
15865 " const char *dir);\n"
15870 #: ../src/guestfs-actions.pod:5789
15872 "This command creates the directory C<dir> and then fills it with files until "
15873 "the filesystem is full, and scrubs the files as for C<guestfs_scrub_file>, "
15874 "and deletes them. The intention is to scrub any free space on the partition "
15875 "containing C<dir>."
15879 #: ../src/guestfs-actions.pod:5802
15880 msgid "guestfs_set_append"
15884 #: ../src/guestfs-actions.pod:5804
15888 " guestfs_set_append (guestfs_h *g,\n"
15889 " const char *append);\n"
15894 #: ../src/guestfs-actions.pod:5808 ../fish/guestfish-actions.pod:3906
15896 "This function is used to add additional options to the guest kernel command "
15901 #: ../src/guestfs-actions.pod:5811 ../fish/guestfish-actions.pod:3909
15903 "The default is C<NULL> unless overridden by setting C<LIBGUESTFS_APPEND> "
15904 "environment variable."
15908 #: ../src/guestfs-actions.pod:5814 ../fish/guestfish-actions.pod:3912
15910 "Setting C<append> to C<NULL> means I<no> additional options are passed "
15911 "(libguestfs always adds a few of its own)."
15915 #: ../src/guestfs-actions.pod:5821
15916 msgid "guestfs_set_attach_method"
15920 #: ../src/guestfs-actions.pod:5823
15924 " guestfs_set_attach_method (guestfs_h *g,\n"
15925 " const char *attachmethod);\n"
15930 #: ../src/guestfs-actions.pod:5827 ../fish/guestfish-actions.pod:3921
15932 "Set the method that libguestfs uses to connect to the back end guestfsd "
15933 "daemon. Possible methods are:"
15937 #: ../src/guestfs-actions.pod:5834 ../fish/guestfish-actions.pod:3928
15939 "Launch an appliance and connect to it. This is the ordinary method and the "
15944 #: ../src/guestfs-actions.pod:5837 ../fish/guestfish-actions.pod:3931
15945 msgid "C<unix:I<path>>"
15949 #: ../src/guestfs-actions.pod:5839 ../fish/guestfish-actions.pod:3933
15950 msgid "Connect to the Unix domain socket I<path>."
15954 #: ../src/guestfs-actions.pod:5841 ../fish/guestfish-actions.pod:3935
15956 "This method lets you connect to an existing daemon or (using virtio-serial) "
15957 "to a live guest. For more information, see L<guestfs(3)/ATTACHING TO "
15958 "RUNNING DAEMONS>."
15962 #: ../src/guestfs-actions.pod:5849
15963 msgid "guestfs_set_autosync"
15967 #: ../src/guestfs-actions.pod:5851
15971 " guestfs_set_autosync (guestfs_h *g,\n"
15972 " int autosync);\n"
15977 #: ../src/guestfs-actions.pod:5855 ../fish/guestfish-actions.pod:3947
15979 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
15980 "effort attempt to make filesystems consistent and synchronized when the "
15981 "handle is closed (also if the program exits without closing handles)."
15985 #: ../src/guestfs-actions.pod:5860 ../fish/guestfish-actions.pod:3952
15987 "This is enabled by default (since libguestfs 1.5.24, previously it was "
15988 "disabled by default)."
15992 #: ../src/guestfs-actions.pod:5867
15993 msgid "guestfs_set_direct"
15997 #: ../src/guestfs-actions.pod:5869
16001 " guestfs_set_direct (guestfs_h *g,\n"
16007 #: ../src/guestfs-actions.pod:5873 ../fish/guestfish-actions.pod:3961
16009 "If the direct appliance mode flag is enabled, then stdin and stdout are "
16010 "passed directly through to the appliance once it is launched."
16014 #: ../src/guestfs-actions.pod:5877
16016 "One consequence of this is that log messages aren't caught by the library "
16017 "and handled by C<guestfs_set_log_message_callback>, but go straight to "
16022 #: ../src/guestfs-actions.pod:5881 ../fish/guestfish-actions.pod:3969
16023 msgid "You probably don't want to use this unless you know what you are doing."
16027 #: ../src/guestfs-actions.pod:5884 ../fish/guestfish-actions.pod:3972
16028 msgid "The default is disabled."
16032 #: ../src/guestfs-actions.pod:5890
16033 msgid "guestfs_set_e2label"
16037 #: ../src/guestfs-actions.pod:5892
16041 " guestfs_set_e2label (guestfs_h *g,\n"
16042 " const char *device,\n"
16043 " const char *label);\n"
16048 #: ../src/guestfs-actions.pod:5897 ../fish/guestfish-actions.pod:3978
16050 "This sets the ext2/3/4 filesystem label of the filesystem on C<device> to "
16051 "C<label>. Filesystem labels are limited to 16 characters."
16055 #: ../src/guestfs-actions.pod:5901
16057 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label> to return "
16058 "the existing label on a filesystem."
16062 #: ../src/guestfs-actions.pod:5908
16063 msgid "guestfs_set_e2uuid"
16067 #: ../src/guestfs-actions.pod:5910
16071 " guestfs_set_e2uuid (guestfs_h *g,\n"
16072 " const char *device,\n"
16073 " const char *uuid);\n"
16078 #: ../src/guestfs-actions.pod:5915 ../fish/guestfish-actions.pod:3989
16080 "This sets the ext2/3/4 filesystem UUID of the filesystem on C<device> to "
16081 "C<uuid>. The format of the UUID and alternatives such as C<clear>, "
16082 "C<random> and C<time> are described in the L<tune2fs(8)> manpage."
16086 #: ../src/guestfs-actions.pod:5920
16088 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid> to return "
16089 "the existing UUID of a filesystem."
16093 #: ../src/guestfs-actions.pod:5927
16094 msgid "guestfs_set_memsize"
16098 #: ../src/guestfs-actions.pod:5929
16102 " guestfs_set_memsize (guestfs_h *g,\n"
16108 #: ../src/guestfs-actions.pod:5933
16110 "This sets the memory size in megabytes allocated to the qemu subprocess. "
16111 "This only has any effect if called before C<guestfs_launch>."
16115 #: ../src/guestfs-actions.pod:5937 ../fish/guestfish-actions.pod:4007
16117 "You can also change this by setting the environment variable "
16118 "C<LIBGUESTFS_MEMSIZE> before the handle is created."
16122 #: ../src/guestfs-actions.pod:5948
16123 msgid "guestfs_set_network"
16127 #: ../src/guestfs-actions.pod:5950
16131 " guestfs_set_network (guestfs_h *g,\n"
16137 #: ../src/guestfs-actions.pod:5954 ../fish/guestfish-actions.pod:4020
16139 "If C<network> is true, then the network is enabled in the libguestfs "
16140 "appliance. The default is false."
16144 #: ../src/guestfs-actions.pod:5957 ../fish/guestfish-actions.pod:4023
16146 "This affects whether commands are able to access the network (see L<guestfs"
16147 "(3)/RUNNING COMMANDS>)."
16151 #: ../src/guestfs-actions.pod:5960
16153 "You must call this before calling C<guestfs_launch>, otherwise it has no "
16158 #: ../src/guestfs-actions.pod:5967
16159 msgid "guestfs_set_path"
16163 #: ../src/guestfs-actions.pod:5969
16167 " guestfs_set_path (guestfs_h *g,\n"
16168 " const char *searchpath);\n"
16173 #: ../src/guestfs-actions.pod:5973 ../fish/guestfish-actions.pod:4035
16174 msgid "Set the path that libguestfs searches for kernel and initrd.img."
16178 #: ../src/guestfs-actions.pod:5975 ../fish/guestfish-actions.pod:4037
16180 "The default is C<$libdir/guestfs> unless overridden by setting "
16181 "C<LIBGUESTFS_PATH> environment variable."
16185 #: ../src/guestfs-actions.pod:5978 ../fish/guestfish-actions.pod:4040
16186 msgid "Setting C<path> to C<NULL> restores the default path."
16190 #: ../src/guestfs-actions.pod:5984
16191 msgid "guestfs_set_qemu"
16195 #: ../src/guestfs-actions.pod:5986
16199 " guestfs_set_qemu (guestfs_h *g,\n"
16200 " const char *qemu);\n"
16205 #: ../src/guestfs-actions.pod:5990 ../fish/guestfish-actions.pod:4048
16206 msgid "Set the qemu binary that we will use."
16210 #: ../src/guestfs-actions.pod:5992 ../fish/guestfish-actions.pod:4050
16212 "The default is chosen when the library was compiled by the configure script."
16216 #: ../src/guestfs-actions.pod:5995 ../fish/guestfish-actions.pod:4053
16218 "You can also override this by setting the C<LIBGUESTFS_QEMU> environment "
16223 #: ../src/guestfs-actions.pod:5998 ../fish/guestfish-actions.pod:4056
16224 msgid "Setting C<qemu> to C<NULL> restores the default qemu binary."
16228 #: ../src/guestfs-actions.pod:6000 ../fish/guestfish-actions.pod:4058
16230 "Note that you should call this function as early as possible after creating "
16231 "the handle. This is because some pre-launch operations depend on testing "
16232 "qemu features (by running C<qemu -help>). If the qemu binary changes, we "
16233 "don't retest features, and so you might see inconsistent results. Using the "
16234 "environment variable C<LIBGUESTFS_QEMU> is safest of all since that picks "
16235 "the qemu binary at the same time as the handle is created."
16239 #: ../src/guestfs-actions.pod:6012
16240 msgid "guestfs_set_recovery_proc"
16244 #: ../src/guestfs-actions.pod:6014
16248 " guestfs_set_recovery_proc (guestfs_h *g,\n"
16249 " int recoveryproc);\n"
16254 #: ../src/guestfs-actions.pod:6018
16256 "If this is called with the parameter C<false> then C<guestfs_launch> does "
16257 "not create a recovery process. The purpose of the recovery process is to "
16258 "stop runaway qemu processes in the case where the main program aborts "
16263 #: ../src/guestfs-actions.pod:6023
16265 "This only has any effect if called before C<guestfs_launch>, and the default "
16270 #: ../src/guestfs-actions.pod:6026 ../fish/guestfish-actions.pod:4080
16272 "About the only time when you would want to disable this is if the main "
16273 "process will fork itself into the background (\"daemonize\" itself). In "
16274 "this case the recovery process thinks that the main program has disappeared "
16275 "and so kills qemu, which is not very helpful."
16279 #: ../src/guestfs-actions.pod:6036
16280 msgid "guestfs_set_selinux"
16284 #: ../src/guestfs-actions.pod:6038
16288 " guestfs_set_selinux (guestfs_h *g,\n"
16294 #: ../src/guestfs-actions.pod:6042 ../fish/guestfish-actions.pod:4092
16296 "This sets the selinux flag that is passed to the appliance at boot time. "
16297 "The default is C<selinux=0> (disabled)."
16301 #: ../src/guestfs-actions.pod:6045 ../fish/guestfish-actions.pod:4095
16303 "Note that if SELinux is enabled, it is always in Permissive mode "
16304 "(C<enforcing=0>)."
16308 #: ../src/guestfs-actions.pod:6055
16309 msgid "guestfs_set_trace"
16313 #: ../src/guestfs-actions.pod:6057
16317 " guestfs_set_trace (guestfs_h *g,\n"
16323 #: ../src/guestfs-actions.pod:6061 ../fish/guestfish-actions.pod:4107
16325 "If the command trace flag is set to 1, then libguestfs calls, parameters and "
16326 "return values are traced."
16330 #: ../src/guestfs-actions.pod:6064 ../fish/guestfish-actions.pod:4110
16332 "If you want to trace C API calls into libguestfs (and other libraries) then "
16333 "possibly a better way is to use the external ltrace(1) command."
16337 #: ../src/guestfs-actions.pod:6068 ../fish/guestfish-actions.pod:4114
16339 "Command traces are disabled unless the environment variable "
16340 "C<LIBGUESTFS_TRACE> is defined and set to C<1>."
16344 #: ../src/guestfs-actions.pod:6071
16346 "Trace messages are normally sent to C<stderr>, unless you register a "
16347 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
16351 #: ../src/guestfs-actions.pod:6079
16352 msgid "guestfs_set_verbose"
16356 #: ../src/guestfs-actions.pod:6081
16360 " guestfs_set_verbose (guestfs_h *g,\n"
16366 #: ../src/guestfs-actions.pod:6085 ../fish/guestfish-actions.pod:4127
16367 msgid "If C<verbose> is true, this turns on verbose messages."
16371 #: ../src/guestfs-actions.pod:6087 ../fish/guestfish-actions.pod:4129
16373 "Verbose messages are disabled unless the environment variable "
16374 "C<LIBGUESTFS_DEBUG> is defined and set to C<1>."
16378 #: ../src/guestfs-actions.pod:6090
16380 "Verbose messages are normally sent to C<stderr>, unless you register a "
16381 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
16385 #: ../src/guestfs-actions.pod:6098
16386 msgid "guestfs_setcon"
16390 #: ../src/guestfs-actions.pod:6100
16394 " guestfs_setcon (guestfs_h *g,\n"
16395 " const char *context);\n"
16400 #: ../src/guestfs-actions.pod:6104 ../fish/guestfish-actions.pod:4140
16402 "This sets the SELinux security context of the daemon to the string "
16407 #: ../src/guestfs-actions.pod:6107 ../fish/guestfish-actions.pod:4143
16408 msgid "See the documentation about SELINUX in L<guestfs(3)>."
16412 #: ../src/guestfs-actions.pod:6113
16413 msgid "guestfs_setxattr"
16417 #: ../src/guestfs-actions.pod:6115
16421 " guestfs_setxattr (guestfs_h *g,\n"
16422 " const char *xattr,\n"
16423 " const char *val,\n"
16425 " const char *path);\n"
16430 #: ../src/guestfs-actions.pod:6122 ../fish/guestfish-actions.pod:4149
16432 "This call sets the extended attribute named C<xattr> of the file C<path> to "
16433 "the value C<val> (of length C<vallen>). The value is arbitrary 8 bit data."
16437 #: ../src/guestfs-actions.pod:6126
16438 msgid "See also: C<guestfs_lsetxattr>, L<attr(5)>."
16442 #: ../src/guestfs-actions.pod:6132
16443 msgid "guestfs_sfdisk"
16447 #: ../src/guestfs-actions.pod:6134
16451 " guestfs_sfdisk (guestfs_h *g,\n"
16452 " const char *device,\n"
16456 " char *const *lines);\n"
16461 #: ../src/guestfs-actions.pod:6142 ../fish/guestfish-actions.pod:4159
16463 "This is a direct interface to the L<sfdisk(8)> program for creating "
16464 "partitions on block devices."
16468 #: ../src/guestfs-actions.pod:6145 ../fish/guestfish-actions.pod:4162
16469 msgid "C<device> should be a block device, for example C</dev/sda>."
16473 #: ../src/guestfs-actions.pod:6147 ../fish/guestfish-actions.pod:4164
16475 "C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads and "
16476 "sectors on the device, which are passed directly to sfdisk as the I<-C>, I<-"
16477 "H> and I<-S> parameters. If you pass C<0> for any of these, then the "
16478 "corresponding parameter is omitted. Usually for 'large' disks, you can just "
16479 "pass C<0> for these, but for small (floppy-sized) disks, sfdisk (or rather, "
16480 "the kernel) cannot work out the right geometry and you will need to tell it."
16484 #: ../src/guestfs-actions.pod:6155 ../fish/guestfish-actions.pod:4172
16486 "C<lines> is a list of lines that we feed to C<sfdisk>. For more information "
16487 "refer to the L<sfdisk(8)> manpage."
16491 #: ../src/guestfs-actions.pod:6158 ../fish/guestfish-actions.pod:4175
16493 "To create a single partition occupying the whole disk, you would pass "
16494 "C<lines> as a single element list, when the single element being the string "
16499 #: ../src/guestfs-actions.pod:6162
16501 "See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>, C<guestfs_part_init>"
16505 #: ../src/guestfs-actions.pod:6170 ../src/guestfs-actions.pod:6200
16506 #: ../src/guestfs-actions.pod:6233
16508 "This function is deprecated. In new code, use the L</guestfs_part_add> call "
16513 #: ../src/guestfs-actions.pod:6179
16514 msgid "guestfs_sfdiskM"
16518 #: ../src/guestfs-actions.pod:6181
16522 " guestfs_sfdiskM (guestfs_h *g,\n"
16523 " const char *device,\n"
16524 " char *const *lines);\n"
16529 #: ../src/guestfs-actions.pod:6186
16531 "This is a simplified interface to the C<guestfs_sfdisk> command, where "
16532 "partition sizes are specified in megabytes only (rounded to the nearest "
16533 "cylinder) and you don't need to specify the cyls, heads and sectors "
16534 "parameters which were rarely if ever used anyway."
16538 #: ../src/guestfs-actions.pod:6192
16540 "See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage and "
16541 "C<guestfs_part_disk>"
16545 #: ../src/guestfs-actions.pod:6209
16546 msgid "guestfs_sfdisk_N"
16550 #: ../src/guestfs-actions.pod:6211
16554 " guestfs_sfdisk_N (guestfs_h *g,\n"
16555 " const char *device,\n"
16560 " const char *line);\n"
16565 #: ../src/guestfs-actions.pod:6220 ../fish/guestfish-actions.pod:4219
16567 "This runs L<sfdisk(8)> option to modify just the single partition C<n> "
16568 "(note: C<n> counts from 1)."
16572 #: ../src/guestfs-actions.pod:6223
16574 "For other parameters, see C<guestfs_sfdisk>. You should usually pass C<0> "
16575 "for the cyls/heads/sectors parameters."
16579 #: ../src/guestfs-actions.pod:6226
16580 msgid "See also: C<guestfs_part_add>"
16584 #: ../src/guestfs-actions.pod:6242
16585 msgid "guestfs_sfdisk_disk_geometry"
16589 #: ../src/guestfs-actions.pod:6244
16593 " guestfs_sfdisk_disk_geometry (guestfs_h *g,\n"
16594 " const char *device);\n"
16599 #: ../src/guestfs-actions.pod:6248
16601 "This displays the disk geometry of C<device> read from the partition table. "
16602 "Especially in the case where the underlying block device has been resized, "
16603 "this can be different from the kernel's idea of the geometry (see "
16604 "C<guestfs_sfdisk_kernel_geometry>)."
16608 #: ../src/guestfs-actions.pod:6253 ../src/guestfs-actions.pod:6269
16609 #: ../fish/guestfish-actions.pod:4246 ../fish/guestfish-actions.pod:4255
16610 msgid "The result is in human-readable format, and not designed to be parsed."
16614 #: ../src/guestfs-actions.pod:6261
16615 msgid "guestfs_sfdisk_kernel_geometry"
16619 #: ../src/guestfs-actions.pod:6263
16623 " guestfs_sfdisk_kernel_geometry (guestfs_h *g,\n"
16624 " const char *device);\n"
16629 #: ../src/guestfs-actions.pod:6267 ../fish/guestfish-actions.pod:4253
16630 msgid "This displays the kernel's idea of the geometry of C<device>."
16634 #: ../src/guestfs-actions.pod:6277
16635 msgid "guestfs_sfdisk_l"
16639 #: ../src/guestfs-actions.pod:6279
16643 " guestfs_sfdisk_l (guestfs_h *g,\n"
16644 " const char *device);\n"
16649 #: ../src/guestfs-actions.pod:6283 ../fish/guestfish-actions.pod:4262
16651 "This displays the partition table on C<device>, in the human-readable output "
16652 "of the L<sfdisk(8)> command. It is not intended to be parsed."
16656 #: ../src/guestfs-actions.pod:6287
16657 msgid "See also: C<guestfs_part_list>"
16661 #: ../src/guestfs-actions.pod:6292
16663 "This function is deprecated. In new code, use the L</guestfs_part_list> "
16668 #: ../src/guestfs-actions.pod:6301
16673 #: ../src/guestfs-actions.pod:6303
16677 " guestfs_sh (guestfs_h *g,\n"
16678 " const char *command);\n"
16683 #: ../src/guestfs-actions.pod:6307 ../fish/guestfish-actions.pod:4279
16685 "This call runs a command from the guest filesystem via the guest's C</bin/"
16690 #: ../src/guestfs-actions.pod:6310
16691 msgid "This is like C<guestfs_command>, but passes the command to:"
16695 #: ../src/guestfs-actions.pod:6312 ../fish/guestfish-actions.pod:4284
16698 " /bin/sh -c \"command\"\n"
16703 #: ../src/guestfs-actions.pod:6314 ../fish/guestfish-actions.pod:4286
16705 "Depending on the guest's shell, this usually results in wildcards being "
16706 "expanded, shell expressions being interpolated and so on."
16710 #: ../src/guestfs-actions.pod:6318
16711 msgid "All the provisos about C<guestfs_command> apply to this call."
16715 #: ../src/guestfs-actions.pod:6325
16716 msgid "guestfs_sh_lines"
16720 #: ../src/guestfs-actions.pod:6327
16724 " guestfs_sh_lines (guestfs_h *g,\n"
16725 " const char *command);\n"
16730 #: ../src/guestfs-actions.pod:6331
16732 "This is the same as C<guestfs_sh>, but splits the result into a list of "
16737 #: ../src/guestfs-actions.pod:6334
16738 msgid "See also: C<guestfs_command_lines>"
16742 #: ../src/guestfs-actions.pod:6342
16743 msgid "guestfs_sleep"
16747 #: ../src/guestfs-actions.pod:6344
16751 " guestfs_sleep (guestfs_h *g,\n"
16757 #: ../src/guestfs-actions.pod:6348 ../fish/guestfish-actions.pod:4305
16758 msgid "Sleep for C<secs> seconds."
16762 #: ../src/guestfs-actions.pod:6352
16763 msgid "(Added in 1.0.41)"
16767 #: ../src/guestfs-actions.pod:6354 ../src/guestfs-structs.pod:109
16768 msgid "guestfs_stat"
16772 #: ../src/guestfs-actions.pod:6356
16775 " struct guestfs_stat *\n"
16776 " guestfs_stat (guestfs_h *g,\n"
16777 " const char *path);\n"
16782 #: ../src/guestfs-actions.pod:6362 ../fish/guestfish-actions.pod:4313
16783 msgid "This is the same as the C<stat(2)> system call."
16787 #: ../src/guestfs-actions.pod:6370 ../src/guestfs-structs.pod:135
16788 msgid "guestfs_statvfs"
16792 #: ../src/guestfs-actions.pod:6372
16795 " struct guestfs_statvfs *\n"
16796 " guestfs_statvfs (guestfs_h *g,\n"
16797 " const char *path);\n"
16802 #: ../src/guestfs-actions.pod:6376 ../fish/guestfish-actions.pod:4319
16804 "Returns file system statistics for any mounted file system. C<path> should "
16805 "be a file or directory in the mounted file system (typically it is the mount "
16806 "point itself, but it doesn't need to be)."
16810 #: ../src/guestfs-actions.pod:6380 ../fish/guestfish-actions.pod:4323
16811 msgid "This is the same as the C<statvfs(2)> system call."
16815 #: ../src/guestfs-actions.pod:6382
16817 "This function returns a C<struct guestfs_statvfs *>, or NULL if there was an "
16818 "error. I<The caller must call C<guestfs_free_statvfs> after use>."
16822 #: ../src/guestfs-actions.pod:6388
16823 msgid "guestfs_strings"
16827 #: ../src/guestfs-actions.pod:6390
16831 " guestfs_strings (guestfs_h *g,\n"
16832 " const char *path);\n"
16837 #: ../src/guestfs-actions.pod:6394 ../fish/guestfish-actions.pod:4329
16839 "This runs the L<strings(1)> command on a file and returns the list of "
16840 "printable strings found."
16844 #: ../src/guestfs-actions.pod:6406
16845 msgid "guestfs_strings_e"
16849 #: ../src/guestfs-actions.pod:6408
16853 " guestfs_strings_e (guestfs_h *g,\n"
16854 " const char *encoding,\n"
16855 " const char *path);\n"
16860 #: ../src/guestfs-actions.pod:6413
16862 "This is like the C<guestfs_strings> command, but allows you to specify the "
16863 "encoding of strings that are looked for in the source file C<path>."
16867 #: ../src/guestfs-actions.pod:6417 ../fish/guestfish-actions.pod:4343
16868 msgid "Allowed encodings are:"
16872 #: ../src/guestfs-actions.pod:6421 ../fish/guestfish-actions.pod:4347
16877 #: ../src/guestfs-actions.pod:6423
16879 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
16880 "ISO-8859-X (this is what C<guestfs_strings> uses)."
16884 #: ../src/guestfs-actions.pod:6426 ../fish/guestfish-actions.pod:4352
16889 #: ../src/guestfs-actions.pod:6428 ../fish/guestfish-actions.pod:4354
16890 msgid "Single 8-bit-byte characters."
16894 #: ../src/guestfs-actions.pod:6430 ../fish/guestfish-actions.pod:4356
16899 #: ../src/guestfs-actions.pod:6432 ../fish/guestfish-actions.pod:4358
16900 msgid "16-bit big endian strings such as those encoded in UTF-16BE or UCS-2BE."
16904 #: ../src/guestfs-actions.pod:6435 ../fish/guestfish-actions.pod:4361
16905 msgid "l (lower case letter L)"
16909 #: ../src/guestfs-actions.pod:6437 ../fish/guestfish-actions.pod:4363
16911 "16-bit little endian such as UTF-16LE and UCS-2LE. This is useful for "
16912 "examining binaries in Windows guests."
16916 #: ../src/guestfs-actions.pod:6440 ../fish/guestfish-actions.pod:4366
16921 #: ../src/guestfs-actions.pod:6442 ../fish/guestfish-actions.pod:4368
16922 msgid "32-bit big endian such as UCS-4BE."
16926 #: ../src/guestfs-actions.pod:6444 ../fish/guestfish-actions.pod:4370
16931 #: ../src/guestfs-actions.pod:6446 ../fish/guestfish-actions.pod:4372
16932 msgid "32-bit little endian such as UCS-4LE."
16936 #: ../src/guestfs-actions.pod:6450 ../fish/guestfish-actions.pod:4376
16937 msgid "The returned strings are transcoded to UTF-8."
16941 #: ../src/guestfs-actions.pod:6461
16942 msgid "guestfs_swapoff_device"
16946 #: ../src/guestfs-actions.pod:6463
16950 " guestfs_swapoff_device (guestfs_h *g,\n"
16951 " const char *device);\n"
16956 #: ../src/guestfs-actions.pod:6467
16958 "This command disables the libguestfs appliance swap device or partition "
16959 "named C<device>. See C<guestfs_swapon_device>."
16963 #: ../src/guestfs-actions.pod:6475
16964 msgid "guestfs_swapoff_file"
16968 #: ../src/guestfs-actions.pod:6477
16972 " guestfs_swapoff_file (guestfs_h *g,\n"
16973 " const char *file);\n"
16978 #: ../src/guestfs-actions.pod:6481 ../fish/guestfish-actions.pod:4393
16979 msgid "This command disables the libguestfs appliance swap on file."
16983 #: ../src/guestfs-actions.pod:6487
16984 msgid "guestfs_swapoff_label"
16988 #: ../src/guestfs-actions.pod:6489
16992 " guestfs_swapoff_label (guestfs_h *g,\n"
16993 " const char *label);\n"
16998 #: ../src/guestfs-actions.pod:6493 ../fish/guestfish-actions.pod:4399
17000 "This command disables the libguestfs appliance swap on labeled swap "
17005 #: ../src/guestfs-actions.pod:6500
17006 msgid "guestfs_swapoff_uuid"
17010 #: ../src/guestfs-actions.pod:6502
17014 " guestfs_swapoff_uuid (guestfs_h *g,\n"
17015 " const char *uuid);\n"
17020 #: ../src/guestfs-actions.pod:6506 ../fish/guestfish-actions.pod:4406
17022 "This command disables the libguestfs appliance swap partition with the given "
17027 #: ../src/guestfs-actions.pod:6513
17028 msgid "guestfs_swapon_device"
17032 #: ../src/guestfs-actions.pod:6515
17036 " guestfs_swapon_device (guestfs_h *g,\n"
17037 " const char *device);\n"
17042 #: ../src/guestfs-actions.pod:6519
17044 "This command enables the libguestfs appliance to use the swap device or "
17045 "partition named C<device>. The increased memory is made available for all "
17046 "commands, for example those run using C<guestfs_command> or C<guestfs_sh>."
17050 #: ../src/guestfs-actions.pod:6524 ../fish/guestfish-actions.pod:4418
17052 "Note that you should not swap to existing guest swap partitions unless you "
17053 "know what you are doing. They may contain hibernation information, or other "
17054 "information that the guest doesn't want you to trash. You also risk leaking "
17055 "information about the host to the guest this way. Instead, attach a new "
17056 "host device to the guest and swap on that."
17060 #: ../src/guestfs-actions.pod:6535
17061 msgid "guestfs_swapon_file"
17065 #: ../src/guestfs-actions.pod:6537
17069 " guestfs_swapon_file (guestfs_h *g,\n"
17070 " const char *file);\n"
17075 #: ../src/guestfs-actions.pod:6541
17077 "This command enables swap to a file. See C<guestfs_swapon_device> for other "
17082 #: ../src/guestfs-actions.pod:6548
17083 msgid "guestfs_swapon_label"
17087 #: ../src/guestfs-actions.pod:6550
17091 " guestfs_swapon_label (guestfs_h *g,\n"
17092 " const char *label);\n"
17097 #: ../src/guestfs-actions.pod:6554
17099 "This command enables swap to a labeled swap partition. See "
17100 "C<guestfs_swapon_device> for other notes."
17104 #: ../src/guestfs-actions.pod:6561
17105 msgid "guestfs_swapon_uuid"
17109 #: ../src/guestfs-actions.pod:6563
17113 " guestfs_swapon_uuid (guestfs_h *g,\n"
17114 " const char *uuid);\n"
17119 #: ../src/guestfs-actions.pod:6567
17121 "This command enables swap to a swap partition with the given UUID. See "
17122 "C<guestfs_swapon_device> for other notes."
17126 #: ../src/guestfs-actions.pod:6574
17127 msgid "guestfs_sync"
17131 #: ../src/guestfs-actions.pod:6576
17135 " guestfs_sync (guestfs_h *g);\n"
17140 #: ../src/guestfs-actions.pod:6579 ../fish/guestfish-actions.pod:4450
17142 "This syncs the disk, so that any writes are flushed through to the "
17143 "underlying disk image."
17147 #: ../src/guestfs-actions.pod:6582 ../fish/guestfish-actions.pod:4453
17149 "You should always call this if you have modified a disk image, before "
17150 "closing the handle."
17154 #: ../src/guestfs-actions.pod:6589
17155 msgid "guestfs_tail"
17159 #: ../src/guestfs-actions.pod:6591
17163 " guestfs_tail (guestfs_h *g,\n"
17164 " const char *path);\n"
17169 #: ../src/guestfs-actions.pod:6595 ../fish/guestfish-actions.pod:4460
17171 "This command returns up to the last 10 lines of a file as a list of strings."
17175 #: ../src/guestfs-actions.pod:6607
17176 msgid "guestfs_tail_n"
17180 #: ../src/guestfs-actions.pod:6609
17184 " guestfs_tail_n (guestfs_h *g,\n"
17186 " const char *path);\n"
17191 #: ../src/guestfs-actions.pod:6614 ../fish/guestfish-actions.pod:4470
17193 "If the parameter C<nrlines> is a positive number, this returns the last "
17194 "C<nrlines> lines of the file C<path>."
17198 #: ../src/guestfs-actions.pod:6617 ../fish/guestfish-actions.pod:4473
17200 "If the parameter C<nrlines> is a negative number, this returns lines from "
17201 "the file C<path>, starting with the C<-nrlines>th line."
17205 #: ../src/guestfs-actions.pod:6631
17206 msgid "guestfs_tar_in"
17210 #: ../src/guestfs-actions.pod:6633
17214 " guestfs_tar_in (guestfs_h *g,\n"
17215 " const char *tarfile,\n"
17216 " const char *directory);\n"
17221 #: ../src/guestfs-actions.pod:6638 ../fish/guestfish-actions.pod:4485
17223 "This command uploads and unpacks local file C<tarfile> (an I<uncompressed> "
17224 "tar file) into C<directory>."
17228 #: ../src/guestfs-actions.pod:6641
17230 "To upload a compressed tarball, use C<guestfs_tgz_in> or C<guestfs_txz_in>."
17234 #: ../src/guestfs-actions.pod:6646 ../src/guestfs-actions.pod:6663
17235 #: ../src/guestfs-actions.pod:6679 ../src/guestfs-actions.pod:6695
17236 msgid "(Added in 1.0.3)"
17240 #: ../src/guestfs-actions.pod:6648
17241 msgid "guestfs_tar_out"
17245 #: ../src/guestfs-actions.pod:6650
17249 " guestfs_tar_out (guestfs_h *g,\n"
17250 " const char *directory,\n"
17251 " const char *tarfile);\n"
17256 #: ../src/guestfs-actions.pod:6655 ../fish/guestfish-actions.pod:4497
17258 "This command packs the contents of C<directory> and downloads it to local "
17263 #: ../src/guestfs-actions.pod:6658
17265 "To download a compressed tarball, use C<guestfs_tgz_out> or "
17266 "C<guestfs_txz_out>."
17270 #: ../src/guestfs-actions.pod:6665
17271 msgid "guestfs_tgz_in"
17275 #: ../src/guestfs-actions.pod:6667
17279 " guestfs_tgz_in (guestfs_h *g,\n"
17280 " const char *tarball,\n"
17281 " const char *directory);\n"
17286 #: ../src/guestfs-actions.pod:6672 ../fish/guestfish-actions.pod:4509
17288 "This command uploads and unpacks local file C<tarball> (a I<gzip compressed> "
17289 "tar file) into C<directory>."
17293 #: ../src/guestfs-actions.pod:6675
17294 msgid "To upload an uncompressed tarball, use C<guestfs_tar_in>."
17298 #: ../src/guestfs-actions.pod:6681
17299 msgid "guestfs_tgz_out"
17303 #: ../src/guestfs-actions.pod:6683
17307 " guestfs_tgz_out (guestfs_h *g,\n"
17308 " const char *directory,\n"
17309 " const char *tarball);\n"
17314 #: ../src/guestfs-actions.pod:6688 ../fish/guestfish-actions.pod:4520
17316 "This command packs the contents of C<directory> and downloads it to local "
17321 #: ../src/guestfs-actions.pod:6691
17322 msgid "To download an uncompressed tarball, use C<guestfs_tar_out>."
17326 #: ../src/guestfs-actions.pod:6697
17327 msgid "guestfs_touch"
17331 #: ../src/guestfs-actions.pod:6699
17335 " guestfs_touch (guestfs_h *g,\n"
17336 " const char *path);\n"
17341 #: ../src/guestfs-actions.pod:6703 ../fish/guestfish-actions.pod:4531
17343 "Touch acts like the L<touch(1)> command. It can be used to update the "
17344 "timestamps on a file, or, if the file does not exist, to create a new zero-"
17349 #: ../src/guestfs-actions.pod:6707 ../fish/guestfish-actions.pod:4535
17351 "This command only works on regular files, and will fail on other file types "
17352 "such as directories, symbolic links, block special etc."
17356 #: ../src/guestfs-actions.pod:6714
17357 msgid "guestfs_truncate"
17361 #: ../src/guestfs-actions.pod:6716
17365 " guestfs_truncate (guestfs_h *g,\n"
17366 " const char *path);\n"
17371 #: ../src/guestfs-actions.pod:6720 ../fish/guestfish-actions.pod:4542
17373 "This command truncates C<path> to a zero-length file. The file must exist "
17378 #: ../src/guestfs-actions.pod:6727
17379 msgid "guestfs_truncate_size"
17383 #: ../src/guestfs-actions.pod:6729
17387 " guestfs_truncate_size (guestfs_h *g,\n"
17388 " const char *path,\n"
17389 " int64_t size);\n"
17394 #: ../src/guestfs-actions.pod:6734 ../fish/guestfish-actions.pod:4549
17396 "This command truncates C<path> to size C<size> bytes. The file must exist "
17401 #: ../src/guestfs-actions.pod:6737
17403 "If the current file size is less than C<size> then the file is extended to "
17404 "the required size with zero bytes. This creates a sparse file (ie. disk "
17405 "blocks are not allocated for the file until you write to it). To create a "
17406 "non-sparse file of zeroes, use C<guestfs_fallocate64> instead."
17410 #: ../src/guestfs-actions.pod:6747
17411 msgid "guestfs_tune2fs_l"
17415 #: ../src/guestfs-actions.pod:6749
17419 " guestfs_tune2fs_l (guestfs_h *g,\n"
17420 " const char *device);\n"
17425 #: ../src/guestfs-actions.pod:6753 ../fish/guestfish-actions.pod:4562
17427 "This returns the contents of the ext2, ext3 or ext4 filesystem superblock on "
17432 #: ../src/guestfs-actions.pod:6756 ../fish/guestfish-actions.pod:4565
17434 "It is the same as running C<tune2fs -l device>. See L<tune2fs(8)> manpage "
17435 "for more details. The list of fields returned isn't clearly defined, and "
17436 "depends on both the version of C<tune2fs> that libguestfs was built against, "
17437 "and the filesystem itself."
17441 #: ../src/guestfs-actions.pod:6769
17442 msgid "guestfs_txz_in"
17446 #: ../src/guestfs-actions.pod:6771
17450 " guestfs_txz_in (guestfs_h *g,\n"
17451 " const char *tarball,\n"
17452 " const char *directory);\n"
17457 #: ../src/guestfs-actions.pod:6776 ../fish/guestfish-actions.pod:4574
17459 "This command uploads and unpacks local file C<tarball> (an I<xz compressed> "
17460 "tar file) into C<directory>."
17464 #: ../src/guestfs-actions.pod:6783
17465 msgid "guestfs_txz_out"
17469 #: ../src/guestfs-actions.pod:6785
17473 " guestfs_txz_out (guestfs_h *g,\n"
17474 " const char *directory,\n"
17475 " const char *tarball);\n"
17480 #: ../src/guestfs-actions.pod:6790 ../fish/guestfish-actions.pod:4583
17482 "This command packs the contents of C<directory> and downloads it to local "
17483 "file C<tarball> (as an xz compressed tar archive)."
17487 #: ../src/guestfs-actions.pod:6797
17488 msgid "guestfs_umask"
17492 #: ../src/guestfs-actions.pod:6799
17496 " guestfs_umask (guestfs_h *g,\n"
17502 #: ../src/guestfs-actions.pod:6803 ../fish/guestfish-actions.pod:4592
17504 "This function sets the mask used for creating new files and device nodes to "
17509 #: ../src/guestfs-actions.pod:6806 ../fish/guestfish-actions.pod:4595
17511 "Typical umask values would be C<022> which creates new files with "
17512 "permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and C<002> which creates "
17513 "new files with permissions like \"-rw-rw-r--\" or \"-rwxrwxr-x\"."
17517 #: ../src/guestfs-actions.pod:6811 ../fish/guestfish-actions.pod:4600
17519 "The default umask is C<022>. This is important because it means that "
17520 "directories and device nodes will be created with C<0644> or C<0755> mode "
17521 "even if you specify C<0777>."
17525 #: ../src/guestfs-actions.pod:6815
17527 "See also C<guestfs_get_umask>, L<umask(2)>, C<guestfs_mknod>, "
17528 "C<guestfs_mkdir>."
17532 #: ../src/guestfs-actions.pod:6818 ../fish/guestfish-actions.pod:4607
17533 msgid "This call returns the previous umask."
17537 #: ../src/guestfs-actions.pod:6824
17538 msgid "guestfs_umount"
17542 #: ../src/guestfs-actions.pod:6826
17546 " guestfs_umount (guestfs_h *g,\n"
17547 " const char *pathordevice);\n"
17552 #: ../src/guestfs-actions.pod:6830 ../fish/guestfish-actions.pod:4615
17554 "This unmounts the given filesystem. The filesystem may be specified either "
17555 "by its mountpoint (path) or the device which contains the filesystem."
17559 #: ../src/guestfs-actions.pod:6838
17560 msgid "guestfs_umount_all"
17564 #: ../src/guestfs-actions.pod:6840
17568 " guestfs_umount_all (guestfs_h *g);\n"
17573 #: ../src/guestfs-actions.pod:6843 ../fish/guestfish-actions.pod:4625
17574 msgid "This unmounts all mounted filesystems."
17578 #: ../src/guestfs-actions.pod:6845 ../fish/guestfish-actions.pod:4627
17579 msgid "Some internal mounts are not unmounted by this call."
17583 #: ../src/guestfs-actions.pod:6851
17584 msgid "guestfs_upload"
17588 #: ../src/guestfs-actions.pod:6853
17592 " guestfs_upload (guestfs_h *g,\n"
17593 " const char *filename,\n"
17594 " const char *remotefilename);\n"
17599 #: ../src/guestfs-actions.pod:6858 ../src/guestfs-actions.pod:6882
17600 #: ../fish/guestfish-actions.pod:4633 ../fish/guestfish-actions.pod:4646
17601 msgid "Upload local file C<filename> to C<remotefilename> on the filesystem."
17605 #: ../src/guestfs-actions.pod:6863
17606 msgid "See also C<guestfs_download>."
17610 #: ../src/guestfs-actions.pod:6874
17611 msgid "guestfs_upload_offset"
17615 #: ../src/guestfs-actions.pod:6876
17619 " guestfs_upload_offset (guestfs_h *g,\n"
17620 " const char *filename,\n"
17621 " const char *remotefilename,\n"
17622 " int64_t offset);\n"
17627 #: ../src/guestfs-actions.pod:6885 ../fish/guestfish-actions.pod:4649
17629 "C<remotefilename> is overwritten starting at the byte C<offset> specified. "
17630 "The intention is to overwrite parts of existing files or devices, although "
17631 "if a non-existant file is specified then it is created with a \"hole\" "
17632 "before C<offset>. The size of the data written is implicit in the size of "
17633 "the source C<filename>."
17637 #: ../src/guestfs-actions.pod:6892
17639 "Note that there is no limit on the amount of data that can be uploaded with "
17640 "this call, unlike with C<guestfs_pwrite>, and this call always writes the "
17641 "full amount unless an error occurs."
17645 #: ../src/guestfs-actions.pod:6897
17646 msgid "See also C<guestfs_upload>, C<guestfs_pwrite>."
17650 #: ../src/guestfs-actions.pod:6908
17651 msgid "guestfs_utimens"
17655 #: ../src/guestfs-actions.pod:6910
17659 " guestfs_utimens (guestfs_h *g,\n"
17660 " const char *path,\n"
17661 " int64_t atsecs,\n"
17662 " int64_t atnsecs,\n"
17663 " int64_t mtsecs,\n"
17664 " int64_t mtnsecs);\n"
17669 #: ../src/guestfs-actions.pod:6918 ../fish/guestfish-actions.pod:4669
17670 msgid "This command sets the timestamps of a file with nanosecond precision."
17674 #: ../src/guestfs-actions.pod:6921 ../fish/guestfish-actions.pod:4672
17676 "C<atsecs, atnsecs> are the last access time (atime) in secs and nanoseconds "
17681 #: ../src/guestfs-actions.pod:6924 ../fish/guestfish-actions.pod:4675
17683 "C<mtsecs, mtnsecs> are the last modification time (mtime) in secs and "
17684 "nanoseconds from the epoch."
17688 #: ../src/guestfs-actions.pod:6927 ../fish/guestfish-actions.pod:4678
17690 "If the C<*nsecs> field contains the special value C<-1> then the "
17691 "corresponding timestamp is set to the current time. (The C<*secs> field is "
17692 "ignored in this case)."
17696 #: ../src/guestfs-actions.pod:6931 ../fish/guestfish-actions.pod:4682
17698 "If the C<*nsecs> field contains the special value C<-2> then the "
17699 "corresponding timestamp is left unchanged. (The C<*secs> field is ignored "
17704 #: ../src/guestfs-actions.pod:6939 ../src/guestfs-structs.pod:175
17705 msgid "guestfs_version"
17709 #: ../src/guestfs-actions.pod:6941
17712 " struct guestfs_version *\n"
17713 " guestfs_version (guestfs_h *g);\n"
17718 #: ../src/guestfs-actions.pod:6944 ../fish/guestfish-actions.pod:4690
17720 "Return the libguestfs version number that the program is linked against."
17724 #: ../src/guestfs-actions.pod:6947 ../fish/guestfish-actions.pod:4693
17726 "Note that because of dynamic linking this is not necessarily the version of "
17727 "libguestfs that you compiled against. You can compile the program, and then "
17728 "at runtime dynamically link against a completely different C<libguestfs.so> "
17733 #: ../src/guestfs-actions.pod:6952 ../fish/guestfish-actions.pod:4698
17735 "This call was added in version C<1.0.58>. In previous versions of "
17736 "libguestfs there was no way to get the version number. From C code you can "
17737 "use dynamic linker functions to find out if this symbol exists (if it "
17738 "doesn't, then it's an earlier version)."
17742 #: ../src/guestfs-actions.pod:6958 ../fish/guestfish-actions.pod:4704
17744 "The call returns a structure with four elements. The first three (C<major>, "
17745 "C<minor> and C<release>) are numbers and correspond to the usual version "
17746 "triplet. The fourth element (C<extra>) is a string and is normally empty, "
17747 "but may be used for distro-specific information."
17751 #: ../src/guestfs-actions.pod:6964 ../fish/guestfish-actions.pod:4710
17753 "To construct the original version string: C<$major.$minor.$release$extra>"
17757 #: ../src/guestfs-actions.pod:6967 ../fish/guestfish-actions.pod:4713
17758 msgid "See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>."
17762 #: ../src/guestfs-actions.pod:6969
17764 "I<Note:> Don't use this call to test for availability of features. In "
17765 "enterprise distributions we backport features from later versions into "
17766 "earlier versions, making this an unreliable way to test for features. Use "
17767 "C<guestfs_available> instead."
17771 #: ../src/guestfs-actions.pod:6975
17773 "This function returns a C<struct guestfs_version *>, or NULL if there was an "
17774 "error. I<The caller must call C<guestfs_free_version> after use>."
17778 #: ../src/guestfs-actions.pod:6979
17779 msgid "(Added in 1.0.58)"
17783 #: ../src/guestfs-actions.pod:6981
17784 msgid "guestfs_vfs_label"
17788 #: ../src/guestfs-actions.pod:6983
17792 " guestfs_vfs_label (guestfs_h *g,\n"
17793 " const char *device);\n"
17798 #: ../src/guestfs-actions.pod:6987 ../fish/guestfish-actions.pod:4725
17799 msgid "This returns the filesystem label of the filesystem on C<device>."
17803 #: ../src/guestfs-actions.pod:6990 ../fish/guestfish-actions.pod:4728
17804 msgid "If the filesystem is unlabeled, this returns the empty string."
17808 #: ../src/guestfs-actions.pod:6992
17809 msgid "To find a filesystem from the label, use C<guestfs_findfs_label>."
17813 #: ../src/guestfs-actions.pod:6997 ../src/guestfs-actions.pod:7034
17814 msgid "(Added in 1.3.18)"
17818 #: ../src/guestfs-actions.pod:6999
17819 msgid "guestfs_vfs_type"
17823 #: ../src/guestfs-actions.pod:7001
17827 " guestfs_vfs_type (guestfs_h *g,\n"
17828 " const char *device);\n"
17833 #: ../src/guestfs-actions.pod:7005 ../fish/guestfish-actions.pod:4736
17835 "This command gets the filesystem type corresponding to the filesystem on "
17840 #: ../src/guestfs-actions.pod:7008 ../fish/guestfish-actions.pod:4739
17842 "For most filesystems, the result is the name of the Linux VFS module which "
17843 "would be used to mount this filesystem if you mounted it without specifying "
17844 "the filesystem type. For example a string such as C<ext3> or C<ntfs>."
17848 #: ../src/guestfs-actions.pod:7018
17849 msgid "guestfs_vfs_uuid"
17853 #: ../src/guestfs-actions.pod:7020
17857 " guestfs_vfs_uuid (guestfs_h *g,\n"
17858 " const char *device);\n"
17863 #: ../src/guestfs-actions.pod:7024 ../fish/guestfish-actions.pod:4748
17864 msgid "This returns the filesystem UUID of the filesystem on C<device>."
17868 #: ../src/guestfs-actions.pod:7027 ../fish/guestfish-actions.pod:4751
17869 msgid "If the filesystem does not have a UUID, this returns the empty string."
17873 #: ../src/guestfs-actions.pod:7029
17874 msgid "To find a filesystem from the UUID, use C<guestfs_findfs_uuid>."
17878 #: ../src/guestfs-actions.pod:7036
17879 msgid "guestfs_vg_activate"
17883 #: ../src/guestfs-actions.pod:7038
17887 " guestfs_vg_activate (guestfs_h *g,\n"
17889 " char *const *volgroups);\n"
17894 #: ../src/guestfs-actions.pod:7043 ../fish/guestfish-actions.pod:4759
17896 "This command activates or (if C<activate> is false) deactivates all logical "
17897 "volumes in the listed volume groups C<volgroups>. If activated, then they "
17898 "are made known to the kernel, ie. they appear as C</dev/mapper> devices. If "
17899 "deactivated, then those devices disappear."
17903 #: ../src/guestfs-actions.pod:7049 ../fish/guestfish-actions.pod:4765
17904 msgid "This command is the same as running C<vgchange -a y|n volgroups...>"
17908 #: ../src/guestfs-actions.pod:7051 ../fish/guestfish-actions.pod:4767
17910 "Note that if C<volgroups> is an empty list then B<all> volume groups are "
17911 "activated or deactivated."
17915 #: ../src/guestfs-actions.pod:7058
17916 msgid "guestfs_vg_activate_all"
17920 #: ../src/guestfs-actions.pod:7060
17924 " guestfs_vg_activate_all (guestfs_h *g,\n"
17925 " int activate);\n"
17930 #: ../src/guestfs-actions.pod:7064 ../fish/guestfish-actions.pod:4774
17932 "This command activates or (if C<activate> is false) deactivates all logical "
17933 "volumes in all volume groups. If activated, then they are made known to the "
17934 "kernel, ie. they appear as C</dev/mapper> devices. If deactivated, then "
17935 "those devices disappear."
17939 #: ../src/guestfs-actions.pod:7070 ../fish/guestfish-actions.pod:4780
17940 msgid "This command is the same as running C<vgchange -a y|n>"
17944 #: ../src/guestfs-actions.pod:7076
17945 msgid "guestfs_vgcreate"
17949 #: ../src/guestfs-actions.pod:7078
17953 " guestfs_vgcreate (guestfs_h *g,\n"
17954 " const char *volgroup,\n"
17955 " char *const *physvols);\n"
17960 #: ../src/guestfs-actions.pod:7083 ../fish/guestfish-actions.pod:4786
17962 "This creates an LVM volume group called C<volgroup> from the non-empty list "
17963 "of physical volumes C<physvols>."
17967 #: ../src/guestfs-actions.pod:7090
17968 msgid "guestfs_vglvuuids"
17972 #: ../src/guestfs-actions.pod:7092
17976 " guestfs_vglvuuids (guestfs_h *g,\n"
17977 " const char *vgname);\n"
17982 #: ../src/guestfs-actions.pod:7096 ../fish/guestfish-actions.pod:4793
17984 "Given a VG called C<vgname>, this returns the UUIDs of all the logical "
17985 "volumes created in this volume group."
17989 #: ../src/guestfs-actions.pod:7099
17991 "You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid> calls to "
17992 "associate logical volumes and volume groups."
17996 #: ../src/guestfs-actions.pod:7102
17997 msgid "See also C<guestfs_vgpvuuids>."
18001 #: ../src/guestfs-actions.pod:7110
18002 msgid "guestfs_vgpvuuids"
18006 #: ../src/guestfs-actions.pod:7112
18010 " guestfs_vgpvuuids (guestfs_h *g,\n"
18011 " const char *vgname);\n"
18016 #: ../src/guestfs-actions.pod:7116 ../fish/guestfish-actions.pod:4805
18018 "Given a VG called C<vgname>, this returns the UUIDs of all the physical "
18019 "volumes that this volume group resides on."
18023 #: ../src/guestfs-actions.pod:7119
18025 "You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid> calls to "
18026 "associate physical volumes and volume groups."
18030 #: ../src/guestfs-actions.pod:7122
18031 msgid "See also C<guestfs_vglvuuids>."
18035 #: ../src/guestfs-actions.pod:7130
18036 msgid "guestfs_vgremove"
18040 #: ../src/guestfs-actions.pod:7132
18044 " guestfs_vgremove (guestfs_h *g,\n"
18045 " const char *vgname);\n"
18050 #: ../src/guestfs-actions.pod:7136 ../fish/guestfish-actions.pod:4817
18051 msgid "Remove an LVM volume group C<vgname>, (for example C<VG>)."
18055 #: ../src/guestfs-actions.pod:7138 ../fish/guestfish-actions.pod:4819
18057 "This also forcibly removes all logical volumes in the volume group (if any)."
18061 #: ../src/guestfs-actions.pod:7145
18062 msgid "guestfs_vgrename"
18066 #: ../src/guestfs-actions.pod:7147
18070 " guestfs_vgrename (guestfs_h *g,\n"
18071 " const char *volgroup,\n"
18072 " const char *newvolgroup);\n"
18077 #: ../src/guestfs-actions.pod:7152 ../fish/guestfish-actions.pod:4826
18078 msgid "Rename a volume group C<volgroup> with the new name C<newvolgroup>."
18082 #: ../src/guestfs-actions.pod:7158
18083 msgid "guestfs_vgs"
18087 #: ../src/guestfs-actions.pod:7160
18091 " guestfs_vgs (guestfs_h *g);\n"
18096 #: ../src/guestfs-actions.pod:7163 ../fish/guestfish-actions.pod:4832
18098 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
18103 #: ../src/guestfs-actions.pod:7166 ../fish/guestfish-actions.pod:4835
18105 "This returns a list of just the volume group names that were detected (eg. "
18110 #: ../src/guestfs-actions.pod:7169
18111 msgid "See also C<guestfs_vgs_full>."
18115 #: ../src/guestfs-actions.pod:7177
18116 msgid "guestfs_vgs_full"
18120 #: ../src/guestfs-actions.pod:7179
18123 " struct guestfs_lvm_vg_list *\n"
18124 " guestfs_vgs_full (guestfs_h *g);\n"
18129 #: ../src/guestfs-actions.pod:7182 ../fish/guestfish-actions.pod:4844
18131 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
18132 "> command. The \"full\" version includes all fields."
18136 #: ../src/guestfs-actions.pod:7185
18138 "This function returns a C<struct guestfs_lvm_vg_list *>, or NULL if there "
18139 "was an error. I<The caller must call C<guestfs_free_lvm_vg_list> after use>."
18143 #: ../src/guestfs-actions.pod:7191
18144 msgid "guestfs_vgscan"
18148 #: ../src/guestfs-actions.pod:7193
18152 " guestfs_vgscan (guestfs_h *g);\n"
18157 #: ../src/guestfs-actions.pod:7196 ../fish/guestfish-actions.pod:4851
18159 "This rescans all block devices and rebuilds the list of LVM physical "
18160 "volumes, volume groups and logical volumes."
18164 #: ../src/guestfs-actions.pod:7203
18165 msgid "guestfs_vguuid"
18169 #: ../src/guestfs-actions.pod:7205
18173 " guestfs_vguuid (guestfs_h *g,\n"
18174 " const char *vgname);\n"
18179 #: ../src/guestfs-actions.pod:7209 ../fish/guestfish-actions.pod:4858
18180 msgid "This command returns the UUID of the LVM VG named C<vgname>."
18184 #: ../src/guestfs-actions.pod:7216
18185 msgid "guestfs_wait_ready"
18189 #: ../src/guestfs-actions.pod:7218
18193 " guestfs_wait_ready (guestfs_h *g);\n"
18198 #: ../src/guestfs-actions.pod:7221
18199 msgid "This function is a no op."
18203 #: ../src/guestfs-actions.pod:7223
18205 "In versions of the API E<lt> 1.0.71 you had to call this function just after "
18206 "calling C<guestfs_launch> to wait for the launch to complete. However this "
18207 "is no longer necessary because C<guestfs_launch> now does the waiting."
18211 #: ../src/guestfs-actions.pod:7228
18213 "If you see any calls to this function in code then you can just remove them, "
18214 "unless you want to retain compatibility with older versions of the API."
18218 #: ../src/guestfs-actions.pod:7234
18220 "This function is deprecated. In new code, use the L</guestfs_launch> call "
18225 #: ../src/guestfs-actions.pod:7243
18226 msgid "guestfs_wc_c"
18230 #: ../src/guestfs-actions.pod:7245
18234 " guestfs_wc_c (guestfs_h *g,\n"
18235 " const char *path);\n"
18240 #: ../src/guestfs-actions.pod:7249 ../fish/guestfish-actions.pod:4864
18242 "This command counts the characters in a file, using the C<wc -c> external "
18247 #: ../src/guestfs-actions.pod:7256
18248 msgid "guestfs_wc_l"
18252 #: ../src/guestfs-actions.pod:7258
18256 " guestfs_wc_l (guestfs_h *g,\n"
18257 " const char *path);\n"
18262 #: ../src/guestfs-actions.pod:7262 ../fish/guestfish-actions.pod:4871
18264 "This command counts the lines in a file, using the C<wc -l> external command."
18268 #: ../src/guestfs-actions.pod:7269
18269 msgid "guestfs_wc_w"
18273 #: ../src/guestfs-actions.pod:7271
18277 " guestfs_wc_w (guestfs_h *g,\n"
18278 " const char *path);\n"
18283 #: ../src/guestfs-actions.pod:7275 ../fish/guestfish-actions.pod:4878
18285 "This command counts the words in a file, using the C<wc -w> external command."
18289 #: ../src/guestfs-actions.pod:7282
18290 msgid "guestfs_write"
18294 #: ../src/guestfs-actions.pod:7284
18298 " guestfs_write (guestfs_h *g,\n"
18299 " const char *path,\n"
18300 " const char *content,\n"
18301 " size_t content_size);\n"
18306 #: ../src/guestfs-actions.pod:7290 ../fish/guestfish-actions.pod:4885
18308 "This call creates a file called C<path>. The content of the file is the "
18309 "string C<content> (which can contain any 8 bit data)."
18313 #: ../src/guestfs-actions.pod:7300
18314 msgid "guestfs_write_file"
18318 #: ../src/guestfs-actions.pod:7302
18322 " guestfs_write_file (guestfs_h *g,\n"
18323 " const char *path,\n"
18324 " const char *content,\n"
18330 #: ../src/guestfs-actions.pod:7308 ../fish/guestfish-actions.pod:4895
18332 "This call creates a file called C<path>. The contents of the file is the "
18333 "string C<content> (which can contain any 8 bit data), with length C<size>."
18337 #: ../src/guestfs-actions.pod:7312 ../fish/guestfish-actions.pod:4899
18339 "As a special case, if C<size> is C<0> then the length is calculated using "
18340 "C<strlen> (so in this case the content cannot contain embedded ASCII NULs)."
18344 #: ../src/guestfs-actions.pod:7316 ../fish/guestfish-actions.pod:4903
18346 "I<NB.> Owing to a bug, writing content containing ASCII NUL characters does "
18347 "I<not> work, even if the length is specified."
18351 #: ../src/guestfs-actions.pod:7324
18353 "This function is deprecated. In new code, use the L</guestfs_write> call "
18358 #: ../src/guestfs-actions.pod:7333
18359 msgid "guestfs_zegrep"
18363 #: ../src/guestfs-actions.pod:7335
18367 " guestfs_zegrep (guestfs_h *g,\n"
18368 " const char *regex,\n"
18369 " const char *path);\n"
18374 #: ../src/guestfs-actions.pod:7340 ../fish/guestfish-actions.pod:4920
18376 "This calls the external C<zegrep> program and returns the matching lines."
18380 #: ../src/guestfs-actions.pod:7352
18381 msgid "guestfs_zegrepi"
18385 #: ../src/guestfs-actions.pod:7354
18389 " guestfs_zegrepi (guestfs_h *g,\n"
18390 " const char *regex,\n"
18391 " const char *path);\n"
18396 #: ../src/guestfs-actions.pod:7359 ../fish/guestfish-actions.pod:4930
18398 "This calls the external C<zegrep -i> program and returns the matching lines."
18402 #: ../src/guestfs-actions.pod:7371
18403 msgid "guestfs_zero"
18407 #: ../src/guestfs-actions.pod:7373
18411 " guestfs_zero (guestfs_h *g,\n"
18412 " const char *device);\n"
18417 #: ../src/guestfs-actions.pod:7377 ../fish/guestfish-actions.pod:4940
18418 msgid "This command writes zeroes over the first few blocks of C<device>."
18422 #: ../src/guestfs-actions.pod:7379 ../fish/guestfish-actions.pod:4942
18424 "How many blocks are zeroed isn't specified (but it's I<not> enough to "
18425 "securely wipe the device). It should be sufficient to remove any partition "
18426 "tables, filesystem superblocks and so on."
18430 #: ../src/guestfs-actions.pod:7383
18431 msgid "See also: C<guestfs_zero_device>, C<guestfs_scrub_device>."
18435 #: ../src/guestfs-actions.pod:7394
18436 msgid "guestfs_zero_device"
18440 #: ../src/guestfs-actions.pod:7396
18444 " guestfs_zero_device (guestfs_h *g,\n"
18445 " const char *device);\n"
18450 #: ../src/guestfs-actions.pod:7400
18452 "This command writes zeroes over the entire C<device>. Compare with "
18453 "C<guestfs_zero> which just zeroes the first few blocks of a device."
18457 #: ../src/guestfs-actions.pod:7414
18458 msgid "(Added in 1.3.1)"
18462 #: ../src/guestfs-actions.pod:7416
18463 msgid "guestfs_zerofree"
18467 #: ../src/guestfs-actions.pod:7418
18471 " guestfs_zerofree (guestfs_h *g,\n"
18472 " const char *device);\n"
18477 #: ../src/guestfs-actions.pod:7422 ../fish/guestfish-actions.pod:4963
18479 "This runs the I<zerofree> program on C<device>. This program claims to zero "
18480 "unused inodes and disk blocks on an ext2/3 filesystem, thus making it "
18481 "possible to compress the filesystem more effectively."
18485 #: ../src/guestfs-actions.pod:7427 ../fish/guestfish-actions.pod:4968
18486 msgid "You should B<not> run this program if the filesystem is mounted."
18490 #: ../src/guestfs-actions.pod:7430 ../fish/guestfish-actions.pod:4971
18492 "It is possible that using this program can damage the filesystem or data on "
18497 #: ../src/guestfs-actions.pod:7437
18498 msgid "guestfs_zfgrep"
18502 #: ../src/guestfs-actions.pod:7439
18506 " guestfs_zfgrep (guestfs_h *g,\n"
18507 " const char *pattern,\n"
18508 " const char *path);\n"
18513 #: ../src/guestfs-actions.pod:7444 ../fish/guestfish-actions.pod:4978
18515 "This calls the external C<zfgrep> program and returns the matching lines."
18519 #: ../src/guestfs-actions.pod:7456
18520 msgid "guestfs_zfgrepi"
18524 #: ../src/guestfs-actions.pod:7458
18528 " guestfs_zfgrepi (guestfs_h *g,\n"
18529 " const char *pattern,\n"
18530 " const char *path);\n"
18535 #: ../src/guestfs-actions.pod:7463 ../fish/guestfish-actions.pod:4988
18537 "This calls the external C<zfgrep -i> program and returns the matching lines."
18541 #: ../src/guestfs-actions.pod:7475
18542 msgid "guestfs_zfile"
18546 #: ../src/guestfs-actions.pod:7477
18550 " guestfs_zfile (guestfs_h *g,\n"
18551 " const char *meth,\n"
18552 " const char *path);\n"
18557 #: ../src/guestfs-actions.pod:7482 ../fish/guestfish-actions.pod:4998
18559 "This command runs C<file> after first decompressing C<path> using C<method>."
18563 #: ../src/guestfs-actions.pod:7485 ../fish/guestfish-actions.pod:5001
18564 msgid "C<method> must be one of C<gzip>, C<compress> or C<bzip2>."
18568 #: ../src/guestfs-actions.pod:7487
18570 "Since 1.0.63, use C<guestfs_file> instead which can now process compressed "
18575 #: ../src/guestfs-actions.pod:7493
18577 "This function is deprecated. In new code, use the L</guestfs_file> call "
18582 #: ../src/guestfs-actions.pod:7502
18583 msgid "guestfs_zgrep"
18587 #: ../src/guestfs-actions.pod:7504
18591 " guestfs_zgrep (guestfs_h *g,\n"
18592 " const char *regex,\n"
18593 " const char *path);\n"
18598 #: ../src/guestfs-actions.pod:7509 ../fish/guestfish-actions.pod:5017
18600 "This calls the external C<zgrep> program and returns the matching lines."
18604 #: ../src/guestfs-actions.pod:7521
18605 msgid "guestfs_zgrepi"
18609 #: ../src/guestfs-actions.pod:7523
18613 " guestfs_zgrepi (guestfs_h *g,\n"
18614 " const char *regex,\n"
18615 " const char *path);\n"
18620 #: ../src/guestfs-actions.pod:7528 ../fish/guestfish-actions.pod:5027
18622 "This calls the external C<zgrep -i> program and returns the matching lines."
18626 #: ../src/guestfs-availability.pod:3
18631 #: ../src/guestfs-availability.pod:5
18633 "The following functions: L</guestfs_aug_clear> L</guestfs_aug_close> L</"
18634 "guestfs_aug_defnode> L</guestfs_aug_defvar> L</guestfs_aug_get> L</"
18635 "guestfs_aug_init> L</guestfs_aug_insert> L</guestfs_aug_load> L</"
18636 "guestfs_aug_ls> L</guestfs_aug_match> L</guestfs_aug_mv> L</guestfs_aug_rm> "
18637 "L</guestfs_aug_save> L</guestfs_aug_set>"
18641 #: ../src/guestfs-availability.pod:21
18646 #: ../src/guestfs-availability.pod:23
18648 "The following functions: L</guestfs_inotify_add_watch> L</"
18649 "guestfs_inotify_close> L</guestfs_inotify_files> L</guestfs_inotify_init> L</"
18650 "guestfs_inotify_read> L</guestfs_inotify_rm_watch>"
18654 #: ../src/guestfs-availability.pod:31
18655 msgid "B<linuxfsuuid>"
18659 #: ../src/guestfs-availability.pod:33
18661 "The following functions: L</guestfs_mke2fs_JU> L</guestfs_mke2journal_U> L</"
18662 "guestfs_mkswap_U> L</guestfs_swapoff_uuid> L</guestfs_swapon_uuid>"
18666 #: ../src/guestfs-availability.pod:40
18667 msgid "B<linuxmodules>"
18671 #: ../src/guestfs-availability.pod:42
18672 msgid "The following functions: L</guestfs_modprobe>"
18676 #: ../src/guestfs-availability.pod:45
18677 msgid "B<linuxxattrs>"
18681 #: ../src/guestfs-availability.pod:47
18683 "The following functions: L</guestfs_getxattr> L</guestfs_getxattrs> L</"
18684 "guestfs_lgetxattr> L</guestfs_lgetxattrs> L</guestfs_lremovexattr> L</"
18685 "guestfs_lsetxattr> L</guestfs_lxattrlist> L</guestfs_removexattr> L</"
18686 "guestfs_setxattr>"
18690 #: ../src/guestfs-availability.pod:58
18695 #: ../src/guestfs-availability.pod:60
18697 "The following functions: L</guestfs_luks_add_key> L</guestfs_luks_close> L</"
18698 "guestfs_luks_format> L</guestfs_luks_format_cipher> L</"
18699 "guestfs_luks_kill_slot> L</guestfs_luks_open> L</guestfs_luks_open_ro>"
18703 #: ../src/guestfs-availability.pod:69
18708 #: ../src/guestfs-availability.pod:71
18710 "The following functions: L</guestfs_is_lv> L</guestfs_lvcreate> L</"
18711 "guestfs_lvm_remove_all> L</guestfs_lvm_set_filter> L</guestfs_lvremove> L</"
18712 "guestfs_lvresize> L</guestfs_lvresize_free> L</guestfs_lvs> L</"
18713 "guestfs_lvs_full> L</guestfs_pvcreate> L</guestfs_pvremove> L</"
18714 "guestfs_pvresize> L</guestfs_pvresize_size> L</guestfs_pvs> L</"
18715 "guestfs_pvs_full> L</guestfs_vg_activate> L</guestfs_vg_activate_all> L</"
18716 "guestfs_vgcreate> L</guestfs_vgremove> L</guestfs_vgs> L</guestfs_vgs_full>"
18720 #: ../src/guestfs-availability.pod:94
18725 #: ../src/guestfs-availability.pod:96
18727 "The following functions: L</guestfs_mkfifo> L</guestfs_mknod> L</"
18728 "guestfs_mknod_b> L</guestfs_mknod_c>"
18732 #: ../src/guestfs-availability.pod:102
18737 #: ../src/guestfs-availability.pod:104
18738 msgid "The following functions: L</guestfs_ntfs_3g_probe>"
18742 #: ../src/guestfs-availability.pod:107
18743 msgid "B<ntfsprogs>"
18747 #: ../src/guestfs-availability.pod:109
18749 "The following functions: L</guestfs_ntfsresize> L</guestfs_ntfsresize_size>"
18753 #: ../src/guestfs-availability.pod:113
18754 msgid "B<realpath>"
18758 #: ../src/guestfs-availability.pod:115
18759 msgid "The following functions: L</guestfs_realpath>"
18763 #: ../src/guestfs-availability.pod:118
18768 #: ../src/guestfs-availability.pod:120
18770 "The following functions: L</guestfs_scrub_device> L</guestfs_scrub_file> L</"
18771 "guestfs_scrub_freespace>"
18775 #: ../src/guestfs-availability.pod:125
18780 #: ../src/guestfs-availability.pod:127
18781 msgid "The following functions: L</guestfs_getcon> L</guestfs_setcon>"
18785 #: ../src/guestfs-availability.pod:131
18790 #: ../src/guestfs-availability.pod:133
18791 msgid "The following functions: L</guestfs_txz_in> L</guestfs_txz_out>"
18795 #: ../src/guestfs-availability.pod:137
18796 msgid "B<zerofree>"
18800 #: ../src/guestfs-availability.pod:139
18801 msgid "The following functions: L</guestfs_zerofree>"
18805 #: ../src/guestfs-structs.pod:1
18806 msgid "guestfs_int_bool"
18810 #: ../src/guestfs-structs.pod:3
18813 " struct guestfs_int_bool {\n"
18821 #: ../src/guestfs-structs.pod:8
18824 " struct guestfs_int_bool_list {\n"
18825 " uint32_t len; /* Number of elements in list. */\n"
18826 " struct guestfs_int_bool *val; /* Elements. */\n"
18832 #: ../src/guestfs-structs.pod:13
18835 " void guestfs_free_int_bool (struct guestfs_free_int_bool *);\n"
18836 " void guestfs_free_int_bool_list (struct guestfs_free_int_bool_list *);\n"
18841 #: ../src/guestfs-structs.pod:16
18842 msgid "guestfs_lvm_pv"
18846 #: ../src/guestfs-structs.pod:18
18849 " struct guestfs_lvm_pv {\n"
18850 " char *pv_name;\n"
18851 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
18852 " char pv_uuid[32];\n"
18854 " uint64_t pv_size;\n"
18855 " uint64_t dev_size;\n"
18856 " uint64_t pv_free;\n"
18857 " uint64_t pv_used;\n"
18858 " char *pv_attr;\n"
18859 " int64_t pv_pe_count;\n"
18860 " int64_t pv_pe_alloc_count;\n"
18861 " char *pv_tags;\n"
18862 " uint64_t pe_start;\n"
18863 " int64_t pv_mda_count;\n"
18864 " uint64_t pv_mda_free;\n"
18870 #: ../src/guestfs-structs.pod:36
18873 " struct guestfs_lvm_pv_list {\n"
18874 " uint32_t len; /* Number of elements in list. */\n"
18875 " struct guestfs_lvm_pv *val; /* Elements. */\n"
18881 #: ../src/guestfs-structs.pod:41
18884 " void guestfs_free_lvm_pv (struct guestfs_free_lvm_pv *);\n"
18885 " void guestfs_free_lvm_pv_list (struct guestfs_free_lvm_pv_list *);\n"
18890 #: ../src/guestfs-structs.pod:44
18891 msgid "guestfs_lvm_vg"
18895 #: ../src/guestfs-structs.pod:46
18898 " struct guestfs_lvm_vg {\n"
18899 " char *vg_name;\n"
18900 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
18901 " char vg_uuid[32];\n"
18903 " char *vg_attr;\n"
18904 " uint64_t vg_size;\n"
18905 " uint64_t vg_free;\n"
18906 " char *vg_sysid;\n"
18907 " uint64_t vg_extent_size;\n"
18908 " int64_t vg_extent_count;\n"
18909 " int64_t vg_free_count;\n"
18910 " int64_t max_lv;\n"
18911 " int64_t max_pv;\n"
18912 " int64_t pv_count;\n"
18913 " int64_t lv_count;\n"
18914 " int64_t snap_count;\n"
18915 " int64_t vg_seqno;\n"
18916 " char *vg_tags;\n"
18917 " int64_t vg_mda_count;\n"
18918 " uint64_t vg_mda_free;\n"
18924 #: ../src/guestfs-structs.pod:69
18927 " struct guestfs_lvm_vg_list {\n"
18928 " uint32_t len; /* Number of elements in list. */\n"
18929 " struct guestfs_lvm_vg *val; /* Elements. */\n"
18935 #: ../src/guestfs-structs.pod:74
18938 " void guestfs_free_lvm_vg (struct guestfs_free_lvm_vg *);\n"
18939 " void guestfs_free_lvm_vg_list (struct guestfs_free_lvm_vg_list *);\n"
18944 #: ../src/guestfs-structs.pod:77
18945 msgid "guestfs_lvm_lv"
18949 #: ../src/guestfs-structs.pod:79
18952 " struct guestfs_lvm_lv {\n"
18953 " char *lv_name;\n"
18954 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
18955 " char lv_uuid[32];\n"
18956 " char *lv_attr;\n"
18957 " int64_t lv_major;\n"
18958 " int64_t lv_minor;\n"
18959 " int64_t lv_kernel_major;\n"
18960 " int64_t lv_kernel_minor;\n"
18961 " uint64_t lv_size;\n"
18962 " int64_t seg_count;\n"
18964 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
18965 " float snap_percent;\n"
18966 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
18967 " float copy_percent;\n"
18968 " char *move_pv;\n"
18969 " char *lv_tags;\n"
18970 " char *mirror_log;\n"
18971 " char *modules;\n"
18977 #: ../src/guestfs-structs.pod:101
18980 " struct guestfs_lvm_lv_list {\n"
18981 " uint32_t len; /* Number of elements in list. */\n"
18982 " struct guestfs_lvm_lv *val; /* Elements. */\n"
18988 #: ../src/guestfs-structs.pod:106
18991 " void guestfs_free_lvm_lv (struct guestfs_free_lvm_lv *);\n"
18992 " void guestfs_free_lvm_lv_list (struct guestfs_free_lvm_lv_list *);\n"
18997 #: ../src/guestfs-structs.pod:111
19000 " struct guestfs_stat {\n"
19004 " int64_t nlink;\n"
19009 " int64_t blksize;\n"
19010 " int64_t blocks;\n"
19011 " int64_t atime;\n"
19012 " int64_t mtime;\n"
19013 " int64_t ctime;\n"
19019 #: ../src/guestfs-structs.pod:127
19022 " struct guestfs_stat_list {\n"
19023 " uint32_t len; /* Number of elements in list. */\n"
19024 " struct guestfs_stat *val; /* Elements. */\n"
19030 #: ../src/guestfs-structs.pod:132
19033 " void guestfs_free_stat (struct guestfs_free_stat *);\n"
19034 " void guestfs_free_stat_list (struct guestfs_free_stat_list *);\n"
19039 #: ../src/guestfs-structs.pod:137
19042 " struct guestfs_statvfs {\n"
19043 " int64_t bsize;\n"
19044 " int64_t frsize;\n"
19045 " int64_t blocks;\n"
19046 " int64_t bfree;\n"
19047 " int64_t bavail;\n"
19048 " int64_t files;\n"
19049 " int64_t ffree;\n"
19050 " int64_t favail;\n"
19053 " int64_t namemax;\n"
19059 #: ../src/guestfs-structs.pod:151
19062 " struct guestfs_statvfs_list {\n"
19063 " uint32_t len; /* Number of elements in list. */\n"
19064 " struct guestfs_statvfs *val; /* Elements. */\n"
19070 #: ../src/guestfs-structs.pod:156
19073 " void guestfs_free_statvfs (struct guestfs_free_statvfs *);\n"
19074 " void guestfs_free_statvfs_list (struct guestfs_free_statvfs_list *);\n"
19079 #: ../src/guestfs-structs.pod:159
19080 msgid "guestfs_dirent"
19084 #: ../src/guestfs-structs.pod:161
19087 " struct guestfs_dirent {\n"
19096 #: ../src/guestfs-structs.pod:167
19099 " struct guestfs_dirent_list {\n"
19100 " uint32_t len; /* Number of elements in list. */\n"
19101 " struct guestfs_dirent *val; /* Elements. */\n"
19107 #: ../src/guestfs-structs.pod:172
19110 " void guestfs_free_dirent (struct guestfs_free_dirent *);\n"
19111 " void guestfs_free_dirent_list (struct guestfs_free_dirent_list *);\n"
19116 #: ../src/guestfs-structs.pod:177
19119 " struct guestfs_version {\n"
19120 " int64_t major;\n"
19121 " int64_t minor;\n"
19122 " int64_t release;\n"
19129 #: ../src/guestfs-structs.pod:184
19132 " struct guestfs_version_list {\n"
19133 " uint32_t len; /* Number of elements in list. */\n"
19134 " struct guestfs_version *val; /* Elements. */\n"
19140 #: ../src/guestfs-structs.pod:189
19143 " void guestfs_free_version (struct guestfs_free_version *);\n"
19144 " void guestfs_free_version_list (struct guestfs_free_version_list *);\n"
19149 #: ../src/guestfs-structs.pod:192
19150 msgid "guestfs_xattr"
19154 #: ../src/guestfs-structs.pod:194
19157 " struct guestfs_xattr {\n"
19158 " char *attrname;\n"
19159 " /* The next two fields describe a byte array. */\n"
19160 " uint32_t attrval_len;\n"
19161 " char *attrval;\n"
19167 #: ../src/guestfs-structs.pod:201
19170 " struct guestfs_xattr_list {\n"
19171 " uint32_t len; /* Number of elements in list. */\n"
19172 " struct guestfs_xattr *val; /* Elements. */\n"
19178 #: ../src/guestfs-structs.pod:206
19181 " void guestfs_free_xattr (struct guestfs_free_xattr *);\n"
19182 " void guestfs_free_xattr_list (struct guestfs_free_xattr_list *);\n"
19187 #: ../src/guestfs-structs.pod:209
19188 msgid "guestfs_inotify_event"
19192 #: ../src/guestfs-structs.pod:211
19195 " struct guestfs_inotify_event {\n"
19196 " int64_t in_wd;\n"
19197 " uint32_t in_mask;\n"
19198 " uint32_t in_cookie;\n"
19199 " char *in_name;\n"
19205 #: ../src/guestfs-structs.pod:218
19208 " struct guestfs_inotify_event_list {\n"
19209 " uint32_t len; /* Number of elements in list. */\n"
19210 " struct guestfs_inotify_event *val; /* Elements. */\n"
19216 #: ../src/guestfs-structs.pod:223
19219 " void guestfs_free_inotify_event (struct guestfs_free_inotify_event *);\n"
19220 " void guestfs_free_inotify_event_list (struct guestfs_free_inotify_event_list *);\n"
19225 #: ../src/guestfs-structs.pod:226
19226 msgid "guestfs_partition"
19230 #: ../src/guestfs-structs.pod:228
19233 " struct guestfs_partition {\n"
19234 " int32_t part_num;\n"
19235 " uint64_t part_start;\n"
19236 " uint64_t part_end;\n"
19237 " uint64_t part_size;\n"
19243 #: ../src/guestfs-structs.pod:235
19246 " struct guestfs_partition_list {\n"
19247 " uint32_t len; /* Number of elements in list. */\n"
19248 " struct guestfs_partition *val; /* Elements. */\n"
19254 #: ../src/guestfs-structs.pod:240
19257 " void guestfs_free_partition (struct guestfs_free_partition *);\n"
19258 " void guestfs_free_partition_list (struct guestfs_free_partition_list *);\n"
19263 #: ../src/guestfs-structs.pod:243
19264 msgid "guestfs_application"
19268 #: ../src/guestfs-structs.pod:245
19271 " struct guestfs_application {\n"
19272 " char *app_name;\n"
19273 " char *app_display_name;\n"
19274 " int32_t app_epoch;\n"
19275 " char *app_version;\n"
19276 " char *app_release;\n"
19277 " char *app_install_path;\n"
19278 " char *app_trans_path;\n"
19279 " char *app_publisher;\n"
19280 " char *app_url;\n"
19281 " char *app_source_package;\n"
19282 " char *app_summary;\n"
19283 " char *app_description;\n"
19289 #: ../src/guestfs-structs.pod:260
19292 " struct guestfs_application_list {\n"
19293 " uint32_t len; /* Number of elements in list. */\n"
19294 " struct guestfs_application *val; /* Elements. */\n"
19300 #: ../src/guestfs-structs.pod:265
19303 " void guestfs_free_application (struct guestfs_free_application *);\n"
19304 " void guestfs_free_application_list (struct guestfs_free_application_list *);\n"
19309 #: ../fish/guestfish.pod:5
19310 msgid "guestfish - the libguestfs Filesystem Interactive SHell"
19314 #: ../fish/guestfish.pod:9
19317 " guestfish [--options] [commands]\n"
19322 #: ../fish/guestfish.pod:11
19330 #: ../fish/guestfish.pod:13
19333 " guestfish [--ro|--rw] -a disk.img\n"
19338 #: ../fish/guestfish.pod:15
19341 " guestfish [--ro|--rw] -a disk.img -m dev[:mountpoint]\n"
19346 #: ../fish/guestfish.pod:17
19349 " guestfish -d libvirt-domain\n"
19354 #: ../fish/guestfish.pod:19
19357 " guestfish [--ro|--rw] -a disk.img -i\n"
19362 #: ../fish/guestfish.pod:21
19365 " guestfish -d libvirt-domain -i\n"
19370 #: ../fish/guestfish.pod:23 ../fuse/guestmount.pod:15 ../tools/virt-edit.pl:44
19371 #: ../tools/virt-win-reg.pl:51 ../tools/virt-tar.pl:64
19376 #: ../fish/guestfish.pod:25
19378 "Using guestfish in read/write mode on live virtual machines can be "
19379 "dangerous, potentially causing disk corruption. Use the I<--ro> (read-only) "
19380 "option to use guestfish safely if the disk image or virtual machine might be "
19385 #: ../fish/guestfish.pod:32
19387 "Guestfish is a shell and command-line tool for examining and modifying "
19388 "virtual machine filesystems. It uses libguestfs and exposes all of the "
19389 "functionality of the guestfs API, see L<guestfs(3)>."
19393 #: ../fish/guestfish.pod:36
19395 "Guestfish gives you structured access to the libguestfs API, from shell "
19396 "scripts or the command line or interactively. If you want to rescue a "
19397 "broken virtual machine image, you should look at the L<virt-rescue(1)> "
19402 #: ../fish/guestfish.pod:41 ../fish/guestfish.pod:958
19403 #: ../fuse/guestmount.pod:39 ../tools/virt-edit.pl:63 ../tools/virt-tar.pl:50
19408 #: ../fish/guestfish.pod:43
19409 msgid "As an interactive shell"
19413 #: ../fish/guestfish.pod:45
19421 #: ../fish/guestfish.pod:47
19424 " Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
19425 " editing virtual machine filesystems.\n"
19430 #: ../fish/guestfish.pod:50
19433 " Type: 'help' for a list of commands\n"
19434 " 'man' to read the manual\n"
19435 " 'quit' to quit the shell\n"
19440 #: ../fish/guestfish.pod:54
19443 " ><fs> add-ro disk.img\n"
19445 " ><fs> list-filesystems\n"
19446 " /dev/sda1: ext4\n"
19447 " /dev/vg_guest/lv_root: ext4\n"
19448 " /dev/vg_guest/lv_swap: swap\n"
19449 " ><fs> mount /dev/vg_guest/lv_root /\n"
19450 " ><fs> cat /etc/fstab\n"
19452 " # Created by anaconda\n"
19459 #: ../fish/guestfish.pod:67
19460 msgid "From shell scripts"
19464 #: ../fish/guestfish.pod:69
19465 msgid "Create a new C</etc/motd> file in a guest or disk image:"
19469 #: ../fish/guestfish.pod:71
19472 " guestfish <<_EOF_\n"
19475 " mount /dev/vg_guest/lv_root /\n"
19476 " write /etc/motd \"Welcome, new users\"\n"
19482 #: ../fish/guestfish.pod:78
19483 msgid "List the LVM logical volumes in a disk image:"
19487 #: ../fish/guestfish.pod:80
19490 " guestfish -a disk.img --ro <<_EOF_\n"
19498 #: ../fish/guestfish.pod:85
19499 msgid "List all the filesystems in a disk image:"
19503 #: ../fish/guestfish.pod:87
19506 " guestfish -a disk.img --ro <<_EOF_\n"
19508 " list-filesystems\n"
19514 #: ../fish/guestfish.pod:92
19515 msgid "On one command line"
19519 #: ../fish/guestfish.pod:94
19520 msgid "Update C</etc/resolv.conf> in a guest:"
19524 #: ../fish/guestfish.pod:96
19528 " add disk.img : run : mount /dev/vg_guest/lv_root / : \\\n"
19529 " write /etc/resolv.conf \"nameserver 1.2.3.4\"\n"
19534 #: ../fish/guestfish.pod:100
19535 msgid "Edit C</boot/grub/grub.conf> interactively:"
19539 #: ../fish/guestfish.pod:102
19542 " guestfish --rw --add disk.img \\\n"
19543 " --mount /dev/vg_guest/lv_root \\\n"
19544 " --mount /dev/sda1:/boot \\\n"
19545 " edit /boot/grub/grub.conf\n"
19550 #: ../fish/guestfish.pod:107
19551 msgid "Mount disks automatically"
19555 #: ../fish/guestfish.pod:109
19557 "Use the I<-i> option to automatically mount the disks from a virtual machine:"
19561 #: ../fish/guestfish.pod:112
19564 " guestfish --ro -a disk.img -i cat /etc/group\n"
19569 #: ../fish/guestfish.pod:114
19572 " guestfish --ro -d libvirt-domain -i cat /etc/group\n"
19577 #: ../fish/guestfish.pod:116
19578 msgid "Another way to edit C</boot/grub/grub.conf> interactively is:"
19582 #: ../fish/guestfish.pod:118
19585 " guestfish --rw -a disk.img -i edit /boot/grub/grub.conf\n"
19590 #: ../fish/guestfish.pod:120
19591 msgid "As a script interpreter"
19595 #: ../fish/guestfish.pod:122
19596 msgid "Create a 100MB disk containing an ext2-formatted partition:"
19600 #: ../fish/guestfish.pod:124
19603 " #!/usr/bin/guestfish -f\n"
19604 " sparse test1.img 100M\n"
19606 " part-disk /dev/sda mbr\n"
19607 " mkfs ext2 /dev/sda1\n"
19612 #: ../fish/guestfish.pod:130
19613 msgid "Start with a prepared disk"
19617 #: ../fish/guestfish.pod:132
19619 "An alternate way to create a 100MB disk called C<test1.img> containing a "
19620 "single ext2-formatted partition:"
19624 #: ../fish/guestfish.pod:135
19627 " guestfish -N fs\n"
19632 #: ../fish/guestfish.pod:137
19633 msgid "To list what is available do:"
19637 #: ../fish/guestfish.pod:139 ../fish/guestfish.pod:949
19640 " guestfish -N help | less\n"
19645 #: ../fish/guestfish.pod:141
19646 msgid "Remote control"
19650 #: ../fish/guestfish.pod:143
19653 " eval \"`guestfish --listen`\"\n"
19654 " guestfish --remote add-ro disk.img\n"
19655 " guestfish --remote run\n"
19656 " guestfish --remote lvs\n"
19661 #: ../fish/guestfish.pod:148 ../test-tool/libguestfs-test-tool.pod:37
19662 #: ../fuse/guestmount.pod:83 ../tools/virt-edit.pl:81
19663 #: ../tools/virt-win-reg.pl:96 ../tools/virt-list-filesystems.pl:53
19664 #: ../tools/virt-tar.pl:103 ../tools/virt-make-fs.pl:153
19665 #: ../tools/virt-list-partitions.pl:54
19670 #: ../fish/guestfish.pod:152 ../fuse/guestmount.pod:141
19671 #: ../tools/virt-edit.pl:89 ../tools/virt-win-reg.pl:104
19672 #: ../tools/virt-list-filesystems.pl:61 ../tools/virt-tar.pl:111
19673 #: ../tools/virt-make-fs.pl:161 ../tools/virt-list-partitions.pl:62
19678 #: ../fish/guestfish.pod:154
19679 msgid "Displays general help on options."
19683 #: ../fish/guestfish.pod:156
19688 #: ../fish/guestfish.pod:158
19689 msgid "B<--cmd-help>"
19693 #: ../fish/guestfish.pod:160
19694 msgid "Lists all available guestfish commands."
19698 #: ../fish/guestfish.pod:162
19703 #: ../fish/guestfish.pod:164
19704 msgid "B<--cmd-help cmd>"
19708 #: ../fish/guestfish.pod:166
19709 msgid "Displays detailed help on a single command C<cmd>."
19713 #: ../fish/guestfish.pod:168
19714 msgid "B<-a image>"
19718 #: ../fish/guestfish.pod:170
19719 msgid "B<--add image>"
19723 #: ../fish/guestfish.pod:172
19724 msgid "Add a block device or virtual machine image to the shell."
19728 #: ../fish/guestfish.pod:174 ../fuse/guestmount.pod:91
19730 "The format of the disk image is auto-detected. To override this and force a "
19731 "particular format use the I<--format=..> option."
19735 #: ../fish/guestfish.pod:177
19737 "Using this flag is mostly equivalent to using the C<add> command, with "
19738 "C<readonly:true> if the I<--ro> flag was given, and with C<format:...> if "
19739 "the I<--format=...> flag was given."
19743 #: ../fish/guestfish.pod:181
19748 #: ../fish/guestfish.pod:183
19749 msgid "B<--connect URI>"
19753 #: ../fish/guestfish.pod:185 ../fuse/guestmount.pod:96
19755 "When used in conjunction with the I<-d> option, this specifies the libvirt "
19756 "URI to use. The default is to use the default libvirt connection."
19760 #: ../fish/guestfish.pod:189
19765 #: ../fish/guestfish.pod:191
19767 "If using the I<--listen> option and a csh-like shell, use this option. See "
19768 "section L</REMOTE CONTROL AND CSH> below."
19772 #: ../fish/guestfish.pod:194
19773 msgid "B<-d libvirt-domain>"
19777 #: ../fish/guestfish.pod:196
19778 msgid "B<--domain libvirt-domain>"
19782 #: ../fish/guestfish.pod:198 ../fuse/guestmount.pod:102
19784 "Add disks from the named libvirt domain. If the I<--ro> option is also "
19785 "used, then any libvirt domain can be used. However in write mode, only "
19786 "libvirt domains which are shut down can be named here."
19790 #: ../fish/guestfish.pod:202
19792 "Using this flag is mostly equivalent to using the C<add-domain> command, "
19793 "with C<readonly:true> if the I<--ro> flag was given, and with C<format:...> "
19794 "if the I<--format:...> flag was given."
19798 #: ../fish/guestfish.pod:206
19803 #: ../fish/guestfish.pod:208
19804 msgid "B<--no-dest-paths>"
19808 #: ../fish/guestfish.pod:210
19810 "Don't tab-complete paths on the guest filesystem. It is useful to be able "
19811 "to hit the tab key to complete paths on the guest filesystem, but this "
19812 "causes extra \"hidden\" guestfs calls to be made, so this option is here to "
19813 "allow this feature to be disabled."
19817 #: ../fish/guestfish.pod:215 ../fuse/guestmount.pod:118
19818 msgid "B<--echo-keys>"
19822 #: ../fish/guestfish.pod:217 ../fuse/guestmount.pod:120
19824 "When prompting for keys and passphrases, guestfish normally turns echoing "
19825 "off so you cannot see what you are typing. If you are not worried about "
19826 "Tempest attacks and there is no one else in the room you can specify this "
19827 "flag to see what you are typing."
19831 #: ../fish/guestfish.pod:222
19836 #: ../fish/guestfish.pod:224
19837 msgid "B<--file file>"
19841 #: ../fish/guestfish.pod:226
19842 msgid "Read commands from C<file>. To write pure guestfish scripts, use:"
19846 #: ../fish/guestfish.pod:229
19849 " #!/usr/bin/guestfish -f\n"
19854 #: ../fish/guestfish.pod:231
19855 msgid "B<--format=raw|qcow2|..>"
19859 #: ../fish/guestfish.pod:233
19860 msgid "B<--format>"
19864 #: ../fish/guestfish.pod:235 ../fuse/guestmount.pod:127
19866 "The default for the I<-a> option is to auto-detect the format of the disk "
19867 "image. Using this forces the disk format for I<-a> options which follow on "
19868 "the command line. Using I<--format> with no argument switches back to auto-"
19869 "detection for subsequent I<-a> options."
19873 #: ../fish/guestfish.pod:242
19876 " guestfish --format=raw -a disk.img\n"
19881 #: ../fish/guestfish.pod:244
19882 msgid "forces raw format (no auto-detection) for C<disk.img>."
19886 #: ../fish/guestfish.pod:246
19889 " guestfish --format=raw -a disk.img --format -a another.img\n"
19894 #: ../fish/guestfish.pod:248
19896 "forces raw format (no auto-detection) for C<disk.img> and reverts to auto-"
19897 "detection for C<another.img>."
19901 #: ../fish/guestfish.pod:251
19903 "If you have untrusted raw-format guest disk images, you should use this "
19904 "option to specify the disk format. This avoids a possible security problem "
19905 "with malicious guests (CVE-2010-3851). See also L</add-drive-opts>."
19909 #: ../fish/guestfish.pod:256
19914 #: ../fish/guestfish.pod:258
19915 msgid "B<--inspector>"
19919 #: ../fish/guestfish.pod:260 ../fuse/guestmount.pod:147
19921 "Using L<virt-inspector(1)> code, inspect the disks looking for an operating "
19922 "system and mount filesystems as they would be mounted on the real virtual "
19927 #: ../fish/guestfish.pod:264
19928 msgid "Typical usage is either:"
19932 #: ../fish/guestfish.pod:266
19935 " guestfish -d myguest -i\n"
19940 #: ../fish/guestfish.pod:268
19941 msgid "(for an inactive libvirt domain called I<myguest>), or:"
19945 #: ../fish/guestfish.pod:270
19948 " guestfish --ro -d myguest -i\n"
19953 #: ../fish/guestfish.pod:272
19954 msgid "(for active domains, readonly), or specify the block device directly:"
19958 #: ../fish/guestfish.pod:274
19961 " guestfish --rw -a /dev/Guests/MyGuest -i\n"
19966 #: ../fish/guestfish.pod:276
19968 "Note that the command line syntax changed slightly over older versions of "
19969 "guestfish. You can still use the old syntax:"
19973 #: ../fish/guestfish.pod:279
19976 " guestfish [--ro] -i disk.img\n"
19981 #: ../fish/guestfish.pod:281
19984 " guestfish [--ro] -i libvirt-domain\n"
19989 #: ../fish/guestfish.pod:283
19991 "Using this flag is mostly equivalent to using the C<inspect-os> command and "
19992 "then using other commands to mount the filesystems that were found."
19996 #: ../fish/guestfish.pod:287 ../fuse/guestmount.pod:151
19997 msgid "B<--keys-from-stdin>"
20001 #: ../fish/guestfish.pod:289 ../fuse/guestmount.pod:153
20003 "Read key or passphrase parameters from stdin. The default is to try to read "
20004 "passphrases from the user by opening C</dev/tty>."
20008 #: ../fish/guestfish.pod:292
20009 msgid "B<--listen>"
20013 #: ../fish/guestfish.pod:294
20015 "Fork into the background and listen for remote commands. See section L</"
20016 "REMOTE CONTROL GUESTFISH OVER A SOCKET> below."
20020 #: ../fish/guestfish.pod:297 ../fuse/guestmount.pod:156
20025 #: ../fish/guestfish.pod:299 ../fuse/guestmount.pod:158
20027 "Connect to a live virtual machine. (Experimental, see L<guestfs(3)/"
20028 "ATTACHING TO RUNNING DAEMONS>)."
20032 #: ../fish/guestfish.pod:302 ../fuse/guestmount.pod:161
20033 msgid "B<-m dev[:mountpoint[:options]]>"
20037 #: ../fish/guestfish.pod:304 ../fuse/guestmount.pod:163
20038 msgid "B<--mount dev[:mountpoint[:options]]>"
20042 #: ../fish/guestfish.pod:306
20043 msgid "Mount the named partition or logical volume on the given mountpoint."
20047 #: ../fish/guestfish.pod:308
20048 msgid "If the mountpoint is omitted, it defaults to C</>."
20052 #: ../fish/guestfish.pod:310
20053 msgid "You have to mount something on C</> before most commands will work."
20057 #: ../fish/guestfish.pod:312
20059 "If any I<-m> or I<--mount> options are given, the guest is automatically "
20064 #: ../fish/guestfish.pod:315
20066 "If you don't know what filesystems a disk image contains, you can either run "
20067 "guestfish without this option, then list the partitions, filesystems and LVs "
20068 "available (see L</list-partitions>, L</list-filesystems> and L</lvs> "
20069 "commands), or you can use the L<virt-filesystems(1)> program."
20073 #: ../fish/guestfish.pod:321 ../fuse/guestmount.pod:171
20075 "The third (and rarely used) part of the mount parameter is the list of mount "
20076 "options used to mount the underlying filesystem. If this is not given, then "
20077 "the mount options are either the empty string or C<ro> (the latter if the "
20078 "I<--ro> flag is used). By specifying the mount options, you override this "
20079 "default choice. Probably the only time you would use this is to enable ACLs "
20080 "and/or extended attributes if the filesystem can support them:"
20084 #: ../fish/guestfish.pod:329 ../fuse/guestmount.pod:179
20087 " -m /dev/sda1:/:acl,user_xattr\n"
20092 #: ../fish/guestfish.pod:331
20093 msgid "Using this flag is equivalent to using the C<mount-options> command."
20097 #: ../fish/guestfish.pod:333
20102 #: ../fish/guestfish.pod:335
20103 msgid "B<--no-sync>"
20107 #: ../fish/guestfish.pod:337
20109 "Disable autosync. This is enabled by default. See the discussion of "
20110 "autosync in the L<guestfs(3)> manpage."
20114 #: ../fish/guestfish.pod:340
20119 #: ../fish/guestfish.pod:342
20120 msgid "B<--new type>"
20124 #: ../fish/guestfish.pod:344
20129 #: ../fish/guestfish.pod:346
20131 "Prepare a fresh disk image formatted as \"type\". This is an alternative to "
20132 "the I<-a> option: whereas I<-a> adds an existing disk, I<-N> creates a "
20133 "preformatted disk with a filesystem and adds it. See L</PREPARED DISK "
20138 #: ../fish/guestfish.pod:351
20139 msgid "B<--progress-bars>"
20143 #: ../fish/guestfish.pod:353
20144 msgid "Enable progress bars, even when guestfish is used non-interactively."
20148 #: ../fish/guestfish.pod:355
20150 "Progress bars are enabled by default when guestfish is used as an "
20151 "interactive shell."
20155 #: ../fish/guestfish.pod:358
20156 msgid "B<--no-progress-bars>"
20160 #: ../fish/guestfish.pod:360
20161 msgid "Disable progress bars."
20165 #: ../fish/guestfish.pod:362
20166 msgid "B<--remote[=pid]>"
20170 #: ../fish/guestfish.pod:364
20172 "Send remote commands to C<$GUESTFISH_PID> or C<pid>. See section L</REMOTE "
20173 "CONTROL GUESTFISH OVER A SOCKET> below."
20177 #: ../fish/guestfish.pod:367
20182 #: ../fish/guestfish.pod:369
20187 #: ../fish/guestfish.pod:371
20189 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
20190 "mounts are done read-only."
20194 #: ../fish/guestfish.pod:374
20196 "The option must always be used if the disk image or virtual machine might be "
20197 "running, and is generally recommended in cases where you don't need write "
20198 "access to the disk."
20202 #: ../fish/guestfish.pod:378
20204 "Note that prepared disk images created with I<-N> are not affected by this "
20205 "option. Also commands like C<add> are not affected - you have to specify "
20206 "the C<readonly:true> option explicitly if you need it."
20210 #: ../fish/guestfish.pod:382
20211 msgid "See also L</OPENING DISKS FOR READ AND WRITE> below."
20215 #: ../fish/guestfish.pod:384 ../fuse/guestmount.pod:235
20216 msgid "B<--selinux>"
20220 #: ../fish/guestfish.pod:386
20221 msgid "Enable SELinux support for the guest. See L<guestfs(3)/SELINUX>."
20225 #: ../fish/guestfish.pod:388
20230 #: ../fish/guestfish.pod:390
20231 msgid "B<--verbose>"
20235 #: ../fish/guestfish.pod:392
20237 "Enable very verbose messages. This is particularly useful if you find a bug."
20241 #: ../fish/guestfish.pod:395
20246 #: ../fish/guestfish.pod:397 ../tools/virt-edit.pl:97
20247 #: ../tools/virt-win-reg.pl:112 ../tools/virt-list-filesystems.pl:69
20248 #: ../tools/virt-tar.pl:119 ../tools/virt-make-fs.pl:169
20249 #: ../tools/virt-list-partitions.pl:70
20250 msgid "B<--version>"
20254 #: ../fish/guestfish.pod:399
20255 msgid "Display the guestfish / libguestfs version number and exit."
20259 #: ../fish/guestfish.pod:401
20264 #: ../fish/guestfish.pod:403
20269 #: ../fish/guestfish.pod:405 ../fuse/guestmount.pod:249
20271 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
20272 "mounts are done read-write."
20276 #: ../fish/guestfish.pod:408
20277 msgid "See L</OPENING DISKS FOR READ AND WRITE> below."
20281 #: ../fish/guestfish.pod:410
20286 #: ../fish/guestfish.pod:412
20287 msgid "Echo each command before executing it."
20291 #: ../fish/guestfish.pod:416
20292 msgid "COMMANDS ON COMMAND LINE"
20296 #: ../fish/guestfish.pod:418
20298 "Any additional (non-option) arguments are treated as commands to execute."
20302 #: ../fish/guestfish.pod:421
20304 "Commands to execute should be separated by a colon (C<:>), where the colon "
20305 "is a separate parameter. Thus:"
20309 #: ../fish/guestfish.pod:424
20312 " guestfish cmd [args...] : cmd [args...] : cmd [args...] ...\n"
20317 #: ../fish/guestfish.pod:426
20319 "If there are no additional arguments, then we enter a shell, either an "
20320 "interactive shell with a prompt (if the input is a terminal) or a non-"
20321 "interactive shell."
20325 #: ../fish/guestfish.pod:430
20327 "In either command line mode or non-interactive shell, the first command that "
20328 "gives an error causes the whole shell to exit. In interactive mode (with a "
20329 "prompt) if a command fails, you can continue to enter commands."
20333 #: ../fish/guestfish.pod:435
20334 msgid "USING launch (OR run)"
20338 #: ../fish/guestfish.pod:437
20340 "As with L<guestfs(3)>, you must first configure your guest by adding disks, "
20341 "then launch it, then mount any disks you need, and finally issue actions/"
20342 "commands. So the general order of the day is:"
20346 #: ../fish/guestfish.pod:445
20347 msgid "add or -a/--add"
20351 #: ../fish/guestfish.pod:449
20352 msgid "launch (aka run)"
20356 #: ../fish/guestfish.pod:453
20357 msgid "mount or -m/--mount"
20361 #: ../fish/guestfish.pod:457
20362 msgid "any other commands"
20366 #: ../fish/guestfish.pod:461
20368 "C<run> is a synonym for C<launch>. You must C<launch> (or C<run>) your "
20369 "guest before mounting or performing any other commands."
20373 #: ../fish/guestfish.pod:464
20375 "The only exception is that if any of the I<-i>, I<-m>, I<--mount>, I<-N> or "
20376 "I<--new> options were given then C<run> is done automatically, simply "
20377 "because guestfish can't perform the action you asked for without doing this."
20381 #: ../fish/guestfish.pod:469
20382 msgid "OPENING DISKS FOR READ AND WRITE"
20386 #: ../fish/guestfish.pod:471
20388 "The guestfish, L<guestmount(1)> and L<virt-rescue(1)> options I<--ro> and "
20389 "I<--rw> affect whether the other command line options I<-a>, I<-c>, I<-d>, "
20390 "I<-i> and I<-m> open disk images read-only or for writing."
20394 #: ../fish/guestfish.pod:476
20396 "In libguestfs E<le> 1.10, guestfish, guestmount and virt-rescue defaulted to "
20397 "opening disk images supplied on the command line for write. To open a disk "
20398 "image read-only you have to do I<-a image --ro>."
20402 #: ../fish/guestfish.pod:480
20404 "This matters: If you accidentally open a live VM disk image writable then "
20405 "you will cause irreversible disk corruption."
20409 #: ../fish/guestfish.pod:483
20411 "By libguestfs 1.12 we intend to change the default the other way. Disk "
20412 "images will be opened read-only. You will have to either specify "
20413 "I<guestfish --rw>, I<guestmount --rw>, I<virt-rescue --rw>, or change the "
20414 "configuration file C</etc/libguestfs-tools.conf> in order to get write "
20415 "access for disk images specified by those other command line options."
20419 #: ../fish/guestfish.pod:490
20421 "This version of guestfish, guestmount and virt-rescue has a I<--rw> option "
20422 "which does nothing (it is already the default). However it is highly "
20423 "recommended that you use this option to indicate that you need write access, "
20424 "and prepare your scripts for the day when this option will be required for "
20429 #: ../fish/guestfish.pod:496
20431 "B<Note:> This does I<not> affect commands like L</add> and L</mount>, or any "
20432 "other libguestfs program apart from guestfish and guestmount."
20436 #: ../fish/guestfish.pod:499
20441 #: ../fish/guestfish.pod:501
20443 "You can quote ordinary parameters using either single or double quotes. For "
20448 #: ../fish/guestfish.pod:504
20451 " add \"file with a space.img\"\n"
20456 #: ../fish/guestfish.pod:506
20459 " rm '/file name'\n"
20464 #: ../fish/guestfish.pod:508
20472 #: ../fish/guestfish.pod:510
20474 "A few commands require a list of strings to be passed. For these, use a "
20475 "whitespace-separated list, enclosed in quotes. Strings containing "
20476 "whitespace to be passed through must be enclosed in single quotes. A "
20477 "literal single quote must be escaped with a backslash."
20481 #: ../fish/guestfish.pod:515
20484 " vgcreate VG \"/dev/sda1 /dev/sdb1\"\n"
20485 " command \"/bin/echo 'foo bar'\"\n"
20486 " command \"/bin/echo \\'foo\\'\"\n"
20491 #: ../fish/guestfish.pod:519
20492 msgid "OPTIONAL ARGUMENTS"
20496 #: ../fish/guestfish.pod:521
20498 "Some commands take optional arguments. These arguments appear in this "
20499 "documentation as C<[argname:..]>. You can use them as in these examples:"
20503 #: ../fish/guestfish.pod:525
20506 " add-drive-opts filename\n"
20511 #: ../fish/guestfish.pod:527
20514 " add-drive-opts filename readonly:true\n"
20519 #: ../fish/guestfish.pod:529
20522 " add-drive-opts filename format:qcow2 readonly:false\n"
20527 #: ../fish/guestfish.pod:531
20529 "Each optional argument can appear at most once. All optional arguments must "
20530 "appear after the required ones."
20534 #: ../fish/guestfish.pod:534
20539 #: ../fish/guestfish.pod:536
20541 "This section applies to all commands which can take integers as parameters."
20545 #: ../fish/guestfish.pod:539
20546 msgid "SIZE SUFFIX"
20550 #: ../fish/guestfish.pod:541
20552 "When the command takes a parameter measured in bytes, you can use one of the "
20553 "following suffixes to specify kilobytes, megabytes and larger sizes:"
20557 #: ../fish/guestfish.pod:547
20558 msgid "B<k> or B<K> or B<KiB>"
20562 #: ../fish/guestfish.pod:549
20563 msgid "The size in kilobytes (multiplied by 1024)."
20567 #: ../fish/guestfish.pod:551
20572 #: ../fish/guestfish.pod:553
20573 msgid "The size in SI 1000 byte units."
20577 #: ../fish/guestfish.pod:555
20578 msgid "B<M> or B<MiB>"
20582 #: ../fish/guestfish.pod:557
20583 msgid "The size in megabytes (multiplied by 1048576)."
20587 #: ../fish/guestfish.pod:559
20592 #: ../fish/guestfish.pod:561
20593 msgid "The size in SI 1000000 byte units."
20597 #: ../fish/guestfish.pod:563
20598 msgid "B<G> or B<GiB>"
20602 #: ../fish/guestfish.pod:565
20603 msgid "The size in gigabytes (multiplied by 2**30)."
20607 #: ../fish/guestfish.pod:567
20612 #: ../fish/guestfish.pod:569
20613 msgid "The size in SI 10**9 byte units."
20617 #: ../fish/guestfish.pod:571
20618 msgid "B<T> or B<TiB>"
20622 #: ../fish/guestfish.pod:573
20623 msgid "The size in terabytes (multiplied by 2**40)."
20627 #: ../fish/guestfish.pod:575
20632 #: ../fish/guestfish.pod:577
20633 msgid "The size in SI 10**12 byte units."
20637 #: ../fish/guestfish.pod:579
20638 msgid "B<P> or B<PiB>"
20642 #: ../fish/guestfish.pod:581
20643 msgid "The size in petabytes (multiplied by 2**50)."
20647 #: ../fish/guestfish.pod:583
20652 #: ../fish/guestfish.pod:585
20653 msgid "The size in SI 10**15 byte units."
20657 #: ../fish/guestfish.pod:587
20658 msgid "B<E> or B<EiB>"
20662 #: ../fish/guestfish.pod:589
20663 msgid "The size in exabytes (multiplied by 2**60)."
20667 #: ../fish/guestfish.pod:591
20672 #: ../fish/guestfish.pod:593
20673 msgid "The size in SI 10**18 byte units."
20677 #: ../fish/guestfish.pod:595
20678 msgid "B<Z> or B<ZiB>"
20682 #: ../fish/guestfish.pod:597
20683 msgid "The size in zettabytes (multiplied by 2**70)."
20687 #: ../fish/guestfish.pod:599
20692 #: ../fish/guestfish.pod:601
20693 msgid "The size in SI 10**21 byte units."
20697 #: ../fish/guestfish.pod:603
20698 msgid "B<Y> or B<YiB>"
20702 #: ../fish/guestfish.pod:605
20703 msgid "The size in yottabytes (multiplied by 2**80)."
20707 #: ../fish/guestfish.pod:607
20712 #: ../fish/guestfish.pod:609
20713 msgid "The size in SI 10**24 byte units."
20717 #: ../fish/guestfish.pod:615
20720 " truncate-size /file 1G\n"
20725 #: ../fish/guestfish.pod:617
20726 msgid "would truncate the file to 1 gigabyte."
20730 #: ../fish/guestfish.pod:619
20732 "Be careful because a few commands take sizes in kilobytes or megabytes (eg. "
20733 "the parameter to L</memsize> is specified in megabytes already). Adding a "
20734 "suffix will probably not do what you expect."
20738 #: ../fish/guestfish.pod:623
20739 msgid "OCTAL AND HEXADECIMAL NUMBERS"
20743 #: ../fish/guestfish.pod:625
20745 "For specifying the radix (base) use the C convention: C<0> to prefix an "
20746 "octal number or C<0x> to prefix a hexadecimal number. For example:"
20750 #: ../fish/guestfish.pod:628
20753 " 1234 decimal number 1234\n"
20754 " 02322 octal number, equivalent to decimal 1234\n"
20755 " 0x4d2 hexadecimal number, equivalent to decimal 1234\n"
20760 #: ../fish/guestfish.pod:632
20762 "When using the C<chmod> command, you almost always want to specify an octal "
20763 "number for the mode, and you must prefix it with C<0> (unlike the Unix "
20764 "L<chmod(1)> program):"
20768 #: ../fish/guestfish.pod:636
20771 " chmod 0777 /public # OK\n"
20772 " chmod 777 /public # WRONG! This is mode 777 decimal = 01411 octal.\n"
20777 #: ../fish/guestfish.pod:639
20779 "Commands that return numbers usually print them in decimal, but some "
20780 "commands print numbers in other radices (eg. C<umask> prints the mode in "
20781 "octal, preceeded by C<0>)."
20785 #: ../fish/guestfish.pod:643
20786 msgid "WILDCARDS AND GLOBBING"
20790 #: ../fish/guestfish.pod:645
20792 "Neither guestfish nor the underlying guestfs API performs wildcard expansion "
20793 "(globbing) by default. So for example the following will not do what you "
20798 #: ../fish/guestfish.pod:649
20806 #: ../fish/guestfish.pod:651
20808 "Assuming you don't have a directory called literally C</home/*> then the "
20809 "above command will return an error."
20813 #: ../fish/guestfish.pod:654
20814 msgid "To perform wildcard expansion, use the C<glob> command."
20818 #: ../fish/guestfish.pod:656
20821 " glob rm-rf /home/*\n"
20826 #: ../fish/guestfish.pod:658
20828 "runs C<rm-rf> on each path that matches (ie. potentially running the command "
20829 "many times), equivalent to:"
20833 #: ../fish/guestfish.pod:661
20836 " rm-rf /home/jim\n"
20837 " rm-rf /home/joe\n"
20838 " rm-rf /home/mary\n"
20843 #: ../fish/guestfish.pod:665
20844 msgid "C<glob> only works on simple guest paths and not on device names."
20848 #: ../fish/guestfish.pod:667
20850 "If you have several parameters, each containing a wildcard, then glob will "
20851 "perform a Cartesian product."
20855 #: ../fish/guestfish.pod:670
20860 #: ../fish/guestfish.pod:672
20862 "Any line which starts with a I<#> character is treated as a comment and "
20863 "ignored. The I<#> can optionally be preceeded by whitespace, but B<not> by "
20864 "a command. For example:"
20868 #: ../fish/guestfish.pod:676
20871 " # this is a comment\n"
20872 " # this is a comment\n"
20873 " foo # NOT a comment\n"
20878 #: ../fish/guestfish.pod:680
20879 msgid "Blank lines are also ignored."
20883 #: ../fish/guestfish.pod:682
20884 msgid "RUNNING COMMANDS LOCALLY"
20888 #: ../fish/guestfish.pod:684
20890 "Any line which starts with a I<!> character is treated as a command sent to "
20891 "the local shell (C</bin/sh> or whatever L<system(3)> uses). For example:"
20895 #: ../fish/guestfish.pod:688
20899 " tgz-out /remote local/remote-data.tar.gz\n"
20904 #: ../fish/guestfish.pod:691
20906 "will create a directory C<local> on the host, and then export the contents "
20907 "of C</remote> on the mounted filesystem to C<local/remote-data.tar.gz>. "
20908 "(See C<tgz-out>)."
20912 #: ../fish/guestfish.pod:695
20914 "To change the local directory, use the C<lcd> command. C<!cd> will have no "
20915 "effect, due to the way that subprocesses work in Unix."
20919 #: ../fish/guestfish.pod:698
20920 msgid "LOCAL COMMANDS WITH INLINE EXECUTION"
20924 #: ../fish/guestfish.pod:700
20926 "If a line starts with I<E<lt>!> then the shell command is executed (as for "
20927 "I<!>), but subsequently any output (stdout) of the shell command is parsed "
20928 "and executed as guestfish commands."
20932 #: ../fish/guestfish.pod:704
20934 "Thus you can use shell script to construct arbitrary guestfish commands "
20935 "which are then parsed by guestfish."
20939 #: ../fish/guestfish.pod:707
20941 "For example it is tedious to create a sequence of files (eg. C</foo.1> "
20942 "through C</foo.100>) using guestfish commands alone. However this is simple "
20943 "if we use a shell script to create the guestfish commands for us:"
20947 #: ../fish/guestfish.pod:712
20950 " <! for n in `seq 1 100`; do echo write /foo.$n $n; done\n"
20955 #: ../fish/guestfish.pod:714
20956 msgid "or with names like C</foo.001>:"
20960 #: ../fish/guestfish.pod:716
20963 " <! for n in `seq 1 100`; do printf \"write /foo.%03d %d\\n\" $n $n; done\n"
20968 #: ../fish/guestfish.pod:718
20970 "When using guestfish interactively it can be helpful to just run the shell "
20971 "script first (ie. remove the initial C<E<lt>> character so it is just an "
20972 "ordinary I<!> local command), see what guestfish commands it would run, and "
20973 "when you are happy with those prepend the C<E<lt>> character to run the "
20974 "guestfish commands for real."
20978 #: ../fish/guestfish.pod:724
20983 #: ../fish/guestfish.pod:726
20985 "Use C<command E<lt>spaceE<gt> | command> to pipe the output of the first "
20986 "command (a guestfish command) to the second command (any host command). For "
20991 #: ../fish/guestfish.pod:730
20994 " cat /etc/passwd | awk -F: '$3 == 0 { print }'\n"
20999 #: ../fish/guestfish.pod:732
21001 "(where C<cat> is the guestfish cat command, but C<awk> is the host awk "
21002 "program). The above command would list all accounts in the guest filesystem "
21003 "which have UID 0, ie. root accounts including backdoors. Other examples:"
21007 #: ../fish/guestfish.pod:737
21010 " hexdump /bin/ls | head\n"
21011 " list-devices | tail -1\n"
21012 " tgz-out / - | tar ztf -\n"
21017 #: ../fish/guestfish.pod:741
21019 "The space before the pipe symbol is required, any space after the pipe "
21020 "symbol is optional. Everything after the pipe symbol is just passed "
21021 "straight to the host shell, so it can contain redirections, globs and "
21022 "anything else that makes sense on the host side."
21026 #: ../fish/guestfish.pod:746
21028 "To use a literal argument which begins with a pipe symbol, you have to quote "
21033 #: ../fish/guestfish.pod:749
21041 #: ../fish/guestfish.pod:751
21042 msgid "HOME DIRECTORIES"
21046 #: ../fish/guestfish.pod:753
21048 "If a parameter starts with the character C<~> then the tilde may be expanded "
21049 "as a home directory path (either C<~> for the current user's home directory, "
21050 "or C<~user> for another user)."
21054 #: ../fish/guestfish.pod:757
21056 "Note that home directory expansion happens for users known I<on the host>, "
21057 "not in the guest filesystem."
21061 #: ../fish/guestfish.pod:760
21063 "To use a literal argument which begins with a tilde, you have to quote it, "
21068 #: ../fish/guestfish.pod:763
21076 #: ../fish/guestfish.pod:767
21078 "Libguestfs has some support for Linux guests encrypted according to the "
21079 "Linux Unified Key Setup (LUKS) standard, which includes nearly all whole "
21080 "disk encryption systems used by modern Linux guests. Currently only LVM-on-"
21081 "LUKS is supported."
21085 #: ../fish/guestfish.pod:772
21086 msgid "Identify encrypted block devices and partitions using L</vfs-type>:"
21090 #: ../fish/guestfish.pod:774
21093 " ><fs> vfs-type /dev/sda2\n"
21099 #: ../fish/guestfish.pod:777
21101 "Then open those devices using L</luks-open>. This creates a device-mapper "
21102 "device called C</dev/mapper/luksdev>."
21106 #: ../fish/guestfish.pod:780
21109 " ><fs> luks-open /dev/sda2 luksdev\n"
21110 " Enter key or passphrase (\"key\"): <enter the passphrase>\n"
21115 #: ../fish/guestfish.pod:783
21117 "Finally you have to tell LVM to scan for volume groups on the newly created "
21122 #: ../fish/guestfish.pod:786
21126 " vg-activate-all true\n"
21131 #: ../fish/guestfish.pod:789
21132 msgid "The logical volume(s) can now be mounted in the usual way."
21136 #: ../fish/guestfish.pod:791
21138 "Before closing a LUKS device you must unmount any logical volumes on it and "
21139 "deactivate the volume groups by calling C<vg-activate false VG> on each "
21140 "one. Then you can close the mapper device:"
21144 #: ../fish/guestfish.pod:795
21147 " vg-activate false /dev/VG\n"
21148 " luks-close /dev/mapper/luksdev\n"
21153 #: ../fish/guestfish.pod:798 ../tools/virt-edit.pl:342
21154 msgid "WINDOWS PATHS"
21158 #: ../fish/guestfish.pod:800
21160 "If a path is prefixed with C<win:> then you can use Windows-style drive "
21161 "letters and paths (with some limitations). The following commands are "
21166 #: ../fish/guestfish.pod:804
21169 " file /WINDOWS/system32/config/system.LOG\n"
21174 #: ../fish/guestfish.pod:806
21177 " file win:\\windows\\system32\\config\\system.log\n"
21182 #: ../fish/guestfish.pod:808
21185 " file WIN:C:\\Windows\\SYSTEM32\\CONFIG\\SYSTEM.LOG\n"
21190 #: ../fish/guestfish.pod:810
21192 "The parameter is rewritten \"behind the scenes\" by looking up the position "
21193 "where the drive is mounted, prepending that to the path, changing all "
21194 "backslash characters to forward slash, then resolving the result using L</"
21195 "case-sensitive-path>. For example if the E: drive was mounted on C</e> then "
21196 "the parameter might be rewritten like this:"
21200 #: ../fish/guestfish.pod:816
21203 " win:e:\\foo\\bar => /e/FOO/bar\n"
21208 #: ../fish/guestfish.pod:818
21209 msgid "This only works in argument positions that expect a path."
21213 #: ../fish/guestfish.pod:820
21214 msgid "UPLOADING AND DOWNLOADING FILES"
21218 #: ../fish/guestfish.pod:822
21220 "For commands such as C<upload>, C<download>, C<tar-in>, C<tar-out> and "
21221 "others which upload from or download to a local file, you can use the "
21222 "special filename C<-> to mean \"from stdin\" or \"to stdout\". For example:"
21226 #: ../fish/guestfish.pod:826
21234 #: ../fish/guestfish.pod:828
21236 "reads stdin and creates from that a file C</foo> in the disk image, and:"
21240 #: ../fish/guestfish.pod:831
21243 " tar-out /etc - | tar tf -\n"
21248 #: ../fish/guestfish.pod:833
21250 "writes the tarball to stdout and then pipes that into the external \"tar\" "
21251 "command (see L</PIPES>)."
21255 #: ../fish/guestfish.pod:836
21257 "When using C<-> to read from stdin, the input is read up to the end of "
21258 "stdin. You can also use a special \"heredoc\"-like syntax to read up to "
21259 "some arbitrary end marker:"
21263 #: ../fish/guestfish.pod:840
21266 " upload -<<END /foo\n"
21275 #: ../fish/guestfish.pod:846
21277 "Any string of characters can be used instead of C<END>. The end marker must "
21278 "appear on a line of its own, without any preceeding or following characters "
21279 "(not even spaces)."
21283 #: ../fish/guestfish.pod:850
21285 "Note that the C<-E<lt>E<lt>> syntax only applies to parameters used to "
21286 "upload local files (so-called \"FileIn\" parameters in the generator)."
21290 #: ../fish/guestfish.pod:853
21291 msgid "EXIT ON ERROR BEHAVIOUR"
21295 #: ../fish/guestfish.pod:855
21297 "By default, guestfish will ignore any errors when in interactive mode (ie. "
21298 "taking commands from a human over a tty), and will exit on the first error "
21299 "in non-interactive mode (scripts, commands given on the command line)."
21303 #: ../fish/guestfish.pod:860
21305 "If you prefix a command with a I<-> character, then that command will not "
21306 "cause guestfish to exit, even if that (one) command returns an error."
21310 #: ../fish/guestfish.pod:864
21311 msgid "REMOTE CONTROL GUESTFISH OVER A SOCKET"
21315 #: ../fish/guestfish.pod:866
21317 "Guestfish can be remote-controlled over a socket. This is useful "
21318 "particularly in shell scripts where you want to make several different "
21319 "changes to a filesystem, but you don't want the overhead of starting up a "
21320 "guestfish process each time."
21324 #: ../fish/guestfish.pod:871
21325 msgid "Start a guestfish server process using:"
21329 #: ../fish/guestfish.pod:873
21332 " eval \"`guestfish --listen`\"\n"
21337 #: ../fish/guestfish.pod:875
21338 msgid "and then send it commands by doing:"
21342 #: ../fish/guestfish.pod:877
21345 " guestfish --remote cmd [...]\n"
21350 #: ../fish/guestfish.pod:879
21351 msgid "To cause the server to exit, send it the exit command:"
21355 #: ../fish/guestfish.pod:881
21358 " guestfish --remote exit\n"
21363 #: ../fish/guestfish.pod:883
21365 "Note that the server will normally exit if there is an error in a command. "
21366 "You can change this in the usual way. See section L</EXIT ON ERROR "
21371 #: ../fish/guestfish.pod:887
21372 msgid "CONTROLLING MULTIPLE GUESTFISH PROCESSES"
21376 #: ../fish/guestfish.pod:889
21378 "The C<eval> statement sets the environment variable C<$GUESTFISH_PID>, which "
21379 "is how the I<--remote> option knows where to send the commands. You can "
21380 "have several guestfish listener processes running using:"
21384 #: ../fish/guestfish.pod:893
21387 " eval \"`guestfish --listen`\"\n"
21388 " pid1=$GUESTFISH_PID\n"
21389 " eval \"`guestfish --listen`\"\n"
21390 " pid2=$GUESTFISH_PID\n"
21392 " guestfish --remote=$pid1 cmd\n"
21393 " guestfish --remote=$pid2 cmd\n"
21398 #: ../fish/guestfish.pod:901
21399 msgid "REMOTE CONTROL AND CSH"
21403 #: ../fish/guestfish.pod:903
21405 "When using csh-like shells (csh, tcsh etc) you have to add the I<--csh> "
21410 #: ../fish/guestfish.pod:906
21413 " eval \"`guestfish --listen --csh`\"\n"
21418 #: ../fish/guestfish.pod:908
21419 msgid "REMOTE CONTROL DETAILS"
21423 #: ../fish/guestfish.pod:910
21425 "Remote control happens over a Unix domain socket called C</tmp/.guestfish-"
21426 "$UID/socket-$PID>, where C<$UID> is the effective user ID of the process, "
21427 "and C<$PID> is the process ID of the server."
21431 #: ../fish/guestfish.pod:914
21432 msgid "Guestfish client and server versions must match exactly."
21436 #: ../fish/guestfish.pod:916
21437 msgid "REMOTE CONTROL RUN COMMAND HANGING"
21441 #: ../fish/guestfish.pod:918
21443 "Using the C<run> (or C<launch>) command remotely in a command substitution "
21444 "context hangs, ie. don't do (note the backquotes):"
21448 #: ../fish/guestfish.pod:921
21451 " a=`guestfish --remote run`\n"
21456 #: ../fish/guestfish.pod:923
21458 "Since the C<run> command produces no output on stdout, this is not useful "
21459 "anyway. For further information see L<https://bugzilla.redhat.com/show_bug."
21464 #: ../fish/guestfish.pod:927
21465 msgid "PREPARED DISK IMAGES"
21469 #: ../fish/guestfish.pod:929
21471 "Use the I<-N type> or I<--new type> parameter to select one of a set of "
21472 "preformatted disk images that guestfish can make for you to save typing. "
21473 "This is particularly useful for testing purposes. This option is used "
21474 "instead of the I<-a> option, and like I<-a> can appear multiple times (and "
21475 "can be mixed with I<-a>)."
21479 #: ../fish/guestfish.pod:935
21481 "The new disk is called C<test1.img> for the first I<-N>, C<test2.img> for "
21482 "the second and so on. Existing files in the current directory are "
21487 #: ../fish/guestfish.pod:939
21489 "The type briefly describes how the disk should be sized, partitioned, how "
21490 "filesystem(s) should be created, and how content should be added. "
21491 "Optionally the type can be followed by extra parameters, separated by C<:> "
21492 "(colon) characters. For example, I<-N fs> creates a default 100MB, sparsely-"
21493 "allocated disk, containing a single partition, with the partition formatted "
21494 "as ext2. I<-N fs:ext4:1G> is the same, but for an ext4 filesystem on a 1GB "
21499 #: ../fish/guestfish.pod:947
21500 msgid "To list the available types and any extra parameters they take, run:"
21504 #: ../fish/guestfish.pod:951
21506 "Note that the prepared filesystem is not mounted. You would usually have to "
21507 "use the C<mount /dev/sda1 /> command or add the I<-m /dev/sda1> option."
21511 #: ../fish/guestfish.pod:955
21513 "If any I<-N> or I<--new> options are given, the guest is automatically "
21518 #: ../fish/guestfish.pod:960
21519 msgid "Create a 100MB disk with an ext4-formatted partition:"
21523 #: ../fish/guestfish.pod:962
21526 " guestfish -N fs:ext4\n"
21531 #: ../fish/guestfish.pod:964
21532 msgid "Create a 32MB disk with a VFAT-formatted partition, and mount it:"
21536 #: ../fish/guestfish.pod:966
21539 " guestfish -N fs:vfat:32M -m /dev/sda1\n"
21544 #: ../fish/guestfish.pod:968
21545 msgid "Create a blank 200MB disk:"
21549 #: ../fish/guestfish.pod:970
21552 " guestfish -N disk:200M\n"
21557 #: ../fish/guestfish.pod:972
21558 msgid "PROGRESS BARS"
21562 #: ../fish/guestfish.pod:974
21564 "Some (not all) long-running commands send progress notification messages as "
21565 "they are running. Guestfish turns these messages into progress bars."
21569 #: ../fish/guestfish.pod:978
21571 "When a command that supports progress bars takes longer than two seconds to "
21572 "run, and if progress bars are enabled, then you will see one appearing below "
21577 #: ../fish/guestfish.pod:982
21580 " ><fs> copy-size /large-file /another-file 2048M\n"
21581 " / 10% [#####-----------------------------------------] 00:30\n"
21586 #: ../fish/guestfish.pod:985
21588 "The spinner on the left hand side moves round once for every progress "
21589 "notification received from the backend. This is a (reasonably) golden "
21590 "assurance that the command is \"doing something\" even if the progress bar "
21591 "is not moving, because the command is able to send the progress "
21592 "notifications. When the bar reaches 100% and the command finishes, the "
21593 "spinner disappears."
21597 #: ../fish/guestfish.pod:992
21599 "Progress bars are enabled by default when guestfish is used interactively. "
21600 "You can enable them even for non-interactive modes using I<--progress-bars>, "
21601 "and you can disable them completely using I<--no-progress-bars>."
21605 #: ../fish/guestfish.pod:997
21606 msgid "GUESTFISH COMMANDS"
21610 #: ../fish/guestfish.pod:999
21612 "The commands in this section are guestfish convenience commands, in other "
21613 "words, they are not part of the L<guestfs(3)> API."
21617 #: ../fish/guestfish.pod:1002
21622 #: ../fish/guestfish.pod:1004
21631 #: ../fish/guestfish.pod:1007
21632 msgid "Without any parameter, this provides general help."
21636 #: ../fish/guestfish.pod:1009
21637 msgid "With a C<cmd> parameter, this displays detailed help for that command."
21641 #: ../fish/guestfish.pod:1011
21642 msgid "quit | exit"
21646 #: ../fish/guestfish.pod:1013
21647 msgid "This exits guestfish. You can also use C<^D> key."
21651 #: ../fish/guestfish.pod:1015
21652 msgid "@FISH_COMMANDS@"
21656 #: ../fish/guestfish.pod:1017
21661 #: ../fish/guestfish.pod:1021 ../test-tool/libguestfs-test-tool.pod:77
21666 #: ../fish/guestfish.pod:1023
21668 "guestfish returns 0 if the commands completed without error, or 1 if there "
21673 #: ../fish/guestfish.pod:1030
21678 #: ../fish/guestfish.pod:1032
21680 "The C<edit> command uses C<$EDITOR> as the editor. If not set, it uses "
21685 #: ../fish/guestfish.pod:1035
21686 msgid "GUESTFISH_PID"
21690 #: ../fish/guestfish.pod:1037
21692 "Used with the I<--remote> option to specify the remote guestfish process to "
21693 "control. See section L</REMOTE CONTROL GUESTFISH OVER A SOCKET>."
21697 #: ../fish/guestfish.pod:1041
21702 #: ../fish/guestfish.pod:1043
21704 "The L</hexedit> command uses C<$HEXEDITOR> as the external hex editor. If "
21705 "not specified, the external L<hexedit(1)> program is used."
21709 #: ../fish/guestfish.pod:1047
21714 #: ../fish/guestfish.pod:1049
21716 "If compiled with GNU readline support, various files in the home directory "
21717 "can be used. See L</FILES>."
21721 #: ../fish/guestfish.pod:1058
21723 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
21724 "effect as using the B<-v> option."
21728 #: ../fish/guestfish.pod:1070
21730 "Set the path that guestfish uses to search for kernel and initrd.img. See "
21731 "the discussion of paths in L<guestfs(3)>."
21735 #: ../fish/guestfish.pod:1081
21736 msgid "Set C<LIBGUESTFS_TRACE=1> to enable command traces."
21740 #: ../fish/guestfish.pod:1083
21745 #: ../fish/guestfish.pod:1085
21747 "The C<more> command uses C<$PAGER> as the pager. If not set, it uses "
21752 #: ../fish/guestfish.pod:1101 ../fuse/guestmount.pod:262
21757 #: ../fish/guestfish.pod:1105 ../fuse/guestmount.pod:266
21758 msgid "$HOME/.libguestfs-tools.rc"
21762 #: ../fish/guestfish.pod:1107 ../fuse/guestmount.pod:268
21763 msgid "/etc/libguestfs-tools.conf"
21767 #: ../fish/guestfish.pod:1109 ../fuse/guestmount.pod:270
21769 "This configuration file controls the default read-only or read-write mode "
21770 "(I<--ro> or I<--rw>)."
21774 #: ../fish/guestfish.pod:1112
21775 msgid "See L</OPENING DISKS FOR READ AND WRITE>."
21779 #: ../fish/guestfish.pod:1114
21780 msgid "$HOME/.guestfish"
21784 #: ../fish/guestfish.pod:1116
21786 "If compiled with GNU readline support, then the command history is saved in "
21791 #: ../fish/guestfish.pod:1119
21792 msgid "$HOME/.inputrc"
21796 #: ../fish/guestfish.pod:1121
21797 msgid "/etc/inputrc"
21801 #: ../fish/guestfish.pod:1123
21803 "If compiled with GNU readline support, then these files can be used to "
21804 "configure readline. For further information, please see L<readline(3)/"
21805 "INITIALIZATION FILE>."
21809 #: ../fish/guestfish.pod:1127
21810 msgid "To write rules which only apply to guestfish, use:"
21814 #: ../fish/guestfish.pod:1129
21824 #: ../fish/guestfish.pod:1133
21826 "Variables that you can set in inputrc that change the behaviour of guestfish "
21827 "in useful ways include:"
21831 #: ../fish/guestfish.pod:1138
21832 msgid "completion-ignore-case (default: on)"
21836 #: ../fish/guestfish.pod:1140
21838 "By default, guestfish will ignore case when tab-completing paths on the "
21843 #: ../fish/guestfish.pod:1143
21846 " set completion-ignore-case off\n"
21851 #: ../fish/guestfish.pod:1145
21852 msgid "to make guestfish case sensitive."
21856 #: ../fish/guestfish.pod:1149
21861 #: ../fish/guestfish.pod:1151
21862 msgid "test2.img (etc)"
21866 #: ../fish/guestfish.pod:1153
21868 "When using the I<-N> or I<--new> option, the prepared disk or filesystem "
21869 "will be created in the file C<test1.img> in the current directory. The "
21870 "second use of I<-N> will use C<test2.img> and so on. Any existing file with "
21871 "the same name will be overwritten."
21875 #: ../fish/guestfish.pod:1162
21877 "L<guestfs(3)>, L<http://libguestfs.org/>, L<virt-cat(1)>, L<virt-copy-in(1)"
21878 ">, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, L<virt-filesystems(1)"
21879 ">, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, L<virt-list-partitions"
21880 "(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, L<virt-rescue(1)>, L<virt-resize(1)"
21881 ">, L<virt-tar(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<virt-win-reg(1)"
21882 ">, L<hexedit(1)>."
21886 #: ../fish/guestfish.pod:1192 ../test-tool/libguestfs-test-tool.pod:102
21887 #: ../fuse/guestmount.pod:297 ../tools/virt-edit.pl:518
21888 #: ../tools/virt-win-reg.pl:606 ../tools/virt-list-filesystems.pl:210
21889 #: ../tools/virt-tar.pl:309 ../tools/virt-make-fs.pl:572
21890 #: ../tools/virt-list-partitions.pl:277
21892 "This program is free software; you can redistribute it and/or modify it "
21893 "under the terms of the GNU General Public License as published by the Free "
21894 "Software Foundation; either version 2 of the License, or (at your option) "
21895 "any later version."
21899 #: ../fish/guestfish.pod:1197 ../test-tool/libguestfs-test-tool.pod:107
21900 #: ../fuse/guestmount.pod:302 ../tools/virt-edit.pl:523
21901 #: ../tools/virt-win-reg.pl:611 ../tools/virt-list-filesystems.pl:215
21902 #: ../tools/virt-tar.pl:314 ../tools/virt-make-fs.pl:577
21903 #: ../tools/virt-list-partitions.pl:282
21905 "This program is distributed in the hope that it will be useful, but WITHOUT "
21906 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
21907 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for "
21912 #: ../fish/guestfish.pod:1202 ../test-tool/libguestfs-test-tool.pod:112
21913 #: ../fuse/guestmount.pod:307 ../tools/virt-edit.pl:528
21914 #: ../tools/virt-win-reg.pl:616 ../tools/virt-list-filesystems.pl:220
21915 #: ../tools/virt-tar.pl:319 ../tools/virt-make-fs.pl:582
21916 #: ../tools/virt-list-partitions.pl:287
21918 "You should have received a copy of the GNU General Public License along with "
21919 "this program; if not, write to the Free Software Foundation, Inc., 675 Mass "
21920 "Ave, Cambridge, MA 02139, USA."
21924 #: ../fish/guestfish-actions.pod:1
21929 #: ../fish/guestfish-actions.pod:3
21932 " add-cdrom filename\n"
21937 #: ../fish/guestfish-actions.pod:15
21939 "This call checks for the existence of C<filename>. This stops you from "
21940 "specifying other types of drive which are supported by qemu such as C<nbd:> "
21941 "and C<http:> URLs. To specify those, use the general L</config> call "
21946 #: ../fish/guestfish-actions.pod:22
21948 "If you just want to add an ISO file (often you use this as an efficient way "
21949 "to transfer large files into the guest), then you should probably use L</add-"
21950 "drive-ro> instead."
21954 #: ../fish/guestfish-actions.pod:28 ../fish/guestfish-actions.pod:158
21955 #: ../fish/guestfish-actions.pod:172
21957 "This function is deprecated. In new code, use the L</add_drive_opts> call "
21962 #: ../fish/guestfish-actions.pod:35
21967 #: ../fish/guestfish-actions.pod:37
21972 #: ../fish/guestfish-actions.pod:39
21975 " add-domain dom [libvirturi:..] [readonly:..] [iface:..] [live:..]\n"
21980 #: ../fish/guestfish-actions.pod:41
21982 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
21983 "It works by connecting to libvirt, requesting the domain and domain XML from "
21984 "libvirt, parsing it for disks, and calling L</add-drive-opts> on each one."
21988 #: ../fish/guestfish-actions.pod:71
21990 "The other optional parameters are passed directly through to L</add-drive-"
21995 #: ../fish/guestfish-actions.pod:74 ../fish/guestfish-actions.pod:138
21996 #: ../fish/guestfish-actions.pod:3049
21998 "This command has one or more optional arguments. See L</OPTIONAL ARGUMENTS>."
22002 #: ../fish/guestfish-actions.pod:76
22007 #: ../fish/guestfish-actions.pod:78
22010 " add-drive filename\n"
22015 #: ../fish/guestfish-actions.pod:80
22017 "This function is the equivalent of calling L</add-drive-opts> with no "
22018 "optional parameters, so the disk is added writable, with the format being "
22019 "detected automatically."
22023 #: ../fish/guestfish-actions.pod:84
22025 "Automatic detection of the format opens you up to a potential security hole "
22026 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
22027 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
22028 "you should think about replacing calls to this function with calls to L</add-"
22029 "drive-opts>, and specifying the format."
22033 #: ../fish/guestfish-actions.pod:91
22034 msgid "add-drive-opts"
22038 #: ../fish/guestfish-actions.pod:93
22043 #: ../fish/guestfish-actions.pod:95
22046 " add-drive-opts filename [readonly:..] [format:..] [iface:..]\n"
22051 #: ../fish/guestfish-actions.pod:122
22053 "This forces the image format. If you omit this (or use L</add-drive> or L</"
22054 "add-drive-ro>) then the format is automatically detected. Possible formats "
22055 "include C<raw> and C<qcow2>."
22059 #: ../fish/guestfish-actions.pod:133
22061 "This rarely-used option lets you emulate the behaviour of the deprecated L</"
22062 "add-drive-with-if> call (q.v.)"
22066 #: ../fish/guestfish-actions.pod:140
22067 msgid "add-drive-ro"
22071 #: ../fish/guestfish-actions.pod:142
22076 #: ../fish/guestfish-actions.pod:144
22079 " add-drive-ro filename\n"
22084 #: ../fish/guestfish-actions.pod:146
22086 "This function is the equivalent of calling L</add-drive-opts> with the "
22087 "optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the disk "
22088 "is added read-only, with the format being detected automatically."
22092 #: ../fish/guestfish-actions.pod:151
22093 msgid "add-drive-ro-with-if"
22097 #: ../fish/guestfish-actions.pod:153
22100 " add-drive-ro-with-if filename iface\n"
22105 #: ../fish/guestfish-actions.pod:155
22107 "This is the same as L</add-drive-ro> but it allows you to specify the QEMU "
22108 "interface emulation to use at run time."
22112 #: ../fish/guestfish-actions.pod:165
22113 msgid "add-drive-with-if"
22117 #: ../fish/guestfish-actions.pod:167
22120 " add-drive-with-if filename iface\n"
22125 #: ../fish/guestfish-actions.pod:169
22127 "This is the same as L</add-drive> but it allows you to specify the QEMU "
22128 "interface emulation to use at run time."
22132 #: ../fish/guestfish-actions.pod:179
22137 #: ../fish/guestfish-actions.pod:181
22140 " aug-clear augpath\n"
22145 #: ../fish/guestfish-actions.pod:186
22150 #: ../fish/guestfish-actions.pod:188
22158 #: ../fish/guestfish-actions.pod:190
22160 "Close the current Augeas handle and free up any resources used by it. After "
22161 "calling this, you have to call L</aug-init> again before you can use any "
22162 "other Augeas functions."
22166 #: ../fish/guestfish-actions.pod:195
22167 msgid "aug-defnode"
22171 #: ../fish/guestfish-actions.pod:197
22174 " aug-defnode name expr val\n"
22179 #: ../fish/guestfish-actions.pod:202
22181 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
22182 "calling L</aug-set> C<expr>, C<value>. C<name> will be the nodeset "
22183 "containing that single node."
22187 #: ../fish/guestfish-actions.pod:210
22192 #: ../fish/guestfish-actions.pod:212
22195 " aug-defvar name expr\n"
22200 #: ../fish/guestfish-actions.pod:221
22205 #: ../fish/guestfish-actions.pod:223
22208 " aug-get augpath\n"
22213 #: ../fish/guestfish-actions.pod:228
22218 #: ../fish/guestfish-actions.pod:230
22221 " aug-init root flags\n"
22226 #: ../fish/guestfish-actions.pod:236
22227 msgid "You must call this before using any other L</aug-*> commands."
22231 #: ../fish/guestfish-actions.pod:261
22233 "This option is only useful when debugging Augeas lenses. Use of this option "
22234 "may require additional memory for the libguestfs appliance. You may need to "
22235 "set the C<LIBGUESTFS_MEMSIZE> environment variable or call L</set-memsize>."
22239 #: ../fish/guestfish-actions.pod:276
22240 msgid "Do not load the tree in L</aug-init>."
22244 #: ../fish/guestfish-actions.pod:280
22245 msgid "To close the handle, you can call L</aug-close>."
22249 #: ../fish/guestfish-actions.pod:284
22254 #: ../fish/guestfish-actions.pod:286
22257 " aug-insert augpath label true|false\n"
22262 #: ../fish/guestfish-actions.pod:296
22267 #: ../fish/guestfish-actions.pod:298
22275 #: ../fish/guestfish-actions.pod:305
22280 #: ../fish/guestfish-actions.pod:307
22283 " aug-ls augpath\n"
22288 #: ../fish/guestfish-actions.pod:309
22290 "This is just a shortcut for listing L</aug-match> C<path/*> and sorting the "
22291 "resulting nodes into alphabetical order."
22295 #: ../fish/guestfish-actions.pod:312
22300 #: ../fish/guestfish-actions.pod:314
22303 " aug-match augpath\n"
22308 #: ../fish/guestfish-actions.pod:320
22313 #: ../fish/guestfish-actions.pod:322
22316 " aug-mv src dest\n"
22321 #: ../fish/guestfish-actions.pod:327
22326 #: ../fish/guestfish-actions.pod:329
22329 " aug-rm augpath\n"
22334 #: ../fish/guestfish-actions.pod:335
22339 #: ../fish/guestfish-actions.pod:337
22347 #: ../fish/guestfish-actions.pod:341
22349 "The flags which were passed to L</aug-init> affect exactly how files are "
22354 #: ../fish/guestfish-actions.pod:344
22359 #: ../fish/guestfish-actions.pod:346
22362 " aug-set augpath val\n"
22367 #: ../fish/guestfish-actions.pod:350
22369 "In the Augeas API, it is possible to clear a node by setting the value to "
22370 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
22371 "this call. Instead you must use the L</aug-clear> call."
22375 #: ../fish/guestfish-actions.pod:355
22380 #: ../fish/guestfish-actions.pod:357
22383 " available 'groups ...'\n"
22388 #: ../fish/guestfish-actions.pod:363
22390 "The libguestfs groups, and the functions that those groups correspond to, "
22391 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
22392 "runtime by calling L</available-all-groups>."
22396 #: ../fish/guestfish-actions.pod:387
22397 msgid "You must call L</launch> before calling this function."
22401 #: ../fish/guestfish-actions.pod:409
22403 "This call was added in version C<1.0.80>. In previous versions of "
22404 "libguestfs all you could do would be to speculatively execute a command to "
22405 "find out if the daemon implemented it. See also L</version>."
22409 #: ../fish/guestfish-actions.pod:416
22410 msgid "available-all-groups"
22414 #: ../fish/guestfish-actions.pod:418
22417 " available-all-groups\n"
22422 #: ../fish/guestfish-actions.pod:420
22424 "This command returns a list of all optional groups that this daemon knows "
22425 "about. Note this returns both supported and unsupported groups. To find "
22426 "out which ones the daemon can actually support you have to call L</"
22427 "available> on each member of the returned list."
22431 #: ../fish/guestfish-actions.pod:426
22432 msgid "See also L</available> and L<guestfs(3)/AVAILABILITY>."
22436 #: ../fish/guestfish-actions.pod:428
22441 #: ../fish/guestfish-actions.pod:430
22444 " base64-in (base64file|-) filename\n"
22449 #: ../fish/guestfish-actions.pod:435 ../fish/guestfish-actions.pod:444
22450 #: ../fish/guestfish-actions.pod:668 ../fish/guestfish-actions.pod:837
22451 #: ../fish/guestfish-actions.pod:856 ../fish/guestfish-actions.pod:1230
22452 #: ../fish/guestfish-actions.pod:4491 ../fish/guestfish-actions.pod:4503
22453 #: ../fish/guestfish-actions.pod:4514 ../fish/guestfish-actions.pod:4525
22454 #: ../fish/guestfish-actions.pod:4577 ../fish/guestfish-actions.pod:4586
22455 #: ../fish/guestfish-actions.pod:4640 ../fish/guestfish-actions.pod:4663
22456 msgid "Use C<-> instead of a filename to read/write from stdin/stdout."
22460 #: ../fish/guestfish-actions.pod:437
22465 #: ../fish/guestfish-actions.pod:439
22468 " base64-out filename (base64file|-)\n"
22473 #: ../fish/guestfish-actions.pod:446
22474 msgid "blockdev-flushbufs"
22478 #: ../fish/guestfish-actions.pod:448
22481 " blockdev-flushbufs device\n"
22486 #: ../fish/guestfish-actions.pod:455
22487 msgid "blockdev-getbsz"
22491 #: ../fish/guestfish-actions.pod:457
22494 " blockdev-getbsz device\n"
22499 #: ../fish/guestfish-actions.pod:466
22500 msgid "blockdev-getro"
22504 #: ../fish/guestfish-actions.pod:468
22507 " blockdev-getro device\n"
22512 #: ../fish/guestfish-actions.pod:475
22513 msgid "blockdev-getsize64"
22517 #: ../fish/guestfish-actions.pod:477
22520 " blockdev-getsize64 device\n"
22525 #: ../fish/guestfish-actions.pod:481
22526 msgid "See also L</blockdev-getsz>."
22530 #: ../fish/guestfish-actions.pod:485
22531 msgid "blockdev-getss"
22535 #: ../fish/guestfish-actions.pod:487
22538 " blockdev-getss device\n"
22543 #: ../fish/guestfish-actions.pod:492
22545 "(Note, this is not the size in sectors, use L</blockdev-getsz> for that)."
22549 #: ../fish/guestfish-actions.pod:497
22550 msgid "blockdev-getsz"
22554 #: ../fish/guestfish-actions.pod:499
22557 " blockdev-getsz device\n"
22562 #: ../fish/guestfish-actions.pod:504
22564 "See also L</blockdev-getss> for the real sector size of the device, and L</"
22565 "blockdev-getsize64> for the more useful I<size in bytes>."
22569 #: ../fish/guestfish-actions.pod:510
22570 msgid "blockdev-rereadpt"
22574 #: ../fish/guestfish-actions.pod:512
22577 " blockdev-rereadpt device\n"
22582 #: ../fish/guestfish-actions.pod:518
22583 msgid "blockdev-setbsz"
22587 #: ../fish/guestfish-actions.pod:520
22590 " blockdev-setbsz device blocksize\n"
22595 #: ../fish/guestfish-actions.pod:529
22596 msgid "blockdev-setro"
22600 #: ../fish/guestfish-actions.pod:531
22603 " blockdev-setro device\n"
22608 #: ../fish/guestfish-actions.pod:537
22609 msgid "blockdev-setrw"
22613 #: ../fish/guestfish-actions.pod:539
22616 " blockdev-setrw device\n"
22621 #: ../fish/guestfish-actions.pod:545
22622 msgid "case-sensitive-path"
22626 #: ../fish/guestfish-actions.pod:547
22629 " case-sensitive-path path\n"
22634 #: ../fish/guestfish-actions.pod:571
22636 "Thus L</case-sensitive-path> (\"/Windows/System32\") might return C<\"/"
22637 "WINDOWS/system32\"> (the exact return value would depend on details of how "
22638 "the directories were originally created under Windows)."
22642 #: ../fish/guestfish-actions.pod:579
22643 msgid "See also L</realpath>."
22647 #: ../fish/guestfish-actions.pod:581
22652 #: ../fish/guestfish-actions.pod:583
22660 #: ../fish/guestfish-actions.pod:587
22662 "Note that this function cannot correctly handle binary files (specifically, "
22663 "files containing C<\\0> character which is treated as end of string). For "
22664 "those you need to use the L</read-file> or L</download> functions which have "
22665 "a more complex interface."
22669 #: ../fish/guestfish-actions.pod:595
22674 #: ../fish/guestfish-actions.pod:597
22677 " checksum csumtype path\n"
22682 #: ../fish/guestfish-actions.pod:640
22683 msgid "To get the checksum for a device, use L</checksum-device>."
22687 #: ../fish/guestfish-actions.pod:642
22688 msgid "To get the checksums for many files, use L</checksums-out>."
22692 #: ../fish/guestfish-actions.pod:644
22693 msgid "checksum-device"
22697 #: ../fish/guestfish-actions.pod:646
22700 " checksum-device csumtype device\n"
22705 #: ../fish/guestfish-actions.pod:648
22707 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
22708 "device named C<device>. For the types of checksums supported see the L</"
22709 "checksum> command."
22713 #: ../fish/guestfish-actions.pod:652
22714 msgid "checksums-out"
22718 #: ../fish/guestfish-actions.pod:654
22721 " checksums-out csumtype directory (sumsfile|-)\n"
22726 #: ../fish/guestfish-actions.pod:670
22731 #: ../fish/guestfish-actions.pod:672
22734 " chmod mode path\n"
22739 #: ../fish/guestfish-actions.pod:683
22744 #: ../fish/guestfish-actions.pod:685
22747 " chown owner group path\n"
22752 #: ../fish/guestfish-actions.pod:693
22757 #: ../fish/guestfish-actions.pod:695
22760 " command 'arguments ...'\n"
22765 #: ../fish/guestfish-actions.pod:702
22767 "The single parameter is an argv-style list of arguments. The first element "
22768 "is the name of the program to run. Subsequent elements are parameters. The "
22769 "list must be non-empty (ie. must contain a program name). Note that the "
22770 "command runs directly, and is I<not> invoked via the shell (see L</sh>)."
22774 #: ../fish/guestfish-actions.pod:730
22775 msgid "command-lines"
22779 #: ../fish/guestfish-actions.pod:732
22782 " command-lines 'arguments ...'\n"
22787 #: ../fish/guestfish-actions.pod:734
22789 "This is the same as L</command>, but splits the result into a list of lines."
22793 #: ../fish/guestfish-actions.pod:737
22794 msgid "See also: L</sh-lines>"
22798 #: ../fish/guestfish-actions.pod:742
22803 #: ../fish/guestfish-actions.pod:744
22806 " config qemuparam qemuvalue\n"
22811 #: ../fish/guestfish-actions.pod:755
22816 #: ../fish/guestfish-actions.pod:757
22819 " copy-size src dest size\n"
22824 #: ../fish/guestfish-actions.pod:765
22829 #: ../fish/guestfish-actions.pod:767
22837 #: ../fish/guestfish-actions.pod:772
22842 #: ../fish/guestfish-actions.pod:774
22850 #: ../fish/guestfish-actions.pod:779
22855 #: ../fish/guestfish-actions.pod:781
22863 #: ../fish/guestfish-actions.pod:788
22865 "If the destination is a device, it must be as large or larger than the "
22866 "source file or device, otherwise the copy will fail. This command cannot do "
22867 "partial copies (see L</copy-size>)."
22871 #: ../fish/guestfish-actions.pod:792
22876 #: ../fish/guestfish-actions.pod:794
22884 #: ../fish/guestfish-actions.pod:798 ../fish/guestfish-actions.pod:809
22886 "This command is mostly useful for interactive sessions. It is I<not> "
22887 "intended that you try to parse the output string. Use L</statvfs> from "
22892 #: ../fish/guestfish-actions.pod:802
22897 #: ../fish/guestfish-actions.pod:804
22905 #: ../fish/guestfish-actions.pod:813
22910 #: ../fish/guestfish-actions.pod:815
22918 #: ../fish/guestfish-actions.pod:821
22920 "Another way to get the same information is to enable verbose messages with "
22921 "L</set-verbose> or by setting the environment variable C<LIBGUESTFS_DEBUG=1> "
22922 "before running the program."
22926 #: ../fish/guestfish-actions.pod:826
22931 #: ../fish/guestfish-actions.pod:828
22934 " download remotefilename (filename|-)\n"
22939 #: ../fish/guestfish-actions.pod:835
22940 msgid "See also L</upload>, L</cat>."
22944 #: ../fish/guestfish-actions.pod:839
22945 msgid "download-offset"
22949 #: ../fish/guestfish-actions.pod:841
22952 " download-offset remotefilename (filename|-) offset size\n"
22957 #: ../fish/guestfish-actions.pod:849
22959 "Note that there is no limit on the amount of data that can be downloaded "
22960 "with this call, unlike with L</pread>, and this call always reads the full "
22961 "amount unless an error occurs."
22965 #: ../fish/guestfish-actions.pod:854
22966 msgid "See also L</download>, L</pread>."
22970 #: ../fish/guestfish-actions.pod:858
22971 msgid "drop-caches"
22975 #: ../fish/guestfish-actions.pod:860
22978 " drop-caches whattodrop\n"
22983 #: ../fish/guestfish-actions.pod:872
22988 #: ../fish/guestfish-actions.pod:874
22996 #: ../fish/guestfish-actions.pod:886
23001 #: ../fish/guestfish-actions.pod:888
23004 " e2fsck-f device\n"
23009 #: ../fish/guestfish-actions.pod:894
23011 "This command is only needed because of L</resize2fs> (q.v.). Normally you "
23012 "should use L</fsck>."
23016 #: ../fish/guestfish-actions.pod:897
23017 msgid "echo-daemon"
23021 #: ../fish/guestfish-actions.pod:899
23024 " echo-daemon 'words ...'\n"
23029 #: ../fish/guestfish-actions.pod:906
23030 msgid "See also L</ping-daemon>."
23034 #: ../fish/guestfish-actions.pod:908
23039 #: ../fish/guestfish-actions.pod:910
23042 " egrep regex path\n"
23047 #: ../fish/guestfish-actions.pod:918
23052 #: ../fish/guestfish-actions.pod:920
23055 " egrepi regex path\n"
23060 #: ../fish/guestfish-actions.pod:928
23065 #: ../fish/guestfish-actions.pod:930
23068 " equal file1 file2\n"
23073 #: ../fish/guestfish-actions.pod:937
23078 #: ../fish/guestfish-actions.pod:939
23086 #: ../fish/guestfish-actions.pod:944
23087 msgid "See also L</is-file>, L</is-dir>, L</stat>."
23091 #: ../fish/guestfish-actions.pod:946
23096 #: ../fish/guestfish-actions.pod:948
23099 " fallocate path len\n"
23104 #: ../fish/guestfish-actions.pod:958
23106 "This function is deprecated. In new code, use the L</fallocate64> call "
23111 #: ../fish/guestfish-actions.pod:965
23112 msgid "fallocate64"
23116 #: ../fish/guestfish-actions.pod:967
23119 " fallocate64 path len\n"
23124 #: ../fish/guestfish-actions.pod:973
23126 "Note that this call allocates disk blocks for the file. To create a sparse "
23127 "file use L</truncate-size> instead."
23131 #: ../fish/guestfish-actions.pod:976
23133 "The deprecated call L</fallocate> does the same, but owing to an oversight "
23134 "it only allowed 30 bit lengths to be specified, effectively limiting the "
23135 "maximum size of files created through that call to 1GB."
23139 #: ../fish/guestfish-actions.pod:985
23144 #: ../fish/guestfish-actions.pod:987
23147 " fgrep pattern path\n"
23152 #: ../fish/guestfish-actions.pod:995
23157 #: ../fish/guestfish-actions.pod:997
23160 " fgrepi pattern path\n"
23165 #: ../fish/guestfish-actions.pod:1005
23170 #: ../fish/guestfish-actions.pod:1007
23178 #: ../fish/guestfish-actions.pod:1023
23180 "See also: L<file(1)>, L</vfs-type>, L</lstat>, L</is-file>, L</is-blockdev> "
23185 #: ../fish/guestfish-actions.pod:1026
23186 msgid "file-architecture"
23190 #: ../fish/guestfish-actions.pod:1028
23193 " file-architecture filename\n"
23198 #: ../fish/guestfish-actions.pod:1131
23203 #: ../fish/guestfish-actions.pod:1133
23211 #: ../fish/guestfish-actions.pod:1137
23213 "To get other stats about a file, use L</stat>, L</lstat>, L</is-dir>, L</is-"
23214 "file> etc. To get the size of block devices, use L</blockdev-getsize64>."
23218 #: ../fish/guestfish-actions.pod:1141
23223 #: ../fish/guestfish-actions.pod:1143
23226 " fill c len path\n"
23231 #: ../fish/guestfish-actions.pod:1149
23233 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
23234 "L</truncate-size>. To create a file with a pattern of repeating bytes use "
23235 "L</fill-pattern>."
23239 #: ../fish/guestfish-actions.pod:1154
23240 msgid "fill-pattern"
23244 #: ../fish/guestfish-actions.pod:1156
23247 " fill-pattern pattern len path\n"
23252 #: ../fish/guestfish-actions.pod:1158
23254 "This function is like L</fill> except that it creates a new file of length "
23255 "C<len> containing the repeating pattern of bytes in C<pattern>. The pattern "
23256 "is truncated if necessary to ensure the length of the file is exactly C<len> "
23261 #: ../fish/guestfish-actions.pod:1163
23266 #: ../fish/guestfish-actions.pod:1165
23269 " find directory\n"
23274 #: ../fish/guestfish-actions.pod:1179
23275 msgid "then the returned list from L</find> C</tmp> would be 4 elements:"
23279 #: ../fish/guestfish-actions.pod:1192
23280 msgid "See also L</find0>."
23284 #: ../fish/guestfish-actions.pod:1197
23289 #: ../fish/guestfish-actions.pod:1199
23292 " find0 directory (files|-)\n"
23297 #: ../fish/guestfish-actions.pod:1205
23299 "This command works the same way as L</find> with the following exceptions:"
23303 #: ../fish/guestfish-actions.pod:1232
23304 msgid "findfs-label"
23308 #: ../fish/guestfish-actions.pod:1234
23311 " findfs-label label\n"
23316 #: ../fish/guestfish-actions.pod:1240
23317 msgid "To find the label of a filesystem, use L</vfs-label>."
23321 #: ../fish/guestfish-actions.pod:1242
23322 msgid "findfs-uuid"
23326 #: ../fish/guestfish-actions.pod:1244
23329 " findfs-uuid uuid\n"
23334 #: ../fish/guestfish-actions.pod:1250
23335 msgid "To find the UUID of a filesystem, use L</vfs-uuid>."
23339 #: ../fish/guestfish-actions.pod:1252
23344 #: ../fish/guestfish-actions.pod:1254
23347 " fsck fstype device\n"
23352 #: ../fish/guestfish-actions.pod:1284
23357 #: ../fish/guestfish-actions.pod:1286
23365 #: ../fish/guestfish-actions.pod:1293
23366 msgid "get-attach-method"
23370 #: ../fish/guestfish-actions.pod:1295
23373 " get-attach-method\n"
23378 #: ../fish/guestfish-actions.pod:1297
23379 msgid "Return the current attach method. See L</set-attach-method>."
23383 #: ../fish/guestfish-actions.pod:1299
23384 msgid "get-autosync"
23388 #: ../fish/guestfish-actions.pod:1301
23396 #: ../fish/guestfish-actions.pod:1305
23401 #: ../fish/guestfish-actions.pod:1307
23409 #: ../fish/guestfish-actions.pod:1311
23410 msgid "get-e2label"
23414 #: ../fish/guestfish-actions.pod:1313
23417 " get-e2label device\n"
23422 #: ../fish/guestfish-actions.pod:1318
23424 "This function is deprecated. In new code, use the L</vfs_label> call "
23429 #: ../fish/guestfish-actions.pod:1325
23434 #: ../fish/guestfish-actions.pod:1327
23437 " get-e2uuid device\n"
23442 #: ../fish/guestfish-actions.pod:1332
23444 "This function is deprecated. In new code, use the L</vfs_uuid> call instead."
23448 #: ../fish/guestfish-actions.pod:1339
23449 msgid "get-memsize"
23453 #: ../fish/guestfish-actions.pod:1341
23461 #: ../fish/guestfish-actions.pod:1346
23463 "If L</set-memsize> was not called on this handle, and if "
23464 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
23465 "value for memsize."
23469 #: ../fish/guestfish-actions.pod:1353
23470 msgid "get-network"
23474 #: ../fish/guestfish-actions.pod:1355
23482 #: ../fish/guestfish-actions.pod:1359
23487 #: ../fish/guestfish-actions.pod:1361
23495 #: ../fish/guestfish-actions.pod:1368
23500 #: ../fish/guestfish-actions.pod:1370
23505 #: ../fish/guestfish-actions.pod:1372
23513 #: ../fish/guestfish-actions.pod:1379
23518 #: ../fish/guestfish-actions.pod:1381
23526 #: ../fish/guestfish-actions.pod:1388
23527 msgid "get-recovery-proc"
23531 #: ../fish/guestfish-actions.pod:1390
23534 " get-recovery-proc\n"
23539 #: ../fish/guestfish-actions.pod:1394
23540 msgid "get-selinux"
23544 #: ../fish/guestfish-actions.pod:1396
23552 #: ../fish/guestfish-actions.pod:1398
23554 "This returns the current setting of the selinux flag which is passed to the "
23555 "appliance at boot time. See L</set-selinux>."
23559 #: ../fish/guestfish-actions.pod:1404
23564 #: ../fish/guestfish-actions.pod:1406
23572 #: ../fish/guestfish-actions.pod:1413
23577 #: ../fish/guestfish-actions.pod:1415
23585 #: ../fish/guestfish-actions.pod:1419
23590 #: ../fish/guestfish-actions.pod:1421
23598 #: ../fish/guestfish-actions.pod:1423
23600 "Return the current umask. By default the umask is C<022> unless it has been "
23601 "set by calling L</umask>."
23605 #: ../fish/guestfish-actions.pod:1426
23606 msgid "get-verbose"
23610 #: ../fish/guestfish-actions.pod:1428
23618 #: ../fish/guestfish-actions.pod:1432
23623 #: ../fish/guestfish-actions.pod:1434
23631 #: ../fish/guestfish-actions.pod:1438
23632 msgid "See the documentation about SELINUX in L<guestfs(3)>, and L</setcon>"
23636 #: ../fish/guestfish-actions.pod:1441
23641 #: ../fish/guestfish-actions.pod:1443
23644 " getxattr path name\n"
23649 #: ../fish/guestfish-actions.pod:1445
23651 "Get a single extended attribute from file C<path> named C<name>. This call "
23652 "follows symlinks. If you want to lookup an extended attribute for the "
23653 "symlink itself, use L</lgetxattr>."
23657 #: ../fish/guestfish-actions.pod:1449 ../fish/guestfish-actions.pod:2455
23659 "Normally it is better to get all extended attributes from a file in one go "
23660 "by calling L</getxattrs>. However some Linux filesystem implementations are "
23661 "buggy and do not provide a way to list out attributes. For these "
23662 "filesystems (notably ntfs-3g) you have to know the names of the extended "
23663 "attributes you want in advance and call this function."
23667 #: ../fish/guestfish-actions.pod:1459
23668 msgid "See also: L</getxattrs>, L</lgetxattr>, L<attr(5)>."
23672 #: ../fish/guestfish-actions.pod:1461
23677 #: ../fish/guestfish-actions.pod:1463
23680 " getxattrs path\n"
23685 #: ../fish/guestfish-actions.pod:1471
23686 msgid "See also: L</lgetxattrs>, L<attr(5)>."
23690 #: ../fish/guestfish-actions.pod:1473
23691 msgid "glob-expand"
23695 #: ../fish/guestfish-actions.pod:1475
23698 " glob-expand pattern\n"
23703 #: ../fish/guestfish-actions.pod:1488
23708 #: ../fish/guestfish-actions.pod:1490
23711 " grep regex path\n"
23716 #: ../fish/guestfish-actions.pod:1498
23721 #: ../fish/guestfish-actions.pod:1500
23724 " grepi regex path\n"
23729 #: ../fish/guestfish-actions.pod:1508
23730 msgid "grub-install"
23734 #: ../fish/guestfish-actions.pod:1510
23737 " grub-install root device\n"
23742 #: ../fish/guestfish-actions.pod:1526
23747 #: ../fish/guestfish-actions.pod:1528
23755 #: ../fish/guestfish-actions.pod:1536
23760 #: ../fish/guestfish-actions.pod:1538
23763 " head-n nrlines path\n"
23768 #: ../fish/guestfish-actions.pod:1551
23773 #: ../fish/guestfish-actions.pod:1553
23781 #: ../fish/guestfish-actions.pod:1561
23786 #: ../fish/guestfish-actions.pod:1563
23789 " initrd-cat initrdpath filename\n"
23794 #: ../fish/guestfish-actions.pod:1575
23795 msgid "See also L</initrd-list>."
23799 #: ../fish/guestfish-actions.pod:1580
23800 msgid "initrd-list"
23804 #: ../fish/guestfish-actions.pod:1582
23807 " initrd-list path\n"
23812 #: ../fish/guestfish-actions.pod:1594
23813 msgid "inotify-add-watch"
23817 #: ../fish/guestfish-actions.pod:1596
23820 " inotify-add-watch path mask\n"
23825 #: ../fish/guestfish-actions.pod:1608
23826 msgid "inotify-close"
23830 #: ../fish/guestfish-actions.pod:1610
23838 #: ../fish/guestfish-actions.pod:1616
23839 msgid "inotify-files"
23843 #: ../fish/guestfish-actions.pod:1618
23851 #: ../fish/guestfish-actions.pod:1620
23853 "This function is a helpful wrapper around L</inotify-read> which just "
23854 "returns a list of pathnames of objects that were touched. The returned "
23855 "pathnames are sorted and deduplicated."
23859 #: ../fish/guestfish-actions.pod:1624
23860 msgid "inotify-init"
23864 #: ../fish/guestfish-actions.pod:1626
23867 " inotify-init maxevents\n"
23872 #: ../fish/guestfish-actions.pod:1632
23874 "C<maxevents> is the maximum number of events which will be queued up between "
23875 "calls to L</inotify-read> or L</inotify-files>. If this is passed as C<0>, "
23876 "then the kernel (or previously set) default is used. For Linux 2.6.29 the "
23877 "default was 16384 events. Beyond this limit, the kernel throws away events, "
23878 "but records the fact that it threw them away by setting a flag "
23879 "C<IN_Q_OVERFLOW> in the returned structure list (see L</inotify-read>)."
23883 #: ../fish/guestfish-actions.pod:1642
23885 "Before any events are generated, you have to add some watches to the "
23886 "internal watch list. See: L</inotify-add-watch>, L</inotify-rm-watch> and "
23887 "L</inotify-watch-all>."
23891 #: ../fish/guestfish-actions.pod:1648
23893 "Queued up events should be read periodically by calling L</inotify-read> (or "
23894 "L</inotify-files> which is just a helpful wrapper around L</inotify-read>). "
23895 "If you don't read the events out often enough then you risk the internal "
23896 "queue overflowing."
23900 #: ../fish/guestfish-actions.pod:1655
23902 "The handle should be closed after use by calling L</inotify-close>. This "
23903 "also removes any watches automatically."
23907 #: ../fish/guestfish-actions.pod:1664
23908 msgid "inotify-read"
23912 #: ../fish/guestfish-actions.pod:1666
23920 #: ../fish/guestfish-actions.pod:1679
23921 msgid "inotify-rm-watch"
23925 #: ../fish/guestfish-actions.pod:1681
23928 " inotify-rm-watch wd\n"
23933 #: ../fish/guestfish-actions.pod:1683
23934 msgid "Remove a previously defined inotify watch. See L</inotify-add-watch>."
23938 #: ../fish/guestfish-actions.pod:1686
23939 msgid "inspect-get-arch"
23943 #: ../fish/guestfish-actions.pod:1688
23946 " inspect-get-arch root\n"
23951 #: ../fish/guestfish-actions.pod:1690 ../fish/guestfish-actions.pod:1706
23952 #: ../fish/guestfish-actions.pod:1792 ../fish/guestfish-actions.pod:1828
23953 #: ../fish/guestfish-actions.pod:1846 ../fish/guestfish-actions.pod:1880
23954 #: ../fish/guestfish-actions.pod:1895 ../fish/guestfish-actions.pod:1916
23955 #: ../fish/guestfish-actions.pod:1931 ../fish/guestfish-actions.pod:1964
23956 #: ../fish/guestfish-actions.pod:1986 ../fish/guestfish-actions.pod:2010
23957 #: ../fish/guestfish-actions.pod:2027 ../fish/guestfish-actions.pod:2070
23958 #: ../fish/guestfish-actions.pod:2105 ../fish/guestfish-actions.pod:2121
23959 #: ../fish/guestfish-actions.pod:2137 ../fish/guestfish-actions.pod:2150
23960 #: ../fish/guestfish-actions.pod:2163 ../fish/guestfish-actions.pod:2178
23962 "This function should only be called with a root device string as returned by "
23967 #: ../fish/guestfish-actions.pod:1693
23969 "This returns the architecture of the inspected operating system. The "
23970 "possible return values are listed under L</file-architecture>."
23974 #: ../fish/guestfish-actions.pod:1702
23975 msgid "inspect-get-distro"
23979 #: ../fish/guestfish-actions.pod:1704
23982 " inspect-get-distro root\n"
23987 #: ../fish/guestfish-actions.pod:1788
23988 msgid "inspect-get-drive-mappings"
23992 #: ../fish/guestfish-actions.pod:1790
23995 " inspect-get-drive-mappings root\n"
24000 #: ../fish/guestfish-actions.pod:1820
24002 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
24003 "get-mountpoints>, L</inspect-get-filesystems>."
24007 #: ../fish/guestfish-actions.pod:1824
24008 msgid "inspect-get-filesystems"
24012 #: ../fish/guestfish-actions.pod:1826
24015 " inspect-get-filesystems root\n"
24020 #: ../fish/guestfish-actions.pod:1839
24022 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
24023 "get-mountpoints>."
24027 #: ../fish/guestfish-actions.pod:1842
24028 msgid "inspect-get-format"
24032 #: ../fish/guestfish-actions.pod:1844
24035 " inspect-get-format root\n"
24040 #: ../fish/guestfish-actions.pod:1876
24041 msgid "inspect-get-hostname"
24045 #: ../fish/guestfish-actions.pod:1878
24048 " inspect-get-hostname root\n"
24053 #: ../fish/guestfish-actions.pod:1891
24054 msgid "inspect-get-major-version"
24058 #: ../fish/guestfish-actions.pod:1893
24061 " inspect-get-major-version root\n"
24066 #: ../fish/guestfish-actions.pod:1912
24067 msgid "inspect-get-minor-version"
24071 #: ../fish/guestfish-actions.pod:1914
24074 " inspect-get-minor-version root\n"
24079 #: ../fish/guestfish-actions.pod:1924
24081 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
24082 "get-major-version>."
24086 #: ../fish/guestfish-actions.pod:1927
24087 msgid "inspect-get-mountpoints"
24091 #: ../fish/guestfish-actions.pod:1929
24094 " inspect-get-mountpoints root\n"
24099 #: ../fish/guestfish-actions.pod:1951
24101 "For operating systems like Windows which still use drive letters, this call "
24102 "will only return an entry for the first drive \"mounted on\" C</>. For "
24103 "information about the mapping of drive letters to partitions, see L</inspect-"
24104 "get-drive-mappings>."
24108 #: ../fish/guestfish-actions.pod:1957
24110 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
24111 "get-filesystems>."
24115 #: ../fish/guestfish-actions.pod:1960
24116 msgid "inspect-get-package-format"
24120 #: ../fish/guestfish-actions.pod:1962
24123 " inspect-get-package-format root\n"
24128 #: ../fish/guestfish-actions.pod:1967
24130 "This function and L</inspect-get-package-management> return the package "
24131 "format and package management tool used by the inspected operating system. "
24132 "For example for Fedora these functions would return C<rpm> (package format) "
24133 "and C<yum> (package management)."
24137 #: ../fish/guestfish-actions.pod:1982
24138 msgid "inspect-get-package-management"
24142 #: ../fish/guestfish-actions.pod:1984
24145 " inspect-get-package-management root\n"
24150 #: ../fish/guestfish-actions.pod:1989
24152 "L</inspect-get-package-format> and this function return the package format "
24153 "and package management tool used by the inspected operating system. For "
24154 "example for Fedora these functions would return C<rpm> (package format) and "
24155 "C<yum> (package management)."
24159 #: ../fish/guestfish-actions.pod:2006
24160 msgid "inspect-get-product-name"
24164 #: ../fish/guestfish-actions.pod:2008
24167 " inspect-get-product-name root\n"
24172 #: ../fish/guestfish-actions.pod:2023
24173 msgid "inspect-get-product-variant"
24177 #: ../fish/guestfish-actions.pod:2025
24180 " inspect-get-product-variant root\n"
24185 #: ../fish/guestfish-actions.pod:2049
24187 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
24188 "get-product-name>, L</inspect-get-major-version>."
24192 #: ../fish/guestfish-actions.pod:2053
24193 msgid "inspect-get-roots"
24197 #: ../fish/guestfish-actions.pod:2055
24200 " inspect-get-roots\n"
24205 #: ../fish/guestfish-actions.pod:2057
24207 "This function is a convenient way to get the list of root devices, as "
24208 "returned from a previous call to L</inspect-os>, but without redoing the "
24209 "whole inspection process."
24213 #: ../fish/guestfish-actions.pod:2061
24215 "This returns an empty list if either no root devices were found or the "
24216 "caller has not called L</inspect-os>."
24220 #: ../fish/guestfish-actions.pod:2066
24221 msgid "inspect-get-type"
24225 #: ../fish/guestfish-actions.pod:2068
24228 " inspect-get-type root\n"
24233 #: ../fish/guestfish-actions.pod:2101
24234 msgid "inspect-get-windows-current-control-set"
24238 #: ../fish/guestfish-actions.pod:2103
24241 " inspect-get-windows-current-control-set root\n"
24246 #: ../fish/guestfish-actions.pod:2117
24247 msgid "inspect-get-windows-systemroot"
24251 #: ../fish/guestfish-actions.pod:2119
24254 " inspect-get-windows-systemroot root\n"
24259 #: ../fish/guestfish-actions.pod:2133
24260 msgid "inspect-is-live"
24264 #: ../fish/guestfish-actions.pod:2135
24267 " inspect-is-live root\n"
24272 #: ../fish/guestfish-actions.pod:2140
24274 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
24275 "then this returns true if a live image was detected on the disk."
24279 #: ../fish/guestfish-actions.pod:2146
24280 msgid "inspect-is-multipart"
24284 #: ../fish/guestfish-actions.pod:2148
24287 " inspect-is-multipart root\n"
24292 #: ../fish/guestfish-actions.pod:2153
24294 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
24295 "then this returns true if the disk is part of a set."
24299 #: ../fish/guestfish-actions.pod:2159
24300 msgid "inspect-is-netinst"
24304 #: ../fish/guestfish-actions.pod:2161
24307 " inspect-is-netinst root\n"
24312 #: ../fish/guestfish-actions.pod:2166
24314 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
24315 "then this returns true if the disk is a network installer, ie. not a self-"
24316 "contained install CD but one which is likely to require network access to "
24317 "complete the install."
24321 #: ../fish/guestfish-actions.pod:2174
24322 msgid "inspect-list-applications"
24326 #: ../fish/guestfish-actions.pod:2176
24329 " inspect-list-applications root\n"
24334 #: ../fish/guestfish-actions.pod:2183
24336 "I<Note:> This call works differently from other parts of the inspection "
24337 "API. You have to call L</inspect-os>, then L</inspect-get-mountpoints>, "
24338 "then mount up the disks, before calling this. Listing applications is a "
24339 "significantly more difficult operation which requires access to the full "
24340 "filesystem. Also note that unlike the other L</inspect-get-*> calls which "
24341 "are just returning data cached in the libguestfs handle, this call actually "
24342 "reads parts of the mounted filesystems during the call."
24346 #: ../fish/guestfish-actions.pod:2273
24351 #: ../fish/guestfish-actions.pod:2275
24359 #: ../fish/guestfish-actions.pod:2290
24361 "You can pass the root string(s) returned to other L</inspect-get-*> "
24362 "functions in order to query further information about each operating system, "
24363 "such as the name and version."
24367 #: ../fish/guestfish-actions.pod:2295
24369 "This function uses other libguestfs features such as L</mount-ro> and L</"
24370 "umount-all> in order to mount and unmount filesystems and look at the "
24371 "contents. This should be called with no disks currently mounted. The "
24372 "function may also use Augeas, so any existing Augeas handle will be closed."
24376 #: ../fish/guestfish-actions.pod:2307 ../fish/guestfish-actions.pod:2483
24377 #: ../fish/guestfish-actions.pod:2529
24378 msgid "See also L</list-filesystems>."
24382 #: ../fish/guestfish-actions.pod:2309
24383 msgid "is-blockdev"
24387 #: ../fish/guestfish-actions.pod:2311
24390 " is-blockdev path\n"
24395 #: ../fish/guestfish-actions.pod:2316 ../fish/guestfish-actions.pod:2334
24396 #: ../fish/guestfish-actions.pod:2353 ../fish/guestfish-actions.pod:2362
24397 #: ../fish/guestfish-actions.pod:2372 ../fish/guestfish-actions.pod:2406
24398 #: ../fish/guestfish-actions.pod:2415
24399 msgid "See also L</stat>."
24403 #: ../fish/guestfish-actions.pod:2318
24408 #: ../fish/guestfish-actions.pod:2320
24416 #: ../fish/guestfish-actions.pod:2327
24421 #: ../fish/guestfish-actions.pod:2329
24424 " is-chardev path\n"
24429 #: ../fish/guestfish-actions.pod:2336
24434 #: ../fish/guestfish-actions.pod:2338
24442 #: ../fish/guestfish-actions.pod:2345
24447 #: ../fish/guestfish-actions.pod:2347
24455 #: ../fish/guestfish-actions.pod:2355
24460 #: ../fish/guestfish-actions.pod:2357
24468 #: ../fish/guestfish-actions.pod:2364
24473 #: ../fish/guestfish-actions.pod:2366
24481 #: ../fish/guestfish-actions.pod:2374
24482 msgid "is-launching"
24486 #: ../fish/guestfish-actions.pod:2376
24494 #: ../fish/guestfish-actions.pod:2383
24499 #: ../fish/guestfish-actions.pod:2385
24507 #: ../fish/guestfish-actions.pod:2390
24512 #: ../fish/guestfish-actions.pod:2392
24520 #: ../fish/guestfish-actions.pod:2399
24525 #: ../fish/guestfish-actions.pod:2401
24528 " is-socket path\n"
24533 #: ../fish/guestfish-actions.pod:2408
24538 #: ../fish/guestfish-actions.pod:2410
24541 " is-symlink path\n"
24546 #: ../fish/guestfish-actions.pod:2417
24547 msgid "kill-subprocess"
24551 #: ../fish/guestfish-actions.pod:2419
24554 " kill-subprocess\n"
24559 #: ../fish/guestfish-actions.pod:2423
24564 #: ../fish/guestfish-actions.pod:2425
24569 #: ../fish/guestfish-actions.pod:2427
24577 #: ../fish/guestfish-actions.pod:2435
24582 #: ../fish/guestfish-actions.pod:2437
24585 " lchown owner group path\n"
24590 #: ../fish/guestfish-actions.pod:2439
24592 "Change the file owner to C<owner> and group to C<group>. This is like L</"
24593 "chown> but if C<path> is a symlink then the link itself is changed, not the "
24598 #: ../fish/guestfish-actions.pod:2447
24603 #: ../fish/guestfish-actions.pod:2449
24606 " lgetxattr path name\n"
24611 #: ../fish/guestfish-actions.pod:2465
24612 msgid "See also: L</lgetxattrs>, L</getxattr>, L<attr(5)>."
24616 #: ../fish/guestfish-actions.pod:2467
24621 #: ../fish/guestfish-actions.pod:2469
24624 " lgetxattrs path\n"
24629 #: ../fish/guestfish-actions.pod:2471
24631 "This is the same as L</getxattrs>, but if C<path> is a symbolic link, then "
24632 "it returns the extended attributes of the link itself."
24636 #: ../fish/guestfish-actions.pod:2475
24637 msgid "list-devices"
24641 #: ../fish/guestfish-actions.pod:2477
24649 #: ../fish/guestfish-actions.pod:2485
24650 msgid "list-filesystems"
24654 #: ../fish/guestfish-actions.pod:2487
24657 " list-filesystems\n"
24662 #: ../fish/guestfish-actions.pod:2506
24664 "This command runs other libguestfs commands, which might include L</mount> "
24665 "and L</umount>, and therefore you should use this soon after launch and only "
24666 "when nothing is mounted."
24670 #: ../fish/guestfish-actions.pod:2510
24672 "Not all of the filesystems returned will be mountable. In particular, swap "
24673 "partitions are returned in the list. Also this command does not check that "
24674 "each filesystem found is valid and mountable, and some filesystems might be "
24675 "mountable but require special options. Filesystems may not all belong to a "
24676 "single logical operating system (use L</inspect-os> to look for OSes)."
24680 #: ../fish/guestfish-actions.pod:2518
24681 msgid "list-partitions"
24685 #: ../fish/guestfish-actions.pod:2520
24688 " list-partitions\n"
24693 #: ../fish/guestfish-actions.pod:2526
24695 "This does not return logical volumes. For that you will need to call L</"
24700 #: ../fish/guestfish-actions.pod:2531
24705 #: ../fish/guestfish-actions.pod:2533
24713 #: ../fish/guestfish-actions.pod:2541
24718 #: ../fish/guestfish-actions.pod:2543
24721 " ln target linkname\n"
24726 #: ../fish/guestfish-actions.pod:2547
24731 #: ../fish/guestfish-actions.pod:2549
24734 " ln-f target linkname\n"
24739 #: ../fish/guestfish-actions.pod:2554
24744 #: ../fish/guestfish-actions.pod:2556
24747 " ln-s target linkname\n"
24752 #: ../fish/guestfish-actions.pod:2560
24757 #: ../fish/guestfish-actions.pod:2562
24760 " ln-sf target linkname\n"
24765 #: ../fish/guestfish-actions.pod:2567
24766 msgid "lremovexattr"
24770 #: ../fish/guestfish-actions.pod:2569
24773 " lremovexattr xattr path\n"
24778 #: ../fish/guestfish-actions.pod:2571
24780 "This is the same as L</removexattr>, but if C<path> is a symbolic link, then "
24781 "it removes an extended attribute of the link itself."
24785 #: ../fish/guestfish-actions.pod:2575
24790 #: ../fish/guestfish-actions.pod:2577
24798 #: ../fish/guestfish-actions.pod:2583
24800 "This command is mostly useful for interactive sessions. Programs should "
24801 "probably use L</readdir> instead."
24805 #: ../fish/guestfish-actions.pod:2586
24810 #: ../fish/guestfish-actions.pod:2588
24813 " lsetxattr xattr val vallen path\n"
24818 #: ../fish/guestfish-actions.pod:2590
24820 "This is the same as L</setxattr>, but if C<path> is a symbolic link, then it "
24821 "sets an extended attribute of the link itself."
24825 #: ../fish/guestfish-actions.pod:2594
24830 #: ../fish/guestfish-actions.pod:2596
24838 #: ../fish/guestfish-actions.pod:2600
24840 "This is the same as L</stat> except that if C<path> is a symbolic link, then "
24841 "the link is stat-ed, not the file it refers to."
24845 #: ../fish/guestfish-actions.pod:2606
24850 #: ../fish/guestfish-actions.pod:2608
24853 " lstatlist path 'names ...'\n"
24858 #: ../fish/guestfish-actions.pod:2610
24860 "This call allows you to perform the L</lstat> operation on multiple files, "
24861 "where all files are in the directory C<path>. C<names> is the list of files "
24862 "from this directory."
24866 #: ../fish/guestfish-actions.pod:2619
24868 "This call is intended for programs that want to efficiently list a directory "
24869 "contents without making many round-trips. See also L</lxattrlist> for a "
24870 "similarly efficient call for getting extended attributes. Very long "
24871 "directory listings might cause the protocol message size to be exceeded, "
24872 "causing this call to fail. The caller must split up such requests into "
24873 "smaller groups of names."
24877 #: ../fish/guestfish-actions.pod:2627
24878 msgid "luks-add-key"
24882 #: ../fish/guestfish-actions.pod:2629
24885 " luks-add-key device keyslot\n"
24890 #: ../fish/guestfish-actions.pod:2636
24892 "Note that if C<keyslot> already contains a key, then this command will "
24893 "fail. You have to use L</luks-kill-slot> first to remove that key."
24897 #: ../fish/guestfish-actions.pod:2640 ../fish/guestfish-actions.pod:2662
24898 #: ../fish/guestfish-actions.pod:2675 ../fish/guestfish-actions.pod:2689
24899 #: ../fish/guestfish-actions.pod:2712 ../fish/guestfish-actions.pod:2722
24901 "This command has one or more key or passphrase parameters. Guestfish will "
24902 "prompt for these separately."
24906 #: ../fish/guestfish-actions.pod:2643
24911 #: ../fish/guestfish-actions.pod:2645
24914 " luks-close device\n"
24919 #: ../fish/guestfish-actions.pod:2647
24921 "This closes a LUKS device that was created earlier by L</luks-open> or L</"
24922 "luks-open-ro>. The C<device> parameter must be the name of the LUKS mapping "
24923 "device (ie. C</dev/mapper/mapname>) and I<not> the name of the underlying "
24928 #: ../fish/guestfish-actions.pod:2653
24929 msgid "luks-format"
24933 #: ../fish/guestfish-actions.pod:2655
24936 " luks-format device keyslot\n"
24941 #: ../fish/guestfish-actions.pod:2668
24942 msgid "luks-format-cipher"
24946 #: ../fish/guestfish-actions.pod:2670
24949 " luks-format-cipher device keyslot cipher\n"
24954 #: ../fish/guestfish-actions.pod:2672
24956 "This command is the same as L</luks-format> but it also allows you to set "
24957 "the C<cipher> used."
24961 #: ../fish/guestfish-actions.pod:2681
24962 msgid "luks-kill-slot"
24966 #: ../fish/guestfish-actions.pod:2683
24969 " luks-kill-slot device keyslot\n"
24974 #: ../fish/guestfish-actions.pod:2692
24979 #: ../fish/guestfish-actions.pod:2694
24982 " luks-open device mapname\n"
24987 #: ../fish/guestfish-actions.pod:2708
24989 "If this block device contains LVM volume groups, then calling L</vgscan> "
24990 "followed by L</vg-activate-all> will make them visible."
24994 #: ../fish/guestfish-actions.pod:2715
24995 msgid "luks-open-ro"
24999 #: ../fish/guestfish-actions.pod:2717
25002 " luks-open-ro device mapname\n"
25007 #: ../fish/guestfish-actions.pod:2719
25009 "This is the same as L</luks-open> except that a read-only mapping is created."
25013 #: ../fish/guestfish-actions.pod:2725
25018 #: ../fish/guestfish-actions.pod:2727
25021 " lvcreate logvol volgroup mbytes\n"
25026 #: ../fish/guestfish-actions.pod:2732
25027 msgid "lvm-canonical-lv-name"
25031 #: ../fish/guestfish-actions.pod:2734
25034 " lvm-canonical-lv-name lvname\n"
25039 #: ../fish/guestfish-actions.pod:2743
25040 msgid "See also L</is-lv>."
25044 #: ../fish/guestfish-actions.pod:2745
25045 msgid "lvm-clear-filter"
25049 #: ../fish/guestfish-actions.pod:2747
25052 " lvm-clear-filter\n"
25057 #: ../fish/guestfish-actions.pod:2749
25059 "This undoes the effect of L</lvm-set-filter>. LVM will be able to see every "
25064 #: ../fish/guestfish-actions.pod:2755
25065 msgid "lvm-remove-all"
25069 #: ../fish/guestfish-actions.pod:2757
25072 " lvm-remove-all\n"
25077 #: ../fish/guestfish-actions.pod:2765
25078 msgid "lvm-set-filter"
25082 #: ../fish/guestfish-actions.pod:2767
25085 " lvm-set-filter 'devices ...'\n"
25090 #: ../fish/guestfish-actions.pod:2792
25095 #: ../fish/guestfish-actions.pod:2794
25098 " lvremove device\n"
25103 #: ../fish/guestfish-actions.pod:2802
25108 #: ../fish/guestfish-actions.pod:2804
25111 " lvrename logvol newlogvol\n"
25116 #: ../fish/guestfish-actions.pod:2808
25121 #: ../fish/guestfish-actions.pod:2810
25124 " lvresize device mbytes\n"
25129 #: ../fish/guestfish-actions.pod:2816
25130 msgid "lvresize-free"
25134 #: ../fish/guestfish-actions.pod:2818
25137 " lvresize-free lv percent\n"
25142 #: ../fish/guestfish-actions.pod:2826
25147 #: ../fish/guestfish-actions.pod:2828
25155 #: ../fish/guestfish-actions.pod:2836
25156 msgid "See also L</lvs-full>, L</list-filesystems>."
25160 #: ../fish/guestfish-actions.pod:2838
25165 #: ../fish/guestfish-actions.pod:2840
25173 #: ../fish/guestfish-actions.pod:2845
25178 #: ../fish/guestfish-actions.pod:2847
25186 #: ../fish/guestfish-actions.pod:2851
25191 #: ../fish/guestfish-actions.pod:2853
25194 " lxattrlist path 'names ...'\n"
25199 #: ../fish/guestfish-actions.pod:2869
25201 "This call is intended for programs that want to efficiently list a directory "
25202 "contents without making many round-trips. See also L</lstatlist> for a "
25203 "similarly efficient call for getting standard stats. Very long directory "
25204 "listings might cause the protocol message size to be exceeded, causing this "
25205 "call to fail. The caller must split up such requests into smaller groups of "
25210 #: ../fish/guestfish-actions.pod:2877
25215 #: ../fish/guestfish-actions.pod:2879
25223 #: ../fish/guestfish-actions.pod:2883
25228 #: ../fish/guestfish-actions.pod:2885
25231 " mkdir-mode path mode\n"
25236 #: ../fish/guestfish-actions.pod:2894
25237 msgid "See also L</mkdir>, L</umask>"
25241 #: ../fish/guestfish-actions.pod:2896
25246 #: ../fish/guestfish-actions.pod:2898
25254 #: ../fish/guestfish-actions.pod:2903
25259 #: ../fish/guestfish-actions.pod:2905
25262 " mkdtemp template\n"
25267 #: ../fish/guestfish-actions.pod:2926
25272 #: ../fish/guestfish-actions.pod:2928
25275 " mke2fs-J fstype blocksize device journal\n"
25280 #: ../fish/guestfish-actions.pod:2936
25281 msgid "See also L</mke2journal>."
25285 #: ../fish/guestfish-actions.pod:2938
25290 #: ../fish/guestfish-actions.pod:2940
25293 " mke2fs-JL fstype blocksize device label\n"
25298 #: ../fish/guestfish-actions.pod:2945
25299 msgid "See also L</mke2journal-L>."
25303 #: ../fish/guestfish-actions.pod:2947
25308 #: ../fish/guestfish-actions.pod:2949
25311 " mke2fs-JU fstype blocksize device uuid\n"
25316 #: ../fish/guestfish-actions.pod:2954
25317 msgid "See also L</mke2journal-U>."
25321 #: ../fish/guestfish-actions.pod:2956
25322 msgid "mke2journal"
25326 #: ../fish/guestfish-actions.pod:2958
25329 " mke2journal blocksize device\n"
25334 #: ../fish/guestfish-actions.pod:2965
25335 msgid "mke2journal-L"
25339 #: ../fish/guestfish-actions.pod:2967
25342 " mke2journal-L blocksize label device\n"
25347 #: ../fish/guestfish-actions.pod:2971
25348 msgid "mke2journal-U"
25352 #: ../fish/guestfish-actions.pod:2973
25355 " mke2journal-U blocksize uuid device\n"
25360 #: ../fish/guestfish-actions.pod:2977
25365 #: ../fish/guestfish-actions.pod:2979
25368 " mkfifo mode path\n"
25373 #: ../fish/guestfish-actions.pod:2981
25375 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
25376 "is just a convenient wrapper around L</mknod>."
25380 #: ../fish/guestfish-actions.pod:2987
25385 #: ../fish/guestfish-actions.pod:2989
25388 " mkfs fstype device\n"
25393 #: ../fish/guestfish-actions.pod:2995
25398 #: ../fish/guestfish-actions.pod:2997
25401 " mkfs-b fstype blocksize device\n"
25406 #: ../fish/guestfish-actions.pod:2999
25408 "This call is similar to L</mkfs>, but it allows you to control the block "
25409 "size of the resulting filesystem. Supported block sizes depend on the "
25410 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
25414 #: ../fish/guestfish-actions.pod:3007
25416 "This function is deprecated. In new code, use the L</mkfs_opts> call "
25421 #: ../fish/guestfish-actions.pod:3014
25426 #: ../fish/guestfish-actions.pod:3016
25429 " mkfs-opts fstype device [blocksize:..] [features:..]\n"
25434 #: ../fish/guestfish-actions.pod:3051
25435 msgid "mkmountpoint"
25439 #: ../fish/guestfish-actions.pod:3053
25442 " mkmountpoint exemptpath\n"
25447 #: ../fish/guestfish-actions.pod:3055
25449 "L</mkmountpoint> and L</rmmountpoint> are specialized calls that can be used "
25450 "to create extra mountpoints before mounting the first filesystem."
25454 #: ../fish/guestfish-actions.pod:3079
25456 "L</mkmountpoint> is not compatible with L</umount-all>. You may get "
25457 "unexpected errors if you try to mix these calls. It is safest to manually "
25458 "unmount filesystems and remove mountpoints after use."
25462 #: ../fish/guestfish-actions.pod:3083
25464 "L</umount-all> unmounts filesystems by sorting the paths longest first, so "
25465 "for this to work for manual mountpoints, you must ensure that the innermost "
25466 "mountpoints have the longest pathnames, as in the example code above."
25470 #: ../fish/guestfish-actions.pod:3090
25472 "Autosync [see L</set-autosync>, this is set by default on handles] can cause "
25473 "L</umount-all> to be called when the handle is closed which can also trigger "
25478 #: ../fish/guestfish-actions.pod:3094
25483 #: ../fish/guestfish-actions.pod:3096
25486 " mknod mode devmajor devminor path\n"
25491 #: ../fish/guestfish-actions.pod:3106
25493 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
25494 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
25495 "regular file). These constants are available in the standard Linux header "
25496 "files, or you can use L</mknod-b>, L</mknod-c> or L</mkfifo> which are "
25497 "wrappers around this command which bitwise OR in the appropriate constant "
25502 #: ../fish/guestfish-actions.pod:3116
25507 #: ../fish/guestfish-actions.pod:3118
25510 " mknod-b mode devmajor devminor path\n"
25515 #: ../fish/guestfish-actions.pod:3120
25517 "This call creates a block device node called C<path> with mode C<mode> and "
25518 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
25519 "wrapper around L</mknod>."
25523 #: ../fish/guestfish-actions.pod:3126
25528 #: ../fish/guestfish-actions.pod:3128
25531 " mknod-c mode devmajor devminor path\n"
25536 #: ../fish/guestfish-actions.pod:3130
25538 "This call creates a char device node called C<path> with mode C<mode> and "
25539 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
25540 "wrapper around L</mknod>."
25544 #: ../fish/guestfish-actions.pod:3136
25549 #: ../fish/guestfish-actions.pod:3138
25557 #: ../fish/guestfish-actions.pod:3142
25562 #: ../fish/guestfish-actions.pod:3144
25565 " mkswap-L label device\n"
25570 #: ../fish/guestfish-actions.pod:3152
25575 #: ../fish/guestfish-actions.pod:3154
25578 " mkswap-U uuid device\n"
25583 #: ../fish/guestfish-actions.pod:3158
25584 msgid "mkswap-file"
25588 #: ../fish/guestfish-actions.pod:3160
25591 " mkswap-file path\n"
25596 #: ../fish/guestfish-actions.pod:3164
25598 "This command just writes a swap file signature to an existing file. To "
25599 "create the file itself, use something like L</fallocate>."
25603 #: ../fish/guestfish-actions.pod:3167
25608 #: ../fish/guestfish-actions.pod:3169
25611 " modprobe modulename\n"
25616 #: ../fish/guestfish-actions.pod:3176
25621 #: ../fish/guestfish-actions.pod:3178
25624 " mount device mountpoint\n"
25629 #: ../fish/guestfish-actions.pod:3194
25631 "B<Important note:> When you use this call, the filesystem options C<sync> "
25632 "and C<noatime> are set implicitly. This was originally done because we "
25633 "thought it would improve reliability, but it turns out that I<-o sync> has a "
25634 "very large negative performance impact and negligible effect on "
25635 "reliability. Therefore we recommend that you avoid using L</mount> in any "
25636 "code that needs performance, and instead use L</mount-options> (use an empty "
25637 "string for the first parameter if you don't want any options)."
25641 #: ../fish/guestfish-actions.pod:3204
25643 "This function is deprecated. In new code, use the L</mount_options> call "
25648 #: ../fish/guestfish-actions.pod:3211
25653 #: ../fish/guestfish-actions.pod:3213
25656 " mount-loop file mountpoint\n"
25661 #: ../fish/guestfish-actions.pod:3219
25662 msgid "mount-options"
25666 #: ../fish/guestfish-actions.pod:3221
25669 " mount-options options device mountpoint\n"
25674 #: ../fish/guestfish-actions.pod:3223
25676 "This is the same as the L</mount> command, but it allows you to set the "
25677 "mount options as for the L<mount(8)> I<-o> flag."
25681 #: ../fish/guestfish-actions.pod:3231
25686 #: ../fish/guestfish-actions.pod:3233
25689 " mount-ro device mountpoint\n"
25694 #: ../fish/guestfish-actions.pod:3235
25696 "This is the same as the L</mount> command, but it mounts the filesystem with "
25697 "the read-only (I<-o ro>) flag."
25701 #: ../fish/guestfish-actions.pod:3238
25706 #: ../fish/guestfish-actions.pod:3240
25709 " mount-vfs options vfstype device mountpoint\n"
25714 #: ../fish/guestfish-actions.pod:3242
25716 "This is the same as the L</mount> command, but it allows you to set both the "
25717 "mount options and the vfstype as for the L<mount(8)> I<-o> and I<-t> flags."
25721 #: ../fish/guestfish-actions.pod:3246
25722 msgid "mountpoints"
25726 #: ../fish/guestfish-actions.pod:3248
25734 #: ../fish/guestfish-actions.pod:3250
25736 "This call is similar to L</mounts>. That call returns a list of devices. "
25737 "This one returns a hash table (map) of device name to directory where the "
25738 "device is mounted."
25742 #: ../fish/guestfish-actions.pod:3254
25747 #: ../fish/guestfish-actions.pod:3256
25755 #: ../fish/guestfish-actions.pod:3263
25756 msgid "See also: L</mountpoints>"
25760 #: ../fish/guestfish-actions.pod:3265
25765 #: ../fish/guestfish-actions.pod:3267
25773 #: ../fish/guestfish-actions.pod:3272
25774 msgid "ntfs-3g-probe"
25778 #: ../fish/guestfish-actions.pod:3274
25781 " ntfs-3g-probe true|false device\n"
25786 #: ../fish/guestfish-actions.pod:3288
25791 #: ../fish/guestfish-actions.pod:3290
25794 " ntfsresize device\n"
25799 #: ../fish/guestfish-actions.pod:3305
25800 msgid "ntfsresize-size"
25804 #: ../fish/guestfish-actions.pod:3307
25807 " ntfsresize-size device size\n"
25812 #: ../fish/guestfish-actions.pod:3309
25814 "This command is the same as L</ntfsresize> except that it allows you to "
25815 "specify the new size (in bytes) explicitly."
25819 #: ../fish/guestfish-actions.pod:3312
25824 #: ../fish/guestfish-actions.pod:3314
25827 " part-add device prlogex startsect endsect\n"
25832 #: ../fish/guestfish-actions.pod:3316
25834 "This command adds a partition to C<device>. If there is no partition table "
25835 "on the device, call L</part-init> first."
25839 #: ../fish/guestfish-actions.pod:3328
25841 "Creating a partition which covers the whole disk is not so easy. Use L</"
25842 "part-disk> to do that."
25846 #: ../fish/guestfish-actions.pod:3331
25851 #: ../fish/guestfish-actions.pod:3333
25854 " part-del device partnum\n"
25859 #: ../fish/guestfish-actions.pod:3341
25864 #: ../fish/guestfish-actions.pod:3343
25867 " part-disk device parttype\n"
25872 #: ../fish/guestfish-actions.pod:3345
25874 "This command is simply a combination of L</part-init> followed by L</part-"
25875 "add> to create a single primary partition covering the whole disk."
25879 #: ../fish/guestfish-actions.pod:3349
25881 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
25882 "possible values are described in L</part-init>."
25886 #: ../fish/guestfish-actions.pod:3355
25887 msgid "part-get-bootable"
25891 #: ../fish/guestfish-actions.pod:3357
25894 " part-get-bootable device partnum\n"
25899 #: ../fish/guestfish-actions.pod:3362
25900 msgid "See also L</part-set-bootable>."
25904 #: ../fish/guestfish-actions.pod:3364
25905 msgid "part-get-mbr-id"
25909 #: ../fish/guestfish-actions.pod:3366
25912 " part-get-mbr-id device partnum\n"
25917 #: ../fish/guestfish-actions.pod:3371 ../fish/guestfish-actions.pod:3509
25919 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
25920 "undefined results for other partition table types (see L</part-get-"
25925 #: ../fish/guestfish-actions.pod:3375
25926 msgid "part-get-parttype"
25930 #: ../fish/guestfish-actions.pod:3377
25933 " part-get-parttype device\n"
25938 #: ../fish/guestfish-actions.pod:3382
25940 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
25941 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
25942 "possible, although unusual. See L</part-init> for a full list."
25946 #: ../fish/guestfish-actions.pod:3387
25951 #: ../fish/guestfish-actions.pod:3389
25954 " part-init device parttype\n"
25959 #: ../fish/guestfish-actions.pod:3395
25961 "Initially there are no partitions. Following this, you should call L</part-"
25962 "add> for each partition required."
25966 #: ../fish/guestfish-actions.pod:3458
25971 #: ../fish/guestfish-actions.pod:3460
25974 " part-list device\n"
25979 #: ../fish/guestfish-actions.pod:3475
25981 "Start of the partition I<in bytes>. To get sectors you have to divide by "
25982 "the device's sector size, see L</blockdev-getss>."
25986 #: ../fish/guestfish-actions.pod:3488
25987 msgid "part-set-bootable"
25991 #: ../fish/guestfish-actions.pod:3490
25994 " part-set-bootable device partnum true|false\n"
25999 #: ../fish/guestfish-actions.pod:3499
26000 msgid "part-set-mbr-id"
26004 #: ../fish/guestfish-actions.pod:3501
26007 " part-set-mbr-id device partnum idbyte\n"
26012 #: ../fish/guestfish-actions.pod:3513
26013 msgid "part-set-name"
26017 #: ../fish/guestfish-actions.pod:3515
26020 " part-set-name device partnum name\n"
26025 #: ../fish/guestfish-actions.pod:3523
26026 msgid "part-to-dev"
26030 #: ../fish/guestfish-actions.pod:3525
26033 " part-to-dev partition\n"
26038 #: ../fish/guestfish-actions.pod:3531
26040 "The named partition must exist, for example as a string returned from L</"
26041 "list-partitions>."
26045 #: ../fish/guestfish-actions.pod:3534
26046 msgid "ping-daemon"
26050 #: ../fish/guestfish-actions.pod:3536
26058 #: ../fish/guestfish-actions.pod:3543
26063 #: ../fish/guestfish-actions.pod:3545
26066 " pread path count offset\n"
26071 #: ../fish/guestfish-actions.pod:3553
26072 msgid "See also L</pwrite>, L</pread-device>."
26076 #: ../fish/guestfish-actions.pod:3558
26077 msgid "pread-device"
26081 #: ../fish/guestfish-actions.pod:3560
26084 " pread-device device count offset\n"
26089 #: ../fish/guestfish-actions.pod:3568
26090 msgid "See also L</pread>."
26094 #: ../fish/guestfish-actions.pod:3573
26099 #: ../fish/guestfish-actions.pod:3575
26102 " pvcreate device\n"
26107 #: ../fish/guestfish-actions.pod:3581
26112 #: ../fish/guestfish-actions.pod:3583
26115 " pvremove device\n"
26120 #: ../fish/guestfish-actions.pod:3592
26125 #: ../fish/guestfish-actions.pod:3594
26128 " pvresize device\n"
26133 #: ../fish/guestfish-actions.pod:3599
26134 msgid "pvresize-size"
26138 #: ../fish/guestfish-actions.pod:3601
26141 " pvresize-size device size\n"
26146 #: ../fish/guestfish-actions.pod:3603
26148 "This command is the same as L</pvresize> except that it allows you to "
26149 "specify the new size (in bytes) explicitly."
26153 #: ../fish/guestfish-actions.pod:3606
26158 #: ../fish/guestfish-actions.pod:3608
26166 #: ../fish/guestfish-actions.pod:3616
26167 msgid "See also L</pvs-full>."
26171 #: ../fish/guestfish-actions.pod:3618
26176 #: ../fish/guestfish-actions.pod:3620
26184 #: ../fish/guestfish-actions.pod:3625
26189 #: ../fish/guestfish-actions.pod:3627
26197 #: ../fish/guestfish-actions.pod:3631
26202 #: ../fish/guestfish-actions.pod:3633
26205 " pwrite path content offset\n"
26210 #: ../fish/guestfish-actions.pod:3644
26211 msgid "See also L</pread>, L</pwrite-device>."
26215 #: ../fish/guestfish-actions.pod:3649
26216 msgid "pwrite-device"
26220 #: ../fish/guestfish-actions.pod:3651
26223 " pwrite-device device content offset\n"
26228 #: ../fish/guestfish-actions.pod:3661
26229 msgid "See also L</pwrite>."
26233 #: ../fish/guestfish-actions.pod:3666
26238 #: ../fish/guestfish-actions.pod:3668
26241 " read-file path\n"
26246 #: ../fish/guestfish-actions.pod:3673
26248 "Unlike L</cat>, this function can correctly handle files that contain "
26249 "embedded ASCII NUL characters. However unlike L</download>, this function "
26250 "is limited in the total size of file that can be handled."
26254 #: ../fish/guestfish-actions.pod:3681
26259 #: ../fish/guestfish-actions.pod:3683
26262 " read-lines path\n"
26267 #: ../fish/guestfish-actions.pod:3690
26269 "Note that this function cannot correctly handle binary files (specifically, "
26270 "files containing C<\\0> character which is treated as end of line). For "
26271 "those you need to use the L</read-file> function which has a more complex "
26276 #: ../fish/guestfish-actions.pod:3695
26281 #: ../fish/guestfish-actions.pod:3697
26289 #: ../fish/guestfish-actions.pod:3749
26291 "This function is primarily intended for use by programs. To get a simple "
26292 "list of names, use L</ls>. To get a printable directory for human "
26293 "consumption, use L</ll>."
26297 #: ../fish/guestfish-actions.pod:3753
26302 #: ../fish/guestfish-actions.pod:3755
26310 #: ../fish/guestfish-actions.pod:3759
26311 msgid "readlinklist"
26315 #: ../fish/guestfish-actions.pod:3761
26318 " readlinklist path 'names ...'\n"
26323 #: ../fish/guestfish-actions.pod:3785
26328 #: ../fish/guestfish-actions.pod:3787
26336 #: ../fish/guestfish-actions.pod:3792
26337 msgid "removexattr"
26341 #: ../fish/guestfish-actions.pod:3794
26344 " removexattr xattr path\n"
26349 #: ../fish/guestfish-actions.pod:3799
26350 msgid "See also: L</lremovexattr>, L<attr(5)>."
26354 #: ../fish/guestfish-actions.pod:3801
26359 #: ../fish/guestfish-actions.pod:3803
26362 " resize2fs device\n"
26367 #: ../fish/guestfish-actions.pod:3808
26369 "I<Note:> It is sometimes required that you run L</e2fsck-f> on the C<device> "
26370 "before calling this command. For unknown reasons C<resize2fs> sometimes "
26371 "gives an error about this and sometimes not. In any case, it is always safe "
26372 "to call L</e2fsck-f> before calling this function."
26376 #: ../fish/guestfish-actions.pod:3814
26377 msgid "resize2fs-M"
26381 #: ../fish/guestfish-actions.pod:3816
26384 " resize2fs-M device\n"
26389 #: ../fish/guestfish-actions.pod:3818
26391 "This command is the same as L</resize2fs>, but the filesystem is resized to "
26392 "its minimum size. This works like the I<-M> option to the C<resize2fs> "
26397 #: ../fish/guestfish-actions.pod:3822
26399 "To get the resulting size of the filesystem you should call L</tune2fs-l> "
26400 "and read the C<Block size> and C<Block count> values. These two numbers, "
26401 "multiplied together, give the resulting size of the minimal filesystem in "
26406 #: ../fish/guestfish-actions.pod:3827
26407 msgid "resize2fs-size"
26411 #: ../fish/guestfish-actions.pod:3829
26414 " resize2fs-size device size\n"
26419 #: ../fish/guestfish-actions.pod:3831
26421 "This command is the same as L</resize2fs> except that it allows you to "
26422 "specify the new size (in bytes) explicitly."
26426 #: ../fish/guestfish-actions.pod:3834
26431 #: ../fish/guestfish-actions.pod:3836
26439 #: ../fish/guestfish-actions.pod:3840
26444 #: ../fish/guestfish-actions.pod:3842
26452 #: ../fish/guestfish-actions.pod:3848
26457 #: ../fish/guestfish-actions.pod:3850
26465 #: ../fish/guestfish-actions.pod:3854
26466 msgid "rmmountpoint"
26470 #: ../fish/guestfish-actions.pod:3856
26473 " rmmountpoint exemptpath\n"
26478 #: ../fish/guestfish-actions.pod:3858
26480 "This calls removes a mountpoint that was previously created with L</"
26481 "mkmountpoint>. See L</mkmountpoint> for full details."
26485 #: ../fish/guestfish-actions.pod:3862
26486 msgid "scrub-device"
26490 #: ../fish/guestfish-actions.pod:3864
26493 " scrub-device device\n"
26498 #: ../fish/guestfish-actions.pod:3875
26503 #: ../fish/guestfish-actions.pod:3877
26506 " scrub-file file\n"
26511 #: ../fish/guestfish-actions.pod:3887
26512 msgid "scrub-freespace"
26516 #: ../fish/guestfish-actions.pod:3889
26519 " scrub-freespace dir\n"
26524 #: ../fish/guestfish-actions.pod:3891
26526 "This command creates the directory C<dir> and then fills it with files until "
26527 "the filesystem is full, and scrubs the files as for L</scrub-file>, and "
26528 "deletes them. The intention is to scrub any free space on the partition "
26529 "containing C<dir>."
26533 #: ../fish/guestfish-actions.pod:3900
26538 #: ../fish/guestfish-actions.pod:3902
26543 #: ../fish/guestfish-actions.pod:3904
26546 " set-append append\n"
26551 #: ../fish/guestfish-actions.pod:3915
26552 msgid "set-attach-method"
26556 #: ../fish/guestfish-actions.pod:3917
26557 msgid "attach-method"
26561 #: ../fish/guestfish-actions.pod:3919
26564 " set-attach-method attachmethod\n"
26569 #: ../fish/guestfish-actions.pod:3941
26570 msgid "set-autosync"
26574 #: ../fish/guestfish-actions.pod:3943
26579 #: ../fish/guestfish-actions.pod:3945
26582 " set-autosync true|false\n"
26587 #: ../fish/guestfish-actions.pod:3955
26592 #: ../fish/guestfish-actions.pod:3957
26597 #: ../fish/guestfish-actions.pod:3959
26600 " set-direct true|false\n"
26605 #: ../fish/guestfish-actions.pod:3965
26607 "One consequence of this is that log messages aren't caught by the library "
26608 "and handled by L</set-log-message-callback>, but go straight to stdout."
26612 #: ../fish/guestfish-actions.pod:3974
26613 msgid "set-e2label"
26617 #: ../fish/guestfish-actions.pod:3976
26620 " set-e2label device label\n"
26625 #: ../fish/guestfish-actions.pod:3982
26627 "You can use either L</tune2fs-l> or L</get-e2label> to return the existing "
26628 "label on a filesystem."
26632 #: ../fish/guestfish-actions.pod:3985
26637 #: ../fish/guestfish-actions.pod:3987
26640 " set-e2uuid device uuid\n"
26645 #: ../fish/guestfish-actions.pod:3994
26647 "You can use either L</tune2fs-l> or L</get-e2uuid> to return the existing "
26648 "UUID of a filesystem."
26652 #: ../fish/guestfish-actions.pod:3997
26653 msgid "set-memsize"
26657 #: ../fish/guestfish-actions.pod:3999
26662 #: ../fish/guestfish-actions.pod:4001
26665 " set-memsize memsize\n"
26670 #: ../fish/guestfish-actions.pod:4003
26672 "This sets the memory size in megabytes allocated to the qemu subprocess. "
26673 "This only has any effect if called before L</launch>."
26677 #: ../fish/guestfish-actions.pod:4014
26678 msgid "set-network"
26682 #: ../fish/guestfish-actions.pod:4016
26687 #: ../fish/guestfish-actions.pod:4018
26690 " set-network true|false\n"
26695 #: ../fish/guestfish-actions.pod:4026
26697 "You must call this before calling L</launch>, otherwise it has no effect."
26701 #: ../fish/guestfish-actions.pod:4029
26706 #: ../fish/guestfish-actions.pod:4031
26711 #: ../fish/guestfish-actions.pod:4033
26714 " set-path searchpath\n"
26719 #: ../fish/guestfish-actions.pod:4042
26724 #: ../fish/guestfish-actions.pod:4044
26729 #: ../fish/guestfish-actions.pod:4046
26737 #: ../fish/guestfish-actions.pod:4066
26738 msgid "set-recovery-proc"
26742 #: ../fish/guestfish-actions.pod:4068
26743 msgid "recovery-proc"
26747 #: ../fish/guestfish-actions.pod:4070
26750 " set-recovery-proc true|false\n"
26755 #: ../fish/guestfish-actions.pod:4072
26757 "If this is called with the parameter C<false> then L</launch> does not "
26758 "create a recovery process. The purpose of the recovery process is to stop "
26759 "runaway qemu processes in the case where the main program aborts abruptly."
26763 #: ../fish/guestfish-actions.pod:4077
26765 "This only has any effect if called before L</launch>, and the default is "
26770 #: ../fish/guestfish-actions.pod:4086
26771 msgid "set-selinux"
26775 #: ../fish/guestfish-actions.pod:4088
26780 #: ../fish/guestfish-actions.pod:4090
26783 " set-selinux true|false\n"
26788 #: ../fish/guestfish-actions.pod:4101
26793 #: ../fish/guestfish-actions.pod:4103
26798 #: ../fish/guestfish-actions.pod:4105
26801 " set-trace true|false\n"
26806 #: ../fish/guestfish-actions.pod:4117
26808 "Trace messages are normally sent to C<stderr>, unless you register a "
26809 "callback to send them somewhere else (see L</set-event-callback>)."
26813 #: ../fish/guestfish-actions.pod:4121
26814 msgid "set-verbose"
26818 #: ../fish/guestfish-actions.pod:4123
26823 #: ../fish/guestfish-actions.pod:4125
26826 " set-verbose true|false\n"
26831 #: ../fish/guestfish-actions.pod:4132
26833 "Verbose messages are normally sent to C<stderr>, unless you register a "
26834 "callback to send them somewhere else (see L</set-event-callback>)."
26838 #: ../fish/guestfish-actions.pod:4136
26843 #: ../fish/guestfish-actions.pod:4138
26846 " setcon context\n"
26851 #: ../fish/guestfish-actions.pod:4145
26856 #: ../fish/guestfish-actions.pod:4147
26859 " setxattr xattr val vallen path\n"
26864 #: ../fish/guestfish-actions.pod:4153
26865 msgid "See also: L</lsetxattr>, L<attr(5)>."
26869 #: ../fish/guestfish-actions.pod:4155
26874 #: ../fish/guestfish-actions.pod:4157
26877 " sfdisk device cyls heads sectors 'lines ...'\n"
26882 #: ../fish/guestfish-actions.pod:4179
26883 msgid "See also: L</sfdisk-l>, L</sfdisk-N>, L</part-init>"
26887 #: ../fish/guestfish-actions.pod:4185 ../fish/guestfish-actions.pod:4208
26888 #: ../fish/guestfish-actions.pod:4230
26890 "This function is deprecated. In new code, use the L</part_add> call instead."
26894 #: ../fish/guestfish-actions.pod:4192
26899 #: ../fish/guestfish-actions.pod:4194
26902 " sfdiskM device 'lines ...'\n"
26907 #: ../fish/guestfish-actions.pod:4196
26909 "This is a simplified interface to the L</sfdisk> command, where partition "
26910 "sizes are specified in megabytes only (rounded to the nearest cylinder) and "
26911 "you don't need to specify the cyls, heads and sectors parameters which were "
26912 "rarely if ever used anyway."
26916 #: ../fish/guestfish-actions.pod:4202
26917 msgid "See also: L</sfdisk>, the L<sfdisk(8)> manpage and L</part-disk>"
26921 #: ../fish/guestfish-actions.pod:4215
26926 #: ../fish/guestfish-actions.pod:4217
26929 " sfdisk-N device partnum cyls heads sectors line\n"
26934 #: ../fish/guestfish-actions.pod:4222
26936 "For other parameters, see L</sfdisk>. You should usually pass C<0> for the "
26937 "cyls/heads/sectors parameters."
26941 #: ../fish/guestfish-actions.pod:4225
26942 msgid "See also: L</part-add>"
26946 #: ../fish/guestfish-actions.pod:4237
26947 msgid "sfdisk-disk-geometry"
26951 #: ../fish/guestfish-actions.pod:4239
26954 " sfdisk-disk-geometry device\n"
26959 #: ../fish/guestfish-actions.pod:4241
26961 "This displays the disk geometry of C<device> read from the partition table. "
26962 "Especially in the case where the underlying block device has been resized, "
26963 "this can be different from the kernel's idea of the geometry (see L</sfdisk-"
26964 "kernel-geometry>)."
26968 #: ../fish/guestfish-actions.pod:4249
26969 msgid "sfdisk-kernel-geometry"
26973 #: ../fish/guestfish-actions.pod:4251
26976 " sfdisk-kernel-geometry device\n"
26981 #: ../fish/guestfish-actions.pod:4258
26986 #: ../fish/guestfish-actions.pod:4260
26989 " sfdisk-l device\n"
26994 #: ../fish/guestfish-actions.pod:4266
26995 msgid "See also: L</part-list>"
26999 #: ../fish/guestfish-actions.pod:4268
27001 "This function is deprecated. In new code, use the L</part_list> call "
27006 #: ../fish/guestfish-actions.pod:4275
27011 #: ../fish/guestfish-actions.pod:4277
27019 #: ../fish/guestfish-actions.pod:4282
27020 msgid "This is like L</command>, but passes the command to:"
27024 #: ../fish/guestfish-actions.pod:4290
27025 msgid "All the provisos about L</command> apply to this call."
27029 #: ../fish/guestfish-actions.pod:4292
27034 #: ../fish/guestfish-actions.pod:4294
27037 " sh-lines command\n"
27042 #: ../fish/guestfish-actions.pod:4296
27043 msgid "This is the same as L</sh>, but splits the result into a list of lines."
27047 #: ../fish/guestfish-actions.pod:4299
27048 msgid "See also: L</command-lines>"
27052 #: ../fish/guestfish-actions.pod:4301
27057 #: ../fish/guestfish-actions.pod:4303
27065 #: ../fish/guestfish-actions.pod:4307
27070 #: ../fish/guestfish-actions.pod:4309
27078 #: ../fish/guestfish-actions.pod:4315
27083 #: ../fish/guestfish-actions.pod:4317
27091 #: ../fish/guestfish-actions.pod:4325
27096 #: ../fish/guestfish-actions.pod:4327
27104 #: ../fish/guestfish-actions.pod:4335
27109 #: ../fish/guestfish-actions.pod:4337
27112 " strings-e encoding path\n"
27117 #: ../fish/guestfish-actions.pod:4339
27119 "This is like the L</strings> command, but allows you to specify the encoding "
27120 "of strings that are looked for in the source file C<path>."
27124 #: ../fish/guestfish-actions.pod:4349
27126 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
27127 "ISO-8859-X (this is what L</strings> uses)."
27131 #: ../fish/guestfish-actions.pod:4381
27132 msgid "swapoff-device"
27136 #: ../fish/guestfish-actions.pod:4383
27139 " swapoff-device device\n"
27144 #: ../fish/guestfish-actions.pod:4385
27146 "This command disables the libguestfs appliance swap device or partition "
27147 "named C<device>. See L</swapon-device>."
27151 #: ../fish/guestfish-actions.pod:4389
27152 msgid "swapoff-file"
27156 #: ../fish/guestfish-actions.pod:4391
27159 " swapoff-file file\n"
27164 #: ../fish/guestfish-actions.pod:4395
27165 msgid "swapoff-label"
27169 #: ../fish/guestfish-actions.pod:4397
27172 " swapoff-label label\n"
27177 #: ../fish/guestfish-actions.pod:4402
27178 msgid "swapoff-uuid"
27182 #: ../fish/guestfish-actions.pod:4404
27185 " swapoff-uuid uuid\n"
27190 #: ../fish/guestfish-actions.pod:4409
27191 msgid "swapon-device"
27195 #: ../fish/guestfish-actions.pod:4411
27198 " swapon-device device\n"
27203 #: ../fish/guestfish-actions.pod:4413
27205 "This command enables the libguestfs appliance to use the swap device or "
27206 "partition named C<device>. The increased memory is made available for all "
27207 "commands, for example those run using L</command> or L</sh>."
27211 #: ../fish/guestfish-actions.pod:4425
27212 msgid "swapon-file"
27216 #: ../fish/guestfish-actions.pod:4427
27219 " swapon-file file\n"
27224 #: ../fish/guestfish-actions.pod:4429
27226 "This command enables swap to a file. See L</swapon-device> for other notes."
27230 #: ../fish/guestfish-actions.pod:4432
27231 msgid "swapon-label"
27235 #: ../fish/guestfish-actions.pod:4434
27238 " swapon-label label\n"
27243 #: ../fish/guestfish-actions.pod:4436
27245 "This command enables swap to a labeled swap partition. See L</swapon-"
27246 "device> for other notes."
27250 #: ../fish/guestfish-actions.pod:4439
27251 msgid "swapon-uuid"
27255 #: ../fish/guestfish-actions.pod:4441
27258 " swapon-uuid uuid\n"
27263 #: ../fish/guestfish-actions.pod:4443
27265 "This command enables swap to a swap partition with the given UUID. See L</"
27266 "swapon-device> for other notes."
27270 #: ../fish/guestfish-actions.pod:4446
27275 #: ../fish/guestfish-actions.pod:4448
27283 #: ../fish/guestfish-actions.pod:4456
27288 #: ../fish/guestfish-actions.pod:4458
27296 #: ../fish/guestfish-actions.pod:4466
27301 #: ../fish/guestfish-actions.pod:4468
27304 " tail-n nrlines path\n"
27309 #: ../fish/guestfish-actions.pod:4481
27314 #: ../fish/guestfish-actions.pod:4483
27317 " tar-in (tarfile|-) directory\n"
27322 #: ../fish/guestfish-actions.pod:4488
27323 msgid "To upload a compressed tarball, use L</tgz-in> or L</txz-in>."
27327 #: ../fish/guestfish-actions.pod:4493
27332 #: ../fish/guestfish-actions.pod:4495
27335 " tar-out directory (tarfile|-)\n"
27340 #: ../fish/guestfish-actions.pod:4500
27341 msgid "To download a compressed tarball, use L</tgz-out> or L</txz-out>."
27345 #: ../fish/guestfish-actions.pod:4505
27350 #: ../fish/guestfish-actions.pod:4507
27353 " tgz-in (tarball|-) directory\n"
27358 #: ../fish/guestfish-actions.pod:4512
27359 msgid "To upload an uncompressed tarball, use L</tar-in>."
27363 #: ../fish/guestfish-actions.pod:4516
27368 #: ../fish/guestfish-actions.pod:4518
27371 " tgz-out directory (tarball|-)\n"
27376 #: ../fish/guestfish-actions.pod:4523
27377 msgid "To download an uncompressed tarball, use L</tar-out>."
27381 #: ../fish/guestfish-actions.pod:4527
27386 #: ../fish/guestfish-actions.pod:4529
27394 #: ../fish/guestfish-actions.pod:4538
27399 #: ../fish/guestfish-actions.pod:4540
27407 #: ../fish/guestfish-actions.pod:4545
27408 msgid "truncate-size"
27412 #: ../fish/guestfish-actions.pod:4547
27415 " truncate-size path size\n"
27420 #: ../fish/guestfish-actions.pod:4552
27422 "If the current file size is less than C<size> then the file is extended to "
27423 "the required size with zero bytes. This creates a sparse file (ie. disk "
27424 "blocks are not allocated for the file until you write to it). To create a "
27425 "non-sparse file of zeroes, use L</fallocate64> instead."
27429 #: ../fish/guestfish-actions.pod:4558
27434 #: ../fish/guestfish-actions.pod:4560
27437 " tune2fs-l device\n"
27442 #: ../fish/guestfish-actions.pod:4570
27447 #: ../fish/guestfish-actions.pod:4572
27450 " txz-in (tarball|-) directory\n"
27455 #: ../fish/guestfish-actions.pod:4579
27460 #: ../fish/guestfish-actions.pod:4581
27463 " txz-out directory (tarball|-)\n"
27468 #: ../fish/guestfish-actions.pod:4588
27473 #: ../fish/guestfish-actions.pod:4590
27481 #: ../fish/guestfish-actions.pod:4604
27482 msgid "See also L</get-umask>, L<umask(2)>, L</mknod>, L</mkdir>."
27486 #: ../fish/guestfish-actions.pod:4609
27491 #: ../fish/guestfish-actions.pod:4611
27496 #: ../fish/guestfish-actions.pod:4613
27499 " umount pathordevice\n"
27504 #: ../fish/guestfish-actions.pod:4619
27509 #: ../fish/guestfish-actions.pod:4621
27510 msgid "unmount-all"
27514 #: ../fish/guestfish-actions.pod:4623
27522 #: ../fish/guestfish-actions.pod:4629
27527 #: ../fish/guestfish-actions.pod:4631
27530 " upload (filename|-) remotefilename\n"
27535 #: ../fish/guestfish-actions.pod:4638
27536 msgid "See also L</download>."
27540 #: ../fish/guestfish-actions.pod:4642
27541 msgid "upload-offset"
27545 #: ../fish/guestfish-actions.pod:4644
27548 " upload-offset (filename|-) remotefilename offset\n"
27553 #: ../fish/guestfish-actions.pod:4656
27555 "Note that there is no limit on the amount of data that can be uploaded with "
27556 "this call, unlike with L</pwrite>, and this call always writes the full "
27557 "amount unless an error occurs."
27561 #: ../fish/guestfish-actions.pod:4661
27562 msgid "See also L</upload>, L</pwrite>."
27566 #: ../fish/guestfish-actions.pod:4665
27571 #: ../fish/guestfish-actions.pod:4667
27574 " utimens path atsecs atnsecs mtsecs mtnsecs\n"
27579 #: ../fish/guestfish-actions.pod:4686
27584 #: ../fish/guestfish-actions.pod:4688
27592 #: ../fish/guestfish-actions.pod:4715
27594 "I<Note:> Don't use this call to test for availability of features. In "
27595 "enterprise distributions we backport features from later versions into "
27596 "earlier versions, making this an unreliable way to test for features. Use "
27597 "L</available> instead."
27601 #: ../fish/guestfish-actions.pod:4721
27606 #: ../fish/guestfish-actions.pod:4723
27609 " vfs-label device\n"
27614 #: ../fish/guestfish-actions.pod:4730
27615 msgid "To find a filesystem from the label, use L</findfs-label>."
27619 #: ../fish/guestfish-actions.pod:4732
27624 #: ../fish/guestfish-actions.pod:4734
27627 " vfs-type device\n"
27632 #: ../fish/guestfish-actions.pod:4744
27637 #: ../fish/guestfish-actions.pod:4746
27640 " vfs-uuid device\n"
27645 #: ../fish/guestfish-actions.pod:4753
27646 msgid "To find a filesystem from the UUID, use L</findfs-uuid>."
27650 #: ../fish/guestfish-actions.pod:4755
27651 msgid "vg-activate"
27655 #: ../fish/guestfish-actions.pod:4757
27658 " vg-activate true|false 'volgroups ...'\n"
27663 #: ../fish/guestfish-actions.pod:4770
27664 msgid "vg-activate-all"
27668 #: ../fish/guestfish-actions.pod:4772
27671 " vg-activate-all true|false\n"
27676 #: ../fish/guestfish-actions.pod:4782
27681 #: ../fish/guestfish-actions.pod:4784
27684 " vgcreate volgroup 'physvols ...'\n"
27689 #: ../fish/guestfish-actions.pod:4789
27694 #: ../fish/guestfish-actions.pod:4791
27697 " vglvuuids vgname\n"
27702 #: ../fish/guestfish-actions.pod:4796
27704 "You can use this along with L</lvs> and L</lvuuid> calls to associate "
27705 "logical volumes and volume groups."
27709 #: ../fish/guestfish-actions.pod:4799
27710 msgid "See also L</vgpvuuids>."
27714 #: ../fish/guestfish-actions.pod:4801
27719 #: ../fish/guestfish-actions.pod:4803
27722 " vgpvuuids vgname\n"
27727 #: ../fish/guestfish-actions.pod:4808
27729 "You can use this along with L</pvs> and L</pvuuid> calls to associate "
27730 "physical volumes and volume groups."
27734 #: ../fish/guestfish-actions.pod:4811
27735 msgid "See also L</vglvuuids>."
27739 #: ../fish/guestfish-actions.pod:4813
27744 #: ../fish/guestfish-actions.pod:4815
27747 " vgremove vgname\n"
27752 #: ../fish/guestfish-actions.pod:4822
27757 #: ../fish/guestfish-actions.pod:4824
27760 " vgrename volgroup newvolgroup\n"
27765 #: ../fish/guestfish-actions.pod:4828
27770 #: ../fish/guestfish-actions.pod:4830
27778 #: ../fish/guestfish-actions.pod:4838
27779 msgid "See also L</vgs-full>."
27783 #: ../fish/guestfish-actions.pod:4840
27788 #: ../fish/guestfish-actions.pod:4842
27796 #: ../fish/guestfish-actions.pod:4847
27801 #: ../fish/guestfish-actions.pod:4849
27809 #: ../fish/guestfish-actions.pod:4854
27814 #: ../fish/guestfish-actions.pod:4856
27822 #: ../fish/guestfish-actions.pod:4860
27827 #: ../fish/guestfish-actions.pod:4862
27835 #: ../fish/guestfish-actions.pod:4867
27840 #: ../fish/guestfish-actions.pod:4869
27848 #: ../fish/guestfish-actions.pod:4874
27853 #: ../fish/guestfish-actions.pod:4876
27861 #: ../fish/guestfish-actions.pod:4881
27866 #: ../fish/guestfish-actions.pod:4883
27869 " write path content\n"
27874 #: ../fish/guestfish-actions.pod:4891
27879 #: ../fish/guestfish-actions.pod:4893
27882 " write-file path content size\n"
27887 #: ../fish/guestfish-actions.pod:4909
27889 "This function is deprecated. In new code, use the L</write> call instead."
27893 #: ../fish/guestfish-actions.pod:4916
27898 #: ../fish/guestfish-actions.pod:4918
27901 " zegrep regex path\n"
27906 #: ../fish/guestfish-actions.pod:4926
27911 #: ../fish/guestfish-actions.pod:4928
27914 " zegrepi regex path\n"
27919 #: ../fish/guestfish-actions.pod:4936
27924 #: ../fish/guestfish-actions.pod:4938
27932 #: ../fish/guestfish-actions.pod:4946
27933 msgid "See also: L</zero-device>, L</scrub-device>."
27937 #: ../fish/guestfish-actions.pod:4948
27938 msgid "zero-device"
27942 #: ../fish/guestfish-actions.pod:4950
27945 " zero-device device\n"
27950 #: ../fish/guestfish-actions.pod:4952
27952 "This command writes zeroes over the entire C<device>. Compare with L</zero> "
27953 "which just zeroes the first few blocks of a device."
27957 #: ../fish/guestfish-actions.pod:4959
27962 #: ../fish/guestfish-actions.pod:4961
27965 " zerofree device\n"
27970 #: ../fish/guestfish-actions.pod:4974
27975 #: ../fish/guestfish-actions.pod:4976
27978 " zfgrep pattern path\n"
27983 #: ../fish/guestfish-actions.pod:4984
27988 #: ../fish/guestfish-actions.pod:4986
27991 " zfgrepi pattern path\n"
27996 #: ../fish/guestfish-actions.pod:4994
28001 #: ../fish/guestfish-actions.pod:4996
28004 " zfile meth path\n"
28009 #: ../fish/guestfish-actions.pod:5003
28011 "Since 1.0.63, use L</file> instead which can now process compressed files."
28015 #: ../fish/guestfish-actions.pod:5006
28017 "This function is deprecated. In new code, use the L</file> call instead."
28021 #: ../fish/guestfish-actions.pod:5013
28026 #: ../fish/guestfish-actions.pod:5015
28029 " zgrep regex path\n"
28034 #: ../fish/guestfish-actions.pod:5023
28039 #: ../fish/guestfish-actions.pod:5025
28042 " zgrepi regex path\n"
28047 #: ../fish/guestfish-commands.pod:1
28052 #: ../fish/guestfish-commands.pod:3
28057 #: ../fish/guestfish-commands.pod:5
28060 " alloc filename size\n"
28065 #: ../fish/guestfish-commands.pod:7
28067 "This creates an empty (zeroed) file of the given size, and then adds so it "
28068 "can be further examined."
28072 #: ../fish/guestfish-commands.pod:10 ../fish/guestfish-commands.pod:168
28073 msgid "For more advanced image creation, see L<qemu-img(1)> utility."
28077 #: ../fish/guestfish-commands.pod:12 ../fish/guestfish-commands.pod:170
28078 msgid "Size can be specified using standard suffixes, eg. C<1M>."
28082 #: ../fish/guestfish-commands.pod:14
28084 "To create a sparse file, use L</sparse> instead. To create a prepared disk "
28085 "image, see L</PREPARED DISK IMAGES>."
28089 #: ../fish/guestfish-commands.pod:17
28094 #: ../fish/guestfish-commands.pod:19
28097 " copy-in local [local ...] /remotedir\n"
28102 #: ../fish/guestfish-commands.pod:21
28104 "C<copy-in> copies local files or directories recursively into the disk "
28105 "image, placing them in the directory called C</remotedir> (which must "
28106 "exist). This guestfish meta-command turns into a sequence of L</tar-in> and "
28107 "other commands as necessary."
28111 #: ../fish/guestfish-commands.pod:26
28113 "Multiple local files and directories can be specified, but the last "
28114 "parameter must always be a remote directory. Wildcards cannot be used."
28118 #: ../fish/guestfish-commands.pod:30
28123 #: ../fish/guestfish-commands.pod:32
28126 " copy-out remote [remote ...] localdir\n"
28131 #: ../fish/guestfish-commands.pod:34
28133 "C<copy-out> copies remote files or directories recursively out of the disk "
28134 "image, placing them on the host disk in a local directory called C<localdir> "
28135 "(which must exist). This guestfish meta-command turns into a sequence of L</"
28136 "download>, L</tar-out> and other commands as necessary."
28140 #: ../fish/guestfish-commands.pod:40
28142 "Multiple remote files and directories can be specified, but the last "
28143 "parameter must always be a local directory. To download to the current "
28144 "directory, use C<.> as in:"
28148 #: ../fish/guestfish-commands.pod:44
28151 " copy-out /home .\n"
28156 #: ../fish/guestfish-commands.pod:46
28158 "Wildcards cannot be used in the ordinary command, but you can use them with "
28159 "the help of L</glob> like this:"
28163 #: ../fish/guestfish-commands.pod:49
28166 " glob copy-out /home/* .\n"
28171 #: ../fish/guestfish-commands.pod:51
28176 #: ../fish/guestfish-commands.pod:53
28179 " echo [params ...]\n"
28184 #: ../fish/guestfish-commands.pod:55
28185 msgid "This echos the parameters to the terminal."
28189 #: ../fish/guestfish-commands.pod:57
28194 #: ../fish/guestfish-commands.pod:59
28199 #: ../fish/guestfish-commands.pod:61
28204 #: ../fish/guestfish-commands.pod:63
28212 #: ../fish/guestfish-commands.pod:65
28214 "This is used to edit a file. It downloads the file, edits it locally using "
28215 "your editor, then uploads the result."
28219 #: ../fish/guestfish-commands.pod:68
28221 "The editor is C<$EDITOR>. However if you use the alternate commands C<vi> "
28222 "or C<emacs> you will get those corresponding editors."
28226 #: ../fish/guestfish-commands.pod:72
28231 #: ../fish/guestfish-commands.pod:74
28234 " glob command args...\n"
28239 #: ../fish/guestfish-commands.pod:76
28241 "Expand wildcards in any paths in the args list, and run C<command> "
28242 "repeatedly on each matching path."
28246 #: ../fish/guestfish-commands.pod:79
28247 msgid "See L</WILDCARDS AND GLOBBING>."
28251 #: ../fish/guestfish-commands.pod:81
28256 #: ../fish/guestfish-commands.pod:83
28259 " hexedit <filename|device>\n"
28260 " hexedit <filename|device> <max>\n"
28261 " hexedit <filename|device> <start> <max>\n"
28266 #: ../fish/guestfish-commands.pod:87
28268 "Use hexedit (a hex editor) to edit all or part of a binary file or block "
28273 #: ../fish/guestfish-commands.pod:90
28275 "This command works by downloading potentially the whole file or device, "
28276 "editing it locally, then uploading it. If the file or device is large, you "
28277 "have to specify which part you wish to edit by using C<max> and/or C<start> "
28278 "C<max> parameters. C<start> and C<max> are specified in bytes, with the "
28279 "usual modifiers allowed such as C<1M> (1 megabyte)."
28283 #: ../fish/guestfish-commands.pod:97
28284 msgid "For example to edit the first few sectors of a disk you might do:"
28288 #: ../fish/guestfish-commands.pod:100
28291 " hexedit /dev/sda 1M\n"
28296 #: ../fish/guestfish-commands.pod:102
28298 "which would allow you to edit anywhere within the first megabyte of the disk."
28302 #: ../fish/guestfish-commands.pod:105
28303 msgid "To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:"
28307 #: ../fish/guestfish-commands.pod:107
28310 " hexedit /dev/sda1 0x400 0x400\n"
28315 #: ../fish/guestfish-commands.pod:109
28316 msgid "(assuming the superblock is in the standard location)."
28320 #: ../fish/guestfish-commands.pod:111
28322 "This command requires the external L<hexedit(1)> program. You can specify "
28323 "another program to use by setting the C<HEXEDITOR> environment variable."
28327 #: ../fish/guestfish-commands.pod:115
28328 msgid "See also L</hexdump>."
28332 #: ../fish/guestfish-commands.pod:117
28337 #: ../fish/guestfish-commands.pod:119
28345 #: ../fish/guestfish-commands.pod:121
28347 "Change the local directory, ie. the current directory of guestfish itself."
28351 #: ../fish/guestfish-commands.pod:124
28352 msgid "Note that C<!cd> won't do what you might expect."
28356 #: ../fish/guestfish-commands.pod:126
28361 #: ../fish/guestfish-commands.pod:128
28366 #: ../fish/guestfish-commands.pod:130
28374 #: ../fish/guestfish-commands.pod:132
28375 msgid "Opens the manual page for guestfish."
28379 #: ../fish/guestfish-commands.pod:134
28384 #: ../fish/guestfish-commands.pod:136
28389 #: ../fish/guestfish-commands.pod:138
28397 #: ../fish/guestfish-commands.pod:140
28405 #: ../fish/guestfish-commands.pod:142
28406 msgid "This is used to view a file."
28410 #: ../fish/guestfish-commands.pod:144
28412 "The default viewer is C<$PAGER>. However if you use the alternate command "
28413 "C<less> you will get the C<less> command specifically."
28417 #: ../fish/guestfish-commands.pod:147
28422 #: ../fish/guestfish-commands.pod:149
28430 #: ../fish/guestfish-commands.pod:151
28432 "Close and reopen the libguestfs handle. It is not necessary to use this "
28433 "normally, because the handle is closed properly when guestfish exits. "
28434 "However this is occasionally useful for testing."
28438 #: ../fish/guestfish-commands.pod:155
28443 #: ../fish/guestfish-commands.pod:157
28446 " sparse filename size\n"
28451 #: ../fish/guestfish-commands.pod:159
28453 "This creates an empty sparse file of the given size, and then adds so it can "
28454 "be further examined."
28458 #: ../fish/guestfish-commands.pod:162
28460 "In all respects it works the same as the L</alloc> command, except that the "
28461 "image file is allocated sparsely, which means that disk blocks are not "
28462 "assigned to the file until they are needed. Sparse disk files only use "
28463 "space when written to, but they are slower and there is a danger you could "
28464 "run out of real disk space during a write operation."
28468 #: ../fish/guestfish-commands.pod:172
28473 #: ../fish/guestfish-commands.pod:174
28481 #: ../fish/guestfish-commands.pod:176
28483 "This command returns a list of the optional groups known to the daemon, and "
28484 "indicates which ones are supported by this build of the libguestfs appliance."
28488 #: ../fish/guestfish-commands.pod:180
28489 msgid "See also L<guestfs(3)/AVAILABILITY>."
28493 #: ../fish/guestfish-commands.pod:182
28498 #: ../fish/guestfish-commands.pod:184
28501 " time command args...\n"
28506 #: ../fish/guestfish-commands.pod:186
28508 "Run the command as usual, but print the elapsed time afterwards. This can "
28509 "be useful for benchmarking operations."
28513 #: ../test-tool/libguestfs-test-tool.pod:5
28514 msgid "libguestfs-test-tool - End user tests for libguestfs"
28518 #: ../test-tool/libguestfs-test-tool.pod:9
28521 " libguestfs-test-tool [--options]\n"
28526 #: ../test-tool/libguestfs-test-tool.pod:13
28528 "libguestfs-test-tool is a test program shipped with libguestfs to end users "
28529 "and developers, to allow them to check basic libguestfs functionality is "
28530 "working. This is needed because libguestfs occasionally breaks for reasons "
28531 "beyond our control: usually because of changes in the underlying qemu or "
28532 "kernel packages, or the host environment."
28536 #: ../test-tool/libguestfs-test-tool.pod:20
28537 msgid "If you suspect a problem in libguestfs, then just run:"
28541 #: ../test-tool/libguestfs-test-tool.pod:22
28544 " libguestfs-test-tool\n"
28549 #: ../test-tool/libguestfs-test-tool.pod:24
28550 msgid "It will print lots of diagnostic messages."
28554 #: ../test-tool/libguestfs-test-tool.pod:26
28555 msgid "If it runs to completion successfully, you will see this near the end:"
28559 #: ../test-tool/libguestfs-test-tool.pod:28
28562 " ===== TEST FINISHED OK =====\n"
28567 #: ../test-tool/libguestfs-test-tool.pod:30
28568 msgid "and the test tool will exit with code 0."
28572 #: ../test-tool/libguestfs-test-tool.pod:32
28574 "If it fails (and/or exits with non-zero error code), please paste the "
28575 "B<complete, unedited> output of the test tool into a bug report. More "
28576 "information about reporting bugs can be found on the L<http://libguestfs.org/"
28581 #: ../test-tool/libguestfs-test-tool.pod:41
28586 #: ../test-tool/libguestfs-test-tool.pod:43
28587 msgid "Display short usage information and exit."
28591 #: ../test-tool/libguestfs-test-tool.pod:45
28592 msgid "I<--qemu qemu_binary>"
28596 #: ../test-tool/libguestfs-test-tool.pod:47
28598 "If you have downloaded another qemu binary, point this option at the full "
28599 "path of the binary to try it."
28603 #: ../test-tool/libguestfs-test-tool.pod:50
28604 msgid "I<--qemudir qemu_source_dir>"
28608 #: ../test-tool/libguestfs-test-tool.pod:52
28610 "If you have compiled qemu from source, point this option at the source "
28611 "directory to try it."
28615 #: ../test-tool/libguestfs-test-tool.pod:55
28616 msgid "I<--timeout N>"
28620 #: ../test-tool/libguestfs-test-tool.pod:57
28622 "Set the launch timeout to C<N> seconds. The default is 120 seconds which "
28623 "does not usually need to be adjusted unless your machine is very slow."
28627 #: ../test-tool/libguestfs-test-tool.pod:63
28628 msgid "TRYING OUT A DIFFERENT VERSION OF QEMU"
28632 #: ../test-tool/libguestfs-test-tool.pod:65
28634 "If you have compiled another version of qemu from source and would like to "
28635 "try that, then you can use the I<--qemudir> option to point to the qemu "
28636 "source directory."
28640 #: ../test-tool/libguestfs-test-tool.pod:69
28642 "If you have downloaded a qemu binary from somewhere, use the I<--qemu> "
28643 "option to point to the binary."
28647 #: ../test-tool/libguestfs-test-tool.pod:72
28649 "When using an alternate qemu with libguestfs, usually you would need to "
28650 "write a qemu wrapper script (see section I<QEMU WRAPPERS> in L<guestfs(3)"
28651 ">). libguestfs-test-tool writes a temporary qemu wrapper script when you "
28652 "use either of the I<--qemudir> or I<--qemu> options."
28656 #: ../test-tool/libguestfs-test-tool.pod:79
28658 "libguestfs-test-tool returns I<0> if the tests completed without error, or "
28659 "I<1> if there was an error."
28663 #: ../test-tool/libguestfs-test-tool.pod:84
28665 "For the full list of environment variables which may affect libguestfs, "
28666 "please see the L<guestfs(3)> manual page."
28670 #: ../test-tool/libguestfs-test-tool.pod:89
28671 msgid "L<guestfs(3)>, L<http://libguestfs.org/>, L<http://qemu.org/>."
28675 #: ../fuse/guestmount.pod:5
28677 "guestmount - Mount a guest filesystem on the host using FUSE and libguestfs"
28681 #: ../fuse/guestmount.pod:9
28684 " guestmount [--options] -a disk.img -m device [--ro] mountpoint\n"
28689 #: ../fuse/guestmount.pod:11
28692 " guestmount [--options] -a disk.img -i [--ro] mountpoint\n"
28697 #: ../fuse/guestmount.pod:13
28700 " guestmount [--options] -d Guest -i [--ro] mountpoint\n"
28705 #: ../fuse/guestmount.pod:17
28707 "You must I<not> use C<guestmount> in read-write mode on live virtual "
28708 "machines. If you do this, you risk disk corruption in the VM."
28712 #: ../fuse/guestmount.pod:22
28714 "The guestmount program can be used to mount virtual machine filesystems and "
28715 "other disk images on the host. It uses libguestfs for access to the guest "
28716 "filesystem, and FUSE (the \"filesystem in userspace\") to make it appear as "
28717 "a mountable device."
28721 #: ../fuse/guestmount.pod:27
28723 "Along with other options, you have to give at least one device (I<-a> "
28724 "option) or libvirt domain (I<-d> option), and at least one mountpoint (I<-m> "
28725 "option) or use the I<-i> inspection option. How this works is better "
28726 "explained in the L<guestfish(1)> manual page, or by looking at the examples "
28731 #: ../fuse/guestmount.pod:33
28733 "FUSE lets you mount filesystems as non-root. The mountpoint must be owned "
28734 "by you, and the filesystem will not be visible to any other users unless you "
28735 "make certain global configuration changes to C</etc/fuse.conf>. To unmount "
28736 "the filesystem, use the C<fusermount -u> command."
28740 #: ../fuse/guestmount.pod:41
28742 "For a typical Windows guest which has its main filesystem on the first "
28747 #: ../fuse/guestmount.pod:44
28750 " guestmount -a windows.img -m /dev/sda1 --ro /mnt\n"
28755 #: ../fuse/guestmount.pod:46
28757 "For a typical Linux guest which has a /boot filesystem on the first "
28758 "partition, and the root filesystem on a logical volume:"
28762 #: ../fuse/guestmount.pod:49
28765 " guestmount -a linux.img -m /dev/VG/LV -m /dev/sda1:/boot --ro /mnt\n"
28770 #: ../fuse/guestmount.pod:51
28771 msgid "To get libguestfs to detect guest mountpoints for you:"
28775 #: ../fuse/guestmount.pod:53
28778 " guestmount -a guest.img -i --ro /mnt\n"
28783 #: ../fuse/guestmount.pod:55
28784 msgid "For a libvirt guest called \"Guest\" you could do:"
28788 #: ../fuse/guestmount.pod:57
28791 " guestmount -d Guest -i --ro /mnt\n"
28796 #: ../fuse/guestmount.pod:59
28798 "If you don't know what filesystems are contained in a guest or disk image, "
28799 "use L<virt-filesystems(1)> first:"
28803 #: ../fuse/guestmount.pod:62
28806 " virt-filesystems MyGuest\n"
28811 #: ../fuse/guestmount.pod:64
28813 "If you want to trace the libguestfs calls but without excessive debugging "
28814 "information, we recommend:"
28818 #: ../fuse/guestmount.pod:67
28821 " guestmount [...] --trace /mnt\n"
28826 #: ../fuse/guestmount.pod:69
28827 msgid "If you want to debug the program, we recommend:"
28831 #: ../fuse/guestmount.pod:71
28834 " guestmount [...] --trace --verbose /mnt\n"
28839 #: ../fuse/guestmount.pod:73
28844 #: ../fuse/guestmount.pod:75
28845 msgid "Other users cannot see the filesystem by default"
28849 #: ../fuse/guestmount.pod:77
28851 "If you mount a filesystem as one user (eg. root), then other users will not "
28852 "be able to see it by default. The fix is to add the FUSE C<allow_other> "
28853 "option when mounting:"
28857 #: ../fuse/guestmount.pod:81
28860 " sudo guestmount [...] -o allow_other /mnt\n"
28865 #: ../fuse/guestmount.pod:87
28866 msgid "B<-a image> | B<--add image>"
28870 #: ../fuse/guestmount.pod:89
28871 msgid "Add a block device or virtual machine image."
28875 #: ../fuse/guestmount.pod:94
28876 msgid "B<-c URI> | B<--connect URI>"
28880 #: ../fuse/guestmount.pod:100
28881 msgid "B<-d libvirt-domain> | B<--domain libvirt-domain>"
28885 #: ../fuse/guestmount.pod:106
28886 msgid "B<--dir-cache-timeout N>"
28890 #: ../fuse/guestmount.pod:108
28892 "Set the readdir cache timeout to I<N> seconds, the default being 60 "
28893 "seconds. The readdir cache [actually, there are several semi-independent "
28894 "caches] is populated after a readdir(2) call with the stat and extended "
28895 "attributes of the files in the directory, in anticipation that they will be "
28896 "requested soon after."
28900 #: ../fuse/guestmount.pod:114
28902 "There is also a different attribute cache implemented by FUSE (see the FUSE "
28903 "option I<-o attr_timeout>), but the FUSE cache does not anticipate future "
28904 "requests, only cache existing ones."
28908 #: ../fuse/guestmount.pod:125
28909 msgid "B<--format=raw|qcow2|..> | B<--format>"
28913 #: ../fuse/guestmount.pod:132
28915 "If you have untrusted raw-format guest disk images, you should use this "
28916 "option to specify the disk format. This avoids a possible security problem "
28917 "with malicious guests (CVE-2010-3851). See also L<guestfs(3)/"
28918 "guestfs_add_drive_opts>."
28922 #: ../fuse/guestmount.pod:137
28923 msgid "B<--fuse-help>"
28927 #: ../fuse/guestmount.pod:139
28928 msgid "Display help on special FUSE options (see I<-o> below)."
28932 #: ../fuse/guestmount.pod:143
28933 msgid "Display brief help and exit."
28937 #: ../fuse/guestmount.pod:145
28938 msgid "B<-i> | B<--inspector>"
28942 #: ../fuse/guestmount.pod:165
28944 "Mount the named partition or logical volume on the given mountpoint B<in the "
28945 "guest> (this has nothing to do with mountpoints in the host)."
28949 #: ../fuse/guestmount.pod:168
28951 "If the mountpoint is omitted, it defaults to C</>. You have to mount "
28952 "something on C</>."
28956 #: ../fuse/guestmount.pod:181
28957 msgid "B<-n> | B<--no-sync>"
28961 #: ../fuse/guestmount.pod:183
28963 "By default, we attempt to sync the guest disk when the FUSE mountpoint is "
28964 "unmounted. If you specify this option, then we don't attempt to sync the "
28965 "disk. See the discussion of autosync in the L<guestfs(3)> manpage."
28969 #: ../fuse/guestmount.pod:188
28970 msgid "B<-o option> | B<--option option>"
28974 #: ../fuse/guestmount.pod:190
28975 msgid "Pass extra options to FUSE."
28979 #: ../fuse/guestmount.pod:192
28981 "To get a list of all the extra options supported by FUSE, use the command "
28982 "below. Note that only the FUSE I<-o> options can be passed, and only some "
28983 "of them are a good idea."
28987 #: ../fuse/guestmount.pod:196
28990 " guestmount --fuse-help\n"
28995 #: ../fuse/guestmount.pod:198
28996 msgid "Some potentially useful FUSE options:"
29000 #: ../fuse/guestmount.pod:202
29001 msgid "B<-o allow_other>"
29005 #: ../fuse/guestmount.pod:204
29006 msgid "Allow other users to see the filesystem."
29010 #: ../fuse/guestmount.pod:206
29011 msgid "B<-o attr_timeout=N>"
29015 #: ../fuse/guestmount.pod:208
29016 msgid "Enable attribute caching by FUSE, and set the timeout to I<N> seconds."
29020 #: ../fuse/guestmount.pod:210
29021 msgid "B<-o kernel_cache>"
29025 #: ../fuse/guestmount.pod:212
29027 "Allow the kernel to cache files (reduces the number of reads that have to go "
29028 "through the L<guestfs(3)> API). This is generally a good idea if you can "
29029 "afford the extra memory usage."
29033 #: ../fuse/guestmount.pod:216
29034 msgid "B<-o uid=N> B<-o gid=N>"
29038 #: ../fuse/guestmount.pod:218
29040 "Use these options to map all UIDs and GIDs inside the guest filesystem to "
29041 "the chosen values."
29045 #: ../fuse/guestmount.pod:223
29046 msgid "B<-r> | B<--ro>"
29050 #: ../fuse/guestmount.pod:225
29052 "Add devices and mount everything read-only. Also disallow writes and make "
29053 "the disk appear read-only to FUSE."
29057 #: ../fuse/guestmount.pod:228
29059 "This is highly recommended if you are not going to edit the guest disk. If "
29060 "the guest is running and this option is I<not> supplied, then there is a "
29061 "strong risk of disk corruption in the guest. We try to prevent this from "
29062 "happening, but it is not always possible."
29066 #: ../fuse/guestmount.pod:233
29067 msgid "See also L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
29071 #: ../fuse/guestmount.pod:237
29072 msgid "Enable SELinux support for the guest."
29076 #: ../fuse/guestmount.pod:239
29077 msgid "B<-v> | B<--verbose>"
29081 #: ../fuse/guestmount.pod:241
29082 msgid "Enable verbose messages from underlying libguestfs."
29086 #: ../fuse/guestmount.pod:243
29087 msgid "B<-V> | B<--version>"
29091 #: ../fuse/guestmount.pod:245
29092 msgid "Display the program version and exit."
29096 #: ../fuse/guestmount.pod:247
29097 msgid "B<-w> | B<--rw>"
29101 #: ../fuse/guestmount.pod:252 ../fuse/guestmount.pod:273
29102 msgid "See L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
29106 #: ../fuse/guestmount.pod:254
29107 msgid "B<-x> | B<--trace>"
29111 #: ../fuse/guestmount.pod:256
29112 msgid "Trace libguestfs calls and entry into each FUSE function."
29116 #: ../fuse/guestmount.pod:258
29117 msgid "This also stops the daemon from forking into the background."
29121 #: ../fuse/guestmount.pod:279
29123 "L<guestfish(1)>, L<virt-inspector(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
29124 "L<virt-tar(1)>, L<guestfs(3)>, L<http://libguestfs.org/>, L<http://fuse.sf."
29129 #: ../fuse/guestmount.pod:294
29130 msgid "Copyright (C) 2009-2010 Red Hat Inc. L<http://libguestfs.org/>"
29134 #: ../tools/virt-edit.pl:34
29135 msgid "virt-edit - Edit a file in a virtual machine"
29139 #: ../tools/virt-edit.pl:38
29142 " virt-edit [--options] domname file\n"
29147 #: ../tools/virt-edit.pl:40
29150 " virt-edit [--options] disk.img [disk.img ...] file\n"
29155 #: ../tools/virt-edit.pl:42
29158 " virt-edit [domname|disk.img] file -e 'expr'\n"
29163 #: ../tools/virt-edit.pl:46
29165 "You must I<not> use C<virt-edit> on live virtual machines. If you do this, "
29166 "you risk disk corruption in the VM. C<virt-edit> tries to stop you from "
29167 "doing this, but doesn't catch all cases."
29171 #: ../tools/virt-edit.pl:52
29173 "C<virt-edit> is a command line tool to edit C<file> where C<file> exists in "
29174 "the named virtual machine (or disk image)."
29178 #: ../tools/virt-edit.pl:55
29179 msgid "If you want to just view a file, use L<virt-cat(1)>."
29183 #: ../tools/virt-edit.pl:57
29185 "For more complex cases you should look at the L<guestfish(1)> tool (see L</"
29186 "USING GUESTFISH> below)."
29190 #: ../tools/virt-edit.pl:60
29192 "C<virt-edit> cannot be used to create a new file, nor to edit multiple "
29193 "files. L<guestfish(1)> can do that and much more."
29197 #: ../tools/virt-edit.pl:65
29198 msgid "Edit the named files interactively:"
29202 #: ../tools/virt-edit.pl:67
29205 " virt-edit mydomain /boot/grub/grub.conf\n"
29210 #: ../tools/virt-edit.pl:69
29213 " virt-edit mydomain /etc/passwd\n"
29218 #: ../tools/virt-edit.pl:71
29219 msgid "For Windows guests, some Windows paths are understood:"
29223 #: ../tools/virt-edit.pl:73
29226 " virt-edit mywindomain 'c:\\autoexec.bat'\n"
29231 #: ../tools/virt-edit.pl:75
29233 "You can also edit files non-interactively (see L</NON-INTERACTIVE EDITING> "
29234 "below). To change the init default level to 5:"
29238 #: ../tools/virt-edit.pl:79
29241 " virt-edit mydomain /etc/inittab -e 's/^id:.*/id:5:initdefault:/'\n"
29246 #: ../tools/virt-edit.pl:91 ../tools/virt-win-reg.pl:106
29247 #: ../tools/virt-list-filesystems.pl:63 ../tools/virt-tar.pl:113
29248 #: ../tools/virt-make-fs.pl:163 ../tools/virt-list-partitions.pl:64
29249 msgid "Display brief help."
29253 #: ../tools/virt-edit.pl:99 ../tools/virt-win-reg.pl:114
29254 #: ../tools/virt-list-filesystems.pl:71 ../tools/virt-tar.pl:121
29255 #: ../tools/virt-make-fs.pl:171 ../tools/virt-list-partitions.pl:72
29256 msgid "Display version number and exit."
29260 #: ../tools/virt-edit.pl:105
29261 msgid "B<--backup extension> | B<-b extension>"
29265 #: ../tools/virt-edit.pl:107
29267 "Create a backup of the original file I<in the guest disk image>. The backup "
29268 "has the original filename with C<extension> added."
29272 #: ../tools/virt-edit.pl:110
29274 "Usually the first character of C<extension> would be a dot C<.> so you would "
29279 #: ../tools/virt-edit.pl:113
29282 " virt-edit -b .orig [etc]\n"
29287 #: ../tools/virt-edit.pl:115
29288 msgid "By default, no backup file is made."
29292 #: ../tools/virt-edit.pl:121 ../tools/virt-win-reg.pl:128
29293 #: ../tools/virt-list-filesystems.pl:77 ../tools/virt-tar.pl:127
29294 #: ../tools/virt-list-partitions.pl:78
29295 msgid "B<--connect URI> | B<-c URI>"
29299 #: ../tools/virt-edit.pl:123 ../tools/virt-win-reg.pl:130
29300 #: ../tools/virt-list-filesystems.pl:79 ../tools/virt-tar.pl:129
29301 #: ../tools/virt-list-partitions.pl:80
29303 "If using libvirt, connect to the given I<URI>. If omitted, then we connect "
29304 "to the default libvirt hypervisor."
29308 #: ../tools/virt-edit.pl:126 ../tools/virt-win-reg.pl:133
29309 #: ../tools/virt-list-filesystems.pl:82 ../tools/virt-tar.pl:132
29310 #: ../tools/virt-list-partitions.pl:83
29312 "If you specify guest block devices directly, then libvirt is not used at all."
29316 #: ../tools/virt-edit.pl:133 ../tools/virt-win-reg.pl:140
29317 #: ../tools/virt-list-filesystems.pl:89 ../tools/virt-tar.pl:139
29318 #: ../tools/virt-list-partitions.pl:90
29319 msgid "B<--format> raw"
29323 #: ../tools/virt-edit.pl:135 ../tools/virt-win-reg.pl:142
29324 #: ../tools/virt-list-filesystems.pl:91 ../tools/virt-tar.pl:141
29325 #: ../tools/virt-list-partitions.pl:92
29327 "Specify the format of disk images given on the command line. If this is "
29328 "omitted then the format is autodetected from the content of the disk image."
29332 #: ../tools/virt-edit.pl:139 ../tools/virt-win-reg.pl:146
29333 #: ../tools/virt-list-filesystems.pl:95 ../tools/virt-tar.pl:145
29334 #: ../tools/virt-list-partitions.pl:96
29336 "If disk images are requested from libvirt, then this program asks libvirt "
29337 "for this information. In this case, the value of the format parameter is "
29342 #: ../tools/virt-edit.pl:143 ../tools/virt-win-reg.pl:150
29343 #: ../tools/virt-list-filesystems.pl:99 ../tools/virt-tar.pl:149
29344 #: ../tools/virt-list-partitions.pl:100
29346 "If working with untrusted raw-format guest disk images, you should ensure "
29347 "the format is always specified."
29351 #: ../tools/virt-edit.pl:150
29352 msgid "B<--expr EXPR> | B<-e EXPR>"
29356 #: ../tools/virt-edit.pl:152
29358 "Instead of launching the external editor, non-interactively apply the Perl "
29359 "expression C<EXPR> to each line in the file. See L</NON-INTERACTIVE "
29364 #: ../tools/virt-edit.pl:156
29366 "Be careful to properly quote the expression to prevent it from being altered "
29371 #: ../tools/virt-edit.pl:280
29372 msgid "NON-INTERACTIVE EDITING"
29376 #: ../tools/virt-edit.pl:282
29378 "C<virt-edit> normally calls out to C<$EDITOR> (or vi) so the system "
29379 "administrator can interactively edit the file."
29383 #: ../tools/virt-edit.pl:285
29385 "There are two ways also to use C<virt-edit> from scripts in order to make "
29386 "automated edits to files. (Note that although you I<can> use C<virt-edit> "
29387 "like this, it's less error-prone to write scripts directly using the "
29388 "libguestfs API and Augeas for configuration file editing.)"
29392 #: ../tools/virt-edit.pl:291
29394 "The first method is to temporarily set C<$EDITOR> to any script or program "
29395 "you want to run. The script is invoked as C<$EDITOR tmpfile> and it should "
29396 "update C<tmpfile> in place however it likes."
29400 #: ../tools/virt-edit.pl:295
29402 "The second method is to use the I<-e> parameter of C<virt-edit> to run a "
29403 "short Perl snippet in the style of L<sed(1)>. For example to replace all "
29404 "instances of C<foo> with C<bar> in a file:"
29408 #: ../tools/virt-edit.pl:299
29411 " virt-edit domname filename -e 's/foo/bar/'\n"
29416 #: ../tools/virt-edit.pl:301
29418 "The full power of Perl regular expressions can be used (see L<perlre(1)>). "
29419 "For example to delete root's password you could do:"
29423 #: ../tools/virt-edit.pl:304
29426 " virt-edit domname /etc/passwd -e 's/^root:.*?:/root::/'\n"
29431 #: ../tools/virt-edit.pl:306
29433 "What really happens is that the snippet is evaluated as a Perl expression "
29434 "for each line of the file. The line, including the final C<\\n>, is passed "
29435 "in C<$_> and the expression should update C<$_> or leave it unchanged."
29439 #: ../tools/virt-edit.pl:311
29441 "To delete a line, set C<$_> to the empty string. For example, to delete the "
29442 "C<apache> user account from the password file you can do:"
29446 #: ../tools/virt-edit.pl:314
29449 " virt-edit mydomain /etc/passwd -e '$_ = \"\" if /^apache:/'\n"
29454 #: ../tools/virt-edit.pl:316
29456 "To insert a line, prepend or append it to C<$_>. However appending lines to "
29457 "the end of the file is rather difficult this way since there is no concept "
29458 "of \"last line of the file\" - your expression just doesn't get called "
29459 "again. You might want to use the first method (setting C<$EDITOR>) if you "
29464 #: ../tools/virt-edit.pl:322
29466 "The variable C<$lineno> contains the current line number. As is "
29467 "traditional, the first line in the file is number C<1>."
29471 #: ../tools/virt-edit.pl:325
29473 "The return value from the expression is ignored, but the expression may call "
29474 "C<die> in order to abort the whole program, leaving the original file "
29479 #: ../tools/virt-edit.pl:329
29481 "Remember when matching the end of a line that C<$_> may contain the final C<"
29482 "\\n>, or (for DOS files) C<\\r\\n>, or if the file does not end with a "
29483 "newline then neither of these. Thus to match or substitute some text at the "
29484 "end of a line, use this regular expression:"
29488 #: ../tools/virt-edit.pl:334
29491 " /some text(\\r?\\n)?$/\n"
29496 #: ../tools/virt-edit.pl:336
29498 "Alternately, use the perl C<chomp> function, being careful not to chomp C<"
29499 "$_> itself (since that would remove all newlines from the file):"
29503 #: ../tools/virt-edit.pl:340
29506 " my $m = $_; chomp $m; $m =~ /some text$/\n"
29511 #: ../tools/virt-edit.pl:344
29513 "C<virt-edit> has a limited ability to understand Windows drive letters and "
29514 "paths (eg. C<E:\\foo\\bar.txt>)."
29518 #: ../tools/virt-edit.pl:347
29519 msgid "If and only if the guest is running Windows then:"
29523 #: ../tools/virt-edit.pl:353
29525 "Drive letter prefixes like C<C:> are resolved against the Windows Registry "
29526 "to the correct filesystem."
29530 #: ../tools/virt-edit.pl:358
29532 "Any backslash (C<\\>) characters in the path are replaced with forward "
29533 "slashes so that libguestfs can process it."
29537 #: ../tools/virt-edit.pl:363
29539 "The path is resolved case insensitively to locate the file that should be "
29544 #: ../tools/virt-edit.pl:368
29545 msgid "There are some known shortcomings:"
29549 #: ../tools/virt-edit.pl:374
29550 msgid "Some NTFS symbolic links may not be followed correctly."
29554 #: ../tools/virt-edit.pl:378
29555 msgid "NTFS junction points that cross filesystems are not followed."
29559 #: ../tools/virt-edit.pl:435
29560 msgid "USING GUESTFISH"
29564 #: ../tools/virt-edit.pl:437
29566 "L<guestfish(1)> is a more powerful, lower level tool which you can use when "
29567 "C<virt-edit> doesn't work."
29571 #: ../tools/virt-edit.pl:440
29572 msgid "Using C<virt-edit> is approximately equivalent to doing:"
29576 #: ../tools/virt-edit.pl:442
29579 " guestfish --rw -i -d domname edit /file\n"
29584 #: ../tools/virt-edit.pl:444
29586 "where C<domname> is the name of the libvirt guest, and C</file> is the full "
29587 "path to the file."
29591 #: ../tools/virt-edit.pl:447
29593 "The command above uses libguestfs's guest inspection feature and so does not "
29594 "work on guests that libguestfs cannot inspect, or on things like arbitrary "
29595 "disk images that don't contain guests. To edit a file on a disk image "
29600 #: ../tools/virt-edit.pl:452
29603 " guestfish --rw -a disk.img -m /dev/sda1 edit /file\n"
29608 #: ../tools/virt-edit.pl:454
29610 "where C<disk.img> is the disk image, C</dev/sda1> is the filesystem within "
29611 "the disk image to edit, and C</file> is the full path to the file."
29615 #: ../tools/virt-edit.pl:458
29617 "C<virt-edit> cannot create new files. Use the guestfish commands C<touch>, "
29618 "C<write> or C<upload> instead:"
29622 #: ../tools/virt-edit.pl:461
29625 " guestfish --rw -i -d domname touch /newfile\n"
29630 #: ../tools/virt-edit.pl:463
29633 " guestfish --rw -i -d domname write /newfile \"new content\"\n"
29638 #: ../tools/virt-edit.pl:465
29641 " guestfish --rw -i -d domname upload localfile /newfile\n"
29646 #: ../tools/virt-edit.pl:467
29648 "C<virt-edit> cannot edit multiple files, but guestfish can do it like this:"
29652 #: ../tools/virt-edit.pl:470
29655 " guestfish --rw -i -d domname edit /file1 : edit /file2\n"
29660 #: ../tools/virt-edit.pl:480
29665 #: ../tools/virt-edit.pl:482
29667 "If set, this string is used as the editor. It may contain arguments, eg. C<"
29672 #: ../tools/virt-edit.pl:485
29673 msgid "If not set, C<vi> is used."
29677 #: ../tools/virt-edit.pl:489 ../tools/virt-win-reg.pl:559
29678 #: ../tools/virt-list-filesystems.pl:182 ../tools/virt-tar.pl:279
29679 #: ../tools/virt-make-fs.pl:532 ../tools/virt-list-partitions.pl:250
29680 msgid "SHELL QUOTING"
29684 #: ../tools/virt-edit.pl:491 ../tools/virt-win-reg.pl:567
29685 #: ../tools/virt-list-filesystems.pl:184 ../tools/virt-tar.pl:281
29686 #: ../tools/virt-make-fs.pl:534 ../tools/virt-list-partitions.pl:252
29688 "Libvirt guest names can contain arbitrary characters, some of which have "
29689 "meaning to the shell such as C<#> and space. You may need to quote or "
29690 "escape these characters on the command line. See the shell manual page L<sh"
29691 "(1)> for details."
29695 #: ../tools/virt-edit.pl:498
29697 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, L<virt-"
29698 "tar-in(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, "
29699 "L<http://libguestfs.org/>, L<perl(1)>, L<perlre(1)>."
29703 #: ../tools/virt-edit.pl:510 ../tools/virt-win-reg.pl:598
29704 #: ../tools/virt-list-filesystems.pl:202 ../tools/virt-tar.pl:301
29705 #: ../tools/virt-make-fs.pl:564 ../tools/virt-list-partitions.pl:269
29710 #: ../tools/virt-edit.pl:512 ../tools/virt-win-reg.pl:600
29711 #: ../tools/virt-list-filesystems.pl:204 ../tools/virt-tar.pl:303
29712 #: ../tools/virt-make-fs.pl:566 ../tools/virt-list-partitions.pl:271
29713 msgid "Richard W.M. Jones L<http://people.redhat.com/~rjones/>"
29717 #: ../tools/virt-edit.pl:516
29718 msgid "Copyright (C) 2009-2011 Red Hat Inc."
29722 #: ../tools/virt-win-reg.pl:37
29724 "virt-win-reg - Export and merge Windows Registry entries from a Windows guest"
29728 #: ../tools/virt-win-reg.pl:41
29731 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey'\n"
29736 #: ../tools/virt-win-reg.pl:43
29739 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' name\n"
29744 #: ../tools/virt-win-reg.pl:45
29747 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' @\n"
29752 #: ../tools/virt-win-reg.pl:47
29755 " virt-win-reg --merge domname [input.reg ...]\n"
29760 #: ../tools/virt-win-reg.pl:49
29763 " virt-win-reg [--options] disk.img ... # instead of domname\n"
29768 #: ../tools/virt-win-reg.pl:53
29770 "You must I<not> use C<virt-win-reg> with the I<--merge> option on live "
29771 "virtual machines. If you do this, you I<will> get irreversible disk "
29772 "corruption in the VM. C<virt-win-reg> tries to stop you from doing this, "
29773 "but doesn't catch all cases."
29777 #: ../tools/virt-win-reg.pl:58
29779 "Modifying the Windows Registry is an inherently risky operation. The format "
29780 "is deliberately obscure and undocumented, and Registry changes can leave the "
29781 "system unbootable. Therefore when using the I<--merge> option, make sure "
29782 "you have a reliable backup first."
29786 #: ../tools/virt-win-reg.pl:65
29788 "This program can export and merge Windows Registry entries from a Windows "
29793 #: ../tools/virt-win-reg.pl:68
29795 "The first parameter is the libvirt guest name or the raw disk image of a "
29800 #: ../tools/virt-win-reg.pl:71
29802 "If I<--merge> is I<not> specified, then the chosen registry key is displayed/"
29803 "exported (recursively). For example:"
29807 #: ../tools/virt-win-reg.pl:74
29810 " $ virt-win-reg Windows7 'HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft'\n"
29815 #: ../tools/virt-win-reg.pl:76
29817 "You can also display single values from within registry keys, for example:"
29821 #: ../tools/virt-win-reg.pl:79
29824 " $ cvkey='HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion'\n"
29825 " $ virt-win-reg Windows7 $cvkey ProductName\n"
29826 " Windows 7 Enterprise\n"
29831 #: ../tools/virt-win-reg.pl:83
29833 "With I<--merge>, you can merge a textual regedit file into the Windows "
29838 #: ../tools/virt-win-reg.pl:86
29841 " $ virt-win-reg --merge Windows7 changes.reg\n"
29846 #: ../tools/virt-win-reg.pl:88 ../tools/virt-tar.pl:45
29851 #: ../tools/virt-win-reg.pl:90
29853 "This program is only meant for simple access to the registry. If you want "
29854 "to do complicated things with the registry, we suggest you download the "
29855 "Registry hive files from the guest using L<libguestfs(3)> or L<guestfish(1)> "
29856 "and access them locally, eg. using L<hivex(3)>, L<hivexsh(1)> or "
29857 "L<hivexregedit(1)>."
29861 #: ../tools/virt-win-reg.pl:120 ../tools/virt-make-fs.pl:177
29866 #: ../tools/virt-win-reg.pl:122
29867 msgid "Enable debugging messages."
29871 #: ../tools/virt-win-reg.pl:157
29876 #: ../tools/virt-win-reg.pl:159
29878 "In merge mode, this merges a textual regedit file into the Windows Registry "
29879 "of the virtual machine. If this flag is I<not> given then virt-win-reg "
29880 "displays or exports Registry entries instead."
29884 #: ../tools/virt-win-reg.pl:163
29886 "Note that I<--merge> is I<unsafe> to use on live virtual machines, and will "
29887 "result in disk corruption. However exporting (without this flag) is always "
29892 #: ../tools/virt-win-reg.pl:171
29893 msgid "B<--encoding> UTF-16LE|ASCII"
29897 #: ../tools/virt-win-reg.pl:173
29899 "When merging (only), you may need to specify the encoding for strings to be "
29900 "used in the hive file. This is explained in detail in L<Win::Hivex::Regedit"
29901 "(3)/ENCODING STRINGS>."
29905 #: ../tools/virt-win-reg.pl:177
29907 "The default is to use UTF-16LE, which should work with recent versions of "
29912 #: ../tools/virt-win-reg.pl:402
29913 msgid "SUPPORTED SYSTEMS"
29917 #: ../tools/virt-win-reg.pl:404
29919 "The program currently supports Windows NT-derived guests starting with "
29920 "Windows XP through to at least Windows 7."
29924 #: ../tools/virt-win-reg.pl:407
29926 "Registry support is done for C<HKEY_LOCAL_MACHINE\\SAM>, C<HKEY_LOCAL_MACHINE"
29927 "\\SECURITY>, C<HKEY_LOCAL_MACHINE\\SOFTWARE>, C<HKEY_LOCAL_MACHINE\\SYSTEM> "
29928 "and C<HKEY_USERS\\.DEFAULT>."
29932 #: ../tools/virt-win-reg.pl:411
29934 "You can use C<HKLM> as a shorthand for C<HKEY_LOCAL_MACHINE>, and C<HKU> for "
29939 #: ../tools/virt-win-reg.pl:414
29941 "C<HKEY_USERS\\$SID> and C<HKEY_CURRENT_USER> are B<not> supported at this "
29946 #: ../tools/virt-win-reg.pl:417
29951 #: ../tools/virt-win-reg.pl:419
29953 "C<virt-win-reg> expects that regedit files have already been reencoded in "
29954 "the local encoding. Usually on Linux hosts, this means UTF-8 with Unix-"
29955 "style line endings. Since Windows regedit files are often in UTF-16LE with "
29956 "Windows-style line endings, you may need to reencode the whole file before "
29957 "or after processing."
29961 #: ../tools/virt-win-reg.pl:425
29963 "To reencode a file from Windows format to Linux (before processing it with "
29964 "the I<--merge> option), you would do something like this:"
29968 #: ../tools/virt-win-reg.pl:428
29971 " iconv -f utf-16le -t utf-8 < win.reg | dos2unix > linux.reg\n"
29976 #: ../tools/virt-win-reg.pl:430
29978 "To go in the opposite direction, after exporting and before sending the file "
29979 "to a Windows user, do something like this:"
29983 #: ../tools/virt-win-reg.pl:433
29986 " unix2dos linux.reg | iconv -f utf-8 -t utf-16le > win.reg\n"
29991 #: ../tools/virt-win-reg.pl:435
29992 msgid "For more information about encoding, see L<Win::Hivex::Regedit(3)>."
29996 #: ../tools/virt-win-reg.pl:437
29998 "If you are unsure about the current encoding, use the L<file(1)> command. "
29999 "Recent versions of Windows regedit.exe produce a UTF-16LE file with Windows-"
30000 "style (CRLF) line endings, like this:"
30004 #: ../tools/virt-win-reg.pl:441
30007 " $ file software.reg\n"
30008 " software.reg: Little-endian UTF-16 Unicode text, with very long lines,\n"
30009 " with CRLF line terminators\n"
30014 #: ../tools/virt-win-reg.pl:445
30015 msgid "This file would need conversion before you could I<--merge> it."
30019 #: ../tools/virt-win-reg.pl:447
30020 msgid "CurrentControlSet etc."
30024 #: ../tools/virt-win-reg.pl:449
30026 "Registry keys like C<CurrentControlSet> don't really exist in the Windows "
30027 "Registry at the level of the hive file, and therefore you cannot modify "
30032 #: ../tools/virt-win-reg.pl:453
30034 "C<CurrentControlSet> is usually an alias for C<ControlSet001>. In some "
30035 "circumstances it might refer to another control set. The way to find out is "
30036 "to look at the C<HKLM\\SYSTEM\\Select> key:"
30040 #: ../tools/virt-win-reg.pl:457
30043 " # virt-win-reg WindowsGuest 'HKLM\\SYSTEM\\Select'\n"
30044 " [HKEY_LOCAL_MACHINE\\SYSTEM\\Select]\n"
30045 " \"Current\"=dword:00000001\n"
30046 " \"Default\"=dword:00000001\n"
30047 " \"Failed\"=dword:00000000\n"
30048 " \"LastKnownGood\"=dword:00000002\n"
30053 #: ../tools/virt-win-reg.pl:464
30054 msgid "\"Current\" is the one which Windows will choose when it boots."
30058 #: ../tools/virt-win-reg.pl:466
30060 "Similarly, other C<Current...> keys in the path may need to be replaced."
30064 #: ../tools/virt-win-reg.pl:469
30065 msgid "WINDOWS TIPS"
30069 #: ../tools/virt-win-reg.pl:471
30071 "Note that some of these tips modify the guest disk image. The guest I<must> "
30072 "be shut off, else you will get disk corruption."
30076 #: ../tools/virt-win-reg.pl:474
30077 msgid "RUNNING A BATCH SCRIPT WHEN A USER LOGS IN"
30081 #: ../tools/virt-win-reg.pl:476
30083 "Prepare a DOS batch script, VBScript or executable. Upload this using "
30084 "L<guestfish(1)>. For this example the script is called C<test.bat> and it "
30085 "is uploaded into C<C:\\>:"
30089 #: ../tools/virt-win-reg.pl:480
30092 " guestfish -i -d WindowsGuest upload test.bat /test.bat\n"
30097 #: ../tools/virt-win-reg.pl:482
30098 msgid "Prepare a regedit file containing the registry change:"
30102 #: ../tools/virt-win-reg.pl:484
30105 " cat > test.reg <<'EOF'\n"
30106 " [HKLM\\Software\\Microsoft\\Windows\\CurrentVersion\\RunOnce]\n"
30107 " \"Test\"=\"c:\\\\test.bat\"\n"
30113 #: ../tools/virt-win-reg.pl:489
30115 "In this example we use the key C<RunOnce> which means that the script will "
30116 "run precisely once when the first user logs in. If you want it to run every "
30117 "time a user logs in, replace C<RunOnce> with C<Run>."
30121 #: ../tools/virt-win-reg.pl:493
30122 msgid "Now update the registry:"
30126 #: ../tools/virt-win-reg.pl:495
30129 " virt-win-reg --merge WindowsGuest test.reg\n"
30134 #: ../tools/virt-win-reg.pl:497
30135 msgid "INSTALLING A SERVICE"
30139 #: ../tools/virt-win-reg.pl:499
30141 "This section assumes you are familiar with Windows services, and you either "
30142 "have a program which handles the Windows Service Control Protocol directly "
30143 "or you want to run any program using a service wrapper like SrvAny or the "
30148 #: ../tools/virt-win-reg.pl:504
30150 "First upload the program and optionally the service wrapper. In this case "
30151 "the test program is called C<test.exe> and we are using the RHSrvAny wrapper:"
30155 #: ../tools/virt-win-reg.pl:508
30158 " guestfish -i -d WindowsGuest <<EOF\n"
30159 " upload rhsrvany.exe /rhsrvany.exe\n"
30160 " upload test.exe /test.exe\n"
30166 #: ../tools/virt-win-reg.pl:513
30168 "Prepare a regedit file containing the registry changes. In this example, "
30169 "the first registry change is needed for the service itself or the service "
30170 "wrapper (if used). The second registry change is only needed because I am "
30171 "using the RHSrvAny service wrapper."
30175 #: ../tools/virt-win-reg.pl:518
30178 " cat > service.reg <<'EOF'\n"
30179 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny]\n"
30180 " \"Type\"=dword:00000010\n"
30181 " \"Start\"=dword:00000002\n"
30182 " \"ErrorControl\"=dword:00000001\n"
30183 " \"ImagePath\"=\"c:\\\\rhsrvany.exe\"\n"
30184 " \"DisplayName\"=\"RHSrvAny\"\n"
30185 " \"ObjectName\"=\"NetworkService\"\n"
30190 #: ../tools/virt-win-reg.pl:527
30193 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny\\Parameters]\n"
30194 " \"CommandLine\"=\"c:\\\\test.exe\"\n"
30195 " \"PWD\"=\"c:\\\\Temp\"\n"
30201 #: ../tools/virt-win-reg.pl:538
30203 "For use of C<ControlSet001> see the section above in this manual page. You "
30204 "may need to adjust this according to the control set that is in use by the "
30209 #: ../tools/virt-win-reg.pl:544
30211 "C<\"ObjectName\"> controls the privileges that the service will have. An "
30212 "alternative is C<\"ObjectName\"=\"LocalSystem\"> which would be the most "
30213 "privileged account."
30217 #: ../tools/virt-win-reg.pl:550
30219 "For the meaning of the magic numbers, see this Microsoft KB article: "
30220 "L<http://support.microsoft.com/kb/103000>."
30224 #: ../tools/virt-win-reg.pl:555
30225 msgid "Update the registry:"
30229 #: ../tools/virt-win-reg.pl:557
30232 " virt-win-reg --merge WindowsGuest service.reg\n"
30237 #: ../tools/virt-win-reg.pl:561
30239 "Be careful when passing parameters containing C<\\> (backslash) in the "
30240 "shell. Usually you will have to use 'single quotes' or double backslashes "
30241 "(but not both) to protect them from the shell."
30245 #: ../tools/virt-win-reg.pl:565
30246 msgid "Paths and value names are case-insensitive."
30250 #: ../tools/virt-win-reg.pl:574
30252 "L<hivex(3)>, L<hivexsh(1)>, L<hivexregedit(1)>, L<guestfs(3)>, L<guestfish(1)"
30253 ">, L<virt-cat(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Win::Hivex"
30254 "(3)>, L<Win::Hivex::Regedit(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
30258 #: ../tools/virt-win-reg.pl:589 ../tools/virt-make-fs.pl:555
30260 "When reporting bugs, please enable debugging and capture the I<complete> "
30265 #: ../tools/virt-win-reg.pl:592
30268 " export LIBGUESTFS_DEBUG=1\n"
30269 " virt-win-reg --debug [... rest ...] > /tmp/virt-win-reg.log 2>&1\n"
30274 #: ../tools/virt-win-reg.pl:595
30276 "Attach /tmp/virt-win-reg.log to a new bug report at L<https://bugzilla."
30281 #: ../tools/virt-win-reg.pl:604 ../tools/virt-make-fs.pl:570
30282 msgid "Copyright (C) 2010 Red Hat Inc."
30286 #: ../tools/virt-list-filesystems.pl:32
30288 "virt-list-filesystems - List filesystems in a virtual machine or disk image"
30292 #: ../tools/virt-list-filesystems.pl:36
30295 " virt-list-filesystems [--options] domname\n"
30300 #: ../tools/virt-list-filesystems.pl:38
30303 " virt-list-filesystems [--options] disk.img [disk.img ...]\n"
30308 #: ../tools/virt-list-filesystems.pl:42 ../tools/virt-list-partitions.pl:42
30310 "This tool is obsolete. Use L<virt-filesystems(1)> as a more flexible "
30315 #: ../tools/virt-list-filesystems.pl:45
30317 "C<virt-list-filesystems> is a command line tool to list the filesystems that "
30318 "are contained in a virtual machine or disk image."
30322 #: ../tools/virt-list-filesystems.pl:49
30324 "C<virt-list-filesystems> is just a simple wrapper around L<libguestfs(3)> "
30325 "functionality. For more complex cases you should look at the L<guestfish(1)"
30330 #: ../tools/virt-list-filesystems.pl:106 ../tools/virt-list-partitions.pl:115
30331 msgid "B<-l> | B<--long>"
30335 #: ../tools/virt-list-filesystems.pl:108
30337 "With this option, C<virt-list-filesystems> displays the type of each "
30338 "filesystem too (where \"type\" means C<ext3>, C<xfs> etc.)"
30342 #: ../tools/virt-list-filesystems.pl:115
30343 msgid "B<-a> | B<--all>"
30347 #: ../tools/virt-list-filesystems.pl:117
30349 "Normally we only show mountable filesystems. If this option is given then "
30350 "swap devices are shown too."
30354 #: ../tools/virt-list-filesystems.pl:191
30356 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, L<virt-"
30357 "filesystems(1)>, L<virt-list-partitions(1)>, L<Sys::Guestfs(3)>, L<Sys::"
30358 "Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
30362 #: ../tools/virt-list-filesystems.pl:208 ../tools/virt-tar.pl:307
30363 msgid "Copyright (C) 2009 Red Hat Inc."
30367 #: ../tools/virt-tar.pl:33
30368 msgid "virt-tar - Extract or upload files to a virtual machine"
30372 #: ../tools/virt-tar.pl:37
30375 " virt-tar [--options] -x domname directory tarball\n"
30380 #: ../tools/virt-tar.pl:39
30383 " virt-tar [--options] -u domname tarball directory\n"
30388 #: ../tools/virt-tar.pl:41
30391 " virt-tar [--options] disk.img [disk.img ...] -x directory tarball\n"
30396 #: ../tools/virt-tar.pl:43
30399 " virt-tar [--options] disk.img [disk.img ...] -u tarball directory\n"
30404 #: ../tools/virt-tar.pl:47
30406 "This tool is obsolete. Use L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-"
30407 "tar-in(1)>, L<virt-tar-out(1)> as replacements."
30411 #: ../tools/virt-tar.pl:52
30412 msgid "Download C</home> from the VM into a local tarball:"
30416 #: ../tools/virt-tar.pl:54
30419 " virt-tar -x domname /home home.tar\n"
30424 #: ../tools/virt-tar.pl:56
30427 " virt-tar -zx domname /home home.tar.gz\n"
30432 #: ../tools/virt-tar.pl:58
30433 msgid "Upload a local tarball and unpack it inside C</tmp> in the VM:"
30437 #: ../tools/virt-tar.pl:60
30440 " virt-tar -u domname uploadstuff.tar /tmp\n"
30445 #: ../tools/virt-tar.pl:62
30448 " virt-tar -zu domname uploadstuff.tar.gz /tmp\n"
30453 #: ../tools/virt-tar.pl:66
30455 "You must I<not> use C<virt-tar> with the I<-u> option (upload) on live "
30456 "virtual machines. If you do this, you risk disk corruption in the VM. "
30457 "C<virt-tar> tries to stop you from doing this, but doesn't catch all cases."
30461 #: ../tools/virt-tar.pl:71
30463 "You can use I<-x> (extract) on live virtual machines, but you might get "
30464 "inconsistent results or errors if there is filesystem activity inside the "
30465 "VM. If the live VM is synched and quiescent, then C<virt-tar> will usually "
30466 "work, but the only way to guarantee consistent results is if the virtual "
30467 "machine is shut down."
30471 #: ../tools/virt-tar.pl:79
30473 "C<virt-tar> is a general purpose archive tool for downloading and uploading "
30474 "parts of a guest filesystem. There are many possibilities: making backups, "
30475 "uploading data files, snooping on guest activity, fixing or customizing "
30480 #: ../tools/virt-tar.pl:84
30482 "If you want to just view a single file, use L<virt-cat(1)>. If you just "
30483 "want to edit a single file, use L<virt-edit(1)>. For more complex cases you "
30484 "should look at the L<guestfish(1)> tool."
30488 #: ../tools/virt-tar.pl:88
30490 "There are two modes of operation: I<-x> (eXtract) downloads a directory and "
30491 "its contents (recursively) from the virtual machine into a local tarball. "
30492 "I<-u> uploads from a local tarball, unpacking it into a directory inside the "
30493 "virtual machine. You cannot use these two options together."
30497 #: ../tools/virt-tar.pl:94
30499 "In addition, you may need to use the I<-z> (gZip) option to enable "
30500 "compression. When uploading, you have to specify I<-z> if the upload file "
30501 "is compressed because virt-tar won't detect this on its own."
30505 #: ../tools/virt-tar.pl:98
30507 "C<virt-tar> can only handle tar (optionally gzipped) format tarballs. For "
30508 "example it cannot do PKZip files or bzip2 compression. If you want that "
30509 "then you'll have to rebuild the tarballs yourself. (This is a limitation of "
30510 "the L<libguestfs(3)> API)."
30514 #: ../tools/virt-tar.pl:156
30515 msgid "B<-x> | B<--extract> | B<--download>"
30519 #: ../tools/virt-tar.pl:158
30520 msgid "B<-u> | B<--upload>"
30524 #: ../tools/virt-tar.pl:160
30526 "Use I<-x> to extract (download) a directory from a virtual machine to a "
30531 #: ../tools/virt-tar.pl:163
30533 "Use I<-u> to upload and unpack from a local tarball into a virtual machine. "
30534 "Please read the L</WARNING> section above before using this option."
30538 #: ../tools/virt-tar.pl:167
30539 msgid "You must specify exactly one of these options."
30543 #: ../tools/virt-tar.pl:173
30544 msgid "B<-z> | B<--gzip>"
30548 #: ../tools/virt-tar.pl:175
30549 msgid "Specify that the input or output tarball is gzip-compressed."
30553 #: ../tools/virt-tar.pl:288
30555 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, L<virt-copy-"
30556 "in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<Sys::"
30557 "Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs."
30562 #: ../tools/virt-make-fs.pl:37
30563 msgid "virt-make-fs - Make a filesystem from a tar archive or files"
30567 #: ../tools/virt-make-fs.pl:41
30570 " virt-make-fs [--options] input.tar output.img\n"
30575 #: ../tools/virt-make-fs.pl:43
30578 " virt-make-fs [--options] input.tar.gz output.img\n"
30583 #: ../tools/virt-make-fs.pl:45
30586 " virt-make-fs [--options] directory output.img\n"
30591 #: ../tools/virt-make-fs.pl:49
30593 "Virt-make-fs is a command line tool for creating a filesystem from a tar "
30594 "archive or some files in a directory. It is similar to tools like L<mkisofs"
30595 "(1)>, L<genisoimage(1)> and L<mksquashfs(1)>. Unlike those tools, it can "
30596 "create common filesystem types like ext2/3 or NTFS, which can be useful if "
30597 "you want to attach these filesystems to existing virtual machines (eg. to "
30598 "import large amounts of read-only data to a VM)."
30602 #: ../tools/virt-make-fs.pl:57
30603 msgid "Basic usage is:"
30607 #: ../tools/virt-make-fs.pl:59
30610 " virt-make-fs input output\n"
30615 #: ../tools/virt-make-fs.pl:61
30617 "where C<input> is either a directory containing files that you want to add, "
30618 "or a tar archive (either uncompressed tar or gzip-compressed tar); and "
30619 "C<output> is a disk image. The input type is detected automatically. The "
30620 "output disk image defaults to a raw ext2 image unless you specify extra "
30621 "flags (see L</OPTIONS> below)."
30625 #: ../tools/virt-make-fs.pl:67
30626 msgid "EXTRA SPACE"
30630 #: ../tools/virt-make-fs.pl:69
30632 "Unlike formats such as tar and squashfs, a filesystem does not \"just fit\" "
30633 "the files that it contains, but might have extra space. Depending on how "
30634 "you are going to use the output, you might think this extra space is wasted "
30635 "and want to minimize it, or you might want to leave space so that more files "
30636 "can be added later. Virt-make-fs defaults to minimizing the extra space, "
30637 "but you can use the I<--size> flag to leave space in the filesystem if you "
30642 #: ../tools/virt-make-fs.pl:77
30644 "An alternative way to leave extra space but not make the output image any "
30645 "bigger is to use an alternative disk image format (instead of the default "
30646 "\"raw\" format). Using I<--format=qcow2> will use the native QEmu/KVM qcow2 "
30647 "image format (check your hypervisor supports this before using it). This "
30648 "allows you to choose a large I<--size> but the extra space won't actually be "
30649 "allocated in the image until you try to store something in it."
30653 #: ../tools/virt-make-fs.pl:85
30655 "Don't forget that you can also use local commands including L<resize2fs(8)> "
30656 "and L<virt-resize(1)> to resize existing filesystems, or rerun virt-make-fs "
30657 "to build another image from scratch."
30661 #: ../tools/virt-make-fs.pl:89 ../tools/virt-make-fs.pl:123
30662 #: ../tools/virt-make-fs.pl:142
30667 #: ../tools/virt-make-fs.pl:91
30670 " virt-make-fs --format=qcow2 --size=+200M input output.img\n"
30675 #: ../tools/virt-make-fs.pl:93
30676 msgid "FILESYSTEM TYPE"
30680 #: ../tools/virt-make-fs.pl:95
30682 "The default filesystem type is C<ext2>. Just about any filesystem type that "
30683 "libguestfs supports can be used (but I<not> read-only formats like "
30684 "ISO9660). Here are some of the more common choices:"
30688 #: ../tools/virt-make-fs.pl:101
30693 #: ../tools/virt-make-fs.pl:103
30695 "Note that ext3 filesystems contain a journal, typically 1-32 MB in size. If "
30696 "you are not going to use the filesystem in a way that requires the journal, "
30697 "then this is just wasted overhead."
30701 #: ../tools/virt-make-fs.pl:107
30702 msgid "I<ntfs> or I<vfat>"
30706 #: ../tools/virt-make-fs.pl:109
30707 msgid "Useful if exporting data to a Windows guest."
30711 #: ../tools/virt-make-fs.pl:111
30713 "I<Note for vfat>: The tar archive or local directory must only contain files "
30714 "which are owned by root (ie. UID:GID = 0:0). The reason is that the tar "
30715 "program running within libguestfs is unable to change the ownership of non-"
30716 "root files, since vfat itself does not support this."
30720 #: ../tools/virt-make-fs.pl:116
30725 #: ../tools/virt-make-fs.pl:118
30727 "Lower overhead than C<ext2>, but certain limitations on filename length and "
30728 "total filesystem size."
30732 #: ../tools/virt-make-fs.pl:125
30735 " virt-make-fs --type=minix input minixfs.img\n"
30740 #: ../tools/virt-make-fs.pl:127
30741 msgid "TO PARTITION OR NOT TO PARTITION"
30745 #: ../tools/virt-make-fs.pl:129
30746 msgid "Optionally virt-make-fs can add a partition table to the output disk."
30750 #: ../tools/virt-make-fs.pl:131
30752 "Adding a partition can make the disk image more compatible with certain "
30753 "virtualized operating systems which don't expect to see a filesystem "
30754 "directly located on a block device (Linux doesn't care and will happily "
30755 "handle both types)."
30759 #: ../tools/virt-make-fs.pl:136
30761 "On the other hand, if you have a partition table then the output image is no "
30762 "longer a straight filesystem. For example you cannot run L<fsck(8)> "
30763 "directly on a partitioned disk image. (However libguestfs tools such as "
30764 "L<guestfish(1)> and L<virt-resize(1)> can still be used)."
30768 #: ../tools/virt-make-fs.pl:144
30769 msgid "Add an MBR partition:"
30773 #: ../tools/virt-make-fs.pl:146
30776 " virt-make-fs --partition -- input disk.img\n"
30781 #: ../tools/virt-make-fs.pl:148
30783 "If the output disk image could be terabyte-sized or larger, it's better to "
30784 "use an EFI/GPT-compatible partition table:"
30788 #: ../tools/virt-make-fs.pl:151
30791 " virt-make-fs --partition=gpt --size=+4T --format=qcow2 input disk.img\n"
30796 #: ../tools/virt-make-fs.pl:179
30797 msgid "Enable debugging information."
30801 #: ../tools/virt-make-fs.pl:185
30802 msgid "B<--size=E<lt>NE<gt>>"
30806 #: ../tools/virt-make-fs.pl:187
30807 msgid "B<--size=+E<lt>NE<gt>>"
30811 #: ../tools/virt-make-fs.pl:189
30812 msgid "B<-s E<lt>NE<gt>>"
30816 #: ../tools/virt-make-fs.pl:191
30817 msgid "B<-s +E<lt>NE<gt>>"
30821 #: ../tools/virt-make-fs.pl:193
30823 "Use the I<--size> (or I<-s>) option to choose the size of the output image."
30827 #: ../tools/virt-make-fs.pl:196
30829 "If this option is I<not> given, then the output image will be just large "
30830 "enough to contain all the files, with not much wasted space."
30834 #: ../tools/virt-make-fs.pl:199
30836 "To choose a fixed size output disk, specify an absolute number followed by b/"
30837 "K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
30838 "Petabytes or Exabytes. This must be large enough to contain all the input "
30839 "files, else you will get an error."
30843 #: ../tools/virt-make-fs.pl:204
30845 "To leave extra space, specify C<+> (plus sign) and a number followed by b/K/"
30846 "M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
30847 "Petabytes or Exabytes. For example: I<--size=+200M> means enough space for "
30848 "the input files, and (approximately) an extra 200 MB free space."
30852 #: ../tools/virt-make-fs.pl:210
30854 "Note that virt-make-fs estimates free space, and therefore will not produce "
30855 "filesystems containing precisely the free space requested. (It is much more "
30856 "expensive and time-consuming to produce a filesystem which has precisely the "
30857 "desired free space)."
30861 #: ../tools/virt-make-fs.pl:219
30862 msgid "B<--format=E<lt>fmtE<gt>>"
30866 #: ../tools/virt-make-fs.pl:221
30867 msgid "B<-F E<lt>fmtE<gt>>"
30871 #: ../tools/virt-make-fs.pl:223
30872 msgid "Choose the output disk image format."
30876 #: ../tools/virt-make-fs.pl:225
30877 msgid "The default is C<raw> (raw disk image)."
30881 #: ../tools/virt-make-fs.pl:227
30883 "For other choices, see the L<qemu-img(1)> manpage. The only other choice "
30884 "that would really make sense here is C<qcow2>."
30888 #: ../tools/virt-make-fs.pl:234
30889 msgid "B<--type=E<lt>fsE<gt>>"
30893 #: ../tools/virt-make-fs.pl:236
30894 msgid "B<-t E<lt>fsE<gt>>"
30898 #: ../tools/virt-make-fs.pl:238
30899 msgid "Choose the output filesystem type."
30903 #: ../tools/virt-make-fs.pl:240
30904 msgid "The default is C<ext2>."
30908 #: ../tools/virt-make-fs.pl:242
30910 "Any filesystem which is supported read-write by libguestfs can be used here."
30914 #: ../tools/virt-make-fs.pl:249
30915 msgid "B<--partition>"
30919 #: ../tools/virt-make-fs.pl:251
30920 msgid "B<--partition=E<lt>parttypeE<gt>>"
30924 #: ../tools/virt-make-fs.pl:253
30926 "If specified, this flag adds an MBR partition table to the output disk image."
30930 #: ../tools/virt-make-fs.pl:256
30932 "You can change the partition table type, eg. I<--partition=gpt> for large "
30937 #: ../tools/virt-make-fs.pl:259
30939 "Note that if you just use a lonesome I<--partition>, the Perl option parser "
30940 "might consider the next parameter to be the partition type. For example:"
30944 #: ../tools/virt-make-fs.pl:263
30947 " virt-make-fs --partition input.tar ...\n"
30952 #: ../tools/virt-make-fs.pl:265
30954 "would cause virt-make-fs to think you wanted to use a partition type of "
30955 "C<input.tar> which is completely wrong. To avoid this, use I<--> (a double "
30956 "dash) between options and the input file argument:"
30960 #: ../tools/virt-make-fs.pl:269
30963 " virt-make-fs --partition -- input.tar ...\n"
30968 #: ../tools/virt-make-fs.pl:541
30970 "L<guestfish(1)>, L<virt-resize(1)>, L<virt-tar-in(1)>, L<mkisofs(1)>, "
30971 "L<genisoimage(1)>, L<mksquashfs(1)>, L<mke2fs(8)>, L<resize2fs(8)>, L<guestfs"
30972 "(3)>, L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
30976 #: ../tools/virt-make-fs.pl:558
30979 " export LIBGUESTFS_DEBUG=1\n"
30980 " virt-make-fs --debug [...] > /tmp/virt-make-fs.log 2>&1\n"
30985 #: ../tools/virt-make-fs.pl:561
30987 "Attach /tmp/virt-make-fs.log to a new bug report at L<https://bugzilla."
30992 #: ../tools/virt-list-partitions.pl:32
30994 "virt-list-partitions - List partitions in a virtual machine or disk image"
30998 #: ../tools/virt-list-partitions.pl:36
31001 " virt-list-partitions [--options] domname\n"
31006 #: ../tools/virt-list-partitions.pl:38
31009 " virt-list-partitions [--options] disk.img [disk.img ...]\n"
31014 #: ../tools/virt-list-partitions.pl:45
31016 "C<virt-list-partitions> is a command line tool to list the partitions that "
31017 "are contained in a virtual machine or disk image. It is mainly useful as a "
31018 "first step to using L<virt-resize(1)>."
31022 #: ../tools/virt-list-partitions.pl:50
31024 "C<virt-list-partitions> is just a simple wrapper around L<libguestfs(3)> "
31025 "functionality. For more complex cases you should look at the L<guestfish(1)"
31030 #: ../tools/virt-list-partitions.pl:107
31031 msgid "B<-h> | B<--human-readable>"
31035 #: ../tools/virt-list-partitions.pl:109
31036 msgid "Show sizes in human-readable form (eg. \"1G\")."
31040 #: ../tools/virt-list-partitions.pl:117
31042 "With this option, C<virt-list-partitions> displays the type and size of each "
31043 "partition too (where \"type\" means C<ext3>, C<pv> etc.)"
31047 #: ../tools/virt-list-partitions.pl:124
31048 msgid "B<-t> | B<--total>"
31052 #: ../tools/virt-list-partitions.pl:126
31054 "Display the total size of each block device (as a separate row or rows)."
31058 #: ../tools/virt-list-partitions.pl:259
31060 "L<guestfs(3)>, L<guestfish(1)>, L<virt-filesystems(1)>, L<virt-list-"
31061 "filesystems(1)>, L<virt-resize(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib"
31062 "(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
31066 #: ../tools/virt-list-partitions.pl:275
31067 msgid "Copyright (C) 2009-2010 Red Hat Inc."