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-05-18 12:00+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:2962 ../src/guestfs.pod:2966 ../src/guestfs.pod:2970
868 #: ../src/guestfs.pod:2974 ../src/guestfs-actions.pod:15
869 #: ../src/guestfs-actions.pod:22 ../src/guestfs-actions.pod:577
870 #: ../src/guestfs-actions.pod:585 ../src/guestfs-actions.pod:592
871 #: ../src/guestfs-actions.pod:599 ../src/guestfs-actions.pod:1600
872 #: ../src/guestfs-actions.pod:1604 ../src/guestfs-actions.pod:1608
873 #: ../src/guestfs-actions.pod:1612 ../src/guestfs-actions.pod:1620
874 #: ../src/guestfs-actions.pod:1624 ../src/guestfs-actions.pod:1628
875 #: ../src/guestfs-actions.pod:1638 ../src/guestfs-actions.pod:1642
876 #: ../src/guestfs-actions.pod:1646 ../src/guestfs-actions.pod:1784
877 #: ../src/guestfs-actions.pod:1788 ../src/guestfs-actions.pod:1793
878 #: ../src/guestfs-actions.pod:1798 ../src/guestfs-actions.pod:1859
879 #: ../src/guestfs-actions.pod:1863 ../src/guestfs-actions.pod:1868
880 #: ../fish/guestfish.pod:443 ../fish/guestfish.pod:447
881 #: ../fish/guestfish.pod:451 ../fish/guestfish.pod:455
882 #: ../fish/guestfish-actions.pod:13 ../fish/guestfish-actions.pod:20
883 #: ../fish/guestfish-actions.pod:380 ../fish/guestfish-actions.pod:388
884 #: ../fish/guestfish-actions.pod:395 ../fish/guestfish-actions.pod:402
885 #: ../fish/guestfish-actions.pod:1072 ../fish/guestfish-actions.pod:1076
886 #: ../fish/guestfish-actions.pod:1080 ../fish/guestfish-actions.pod:1084
887 #: ../fish/guestfish-actions.pod:1092 ../fish/guestfish-actions.pod:1096
888 #: ../fish/guestfish-actions.pod:1100 ../fish/guestfish-actions.pod:1110
889 #: ../fish/guestfish-actions.pod:1114 ../fish/guestfish-actions.pod:1118
890 #: ../fish/guestfish-actions.pod:1208 ../fish/guestfish-actions.pod:1212
891 #: ../fish/guestfish-actions.pod:1217 ../fish/guestfish-actions.pod:1222
892 #: ../fish/guestfish-actions.pod:1264 ../fish/guestfish-actions.pod:1268
893 #: ../fish/guestfish-actions.pod:1273 ../tools/virt-edit.pl:351
894 #: ../tools/virt-edit.pl:356 ../tools/virt-edit.pl:361
895 #: ../tools/virt-edit.pl:372 ../tools/virt-edit.pl:376
896 #: ../tools/virt-win-reg.pl:536 ../tools/virt-win-reg.pl:542
897 #: ../tools/virt-win-reg.pl:548
902 #: ../src/guestfs.pod:390
904 "The kernel version that the command runs under will be different from what "
909 #: ../src/guestfs.pod:395
911 "If the command needs to communicate with daemons, then most likely they "
916 #: ../src/guestfs.pod:400
917 msgid "The command will be running in limited memory."
921 #: ../src/guestfs.pod:404
923 "The network may not be available unless you enable it (see L</"
924 "guestfs_set_network>)."
928 #: ../src/guestfs.pod:409
929 msgid "Only supports Linux guests (not Windows, BSD, etc)."
933 #: ../src/guestfs.pod:413
935 "Architecture limitations (eg. won't work for a PPC guest on an X86 host)."
939 #: ../src/guestfs.pod:418
941 "For SELinux guests, you may need to enable SELinux and load policy first. "
942 "See L</SELINUX> in this manpage."
946 #: ../src/guestfs.pod:423
948 "I<Security:> It is not safe to run commands from untrusted, possibly "
949 "malicious guests. These commands may attempt to exploit your program by "
950 "sending unexpected output. They could also try to exploit the Linux kernel "
951 "or qemu provided by the libguestfs appliance. They could use the network "
952 "provided by the libguestfs appliance to bypass ordinary network partitions "
953 "and firewalls. They could use the elevated privileges or different SELinux "
954 "context of your program to their advantage."
958 #: ../src/guestfs.pod:432
960 "A secure alternative is to use libguestfs to install a \"firstboot\" script "
961 "(a script which runs when the guest next boots normally), and to have this "
962 "script run the commands you want in the normal context of the running guest, "
963 "network security and so on. For information about other security issues, "
968 #: ../src/guestfs.pod:440
970 "The two main API calls to run commands are L</guestfs_command> and L</"
971 "guestfs_sh> (there are also variations)."
975 #: ../src/guestfs.pod:443
977 "The difference is that L</guestfs_sh> runs commands using the shell, so any "
978 "shell globs, redirections, etc will work."
982 #: ../src/guestfs.pod:446
983 msgid "CONFIGURATION FILES"
984 msgstr "ФАЙЛИ НАЛАШТУВАННЯ"
987 #: ../src/guestfs.pod:448
989 "To read and write configuration files in Linux guest filesystems, we "
990 "strongly recommend using Augeas. For example, Augeas understands how to "
991 "read and write, say, a Linux shadow password file or X.org configuration "
992 "file, and so avoids you having to write that code."
996 #: ../src/guestfs.pod:453
998 "The main Augeas calls are bound through the C<guestfs_aug_*> APIs. We don't "
999 "document Augeas itself here because there is excellent documentation on the "
1000 "L<http://augeas.net/> website."
1004 #: ../src/guestfs.pod:457
1006 "If you don't want to use Augeas (you fool!) then try calling L</"
1007 "guestfs_read_lines> to get the file as a list of lines which you can iterate "
1012 #: ../src/guestfs.pod:461
1017 #: ../src/guestfs.pod:463
1019 "We support SELinux guests. To ensure that labeling happens correctly in "
1020 "SELinux guests, you need to enable SELinux and load the guest's policy:"
1024 #: ../src/guestfs.pod:469 ../src/guestfs.pod: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 " int 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:1855 ../fish/guestfish-actions.pod:9
3310 #: ../fish/guestfish-actions.pod:1260 ../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:5814
5136 #: ../fish/guestfish-actions.pod:3908
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
5173 #: ../src/guestfs.pod:2662
5174 msgid "Outside contributions, experimental parts."
5178 #: ../src/guestfs.pod:2664
5183 #: ../src/guestfs.pod:2666
5185 "The daemon that runs inside the libguestfs appliance and carries out actions."
5189 #: ../src/guestfs.pod:2669
5194 #: ../src/guestfs.pod:2671
5195 msgid "L<virt-df(1)> command and documentation."
5199 #: ../src/guestfs.pod:2673
5201 msgstr "C<examples>"
5204 #: ../src/guestfs.pod:2675
5205 msgid "C API example code."
5206 msgstr "Код прикладів використання програмного інтерфейсу мовою C."
5209 #: ../src/guestfs.pod:2677
5214 #: ../src/guestfs.pod:2679
5216 "L<guestfish(1)>, the command-line shell, and various shell scripts built on "
5217 "top such as L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, "
5218 "L<virt-tar-out(1)>."
5222 #: ../src/guestfs.pod:2683
5227 #: ../src/guestfs.pod:2685
5229 "L<guestmount(1)>, FUSE (userspace filesystem) built on top of libguestfs."
5233 #: ../src/guestfs.pod:2687
5234 msgid "C<generator>"
5235 msgstr "C<generator>"
5238 #: ../src/guestfs.pod:2689
5240 "The crucially important generator, used to automatically generate large "
5241 "amounts of boilerplate C code for things like RPC and bindings."
5245 #: ../src/guestfs.pod:2692
5250 #: ../src/guestfs.pod:2694
5251 msgid "Files used by the test suite."
5255 #: ../src/guestfs.pod:2696
5256 msgid "Some \"phony\" guest images which we test against."
5260 #: ../src/guestfs.pod:2698
5261 msgid "C<inspector>"
5262 msgstr "C<inspector>"
5265 #: ../src/guestfs.pod:2700
5266 msgid "L<virt-inspector(1)>, the virtual machine image inspector."
5270 #: ../src/guestfs.pod:2702
5275 #: ../src/guestfs.pod:2704
5276 msgid "Logo used on the website. The fish is called Arthur by the way."
5280 #: ../src/guestfs.pod:2706
5285 #: ../src/guestfs.pod:2708
5286 msgid "M4 macros used by autoconf."
5290 #: ../src/guestfs.pod:2710
5295 #: ../src/guestfs.pod:2712
5296 msgid "Translations of simple gettext strings."
5297 msgstr "Переклади простих рядків gettext."
5300 #: ../src/guestfs.pod:2714
5305 #: ../src/guestfs.pod:2716
5307 "The build infrastructure and PO files for translations of manpages and POD "
5308 "files. Eventually this will be combined with the C<po> directory, but that "
5309 "is rather complicated."
5313 #: ../src/guestfs.pod:2720
5314 msgid "C<regressions>"
5315 msgstr "C<regressions>"
5318 #: ../src/guestfs.pod:2722
5319 msgid "Regression tests."
5320 msgstr "Тести на регресії."
5323 #: ../src/guestfs.pod:2724
5328 #: ../src/guestfs.pod:2726
5329 msgid "L<virt-rescue(1)> command and documentation."
5333 #: ../src/guestfs.pod:2728
5338 #: ../src/guestfs.pod:2730
5339 msgid "Source code to the C library."
5343 #: ../src/guestfs.pod:2732
5348 #: ../src/guestfs.pod:2734
5349 msgid "Command line tools written in Perl (L<virt-resize(1)> and many others)."
5353 #: ../src/guestfs.pod:2736
5354 msgid "C<test-tool>"
5355 msgstr "C<test-tool>"
5358 #: ../src/guestfs.pod:2738
5360 "Test tool for end users to test if their qemu/kernel combination will work "
5365 #: ../src/guestfs.pod:2741
5370 #: ../src/guestfs.pod:2743
5375 #: ../src/guestfs.pod:2745
5380 #: ../src/guestfs.pod:2747
5385 #: ../src/guestfs.pod:2749
5390 #: ../src/guestfs.pod:2751
5395 #: ../src/guestfs.pod:2753
5400 #: ../src/guestfs.pod:2755
5405 #: ../src/guestfs.pod:2757
5406 msgid "Language bindings."
5407 msgstr "Прив’язки до мов програмування."
5410 #: ../src/guestfs.pod:2761
5415 #: ../src/guestfs.pod:2763
5416 msgid "PROTOCOL LIMITS"
5420 #: ../src/guestfs.pod:2765
5422 "Internally libguestfs uses a message-based protocol to pass API calls and "
5423 "their responses to and from a small \"appliance\" (see L</INTERNALS> for "
5424 "plenty more detail about this). The maximum message size used by the "
5425 "protocol is slightly less than 4 MB. For some API calls you may need to be "
5426 "aware of this limit. The API calls which may be affected are individually "
5427 "documented, with a link back to this section of the documentation."
5431 #: ../src/guestfs.pod:2773
5433 "A simple call such as L</guestfs_cat> returns its result (the file data) in "
5434 "a simple string. Because this string is at some point internally encoded as "
5435 "a message, the maximum size that it can return is slightly under 4 MB. If "
5436 "the requested file is larger than this then you will get an error."
5440 #: ../src/guestfs.pod:2779
5442 "In order to transfer large files into and out of the guest filesystem, you "
5443 "need to use particular calls that support this. The sections L</UPLOADING> "
5444 "and L</DOWNLOADING> document how to do this."
5448 #: ../src/guestfs.pod:2783
5450 "You might also consider mounting the disk image using our FUSE filesystem "
5451 "support (L<guestmount(1)>)."
5455 #: ../src/guestfs.pod:2786
5456 msgid "MAXIMUM NUMBER OF DISKS"
5460 #: ../src/guestfs.pod:2788
5461 msgid "When using virtio disks (the default) the current limit is B<25> disks."
5465 #: ../src/guestfs.pod:2791
5467 "Virtio itself consumes 1 virtual PCI slot per disk, and PCI is limited to 31 "
5468 "slots. However febootstrap only understands disks with names C</dev/vda> "
5469 "through C</dev/vdz> (26 letters) and it reserves one disk for its own "
5474 #: ../src/guestfs.pod:2796
5476 "We are working to substantially raise this limit in future versions but it "
5477 "requires complex changes to qemu."
5481 #: ../src/guestfs.pod:2799
5483 "In future versions of libguestfs it should also be possible to \"hot plug\" "
5484 "disks (add and remove disks after calling L</guestfs_launch>). This also "
5485 "requires changes to qemu."
5489 #: ../src/guestfs.pod:2803
5490 msgid "MAXIMUM NUMBER OF PARTITIONS PER DISK"
5494 #: ../src/guestfs.pod:2805
5495 msgid "Virtio limits the maximum number of partitions per disk to B<15>."
5499 #: ../src/guestfs.pod:2807
5501 "This is because it reserves 4 bits for the minor device number (thus C</dev/"
5502 "vda>, and C</dev/vda1> through C</dev/vda15>)."
5506 #: ../src/guestfs.pod:2810
5508 "If you attach a disk with more than 15 partitions, the extra partitions are "
5509 "ignored by libguestfs."
5513 #: ../src/guestfs.pod:2813
5514 msgid "MAXIMUM SIZE OF A DISK"
5518 #: ../src/guestfs.pod:2815
5519 msgid "Probably the limit is between 2**63-1 and 2**64-1 bytes."
5523 #: ../src/guestfs.pod:2817
5525 "We have tested block devices up to 1 exabyte (2**60 or "
5526 "1,152,921,504,606,846,976 bytes) using sparse files backed by an XFS host "
5531 #: ../src/guestfs.pod:2821
5533 "Although libguestfs probably does not impose any limit, the underlying host "
5534 "storage will. If you store disk images on a host ext4 filesystem, then the "
5535 "maximum size will be limited by the maximum ext4 file size (currently 16 "
5536 "TB). If you store disk images as host logical volumes then you are limited "
5537 "by the maximum size of an LV."
5541 #: ../src/guestfs.pod:2827
5543 "For the hugest disk image files, we recommend using XFS on the host for "
5548 #: ../src/guestfs.pod:2830
5549 msgid "MAXIMUM SIZE OF A PARTITION"
5553 #: ../src/guestfs.pod:2832
5555 "The MBR (ie. classic MS-DOS) partitioning scheme uses 32 bit sector "
5556 "numbers. Assuming a 512 byte sector size, this means that MBR cannot "
5557 "address a partition located beyond 2 TB on the disk."
5561 #: ../src/guestfs.pod:2836
5563 "It is recommended that you use GPT partitions on disks which are larger than "
5564 "this size. GPT uses 64 bit sector numbers and so can address partitions "
5565 "which are theoretically larger than the largest disk we could support."
5569 #: ../src/guestfs.pod:2841
5570 msgid "MAXIMUM SIZE OF A FILESYSTEM, FILES, DIRECTORIES"
5574 #: ../src/guestfs.pod:2843
5576 "This depends on the filesystem type. libguestfs itself does not impose any "
5577 "known limit. Consult Wikipedia or the filesystem documentation to find out "
5578 "what these limits are."
5582 #: ../src/guestfs.pod:2847
5583 msgid "MAXIMUM UPLOAD AND DOWNLOAD"
5587 #: ../src/guestfs.pod:2849
5589 "The API functions L</guestfs_upload>, L</guestfs_download>, L</"
5590 "guestfs_tar_in>, L</guestfs_tar_out> and the like allow unlimited sized "
5591 "uploads and downloads."
5595 #: ../src/guestfs.pod:2853
5597 #| msgid "INSPECTION"
5598 msgid "INSPECTION LIMITS"
5602 #: ../src/guestfs.pod:2855
5604 "The inspection code has several arbitrary limits on things like the size of "
5605 "Windows Registry hive it will read, and the length of product name. These "
5606 "are intended to stop a malicious guest from consuming arbitrary amounts of "
5607 "memory and disk space on the host, and should not be reached in practice. "
5608 "See the source code for more information."
5612 #: ../src/guestfs.pod:2861 ../fish/guestfish.pod:1015
5613 #: ../test-tool/libguestfs-test-tool.pod:82 ../tools/virt-edit.pl:476
5614 msgid "ENVIRONMENT VARIABLES"
5615 msgstr "ЗМІННІ СЕРЕДОВИЩА"
5618 #: ../src/guestfs.pod:2865 ../fish/guestfish.pod:1041
5619 msgid "LIBGUESTFS_APPEND"
5623 #: ../src/guestfs.pod:2867 ../fish/guestfish.pod:1043
5624 msgid "Pass additional options to the guest kernel."
5628 #: ../src/guestfs.pod:2869 ../fish/guestfish.pod:1045
5629 msgid "LIBGUESTFS_DEBUG"
5633 #: ../src/guestfs.pod:2871
5635 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
5636 "effect as calling C<guestfs_set_verbose (g, 1)>."
5640 #: ../src/guestfs.pod:2874 ../fish/guestfish.pod:1050
5641 msgid "LIBGUESTFS_MEMSIZE"
5645 #: ../src/guestfs.pod:2876 ../fish/guestfish.pod:1052
5647 "Set the memory allocated to the qemu process, in megabytes. For example:"
5651 #: ../src/guestfs.pod:2879 ../fish/guestfish.pod:1055
5654 " LIBGUESTFS_MEMSIZE=700\n"
5659 #: ../src/guestfs.pod:2881 ../fish/guestfish.pod:1057
5660 msgid "LIBGUESTFS_PATH"
5664 #: ../src/guestfs.pod:2883
5666 "Set the path that libguestfs uses to search for a supermin appliance. See "
5667 "the discussion of paths in section L</PATH> above."
5671 #: ../src/guestfs.pod:2886 ../fish/guestfish.pod:1062
5672 msgid "LIBGUESTFS_QEMU"
5676 #: ../src/guestfs.pod:2888 ../fish/guestfish.pod:1064
5678 "Set the default qemu binary that libguestfs uses. If not set, then the qemu "
5679 "which was found at compile time by the configure script is used."
5683 #: ../src/guestfs.pod:2892
5684 msgid "See also L</QEMU WRAPPERS> above."
5688 #: ../src/guestfs.pod:2894 ../fish/guestfish.pod:1068
5689 msgid "LIBGUESTFS_TRACE"
5693 #: ../src/guestfs.pod:2896
5695 "Set C<LIBGUESTFS_TRACE=1> to enable command traces. This has the same "
5696 "effect as calling C<guestfs_set_trace (g, 1)>."
5700 #: ../src/guestfs.pod:2899 ../fish/guestfish.pod:1077
5705 #: ../src/guestfs.pod:2901 ../fish/guestfish.pod:1079
5707 "Location of temporary directory, defaults to C</tmp> except for the cached "
5708 "supermin appliance which defaults to C</var/tmp>."
5712 #: ../src/guestfs.pod:2904 ../fish/guestfish.pod:1082
5714 "If libguestfs was compiled to use the supermin appliance then the real "
5715 "appliance is cached in this directory, shared between all handles belonging "
5716 "to the same EUID. You can use C<$TMPDIR> to configure another directory to "
5717 "use in case C</var/tmp> is not large enough."
5721 #: ../src/guestfs.pod:2912 ../fish/guestfish.pod:1149
5722 #: ../test-tool/libguestfs-test-tool.pod:87 ../fuse/guestmount.pod:267
5723 #: ../tools/virt-edit.pl:496 ../tools/virt-win-reg.pl:572
5724 #: ../tools/virt-list-filesystems.pl:189 ../tools/virt-tar.pl:286
5725 #: ../tools/virt-make-fs.pl:539 ../tools/virt-list-partitions.pl:257
5727 msgstr "ТАКОЖ ПЕРЕГЛЯНЬТЕ"
5730 #: ../src/guestfs.pod:2914
5732 "L<guestfs-examples(3)>, L<guestfs-ocaml(3)>, L<guestfs-python(3)>, L<guestfs-"
5733 "ruby(3)>, L<guestfish(1)>, L<guestmount(1)>, L<virt-cat(1)>, L<virt-copy-in"
5734 "(1)>, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, L<virt-filesystems"
5735 "(1)>, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, L<virt-list-"
5736 "partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, L<virt-rescue(1)>, L<virt-"
5737 "tar(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<virt-win-reg(1)>, L<qemu(1)"
5738 ">, L<febootstrap(1)>, L<hivex(3)>, L<http://libguestfs.org/>."
5742 #: ../src/guestfs.pod:2941
5744 "Tools with a similar purpose: L<fdisk(8)>, L<parted(8)>, L<kpartx(8)>, L<lvm"
5745 "(8)>, L<disktype(1)>."
5749 #: ../src/guestfs.pod:2948 ../tools/virt-win-reg.pl:587
5750 #: ../tools/virt-make-fs.pl:553
5755 #: ../src/guestfs.pod:2950
5756 msgid "To get a list of bugs against libguestfs use this link:"
5758 "Щоб переглянути список відомих вад у libguestfs, скористайтеся таким "
5762 #: ../src/guestfs.pod:2952
5764 "L<https://bugzilla.redhat.com/buglist.cgi?"
5765 "component=libguestfs&product=Virtualization+Tools>"
5767 "L<https://bugzilla.redhat.com/buglist.cgi?"
5768 "component=libguestfs&product=Virtualization+Tools>"
5771 #: ../src/guestfs.pod:2954
5772 msgid "To report a new bug against libguestfs use this link:"
5773 msgstr "Для звітування щодо вад у libguestfs скористайтеся цим посиланням:"
5776 #: ../src/guestfs.pod:2956
5778 "L<https://bugzilla.redhat.com/enter_bug.cgi?"
5779 "component=libguestfs&product=Virtualization+Tools>"
5781 "L<https://bugzilla.redhat.com/enter_bug.cgi?"
5782 "component=libguestfs&product=Virtualization+Tools>"
5785 #: ../src/guestfs.pod:2958
5786 msgid "When reporting a bug, please check:"
5790 #: ../src/guestfs.pod:2964
5791 msgid "That the bug hasn't been reported already."
5795 #: ../src/guestfs.pod:2968
5796 msgid "That you are testing a recent version."
5800 #: ../src/guestfs.pod:2972
5801 msgid "Describe the bug accurately, and give a way to reproduce it."
5805 #: ../src/guestfs.pod:2976
5807 "Run libguestfs-test-tool and paste the B<complete, unedited> output into the "
5812 #: ../src/guestfs.pod:2981 ../fish/guestfish.pod:1172
5813 #: ../test-tool/libguestfs-test-tool.pod:93 ../fuse/guestmount.pod:278
5818 #: ../src/guestfs.pod:2983 ../fish/guestfish.pod:1174
5819 #: ../test-tool/libguestfs-test-tool.pod:95 ../fuse/guestmount.pod:280
5820 msgid "Richard W.M. Jones (C<rjones at redhat dot com>)"
5824 #: ../src/guestfs.pod:2985 ../fish/guestfish.pod:1176
5825 #: ../test-tool/libguestfs-test-tool.pod:97 ../fuse/guestmount.pod:282
5826 #: ../tools/virt-edit.pl:514 ../tools/virt-win-reg.pl:602
5827 #: ../tools/virt-list-filesystems.pl:206 ../tools/virt-tar.pl:305
5828 #: ../tools/virt-make-fs.pl:568 ../tools/virt-list-partitions.pl:273
5830 msgstr "АВТОРСЬКІ ПРАВА"
5833 #: ../src/guestfs.pod:2987 ../fish/guestfish.pod:1178
5834 #: ../test-tool/libguestfs-test-tool.pod:99
5835 msgid "Copyright (C) 2009-2011 Red Hat Inc. L<http://libguestfs.org/>"
5839 #: ../src/guestfs.pod:2990
5841 "This library is free software; you can redistribute it and/or modify it "
5842 "under the terms of the GNU Lesser General Public License as published by the "
5843 "Free Software Foundation; either version 2 of the License, or (at your "
5844 "option) any later version."
5848 #: ../src/guestfs.pod:2995
5850 "This library is distributed in the hope that it will be useful, but WITHOUT "
5851 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
5852 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License "
5857 #: ../src/guestfs.pod:3000
5859 "You should have received a copy of the GNU Lesser General Public License "
5860 "along with this library; if not, write to the Free Software Foundation, "
5861 "Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA"
5865 #: ../src/guestfs-actions.pod:1
5866 msgid "guestfs_add_cdrom"
5870 #: ../src/guestfs-actions.pod:3
5874 " guestfs_add_cdrom (guestfs_h *g,\n"
5875 " const char *filename);\n"
5880 #: ../src/guestfs-actions.pod:7 ../fish/guestfish-actions.pod:5
5881 msgid "This function adds a virtual CD-ROM disk image to the guest."
5885 #: ../src/guestfs-actions.pod:9 ../fish/guestfish-actions.pod:7
5886 msgid "This is equivalent to the qemu parameter I<-cdrom filename>."
5890 #: ../src/guestfs-actions.pod:17
5892 "This call checks for the existence of C<filename>. This stops you from "
5893 "specifying other types of drive which are supported by qemu such as C<nbd:> "
5894 "and C<http:> URLs. To specify those, use the general C<guestfs_config> call "
5899 #: ../src/guestfs-actions.pod:24
5901 "If you just want to add an ISO file (often you use this as an efficient way "
5902 "to transfer large files into the guest), then you should probably use "
5903 "C<guestfs_add_drive_ro> instead."
5907 #: ../src/guestfs-actions.pod:30 ../src/guestfs-actions.pod:134
5908 #: ../src/guestfs-actions.pod:195 ../src/guestfs-actions.pod:232
5909 #: ../src/guestfs-actions.pod:246 ../src/guestfs-actions.pod:267
5910 #: ../src/guestfs-actions.pod:287 ../src/guestfs-actions.pod:301
5911 #: ../src/guestfs-actions.pod:416 ../src/guestfs-actions.pod:436
5912 #: ../src/guestfs-actions.pod:450 ../src/guestfs-actions.pod:495
5913 #: ../src/guestfs-actions.pod:523 ../src/guestfs-actions.pod:541
5914 #: ../src/guestfs-actions.pod:608 ../src/guestfs-actions.pod:641
5915 #: ../src/guestfs-actions.pod:655 ../src/guestfs-actions.pod:670
5916 #: ../src/guestfs-actions.pod:769 ../src/guestfs-actions.pod:787
5917 #: ../src/guestfs-actions.pod:801 ../src/guestfs-actions.pod:815
5918 #: ../src/guestfs-actions.pod:976 ../src/guestfs-actions.pod:996
5919 #: ../src/guestfs-actions.pod:1014 ../src/guestfs-actions.pod:1098
5920 #: ../src/guestfs-actions.pod:1116 ../src/guestfs-actions.pod:1135
5921 #: ../src/guestfs-actions.pod:1149 ../src/guestfs-actions.pod:1169
5922 #: ../src/guestfs-actions.pod:1239 ../src/guestfs-actions.pod:1270
5923 #: ../src/guestfs-actions.pod:1295 ../src/guestfs-actions.pod:1337
5924 #: ../src/guestfs-actions.pod:1443 ../src/guestfs-actions.pod:1477
5925 #: ../src/guestfs-actions.pod:1695 ../src/guestfs-actions.pod:1717
5926 #: ../src/guestfs-actions.pod:1804 ../src/guestfs-actions.pod:2266
5927 #: ../src/guestfs-actions.pod:2410 ../src/guestfs-actions.pod:2471
5928 #: ../src/guestfs-actions.pod:2506 ../src/guestfs-actions.pod:3459
5929 #: ../src/guestfs-actions.pod:3474 ../src/guestfs-actions.pod:3499
5930 #: ../src/guestfs-actions.pod:3654 ../src/guestfs-actions.pod:3668
5931 #: ../src/guestfs-actions.pod:3681 ../src/guestfs-actions.pod:3695
5932 #: ../src/guestfs-actions.pod:3710 ../src/guestfs-actions.pod:3746
5933 #: ../src/guestfs-actions.pod:3818 ../src/guestfs-actions.pod:3838
5934 #: ../src/guestfs-actions.pod:3855 ../src/guestfs-actions.pod:3878
5935 #: ../src/guestfs-actions.pod:3901 ../src/guestfs-actions.pod:3933
5936 #: ../src/guestfs-actions.pod:3952 ../src/guestfs-actions.pod:3971
5937 #: ../src/guestfs-actions.pod:4006 ../src/guestfs-actions.pod:4018
5938 #: ../src/guestfs-actions.pod:4054 ../src/guestfs-actions.pod:4070
5939 #: ../src/guestfs-actions.pod:4083 ../src/guestfs-actions.pod:4098
5940 #: ../src/guestfs-actions.pod:4115 ../src/guestfs-actions.pod:4208
5941 #: ../src/guestfs-actions.pod:4228 ../src/guestfs-actions.pod:4241
5942 #: ../src/guestfs-actions.pod:4292 ../src/guestfs-actions.pod:4310
5943 #: ../src/guestfs-actions.pod:4328 ../src/guestfs-actions.pod:4344
5944 #: ../src/guestfs-actions.pod:4358 ../src/guestfs-actions.pod:4372
5945 #: ../src/guestfs-actions.pod:4389 ../src/guestfs-actions.pod:4404
5946 #: ../src/guestfs-actions.pod:4424 ../src/guestfs-actions.pod:4482
5947 #: ../src/guestfs-actions.pod:4555 ../src/guestfs-actions.pod:4586
5948 #: ../src/guestfs-actions.pod:4605 ../src/guestfs-actions.pod:4624
5949 #: ../src/guestfs-actions.pod:4636 ../src/guestfs-actions.pod:4653
5950 #: ../src/guestfs-actions.pod:4666 ../src/guestfs-actions.pod:4681
5951 #: ../src/guestfs-actions.pod:4696 ../src/guestfs-actions.pod:4731
5952 #: ../src/guestfs-actions.pod:4746 ../src/guestfs-actions.pod:4766
5953 #: ../src/guestfs-actions.pod:4780 ../src/guestfs-actions.pod:4797
5954 #: ../src/guestfs-actions.pod:4846 ../src/guestfs-actions.pod:4883
5955 #: ../src/guestfs-actions.pod:4897 ../src/guestfs-actions.pod:4925
5956 #: ../src/guestfs-actions.pod:4942 ../src/guestfs-actions.pod:4960
5957 #: ../src/guestfs-actions.pod:5094 ../src/guestfs-actions.pod:5151
5958 #: ../src/guestfs-actions.pod:5173 ../src/guestfs-actions.pod:5191
5959 #: ../src/guestfs-actions.pod:5223 ../src/guestfs-actions.pod:5289
5960 #: ../src/guestfs-actions.pod:5306 ../src/guestfs-actions.pod:5319
5961 #: ../src/guestfs-actions.pod:5333 ../src/guestfs-actions.pod:5622
5962 #: ../src/guestfs-actions.pod:5641 ../src/guestfs-actions.pod:5660
5963 #: ../src/guestfs-actions.pod:5672 ../src/guestfs-actions.pod:5684
5964 #: ../src/guestfs-actions.pod:5698 ../src/guestfs-actions.pod:5710
5965 #: ../src/guestfs-actions.pod:5724 ../src/guestfs-actions.pod:5740
5966 #: ../src/guestfs-actions.pod:5761 ../src/guestfs-actions.pod:5780
5967 #: ../src/guestfs-actions.pod:5799 ../src/guestfs-actions.pod:5829
5968 #: ../src/guestfs-actions.pod:5845 ../src/guestfs-actions.pod:5868
5969 #: ../src/guestfs-actions.pod:5886 ../src/guestfs-actions.pod:5905
5970 #: ../src/guestfs-actions.pod:5926 ../src/guestfs-actions.pod:5945
5971 #: ../src/guestfs-actions.pod:5962 ../src/guestfs-actions.pod:5990
5972 #: ../src/guestfs-actions.pod:6014 ../src/guestfs-actions.pod:6033
5973 #: ../src/guestfs-actions.pod:6057 ../src/guestfs-actions.pod:6076
5974 #: ../src/guestfs-actions.pod:6091 ../src/guestfs-actions.pod:6110
5975 #: ../src/guestfs-actions.pod:6147 ../src/guestfs-actions.pod:6170
5976 #: ../src/guestfs-actions.pod:6196 ../src/guestfs-actions.pod:6304
5977 #: ../src/guestfs-actions.pod:6425 ../src/guestfs-actions.pod:6437
5978 #: ../src/guestfs-actions.pod:6450 ../src/guestfs-actions.pod:6463
5979 #: ../src/guestfs-actions.pod:6485 ../src/guestfs-actions.pod:6498
5980 #: ../src/guestfs-actions.pod:6511 ../src/guestfs-actions.pod:6524
5981 #: ../src/guestfs-actions.pod:6539 ../src/guestfs-actions.pod:6598
5982 #: ../src/guestfs-actions.pod:6615 ../src/guestfs-actions.pod:6631
5983 #: ../src/guestfs-actions.pod:6647 ../src/guestfs-actions.pod:6664
5984 #: ../src/guestfs-actions.pod:6677 ../src/guestfs-actions.pod:6697
5985 #: ../src/guestfs-actions.pod:6733 ../src/guestfs-actions.pod:6747
5986 #: ../src/guestfs-actions.pod:6788 ../src/guestfs-actions.pod:6801
5987 #: ../src/guestfs-actions.pod:6819 ../src/guestfs-actions.pod:6853
5988 #: ../src/guestfs-actions.pod:6889 ../src/guestfs-actions.pod:7008
5989 #: ../src/guestfs-actions.pod:7026 ../src/guestfs-actions.pod:7040
5990 #: ../src/guestfs-actions.pod:7095 ../src/guestfs-actions.pod:7108
5991 #: ../src/guestfs-actions.pod:7153 ../src/guestfs-actions.pod:7186
5992 #: ../src/guestfs-actions.pod:7240 ../src/guestfs-actions.pod:7266
5993 #: ../src/guestfs-actions.pod:7332 ../src/guestfs-actions.pod:7351
5994 #: ../src/guestfs-actions.pod:7380
5995 msgid "This function returns 0 on success or -1 on error."
5999 #: ../src/guestfs-actions.pod:32 ../src/guestfs-actions.pod:248
6000 #: ../src/guestfs-actions.pod:269 ../fish/guestfish-actions.pod:28
6001 #: ../fish/guestfish-actions.pod:158 ../fish/guestfish-actions.pod:172
6003 "This function is deprecated. In new code, use the C<add_drive_opts> call "
6008 #: ../src/guestfs-actions.pod:35 ../src/guestfs-actions.pod:251
6009 #: ../src/guestfs-actions.pod:272 ../src/guestfs-actions.pod:1448
6010 #: ../src/guestfs-actions.pod:1944 ../src/guestfs-actions.pod:1965
6011 #: ../src/guestfs-actions.pod:4429 ../src/guestfs-actions.pod:7274
6012 #: ../src/guestfs-actions.pod:7443 ../fish/guestfish-actions.pod:31
6013 #: ../fish/guestfish-actions.pod:161 ../fish/guestfish-actions.pod:175
6014 #: ../fish/guestfish-actions.pod:956 ../fish/guestfish-actions.pod:1319
6015 #: ../fish/guestfish-actions.pod:1333 ../fish/guestfish-actions.pod:3008
6016 #: ../fish/guestfish-actions.pod:4866 ../fish/guestfish-actions.pod:4963
6018 "Deprecated functions will not be removed from the API, but the fact that "
6019 "they are deprecated indicates that there are problems with correct use of "
6024 #: ../src/guestfs-actions.pod:39 ../src/guestfs-actions.pod:136
6025 #: ../src/guestfs-actions.pod:1100 ../src/guestfs-actions.pod:1916
6026 #: ../src/guestfs-actions.pod:2014 ../src/guestfs-actions.pod:2117
6027 #: ../src/guestfs-actions.pod:3461 ../src/guestfs-actions.pod:3481
6028 #: ../src/guestfs-actions.pod:4733 ../src/guestfs-actions.pod:5847
6029 #: ../src/guestfs-actions.pod:5964 ../src/guestfs-actions.pod:6078
6030 #: ../src/guestfs-actions.pod:6541 ../src/guestfs-actions.pod:6666
6031 #: ../src/guestfs-actions.pod:7188
6032 msgid "(Added in 0.3)"
6036 #: ../src/guestfs-actions.pod:41
6037 msgid "guestfs_add_domain"
6041 #: ../src/guestfs-actions.pod:43
6045 " guestfs_add_domain (guestfs_h *g,\n"
6046 " const char *dom,\n"
6052 #: ../src/guestfs-actions.pod:48 ../src/guestfs-actions.pod:145
6053 #: ../src/guestfs-actions.pod:4443
6055 "You may supply a list of optional arguments to this call. Use zero or more "
6056 "of the following pairs of parameters, and terminate the list with C<-1> on "
6057 "its own. See L</CALLS WITH OPTIONAL ARGUMENTS>."
6061 #: ../src/guestfs-actions.pod:53
6064 " GUESTFS_ADD_DOMAIN_LIBVIRTURI, const char *libvirturi,\n"
6065 " GUESTFS_ADD_DOMAIN_READONLY, int readonly,\n"
6066 " GUESTFS_ADD_DOMAIN_IFACE, const char *iface,\n"
6067 " GUESTFS_ADD_DOMAIN_LIVE, int live,\n"
6072 #: ../src/guestfs-actions.pod:58
6074 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
6075 "It works by connecting to libvirt, requesting the domain and domain XML from "
6076 "libvirt, parsing it for disks, and calling C<guestfs_add_drive_opts> on each "
6081 #: ../src/guestfs-actions.pod:63 ../fish/guestfish-actions.pod:46
6083 "The number of disks added is returned. This operation is atomic: if an "
6084 "error is returned, then no disks are added."
6088 #: ../src/guestfs-actions.pod:66 ../fish/guestfish-actions.pod:49
6090 "This function does some minimal checks to make sure the libvirt domain is "
6091 "not running (unless C<readonly> is true). In a future version we will try "
6092 "to acquire the libvirt lock on each disk."
6096 #: ../src/guestfs-actions.pod:70 ../fish/guestfish-actions.pod:53
6098 "Disks must be accessible locally. This often means that adding disks from a "
6099 "remote libvirt connection (see L<http://libvirt.org/remote.html>) will fail "
6100 "unless those disks are accessible via the same device path locally too."
6104 #: ../src/guestfs-actions.pod:75 ../fish/guestfish-actions.pod:58
6106 "The optional C<libvirturi> parameter sets the libvirt URI (see L<http://"
6107 "libvirt.org/uri.html>). If this is not set then we connect to the default "
6108 "libvirt URI (or one set through an environment variable, see the libvirt "
6109 "documentation for full details)."
6113 #: ../src/guestfs-actions.pod:81 ../fish/guestfish-actions.pod:64
6115 "The optional C<live> flag controls whether this call will try to connect to "
6116 "a running virtual machine C<guestfsd> process if it sees a suitable "
6117 "E<lt>channelE<gt> element in the libvirt XML definition. The default (if "
6118 "the flag is omitted) is never to try. See L<guestfs(3)/ATTACHING TO RUNNING "
6119 "DAEMONS> for more information."
6123 #: ../src/guestfs-actions.pod:88
6125 "The other optional parameters are passed directly through to "
6126 "C<guestfs_add_drive_opts>."
6130 #: ../src/guestfs-actions.pod:91 ../src/guestfs-actions.pod:344
6131 #: ../src/guestfs-actions.pod:509 ../src/guestfs-actions.pod:687
6132 #: ../src/guestfs-actions.pod:718 ../src/guestfs-actions.pod:736
6133 #: ../src/guestfs-actions.pod:755 ../src/guestfs-actions.pod:1315
6134 #: ../src/guestfs-actions.pod:1674 ../src/guestfs-actions.pod:1877
6135 #: ../src/guestfs-actions.pod:1986 ../src/guestfs-actions.pod:2026
6136 #: ../src/guestfs-actions.pod:2081 ../src/guestfs-actions.pod:2104
6137 #: ../src/guestfs-actions.pod:2397 ../src/guestfs-actions.pod:2780
6138 #: ../src/guestfs-actions.pod:2801 ../src/guestfs-actions.pod:4869
6139 #: ../src/guestfs-actions.pod:4997 ../src/guestfs-actions.pod:5403
6140 #: ../src/guestfs-actions.pod:5429 ../src/guestfs-actions.pod:6774
6141 #: ../src/guestfs-actions.pod:7199 ../src/guestfs-actions.pod:7212
6142 #: ../src/guestfs-actions.pod:7225
6143 msgid "On error this function returns -1."
6147 #: ../src/guestfs-actions.pod:93
6148 msgid "(Added in 1.7.4)"
6152 #: ../src/guestfs-actions.pod:95
6153 msgid "guestfs_add_domain_va"
6157 #: ../src/guestfs-actions.pod:97
6161 " guestfs_add_domain_va (guestfs_h *g,\n"
6162 " const char *dom,\n"
6168 #: ../src/guestfs-actions.pod:102
6169 msgid "This is the \"va_list variant\" of L</guestfs_add_domain>."
6173 #: ../src/guestfs-actions.pod:104 ../src/guestfs-actions.pod:115
6174 #: ../src/guestfs-actions.pod:208 ../src/guestfs-actions.pod:219
6175 #: ../src/guestfs-actions.pod:4496 ../src/guestfs-actions.pod:4508
6176 msgid "See L</CALLS WITH OPTIONAL ARGUMENTS>."
6180 #: ../src/guestfs-actions.pod:106
6181 msgid "guestfs_add_domain_argv"
6185 #: ../src/guestfs-actions.pod:108
6189 " guestfs_add_domain_argv (guestfs_h *g,\n"
6190 " const char *dom,\n"
6191 " const struct guestfs_add_domain_argv *optargs);\n"
6196 #: ../src/guestfs-actions.pod:113
6197 msgid "This is the \"argv variant\" of L</guestfs_add_domain>."
6201 #: ../src/guestfs-actions.pod:117
6202 msgid "guestfs_add_drive"
6206 #: ../src/guestfs-actions.pod:119
6210 " guestfs_add_drive (guestfs_h *g,\n"
6211 " const char *filename);\n"
6216 #: ../src/guestfs-actions.pod:123
6218 "This function is the equivalent of calling C<guestfs_add_drive_opts> with no "
6219 "optional parameters, so the disk is added writable, with the format being "
6220 "detected automatically."
6224 #: ../src/guestfs-actions.pod:127
6226 "Automatic detection of the format opens you up to a potential security hole "
6227 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
6228 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
6229 "you should think about replacing calls to this function with calls to "
6230 "C<guestfs_add_drive_opts>, and specifying the format."
6234 #: ../src/guestfs-actions.pod:138
6235 msgid "guestfs_add_drive_opts"
6239 #: ../src/guestfs-actions.pod:140
6243 " guestfs_add_drive_opts (guestfs_h *g,\n"
6244 " const char *filename,\n"
6250 #: ../src/guestfs-actions.pod:150
6253 " GUESTFS_ADD_DRIVE_OPTS_READONLY, int readonly,\n"
6254 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, const char *format,\n"
6255 " GUESTFS_ADD_DRIVE_OPTS_IFACE, const char *iface,\n"
6260 #: ../src/guestfs-actions.pod:154 ../fish/guestfish-actions.pod:97
6262 "This function adds a virtual machine disk image C<filename> to libguestfs. "
6263 "The first time you call this function, the disk appears as C</dev/sda>, the "
6264 "second time as C</dev/sdb>, and so on."
6268 #: ../src/guestfs-actions.pod:159 ../fish/guestfish-actions.pod:102
6270 "You don't necessarily need to be root when using libguestfs. However you "
6271 "obviously do need sufficient permissions to access the filename for whatever "
6272 "operations you want to perform (ie. read access if you just want to read the "
6273 "image or write access if you want to modify the image)."
6277 #: ../src/guestfs-actions.pod:165 ../fish/guestfish-actions.pod:108
6278 msgid "This call checks that C<filename> exists."
6282 #: ../src/guestfs-actions.pod:167 ../src/guestfs-actions.pod:4454
6283 #: ../fish/guestfish-actions.pod:110 ../fish/guestfish-actions.pod:3019
6284 msgid "The optional arguments are:"
6288 #: ../src/guestfs-actions.pod:171 ../fish/guestfish-actions.pod:114
6290 msgstr "C<readonly>"
6293 #: ../src/guestfs-actions.pod:173 ../fish/guestfish-actions.pod:116
6295 "If true then the image is treated as read-only. Writes are still allowed, "
6296 "but they are stored in a temporary snapshot overlay which is discarded at "
6297 "the end. The disk that you add is not modified."
6301 #: ../src/guestfs-actions.pod:177 ../fish/guestfish-actions.pod:120
6306 #: ../src/guestfs-actions.pod:179
6308 "This forces the image format. If you omit this (or use C<guestfs_add_drive> "
6309 "or C<guestfs_add_drive_ro>) then the format is automatically detected. "
6310 "Possible formats include C<raw> and C<qcow2>."
6314 #: ../src/guestfs-actions.pod:183 ../fish/guestfish-actions.pod:126
6316 "Automatic detection of the format opens you up to a potential security hole "
6317 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
6318 "RHBZ#642934. Specifying the format closes this security hole."
6322 #: ../src/guestfs-actions.pod:188 ../fish/guestfish-actions.pod:131
6327 #: ../src/guestfs-actions.pod:190
6329 "This rarely-used option lets you emulate the behaviour of the deprecated "
6330 "C<guestfs_add_drive_with_if> call (q.v.)"
6334 #: ../src/guestfs-actions.pod:197
6335 msgid "(Added in 1.5.23)"
6339 #: ../src/guestfs-actions.pod:199
6340 msgid "guestfs_add_drive_opts_va"
6344 #: ../src/guestfs-actions.pod:201
6348 " guestfs_add_drive_opts_va (guestfs_h *g,\n"
6349 " const char *filename,\n"
6355 #: ../src/guestfs-actions.pod:206
6356 msgid "This is the \"va_list variant\" of L</guestfs_add_drive_opts>."
6360 #: ../src/guestfs-actions.pod:210
6361 msgid "guestfs_add_drive_opts_argv"
6365 #: ../src/guestfs-actions.pod:212
6369 " guestfs_add_drive_opts_argv (guestfs_h *g,\n"
6370 " const char *filename,\n"
6371 " const struct guestfs_add_drive_opts_argv *optargs);\n"
6376 #: ../src/guestfs-actions.pod:217
6377 msgid "This is the \"argv variant\" of L</guestfs_add_drive_opts>."
6381 #: ../src/guestfs-actions.pod:221
6382 msgid "guestfs_add_drive_ro"
6386 #: ../src/guestfs-actions.pod:223
6390 " guestfs_add_drive_ro (guestfs_h *g,\n"
6391 " const char *filename);\n"
6396 #: ../src/guestfs-actions.pod:227
6398 "This function is the equivalent of calling C<guestfs_add_drive_opts> with "
6399 "the optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the "
6400 "disk is added read-only, with the format being detected automatically."
6404 #: ../src/guestfs-actions.pod:234
6405 msgid "(Added in 1.0.38)"
6409 #: ../src/guestfs-actions.pod:236
6410 msgid "guestfs_add_drive_ro_with_if"
6414 #: ../src/guestfs-actions.pod:238
6418 " guestfs_add_drive_ro_with_if (guestfs_h *g,\n"
6419 " const char *filename,\n"
6420 " const char *iface);\n"
6425 #: ../src/guestfs-actions.pod:243
6427 "This is the same as C<guestfs_add_drive_ro> but it allows you to specify the "
6428 "QEMU interface emulation to use at run time."
6432 #: ../src/guestfs-actions.pod:255 ../src/guestfs-actions.pod:276
6433 #: ../src/guestfs-actions.pod:2356
6434 msgid "(Added in 1.0.84)"
6438 #: ../src/guestfs-actions.pod:257
6439 msgid "guestfs_add_drive_with_if"
6443 #: ../src/guestfs-actions.pod:259
6447 " guestfs_add_drive_with_if (guestfs_h *g,\n"
6448 " const char *filename,\n"
6449 " const char *iface);\n"
6454 #: ../src/guestfs-actions.pod:264
6456 "This is the same as C<guestfs_add_drive> but it allows you to specify the "
6457 "QEMU interface emulation to use at run time."
6461 #: ../src/guestfs-actions.pod:278
6462 msgid "guestfs_aug_clear"
6466 #: ../src/guestfs-actions.pod:280
6470 " guestfs_aug_clear (guestfs_h *g,\n"
6471 " const char *augpath);\n"
6476 #: ../src/guestfs-actions.pod:284 ../fish/guestfish-actions.pod:183
6478 "Set the value associated with C<path> to C<NULL>. This is the same as the "
6479 "L<augtool(1)> C<clear> command."
6483 #: ../src/guestfs-actions.pod:289 ../src/guestfs-actions.pod:2106
6484 msgid "(Added in 1.3.4)"
6488 #: ../src/guestfs-actions.pod:291
6489 msgid "guestfs_aug_close"
6493 #: ../src/guestfs-actions.pod:293
6497 " guestfs_aug_close (guestfs_h *g);\n"
6502 #: ../src/guestfs-actions.pod:296
6504 "Close the current Augeas handle and free up any resources used by it. After "
6505 "calling this, you have to call C<guestfs_aug_init> again before you can use "
6506 "any other Augeas functions."
6510 #: ../src/guestfs-actions.pod:303 ../src/guestfs-actions.pod:328
6511 #: ../src/guestfs-actions.pod:346 ../src/guestfs-actions.pod:360
6512 #: ../src/guestfs-actions.pod:418 ../src/guestfs-actions.pod:438
6513 #: ../src/guestfs-actions.pod:452 ../src/guestfs-actions.pod:483
6514 #: ../src/guestfs-actions.pod:497 ../src/guestfs-actions.pod:511
6515 #: ../src/guestfs-actions.pod:525 ../src/guestfs-actions.pod:543
6516 #: ../src/guestfs-actions.pod:5480
6517 msgid "(Added in 0.7)"
6521 #: ../src/guestfs-actions.pod:305
6522 msgid "guestfs_aug_defnode"
6526 #: ../src/guestfs-actions.pod:307
6529 " struct guestfs_int_bool *\n"
6530 " guestfs_aug_defnode (guestfs_h *g,\n"
6531 " const char *name,\n"
6532 " const char *expr,\n"
6533 " const char *val);\n"
6538 #: ../src/guestfs-actions.pod:313 ../fish/guestfish-actions.pod:199
6540 "Defines a variable C<name> whose value is the result of evaluating C<expr>."
6544 #: ../src/guestfs-actions.pod:316
6546 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
6547 "calling C<guestfs_aug_set> C<expr>, C<value>. C<name> will be the nodeset "
6548 "containing that single node."
6552 #: ../src/guestfs-actions.pod:320 ../fish/guestfish-actions.pod:206
6554 "On success this returns a pair containing the number of nodes in the "
6555 "nodeset, and a boolean flag if a node was created."
6559 #: ../src/guestfs-actions.pod:324
6561 "This function returns a C<struct guestfs_int_bool *>, or NULL if there was "
6562 "an error. I<The caller must call C<guestfs_free_int_bool> after use>."
6566 #: ../src/guestfs-actions.pod:330
6567 msgid "guestfs_aug_defvar"
6571 #: ../src/guestfs-actions.pod:332
6575 " guestfs_aug_defvar (guestfs_h *g,\n"
6576 " const char *name,\n"
6577 " const char *expr);\n"
6582 #: ../src/guestfs-actions.pod:337 ../fish/guestfish-actions.pod:214
6584 "Defines an Augeas variable C<name> whose value is the result of evaluating "
6585 "C<expr>. If C<expr> is NULL, then C<name> is undefined."
6589 #: ../src/guestfs-actions.pod:341 ../fish/guestfish-actions.pod:218
6591 "On success this returns the number of nodes in C<expr>, or C<0> if C<expr> "
6592 "evaluates to something which is not a nodeset."
6596 #: ../src/guestfs-actions.pod:348
6597 msgid "guestfs_aug_get"
6601 #: ../src/guestfs-actions.pod:350
6605 " guestfs_aug_get (guestfs_h *g,\n"
6606 " const char *augpath);\n"
6611 #: ../src/guestfs-actions.pod:354 ../fish/guestfish-actions.pod:225
6613 "Look up the value associated with C<path>. If C<path> matches exactly one "
6614 "node, the C<value> is returned."
6618 #: ../src/guestfs-actions.pod:357 ../src/guestfs-actions.pod:857
6619 #: ../src/guestfs-actions.pod:875 ../src/guestfs-actions.pod:935
6620 #: ../src/guestfs-actions.pod:951 ../src/guestfs-actions.pod:1054
6621 #: ../src/guestfs-actions.pod:1184 ../src/guestfs-actions.pod:1201
6622 #: ../src/guestfs-actions.pod:1220 ../src/guestfs-actions.pod:1354
6623 #: ../src/guestfs-actions.pod:1545 ../src/guestfs-actions.pod:1657
6624 #: ../src/guestfs-actions.pod:1820 ../src/guestfs-actions.pod:1837
6625 #: ../src/guestfs-actions.pod:1904 ../src/guestfs-actions.pod:1938
6626 #: ../src/guestfs-actions.pod:1959 ../src/guestfs-actions.pod:2129
6627 #: ../src/guestfs-actions.pod:2321 ../src/guestfs-actions.pod:2528
6628 #: ../src/guestfs-actions.pod:2621 ../src/guestfs-actions.pod:2732
6629 #: ../src/guestfs-actions.pod:2752 ../src/guestfs-actions.pod:2872
6630 #: ../src/guestfs-actions.pod:2903 ../src/guestfs-actions.pod:2927
6631 #: ../src/guestfs-actions.pod:2964 ../src/guestfs-actions.pod:3024
6632 #: ../src/guestfs-actions.pod:3047 ../src/guestfs-actions.pod:3068
6633 #: ../src/guestfs-actions.pod:3640 ../src/guestfs-actions.pod:3990
6634 #: ../src/guestfs-actions.pod:4160 ../src/guestfs-actions.pod:4270
6635 #: ../src/guestfs-actions.pod:5015 ../src/guestfs-actions.pod:5208
6636 #: ../src/guestfs-actions.pod:5378 ../src/guestfs-actions.pod:5556
6637 #: ../src/guestfs-actions.pod:5605 ../src/guestfs-actions.pod:6217
6638 #: ../src/guestfs-actions.pod:6233 ../src/guestfs-actions.pod:6250
6639 #: ../src/guestfs-actions.pod:6274 ../src/guestfs-actions.pod:6948
6640 #: ../src/guestfs-actions.pod:6967 ../src/guestfs-actions.pod:6985
6641 #: ../src/guestfs-actions.pod:7165 ../src/guestfs-actions.pod:7437
6643 "This function returns a string, or NULL on error. I<The caller must free "
6644 "the returned string after use>."
6648 #: ../src/guestfs-actions.pod:362
6649 msgid "guestfs_aug_init"
6653 #: ../src/guestfs-actions.pod:364
6657 " guestfs_aug_init (guestfs_h *g,\n"
6658 " const char *root,\n"
6664 #: ../src/guestfs-actions.pod:369 ../fish/guestfish-actions.pod:232
6666 "Create a new Augeas handle for editing configuration files. If there was "
6667 "any previous Augeas handle associated with this guestfs session, then it is "
6672 #: ../src/guestfs-actions.pod:373
6673 msgid "You must call this before using any other C<guestfs_aug_*> commands."
6677 #: ../src/guestfs-actions.pod:376 ../fish/guestfish-actions.pod:239
6679 "C<root> is the filesystem root. C<root> must not be NULL, use C</> instead."
6683 #: ../src/guestfs-actions.pod:379 ../fish/guestfish-actions.pod:242
6685 "The flags are the same as the flags defined in E<lt>augeas.hE<gt>, the "
6686 "logical I<or> of the following integers:"
6690 #: ../src/guestfs-actions.pod:385 ../fish/guestfish-actions.pod:248
6691 msgid "C<AUG_SAVE_BACKUP> = 1"
6692 msgstr "C<AUG_SAVE_BACKUP> = 1"
6695 #: ../src/guestfs-actions.pod:387 ../fish/guestfish-actions.pod:250
6696 msgid "Keep the original file with a C<.augsave> extension."
6700 #: ../src/guestfs-actions.pod:389 ../fish/guestfish-actions.pod:252
6701 msgid "C<AUG_SAVE_NEWFILE> = 2"
6702 msgstr "C<AUG_SAVE_NEWFILE> = 2"
6705 #: ../src/guestfs-actions.pod:391 ../fish/guestfish-actions.pod:254
6707 "Save changes into a file with extension C<.augnew>, and do not overwrite "
6708 "original. Overrides C<AUG_SAVE_BACKUP>."
6712 #: ../src/guestfs-actions.pod:394 ../fish/guestfish-actions.pod:257
6713 msgid "C<AUG_TYPE_CHECK> = 4"
6714 msgstr "C<AUG_TYPE_CHECK> = 4"
6717 #: ../src/guestfs-actions.pod:396 ../fish/guestfish-actions.pod:259
6718 msgid "Typecheck lenses (can be expensive)."
6722 #: ../src/guestfs-actions.pod:398 ../fish/guestfish-actions.pod:261
6723 msgid "C<AUG_NO_STDINC> = 8"
6724 msgstr "C<AUG_NO_STDINC> = 8"
6727 #: ../src/guestfs-actions.pod:400 ../fish/guestfish-actions.pod:263
6728 msgid "Do not use standard load path for modules."
6732 #: ../src/guestfs-actions.pod:402 ../fish/guestfish-actions.pod:265
6733 msgid "C<AUG_SAVE_NOOP> = 16"
6734 msgstr "C<AUG_SAVE_NOOP> = 16"
6737 #: ../src/guestfs-actions.pod:404 ../fish/guestfish-actions.pod:267
6738 msgid "Make save a no-op, just record what would have been changed."
6742 #: ../src/guestfs-actions.pod:406 ../fish/guestfish-actions.pod:269
6743 msgid "C<AUG_NO_LOAD> = 32"
6744 msgstr "C<AUG_NO_LOAD> = 32"
6747 #: ../src/guestfs-actions.pod:408
6748 msgid "Do not load the tree in C<guestfs_aug_init>."
6752 #: ../src/guestfs-actions.pod:412
6753 msgid "To close the handle, you can call C<guestfs_aug_close>."
6757 #: ../src/guestfs-actions.pod:414 ../fish/guestfish-actions.pod:277
6758 msgid "To find out more about Augeas, see L<http://augeas.net/>."
6762 #: ../src/guestfs-actions.pod:420
6763 msgid "guestfs_aug_insert"
6767 #: ../src/guestfs-actions.pod:422
6771 " guestfs_aug_insert (guestfs_h *g,\n"
6772 " const char *augpath,\n"
6773 " const char *label,\n"
6779 #: ../src/guestfs-actions.pod:428 ../fish/guestfish-actions.pod:283
6781 "Create a new sibling C<label> for C<path>, inserting it into the tree before "
6782 "or after C<path> (depending on the boolean flag C<before>)."
6786 #: ../src/guestfs-actions.pod:432 ../fish/guestfish-actions.pod:287
6788 "C<path> must match exactly one existing node in the tree, and C<label> must "
6789 "be a label, ie. not contain C</>, C<*> or end with a bracketed index C<[N]>."
6793 #: ../src/guestfs-actions.pod:440
6794 msgid "guestfs_aug_load"
6798 #: ../src/guestfs-actions.pod:442
6802 " guestfs_aug_load (guestfs_h *g);\n"
6807 #: ../src/guestfs-actions.pod:445 ../fish/guestfish-actions.pod:295
6808 msgid "Load files into the tree."
6809 msgstr "Завантажити файли до ієрархії."
6812 #: ../src/guestfs-actions.pod:447 ../fish/guestfish-actions.pod:297
6813 msgid "See C<aug_load> in the Augeas documentation for the full gory details."
6817 #: ../src/guestfs-actions.pod:454
6818 msgid "guestfs_aug_ls"
6822 #: ../src/guestfs-actions.pod:456
6826 " guestfs_aug_ls (guestfs_h *g,\n"
6827 " const char *augpath);\n"
6832 #: ../src/guestfs-actions.pod:460
6834 "This is just a shortcut for listing C<guestfs_aug_match> C<path/*> and "
6835 "sorting the resulting nodes into alphabetical order."
6839 #: ../src/guestfs-actions.pod:463 ../src/guestfs-actions.pod:479
6840 #: ../src/guestfs-actions.pod:625 ../src/guestfs-actions.pod:1073
6841 #: ../src/guestfs-actions.pod:1369 ../src/guestfs-actions.pod:1388
6842 #: ../src/guestfs-actions.pod:1491 ../src/guestfs-actions.pod:1510
6843 #: ../src/guestfs-actions.pod:1759 ../src/guestfs-actions.pod:2201
6844 #: ../src/guestfs-actions.pod:2217 ../src/guestfs-actions.pod:2236
6845 #: ../src/guestfs-actions.pod:2279 ../src/guestfs-actions.pod:2303
6846 #: ../src/guestfs-actions.pod:2374 ../src/guestfs-actions.pod:2423
6847 #: ../src/guestfs-actions.pod:2690 ../src/guestfs-actions.pod:2981
6848 #: ../src/guestfs-actions.pod:3270 ../src/guestfs-actions.pod:3560
6849 #: ../src/guestfs-actions.pod:3622 ../src/guestfs-actions.pod:3727
6850 #: ../src/guestfs-actions.pod:4132 ../src/guestfs-actions.pod:4830
6851 #: ../src/guestfs-actions.pod:5350 ../src/guestfs-actions.pod:5476
6852 #: ../src/guestfs-actions.pod:5590 ../src/guestfs-actions.pod:6290
6853 #: ../src/guestfs-actions.pod:6351 ../src/guestfs-actions.pod:6406
6854 #: ../src/guestfs-actions.pod:6552 ../src/guestfs-actions.pod:6576
6855 #: ../src/guestfs-actions.pod:7058 ../src/guestfs-actions.pod:7078
6856 #: ../src/guestfs-actions.pod:7125 ../src/guestfs-actions.pod:7290
6857 #: ../src/guestfs-actions.pod:7309 ../src/guestfs-actions.pod:7394
6858 #: ../src/guestfs-actions.pod:7413 ../src/guestfs-actions.pod:7459
6859 #: ../src/guestfs-actions.pod:7478
6861 "This function returns a NULL-terminated array of strings (like L<environ(3)"
6862 ">), or NULL if there was an error. I<The caller must free the strings and "
6863 "the array after use>."
6867 #: ../src/guestfs-actions.pod:467 ../src/guestfs-actions.pod:998
6868 #: ../src/guestfs-actions.pod:1016 ../src/guestfs-actions.pod:1426
6869 #: ../src/guestfs-actions.pod:3348 ../src/guestfs-actions.pod:3379
6870 #: ../src/guestfs-actions.pod:3973 ../src/guestfs-actions.pod:4023
6871 #: ../src/guestfs-actions.pod:4210 ../src/guestfs-actions.pod:4243
6872 #: ../src/guestfs-actions.pod:4406 ../src/guestfs-actions.pod:4834
6873 #: ../src/guestfs-actions.pod:5291 ../src/guestfs-actions.pod:5686
6874 #: ../src/guestfs-actions.pod:5700 ../src/guestfs-actions.pod:5712
6875 #: ../src/guestfs-actions.pod:6152 ../src/guestfs-actions.pod:6790
6876 #: ../src/guestfs-actions.pod:6803 ../src/guestfs-actions.pod:7042
6877 #: ../src/guestfs-actions.pod:7278
6878 msgid "(Added in 0.8)"
6882 #: ../src/guestfs-actions.pod:469
6883 msgid "guestfs_aug_match"
6887 #: ../src/guestfs-actions.pod:471
6891 " guestfs_aug_match (guestfs_h *g,\n"
6892 " const char *augpath);\n"
6897 #: ../src/guestfs-actions.pod:475 ../fish/guestfish-actions.pod:311
6899 "Returns a list of paths which match the path expression C<path>. The "
6900 "returned paths are sufficiently qualified so that they match exactly one "
6901 "node in the current tree."
6905 #: ../src/guestfs-actions.pod:485
6906 msgid "guestfs_aug_mv"
6910 #: ../src/guestfs-actions.pod:487
6914 " guestfs_aug_mv (guestfs_h *g,\n"
6915 " const char *src,\n"
6916 " const char *dest);\n"
6921 #: ../src/guestfs-actions.pod:492 ../fish/guestfish-actions.pod:319
6923 "Move the node C<src> to C<dest>. C<src> must match exactly one node. "
6924 "C<dest> is overwritten if it exists."
6928 #: ../src/guestfs-actions.pod:499
6929 msgid "guestfs_aug_rm"
6933 #: ../src/guestfs-actions.pod:501
6937 " guestfs_aug_rm (guestfs_h *g,\n"
6938 " const char *augpath);\n"
6943 #: ../src/guestfs-actions.pod:505 ../fish/guestfish-actions.pod:326
6944 msgid "Remove C<path> and all of its children."
6948 #: ../src/guestfs-actions.pod:507 ../fish/guestfish-actions.pod:328
6949 msgid "On success this returns the number of entries which were removed."
6953 #: ../src/guestfs-actions.pod:513
6954 msgid "guestfs_aug_save"
6958 #: ../src/guestfs-actions.pod:515
6962 " guestfs_aug_save (guestfs_h *g);\n"
6967 #: ../src/guestfs-actions.pod:518 ../fish/guestfish-actions.pod:334
6968 msgid "This writes all pending changes to disk."
6972 #: ../src/guestfs-actions.pod:520
6974 "The flags which were passed to C<guestfs_aug_init> affect exactly how files "
6979 #: ../src/guestfs-actions.pod:527
6980 msgid "guestfs_aug_set"
6984 #: ../src/guestfs-actions.pod:529
6988 " guestfs_aug_set (guestfs_h *g,\n"
6989 " const char *augpath,\n"
6990 " const char *val);\n"
6995 #: ../src/guestfs-actions.pod:534 ../fish/guestfish-actions.pod:343
6996 msgid "Set the value associated with C<path> to C<val>."
7000 #: ../src/guestfs-actions.pod:536
7002 "In the Augeas API, it is possible to clear a node by setting the value to "
7003 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
7004 "this call. Instead you must use the C<guestfs_aug_clear> call."
7008 #: ../src/guestfs-actions.pod:545
7009 msgid "guestfs_available"
7013 #: ../src/guestfs-actions.pod:547
7017 " guestfs_available (guestfs_h *g,\n"
7018 " char *const *groups);\n"
7023 #: ../src/guestfs-actions.pod:551 ../fish/guestfish-actions.pod:354
7025 "This command is used to check the availability of some groups of "
7026 "functionality in the appliance, which not all builds of the libguestfs "
7027 "appliance will be able to provide."
7031 #: ../src/guestfs-actions.pod:555
7033 "The libguestfs groups, and the functions that those groups correspond to, "
7034 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
7035 "runtime by calling C<guestfs_available_all_groups>."
7039 #: ../src/guestfs-actions.pod:560 ../fish/guestfish-actions.pod:363
7041 "The argument C<groups> is a list of group names, eg: C<[\"inotify\", \"augeas"
7042 "\"]> would check for the availability of the Linux inotify functions and "
7043 "Augeas (configuration file editing) functions."
7047 #: ../src/guestfs-actions.pod:565 ../fish/guestfish-actions.pod:368
7048 msgid "The command returns no error if I<all> requested groups are available."
7052 #: ../src/guestfs-actions.pod:567 ../fish/guestfish-actions.pod:370
7054 "It fails with an error if one or more of the requested groups is unavailable "
7059 #: ../src/guestfs-actions.pod:570 ../fish/guestfish-actions.pod:373
7061 "If an unknown group name is included in the list of groups then an error is "
7066 #: ../src/guestfs-actions.pod:573 ../fish/guestfish-actions.pod:376
7068 msgstr "I<Нотатки:>"
7071 #: ../src/guestfs-actions.pod:579
7072 msgid "You must call C<guestfs_launch> before calling this function."
7076 #: ../src/guestfs-actions.pod:581 ../fish/guestfish-actions.pod:384
7078 "The reason is because we don't know what groups are supported by the "
7079 "appliance/daemon until it is running and can be queried."
7083 #: ../src/guestfs-actions.pod:587 ../fish/guestfish-actions.pod:390
7085 "If a group of functions is available, this does not necessarily mean that "
7086 "they will work. You still have to check for errors when calling individual "
7087 "API functions even if they are available."
7091 #: ../src/guestfs-actions.pod:594 ../fish/guestfish-actions.pod:397
7093 "It is usually the job of distro packagers to build complete functionality "
7094 "into the libguestfs appliance. Upstream libguestfs, if built from source "
7095 "with all requirements satisfied, will support everything."
7099 #: ../src/guestfs-actions.pod:601
7101 "This call was added in version C<1.0.80>. In previous versions of "
7102 "libguestfs all you could do would be to speculatively execute a command to "
7103 "find out if the daemon implemented it. See also C<guestfs_version>."
7107 #: ../src/guestfs-actions.pod:610 ../src/guestfs-actions.pod:1171
7108 msgid "(Added in 1.0.80)"
7112 #: ../src/guestfs-actions.pod:612
7113 msgid "guestfs_available_all_groups"
7117 #: ../src/guestfs-actions.pod:614
7121 " guestfs_available_all_groups (guestfs_h *g);\n"
7126 #: ../src/guestfs-actions.pod:617
7128 "This command returns a list of all optional groups that this daemon knows "
7129 "about. Note this returns both supported and unsupported groups. To find "
7130 "out which ones the daemon can actually support you have to call "
7131 "C<guestfs_available> on each member of the returned list."
7135 #: ../src/guestfs-actions.pod:623
7136 msgid "See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>."
7140 #: ../src/guestfs-actions.pod:629
7141 msgid "(Added in 1.3.15)"
7145 #: ../src/guestfs-actions.pod:631
7146 msgid "guestfs_base64_in"
7150 #: ../src/guestfs-actions.pod:633
7154 " guestfs_base64_in (guestfs_h *g,\n"
7155 " const char *base64file,\n"
7156 " const char *filename);\n"
7161 #: ../src/guestfs-actions.pod:638 ../fish/guestfish-actions.pod:427
7163 "This command uploads base64-encoded data from C<base64file> to C<filename>."
7167 #: ../src/guestfs-actions.pod:643 ../src/guestfs-actions.pod:657
7168 msgid "(Added in 1.3.5)"
7172 #: ../src/guestfs-actions.pod:645
7173 msgid "guestfs_base64_out"
7177 #: ../src/guestfs-actions.pod:647
7181 " guestfs_base64_out (guestfs_h *g,\n"
7182 " const char *filename,\n"
7183 " const char *base64file);\n"
7188 #: ../src/guestfs-actions.pod:652 ../fish/guestfish-actions.pod:436
7190 "This command downloads the contents of C<filename>, writing it out to local "
7191 "file C<base64file> encoded as base64."
7195 #: ../src/guestfs-actions.pod:659
7196 msgid "guestfs_blockdev_flushbufs"
7200 #: ../src/guestfs-actions.pod:661
7204 " guestfs_blockdev_flushbufs (guestfs_h *g,\n"
7205 " const char *device);\n"
7210 #: ../src/guestfs-actions.pod:665 ../fish/guestfish-actions.pod:445
7212 "This tells the kernel to flush internal buffers associated with C<device>."
7216 #: ../src/guestfs-actions.pod:668 ../src/guestfs-actions.pod:685
7217 #: ../src/guestfs-actions.pod:700 ../src/guestfs-actions.pod:716
7218 #: ../src/guestfs-actions.pod:734 ../src/guestfs-actions.pod:753
7219 #: ../src/guestfs-actions.pod:767 ../src/guestfs-actions.pod:785
7220 #: ../src/guestfs-actions.pod:799 ../src/guestfs-actions.pod:813
7221 #: ../fish/guestfish-actions.pod:448 ../fish/guestfish-actions.pod:459
7222 #: ../fish/guestfish-actions.pod:468 ../fish/guestfish-actions.pod:478
7223 #: ../fish/guestfish-actions.pod:490 ../fish/guestfish-actions.pod:503
7224 #: ../fish/guestfish-actions.pod:511 ../fish/guestfish-actions.pod:522
7225 #: ../fish/guestfish-actions.pod:530 ../fish/guestfish-actions.pod:538
7226 msgid "This uses the L<blockdev(8)> command."
7230 #: ../src/guestfs-actions.pod:672 ../src/guestfs-actions.pod:689
7231 #: ../src/guestfs-actions.pod:704 ../src/guestfs-actions.pod:720
7232 #: ../src/guestfs-actions.pod:738 ../src/guestfs-actions.pod:757
7233 #: ../src/guestfs-actions.pod:771 ../src/guestfs-actions.pod:789
7234 #: ../src/guestfs-actions.pod:803 ../src/guestfs-actions.pod:817
7235 msgid "(Added in 0.9.3)"
7239 #: ../src/guestfs-actions.pod:674
7240 msgid "guestfs_blockdev_getbsz"
7244 #: ../src/guestfs-actions.pod:676
7248 " guestfs_blockdev_getbsz (guestfs_h *g,\n"
7249 " const char *device);\n"
7254 #: ../src/guestfs-actions.pod:680 ../fish/guestfish-actions.pod:454
7255 msgid "This returns the block size of a device."
7259 #: ../src/guestfs-actions.pod:682 ../src/guestfs-actions.pod:782
7260 #: ../fish/guestfish-actions.pod:456 ../fish/guestfish-actions.pod:519
7262 "(Note this is different from both I<size in blocks> and I<filesystem block "
7267 #: ../src/guestfs-actions.pod:691
7268 msgid "guestfs_blockdev_getro"
7272 #: ../src/guestfs-actions.pod:693
7276 " guestfs_blockdev_getro (guestfs_h *g,\n"
7277 " const char *device);\n"
7282 #: ../src/guestfs-actions.pod:697 ../fish/guestfish-actions.pod:465
7284 "Returns a boolean indicating if the block device is read-only (true if read-"
7285 "only, false if not)."
7289 #: ../src/guestfs-actions.pod:702 ../src/guestfs-actions.pod:1409
7290 #: ../src/guestfs-actions.pod:1424 ../src/guestfs-actions.pod:1914
7291 #: ../src/guestfs-actions.pod:1925 ../src/guestfs-actions.pod:1997
7292 #: ../src/guestfs-actions.pod:2052 ../src/guestfs-actions.pod:2067
7293 #: ../src/guestfs-actions.pod:2092 ../src/guestfs-actions.pod:2115
7294 #: ../src/guestfs-actions.pod:3088 ../src/guestfs-actions.pod:3105
7295 #: ../src/guestfs-actions.pod:3124 ../src/guestfs-actions.pod:3287
7296 #: ../src/guestfs-actions.pod:3301 ../src/guestfs-actions.pod:3316
7297 #: ../src/guestfs-actions.pod:3330 ../src/guestfs-actions.pod:3346
7298 #: ../src/guestfs-actions.pod:3361 ../src/guestfs-actions.pod:3377
7299 #: ../src/guestfs-actions.pod:3391 ../src/guestfs-actions.pod:3404
7300 #: ../src/guestfs-actions.pod:3418 ../src/guestfs-actions.pod:3433
7301 #: ../src/guestfs-actions.pod:3448 ../src/guestfs-actions.pod:4979
7302 msgid "This function returns a C truth value on success or -1 on error."
7306 #: ../src/guestfs-actions.pod:706
7307 msgid "guestfs_blockdev_getsize64"
7311 #: ../src/guestfs-actions.pod:708
7315 " guestfs_blockdev_getsize64 (guestfs_h *g,\n"
7316 " const char *device);\n"
7321 #: ../src/guestfs-actions.pod:712 ../fish/guestfish-actions.pod:474
7322 msgid "This returns the size of the device in bytes."
7326 #: ../src/guestfs-actions.pod:714
7327 msgid "See also C<guestfs_blockdev_getsz>."
7331 #: ../src/guestfs-actions.pod:722
7332 msgid "guestfs_blockdev_getss"
7336 #: ../src/guestfs-actions.pod:724
7340 " guestfs_blockdev_getss (guestfs_h *g,\n"
7341 " const char *device);\n"
7346 #: ../src/guestfs-actions.pod:728 ../fish/guestfish-actions.pod:484
7348 "This returns the size of sectors on a block device. Usually 512, but can be "
7349 "larger for modern devices."
7353 #: ../src/guestfs-actions.pod:731
7355 "(Note, this is not the size in sectors, use C<guestfs_blockdev_getsz> for "
7360 #: ../src/guestfs-actions.pod:740
7361 msgid "guestfs_blockdev_getsz"
7365 #: ../src/guestfs-actions.pod:742
7369 " guestfs_blockdev_getsz (guestfs_h *g,\n"
7370 " const char *device);\n"
7375 #: ../src/guestfs-actions.pod:746 ../fish/guestfish-actions.pod:496
7377 "This returns the size of the device in units of 512-byte sectors (even if "
7378 "the sectorsize isn't 512 bytes ... weird)."
7382 #: ../src/guestfs-actions.pod:749
7384 "See also C<guestfs_blockdev_getss> for the real sector size of the device, "
7385 "and C<guestfs_blockdev_getsize64> for the more useful I<size in bytes>."
7389 #: ../src/guestfs-actions.pod:759
7390 msgid "guestfs_blockdev_rereadpt"
7394 #: ../src/guestfs-actions.pod:761
7398 " guestfs_blockdev_rereadpt (guestfs_h *g,\n"
7399 " const char *device);\n"
7404 #: ../src/guestfs-actions.pod:765 ../fish/guestfish-actions.pod:509
7405 msgid "Reread the partition table on C<device>."
7409 #: ../src/guestfs-actions.pod:773
7410 msgid "guestfs_blockdev_setbsz"
7414 #: ../src/guestfs-actions.pod:775
7418 " guestfs_blockdev_setbsz (guestfs_h *g,\n"
7419 " const char *device,\n"
7420 " int blocksize);\n"
7425 #: ../src/guestfs-actions.pod:780 ../fish/guestfish-actions.pod:517
7426 msgid "This sets the block size of a device."
7430 #: ../src/guestfs-actions.pod:791
7431 msgid "guestfs_blockdev_setro"
7435 #: ../src/guestfs-actions.pod:793
7439 " guestfs_blockdev_setro (guestfs_h *g,\n"
7440 " const char *device);\n"
7445 #: ../src/guestfs-actions.pod:797 ../fish/guestfish-actions.pod:528
7446 msgid "Sets the block device named C<device> to read-only."
7450 #: ../src/guestfs-actions.pod:805
7451 msgid "guestfs_blockdev_setrw"
7455 #: ../src/guestfs-actions.pod:807
7459 " guestfs_blockdev_setrw (guestfs_h *g,\n"
7460 " const char *device);\n"
7465 #: ../src/guestfs-actions.pod:811 ../fish/guestfish-actions.pod:536
7466 msgid "Sets the block device named C<device> to read-write."
7470 #: ../src/guestfs-actions.pod:819
7471 msgid "guestfs_case_sensitive_path"
7475 #: ../src/guestfs-actions.pod:821
7479 " guestfs_case_sensitive_path (guestfs_h *g,\n"
7480 " const char *path);\n"
7485 #: ../src/guestfs-actions.pod:825 ../fish/guestfish-actions.pod:544
7487 "This can be used to resolve case insensitive paths on a filesystem which is "
7488 "case sensitive. The use case is to resolve paths which you have read from "
7489 "Windows configuration files or the Windows Registry, to the true path."
7493 #: ../src/guestfs-actions.pod:830 ../fish/guestfish-actions.pod:549
7495 "The command handles a peculiarity of the Linux ntfs-3g filesystem driver "
7496 "(and probably others), which is that although the underlying filesystem is "
7497 "case-insensitive, the driver exports the filesystem to Linux as case-"
7502 #: ../src/guestfs-actions.pod:835 ../fish/guestfish-actions.pod:554
7504 "One consequence of this is that special directories such as C<c:\\windows> "
7505 "may appear as C</WINDOWS> or C</windows> (or other things) depending on the "
7506 "precise details of how they were created. In Windows itself this would not "
7511 #: ../src/guestfs-actions.pod:841 ../fish/guestfish-actions.pod:560
7513 "Bug or feature? You decide: L<http://www.tuxera.com/community/ntfs-3g-faq/"
7518 #: ../src/guestfs-actions.pod:844 ../fish/guestfish-actions.pod:563
7520 "This function resolves the true case of each element in the path and returns "
7521 "the case-sensitive path."
7525 #: ../src/guestfs-actions.pod:847
7527 "Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\") might return C<"
7528 "\"/WINDOWS/system32\"> (the exact return value would depend on details of "
7529 "how the directories were originally created under Windows)."
7533 #: ../src/guestfs-actions.pod:852 ../fish/guestfish-actions.pod:571
7534 msgid "I<Note>: This function does not handle drive names, backslashes etc."
7538 #: ../src/guestfs-actions.pod:855
7539 msgid "See also C<guestfs_realpath>."
7543 #: ../src/guestfs-actions.pod:860 ../src/guestfs-actions.pod:6970
7544 msgid "(Added in 1.0.75)"
7548 #: ../src/guestfs-actions.pod:862
7553 #: ../src/guestfs-actions.pod:864
7557 " guestfs_cat (guestfs_h *g,\n"
7558 " const char *path);\n"
7563 #: ../src/guestfs-actions.pod:868 ../src/guestfs-actions.pod:5466
7564 #: ../fish/guestfish-actions.pod:580 ../fish/guestfish-actions.pod:3667
7565 msgid "Return the contents of the file named C<path>."
7569 #: ../src/guestfs-actions.pod:870
7571 "Note that this function cannot correctly handle binary files (specifically, "
7572 "files containing C<\\0> character which is treated as end of string). For "
7573 "those you need to use the C<guestfs_read_file> or C<guestfs_download> "
7574 "functions which have a more complex interface."
7578 #: ../src/guestfs-actions.pod:878 ../src/guestfs-actions.pod:1057
7579 #: ../src/guestfs-actions.pod:1077 ../src/guestfs-actions.pod:1373
7580 #: ../src/guestfs-actions.pod:1392 ../src/guestfs-actions.pod:1495
7581 #: ../src/guestfs-actions.pod:1514 ../src/guestfs-actions.pod:1763
7582 #: ../src/guestfs-actions.pod:2221 ../src/guestfs-actions.pod:2240
7583 #: ../src/guestfs-actions.pod:2283 ../src/guestfs-actions.pod:2307
7584 #: ../src/guestfs-actions.pod:2324 ../src/guestfs-actions.pod:2353
7585 #: ../src/guestfs-actions.pod:5248 ../src/guestfs-actions.pod:5274
7586 #: ../src/guestfs-actions.pod:5405 ../src/guestfs-actions.pod:5431
7587 #: ../src/guestfs-actions.pod:5455 ../src/guestfs-actions.pod:6355
7588 #: ../src/guestfs-actions.pod:6410 ../src/guestfs-actions.pod:6556
7589 #: ../src/guestfs-actions.pod:6580 ../src/guestfs-actions.pod:7242
7590 #: ../src/guestfs-actions.pod:7268 ../src/guestfs-actions.pod:7294
7591 #: ../src/guestfs-actions.pod:7313 ../src/guestfs-actions.pod:7398
7592 #: ../src/guestfs-actions.pod:7417 ../src/guestfs-actions.pod:7463
7593 #: ../src/guestfs-actions.pod:7482 ../fish/guestfish-actions.pod:587
7594 #: ../fish/guestfish-actions.pod:722 ../fish/guestfish-actions.pod:734
7595 #: ../fish/guestfish-actions.pod:910 ../fish/guestfish-actions.pod:920
7596 #: ../fish/guestfish-actions.pod:987 ../fish/guestfish-actions.pod:997
7597 #: ../fish/guestfish-actions.pod:1192 ../fish/guestfish-actions.pod:1493
7598 #: ../fish/guestfish-actions.pod:1503 ../fish/guestfish-actions.pod:1531
7599 #: ../fish/guestfish-actions.pod:1546 ../fish/guestfish-actions.pod:1556
7600 #: ../fish/guestfish-actions.pod:1575 ../fish/guestfish-actions.pod:3537
7601 #: ../fish/guestfish-actions.pod:3552 ../fish/guestfish-actions.pod:3628
7602 #: ../fish/guestfish-actions.pod:3645 ../fish/guestfish-actions.pod:3660
7603 #: ../fish/guestfish-actions.pod:4286 ../fish/guestfish-actions.pod:4332
7604 #: ../fish/guestfish-actions.pod:4417 ../fish/guestfish-actions.pod:4432
7605 #: ../fish/guestfish-actions.pod:4842 ../fish/guestfish-actions.pod:4860
7606 #: ../fish/guestfish-actions.pod:4877 ../fish/guestfish-actions.pod:4887
7607 #: ../fish/guestfish-actions.pod:4935 ../fish/guestfish-actions.pod:4945
7608 #: ../fish/guestfish-actions.pod:4974 ../fish/guestfish-actions.pod:4984
7610 "Because of the message protocol, there is a transfer limit of somewhere "
7611 "between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
7615 #: ../src/guestfs-actions.pod:881 ../src/guestfs-actions.pod:3564
7616 #: ../src/guestfs-actions.pod:3626 ../src/guestfs-actions.pod:3643
7617 #: ../src/guestfs-actions.pod:3731 ../src/guestfs-actions.pod:4136
7618 #: ../src/guestfs-actions.pod:4150 ../src/guestfs-actions.pod:5354
7619 #: ../src/guestfs-actions.pod:5368 ../src/guestfs-actions.pod:7129
7620 #: ../src/guestfs-actions.pod:7143
7621 msgid "(Added in 0.4)"
7625 #: ../src/guestfs-actions.pod:883
7626 msgid "guestfs_checksum"
7630 #: ../src/guestfs-actions.pod:885
7634 " guestfs_checksum (guestfs_h *g,\n"
7635 " const char *csumtype,\n"
7636 " const char *path);\n"
7641 #: ../src/guestfs-actions.pod:890 ../fish/guestfish-actions.pod:594
7643 "This call computes the MD5, SHAx or CRC checksum of the file named C<path>."
7647 #: ../src/guestfs-actions.pod:893 ../fish/guestfish-actions.pod:597
7649 "The type of checksum to compute is given by the C<csumtype> parameter which "
7650 "must have one of the following values:"
7654 #: ../src/guestfs-actions.pod:898 ../fish/guestfish-actions.pod:602
7659 #: ../src/guestfs-actions.pod:900 ../fish/guestfish-actions.pod:604
7661 "Compute the cyclic redundancy check (CRC) specified by POSIX for the "
7666 #: ../src/guestfs-actions.pod:903 ../fish/guestfish-actions.pod:607
7671 #: ../src/guestfs-actions.pod:905 ../fish/guestfish-actions.pod:609
7672 msgid "Compute the MD5 hash (using the C<md5sum> program)."
7676 #: ../src/guestfs-actions.pod:907 ../fish/guestfish-actions.pod:611
7681 #: ../src/guestfs-actions.pod:909 ../fish/guestfish-actions.pod:613
7682 msgid "Compute the SHA1 hash (using the C<sha1sum> program)."
7686 #: ../src/guestfs-actions.pod:911 ../fish/guestfish-actions.pod:615
7691 #: ../src/guestfs-actions.pod:913 ../fish/guestfish-actions.pod:617
7692 msgid "Compute the SHA224 hash (using the C<sha224sum> program)."
7696 #: ../src/guestfs-actions.pod:915 ../fish/guestfish-actions.pod:619
7701 #: ../src/guestfs-actions.pod:917 ../fish/guestfish-actions.pod:621
7702 msgid "Compute the SHA256 hash (using the C<sha256sum> program)."
7706 #: ../src/guestfs-actions.pod:919 ../fish/guestfish-actions.pod:623
7711 #: ../src/guestfs-actions.pod:921 ../fish/guestfish-actions.pod:625
7712 msgid "Compute the SHA384 hash (using the C<sha384sum> program)."
7716 #: ../src/guestfs-actions.pod:923 ../fish/guestfish-actions.pod:627
7721 #: ../src/guestfs-actions.pod:925 ../fish/guestfish-actions.pod:629
7722 msgid "Compute the SHA512 hash (using the C<sha512sum> program)."
7726 #: ../src/guestfs-actions.pod:929 ../fish/guestfish-actions.pod:633
7727 msgid "The checksum is returned as a printable string."
7731 #: ../src/guestfs-actions.pod:931
7732 msgid "To get the checksum for a device, use C<guestfs_checksum_device>."
7736 #: ../src/guestfs-actions.pod:933
7737 msgid "To get the checksums for many files, use C<guestfs_checksums_out>."
7741 #: ../src/guestfs-actions.pod:938 ../src/guestfs-actions.pod:1246
7742 #: ../src/guestfs-actions.pod:2083 ../src/guestfs-actions.pod:3303
7743 #: ../src/guestfs-actions.pod:3332 ../src/guestfs-actions.pod:3393
7744 #: ../src/guestfs-actions.pod:3420 ../src/guestfs-actions.pod:6826
7745 msgid "(Added in 1.0.2)"
7749 #: ../src/guestfs-actions.pod:940
7750 msgid "guestfs_checksum_device"
7754 #: ../src/guestfs-actions.pod:942
7758 " guestfs_checksum_device (guestfs_h *g,\n"
7759 " const char *csumtype,\n"
7760 " const char *device);\n"
7765 #: ../src/guestfs-actions.pod:947
7767 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
7768 "device named C<device>. For the types of checksums supported see the "
7769 "C<guestfs_checksum> command."
7773 #: ../src/guestfs-actions.pod:954 ../src/guestfs-actions.pod:4885
7774 #: ../src/guestfs-actions.pod:4944 ../src/guestfs-actions.pod:4981
7775 #: ../src/guestfs-actions.pod:4999 ../src/guestfs-actions.pod:5175
7776 #: ../src/guestfs-actions.pod:6735 ../src/guestfs-actions.pod:6749
7777 #: ../src/guestfs-actions.pod:7155
7778 msgid "(Added in 1.3.2)"
7782 #: ../src/guestfs-actions.pod:956
7783 msgid "guestfs_checksums_out"
7787 #: ../src/guestfs-actions.pod:958
7791 " guestfs_checksums_out (guestfs_h *g,\n"
7792 " const char *csumtype,\n"
7793 " const char *directory,\n"
7794 " const char *sumsfile);\n"
7799 #: ../src/guestfs-actions.pod:964 ../fish/guestfish-actions.pod:651
7801 "This command computes the checksums of all regular files in C<directory> and "
7802 "then emits a list of those checksums to the local output file C<sumsfile>."
7806 #: ../src/guestfs-actions.pod:968 ../fish/guestfish-actions.pod:655
7808 "This can be used for verifying the integrity of a virtual machine. However "
7809 "to be properly secure you should pay attention to the output of the checksum "
7810 "command (it uses the ones from GNU coreutils). In particular when the "
7811 "filename is not printable, coreutils uses a special backslash syntax. For "
7812 "more information, see the GNU coreutils info file."
7816 #: ../src/guestfs-actions.pod:978
7817 msgid "(Added in 1.3.7)"
7821 #: ../src/guestfs-actions.pod:980
7822 msgid "guestfs_chmod"
7826 #: ../src/guestfs-actions.pod:982
7830 " guestfs_chmod (guestfs_h *g,\n"
7832 " const char *path);\n"
7837 #: ../src/guestfs-actions.pod:987 ../fish/guestfish-actions.pod:669
7839 "Change the mode (permissions) of C<path> to C<mode>. Only numeric modes are "
7844 #: ../src/guestfs-actions.pod:990 ../fish/guestfish-actions.pod:672
7846 "I<Note>: When using this command from guestfish, C<mode> by default would be "
7847 "decimal, unless you prefix it with C<0> to get octal, ie. use C<0700> not "
7852 #: ../src/guestfs-actions.pod:994 ../src/guestfs-actions.pod:4387
7853 #: ../src/guestfs-actions.pod:4584 ../src/guestfs-actions.pod:4603
7854 #: ../src/guestfs-actions.pod:4622 ../fish/guestfish-actions.pod:676
7855 #: ../fish/guestfish-actions.pod:2983 ../fish/guestfish-actions.pod:3112
7856 #: ../fish/guestfish-actions.pod:3122 ../fish/guestfish-actions.pod:3132
7857 msgid "The mode actually set is affected by the umask."
7861 #: ../src/guestfs-actions.pod:1000
7862 msgid "guestfs_chown"
7866 #: ../src/guestfs-actions.pod:1002
7870 " guestfs_chown (guestfs_h *g,\n"
7873 " const char *path);\n"
7878 #: ../src/guestfs-actions.pod:1008 ../fish/guestfish-actions.pod:682
7879 msgid "Change the file owner to C<owner> and group to C<group>."
7883 #: ../src/guestfs-actions.pod:1010 ../src/guestfs-actions.pod:3495
7884 #: ../fish/guestfish-actions.pod:684 ../fish/guestfish-actions.pod:2441
7886 "Only numeric uid and gid are supported. If you want to use names, you will "
7887 "need to locate and parse the password file yourself (Augeas support makes "
7888 "this relatively easy)."
7892 #: ../src/guestfs-actions.pod:1018
7893 msgid "guestfs_command"
7897 #: ../src/guestfs-actions.pod:1020
7901 " guestfs_command (guestfs_h *g,\n"
7902 " char *const *arguments);\n"
7907 #: ../src/guestfs-actions.pod:1024 ../fish/guestfish-actions.pod:692
7909 "This call runs a command from the guest filesystem. The filesystem must be "
7910 "mounted, and must contain a compatible operating system (ie. something "
7911 "Linux, with the same or compatible processor architecture)."
7915 #: ../src/guestfs-actions.pod:1029
7917 "The single parameter is an argv-style list of arguments. The first element "
7918 "is the name of the program to run. Subsequent elements are parameters. The "
7919 "list must be non-empty (ie. must contain a program name). Note that the "
7920 "command runs directly, and is I<not> invoked via the shell (see "
7925 #: ../src/guestfs-actions.pod:1036 ../fish/guestfish-actions.pod:704
7926 msgid "The return value is anything printed to I<stdout> by the command."
7930 #: ../src/guestfs-actions.pod:1039 ../fish/guestfish-actions.pod:707
7932 "If the command returns a non-zero exit status, then this function returns an "
7933 "error message. The error message string is the content of I<stderr> from "
7938 #: ../src/guestfs-actions.pod:1043 ../fish/guestfish-actions.pod:711
7940 "The C<$PATH> environment variable will contain at least C</usr/bin> and C</"
7941 "bin>. If you require a program from another location, you should provide "
7942 "the full path in the first parameter."
7946 #: ../src/guestfs-actions.pod:1048 ../fish/guestfish-actions.pod:716
7948 "Shared libraries and data files required by the program must be available on "
7949 "filesystems which are mounted in the correct places. It is the caller's "
7950 "responsibility to ensure all filesystems that are needed are mounted at the "
7955 #: ../src/guestfs-actions.pod:1060 ../src/guestfs-actions.pod:1080
7956 #: ../src/guestfs-actions.pod:1548
7957 msgid "(Added in 0.9.1)"
7961 #: ../src/guestfs-actions.pod:1062
7962 msgid "guestfs_command_lines"
7966 #: ../src/guestfs-actions.pod:1064
7970 " guestfs_command_lines (guestfs_h *g,\n"
7971 " char *const *arguments);\n"
7976 #: ../src/guestfs-actions.pod:1068
7978 "This is the same as C<guestfs_command>, but splits the result into a list of "
7983 #: ../src/guestfs-actions.pod:1071
7984 msgid "See also: C<guestfs_sh_lines>"
7988 #: ../src/guestfs-actions.pod:1082
7989 msgid "guestfs_config"
7993 #: ../src/guestfs-actions.pod:1084
7997 " guestfs_config (guestfs_h *g,\n"
7998 " const char *qemuparam,\n"
7999 " const char *qemuvalue);\n"
8004 #: ../src/guestfs-actions.pod:1089 ../fish/guestfish-actions.pod:741
8006 "This can be used to add arbitrary qemu command line parameters of the form "
8007 "I<-param value>. Actually it's not quite arbitrary - we prevent you from "
8008 "setting some parameters which would interfere with parameters that we use."
8012 #: ../src/guestfs-actions.pod:1094 ../fish/guestfish-actions.pod:746
8013 msgid "The first character of C<param> string must be a C<-> (dash)."
8017 #: ../src/guestfs-actions.pod:1096 ../fish/guestfish-actions.pod:748
8018 msgid "C<value> can be NULL."
8022 #: ../src/guestfs-actions.pod:1102
8023 msgid "guestfs_copy_size"
8027 #: ../src/guestfs-actions.pod:1104
8031 " guestfs_copy_size (guestfs_h *g,\n"
8032 " const char *src,\n"
8033 " const char *dest,\n"
8039 #: ../src/guestfs-actions.pod:1110 ../fish/guestfish-actions.pod:754
8041 "This command copies exactly C<size> bytes from one source device or file "
8042 "C<src> to another destination device or file C<dest>."
8046 #: ../src/guestfs-actions.pod:1113 ../fish/guestfish-actions.pod:757
8048 "Note this will fail if the source is too short or if the destination is not "
8053 #: ../src/guestfs-actions.pod:1118 ../src/guestfs-actions.pod:1241
8054 #: ../src/guestfs-actions.pod:1272 ../src/guestfs-actions.pod:1317
8055 #: ../src/guestfs-actions.pod:1697 ../src/guestfs-actions.pod:1719
8056 #: ../src/guestfs-actions.pod:3476 ../src/guestfs-actions.pod:6821
8057 #: ../src/guestfs-actions.pod:6855 ../src/guestfs-actions.pod:7334
8058 #: ../src/guestfs-actions.pod:7353
8060 "This long-running command can generate progress notification messages so "
8061 "that the caller can display a progress bar or indicator. To receive these "
8062 "messages, the caller must register a progress event callback. See L<guestfs"
8063 "(3)/GUESTFS_EVENT_PROGRESS>."
8067 #: ../src/guestfs-actions.pod:1123 ../src/guestfs-actions.pod:4163
8068 #: ../src/guestfs-actions.pod:5381 ../src/guestfs-actions.pod:7062
8069 #: ../src/guestfs-actions.pod:7082 ../src/guestfs-actions.pod:7168
8070 msgid "(Added in 1.0.87)"
8074 #: ../src/guestfs-actions.pod:1125
8079 #: ../src/guestfs-actions.pod:1127
8083 " guestfs_cp (guestfs_h *g,\n"
8084 " const char *src,\n"
8085 " const char *dest);\n"
8090 #: ../src/guestfs-actions.pod:1132 ../fish/guestfish-actions.pod:764
8092 "This copies a file from C<src> to C<dest> where C<dest> is either a "
8093 "destination filename or destination directory."
8097 #: ../src/guestfs-actions.pod:1137 ../src/guestfs-actions.pod:1151
8098 #: ../src/guestfs-actions.pod:1223 ../src/guestfs-actions.pod:1297
8099 #: ../src/guestfs-actions.pod:1411 ../src/guestfs-actions.pod:4848
8100 #: ../src/guestfs-actions.pod:5225
8101 msgid "(Added in 1.0.18)"
8105 #: ../src/guestfs-actions.pod:1139
8106 msgid "guestfs_cp_a"
8110 #: ../src/guestfs-actions.pod:1141
8114 " guestfs_cp_a (guestfs_h *g,\n"
8115 " const char *src,\n"
8116 " const char *dest);\n"
8121 #: ../src/guestfs-actions.pod:1146 ../fish/guestfish-actions.pod:771
8123 "This copies a file or directory from C<src> to C<dest> recursively using the "
8128 #: ../src/guestfs-actions.pod:1153
8133 #: ../src/guestfs-actions.pod:1155
8137 " guestfs_dd (guestfs_h *g,\n"
8138 " const char *src,\n"
8139 " const char *dest);\n"
8144 #: ../src/guestfs-actions.pod:1160 ../fish/guestfish-actions.pod:778
8146 "This command copies from one source device or file C<src> to another "
8147 "destination device or file C<dest>. Normally you would use this to copy to "
8148 "or from a device or partition, for example to duplicate a filesystem."
8152 #: ../src/guestfs-actions.pod:1165
8154 "If the destination is a device, it must be as large or larger than the "
8155 "source file or device, otherwise the copy will fail. This command cannot do "
8156 "partial copies (see C<guestfs_copy_size>)."
8160 #: ../src/guestfs-actions.pod:1173
8165 #: ../src/guestfs-actions.pod:1175
8169 " guestfs_df (guestfs_h *g);\n"
8174 #: ../src/guestfs-actions.pod:1178 ../fish/guestfish-actions.pod:791
8175 msgid "This command runs the C<df> command to report disk space used."
8179 #: ../src/guestfs-actions.pod:1180 ../src/guestfs-actions.pod:1197
8181 "This command is mostly useful for interactive sessions. It is I<not> "
8182 "intended that you try to parse the output string. Use C<guestfs_statvfs> "
8187 #: ../src/guestfs-actions.pod:1187 ../src/guestfs-actions.pod:1204
8188 #: ../src/guestfs-actions.pod:1322 ../src/guestfs-actions.pod:2286
8189 #: ../src/guestfs-actions.pod:2310 ../src/guestfs-actions.pod:2378
8190 #: ../src/guestfs-actions.pod:4273 ../src/guestfs-actions.pod:4748
8191 #: ../src/guestfs-actions.pod:6559 ../src/guestfs-actions.pod:6583
8192 #: ../src/guestfs-actions.pod:7201 ../src/guestfs-actions.pod:7214
8193 #: ../src/guestfs-actions.pod:7227
8194 msgid "(Added in 1.0.54)"
8198 #: ../src/guestfs-actions.pod:1189
8199 msgid "guestfs_df_h"
8203 #: ../src/guestfs-actions.pod:1191
8207 " guestfs_df_h (guestfs_h *g);\n"
8212 #: ../src/guestfs-actions.pod:1194 ../fish/guestfish-actions.pod:801
8214 "This command runs the C<df -h> command to report disk space used in human-"
8219 #: ../src/guestfs-actions.pod:1206
8220 msgid "guestfs_dmesg"
8224 #: ../src/guestfs-actions.pod:1208
8228 " guestfs_dmesg (guestfs_h *g);\n"
8233 #: ../src/guestfs-actions.pod:1211 ../fish/guestfish-actions.pod:812
8235 "This returns the kernel messages (C<dmesg> output) from the guest kernel. "
8236 "This is sometimes useful for extended debugging of problems."
8240 #: ../src/guestfs-actions.pod:1215
8242 "Another way to get the same information is to enable verbose messages with "
8243 "C<guestfs_set_verbose> or by setting the environment variable "
8244 "C<LIBGUESTFS_DEBUG=1> before running the program."
8248 #: ../src/guestfs-actions.pod:1225
8249 msgid "guestfs_download"
8253 #: ../src/guestfs-actions.pod:1227
8257 " guestfs_download (guestfs_h *g,\n"
8258 " const char *remotefilename,\n"
8259 " const char *filename);\n"
8264 #: ../src/guestfs-actions.pod:1232 ../src/guestfs-actions.pod:1257
8265 #: ../fish/guestfish-actions.pod:825 ../fish/guestfish-actions.pod:838
8267 "Download file C<remotefilename> and save it as C<filename> on the local "
8272 #: ../src/guestfs-actions.pod:1235 ../src/guestfs-actions.pod:6815
8273 #: ../fish/guestfish-actions.pod:828 ../fish/guestfish-actions.pod:4590
8274 msgid "C<filename> can also be a named pipe."
8278 #: ../src/guestfs-actions.pod:1237
8279 msgid "See also C<guestfs_upload>, C<guestfs_cat>."
8283 #: ../src/guestfs-actions.pod:1248
8284 msgid "guestfs_download_offset"
8288 #: ../src/guestfs-actions.pod:1250
8292 " guestfs_download_offset (guestfs_h *g,\n"
8293 " const char *remotefilename,\n"
8294 " const char *filename,\n"
8295 " int64_t offset,\n"
8301 #: ../src/guestfs-actions.pod:1260 ../fish/guestfish-actions.pod:841
8303 "C<remotefilename> is read for C<size> bytes starting at C<offset> (this "
8304 "region must be within the file or device)."
8308 #: ../src/guestfs-actions.pod:1263
8310 "Note that there is no limit on the amount of data that can be downloaded "
8311 "with this call, unlike with C<guestfs_pread>, and this call always reads the "
8312 "full amount unless an error occurs."
8316 #: ../src/guestfs-actions.pod:1268
8317 msgid "See also C<guestfs_download>, C<guestfs_pread>."
8321 #: ../src/guestfs-actions.pod:1277 ../src/guestfs-actions.pod:6860
8322 msgid "(Added in 1.5.17)"
8326 #: ../src/guestfs-actions.pod:1279
8327 msgid "guestfs_drop_caches"
8331 #: ../src/guestfs-actions.pod:1281
8335 " guestfs_drop_caches (guestfs_h *g,\n"
8336 " int whattodrop);\n"
8341 #: ../src/guestfs-actions.pod:1285 ../fish/guestfish-actions.pod:857
8343 "This instructs the guest kernel to drop its page cache, and/or dentries and "
8344 "inode caches. The parameter C<whattodrop> tells the kernel what precisely "
8345 "to drop, see L<http://linux-mm.org/Drop_Caches>"
8349 #: ../src/guestfs-actions.pod:1290 ../fish/guestfish-actions.pod:862
8350 msgid "Setting C<whattodrop> to 3 should drop everything."
8354 #: ../src/guestfs-actions.pod:1292 ../fish/guestfish-actions.pod:864
8356 "This automatically calls L<sync(2)> before the operation, so that the "
8357 "maximum guest memory is freed."
8361 #: ../src/guestfs-actions.pod:1299
8366 #: ../src/guestfs-actions.pod:1301
8370 " guestfs_du (guestfs_h *g,\n"
8371 " const char *path);\n"
8376 #: ../src/guestfs-actions.pod:1305 ../fish/guestfish-actions.pod:871
8378 "This command runs the C<du -s> command to estimate file space usage for "
8383 #: ../src/guestfs-actions.pod:1308 ../fish/guestfish-actions.pod:874
8385 "C<path> can be a file or a directory. If C<path> is a directory then the "
8386 "estimate includes the contents of the directory and all subdirectories "
8391 #: ../src/guestfs-actions.pod:1312 ../fish/guestfish-actions.pod:878
8393 "The result is the estimated size in I<kilobytes> (ie. units of 1024 bytes)."
8397 #: ../src/guestfs-actions.pod:1324
8398 msgid "guestfs_e2fsck_f"
8402 #: ../src/guestfs-actions.pod:1326
8406 " guestfs_e2fsck_f (guestfs_h *g,\n"
8407 " const char *device);\n"
8412 #: ../src/guestfs-actions.pod:1330 ../fish/guestfish-actions.pod:885
8414 "This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3 filesystem checker "
8415 "on C<device>, noninteractively (I<-p>), even if the filesystem appears to be "
8420 #: ../src/guestfs-actions.pod:1334
8422 "This command is only needed because of C<guestfs_resize2fs> (q.v.). "
8423 "Normally you should use C<guestfs_fsck>."
8427 #: ../src/guestfs-actions.pod:1339
8428 msgid "(Added in 1.0.29)"
8432 #: ../src/guestfs-actions.pod:1341
8433 msgid "guestfs_echo_daemon"
8437 #: ../src/guestfs-actions.pod:1343
8441 " guestfs_echo_daemon (guestfs_h *g,\n"
8442 " char *const *words);\n"
8447 #: ../src/guestfs-actions.pod:1347 ../fish/guestfish-actions.pod:896
8449 "This command concatenates the list of C<words> passed with single spaces "
8450 "between them and returns the resulting string."
8454 #: ../src/guestfs-actions.pod:1350 ../fish/guestfish-actions.pod:899
8455 msgid "You can use this command to test the connection through to the daemon."
8459 #: ../src/guestfs-actions.pod:1352
8460 msgid "See also C<guestfs_ping_daemon>."
8464 #: ../src/guestfs-actions.pod:1357 ../src/guestfs-actions.pod:2094
8465 #: ../src/guestfs-actions.pod:6059
8466 msgid "(Added in 1.0.69)"
8470 #: ../src/guestfs-actions.pod:1359
8471 msgid "guestfs_egrep"
8475 #: ../src/guestfs-actions.pod:1361
8479 " guestfs_egrep (guestfs_h *g,\n"
8480 " const char *regex,\n"
8481 " const char *path);\n"
8486 #: ../src/guestfs-actions.pod:1366 ../fish/guestfish-actions.pod:907
8488 "This calls the external C<egrep> program and returns the matching lines."
8492 #: ../src/guestfs-actions.pod:1376 ../src/guestfs-actions.pod:1395
8493 #: ../src/guestfs-actions.pod:1452 ../src/guestfs-actions.pod:1498
8494 #: ../src/guestfs-actions.pod:1517 ../src/guestfs-actions.pod:2224
8495 #: ../src/guestfs-actions.pod:2243 ../src/guestfs-actions.pod:2399
8496 #: ../src/guestfs-actions.pod:2412 ../src/guestfs-actions.pod:2427
8497 #: ../src/guestfs-actions.pod:2473 ../src/guestfs-actions.pod:2495
8498 #: ../src/guestfs-actions.pod:2508 ../src/guestfs-actions.pod:3656
8499 #: ../src/guestfs-actions.pod:3670 ../src/guestfs-actions.pod:3683
8500 #: ../src/guestfs-actions.pod:3697 ../src/guestfs-actions.pod:4683
8501 #: ../src/guestfs-actions.pod:5559 ../src/guestfs-actions.pod:5608
8502 #: ../src/guestfs-actions.pod:6427 ../src/guestfs-actions.pod:6439
8503 #: ../src/guestfs-actions.pod:6452 ../src/guestfs-actions.pod:6465
8504 #: ../src/guestfs-actions.pod:6487 ../src/guestfs-actions.pod:6500
8505 #: ../src/guestfs-actions.pod:6513 ../src/guestfs-actions.pod:6526
8506 #: ../src/guestfs-actions.pod:7297 ../src/guestfs-actions.pod:7316
8507 #: ../src/guestfs-actions.pod:7401 ../src/guestfs-actions.pod:7420
8508 #: ../src/guestfs-actions.pod:7466 ../src/guestfs-actions.pod:7485
8509 msgid "(Added in 1.0.66)"
8513 #: ../src/guestfs-actions.pod:1378
8514 msgid "guestfs_egrepi"
8518 #: ../src/guestfs-actions.pod:1380
8522 " guestfs_egrepi (guestfs_h *g,\n"
8523 " const char *regex,\n"
8524 " const char *path);\n"
8529 #: ../src/guestfs-actions.pod:1385 ../fish/guestfish-actions.pod:917
8531 "This calls the external C<egrep -i> program and returns the matching lines."
8535 #: ../src/guestfs-actions.pod:1397
8536 msgid "guestfs_equal"
8540 #: ../src/guestfs-actions.pod:1399
8544 " guestfs_equal (guestfs_h *g,\n"
8545 " const char *file1,\n"
8546 " const char *file2);\n"
8551 #: ../src/guestfs-actions.pod:1404 ../fish/guestfish-actions.pod:927
8553 "This compares the two files C<file1> and C<file2> and returns true if their "
8554 "content is exactly equal, or false otherwise."
8558 #: ../src/guestfs-actions.pod:1407 ../fish/guestfish-actions.pod:930
8559 msgid "The external L<cmp(1)> program is used for the comparison."
8563 #: ../src/guestfs-actions.pod:1413
8564 msgid "guestfs_exists"
8568 #: ../src/guestfs-actions.pod:1415
8572 " guestfs_exists (guestfs_h *g,\n"
8573 " const char *path);\n"
8578 #: ../src/guestfs-actions.pod:1419 ../fish/guestfish-actions.pod:936
8580 "This returns C<true> if and only if there is a file, directory (or anything) "
8581 "with the given C<path> name."
8585 #: ../src/guestfs-actions.pod:1422
8586 msgid "See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>."
8590 #: ../src/guestfs-actions.pod:1428
8591 msgid "guestfs_fallocate"
8595 #: ../src/guestfs-actions.pod:1430
8599 " guestfs_fallocate (guestfs_h *g,\n"
8600 " const char *path,\n"
8606 #: ../src/guestfs-actions.pod:1435 ../src/guestfs-actions.pod:1461
8607 #: ../fish/guestfish-actions.pod:945 ../fish/guestfish-actions.pod:964
8609 "This command preallocates a file (containing zero bytes) named C<path> of "
8610 "size C<len> bytes. If the file exists already, it is overwritten."
8614 #: ../src/guestfs-actions.pod:1439 ../fish/guestfish-actions.pod:949
8616 "Do not confuse this with the guestfish-specific C<alloc> command which "
8617 "allocates a file in the host and attaches it as a device."
8621 #: ../src/guestfs-actions.pod:1445 ../fish/guestfish-actions.pod:953
8623 "This function is deprecated. In new code, use the C<fallocate64> call "
8628 #: ../src/guestfs-actions.pod:1454
8629 msgid "guestfs_fallocate64"
8633 #: ../src/guestfs-actions.pod:1456
8637 " guestfs_fallocate64 (guestfs_h *g,\n"
8638 " const char *path,\n"
8644 #: ../src/guestfs-actions.pod:1465
8646 "Note that this call allocates disk blocks for the file. To create a sparse "
8647 "file use C<guestfs_truncate_size> instead."
8651 #: ../src/guestfs-actions.pod:1468
8653 "The deprecated call C<guestfs_fallocate> does the same, but owing to an "
8654 "oversight it only allowed 30 bit lengths to be specified, effectively "
8655 "limiting the maximum size of files created through that call to 1GB."
8659 #: ../src/guestfs-actions.pod:1473 ../fish/guestfish-actions.pod:976
8661 "Do not confuse this with the guestfish-specific C<alloc> and C<sparse> "
8662 "commands which create a file in the host and attach it as a device."
8666 #: ../src/guestfs-actions.pod:1479
8667 msgid "(Added in 1.3.17)"
8671 #: ../src/guestfs-actions.pod:1481
8672 msgid "guestfs_fgrep"
8676 #: ../src/guestfs-actions.pod:1483
8680 " guestfs_fgrep (guestfs_h *g,\n"
8681 " const char *pattern,\n"
8682 " const char *path);\n"
8687 #: ../src/guestfs-actions.pod:1488 ../fish/guestfish-actions.pod:984
8689 "This calls the external C<fgrep> program and returns the matching lines."
8693 #: ../src/guestfs-actions.pod:1500
8694 msgid "guestfs_fgrepi"
8698 #: ../src/guestfs-actions.pod:1502
8702 " guestfs_fgrepi (guestfs_h *g,\n"
8703 " const char *pattern,\n"
8704 " const char *path);\n"
8709 #: ../src/guestfs-actions.pod:1507 ../fish/guestfish-actions.pod:994
8711 "This calls the external C<fgrep -i> program and returns the matching lines."
8715 #: ../src/guestfs-actions.pod:1519
8716 msgid "guestfs_file"
8720 #: ../src/guestfs-actions.pod:1521
8724 " guestfs_file (guestfs_h *g,\n"
8725 " const char *path);\n"
8730 #: ../src/guestfs-actions.pod:1525 ../fish/guestfish-actions.pod:1004
8732 "This call uses the standard L<file(1)> command to determine the type or "
8733 "contents of the file."
8737 #: ../src/guestfs-actions.pod:1528 ../fish/guestfish-actions.pod:1007
8739 "This call will also transparently look inside various types of compressed "
8744 #: ../src/guestfs-actions.pod:1531 ../fish/guestfish-actions.pod:1010
8746 "The exact command which runs is C<file -zb path>. Note in particular that "
8747 "the filename is not prepended to the output (the I<-b> option)."
8751 #: ../src/guestfs-actions.pod:1535
8753 "This command can also be used on C</dev/> devices (and partitions, LV "
8754 "names). You can for example use this to determine if a device contains a "
8755 "filesystem, although it's usually better to use C<guestfs_vfs_type>."
8759 #: ../src/guestfs-actions.pod:1540 ../fish/guestfish-actions.pod:1019
8761 "If the C<path> does not begin with C</dev/> then this command only works for "
8762 "the content of regular files. For other file types (directory, symbolic "
8763 "link etc) it will just return the string C<directory> etc."
8767 #: ../src/guestfs-actions.pod:1550
8768 msgid "guestfs_file_architecture"
8772 #: ../src/guestfs-actions.pod:1552
8776 " guestfs_file_architecture (guestfs_h *g,\n"
8777 " const char *filename);\n"
8782 #: ../src/guestfs-actions.pod:1556 ../fish/guestfish-actions.pod:1028
8784 "This detects the architecture of the binary C<filename>, and returns it if "
8789 #: ../src/guestfs-actions.pod:1559 ../fish/guestfish-actions.pod:1031
8790 msgid "Currently defined architectures are:"
8794 #: ../src/guestfs-actions.pod:1563 ../fish/guestfish-actions.pod:1035
8799 #: ../src/guestfs-actions.pod:1565 ../fish/guestfish-actions.pod:1037
8801 "This string is returned for all 32 bit i386, i486, i586, i686 binaries "
8802 "irrespective of the precise processor requirements of the binary."
8806 #: ../src/guestfs-actions.pod:1568 ../fish/guestfish-actions.pod:1040
8811 #: ../src/guestfs-actions.pod:1570 ../fish/guestfish-actions.pod:1042
8812 msgid "64 bit x86-64."
8816 #: ../src/guestfs-actions.pod:1572 ../fish/guestfish-actions.pod:1044
8821 #: ../src/guestfs-actions.pod:1574 ../fish/guestfish-actions.pod:1046
8822 msgid "32 bit SPARC."
8826 #: ../src/guestfs-actions.pod:1576 ../fish/guestfish-actions.pod:1048
8831 #: ../src/guestfs-actions.pod:1578 ../fish/guestfish-actions.pod:1050
8832 msgid "64 bit SPARC V9 and above."
8836 #: ../src/guestfs-actions.pod:1580 ../fish/guestfish-actions.pod:1052
8841 #: ../src/guestfs-actions.pod:1582 ../fish/guestfish-actions.pod:1054
8842 msgid "Intel Itanium."
8843 msgstr "Intel Itanium."
8846 #: ../src/guestfs-actions.pod:1584 ../fish/guestfish-actions.pod:1056
8851 #: ../src/guestfs-actions.pod:1586 ../fish/guestfish-actions.pod:1058
8852 msgid "32 bit Power PC."
8856 #: ../src/guestfs-actions.pod:1588 ../fish/guestfish-actions.pod:1060
8861 #: ../src/guestfs-actions.pod:1590 ../fish/guestfish-actions.pod:1062
8862 msgid "64 bit Power PC."
8866 #: ../src/guestfs-actions.pod:1594 ../fish/guestfish-actions.pod:1066
8867 msgid "Libguestfs may return other architecture strings in future."
8871 #: ../src/guestfs-actions.pod:1596 ../fish/guestfish-actions.pod:1068
8872 msgid "The function works on at least the following types of files:"
8876 #: ../src/guestfs-actions.pod:1602 ../fish/guestfish-actions.pod:1074
8877 msgid "many types of Un*x and Linux binary"
8881 #: ../src/guestfs-actions.pod:1606 ../fish/guestfish-actions.pod:1078
8882 msgid "many types of Un*x and Linux shared library"
8886 #: ../src/guestfs-actions.pod:1610 ../fish/guestfish-actions.pod:1082
8887 msgid "Windows Win32 and Win64 binaries"
8891 #: ../src/guestfs-actions.pod:1614 ../fish/guestfish-actions.pod:1086
8892 msgid "Windows Win32 and Win64 DLLs"
8896 #: ../src/guestfs-actions.pod:1616 ../fish/guestfish-actions.pod:1088
8897 msgid "Win32 binaries and DLLs return C<i386>."
8901 #: ../src/guestfs-actions.pod:1618 ../fish/guestfish-actions.pod:1090
8902 msgid "Win64 binaries and DLLs return C<x86_64>."
8906 #: ../src/guestfs-actions.pod:1622 ../fish/guestfish-actions.pod:1094
8907 msgid "Linux kernel modules"
8911 #: ../src/guestfs-actions.pod:1626 ../fish/guestfish-actions.pod:1098
8912 msgid "Linux new-style initrd images"
8916 #: ../src/guestfs-actions.pod:1630 ../fish/guestfish-actions.pod:1102
8917 msgid "some non-x86 Linux vmlinuz kernels"
8921 #: ../src/guestfs-actions.pod:1634 ../fish/guestfish-actions.pod:1106
8922 msgid "What it can't do currently:"
8926 #: ../src/guestfs-actions.pod:1640 ../fish/guestfish-actions.pod:1112
8927 msgid "static libraries (libfoo.a)"
8931 #: ../src/guestfs-actions.pod:1644 ../fish/guestfish-actions.pod:1116
8932 msgid "Linux old-style initrd as compressed ext2 filesystem (RHEL 3)"
8936 #: ../src/guestfs-actions.pod:1648 ../fish/guestfish-actions.pod:1120
8937 msgid "x86 Linux vmlinuz kernels"
8941 #: ../src/guestfs-actions.pod:1650 ../fish/guestfish-actions.pod:1122
8943 "x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and "
8944 "compressed code, and are horribly hard to unpack. If you want to find the "
8945 "architecture of a kernel, use the architecture of the associated initrd or "
8946 "kernel module(s) instead."
8950 #: ../src/guestfs-actions.pod:1660 ../src/guestfs-actions.pod:1823
8951 #: ../src/guestfs-actions.pod:1840 ../src/guestfs-actions.pod:2531
8952 #: ../src/guestfs-actions.pod:2624 ../src/guestfs-actions.pod:2694
8953 #: ../src/guestfs-actions.pod:2782 ../src/guestfs-actions.pod:2803
8954 #: ../src/guestfs-actions.pod:2846 ../src/guestfs-actions.pod:2930
8955 #: ../src/guestfs-actions.pod:3027 ../src/guestfs-actions.pod:3274
8956 #: ../src/guestfs-actions.pod:3406
8957 msgid "(Added in 1.5.3)"
8961 #: ../src/guestfs-actions.pod:1662
8962 msgid "guestfs_filesize"
8966 #: ../src/guestfs-actions.pod:1664
8970 " guestfs_filesize (guestfs_h *g,\n"
8971 " const char *file);\n"
8976 #: ../src/guestfs-actions.pod:1668 ../fish/guestfish-actions.pod:1133
8977 msgid "This command returns the size of C<file> in bytes."
8981 #: ../src/guestfs-actions.pod:1670
8983 "To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>, "
8984 "C<guestfs_is_dir>, C<guestfs_is_file> etc. To get the size of block "
8985 "devices, use C<guestfs_blockdev_getsize64>."
8989 #: ../src/guestfs-actions.pod:1676
8990 msgid "(Added in 1.0.82)"
8994 #: ../src/guestfs-actions.pod:1678
8995 msgid "guestfs_fill"
8999 #: ../src/guestfs-actions.pod:1680
9003 " guestfs_fill (guestfs_h *g,\n"
9006 " const char *path);\n"
9011 #: ../src/guestfs-actions.pod:1686 ../fish/guestfish-actions.pod:1143
9013 "This command creates a new file called C<path>. The initial content of the "
9014 "file is C<len> octets of C<c>, where C<c> must be a number in the range C<"
9019 #: ../src/guestfs-actions.pod:1690
9021 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
9022 "C<guestfs_truncate_size>. To create a file with a pattern of repeating "
9023 "bytes use C<guestfs_fill_pattern>."
9027 #: ../src/guestfs-actions.pod:1702
9028 msgid "(Added in 1.0.79)"
9032 #: ../src/guestfs-actions.pod:1704
9033 msgid "guestfs_fill_pattern"
9037 #: ../src/guestfs-actions.pod:1706
9041 " guestfs_fill_pattern (guestfs_h *g,\n"
9042 " const char *pattern,\n"
9044 " const char *path);\n"
9049 #: ../src/guestfs-actions.pod:1712
9051 "This function is like C<guestfs_fill> except that it creates a new file of "
9052 "length C<len> containing the repeating pattern of bytes in C<pattern>. The "
9053 "pattern is truncated if necessary to ensure the length of the file is "
9054 "exactly C<len> bytes."
9058 #: ../src/guestfs-actions.pod:1724
9059 msgid "(Added in 1.3.12)"
9063 #: ../src/guestfs-actions.pod:1726
9064 msgid "guestfs_find"
9068 #: ../src/guestfs-actions.pod:1728
9072 " guestfs_find (guestfs_h *g,\n"
9073 " const char *directory);\n"
9078 #: ../src/guestfs-actions.pod:1732 ../fish/guestfish-actions.pod:1165
9080 "This command lists out all files and directories, recursively, starting at "
9081 "C<directory>. It is essentially equivalent to running the shell command "
9082 "C<find directory -print> but some post-processing happens on the output, "
9087 #: ../src/guestfs-actions.pod:1737 ../fish/guestfish-actions.pod:1170
9089 "This returns a list of strings I<without any prefix>. Thus if the directory "
9094 #: ../src/guestfs-actions.pod:1740 ../fish/guestfish-actions.pod:1173
9104 #: ../src/guestfs-actions.pod:1744
9106 "then the returned list from C<guestfs_find> C</tmp> would be 4 elements:"
9110 #: ../src/guestfs-actions.pod:1747 ../fish/guestfish-actions.pod:1180
9121 #: ../src/guestfs-actions.pod:1752 ../fish/guestfish-actions.pod:1185
9122 msgid "If C<directory> is not a directory, then this command returns an error."
9126 #: ../src/guestfs-actions.pod:1755 ../fish/guestfish-actions.pod:1188
9127 msgid "The returned list is sorted."
9131 #: ../src/guestfs-actions.pod:1757
9132 msgid "See also C<guestfs_find0>."
9136 #: ../src/guestfs-actions.pod:1766 ../src/guestfs-actions.pod:4100
9137 #: ../src/guestfs-actions.pod:5643
9138 msgid "(Added in 1.0.27)"
9142 #: ../src/guestfs-actions.pod:1768
9143 msgid "guestfs_find0"
9147 #: ../src/guestfs-actions.pod:1770
9151 " guestfs_find0 (guestfs_h *g,\n"
9152 " const char *directory,\n"
9153 " const char *files);\n"
9158 #: ../src/guestfs-actions.pod:1775 ../fish/guestfish-actions.pod:1199
9160 "This command lists out all files and directories, recursively, starting at "
9161 "C<directory>, placing the resulting list in the external file called "
9166 #: ../src/guestfs-actions.pod:1779
9168 "This command works the same way as C<guestfs_find> with the following "
9173 #: ../src/guestfs-actions.pod:1786 ../fish/guestfish-actions.pod:1210
9174 msgid "The resulting list is written to an external file."
9178 #: ../src/guestfs-actions.pod:1790 ../fish/guestfish-actions.pod:1214
9180 "Items (filenames) in the result are separated by C<\\0> characters. See "
9181 "L<find(1)> option I<-print0>."
9185 #: ../src/guestfs-actions.pod:1795 ../fish/guestfish-actions.pod:1219
9186 msgid "This command is not limited in the number of names that it can return."
9190 #: ../src/guestfs-actions.pod:1800 ../fish/guestfish-actions.pod:1224
9191 msgid "The result list is not sorted."
9195 #: ../src/guestfs-actions.pod:1806
9196 msgid "(Added in 1.0.74)"
9200 #: ../src/guestfs-actions.pod:1808
9201 msgid "guestfs_findfs_label"
9205 #: ../src/guestfs-actions.pod:1810
9209 " guestfs_findfs_label (guestfs_h *g,\n"
9210 " const char *label);\n"
9215 #: ../src/guestfs-actions.pod:1814 ../fish/guestfish-actions.pod:1234
9217 "This command searches the filesystems and returns the one which has the "
9218 "given label. An error is returned if no such filesystem can be found."
9222 #: ../src/guestfs-actions.pod:1818
9223 msgid "To find the label of a filesystem, use C<guestfs_vfs_label>."
9227 #: ../src/guestfs-actions.pod:1825
9228 msgid "guestfs_findfs_uuid"
9232 #: ../src/guestfs-actions.pod:1827
9236 " guestfs_findfs_uuid (guestfs_h *g,\n"
9237 " const char *uuid);\n"
9242 #: ../src/guestfs-actions.pod:1831 ../fish/guestfish-actions.pod:1244
9244 "This command searches the filesystems and returns the one which has the "
9245 "given UUID. An error is returned if no such filesystem can be found."
9249 #: ../src/guestfs-actions.pod:1835
9250 msgid "To find the UUID of a filesystem, use C<guestfs_vfs_uuid>."
9254 #: ../src/guestfs-actions.pod:1842
9255 msgid "guestfs_fsck"
9259 #: ../src/guestfs-actions.pod:1844
9263 " guestfs_fsck (guestfs_h *g,\n"
9264 " const char *fstype,\n"
9265 " const char *device);\n"
9270 #: ../src/guestfs-actions.pod:1849 ../fish/guestfish-actions.pod:1254
9272 "This runs the filesystem checker (fsck) on C<device> which should have "
9273 "filesystem type C<fstype>."
9277 #: ../src/guestfs-actions.pod:1852 ../fish/guestfish-actions.pod:1257
9279 "The returned integer is the status. See L<fsck(8)> for the list of status "
9280 "codes from C<fsck>."
9284 #: ../src/guestfs-actions.pod:1861 ../fish/guestfish-actions.pod:1266
9285 msgid "Multiple status codes can be summed together."
9289 #: ../src/guestfs-actions.pod:1865 ../fish/guestfish-actions.pod:1270
9291 "A non-zero return code can mean \"success\", for example if errors have been "
9292 "corrected on the filesystem."
9296 #: ../src/guestfs-actions.pod:1870 ../fish/guestfish-actions.pod:1275
9297 msgid "Checking or repairing NTFS volumes is not supported (by linux-ntfs)."
9301 #: ../src/guestfs-actions.pod:1875 ../fish/guestfish-actions.pod:1280
9303 "This command is entirely equivalent to running C<fsck -a -t fstype device>."
9307 #: ../src/guestfs-actions.pod:1879 ../src/guestfs-actions.pod:7339
9308 msgid "(Added in 1.0.16)"
9312 #: ../src/guestfs-actions.pod:1881
9313 msgid "guestfs_get_append"
9317 #: ../src/guestfs-actions.pod:1883
9321 " guestfs_get_append (guestfs_h *g);\n"
9326 #: ../src/guestfs-actions.pod:1886 ../fish/guestfish-actions.pod:1286
9328 "Return the additional kernel options which are added to the guest kernel "
9333 #: ../src/guestfs-actions.pod:1889 ../fish/guestfish-actions.pod:1289
9334 msgid "If C<NULL> then no options are added."
9338 #: ../src/guestfs-actions.pod:1891
9340 "This function returns a string which may be NULL. There is no way to return "
9341 "an error from this function. The string is owned by the guest handle and "
9342 "must I<not> be freed."
9346 #: ../src/guestfs-actions.pod:1895 ../src/guestfs-actions.pod:5321
9347 #: ../src/guestfs-actions.pod:5801 ../src/guestfs-actions.pod:6201
9348 #: ../src/guestfs-actions.pod:6220 ../src/guestfs-actions.pod:6236
9349 #: ../src/guestfs-actions.pod:6253 ../src/guestfs-actions.pod:7010
9350 #: ../src/guestfs-actions.pod:7028 ../src/guestfs-actions.pod:7382
9351 msgid "(Added in 1.0.26)"
9355 #: ../src/guestfs-actions.pod:1897
9356 msgid "guestfs_get_attach_method"
9360 #: ../src/guestfs-actions.pod:1899
9364 " guestfs_get_attach_method (guestfs_h *g);\n"
9369 #: ../src/guestfs-actions.pod:1902
9370 msgid "Return the current attach method. See C<guestfs_set_attach_method>."
9374 #: ../src/guestfs-actions.pod:1907
9375 msgid "guestfs_get_autosync"
9379 #: ../src/guestfs-actions.pod:1909
9383 " guestfs_get_autosync (guestfs_h *g);\n"
9388 #: ../src/guestfs-actions.pod:1912 ../fish/guestfish-actions.pod:1301
9389 msgid "Get the autosync flag."
9393 #: ../src/guestfs-actions.pod:1918
9394 msgid "guestfs_get_direct"
9398 #: ../src/guestfs-actions.pod:1920
9402 " guestfs_get_direct (guestfs_h *g);\n"
9407 #: ../src/guestfs-actions.pod:1923 ../fish/guestfish-actions.pod:1307
9408 msgid "Return the direct appliance mode flag."
9412 #: ../src/guestfs-actions.pod:1927 ../src/guestfs-actions.pod:5870
9413 msgid "(Added in 1.0.72)"
9417 #: ../src/guestfs-actions.pod:1929
9418 msgid "guestfs_get_e2label"
9422 #: ../src/guestfs-actions.pod:1931
9426 " guestfs_get_e2label (guestfs_h *g,\n"
9427 " const char *device);\n"
9432 #: ../src/guestfs-actions.pod:1935 ../fish/guestfish-actions.pod:1313
9434 "This returns the ext2/3/4 filesystem label of the filesystem on C<device>."
9438 #: ../src/guestfs-actions.pod:1941 ../fish/guestfish-actions.pod:1316
9440 "This function is deprecated. In new code, use the C<vfs_label> call instead."
9444 #: ../src/guestfs-actions.pod:1948 ../src/guestfs-actions.pod:1969
9445 #: ../src/guestfs-actions.pod:5888 ../src/guestfs-actions.pod:5907
9446 msgid "(Added in 1.0.15)"
9450 #: ../src/guestfs-actions.pod:1950
9451 msgid "guestfs_get_e2uuid"
9455 #: ../src/guestfs-actions.pod:1952
9459 " guestfs_get_e2uuid (guestfs_h *g,\n"
9460 " const char *device);\n"
9465 #: ../src/guestfs-actions.pod:1956 ../fish/guestfish-actions.pod:1327
9467 "This returns the ext2/3/4 filesystem UUID of the filesystem on C<device>."
9471 #: ../src/guestfs-actions.pod:1962 ../fish/guestfish-actions.pod:1330
9473 "This function is deprecated. In new code, use the C<vfs_uuid> call instead."
9477 #: ../src/guestfs-actions.pod:1971
9478 msgid "guestfs_get_memsize"
9482 #: ../src/guestfs-actions.pod:1973
9486 " guestfs_get_memsize (guestfs_h *g);\n"
9491 #: ../src/guestfs-actions.pod:1976 ../fish/guestfish-actions.pod:1341
9493 "This gets the memory size in megabytes allocated to the qemu subprocess."
9497 #: ../src/guestfs-actions.pod:1979
9499 "If C<guestfs_set_memsize> was not called on this handle, and if "
9500 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
9501 "value for memsize."
9505 #: ../src/guestfs-actions.pod:1983 ../src/guestfs-actions.pod:2064
9506 #: ../src/guestfs-actions.pod:5923 ../src/guestfs-actions.pod:6030
9507 #: ../fish/guestfish-actions.pod:1348 ../fish/guestfish-actions.pod:1399
9508 #: ../fish/guestfish-actions.pod:3993 ../fish/guestfish-actions.pod:4080
9510 "For more information on the architecture of libguestfs, see L<guestfs(3)>."
9514 #: ../src/guestfs-actions.pod:1988 ../src/guestfs-actions.pod:4391
9515 #: ../src/guestfs-actions.pod:4588 ../src/guestfs-actions.pod:4607
9516 #: ../src/guestfs-actions.pod:4626 ../src/guestfs-actions.pod:4638
9517 #: ../src/guestfs-actions.pod:4655 ../src/guestfs-actions.pod:4668
9518 #: ../src/guestfs-actions.pod:5546 ../src/guestfs-actions.pod:5928
9519 #: ../src/guestfs-actions.pod:6175 ../src/guestfs-actions.pod:6776
9520 msgid "(Added in 1.0.55)"
9524 #: ../src/guestfs-actions.pod:1990
9525 msgid "guestfs_get_network"
9529 #: ../src/guestfs-actions.pod:1992
9533 " guestfs_get_network (guestfs_h *g);\n"
9538 #: ../src/guestfs-actions.pod:1995 ../fish/guestfish-actions.pod:1355
9539 msgid "This returns the enable network flag."
9543 #: ../src/guestfs-actions.pod:1999 ../src/guestfs-actions.pod:5947
9544 msgid "(Added in 1.5.4)"
9548 #: ../src/guestfs-actions.pod:2001
9549 msgid "guestfs_get_path"
9553 #: ../src/guestfs-actions.pod:2003
9557 " guestfs_get_path (guestfs_h *g);\n"
9562 #: ../src/guestfs-actions.pod:2006 ../fish/guestfish-actions.pod:1361
9563 msgid "Return the current search path."
9567 #: ../src/guestfs-actions.pod:2008 ../fish/guestfish-actions.pod:1363
9569 "This is always non-NULL. If it wasn't set already, then this will return "
9574 #: ../src/guestfs-actions.pod:2011 ../src/guestfs-actions.pod:2040
9576 "This function returns a string, or NULL on error. The string is owned by "
9577 "the guest handle and must I<not> be freed."
9581 #: ../src/guestfs-actions.pod:2016
9582 msgid "guestfs_get_pid"
9586 #: ../src/guestfs-actions.pod:2018
9590 " guestfs_get_pid (guestfs_h *g);\n"
9595 #: ../src/guestfs-actions.pod:2021 ../fish/guestfish-actions.pod:1372
9597 "Return the process ID of the qemu subprocess. If there is no qemu "
9598 "subprocess, then this will return an error."
9602 #: ../src/guestfs-actions.pod:2024 ../fish/guestfish-actions.pod:1375
9603 msgid "This is an internal call used for debugging and testing."
9607 #: ../src/guestfs-actions.pod:2028
9608 msgid "(Added in 1.0.56)"
9612 #: ../src/guestfs-actions.pod:2030
9613 msgid "guestfs_get_qemu"
9617 #: ../src/guestfs-actions.pod:2032
9621 " guestfs_get_qemu (guestfs_h *g);\n"
9626 #: ../src/guestfs-actions.pod:2035 ../fish/guestfish-actions.pod:1381
9627 msgid "Return the current qemu binary."
9631 #: ../src/guestfs-actions.pod:2037 ../fish/guestfish-actions.pod:1383
9633 "This is always non-NULL. If it wasn't set already, then this will return "
9634 "the default qemu binary name."
9638 #: ../src/guestfs-actions.pod:2043 ../src/guestfs-actions.pod:5992
9639 msgid "(Added in 1.0.6)"
9643 #: ../src/guestfs-actions.pod:2045
9644 msgid "guestfs_get_recovery_proc"
9648 #: ../src/guestfs-actions.pod:2047
9652 " guestfs_get_recovery_proc (guestfs_h *g);\n"
9657 #: ../src/guestfs-actions.pod:2050 ../fish/guestfish-actions.pod:1390
9658 msgid "Return the recovery process enabled flag."
9662 #: ../src/guestfs-actions.pod:2054 ../src/guestfs-actions.pod:3501
9663 #: ../src/guestfs-actions.pod:3798 ../src/guestfs-actions.pod:4198
9664 #: ../src/guestfs-actions.pod:4230 ../src/guestfs-actions.pod:5251
9665 #: ../src/guestfs-actions.pod:5594 ../src/guestfs-actions.pod:6016
9666 #: ../src/guestfs-actions.pod:6679 ../src/guestfs-actions.pod:6699
9667 #: ../src/guestfs-actions.pod:6891
9668 msgid "(Added in 1.0.77)"
9672 #: ../src/guestfs-actions.pod:2056
9673 msgid "guestfs_get_selinux"
9677 #: ../src/guestfs-actions.pod:2058
9681 " guestfs_get_selinux (guestfs_h *g);\n"
9686 #: ../src/guestfs-actions.pod:2061
9688 "This returns the current setting of the selinux flag which is passed to the "
9689 "appliance at boot time. See C<guestfs_set_selinux>."
9693 #: ../src/guestfs-actions.pod:2069 ../src/guestfs-actions.pod:2132
9694 #: ../src/guestfs-actions.pod:6035 ../src/guestfs-actions.pod:6093
9695 msgid "(Added in 1.0.67)"
9699 #: ../src/guestfs-actions.pod:2071
9700 msgid "guestfs_get_state"
9704 #: ../src/guestfs-actions.pod:2073
9708 " guestfs_get_state (guestfs_h *g);\n"
9713 #: ../src/guestfs-actions.pod:2076 ../fish/guestfish-actions.pod:1406
9715 "This returns the current state as an opaque integer. This is only useful "
9716 "for printing debug and internal error messages."
9720 #: ../src/guestfs-actions.pod:2079 ../src/guestfs-actions.pod:3299
9721 #: ../src/guestfs-actions.pod:3328 ../src/guestfs-actions.pod:3389
9722 #: ../src/guestfs-actions.pod:3416 ../fish/guestfish-actions.pod:1409
9723 #: ../fish/guestfish-actions.pod:2323 ../fish/guestfish-actions.pod:2341
9724 #: ../fish/guestfish-actions.pod:2379 ../fish/guestfish-actions.pod:2395
9725 msgid "For more information on states, see L<guestfs(3)>."
9729 #: ../src/guestfs-actions.pod:2085
9730 msgid "guestfs_get_trace"
9734 #: ../src/guestfs-actions.pod:2087
9738 " guestfs_get_trace (guestfs_h *g);\n"
9743 #: ../src/guestfs-actions.pod:2090 ../fish/guestfish-actions.pod:1415
9744 msgid "Return the command trace flag."
9748 #: ../src/guestfs-actions.pod:2096
9749 msgid "guestfs_get_umask"
9753 #: ../src/guestfs-actions.pod:2098
9757 " guestfs_get_umask (guestfs_h *g);\n"
9762 #: ../src/guestfs-actions.pod:2101
9764 "Return the current umask. By default the umask is C<022> unless it has been "
9765 "set by calling C<guestfs_umask>."
9769 #: ../src/guestfs-actions.pod:2108
9770 msgid "guestfs_get_verbose"
9774 #: ../src/guestfs-actions.pod:2110
9778 " guestfs_get_verbose (guestfs_h *g);\n"
9783 #: ../src/guestfs-actions.pod:2113 ../fish/guestfish-actions.pod:1428
9784 msgid "This returns the verbose messages flag."
9788 #: ../src/guestfs-actions.pod:2119
9789 msgid "guestfs_getcon"
9793 #: ../src/guestfs-actions.pod:2121
9797 " guestfs_getcon (guestfs_h *g);\n"
9802 #: ../src/guestfs-actions.pod:2124 ../fish/guestfish-actions.pod:1434
9803 msgid "This gets the SELinux security context of the daemon."
9807 #: ../src/guestfs-actions.pod:2126
9809 "See the documentation about SELINUX in L<guestfs(3)>, and C<guestfs_setcon>"
9813 #: ../src/guestfs-actions.pod:2134
9814 msgid "guestfs_getxattr"
9818 #: ../src/guestfs-actions.pod:2136
9822 " guestfs_getxattr (guestfs_h *g,\n"
9823 " const char *path,\n"
9824 " const char *name,\n"
9825 " size_t *size_r);\n"
9830 #: ../src/guestfs-actions.pod:2142
9832 "Get a single extended attribute from file C<path> named C<name>. This call "
9833 "follows symlinks. If you want to lookup an extended attribute for the "
9834 "symlink itself, use C<guestfs_lgetxattr>."
9838 #: ../src/guestfs-actions.pod:2146 ../src/guestfs-actions.pod:3515
9840 "Normally it is better to get all extended attributes from a file in one go "
9841 "by calling C<guestfs_getxattrs>. However some Linux filesystem "
9842 "implementations are buggy and do not provide a way to list out attributes. "
9843 "For these filesystems (notably ntfs-3g) you have to know the names of the "
9844 "extended attributes you want in advance and call this function."
9848 #: ../src/guestfs-actions.pod:2153 ../src/guestfs-actions.pod:3522
9849 #: ../fish/guestfish-actions.pod:1454 ../fish/guestfish-actions.pod:2460
9851 "Extended attribute values are blobs of binary data. If there is no extended "
9852 "attribute named C<name>, this returns an error."
9856 #: ../src/guestfs-actions.pod:2156
9857 msgid "See also: C<guestfs_getxattrs>, C<guestfs_lgetxattr>, L<attr(5)>."
9861 #: ../src/guestfs-actions.pod:2158 ../src/guestfs-actions.pod:2349
9862 #: ../src/guestfs-actions.pod:3527 ../src/guestfs-actions.pod:5244
9863 #: ../src/guestfs-actions.pod:5270 ../src/guestfs-actions.pod:5451
9865 "This function returns a buffer, or NULL on error. The size of the returned "
9866 "buffer is written to C<*size_r>. I<The caller must free the returned buffer "
9871 #: ../src/guestfs-actions.pod:2162 ../src/guestfs-actions.pod:3531
9872 msgid "(Added in 1.7.24)"
9876 #: ../src/guestfs-actions.pod:2164
9877 msgid "guestfs_getxattrs"
9881 #: ../src/guestfs-actions.pod:2166
9884 " struct guestfs_xattr_list *\n"
9885 " guestfs_getxattrs (guestfs_h *g,\n"
9886 " const char *path);\n"
9891 #: ../src/guestfs-actions.pod:2170 ../fish/guestfish-actions.pod:1463
9893 "This call lists the extended attributes of the file or directory C<path>."
9897 #: ../src/guestfs-actions.pod:2173 ../fish/guestfish-actions.pod:1466
9899 "At the system call level, this is a combination of the L<listxattr(2)> and "
9900 "L<getxattr(2)> calls."
9904 #: ../src/guestfs-actions.pod:2176
9905 msgid "See also: C<guestfs_lgetxattrs>, L<attr(5)>."
9909 #: ../src/guestfs-actions.pod:2178 ../src/guestfs-actions.pod:3543
9910 #: ../src/guestfs-actions.pod:4194
9912 "This function returns a C<struct guestfs_xattr_list *>, or NULL if there was "
9913 "an error. I<The caller must call C<guestfs_free_xattr_list> after use>."
9917 #: ../src/guestfs-actions.pod:2182 ../src/guestfs-actions.pod:3547
9918 #: ../src/guestfs-actions.pod:3712 ../src/guestfs-actions.pod:3748
9919 #: ../src/guestfs-actions.pod:5624 ../src/guestfs-actions.pod:6112
9920 #: ../src/guestfs-actions.pod:7447
9921 msgid "(Added in 1.0.59)"
9925 #: ../src/guestfs-actions.pod:2184
9926 msgid "guestfs_glob_expand"
9930 #: ../src/guestfs-actions.pod:2186
9934 " guestfs_glob_expand (guestfs_h *g,\n"
9935 " const char *pattern);\n"
9940 #: ../src/guestfs-actions.pod:2190 ../fish/guestfish-actions.pod:1475
9942 "This command searches for all the pathnames matching C<pattern> according to "
9943 "the wildcard expansion rules used by the shell."
9947 #: ../src/guestfs-actions.pod:2194 ../fish/guestfish-actions.pod:1479
9949 "If no paths match, then this returns an empty list (note: not an error)."
9953 #: ../src/guestfs-actions.pod:2197 ../fish/guestfish-actions.pod:1482
9955 "It is just a wrapper around the C L<glob(3)> function with flags C<GLOB_MARK|"
9956 "GLOB_BRACE>. See that manual page for more details."
9960 #: ../src/guestfs-actions.pod:2205 ../src/guestfs-actions.pod:6277
9961 #: ../src/guestfs-actions.pod:6294
9962 msgid "(Added in 1.0.50)"
9966 #: ../src/guestfs-actions.pod:2207
9967 msgid "guestfs_grep"
9971 #: ../src/guestfs-actions.pod:2209
9975 " guestfs_grep (guestfs_h *g,\n"
9976 " const char *regex,\n"
9977 " const char *path);\n"
9982 #: ../src/guestfs-actions.pod:2214 ../fish/guestfish-actions.pod:1490
9983 msgid "This calls the external C<grep> program and returns the matching lines."
9987 #: ../src/guestfs-actions.pod:2226
9988 msgid "guestfs_grepi"
9992 #: ../src/guestfs-actions.pod:2228
9996 " guestfs_grepi (guestfs_h *g,\n"
9997 " const char *regex,\n"
9998 " const char *path);\n"
10003 #: ../src/guestfs-actions.pod:2233 ../fish/guestfish-actions.pod:1500
10005 "This calls the external C<grep -i> program and returns the matching lines."
10009 #: ../src/guestfs-actions.pod:2245
10010 msgid "guestfs_grub_install"
10014 #: ../src/guestfs-actions.pod:2247
10018 " guestfs_grub_install (guestfs_h *g,\n"
10019 " const char *root,\n"
10020 " const char *device);\n"
10025 #: ../src/guestfs-actions.pod:2252 ../fish/guestfish-actions.pod:1510
10027 "This command installs GRUB (the Grand Unified Bootloader) on C<device>, with "
10028 "the root directory being C<root>."
10032 #: ../src/guestfs-actions.pod:2255 ../fish/guestfish-actions.pod:1513
10034 "Note: If grub-install reports the error \"No suitable drive was found in the "
10035 "generated device map.\" it may be that you need to create a C</boot/grub/"
10036 "device.map> file first that contains the mapping between grub device names "
10037 "and Linux device names. It is usually sufficient to create a file "
10042 #: ../src/guestfs-actions.pod:2262 ../fish/guestfish-actions.pod:1520
10045 " (hd0) /dev/vda\n"
10050 #: ../src/guestfs-actions.pod:2264 ../fish/guestfish-actions.pod:1522
10051 msgid "replacing C</dev/vda> with the name of the installation device."
10055 #: ../src/guestfs-actions.pod:2268
10056 msgid "(Added in 1.0.17)"
10060 #: ../src/guestfs-actions.pod:2270
10061 msgid "guestfs_head"
10065 #: ../src/guestfs-actions.pod:2272
10069 " guestfs_head (guestfs_h *g,\n"
10070 " const char *path);\n"
10075 #: ../src/guestfs-actions.pod:2276 ../fish/guestfish-actions.pod:1528
10077 "This command returns up to the first 10 lines of a file as a list of strings."
10081 #: ../src/guestfs-actions.pod:2288
10082 msgid "guestfs_head_n"
10086 #: ../src/guestfs-actions.pod:2290
10090 " guestfs_head_n (guestfs_h *g,\n"
10092 " const char *path);\n"
10097 #: ../src/guestfs-actions.pod:2295 ../fish/guestfish-actions.pod:1538
10099 "If the parameter C<nrlines> is a positive number, this returns the first "
10100 "C<nrlines> lines of the file C<path>."
10104 #: ../src/guestfs-actions.pod:2298 ../fish/guestfish-actions.pod:1541
10106 "If the parameter C<nrlines> is a negative number, this returns lines from "
10107 "the file C<path>, excluding the last C<nrlines> lines."
10111 #: ../src/guestfs-actions.pod:2301 ../src/guestfs-actions.pod:6574
10112 #: ../fish/guestfish-actions.pod:1544 ../fish/guestfish-actions.pod:4430
10113 msgid "If the parameter C<nrlines> is zero, this returns an empty list."
10117 #: ../src/guestfs-actions.pod:2312
10118 msgid "guestfs_hexdump"
10122 #: ../src/guestfs-actions.pod:2314
10126 " guestfs_hexdump (guestfs_h *g,\n"
10127 " const char *path);\n"
10132 #: ../src/guestfs-actions.pod:2318 ../fish/guestfish-actions.pod:1553
10134 "This runs C<hexdump -C> on the given C<path>. The result is the human-"
10135 "readable, canonical hex dump of the file."
10139 #: ../src/guestfs-actions.pod:2327 ../src/guestfs-actions.pod:6358
10140 #: ../src/guestfs-actions.pod:6413
10141 msgid "(Added in 1.0.22)"
10145 #: ../src/guestfs-actions.pod:2329
10146 msgid "guestfs_initrd_cat"
10150 #: ../src/guestfs-actions.pod:2331
10154 " guestfs_initrd_cat (guestfs_h *g,\n"
10155 " const char *initrdpath,\n"
10156 " const char *filename,\n"
10157 " size_t *size_r);\n"
10162 #: ../src/guestfs-actions.pod:2337 ../fish/guestfish-actions.pod:1563
10164 "This command unpacks the file C<filename> from the initrd file called "
10165 "C<initrdpath>. The filename must be given I<without> the initial C</> "
10170 #: ../src/guestfs-actions.pod:2341 ../fish/guestfish-actions.pod:1567
10172 "For example, in guestfish you could use the following command to examine the "
10173 "boot script (usually called C</init>) contained in a Linux initrd or "
10178 #: ../src/guestfs-actions.pod:2345 ../fish/guestfish-actions.pod:1571
10181 " initrd-cat /boot/initrd-<version>.img init\n"
10186 #: ../src/guestfs-actions.pod:2347
10187 msgid "See also C<guestfs_initrd_list>."
10191 #: ../src/guestfs-actions.pod:2358
10192 msgid "guestfs_initrd_list"
10196 #: ../src/guestfs-actions.pod:2360
10200 " guestfs_initrd_list (guestfs_h *g,\n"
10201 " const char *path);\n"
10206 #: ../src/guestfs-actions.pod:2364 ../fish/guestfish-actions.pod:1582
10207 msgid "This command lists out files contained in an initrd."
10211 #: ../src/guestfs-actions.pod:2366 ../fish/guestfish-actions.pod:1584
10213 "The files are listed without any initial C</> character. The files are "
10214 "listed in the order they appear (not necessarily alphabetical). Directory "
10215 "names are listed as separate items."
10219 #: ../src/guestfs-actions.pod:2370 ../fish/guestfish-actions.pod:1588
10221 "Old Linux kernels (2.4 and earlier) used a compressed ext2 filesystem as "
10222 "initrd. We I<only> support the newer initramfs format (compressed cpio "
10227 #: ../src/guestfs-actions.pod:2380
10228 msgid "guestfs_inotify_add_watch"
10232 #: ../src/guestfs-actions.pod:2382
10236 " guestfs_inotify_add_watch (guestfs_h *g,\n"
10237 " const char *path,\n"
10243 #: ../src/guestfs-actions.pod:2387 ../fish/guestfish-actions.pod:1596
10244 msgid "Watch C<path> for the events listed in C<mask>."
10248 #: ../src/guestfs-actions.pod:2389 ../fish/guestfish-actions.pod:1598
10250 "Note that if C<path> is a directory then events within that directory are "
10251 "watched, but this does I<not> happen recursively (in subdirectories)."
10255 #: ../src/guestfs-actions.pod:2393 ../fish/guestfish-actions.pod:1602
10257 "Note for non-C or non-Linux callers: the inotify events are defined by the "
10258 "Linux kernel ABI and are listed in C</usr/include/sys/inotify.h>."
10262 #: ../src/guestfs-actions.pod:2401
10263 msgid "guestfs_inotify_close"
10267 #: ../src/guestfs-actions.pod:2403
10271 " guestfs_inotify_close (guestfs_h *g);\n"
10276 #: ../src/guestfs-actions.pod:2406 ../fish/guestfish-actions.pod:1610
10278 "This closes the inotify handle which was previously opened by inotify_init. "
10279 "It removes all watches, throws away any pending events, and deallocates all "
10284 #: ../src/guestfs-actions.pod:2414
10285 msgid "guestfs_inotify_files"
10289 #: ../src/guestfs-actions.pod:2416
10293 " guestfs_inotify_files (guestfs_h *g);\n"
10298 #: ../src/guestfs-actions.pod:2419
10300 "This function is a helpful wrapper around C<guestfs_inotify_read> which just "
10301 "returns a list of pathnames of objects that were touched. The returned "
10302 "pathnames are sorted and deduplicated."
10306 #: ../src/guestfs-actions.pod:2429
10307 msgid "guestfs_inotify_init"
10311 #: ../src/guestfs-actions.pod:2431
10315 " guestfs_inotify_init (guestfs_h *g,\n"
10316 " int maxevents);\n"
10321 #: ../src/guestfs-actions.pod:2435 ../fish/guestfish-actions.pod:1626
10323 "This command creates a new inotify handle. The inotify subsystem can be "
10324 "used to notify events which happen to objects in the guest filesystem."
10328 #: ../src/guestfs-actions.pod:2439
10330 "C<maxevents> is the maximum number of events which will be queued up between "
10331 "calls to C<guestfs_inotify_read> or C<guestfs_inotify_files>. If this is "
10332 "passed as C<0>, then the kernel (or previously set) default is used. For "
10333 "Linux 2.6.29 the default was 16384 events. Beyond this limit, the kernel "
10334 "throws away events, but records the fact that it threw them away by setting "
10335 "a flag C<IN_Q_OVERFLOW> in the returned structure list (see "
10336 "C<guestfs_inotify_read>)."
10340 #: ../src/guestfs-actions.pod:2449
10342 "Before any events are generated, you have to add some watches to the "
10343 "internal watch list. See: C<guestfs_inotify_add_watch>, "
10344 "C<guestfs_inotify_rm_watch> and C<guestfs_inotify_watch_all>."
10348 #: ../src/guestfs-actions.pod:2455
10350 "Queued up events should be read periodically by calling "
10351 "C<guestfs_inotify_read> (or C<guestfs_inotify_files> which is just a helpful "
10352 "wrapper around C<guestfs_inotify_read>). If you don't read the events out "
10353 "often enough then you risk the internal queue overflowing."
10357 #: ../src/guestfs-actions.pod:2462
10359 "The handle should be closed after use by calling C<guestfs_inotify_close>. "
10360 "This also removes any watches automatically."
10364 #: ../src/guestfs-actions.pod:2466 ../fish/guestfish-actions.pod:1657
10366 "See also L<inotify(7)> for an overview of the inotify interface as exposed "
10367 "by the Linux kernel, which is roughly what we expose via libguestfs. Note "
10368 "that there is one global inotify handle per libguestfs instance."
10372 #: ../src/guestfs-actions.pod:2475
10373 msgid "guestfs_inotify_read"
10377 #: ../src/guestfs-actions.pod:2477
10380 " struct guestfs_inotify_event_list *\n"
10381 " guestfs_inotify_read (guestfs_h *g);\n"
10386 #: ../src/guestfs-actions.pod:2480 ../fish/guestfish-actions.pod:1666
10388 "Return the complete queue of events that have happened since the previous "
10393 #: ../src/guestfs-actions.pod:2483 ../fish/guestfish-actions.pod:1669
10394 msgid "If no events have happened, this returns an empty list."
10398 #: ../src/guestfs-actions.pod:2485 ../fish/guestfish-actions.pod:1671
10400 "I<Note>: In order to make sure that all events have been read, you must call "
10401 "this function repeatedly until it returns an empty list. The reason is that "
10402 "the call will read events up to the maximum appliance-to-host message size "
10403 "and leave remaining events in the queue."
10407 #: ../src/guestfs-actions.pod:2491
10409 "This function returns a C<struct guestfs_inotify_event_list *>, or NULL if "
10410 "there was an error. I<The caller must call "
10411 "C<guestfs_free_inotify_event_list> after use>."
10415 #: ../src/guestfs-actions.pod:2497
10416 msgid "guestfs_inotify_rm_watch"
10420 #: ../src/guestfs-actions.pod:2499
10424 " guestfs_inotify_rm_watch (guestfs_h *g,\n"
10430 #: ../src/guestfs-actions.pod:2503
10432 "Remove a previously defined inotify watch. See C<guestfs_inotify_add_watch>."
10436 #: ../src/guestfs-actions.pod:2510
10437 msgid "guestfs_inspect_get_arch"
10441 #: ../src/guestfs-actions.pod:2512
10445 " guestfs_inspect_get_arch (guestfs_h *g,\n"
10446 " const char *root);\n"
10451 #: ../src/guestfs-actions.pod:2516 ../src/guestfs-actions.pod:2539
10452 #: ../src/guestfs-actions.pod:2632 ../src/guestfs-actions.pod:2676
10453 #: ../src/guestfs-actions.pod:2702 ../src/guestfs-actions.pod:2741
10454 #: ../src/guestfs-actions.pod:2763 ../src/guestfs-actions.pod:2790
10455 #: ../src/guestfs-actions.pod:2811 ../src/guestfs-actions.pod:2854
10456 #: ../src/guestfs-actions.pod:2883 ../src/guestfs-actions.pod:2914
10457 #: ../src/guestfs-actions.pod:2938 ../src/guestfs-actions.pod:2993
10458 #: ../src/guestfs-actions.pod:3035 ../src/guestfs-actions.pod:3056
10459 #: ../src/guestfs-actions.pod:3079 ../src/guestfs-actions.pod:3096
10460 #: ../src/guestfs-actions.pod:3113 ../src/guestfs-actions.pod:3132
10462 "This function should only be called with a root device string as returned by "
10463 "C<guestfs_inspect_os>."
10467 #: ../src/guestfs-actions.pod:2519
10469 "This returns the architecture of the inspected operating system. The "
10470 "possible return values are listed under C<guestfs_file_architecture>."
10474 #: ../src/guestfs-actions.pod:2523 ../fish/guestfish-actions.pod:1695
10476 "If the architecture could not be determined, then the string C<unknown> is "
10481 #: ../src/guestfs-actions.pod:2526 ../src/guestfs-actions.pod:2619
10482 #: ../src/guestfs-actions.pod:2730 ../src/guestfs-actions.pod:2750
10483 #: ../src/guestfs-actions.pod:2778 ../src/guestfs-actions.pod:2870
10484 #: ../src/guestfs-actions.pod:2901 ../src/guestfs-actions.pod:2925
10485 #: ../src/guestfs-actions.pod:2979 ../src/guestfs-actions.pod:3022
10486 #: ../src/guestfs-actions.pod:3045 ../src/guestfs-actions.pod:3066
10487 #: ../src/guestfs-actions.pod:3086 ../src/guestfs-actions.pod:3103
10488 #: ../src/guestfs-actions.pod:3122 ../src/guestfs-actions.pod:3225
10489 #: ../src/guestfs-actions.pod:3266 ../fish/guestfish-actions.pod:1698
10490 #: ../fish/guestfish-actions.pod:1784 ../fish/guestfish-actions.pod:1872
10491 #: ../fish/guestfish-actions.pod:1887 ../fish/guestfish-actions.pod:1908
10492 #: ../fish/guestfish-actions.pod:1978 ../fish/guestfish-actions.pod:2002
10493 #: ../fish/guestfish-actions.pod:2019 ../fish/guestfish-actions.pod:2062
10494 #: ../fish/guestfish-actions.pod:2097 ../fish/guestfish-actions.pod:2113
10495 #: ../fish/guestfish-actions.pod:2129 ../fish/guestfish-actions.pod:2142
10496 #: ../fish/guestfish-actions.pod:2155 ../fish/guestfish-actions.pod:2170
10497 #: ../fish/guestfish-actions.pod:2269 ../fish/guestfish-actions.pod:2303
10498 msgid "Please read L<guestfs(3)/INSPECTION> for more details."
10502 #: ../src/guestfs-actions.pod:2533
10503 msgid "guestfs_inspect_get_distro"
10507 #: ../src/guestfs-actions.pod:2535
10511 " guestfs_inspect_get_distro (guestfs_h *g,\n"
10512 " const char *root);\n"
10517 #: ../src/guestfs-actions.pod:2542 ../fish/guestfish-actions.pod:1707
10519 "This returns the distro (distribution) of the inspected operating system."
10523 #: ../src/guestfs-actions.pod:2545 ../fish/guestfish-actions.pod:1710
10524 msgid "Currently defined distros are:"
10528 #: ../src/guestfs-actions.pod:2549 ../fish/guestfish-actions.pod:1714
10529 msgid "\"archlinux\""
10530 msgstr "\"archlinux\""
10533 #: ../src/guestfs-actions.pod:2551 ../fish/guestfish-actions.pod:1716
10534 msgid "Arch Linux."
10535 msgstr "Arch Linux."
10538 #: ../src/guestfs-actions.pod:2553 ../fish/guestfish-actions.pod:1718
10540 #| msgid "\"gentoo\""
10542 msgstr "\"gentoo\""
10545 #: ../src/guestfs-actions.pod:2555 ../fish/guestfish-actions.pod:1720
10550 #: ../src/guestfs-actions.pod:2557 ../fish/guestfish-actions.pod:1722
10552 msgstr "\"debian\""
10555 #: ../src/guestfs-actions.pod:2559 ../fish/guestfish-actions.pod:1724
10560 #: ../src/guestfs-actions.pod:2561 ../fish/guestfish-actions.pod:1726
10562 msgstr "\"fedora\""
10565 #: ../src/guestfs-actions.pod:2563 ../fish/guestfish-actions.pod:1728
10570 #: ../src/guestfs-actions.pod:2565 ../fish/guestfish-actions.pod:1730
10572 msgstr "\"gentoo\""
10575 #: ../src/guestfs-actions.pod:2567 ../fish/guestfish-actions.pod:1732
10580 #: ../src/guestfs-actions.pod:2569 ../fish/guestfish-actions.pod:1734
10581 msgid "\"linuxmint\""
10582 msgstr "\"linuxmint\""
10585 #: ../src/guestfs-actions.pod:2571 ../fish/guestfish-actions.pod:1736
10586 msgid "Linux Mint."
10587 msgstr "Linux Mint."
10590 #: ../src/guestfs-actions.pod:2573 ../fish/guestfish-actions.pod:1738
10591 msgid "\"mandriva\""
10592 msgstr "\"mandriva\""
10595 #: ../src/guestfs-actions.pod:2575 ../fish/guestfish-actions.pod:1740
10600 #: ../src/guestfs-actions.pod:2577 ../fish/guestfish-actions.pod:1742
10605 #: ../src/guestfs-actions.pod:2579 ../fish/guestfish-actions.pod:1744
10610 #: ../src/guestfs-actions.pod:2581 ../fish/guestfish-actions.pod:1746
10612 msgstr "\"pardus\""
10615 #: ../src/guestfs-actions.pod:2583 ../fish/guestfish-actions.pod:1748
10620 #: ../src/guestfs-actions.pod:2585 ../fish/guestfish-actions.pod:1750
10621 msgid "\"redhat-based\""
10622 msgstr "\"redhat-based\""
10625 #: ../src/guestfs-actions.pod:2587 ../fish/guestfish-actions.pod:1752
10626 msgid "Some Red Hat-derived distro."
10627 msgstr "Дистрибутив, що походить від Red Hat."
10630 #: ../src/guestfs-actions.pod:2589 ../fish/guestfish-actions.pod:1754
10635 #: ../src/guestfs-actions.pod:2591 ../fish/guestfish-actions.pod:1756
10637 #| msgid "Red Hat Enterprise Linux and some derivatives."
10638 msgid "Red Hat Enterprise Linux."
10639 msgstr "Red Hat Enterprise Linux та деякі з похідних дистрибутивів."
10642 #: ../src/guestfs-actions.pod:2593 ../fish/guestfish-actions.pod:1758
10643 msgid "\"scientificlinux\""
10647 #: ../src/guestfs-actions.pod:2595 ../fish/guestfish-actions.pod:1760
10648 msgid "Scientific Linux."
10652 #: ../src/guestfs-actions.pod:2597 ../fish/guestfish-actions.pod:1762
10653 msgid "\"slackware\""
10657 #: ../src/guestfs-actions.pod:2599 ../fish/guestfish-actions.pod:1764
10662 #: ../src/guestfs-actions.pod:2601 ../fish/guestfish-actions.pod:1766
10664 msgstr "\"ubuntu\""
10667 #: ../src/guestfs-actions.pod:2603 ../fish/guestfish-actions.pod:1768
10672 #: ../src/guestfs-actions.pod:2605 ../src/guestfs-actions.pod:2721
10673 #: ../src/guestfs-actions.pod:3013 ../fish/guestfish-actions.pod:1770
10674 #: ../fish/guestfish-actions.pod:1863 ../fish/guestfish-actions.pod:2088
10675 msgid "\"unknown\""
10676 msgstr "\"unknown\""
10679 #: ../src/guestfs-actions.pod:2607 ../fish/guestfish-actions.pod:1772
10680 msgid "The distro could not be determined."
10681 msgstr "Дистрибутив, тип якого не вдалося визначити."
10684 #: ../src/guestfs-actions.pod:2609 ../src/guestfs-actions.pod:3005
10685 #: ../fish/guestfish-actions.pod:1774 ../fish/guestfish-actions.pod:2080
10686 msgid "\"windows\""
10687 msgstr "\"windows\""
10690 #: ../src/guestfs-actions.pod:2611 ../fish/guestfish-actions.pod:1776
10692 "Windows does not have distributions. This string is returned if the OS type "
10697 #: ../src/guestfs-actions.pod:2616 ../src/guestfs-actions.pod:2727
10698 #: ../src/guestfs-actions.pod:3019 ../fish/guestfish-actions.pod:1781
10699 #: ../fish/guestfish-actions.pod:1869 ../fish/guestfish-actions.pod:2094
10701 "Future versions of libguestfs may return other strings here. The caller "
10702 "should be prepared to handle any string."
10706 #: ../src/guestfs-actions.pod:2626
10707 msgid "guestfs_inspect_get_drive_mappings"
10711 #: ../src/guestfs-actions.pod:2628
10715 " guestfs_inspect_get_drive_mappings (guestfs_h *g,\n"
10716 " const char *root);\n"
10721 #: ../src/guestfs-actions.pod:2635 ../fish/guestfish-actions.pod:1793
10723 "This call is useful for Windows which uses a primitive system of assigning "
10724 "drive letters (like \"C:\") to partitions. This inspection API examines the "
10725 "Windows Registry to find out how disks/partitions are mapped to drive "
10726 "letters, and returns a hash table as in the example below:"
10730 #: ../src/guestfs-actions.pod:2641 ../fish/guestfish-actions.pod:1799
10733 " C => /dev/vda2\n"
10734 " E => /dev/vdb1\n"
10735 " F => /dev/vdc1\n"
10740 #: ../src/guestfs-actions.pod:2645 ../fish/guestfish-actions.pod:1803
10742 "Note that keys are drive letters. For Windows, the key is case insensitive "
10743 "and just contains the drive letter, without the customary colon separator "
10748 #: ../src/guestfs-actions.pod:2649 ../fish/guestfish-actions.pod:1807
10750 "In future we may support other operating systems that also used drive "
10751 "letters, but the keys for those might not be case insensitive and might be "
10752 "longer than 1 character. For example in OS-9, hard drives were named C<h0>, "
10757 #: ../src/guestfs-actions.pod:2654 ../fish/guestfish-actions.pod:1812
10759 "For Windows guests, currently only hard drive mappings are returned. "
10760 "Removable disks (eg. DVD-ROMs) are ignored."
10764 #: ../src/guestfs-actions.pod:2657 ../fish/guestfish-actions.pod:1815
10766 "For guests that do not use drive mappings, or if the drive mappings could "
10767 "not be determined, this returns an empty hash table."
10771 #: ../src/guestfs-actions.pod:2660
10773 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
10774 "C<guestfs_inspect_get_mountpoints>, C<guestfs_inspect_get_filesystems>."
10778 #: ../src/guestfs-actions.pod:2664 ../src/guestfs-actions.pod:2840
10779 #: ../src/guestfs-actions.pod:3600 ../src/guestfs-actions.pod:4810
10780 #: ../src/guestfs-actions.pod:6715
10782 "This function returns a NULL-terminated array of strings, or NULL if there "
10783 "was an error. The array of strings will always have length C<2n+1>, where "
10784 "C<n> keys and values alternate, followed by the trailing NULL entry. I<The "
10785 "caller must free the strings and the array after use>."
10789 #: ../src/guestfs-actions.pod:2670
10790 msgid "guestfs_inspect_get_filesystems"
10794 #: ../src/guestfs-actions.pod:2672
10798 " guestfs_inspect_get_filesystems (guestfs_h *g,\n"
10799 " const char *root);\n"
10804 #: ../src/guestfs-actions.pod:2679 ../fish/guestfish-actions.pod:1829
10806 "This returns a list of all the filesystems that we think are associated with "
10807 "this operating system. This includes the root filesystem, other ordinary "
10808 "filesystems, and non-mounted devices like swap partitions."
10812 #: ../src/guestfs-actions.pod:2684 ../fish/guestfish-actions.pod:1834
10814 "In the case of a multi-boot virtual machine, it is possible for a filesystem "
10815 "to be shared between operating systems."
10819 #: ../src/guestfs-actions.pod:2687
10821 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
10822 "C<guestfs_inspect_get_mountpoints>."
10826 #: ../src/guestfs-actions.pod:2696
10827 msgid "guestfs_inspect_get_format"
10831 #: ../src/guestfs-actions.pod:2698
10835 " guestfs_inspect_get_format (guestfs_h *g,\n"
10836 " const char *root);\n"
10841 #: ../src/guestfs-actions.pod:2705 ../fish/guestfish-actions.pod:1847
10843 "This returns the format of the inspected operating system. You can use it "
10844 "to detect install images, live CDs and similar."
10848 #: ../src/guestfs-actions.pod:2708 ../fish/guestfish-actions.pod:1850
10849 msgid "Currently defined formats are:"
10853 #: ../src/guestfs-actions.pod:2712 ../fish/guestfish-actions.pod:1854
10854 msgid "\"installed\""
10855 msgstr "\"installed\""
10858 #: ../src/guestfs-actions.pod:2714 ../fish/guestfish-actions.pod:1856
10859 msgid "This is an installed operating system."
10860 msgstr "Це встановлена операційна система."
10863 #: ../src/guestfs-actions.pod:2716 ../fish/guestfish-actions.pod:1858
10864 msgid "\"installer\""
10868 #: ../src/guestfs-actions.pod:2718 ../fish/guestfish-actions.pod:1860
10870 "The disk image being inspected is not an installed operating system, but a "
10871 "I<bootable> install disk, live CD, or similar."
10875 #: ../src/guestfs-actions.pod:2723 ../fish/guestfish-actions.pod:1865
10876 msgid "The format of this disk image is not known."
10880 #: ../src/guestfs-actions.pod:2735
10881 msgid "guestfs_inspect_get_hostname"
10885 #: ../src/guestfs-actions.pod:2737
10889 " guestfs_inspect_get_hostname (guestfs_h *g,\n"
10890 " const char *root);\n"
10895 #: ../src/guestfs-actions.pod:2744 ../fish/guestfish-actions.pod:1881
10897 "This function returns the hostname of the operating system as found by "
10898 "inspection of the guest's configuration files."
10902 #: ../src/guestfs-actions.pod:2747 ../fish/guestfish-actions.pod:1884
10904 "If the hostname could not be determined, then the string C<unknown> is "
10909 #: ../src/guestfs-actions.pod:2755
10910 msgid "(Added in 1.7.9)"
10914 #: ../src/guestfs-actions.pod:2757
10915 msgid "guestfs_inspect_get_major_version"
10919 #: ../src/guestfs-actions.pod:2759
10923 " guestfs_inspect_get_major_version (guestfs_h *g,\n"
10924 " const char *root);\n"
10929 #: ../src/guestfs-actions.pod:2766 ../fish/guestfish-actions.pod:1896
10931 "This returns the major version number of the inspected operating system."
10935 #: ../src/guestfs-actions.pod:2769 ../fish/guestfish-actions.pod:1899
10937 "Windows uses a consistent versioning scheme which is I<not> reflected in the "
10938 "popular public names used by the operating system. Notably the operating "
10939 "system known as \"Windows 7\" is really version 6.1 (ie. major = 6, minor = "
10940 "1). You can find out the real versions corresponding to releases of Windows "
10941 "by consulting Wikipedia or MSDN."
10945 #: ../src/guestfs-actions.pod:2776 ../src/guestfs-actions.pod:2796
10946 #: ../fish/guestfish-actions.pod:1906 ../fish/guestfish-actions.pod:1920
10947 msgid "If the version could not be determined, then C<0> is returned."
10951 #: ../src/guestfs-actions.pod:2784
10952 msgid "guestfs_inspect_get_minor_version"
10956 #: ../src/guestfs-actions.pod:2786
10960 " guestfs_inspect_get_minor_version (guestfs_h *g,\n"
10961 " const char *root);\n"
10966 #: ../src/guestfs-actions.pod:2793 ../fish/guestfish-actions.pod:1917
10968 "This returns the minor version number of the inspected operating system."
10972 #: ../src/guestfs-actions.pod:2798
10974 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
10975 "C<guestfs_inspect_get_major_version>."
10979 #: ../src/guestfs-actions.pod:2805
10980 msgid "guestfs_inspect_get_mountpoints"
10984 #: ../src/guestfs-actions.pod:2807
10988 " guestfs_inspect_get_mountpoints (guestfs_h *g,\n"
10989 " const char *root);\n"
10994 #: ../src/guestfs-actions.pod:2814 ../fish/guestfish-actions.pod:1932
10996 "This returns a hash of where we think the filesystems associated with this "
10997 "operating system should be mounted. Callers should note that this is at "
10998 "best an educated guess made by reading configuration files such as C</etc/"
10999 "fstab>. I<In particular note> that this may return filesystems which are "
11000 "non-existent or not mountable and callers should be prepared to handle or "
11001 "ignore failures if they try to mount them."
11005 #: ../src/guestfs-actions.pod:2823 ../fish/guestfish-actions.pod:1941
11007 "Each element in the returned hashtable has a key which is the path of the "
11008 "mountpoint (eg. C</boot>) and a value which is the filesystem that would be "
11009 "mounted there (eg. C</dev/sda1>)."
11013 #: ../src/guestfs-actions.pod:2828 ../fish/guestfish-actions.pod:1946
11015 "Non-mounted devices such as swap devices are I<not> returned in this list."
11019 #: ../src/guestfs-actions.pod:2831
11021 "For operating systems like Windows which still use drive letters, this call "
11022 "will only return an entry for the first drive \"mounted on\" C</>. For "
11023 "information about the mapping of drive letters to partitions, see "
11024 "C<guestfs_inspect_get_drive_mappings>."
11028 #: ../src/guestfs-actions.pod:2837
11030 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
11031 "C<guestfs_inspect_get_filesystems>."
11035 #: ../src/guestfs-actions.pod:2848
11036 msgid "guestfs_inspect_get_package_format"
11040 #: ../src/guestfs-actions.pod:2850
11044 " guestfs_inspect_get_package_format (guestfs_h *g,\n"
11045 " const char *root);\n"
11050 #: ../src/guestfs-actions.pod:2857
11052 "This function and C<guestfs_inspect_get_package_management> return the "
11053 "package format and package management tool used by the inspected operating "
11054 "system. For example for Fedora these functions would return C<rpm> (package "
11055 "format) and C<yum> (package management)."
11059 #: ../src/guestfs-actions.pod:2863 ../fish/guestfish-actions.pod:1971
11061 "This returns the string C<unknown> if we could not determine the package "
11062 "format I<or> if the operating system does not have a real packaging system "
11067 #: ../src/guestfs-actions.pod:2867 ../fish/guestfish-actions.pod:1975
11069 "Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>. "
11070 "Future versions of libguestfs may return other strings."
11074 #: ../src/guestfs-actions.pod:2875 ../src/guestfs-actions.pod:2906
11075 msgid "(Added in 1.7.5)"
11079 #: ../src/guestfs-actions.pod:2877
11080 msgid "guestfs_inspect_get_package_management"
11084 #: ../src/guestfs-actions.pod:2879
11088 " guestfs_inspect_get_package_management (guestfs_h *g,\n"
11089 " const char *root);\n"
11094 #: ../src/guestfs-actions.pod:2886
11096 "C<guestfs_inspect_get_package_format> and this function return the package "
11097 "format and package management tool used by the inspected operating system. "
11098 "For example for Fedora these functions would return C<rpm> (package format) "
11099 "and C<yum> (package management)."
11103 #: ../src/guestfs-actions.pod:2892 ../fish/guestfish-actions.pod:1993
11105 "This returns the string C<unknown> if we could not determine the package "
11106 "management tool I<or> if the operating system does not have a real packaging "
11107 "system (eg. Windows)."
11111 #: ../src/guestfs-actions.pod:2896 ../fish/guestfish-actions.pod:1997
11113 "Possible strings include: C<yum>, C<up2date>, C<apt> (for all Debian "
11114 "derivatives), C<portage>, C<pisi>, C<pacman>, C<urpmi>. Future versions of "
11115 "libguestfs may return other strings."
11119 #: ../src/guestfs-actions.pod:2908
11120 msgid "guestfs_inspect_get_product_name"
11124 #: ../src/guestfs-actions.pod:2910
11128 " guestfs_inspect_get_product_name (guestfs_h *g,\n"
11129 " const char *root);\n"
11134 #: ../src/guestfs-actions.pod:2917 ../fish/guestfish-actions.pod:2011
11136 "This returns the product name of the inspected operating system. The "
11137 "product name is generally some freeform string which can be displayed to the "
11138 "user, but should not be parsed by programs."
11142 #: ../src/guestfs-actions.pod:2922 ../fish/guestfish-actions.pod:2016
11144 "If the product name could not be determined, then the string C<unknown> is "
11149 #: ../src/guestfs-actions.pod:2932
11150 msgid "guestfs_inspect_get_product_variant"
11154 #: ../src/guestfs-actions.pod:2934
11158 " guestfs_inspect_get_product_variant (guestfs_h *g,\n"
11159 " const char *root);\n"
11164 #: ../src/guestfs-actions.pod:2941 ../fish/guestfish-actions.pod:2028
11166 #| msgid "This is an installed operating system."
11167 msgid "This returns the product variant of the inspected operating system."
11168 msgstr "Це встановлена операційна система."
11171 #: ../src/guestfs-actions.pod:2944 ../fish/guestfish-actions.pod:2031
11173 "For Windows guests, this returns the contents of the Registry key C<HKLM"
11174 "\\Software\\Microsoft\\Windows NT\\CurrentVersion> C<InstallationType> which "
11175 "is usually a string such as C<Client> or C<Server> (other values are "
11176 "possible). This can be used to distinguish consumer and enterprise versions "
11177 "of Windows that have the same version number (for example, Windows 7 and "
11178 "Windows 2008 Server are both version 6.1, but the former is C<Client> and "
11179 "the latter is C<Server>)."
11183 #: ../src/guestfs-actions.pod:2953 ../fish/guestfish-actions.pod:2040
11185 "For enterprise Linux guests, in future we intend this to return the product "
11186 "variant such as C<Desktop>, C<Server> and so on. But this is not "
11187 "implemented at present."
11191 #: ../src/guestfs-actions.pod:2957 ../fish/guestfish-actions.pod:2044
11193 "If the product variant could not be determined, then the string C<unknown> "
11198 #: ../src/guestfs-actions.pod:2960
11200 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
11201 "C<guestfs_inspect_get_product_name>, C<guestfs_inspect_get_major_version>."
11205 #: ../src/guestfs-actions.pod:2967
11206 msgid "guestfs_inspect_get_roots"
11210 #: ../src/guestfs-actions.pod:2969
11214 " guestfs_inspect_get_roots (guestfs_h *g);\n"
11219 #: ../src/guestfs-actions.pod:2972
11221 "This function is a convenient way to get the list of root devices, as "
11222 "returned from a previous call to C<guestfs_inspect_os>, but without redoing "
11223 "the whole inspection process."
11227 #: ../src/guestfs-actions.pod:2976
11229 "This returns an empty list if either no root devices were found or the "
11230 "caller has not called C<guestfs_inspect_os>."
11234 #: ../src/guestfs-actions.pod:2985
11235 msgid "(Added in 1.7.3)"
11239 #: ../src/guestfs-actions.pod:2987
11240 msgid "guestfs_inspect_get_type"
11244 #: ../src/guestfs-actions.pod:2989
11248 " guestfs_inspect_get_type (guestfs_h *g,\n"
11249 " const char *root);\n"
11254 #: ../src/guestfs-actions.pod:2996 ../fish/guestfish-actions.pod:2071
11256 "This returns the type of the inspected operating system. Currently defined "
11261 #: ../src/guestfs-actions.pod:3001 ../fish/guestfish-actions.pod:2076
11266 #: ../src/guestfs-actions.pod:3003 ../fish/guestfish-actions.pod:2078
11267 msgid "Any Linux-based operating system."
11271 #: ../src/guestfs-actions.pod:3007 ../fish/guestfish-actions.pod:2082
11272 msgid "Any Microsoft Windows operating system."
11276 #: ../src/guestfs-actions.pod:3009 ../fish/guestfish-actions.pod:2084
11277 msgid "\"freebsd\""
11278 msgstr "\"freebsd\""
11281 #: ../src/guestfs-actions.pod:3011 ../fish/guestfish-actions.pod:2086
11286 #: ../src/guestfs-actions.pod:3015 ../fish/guestfish-actions.pod:2090
11287 msgid "The operating system type could not be determined."
11291 #: ../src/guestfs-actions.pod:3029
11292 msgid "guestfs_inspect_get_windows_current_control_set"
11296 #: ../src/guestfs-actions.pod:3031
11300 " guestfs_inspect_get_windows_current_control_set (guestfs_h *g,\n"
11301 " const char *root);\n"
11306 #: ../src/guestfs-actions.pod:3038 ../fish/guestfish-actions.pod:2106
11308 "This returns the Windows CurrentControlSet of the inspected guest. The "
11309 "CurrentControlSet is a registry key name such as C<ControlSet001>."
11313 #: ../src/guestfs-actions.pod:3041 ../fish/guestfish-actions.pod:2109
11315 "This call assumes that the guest is Windows and that the Registry could be "
11316 "examined by inspection. If this is not the case then an error is returned."
11320 #: ../src/guestfs-actions.pod:3050
11321 msgid "guestfs_inspect_get_windows_systemroot"
11325 #: ../src/guestfs-actions.pod:3052
11329 " guestfs_inspect_get_windows_systemroot (guestfs_h *g,\n"
11330 " const char *root);\n"
11335 #: ../src/guestfs-actions.pod:3059 ../fish/guestfish-actions.pod:2122
11337 "This returns the Windows systemroot of the inspected guest. The systemroot "
11338 "is a directory path such as C</WINDOWS>."
11342 #: ../src/guestfs-actions.pod:3062 ../fish/guestfish-actions.pod:2125
11344 "This call assumes that the guest is Windows and that the systemroot could be "
11345 "determined by inspection. If this is not the case then an error is returned."
11349 #: ../src/guestfs-actions.pod:3071
11350 msgid "(Added in 1.5.25)"
11354 #: ../src/guestfs-actions.pod:3073
11355 msgid "guestfs_inspect_is_live"
11359 #: ../src/guestfs-actions.pod:3075
11363 " guestfs_inspect_is_live (guestfs_h *g,\n"
11364 " const char *root);\n"
11369 #: ../src/guestfs-actions.pod:3082
11371 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
11372 "disk), then this returns true if a live image was detected on the disk."
11376 #: ../src/guestfs-actions.pod:3090
11377 msgid "guestfs_inspect_is_multipart"
11381 #: ../src/guestfs-actions.pod:3092
11385 " guestfs_inspect_is_multipart (guestfs_h *g,\n"
11386 " const char *root);\n"
11391 #: ../src/guestfs-actions.pod:3099
11393 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
11394 "disk), then this returns true if the disk is part of a set."
11398 #: ../src/guestfs-actions.pod:3107
11399 msgid "guestfs_inspect_is_netinst"
11403 #: ../src/guestfs-actions.pod:3109
11407 " guestfs_inspect_is_netinst (guestfs_h *g,\n"
11408 " const char *root);\n"
11413 #: ../src/guestfs-actions.pod:3116
11415 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
11416 "disk), then this returns true if the disk is a network installer, ie. not a "
11417 "self-contained install CD but one which is likely to require network access "
11418 "to complete the install."
11422 #: ../src/guestfs-actions.pod:3126
11423 msgid "guestfs_inspect_list_applications"
11427 #: ../src/guestfs-actions.pod:3128
11430 " struct guestfs_application_list *\n"
11431 " guestfs_inspect_list_applications (guestfs_h *g,\n"
11432 " const char *root);\n"
11437 #: ../src/guestfs-actions.pod:3135 ../fish/guestfish-actions.pod:2179
11438 msgid "Return the list of applications installed in the operating system."
11442 #: ../src/guestfs-actions.pod:3137
11444 "I<Note:> This call works differently from other parts of the inspection "
11445 "API. You have to call C<guestfs_inspect_os>, then "
11446 "C<guestfs_inspect_get_mountpoints>, then mount up the disks, before calling "
11447 "this. Listing applications is a significantly more difficult operation "
11448 "which requires access to the full filesystem. Also note that unlike the "
11449 "other C<guestfs_inspect_get_*> calls which are just returning data cached in "
11450 "the libguestfs handle, this call actually reads parts of the mounted "
11451 "filesystems during the call."
11455 #: ../src/guestfs-actions.pod:3147 ../fish/guestfish-actions.pod:2191
11457 "This returns an empty list if the inspection code was not able to determine "
11458 "the list of applications."
11462 #: ../src/guestfs-actions.pod:3150 ../fish/guestfish-actions.pod:2194
11463 msgid "The application structure contains the following fields:"
11467 #: ../src/guestfs-actions.pod:3154 ../fish/guestfish-actions.pod:2198
11468 msgid "C<app_name>"
11469 msgstr "C<app_name>"
11472 #: ../src/guestfs-actions.pod:3156 ../fish/guestfish-actions.pod:2200
11474 "The name of the application. For Red Hat-derived and Debian-derived Linux "
11475 "guests, this is the package name."
11479 #: ../src/guestfs-actions.pod:3159 ../fish/guestfish-actions.pod:2203
11480 msgid "C<app_display_name>"
11481 msgstr "C<app_display_name>"
11484 #: ../src/guestfs-actions.pod:3161 ../fish/guestfish-actions.pod:2205
11486 "The display name of the application, sometimes localized to the install "
11487 "language of the guest operating system."
11491 #: ../src/guestfs-actions.pod:3164 ../fish/guestfish-actions.pod:2208
11493 "If unavailable this is returned as an empty string C<\"\">. Callers needing "
11494 "to display something can use C<app_name> instead."
11498 #: ../src/guestfs-actions.pod:3167 ../fish/guestfish-actions.pod:2211
11499 msgid "C<app_epoch>"
11500 msgstr "C<app_epoch>"
11503 #: ../src/guestfs-actions.pod:3169 ../fish/guestfish-actions.pod:2213
11505 "For package managers which use epochs, this contains the epoch of the "
11506 "package (an integer). If unavailable, this is returned as C<0>."
11510 #: ../src/guestfs-actions.pod:3172 ../fish/guestfish-actions.pod:2216
11511 msgid "C<app_version>"
11512 msgstr "C<app_version>"
11515 #: ../src/guestfs-actions.pod:3174 ../fish/guestfish-actions.pod:2218
11517 "The version string of the application or package. If unavailable this is "
11518 "returned as an empty string C<\"\">."
11522 #: ../src/guestfs-actions.pod:3177 ../fish/guestfish-actions.pod:2221
11523 msgid "C<app_release>"
11524 msgstr "C<app_release>"
11527 #: ../src/guestfs-actions.pod:3179 ../fish/guestfish-actions.pod:2223
11529 "The release string of the application or package, for package managers that "
11530 "use this. If unavailable this is returned as an empty string C<\"\">."
11534 #: ../src/guestfs-actions.pod:3183 ../fish/guestfish-actions.pod:2227
11535 msgid "C<app_install_path>"
11536 msgstr "C<app_install_path>"
11539 #: ../src/guestfs-actions.pod:3185 ../fish/guestfish-actions.pod:2229
11541 "The installation path of the application (on operating systems such as "
11542 "Windows which use installation paths). This path is in the format used by "
11543 "the guest operating system, it is not a libguestfs path."
11547 #: ../src/guestfs-actions.pod:3190 ../fish/guestfish-actions.pod:2234
11548 msgid "If unavailable this is returned as an empty string C<\"\">."
11552 #: ../src/guestfs-actions.pod:3192 ../fish/guestfish-actions.pod:2236
11553 msgid "C<app_trans_path>"
11554 msgstr "C<app_trans_path>"
11557 #: ../src/guestfs-actions.pod:3194 ../fish/guestfish-actions.pod:2238
11559 "The install path translated into a libguestfs path. If unavailable this is "
11560 "returned as an empty string C<\"\">."
11564 #: ../src/guestfs-actions.pod:3197 ../fish/guestfish-actions.pod:2241
11565 msgid "C<app_publisher>"
11566 msgstr "C<app_publisher>"
11569 #: ../src/guestfs-actions.pod:3199 ../fish/guestfish-actions.pod:2243
11571 "The name of the publisher of the application, for package managers that use "
11572 "this. If unavailable this is returned as an empty string C<\"\">."
11576 #: ../src/guestfs-actions.pod:3203 ../fish/guestfish-actions.pod:2247
11578 msgstr "C<app_url>"
11581 #: ../src/guestfs-actions.pod:3205 ../fish/guestfish-actions.pod:2249
11583 "The URL (eg. upstream URL) of the application. If unavailable this is "
11584 "returned as an empty string C<\"\">."
11588 #: ../src/guestfs-actions.pod:3208 ../fish/guestfish-actions.pod:2252
11589 msgid "C<app_source_package>"
11593 #: ../src/guestfs-actions.pod:3210 ../fish/guestfish-actions.pod:2254
11595 "For packaging systems which support this, the name of the source package. "
11596 "If unavailable this is returned as an empty string C<\"\">."
11600 #: ../src/guestfs-actions.pod:3213 ../fish/guestfish-actions.pod:2257
11601 msgid "C<app_summary>"
11605 #: ../src/guestfs-actions.pod:3215 ../fish/guestfish-actions.pod:2259
11607 "A short (usually one line) description of the application or package. If "
11608 "unavailable this is returned as an empty string C<\"\">."
11612 #: ../src/guestfs-actions.pod:3218 ../fish/guestfish-actions.pod:2262
11613 msgid "C<app_description>"
11617 #: ../src/guestfs-actions.pod:3220 ../fish/guestfish-actions.pod:2264
11619 "A longer description of the application or package. If unavailable this is "
11620 "returned as an empty string C<\"\">."
11624 #: ../src/guestfs-actions.pod:3227
11626 "This function returns a C<struct guestfs_application_list *>, or NULL if "
11627 "there was an error. I<The caller must call C<guestfs_free_application_list> "
11632 #: ../src/guestfs-actions.pod:3231
11633 msgid "(Added in 1.7.8)"
11637 #: ../src/guestfs-actions.pod:3233
11638 msgid "guestfs_inspect_os"
11642 #: ../src/guestfs-actions.pod:3235
11646 " guestfs_inspect_os (guestfs_h *g);\n"
11651 #: ../src/guestfs-actions.pod:3238 ../fish/guestfish-actions.pod:2275
11653 "This function uses other libguestfs functions and certain heuristics to "
11654 "inspect the disk(s) (usually disks belonging to a virtual machine), looking "
11655 "for operating systems."
11659 #: ../src/guestfs-actions.pod:3242 ../fish/guestfish-actions.pod:2279
11660 msgid "The list returned is empty if no operating systems were found."
11664 #: ../src/guestfs-actions.pod:3244 ../fish/guestfish-actions.pod:2281
11666 "If one operating system was found, then this returns a list with a single "
11667 "element, which is the name of the root filesystem of this operating system. "
11668 "It is also possible for this function to return a list containing more than "
11669 "one element, indicating a dual-boot or multi-boot virtual machine, with each "
11670 "element being the root filesystem of one of the operating systems."
11674 #: ../src/guestfs-actions.pod:3251
11676 "You can pass the root string(s) returned to other C<guestfs_inspect_get_*> "
11677 "functions in order to query further information about each operating system, "
11678 "such as the name and version."
11682 #: ../src/guestfs-actions.pod:3256
11684 "This function uses other libguestfs features such as C<guestfs_mount_ro> and "
11685 "C<guestfs_umount_all> in order to mount and unmount filesystems and look at "
11686 "the contents. This should be called with no disks currently mounted. The "
11687 "function may also use Augeas, so any existing Augeas handle will be closed."
11691 #: ../src/guestfs-actions.pod:3262 ../fish/guestfish-actions.pod:2299
11693 "This function cannot decrypt encrypted disks. The caller must do that first "
11694 "(supplying the necessary keys) if the disk is encrypted."
11698 #: ../src/guestfs-actions.pod:3268 ../src/guestfs-actions.pod:3558
11699 #: ../src/guestfs-actions.pod:3620
11700 msgid "See also C<guestfs_list_filesystems>."
11704 #: ../src/guestfs-actions.pod:3276
11705 msgid "guestfs_is_blockdev"
11709 #: ../src/guestfs-actions.pod:3278
11713 " guestfs_is_blockdev (guestfs_h *g,\n"
11714 " const char *path);\n"
11719 #: ../src/guestfs-actions.pod:3282 ../fish/guestfish-actions.pod:2311
11721 "This returns C<true> if and only if there is a block device with the given "
11726 #: ../src/guestfs-actions.pod:3285 ../src/guestfs-actions.pod:3314
11727 #: ../src/guestfs-actions.pod:3344 ../src/guestfs-actions.pod:3359
11728 #: ../src/guestfs-actions.pod:3375 ../src/guestfs-actions.pod:3431
11729 #: ../src/guestfs-actions.pod:3446
11730 msgid "See also C<guestfs_stat>."
11734 #: ../src/guestfs-actions.pod:3289 ../src/guestfs-actions.pod:3318
11735 #: ../src/guestfs-actions.pod:3363 ../src/guestfs-actions.pod:3435
11736 #: ../src/guestfs-actions.pod:3450
11737 msgid "(Added in 1.5.10)"
11741 #: ../src/guestfs-actions.pod:3291
11742 msgid "guestfs_is_busy"
11746 #: ../src/guestfs-actions.pod:3293
11750 " guestfs_is_busy (guestfs_h *g);\n"
11755 #: ../src/guestfs-actions.pod:3296 ../fish/guestfish-actions.pod:2320
11757 "This returns true iff this handle is busy processing a command (in the "
11762 #: ../src/guestfs-actions.pod:3305
11763 msgid "guestfs_is_chardev"
11767 #: ../src/guestfs-actions.pod:3307
11771 " guestfs_is_chardev (guestfs_h *g,\n"
11772 " const char *path);\n"
11777 #: ../src/guestfs-actions.pod:3311 ../fish/guestfish-actions.pod:2329
11779 "This returns C<true> if and only if there is a character device with the "
11780 "given C<path> name."
11784 #: ../src/guestfs-actions.pod:3320
11785 msgid "guestfs_is_config"
11789 #: ../src/guestfs-actions.pod:3322
11793 " guestfs_is_config (guestfs_h *g);\n"
11798 #: ../src/guestfs-actions.pod:3325 ../fish/guestfish-actions.pod:2338
11800 "This returns true iff this handle is being configured (in the C<CONFIG> "
11805 #: ../src/guestfs-actions.pod:3334
11806 msgid "guestfs_is_dir"
11810 #: ../src/guestfs-actions.pod:3336
11814 " guestfs_is_dir (guestfs_h *g,\n"
11815 " const char *path);\n"
11820 #: ../src/guestfs-actions.pod:3340 ../fish/guestfish-actions.pod:2347
11822 "This returns C<true> if and only if there is a directory with the given "
11823 "C<path> name. Note that it returns false for other objects like files."
11827 #: ../src/guestfs-actions.pod:3350
11828 msgid "guestfs_is_fifo"
11832 #: ../src/guestfs-actions.pod:3352
11836 " guestfs_is_fifo (guestfs_h *g,\n"
11837 " const char *path);\n"
11842 #: ../src/guestfs-actions.pod:3356 ../fish/guestfish-actions.pod:2357
11844 "This returns C<true> if and only if there is a FIFO (named pipe) with the "
11845 "given C<path> name."
11849 #: ../src/guestfs-actions.pod:3365
11850 msgid "guestfs_is_file"
11854 #: ../src/guestfs-actions.pod:3367
11858 " guestfs_is_file (guestfs_h *g,\n"
11859 " const char *path);\n"
11864 #: ../src/guestfs-actions.pod:3371 ../fish/guestfish-actions.pod:2366
11866 "This returns C<true> if and only if there is a regular file with the given "
11867 "C<path> name. Note that it returns false for other objects like directories."
11871 #: ../src/guestfs-actions.pod:3381
11872 msgid "guestfs_is_launching"
11876 #: ../src/guestfs-actions.pod:3383
11880 " guestfs_is_launching (guestfs_h *g);\n"
11885 #: ../src/guestfs-actions.pod:3386 ../fish/guestfish-actions.pod:2376
11887 "This returns true iff this handle is launching the subprocess (in the "
11888 "C<LAUNCHING> state)."
11892 #: ../src/guestfs-actions.pod:3395
11893 msgid "guestfs_is_lv"
11897 #: ../src/guestfs-actions.pod:3397
11901 " guestfs_is_lv (guestfs_h *g,\n"
11902 " const char *device);\n"
11907 #: ../src/guestfs-actions.pod:3401 ../fish/guestfish-actions.pod:2385
11909 "This command tests whether C<device> is a logical volume, and returns true "
11910 "iff this is the case."
11914 #: ../src/guestfs-actions.pod:3408
11915 msgid "guestfs_is_ready"
11919 #: ../src/guestfs-actions.pod:3410
11923 " guestfs_is_ready (guestfs_h *g);\n"
11928 #: ../src/guestfs-actions.pod:3413 ../fish/guestfish-actions.pod:2392
11930 "This returns true iff this handle is ready to accept commands (in the "
11935 #: ../src/guestfs-actions.pod:3422
11936 msgid "guestfs_is_socket"
11940 #: ../src/guestfs-actions.pod:3424
11944 " guestfs_is_socket (guestfs_h *g,\n"
11945 " const char *path);\n"
11950 #: ../src/guestfs-actions.pod:3428 ../fish/guestfish-actions.pod:2401
11952 "This returns C<true> if and only if there is a Unix domain socket with the "
11953 "given C<path> name."
11957 #: ../src/guestfs-actions.pod:3437
11958 msgid "guestfs_is_symlink"
11962 #: ../src/guestfs-actions.pod:3439
11966 " guestfs_is_symlink (guestfs_h *g,\n"
11967 " const char *path);\n"
11972 #: ../src/guestfs-actions.pod:3443 ../fish/guestfish-actions.pod:2410
11974 "This returns C<true> if and only if there is a symbolic link with the given "
11979 #: ../src/guestfs-actions.pod:3452
11980 msgid "guestfs_kill_subprocess"
11984 #: ../src/guestfs-actions.pod:3454
11988 " guestfs_kill_subprocess (guestfs_h *g);\n"
11993 #: ../src/guestfs-actions.pod:3457 ../fish/guestfish-actions.pod:2419
11994 msgid "This kills the qemu subprocess. You should never need to call this."
11998 #: ../src/guestfs-actions.pod:3463
11999 msgid "guestfs_launch"
12003 #: ../src/guestfs-actions.pod:3465
12007 " guestfs_launch (guestfs_h *g);\n"
12012 #: ../src/guestfs-actions.pod:3468 ../fish/guestfish-actions.pod:2427
12014 "Internally libguestfs is implemented by running a virtual machine using "
12019 #: ../src/guestfs-actions.pod:3471 ../fish/guestfish-actions.pod:2430
12021 "You should call this after configuring the handle (eg. adding drives) but "
12022 "before performing any actions."
12026 #: ../src/guestfs-actions.pod:3483
12027 msgid "guestfs_lchown"
12031 #: ../src/guestfs-actions.pod:3485
12035 " guestfs_lchown (guestfs_h *g,\n"
12038 " const char *path);\n"
12043 #: ../src/guestfs-actions.pod:3491
12045 "Change the file owner to C<owner> and group to C<group>. This is like "
12046 "C<guestfs_chown> but if C<path> is a symlink then the link itself is "
12047 "changed, not the target."
12051 #: ../src/guestfs-actions.pod:3503
12052 msgid "guestfs_lgetxattr"
12056 #: ../src/guestfs-actions.pod:3505
12060 " guestfs_lgetxattr (guestfs_h *g,\n"
12061 " const char *path,\n"
12062 " const char *name,\n"
12063 " size_t *size_r);\n"
12068 #: ../src/guestfs-actions.pod:3511 ../fish/guestfish-actions.pod:2449
12070 "Get a single extended attribute from file C<path> named C<name>. If C<path> "
12071 "is a symlink, then this call returns an extended attribute from the symlink."
12075 #: ../src/guestfs-actions.pod:3525
12076 msgid "See also: C<guestfs_lgetxattrs>, C<guestfs_getxattr>, L<attr(5)>."
12080 #: ../src/guestfs-actions.pod:3533
12081 msgid "guestfs_lgetxattrs"
12085 #: ../src/guestfs-actions.pod:3535
12088 " struct guestfs_xattr_list *\n"
12089 " guestfs_lgetxattrs (guestfs_h *g,\n"
12090 " const char *path);\n"
12095 #: ../src/guestfs-actions.pod:3539
12097 "This is the same as C<guestfs_getxattrs>, but if C<path> is a symbolic link, "
12098 "then it returns the extended attributes of the link itself."
12102 #: ../src/guestfs-actions.pod:3549
12103 msgid "guestfs_list_devices"
12107 #: ../src/guestfs-actions.pod:3551
12111 " guestfs_list_devices (guestfs_h *g);\n"
12116 #: ../src/guestfs-actions.pod:3554 ../fish/guestfish-actions.pod:2477
12117 msgid "List all the block devices."
12121 #: ../src/guestfs-actions.pod:3556 ../fish/guestfish-actions.pod:2479
12122 msgid "The full block device names are returned, eg. C</dev/sda>."
12126 #: ../src/guestfs-actions.pod:3566
12127 msgid "guestfs_list_filesystems"
12131 #: ../src/guestfs-actions.pod:3568
12135 " guestfs_list_filesystems (guestfs_h *g);\n"
12140 #: ../src/guestfs-actions.pod:3571 ../fish/guestfish-actions.pod:2487
12142 "This inspection command looks for filesystems on partitions, block devices "
12143 "and logical volumes, returning a list of devices containing filesystems and "
12148 #: ../src/guestfs-actions.pod:3575 ../fish/guestfish-actions.pod:2491
12150 "The return value is a hash, where the keys are the devices containing "
12151 "filesystems, and the values are the filesystem types. For example:"
12155 #: ../src/guestfs-actions.pod:3579 ../fish/guestfish-actions.pod:2495
12158 " \"/dev/sda1\" => \"ntfs\"\n"
12159 " \"/dev/sda2\" => \"ext2\"\n"
12160 " \"/dev/vg_guest/lv_root\" => \"ext4\"\n"
12161 " \"/dev/vg_guest/lv_swap\" => \"swap\"\n"
12166 #: ../src/guestfs-actions.pod:3584 ../fish/guestfish-actions.pod:2500
12168 "The value can have the special value \"unknown\", meaning the content of the "
12169 "device is undetermined or empty. \"swap\" means a Linux swap partition."
12173 #: ../src/guestfs-actions.pod:3588
12175 "This command runs other libguestfs commands, which might include "
12176 "C<guestfs_mount> and C<guestfs_umount>, and therefore you should use this "
12177 "soon after launch and only when nothing is mounted."
12181 #: ../src/guestfs-actions.pod:3592
12183 "Not all of the filesystems returned will be mountable. In particular, swap "
12184 "partitions are returned in the list. Also this command does not check that "
12185 "each filesystem found is valid and mountable, and some filesystems might be "
12186 "mountable but require special options. Filesystems may not all belong to a "
12187 "single logical operating system (use C<guestfs_inspect_os> to look for OSes)."
12191 #: ../src/guestfs-actions.pod:3606 ../src/guestfs-actions.pod:5211
12192 msgid "(Added in 1.5.15)"
12196 #: ../src/guestfs-actions.pod:3608
12197 msgid "guestfs_list_partitions"
12201 #: ../src/guestfs-actions.pod:3610
12205 " guestfs_list_partitions (guestfs_h *g);\n"
12210 #: ../src/guestfs-actions.pod:3613 ../fish/guestfish-actions.pod:2520
12211 msgid "List all the partitions detected on all block devices."
12215 #: ../src/guestfs-actions.pod:3615 ../fish/guestfish-actions.pod:2522
12216 msgid "The full partition device names are returned, eg. C</dev/sda1>"
12220 #: ../src/guestfs-actions.pod:3617
12222 "This does not return logical volumes. For that you will need to call "
12227 #: ../src/guestfs-actions.pod:3628
12232 #: ../src/guestfs-actions.pod:3630
12236 " guestfs_ll (guestfs_h *g,\n"
12237 " const char *directory);\n"
12242 #: ../src/guestfs-actions.pod:3634 ../fish/guestfish-actions.pod:2533
12244 "List the files in C<directory> (relative to the root directory, there is no "
12245 "cwd) in the format of 'ls -la'."
12249 #: ../src/guestfs-actions.pod:3637 ../fish/guestfish-actions.pod:2536
12251 "This command is mostly useful for interactive sessions. It is I<not> "
12252 "intended that you try to parse the output string."
12256 #: ../src/guestfs-actions.pod:3645
12261 #: ../src/guestfs-actions.pod:3647
12265 " guestfs_ln (guestfs_h *g,\n"
12266 " const char *target,\n"
12267 " const char *linkname);\n"
12272 #: ../src/guestfs-actions.pod:3652 ../fish/guestfish-actions.pod:2543
12273 msgid "This command creates a hard link using the C<ln> command."
12277 #: ../src/guestfs-actions.pod:3658
12278 msgid "guestfs_ln_f"
12282 #: ../src/guestfs-actions.pod:3660
12286 " guestfs_ln_f (guestfs_h *g,\n"
12287 " const char *target,\n"
12288 " const char *linkname);\n"
12293 #: ../src/guestfs-actions.pod:3665 ../fish/guestfish-actions.pod:2549
12295 "This command creates a hard link using the C<ln -f> command. The I<-f> "
12296 "option removes the link (C<linkname>) if it exists already."
12300 #: ../src/guestfs-actions.pod:3672
12301 msgid "guestfs_ln_s"
12305 #: ../src/guestfs-actions.pod:3674
12309 " guestfs_ln_s (guestfs_h *g,\n"
12310 " const char *target,\n"
12311 " const char *linkname);\n"
12316 #: ../src/guestfs-actions.pod:3679 ../fish/guestfish-actions.pod:2556
12317 msgid "This command creates a symbolic link using the C<ln -s> command."
12321 #: ../src/guestfs-actions.pod:3685
12322 msgid "guestfs_ln_sf"
12326 #: ../src/guestfs-actions.pod:3687
12330 " guestfs_ln_sf (guestfs_h *g,\n"
12331 " const char *target,\n"
12332 " const char *linkname);\n"
12337 #: ../src/guestfs-actions.pod:3692 ../fish/guestfish-actions.pod:2562
12339 "This command creates a symbolic link using the C<ln -sf> command, The I<-f> "
12340 "option removes the link (C<linkname>) if it exists already."
12344 #: ../src/guestfs-actions.pod:3699
12345 msgid "guestfs_lremovexattr"
12349 #: ../src/guestfs-actions.pod:3701
12353 " guestfs_lremovexattr (guestfs_h *g,\n"
12354 " const char *xattr,\n"
12355 " const char *path);\n"
12360 #: ../src/guestfs-actions.pod:3706
12362 "This is the same as C<guestfs_removexattr>, but if C<path> is a symbolic "
12363 "link, then it removes an extended attribute of the link itself."
12367 #: ../src/guestfs-actions.pod:3714
12372 #: ../src/guestfs-actions.pod:3716
12376 " guestfs_ls (guestfs_h *g,\n"
12377 " const char *directory);\n"
12382 #: ../src/guestfs-actions.pod:3720 ../fish/guestfish-actions.pod:2577
12384 "List the files in C<directory> (relative to the root directory, there is no "
12385 "cwd). The '.' and '..' entries are not returned, but hidden files are shown."
12389 #: ../src/guestfs-actions.pod:3724
12391 "This command is mostly useful for interactive sessions. Programs should "
12392 "probably use C<guestfs_readdir> instead."
12396 #: ../src/guestfs-actions.pod:3733
12397 msgid "guestfs_lsetxattr"
12401 #: ../src/guestfs-actions.pod:3735
12405 " guestfs_lsetxattr (guestfs_h *g,\n"
12406 " const char *xattr,\n"
12407 " const char *val,\n"
12409 " const char *path);\n"
12414 #: ../src/guestfs-actions.pod:3742
12416 "This is the same as C<guestfs_setxattr>, but if C<path> is a symbolic link, "
12417 "then it sets an extended attribute of the link itself."
12421 #: ../src/guestfs-actions.pod:3750
12422 msgid "guestfs_lstat"
12426 #: ../src/guestfs-actions.pod:3752
12429 " struct guestfs_stat *\n"
12430 " guestfs_lstat (guestfs_h *g,\n"
12431 " const char *path);\n"
12436 #: ../src/guestfs-actions.pod:3756 ../src/guestfs-actions.pod:6314
12437 #: ../fish/guestfish-actions.pod:2596 ../fish/guestfish-actions.pod:4265
12438 msgid "Returns file information for the given C<path>."
12442 #: ../src/guestfs-actions.pod:3758
12444 "This is the same as C<guestfs_stat> except that if C<path> is a symbolic "
12445 "link, then the link is stat-ed, not the file it refers to."
12449 #: ../src/guestfs-actions.pod:3762 ../fish/guestfish-actions.pod:2602
12450 msgid "This is the same as the C<lstat(2)> system call."
12454 #: ../src/guestfs-actions.pod:3764 ../src/guestfs-actions.pod:6318
12456 "This function returns a C<struct guestfs_stat *>, or NULL if there was an "
12457 "error. I<The caller must call C<guestfs_free_stat> after use>."
12461 #: ../src/guestfs-actions.pod:3768 ../src/guestfs-actions.pod:6322
12462 #: ../src/guestfs-actions.pod:6340 ../src/guestfs-actions.pod:6721
12463 msgid "(Added in 0.9.2)"
12467 #: ../src/guestfs-actions.pod:3770
12468 msgid "guestfs_lstatlist"
12472 #: ../src/guestfs-actions.pod:3772
12475 " struct guestfs_stat_list *\n"
12476 " guestfs_lstatlist (guestfs_h *g,\n"
12477 " const char *path,\n"
12478 " char *const *names);\n"
12483 #: ../src/guestfs-actions.pod:3777
12485 "This call allows you to perform the C<guestfs_lstat> operation on multiple "
12486 "files, where all files are in the directory C<path>. C<names> is the list "
12487 "of files from this directory."
12491 #: ../src/guestfs-actions.pod:3781 ../fish/guestfish-actions.pod:2612
12493 "On return you get a list of stat structs, with a one-to-one correspondence "
12494 "to the C<names> list. If any name did not exist or could not be lstat'd, "
12495 "then the C<ino> field of that structure is set to C<-1>."
12499 #: ../src/guestfs-actions.pod:3786
12501 "This call is intended for programs that want to efficiently list a directory "
12502 "contents without making many round-trips. See also C<guestfs_lxattrlist> "
12503 "for a similarly efficient call for getting extended attributes. Very long "
12504 "directory listings might cause the protocol message size to be exceeded, "
12505 "causing this call to fail. The caller must split up such requests into "
12506 "smaller groups of names."
12510 #: ../src/guestfs-actions.pod:3794
12512 "This function returns a C<struct guestfs_stat_list *>, or NULL if there was "
12513 "an error. I<The caller must call C<guestfs_free_stat_list> after use>."
12517 #: ../src/guestfs-actions.pod:3800
12518 msgid "guestfs_luks_add_key"
12522 #: ../src/guestfs-actions.pod:3802
12526 " guestfs_luks_add_key (guestfs_h *g,\n"
12527 " const char *device,\n"
12528 " const char *key,\n"
12529 " const char *newkey,\n"
12535 #: ../src/guestfs-actions.pod:3809 ../fish/guestfish-actions.pod:2629
12537 "This command adds a new key on LUKS device C<device>. C<key> is any "
12538 "existing key, and is used to access the device. C<newkey> is the new key to "
12539 "add. C<keyslot> is the key slot that will be replaced."
12543 #: ../src/guestfs-actions.pod:3814
12545 "Note that if C<keyslot> already contains a key, then this command will "
12546 "fail. You have to use C<guestfs_luks_kill_slot> first to remove that key."
12550 #: ../src/guestfs-actions.pod:3820 ../src/guestfs-actions.pod:3860
12551 #: ../src/guestfs-actions.pod:3883 ../src/guestfs-actions.pod:3903
12552 #: ../src/guestfs-actions.pod:3935 ../src/guestfs-actions.pod:3954
12554 "This function takes a key or passphrase parameter which could contain "
12555 "sensitive material. Read the section L</KEYS AND PASSPHRASES> for more "
12560 #: ../src/guestfs-actions.pod:3824 ../src/guestfs-actions.pod:3864
12561 #: ../src/guestfs-actions.pod:3887 ../src/guestfs-actions.pod:3907
12562 msgid "(Added in 1.5.2)"
12566 #: ../src/guestfs-actions.pod:3826
12567 msgid "guestfs_luks_close"
12571 #: ../src/guestfs-actions.pod:3828
12575 " guestfs_luks_close (guestfs_h *g,\n"
12576 " const char *device);\n"
12581 #: ../src/guestfs-actions.pod:3832
12583 "This closes a LUKS device that was created earlier by C<guestfs_luks_open> "
12584 "or C<guestfs_luks_open_ro>. The C<device> parameter must be the name of the "
12585 "LUKS mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
12586 "underlying block device."
12590 #: ../src/guestfs-actions.pod:3840 ../src/guestfs-actions.pod:3939
12591 #: ../src/guestfs-actions.pod:3958 ../src/guestfs-actions.pod:4008
12592 #: ../src/guestfs-actions.pod:4056
12593 msgid "(Added in 1.5.1)"
12597 #: ../src/guestfs-actions.pod:3842
12598 msgid "guestfs_luks_format"
12602 #: ../src/guestfs-actions.pod:3844
12606 " guestfs_luks_format (guestfs_h *g,\n"
12607 " const char *device,\n"
12608 " const char *key,\n"
12614 #: ../src/guestfs-actions.pod:3850 ../fish/guestfish-actions.pod:2655
12616 "This command erases existing data on C<device> and formats the device as a "
12617 "LUKS encrypted device. C<key> is the initial key, which is added to key "
12618 "slot C<slot>. (LUKS supports 8 key slots, numbered 0-7)."
12622 #: ../src/guestfs-actions.pod:3857 ../src/guestfs-actions.pod:3880
12623 #: ../src/guestfs-actions.pod:4020 ../src/guestfs-actions.pod:4962
12624 #: ../src/guestfs-actions.pod:5742 ../src/guestfs-actions.pod:6149
12625 #: ../src/guestfs-actions.pod:6172 ../src/guestfs-actions.pod:6198
12626 #: ../src/guestfs-actions.pod:7358 ../fish/guestfish-actions.pod:2663
12627 #: ../fish/guestfish-actions.pod:2676 ../fish/guestfish-actions.pod:2760
12628 #: ../fish/guestfish-actions.pod:3334 ../fish/guestfish-actions.pod:3854
12629 #: ../fish/guestfish-actions.pod:4164 ../fish/guestfish-actions.pod:4180
12630 #: ../fish/guestfish-actions.pod:4195 ../fish/guestfish-actions.pod:4910
12632 "B<This command is dangerous. Without careful use you can easily destroy all "
12637 #: ../src/guestfs-actions.pod:3866
12638 msgid "guestfs_luks_format_cipher"
12642 #: ../src/guestfs-actions.pod:3868
12646 " guestfs_luks_format_cipher (guestfs_h *g,\n"
12647 " const char *device,\n"
12648 " const char *key,\n"
12650 " const char *cipher);\n"
12655 #: ../src/guestfs-actions.pod:3875
12657 "This command is the same as C<guestfs_luks_format> but it also allows you to "
12658 "set the C<cipher> used."
12662 #: ../src/guestfs-actions.pod:3889
12663 msgid "guestfs_luks_kill_slot"
12667 #: ../src/guestfs-actions.pod:3891
12671 " guestfs_luks_kill_slot (guestfs_h *g,\n"
12672 " const char *device,\n"
12673 " const char *key,\n"
12679 #: ../src/guestfs-actions.pod:3897 ../fish/guestfish-actions.pod:2683
12681 "This command deletes the key in key slot C<keyslot> from the encrypted LUKS "
12682 "device C<device>. C<key> must be one of the I<other> keys."
12686 #: ../src/guestfs-actions.pod:3909
12687 msgid "guestfs_luks_open"
12691 #: ../src/guestfs-actions.pod:3911
12695 " guestfs_luks_open (guestfs_h *g,\n"
12696 " const char *device,\n"
12697 " const char *key,\n"
12698 " const char *mapname);\n"
12703 #: ../src/guestfs-actions.pod:3917 ../fish/guestfish-actions.pod:2694
12705 "This command opens a block device which has been encrypted according to the "
12706 "Linux Unified Key Setup (LUKS) standard."
12710 #: ../src/guestfs-actions.pod:3920 ../fish/guestfish-actions.pod:2697
12711 msgid "C<device> is the encrypted block device or partition."
12715 #: ../src/guestfs-actions.pod:3922 ../fish/guestfish-actions.pod:2699
12717 "The caller must supply one of the keys associated with the LUKS block "
12718 "device, in the C<key> parameter."
12722 #: ../src/guestfs-actions.pod:3925 ../fish/guestfish-actions.pod:2702
12724 "This creates a new block device called C</dev/mapper/mapname>. Reads and "
12725 "writes to this block device are decrypted from and encrypted to the "
12726 "underlying C<device> respectively."
12730 #: ../src/guestfs-actions.pod:3929
12732 "If this block device contains LVM volume groups, then calling "
12733 "C<guestfs_vgscan> followed by C<guestfs_vg_activate_all> will make them "
12738 #: ../src/guestfs-actions.pod:3941
12739 msgid "guestfs_luks_open_ro"
12743 #: ../src/guestfs-actions.pod:3943
12747 " guestfs_luks_open_ro (guestfs_h *g,\n"
12748 " const char *device,\n"
12749 " const char *key,\n"
12750 " const char *mapname);\n"
12755 #: ../src/guestfs-actions.pod:3949
12757 "This is the same as C<guestfs_luks_open> except that a read-only mapping is "
12762 #: ../src/guestfs-actions.pod:3960
12763 msgid "guestfs_lvcreate"
12767 #: ../src/guestfs-actions.pod:3962
12771 " guestfs_lvcreate (guestfs_h *g,\n"
12772 " const char *logvol,\n"
12773 " const char *volgroup,\n"
12779 #: ../src/guestfs-actions.pod:3968 ../fish/guestfish-actions.pod:2727
12781 "This creates an LVM logical volume called C<logvol> on the volume group "
12782 "C<volgroup>, with C<size> megabytes."
12786 #: ../src/guestfs-actions.pod:3975
12787 msgid "guestfs_lvm_canonical_lv_name"
12791 #: ../src/guestfs-actions.pod:3977
12795 " guestfs_lvm_canonical_lv_name (guestfs_h *g,\n"
12796 " const char *lvname);\n"
12801 #: ../src/guestfs-actions.pod:3981 ../fish/guestfish-actions.pod:2734
12803 "This converts alternative naming schemes for LVs that you might find to the "
12804 "canonical name. For example, C</dev/mapper/VG-LV> is converted to C</dev/VG/"
12809 #: ../src/guestfs-actions.pod:3985 ../fish/guestfish-actions.pod:2738
12811 "This command returns an error if the C<lvname> parameter does not refer to a "
12816 #: ../src/guestfs-actions.pod:3988
12817 msgid "See also C<guestfs_is_lv>."
12821 #: ../src/guestfs-actions.pod:3993
12822 msgid "(Added in 1.5.24)"
12826 #: ../src/guestfs-actions.pod:3995
12827 msgid "guestfs_lvm_clear_filter"
12831 #: ../src/guestfs-actions.pod:3997
12835 " guestfs_lvm_clear_filter (guestfs_h *g);\n"
12840 #: ../src/guestfs-actions.pod:4000
12842 "This undoes the effect of C<guestfs_lvm_set_filter>. LVM will be able to "
12843 "see every block device."
12847 #: ../src/guestfs-actions.pod:4003 ../src/guestfs-actions.pod:4045
12848 #: ../fish/guestfish-actions.pod:2750 ../fish/guestfish-actions.pod:2781
12850 "This command also clears the LVM cache and performs a volume group scan."
12854 #: ../src/guestfs-actions.pod:4010
12855 msgid "guestfs_lvm_remove_all"
12859 #: ../src/guestfs-actions.pod:4012
12863 " guestfs_lvm_remove_all (guestfs_h *g);\n"
12868 #: ../src/guestfs-actions.pod:4015 ../fish/guestfish-actions.pod:2757
12870 "This command removes all LVM logical volumes, volume groups and physical "
12875 #: ../src/guestfs-actions.pod:4025
12876 msgid "guestfs_lvm_set_filter"
12880 #: ../src/guestfs-actions.pod:4027
12884 " guestfs_lvm_set_filter (guestfs_h *g,\n"
12885 " char *const *devices);\n"
12890 #: ../src/guestfs-actions.pod:4031 ../fish/guestfish-actions.pod:2767
12892 "This sets the LVM device filter so that LVM will only be able to \"see\" the "
12893 "block devices in the list C<devices>, and will ignore all other attached "
12898 #: ../src/guestfs-actions.pod:4035 ../fish/guestfish-actions.pod:2771
12900 "Where disk image(s) contain duplicate PVs or VGs, this command is useful to "
12901 "get LVM to ignore the duplicates, otherwise LVM can get confused. Note also "
12902 "there are two types of duplication possible: either cloned PVs/VGs which "
12903 "have identical UUIDs; or VGs that are not cloned but just happen to have the "
12904 "same name. In normal operation you cannot create this situation, but you "
12905 "can do it outside LVM, eg. by cloning disk images or by bit twiddling "
12906 "inside the LVM metadata."
12910 #: ../src/guestfs-actions.pod:4048 ../fish/guestfish-actions.pod:2784
12911 msgid "You can filter whole block devices or individual partitions."
12915 #: ../src/guestfs-actions.pod:4050 ../fish/guestfish-actions.pod:2786
12917 "You cannot use this if any VG is currently in use (eg. contains a mounted "
12918 "filesystem), even if you are not filtering out that VG."
12922 #: ../src/guestfs-actions.pod:4058
12923 msgid "guestfs_lvremove"
12927 #: ../src/guestfs-actions.pod:4060
12931 " guestfs_lvremove (guestfs_h *g,\n"
12932 " const char *device);\n"
12937 #: ../src/guestfs-actions.pod:4064 ../fish/guestfish-actions.pod:2794
12939 "Remove an LVM logical volume C<device>, where C<device> is the path to the "
12940 "LV, such as C</dev/VG/LV>."
12944 #: ../src/guestfs-actions.pod:4067 ../fish/guestfish-actions.pod:2797
12946 "You can also remove all LVs in a volume group by specifying the VG name, C</"
12951 #: ../src/guestfs-actions.pod:4072 ../src/guestfs-actions.pod:5308
12952 #: ../src/guestfs-actions.pod:7097
12953 msgid "(Added in 1.0.13)"
12957 #: ../src/guestfs-actions.pod:4074
12958 msgid "guestfs_lvrename"
12962 #: ../src/guestfs-actions.pod:4076
12966 " guestfs_lvrename (guestfs_h *g,\n"
12967 " const char *logvol,\n"
12968 " const char *newlogvol);\n"
12973 #: ../src/guestfs-actions.pod:4081 ../fish/guestfish-actions.pod:2804
12974 msgid "Rename a logical volume C<logvol> with the new name C<newlogvol>."
12978 #: ../src/guestfs-actions.pod:4085 ../src/guestfs-actions.pod:7110
12979 msgid "(Added in 1.0.83)"
12983 #: ../src/guestfs-actions.pod:4087
12984 msgid "guestfs_lvresize"
12988 #: ../src/guestfs-actions.pod:4089
12992 " guestfs_lvresize (guestfs_h *g,\n"
12993 " const char *device,\n"
12999 #: ../src/guestfs-actions.pod:4094 ../fish/guestfish-actions.pod:2810
13001 "This resizes (expands or shrinks) an existing LVM logical volume to "
13002 "C<mbytes>. When reducing, data in the reduced part is lost."
13006 #: ../src/guestfs-actions.pod:4102
13007 msgid "guestfs_lvresize_free"
13011 #: ../src/guestfs-actions.pod:4104
13015 " guestfs_lvresize_free (guestfs_h *g,\n"
13016 " const char *lv,\n"
13022 #: ../src/guestfs-actions.pod:4109 ../fish/guestfish-actions.pod:2818
13024 "This expands an existing logical volume C<lv> so that it fills C<pc>% of the "
13025 "remaining free space in the volume group. Commonly you would call this with "
13026 "pc = 100 which expands the logical volume as much as possible, using all "
13027 "remaining free space in the volume group."
13031 #: ../src/guestfs-actions.pod:4117
13032 msgid "(Added in 1.3.3)"
13036 #: ../src/guestfs-actions.pod:4119
13037 msgid "guestfs_lvs"
13041 #: ../src/guestfs-actions.pod:4121
13045 " guestfs_lvs (guestfs_h *g);\n"
13050 #: ../src/guestfs-actions.pod:4124 ../fish/guestfish-actions.pod:2828
13052 "List all the logical volumes detected. This is the equivalent of the L<lvs"
13057 #: ../src/guestfs-actions.pod:4127 ../fish/guestfish-actions.pod:2831
13059 "This returns a list of the logical volume device names (eg. C</dev/"
13060 "VolGroup00/LogVol00>)."
13064 #: ../src/guestfs-actions.pod:4130
13065 msgid "See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>."
13069 #: ../src/guestfs-actions.pod:4138
13070 msgid "guestfs_lvs_full"
13074 #: ../src/guestfs-actions.pod:4140
13077 " struct guestfs_lvm_lv_list *\n"
13078 " guestfs_lvs_full (guestfs_h *g);\n"
13083 #: ../src/guestfs-actions.pod:4143 ../fish/guestfish-actions.pod:2840
13085 "List all the logical volumes detected. This is the equivalent of the L<lvs"
13086 "(8)> command. The \"full\" version includes all fields."
13090 #: ../src/guestfs-actions.pod:4146
13092 "This function returns a C<struct guestfs_lvm_lv_list *>, or NULL if there "
13093 "was an error. I<The caller must call C<guestfs_free_lvm_lv_list> after use>."
13097 #: ../src/guestfs-actions.pod:4152
13098 msgid "guestfs_lvuuid"
13102 #: ../src/guestfs-actions.pod:4154
13106 " guestfs_lvuuid (guestfs_h *g,\n"
13107 " const char *device);\n"
13112 #: ../src/guestfs-actions.pod:4158 ../fish/guestfish-actions.pod:2847
13113 msgid "This command returns the UUID of the LVM LV C<device>."
13117 #: ../src/guestfs-actions.pod:4165
13118 msgid "guestfs_lxattrlist"
13122 #: ../src/guestfs-actions.pod:4167
13125 " struct guestfs_xattr_list *\n"
13126 " guestfs_lxattrlist (guestfs_h *g,\n"
13127 " const char *path,\n"
13128 " char *const *names);\n"
13133 #: ../src/guestfs-actions.pod:4172 ../fish/guestfish-actions.pod:2853
13135 "This call allows you to get the extended attributes of multiple files, where "
13136 "all files are in the directory C<path>. C<names> is the list of files from "
13141 #: ../src/guestfs-actions.pod:4176 ../fish/guestfish-actions.pod:2857
13143 "On return you get a flat list of xattr structs which must be interpreted "
13144 "sequentially. The first xattr struct always has a zero-length C<attrname>. "
13145 "C<attrval> in this struct is zero-length to indicate there was an error "
13146 "doing C<lgetxattr> for this file, I<or> is a C string which is a decimal "
13147 "number (the number of following attributes for this file, which could be C<"
13148 "\"0\">). Then after the first xattr struct are the zero or more attributes "
13149 "for the first named file. This repeats for the second and subsequent files."
13153 #: ../src/guestfs-actions.pod:4186
13155 "This call is intended for programs that want to efficiently list a directory "
13156 "contents without making many round-trips. See also C<guestfs_lstatlist> for "
13157 "a similarly efficient call for getting standard stats. Very long directory "
13158 "listings might cause the protocol message size to be exceeded, causing this "
13159 "call to fail. The caller must split up such requests into smaller groups of "
13164 #: ../src/guestfs-actions.pod:4200
13165 msgid "guestfs_mkdir"
13169 #: ../src/guestfs-actions.pod:4202
13173 " guestfs_mkdir (guestfs_h *g,\n"
13174 " const char *path);\n"
13179 #: ../src/guestfs-actions.pod:4206 ../fish/guestfish-actions.pod:2879
13180 msgid "Create a directory named C<path>."
13184 #: ../src/guestfs-actions.pod:4212
13185 msgid "guestfs_mkdir_mode"
13189 #: ../src/guestfs-actions.pod:4214
13193 " guestfs_mkdir_mode (guestfs_h *g,\n"
13194 " const char *path,\n"
13200 #: ../src/guestfs-actions.pod:4219 ../fish/guestfish-actions.pod:2885
13202 "This command creates a directory, setting the initial permissions of the "
13203 "directory to C<mode>."
13207 #: ../src/guestfs-actions.pod:4222 ../fish/guestfish-actions.pod:2888
13209 "For common Linux filesystems, the actual mode which is set will be C<mode & "
13210 "~umask & 01777>. Non-native-Linux filesystems may interpret the mode in "
13215 #: ../src/guestfs-actions.pod:4226
13216 msgid "See also C<guestfs_mkdir>, C<guestfs_umask>"
13220 #: ../src/guestfs-actions.pod:4232
13221 msgid "guestfs_mkdir_p"
13225 #: ../src/guestfs-actions.pod:4234
13229 " guestfs_mkdir_p (guestfs_h *g,\n"
13230 " const char *path);\n"
13235 #: ../src/guestfs-actions.pod:4238 ../fish/guestfish-actions.pod:2898
13237 "Create a directory named C<path>, creating any parent directories as "
13238 "necessary. This is like the C<mkdir -p> shell command."
13242 #: ../src/guestfs-actions.pod:4245
13243 msgid "guestfs_mkdtemp"
13247 #: ../src/guestfs-actions.pod:4247
13251 " guestfs_mkdtemp (guestfs_h *g,\n"
13252 " const char *template);\n"
13257 #: ../src/guestfs-actions.pod:4251 ../fish/guestfish-actions.pod:2905
13259 "This command creates a temporary directory. The C<template> parameter "
13260 "should be a full pathname for the temporary directory name with the final "
13261 "six characters being \"XXXXXX\"."
13265 #: ../src/guestfs-actions.pod:4256 ../fish/guestfish-actions.pod:2910
13267 "For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\", the second one "
13268 "being suitable for Windows filesystems."
13272 #: ../src/guestfs-actions.pod:4259 ../fish/guestfish-actions.pod:2913
13273 msgid "The name of the temporary directory that was created is returned."
13277 #: ../src/guestfs-actions.pod:4262 ../fish/guestfish-actions.pod:2916
13278 msgid "The temporary directory is created with mode 0700 and is owned by root."
13282 #: ../src/guestfs-actions.pod:4265 ../fish/guestfish-actions.pod:2919
13284 "The caller is responsible for deleting the temporary directory and its "
13285 "contents after use."
13289 #: ../src/guestfs-actions.pod:4268 ../fish/guestfish-actions.pod:2922
13290 msgid "See also: L<mkdtemp(3)>"
13294 #: ../src/guestfs-actions.pod:4275
13295 msgid "guestfs_mke2fs_J"
13299 #: ../src/guestfs-actions.pod:4277
13303 " guestfs_mke2fs_J (guestfs_h *g,\n"
13304 " const char *fstype,\n"
13305 " int blocksize,\n"
13306 " const char *device,\n"
13307 " const char *journal);\n"
13312 #: ../src/guestfs-actions.pod:4284 ../fish/guestfish-actions.pod:2928
13314 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
13315 "C<journal>. It is equivalent to the command:"
13319 #: ../src/guestfs-actions.pod:4288 ../fish/guestfish-actions.pod:2932
13322 " mke2fs -t fstype -b blocksize -J device=<journal> <device>\n"
13327 #: ../src/guestfs-actions.pod:4290
13328 msgid "See also C<guestfs_mke2journal>."
13332 #: ../src/guestfs-actions.pod:4294 ../src/guestfs-actions.pod:4312
13333 #: ../src/guestfs-actions.pod:4330 ../src/guestfs-actions.pod:4346
13334 #: ../src/guestfs-actions.pod:4360 ../src/guestfs-actions.pod:4374
13335 #: ../src/guestfs-actions.pod:4433 ../src/guestfs-actions.pod:4698
13336 msgid "(Added in 1.0.68)"
13340 #: ../src/guestfs-actions.pod:4296
13341 msgid "guestfs_mke2fs_JL"
13345 #: ../src/guestfs-actions.pod:4298
13349 " guestfs_mke2fs_JL (guestfs_h *g,\n"
13350 " const char *fstype,\n"
13351 " int blocksize,\n"
13352 " const char *device,\n"
13353 " const char *label);\n"
13358 #: ../src/guestfs-actions.pod:4305 ../fish/guestfish-actions.pod:2940
13360 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
13361 "the journal labeled C<label>."
13365 #: ../src/guestfs-actions.pod:4308
13366 msgid "See also C<guestfs_mke2journal_L>."
13370 #: ../src/guestfs-actions.pod:4314
13371 msgid "guestfs_mke2fs_JU"
13375 #: ../src/guestfs-actions.pod:4316
13379 " guestfs_mke2fs_JU (guestfs_h *g,\n"
13380 " const char *fstype,\n"
13381 " int blocksize,\n"
13382 " const char *device,\n"
13383 " const char *uuid);\n"
13388 #: ../src/guestfs-actions.pod:4323 ../fish/guestfish-actions.pod:2949
13390 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
13391 "the journal with UUID C<uuid>."
13395 #: ../src/guestfs-actions.pod:4326
13396 msgid "See also C<guestfs_mke2journal_U>."
13400 #: ../src/guestfs-actions.pod:4332
13401 msgid "guestfs_mke2journal"
13405 #: ../src/guestfs-actions.pod:4334
13409 " guestfs_mke2journal (guestfs_h *g,\n"
13410 " int blocksize,\n"
13411 " const char *device);\n"
13416 #: ../src/guestfs-actions.pod:4339 ../fish/guestfish-actions.pod:2958
13418 "This creates an ext2 external journal on C<device>. It is equivalent to the "
13423 #: ../src/guestfs-actions.pod:4342 ../fish/guestfish-actions.pod:2961
13426 " mke2fs -O journal_dev -b blocksize device\n"
13431 #: ../src/guestfs-actions.pod:4348
13432 msgid "guestfs_mke2journal_L"
13436 #: ../src/guestfs-actions.pod:4350
13440 " guestfs_mke2journal_L (guestfs_h *g,\n"
13441 " int blocksize,\n"
13442 " const char *label,\n"
13443 " const char *device);\n"
13448 #: ../src/guestfs-actions.pod:4356 ../fish/guestfish-actions.pod:2967
13449 msgid "This creates an ext2 external journal on C<device> with label C<label>."
13453 #: ../src/guestfs-actions.pod:4362
13454 msgid "guestfs_mke2journal_U"
13458 #: ../src/guestfs-actions.pod:4364
13462 " guestfs_mke2journal_U (guestfs_h *g,\n"
13463 " int blocksize,\n"
13464 " const char *uuid,\n"
13465 " const char *device);\n"
13470 #: ../src/guestfs-actions.pod:4370 ../fish/guestfish-actions.pod:2973
13471 msgid "This creates an ext2 external journal on C<device> with UUID C<uuid>."
13475 #: ../src/guestfs-actions.pod:4376
13476 msgid "guestfs_mkfifo"
13480 #: ../src/guestfs-actions.pod:4378
13484 " guestfs_mkfifo (guestfs_h *g,\n"
13486 " const char *path);\n"
13491 #: ../src/guestfs-actions.pod:4383
13493 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
13494 "is just a convenient wrapper around C<guestfs_mknod>."
13498 #: ../src/guestfs-actions.pod:4393
13499 msgid "guestfs_mkfs"
13503 #: ../src/guestfs-actions.pod:4395
13507 " guestfs_mkfs (guestfs_h *g,\n"
13508 " const char *fstype,\n"
13509 " const char *device);\n"
13514 #: ../src/guestfs-actions.pod:4400 ../fish/guestfish-actions.pod:2989
13516 "This creates a filesystem on C<device> (usually a partition or LVM logical "
13517 "volume). The filesystem type is C<fstype>, for example C<ext3>."
13521 #: ../src/guestfs-actions.pod:4408
13522 msgid "guestfs_mkfs_b"
13526 #: ../src/guestfs-actions.pod:4410
13530 " guestfs_mkfs_b (guestfs_h *g,\n"
13531 " const char *fstype,\n"
13532 " int blocksize,\n"
13533 " const char *device);\n"
13538 #: ../src/guestfs-actions.pod:4416
13540 "This call is similar to C<guestfs_mkfs>, but it allows you to control the "
13541 "block size of the resulting filesystem. Supported block sizes depend on the "
13542 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
13546 #: ../src/guestfs-actions.pod:4421 ../src/guestfs-actions.pod:4464
13547 #: ../fish/guestfish-actions.pod:3002 ../fish/guestfish-actions.pod:3029
13549 "For VFAT and NTFS the C<blocksize> parameter is treated as the requested "
13554 #: ../src/guestfs-actions.pod:4426 ../fish/guestfish-actions.pod:3005
13556 "This function is deprecated. In new code, use the C<mkfs_opts> call instead."
13560 #: ../src/guestfs-actions.pod:4435
13561 msgid "guestfs_mkfs_opts"
13565 #: ../src/guestfs-actions.pod:4437
13569 " guestfs_mkfs_opts (guestfs_h *g,\n"
13570 " const char *fstype,\n"
13571 " const char *device,\n"
13577 #: ../src/guestfs-actions.pod:4448
13580 " GUESTFS_MKFS_OPTS_BLOCKSIZE, int blocksize,\n"
13581 " GUESTFS_MKFS_OPTS_FEATURES, const char *features,\n"
13586 #: ../src/guestfs-actions.pod:4451 ../fish/guestfish-actions.pod:3016
13588 "This function creates a filesystem on C<device>. The filesystem type is "
13589 "C<fstype>, for example C<ext3>."
13593 #: ../src/guestfs-actions.pod:4458 ../fish/guestfish-actions.pod:3023
13594 msgid "C<blocksize>"
13598 #: ../src/guestfs-actions.pod:4460 ../fish/guestfish-actions.pod:3025
13600 "The filesystem block size. Supported block sizes depend on the filesystem "
13601 "type, but typically they are C<1024>, C<2048> or C<4096> for Linux ext2/3 "
13606 #: ../src/guestfs-actions.pod:4467 ../fish/guestfish-actions.pod:3032
13607 msgid "For UFS block sizes, please see L<mkfs.ufs(8)>."
13611 #: ../src/guestfs-actions.pod:4469 ../fish/guestfish-actions.pod:3034
13612 msgid "C<features>"
13616 #: ../src/guestfs-actions.pod:4471 ../fish/guestfish-actions.pod:3036
13617 msgid "This passes the I<-O> parameter to the external mkfs program."
13621 #: ../src/guestfs-actions.pod:4473 ../fish/guestfish-actions.pod:3038
13623 "For certain filesystem types, this allows extra filesystem features to be "
13624 "selected. See L<mke2fs(8)> and L<mkfs.ufs(8)> for more details."
13628 #: ../src/guestfs-actions.pod:4477 ../fish/guestfish-actions.pod:3042
13630 "You cannot use this optional parameter with the C<gfs> or C<gfs2> filesystem "
13635 #: ../src/guestfs-actions.pod:4484
13636 msgid "(Added in 1.7.19)"
13640 #: ../src/guestfs-actions.pod:4486
13641 msgid "guestfs_mkfs_opts_va"
13645 #: ../src/guestfs-actions.pod:4488
13649 " guestfs_mkfs_opts_va (guestfs_h *g,\n"
13650 " const char *fstype,\n"
13651 " const char *device,\n"
13652 " va_list args);\n"
13657 #: ../src/guestfs-actions.pod:4494
13658 msgid "This is the \"va_list variant\" of L</guestfs_mkfs_opts>."
13662 #: ../src/guestfs-actions.pod:4498
13663 msgid "guestfs_mkfs_opts_argv"
13667 #: ../src/guestfs-actions.pod:4500
13671 " guestfs_mkfs_opts_argv (guestfs_h *g,\n"
13672 " const char *fstype,\n"
13673 " const char *device,\n"
13674 " const struct guestfs_mkfs_opts_argv *optargs);\n"
13679 #: ../src/guestfs-actions.pod:4506
13680 msgid "This is the \"argv variant\" of L</guestfs_mkfs_opts>."
13684 #: ../src/guestfs-actions.pod:4510
13685 msgid "guestfs_mkmountpoint"
13689 #: ../src/guestfs-actions.pod:4512
13693 " guestfs_mkmountpoint (guestfs_h *g,\n"
13694 " const char *exemptpath);\n"
13699 #: ../src/guestfs-actions.pod:4516
13701 "C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are specialized calls "
13702 "that can be used to create extra mountpoints before mounting the first "
13707 #: ../src/guestfs-actions.pod:4520 ../fish/guestfish-actions.pod:3057
13709 "These calls are I<only> necessary in some very limited circumstances, mainly "
13710 "the case where you want to mount a mix of unrelated and/or read-only "
13711 "filesystems together."
13715 #: ../src/guestfs-actions.pod:4524 ../fish/guestfish-actions.pod:3061
13717 "For example, live CDs often contain a \"Russian doll\" nest of filesystems, "
13718 "an ISO outer layer, with a squashfs image inside, with an ext2/3 image "
13719 "inside that. You can unpack this as follows in guestfish:"
13723 #: ../src/guestfs-actions.pod:4529 ../fish/guestfish-actions.pod:3066
13726 " add-ro Fedora-11-i686-Live.iso\n"
13728 " mkmountpoint /cd\n"
13729 " mkmountpoint /sqsh\n"
13730 " mkmountpoint /ext3fs\n"
13731 " mount /dev/sda /cd\n"
13732 " mount-loop /cd/LiveOS/squashfs.img /sqsh\n"
13733 " mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs\n"
13738 #: ../src/guestfs-actions.pod:4538 ../fish/guestfish-actions.pod:3075
13739 msgid "The inner filesystem is now unpacked under the /ext3fs mountpoint."
13743 #: ../src/guestfs-actions.pod:4540
13745 "C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>. You "
13746 "may get unexpected errors if you try to mix these calls. It is safest to "
13747 "manually unmount filesystems and remove mountpoints after use."
13751 #: ../src/guestfs-actions.pod:4544
13753 "C<guestfs_umount_all> unmounts filesystems by sorting the paths longest "
13754 "first, so for this to work for manual mountpoints, you must ensure that the "
13755 "innermost mountpoints have the longest pathnames, as in the example code "
13760 #: ../src/guestfs-actions.pod:4549 ../fish/guestfish-actions.pod:3086
13762 "For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>"
13766 #: ../src/guestfs-actions.pod:4551
13768 "Autosync [see C<guestfs_set_autosync>, this is set by default on handles] "
13769 "can cause C<guestfs_umount_all> to be called when the handle is closed which "
13770 "can also trigger these issues."
13774 #: ../src/guestfs-actions.pod:4557 ../src/guestfs-actions.pod:4816
13775 #: ../src/guestfs-actions.pod:5726
13776 msgid "(Added in 1.0.62)"
13780 #: ../src/guestfs-actions.pod:4559
13781 msgid "guestfs_mknod"
13785 #: ../src/guestfs-actions.pod:4561
13789 " guestfs_mknod (guestfs_h *g,\n"
13793 " const char *path);\n"
13798 #: ../src/guestfs-actions.pod:4568 ../fish/guestfish-actions.pod:3096
13800 "This call creates block or character special devices, or named pipes (FIFOs)."
13804 #: ../src/guestfs-actions.pod:4571 ../fish/guestfish-actions.pod:3099
13806 "The C<mode> parameter should be the mode, using the standard constants. "
13807 "C<devmajor> and C<devminor> are the device major and minor numbers, only "
13808 "used when creating block and character special devices."
13812 #: ../src/guestfs-actions.pod:4576
13814 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
13815 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
13816 "regular file). These constants are available in the standard Linux header "
13817 "files, or you can use C<guestfs_mknod_b>, C<guestfs_mknod_c> or "
13818 "C<guestfs_mkfifo> which are wrappers around this command which bitwise OR in "
13819 "the appropriate constant for you."
13823 #: ../src/guestfs-actions.pod:4590
13824 msgid "guestfs_mknod_b"
13828 #: ../src/guestfs-actions.pod:4592
13832 " guestfs_mknod_b (guestfs_h *g,\n"
13836 " const char *path);\n"
13841 #: ../src/guestfs-actions.pod:4599
13843 "This call creates a block device node called C<path> with mode C<mode> and "
13844 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
13845 "wrapper around C<guestfs_mknod>."
13849 #: ../src/guestfs-actions.pod:4609
13850 msgid "guestfs_mknod_c"
13854 #: ../src/guestfs-actions.pod:4611
13858 " guestfs_mknod_c (guestfs_h *g,\n"
13862 " const char *path);\n"
13867 #: ../src/guestfs-actions.pod:4618
13869 "This call creates a char device node called C<path> with mode C<mode> and "
13870 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
13871 "wrapper around C<guestfs_mknod>."
13875 #: ../src/guestfs-actions.pod:4628
13876 msgid "guestfs_mkswap"
13880 #: ../src/guestfs-actions.pod:4630
13884 " guestfs_mkswap (guestfs_h *g,\n"
13885 " const char *device);\n"
13890 #: ../src/guestfs-actions.pod:4634 ../fish/guestfish-actions.pod:3138
13891 msgid "Create a swap partition on C<device>."
13895 #: ../src/guestfs-actions.pod:4640
13896 msgid "guestfs_mkswap_L"
13900 #: ../src/guestfs-actions.pod:4642
13904 " guestfs_mkswap_L (guestfs_h *g,\n"
13905 " const char *label,\n"
13906 " const char *device);\n"
13911 #: ../src/guestfs-actions.pod:4647 ../fish/guestfish-actions.pod:3144
13912 msgid "Create a swap partition on C<device> with label C<label>."
13916 #: ../src/guestfs-actions.pod:4649 ../fish/guestfish-actions.pod:3146
13918 "Note that you cannot attach a swap label to a block device (eg. C</dev/"
13919 "sda>), just to a partition. This appears to be a limitation of the kernel "
13924 #: ../src/guestfs-actions.pod:4657
13925 msgid "guestfs_mkswap_U"
13929 #: ../src/guestfs-actions.pod:4659
13933 " guestfs_mkswap_U (guestfs_h *g,\n"
13934 " const char *uuid,\n"
13935 " const char *device);\n"
13940 #: ../src/guestfs-actions.pod:4664 ../fish/guestfish-actions.pod:3154
13941 msgid "Create a swap partition on C<device> with UUID C<uuid>."
13945 #: ../src/guestfs-actions.pod:4670
13946 msgid "guestfs_mkswap_file"
13950 #: ../src/guestfs-actions.pod:4672
13954 " guestfs_mkswap_file (guestfs_h *g,\n"
13955 " const char *path);\n"
13960 #: ../src/guestfs-actions.pod:4676 ../fish/guestfish-actions.pod:3160
13961 msgid "Create a swap file."
13965 #: ../src/guestfs-actions.pod:4678
13967 "This command just writes a swap file signature to an existing file. To "
13968 "create the file itself, use something like C<guestfs_fallocate>."
13972 #: ../src/guestfs-actions.pod:4685
13973 msgid "guestfs_modprobe"
13977 #: ../src/guestfs-actions.pod:4687
13981 " guestfs_modprobe (guestfs_h *g,\n"
13982 " const char *modulename);\n"
13987 #: ../src/guestfs-actions.pod:4691 ../fish/guestfish-actions.pod:3169
13988 msgid "This loads a kernel module in the appliance."
13992 #: ../src/guestfs-actions.pod:4693 ../fish/guestfish-actions.pod:3171
13994 "The kernel module must have been whitelisted when libguestfs was built (see "
13995 "C<appliance/kmod.whitelist.in> in the source)."
13999 #: ../src/guestfs-actions.pod:4700
14000 msgid "guestfs_mount"
14004 #: ../src/guestfs-actions.pod:4702
14008 " guestfs_mount (guestfs_h *g,\n"
14009 " const char *device,\n"
14010 " const char *mountpoint);\n"
14015 #: ../src/guestfs-actions.pod:4707 ../fish/guestfish-actions.pod:3178
14017 "Mount a guest disk at a position in the filesystem. Block devices are named "
14018 "C</dev/sda>, C</dev/sdb> and so on, as they were added to the guest. If "
14019 "those block devices contain partitions, they will have the usual names (eg. "
14020 "C</dev/sda1>). Also LVM C</dev/VG/LV>-style names can be used."
14024 #: ../src/guestfs-actions.pod:4713 ../fish/guestfish-actions.pod:3184
14026 "The rules are the same as for L<mount(2)>: A filesystem must first be "
14027 "mounted on C</> before others can be mounted. Other filesystems can only be "
14028 "mounted on directories which already exist."
14032 #: ../src/guestfs-actions.pod:4718 ../fish/guestfish-actions.pod:3189
14034 "The mounted filesystem is writable, if we have sufficient permissions on the "
14035 "underlying device."
14039 #: ../src/guestfs-actions.pod:4721
14041 "B<Important note:> When you use this call, the filesystem options C<sync> "
14042 "and C<noatime> are set implicitly. This was originally done because we "
14043 "thought it would improve reliability, but it turns out that I<-o sync> has a "
14044 "very large negative performance impact and negligible effect on "
14045 "reliability. Therefore we recommend that you avoid using C<guestfs_mount> "
14046 "in any code that needs performance, and instead use C<guestfs_mount_options> "
14047 "(use an empty string for the first parameter if you don't want any options)."
14051 #: ../src/guestfs-actions.pod:4735
14052 msgid "guestfs_mount_loop"
14056 #: ../src/guestfs-actions.pod:4737
14060 " guestfs_mount_loop (guestfs_h *g,\n"
14061 " const char *file,\n"
14062 " const char *mountpoint);\n"
14067 #: ../src/guestfs-actions.pod:4742 ../fish/guestfish-actions.pod:3206
14069 "This command lets you mount C<file> (a filesystem image in a file) on a "
14070 "mount point. It is entirely equivalent to the command C<mount -o loop file "
14075 #: ../src/guestfs-actions.pod:4750
14076 msgid "guestfs_mount_options"
14080 #: ../src/guestfs-actions.pod:4752
14084 " guestfs_mount_options (guestfs_h *g,\n"
14085 " const char *options,\n"
14086 " const char *device,\n"
14087 " const char *mountpoint);\n"
14092 #: ../src/guestfs-actions.pod:4758
14094 "This is the same as the C<guestfs_mount> command, but it allows you to set "
14095 "the mount options as for the L<mount(8)> I<-o> flag."
14099 #: ../src/guestfs-actions.pod:4762 ../fish/guestfish-actions.pod:3218
14101 "If the C<options> parameter is an empty string, then no options are passed "
14102 "(all options default to whatever the filesystem uses)."
14106 #: ../src/guestfs-actions.pod:4768 ../src/guestfs-actions.pod:4782
14107 #: ../src/guestfs-actions.pod:4799
14108 msgid "(Added in 1.0.10)"
14112 #: ../src/guestfs-actions.pod:4770
14113 msgid "guestfs_mount_ro"
14117 #: ../src/guestfs-actions.pod:4772
14121 " guestfs_mount_ro (guestfs_h *g,\n"
14122 " const char *device,\n"
14123 " const char *mountpoint);\n"
14128 #: ../src/guestfs-actions.pod:4777
14130 "This is the same as the C<guestfs_mount> command, but it mounts the "
14131 "filesystem with the read-only (I<-o ro>) flag."
14135 #: ../src/guestfs-actions.pod:4784
14136 msgid "guestfs_mount_vfs"
14140 #: ../src/guestfs-actions.pod:4786
14144 " guestfs_mount_vfs (guestfs_h *g,\n"
14145 " const char *options,\n"
14146 " const char *vfstype,\n"
14147 " const char *device,\n"
14148 " const char *mountpoint);\n"
14153 #: ../src/guestfs-actions.pod:4793
14155 "This is the same as the C<guestfs_mount> command, but it allows you to set "
14156 "both the mount options and the vfstype as for the L<mount(8)> I<-o> and I<-"
14161 #: ../src/guestfs-actions.pod:4801
14162 msgid "guestfs_mountpoints"
14166 #: ../src/guestfs-actions.pod:4803
14170 " guestfs_mountpoints (guestfs_h *g);\n"
14175 #: ../src/guestfs-actions.pod:4806
14177 "This call is similar to C<guestfs_mounts>. That call returns a list of "
14178 "devices. This one returns a hash table (map) of device name to directory "
14179 "where the device is mounted."
14183 #: ../src/guestfs-actions.pod:4818
14184 msgid "guestfs_mounts"
14188 #: ../src/guestfs-actions.pod:4820
14192 " guestfs_mounts (guestfs_h *g);\n"
14197 #: ../src/guestfs-actions.pod:4823 ../fish/guestfish-actions.pod:3249
14199 "This returns the list of currently mounted filesystems. It returns the list "
14200 "of devices (eg. C</dev/sda1>, C</dev/VG/LV>)."
14204 #: ../src/guestfs-actions.pod:4826 ../fish/guestfish-actions.pod:3252
14205 msgid "Some internal mounts are not shown."
14209 #: ../src/guestfs-actions.pod:4828
14210 msgid "See also: C<guestfs_mountpoints>"
14214 #: ../src/guestfs-actions.pod:4836
14219 #: ../src/guestfs-actions.pod:4838
14223 " guestfs_mv (guestfs_h *g,\n"
14224 " const char *src,\n"
14225 " const char *dest);\n"
14230 #: ../src/guestfs-actions.pod:4843 ../fish/guestfish-actions.pod:3260
14232 "This moves a file from C<src> to C<dest> where C<dest> is either a "
14233 "destination filename or destination directory."
14237 #: ../src/guestfs-actions.pod:4850
14238 msgid "guestfs_ntfs_3g_probe"
14242 #: ../src/guestfs-actions.pod:4852
14246 " guestfs_ntfs_3g_probe (guestfs_h *g,\n"
14248 " const char *device);\n"
14253 #: ../src/guestfs-actions.pod:4857 ../fish/guestfish-actions.pod:3267
14255 "This command runs the L<ntfs-3g.probe(8)> command which probes an NTFS "
14256 "C<device> for mountability. (Not all NTFS volumes can be mounted read-"
14257 "write, and some cannot be mounted at all)."
14261 #: ../src/guestfs-actions.pod:4861 ../fish/guestfish-actions.pod:3271
14263 "C<rw> is a boolean flag. Set it to true if you want to test if the volume "
14264 "can be mounted read-write. Set it to false if you want to test if the "
14265 "volume can be mounted read-only."
14269 #: ../src/guestfs-actions.pod:4865 ../fish/guestfish-actions.pod:3275
14271 "The return value is an integer which C<0> if the operation would succeed, or "
14272 "some non-zero value documented in the L<ntfs-3g.probe(8)> manual page."
14276 #: ../src/guestfs-actions.pod:4871
14277 msgid "(Added in 1.0.43)"
14281 #: ../src/guestfs-actions.pod:4873
14282 msgid "guestfs_ntfsresize"
14286 #: ../src/guestfs-actions.pod:4875
14290 " guestfs_ntfsresize (guestfs_h *g,\n"
14291 " const char *device);\n"
14296 #: ../src/guestfs-actions.pod:4879 ../fish/guestfish-actions.pod:3283
14298 "This command resizes an NTFS filesystem, expanding or shrinking it to the "
14299 "size of the underlying device. See also L<ntfsresize(8)>."
14303 #: ../src/guestfs-actions.pod:4887
14304 msgid "guestfs_ntfsresize_size"
14308 #: ../src/guestfs-actions.pod:4889
14312 " guestfs_ntfsresize_size (guestfs_h *g,\n"
14313 " const char *device,\n"
14314 " int64_t size);\n"
14319 #: ../src/guestfs-actions.pod:4894
14321 "This command is the same as C<guestfs_ntfsresize> except that it allows you "
14322 "to specify the new size (in bytes) explicitly."
14326 #: ../src/guestfs-actions.pod:4899 ../src/guestfs-actions.pod:5335
14327 #: ../src/guestfs-actions.pod:5408 ../src/guestfs-actions.pod:5674
14328 #: ../src/guestfs-actions.pod:7245
14329 msgid "(Added in 1.3.14)"
14333 #: ../src/guestfs-actions.pod:4901
14334 msgid "guestfs_part_add"
14338 #: ../src/guestfs-actions.pod:4903
14342 " guestfs_part_add (guestfs_h *g,\n"
14343 " const char *device,\n"
14344 " const char *prlogex,\n"
14345 " int64_t startsect,\n"
14346 " int64_t endsect);\n"
14351 #: ../src/guestfs-actions.pod:4910
14353 "This command adds a partition to C<device>. If there is no partition table "
14354 "on the device, call C<guestfs_part_init> first."
14358 #: ../src/guestfs-actions.pod:4913 ../fish/guestfish-actions.pod:3301
14360 "The C<prlogex> parameter is the type of partition. Normally you should pass "
14361 "C<p> or C<primary> here, but MBR partition tables also support C<l> (or "
14362 "C<logical>) and C<e> (or C<extended>) partition types."
14366 #: ../src/guestfs-actions.pod:4918 ../fish/guestfish-actions.pod:3306
14368 "C<startsect> and C<endsect> are the start and end of the partition in "
14369 "I<sectors>. C<endsect> may be negative, which means it counts backwards "
14370 "from the end of the disk (C<-1> is the last sector)."
14374 #: ../src/guestfs-actions.pod:4922
14376 "Creating a partition which covers the whole disk is not so easy. Use "
14377 "C<guestfs_part_disk> to do that."
14381 #: ../src/guestfs-actions.pod:4927 ../src/guestfs-actions.pod:4965
14382 #: ../src/guestfs-actions.pod:5018 ../src/guestfs-actions.pod:5096
14383 #: ../src/guestfs-actions.pod:5134 ../src/guestfs-actions.pod:5153
14384 #: ../src/guestfs-actions.pod:5193
14385 msgid "(Added in 1.0.78)"
14389 #: ../src/guestfs-actions.pod:4929
14390 msgid "guestfs_part_del"
14394 #: ../src/guestfs-actions.pod:4931
14398 " guestfs_part_del (guestfs_h *g,\n"
14399 " const char *device,\n"
14405 #: ../src/guestfs-actions.pod:4936 ../fish/guestfish-actions.pod:3317
14406 msgid "This command deletes the partition numbered C<partnum> on C<device>."
14410 #: ../src/guestfs-actions.pod:4938 ../fish/guestfish-actions.pod:3319
14412 "Note that in the case of MBR partitioning, deleting an extended partition "
14413 "also deletes any logical partitions it contains."
14417 #: ../src/guestfs-actions.pod:4946
14418 msgid "guestfs_part_disk"
14422 #: ../src/guestfs-actions.pod:4948
14426 " guestfs_part_disk (guestfs_h *g,\n"
14427 " const char *device,\n"
14428 " const char *parttype);\n"
14433 #: ../src/guestfs-actions.pod:4953
14435 "This command is simply a combination of C<guestfs_part_init> followed by "
14436 "C<guestfs_part_add> to create a single primary partition covering the whole "
14441 #: ../src/guestfs-actions.pod:4957
14443 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
14444 "possible values are described in C<guestfs_part_init>."
14448 #: ../src/guestfs-actions.pod:4967
14449 msgid "guestfs_part_get_bootable"
14453 #: ../src/guestfs-actions.pod:4969
14457 " guestfs_part_get_bootable (guestfs_h *g,\n"
14458 " const char *device,\n"
14464 #: ../src/guestfs-actions.pod:4974 ../fish/guestfish-actions.pod:3341
14466 "This command returns true if the partition C<partnum> on C<device> has the "
14467 "bootable flag set."
14471 #: ../src/guestfs-actions.pod:4977
14472 msgid "See also C<guestfs_part_set_bootable>."
14476 #: ../src/guestfs-actions.pod:4983
14477 msgid "guestfs_part_get_mbr_id"
14481 #: ../src/guestfs-actions.pod:4985
14485 " guestfs_part_get_mbr_id (guestfs_h *g,\n"
14486 " const char *device,\n"
14492 #: ../src/guestfs-actions.pod:4990 ../fish/guestfish-actions.pod:3350
14494 "Returns the MBR type byte (also known as the ID byte) from the numbered "
14495 "partition C<partnum>."
14499 #: ../src/guestfs-actions.pod:4993 ../src/guestfs-actions.pod:5169
14501 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
14502 "undefined results for other partition table types (see "
14503 "C<guestfs_part_get_parttype>)."
14507 #: ../src/guestfs-actions.pod:5001
14508 msgid "guestfs_part_get_parttype"
14512 #: ../src/guestfs-actions.pod:5003
14516 " guestfs_part_get_parttype (guestfs_h *g,\n"
14517 " const char *device);\n"
14522 #: ../src/guestfs-actions.pod:5007 ../fish/guestfish-actions.pod:3361
14524 "This command examines the partition table on C<device> and returns the "
14525 "partition table type (format) being used."
14529 #: ../src/guestfs-actions.pod:5010
14531 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
14532 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
14533 "possible, although unusual. See C<guestfs_part_init> for a full list."
14537 #: ../src/guestfs-actions.pod:5020
14538 msgid "guestfs_part_init"
14542 #: ../src/guestfs-actions.pod:5022
14546 " guestfs_part_init (guestfs_h *g,\n"
14547 " const char *device,\n"
14548 " const char *parttype);\n"
14553 #: ../src/guestfs-actions.pod:5027 ../fish/guestfish-actions.pod:3373
14555 "This creates an empty partition table on C<device> of one of the partition "
14556 "types listed below. Usually C<parttype> should be either C<msdos> or C<gpt> "
14557 "(for large disks)."
14561 #: ../src/guestfs-actions.pod:5031
14563 "Initially there are no partitions. Following this, you should call "
14564 "C<guestfs_part_add> for each partition required."
14568 #: ../src/guestfs-actions.pod:5034 ../fish/guestfish-actions.pod:3380
14569 msgid "Possible values for C<parttype> are:"
14573 #: ../src/guestfs-actions.pod:5038 ../fish/guestfish-actions.pod:3384
14574 msgid "B<efi> | B<gpt>"
14578 #: ../src/guestfs-actions.pod:5040 ../fish/guestfish-actions.pod:3386
14579 msgid "Intel EFI / GPT partition table."
14583 #: ../src/guestfs-actions.pod:5042 ../fish/guestfish-actions.pod:3388
14585 "This is recommended for >= 2 TB partitions that will be accessed from Linux "
14586 "and Intel-based Mac OS X. It also has limited backwards compatibility with "
14587 "the C<mbr> format."
14591 #: ../src/guestfs-actions.pod:5046 ../fish/guestfish-actions.pod:3392
14592 msgid "B<mbr> | B<msdos>"
14596 #: ../src/guestfs-actions.pod:5048 ../fish/guestfish-actions.pod:3394
14598 "The standard PC \"Master Boot Record\" (MBR) format used by MS-DOS and "
14599 "Windows. This partition type will B<only> work for device sizes up to 2 "
14600 "TB. For large disks we recommend using C<gpt>."
14604 #: ../src/guestfs-actions.pod:5055 ../fish/guestfish-actions.pod:3401
14606 "Other partition table types that may work but are not supported include:"
14610 #: ../src/guestfs-actions.pod:5060 ../fish/guestfish-actions.pod:3406
14615 #: ../src/guestfs-actions.pod:5062 ../fish/guestfish-actions.pod:3408
14616 msgid "AIX disk labels."
14620 #: ../src/guestfs-actions.pod:5064 ../fish/guestfish-actions.pod:3410
14621 msgid "B<amiga> | B<rdb>"
14625 #: ../src/guestfs-actions.pod:5066 ../fish/guestfish-actions.pod:3412
14626 msgid "Amiga \"Rigid Disk Block\" format."
14630 #: ../src/guestfs-actions.pod:5068 ../fish/guestfish-actions.pod:3414
14635 #: ../src/guestfs-actions.pod:5070 ../fish/guestfish-actions.pod:3416
14636 msgid "BSD disk labels."
14640 #: ../src/guestfs-actions.pod:5072 ../fish/guestfish-actions.pod:3418
14645 #: ../src/guestfs-actions.pod:5074 ../fish/guestfish-actions.pod:3420
14646 msgid "DASD, used on IBM mainframes."
14650 #: ../src/guestfs-actions.pod:5076 ../fish/guestfish-actions.pod:3422
14655 #: ../src/guestfs-actions.pod:5078 ../fish/guestfish-actions.pod:3424
14656 msgid "MIPS/SGI volumes."
14660 #: ../src/guestfs-actions.pod:5080 ../fish/guestfish-actions.pod:3426
14665 #: ../src/guestfs-actions.pod:5082 ../fish/guestfish-actions.pod:3428
14666 msgid "Old Mac partition format. Modern Macs use C<gpt>."
14670 #: ../src/guestfs-actions.pod:5084 ../fish/guestfish-actions.pod:3430
14675 #: ../src/guestfs-actions.pod:5086 ../fish/guestfish-actions.pod:3432
14676 msgid "NEC PC-98 format, common in Japan apparently."
14680 #: ../src/guestfs-actions.pod:5088 ../fish/guestfish-actions.pod:3434
14685 #: ../src/guestfs-actions.pod:5090 ../fish/guestfish-actions.pod:3436
14686 msgid "Sun disk labels."
14690 #: ../src/guestfs-actions.pod:5098
14691 msgid "guestfs_part_list"
14695 #: ../src/guestfs-actions.pod:5100
14698 " struct guestfs_partition_list *\n"
14699 " guestfs_part_list (guestfs_h *g,\n"
14700 " const char *device);\n"
14705 #: ../src/guestfs-actions.pod:5104 ../fish/guestfish-actions.pod:3444
14707 "This command parses the partition table on C<device> and returns the list of "
14708 "partitions found."
14712 #: ../src/guestfs-actions.pod:5107 ../fish/guestfish-actions.pod:3447
14713 msgid "The fields in the returned structure are:"
14717 #: ../src/guestfs-actions.pod:5111 ../fish/guestfish-actions.pod:3451
14718 msgid "B<part_num>"
14722 #: ../src/guestfs-actions.pod:5113 ../fish/guestfish-actions.pod:3453
14723 msgid "Partition number, counting from 1."
14727 #: ../src/guestfs-actions.pod:5115 ../fish/guestfish-actions.pod:3455
14728 msgid "B<part_start>"
14732 #: ../src/guestfs-actions.pod:5117
14734 "Start of the partition I<in bytes>. To get sectors you have to divide by "
14735 "the device's sector size, see C<guestfs_blockdev_getss>."
14739 #: ../src/guestfs-actions.pod:5120 ../fish/guestfish-actions.pod:3460
14740 msgid "B<part_end>"
14744 #: ../src/guestfs-actions.pod:5122 ../fish/guestfish-actions.pod:3462
14745 msgid "End of the partition in bytes."
14749 #: ../src/guestfs-actions.pod:5124 ../fish/guestfish-actions.pod:3464
14750 msgid "B<part_size>"
14754 #: ../src/guestfs-actions.pod:5126 ../fish/guestfish-actions.pod:3466
14755 msgid "Size of the partition in bytes."
14759 #: ../src/guestfs-actions.pod:5130
14761 "This function returns a C<struct guestfs_partition_list *>, or NULL if there "
14762 "was an error. I<The caller must call C<guestfs_free_partition_list> after "
14767 #: ../src/guestfs-actions.pod:5136
14768 msgid "guestfs_part_set_bootable"
14772 #: ../src/guestfs-actions.pod:5138
14776 " guestfs_part_set_bootable (guestfs_h *g,\n"
14777 " const char *device,\n"
14779 " int bootable);\n"
14784 #: ../src/guestfs-actions.pod:5144 ../fish/guestfish-actions.pod:3474
14786 "This sets the bootable flag on partition numbered C<partnum> on device "
14787 "C<device>. Note that partitions are numbered from 1."
14791 #: ../src/guestfs-actions.pod:5147 ../fish/guestfish-actions.pod:3477
14793 "The bootable flag is used by some operating systems (notably Windows) to "
14794 "determine which partition to boot from. It is by no means universally "
14799 #: ../src/guestfs-actions.pod:5155
14800 msgid "guestfs_part_set_mbr_id"
14804 #: ../src/guestfs-actions.pod:5157
14808 " guestfs_part_set_mbr_id (guestfs_h *g,\n"
14809 " const char *device,\n"
14816 #: ../src/guestfs-actions.pod:5163 ../fish/guestfish-actions.pod:3485
14818 "Sets the MBR type byte (also known as the ID byte) of the numbered partition "
14819 "C<partnum> to C<idbyte>. Note that the type bytes quoted in most "
14820 "documentation are in fact hexadecimal numbers, but usually documented "
14821 "without any leading \"0x\" which might be confusing."
14825 #: ../src/guestfs-actions.pod:5177
14826 msgid "guestfs_part_set_name"
14830 #: ../src/guestfs-actions.pod:5179
14834 " guestfs_part_set_name (guestfs_h *g,\n"
14835 " const char *device,\n"
14837 " const char *name);\n"
14842 #: ../src/guestfs-actions.pod:5185 ../fish/guestfish-actions.pod:3499
14844 "This sets the partition name on partition numbered C<partnum> on device "
14845 "C<device>. Note that partitions are numbered from 1."
14849 #: ../src/guestfs-actions.pod:5188 ../fish/guestfish-actions.pod:3502
14851 "The partition name can only be set on certain types of partition table. "
14852 "This works on C<gpt> but not on C<mbr> partitions."
14856 #: ../src/guestfs-actions.pod:5195
14857 msgid "guestfs_part_to_dev"
14861 #: ../src/guestfs-actions.pod:5197
14865 " guestfs_part_to_dev (guestfs_h *g,\n"
14866 " const char *partition);\n"
14871 #: ../src/guestfs-actions.pod:5201 ../fish/guestfish-actions.pod:3509
14873 "This function takes a partition name (eg. \"/dev/sdb1\") and removes the "
14874 "partition number, returning the device name (eg. \"/dev/sdb\")."
14878 #: ../src/guestfs-actions.pod:5205
14880 "The named partition must exist, for example as a string returned from "
14881 "C<guestfs_list_partitions>."
14885 #: ../src/guestfs-actions.pod:5213
14886 msgid "guestfs_ping_daemon"
14890 #: ../src/guestfs-actions.pod:5215
14894 " guestfs_ping_daemon (guestfs_h *g);\n"
14899 #: ../src/guestfs-actions.pod:5218 ../fish/guestfish-actions.pod:3520
14901 "This is a test probe into the guestfs daemon running inside the qemu "
14902 "subprocess. Calling this function checks that the daemon responds to the "
14903 "ping message, without affecting the daemon or attached block device(s) in "
14908 #: ../src/guestfs-actions.pod:5227
14909 msgid "guestfs_pread"
14913 #: ../src/guestfs-actions.pod:5229
14917 " guestfs_pread (guestfs_h *g,\n"
14918 " const char *path,\n"
14920 " int64_t offset,\n"
14921 " size_t *size_r);\n"
14926 #: ../src/guestfs-actions.pod:5236 ../fish/guestfish-actions.pod:3529
14928 "This command lets you read part of a file. It reads C<count> bytes of the "
14929 "file, starting at C<offset>, from file C<path>."
14933 #: ../src/guestfs-actions.pod:5239 ../src/guestfs-actions.pod:5265
14934 #: ../fish/guestfish-actions.pod:3532 ../fish/guestfish-actions.pod:3547
14936 "This may read fewer bytes than requested. For further details see the "
14937 "L<pread(2)> system call."
14941 #: ../src/guestfs-actions.pod:5242
14942 msgid "See also C<guestfs_pwrite>, C<guestfs_pread_device>."
14946 #: ../src/guestfs-actions.pod:5253
14947 msgid "guestfs_pread_device"
14951 #: ../src/guestfs-actions.pod:5255
14955 " guestfs_pread_device (guestfs_h *g,\n"
14956 " const char *device,\n"
14958 " int64_t offset,\n"
14959 " size_t *size_r);\n"
14964 #: ../src/guestfs-actions.pod:5262 ../fish/guestfish-actions.pod:3544
14966 "This command lets you read part of a file. It reads C<count> bytes of "
14967 "C<device>, starting at C<offset>."
14971 #: ../src/guestfs-actions.pod:5268
14972 msgid "See also C<guestfs_pread>."
14976 #: ../src/guestfs-actions.pod:5277
14977 msgid "(Added in 1.5.21)"
14981 #: ../src/guestfs-actions.pod:5279
14982 msgid "guestfs_pvcreate"
14986 #: ../src/guestfs-actions.pod:5281
14990 " guestfs_pvcreate (guestfs_h *g,\n"
14991 " const char *device);\n"
14996 #: ../src/guestfs-actions.pod:5285 ../fish/guestfish-actions.pod:3559
14998 "This creates an LVM physical volume on the named C<device>, where C<device> "
14999 "should usually be a partition name such as C</dev/sda1>."
15003 #: ../src/guestfs-actions.pod:5293
15004 msgid "guestfs_pvremove"
15008 #: ../src/guestfs-actions.pod:5295
15012 " guestfs_pvremove (guestfs_h *g,\n"
15013 " const char *device);\n"
15018 #: ../src/guestfs-actions.pod:5299 ../fish/guestfish-actions.pod:3567
15020 "This wipes a physical volume C<device> so that LVM will no longer recognise "
15025 #: ../src/guestfs-actions.pod:5302 ../fish/guestfish-actions.pod:3570
15027 "The implementation uses the C<pvremove> command which refuses to wipe "
15028 "physical volumes that contain any volume groups, so you have to remove those "
15033 #: ../src/guestfs-actions.pod:5310
15034 msgid "guestfs_pvresize"
15038 #: ../src/guestfs-actions.pod:5312
15042 " guestfs_pvresize (guestfs_h *g,\n"
15043 " const char *device);\n"
15048 #: ../src/guestfs-actions.pod:5316 ../fish/guestfish-actions.pod:3578
15050 "This resizes (expands or shrinks) an existing LVM physical volume to match "
15051 "the new size of the underlying device."
15055 #: ../src/guestfs-actions.pod:5323
15056 msgid "guestfs_pvresize_size"
15060 #: ../src/guestfs-actions.pod:5325
15064 " guestfs_pvresize_size (guestfs_h *g,\n"
15065 " const char *device,\n"
15066 " int64_t size);\n"
15071 #: ../src/guestfs-actions.pod:5330
15073 "This command is the same as C<guestfs_pvresize> except that it allows you to "
15074 "specify the new size (in bytes) explicitly."
15078 #: ../src/guestfs-actions.pod:5337
15079 msgid "guestfs_pvs"
15083 #: ../src/guestfs-actions.pod:5339
15087 " guestfs_pvs (guestfs_h *g);\n"
15092 #: ../src/guestfs-actions.pod:5342 ../fish/guestfish-actions.pod:3592
15094 "List all the physical volumes detected. This is the equivalent of the L<pvs"
15099 #: ../src/guestfs-actions.pod:5345 ../fish/guestfish-actions.pod:3595
15101 "This returns a list of just the device names that contain PVs (eg. C</dev/"
15106 #: ../src/guestfs-actions.pod:5348
15107 msgid "See also C<guestfs_pvs_full>."
15111 #: ../src/guestfs-actions.pod:5356
15112 msgid "guestfs_pvs_full"
15116 #: ../src/guestfs-actions.pod:5358
15119 " struct guestfs_lvm_pv_list *\n"
15120 " guestfs_pvs_full (guestfs_h *g);\n"
15125 #: ../src/guestfs-actions.pod:5361 ../fish/guestfish-actions.pod:3604
15127 "List all the physical volumes detected. This is the equivalent of the L<pvs"
15128 "(8)> command. The \"full\" version includes all fields."
15132 #: ../src/guestfs-actions.pod:5364
15134 "This function returns a C<struct guestfs_lvm_pv_list *>, or NULL if there "
15135 "was an error. I<The caller must call C<guestfs_free_lvm_pv_list> after use>."
15139 #: ../src/guestfs-actions.pod:5370
15140 msgid "guestfs_pvuuid"
15144 #: ../src/guestfs-actions.pod:5372
15148 " guestfs_pvuuid (guestfs_h *g,\n"
15149 " const char *device);\n"
15154 #: ../src/guestfs-actions.pod:5376 ../fish/guestfish-actions.pod:3611
15155 msgid "This command returns the UUID of the LVM PV C<device>."
15159 #: ../src/guestfs-actions.pod:5383
15160 msgid "guestfs_pwrite"
15164 #: ../src/guestfs-actions.pod:5385
15168 " guestfs_pwrite (guestfs_h *g,\n"
15169 " const char *path,\n"
15170 " const char *content,\n"
15171 " size_t content_size,\n"
15172 " int64_t offset);\n"
15177 #: ../src/guestfs-actions.pod:5392 ../fish/guestfish-actions.pod:3617
15179 "This command writes to part of a file. It writes the data buffer C<content> "
15180 "to the file C<path> starting at offset C<offset>."
15184 #: ../src/guestfs-actions.pod:5395 ../fish/guestfish-actions.pod:3620
15186 "This command implements the L<pwrite(2)> system call, and like that system "
15187 "call it may not write the full data requested. The return value is the "
15188 "number of bytes that were actually written to the file. This could even be "
15189 "0, although short writes are unlikely for regular files in ordinary "
15194 #: ../src/guestfs-actions.pod:5401
15195 msgid "See also C<guestfs_pread>, C<guestfs_pwrite_device>."
15199 #: ../src/guestfs-actions.pod:5410
15200 msgid "guestfs_pwrite_device"
15204 #: ../src/guestfs-actions.pod:5412
15208 " guestfs_pwrite_device (guestfs_h *g,\n"
15209 " const char *device,\n"
15210 " const char *content,\n"
15211 " size_t content_size,\n"
15212 " int64_t offset);\n"
15217 #: ../src/guestfs-actions.pod:5419 ../fish/guestfish-actions.pod:3635
15219 "This command writes to part of a device. It writes the data buffer "
15220 "C<content> to C<device> starting at offset C<offset>."
15224 #: ../src/guestfs-actions.pod:5422 ../fish/guestfish-actions.pod:3638
15226 "This command implements the L<pwrite(2)> system call, and like that system "
15227 "call it may not write the full data requested (although short writes to disk "
15228 "devices and partitions are probably impossible with standard Linux kernels)."
15232 #: ../src/guestfs-actions.pod:5427
15233 msgid "See also C<guestfs_pwrite>."
15237 #: ../src/guestfs-actions.pod:5434
15238 msgid "(Added in 1.5.20)"
15242 #: ../src/guestfs-actions.pod:5436
15243 msgid "guestfs_read_file"
15247 #: ../src/guestfs-actions.pod:5438
15251 " guestfs_read_file (guestfs_h *g,\n"
15252 " const char *path,\n"
15253 " size_t *size_r);\n"
15258 #: ../src/guestfs-actions.pod:5443 ../fish/guestfish-actions.pod:3652
15259 msgid "This calls returns the contents of the file C<path> as a buffer."
15263 #: ../src/guestfs-actions.pod:5446
15265 "Unlike C<guestfs_cat>, this function can correctly handle files that contain "
15266 "embedded ASCII NUL characters. However unlike C<guestfs_download>, this "
15267 "function is limited in the total size of file that can be handled."
15271 #: ../src/guestfs-actions.pod:5458
15272 msgid "(Added in 1.0.63)"
15276 #: ../src/guestfs-actions.pod:5460
15277 msgid "guestfs_read_lines"
15281 #: ../src/guestfs-actions.pod:5462
15285 " guestfs_read_lines (guestfs_h *g,\n"
15286 " const char *path);\n"
15291 #: ../src/guestfs-actions.pod:5468 ../fish/guestfish-actions.pod:3669
15293 "The file contents are returned as a list of lines. Trailing C<LF> and "
15294 "C<CRLF> character sequences are I<not> returned."
15298 #: ../src/guestfs-actions.pod:5471
15300 "Note that this function cannot correctly handle binary files (specifically, "
15301 "files containing C<\\0> character which is treated as end of line). For "
15302 "those you need to use the C<guestfs_read_file> function which has a more "
15303 "complex interface."
15307 #: ../src/guestfs-actions.pod:5482
15308 msgid "guestfs_readdir"
15312 #: ../src/guestfs-actions.pod:5484
15315 " struct guestfs_dirent_list *\n"
15316 " guestfs_readdir (guestfs_h *g,\n"
15317 " const char *dir);\n"
15322 #: ../src/guestfs-actions.pod:5488 ../fish/guestfish-actions.pod:3681
15323 msgid "This returns the list of directory entries in directory C<dir>."
15327 #: ../src/guestfs-actions.pod:5490 ../fish/guestfish-actions.pod:3683
15329 "All entries in the directory are returned, including C<.> and C<..>. The "
15330 "entries are I<not> sorted, but returned in the same order as the underlying "
15335 #: ../src/guestfs-actions.pod:5494 ../fish/guestfish-actions.pod:3687
15337 "Also this call returns basic file type information about each file. The "
15338 "C<ftyp> field will contain one of the following characters:"
15342 #: ../src/guestfs-actions.pod:5499 ../fish/guestfish-actions.pod:3692
15347 #: ../src/guestfs-actions.pod:5501 ../fish/guestfish-actions.pod:3694
15348 msgid "Block special"
15352 #: ../src/guestfs-actions.pod:5503 ../fish/guestfish-actions.pod:3696
15357 #: ../src/guestfs-actions.pod:5505 ../fish/guestfish-actions.pod:3698
15358 msgid "Char special"
15362 #: ../src/guestfs-actions.pod:5507 ../fish/guestfish-actions.pod:3700
15367 #: ../src/guestfs-actions.pod:5509 ../fish/guestfish-actions.pod:3702
15372 #: ../src/guestfs-actions.pod:5511 ../fish/guestfish-actions.pod:3704
15377 #: ../src/guestfs-actions.pod:5513 ../fish/guestfish-actions.pod:3706
15378 msgid "FIFO (named pipe)"
15382 #: ../src/guestfs-actions.pod:5515 ../fish/guestfish-actions.pod:3708
15387 #: ../src/guestfs-actions.pod:5517 ../fish/guestfish-actions.pod:3710
15388 msgid "Symbolic link"
15392 #: ../src/guestfs-actions.pod:5519 ../fish/guestfish-actions.pod:3712
15397 #: ../src/guestfs-actions.pod:5521 ../fish/guestfish-actions.pod:3714
15398 msgid "Regular file"
15402 #: ../src/guestfs-actions.pod:5523 ../fish/guestfish-actions.pod:3716
15407 #: ../src/guestfs-actions.pod:5525 ../fish/guestfish-actions.pod:3718
15412 #: ../src/guestfs-actions.pod:5527 ../fish/guestfish-actions.pod:3720
15417 #: ../src/guestfs-actions.pod:5529 ../fish/guestfish-actions.pod:3722
15418 msgid "Unknown file type"
15422 #: ../src/guestfs-actions.pod:5531 ../fish/guestfish-actions.pod:3724
15427 #: ../src/guestfs-actions.pod:5533 ../fish/guestfish-actions.pod:3726
15429 "The L<readdir(3)> call returned a C<d_type> field with an unexpected value"
15433 #: ../src/guestfs-actions.pod:5538
15435 "This function is primarily intended for use by programs. To get a simple "
15436 "list of names, use C<guestfs_ls>. To get a printable directory for human "
15437 "consumption, use C<guestfs_ll>."
15441 #: ../src/guestfs-actions.pod:5542
15443 "This function returns a C<struct guestfs_dirent_list *>, or NULL if there "
15444 "was an error. I<The caller must call C<guestfs_free_dirent_list> after use>."
15448 #: ../src/guestfs-actions.pod:5548
15449 msgid "guestfs_readlink"
15453 #: ../src/guestfs-actions.pod:5550
15457 " guestfs_readlink (guestfs_h *g,\n"
15458 " const char *path);\n"
15463 #: ../src/guestfs-actions.pod:5554 ../fish/guestfish-actions.pod:3739
15464 msgid "This command reads the target of a symbolic link."
15468 #: ../src/guestfs-actions.pod:5561
15469 msgid "guestfs_readlinklist"
15473 #: ../src/guestfs-actions.pod:5563
15477 " guestfs_readlinklist (guestfs_h *g,\n"
15478 " const char *path,\n"
15479 " char *const *names);\n"
15484 #: ../src/guestfs-actions.pod:5568 ../fish/guestfish-actions.pod:3745
15486 "This call allows you to do a C<readlink> operation on multiple files, where "
15487 "all files are in the directory C<path>. C<names> is the list of files from "
15492 #: ../src/guestfs-actions.pod:5572 ../fish/guestfish-actions.pod:3749
15494 "On return you get a list of strings, with a one-to-one correspondence to the "
15495 "C<names> list. Each string is the value of the symbolic link."
15499 #: ../src/guestfs-actions.pod:5576 ../fish/guestfish-actions.pod:3753
15501 "If the C<readlink(2)> operation fails on any name, then the corresponding "
15502 "result string is the empty string C<\"\">. However the whole operation is "
15503 "completed even if there were C<readlink(2)> errors, and so you can call this "
15504 "function with names where you don't know if they are symbolic links already "
15505 "(albeit slightly less efficient)."
15509 #: ../src/guestfs-actions.pod:5583 ../fish/guestfish-actions.pod:3760
15511 "This call is intended for programs that want to efficiently list a directory "
15512 "contents without making many round-trips. Very long directory listings "
15513 "might cause the protocol message size to be exceeded, causing this call to "
15514 "fail. The caller must split up such requests into smaller groups of names."
15518 #: ../src/guestfs-actions.pod:5596
15519 msgid "guestfs_realpath"
15523 #: ../src/guestfs-actions.pod:5598
15527 " guestfs_realpath (guestfs_h *g,\n"
15528 " const char *path);\n"
15533 #: ../src/guestfs-actions.pod:5602 ../fish/guestfish-actions.pod:3771
15535 "Return the canonicalized absolute pathname of C<path>. The returned path "
15536 "has no C<.>, C<..> or symbolic link path elements."
15540 #: ../src/guestfs-actions.pod:5610
15541 msgid "guestfs_removexattr"
15545 #: ../src/guestfs-actions.pod:5612
15549 " guestfs_removexattr (guestfs_h *g,\n"
15550 " const char *xattr,\n"
15551 " const char *path);\n"
15556 #: ../src/guestfs-actions.pod:5617 ../fish/guestfish-actions.pod:3778
15558 "This call removes the extended attribute named C<xattr> of the file C<path>."
15562 #: ../src/guestfs-actions.pod:5620
15563 msgid "See also: C<guestfs_lremovexattr>, L<attr(5)>."
15567 #: ../src/guestfs-actions.pod:5626
15568 msgid "guestfs_resize2fs"
15572 #: ../src/guestfs-actions.pod:5628
15576 " guestfs_resize2fs (guestfs_h *g,\n"
15577 " const char *device);\n"
15582 #: ../src/guestfs-actions.pod:5632 ../fish/guestfish-actions.pod:3787
15584 "This resizes an ext2, ext3 or ext4 filesystem to match the size of the "
15585 "underlying device."
15589 #: ../src/guestfs-actions.pod:5635
15591 "I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f> on the "
15592 "C<device> before calling this command. For unknown reasons C<resize2fs> "
15593 "sometimes gives an error about this and sometimes not. In any case, it is "
15594 "always safe to call C<guestfs_e2fsck_f> before calling this function."
15598 #: ../src/guestfs-actions.pod:5645
15599 msgid "guestfs_resize2fs_M"
15603 #: ../src/guestfs-actions.pod:5647
15607 " guestfs_resize2fs_M (guestfs_h *g,\n"
15608 " const char *device);\n"
15613 #: ../src/guestfs-actions.pod:5651
15615 "This command is the same as C<guestfs_resize2fs>, but the filesystem is "
15616 "resized to its minimum size. This works like the I<-M> option to the "
15617 "C<resize2fs> command."
15621 #: ../src/guestfs-actions.pod:5655
15623 "To get the resulting size of the filesystem you should call "
15624 "C<guestfs_tune2fs_l> and read the C<Block size> and C<Block count> values. "
15625 "These two numbers, multiplied together, give the resulting size of the "
15626 "minimal filesystem in bytes."
15630 #: ../src/guestfs-actions.pod:5662
15631 msgid "guestfs_resize2fs_size"
15635 #: ../src/guestfs-actions.pod:5664
15639 " guestfs_resize2fs_size (guestfs_h *g,\n"
15640 " const char *device,\n"
15641 " int64_t size);\n"
15646 #: ../src/guestfs-actions.pod:5669
15648 "This command is the same as C<guestfs_resize2fs> except that it allows you "
15649 "to specify the new size (in bytes) explicitly."
15653 #: ../src/guestfs-actions.pod:5676
15658 #: ../src/guestfs-actions.pod:5678
15662 " guestfs_rm (guestfs_h *g,\n"
15663 " const char *path);\n"
15668 #: ../src/guestfs-actions.pod:5682 ../fish/guestfish-actions.pod:3820
15669 msgid "Remove the single file C<path>."
15673 #: ../src/guestfs-actions.pod:5688
15674 msgid "guestfs_rm_rf"
15678 #: ../src/guestfs-actions.pod:5690
15682 " guestfs_rm_rf (guestfs_h *g,\n"
15683 " const char *path);\n"
15688 #: ../src/guestfs-actions.pod:5694 ../fish/guestfish-actions.pod:3826
15690 "Remove the file or directory C<path>, recursively removing the contents if "
15691 "its a directory. This is like the C<rm -rf> shell command."
15695 #: ../src/guestfs-actions.pod:5702
15696 msgid "guestfs_rmdir"
15700 #: ../src/guestfs-actions.pod:5704
15704 " guestfs_rmdir (guestfs_h *g,\n"
15705 " const char *path);\n"
15710 #: ../src/guestfs-actions.pod:5708 ../fish/guestfish-actions.pod:3834
15711 msgid "Remove the single directory C<path>."
15715 #: ../src/guestfs-actions.pod:5714
15716 msgid "guestfs_rmmountpoint"
15720 #: ../src/guestfs-actions.pod:5716
15724 " guestfs_rmmountpoint (guestfs_h *g,\n"
15725 " const char *exemptpath);\n"
15730 #: ../src/guestfs-actions.pod:5720
15732 "This calls removes a mountpoint that was previously created with "
15733 "C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint> for full details."
15737 #: ../src/guestfs-actions.pod:5728
15738 msgid "guestfs_scrub_device"
15742 #: ../src/guestfs-actions.pod:5730
15746 " guestfs_scrub_device (guestfs_h *g,\n"
15747 " const char *device);\n"
15752 #: ../src/guestfs-actions.pod:5734 ../fish/guestfish-actions.pod:3848
15754 "This command writes patterns over C<device> to make data retrieval more "
15759 #: ../src/guestfs-actions.pod:5737 ../src/guestfs-actions.pod:5758
15760 #: ../src/guestfs-actions.pod:5777 ../fish/guestfish-actions.pod:3851
15761 #: ../fish/guestfish-actions.pod:3866 ../fish/guestfish-actions.pod:3879
15763 "It is an interface to the L<scrub(1)> program. See that manual page for "
15768 #: ../src/guestfs-actions.pod:5745 ../src/guestfs-actions.pod:5763
15769 #: ../src/guestfs-actions.pod:5782
15770 msgid "(Added in 1.0.52)"
15774 #: ../src/guestfs-actions.pod:5747
15775 msgid "guestfs_scrub_file"
15779 #: ../src/guestfs-actions.pod:5749
15783 " guestfs_scrub_file (guestfs_h *g,\n"
15784 " const char *file);\n"
15789 #: ../src/guestfs-actions.pod:5753 ../fish/guestfish-actions.pod:3861
15791 "This command writes patterns over a file to make data retrieval more "
15796 #: ../src/guestfs-actions.pod:5756 ../fish/guestfish-actions.pod:3864
15797 msgid "The file is I<removed> after scrubbing."
15801 #: ../src/guestfs-actions.pod:5765
15802 msgid "guestfs_scrub_freespace"
15806 #: ../src/guestfs-actions.pod:5767
15810 " guestfs_scrub_freespace (guestfs_h *g,\n"
15811 " const char *dir);\n"
15816 #: ../src/guestfs-actions.pod:5771
15818 "This command creates the directory C<dir> and then fills it with files until "
15819 "the filesystem is full, and scrubs the files as for C<guestfs_scrub_file>, "
15820 "and deletes them. The intention is to scrub any free space on the partition "
15821 "containing C<dir>."
15825 #: ../src/guestfs-actions.pod:5784
15826 msgid "guestfs_set_append"
15830 #: ../src/guestfs-actions.pod:5786
15834 " guestfs_set_append (guestfs_h *g,\n"
15835 " const char *append);\n"
15840 #: ../src/guestfs-actions.pod:5790 ../fish/guestfish-actions.pod:3888
15842 "This function is used to add additional options to the guest kernel command "
15847 #: ../src/guestfs-actions.pod:5793 ../fish/guestfish-actions.pod:3891
15849 "The default is C<NULL> unless overridden by setting C<LIBGUESTFS_APPEND> "
15850 "environment variable."
15854 #: ../src/guestfs-actions.pod:5796 ../fish/guestfish-actions.pod:3894
15856 "Setting C<append> to C<NULL> means I<no> additional options are passed "
15857 "(libguestfs always adds a few of its own)."
15861 #: ../src/guestfs-actions.pod:5803
15862 msgid "guestfs_set_attach_method"
15866 #: ../src/guestfs-actions.pod:5805
15870 " guestfs_set_attach_method (guestfs_h *g,\n"
15871 " const char *attachmethod);\n"
15876 #: ../src/guestfs-actions.pod:5809 ../fish/guestfish-actions.pod:3903
15878 "Set the method that libguestfs uses to connect to the back end guestfsd "
15879 "daemon. Possible methods are:"
15883 #: ../src/guestfs-actions.pod:5816 ../fish/guestfish-actions.pod:3910
15885 "Launch an appliance and connect to it. This is the ordinary method and the "
15890 #: ../src/guestfs-actions.pod:5819 ../fish/guestfish-actions.pod:3913
15891 msgid "C<unix:I<path>>"
15895 #: ../src/guestfs-actions.pod:5821 ../fish/guestfish-actions.pod:3915
15896 msgid "Connect to the Unix domain socket I<path>."
15900 #: ../src/guestfs-actions.pod:5823 ../fish/guestfish-actions.pod:3917
15902 "This method lets you connect to an existing daemon or (using virtio-serial) "
15903 "to a live guest. For more information, see L<guestfs(3)/ATTACHING TO "
15904 "RUNNING DAEMONS>."
15908 #: ../src/guestfs-actions.pod:5831
15909 msgid "guestfs_set_autosync"
15913 #: ../src/guestfs-actions.pod:5833
15917 " guestfs_set_autosync (guestfs_h *g,\n"
15918 " int autosync);\n"
15923 #: ../src/guestfs-actions.pod:5837 ../fish/guestfish-actions.pod:3929
15925 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
15926 "effort attempt to make filesystems consistent and synchronized when the "
15927 "handle is closed (also if the program exits without closing handles)."
15931 #: ../src/guestfs-actions.pod:5842 ../fish/guestfish-actions.pod:3934
15933 "This is enabled by default (since libguestfs 1.5.24, previously it was "
15934 "disabled by default)."
15938 #: ../src/guestfs-actions.pod:5849
15939 msgid "guestfs_set_direct"
15943 #: ../src/guestfs-actions.pod:5851
15947 " guestfs_set_direct (guestfs_h *g,\n"
15953 #: ../src/guestfs-actions.pod:5855 ../fish/guestfish-actions.pod:3943
15955 "If the direct appliance mode flag is enabled, then stdin and stdout are "
15956 "passed directly through to the appliance once it is launched."
15960 #: ../src/guestfs-actions.pod:5859
15962 "One consequence of this is that log messages aren't caught by the library "
15963 "and handled by C<guestfs_set_log_message_callback>, but go straight to "
15968 #: ../src/guestfs-actions.pod:5863 ../fish/guestfish-actions.pod:3951
15969 msgid "You probably don't want to use this unless you know what you are doing."
15973 #: ../src/guestfs-actions.pod:5866 ../fish/guestfish-actions.pod:3954
15974 msgid "The default is disabled."
15978 #: ../src/guestfs-actions.pod:5872
15979 msgid "guestfs_set_e2label"
15983 #: ../src/guestfs-actions.pod:5874
15987 " guestfs_set_e2label (guestfs_h *g,\n"
15988 " const char *device,\n"
15989 " const char *label);\n"
15994 #: ../src/guestfs-actions.pod:5879 ../fish/guestfish-actions.pod:3960
15996 "This sets the ext2/3/4 filesystem label of the filesystem on C<device> to "
15997 "C<label>. Filesystem labels are limited to 16 characters."
16001 #: ../src/guestfs-actions.pod:5883
16003 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label> to return "
16004 "the existing label on a filesystem."
16008 #: ../src/guestfs-actions.pod:5890
16009 msgid "guestfs_set_e2uuid"
16013 #: ../src/guestfs-actions.pod:5892
16017 " guestfs_set_e2uuid (guestfs_h *g,\n"
16018 " const char *device,\n"
16019 " const char *uuid);\n"
16024 #: ../src/guestfs-actions.pod:5897 ../fish/guestfish-actions.pod:3971
16026 "This sets the ext2/3/4 filesystem UUID of the filesystem on C<device> to "
16027 "C<uuid>. The format of the UUID and alternatives such as C<clear>, "
16028 "C<random> and C<time> are described in the L<tune2fs(8)> manpage."
16032 #: ../src/guestfs-actions.pod:5902
16034 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid> to return "
16035 "the existing UUID of a filesystem."
16039 #: ../src/guestfs-actions.pod:5909
16040 msgid "guestfs_set_memsize"
16044 #: ../src/guestfs-actions.pod:5911
16048 " guestfs_set_memsize (guestfs_h *g,\n"
16054 #: ../src/guestfs-actions.pod:5915
16056 "This sets the memory size in megabytes allocated to the qemu subprocess. "
16057 "This only has any effect if called before C<guestfs_launch>."
16061 #: ../src/guestfs-actions.pod:5919 ../fish/guestfish-actions.pod:3989
16063 "You can also change this by setting the environment variable "
16064 "C<LIBGUESTFS_MEMSIZE> before the handle is created."
16068 #: ../src/guestfs-actions.pod:5930
16069 msgid "guestfs_set_network"
16073 #: ../src/guestfs-actions.pod:5932
16077 " guestfs_set_network (guestfs_h *g,\n"
16083 #: ../src/guestfs-actions.pod:5936 ../fish/guestfish-actions.pod:4002
16085 "If C<network> is true, then the network is enabled in the libguestfs "
16086 "appliance. The default is false."
16090 #: ../src/guestfs-actions.pod:5939 ../fish/guestfish-actions.pod:4005
16092 "This affects whether commands are able to access the network (see L<guestfs"
16093 "(3)/RUNNING COMMANDS>)."
16097 #: ../src/guestfs-actions.pod:5942
16099 "You must call this before calling C<guestfs_launch>, otherwise it has no "
16104 #: ../src/guestfs-actions.pod:5949
16105 msgid "guestfs_set_path"
16109 #: ../src/guestfs-actions.pod:5951
16113 " guestfs_set_path (guestfs_h *g,\n"
16114 " const char *searchpath);\n"
16119 #: ../src/guestfs-actions.pod:5955 ../fish/guestfish-actions.pod:4017
16120 msgid "Set the path that libguestfs searches for kernel and initrd.img."
16124 #: ../src/guestfs-actions.pod:5957 ../fish/guestfish-actions.pod:4019
16126 "The default is C<$libdir/guestfs> unless overridden by setting "
16127 "C<LIBGUESTFS_PATH> environment variable."
16131 #: ../src/guestfs-actions.pod:5960 ../fish/guestfish-actions.pod:4022
16132 msgid "Setting C<path> to C<NULL> restores the default path."
16136 #: ../src/guestfs-actions.pod:5966
16137 msgid "guestfs_set_qemu"
16141 #: ../src/guestfs-actions.pod:5968
16145 " guestfs_set_qemu (guestfs_h *g,\n"
16146 " const char *qemu);\n"
16151 #: ../src/guestfs-actions.pod:5972 ../fish/guestfish-actions.pod:4030
16152 msgid "Set the qemu binary that we will use."
16156 #: ../src/guestfs-actions.pod:5974 ../fish/guestfish-actions.pod:4032
16158 "The default is chosen when the library was compiled by the configure script."
16162 #: ../src/guestfs-actions.pod:5977 ../fish/guestfish-actions.pod:4035
16164 "You can also override this by setting the C<LIBGUESTFS_QEMU> environment "
16169 #: ../src/guestfs-actions.pod:5980 ../fish/guestfish-actions.pod:4038
16170 msgid "Setting C<qemu> to C<NULL> restores the default qemu binary."
16174 #: ../src/guestfs-actions.pod:5982 ../fish/guestfish-actions.pod:4040
16176 "Note that you should call this function as early as possible after creating "
16177 "the handle. This is because some pre-launch operations depend on testing "
16178 "qemu features (by running C<qemu -help>). If the qemu binary changes, we "
16179 "don't retest features, and so you might see inconsistent results. Using the "
16180 "environment variable C<LIBGUESTFS_QEMU> is safest of all since that picks "
16181 "the qemu binary at the same time as the handle is created."
16185 #: ../src/guestfs-actions.pod:5994
16186 msgid "guestfs_set_recovery_proc"
16190 #: ../src/guestfs-actions.pod:5996
16194 " guestfs_set_recovery_proc (guestfs_h *g,\n"
16195 " int recoveryproc);\n"
16200 #: ../src/guestfs-actions.pod:6000
16202 "If this is called with the parameter C<false> then C<guestfs_launch> does "
16203 "not create a recovery process. The purpose of the recovery process is to "
16204 "stop runaway qemu processes in the case where the main program aborts "
16209 #: ../src/guestfs-actions.pod:6005
16211 "This only has any effect if called before C<guestfs_launch>, and the default "
16216 #: ../src/guestfs-actions.pod:6008 ../fish/guestfish-actions.pod:4062
16218 "About the only time when you would want to disable this is if the main "
16219 "process will fork itself into the background (\"daemonize\" itself). In "
16220 "this case the recovery process thinks that the main program has disappeared "
16221 "and so kills qemu, which is not very helpful."
16225 #: ../src/guestfs-actions.pod:6018
16226 msgid "guestfs_set_selinux"
16230 #: ../src/guestfs-actions.pod:6020
16234 " guestfs_set_selinux (guestfs_h *g,\n"
16240 #: ../src/guestfs-actions.pod:6024 ../fish/guestfish-actions.pod:4074
16242 "This sets the selinux flag that is passed to the appliance at boot time. "
16243 "The default is C<selinux=0> (disabled)."
16247 #: ../src/guestfs-actions.pod:6027 ../fish/guestfish-actions.pod:4077
16249 "Note that if SELinux is enabled, it is always in Permissive mode "
16250 "(C<enforcing=0>)."
16254 #: ../src/guestfs-actions.pod:6037
16255 msgid "guestfs_set_trace"
16259 #: ../src/guestfs-actions.pod:6039
16263 " guestfs_set_trace (guestfs_h *g,\n"
16269 #: ../src/guestfs-actions.pod:6043 ../fish/guestfish-actions.pod:4089
16271 "If the command trace flag is set to 1, then libguestfs calls, parameters and "
16272 "return values are traced."
16276 #: ../src/guestfs-actions.pod:6046 ../fish/guestfish-actions.pod:4092
16278 "If you want to trace C API calls into libguestfs (and other libraries) then "
16279 "possibly a better way is to use the external ltrace(1) command."
16283 #: ../src/guestfs-actions.pod:6050 ../fish/guestfish-actions.pod:4096
16285 "Command traces are disabled unless the environment variable "
16286 "C<LIBGUESTFS_TRACE> is defined and set to C<1>."
16290 #: ../src/guestfs-actions.pod:6053
16292 "Trace messages are normally sent to C<stderr>, unless you register a "
16293 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
16297 #: ../src/guestfs-actions.pod:6061
16298 msgid "guestfs_set_verbose"
16302 #: ../src/guestfs-actions.pod:6063
16306 " guestfs_set_verbose (guestfs_h *g,\n"
16312 #: ../src/guestfs-actions.pod:6067 ../fish/guestfish-actions.pod:4109
16313 msgid "If C<verbose> is true, this turns on verbose messages."
16317 #: ../src/guestfs-actions.pod:6069 ../fish/guestfish-actions.pod:4111
16319 "Verbose messages are disabled unless the environment variable "
16320 "C<LIBGUESTFS_DEBUG> is defined and set to C<1>."
16324 #: ../src/guestfs-actions.pod:6072
16326 "Verbose messages are normally sent to C<stderr>, unless you register a "
16327 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
16331 #: ../src/guestfs-actions.pod:6080
16332 msgid "guestfs_setcon"
16336 #: ../src/guestfs-actions.pod:6082
16340 " guestfs_setcon (guestfs_h *g,\n"
16341 " const char *context);\n"
16346 #: ../src/guestfs-actions.pod:6086 ../fish/guestfish-actions.pod:4122
16348 "This sets the SELinux security context of the daemon to the string "
16353 #: ../src/guestfs-actions.pod:6089 ../fish/guestfish-actions.pod:4125
16354 msgid "See the documentation about SELINUX in L<guestfs(3)>."
16358 #: ../src/guestfs-actions.pod:6095
16359 msgid "guestfs_setxattr"
16363 #: ../src/guestfs-actions.pod:6097
16367 " guestfs_setxattr (guestfs_h *g,\n"
16368 " const char *xattr,\n"
16369 " const char *val,\n"
16371 " const char *path);\n"
16376 #: ../src/guestfs-actions.pod:6104 ../fish/guestfish-actions.pod:4131
16378 "This call sets the extended attribute named C<xattr> of the file C<path> to "
16379 "the value C<val> (of length C<vallen>). The value is arbitrary 8 bit data."
16383 #: ../src/guestfs-actions.pod:6108
16384 msgid "See also: C<guestfs_lsetxattr>, L<attr(5)>."
16388 #: ../src/guestfs-actions.pod:6114
16389 msgid "guestfs_sfdisk"
16393 #: ../src/guestfs-actions.pod:6116
16397 " guestfs_sfdisk (guestfs_h *g,\n"
16398 " const char *device,\n"
16402 " char *const *lines);\n"
16407 #: ../src/guestfs-actions.pod:6124 ../fish/guestfish-actions.pod:4141
16409 "This is a direct interface to the L<sfdisk(8)> program for creating "
16410 "partitions on block devices."
16414 #: ../src/guestfs-actions.pod:6127 ../fish/guestfish-actions.pod:4144
16415 msgid "C<device> should be a block device, for example C</dev/sda>."
16419 #: ../src/guestfs-actions.pod:6129 ../fish/guestfish-actions.pod:4146
16421 "C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads and "
16422 "sectors on the device, which are passed directly to sfdisk as the I<-C>, I<-"
16423 "H> and I<-S> parameters. If you pass C<0> for any of these, then the "
16424 "corresponding parameter is omitted. Usually for 'large' disks, you can just "
16425 "pass C<0> for these, but for small (floppy-sized) disks, sfdisk (or rather, "
16426 "the kernel) cannot work out the right geometry and you will need to tell it."
16430 #: ../src/guestfs-actions.pod:6137 ../fish/guestfish-actions.pod:4154
16432 "C<lines> is a list of lines that we feed to C<sfdisk>. For more information "
16433 "refer to the L<sfdisk(8)> manpage."
16437 #: ../src/guestfs-actions.pod:6140 ../fish/guestfish-actions.pod:4157
16439 "To create a single partition occupying the whole disk, you would pass "
16440 "C<lines> as a single element list, when the single element being the string "
16445 #: ../src/guestfs-actions.pod:6144
16447 "See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>, C<guestfs_part_init>"
16451 #: ../src/guestfs-actions.pod:6154
16452 msgid "guestfs_sfdiskM"
16456 #: ../src/guestfs-actions.pod:6156
16460 " guestfs_sfdiskM (guestfs_h *g,\n"
16461 " const char *device,\n"
16462 " char *const *lines);\n"
16467 #: ../src/guestfs-actions.pod:6161
16469 "This is a simplified interface to the C<guestfs_sfdisk> command, where "
16470 "partition sizes are specified in megabytes only (rounded to the nearest "
16471 "cylinder) and you don't need to specify the cyls, heads and sectors "
16472 "parameters which were rarely if ever used anyway."
16476 #: ../src/guestfs-actions.pod:6167
16478 "See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage and "
16479 "C<guestfs_part_disk>"
16483 #: ../src/guestfs-actions.pod:6177
16484 msgid "guestfs_sfdisk_N"
16488 #: ../src/guestfs-actions.pod:6179
16492 " guestfs_sfdisk_N (guestfs_h *g,\n"
16493 " const char *device,\n"
16498 " const char *line);\n"
16503 #: ../src/guestfs-actions.pod:6188 ../fish/guestfish-actions.pod:4187
16505 "This runs L<sfdisk(8)> option to modify just the single partition C<n> "
16506 "(note: C<n> counts from 1)."
16510 #: ../src/guestfs-actions.pod:6191
16512 "For other parameters, see C<guestfs_sfdisk>. You should usually pass C<0> "
16513 "for the cyls/heads/sectors parameters."
16517 #: ../src/guestfs-actions.pod:6194
16518 msgid "See also: C<guestfs_part_add>"
16522 #: ../src/guestfs-actions.pod:6203
16523 msgid "guestfs_sfdisk_disk_geometry"
16527 #: ../src/guestfs-actions.pod:6205
16531 " guestfs_sfdisk_disk_geometry (guestfs_h *g,\n"
16532 " const char *device);\n"
16537 #: ../src/guestfs-actions.pod:6209
16539 "This displays the disk geometry of C<device> read from the partition table. "
16540 "Especially in the case where the underlying block device has been resized, "
16541 "this can be different from the kernel's idea of the geometry (see "
16542 "C<guestfs_sfdisk_kernel_geometry>)."
16546 #: ../src/guestfs-actions.pod:6214 ../src/guestfs-actions.pod:6230
16547 #: ../fish/guestfish-actions.pod:4207 ../fish/guestfish-actions.pod:4216
16548 msgid "The result is in human-readable format, and not designed to be parsed."
16552 #: ../src/guestfs-actions.pod:6222
16553 msgid "guestfs_sfdisk_kernel_geometry"
16557 #: ../src/guestfs-actions.pod:6224
16561 " guestfs_sfdisk_kernel_geometry (guestfs_h *g,\n"
16562 " const char *device);\n"
16567 #: ../src/guestfs-actions.pod:6228 ../fish/guestfish-actions.pod:4214
16568 msgid "This displays the kernel's idea of the geometry of C<device>."
16572 #: ../src/guestfs-actions.pod:6238
16573 msgid "guestfs_sfdisk_l"
16577 #: ../src/guestfs-actions.pod:6240
16581 " guestfs_sfdisk_l (guestfs_h *g,\n"
16582 " const char *device);\n"
16587 #: ../src/guestfs-actions.pod:6244 ../fish/guestfish-actions.pod:4223
16589 "This displays the partition table on C<device>, in the human-readable output "
16590 "of the L<sfdisk(8)> command. It is not intended to be parsed."
16594 #: ../src/guestfs-actions.pod:6248
16595 msgid "See also: C<guestfs_part_list>"
16599 #: ../src/guestfs-actions.pod:6255
16604 #: ../src/guestfs-actions.pod:6257
16608 " guestfs_sh (guestfs_h *g,\n"
16609 " const char *command);\n"
16614 #: ../src/guestfs-actions.pod:6261 ../fish/guestfish-actions.pod:4233
16616 "This call runs a command from the guest filesystem via the guest's C</bin/"
16621 #: ../src/guestfs-actions.pod:6264
16622 msgid "This is like C<guestfs_command>, but passes the command to:"
16626 #: ../src/guestfs-actions.pod:6266 ../fish/guestfish-actions.pod:4238
16629 " /bin/sh -c \"command\"\n"
16634 #: ../src/guestfs-actions.pod:6268 ../fish/guestfish-actions.pod:4240
16636 "Depending on the guest's shell, this usually results in wildcards being "
16637 "expanded, shell expressions being interpolated and so on."
16641 #: ../src/guestfs-actions.pod:6272
16642 msgid "All the provisos about C<guestfs_command> apply to this call."
16646 #: ../src/guestfs-actions.pod:6279
16647 msgid "guestfs_sh_lines"
16651 #: ../src/guestfs-actions.pod:6281
16655 " guestfs_sh_lines (guestfs_h *g,\n"
16656 " const char *command);\n"
16661 #: ../src/guestfs-actions.pod:6285
16663 "This is the same as C<guestfs_sh>, but splits the result into a list of "
16668 #: ../src/guestfs-actions.pod:6288
16669 msgid "See also: C<guestfs_command_lines>"
16673 #: ../src/guestfs-actions.pod:6296
16674 msgid "guestfs_sleep"
16678 #: ../src/guestfs-actions.pod:6298
16682 " guestfs_sleep (guestfs_h *g,\n"
16688 #: ../src/guestfs-actions.pod:6302 ../fish/guestfish-actions.pod:4259
16689 msgid "Sleep for C<secs> seconds."
16693 #: ../src/guestfs-actions.pod:6306
16694 msgid "(Added in 1.0.41)"
16698 #: ../src/guestfs-actions.pod:6308 ../src/guestfs-structs.pod:109
16699 msgid "guestfs_stat"
16703 #: ../src/guestfs-actions.pod:6310
16706 " struct guestfs_stat *\n"
16707 " guestfs_stat (guestfs_h *g,\n"
16708 " const char *path);\n"
16713 #: ../src/guestfs-actions.pod:6316 ../fish/guestfish-actions.pod:4267
16714 msgid "This is the same as the C<stat(2)> system call."
16718 #: ../src/guestfs-actions.pod:6324 ../src/guestfs-structs.pod:135
16719 msgid "guestfs_statvfs"
16723 #: ../src/guestfs-actions.pod:6326
16726 " struct guestfs_statvfs *\n"
16727 " guestfs_statvfs (guestfs_h *g,\n"
16728 " const char *path);\n"
16733 #: ../src/guestfs-actions.pod:6330 ../fish/guestfish-actions.pod:4273
16735 "Returns file system statistics for any mounted file system. C<path> should "
16736 "be a file or directory in the mounted file system (typically it is the mount "
16737 "point itself, but it doesn't need to be)."
16741 #: ../src/guestfs-actions.pod:6334 ../fish/guestfish-actions.pod:4277
16742 msgid "This is the same as the C<statvfs(2)> system call."
16746 #: ../src/guestfs-actions.pod:6336
16748 "This function returns a C<struct guestfs_statvfs *>, or NULL if there was an "
16749 "error. I<The caller must call C<guestfs_free_statvfs> after use>."
16753 #: ../src/guestfs-actions.pod:6342
16754 msgid "guestfs_strings"
16758 #: ../src/guestfs-actions.pod:6344
16762 " guestfs_strings (guestfs_h *g,\n"
16763 " const char *path);\n"
16768 #: ../src/guestfs-actions.pod:6348 ../fish/guestfish-actions.pod:4283
16770 "This runs the L<strings(1)> command on a file and returns the list of "
16771 "printable strings found."
16775 #: ../src/guestfs-actions.pod:6360
16776 msgid "guestfs_strings_e"
16780 #: ../src/guestfs-actions.pod:6362
16784 " guestfs_strings_e (guestfs_h *g,\n"
16785 " const char *encoding,\n"
16786 " const char *path);\n"
16791 #: ../src/guestfs-actions.pod:6367
16793 "This is like the C<guestfs_strings> command, but allows you to specify the "
16794 "encoding of strings that are looked for in the source file C<path>."
16798 #: ../src/guestfs-actions.pod:6371 ../fish/guestfish-actions.pod:4297
16799 msgid "Allowed encodings are:"
16803 #: ../src/guestfs-actions.pod:6375 ../fish/guestfish-actions.pod:4301
16808 #: ../src/guestfs-actions.pod:6377
16810 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
16811 "ISO-8859-X (this is what C<guestfs_strings> uses)."
16815 #: ../src/guestfs-actions.pod:6380 ../fish/guestfish-actions.pod:4306
16820 #: ../src/guestfs-actions.pod:6382 ../fish/guestfish-actions.pod:4308
16821 msgid "Single 8-bit-byte characters."
16825 #: ../src/guestfs-actions.pod:6384 ../fish/guestfish-actions.pod:4310
16830 #: ../src/guestfs-actions.pod:6386 ../fish/guestfish-actions.pod:4312
16831 msgid "16-bit big endian strings such as those encoded in UTF-16BE or UCS-2BE."
16835 #: ../src/guestfs-actions.pod:6389 ../fish/guestfish-actions.pod:4315
16836 msgid "l (lower case letter L)"
16840 #: ../src/guestfs-actions.pod:6391 ../fish/guestfish-actions.pod:4317
16842 "16-bit little endian such as UTF-16LE and UCS-2LE. This is useful for "
16843 "examining binaries in Windows guests."
16847 #: ../src/guestfs-actions.pod:6394 ../fish/guestfish-actions.pod:4320
16852 #: ../src/guestfs-actions.pod:6396 ../fish/guestfish-actions.pod:4322
16853 msgid "32-bit big endian such as UCS-4BE."
16857 #: ../src/guestfs-actions.pod:6398 ../fish/guestfish-actions.pod:4324
16862 #: ../src/guestfs-actions.pod:6400 ../fish/guestfish-actions.pod:4326
16863 msgid "32-bit little endian such as UCS-4LE."
16867 #: ../src/guestfs-actions.pod:6404 ../fish/guestfish-actions.pod:4330
16868 msgid "The returned strings are transcoded to UTF-8."
16872 #: ../src/guestfs-actions.pod:6415
16873 msgid "guestfs_swapoff_device"
16877 #: ../src/guestfs-actions.pod:6417
16881 " guestfs_swapoff_device (guestfs_h *g,\n"
16882 " const char *device);\n"
16887 #: ../src/guestfs-actions.pod:6421
16889 "This command disables the libguestfs appliance swap device or partition "
16890 "named C<device>. See C<guestfs_swapon_device>."
16894 #: ../src/guestfs-actions.pod:6429
16895 msgid "guestfs_swapoff_file"
16899 #: ../src/guestfs-actions.pod:6431
16903 " guestfs_swapoff_file (guestfs_h *g,\n"
16904 " const char *file);\n"
16909 #: ../src/guestfs-actions.pod:6435 ../fish/guestfish-actions.pod:4347
16910 msgid "This command disables the libguestfs appliance swap on file."
16914 #: ../src/guestfs-actions.pod:6441
16915 msgid "guestfs_swapoff_label"
16919 #: ../src/guestfs-actions.pod:6443
16923 " guestfs_swapoff_label (guestfs_h *g,\n"
16924 " const char *label);\n"
16929 #: ../src/guestfs-actions.pod:6447 ../fish/guestfish-actions.pod:4353
16931 "This command disables the libguestfs appliance swap on labeled swap "
16936 #: ../src/guestfs-actions.pod:6454
16937 msgid "guestfs_swapoff_uuid"
16941 #: ../src/guestfs-actions.pod:6456
16945 " guestfs_swapoff_uuid (guestfs_h *g,\n"
16946 " const char *uuid);\n"
16951 #: ../src/guestfs-actions.pod:6460 ../fish/guestfish-actions.pod:4360
16953 "This command disables the libguestfs appliance swap partition with the given "
16958 #: ../src/guestfs-actions.pod:6467
16959 msgid "guestfs_swapon_device"
16963 #: ../src/guestfs-actions.pod:6469
16967 " guestfs_swapon_device (guestfs_h *g,\n"
16968 " const char *device);\n"
16973 #: ../src/guestfs-actions.pod:6473
16975 "This command enables the libguestfs appliance to use the swap device or "
16976 "partition named C<device>. The increased memory is made available for all "
16977 "commands, for example those run using C<guestfs_command> or C<guestfs_sh>."
16981 #: ../src/guestfs-actions.pod:6478 ../fish/guestfish-actions.pod:4372
16983 "Note that you should not swap to existing guest swap partitions unless you "
16984 "know what you are doing. They may contain hibernation information, or other "
16985 "information that the guest doesn't want you to trash. You also risk leaking "
16986 "information about the host to the guest this way. Instead, attach a new "
16987 "host device to the guest and swap on that."
16991 #: ../src/guestfs-actions.pod:6489
16992 msgid "guestfs_swapon_file"
16996 #: ../src/guestfs-actions.pod:6491
17000 " guestfs_swapon_file (guestfs_h *g,\n"
17001 " const char *file);\n"
17006 #: ../src/guestfs-actions.pod:6495
17008 "This command enables swap to a file. See C<guestfs_swapon_device> for other "
17013 #: ../src/guestfs-actions.pod:6502
17014 msgid "guestfs_swapon_label"
17018 #: ../src/guestfs-actions.pod:6504
17022 " guestfs_swapon_label (guestfs_h *g,\n"
17023 " const char *label);\n"
17028 #: ../src/guestfs-actions.pod:6508
17030 "This command enables swap to a labeled swap partition. See "
17031 "C<guestfs_swapon_device> for other notes."
17035 #: ../src/guestfs-actions.pod:6515
17036 msgid "guestfs_swapon_uuid"
17040 #: ../src/guestfs-actions.pod:6517
17044 " guestfs_swapon_uuid (guestfs_h *g,\n"
17045 " const char *uuid);\n"
17050 #: ../src/guestfs-actions.pod:6521
17052 "This command enables swap to a swap partition with the given UUID. See "
17053 "C<guestfs_swapon_device> for other notes."
17057 #: ../src/guestfs-actions.pod:6528
17058 msgid "guestfs_sync"
17062 #: ../src/guestfs-actions.pod:6530
17066 " guestfs_sync (guestfs_h *g);\n"
17071 #: ../src/guestfs-actions.pod:6533 ../fish/guestfish-actions.pod:4404
17073 "This syncs the disk, so that any writes are flushed through to the "
17074 "underlying disk image."
17078 #: ../src/guestfs-actions.pod:6536 ../fish/guestfish-actions.pod:4407
17080 "You should always call this if you have modified a disk image, before "
17081 "closing the handle."
17085 #: ../src/guestfs-actions.pod:6543
17086 msgid "guestfs_tail"
17090 #: ../src/guestfs-actions.pod:6545
17094 " guestfs_tail (guestfs_h *g,\n"
17095 " const char *path);\n"
17100 #: ../src/guestfs-actions.pod:6549 ../fish/guestfish-actions.pod:4414
17102 "This command returns up to the last 10 lines of a file as a list of strings."
17106 #: ../src/guestfs-actions.pod:6561
17107 msgid "guestfs_tail_n"
17111 #: ../src/guestfs-actions.pod:6563
17115 " guestfs_tail_n (guestfs_h *g,\n"
17117 " const char *path);\n"
17122 #: ../src/guestfs-actions.pod:6568 ../fish/guestfish-actions.pod:4424
17124 "If the parameter C<nrlines> is a positive number, this returns the last "
17125 "C<nrlines> lines of the file C<path>."
17129 #: ../src/guestfs-actions.pod:6571 ../fish/guestfish-actions.pod:4427
17131 "If the parameter C<nrlines> is a negative number, this returns lines from "
17132 "the file C<path>, starting with the C<-nrlines>th line."
17136 #: ../src/guestfs-actions.pod:6585
17137 msgid "guestfs_tar_in"
17141 #: ../src/guestfs-actions.pod:6587
17145 " guestfs_tar_in (guestfs_h *g,\n"
17146 " const char *tarfile,\n"
17147 " const char *directory);\n"
17152 #: ../src/guestfs-actions.pod:6592 ../fish/guestfish-actions.pod:4439
17154 "This command uploads and unpacks local file C<tarfile> (an I<uncompressed> "
17155 "tar file) into C<directory>."
17159 #: ../src/guestfs-actions.pod:6595
17161 "To upload a compressed tarball, use C<guestfs_tgz_in> or C<guestfs_txz_in>."
17165 #: ../src/guestfs-actions.pod:6600 ../src/guestfs-actions.pod:6617
17166 #: ../src/guestfs-actions.pod:6633 ../src/guestfs-actions.pod:6649
17167 msgid "(Added in 1.0.3)"
17171 #: ../src/guestfs-actions.pod:6602
17172 msgid "guestfs_tar_out"
17176 #: ../src/guestfs-actions.pod:6604
17180 " guestfs_tar_out (guestfs_h *g,\n"
17181 " const char *directory,\n"
17182 " const char *tarfile);\n"
17187 #: ../src/guestfs-actions.pod:6609 ../fish/guestfish-actions.pod:4451
17189 "This command packs the contents of C<directory> and downloads it to local "
17194 #: ../src/guestfs-actions.pod:6612
17196 "To download a compressed tarball, use C<guestfs_tgz_out> or "
17197 "C<guestfs_txz_out>."
17201 #: ../src/guestfs-actions.pod:6619
17202 msgid "guestfs_tgz_in"
17206 #: ../src/guestfs-actions.pod:6621
17210 " guestfs_tgz_in (guestfs_h *g,\n"
17211 " const char *tarball,\n"
17212 " const char *directory);\n"
17217 #: ../src/guestfs-actions.pod:6626 ../fish/guestfish-actions.pod:4463
17219 "This command uploads and unpacks local file C<tarball> (a I<gzip compressed> "
17220 "tar file) into C<directory>."
17224 #: ../src/guestfs-actions.pod:6629
17225 msgid "To upload an uncompressed tarball, use C<guestfs_tar_in>."
17229 #: ../src/guestfs-actions.pod:6635
17230 msgid "guestfs_tgz_out"
17234 #: ../src/guestfs-actions.pod:6637
17238 " guestfs_tgz_out (guestfs_h *g,\n"
17239 " const char *directory,\n"
17240 " const char *tarball);\n"
17245 #: ../src/guestfs-actions.pod:6642 ../fish/guestfish-actions.pod:4474
17247 "This command packs the contents of C<directory> and downloads it to local "
17252 #: ../src/guestfs-actions.pod:6645
17253 msgid "To download an uncompressed tarball, use C<guestfs_tar_out>."
17257 #: ../src/guestfs-actions.pod:6651
17258 msgid "guestfs_touch"
17262 #: ../src/guestfs-actions.pod:6653
17266 " guestfs_touch (guestfs_h *g,\n"
17267 " const char *path);\n"
17272 #: ../src/guestfs-actions.pod:6657 ../fish/guestfish-actions.pod:4485
17274 "Touch acts like the L<touch(1)> command. It can be used to update the "
17275 "timestamps on a file, or, if the file does not exist, to create a new zero-"
17280 #: ../src/guestfs-actions.pod:6661 ../fish/guestfish-actions.pod:4489
17282 "This command only works on regular files, and will fail on other file types "
17283 "such as directories, symbolic links, block special etc."
17287 #: ../src/guestfs-actions.pod:6668
17288 msgid "guestfs_truncate"
17292 #: ../src/guestfs-actions.pod:6670
17296 " guestfs_truncate (guestfs_h *g,\n"
17297 " const char *path);\n"
17302 #: ../src/guestfs-actions.pod:6674 ../fish/guestfish-actions.pod:4496
17304 "This command truncates C<path> to a zero-length file. The file must exist "
17309 #: ../src/guestfs-actions.pod:6681
17310 msgid "guestfs_truncate_size"
17314 #: ../src/guestfs-actions.pod:6683
17318 " guestfs_truncate_size (guestfs_h *g,\n"
17319 " const char *path,\n"
17320 " int64_t size);\n"
17325 #: ../src/guestfs-actions.pod:6688 ../fish/guestfish-actions.pod:4503
17327 "This command truncates C<path> to size C<size> bytes. The file must exist "
17332 #: ../src/guestfs-actions.pod:6691
17334 "If the current file size is less than C<size> then the file is extended to "
17335 "the required size with zero bytes. This creates a sparse file (ie. disk "
17336 "blocks are not allocated for the file until you write to it). To create a "
17337 "non-sparse file of zeroes, use C<guestfs_fallocate64> instead."
17341 #: ../src/guestfs-actions.pod:6701
17342 msgid "guestfs_tune2fs_l"
17346 #: ../src/guestfs-actions.pod:6703
17350 " guestfs_tune2fs_l (guestfs_h *g,\n"
17351 " const char *device);\n"
17356 #: ../src/guestfs-actions.pod:6707 ../fish/guestfish-actions.pod:4516
17358 "This returns the contents of the ext2, ext3 or ext4 filesystem superblock on "
17363 #: ../src/guestfs-actions.pod:6710 ../fish/guestfish-actions.pod:4519
17365 "It is the same as running C<tune2fs -l device>. See L<tune2fs(8)> manpage "
17366 "for more details. The list of fields returned isn't clearly defined, and "
17367 "depends on both the version of C<tune2fs> that libguestfs was built against, "
17368 "and the filesystem itself."
17372 #: ../src/guestfs-actions.pod:6723
17373 msgid "guestfs_txz_in"
17377 #: ../src/guestfs-actions.pod:6725
17381 " guestfs_txz_in (guestfs_h *g,\n"
17382 " const char *tarball,\n"
17383 " const char *directory);\n"
17388 #: ../src/guestfs-actions.pod:6730 ../fish/guestfish-actions.pod:4528
17390 "This command uploads and unpacks local file C<tarball> (an I<xz compressed> "
17391 "tar file) into C<directory>."
17395 #: ../src/guestfs-actions.pod:6737
17396 msgid "guestfs_txz_out"
17400 #: ../src/guestfs-actions.pod:6739
17404 " guestfs_txz_out (guestfs_h *g,\n"
17405 " const char *directory,\n"
17406 " const char *tarball);\n"
17411 #: ../src/guestfs-actions.pod:6744 ../fish/guestfish-actions.pod:4537
17413 "This command packs the contents of C<directory> and downloads it to local "
17414 "file C<tarball> (as an xz compressed tar archive)."
17418 #: ../src/guestfs-actions.pod:6751
17419 msgid "guestfs_umask"
17423 #: ../src/guestfs-actions.pod:6753
17427 " guestfs_umask (guestfs_h *g,\n"
17433 #: ../src/guestfs-actions.pod:6757 ../fish/guestfish-actions.pod:4546
17435 "This function sets the mask used for creating new files and device nodes to "
17440 #: ../src/guestfs-actions.pod:6760 ../fish/guestfish-actions.pod:4549
17442 "Typical umask values would be C<022> which creates new files with "
17443 "permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and C<002> which creates "
17444 "new files with permissions like \"-rw-rw-r--\" or \"-rwxrwxr-x\"."
17448 #: ../src/guestfs-actions.pod:6765 ../fish/guestfish-actions.pod:4554
17450 "The default umask is C<022>. This is important because it means that "
17451 "directories and device nodes will be created with C<0644> or C<0755> mode "
17452 "even if you specify C<0777>."
17456 #: ../src/guestfs-actions.pod:6769
17458 "See also C<guestfs_get_umask>, L<umask(2)>, C<guestfs_mknod>, "
17459 "C<guestfs_mkdir>."
17463 #: ../src/guestfs-actions.pod:6772 ../fish/guestfish-actions.pod:4561
17464 msgid "This call returns the previous umask."
17468 #: ../src/guestfs-actions.pod:6778
17469 msgid "guestfs_umount"
17473 #: ../src/guestfs-actions.pod:6780
17477 " guestfs_umount (guestfs_h *g,\n"
17478 " const char *pathordevice);\n"
17483 #: ../src/guestfs-actions.pod:6784 ../fish/guestfish-actions.pod:4569
17485 "This unmounts the given filesystem. The filesystem may be specified either "
17486 "by its mountpoint (path) or the device which contains the filesystem."
17490 #: ../src/guestfs-actions.pod:6792
17491 msgid "guestfs_umount_all"
17495 #: ../src/guestfs-actions.pod:6794
17499 " guestfs_umount_all (guestfs_h *g);\n"
17504 #: ../src/guestfs-actions.pod:6797 ../fish/guestfish-actions.pod:4579
17505 msgid "This unmounts all mounted filesystems."
17509 #: ../src/guestfs-actions.pod:6799 ../fish/guestfish-actions.pod:4581
17510 msgid "Some internal mounts are not unmounted by this call."
17514 #: ../src/guestfs-actions.pod:6805
17515 msgid "guestfs_upload"
17519 #: ../src/guestfs-actions.pod:6807
17523 " guestfs_upload (guestfs_h *g,\n"
17524 " const char *filename,\n"
17525 " const char *remotefilename);\n"
17530 #: ../src/guestfs-actions.pod:6812 ../src/guestfs-actions.pod:6836
17531 #: ../fish/guestfish-actions.pod:4587 ../fish/guestfish-actions.pod:4600
17532 msgid "Upload local file C<filename> to C<remotefilename> on the filesystem."
17536 #: ../src/guestfs-actions.pod:6817
17537 msgid "See also C<guestfs_download>."
17541 #: ../src/guestfs-actions.pod:6828
17542 msgid "guestfs_upload_offset"
17546 #: ../src/guestfs-actions.pod:6830
17550 " guestfs_upload_offset (guestfs_h *g,\n"
17551 " const char *filename,\n"
17552 " const char *remotefilename,\n"
17553 " int64_t offset);\n"
17558 #: ../src/guestfs-actions.pod:6839 ../fish/guestfish-actions.pod:4603
17560 "C<remotefilename> is overwritten starting at the byte C<offset> specified. "
17561 "The intention is to overwrite parts of existing files or devices, although "
17562 "if a non-existant file is specified then it is created with a \"hole\" "
17563 "before C<offset>. The size of the data written is implicit in the size of "
17564 "the source C<filename>."
17568 #: ../src/guestfs-actions.pod:6846
17570 "Note that there is no limit on the amount of data that can be uploaded with "
17571 "this call, unlike with C<guestfs_pwrite>, and this call always writes the "
17572 "full amount unless an error occurs."
17576 #: ../src/guestfs-actions.pod:6851
17577 msgid "See also C<guestfs_upload>, C<guestfs_pwrite>."
17581 #: ../src/guestfs-actions.pod:6862
17582 msgid "guestfs_utimens"
17586 #: ../src/guestfs-actions.pod:6864
17590 " guestfs_utimens (guestfs_h *g,\n"
17591 " const char *path,\n"
17592 " int64_t atsecs,\n"
17593 " int64_t atnsecs,\n"
17594 " int64_t mtsecs,\n"
17595 " int64_t mtnsecs);\n"
17600 #: ../src/guestfs-actions.pod:6872 ../fish/guestfish-actions.pod:4623
17601 msgid "This command sets the timestamps of a file with nanosecond precision."
17605 #: ../src/guestfs-actions.pod:6875 ../fish/guestfish-actions.pod:4626
17607 "C<atsecs, atnsecs> are the last access time (atime) in secs and nanoseconds "
17612 #: ../src/guestfs-actions.pod:6878 ../fish/guestfish-actions.pod:4629
17614 "C<mtsecs, mtnsecs> are the last modification time (mtime) in secs and "
17615 "nanoseconds from the epoch."
17619 #: ../src/guestfs-actions.pod:6881 ../fish/guestfish-actions.pod:4632
17621 "If the C<*nsecs> field contains the special value C<-1> then the "
17622 "corresponding timestamp is set to the current time. (The C<*secs> field is "
17623 "ignored in this case)."
17627 #: ../src/guestfs-actions.pod:6885 ../fish/guestfish-actions.pod:4636
17629 "If the C<*nsecs> field contains the special value C<-2> then the "
17630 "corresponding timestamp is left unchanged. (The C<*secs> field is ignored "
17635 #: ../src/guestfs-actions.pod:6893 ../src/guestfs-structs.pod:175
17636 msgid "guestfs_version"
17640 #: ../src/guestfs-actions.pod:6895
17643 " struct guestfs_version *\n"
17644 " guestfs_version (guestfs_h *g);\n"
17649 #: ../src/guestfs-actions.pod:6898 ../fish/guestfish-actions.pod:4644
17651 "Return the libguestfs version number that the program is linked against."
17655 #: ../src/guestfs-actions.pod:6901 ../fish/guestfish-actions.pod:4647
17657 "Note that because of dynamic linking this is not necessarily the version of "
17658 "libguestfs that you compiled against. You can compile the program, and then "
17659 "at runtime dynamically link against a completely different C<libguestfs.so> "
17664 #: ../src/guestfs-actions.pod:6906 ../fish/guestfish-actions.pod:4652
17666 "This call was added in version C<1.0.58>. In previous versions of "
17667 "libguestfs there was no way to get the version number. From C code you can "
17668 "use dynamic linker functions to find out if this symbol exists (if it "
17669 "doesn't, then it's an earlier version)."
17673 #: ../src/guestfs-actions.pod:6912 ../fish/guestfish-actions.pod:4658
17675 "The call returns a structure with four elements. The first three (C<major>, "
17676 "C<minor> and C<release>) are numbers and correspond to the usual version "
17677 "triplet. The fourth element (C<extra>) is a string and is normally empty, "
17678 "but may be used for distro-specific information."
17682 #: ../src/guestfs-actions.pod:6918 ../fish/guestfish-actions.pod:4664
17684 "To construct the original version string: C<$major.$minor.$release$extra>"
17688 #: ../src/guestfs-actions.pod:6921 ../fish/guestfish-actions.pod:4667
17689 msgid "See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>."
17693 #: ../src/guestfs-actions.pod:6923
17695 "I<Note:> Don't use this call to test for availability of features. In "
17696 "enterprise distributions we backport features from later versions into "
17697 "earlier versions, making this an unreliable way to test for features. Use "
17698 "C<guestfs_available> instead."
17702 #: ../src/guestfs-actions.pod:6929
17704 "This function returns a C<struct guestfs_version *>, or NULL if there was an "
17705 "error. I<The caller must call C<guestfs_free_version> after use>."
17709 #: ../src/guestfs-actions.pod:6933
17710 msgid "(Added in 1.0.58)"
17714 #: ../src/guestfs-actions.pod:6935
17715 msgid "guestfs_vfs_label"
17719 #: ../src/guestfs-actions.pod:6937
17723 " guestfs_vfs_label (guestfs_h *g,\n"
17724 " const char *device);\n"
17729 #: ../src/guestfs-actions.pod:6941 ../fish/guestfish-actions.pod:4679
17730 msgid "This returns the filesystem label of the filesystem on C<device>."
17734 #: ../src/guestfs-actions.pod:6944 ../fish/guestfish-actions.pod:4682
17735 msgid "If the filesystem is unlabeled, this returns the empty string."
17739 #: ../src/guestfs-actions.pod:6946
17740 msgid "To find a filesystem from the label, use C<guestfs_findfs_label>."
17744 #: ../src/guestfs-actions.pod:6951 ../src/guestfs-actions.pod:6988
17745 msgid "(Added in 1.3.18)"
17749 #: ../src/guestfs-actions.pod:6953
17750 msgid "guestfs_vfs_type"
17754 #: ../src/guestfs-actions.pod:6955
17758 " guestfs_vfs_type (guestfs_h *g,\n"
17759 " const char *device);\n"
17764 #: ../src/guestfs-actions.pod:6959 ../fish/guestfish-actions.pod:4690
17766 "This command gets the filesystem type corresponding to the filesystem on "
17771 #: ../src/guestfs-actions.pod:6962 ../fish/guestfish-actions.pod:4693
17773 "For most filesystems, the result is the name of the Linux VFS module which "
17774 "would be used to mount this filesystem if you mounted it without specifying "
17775 "the filesystem type. For example a string such as C<ext3> or C<ntfs>."
17779 #: ../src/guestfs-actions.pod:6972
17780 msgid "guestfs_vfs_uuid"
17784 #: ../src/guestfs-actions.pod:6974
17788 " guestfs_vfs_uuid (guestfs_h *g,\n"
17789 " const char *device);\n"
17794 #: ../src/guestfs-actions.pod:6978 ../fish/guestfish-actions.pod:4702
17795 msgid "This returns the filesystem UUID of the filesystem on C<device>."
17799 #: ../src/guestfs-actions.pod:6981 ../fish/guestfish-actions.pod:4705
17800 msgid "If the filesystem does not have a UUID, this returns the empty string."
17804 #: ../src/guestfs-actions.pod:6983
17805 msgid "To find a filesystem from the UUID, use C<guestfs_findfs_uuid>."
17809 #: ../src/guestfs-actions.pod:6990
17810 msgid "guestfs_vg_activate"
17814 #: ../src/guestfs-actions.pod:6992
17818 " guestfs_vg_activate (guestfs_h *g,\n"
17820 " char *const *volgroups);\n"
17825 #: ../src/guestfs-actions.pod:6997 ../fish/guestfish-actions.pod:4713
17827 "This command activates or (if C<activate> is false) deactivates all logical "
17828 "volumes in the listed volume groups C<volgroups>. If activated, then they "
17829 "are made known to the kernel, ie. they appear as C</dev/mapper> devices. If "
17830 "deactivated, then those devices disappear."
17834 #: ../src/guestfs-actions.pod:7003 ../fish/guestfish-actions.pod:4719
17835 msgid "This command is the same as running C<vgchange -a y|n volgroups...>"
17839 #: ../src/guestfs-actions.pod:7005 ../fish/guestfish-actions.pod:4721
17841 "Note that if C<volgroups> is an empty list then B<all> volume groups are "
17842 "activated or deactivated."
17846 #: ../src/guestfs-actions.pod:7012
17847 msgid "guestfs_vg_activate_all"
17851 #: ../src/guestfs-actions.pod:7014
17855 " guestfs_vg_activate_all (guestfs_h *g,\n"
17856 " int activate);\n"
17861 #: ../src/guestfs-actions.pod:7018 ../fish/guestfish-actions.pod:4728
17863 "This command activates or (if C<activate> is false) deactivates all logical "
17864 "volumes in all volume groups. If activated, then they are made known to the "
17865 "kernel, ie. they appear as C</dev/mapper> devices. If deactivated, then "
17866 "those devices disappear."
17870 #: ../src/guestfs-actions.pod:7024 ../fish/guestfish-actions.pod:4734
17871 msgid "This command is the same as running C<vgchange -a y|n>"
17875 #: ../src/guestfs-actions.pod:7030
17876 msgid "guestfs_vgcreate"
17880 #: ../src/guestfs-actions.pod:7032
17884 " guestfs_vgcreate (guestfs_h *g,\n"
17885 " const char *volgroup,\n"
17886 " char *const *physvols);\n"
17891 #: ../src/guestfs-actions.pod:7037 ../fish/guestfish-actions.pod:4740
17893 "This creates an LVM volume group called C<volgroup> from the non-empty list "
17894 "of physical volumes C<physvols>."
17898 #: ../src/guestfs-actions.pod:7044
17899 msgid "guestfs_vglvuuids"
17903 #: ../src/guestfs-actions.pod:7046
17907 " guestfs_vglvuuids (guestfs_h *g,\n"
17908 " const char *vgname);\n"
17913 #: ../src/guestfs-actions.pod:7050 ../fish/guestfish-actions.pod:4747
17915 "Given a VG called C<vgname>, this returns the UUIDs of all the logical "
17916 "volumes created in this volume group."
17920 #: ../src/guestfs-actions.pod:7053
17922 "You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid> calls to "
17923 "associate logical volumes and volume groups."
17927 #: ../src/guestfs-actions.pod:7056
17928 msgid "See also C<guestfs_vgpvuuids>."
17932 #: ../src/guestfs-actions.pod:7064
17933 msgid "guestfs_vgpvuuids"
17937 #: ../src/guestfs-actions.pod:7066
17941 " guestfs_vgpvuuids (guestfs_h *g,\n"
17942 " const char *vgname);\n"
17947 #: ../src/guestfs-actions.pod:7070 ../fish/guestfish-actions.pod:4759
17949 "Given a VG called C<vgname>, this returns the UUIDs of all the physical "
17950 "volumes that this volume group resides on."
17954 #: ../src/guestfs-actions.pod:7073
17956 "You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid> calls to "
17957 "associate physical volumes and volume groups."
17961 #: ../src/guestfs-actions.pod:7076
17962 msgid "See also C<guestfs_vglvuuids>."
17966 #: ../src/guestfs-actions.pod:7084
17967 msgid "guestfs_vgremove"
17971 #: ../src/guestfs-actions.pod:7086
17975 " guestfs_vgremove (guestfs_h *g,\n"
17976 " const char *vgname);\n"
17981 #: ../src/guestfs-actions.pod:7090 ../fish/guestfish-actions.pod:4771
17982 msgid "Remove an LVM volume group C<vgname>, (for example C<VG>)."
17986 #: ../src/guestfs-actions.pod:7092 ../fish/guestfish-actions.pod:4773
17988 "This also forcibly removes all logical volumes in the volume group (if any)."
17992 #: ../src/guestfs-actions.pod:7099
17993 msgid "guestfs_vgrename"
17997 #: ../src/guestfs-actions.pod:7101
18001 " guestfs_vgrename (guestfs_h *g,\n"
18002 " const char *volgroup,\n"
18003 " const char *newvolgroup);\n"
18008 #: ../src/guestfs-actions.pod:7106 ../fish/guestfish-actions.pod:4780
18009 msgid "Rename a volume group C<volgroup> with the new name C<newvolgroup>."
18013 #: ../src/guestfs-actions.pod:7112
18014 msgid "guestfs_vgs"
18018 #: ../src/guestfs-actions.pod:7114
18022 " guestfs_vgs (guestfs_h *g);\n"
18027 #: ../src/guestfs-actions.pod:7117 ../fish/guestfish-actions.pod:4786
18029 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
18034 #: ../src/guestfs-actions.pod:7120 ../fish/guestfish-actions.pod:4789
18036 "This returns a list of just the volume group names that were detected (eg. "
18041 #: ../src/guestfs-actions.pod:7123
18042 msgid "See also C<guestfs_vgs_full>."
18046 #: ../src/guestfs-actions.pod:7131
18047 msgid "guestfs_vgs_full"
18051 #: ../src/guestfs-actions.pod:7133
18054 " struct guestfs_lvm_vg_list *\n"
18055 " guestfs_vgs_full (guestfs_h *g);\n"
18060 #: ../src/guestfs-actions.pod:7136 ../fish/guestfish-actions.pod:4798
18062 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
18063 "> command. The \"full\" version includes all fields."
18067 #: ../src/guestfs-actions.pod:7139
18069 "This function returns a C<struct guestfs_lvm_vg_list *>, or NULL if there "
18070 "was an error. I<The caller must call C<guestfs_free_lvm_vg_list> after use>."
18074 #: ../src/guestfs-actions.pod:7145
18075 msgid "guestfs_vgscan"
18079 #: ../src/guestfs-actions.pod:7147
18083 " guestfs_vgscan (guestfs_h *g);\n"
18088 #: ../src/guestfs-actions.pod:7150 ../fish/guestfish-actions.pod:4805
18090 "This rescans all block devices and rebuilds the list of LVM physical "
18091 "volumes, volume groups and logical volumes."
18095 #: ../src/guestfs-actions.pod:7157
18096 msgid "guestfs_vguuid"
18100 #: ../src/guestfs-actions.pod:7159
18104 " guestfs_vguuid (guestfs_h *g,\n"
18105 " const char *vgname);\n"
18110 #: ../src/guestfs-actions.pod:7163 ../fish/guestfish-actions.pod:4812
18111 msgid "This command returns the UUID of the LVM VG named C<vgname>."
18115 #: ../src/guestfs-actions.pod:7170
18116 msgid "guestfs_wait_ready"
18120 #: ../src/guestfs-actions.pod:7172
18124 " guestfs_wait_ready (guestfs_h *g);\n"
18129 #: ../src/guestfs-actions.pod:7175
18130 msgid "This function is a no op."
18134 #: ../src/guestfs-actions.pod:7177
18136 "In versions of the API E<lt> 1.0.71 you had to call this function just after "
18137 "calling C<guestfs_launch> to wait for the launch to complete. However this "
18138 "is no longer necessary because C<guestfs_launch> now does the waiting."
18142 #: ../src/guestfs-actions.pod:7182
18144 "If you see any calls to this function in code then you can just remove them, "
18145 "unless you want to retain compatibility with older versions of the API."
18149 #: ../src/guestfs-actions.pod:7190
18150 msgid "guestfs_wc_c"
18154 #: ../src/guestfs-actions.pod:7192
18158 " guestfs_wc_c (guestfs_h *g,\n"
18159 " const char *path);\n"
18164 #: ../src/guestfs-actions.pod:7196 ../fish/guestfish-actions.pod:4818
18166 "This command counts the characters in a file, using the C<wc -c> external "
18171 #: ../src/guestfs-actions.pod:7203
18172 msgid "guestfs_wc_l"
18176 #: ../src/guestfs-actions.pod:7205
18180 " guestfs_wc_l (guestfs_h *g,\n"
18181 " const char *path);\n"
18186 #: ../src/guestfs-actions.pod:7209 ../fish/guestfish-actions.pod:4825
18188 "This command counts the lines in a file, using the C<wc -l> external command."
18192 #: ../src/guestfs-actions.pod:7216
18193 msgid "guestfs_wc_w"
18197 #: ../src/guestfs-actions.pod:7218
18201 " guestfs_wc_w (guestfs_h *g,\n"
18202 " const char *path);\n"
18207 #: ../src/guestfs-actions.pod:7222 ../fish/guestfish-actions.pod:4832
18209 "This command counts the words in a file, using the C<wc -w> external command."
18213 #: ../src/guestfs-actions.pod:7229
18214 msgid "guestfs_write"
18218 #: ../src/guestfs-actions.pod:7231
18222 " guestfs_write (guestfs_h *g,\n"
18223 " const char *path,\n"
18224 " const char *content,\n"
18225 " size_t content_size);\n"
18230 #: ../src/guestfs-actions.pod:7237 ../fish/guestfish-actions.pod:4839
18232 "This call creates a file called C<path>. The content of the file is the "
18233 "string C<content> (which can contain any 8 bit data)."
18237 #: ../src/guestfs-actions.pod:7247
18238 msgid "guestfs_write_file"
18242 #: ../src/guestfs-actions.pod:7249
18246 " guestfs_write_file (guestfs_h *g,\n"
18247 " const char *path,\n"
18248 " const char *content,\n"
18254 #: ../src/guestfs-actions.pod:7255 ../fish/guestfish-actions.pod:4849
18256 "This call creates a file called C<path>. The contents of the file is the "
18257 "string C<content> (which can contain any 8 bit data), with length C<size>."
18261 #: ../src/guestfs-actions.pod:7259 ../fish/guestfish-actions.pod:4853
18263 "As a special case, if C<size> is C<0> then the length is calculated using "
18264 "C<strlen> (so in this case the content cannot contain embedded ASCII NULs)."
18268 #: ../src/guestfs-actions.pod:7263 ../fish/guestfish-actions.pod:4857
18270 "I<NB.> Owing to a bug, writing content containing ASCII NUL characters does "
18271 "I<not> work, even if the length is specified."
18275 #: ../src/guestfs-actions.pod:7271 ../fish/guestfish-actions.pod:4863
18277 "This function is deprecated. In new code, use the C<write> call instead."
18281 #: ../src/guestfs-actions.pod:7280
18282 msgid "guestfs_zegrep"
18286 #: ../src/guestfs-actions.pod:7282
18290 " guestfs_zegrep (guestfs_h *g,\n"
18291 " const char *regex,\n"
18292 " const char *path);\n"
18297 #: ../src/guestfs-actions.pod:7287 ../fish/guestfish-actions.pod:4874
18299 "This calls the external C<zegrep> program and returns the matching lines."
18303 #: ../src/guestfs-actions.pod:7299
18304 msgid "guestfs_zegrepi"
18308 #: ../src/guestfs-actions.pod:7301
18312 " guestfs_zegrepi (guestfs_h *g,\n"
18313 " const char *regex,\n"
18314 " const char *path);\n"
18319 #: ../src/guestfs-actions.pod:7306 ../fish/guestfish-actions.pod:4884
18321 "This calls the external C<zegrep -i> program and returns the matching lines."
18325 #: ../src/guestfs-actions.pod:7318
18326 msgid "guestfs_zero"
18330 #: ../src/guestfs-actions.pod:7320
18334 " guestfs_zero (guestfs_h *g,\n"
18335 " const char *device);\n"
18340 #: ../src/guestfs-actions.pod:7324 ../fish/guestfish-actions.pod:4894
18341 msgid "This command writes zeroes over the first few blocks of C<device>."
18345 #: ../src/guestfs-actions.pod:7326 ../fish/guestfish-actions.pod:4896
18347 "How many blocks are zeroed isn't specified (but it's I<not> enough to "
18348 "securely wipe the device). It should be sufficient to remove any partition "
18349 "tables, filesystem superblocks and so on."
18353 #: ../src/guestfs-actions.pod:7330
18354 msgid "See also: C<guestfs_zero_device>, C<guestfs_scrub_device>."
18358 #: ../src/guestfs-actions.pod:7341
18359 msgid "guestfs_zero_device"
18363 #: ../src/guestfs-actions.pod:7343
18367 " guestfs_zero_device (guestfs_h *g,\n"
18368 " const char *device);\n"
18373 #: ../src/guestfs-actions.pod:7347
18375 "This command writes zeroes over the entire C<device>. Compare with "
18376 "C<guestfs_zero> which just zeroes the first few blocks of a device."
18380 #: ../src/guestfs-actions.pod:7361
18381 msgid "(Added in 1.3.1)"
18385 #: ../src/guestfs-actions.pod:7363
18386 msgid "guestfs_zerofree"
18390 #: ../src/guestfs-actions.pod:7365
18394 " guestfs_zerofree (guestfs_h *g,\n"
18395 " const char *device);\n"
18400 #: ../src/guestfs-actions.pod:7369 ../fish/guestfish-actions.pod:4917
18402 "This runs the I<zerofree> program on C<device>. This program claims to zero "
18403 "unused inodes and disk blocks on an ext2/3 filesystem, thus making it "
18404 "possible to compress the filesystem more effectively."
18408 #: ../src/guestfs-actions.pod:7374 ../fish/guestfish-actions.pod:4922
18409 msgid "You should B<not> run this program if the filesystem is mounted."
18413 #: ../src/guestfs-actions.pod:7377 ../fish/guestfish-actions.pod:4925
18415 "It is possible that using this program can damage the filesystem or data on "
18420 #: ../src/guestfs-actions.pod:7384
18421 msgid "guestfs_zfgrep"
18425 #: ../src/guestfs-actions.pod:7386
18429 " guestfs_zfgrep (guestfs_h *g,\n"
18430 " const char *pattern,\n"
18431 " const char *path);\n"
18436 #: ../src/guestfs-actions.pod:7391 ../fish/guestfish-actions.pod:4932
18438 "This calls the external C<zfgrep> program and returns the matching lines."
18442 #: ../src/guestfs-actions.pod:7403
18443 msgid "guestfs_zfgrepi"
18447 #: ../src/guestfs-actions.pod:7405
18451 " guestfs_zfgrepi (guestfs_h *g,\n"
18452 " const char *pattern,\n"
18453 " const char *path);\n"
18458 #: ../src/guestfs-actions.pod:7410 ../fish/guestfish-actions.pod:4942
18460 "This calls the external C<zfgrep -i> program and returns the matching lines."
18464 #: ../src/guestfs-actions.pod:7422
18465 msgid "guestfs_zfile"
18469 #: ../src/guestfs-actions.pod:7424
18473 " guestfs_zfile (guestfs_h *g,\n"
18474 " const char *meth,\n"
18475 " const char *path);\n"
18480 #: ../src/guestfs-actions.pod:7429 ../fish/guestfish-actions.pod:4952
18482 "This command runs C<file> after first decompressing C<path> using C<method>."
18486 #: ../src/guestfs-actions.pod:7432 ../fish/guestfish-actions.pod:4955
18487 msgid "C<method> must be one of C<gzip>, C<compress> or C<bzip2>."
18491 #: ../src/guestfs-actions.pod:7434
18493 "Since 1.0.63, use C<guestfs_file> instead which can now process compressed "
18498 #: ../src/guestfs-actions.pod:7440 ../fish/guestfish-actions.pod:4960
18500 "This function is deprecated. In new code, use the C<file> call instead."
18504 #: ../src/guestfs-actions.pod:7449
18505 msgid "guestfs_zgrep"
18509 #: ../src/guestfs-actions.pod:7451
18513 " guestfs_zgrep (guestfs_h *g,\n"
18514 " const char *regex,\n"
18515 " const char *path);\n"
18520 #: ../src/guestfs-actions.pod:7456 ../fish/guestfish-actions.pod:4971
18522 "This calls the external C<zgrep> program and returns the matching lines."
18526 #: ../src/guestfs-actions.pod:7468
18527 msgid "guestfs_zgrepi"
18531 #: ../src/guestfs-actions.pod:7470
18535 " guestfs_zgrepi (guestfs_h *g,\n"
18536 " const char *regex,\n"
18537 " const char *path);\n"
18542 #: ../src/guestfs-actions.pod:7475 ../fish/guestfish-actions.pod:4981
18544 "This calls the external C<zgrep -i> program and returns the matching lines."
18548 #: ../src/guestfs-availability.pod:3
18553 #: ../src/guestfs-availability.pod:5
18555 "The following functions: L</guestfs_aug_clear> L</guestfs_aug_close> L</"
18556 "guestfs_aug_defnode> L</guestfs_aug_defvar> L</guestfs_aug_get> L</"
18557 "guestfs_aug_init> L</guestfs_aug_insert> L</guestfs_aug_load> L</"
18558 "guestfs_aug_ls> L</guestfs_aug_match> L</guestfs_aug_mv> L</guestfs_aug_rm> "
18559 "L</guestfs_aug_save> L</guestfs_aug_set>"
18563 #: ../src/guestfs-availability.pod:21
18568 #: ../src/guestfs-availability.pod:23
18570 "The following functions: L</guestfs_inotify_add_watch> L</"
18571 "guestfs_inotify_close> L</guestfs_inotify_files> L</guestfs_inotify_init> L</"
18572 "guestfs_inotify_read> L</guestfs_inotify_rm_watch>"
18576 #: ../src/guestfs-availability.pod:31
18577 msgid "B<linuxfsuuid>"
18581 #: ../src/guestfs-availability.pod:33
18583 "The following functions: L</guestfs_mke2fs_JU> L</guestfs_mke2journal_U> L</"
18584 "guestfs_mkswap_U> L</guestfs_swapoff_uuid> L</guestfs_swapon_uuid>"
18588 #: ../src/guestfs-availability.pod:40
18589 msgid "B<linuxmodules>"
18593 #: ../src/guestfs-availability.pod:42
18594 msgid "The following functions: L</guestfs_modprobe>"
18598 #: ../src/guestfs-availability.pod:45
18599 msgid "B<linuxxattrs>"
18603 #: ../src/guestfs-availability.pod:47
18605 "The following functions: L</guestfs_getxattr> L</guestfs_getxattrs> L</"
18606 "guestfs_lgetxattr> L</guestfs_lgetxattrs> L</guestfs_lremovexattr> L</"
18607 "guestfs_lsetxattr> L</guestfs_lxattrlist> L</guestfs_removexattr> L</"
18608 "guestfs_setxattr>"
18612 #: ../src/guestfs-availability.pod:58
18617 #: ../src/guestfs-availability.pod:60
18619 "The following functions: L</guestfs_luks_add_key> L</guestfs_luks_close> L</"
18620 "guestfs_luks_format> L</guestfs_luks_format_cipher> L</"
18621 "guestfs_luks_kill_slot> L</guestfs_luks_open> L</guestfs_luks_open_ro>"
18625 #: ../src/guestfs-availability.pod:69
18630 #: ../src/guestfs-availability.pod:71
18632 "The following functions: L</guestfs_is_lv> L</guestfs_lvcreate> L</"
18633 "guestfs_lvm_remove_all> L</guestfs_lvm_set_filter> L</guestfs_lvremove> L</"
18634 "guestfs_lvresize> L</guestfs_lvresize_free> L</guestfs_lvs> L</"
18635 "guestfs_lvs_full> L</guestfs_pvcreate> L</guestfs_pvremove> L</"
18636 "guestfs_pvresize> L</guestfs_pvresize_size> L</guestfs_pvs> L</"
18637 "guestfs_pvs_full> L</guestfs_vg_activate> L</guestfs_vg_activate_all> L</"
18638 "guestfs_vgcreate> L</guestfs_vgremove> L</guestfs_vgs> L</guestfs_vgs_full>"
18642 #: ../src/guestfs-availability.pod:94
18647 #: ../src/guestfs-availability.pod:96
18649 "The following functions: L</guestfs_mkfifo> L</guestfs_mknod> L</"
18650 "guestfs_mknod_b> L</guestfs_mknod_c>"
18654 #: ../src/guestfs-availability.pod:102
18659 #: ../src/guestfs-availability.pod:104
18660 msgid "The following functions: L</guestfs_ntfs_3g_probe>"
18664 #: ../src/guestfs-availability.pod:107
18665 msgid "B<ntfsprogs>"
18669 #: ../src/guestfs-availability.pod:109
18671 "The following functions: L</guestfs_ntfsresize> L</guestfs_ntfsresize_size>"
18675 #: ../src/guestfs-availability.pod:113
18676 msgid "B<realpath>"
18680 #: ../src/guestfs-availability.pod:115
18681 msgid "The following functions: L</guestfs_realpath>"
18685 #: ../src/guestfs-availability.pod:118
18690 #: ../src/guestfs-availability.pod:120
18692 "The following functions: L</guestfs_scrub_device> L</guestfs_scrub_file> L</"
18693 "guestfs_scrub_freespace>"
18697 #: ../src/guestfs-availability.pod:125
18702 #: ../src/guestfs-availability.pod:127
18703 msgid "The following functions: L</guestfs_getcon> L</guestfs_setcon>"
18707 #: ../src/guestfs-availability.pod:131
18712 #: ../src/guestfs-availability.pod:133
18713 msgid "The following functions: L</guestfs_txz_in> L</guestfs_txz_out>"
18717 #: ../src/guestfs-availability.pod:137
18718 msgid "B<zerofree>"
18722 #: ../src/guestfs-availability.pod:139
18723 msgid "The following functions: L</guestfs_zerofree>"
18727 #: ../src/guestfs-structs.pod:1
18728 msgid "guestfs_int_bool"
18732 #: ../src/guestfs-structs.pod:3
18735 " struct guestfs_int_bool {\n"
18743 #: ../src/guestfs-structs.pod:8
18746 " struct guestfs_int_bool_list {\n"
18747 " uint32_t len; /* Number of elements in list. */\n"
18748 " struct guestfs_int_bool *val; /* Elements. */\n"
18754 #: ../src/guestfs-structs.pod:13
18757 " void guestfs_free_int_bool (struct guestfs_free_int_bool *);\n"
18758 " void guestfs_free_int_bool_list (struct guestfs_free_int_bool_list *);\n"
18763 #: ../src/guestfs-structs.pod:16
18764 msgid "guestfs_lvm_pv"
18768 #: ../src/guestfs-structs.pod:18
18771 " struct guestfs_lvm_pv {\n"
18772 " char *pv_name;\n"
18773 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
18774 " char pv_uuid[32];\n"
18776 " uint64_t pv_size;\n"
18777 " uint64_t dev_size;\n"
18778 " uint64_t pv_free;\n"
18779 " uint64_t pv_used;\n"
18780 " char *pv_attr;\n"
18781 " int64_t pv_pe_count;\n"
18782 " int64_t pv_pe_alloc_count;\n"
18783 " char *pv_tags;\n"
18784 " uint64_t pe_start;\n"
18785 " int64_t pv_mda_count;\n"
18786 " uint64_t pv_mda_free;\n"
18792 #: ../src/guestfs-structs.pod:36
18795 " struct guestfs_lvm_pv_list {\n"
18796 " uint32_t len; /* Number of elements in list. */\n"
18797 " struct guestfs_lvm_pv *val; /* Elements. */\n"
18803 #: ../src/guestfs-structs.pod:41
18806 " void guestfs_free_lvm_pv (struct guestfs_free_lvm_pv *);\n"
18807 " void guestfs_free_lvm_pv_list (struct guestfs_free_lvm_pv_list *);\n"
18812 #: ../src/guestfs-structs.pod:44
18813 msgid "guestfs_lvm_vg"
18817 #: ../src/guestfs-structs.pod:46
18820 " struct guestfs_lvm_vg {\n"
18821 " char *vg_name;\n"
18822 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
18823 " char vg_uuid[32];\n"
18825 " char *vg_attr;\n"
18826 " uint64_t vg_size;\n"
18827 " uint64_t vg_free;\n"
18828 " char *vg_sysid;\n"
18829 " uint64_t vg_extent_size;\n"
18830 " int64_t vg_extent_count;\n"
18831 " int64_t vg_free_count;\n"
18832 " int64_t max_lv;\n"
18833 " int64_t max_pv;\n"
18834 " int64_t pv_count;\n"
18835 " int64_t lv_count;\n"
18836 " int64_t snap_count;\n"
18837 " int64_t vg_seqno;\n"
18838 " char *vg_tags;\n"
18839 " int64_t vg_mda_count;\n"
18840 " uint64_t vg_mda_free;\n"
18846 #: ../src/guestfs-structs.pod:69
18849 " struct guestfs_lvm_vg_list {\n"
18850 " uint32_t len; /* Number of elements in list. */\n"
18851 " struct guestfs_lvm_vg *val; /* Elements. */\n"
18857 #: ../src/guestfs-structs.pod:74
18860 " void guestfs_free_lvm_vg (struct guestfs_free_lvm_vg *);\n"
18861 " void guestfs_free_lvm_vg_list (struct guestfs_free_lvm_vg_list *);\n"
18866 #: ../src/guestfs-structs.pod:77
18867 msgid "guestfs_lvm_lv"
18871 #: ../src/guestfs-structs.pod:79
18874 " struct guestfs_lvm_lv {\n"
18875 " char *lv_name;\n"
18876 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
18877 " char lv_uuid[32];\n"
18878 " char *lv_attr;\n"
18879 " int64_t lv_major;\n"
18880 " int64_t lv_minor;\n"
18881 " int64_t lv_kernel_major;\n"
18882 " int64_t lv_kernel_minor;\n"
18883 " uint64_t lv_size;\n"
18884 " int64_t seg_count;\n"
18886 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
18887 " float snap_percent;\n"
18888 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
18889 " float copy_percent;\n"
18890 " char *move_pv;\n"
18891 " char *lv_tags;\n"
18892 " char *mirror_log;\n"
18893 " char *modules;\n"
18899 #: ../src/guestfs-structs.pod:101
18902 " struct guestfs_lvm_lv_list {\n"
18903 " uint32_t len; /* Number of elements in list. */\n"
18904 " struct guestfs_lvm_lv *val; /* Elements. */\n"
18910 #: ../src/guestfs-structs.pod:106
18913 " void guestfs_free_lvm_lv (struct guestfs_free_lvm_lv *);\n"
18914 " void guestfs_free_lvm_lv_list (struct guestfs_free_lvm_lv_list *);\n"
18919 #: ../src/guestfs-structs.pod:111
18922 " struct guestfs_stat {\n"
18926 " int64_t nlink;\n"
18931 " int64_t blksize;\n"
18932 " int64_t blocks;\n"
18933 " int64_t atime;\n"
18934 " int64_t mtime;\n"
18935 " int64_t ctime;\n"
18941 #: ../src/guestfs-structs.pod:127
18944 " struct guestfs_stat_list {\n"
18945 " uint32_t len; /* Number of elements in list. */\n"
18946 " struct guestfs_stat *val; /* Elements. */\n"
18952 #: ../src/guestfs-structs.pod:132
18955 " void guestfs_free_stat (struct guestfs_free_stat *);\n"
18956 " void guestfs_free_stat_list (struct guestfs_free_stat_list *);\n"
18961 #: ../src/guestfs-structs.pod:137
18964 " struct guestfs_statvfs {\n"
18965 " int64_t bsize;\n"
18966 " int64_t frsize;\n"
18967 " int64_t blocks;\n"
18968 " int64_t bfree;\n"
18969 " int64_t bavail;\n"
18970 " int64_t files;\n"
18971 " int64_t ffree;\n"
18972 " int64_t favail;\n"
18975 " int64_t namemax;\n"
18981 #: ../src/guestfs-structs.pod:151
18984 " struct guestfs_statvfs_list {\n"
18985 " uint32_t len; /* Number of elements in list. */\n"
18986 " struct guestfs_statvfs *val; /* Elements. */\n"
18992 #: ../src/guestfs-structs.pod:156
18995 " void guestfs_free_statvfs (struct guestfs_free_statvfs *);\n"
18996 " void guestfs_free_statvfs_list (struct guestfs_free_statvfs_list *);\n"
19001 #: ../src/guestfs-structs.pod:159
19002 msgid "guestfs_dirent"
19006 #: ../src/guestfs-structs.pod:161
19009 " struct guestfs_dirent {\n"
19018 #: ../src/guestfs-structs.pod:167
19021 " struct guestfs_dirent_list {\n"
19022 " uint32_t len; /* Number of elements in list. */\n"
19023 " struct guestfs_dirent *val; /* Elements. */\n"
19029 #: ../src/guestfs-structs.pod:172
19032 " void guestfs_free_dirent (struct guestfs_free_dirent *);\n"
19033 " void guestfs_free_dirent_list (struct guestfs_free_dirent_list *);\n"
19038 #: ../src/guestfs-structs.pod:177
19041 " struct guestfs_version {\n"
19042 " int64_t major;\n"
19043 " int64_t minor;\n"
19044 " int64_t release;\n"
19051 #: ../src/guestfs-structs.pod:184
19054 " struct guestfs_version_list {\n"
19055 " uint32_t len; /* Number of elements in list. */\n"
19056 " struct guestfs_version *val; /* Elements. */\n"
19062 #: ../src/guestfs-structs.pod:189
19065 " void guestfs_free_version (struct guestfs_free_version *);\n"
19066 " void guestfs_free_version_list (struct guestfs_free_version_list *);\n"
19071 #: ../src/guestfs-structs.pod:192
19072 msgid "guestfs_xattr"
19076 #: ../src/guestfs-structs.pod:194
19079 " struct guestfs_xattr {\n"
19080 " char *attrname;\n"
19081 " /* The next two fields describe a byte array. */\n"
19082 " uint32_t attrval_len;\n"
19083 " char *attrval;\n"
19089 #: ../src/guestfs-structs.pod:201
19092 " struct guestfs_xattr_list {\n"
19093 " uint32_t len; /* Number of elements in list. */\n"
19094 " struct guestfs_xattr *val; /* Elements. */\n"
19100 #: ../src/guestfs-structs.pod:206
19103 " void guestfs_free_xattr (struct guestfs_free_xattr *);\n"
19104 " void guestfs_free_xattr_list (struct guestfs_free_xattr_list *);\n"
19109 #: ../src/guestfs-structs.pod:209
19110 msgid "guestfs_inotify_event"
19114 #: ../src/guestfs-structs.pod:211
19117 " struct guestfs_inotify_event {\n"
19118 " int64_t in_wd;\n"
19119 " uint32_t in_mask;\n"
19120 " uint32_t in_cookie;\n"
19121 " char *in_name;\n"
19127 #: ../src/guestfs-structs.pod:218
19130 " struct guestfs_inotify_event_list {\n"
19131 " uint32_t len; /* Number of elements in list. */\n"
19132 " struct guestfs_inotify_event *val; /* Elements. */\n"
19138 #: ../src/guestfs-structs.pod:223
19141 " void guestfs_free_inotify_event (struct guestfs_free_inotify_event *);\n"
19142 " void guestfs_free_inotify_event_list (struct guestfs_free_inotify_event_list *);\n"
19147 #: ../src/guestfs-structs.pod:226
19148 msgid "guestfs_partition"
19152 #: ../src/guestfs-structs.pod:228
19155 " struct guestfs_partition {\n"
19156 " int32_t part_num;\n"
19157 " uint64_t part_start;\n"
19158 " uint64_t part_end;\n"
19159 " uint64_t part_size;\n"
19165 #: ../src/guestfs-structs.pod:235
19168 " struct guestfs_partition_list {\n"
19169 " uint32_t len; /* Number of elements in list. */\n"
19170 " struct guestfs_partition *val; /* Elements. */\n"
19176 #: ../src/guestfs-structs.pod:240
19179 " void guestfs_free_partition (struct guestfs_free_partition *);\n"
19180 " void guestfs_free_partition_list (struct guestfs_free_partition_list *);\n"
19185 #: ../src/guestfs-structs.pod:243
19186 msgid "guestfs_application"
19190 #: ../src/guestfs-structs.pod:245
19193 " struct guestfs_application {\n"
19194 " char *app_name;\n"
19195 " char *app_display_name;\n"
19196 " int32_t app_epoch;\n"
19197 " char *app_version;\n"
19198 " char *app_release;\n"
19199 " char *app_install_path;\n"
19200 " char *app_trans_path;\n"
19201 " char *app_publisher;\n"
19202 " char *app_url;\n"
19203 " char *app_source_package;\n"
19204 " char *app_summary;\n"
19205 " char *app_description;\n"
19211 #: ../src/guestfs-structs.pod:260
19214 " struct guestfs_application_list {\n"
19215 " uint32_t len; /* Number of elements in list. */\n"
19216 " struct guestfs_application *val; /* Elements. */\n"
19222 #: ../src/guestfs-structs.pod:265
19225 " void guestfs_free_application (struct guestfs_free_application *);\n"
19226 " void guestfs_free_application_list (struct guestfs_free_application_list *);\n"
19231 #: ../fish/guestfish.pod:5
19232 msgid "guestfish - the libguestfs Filesystem Interactive SHell"
19236 #: ../fish/guestfish.pod:9
19239 " guestfish [--options] [commands]\n"
19244 #: ../fish/guestfish.pod:11
19252 #: ../fish/guestfish.pod:13
19255 " guestfish [--ro|--rw] -a disk.img\n"
19260 #: ../fish/guestfish.pod:15
19263 " guestfish [--ro|--rw] -a disk.img -m dev[:mountpoint]\n"
19268 #: ../fish/guestfish.pod:17
19271 " guestfish -d libvirt-domain\n"
19276 #: ../fish/guestfish.pod:19
19279 " guestfish [--ro|--rw] -a disk.img -i\n"
19284 #: ../fish/guestfish.pod:21
19287 " guestfish -d libvirt-domain -i\n"
19292 #: ../fish/guestfish.pod:23 ../fuse/guestmount.pod:15 ../tools/virt-edit.pl:44
19293 #: ../tools/virt-win-reg.pl:51 ../tools/virt-tar.pl:64
19298 #: ../fish/guestfish.pod:25
19300 "Using guestfish in read/write mode on live virtual machines can be "
19301 "dangerous, potentially causing disk corruption. Use the I<--ro> (read-only) "
19302 "option to use guestfish safely if the disk image or virtual machine might be "
19307 #: ../fish/guestfish.pod:32
19309 "Guestfish is a shell and command-line tool for examining and modifying "
19310 "virtual machine filesystems. It uses libguestfs and exposes all of the "
19311 "functionality of the guestfs API, see L<guestfs(3)>."
19315 #: ../fish/guestfish.pod:36
19317 "Guestfish gives you structured access to the libguestfs API, from shell "
19318 "scripts or the command line or interactively. If you want to rescue a "
19319 "broken virtual machine image, you should look at the L<virt-rescue(1)> "
19324 #: ../fish/guestfish.pod:41 ../fish/guestfish.pod:947
19325 #: ../fuse/guestmount.pod:39 ../tools/virt-edit.pl:63 ../tools/virt-tar.pl:50
19330 #: ../fish/guestfish.pod:43
19331 msgid "As an interactive shell"
19335 #: ../fish/guestfish.pod:45
19343 #: ../fish/guestfish.pod:47
19346 " Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
19347 " editing virtual machine filesystems.\n"
19352 #: ../fish/guestfish.pod:50
19355 " Type: 'help' for a list of commands\n"
19356 " 'man' to read the manual\n"
19357 " 'quit' to quit the shell\n"
19362 #: ../fish/guestfish.pod:54
19365 " ><fs> add-ro disk.img\n"
19367 " ><fs> list-filesystems\n"
19368 " /dev/sda1: ext4\n"
19369 " /dev/vg_guest/lv_root: ext4\n"
19370 " /dev/vg_guest/lv_swap: swap\n"
19371 " ><fs> mount /dev/vg_guest/lv_root /\n"
19372 " ><fs> cat /etc/fstab\n"
19374 " # Created by anaconda\n"
19381 #: ../fish/guestfish.pod:67
19382 msgid "From shell scripts"
19386 #: ../fish/guestfish.pod:69
19387 msgid "Create a new C</etc/motd> file in a guest or disk image:"
19391 #: ../fish/guestfish.pod:71
19394 " guestfish <<_EOF_\n"
19397 " mount /dev/vg_guest/lv_root /\n"
19398 " write /etc/motd \"Welcome, new users\"\n"
19404 #: ../fish/guestfish.pod:78
19405 msgid "List the LVM logical volumes in a disk image:"
19409 #: ../fish/guestfish.pod:80
19412 " guestfish -a disk.img --ro <<_EOF_\n"
19420 #: ../fish/guestfish.pod:85
19421 msgid "List all the filesystems in a disk image:"
19425 #: ../fish/guestfish.pod:87
19428 " guestfish -a disk.img --ro <<_EOF_\n"
19430 " list-filesystems\n"
19436 #: ../fish/guestfish.pod:92
19437 msgid "On one command line"
19441 #: ../fish/guestfish.pod:94
19442 msgid "Update C</etc/resolv.conf> in a guest:"
19446 #: ../fish/guestfish.pod:96
19450 " add disk.img : run : mount /dev/vg_guest/lv_root / : \\\n"
19451 " write /etc/resolv.conf \"nameserver 1.2.3.4\"\n"
19456 #: ../fish/guestfish.pod:100
19457 msgid "Edit C</boot/grub/grub.conf> interactively:"
19461 #: ../fish/guestfish.pod:102
19464 " guestfish --rw --add disk.img \\\n"
19465 " --mount /dev/vg_guest/lv_root \\\n"
19466 " --mount /dev/sda1:/boot \\\n"
19467 " edit /boot/grub/grub.conf\n"
19472 #: ../fish/guestfish.pod:107
19473 msgid "Mount disks automatically"
19477 #: ../fish/guestfish.pod:109
19479 "Use the I<-i> option to automatically mount the disks from a virtual machine:"
19483 #: ../fish/guestfish.pod:112
19486 " guestfish --ro -a disk.img -i cat /etc/group\n"
19491 #: ../fish/guestfish.pod:114
19494 " guestfish --ro -d libvirt-domain -i cat /etc/group\n"
19499 #: ../fish/guestfish.pod:116
19500 msgid "Another way to edit C</boot/grub/grub.conf> interactively is:"
19504 #: ../fish/guestfish.pod:118
19507 " guestfish --rw -a disk.img -i edit /boot/grub/grub.conf\n"
19512 #: ../fish/guestfish.pod:120
19513 msgid "As a script interpreter"
19517 #: ../fish/guestfish.pod:122
19518 msgid "Create a 100MB disk containing an ext2-formatted partition:"
19522 #: ../fish/guestfish.pod:124
19525 " #!/usr/bin/guestfish -f\n"
19526 " sparse test1.img 100M\n"
19528 " part-disk /dev/sda mbr\n"
19529 " mkfs ext2 /dev/sda1\n"
19534 #: ../fish/guestfish.pod:130
19535 msgid "Start with a prepared disk"
19539 #: ../fish/guestfish.pod:132
19541 "An alternate way to create a 100MB disk called C<test1.img> containing a "
19542 "single ext2-formatted partition:"
19546 #: ../fish/guestfish.pod:135
19549 " guestfish -N fs\n"
19554 #: ../fish/guestfish.pod:137
19555 msgid "To list what is available do:"
19559 #: ../fish/guestfish.pod:139 ../fish/guestfish.pod:938
19562 " guestfish -N help | less\n"
19567 #: ../fish/guestfish.pod:141
19568 msgid "Remote control"
19572 #: ../fish/guestfish.pod:143
19575 " eval \"`guestfish --listen`\"\n"
19576 " guestfish --remote add-ro disk.img\n"
19577 " guestfish --remote run\n"
19578 " guestfish --remote lvs\n"
19583 #: ../fish/guestfish.pod:148 ../test-tool/libguestfs-test-tool.pod:37
19584 #: ../fuse/guestmount.pod:73 ../tools/virt-edit.pl:81
19585 #: ../tools/virt-win-reg.pl:96 ../tools/virt-list-filesystems.pl:53
19586 #: ../tools/virt-tar.pl:103 ../tools/virt-make-fs.pl:153
19587 #: ../tools/virt-list-partitions.pl:54
19592 #: ../fish/guestfish.pod:152 ../fuse/guestmount.pod:131
19593 #: ../tools/virt-edit.pl:89 ../tools/virt-win-reg.pl:104
19594 #: ../tools/virt-list-filesystems.pl:61 ../tools/virt-tar.pl:111
19595 #: ../tools/virt-make-fs.pl:161 ../tools/virt-list-partitions.pl:62
19600 #: ../fish/guestfish.pod:154
19601 msgid "Displays general help on options."
19605 #: ../fish/guestfish.pod:156
19610 #: ../fish/guestfish.pod:158
19611 msgid "B<--cmd-help>"
19615 #: ../fish/guestfish.pod:160
19616 msgid "Lists all available guestfish commands."
19620 #: ../fish/guestfish.pod:162
19625 #: ../fish/guestfish.pod:164
19626 msgid "B<--cmd-help cmd>"
19630 #: ../fish/guestfish.pod:166
19631 msgid "Displays detailed help on a single command C<cmd>."
19635 #: ../fish/guestfish.pod:168
19636 msgid "B<-a image>"
19640 #: ../fish/guestfish.pod:170
19641 msgid "B<--add image>"
19645 #: ../fish/guestfish.pod:172
19646 msgid "Add a block device or virtual machine image to the shell."
19650 #: ../fish/guestfish.pod:174 ../fuse/guestmount.pod:81
19652 "The format of the disk image is auto-detected. To override this and force a "
19653 "particular format use the I<--format=..> option."
19657 #: ../fish/guestfish.pod:177
19659 "Using this flag is mostly equivalent to using the C<add> command, with "
19660 "C<readonly:true> if the I<--ro> flag was given, and with C<format:...> if "
19661 "the I<--format=...> flag was given."
19665 #: ../fish/guestfish.pod:181
19670 #: ../fish/guestfish.pod:183
19671 msgid "B<--connect URI>"
19675 #: ../fish/guestfish.pod:185 ../fuse/guestmount.pod:86
19677 "When used in conjunction with the I<-d> option, this specifies the libvirt "
19678 "URI to use. The default is to use the default libvirt connection."
19682 #: ../fish/guestfish.pod:189
19687 #: ../fish/guestfish.pod:191
19689 "If using the I<--listen> option and a csh-like shell, use this option. See "
19690 "section L</REMOTE CONTROL AND CSH> below."
19694 #: ../fish/guestfish.pod:194
19695 msgid "B<-d libvirt-domain>"
19699 #: ../fish/guestfish.pod:196
19700 msgid "B<--domain libvirt-domain>"
19704 #: ../fish/guestfish.pod:198 ../fuse/guestmount.pod:92
19706 "Add disks from the named libvirt domain. If the I<--ro> option is also "
19707 "used, then any libvirt domain can be used. However in write mode, only "
19708 "libvirt domains which are shut down can be named here."
19712 #: ../fish/guestfish.pod:202
19714 "Using this flag is mostly equivalent to using the C<add-domain> command, "
19715 "with C<readonly:true> if the I<--ro> flag was given, and with C<format:...> "
19716 "if the I<--format:...> flag was given."
19720 #: ../fish/guestfish.pod:206
19725 #: ../fish/guestfish.pod:208
19726 msgid "B<--no-dest-paths>"
19730 #: ../fish/guestfish.pod:210
19732 "Don't tab-complete paths on the guest filesystem. It is useful to be able "
19733 "to hit the tab key to complete paths on the guest filesystem, but this "
19734 "causes extra \"hidden\" guestfs calls to be made, so this option is here to "
19735 "allow this feature to be disabled."
19739 #: ../fish/guestfish.pod:215 ../fuse/guestmount.pod:108
19740 msgid "B<--echo-keys>"
19744 #: ../fish/guestfish.pod:217 ../fuse/guestmount.pod:110
19746 "When prompting for keys and passphrases, guestfish normally turns echoing "
19747 "off so you cannot see what you are typing. If you are not worried about "
19748 "Tempest attacks and there is no one else in the room you can specify this "
19749 "flag to see what you are typing."
19753 #: ../fish/guestfish.pod:222
19758 #: ../fish/guestfish.pod:224
19759 msgid "B<--file file>"
19763 #: ../fish/guestfish.pod:226
19764 msgid "Read commands from C<file>. To write pure guestfish scripts, use:"
19768 #: ../fish/guestfish.pod:229
19771 " #!/usr/bin/guestfish -f\n"
19776 #: ../fish/guestfish.pod:231
19777 msgid "B<--format=raw|qcow2|..>"
19781 #: ../fish/guestfish.pod:233
19782 msgid "B<--format>"
19786 #: ../fish/guestfish.pod:235 ../fuse/guestmount.pod:117
19788 "The default for the I<-a> option is to auto-detect the format of the disk "
19789 "image. Using this forces the disk format for I<-a> options which follow on "
19790 "the command line. Using I<--format> with no argument switches back to auto-"
19791 "detection for subsequent I<-a> options."
19795 #: ../fish/guestfish.pod:242
19798 " guestfish --format=raw -a disk.img\n"
19803 #: ../fish/guestfish.pod:244
19804 msgid "forces raw format (no auto-detection) for C<disk.img>."
19808 #: ../fish/guestfish.pod:246
19811 " guestfish --format=raw -a disk.img --format -a another.img\n"
19816 #: ../fish/guestfish.pod:248
19818 "forces raw format (no auto-detection) for C<disk.img> and reverts to auto-"
19819 "detection for C<another.img>."
19823 #: ../fish/guestfish.pod:251
19825 "If you have untrusted raw-format guest disk images, you should use this "
19826 "option to specify the disk format. This avoids a possible security problem "
19827 "with malicious guests (CVE-2010-3851). See also L</add-drive-opts>."
19831 #: ../fish/guestfish.pod:256
19836 #: ../fish/guestfish.pod:258
19837 msgid "B<--inspector>"
19841 #: ../fish/guestfish.pod:260 ../fuse/guestmount.pod:137
19843 "Using L<virt-inspector(1)> code, inspect the disks looking for an operating "
19844 "system and mount filesystems as they would be mounted on the real virtual "
19849 #: ../fish/guestfish.pod:264
19850 msgid "Typical usage is either:"
19854 #: ../fish/guestfish.pod:266
19857 " guestfish -d myguest -i\n"
19862 #: ../fish/guestfish.pod:268
19863 msgid "(for an inactive libvirt domain called I<myguest>), or:"
19867 #: ../fish/guestfish.pod:270
19870 " guestfish --ro -d myguest -i\n"
19875 #: ../fish/guestfish.pod:272
19876 msgid "(for active domains, readonly), or specify the block device directly:"
19880 #: ../fish/guestfish.pod:274
19883 " guestfish --rw -a /dev/Guests/MyGuest -i\n"
19888 #: ../fish/guestfish.pod:276
19890 "Note that the command line syntax changed slightly over older versions of "
19891 "guestfish. You can still use the old syntax:"
19895 #: ../fish/guestfish.pod:279
19898 " guestfish [--ro] -i disk.img\n"
19903 #: ../fish/guestfish.pod:281
19906 " guestfish [--ro] -i libvirt-domain\n"
19911 #: ../fish/guestfish.pod:283
19913 "Using this flag is mostly equivalent to using the C<inspect-os> command and "
19914 "then using other commands to mount the filesystems that were found."
19918 #: ../fish/guestfish.pod:287 ../fuse/guestmount.pod:141
19919 msgid "B<--keys-from-stdin>"
19923 #: ../fish/guestfish.pod:289 ../fuse/guestmount.pod:143
19925 "Read key or passphrase parameters from stdin. The default is to try to read "
19926 "passphrases from the user by opening C</dev/tty>."
19930 #: ../fish/guestfish.pod:292
19931 msgid "B<--listen>"
19935 #: ../fish/guestfish.pod:294
19937 "Fork into the background and listen for remote commands. See section L</"
19938 "REMOTE CONTROL GUESTFISH OVER A SOCKET> below."
19942 #: ../fish/guestfish.pod:297 ../fuse/guestmount.pod:146
19947 #: ../fish/guestfish.pod:299 ../fuse/guestmount.pod:148
19949 "Connect to a live virtual machine. (Experimental, see L<guestfs(3)/"
19950 "ATTACHING TO RUNNING DAEMONS>)."
19954 #: ../fish/guestfish.pod:302 ../fuse/guestmount.pod:151
19955 msgid "B<-m dev[:mountpoint[:options]]>"
19959 #: ../fish/guestfish.pod:304 ../fuse/guestmount.pod:153
19960 msgid "B<--mount dev[:mountpoint[:options]]>"
19964 #: ../fish/guestfish.pod:306
19965 msgid "Mount the named partition or logical volume on the given mountpoint."
19969 #: ../fish/guestfish.pod:308
19970 msgid "If the mountpoint is omitted, it defaults to C</>."
19974 #: ../fish/guestfish.pod:310
19975 msgid "You have to mount something on C</> before most commands will work."
19979 #: ../fish/guestfish.pod:312
19981 "If any I<-m> or I<--mount> options are given, the guest is automatically "
19986 #: ../fish/guestfish.pod:315
19988 "If you don't know what filesystems a disk image contains, you can either run "
19989 "guestfish without this option, then list the partitions, filesystems and LVs "
19990 "available (see L</list-partitions>, L</list-filesystems> and L</lvs> "
19991 "commands), or you can use the L<virt-filesystems(1)> program."
19995 #: ../fish/guestfish.pod:321 ../fuse/guestmount.pod:161
19997 "The third (and rarely used) part of the mount parameter is the list of mount "
19998 "options used to mount the underlying filesystem. If this is not given, then "
19999 "the mount options are either the empty string or C<ro> (the latter if the "
20000 "I<--ro> flag is used). By specifying the mount options, you override this "
20001 "default choice. Probably the only time you would use this is to enable ACLs "
20002 "and/or extended attributes if the filesystem can support them:"
20006 #: ../fish/guestfish.pod:329 ../fuse/guestmount.pod:169
20009 " -m /dev/sda1:/:acl,user_xattr\n"
20014 #: ../fish/guestfish.pod:331
20015 msgid "Using this flag is equivalent to using the C<mount-options> command."
20019 #: ../fish/guestfish.pod:333
20024 #: ../fish/guestfish.pod:335
20025 msgid "B<--no-sync>"
20029 #: ../fish/guestfish.pod:337
20031 "Disable autosync. This is enabled by default. See the discussion of "
20032 "autosync in the L<guestfs(3)> manpage."
20036 #: ../fish/guestfish.pod:340
20041 #: ../fish/guestfish.pod:342
20042 msgid "B<--new type>"
20046 #: ../fish/guestfish.pod:344
20051 #: ../fish/guestfish.pod:346
20053 "Prepare a fresh disk image formatted as \"type\". This is an alternative to "
20054 "the I<-a> option: whereas I<-a> adds an existing disk, I<-N> creates a "
20055 "preformatted disk with a filesystem and adds it. See L</PREPARED DISK "
20060 #: ../fish/guestfish.pod:351
20061 msgid "B<--progress-bars>"
20065 #: ../fish/guestfish.pod:353
20066 msgid "Enable progress bars, even when guestfish is used non-interactively."
20070 #: ../fish/guestfish.pod:355
20072 "Progress bars are enabled by default when guestfish is used as an "
20073 "interactive shell."
20077 #: ../fish/guestfish.pod:358
20078 msgid "B<--no-progress-bars>"
20082 #: ../fish/guestfish.pod:360
20083 msgid "Disable progress bars."
20087 #: ../fish/guestfish.pod:362
20088 msgid "B<--remote[=pid]>"
20092 #: ../fish/guestfish.pod:364
20094 "Send remote commands to C<$GUESTFISH_PID> or C<pid>. See section L</REMOTE "
20095 "CONTROL GUESTFISH OVER A SOCKET> below."
20099 #: ../fish/guestfish.pod:367
20104 #: ../fish/guestfish.pod:369
20109 #: ../fish/guestfish.pod:371
20111 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
20112 "mounts are done read-only."
20116 #: ../fish/guestfish.pod:374
20118 "The option must always be used if the disk image or virtual machine might be "
20119 "running, and is generally recommended in cases where you don't need write "
20120 "access to the disk."
20124 #: ../fish/guestfish.pod:378
20126 "Note that prepared disk images created with I<-N> are not affected by this "
20127 "option. Also commands like C<add> are not affected - you have to specify "
20128 "the C<readonly:true> option explicitly if you need it."
20132 #: ../fish/guestfish.pod:382
20133 msgid "See also L</OPENING DISKS FOR READ AND WRITE> below."
20137 #: ../fish/guestfish.pod:384 ../fuse/guestmount.pod:225
20138 msgid "B<--selinux>"
20142 #: ../fish/guestfish.pod:386
20143 msgid "Enable SELinux support for the guest. See L<guestfs(3)/SELINUX>."
20147 #: ../fish/guestfish.pod:388
20152 #: ../fish/guestfish.pod:390
20153 msgid "B<--verbose>"
20157 #: ../fish/guestfish.pod:392
20159 "Enable very verbose messages. This is particularly useful if you find a bug."
20163 #: ../fish/guestfish.pod:395
20168 #: ../fish/guestfish.pod:397 ../tools/virt-edit.pl:97
20169 #: ../tools/virt-win-reg.pl:112 ../tools/virt-list-filesystems.pl:69
20170 #: ../tools/virt-tar.pl:119 ../tools/virt-make-fs.pl:169
20171 #: ../tools/virt-list-partitions.pl:70
20172 msgid "B<--version>"
20176 #: ../fish/guestfish.pod:399
20177 msgid "Display the guestfish / libguestfs version number and exit."
20181 #: ../fish/guestfish.pod:401
20186 #: ../fish/guestfish.pod:403
20191 #: ../fish/guestfish.pod:405 ../fuse/guestmount.pod:239
20193 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
20194 "mounts are done read-write."
20198 #: ../fish/guestfish.pod:408
20199 msgid "See L</OPENING DISKS FOR READ AND WRITE> below."
20203 #: ../fish/guestfish.pod:410
20208 #: ../fish/guestfish.pod:412
20209 msgid "Echo each command before executing it."
20213 #: ../fish/guestfish.pod:416
20214 msgid "COMMANDS ON COMMAND LINE"
20218 #: ../fish/guestfish.pod:418
20220 "Any additional (non-option) arguments are treated as commands to execute."
20224 #: ../fish/guestfish.pod:421
20226 "Commands to execute should be separated by a colon (C<:>), where the colon "
20227 "is a separate parameter. Thus:"
20231 #: ../fish/guestfish.pod:424
20234 " guestfish cmd [args...] : cmd [args...] : cmd [args...] ...\n"
20239 #: ../fish/guestfish.pod:426
20241 "If there are no additional arguments, then we enter a shell, either an "
20242 "interactive shell with a prompt (if the input is a terminal) or a non-"
20243 "interactive shell."
20247 #: ../fish/guestfish.pod:430
20249 "In either command line mode or non-interactive shell, the first command that "
20250 "gives an error causes the whole shell to exit. In interactive mode (with a "
20251 "prompt) if a command fails, you can continue to enter commands."
20255 #: ../fish/guestfish.pod:435
20256 msgid "USING launch (OR run)"
20260 #: ../fish/guestfish.pod:437
20262 "As with L<guestfs(3)>, you must first configure your guest by adding disks, "
20263 "then launch it, then mount any disks you need, and finally issue actions/"
20264 "commands. So the general order of the day is:"
20268 #: ../fish/guestfish.pod:445
20269 msgid "add or -a/--add"
20273 #: ../fish/guestfish.pod:449
20274 msgid "launch (aka run)"
20278 #: ../fish/guestfish.pod:453
20279 msgid "mount or -m/--mount"
20283 #: ../fish/guestfish.pod:457
20284 msgid "any other commands"
20288 #: ../fish/guestfish.pod:461
20290 "C<run> is a synonym for C<launch>. You must C<launch> (or C<run>) your "
20291 "guest before mounting or performing any other commands."
20295 #: ../fish/guestfish.pod:464
20297 "The only exception is that if any of the I<-i>, I<-m>, I<--mount>, I<-N> or "
20298 "I<--new> options were given then C<run> is done automatically, simply "
20299 "because guestfish can't perform the action you asked for without doing this."
20303 #: ../fish/guestfish.pod:469
20304 msgid "OPENING DISKS FOR READ AND WRITE"
20308 #: ../fish/guestfish.pod:471
20310 "The guestfish, L<guestmount(1)> and L<virt-rescue(1)> options I<--ro> and "
20311 "I<--rw> affect whether the other command line options I<-a>, I<-c>, I<-d>, "
20312 "I<-i> and I<-m> open disk images read-only or for writing."
20316 #: ../fish/guestfish.pod:476
20318 "In libguestfs E<le> 1.10, guestfish, guestmount and virt-rescue defaulted to "
20319 "opening disk images supplied on the command line for write. To open a disk "
20320 "image read-only you have to do I<-a image --ro>."
20324 #: ../fish/guestfish.pod:480
20326 "This matters: If you accidentally open a live VM disk image writable then "
20327 "you will cause irreversible disk corruption."
20331 #: ../fish/guestfish.pod:483
20333 "By libguestfs 1.12 we intend to change the default the other way. Disk "
20334 "images will be opened read-only. You will have to either specify "
20335 "I<guestfish --rw>, I<guestmount --rw>, I<virt-rescue --rw>, or change the "
20336 "configuration file C</etc/libguestfs-tools.conf> in order to get write "
20337 "access for disk images specified by those other command line options."
20341 #: ../fish/guestfish.pod:490
20343 "This version of guestfish, guestmount and virt-rescue has a I<--rw> option "
20344 "which does nothing (it is already the default). However it is highly "
20345 "recommended that you use this option to indicate that you need write access, "
20346 "and prepare your scripts for the day when this option will be required for "
20351 #: ../fish/guestfish.pod:496
20353 "B<Note:> This does I<not> affect commands like L</add> and L</mount>, or any "
20354 "other libguestfs program apart from guestfish and guestmount."
20358 #: ../fish/guestfish.pod:499
20363 #: ../fish/guestfish.pod:501
20365 "You can quote ordinary parameters using either single or double quotes. For "
20370 #: ../fish/guestfish.pod:504
20373 " add \"file with a space.img\"\n"
20378 #: ../fish/guestfish.pod:506
20381 " rm '/file name'\n"
20386 #: ../fish/guestfish.pod:508
20394 #: ../fish/guestfish.pod:510
20396 "A few commands require a list of strings to be passed. For these, use a "
20397 "whitespace-separated list, enclosed in quotes. Strings containing "
20398 "whitespace to be passed through must be enclosed in single quotes. A "
20399 "literal single quote must be escaped with a backslash."
20403 #: ../fish/guestfish.pod:515
20406 " vgcreate VG \"/dev/sda1 /dev/sdb1\"\n"
20407 " command \"/bin/echo 'foo bar'\"\n"
20408 " command \"/bin/echo \\'foo\\'\"\n"
20413 #: ../fish/guestfish.pod:519
20414 msgid "OPTIONAL ARGUMENTS"
20418 #: ../fish/guestfish.pod:521
20420 "Some commands take optional arguments. These arguments appear in this "
20421 "documentation as C<[argname:..]>. You can use them as in these examples:"
20425 #: ../fish/guestfish.pod:525
20428 " add-drive-opts filename\n"
20433 #: ../fish/guestfish.pod:527
20436 " add-drive-opts filename readonly:true\n"
20441 #: ../fish/guestfish.pod:529
20444 " add-drive-opts filename format:qcow2 readonly:false\n"
20449 #: ../fish/guestfish.pod:531
20451 "Each optional argument can appear at most once. All optional arguments must "
20452 "appear after the required ones."
20456 #: ../fish/guestfish.pod:534
20461 #: ../fish/guestfish.pod:536
20463 "This section applies to all commands which can take integers as parameters."
20467 #: ../fish/guestfish.pod:539
20468 msgid "SIZE SUFFIX"
20472 #: ../fish/guestfish.pod:541
20474 "When the command takes a parameter measured in bytes, you can use one of the "
20475 "following suffixes to specify kilobytes, megabytes and larger sizes:"
20479 #: ../fish/guestfish.pod:547
20480 msgid "B<k> or B<K> or B<KiB>"
20484 #: ../fish/guestfish.pod:549
20485 msgid "The size in kilobytes (multiplied by 1024)."
20489 #: ../fish/guestfish.pod:551
20494 #: ../fish/guestfish.pod:553
20495 msgid "The size in SI 1000 byte units."
20499 #: ../fish/guestfish.pod:555
20500 msgid "B<M> or B<MiB>"
20504 #: ../fish/guestfish.pod:557
20505 msgid "The size in megabytes (multiplied by 1048576)."
20509 #: ../fish/guestfish.pod:559
20514 #: ../fish/guestfish.pod:561
20515 msgid "The size in SI 1000000 byte units."
20519 #: ../fish/guestfish.pod:563
20520 msgid "B<G> or B<GiB>"
20524 #: ../fish/guestfish.pod:565
20525 msgid "The size in gigabytes (multiplied by 2**30)."
20529 #: ../fish/guestfish.pod:567
20534 #: ../fish/guestfish.pod:569
20535 msgid "The size in SI 10**9 byte units."
20539 #: ../fish/guestfish.pod:571
20540 msgid "B<T> or B<TiB>"
20544 #: ../fish/guestfish.pod:573
20545 msgid "The size in terabytes (multiplied by 2**40)."
20549 #: ../fish/guestfish.pod:575
20554 #: ../fish/guestfish.pod:577
20555 msgid "The size in SI 10**12 byte units."
20559 #: ../fish/guestfish.pod:579
20560 msgid "B<P> or B<PiB>"
20564 #: ../fish/guestfish.pod:581
20565 msgid "The size in petabytes (multiplied by 2**50)."
20569 #: ../fish/guestfish.pod:583
20574 #: ../fish/guestfish.pod:585
20575 msgid "The size in SI 10**15 byte units."
20579 #: ../fish/guestfish.pod:587
20580 msgid "B<E> or B<EiB>"
20584 #: ../fish/guestfish.pod:589
20585 msgid "The size in exabytes (multiplied by 2**60)."
20589 #: ../fish/guestfish.pod:591
20594 #: ../fish/guestfish.pod:593
20595 msgid "The size in SI 10**18 byte units."
20599 #: ../fish/guestfish.pod:595
20600 msgid "B<Z> or B<ZiB>"
20604 #: ../fish/guestfish.pod:597
20605 msgid "The size in zettabytes (multiplied by 2**70)."
20609 #: ../fish/guestfish.pod:599
20614 #: ../fish/guestfish.pod:601
20615 msgid "The size in SI 10**21 byte units."
20619 #: ../fish/guestfish.pod:603
20620 msgid "B<Y> or B<YiB>"
20624 #: ../fish/guestfish.pod:605
20625 msgid "The size in yottabytes (multiplied by 2**80)."
20629 #: ../fish/guestfish.pod:607
20634 #: ../fish/guestfish.pod:609
20635 msgid "The size in SI 10**24 byte units."
20639 #: ../fish/guestfish.pod:615
20642 " truncate-size /file 1G\n"
20647 #: ../fish/guestfish.pod:617
20648 msgid "would truncate the file to 1 gigabyte."
20652 #: ../fish/guestfish.pod:619
20654 "Be careful because a few commands take sizes in kilobytes or megabytes (eg. "
20655 "the parameter to L</memsize> is specified in megabytes already). Adding a "
20656 "suffix will probably not do what you expect."
20660 #: ../fish/guestfish.pod:623
20661 msgid "OCTAL AND HEXADECIMAL NUMBERS"
20665 #: ../fish/guestfish.pod:625
20667 "For specifying the radix (base) use the C convention: C<0> to prefix an "
20668 "octal number or C<0x> to prefix a hexadecimal number. For example:"
20672 #: ../fish/guestfish.pod:628
20675 " 1234 decimal number 1234\n"
20676 " 02322 octal number, equivalent to decimal 1234\n"
20677 " 0x4d2 hexadecimal number, equivalent to decimal 1234\n"
20682 #: ../fish/guestfish.pod:632
20684 "When using the C<chmod> command, you almost always want to specify an octal "
20685 "number for the mode, and you must prefix it with C<0> (unlike the Unix "
20686 "L<chmod(1)> program):"
20690 #: ../fish/guestfish.pod:636
20693 " chmod 0777 /public # OK\n"
20694 " chmod 777 /public # WRONG! This is mode 777 decimal = 01411 octal.\n"
20699 #: ../fish/guestfish.pod:639
20701 "Commands that return numbers usually print them in decimal, but some "
20702 "commands print numbers in other radices (eg. C<umask> prints the mode in "
20703 "octal, preceeded by C<0>)."
20707 #: ../fish/guestfish.pod:643
20708 msgid "WILDCARDS AND GLOBBING"
20712 #: ../fish/guestfish.pod:645
20714 "Neither guestfish nor the underlying guestfs API performs wildcard expansion "
20715 "(globbing) by default. So for example the following will not do what you "
20720 #: ../fish/guestfish.pod:649
20728 #: ../fish/guestfish.pod:651
20730 "Assuming you don't have a directory called literally C</home/*> then the "
20731 "above command will return an error."
20735 #: ../fish/guestfish.pod:654
20736 msgid "To perform wildcard expansion, use the C<glob> command."
20740 #: ../fish/guestfish.pod:656
20743 " glob rm-rf /home/*\n"
20748 #: ../fish/guestfish.pod:658
20750 "runs C<rm-rf> on each path that matches (ie. potentially running the command "
20751 "many times), equivalent to:"
20755 #: ../fish/guestfish.pod:661
20758 " rm-rf /home/jim\n"
20759 " rm-rf /home/joe\n"
20760 " rm-rf /home/mary\n"
20765 #: ../fish/guestfish.pod:665
20766 msgid "C<glob> only works on simple guest paths and not on device names."
20770 #: ../fish/guestfish.pod:667
20772 "If you have several parameters, each containing a wildcard, then glob will "
20773 "perform a Cartesian product."
20777 #: ../fish/guestfish.pod:670
20782 #: ../fish/guestfish.pod:672
20784 "Any line which starts with a I<#> character is treated as a comment and "
20785 "ignored. The I<#> can optionally be preceeded by whitespace, but B<not> by "
20786 "a command. For example:"
20790 #: ../fish/guestfish.pod:676
20793 " # this is a comment\n"
20794 " # this is a comment\n"
20795 " foo # NOT a comment\n"
20800 #: ../fish/guestfish.pod:680
20801 msgid "Blank lines are also ignored."
20805 #: ../fish/guestfish.pod:682
20806 msgid "RUNNING COMMANDS LOCALLY"
20810 #: ../fish/guestfish.pod:684
20812 "Any line which starts with a I<!> character is treated as a command sent to "
20813 "the local shell (C</bin/sh> or whatever L<system(3)> uses). For example:"
20817 #: ../fish/guestfish.pod:688
20821 " tgz-out /remote local/remote-data.tar.gz\n"
20826 #: ../fish/guestfish.pod:691
20828 "will create a directory C<local> on the host, and then export the contents "
20829 "of C</remote> on the mounted filesystem to C<local/remote-data.tar.gz>. "
20830 "(See C<tgz-out>)."
20834 #: ../fish/guestfish.pod:695
20836 "To change the local directory, use the C<lcd> command. C<!cd> will have no "
20837 "effect, due to the way that subprocesses work in Unix."
20841 #: ../fish/guestfish.pod:698
20842 msgid "LOCAL COMMANDS WITH INLINE EXECUTION"
20846 #: ../fish/guestfish.pod:700
20848 "If a line starts with I<E<lt>!> then the shell command is executed (as for "
20849 "I<!>), but subsequently any output (stdout) of the shell command is parsed "
20850 "and executed as guestfish commands."
20854 #: ../fish/guestfish.pod:704
20856 "Thus you can use shell script to construct arbitrary guestfish commands "
20857 "which are then parsed by guestfish."
20861 #: ../fish/guestfish.pod:707
20863 "For example it is tedious to create a sequence of files (eg. C</foo.1> "
20864 "through C</foo.100>) using guestfish commands alone. However this is simple "
20865 "if we use a shell script to create the guestfish commands for us:"
20869 #: ../fish/guestfish.pod:712
20872 " <! for n in `seq 1 100`; do echo write /foo.$n $n; done\n"
20877 #: ../fish/guestfish.pod:714
20878 msgid "or with names like C</foo.001>:"
20882 #: ../fish/guestfish.pod:716
20885 " <! for n in `seq 1 100`; do printf \"write /foo.%03d %d\\n\" $n $n; done\n"
20890 #: ../fish/guestfish.pod:718
20892 "When using guestfish interactively it can be helpful to just run the shell "
20893 "script first (ie. remove the initial C<E<lt>> character so it is just an "
20894 "ordinary I<!> local command), see what guestfish commands it would run, and "
20895 "when you are happy with those prepend the C<E<lt>> character to run the "
20896 "guestfish commands for real."
20900 #: ../fish/guestfish.pod:724
20905 #: ../fish/guestfish.pod:726
20907 "Use C<command E<lt>spaceE<gt> | command> to pipe the output of the first "
20908 "command (a guestfish command) to the second command (any host command). For "
20913 #: ../fish/guestfish.pod:730
20916 " cat /etc/passwd | awk -F: '$3 == 0 { print }'\n"
20921 #: ../fish/guestfish.pod:732
20923 "(where C<cat> is the guestfish cat command, but C<awk> is the host awk "
20924 "program). The above command would list all accounts in the guest filesystem "
20925 "which have UID 0, ie. root accounts including backdoors. Other examples:"
20929 #: ../fish/guestfish.pod:737
20932 " hexdump /bin/ls | head\n"
20933 " list-devices | tail -1\n"
20934 " tgz-out / - | tar ztf -\n"
20939 #: ../fish/guestfish.pod:741
20941 "The space before the pipe symbol is required, any space after the pipe "
20942 "symbol is optional. Everything after the pipe symbol is just passed "
20943 "straight to the host shell, so it can contain redirections, globs and "
20944 "anything else that makes sense on the host side."
20948 #: ../fish/guestfish.pod:746
20950 "To use a literal argument which begins with a pipe symbol, you have to quote "
20955 #: ../fish/guestfish.pod:749
20963 #: ../fish/guestfish.pod:751
20964 msgid "HOME DIRECTORIES"
20968 #: ../fish/guestfish.pod:753
20970 "If a parameter starts with the character C<~> then the tilde may be expanded "
20971 "as a home directory path (either C<~> for the current user's home directory, "
20972 "or C<~user> for another user)."
20976 #: ../fish/guestfish.pod:757
20978 "Note that home directory expansion happens for users known I<on the host>, "
20979 "not in the guest filesystem."
20983 #: ../fish/guestfish.pod:760
20985 "To use a literal argument which begins with a tilde, you have to quote it, "
20990 #: ../fish/guestfish.pod:763
20998 #: ../fish/guestfish.pod:767
21000 "Libguestfs has some support for Linux guests encrypted according to the "
21001 "Linux Unified Key Setup (LUKS) standard, which includes nearly all whole "
21002 "disk encryption systems used by modern Linux guests. Currently only LVM-on-"
21003 "LUKS is supported."
21007 #: ../fish/guestfish.pod:772
21008 msgid "Identify encrypted block devices and partitions using L</vfs-type>:"
21012 #: ../fish/guestfish.pod:774
21015 " ><fs> vfs-type /dev/sda2\n"
21021 #: ../fish/guestfish.pod:777
21023 "Then open those devices using L</luks-open>. This creates a device-mapper "
21024 "device called C</dev/mapper/luksdev>."
21028 #: ../fish/guestfish.pod:780
21031 " ><fs> luks-open /dev/sda2 luksdev\n"
21032 " Enter key or passphrase (\"key\"): <enter the passphrase>\n"
21037 #: ../fish/guestfish.pod:783
21039 "Finally you have to tell LVM to scan for volume groups on the newly created "
21044 #: ../fish/guestfish.pod:786
21048 " vg-activate-all true\n"
21053 #: ../fish/guestfish.pod:789
21054 msgid "The logical volume(s) can now be mounted in the usual way."
21058 #: ../fish/guestfish.pod:791
21060 "Before closing a LUKS device you must unmount any logical volumes on it and "
21061 "deactivate the volume groups by calling C<vg-activate false VG> on each "
21062 "one. Then you can close the mapper device:"
21066 #: ../fish/guestfish.pod:795
21069 " vg-activate false /dev/VG\n"
21070 " luks-close /dev/mapper/luksdev\n"
21075 #: ../fish/guestfish.pod:798 ../tools/virt-edit.pl:342
21076 msgid "WINDOWS PATHS"
21080 #: ../fish/guestfish.pod:800
21082 "If a path is prefixed with C<win:> then you can use Windows-style drive "
21083 "letters and paths (with some limitations). The following commands are "
21088 #: ../fish/guestfish.pod:804
21091 " file /WINDOWS/system32/config/system.LOG\n"
21096 #: ../fish/guestfish.pod:806
21099 " file win:\\windows\\system32\\config\\system.log\n"
21104 #: ../fish/guestfish.pod:808
21107 " file WIN:C:\\Windows\\SYSTEM32\\CONFIG\\SYSTEM.LOG\n"
21112 #: ../fish/guestfish.pod:810
21114 "The parameter is rewritten \"behind the scenes\" by looking up the position "
21115 "where the drive is mounted, prepending that to the path, changing all "
21116 "backslash characters to forward slash, then resolving the result using L</"
21117 "case-sensitive-path>. For example if the E: drive was mounted on C</e> then "
21118 "the parameter might be rewritten like this:"
21122 #: ../fish/guestfish.pod:816
21125 " win:e:\\foo\\bar => /e/FOO/bar\n"
21130 #: ../fish/guestfish.pod:818
21131 msgid "This only works in argument positions that expect a path."
21135 #: ../fish/guestfish.pod:820
21136 msgid "UPLOADING AND DOWNLOADING FILES"
21140 #: ../fish/guestfish.pod:822
21142 "For commands such as C<upload>, C<download>, C<tar-in>, C<tar-out> and "
21143 "others which upload from or download to a local file, you can use the "
21144 "special filename C<-> to mean \"from stdin\" or \"to stdout\". For example:"
21148 #: ../fish/guestfish.pod:826
21156 #: ../fish/guestfish.pod:828
21158 "reads stdin and creates from that a file C</foo> in the disk image, and:"
21162 #: ../fish/guestfish.pod:831
21165 " tar-out /etc - | tar tf -\n"
21170 #: ../fish/guestfish.pod:833
21172 "writes the tarball to stdout and then pipes that into the external \"tar\" "
21173 "command (see L</PIPES>)."
21177 #: ../fish/guestfish.pod:836
21179 "When using C<-> to read from stdin, the input is read up to the end of "
21180 "stdin. You can also use a special \"heredoc\"-like syntax to read up to "
21181 "some arbitrary end marker:"
21185 #: ../fish/guestfish.pod:840
21188 " upload -<<END /foo\n"
21197 #: ../fish/guestfish.pod:846
21199 "Any string of characters can be used instead of C<END>. The end marker must "
21200 "appear on a line of its own, without any preceeding or following characters "
21201 "(not even spaces)."
21205 #: ../fish/guestfish.pod:850
21207 "Note that the C<-E<lt>E<lt>> syntax only applies to parameters used to "
21208 "upload local files (so-called \"FileIn\" parameters in the generator)."
21212 #: ../fish/guestfish.pod:853
21213 msgid "EXIT ON ERROR BEHAVIOUR"
21217 #: ../fish/guestfish.pod:855
21219 "By default, guestfish will ignore any errors when in interactive mode (ie. "
21220 "taking commands from a human over a tty), and will exit on the first error "
21221 "in non-interactive mode (scripts, commands given on the command line)."
21225 #: ../fish/guestfish.pod:860
21227 "If you prefix a command with a I<-> character, then that command will not "
21228 "cause guestfish to exit, even if that (one) command returns an error."
21232 #: ../fish/guestfish.pod:864
21233 msgid "REMOTE CONTROL GUESTFISH OVER A SOCKET"
21237 #: ../fish/guestfish.pod:866
21239 "Guestfish can be remote-controlled over a socket. This is useful "
21240 "particularly in shell scripts where you want to make several different "
21241 "changes to a filesystem, but you don't want the overhead of starting up a "
21242 "guestfish process each time."
21246 #: ../fish/guestfish.pod:871
21247 msgid "Start a guestfish server process using:"
21251 #: ../fish/guestfish.pod:873
21254 " eval \"`guestfish --listen`\"\n"
21259 #: ../fish/guestfish.pod:875
21260 msgid "and then send it commands by doing:"
21264 #: ../fish/guestfish.pod:877
21267 " guestfish --remote cmd [...]\n"
21272 #: ../fish/guestfish.pod:879
21273 msgid "To cause the server to exit, send it the exit command:"
21277 #: ../fish/guestfish.pod:881
21280 " guestfish --remote exit\n"
21285 #: ../fish/guestfish.pod:883
21287 "Note that the server will normally exit if there is an error in a command. "
21288 "You can change this in the usual way. See section L</EXIT ON ERROR "
21293 #: ../fish/guestfish.pod:887
21294 msgid "CONTROLLING MULTIPLE GUESTFISH PROCESSES"
21298 #: ../fish/guestfish.pod:889
21300 "The C<eval> statement sets the environment variable C<$GUESTFISH_PID>, which "
21301 "is how the I<--remote> option knows where to send the commands. You can "
21302 "have several guestfish listener processes running using:"
21306 #: ../fish/guestfish.pod:893
21309 " eval \"`guestfish --listen`\"\n"
21310 " pid1=$GUESTFISH_PID\n"
21311 " eval \"`guestfish --listen`\"\n"
21312 " pid2=$GUESTFISH_PID\n"
21314 " guestfish --remote=$pid1 cmd\n"
21315 " guestfish --remote=$pid2 cmd\n"
21320 #: ../fish/guestfish.pod:901
21321 msgid "REMOTE CONTROL AND CSH"
21325 #: ../fish/guestfish.pod:903
21327 "When using csh-like shells (csh, tcsh etc) you have to add the I<--csh> "
21332 #: ../fish/guestfish.pod:906
21335 " eval \"`guestfish --listen --csh`\"\n"
21340 #: ../fish/guestfish.pod:908
21341 msgid "REMOTE CONTROL DETAILS"
21345 #: ../fish/guestfish.pod:910
21347 "Remote control happens over a Unix domain socket called C</tmp/.guestfish-"
21348 "$UID/socket-$PID>, where C<$UID> is the effective user ID of the process, "
21349 "and C<$PID> is the process ID of the server."
21353 #: ../fish/guestfish.pod:914
21354 msgid "Guestfish client and server versions must match exactly."
21358 #: ../fish/guestfish.pod:916
21359 msgid "PREPARED DISK IMAGES"
21363 #: ../fish/guestfish.pod:918
21365 "Use the I<-N type> or I<--new type> parameter to select one of a set of "
21366 "preformatted disk images that guestfish can make for you to save typing. "
21367 "This is particularly useful for testing purposes. This option is used "
21368 "instead of the I<-a> option, and like I<-a> can appear multiple times (and "
21369 "can be mixed with I<-a>)."
21373 #: ../fish/guestfish.pod:924
21375 "The new disk is called C<test1.img> for the first I<-N>, C<test2.img> for "
21376 "the second and so on. Existing files in the current directory are "
21381 #: ../fish/guestfish.pod:928
21383 "The type briefly describes how the disk should be sized, partitioned, how "
21384 "filesystem(s) should be created, and how content should be added. "
21385 "Optionally the type can be followed by extra parameters, separated by C<:> "
21386 "(colon) characters. For example, I<-N fs> creates a default 100MB, sparsely-"
21387 "allocated disk, containing a single partition, with the partition formatted "
21388 "as ext2. I<-N fs:ext4:1G> is the same, but for an ext4 filesystem on a 1GB "
21393 #: ../fish/guestfish.pod:936
21394 msgid "To list the available types and any extra parameters they take, run:"
21398 #: ../fish/guestfish.pod:940
21400 "Note that the prepared filesystem is not mounted. You would usually have to "
21401 "use the C<mount /dev/sda1 /> command or add the I<-m /dev/sda1> option."
21405 #: ../fish/guestfish.pod:944
21407 "If any I<-N> or I<--new> options are given, the guest is automatically "
21412 #: ../fish/guestfish.pod:949
21413 msgid "Create a 100MB disk with an ext4-formatted partition:"
21417 #: ../fish/guestfish.pod:951
21420 " guestfish -N fs:ext4\n"
21425 #: ../fish/guestfish.pod:953
21426 msgid "Create a 32MB disk with a VFAT-formatted partition, and mount it:"
21430 #: ../fish/guestfish.pod:955
21433 " guestfish -N fs:vfat:32M -m /dev/sda1\n"
21438 #: ../fish/guestfish.pod:957
21439 msgid "Create a blank 200MB disk:"
21443 #: ../fish/guestfish.pod:959
21446 " guestfish -N disk:200M\n"
21451 #: ../fish/guestfish.pod:961
21452 msgid "PROGRESS BARS"
21456 #: ../fish/guestfish.pod:963
21458 "Some (not all) long-running commands send progress notification messages as "
21459 "they are running. Guestfish turns these messages into progress bars."
21463 #: ../fish/guestfish.pod:967
21465 "When a command that supports progress bars takes longer than two seconds to "
21466 "run, and if progress bars are enabled, then you will see one appearing below "
21471 #: ../fish/guestfish.pod:971
21474 " ><fs> copy-size /large-file /another-file 2048M\n"
21475 " / 10% [#####-----------------------------------------] 00:30\n"
21480 #: ../fish/guestfish.pod:974
21482 "The spinner on the left hand side moves round once for every progress "
21483 "notification received from the backend. This is a (reasonably) golden "
21484 "assurance that the command is \"doing something\" even if the progress bar "
21485 "is not moving, because the command is able to send the progress "
21486 "notifications. When the bar reaches 100% and the command finishes, the "
21487 "spinner disappears."
21491 #: ../fish/guestfish.pod:981
21493 "Progress bars are enabled by default when guestfish is used interactively. "
21494 "You can enable them even for non-interactive modes using I<--progress-bars>, "
21495 "and you can disable them completely using I<--no-progress-bars>."
21499 #: ../fish/guestfish.pod:986
21500 msgid "GUESTFISH COMMANDS"
21504 #: ../fish/guestfish.pod:988
21506 "The commands in this section are guestfish convenience commands, in other "
21507 "words, they are not part of the L<guestfs(3)> API."
21511 #: ../fish/guestfish.pod:991
21516 #: ../fish/guestfish.pod:993
21525 #: ../fish/guestfish.pod:996
21526 msgid "Without any parameter, this provides general help."
21530 #: ../fish/guestfish.pod:998
21531 msgid "With a C<cmd> parameter, this displays detailed help for that command."
21535 #: ../fish/guestfish.pod:1000
21536 msgid "quit | exit"
21540 #: ../fish/guestfish.pod:1002
21541 msgid "This exits guestfish. You can also use C<^D> key."
21545 #: ../fish/guestfish.pod:1004
21546 msgid "@FISH_COMMANDS@"
21550 #: ../fish/guestfish.pod:1006
21555 #: ../fish/guestfish.pod:1010 ../test-tool/libguestfs-test-tool.pod:77
21560 #: ../fish/guestfish.pod:1012
21562 "guestfish returns 0 if the commands completed without error, or 1 if there "
21567 #: ../fish/guestfish.pod:1019
21572 #: ../fish/guestfish.pod:1021
21574 "The C<edit> command uses C<$EDITOR> as the editor. If not set, it uses "
21579 #: ../fish/guestfish.pod:1024
21580 msgid "GUESTFISH_PID"
21584 #: ../fish/guestfish.pod:1026
21586 "Used with the I<--remote> option to specify the remote guestfish process to "
21587 "control. See section L</REMOTE CONTROL GUESTFISH OVER A SOCKET>."
21591 #: ../fish/guestfish.pod:1030
21596 #: ../fish/guestfish.pod:1032
21598 "The L</hexedit> command uses C<$HEXEDITOR> as the external hex editor. If "
21599 "not specified, the external L<hexedit(1)> program is used."
21603 #: ../fish/guestfish.pod:1036
21608 #: ../fish/guestfish.pod:1038
21610 "If compiled with GNU readline support, various files in the home directory "
21611 "can be used. See L</FILES>."
21615 #: ../fish/guestfish.pod:1047
21617 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
21618 "effect as using the B<-v> option."
21622 #: ../fish/guestfish.pod:1059
21624 "Set the path that guestfish uses to search for kernel and initrd.img. See "
21625 "the discussion of paths in L<guestfs(3)>."
21629 #: ../fish/guestfish.pod:1070
21630 msgid "Set C<LIBGUESTFS_TRACE=1> to enable command traces."
21634 #: ../fish/guestfish.pod:1072
21639 #: ../fish/guestfish.pod:1074
21641 "The C<more> command uses C<$PAGER> as the pager. If not set, it uses "
21646 #: ../fish/guestfish.pod:1090 ../fuse/guestmount.pod:252
21651 #: ../fish/guestfish.pod:1094 ../fuse/guestmount.pod:256
21652 msgid "$HOME/.libguestfs-tools.rc"
21656 #: ../fish/guestfish.pod:1096 ../fuse/guestmount.pod:258
21657 msgid "/etc/libguestfs-tools.conf"
21661 #: ../fish/guestfish.pod:1098 ../fuse/guestmount.pod:260
21663 "This configuration file controls the default read-only or read-write mode "
21664 "(I<--ro> or I<--rw>)."
21668 #: ../fish/guestfish.pod:1101
21669 msgid "See L</OPENING DISKS FOR READ AND WRITE>."
21673 #: ../fish/guestfish.pod:1103
21674 msgid "$HOME/.guestfish"
21678 #: ../fish/guestfish.pod:1105
21680 "If compiled with GNU readline support, then the command history is saved in "
21685 #: ../fish/guestfish.pod:1108
21686 msgid "$HOME/.inputrc"
21690 #: ../fish/guestfish.pod:1110
21691 msgid "/etc/inputrc"
21695 #: ../fish/guestfish.pod:1112
21697 "If compiled with GNU readline support, then these files can be used to "
21698 "configure readline. For further information, please see L<readline(3)/"
21699 "INITIALIZATION FILE>."
21703 #: ../fish/guestfish.pod:1116
21704 msgid "To write rules which only apply to guestfish, use:"
21708 #: ../fish/guestfish.pod:1118
21718 #: ../fish/guestfish.pod:1122
21720 "Variables that you can set in inputrc that change the behaviour of guestfish "
21721 "in useful ways include:"
21725 #: ../fish/guestfish.pod:1127
21726 msgid "completion-ignore-case (default: on)"
21730 #: ../fish/guestfish.pod:1129
21732 "By default, guestfish will ignore case when tab-completing paths on the "
21737 #: ../fish/guestfish.pod:1132
21740 " set completion-ignore-case off\n"
21745 #: ../fish/guestfish.pod:1134
21746 msgid "to make guestfish case sensitive."
21750 #: ../fish/guestfish.pod:1138
21755 #: ../fish/guestfish.pod:1140
21756 msgid "test2.img (etc)"
21760 #: ../fish/guestfish.pod:1142
21762 "When using the I<-N> or I<--new> option, the prepared disk or filesystem "
21763 "will be created in the file C<test1.img> in the current directory. The "
21764 "second use of I<-N> will use C<test2.img> and so on. Any existing file with "
21765 "the same name will be overwritten."
21769 #: ../fish/guestfish.pod:1151
21771 "L<guestfs(3)>, L<http://libguestfs.org/>, L<virt-cat(1)>, L<virt-copy-in(1)"
21772 ">, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, L<virt-filesystems(1)"
21773 ">, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, L<virt-list-partitions"
21774 "(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, L<virt-rescue(1)>, L<virt-resize(1)"
21775 ">, L<virt-tar(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<virt-win-reg(1)"
21776 ">, L<hexedit(1)>."
21780 #: ../fish/guestfish.pod:1181 ../test-tool/libguestfs-test-tool.pod:102
21781 #: ../fuse/guestmount.pod:287 ../tools/virt-edit.pl:518
21782 #: ../tools/virt-win-reg.pl:606 ../tools/virt-list-filesystems.pl:210
21783 #: ../tools/virt-tar.pl:309 ../tools/virt-make-fs.pl:572
21784 #: ../tools/virt-list-partitions.pl:277
21786 "This program is free software; you can redistribute it and/or modify it "
21787 "under the terms of the GNU General Public License as published by the Free "
21788 "Software Foundation; either version 2 of the License, or (at your option) "
21789 "any later version."
21793 #: ../fish/guestfish.pod:1186 ../test-tool/libguestfs-test-tool.pod:107
21794 #: ../fuse/guestmount.pod:292 ../tools/virt-edit.pl:523
21795 #: ../tools/virt-win-reg.pl:611 ../tools/virt-list-filesystems.pl:215
21796 #: ../tools/virt-tar.pl:314 ../tools/virt-make-fs.pl:577
21797 #: ../tools/virt-list-partitions.pl:282
21799 "This program is distributed in the hope that it will be useful, but WITHOUT "
21800 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
21801 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for "
21806 #: ../fish/guestfish.pod:1191 ../test-tool/libguestfs-test-tool.pod:112
21807 #: ../fuse/guestmount.pod:297 ../tools/virt-edit.pl:528
21808 #: ../tools/virt-win-reg.pl:616 ../tools/virt-list-filesystems.pl:220
21809 #: ../tools/virt-tar.pl:319 ../tools/virt-make-fs.pl:582
21810 #: ../tools/virt-list-partitions.pl:287
21812 "You should have received a copy of the GNU General Public License along with "
21813 "this program; if not, write to the Free Software Foundation, Inc., 675 Mass "
21814 "Ave, Cambridge, MA 02139, USA."
21818 #: ../fish/guestfish-actions.pod:1
21823 #: ../fish/guestfish-actions.pod:3
21826 " add-cdrom filename\n"
21831 #: ../fish/guestfish-actions.pod:15
21833 "This call checks for the existence of C<filename>. This stops you from "
21834 "specifying other types of drive which are supported by qemu such as C<nbd:> "
21835 "and C<http:> URLs. To specify those, use the general L</config> call "
21840 #: ../fish/guestfish-actions.pod:22
21842 "If you just want to add an ISO file (often you use this as an efficient way "
21843 "to transfer large files into the guest), then you should probably use L</add-"
21844 "drive-ro> instead."
21848 #: ../fish/guestfish-actions.pod:35
21853 #: ../fish/guestfish-actions.pod:37
21858 #: ../fish/guestfish-actions.pod:39
21861 " add-domain dom [libvirturi:..] [readonly:..] [iface:..] [live:..]\n"
21866 #: ../fish/guestfish-actions.pod:41
21868 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
21869 "It works by connecting to libvirt, requesting the domain and domain XML from "
21870 "libvirt, parsing it for disks, and calling L</add-drive-opts> on each one."
21874 #: ../fish/guestfish-actions.pod:71
21876 "The other optional parameters are passed directly through to L</add-drive-"
21881 #: ../fish/guestfish-actions.pod:74 ../fish/guestfish-actions.pod:138
21882 #: ../fish/guestfish-actions.pod:3047
21884 "This command has one or more optional arguments. See L</OPTIONAL ARGUMENTS>."
21888 #: ../fish/guestfish-actions.pod:76
21893 #: ../fish/guestfish-actions.pod:78
21896 " add-drive filename\n"
21901 #: ../fish/guestfish-actions.pod:80
21903 "This function is the equivalent of calling L</add-drive-opts> with no "
21904 "optional parameters, so the disk is added writable, with the format being "
21905 "detected automatically."
21909 #: ../fish/guestfish-actions.pod:84
21911 "Automatic detection of the format opens you up to a potential security hole "
21912 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
21913 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
21914 "you should think about replacing calls to this function with calls to L</add-"
21915 "drive-opts>, and specifying the format."
21919 #: ../fish/guestfish-actions.pod:91
21920 msgid "add-drive-opts"
21924 #: ../fish/guestfish-actions.pod:93
21929 #: ../fish/guestfish-actions.pod:95
21932 " add-drive-opts filename [readonly:..] [format:..] [iface:..]\n"
21937 #: ../fish/guestfish-actions.pod:122
21939 "This forces the image format. If you omit this (or use L</add-drive> or L</"
21940 "add-drive-ro>) then the format is automatically detected. Possible formats "
21941 "include C<raw> and C<qcow2>."
21945 #: ../fish/guestfish-actions.pod:133
21947 "This rarely-used option lets you emulate the behaviour of the deprecated L</"
21948 "add-drive-with-if> call (q.v.)"
21952 #: ../fish/guestfish-actions.pod:140
21953 msgid "add-drive-ro"
21957 #: ../fish/guestfish-actions.pod:142
21962 #: ../fish/guestfish-actions.pod:144
21965 " add-drive-ro filename\n"
21970 #: ../fish/guestfish-actions.pod:146
21972 "This function is the equivalent of calling L</add-drive-opts> with the "
21973 "optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the disk "
21974 "is added read-only, with the format being detected automatically."
21978 #: ../fish/guestfish-actions.pod:151
21979 msgid "add-drive-ro-with-if"
21983 #: ../fish/guestfish-actions.pod:153
21986 " add-drive-ro-with-if filename iface\n"
21991 #: ../fish/guestfish-actions.pod:155
21993 "This is the same as L</add-drive-ro> but it allows you to specify the QEMU "
21994 "interface emulation to use at run time."
21998 #: ../fish/guestfish-actions.pod:165
21999 msgid "add-drive-with-if"
22003 #: ../fish/guestfish-actions.pod:167
22006 " add-drive-with-if filename iface\n"
22011 #: ../fish/guestfish-actions.pod:169
22013 "This is the same as L</add-drive> but it allows you to specify the QEMU "
22014 "interface emulation to use at run time."
22018 #: ../fish/guestfish-actions.pod:179
22023 #: ../fish/guestfish-actions.pod:181
22026 " aug-clear augpath\n"
22031 #: ../fish/guestfish-actions.pod:186
22036 #: ../fish/guestfish-actions.pod:188
22044 #: ../fish/guestfish-actions.pod:190
22046 "Close the current Augeas handle and free up any resources used by it. After "
22047 "calling this, you have to call L</aug-init> again before you can use any "
22048 "other Augeas functions."
22052 #: ../fish/guestfish-actions.pod:195
22053 msgid "aug-defnode"
22057 #: ../fish/guestfish-actions.pod:197
22060 " aug-defnode name expr val\n"
22065 #: ../fish/guestfish-actions.pod:202
22067 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
22068 "calling L</aug-set> C<expr>, C<value>. C<name> will be the nodeset "
22069 "containing that single node."
22073 #: ../fish/guestfish-actions.pod:210
22078 #: ../fish/guestfish-actions.pod:212
22081 " aug-defvar name expr\n"
22086 #: ../fish/guestfish-actions.pod:221
22091 #: ../fish/guestfish-actions.pod:223
22094 " aug-get augpath\n"
22099 #: ../fish/guestfish-actions.pod:228
22104 #: ../fish/guestfish-actions.pod:230
22107 " aug-init root flags\n"
22112 #: ../fish/guestfish-actions.pod:236
22113 msgid "You must call this before using any other L</aug-*> commands."
22117 #: ../fish/guestfish-actions.pod:271
22118 msgid "Do not load the tree in L</aug-init>."
22122 #: ../fish/guestfish-actions.pod:275
22123 msgid "To close the handle, you can call L</aug-close>."
22127 #: ../fish/guestfish-actions.pod:279
22132 #: ../fish/guestfish-actions.pod:281
22135 " aug-insert augpath label true|false\n"
22140 #: ../fish/guestfish-actions.pod:291
22145 #: ../fish/guestfish-actions.pod:293
22153 #: ../fish/guestfish-actions.pod:300
22158 #: ../fish/guestfish-actions.pod:302
22161 " aug-ls augpath\n"
22166 #: ../fish/guestfish-actions.pod:304
22168 "This is just a shortcut for listing L</aug-match> C<path/*> and sorting the "
22169 "resulting nodes into alphabetical order."
22173 #: ../fish/guestfish-actions.pod:307
22178 #: ../fish/guestfish-actions.pod:309
22181 " aug-match augpath\n"
22186 #: ../fish/guestfish-actions.pod:315
22191 #: ../fish/guestfish-actions.pod:317
22194 " aug-mv src dest\n"
22199 #: ../fish/guestfish-actions.pod:322
22204 #: ../fish/guestfish-actions.pod:324
22207 " aug-rm augpath\n"
22212 #: ../fish/guestfish-actions.pod:330
22217 #: ../fish/guestfish-actions.pod:332
22225 #: ../fish/guestfish-actions.pod:336
22227 "The flags which were passed to L</aug-init> affect exactly how files are "
22232 #: ../fish/guestfish-actions.pod:339
22237 #: ../fish/guestfish-actions.pod:341
22240 " aug-set augpath val\n"
22245 #: ../fish/guestfish-actions.pod:345
22247 "In the Augeas API, it is possible to clear a node by setting the value to "
22248 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
22249 "this call. Instead you must use the L</aug-clear> call."
22253 #: ../fish/guestfish-actions.pod:350
22258 #: ../fish/guestfish-actions.pod:352
22261 " available 'groups ...'\n"
22266 #: ../fish/guestfish-actions.pod:358
22268 "The libguestfs groups, and the functions that those groups correspond to, "
22269 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
22270 "runtime by calling L</available-all-groups>."
22274 #: ../fish/guestfish-actions.pod:382
22275 msgid "You must call L</launch> before calling this function."
22279 #: ../fish/guestfish-actions.pod:404
22281 "This call was added in version C<1.0.80>. In previous versions of "
22282 "libguestfs all you could do would be to speculatively execute a command to "
22283 "find out if the daemon implemented it. See also L</version>."
22287 #: ../fish/guestfish-actions.pod:411
22288 msgid "available-all-groups"
22292 #: ../fish/guestfish-actions.pod:413
22295 " available-all-groups\n"
22300 #: ../fish/guestfish-actions.pod:415
22302 "This command returns a list of all optional groups that this daemon knows "
22303 "about. Note this returns both supported and unsupported groups. To find "
22304 "out which ones the daemon can actually support you have to call L</"
22305 "available> on each member of the returned list."
22309 #: ../fish/guestfish-actions.pod:421
22310 msgid "See also L</available> and L<guestfs(3)/AVAILABILITY>."
22314 #: ../fish/guestfish-actions.pod:423
22319 #: ../fish/guestfish-actions.pod:425
22322 " base64-in (base64file|-) filename\n"
22327 #: ../fish/guestfish-actions.pod:430 ../fish/guestfish-actions.pod:439
22328 #: ../fish/guestfish-actions.pod:663 ../fish/guestfish-actions.pod:832
22329 #: ../fish/guestfish-actions.pod:851 ../fish/guestfish-actions.pod:1228
22330 #: ../fish/guestfish-actions.pod:4445 ../fish/guestfish-actions.pod:4457
22331 #: ../fish/guestfish-actions.pod:4468 ../fish/guestfish-actions.pod:4479
22332 #: ../fish/guestfish-actions.pod:4531 ../fish/guestfish-actions.pod:4540
22333 #: ../fish/guestfish-actions.pod:4594 ../fish/guestfish-actions.pod:4617
22334 msgid "Use C<-> instead of a filename to read/write from stdin/stdout."
22338 #: ../fish/guestfish-actions.pod:432
22343 #: ../fish/guestfish-actions.pod:434
22346 " base64-out filename (base64file|-)\n"
22351 #: ../fish/guestfish-actions.pod:441
22352 msgid "blockdev-flushbufs"
22356 #: ../fish/guestfish-actions.pod:443
22359 " blockdev-flushbufs device\n"
22364 #: ../fish/guestfish-actions.pod:450
22365 msgid "blockdev-getbsz"
22369 #: ../fish/guestfish-actions.pod:452
22372 " blockdev-getbsz device\n"
22377 #: ../fish/guestfish-actions.pod:461
22378 msgid "blockdev-getro"
22382 #: ../fish/guestfish-actions.pod:463
22385 " blockdev-getro device\n"
22390 #: ../fish/guestfish-actions.pod:470
22391 msgid "blockdev-getsize64"
22395 #: ../fish/guestfish-actions.pod:472
22398 " blockdev-getsize64 device\n"
22403 #: ../fish/guestfish-actions.pod:476
22404 msgid "See also L</blockdev-getsz>."
22408 #: ../fish/guestfish-actions.pod:480
22409 msgid "blockdev-getss"
22413 #: ../fish/guestfish-actions.pod:482
22416 " blockdev-getss device\n"
22421 #: ../fish/guestfish-actions.pod:487
22423 "(Note, this is not the size in sectors, use L</blockdev-getsz> for that)."
22427 #: ../fish/guestfish-actions.pod:492
22428 msgid "blockdev-getsz"
22432 #: ../fish/guestfish-actions.pod:494
22435 " blockdev-getsz device\n"
22440 #: ../fish/guestfish-actions.pod:499
22442 "See also L</blockdev-getss> for the real sector size of the device, and L</"
22443 "blockdev-getsize64> for the more useful I<size in bytes>."
22447 #: ../fish/guestfish-actions.pod:505
22448 msgid "blockdev-rereadpt"
22452 #: ../fish/guestfish-actions.pod:507
22455 " blockdev-rereadpt device\n"
22460 #: ../fish/guestfish-actions.pod:513
22461 msgid "blockdev-setbsz"
22465 #: ../fish/guestfish-actions.pod:515
22468 " blockdev-setbsz device blocksize\n"
22473 #: ../fish/guestfish-actions.pod:524
22474 msgid "blockdev-setro"
22478 #: ../fish/guestfish-actions.pod:526
22481 " blockdev-setro device\n"
22486 #: ../fish/guestfish-actions.pod:532
22487 msgid "blockdev-setrw"
22491 #: ../fish/guestfish-actions.pod:534
22494 " blockdev-setrw device\n"
22499 #: ../fish/guestfish-actions.pod:540
22500 msgid "case-sensitive-path"
22504 #: ../fish/guestfish-actions.pod:542
22507 " case-sensitive-path path\n"
22512 #: ../fish/guestfish-actions.pod:566
22514 "Thus L</case-sensitive-path> (\"/Windows/System32\") might return C<\"/"
22515 "WINDOWS/system32\"> (the exact return value would depend on details of how "
22516 "the directories were originally created under Windows)."
22520 #: ../fish/guestfish-actions.pod:574
22521 msgid "See also L</realpath>."
22525 #: ../fish/guestfish-actions.pod:576
22530 #: ../fish/guestfish-actions.pod:578
22538 #: ../fish/guestfish-actions.pod:582
22540 "Note that this function cannot correctly handle binary files (specifically, "
22541 "files containing C<\\0> character which is treated as end of string). For "
22542 "those you need to use the L</read-file> or L</download> functions which have "
22543 "a more complex interface."
22547 #: ../fish/guestfish-actions.pod:590
22552 #: ../fish/guestfish-actions.pod:592
22555 " checksum csumtype path\n"
22560 #: ../fish/guestfish-actions.pod:635
22561 msgid "To get the checksum for a device, use L</checksum-device>."
22565 #: ../fish/guestfish-actions.pod:637
22566 msgid "To get the checksums for many files, use L</checksums-out>."
22570 #: ../fish/guestfish-actions.pod:639
22571 msgid "checksum-device"
22575 #: ../fish/guestfish-actions.pod:641
22578 " checksum-device csumtype device\n"
22583 #: ../fish/guestfish-actions.pod:643
22585 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
22586 "device named C<device>. For the types of checksums supported see the L</"
22587 "checksum> command."
22591 #: ../fish/guestfish-actions.pod:647
22592 msgid "checksums-out"
22596 #: ../fish/guestfish-actions.pod:649
22599 " checksums-out csumtype directory (sumsfile|-)\n"
22604 #: ../fish/guestfish-actions.pod:665
22609 #: ../fish/guestfish-actions.pod:667
22612 " chmod mode path\n"
22617 #: ../fish/guestfish-actions.pod:678
22622 #: ../fish/guestfish-actions.pod:680
22625 " chown owner group path\n"
22630 #: ../fish/guestfish-actions.pod:688
22635 #: ../fish/guestfish-actions.pod:690
22638 " command 'arguments ...'\n"
22643 #: ../fish/guestfish-actions.pod:697
22645 "The single parameter is an argv-style list of arguments. The first element "
22646 "is the name of the program to run. Subsequent elements are parameters. The "
22647 "list must be non-empty (ie. must contain a program name). Note that the "
22648 "command runs directly, and is I<not> invoked via the shell (see L</sh>)."
22652 #: ../fish/guestfish-actions.pod:725
22653 msgid "command-lines"
22657 #: ../fish/guestfish-actions.pod:727
22660 " command-lines 'arguments ...'\n"
22665 #: ../fish/guestfish-actions.pod:729
22667 "This is the same as L</command>, but splits the result into a list of lines."
22671 #: ../fish/guestfish-actions.pod:732
22672 msgid "See also: L</sh-lines>"
22676 #: ../fish/guestfish-actions.pod:737
22681 #: ../fish/guestfish-actions.pod:739
22684 " config qemuparam qemuvalue\n"
22689 #: ../fish/guestfish-actions.pod:750
22694 #: ../fish/guestfish-actions.pod:752
22697 " copy-size src dest size\n"
22702 #: ../fish/guestfish-actions.pod:760
22707 #: ../fish/guestfish-actions.pod:762
22715 #: ../fish/guestfish-actions.pod:767
22720 #: ../fish/guestfish-actions.pod:769
22728 #: ../fish/guestfish-actions.pod:774
22733 #: ../fish/guestfish-actions.pod:776
22741 #: ../fish/guestfish-actions.pod:783
22743 "If the destination is a device, it must be as large or larger than the "
22744 "source file or device, otherwise the copy will fail. This command cannot do "
22745 "partial copies (see L</copy-size>)."
22749 #: ../fish/guestfish-actions.pod:787
22754 #: ../fish/guestfish-actions.pod:789
22762 #: ../fish/guestfish-actions.pod:793 ../fish/guestfish-actions.pod:804
22764 "This command is mostly useful for interactive sessions. It is I<not> "
22765 "intended that you try to parse the output string. Use L</statvfs> from "
22770 #: ../fish/guestfish-actions.pod:797
22775 #: ../fish/guestfish-actions.pod:799
22783 #: ../fish/guestfish-actions.pod:808
22788 #: ../fish/guestfish-actions.pod:810
22796 #: ../fish/guestfish-actions.pod:816
22798 "Another way to get the same information is to enable verbose messages with "
22799 "L</set-verbose> or by setting the environment variable C<LIBGUESTFS_DEBUG=1> "
22800 "before running the program."
22804 #: ../fish/guestfish-actions.pod:821
22809 #: ../fish/guestfish-actions.pod:823
22812 " download remotefilename (filename|-)\n"
22817 #: ../fish/guestfish-actions.pod:830
22818 msgid "See also L</upload>, L</cat>."
22822 #: ../fish/guestfish-actions.pod:834
22823 msgid "download-offset"
22827 #: ../fish/guestfish-actions.pod:836
22830 " download-offset remotefilename (filename|-) offset size\n"
22835 #: ../fish/guestfish-actions.pod:844
22837 "Note that there is no limit on the amount of data that can be downloaded "
22838 "with this call, unlike with L</pread>, and this call always reads the full "
22839 "amount unless an error occurs."
22843 #: ../fish/guestfish-actions.pod:849
22844 msgid "See also L</download>, L</pread>."
22848 #: ../fish/guestfish-actions.pod:853
22849 msgid "drop-caches"
22853 #: ../fish/guestfish-actions.pod:855
22856 " drop-caches whattodrop\n"
22861 #: ../fish/guestfish-actions.pod:867
22866 #: ../fish/guestfish-actions.pod:869
22874 #: ../fish/guestfish-actions.pod:881
22879 #: ../fish/guestfish-actions.pod:883
22882 " e2fsck-f device\n"
22887 #: ../fish/guestfish-actions.pod:889
22889 "This command is only needed because of L</resize2fs> (q.v.). Normally you "
22890 "should use L</fsck>."
22894 #: ../fish/guestfish-actions.pod:892
22895 msgid "echo-daemon"
22899 #: ../fish/guestfish-actions.pod:894
22902 " echo-daemon 'words ...'\n"
22907 #: ../fish/guestfish-actions.pod:901
22908 msgid "See also L</ping-daemon>."
22912 #: ../fish/guestfish-actions.pod:903
22917 #: ../fish/guestfish-actions.pod:905
22920 " egrep regex path\n"
22925 #: ../fish/guestfish-actions.pod:913
22930 #: ../fish/guestfish-actions.pod:915
22933 " egrepi regex path\n"
22938 #: ../fish/guestfish-actions.pod:923
22943 #: ../fish/guestfish-actions.pod:925
22946 " equal file1 file2\n"
22951 #: ../fish/guestfish-actions.pod:932
22956 #: ../fish/guestfish-actions.pod:934
22964 #: ../fish/guestfish-actions.pod:939
22965 msgid "See also L</is-file>, L</is-dir>, L</stat>."
22969 #: ../fish/guestfish-actions.pod:941
22974 #: ../fish/guestfish-actions.pod:943
22977 " fallocate path len\n"
22982 #: ../fish/guestfish-actions.pod:960
22983 msgid "fallocate64"
22987 #: ../fish/guestfish-actions.pod:962
22990 " fallocate64 path len\n"
22995 #: ../fish/guestfish-actions.pod:968
22997 "Note that this call allocates disk blocks for the file. To create a sparse "
22998 "file use L</truncate-size> instead."
23002 #: ../fish/guestfish-actions.pod:971
23004 "The deprecated call L</fallocate> does the same, but owing to an oversight "
23005 "it only allowed 30 bit lengths to be specified, effectively limiting the "
23006 "maximum size of files created through that call to 1GB."
23010 #: ../fish/guestfish-actions.pod:980
23015 #: ../fish/guestfish-actions.pod:982
23018 " fgrep pattern path\n"
23023 #: ../fish/guestfish-actions.pod:990
23028 #: ../fish/guestfish-actions.pod:992
23031 " fgrepi pattern path\n"
23036 #: ../fish/guestfish-actions.pod:1000
23041 #: ../fish/guestfish-actions.pod:1002
23049 #: ../fish/guestfish-actions.pod:1014
23051 "This command can also be used on C</dev/> devices (and partitions, LV "
23052 "names). You can for example use this to determine if a device contains a "
23053 "filesystem, although it's usually better to use L</vfs-type>."
23057 #: ../fish/guestfish-actions.pod:1024
23058 msgid "file-architecture"
23062 #: ../fish/guestfish-actions.pod:1026
23065 " file-architecture filename\n"
23070 #: ../fish/guestfish-actions.pod:1129
23075 #: ../fish/guestfish-actions.pod:1131
23083 #: ../fish/guestfish-actions.pod:1135
23085 "To get other stats about a file, use L</stat>, L</lstat>, L</is-dir>, L</is-"
23086 "file> etc. To get the size of block devices, use L</blockdev-getsize64>."
23090 #: ../fish/guestfish-actions.pod:1139
23095 #: ../fish/guestfish-actions.pod:1141
23098 " fill c len path\n"
23103 #: ../fish/guestfish-actions.pod:1147
23105 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
23106 "L</truncate-size>. To create a file with a pattern of repeating bytes use "
23107 "L</fill-pattern>."
23111 #: ../fish/guestfish-actions.pod:1152
23112 msgid "fill-pattern"
23116 #: ../fish/guestfish-actions.pod:1154
23119 " fill-pattern pattern len path\n"
23124 #: ../fish/guestfish-actions.pod:1156
23126 "This function is like L</fill> except that it creates a new file of length "
23127 "C<len> containing the repeating pattern of bytes in C<pattern>. The pattern "
23128 "is truncated if necessary to ensure the length of the file is exactly C<len> "
23133 #: ../fish/guestfish-actions.pod:1161
23138 #: ../fish/guestfish-actions.pod:1163
23141 " find directory\n"
23146 #: ../fish/guestfish-actions.pod:1177
23147 msgid "then the returned list from L</find> C</tmp> would be 4 elements:"
23151 #: ../fish/guestfish-actions.pod:1190
23152 msgid "See also L</find0>."
23156 #: ../fish/guestfish-actions.pod:1195
23161 #: ../fish/guestfish-actions.pod:1197
23164 " find0 directory (files|-)\n"
23169 #: ../fish/guestfish-actions.pod:1203
23171 "This command works the same way as L</find> with the following exceptions:"
23175 #: ../fish/guestfish-actions.pod:1230
23176 msgid "findfs-label"
23180 #: ../fish/guestfish-actions.pod:1232
23183 " findfs-label label\n"
23188 #: ../fish/guestfish-actions.pod:1238
23189 msgid "To find the label of a filesystem, use L</vfs-label>."
23193 #: ../fish/guestfish-actions.pod:1240
23194 msgid "findfs-uuid"
23198 #: ../fish/guestfish-actions.pod:1242
23201 " findfs-uuid uuid\n"
23206 #: ../fish/guestfish-actions.pod:1248
23207 msgid "To find the UUID of a filesystem, use L</vfs-uuid>."
23211 #: ../fish/guestfish-actions.pod:1250
23216 #: ../fish/guestfish-actions.pod:1252
23219 " fsck fstype device\n"
23224 #: ../fish/guestfish-actions.pod:1282
23229 #: ../fish/guestfish-actions.pod:1284
23237 #: ../fish/guestfish-actions.pod:1291
23238 msgid "get-attach-method"
23242 #: ../fish/guestfish-actions.pod:1293
23245 " get-attach-method\n"
23250 #: ../fish/guestfish-actions.pod:1295
23251 msgid "Return the current attach method. See L</set-attach-method>."
23255 #: ../fish/guestfish-actions.pod:1297
23256 msgid "get-autosync"
23260 #: ../fish/guestfish-actions.pod:1299
23268 #: ../fish/guestfish-actions.pod:1303
23273 #: ../fish/guestfish-actions.pod:1305
23281 #: ../fish/guestfish-actions.pod:1309
23282 msgid "get-e2label"
23286 #: ../fish/guestfish-actions.pod:1311
23289 " get-e2label device\n"
23294 #: ../fish/guestfish-actions.pod:1323
23299 #: ../fish/guestfish-actions.pod:1325
23302 " get-e2uuid device\n"
23307 #: ../fish/guestfish-actions.pod:1337
23308 msgid "get-memsize"
23312 #: ../fish/guestfish-actions.pod:1339
23320 #: ../fish/guestfish-actions.pod:1344
23322 "If L</set-memsize> was not called on this handle, and if "
23323 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
23324 "value for memsize."
23328 #: ../fish/guestfish-actions.pod:1351
23329 msgid "get-network"
23333 #: ../fish/guestfish-actions.pod:1353
23341 #: ../fish/guestfish-actions.pod:1357
23346 #: ../fish/guestfish-actions.pod:1359
23354 #: ../fish/guestfish-actions.pod:1366
23359 #: ../fish/guestfish-actions.pod:1368
23364 #: ../fish/guestfish-actions.pod:1370
23372 #: ../fish/guestfish-actions.pod:1377
23377 #: ../fish/guestfish-actions.pod:1379
23385 #: ../fish/guestfish-actions.pod:1386
23386 msgid "get-recovery-proc"
23390 #: ../fish/guestfish-actions.pod:1388
23393 " get-recovery-proc\n"
23398 #: ../fish/guestfish-actions.pod:1392
23399 msgid "get-selinux"
23403 #: ../fish/guestfish-actions.pod:1394
23411 #: ../fish/guestfish-actions.pod:1396
23413 "This returns the current setting of the selinux flag which is passed to the "
23414 "appliance at boot time. See L</set-selinux>."
23418 #: ../fish/guestfish-actions.pod:1402
23423 #: ../fish/guestfish-actions.pod:1404
23431 #: ../fish/guestfish-actions.pod:1411
23436 #: ../fish/guestfish-actions.pod:1413
23444 #: ../fish/guestfish-actions.pod:1417
23449 #: ../fish/guestfish-actions.pod:1419
23457 #: ../fish/guestfish-actions.pod:1421
23459 "Return the current umask. By default the umask is C<022> unless it has been "
23460 "set by calling L</umask>."
23464 #: ../fish/guestfish-actions.pod:1424
23465 msgid "get-verbose"
23469 #: ../fish/guestfish-actions.pod:1426
23477 #: ../fish/guestfish-actions.pod:1430
23482 #: ../fish/guestfish-actions.pod:1432
23490 #: ../fish/guestfish-actions.pod:1436
23491 msgid "See the documentation about SELINUX in L<guestfs(3)>, and L</setcon>"
23495 #: ../fish/guestfish-actions.pod:1439
23500 #: ../fish/guestfish-actions.pod:1441
23503 " getxattr path name\n"
23508 #: ../fish/guestfish-actions.pod:1443
23510 "Get a single extended attribute from file C<path> named C<name>. This call "
23511 "follows symlinks. If you want to lookup an extended attribute for the "
23512 "symlink itself, use L</lgetxattr>."
23516 #: ../fish/guestfish-actions.pod:1447 ../fish/guestfish-actions.pod:2453
23518 "Normally it is better to get all extended attributes from a file in one go "
23519 "by calling L</getxattrs>. However some Linux filesystem implementations are "
23520 "buggy and do not provide a way to list out attributes. For these "
23521 "filesystems (notably ntfs-3g) you have to know the names of the extended "
23522 "attributes you want in advance and call this function."
23526 #: ../fish/guestfish-actions.pod:1457
23527 msgid "See also: L</getxattrs>, L</lgetxattr>, L<attr(5)>."
23531 #: ../fish/guestfish-actions.pod:1459
23536 #: ../fish/guestfish-actions.pod:1461
23539 " getxattrs path\n"
23544 #: ../fish/guestfish-actions.pod:1469
23545 msgid "See also: L</lgetxattrs>, L<attr(5)>."
23549 #: ../fish/guestfish-actions.pod:1471
23550 msgid "glob-expand"
23554 #: ../fish/guestfish-actions.pod:1473
23557 " glob-expand pattern\n"
23562 #: ../fish/guestfish-actions.pod:1486
23567 #: ../fish/guestfish-actions.pod:1488
23570 " grep regex path\n"
23575 #: ../fish/guestfish-actions.pod:1496
23580 #: ../fish/guestfish-actions.pod:1498
23583 " grepi regex path\n"
23588 #: ../fish/guestfish-actions.pod:1506
23589 msgid "grub-install"
23593 #: ../fish/guestfish-actions.pod:1508
23596 " grub-install root device\n"
23601 #: ../fish/guestfish-actions.pod:1524
23606 #: ../fish/guestfish-actions.pod:1526
23614 #: ../fish/guestfish-actions.pod:1534
23619 #: ../fish/guestfish-actions.pod:1536
23622 " head-n nrlines path\n"
23627 #: ../fish/guestfish-actions.pod:1549
23632 #: ../fish/guestfish-actions.pod:1551
23640 #: ../fish/guestfish-actions.pod:1559
23645 #: ../fish/guestfish-actions.pod:1561
23648 " initrd-cat initrdpath filename\n"
23653 #: ../fish/guestfish-actions.pod:1573
23654 msgid "See also L</initrd-list>."
23658 #: ../fish/guestfish-actions.pod:1578
23659 msgid "initrd-list"
23663 #: ../fish/guestfish-actions.pod:1580
23666 " initrd-list path\n"
23671 #: ../fish/guestfish-actions.pod:1592
23672 msgid "inotify-add-watch"
23676 #: ../fish/guestfish-actions.pod:1594
23679 " inotify-add-watch path mask\n"
23684 #: ../fish/guestfish-actions.pod:1606
23685 msgid "inotify-close"
23689 #: ../fish/guestfish-actions.pod:1608
23697 #: ../fish/guestfish-actions.pod:1614
23698 msgid "inotify-files"
23702 #: ../fish/guestfish-actions.pod:1616
23710 #: ../fish/guestfish-actions.pod:1618
23712 "This function is a helpful wrapper around L</inotify-read> which just "
23713 "returns a list of pathnames of objects that were touched. The returned "
23714 "pathnames are sorted and deduplicated."
23718 #: ../fish/guestfish-actions.pod:1622
23719 msgid "inotify-init"
23723 #: ../fish/guestfish-actions.pod:1624
23726 " inotify-init maxevents\n"
23731 #: ../fish/guestfish-actions.pod:1630
23733 "C<maxevents> is the maximum number of events which will be queued up between "
23734 "calls to L</inotify-read> or L</inotify-files>. If this is passed as C<0>, "
23735 "then the kernel (or previously set) default is used. For Linux 2.6.29 the "
23736 "default was 16384 events. Beyond this limit, the kernel throws away events, "
23737 "but records the fact that it threw them away by setting a flag "
23738 "C<IN_Q_OVERFLOW> in the returned structure list (see L</inotify-read>)."
23742 #: ../fish/guestfish-actions.pod:1640
23744 "Before any events are generated, you have to add some watches to the "
23745 "internal watch list. See: L</inotify-add-watch>, L</inotify-rm-watch> and "
23746 "L</inotify-watch-all>."
23750 #: ../fish/guestfish-actions.pod:1646
23752 "Queued up events should be read periodically by calling L</inotify-read> (or "
23753 "L</inotify-files> which is just a helpful wrapper around L</inotify-read>). "
23754 "If you don't read the events out often enough then you risk the internal "
23755 "queue overflowing."
23759 #: ../fish/guestfish-actions.pod:1653
23761 "The handle should be closed after use by calling L</inotify-close>. This "
23762 "also removes any watches automatically."
23766 #: ../fish/guestfish-actions.pod:1662
23767 msgid "inotify-read"
23771 #: ../fish/guestfish-actions.pod:1664
23779 #: ../fish/guestfish-actions.pod:1677
23780 msgid "inotify-rm-watch"
23784 #: ../fish/guestfish-actions.pod:1679
23787 " inotify-rm-watch wd\n"
23792 #: ../fish/guestfish-actions.pod:1681
23793 msgid "Remove a previously defined inotify watch. See L</inotify-add-watch>."
23797 #: ../fish/guestfish-actions.pod:1684
23798 msgid "inspect-get-arch"
23802 #: ../fish/guestfish-actions.pod:1686
23805 " inspect-get-arch root\n"
23810 #: ../fish/guestfish-actions.pod:1688 ../fish/guestfish-actions.pod:1704
23811 #: ../fish/guestfish-actions.pod:1790 ../fish/guestfish-actions.pod:1826
23812 #: ../fish/guestfish-actions.pod:1844 ../fish/guestfish-actions.pod:1878
23813 #: ../fish/guestfish-actions.pod:1893 ../fish/guestfish-actions.pod:1914
23814 #: ../fish/guestfish-actions.pod:1929 ../fish/guestfish-actions.pod:1962
23815 #: ../fish/guestfish-actions.pod:1984 ../fish/guestfish-actions.pod:2008
23816 #: ../fish/guestfish-actions.pod:2025 ../fish/guestfish-actions.pod:2068
23817 #: ../fish/guestfish-actions.pod:2103 ../fish/guestfish-actions.pod:2119
23818 #: ../fish/guestfish-actions.pod:2135 ../fish/guestfish-actions.pod:2148
23819 #: ../fish/guestfish-actions.pod:2161 ../fish/guestfish-actions.pod:2176
23821 "This function should only be called with a root device string as returned by "
23826 #: ../fish/guestfish-actions.pod:1691
23828 "This returns the architecture of the inspected operating system. The "
23829 "possible return values are listed under L</file-architecture>."
23833 #: ../fish/guestfish-actions.pod:1700
23834 msgid "inspect-get-distro"
23838 #: ../fish/guestfish-actions.pod:1702
23841 " inspect-get-distro root\n"
23846 #: ../fish/guestfish-actions.pod:1786
23847 msgid "inspect-get-drive-mappings"
23851 #: ../fish/guestfish-actions.pod:1788
23854 " inspect-get-drive-mappings root\n"
23859 #: ../fish/guestfish-actions.pod:1818
23861 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
23862 "get-mountpoints>, L</inspect-get-filesystems>."
23866 #: ../fish/guestfish-actions.pod:1822
23867 msgid "inspect-get-filesystems"
23871 #: ../fish/guestfish-actions.pod:1824
23874 " inspect-get-filesystems root\n"
23879 #: ../fish/guestfish-actions.pod:1837
23881 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
23882 "get-mountpoints>."
23886 #: ../fish/guestfish-actions.pod:1840
23887 msgid "inspect-get-format"
23891 #: ../fish/guestfish-actions.pod:1842
23894 " inspect-get-format root\n"
23899 #: ../fish/guestfish-actions.pod:1874
23900 msgid "inspect-get-hostname"
23904 #: ../fish/guestfish-actions.pod:1876
23907 " inspect-get-hostname root\n"
23912 #: ../fish/guestfish-actions.pod:1889
23913 msgid "inspect-get-major-version"
23917 #: ../fish/guestfish-actions.pod:1891
23920 " inspect-get-major-version root\n"
23925 #: ../fish/guestfish-actions.pod:1910
23926 msgid "inspect-get-minor-version"
23930 #: ../fish/guestfish-actions.pod:1912
23933 " inspect-get-minor-version root\n"
23938 #: ../fish/guestfish-actions.pod:1922
23940 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
23941 "get-major-version>."
23945 #: ../fish/guestfish-actions.pod:1925
23946 msgid "inspect-get-mountpoints"
23950 #: ../fish/guestfish-actions.pod:1927
23953 " inspect-get-mountpoints root\n"
23958 #: ../fish/guestfish-actions.pod:1949
23960 "For operating systems like Windows which still use drive letters, this call "
23961 "will only return an entry for the first drive \"mounted on\" C</>. For "
23962 "information about the mapping of drive letters to partitions, see L</inspect-"
23963 "get-drive-mappings>."
23967 #: ../fish/guestfish-actions.pod:1955
23969 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
23970 "get-filesystems>."
23974 #: ../fish/guestfish-actions.pod:1958
23975 msgid "inspect-get-package-format"
23979 #: ../fish/guestfish-actions.pod:1960
23982 " inspect-get-package-format root\n"
23987 #: ../fish/guestfish-actions.pod:1965
23989 "This function and L</inspect-get-package-management> return the package "
23990 "format and package management tool used by the inspected operating system. "
23991 "For example for Fedora these functions would return C<rpm> (package format) "
23992 "and C<yum> (package management)."
23996 #: ../fish/guestfish-actions.pod:1980
23997 msgid "inspect-get-package-management"
24001 #: ../fish/guestfish-actions.pod:1982
24004 " inspect-get-package-management root\n"
24009 #: ../fish/guestfish-actions.pod:1987
24011 "L</inspect-get-package-format> and this function return the package format "
24012 "and package management tool used by the inspected operating system. For "
24013 "example for Fedora these functions would return C<rpm> (package format) and "
24014 "C<yum> (package management)."
24018 #: ../fish/guestfish-actions.pod:2004
24019 msgid "inspect-get-product-name"
24023 #: ../fish/guestfish-actions.pod:2006
24026 " inspect-get-product-name root\n"
24031 #: ../fish/guestfish-actions.pod:2021
24032 msgid "inspect-get-product-variant"
24036 #: ../fish/guestfish-actions.pod:2023
24039 " inspect-get-product-variant root\n"
24044 #: ../fish/guestfish-actions.pod:2047
24046 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
24047 "get-product-name>, L</inspect-get-major-version>."
24051 #: ../fish/guestfish-actions.pod:2051
24052 msgid "inspect-get-roots"
24056 #: ../fish/guestfish-actions.pod:2053
24059 " inspect-get-roots\n"
24064 #: ../fish/guestfish-actions.pod:2055
24066 "This function is a convenient way to get the list of root devices, as "
24067 "returned from a previous call to L</inspect-os>, but without redoing the "
24068 "whole inspection process."
24072 #: ../fish/guestfish-actions.pod:2059
24074 "This returns an empty list if either no root devices were found or the "
24075 "caller has not called L</inspect-os>."
24079 #: ../fish/guestfish-actions.pod:2064
24080 msgid "inspect-get-type"
24084 #: ../fish/guestfish-actions.pod:2066
24087 " inspect-get-type root\n"
24092 #: ../fish/guestfish-actions.pod:2099
24093 msgid "inspect-get-windows-current-control-set"
24097 #: ../fish/guestfish-actions.pod:2101
24100 " inspect-get-windows-current-control-set root\n"
24105 #: ../fish/guestfish-actions.pod:2115
24106 msgid "inspect-get-windows-systemroot"
24110 #: ../fish/guestfish-actions.pod:2117
24113 " inspect-get-windows-systemroot root\n"
24118 #: ../fish/guestfish-actions.pod:2131
24119 msgid "inspect-is-live"
24123 #: ../fish/guestfish-actions.pod:2133
24126 " inspect-is-live root\n"
24131 #: ../fish/guestfish-actions.pod:2138
24133 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
24134 "then this returns true if a live image was detected on the disk."
24138 #: ../fish/guestfish-actions.pod:2144
24139 msgid "inspect-is-multipart"
24143 #: ../fish/guestfish-actions.pod:2146
24146 " inspect-is-multipart root\n"
24151 #: ../fish/guestfish-actions.pod:2151
24153 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
24154 "then this returns true if the disk is part of a set."
24158 #: ../fish/guestfish-actions.pod:2157
24159 msgid "inspect-is-netinst"
24163 #: ../fish/guestfish-actions.pod:2159
24166 " inspect-is-netinst root\n"
24171 #: ../fish/guestfish-actions.pod:2164
24173 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
24174 "then this returns true if the disk is a network installer, ie. not a self-"
24175 "contained install CD but one which is likely to require network access to "
24176 "complete the install."
24180 #: ../fish/guestfish-actions.pod:2172
24181 msgid "inspect-list-applications"
24185 #: ../fish/guestfish-actions.pod:2174
24188 " inspect-list-applications root\n"
24193 #: ../fish/guestfish-actions.pod:2181
24195 "I<Note:> This call works differently from other parts of the inspection "
24196 "API. You have to call L</inspect-os>, then L</inspect-get-mountpoints>, "
24197 "then mount up the disks, before calling this. Listing applications is a "
24198 "significantly more difficult operation which requires access to the full "
24199 "filesystem. Also note that unlike the other L</inspect-get-*> calls which "
24200 "are just returning data cached in the libguestfs handle, this call actually "
24201 "reads parts of the mounted filesystems during the call."
24205 #: ../fish/guestfish-actions.pod:2271
24210 #: ../fish/guestfish-actions.pod:2273
24218 #: ../fish/guestfish-actions.pod:2288
24220 "You can pass the root string(s) returned to other L</inspect-get-*> "
24221 "functions in order to query further information about each operating system, "
24222 "such as the name and version."
24226 #: ../fish/guestfish-actions.pod:2293
24228 "This function uses other libguestfs features such as L</mount-ro> and L</"
24229 "umount-all> in order to mount and unmount filesystems and look at the "
24230 "contents. This should be called with no disks currently mounted. The "
24231 "function may also use Augeas, so any existing Augeas handle will be closed."
24235 #: ../fish/guestfish-actions.pod:2305 ../fish/guestfish-actions.pod:2481
24236 #: ../fish/guestfish-actions.pod:2527
24237 msgid "See also L</list-filesystems>."
24241 #: ../fish/guestfish-actions.pod:2307
24242 msgid "is-blockdev"
24246 #: ../fish/guestfish-actions.pod:2309
24249 " is-blockdev path\n"
24254 #: ../fish/guestfish-actions.pod:2314 ../fish/guestfish-actions.pod:2332
24255 #: ../fish/guestfish-actions.pod:2351 ../fish/guestfish-actions.pod:2360
24256 #: ../fish/guestfish-actions.pod:2370 ../fish/guestfish-actions.pod:2404
24257 #: ../fish/guestfish-actions.pod:2413
24258 msgid "See also L</stat>."
24262 #: ../fish/guestfish-actions.pod:2316
24267 #: ../fish/guestfish-actions.pod:2318
24275 #: ../fish/guestfish-actions.pod:2325
24280 #: ../fish/guestfish-actions.pod:2327
24283 " is-chardev path\n"
24288 #: ../fish/guestfish-actions.pod:2334
24293 #: ../fish/guestfish-actions.pod:2336
24301 #: ../fish/guestfish-actions.pod:2343
24306 #: ../fish/guestfish-actions.pod:2345
24314 #: ../fish/guestfish-actions.pod:2353
24319 #: ../fish/guestfish-actions.pod:2355
24327 #: ../fish/guestfish-actions.pod:2362
24332 #: ../fish/guestfish-actions.pod:2364
24340 #: ../fish/guestfish-actions.pod:2372
24341 msgid "is-launching"
24345 #: ../fish/guestfish-actions.pod:2374
24353 #: ../fish/guestfish-actions.pod:2381
24358 #: ../fish/guestfish-actions.pod:2383
24366 #: ../fish/guestfish-actions.pod:2388
24371 #: ../fish/guestfish-actions.pod:2390
24379 #: ../fish/guestfish-actions.pod:2397
24384 #: ../fish/guestfish-actions.pod:2399
24387 " is-socket path\n"
24392 #: ../fish/guestfish-actions.pod:2406
24397 #: ../fish/guestfish-actions.pod:2408
24400 " is-symlink path\n"
24405 #: ../fish/guestfish-actions.pod:2415
24406 msgid "kill-subprocess"
24410 #: ../fish/guestfish-actions.pod:2417
24413 " kill-subprocess\n"
24418 #: ../fish/guestfish-actions.pod:2421
24423 #: ../fish/guestfish-actions.pod:2423
24428 #: ../fish/guestfish-actions.pod:2425
24436 #: ../fish/guestfish-actions.pod:2433
24441 #: ../fish/guestfish-actions.pod:2435
24444 " lchown owner group path\n"
24449 #: ../fish/guestfish-actions.pod:2437
24451 "Change the file owner to C<owner> and group to C<group>. This is like L</"
24452 "chown> but if C<path> is a symlink then the link itself is changed, not the "
24457 #: ../fish/guestfish-actions.pod:2445
24462 #: ../fish/guestfish-actions.pod:2447
24465 " lgetxattr path name\n"
24470 #: ../fish/guestfish-actions.pod:2463
24471 msgid "See also: L</lgetxattrs>, L</getxattr>, L<attr(5)>."
24475 #: ../fish/guestfish-actions.pod:2465
24480 #: ../fish/guestfish-actions.pod:2467
24483 " lgetxattrs path\n"
24488 #: ../fish/guestfish-actions.pod:2469
24490 "This is the same as L</getxattrs>, but if C<path> is a symbolic link, then "
24491 "it returns the extended attributes of the link itself."
24495 #: ../fish/guestfish-actions.pod:2473
24496 msgid "list-devices"
24500 #: ../fish/guestfish-actions.pod:2475
24508 #: ../fish/guestfish-actions.pod:2483
24509 msgid "list-filesystems"
24513 #: ../fish/guestfish-actions.pod:2485
24516 " list-filesystems\n"
24521 #: ../fish/guestfish-actions.pod:2504
24523 "This command runs other libguestfs commands, which might include L</mount> "
24524 "and L</umount>, and therefore you should use this soon after launch and only "
24525 "when nothing is mounted."
24529 #: ../fish/guestfish-actions.pod:2508
24531 "Not all of the filesystems returned will be mountable. In particular, swap "
24532 "partitions are returned in the list. Also this command does not check that "
24533 "each filesystem found is valid and mountable, and some filesystems might be "
24534 "mountable but require special options. Filesystems may not all belong to a "
24535 "single logical operating system (use L</inspect-os> to look for OSes)."
24539 #: ../fish/guestfish-actions.pod:2516
24540 msgid "list-partitions"
24544 #: ../fish/guestfish-actions.pod:2518
24547 " list-partitions\n"
24552 #: ../fish/guestfish-actions.pod:2524
24554 "This does not return logical volumes. For that you will need to call L</"
24559 #: ../fish/guestfish-actions.pod:2529
24564 #: ../fish/guestfish-actions.pod:2531
24572 #: ../fish/guestfish-actions.pod:2539
24577 #: ../fish/guestfish-actions.pod:2541
24580 " ln target linkname\n"
24585 #: ../fish/guestfish-actions.pod:2545
24590 #: ../fish/guestfish-actions.pod:2547
24593 " ln-f target linkname\n"
24598 #: ../fish/guestfish-actions.pod:2552
24603 #: ../fish/guestfish-actions.pod:2554
24606 " ln-s target linkname\n"
24611 #: ../fish/guestfish-actions.pod:2558
24616 #: ../fish/guestfish-actions.pod:2560
24619 " ln-sf target linkname\n"
24624 #: ../fish/guestfish-actions.pod:2565
24625 msgid "lremovexattr"
24629 #: ../fish/guestfish-actions.pod:2567
24632 " lremovexattr xattr path\n"
24637 #: ../fish/guestfish-actions.pod:2569
24639 "This is the same as L</removexattr>, but if C<path> is a symbolic link, then "
24640 "it removes an extended attribute of the link itself."
24644 #: ../fish/guestfish-actions.pod:2573
24649 #: ../fish/guestfish-actions.pod:2575
24657 #: ../fish/guestfish-actions.pod:2581
24659 "This command is mostly useful for interactive sessions. Programs should "
24660 "probably use L</readdir> instead."
24664 #: ../fish/guestfish-actions.pod:2584
24669 #: ../fish/guestfish-actions.pod:2586
24672 " lsetxattr xattr val vallen path\n"
24677 #: ../fish/guestfish-actions.pod:2588
24679 "This is the same as L</setxattr>, but if C<path> is a symbolic link, then it "
24680 "sets an extended attribute of the link itself."
24684 #: ../fish/guestfish-actions.pod:2592
24689 #: ../fish/guestfish-actions.pod:2594
24697 #: ../fish/guestfish-actions.pod:2598
24699 "This is the same as L</stat> except that if C<path> is a symbolic link, then "
24700 "the link is stat-ed, not the file it refers to."
24704 #: ../fish/guestfish-actions.pod:2604
24709 #: ../fish/guestfish-actions.pod:2606
24712 " lstatlist path 'names ...'\n"
24717 #: ../fish/guestfish-actions.pod:2608
24719 "This call allows you to perform the L</lstat> operation on multiple files, "
24720 "where all files are in the directory C<path>. C<names> is the list of files "
24721 "from this directory."
24725 #: ../fish/guestfish-actions.pod:2617
24727 "This call is intended for programs that want to efficiently list a directory "
24728 "contents without making many round-trips. See also L</lxattrlist> for a "
24729 "similarly efficient call for getting extended attributes. Very long "
24730 "directory listings might cause the protocol message size to be exceeded, "
24731 "causing this call to fail. The caller must split up such requests into "
24732 "smaller groups of names."
24736 #: ../fish/guestfish-actions.pod:2625
24737 msgid "luks-add-key"
24741 #: ../fish/guestfish-actions.pod:2627
24744 " luks-add-key device keyslot\n"
24749 #: ../fish/guestfish-actions.pod:2634
24751 "Note that if C<keyslot> already contains a key, then this command will "
24752 "fail. You have to use L</luks-kill-slot> first to remove that key."
24756 #: ../fish/guestfish-actions.pod:2638 ../fish/guestfish-actions.pod:2660
24757 #: ../fish/guestfish-actions.pod:2673 ../fish/guestfish-actions.pod:2687
24758 #: ../fish/guestfish-actions.pod:2710 ../fish/guestfish-actions.pod:2720
24760 "This command has one or more key or passphrase parameters. Guestfish will "
24761 "prompt for these separately."
24765 #: ../fish/guestfish-actions.pod:2641
24770 #: ../fish/guestfish-actions.pod:2643
24773 " luks-close device\n"
24778 #: ../fish/guestfish-actions.pod:2645
24780 "This closes a LUKS device that was created earlier by L</luks-open> or L</"
24781 "luks-open-ro>. The C<device> parameter must be the name of the LUKS mapping "
24782 "device (ie. C</dev/mapper/mapname>) and I<not> the name of the underlying "
24787 #: ../fish/guestfish-actions.pod:2651
24788 msgid "luks-format"
24792 #: ../fish/guestfish-actions.pod:2653
24795 " luks-format device keyslot\n"
24800 #: ../fish/guestfish-actions.pod:2666
24801 msgid "luks-format-cipher"
24805 #: ../fish/guestfish-actions.pod:2668
24808 " luks-format-cipher device keyslot cipher\n"
24813 #: ../fish/guestfish-actions.pod:2670
24815 "This command is the same as L</luks-format> but it also allows you to set "
24816 "the C<cipher> used."
24820 #: ../fish/guestfish-actions.pod:2679
24821 msgid "luks-kill-slot"
24825 #: ../fish/guestfish-actions.pod:2681
24828 " luks-kill-slot device keyslot\n"
24833 #: ../fish/guestfish-actions.pod:2690
24838 #: ../fish/guestfish-actions.pod:2692
24841 " luks-open device mapname\n"
24846 #: ../fish/guestfish-actions.pod:2706
24848 "If this block device contains LVM volume groups, then calling L</vgscan> "
24849 "followed by L</vg-activate-all> will make them visible."
24853 #: ../fish/guestfish-actions.pod:2713
24854 msgid "luks-open-ro"
24858 #: ../fish/guestfish-actions.pod:2715
24861 " luks-open-ro device mapname\n"
24866 #: ../fish/guestfish-actions.pod:2717
24868 "This is the same as L</luks-open> except that a read-only mapping is created."
24872 #: ../fish/guestfish-actions.pod:2723
24877 #: ../fish/guestfish-actions.pod:2725
24880 " lvcreate logvol volgroup mbytes\n"
24885 #: ../fish/guestfish-actions.pod:2730
24886 msgid "lvm-canonical-lv-name"
24890 #: ../fish/guestfish-actions.pod:2732
24893 " lvm-canonical-lv-name lvname\n"
24898 #: ../fish/guestfish-actions.pod:2741
24899 msgid "See also L</is-lv>."
24903 #: ../fish/guestfish-actions.pod:2743
24904 msgid "lvm-clear-filter"
24908 #: ../fish/guestfish-actions.pod:2745
24911 " lvm-clear-filter\n"
24916 #: ../fish/guestfish-actions.pod:2747
24918 "This undoes the effect of L</lvm-set-filter>. LVM will be able to see every "
24923 #: ../fish/guestfish-actions.pod:2753
24924 msgid "lvm-remove-all"
24928 #: ../fish/guestfish-actions.pod:2755
24931 " lvm-remove-all\n"
24936 #: ../fish/guestfish-actions.pod:2763
24937 msgid "lvm-set-filter"
24941 #: ../fish/guestfish-actions.pod:2765
24944 " lvm-set-filter 'devices ...'\n"
24949 #: ../fish/guestfish-actions.pod:2790
24954 #: ../fish/guestfish-actions.pod:2792
24957 " lvremove device\n"
24962 #: ../fish/guestfish-actions.pod:2800
24967 #: ../fish/guestfish-actions.pod:2802
24970 " lvrename logvol newlogvol\n"
24975 #: ../fish/guestfish-actions.pod:2806
24980 #: ../fish/guestfish-actions.pod:2808
24983 " lvresize device mbytes\n"
24988 #: ../fish/guestfish-actions.pod:2814
24989 msgid "lvresize-free"
24993 #: ../fish/guestfish-actions.pod:2816
24996 " lvresize-free lv percent\n"
25001 #: ../fish/guestfish-actions.pod:2824
25006 #: ../fish/guestfish-actions.pod:2826
25014 #: ../fish/guestfish-actions.pod:2834
25015 msgid "See also L</lvs-full>, L</list-filesystems>."
25019 #: ../fish/guestfish-actions.pod:2836
25024 #: ../fish/guestfish-actions.pod:2838
25032 #: ../fish/guestfish-actions.pod:2843
25037 #: ../fish/guestfish-actions.pod:2845
25045 #: ../fish/guestfish-actions.pod:2849
25050 #: ../fish/guestfish-actions.pod:2851
25053 " lxattrlist path 'names ...'\n"
25058 #: ../fish/guestfish-actions.pod:2867
25060 "This call is intended for programs that want to efficiently list a directory "
25061 "contents without making many round-trips. See also L</lstatlist> for a "
25062 "similarly efficient call for getting standard stats. Very long directory "
25063 "listings might cause the protocol message size to be exceeded, causing this "
25064 "call to fail. The caller must split up such requests into smaller groups of "
25069 #: ../fish/guestfish-actions.pod:2875
25074 #: ../fish/guestfish-actions.pod:2877
25082 #: ../fish/guestfish-actions.pod:2881
25087 #: ../fish/guestfish-actions.pod:2883
25090 " mkdir-mode path mode\n"
25095 #: ../fish/guestfish-actions.pod:2892
25096 msgid "See also L</mkdir>, L</umask>"
25100 #: ../fish/guestfish-actions.pod:2894
25105 #: ../fish/guestfish-actions.pod:2896
25113 #: ../fish/guestfish-actions.pod:2901
25118 #: ../fish/guestfish-actions.pod:2903
25121 " mkdtemp template\n"
25126 #: ../fish/guestfish-actions.pod:2924
25131 #: ../fish/guestfish-actions.pod:2926
25134 " mke2fs-J fstype blocksize device journal\n"
25139 #: ../fish/guestfish-actions.pod:2934
25140 msgid "See also L</mke2journal>."
25144 #: ../fish/guestfish-actions.pod:2936
25149 #: ../fish/guestfish-actions.pod:2938
25152 " mke2fs-JL fstype blocksize device label\n"
25157 #: ../fish/guestfish-actions.pod:2943
25158 msgid "See also L</mke2journal-L>."
25162 #: ../fish/guestfish-actions.pod:2945
25167 #: ../fish/guestfish-actions.pod:2947
25170 " mke2fs-JU fstype blocksize device uuid\n"
25175 #: ../fish/guestfish-actions.pod:2952
25176 msgid "See also L</mke2journal-U>."
25180 #: ../fish/guestfish-actions.pod:2954
25181 msgid "mke2journal"
25185 #: ../fish/guestfish-actions.pod:2956
25188 " mke2journal blocksize device\n"
25193 #: ../fish/guestfish-actions.pod:2963
25194 msgid "mke2journal-L"
25198 #: ../fish/guestfish-actions.pod:2965
25201 " mke2journal-L blocksize label device\n"
25206 #: ../fish/guestfish-actions.pod:2969
25207 msgid "mke2journal-U"
25211 #: ../fish/guestfish-actions.pod:2971
25214 " mke2journal-U blocksize uuid device\n"
25219 #: ../fish/guestfish-actions.pod:2975
25224 #: ../fish/guestfish-actions.pod:2977
25227 " mkfifo mode path\n"
25232 #: ../fish/guestfish-actions.pod:2979
25234 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
25235 "is just a convenient wrapper around L</mknod>."
25239 #: ../fish/guestfish-actions.pod:2985
25244 #: ../fish/guestfish-actions.pod:2987
25247 " mkfs fstype device\n"
25252 #: ../fish/guestfish-actions.pod:2993
25257 #: ../fish/guestfish-actions.pod:2995
25260 " mkfs-b fstype blocksize device\n"
25265 #: ../fish/guestfish-actions.pod:2997
25267 "This call is similar to L</mkfs>, but it allows you to control the block "
25268 "size of the resulting filesystem. Supported block sizes depend on the "
25269 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
25273 #: ../fish/guestfish-actions.pod:3012
25278 #: ../fish/guestfish-actions.pod:3014
25281 " mkfs-opts fstype device [blocksize:..] [features:..]\n"
25286 #: ../fish/guestfish-actions.pod:3049
25287 msgid "mkmountpoint"
25291 #: ../fish/guestfish-actions.pod:3051
25294 " mkmountpoint exemptpath\n"
25299 #: ../fish/guestfish-actions.pod:3053
25301 "L</mkmountpoint> and L</rmmountpoint> are specialized calls that can be used "
25302 "to create extra mountpoints before mounting the first filesystem."
25306 #: ../fish/guestfish-actions.pod:3077
25308 "L</mkmountpoint> is not compatible with L</umount-all>. You may get "
25309 "unexpected errors if you try to mix these calls. It is safest to manually "
25310 "unmount filesystems and remove mountpoints after use."
25314 #: ../fish/guestfish-actions.pod:3081
25316 "L</umount-all> unmounts filesystems by sorting the paths longest first, so "
25317 "for this to work for manual mountpoints, you must ensure that the innermost "
25318 "mountpoints have the longest pathnames, as in the example code above."
25322 #: ../fish/guestfish-actions.pod:3088
25324 "Autosync [see L</set-autosync>, this is set by default on handles] can cause "
25325 "L</umount-all> to be called when the handle is closed which can also trigger "
25330 #: ../fish/guestfish-actions.pod:3092
25335 #: ../fish/guestfish-actions.pod:3094
25338 " mknod mode devmajor devminor path\n"
25343 #: ../fish/guestfish-actions.pod:3104
25345 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
25346 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
25347 "regular file). These constants are available in the standard Linux header "
25348 "files, or you can use L</mknod-b>, L</mknod-c> or L</mkfifo> which are "
25349 "wrappers around this command which bitwise OR in the appropriate constant "
25354 #: ../fish/guestfish-actions.pod:3114
25359 #: ../fish/guestfish-actions.pod:3116
25362 " mknod-b mode devmajor devminor path\n"
25367 #: ../fish/guestfish-actions.pod:3118
25369 "This call creates a block device node called C<path> with mode C<mode> and "
25370 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
25371 "wrapper around L</mknod>."
25375 #: ../fish/guestfish-actions.pod:3124
25380 #: ../fish/guestfish-actions.pod:3126
25383 " mknod-c mode devmajor devminor path\n"
25388 #: ../fish/guestfish-actions.pod:3128
25390 "This call creates a char device node called C<path> with mode C<mode> and "
25391 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
25392 "wrapper around L</mknod>."
25396 #: ../fish/guestfish-actions.pod:3134
25401 #: ../fish/guestfish-actions.pod:3136
25409 #: ../fish/guestfish-actions.pod:3140
25414 #: ../fish/guestfish-actions.pod:3142
25417 " mkswap-L label device\n"
25422 #: ../fish/guestfish-actions.pod:3150
25427 #: ../fish/guestfish-actions.pod:3152
25430 " mkswap-U uuid device\n"
25435 #: ../fish/guestfish-actions.pod:3156
25436 msgid "mkswap-file"
25440 #: ../fish/guestfish-actions.pod:3158
25443 " mkswap-file path\n"
25448 #: ../fish/guestfish-actions.pod:3162
25450 "This command just writes a swap file signature to an existing file. To "
25451 "create the file itself, use something like L</fallocate>."
25455 #: ../fish/guestfish-actions.pod:3165
25460 #: ../fish/guestfish-actions.pod:3167
25463 " modprobe modulename\n"
25468 #: ../fish/guestfish-actions.pod:3174
25473 #: ../fish/guestfish-actions.pod:3176
25476 " mount device mountpoint\n"
25481 #: ../fish/guestfish-actions.pod:3192
25483 "B<Important note:> When you use this call, the filesystem options C<sync> "
25484 "and C<noatime> are set implicitly. This was originally done because we "
25485 "thought it would improve reliability, but it turns out that I<-o sync> has a "
25486 "very large negative performance impact and negligible effect on "
25487 "reliability. Therefore we recommend that you avoid using L</mount> in any "
25488 "code that needs performance, and instead use L</mount-options> (use an empty "
25489 "string for the first parameter if you don't want any options)."
25493 #: ../fish/guestfish-actions.pod:3202
25498 #: ../fish/guestfish-actions.pod:3204
25501 " mount-loop file mountpoint\n"
25506 #: ../fish/guestfish-actions.pod:3210
25507 msgid "mount-options"
25511 #: ../fish/guestfish-actions.pod:3212
25514 " mount-options options device mountpoint\n"
25519 #: ../fish/guestfish-actions.pod:3214
25521 "This is the same as the L</mount> command, but it allows you to set the "
25522 "mount options as for the L<mount(8)> I<-o> flag."
25526 #: ../fish/guestfish-actions.pod:3222
25531 #: ../fish/guestfish-actions.pod:3224
25534 " mount-ro device mountpoint\n"
25539 #: ../fish/guestfish-actions.pod:3226
25541 "This is the same as the L</mount> command, but it mounts the filesystem with "
25542 "the read-only (I<-o ro>) flag."
25546 #: ../fish/guestfish-actions.pod:3229
25551 #: ../fish/guestfish-actions.pod:3231
25554 " mount-vfs options vfstype device mountpoint\n"
25559 #: ../fish/guestfish-actions.pod:3233
25561 "This is the same as the L</mount> command, but it allows you to set both the "
25562 "mount options and the vfstype as for the L<mount(8)> I<-o> and I<-t> flags."
25566 #: ../fish/guestfish-actions.pod:3237
25567 msgid "mountpoints"
25571 #: ../fish/guestfish-actions.pod:3239
25579 #: ../fish/guestfish-actions.pod:3241
25581 "This call is similar to L</mounts>. That call returns a list of devices. "
25582 "This one returns a hash table (map) of device name to directory where the "
25583 "device is mounted."
25587 #: ../fish/guestfish-actions.pod:3245
25592 #: ../fish/guestfish-actions.pod:3247
25600 #: ../fish/guestfish-actions.pod:3254
25601 msgid "See also: L</mountpoints>"
25605 #: ../fish/guestfish-actions.pod:3256
25610 #: ../fish/guestfish-actions.pod:3258
25618 #: ../fish/guestfish-actions.pod:3263
25619 msgid "ntfs-3g-probe"
25623 #: ../fish/guestfish-actions.pod:3265
25626 " ntfs-3g-probe true|false device\n"
25631 #: ../fish/guestfish-actions.pod:3279
25636 #: ../fish/guestfish-actions.pod:3281
25639 " ntfsresize device\n"
25644 #: ../fish/guestfish-actions.pod:3287
25645 msgid "ntfsresize-size"
25649 #: ../fish/guestfish-actions.pod:3289
25652 " ntfsresize-size device size\n"
25657 #: ../fish/guestfish-actions.pod:3291
25659 "This command is the same as L</ntfsresize> except that it allows you to "
25660 "specify the new size (in bytes) explicitly."
25664 #: ../fish/guestfish-actions.pod:3294
25669 #: ../fish/guestfish-actions.pod:3296
25672 " part-add device prlogex startsect endsect\n"
25677 #: ../fish/guestfish-actions.pod:3298
25679 "This command adds a partition to C<device>. If there is no partition table "
25680 "on the device, call L</part-init> first."
25684 #: ../fish/guestfish-actions.pod:3310
25686 "Creating a partition which covers the whole disk is not so easy. Use L</"
25687 "part-disk> to do that."
25691 #: ../fish/guestfish-actions.pod:3313
25696 #: ../fish/guestfish-actions.pod:3315
25699 " part-del device partnum\n"
25704 #: ../fish/guestfish-actions.pod:3323
25709 #: ../fish/guestfish-actions.pod:3325
25712 " part-disk device parttype\n"
25717 #: ../fish/guestfish-actions.pod:3327
25719 "This command is simply a combination of L</part-init> followed by L</part-"
25720 "add> to create a single primary partition covering the whole disk."
25724 #: ../fish/guestfish-actions.pod:3331
25726 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
25727 "possible values are described in L</part-init>."
25731 #: ../fish/guestfish-actions.pod:3337
25732 msgid "part-get-bootable"
25736 #: ../fish/guestfish-actions.pod:3339
25739 " part-get-bootable device partnum\n"
25744 #: ../fish/guestfish-actions.pod:3344
25745 msgid "See also L</part-set-bootable>."
25749 #: ../fish/guestfish-actions.pod:3346
25750 msgid "part-get-mbr-id"
25754 #: ../fish/guestfish-actions.pod:3348
25757 " part-get-mbr-id device partnum\n"
25762 #: ../fish/guestfish-actions.pod:3353 ../fish/guestfish-actions.pod:3491
25764 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
25765 "undefined results for other partition table types (see L</part-get-"
25770 #: ../fish/guestfish-actions.pod:3357
25771 msgid "part-get-parttype"
25775 #: ../fish/guestfish-actions.pod:3359
25778 " part-get-parttype device\n"
25783 #: ../fish/guestfish-actions.pod:3364
25785 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
25786 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
25787 "possible, although unusual. See L</part-init> for a full list."
25791 #: ../fish/guestfish-actions.pod:3369
25796 #: ../fish/guestfish-actions.pod:3371
25799 " part-init device parttype\n"
25804 #: ../fish/guestfish-actions.pod:3377
25806 "Initially there are no partitions. Following this, you should call L</part-"
25807 "add> for each partition required."
25811 #: ../fish/guestfish-actions.pod:3440
25816 #: ../fish/guestfish-actions.pod:3442
25819 " part-list device\n"
25824 #: ../fish/guestfish-actions.pod:3457
25826 "Start of the partition I<in bytes>. To get sectors you have to divide by "
25827 "the device's sector size, see L</blockdev-getss>."
25831 #: ../fish/guestfish-actions.pod:3470
25832 msgid "part-set-bootable"
25836 #: ../fish/guestfish-actions.pod:3472
25839 " part-set-bootable device partnum true|false\n"
25844 #: ../fish/guestfish-actions.pod:3481
25845 msgid "part-set-mbr-id"
25849 #: ../fish/guestfish-actions.pod:3483
25852 " part-set-mbr-id device partnum idbyte\n"
25857 #: ../fish/guestfish-actions.pod:3495
25858 msgid "part-set-name"
25862 #: ../fish/guestfish-actions.pod:3497
25865 " part-set-name device partnum name\n"
25870 #: ../fish/guestfish-actions.pod:3505
25871 msgid "part-to-dev"
25875 #: ../fish/guestfish-actions.pod:3507
25878 " part-to-dev partition\n"
25883 #: ../fish/guestfish-actions.pod:3513
25885 "The named partition must exist, for example as a string returned from L</"
25886 "list-partitions>."
25890 #: ../fish/guestfish-actions.pod:3516
25891 msgid "ping-daemon"
25895 #: ../fish/guestfish-actions.pod:3518
25903 #: ../fish/guestfish-actions.pod:3525
25908 #: ../fish/guestfish-actions.pod:3527
25911 " pread path count offset\n"
25916 #: ../fish/guestfish-actions.pod:3535
25917 msgid "See also L</pwrite>, L</pread-device>."
25921 #: ../fish/guestfish-actions.pod:3540
25922 msgid "pread-device"
25926 #: ../fish/guestfish-actions.pod:3542
25929 " pread-device device count offset\n"
25934 #: ../fish/guestfish-actions.pod:3550
25935 msgid "See also L</pread>."
25939 #: ../fish/guestfish-actions.pod:3555
25944 #: ../fish/guestfish-actions.pod:3557
25947 " pvcreate device\n"
25952 #: ../fish/guestfish-actions.pod:3563
25957 #: ../fish/guestfish-actions.pod:3565
25960 " pvremove device\n"
25965 #: ../fish/guestfish-actions.pod:3574
25970 #: ../fish/guestfish-actions.pod:3576
25973 " pvresize device\n"
25978 #: ../fish/guestfish-actions.pod:3581
25979 msgid "pvresize-size"
25983 #: ../fish/guestfish-actions.pod:3583
25986 " pvresize-size device size\n"
25991 #: ../fish/guestfish-actions.pod:3585
25993 "This command is the same as L</pvresize> except that it allows you to "
25994 "specify the new size (in bytes) explicitly."
25998 #: ../fish/guestfish-actions.pod:3588
26003 #: ../fish/guestfish-actions.pod:3590
26011 #: ../fish/guestfish-actions.pod:3598
26012 msgid "See also L</pvs-full>."
26016 #: ../fish/guestfish-actions.pod:3600
26021 #: ../fish/guestfish-actions.pod:3602
26029 #: ../fish/guestfish-actions.pod:3607
26034 #: ../fish/guestfish-actions.pod:3609
26042 #: ../fish/guestfish-actions.pod:3613
26047 #: ../fish/guestfish-actions.pod:3615
26050 " pwrite path content offset\n"
26055 #: ../fish/guestfish-actions.pod:3626
26056 msgid "See also L</pread>, L</pwrite-device>."
26060 #: ../fish/guestfish-actions.pod:3631
26061 msgid "pwrite-device"
26065 #: ../fish/guestfish-actions.pod:3633
26068 " pwrite-device device content offset\n"
26073 #: ../fish/guestfish-actions.pod:3643
26074 msgid "See also L</pwrite>."
26078 #: ../fish/guestfish-actions.pod:3648
26083 #: ../fish/guestfish-actions.pod:3650
26086 " read-file path\n"
26091 #: ../fish/guestfish-actions.pod:3655
26093 "Unlike L</cat>, this function can correctly handle files that contain "
26094 "embedded ASCII NUL characters. However unlike L</download>, this function "
26095 "is limited in the total size of file that can be handled."
26099 #: ../fish/guestfish-actions.pod:3663
26104 #: ../fish/guestfish-actions.pod:3665
26107 " read-lines path\n"
26112 #: ../fish/guestfish-actions.pod:3672
26114 "Note that this function cannot correctly handle binary files (specifically, "
26115 "files containing C<\\0> character which is treated as end of line). For "
26116 "those you need to use the L</read-file> function which has a more complex "
26121 #: ../fish/guestfish-actions.pod:3677
26126 #: ../fish/guestfish-actions.pod:3679
26134 #: ../fish/guestfish-actions.pod:3731
26136 "This function is primarily intended for use by programs. To get a simple "
26137 "list of names, use L</ls>. To get a printable directory for human "
26138 "consumption, use L</ll>."
26142 #: ../fish/guestfish-actions.pod:3735
26147 #: ../fish/guestfish-actions.pod:3737
26155 #: ../fish/guestfish-actions.pod:3741
26156 msgid "readlinklist"
26160 #: ../fish/guestfish-actions.pod:3743
26163 " readlinklist path 'names ...'\n"
26168 #: ../fish/guestfish-actions.pod:3767
26173 #: ../fish/guestfish-actions.pod:3769
26181 #: ../fish/guestfish-actions.pod:3774
26182 msgid "removexattr"
26186 #: ../fish/guestfish-actions.pod:3776
26189 " removexattr xattr path\n"
26194 #: ../fish/guestfish-actions.pod:3781
26195 msgid "See also: L</lremovexattr>, L<attr(5)>."
26199 #: ../fish/guestfish-actions.pod:3783
26204 #: ../fish/guestfish-actions.pod:3785
26207 " resize2fs device\n"
26212 #: ../fish/guestfish-actions.pod:3790
26214 "I<Note:> It is sometimes required that you run L</e2fsck-f> on the C<device> "
26215 "before calling this command. For unknown reasons C<resize2fs> sometimes "
26216 "gives an error about this and sometimes not. In any case, it is always safe "
26217 "to call L</e2fsck-f> before calling this function."
26221 #: ../fish/guestfish-actions.pod:3796
26222 msgid "resize2fs-M"
26226 #: ../fish/guestfish-actions.pod:3798
26229 " resize2fs-M device\n"
26234 #: ../fish/guestfish-actions.pod:3800
26236 "This command is the same as L</resize2fs>, but the filesystem is resized to "
26237 "its minimum size. This works like the I<-M> option to the C<resize2fs> "
26242 #: ../fish/guestfish-actions.pod:3804
26244 "To get the resulting size of the filesystem you should call L</tune2fs-l> "
26245 "and read the C<Block size> and C<Block count> values. These two numbers, "
26246 "multiplied together, give the resulting size of the minimal filesystem in "
26251 #: ../fish/guestfish-actions.pod:3809
26252 msgid "resize2fs-size"
26256 #: ../fish/guestfish-actions.pod:3811
26259 " resize2fs-size device size\n"
26264 #: ../fish/guestfish-actions.pod:3813
26266 "This command is the same as L</resize2fs> except that it allows you to "
26267 "specify the new size (in bytes) explicitly."
26271 #: ../fish/guestfish-actions.pod:3816
26276 #: ../fish/guestfish-actions.pod:3818
26284 #: ../fish/guestfish-actions.pod:3822
26289 #: ../fish/guestfish-actions.pod:3824
26297 #: ../fish/guestfish-actions.pod:3830
26302 #: ../fish/guestfish-actions.pod:3832
26310 #: ../fish/guestfish-actions.pod:3836
26311 msgid "rmmountpoint"
26315 #: ../fish/guestfish-actions.pod:3838
26318 " rmmountpoint exemptpath\n"
26323 #: ../fish/guestfish-actions.pod:3840
26325 "This calls removes a mountpoint that was previously created with L</"
26326 "mkmountpoint>. See L</mkmountpoint> for full details."
26330 #: ../fish/guestfish-actions.pod:3844
26331 msgid "scrub-device"
26335 #: ../fish/guestfish-actions.pod:3846
26338 " scrub-device device\n"
26343 #: ../fish/guestfish-actions.pod:3857
26348 #: ../fish/guestfish-actions.pod:3859
26351 " scrub-file file\n"
26356 #: ../fish/guestfish-actions.pod:3869
26357 msgid "scrub-freespace"
26361 #: ../fish/guestfish-actions.pod:3871
26364 " scrub-freespace dir\n"
26369 #: ../fish/guestfish-actions.pod:3873
26371 "This command creates the directory C<dir> and then fills it with files until "
26372 "the filesystem is full, and scrubs the files as for L</scrub-file>, and "
26373 "deletes them. The intention is to scrub any free space on the partition "
26374 "containing C<dir>."
26378 #: ../fish/guestfish-actions.pod:3882
26383 #: ../fish/guestfish-actions.pod:3884
26388 #: ../fish/guestfish-actions.pod:3886
26391 " set-append append\n"
26396 #: ../fish/guestfish-actions.pod:3897
26397 msgid "set-attach-method"
26401 #: ../fish/guestfish-actions.pod:3899
26402 msgid "attach-method"
26406 #: ../fish/guestfish-actions.pod:3901
26409 " set-attach-method attachmethod\n"
26414 #: ../fish/guestfish-actions.pod:3923
26415 msgid "set-autosync"
26419 #: ../fish/guestfish-actions.pod:3925
26424 #: ../fish/guestfish-actions.pod:3927
26427 " set-autosync true|false\n"
26432 #: ../fish/guestfish-actions.pod:3937
26437 #: ../fish/guestfish-actions.pod:3939
26442 #: ../fish/guestfish-actions.pod:3941
26445 " set-direct true|false\n"
26450 #: ../fish/guestfish-actions.pod:3947
26452 "One consequence of this is that log messages aren't caught by the library "
26453 "and handled by L</set-log-message-callback>, but go straight to stdout."
26457 #: ../fish/guestfish-actions.pod:3956
26458 msgid "set-e2label"
26462 #: ../fish/guestfish-actions.pod:3958
26465 " set-e2label device label\n"
26470 #: ../fish/guestfish-actions.pod:3964
26472 "You can use either L</tune2fs-l> or L</get-e2label> to return the existing "
26473 "label on a filesystem."
26477 #: ../fish/guestfish-actions.pod:3967
26482 #: ../fish/guestfish-actions.pod:3969
26485 " set-e2uuid device uuid\n"
26490 #: ../fish/guestfish-actions.pod:3976
26492 "You can use either L</tune2fs-l> or L</get-e2uuid> to return the existing "
26493 "UUID of a filesystem."
26497 #: ../fish/guestfish-actions.pod:3979
26498 msgid "set-memsize"
26502 #: ../fish/guestfish-actions.pod:3981
26507 #: ../fish/guestfish-actions.pod:3983
26510 " set-memsize memsize\n"
26515 #: ../fish/guestfish-actions.pod:3985
26517 "This sets the memory size in megabytes allocated to the qemu subprocess. "
26518 "This only has any effect if called before L</launch>."
26522 #: ../fish/guestfish-actions.pod:3996
26523 msgid "set-network"
26527 #: ../fish/guestfish-actions.pod:3998
26532 #: ../fish/guestfish-actions.pod:4000
26535 " set-network true|false\n"
26540 #: ../fish/guestfish-actions.pod:4008
26542 "You must call this before calling L</launch>, otherwise it has no effect."
26546 #: ../fish/guestfish-actions.pod:4011
26551 #: ../fish/guestfish-actions.pod:4013
26556 #: ../fish/guestfish-actions.pod:4015
26559 " set-path searchpath\n"
26564 #: ../fish/guestfish-actions.pod:4024
26569 #: ../fish/guestfish-actions.pod:4026
26574 #: ../fish/guestfish-actions.pod:4028
26582 #: ../fish/guestfish-actions.pod:4048
26583 msgid "set-recovery-proc"
26587 #: ../fish/guestfish-actions.pod:4050
26588 msgid "recovery-proc"
26592 #: ../fish/guestfish-actions.pod:4052
26595 " set-recovery-proc true|false\n"
26600 #: ../fish/guestfish-actions.pod:4054
26602 "If this is called with the parameter C<false> then L</launch> does not "
26603 "create a recovery process. The purpose of the recovery process is to stop "
26604 "runaway qemu processes in the case where the main program aborts abruptly."
26608 #: ../fish/guestfish-actions.pod:4059
26610 "This only has any effect if called before L</launch>, and the default is "
26615 #: ../fish/guestfish-actions.pod:4068
26616 msgid "set-selinux"
26620 #: ../fish/guestfish-actions.pod:4070
26625 #: ../fish/guestfish-actions.pod:4072
26628 " set-selinux true|false\n"
26633 #: ../fish/guestfish-actions.pod:4083
26638 #: ../fish/guestfish-actions.pod:4085
26643 #: ../fish/guestfish-actions.pod:4087
26646 " set-trace true|false\n"
26651 #: ../fish/guestfish-actions.pod:4099
26653 "Trace messages are normally sent to C<stderr>, unless you register a "
26654 "callback to send them somewhere else (see L</set-event-callback>)."
26658 #: ../fish/guestfish-actions.pod:4103
26659 msgid "set-verbose"
26663 #: ../fish/guestfish-actions.pod:4105
26668 #: ../fish/guestfish-actions.pod:4107
26671 " set-verbose true|false\n"
26676 #: ../fish/guestfish-actions.pod:4114
26678 "Verbose messages are normally sent to C<stderr>, unless you register a "
26679 "callback to send them somewhere else (see L</set-event-callback>)."
26683 #: ../fish/guestfish-actions.pod:4118
26688 #: ../fish/guestfish-actions.pod:4120
26691 " setcon context\n"
26696 #: ../fish/guestfish-actions.pod:4127
26701 #: ../fish/guestfish-actions.pod:4129
26704 " setxattr xattr val vallen path\n"
26709 #: ../fish/guestfish-actions.pod:4135
26710 msgid "See also: L</lsetxattr>, L<attr(5)>."
26714 #: ../fish/guestfish-actions.pod:4137
26719 #: ../fish/guestfish-actions.pod:4139
26722 " sfdisk device cyls heads sectors 'lines ...'\n"
26727 #: ../fish/guestfish-actions.pod:4161
26728 msgid "See also: L</sfdisk-l>, L</sfdisk-N>, L</part-init>"
26732 #: ../fish/guestfish-actions.pod:4167
26737 #: ../fish/guestfish-actions.pod:4169
26740 " sfdiskM device 'lines ...'\n"
26745 #: ../fish/guestfish-actions.pod:4171
26747 "This is a simplified interface to the L</sfdisk> command, where partition "
26748 "sizes are specified in megabytes only (rounded to the nearest cylinder) and "
26749 "you don't need to specify the cyls, heads and sectors parameters which were "
26750 "rarely if ever used anyway."
26754 #: ../fish/guestfish-actions.pod:4177
26755 msgid "See also: L</sfdisk>, the L<sfdisk(8)> manpage and L</part-disk>"
26759 #: ../fish/guestfish-actions.pod:4183
26764 #: ../fish/guestfish-actions.pod:4185
26767 " sfdisk-N device partnum cyls heads sectors line\n"
26772 #: ../fish/guestfish-actions.pod:4190
26774 "For other parameters, see L</sfdisk>. You should usually pass C<0> for the "
26775 "cyls/heads/sectors parameters."
26779 #: ../fish/guestfish-actions.pod:4193
26780 msgid "See also: L</part-add>"
26784 #: ../fish/guestfish-actions.pod:4198
26785 msgid "sfdisk-disk-geometry"
26789 #: ../fish/guestfish-actions.pod:4200
26792 " sfdisk-disk-geometry device\n"
26797 #: ../fish/guestfish-actions.pod:4202
26799 "This displays the disk geometry of C<device> read from the partition table. "
26800 "Especially in the case where the underlying block device has been resized, "
26801 "this can be different from the kernel's idea of the geometry (see L</sfdisk-"
26802 "kernel-geometry>)."
26806 #: ../fish/guestfish-actions.pod:4210
26807 msgid "sfdisk-kernel-geometry"
26811 #: ../fish/guestfish-actions.pod:4212
26814 " sfdisk-kernel-geometry device\n"
26819 #: ../fish/guestfish-actions.pod:4219
26824 #: ../fish/guestfish-actions.pod:4221
26827 " sfdisk-l device\n"
26832 #: ../fish/guestfish-actions.pod:4227
26833 msgid "See also: L</part-list>"
26837 #: ../fish/guestfish-actions.pod:4229
26842 #: ../fish/guestfish-actions.pod:4231
26850 #: ../fish/guestfish-actions.pod:4236
26851 msgid "This is like L</command>, but passes the command to:"
26855 #: ../fish/guestfish-actions.pod:4244
26856 msgid "All the provisos about L</command> apply to this call."
26860 #: ../fish/guestfish-actions.pod:4246
26865 #: ../fish/guestfish-actions.pod:4248
26868 " sh-lines command\n"
26873 #: ../fish/guestfish-actions.pod:4250
26874 msgid "This is the same as L</sh>, but splits the result into a list of lines."
26878 #: ../fish/guestfish-actions.pod:4253
26879 msgid "See also: L</command-lines>"
26883 #: ../fish/guestfish-actions.pod:4255
26888 #: ../fish/guestfish-actions.pod:4257
26896 #: ../fish/guestfish-actions.pod:4261
26901 #: ../fish/guestfish-actions.pod:4263
26909 #: ../fish/guestfish-actions.pod:4269
26914 #: ../fish/guestfish-actions.pod:4271
26922 #: ../fish/guestfish-actions.pod:4279
26927 #: ../fish/guestfish-actions.pod:4281
26935 #: ../fish/guestfish-actions.pod:4289
26940 #: ../fish/guestfish-actions.pod:4291
26943 " strings-e encoding path\n"
26948 #: ../fish/guestfish-actions.pod:4293
26950 "This is like the L</strings> command, but allows you to specify the encoding "
26951 "of strings that are looked for in the source file C<path>."
26955 #: ../fish/guestfish-actions.pod:4303
26957 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
26958 "ISO-8859-X (this is what L</strings> uses)."
26962 #: ../fish/guestfish-actions.pod:4335
26963 msgid "swapoff-device"
26967 #: ../fish/guestfish-actions.pod:4337
26970 " swapoff-device device\n"
26975 #: ../fish/guestfish-actions.pod:4339
26977 "This command disables the libguestfs appliance swap device or partition "
26978 "named C<device>. See L</swapon-device>."
26982 #: ../fish/guestfish-actions.pod:4343
26983 msgid "swapoff-file"
26987 #: ../fish/guestfish-actions.pod:4345
26990 " swapoff-file file\n"
26995 #: ../fish/guestfish-actions.pod:4349
26996 msgid "swapoff-label"
27000 #: ../fish/guestfish-actions.pod:4351
27003 " swapoff-label label\n"
27008 #: ../fish/guestfish-actions.pod:4356
27009 msgid "swapoff-uuid"
27013 #: ../fish/guestfish-actions.pod:4358
27016 " swapoff-uuid uuid\n"
27021 #: ../fish/guestfish-actions.pod:4363
27022 msgid "swapon-device"
27026 #: ../fish/guestfish-actions.pod:4365
27029 " swapon-device device\n"
27034 #: ../fish/guestfish-actions.pod:4367
27036 "This command enables the libguestfs appliance to use the swap device or "
27037 "partition named C<device>. The increased memory is made available for all "
27038 "commands, for example those run using L</command> or L</sh>."
27042 #: ../fish/guestfish-actions.pod:4379
27043 msgid "swapon-file"
27047 #: ../fish/guestfish-actions.pod:4381
27050 " swapon-file file\n"
27055 #: ../fish/guestfish-actions.pod:4383
27057 "This command enables swap to a file. See L</swapon-device> for other notes."
27061 #: ../fish/guestfish-actions.pod:4386
27062 msgid "swapon-label"
27066 #: ../fish/guestfish-actions.pod:4388
27069 " swapon-label label\n"
27074 #: ../fish/guestfish-actions.pod:4390
27076 "This command enables swap to a labeled swap partition. See L</swapon-"
27077 "device> for other notes."
27081 #: ../fish/guestfish-actions.pod:4393
27082 msgid "swapon-uuid"
27086 #: ../fish/guestfish-actions.pod:4395
27089 " swapon-uuid uuid\n"
27094 #: ../fish/guestfish-actions.pod:4397
27096 "This command enables swap to a swap partition with the given UUID. See L</"
27097 "swapon-device> for other notes."
27101 #: ../fish/guestfish-actions.pod:4400
27106 #: ../fish/guestfish-actions.pod:4402
27114 #: ../fish/guestfish-actions.pod:4410
27119 #: ../fish/guestfish-actions.pod:4412
27127 #: ../fish/guestfish-actions.pod:4420
27132 #: ../fish/guestfish-actions.pod:4422
27135 " tail-n nrlines path\n"
27140 #: ../fish/guestfish-actions.pod:4435
27145 #: ../fish/guestfish-actions.pod:4437
27148 " tar-in (tarfile|-) directory\n"
27153 #: ../fish/guestfish-actions.pod:4442
27154 msgid "To upload a compressed tarball, use L</tgz-in> or L</txz-in>."
27158 #: ../fish/guestfish-actions.pod:4447
27163 #: ../fish/guestfish-actions.pod:4449
27166 " tar-out directory (tarfile|-)\n"
27171 #: ../fish/guestfish-actions.pod:4454
27172 msgid "To download a compressed tarball, use L</tgz-out> or L</txz-out>."
27176 #: ../fish/guestfish-actions.pod:4459
27181 #: ../fish/guestfish-actions.pod:4461
27184 " tgz-in (tarball|-) directory\n"
27189 #: ../fish/guestfish-actions.pod:4466
27190 msgid "To upload an uncompressed tarball, use L</tar-in>."
27194 #: ../fish/guestfish-actions.pod:4470
27199 #: ../fish/guestfish-actions.pod:4472
27202 " tgz-out directory (tarball|-)\n"
27207 #: ../fish/guestfish-actions.pod:4477
27208 msgid "To download an uncompressed tarball, use L</tar-out>."
27212 #: ../fish/guestfish-actions.pod:4481
27217 #: ../fish/guestfish-actions.pod:4483
27225 #: ../fish/guestfish-actions.pod:4492
27230 #: ../fish/guestfish-actions.pod:4494
27238 #: ../fish/guestfish-actions.pod:4499
27239 msgid "truncate-size"
27243 #: ../fish/guestfish-actions.pod:4501
27246 " truncate-size path size\n"
27251 #: ../fish/guestfish-actions.pod:4506
27253 "If the current file size is less than C<size> then the file is extended to "
27254 "the required size with zero bytes. This creates a sparse file (ie. disk "
27255 "blocks are not allocated for the file until you write to it). To create a "
27256 "non-sparse file of zeroes, use L</fallocate64> instead."
27260 #: ../fish/guestfish-actions.pod:4512
27265 #: ../fish/guestfish-actions.pod:4514
27268 " tune2fs-l device\n"
27273 #: ../fish/guestfish-actions.pod:4524
27278 #: ../fish/guestfish-actions.pod:4526
27281 " txz-in (tarball|-) directory\n"
27286 #: ../fish/guestfish-actions.pod:4533
27291 #: ../fish/guestfish-actions.pod:4535
27294 " txz-out directory (tarball|-)\n"
27299 #: ../fish/guestfish-actions.pod:4542
27304 #: ../fish/guestfish-actions.pod:4544
27312 #: ../fish/guestfish-actions.pod:4558
27313 msgid "See also L</get-umask>, L<umask(2)>, L</mknod>, L</mkdir>."
27317 #: ../fish/guestfish-actions.pod:4563
27322 #: ../fish/guestfish-actions.pod:4565
27327 #: ../fish/guestfish-actions.pod:4567
27330 " umount pathordevice\n"
27335 #: ../fish/guestfish-actions.pod:4573
27340 #: ../fish/guestfish-actions.pod:4575
27341 msgid "unmount-all"
27345 #: ../fish/guestfish-actions.pod:4577
27353 #: ../fish/guestfish-actions.pod:4583
27358 #: ../fish/guestfish-actions.pod:4585
27361 " upload (filename|-) remotefilename\n"
27366 #: ../fish/guestfish-actions.pod:4592
27367 msgid "See also L</download>."
27371 #: ../fish/guestfish-actions.pod:4596
27372 msgid "upload-offset"
27376 #: ../fish/guestfish-actions.pod:4598
27379 " upload-offset (filename|-) remotefilename offset\n"
27384 #: ../fish/guestfish-actions.pod:4610
27386 "Note that there is no limit on the amount of data that can be uploaded with "
27387 "this call, unlike with L</pwrite>, and this call always writes the full "
27388 "amount unless an error occurs."
27392 #: ../fish/guestfish-actions.pod:4615
27393 msgid "See also L</upload>, L</pwrite>."
27397 #: ../fish/guestfish-actions.pod:4619
27402 #: ../fish/guestfish-actions.pod:4621
27405 " utimens path atsecs atnsecs mtsecs mtnsecs\n"
27410 #: ../fish/guestfish-actions.pod:4640
27415 #: ../fish/guestfish-actions.pod:4642
27423 #: ../fish/guestfish-actions.pod:4669
27425 "I<Note:> Don't use this call to test for availability of features. In "
27426 "enterprise distributions we backport features from later versions into "
27427 "earlier versions, making this an unreliable way to test for features. Use "
27428 "L</available> instead."
27432 #: ../fish/guestfish-actions.pod:4675
27437 #: ../fish/guestfish-actions.pod:4677
27440 " vfs-label device\n"
27445 #: ../fish/guestfish-actions.pod:4684
27446 msgid "To find a filesystem from the label, use L</findfs-label>."
27450 #: ../fish/guestfish-actions.pod:4686
27455 #: ../fish/guestfish-actions.pod:4688
27458 " vfs-type device\n"
27463 #: ../fish/guestfish-actions.pod:4698
27468 #: ../fish/guestfish-actions.pod:4700
27471 " vfs-uuid device\n"
27476 #: ../fish/guestfish-actions.pod:4707
27477 msgid "To find a filesystem from the UUID, use L</findfs-uuid>."
27481 #: ../fish/guestfish-actions.pod:4709
27482 msgid "vg-activate"
27486 #: ../fish/guestfish-actions.pod:4711
27489 " vg-activate true|false 'volgroups ...'\n"
27494 #: ../fish/guestfish-actions.pod:4724
27495 msgid "vg-activate-all"
27499 #: ../fish/guestfish-actions.pod:4726
27502 " vg-activate-all true|false\n"
27507 #: ../fish/guestfish-actions.pod:4736
27512 #: ../fish/guestfish-actions.pod:4738
27515 " vgcreate volgroup 'physvols ...'\n"
27520 #: ../fish/guestfish-actions.pod:4743
27525 #: ../fish/guestfish-actions.pod:4745
27528 " vglvuuids vgname\n"
27533 #: ../fish/guestfish-actions.pod:4750
27535 "You can use this along with L</lvs> and L</lvuuid> calls to associate "
27536 "logical volumes and volume groups."
27540 #: ../fish/guestfish-actions.pod:4753
27541 msgid "See also L</vgpvuuids>."
27545 #: ../fish/guestfish-actions.pod:4755
27550 #: ../fish/guestfish-actions.pod:4757
27553 " vgpvuuids vgname\n"
27558 #: ../fish/guestfish-actions.pod:4762
27560 "You can use this along with L</pvs> and L</pvuuid> calls to associate "
27561 "physical volumes and volume groups."
27565 #: ../fish/guestfish-actions.pod:4765
27566 msgid "See also L</vglvuuids>."
27570 #: ../fish/guestfish-actions.pod:4767
27575 #: ../fish/guestfish-actions.pod:4769
27578 " vgremove vgname\n"
27583 #: ../fish/guestfish-actions.pod:4776
27588 #: ../fish/guestfish-actions.pod:4778
27591 " vgrename volgroup newvolgroup\n"
27596 #: ../fish/guestfish-actions.pod:4782
27601 #: ../fish/guestfish-actions.pod:4784
27609 #: ../fish/guestfish-actions.pod:4792
27610 msgid "See also L</vgs-full>."
27614 #: ../fish/guestfish-actions.pod:4794
27619 #: ../fish/guestfish-actions.pod:4796
27627 #: ../fish/guestfish-actions.pod:4801
27632 #: ../fish/guestfish-actions.pod:4803
27640 #: ../fish/guestfish-actions.pod:4808
27645 #: ../fish/guestfish-actions.pod:4810
27653 #: ../fish/guestfish-actions.pod:4814
27658 #: ../fish/guestfish-actions.pod:4816
27666 #: ../fish/guestfish-actions.pod:4821
27671 #: ../fish/guestfish-actions.pod:4823
27679 #: ../fish/guestfish-actions.pod:4828
27684 #: ../fish/guestfish-actions.pod:4830
27692 #: ../fish/guestfish-actions.pod:4835
27697 #: ../fish/guestfish-actions.pod:4837
27700 " write path content\n"
27705 #: ../fish/guestfish-actions.pod:4845
27710 #: ../fish/guestfish-actions.pod:4847
27713 " write-file path content size\n"
27718 #: ../fish/guestfish-actions.pod:4870
27723 #: ../fish/guestfish-actions.pod:4872
27726 " zegrep regex path\n"
27731 #: ../fish/guestfish-actions.pod:4880
27736 #: ../fish/guestfish-actions.pod:4882
27739 " zegrepi regex path\n"
27744 #: ../fish/guestfish-actions.pod:4890
27749 #: ../fish/guestfish-actions.pod:4892
27757 #: ../fish/guestfish-actions.pod:4900
27758 msgid "See also: L</zero-device>, L</scrub-device>."
27762 #: ../fish/guestfish-actions.pod:4902
27763 msgid "zero-device"
27767 #: ../fish/guestfish-actions.pod:4904
27770 " zero-device device\n"
27775 #: ../fish/guestfish-actions.pod:4906
27777 "This command writes zeroes over the entire C<device>. Compare with L</zero> "
27778 "which just zeroes the first few blocks of a device."
27782 #: ../fish/guestfish-actions.pod:4913
27787 #: ../fish/guestfish-actions.pod:4915
27790 " zerofree device\n"
27795 #: ../fish/guestfish-actions.pod:4928
27800 #: ../fish/guestfish-actions.pod:4930
27803 " zfgrep pattern path\n"
27808 #: ../fish/guestfish-actions.pod:4938
27813 #: ../fish/guestfish-actions.pod:4940
27816 " zfgrepi pattern path\n"
27821 #: ../fish/guestfish-actions.pod:4948
27826 #: ../fish/guestfish-actions.pod:4950
27829 " zfile meth path\n"
27834 #: ../fish/guestfish-actions.pod:4957
27836 "Since 1.0.63, use L</file> instead which can now process compressed files."
27840 #: ../fish/guestfish-actions.pod:4967
27845 #: ../fish/guestfish-actions.pod:4969
27848 " zgrep regex path\n"
27853 #: ../fish/guestfish-actions.pod:4977
27858 #: ../fish/guestfish-actions.pod:4979
27861 " zgrepi regex path\n"
27866 #: ../fish/guestfish-commands.pod:1
27871 #: ../fish/guestfish-commands.pod:3
27876 #: ../fish/guestfish-commands.pod:5
27879 " alloc filename size\n"
27884 #: ../fish/guestfish-commands.pod:7
27886 "This creates an empty (zeroed) file of the given size, and then adds so it "
27887 "can be further examined."
27891 #: ../fish/guestfish-commands.pod:10 ../fish/guestfish-commands.pod:168
27892 msgid "For more advanced image creation, see L<qemu-img(1)> utility."
27896 #: ../fish/guestfish-commands.pod:12 ../fish/guestfish-commands.pod:170
27897 msgid "Size can be specified using standard suffixes, eg. C<1M>."
27901 #: ../fish/guestfish-commands.pod:14
27903 "To create a sparse file, use L</sparse> instead. To create a prepared disk "
27904 "image, see L</PREPARED DISK IMAGES>."
27908 #: ../fish/guestfish-commands.pod:17
27913 #: ../fish/guestfish-commands.pod:19
27916 " copy-in local [local ...] /remotedir\n"
27921 #: ../fish/guestfish-commands.pod:21
27923 "C<copy-in> copies local files or directories recursively into the disk "
27924 "image, placing them in the directory called C</remotedir> (which must "
27925 "exist). This guestfish meta-command turns into a sequence of L</tar-in> and "
27926 "other commands as necessary."
27930 #: ../fish/guestfish-commands.pod:26
27932 "Multiple local files and directories can be specified, but the last "
27933 "parameter must always be a remote directory. Wildcards cannot be used."
27937 #: ../fish/guestfish-commands.pod:30
27942 #: ../fish/guestfish-commands.pod:32
27945 " copy-out remote [remote ...] localdir\n"
27950 #: ../fish/guestfish-commands.pod:34
27952 "C<copy-out> copies remote files or directories recursively out of the disk "
27953 "image, placing them on the host disk in a local directory called C<localdir> "
27954 "(which must exist). This guestfish meta-command turns into a sequence of L</"
27955 "download>, L</tar-out> and other commands as necessary."
27959 #: ../fish/guestfish-commands.pod:40
27961 "Multiple remote files and directories can be specified, but the last "
27962 "parameter must always be a local directory. To download to the current "
27963 "directory, use C<.> as in:"
27967 #: ../fish/guestfish-commands.pod:44
27970 " copy-out /home .\n"
27975 #: ../fish/guestfish-commands.pod:46
27977 "Wildcards cannot be used in the ordinary command, but you can use them with "
27978 "the help of L</glob> like this:"
27982 #: ../fish/guestfish-commands.pod:49
27985 " glob copy-out /home/* .\n"
27990 #: ../fish/guestfish-commands.pod:51
27995 #: ../fish/guestfish-commands.pod:53
27998 " echo [params ...]\n"
28003 #: ../fish/guestfish-commands.pod:55
28004 msgid "This echos the parameters to the terminal."
28008 #: ../fish/guestfish-commands.pod:57
28013 #: ../fish/guestfish-commands.pod:59
28018 #: ../fish/guestfish-commands.pod:61
28023 #: ../fish/guestfish-commands.pod:63
28031 #: ../fish/guestfish-commands.pod:65
28033 "This is used to edit a file. It downloads the file, edits it locally using "
28034 "your editor, then uploads the result."
28038 #: ../fish/guestfish-commands.pod:68
28040 "The editor is C<$EDITOR>. However if you use the alternate commands C<vi> "
28041 "or C<emacs> you will get those corresponding editors."
28045 #: ../fish/guestfish-commands.pod:72
28050 #: ../fish/guestfish-commands.pod:74
28053 " glob command args...\n"
28058 #: ../fish/guestfish-commands.pod:76
28060 "Expand wildcards in any paths in the args list, and run C<command> "
28061 "repeatedly on each matching path."
28065 #: ../fish/guestfish-commands.pod:79
28066 msgid "See L</WILDCARDS AND GLOBBING>."
28070 #: ../fish/guestfish-commands.pod:81
28075 #: ../fish/guestfish-commands.pod:83
28078 " hexedit <filename|device>\n"
28079 " hexedit <filename|device> <max>\n"
28080 " hexedit <filename|device> <start> <max>\n"
28085 #: ../fish/guestfish-commands.pod:87
28087 "Use hexedit (a hex editor) to edit all or part of a binary file or block "
28092 #: ../fish/guestfish-commands.pod:90
28094 "This command works by downloading potentially the whole file or device, "
28095 "editing it locally, then uploading it. If the file or device is large, you "
28096 "have to specify which part you wish to edit by using C<max> and/or C<start> "
28097 "C<max> parameters. C<start> and C<max> are specified in bytes, with the "
28098 "usual modifiers allowed such as C<1M> (1 megabyte)."
28102 #: ../fish/guestfish-commands.pod:97
28103 msgid "For example to edit the first few sectors of a disk you might do:"
28107 #: ../fish/guestfish-commands.pod:100
28110 " hexedit /dev/sda 1M\n"
28115 #: ../fish/guestfish-commands.pod:102
28117 "which would allow you to edit anywhere within the first megabyte of the disk."
28121 #: ../fish/guestfish-commands.pod:105
28122 msgid "To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:"
28126 #: ../fish/guestfish-commands.pod:107
28129 " hexedit /dev/sda1 0x400 0x400\n"
28134 #: ../fish/guestfish-commands.pod:109
28135 msgid "(assuming the superblock is in the standard location)."
28139 #: ../fish/guestfish-commands.pod:111
28141 "This command requires the external L<hexedit(1)> program. You can specify "
28142 "another program to use by setting the C<HEXEDITOR> environment variable."
28146 #: ../fish/guestfish-commands.pod:115
28147 msgid "See also L</hexdump>."
28151 #: ../fish/guestfish-commands.pod:117
28156 #: ../fish/guestfish-commands.pod:119
28164 #: ../fish/guestfish-commands.pod:121
28166 "Change the local directory, ie. the current directory of guestfish itself."
28170 #: ../fish/guestfish-commands.pod:124
28171 msgid "Note that C<!cd> won't do what you might expect."
28175 #: ../fish/guestfish-commands.pod:126
28180 #: ../fish/guestfish-commands.pod:128
28185 #: ../fish/guestfish-commands.pod:130
28193 #: ../fish/guestfish-commands.pod:132
28194 msgid "Opens the manual page for guestfish."
28198 #: ../fish/guestfish-commands.pod:134
28203 #: ../fish/guestfish-commands.pod:136
28208 #: ../fish/guestfish-commands.pod:138
28216 #: ../fish/guestfish-commands.pod:140
28224 #: ../fish/guestfish-commands.pod:142
28225 msgid "This is used to view a file."
28229 #: ../fish/guestfish-commands.pod:144
28231 "The default viewer is C<$PAGER>. However if you use the alternate command "
28232 "C<less> you will get the C<less> command specifically."
28236 #: ../fish/guestfish-commands.pod:147
28241 #: ../fish/guestfish-commands.pod:149
28249 #: ../fish/guestfish-commands.pod:151
28251 "Close and reopen the libguestfs handle. It is not necessary to use this "
28252 "normally, because the handle is closed properly when guestfish exits. "
28253 "However this is occasionally useful for testing."
28257 #: ../fish/guestfish-commands.pod:155
28262 #: ../fish/guestfish-commands.pod:157
28265 " sparse filename size\n"
28270 #: ../fish/guestfish-commands.pod:159
28272 "This creates an empty sparse file of the given size, and then adds so it can "
28273 "be further examined."
28277 #: ../fish/guestfish-commands.pod:162
28279 "In all respects it works the same as the L</alloc> command, except that the "
28280 "image file is allocated sparsely, which means that disk blocks are not "
28281 "assigned to the file until they are needed. Sparse disk files only use "
28282 "space when written to, but they are slower and there is a danger you could "
28283 "run out of real disk space during a write operation."
28287 #: ../fish/guestfish-commands.pod:172
28292 #: ../fish/guestfish-commands.pod:174
28300 #: ../fish/guestfish-commands.pod:176
28302 "This command returns a list of the optional groups known to the daemon, and "
28303 "indicates which ones are supported by this build of the libguestfs appliance."
28307 #: ../fish/guestfish-commands.pod:180
28308 msgid "See also L<guestfs(3)/AVAILABILITY>."
28312 #: ../fish/guestfish-commands.pod:182
28317 #: ../fish/guestfish-commands.pod:184
28320 " time command args...\n"
28325 #: ../fish/guestfish-commands.pod:186
28327 "Run the command as usual, but print the elapsed time afterwards. This can "
28328 "be useful for benchmarking operations."
28332 #: ../test-tool/libguestfs-test-tool.pod:5
28333 msgid "libguestfs-test-tool - End user tests for libguestfs"
28337 #: ../test-tool/libguestfs-test-tool.pod:9
28340 " libguestfs-test-tool [--options]\n"
28345 #: ../test-tool/libguestfs-test-tool.pod:13
28347 "libguestfs-test-tool is a test program shipped with libguestfs to end users "
28348 "and developers, to allow them to check basic libguestfs functionality is "
28349 "working. This is needed because libguestfs occasionally breaks for reasons "
28350 "beyond our control: usually because of changes in the underlying qemu or "
28351 "kernel packages, or the host environment."
28355 #: ../test-tool/libguestfs-test-tool.pod:20
28356 msgid "If you suspect a problem in libguestfs, then just run:"
28360 #: ../test-tool/libguestfs-test-tool.pod:22
28363 " libguestfs-test-tool\n"
28368 #: ../test-tool/libguestfs-test-tool.pod:24
28369 msgid "It will print lots of diagnostic messages."
28373 #: ../test-tool/libguestfs-test-tool.pod:26
28374 msgid "If it runs to completion successfully, you will see this near the end:"
28378 #: ../test-tool/libguestfs-test-tool.pod:28
28381 " ===== TEST FINISHED OK =====\n"
28386 #: ../test-tool/libguestfs-test-tool.pod:30
28387 msgid "and the test tool will exit with code 0."
28391 #: ../test-tool/libguestfs-test-tool.pod:32
28393 "If it fails (and/or exits with non-zero error code), please paste the "
28394 "B<complete, unedited> output of the test tool into a bug report. More "
28395 "information about reporting bugs can be found on the L<http://libguestfs.org/"
28400 #: ../test-tool/libguestfs-test-tool.pod:41
28405 #: ../test-tool/libguestfs-test-tool.pod:43
28406 msgid "Display short usage information and exit."
28410 #: ../test-tool/libguestfs-test-tool.pod:45
28411 msgid "I<--qemu qemu_binary>"
28415 #: ../test-tool/libguestfs-test-tool.pod:47
28417 "If you have downloaded another qemu binary, point this option at the full "
28418 "path of the binary to try it."
28422 #: ../test-tool/libguestfs-test-tool.pod:50
28423 msgid "I<--qemudir qemu_source_dir>"
28427 #: ../test-tool/libguestfs-test-tool.pod:52
28429 "If you have compiled qemu from source, point this option at the source "
28430 "directory to try it."
28434 #: ../test-tool/libguestfs-test-tool.pod:55
28435 msgid "I<--timeout N>"
28439 #: ../test-tool/libguestfs-test-tool.pod:57
28441 "Set the launch timeout to C<N> seconds. The default is 120 seconds which "
28442 "does not usually need to be adjusted unless your machine is very slow."
28446 #: ../test-tool/libguestfs-test-tool.pod:63
28447 msgid "TRYING OUT A DIFFERENT VERSION OF QEMU"
28451 #: ../test-tool/libguestfs-test-tool.pod:65
28453 "If you have compiled another version of qemu from source and would like to "
28454 "try that, then you can use the I<--qemudir> option to point to the qemu "
28455 "source directory."
28459 #: ../test-tool/libguestfs-test-tool.pod:69
28461 "If you have downloaded a qemu binary from somewhere, use the I<--qemu> "
28462 "option to point to the binary."
28466 #: ../test-tool/libguestfs-test-tool.pod:72
28468 "When using an alternate qemu with libguestfs, usually you would need to "
28469 "write a qemu wrapper script (see section I<QEMU WRAPPERS> in L<guestfs(3)"
28470 ">). libguestfs-test-tool writes a temporary qemu wrapper script when you "
28471 "use either of the I<--qemudir> or I<--qemu> options."
28475 #: ../test-tool/libguestfs-test-tool.pod:79
28477 "libguestfs-test-tool returns I<0> if the tests completed without error, or "
28478 "I<1> if there was an error."
28482 #: ../test-tool/libguestfs-test-tool.pod:84
28484 "For the full list of environment variables which may affect libguestfs, "
28485 "please see the L<guestfs(3)> manual page."
28489 #: ../test-tool/libguestfs-test-tool.pod:89
28490 msgid "L<guestfs(3)>, L<http://libguestfs.org/>, L<http://qemu.org/>."
28494 #: ../fuse/guestmount.pod:5
28496 "guestmount - Mount a guest filesystem on the host using FUSE and libguestfs"
28500 #: ../fuse/guestmount.pod:9
28503 " guestmount [--options] -a disk.img -m device [--ro] mountpoint\n"
28508 #: ../fuse/guestmount.pod:11
28511 " guestmount [--options] -a disk.img -i [--ro] mountpoint\n"
28516 #: ../fuse/guestmount.pod:13
28519 " guestmount [--options] -d Guest -i [--ro] mountpoint\n"
28524 #: ../fuse/guestmount.pod:17
28526 "You must I<not> use C<guestmount> in read-write mode on live virtual "
28527 "machines. If you do this, you risk disk corruption in the VM."
28531 #: ../fuse/guestmount.pod:22
28533 "The guestmount program can be used to mount virtual machine filesystems and "
28534 "other disk images on the host. It uses libguestfs for access to the guest "
28535 "filesystem, and FUSE (the \"filesystem in userspace\") to make it appear as "
28536 "a mountable device."
28540 #: ../fuse/guestmount.pod:27
28542 "Along with other options, you have to give at least one device (I<-a> "
28543 "option) or libvirt domain (I<-d> option), and at least one mountpoint (I<-m> "
28544 "option) or use the I<-i> inspection option. How this works is better "
28545 "explained in the L<guestfish(1)> manual page, or by looking at the examples "
28550 #: ../fuse/guestmount.pod:33
28552 "FUSE lets you mount filesystems as non-root. The mountpoint must be owned "
28553 "by you, and the filesystem will not be visible to any other users unless you "
28554 "make certain global configuration changes to C</etc/fuse.conf>. To unmount "
28555 "the filesystem, use the C<fusermount -u> command."
28559 #: ../fuse/guestmount.pod:41
28561 "For a typical Windows guest which has its main filesystem on the first "
28566 #: ../fuse/guestmount.pod:44
28569 " guestmount -a windows.img -m /dev/sda1 --ro /mnt\n"
28574 #: ../fuse/guestmount.pod:46
28576 "For a typical Linux guest which has a /boot filesystem on the first "
28577 "partition, and the root filesystem on a logical volume:"
28581 #: ../fuse/guestmount.pod:49
28584 " guestmount -a linux.img -m /dev/VG/LV -m /dev/sda1:/boot --ro /mnt\n"
28589 #: ../fuse/guestmount.pod:51
28590 msgid "To get libguestfs to detect guest mountpoints for you:"
28594 #: ../fuse/guestmount.pod:53
28597 " guestmount -a guest.img -i --ro /mnt\n"
28602 #: ../fuse/guestmount.pod:55
28603 msgid "For a libvirt guest called \"Guest\" you could do:"
28607 #: ../fuse/guestmount.pod:57
28610 " guestmount -d Guest -i --ro /mnt\n"
28615 #: ../fuse/guestmount.pod:59
28617 "If you don't know what filesystems are contained in a guest or disk image, "
28618 "use L<virt-filesystems(1)> first:"
28622 #: ../fuse/guestmount.pod:62
28625 " virt-filesystems MyGuest\n"
28630 #: ../fuse/guestmount.pod:64
28632 "If you want to trace the libguestfs calls but without excessive debugging "
28633 "information, we recommend:"
28637 #: ../fuse/guestmount.pod:67
28640 " guestmount [...] --trace /mnt\n"
28645 #: ../fuse/guestmount.pod:69
28646 msgid "If you want to debug the program, we recommend:"
28650 #: ../fuse/guestmount.pod:71
28653 " guestmount [...] --trace --verbose /mnt\n"
28658 #: ../fuse/guestmount.pod:77
28659 msgid "B<-a image> | B<--add image>"
28663 #: ../fuse/guestmount.pod:79
28664 msgid "Add a block device or virtual machine image."
28668 #: ../fuse/guestmount.pod:84
28669 msgid "B<-c URI> | B<--connect URI>"
28673 #: ../fuse/guestmount.pod:90
28674 msgid "B<-d libvirt-domain> | B<--domain libvirt-domain>"
28678 #: ../fuse/guestmount.pod:96
28679 msgid "B<--dir-cache-timeout N>"
28683 #: ../fuse/guestmount.pod:98
28685 "Set the readdir cache timeout to I<N> seconds, the default being 60 "
28686 "seconds. The readdir cache [actually, there are several semi-independent "
28687 "caches] is populated after a readdir(2) call with the stat and extended "
28688 "attributes of the files in the directory, in anticipation that they will be "
28689 "requested soon after."
28693 #: ../fuse/guestmount.pod:104
28695 "There is also a different attribute cache implemented by FUSE (see the FUSE "
28696 "option I<-o attr_timeout>), but the FUSE cache does not anticipate future "
28697 "requests, only cache existing ones."
28701 #: ../fuse/guestmount.pod:115
28702 msgid "B<--format=raw|qcow2|..> | B<--format>"
28706 #: ../fuse/guestmount.pod:122
28708 "If you have untrusted raw-format guest disk images, you should use this "
28709 "option to specify the disk format. This avoids a possible security problem "
28710 "with malicious guests (CVE-2010-3851). See also L<guestfs(3)/"
28711 "guestfs_add_drive_opts>."
28715 #: ../fuse/guestmount.pod:127
28716 msgid "B<--fuse-help>"
28720 #: ../fuse/guestmount.pod:129
28721 msgid "Display help on special FUSE options (see I<-o> below)."
28725 #: ../fuse/guestmount.pod:133
28726 msgid "Display brief help and exit."
28730 #: ../fuse/guestmount.pod:135
28731 msgid "B<-i> | B<--inspector>"
28735 #: ../fuse/guestmount.pod:155
28737 "Mount the named partition or logical volume on the given mountpoint B<in the "
28738 "guest> (this has nothing to do with mountpoints in the host)."
28742 #: ../fuse/guestmount.pod:158
28744 "If the mountpoint is omitted, it defaults to C</>. You have to mount "
28745 "something on C</>."
28749 #: ../fuse/guestmount.pod:171
28750 msgid "B<-n> | B<--no-sync>"
28754 #: ../fuse/guestmount.pod:173
28756 "By default, we attempt to sync the guest disk when the FUSE mountpoint is "
28757 "unmounted. If you specify this option, then we don't attempt to sync the "
28758 "disk. See the discussion of autosync in the L<guestfs(3)> manpage."
28762 #: ../fuse/guestmount.pod:178
28763 msgid "B<-o option> | B<--option option>"
28767 #: ../fuse/guestmount.pod:180
28768 msgid "Pass extra options to FUSE."
28772 #: ../fuse/guestmount.pod:182
28774 "To get a list of all the extra options supported by FUSE, use the command "
28775 "below. Note that only the FUSE I<-o> options can be passed, and only some "
28776 "of them are a good idea."
28780 #: ../fuse/guestmount.pod:186
28783 " guestmount --fuse-help\n"
28788 #: ../fuse/guestmount.pod:188
28789 msgid "Some potentially useful FUSE options:"
28793 #: ../fuse/guestmount.pod:192
28794 msgid "B<-o allow_other>"
28798 #: ../fuse/guestmount.pod:194
28799 msgid "Allow other users to see the filesystem."
28803 #: ../fuse/guestmount.pod:196
28804 msgid "B<-o attr_timeout=N>"
28808 #: ../fuse/guestmount.pod:198
28809 msgid "Enable attribute caching by FUSE, and set the timeout to I<N> seconds."
28813 #: ../fuse/guestmount.pod:200
28814 msgid "B<-o kernel_cache>"
28818 #: ../fuse/guestmount.pod:202
28820 "Allow the kernel to cache files (reduces the number of reads that have to go "
28821 "through the L<guestfs(3)> API). This is generally a good idea if you can "
28822 "afford the extra memory usage."
28826 #: ../fuse/guestmount.pod:206
28827 msgid "B<-o uid=N> B<-o gid=N>"
28831 #: ../fuse/guestmount.pod:208
28833 "Use these options to map all UIDs and GIDs inside the guest filesystem to "
28834 "the chosen values."
28838 #: ../fuse/guestmount.pod:213
28839 msgid "B<-r> | B<--ro>"
28843 #: ../fuse/guestmount.pod:215
28845 "Add devices and mount everything read-only. Also disallow writes and make "
28846 "the disk appear read-only to FUSE."
28850 #: ../fuse/guestmount.pod:218
28852 "This is highly recommended if you are not going to edit the guest disk. If "
28853 "the guest is running and this option is I<not> supplied, then there is a "
28854 "strong risk of disk corruption in the guest. We try to prevent this from "
28855 "happening, but it is not always possible."
28859 #: ../fuse/guestmount.pod:223
28860 msgid "See also L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
28864 #: ../fuse/guestmount.pod:227
28865 msgid "Enable SELinux support for the guest."
28869 #: ../fuse/guestmount.pod:229
28870 msgid "B<-v> | B<--verbose>"
28874 #: ../fuse/guestmount.pod:231
28875 msgid "Enable verbose messages from underlying libguestfs."
28879 #: ../fuse/guestmount.pod:233
28880 msgid "B<-V> | B<--version>"
28884 #: ../fuse/guestmount.pod:235
28885 msgid "Display the program version and exit."
28889 #: ../fuse/guestmount.pod:237
28890 msgid "B<-w> | B<--rw>"
28894 #: ../fuse/guestmount.pod:242 ../fuse/guestmount.pod:263
28895 msgid "See L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
28899 #: ../fuse/guestmount.pod:244
28900 msgid "B<-x> | B<--trace>"
28904 #: ../fuse/guestmount.pod:246
28905 msgid "Trace libguestfs calls and entry into each FUSE function."
28909 #: ../fuse/guestmount.pod:248
28910 msgid "This also stops the daemon from forking into the background."
28914 #: ../fuse/guestmount.pod:269
28916 "L<guestfish(1)>, L<virt-inspector(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
28917 "L<virt-tar(1)>, L<guestfs(3)>, L<http://libguestfs.org/>, L<http://fuse.sf."
28922 #: ../fuse/guestmount.pod:284
28923 msgid "Copyright (C) 2009-2010 Red Hat Inc. L<http://libguestfs.org/>"
28927 #: ../tools/virt-edit.pl:34
28928 msgid "virt-edit - Edit a file in a virtual machine"
28932 #: ../tools/virt-edit.pl:38
28935 " virt-edit [--options] domname file\n"
28940 #: ../tools/virt-edit.pl:40
28943 " virt-edit [--options] disk.img [disk.img ...] file\n"
28948 #: ../tools/virt-edit.pl:42
28951 " virt-edit [domname|disk.img] file -e 'expr'\n"
28956 #: ../tools/virt-edit.pl:46
28958 "You must I<not> use C<virt-edit> on live virtual machines. If you do this, "
28959 "you risk disk corruption in the VM. C<virt-edit> tries to stop you from "
28960 "doing this, but doesn't catch all cases."
28964 #: ../tools/virt-edit.pl:52
28966 "C<virt-edit> is a command line tool to edit C<file> where C<file> exists in "
28967 "the named virtual machine (or disk image)."
28971 #: ../tools/virt-edit.pl:55
28972 msgid "If you want to just view a file, use L<virt-cat(1)>."
28976 #: ../tools/virt-edit.pl:57
28978 "For more complex cases you should look at the L<guestfish(1)> tool (see L</"
28979 "USING GUESTFISH> below)."
28983 #: ../tools/virt-edit.pl:60
28985 "C<virt-edit> cannot be used to create a new file, nor to edit multiple "
28986 "files. L<guestfish(1)> can do that and much more."
28990 #: ../tools/virt-edit.pl:65
28991 msgid "Edit the named files interactively:"
28995 #: ../tools/virt-edit.pl:67
28998 " virt-edit mydomain /boot/grub/grub.conf\n"
29003 #: ../tools/virt-edit.pl:69
29006 " virt-edit mydomain /etc/passwd\n"
29011 #: ../tools/virt-edit.pl:71
29012 msgid "For Windows guests, some Windows paths are understood:"
29016 #: ../tools/virt-edit.pl:73
29019 " virt-edit mywindomain 'c:\\autoexec.bat'\n"
29024 #: ../tools/virt-edit.pl:75
29026 "You can also edit files non-interactively (see L</NON-INTERACTIVE EDITING> "
29027 "below). To change the init default level to 5:"
29031 #: ../tools/virt-edit.pl:79
29034 " virt-edit mydomain /etc/inittab -e 's/^id:.*/id:5:initdefault:/'\n"
29039 #: ../tools/virt-edit.pl:91 ../tools/virt-win-reg.pl:106
29040 #: ../tools/virt-list-filesystems.pl:63 ../tools/virt-tar.pl:113
29041 #: ../tools/virt-make-fs.pl:163 ../tools/virt-list-partitions.pl:64
29042 msgid "Display brief help."
29046 #: ../tools/virt-edit.pl:99 ../tools/virt-win-reg.pl:114
29047 #: ../tools/virt-list-filesystems.pl:71 ../tools/virt-tar.pl:121
29048 #: ../tools/virt-make-fs.pl:171 ../tools/virt-list-partitions.pl:72
29049 msgid "Display version number and exit."
29053 #: ../tools/virt-edit.pl:105
29054 msgid "B<--backup extension> | B<-b extension>"
29058 #: ../tools/virt-edit.pl:107
29060 "Create a backup of the original file I<in the guest disk image>. The backup "
29061 "has the original filename with C<extension> added."
29065 #: ../tools/virt-edit.pl:110
29067 "Usually the first character of C<extension> would be a dot C<.> so you would "
29072 #: ../tools/virt-edit.pl:113
29075 " virt-edit -b .orig [etc]\n"
29080 #: ../tools/virt-edit.pl:115
29081 msgid "By default, no backup file is made."
29085 #: ../tools/virt-edit.pl:121 ../tools/virt-win-reg.pl:128
29086 #: ../tools/virt-list-filesystems.pl:77 ../tools/virt-tar.pl:127
29087 #: ../tools/virt-list-partitions.pl:78
29088 msgid "B<--connect URI> | B<-c URI>"
29092 #: ../tools/virt-edit.pl:123 ../tools/virt-win-reg.pl:130
29093 #: ../tools/virt-list-filesystems.pl:79 ../tools/virt-tar.pl:129
29094 #: ../tools/virt-list-partitions.pl:80
29096 "If using libvirt, connect to the given I<URI>. If omitted, then we connect "
29097 "to the default libvirt hypervisor."
29101 #: ../tools/virt-edit.pl:126 ../tools/virt-win-reg.pl:133
29102 #: ../tools/virt-list-filesystems.pl:82 ../tools/virt-tar.pl:132
29103 #: ../tools/virt-list-partitions.pl:83
29105 "If you specify guest block devices directly, then libvirt is not used at all."
29109 #: ../tools/virt-edit.pl:133 ../tools/virt-win-reg.pl:140
29110 #: ../tools/virt-list-filesystems.pl:89 ../tools/virt-tar.pl:139
29111 #: ../tools/virt-list-partitions.pl:90
29112 msgid "B<--format> raw"
29116 #: ../tools/virt-edit.pl:135 ../tools/virt-win-reg.pl:142
29117 #: ../tools/virt-list-filesystems.pl:91 ../tools/virt-tar.pl:141
29118 #: ../tools/virt-list-partitions.pl:92
29120 "Specify the format of disk images given on the command line. If this is "
29121 "omitted then the format is autodetected from the content of the disk image."
29125 #: ../tools/virt-edit.pl:139 ../tools/virt-win-reg.pl:146
29126 #: ../tools/virt-list-filesystems.pl:95 ../tools/virt-tar.pl:145
29127 #: ../tools/virt-list-partitions.pl:96
29129 "If disk images are requested from libvirt, then this program asks libvirt "
29130 "for this information. In this case, the value of the format parameter is "
29135 #: ../tools/virt-edit.pl:143 ../tools/virt-win-reg.pl:150
29136 #: ../tools/virt-list-filesystems.pl:99 ../tools/virt-tar.pl:149
29137 #: ../tools/virt-list-partitions.pl:100
29139 "If working with untrusted raw-format guest disk images, you should ensure "
29140 "the format is always specified."
29144 #: ../tools/virt-edit.pl:150
29145 msgid "B<--expr EXPR> | B<-e EXPR>"
29149 #: ../tools/virt-edit.pl:152
29151 "Instead of launching the external editor, non-interactively apply the Perl "
29152 "expression C<EXPR> to each line in the file. See L</NON-INTERACTIVE "
29157 #: ../tools/virt-edit.pl:156
29159 "Be careful to properly quote the expression to prevent it from being altered "
29164 #: ../tools/virt-edit.pl:280
29165 msgid "NON-INTERACTIVE EDITING"
29169 #: ../tools/virt-edit.pl:282
29171 "C<virt-edit> normally calls out to C<$EDITOR> (or vi) so the system "
29172 "administrator can interactively edit the file."
29176 #: ../tools/virt-edit.pl:285
29178 "There are two ways also to use C<virt-edit> from scripts in order to make "
29179 "automated edits to files. (Note that although you I<can> use C<virt-edit> "
29180 "like this, it's less error-prone to write scripts directly using the "
29181 "libguestfs API and Augeas for configuration file editing.)"
29185 #: ../tools/virt-edit.pl:291
29187 "The first method is to temporarily set C<$EDITOR> to any script or program "
29188 "you want to run. The script is invoked as C<$EDITOR tmpfile> and it should "
29189 "update C<tmpfile> in place however it likes."
29193 #: ../tools/virt-edit.pl:295
29195 "The second method is to use the I<-e> parameter of C<virt-edit> to run a "
29196 "short Perl snippet in the style of L<sed(1)>. For example to replace all "
29197 "instances of C<foo> with C<bar> in a file:"
29201 #: ../tools/virt-edit.pl:299
29204 " virt-edit domname filename -e 's/foo/bar/'\n"
29209 #: ../tools/virt-edit.pl:301
29211 "The full power of Perl regular expressions can be used (see L<perlre(1)>). "
29212 "For example to delete root's password you could do:"
29216 #: ../tools/virt-edit.pl:304
29219 " virt-edit domname /etc/passwd -e 's/^root:.*?:/root::/'\n"
29224 #: ../tools/virt-edit.pl:306
29226 "What really happens is that the snippet is evaluated as a Perl expression "
29227 "for each line of the file. The line, including the final C<\\n>, is passed "
29228 "in C<$_> and the expression should update C<$_> or leave it unchanged."
29232 #: ../tools/virt-edit.pl:311
29234 "To delete a line, set C<$_> to the empty string. For example, to delete the "
29235 "C<apache> user account from the password file you can do:"
29239 #: ../tools/virt-edit.pl:314
29242 " virt-edit mydomain /etc/passwd -e '$_ = \"\" if /^apache:/'\n"
29247 #: ../tools/virt-edit.pl:316
29249 "To insert a line, prepend or append it to C<$_>. However appending lines to "
29250 "the end of the file is rather difficult this way since there is no concept "
29251 "of \"last line of the file\" - your expression just doesn't get called "
29252 "again. You might want to use the first method (setting C<$EDITOR>) if you "
29257 #: ../tools/virt-edit.pl:322
29259 "The variable C<$lineno> contains the current line number. As is "
29260 "traditional, the first line in the file is number C<1>."
29264 #: ../tools/virt-edit.pl:325
29266 "The return value from the expression is ignored, but the expression may call "
29267 "C<die> in order to abort the whole program, leaving the original file "
29272 #: ../tools/virt-edit.pl:329
29274 "Remember when matching the end of a line that C<$_> may contain the final C<"
29275 "\\n>, or (for DOS files) C<\\r\\n>, or if the file does not end with a "
29276 "newline then neither of these. Thus to match or substitute some text at the "
29277 "end of a line, use this regular expression:"
29281 #: ../tools/virt-edit.pl:334
29284 " /some text(\\r?\\n)?$/\n"
29289 #: ../tools/virt-edit.pl:336
29291 "Alternately, use the perl C<chomp> function, being careful not to chomp C<"
29292 "$_> itself (since that would remove all newlines from the file):"
29296 #: ../tools/virt-edit.pl:340
29299 " my $m = $_; chomp $m; $m =~ /some text$/\n"
29304 #: ../tools/virt-edit.pl:344
29306 "C<virt-edit> has a limited ability to understand Windows drive letters and "
29307 "paths (eg. C<E:\\foo\\bar.txt>)."
29311 #: ../tools/virt-edit.pl:347
29312 msgid "If and only if the guest is running Windows then:"
29316 #: ../tools/virt-edit.pl:353
29318 "Drive letter prefixes like C<C:> are resolved against the Windows Registry "
29319 "to the correct filesystem."
29323 #: ../tools/virt-edit.pl:358
29325 "Any backslash (C<\\>) characters in the path are replaced with forward "
29326 "slashes so that libguestfs can process it."
29330 #: ../tools/virt-edit.pl:363
29332 "The path is resolved case insensitively to locate the file that should be "
29337 #: ../tools/virt-edit.pl:368
29338 msgid "There are some known shortcomings:"
29342 #: ../tools/virt-edit.pl:374
29343 msgid "Some NTFS symbolic links may not be followed correctly."
29347 #: ../tools/virt-edit.pl:378
29348 msgid "NTFS junction points that cross filesystems are not followed."
29352 #: ../tools/virt-edit.pl:435
29353 msgid "USING GUESTFISH"
29357 #: ../tools/virt-edit.pl:437
29359 "L<guestfish(1)> is a more powerful, lower level tool which you can use when "
29360 "C<virt-edit> doesn't work."
29364 #: ../tools/virt-edit.pl:440
29365 msgid "Using C<virt-edit> is approximately equivalent to doing:"
29369 #: ../tools/virt-edit.pl:442
29372 " guestfish --rw -i -d domname edit /file\n"
29377 #: ../tools/virt-edit.pl:444
29379 "where C<domname> is the name of the libvirt guest, and C</file> is the full "
29380 "path to the file."
29384 #: ../tools/virt-edit.pl:447
29386 "The command above uses libguestfs's guest inspection feature and so does not "
29387 "work on guests that libguestfs cannot inspect, or on things like arbitrary "
29388 "disk images that don't contain guests. To edit a file on a disk image "
29393 #: ../tools/virt-edit.pl:452
29396 " guestfish --rw -a disk.img -m /dev/sda1 edit /file\n"
29401 #: ../tools/virt-edit.pl:454
29403 "where C<disk.img> is the disk image, C</dev/sda1> is the filesystem within "
29404 "the disk image to edit, and C</file> is the full path to the file."
29408 #: ../tools/virt-edit.pl:458
29410 "C<virt-edit> cannot create new files. Use the guestfish commands C<touch>, "
29411 "C<write> or C<upload> instead:"
29415 #: ../tools/virt-edit.pl:461
29418 " guestfish --rw -i -d domname touch /newfile\n"
29423 #: ../tools/virt-edit.pl:463
29426 " guestfish --rw -i -d domname write /newfile \"new content\"\n"
29431 #: ../tools/virt-edit.pl:465
29434 " guestfish --rw -i -d domname upload localfile /newfile\n"
29439 #: ../tools/virt-edit.pl:467
29441 "C<virt-edit> cannot edit multiple files, but guestfish can do it like this:"
29445 #: ../tools/virt-edit.pl:470
29448 " guestfish --rw -i -d domname edit /file1 : edit /file2\n"
29453 #: ../tools/virt-edit.pl:480
29458 #: ../tools/virt-edit.pl:482
29460 "If set, this string is used as the editor. It may contain arguments, eg. C<"
29465 #: ../tools/virt-edit.pl:485
29466 msgid "If not set, C<vi> is used."
29470 #: ../tools/virt-edit.pl:489 ../tools/virt-win-reg.pl:559
29471 #: ../tools/virt-list-filesystems.pl:182 ../tools/virt-tar.pl:279
29472 #: ../tools/virt-make-fs.pl:532 ../tools/virt-list-partitions.pl:250
29473 msgid "SHELL QUOTING"
29477 #: ../tools/virt-edit.pl:491 ../tools/virt-win-reg.pl:567
29478 #: ../tools/virt-list-filesystems.pl:184 ../tools/virt-tar.pl:281
29479 #: ../tools/virt-make-fs.pl:534 ../tools/virt-list-partitions.pl:252
29481 "Libvirt guest names can contain arbitrary characters, some of which have "
29482 "meaning to the shell such as C<#> and space. You may need to quote or "
29483 "escape these characters on the command line. See the shell manual page L<sh"
29484 "(1)> for details."
29488 #: ../tools/virt-edit.pl:498
29490 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, L<virt-"
29491 "tar-in(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, "
29492 "L<http://libguestfs.org/>, L<perl(1)>, L<perlre(1)>."
29496 #: ../tools/virt-edit.pl:510 ../tools/virt-win-reg.pl:598
29497 #: ../tools/virt-list-filesystems.pl:202 ../tools/virt-tar.pl:301
29498 #: ../tools/virt-make-fs.pl:564 ../tools/virt-list-partitions.pl:269
29503 #: ../tools/virt-edit.pl:512 ../tools/virt-win-reg.pl:600
29504 #: ../tools/virt-list-filesystems.pl:204 ../tools/virt-tar.pl:303
29505 #: ../tools/virt-make-fs.pl:566 ../tools/virt-list-partitions.pl:271
29506 msgid "Richard W.M. Jones L<http://people.redhat.com/~rjones/>"
29510 #: ../tools/virt-edit.pl:516
29511 msgid "Copyright (C) 2009-2011 Red Hat Inc."
29515 #: ../tools/virt-win-reg.pl:37
29517 "virt-win-reg - Export and merge Windows Registry entries from a Windows guest"
29521 #: ../tools/virt-win-reg.pl:41
29524 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey'\n"
29529 #: ../tools/virt-win-reg.pl:43
29532 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' name\n"
29537 #: ../tools/virt-win-reg.pl:45
29540 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' @\n"
29545 #: ../tools/virt-win-reg.pl:47
29548 " virt-win-reg --merge domname [input.reg ...]\n"
29553 #: ../tools/virt-win-reg.pl:49
29556 " virt-win-reg [--options] disk.img ... # instead of domname\n"
29561 #: ../tools/virt-win-reg.pl:53
29563 "You must I<not> use C<virt-win-reg> with the I<--merge> option on live "
29564 "virtual machines. If you do this, you I<will> get irreversible disk "
29565 "corruption in the VM. C<virt-win-reg> tries to stop you from doing this, "
29566 "but doesn't catch all cases."
29570 #: ../tools/virt-win-reg.pl:58
29572 "Modifying the Windows Registry is an inherently risky operation. The format "
29573 "is deliberately obscure and undocumented, and Registry changes can leave the "
29574 "system unbootable. Therefore when using the I<--merge> option, make sure "
29575 "you have a reliable backup first."
29579 #: ../tools/virt-win-reg.pl:65
29581 "This program can export and merge Windows Registry entries from a Windows "
29586 #: ../tools/virt-win-reg.pl:68
29588 "The first parameter is the libvirt guest name or the raw disk image of a "
29593 #: ../tools/virt-win-reg.pl:71
29595 "If I<--merge> is I<not> specified, then the chosen registry key is displayed/"
29596 "exported (recursively). For example:"
29600 #: ../tools/virt-win-reg.pl:74
29603 " $ virt-win-reg Windows7 'HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft'\n"
29608 #: ../tools/virt-win-reg.pl:76
29610 "You can also display single values from within registry keys, for example:"
29614 #: ../tools/virt-win-reg.pl:79
29617 " $ cvkey='HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion'\n"
29618 " $ virt-win-reg Windows7 $cvkey ProductName\n"
29619 " Windows 7 Enterprise\n"
29624 #: ../tools/virt-win-reg.pl:83
29626 "With I<--merge>, you can merge a textual regedit file into the Windows "
29631 #: ../tools/virt-win-reg.pl:86
29634 " $ virt-win-reg --merge Windows7 changes.reg\n"
29639 #: ../tools/virt-win-reg.pl:88 ../tools/virt-tar.pl:45
29644 #: ../tools/virt-win-reg.pl:90
29646 "This program is only meant for simple access to the registry. If you want "
29647 "to do complicated things with the registry, we suggest you download the "
29648 "Registry hive files from the guest using L<libguestfs(3)> or L<guestfish(1)> "
29649 "and access them locally, eg. using L<hivex(3)>, L<hivexsh(1)> or "
29650 "L<hivexregedit(1)>."
29654 #: ../tools/virt-win-reg.pl:120 ../tools/virt-make-fs.pl:177
29659 #: ../tools/virt-win-reg.pl:122
29660 msgid "Enable debugging messages."
29664 #: ../tools/virt-win-reg.pl:157
29669 #: ../tools/virt-win-reg.pl:159
29671 "In merge mode, this merges a textual regedit file into the Windows Registry "
29672 "of the virtual machine. If this flag is I<not> given then virt-win-reg "
29673 "displays or exports Registry entries instead."
29677 #: ../tools/virt-win-reg.pl:163
29679 "Note that I<--merge> is I<unsafe> to use on live virtual machines, and will "
29680 "result in disk corruption. However exporting (without this flag) is always "
29685 #: ../tools/virt-win-reg.pl:171
29686 msgid "B<--encoding> UTF-16LE|ASCII"
29690 #: ../tools/virt-win-reg.pl:173
29692 "When merging (only), you may need to specify the encoding for strings to be "
29693 "used in the hive file. This is explained in detail in L<Win::Hivex::Regedit"
29694 "(3)/ENCODING STRINGS>."
29698 #: ../tools/virt-win-reg.pl:177
29700 "The default is to use UTF-16LE, which should work with recent versions of "
29705 #: ../tools/virt-win-reg.pl:402
29706 msgid "SUPPORTED SYSTEMS"
29710 #: ../tools/virt-win-reg.pl:404
29712 "The program currently supports Windows NT-derived guests starting with "
29713 "Windows XP through to at least Windows 7."
29717 #: ../tools/virt-win-reg.pl:407
29719 "Registry support is done for C<HKEY_LOCAL_MACHINE\\SAM>, C<HKEY_LOCAL_MACHINE"
29720 "\\SECURITY>, C<HKEY_LOCAL_MACHINE\\SOFTWARE>, C<HKEY_LOCAL_MACHINE\\SYSTEM> "
29721 "and C<HKEY_USERS\\.DEFAULT>."
29725 #: ../tools/virt-win-reg.pl:411
29727 "You can use C<HKLM> as a shorthand for C<HKEY_LOCAL_MACHINE>, and C<HKU> for "
29732 #: ../tools/virt-win-reg.pl:414
29734 "C<HKEY_USERS\\$SID> and C<HKEY_CURRENT_USER> are B<not> supported at this "
29739 #: ../tools/virt-win-reg.pl:417
29744 #: ../tools/virt-win-reg.pl:419
29746 "C<virt-win-reg> expects that regedit files have already been reencoded in "
29747 "the local encoding. Usually on Linux hosts, this means UTF-8 with Unix-"
29748 "style line endings. Since Windows regedit files are often in UTF-16LE with "
29749 "Windows-style line endings, you may need to reencode the whole file before "
29750 "or after processing."
29754 #: ../tools/virt-win-reg.pl:425
29756 "To reencode a file from Windows format to Linux (before processing it with "
29757 "the I<--merge> option), you would do something like this:"
29761 #: ../tools/virt-win-reg.pl:428
29764 " iconv -f utf-16le -t utf-8 < win.reg | dos2unix > linux.reg\n"
29769 #: ../tools/virt-win-reg.pl:430
29771 "To go in the opposite direction, after exporting and before sending the file "
29772 "to a Windows user, do something like this:"
29776 #: ../tools/virt-win-reg.pl:433
29779 " unix2dos linux.reg | iconv -f utf-8 -t utf-16le > win.reg\n"
29784 #: ../tools/virt-win-reg.pl:435
29785 msgid "For more information about encoding, see L<Win::Hivex::Regedit(3)>."
29789 #: ../tools/virt-win-reg.pl:437
29791 "If you are unsure about the current encoding, use the L<file(1)> command. "
29792 "Recent versions of Windows regedit.exe produce a UTF-16LE file with Windows-"
29793 "style (CRLF) line endings, like this:"
29797 #: ../tools/virt-win-reg.pl:441
29800 " $ file software.reg\n"
29801 " software.reg: Little-endian UTF-16 Unicode text, with very long lines,\n"
29802 " with CRLF line terminators\n"
29807 #: ../tools/virt-win-reg.pl:445
29808 msgid "This file would need conversion before you could I<--merge> it."
29812 #: ../tools/virt-win-reg.pl:447
29813 msgid "CurrentControlSet etc."
29817 #: ../tools/virt-win-reg.pl:449
29819 "Registry keys like C<CurrentControlSet> don't really exist in the Windows "
29820 "Registry at the level of the hive file, and therefore you cannot modify "
29825 #: ../tools/virt-win-reg.pl:453
29827 "C<CurrentControlSet> is usually an alias for C<ControlSet001>. In some "
29828 "circumstances it might refer to another control set. The way to find out is "
29829 "to look at the C<HKLM\\SYSTEM\\Select> key:"
29833 #: ../tools/virt-win-reg.pl:457
29836 " # virt-win-reg WindowsGuest 'HKLM\\SYSTEM\\Select'\n"
29837 " [HKEY_LOCAL_MACHINE\\SYSTEM\\Select]\n"
29838 " \"Current\"=dword:00000001\n"
29839 " \"Default\"=dword:00000001\n"
29840 " \"Failed\"=dword:00000000\n"
29841 " \"LastKnownGood\"=dword:00000002\n"
29846 #: ../tools/virt-win-reg.pl:464
29847 msgid "\"Current\" is the one which Windows will choose when it boots."
29851 #: ../tools/virt-win-reg.pl:466
29853 "Similarly, other C<Current...> keys in the path may need to be replaced."
29857 #: ../tools/virt-win-reg.pl:469
29858 msgid "WINDOWS TIPS"
29862 #: ../tools/virt-win-reg.pl:471
29864 "Note that some of these tips modify the guest disk image. The guest I<must> "
29865 "be shut off, else you will get disk corruption."
29869 #: ../tools/virt-win-reg.pl:474
29870 msgid "RUNNING A BATCH SCRIPT WHEN A USER LOGS IN"
29874 #: ../tools/virt-win-reg.pl:476
29876 "Prepare a DOS batch script, VBScript or executable. Upload this using "
29877 "L<guestfish(1)>. For this example the script is called C<test.bat> and it "
29878 "is uploaded into C<C:\\>:"
29882 #: ../tools/virt-win-reg.pl:480
29885 " guestfish -i -d WindowsGuest upload test.bat /test.bat\n"
29890 #: ../tools/virt-win-reg.pl:482
29891 msgid "Prepare a regedit file containing the registry change:"
29895 #: ../tools/virt-win-reg.pl:484
29898 " cat > test.reg <<'EOF'\n"
29899 " [HKLM\\Software\\Microsoft\\Windows\\CurrentVersion\\RunOnce]\n"
29900 " \"Test\"=\"c:\\\\test.bat\"\n"
29906 #: ../tools/virt-win-reg.pl:489
29908 "In this example we use the key C<RunOnce> which means that the script will "
29909 "run precisely once when the first user logs in. If you want it to run every "
29910 "time a user logs in, replace C<RunOnce> with C<Run>."
29914 #: ../tools/virt-win-reg.pl:493
29915 msgid "Now update the registry:"
29919 #: ../tools/virt-win-reg.pl:495
29922 " virt-win-reg --merge WindowsGuest test.reg\n"
29927 #: ../tools/virt-win-reg.pl:497
29928 msgid "INSTALLING A SERVICE"
29932 #: ../tools/virt-win-reg.pl:499
29934 "This section assumes you are familiar with Windows services, and you either "
29935 "have a program which handles the Windows Service Control Protocol directly "
29936 "or you want to run any program using a service wrapper like SrvAny or the "
29941 #: ../tools/virt-win-reg.pl:504
29943 "First upload the program and optionally the service wrapper. In this case "
29944 "the test program is called C<test.exe> and we are using the RHSrvAny wrapper:"
29948 #: ../tools/virt-win-reg.pl:508
29951 " guestfish -i -d WindowsGuest <<EOF\n"
29952 " upload rhsrvany.exe /rhsrvany.exe\n"
29953 " upload test.exe /test.exe\n"
29959 #: ../tools/virt-win-reg.pl:513
29961 "Prepare a regedit file containing the registry changes. In this example, "
29962 "the first registry change is needed for the service itself or the service "
29963 "wrapper (if used). The second registry change is only needed because I am "
29964 "using the RHSrvAny service wrapper."
29968 #: ../tools/virt-win-reg.pl:518
29971 " cat > service.reg <<'EOF'\n"
29972 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny]\n"
29973 " \"Type\"=dword:00000010\n"
29974 " \"Start\"=dword:00000002\n"
29975 " \"ErrorControl\"=dword:00000001\n"
29976 " \"ImagePath\"=\"c:\\\\rhsrvany.exe\"\n"
29977 " \"DisplayName\"=\"RHSrvAny\"\n"
29978 " \"ObjectName\"=\"NetworkService\"\n"
29983 #: ../tools/virt-win-reg.pl:527
29986 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny\\Parameters]\n"
29987 " \"CommandLine\"=\"c:\\\\test.exe\"\n"
29988 " \"PWD\"=\"c:\\\\Temp\"\n"
29994 #: ../tools/virt-win-reg.pl:538
29996 "For use of C<ControlSet001> see the section above in this manual page. You "
29997 "may need to adjust this according to the control set that is in use by the "
30002 #: ../tools/virt-win-reg.pl:544
30004 "C<\"ObjectName\"> controls the privileges that the service will have. An "
30005 "alternative is C<\"ObjectName\"=\"LocalSystem\"> which would be the most "
30006 "privileged account."
30010 #: ../tools/virt-win-reg.pl:550
30012 "For the meaning of the magic numbers, see this Microsoft KB article: "
30013 "L<http://support.microsoft.com/kb/103000>."
30017 #: ../tools/virt-win-reg.pl:555
30018 msgid "Update the registry:"
30022 #: ../tools/virt-win-reg.pl:557
30025 " virt-win-reg --merge WindowsGuest service.reg\n"
30030 #: ../tools/virt-win-reg.pl:561
30032 "Be careful when passing parameters containing C<\\> (backslash) in the "
30033 "shell. Usually you will have to use 'single quotes' or double backslashes "
30034 "(but not both) to protect them from the shell."
30038 #: ../tools/virt-win-reg.pl:565
30039 msgid "Paths and value names are case-insensitive."
30043 #: ../tools/virt-win-reg.pl:574
30045 "L<hivex(3)>, L<hivexsh(1)>, L<hivexregedit(1)>, L<guestfs(3)>, L<guestfish(1)"
30046 ">, L<virt-cat(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Win::Hivex"
30047 "(3)>, L<Win::Hivex::Regedit(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
30051 #: ../tools/virt-win-reg.pl:589 ../tools/virt-make-fs.pl:555
30053 "When reporting bugs, please enable debugging and capture the I<complete> "
30058 #: ../tools/virt-win-reg.pl:592
30061 " export LIBGUESTFS_DEBUG=1\n"
30062 " virt-win-reg --debug [... rest ...] > /tmp/virt-win-reg.log 2>&1\n"
30067 #: ../tools/virt-win-reg.pl:595
30069 "Attach /tmp/virt-win-reg.log to a new bug report at L<https://bugzilla."
30074 #: ../tools/virt-win-reg.pl:604 ../tools/virt-make-fs.pl:570
30075 msgid "Copyright (C) 2010 Red Hat Inc."
30079 #: ../tools/virt-list-filesystems.pl:32
30081 "virt-list-filesystems - List filesystems in a virtual machine or disk image"
30085 #: ../tools/virt-list-filesystems.pl:36
30088 " virt-list-filesystems [--options] domname\n"
30093 #: ../tools/virt-list-filesystems.pl:38
30096 " virt-list-filesystems [--options] disk.img [disk.img ...]\n"
30101 #: ../tools/virt-list-filesystems.pl:42 ../tools/virt-list-partitions.pl:42
30103 "This tool is obsolete. Use L<virt-filesystems(1)> as a more flexible "
30108 #: ../tools/virt-list-filesystems.pl:45
30110 "C<virt-list-filesystems> is a command line tool to list the filesystems that "
30111 "are contained in a virtual machine or disk image."
30115 #: ../tools/virt-list-filesystems.pl:49
30117 "C<virt-list-filesystems> is just a simple wrapper around L<libguestfs(3)> "
30118 "functionality. For more complex cases you should look at the L<guestfish(1)"
30123 #: ../tools/virt-list-filesystems.pl:106 ../tools/virt-list-partitions.pl:115
30124 msgid "B<-l> | B<--long>"
30128 #: ../tools/virt-list-filesystems.pl:108
30130 "With this option, C<virt-list-filesystems> displays the type of each "
30131 "filesystem too (where \"type\" means C<ext3>, C<xfs> etc.)"
30135 #: ../tools/virt-list-filesystems.pl:115
30136 msgid "B<-a> | B<--all>"
30140 #: ../tools/virt-list-filesystems.pl:117
30142 "Normally we only show mountable filesystems. If this option is given then "
30143 "swap devices are shown too."
30147 #: ../tools/virt-list-filesystems.pl:191
30149 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, L<virt-"
30150 "filesystems(1)>, L<virt-list-partitions(1)>, L<Sys::Guestfs(3)>, L<Sys::"
30151 "Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
30155 #: ../tools/virt-list-filesystems.pl:208 ../tools/virt-tar.pl:307
30156 msgid "Copyright (C) 2009 Red Hat Inc."
30160 #: ../tools/virt-tar.pl:33
30161 msgid "virt-tar - Extract or upload files to a virtual machine"
30165 #: ../tools/virt-tar.pl:37
30168 " virt-tar [--options] -x domname directory tarball\n"
30173 #: ../tools/virt-tar.pl:39
30176 " virt-tar [--options] -u domname tarball directory\n"
30181 #: ../tools/virt-tar.pl:41
30184 " virt-tar [--options] disk.img [disk.img ...] -x directory tarball\n"
30189 #: ../tools/virt-tar.pl:43
30192 " virt-tar [--options] disk.img [disk.img ...] -u tarball directory\n"
30197 #: ../tools/virt-tar.pl:47
30199 "This tool is obsolete. Use L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-"
30200 "tar-in(1)>, L<virt-tar-out(1)> as replacements."
30204 #: ../tools/virt-tar.pl:52
30205 msgid "Download C</home> from the VM into a local tarball:"
30209 #: ../tools/virt-tar.pl:54
30212 " virt-tar -x domname /home home.tar\n"
30217 #: ../tools/virt-tar.pl:56
30220 " virt-tar -zx domname /home home.tar.gz\n"
30225 #: ../tools/virt-tar.pl:58
30226 msgid "Upload a local tarball and unpack it inside C</tmp> in the VM:"
30230 #: ../tools/virt-tar.pl:60
30233 " virt-tar -u domname uploadstuff.tar /tmp\n"
30238 #: ../tools/virt-tar.pl:62
30241 " virt-tar -zu domname uploadstuff.tar.gz /tmp\n"
30246 #: ../tools/virt-tar.pl:66
30248 "You must I<not> use C<virt-tar> with the I<-u> option (upload) on live "
30249 "virtual machines. If you do this, you risk disk corruption in the VM. "
30250 "C<virt-tar> tries to stop you from doing this, but doesn't catch all cases."
30254 #: ../tools/virt-tar.pl:71
30256 "You can use I<-x> (extract) on live virtual machines, but you might get "
30257 "inconsistent results or errors if there is filesystem activity inside the "
30258 "VM. If the live VM is synched and quiescent, then C<virt-tar> will usually "
30259 "work, but the only way to guarantee consistent results is if the virtual "
30260 "machine is shut down."
30264 #: ../tools/virt-tar.pl:79
30266 "C<virt-tar> is a general purpose archive tool for downloading and uploading "
30267 "parts of a guest filesystem. There are many possibilities: making backups, "
30268 "uploading data files, snooping on guest activity, fixing or customizing "
30273 #: ../tools/virt-tar.pl:84
30275 "If you want to just view a single file, use L<virt-cat(1)>. If you just "
30276 "want to edit a single file, use L<virt-edit(1)>. For more complex cases you "
30277 "should look at the L<guestfish(1)> tool."
30281 #: ../tools/virt-tar.pl:88
30283 "There are two modes of operation: I<-x> (eXtract) downloads a directory and "
30284 "its contents (recursively) from the virtual machine into a local tarball. "
30285 "I<-u> uploads from a local tarball, unpacking it into a directory inside the "
30286 "virtual machine. You cannot use these two options together."
30290 #: ../tools/virt-tar.pl:94
30292 "In addition, you may need to use the I<-z> (gZip) option to enable "
30293 "compression. When uploading, you have to specify I<-z> if the upload file "
30294 "is compressed because virt-tar won't detect this on its own."
30298 #: ../tools/virt-tar.pl:98
30300 "C<virt-tar> can only handle tar (optionally gzipped) format tarballs. For "
30301 "example it cannot do PKZip files or bzip2 compression. If you want that "
30302 "then you'll have to rebuild the tarballs yourself. (This is a limitation of "
30303 "the L<libguestfs(3)> API)."
30307 #: ../tools/virt-tar.pl:156
30308 msgid "B<-x> | B<--extract> | B<--download>"
30312 #: ../tools/virt-tar.pl:158
30313 msgid "B<-u> | B<--upload>"
30317 #: ../tools/virt-tar.pl:160
30319 "Use I<-x> to extract (download) a directory from a virtual machine to a "
30324 #: ../tools/virt-tar.pl:163
30326 "Use I<-u> to upload and unpack from a local tarball into a virtual machine. "
30327 "Please read the L</WARNING> section above before using this option."
30331 #: ../tools/virt-tar.pl:167
30332 msgid "You must specify exactly one of these options."
30336 #: ../tools/virt-tar.pl:173
30337 msgid "B<-z> | B<--gzip>"
30341 #: ../tools/virt-tar.pl:175
30342 msgid "Specify that the input or output tarball is gzip-compressed."
30346 #: ../tools/virt-tar.pl:288
30348 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, L<virt-copy-"
30349 "in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<Sys::"
30350 "Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs."
30355 #: ../tools/virt-make-fs.pl:37
30356 msgid "virt-make-fs - Make a filesystem from a tar archive or files"
30360 #: ../tools/virt-make-fs.pl:41
30363 " virt-make-fs [--options] input.tar output.img\n"
30368 #: ../tools/virt-make-fs.pl:43
30371 " virt-make-fs [--options] input.tar.gz output.img\n"
30376 #: ../tools/virt-make-fs.pl:45
30379 " virt-make-fs [--options] directory output.img\n"
30384 #: ../tools/virt-make-fs.pl:49
30386 "Virt-make-fs is a command line tool for creating a filesystem from a tar "
30387 "archive or some files in a directory. It is similar to tools like L<mkisofs"
30388 "(1)>, L<genisoimage(1)> and L<mksquashfs(1)>. Unlike those tools, it can "
30389 "create common filesystem types like ext2/3 or NTFS, which can be useful if "
30390 "you want to attach these filesystems to existing virtual machines (eg. to "
30391 "import large amounts of read-only data to a VM)."
30395 #: ../tools/virt-make-fs.pl:57
30396 msgid "Basic usage is:"
30400 #: ../tools/virt-make-fs.pl:59
30403 " virt-make-fs input output\n"
30408 #: ../tools/virt-make-fs.pl:61
30410 "where C<input> is either a directory containing files that you want to add, "
30411 "or a tar archive (either uncompressed tar or gzip-compressed tar); and "
30412 "C<output> is a disk image. The input type is detected automatically. The "
30413 "output disk image defaults to a raw ext2 image unless you specify extra "
30414 "flags (see L</OPTIONS> below)."
30418 #: ../tools/virt-make-fs.pl:67
30419 msgid "EXTRA SPACE"
30423 #: ../tools/virt-make-fs.pl:69
30425 "Unlike formats such as tar and squashfs, a filesystem does not \"just fit\" "
30426 "the files that it contains, but might have extra space. Depending on how "
30427 "you are going to use the output, you might think this extra space is wasted "
30428 "and want to minimize it, or you might want to leave space so that more files "
30429 "can be added later. Virt-make-fs defaults to minimizing the extra space, "
30430 "but you can use the I<--size> flag to leave space in the filesystem if you "
30435 #: ../tools/virt-make-fs.pl:77
30437 "An alternative way to leave extra space but not make the output image any "
30438 "bigger is to use an alternative disk image format (instead of the default "
30439 "\"raw\" format). Using I<--format=qcow2> will use the native QEmu/KVM qcow2 "
30440 "image format (check your hypervisor supports this before using it). This "
30441 "allows you to choose a large I<--size> but the extra space won't actually be "
30442 "allocated in the image until you try to store something in it."
30446 #: ../tools/virt-make-fs.pl:85
30448 "Don't forget that you can also use local commands including L<resize2fs(8)> "
30449 "and L<virt-resize(1)> to resize existing filesystems, or rerun virt-make-fs "
30450 "to build another image from scratch."
30454 #: ../tools/virt-make-fs.pl:89 ../tools/virt-make-fs.pl:123
30455 #: ../tools/virt-make-fs.pl:142
30460 #: ../tools/virt-make-fs.pl:91
30463 " virt-make-fs --format=qcow2 --size=+200M input output.img\n"
30468 #: ../tools/virt-make-fs.pl:93
30469 msgid "FILESYSTEM TYPE"
30473 #: ../tools/virt-make-fs.pl:95
30475 "The default filesystem type is C<ext2>. Just about any filesystem type that "
30476 "libguestfs supports can be used (but I<not> read-only formats like "
30477 "ISO9660). Here are some of the more common choices:"
30481 #: ../tools/virt-make-fs.pl:101
30486 #: ../tools/virt-make-fs.pl:103
30488 "Note that ext3 filesystems contain a journal, typically 1-32 MB in size. If "
30489 "you are not going to use the filesystem in a way that requires the journal, "
30490 "then this is just wasted overhead."
30494 #: ../tools/virt-make-fs.pl:107
30495 msgid "I<ntfs> or I<vfat>"
30499 #: ../tools/virt-make-fs.pl:109
30500 msgid "Useful if exporting data to a Windows guest."
30504 #: ../tools/virt-make-fs.pl:111
30506 "I<Note for vfat>: The tar archive or local directory must only contain files "
30507 "which are owned by root (ie. UID:GID = 0:0). The reason is that the tar "
30508 "program running within libguestfs is unable to change the ownership of non-"
30509 "root files, since vfat itself does not support this."
30513 #: ../tools/virt-make-fs.pl:116
30518 #: ../tools/virt-make-fs.pl:118
30520 "Lower overhead than C<ext2>, but certain limitations on filename length and "
30521 "total filesystem size."
30525 #: ../tools/virt-make-fs.pl:125
30528 " virt-make-fs --type=minix input minixfs.img\n"
30533 #: ../tools/virt-make-fs.pl:127
30534 msgid "TO PARTITION OR NOT TO PARTITION"
30538 #: ../tools/virt-make-fs.pl:129
30539 msgid "Optionally virt-make-fs can add a partition table to the output disk."
30543 #: ../tools/virt-make-fs.pl:131
30545 "Adding a partition can make the disk image more compatible with certain "
30546 "virtualized operating systems which don't expect to see a filesystem "
30547 "directly located on a block device (Linux doesn't care and will happily "
30548 "handle both types)."
30552 #: ../tools/virt-make-fs.pl:136
30554 "On the other hand, if you have a partition table then the output image is no "
30555 "longer a straight filesystem. For example you cannot run L<fsck(8)> "
30556 "directly on a partitioned disk image. (However libguestfs tools such as "
30557 "L<guestfish(1)> and L<virt-resize(1)> can still be used)."
30561 #: ../tools/virt-make-fs.pl:144
30562 msgid "Add an MBR partition:"
30566 #: ../tools/virt-make-fs.pl:146
30569 " virt-make-fs --partition -- input disk.img\n"
30574 #: ../tools/virt-make-fs.pl:148
30576 "If the output disk image could be terabyte-sized or larger, it's better to "
30577 "use an EFI/GPT-compatible partition table:"
30581 #: ../tools/virt-make-fs.pl:151
30584 " virt-make-fs --partition=gpt --size=+4T --format=qcow2 input disk.img\n"
30589 #: ../tools/virt-make-fs.pl:179
30590 msgid "Enable debugging information."
30594 #: ../tools/virt-make-fs.pl:185
30595 msgid "B<--size=E<lt>NE<gt>>"
30599 #: ../tools/virt-make-fs.pl:187
30600 msgid "B<--size=+E<lt>NE<gt>>"
30604 #: ../tools/virt-make-fs.pl:189
30605 msgid "B<-s E<lt>NE<gt>>"
30609 #: ../tools/virt-make-fs.pl:191
30610 msgid "B<-s +E<lt>NE<gt>>"
30614 #: ../tools/virt-make-fs.pl:193
30616 "Use the I<--size> (or I<-s>) option to choose the size of the output image."
30620 #: ../tools/virt-make-fs.pl:196
30622 "If this option is I<not> given, then the output image will be just large "
30623 "enough to contain all the files, with not much wasted space."
30627 #: ../tools/virt-make-fs.pl:199
30629 "To choose a fixed size output disk, specify an absolute number followed by b/"
30630 "K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
30631 "Petabytes or Exabytes. This must be large enough to contain all the input "
30632 "files, else you will get an error."
30636 #: ../tools/virt-make-fs.pl:204
30638 "To leave extra space, specify C<+> (plus sign) and a number followed by b/K/"
30639 "M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
30640 "Petabytes or Exabytes. For example: I<--size=+200M> means enough space for "
30641 "the input files, and (approximately) an extra 200 MB free space."
30645 #: ../tools/virt-make-fs.pl:210
30647 "Note that virt-make-fs estimates free space, and therefore will not produce "
30648 "filesystems containing precisely the free space requested. (It is much more "
30649 "expensive and time-consuming to produce a filesystem which has precisely the "
30650 "desired free space)."
30654 #: ../tools/virt-make-fs.pl:219
30655 msgid "B<--format=E<lt>fmtE<gt>>"
30659 #: ../tools/virt-make-fs.pl:221
30660 msgid "B<-F E<lt>fmtE<gt>>"
30664 #: ../tools/virt-make-fs.pl:223
30665 msgid "Choose the output disk image format."
30669 #: ../tools/virt-make-fs.pl:225
30670 msgid "The default is C<raw> (raw disk image)."
30674 #: ../tools/virt-make-fs.pl:227
30676 "For other choices, see the L<qemu-img(1)> manpage. The only other choice "
30677 "that would really make sense here is C<qcow2>."
30681 #: ../tools/virt-make-fs.pl:234
30682 msgid "B<--type=E<lt>fsE<gt>>"
30686 #: ../tools/virt-make-fs.pl:236
30687 msgid "B<-t E<lt>fsE<gt>>"
30691 #: ../tools/virt-make-fs.pl:238
30692 msgid "Choose the output filesystem type."
30696 #: ../tools/virt-make-fs.pl:240
30697 msgid "The default is C<ext2>."
30701 #: ../tools/virt-make-fs.pl:242
30703 "Any filesystem which is supported read-write by libguestfs can be used here."
30707 #: ../tools/virt-make-fs.pl:249
30708 msgid "B<--partition>"
30712 #: ../tools/virt-make-fs.pl:251
30713 msgid "B<--partition=E<lt>parttypeE<gt>>"
30717 #: ../tools/virt-make-fs.pl:253
30719 "If specified, this flag adds an MBR partition table to the output disk image."
30723 #: ../tools/virt-make-fs.pl:256
30725 "You can change the partition table type, eg. I<--partition=gpt> for large "
30730 #: ../tools/virt-make-fs.pl:259
30732 "Note that if you just use a lonesome I<--partition>, the Perl option parser "
30733 "might consider the next parameter to be the partition type. For example:"
30737 #: ../tools/virt-make-fs.pl:263
30740 " virt-make-fs --partition input.tar ...\n"
30745 #: ../tools/virt-make-fs.pl:265
30747 "would cause virt-make-fs to think you wanted to use a partition type of "
30748 "C<input.tar> which is completely wrong. To avoid this, use I<--> (a double "
30749 "dash) between options and the input file argument:"
30753 #: ../tools/virt-make-fs.pl:269
30756 " virt-make-fs --partition -- input.tar ...\n"
30761 #: ../tools/virt-make-fs.pl:541
30763 "L<guestfish(1)>, L<virt-resize(1)>, L<virt-tar-in(1)>, L<mkisofs(1)>, "
30764 "L<genisoimage(1)>, L<mksquashfs(1)>, L<mke2fs(8)>, L<resize2fs(8)>, L<guestfs"
30765 "(3)>, L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
30769 #: ../tools/virt-make-fs.pl:558
30772 " export LIBGUESTFS_DEBUG=1\n"
30773 " virt-make-fs --debug [...] > /tmp/virt-make-fs.log 2>&1\n"
30778 #: ../tools/virt-make-fs.pl:561
30780 "Attach /tmp/virt-make-fs.log to a new bug report at L<https://bugzilla."
30785 #: ../tools/virt-list-partitions.pl:32
30787 "virt-list-partitions - List partitions in a virtual machine or disk image"
30791 #: ../tools/virt-list-partitions.pl:36
30794 " virt-list-partitions [--options] domname\n"
30799 #: ../tools/virt-list-partitions.pl:38
30802 " virt-list-partitions [--options] disk.img [disk.img ...]\n"
30807 #: ../tools/virt-list-partitions.pl:45
30809 "C<virt-list-partitions> is a command line tool to list the partitions that "
30810 "are contained in a virtual machine or disk image. It is mainly useful as a "
30811 "first step to using L<virt-resize(1)>."
30815 #: ../tools/virt-list-partitions.pl:50
30817 "C<virt-list-partitions> is just a simple wrapper around L<libguestfs(3)> "
30818 "functionality. For more complex cases you should look at the L<guestfish(1)"
30823 #: ../tools/virt-list-partitions.pl:107
30824 msgid "B<-h> | B<--human-readable>"
30828 #: ../tools/virt-list-partitions.pl:109
30829 msgid "Show sizes in human-readable form (eg. \"1G\")."
30833 #: ../tools/virt-list-partitions.pl:117
30835 "With this option, C<virt-list-partitions> displays the type and size of each "
30836 "partition too (where \"type\" means C<ext3>, C<pv> etc.)"
30840 #: ../tools/virt-list-partitions.pl:124
30841 msgid "B<-t> | B<--total>"
30845 #: ../tools/virt-list-partitions.pl:126
30847 "Display the total size of each block device (as a separate row or rows)."
30851 #: ../tools/virt-list-partitions.pl:259
30853 "L<guestfs(3)>, L<guestfish(1)>, L<virt-filesystems(1)>, L<virt-list-"
30854 "filesystems(1)>, L<virt-resize(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib"
30855 "(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
30859 #: ../tools/virt-list-partitions.pl:275
30860 msgid "Copyright (C) 2009-2010 Red Hat Inc."