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-07 23:15+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:577
870 #: ../src/guestfs-actions.pod:585 ../src/guestfs-actions.pod:592
871 #: ../src/guestfs-actions.pod:599 ../src/guestfs-actions.pod:1597
872 #: ../src/guestfs-actions.pod:1601 ../src/guestfs-actions.pod:1605
873 #: ../src/guestfs-actions.pod:1609 ../src/guestfs-actions.pod:1617
874 #: ../src/guestfs-actions.pod:1621 ../src/guestfs-actions.pod:1625
875 #: ../src/guestfs-actions.pod:1635 ../src/guestfs-actions.pod:1639
876 #: ../src/guestfs-actions.pod:1643 ../src/guestfs-actions.pod:1781
877 #: ../src/guestfs-actions.pod:1785 ../src/guestfs-actions.pod:1790
878 #: ../src/guestfs-actions.pod:1795 ../src/guestfs-actions.pod:1856
879 #: ../src/guestfs-actions.pod:1860 ../src/guestfs-actions.pod:1865
880 #: ../fish/guestfish.pod:443 ../fish/guestfish.pod:447
881 #: ../fish/guestfish.pod:451 ../fish/guestfish.pod:455
882 #: ../fish/guestfish-actions.pod:13 ../fish/guestfish-actions.pod:20
883 #: ../fish/guestfish-actions.pod:380 ../fish/guestfish-actions.pod:388
884 #: ../fish/guestfish-actions.pod:395 ../fish/guestfish-actions.pod:402
885 #: ../fish/guestfish-actions.pod:1069 ../fish/guestfish-actions.pod:1073
886 #: ../fish/guestfish-actions.pod:1077 ../fish/guestfish-actions.pod:1081
887 #: ../fish/guestfish-actions.pod:1089 ../fish/guestfish-actions.pod:1093
888 #: ../fish/guestfish-actions.pod:1097 ../fish/guestfish-actions.pod:1107
889 #: ../fish/guestfish-actions.pod:1111 ../fish/guestfish-actions.pod:1115
890 #: ../fish/guestfish-actions.pod:1205 ../fish/guestfish-actions.pod:1209
891 #: ../fish/guestfish-actions.pod:1214 ../fish/guestfish-actions.pod:1219
892 #: ../fish/guestfish-actions.pod:1261 ../fish/guestfish-actions.pod:1265
893 #: ../fish/guestfish-actions.pod:1270 ../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:1008
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:1852 ../fish/guestfish-actions.pod:9
3310 #: ../fish/guestfish-actions.pod:1257 ../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:5827
5136 #: ../fish/guestfish-actions.pod:3921
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:1015
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:1041
5633 msgid "LIBGUESTFS_APPEND"
5637 #: ../src/guestfs.pod:2872 ../fish/guestfish.pod:1043
5638 msgid "Pass additional options to the guest kernel."
5642 #: ../src/guestfs.pod:2874 ../fish/guestfish.pod:1045
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:1050
5655 msgid "LIBGUESTFS_MEMSIZE"
5659 #: ../src/guestfs.pod:2881 ../fish/guestfish.pod:1052
5661 "Set the memory allocated to the qemu process, in megabytes. For example:"
5665 #: ../src/guestfs.pod:2884 ../fish/guestfish.pod:1055
5668 " LIBGUESTFS_MEMSIZE=700\n"
5673 #: ../src/guestfs.pod:2886 ../fish/guestfish.pod:1057
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:1062
5686 msgid "LIBGUESTFS_QEMU"
5690 #: ../src/guestfs.pod:2893 ../fish/guestfish.pod:1064
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:1068
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:1077
5719 #: ../src/guestfs.pod:2906 ../fish/guestfish.pod:1079
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:1082
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:1149
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:1172
5828 #: ../test-tool/libguestfs-test-tool.pod:93 ../fuse/guestmount.pod:288
5833 #: ../src/guestfs.pod:2989 ../fish/guestfish.pod:1174
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:1176
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:1178
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:416 ../src/guestfs-actions.pod:436
5927 #: ../src/guestfs-actions.pod:450 ../src/guestfs-actions.pod:495
5928 #: ../src/guestfs-actions.pod:523 ../src/guestfs-actions.pod:541
5929 #: ../src/guestfs-actions.pod:608 ../src/guestfs-actions.pod:641
5930 #: ../src/guestfs-actions.pod:655 ../src/guestfs-actions.pod:670
5931 #: ../src/guestfs-actions.pod:769 ../src/guestfs-actions.pod:787
5932 #: ../src/guestfs-actions.pod:801 ../src/guestfs-actions.pod:815
5933 #: ../src/guestfs-actions.pod:976 ../src/guestfs-actions.pod:996
5934 #: ../src/guestfs-actions.pod:1014 ../src/guestfs-actions.pod:1098
5935 #: ../src/guestfs-actions.pod:1116 ../src/guestfs-actions.pod:1135
5936 #: ../src/guestfs-actions.pod:1149 ../src/guestfs-actions.pod:1169
5937 #: ../src/guestfs-actions.pod:1239 ../src/guestfs-actions.pod:1270
5938 #: ../src/guestfs-actions.pod:1295 ../src/guestfs-actions.pod:1337
5939 #: ../src/guestfs-actions.pod:1443 ../src/guestfs-actions.pod:1477
5940 #: ../src/guestfs-actions.pod:1692 ../src/guestfs-actions.pod:1714
5941 #: ../src/guestfs-actions.pod:1801 ../src/guestfs-actions.pod:2263
5942 #: ../src/guestfs-actions.pod:2407 ../src/guestfs-actions.pod:2468
5943 #: ../src/guestfs-actions.pod:2503 ../src/guestfs-actions.pod:3456
5944 #: ../src/guestfs-actions.pod:3471 ../src/guestfs-actions.pod:3496
5945 #: ../src/guestfs-actions.pod:3651 ../src/guestfs-actions.pod:3665
5946 #: ../src/guestfs-actions.pod:3678 ../src/guestfs-actions.pod:3692
5947 #: ../src/guestfs-actions.pod:3707 ../src/guestfs-actions.pod:3743
5948 #: ../src/guestfs-actions.pod:3815 ../src/guestfs-actions.pod:3835
5949 #: ../src/guestfs-actions.pod:3852 ../src/guestfs-actions.pod:3875
5950 #: ../src/guestfs-actions.pod:3898 ../src/guestfs-actions.pod:3930
5951 #: ../src/guestfs-actions.pod:3949 ../src/guestfs-actions.pod:3968
5952 #: ../src/guestfs-actions.pod:4003 ../src/guestfs-actions.pod:4015
5953 #: ../src/guestfs-actions.pod:4051 ../src/guestfs-actions.pod:4067
5954 #: ../src/guestfs-actions.pod:4080 ../src/guestfs-actions.pod:4095
5955 #: ../src/guestfs-actions.pod:4112 ../src/guestfs-actions.pod:4205
5956 #: ../src/guestfs-actions.pod:4225 ../src/guestfs-actions.pod:4238
5957 #: ../src/guestfs-actions.pod:4289 ../src/guestfs-actions.pod:4307
5958 #: ../src/guestfs-actions.pod:4325 ../src/guestfs-actions.pod:4341
5959 #: ../src/guestfs-actions.pod:4355 ../src/guestfs-actions.pod:4369
5960 #: ../src/guestfs-actions.pod:4386 ../src/guestfs-actions.pod:4401
5961 #: ../src/guestfs-actions.pod:4421 ../src/guestfs-actions.pod:4479
5962 #: ../src/guestfs-actions.pod:4552 ../src/guestfs-actions.pod:4583
5963 #: ../src/guestfs-actions.pod:4602 ../src/guestfs-actions.pod:4621
5964 #: ../src/guestfs-actions.pod:4633 ../src/guestfs-actions.pod:4650
5965 #: ../src/guestfs-actions.pod:4663 ../src/guestfs-actions.pod:4678
5966 #: ../src/guestfs-actions.pod:4693 ../src/guestfs-actions.pod:4728
5967 #: ../src/guestfs-actions.pod:4750 ../src/guestfs-actions.pod:4770
5968 #: ../src/guestfs-actions.pod:4784 ../src/guestfs-actions.pod:4801
5969 #: ../src/guestfs-actions.pod:4850 ../src/guestfs-actions.pod:4896
5970 #: ../src/guestfs-actions.pod:4910 ../src/guestfs-actions.pod:4938
5971 #: ../src/guestfs-actions.pod:4955 ../src/guestfs-actions.pod:4973
5972 #: ../src/guestfs-actions.pod:5107 ../src/guestfs-actions.pod:5164
5973 #: ../src/guestfs-actions.pod:5186 ../src/guestfs-actions.pod:5204
5974 #: ../src/guestfs-actions.pod:5236 ../src/guestfs-actions.pod:5302
5975 #: ../src/guestfs-actions.pod:5319 ../src/guestfs-actions.pod:5332
5976 #: ../src/guestfs-actions.pod:5346 ../src/guestfs-actions.pod:5635
5977 #: ../src/guestfs-actions.pod:5654 ../src/guestfs-actions.pod:5673
5978 #: ../src/guestfs-actions.pod:5685 ../src/guestfs-actions.pod:5697
5979 #: ../src/guestfs-actions.pod:5711 ../src/guestfs-actions.pod:5723
5980 #: ../src/guestfs-actions.pod:5737 ../src/guestfs-actions.pod:5753
5981 #: ../src/guestfs-actions.pod:5774 ../src/guestfs-actions.pod:5793
5982 #: ../src/guestfs-actions.pod:5812 ../src/guestfs-actions.pod:5842
5983 #: ../src/guestfs-actions.pod:5858 ../src/guestfs-actions.pod:5881
5984 #: ../src/guestfs-actions.pod:5899 ../src/guestfs-actions.pod:5918
5985 #: ../src/guestfs-actions.pod:5939 ../src/guestfs-actions.pod:5958
5986 #: ../src/guestfs-actions.pod:5975 ../src/guestfs-actions.pod:6003
5987 #: ../src/guestfs-actions.pod:6027 ../src/guestfs-actions.pod:6046
5988 #: ../src/guestfs-actions.pod:6070 ../src/guestfs-actions.pod:6089
5989 #: ../src/guestfs-actions.pod:6104 ../src/guestfs-actions.pod:6123
5990 #: ../src/guestfs-actions.pod:6160 ../src/guestfs-actions.pod:6190
5991 #: ../src/guestfs-actions.pod:6223 ../src/guestfs-actions.pod:6345
5992 #: ../src/guestfs-actions.pod:6466 ../src/guestfs-actions.pod:6478
5993 #: ../src/guestfs-actions.pod:6491 ../src/guestfs-actions.pod:6504
5994 #: ../src/guestfs-actions.pod:6526 ../src/guestfs-actions.pod:6539
5995 #: ../src/guestfs-actions.pod:6552 ../src/guestfs-actions.pod:6565
5996 #: ../src/guestfs-actions.pod:6580 ../src/guestfs-actions.pod:6639
5997 #: ../src/guestfs-actions.pod:6656 ../src/guestfs-actions.pod:6672
5998 #: ../src/guestfs-actions.pod:6688 ../src/guestfs-actions.pod:6705
5999 #: ../src/guestfs-actions.pod:6718 ../src/guestfs-actions.pod:6738
6000 #: ../src/guestfs-actions.pod:6774 ../src/guestfs-actions.pod:6788
6001 #: ../src/guestfs-actions.pod:6829 ../src/guestfs-actions.pod:6842
6002 #: ../src/guestfs-actions.pod:6860 ../src/guestfs-actions.pod:6894
6003 #: ../src/guestfs-actions.pod:6930 ../src/guestfs-actions.pod:7049
6004 #: ../src/guestfs-actions.pod:7067 ../src/guestfs-actions.pod:7081
6005 #: ../src/guestfs-actions.pod:7136 ../src/guestfs-actions.pod:7149
6006 #: ../src/guestfs-actions.pod:7194 ../src/guestfs-actions.pod:7227
6007 #: ../src/guestfs-actions.pod:7288 ../src/guestfs-actions.pod:7314
6008 #: ../src/guestfs-actions.pod:7380 ../src/guestfs-actions.pod:7399
6009 #: ../src/guestfs-actions.pod:7428
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:1448
6024 #: ../src/guestfs-actions.pod:1941 ../src/guestfs-actions.pod:1962
6025 #: ../src/guestfs-actions.pod:4426 ../src/guestfs-actions.pod:4733
6026 #: ../src/guestfs-actions.pod:6168 ../src/guestfs-actions.pod:6198
6027 #: ../src/guestfs-actions.pod:6231 ../src/guestfs-actions.pod:6290
6028 #: ../src/guestfs-actions.pod:7232 ../src/guestfs-actions.pod:7322
6029 #: ../src/guestfs-actions.pod:7491 ../fish/guestfish-actions.pod:31
6030 #: ../fish/guestfish-actions.pod:161 ../fish/guestfish-actions.pod:175
6031 #: ../fish/guestfish-actions.pod:956 ../fish/guestfish-actions.pod:1316
6032 #: ../fish/guestfish-actions.pod:1330 ../fish/guestfish-actions.pod:3005
6033 #: ../fish/guestfish-actions.pod:3202 ../fish/guestfish-actions.pod:4183
6034 #: ../fish/guestfish-actions.pod:4206 ../fish/guestfish-actions.pod:4228
6035 #: ../fish/guestfish-actions.pod:4266 ../fish/guestfish-actions.pod:4907
6036 #: ../fish/guestfish-actions.pod:5004
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:1100 ../src/guestfs-actions.pod:1913
6046 #: ../src/guestfs-actions.pod:2011 ../src/guestfs-actions.pod:2114
6047 #: ../src/guestfs-actions.pod:3458 ../src/guestfs-actions.pod:3478
6048 #: ../src/guestfs-actions.pod:4737 ../src/guestfs-actions.pod:5860
6049 #: ../src/guestfs-actions.pod:5977 ../src/guestfs-actions.pod:6091
6050 #: ../src/guestfs-actions.pod:6582 ../src/guestfs-actions.pod:6707
6051 #: ../src/guestfs-actions.pod:7236
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:4440
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:509 ../src/guestfs-actions.pod:687
6152 #: ../src/guestfs-actions.pod:718 ../src/guestfs-actions.pod:736
6153 #: ../src/guestfs-actions.pod:755 ../src/guestfs-actions.pod:1315
6154 #: ../src/guestfs-actions.pod:1671 ../src/guestfs-actions.pod:1874
6155 #: ../src/guestfs-actions.pod:1983 ../src/guestfs-actions.pod:2023
6156 #: ../src/guestfs-actions.pod:2078 ../src/guestfs-actions.pod:2101
6157 #: ../src/guestfs-actions.pod:2394 ../src/guestfs-actions.pod:2777
6158 #: ../src/guestfs-actions.pod:2798 ../src/guestfs-actions.pod:4873
6159 #: ../src/guestfs-actions.pod:5010 ../src/guestfs-actions.pod:5416
6160 #: ../src/guestfs-actions.pod:5442 ../src/guestfs-actions.pod:6815
6161 #: ../src/guestfs-actions.pod:7247 ../src/guestfs-actions.pod:7260
6162 #: ../src/guestfs-actions.pod:7273
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:4493 ../src/guestfs-actions.pod:4505
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:4451
6303 #: ../fish/guestfish-actions.pod:110 ../fish/guestfish-actions.pod:3016
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:2353
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:2103
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:418 ../src/guestfs-actions.pod:438
6533 #: ../src/guestfs-actions.pod:452 ../src/guestfs-actions.pod:483
6534 #: ../src/guestfs-actions.pod:497 ../src/guestfs-actions.pod:511
6535 #: ../src/guestfs-actions.pod:525 ../src/guestfs-actions.pod:543
6536 #: ../src/guestfs-actions.pod:5493
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:857
6639 #: ../src/guestfs-actions.pod:875 ../src/guestfs-actions.pod:935
6640 #: ../src/guestfs-actions.pod:951 ../src/guestfs-actions.pod:1054
6641 #: ../src/guestfs-actions.pod:1184 ../src/guestfs-actions.pod:1201
6642 #: ../src/guestfs-actions.pod:1220 ../src/guestfs-actions.pod:1354
6643 #: ../src/guestfs-actions.pod:1542 ../src/guestfs-actions.pod:1654
6644 #: ../src/guestfs-actions.pod:1817 ../src/guestfs-actions.pod:1834
6645 #: ../src/guestfs-actions.pod:1901 ../src/guestfs-actions.pod:1935
6646 #: ../src/guestfs-actions.pod:1956 ../src/guestfs-actions.pod:2126
6647 #: ../src/guestfs-actions.pod:2318 ../src/guestfs-actions.pod:2525
6648 #: ../src/guestfs-actions.pod:2618 ../src/guestfs-actions.pod:2729
6649 #: ../src/guestfs-actions.pod:2749 ../src/guestfs-actions.pod:2869
6650 #: ../src/guestfs-actions.pod:2900 ../src/guestfs-actions.pod:2924
6651 #: ../src/guestfs-actions.pod:2961 ../src/guestfs-actions.pod:3021
6652 #: ../src/guestfs-actions.pod:3044 ../src/guestfs-actions.pod:3065
6653 #: ../src/guestfs-actions.pod:3637 ../src/guestfs-actions.pod:3987
6654 #: ../src/guestfs-actions.pod:4157 ../src/guestfs-actions.pod:4267
6655 #: ../src/guestfs-actions.pod:5028 ../src/guestfs-actions.pod:5221
6656 #: ../src/guestfs-actions.pod:5391 ../src/guestfs-actions.pod:5569
6657 #: ../src/guestfs-actions.pod:5618 ../src/guestfs-actions.pod:6251
6658 #: ../src/guestfs-actions.pod:6267 ../src/guestfs-actions.pod:6284
6659 #: ../src/guestfs-actions.pod:6315 ../src/guestfs-actions.pod:6989
6660 #: ../src/guestfs-actions.pod:7008 ../src/guestfs-actions.pod:7026
6661 #: ../src/guestfs-actions.pod:7206 ../src/guestfs-actions.pod:7485
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 (can be expensive)."
6742 #: ../src/guestfs-actions.pod:398 ../fish/guestfish-actions.pod:261
6743 msgid "C<AUG_NO_STDINC> = 8"
6744 msgstr "C<AUG_NO_STDINC> = 8"
6747 #: ../src/guestfs-actions.pod:400 ../fish/guestfish-actions.pod:263
6748 msgid "Do not use standard load path for modules."
6752 #: ../src/guestfs-actions.pod:402 ../fish/guestfish-actions.pod:265
6753 msgid "C<AUG_SAVE_NOOP> = 16"
6754 msgstr "C<AUG_SAVE_NOOP> = 16"
6757 #: ../src/guestfs-actions.pod:404 ../fish/guestfish-actions.pod:267
6758 msgid "Make save a no-op, just record what would have been changed."
6762 #: ../src/guestfs-actions.pod:406 ../fish/guestfish-actions.pod:269
6763 msgid "C<AUG_NO_LOAD> = 32"
6764 msgstr "C<AUG_NO_LOAD> = 32"
6767 #: ../src/guestfs-actions.pod:408
6768 msgid "Do not load the tree in C<guestfs_aug_init>."
6772 #: ../src/guestfs-actions.pod:412
6773 msgid "To close the handle, you can call C<guestfs_aug_close>."
6777 #: ../src/guestfs-actions.pod:414 ../fish/guestfish-actions.pod:277
6778 msgid "To find out more about Augeas, see L<http://augeas.net/>."
6782 #: ../src/guestfs-actions.pod:420
6783 msgid "guestfs_aug_insert"
6787 #: ../src/guestfs-actions.pod:422
6791 " guestfs_aug_insert (guestfs_h *g,\n"
6792 " const char *augpath,\n"
6793 " const char *label,\n"
6799 #: ../src/guestfs-actions.pod:428 ../fish/guestfish-actions.pod:283
6801 "Create a new sibling C<label> for C<path>, inserting it into the tree before "
6802 "or after C<path> (depending on the boolean flag C<before>)."
6806 #: ../src/guestfs-actions.pod:432 ../fish/guestfish-actions.pod:287
6808 "C<path> must match exactly one existing node in the tree, and C<label> must "
6809 "be a label, ie. not contain C</>, C<*> or end with a bracketed index C<[N]>."
6813 #: ../src/guestfs-actions.pod:440
6814 msgid "guestfs_aug_load"
6818 #: ../src/guestfs-actions.pod:442
6822 " guestfs_aug_load (guestfs_h *g);\n"
6827 #: ../src/guestfs-actions.pod:445 ../fish/guestfish-actions.pod:295
6828 msgid "Load files into the tree."
6829 msgstr "Завантажити файли до ієрархії."
6832 #: ../src/guestfs-actions.pod:447 ../fish/guestfish-actions.pod:297
6833 msgid "See C<aug_load> in the Augeas documentation for the full gory details."
6837 #: ../src/guestfs-actions.pod:454
6838 msgid "guestfs_aug_ls"
6842 #: ../src/guestfs-actions.pod:456
6846 " guestfs_aug_ls (guestfs_h *g,\n"
6847 " const char *augpath);\n"
6852 #: ../src/guestfs-actions.pod:460
6854 "This is just a shortcut for listing C<guestfs_aug_match> C<path/*> and "
6855 "sorting the resulting nodes into alphabetical order."
6859 #: ../src/guestfs-actions.pod:463 ../src/guestfs-actions.pod:479
6860 #: ../src/guestfs-actions.pod:625 ../src/guestfs-actions.pod:1073
6861 #: ../src/guestfs-actions.pod:1369 ../src/guestfs-actions.pod:1388
6862 #: ../src/guestfs-actions.pod:1491 ../src/guestfs-actions.pod:1510
6863 #: ../src/guestfs-actions.pod:1756 ../src/guestfs-actions.pod:2198
6864 #: ../src/guestfs-actions.pod:2214 ../src/guestfs-actions.pod:2233
6865 #: ../src/guestfs-actions.pod:2276 ../src/guestfs-actions.pod:2300
6866 #: ../src/guestfs-actions.pod:2371 ../src/guestfs-actions.pod:2420
6867 #: ../src/guestfs-actions.pod:2687 ../src/guestfs-actions.pod:2978
6868 #: ../src/guestfs-actions.pod:3267 ../src/guestfs-actions.pod:3557
6869 #: ../src/guestfs-actions.pod:3619 ../src/guestfs-actions.pod:3724
6870 #: ../src/guestfs-actions.pod:4129 ../src/guestfs-actions.pod:4834
6871 #: ../src/guestfs-actions.pod:5363 ../src/guestfs-actions.pod:5489
6872 #: ../src/guestfs-actions.pod:5603 ../src/guestfs-actions.pod:6331
6873 #: ../src/guestfs-actions.pod:6392 ../src/guestfs-actions.pod:6447
6874 #: ../src/guestfs-actions.pod:6593 ../src/guestfs-actions.pod:6617
6875 #: ../src/guestfs-actions.pod:7099 ../src/guestfs-actions.pod:7119
6876 #: ../src/guestfs-actions.pod:7166 ../src/guestfs-actions.pod:7338
6877 #: ../src/guestfs-actions.pod:7357 ../src/guestfs-actions.pod:7442
6878 #: ../src/guestfs-actions.pod:7461 ../src/guestfs-actions.pod:7507
6879 #: ../src/guestfs-actions.pod:7526
6881 "This function returns a NULL-terminated array of strings (like L<environ(3)"
6882 ">), or NULL if there was an error. I<The caller must free the strings and "
6883 "the array after use>."
6887 #: ../src/guestfs-actions.pod:467 ../src/guestfs-actions.pod:998
6888 #: ../src/guestfs-actions.pod:1016 ../src/guestfs-actions.pod:1426
6889 #: ../src/guestfs-actions.pod:3345 ../src/guestfs-actions.pod:3376
6890 #: ../src/guestfs-actions.pod:3970 ../src/guestfs-actions.pod:4020
6891 #: ../src/guestfs-actions.pod:4207 ../src/guestfs-actions.pod:4240
6892 #: ../src/guestfs-actions.pod:4403 ../src/guestfs-actions.pod:4838
6893 #: ../src/guestfs-actions.pod:5304 ../src/guestfs-actions.pod:5699
6894 #: ../src/guestfs-actions.pod:5713 ../src/guestfs-actions.pod:5725
6895 #: ../src/guestfs-actions.pod:6172 ../src/guestfs-actions.pod:6831
6896 #: ../src/guestfs-actions.pod:6844 ../src/guestfs-actions.pod:7083
6897 #: ../src/guestfs-actions.pod:7326
6898 msgid "(Added in 0.8)"
6902 #: ../src/guestfs-actions.pod:469
6903 msgid "guestfs_aug_match"
6907 #: ../src/guestfs-actions.pod:471
6911 " guestfs_aug_match (guestfs_h *g,\n"
6912 " const char *augpath);\n"
6917 #: ../src/guestfs-actions.pod:475 ../fish/guestfish-actions.pod:311
6919 "Returns a list of paths which match the path expression C<path>. The "
6920 "returned paths are sufficiently qualified so that they match exactly one "
6921 "node in the current tree."
6925 #: ../src/guestfs-actions.pod:485
6926 msgid "guestfs_aug_mv"
6930 #: ../src/guestfs-actions.pod:487
6934 " guestfs_aug_mv (guestfs_h *g,\n"
6935 " const char *src,\n"
6936 " const char *dest);\n"
6941 #: ../src/guestfs-actions.pod:492 ../fish/guestfish-actions.pod:319
6943 "Move the node C<src> to C<dest>. C<src> must match exactly one node. "
6944 "C<dest> is overwritten if it exists."
6948 #: ../src/guestfs-actions.pod:499
6949 msgid "guestfs_aug_rm"
6953 #: ../src/guestfs-actions.pod:501
6957 " guestfs_aug_rm (guestfs_h *g,\n"
6958 " const char *augpath);\n"
6963 #: ../src/guestfs-actions.pod:505 ../fish/guestfish-actions.pod:326
6964 msgid "Remove C<path> and all of its children."
6968 #: ../src/guestfs-actions.pod:507 ../fish/guestfish-actions.pod:328
6969 msgid "On success this returns the number of entries which were removed."
6973 #: ../src/guestfs-actions.pod:513
6974 msgid "guestfs_aug_save"
6978 #: ../src/guestfs-actions.pod:515
6982 " guestfs_aug_save (guestfs_h *g);\n"
6987 #: ../src/guestfs-actions.pod:518 ../fish/guestfish-actions.pod:334
6988 msgid "This writes all pending changes to disk."
6992 #: ../src/guestfs-actions.pod:520
6994 "The flags which were passed to C<guestfs_aug_init> affect exactly how files "
6999 #: ../src/guestfs-actions.pod:527
7000 msgid "guestfs_aug_set"
7004 #: ../src/guestfs-actions.pod:529
7008 " guestfs_aug_set (guestfs_h *g,\n"
7009 " const char *augpath,\n"
7010 " const char *val);\n"
7015 #: ../src/guestfs-actions.pod:534 ../fish/guestfish-actions.pod:343
7016 msgid "Set the value associated with C<path> to C<val>."
7020 #: ../src/guestfs-actions.pod:536
7022 "In the Augeas API, it is possible to clear a node by setting the value to "
7023 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
7024 "this call. Instead you must use the C<guestfs_aug_clear> call."
7028 #: ../src/guestfs-actions.pod:545
7029 msgid "guestfs_available"
7033 #: ../src/guestfs-actions.pod:547
7037 " guestfs_available (guestfs_h *g,\n"
7038 " char *const *groups);\n"
7043 #: ../src/guestfs-actions.pod:551 ../fish/guestfish-actions.pod:354
7045 "This command is used to check the availability of some groups of "
7046 "functionality in the appliance, which not all builds of the libguestfs "
7047 "appliance will be able to provide."
7051 #: ../src/guestfs-actions.pod:555
7053 "The libguestfs groups, and the functions that those groups correspond to, "
7054 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
7055 "runtime by calling C<guestfs_available_all_groups>."
7059 #: ../src/guestfs-actions.pod:560 ../fish/guestfish-actions.pod:363
7061 "The argument C<groups> is a list of group names, eg: C<[\"inotify\", \"augeas"
7062 "\"]> would check for the availability of the Linux inotify functions and "
7063 "Augeas (configuration file editing) functions."
7067 #: ../src/guestfs-actions.pod:565 ../fish/guestfish-actions.pod:368
7068 msgid "The command returns no error if I<all> requested groups are available."
7072 #: ../src/guestfs-actions.pod:567 ../fish/guestfish-actions.pod:370
7074 "It fails with an error if one or more of the requested groups is unavailable "
7079 #: ../src/guestfs-actions.pod:570 ../fish/guestfish-actions.pod:373
7081 "If an unknown group name is included in the list of groups then an error is "
7086 #: ../src/guestfs-actions.pod:573 ../fish/guestfish-actions.pod:376
7088 msgstr "I<Нотатки:>"
7091 #: ../src/guestfs-actions.pod:579
7092 msgid "You must call C<guestfs_launch> before calling this function."
7096 #: ../src/guestfs-actions.pod:581 ../fish/guestfish-actions.pod:384
7098 "The reason is because we don't know what groups are supported by the "
7099 "appliance/daemon until it is running and can be queried."
7103 #: ../src/guestfs-actions.pod:587 ../fish/guestfish-actions.pod:390
7105 "If a group of functions is available, this does not necessarily mean that "
7106 "they will work. You still have to check for errors when calling individual "
7107 "API functions even if they are available."
7111 #: ../src/guestfs-actions.pod:594 ../fish/guestfish-actions.pod:397
7113 "It is usually the job of distro packagers to build complete functionality "
7114 "into the libguestfs appliance. Upstream libguestfs, if built from source "
7115 "with all requirements satisfied, will support everything."
7119 #: ../src/guestfs-actions.pod:601
7121 "This call was added in version C<1.0.80>. In previous versions of "
7122 "libguestfs all you could do would be to speculatively execute a command to "
7123 "find out if the daemon implemented it. See also C<guestfs_version>."
7127 #: ../src/guestfs-actions.pod:610 ../src/guestfs-actions.pod:1171
7128 msgid "(Added in 1.0.80)"
7132 #: ../src/guestfs-actions.pod:612
7133 msgid "guestfs_available_all_groups"
7137 #: ../src/guestfs-actions.pod:614
7141 " guestfs_available_all_groups (guestfs_h *g);\n"
7146 #: ../src/guestfs-actions.pod:617
7148 "This command returns a list of all optional groups that this daemon knows "
7149 "about. Note this returns both supported and unsupported groups. To find "
7150 "out which ones the daemon can actually support you have to call "
7151 "C<guestfs_available> on each member of the returned list."
7155 #: ../src/guestfs-actions.pod:623
7156 msgid "See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>."
7160 #: ../src/guestfs-actions.pod:629
7161 msgid "(Added in 1.3.15)"
7165 #: ../src/guestfs-actions.pod:631
7166 msgid "guestfs_base64_in"
7170 #: ../src/guestfs-actions.pod:633
7174 " guestfs_base64_in (guestfs_h *g,\n"
7175 " const char *base64file,\n"
7176 " const char *filename);\n"
7181 #: ../src/guestfs-actions.pod:638 ../fish/guestfish-actions.pod:427
7183 "This command uploads base64-encoded data from C<base64file> to C<filename>."
7187 #: ../src/guestfs-actions.pod:643 ../src/guestfs-actions.pod:657
7188 msgid "(Added in 1.3.5)"
7192 #: ../src/guestfs-actions.pod:645
7193 msgid "guestfs_base64_out"
7197 #: ../src/guestfs-actions.pod:647
7201 " guestfs_base64_out (guestfs_h *g,\n"
7202 " const char *filename,\n"
7203 " const char *base64file);\n"
7208 #: ../src/guestfs-actions.pod:652 ../fish/guestfish-actions.pod:436
7210 "This command downloads the contents of C<filename>, writing it out to local "
7211 "file C<base64file> encoded as base64."
7215 #: ../src/guestfs-actions.pod:659
7216 msgid "guestfs_blockdev_flushbufs"
7220 #: ../src/guestfs-actions.pod:661
7224 " guestfs_blockdev_flushbufs (guestfs_h *g,\n"
7225 " const char *device);\n"
7230 #: ../src/guestfs-actions.pod:665 ../fish/guestfish-actions.pod:445
7232 "This tells the kernel to flush internal buffers associated with C<device>."
7236 #: ../src/guestfs-actions.pod:668 ../src/guestfs-actions.pod:685
7237 #: ../src/guestfs-actions.pod:700 ../src/guestfs-actions.pod:716
7238 #: ../src/guestfs-actions.pod:734 ../src/guestfs-actions.pod:753
7239 #: ../src/guestfs-actions.pod:767 ../src/guestfs-actions.pod:785
7240 #: ../src/guestfs-actions.pod:799 ../src/guestfs-actions.pod:813
7241 #: ../fish/guestfish-actions.pod:448 ../fish/guestfish-actions.pod:459
7242 #: ../fish/guestfish-actions.pod:468 ../fish/guestfish-actions.pod:478
7243 #: ../fish/guestfish-actions.pod:490 ../fish/guestfish-actions.pod:503
7244 #: ../fish/guestfish-actions.pod:511 ../fish/guestfish-actions.pod:522
7245 #: ../fish/guestfish-actions.pod:530 ../fish/guestfish-actions.pod:538
7246 msgid "This uses the L<blockdev(8)> command."
7250 #: ../src/guestfs-actions.pod:672 ../src/guestfs-actions.pod:689
7251 #: ../src/guestfs-actions.pod:704 ../src/guestfs-actions.pod:720
7252 #: ../src/guestfs-actions.pod:738 ../src/guestfs-actions.pod:757
7253 #: ../src/guestfs-actions.pod:771 ../src/guestfs-actions.pod:789
7254 #: ../src/guestfs-actions.pod:803 ../src/guestfs-actions.pod:817
7255 msgid "(Added in 0.9.3)"
7259 #: ../src/guestfs-actions.pod:674
7260 msgid "guestfs_blockdev_getbsz"
7264 #: ../src/guestfs-actions.pod:676
7268 " guestfs_blockdev_getbsz (guestfs_h *g,\n"
7269 " const char *device);\n"
7274 #: ../src/guestfs-actions.pod:680 ../fish/guestfish-actions.pod:454
7275 msgid "This returns the block size of a device."
7279 #: ../src/guestfs-actions.pod:682 ../src/guestfs-actions.pod:782
7280 #: ../fish/guestfish-actions.pod:456 ../fish/guestfish-actions.pod:519
7282 "(Note this is different from both I<size in blocks> and I<filesystem block "
7287 #: ../src/guestfs-actions.pod:691
7288 msgid "guestfs_blockdev_getro"
7292 #: ../src/guestfs-actions.pod:693
7296 " guestfs_blockdev_getro (guestfs_h *g,\n"
7297 " const char *device);\n"
7302 #: ../src/guestfs-actions.pod:697 ../fish/guestfish-actions.pod:465
7304 "Returns a boolean indicating if the block device is read-only (true if read-"
7305 "only, false if not)."
7309 #: ../src/guestfs-actions.pod:702 ../src/guestfs-actions.pod:1409
7310 #: ../src/guestfs-actions.pod:1424 ../src/guestfs-actions.pod:1911
7311 #: ../src/guestfs-actions.pod:1922 ../src/guestfs-actions.pod:1994
7312 #: ../src/guestfs-actions.pod:2049 ../src/guestfs-actions.pod:2064
7313 #: ../src/guestfs-actions.pod:2089 ../src/guestfs-actions.pod:2112
7314 #: ../src/guestfs-actions.pod:3085 ../src/guestfs-actions.pod:3102
7315 #: ../src/guestfs-actions.pod:3121 ../src/guestfs-actions.pod:3284
7316 #: ../src/guestfs-actions.pod:3298 ../src/guestfs-actions.pod:3313
7317 #: ../src/guestfs-actions.pod:3327 ../src/guestfs-actions.pod:3343
7318 #: ../src/guestfs-actions.pod:3358 ../src/guestfs-actions.pod:3374
7319 #: ../src/guestfs-actions.pod:3388 ../src/guestfs-actions.pod:3401
7320 #: ../src/guestfs-actions.pod:3415 ../src/guestfs-actions.pod:3430
7321 #: ../src/guestfs-actions.pod:3445 ../src/guestfs-actions.pod:4992
7322 msgid "This function returns a C truth value on success or -1 on error."
7326 #: ../src/guestfs-actions.pod:706
7327 msgid "guestfs_blockdev_getsize64"
7331 #: ../src/guestfs-actions.pod:708
7335 " guestfs_blockdev_getsize64 (guestfs_h *g,\n"
7336 " const char *device);\n"
7341 #: ../src/guestfs-actions.pod:712 ../fish/guestfish-actions.pod:474
7342 msgid "This returns the size of the device in bytes."
7346 #: ../src/guestfs-actions.pod:714
7347 msgid "See also C<guestfs_blockdev_getsz>."
7351 #: ../src/guestfs-actions.pod:722
7352 msgid "guestfs_blockdev_getss"
7356 #: ../src/guestfs-actions.pod:724
7360 " guestfs_blockdev_getss (guestfs_h *g,\n"
7361 " const char *device);\n"
7366 #: ../src/guestfs-actions.pod:728 ../fish/guestfish-actions.pod:484
7368 "This returns the size of sectors on a block device. Usually 512, but can be "
7369 "larger for modern devices."
7373 #: ../src/guestfs-actions.pod:731
7375 "(Note, this is not the size in sectors, use C<guestfs_blockdev_getsz> for "
7380 #: ../src/guestfs-actions.pod:740
7381 msgid "guestfs_blockdev_getsz"
7385 #: ../src/guestfs-actions.pod:742
7389 " guestfs_blockdev_getsz (guestfs_h *g,\n"
7390 " const char *device);\n"
7395 #: ../src/guestfs-actions.pod:746 ../fish/guestfish-actions.pod:496
7397 "This returns the size of the device in units of 512-byte sectors (even if "
7398 "the sectorsize isn't 512 bytes ... weird)."
7402 #: ../src/guestfs-actions.pod:749
7404 "See also C<guestfs_blockdev_getss> for the real sector size of the device, "
7405 "and C<guestfs_blockdev_getsize64> for the more useful I<size in bytes>."
7409 #: ../src/guestfs-actions.pod:759
7410 msgid "guestfs_blockdev_rereadpt"
7414 #: ../src/guestfs-actions.pod:761
7418 " guestfs_blockdev_rereadpt (guestfs_h *g,\n"
7419 " const char *device);\n"
7424 #: ../src/guestfs-actions.pod:765 ../fish/guestfish-actions.pod:509
7425 msgid "Reread the partition table on C<device>."
7429 #: ../src/guestfs-actions.pod:773
7430 msgid "guestfs_blockdev_setbsz"
7434 #: ../src/guestfs-actions.pod:775
7438 " guestfs_blockdev_setbsz (guestfs_h *g,\n"
7439 " const char *device,\n"
7440 " int blocksize);\n"
7445 #: ../src/guestfs-actions.pod:780 ../fish/guestfish-actions.pod:517
7446 msgid "This sets the block size of a device."
7450 #: ../src/guestfs-actions.pod:791
7451 msgid "guestfs_blockdev_setro"
7455 #: ../src/guestfs-actions.pod:793
7459 " guestfs_blockdev_setro (guestfs_h *g,\n"
7460 " const char *device);\n"
7465 #: ../src/guestfs-actions.pod:797 ../fish/guestfish-actions.pod:528
7466 msgid "Sets the block device named C<device> to read-only."
7470 #: ../src/guestfs-actions.pod:805
7471 msgid "guestfs_blockdev_setrw"
7475 #: ../src/guestfs-actions.pod:807
7479 " guestfs_blockdev_setrw (guestfs_h *g,\n"
7480 " const char *device);\n"
7485 #: ../src/guestfs-actions.pod:811 ../fish/guestfish-actions.pod:536
7486 msgid "Sets the block device named C<device> to read-write."
7490 #: ../src/guestfs-actions.pod:819
7491 msgid "guestfs_case_sensitive_path"
7495 #: ../src/guestfs-actions.pod:821
7499 " guestfs_case_sensitive_path (guestfs_h *g,\n"
7500 " const char *path);\n"
7505 #: ../src/guestfs-actions.pod:825 ../fish/guestfish-actions.pod:544
7507 "This can be used to resolve case insensitive paths on a filesystem which is "
7508 "case sensitive. The use case is to resolve paths which you have read from "
7509 "Windows configuration files or the Windows Registry, to the true path."
7513 #: ../src/guestfs-actions.pod:830 ../fish/guestfish-actions.pod:549
7515 "The command handles a peculiarity of the Linux ntfs-3g filesystem driver "
7516 "(and probably others), which is that although the underlying filesystem is "
7517 "case-insensitive, the driver exports the filesystem to Linux as case-"
7522 #: ../src/guestfs-actions.pod:835 ../fish/guestfish-actions.pod:554
7524 "One consequence of this is that special directories such as C<c:\\windows> "
7525 "may appear as C</WINDOWS> or C</windows> (or other things) depending on the "
7526 "precise details of how they were created. In Windows itself this would not "
7531 #: ../src/guestfs-actions.pod:841 ../fish/guestfish-actions.pod:560
7533 "Bug or feature? You decide: L<http://www.tuxera.com/community/ntfs-3g-faq/"
7538 #: ../src/guestfs-actions.pod:844 ../fish/guestfish-actions.pod:563
7540 "This function resolves the true case of each element in the path and returns "
7541 "the case-sensitive path."
7545 #: ../src/guestfs-actions.pod:847
7547 "Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\") might return C<"
7548 "\"/WINDOWS/system32\"> (the exact return value would depend on details of "
7549 "how the directories were originally created under Windows)."
7553 #: ../src/guestfs-actions.pod:852 ../fish/guestfish-actions.pod:571
7554 msgid "I<Note>: This function does not handle drive names, backslashes etc."
7558 #: ../src/guestfs-actions.pod:855
7559 msgid "See also C<guestfs_realpath>."
7563 #: ../src/guestfs-actions.pod:860 ../src/guestfs-actions.pod:7011
7564 msgid "(Added in 1.0.75)"
7568 #: ../src/guestfs-actions.pod:862
7573 #: ../src/guestfs-actions.pod:864
7577 " guestfs_cat (guestfs_h *g,\n"
7578 " const char *path);\n"
7583 #: ../src/guestfs-actions.pod:868 ../src/guestfs-actions.pod:5479
7584 #: ../fish/guestfish-actions.pod:580 ../fish/guestfish-actions.pod:3680
7585 msgid "Return the contents of the file named C<path>."
7589 #: ../src/guestfs-actions.pod:870
7591 "Note that this function cannot correctly handle binary files (specifically, "
7592 "files containing C<\\0> character which is treated as end of string). For "
7593 "those you need to use the C<guestfs_read_file> or C<guestfs_download> "
7594 "functions which have a more complex interface."
7598 #: ../src/guestfs-actions.pod:878 ../src/guestfs-actions.pod:1057
7599 #: ../src/guestfs-actions.pod:1077 ../src/guestfs-actions.pod:1373
7600 #: ../src/guestfs-actions.pod:1392 ../src/guestfs-actions.pod:1495
7601 #: ../src/guestfs-actions.pod:1514 ../src/guestfs-actions.pod:1760
7602 #: ../src/guestfs-actions.pod:2218 ../src/guestfs-actions.pod:2237
7603 #: ../src/guestfs-actions.pod:2280 ../src/guestfs-actions.pod:2304
7604 #: ../src/guestfs-actions.pod:2321 ../src/guestfs-actions.pod:2350
7605 #: ../src/guestfs-actions.pod:5261 ../src/guestfs-actions.pod:5287
7606 #: ../src/guestfs-actions.pod:5418 ../src/guestfs-actions.pod:5444
7607 #: ../src/guestfs-actions.pod:5468 ../src/guestfs-actions.pod:6396
7608 #: ../src/guestfs-actions.pod:6451 ../src/guestfs-actions.pod:6597
7609 #: ../src/guestfs-actions.pod:6621 ../src/guestfs-actions.pod:7290
7610 #: ../src/guestfs-actions.pod:7316 ../src/guestfs-actions.pod:7342
7611 #: ../src/guestfs-actions.pod:7361 ../src/guestfs-actions.pod:7446
7612 #: ../src/guestfs-actions.pod:7465 ../src/guestfs-actions.pod:7511
7613 #: ../src/guestfs-actions.pod:7530 ../fish/guestfish-actions.pod:587
7614 #: ../fish/guestfish-actions.pod:722 ../fish/guestfish-actions.pod:734
7615 #: ../fish/guestfish-actions.pod:910 ../fish/guestfish-actions.pod:920
7616 #: ../fish/guestfish-actions.pod:987 ../fish/guestfish-actions.pod:997
7617 #: ../fish/guestfish-actions.pod:1189 ../fish/guestfish-actions.pod:1490
7618 #: ../fish/guestfish-actions.pod:1500 ../fish/guestfish-actions.pod:1528
7619 #: ../fish/guestfish-actions.pod:1543 ../fish/guestfish-actions.pod:1553
7620 #: ../fish/guestfish-actions.pod:1572 ../fish/guestfish-actions.pod:3550
7621 #: ../fish/guestfish-actions.pod:3565 ../fish/guestfish-actions.pod:3641
7622 #: ../fish/guestfish-actions.pod:3658 ../fish/guestfish-actions.pod:3673
7623 #: ../fish/guestfish-actions.pod:4327 ../fish/guestfish-actions.pod:4373
7624 #: ../fish/guestfish-actions.pod:4458 ../fish/guestfish-actions.pod:4473
7625 #: ../fish/guestfish-actions.pod:4883 ../fish/guestfish-actions.pod:4901
7626 #: ../fish/guestfish-actions.pod:4918 ../fish/guestfish-actions.pod:4928
7627 #: ../fish/guestfish-actions.pod:4976 ../fish/guestfish-actions.pod:4986
7628 #: ../fish/guestfish-actions.pod:5015 ../fish/guestfish-actions.pod:5025
7630 "Because of the message protocol, there is a transfer limit of somewhere "
7631 "between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
7635 #: ../src/guestfs-actions.pod:881 ../src/guestfs-actions.pod:3561
7636 #: ../src/guestfs-actions.pod:3623 ../src/guestfs-actions.pod:3640
7637 #: ../src/guestfs-actions.pod:3728 ../src/guestfs-actions.pod:4133
7638 #: ../src/guestfs-actions.pod:4147 ../src/guestfs-actions.pod:5367
7639 #: ../src/guestfs-actions.pod:5381 ../src/guestfs-actions.pod:7170
7640 #: ../src/guestfs-actions.pod:7184
7641 msgid "(Added in 0.4)"
7645 #: ../src/guestfs-actions.pod:883
7646 msgid "guestfs_checksum"
7650 #: ../src/guestfs-actions.pod:885
7654 " guestfs_checksum (guestfs_h *g,\n"
7655 " const char *csumtype,\n"
7656 " const char *path);\n"
7661 #: ../src/guestfs-actions.pod:890 ../fish/guestfish-actions.pod:594
7663 "This call computes the MD5, SHAx or CRC checksum of the file named C<path>."
7667 #: ../src/guestfs-actions.pod:893 ../fish/guestfish-actions.pod:597
7669 "The type of checksum to compute is given by the C<csumtype> parameter which "
7670 "must have one of the following values:"
7674 #: ../src/guestfs-actions.pod:898 ../fish/guestfish-actions.pod:602
7679 #: ../src/guestfs-actions.pod:900 ../fish/guestfish-actions.pod:604
7681 "Compute the cyclic redundancy check (CRC) specified by POSIX for the "
7686 #: ../src/guestfs-actions.pod:903 ../fish/guestfish-actions.pod:607
7691 #: ../src/guestfs-actions.pod:905 ../fish/guestfish-actions.pod:609
7692 msgid "Compute the MD5 hash (using the C<md5sum> program)."
7696 #: ../src/guestfs-actions.pod:907 ../fish/guestfish-actions.pod:611
7701 #: ../src/guestfs-actions.pod:909 ../fish/guestfish-actions.pod:613
7702 msgid "Compute the SHA1 hash (using the C<sha1sum> program)."
7706 #: ../src/guestfs-actions.pod:911 ../fish/guestfish-actions.pod:615
7711 #: ../src/guestfs-actions.pod:913 ../fish/guestfish-actions.pod:617
7712 msgid "Compute the SHA224 hash (using the C<sha224sum> program)."
7716 #: ../src/guestfs-actions.pod:915 ../fish/guestfish-actions.pod:619
7721 #: ../src/guestfs-actions.pod:917 ../fish/guestfish-actions.pod:621
7722 msgid "Compute the SHA256 hash (using the C<sha256sum> program)."
7726 #: ../src/guestfs-actions.pod:919 ../fish/guestfish-actions.pod:623
7731 #: ../src/guestfs-actions.pod:921 ../fish/guestfish-actions.pod:625
7732 msgid "Compute the SHA384 hash (using the C<sha384sum> program)."
7736 #: ../src/guestfs-actions.pod:923 ../fish/guestfish-actions.pod:627
7741 #: ../src/guestfs-actions.pod:925 ../fish/guestfish-actions.pod:629
7742 msgid "Compute the SHA512 hash (using the C<sha512sum> program)."
7746 #: ../src/guestfs-actions.pod:929 ../fish/guestfish-actions.pod:633
7747 msgid "The checksum is returned as a printable string."
7751 #: ../src/guestfs-actions.pod:931
7752 msgid "To get the checksum for a device, use C<guestfs_checksum_device>."
7756 #: ../src/guestfs-actions.pod:933
7757 msgid "To get the checksums for many files, use C<guestfs_checksums_out>."
7761 #: ../src/guestfs-actions.pod:938 ../src/guestfs-actions.pod:1246
7762 #: ../src/guestfs-actions.pod:2080 ../src/guestfs-actions.pod:3300
7763 #: ../src/guestfs-actions.pod:3329 ../src/guestfs-actions.pod:3390
7764 #: ../src/guestfs-actions.pod:3417 ../src/guestfs-actions.pod:6867
7765 msgid "(Added in 1.0.2)"
7769 #: ../src/guestfs-actions.pod:940
7770 msgid "guestfs_checksum_device"
7774 #: ../src/guestfs-actions.pod:942
7778 " guestfs_checksum_device (guestfs_h *g,\n"
7779 " const char *csumtype,\n"
7780 " const char *device);\n"
7785 #: ../src/guestfs-actions.pod:947
7787 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
7788 "device named C<device>. For the types of checksums supported see the "
7789 "C<guestfs_checksum> command."
7793 #: ../src/guestfs-actions.pod:954 ../src/guestfs-actions.pod:4898
7794 #: ../src/guestfs-actions.pod:4957 ../src/guestfs-actions.pod:4994
7795 #: ../src/guestfs-actions.pod:5012 ../src/guestfs-actions.pod:5188
7796 #: ../src/guestfs-actions.pod:6776 ../src/guestfs-actions.pod:6790
7797 #: ../src/guestfs-actions.pod:7196
7798 msgid "(Added in 1.3.2)"
7802 #: ../src/guestfs-actions.pod:956
7803 msgid "guestfs_checksums_out"
7807 #: ../src/guestfs-actions.pod:958
7811 " guestfs_checksums_out (guestfs_h *g,\n"
7812 " const char *csumtype,\n"
7813 " const char *directory,\n"
7814 " const char *sumsfile);\n"
7819 #: ../src/guestfs-actions.pod:964 ../fish/guestfish-actions.pod:651
7821 "This command computes the checksums of all regular files in C<directory> and "
7822 "then emits a list of those checksums to the local output file C<sumsfile>."
7826 #: ../src/guestfs-actions.pod:968 ../fish/guestfish-actions.pod:655
7828 "This can be used for verifying the integrity of a virtual machine. However "
7829 "to be properly secure you should pay attention to the output of the checksum "
7830 "command (it uses the ones from GNU coreutils). In particular when the "
7831 "filename is not printable, coreutils uses a special backslash syntax. For "
7832 "more information, see the GNU coreutils info file."
7836 #: ../src/guestfs-actions.pod:978
7837 msgid "(Added in 1.3.7)"
7841 #: ../src/guestfs-actions.pod:980
7842 msgid "guestfs_chmod"
7846 #: ../src/guestfs-actions.pod:982
7850 " guestfs_chmod (guestfs_h *g,\n"
7852 " const char *path);\n"
7857 #: ../src/guestfs-actions.pod:987 ../fish/guestfish-actions.pod:669
7859 "Change the mode (permissions) of C<path> to C<mode>. Only numeric modes are "
7864 #: ../src/guestfs-actions.pod:990 ../fish/guestfish-actions.pod:672
7866 "I<Note>: When using this command from guestfish, C<mode> by default would be "
7867 "decimal, unless you prefix it with C<0> to get octal, ie. use C<0700> not "
7872 #: ../src/guestfs-actions.pod:994 ../src/guestfs-actions.pod:4384
7873 #: ../src/guestfs-actions.pod:4581 ../src/guestfs-actions.pod:4600
7874 #: ../src/guestfs-actions.pod:4619 ../fish/guestfish-actions.pod:676
7875 #: ../fish/guestfish-actions.pod:2980 ../fish/guestfish-actions.pod:3109
7876 #: ../fish/guestfish-actions.pod:3119 ../fish/guestfish-actions.pod:3129
7877 msgid "The mode actually set is affected by the umask."
7881 #: ../src/guestfs-actions.pod:1000
7882 msgid "guestfs_chown"
7886 #: ../src/guestfs-actions.pod:1002
7890 " guestfs_chown (guestfs_h *g,\n"
7893 " const char *path);\n"
7898 #: ../src/guestfs-actions.pod:1008 ../fish/guestfish-actions.pod:682
7899 msgid "Change the file owner to C<owner> and group to C<group>."
7903 #: ../src/guestfs-actions.pod:1010 ../src/guestfs-actions.pod:3492
7904 #: ../fish/guestfish-actions.pod:684 ../fish/guestfish-actions.pod:2438
7906 "Only numeric uid and gid are supported. If you want to use names, you will "
7907 "need to locate and parse the password file yourself (Augeas support makes "
7908 "this relatively easy)."
7912 #: ../src/guestfs-actions.pod:1018
7913 msgid "guestfs_command"
7917 #: ../src/guestfs-actions.pod:1020
7921 " guestfs_command (guestfs_h *g,\n"
7922 " char *const *arguments);\n"
7927 #: ../src/guestfs-actions.pod:1024 ../fish/guestfish-actions.pod:692
7929 "This call runs a command from the guest filesystem. The filesystem must be "
7930 "mounted, and must contain a compatible operating system (ie. something "
7931 "Linux, with the same or compatible processor architecture)."
7935 #: ../src/guestfs-actions.pod:1029
7937 "The single parameter is an argv-style list of arguments. The first element "
7938 "is the name of the program to run. Subsequent elements are parameters. The "
7939 "list must be non-empty (ie. must contain a program name). Note that the "
7940 "command runs directly, and is I<not> invoked via the shell (see "
7945 #: ../src/guestfs-actions.pod:1036 ../fish/guestfish-actions.pod:704
7946 msgid "The return value is anything printed to I<stdout> by the command."
7950 #: ../src/guestfs-actions.pod:1039 ../fish/guestfish-actions.pod:707
7952 "If the command returns a non-zero exit status, then this function returns an "
7953 "error message. The error message string is the content of I<stderr> from "
7958 #: ../src/guestfs-actions.pod:1043 ../fish/guestfish-actions.pod:711
7960 "The C<$PATH> environment variable will contain at least C</usr/bin> and C</"
7961 "bin>. If you require a program from another location, you should provide "
7962 "the full path in the first parameter."
7966 #: ../src/guestfs-actions.pod:1048 ../fish/guestfish-actions.pod:716
7968 "Shared libraries and data files required by the program must be available on "
7969 "filesystems which are mounted in the correct places. It is the caller's "
7970 "responsibility to ensure all filesystems that are needed are mounted at the "
7975 #: ../src/guestfs-actions.pod:1060 ../src/guestfs-actions.pod:1080
7976 #: ../src/guestfs-actions.pod:1545
7977 msgid "(Added in 0.9.1)"
7981 #: ../src/guestfs-actions.pod:1062
7982 msgid "guestfs_command_lines"
7986 #: ../src/guestfs-actions.pod:1064
7990 " guestfs_command_lines (guestfs_h *g,\n"
7991 " char *const *arguments);\n"
7996 #: ../src/guestfs-actions.pod:1068
7998 "This is the same as C<guestfs_command>, but splits the result into a list of "
8003 #: ../src/guestfs-actions.pod:1071
8004 msgid "See also: C<guestfs_sh_lines>"
8008 #: ../src/guestfs-actions.pod:1082
8009 msgid "guestfs_config"
8013 #: ../src/guestfs-actions.pod:1084
8017 " guestfs_config (guestfs_h *g,\n"
8018 " const char *qemuparam,\n"
8019 " const char *qemuvalue);\n"
8024 #: ../src/guestfs-actions.pod:1089 ../fish/guestfish-actions.pod:741
8026 "This can be used to add arbitrary qemu command line parameters of the form "
8027 "I<-param value>. Actually it's not quite arbitrary - we prevent you from "
8028 "setting some parameters which would interfere with parameters that we use."
8032 #: ../src/guestfs-actions.pod:1094 ../fish/guestfish-actions.pod:746
8033 msgid "The first character of C<param> string must be a C<-> (dash)."
8037 #: ../src/guestfs-actions.pod:1096 ../fish/guestfish-actions.pod:748
8038 msgid "C<value> can be NULL."
8042 #: ../src/guestfs-actions.pod:1102
8043 msgid "guestfs_copy_size"
8047 #: ../src/guestfs-actions.pod:1104
8051 " guestfs_copy_size (guestfs_h *g,\n"
8052 " const char *src,\n"
8053 " const char *dest,\n"
8059 #: ../src/guestfs-actions.pod:1110 ../fish/guestfish-actions.pod:754
8061 "This command copies exactly C<size> bytes from one source device or file "
8062 "C<src> to another destination device or file C<dest>."
8066 #: ../src/guestfs-actions.pod:1113 ../fish/guestfish-actions.pod:757
8068 "Note this will fail if the source is too short or if the destination is not "
8073 #: ../src/guestfs-actions.pod:1118 ../src/guestfs-actions.pod:1241
8074 #: ../src/guestfs-actions.pod:1272 ../src/guestfs-actions.pod:1317
8075 #: ../src/guestfs-actions.pod:1694 ../src/guestfs-actions.pod:1716
8076 #: ../src/guestfs-actions.pod:3473 ../src/guestfs-actions.pod:6862
8077 #: ../src/guestfs-actions.pod:6896 ../src/guestfs-actions.pod:7382
8078 #: ../src/guestfs-actions.pod:7401
8080 "This long-running command can generate progress notification messages so "
8081 "that the caller can display a progress bar or indicator. To receive these "
8082 "messages, the caller must register a progress event callback. See L<guestfs"
8083 "(3)/GUESTFS_EVENT_PROGRESS>."
8087 #: ../src/guestfs-actions.pod:1123 ../src/guestfs-actions.pod:4160
8088 #: ../src/guestfs-actions.pod:5394 ../src/guestfs-actions.pod:7103
8089 #: ../src/guestfs-actions.pod:7123 ../src/guestfs-actions.pod:7209
8090 msgid "(Added in 1.0.87)"
8094 #: ../src/guestfs-actions.pod:1125
8099 #: ../src/guestfs-actions.pod:1127
8103 " guestfs_cp (guestfs_h *g,\n"
8104 " const char *src,\n"
8105 " const char *dest);\n"
8110 #: ../src/guestfs-actions.pod:1132 ../fish/guestfish-actions.pod:764
8112 "This copies a file from C<src> to C<dest> where C<dest> is either a "
8113 "destination filename or destination directory."
8117 #: ../src/guestfs-actions.pod:1137 ../src/guestfs-actions.pod:1151
8118 #: ../src/guestfs-actions.pod:1223 ../src/guestfs-actions.pod:1297
8119 #: ../src/guestfs-actions.pod:1411 ../src/guestfs-actions.pod:4852
8120 #: ../src/guestfs-actions.pod:5238
8121 msgid "(Added in 1.0.18)"
8125 #: ../src/guestfs-actions.pod:1139
8126 msgid "guestfs_cp_a"
8130 #: ../src/guestfs-actions.pod:1141
8134 " guestfs_cp_a (guestfs_h *g,\n"
8135 " const char *src,\n"
8136 " const char *dest);\n"
8141 #: ../src/guestfs-actions.pod:1146 ../fish/guestfish-actions.pod:771
8143 "This copies a file or directory from C<src> to C<dest> recursively using the "
8148 #: ../src/guestfs-actions.pod:1153
8153 #: ../src/guestfs-actions.pod:1155
8157 " guestfs_dd (guestfs_h *g,\n"
8158 " const char *src,\n"
8159 " const char *dest);\n"
8164 #: ../src/guestfs-actions.pod:1160 ../fish/guestfish-actions.pod:778
8166 "This command copies from one source device or file C<src> to another "
8167 "destination device or file C<dest>. Normally you would use this to copy to "
8168 "or from a device or partition, for example to duplicate a filesystem."
8172 #: ../src/guestfs-actions.pod:1165
8174 "If the destination is a device, it must be as large or larger than the "
8175 "source file or device, otherwise the copy will fail. This command cannot do "
8176 "partial copies (see C<guestfs_copy_size>)."
8180 #: ../src/guestfs-actions.pod:1173
8185 #: ../src/guestfs-actions.pod:1175
8189 " guestfs_df (guestfs_h *g);\n"
8194 #: ../src/guestfs-actions.pod:1178 ../fish/guestfish-actions.pod:791
8195 msgid "This command runs the C<df> command to report disk space used."
8199 #: ../src/guestfs-actions.pod:1180 ../src/guestfs-actions.pod:1197
8201 "This command is mostly useful for interactive sessions. It is I<not> "
8202 "intended that you try to parse the output string. Use C<guestfs_statvfs> "
8207 #: ../src/guestfs-actions.pod:1187 ../src/guestfs-actions.pod:1204
8208 #: ../src/guestfs-actions.pod:1322 ../src/guestfs-actions.pod:2283
8209 #: ../src/guestfs-actions.pod:2307 ../src/guestfs-actions.pod:2375
8210 #: ../src/guestfs-actions.pod:4270 ../src/guestfs-actions.pod:4752
8211 #: ../src/guestfs-actions.pod:6600 ../src/guestfs-actions.pod:6624
8212 #: ../src/guestfs-actions.pod:7249 ../src/guestfs-actions.pod:7262
8213 #: ../src/guestfs-actions.pod:7275
8214 msgid "(Added in 1.0.54)"
8218 #: ../src/guestfs-actions.pod:1189
8219 msgid "guestfs_df_h"
8223 #: ../src/guestfs-actions.pod:1191
8227 " guestfs_df_h (guestfs_h *g);\n"
8232 #: ../src/guestfs-actions.pod:1194 ../fish/guestfish-actions.pod:801
8234 "This command runs the C<df -h> command to report disk space used in human-"
8239 #: ../src/guestfs-actions.pod:1206
8240 msgid "guestfs_dmesg"
8244 #: ../src/guestfs-actions.pod:1208
8248 " guestfs_dmesg (guestfs_h *g);\n"
8253 #: ../src/guestfs-actions.pod:1211 ../fish/guestfish-actions.pod:812
8255 "This returns the kernel messages (C<dmesg> output) from the guest kernel. "
8256 "This is sometimes useful for extended debugging of problems."
8260 #: ../src/guestfs-actions.pod:1215
8262 "Another way to get the same information is to enable verbose messages with "
8263 "C<guestfs_set_verbose> or by setting the environment variable "
8264 "C<LIBGUESTFS_DEBUG=1> before running the program."
8268 #: ../src/guestfs-actions.pod:1225
8269 msgid "guestfs_download"
8273 #: ../src/guestfs-actions.pod:1227
8277 " guestfs_download (guestfs_h *g,\n"
8278 " const char *remotefilename,\n"
8279 " const char *filename);\n"
8284 #: ../src/guestfs-actions.pod:1232 ../src/guestfs-actions.pod:1257
8285 #: ../fish/guestfish-actions.pod:825 ../fish/guestfish-actions.pod:838
8287 "Download file C<remotefilename> and save it as C<filename> on the local "
8292 #: ../src/guestfs-actions.pod:1235 ../src/guestfs-actions.pod:6856
8293 #: ../fish/guestfish-actions.pod:828 ../fish/guestfish-actions.pod:4631
8294 msgid "C<filename> can also be a named pipe."
8298 #: ../src/guestfs-actions.pod:1237
8299 msgid "See also C<guestfs_upload>, C<guestfs_cat>."
8303 #: ../src/guestfs-actions.pod:1248
8304 msgid "guestfs_download_offset"
8308 #: ../src/guestfs-actions.pod:1250
8312 " guestfs_download_offset (guestfs_h *g,\n"
8313 " const char *remotefilename,\n"
8314 " const char *filename,\n"
8315 " int64_t offset,\n"
8321 #: ../src/guestfs-actions.pod:1260 ../fish/guestfish-actions.pod:841
8323 "C<remotefilename> is read for C<size> bytes starting at C<offset> (this "
8324 "region must be within the file or device)."
8328 #: ../src/guestfs-actions.pod:1263
8330 "Note that there is no limit on the amount of data that can be downloaded "
8331 "with this call, unlike with C<guestfs_pread>, and this call always reads the "
8332 "full amount unless an error occurs."
8336 #: ../src/guestfs-actions.pod:1268
8337 msgid "See also C<guestfs_download>, C<guestfs_pread>."
8341 #: ../src/guestfs-actions.pod:1277 ../src/guestfs-actions.pod:6901
8342 msgid "(Added in 1.5.17)"
8346 #: ../src/guestfs-actions.pod:1279
8347 msgid "guestfs_drop_caches"
8351 #: ../src/guestfs-actions.pod:1281
8355 " guestfs_drop_caches (guestfs_h *g,\n"
8356 " int whattodrop);\n"
8361 #: ../src/guestfs-actions.pod:1285 ../fish/guestfish-actions.pod:857
8363 "This instructs the guest kernel to drop its page cache, and/or dentries and "
8364 "inode caches. The parameter C<whattodrop> tells the kernel what precisely "
8365 "to drop, see L<http://linux-mm.org/Drop_Caches>"
8369 #: ../src/guestfs-actions.pod:1290 ../fish/guestfish-actions.pod:862
8370 msgid "Setting C<whattodrop> to 3 should drop everything."
8374 #: ../src/guestfs-actions.pod:1292 ../fish/guestfish-actions.pod:864
8376 "This automatically calls L<sync(2)> before the operation, so that the "
8377 "maximum guest memory is freed."
8381 #: ../src/guestfs-actions.pod:1299
8386 #: ../src/guestfs-actions.pod:1301
8390 " guestfs_du (guestfs_h *g,\n"
8391 " const char *path);\n"
8396 #: ../src/guestfs-actions.pod:1305 ../fish/guestfish-actions.pod:871
8398 "This command runs the C<du -s> command to estimate file space usage for "
8403 #: ../src/guestfs-actions.pod:1308 ../fish/guestfish-actions.pod:874
8405 "C<path> can be a file or a directory. If C<path> is a directory then the "
8406 "estimate includes the contents of the directory and all subdirectories "
8411 #: ../src/guestfs-actions.pod:1312 ../fish/guestfish-actions.pod:878
8413 "The result is the estimated size in I<kilobytes> (ie. units of 1024 bytes)."
8417 #: ../src/guestfs-actions.pod:1324
8418 msgid "guestfs_e2fsck_f"
8422 #: ../src/guestfs-actions.pod:1326
8426 " guestfs_e2fsck_f (guestfs_h *g,\n"
8427 " const char *device);\n"
8432 #: ../src/guestfs-actions.pod:1330 ../fish/guestfish-actions.pod:885
8434 "This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3 filesystem checker "
8435 "on C<device>, noninteractively (I<-p>), even if the filesystem appears to be "
8440 #: ../src/guestfs-actions.pod:1334
8442 "This command is only needed because of C<guestfs_resize2fs> (q.v.). "
8443 "Normally you should use C<guestfs_fsck>."
8447 #: ../src/guestfs-actions.pod:1339
8448 msgid "(Added in 1.0.29)"
8452 #: ../src/guestfs-actions.pod:1341
8453 msgid "guestfs_echo_daemon"
8457 #: ../src/guestfs-actions.pod:1343
8461 " guestfs_echo_daemon (guestfs_h *g,\n"
8462 " char *const *words);\n"
8467 #: ../src/guestfs-actions.pod:1347 ../fish/guestfish-actions.pod:896
8469 "This command concatenates the list of C<words> passed with single spaces "
8470 "between them and returns the resulting string."
8474 #: ../src/guestfs-actions.pod:1350 ../fish/guestfish-actions.pod:899
8475 msgid "You can use this command to test the connection through to the daemon."
8479 #: ../src/guestfs-actions.pod:1352
8480 msgid "See also C<guestfs_ping_daemon>."
8484 #: ../src/guestfs-actions.pod:1357 ../src/guestfs-actions.pod:2091
8485 #: ../src/guestfs-actions.pod:6072
8486 msgid "(Added in 1.0.69)"
8490 #: ../src/guestfs-actions.pod:1359
8491 msgid "guestfs_egrep"
8495 #: ../src/guestfs-actions.pod:1361
8499 " guestfs_egrep (guestfs_h *g,\n"
8500 " const char *regex,\n"
8501 " const char *path);\n"
8506 #: ../src/guestfs-actions.pod:1366 ../fish/guestfish-actions.pod:907
8508 "This calls the external C<egrep> program and returns the matching lines."
8512 #: ../src/guestfs-actions.pod:1376 ../src/guestfs-actions.pod:1395
8513 #: ../src/guestfs-actions.pod:1452 ../src/guestfs-actions.pod:1498
8514 #: ../src/guestfs-actions.pod:1517 ../src/guestfs-actions.pod:2221
8515 #: ../src/guestfs-actions.pod:2240 ../src/guestfs-actions.pod:2396
8516 #: ../src/guestfs-actions.pod:2409 ../src/guestfs-actions.pod:2424
8517 #: ../src/guestfs-actions.pod:2470 ../src/guestfs-actions.pod:2492
8518 #: ../src/guestfs-actions.pod:2505 ../src/guestfs-actions.pod:3653
8519 #: ../src/guestfs-actions.pod:3667 ../src/guestfs-actions.pod:3680
8520 #: ../src/guestfs-actions.pod:3694 ../src/guestfs-actions.pod:4680
8521 #: ../src/guestfs-actions.pod:5572 ../src/guestfs-actions.pod:5621
8522 #: ../src/guestfs-actions.pod:6468 ../src/guestfs-actions.pod:6480
8523 #: ../src/guestfs-actions.pod:6493 ../src/guestfs-actions.pod:6506
8524 #: ../src/guestfs-actions.pod:6528 ../src/guestfs-actions.pod:6541
8525 #: ../src/guestfs-actions.pod:6554 ../src/guestfs-actions.pod:6567
8526 #: ../src/guestfs-actions.pod:7345 ../src/guestfs-actions.pod:7364
8527 #: ../src/guestfs-actions.pod:7449 ../src/guestfs-actions.pod:7468
8528 #: ../src/guestfs-actions.pod:7514 ../src/guestfs-actions.pod:7533
8529 msgid "(Added in 1.0.66)"
8533 #: ../src/guestfs-actions.pod:1378
8534 msgid "guestfs_egrepi"
8538 #: ../src/guestfs-actions.pod:1380
8542 " guestfs_egrepi (guestfs_h *g,\n"
8543 " const char *regex,\n"
8544 " const char *path);\n"
8549 #: ../src/guestfs-actions.pod:1385 ../fish/guestfish-actions.pod:917
8551 "This calls the external C<egrep -i> program and returns the matching lines."
8555 #: ../src/guestfs-actions.pod:1397
8556 msgid "guestfs_equal"
8560 #: ../src/guestfs-actions.pod:1399
8564 " guestfs_equal (guestfs_h *g,\n"
8565 " const char *file1,\n"
8566 " const char *file2);\n"
8571 #: ../src/guestfs-actions.pod:1404 ../fish/guestfish-actions.pod:927
8573 "This compares the two files C<file1> and C<file2> and returns true if their "
8574 "content is exactly equal, or false otherwise."
8578 #: ../src/guestfs-actions.pod:1407 ../fish/guestfish-actions.pod:930
8579 msgid "The external L<cmp(1)> program is used for the comparison."
8583 #: ../src/guestfs-actions.pod:1413
8584 msgid "guestfs_exists"
8588 #: ../src/guestfs-actions.pod:1415
8592 " guestfs_exists (guestfs_h *g,\n"
8593 " const char *path);\n"
8598 #: ../src/guestfs-actions.pod:1419 ../fish/guestfish-actions.pod:936
8600 "This returns C<true> if and only if there is a file, directory (or anything) "
8601 "with the given C<path> name."
8605 #: ../src/guestfs-actions.pod:1422
8606 msgid "See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>."
8610 #: ../src/guestfs-actions.pod:1428
8611 msgid "guestfs_fallocate"
8615 #: ../src/guestfs-actions.pod:1430
8619 " guestfs_fallocate (guestfs_h *g,\n"
8620 " const char *path,\n"
8626 #: ../src/guestfs-actions.pod:1435 ../src/guestfs-actions.pod:1461
8627 #: ../fish/guestfish-actions.pod:945 ../fish/guestfish-actions.pod:964
8629 "This command preallocates a file (containing zero bytes) named C<path> of "
8630 "size C<len> bytes. If the file exists already, it is overwritten."
8634 #: ../src/guestfs-actions.pod:1439 ../fish/guestfish-actions.pod:949
8636 "Do not confuse this with the guestfish-specific C<alloc> command which "
8637 "allocates a file in the host and attaches it as a device."
8641 #: ../src/guestfs-actions.pod:1445
8643 "This function is deprecated. In new code, use the L</guestfs_fallocate64> "
8648 #: ../src/guestfs-actions.pod:1454
8649 msgid "guestfs_fallocate64"
8653 #: ../src/guestfs-actions.pod:1456
8657 " guestfs_fallocate64 (guestfs_h *g,\n"
8658 " const char *path,\n"
8664 #: ../src/guestfs-actions.pod:1465
8666 "Note that this call allocates disk blocks for the file. To create a sparse "
8667 "file use C<guestfs_truncate_size> instead."
8671 #: ../src/guestfs-actions.pod:1468
8673 "The deprecated call C<guestfs_fallocate> does the same, but owing to an "
8674 "oversight it only allowed 30 bit lengths to be specified, effectively "
8675 "limiting the maximum size of files created through that call to 1GB."
8679 #: ../src/guestfs-actions.pod:1473 ../fish/guestfish-actions.pod:976
8681 "Do not confuse this with the guestfish-specific C<alloc> and C<sparse> "
8682 "commands which create a file in the host and attach it as a device."
8686 #: ../src/guestfs-actions.pod:1479
8687 msgid "(Added in 1.3.17)"
8691 #: ../src/guestfs-actions.pod:1481
8692 msgid "guestfs_fgrep"
8696 #: ../src/guestfs-actions.pod:1483
8700 " guestfs_fgrep (guestfs_h *g,\n"
8701 " const char *pattern,\n"
8702 " const char *path);\n"
8707 #: ../src/guestfs-actions.pod:1488 ../fish/guestfish-actions.pod:984
8709 "This calls the external C<fgrep> program and returns the matching lines."
8713 #: ../src/guestfs-actions.pod:1500
8714 msgid "guestfs_fgrepi"
8718 #: ../src/guestfs-actions.pod:1502
8722 " guestfs_fgrepi (guestfs_h *g,\n"
8723 " const char *pattern,\n"
8724 " const char *path);\n"
8729 #: ../src/guestfs-actions.pod:1507 ../fish/guestfish-actions.pod:994
8731 "This calls the external C<fgrep -i> program and returns the matching lines."
8735 #: ../src/guestfs-actions.pod:1519
8736 msgid "guestfs_file"
8740 #: ../src/guestfs-actions.pod:1521
8744 " guestfs_file (guestfs_h *g,\n"
8745 " const char *path);\n"
8750 #: ../src/guestfs-actions.pod:1525 ../fish/guestfish-actions.pod:1004
8752 "This call uses the standard L<file(1)> command to determine the type or "
8753 "contents of the file."
8757 #: ../src/guestfs-actions.pod:1528 ../fish/guestfish-actions.pod:1007
8759 "This call will also transparently look inside various types of compressed "
8764 #: ../src/guestfs-actions.pod:1531 ../fish/guestfish-actions.pod:1010
8766 "The exact command which runs is C<file -zb path>. Note in particular that "
8767 "the filename is not prepended to the output (the I<-b> option)."
8771 #: ../src/guestfs-actions.pod:1535 ../fish/guestfish-actions.pod:1014
8773 "The output depends on the output of the underlying L<file(1)> command and it "
8774 "can change in future in ways beyond our control. In other words, the output "
8775 "is not guaranteed by the ABI."
8779 #: ../src/guestfs-actions.pod:1539
8781 "See also: L<file(1)>, C<guestfs_vfs_type>, C<guestfs_lstat>, "
8782 "C<guestfs_is_file>, C<guestfs_is_blockdev> (etc)."
8786 #: ../src/guestfs-actions.pod:1547
8787 msgid "guestfs_file_architecture"
8791 #: ../src/guestfs-actions.pod:1549
8795 " guestfs_file_architecture (guestfs_h *g,\n"
8796 " const char *filename);\n"
8801 #: ../src/guestfs-actions.pod:1553 ../fish/guestfish-actions.pod:1025
8803 "This detects the architecture of the binary C<filename>, and returns it if "
8808 #: ../src/guestfs-actions.pod:1556 ../fish/guestfish-actions.pod:1028
8809 msgid "Currently defined architectures are:"
8813 #: ../src/guestfs-actions.pod:1560 ../fish/guestfish-actions.pod:1032
8818 #: ../src/guestfs-actions.pod:1562 ../fish/guestfish-actions.pod:1034
8820 "This string is returned for all 32 bit i386, i486, i586, i686 binaries "
8821 "irrespective of the precise processor requirements of the binary."
8825 #: ../src/guestfs-actions.pod:1565 ../fish/guestfish-actions.pod:1037
8830 #: ../src/guestfs-actions.pod:1567 ../fish/guestfish-actions.pod:1039
8831 msgid "64 bit x86-64."
8835 #: ../src/guestfs-actions.pod:1569 ../fish/guestfish-actions.pod:1041
8840 #: ../src/guestfs-actions.pod:1571 ../fish/guestfish-actions.pod:1043
8841 msgid "32 bit SPARC."
8845 #: ../src/guestfs-actions.pod:1573 ../fish/guestfish-actions.pod:1045
8850 #: ../src/guestfs-actions.pod:1575 ../fish/guestfish-actions.pod:1047
8851 msgid "64 bit SPARC V9 and above."
8855 #: ../src/guestfs-actions.pod:1577 ../fish/guestfish-actions.pod:1049
8860 #: ../src/guestfs-actions.pod:1579 ../fish/guestfish-actions.pod:1051
8861 msgid "Intel Itanium."
8862 msgstr "Intel Itanium."
8865 #: ../src/guestfs-actions.pod:1581 ../fish/guestfish-actions.pod:1053
8870 #: ../src/guestfs-actions.pod:1583 ../fish/guestfish-actions.pod:1055
8871 msgid "32 bit Power PC."
8875 #: ../src/guestfs-actions.pod:1585 ../fish/guestfish-actions.pod:1057
8880 #: ../src/guestfs-actions.pod:1587 ../fish/guestfish-actions.pod:1059
8881 msgid "64 bit Power PC."
8885 #: ../src/guestfs-actions.pod:1591 ../fish/guestfish-actions.pod:1063
8886 msgid "Libguestfs may return other architecture strings in future."
8890 #: ../src/guestfs-actions.pod:1593 ../fish/guestfish-actions.pod:1065
8891 msgid "The function works on at least the following types of files:"
8895 #: ../src/guestfs-actions.pod:1599 ../fish/guestfish-actions.pod:1071
8896 msgid "many types of Un*x and Linux binary"
8900 #: ../src/guestfs-actions.pod:1603 ../fish/guestfish-actions.pod:1075
8901 msgid "many types of Un*x and Linux shared library"
8905 #: ../src/guestfs-actions.pod:1607 ../fish/guestfish-actions.pod:1079
8906 msgid "Windows Win32 and Win64 binaries"
8910 #: ../src/guestfs-actions.pod:1611 ../fish/guestfish-actions.pod:1083
8911 msgid "Windows Win32 and Win64 DLLs"
8915 #: ../src/guestfs-actions.pod:1613 ../fish/guestfish-actions.pod:1085
8916 msgid "Win32 binaries and DLLs return C<i386>."
8920 #: ../src/guestfs-actions.pod:1615 ../fish/guestfish-actions.pod:1087
8921 msgid "Win64 binaries and DLLs return C<x86_64>."
8925 #: ../src/guestfs-actions.pod:1619 ../fish/guestfish-actions.pod:1091
8926 msgid "Linux kernel modules"
8930 #: ../src/guestfs-actions.pod:1623 ../fish/guestfish-actions.pod:1095
8931 msgid "Linux new-style initrd images"
8935 #: ../src/guestfs-actions.pod:1627 ../fish/guestfish-actions.pod:1099
8936 msgid "some non-x86 Linux vmlinuz kernels"
8940 #: ../src/guestfs-actions.pod:1631 ../fish/guestfish-actions.pod:1103
8941 msgid "What it can't do currently:"
8945 #: ../src/guestfs-actions.pod:1637 ../fish/guestfish-actions.pod:1109
8946 msgid "static libraries (libfoo.a)"
8950 #: ../src/guestfs-actions.pod:1641 ../fish/guestfish-actions.pod:1113
8951 msgid "Linux old-style initrd as compressed ext2 filesystem (RHEL 3)"
8955 #: ../src/guestfs-actions.pod:1645 ../fish/guestfish-actions.pod:1117
8956 msgid "x86 Linux vmlinuz kernels"
8960 #: ../src/guestfs-actions.pod:1647 ../fish/guestfish-actions.pod:1119
8962 "x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and "
8963 "compressed code, and are horribly hard to unpack. If you want to find the "
8964 "architecture of a kernel, use the architecture of the associated initrd or "
8965 "kernel module(s) instead."
8969 #: ../src/guestfs-actions.pod:1657 ../src/guestfs-actions.pod:1820
8970 #: ../src/guestfs-actions.pod:1837 ../src/guestfs-actions.pod:2528
8971 #: ../src/guestfs-actions.pod:2621 ../src/guestfs-actions.pod:2691
8972 #: ../src/guestfs-actions.pod:2779 ../src/guestfs-actions.pod:2800
8973 #: ../src/guestfs-actions.pod:2843 ../src/guestfs-actions.pod:2927
8974 #: ../src/guestfs-actions.pod:3024 ../src/guestfs-actions.pod:3271
8975 #: ../src/guestfs-actions.pod:3403
8976 msgid "(Added in 1.5.3)"
8980 #: ../src/guestfs-actions.pod:1659
8981 msgid "guestfs_filesize"
8985 #: ../src/guestfs-actions.pod:1661
8989 " guestfs_filesize (guestfs_h *g,\n"
8990 " const char *file);\n"
8995 #: ../src/guestfs-actions.pod:1665 ../fish/guestfish-actions.pod:1130
8996 msgid "This command returns the size of C<file> in bytes."
9000 #: ../src/guestfs-actions.pod:1667
9002 "To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>, "
9003 "C<guestfs_is_dir>, C<guestfs_is_file> etc. To get the size of block "
9004 "devices, use C<guestfs_blockdev_getsize64>."
9008 #: ../src/guestfs-actions.pod:1673
9009 msgid "(Added in 1.0.82)"
9013 #: ../src/guestfs-actions.pod:1675
9014 msgid "guestfs_fill"
9018 #: ../src/guestfs-actions.pod:1677
9022 " guestfs_fill (guestfs_h *g,\n"
9025 " const char *path);\n"
9030 #: ../src/guestfs-actions.pod:1683 ../fish/guestfish-actions.pod:1140
9032 "This command creates a new file called C<path>. The initial content of the "
9033 "file is C<len> octets of C<c>, where C<c> must be a number in the range C<"
9038 #: ../src/guestfs-actions.pod:1687
9040 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
9041 "C<guestfs_truncate_size>. To create a file with a pattern of repeating "
9042 "bytes use C<guestfs_fill_pattern>."
9046 #: ../src/guestfs-actions.pod:1699
9047 msgid "(Added in 1.0.79)"
9051 #: ../src/guestfs-actions.pod:1701
9052 msgid "guestfs_fill_pattern"
9056 #: ../src/guestfs-actions.pod:1703
9060 " guestfs_fill_pattern (guestfs_h *g,\n"
9061 " const char *pattern,\n"
9063 " const char *path);\n"
9068 #: ../src/guestfs-actions.pod:1709
9070 "This function is like C<guestfs_fill> except that it creates a new file of "
9071 "length C<len> containing the repeating pattern of bytes in C<pattern>. The "
9072 "pattern is truncated if necessary to ensure the length of the file is "
9073 "exactly C<len> bytes."
9077 #: ../src/guestfs-actions.pod:1721
9078 msgid "(Added in 1.3.12)"
9082 #: ../src/guestfs-actions.pod:1723
9083 msgid "guestfs_find"
9087 #: ../src/guestfs-actions.pod:1725
9091 " guestfs_find (guestfs_h *g,\n"
9092 " const char *directory);\n"
9097 #: ../src/guestfs-actions.pod:1729 ../fish/guestfish-actions.pod:1162
9099 "This command lists out all files and directories, recursively, starting at "
9100 "C<directory>. It is essentially equivalent to running the shell command "
9101 "C<find directory -print> but some post-processing happens on the output, "
9106 #: ../src/guestfs-actions.pod:1734 ../fish/guestfish-actions.pod:1167
9108 "This returns a list of strings I<without any prefix>. Thus if the directory "
9113 #: ../src/guestfs-actions.pod:1737 ../fish/guestfish-actions.pod:1170
9123 #: ../src/guestfs-actions.pod:1741
9125 "then the returned list from C<guestfs_find> C</tmp> would be 4 elements:"
9129 #: ../src/guestfs-actions.pod:1744 ../fish/guestfish-actions.pod:1177
9140 #: ../src/guestfs-actions.pod:1749 ../fish/guestfish-actions.pod:1182
9141 msgid "If C<directory> is not a directory, then this command returns an error."
9145 #: ../src/guestfs-actions.pod:1752 ../fish/guestfish-actions.pod:1185
9146 msgid "The returned list is sorted."
9150 #: ../src/guestfs-actions.pod:1754
9151 msgid "See also C<guestfs_find0>."
9155 #: ../src/guestfs-actions.pod:1763 ../src/guestfs-actions.pod:4097
9156 #: ../src/guestfs-actions.pod:5656
9157 msgid "(Added in 1.0.27)"
9161 #: ../src/guestfs-actions.pod:1765
9162 msgid "guestfs_find0"
9166 #: ../src/guestfs-actions.pod:1767
9170 " guestfs_find0 (guestfs_h *g,\n"
9171 " const char *directory,\n"
9172 " const char *files);\n"
9177 #: ../src/guestfs-actions.pod:1772 ../fish/guestfish-actions.pod:1196
9179 "This command lists out all files and directories, recursively, starting at "
9180 "C<directory>, placing the resulting list in the external file called "
9185 #: ../src/guestfs-actions.pod:1776
9187 "This command works the same way as C<guestfs_find> with the following "
9192 #: ../src/guestfs-actions.pod:1783 ../fish/guestfish-actions.pod:1207
9193 msgid "The resulting list is written to an external file."
9197 #: ../src/guestfs-actions.pod:1787 ../fish/guestfish-actions.pod:1211
9199 "Items (filenames) in the result are separated by C<\\0> characters. See "
9200 "L<find(1)> option I<-print0>."
9204 #: ../src/guestfs-actions.pod:1792 ../fish/guestfish-actions.pod:1216
9205 msgid "This command is not limited in the number of names that it can return."
9209 #: ../src/guestfs-actions.pod:1797 ../fish/guestfish-actions.pod:1221
9210 msgid "The result list is not sorted."
9214 #: ../src/guestfs-actions.pod:1803
9215 msgid "(Added in 1.0.74)"
9219 #: ../src/guestfs-actions.pod:1805
9220 msgid "guestfs_findfs_label"
9224 #: ../src/guestfs-actions.pod:1807
9228 " guestfs_findfs_label (guestfs_h *g,\n"
9229 " const char *label);\n"
9234 #: ../src/guestfs-actions.pod:1811 ../fish/guestfish-actions.pod:1231
9236 "This command searches the filesystems and returns the one which has the "
9237 "given label. An error is returned if no such filesystem can be found."
9241 #: ../src/guestfs-actions.pod:1815
9242 msgid "To find the label of a filesystem, use C<guestfs_vfs_label>."
9246 #: ../src/guestfs-actions.pod:1822
9247 msgid "guestfs_findfs_uuid"
9251 #: ../src/guestfs-actions.pod:1824
9255 " guestfs_findfs_uuid (guestfs_h *g,\n"
9256 " const char *uuid);\n"
9261 #: ../src/guestfs-actions.pod:1828 ../fish/guestfish-actions.pod:1241
9263 "This command searches the filesystems and returns the one which has the "
9264 "given UUID. An error is returned if no such filesystem can be found."
9268 #: ../src/guestfs-actions.pod:1832
9269 msgid "To find the UUID of a filesystem, use C<guestfs_vfs_uuid>."
9273 #: ../src/guestfs-actions.pod:1839
9274 msgid "guestfs_fsck"
9278 #: ../src/guestfs-actions.pod:1841
9282 " guestfs_fsck (guestfs_h *g,\n"
9283 " const char *fstype,\n"
9284 " const char *device);\n"
9289 #: ../src/guestfs-actions.pod:1846 ../fish/guestfish-actions.pod:1251
9291 "This runs the filesystem checker (fsck) on C<device> which should have "
9292 "filesystem type C<fstype>."
9296 #: ../src/guestfs-actions.pod:1849 ../fish/guestfish-actions.pod:1254
9298 "The returned integer is the status. See L<fsck(8)> for the list of status "
9299 "codes from C<fsck>."
9303 #: ../src/guestfs-actions.pod:1858 ../fish/guestfish-actions.pod:1263
9304 msgid "Multiple status codes can be summed together."
9308 #: ../src/guestfs-actions.pod:1862 ../fish/guestfish-actions.pod:1267
9310 "A non-zero return code can mean \"success\", for example if errors have been "
9311 "corrected on the filesystem."
9315 #: ../src/guestfs-actions.pod:1867 ../fish/guestfish-actions.pod:1272
9316 msgid "Checking or repairing NTFS volumes is not supported (by linux-ntfs)."
9320 #: ../src/guestfs-actions.pod:1872 ../fish/guestfish-actions.pod:1277
9322 "This command is entirely equivalent to running C<fsck -a -t fstype device>."
9326 #: ../src/guestfs-actions.pod:1876 ../src/guestfs-actions.pod:7387
9327 msgid "(Added in 1.0.16)"
9331 #: ../src/guestfs-actions.pod:1878
9332 msgid "guestfs_get_append"
9336 #: ../src/guestfs-actions.pod:1880
9340 " guestfs_get_append (guestfs_h *g);\n"
9345 #: ../src/guestfs-actions.pod:1883 ../fish/guestfish-actions.pod:1283
9347 "Return the additional kernel options which are added to the guest kernel "
9352 #: ../src/guestfs-actions.pod:1886 ../fish/guestfish-actions.pod:1286
9353 msgid "If C<NULL> then no options are added."
9357 #: ../src/guestfs-actions.pod:1888
9359 "This function returns a string which may be NULL. There is no way to return "
9360 "an error from this function. The string is owned by the guest handle and "
9361 "must I<not> be freed."
9365 #: ../src/guestfs-actions.pod:1892 ../src/guestfs-actions.pod:5334
9366 #: ../src/guestfs-actions.pod:5814 ../src/guestfs-actions.pod:6235
9367 #: ../src/guestfs-actions.pod:6254 ../src/guestfs-actions.pod:6270
9368 #: ../src/guestfs-actions.pod:6294 ../src/guestfs-actions.pod:7051
9369 #: ../src/guestfs-actions.pod:7069 ../src/guestfs-actions.pod:7430
9370 msgid "(Added in 1.0.26)"
9374 #: ../src/guestfs-actions.pod:1894
9375 msgid "guestfs_get_attach_method"
9379 #: ../src/guestfs-actions.pod:1896
9383 " guestfs_get_attach_method (guestfs_h *g);\n"
9388 #: ../src/guestfs-actions.pod:1899
9389 msgid "Return the current attach method. See C<guestfs_set_attach_method>."
9393 #: ../src/guestfs-actions.pod:1904
9394 msgid "guestfs_get_autosync"
9398 #: ../src/guestfs-actions.pod:1906
9402 " guestfs_get_autosync (guestfs_h *g);\n"
9407 #: ../src/guestfs-actions.pod:1909 ../fish/guestfish-actions.pod:1298
9408 msgid "Get the autosync flag."
9412 #: ../src/guestfs-actions.pod:1915
9413 msgid "guestfs_get_direct"
9417 #: ../src/guestfs-actions.pod:1917
9421 " guestfs_get_direct (guestfs_h *g);\n"
9426 #: ../src/guestfs-actions.pod:1920 ../fish/guestfish-actions.pod:1304
9427 msgid "Return the direct appliance mode flag."
9431 #: ../src/guestfs-actions.pod:1924 ../src/guestfs-actions.pod:5883
9432 msgid "(Added in 1.0.72)"
9436 #: ../src/guestfs-actions.pod:1926
9437 msgid "guestfs_get_e2label"
9441 #: ../src/guestfs-actions.pod:1928
9445 " guestfs_get_e2label (guestfs_h *g,\n"
9446 " const char *device);\n"
9451 #: ../src/guestfs-actions.pod:1932 ../fish/guestfish-actions.pod:1310
9453 "This returns the ext2/3/4 filesystem label of the filesystem on C<device>."
9457 #: ../src/guestfs-actions.pod:1938
9459 "This function is deprecated. In new code, use the L</guestfs_vfs_label> "
9464 #: ../src/guestfs-actions.pod:1945 ../src/guestfs-actions.pod:1966
9465 #: ../src/guestfs-actions.pod:5901 ../src/guestfs-actions.pod:5920
9466 msgid "(Added in 1.0.15)"
9470 #: ../src/guestfs-actions.pod:1947
9471 msgid "guestfs_get_e2uuid"
9475 #: ../src/guestfs-actions.pod:1949
9479 " guestfs_get_e2uuid (guestfs_h *g,\n"
9480 " const char *device);\n"
9485 #: ../src/guestfs-actions.pod:1953 ../fish/guestfish-actions.pod:1324
9487 "This returns the ext2/3/4 filesystem UUID of the filesystem on C<device>."
9491 #: ../src/guestfs-actions.pod:1959
9493 "This function is deprecated. In new code, use the L</guestfs_vfs_uuid> call "
9498 #: ../src/guestfs-actions.pod:1968
9499 msgid "guestfs_get_memsize"
9503 #: ../src/guestfs-actions.pod:1970
9507 " guestfs_get_memsize (guestfs_h *g);\n"
9512 #: ../src/guestfs-actions.pod:1973 ../fish/guestfish-actions.pod:1338
9514 "This gets the memory size in megabytes allocated to the qemu subprocess."
9518 #: ../src/guestfs-actions.pod:1976
9520 "If C<guestfs_set_memsize> was not called on this handle, and if "
9521 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
9522 "value for memsize."
9526 #: ../src/guestfs-actions.pod:1980 ../src/guestfs-actions.pod:2061
9527 #: ../src/guestfs-actions.pod:5936 ../src/guestfs-actions.pod:6043
9528 #: ../fish/guestfish-actions.pod:1345 ../fish/guestfish-actions.pod:1396
9529 #: ../fish/guestfish-actions.pod:4006 ../fish/guestfish-actions.pod:4093
9531 "For more information on the architecture of libguestfs, see L<guestfs(3)>."
9535 #: ../src/guestfs-actions.pod:1985 ../src/guestfs-actions.pod:4388
9536 #: ../src/guestfs-actions.pod:4585 ../src/guestfs-actions.pod:4604
9537 #: ../src/guestfs-actions.pod:4623 ../src/guestfs-actions.pod:4635
9538 #: ../src/guestfs-actions.pod:4652 ../src/guestfs-actions.pod:4665
9539 #: ../src/guestfs-actions.pod:5559 ../src/guestfs-actions.pod:5941
9540 #: ../src/guestfs-actions.pod:6202 ../src/guestfs-actions.pod:6817
9541 msgid "(Added in 1.0.55)"
9545 #: ../src/guestfs-actions.pod:1987
9546 msgid "guestfs_get_network"
9550 #: ../src/guestfs-actions.pod:1989
9554 " guestfs_get_network (guestfs_h *g);\n"
9559 #: ../src/guestfs-actions.pod:1992 ../fish/guestfish-actions.pod:1352
9560 msgid "This returns the enable network flag."
9564 #: ../src/guestfs-actions.pod:1996 ../src/guestfs-actions.pod:5960
9565 msgid "(Added in 1.5.4)"
9569 #: ../src/guestfs-actions.pod:1998
9570 msgid "guestfs_get_path"
9574 #: ../src/guestfs-actions.pod:2000
9578 " guestfs_get_path (guestfs_h *g);\n"
9583 #: ../src/guestfs-actions.pod:2003 ../fish/guestfish-actions.pod:1358
9584 msgid "Return the current search path."
9588 #: ../src/guestfs-actions.pod:2005 ../fish/guestfish-actions.pod:1360
9590 "This is always non-NULL. If it wasn't set already, then this will return "
9595 #: ../src/guestfs-actions.pod:2008 ../src/guestfs-actions.pod:2037
9597 "This function returns a string, or NULL on error. The string is owned by "
9598 "the guest handle and must I<not> be freed."
9602 #: ../src/guestfs-actions.pod:2013
9603 msgid "guestfs_get_pid"
9607 #: ../src/guestfs-actions.pod:2015
9611 " guestfs_get_pid (guestfs_h *g);\n"
9616 #: ../src/guestfs-actions.pod:2018 ../fish/guestfish-actions.pod:1369
9618 "Return the process ID of the qemu subprocess. If there is no qemu "
9619 "subprocess, then this will return an error."
9623 #: ../src/guestfs-actions.pod:2021 ../fish/guestfish-actions.pod:1372
9624 msgid "This is an internal call used for debugging and testing."
9628 #: ../src/guestfs-actions.pod:2025
9629 msgid "(Added in 1.0.56)"
9633 #: ../src/guestfs-actions.pod:2027
9634 msgid "guestfs_get_qemu"
9638 #: ../src/guestfs-actions.pod:2029
9642 " guestfs_get_qemu (guestfs_h *g);\n"
9647 #: ../src/guestfs-actions.pod:2032 ../fish/guestfish-actions.pod:1378
9648 msgid "Return the current qemu binary."
9652 #: ../src/guestfs-actions.pod:2034 ../fish/guestfish-actions.pod:1380
9654 "This is always non-NULL. If it wasn't set already, then this will return "
9655 "the default qemu binary name."
9659 #: ../src/guestfs-actions.pod:2040 ../src/guestfs-actions.pod:6005
9660 msgid "(Added in 1.0.6)"
9664 #: ../src/guestfs-actions.pod:2042
9665 msgid "guestfs_get_recovery_proc"
9669 #: ../src/guestfs-actions.pod:2044
9673 " guestfs_get_recovery_proc (guestfs_h *g);\n"
9678 #: ../src/guestfs-actions.pod:2047 ../fish/guestfish-actions.pod:1387
9679 msgid "Return the recovery process enabled flag."
9683 #: ../src/guestfs-actions.pod:2051 ../src/guestfs-actions.pod:3498
9684 #: ../src/guestfs-actions.pod:3795 ../src/guestfs-actions.pod:4195
9685 #: ../src/guestfs-actions.pod:4227 ../src/guestfs-actions.pod:5264
9686 #: ../src/guestfs-actions.pod:5607 ../src/guestfs-actions.pod:6029
9687 #: ../src/guestfs-actions.pod:6720 ../src/guestfs-actions.pod:6740
9688 #: ../src/guestfs-actions.pod:6932
9689 msgid "(Added in 1.0.77)"
9693 #: ../src/guestfs-actions.pod:2053
9694 msgid "guestfs_get_selinux"
9698 #: ../src/guestfs-actions.pod:2055
9702 " guestfs_get_selinux (guestfs_h *g);\n"
9707 #: ../src/guestfs-actions.pod:2058
9709 "This returns the current setting of the selinux flag which is passed to the "
9710 "appliance at boot time. See C<guestfs_set_selinux>."
9714 #: ../src/guestfs-actions.pod:2066 ../src/guestfs-actions.pod:2129
9715 #: ../src/guestfs-actions.pod:6048 ../src/guestfs-actions.pod:6106
9716 msgid "(Added in 1.0.67)"
9720 #: ../src/guestfs-actions.pod:2068
9721 msgid "guestfs_get_state"
9725 #: ../src/guestfs-actions.pod:2070
9729 " guestfs_get_state (guestfs_h *g);\n"
9734 #: ../src/guestfs-actions.pod:2073 ../fish/guestfish-actions.pod:1403
9736 "This returns the current state as an opaque integer. This is only useful "
9737 "for printing debug and internal error messages."
9741 #: ../src/guestfs-actions.pod:2076 ../src/guestfs-actions.pod:3296
9742 #: ../src/guestfs-actions.pod:3325 ../src/guestfs-actions.pod:3386
9743 #: ../src/guestfs-actions.pod:3413 ../fish/guestfish-actions.pod:1406
9744 #: ../fish/guestfish-actions.pod:2320 ../fish/guestfish-actions.pod:2338
9745 #: ../fish/guestfish-actions.pod:2376 ../fish/guestfish-actions.pod:2392
9746 msgid "For more information on states, see L<guestfs(3)>."
9750 #: ../src/guestfs-actions.pod:2082
9751 msgid "guestfs_get_trace"
9755 #: ../src/guestfs-actions.pod:2084
9759 " guestfs_get_trace (guestfs_h *g);\n"
9764 #: ../src/guestfs-actions.pod:2087 ../fish/guestfish-actions.pod:1412
9765 msgid "Return the command trace flag."
9769 #: ../src/guestfs-actions.pod:2093
9770 msgid "guestfs_get_umask"
9774 #: ../src/guestfs-actions.pod:2095
9778 " guestfs_get_umask (guestfs_h *g);\n"
9783 #: ../src/guestfs-actions.pod:2098
9785 "Return the current umask. By default the umask is C<022> unless it has been "
9786 "set by calling C<guestfs_umask>."
9790 #: ../src/guestfs-actions.pod:2105
9791 msgid "guestfs_get_verbose"
9795 #: ../src/guestfs-actions.pod:2107
9799 " guestfs_get_verbose (guestfs_h *g);\n"
9804 #: ../src/guestfs-actions.pod:2110 ../fish/guestfish-actions.pod:1425
9805 msgid "This returns the verbose messages flag."
9809 #: ../src/guestfs-actions.pod:2116
9810 msgid "guestfs_getcon"
9814 #: ../src/guestfs-actions.pod:2118
9818 " guestfs_getcon (guestfs_h *g);\n"
9823 #: ../src/guestfs-actions.pod:2121 ../fish/guestfish-actions.pod:1431
9824 msgid "This gets the SELinux security context of the daemon."
9828 #: ../src/guestfs-actions.pod:2123
9830 "See the documentation about SELINUX in L<guestfs(3)>, and C<guestfs_setcon>"
9834 #: ../src/guestfs-actions.pod:2131
9835 msgid "guestfs_getxattr"
9839 #: ../src/guestfs-actions.pod:2133
9843 " guestfs_getxattr (guestfs_h *g,\n"
9844 " const char *path,\n"
9845 " const char *name,\n"
9846 " size_t *size_r);\n"
9851 #: ../src/guestfs-actions.pod:2139
9853 "Get a single extended attribute from file C<path> named C<name>. This call "
9854 "follows symlinks. If you want to lookup an extended attribute for the "
9855 "symlink itself, use C<guestfs_lgetxattr>."
9859 #: ../src/guestfs-actions.pod:2143 ../src/guestfs-actions.pod:3512
9861 "Normally it is better to get all extended attributes from a file in one go "
9862 "by calling C<guestfs_getxattrs>. However some Linux filesystem "
9863 "implementations are buggy and do not provide a way to list out attributes. "
9864 "For these filesystems (notably ntfs-3g) you have to know the names of the "
9865 "extended attributes you want in advance and call this function."
9869 #: ../src/guestfs-actions.pod:2150 ../src/guestfs-actions.pod:3519
9870 #: ../fish/guestfish-actions.pod:1451 ../fish/guestfish-actions.pod:2457
9872 "Extended attribute values are blobs of binary data. If there is no extended "
9873 "attribute named C<name>, this returns an error."
9877 #: ../src/guestfs-actions.pod:2153
9878 msgid "See also: C<guestfs_getxattrs>, C<guestfs_lgetxattr>, L<attr(5)>."
9882 #: ../src/guestfs-actions.pod:2155 ../src/guestfs-actions.pod:2346
9883 #: ../src/guestfs-actions.pod:3524 ../src/guestfs-actions.pod:5257
9884 #: ../src/guestfs-actions.pod:5283 ../src/guestfs-actions.pod:5464
9886 "This function returns a buffer, or NULL on error. The size of the returned "
9887 "buffer is written to C<*size_r>. I<The caller must free the returned buffer "
9892 #: ../src/guestfs-actions.pod:2159 ../src/guestfs-actions.pod:3528
9893 msgid "(Added in 1.7.24)"
9897 #: ../src/guestfs-actions.pod:2161
9898 msgid "guestfs_getxattrs"
9902 #: ../src/guestfs-actions.pod:2163
9905 " struct guestfs_xattr_list *\n"
9906 " guestfs_getxattrs (guestfs_h *g,\n"
9907 " const char *path);\n"
9912 #: ../src/guestfs-actions.pod:2167 ../fish/guestfish-actions.pod:1460
9914 "This call lists the extended attributes of the file or directory C<path>."
9918 #: ../src/guestfs-actions.pod:2170 ../fish/guestfish-actions.pod:1463
9920 "At the system call level, this is a combination of the L<listxattr(2)> and "
9921 "L<getxattr(2)> calls."
9925 #: ../src/guestfs-actions.pod:2173
9926 msgid "See also: C<guestfs_lgetxattrs>, L<attr(5)>."
9930 #: ../src/guestfs-actions.pod:2175 ../src/guestfs-actions.pod:3540
9931 #: ../src/guestfs-actions.pod:4191
9933 "This function returns a C<struct guestfs_xattr_list *>, or NULL if there was "
9934 "an error. I<The caller must call C<guestfs_free_xattr_list> after use>."
9938 #: ../src/guestfs-actions.pod:2179 ../src/guestfs-actions.pod:3544
9939 #: ../src/guestfs-actions.pod:3709 ../src/guestfs-actions.pod:3745
9940 #: ../src/guestfs-actions.pod:5637 ../src/guestfs-actions.pod:6125
9941 #: ../src/guestfs-actions.pod:7495
9942 msgid "(Added in 1.0.59)"
9946 #: ../src/guestfs-actions.pod:2181
9947 msgid "guestfs_glob_expand"
9951 #: ../src/guestfs-actions.pod:2183
9955 " guestfs_glob_expand (guestfs_h *g,\n"
9956 " const char *pattern);\n"
9961 #: ../src/guestfs-actions.pod:2187 ../fish/guestfish-actions.pod:1472
9963 "This command searches for all the pathnames matching C<pattern> according to "
9964 "the wildcard expansion rules used by the shell."
9968 #: ../src/guestfs-actions.pod:2191 ../fish/guestfish-actions.pod:1476
9970 "If no paths match, then this returns an empty list (note: not an error)."
9974 #: ../src/guestfs-actions.pod:2194 ../fish/guestfish-actions.pod:1479
9976 "It is just a wrapper around the C L<glob(3)> function with flags C<GLOB_MARK|"
9977 "GLOB_BRACE>. See that manual page for more details."
9981 #: ../src/guestfs-actions.pod:2202 ../src/guestfs-actions.pod:6318
9982 #: ../src/guestfs-actions.pod:6335
9983 msgid "(Added in 1.0.50)"
9987 #: ../src/guestfs-actions.pod:2204
9988 msgid "guestfs_grep"
9992 #: ../src/guestfs-actions.pod:2206
9996 " guestfs_grep (guestfs_h *g,\n"
9997 " const char *regex,\n"
9998 " const char *path);\n"
10003 #: ../src/guestfs-actions.pod:2211 ../fish/guestfish-actions.pod:1487
10004 msgid "This calls the external C<grep> program and returns the matching lines."
10008 #: ../src/guestfs-actions.pod:2223
10009 msgid "guestfs_grepi"
10013 #: ../src/guestfs-actions.pod:2225
10017 " guestfs_grepi (guestfs_h *g,\n"
10018 " const char *regex,\n"
10019 " const char *path);\n"
10024 #: ../src/guestfs-actions.pod:2230 ../fish/guestfish-actions.pod:1497
10026 "This calls the external C<grep -i> program and returns the matching lines."
10030 #: ../src/guestfs-actions.pod:2242
10031 msgid "guestfs_grub_install"
10035 #: ../src/guestfs-actions.pod:2244
10039 " guestfs_grub_install (guestfs_h *g,\n"
10040 " const char *root,\n"
10041 " const char *device);\n"
10046 #: ../src/guestfs-actions.pod:2249 ../fish/guestfish-actions.pod:1507
10048 "This command installs GRUB (the Grand Unified Bootloader) on C<device>, with "
10049 "the root directory being C<root>."
10053 #: ../src/guestfs-actions.pod:2252 ../fish/guestfish-actions.pod:1510
10055 "Note: If grub-install reports the error \"No suitable drive was found in the "
10056 "generated device map.\" it may be that you need to create a C</boot/grub/"
10057 "device.map> file first that contains the mapping between grub device names "
10058 "and Linux device names. It is usually sufficient to create a file "
10063 #: ../src/guestfs-actions.pod:2259 ../fish/guestfish-actions.pod:1517
10066 " (hd0) /dev/vda\n"
10071 #: ../src/guestfs-actions.pod:2261 ../fish/guestfish-actions.pod:1519
10072 msgid "replacing C</dev/vda> with the name of the installation device."
10076 #: ../src/guestfs-actions.pod:2265
10077 msgid "(Added in 1.0.17)"
10081 #: ../src/guestfs-actions.pod:2267
10082 msgid "guestfs_head"
10086 #: ../src/guestfs-actions.pod:2269
10090 " guestfs_head (guestfs_h *g,\n"
10091 " const char *path);\n"
10096 #: ../src/guestfs-actions.pod:2273 ../fish/guestfish-actions.pod:1525
10098 "This command returns up to the first 10 lines of a file as a list of strings."
10102 #: ../src/guestfs-actions.pod:2285
10103 msgid "guestfs_head_n"
10107 #: ../src/guestfs-actions.pod:2287
10111 " guestfs_head_n (guestfs_h *g,\n"
10113 " const char *path);\n"
10118 #: ../src/guestfs-actions.pod:2292 ../fish/guestfish-actions.pod:1535
10120 "If the parameter C<nrlines> is a positive number, this returns the first "
10121 "C<nrlines> lines of the file C<path>."
10125 #: ../src/guestfs-actions.pod:2295 ../fish/guestfish-actions.pod:1538
10127 "If the parameter C<nrlines> is a negative number, this returns lines from "
10128 "the file C<path>, excluding the last C<nrlines> lines."
10132 #: ../src/guestfs-actions.pod:2298 ../src/guestfs-actions.pod:6615
10133 #: ../fish/guestfish-actions.pod:1541 ../fish/guestfish-actions.pod:4471
10134 msgid "If the parameter C<nrlines> is zero, this returns an empty list."
10138 #: ../src/guestfs-actions.pod:2309
10139 msgid "guestfs_hexdump"
10143 #: ../src/guestfs-actions.pod:2311
10147 " guestfs_hexdump (guestfs_h *g,\n"
10148 " const char *path);\n"
10153 #: ../src/guestfs-actions.pod:2315 ../fish/guestfish-actions.pod:1550
10155 "This runs C<hexdump -C> on the given C<path>. The result is the human-"
10156 "readable, canonical hex dump of the file."
10160 #: ../src/guestfs-actions.pod:2324 ../src/guestfs-actions.pod:6399
10161 #: ../src/guestfs-actions.pod:6454
10162 msgid "(Added in 1.0.22)"
10166 #: ../src/guestfs-actions.pod:2326
10167 msgid "guestfs_initrd_cat"
10171 #: ../src/guestfs-actions.pod:2328
10175 " guestfs_initrd_cat (guestfs_h *g,\n"
10176 " const char *initrdpath,\n"
10177 " const char *filename,\n"
10178 " size_t *size_r);\n"
10183 #: ../src/guestfs-actions.pod:2334 ../fish/guestfish-actions.pod:1560
10185 "This command unpacks the file C<filename> from the initrd file called "
10186 "C<initrdpath>. The filename must be given I<without> the initial C</> "
10191 #: ../src/guestfs-actions.pod:2338 ../fish/guestfish-actions.pod:1564
10193 "For example, in guestfish you could use the following command to examine the "
10194 "boot script (usually called C</init>) contained in a Linux initrd or "
10199 #: ../src/guestfs-actions.pod:2342 ../fish/guestfish-actions.pod:1568
10202 " initrd-cat /boot/initrd-<version>.img init\n"
10207 #: ../src/guestfs-actions.pod:2344
10208 msgid "See also C<guestfs_initrd_list>."
10212 #: ../src/guestfs-actions.pod:2355
10213 msgid "guestfs_initrd_list"
10217 #: ../src/guestfs-actions.pod:2357
10221 " guestfs_initrd_list (guestfs_h *g,\n"
10222 " const char *path);\n"
10227 #: ../src/guestfs-actions.pod:2361 ../fish/guestfish-actions.pod:1579
10228 msgid "This command lists out files contained in an initrd."
10232 #: ../src/guestfs-actions.pod:2363 ../fish/guestfish-actions.pod:1581
10234 "The files are listed without any initial C</> character. The files are "
10235 "listed in the order they appear (not necessarily alphabetical). Directory "
10236 "names are listed as separate items."
10240 #: ../src/guestfs-actions.pod:2367 ../fish/guestfish-actions.pod:1585
10242 "Old Linux kernels (2.4 and earlier) used a compressed ext2 filesystem as "
10243 "initrd. We I<only> support the newer initramfs format (compressed cpio "
10248 #: ../src/guestfs-actions.pod:2377
10249 msgid "guestfs_inotify_add_watch"
10253 #: ../src/guestfs-actions.pod:2379
10257 " guestfs_inotify_add_watch (guestfs_h *g,\n"
10258 " const char *path,\n"
10264 #: ../src/guestfs-actions.pod:2384 ../fish/guestfish-actions.pod:1593
10265 msgid "Watch C<path> for the events listed in C<mask>."
10269 #: ../src/guestfs-actions.pod:2386 ../fish/guestfish-actions.pod:1595
10271 "Note that if C<path> is a directory then events within that directory are "
10272 "watched, but this does I<not> happen recursively (in subdirectories)."
10276 #: ../src/guestfs-actions.pod:2390 ../fish/guestfish-actions.pod:1599
10278 "Note for non-C or non-Linux callers: the inotify events are defined by the "
10279 "Linux kernel ABI and are listed in C</usr/include/sys/inotify.h>."
10283 #: ../src/guestfs-actions.pod:2398
10284 msgid "guestfs_inotify_close"
10288 #: ../src/guestfs-actions.pod:2400
10292 " guestfs_inotify_close (guestfs_h *g);\n"
10297 #: ../src/guestfs-actions.pod:2403 ../fish/guestfish-actions.pod:1607
10299 "This closes the inotify handle which was previously opened by inotify_init. "
10300 "It removes all watches, throws away any pending events, and deallocates all "
10305 #: ../src/guestfs-actions.pod:2411
10306 msgid "guestfs_inotify_files"
10310 #: ../src/guestfs-actions.pod:2413
10314 " guestfs_inotify_files (guestfs_h *g);\n"
10319 #: ../src/guestfs-actions.pod:2416
10321 "This function is a helpful wrapper around C<guestfs_inotify_read> which just "
10322 "returns a list of pathnames of objects that were touched. The returned "
10323 "pathnames are sorted and deduplicated."
10327 #: ../src/guestfs-actions.pod:2426
10328 msgid "guestfs_inotify_init"
10332 #: ../src/guestfs-actions.pod:2428
10336 " guestfs_inotify_init (guestfs_h *g,\n"
10337 " int maxevents);\n"
10342 #: ../src/guestfs-actions.pod:2432 ../fish/guestfish-actions.pod:1623
10344 "This command creates a new inotify handle. The inotify subsystem can be "
10345 "used to notify events which happen to objects in the guest filesystem."
10349 #: ../src/guestfs-actions.pod:2436
10351 "C<maxevents> is the maximum number of events which will be queued up between "
10352 "calls to C<guestfs_inotify_read> or C<guestfs_inotify_files>. If this is "
10353 "passed as C<0>, then the kernel (or previously set) default is used. For "
10354 "Linux 2.6.29 the default was 16384 events. Beyond this limit, the kernel "
10355 "throws away events, but records the fact that it threw them away by setting "
10356 "a flag C<IN_Q_OVERFLOW> in the returned structure list (see "
10357 "C<guestfs_inotify_read>)."
10361 #: ../src/guestfs-actions.pod:2446
10363 "Before any events are generated, you have to add some watches to the "
10364 "internal watch list. See: C<guestfs_inotify_add_watch>, "
10365 "C<guestfs_inotify_rm_watch> and C<guestfs_inotify_watch_all>."
10369 #: ../src/guestfs-actions.pod:2452
10371 "Queued up events should be read periodically by calling "
10372 "C<guestfs_inotify_read> (or C<guestfs_inotify_files> which is just a helpful "
10373 "wrapper around C<guestfs_inotify_read>). If you don't read the events out "
10374 "often enough then you risk the internal queue overflowing."
10378 #: ../src/guestfs-actions.pod:2459
10380 "The handle should be closed after use by calling C<guestfs_inotify_close>. "
10381 "This also removes any watches automatically."
10385 #: ../src/guestfs-actions.pod:2463 ../fish/guestfish-actions.pod:1654
10387 "See also L<inotify(7)> for an overview of the inotify interface as exposed "
10388 "by the Linux kernel, which is roughly what we expose via libguestfs. Note "
10389 "that there is one global inotify handle per libguestfs instance."
10393 #: ../src/guestfs-actions.pod:2472
10394 msgid "guestfs_inotify_read"
10398 #: ../src/guestfs-actions.pod:2474
10401 " struct guestfs_inotify_event_list *\n"
10402 " guestfs_inotify_read (guestfs_h *g);\n"
10407 #: ../src/guestfs-actions.pod:2477 ../fish/guestfish-actions.pod:1663
10409 "Return the complete queue of events that have happened since the previous "
10414 #: ../src/guestfs-actions.pod:2480 ../fish/guestfish-actions.pod:1666
10415 msgid "If no events have happened, this returns an empty list."
10419 #: ../src/guestfs-actions.pod:2482 ../fish/guestfish-actions.pod:1668
10421 "I<Note>: In order to make sure that all events have been read, you must call "
10422 "this function repeatedly until it returns an empty list. The reason is that "
10423 "the call will read events up to the maximum appliance-to-host message size "
10424 "and leave remaining events in the queue."
10428 #: ../src/guestfs-actions.pod:2488
10430 "This function returns a C<struct guestfs_inotify_event_list *>, or NULL if "
10431 "there was an error. I<The caller must call "
10432 "C<guestfs_free_inotify_event_list> after use>."
10436 #: ../src/guestfs-actions.pod:2494
10437 msgid "guestfs_inotify_rm_watch"
10441 #: ../src/guestfs-actions.pod:2496
10445 " guestfs_inotify_rm_watch (guestfs_h *g,\n"
10451 #: ../src/guestfs-actions.pod:2500
10453 "Remove a previously defined inotify watch. See C<guestfs_inotify_add_watch>."
10457 #: ../src/guestfs-actions.pod:2507
10458 msgid "guestfs_inspect_get_arch"
10462 #: ../src/guestfs-actions.pod:2509
10466 " guestfs_inspect_get_arch (guestfs_h *g,\n"
10467 " const char *root);\n"
10472 #: ../src/guestfs-actions.pod:2513 ../src/guestfs-actions.pod:2536
10473 #: ../src/guestfs-actions.pod:2629 ../src/guestfs-actions.pod:2673
10474 #: ../src/guestfs-actions.pod:2699 ../src/guestfs-actions.pod:2738
10475 #: ../src/guestfs-actions.pod:2760 ../src/guestfs-actions.pod:2787
10476 #: ../src/guestfs-actions.pod:2808 ../src/guestfs-actions.pod:2851
10477 #: ../src/guestfs-actions.pod:2880 ../src/guestfs-actions.pod:2911
10478 #: ../src/guestfs-actions.pod:2935 ../src/guestfs-actions.pod:2990
10479 #: ../src/guestfs-actions.pod:3032 ../src/guestfs-actions.pod:3053
10480 #: ../src/guestfs-actions.pod:3076 ../src/guestfs-actions.pod:3093
10481 #: ../src/guestfs-actions.pod:3110 ../src/guestfs-actions.pod:3129
10483 "This function should only be called with a root device string as returned by "
10484 "C<guestfs_inspect_os>."
10488 #: ../src/guestfs-actions.pod:2516
10490 "This returns the architecture of the inspected operating system. The "
10491 "possible return values are listed under C<guestfs_file_architecture>."
10495 #: ../src/guestfs-actions.pod:2520 ../fish/guestfish-actions.pod:1692
10497 "If the architecture could not be determined, then the string C<unknown> is "
10502 #: ../src/guestfs-actions.pod:2523 ../src/guestfs-actions.pod:2616
10503 #: ../src/guestfs-actions.pod:2727 ../src/guestfs-actions.pod:2747
10504 #: ../src/guestfs-actions.pod:2775 ../src/guestfs-actions.pod:2867
10505 #: ../src/guestfs-actions.pod:2898 ../src/guestfs-actions.pod:2922
10506 #: ../src/guestfs-actions.pod:2976 ../src/guestfs-actions.pod:3019
10507 #: ../src/guestfs-actions.pod:3042 ../src/guestfs-actions.pod:3063
10508 #: ../src/guestfs-actions.pod:3083 ../src/guestfs-actions.pod:3100
10509 #: ../src/guestfs-actions.pod:3119 ../src/guestfs-actions.pod:3222
10510 #: ../src/guestfs-actions.pod:3263 ../fish/guestfish-actions.pod:1695
10511 #: ../fish/guestfish-actions.pod:1781 ../fish/guestfish-actions.pod:1869
10512 #: ../fish/guestfish-actions.pod:1884 ../fish/guestfish-actions.pod:1905
10513 #: ../fish/guestfish-actions.pod:1975 ../fish/guestfish-actions.pod:1999
10514 #: ../fish/guestfish-actions.pod:2016 ../fish/guestfish-actions.pod:2059
10515 #: ../fish/guestfish-actions.pod:2094 ../fish/guestfish-actions.pod:2110
10516 #: ../fish/guestfish-actions.pod:2126 ../fish/guestfish-actions.pod:2139
10517 #: ../fish/guestfish-actions.pod:2152 ../fish/guestfish-actions.pod:2167
10518 #: ../fish/guestfish-actions.pod:2266 ../fish/guestfish-actions.pod:2300
10519 msgid "Please read L<guestfs(3)/INSPECTION> for more details."
10523 #: ../src/guestfs-actions.pod:2530
10524 msgid "guestfs_inspect_get_distro"
10528 #: ../src/guestfs-actions.pod:2532
10532 " guestfs_inspect_get_distro (guestfs_h *g,\n"
10533 " const char *root);\n"
10538 #: ../src/guestfs-actions.pod:2539 ../fish/guestfish-actions.pod:1704
10540 "This returns the distro (distribution) of the inspected operating system."
10544 #: ../src/guestfs-actions.pod:2542 ../fish/guestfish-actions.pod:1707
10545 msgid "Currently defined distros are:"
10549 #: ../src/guestfs-actions.pod:2546 ../fish/guestfish-actions.pod:1711
10550 msgid "\"archlinux\""
10551 msgstr "\"archlinux\""
10554 #: ../src/guestfs-actions.pod:2548 ../fish/guestfish-actions.pod:1713
10555 msgid "Arch Linux."
10556 msgstr "Arch Linux."
10559 #: ../src/guestfs-actions.pod:2550 ../fish/guestfish-actions.pod:1715
10561 #| msgid "\"gentoo\""
10563 msgstr "\"gentoo\""
10566 #: ../src/guestfs-actions.pod:2552 ../fish/guestfish-actions.pod:1717
10571 #: ../src/guestfs-actions.pod:2554 ../fish/guestfish-actions.pod:1719
10573 msgstr "\"debian\""
10576 #: ../src/guestfs-actions.pod:2556 ../fish/guestfish-actions.pod:1721
10581 #: ../src/guestfs-actions.pod:2558 ../fish/guestfish-actions.pod:1723
10583 msgstr "\"fedora\""
10586 #: ../src/guestfs-actions.pod:2560 ../fish/guestfish-actions.pod:1725
10591 #: ../src/guestfs-actions.pod:2562 ../fish/guestfish-actions.pod:1727
10593 msgstr "\"gentoo\""
10596 #: ../src/guestfs-actions.pod:2564 ../fish/guestfish-actions.pod:1729
10601 #: ../src/guestfs-actions.pod:2566 ../fish/guestfish-actions.pod:1731
10602 msgid "\"linuxmint\""
10603 msgstr "\"linuxmint\""
10606 #: ../src/guestfs-actions.pod:2568 ../fish/guestfish-actions.pod:1733
10607 msgid "Linux Mint."
10608 msgstr "Linux Mint."
10611 #: ../src/guestfs-actions.pod:2570 ../fish/guestfish-actions.pod:1735
10612 msgid "\"mandriva\""
10613 msgstr "\"mandriva\""
10616 #: ../src/guestfs-actions.pod:2572 ../fish/guestfish-actions.pod:1737
10621 #: ../src/guestfs-actions.pod:2574 ../fish/guestfish-actions.pod:1739
10626 #: ../src/guestfs-actions.pod:2576 ../fish/guestfish-actions.pod:1741
10631 #: ../src/guestfs-actions.pod:2578 ../fish/guestfish-actions.pod:1743
10633 msgstr "\"pardus\""
10636 #: ../src/guestfs-actions.pod:2580 ../fish/guestfish-actions.pod:1745
10641 #: ../src/guestfs-actions.pod:2582 ../fish/guestfish-actions.pod:1747
10642 msgid "\"redhat-based\""
10643 msgstr "\"redhat-based\""
10646 #: ../src/guestfs-actions.pod:2584 ../fish/guestfish-actions.pod:1749
10647 msgid "Some Red Hat-derived distro."
10648 msgstr "Дистрибутив, що походить від Red Hat."
10651 #: ../src/guestfs-actions.pod:2586 ../fish/guestfish-actions.pod:1751
10656 #: ../src/guestfs-actions.pod:2588 ../fish/guestfish-actions.pod:1753
10658 #| msgid "Red Hat Enterprise Linux and some derivatives."
10659 msgid "Red Hat Enterprise Linux."
10660 msgstr "Red Hat Enterprise Linux та деякі з похідних дистрибутивів."
10663 #: ../src/guestfs-actions.pod:2590 ../fish/guestfish-actions.pod:1755
10664 msgid "\"scientificlinux\""
10668 #: ../src/guestfs-actions.pod:2592 ../fish/guestfish-actions.pod:1757
10669 msgid "Scientific Linux."
10673 #: ../src/guestfs-actions.pod:2594 ../fish/guestfish-actions.pod:1759
10674 msgid "\"slackware\""
10678 #: ../src/guestfs-actions.pod:2596 ../fish/guestfish-actions.pod:1761
10683 #: ../src/guestfs-actions.pod:2598 ../fish/guestfish-actions.pod:1763
10685 msgstr "\"ubuntu\""
10688 #: ../src/guestfs-actions.pod:2600 ../fish/guestfish-actions.pod:1765
10693 #: ../src/guestfs-actions.pod:2602 ../src/guestfs-actions.pod:2718
10694 #: ../src/guestfs-actions.pod:3010 ../fish/guestfish-actions.pod:1767
10695 #: ../fish/guestfish-actions.pod:1860 ../fish/guestfish-actions.pod:2085
10696 msgid "\"unknown\""
10697 msgstr "\"unknown\""
10700 #: ../src/guestfs-actions.pod:2604 ../fish/guestfish-actions.pod:1769
10701 msgid "The distro could not be determined."
10702 msgstr "Дистрибутив, тип якого не вдалося визначити."
10705 #: ../src/guestfs-actions.pod:2606 ../src/guestfs-actions.pod:3002
10706 #: ../fish/guestfish-actions.pod:1771 ../fish/guestfish-actions.pod:2077
10707 msgid "\"windows\""
10708 msgstr "\"windows\""
10711 #: ../src/guestfs-actions.pod:2608 ../fish/guestfish-actions.pod:1773
10713 "Windows does not have distributions. This string is returned if the OS type "
10718 #: ../src/guestfs-actions.pod:2613 ../src/guestfs-actions.pod:2724
10719 #: ../src/guestfs-actions.pod:3016 ../fish/guestfish-actions.pod:1778
10720 #: ../fish/guestfish-actions.pod:1866 ../fish/guestfish-actions.pod:2091
10722 "Future versions of libguestfs may return other strings here. The caller "
10723 "should be prepared to handle any string."
10727 #: ../src/guestfs-actions.pod:2623
10728 msgid "guestfs_inspect_get_drive_mappings"
10732 #: ../src/guestfs-actions.pod:2625
10736 " guestfs_inspect_get_drive_mappings (guestfs_h *g,\n"
10737 " const char *root);\n"
10742 #: ../src/guestfs-actions.pod:2632 ../fish/guestfish-actions.pod:1790
10744 "This call is useful for Windows which uses a primitive system of assigning "
10745 "drive letters (like \"C:\") to partitions. This inspection API examines the "
10746 "Windows Registry to find out how disks/partitions are mapped to drive "
10747 "letters, and returns a hash table as in the example below:"
10751 #: ../src/guestfs-actions.pod:2638 ../fish/guestfish-actions.pod:1796
10754 " C => /dev/vda2\n"
10755 " E => /dev/vdb1\n"
10756 " F => /dev/vdc1\n"
10761 #: ../src/guestfs-actions.pod:2642 ../fish/guestfish-actions.pod:1800
10763 "Note that keys are drive letters. For Windows, the key is case insensitive "
10764 "and just contains the drive letter, without the customary colon separator "
10769 #: ../src/guestfs-actions.pod:2646 ../fish/guestfish-actions.pod:1804
10771 "In future we may support other operating systems that also used drive "
10772 "letters, but the keys for those might not be case insensitive and might be "
10773 "longer than 1 character. For example in OS-9, hard drives were named C<h0>, "
10778 #: ../src/guestfs-actions.pod:2651 ../fish/guestfish-actions.pod:1809
10780 "For Windows guests, currently only hard drive mappings are returned. "
10781 "Removable disks (eg. DVD-ROMs) are ignored."
10785 #: ../src/guestfs-actions.pod:2654 ../fish/guestfish-actions.pod:1812
10787 "For guests that do not use drive mappings, or if the drive mappings could "
10788 "not be determined, this returns an empty hash table."
10792 #: ../src/guestfs-actions.pod:2657
10794 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
10795 "C<guestfs_inspect_get_mountpoints>, C<guestfs_inspect_get_filesystems>."
10799 #: ../src/guestfs-actions.pod:2661 ../src/guestfs-actions.pod:2837
10800 #: ../src/guestfs-actions.pod:3597 ../src/guestfs-actions.pod:4814
10801 #: ../src/guestfs-actions.pod:6756
10803 "This function returns a NULL-terminated array of strings, or NULL if there "
10804 "was an error. The array of strings will always have length C<2n+1>, where "
10805 "C<n> keys and values alternate, followed by the trailing NULL entry. I<The "
10806 "caller must free the strings and the array after use>."
10810 #: ../src/guestfs-actions.pod:2667
10811 msgid "guestfs_inspect_get_filesystems"
10815 #: ../src/guestfs-actions.pod:2669
10819 " guestfs_inspect_get_filesystems (guestfs_h *g,\n"
10820 " const char *root);\n"
10825 #: ../src/guestfs-actions.pod:2676 ../fish/guestfish-actions.pod:1826
10827 "This returns a list of all the filesystems that we think are associated with "
10828 "this operating system. This includes the root filesystem, other ordinary "
10829 "filesystems, and non-mounted devices like swap partitions."
10833 #: ../src/guestfs-actions.pod:2681 ../fish/guestfish-actions.pod:1831
10835 "In the case of a multi-boot virtual machine, it is possible for a filesystem "
10836 "to be shared between operating systems."
10840 #: ../src/guestfs-actions.pod:2684
10842 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
10843 "C<guestfs_inspect_get_mountpoints>."
10847 #: ../src/guestfs-actions.pod:2693
10848 msgid "guestfs_inspect_get_format"
10852 #: ../src/guestfs-actions.pod:2695
10856 " guestfs_inspect_get_format (guestfs_h *g,\n"
10857 " const char *root);\n"
10862 #: ../src/guestfs-actions.pod:2702 ../fish/guestfish-actions.pod:1844
10864 "This returns the format of the inspected operating system. You can use it "
10865 "to detect install images, live CDs and similar."
10869 #: ../src/guestfs-actions.pod:2705 ../fish/guestfish-actions.pod:1847
10870 msgid "Currently defined formats are:"
10874 #: ../src/guestfs-actions.pod:2709 ../fish/guestfish-actions.pod:1851
10875 msgid "\"installed\""
10876 msgstr "\"installed\""
10879 #: ../src/guestfs-actions.pod:2711 ../fish/guestfish-actions.pod:1853
10880 msgid "This is an installed operating system."
10881 msgstr "Це встановлена операційна система."
10884 #: ../src/guestfs-actions.pod:2713 ../fish/guestfish-actions.pod:1855
10885 msgid "\"installer\""
10889 #: ../src/guestfs-actions.pod:2715 ../fish/guestfish-actions.pod:1857
10891 "The disk image being inspected is not an installed operating system, but a "
10892 "I<bootable> install disk, live CD, or similar."
10896 #: ../src/guestfs-actions.pod:2720 ../fish/guestfish-actions.pod:1862
10897 msgid "The format of this disk image is not known."
10901 #: ../src/guestfs-actions.pod:2732
10902 msgid "guestfs_inspect_get_hostname"
10906 #: ../src/guestfs-actions.pod:2734
10910 " guestfs_inspect_get_hostname (guestfs_h *g,\n"
10911 " const char *root);\n"
10916 #: ../src/guestfs-actions.pod:2741 ../fish/guestfish-actions.pod:1878
10918 "This function returns the hostname of the operating system as found by "
10919 "inspection of the guest's configuration files."
10923 #: ../src/guestfs-actions.pod:2744 ../fish/guestfish-actions.pod:1881
10925 "If the hostname could not be determined, then the string C<unknown> is "
10930 #: ../src/guestfs-actions.pod:2752
10931 msgid "(Added in 1.7.9)"
10935 #: ../src/guestfs-actions.pod:2754
10936 msgid "guestfs_inspect_get_major_version"
10940 #: ../src/guestfs-actions.pod:2756
10944 " guestfs_inspect_get_major_version (guestfs_h *g,\n"
10945 " const char *root);\n"
10950 #: ../src/guestfs-actions.pod:2763 ../fish/guestfish-actions.pod:1893
10952 "This returns the major version number of the inspected operating system."
10956 #: ../src/guestfs-actions.pod:2766 ../fish/guestfish-actions.pod:1896
10958 "Windows uses a consistent versioning scheme which is I<not> reflected in the "
10959 "popular public names used by the operating system. Notably the operating "
10960 "system known as \"Windows 7\" is really version 6.1 (ie. major = 6, minor = "
10961 "1). You can find out the real versions corresponding to releases of Windows "
10962 "by consulting Wikipedia or MSDN."
10966 #: ../src/guestfs-actions.pod:2773 ../src/guestfs-actions.pod:2793
10967 #: ../fish/guestfish-actions.pod:1903 ../fish/guestfish-actions.pod:1917
10968 msgid "If the version could not be determined, then C<0> is returned."
10972 #: ../src/guestfs-actions.pod:2781
10973 msgid "guestfs_inspect_get_minor_version"
10977 #: ../src/guestfs-actions.pod:2783
10981 " guestfs_inspect_get_minor_version (guestfs_h *g,\n"
10982 " const char *root);\n"
10987 #: ../src/guestfs-actions.pod:2790 ../fish/guestfish-actions.pod:1914
10989 "This returns the minor version number of the inspected operating system."
10993 #: ../src/guestfs-actions.pod:2795
10995 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
10996 "C<guestfs_inspect_get_major_version>."
11000 #: ../src/guestfs-actions.pod:2802
11001 msgid "guestfs_inspect_get_mountpoints"
11005 #: ../src/guestfs-actions.pod:2804
11009 " guestfs_inspect_get_mountpoints (guestfs_h *g,\n"
11010 " const char *root);\n"
11015 #: ../src/guestfs-actions.pod:2811 ../fish/guestfish-actions.pod:1929
11017 "This returns a hash of where we think the filesystems associated with this "
11018 "operating system should be mounted. Callers should note that this is at "
11019 "best an educated guess made by reading configuration files such as C</etc/"
11020 "fstab>. I<In particular note> that this may return filesystems which are "
11021 "non-existent or not mountable and callers should be prepared to handle or "
11022 "ignore failures if they try to mount them."
11026 #: ../src/guestfs-actions.pod:2820 ../fish/guestfish-actions.pod:1938
11028 "Each element in the returned hashtable has a key which is the path of the "
11029 "mountpoint (eg. C</boot>) and a value which is the filesystem that would be "
11030 "mounted there (eg. C</dev/sda1>)."
11034 #: ../src/guestfs-actions.pod:2825 ../fish/guestfish-actions.pod:1943
11036 "Non-mounted devices such as swap devices are I<not> returned in this list."
11040 #: ../src/guestfs-actions.pod:2828
11042 "For operating systems like Windows which still use drive letters, this call "
11043 "will only return an entry for the first drive \"mounted on\" C</>. For "
11044 "information about the mapping of drive letters to partitions, see "
11045 "C<guestfs_inspect_get_drive_mappings>."
11049 #: ../src/guestfs-actions.pod:2834
11051 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
11052 "C<guestfs_inspect_get_filesystems>."
11056 #: ../src/guestfs-actions.pod:2845
11057 msgid "guestfs_inspect_get_package_format"
11061 #: ../src/guestfs-actions.pod:2847
11065 " guestfs_inspect_get_package_format (guestfs_h *g,\n"
11066 " const char *root);\n"
11071 #: ../src/guestfs-actions.pod:2854
11073 "This function and C<guestfs_inspect_get_package_management> return the "
11074 "package format and package management tool used by the inspected operating "
11075 "system. For example for Fedora these functions would return C<rpm> (package "
11076 "format) and C<yum> (package management)."
11080 #: ../src/guestfs-actions.pod:2860 ../fish/guestfish-actions.pod:1968
11082 "This returns the string C<unknown> if we could not determine the package "
11083 "format I<or> if the operating system does not have a real packaging system "
11088 #: ../src/guestfs-actions.pod:2864 ../fish/guestfish-actions.pod:1972
11090 "Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>. "
11091 "Future versions of libguestfs may return other strings."
11095 #: ../src/guestfs-actions.pod:2872 ../src/guestfs-actions.pod:2903
11096 msgid "(Added in 1.7.5)"
11100 #: ../src/guestfs-actions.pod:2874
11101 msgid "guestfs_inspect_get_package_management"
11105 #: ../src/guestfs-actions.pod:2876
11109 " guestfs_inspect_get_package_management (guestfs_h *g,\n"
11110 " const char *root);\n"
11115 #: ../src/guestfs-actions.pod:2883
11117 "C<guestfs_inspect_get_package_format> and this function return the package "
11118 "format and package management tool used by the inspected operating system. "
11119 "For example for Fedora these functions would return C<rpm> (package format) "
11120 "and C<yum> (package management)."
11124 #: ../src/guestfs-actions.pod:2889 ../fish/guestfish-actions.pod:1990
11126 "This returns the string C<unknown> if we could not determine the package "
11127 "management tool I<or> if the operating system does not have a real packaging "
11128 "system (eg. Windows)."
11132 #: ../src/guestfs-actions.pod:2893 ../fish/guestfish-actions.pod:1994
11134 "Possible strings include: C<yum>, C<up2date>, C<apt> (for all Debian "
11135 "derivatives), C<portage>, C<pisi>, C<pacman>, C<urpmi>. Future versions of "
11136 "libguestfs may return other strings."
11140 #: ../src/guestfs-actions.pod:2905
11141 msgid "guestfs_inspect_get_product_name"
11145 #: ../src/guestfs-actions.pod:2907
11149 " guestfs_inspect_get_product_name (guestfs_h *g,\n"
11150 " const char *root);\n"
11155 #: ../src/guestfs-actions.pod:2914 ../fish/guestfish-actions.pod:2008
11157 "This returns the product name of the inspected operating system. The "
11158 "product name is generally some freeform string which can be displayed to the "
11159 "user, but should not be parsed by programs."
11163 #: ../src/guestfs-actions.pod:2919 ../fish/guestfish-actions.pod:2013
11165 "If the product name could not be determined, then the string C<unknown> is "
11170 #: ../src/guestfs-actions.pod:2929
11171 msgid "guestfs_inspect_get_product_variant"
11175 #: ../src/guestfs-actions.pod:2931
11179 " guestfs_inspect_get_product_variant (guestfs_h *g,\n"
11180 " const char *root);\n"
11185 #: ../src/guestfs-actions.pod:2938 ../fish/guestfish-actions.pod:2025
11187 #| msgid "This is an installed operating system."
11188 msgid "This returns the product variant of the inspected operating system."
11189 msgstr "Це встановлена операційна система."
11192 #: ../src/guestfs-actions.pod:2941 ../fish/guestfish-actions.pod:2028
11194 "For Windows guests, this returns the contents of the Registry key C<HKLM"
11195 "\\Software\\Microsoft\\Windows NT\\CurrentVersion> C<InstallationType> which "
11196 "is usually a string such as C<Client> or C<Server> (other values are "
11197 "possible). This can be used to distinguish consumer and enterprise versions "
11198 "of Windows that have the same version number (for example, Windows 7 and "
11199 "Windows 2008 Server are both version 6.1, but the former is C<Client> and "
11200 "the latter is C<Server>)."
11204 #: ../src/guestfs-actions.pod:2950 ../fish/guestfish-actions.pod:2037
11206 "For enterprise Linux guests, in future we intend this to return the product "
11207 "variant such as C<Desktop>, C<Server> and so on. But this is not "
11208 "implemented at present."
11212 #: ../src/guestfs-actions.pod:2954 ../fish/guestfish-actions.pod:2041
11214 "If the product variant could not be determined, then the string C<unknown> "
11219 #: ../src/guestfs-actions.pod:2957
11221 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
11222 "C<guestfs_inspect_get_product_name>, C<guestfs_inspect_get_major_version>."
11226 #: ../src/guestfs-actions.pod:2964
11227 msgid "guestfs_inspect_get_roots"
11231 #: ../src/guestfs-actions.pod:2966
11235 " guestfs_inspect_get_roots (guestfs_h *g);\n"
11240 #: ../src/guestfs-actions.pod:2969
11242 "This function is a convenient way to get the list of root devices, as "
11243 "returned from a previous call to C<guestfs_inspect_os>, but without redoing "
11244 "the whole inspection process."
11248 #: ../src/guestfs-actions.pod:2973
11250 "This returns an empty list if either no root devices were found or the "
11251 "caller has not called C<guestfs_inspect_os>."
11255 #: ../src/guestfs-actions.pod:2982
11256 msgid "(Added in 1.7.3)"
11260 #: ../src/guestfs-actions.pod:2984
11261 msgid "guestfs_inspect_get_type"
11265 #: ../src/guestfs-actions.pod:2986
11269 " guestfs_inspect_get_type (guestfs_h *g,\n"
11270 " const char *root);\n"
11275 #: ../src/guestfs-actions.pod:2993 ../fish/guestfish-actions.pod:2068
11277 "This returns the type of the inspected operating system. Currently defined "
11282 #: ../src/guestfs-actions.pod:2998 ../fish/guestfish-actions.pod:2073
11287 #: ../src/guestfs-actions.pod:3000 ../fish/guestfish-actions.pod:2075
11288 msgid "Any Linux-based operating system."
11292 #: ../src/guestfs-actions.pod:3004 ../fish/guestfish-actions.pod:2079
11293 msgid "Any Microsoft Windows operating system."
11297 #: ../src/guestfs-actions.pod:3006 ../fish/guestfish-actions.pod:2081
11298 msgid "\"freebsd\""
11299 msgstr "\"freebsd\""
11302 #: ../src/guestfs-actions.pod:3008 ../fish/guestfish-actions.pod:2083
11307 #: ../src/guestfs-actions.pod:3012 ../fish/guestfish-actions.pod:2087
11308 msgid "The operating system type could not be determined."
11312 #: ../src/guestfs-actions.pod:3026
11313 msgid "guestfs_inspect_get_windows_current_control_set"
11317 #: ../src/guestfs-actions.pod:3028
11321 " guestfs_inspect_get_windows_current_control_set (guestfs_h *g,\n"
11322 " const char *root);\n"
11327 #: ../src/guestfs-actions.pod:3035 ../fish/guestfish-actions.pod:2103
11329 "This returns the Windows CurrentControlSet of the inspected guest. The "
11330 "CurrentControlSet is a registry key name such as C<ControlSet001>."
11334 #: ../src/guestfs-actions.pod:3038 ../fish/guestfish-actions.pod:2106
11336 "This call assumes that the guest is Windows and that the Registry could be "
11337 "examined by inspection. If this is not the case then an error is returned."
11341 #: ../src/guestfs-actions.pod:3047
11342 msgid "guestfs_inspect_get_windows_systemroot"
11346 #: ../src/guestfs-actions.pod:3049
11350 " guestfs_inspect_get_windows_systemroot (guestfs_h *g,\n"
11351 " const char *root);\n"
11356 #: ../src/guestfs-actions.pod:3056 ../fish/guestfish-actions.pod:2119
11358 "This returns the Windows systemroot of the inspected guest. The systemroot "
11359 "is a directory path such as C</WINDOWS>."
11363 #: ../src/guestfs-actions.pod:3059 ../fish/guestfish-actions.pod:2122
11365 "This call assumes that the guest is Windows and that the systemroot could be "
11366 "determined by inspection. If this is not the case then an error is returned."
11370 #: ../src/guestfs-actions.pod:3068
11371 msgid "(Added in 1.5.25)"
11375 #: ../src/guestfs-actions.pod:3070
11376 msgid "guestfs_inspect_is_live"
11380 #: ../src/guestfs-actions.pod:3072
11384 " guestfs_inspect_is_live (guestfs_h *g,\n"
11385 " const char *root);\n"
11390 #: ../src/guestfs-actions.pod:3079
11392 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
11393 "disk), then this returns true if a live image was detected on the disk."
11397 #: ../src/guestfs-actions.pod:3087
11398 msgid "guestfs_inspect_is_multipart"
11402 #: ../src/guestfs-actions.pod:3089
11406 " guestfs_inspect_is_multipart (guestfs_h *g,\n"
11407 " const char *root);\n"
11412 #: ../src/guestfs-actions.pod:3096
11414 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
11415 "disk), then this returns true if the disk is part of a set."
11419 #: ../src/guestfs-actions.pod:3104
11420 msgid "guestfs_inspect_is_netinst"
11424 #: ../src/guestfs-actions.pod:3106
11428 " guestfs_inspect_is_netinst (guestfs_h *g,\n"
11429 " const char *root);\n"
11434 #: ../src/guestfs-actions.pod:3113
11436 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
11437 "disk), then this returns true if the disk is a network installer, ie. not a "
11438 "self-contained install CD but one which is likely to require network access "
11439 "to complete the install."
11443 #: ../src/guestfs-actions.pod:3123
11444 msgid "guestfs_inspect_list_applications"
11448 #: ../src/guestfs-actions.pod:3125
11451 " struct guestfs_application_list *\n"
11452 " guestfs_inspect_list_applications (guestfs_h *g,\n"
11453 " const char *root);\n"
11458 #: ../src/guestfs-actions.pod:3132 ../fish/guestfish-actions.pod:2176
11459 msgid "Return the list of applications installed in the operating system."
11463 #: ../src/guestfs-actions.pod:3134
11465 "I<Note:> This call works differently from other parts of the inspection "
11466 "API. You have to call C<guestfs_inspect_os>, then "
11467 "C<guestfs_inspect_get_mountpoints>, then mount up the disks, before calling "
11468 "this. Listing applications is a significantly more difficult operation "
11469 "which requires access to the full filesystem. Also note that unlike the "
11470 "other C<guestfs_inspect_get_*> calls which are just returning data cached in "
11471 "the libguestfs handle, this call actually reads parts of the mounted "
11472 "filesystems during the call."
11476 #: ../src/guestfs-actions.pod:3144 ../fish/guestfish-actions.pod:2188
11478 "This returns an empty list if the inspection code was not able to determine "
11479 "the list of applications."
11483 #: ../src/guestfs-actions.pod:3147 ../fish/guestfish-actions.pod:2191
11484 msgid "The application structure contains the following fields:"
11488 #: ../src/guestfs-actions.pod:3151 ../fish/guestfish-actions.pod:2195
11489 msgid "C<app_name>"
11490 msgstr "C<app_name>"
11493 #: ../src/guestfs-actions.pod:3153 ../fish/guestfish-actions.pod:2197
11495 "The name of the application. For Red Hat-derived and Debian-derived Linux "
11496 "guests, this is the package name."
11500 #: ../src/guestfs-actions.pod:3156 ../fish/guestfish-actions.pod:2200
11501 msgid "C<app_display_name>"
11502 msgstr "C<app_display_name>"
11505 #: ../src/guestfs-actions.pod:3158 ../fish/guestfish-actions.pod:2202
11507 "The display name of the application, sometimes localized to the install "
11508 "language of the guest operating system."
11512 #: ../src/guestfs-actions.pod:3161 ../fish/guestfish-actions.pod:2205
11514 "If unavailable this is returned as an empty string C<\"\">. Callers needing "
11515 "to display something can use C<app_name> instead."
11519 #: ../src/guestfs-actions.pod:3164 ../fish/guestfish-actions.pod:2208
11520 msgid "C<app_epoch>"
11521 msgstr "C<app_epoch>"
11524 #: ../src/guestfs-actions.pod:3166 ../fish/guestfish-actions.pod:2210
11526 "For package managers which use epochs, this contains the epoch of the "
11527 "package (an integer). If unavailable, this is returned as C<0>."
11531 #: ../src/guestfs-actions.pod:3169 ../fish/guestfish-actions.pod:2213
11532 msgid "C<app_version>"
11533 msgstr "C<app_version>"
11536 #: ../src/guestfs-actions.pod:3171 ../fish/guestfish-actions.pod:2215
11538 "The version string of the application or package. If unavailable this is "
11539 "returned as an empty string C<\"\">."
11543 #: ../src/guestfs-actions.pod:3174 ../fish/guestfish-actions.pod:2218
11544 msgid "C<app_release>"
11545 msgstr "C<app_release>"
11548 #: ../src/guestfs-actions.pod:3176 ../fish/guestfish-actions.pod:2220
11550 "The release string of the application or package, for package managers that "
11551 "use this. If unavailable this is returned as an empty string C<\"\">."
11555 #: ../src/guestfs-actions.pod:3180 ../fish/guestfish-actions.pod:2224
11556 msgid "C<app_install_path>"
11557 msgstr "C<app_install_path>"
11560 #: ../src/guestfs-actions.pod:3182 ../fish/guestfish-actions.pod:2226
11562 "The installation path of the application (on operating systems such as "
11563 "Windows which use installation paths). This path is in the format used by "
11564 "the guest operating system, it is not a libguestfs path."
11568 #: ../src/guestfs-actions.pod:3187 ../fish/guestfish-actions.pod:2231
11569 msgid "If unavailable this is returned as an empty string C<\"\">."
11573 #: ../src/guestfs-actions.pod:3189 ../fish/guestfish-actions.pod:2233
11574 msgid "C<app_trans_path>"
11575 msgstr "C<app_trans_path>"
11578 #: ../src/guestfs-actions.pod:3191 ../fish/guestfish-actions.pod:2235
11580 "The install path translated into a libguestfs path. If unavailable this is "
11581 "returned as an empty string C<\"\">."
11585 #: ../src/guestfs-actions.pod:3194 ../fish/guestfish-actions.pod:2238
11586 msgid "C<app_publisher>"
11587 msgstr "C<app_publisher>"
11590 #: ../src/guestfs-actions.pod:3196 ../fish/guestfish-actions.pod:2240
11592 "The name of the publisher of the application, for package managers that use "
11593 "this. If unavailable this is returned as an empty string C<\"\">."
11597 #: ../src/guestfs-actions.pod:3200 ../fish/guestfish-actions.pod:2244
11599 msgstr "C<app_url>"
11602 #: ../src/guestfs-actions.pod:3202 ../fish/guestfish-actions.pod:2246
11604 "The URL (eg. upstream URL) of the application. If unavailable this is "
11605 "returned as an empty string C<\"\">."
11609 #: ../src/guestfs-actions.pod:3205 ../fish/guestfish-actions.pod:2249
11610 msgid "C<app_source_package>"
11614 #: ../src/guestfs-actions.pod:3207 ../fish/guestfish-actions.pod:2251
11616 "For packaging systems which support this, the name of the source package. "
11617 "If unavailable this is returned as an empty string C<\"\">."
11621 #: ../src/guestfs-actions.pod:3210 ../fish/guestfish-actions.pod:2254
11622 msgid "C<app_summary>"
11626 #: ../src/guestfs-actions.pod:3212 ../fish/guestfish-actions.pod:2256
11628 "A short (usually one line) description of the application or package. If "
11629 "unavailable this is returned as an empty string C<\"\">."
11633 #: ../src/guestfs-actions.pod:3215 ../fish/guestfish-actions.pod:2259
11634 msgid "C<app_description>"
11638 #: ../src/guestfs-actions.pod:3217 ../fish/guestfish-actions.pod:2261
11640 "A longer description of the application or package. If unavailable this is "
11641 "returned as an empty string C<\"\">."
11645 #: ../src/guestfs-actions.pod:3224
11647 "This function returns a C<struct guestfs_application_list *>, or NULL if "
11648 "there was an error. I<The caller must call C<guestfs_free_application_list> "
11653 #: ../src/guestfs-actions.pod:3228
11654 msgid "(Added in 1.7.8)"
11658 #: ../src/guestfs-actions.pod:3230
11659 msgid "guestfs_inspect_os"
11663 #: ../src/guestfs-actions.pod:3232
11667 " guestfs_inspect_os (guestfs_h *g);\n"
11672 #: ../src/guestfs-actions.pod:3235 ../fish/guestfish-actions.pod:2272
11674 "This function uses other libguestfs functions and certain heuristics to "
11675 "inspect the disk(s) (usually disks belonging to a virtual machine), looking "
11676 "for operating systems."
11680 #: ../src/guestfs-actions.pod:3239 ../fish/guestfish-actions.pod:2276
11681 msgid "The list returned is empty if no operating systems were found."
11685 #: ../src/guestfs-actions.pod:3241 ../fish/guestfish-actions.pod:2278
11687 "If one operating system was found, then this returns a list with a single "
11688 "element, which is the name of the root filesystem of this operating system. "
11689 "It is also possible for this function to return a list containing more than "
11690 "one element, indicating a dual-boot or multi-boot virtual machine, with each "
11691 "element being the root filesystem of one of the operating systems."
11695 #: ../src/guestfs-actions.pod:3248
11697 "You can pass the root string(s) returned to other C<guestfs_inspect_get_*> "
11698 "functions in order to query further information about each operating system, "
11699 "such as the name and version."
11703 #: ../src/guestfs-actions.pod:3253
11705 "This function uses other libguestfs features such as C<guestfs_mount_ro> and "
11706 "C<guestfs_umount_all> in order to mount and unmount filesystems and look at "
11707 "the contents. This should be called with no disks currently mounted. The "
11708 "function may also use Augeas, so any existing Augeas handle will be closed."
11712 #: ../src/guestfs-actions.pod:3259 ../fish/guestfish-actions.pod:2296
11714 "This function cannot decrypt encrypted disks. The caller must do that first "
11715 "(supplying the necessary keys) if the disk is encrypted."
11719 #: ../src/guestfs-actions.pod:3265 ../src/guestfs-actions.pod:3555
11720 #: ../src/guestfs-actions.pod:3617
11721 msgid "See also C<guestfs_list_filesystems>."
11725 #: ../src/guestfs-actions.pod:3273
11726 msgid "guestfs_is_blockdev"
11730 #: ../src/guestfs-actions.pod:3275
11734 " guestfs_is_blockdev (guestfs_h *g,\n"
11735 " const char *path);\n"
11740 #: ../src/guestfs-actions.pod:3279 ../fish/guestfish-actions.pod:2308
11742 "This returns C<true> if and only if there is a block device with the given "
11747 #: ../src/guestfs-actions.pod:3282 ../src/guestfs-actions.pod:3311
11748 #: ../src/guestfs-actions.pod:3341 ../src/guestfs-actions.pod:3356
11749 #: ../src/guestfs-actions.pod:3372 ../src/guestfs-actions.pod:3428
11750 #: ../src/guestfs-actions.pod:3443
11751 msgid "See also C<guestfs_stat>."
11755 #: ../src/guestfs-actions.pod:3286 ../src/guestfs-actions.pod:3315
11756 #: ../src/guestfs-actions.pod:3360 ../src/guestfs-actions.pod:3432
11757 #: ../src/guestfs-actions.pod:3447
11758 msgid "(Added in 1.5.10)"
11762 #: ../src/guestfs-actions.pod:3288
11763 msgid "guestfs_is_busy"
11767 #: ../src/guestfs-actions.pod:3290
11771 " guestfs_is_busy (guestfs_h *g);\n"
11776 #: ../src/guestfs-actions.pod:3293 ../fish/guestfish-actions.pod:2317
11778 "This returns true iff this handle is busy processing a command (in the "
11783 #: ../src/guestfs-actions.pod:3302
11784 msgid "guestfs_is_chardev"
11788 #: ../src/guestfs-actions.pod:3304
11792 " guestfs_is_chardev (guestfs_h *g,\n"
11793 " const char *path);\n"
11798 #: ../src/guestfs-actions.pod:3308 ../fish/guestfish-actions.pod:2326
11800 "This returns C<true> if and only if there is a character device with the "
11801 "given C<path> name."
11805 #: ../src/guestfs-actions.pod:3317
11806 msgid "guestfs_is_config"
11810 #: ../src/guestfs-actions.pod:3319
11814 " guestfs_is_config (guestfs_h *g);\n"
11819 #: ../src/guestfs-actions.pod:3322 ../fish/guestfish-actions.pod:2335
11821 "This returns true iff this handle is being configured (in the C<CONFIG> "
11826 #: ../src/guestfs-actions.pod:3331
11827 msgid "guestfs_is_dir"
11831 #: ../src/guestfs-actions.pod:3333
11835 " guestfs_is_dir (guestfs_h *g,\n"
11836 " const char *path);\n"
11841 #: ../src/guestfs-actions.pod:3337 ../fish/guestfish-actions.pod:2344
11843 "This returns C<true> if and only if there is a directory with the given "
11844 "C<path> name. Note that it returns false for other objects like files."
11848 #: ../src/guestfs-actions.pod:3347
11849 msgid "guestfs_is_fifo"
11853 #: ../src/guestfs-actions.pod:3349
11857 " guestfs_is_fifo (guestfs_h *g,\n"
11858 " const char *path);\n"
11863 #: ../src/guestfs-actions.pod:3353 ../fish/guestfish-actions.pod:2354
11865 "This returns C<true> if and only if there is a FIFO (named pipe) with the "
11866 "given C<path> name."
11870 #: ../src/guestfs-actions.pod:3362
11871 msgid "guestfs_is_file"
11875 #: ../src/guestfs-actions.pod:3364
11879 " guestfs_is_file (guestfs_h *g,\n"
11880 " const char *path);\n"
11885 #: ../src/guestfs-actions.pod:3368 ../fish/guestfish-actions.pod:2363
11887 "This returns C<true> if and only if there is a regular file with the given "
11888 "C<path> name. Note that it returns false for other objects like directories."
11892 #: ../src/guestfs-actions.pod:3378
11893 msgid "guestfs_is_launching"
11897 #: ../src/guestfs-actions.pod:3380
11901 " guestfs_is_launching (guestfs_h *g);\n"
11906 #: ../src/guestfs-actions.pod:3383 ../fish/guestfish-actions.pod:2373
11908 "This returns true iff this handle is launching the subprocess (in the "
11909 "C<LAUNCHING> state)."
11913 #: ../src/guestfs-actions.pod:3392
11914 msgid "guestfs_is_lv"
11918 #: ../src/guestfs-actions.pod:3394
11922 " guestfs_is_lv (guestfs_h *g,\n"
11923 " const char *device);\n"
11928 #: ../src/guestfs-actions.pod:3398 ../fish/guestfish-actions.pod:2382
11930 "This command tests whether C<device> is a logical volume, and returns true "
11931 "iff this is the case."
11935 #: ../src/guestfs-actions.pod:3405
11936 msgid "guestfs_is_ready"
11940 #: ../src/guestfs-actions.pod:3407
11944 " guestfs_is_ready (guestfs_h *g);\n"
11949 #: ../src/guestfs-actions.pod:3410 ../fish/guestfish-actions.pod:2389
11951 "This returns true iff this handle is ready to accept commands (in the "
11956 #: ../src/guestfs-actions.pod:3419
11957 msgid "guestfs_is_socket"
11961 #: ../src/guestfs-actions.pod:3421
11965 " guestfs_is_socket (guestfs_h *g,\n"
11966 " const char *path);\n"
11971 #: ../src/guestfs-actions.pod:3425 ../fish/guestfish-actions.pod:2398
11973 "This returns C<true> if and only if there is a Unix domain socket with the "
11974 "given C<path> name."
11978 #: ../src/guestfs-actions.pod:3434
11979 msgid "guestfs_is_symlink"
11983 #: ../src/guestfs-actions.pod:3436
11987 " guestfs_is_symlink (guestfs_h *g,\n"
11988 " const char *path);\n"
11993 #: ../src/guestfs-actions.pod:3440 ../fish/guestfish-actions.pod:2407
11995 "This returns C<true> if and only if there is a symbolic link with the given "
12000 #: ../src/guestfs-actions.pod:3449
12001 msgid "guestfs_kill_subprocess"
12005 #: ../src/guestfs-actions.pod:3451
12009 " guestfs_kill_subprocess (guestfs_h *g);\n"
12014 #: ../src/guestfs-actions.pod:3454 ../fish/guestfish-actions.pod:2416
12015 msgid "This kills the qemu subprocess. You should never need to call this."
12019 #: ../src/guestfs-actions.pod:3460
12020 msgid "guestfs_launch"
12024 #: ../src/guestfs-actions.pod:3462
12028 " guestfs_launch (guestfs_h *g);\n"
12033 #: ../src/guestfs-actions.pod:3465 ../fish/guestfish-actions.pod:2424
12035 "Internally libguestfs is implemented by running a virtual machine using "
12040 #: ../src/guestfs-actions.pod:3468 ../fish/guestfish-actions.pod:2427
12042 "You should call this after configuring the handle (eg. adding drives) but "
12043 "before performing any actions."
12047 #: ../src/guestfs-actions.pod:3480
12048 msgid "guestfs_lchown"
12052 #: ../src/guestfs-actions.pod:3482
12056 " guestfs_lchown (guestfs_h *g,\n"
12059 " const char *path);\n"
12064 #: ../src/guestfs-actions.pod:3488
12066 "Change the file owner to C<owner> and group to C<group>. This is like "
12067 "C<guestfs_chown> but if C<path> is a symlink then the link itself is "
12068 "changed, not the target."
12072 #: ../src/guestfs-actions.pod:3500
12073 msgid "guestfs_lgetxattr"
12077 #: ../src/guestfs-actions.pod:3502
12081 " guestfs_lgetxattr (guestfs_h *g,\n"
12082 " const char *path,\n"
12083 " const char *name,\n"
12084 " size_t *size_r);\n"
12089 #: ../src/guestfs-actions.pod:3508 ../fish/guestfish-actions.pod:2446
12091 "Get a single extended attribute from file C<path> named C<name>. If C<path> "
12092 "is a symlink, then this call returns an extended attribute from the symlink."
12096 #: ../src/guestfs-actions.pod:3522
12097 msgid "See also: C<guestfs_lgetxattrs>, C<guestfs_getxattr>, L<attr(5)>."
12101 #: ../src/guestfs-actions.pod:3530
12102 msgid "guestfs_lgetxattrs"
12106 #: ../src/guestfs-actions.pod:3532
12109 " struct guestfs_xattr_list *\n"
12110 " guestfs_lgetxattrs (guestfs_h *g,\n"
12111 " const char *path);\n"
12116 #: ../src/guestfs-actions.pod:3536
12118 "This is the same as C<guestfs_getxattrs>, but if C<path> is a symbolic link, "
12119 "then it returns the extended attributes of the link itself."
12123 #: ../src/guestfs-actions.pod:3546
12124 msgid "guestfs_list_devices"
12128 #: ../src/guestfs-actions.pod:3548
12132 " guestfs_list_devices (guestfs_h *g);\n"
12137 #: ../src/guestfs-actions.pod:3551 ../fish/guestfish-actions.pod:2474
12138 msgid "List all the block devices."
12142 #: ../src/guestfs-actions.pod:3553 ../fish/guestfish-actions.pod:2476
12143 msgid "The full block device names are returned, eg. C</dev/sda>."
12147 #: ../src/guestfs-actions.pod:3563
12148 msgid "guestfs_list_filesystems"
12152 #: ../src/guestfs-actions.pod:3565
12156 " guestfs_list_filesystems (guestfs_h *g);\n"
12161 #: ../src/guestfs-actions.pod:3568 ../fish/guestfish-actions.pod:2484
12163 "This inspection command looks for filesystems on partitions, block devices "
12164 "and logical volumes, returning a list of devices containing filesystems and "
12169 #: ../src/guestfs-actions.pod:3572 ../fish/guestfish-actions.pod:2488
12171 "The return value is a hash, where the keys are the devices containing "
12172 "filesystems, and the values are the filesystem types. For example:"
12176 #: ../src/guestfs-actions.pod:3576 ../fish/guestfish-actions.pod:2492
12179 " \"/dev/sda1\" => \"ntfs\"\n"
12180 " \"/dev/sda2\" => \"ext2\"\n"
12181 " \"/dev/vg_guest/lv_root\" => \"ext4\"\n"
12182 " \"/dev/vg_guest/lv_swap\" => \"swap\"\n"
12187 #: ../src/guestfs-actions.pod:3581 ../fish/guestfish-actions.pod:2497
12189 "The value can have the special value \"unknown\", meaning the content of the "
12190 "device is undetermined or empty. \"swap\" means a Linux swap partition."
12194 #: ../src/guestfs-actions.pod:3585
12196 "This command runs other libguestfs commands, which might include "
12197 "C<guestfs_mount> and C<guestfs_umount>, and therefore you should use this "
12198 "soon after launch and only when nothing is mounted."
12202 #: ../src/guestfs-actions.pod:3589
12204 "Not all of the filesystems returned will be mountable. In particular, swap "
12205 "partitions are returned in the list. Also this command does not check that "
12206 "each filesystem found is valid and mountable, and some filesystems might be "
12207 "mountable but require special options. Filesystems may not all belong to a "
12208 "single logical operating system (use C<guestfs_inspect_os> to look for OSes)."
12212 #: ../src/guestfs-actions.pod:3603 ../src/guestfs-actions.pod:5224
12213 msgid "(Added in 1.5.15)"
12217 #: ../src/guestfs-actions.pod:3605
12218 msgid "guestfs_list_partitions"
12222 #: ../src/guestfs-actions.pod:3607
12226 " guestfs_list_partitions (guestfs_h *g);\n"
12231 #: ../src/guestfs-actions.pod:3610 ../fish/guestfish-actions.pod:2517
12232 msgid "List all the partitions detected on all block devices."
12236 #: ../src/guestfs-actions.pod:3612 ../fish/guestfish-actions.pod:2519
12237 msgid "The full partition device names are returned, eg. C</dev/sda1>"
12241 #: ../src/guestfs-actions.pod:3614
12243 "This does not return logical volumes. For that you will need to call "
12248 #: ../src/guestfs-actions.pod:3625
12253 #: ../src/guestfs-actions.pod:3627
12257 " guestfs_ll (guestfs_h *g,\n"
12258 " const char *directory);\n"
12263 #: ../src/guestfs-actions.pod:3631 ../fish/guestfish-actions.pod:2530
12265 "List the files in C<directory> (relative to the root directory, there is no "
12266 "cwd) in the format of 'ls -la'."
12270 #: ../src/guestfs-actions.pod:3634 ../fish/guestfish-actions.pod:2533
12272 "This command is mostly useful for interactive sessions. It is I<not> "
12273 "intended that you try to parse the output string."
12277 #: ../src/guestfs-actions.pod:3642
12282 #: ../src/guestfs-actions.pod:3644
12286 " guestfs_ln (guestfs_h *g,\n"
12287 " const char *target,\n"
12288 " const char *linkname);\n"
12293 #: ../src/guestfs-actions.pod:3649 ../fish/guestfish-actions.pod:2540
12294 msgid "This command creates a hard link using the C<ln> command."
12298 #: ../src/guestfs-actions.pod:3655
12299 msgid "guestfs_ln_f"
12303 #: ../src/guestfs-actions.pod:3657
12307 " guestfs_ln_f (guestfs_h *g,\n"
12308 " const char *target,\n"
12309 " const char *linkname);\n"
12314 #: ../src/guestfs-actions.pod:3662 ../fish/guestfish-actions.pod:2546
12316 "This command creates a hard link using the C<ln -f> command. The I<-f> "
12317 "option removes the link (C<linkname>) if it exists already."
12321 #: ../src/guestfs-actions.pod:3669
12322 msgid "guestfs_ln_s"
12326 #: ../src/guestfs-actions.pod:3671
12330 " guestfs_ln_s (guestfs_h *g,\n"
12331 " const char *target,\n"
12332 " const char *linkname);\n"
12337 #: ../src/guestfs-actions.pod:3676 ../fish/guestfish-actions.pod:2553
12338 msgid "This command creates a symbolic link using the C<ln -s> command."
12342 #: ../src/guestfs-actions.pod:3682
12343 msgid "guestfs_ln_sf"
12347 #: ../src/guestfs-actions.pod:3684
12351 " guestfs_ln_sf (guestfs_h *g,\n"
12352 " const char *target,\n"
12353 " const char *linkname);\n"
12358 #: ../src/guestfs-actions.pod:3689 ../fish/guestfish-actions.pod:2559
12360 "This command creates a symbolic link using the C<ln -sf> command, The I<-f> "
12361 "option removes the link (C<linkname>) if it exists already."
12365 #: ../src/guestfs-actions.pod:3696
12366 msgid "guestfs_lremovexattr"
12370 #: ../src/guestfs-actions.pod:3698
12374 " guestfs_lremovexattr (guestfs_h *g,\n"
12375 " const char *xattr,\n"
12376 " const char *path);\n"
12381 #: ../src/guestfs-actions.pod:3703
12383 "This is the same as C<guestfs_removexattr>, but if C<path> is a symbolic "
12384 "link, then it removes an extended attribute of the link itself."
12388 #: ../src/guestfs-actions.pod:3711
12393 #: ../src/guestfs-actions.pod:3713
12397 " guestfs_ls (guestfs_h *g,\n"
12398 " const char *directory);\n"
12403 #: ../src/guestfs-actions.pod:3717 ../fish/guestfish-actions.pod:2574
12405 "List the files in C<directory> (relative to the root directory, there is no "
12406 "cwd). The '.' and '..' entries are not returned, but hidden files are shown."
12410 #: ../src/guestfs-actions.pod:3721
12412 "This command is mostly useful for interactive sessions. Programs should "
12413 "probably use C<guestfs_readdir> instead."
12417 #: ../src/guestfs-actions.pod:3730
12418 msgid "guestfs_lsetxattr"
12422 #: ../src/guestfs-actions.pod:3732
12426 " guestfs_lsetxattr (guestfs_h *g,\n"
12427 " const char *xattr,\n"
12428 " const char *val,\n"
12430 " const char *path);\n"
12435 #: ../src/guestfs-actions.pod:3739
12437 "This is the same as C<guestfs_setxattr>, but if C<path> is a symbolic link, "
12438 "then it sets an extended attribute of the link itself."
12442 #: ../src/guestfs-actions.pod:3747
12443 msgid "guestfs_lstat"
12447 #: ../src/guestfs-actions.pod:3749
12450 " struct guestfs_stat *\n"
12451 " guestfs_lstat (guestfs_h *g,\n"
12452 " const char *path);\n"
12457 #: ../src/guestfs-actions.pod:3753 ../src/guestfs-actions.pod:6355
12458 #: ../fish/guestfish-actions.pod:2593 ../fish/guestfish-actions.pod:4306
12459 msgid "Returns file information for the given C<path>."
12463 #: ../src/guestfs-actions.pod:3755
12465 "This is the same as C<guestfs_stat> except that if C<path> is a symbolic "
12466 "link, then the link is stat-ed, not the file it refers to."
12470 #: ../src/guestfs-actions.pod:3759 ../fish/guestfish-actions.pod:2599
12471 msgid "This is the same as the C<lstat(2)> system call."
12475 #: ../src/guestfs-actions.pod:3761 ../src/guestfs-actions.pod:6359
12477 "This function returns a C<struct guestfs_stat *>, or NULL if there was an "
12478 "error. I<The caller must call C<guestfs_free_stat> after use>."
12482 #: ../src/guestfs-actions.pod:3765 ../src/guestfs-actions.pod:6363
12483 #: ../src/guestfs-actions.pod:6381 ../src/guestfs-actions.pod:6762
12484 msgid "(Added in 0.9.2)"
12488 #: ../src/guestfs-actions.pod:3767
12489 msgid "guestfs_lstatlist"
12493 #: ../src/guestfs-actions.pod:3769
12496 " struct guestfs_stat_list *\n"
12497 " guestfs_lstatlist (guestfs_h *g,\n"
12498 " const char *path,\n"
12499 " char *const *names);\n"
12504 #: ../src/guestfs-actions.pod:3774
12506 "This call allows you to perform the C<guestfs_lstat> operation on multiple "
12507 "files, where all files are in the directory C<path>. C<names> is the list "
12508 "of files from this directory."
12512 #: ../src/guestfs-actions.pod:3778 ../fish/guestfish-actions.pod:2609
12514 "On return you get a list of stat structs, with a one-to-one correspondence "
12515 "to the C<names> list. If any name did not exist or could not be lstat'd, "
12516 "then the C<ino> field of that structure is set to C<-1>."
12520 #: ../src/guestfs-actions.pod:3783
12522 "This call is intended for programs that want to efficiently list a directory "
12523 "contents without making many round-trips. See also C<guestfs_lxattrlist> "
12524 "for a similarly efficient call for getting extended attributes. Very long "
12525 "directory listings might cause the protocol message size to be exceeded, "
12526 "causing this call to fail. The caller must split up such requests into "
12527 "smaller groups of names."
12531 #: ../src/guestfs-actions.pod:3791
12533 "This function returns a C<struct guestfs_stat_list *>, or NULL if there was "
12534 "an error. I<The caller must call C<guestfs_free_stat_list> after use>."
12538 #: ../src/guestfs-actions.pod:3797
12539 msgid "guestfs_luks_add_key"
12543 #: ../src/guestfs-actions.pod:3799
12547 " guestfs_luks_add_key (guestfs_h *g,\n"
12548 " const char *device,\n"
12549 " const char *key,\n"
12550 " const char *newkey,\n"
12556 #: ../src/guestfs-actions.pod:3806 ../fish/guestfish-actions.pod:2626
12558 "This command adds a new key on LUKS device C<device>. C<key> is any "
12559 "existing key, and is used to access the device. C<newkey> is the new key to "
12560 "add. C<keyslot> is the key slot that will be replaced."
12564 #: ../src/guestfs-actions.pod:3811
12566 "Note that if C<keyslot> already contains a key, then this command will "
12567 "fail. You have to use C<guestfs_luks_kill_slot> first to remove that key."
12571 #: ../src/guestfs-actions.pod:3817 ../src/guestfs-actions.pod:3857
12572 #: ../src/guestfs-actions.pod:3880 ../src/guestfs-actions.pod:3900
12573 #: ../src/guestfs-actions.pod:3932 ../src/guestfs-actions.pod:3951
12575 "This function takes a key or passphrase parameter which could contain "
12576 "sensitive material. Read the section L</KEYS AND PASSPHRASES> for more "
12581 #: ../src/guestfs-actions.pod:3821 ../src/guestfs-actions.pod:3861
12582 #: ../src/guestfs-actions.pod:3884 ../src/guestfs-actions.pod:3904
12583 msgid "(Added in 1.5.2)"
12587 #: ../src/guestfs-actions.pod:3823
12588 msgid "guestfs_luks_close"
12592 #: ../src/guestfs-actions.pod:3825
12596 " guestfs_luks_close (guestfs_h *g,\n"
12597 " const char *device);\n"
12602 #: ../src/guestfs-actions.pod:3829
12604 "This closes a LUKS device that was created earlier by C<guestfs_luks_open> "
12605 "or C<guestfs_luks_open_ro>. The C<device> parameter must be the name of the "
12606 "LUKS mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
12607 "underlying block device."
12611 #: ../src/guestfs-actions.pod:3837 ../src/guestfs-actions.pod:3936
12612 #: ../src/guestfs-actions.pod:3955 ../src/guestfs-actions.pod:4005
12613 #: ../src/guestfs-actions.pod:4053
12614 msgid "(Added in 1.5.1)"
12618 #: ../src/guestfs-actions.pod:3839
12619 msgid "guestfs_luks_format"
12623 #: ../src/guestfs-actions.pod:3841
12627 " guestfs_luks_format (guestfs_h *g,\n"
12628 " const char *device,\n"
12629 " const char *key,\n"
12635 #: ../src/guestfs-actions.pod:3847 ../fish/guestfish-actions.pod:2652
12637 "This command erases existing data on C<device> and formats the device as a "
12638 "LUKS encrypted device. C<key> is the initial key, which is added to key "
12639 "slot C<slot>. (LUKS supports 8 key slots, numbered 0-7)."
12643 #: ../src/guestfs-actions.pod:3854 ../src/guestfs-actions.pod:3877
12644 #: ../src/guestfs-actions.pod:4017 ../src/guestfs-actions.pod:4975
12645 #: ../src/guestfs-actions.pod:5755 ../src/guestfs-actions.pod:6162
12646 #: ../src/guestfs-actions.pod:6192 ../src/guestfs-actions.pod:6225
12647 #: ../src/guestfs-actions.pod:7406 ../fish/guestfish-actions.pod:2660
12648 #: ../fish/guestfish-actions.pod:2673 ../fish/guestfish-actions.pod:2757
12649 #: ../fish/guestfish-actions.pod:3347 ../fish/guestfish-actions.pod:3867
12650 #: ../fish/guestfish-actions.pod:4177 ../fish/guestfish-actions.pod:4200
12651 #: ../fish/guestfish-actions.pod:4222 ../fish/guestfish-actions.pod:4951
12653 "B<This command is dangerous. Without careful use you can easily destroy all "
12658 #: ../src/guestfs-actions.pod:3863
12659 msgid "guestfs_luks_format_cipher"
12663 #: ../src/guestfs-actions.pod:3865
12667 " guestfs_luks_format_cipher (guestfs_h *g,\n"
12668 " const char *device,\n"
12669 " const char *key,\n"
12671 " const char *cipher);\n"
12676 #: ../src/guestfs-actions.pod:3872
12678 "This command is the same as C<guestfs_luks_format> but it also allows you to "
12679 "set the C<cipher> used."
12683 #: ../src/guestfs-actions.pod:3886
12684 msgid "guestfs_luks_kill_slot"
12688 #: ../src/guestfs-actions.pod:3888
12692 " guestfs_luks_kill_slot (guestfs_h *g,\n"
12693 " const char *device,\n"
12694 " const char *key,\n"
12700 #: ../src/guestfs-actions.pod:3894 ../fish/guestfish-actions.pod:2680
12702 "This command deletes the key in key slot C<keyslot> from the encrypted LUKS "
12703 "device C<device>. C<key> must be one of the I<other> keys."
12707 #: ../src/guestfs-actions.pod:3906
12708 msgid "guestfs_luks_open"
12712 #: ../src/guestfs-actions.pod:3908
12716 " guestfs_luks_open (guestfs_h *g,\n"
12717 " const char *device,\n"
12718 " const char *key,\n"
12719 " const char *mapname);\n"
12724 #: ../src/guestfs-actions.pod:3914 ../fish/guestfish-actions.pod:2691
12726 "This command opens a block device which has been encrypted according to the "
12727 "Linux Unified Key Setup (LUKS) standard."
12731 #: ../src/guestfs-actions.pod:3917 ../fish/guestfish-actions.pod:2694
12732 msgid "C<device> is the encrypted block device or partition."
12736 #: ../src/guestfs-actions.pod:3919 ../fish/guestfish-actions.pod:2696
12738 "The caller must supply one of the keys associated with the LUKS block "
12739 "device, in the C<key> parameter."
12743 #: ../src/guestfs-actions.pod:3922 ../fish/guestfish-actions.pod:2699
12745 "This creates a new block device called C</dev/mapper/mapname>. Reads and "
12746 "writes to this block device are decrypted from and encrypted to the "
12747 "underlying C<device> respectively."
12751 #: ../src/guestfs-actions.pod:3926
12753 "If this block device contains LVM volume groups, then calling "
12754 "C<guestfs_vgscan> followed by C<guestfs_vg_activate_all> will make them "
12759 #: ../src/guestfs-actions.pod:3938
12760 msgid "guestfs_luks_open_ro"
12764 #: ../src/guestfs-actions.pod:3940
12768 " guestfs_luks_open_ro (guestfs_h *g,\n"
12769 " const char *device,\n"
12770 " const char *key,\n"
12771 " const char *mapname);\n"
12776 #: ../src/guestfs-actions.pod:3946
12778 "This is the same as C<guestfs_luks_open> except that a read-only mapping is "
12783 #: ../src/guestfs-actions.pod:3957
12784 msgid "guestfs_lvcreate"
12788 #: ../src/guestfs-actions.pod:3959
12792 " guestfs_lvcreate (guestfs_h *g,\n"
12793 " const char *logvol,\n"
12794 " const char *volgroup,\n"
12800 #: ../src/guestfs-actions.pod:3965 ../fish/guestfish-actions.pod:2724
12802 "This creates an LVM logical volume called C<logvol> on the volume group "
12803 "C<volgroup>, with C<size> megabytes."
12807 #: ../src/guestfs-actions.pod:3972
12808 msgid "guestfs_lvm_canonical_lv_name"
12812 #: ../src/guestfs-actions.pod:3974
12816 " guestfs_lvm_canonical_lv_name (guestfs_h *g,\n"
12817 " const char *lvname);\n"
12822 #: ../src/guestfs-actions.pod:3978 ../fish/guestfish-actions.pod:2731
12824 "This converts alternative naming schemes for LVs that you might find to the "
12825 "canonical name. For example, C</dev/mapper/VG-LV> is converted to C</dev/VG/"
12830 #: ../src/guestfs-actions.pod:3982 ../fish/guestfish-actions.pod:2735
12832 "This command returns an error if the C<lvname> parameter does not refer to a "
12837 #: ../src/guestfs-actions.pod:3985
12838 msgid "See also C<guestfs_is_lv>."
12842 #: ../src/guestfs-actions.pod:3990
12843 msgid "(Added in 1.5.24)"
12847 #: ../src/guestfs-actions.pod:3992
12848 msgid "guestfs_lvm_clear_filter"
12852 #: ../src/guestfs-actions.pod:3994
12856 " guestfs_lvm_clear_filter (guestfs_h *g);\n"
12861 #: ../src/guestfs-actions.pod:3997
12863 "This undoes the effect of C<guestfs_lvm_set_filter>. LVM will be able to "
12864 "see every block device."
12868 #: ../src/guestfs-actions.pod:4000 ../src/guestfs-actions.pod:4042
12869 #: ../fish/guestfish-actions.pod:2747 ../fish/guestfish-actions.pod:2778
12871 "This command also clears the LVM cache and performs a volume group scan."
12875 #: ../src/guestfs-actions.pod:4007
12876 msgid "guestfs_lvm_remove_all"
12880 #: ../src/guestfs-actions.pod:4009
12884 " guestfs_lvm_remove_all (guestfs_h *g);\n"
12889 #: ../src/guestfs-actions.pod:4012 ../fish/guestfish-actions.pod:2754
12891 "This command removes all LVM logical volumes, volume groups and physical "
12896 #: ../src/guestfs-actions.pod:4022
12897 msgid "guestfs_lvm_set_filter"
12901 #: ../src/guestfs-actions.pod:4024
12905 " guestfs_lvm_set_filter (guestfs_h *g,\n"
12906 " char *const *devices);\n"
12911 #: ../src/guestfs-actions.pod:4028 ../fish/guestfish-actions.pod:2764
12913 "This sets the LVM device filter so that LVM will only be able to \"see\" the "
12914 "block devices in the list C<devices>, and will ignore all other attached "
12919 #: ../src/guestfs-actions.pod:4032 ../fish/guestfish-actions.pod:2768
12921 "Where disk image(s) contain duplicate PVs or VGs, this command is useful to "
12922 "get LVM to ignore the duplicates, otherwise LVM can get confused. Note also "
12923 "there are two types of duplication possible: either cloned PVs/VGs which "
12924 "have identical UUIDs; or VGs that are not cloned but just happen to have the "
12925 "same name. In normal operation you cannot create this situation, but you "
12926 "can do it outside LVM, eg. by cloning disk images or by bit twiddling "
12927 "inside the LVM metadata."
12931 #: ../src/guestfs-actions.pod:4045 ../fish/guestfish-actions.pod:2781
12932 msgid "You can filter whole block devices or individual partitions."
12936 #: ../src/guestfs-actions.pod:4047 ../fish/guestfish-actions.pod:2783
12938 "You cannot use this if any VG is currently in use (eg. contains a mounted "
12939 "filesystem), even if you are not filtering out that VG."
12943 #: ../src/guestfs-actions.pod:4055
12944 msgid "guestfs_lvremove"
12948 #: ../src/guestfs-actions.pod:4057
12952 " guestfs_lvremove (guestfs_h *g,\n"
12953 " const char *device);\n"
12958 #: ../src/guestfs-actions.pod:4061 ../fish/guestfish-actions.pod:2791
12960 "Remove an LVM logical volume C<device>, where C<device> is the path to the "
12961 "LV, such as C</dev/VG/LV>."
12965 #: ../src/guestfs-actions.pod:4064 ../fish/guestfish-actions.pod:2794
12967 "You can also remove all LVs in a volume group by specifying the VG name, C</"
12972 #: ../src/guestfs-actions.pod:4069 ../src/guestfs-actions.pod:5321
12973 #: ../src/guestfs-actions.pod:7138
12974 msgid "(Added in 1.0.13)"
12978 #: ../src/guestfs-actions.pod:4071
12979 msgid "guestfs_lvrename"
12983 #: ../src/guestfs-actions.pod:4073
12987 " guestfs_lvrename (guestfs_h *g,\n"
12988 " const char *logvol,\n"
12989 " const char *newlogvol);\n"
12994 #: ../src/guestfs-actions.pod:4078 ../fish/guestfish-actions.pod:2801
12995 msgid "Rename a logical volume C<logvol> with the new name C<newlogvol>."
12999 #: ../src/guestfs-actions.pod:4082 ../src/guestfs-actions.pod:7151
13000 msgid "(Added in 1.0.83)"
13004 #: ../src/guestfs-actions.pod:4084
13005 msgid "guestfs_lvresize"
13009 #: ../src/guestfs-actions.pod:4086
13013 " guestfs_lvresize (guestfs_h *g,\n"
13014 " const char *device,\n"
13020 #: ../src/guestfs-actions.pod:4091 ../fish/guestfish-actions.pod:2807
13022 "This resizes (expands or shrinks) an existing LVM logical volume to "
13023 "C<mbytes>. When reducing, data in the reduced part is lost."
13027 #: ../src/guestfs-actions.pod:4099
13028 msgid "guestfs_lvresize_free"
13032 #: ../src/guestfs-actions.pod:4101
13036 " guestfs_lvresize_free (guestfs_h *g,\n"
13037 " const char *lv,\n"
13043 #: ../src/guestfs-actions.pod:4106 ../fish/guestfish-actions.pod:2815
13045 "This expands an existing logical volume C<lv> so that it fills C<pc>% of the "
13046 "remaining free space in the volume group. Commonly you would call this with "
13047 "pc = 100 which expands the logical volume as much as possible, using all "
13048 "remaining free space in the volume group."
13052 #: ../src/guestfs-actions.pod:4114
13053 msgid "(Added in 1.3.3)"
13057 #: ../src/guestfs-actions.pod:4116
13058 msgid "guestfs_lvs"
13062 #: ../src/guestfs-actions.pod:4118
13066 " guestfs_lvs (guestfs_h *g);\n"
13071 #: ../src/guestfs-actions.pod:4121 ../fish/guestfish-actions.pod:2825
13073 "List all the logical volumes detected. This is the equivalent of the L<lvs"
13078 #: ../src/guestfs-actions.pod:4124 ../fish/guestfish-actions.pod:2828
13080 "This returns a list of the logical volume device names (eg. C</dev/"
13081 "VolGroup00/LogVol00>)."
13085 #: ../src/guestfs-actions.pod:4127
13086 msgid "See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>."
13090 #: ../src/guestfs-actions.pod:4135
13091 msgid "guestfs_lvs_full"
13095 #: ../src/guestfs-actions.pod:4137
13098 " struct guestfs_lvm_lv_list *\n"
13099 " guestfs_lvs_full (guestfs_h *g);\n"
13104 #: ../src/guestfs-actions.pod:4140 ../fish/guestfish-actions.pod:2837
13106 "List all the logical volumes detected. This is the equivalent of the L<lvs"
13107 "(8)> command. The \"full\" version includes all fields."
13111 #: ../src/guestfs-actions.pod:4143
13113 "This function returns a C<struct guestfs_lvm_lv_list *>, or NULL if there "
13114 "was an error. I<The caller must call C<guestfs_free_lvm_lv_list> after use>."
13118 #: ../src/guestfs-actions.pod:4149
13119 msgid "guestfs_lvuuid"
13123 #: ../src/guestfs-actions.pod:4151
13127 " guestfs_lvuuid (guestfs_h *g,\n"
13128 " const char *device);\n"
13133 #: ../src/guestfs-actions.pod:4155 ../fish/guestfish-actions.pod:2844
13134 msgid "This command returns the UUID of the LVM LV C<device>."
13138 #: ../src/guestfs-actions.pod:4162
13139 msgid "guestfs_lxattrlist"
13143 #: ../src/guestfs-actions.pod:4164
13146 " struct guestfs_xattr_list *\n"
13147 " guestfs_lxattrlist (guestfs_h *g,\n"
13148 " const char *path,\n"
13149 " char *const *names);\n"
13154 #: ../src/guestfs-actions.pod:4169 ../fish/guestfish-actions.pod:2850
13156 "This call allows you to get the extended attributes of multiple files, where "
13157 "all files are in the directory C<path>. C<names> is the list of files from "
13162 #: ../src/guestfs-actions.pod:4173 ../fish/guestfish-actions.pod:2854
13164 "On return you get a flat list of xattr structs which must be interpreted "
13165 "sequentially. The first xattr struct always has a zero-length C<attrname>. "
13166 "C<attrval> in this struct is zero-length to indicate there was an error "
13167 "doing C<lgetxattr> for this file, I<or> is a C string which is a decimal "
13168 "number (the number of following attributes for this file, which could be C<"
13169 "\"0\">). Then after the first xattr struct are the zero or more attributes "
13170 "for the first named file. This repeats for the second and subsequent files."
13174 #: ../src/guestfs-actions.pod:4183
13176 "This call is intended for programs that want to efficiently list a directory "
13177 "contents without making many round-trips. See also C<guestfs_lstatlist> for "
13178 "a similarly efficient call for getting standard stats. Very long directory "
13179 "listings might cause the protocol message size to be exceeded, causing this "
13180 "call to fail. The caller must split up such requests into smaller groups of "
13185 #: ../src/guestfs-actions.pod:4197
13186 msgid "guestfs_mkdir"
13190 #: ../src/guestfs-actions.pod:4199
13194 " guestfs_mkdir (guestfs_h *g,\n"
13195 " const char *path);\n"
13200 #: ../src/guestfs-actions.pod:4203 ../fish/guestfish-actions.pod:2876
13201 msgid "Create a directory named C<path>."
13205 #: ../src/guestfs-actions.pod:4209
13206 msgid "guestfs_mkdir_mode"
13210 #: ../src/guestfs-actions.pod:4211
13214 " guestfs_mkdir_mode (guestfs_h *g,\n"
13215 " const char *path,\n"
13221 #: ../src/guestfs-actions.pod:4216 ../fish/guestfish-actions.pod:2882
13223 "This command creates a directory, setting the initial permissions of the "
13224 "directory to C<mode>."
13228 #: ../src/guestfs-actions.pod:4219 ../fish/guestfish-actions.pod:2885
13230 "For common Linux filesystems, the actual mode which is set will be C<mode & "
13231 "~umask & 01777>. Non-native-Linux filesystems may interpret the mode in "
13236 #: ../src/guestfs-actions.pod:4223
13237 msgid "See also C<guestfs_mkdir>, C<guestfs_umask>"
13241 #: ../src/guestfs-actions.pod:4229
13242 msgid "guestfs_mkdir_p"
13246 #: ../src/guestfs-actions.pod:4231
13250 " guestfs_mkdir_p (guestfs_h *g,\n"
13251 " const char *path);\n"
13256 #: ../src/guestfs-actions.pod:4235 ../fish/guestfish-actions.pod:2895
13258 "Create a directory named C<path>, creating any parent directories as "
13259 "necessary. This is like the C<mkdir -p> shell command."
13263 #: ../src/guestfs-actions.pod:4242
13264 msgid "guestfs_mkdtemp"
13268 #: ../src/guestfs-actions.pod:4244
13272 " guestfs_mkdtemp (guestfs_h *g,\n"
13273 " const char *template);\n"
13278 #: ../src/guestfs-actions.pod:4248 ../fish/guestfish-actions.pod:2902
13280 "This command creates a temporary directory. The C<template> parameter "
13281 "should be a full pathname for the temporary directory name with the final "
13282 "six characters being \"XXXXXX\"."
13286 #: ../src/guestfs-actions.pod:4253 ../fish/guestfish-actions.pod:2907
13288 "For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\", the second one "
13289 "being suitable for Windows filesystems."
13293 #: ../src/guestfs-actions.pod:4256 ../fish/guestfish-actions.pod:2910
13294 msgid "The name of the temporary directory that was created is returned."
13298 #: ../src/guestfs-actions.pod:4259 ../fish/guestfish-actions.pod:2913
13299 msgid "The temporary directory is created with mode 0700 and is owned by root."
13303 #: ../src/guestfs-actions.pod:4262 ../fish/guestfish-actions.pod:2916
13305 "The caller is responsible for deleting the temporary directory and its "
13306 "contents after use."
13310 #: ../src/guestfs-actions.pod:4265 ../fish/guestfish-actions.pod:2919
13311 msgid "See also: L<mkdtemp(3)>"
13315 #: ../src/guestfs-actions.pod:4272
13316 msgid "guestfs_mke2fs_J"
13320 #: ../src/guestfs-actions.pod:4274
13324 " guestfs_mke2fs_J (guestfs_h *g,\n"
13325 " const char *fstype,\n"
13326 " int blocksize,\n"
13327 " const char *device,\n"
13328 " const char *journal);\n"
13333 #: ../src/guestfs-actions.pod:4281 ../fish/guestfish-actions.pod:2925
13335 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
13336 "C<journal>. It is equivalent to the command:"
13340 #: ../src/guestfs-actions.pod:4285 ../fish/guestfish-actions.pod:2929
13343 " mke2fs -t fstype -b blocksize -J device=<journal> <device>\n"
13348 #: ../src/guestfs-actions.pod:4287
13349 msgid "See also C<guestfs_mke2journal>."
13353 #: ../src/guestfs-actions.pod:4291 ../src/guestfs-actions.pod:4309
13354 #: ../src/guestfs-actions.pod:4327 ../src/guestfs-actions.pod:4343
13355 #: ../src/guestfs-actions.pod:4357 ../src/guestfs-actions.pod:4371
13356 #: ../src/guestfs-actions.pod:4430 ../src/guestfs-actions.pod:4695
13357 msgid "(Added in 1.0.68)"
13361 #: ../src/guestfs-actions.pod:4293
13362 msgid "guestfs_mke2fs_JL"
13366 #: ../src/guestfs-actions.pod:4295
13370 " guestfs_mke2fs_JL (guestfs_h *g,\n"
13371 " const char *fstype,\n"
13372 " int blocksize,\n"
13373 " const char *device,\n"
13374 " const char *label);\n"
13379 #: ../src/guestfs-actions.pod:4302 ../fish/guestfish-actions.pod:2937
13381 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
13382 "the journal labeled C<label>."
13386 #: ../src/guestfs-actions.pod:4305
13387 msgid "See also C<guestfs_mke2journal_L>."
13391 #: ../src/guestfs-actions.pod:4311
13392 msgid "guestfs_mke2fs_JU"
13396 #: ../src/guestfs-actions.pod:4313
13400 " guestfs_mke2fs_JU (guestfs_h *g,\n"
13401 " const char *fstype,\n"
13402 " int blocksize,\n"
13403 " const char *device,\n"
13404 " const char *uuid);\n"
13409 #: ../src/guestfs-actions.pod:4320 ../fish/guestfish-actions.pod:2946
13411 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
13412 "the journal with UUID C<uuid>."
13416 #: ../src/guestfs-actions.pod:4323
13417 msgid "See also C<guestfs_mke2journal_U>."
13421 #: ../src/guestfs-actions.pod:4329
13422 msgid "guestfs_mke2journal"
13426 #: ../src/guestfs-actions.pod:4331
13430 " guestfs_mke2journal (guestfs_h *g,\n"
13431 " int blocksize,\n"
13432 " const char *device);\n"
13437 #: ../src/guestfs-actions.pod:4336 ../fish/guestfish-actions.pod:2955
13439 "This creates an ext2 external journal on C<device>. It is equivalent to the "
13444 #: ../src/guestfs-actions.pod:4339 ../fish/guestfish-actions.pod:2958
13447 " mke2fs -O journal_dev -b blocksize device\n"
13452 #: ../src/guestfs-actions.pod:4345
13453 msgid "guestfs_mke2journal_L"
13457 #: ../src/guestfs-actions.pod:4347
13461 " guestfs_mke2journal_L (guestfs_h *g,\n"
13462 " int blocksize,\n"
13463 " const char *label,\n"
13464 " const char *device);\n"
13469 #: ../src/guestfs-actions.pod:4353 ../fish/guestfish-actions.pod:2964
13470 msgid "This creates an ext2 external journal on C<device> with label C<label>."
13474 #: ../src/guestfs-actions.pod:4359
13475 msgid "guestfs_mke2journal_U"
13479 #: ../src/guestfs-actions.pod:4361
13483 " guestfs_mke2journal_U (guestfs_h *g,\n"
13484 " int blocksize,\n"
13485 " const char *uuid,\n"
13486 " const char *device);\n"
13491 #: ../src/guestfs-actions.pod:4367 ../fish/guestfish-actions.pod:2970
13492 msgid "This creates an ext2 external journal on C<device> with UUID C<uuid>."
13496 #: ../src/guestfs-actions.pod:4373
13497 msgid "guestfs_mkfifo"
13501 #: ../src/guestfs-actions.pod:4375
13505 " guestfs_mkfifo (guestfs_h *g,\n"
13507 " const char *path);\n"
13512 #: ../src/guestfs-actions.pod:4380
13514 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
13515 "is just a convenient wrapper around C<guestfs_mknod>."
13519 #: ../src/guestfs-actions.pod:4390
13520 msgid "guestfs_mkfs"
13524 #: ../src/guestfs-actions.pod:4392
13528 " guestfs_mkfs (guestfs_h *g,\n"
13529 " const char *fstype,\n"
13530 " const char *device);\n"
13535 #: ../src/guestfs-actions.pod:4397 ../fish/guestfish-actions.pod:2986
13537 "This creates a filesystem on C<device> (usually a partition or LVM logical "
13538 "volume). The filesystem type is C<fstype>, for example C<ext3>."
13542 #: ../src/guestfs-actions.pod:4405
13543 msgid "guestfs_mkfs_b"
13547 #: ../src/guestfs-actions.pod:4407
13551 " guestfs_mkfs_b (guestfs_h *g,\n"
13552 " const char *fstype,\n"
13553 " int blocksize,\n"
13554 " const char *device);\n"
13559 #: ../src/guestfs-actions.pod:4413
13561 "This call is similar to C<guestfs_mkfs>, but it allows you to control the "
13562 "block size of the resulting filesystem. Supported block sizes depend on the "
13563 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
13567 #: ../src/guestfs-actions.pod:4418 ../src/guestfs-actions.pod:4461
13568 #: ../fish/guestfish-actions.pod:2999 ../fish/guestfish-actions.pod:3026
13570 "For VFAT and NTFS the C<blocksize> parameter is treated as the requested "
13575 #: ../src/guestfs-actions.pod:4423
13577 "This function is deprecated. In new code, use the L</guestfs_mkfs_opts> "
13582 #: ../src/guestfs-actions.pod:4432
13583 msgid "guestfs_mkfs_opts"
13587 #: ../src/guestfs-actions.pod:4434
13591 " guestfs_mkfs_opts (guestfs_h *g,\n"
13592 " const char *fstype,\n"
13593 " const char *device,\n"
13599 #: ../src/guestfs-actions.pod:4445
13602 " GUESTFS_MKFS_OPTS_BLOCKSIZE, int blocksize,\n"
13603 " GUESTFS_MKFS_OPTS_FEATURES, const char *features,\n"
13608 #: ../src/guestfs-actions.pod:4448 ../fish/guestfish-actions.pod:3013
13610 "This function creates a filesystem on C<device>. The filesystem type is "
13611 "C<fstype>, for example C<ext3>."
13615 #: ../src/guestfs-actions.pod:4455 ../fish/guestfish-actions.pod:3020
13616 msgid "C<blocksize>"
13620 #: ../src/guestfs-actions.pod:4457 ../fish/guestfish-actions.pod:3022
13622 "The filesystem block size. Supported block sizes depend on the filesystem "
13623 "type, but typically they are C<1024>, C<2048> or C<4096> for Linux ext2/3 "
13628 #: ../src/guestfs-actions.pod:4464 ../fish/guestfish-actions.pod:3029
13629 msgid "For UFS block sizes, please see L<mkfs.ufs(8)>."
13633 #: ../src/guestfs-actions.pod:4466 ../fish/guestfish-actions.pod:3031
13634 msgid "C<features>"
13638 #: ../src/guestfs-actions.pod:4468 ../fish/guestfish-actions.pod:3033
13639 msgid "This passes the I<-O> parameter to the external mkfs program."
13643 #: ../src/guestfs-actions.pod:4470 ../fish/guestfish-actions.pod:3035
13645 "For certain filesystem types, this allows extra filesystem features to be "
13646 "selected. See L<mke2fs(8)> and L<mkfs.ufs(8)> for more details."
13650 #: ../src/guestfs-actions.pod:4474 ../fish/guestfish-actions.pod:3039
13652 "You cannot use this optional parameter with the C<gfs> or C<gfs2> filesystem "
13657 #: ../src/guestfs-actions.pod:4481
13658 msgid "(Added in 1.7.19)"
13662 #: ../src/guestfs-actions.pod:4483
13663 msgid "guestfs_mkfs_opts_va"
13667 #: ../src/guestfs-actions.pod:4485
13671 " guestfs_mkfs_opts_va (guestfs_h *g,\n"
13672 " const char *fstype,\n"
13673 " const char *device,\n"
13674 " va_list args);\n"
13679 #: ../src/guestfs-actions.pod:4491
13680 msgid "This is the \"va_list variant\" of L</guestfs_mkfs_opts>."
13684 #: ../src/guestfs-actions.pod:4495
13685 msgid "guestfs_mkfs_opts_argv"
13689 #: ../src/guestfs-actions.pod:4497
13693 " guestfs_mkfs_opts_argv (guestfs_h *g,\n"
13694 " const char *fstype,\n"
13695 " const char *device,\n"
13696 " const struct guestfs_mkfs_opts_argv *optargs);\n"
13701 #: ../src/guestfs-actions.pod:4503
13702 msgid "This is the \"argv variant\" of L</guestfs_mkfs_opts>."
13706 #: ../src/guestfs-actions.pod:4507
13707 msgid "guestfs_mkmountpoint"
13711 #: ../src/guestfs-actions.pod:4509
13715 " guestfs_mkmountpoint (guestfs_h *g,\n"
13716 " const char *exemptpath);\n"
13721 #: ../src/guestfs-actions.pod:4513
13723 "C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are specialized calls "
13724 "that can be used to create extra mountpoints before mounting the first "
13729 #: ../src/guestfs-actions.pod:4517 ../fish/guestfish-actions.pod:3054
13731 "These calls are I<only> necessary in some very limited circumstances, mainly "
13732 "the case where you want to mount a mix of unrelated and/or read-only "
13733 "filesystems together."
13737 #: ../src/guestfs-actions.pod:4521 ../fish/guestfish-actions.pod:3058
13739 "For example, live CDs often contain a \"Russian doll\" nest of filesystems, "
13740 "an ISO outer layer, with a squashfs image inside, with an ext2/3 image "
13741 "inside that. You can unpack this as follows in guestfish:"
13745 #: ../src/guestfs-actions.pod:4526 ../fish/guestfish-actions.pod:3063
13748 " add-ro Fedora-11-i686-Live.iso\n"
13750 " mkmountpoint /cd\n"
13751 " mkmountpoint /sqsh\n"
13752 " mkmountpoint /ext3fs\n"
13753 " mount /dev/sda /cd\n"
13754 " mount-loop /cd/LiveOS/squashfs.img /sqsh\n"
13755 " mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs\n"
13760 #: ../src/guestfs-actions.pod:4535 ../fish/guestfish-actions.pod:3072
13761 msgid "The inner filesystem is now unpacked under the /ext3fs mountpoint."
13765 #: ../src/guestfs-actions.pod:4537
13767 "C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>. You "
13768 "may get unexpected errors if you try to mix these calls. It is safest to "
13769 "manually unmount filesystems and remove mountpoints after use."
13773 #: ../src/guestfs-actions.pod:4541
13775 "C<guestfs_umount_all> unmounts filesystems by sorting the paths longest "
13776 "first, so for this to work for manual mountpoints, you must ensure that the "
13777 "innermost mountpoints have the longest pathnames, as in the example code "
13782 #: ../src/guestfs-actions.pod:4546 ../fish/guestfish-actions.pod:3083
13784 "For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>"
13788 #: ../src/guestfs-actions.pod:4548
13790 "Autosync [see C<guestfs_set_autosync>, this is set by default on handles] "
13791 "can cause C<guestfs_umount_all> to be called when the handle is closed which "
13792 "can also trigger these issues."
13796 #: ../src/guestfs-actions.pod:4554 ../src/guestfs-actions.pod:4820
13797 #: ../src/guestfs-actions.pod:5739
13798 msgid "(Added in 1.0.62)"
13802 #: ../src/guestfs-actions.pod:4556
13803 msgid "guestfs_mknod"
13807 #: ../src/guestfs-actions.pod:4558
13811 " guestfs_mknod (guestfs_h *g,\n"
13815 " const char *path);\n"
13820 #: ../src/guestfs-actions.pod:4565 ../fish/guestfish-actions.pod:3093
13822 "This call creates block or character special devices, or named pipes (FIFOs)."
13826 #: ../src/guestfs-actions.pod:4568 ../fish/guestfish-actions.pod:3096
13828 "The C<mode> parameter should be the mode, using the standard constants. "
13829 "C<devmajor> and C<devminor> are the device major and minor numbers, only "
13830 "used when creating block and character special devices."
13834 #: ../src/guestfs-actions.pod:4573
13836 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
13837 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
13838 "regular file). These constants are available in the standard Linux header "
13839 "files, or you can use C<guestfs_mknod_b>, C<guestfs_mknod_c> or "
13840 "C<guestfs_mkfifo> which are wrappers around this command which bitwise OR in "
13841 "the appropriate constant for you."
13845 #: ../src/guestfs-actions.pod:4587
13846 msgid "guestfs_mknod_b"
13850 #: ../src/guestfs-actions.pod:4589
13854 " guestfs_mknod_b (guestfs_h *g,\n"
13858 " const char *path);\n"
13863 #: ../src/guestfs-actions.pod:4596
13865 "This call creates a block device node called C<path> with mode C<mode> and "
13866 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
13867 "wrapper around C<guestfs_mknod>."
13871 #: ../src/guestfs-actions.pod:4606
13872 msgid "guestfs_mknod_c"
13876 #: ../src/guestfs-actions.pod:4608
13880 " guestfs_mknod_c (guestfs_h *g,\n"
13884 " const char *path);\n"
13889 #: ../src/guestfs-actions.pod:4615
13891 "This call creates a char device node called C<path> with mode C<mode> and "
13892 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
13893 "wrapper around C<guestfs_mknod>."
13897 #: ../src/guestfs-actions.pod:4625
13898 msgid "guestfs_mkswap"
13902 #: ../src/guestfs-actions.pod:4627
13906 " guestfs_mkswap (guestfs_h *g,\n"
13907 " const char *device);\n"
13912 #: ../src/guestfs-actions.pod:4631 ../fish/guestfish-actions.pod:3135
13913 msgid "Create a swap partition on C<device>."
13917 #: ../src/guestfs-actions.pod:4637
13918 msgid "guestfs_mkswap_L"
13922 #: ../src/guestfs-actions.pod:4639
13926 " guestfs_mkswap_L (guestfs_h *g,\n"
13927 " const char *label,\n"
13928 " const char *device);\n"
13933 #: ../src/guestfs-actions.pod:4644 ../fish/guestfish-actions.pod:3141
13934 msgid "Create a swap partition on C<device> with label C<label>."
13938 #: ../src/guestfs-actions.pod:4646 ../fish/guestfish-actions.pod:3143
13940 "Note that you cannot attach a swap label to a block device (eg. C</dev/"
13941 "sda>), just to a partition. This appears to be a limitation of the kernel "
13946 #: ../src/guestfs-actions.pod:4654
13947 msgid "guestfs_mkswap_U"
13951 #: ../src/guestfs-actions.pod:4656
13955 " guestfs_mkswap_U (guestfs_h *g,\n"
13956 " const char *uuid,\n"
13957 " const char *device);\n"
13962 #: ../src/guestfs-actions.pod:4661 ../fish/guestfish-actions.pod:3151
13963 msgid "Create a swap partition on C<device> with UUID C<uuid>."
13967 #: ../src/guestfs-actions.pod:4667
13968 msgid "guestfs_mkswap_file"
13972 #: ../src/guestfs-actions.pod:4669
13976 " guestfs_mkswap_file (guestfs_h *g,\n"
13977 " const char *path);\n"
13982 #: ../src/guestfs-actions.pod:4673 ../fish/guestfish-actions.pod:3157
13983 msgid "Create a swap file."
13987 #: ../src/guestfs-actions.pod:4675
13989 "This command just writes a swap file signature to an existing file. To "
13990 "create the file itself, use something like C<guestfs_fallocate>."
13994 #: ../src/guestfs-actions.pod:4682
13995 msgid "guestfs_modprobe"
13999 #: ../src/guestfs-actions.pod:4684
14003 " guestfs_modprobe (guestfs_h *g,\n"
14004 " const char *modulename);\n"
14009 #: ../src/guestfs-actions.pod:4688 ../fish/guestfish-actions.pod:3166
14010 msgid "This loads a kernel module in the appliance."
14014 #: ../src/guestfs-actions.pod:4690 ../fish/guestfish-actions.pod:3168
14016 "The kernel module must have been whitelisted when libguestfs was built (see "
14017 "C<appliance/kmod.whitelist.in> in the source)."
14021 #: ../src/guestfs-actions.pod:4697
14022 msgid "guestfs_mount"
14026 #: ../src/guestfs-actions.pod:4699
14030 " guestfs_mount (guestfs_h *g,\n"
14031 " const char *device,\n"
14032 " const char *mountpoint);\n"
14037 #: ../src/guestfs-actions.pod:4704 ../fish/guestfish-actions.pod:3175
14039 "Mount a guest disk at a position in the filesystem. Block devices are named "
14040 "C</dev/sda>, C</dev/sdb> and so on, as they were added to the guest. If "
14041 "those block devices contain partitions, they will have the usual names (eg. "
14042 "C</dev/sda1>). Also LVM C</dev/VG/LV>-style names can be used."
14046 #: ../src/guestfs-actions.pod:4710 ../fish/guestfish-actions.pod:3181
14048 "The rules are the same as for L<mount(2)>: A filesystem must first be "
14049 "mounted on C</> before others can be mounted. Other filesystems can only be "
14050 "mounted on directories which already exist."
14054 #: ../src/guestfs-actions.pod:4715 ../fish/guestfish-actions.pod:3186
14056 "The mounted filesystem is writable, if we have sufficient permissions on the "
14057 "underlying device."
14061 #: ../src/guestfs-actions.pod:4718
14063 "B<Important note:> When you use this call, the filesystem options C<sync> "
14064 "and C<noatime> are set implicitly. This was originally done because we "
14065 "thought it would improve reliability, but it turns out that I<-o sync> has a "
14066 "very large negative performance impact and negligible effect on "
14067 "reliability. Therefore we recommend that you avoid using C<guestfs_mount> "
14068 "in any code that needs performance, and instead use C<guestfs_mount_options> "
14069 "(use an empty string for the first parameter if you don't want any options)."
14073 #: ../src/guestfs-actions.pod:4730
14075 "This function is deprecated. In new code, use the L</guestfs_mount_options> "
14080 #: ../src/guestfs-actions.pod:4739
14081 msgid "guestfs_mount_loop"
14085 #: ../src/guestfs-actions.pod:4741
14089 " guestfs_mount_loop (guestfs_h *g,\n"
14090 " const char *file,\n"
14091 " const char *mountpoint);\n"
14096 #: ../src/guestfs-actions.pod:4746 ../fish/guestfish-actions.pod:3210
14098 "This command lets you mount C<file> (a filesystem image in a file) on a "
14099 "mount point. It is entirely equivalent to the command C<mount -o loop file "
14104 #: ../src/guestfs-actions.pod:4754
14105 msgid "guestfs_mount_options"
14109 #: ../src/guestfs-actions.pod:4756
14113 " guestfs_mount_options (guestfs_h *g,\n"
14114 " const char *options,\n"
14115 " const char *device,\n"
14116 " const char *mountpoint);\n"
14121 #: ../src/guestfs-actions.pod:4762
14123 "This is the same as the C<guestfs_mount> command, but it allows you to set "
14124 "the mount options as for the L<mount(8)> I<-o> flag."
14128 #: ../src/guestfs-actions.pod:4766 ../fish/guestfish-actions.pod:3222
14130 "If the C<options> parameter is an empty string, then no options are passed "
14131 "(all options default to whatever the filesystem uses)."
14135 #: ../src/guestfs-actions.pod:4772 ../src/guestfs-actions.pod:4786
14136 #: ../src/guestfs-actions.pod:4803
14137 msgid "(Added in 1.0.10)"
14141 #: ../src/guestfs-actions.pod:4774
14142 msgid "guestfs_mount_ro"
14146 #: ../src/guestfs-actions.pod:4776
14150 " guestfs_mount_ro (guestfs_h *g,\n"
14151 " const char *device,\n"
14152 " const char *mountpoint);\n"
14157 #: ../src/guestfs-actions.pod:4781
14159 "This is the same as the C<guestfs_mount> command, but it mounts the "
14160 "filesystem with the read-only (I<-o ro>) flag."
14164 #: ../src/guestfs-actions.pod:4788
14165 msgid "guestfs_mount_vfs"
14169 #: ../src/guestfs-actions.pod:4790
14173 " guestfs_mount_vfs (guestfs_h *g,\n"
14174 " const char *options,\n"
14175 " const char *vfstype,\n"
14176 " const char *device,\n"
14177 " const char *mountpoint);\n"
14182 #: ../src/guestfs-actions.pod:4797
14184 "This is the same as the C<guestfs_mount> command, but it allows you to set "
14185 "both the mount options and the vfstype as for the L<mount(8)> I<-o> and I<-"
14190 #: ../src/guestfs-actions.pod:4805
14191 msgid "guestfs_mountpoints"
14195 #: ../src/guestfs-actions.pod:4807
14199 " guestfs_mountpoints (guestfs_h *g);\n"
14204 #: ../src/guestfs-actions.pod:4810
14206 "This call is similar to C<guestfs_mounts>. That call returns a list of "
14207 "devices. This one returns a hash table (map) of device name to directory "
14208 "where the device is mounted."
14212 #: ../src/guestfs-actions.pod:4822
14213 msgid "guestfs_mounts"
14217 #: ../src/guestfs-actions.pod:4824
14221 " guestfs_mounts (guestfs_h *g);\n"
14226 #: ../src/guestfs-actions.pod:4827 ../fish/guestfish-actions.pod:3253
14228 "This returns the list of currently mounted filesystems. It returns the list "
14229 "of devices (eg. C</dev/sda1>, C</dev/VG/LV>)."
14233 #: ../src/guestfs-actions.pod:4830 ../fish/guestfish-actions.pod:3256
14234 msgid "Some internal mounts are not shown."
14238 #: ../src/guestfs-actions.pod:4832
14239 msgid "See also: C<guestfs_mountpoints>"
14243 #: ../src/guestfs-actions.pod:4840
14248 #: ../src/guestfs-actions.pod:4842
14252 " guestfs_mv (guestfs_h *g,\n"
14253 " const char *src,\n"
14254 " const char *dest);\n"
14259 #: ../src/guestfs-actions.pod:4847 ../fish/guestfish-actions.pod:3264
14261 "This moves a file from C<src> to C<dest> where C<dest> is either a "
14262 "destination filename or destination directory."
14266 #: ../src/guestfs-actions.pod:4854
14267 msgid "guestfs_ntfs_3g_probe"
14271 #: ../src/guestfs-actions.pod:4856
14275 " guestfs_ntfs_3g_probe (guestfs_h *g,\n"
14277 " const char *device);\n"
14282 #: ../src/guestfs-actions.pod:4861 ../fish/guestfish-actions.pod:3271
14284 "This command runs the L<ntfs-3g.probe(8)> command which probes an NTFS "
14285 "C<device> for mountability. (Not all NTFS volumes can be mounted read-"
14286 "write, and some cannot be mounted at all)."
14290 #: ../src/guestfs-actions.pod:4865 ../fish/guestfish-actions.pod:3275
14292 "C<rw> is a boolean flag. Set it to true if you want to test if the volume "
14293 "can be mounted read-write. Set it to false if you want to test if the "
14294 "volume can be mounted read-only."
14298 #: ../src/guestfs-actions.pod:4869 ../fish/guestfish-actions.pod:3279
14300 "The return value is an integer which C<0> if the operation would succeed, or "
14301 "some non-zero value documented in the L<ntfs-3g.probe(8)> manual page."
14305 #: ../src/guestfs-actions.pod:4875
14306 msgid "(Added in 1.0.43)"
14310 #: ../src/guestfs-actions.pod:4877
14311 msgid "guestfs_ntfsresize"
14315 #: ../src/guestfs-actions.pod:4879
14319 " guestfs_ntfsresize (guestfs_h *g,\n"
14320 " const char *device);\n"
14325 #: ../src/guestfs-actions.pod:4883 ../fish/guestfish-actions.pod:3287
14327 "This command resizes an NTFS filesystem, expanding or shrinking it to the "
14328 "size of the underlying device."
14332 #: ../src/guestfs-actions.pod:4886 ../fish/guestfish-actions.pod:3290
14334 "I<Note:> After the resize operation, the filesystem is marked as requiring a "
14335 "consistency check (for safety). You have to boot into Windows to perform "
14336 "this check and clear this condition. Furthermore, ntfsresize refuses to "
14337 "resize filesystems which have been marked in this way. So in effect it is "
14338 "not possible to call ntfsresize multiple times on a single filesystem "
14339 "without booting into Windows between each resize."
14343 #: ../src/guestfs-actions.pod:4894 ../fish/guestfish-actions.pod:3298
14344 msgid "See also L<ntfsresize(8)>."
14348 #: ../src/guestfs-actions.pod:4900
14349 msgid "guestfs_ntfsresize_size"
14353 #: ../src/guestfs-actions.pod:4902
14357 " guestfs_ntfsresize_size (guestfs_h *g,\n"
14358 " const char *device,\n"
14359 " int64_t size);\n"
14364 #: ../src/guestfs-actions.pod:4907
14366 "This command is the same as C<guestfs_ntfsresize> except that it allows you "
14367 "to specify the new size (in bytes) explicitly."
14371 #: ../src/guestfs-actions.pod:4912 ../src/guestfs-actions.pod:5348
14372 #: ../src/guestfs-actions.pod:5421 ../src/guestfs-actions.pod:5687
14373 #: ../src/guestfs-actions.pod:7293
14374 msgid "(Added in 1.3.14)"
14378 #: ../src/guestfs-actions.pod:4914
14379 msgid "guestfs_part_add"
14383 #: ../src/guestfs-actions.pod:4916
14387 " guestfs_part_add (guestfs_h *g,\n"
14388 " const char *device,\n"
14389 " const char *prlogex,\n"
14390 " int64_t startsect,\n"
14391 " int64_t endsect);\n"
14396 #: ../src/guestfs-actions.pod:4923
14398 "This command adds a partition to C<device>. If there is no partition table "
14399 "on the device, call C<guestfs_part_init> first."
14403 #: ../src/guestfs-actions.pod:4926 ../fish/guestfish-actions.pod:3314
14405 "The C<prlogex> parameter is the type of partition. Normally you should pass "
14406 "C<p> or C<primary> here, but MBR partition tables also support C<l> (or "
14407 "C<logical>) and C<e> (or C<extended>) partition types."
14411 #: ../src/guestfs-actions.pod:4931 ../fish/guestfish-actions.pod:3319
14413 "C<startsect> and C<endsect> are the start and end of the partition in "
14414 "I<sectors>. C<endsect> may be negative, which means it counts backwards "
14415 "from the end of the disk (C<-1> is the last sector)."
14419 #: ../src/guestfs-actions.pod:4935
14421 "Creating a partition which covers the whole disk is not so easy. Use "
14422 "C<guestfs_part_disk> to do that."
14426 #: ../src/guestfs-actions.pod:4940 ../src/guestfs-actions.pod:4978
14427 #: ../src/guestfs-actions.pod:5031 ../src/guestfs-actions.pod:5109
14428 #: ../src/guestfs-actions.pod:5147 ../src/guestfs-actions.pod:5166
14429 #: ../src/guestfs-actions.pod:5206
14430 msgid "(Added in 1.0.78)"
14434 #: ../src/guestfs-actions.pod:4942
14435 msgid "guestfs_part_del"
14439 #: ../src/guestfs-actions.pod:4944
14443 " guestfs_part_del (guestfs_h *g,\n"
14444 " const char *device,\n"
14450 #: ../src/guestfs-actions.pod:4949 ../fish/guestfish-actions.pod:3330
14451 msgid "This command deletes the partition numbered C<partnum> on C<device>."
14455 #: ../src/guestfs-actions.pod:4951 ../fish/guestfish-actions.pod:3332
14457 "Note that in the case of MBR partitioning, deleting an extended partition "
14458 "also deletes any logical partitions it contains."
14462 #: ../src/guestfs-actions.pod:4959
14463 msgid "guestfs_part_disk"
14467 #: ../src/guestfs-actions.pod:4961
14471 " guestfs_part_disk (guestfs_h *g,\n"
14472 " const char *device,\n"
14473 " const char *parttype);\n"
14478 #: ../src/guestfs-actions.pod:4966
14480 "This command is simply a combination of C<guestfs_part_init> followed by "
14481 "C<guestfs_part_add> to create a single primary partition covering the whole "
14486 #: ../src/guestfs-actions.pod:4970
14488 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
14489 "possible values are described in C<guestfs_part_init>."
14493 #: ../src/guestfs-actions.pod:4980
14494 msgid "guestfs_part_get_bootable"
14498 #: ../src/guestfs-actions.pod:4982
14502 " guestfs_part_get_bootable (guestfs_h *g,\n"
14503 " const char *device,\n"
14509 #: ../src/guestfs-actions.pod:4987 ../fish/guestfish-actions.pod:3354
14511 "This command returns true if the partition C<partnum> on C<device> has the "
14512 "bootable flag set."
14516 #: ../src/guestfs-actions.pod:4990
14517 msgid "See also C<guestfs_part_set_bootable>."
14521 #: ../src/guestfs-actions.pod:4996
14522 msgid "guestfs_part_get_mbr_id"
14526 #: ../src/guestfs-actions.pod:4998
14530 " guestfs_part_get_mbr_id (guestfs_h *g,\n"
14531 " const char *device,\n"
14537 #: ../src/guestfs-actions.pod:5003 ../fish/guestfish-actions.pod:3363
14539 "Returns the MBR type byte (also known as the ID byte) from the numbered "
14540 "partition C<partnum>."
14544 #: ../src/guestfs-actions.pod:5006 ../src/guestfs-actions.pod:5182
14546 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
14547 "undefined results for other partition table types (see "
14548 "C<guestfs_part_get_parttype>)."
14552 #: ../src/guestfs-actions.pod:5014
14553 msgid "guestfs_part_get_parttype"
14557 #: ../src/guestfs-actions.pod:5016
14561 " guestfs_part_get_parttype (guestfs_h *g,\n"
14562 " const char *device);\n"
14567 #: ../src/guestfs-actions.pod:5020 ../fish/guestfish-actions.pod:3374
14569 "This command examines the partition table on C<device> and returns the "
14570 "partition table type (format) being used."
14574 #: ../src/guestfs-actions.pod:5023
14576 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
14577 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
14578 "possible, although unusual. See C<guestfs_part_init> for a full list."
14582 #: ../src/guestfs-actions.pod:5033
14583 msgid "guestfs_part_init"
14587 #: ../src/guestfs-actions.pod:5035
14591 " guestfs_part_init (guestfs_h *g,\n"
14592 " const char *device,\n"
14593 " const char *parttype);\n"
14598 #: ../src/guestfs-actions.pod:5040 ../fish/guestfish-actions.pod:3386
14600 "This creates an empty partition table on C<device> of one of the partition "
14601 "types listed below. Usually C<parttype> should be either C<msdos> or C<gpt> "
14602 "(for large disks)."
14606 #: ../src/guestfs-actions.pod:5044
14608 "Initially there are no partitions. Following this, you should call "
14609 "C<guestfs_part_add> for each partition required."
14613 #: ../src/guestfs-actions.pod:5047 ../fish/guestfish-actions.pod:3393
14614 msgid "Possible values for C<parttype> are:"
14618 #: ../src/guestfs-actions.pod:5051 ../fish/guestfish-actions.pod:3397
14619 msgid "B<efi> | B<gpt>"
14623 #: ../src/guestfs-actions.pod:5053 ../fish/guestfish-actions.pod:3399
14624 msgid "Intel EFI / GPT partition table."
14628 #: ../src/guestfs-actions.pod:5055 ../fish/guestfish-actions.pod:3401
14630 "This is recommended for >= 2 TB partitions that will be accessed from Linux "
14631 "and Intel-based Mac OS X. It also has limited backwards compatibility with "
14632 "the C<mbr> format."
14636 #: ../src/guestfs-actions.pod:5059 ../fish/guestfish-actions.pod:3405
14637 msgid "B<mbr> | B<msdos>"
14641 #: ../src/guestfs-actions.pod:5061 ../fish/guestfish-actions.pod:3407
14643 "The standard PC \"Master Boot Record\" (MBR) format used by MS-DOS and "
14644 "Windows. This partition type will B<only> work for device sizes up to 2 "
14645 "TB. For large disks we recommend using C<gpt>."
14649 #: ../src/guestfs-actions.pod:5068 ../fish/guestfish-actions.pod:3414
14651 "Other partition table types that may work but are not supported include:"
14655 #: ../src/guestfs-actions.pod:5073 ../fish/guestfish-actions.pod:3419
14660 #: ../src/guestfs-actions.pod:5075 ../fish/guestfish-actions.pod:3421
14661 msgid "AIX disk labels."
14665 #: ../src/guestfs-actions.pod:5077 ../fish/guestfish-actions.pod:3423
14666 msgid "B<amiga> | B<rdb>"
14670 #: ../src/guestfs-actions.pod:5079 ../fish/guestfish-actions.pod:3425
14671 msgid "Amiga \"Rigid Disk Block\" format."
14675 #: ../src/guestfs-actions.pod:5081 ../fish/guestfish-actions.pod:3427
14680 #: ../src/guestfs-actions.pod:5083 ../fish/guestfish-actions.pod:3429
14681 msgid "BSD disk labels."
14685 #: ../src/guestfs-actions.pod:5085 ../fish/guestfish-actions.pod:3431
14690 #: ../src/guestfs-actions.pod:5087 ../fish/guestfish-actions.pod:3433
14691 msgid "DASD, used on IBM mainframes."
14695 #: ../src/guestfs-actions.pod:5089 ../fish/guestfish-actions.pod:3435
14700 #: ../src/guestfs-actions.pod:5091 ../fish/guestfish-actions.pod:3437
14701 msgid "MIPS/SGI volumes."
14705 #: ../src/guestfs-actions.pod:5093 ../fish/guestfish-actions.pod:3439
14710 #: ../src/guestfs-actions.pod:5095 ../fish/guestfish-actions.pod:3441
14711 msgid "Old Mac partition format. Modern Macs use C<gpt>."
14715 #: ../src/guestfs-actions.pod:5097 ../fish/guestfish-actions.pod:3443
14720 #: ../src/guestfs-actions.pod:5099 ../fish/guestfish-actions.pod:3445
14721 msgid "NEC PC-98 format, common in Japan apparently."
14725 #: ../src/guestfs-actions.pod:5101 ../fish/guestfish-actions.pod:3447
14730 #: ../src/guestfs-actions.pod:5103 ../fish/guestfish-actions.pod:3449
14731 msgid "Sun disk labels."
14735 #: ../src/guestfs-actions.pod:5111
14736 msgid "guestfs_part_list"
14740 #: ../src/guestfs-actions.pod:5113
14743 " struct guestfs_partition_list *\n"
14744 " guestfs_part_list (guestfs_h *g,\n"
14745 " const char *device);\n"
14750 #: ../src/guestfs-actions.pod:5117 ../fish/guestfish-actions.pod:3457
14752 "This command parses the partition table on C<device> and returns the list of "
14753 "partitions found."
14757 #: ../src/guestfs-actions.pod:5120 ../fish/guestfish-actions.pod:3460
14758 msgid "The fields in the returned structure are:"
14762 #: ../src/guestfs-actions.pod:5124 ../fish/guestfish-actions.pod:3464
14763 msgid "B<part_num>"
14767 #: ../src/guestfs-actions.pod:5126 ../fish/guestfish-actions.pod:3466
14768 msgid "Partition number, counting from 1."
14772 #: ../src/guestfs-actions.pod:5128 ../fish/guestfish-actions.pod:3468
14773 msgid "B<part_start>"
14777 #: ../src/guestfs-actions.pod:5130
14779 "Start of the partition I<in bytes>. To get sectors you have to divide by "
14780 "the device's sector size, see C<guestfs_blockdev_getss>."
14784 #: ../src/guestfs-actions.pod:5133 ../fish/guestfish-actions.pod:3473
14785 msgid "B<part_end>"
14789 #: ../src/guestfs-actions.pod:5135 ../fish/guestfish-actions.pod:3475
14790 msgid "End of the partition in bytes."
14794 #: ../src/guestfs-actions.pod:5137 ../fish/guestfish-actions.pod:3477
14795 msgid "B<part_size>"
14799 #: ../src/guestfs-actions.pod:5139 ../fish/guestfish-actions.pod:3479
14800 msgid "Size of the partition in bytes."
14804 #: ../src/guestfs-actions.pod:5143
14806 "This function returns a C<struct guestfs_partition_list *>, or NULL if there "
14807 "was an error. I<The caller must call C<guestfs_free_partition_list> after "
14812 #: ../src/guestfs-actions.pod:5149
14813 msgid "guestfs_part_set_bootable"
14817 #: ../src/guestfs-actions.pod:5151
14821 " guestfs_part_set_bootable (guestfs_h *g,\n"
14822 " const char *device,\n"
14824 " int bootable);\n"
14829 #: ../src/guestfs-actions.pod:5157 ../fish/guestfish-actions.pod:3487
14831 "This sets the bootable flag on partition numbered C<partnum> on device "
14832 "C<device>. Note that partitions are numbered from 1."
14836 #: ../src/guestfs-actions.pod:5160 ../fish/guestfish-actions.pod:3490
14838 "The bootable flag is used by some operating systems (notably Windows) to "
14839 "determine which partition to boot from. It is by no means universally "
14844 #: ../src/guestfs-actions.pod:5168
14845 msgid "guestfs_part_set_mbr_id"
14849 #: ../src/guestfs-actions.pod:5170
14853 " guestfs_part_set_mbr_id (guestfs_h *g,\n"
14854 " const char *device,\n"
14861 #: ../src/guestfs-actions.pod:5176 ../fish/guestfish-actions.pod:3498
14863 "Sets the MBR type byte (also known as the ID byte) of the numbered partition "
14864 "C<partnum> to C<idbyte>. Note that the type bytes quoted in most "
14865 "documentation are in fact hexadecimal numbers, but usually documented "
14866 "without any leading \"0x\" which might be confusing."
14870 #: ../src/guestfs-actions.pod:5190
14871 msgid "guestfs_part_set_name"
14875 #: ../src/guestfs-actions.pod:5192
14879 " guestfs_part_set_name (guestfs_h *g,\n"
14880 " const char *device,\n"
14882 " const char *name);\n"
14887 #: ../src/guestfs-actions.pod:5198 ../fish/guestfish-actions.pod:3512
14889 "This sets the partition name on partition numbered C<partnum> on device "
14890 "C<device>. Note that partitions are numbered from 1."
14894 #: ../src/guestfs-actions.pod:5201 ../fish/guestfish-actions.pod:3515
14896 "The partition name can only be set on certain types of partition table. "
14897 "This works on C<gpt> but not on C<mbr> partitions."
14901 #: ../src/guestfs-actions.pod:5208
14902 msgid "guestfs_part_to_dev"
14906 #: ../src/guestfs-actions.pod:5210
14910 " guestfs_part_to_dev (guestfs_h *g,\n"
14911 " const char *partition);\n"
14916 #: ../src/guestfs-actions.pod:5214 ../fish/guestfish-actions.pod:3522
14918 "This function takes a partition name (eg. \"/dev/sdb1\") and removes the "
14919 "partition number, returning the device name (eg. \"/dev/sdb\")."
14923 #: ../src/guestfs-actions.pod:5218
14925 "The named partition must exist, for example as a string returned from "
14926 "C<guestfs_list_partitions>."
14930 #: ../src/guestfs-actions.pod:5226
14931 msgid "guestfs_ping_daemon"
14935 #: ../src/guestfs-actions.pod:5228
14939 " guestfs_ping_daemon (guestfs_h *g);\n"
14944 #: ../src/guestfs-actions.pod:5231 ../fish/guestfish-actions.pod:3533
14946 "This is a test probe into the guestfs daemon running inside the qemu "
14947 "subprocess. Calling this function checks that the daemon responds to the "
14948 "ping message, without affecting the daemon or attached block device(s) in "
14953 #: ../src/guestfs-actions.pod:5240
14954 msgid "guestfs_pread"
14958 #: ../src/guestfs-actions.pod:5242
14962 " guestfs_pread (guestfs_h *g,\n"
14963 " const char *path,\n"
14965 " int64_t offset,\n"
14966 " size_t *size_r);\n"
14971 #: ../src/guestfs-actions.pod:5249 ../fish/guestfish-actions.pod:3542
14973 "This command lets you read part of a file. It reads C<count> bytes of the "
14974 "file, starting at C<offset>, from file C<path>."
14978 #: ../src/guestfs-actions.pod:5252 ../src/guestfs-actions.pod:5278
14979 #: ../fish/guestfish-actions.pod:3545 ../fish/guestfish-actions.pod:3560
14981 "This may read fewer bytes than requested. For further details see the "
14982 "L<pread(2)> system call."
14986 #: ../src/guestfs-actions.pod:5255
14987 msgid "See also C<guestfs_pwrite>, C<guestfs_pread_device>."
14991 #: ../src/guestfs-actions.pod:5266
14992 msgid "guestfs_pread_device"
14996 #: ../src/guestfs-actions.pod:5268
15000 " guestfs_pread_device (guestfs_h *g,\n"
15001 " const char *device,\n"
15003 " int64_t offset,\n"
15004 " size_t *size_r);\n"
15009 #: ../src/guestfs-actions.pod:5275 ../fish/guestfish-actions.pod:3557
15011 "This command lets you read part of a file. It reads C<count> bytes of "
15012 "C<device>, starting at C<offset>."
15016 #: ../src/guestfs-actions.pod:5281
15017 msgid "See also C<guestfs_pread>."
15021 #: ../src/guestfs-actions.pod:5290
15022 msgid "(Added in 1.5.21)"
15026 #: ../src/guestfs-actions.pod:5292
15027 msgid "guestfs_pvcreate"
15031 #: ../src/guestfs-actions.pod:5294
15035 " guestfs_pvcreate (guestfs_h *g,\n"
15036 " const char *device);\n"
15041 #: ../src/guestfs-actions.pod:5298 ../fish/guestfish-actions.pod:3572
15043 "This creates an LVM physical volume on the named C<device>, where C<device> "
15044 "should usually be a partition name such as C</dev/sda1>."
15048 #: ../src/guestfs-actions.pod:5306
15049 msgid "guestfs_pvremove"
15053 #: ../src/guestfs-actions.pod:5308
15057 " guestfs_pvremove (guestfs_h *g,\n"
15058 " const char *device);\n"
15063 #: ../src/guestfs-actions.pod:5312 ../fish/guestfish-actions.pod:3580
15065 "This wipes a physical volume C<device> so that LVM will no longer recognise "
15070 #: ../src/guestfs-actions.pod:5315 ../fish/guestfish-actions.pod:3583
15072 "The implementation uses the C<pvremove> command which refuses to wipe "
15073 "physical volumes that contain any volume groups, so you have to remove those "
15078 #: ../src/guestfs-actions.pod:5323
15079 msgid "guestfs_pvresize"
15083 #: ../src/guestfs-actions.pod:5325
15087 " guestfs_pvresize (guestfs_h *g,\n"
15088 " const char *device);\n"
15093 #: ../src/guestfs-actions.pod:5329 ../fish/guestfish-actions.pod:3591
15095 "This resizes (expands or shrinks) an existing LVM physical volume to match "
15096 "the new size of the underlying device."
15100 #: ../src/guestfs-actions.pod:5336
15101 msgid "guestfs_pvresize_size"
15105 #: ../src/guestfs-actions.pod:5338
15109 " guestfs_pvresize_size (guestfs_h *g,\n"
15110 " const char *device,\n"
15111 " int64_t size);\n"
15116 #: ../src/guestfs-actions.pod:5343
15118 "This command is the same as C<guestfs_pvresize> except that it allows you to "
15119 "specify the new size (in bytes) explicitly."
15123 #: ../src/guestfs-actions.pod:5350
15124 msgid "guestfs_pvs"
15128 #: ../src/guestfs-actions.pod:5352
15132 " guestfs_pvs (guestfs_h *g);\n"
15137 #: ../src/guestfs-actions.pod:5355 ../fish/guestfish-actions.pod:3605
15139 "List all the physical volumes detected. This is the equivalent of the L<pvs"
15144 #: ../src/guestfs-actions.pod:5358 ../fish/guestfish-actions.pod:3608
15146 "This returns a list of just the device names that contain PVs (eg. C</dev/"
15151 #: ../src/guestfs-actions.pod:5361
15152 msgid "See also C<guestfs_pvs_full>."
15156 #: ../src/guestfs-actions.pod:5369
15157 msgid "guestfs_pvs_full"
15161 #: ../src/guestfs-actions.pod:5371
15164 " struct guestfs_lvm_pv_list *\n"
15165 " guestfs_pvs_full (guestfs_h *g);\n"
15170 #: ../src/guestfs-actions.pod:5374 ../fish/guestfish-actions.pod:3617
15172 "List all the physical volumes detected. This is the equivalent of the L<pvs"
15173 "(8)> command. The \"full\" version includes all fields."
15177 #: ../src/guestfs-actions.pod:5377
15179 "This function returns a C<struct guestfs_lvm_pv_list *>, or NULL if there "
15180 "was an error. I<The caller must call C<guestfs_free_lvm_pv_list> after use>."
15184 #: ../src/guestfs-actions.pod:5383
15185 msgid "guestfs_pvuuid"
15189 #: ../src/guestfs-actions.pod:5385
15193 " guestfs_pvuuid (guestfs_h *g,\n"
15194 " const char *device);\n"
15199 #: ../src/guestfs-actions.pod:5389 ../fish/guestfish-actions.pod:3624
15200 msgid "This command returns the UUID of the LVM PV C<device>."
15204 #: ../src/guestfs-actions.pod:5396
15205 msgid "guestfs_pwrite"
15209 #: ../src/guestfs-actions.pod:5398
15213 " guestfs_pwrite (guestfs_h *g,\n"
15214 " const char *path,\n"
15215 " const char *content,\n"
15216 " size_t content_size,\n"
15217 " int64_t offset);\n"
15222 #: ../src/guestfs-actions.pod:5405 ../fish/guestfish-actions.pod:3630
15224 "This command writes to part of a file. It writes the data buffer C<content> "
15225 "to the file C<path> starting at offset C<offset>."
15229 #: ../src/guestfs-actions.pod:5408 ../fish/guestfish-actions.pod:3633
15231 "This command implements the L<pwrite(2)> system call, and like that system "
15232 "call it may not write the full data requested. The return value is the "
15233 "number of bytes that were actually written to the file. This could even be "
15234 "0, although short writes are unlikely for regular files in ordinary "
15239 #: ../src/guestfs-actions.pod:5414
15240 msgid "See also C<guestfs_pread>, C<guestfs_pwrite_device>."
15244 #: ../src/guestfs-actions.pod:5423
15245 msgid "guestfs_pwrite_device"
15249 #: ../src/guestfs-actions.pod:5425
15253 " guestfs_pwrite_device (guestfs_h *g,\n"
15254 " const char *device,\n"
15255 " const char *content,\n"
15256 " size_t content_size,\n"
15257 " int64_t offset);\n"
15262 #: ../src/guestfs-actions.pod:5432 ../fish/guestfish-actions.pod:3648
15264 "This command writes to part of a device. It writes the data buffer "
15265 "C<content> to C<device> starting at offset C<offset>."
15269 #: ../src/guestfs-actions.pod:5435 ../fish/guestfish-actions.pod:3651
15271 "This command implements the L<pwrite(2)> system call, and like that system "
15272 "call it may not write the full data requested (although short writes to disk "
15273 "devices and partitions are probably impossible with standard Linux kernels)."
15277 #: ../src/guestfs-actions.pod:5440
15278 msgid "See also C<guestfs_pwrite>."
15282 #: ../src/guestfs-actions.pod:5447
15283 msgid "(Added in 1.5.20)"
15287 #: ../src/guestfs-actions.pod:5449
15288 msgid "guestfs_read_file"
15292 #: ../src/guestfs-actions.pod:5451
15296 " guestfs_read_file (guestfs_h *g,\n"
15297 " const char *path,\n"
15298 " size_t *size_r);\n"
15303 #: ../src/guestfs-actions.pod:5456 ../fish/guestfish-actions.pod:3665
15304 msgid "This calls returns the contents of the file C<path> as a buffer."
15308 #: ../src/guestfs-actions.pod:5459
15310 "Unlike C<guestfs_cat>, this function can correctly handle files that contain "
15311 "embedded ASCII NUL characters. However unlike C<guestfs_download>, this "
15312 "function is limited in the total size of file that can be handled."
15316 #: ../src/guestfs-actions.pod:5471
15317 msgid "(Added in 1.0.63)"
15321 #: ../src/guestfs-actions.pod:5473
15322 msgid "guestfs_read_lines"
15326 #: ../src/guestfs-actions.pod:5475
15330 " guestfs_read_lines (guestfs_h *g,\n"
15331 " const char *path);\n"
15336 #: ../src/guestfs-actions.pod:5481 ../fish/guestfish-actions.pod:3682
15338 "The file contents are returned as a list of lines. Trailing C<LF> and "
15339 "C<CRLF> character sequences are I<not> returned."
15343 #: ../src/guestfs-actions.pod:5484
15345 "Note that this function cannot correctly handle binary files (specifically, "
15346 "files containing C<\\0> character which is treated as end of line). For "
15347 "those you need to use the C<guestfs_read_file> function which has a more "
15348 "complex interface."
15352 #: ../src/guestfs-actions.pod:5495
15353 msgid "guestfs_readdir"
15357 #: ../src/guestfs-actions.pod:5497
15360 " struct guestfs_dirent_list *\n"
15361 " guestfs_readdir (guestfs_h *g,\n"
15362 " const char *dir);\n"
15367 #: ../src/guestfs-actions.pod:5501 ../fish/guestfish-actions.pod:3694
15368 msgid "This returns the list of directory entries in directory C<dir>."
15372 #: ../src/guestfs-actions.pod:5503 ../fish/guestfish-actions.pod:3696
15374 "All entries in the directory are returned, including C<.> and C<..>. The "
15375 "entries are I<not> sorted, but returned in the same order as the underlying "
15380 #: ../src/guestfs-actions.pod:5507 ../fish/guestfish-actions.pod:3700
15382 "Also this call returns basic file type information about each file. The "
15383 "C<ftyp> field will contain one of the following characters:"
15387 #: ../src/guestfs-actions.pod:5512 ../fish/guestfish-actions.pod:3705
15392 #: ../src/guestfs-actions.pod:5514 ../fish/guestfish-actions.pod:3707
15393 msgid "Block special"
15397 #: ../src/guestfs-actions.pod:5516 ../fish/guestfish-actions.pod:3709
15402 #: ../src/guestfs-actions.pod:5518 ../fish/guestfish-actions.pod:3711
15403 msgid "Char special"
15407 #: ../src/guestfs-actions.pod:5520 ../fish/guestfish-actions.pod:3713
15412 #: ../src/guestfs-actions.pod:5522 ../fish/guestfish-actions.pod:3715
15417 #: ../src/guestfs-actions.pod:5524 ../fish/guestfish-actions.pod:3717
15422 #: ../src/guestfs-actions.pod:5526 ../fish/guestfish-actions.pod:3719
15423 msgid "FIFO (named pipe)"
15427 #: ../src/guestfs-actions.pod:5528 ../fish/guestfish-actions.pod:3721
15432 #: ../src/guestfs-actions.pod:5530 ../fish/guestfish-actions.pod:3723
15433 msgid "Symbolic link"
15437 #: ../src/guestfs-actions.pod:5532 ../fish/guestfish-actions.pod:3725
15442 #: ../src/guestfs-actions.pod:5534 ../fish/guestfish-actions.pod:3727
15443 msgid "Regular file"
15447 #: ../src/guestfs-actions.pod:5536 ../fish/guestfish-actions.pod:3729
15452 #: ../src/guestfs-actions.pod:5538 ../fish/guestfish-actions.pod:3731
15457 #: ../src/guestfs-actions.pod:5540 ../fish/guestfish-actions.pod:3733
15462 #: ../src/guestfs-actions.pod:5542 ../fish/guestfish-actions.pod:3735
15463 msgid "Unknown file type"
15467 #: ../src/guestfs-actions.pod:5544 ../fish/guestfish-actions.pod:3737
15472 #: ../src/guestfs-actions.pod:5546 ../fish/guestfish-actions.pod:3739
15474 "The L<readdir(3)> call returned a C<d_type> field with an unexpected value"
15478 #: ../src/guestfs-actions.pod:5551
15480 "This function is primarily intended for use by programs. To get a simple "
15481 "list of names, use C<guestfs_ls>. To get a printable directory for human "
15482 "consumption, use C<guestfs_ll>."
15486 #: ../src/guestfs-actions.pod:5555
15488 "This function returns a C<struct guestfs_dirent_list *>, or NULL if there "
15489 "was an error. I<The caller must call C<guestfs_free_dirent_list> after use>."
15493 #: ../src/guestfs-actions.pod:5561
15494 msgid "guestfs_readlink"
15498 #: ../src/guestfs-actions.pod:5563
15502 " guestfs_readlink (guestfs_h *g,\n"
15503 " const char *path);\n"
15508 #: ../src/guestfs-actions.pod:5567 ../fish/guestfish-actions.pod:3752
15509 msgid "This command reads the target of a symbolic link."
15513 #: ../src/guestfs-actions.pod:5574
15514 msgid "guestfs_readlinklist"
15518 #: ../src/guestfs-actions.pod:5576
15522 " guestfs_readlinklist (guestfs_h *g,\n"
15523 " const char *path,\n"
15524 " char *const *names);\n"
15529 #: ../src/guestfs-actions.pod:5581 ../fish/guestfish-actions.pod:3758
15531 "This call allows you to do a C<readlink> operation on multiple files, where "
15532 "all files are in the directory C<path>. C<names> is the list of files from "
15537 #: ../src/guestfs-actions.pod:5585 ../fish/guestfish-actions.pod:3762
15539 "On return you get a list of strings, with a one-to-one correspondence to the "
15540 "C<names> list. Each string is the value of the symbolic link."
15544 #: ../src/guestfs-actions.pod:5589 ../fish/guestfish-actions.pod:3766
15546 "If the C<readlink(2)> operation fails on any name, then the corresponding "
15547 "result string is the empty string C<\"\">. However the whole operation is "
15548 "completed even if there were C<readlink(2)> errors, and so you can call this "
15549 "function with names where you don't know if they are symbolic links already "
15550 "(albeit slightly less efficient)."
15554 #: ../src/guestfs-actions.pod:5596 ../fish/guestfish-actions.pod:3773
15556 "This call is intended for programs that want to efficiently list a directory "
15557 "contents without making many round-trips. Very long directory listings "
15558 "might cause the protocol message size to be exceeded, causing this call to "
15559 "fail. The caller must split up such requests into smaller groups of names."
15563 #: ../src/guestfs-actions.pod:5609
15564 msgid "guestfs_realpath"
15568 #: ../src/guestfs-actions.pod:5611
15572 " guestfs_realpath (guestfs_h *g,\n"
15573 " const char *path);\n"
15578 #: ../src/guestfs-actions.pod:5615 ../fish/guestfish-actions.pod:3784
15580 "Return the canonicalized absolute pathname of C<path>. The returned path "
15581 "has no C<.>, C<..> or symbolic link path elements."
15585 #: ../src/guestfs-actions.pod:5623
15586 msgid "guestfs_removexattr"
15590 #: ../src/guestfs-actions.pod:5625
15594 " guestfs_removexattr (guestfs_h *g,\n"
15595 " const char *xattr,\n"
15596 " const char *path);\n"
15601 #: ../src/guestfs-actions.pod:5630 ../fish/guestfish-actions.pod:3791
15603 "This call removes the extended attribute named C<xattr> of the file C<path>."
15607 #: ../src/guestfs-actions.pod:5633
15608 msgid "See also: C<guestfs_lremovexattr>, L<attr(5)>."
15612 #: ../src/guestfs-actions.pod:5639
15613 msgid "guestfs_resize2fs"
15617 #: ../src/guestfs-actions.pod:5641
15621 " guestfs_resize2fs (guestfs_h *g,\n"
15622 " const char *device);\n"
15627 #: ../src/guestfs-actions.pod:5645 ../fish/guestfish-actions.pod:3800
15629 "This resizes an ext2, ext3 or ext4 filesystem to match the size of the "
15630 "underlying device."
15634 #: ../src/guestfs-actions.pod:5648
15636 "I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f> on the "
15637 "C<device> before calling this command. For unknown reasons C<resize2fs> "
15638 "sometimes gives an error about this and sometimes not. In any case, it is "
15639 "always safe to call C<guestfs_e2fsck_f> before calling this function."
15643 #: ../src/guestfs-actions.pod:5658
15644 msgid "guestfs_resize2fs_M"
15648 #: ../src/guestfs-actions.pod:5660
15652 " guestfs_resize2fs_M (guestfs_h *g,\n"
15653 " const char *device);\n"
15658 #: ../src/guestfs-actions.pod:5664
15660 "This command is the same as C<guestfs_resize2fs>, but the filesystem is "
15661 "resized to its minimum size. This works like the I<-M> option to the "
15662 "C<resize2fs> command."
15666 #: ../src/guestfs-actions.pod:5668
15668 "To get the resulting size of the filesystem you should call "
15669 "C<guestfs_tune2fs_l> and read the C<Block size> and C<Block count> values. "
15670 "These two numbers, multiplied together, give the resulting size of the "
15671 "minimal filesystem in bytes."
15675 #: ../src/guestfs-actions.pod:5675
15676 msgid "guestfs_resize2fs_size"
15680 #: ../src/guestfs-actions.pod:5677
15684 " guestfs_resize2fs_size (guestfs_h *g,\n"
15685 " const char *device,\n"
15686 " int64_t size);\n"
15691 #: ../src/guestfs-actions.pod:5682
15693 "This command is the same as C<guestfs_resize2fs> except that it allows you "
15694 "to specify the new size (in bytes) explicitly."
15698 #: ../src/guestfs-actions.pod:5689
15703 #: ../src/guestfs-actions.pod:5691
15707 " guestfs_rm (guestfs_h *g,\n"
15708 " const char *path);\n"
15713 #: ../src/guestfs-actions.pod:5695 ../fish/guestfish-actions.pod:3833
15714 msgid "Remove the single file C<path>."
15718 #: ../src/guestfs-actions.pod:5701
15719 msgid "guestfs_rm_rf"
15723 #: ../src/guestfs-actions.pod:5703
15727 " guestfs_rm_rf (guestfs_h *g,\n"
15728 " const char *path);\n"
15733 #: ../src/guestfs-actions.pod:5707 ../fish/guestfish-actions.pod:3839
15735 "Remove the file or directory C<path>, recursively removing the contents if "
15736 "its a directory. This is like the C<rm -rf> shell command."
15740 #: ../src/guestfs-actions.pod:5715
15741 msgid "guestfs_rmdir"
15745 #: ../src/guestfs-actions.pod:5717
15749 " guestfs_rmdir (guestfs_h *g,\n"
15750 " const char *path);\n"
15755 #: ../src/guestfs-actions.pod:5721 ../fish/guestfish-actions.pod:3847
15756 msgid "Remove the single directory C<path>."
15760 #: ../src/guestfs-actions.pod:5727
15761 msgid "guestfs_rmmountpoint"
15765 #: ../src/guestfs-actions.pod:5729
15769 " guestfs_rmmountpoint (guestfs_h *g,\n"
15770 " const char *exemptpath);\n"
15775 #: ../src/guestfs-actions.pod:5733
15777 "This calls removes a mountpoint that was previously created with "
15778 "C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint> for full details."
15782 #: ../src/guestfs-actions.pod:5741
15783 msgid "guestfs_scrub_device"
15787 #: ../src/guestfs-actions.pod:5743
15791 " guestfs_scrub_device (guestfs_h *g,\n"
15792 " const char *device);\n"
15797 #: ../src/guestfs-actions.pod:5747 ../fish/guestfish-actions.pod:3861
15799 "This command writes patterns over C<device> to make data retrieval more "
15804 #: ../src/guestfs-actions.pod:5750 ../src/guestfs-actions.pod:5771
15805 #: ../src/guestfs-actions.pod:5790 ../fish/guestfish-actions.pod:3864
15806 #: ../fish/guestfish-actions.pod:3879 ../fish/guestfish-actions.pod:3892
15808 "It is an interface to the L<scrub(1)> program. See that manual page for "
15813 #: ../src/guestfs-actions.pod:5758 ../src/guestfs-actions.pod:5776
15814 #: ../src/guestfs-actions.pod:5795
15815 msgid "(Added in 1.0.52)"
15819 #: ../src/guestfs-actions.pod:5760
15820 msgid "guestfs_scrub_file"
15824 #: ../src/guestfs-actions.pod:5762
15828 " guestfs_scrub_file (guestfs_h *g,\n"
15829 " const char *file);\n"
15834 #: ../src/guestfs-actions.pod:5766 ../fish/guestfish-actions.pod:3874
15836 "This command writes patterns over a file to make data retrieval more "
15841 #: ../src/guestfs-actions.pod:5769 ../fish/guestfish-actions.pod:3877
15842 msgid "The file is I<removed> after scrubbing."
15846 #: ../src/guestfs-actions.pod:5778
15847 msgid "guestfs_scrub_freespace"
15851 #: ../src/guestfs-actions.pod:5780
15855 " guestfs_scrub_freespace (guestfs_h *g,\n"
15856 " const char *dir);\n"
15861 #: ../src/guestfs-actions.pod:5784
15863 "This command creates the directory C<dir> and then fills it with files until "
15864 "the filesystem is full, and scrubs the files as for C<guestfs_scrub_file>, "
15865 "and deletes them. The intention is to scrub any free space on the partition "
15866 "containing C<dir>."
15870 #: ../src/guestfs-actions.pod:5797
15871 msgid "guestfs_set_append"
15875 #: ../src/guestfs-actions.pod:5799
15879 " guestfs_set_append (guestfs_h *g,\n"
15880 " const char *append);\n"
15885 #: ../src/guestfs-actions.pod:5803 ../fish/guestfish-actions.pod:3901
15887 "This function is used to add additional options to the guest kernel command "
15892 #: ../src/guestfs-actions.pod:5806 ../fish/guestfish-actions.pod:3904
15894 "The default is C<NULL> unless overridden by setting C<LIBGUESTFS_APPEND> "
15895 "environment variable."
15899 #: ../src/guestfs-actions.pod:5809 ../fish/guestfish-actions.pod:3907
15901 "Setting C<append> to C<NULL> means I<no> additional options are passed "
15902 "(libguestfs always adds a few of its own)."
15906 #: ../src/guestfs-actions.pod:5816
15907 msgid "guestfs_set_attach_method"
15911 #: ../src/guestfs-actions.pod:5818
15915 " guestfs_set_attach_method (guestfs_h *g,\n"
15916 " const char *attachmethod);\n"
15921 #: ../src/guestfs-actions.pod:5822 ../fish/guestfish-actions.pod:3916
15923 "Set the method that libguestfs uses to connect to the back end guestfsd "
15924 "daemon. Possible methods are:"
15928 #: ../src/guestfs-actions.pod:5829 ../fish/guestfish-actions.pod:3923
15930 "Launch an appliance and connect to it. This is the ordinary method and the "
15935 #: ../src/guestfs-actions.pod:5832 ../fish/guestfish-actions.pod:3926
15936 msgid "C<unix:I<path>>"
15940 #: ../src/guestfs-actions.pod:5834 ../fish/guestfish-actions.pod:3928
15941 msgid "Connect to the Unix domain socket I<path>."
15945 #: ../src/guestfs-actions.pod:5836 ../fish/guestfish-actions.pod:3930
15947 "This method lets you connect to an existing daemon or (using virtio-serial) "
15948 "to a live guest. For more information, see L<guestfs(3)/ATTACHING TO "
15949 "RUNNING DAEMONS>."
15953 #: ../src/guestfs-actions.pod:5844
15954 msgid "guestfs_set_autosync"
15958 #: ../src/guestfs-actions.pod:5846
15962 " guestfs_set_autosync (guestfs_h *g,\n"
15963 " int autosync);\n"
15968 #: ../src/guestfs-actions.pod:5850 ../fish/guestfish-actions.pod:3942
15970 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
15971 "effort attempt to make filesystems consistent and synchronized when the "
15972 "handle is closed (also if the program exits without closing handles)."
15976 #: ../src/guestfs-actions.pod:5855 ../fish/guestfish-actions.pod:3947
15978 "This is enabled by default (since libguestfs 1.5.24, previously it was "
15979 "disabled by default)."
15983 #: ../src/guestfs-actions.pod:5862
15984 msgid "guestfs_set_direct"
15988 #: ../src/guestfs-actions.pod:5864
15992 " guestfs_set_direct (guestfs_h *g,\n"
15998 #: ../src/guestfs-actions.pod:5868 ../fish/guestfish-actions.pod:3956
16000 "If the direct appliance mode flag is enabled, then stdin and stdout are "
16001 "passed directly through to the appliance once it is launched."
16005 #: ../src/guestfs-actions.pod:5872
16007 "One consequence of this is that log messages aren't caught by the library "
16008 "and handled by C<guestfs_set_log_message_callback>, but go straight to "
16013 #: ../src/guestfs-actions.pod:5876 ../fish/guestfish-actions.pod:3964
16014 msgid "You probably don't want to use this unless you know what you are doing."
16018 #: ../src/guestfs-actions.pod:5879 ../fish/guestfish-actions.pod:3967
16019 msgid "The default is disabled."
16023 #: ../src/guestfs-actions.pod:5885
16024 msgid "guestfs_set_e2label"
16028 #: ../src/guestfs-actions.pod:5887
16032 " guestfs_set_e2label (guestfs_h *g,\n"
16033 " const char *device,\n"
16034 " const char *label);\n"
16039 #: ../src/guestfs-actions.pod:5892 ../fish/guestfish-actions.pod:3973
16041 "This sets the ext2/3/4 filesystem label of the filesystem on C<device> to "
16042 "C<label>. Filesystem labels are limited to 16 characters."
16046 #: ../src/guestfs-actions.pod:5896
16048 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label> to return "
16049 "the existing label on a filesystem."
16053 #: ../src/guestfs-actions.pod:5903
16054 msgid "guestfs_set_e2uuid"
16058 #: ../src/guestfs-actions.pod:5905
16062 " guestfs_set_e2uuid (guestfs_h *g,\n"
16063 " const char *device,\n"
16064 " const char *uuid);\n"
16069 #: ../src/guestfs-actions.pod:5910 ../fish/guestfish-actions.pod:3984
16071 "This sets the ext2/3/4 filesystem UUID of the filesystem on C<device> to "
16072 "C<uuid>. The format of the UUID and alternatives such as C<clear>, "
16073 "C<random> and C<time> are described in the L<tune2fs(8)> manpage."
16077 #: ../src/guestfs-actions.pod:5915
16079 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid> to return "
16080 "the existing UUID of a filesystem."
16084 #: ../src/guestfs-actions.pod:5922
16085 msgid "guestfs_set_memsize"
16089 #: ../src/guestfs-actions.pod:5924
16093 " guestfs_set_memsize (guestfs_h *g,\n"
16099 #: ../src/guestfs-actions.pod:5928
16101 "This sets the memory size in megabytes allocated to the qemu subprocess. "
16102 "This only has any effect if called before C<guestfs_launch>."
16106 #: ../src/guestfs-actions.pod:5932 ../fish/guestfish-actions.pod:4002
16108 "You can also change this by setting the environment variable "
16109 "C<LIBGUESTFS_MEMSIZE> before the handle is created."
16113 #: ../src/guestfs-actions.pod:5943
16114 msgid "guestfs_set_network"
16118 #: ../src/guestfs-actions.pod:5945
16122 " guestfs_set_network (guestfs_h *g,\n"
16128 #: ../src/guestfs-actions.pod:5949 ../fish/guestfish-actions.pod:4015
16130 "If C<network> is true, then the network is enabled in the libguestfs "
16131 "appliance. The default is false."
16135 #: ../src/guestfs-actions.pod:5952 ../fish/guestfish-actions.pod:4018
16137 "This affects whether commands are able to access the network (see L<guestfs"
16138 "(3)/RUNNING COMMANDS>)."
16142 #: ../src/guestfs-actions.pod:5955
16144 "You must call this before calling C<guestfs_launch>, otherwise it has no "
16149 #: ../src/guestfs-actions.pod:5962
16150 msgid "guestfs_set_path"
16154 #: ../src/guestfs-actions.pod:5964
16158 " guestfs_set_path (guestfs_h *g,\n"
16159 " const char *searchpath);\n"
16164 #: ../src/guestfs-actions.pod:5968 ../fish/guestfish-actions.pod:4030
16165 msgid "Set the path that libguestfs searches for kernel and initrd.img."
16169 #: ../src/guestfs-actions.pod:5970 ../fish/guestfish-actions.pod:4032
16171 "The default is C<$libdir/guestfs> unless overridden by setting "
16172 "C<LIBGUESTFS_PATH> environment variable."
16176 #: ../src/guestfs-actions.pod:5973 ../fish/guestfish-actions.pod:4035
16177 msgid "Setting C<path> to C<NULL> restores the default path."
16181 #: ../src/guestfs-actions.pod:5979
16182 msgid "guestfs_set_qemu"
16186 #: ../src/guestfs-actions.pod:5981
16190 " guestfs_set_qemu (guestfs_h *g,\n"
16191 " const char *qemu);\n"
16196 #: ../src/guestfs-actions.pod:5985 ../fish/guestfish-actions.pod:4043
16197 msgid "Set the qemu binary that we will use."
16201 #: ../src/guestfs-actions.pod:5987 ../fish/guestfish-actions.pod:4045
16203 "The default is chosen when the library was compiled by the configure script."
16207 #: ../src/guestfs-actions.pod:5990 ../fish/guestfish-actions.pod:4048
16209 "You can also override this by setting the C<LIBGUESTFS_QEMU> environment "
16214 #: ../src/guestfs-actions.pod:5993 ../fish/guestfish-actions.pod:4051
16215 msgid "Setting C<qemu> to C<NULL> restores the default qemu binary."
16219 #: ../src/guestfs-actions.pod:5995 ../fish/guestfish-actions.pod:4053
16221 "Note that you should call this function as early as possible after creating "
16222 "the handle. This is because some pre-launch operations depend on testing "
16223 "qemu features (by running C<qemu -help>). If the qemu binary changes, we "
16224 "don't retest features, and so you might see inconsistent results. Using the "
16225 "environment variable C<LIBGUESTFS_QEMU> is safest of all since that picks "
16226 "the qemu binary at the same time as the handle is created."
16230 #: ../src/guestfs-actions.pod:6007
16231 msgid "guestfs_set_recovery_proc"
16235 #: ../src/guestfs-actions.pod:6009
16239 " guestfs_set_recovery_proc (guestfs_h *g,\n"
16240 " int recoveryproc);\n"
16245 #: ../src/guestfs-actions.pod:6013
16247 "If this is called with the parameter C<false> then C<guestfs_launch> does "
16248 "not create a recovery process. The purpose of the recovery process is to "
16249 "stop runaway qemu processes in the case where the main program aborts "
16254 #: ../src/guestfs-actions.pod:6018
16256 "This only has any effect if called before C<guestfs_launch>, and the default "
16261 #: ../src/guestfs-actions.pod:6021 ../fish/guestfish-actions.pod:4075
16263 "About the only time when you would want to disable this is if the main "
16264 "process will fork itself into the background (\"daemonize\" itself). In "
16265 "this case the recovery process thinks that the main program has disappeared "
16266 "and so kills qemu, which is not very helpful."
16270 #: ../src/guestfs-actions.pod:6031
16271 msgid "guestfs_set_selinux"
16275 #: ../src/guestfs-actions.pod:6033
16279 " guestfs_set_selinux (guestfs_h *g,\n"
16285 #: ../src/guestfs-actions.pod:6037 ../fish/guestfish-actions.pod:4087
16287 "This sets the selinux flag that is passed to the appliance at boot time. "
16288 "The default is C<selinux=0> (disabled)."
16292 #: ../src/guestfs-actions.pod:6040 ../fish/guestfish-actions.pod:4090
16294 "Note that if SELinux is enabled, it is always in Permissive mode "
16295 "(C<enforcing=0>)."
16299 #: ../src/guestfs-actions.pod:6050
16300 msgid "guestfs_set_trace"
16304 #: ../src/guestfs-actions.pod:6052
16308 " guestfs_set_trace (guestfs_h *g,\n"
16314 #: ../src/guestfs-actions.pod:6056 ../fish/guestfish-actions.pod:4102
16316 "If the command trace flag is set to 1, then libguestfs calls, parameters and "
16317 "return values are traced."
16321 #: ../src/guestfs-actions.pod:6059 ../fish/guestfish-actions.pod:4105
16323 "If you want to trace C API calls into libguestfs (and other libraries) then "
16324 "possibly a better way is to use the external ltrace(1) command."
16328 #: ../src/guestfs-actions.pod:6063 ../fish/guestfish-actions.pod:4109
16330 "Command traces are disabled unless the environment variable "
16331 "C<LIBGUESTFS_TRACE> is defined and set to C<1>."
16335 #: ../src/guestfs-actions.pod:6066
16337 "Trace messages are normally sent to C<stderr>, unless you register a "
16338 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
16342 #: ../src/guestfs-actions.pod:6074
16343 msgid "guestfs_set_verbose"
16347 #: ../src/guestfs-actions.pod:6076
16351 " guestfs_set_verbose (guestfs_h *g,\n"
16357 #: ../src/guestfs-actions.pod:6080 ../fish/guestfish-actions.pod:4122
16358 msgid "If C<verbose> is true, this turns on verbose messages."
16362 #: ../src/guestfs-actions.pod:6082 ../fish/guestfish-actions.pod:4124
16364 "Verbose messages are disabled unless the environment variable "
16365 "C<LIBGUESTFS_DEBUG> is defined and set to C<1>."
16369 #: ../src/guestfs-actions.pod:6085
16371 "Verbose messages are normally sent to C<stderr>, unless you register a "
16372 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
16376 #: ../src/guestfs-actions.pod:6093
16377 msgid "guestfs_setcon"
16381 #: ../src/guestfs-actions.pod:6095
16385 " guestfs_setcon (guestfs_h *g,\n"
16386 " const char *context);\n"
16391 #: ../src/guestfs-actions.pod:6099 ../fish/guestfish-actions.pod:4135
16393 "This sets the SELinux security context of the daemon to the string "
16398 #: ../src/guestfs-actions.pod:6102 ../fish/guestfish-actions.pod:4138
16399 msgid "See the documentation about SELINUX in L<guestfs(3)>."
16403 #: ../src/guestfs-actions.pod:6108
16404 msgid "guestfs_setxattr"
16408 #: ../src/guestfs-actions.pod:6110
16412 " guestfs_setxattr (guestfs_h *g,\n"
16413 " const char *xattr,\n"
16414 " const char *val,\n"
16416 " const char *path);\n"
16421 #: ../src/guestfs-actions.pod:6117 ../fish/guestfish-actions.pod:4144
16423 "This call sets the extended attribute named C<xattr> of the file C<path> to "
16424 "the value C<val> (of length C<vallen>). The value is arbitrary 8 bit data."
16428 #: ../src/guestfs-actions.pod:6121
16429 msgid "See also: C<guestfs_lsetxattr>, L<attr(5)>."
16433 #: ../src/guestfs-actions.pod:6127
16434 msgid "guestfs_sfdisk"
16438 #: ../src/guestfs-actions.pod:6129
16442 " guestfs_sfdisk (guestfs_h *g,\n"
16443 " const char *device,\n"
16447 " char *const *lines);\n"
16452 #: ../src/guestfs-actions.pod:6137 ../fish/guestfish-actions.pod:4154
16454 "This is a direct interface to the L<sfdisk(8)> program for creating "
16455 "partitions on block devices."
16459 #: ../src/guestfs-actions.pod:6140 ../fish/guestfish-actions.pod:4157
16460 msgid "C<device> should be a block device, for example C</dev/sda>."
16464 #: ../src/guestfs-actions.pod:6142 ../fish/guestfish-actions.pod:4159
16466 "C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads and "
16467 "sectors on the device, which are passed directly to sfdisk as the I<-C>, I<-"
16468 "H> and I<-S> parameters. If you pass C<0> for any of these, then the "
16469 "corresponding parameter is omitted. Usually for 'large' disks, you can just "
16470 "pass C<0> for these, but for small (floppy-sized) disks, sfdisk (or rather, "
16471 "the kernel) cannot work out the right geometry and you will need to tell it."
16475 #: ../src/guestfs-actions.pod:6150 ../fish/guestfish-actions.pod:4167
16477 "C<lines> is a list of lines that we feed to C<sfdisk>. For more information "
16478 "refer to the L<sfdisk(8)> manpage."
16482 #: ../src/guestfs-actions.pod:6153 ../fish/guestfish-actions.pod:4170
16484 "To create a single partition occupying the whole disk, you would pass "
16485 "C<lines> as a single element list, when the single element being the string "
16490 #: ../src/guestfs-actions.pod:6157
16492 "See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>, C<guestfs_part_init>"
16496 #: ../src/guestfs-actions.pod:6165 ../src/guestfs-actions.pod:6195
16497 #: ../src/guestfs-actions.pod:6228
16499 "This function is deprecated. In new code, use the L</guestfs_part_add> call "
16504 #: ../src/guestfs-actions.pod:6174
16505 msgid "guestfs_sfdiskM"
16509 #: ../src/guestfs-actions.pod:6176
16513 " guestfs_sfdiskM (guestfs_h *g,\n"
16514 " const char *device,\n"
16515 " char *const *lines);\n"
16520 #: ../src/guestfs-actions.pod:6181
16522 "This is a simplified interface to the C<guestfs_sfdisk> command, where "
16523 "partition sizes are specified in megabytes only (rounded to the nearest "
16524 "cylinder) and you don't need to specify the cyls, heads and sectors "
16525 "parameters which were rarely if ever used anyway."
16529 #: ../src/guestfs-actions.pod:6187
16531 "See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage and "
16532 "C<guestfs_part_disk>"
16536 #: ../src/guestfs-actions.pod:6204
16537 msgid "guestfs_sfdisk_N"
16541 #: ../src/guestfs-actions.pod:6206
16545 " guestfs_sfdisk_N (guestfs_h *g,\n"
16546 " const char *device,\n"
16551 " const char *line);\n"
16556 #: ../src/guestfs-actions.pod:6215 ../fish/guestfish-actions.pod:4214
16558 "This runs L<sfdisk(8)> option to modify just the single partition C<n> "
16559 "(note: C<n> counts from 1)."
16563 #: ../src/guestfs-actions.pod:6218
16565 "For other parameters, see C<guestfs_sfdisk>. You should usually pass C<0> "
16566 "for the cyls/heads/sectors parameters."
16570 #: ../src/guestfs-actions.pod:6221
16571 msgid "See also: C<guestfs_part_add>"
16575 #: ../src/guestfs-actions.pod:6237
16576 msgid "guestfs_sfdisk_disk_geometry"
16580 #: ../src/guestfs-actions.pod:6239
16584 " guestfs_sfdisk_disk_geometry (guestfs_h *g,\n"
16585 " const char *device);\n"
16590 #: ../src/guestfs-actions.pod:6243
16592 "This displays the disk geometry of C<device> read from the partition table. "
16593 "Especially in the case where the underlying block device has been resized, "
16594 "this can be different from the kernel's idea of the geometry (see "
16595 "C<guestfs_sfdisk_kernel_geometry>)."
16599 #: ../src/guestfs-actions.pod:6248 ../src/guestfs-actions.pod:6264
16600 #: ../fish/guestfish-actions.pod:4241 ../fish/guestfish-actions.pod:4250
16601 msgid "The result is in human-readable format, and not designed to be parsed."
16605 #: ../src/guestfs-actions.pod:6256
16606 msgid "guestfs_sfdisk_kernel_geometry"
16610 #: ../src/guestfs-actions.pod:6258
16614 " guestfs_sfdisk_kernel_geometry (guestfs_h *g,\n"
16615 " const char *device);\n"
16620 #: ../src/guestfs-actions.pod:6262 ../fish/guestfish-actions.pod:4248
16621 msgid "This displays the kernel's idea of the geometry of C<device>."
16625 #: ../src/guestfs-actions.pod:6272
16626 msgid "guestfs_sfdisk_l"
16630 #: ../src/guestfs-actions.pod:6274
16634 " guestfs_sfdisk_l (guestfs_h *g,\n"
16635 " const char *device);\n"
16640 #: ../src/guestfs-actions.pod:6278 ../fish/guestfish-actions.pod:4257
16642 "This displays the partition table on C<device>, in the human-readable output "
16643 "of the L<sfdisk(8)> command. It is not intended to be parsed."
16647 #: ../src/guestfs-actions.pod:6282
16648 msgid "See also: C<guestfs_part_list>"
16652 #: ../src/guestfs-actions.pod:6287
16654 "This function is deprecated. In new code, use the L</guestfs_part_list> "
16659 #: ../src/guestfs-actions.pod:6296
16664 #: ../src/guestfs-actions.pod:6298
16668 " guestfs_sh (guestfs_h *g,\n"
16669 " const char *command);\n"
16674 #: ../src/guestfs-actions.pod:6302 ../fish/guestfish-actions.pod:4274
16676 "This call runs a command from the guest filesystem via the guest's C</bin/"
16681 #: ../src/guestfs-actions.pod:6305
16682 msgid "This is like C<guestfs_command>, but passes the command to:"
16686 #: ../src/guestfs-actions.pod:6307 ../fish/guestfish-actions.pod:4279
16689 " /bin/sh -c \"command\"\n"
16694 #: ../src/guestfs-actions.pod:6309 ../fish/guestfish-actions.pod:4281
16696 "Depending on the guest's shell, this usually results in wildcards being "
16697 "expanded, shell expressions being interpolated and so on."
16701 #: ../src/guestfs-actions.pod:6313
16702 msgid "All the provisos about C<guestfs_command> apply to this call."
16706 #: ../src/guestfs-actions.pod:6320
16707 msgid "guestfs_sh_lines"
16711 #: ../src/guestfs-actions.pod:6322
16715 " guestfs_sh_lines (guestfs_h *g,\n"
16716 " const char *command);\n"
16721 #: ../src/guestfs-actions.pod:6326
16723 "This is the same as C<guestfs_sh>, but splits the result into a list of "
16728 #: ../src/guestfs-actions.pod:6329
16729 msgid "See also: C<guestfs_command_lines>"
16733 #: ../src/guestfs-actions.pod:6337
16734 msgid "guestfs_sleep"
16738 #: ../src/guestfs-actions.pod:6339
16742 " guestfs_sleep (guestfs_h *g,\n"
16748 #: ../src/guestfs-actions.pod:6343 ../fish/guestfish-actions.pod:4300
16749 msgid "Sleep for C<secs> seconds."
16753 #: ../src/guestfs-actions.pod:6347
16754 msgid "(Added in 1.0.41)"
16758 #: ../src/guestfs-actions.pod:6349 ../src/guestfs-structs.pod:109
16759 msgid "guestfs_stat"
16763 #: ../src/guestfs-actions.pod:6351
16766 " struct guestfs_stat *\n"
16767 " guestfs_stat (guestfs_h *g,\n"
16768 " const char *path);\n"
16773 #: ../src/guestfs-actions.pod:6357 ../fish/guestfish-actions.pod:4308
16774 msgid "This is the same as the C<stat(2)> system call."
16778 #: ../src/guestfs-actions.pod:6365 ../src/guestfs-structs.pod:135
16779 msgid "guestfs_statvfs"
16783 #: ../src/guestfs-actions.pod:6367
16786 " struct guestfs_statvfs *\n"
16787 " guestfs_statvfs (guestfs_h *g,\n"
16788 " const char *path);\n"
16793 #: ../src/guestfs-actions.pod:6371 ../fish/guestfish-actions.pod:4314
16795 "Returns file system statistics for any mounted file system. C<path> should "
16796 "be a file or directory in the mounted file system (typically it is the mount "
16797 "point itself, but it doesn't need to be)."
16801 #: ../src/guestfs-actions.pod:6375 ../fish/guestfish-actions.pod:4318
16802 msgid "This is the same as the C<statvfs(2)> system call."
16806 #: ../src/guestfs-actions.pod:6377
16808 "This function returns a C<struct guestfs_statvfs *>, or NULL if there was an "
16809 "error. I<The caller must call C<guestfs_free_statvfs> after use>."
16813 #: ../src/guestfs-actions.pod:6383
16814 msgid "guestfs_strings"
16818 #: ../src/guestfs-actions.pod:6385
16822 " guestfs_strings (guestfs_h *g,\n"
16823 " const char *path);\n"
16828 #: ../src/guestfs-actions.pod:6389 ../fish/guestfish-actions.pod:4324
16830 "This runs the L<strings(1)> command on a file and returns the list of "
16831 "printable strings found."
16835 #: ../src/guestfs-actions.pod:6401
16836 msgid "guestfs_strings_e"
16840 #: ../src/guestfs-actions.pod:6403
16844 " guestfs_strings_e (guestfs_h *g,\n"
16845 " const char *encoding,\n"
16846 " const char *path);\n"
16851 #: ../src/guestfs-actions.pod:6408
16853 "This is like the C<guestfs_strings> command, but allows you to specify the "
16854 "encoding of strings that are looked for in the source file C<path>."
16858 #: ../src/guestfs-actions.pod:6412 ../fish/guestfish-actions.pod:4338
16859 msgid "Allowed encodings are:"
16863 #: ../src/guestfs-actions.pod:6416 ../fish/guestfish-actions.pod:4342
16868 #: ../src/guestfs-actions.pod:6418
16870 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
16871 "ISO-8859-X (this is what C<guestfs_strings> uses)."
16875 #: ../src/guestfs-actions.pod:6421 ../fish/guestfish-actions.pod:4347
16880 #: ../src/guestfs-actions.pod:6423 ../fish/guestfish-actions.pod:4349
16881 msgid "Single 8-bit-byte characters."
16885 #: ../src/guestfs-actions.pod:6425 ../fish/guestfish-actions.pod:4351
16890 #: ../src/guestfs-actions.pod:6427 ../fish/guestfish-actions.pod:4353
16891 msgid "16-bit big endian strings such as those encoded in UTF-16BE or UCS-2BE."
16895 #: ../src/guestfs-actions.pod:6430 ../fish/guestfish-actions.pod:4356
16896 msgid "l (lower case letter L)"
16900 #: ../src/guestfs-actions.pod:6432 ../fish/guestfish-actions.pod:4358
16902 "16-bit little endian such as UTF-16LE and UCS-2LE. This is useful for "
16903 "examining binaries in Windows guests."
16907 #: ../src/guestfs-actions.pod:6435 ../fish/guestfish-actions.pod:4361
16912 #: ../src/guestfs-actions.pod:6437 ../fish/guestfish-actions.pod:4363
16913 msgid "32-bit big endian such as UCS-4BE."
16917 #: ../src/guestfs-actions.pod:6439 ../fish/guestfish-actions.pod:4365
16922 #: ../src/guestfs-actions.pod:6441 ../fish/guestfish-actions.pod:4367
16923 msgid "32-bit little endian such as UCS-4LE."
16927 #: ../src/guestfs-actions.pod:6445 ../fish/guestfish-actions.pod:4371
16928 msgid "The returned strings are transcoded to UTF-8."
16932 #: ../src/guestfs-actions.pod:6456
16933 msgid "guestfs_swapoff_device"
16937 #: ../src/guestfs-actions.pod:6458
16941 " guestfs_swapoff_device (guestfs_h *g,\n"
16942 " const char *device);\n"
16947 #: ../src/guestfs-actions.pod:6462
16949 "This command disables the libguestfs appliance swap device or partition "
16950 "named C<device>. See C<guestfs_swapon_device>."
16954 #: ../src/guestfs-actions.pod:6470
16955 msgid "guestfs_swapoff_file"
16959 #: ../src/guestfs-actions.pod:6472
16963 " guestfs_swapoff_file (guestfs_h *g,\n"
16964 " const char *file);\n"
16969 #: ../src/guestfs-actions.pod:6476 ../fish/guestfish-actions.pod:4388
16970 msgid "This command disables the libguestfs appliance swap on file."
16974 #: ../src/guestfs-actions.pod:6482
16975 msgid "guestfs_swapoff_label"
16979 #: ../src/guestfs-actions.pod:6484
16983 " guestfs_swapoff_label (guestfs_h *g,\n"
16984 " const char *label);\n"
16989 #: ../src/guestfs-actions.pod:6488 ../fish/guestfish-actions.pod:4394
16991 "This command disables the libguestfs appliance swap on labeled swap "
16996 #: ../src/guestfs-actions.pod:6495
16997 msgid "guestfs_swapoff_uuid"
17001 #: ../src/guestfs-actions.pod:6497
17005 " guestfs_swapoff_uuid (guestfs_h *g,\n"
17006 " const char *uuid);\n"
17011 #: ../src/guestfs-actions.pod:6501 ../fish/guestfish-actions.pod:4401
17013 "This command disables the libguestfs appliance swap partition with the given "
17018 #: ../src/guestfs-actions.pod:6508
17019 msgid "guestfs_swapon_device"
17023 #: ../src/guestfs-actions.pod:6510
17027 " guestfs_swapon_device (guestfs_h *g,\n"
17028 " const char *device);\n"
17033 #: ../src/guestfs-actions.pod:6514
17035 "This command enables the libguestfs appliance to use the swap device or "
17036 "partition named C<device>. The increased memory is made available for all "
17037 "commands, for example those run using C<guestfs_command> or C<guestfs_sh>."
17041 #: ../src/guestfs-actions.pod:6519 ../fish/guestfish-actions.pod:4413
17043 "Note that you should not swap to existing guest swap partitions unless you "
17044 "know what you are doing. They may contain hibernation information, or other "
17045 "information that the guest doesn't want you to trash. You also risk leaking "
17046 "information about the host to the guest this way. Instead, attach a new "
17047 "host device to the guest and swap on that."
17051 #: ../src/guestfs-actions.pod:6530
17052 msgid "guestfs_swapon_file"
17056 #: ../src/guestfs-actions.pod:6532
17060 " guestfs_swapon_file (guestfs_h *g,\n"
17061 " const char *file);\n"
17066 #: ../src/guestfs-actions.pod:6536
17068 "This command enables swap to a file. See C<guestfs_swapon_device> for other "
17073 #: ../src/guestfs-actions.pod:6543
17074 msgid "guestfs_swapon_label"
17078 #: ../src/guestfs-actions.pod:6545
17082 " guestfs_swapon_label (guestfs_h *g,\n"
17083 " const char *label);\n"
17088 #: ../src/guestfs-actions.pod:6549
17090 "This command enables swap to a labeled swap partition. See "
17091 "C<guestfs_swapon_device> for other notes."
17095 #: ../src/guestfs-actions.pod:6556
17096 msgid "guestfs_swapon_uuid"
17100 #: ../src/guestfs-actions.pod:6558
17104 " guestfs_swapon_uuid (guestfs_h *g,\n"
17105 " const char *uuid);\n"
17110 #: ../src/guestfs-actions.pod:6562
17112 "This command enables swap to a swap partition with the given UUID. See "
17113 "C<guestfs_swapon_device> for other notes."
17117 #: ../src/guestfs-actions.pod:6569
17118 msgid "guestfs_sync"
17122 #: ../src/guestfs-actions.pod:6571
17126 " guestfs_sync (guestfs_h *g);\n"
17131 #: ../src/guestfs-actions.pod:6574 ../fish/guestfish-actions.pod:4445
17133 "This syncs the disk, so that any writes are flushed through to the "
17134 "underlying disk image."
17138 #: ../src/guestfs-actions.pod:6577 ../fish/guestfish-actions.pod:4448
17140 "You should always call this if you have modified a disk image, before "
17141 "closing the handle."
17145 #: ../src/guestfs-actions.pod:6584
17146 msgid "guestfs_tail"
17150 #: ../src/guestfs-actions.pod:6586
17154 " guestfs_tail (guestfs_h *g,\n"
17155 " const char *path);\n"
17160 #: ../src/guestfs-actions.pod:6590 ../fish/guestfish-actions.pod:4455
17162 "This command returns up to the last 10 lines of a file as a list of strings."
17166 #: ../src/guestfs-actions.pod:6602
17167 msgid "guestfs_tail_n"
17171 #: ../src/guestfs-actions.pod:6604
17175 " guestfs_tail_n (guestfs_h *g,\n"
17177 " const char *path);\n"
17182 #: ../src/guestfs-actions.pod:6609 ../fish/guestfish-actions.pod:4465
17184 "If the parameter C<nrlines> is a positive number, this returns the last "
17185 "C<nrlines> lines of the file C<path>."
17189 #: ../src/guestfs-actions.pod:6612 ../fish/guestfish-actions.pod:4468
17191 "If the parameter C<nrlines> is a negative number, this returns lines from "
17192 "the file C<path>, starting with the C<-nrlines>th line."
17196 #: ../src/guestfs-actions.pod:6626
17197 msgid "guestfs_tar_in"
17201 #: ../src/guestfs-actions.pod:6628
17205 " guestfs_tar_in (guestfs_h *g,\n"
17206 " const char *tarfile,\n"
17207 " const char *directory);\n"
17212 #: ../src/guestfs-actions.pod:6633 ../fish/guestfish-actions.pod:4480
17214 "This command uploads and unpacks local file C<tarfile> (an I<uncompressed> "
17215 "tar file) into C<directory>."
17219 #: ../src/guestfs-actions.pod:6636
17221 "To upload a compressed tarball, use C<guestfs_tgz_in> or C<guestfs_txz_in>."
17225 #: ../src/guestfs-actions.pod:6641 ../src/guestfs-actions.pod:6658
17226 #: ../src/guestfs-actions.pod:6674 ../src/guestfs-actions.pod:6690
17227 msgid "(Added in 1.0.3)"
17231 #: ../src/guestfs-actions.pod:6643
17232 msgid "guestfs_tar_out"
17236 #: ../src/guestfs-actions.pod:6645
17240 " guestfs_tar_out (guestfs_h *g,\n"
17241 " const char *directory,\n"
17242 " const char *tarfile);\n"
17247 #: ../src/guestfs-actions.pod:6650 ../fish/guestfish-actions.pod:4492
17249 "This command packs the contents of C<directory> and downloads it to local "
17254 #: ../src/guestfs-actions.pod:6653
17256 "To download a compressed tarball, use C<guestfs_tgz_out> or "
17257 "C<guestfs_txz_out>."
17261 #: ../src/guestfs-actions.pod:6660
17262 msgid "guestfs_tgz_in"
17266 #: ../src/guestfs-actions.pod:6662
17270 " guestfs_tgz_in (guestfs_h *g,\n"
17271 " const char *tarball,\n"
17272 " const char *directory);\n"
17277 #: ../src/guestfs-actions.pod:6667 ../fish/guestfish-actions.pod:4504
17279 "This command uploads and unpacks local file C<tarball> (a I<gzip compressed> "
17280 "tar file) into C<directory>."
17284 #: ../src/guestfs-actions.pod:6670
17285 msgid "To upload an uncompressed tarball, use C<guestfs_tar_in>."
17289 #: ../src/guestfs-actions.pod:6676
17290 msgid "guestfs_tgz_out"
17294 #: ../src/guestfs-actions.pod:6678
17298 " guestfs_tgz_out (guestfs_h *g,\n"
17299 " const char *directory,\n"
17300 " const char *tarball);\n"
17305 #: ../src/guestfs-actions.pod:6683 ../fish/guestfish-actions.pod:4515
17307 "This command packs the contents of C<directory> and downloads it to local "
17312 #: ../src/guestfs-actions.pod:6686
17313 msgid "To download an uncompressed tarball, use C<guestfs_tar_out>."
17317 #: ../src/guestfs-actions.pod:6692
17318 msgid "guestfs_touch"
17322 #: ../src/guestfs-actions.pod:6694
17326 " guestfs_touch (guestfs_h *g,\n"
17327 " const char *path);\n"
17332 #: ../src/guestfs-actions.pod:6698 ../fish/guestfish-actions.pod:4526
17334 "Touch acts like the L<touch(1)> command. It can be used to update the "
17335 "timestamps on a file, or, if the file does not exist, to create a new zero-"
17340 #: ../src/guestfs-actions.pod:6702 ../fish/guestfish-actions.pod:4530
17342 "This command only works on regular files, and will fail on other file types "
17343 "such as directories, symbolic links, block special etc."
17347 #: ../src/guestfs-actions.pod:6709
17348 msgid "guestfs_truncate"
17352 #: ../src/guestfs-actions.pod:6711
17356 " guestfs_truncate (guestfs_h *g,\n"
17357 " const char *path);\n"
17362 #: ../src/guestfs-actions.pod:6715 ../fish/guestfish-actions.pod:4537
17364 "This command truncates C<path> to a zero-length file. The file must exist "
17369 #: ../src/guestfs-actions.pod:6722
17370 msgid "guestfs_truncate_size"
17374 #: ../src/guestfs-actions.pod:6724
17378 " guestfs_truncate_size (guestfs_h *g,\n"
17379 " const char *path,\n"
17380 " int64_t size);\n"
17385 #: ../src/guestfs-actions.pod:6729 ../fish/guestfish-actions.pod:4544
17387 "This command truncates C<path> to size C<size> bytes. The file must exist "
17392 #: ../src/guestfs-actions.pod:6732
17394 "If the current file size is less than C<size> then the file is extended to "
17395 "the required size with zero bytes. This creates a sparse file (ie. disk "
17396 "blocks are not allocated for the file until you write to it). To create a "
17397 "non-sparse file of zeroes, use C<guestfs_fallocate64> instead."
17401 #: ../src/guestfs-actions.pod:6742
17402 msgid "guestfs_tune2fs_l"
17406 #: ../src/guestfs-actions.pod:6744
17410 " guestfs_tune2fs_l (guestfs_h *g,\n"
17411 " const char *device);\n"
17416 #: ../src/guestfs-actions.pod:6748 ../fish/guestfish-actions.pod:4557
17418 "This returns the contents of the ext2, ext3 or ext4 filesystem superblock on "
17423 #: ../src/guestfs-actions.pod:6751 ../fish/guestfish-actions.pod:4560
17425 "It is the same as running C<tune2fs -l device>. See L<tune2fs(8)> manpage "
17426 "for more details. The list of fields returned isn't clearly defined, and "
17427 "depends on both the version of C<tune2fs> that libguestfs was built against, "
17428 "and the filesystem itself."
17432 #: ../src/guestfs-actions.pod:6764
17433 msgid "guestfs_txz_in"
17437 #: ../src/guestfs-actions.pod:6766
17441 " guestfs_txz_in (guestfs_h *g,\n"
17442 " const char *tarball,\n"
17443 " const char *directory);\n"
17448 #: ../src/guestfs-actions.pod:6771 ../fish/guestfish-actions.pod:4569
17450 "This command uploads and unpacks local file C<tarball> (an I<xz compressed> "
17451 "tar file) into C<directory>."
17455 #: ../src/guestfs-actions.pod:6778
17456 msgid "guestfs_txz_out"
17460 #: ../src/guestfs-actions.pod:6780
17464 " guestfs_txz_out (guestfs_h *g,\n"
17465 " const char *directory,\n"
17466 " const char *tarball);\n"
17471 #: ../src/guestfs-actions.pod:6785 ../fish/guestfish-actions.pod:4578
17473 "This command packs the contents of C<directory> and downloads it to local "
17474 "file C<tarball> (as an xz compressed tar archive)."
17478 #: ../src/guestfs-actions.pod:6792
17479 msgid "guestfs_umask"
17483 #: ../src/guestfs-actions.pod:6794
17487 " guestfs_umask (guestfs_h *g,\n"
17493 #: ../src/guestfs-actions.pod:6798 ../fish/guestfish-actions.pod:4587
17495 "This function sets the mask used for creating new files and device nodes to "
17500 #: ../src/guestfs-actions.pod:6801 ../fish/guestfish-actions.pod:4590
17502 "Typical umask values would be C<022> which creates new files with "
17503 "permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and C<002> which creates "
17504 "new files with permissions like \"-rw-rw-r--\" or \"-rwxrwxr-x\"."
17508 #: ../src/guestfs-actions.pod:6806 ../fish/guestfish-actions.pod:4595
17510 "The default umask is C<022>. This is important because it means that "
17511 "directories and device nodes will be created with C<0644> or C<0755> mode "
17512 "even if you specify C<0777>."
17516 #: ../src/guestfs-actions.pod:6810
17518 "See also C<guestfs_get_umask>, L<umask(2)>, C<guestfs_mknod>, "
17519 "C<guestfs_mkdir>."
17523 #: ../src/guestfs-actions.pod:6813 ../fish/guestfish-actions.pod:4602
17524 msgid "This call returns the previous umask."
17528 #: ../src/guestfs-actions.pod:6819
17529 msgid "guestfs_umount"
17533 #: ../src/guestfs-actions.pod:6821
17537 " guestfs_umount (guestfs_h *g,\n"
17538 " const char *pathordevice);\n"
17543 #: ../src/guestfs-actions.pod:6825 ../fish/guestfish-actions.pod:4610
17545 "This unmounts the given filesystem. The filesystem may be specified either "
17546 "by its mountpoint (path) or the device which contains the filesystem."
17550 #: ../src/guestfs-actions.pod:6833
17551 msgid "guestfs_umount_all"
17555 #: ../src/guestfs-actions.pod:6835
17559 " guestfs_umount_all (guestfs_h *g);\n"
17564 #: ../src/guestfs-actions.pod:6838 ../fish/guestfish-actions.pod:4620
17565 msgid "This unmounts all mounted filesystems."
17569 #: ../src/guestfs-actions.pod:6840 ../fish/guestfish-actions.pod:4622
17570 msgid "Some internal mounts are not unmounted by this call."
17574 #: ../src/guestfs-actions.pod:6846
17575 msgid "guestfs_upload"
17579 #: ../src/guestfs-actions.pod:6848
17583 " guestfs_upload (guestfs_h *g,\n"
17584 " const char *filename,\n"
17585 " const char *remotefilename);\n"
17590 #: ../src/guestfs-actions.pod:6853 ../src/guestfs-actions.pod:6877
17591 #: ../fish/guestfish-actions.pod:4628 ../fish/guestfish-actions.pod:4641
17592 msgid "Upload local file C<filename> to C<remotefilename> on the filesystem."
17596 #: ../src/guestfs-actions.pod:6858
17597 msgid "See also C<guestfs_download>."
17601 #: ../src/guestfs-actions.pod:6869
17602 msgid "guestfs_upload_offset"
17606 #: ../src/guestfs-actions.pod:6871
17610 " guestfs_upload_offset (guestfs_h *g,\n"
17611 " const char *filename,\n"
17612 " const char *remotefilename,\n"
17613 " int64_t offset);\n"
17618 #: ../src/guestfs-actions.pod:6880 ../fish/guestfish-actions.pod:4644
17620 "C<remotefilename> is overwritten starting at the byte C<offset> specified. "
17621 "The intention is to overwrite parts of existing files or devices, although "
17622 "if a non-existant file is specified then it is created with a \"hole\" "
17623 "before C<offset>. The size of the data written is implicit in the size of "
17624 "the source C<filename>."
17628 #: ../src/guestfs-actions.pod:6887
17630 "Note that there is no limit on the amount of data that can be uploaded with "
17631 "this call, unlike with C<guestfs_pwrite>, and this call always writes the "
17632 "full amount unless an error occurs."
17636 #: ../src/guestfs-actions.pod:6892
17637 msgid "See also C<guestfs_upload>, C<guestfs_pwrite>."
17641 #: ../src/guestfs-actions.pod:6903
17642 msgid "guestfs_utimens"
17646 #: ../src/guestfs-actions.pod:6905
17650 " guestfs_utimens (guestfs_h *g,\n"
17651 " const char *path,\n"
17652 " int64_t atsecs,\n"
17653 " int64_t atnsecs,\n"
17654 " int64_t mtsecs,\n"
17655 " int64_t mtnsecs);\n"
17660 #: ../src/guestfs-actions.pod:6913 ../fish/guestfish-actions.pod:4664
17661 msgid "This command sets the timestamps of a file with nanosecond precision."
17665 #: ../src/guestfs-actions.pod:6916 ../fish/guestfish-actions.pod:4667
17667 "C<atsecs, atnsecs> are the last access time (atime) in secs and nanoseconds "
17672 #: ../src/guestfs-actions.pod:6919 ../fish/guestfish-actions.pod:4670
17674 "C<mtsecs, mtnsecs> are the last modification time (mtime) in secs and "
17675 "nanoseconds from the epoch."
17679 #: ../src/guestfs-actions.pod:6922 ../fish/guestfish-actions.pod:4673
17681 "If the C<*nsecs> field contains the special value C<-1> then the "
17682 "corresponding timestamp is set to the current time. (The C<*secs> field is "
17683 "ignored in this case)."
17687 #: ../src/guestfs-actions.pod:6926 ../fish/guestfish-actions.pod:4677
17689 "If the C<*nsecs> field contains the special value C<-2> then the "
17690 "corresponding timestamp is left unchanged. (The C<*secs> field is ignored "
17695 #: ../src/guestfs-actions.pod:6934 ../src/guestfs-structs.pod:175
17696 msgid "guestfs_version"
17700 #: ../src/guestfs-actions.pod:6936
17703 " struct guestfs_version *\n"
17704 " guestfs_version (guestfs_h *g);\n"
17709 #: ../src/guestfs-actions.pod:6939 ../fish/guestfish-actions.pod:4685
17711 "Return the libguestfs version number that the program is linked against."
17715 #: ../src/guestfs-actions.pod:6942 ../fish/guestfish-actions.pod:4688
17717 "Note that because of dynamic linking this is not necessarily the version of "
17718 "libguestfs that you compiled against. You can compile the program, and then "
17719 "at runtime dynamically link against a completely different C<libguestfs.so> "
17724 #: ../src/guestfs-actions.pod:6947 ../fish/guestfish-actions.pod:4693
17726 "This call was added in version C<1.0.58>. In previous versions of "
17727 "libguestfs there was no way to get the version number. From C code you can "
17728 "use dynamic linker functions to find out if this symbol exists (if it "
17729 "doesn't, then it's an earlier version)."
17733 #: ../src/guestfs-actions.pod:6953 ../fish/guestfish-actions.pod:4699
17735 "The call returns a structure with four elements. The first three (C<major>, "
17736 "C<minor> and C<release>) are numbers and correspond to the usual version "
17737 "triplet. The fourth element (C<extra>) is a string and is normally empty, "
17738 "but may be used for distro-specific information."
17742 #: ../src/guestfs-actions.pod:6959 ../fish/guestfish-actions.pod:4705
17744 "To construct the original version string: C<$major.$minor.$release$extra>"
17748 #: ../src/guestfs-actions.pod:6962 ../fish/guestfish-actions.pod:4708
17749 msgid "See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>."
17753 #: ../src/guestfs-actions.pod:6964
17755 "I<Note:> Don't use this call to test for availability of features. In "
17756 "enterprise distributions we backport features from later versions into "
17757 "earlier versions, making this an unreliable way to test for features. Use "
17758 "C<guestfs_available> instead."
17762 #: ../src/guestfs-actions.pod:6970
17764 "This function returns a C<struct guestfs_version *>, or NULL if there was an "
17765 "error. I<The caller must call C<guestfs_free_version> after use>."
17769 #: ../src/guestfs-actions.pod:6974
17770 msgid "(Added in 1.0.58)"
17774 #: ../src/guestfs-actions.pod:6976
17775 msgid "guestfs_vfs_label"
17779 #: ../src/guestfs-actions.pod:6978
17783 " guestfs_vfs_label (guestfs_h *g,\n"
17784 " const char *device);\n"
17789 #: ../src/guestfs-actions.pod:6982 ../fish/guestfish-actions.pod:4720
17790 msgid "This returns the filesystem label of the filesystem on C<device>."
17794 #: ../src/guestfs-actions.pod:6985 ../fish/guestfish-actions.pod:4723
17795 msgid "If the filesystem is unlabeled, this returns the empty string."
17799 #: ../src/guestfs-actions.pod:6987
17800 msgid "To find a filesystem from the label, use C<guestfs_findfs_label>."
17804 #: ../src/guestfs-actions.pod:6992 ../src/guestfs-actions.pod:7029
17805 msgid "(Added in 1.3.18)"
17809 #: ../src/guestfs-actions.pod:6994
17810 msgid "guestfs_vfs_type"
17814 #: ../src/guestfs-actions.pod:6996
17818 " guestfs_vfs_type (guestfs_h *g,\n"
17819 " const char *device);\n"
17824 #: ../src/guestfs-actions.pod:7000 ../fish/guestfish-actions.pod:4731
17826 "This command gets the filesystem type corresponding to the filesystem on "
17831 #: ../src/guestfs-actions.pod:7003 ../fish/guestfish-actions.pod:4734
17833 "For most filesystems, the result is the name of the Linux VFS module which "
17834 "would be used to mount this filesystem if you mounted it without specifying "
17835 "the filesystem type. For example a string such as C<ext3> or C<ntfs>."
17839 #: ../src/guestfs-actions.pod:7013
17840 msgid "guestfs_vfs_uuid"
17844 #: ../src/guestfs-actions.pod:7015
17848 " guestfs_vfs_uuid (guestfs_h *g,\n"
17849 " const char *device);\n"
17854 #: ../src/guestfs-actions.pod:7019 ../fish/guestfish-actions.pod:4743
17855 msgid "This returns the filesystem UUID of the filesystem on C<device>."
17859 #: ../src/guestfs-actions.pod:7022 ../fish/guestfish-actions.pod:4746
17860 msgid "If the filesystem does not have a UUID, this returns the empty string."
17864 #: ../src/guestfs-actions.pod:7024
17865 msgid "To find a filesystem from the UUID, use C<guestfs_findfs_uuid>."
17869 #: ../src/guestfs-actions.pod:7031
17870 msgid "guestfs_vg_activate"
17874 #: ../src/guestfs-actions.pod:7033
17878 " guestfs_vg_activate (guestfs_h *g,\n"
17880 " char *const *volgroups);\n"
17885 #: ../src/guestfs-actions.pod:7038 ../fish/guestfish-actions.pod:4754
17887 "This command activates or (if C<activate> is false) deactivates all logical "
17888 "volumes in the listed volume groups C<volgroups>. If activated, then they "
17889 "are made known to the kernel, ie. they appear as C</dev/mapper> devices. If "
17890 "deactivated, then those devices disappear."
17894 #: ../src/guestfs-actions.pod:7044 ../fish/guestfish-actions.pod:4760
17895 msgid "This command is the same as running C<vgchange -a y|n volgroups...>"
17899 #: ../src/guestfs-actions.pod:7046 ../fish/guestfish-actions.pod:4762
17901 "Note that if C<volgroups> is an empty list then B<all> volume groups are "
17902 "activated or deactivated."
17906 #: ../src/guestfs-actions.pod:7053
17907 msgid "guestfs_vg_activate_all"
17911 #: ../src/guestfs-actions.pod:7055
17915 " guestfs_vg_activate_all (guestfs_h *g,\n"
17916 " int activate);\n"
17921 #: ../src/guestfs-actions.pod:7059 ../fish/guestfish-actions.pod:4769
17923 "This command activates or (if C<activate> is false) deactivates all logical "
17924 "volumes in all volume groups. If activated, then they are made known to the "
17925 "kernel, ie. they appear as C</dev/mapper> devices. If deactivated, then "
17926 "those devices disappear."
17930 #: ../src/guestfs-actions.pod:7065 ../fish/guestfish-actions.pod:4775
17931 msgid "This command is the same as running C<vgchange -a y|n>"
17935 #: ../src/guestfs-actions.pod:7071
17936 msgid "guestfs_vgcreate"
17940 #: ../src/guestfs-actions.pod:7073
17944 " guestfs_vgcreate (guestfs_h *g,\n"
17945 " const char *volgroup,\n"
17946 " char *const *physvols);\n"
17951 #: ../src/guestfs-actions.pod:7078 ../fish/guestfish-actions.pod:4781
17953 "This creates an LVM volume group called C<volgroup> from the non-empty list "
17954 "of physical volumes C<physvols>."
17958 #: ../src/guestfs-actions.pod:7085
17959 msgid "guestfs_vglvuuids"
17963 #: ../src/guestfs-actions.pod:7087
17967 " guestfs_vglvuuids (guestfs_h *g,\n"
17968 " const char *vgname);\n"
17973 #: ../src/guestfs-actions.pod:7091 ../fish/guestfish-actions.pod:4788
17975 "Given a VG called C<vgname>, this returns the UUIDs of all the logical "
17976 "volumes created in this volume group."
17980 #: ../src/guestfs-actions.pod:7094
17982 "You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid> calls to "
17983 "associate logical volumes and volume groups."
17987 #: ../src/guestfs-actions.pod:7097
17988 msgid "See also C<guestfs_vgpvuuids>."
17992 #: ../src/guestfs-actions.pod:7105
17993 msgid "guestfs_vgpvuuids"
17997 #: ../src/guestfs-actions.pod:7107
18001 " guestfs_vgpvuuids (guestfs_h *g,\n"
18002 " const char *vgname);\n"
18007 #: ../src/guestfs-actions.pod:7111 ../fish/guestfish-actions.pod:4800
18009 "Given a VG called C<vgname>, this returns the UUIDs of all the physical "
18010 "volumes that this volume group resides on."
18014 #: ../src/guestfs-actions.pod:7114
18016 "You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid> calls to "
18017 "associate physical volumes and volume groups."
18021 #: ../src/guestfs-actions.pod:7117
18022 msgid "See also C<guestfs_vglvuuids>."
18026 #: ../src/guestfs-actions.pod:7125
18027 msgid "guestfs_vgremove"
18031 #: ../src/guestfs-actions.pod:7127
18035 " guestfs_vgremove (guestfs_h *g,\n"
18036 " const char *vgname);\n"
18041 #: ../src/guestfs-actions.pod:7131 ../fish/guestfish-actions.pod:4812
18042 msgid "Remove an LVM volume group C<vgname>, (for example C<VG>)."
18046 #: ../src/guestfs-actions.pod:7133 ../fish/guestfish-actions.pod:4814
18048 "This also forcibly removes all logical volumes in the volume group (if any)."
18052 #: ../src/guestfs-actions.pod:7140
18053 msgid "guestfs_vgrename"
18057 #: ../src/guestfs-actions.pod:7142
18061 " guestfs_vgrename (guestfs_h *g,\n"
18062 " const char *volgroup,\n"
18063 " const char *newvolgroup);\n"
18068 #: ../src/guestfs-actions.pod:7147 ../fish/guestfish-actions.pod:4821
18069 msgid "Rename a volume group C<volgroup> with the new name C<newvolgroup>."
18073 #: ../src/guestfs-actions.pod:7153
18074 msgid "guestfs_vgs"
18078 #: ../src/guestfs-actions.pod:7155
18082 " guestfs_vgs (guestfs_h *g);\n"
18087 #: ../src/guestfs-actions.pod:7158 ../fish/guestfish-actions.pod:4827
18089 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
18094 #: ../src/guestfs-actions.pod:7161 ../fish/guestfish-actions.pod:4830
18096 "This returns a list of just the volume group names that were detected (eg. "
18101 #: ../src/guestfs-actions.pod:7164
18102 msgid "See also C<guestfs_vgs_full>."
18106 #: ../src/guestfs-actions.pod:7172
18107 msgid "guestfs_vgs_full"
18111 #: ../src/guestfs-actions.pod:7174
18114 " struct guestfs_lvm_vg_list *\n"
18115 " guestfs_vgs_full (guestfs_h *g);\n"
18120 #: ../src/guestfs-actions.pod:7177 ../fish/guestfish-actions.pod:4839
18122 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
18123 "> command. The \"full\" version includes all fields."
18127 #: ../src/guestfs-actions.pod:7180
18129 "This function returns a C<struct guestfs_lvm_vg_list *>, or NULL if there "
18130 "was an error. I<The caller must call C<guestfs_free_lvm_vg_list> after use>."
18134 #: ../src/guestfs-actions.pod:7186
18135 msgid "guestfs_vgscan"
18139 #: ../src/guestfs-actions.pod:7188
18143 " guestfs_vgscan (guestfs_h *g);\n"
18148 #: ../src/guestfs-actions.pod:7191 ../fish/guestfish-actions.pod:4846
18150 "This rescans all block devices and rebuilds the list of LVM physical "
18151 "volumes, volume groups and logical volumes."
18155 #: ../src/guestfs-actions.pod:7198
18156 msgid "guestfs_vguuid"
18160 #: ../src/guestfs-actions.pod:7200
18164 " guestfs_vguuid (guestfs_h *g,\n"
18165 " const char *vgname);\n"
18170 #: ../src/guestfs-actions.pod:7204 ../fish/guestfish-actions.pod:4853
18171 msgid "This command returns the UUID of the LVM VG named C<vgname>."
18175 #: ../src/guestfs-actions.pod:7211
18176 msgid "guestfs_wait_ready"
18180 #: ../src/guestfs-actions.pod:7213
18184 " guestfs_wait_ready (guestfs_h *g);\n"
18189 #: ../src/guestfs-actions.pod:7216
18190 msgid "This function is a no op."
18194 #: ../src/guestfs-actions.pod:7218
18196 "In versions of the API E<lt> 1.0.71 you had to call this function just after "
18197 "calling C<guestfs_launch> to wait for the launch to complete. However this "
18198 "is no longer necessary because C<guestfs_launch> now does the waiting."
18202 #: ../src/guestfs-actions.pod:7223
18204 "If you see any calls to this function in code then you can just remove them, "
18205 "unless you want to retain compatibility with older versions of the API."
18209 #: ../src/guestfs-actions.pod:7229
18211 "This function is deprecated. In new code, use the L</guestfs_launch> call "
18216 #: ../src/guestfs-actions.pod:7238
18217 msgid "guestfs_wc_c"
18221 #: ../src/guestfs-actions.pod:7240
18225 " guestfs_wc_c (guestfs_h *g,\n"
18226 " const char *path);\n"
18231 #: ../src/guestfs-actions.pod:7244 ../fish/guestfish-actions.pod:4859
18233 "This command counts the characters in a file, using the C<wc -c> external "
18238 #: ../src/guestfs-actions.pod:7251
18239 msgid "guestfs_wc_l"
18243 #: ../src/guestfs-actions.pod:7253
18247 " guestfs_wc_l (guestfs_h *g,\n"
18248 " const char *path);\n"
18253 #: ../src/guestfs-actions.pod:7257 ../fish/guestfish-actions.pod:4866
18255 "This command counts the lines in a file, using the C<wc -l> external command."
18259 #: ../src/guestfs-actions.pod:7264
18260 msgid "guestfs_wc_w"
18264 #: ../src/guestfs-actions.pod:7266
18268 " guestfs_wc_w (guestfs_h *g,\n"
18269 " const char *path);\n"
18274 #: ../src/guestfs-actions.pod:7270 ../fish/guestfish-actions.pod:4873
18276 "This command counts the words in a file, using the C<wc -w> external command."
18280 #: ../src/guestfs-actions.pod:7277
18281 msgid "guestfs_write"
18285 #: ../src/guestfs-actions.pod:7279
18289 " guestfs_write (guestfs_h *g,\n"
18290 " const char *path,\n"
18291 " const char *content,\n"
18292 " size_t content_size);\n"
18297 #: ../src/guestfs-actions.pod:7285 ../fish/guestfish-actions.pod:4880
18299 "This call creates a file called C<path>. The content of the file is the "
18300 "string C<content> (which can contain any 8 bit data)."
18304 #: ../src/guestfs-actions.pod:7295
18305 msgid "guestfs_write_file"
18309 #: ../src/guestfs-actions.pod:7297
18313 " guestfs_write_file (guestfs_h *g,\n"
18314 " const char *path,\n"
18315 " const char *content,\n"
18321 #: ../src/guestfs-actions.pod:7303 ../fish/guestfish-actions.pod:4890
18323 "This call creates a file called C<path>. The contents of the file is the "
18324 "string C<content> (which can contain any 8 bit data), with length C<size>."
18328 #: ../src/guestfs-actions.pod:7307 ../fish/guestfish-actions.pod:4894
18330 "As a special case, if C<size> is C<0> then the length is calculated using "
18331 "C<strlen> (so in this case the content cannot contain embedded ASCII NULs)."
18335 #: ../src/guestfs-actions.pod:7311 ../fish/guestfish-actions.pod:4898
18337 "I<NB.> Owing to a bug, writing content containing ASCII NUL characters does "
18338 "I<not> work, even if the length is specified."
18342 #: ../src/guestfs-actions.pod:7319
18344 "This function is deprecated. In new code, use the L</guestfs_write> call "
18349 #: ../src/guestfs-actions.pod:7328
18350 msgid "guestfs_zegrep"
18354 #: ../src/guestfs-actions.pod:7330
18358 " guestfs_zegrep (guestfs_h *g,\n"
18359 " const char *regex,\n"
18360 " const char *path);\n"
18365 #: ../src/guestfs-actions.pod:7335 ../fish/guestfish-actions.pod:4915
18367 "This calls the external C<zegrep> program and returns the matching lines."
18371 #: ../src/guestfs-actions.pod:7347
18372 msgid "guestfs_zegrepi"
18376 #: ../src/guestfs-actions.pod:7349
18380 " guestfs_zegrepi (guestfs_h *g,\n"
18381 " const char *regex,\n"
18382 " const char *path);\n"
18387 #: ../src/guestfs-actions.pod:7354 ../fish/guestfish-actions.pod:4925
18389 "This calls the external C<zegrep -i> program and returns the matching lines."
18393 #: ../src/guestfs-actions.pod:7366
18394 msgid "guestfs_zero"
18398 #: ../src/guestfs-actions.pod:7368
18402 " guestfs_zero (guestfs_h *g,\n"
18403 " const char *device);\n"
18408 #: ../src/guestfs-actions.pod:7372 ../fish/guestfish-actions.pod:4935
18409 msgid "This command writes zeroes over the first few blocks of C<device>."
18413 #: ../src/guestfs-actions.pod:7374 ../fish/guestfish-actions.pod:4937
18415 "How many blocks are zeroed isn't specified (but it's I<not> enough to "
18416 "securely wipe the device). It should be sufficient to remove any partition "
18417 "tables, filesystem superblocks and so on."
18421 #: ../src/guestfs-actions.pod:7378
18422 msgid "See also: C<guestfs_zero_device>, C<guestfs_scrub_device>."
18426 #: ../src/guestfs-actions.pod:7389
18427 msgid "guestfs_zero_device"
18431 #: ../src/guestfs-actions.pod:7391
18435 " guestfs_zero_device (guestfs_h *g,\n"
18436 " const char *device);\n"
18441 #: ../src/guestfs-actions.pod:7395
18443 "This command writes zeroes over the entire C<device>. Compare with "
18444 "C<guestfs_zero> which just zeroes the first few blocks of a device."
18448 #: ../src/guestfs-actions.pod:7409
18449 msgid "(Added in 1.3.1)"
18453 #: ../src/guestfs-actions.pod:7411
18454 msgid "guestfs_zerofree"
18458 #: ../src/guestfs-actions.pod:7413
18462 " guestfs_zerofree (guestfs_h *g,\n"
18463 " const char *device);\n"
18468 #: ../src/guestfs-actions.pod:7417 ../fish/guestfish-actions.pod:4958
18470 "This runs the I<zerofree> program on C<device>. This program claims to zero "
18471 "unused inodes and disk blocks on an ext2/3 filesystem, thus making it "
18472 "possible to compress the filesystem more effectively."
18476 #: ../src/guestfs-actions.pod:7422 ../fish/guestfish-actions.pod:4963
18477 msgid "You should B<not> run this program if the filesystem is mounted."
18481 #: ../src/guestfs-actions.pod:7425 ../fish/guestfish-actions.pod:4966
18483 "It is possible that using this program can damage the filesystem or data on "
18488 #: ../src/guestfs-actions.pod:7432
18489 msgid "guestfs_zfgrep"
18493 #: ../src/guestfs-actions.pod:7434
18497 " guestfs_zfgrep (guestfs_h *g,\n"
18498 " const char *pattern,\n"
18499 " const char *path);\n"
18504 #: ../src/guestfs-actions.pod:7439 ../fish/guestfish-actions.pod:4973
18506 "This calls the external C<zfgrep> program and returns the matching lines."
18510 #: ../src/guestfs-actions.pod:7451
18511 msgid "guestfs_zfgrepi"
18515 #: ../src/guestfs-actions.pod:7453
18519 " guestfs_zfgrepi (guestfs_h *g,\n"
18520 " const char *pattern,\n"
18521 " const char *path);\n"
18526 #: ../src/guestfs-actions.pod:7458 ../fish/guestfish-actions.pod:4983
18528 "This calls the external C<zfgrep -i> program and returns the matching lines."
18532 #: ../src/guestfs-actions.pod:7470
18533 msgid "guestfs_zfile"
18537 #: ../src/guestfs-actions.pod:7472
18541 " guestfs_zfile (guestfs_h *g,\n"
18542 " const char *meth,\n"
18543 " const char *path);\n"
18548 #: ../src/guestfs-actions.pod:7477 ../fish/guestfish-actions.pod:4993
18550 "This command runs C<file> after first decompressing C<path> using C<method>."
18554 #: ../src/guestfs-actions.pod:7480 ../fish/guestfish-actions.pod:4996
18555 msgid "C<method> must be one of C<gzip>, C<compress> or C<bzip2>."
18559 #: ../src/guestfs-actions.pod:7482
18561 "Since 1.0.63, use C<guestfs_file> instead which can now process compressed "
18566 #: ../src/guestfs-actions.pod:7488
18568 "This function is deprecated. In new code, use the L</guestfs_file> call "
18573 #: ../src/guestfs-actions.pod:7497
18574 msgid "guestfs_zgrep"
18578 #: ../src/guestfs-actions.pod:7499
18582 " guestfs_zgrep (guestfs_h *g,\n"
18583 " const char *regex,\n"
18584 " const char *path);\n"
18589 #: ../src/guestfs-actions.pod:7504 ../fish/guestfish-actions.pod:5012
18591 "This calls the external C<zgrep> program and returns the matching lines."
18595 #: ../src/guestfs-actions.pod:7516
18596 msgid "guestfs_zgrepi"
18600 #: ../src/guestfs-actions.pod:7518
18604 " guestfs_zgrepi (guestfs_h *g,\n"
18605 " const char *regex,\n"
18606 " const char *path);\n"
18611 #: ../src/guestfs-actions.pod:7523 ../fish/guestfish-actions.pod:5022
18613 "This calls the external C<zgrep -i> program and returns the matching lines."
18617 #: ../src/guestfs-availability.pod:3
18622 #: ../src/guestfs-availability.pod:5
18624 "The following functions: L</guestfs_aug_clear> L</guestfs_aug_close> L</"
18625 "guestfs_aug_defnode> L</guestfs_aug_defvar> L</guestfs_aug_get> L</"
18626 "guestfs_aug_init> L</guestfs_aug_insert> L</guestfs_aug_load> L</"
18627 "guestfs_aug_ls> L</guestfs_aug_match> L</guestfs_aug_mv> L</guestfs_aug_rm> "
18628 "L</guestfs_aug_save> L</guestfs_aug_set>"
18632 #: ../src/guestfs-availability.pod:21
18637 #: ../src/guestfs-availability.pod:23
18639 "The following functions: L</guestfs_inotify_add_watch> L</"
18640 "guestfs_inotify_close> L</guestfs_inotify_files> L</guestfs_inotify_init> L</"
18641 "guestfs_inotify_read> L</guestfs_inotify_rm_watch>"
18645 #: ../src/guestfs-availability.pod:31
18646 msgid "B<linuxfsuuid>"
18650 #: ../src/guestfs-availability.pod:33
18652 "The following functions: L</guestfs_mke2fs_JU> L</guestfs_mke2journal_U> L</"
18653 "guestfs_mkswap_U> L</guestfs_swapoff_uuid> L</guestfs_swapon_uuid>"
18657 #: ../src/guestfs-availability.pod:40
18658 msgid "B<linuxmodules>"
18662 #: ../src/guestfs-availability.pod:42
18663 msgid "The following functions: L</guestfs_modprobe>"
18667 #: ../src/guestfs-availability.pod:45
18668 msgid "B<linuxxattrs>"
18672 #: ../src/guestfs-availability.pod:47
18674 "The following functions: L</guestfs_getxattr> L</guestfs_getxattrs> L</"
18675 "guestfs_lgetxattr> L</guestfs_lgetxattrs> L</guestfs_lremovexattr> L</"
18676 "guestfs_lsetxattr> L</guestfs_lxattrlist> L</guestfs_removexattr> L</"
18677 "guestfs_setxattr>"
18681 #: ../src/guestfs-availability.pod:58
18686 #: ../src/guestfs-availability.pod:60
18688 "The following functions: L</guestfs_luks_add_key> L</guestfs_luks_close> L</"
18689 "guestfs_luks_format> L</guestfs_luks_format_cipher> L</"
18690 "guestfs_luks_kill_slot> L</guestfs_luks_open> L</guestfs_luks_open_ro>"
18694 #: ../src/guestfs-availability.pod:69
18699 #: ../src/guestfs-availability.pod:71
18701 "The following functions: L</guestfs_is_lv> L</guestfs_lvcreate> L</"
18702 "guestfs_lvm_remove_all> L</guestfs_lvm_set_filter> L</guestfs_lvremove> L</"
18703 "guestfs_lvresize> L</guestfs_lvresize_free> L</guestfs_lvs> L</"
18704 "guestfs_lvs_full> L</guestfs_pvcreate> L</guestfs_pvremove> L</"
18705 "guestfs_pvresize> L</guestfs_pvresize_size> L</guestfs_pvs> L</"
18706 "guestfs_pvs_full> L</guestfs_vg_activate> L</guestfs_vg_activate_all> L</"
18707 "guestfs_vgcreate> L</guestfs_vgremove> L</guestfs_vgs> L</guestfs_vgs_full>"
18711 #: ../src/guestfs-availability.pod:94
18716 #: ../src/guestfs-availability.pod:96
18718 "The following functions: L</guestfs_mkfifo> L</guestfs_mknod> L</"
18719 "guestfs_mknod_b> L</guestfs_mknod_c>"
18723 #: ../src/guestfs-availability.pod:102
18728 #: ../src/guestfs-availability.pod:104
18729 msgid "The following functions: L</guestfs_ntfs_3g_probe>"
18733 #: ../src/guestfs-availability.pod:107
18734 msgid "B<ntfsprogs>"
18738 #: ../src/guestfs-availability.pod:109
18740 "The following functions: L</guestfs_ntfsresize> L</guestfs_ntfsresize_size>"
18744 #: ../src/guestfs-availability.pod:113
18745 msgid "B<realpath>"
18749 #: ../src/guestfs-availability.pod:115
18750 msgid "The following functions: L</guestfs_realpath>"
18754 #: ../src/guestfs-availability.pod:118
18759 #: ../src/guestfs-availability.pod:120
18761 "The following functions: L</guestfs_scrub_device> L</guestfs_scrub_file> L</"
18762 "guestfs_scrub_freespace>"
18766 #: ../src/guestfs-availability.pod:125
18771 #: ../src/guestfs-availability.pod:127
18772 msgid "The following functions: L</guestfs_getcon> L</guestfs_setcon>"
18776 #: ../src/guestfs-availability.pod:131
18781 #: ../src/guestfs-availability.pod:133
18782 msgid "The following functions: L</guestfs_txz_in> L</guestfs_txz_out>"
18786 #: ../src/guestfs-availability.pod:137
18787 msgid "B<zerofree>"
18791 #: ../src/guestfs-availability.pod:139
18792 msgid "The following functions: L</guestfs_zerofree>"
18796 #: ../src/guestfs-structs.pod:1
18797 msgid "guestfs_int_bool"
18801 #: ../src/guestfs-structs.pod:3
18804 " struct guestfs_int_bool {\n"
18812 #: ../src/guestfs-structs.pod:8
18815 " struct guestfs_int_bool_list {\n"
18816 " uint32_t len; /* Number of elements in list. */\n"
18817 " struct guestfs_int_bool *val; /* Elements. */\n"
18823 #: ../src/guestfs-structs.pod:13
18826 " void guestfs_free_int_bool (struct guestfs_free_int_bool *);\n"
18827 " void guestfs_free_int_bool_list (struct guestfs_free_int_bool_list *);\n"
18832 #: ../src/guestfs-structs.pod:16
18833 msgid "guestfs_lvm_pv"
18837 #: ../src/guestfs-structs.pod:18
18840 " struct guestfs_lvm_pv {\n"
18841 " char *pv_name;\n"
18842 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
18843 " char pv_uuid[32];\n"
18845 " uint64_t pv_size;\n"
18846 " uint64_t dev_size;\n"
18847 " uint64_t pv_free;\n"
18848 " uint64_t pv_used;\n"
18849 " char *pv_attr;\n"
18850 " int64_t pv_pe_count;\n"
18851 " int64_t pv_pe_alloc_count;\n"
18852 " char *pv_tags;\n"
18853 " uint64_t pe_start;\n"
18854 " int64_t pv_mda_count;\n"
18855 " uint64_t pv_mda_free;\n"
18861 #: ../src/guestfs-structs.pod:36
18864 " struct guestfs_lvm_pv_list {\n"
18865 " uint32_t len; /* Number of elements in list. */\n"
18866 " struct guestfs_lvm_pv *val; /* Elements. */\n"
18872 #: ../src/guestfs-structs.pod:41
18875 " void guestfs_free_lvm_pv (struct guestfs_free_lvm_pv *);\n"
18876 " void guestfs_free_lvm_pv_list (struct guestfs_free_lvm_pv_list *);\n"
18881 #: ../src/guestfs-structs.pod:44
18882 msgid "guestfs_lvm_vg"
18886 #: ../src/guestfs-structs.pod:46
18889 " struct guestfs_lvm_vg {\n"
18890 " char *vg_name;\n"
18891 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
18892 " char vg_uuid[32];\n"
18894 " char *vg_attr;\n"
18895 " uint64_t vg_size;\n"
18896 " uint64_t vg_free;\n"
18897 " char *vg_sysid;\n"
18898 " uint64_t vg_extent_size;\n"
18899 " int64_t vg_extent_count;\n"
18900 " int64_t vg_free_count;\n"
18901 " int64_t max_lv;\n"
18902 " int64_t max_pv;\n"
18903 " int64_t pv_count;\n"
18904 " int64_t lv_count;\n"
18905 " int64_t snap_count;\n"
18906 " int64_t vg_seqno;\n"
18907 " char *vg_tags;\n"
18908 " int64_t vg_mda_count;\n"
18909 " uint64_t vg_mda_free;\n"
18915 #: ../src/guestfs-structs.pod:69
18918 " struct guestfs_lvm_vg_list {\n"
18919 " uint32_t len; /* Number of elements in list. */\n"
18920 " struct guestfs_lvm_vg *val; /* Elements. */\n"
18926 #: ../src/guestfs-structs.pod:74
18929 " void guestfs_free_lvm_vg (struct guestfs_free_lvm_vg *);\n"
18930 " void guestfs_free_lvm_vg_list (struct guestfs_free_lvm_vg_list *);\n"
18935 #: ../src/guestfs-structs.pod:77
18936 msgid "guestfs_lvm_lv"
18940 #: ../src/guestfs-structs.pod:79
18943 " struct guestfs_lvm_lv {\n"
18944 " char *lv_name;\n"
18945 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
18946 " char lv_uuid[32];\n"
18947 " char *lv_attr;\n"
18948 " int64_t lv_major;\n"
18949 " int64_t lv_minor;\n"
18950 " int64_t lv_kernel_major;\n"
18951 " int64_t lv_kernel_minor;\n"
18952 " uint64_t lv_size;\n"
18953 " int64_t seg_count;\n"
18955 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
18956 " float snap_percent;\n"
18957 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
18958 " float copy_percent;\n"
18959 " char *move_pv;\n"
18960 " char *lv_tags;\n"
18961 " char *mirror_log;\n"
18962 " char *modules;\n"
18968 #: ../src/guestfs-structs.pod:101
18971 " struct guestfs_lvm_lv_list {\n"
18972 " uint32_t len; /* Number of elements in list. */\n"
18973 " struct guestfs_lvm_lv *val; /* Elements. */\n"
18979 #: ../src/guestfs-structs.pod:106
18982 " void guestfs_free_lvm_lv (struct guestfs_free_lvm_lv *);\n"
18983 " void guestfs_free_lvm_lv_list (struct guestfs_free_lvm_lv_list *);\n"
18988 #: ../src/guestfs-structs.pod:111
18991 " struct guestfs_stat {\n"
18995 " int64_t nlink;\n"
19000 " int64_t blksize;\n"
19001 " int64_t blocks;\n"
19002 " int64_t atime;\n"
19003 " int64_t mtime;\n"
19004 " int64_t ctime;\n"
19010 #: ../src/guestfs-structs.pod:127
19013 " struct guestfs_stat_list {\n"
19014 " uint32_t len; /* Number of elements in list. */\n"
19015 " struct guestfs_stat *val; /* Elements. */\n"
19021 #: ../src/guestfs-structs.pod:132
19024 " void guestfs_free_stat (struct guestfs_free_stat *);\n"
19025 " void guestfs_free_stat_list (struct guestfs_free_stat_list *);\n"
19030 #: ../src/guestfs-structs.pod:137
19033 " struct guestfs_statvfs {\n"
19034 " int64_t bsize;\n"
19035 " int64_t frsize;\n"
19036 " int64_t blocks;\n"
19037 " int64_t bfree;\n"
19038 " int64_t bavail;\n"
19039 " int64_t files;\n"
19040 " int64_t ffree;\n"
19041 " int64_t favail;\n"
19044 " int64_t namemax;\n"
19050 #: ../src/guestfs-structs.pod:151
19053 " struct guestfs_statvfs_list {\n"
19054 " uint32_t len; /* Number of elements in list. */\n"
19055 " struct guestfs_statvfs *val; /* Elements. */\n"
19061 #: ../src/guestfs-structs.pod:156
19064 " void guestfs_free_statvfs (struct guestfs_free_statvfs *);\n"
19065 " void guestfs_free_statvfs_list (struct guestfs_free_statvfs_list *);\n"
19070 #: ../src/guestfs-structs.pod:159
19071 msgid "guestfs_dirent"
19075 #: ../src/guestfs-structs.pod:161
19078 " struct guestfs_dirent {\n"
19087 #: ../src/guestfs-structs.pod:167
19090 " struct guestfs_dirent_list {\n"
19091 " uint32_t len; /* Number of elements in list. */\n"
19092 " struct guestfs_dirent *val; /* Elements. */\n"
19098 #: ../src/guestfs-structs.pod:172
19101 " void guestfs_free_dirent (struct guestfs_free_dirent *);\n"
19102 " void guestfs_free_dirent_list (struct guestfs_free_dirent_list *);\n"
19107 #: ../src/guestfs-structs.pod:177
19110 " struct guestfs_version {\n"
19111 " int64_t major;\n"
19112 " int64_t minor;\n"
19113 " int64_t release;\n"
19120 #: ../src/guestfs-structs.pod:184
19123 " struct guestfs_version_list {\n"
19124 " uint32_t len; /* Number of elements in list. */\n"
19125 " struct guestfs_version *val; /* Elements. */\n"
19131 #: ../src/guestfs-structs.pod:189
19134 " void guestfs_free_version (struct guestfs_free_version *);\n"
19135 " void guestfs_free_version_list (struct guestfs_free_version_list *);\n"
19140 #: ../src/guestfs-structs.pod:192
19141 msgid "guestfs_xattr"
19145 #: ../src/guestfs-structs.pod:194
19148 " struct guestfs_xattr {\n"
19149 " char *attrname;\n"
19150 " /* The next two fields describe a byte array. */\n"
19151 " uint32_t attrval_len;\n"
19152 " char *attrval;\n"
19158 #: ../src/guestfs-structs.pod:201
19161 " struct guestfs_xattr_list {\n"
19162 " uint32_t len; /* Number of elements in list. */\n"
19163 " struct guestfs_xattr *val; /* Elements. */\n"
19169 #: ../src/guestfs-structs.pod:206
19172 " void guestfs_free_xattr (struct guestfs_free_xattr *);\n"
19173 " void guestfs_free_xattr_list (struct guestfs_free_xattr_list *);\n"
19178 #: ../src/guestfs-structs.pod:209
19179 msgid "guestfs_inotify_event"
19183 #: ../src/guestfs-structs.pod:211
19186 " struct guestfs_inotify_event {\n"
19187 " int64_t in_wd;\n"
19188 " uint32_t in_mask;\n"
19189 " uint32_t in_cookie;\n"
19190 " char *in_name;\n"
19196 #: ../src/guestfs-structs.pod:218
19199 " struct guestfs_inotify_event_list {\n"
19200 " uint32_t len; /* Number of elements in list. */\n"
19201 " struct guestfs_inotify_event *val; /* Elements. */\n"
19207 #: ../src/guestfs-structs.pod:223
19210 " void guestfs_free_inotify_event (struct guestfs_free_inotify_event *);\n"
19211 " void guestfs_free_inotify_event_list (struct guestfs_free_inotify_event_list *);\n"
19216 #: ../src/guestfs-structs.pod:226
19217 msgid "guestfs_partition"
19221 #: ../src/guestfs-structs.pod:228
19224 " struct guestfs_partition {\n"
19225 " int32_t part_num;\n"
19226 " uint64_t part_start;\n"
19227 " uint64_t part_end;\n"
19228 " uint64_t part_size;\n"
19234 #: ../src/guestfs-structs.pod:235
19237 " struct guestfs_partition_list {\n"
19238 " uint32_t len; /* Number of elements in list. */\n"
19239 " struct guestfs_partition *val; /* Elements. */\n"
19245 #: ../src/guestfs-structs.pod:240
19248 " void guestfs_free_partition (struct guestfs_free_partition *);\n"
19249 " void guestfs_free_partition_list (struct guestfs_free_partition_list *);\n"
19254 #: ../src/guestfs-structs.pod:243
19255 msgid "guestfs_application"
19259 #: ../src/guestfs-structs.pod:245
19262 " struct guestfs_application {\n"
19263 " char *app_name;\n"
19264 " char *app_display_name;\n"
19265 " int32_t app_epoch;\n"
19266 " char *app_version;\n"
19267 " char *app_release;\n"
19268 " char *app_install_path;\n"
19269 " char *app_trans_path;\n"
19270 " char *app_publisher;\n"
19271 " char *app_url;\n"
19272 " char *app_source_package;\n"
19273 " char *app_summary;\n"
19274 " char *app_description;\n"
19280 #: ../src/guestfs-structs.pod:260
19283 " struct guestfs_application_list {\n"
19284 " uint32_t len; /* Number of elements in list. */\n"
19285 " struct guestfs_application *val; /* Elements. */\n"
19291 #: ../src/guestfs-structs.pod:265
19294 " void guestfs_free_application (struct guestfs_free_application *);\n"
19295 " void guestfs_free_application_list (struct guestfs_free_application_list *);\n"
19300 #: ../fish/guestfish.pod:5
19301 msgid "guestfish - the libguestfs Filesystem Interactive SHell"
19305 #: ../fish/guestfish.pod:9
19308 " guestfish [--options] [commands]\n"
19313 #: ../fish/guestfish.pod:11
19321 #: ../fish/guestfish.pod:13
19324 " guestfish [--ro|--rw] -a disk.img\n"
19329 #: ../fish/guestfish.pod:15
19332 " guestfish [--ro|--rw] -a disk.img -m dev[:mountpoint]\n"
19337 #: ../fish/guestfish.pod:17
19340 " guestfish -d libvirt-domain\n"
19345 #: ../fish/guestfish.pod:19
19348 " guestfish [--ro|--rw] -a disk.img -i\n"
19353 #: ../fish/guestfish.pod:21
19356 " guestfish -d libvirt-domain -i\n"
19361 #: ../fish/guestfish.pod:23 ../fuse/guestmount.pod:15 ../tools/virt-edit.pl:44
19362 #: ../tools/virt-win-reg.pl:51 ../tools/virt-tar.pl:64
19367 #: ../fish/guestfish.pod:25
19369 "Using guestfish in read/write mode on live virtual machines can be "
19370 "dangerous, potentially causing disk corruption. Use the I<--ro> (read-only) "
19371 "option to use guestfish safely if the disk image or virtual machine might be "
19376 #: ../fish/guestfish.pod:32
19378 "Guestfish is a shell and command-line tool for examining and modifying "
19379 "virtual machine filesystems. It uses libguestfs and exposes all of the "
19380 "functionality of the guestfs API, see L<guestfs(3)>."
19384 #: ../fish/guestfish.pod:36
19386 "Guestfish gives you structured access to the libguestfs API, from shell "
19387 "scripts or the command line or interactively. If you want to rescue a "
19388 "broken virtual machine image, you should look at the L<virt-rescue(1)> "
19393 #: ../fish/guestfish.pod:41 ../fish/guestfish.pod:947
19394 #: ../fuse/guestmount.pod:39 ../tools/virt-edit.pl:63 ../tools/virt-tar.pl:50
19399 #: ../fish/guestfish.pod:43
19400 msgid "As an interactive shell"
19404 #: ../fish/guestfish.pod:45
19412 #: ../fish/guestfish.pod:47
19415 " Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
19416 " editing virtual machine filesystems.\n"
19421 #: ../fish/guestfish.pod:50
19424 " Type: 'help' for a list of commands\n"
19425 " 'man' to read the manual\n"
19426 " 'quit' to quit the shell\n"
19431 #: ../fish/guestfish.pod:54
19434 " ><fs> add-ro disk.img\n"
19436 " ><fs> list-filesystems\n"
19437 " /dev/sda1: ext4\n"
19438 " /dev/vg_guest/lv_root: ext4\n"
19439 " /dev/vg_guest/lv_swap: swap\n"
19440 " ><fs> mount /dev/vg_guest/lv_root /\n"
19441 " ><fs> cat /etc/fstab\n"
19443 " # Created by anaconda\n"
19450 #: ../fish/guestfish.pod:67
19451 msgid "From shell scripts"
19455 #: ../fish/guestfish.pod:69
19456 msgid "Create a new C</etc/motd> file in a guest or disk image:"
19460 #: ../fish/guestfish.pod:71
19463 " guestfish <<_EOF_\n"
19466 " mount /dev/vg_guest/lv_root /\n"
19467 " write /etc/motd \"Welcome, new users\"\n"
19473 #: ../fish/guestfish.pod:78
19474 msgid "List the LVM logical volumes in a disk image:"
19478 #: ../fish/guestfish.pod:80
19481 " guestfish -a disk.img --ro <<_EOF_\n"
19489 #: ../fish/guestfish.pod:85
19490 msgid "List all the filesystems in a disk image:"
19494 #: ../fish/guestfish.pod:87
19497 " guestfish -a disk.img --ro <<_EOF_\n"
19499 " list-filesystems\n"
19505 #: ../fish/guestfish.pod:92
19506 msgid "On one command line"
19510 #: ../fish/guestfish.pod:94
19511 msgid "Update C</etc/resolv.conf> in a guest:"
19515 #: ../fish/guestfish.pod:96
19519 " add disk.img : run : mount /dev/vg_guest/lv_root / : \\\n"
19520 " write /etc/resolv.conf \"nameserver 1.2.3.4\"\n"
19525 #: ../fish/guestfish.pod:100
19526 msgid "Edit C</boot/grub/grub.conf> interactively:"
19530 #: ../fish/guestfish.pod:102
19533 " guestfish --rw --add disk.img \\\n"
19534 " --mount /dev/vg_guest/lv_root \\\n"
19535 " --mount /dev/sda1:/boot \\\n"
19536 " edit /boot/grub/grub.conf\n"
19541 #: ../fish/guestfish.pod:107
19542 msgid "Mount disks automatically"
19546 #: ../fish/guestfish.pod:109
19548 "Use the I<-i> option to automatically mount the disks from a virtual machine:"
19552 #: ../fish/guestfish.pod:112
19555 " guestfish --ro -a disk.img -i cat /etc/group\n"
19560 #: ../fish/guestfish.pod:114
19563 " guestfish --ro -d libvirt-domain -i cat /etc/group\n"
19568 #: ../fish/guestfish.pod:116
19569 msgid "Another way to edit C</boot/grub/grub.conf> interactively is:"
19573 #: ../fish/guestfish.pod:118
19576 " guestfish --rw -a disk.img -i edit /boot/grub/grub.conf\n"
19581 #: ../fish/guestfish.pod:120
19582 msgid "As a script interpreter"
19586 #: ../fish/guestfish.pod:122
19587 msgid "Create a 100MB disk containing an ext2-formatted partition:"
19591 #: ../fish/guestfish.pod:124
19594 " #!/usr/bin/guestfish -f\n"
19595 " sparse test1.img 100M\n"
19597 " part-disk /dev/sda mbr\n"
19598 " mkfs ext2 /dev/sda1\n"
19603 #: ../fish/guestfish.pod:130
19604 msgid "Start with a prepared disk"
19608 #: ../fish/guestfish.pod:132
19610 "An alternate way to create a 100MB disk called C<test1.img> containing a "
19611 "single ext2-formatted partition:"
19615 #: ../fish/guestfish.pod:135
19618 " guestfish -N fs\n"
19623 #: ../fish/guestfish.pod:137
19624 msgid "To list what is available do:"
19628 #: ../fish/guestfish.pod:139 ../fish/guestfish.pod:938
19631 " guestfish -N help | less\n"
19636 #: ../fish/guestfish.pod:141
19637 msgid "Remote control"
19641 #: ../fish/guestfish.pod:143
19644 " eval \"`guestfish --listen`\"\n"
19645 " guestfish --remote add-ro disk.img\n"
19646 " guestfish --remote run\n"
19647 " guestfish --remote lvs\n"
19652 #: ../fish/guestfish.pod:148 ../test-tool/libguestfs-test-tool.pod:37
19653 #: ../fuse/guestmount.pod:83 ../tools/virt-edit.pl:81
19654 #: ../tools/virt-win-reg.pl:96 ../tools/virt-list-filesystems.pl:53
19655 #: ../tools/virt-tar.pl:103 ../tools/virt-make-fs.pl:153
19656 #: ../tools/virt-list-partitions.pl:54
19661 #: ../fish/guestfish.pod:152 ../fuse/guestmount.pod:141
19662 #: ../tools/virt-edit.pl:89 ../tools/virt-win-reg.pl:104
19663 #: ../tools/virt-list-filesystems.pl:61 ../tools/virt-tar.pl:111
19664 #: ../tools/virt-make-fs.pl:161 ../tools/virt-list-partitions.pl:62
19669 #: ../fish/guestfish.pod:154
19670 msgid "Displays general help on options."
19674 #: ../fish/guestfish.pod:156
19679 #: ../fish/guestfish.pod:158
19680 msgid "B<--cmd-help>"
19684 #: ../fish/guestfish.pod:160
19685 msgid "Lists all available guestfish commands."
19689 #: ../fish/guestfish.pod:162
19694 #: ../fish/guestfish.pod:164
19695 msgid "B<--cmd-help cmd>"
19699 #: ../fish/guestfish.pod:166
19700 msgid "Displays detailed help on a single command C<cmd>."
19704 #: ../fish/guestfish.pod:168
19705 msgid "B<-a image>"
19709 #: ../fish/guestfish.pod:170
19710 msgid "B<--add image>"
19714 #: ../fish/guestfish.pod:172
19715 msgid "Add a block device or virtual machine image to the shell."
19719 #: ../fish/guestfish.pod:174 ../fuse/guestmount.pod:91
19721 "The format of the disk image is auto-detected. To override this and force a "
19722 "particular format use the I<--format=..> option."
19726 #: ../fish/guestfish.pod:177
19728 "Using this flag is mostly equivalent to using the C<add> command, with "
19729 "C<readonly:true> if the I<--ro> flag was given, and with C<format:...> if "
19730 "the I<--format=...> flag was given."
19734 #: ../fish/guestfish.pod:181
19739 #: ../fish/guestfish.pod:183
19740 msgid "B<--connect URI>"
19744 #: ../fish/guestfish.pod:185 ../fuse/guestmount.pod:96
19746 "When used in conjunction with the I<-d> option, this specifies the libvirt "
19747 "URI to use. The default is to use the default libvirt connection."
19751 #: ../fish/guestfish.pod:189
19756 #: ../fish/guestfish.pod:191
19758 "If using the I<--listen> option and a csh-like shell, use this option. See "
19759 "section L</REMOTE CONTROL AND CSH> below."
19763 #: ../fish/guestfish.pod:194
19764 msgid "B<-d libvirt-domain>"
19768 #: ../fish/guestfish.pod:196
19769 msgid "B<--domain libvirt-domain>"
19773 #: ../fish/guestfish.pod:198 ../fuse/guestmount.pod:102
19775 "Add disks from the named libvirt domain. If the I<--ro> option is also "
19776 "used, then any libvirt domain can be used. However in write mode, only "
19777 "libvirt domains which are shut down can be named here."
19781 #: ../fish/guestfish.pod:202
19783 "Using this flag is mostly equivalent to using the C<add-domain> command, "
19784 "with C<readonly:true> if the I<--ro> flag was given, and with C<format:...> "
19785 "if the I<--format:...> flag was given."
19789 #: ../fish/guestfish.pod:206
19794 #: ../fish/guestfish.pod:208
19795 msgid "B<--no-dest-paths>"
19799 #: ../fish/guestfish.pod:210
19801 "Don't tab-complete paths on the guest filesystem. It is useful to be able "
19802 "to hit the tab key to complete paths on the guest filesystem, but this "
19803 "causes extra \"hidden\" guestfs calls to be made, so this option is here to "
19804 "allow this feature to be disabled."
19808 #: ../fish/guestfish.pod:215 ../fuse/guestmount.pod:118
19809 msgid "B<--echo-keys>"
19813 #: ../fish/guestfish.pod:217 ../fuse/guestmount.pod:120
19815 "When prompting for keys and passphrases, guestfish normally turns echoing "
19816 "off so you cannot see what you are typing. If you are not worried about "
19817 "Tempest attacks and there is no one else in the room you can specify this "
19818 "flag to see what you are typing."
19822 #: ../fish/guestfish.pod:222
19827 #: ../fish/guestfish.pod:224
19828 msgid "B<--file file>"
19832 #: ../fish/guestfish.pod:226
19833 msgid "Read commands from C<file>. To write pure guestfish scripts, use:"
19837 #: ../fish/guestfish.pod:229
19840 " #!/usr/bin/guestfish -f\n"
19845 #: ../fish/guestfish.pod:231
19846 msgid "B<--format=raw|qcow2|..>"
19850 #: ../fish/guestfish.pod:233
19851 msgid "B<--format>"
19855 #: ../fish/guestfish.pod:235 ../fuse/guestmount.pod:127
19857 "The default for the I<-a> option is to auto-detect the format of the disk "
19858 "image. Using this forces the disk format for I<-a> options which follow on "
19859 "the command line. Using I<--format> with no argument switches back to auto-"
19860 "detection for subsequent I<-a> options."
19864 #: ../fish/guestfish.pod:242
19867 " guestfish --format=raw -a disk.img\n"
19872 #: ../fish/guestfish.pod:244
19873 msgid "forces raw format (no auto-detection) for C<disk.img>."
19877 #: ../fish/guestfish.pod:246
19880 " guestfish --format=raw -a disk.img --format -a another.img\n"
19885 #: ../fish/guestfish.pod:248
19887 "forces raw format (no auto-detection) for C<disk.img> and reverts to auto-"
19888 "detection for C<another.img>."
19892 #: ../fish/guestfish.pod:251
19894 "If you have untrusted raw-format guest disk images, you should use this "
19895 "option to specify the disk format. This avoids a possible security problem "
19896 "with malicious guests (CVE-2010-3851). See also L</add-drive-opts>."
19900 #: ../fish/guestfish.pod:256
19905 #: ../fish/guestfish.pod:258
19906 msgid "B<--inspector>"
19910 #: ../fish/guestfish.pod:260 ../fuse/guestmount.pod:147
19912 "Using L<virt-inspector(1)> code, inspect the disks looking for an operating "
19913 "system and mount filesystems as they would be mounted on the real virtual "
19918 #: ../fish/guestfish.pod:264
19919 msgid "Typical usage is either:"
19923 #: ../fish/guestfish.pod:266
19926 " guestfish -d myguest -i\n"
19931 #: ../fish/guestfish.pod:268
19932 msgid "(for an inactive libvirt domain called I<myguest>), or:"
19936 #: ../fish/guestfish.pod:270
19939 " guestfish --ro -d myguest -i\n"
19944 #: ../fish/guestfish.pod:272
19945 msgid "(for active domains, readonly), or specify the block device directly:"
19949 #: ../fish/guestfish.pod:274
19952 " guestfish --rw -a /dev/Guests/MyGuest -i\n"
19957 #: ../fish/guestfish.pod:276
19959 "Note that the command line syntax changed slightly over older versions of "
19960 "guestfish. You can still use the old syntax:"
19964 #: ../fish/guestfish.pod:279
19967 " guestfish [--ro] -i disk.img\n"
19972 #: ../fish/guestfish.pod:281
19975 " guestfish [--ro] -i libvirt-domain\n"
19980 #: ../fish/guestfish.pod:283
19982 "Using this flag is mostly equivalent to using the C<inspect-os> command and "
19983 "then using other commands to mount the filesystems that were found."
19987 #: ../fish/guestfish.pod:287 ../fuse/guestmount.pod:151
19988 msgid "B<--keys-from-stdin>"
19992 #: ../fish/guestfish.pod:289 ../fuse/guestmount.pod:153
19994 "Read key or passphrase parameters from stdin. The default is to try to read "
19995 "passphrases from the user by opening C</dev/tty>."
19999 #: ../fish/guestfish.pod:292
20000 msgid "B<--listen>"
20004 #: ../fish/guestfish.pod:294
20006 "Fork into the background and listen for remote commands. See section L</"
20007 "REMOTE CONTROL GUESTFISH OVER A SOCKET> below."
20011 #: ../fish/guestfish.pod:297 ../fuse/guestmount.pod:156
20016 #: ../fish/guestfish.pod:299 ../fuse/guestmount.pod:158
20018 "Connect to a live virtual machine. (Experimental, see L<guestfs(3)/"
20019 "ATTACHING TO RUNNING DAEMONS>)."
20023 #: ../fish/guestfish.pod:302 ../fuse/guestmount.pod:161
20024 msgid "B<-m dev[:mountpoint[:options]]>"
20028 #: ../fish/guestfish.pod:304 ../fuse/guestmount.pod:163
20029 msgid "B<--mount dev[:mountpoint[:options]]>"
20033 #: ../fish/guestfish.pod:306
20034 msgid "Mount the named partition or logical volume on the given mountpoint."
20038 #: ../fish/guestfish.pod:308
20039 msgid "If the mountpoint is omitted, it defaults to C</>."
20043 #: ../fish/guestfish.pod:310
20044 msgid "You have to mount something on C</> before most commands will work."
20048 #: ../fish/guestfish.pod:312
20050 "If any I<-m> or I<--mount> options are given, the guest is automatically "
20055 #: ../fish/guestfish.pod:315
20057 "If you don't know what filesystems a disk image contains, you can either run "
20058 "guestfish without this option, then list the partitions, filesystems and LVs "
20059 "available (see L</list-partitions>, L</list-filesystems> and L</lvs> "
20060 "commands), or you can use the L<virt-filesystems(1)> program."
20064 #: ../fish/guestfish.pod:321 ../fuse/guestmount.pod:171
20066 "The third (and rarely used) part of the mount parameter is the list of mount "
20067 "options used to mount the underlying filesystem. If this is not given, then "
20068 "the mount options are either the empty string or C<ro> (the latter if the "
20069 "I<--ro> flag is used). By specifying the mount options, you override this "
20070 "default choice. Probably the only time you would use this is to enable ACLs "
20071 "and/or extended attributes if the filesystem can support them:"
20075 #: ../fish/guestfish.pod:329 ../fuse/guestmount.pod:179
20078 " -m /dev/sda1:/:acl,user_xattr\n"
20083 #: ../fish/guestfish.pod:331
20084 msgid "Using this flag is equivalent to using the C<mount-options> command."
20088 #: ../fish/guestfish.pod:333
20093 #: ../fish/guestfish.pod:335
20094 msgid "B<--no-sync>"
20098 #: ../fish/guestfish.pod:337
20100 "Disable autosync. This is enabled by default. See the discussion of "
20101 "autosync in the L<guestfs(3)> manpage."
20105 #: ../fish/guestfish.pod:340
20110 #: ../fish/guestfish.pod:342
20111 msgid "B<--new type>"
20115 #: ../fish/guestfish.pod:344
20120 #: ../fish/guestfish.pod:346
20122 "Prepare a fresh disk image formatted as \"type\". This is an alternative to "
20123 "the I<-a> option: whereas I<-a> adds an existing disk, I<-N> creates a "
20124 "preformatted disk with a filesystem and adds it. See L</PREPARED DISK "
20129 #: ../fish/guestfish.pod:351
20130 msgid "B<--progress-bars>"
20134 #: ../fish/guestfish.pod:353
20135 msgid "Enable progress bars, even when guestfish is used non-interactively."
20139 #: ../fish/guestfish.pod:355
20141 "Progress bars are enabled by default when guestfish is used as an "
20142 "interactive shell."
20146 #: ../fish/guestfish.pod:358
20147 msgid "B<--no-progress-bars>"
20151 #: ../fish/guestfish.pod:360
20152 msgid "Disable progress bars."
20156 #: ../fish/guestfish.pod:362
20157 msgid "B<--remote[=pid]>"
20161 #: ../fish/guestfish.pod:364
20163 "Send remote commands to C<$GUESTFISH_PID> or C<pid>. See section L</REMOTE "
20164 "CONTROL GUESTFISH OVER A SOCKET> below."
20168 #: ../fish/guestfish.pod:367
20173 #: ../fish/guestfish.pod:369
20178 #: ../fish/guestfish.pod:371
20180 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
20181 "mounts are done read-only."
20185 #: ../fish/guestfish.pod:374
20187 "The option must always be used if the disk image or virtual machine might be "
20188 "running, and is generally recommended in cases where you don't need write "
20189 "access to the disk."
20193 #: ../fish/guestfish.pod:378
20195 "Note that prepared disk images created with I<-N> are not affected by this "
20196 "option. Also commands like C<add> are not affected - you have to specify "
20197 "the C<readonly:true> option explicitly if you need it."
20201 #: ../fish/guestfish.pod:382
20202 msgid "See also L</OPENING DISKS FOR READ AND WRITE> below."
20206 #: ../fish/guestfish.pod:384 ../fuse/guestmount.pod:235
20207 msgid "B<--selinux>"
20211 #: ../fish/guestfish.pod:386
20212 msgid "Enable SELinux support for the guest. See L<guestfs(3)/SELINUX>."
20216 #: ../fish/guestfish.pod:388
20221 #: ../fish/guestfish.pod:390
20222 msgid "B<--verbose>"
20226 #: ../fish/guestfish.pod:392
20228 "Enable very verbose messages. This is particularly useful if you find a bug."
20232 #: ../fish/guestfish.pod:395
20237 #: ../fish/guestfish.pod:397 ../tools/virt-edit.pl:97
20238 #: ../tools/virt-win-reg.pl:112 ../tools/virt-list-filesystems.pl:69
20239 #: ../tools/virt-tar.pl:119 ../tools/virt-make-fs.pl:169
20240 #: ../tools/virt-list-partitions.pl:70
20241 msgid "B<--version>"
20245 #: ../fish/guestfish.pod:399
20246 msgid "Display the guestfish / libguestfs version number and exit."
20250 #: ../fish/guestfish.pod:401
20255 #: ../fish/guestfish.pod:403
20260 #: ../fish/guestfish.pod:405 ../fuse/guestmount.pod:249
20262 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
20263 "mounts are done read-write."
20267 #: ../fish/guestfish.pod:408
20268 msgid "See L</OPENING DISKS FOR READ AND WRITE> below."
20272 #: ../fish/guestfish.pod:410
20277 #: ../fish/guestfish.pod:412
20278 msgid "Echo each command before executing it."
20282 #: ../fish/guestfish.pod:416
20283 msgid "COMMANDS ON COMMAND LINE"
20287 #: ../fish/guestfish.pod:418
20289 "Any additional (non-option) arguments are treated as commands to execute."
20293 #: ../fish/guestfish.pod:421
20295 "Commands to execute should be separated by a colon (C<:>), where the colon "
20296 "is a separate parameter. Thus:"
20300 #: ../fish/guestfish.pod:424
20303 " guestfish cmd [args...] : cmd [args...] : cmd [args...] ...\n"
20308 #: ../fish/guestfish.pod:426
20310 "If there are no additional arguments, then we enter a shell, either an "
20311 "interactive shell with a prompt (if the input is a terminal) or a non-"
20312 "interactive shell."
20316 #: ../fish/guestfish.pod:430
20318 "In either command line mode or non-interactive shell, the first command that "
20319 "gives an error causes the whole shell to exit. In interactive mode (with a "
20320 "prompt) if a command fails, you can continue to enter commands."
20324 #: ../fish/guestfish.pod:435
20325 msgid "USING launch (OR run)"
20329 #: ../fish/guestfish.pod:437
20331 "As with L<guestfs(3)>, you must first configure your guest by adding disks, "
20332 "then launch it, then mount any disks you need, and finally issue actions/"
20333 "commands. So the general order of the day is:"
20337 #: ../fish/guestfish.pod:445
20338 msgid "add or -a/--add"
20342 #: ../fish/guestfish.pod:449
20343 msgid "launch (aka run)"
20347 #: ../fish/guestfish.pod:453
20348 msgid "mount or -m/--mount"
20352 #: ../fish/guestfish.pod:457
20353 msgid "any other commands"
20357 #: ../fish/guestfish.pod:461
20359 "C<run> is a synonym for C<launch>. You must C<launch> (or C<run>) your "
20360 "guest before mounting or performing any other commands."
20364 #: ../fish/guestfish.pod:464
20366 "The only exception is that if any of the I<-i>, I<-m>, I<--mount>, I<-N> or "
20367 "I<--new> options were given then C<run> is done automatically, simply "
20368 "because guestfish can't perform the action you asked for without doing this."
20372 #: ../fish/guestfish.pod:469
20373 msgid "OPENING DISKS FOR READ AND WRITE"
20377 #: ../fish/guestfish.pod:471
20379 "The guestfish, L<guestmount(1)> and L<virt-rescue(1)> options I<--ro> and "
20380 "I<--rw> affect whether the other command line options I<-a>, I<-c>, I<-d>, "
20381 "I<-i> and I<-m> open disk images read-only or for writing."
20385 #: ../fish/guestfish.pod:476
20387 "In libguestfs E<le> 1.10, guestfish, guestmount and virt-rescue defaulted to "
20388 "opening disk images supplied on the command line for write. To open a disk "
20389 "image read-only you have to do I<-a image --ro>."
20393 #: ../fish/guestfish.pod:480
20395 "This matters: If you accidentally open a live VM disk image writable then "
20396 "you will cause irreversible disk corruption."
20400 #: ../fish/guestfish.pod:483
20402 "By libguestfs 1.12 we intend to change the default the other way. Disk "
20403 "images will be opened read-only. You will have to either specify "
20404 "I<guestfish --rw>, I<guestmount --rw>, I<virt-rescue --rw>, or change the "
20405 "configuration file C</etc/libguestfs-tools.conf> in order to get write "
20406 "access for disk images specified by those other command line options."
20410 #: ../fish/guestfish.pod:490
20412 "This version of guestfish, guestmount and virt-rescue has a I<--rw> option "
20413 "which does nothing (it is already the default). However it is highly "
20414 "recommended that you use this option to indicate that you need write access, "
20415 "and prepare your scripts for the day when this option will be required for "
20420 #: ../fish/guestfish.pod:496
20422 "B<Note:> This does I<not> affect commands like L</add> and L</mount>, or any "
20423 "other libguestfs program apart from guestfish and guestmount."
20427 #: ../fish/guestfish.pod:499
20432 #: ../fish/guestfish.pod:501
20434 "You can quote ordinary parameters using either single or double quotes. For "
20439 #: ../fish/guestfish.pod:504
20442 " add \"file with a space.img\"\n"
20447 #: ../fish/guestfish.pod:506
20450 " rm '/file name'\n"
20455 #: ../fish/guestfish.pod:508
20463 #: ../fish/guestfish.pod:510
20465 "A few commands require a list of strings to be passed. For these, use a "
20466 "whitespace-separated list, enclosed in quotes. Strings containing "
20467 "whitespace to be passed through must be enclosed in single quotes. A "
20468 "literal single quote must be escaped with a backslash."
20472 #: ../fish/guestfish.pod:515
20475 " vgcreate VG \"/dev/sda1 /dev/sdb1\"\n"
20476 " command \"/bin/echo 'foo bar'\"\n"
20477 " command \"/bin/echo \\'foo\\'\"\n"
20482 #: ../fish/guestfish.pod:519
20483 msgid "OPTIONAL ARGUMENTS"
20487 #: ../fish/guestfish.pod:521
20489 "Some commands take optional arguments. These arguments appear in this "
20490 "documentation as C<[argname:..]>. You can use them as in these examples:"
20494 #: ../fish/guestfish.pod:525
20497 " add-drive-opts filename\n"
20502 #: ../fish/guestfish.pod:527
20505 " add-drive-opts filename readonly:true\n"
20510 #: ../fish/guestfish.pod:529
20513 " add-drive-opts filename format:qcow2 readonly:false\n"
20518 #: ../fish/guestfish.pod:531
20520 "Each optional argument can appear at most once. All optional arguments must "
20521 "appear after the required ones."
20525 #: ../fish/guestfish.pod:534
20530 #: ../fish/guestfish.pod:536
20532 "This section applies to all commands which can take integers as parameters."
20536 #: ../fish/guestfish.pod:539
20537 msgid "SIZE SUFFIX"
20541 #: ../fish/guestfish.pod:541
20543 "When the command takes a parameter measured in bytes, you can use one of the "
20544 "following suffixes to specify kilobytes, megabytes and larger sizes:"
20548 #: ../fish/guestfish.pod:547
20549 msgid "B<k> or B<K> or B<KiB>"
20553 #: ../fish/guestfish.pod:549
20554 msgid "The size in kilobytes (multiplied by 1024)."
20558 #: ../fish/guestfish.pod:551
20563 #: ../fish/guestfish.pod:553
20564 msgid "The size in SI 1000 byte units."
20568 #: ../fish/guestfish.pod:555
20569 msgid "B<M> or B<MiB>"
20573 #: ../fish/guestfish.pod:557
20574 msgid "The size in megabytes (multiplied by 1048576)."
20578 #: ../fish/guestfish.pod:559
20583 #: ../fish/guestfish.pod:561
20584 msgid "The size in SI 1000000 byte units."
20588 #: ../fish/guestfish.pod:563
20589 msgid "B<G> or B<GiB>"
20593 #: ../fish/guestfish.pod:565
20594 msgid "The size in gigabytes (multiplied by 2**30)."
20598 #: ../fish/guestfish.pod:567
20603 #: ../fish/guestfish.pod:569
20604 msgid "The size in SI 10**9 byte units."
20608 #: ../fish/guestfish.pod:571
20609 msgid "B<T> or B<TiB>"
20613 #: ../fish/guestfish.pod:573
20614 msgid "The size in terabytes (multiplied by 2**40)."
20618 #: ../fish/guestfish.pod:575
20623 #: ../fish/guestfish.pod:577
20624 msgid "The size in SI 10**12 byte units."
20628 #: ../fish/guestfish.pod:579
20629 msgid "B<P> or B<PiB>"
20633 #: ../fish/guestfish.pod:581
20634 msgid "The size in petabytes (multiplied by 2**50)."
20638 #: ../fish/guestfish.pod:583
20643 #: ../fish/guestfish.pod:585
20644 msgid "The size in SI 10**15 byte units."
20648 #: ../fish/guestfish.pod:587
20649 msgid "B<E> or B<EiB>"
20653 #: ../fish/guestfish.pod:589
20654 msgid "The size in exabytes (multiplied by 2**60)."
20658 #: ../fish/guestfish.pod:591
20663 #: ../fish/guestfish.pod:593
20664 msgid "The size in SI 10**18 byte units."
20668 #: ../fish/guestfish.pod:595
20669 msgid "B<Z> or B<ZiB>"
20673 #: ../fish/guestfish.pod:597
20674 msgid "The size in zettabytes (multiplied by 2**70)."
20678 #: ../fish/guestfish.pod:599
20683 #: ../fish/guestfish.pod:601
20684 msgid "The size in SI 10**21 byte units."
20688 #: ../fish/guestfish.pod:603
20689 msgid "B<Y> or B<YiB>"
20693 #: ../fish/guestfish.pod:605
20694 msgid "The size in yottabytes (multiplied by 2**80)."
20698 #: ../fish/guestfish.pod:607
20703 #: ../fish/guestfish.pod:609
20704 msgid "The size in SI 10**24 byte units."
20708 #: ../fish/guestfish.pod:615
20711 " truncate-size /file 1G\n"
20716 #: ../fish/guestfish.pod:617
20717 msgid "would truncate the file to 1 gigabyte."
20721 #: ../fish/guestfish.pod:619
20723 "Be careful because a few commands take sizes in kilobytes or megabytes (eg. "
20724 "the parameter to L</memsize> is specified in megabytes already). Adding a "
20725 "suffix will probably not do what you expect."
20729 #: ../fish/guestfish.pod:623
20730 msgid "OCTAL AND HEXADECIMAL NUMBERS"
20734 #: ../fish/guestfish.pod:625
20736 "For specifying the radix (base) use the C convention: C<0> to prefix an "
20737 "octal number or C<0x> to prefix a hexadecimal number. For example:"
20741 #: ../fish/guestfish.pod:628
20744 " 1234 decimal number 1234\n"
20745 " 02322 octal number, equivalent to decimal 1234\n"
20746 " 0x4d2 hexadecimal number, equivalent to decimal 1234\n"
20751 #: ../fish/guestfish.pod:632
20753 "When using the C<chmod> command, you almost always want to specify an octal "
20754 "number for the mode, and you must prefix it with C<0> (unlike the Unix "
20755 "L<chmod(1)> program):"
20759 #: ../fish/guestfish.pod:636
20762 " chmod 0777 /public # OK\n"
20763 " chmod 777 /public # WRONG! This is mode 777 decimal = 01411 octal.\n"
20768 #: ../fish/guestfish.pod:639
20770 "Commands that return numbers usually print them in decimal, but some "
20771 "commands print numbers in other radices (eg. C<umask> prints the mode in "
20772 "octal, preceeded by C<0>)."
20776 #: ../fish/guestfish.pod:643
20777 msgid "WILDCARDS AND GLOBBING"
20781 #: ../fish/guestfish.pod:645
20783 "Neither guestfish nor the underlying guestfs API performs wildcard expansion "
20784 "(globbing) by default. So for example the following will not do what you "
20789 #: ../fish/guestfish.pod:649
20797 #: ../fish/guestfish.pod:651
20799 "Assuming you don't have a directory called literally C</home/*> then the "
20800 "above command will return an error."
20804 #: ../fish/guestfish.pod:654
20805 msgid "To perform wildcard expansion, use the C<glob> command."
20809 #: ../fish/guestfish.pod:656
20812 " glob rm-rf /home/*\n"
20817 #: ../fish/guestfish.pod:658
20819 "runs C<rm-rf> on each path that matches (ie. potentially running the command "
20820 "many times), equivalent to:"
20824 #: ../fish/guestfish.pod:661
20827 " rm-rf /home/jim\n"
20828 " rm-rf /home/joe\n"
20829 " rm-rf /home/mary\n"
20834 #: ../fish/guestfish.pod:665
20835 msgid "C<glob> only works on simple guest paths and not on device names."
20839 #: ../fish/guestfish.pod:667
20841 "If you have several parameters, each containing a wildcard, then glob will "
20842 "perform a Cartesian product."
20846 #: ../fish/guestfish.pod:670
20851 #: ../fish/guestfish.pod:672
20853 "Any line which starts with a I<#> character is treated as a comment and "
20854 "ignored. The I<#> can optionally be preceeded by whitespace, but B<not> by "
20855 "a command. For example:"
20859 #: ../fish/guestfish.pod:676
20862 " # this is a comment\n"
20863 " # this is a comment\n"
20864 " foo # NOT a comment\n"
20869 #: ../fish/guestfish.pod:680
20870 msgid "Blank lines are also ignored."
20874 #: ../fish/guestfish.pod:682
20875 msgid "RUNNING COMMANDS LOCALLY"
20879 #: ../fish/guestfish.pod:684
20881 "Any line which starts with a I<!> character is treated as a command sent to "
20882 "the local shell (C</bin/sh> or whatever L<system(3)> uses). For example:"
20886 #: ../fish/guestfish.pod:688
20890 " tgz-out /remote local/remote-data.tar.gz\n"
20895 #: ../fish/guestfish.pod:691
20897 "will create a directory C<local> on the host, and then export the contents "
20898 "of C</remote> on the mounted filesystem to C<local/remote-data.tar.gz>. "
20899 "(See C<tgz-out>)."
20903 #: ../fish/guestfish.pod:695
20905 "To change the local directory, use the C<lcd> command. C<!cd> will have no "
20906 "effect, due to the way that subprocesses work in Unix."
20910 #: ../fish/guestfish.pod:698
20911 msgid "LOCAL COMMANDS WITH INLINE EXECUTION"
20915 #: ../fish/guestfish.pod:700
20917 "If a line starts with I<E<lt>!> then the shell command is executed (as for "
20918 "I<!>), but subsequently any output (stdout) of the shell command is parsed "
20919 "and executed as guestfish commands."
20923 #: ../fish/guestfish.pod:704
20925 "Thus you can use shell script to construct arbitrary guestfish commands "
20926 "which are then parsed by guestfish."
20930 #: ../fish/guestfish.pod:707
20932 "For example it is tedious to create a sequence of files (eg. C</foo.1> "
20933 "through C</foo.100>) using guestfish commands alone. However this is simple "
20934 "if we use a shell script to create the guestfish commands for us:"
20938 #: ../fish/guestfish.pod:712
20941 " <! for n in `seq 1 100`; do echo write /foo.$n $n; done\n"
20946 #: ../fish/guestfish.pod:714
20947 msgid "or with names like C</foo.001>:"
20951 #: ../fish/guestfish.pod:716
20954 " <! for n in `seq 1 100`; do printf \"write /foo.%03d %d\\n\" $n $n; done\n"
20959 #: ../fish/guestfish.pod:718
20961 "When using guestfish interactively it can be helpful to just run the shell "
20962 "script first (ie. remove the initial C<E<lt>> character so it is just an "
20963 "ordinary I<!> local command), see what guestfish commands it would run, and "
20964 "when you are happy with those prepend the C<E<lt>> character to run the "
20965 "guestfish commands for real."
20969 #: ../fish/guestfish.pod:724
20974 #: ../fish/guestfish.pod:726
20976 "Use C<command E<lt>spaceE<gt> | command> to pipe the output of the first "
20977 "command (a guestfish command) to the second command (any host command). For "
20982 #: ../fish/guestfish.pod:730
20985 " cat /etc/passwd | awk -F: '$3 == 0 { print }'\n"
20990 #: ../fish/guestfish.pod:732
20992 "(where C<cat> is the guestfish cat command, but C<awk> is the host awk "
20993 "program). The above command would list all accounts in the guest filesystem "
20994 "which have UID 0, ie. root accounts including backdoors. Other examples:"
20998 #: ../fish/guestfish.pod:737
21001 " hexdump /bin/ls | head\n"
21002 " list-devices | tail -1\n"
21003 " tgz-out / - | tar ztf -\n"
21008 #: ../fish/guestfish.pod:741
21010 "The space before the pipe symbol is required, any space after the pipe "
21011 "symbol is optional. Everything after the pipe symbol is just passed "
21012 "straight to the host shell, so it can contain redirections, globs and "
21013 "anything else that makes sense on the host side."
21017 #: ../fish/guestfish.pod:746
21019 "To use a literal argument which begins with a pipe symbol, you have to quote "
21024 #: ../fish/guestfish.pod:749
21032 #: ../fish/guestfish.pod:751
21033 msgid "HOME DIRECTORIES"
21037 #: ../fish/guestfish.pod:753
21039 "If a parameter starts with the character C<~> then the tilde may be expanded "
21040 "as a home directory path (either C<~> for the current user's home directory, "
21041 "or C<~user> for another user)."
21045 #: ../fish/guestfish.pod:757
21047 "Note that home directory expansion happens for users known I<on the host>, "
21048 "not in the guest filesystem."
21052 #: ../fish/guestfish.pod:760
21054 "To use a literal argument which begins with a tilde, you have to quote it, "
21059 #: ../fish/guestfish.pod:763
21067 #: ../fish/guestfish.pod:767
21069 "Libguestfs has some support for Linux guests encrypted according to the "
21070 "Linux Unified Key Setup (LUKS) standard, which includes nearly all whole "
21071 "disk encryption systems used by modern Linux guests. Currently only LVM-on-"
21072 "LUKS is supported."
21076 #: ../fish/guestfish.pod:772
21077 msgid "Identify encrypted block devices and partitions using L</vfs-type>:"
21081 #: ../fish/guestfish.pod:774
21084 " ><fs> vfs-type /dev/sda2\n"
21090 #: ../fish/guestfish.pod:777
21092 "Then open those devices using L</luks-open>. This creates a device-mapper "
21093 "device called C</dev/mapper/luksdev>."
21097 #: ../fish/guestfish.pod:780
21100 " ><fs> luks-open /dev/sda2 luksdev\n"
21101 " Enter key or passphrase (\"key\"): <enter the passphrase>\n"
21106 #: ../fish/guestfish.pod:783
21108 "Finally you have to tell LVM to scan for volume groups on the newly created "
21113 #: ../fish/guestfish.pod:786
21117 " vg-activate-all true\n"
21122 #: ../fish/guestfish.pod:789
21123 msgid "The logical volume(s) can now be mounted in the usual way."
21127 #: ../fish/guestfish.pod:791
21129 "Before closing a LUKS device you must unmount any logical volumes on it and "
21130 "deactivate the volume groups by calling C<vg-activate false VG> on each "
21131 "one. Then you can close the mapper device:"
21135 #: ../fish/guestfish.pod:795
21138 " vg-activate false /dev/VG\n"
21139 " luks-close /dev/mapper/luksdev\n"
21144 #: ../fish/guestfish.pod:798 ../tools/virt-edit.pl:342
21145 msgid "WINDOWS PATHS"
21149 #: ../fish/guestfish.pod:800
21151 "If a path is prefixed with C<win:> then you can use Windows-style drive "
21152 "letters and paths (with some limitations). The following commands are "
21157 #: ../fish/guestfish.pod:804
21160 " file /WINDOWS/system32/config/system.LOG\n"
21165 #: ../fish/guestfish.pod:806
21168 " file win:\\windows\\system32\\config\\system.log\n"
21173 #: ../fish/guestfish.pod:808
21176 " file WIN:C:\\Windows\\SYSTEM32\\CONFIG\\SYSTEM.LOG\n"
21181 #: ../fish/guestfish.pod:810
21183 "The parameter is rewritten \"behind the scenes\" by looking up the position "
21184 "where the drive is mounted, prepending that to the path, changing all "
21185 "backslash characters to forward slash, then resolving the result using L</"
21186 "case-sensitive-path>. For example if the E: drive was mounted on C</e> then "
21187 "the parameter might be rewritten like this:"
21191 #: ../fish/guestfish.pod:816
21194 " win:e:\\foo\\bar => /e/FOO/bar\n"
21199 #: ../fish/guestfish.pod:818
21200 msgid "This only works in argument positions that expect a path."
21204 #: ../fish/guestfish.pod:820
21205 msgid "UPLOADING AND DOWNLOADING FILES"
21209 #: ../fish/guestfish.pod:822
21211 "For commands such as C<upload>, C<download>, C<tar-in>, C<tar-out> and "
21212 "others which upload from or download to a local file, you can use the "
21213 "special filename C<-> to mean \"from stdin\" or \"to stdout\". For example:"
21217 #: ../fish/guestfish.pod:826
21225 #: ../fish/guestfish.pod:828
21227 "reads stdin and creates from that a file C</foo> in the disk image, and:"
21231 #: ../fish/guestfish.pod:831
21234 " tar-out /etc - | tar tf -\n"
21239 #: ../fish/guestfish.pod:833
21241 "writes the tarball to stdout and then pipes that into the external \"tar\" "
21242 "command (see L</PIPES>)."
21246 #: ../fish/guestfish.pod:836
21248 "When using C<-> to read from stdin, the input is read up to the end of "
21249 "stdin. You can also use a special \"heredoc\"-like syntax to read up to "
21250 "some arbitrary end marker:"
21254 #: ../fish/guestfish.pod:840
21257 " upload -<<END /foo\n"
21266 #: ../fish/guestfish.pod:846
21268 "Any string of characters can be used instead of C<END>. The end marker must "
21269 "appear on a line of its own, without any preceeding or following characters "
21270 "(not even spaces)."
21274 #: ../fish/guestfish.pod:850
21276 "Note that the C<-E<lt>E<lt>> syntax only applies to parameters used to "
21277 "upload local files (so-called \"FileIn\" parameters in the generator)."
21281 #: ../fish/guestfish.pod:853
21282 msgid "EXIT ON ERROR BEHAVIOUR"
21286 #: ../fish/guestfish.pod:855
21288 "By default, guestfish will ignore any errors when in interactive mode (ie. "
21289 "taking commands from a human over a tty), and will exit on the first error "
21290 "in non-interactive mode (scripts, commands given on the command line)."
21294 #: ../fish/guestfish.pod:860
21296 "If you prefix a command with a I<-> character, then that command will not "
21297 "cause guestfish to exit, even if that (one) command returns an error."
21301 #: ../fish/guestfish.pod:864
21302 msgid "REMOTE CONTROL GUESTFISH OVER A SOCKET"
21306 #: ../fish/guestfish.pod:866
21308 "Guestfish can be remote-controlled over a socket. This is useful "
21309 "particularly in shell scripts where you want to make several different "
21310 "changes to a filesystem, but you don't want the overhead of starting up a "
21311 "guestfish process each time."
21315 #: ../fish/guestfish.pod:871
21316 msgid "Start a guestfish server process using:"
21320 #: ../fish/guestfish.pod:873
21323 " eval \"`guestfish --listen`\"\n"
21328 #: ../fish/guestfish.pod:875
21329 msgid "and then send it commands by doing:"
21333 #: ../fish/guestfish.pod:877
21336 " guestfish --remote cmd [...]\n"
21341 #: ../fish/guestfish.pod:879
21342 msgid "To cause the server to exit, send it the exit command:"
21346 #: ../fish/guestfish.pod:881
21349 " guestfish --remote exit\n"
21354 #: ../fish/guestfish.pod:883
21356 "Note that the server will normally exit if there is an error in a command. "
21357 "You can change this in the usual way. See section L</EXIT ON ERROR "
21362 #: ../fish/guestfish.pod:887
21363 msgid "CONTROLLING MULTIPLE GUESTFISH PROCESSES"
21367 #: ../fish/guestfish.pod:889
21369 "The C<eval> statement sets the environment variable C<$GUESTFISH_PID>, which "
21370 "is how the I<--remote> option knows where to send the commands. You can "
21371 "have several guestfish listener processes running using:"
21375 #: ../fish/guestfish.pod:893
21378 " eval \"`guestfish --listen`\"\n"
21379 " pid1=$GUESTFISH_PID\n"
21380 " eval \"`guestfish --listen`\"\n"
21381 " pid2=$GUESTFISH_PID\n"
21383 " guestfish --remote=$pid1 cmd\n"
21384 " guestfish --remote=$pid2 cmd\n"
21389 #: ../fish/guestfish.pod:901
21390 msgid "REMOTE CONTROL AND CSH"
21394 #: ../fish/guestfish.pod:903
21396 "When using csh-like shells (csh, tcsh etc) you have to add the I<--csh> "
21401 #: ../fish/guestfish.pod:906
21404 " eval \"`guestfish --listen --csh`\"\n"
21409 #: ../fish/guestfish.pod:908
21410 msgid "REMOTE CONTROL DETAILS"
21414 #: ../fish/guestfish.pod:910
21416 "Remote control happens over a Unix domain socket called C</tmp/.guestfish-"
21417 "$UID/socket-$PID>, where C<$UID> is the effective user ID of the process, "
21418 "and C<$PID> is the process ID of the server."
21422 #: ../fish/guestfish.pod:914
21423 msgid "Guestfish client and server versions must match exactly."
21427 #: ../fish/guestfish.pod:916
21428 msgid "PREPARED DISK IMAGES"
21432 #: ../fish/guestfish.pod:918
21434 "Use the I<-N type> or I<--new type> parameter to select one of a set of "
21435 "preformatted disk images that guestfish can make for you to save typing. "
21436 "This is particularly useful for testing purposes. This option is used "
21437 "instead of the I<-a> option, and like I<-a> can appear multiple times (and "
21438 "can be mixed with I<-a>)."
21442 #: ../fish/guestfish.pod:924
21444 "The new disk is called C<test1.img> for the first I<-N>, C<test2.img> for "
21445 "the second and so on. Existing files in the current directory are "
21450 #: ../fish/guestfish.pod:928
21452 "The type briefly describes how the disk should be sized, partitioned, how "
21453 "filesystem(s) should be created, and how content should be added. "
21454 "Optionally the type can be followed by extra parameters, separated by C<:> "
21455 "(colon) characters. For example, I<-N fs> creates a default 100MB, sparsely-"
21456 "allocated disk, containing a single partition, with the partition formatted "
21457 "as ext2. I<-N fs:ext4:1G> is the same, but for an ext4 filesystem on a 1GB "
21462 #: ../fish/guestfish.pod:936
21463 msgid "To list the available types and any extra parameters they take, run:"
21467 #: ../fish/guestfish.pod:940
21469 "Note that the prepared filesystem is not mounted. You would usually have to "
21470 "use the C<mount /dev/sda1 /> command or add the I<-m /dev/sda1> option."
21474 #: ../fish/guestfish.pod:944
21476 "If any I<-N> or I<--new> options are given, the guest is automatically "
21481 #: ../fish/guestfish.pod:949
21482 msgid "Create a 100MB disk with an ext4-formatted partition:"
21486 #: ../fish/guestfish.pod:951
21489 " guestfish -N fs:ext4\n"
21494 #: ../fish/guestfish.pod:953
21495 msgid "Create a 32MB disk with a VFAT-formatted partition, and mount it:"
21499 #: ../fish/guestfish.pod:955
21502 " guestfish -N fs:vfat:32M -m /dev/sda1\n"
21507 #: ../fish/guestfish.pod:957
21508 msgid "Create a blank 200MB disk:"
21512 #: ../fish/guestfish.pod:959
21515 " guestfish -N disk:200M\n"
21520 #: ../fish/guestfish.pod:961
21521 msgid "PROGRESS BARS"
21525 #: ../fish/guestfish.pod:963
21527 "Some (not all) long-running commands send progress notification messages as "
21528 "they are running. Guestfish turns these messages into progress bars."
21532 #: ../fish/guestfish.pod:967
21534 "When a command that supports progress bars takes longer than two seconds to "
21535 "run, and if progress bars are enabled, then you will see one appearing below "
21540 #: ../fish/guestfish.pod:971
21543 " ><fs> copy-size /large-file /another-file 2048M\n"
21544 " / 10% [#####-----------------------------------------] 00:30\n"
21549 #: ../fish/guestfish.pod:974
21551 "The spinner on the left hand side moves round once for every progress "
21552 "notification received from the backend. This is a (reasonably) golden "
21553 "assurance that the command is \"doing something\" even if the progress bar "
21554 "is not moving, because the command is able to send the progress "
21555 "notifications. When the bar reaches 100% and the command finishes, the "
21556 "spinner disappears."
21560 #: ../fish/guestfish.pod:981
21562 "Progress bars are enabled by default when guestfish is used interactively. "
21563 "You can enable them even for non-interactive modes using I<--progress-bars>, "
21564 "and you can disable them completely using I<--no-progress-bars>."
21568 #: ../fish/guestfish.pod:986
21569 msgid "GUESTFISH COMMANDS"
21573 #: ../fish/guestfish.pod:988
21575 "The commands in this section are guestfish convenience commands, in other "
21576 "words, they are not part of the L<guestfs(3)> API."
21580 #: ../fish/guestfish.pod:991
21585 #: ../fish/guestfish.pod:993
21594 #: ../fish/guestfish.pod:996
21595 msgid "Without any parameter, this provides general help."
21599 #: ../fish/guestfish.pod:998
21600 msgid "With a C<cmd> parameter, this displays detailed help for that command."
21604 #: ../fish/guestfish.pod:1000
21605 msgid "quit | exit"
21609 #: ../fish/guestfish.pod:1002
21610 msgid "This exits guestfish. You can also use C<^D> key."
21614 #: ../fish/guestfish.pod:1004
21615 msgid "@FISH_COMMANDS@"
21619 #: ../fish/guestfish.pod:1006
21624 #: ../fish/guestfish.pod:1010 ../test-tool/libguestfs-test-tool.pod:77
21629 #: ../fish/guestfish.pod:1012
21631 "guestfish returns 0 if the commands completed without error, or 1 if there "
21636 #: ../fish/guestfish.pod:1019
21641 #: ../fish/guestfish.pod:1021
21643 "The C<edit> command uses C<$EDITOR> as the editor. If not set, it uses "
21648 #: ../fish/guestfish.pod:1024
21649 msgid "GUESTFISH_PID"
21653 #: ../fish/guestfish.pod:1026
21655 "Used with the I<--remote> option to specify the remote guestfish process to "
21656 "control. See section L</REMOTE CONTROL GUESTFISH OVER A SOCKET>."
21660 #: ../fish/guestfish.pod:1030
21665 #: ../fish/guestfish.pod:1032
21667 "The L</hexedit> command uses C<$HEXEDITOR> as the external hex editor. If "
21668 "not specified, the external L<hexedit(1)> program is used."
21672 #: ../fish/guestfish.pod:1036
21677 #: ../fish/guestfish.pod:1038
21679 "If compiled with GNU readline support, various files in the home directory "
21680 "can be used. See L</FILES>."
21684 #: ../fish/guestfish.pod:1047
21686 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
21687 "effect as using the B<-v> option."
21691 #: ../fish/guestfish.pod:1059
21693 "Set the path that guestfish uses to search for kernel and initrd.img. See "
21694 "the discussion of paths in L<guestfs(3)>."
21698 #: ../fish/guestfish.pod:1070
21699 msgid "Set C<LIBGUESTFS_TRACE=1> to enable command traces."
21703 #: ../fish/guestfish.pod:1072
21708 #: ../fish/guestfish.pod:1074
21710 "The C<more> command uses C<$PAGER> as the pager. If not set, it uses "
21715 #: ../fish/guestfish.pod:1090 ../fuse/guestmount.pod:262
21720 #: ../fish/guestfish.pod:1094 ../fuse/guestmount.pod:266
21721 msgid "$HOME/.libguestfs-tools.rc"
21725 #: ../fish/guestfish.pod:1096 ../fuse/guestmount.pod:268
21726 msgid "/etc/libguestfs-tools.conf"
21730 #: ../fish/guestfish.pod:1098 ../fuse/guestmount.pod:270
21732 "This configuration file controls the default read-only or read-write mode "
21733 "(I<--ro> or I<--rw>)."
21737 #: ../fish/guestfish.pod:1101
21738 msgid "See L</OPENING DISKS FOR READ AND WRITE>."
21742 #: ../fish/guestfish.pod:1103
21743 msgid "$HOME/.guestfish"
21747 #: ../fish/guestfish.pod:1105
21749 "If compiled with GNU readline support, then the command history is saved in "
21754 #: ../fish/guestfish.pod:1108
21755 msgid "$HOME/.inputrc"
21759 #: ../fish/guestfish.pod:1110
21760 msgid "/etc/inputrc"
21764 #: ../fish/guestfish.pod:1112
21766 "If compiled with GNU readline support, then these files can be used to "
21767 "configure readline. For further information, please see L<readline(3)/"
21768 "INITIALIZATION FILE>."
21772 #: ../fish/guestfish.pod:1116
21773 msgid "To write rules which only apply to guestfish, use:"
21777 #: ../fish/guestfish.pod:1118
21787 #: ../fish/guestfish.pod:1122
21789 "Variables that you can set in inputrc that change the behaviour of guestfish "
21790 "in useful ways include:"
21794 #: ../fish/guestfish.pod:1127
21795 msgid "completion-ignore-case (default: on)"
21799 #: ../fish/guestfish.pod:1129
21801 "By default, guestfish will ignore case when tab-completing paths on the "
21806 #: ../fish/guestfish.pod:1132
21809 " set completion-ignore-case off\n"
21814 #: ../fish/guestfish.pod:1134
21815 msgid "to make guestfish case sensitive."
21819 #: ../fish/guestfish.pod:1138
21824 #: ../fish/guestfish.pod:1140
21825 msgid "test2.img (etc)"
21829 #: ../fish/guestfish.pod:1142
21831 "When using the I<-N> or I<--new> option, the prepared disk or filesystem "
21832 "will be created in the file C<test1.img> in the current directory. The "
21833 "second use of I<-N> will use C<test2.img> and so on. Any existing file with "
21834 "the same name will be overwritten."
21838 #: ../fish/guestfish.pod:1151
21840 "L<guestfs(3)>, L<http://libguestfs.org/>, L<virt-cat(1)>, L<virt-copy-in(1)"
21841 ">, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, L<virt-filesystems(1)"
21842 ">, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, L<virt-list-partitions"
21843 "(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, L<virt-rescue(1)>, L<virt-resize(1)"
21844 ">, L<virt-tar(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<virt-win-reg(1)"
21845 ">, L<hexedit(1)>."
21849 #: ../fish/guestfish.pod:1181 ../test-tool/libguestfs-test-tool.pod:102
21850 #: ../fuse/guestmount.pod:297 ../tools/virt-edit.pl:518
21851 #: ../tools/virt-win-reg.pl:606 ../tools/virt-list-filesystems.pl:210
21852 #: ../tools/virt-tar.pl:309 ../tools/virt-make-fs.pl:572
21853 #: ../tools/virt-list-partitions.pl:277
21855 "This program is free software; you can redistribute it and/or modify it "
21856 "under the terms of the GNU General Public License as published by the Free "
21857 "Software Foundation; either version 2 of the License, or (at your option) "
21858 "any later version."
21862 #: ../fish/guestfish.pod:1186 ../test-tool/libguestfs-test-tool.pod:107
21863 #: ../fuse/guestmount.pod:302 ../tools/virt-edit.pl:523
21864 #: ../tools/virt-win-reg.pl:611 ../tools/virt-list-filesystems.pl:215
21865 #: ../tools/virt-tar.pl:314 ../tools/virt-make-fs.pl:577
21866 #: ../tools/virt-list-partitions.pl:282
21868 "This program is distributed in the hope that it will be useful, but WITHOUT "
21869 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
21870 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for "
21875 #: ../fish/guestfish.pod:1191 ../test-tool/libguestfs-test-tool.pod:112
21876 #: ../fuse/guestmount.pod:307 ../tools/virt-edit.pl:528
21877 #: ../tools/virt-win-reg.pl:616 ../tools/virt-list-filesystems.pl:220
21878 #: ../tools/virt-tar.pl:319 ../tools/virt-make-fs.pl:582
21879 #: ../tools/virt-list-partitions.pl:287
21881 "You should have received a copy of the GNU General Public License along with "
21882 "this program; if not, write to the Free Software Foundation, Inc., 675 Mass "
21883 "Ave, Cambridge, MA 02139, USA."
21887 #: ../fish/guestfish-actions.pod:1
21892 #: ../fish/guestfish-actions.pod:3
21895 " add-cdrom filename\n"
21900 #: ../fish/guestfish-actions.pod:15
21902 "This call checks for the existence of C<filename>. This stops you from "
21903 "specifying other types of drive which are supported by qemu such as C<nbd:> "
21904 "and C<http:> URLs. To specify those, use the general L</config> call "
21909 #: ../fish/guestfish-actions.pod:22
21911 "If you just want to add an ISO file (often you use this as an efficient way "
21912 "to transfer large files into the guest), then you should probably use L</add-"
21913 "drive-ro> instead."
21917 #: ../fish/guestfish-actions.pod:28 ../fish/guestfish-actions.pod:158
21918 #: ../fish/guestfish-actions.pod:172
21920 "This function is deprecated. In new code, use the L</add_drive_opts> call "
21925 #: ../fish/guestfish-actions.pod:35
21930 #: ../fish/guestfish-actions.pod:37
21935 #: ../fish/guestfish-actions.pod:39
21938 " add-domain dom [libvirturi:..] [readonly:..] [iface:..] [live:..]\n"
21943 #: ../fish/guestfish-actions.pod:41
21945 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
21946 "It works by connecting to libvirt, requesting the domain and domain XML from "
21947 "libvirt, parsing it for disks, and calling L</add-drive-opts> on each one."
21951 #: ../fish/guestfish-actions.pod:71
21953 "The other optional parameters are passed directly through to L</add-drive-"
21958 #: ../fish/guestfish-actions.pod:74 ../fish/guestfish-actions.pod:138
21959 #: ../fish/guestfish-actions.pod:3044
21961 "This command has one or more optional arguments. See L</OPTIONAL ARGUMENTS>."
21965 #: ../fish/guestfish-actions.pod:76
21970 #: ../fish/guestfish-actions.pod:78
21973 " add-drive filename\n"
21978 #: ../fish/guestfish-actions.pod:80
21980 "This function is the equivalent of calling L</add-drive-opts> with no "
21981 "optional parameters, so the disk is added writable, with the format being "
21982 "detected automatically."
21986 #: ../fish/guestfish-actions.pod:84
21988 "Automatic detection of the format opens you up to a potential security hole "
21989 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
21990 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
21991 "you should think about replacing calls to this function with calls to L</add-"
21992 "drive-opts>, and specifying the format."
21996 #: ../fish/guestfish-actions.pod:91
21997 msgid "add-drive-opts"
22001 #: ../fish/guestfish-actions.pod:93
22006 #: ../fish/guestfish-actions.pod:95
22009 " add-drive-opts filename [readonly:..] [format:..] [iface:..]\n"
22014 #: ../fish/guestfish-actions.pod:122
22016 "This forces the image format. If you omit this (or use L</add-drive> or L</"
22017 "add-drive-ro>) then the format is automatically detected. Possible formats "
22018 "include C<raw> and C<qcow2>."
22022 #: ../fish/guestfish-actions.pod:133
22024 "This rarely-used option lets you emulate the behaviour of the deprecated L</"
22025 "add-drive-with-if> call (q.v.)"
22029 #: ../fish/guestfish-actions.pod:140
22030 msgid "add-drive-ro"
22034 #: ../fish/guestfish-actions.pod:142
22039 #: ../fish/guestfish-actions.pod:144
22042 " add-drive-ro filename\n"
22047 #: ../fish/guestfish-actions.pod:146
22049 "This function is the equivalent of calling L</add-drive-opts> with the "
22050 "optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the disk "
22051 "is added read-only, with the format being detected automatically."
22055 #: ../fish/guestfish-actions.pod:151
22056 msgid "add-drive-ro-with-if"
22060 #: ../fish/guestfish-actions.pod:153
22063 " add-drive-ro-with-if filename iface\n"
22068 #: ../fish/guestfish-actions.pod:155
22070 "This is the same as L</add-drive-ro> but it allows you to specify the QEMU "
22071 "interface emulation to use at run time."
22075 #: ../fish/guestfish-actions.pod:165
22076 msgid "add-drive-with-if"
22080 #: ../fish/guestfish-actions.pod:167
22083 " add-drive-with-if filename iface\n"
22088 #: ../fish/guestfish-actions.pod:169
22090 "This is the same as L</add-drive> but it allows you to specify the QEMU "
22091 "interface emulation to use at run time."
22095 #: ../fish/guestfish-actions.pod:179
22100 #: ../fish/guestfish-actions.pod:181
22103 " aug-clear augpath\n"
22108 #: ../fish/guestfish-actions.pod:186
22113 #: ../fish/guestfish-actions.pod:188
22121 #: ../fish/guestfish-actions.pod:190
22123 "Close the current Augeas handle and free up any resources used by it. After "
22124 "calling this, you have to call L</aug-init> again before you can use any "
22125 "other Augeas functions."
22129 #: ../fish/guestfish-actions.pod:195
22130 msgid "aug-defnode"
22134 #: ../fish/guestfish-actions.pod:197
22137 " aug-defnode name expr val\n"
22142 #: ../fish/guestfish-actions.pod:202
22144 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
22145 "calling L</aug-set> C<expr>, C<value>. C<name> will be the nodeset "
22146 "containing that single node."
22150 #: ../fish/guestfish-actions.pod:210
22155 #: ../fish/guestfish-actions.pod:212
22158 " aug-defvar name expr\n"
22163 #: ../fish/guestfish-actions.pod:221
22168 #: ../fish/guestfish-actions.pod:223
22171 " aug-get augpath\n"
22176 #: ../fish/guestfish-actions.pod:228
22181 #: ../fish/guestfish-actions.pod:230
22184 " aug-init root flags\n"
22189 #: ../fish/guestfish-actions.pod:236
22190 msgid "You must call this before using any other L</aug-*> commands."
22194 #: ../fish/guestfish-actions.pod:271
22195 msgid "Do not load the tree in L</aug-init>."
22199 #: ../fish/guestfish-actions.pod:275
22200 msgid "To close the handle, you can call L</aug-close>."
22204 #: ../fish/guestfish-actions.pod:279
22209 #: ../fish/guestfish-actions.pod:281
22212 " aug-insert augpath label true|false\n"
22217 #: ../fish/guestfish-actions.pod:291
22222 #: ../fish/guestfish-actions.pod:293
22230 #: ../fish/guestfish-actions.pod:300
22235 #: ../fish/guestfish-actions.pod:302
22238 " aug-ls augpath\n"
22243 #: ../fish/guestfish-actions.pod:304
22245 "This is just a shortcut for listing L</aug-match> C<path/*> and sorting the "
22246 "resulting nodes into alphabetical order."
22250 #: ../fish/guestfish-actions.pod:307
22255 #: ../fish/guestfish-actions.pod:309
22258 " aug-match augpath\n"
22263 #: ../fish/guestfish-actions.pod:315
22268 #: ../fish/guestfish-actions.pod:317
22271 " aug-mv src dest\n"
22276 #: ../fish/guestfish-actions.pod:322
22281 #: ../fish/guestfish-actions.pod:324
22284 " aug-rm augpath\n"
22289 #: ../fish/guestfish-actions.pod:330
22294 #: ../fish/guestfish-actions.pod:332
22302 #: ../fish/guestfish-actions.pod:336
22304 "The flags which were passed to L</aug-init> affect exactly how files are "
22309 #: ../fish/guestfish-actions.pod:339
22314 #: ../fish/guestfish-actions.pod:341
22317 " aug-set augpath val\n"
22322 #: ../fish/guestfish-actions.pod:345
22324 "In the Augeas API, it is possible to clear a node by setting the value to "
22325 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
22326 "this call. Instead you must use the L</aug-clear> call."
22330 #: ../fish/guestfish-actions.pod:350
22335 #: ../fish/guestfish-actions.pod:352
22338 " available 'groups ...'\n"
22343 #: ../fish/guestfish-actions.pod:358
22345 "The libguestfs groups, and the functions that those groups correspond to, "
22346 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
22347 "runtime by calling L</available-all-groups>."
22351 #: ../fish/guestfish-actions.pod:382
22352 msgid "You must call L</launch> before calling this function."
22356 #: ../fish/guestfish-actions.pod:404
22358 "This call was added in version C<1.0.80>. In previous versions of "
22359 "libguestfs all you could do would be to speculatively execute a command to "
22360 "find out if the daemon implemented it. See also L</version>."
22364 #: ../fish/guestfish-actions.pod:411
22365 msgid "available-all-groups"
22369 #: ../fish/guestfish-actions.pod:413
22372 " available-all-groups\n"
22377 #: ../fish/guestfish-actions.pod:415
22379 "This command returns a list of all optional groups that this daemon knows "
22380 "about. Note this returns both supported and unsupported groups. To find "
22381 "out which ones the daemon can actually support you have to call L</"
22382 "available> on each member of the returned list."
22386 #: ../fish/guestfish-actions.pod:421
22387 msgid "See also L</available> and L<guestfs(3)/AVAILABILITY>."
22391 #: ../fish/guestfish-actions.pod:423
22396 #: ../fish/guestfish-actions.pod:425
22399 " base64-in (base64file|-) filename\n"
22404 #: ../fish/guestfish-actions.pod:430 ../fish/guestfish-actions.pod:439
22405 #: ../fish/guestfish-actions.pod:663 ../fish/guestfish-actions.pod:832
22406 #: ../fish/guestfish-actions.pod:851 ../fish/guestfish-actions.pod:1225
22407 #: ../fish/guestfish-actions.pod:4486 ../fish/guestfish-actions.pod:4498
22408 #: ../fish/guestfish-actions.pod:4509 ../fish/guestfish-actions.pod:4520
22409 #: ../fish/guestfish-actions.pod:4572 ../fish/guestfish-actions.pod:4581
22410 #: ../fish/guestfish-actions.pod:4635 ../fish/guestfish-actions.pod:4658
22411 msgid "Use C<-> instead of a filename to read/write from stdin/stdout."
22415 #: ../fish/guestfish-actions.pod:432
22420 #: ../fish/guestfish-actions.pod:434
22423 " base64-out filename (base64file|-)\n"
22428 #: ../fish/guestfish-actions.pod:441
22429 msgid "blockdev-flushbufs"
22433 #: ../fish/guestfish-actions.pod:443
22436 " blockdev-flushbufs device\n"
22441 #: ../fish/guestfish-actions.pod:450
22442 msgid "blockdev-getbsz"
22446 #: ../fish/guestfish-actions.pod:452
22449 " blockdev-getbsz device\n"
22454 #: ../fish/guestfish-actions.pod:461
22455 msgid "blockdev-getro"
22459 #: ../fish/guestfish-actions.pod:463
22462 " blockdev-getro device\n"
22467 #: ../fish/guestfish-actions.pod:470
22468 msgid "blockdev-getsize64"
22472 #: ../fish/guestfish-actions.pod:472
22475 " blockdev-getsize64 device\n"
22480 #: ../fish/guestfish-actions.pod:476
22481 msgid "See also L</blockdev-getsz>."
22485 #: ../fish/guestfish-actions.pod:480
22486 msgid "blockdev-getss"
22490 #: ../fish/guestfish-actions.pod:482
22493 " blockdev-getss device\n"
22498 #: ../fish/guestfish-actions.pod:487
22500 "(Note, this is not the size in sectors, use L</blockdev-getsz> for that)."
22504 #: ../fish/guestfish-actions.pod:492
22505 msgid "blockdev-getsz"
22509 #: ../fish/guestfish-actions.pod:494
22512 " blockdev-getsz device\n"
22517 #: ../fish/guestfish-actions.pod:499
22519 "See also L</blockdev-getss> for the real sector size of the device, and L</"
22520 "blockdev-getsize64> for the more useful I<size in bytes>."
22524 #: ../fish/guestfish-actions.pod:505
22525 msgid "blockdev-rereadpt"
22529 #: ../fish/guestfish-actions.pod:507
22532 " blockdev-rereadpt device\n"
22537 #: ../fish/guestfish-actions.pod:513
22538 msgid "blockdev-setbsz"
22542 #: ../fish/guestfish-actions.pod:515
22545 " blockdev-setbsz device blocksize\n"
22550 #: ../fish/guestfish-actions.pod:524
22551 msgid "blockdev-setro"
22555 #: ../fish/guestfish-actions.pod:526
22558 " blockdev-setro device\n"
22563 #: ../fish/guestfish-actions.pod:532
22564 msgid "blockdev-setrw"
22568 #: ../fish/guestfish-actions.pod:534
22571 " blockdev-setrw device\n"
22576 #: ../fish/guestfish-actions.pod:540
22577 msgid "case-sensitive-path"
22581 #: ../fish/guestfish-actions.pod:542
22584 " case-sensitive-path path\n"
22589 #: ../fish/guestfish-actions.pod:566
22591 "Thus L</case-sensitive-path> (\"/Windows/System32\") might return C<\"/"
22592 "WINDOWS/system32\"> (the exact return value would depend on details of how "
22593 "the directories were originally created under Windows)."
22597 #: ../fish/guestfish-actions.pod:574
22598 msgid "See also L</realpath>."
22602 #: ../fish/guestfish-actions.pod:576
22607 #: ../fish/guestfish-actions.pod:578
22615 #: ../fish/guestfish-actions.pod:582
22617 "Note that this function cannot correctly handle binary files (specifically, "
22618 "files containing C<\\0> character which is treated as end of string). For "
22619 "those you need to use the L</read-file> or L</download> functions which have "
22620 "a more complex interface."
22624 #: ../fish/guestfish-actions.pod:590
22629 #: ../fish/guestfish-actions.pod:592
22632 " checksum csumtype path\n"
22637 #: ../fish/guestfish-actions.pod:635
22638 msgid "To get the checksum for a device, use L</checksum-device>."
22642 #: ../fish/guestfish-actions.pod:637
22643 msgid "To get the checksums for many files, use L</checksums-out>."
22647 #: ../fish/guestfish-actions.pod:639
22648 msgid "checksum-device"
22652 #: ../fish/guestfish-actions.pod:641
22655 " checksum-device csumtype device\n"
22660 #: ../fish/guestfish-actions.pod:643
22662 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
22663 "device named C<device>. For the types of checksums supported see the L</"
22664 "checksum> command."
22668 #: ../fish/guestfish-actions.pod:647
22669 msgid "checksums-out"
22673 #: ../fish/guestfish-actions.pod:649
22676 " checksums-out csumtype directory (sumsfile|-)\n"
22681 #: ../fish/guestfish-actions.pod:665
22686 #: ../fish/guestfish-actions.pod:667
22689 " chmod mode path\n"
22694 #: ../fish/guestfish-actions.pod:678
22699 #: ../fish/guestfish-actions.pod:680
22702 " chown owner group path\n"
22707 #: ../fish/guestfish-actions.pod:688
22712 #: ../fish/guestfish-actions.pod:690
22715 " command 'arguments ...'\n"
22720 #: ../fish/guestfish-actions.pod:697
22722 "The single parameter is an argv-style list of arguments. The first element "
22723 "is the name of the program to run. Subsequent elements are parameters. The "
22724 "list must be non-empty (ie. must contain a program name). Note that the "
22725 "command runs directly, and is I<not> invoked via the shell (see L</sh>)."
22729 #: ../fish/guestfish-actions.pod:725
22730 msgid "command-lines"
22734 #: ../fish/guestfish-actions.pod:727
22737 " command-lines 'arguments ...'\n"
22742 #: ../fish/guestfish-actions.pod:729
22744 "This is the same as L</command>, but splits the result into a list of lines."
22748 #: ../fish/guestfish-actions.pod:732
22749 msgid "See also: L</sh-lines>"
22753 #: ../fish/guestfish-actions.pod:737
22758 #: ../fish/guestfish-actions.pod:739
22761 " config qemuparam qemuvalue\n"
22766 #: ../fish/guestfish-actions.pod:750
22771 #: ../fish/guestfish-actions.pod:752
22774 " copy-size src dest size\n"
22779 #: ../fish/guestfish-actions.pod:760
22784 #: ../fish/guestfish-actions.pod:762
22792 #: ../fish/guestfish-actions.pod:767
22797 #: ../fish/guestfish-actions.pod:769
22805 #: ../fish/guestfish-actions.pod:774
22810 #: ../fish/guestfish-actions.pod:776
22818 #: ../fish/guestfish-actions.pod:783
22820 "If the destination is a device, it must be as large or larger than the "
22821 "source file or device, otherwise the copy will fail. This command cannot do "
22822 "partial copies (see L</copy-size>)."
22826 #: ../fish/guestfish-actions.pod:787
22831 #: ../fish/guestfish-actions.pod:789
22839 #: ../fish/guestfish-actions.pod:793 ../fish/guestfish-actions.pod:804
22841 "This command is mostly useful for interactive sessions. It is I<not> "
22842 "intended that you try to parse the output string. Use L</statvfs> from "
22847 #: ../fish/guestfish-actions.pod:797
22852 #: ../fish/guestfish-actions.pod:799
22860 #: ../fish/guestfish-actions.pod:808
22865 #: ../fish/guestfish-actions.pod:810
22873 #: ../fish/guestfish-actions.pod:816
22875 "Another way to get the same information is to enable verbose messages with "
22876 "L</set-verbose> or by setting the environment variable C<LIBGUESTFS_DEBUG=1> "
22877 "before running the program."
22881 #: ../fish/guestfish-actions.pod:821
22886 #: ../fish/guestfish-actions.pod:823
22889 " download remotefilename (filename|-)\n"
22894 #: ../fish/guestfish-actions.pod:830
22895 msgid "See also L</upload>, L</cat>."
22899 #: ../fish/guestfish-actions.pod:834
22900 msgid "download-offset"
22904 #: ../fish/guestfish-actions.pod:836
22907 " download-offset remotefilename (filename|-) offset size\n"
22912 #: ../fish/guestfish-actions.pod:844
22914 "Note that there is no limit on the amount of data that can be downloaded "
22915 "with this call, unlike with L</pread>, and this call always reads the full "
22916 "amount unless an error occurs."
22920 #: ../fish/guestfish-actions.pod:849
22921 msgid "See also L</download>, L</pread>."
22925 #: ../fish/guestfish-actions.pod:853
22926 msgid "drop-caches"
22930 #: ../fish/guestfish-actions.pod:855
22933 " drop-caches whattodrop\n"
22938 #: ../fish/guestfish-actions.pod:867
22943 #: ../fish/guestfish-actions.pod:869
22951 #: ../fish/guestfish-actions.pod:881
22956 #: ../fish/guestfish-actions.pod:883
22959 " e2fsck-f device\n"
22964 #: ../fish/guestfish-actions.pod:889
22966 "This command is only needed because of L</resize2fs> (q.v.). Normally you "
22967 "should use L</fsck>."
22971 #: ../fish/guestfish-actions.pod:892
22972 msgid "echo-daemon"
22976 #: ../fish/guestfish-actions.pod:894
22979 " echo-daemon 'words ...'\n"
22984 #: ../fish/guestfish-actions.pod:901
22985 msgid "See also L</ping-daemon>."
22989 #: ../fish/guestfish-actions.pod:903
22994 #: ../fish/guestfish-actions.pod:905
22997 " egrep regex path\n"
23002 #: ../fish/guestfish-actions.pod:913
23007 #: ../fish/guestfish-actions.pod:915
23010 " egrepi regex path\n"
23015 #: ../fish/guestfish-actions.pod:923
23020 #: ../fish/guestfish-actions.pod:925
23023 " equal file1 file2\n"
23028 #: ../fish/guestfish-actions.pod:932
23033 #: ../fish/guestfish-actions.pod:934
23041 #: ../fish/guestfish-actions.pod:939
23042 msgid "See also L</is-file>, L</is-dir>, L</stat>."
23046 #: ../fish/guestfish-actions.pod:941
23051 #: ../fish/guestfish-actions.pod:943
23054 " fallocate path len\n"
23059 #: ../fish/guestfish-actions.pod:953
23061 "This function is deprecated. In new code, use the L</fallocate64> call "
23066 #: ../fish/guestfish-actions.pod:960
23067 msgid "fallocate64"
23071 #: ../fish/guestfish-actions.pod:962
23074 " fallocate64 path len\n"
23079 #: ../fish/guestfish-actions.pod:968
23081 "Note that this call allocates disk blocks for the file. To create a sparse "
23082 "file use L</truncate-size> instead."
23086 #: ../fish/guestfish-actions.pod:971
23088 "The deprecated call L</fallocate> does the same, but owing to an oversight "
23089 "it only allowed 30 bit lengths to be specified, effectively limiting the "
23090 "maximum size of files created through that call to 1GB."
23094 #: ../fish/guestfish-actions.pod:980
23099 #: ../fish/guestfish-actions.pod:982
23102 " fgrep pattern path\n"
23107 #: ../fish/guestfish-actions.pod:990
23112 #: ../fish/guestfish-actions.pod:992
23115 " fgrepi pattern path\n"
23120 #: ../fish/guestfish-actions.pod:1000
23125 #: ../fish/guestfish-actions.pod:1002
23133 #: ../fish/guestfish-actions.pod:1018
23135 "See also: L<file(1)>, L</vfs-type>, L</lstat>, L</is-file>, L</is-blockdev> "
23140 #: ../fish/guestfish-actions.pod:1021
23141 msgid "file-architecture"
23145 #: ../fish/guestfish-actions.pod:1023
23148 " file-architecture filename\n"
23153 #: ../fish/guestfish-actions.pod:1126
23158 #: ../fish/guestfish-actions.pod:1128
23166 #: ../fish/guestfish-actions.pod:1132
23168 "To get other stats about a file, use L</stat>, L</lstat>, L</is-dir>, L</is-"
23169 "file> etc. To get the size of block devices, use L</blockdev-getsize64>."
23173 #: ../fish/guestfish-actions.pod:1136
23178 #: ../fish/guestfish-actions.pod:1138
23181 " fill c len path\n"
23186 #: ../fish/guestfish-actions.pod:1144
23188 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
23189 "L</truncate-size>. To create a file with a pattern of repeating bytes use "
23190 "L</fill-pattern>."
23194 #: ../fish/guestfish-actions.pod:1149
23195 msgid "fill-pattern"
23199 #: ../fish/guestfish-actions.pod:1151
23202 " fill-pattern pattern len path\n"
23207 #: ../fish/guestfish-actions.pod:1153
23209 "This function is like L</fill> except that it creates a new file of length "
23210 "C<len> containing the repeating pattern of bytes in C<pattern>. The pattern "
23211 "is truncated if necessary to ensure the length of the file is exactly C<len> "
23216 #: ../fish/guestfish-actions.pod:1158
23221 #: ../fish/guestfish-actions.pod:1160
23224 " find directory\n"
23229 #: ../fish/guestfish-actions.pod:1174
23230 msgid "then the returned list from L</find> C</tmp> would be 4 elements:"
23234 #: ../fish/guestfish-actions.pod:1187
23235 msgid "See also L</find0>."
23239 #: ../fish/guestfish-actions.pod:1192
23244 #: ../fish/guestfish-actions.pod:1194
23247 " find0 directory (files|-)\n"
23252 #: ../fish/guestfish-actions.pod:1200
23254 "This command works the same way as L</find> with the following exceptions:"
23258 #: ../fish/guestfish-actions.pod:1227
23259 msgid "findfs-label"
23263 #: ../fish/guestfish-actions.pod:1229
23266 " findfs-label label\n"
23271 #: ../fish/guestfish-actions.pod:1235
23272 msgid "To find the label of a filesystem, use L</vfs-label>."
23276 #: ../fish/guestfish-actions.pod:1237
23277 msgid "findfs-uuid"
23281 #: ../fish/guestfish-actions.pod:1239
23284 " findfs-uuid uuid\n"
23289 #: ../fish/guestfish-actions.pod:1245
23290 msgid "To find the UUID of a filesystem, use L</vfs-uuid>."
23294 #: ../fish/guestfish-actions.pod:1247
23299 #: ../fish/guestfish-actions.pod:1249
23302 " fsck fstype device\n"
23307 #: ../fish/guestfish-actions.pod:1279
23312 #: ../fish/guestfish-actions.pod:1281
23320 #: ../fish/guestfish-actions.pod:1288
23321 msgid "get-attach-method"
23325 #: ../fish/guestfish-actions.pod:1290
23328 " get-attach-method\n"
23333 #: ../fish/guestfish-actions.pod:1292
23334 msgid "Return the current attach method. See L</set-attach-method>."
23338 #: ../fish/guestfish-actions.pod:1294
23339 msgid "get-autosync"
23343 #: ../fish/guestfish-actions.pod:1296
23351 #: ../fish/guestfish-actions.pod:1300
23356 #: ../fish/guestfish-actions.pod:1302
23364 #: ../fish/guestfish-actions.pod:1306
23365 msgid "get-e2label"
23369 #: ../fish/guestfish-actions.pod:1308
23372 " get-e2label device\n"
23377 #: ../fish/guestfish-actions.pod:1313
23379 "This function is deprecated. In new code, use the L</vfs_label> call "
23384 #: ../fish/guestfish-actions.pod:1320
23389 #: ../fish/guestfish-actions.pod:1322
23392 " get-e2uuid device\n"
23397 #: ../fish/guestfish-actions.pod:1327
23399 "This function is deprecated. In new code, use the L</vfs_uuid> call instead."
23403 #: ../fish/guestfish-actions.pod:1334
23404 msgid "get-memsize"
23408 #: ../fish/guestfish-actions.pod:1336
23416 #: ../fish/guestfish-actions.pod:1341
23418 "If L</set-memsize> was not called on this handle, and if "
23419 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
23420 "value for memsize."
23424 #: ../fish/guestfish-actions.pod:1348
23425 msgid "get-network"
23429 #: ../fish/guestfish-actions.pod:1350
23437 #: ../fish/guestfish-actions.pod:1354
23442 #: ../fish/guestfish-actions.pod:1356
23450 #: ../fish/guestfish-actions.pod:1363
23455 #: ../fish/guestfish-actions.pod:1365
23460 #: ../fish/guestfish-actions.pod:1367
23468 #: ../fish/guestfish-actions.pod:1374
23473 #: ../fish/guestfish-actions.pod:1376
23481 #: ../fish/guestfish-actions.pod:1383
23482 msgid "get-recovery-proc"
23486 #: ../fish/guestfish-actions.pod:1385
23489 " get-recovery-proc\n"
23494 #: ../fish/guestfish-actions.pod:1389
23495 msgid "get-selinux"
23499 #: ../fish/guestfish-actions.pod:1391
23507 #: ../fish/guestfish-actions.pod:1393
23509 "This returns the current setting of the selinux flag which is passed to the "
23510 "appliance at boot time. See L</set-selinux>."
23514 #: ../fish/guestfish-actions.pod:1399
23519 #: ../fish/guestfish-actions.pod:1401
23527 #: ../fish/guestfish-actions.pod:1408
23532 #: ../fish/guestfish-actions.pod:1410
23540 #: ../fish/guestfish-actions.pod:1414
23545 #: ../fish/guestfish-actions.pod:1416
23553 #: ../fish/guestfish-actions.pod:1418
23555 "Return the current umask. By default the umask is C<022> unless it has been "
23556 "set by calling L</umask>."
23560 #: ../fish/guestfish-actions.pod:1421
23561 msgid "get-verbose"
23565 #: ../fish/guestfish-actions.pod:1423
23573 #: ../fish/guestfish-actions.pod:1427
23578 #: ../fish/guestfish-actions.pod:1429
23586 #: ../fish/guestfish-actions.pod:1433
23587 msgid "See the documentation about SELINUX in L<guestfs(3)>, and L</setcon>"
23591 #: ../fish/guestfish-actions.pod:1436
23596 #: ../fish/guestfish-actions.pod:1438
23599 " getxattr path name\n"
23604 #: ../fish/guestfish-actions.pod:1440
23606 "Get a single extended attribute from file C<path> named C<name>. This call "
23607 "follows symlinks. If you want to lookup an extended attribute for the "
23608 "symlink itself, use L</lgetxattr>."
23612 #: ../fish/guestfish-actions.pod:1444 ../fish/guestfish-actions.pod:2450
23614 "Normally it is better to get all extended attributes from a file in one go "
23615 "by calling L</getxattrs>. However some Linux filesystem implementations are "
23616 "buggy and do not provide a way to list out attributes. For these "
23617 "filesystems (notably ntfs-3g) you have to know the names of the extended "
23618 "attributes you want in advance and call this function."
23622 #: ../fish/guestfish-actions.pod:1454
23623 msgid "See also: L</getxattrs>, L</lgetxattr>, L<attr(5)>."
23627 #: ../fish/guestfish-actions.pod:1456
23632 #: ../fish/guestfish-actions.pod:1458
23635 " getxattrs path\n"
23640 #: ../fish/guestfish-actions.pod:1466
23641 msgid "See also: L</lgetxattrs>, L<attr(5)>."
23645 #: ../fish/guestfish-actions.pod:1468
23646 msgid "glob-expand"
23650 #: ../fish/guestfish-actions.pod:1470
23653 " glob-expand pattern\n"
23658 #: ../fish/guestfish-actions.pod:1483
23663 #: ../fish/guestfish-actions.pod:1485
23666 " grep regex path\n"
23671 #: ../fish/guestfish-actions.pod:1493
23676 #: ../fish/guestfish-actions.pod:1495
23679 " grepi regex path\n"
23684 #: ../fish/guestfish-actions.pod:1503
23685 msgid "grub-install"
23689 #: ../fish/guestfish-actions.pod:1505
23692 " grub-install root device\n"
23697 #: ../fish/guestfish-actions.pod:1521
23702 #: ../fish/guestfish-actions.pod:1523
23710 #: ../fish/guestfish-actions.pod:1531
23715 #: ../fish/guestfish-actions.pod:1533
23718 " head-n nrlines path\n"
23723 #: ../fish/guestfish-actions.pod:1546
23728 #: ../fish/guestfish-actions.pod:1548
23736 #: ../fish/guestfish-actions.pod:1556
23741 #: ../fish/guestfish-actions.pod:1558
23744 " initrd-cat initrdpath filename\n"
23749 #: ../fish/guestfish-actions.pod:1570
23750 msgid "See also L</initrd-list>."
23754 #: ../fish/guestfish-actions.pod:1575
23755 msgid "initrd-list"
23759 #: ../fish/guestfish-actions.pod:1577
23762 " initrd-list path\n"
23767 #: ../fish/guestfish-actions.pod:1589
23768 msgid "inotify-add-watch"
23772 #: ../fish/guestfish-actions.pod:1591
23775 " inotify-add-watch path mask\n"
23780 #: ../fish/guestfish-actions.pod:1603
23781 msgid "inotify-close"
23785 #: ../fish/guestfish-actions.pod:1605
23793 #: ../fish/guestfish-actions.pod:1611
23794 msgid "inotify-files"
23798 #: ../fish/guestfish-actions.pod:1613
23806 #: ../fish/guestfish-actions.pod:1615
23808 "This function is a helpful wrapper around L</inotify-read> which just "
23809 "returns a list of pathnames of objects that were touched. The returned "
23810 "pathnames are sorted and deduplicated."
23814 #: ../fish/guestfish-actions.pod:1619
23815 msgid "inotify-init"
23819 #: ../fish/guestfish-actions.pod:1621
23822 " inotify-init maxevents\n"
23827 #: ../fish/guestfish-actions.pod:1627
23829 "C<maxevents> is the maximum number of events which will be queued up between "
23830 "calls to L</inotify-read> or L</inotify-files>. If this is passed as C<0>, "
23831 "then the kernel (or previously set) default is used. For Linux 2.6.29 the "
23832 "default was 16384 events. Beyond this limit, the kernel throws away events, "
23833 "but records the fact that it threw them away by setting a flag "
23834 "C<IN_Q_OVERFLOW> in the returned structure list (see L</inotify-read>)."
23838 #: ../fish/guestfish-actions.pod:1637
23840 "Before any events are generated, you have to add some watches to the "
23841 "internal watch list. See: L</inotify-add-watch>, L</inotify-rm-watch> and "
23842 "L</inotify-watch-all>."
23846 #: ../fish/guestfish-actions.pod:1643
23848 "Queued up events should be read periodically by calling L</inotify-read> (or "
23849 "L</inotify-files> which is just a helpful wrapper around L</inotify-read>). "
23850 "If you don't read the events out often enough then you risk the internal "
23851 "queue overflowing."
23855 #: ../fish/guestfish-actions.pod:1650
23857 "The handle should be closed after use by calling L</inotify-close>. This "
23858 "also removes any watches automatically."
23862 #: ../fish/guestfish-actions.pod:1659
23863 msgid "inotify-read"
23867 #: ../fish/guestfish-actions.pod:1661
23875 #: ../fish/guestfish-actions.pod:1674
23876 msgid "inotify-rm-watch"
23880 #: ../fish/guestfish-actions.pod:1676
23883 " inotify-rm-watch wd\n"
23888 #: ../fish/guestfish-actions.pod:1678
23889 msgid "Remove a previously defined inotify watch. See L</inotify-add-watch>."
23893 #: ../fish/guestfish-actions.pod:1681
23894 msgid "inspect-get-arch"
23898 #: ../fish/guestfish-actions.pod:1683
23901 " inspect-get-arch root\n"
23906 #: ../fish/guestfish-actions.pod:1685 ../fish/guestfish-actions.pod:1701
23907 #: ../fish/guestfish-actions.pod:1787 ../fish/guestfish-actions.pod:1823
23908 #: ../fish/guestfish-actions.pod:1841 ../fish/guestfish-actions.pod:1875
23909 #: ../fish/guestfish-actions.pod:1890 ../fish/guestfish-actions.pod:1911
23910 #: ../fish/guestfish-actions.pod:1926 ../fish/guestfish-actions.pod:1959
23911 #: ../fish/guestfish-actions.pod:1981 ../fish/guestfish-actions.pod:2005
23912 #: ../fish/guestfish-actions.pod:2022 ../fish/guestfish-actions.pod:2065
23913 #: ../fish/guestfish-actions.pod:2100 ../fish/guestfish-actions.pod:2116
23914 #: ../fish/guestfish-actions.pod:2132 ../fish/guestfish-actions.pod:2145
23915 #: ../fish/guestfish-actions.pod:2158 ../fish/guestfish-actions.pod:2173
23917 "This function should only be called with a root device string as returned by "
23922 #: ../fish/guestfish-actions.pod:1688
23924 "This returns the architecture of the inspected operating system. The "
23925 "possible return values are listed under L</file-architecture>."
23929 #: ../fish/guestfish-actions.pod:1697
23930 msgid "inspect-get-distro"
23934 #: ../fish/guestfish-actions.pod:1699
23937 " inspect-get-distro root\n"
23942 #: ../fish/guestfish-actions.pod:1783
23943 msgid "inspect-get-drive-mappings"
23947 #: ../fish/guestfish-actions.pod:1785
23950 " inspect-get-drive-mappings root\n"
23955 #: ../fish/guestfish-actions.pod:1815
23957 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
23958 "get-mountpoints>, L</inspect-get-filesystems>."
23962 #: ../fish/guestfish-actions.pod:1819
23963 msgid "inspect-get-filesystems"
23967 #: ../fish/guestfish-actions.pod:1821
23970 " inspect-get-filesystems root\n"
23975 #: ../fish/guestfish-actions.pod:1834
23977 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
23978 "get-mountpoints>."
23982 #: ../fish/guestfish-actions.pod:1837
23983 msgid "inspect-get-format"
23987 #: ../fish/guestfish-actions.pod:1839
23990 " inspect-get-format root\n"
23995 #: ../fish/guestfish-actions.pod:1871
23996 msgid "inspect-get-hostname"
24000 #: ../fish/guestfish-actions.pod:1873
24003 " inspect-get-hostname root\n"
24008 #: ../fish/guestfish-actions.pod:1886
24009 msgid "inspect-get-major-version"
24013 #: ../fish/guestfish-actions.pod:1888
24016 " inspect-get-major-version root\n"
24021 #: ../fish/guestfish-actions.pod:1907
24022 msgid "inspect-get-minor-version"
24026 #: ../fish/guestfish-actions.pod:1909
24029 " inspect-get-minor-version root\n"
24034 #: ../fish/guestfish-actions.pod:1919
24036 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
24037 "get-major-version>."
24041 #: ../fish/guestfish-actions.pod:1922
24042 msgid "inspect-get-mountpoints"
24046 #: ../fish/guestfish-actions.pod:1924
24049 " inspect-get-mountpoints root\n"
24054 #: ../fish/guestfish-actions.pod:1946
24056 "For operating systems like Windows which still use drive letters, this call "
24057 "will only return an entry for the first drive \"mounted on\" C</>. For "
24058 "information about the mapping of drive letters to partitions, see L</inspect-"
24059 "get-drive-mappings>."
24063 #: ../fish/guestfish-actions.pod:1952
24065 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
24066 "get-filesystems>."
24070 #: ../fish/guestfish-actions.pod:1955
24071 msgid "inspect-get-package-format"
24075 #: ../fish/guestfish-actions.pod:1957
24078 " inspect-get-package-format root\n"
24083 #: ../fish/guestfish-actions.pod:1962
24085 "This function and L</inspect-get-package-management> return the package "
24086 "format and package management tool used by the inspected operating system. "
24087 "For example for Fedora these functions would return C<rpm> (package format) "
24088 "and C<yum> (package management)."
24092 #: ../fish/guestfish-actions.pod:1977
24093 msgid "inspect-get-package-management"
24097 #: ../fish/guestfish-actions.pod:1979
24100 " inspect-get-package-management root\n"
24105 #: ../fish/guestfish-actions.pod:1984
24107 "L</inspect-get-package-format> and this function return the package format "
24108 "and package management tool used by the inspected operating system. For "
24109 "example for Fedora these functions would return C<rpm> (package format) and "
24110 "C<yum> (package management)."
24114 #: ../fish/guestfish-actions.pod:2001
24115 msgid "inspect-get-product-name"
24119 #: ../fish/guestfish-actions.pod:2003
24122 " inspect-get-product-name root\n"
24127 #: ../fish/guestfish-actions.pod:2018
24128 msgid "inspect-get-product-variant"
24132 #: ../fish/guestfish-actions.pod:2020
24135 " inspect-get-product-variant root\n"
24140 #: ../fish/guestfish-actions.pod:2044
24142 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
24143 "get-product-name>, L</inspect-get-major-version>."
24147 #: ../fish/guestfish-actions.pod:2048
24148 msgid "inspect-get-roots"
24152 #: ../fish/guestfish-actions.pod:2050
24155 " inspect-get-roots\n"
24160 #: ../fish/guestfish-actions.pod:2052
24162 "This function is a convenient way to get the list of root devices, as "
24163 "returned from a previous call to L</inspect-os>, but without redoing the "
24164 "whole inspection process."
24168 #: ../fish/guestfish-actions.pod:2056
24170 "This returns an empty list if either no root devices were found or the "
24171 "caller has not called L</inspect-os>."
24175 #: ../fish/guestfish-actions.pod:2061
24176 msgid "inspect-get-type"
24180 #: ../fish/guestfish-actions.pod:2063
24183 " inspect-get-type root\n"
24188 #: ../fish/guestfish-actions.pod:2096
24189 msgid "inspect-get-windows-current-control-set"
24193 #: ../fish/guestfish-actions.pod:2098
24196 " inspect-get-windows-current-control-set root\n"
24201 #: ../fish/guestfish-actions.pod:2112
24202 msgid "inspect-get-windows-systemroot"
24206 #: ../fish/guestfish-actions.pod:2114
24209 " inspect-get-windows-systemroot root\n"
24214 #: ../fish/guestfish-actions.pod:2128
24215 msgid "inspect-is-live"
24219 #: ../fish/guestfish-actions.pod:2130
24222 " inspect-is-live root\n"
24227 #: ../fish/guestfish-actions.pod:2135
24229 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
24230 "then this returns true if a live image was detected on the disk."
24234 #: ../fish/guestfish-actions.pod:2141
24235 msgid "inspect-is-multipart"
24239 #: ../fish/guestfish-actions.pod:2143
24242 " inspect-is-multipart root\n"
24247 #: ../fish/guestfish-actions.pod:2148
24249 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
24250 "then this returns true if the disk is part of a set."
24254 #: ../fish/guestfish-actions.pod:2154
24255 msgid "inspect-is-netinst"
24259 #: ../fish/guestfish-actions.pod:2156
24262 " inspect-is-netinst root\n"
24267 #: ../fish/guestfish-actions.pod:2161
24269 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
24270 "then this returns true if the disk is a network installer, ie. not a self-"
24271 "contained install CD but one which is likely to require network access to "
24272 "complete the install."
24276 #: ../fish/guestfish-actions.pod:2169
24277 msgid "inspect-list-applications"
24281 #: ../fish/guestfish-actions.pod:2171
24284 " inspect-list-applications root\n"
24289 #: ../fish/guestfish-actions.pod:2178
24291 "I<Note:> This call works differently from other parts of the inspection "
24292 "API. You have to call L</inspect-os>, then L</inspect-get-mountpoints>, "
24293 "then mount up the disks, before calling this. Listing applications is a "
24294 "significantly more difficult operation which requires access to the full "
24295 "filesystem. Also note that unlike the other L</inspect-get-*> calls which "
24296 "are just returning data cached in the libguestfs handle, this call actually "
24297 "reads parts of the mounted filesystems during the call."
24301 #: ../fish/guestfish-actions.pod:2268
24306 #: ../fish/guestfish-actions.pod:2270
24314 #: ../fish/guestfish-actions.pod:2285
24316 "You can pass the root string(s) returned to other L</inspect-get-*> "
24317 "functions in order to query further information about each operating system, "
24318 "such as the name and version."
24322 #: ../fish/guestfish-actions.pod:2290
24324 "This function uses other libguestfs features such as L</mount-ro> and L</"
24325 "umount-all> in order to mount and unmount filesystems and look at the "
24326 "contents. This should be called with no disks currently mounted. The "
24327 "function may also use Augeas, so any existing Augeas handle will be closed."
24331 #: ../fish/guestfish-actions.pod:2302 ../fish/guestfish-actions.pod:2478
24332 #: ../fish/guestfish-actions.pod:2524
24333 msgid "See also L</list-filesystems>."
24337 #: ../fish/guestfish-actions.pod:2304
24338 msgid "is-blockdev"
24342 #: ../fish/guestfish-actions.pod:2306
24345 " is-blockdev path\n"
24350 #: ../fish/guestfish-actions.pod:2311 ../fish/guestfish-actions.pod:2329
24351 #: ../fish/guestfish-actions.pod:2348 ../fish/guestfish-actions.pod:2357
24352 #: ../fish/guestfish-actions.pod:2367 ../fish/guestfish-actions.pod:2401
24353 #: ../fish/guestfish-actions.pod:2410
24354 msgid "See also L</stat>."
24358 #: ../fish/guestfish-actions.pod:2313
24363 #: ../fish/guestfish-actions.pod:2315
24371 #: ../fish/guestfish-actions.pod:2322
24376 #: ../fish/guestfish-actions.pod:2324
24379 " is-chardev path\n"
24384 #: ../fish/guestfish-actions.pod:2331
24389 #: ../fish/guestfish-actions.pod:2333
24397 #: ../fish/guestfish-actions.pod:2340
24402 #: ../fish/guestfish-actions.pod:2342
24410 #: ../fish/guestfish-actions.pod:2350
24415 #: ../fish/guestfish-actions.pod:2352
24423 #: ../fish/guestfish-actions.pod:2359
24428 #: ../fish/guestfish-actions.pod:2361
24436 #: ../fish/guestfish-actions.pod:2369
24437 msgid "is-launching"
24441 #: ../fish/guestfish-actions.pod:2371
24449 #: ../fish/guestfish-actions.pod:2378
24454 #: ../fish/guestfish-actions.pod:2380
24462 #: ../fish/guestfish-actions.pod:2385
24467 #: ../fish/guestfish-actions.pod:2387
24475 #: ../fish/guestfish-actions.pod:2394
24480 #: ../fish/guestfish-actions.pod:2396
24483 " is-socket path\n"
24488 #: ../fish/guestfish-actions.pod:2403
24493 #: ../fish/guestfish-actions.pod:2405
24496 " is-symlink path\n"
24501 #: ../fish/guestfish-actions.pod:2412
24502 msgid "kill-subprocess"
24506 #: ../fish/guestfish-actions.pod:2414
24509 " kill-subprocess\n"
24514 #: ../fish/guestfish-actions.pod:2418
24519 #: ../fish/guestfish-actions.pod:2420
24524 #: ../fish/guestfish-actions.pod:2422
24532 #: ../fish/guestfish-actions.pod:2430
24537 #: ../fish/guestfish-actions.pod:2432
24540 " lchown owner group path\n"
24545 #: ../fish/guestfish-actions.pod:2434
24547 "Change the file owner to C<owner> and group to C<group>. This is like L</"
24548 "chown> but if C<path> is a symlink then the link itself is changed, not the "
24553 #: ../fish/guestfish-actions.pod:2442
24558 #: ../fish/guestfish-actions.pod:2444
24561 " lgetxattr path name\n"
24566 #: ../fish/guestfish-actions.pod:2460
24567 msgid "See also: L</lgetxattrs>, L</getxattr>, L<attr(5)>."
24571 #: ../fish/guestfish-actions.pod:2462
24576 #: ../fish/guestfish-actions.pod:2464
24579 " lgetxattrs path\n"
24584 #: ../fish/guestfish-actions.pod:2466
24586 "This is the same as L</getxattrs>, but if C<path> is a symbolic link, then "
24587 "it returns the extended attributes of the link itself."
24591 #: ../fish/guestfish-actions.pod:2470
24592 msgid "list-devices"
24596 #: ../fish/guestfish-actions.pod:2472
24604 #: ../fish/guestfish-actions.pod:2480
24605 msgid "list-filesystems"
24609 #: ../fish/guestfish-actions.pod:2482
24612 " list-filesystems\n"
24617 #: ../fish/guestfish-actions.pod:2501
24619 "This command runs other libguestfs commands, which might include L</mount> "
24620 "and L</umount>, and therefore you should use this soon after launch and only "
24621 "when nothing is mounted."
24625 #: ../fish/guestfish-actions.pod:2505
24627 "Not all of the filesystems returned will be mountable. In particular, swap "
24628 "partitions are returned in the list. Also this command does not check that "
24629 "each filesystem found is valid and mountable, and some filesystems might be "
24630 "mountable but require special options. Filesystems may not all belong to a "
24631 "single logical operating system (use L</inspect-os> to look for OSes)."
24635 #: ../fish/guestfish-actions.pod:2513
24636 msgid "list-partitions"
24640 #: ../fish/guestfish-actions.pod:2515
24643 " list-partitions\n"
24648 #: ../fish/guestfish-actions.pod:2521
24650 "This does not return logical volumes. For that you will need to call L</"
24655 #: ../fish/guestfish-actions.pod:2526
24660 #: ../fish/guestfish-actions.pod:2528
24668 #: ../fish/guestfish-actions.pod:2536
24673 #: ../fish/guestfish-actions.pod:2538
24676 " ln target linkname\n"
24681 #: ../fish/guestfish-actions.pod:2542
24686 #: ../fish/guestfish-actions.pod:2544
24689 " ln-f target linkname\n"
24694 #: ../fish/guestfish-actions.pod:2549
24699 #: ../fish/guestfish-actions.pod:2551
24702 " ln-s target linkname\n"
24707 #: ../fish/guestfish-actions.pod:2555
24712 #: ../fish/guestfish-actions.pod:2557
24715 " ln-sf target linkname\n"
24720 #: ../fish/guestfish-actions.pod:2562
24721 msgid "lremovexattr"
24725 #: ../fish/guestfish-actions.pod:2564
24728 " lremovexattr xattr path\n"
24733 #: ../fish/guestfish-actions.pod:2566
24735 "This is the same as L</removexattr>, but if C<path> is a symbolic link, then "
24736 "it removes an extended attribute of the link itself."
24740 #: ../fish/guestfish-actions.pod:2570
24745 #: ../fish/guestfish-actions.pod:2572
24753 #: ../fish/guestfish-actions.pod:2578
24755 "This command is mostly useful for interactive sessions. Programs should "
24756 "probably use L</readdir> instead."
24760 #: ../fish/guestfish-actions.pod:2581
24765 #: ../fish/guestfish-actions.pod:2583
24768 " lsetxattr xattr val vallen path\n"
24773 #: ../fish/guestfish-actions.pod:2585
24775 "This is the same as L</setxattr>, but if C<path> is a symbolic link, then it "
24776 "sets an extended attribute of the link itself."
24780 #: ../fish/guestfish-actions.pod:2589
24785 #: ../fish/guestfish-actions.pod:2591
24793 #: ../fish/guestfish-actions.pod:2595
24795 "This is the same as L</stat> except that if C<path> is a symbolic link, then "
24796 "the link is stat-ed, not the file it refers to."
24800 #: ../fish/guestfish-actions.pod:2601
24805 #: ../fish/guestfish-actions.pod:2603
24808 " lstatlist path 'names ...'\n"
24813 #: ../fish/guestfish-actions.pod:2605
24815 "This call allows you to perform the L</lstat> operation on multiple files, "
24816 "where all files are in the directory C<path>. C<names> is the list of files "
24817 "from this directory."
24821 #: ../fish/guestfish-actions.pod:2614
24823 "This call is intended for programs that want to efficiently list a directory "
24824 "contents without making many round-trips. See also L</lxattrlist> for a "
24825 "similarly efficient call for getting extended attributes. Very long "
24826 "directory listings might cause the protocol message size to be exceeded, "
24827 "causing this call to fail. The caller must split up such requests into "
24828 "smaller groups of names."
24832 #: ../fish/guestfish-actions.pod:2622
24833 msgid "luks-add-key"
24837 #: ../fish/guestfish-actions.pod:2624
24840 " luks-add-key device keyslot\n"
24845 #: ../fish/guestfish-actions.pod:2631
24847 "Note that if C<keyslot> already contains a key, then this command will "
24848 "fail. You have to use L</luks-kill-slot> first to remove that key."
24852 #: ../fish/guestfish-actions.pod:2635 ../fish/guestfish-actions.pod:2657
24853 #: ../fish/guestfish-actions.pod:2670 ../fish/guestfish-actions.pod:2684
24854 #: ../fish/guestfish-actions.pod:2707 ../fish/guestfish-actions.pod:2717
24856 "This command has one or more key or passphrase parameters. Guestfish will "
24857 "prompt for these separately."
24861 #: ../fish/guestfish-actions.pod:2638
24866 #: ../fish/guestfish-actions.pod:2640
24869 " luks-close device\n"
24874 #: ../fish/guestfish-actions.pod:2642
24876 "This closes a LUKS device that was created earlier by L</luks-open> or L</"
24877 "luks-open-ro>. The C<device> parameter must be the name of the LUKS mapping "
24878 "device (ie. C</dev/mapper/mapname>) and I<not> the name of the underlying "
24883 #: ../fish/guestfish-actions.pod:2648
24884 msgid "luks-format"
24888 #: ../fish/guestfish-actions.pod:2650
24891 " luks-format device keyslot\n"
24896 #: ../fish/guestfish-actions.pod:2663
24897 msgid "luks-format-cipher"
24901 #: ../fish/guestfish-actions.pod:2665
24904 " luks-format-cipher device keyslot cipher\n"
24909 #: ../fish/guestfish-actions.pod:2667
24911 "This command is the same as L</luks-format> but it also allows you to set "
24912 "the C<cipher> used."
24916 #: ../fish/guestfish-actions.pod:2676
24917 msgid "luks-kill-slot"
24921 #: ../fish/guestfish-actions.pod:2678
24924 " luks-kill-slot device keyslot\n"
24929 #: ../fish/guestfish-actions.pod:2687
24934 #: ../fish/guestfish-actions.pod:2689
24937 " luks-open device mapname\n"
24942 #: ../fish/guestfish-actions.pod:2703
24944 "If this block device contains LVM volume groups, then calling L</vgscan> "
24945 "followed by L</vg-activate-all> will make them visible."
24949 #: ../fish/guestfish-actions.pod:2710
24950 msgid "luks-open-ro"
24954 #: ../fish/guestfish-actions.pod:2712
24957 " luks-open-ro device mapname\n"
24962 #: ../fish/guestfish-actions.pod:2714
24964 "This is the same as L</luks-open> except that a read-only mapping is created."
24968 #: ../fish/guestfish-actions.pod:2720
24973 #: ../fish/guestfish-actions.pod:2722
24976 " lvcreate logvol volgroup mbytes\n"
24981 #: ../fish/guestfish-actions.pod:2727
24982 msgid "lvm-canonical-lv-name"
24986 #: ../fish/guestfish-actions.pod:2729
24989 " lvm-canonical-lv-name lvname\n"
24994 #: ../fish/guestfish-actions.pod:2738
24995 msgid "See also L</is-lv>."
24999 #: ../fish/guestfish-actions.pod:2740
25000 msgid "lvm-clear-filter"
25004 #: ../fish/guestfish-actions.pod:2742
25007 " lvm-clear-filter\n"
25012 #: ../fish/guestfish-actions.pod:2744
25014 "This undoes the effect of L</lvm-set-filter>. LVM will be able to see every "
25019 #: ../fish/guestfish-actions.pod:2750
25020 msgid "lvm-remove-all"
25024 #: ../fish/guestfish-actions.pod:2752
25027 " lvm-remove-all\n"
25032 #: ../fish/guestfish-actions.pod:2760
25033 msgid "lvm-set-filter"
25037 #: ../fish/guestfish-actions.pod:2762
25040 " lvm-set-filter 'devices ...'\n"
25045 #: ../fish/guestfish-actions.pod:2787
25050 #: ../fish/guestfish-actions.pod:2789
25053 " lvremove device\n"
25058 #: ../fish/guestfish-actions.pod:2797
25063 #: ../fish/guestfish-actions.pod:2799
25066 " lvrename logvol newlogvol\n"
25071 #: ../fish/guestfish-actions.pod:2803
25076 #: ../fish/guestfish-actions.pod:2805
25079 " lvresize device mbytes\n"
25084 #: ../fish/guestfish-actions.pod:2811
25085 msgid "lvresize-free"
25089 #: ../fish/guestfish-actions.pod:2813
25092 " lvresize-free lv percent\n"
25097 #: ../fish/guestfish-actions.pod:2821
25102 #: ../fish/guestfish-actions.pod:2823
25110 #: ../fish/guestfish-actions.pod:2831
25111 msgid "See also L</lvs-full>, L</list-filesystems>."
25115 #: ../fish/guestfish-actions.pod:2833
25120 #: ../fish/guestfish-actions.pod:2835
25128 #: ../fish/guestfish-actions.pod:2840
25133 #: ../fish/guestfish-actions.pod:2842
25141 #: ../fish/guestfish-actions.pod:2846
25146 #: ../fish/guestfish-actions.pod:2848
25149 " lxattrlist path 'names ...'\n"
25154 #: ../fish/guestfish-actions.pod:2864
25156 "This call is intended for programs that want to efficiently list a directory "
25157 "contents without making many round-trips. See also L</lstatlist> for a "
25158 "similarly efficient call for getting standard stats. Very long directory "
25159 "listings might cause the protocol message size to be exceeded, causing this "
25160 "call to fail. The caller must split up such requests into smaller groups of "
25165 #: ../fish/guestfish-actions.pod:2872
25170 #: ../fish/guestfish-actions.pod:2874
25178 #: ../fish/guestfish-actions.pod:2878
25183 #: ../fish/guestfish-actions.pod:2880
25186 " mkdir-mode path mode\n"
25191 #: ../fish/guestfish-actions.pod:2889
25192 msgid "See also L</mkdir>, L</umask>"
25196 #: ../fish/guestfish-actions.pod:2891
25201 #: ../fish/guestfish-actions.pod:2893
25209 #: ../fish/guestfish-actions.pod:2898
25214 #: ../fish/guestfish-actions.pod:2900
25217 " mkdtemp template\n"
25222 #: ../fish/guestfish-actions.pod:2921
25227 #: ../fish/guestfish-actions.pod:2923
25230 " mke2fs-J fstype blocksize device journal\n"
25235 #: ../fish/guestfish-actions.pod:2931
25236 msgid "See also L</mke2journal>."
25240 #: ../fish/guestfish-actions.pod:2933
25245 #: ../fish/guestfish-actions.pod:2935
25248 " mke2fs-JL fstype blocksize device label\n"
25253 #: ../fish/guestfish-actions.pod:2940
25254 msgid "See also L</mke2journal-L>."
25258 #: ../fish/guestfish-actions.pod:2942
25263 #: ../fish/guestfish-actions.pod:2944
25266 " mke2fs-JU fstype blocksize device uuid\n"
25271 #: ../fish/guestfish-actions.pod:2949
25272 msgid "See also L</mke2journal-U>."
25276 #: ../fish/guestfish-actions.pod:2951
25277 msgid "mke2journal"
25281 #: ../fish/guestfish-actions.pod:2953
25284 " mke2journal blocksize device\n"
25289 #: ../fish/guestfish-actions.pod:2960
25290 msgid "mke2journal-L"
25294 #: ../fish/guestfish-actions.pod:2962
25297 " mke2journal-L blocksize label device\n"
25302 #: ../fish/guestfish-actions.pod:2966
25303 msgid "mke2journal-U"
25307 #: ../fish/guestfish-actions.pod:2968
25310 " mke2journal-U blocksize uuid device\n"
25315 #: ../fish/guestfish-actions.pod:2972
25320 #: ../fish/guestfish-actions.pod:2974
25323 " mkfifo mode path\n"
25328 #: ../fish/guestfish-actions.pod:2976
25330 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
25331 "is just a convenient wrapper around L</mknod>."
25335 #: ../fish/guestfish-actions.pod:2982
25340 #: ../fish/guestfish-actions.pod:2984
25343 " mkfs fstype device\n"
25348 #: ../fish/guestfish-actions.pod:2990
25353 #: ../fish/guestfish-actions.pod:2992
25356 " mkfs-b fstype blocksize device\n"
25361 #: ../fish/guestfish-actions.pod:2994
25363 "This call is similar to L</mkfs>, but it allows you to control the block "
25364 "size of the resulting filesystem. Supported block sizes depend on the "
25365 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
25369 #: ../fish/guestfish-actions.pod:3002
25371 "This function is deprecated. In new code, use the L</mkfs_opts> call "
25376 #: ../fish/guestfish-actions.pod:3009
25381 #: ../fish/guestfish-actions.pod:3011
25384 " mkfs-opts fstype device [blocksize:..] [features:..]\n"
25389 #: ../fish/guestfish-actions.pod:3046
25390 msgid "mkmountpoint"
25394 #: ../fish/guestfish-actions.pod:3048
25397 " mkmountpoint exemptpath\n"
25402 #: ../fish/guestfish-actions.pod:3050
25404 "L</mkmountpoint> and L</rmmountpoint> are specialized calls that can be used "
25405 "to create extra mountpoints before mounting the first filesystem."
25409 #: ../fish/guestfish-actions.pod:3074
25411 "L</mkmountpoint> is not compatible with L</umount-all>. You may get "
25412 "unexpected errors if you try to mix these calls. It is safest to manually "
25413 "unmount filesystems and remove mountpoints after use."
25417 #: ../fish/guestfish-actions.pod:3078
25419 "L</umount-all> unmounts filesystems by sorting the paths longest first, so "
25420 "for this to work for manual mountpoints, you must ensure that the innermost "
25421 "mountpoints have the longest pathnames, as in the example code above."
25425 #: ../fish/guestfish-actions.pod:3085
25427 "Autosync [see L</set-autosync>, this is set by default on handles] can cause "
25428 "L</umount-all> to be called when the handle is closed which can also trigger "
25433 #: ../fish/guestfish-actions.pod:3089
25438 #: ../fish/guestfish-actions.pod:3091
25441 " mknod mode devmajor devminor path\n"
25446 #: ../fish/guestfish-actions.pod:3101
25448 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
25449 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
25450 "regular file). These constants are available in the standard Linux header "
25451 "files, or you can use L</mknod-b>, L</mknod-c> or L</mkfifo> which are "
25452 "wrappers around this command which bitwise OR in the appropriate constant "
25457 #: ../fish/guestfish-actions.pod:3111
25462 #: ../fish/guestfish-actions.pod:3113
25465 " mknod-b mode devmajor devminor path\n"
25470 #: ../fish/guestfish-actions.pod:3115
25472 "This call creates a block device node called C<path> with mode C<mode> and "
25473 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
25474 "wrapper around L</mknod>."
25478 #: ../fish/guestfish-actions.pod:3121
25483 #: ../fish/guestfish-actions.pod:3123
25486 " mknod-c mode devmajor devminor path\n"
25491 #: ../fish/guestfish-actions.pod:3125
25493 "This call creates a char device node called C<path> with mode C<mode> and "
25494 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
25495 "wrapper around L</mknod>."
25499 #: ../fish/guestfish-actions.pod:3131
25504 #: ../fish/guestfish-actions.pod:3133
25512 #: ../fish/guestfish-actions.pod:3137
25517 #: ../fish/guestfish-actions.pod:3139
25520 " mkswap-L label device\n"
25525 #: ../fish/guestfish-actions.pod:3147
25530 #: ../fish/guestfish-actions.pod:3149
25533 " mkswap-U uuid device\n"
25538 #: ../fish/guestfish-actions.pod:3153
25539 msgid "mkswap-file"
25543 #: ../fish/guestfish-actions.pod:3155
25546 " mkswap-file path\n"
25551 #: ../fish/guestfish-actions.pod:3159
25553 "This command just writes a swap file signature to an existing file. To "
25554 "create the file itself, use something like L</fallocate>."
25558 #: ../fish/guestfish-actions.pod:3162
25563 #: ../fish/guestfish-actions.pod:3164
25566 " modprobe modulename\n"
25571 #: ../fish/guestfish-actions.pod:3171
25576 #: ../fish/guestfish-actions.pod:3173
25579 " mount device mountpoint\n"
25584 #: ../fish/guestfish-actions.pod:3189
25586 "B<Important note:> When you use this call, the filesystem options C<sync> "
25587 "and C<noatime> are set implicitly. This was originally done because we "
25588 "thought it would improve reliability, but it turns out that I<-o sync> has a "
25589 "very large negative performance impact and negligible effect on "
25590 "reliability. Therefore we recommend that you avoid using L</mount> in any "
25591 "code that needs performance, and instead use L</mount-options> (use an empty "
25592 "string for the first parameter if you don't want any options)."
25596 #: ../fish/guestfish-actions.pod:3199
25598 "This function is deprecated. In new code, use the L</mount_options> call "
25603 #: ../fish/guestfish-actions.pod:3206
25608 #: ../fish/guestfish-actions.pod:3208
25611 " mount-loop file mountpoint\n"
25616 #: ../fish/guestfish-actions.pod:3214
25617 msgid "mount-options"
25621 #: ../fish/guestfish-actions.pod:3216
25624 " mount-options options device mountpoint\n"
25629 #: ../fish/guestfish-actions.pod:3218
25631 "This is the same as the L</mount> command, but it allows you to set the "
25632 "mount options as for the L<mount(8)> I<-o> flag."
25636 #: ../fish/guestfish-actions.pod:3226
25641 #: ../fish/guestfish-actions.pod:3228
25644 " mount-ro device mountpoint\n"
25649 #: ../fish/guestfish-actions.pod:3230
25651 "This is the same as the L</mount> command, but it mounts the filesystem with "
25652 "the read-only (I<-o ro>) flag."
25656 #: ../fish/guestfish-actions.pod:3233
25661 #: ../fish/guestfish-actions.pod:3235
25664 " mount-vfs options vfstype device mountpoint\n"
25669 #: ../fish/guestfish-actions.pod:3237
25671 "This is the same as the L</mount> command, but it allows you to set both the "
25672 "mount options and the vfstype as for the L<mount(8)> I<-o> and I<-t> flags."
25676 #: ../fish/guestfish-actions.pod:3241
25677 msgid "mountpoints"
25681 #: ../fish/guestfish-actions.pod:3243
25689 #: ../fish/guestfish-actions.pod:3245
25691 "This call is similar to L</mounts>. That call returns a list of devices. "
25692 "This one returns a hash table (map) of device name to directory where the "
25693 "device is mounted."
25697 #: ../fish/guestfish-actions.pod:3249
25702 #: ../fish/guestfish-actions.pod:3251
25710 #: ../fish/guestfish-actions.pod:3258
25711 msgid "See also: L</mountpoints>"
25715 #: ../fish/guestfish-actions.pod:3260
25720 #: ../fish/guestfish-actions.pod:3262
25728 #: ../fish/guestfish-actions.pod:3267
25729 msgid "ntfs-3g-probe"
25733 #: ../fish/guestfish-actions.pod:3269
25736 " ntfs-3g-probe true|false device\n"
25741 #: ../fish/guestfish-actions.pod:3283
25746 #: ../fish/guestfish-actions.pod:3285
25749 " ntfsresize device\n"
25754 #: ../fish/guestfish-actions.pod:3300
25755 msgid "ntfsresize-size"
25759 #: ../fish/guestfish-actions.pod:3302
25762 " ntfsresize-size device size\n"
25767 #: ../fish/guestfish-actions.pod:3304
25769 "This command is the same as L</ntfsresize> except that it allows you to "
25770 "specify the new size (in bytes) explicitly."
25774 #: ../fish/guestfish-actions.pod:3307
25779 #: ../fish/guestfish-actions.pod:3309
25782 " part-add device prlogex startsect endsect\n"
25787 #: ../fish/guestfish-actions.pod:3311
25789 "This command adds a partition to C<device>. If there is no partition table "
25790 "on the device, call L</part-init> first."
25794 #: ../fish/guestfish-actions.pod:3323
25796 "Creating a partition which covers the whole disk is not so easy. Use L</"
25797 "part-disk> to do that."
25801 #: ../fish/guestfish-actions.pod:3326
25806 #: ../fish/guestfish-actions.pod:3328
25809 " part-del device partnum\n"
25814 #: ../fish/guestfish-actions.pod:3336
25819 #: ../fish/guestfish-actions.pod:3338
25822 " part-disk device parttype\n"
25827 #: ../fish/guestfish-actions.pod:3340
25829 "This command is simply a combination of L</part-init> followed by L</part-"
25830 "add> to create a single primary partition covering the whole disk."
25834 #: ../fish/guestfish-actions.pod:3344
25836 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
25837 "possible values are described in L</part-init>."
25841 #: ../fish/guestfish-actions.pod:3350
25842 msgid "part-get-bootable"
25846 #: ../fish/guestfish-actions.pod:3352
25849 " part-get-bootable device partnum\n"
25854 #: ../fish/guestfish-actions.pod:3357
25855 msgid "See also L</part-set-bootable>."
25859 #: ../fish/guestfish-actions.pod:3359
25860 msgid "part-get-mbr-id"
25864 #: ../fish/guestfish-actions.pod:3361
25867 " part-get-mbr-id device partnum\n"
25872 #: ../fish/guestfish-actions.pod:3366 ../fish/guestfish-actions.pod:3504
25874 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
25875 "undefined results for other partition table types (see L</part-get-"
25880 #: ../fish/guestfish-actions.pod:3370
25881 msgid "part-get-parttype"
25885 #: ../fish/guestfish-actions.pod:3372
25888 " part-get-parttype device\n"
25893 #: ../fish/guestfish-actions.pod:3377
25895 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
25896 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
25897 "possible, although unusual. See L</part-init> for a full list."
25901 #: ../fish/guestfish-actions.pod:3382
25906 #: ../fish/guestfish-actions.pod:3384
25909 " part-init device parttype\n"
25914 #: ../fish/guestfish-actions.pod:3390
25916 "Initially there are no partitions. Following this, you should call L</part-"
25917 "add> for each partition required."
25921 #: ../fish/guestfish-actions.pod:3453
25926 #: ../fish/guestfish-actions.pod:3455
25929 " part-list device\n"
25934 #: ../fish/guestfish-actions.pod:3470
25936 "Start of the partition I<in bytes>. To get sectors you have to divide by "
25937 "the device's sector size, see L</blockdev-getss>."
25941 #: ../fish/guestfish-actions.pod:3483
25942 msgid "part-set-bootable"
25946 #: ../fish/guestfish-actions.pod:3485
25949 " part-set-bootable device partnum true|false\n"
25954 #: ../fish/guestfish-actions.pod:3494
25955 msgid "part-set-mbr-id"
25959 #: ../fish/guestfish-actions.pod:3496
25962 " part-set-mbr-id device partnum idbyte\n"
25967 #: ../fish/guestfish-actions.pod:3508
25968 msgid "part-set-name"
25972 #: ../fish/guestfish-actions.pod:3510
25975 " part-set-name device partnum name\n"
25980 #: ../fish/guestfish-actions.pod:3518
25981 msgid "part-to-dev"
25985 #: ../fish/guestfish-actions.pod:3520
25988 " part-to-dev partition\n"
25993 #: ../fish/guestfish-actions.pod:3526
25995 "The named partition must exist, for example as a string returned from L</"
25996 "list-partitions>."
26000 #: ../fish/guestfish-actions.pod:3529
26001 msgid "ping-daemon"
26005 #: ../fish/guestfish-actions.pod:3531
26013 #: ../fish/guestfish-actions.pod:3538
26018 #: ../fish/guestfish-actions.pod:3540
26021 " pread path count offset\n"
26026 #: ../fish/guestfish-actions.pod:3548
26027 msgid "See also L</pwrite>, L</pread-device>."
26031 #: ../fish/guestfish-actions.pod:3553
26032 msgid "pread-device"
26036 #: ../fish/guestfish-actions.pod:3555
26039 " pread-device device count offset\n"
26044 #: ../fish/guestfish-actions.pod:3563
26045 msgid "See also L</pread>."
26049 #: ../fish/guestfish-actions.pod:3568
26054 #: ../fish/guestfish-actions.pod:3570
26057 " pvcreate device\n"
26062 #: ../fish/guestfish-actions.pod:3576
26067 #: ../fish/guestfish-actions.pod:3578
26070 " pvremove device\n"
26075 #: ../fish/guestfish-actions.pod:3587
26080 #: ../fish/guestfish-actions.pod:3589
26083 " pvresize device\n"
26088 #: ../fish/guestfish-actions.pod:3594
26089 msgid "pvresize-size"
26093 #: ../fish/guestfish-actions.pod:3596
26096 " pvresize-size device size\n"
26101 #: ../fish/guestfish-actions.pod:3598
26103 "This command is the same as L</pvresize> except that it allows you to "
26104 "specify the new size (in bytes) explicitly."
26108 #: ../fish/guestfish-actions.pod:3601
26113 #: ../fish/guestfish-actions.pod:3603
26121 #: ../fish/guestfish-actions.pod:3611
26122 msgid "See also L</pvs-full>."
26126 #: ../fish/guestfish-actions.pod:3613
26131 #: ../fish/guestfish-actions.pod:3615
26139 #: ../fish/guestfish-actions.pod:3620
26144 #: ../fish/guestfish-actions.pod:3622
26152 #: ../fish/guestfish-actions.pod:3626
26157 #: ../fish/guestfish-actions.pod:3628
26160 " pwrite path content offset\n"
26165 #: ../fish/guestfish-actions.pod:3639
26166 msgid "See also L</pread>, L</pwrite-device>."
26170 #: ../fish/guestfish-actions.pod:3644
26171 msgid "pwrite-device"
26175 #: ../fish/guestfish-actions.pod:3646
26178 " pwrite-device device content offset\n"
26183 #: ../fish/guestfish-actions.pod:3656
26184 msgid "See also L</pwrite>."
26188 #: ../fish/guestfish-actions.pod:3661
26193 #: ../fish/guestfish-actions.pod:3663
26196 " read-file path\n"
26201 #: ../fish/guestfish-actions.pod:3668
26203 "Unlike L</cat>, this function can correctly handle files that contain "
26204 "embedded ASCII NUL characters. However unlike L</download>, this function "
26205 "is limited in the total size of file that can be handled."
26209 #: ../fish/guestfish-actions.pod:3676
26214 #: ../fish/guestfish-actions.pod:3678
26217 " read-lines path\n"
26222 #: ../fish/guestfish-actions.pod:3685
26224 "Note that this function cannot correctly handle binary files (specifically, "
26225 "files containing C<\\0> character which is treated as end of line). For "
26226 "those you need to use the L</read-file> function which has a more complex "
26231 #: ../fish/guestfish-actions.pod:3690
26236 #: ../fish/guestfish-actions.pod:3692
26244 #: ../fish/guestfish-actions.pod:3744
26246 "This function is primarily intended for use by programs. To get a simple "
26247 "list of names, use L</ls>. To get a printable directory for human "
26248 "consumption, use L</ll>."
26252 #: ../fish/guestfish-actions.pod:3748
26257 #: ../fish/guestfish-actions.pod:3750
26265 #: ../fish/guestfish-actions.pod:3754
26266 msgid "readlinklist"
26270 #: ../fish/guestfish-actions.pod:3756
26273 " readlinklist path 'names ...'\n"
26278 #: ../fish/guestfish-actions.pod:3780
26283 #: ../fish/guestfish-actions.pod:3782
26291 #: ../fish/guestfish-actions.pod:3787
26292 msgid "removexattr"
26296 #: ../fish/guestfish-actions.pod:3789
26299 " removexattr xattr path\n"
26304 #: ../fish/guestfish-actions.pod:3794
26305 msgid "See also: L</lremovexattr>, L<attr(5)>."
26309 #: ../fish/guestfish-actions.pod:3796
26314 #: ../fish/guestfish-actions.pod:3798
26317 " resize2fs device\n"
26322 #: ../fish/guestfish-actions.pod:3803
26324 "I<Note:> It is sometimes required that you run L</e2fsck-f> on the C<device> "
26325 "before calling this command. For unknown reasons C<resize2fs> sometimes "
26326 "gives an error about this and sometimes not. In any case, it is always safe "
26327 "to call L</e2fsck-f> before calling this function."
26331 #: ../fish/guestfish-actions.pod:3809
26332 msgid "resize2fs-M"
26336 #: ../fish/guestfish-actions.pod:3811
26339 " resize2fs-M device\n"
26344 #: ../fish/guestfish-actions.pod:3813
26346 "This command is the same as L</resize2fs>, but the filesystem is resized to "
26347 "its minimum size. This works like the I<-M> option to the C<resize2fs> "
26352 #: ../fish/guestfish-actions.pod:3817
26354 "To get the resulting size of the filesystem you should call L</tune2fs-l> "
26355 "and read the C<Block size> and C<Block count> values. These two numbers, "
26356 "multiplied together, give the resulting size of the minimal filesystem in "
26361 #: ../fish/guestfish-actions.pod:3822
26362 msgid "resize2fs-size"
26366 #: ../fish/guestfish-actions.pod:3824
26369 " resize2fs-size device size\n"
26374 #: ../fish/guestfish-actions.pod:3826
26376 "This command is the same as L</resize2fs> except that it allows you to "
26377 "specify the new size (in bytes) explicitly."
26381 #: ../fish/guestfish-actions.pod:3829
26386 #: ../fish/guestfish-actions.pod:3831
26394 #: ../fish/guestfish-actions.pod:3835
26399 #: ../fish/guestfish-actions.pod:3837
26407 #: ../fish/guestfish-actions.pod:3843
26412 #: ../fish/guestfish-actions.pod:3845
26420 #: ../fish/guestfish-actions.pod:3849
26421 msgid "rmmountpoint"
26425 #: ../fish/guestfish-actions.pod:3851
26428 " rmmountpoint exemptpath\n"
26433 #: ../fish/guestfish-actions.pod:3853
26435 "This calls removes a mountpoint that was previously created with L</"
26436 "mkmountpoint>. See L</mkmountpoint> for full details."
26440 #: ../fish/guestfish-actions.pod:3857
26441 msgid "scrub-device"
26445 #: ../fish/guestfish-actions.pod:3859
26448 " scrub-device device\n"
26453 #: ../fish/guestfish-actions.pod:3870
26458 #: ../fish/guestfish-actions.pod:3872
26461 " scrub-file file\n"
26466 #: ../fish/guestfish-actions.pod:3882
26467 msgid "scrub-freespace"
26471 #: ../fish/guestfish-actions.pod:3884
26474 " scrub-freespace dir\n"
26479 #: ../fish/guestfish-actions.pod:3886
26481 "This command creates the directory C<dir> and then fills it with files until "
26482 "the filesystem is full, and scrubs the files as for L</scrub-file>, and "
26483 "deletes them. The intention is to scrub any free space on the partition "
26484 "containing C<dir>."
26488 #: ../fish/guestfish-actions.pod:3895
26493 #: ../fish/guestfish-actions.pod:3897
26498 #: ../fish/guestfish-actions.pod:3899
26501 " set-append append\n"
26506 #: ../fish/guestfish-actions.pod:3910
26507 msgid "set-attach-method"
26511 #: ../fish/guestfish-actions.pod:3912
26512 msgid "attach-method"
26516 #: ../fish/guestfish-actions.pod:3914
26519 " set-attach-method attachmethod\n"
26524 #: ../fish/guestfish-actions.pod:3936
26525 msgid "set-autosync"
26529 #: ../fish/guestfish-actions.pod:3938
26534 #: ../fish/guestfish-actions.pod:3940
26537 " set-autosync true|false\n"
26542 #: ../fish/guestfish-actions.pod:3950
26547 #: ../fish/guestfish-actions.pod:3952
26552 #: ../fish/guestfish-actions.pod:3954
26555 " set-direct true|false\n"
26560 #: ../fish/guestfish-actions.pod:3960
26562 "One consequence of this is that log messages aren't caught by the library "
26563 "and handled by L</set-log-message-callback>, but go straight to stdout."
26567 #: ../fish/guestfish-actions.pod:3969
26568 msgid "set-e2label"
26572 #: ../fish/guestfish-actions.pod:3971
26575 " set-e2label device label\n"
26580 #: ../fish/guestfish-actions.pod:3977
26582 "You can use either L</tune2fs-l> or L</get-e2label> to return the existing "
26583 "label on a filesystem."
26587 #: ../fish/guestfish-actions.pod:3980
26592 #: ../fish/guestfish-actions.pod:3982
26595 " set-e2uuid device uuid\n"
26600 #: ../fish/guestfish-actions.pod:3989
26602 "You can use either L</tune2fs-l> or L</get-e2uuid> to return the existing "
26603 "UUID of a filesystem."
26607 #: ../fish/guestfish-actions.pod:3992
26608 msgid "set-memsize"
26612 #: ../fish/guestfish-actions.pod:3994
26617 #: ../fish/guestfish-actions.pod:3996
26620 " set-memsize memsize\n"
26625 #: ../fish/guestfish-actions.pod:3998
26627 "This sets the memory size in megabytes allocated to the qemu subprocess. "
26628 "This only has any effect if called before L</launch>."
26632 #: ../fish/guestfish-actions.pod:4009
26633 msgid "set-network"
26637 #: ../fish/guestfish-actions.pod:4011
26642 #: ../fish/guestfish-actions.pod:4013
26645 " set-network true|false\n"
26650 #: ../fish/guestfish-actions.pod:4021
26652 "You must call this before calling L</launch>, otherwise it has no effect."
26656 #: ../fish/guestfish-actions.pod:4024
26661 #: ../fish/guestfish-actions.pod:4026
26666 #: ../fish/guestfish-actions.pod:4028
26669 " set-path searchpath\n"
26674 #: ../fish/guestfish-actions.pod:4037
26679 #: ../fish/guestfish-actions.pod:4039
26684 #: ../fish/guestfish-actions.pod:4041
26692 #: ../fish/guestfish-actions.pod:4061
26693 msgid "set-recovery-proc"
26697 #: ../fish/guestfish-actions.pod:4063
26698 msgid "recovery-proc"
26702 #: ../fish/guestfish-actions.pod:4065
26705 " set-recovery-proc true|false\n"
26710 #: ../fish/guestfish-actions.pod:4067
26712 "If this is called with the parameter C<false> then L</launch> does not "
26713 "create a recovery process. The purpose of the recovery process is to stop "
26714 "runaway qemu processes in the case where the main program aborts abruptly."
26718 #: ../fish/guestfish-actions.pod:4072
26720 "This only has any effect if called before L</launch>, and the default is "
26725 #: ../fish/guestfish-actions.pod:4081
26726 msgid "set-selinux"
26730 #: ../fish/guestfish-actions.pod:4083
26735 #: ../fish/guestfish-actions.pod:4085
26738 " set-selinux true|false\n"
26743 #: ../fish/guestfish-actions.pod:4096
26748 #: ../fish/guestfish-actions.pod:4098
26753 #: ../fish/guestfish-actions.pod:4100
26756 " set-trace true|false\n"
26761 #: ../fish/guestfish-actions.pod:4112
26763 "Trace messages are normally sent to C<stderr>, unless you register a "
26764 "callback to send them somewhere else (see L</set-event-callback>)."
26768 #: ../fish/guestfish-actions.pod:4116
26769 msgid "set-verbose"
26773 #: ../fish/guestfish-actions.pod:4118
26778 #: ../fish/guestfish-actions.pod:4120
26781 " set-verbose true|false\n"
26786 #: ../fish/guestfish-actions.pod:4127
26788 "Verbose messages are normally sent to C<stderr>, unless you register a "
26789 "callback to send them somewhere else (see L</set-event-callback>)."
26793 #: ../fish/guestfish-actions.pod:4131
26798 #: ../fish/guestfish-actions.pod:4133
26801 " setcon context\n"
26806 #: ../fish/guestfish-actions.pod:4140
26811 #: ../fish/guestfish-actions.pod:4142
26814 " setxattr xattr val vallen path\n"
26819 #: ../fish/guestfish-actions.pod:4148
26820 msgid "See also: L</lsetxattr>, L<attr(5)>."
26824 #: ../fish/guestfish-actions.pod:4150
26829 #: ../fish/guestfish-actions.pod:4152
26832 " sfdisk device cyls heads sectors 'lines ...'\n"
26837 #: ../fish/guestfish-actions.pod:4174
26838 msgid "See also: L</sfdisk-l>, L</sfdisk-N>, L</part-init>"
26842 #: ../fish/guestfish-actions.pod:4180 ../fish/guestfish-actions.pod:4203
26843 #: ../fish/guestfish-actions.pod:4225
26845 "This function is deprecated. In new code, use the L</part_add> call instead."
26849 #: ../fish/guestfish-actions.pod:4187
26854 #: ../fish/guestfish-actions.pod:4189
26857 " sfdiskM device 'lines ...'\n"
26862 #: ../fish/guestfish-actions.pod:4191
26864 "This is a simplified interface to the L</sfdisk> command, where partition "
26865 "sizes are specified in megabytes only (rounded to the nearest cylinder) and "
26866 "you don't need to specify the cyls, heads and sectors parameters which were "
26867 "rarely if ever used anyway."
26871 #: ../fish/guestfish-actions.pod:4197
26872 msgid "See also: L</sfdisk>, the L<sfdisk(8)> manpage and L</part-disk>"
26876 #: ../fish/guestfish-actions.pod:4210
26881 #: ../fish/guestfish-actions.pod:4212
26884 " sfdisk-N device partnum cyls heads sectors line\n"
26889 #: ../fish/guestfish-actions.pod:4217
26891 "For other parameters, see L</sfdisk>. You should usually pass C<0> for the "
26892 "cyls/heads/sectors parameters."
26896 #: ../fish/guestfish-actions.pod:4220
26897 msgid "See also: L</part-add>"
26901 #: ../fish/guestfish-actions.pod:4232
26902 msgid "sfdisk-disk-geometry"
26906 #: ../fish/guestfish-actions.pod:4234
26909 " sfdisk-disk-geometry device\n"
26914 #: ../fish/guestfish-actions.pod:4236
26916 "This displays the disk geometry of C<device> read from the partition table. "
26917 "Especially in the case where the underlying block device has been resized, "
26918 "this can be different from the kernel's idea of the geometry (see L</sfdisk-"
26919 "kernel-geometry>)."
26923 #: ../fish/guestfish-actions.pod:4244
26924 msgid "sfdisk-kernel-geometry"
26928 #: ../fish/guestfish-actions.pod:4246
26931 " sfdisk-kernel-geometry device\n"
26936 #: ../fish/guestfish-actions.pod:4253
26941 #: ../fish/guestfish-actions.pod:4255
26944 " sfdisk-l device\n"
26949 #: ../fish/guestfish-actions.pod:4261
26950 msgid "See also: L</part-list>"
26954 #: ../fish/guestfish-actions.pod:4263
26956 "This function is deprecated. In new code, use the L</part_list> call "
26961 #: ../fish/guestfish-actions.pod:4270
26966 #: ../fish/guestfish-actions.pod:4272
26974 #: ../fish/guestfish-actions.pod:4277
26975 msgid "This is like L</command>, but passes the command to:"
26979 #: ../fish/guestfish-actions.pod:4285
26980 msgid "All the provisos about L</command> apply to this call."
26984 #: ../fish/guestfish-actions.pod:4287
26989 #: ../fish/guestfish-actions.pod:4289
26992 " sh-lines command\n"
26997 #: ../fish/guestfish-actions.pod:4291
26998 msgid "This is the same as L</sh>, but splits the result into a list of lines."
27002 #: ../fish/guestfish-actions.pod:4294
27003 msgid "See also: L</command-lines>"
27007 #: ../fish/guestfish-actions.pod:4296
27012 #: ../fish/guestfish-actions.pod:4298
27020 #: ../fish/guestfish-actions.pod:4302
27025 #: ../fish/guestfish-actions.pod:4304
27033 #: ../fish/guestfish-actions.pod:4310
27038 #: ../fish/guestfish-actions.pod:4312
27046 #: ../fish/guestfish-actions.pod:4320
27051 #: ../fish/guestfish-actions.pod:4322
27059 #: ../fish/guestfish-actions.pod:4330
27064 #: ../fish/guestfish-actions.pod:4332
27067 " strings-e encoding path\n"
27072 #: ../fish/guestfish-actions.pod:4334
27074 "This is like the L</strings> command, but allows you to specify the encoding "
27075 "of strings that are looked for in the source file C<path>."
27079 #: ../fish/guestfish-actions.pod:4344
27081 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
27082 "ISO-8859-X (this is what L</strings> uses)."
27086 #: ../fish/guestfish-actions.pod:4376
27087 msgid "swapoff-device"
27091 #: ../fish/guestfish-actions.pod:4378
27094 " swapoff-device device\n"
27099 #: ../fish/guestfish-actions.pod:4380
27101 "This command disables the libguestfs appliance swap device or partition "
27102 "named C<device>. See L</swapon-device>."
27106 #: ../fish/guestfish-actions.pod:4384
27107 msgid "swapoff-file"
27111 #: ../fish/guestfish-actions.pod:4386
27114 " swapoff-file file\n"
27119 #: ../fish/guestfish-actions.pod:4390
27120 msgid "swapoff-label"
27124 #: ../fish/guestfish-actions.pod:4392
27127 " swapoff-label label\n"
27132 #: ../fish/guestfish-actions.pod:4397
27133 msgid "swapoff-uuid"
27137 #: ../fish/guestfish-actions.pod:4399
27140 " swapoff-uuid uuid\n"
27145 #: ../fish/guestfish-actions.pod:4404
27146 msgid "swapon-device"
27150 #: ../fish/guestfish-actions.pod:4406
27153 " swapon-device device\n"
27158 #: ../fish/guestfish-actions.pod:4408
27160 "This command enables the libguestfs appliance to use the swap device or "
27161 "partition named C<device>. The increased memory is made available for all "
27162 "commands, for example those run using L</command> or L</sh>."
27166 #: ../fish/guestfish-actions.pod:4420
27167 msgid "swapon-file"
27171 #: ../fish/guestfish-actions.pod:4422
27174 " swapon-file file\n"
27179 #: ../fish/guestfish-actions.pod:4424
27181 "This command enables swap to a file. See L</swapon-device> for other notes."
27185 #: ../fish/guestfish-actions.pod:4427
27186 msgid "swapon-label"
27190 #: ../fish/guestfish-actions.pod:4429
27193 " swapon-label label\n"
27198 #: ../fish/guestfish-actions.pod:4431
27200 "This command enables swap to a labeled swap partition. See L</swapon-"
27201 "device> for other notes."
27205 #: ../fish/guestfish-actions.pod:4434
27206 msgid "swapon-uuid"
27210 #: ../fish/guestfish-actions.pod:4436
27213 " swapon-uuid uuid\n"
27218 #: ../fish/guestfish-actions.pod:4438
27220 "This command enables swap to a swap partition with the given UUID. See L</"
27221 "swapon-device> for other notes."
27225 #: ../fish/guestfish-actions.pod:4441
27230 #: ../fish/guestfish-actions.pod:4443
27238 #: ../fish/guestfish-actions.pod:4451
27243 #: ../fish/guestfish-actions.pod:4453
27251 #: ../fish/guestfish-actions.pod:4461
27256 #: ../fish/guestfish-actions.pod:4463
27259 " tail-n nrlines path\n"
27264 #: ../fish/guestfish-actions.pod:4476
27269 #: ../fish/guestfish-actions.pod:4478
27272 " tar-in (tarfile|-) directory\n"
27277 #: ../fish/guestfish-actions.pod:4483
27278 msgid "To upload a compressed tarball, use L</tgz-in> or L</txz-in>."
27282 #: ../fish/guestfish-actions.pod:4488
27287 #: ../fish/guestfish-actions.pod:4490
27290 " tar-out directory (tarfile|-)\n"
27295 #: ../fish/guestfish-actions.pod:4495
27296 msgid "To download a compressed tarball, use L</tgz-out> or L</txz-out>."
27300 #: ../fish/guestfish-actions.pod:4500
27305 #: ../fish/guestfish-actions.pod:4502
27308 " tgz-in (tarball|-) directory\n"
27313 #: ../fish/guestfish-actions.pod:4507
27314 msgid "To upload an uncompressed tarball, use L</tar-in>."
27318 #: ../fish/guestfish-actions.pod:4511
27323 #: ../fish/guestfish-actions.pod:4513
27326 " tgz-out directory (tarball|-)\n"
27331 #: ../fish/guestfish-actions.pod:4518
27332 msgid "To download an uncompressed tarball, use L</tar-out>."
27336 #: ../fish/guestfish-actions.pod:4522
27341 #: ../fish/guestfish-actions.pod:4524
27349 #: ../fish/guestfish-actions.pod:4533
27354 #: ../fish/guestfish-actions.pod:4535
27362 #: ../fish/guestfish-actions.pod:4540
27363 msgid "truncate-size"
27367 #: ../fish/guestfish-actions.pod:4542
27370 " truncate-size path size\n"
27375 #: ../fish/guestfish-actions.pod:4547
27377 "If the current file size is less than C<size> then the file is extended to "
27378 "the required size with zero bytes. This creates a sparse file (ie. disk "
27379 "blocks are not allocated for the file until you write to it). To create a "
27380 "non-sparse file of zeroes, use L</fallocate64> instead."
27384 #: ../fish/guestfish-actions.pod:4553
27389 #: ../fish/guestfish-actions.pod:4555
27392 " tune2fs-l device\n"
27397 #: ../fish/guestfish-actions.pod:4565
27402 #: ../fish/guestfish-actions.pod:4567
27405 " txz-in (tarball|-) directory\n"
27410 #: ../fish/guestfish-actions.pod:4574
27415 #: ../fish/guestfish-actions.pod:4576
27418 " txz-out directory (tarball|-)\n"
27423 #: ../fish/guestfish-actions.pod:4583
27428 #: ../fish/guestfish-actions.pod:4585
27436 #: ../fish/guestfish-actions.pod:4599
27437 msgid "See also L</get-umask>, L<umask(2)>, L</mknod>, L</mkdir>."
27441 #: ../fish/guestfish-actions.pod:4604
27446 #: ../fish/guestfish-actions.pod:4606
27451 #: ../fish/guestfish-actions.pod:4608
27454 " umount pathordevice\n"
27459 #: ../fish/guestfish-actions.pod:4614
27464 #: ../fish/guestfish-actions.pod:4616
27465 msgid "unmount-all"
27469 #: ../fish/guestfish-actions.pod:4618
27477 #: ../fish/guestfish-actions.pod:4624
27482 #: ../fish/guestfish-actions.pod:4626
27485 " upload (filename|-) remotefilename\n"
27490 #: ../fish/guestfish-actions.pod:4633
27491 msgid "See also L</download>."
27495 #: ../fish/guestfish-actions.pod:4637
27496 msgid "upload-offset"
27500 #: ../fish/guestfish-actions.pod:4639
27503 " upload-offset (filename|-) remotefilename offset\n"
27508 #: ../fish/guestfish-actions.pod:4651
27510 "Note that there is no limit on the amount of data that can be uploaded with "
27511 "this call, unlike with L</pwrite>, and this call always writes the full "
27512 "amount unless an error occurs."
27516 #: ../fish/guestfish-actions.pod:4656
27517 msgid "See also L</upload>, L</pwrite>."
27521 #: ../fish/guestfish-actions.pod:4660
27526 #: ../fish/guestfish-actions.pod:4662
27529 " utimens path atsecs atnsecs mtsecs mtnsecs\n"
27534 #: ../fish/guestfish-actions.pod:4681
27539 #: ../fish/guestfish-actions.pod:4683
27547 #: ../fish/guestfish-actions.pod:4710
27549 "I<Note:> Don't use this call to test for availability of features. In "
27550 "enterprise distributions we backport features from later versions into "
27551 "earlier versions, making this an unreliable way to test for features. Use "
27552 "L</available> instead."
27556 #: ../fish/guestfish-actions.pod:4716
27561 #: ../fish/guestfish-actions.pod:4718
27564 " vfs-label device\n"
27569 #: ../fish/guestfish-actions.pod:4725
27570 msgid "To find a filesystem from the label, use L</findfs-label>."
27574 #: ../fish/guestfish-actions.pod:4727
27579 #: ../fish/guestfish-actions.pod:4729
27582 " vfs-type device\n"
27587 #: ../fish/guestfish-actions.pod:4739
27592 #: ../fish/guestfish-actions.pod:4741
27595 " vfs-uuid device\n"
27600 #: ../fish/guestfish-actions.pod:4748
27601 msgid "To find a filesystem from the UUID, use L</findfs-uuid>."
27605 #: ../fish/guestfish-actions.pod:4750
27606 msgid "vg-activate"
27610 #: ../fish/guestfish-actions.pod:4752
27613 " vg-activate true|false 'volgroups ...'\n"
27618 #: ../fish/guestfish-actions.pod:4765
27619 msgid "vg-activate-all"
27623 #: ../fish/guestfish-actions.pod:4767
27626 " vg-activate-all true|false\n"
27631 #: ../fish/guestfish-actions.pod:4777
27636 #: ../fish/guestfish-actions.pod:4779
27639 " vgcreate volgroup 'physvols ...'\n"
27644 #: ../fish/guestfish-actions.pod:4784
27649 #: ../fish/guestfish-actions.pod:4786
27652 " vglvuuids vgname\n"
27657 #: ../fish/guestfish-actions.pod:4791
27659 "You can use this along with L</lvs> and L</lvuuid> calls to associate "
27660 "logical volumes and volume groups."
27664 #: ../fish/guestfish-actions.pod:4794
27665 msgid "See also L</vgpvuuids>."
27669 #: ../fish/guestfish-actions.pod:4796
27674 #: ../fish/guestfish-actions.pod:4798
27677 " vgpvuuids vgname\n"
27682 #: ../fish/guestfish-actions.pod:4803
27684 "You can use this along with L</pvs> and L</pvuuid> calls to associate "
27685 "physical volumes and volume groups."
27689 #: ../fish/guestfish-actions.pod:4806
27690 msgid "See also L</vglvuuids>."
27694 #: ../fish/guestfish-actions.pod:4808
27699 #: ../fish/guestfish-actions.pod:4810
27702 " vgremove vgname\n"
27707 #: ../fish/guestfish-actions.pod:4817
27712 #: ../fish/guestfish-actions.pod:4819
27715 " vgrename volgroup newvolgroup\n"
27720 #: ../fish/guestfish-actions.pod:4823
27725 #: ../fish/guestfish-actions.pod:4825
27733 #: ../fish/guestfish-actions.pod:4833
27734 msgid "See also L</vgs-full>."
27738 #: ../fish/guestfish-actions.pod:4835
27743 #: ../fish/guestfish-actions.pod:4837
27751 #: ../fish/guestfish-actions.pod:4842
27756 #: ../fish/guestfish-actions.pod:4844
27764 #: ../fish/guestfish-actions.pod:4849
27769 #: ../fish/guestfish-actions.pod:4851
27777 #: ../fish/guestfish-actions.pod:4855
27782 #: ../fish/guestfish-actions.pod:4857
27790 #: ../fish/guestfish-actions.pod:4862
27795 #: ../fish/guestfish-actions.pod:4864
27803 #: ../fish/guestfish-actions.pod:4869
27808 #: ../fish/guestfish-actions.pod:4871
27816 #: ../fish/guestfish-actions.pod:4876
27821 #: ../fish/guestfish-actions.pod:4878
27824 " write path content\n"
27829 #: ../fish/guestfish-actions.pod:4886
27834 #: ../fish/guestfish-actions.pod:4888
27837 " write-file path content size\n"
27842 #: ../fish/guestfish-actions.pod:4904
27844 "This function is deprecated. In new code, use the L</write> call instead."
27848 #: ../fish/guestfish-actions.pod:4911
27853 #: ../fish/guestfish-actions.pod:4913
27856 " zegrep regex path\n"
27861 #: ../fish/guestfish-actions.pod:4921
27866 #: ../fish/guestfish-actions.pod:4923
27869 " zegrepi regex path\n"
27874 #: ../fish/guestfish-actions.pod:4931
27879 #: ../fish/guestfish-actions.pod:4933
27887 #: ../fish/guestfish-actions.pod:4941
27888 msgid "See also: L</zero-device>, L</scrub-device>."
27892 #: ../fish/guestfish-actions.pod:4943
27893 msgid "zero-device"
27897 #: ../fish/guestfish-actions.pod:4945
27900 " zero-device device\n"
27905 #: ../fish/guestfish-actions.pod:4947
27907 "This command writes zeroes over the entire C<device>. Compare with L</zero> "
27908 "which just zeroes the first few blocks of a device."
27912 #: ../fish/guestfish-actions.pod:4954
27917 #: ../fish/guestfish-actions.pod:4956
27920 " zerofree device\n"
27925 #: ../fish/guestfish-actions.pod:4969
27930 #: ../fish/guestfish-actions.pod:4971
27933 " zfgrep pattern path\n"
27938 #: ../fish/guestfish-actions.pod:4979
27943 #: ../fish/guestfish-actions.pod:4981
27946 " zfgrepi pattern path\n"
27951 #: ../fish/guestfish-actions.pod:4989
27956 #: ../fish/guestfish-actions.pod:4991
27959 " zfile meth path\n"
27964 #: ../fish/guestfish-actions.pod:4998
27966 "Since 1.0.63, use L</file> instead which can now process compressed files."
27970 #: ../fish/guestfish-actions.pod:5001
27972 "This function is deprecated. In new code, use the L</file> call instead."
27976 #: ../fish/guestfish-actions.pod:5008
27981 #: ../fish/guestfish-actions.pod:5010
27984 " zgrep regex path\n"
27989 #: ../fish/guestfish-actions.pod:5018
27994 #: ../fish/guestfish-actions.pod:5020
27997 " zgrepi regex path\n"
28002 #: ../fish/guestfish-commands.pod:1
28007 #: ../fish/guestfish-commands.pod:3
28012 #: ../fish/guestfish-commands.pod:5
28015 " alloc filename size\n"
28020 #: ../fish/guestfish-commands.pod:7
28022 "This creates an empty (zeroed) file of the given size, and then adds so it "
28023 "can be further examined."
28027 #: ../fish/guestfish-commands.pod:10 ../fish/guestfish-commands.pod:168
28028 msgid "For more advanced image creation, see L<qemu-img(1)> utility."
28032 #: ../fish/guestfish-commands.pod:12 ../fish/guestfish-commands.pod:170
28033 msgid "Size can be specified using standard suffixes, eg. C<1M>."
28037 #: ../fish/guestfish-commands.pod:14
28039 "To create a sparse file, use L</sparse> instead. To create a prepared disk "
28040 "image, see L</PREPARED DISK IMAGES>."
28044 #: ../fish/guestfish-commands.pod:17
28049 #: ../fish/guestfish-commands.pod:19
28052 " copy-in local [local ...] /remotedir\n"
28057 #: ../fish/guestfish-commands.pod:21
28059 "C<copy-in> copies local files or directories recursively into the disk "
28060 "image, placing them in the directory called C</remotedir> (which must "
28061 "exist). This guestfish meta-command turns into a sequence of L</tar-in> and "
28062 "other commands as necessary."
28066 #: ../fish/guestfish-commands.pod:26
28068 "Multiple local files and directories can be specified, but the last "
28069 "parameter must always be a remote directory. Wildcards cannot be used."
28073 #: ../fish/guestfish-commands.pod:30
28078 #: ../fish/guestfish-commands.pod:32
28081 " copy-out remote [remote ...] localdir\n"
28086 #: ../fish/guestfish-commands.pod:34
28088 "C<copy-out> copies remote files or directories recursively out of the disk "
28089 "image, placing them on the host disk in a local directory called C<localdir> "
28090 "(which must exist). This guestfish meta-command turns into a sequence of L</"
28091 "download>, L</tar-out> and other commands as necessary."
28095 #: ../fish/guestfish-commands.pod:40
28097 "Multiple remote files and directories can be specified, but the last "
28098 "parameter must always be a local directory. To download to the current "
28099 "directory, use C<.> as in:"
28103 #: ../fish/guestfish-commands.pod:44
28106 " copy-out /home .\n"
28111 #: ../fish/guestfish-commands.pod:46
28113 "Wildcards cannot be used in the ordinary command, but you can use them with "
28114 "the help of L</glob> like this:"
28118 #: ../fish/guestfish-commands.pod:49
28121 " glob copy-out /home/* .\n"
28126 #: ../fish/guestfish-commands.pod:51
28131 #: ../fish/guestfish-commands.pod:53
28134 " echo [params ...]\n"
28139 #: ../fish/guestfish-commands.pod:55
28140 msgid "This echos the parameters to the terminal."
28144 #: ../fish/guestfish-commands.pod:57
28149 #: ../fish/guestfish-commands.pod:59
28154 #: ../fish/guestfish-commands.pod:61
28159 #: ../fish/guestfish-commands.pod:63
28167 #: ../fish/guestfish-commands.pod:65
28169 "This is used to edit a file. It downloads the file, edits it locally using "
28170 "your editor, then uploads the result."
28174 #: ../fish/guestfish-commands.pod:68
28176 "The editor is C<$EDITOR>. However if you use the alternate commands C<vi> "
28177 "or C<emacs> you will get those corresponding editors."
28181 #: ../fish/guestfish-commands.pod:72
28186 #: ../fish/guestfish-commands.pod:74
28189 " glob command args...\n"
28194 #: ../fish/guestfish-commands.pod:76
28196 "Expand wildcards in any paths in the args list, and run C<command> "
28197 "repeatedly on each matching path."
28201 #: ../fish/guestfish-commands.pod:79
28202 msgid "See L</WILDCARDS AND GLOBBING>."
28206 #: ../fish/guestfish-commands.pod:81
28211 #: ../fish/guestfish-commands.pod:83
28214 " hexedit <filename|device>\n"
28215 " hexedit <filename|device> <max>\n"
28216 " hexedit <filename|device> <start> <max>\n"
28221 #: ../fish/guestfish-commands.pod:87
28223 "Use hexedit (a hex editor) to edit all or part of a binary file or block "
28228 #: ../fish/guestfish-commands.pod:90
28230 "This command works by downloading potentially the whole file or device, "
28231 "editing it locally, then uploading it. If the file or device is large, you "
28232 "have to specify which part you wish to edit by using C<max> and/or C<start> "
28233 "C<max> parameters. C<start> and C<max> are specified in bytes, with the "
28234 "usual modifiers allowed such as C<1M> (1 megabyte)."
28238 #: ../fish/guestfish-commands.pod:97
28239 msgid "For example to edit the first few sectors of a disk you might do:"
28243 #: ../fish/guestfish-commands.pod:100
28246 " hexedit /dev/sda 1M\n"
28251 #: ../fish/guestfish-commands.pod:102
28253 "which would allow you to edit anywhere within the first megabyte of the disk."
28257 #: ../fish/guestfish-commands.pod:105
28258 msgid "To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:"
28262 #: ../fish/guestfish-commands.pod:107
28265 " hexedit /dev/sda1 0x400 0x400\n"
28270 #: ../fish/guestfish-commands.pod:109
28271 msgid "(assuming the superblock is in the standard location)."
28275 #: ../fish/guestfish-commands.pod:111
28277 "This command requires the external L<hexedit(1)> program. You can specify "
28278 "another program to use by setting the C<HEXEDITOR> environment variable."
28282 #: ../fish/guestfish-commands.pod:115
28283 msgid "See also L</hexdump>."
28287 #: ../fish/guestfish-commands.pod:117
28292 #: ../fish/guestfish-commands.pod:119
28300 #: ../fish/guestfish-commands.pod:121
28302 "Change the local directory, ie. the current directory of guestfish itself."
28306 #: ../fish/guestfish-commands.pod:124
28307 msgid "Note that C<!cd> won't do what you might expect."
28311 #: ../fish/guestfish-commands.pod:126
28316 #: ../fish/guestfish-commands.pod:128
28321 #: ../fish/guestfish-commands.pod:130
28329 #: ../fish/guestfish-commands.pod:132
28330 msgid "Opens the manual page for guestfish."
28334 #: ../fish/guestfish-commands.pod:134
28339 #: ../fish/guestfish-commands.pod:136
28344 #: ../fish/guestfish-commands.pod:138
28352 #: ../fish/guestfish-commands.pod:140
28360 #: ../fish/guestfish-commands.pod:142
28361 msgid "This is used to view a file."
28365 #: ../fish/guestfish-commands.pod:144
28367 "The default viewer is C<$PAGER>. However if you use the alternate command "
28368 "C<less> you will get the C<less> command specifically."
28372 #: ../fish/guestfish-commands.pod:147
28377 #: ../fish/guestfish-commands.pod:149
28385 #: ../fish/guestfish-commands.pod:151
28387 "Close and reopen the libguestfs handle. It is not necessary to use this "
28388 "normally, because the handle is closed properly when guestfish exits. "
28389 "However this is occasionally useful for testing."
28393 #: ../fish/guestfish-commands.pod:155
28398 #: ../fish/guestfish-commands.pod:157
28401 " sparse filename size\n"
28406 #: ../fish/guestfish-commands.pod:159
28408 "This creates an empty sparse file of the given size, and then adds so it can "
28409 "be further examined."
28413 #: ../fish/guestfish-commands.pod:162
28415 "In all respects it works the same as the L</alloc> command, except that the "
28416 "image file is allocated sparsely, which means that disk blocks are not "
28417 "assigned to the file until they are needed. Sparse disk files only use "
28418 "space when written to, but they are slower and there is a danger you could "
28419 "run out of real disk space during a write operation."
28423 #: ../fish/guestfish-commands.pod:172
28428 #: ../fish/guestfish-commands.pod:174
28436 #: ../fish/guestfish-commands.pod:176
28438 "This command returns a list of the optional groups known to the daemon, and "
28439 "indicates which ones are supported by this build of the libguestfs appliance."
28443 #: ../fish/guestfish-commands.pod:180
28444 msgid "See also L<guestfs(3)/AVAILABILITY>."
28448 #: ../fish/guestfish-commands.pod:182
28453 #: ../fish/guestfish-commands.pod:184
28456 " time command args...\n"
28461 #: ../fish/guestfish-commands.pod:186
28463 "Run the command as usual, but print the elapsed time afterwards. This can "
28464 "be useful for benchmarking operations."
28468 #: ../test-tool/libguestfs-test-tool.pod:5
28469 msgid "libguestfs-test-tool - End user tests for libguestfs"
28473 #: ../test-tool/libguestfs-test-tool.pod:9
28476 " libguestfs-test-tool [--options]\n"
28481 #: ../test-tool/libguestfs-test-tool.pod:13
28483 "libguestfs-test-tool is a test program shipped with libguestfs to end users "
28484 "and developers, to allow them to check basic libguestfs functionality is "
28485 "working. This is needed because libguestfs occasionally breaks for reasons "
28486 "beyond our control: usually because of changes in the underlying qemu or "
28487 "kernel packages, or the host environment."
28491 #: ../test-tool/libguestfs-test-tool.pod:20
28492 msgid "If you suspect a problem in libguestfs, then just run:"
28496 #: ../test-tool/libguestfs-test-tool.pod:22
28499 " libguestfs-test-tool\n"
28504 #: ../test-tool/libguestfs-test-tool.pod:24
28505 msgid "It will print lots of diagnostic messages."
28509 #: ../test-tool/libguestfs-test-tool.pod:26
28510 msgid "If it runs to completion successfully, you will see this near the end:"
28514 #: ../test-tool/libguestfs-test-tool.pod:28
28517 " ===== TEST FINISHED OK =====\n"
28522 #: ../test-tool/libguestfs-test-tool.pod:30
28523 msgid "and the test tool will exit with code 0."
28527 #: ../test-tool/libguestfs-test-tool.pod:32
28529 "If it fails (and/or exits with non-zero error code), please paste the "
28530 "B<complete, unedited> output of the test tool into a bug report. More "
28531 "information about reporting bugs can be found on the L<http://libguestfs.org/"
28536 #: ../test-tool/libguestfs-test-tool.pod:41
28541 #: ../test-tool/libguestfs-test-tool.pod:43
28542 msgid "Display short usage information and exit."
28546 #: ../test-tool/libguestfs-test-tool.pod:45
28547 msgid "I<--qemu qemu_binary>"
28551 #: ../test-tool/libguestfs-test-tool.pod:47
28553 "If you have downloaded another qemu binary, point this option at the full "
28554 "path of the binary to try it."
28558 #: ../test-tool/libguestfs-test-tool.pod:50
28559 msgid "I<--qemudir qemu_source_dir>"
28563 #: ../test-tool/libguestfs-test-tool.pod:52
28565 "If you have compiled qemu from source, point this option at the source "
28566 "directory to try it."
28570 #: ../test-tool/libguestfs-test-tool.pod:55
28571 msgid "I<--timeout N>"
28575 #: ../test-tool/libguestfs-test-tool.pod:57
28577 "Set the launch timeout to C<N> seconds. The default is 120 seconds which "
28578 "does not usually need to be adjusted unless your machine is very slow."
28582 #: ../test-tool/libguestfs-test-tool.pod:63
28583 msgid "TRYING OUT A DIFFERENT VERSION OF QEMU"
28587 #: ../test-tool/libguestfs-test-tool.pod:65
28589 "If you have compiled another version of qemu from source and would like to "
28590 "try that, then you can use the I<--qemudir> option to point to the qemu "
28591 "source directory."
28595 #: ../test-tool/libguestfs-test-tool.pod:69
28597 "If you have downloaded a qemu binary from somewhere, use the I<--qemu> "
28598 "option to point to the binary."
28602 #: ../test-tool/libguestfs-test-tool.pod:72
28604 "When using an alternate qemu with libguestfs, usually you would need to "
28605 "write a qemu wrapper script (see section I<QEMU WRAPPERS> in L<guestfs(3)"
28606 ">). libguestfs-test-tool writes a temporary qemu wrapper script when you "
28607 "use either of the I<--qemudir> or I<--qemu> options."
28611 #: ../test-tool/libguestfs-test-tool.pod:79
28613 "libguestfs-test-tool returns I<0> if the tests completed without error, or "
28614 "I<1> if there was an error."
28618 #: ../test-tool/libguestfs-test-tool.pod:84
28620 "For the full list of environment variables which may affect libguestfs, "
28621 "please see the L<guestfs(3)> manual page."
28625 #: ../test-tool/libguestfs-test-tool.pod:89
28626 msgid "L<guestfs(3)>, L<http://libguestfs.org/>, L<http://qemu.org/>."
28630 #: ../fuse/guestmount.pod:5
28632 "guestmount - Mount a guest filesystem on the host using FUSE and libguestfs"
28636 #: ../fuse/guestmount.pod:9
28639 " guestmount [--options] -a disk.img -m device [--ro] mountpoint\n"
28644 #: ../fuse/guestmount.pod:11
28647 " guestmount [--options] -a disk.img -i [--ro] mountpoint\n"
28652 #: ../fuse/guestmount.pod:13
28655 " guestmount [--options] -d Guest -i [--ro] mountpoint\n"
28660 #: ../fuse/guestmount.pod:17
28662 "You must I<not> use C<guestmount> in read-write mode on live virtual "
28663 "machines. If you do this, you risk disk corruption in the VM."
28667 #: ../fuse/guestmount.pod:22
28669 "The guestmount program can be used to mount virtual machine filesystems and "
28670 "other disk images on the host. It uses libguestfs for access to the guest "
28671 "filesystem, and FUSE (the \"filesystem in userspace\") to make it appear as "
28672 "a mountable device."
28676 #: ../fuse/guestmount.pod:27
28678 "Along with other options, you have to give at least one device (I<-a> "
28679 "option) or libvirt domain (I<-d> option), and at least one mountpoint (I<-m> "
28680 "option) or use the I<-i> inspection option. How this works is better "
28681 "explained in the L<guestfish(1)> manual page, or by looking at the examples "
28686 #: ../fuse/guestmount.pod:33
28688 "FUSE lets you mount filesystems as non-root. The mountpoint must be owned "
28689 "by you, and the filesystem will not be visible to any other users unless you "
28690 "make certain global configuration changes to C</etc/fuse.conf>. To unmount "
28691 "the filesystem, use the C<fusermount -u> command."
28695 #: ../fuse/guestmount.pod:41
28697 "For a typical Windows guest which has its main filesystem on the first "
28702 #: ../fuse/guestmount.pod:44
28705 " guestmount -a windows.img -m /dev/sda1 --ro /mnt\n"
28710 #: ../fuse/guestmount.pod:46
28712 "For a typical Linux guest which has a /boot filesystem on the first "
28713 "partition, and the root filesystem on a logical volume:"
28717 #: ../fuse/guestmount.pod:49
28720 " guestmount -a linux.img -m /dev/VG/LV -m /dev/sda1:/boot --ro /mnt\n"
28725 #: ../fuse/guestmount.pod:51
28726 msgid "To get libguestfs to detect guest mountpoints for you:"
28730 #: ../fuse/guestmount.pod:53
28733 " guestmount -a guest.img -i --ro /mnt\n"
28738 #: ../fuse/guestmount.pod:55
28739 msgid "For a libvirt guest called \"Guest\" you could do:"
28743 #: ../fuse/guestmount.pod:57
28746 " guestmount -d Guest -i --ro /mnt\n"
28751 #: ../fuse/guestmount.pod:59
28753 "If you don't know what filesystems are contained in a guest or disk image, "
28754 "use L<virt-filesystems(1)> first:"
28758 #: ../fuse/guestmount.pod:62
28761 " virt-filesystems MyGuest\n"
28766 #: ../fuse/guestmount.pod:64
28768 "If you want to trace the libguestfs calls but without excessive debugging "
28769 "information, we recommend:"
28773 #: ../fuse/guestmount.pod:67
28776 " guestmount [...] --trace /mnt\n"
28781 #: ../fuse/guestmount.pod:69
28782 msgid "If you want to debug the program, we recommend:"
28786 #: ../fuse/guestmount.pod:71
28789 " guestmount [...] --trace --verbose /mnt\n"
28794 #: ../fuse/guestmount.pod:73
28799 #: ../fuse/guestmount.pod:75
28800 msgid "Other users cannot see the filesystem by default"
28804 #: ../fuse/guestmount.pod:77
28806 "If you mount a filesystem as one user (eg. root), then other users will not "
28807 "be able to see it by default. The fix is to add the FUSE C<allow_other> "
28808 "option when mounting:"
28812 #: ../fuse/guestmount.pod:81
28815 " sudo guestmount [...] -o allow_other /mnt\n"
28820 #: ../fuse/guestmount.pod:87
28821 msgid "B<-a image> | B<--add image>"
28825 #: ../fuse/guestmount.pod:89
28826 msgid "Add a block device or virtual machine image."
28830 #: ../fuse/guestmount.pod:94
28831 msgid "B<-c URI> | B<--connect URI>"
28835 #: ../fuse/guestmount.pod:100
28836 msgid "B<-d libvirt-domain> | B<--domain libvirt-domain>"
28840 #: ../fuse/guestmount.pod:106
28841 msgid "B<--dir-cache-timeout N>"
28845 #: ../fuse/guestmount.pod:108
28847 "Set the readdir cache timeout to I<N> seconds, the default being 60 "
28848 "seconds. The readdir cache [actually, there are several semi-independent "
28849 "caches] is populated after a readdir(2) call with the stat and extended "
28850 "attributes of the files in the directory, in anticipation that they will be "
28851 "requested soon after."
28855 #: ../fuse/guestmount.pod:114
28857 "There is also a different attribute cache implemented by FUSE (see the FUSE "
28858 "option I<-o attr_timeout>), but the FUSE cache does not anticipate future "
28859 "requests, only cache existing ones."
28863 #: ../fuse/guestmount.pod:125
28864 msgid "B<--format=raw|qcow2|..> | B<--format>"
28868 #: ../fuse/guestmount.pod:132
28870 "If you have untrusted raw-format guest disk images, you should use this "
28871 "option to specify the disk format. This avoids a possible security problem "
28872 "with malicious guests (CVE-2010-3851). See also L<guestfs(3)/"
28873 "guestfs_add_drive_opts>."
28877 #: ../fuse/guestmount.pod:137
28878 msgid "B<--fuse-help>"
28882 #: ../fuse/guestmount.pod:139
28883 msgid "Display help on special FUSE options (see I<-o> below)."
28887 #: ../fuse/guestmount.pod:143
28888 msgid "Display brief help and exit."
28892 #: ../fuse/guestmount.pod:145
28893 msgid "B<-i> | B<--inspector>"
28897 #: ../fuse/guestmount.pod:165
28899 "Mount the named partition or logical volume on the given mountpoint B<in the "
28900 "guest> (this has nothing to do with mountpoints in the host)."
28904 #: ../fuse/guestmount.pod:168
28906 "If the mountpoint is omitted, it defaults to C</>. You have to mount "
28907 "something on C</>."
28911 #: ../fuse/guestmount.pod:181
28912 msgid "B<-n> | B<--no-sync>"
28916 #: ../fuse/guestmount.pod:183
28918 "By default, we attempt to sync the guest disk when the FUSE mountpoint is "
28919 "unmounted. If you specify this option, then we don't attempt to sync the "
28920 "disk. See the discussion of autosync in the L<guestfs(3)> manpage."
28924 #: ../fuse/guestmount.pod:188
28925 msgid "B<-o option> | B<--option option>"
28929 #: ../fuse/guestmount.pod:190
28930 msgid "Pass extra options to FUSE."
28934 #: ../fuse/guestmount.pod:192
28936 "To get a list of all the extra options supported by FUSE, use the command "
28937 "below. Note that only the FUSE I<-o> options can be passed, and only some "
28938 "of them are a good idea."
28942 #: ../fuse/guestmount.pod:196
28945 " guestmount --fuse-help\n"
28950 #: ../fuse/guestmount.pod:198
28951 msgid "Some potentially useful FUSE options:"
28955 #: ../fuse/guestmount.pod:202
28956 msgid "B<-o allow_other>"
28960 #: ../fuse/guestmount.pod:204
28961 msgid "Allow other users to see the filesystem."
28965 #: ../fuse/guestmount.pod:206
28966 msgid "B<-o attr_timeout=N>"
28970 #: ../fuse/guestmount.pod:208
28971 msgid "Enable attribute caching by FUSE, and set the timeout to I<N> seconds."
28975 #: ../fuse/guestmount.pod:210
28976 msgid "B<-o kernel_cache>"
28980 #: ../fuse/guestmount.pod:212
28982 "Allow the kernel to cache files (reduces the number of reads that have to go "
28983 "through the L<guestfs(3)> API). This is generally a good idea if you can "
28984 "afford the extra memory usage."
28988 #: ../fuse/guestmount.pod:216
28989 msgid "B<-o uid=N> B<-o gid=N>"
28993 #: ../fuse/guestmount.pod:218
28995 "Use these options to map all UIDs and GIDs inside the guest filesystem to "
28996 "the chosen values."
29000 #: ../fuse/guestmount.pod:223
29001 msgid "B<-r> | B<--ro>"
29005 #: ../fuse/guestmount.pod:225
29007 "Add devices and mount everything read-only. Also disallow writes and make "
29008 "the disk appear read-only to FUSE."
29012 #: ../fuse/guestmount.pod:228
29014 "This is highly recommended if you are not going to edit the guest disk. If "
29015 "the guest is running and this option is I<not> supplied, then there is a "
29016 "strong risk of disk corruption in the guest. We try to prevent this from "
29017 "happening, but it is not always possible."
29021 #: ../fuse/guestmount.pod:233
29022 msgid "See also L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
29026 #: ../fuse/guestmount.pod:237
29027 msgid "Enable SELinux support for the guest."
29031 #: ../fuse/guestmount.pod:239
29032 msgid "B<-v> | B<--verbose>"
29036 #: ../fuse/guestmount.pod:241
29037 msgid "Enable verbose messages from underlying libguestfs."
29041 #: ../fuse/guestmount.pod:243
29042 msgid "B<-V> | B<--version>"
29046 #: ../fuse/guestmount.pod:245
29047 msgid "Display the program version and exit."
29051 #: ../fuse/guestmount.pod:247
29052 msgid "B<-w> | B<--rw>"
29056 #: ../fuse/guestmount.pod:252 ../fuse/guestmount.pod:273
29057 msgid "See L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
29061 #: ../fuse/guestmount.pod:254
29062 msgid "B<-x> | B<--trace>"
29066 #: ../fuse/guestmount.pod:256
29067 msgid "Trace libguestfs calls and entry into each FUSE function."
29071 #: ../fuse/guestmount.pod:258
29072 msgid "This also stops the daemon from forking into the background."
29076 #: ../fuse/guestmount.pod:279
29078 "L<guestfish(1)>, L<virt-inspector(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
29079 "L<virt-tar(1)>, L<guestfs(3)>, L<http://libguestfs.org/>, L<http://fuse.sf."
29084 #: ../fuse/guestmount.pod:294
29085 msgid "Copyright (C) 2009-2010 Red Hat Inc. L<http://libguestfs.org/>"
29089 #: ../tools/virt-edit.pl:34
29090 msgid "virt-edit - Edit a file in a virtual machine"
29094 #: ../tools/virt-edit.pl:38
29097 " virt-edit [--options] domname file\n"
29102 #: ../tools/virt-edit.pl:40
29105 " virt-edit [--options] disk.img [disk.img ...] file\n"
29110 #: ../tools/virt-edit.pl:42
29113 " virt-edit [domname|disk.img] file -e 'expr'\n"
29118 #: ../tools/virt-edit.pl:46
29120 "You must I<not> use C<virt-edit> on live virtual machines. If you do this, "
29121 "you risk disk corruption in the VM. C<virt-edit> tries to stop you from "
29122 "doing this, but doesn't catch all cases."
29126 #: ../tools/virt-edit.pl:52
29128 "C<virt-edit> is a command line tool to edit C<file> where C<file> exists in "
29129 "the named virtual machine (or disk image)."
29133 #: ../tools/virt-edit.pl:55
29134 msgid "If you want to just view a file, use L<virt-cat(1)>."
29138 #: ../tools/virt-edit.pl:57
29140 "For more complex cases you should look at the L<guestfish(1)> tool (see L</"
29141 "USING GUESTFISH> below)."
29145 #: ../tools/virt-edit.pl:60
29147 "C<virt-edit> cannot be used to create a new file, nor to edit multiple "
29148 "files. L<guestfish(1)> can do that and much more."
29152 #: ../tools/virt-edit.pl:65
29153 msgid "Edit the named files interactively:"
29157 #: ../tools/virt-edit.pl:67
29160 " virt-edit mydomain /boot/grub/grub.conf\n"
29165 #: ../tools/virt-edit.pl:69
29168 " virt-edit mydomain /etc/passwd\n"
29173 #: ../tools/virt-edit.pl:71
29174 msgid "For Windows guests, some Windows paths are understood:"
29178 #: ../tools/virt-edit.pl:73
29181 " virt-edit mywindomain 'c:\\autoexec.bat'\n"
29186 #: ../tools/virt-edit.pl:75
29188 "You can also edit files non-interactively (see L</NON-INTERACTIVE EDITING> "
29189 "below). To change the init default level to 5:"
29193 #: ../tools/virt-edit.pl:79
29196 " virt-edit mydomain /etc/inittab -e 's/^id:.*/id:5:initdefault:/'\n"
29201 #: ../tools/virt-edit.pl:91 ../tools/virt-win-reg.pl:106
29202 #: ../tools/virt-list-filesystems.pl:63 ../tools/virt-tar.pl:113
29203 #: ../tools/virt-make-fs.pl:163 ../tools/virt-list-partitions.pl:64
29204 msgid "Display brief help."
29208 #: ../tools/virt-edit.pl:99 ../tools/virt-win-reg.pl:114
29209 #: ../tools/virt-list-filesystems.pl:71 ../tools/virt-tar.pl:121
29210 #: ../tools/virt-make-fs.pl:171 ../tools/virt-list-partitions.pl:72
29211 msgid "Display version number and exit."
29215 #: ../tools/virt-edit.pl:105
29216 msgid "B<--backup extension> | B<-b extension>"
29220 #: ../tools/virt-edit.pl:107
29222 "Create a backup of the original file I<in the guest disk image>. The backup "
29223 "has the original filename with C<extension> added."
29227 #: ../tools/virt-edit.pl:110
29229 "Usually the first character of C<extension> would be a dot C<.> so you would "
29234 #: ../tools/virt-edit.pl:113
29237 " virt-edit -b .orig [etc]\n"
29242 #: ../tools/virt-edit.pl:115
29243 msgid "By default, no backup file is made."
29247 #: ../tools/virt-edit.pl:121 ../tools/virt-win-reg.pl:128
29248 #: ../tools/virt-list-filesystems.pl:77 ../tools/virt-tar.pl:127
29249 #: ../tools/virt-list-partitions.pl:78
29250 msgid "B<--connect URI> | B<-c URI>"
29254 #: ../tools/virt-edit.pl:123 ../tools/virt-win-reg.pl:130
29255 #: ../tools/virt-list-filesystems.pl:79 ../tools/virt-tar.pl:129
29256 #: ../tools/virt-list-partitions.pl:80
29258 "If using libvirt, connect to the given I<URI>. If omitted, then we connect "
29259 "to the default libvirt hypervisor."
29263 #: ../tools/virt-edit.pl:126 ../tools/virt-win-reg.pl:133
29264 #: ../tools/virt-list-filesystems.pl:82 ../tools/virt-tar.pl:132
29265 #: ../tools/virt-list-partitions.pl:83
29267 "If you specify guest block devices directly, then libvirt is not used at all."
29271 #: ../tools/virt-edit.pl:133 ../tools/virt-win-reg.pl:140
29272 #: ../tools/virt-list-filesystems.pl:89 ../tools/virt-tar.pl:139
29273 #: ../tools/virt-list-partitions.pl:90
29274 msgid "B<--format> raw"
29278 #: ../tools/virt-edit.pl:135 ../tools/virt-win-reg.pl:142
29279 #: ../tools/virt-list-filesystems.pl:91 ../tools/virt-tar.pl:141
29280 #: ../tools/virt-list-partitions.pl:92
29282 "Specify the format of disk images given on the command line. If this is "
29283 "omitted then the format is autodetected from the content of the disk image."
29287 #: ../tools/virt-edit.pl:139 ../tools/virt-win-reg.pl:146
29288 #: ../tools/virt-list-filesystems.pl:95 ../tools/virt-tar.pl:145
29289 #: ../tools/virt-list-partitions.pl:96
29291 "If disk images are requested from libvirt, then this program asks libvirt "
29292 "for this information. In this case, the value of the format parameter is "
29297 #: ../tools/virt-edit.pl:143 ../tools/virt-win-reg.pl:150
29298 #: ../tools/virt-list-filesystems.pl:99 ../tools/virt-tar.pl:149
29299 #: ../tools/virt-list-partitions.pl:100
29301 "If working with untrusted raw-format guest disk images, you should ensure "
29302 "the format is always specified."
29306 #: ../tools/virt-edit.pl:150
29307 msgid "B<--expr EXPR> | B<-e EXPR>"
29311 #: ../tools/virt-edit.pl:152
29313 "Instead of launching the external editor, non-interactively apply the Perl "
29314 "expression C<EXPR> to each line in the file. See L</NON-INTERACTIVE "
29319 #: ../tools/virt-edit.pl:156
29321 "Be careful to properly quote the expression to prevent it from being altered "
29326 #: ../tools/virt-edit.pl:280
29327 msgid "NON-INTERACTIVE EDITING"
29331 #: ../tools/virt-edit.pl:282
29333 "C<virt-edit> normally calls out to C<$EDITOR> (or vi) so the system "
29334 "administrator can interactively edit the file."
29338 #: ../tools/virt-edit.pl:285
29340 "There are two ways also to use C<virt-edit> from scripts in order to make "
29341 "automated edits to files. (Note that although you I<can> use C<virt-edit> "
29342 "like this, it's less error-prone to write scripts directly using the "
29343 "libguestfs API and Augeas for configuration file editing.)"
29347 #: ../tools/virt-edit.pl:291
29349 "The first method is to temporarily set C<$EDITOR> to any script or program "
29350 "you want to run. The script is invoked as C<$EDITOR tmpfile> and it should "
29351 "update C<tmpfile> in place however it likes."
29355 #: ../tools/virt-edit.pl:295
29357 "The second method is to use the I<-e> parameter of C<virt-edit> to run a "
29358 "short Perl snippet in the style of L<sed(1)>. For example to replace all "
29359 "instances of C<foo> with C<bar> in a file:"
29363 #: ../tools/virt-edit.pl:299
29366 " virt-edit domname filename -e 's/foo/bar/'\n"
29371 #: ../tools/virt-edit.pl:301
29373 "The full power of Perl regular expressions can be used (see L<perlre(1)>). "
29374 "For example to delete root's password you could do:"
29378 #: ../tools/virt-edit.pl:304
29381 " virt-edit domname /etc/passwd -e 's/^root:.*?:/root::/'\n"
29386 #: ../tools/virt-edit.pl:306
29388 "What really happens is that the snippet is evaluated as a Perl expression "
29389 "for each line of the file. The line, including the final C<\\n>, is passed "
29390 "in C<$_> and the expression should update C<$_> or leave it unchanged."
29394 #: ../tools/virt-edit.pl:311
29396 "To delete a line, set C<$_> to the empty string. For example, to delete the "
29397 "C<apache> user account from the password file you can do:"
29401 #: ../tools/virt-edit.pl:314
29404 " virt-edit mydomain /etc/passwd -e '$_ = \"\" if /^apache:/'\n"
29409 #: ../tools/virt-edit.pl:316
29411 "To insert a line, prepend or append it to C<$_>. However appending lines to "
29412 "the end of the file is rather difficult this way since there is no concept "
29413 "of \"last line of the file\" - your expression just doesn't get called "
29414 "again. You might want to use the first method (setting C<$EDITOR>) if you "
29419 #: ../tools/virt-edit.pl:322
29421 "The variable C<$lineno> contains the current line number. As is "
29422 "traditional, the first line in the file is number C<1>."
29426 #: ../tools/virt-edit.pl:325
29428 "The return value from the expression is ignored, but the expression may call "
29429 "C<die> in order to abort the whole program, leaving the original file "
29434 #: ../tools/virt-edit.pl:329
29436 "Remember when matching the end of a line that C<$_> may contain the final C<"
29437 "\\n>, or (for DOS files) C<\\r\\n>, or if the file does not end with a "
29438 "newline then neither of these. Thus to match or substitute some text at the "
29439 "end of a line, use this regular expression:"
29443 #: ../tools/virt-edit.pl:334
29446 " /some text(\\r?\\n)?$/\n"
29451 #: ../tools/virt-edit.pl:336
29453 "Alternately, use the perl C<chomp> function, being careful not to chomp C<"
29454 "$_> itself (since that would remove all newlines from the file):"
29458 #: ../tools/virt-edit.pl:340
29461 " my $m = $_; chomp $m; $m =~ /some text$/\n"
29466 #: ../tools/virt-edit.pl:344
29468 "C<virt-edit> has a limited ability to understand Windows drive letters and "
29469 "paths (eg. C<E:\\foo\\bar.txt>)."
29473 #: ../tools/virt-edit.pl:347
29474 msgid "If and only if the guest is running Windows then:"
29478 #: ../tools/virt-edit.pl:353
29480 "Drive letter prefixes like C<C:> are resolved against the Windows Registry "
29481 "to the correct filesystem."
29485 #: ../tools/virt-edit.pl:358
29487 "Any backslash (C<\\>) characters in the path are replaced with forward "
29488 "slashes so that libguestfs can process it."
29492 #: ../tools/virt-edit.pl:363
29494 "The path is resolved case insensitively to locate the file that should be "
29499 #: ../tools/virt-edit.pl:368
29500 msgid "There are some known shortcomings:"
29504 #: ../tools/virt-edit.pl:374
29505 msgid "Some NTFS symbolic links may not be followed correctly."
29509 #: ../tools/virt-edit.pl:378
29510 msgid "NTFS junction points that cross filesystems are not followed."
29514 #: ../tools/virt-edit.pl:435
29515 msgid "USING GUESTFISH"
29519 #: ../tools/virt-edit.pl:437
29521 "L<guestfish(1)> is a more powerful, lower level tool which you can use when "
29522 "C<virt-edit> doesn't work."
29526 #: ../tools/virt-edit.pl:440
29527 msgid "Using C<virt-edit> is approximately equivalent to doing:"
29531 #: ../tools/virt-edit.pl:442
29534 " guestfish --rw -i -d domname edit /file\n"
29539 #: ../tools/virt-edit.pl:444
29541 "where C<domname> is the name of the libvirt guest, and C</file> is the full "
29542 "path to the file."
29546 #: ../tools/virt-edit.pl:447
29548 "The command above uses libguestfs's guest inspection feature and so does not "
29549 "work on guests that libguestfs cannot inspect, or on things like arbitrary "
29550 "disk images that don't contain guests. To edit a file on a disk image "
29555 #: ../tools/virt-edit.pl:452
29558 " guestfish --rw -a disk.img -m /dev/sda1 edit /file\n"
29563 #: ../tools/virt-edit.pl:454
29565 "where C<disk.img> is the disk image, C</dev/sda1> is the filesystem within "
29566 "the disk image to edit, and C</file> is the full path to the file."
29570 #: ../tools/virt-edit.pl:458
29572 "C<virt-edit> cannot create new files. Use the guestfish commands C<touch>, "
29573 "C<write> or C<upload> instead:"
29577 #: ../tools/virt-edit.pl:461
29580 " guestfish --rw -i -d domname touch /newfile\n"
29585 #: ../tools/virt-edit.pl:463
29588 " guestfish --rw -i -d domname write /newfile \"new content\"\n"
29593 #: ../tools/virt-edit.pl:465
29596 " guestfish --rw -i -d domname upload localfile /newfile\n"
29601 #: ../tools/virt-edit.pl:467
29603 "C<virt-edit> cannot edit multiple files, but guestfish can do it like this:"
29607 #: ../tools/virt-edit.pl:470
29610 " guestfish --rw -i -d domname edit /file1 : edit /file2\n"
29615 #: ../tools/virt-edit.pl:480
29620 #: ../tools/virt-edit.pl:482
29622 "If set, this string is used as the editor. It may contain arguments, eg. C<"
29627 #: ../tools/virt-edit.pl:485
29628 msgid "If not set, C<vi> is used."
29632 #: ../tools/virt-edit.pl:489 ../tools/virt-win-reg.pl:559
29633 #: ../tools/virt-list-filesystems.pl:182 ../tools/virt-tar.pl:279
29634 #: ../tools/virt-make-fs.pl:532 ../tools/virt-list-partitions.pl:250
29635 msgid "SHELL QUOTING"
29639 #: ../tools/virt-edit.pl:491 ../tools/virt-win-reg.pl:567
29640 #: ../tools/virt-list-filesystems.pl:184 ../tools/virt-tar.pl:281
29641 #: ../tools/virt-make-fs.pl:534 ../tools/virt-list-partitions.pl:252
29643 "Libvirt guest names can contain arbitrary characters, some of which have "
29644 "meaning to the shell such as C<#> and space. You may need to quote or "
29645 "escape these characters on the command line. See the shell manual page L<sh"
29646 "(1)> for details."
29650 #: ../tools/virt-edit.pl:498
29652 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, L<virt-"
29653 "tar-in(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, "
29654 "L<http://libguestfs.org/>, L<perl(1)>, L<perlre(1)>."
29658 #: ../tools/virt-edit.pl:510 ../tools/virt-win-reg.pl:598
29659 #: ../tools/virt-list-filesystems.pl:202 ../tools/virt-tar.pl:301
29660 #: ../tools/virt-make-fs.pl:564 ../tools/virt-list-partitions.pl:269
29665 #: ../tools/virt-edit.pl:512 ../tools/virt-win-reg.pl:600
29666 #: ../tools/virt-list-filesystems.pl:204 ../tools/virt-tar.pl:303
29667 #: ../tools/virt-make-fs.pl:566 ../tools/virt-list-partitions.pl:271
29668 msgid "Richard W.M. Jones L<http://people.redhat.com/~rjones/>"
29672 #: ../tools/virt-edit.pl:516
29673 msgid "Copyright (C) 2009-2011 Red Hat Inc."
29677 #: ../tools/virt-win-reg.pl:37
29679 "virt-win-reg - Export and merge Windows Registry entries from a Windows guest"
29683 #: ../tools/virt-win-reg.pl:41
29686 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey'\n"
29691 #: ../tools/virt-win-reg.pl:43
29694 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' name\n"
29699 #: ../tools/virt-win-reg.pl:45
29702 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' @\n"
29707 #: ../tools/virt-win-reg.pl:47
29710 " virt-win-reg --merge domname [input.reg ...]\n"
29715 #: ../tools/virt-win-reg.pl:49
29718 " virt-win-reg [--options] disk.img ... # instead of domname\n"
29723 #: ../tools/virt-win-reg.pl:53
29725 "You must I<not> use C<virt-win-reg> with the I<--merge> option on live "
29726 "virtual machines. If you do this, you I<will> get irreversible disk "
29727 "corruption in the VM. C<virt-win-reg> tries to stop you from doing this, "
29728 "but doesn't catch all cases."
29732 #: ../tools/virt-win-reg.pl:58
29734 "Modifying the Windows Registry is an inherently risky operation. The format "
29735 "is deliberately obscure and undocumented, and Registry changes can leave the "
29736 "system unbootable. Therefore when using the I<--merge> option, make sure "
29737 "you have a reliable backup first."
29741 #: ../tools/virt-win-reg.pl:65
29743 "This program can export and merge Windows Registry entries from a Windows "
29748 #: ../tools/virt-win-reg.pl:68
29750 "The first parameter is the libvirt guest name or the raw disk image of a "
29755 #: ../tools/virt-win-reg.pl:71
29757 "If I<--merge> is I<not> specified, then the chosen registry key is displayed/"
29758 "exported (recursively). For example:"
29762 #: ../tools/virt-win-reg.pl:74
29765 " $ virt-win-reg Windows7 'HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft'\n"
29770 #: ../tools/virt-win-reg.pl:76
29772 "You can also display single values from within registry keys, for example:"
29776 #: ../tools/virt-win-reg.pl:79
29779 " $ cvkey='HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion'\n"
29780 " $ virt-win-reg Windows7 $cvkey ProductName\n"
29781 " Windows 7 Enterprise\n"
29786 #: ../tools/virt-win-reg.pl:83
29788 "With I<--merge>, you can merge a textual regedit file into the Windows "
29793 #: ../tools/virt-win-reg.pl:86
29796 " $ virt-win-reg --merge Windows7 changes.reg\n"
29801 #: ../tools/virt-win-reg.pl:88 ../tools/virt-tar.pl:45
29806 #: ../tools/virt-win-reg.pl:90
29808 "This program is only meant for simple access to the registry. If you want "
29809 "to do complicated things with the registry, we suggest you download the "
29810 "Registry hive files from the guest using L<libguestfs(3)> or L<guestfish(1)> "
29811 "and access them locally, eg. using L<hivex(3)>, L<hivexsh(1)> or "
29812 "L<hivexregedit(1)>."
29816 #: ../tools/virt-win-reg.pl:120 ../tools/virt-make-fs.pl:177
29821 #: ../tools/virt-win-reg.pl:122
29822 msgid "Enable debugging messages."
29826 #: ../tools/virt-win-reg.pl:157
29831 #: ../tools/virt-win-reg.pl:159
29833 "In merge mode, this merges a textual regedit file into the Windows Registry "
29834 "of the virtual machine. If this flag is I<not> given then virt-win-reg "
29835 "displays or exports Registry entries instead."
29839 #: ../tools/virt-win-reg.pl:163
29841 "Note that I<--merge> is I<unsafe> to use on live virtual machines, and will "
29842 "result in disk corruption. However exporting (without this flag) is always "
29847 #: ../tools/virt-win-reg.pl:171
29848 msgid "B<--encoding> UTF-16LE|ASCII"
29852 #: ../tools/virt-win-reg.pl:173
29854 "When merging (only), you may need to specify the encoding for strings to be "
29855 "used in the hive file. This is explained in detail in L<Win::Hivex::Regedit"
29856 "(3)/ENCODING STRINGS>."
29860 #: ../tools/virt-win-reg.pl:177
29862 "The default is to use UTF-16LE, which should work with recent versions of "
29867 #: ../tools/virt-win-reg.pl:402
29868 msgid "SUPPORTED SYSTEMS"
29872 #: ../tools/virt-win-reg.pl:404
29874 "The program currently supports Windows NT-derived guests starting with "
29875 "Windows XP through to at least Windows 7."
29879 #: ../tools/virt-win-reg.pl:407
29881 "Registry support is done for C<HKEY_LOCAL_MACHINE\\SAM>, C<HKEY_LOCAL_MACHINE"
29882 "\\SECURITY>, C<HKEY_LOCAL_MACHINE\\SOFTWARE>, C<HKEY_LOCAL_MACHINE\\SYSTEM> "
29883 "and C<HKEY_USERS\\.DEFAULT>."
29887 #: ../tools/virt-win-reg.pl:411
29889 "You can use C<HKLM> as a shorthand for C<HKEY_LOCAL_MACHINE>, and C<HKU> for "
29894 #: ../tools/virt-win-reg.pl:414
29896 "C<HKEY_USERS\\$SID> and C<HKEY_CURRENT_USER> are B<not> supported at this "
29901 #: ../tools/virt-win-reg.pl:417
29906 #: ../tools/virt-win-reg.pl:419
29908 "C<virt-win-reg> expects that regedit files have already been reencoded in "
29909 "the local encoding. Usually on Linux hosts, this means UTF-8 with Unix-"
29910 "style line endings. Since Windows regedit files are often in UTF-16LE with "
29911 "Windows-style line endings, you may need to reencode the whole file before "
29912 "or after processing."
29916 #: ../tools/virt-win-reg.pl:425
29918 "To reencode a file from Windows format to Linux (before processing it with "
29919 "the I<--merge> option), you would do something like this:"
29923 #: ../tools/virt-win-reg.pl:428
29926 " iconv -f utf-16le -t utf-8 < win.reg | dos2unix > linux.reg\n"
29931 #: ../tools/virt-win-reg.pl:430
29933 "To go in the opposite direction, after exporting and before sending the file "
29934 "to a Windows user, do something like this:"
29938 #: ../tools/virt-win-reg.pl:433
29941 " unix2dos linux.reg | iconv -f utf-8 -t utf-16le > win.reg\n"
29946 #: ../tools/virt-win-reg.pl:435
29947 msgid "For more information about encoding, see L<Win::Hivex::Regedit(3)>."
29951 #: ../tools/virt-win-reg.pl:437
29953 "If you are unsure about the current encoding, use the L<file(1)> command. "
29954 "Recent versions of Windows regedit.exe produce a UTF-16LE file with Windows-"
29955 "style (CRLF) line endings, like this:"
29959 #: ../tools/virt-win-reg.pl:441
29962 " $ file software.reg\n"
29963 " software.reg: Little-endian UTF-16 Unicode text, with very long lines,\n"
29964 " with CRLF line terminators\n"
29969 #: ../tools/virt-win-reg.pl:445
29970 msgid "This file would need conversion before you could I<--merge> it."
29974 #: ../tools/virt-win-reg.pl:447
29975 msgid "CurrentControlSet etc."
29979 #: ../tools/virt-win-reg.pl:449
29981 "Registry keys like C<CurrentControlSet> don't really exist in the Windows "
29982 "Registry at the level of the hive file, and therefore you cannot modify "
29987 #: ../tools/virt-win-reg.pl:453
29989 "C<CurrentControlSet> is usually an alias for C<ControlSet001>. In some "
29990 "circumstances it might refer to another control set. The way to find out is "
29991 "to look at the C<HKLM\\SYSTEM\\Select> key:"
29995 #: ../tools/virt-win-reg.pl:457
29998 " # virt-win-reg WindowsGuest 'HKLM\\SYSTEM\\Select'\n"
29999 " [HKEY_LOCAL_MACHINE\\SYSTEM\\Select]\n"
30000 " \"Current\"=dword:00000001\n"
30001 " \"Default\"=dword:00000001\n"
30002 " \"Failed\"=dword:00000000\n"
30003 " \"LastKnownGood\"=dword:00000002\n"
30008 #: ../tools/virt-win-reg.pl:464
30009 msgid "\"Current\" is the one which Windows will choose when it boots."
30013 #: ../tools/virt-win-reg.pl:466
30015 "Similarly, other C<Current...> keys in the path may need to be replaced."
30019 #: ../tools/virt-win-reg.pl:469
30020 msgid "WINDOWS TIPS"
30024 #: ../tools/virt-win-reg.pl:471
30026 "Note that some of these tips modify the guest disk image. The guest I<must> "
30027 "be shut off, else you will get disk corruption."
30031 #: ../tools/virt-win-reg.pl:474
30032 msgid "RUNNING A BATCH SCRIPT WHEN A USER LOGS IN"
30036 #: ../tools/virt-win-reg.pl:476
30038 "Prepare a DOS batch script, VBScript or executable. Upload this using "
30039 "L<guestfish(1)>. For this example the script is called C<test.bat> and it "
30040 "is uploaded into C<C:\\>:"
30044 #: ../tools/virt-win-reg.pl:480
30047 " guestfish -i -d WindowsGuest upload test.bat /test.bat\n"
30052 #: ../tools/virt-win-reg.pl:482
30053 msgid "Prepare a regedit file containing the registry change:"
30057 #: ../tools/virt-win-reg.pl:484
30060 " cat > test.reg <<'EOF'\n"
30061 " [HKLM\\Software\\Microsoft\\Windows\\CurrentVersion\\RunOnce]\n"
30062 " \"Test\"=\"c:\\\\test.bat\"\n"
30068 #: ../tools/virt-win-reg.pl:489
30070 "In this example we use the key C<RunOnce> which means that the script will "
30071 "run precisely once when the first user logs in. If you want it to run every "
30072 "time a user logs in, replace C<RunOnce> with C<Run>."
30076 #: ../tools/virt-win-reg.pl:493
30077 msgid "Now update the registry:"
30081 #: ../tools/virt-win-reg.pl:495
30084 " virt-win-reg --merge WindowsGuest test.reg\n"
30089 #: ../tools/virt-win-reg.pl:497
30090 msgid "INSTALLING A SERVICE"
30094 #: ../tools/virt-win-reg.pl:499
30096 "This section assumes you are familiar with Windows services, and you either "
30097 "have a program which handles the Windows Service Control Protocol directly "
30098 "or you want to run any program using a service wrapper like SrvAny or the "
30103 #: ../tools/virt-win-reg.pl:504
30105 "First upload the program and optionally the service wrapper. In this case "
30106 "the test program is called C<test.exe> and we are using the RHSrvAny wrapper:"
30110 #: ../tools/virt-win-reg.pl:508
30113 " guestfish -i -d WindowsGuest <<EOF\n"
30114 " upload rhsrvany.exe /rhsrvany.exe\n"
30115 " upload test.exe /test.exe\n"
30121 #: ../tools/virt-win-reg.pl:513
30123 "Prepare a regedit file containing the registry changes. In this example, "
30124 "the first registry change is needed for the service itself or the service "
30125 "wrapper (if used). The second registry change is only needed because I am "
30126 "using the RHSrvAny service wrapper."
30130 #: ../tools/virt-win-reg.pl:518
30133 " cat > service.reg <<'EOF'\n"
30134 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny]\n"
30135 " \"Type\"=dword:00000010\n"
30136 " \"Start\"=dword:00000002\n"
30137 " \"ErrorControl\"=dword:00000001\n"
30138 " \"ImagePath\"=\"c:\\\\rhsrvany.exe\"\n"
30139 " \"DisplayName\"=\"RHSrvAny\"\n"
30140 " \"ObjectName\"=\"NetworkService\"\n"
30145 #: ../tools/virt-win-reg.pl:527
30148 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny\\Parameters]\n"
30149 " \"CommandLine\"=\"c:\\\\test.exe\"\n"
30150 " \"PWD\"=\"c:\\\\Temp\"\n"
30156 #: ../tools/virt-win-reg.pl:538
30158 "For use of C<ControlSet001> see the section above in this manual page. You "
30159 "may need to adjust this according to the control set that is in use by the "
30164 #: ../tools/virt-win-reg.pl:544
30166 "C<\"ObjectName\"> controls the privileges that the service will have. An "
30167 "alternative is C<\"ObjectName\"=\"LocalSystem\"> which would be the most "
30168 "privileged account."
30172 #: ../tools/virt-win-reg.pl:550
30174 "For the meaning of the magic numbers, see this Microsoft KB article: "
30175 "L<http://support.microsoft.com/kb/103000>."
30179 #: ../tools/virt-win-reg.pl:555
30180 msgid "Update the registry:"
30184 #: ../tools/virt-win-reg.pl:557
30187 " virt-win-reg --merge WindowsGuest service.reg\n"
30192 #: ../tools/virt-win-reg.pl:561
30194 "Be careful when passing parameters containing C<\\> (backslash) in the "
30195 "shell. Usually you will have to use 'single quotes' or double backslashes "
30196 "(but not both) to protect them from the shell."
30200 #: ../tools/virt-win-reg.pl:565
30201 msgid "Paths and value names are case-insensitive."
30205 #: ../tools/virt-win-reg.pl:574
30207 "L<hivex(3)>, L<hivexsh(1)>, L<hivexregedit(1)>, L<guestfs(3)>, L<guestfish(1)"
30208 ">, L<virt-cat(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Win::Hivex"
30209 "(3)>, L<Win::Hivex::Regedit(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
30213 #: ../tools/virt-win-reg.pl:589 ../tools/virt-make-fs.pl:555
30215 "When reporting bugs, please enable debugging and capture the I<complete> "
30220 #: ../tools/virt-win-reg.pl:592
30223 " export LIBGUESTFS_DEBUG=1\n"
30224 " virt-win-reg --debug [... rest ...] > /tmp/virt-win-reg.log 2>&1\n"
30229 #: ../tools/virt-win-reg.pl:595
30231 "Attach /tmp/virt-win-reg.log to a new bug report at L<https://bugzilla."
30236 #: ../tools/virt-win-reg.pl:604 ../tools/virt-make-fs.pl:570
30237 msgid "Copyright (C) 2010 Red Hat Inc."
30241 #: ../tools/virt-list-filesystems.pl:32
30243 "virt-list-filesystems - List filesystems in a virtual machine or disk image"
30247 #: ../tools/virt-list-filesystems.pl:36
30250 " virt-list-filesystems [--options] domname\n"
30255 #: ../tools/virt-list-filesystems.pl:38
30258 " virt-list-filesystems [--options] disk.img [disk.img ...]\n"
30263 #: ../tools/virt-list-filesystems.pl:42 ../tools/virt-list-partitions.pl:42
30265 "This tool is obsolete. Use L<virt-filesystems(1)> as a more flexible "
30270 #: ../tools/virt-list-filesystems.pl:45
30272 "C<virt-list-filesystems> is a command line tool to list the filesystems that "
30273 "are contained in a virtual machine or disk image."
30277 #: ../tools/virt-list-filesystems.pl:49
30279 "C<virt-list-filesystems> is just a simple wrapper around L<libguestfs(3)> "
30280 "functionality. For more complex cases you should look at the L<guestfish(1)"
30285 #: ../tools/virt-list-filesystems.pl:106 ../tools/virt-list-partitions.pl:115
30286 msgid "B<-l> | B<--long>"
30290 #: ../tools/virt-list-filesystems.pl:108
30292 "With this option, C<virt-list-filesystems> displays the type of each "
30293 "filesystem too (where \"type\" means C<ext3>, C<xfs> etc.)"
30297 #: ../tools/virt-list-filesystems.pl:115
30298 msgid "B<-a> | B<--all>"
30302 #: ../tools/virt-list-filesystems.pl:117
30304 "Normally we only show mountable filesystems. If this option is given then "
30305 "swap devices are shown too."
30309 #: ../tools/virt-list-filesystems.pl:191
30311 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, L<virt-"
30312 "filesystems(1)>, L<virt-list-partitions(1)>, L<Sys::Guestfs(3)>, L<Sys::"
30313 "Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
30317 #: ../tools/virt-list-filesystems.pl:208 ../tools/virt-tar.pl:307
30318 msgid "Copyright (C) 2009 Red Hat Inc."
30322 #: ../tools/virt-tar.pl:33
30323 msgid "virt-tar - Extract or upload files to a virtual machine"
30327 #: ../tools/virt-tar.pl:37
30330 " virt-tar [--options] -x domname directory tarball\n"
30335 #: ../tools/virt-tar.pl:39
30338 " virt-tar [--options] -u domname tarball directory\n"
30343 #: ../tools/virt-tar.pl:41
30346 " virt-tar [--options] disk.img [disk.img ...] -x directory tarball\n"
30351 #: ../tools/virt-tar.pl:43
30354 " virt-tar [--options] disk.img [disk.img ...] -u tarball directory\n"
30359 #: ../tools/virt-tar.pl:47
30361 "This tool is obsolete. Use L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-"
30362 "tar-in(1)>, L<virt-tar-out(1)> as replacements."
30366 #: ../tools/virt-tar.pl:52
30367 msgid "Download C</home> from the VM into a local tarball:"
30371 #: ../tools/virt-tar.pl:54
30374 " virt-tar -x domname /home home.tar\n"
30379 #: ../tools/virt-tar.pl:56
30382 " virt-tar -zx domname /home home.tar.gz\n"
30387 #: ../tools/virt-tar.pl:58
30388 msgid "Upload a local tarball and unpack it inside C</tmp> in the VM:"
30392 #: ../tools/virt-tar.pl:60
30395 " virt-tar -u domname uploadstuff.tar /tmp\n"
30400 #: ../tools/virt-tar.pl:62
30403 " virt-tar -zu domname uploadstuff.tar.gz /tmp\n"
30408 #: ../tools/virt-tar.pl:66
30410 "You must I<not> use C<virt-tar> with the I<-u> option (upload) on live "
30411 "virtual machines. If you do this, you risk disk corruption in the VM. "
30412 "C<virt-tar> tries to stop you from doing this, but doesn't catch all cases."
30416 #: ../tools/virt-tar.pl:71
30418 "You can use I<-x> (extract) on live virtual machines, but you might get "
30419 "inconsistent results or errors if there is filesystem activity inside the "
30420 "VM. If the live VM is synched and quiescent, then C<virt-tar> will usually "
30421 "work, but the only way to guarantee consistent results is if the virtual "
30422 "machine is shut down."
30426 #: ../tools/virt-tar.pl:79
30428 "C<virt-tar> is a general purpose archive tool for downloading and uploading "
30429 "parts of a guest filesystem. There are many possibilities: making backups, "
30430 "uploading data files, snooping on guest activity, fixing or customizing "
30435 #: ../tools/virt-tar.pl:84
30437 "If you want to just view a single file, use L<virt-cat(1)>. If you just "
30438 "want to edit a single file, use L<virt-edit(1)>. For more complex cases you "
30439 "should look at the L<guestfish(1)> tool."
30443 #: ../tools/virt-tar.pl:88
30445 "There are two modes of operation: I<-x> (eXtract) downloads a directory and "
30446 "its contents (recursively) from the virtual machine into a local tarball. "
30447 "I<-u> uploads from a local tarball, unpacking it into a directory inside the "
30448 "virtual machine. You cannot use these two options together."
30452 #: ../tools/virt-tar.pl:94
30454 "In addition, you may need to use the I<-z> (gZip) option to enable "
30455 "compression. When uploading, you have to specify I<-z> if the upload file "
30456 "is compressed because virt-tar won't detect this on its own."
30460 #: ../tools/virt-tar.pl:98
30462 "C<virt-tar> can only handle tar (optionally gzipped) format tarballs. For "
30463 "example it cannot do PKZip files or bzip2 compression. If you want that "
30464 "then you'll have to rebuild the tarballs yourself. (This is a limitation of "
30465 "the L<libguestfs(3)> API)."
30469 #: ../tools/virt-tar.pl:156
30470 msgid "B<-x> | B<--extract> | B<--download>"
30474 #: ../tools/virt-tar.pl:158
30475 msgid "B<-u> | B<--upload>"
30479 #: ../tools/virt-tar.pl:160
30481 "Use I<-x> to extract (download) a directory from a virtual machine to a "
30486 #: ../tools/virt-tar.pl:163
30488 "Use I<-u> to upload and unpack from a local tarball into a virtual machine. "
30489 "Please read the L</WARNING> section above before using this option."
30493 #: ../tools/virt-tar.pl:167
30494 msgid "You must specify exactly one of these options."
30498 #: ../tools/virt-tar.pl:173
30499 msgid "B<-z> | B<--gzip>"
30503 #: ../tools/virt-tar.pl:175
30504 msgid "Specify that the input or output tarball is gzip-compressed."
30508 #: ../tools/virt-tar.pl:288
30510 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, L<virt-copy-"
30511 "in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<Sys::"
30512 "Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs."
30517 #: ../tools/virt-make-fs.pl:37
30518 msgid "virt-make-fs - Make a filesystem from a tar archive or files"
30522 #: ../tools/virt-make-fs.pl:41
30525 " virt-make-fs [--options] input.tar output.img\n"
30530 #: ../tools/virt-make-fs.pl:43
30533 " virt-make-fs [--options] input.tar.gz output.img\n"
30538 #: ../tools/virt-make-fs.pl:45
30541 " virt-make-fs [--options] directory output.img\n"
30546 #: ../tools/virt-make-fs.pl:49
30548 "Virt-make-fs is a command line tool for creating a filesystem from a tar "
30549 "archive or some files in a directory. It is similar to tools like L<mkisofs"
30550 "(1)>, L<genisoimage(1)> and L<mksquashfs(1)>. Unlike those tools, it can "
30551 "create common filesystem types like ext2/3 or NTFS, which can be useful if "
30552 "you want to attach these filesystems to existing virtual machines (eg. to "
30553 "import large amounts of read-only data to a VM)."
30557 #: ../tools/virt-make-fs.pl:57
30558 msgid "Basic usage is:"
30562 #: ../tools/virt-make-fs.pl:59
30565 " virt-make-fs input output\n"
30570 #: ../tools/virt-make-fs.pl:61
30572 "where C<input> is either a directory containing files that you want to add, "
30573 "or a tar archive (either uncompressed tar or gzip-compressed tar); and "
30574 "C<output> is a disk image. The input type is detected automatically. The "
30575 "output disk image defaults to a raw ext2 image unless you specify extra "
30576 "flags (see L</OPTIONS> below)."
30580 #: ../tools/virt-make-fs.pl:67
30581 msgid "EXTRA SPACE"
30585 #: ../tools/virt-make-fs.pl:69
30587 "Unlike formats such as tar and squashfs, a filesystem does not \"just fit\" "
30588 "the files that it contains, but might have extra space. Depending on how "
30589 "you are going to use the output, you might think this extra space is wasted "
30590 "and want to minimize it, or you might want to leave space so that more files "
30591 "can be added later. Virt-make-fs defaults to minimizing the extra space, "
30592 "but you can use the I<--size> flag to leave space in the filesystem if you "
30597 #: ../tools/virt-make-fs.pl:77
30599 "An alternative way to leave extra space but not make the output image any "
30600 "bigger is to use an alternative disk image format (instead of the default "
30601 "\"raw\" format). Using I<--format=qcow2> will use the native QEmu/KVM qcow2 "
30602 "image format (check your hypervisor supports this before using it). This "
30603 "allows you to choose a large I<--size> but the extra space won't actually be "
30604 "allocated in the image until you try to store something in it."
30608 #: ../tools/virt-make-fs.pl:85
30610 "Don't forget that you can also use local commands including L<resize2fs(8)> "
30611 "and L<virt-resize(1)> to resize existing filesystems, or rerun virt-make-fs "
30612 "to build another image from scratch."
30616 #: ../tools/virt-make-fs.pl:89 ../tools/virt-make-fs.pl:123
30617 #: ../tools/virt-make-fs.pl:142
30622 #: ../tools/virt-make-fs.pl:91
30625 " virt-make-fs --format=qcow2 --size=+200M input output.img\n"
30630 #: ../tools/virt-make-fs.pl:93
30631 msgid "FILESYSTEM TYPE"
30635 #: ../tools/virt-make-fs.pl:95
30637 "The default filesystem type is C<ext2>. Just about any filesystem type that "
30638 "libguestfs supports can be used (but I<not> read-only formats like "
30639 "ISO9660). Here are some of the more common choices:"
30643 #: ../tools/virt-make-fs.pl:101
30648 #: ../tools/virt-make-fs.pl:103
30650 "Note that ext3 filesystems contain a journal, typically 1-32 MB in size. If "
30651 "you are not going to use the filesystem in a way that requires the journal, "
30652 "then this is just wasted overhead."
30656 #: ../tools/virt-make-fs.pl:107
30657 msgid "I<ntfs> or I<vfat>"
30661 #: ../tools/virt-make-fs.pl:109
30662 msgid "Useful if exporting data to a Windows guest."
30666 #: ../tools/virt-make-fs.pl:111
30668 "I<Note for vfat>: The tar archive or local directory must only contain files "
30669 "which are owned by root (ie. UID:GID = 0:0). The reason is that the tar "
30670 "program running within libguestfs is unable to change the ownership of non-"
30671 "root files, since vfat itself does not support this."
30675 #: ../tools/virt-make-fs.pl:116
30680 #: ../tools/virt-make-fs.pl:118
30682 "Lower overhead than C<ext2>, but certain limitations on filename length and "
30683 "total filesystem size."
30687 #: ../tools/virt-make-fs.pl:125
30690 " virt-make-fs --type=minix input minixfs.img\n"
30695 #: ../tools/virt-make-fs.pl:127
30696 msgid "TO PARTITION OR NOT TO PARTITION"
30700 #: ../tools/virt-make-fs.pl:129
30701 msgid "Optionally virt-make-fs can add a partition table to the output disk."
30705 #: ../tools/virt-make-fs.pl:131
30707 "Adding a partition can make the disk image more compatible with certain "
30708 "virtualized operating systems which don't expect to see a filesystem "
30709 "directly located on a block device (Linux doesn't care and will happily "
30710 "handle both types)."
30714 #: ../tools/virt-make-fs.pl:136
30716 "On the other hand, if you have a partition table then the output image is no "
30717 "longer a straight filesystem. For example you cannot run L<fsck(8)> "
30718 "directly on a partitioned disk image. (However libguestfs tools such as "
30719 "L<guestfish(1)> and L<virt-resize(1)> can still be used)."
30723 #: ../tools/virt-make-fs.pl:144
30724 msgid "Add an MBR partition:"
30728 #: ../tools/virt-make-fs.pl:146
30731 " virt-make-fs --partition -- input disk.img\n"
30736 #: ../tools/virt-make-fs.pl:148
30738 "If the output disk image could be terabyte-sized or larger, it's better to "
30739 "use an EFI/GPT-compatible partition table:"
30743 #: ../tools/virt-make-fs.pl:151
30746 " virt-make-fs --partition=gpt --size=+4T --format=qcow2 input disk.img\n"
30751 #: ../tools/virt-make-fs.pl:179
30752 msgid "Enable debugging information."
30756 #: ../tools/virt-make-fs.pl:185
30757 msgid "B<--size=E<lt>NE<gt>>"
30761 #: ../tools/virt-make-fs.pl:187
30762 msgid "B<--size=+E<lt>NE<gt>>"
30766 #: ../tools/virt-make-fs.pl:189
30767 msgid "B<-s E<lt>NE<gt>>"
30771 #: ../tools/virt-make-fs.pl:191
30772 msgid "B<-s +E<lt>NE<gt>>"
30776 #: ../tools/virt-make-fs.pl:193
30778 "Use the I<--size> (or I<-s>) option to choose the size of the output image."
30782 #: ../tools/virt-make-fs.pl:196
30784 "If this option is I<not> given, then the output image will be just large "
30785 "enough to contain all the files, with not much wasted space."
30789 #: ../tools/virt-make-fs.pl:199
30791 "To choose a fixed size output disk, specify an absolute number followed by b/"
30792 "K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
30793 "Petabytes or Exabytes. This must be large enough to contain all the input "
30794 "files, else you will get an error."
30798 #: ../tools/virt-make-fs.pl:204
30800 "To leave extra space, specify C<+> (plus sign) and a number followed by b/K/"
30801 "M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
30802 "Petabytes or Exabytes. For example: I<--size=+200M> means enough space for "
30803 "the input files, and (approximately) an extra 200 MB free space."
30807 #: ../tools/virt-make-fs.pl:210
30809 "Note that virt-make-fs estimates free space, and therefore will not produce "
30810 "filesystems containing precisely the free space requested. (It is much more "
30811 "expensive and time-consuming to produce a filesystem which has precisely the "
30812 "desired free space)."
30816 #: ../tools/virt-make-fs.pl:219
30817 msgid "B<--format=E<lt>fmtE<gt>>"
30821 #: ../tools/virt-make-fs.pl:221
30822 msgid "B<-F E<lt>fmtE<gt>>"
30826 #: ../tools/virt-make-fs.pl:223
30827 msgid "Choose the output disk image format."
30831 #: ../tools/virt-make-fs.pl:225
30832 msgid "The default is C<raw> (raw disk image)."
30836 #: ../tools/virt-make-fs.pl:227
30838 "For other choices, see the L<qemu-img(1)> manpage. The only other choice "
30839 "that would really make sense here is C<qcow2>."
30843 #: ../tools/virt-make-fs.pl:234
30844 msgid "B<--type=E<lt>fsE<gt>>"
30848 #: ../tools/virt-make-fs.pl:236
30849 msgid "B<-t E<lt>fsE<gt>>"
30853 #: ../tools/virt-make-fs.pl:238
30854 msgid "Choose the output filesystem type."
30858 #: ../tools/virt-make-fs.pl:240
30859 msgid "The default is C<ext2>."
30863 #: ../tools/virt-make-fs.pl:242
30865 "Any filesystem which is supported read-write by libguestfs can be used here."
30869 #: ../tools/virt-make-fs.pl:249
30870 msgid "B<--partition>"
30874 #: ../tools/virt-make-fs.pl:251
30875 msgid "B<--partition=E<lt>parttypeE<gt>>"
30879 #: ../tools/virt-make-fs.pl:253
30881 "If specified, this flag adds an MBR partition table to the output disk image."
30885 #: ../tools/virt-make-fs.pl:256
30887 "You can change the partition table type, eg. I<--partition=gpt> for large "
30892 #: ../tools/virt-make-fs.pl:259
30894 "Note that if you just use a lonesome I<--partition>, the Perl option parser "
30895 "might consider the next parameter to be the partition type. For example:"
30899 #: ../tools/virt-make-fs.pl:263
30902 " virt-make-fs --partition input.tar ...\n"
30907 #: ../tools/virt-make-fs.pl:265
30909 "would cause virt-make-fs to think you wanted to use a partition type of "
30910 "C<input.tar> which is completely wrong. To avoid this, use I<--> (a double "
30911 "dash) between options and the input file argument:"
30915 #: ../tools/virt-make-fs.pl:269
30918 " virt-make-fs --partition -- input.tar ...\n"
30923 #: ../tools/virt-make-fs.pl:541
30925 "L<guestfish(1)>, L<virt-resize(1)>, L<virt-tar-in(1)>, L<mkisofs(1)>, "
30926 "L<genisoimage(1)>, L<mksquashfs(1)>, L<mke2fs(8)>, L<resize2fs(8)>, L<guestfs"
30927 "(3)>, L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
30931 #: ../tools/virt-make-fs.pl:558
30934 " export LIBGUESTFS_DEBUG=1\n"
30935 " virt-make-fs --debug [...] > /tmp/virt-make-fs.log 2>&1\n"
30940 #: ../tools/virt-make-fs.pl:561
30942 "Attach /tmp/virt-make-fs.log to a new bug report at L<https://bugzilla."
30947 #: ../tools/virt-list-partitions.pl:32
30949 "virt-list-partitions - List partitions in a virtual machine or disk image"
30953 #: ../tools/virt-list-partitions.pl:36
30956 " virt-list-partitions [--options] domname\n"
30961 #: ../tools/virt-list-partitions.pl:38
30964 " virt-list-partitions [--options] disk.img [disk.img ...]\n"
30969 #: ../tools/virt-list-partitions.pl:45
30971 "C<virt-list-partitions> is a command line tool to list the partitions that "
30972 "are contained in a virtual machine or disk image. It is mainly useful as a "
30973 "first step to using L<virt-resize(1)>."
30977 #: ../tools/virt-list-partitions.pl:50
30979 "C<virt-list-partitions> is just a simple wrapper around L<libguestfs(3)> "
30980 "functionality. For more complex cases you should look at the L<guestfish(1)"
30985 #: ../tools/virt-list-partitions.pl:107
30986 msgid "B<-h> | B<--human-readable>"
30990 #: ../tools/virt-list-partitions.pl:109
30991 msgid "Show sizes in human-readable form (eg. \"1G\")."
30995 #: ../tools/virt-list-partitions.pl:117
30997 "With this option, C<virt-list-partitions> displays the type and size of each "
30998 "partition too (where \"type\" means C<ext3>, C<pv> etc.)"
31002 #: ../tools/virt-list-partitions.pl:124
31003 msgid "B<-t> | B<--total>"
31007 #: ../tools/virt-list-partitions.pl:126
31009 "Display the total size of each block device (as a separate row or rows)."
31013 #: ../tools/virt-list-partitions.pl:259
31015 "L<guestfs(3)>, L<guestfish(1)>, L<virt-filesystems(1)>, L<virt-list-"
31016 "filesystems(1)>, L<virt-resize(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib"
31017 "(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
31021 #: ../tools/virt-list-partitions.pl:275
31022 msgid "Copyright (C) 2009-2010 Red Hat Inc."