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-07-06 15:21+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-win-reg.pl:35 ../tools/virt-list-filesystems.pl:30
25 #: ../tools/virt-tar.pl:31 ../tools/virt-make-fs.pl:35
26 #: ../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-win-reg.pl:39 ../tools/virt-list-filesystems.pl:34
41 #: ../tools/virt-tar.pl:35 ../tools/virt-make-fs.pl:39
42 #: ../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-win-reg.pl:63 ../tools/virt-list-filesystems.pl:40
96 #: ../tools/virt-tar.pl:77 ../tools/virt-make-fs.pl:47
97 #: ../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:1754 ../src/guestfs.pod:1759 ../src/guestfs.pod:1763
864 #: ../src/guestfs.pod:1773 ../src/guestfs.pod:2008 ../src/guestfs.pod:2013
865 #: ../src/guestfs.pod:2019 ../src/guestfs.pod:2027 ../src/guestfs.pod:2381
866 #: ../src/guestfs.pod:2387 ../src/guestfs.pod:2392 ../src/guestfs.pod:2398
867 #: ../src/guestfs.pod:2972 ../src/guestfs.pod:2976 ../src/guestfs.pod:2980
868 #: ../src/guestfs.pod:2984 ../src/guestfs-actions.pod:15
869 #: ../src/guestfs-actions.pod:22 ../src/guestfs-actions.pod:583
870 #: ../src/guestfs-actions.pod:591 ../src/guestfs-actions.pod:598
871 #: ../src/guestfs-actions.pod:605 ../src/guestfs-actions.pod:1603
872 #: ../src/guestfs-actions.pod:1607 ../src/guestfs-actions.pod:1611
873 #: ../src/guestfs-actions.pod:1615 ../src/guestfs-actions.pod:1623
874 #: ../src/guestfs-actions.pod:1627 ../src/guestfs-actions.pod:1631
875 #: ../src/guestfs-actions.pod:1641 ../src/guestfs-actions.pod:1645
876 #: ../src/guestfs-actions.pod:1649 ../src/guestfs-actions.pod:1787
877 #: ../src/guestfs-actions.pod:1791 ../src/guestfs-actions.pod:1796
878 #: ../src/guestfs-actions.pod:1801 ../src/guestfs-actions.pod:1862
879 #: ../src/guestfs-actions.pod:1866 ../src/guestfs-actions.pod:1871
880 #: ../src/guestfs-actions.pod:2789 ../src/guestfs-actions.pod:2795
881 #: ../src/guestfs-actions.pod:2803 ../src/guestfs-actions.pod:2810
882 #: ../src/guestfs-actions.pod:2817 ../fish/guestfish.pod:445
883 #: ../fish/guestfish.pod:449 ../fish/guestfish.pod:453
884 #: ../fish/guestfish.pod:457 ../fish/guestfish-actions.pod:13
885 #: ../fish/guestfish-actions.pod:20 ../fish/guestfish-actions.pod:385
886 #: ../fish/guestfish-actions.pod:393 ../fish/guestfish-actions.pod:400
887 #: ../fish/guestfish-actions.pod:407 ../fish/guestfish-actions.pod:1074
888 #: ../fish/guestfish-actions.pod:1078 ../fish/guestfish-actions.pod:1082
889 #: ../fish/guestfish-actions.pod:1086 ../fish/guestfish-actions.pod:1094
890 #: ../fish/guestfish-actions.pod:1098 ../fish/guestfish-actions.pod:1102
891 #: ../fish/guestfish-actions.pod:1112 ../fish/guestfish-actions.pod:1116
892 #: ../fish/guestfish-actions.pod:1120 ../fish/guestfish-actions.pod:1210
893 #: ../fish/guestfish-actions.pod:1214 ../fish/guestfish-actions.pod:1219
894 #: ../fish/guestfish-actions.pod:1224 ../fish/guestfish-actions.pod:1266
895 #: ../fish/guestfish-actions.pod:1270 ../fish/guestfish-actions.pod:1275
896 #: ../fish/guestfish-actions.pod:1902 ../fish/guestfish-actions.pod:1908
897 #: ../fish/guestfish-actions.pod:1916 ../fish/guestfish-actions.pod:1923
898 #: ../fish/guestfish-actions.pod:1930 ../tools/virt-win-reg.pl:195
899 #: ../tools/virt-win-reg.pl:200 ../tools/virt-win-reg.pl:206
900 #: ../tools/virt-win-reg.pl:708 ../tools/virt-win-reg.pl:714
901 #: ../tools/virt-win-reg.pl:720
906 #: ../src/guestfs.pod:390
908 "The kernel version that the command runs under will be different from what "
913 #: ../src/guestfs.pod:395
915 "If the command needs to communicate with daemons, then most likely they "
920 #: ../src/guestfs.pod:400
921 msgid "The command will be running in limited memory."
925 #: ../src/guestfs.pod:404
927 "The network may not be available unless you enable it (see L</"
928 "guestfs_set_network>)."
932 #: ../src/guestfs.pod:409
933 msgid "Only supports Linux guests (not Windows, BSD, etc)."
937 #: ../src/guestfs.pod:413
939 "Architecture limitations (eg. won't work for a PPC guest on an X86 host)."
943 #: ../src/guestfs.pod:418
945 "For SELinux guests, you may need to enable SELinux and load policy first. "
946 "See L</SELINUX> in this manpage."
950 #: ../src/guestfs.pod:423
952 "I<Security:> It is not safe to run commands from untrusted, possibly "
953 "malicious guests. These commands may attempt to exploit your program by "
954 "sending unexpected output. They could also try to exploit the Linux kernel "
955 "or qemu provided by the libguestfs appliance. They could use the network "
956 "provided by the libguestfs appliance to bypass ordinary network partitions "
957 "and firewalls. They could use the elevated privileges or different SELinux "
958 "context of your program to their advantage."
962 #: ../src/guestfs.pod:432
964 "A secure alternative is to use libguestfs to install a \"firstboot\" script "
965 "(a script which runs when the guest next boots normally), and to have this "
966 "script run the commands you want in the normal context of the running guest, "
967 "network security and so on. For information about other security issues, "
972 #: ../src/guestfs.pod:440
974 "The two main API calls to run commands are L</guestfs_command> and L</"
975 "guestfs_sh> (there are also variations)."
979 #: ../src/guestfs.pod:443
981 "The difference is that L</guestfs_sh> runs commands using the shell, so any "
982 "shell globs, redirections, etc will work."
986 #: ../src/guestfs.pod:446
987 msgid "CONFIGURATION FILES"
988 msgstr "ФАЙЛИ НАЛАШТУВАННЯ"
991 #: ../src/guestfs.pod:448
993 "To read and write configuration files in Linux guest filesystems, we "
994 "strongly recommend using Augeas. For example, Augeas understands how to "
995 "read and write, say, a Linux shadow password file or X.org configuration "
996 "file, and so avoids you having to write that code."
1000 #: ../src/guestfs.pod:453
1002 "The main Augeas calls are bound through the C<guestfs_aug_*> APIs. We don't "
1003 "document Augeas itself here because there is excellent documentation on the "
1004 "L<http://augeas.net/> website."
1008 #: ../src/guestfs.pod:457
1010 "If you don't want to use Augeas (you fool!) then try calling L</"
1011 "guestfs_read_lines> to get the file as a list of lines which you can iterate "
1016 #: ../src/guestfs.pod:461
1021 #: ../src/guestfs.pod:463
1023 "We support SELinux guests. To ensure that labeling happens correctly in "
1024 "SELinux guests, you need to enable SELinux and load the guest's policy:"
1028 #: ../src/guestfs.pod:469 ../src/guestfs.pod:1257 ../src/guestfs.pod:1395
1029 #: ../src/guestfs.pod:2426
1034 #: ../src/guestfs.pod:471
1035 msgid "Before launching, do:"
1039 #: ../src/guestfs.pod:473
1042 " guestfs_set_selinux (g, 1);\n"
1047 #: ../src/guestfs.pod:475 ../src/guestfs.pod:1261 ../src/guestfs.pod:1399
1048 #: ../src/guestfs.pod:2451
1053 #: ../src/guestfs.pod:477
1055 "After mounting the guest's filesystem(s), load the policy. This is best "
1056 "done by running the L<load_policy(8)> command in the guest itself:"
1060 #: ../src/guestfs.pod:481
1063 " guestfs_sh (g, \"/usr/sbin/load_policy\");\n"
1068 #: ../src/guestfs.pod:483
1070 "(Older versions of C<load_policy> require you to specify the name of the "
1075 #: ../src/guestfs.pod:486 ../src/guestfs.pod:1405
1080 #: ../src/guestfs.pod:488
1082 "Optionally, set the security context for the API. The correct security "
1083 "context to use can only be known by inspecting the guest. As an example:"
1087 #: ../src/guestfs.pod:492
1090 " guestfs_setcon (g, \"unconfined_u:unconfined_r:unconfined_t:s0\");\n"
1095 #: ../src/guestfs.pod:496
1096 msgid "This will work for running commands and editing existing files."
1100 #: ../src/guestfs.pod:498
1102 "When new files are created, you may need to label them explicitly, for "
1103 "example by running the external command C<restorecon pathname>."
1107 #: ../src/guestfs.pod:502
1112 #: ../src/guestfs.pod:504
1114 "Certain calls are affected by the current file mode creation mask (the "
1115 "\"umask\"). In particular ones which create files or directories, such as "
1116 "L</guestfs_touch>, L</guestfs_mknod> or L</guestfs_mkdir>. This affects "
1117 "either the default mode that the file is created with or modifies the mode "
1122 #: ../src/guestfs.pod:510
1124 "The default umask is C<022>, so files are created with modes such as C<0644> "
1125 "and directories with C<0755>."
1129 #: ../src/guestfs.pod:513
1131 "There are two ways to avoid being affected by umask. Either set umask to 0 "
1132 "(call C<guestfs_umask (g, 0)> early after launching). Or call L</"
1133 "guestfs_chmod> after creating each file or directory."
1137 #: ../src/guestfs.pod:517
1138 msgid "For more information about umask, see L<umask(2)>."
1142 #: ../src/guestfs.pod:519 ../fish/guestfish.pod:767
1143 msgid "ENCRYPTED DISKS"
1147 #: ../src/guestfs.pod:521
1149 "Libguestfs allows you to access Linux guests which have been encrypted using "
1150 "whole disk encryption that conforms to the Linux Unified Key Setup (LUKS) "
1151 "standard. This includes nearly all whole disk encryption systems used by "
1152 "modern Linux guests."
1156 #: ../src/guestfs.pod:527
1158 "Use L</guestfs_vfs_type> to identify LUKS-encrypted block devices (it "
1159 "returns the string C<crypto_LUKS>)."
1163 #: ../src/guestfs.pod:530
1165 "Then open these devices by calling L</guestfs_luks_open>. Obviously you "
1166 "will require the passphrase!"
1170 #: ../src/guestfs.pod:533
1172 "Opening a LUKS device creates a new device mapper device called C</dev/"
1173 "mapper/mapname> (where C<mapname> is the string you supply to L</"
1174 "guestfs_luks_open>). Reads and writes to this mapper device are decrypted "
1175 "from and encrypted to the underlying block device respectively."
1179 #: ../src/guestfs.pod:539
1181 "LVM volume groups on the device can be made visible by calling L</"
1182 "guestfs_vgscan> followed by L</guestfs_vg_activate_all>. The logical volume"
1183 "(s) can now be mounted in the usual way."
1187 #: ../src/guestfs.pod:543
1189 "Use the reverse process to close a LUKS device. Unmount any logical volumes "
1190 "on it, deactivate the volume groups by caling C<guestfs_vg_activate (g, 0, "
1191 "[\"/dev/VG\"])>. Then close the mapper device by calling L</"
1192 "guestfs_luks_close> on the C</dev/mapper/mapname> device (I<not> the "
1193 "underlying encrypted block device)."
1197 #: ../src/guestfs.pod:550
1202 #: ../src/guestfs.pod:552
1204 "Libguestfs has APIs for inspecting an unknown disk image to find out if it "
1205 "contains operating systems, an install CD or a live CD. (These APIs used to "
1206 "be in a separate Perl-only library called L<Sys::Guestfs::Lib(3)> but since "
1207 "version 1.5.3 the most frequently used part of this library has been "
1208 "rewritten in C and moved into the core code)."
1212 #: ../src/guestfs.pod:559
1214 "Add all disks belonging to the unknown virtual machine and call L</"
1215 "guestfs_launch> in the usual way."
1219 #: ../src/guestfs.pod:562
1221 "Then call L</guestfs_inspect_os>. This function uses other libguestfs calls "
1222 "and certain heuristics, and returns a list of operating systems that were "
1223 "found. An empty list means none were found. A single element is the root "
1224 "filesystem of the operating system. For dual- or multi-boot guests, "
1225 "multiple roots can be returned, each one corresponding to a separate "
1226 "operating system. (Multi-boot virtual machines are extremely rare in the "
1227 "world of virtualization, but since this scenario can happen, we have built "
1228 "libguestfs to deal with it.)"
1232 #: ../src/guestfs.pod:571
1234 "For each root, you can then call various C<guestfs_inspect_get_*> functions "
1235 "to get additional details about that operating system. For example, call L</"
1236 "guestfs_inspect_get_type> to return the string C<windows> or C<linux> for "
1237 "Windows and Linux-based operating systems respectively."
1241 #: ../src/guestfs.pod:577
1243 "Un*x-like and Linux-based operating systems usually consist of several "
1244 "filesystems which are mounted at boot time (for example, a separate boot "
1245 "partition mounted on C</boot>). The inspection rules are able to detect how "
1246 "filesystems correspond to mount points. Call "
1247 "C<guestfs_inspect_get_mountpoints> to get this mapping. It might return a "
1248 "hash table like this example:"
1252 #: ../src/guestfs.pod:584
1255 " /boot => /dev/sda1\n"
1256 " / => /dev/vg_guest/lv_root\n"
1257 " /usr => /dev/vg_guest/lv_usr\n"
1262 #: ../src/guestfs.pod:588
1264 "The caller can then make calls to L</guestfs_mount_options> to mount the "
1265 "filesystems as suggested."
1269 #: ../src/guestfs.pod:591
1271 "Be careful to mount filesystems in the right order (eg. C</> before C</"
1272 "usr>). Sorting the keys of the hash by length, shortest first, should work."
1276 #: ../src/guestfs.pod:595
1278 "Inspection currently only works for some common operating systems. "
1279 "Contributors are welcome to send patches for other operating systems that we "
1280 "currently cannot detect."
1284 #: ../src/guestfs.pod:599
1286 "Encrypted disks must be opened before inspection. See L</ENCRYPTED DISKS> "
1287 "for more details. The L</guestfs_inspect_os> function just ignores any "
1288 "encrypted devices."
1292 #: ../src/guestfs.pod:603
1294 "A note on the implementation: The call L</guestfs_inspect_os> performs "
1295 "inspection and caches the results in the guest handle. Subsequent calls to "
1296 "C<guestfs_inspect_get_*> return this cached information, but I<do not> re-"
1297 "read the disks. If you change the content of the guest disks, you can redo "
1298 "inspection by calling L</guestfs_inspect_os> again. (L</"
1299 "guestfs_inspect_list_applications> works a little differently from the other "
1300 "calls and does read the disks. See documentation for that function for "
1305 #: ../src/guestfs.pod:612
1306 msgid "INSPECTING INSTALL DISKS"
1310 #: ../src/guestfs.pod:614
1312 "Libguestfs (since 1.9.4) can detect some install disks, install CDs, live "
1317 #: ../src/guestfs.pod:617
1319 "Call L</guestfs_inspect_get_format> to return the format of the operating "
1320 "system, which currently can be C<installed> (a regular operating system) or "
1321 "C<installer> (some sort of install disk)."
1325 #: ../src/guestfs.pod:621
1327 "Further information is available about the operating system that can be "
1328 "installed using the regular inspection APIs like L</"
1329 "guestfs_inspect_get_product_name>, L</guestfs_inspect_get_major_version> etc."
1333 #: ../src/guestfs.pod:626
1335 "Some additional information specific to installer disks is also available "
1336 "from the L</guestfs_inspect_is_live>, L</guestfs_inspect_is_netinst> and L</"
1337 "guestfs_inspect_is_multipart> calls."
1341 #: ../src/guestfs.pod:631
1342 msgid "SPECIAL CONSIDERATIONS FOR WINDOWS GUESTS"
1346 #: ../src/guestfs.pod:633
1348 "Libguestfs can mount NTFS partitions. It does this using the L<http://www."
1349 "ntfs-3g.org/> driver."
1353 #: ../src/guestfs.pod:636
1354 msgid "DRIVE LETTERS AND PATHS"
1358 #: ../src/guestfs.pod:638
1360 "DOS and Windows still use drive letters, and the filesystems are always "
1361 "treated as case insensitive by Windows itself, and therefore you might find "
1362 "a Windows configuration file referring to a path like C<c:\\windows"
1363 "\\system32>. When the filesystem is mounted in libguestfs, that directory "
1364 "might be referred to as C</WINDOWS/System32>."
1368 #: ../src/guestfs.pod:644
1370 "Drive letter mappings can be found using inspection (see L</INSPECTION> and "
1371 "L</guestfs_inspect_get_drive_mappings>)"
1375 #: ../src/guestfs.pod:647
1377 "Dealing with separator characters (backslash vs forward slash) is outside "
1378 "the scope of libguestfs, but usually a simple character replacement will "
1383 #: ../src/guestfs.pod:651
1385 "To resolve the case insensitivity of paths, call L</"
1386 "guestfs_case_sensitive_path>."
1390 #: ../src/guestfs.pod:654
1391 msgid "ACCESSING THE WINDOWS REGISTRY"
1395 #: ../src/guestfs.pod:656
1397 "Libguestfs also provides some help for decoding Windows Registry \"hive\" "
1398 "files, through the library C<hivex> which is part of the libguestfs project "
1399 "although ships as a separate tarball. You have to locate and download the "
1400 "hive file(s) yourself, and then pass them to C<hivex> functions. See also "
1401 "the programs L<hivexml(1)>, L<hivexsh(1)>, L<hivexregedit(1)> and L<virt-win-"
1402 "reg(1)> for more help on this issue."
1406 #: ../src/guestfs.pod:664
1407 msgid "SYMLINKS ON NTFS-3G FILESYSTEMS"
1411 #: ../src/guestfs.pod:666
1413 "Ntfs-3g tries to rewrite \"Junction Points\" and NTFS \"symbolic links\" to "
1414 "provide something which looks like a Linux symlink. The way it tries to do "
1415 "the rewriting is described here:"
1419 #: ../src/guestfs.pod:670
1421 "L<http://www.tuxera.com/community/ntfs-3g-advanced/junction-points-and-"
1424 "L<http://www.tuxera.com/community/ntfs-3g-advanced/junction-points-and-"
1428 #: ../src/guestfs.pod:672
1430 "The essential problem is that ntfs-3g simply does not have enough "
1431 "information to do a correct job. NTFS links can contain drive letters and "
1432 "references to external device GUIDs that ntfs-3g has no way of resolving. "
1433 "It is almost certainly the case that libguestfs callers should ignore what "
1434 "ntfs-3g does (ie. don't use L</guestfs_readlink> on NTFS volumes)."
1438 #: ../src/guestfs.pod:679
1440 "Instead if you encounter a symbolic link on an ntfs-3g filesystem, use L</"
1441 "guestfs_lgetxattr> to read the C<system.ntfs_reparse_data> extended "
1442 "attribute, and read the raw reparse data from that (you can find the format "
1443 "documented in various places around the web)."
1447 #: ../src/guestfs.pod:684
1448 msgid "EXTENDED ATTRIBUTES ON NTFS-3G FILESYSTEMS"
1452 #: ../src/guestfs.pod:686
1454 "There are other useful extended attributes that can be read from ntfs-3g "
1455 "filesystems (using L</guestfs_getxattr>). See:"
1459 #: ../src/guestfs.pod:689
1461 "L<http://www.tuxera.com/community/ntfs-3g-advanced/extended-attributes/>"
1463 "L<http://www.tuxera.com/community/ntfs-3g-advanced/extended-attributes/>"
1466 #: ../src/guestfs.pod:691
1467 msgid "USING LIBGUESTFS WITH OTHER PROGRAMMING LANGUAGES"
1471 #: ../src/guestfs.pod:693
1473 "Although we don't want to discourage you from using the C API, we will "
1474 "mention here that the same API is also available in other languages."
1478 #: ../src/guestfs.pod:696
1480 "The API is broadly identical in all supported languages. This means that "
1481 "the C call C<guestfs_add_drive_ro(g,file)> is C<$g-E<gt>add_drive_ro($file)> "
1482 "in Perl, C<g.add_drive_ro(file)> in Python, and C<g#add_drive_ro file> in "
1483 "OCaml. In other words, a straightforward, predictable isomorphism between "
1488 #: ../src/guestfs.pod:702
1490 "Error messages are automatically transformed into exceptions if the language "
1495 #: ../src/guestfs.pod:705
1497 "We don't try to \"object orientify\" parts of the API in OO languages, "
1498 "although contributors are welcome to write higher level APIs above what we "
1499 "provide in their favourite languages if they wish."
1503 #: ../src/guestfs.pod:711
1508 #: ../src/guestfs.pod:713
1510 "You can use the I<guestfs.h> header file from C++ programs. The C++ API is "
1511 "identical to the C API. C++ classes and exceptions are not used."
1515 #: ../src/guestfs.pod:717
1520 #: ../src/guestfs.pod:719
1522 "The C# bindings are highly experimental. Please read the warnings at the "
1523 "top of C<csharp/Libguestfs.cs>."
1527 #: ../src/guestfs.pod:722
1532 #: ../src/guestfs.pod:724
1534 "This is the only language binding that is working but incomplete. Only "
1535 "calls which return simple integers have been bound in Haskell, and we are "
1536 "looking for help to complete this binding."
1540 #: ../src/guestfs.pod:728
1545 #: ../src/guestfs.pod:730
1547 "Full documentation is contained in the Javadoc which is distributed with "
1552 #: ../src/guestfs.pod:733
1557 #: ../src/guestfs.pod:735
1558 msgid "See L<guestfs-ocaml(3)>."
1559 msgstr "Див. L<guestfs-ocaml(3)>."
1562 #: ../src/guestfs.pod:737
1567 #: ../src/guestfs.pod:739
1568 msgid "See L<guestfs-perl(3)> and L<Sys::Guestfs(3)>."
1569 msgstr "Див. L<guestfs-perl(3)> та L<Sys::Guestfs(3)>."
1572 #: ../src/guestfs.pod:741
1577 #: ../src/guestfs.pod:743
1579 "For documentation see C<README-PHP> supplied with libguestfs sources or in "
1580 "the php-libguestfs package for your distribution."
1584 #: ../src/guestfs.pod:746
1585 msgid "The PHP binding only works correctly on 64 bit machines."
1589 #: ../src/guestfs.pod:748
1594 #: ../src/guestfs.pod:750
1595 msgid "See L<guestfs-python(3)>."
1596 msgstr "Див. L<guestfs-python(3)>."
1599 #: ../src/guestfs.pod:752
1604 #: ../src/guestfs.pod:754
1605 msgid "See L<guestfs-ruby(3)>."
1606 msgstr "Див. L<guestfs-ruby(3)>."
1609 #: ../src/guestfs.pod:756
1610 msgid "B<shell scripts>"
1611 msgstr "B<скрипти оболонки>"
1614 #: ../src/guestfs.pod:758
1615 msgid "See L<guestfish(1)>."
1616 msgstr "Див. L<guestfish(1)>."
1619 #: ../src/guestfs.pod:762
1620 msgid "LIBGUESTFS GOTCHAS"
1624 #: ../src/guestfs.pod:764
1626 "L<http://en.wikipedia.org/wiki/Gotcha_(programming)>: \"A feature of a "
1627 "system [...] that works in the way it is documented but is counterintuitive "
1628 "and almost invites mistakes.\""
1632 #: ../src/guestfs.pod:768
1634 "Since we developed libguestfs and the associated tools, there are several "
1635 "things we would have designed differently, but are now stuck with for "
1636 "backwards compatibility or other reasons. If there is ever a libguestfs 2.0 "
1637 "release, you can expect these to change. Beware of them."
1641 #: ../src/guestfs.pod:776
1642 msgid "Autosync / forgetting to sync."
1646 #: ../src/guestfs.pod:778
1648 "I<Update:> Autosync is enabled by default for all API users starting from "
1649 "libguestfs 1.5.24. This section only applies to older versions."
1653 #: ../src/guestfs.pod:781
1655 "When modifying a filesystem from C or another language, you B<must> unmount "
1656 "all filesystems and call L</guestfs_sync> explicitly before you close the "
1657 "libguestfs handle. You can also call:"
1661 #: ../src/guestfs.pod:785
1664 " guestfs_set_autosync (g, 1);\n"
1669 #: ../src/guestfs.pod:787
1671 "to have the unmount/sync done automatically for you when the handle 'g' is "
1672 "closed. (This feature is called \"autosync\", L</guestfs_set_autosync> q.v.)"
1676 #: ../src/guestfs.pod:791
1678 "If you forget to do this, then it is entirely possible that your changes "
1679 "won't be written out, or will be partially written, or (very rarely) that "
1680 "you'll get disk corruption."
1684 #: ../src/guestfs.pod:795
1686 "Note that in L<guestfish(3)> autosync is the default. So quick and dirty "
1687 "guestfish scripts that forget to sync will work just fine, which can make "
1688 "this very puzzling if you are trying to debug a problem."
1692 #: ../src/guestfs.pod:799
1693 msgid "Mount option C<-o sync> should not be the default."
1697 #: ../src/guestfs.pod:801
1699 "If you use L</guestfs_mount>, then C<-o sync,noatime> are added implicitly. "
1700 "However C<-o sync> does not add any reliability benefit, but does have a "
1701 "very large performance impact."
1705 #: ../src/guestfs.pod:805
1707 "The work around is to use L</guestfs_mount_options> and set the mount "
1708 "options that you actually want to use."
1712 #: ../src/guestfs.pod:808
1713 msgid "Read-only should be the default."
1717 #: ../src/guestfs.pod:810
1719 "In L<guestfish(3)>, I<--ro> should be the default, and you should have to "
1720 "specify I<--rw> if you want to make changes to the image."
1724 #: ../src/guestfs.pod:813
1725 msgid "This would reduce the potential to corrupt live VM images."
1729 #: ../src/guestfs.pod:815
1731 "Note that many filesystems change the disk when you just mount and unmount, "
1732 "even if you didn't perform any writes. You need to use L</"
1733 "guestfs_add_drive_ro> to guarantee that the disk is not changed."
1737 #: ../src/guestfs.pod:819
1738 msgid "guestfish command line is hard to use."
1742 #: ../src/guestfs.pod:821
1744 "C<guestfish disk.img> doesn't do what people expect (open C<disk.img> for "
1745 "examination). It tries to run a guestfish command C<disk.img> which doesn't "
1746 "exist, so it fails. In earlier versions of guestfish the error message was "
1747 "also unintuitive, but we have corrected this since. Like the Bourne shell, "
1748 "we should have used C<guestfish -c command> to run commands."
1752 #: ../src/guestfs.pod:828
1753 msgid "guestfish megabyte modifiers don't work right on all commands"
1757 #: ../src/guestfs.pod:830
1759 "In recent guestfish you can use C<1M> to mean 1 megabyte (and similarly for "
1760 "other modifiers). What guestfish actually does is to multiply the number "
1761 "part by the modifier part and pass the result to the C API. However this "
1762 "doesn't work for a few APIs which aren't expecting bytes, but are already "
1763 "expecting some other unit (eg. megabytes)."
1767 #: ../src/guestfs.pod:837
1768 msgid "The most common is L</guestfs_lvcreate>. The guestfish command:"
1772 #: ../src/guestfs.pod:839
1775 " lvcreate LV VG 100M\n"
1780 #: ../src/guestfs.pod:841
1782 "does not do what you might expect. Instead because L</guestfs_lvcreate> is "
1783 "already expecting megabytes, this tries to create a 100 I<terabyte> (100 "
1784 "megabytes * megabytes) logical volume. The error message you get from this "
1785 "is also a little obscure."
1789 #: ../src/guestfs.pod:846
1791 "This could be fixed in the generator by specially marking parameters and "
1792 "return values which take bytes or other units."
1796 #: ../src/guestfs.pod:849
1797 msgid "Ambiguity between devices and paths"
1801 #: ../src/guestfs.pod:851
1803 "There is a subtle ambiguity in the API between a device name (eg. C</dev/"
1804 "sdb2>) and a similar pathname. A file might just happen to be called "
1805 "C<sdb2> in the directory C</dev> (consider some non-Unix VM image)."
1809 #: ../src/guestfs.pod:856
1811 "In the current API we usually resolve this ambiguity by having two separate "
1812 "calls, for example L</guestfs_checksum> and L</guestfs_checksum_device>. "
1813 "Some API calls are ambiguous and (incorrectly) resolve the problem by "
1814 "detecting if the path supplied begins with C</dev/>."
1818 #: ../src/guestfs.pod:862
1820 "To avoid both the ambiguity and the need to duplicate some calls, we could "
1821 "make paths/devices into structured names. One way to do this would be to "
1822 "use a notation like grub (C<hd(0,0)>), although nobody really likes this "
1823 "aspect of grub. Another way would be to use a structured type, equivalent "
1824 "to this OCaml type:"
1828 #: ../src/guestfs.pod:868
1831 " type path = Path of string | Device of int | Partition of int * int\n"
1836 #: ../src/guestfs.pod:870
1837 msgid "which would allow you to pass arguments like:"
1841 #: ../src/guestfs.pod:872
1844 " Path \"/foo/bar\"\n"
1845 " Device 1 (* /dev/sdb, or perhaps /dev/sda *)\n"
1846 " Partition (1, 2) (* /dev/sdb2 (or is it /dev/sda2 or /dev/sdb3?) *)\n"
1847 " Path \"/dev/sdb2\" (* not a device *)\n"
1852 #: ../src/guestfs.pod:877
1854 "As you can see there are still problems to resolve even with this "
1855 "representation. Also consider how it might work in guestfish."
1859 #: ../src/guestfs.pod:882
1860 msgid "KEYS AND PASSPHRASES"
1864 #: ../src/guestfs.pod:884
1866 "Certain libguestfs calls take a parameter that contains sensitive key "
1867 "material, passed in as a C string."
1871 #: ../src/guestfs.pod:887
1873 "In the future we would hope to change the libguestfs implementation so that "
1874 "keys are L<mlock(2)>-ed into physical RAM, and thus can never end up in "
1875 "swap. However this is I<not> done at the moment, because of the complexity "
1876 "of such an implementation."
1880 #: ../src/guestfs.pod:892
1882 "Therefore you should be aware that any key parameter you pass to libguestfs "
1883 "might end up being written out to the swap partition. If this is a concern, "
1884 "scrub the swap partition or don't use libguestfs on encrypted devices."
1888 #: ../src/guestfs.pod:897
1889 msgid "MULTIPLE HANDLES AND MULTIPLE THREADS"
1893 #: ../src/guestfs.pod:899
1895 "All high-level libguestfs actions are synchronous. If you want to use "
1896 "libguestfs asynchronously then you must create a thread."
1900 #: ../src/guestfs.pod:902
1902 "Only use the handle from a single thread. Either use the handle exclusively "
1903 "from one thread, or provide your own mutex so that two threads cannot issue "
1904 "calls on the same handle at the same time."
1908 #: ../src/guestfs.pod:906
1910 "See the graphical program guestfs-browser for one possible architecture for "
1911 "multithreaded programs using libvirt and libguestfs."
1915 #: ../src/guestfs.pod:909
1920 #: ../src/guestfs.pod:911
1922 "Libguestfs needs a supermin appliance, which it finds by looking along an "
1927 #: ../src/guestfs.pod:914
1929 "By default it looks for these in the directory C<$libdir/guestfs> (eg. C</"
1930 "usr/local/lib/guestfs> or C</usr/lib64/guestfs>)."
1934 #: ../src/guestfs.pod:917
1936 "Use L</guestfs_set_path> or set the environment variable L</LIBGUESTFS_PATH> "
1937 "to change the directories that libguestfs will search in. The value is a "
1938 "colon-separated list of paths. The current directory is I<not> searched "
1939 "unless the path contains an empty element or C<.>. For example "
1940 "C<LIBGUESTFS_PATH=:/usr/lib/guestfs> would search the current directory and "
1941 "then C</usr/lib/guestfs>."
1945 #: ../src/guestfs.pod:924
1946 msgid "QEMU WRAPPERS"
1950 #: ../src/guestfs.pod:926
1952 "If you want to compile your own qemu, run qemu from a non-standard location, "
1953 "or pass extra arguments to qemu, then you can write a shell-script wrapper "
1958 #: ../src/guestfs.pod:930
1960 "There is one important rule to remember: you I<must C<exec qemu>> as the "
1961 "last command in the shell script (so that qemu replaces the shell and "
1962 "becomes the direct child of the libguestfs-using program). If you don't do "
1963 "this, then the qemu process won't be cleaned up correctly."
1967 #: ../src/guestfs.pod:935
1969 "Here is an example of a wrapper, where I have built my own copy of qemu from "
1974 #: ../src/guestfs.pod:938
1978 " qemudir=/home/rjones/d/qemu\n"
1979 " exec $qemudir/x86_64-softmmu/qemu-system-x86_64 -L $qemudir/pc-bios \"$@\"\n"
1984 #: ../src/guestfs.pod:942
1986 "Save this script as C</tmp/qemu.wrapper> (or wherever), C<chmod +x>, and "
1987 "then use it by setting the LIBGUESTFS_QEMU environment variable. For "
1992 #: ../src/guestfs.pod:946
1995 " LIBGUESTFS_QEMU=/tmp/qemu.wrapper guestfish\n"
2000 #: ../src/guestfs.pod:948
2002 "Note that libguestfs also calls qemu with the -help and -version options in "
2003 "order to determine features."
2007 #: ../src/guestfs.pod:951
2008 msgid "ATTACHING TO RUNNING DAEMONS"
2012 #: ../src/guestfs.pod:953
2014 "I<Note (1):> This is B<highly experimental> and has a tendency to eat "
2015 "babies. Use with caution."
2019 #: ../src/guestfs.pod:956
2021 "I<Note (2):> This section explains how to attach to a running daemon from a "
2022 "low level perspective. For most users, simply using virt tools such as "
2023 "L<guestfish(1)> with the I<--live> option will \"just work\"."
2027 #: ../src/guestfs.pod:960
2028 msgid "Using guestfs_set_attach_method"
2032 #: ../src/guestfs.pod:962
2034 "By calling L</guestfs_set_attach_method> you can change how the library "
2035 "connects to the C<guestfsd> daemon in L</guestfs_launch> (read L</"
2036 "ARCHITECTURE> for some background)."
2040 #: ../src/guestfs.pod:966
2042 "The normal attach method is C<appliance>, where a small appliance is created "
2043 "containing the daemon, and then the library connects to this."
2047 #: ../src/guestfs.pod:969
2049 "Setting attach method to C<unix:I<path>> (where I<path> is the path of a "
2050 "Unix domain socket) causes L</guestfs_launch> to connect to an existing "
2051 "daemon over the Unix domain socket."
2055 #: ../src/guestfs.pod:973
2057 "The normal use for this is to connect to a running virtual machine that "
2058 "contains a C<guestfsd> daemon, and send commands so you can read and write "
2059 "files inside the live virtual machine."
2063 #: ../src/guestfs.pod:977
2064 msgid "Using guestfs_add_domain with live flag"
2068 #: ../src/guestfs.pod:979
2070 "L</guestfs_add_domain> provides some help for getting the correct attach "
2071 "method. If you pass the C<live> option to this function, then (if the "
2072 "virtual machine is running) it will examine the libvirt XML looking for a "
2073 "virtio-serial channel to connect to:"
2077 #: ../src/guestfs.pod:985
2084 " <channel type='unix'>\n"
2085 " <source mode='bind' path='/path/to/socket'/>\n"
2086 " <target type='virtio' name='org.libguestfs.channel.0'/>\n"
2095 #: ../src/guestfs.pod:997
2097 "L</guestfs_add_domain> extracts C</path/to/socket> and sets the attach "
2098 "method to C<unix:/path/to/socket>."
2102 #: ../src/guestfs.pod:1000
2104 "Some of the libguestfs tools (including guestfish) support a I<--live> "
2105 "option which is passed through to L</guestfs_add_domain> thus allowing you "
2106 "to attach to and modify live virtual machines."
2110 #: ../src/guestfs.pod:1004
2112 "The virtual machine needs to have been set up beforehand so that it has the "
2113 "virtio-serial channel and so that guestfsd is running inside it."
2117 #: ../src/guestfs.pod:1008
2118 msgid "ABI GUARANTEE"
2122 #: ../src/guestfs.pod:1010
2124 "We guarantee the libguestfs ABI (binary interface), for public, high-level "
2125 "actions as outlined in this section. Although we will deprecate some "
2126 "actions, for example if they get replaced by newer calls, we will keep the "
2127 "old actions forever. This allows you the developer to program in confidence "
2128 "against the libguestfs API."
2132 #: ../src/guestfs.pod:1016
2133 msgid "BLOCK DEVICE NAMING"
2137 #: ../src/guestfs.pod:1018
2139 "In the kernel there is now quite a profusion of schemata for naming block "
2140 "devices (in this context, by I<block device> I mean a physical or virtual "
2141 "hard drive). The original Linux IDE driver used names starting with C</dev/"
2142 "hd*>. SCSI devices have historically used a different naming scheme, C</dev/"
2143 "sd*>. When the Linux kernel I<libata> driver became a popular replacement "
2144 "for the old IDE driver (particularly for SATA devices) those devices also "
2145 "used the C</dev/sd*> scheme. Additionally we now have virtual machines with "
2146 "paravirtualized drivers. This has created several different naming systems, "
2147 "such as C</dev/vd*> for virtio disks and C</dev/xvd*> for Xen PV disks."
2151 #: ../src/guestfs.pod:1030
2153 "As discussed above, libguestfs uses a qemu appliance running an embedded "
2154 "Linux kernel to access block devices. We can run a variety of appliances "
2155 "based on a variety of Linux kernels."
2159 #: ../src/guestfs.pod:1034
2161 "This causes a problem for libguestfs because many API calls use device or "
2162 "partition names. Working scripts and the recipe (example) scripts that we "
2163 "make available over the internet could fail if the naming scheme changes."
2167 #: ../src/guestfs.pod:1039
2169 "Therefore libguestfs defines C</dev/sd*> as the I<standard naming scheme>. "
2170 "Internally C</dev/sd*> names are translated, if necessary, to other names as "
2171 "required. For example, under RHEL 5 which uses the C</dev/hd*> scheme, any "
2172 "device parameter C</dev/sda2> is translated to C</dev/hda2> transparently."
2176 #: ../src/guestfs.pod:1045
2178 "Note that this I<only> applies to parameters. The L</guestfs_list_devices>, "
2179 "L</guestfs_list_partitions> and similar calls return the true names of the "
2180 "devices and partitions as known to the appliance."
2184 #: ../src/guestfs.pod:1050
2185 msgid "ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION"
2189 #: ../src/guestfs.pod:1052
2191 "Usually this translation is transparent. However in some (very rare) cases "
2192 "you may need to know the exact algorithm. Such cases include where you use "
2193 "L</guestfs_config> to add a mixture of virtio and IDE devices to the qemu-"
2194 "based appliance, so have a mixture of C</dev/sd*> and C</dev/vd*> devices."
2198 #: ../src/guestfs.pod:1058
2200 "The algorithm is applied only to I<parameters> which are known to be either "
2201 "device or partition names. Return values from functions such as L</"
2202 "guestfs_list_devices> are never changed."
2206 #: ../src/guestfs.pod:1066
2207 msgid "Is the string a parameter which is a device or partition name?"
2211 #: ../src/guestfs.pod:1070
2212 msgid "Does the string begin with C</dev/sd>?"
2216 #: ../src/guestfs.pod:1074
2218 "Does the named device exist? If so, we use that device. However if I<not> "
2219 "then we continue with this algorithm."
2223 #: ../src/guestfs.pod:1079
2224 msgid "Replace initial C</dev/sd> string with C</dev/hd>."
2228 #: ../src/guestfs.pod:1081
2229 msgid "For example, change C</dev/sda2> to C</dev/hda2>."
2233 #: ../src/guestfs.pod:1083
2234 msgid "If that named device exists, use it. If not, continue."
2238 #: ../src/guestfs.pod:1087
2239 msgid "Replace initial C</dev/sd> string with C</dev/vd>."
2243 #: ../src/guestfs.pod:1089
2244 msgid "If that named device exists, use it. If not, return an error."
2248 #: ../src/guestfs.pod:1093
2249 msgid "PORTABILITY CONCERNS WITH BLOCK DEVICE NAMING"
2253 #: ../src/guestfs.pod:1095
2255 "Although the standard naming scheme and automatic translation is useful for "
2256 "simple programs and guestfish scripts, for larger programs it is best not to "
2257 "rely on this mechanism."
2261 #: ../src/guestfs.pod:1099
2263 "Where possible for maximum future portability programs using libguestfs "
2264 "should use these future-proof techniques:"
2268 #: ../src/guestfs.pod:1106
2270 "Use L</guestfs_list_devices> or L</guestfs_list_partitions> to list actual "
2271 "device names, and then use those names directly."
2275 #: ../src/guestfs.pod:1109
2277 "Since those device names exist by definition, they will never be translated."
2281 #: ../src/guestfs.pod:1114
2283 "Use higher level ways to identify filesystems, such as LVM names, UUIDs and "
2284 "filesystem labels."
2288 #: ../src/guestfs.pod:1119
2293 #: ../src/guestfs.pod:1121
2295 "This section discusses security implications of using libguestfs, "
2296 "particularly with untrusted or malicious guests or disk images."
2300 #: ../src/guestfs.pod:1124
2301 msgid "GENERAL SECURITY CONSIDERATIONS"
2305 #: ../src/guestfs.pod:1126
2307 "Be careful with any files or data that you download from a guest (by "
2308 "\"download\" we mean not just the L</guestfs_download> command but any "
2309 "command that reads files, filenames, directories or anything else from a "
2310 "disk image). An attacker could manipulate the data to fool your program "
2311 "into doing the wrong thing. Consider cases such as:"
2315 #: ../src/guestfs.pod:1136
2316 msgid "the data (file etc) not being present"
2320 #: ../src/guestfs.pod:1140
2321 msgid "being present but empty"
2325 #: ../src/guestfs.pod:1144
2326 msgid "being much larger than normal"
2330 #: ../src/guestfs.pod:1148
2331 msgid "containing arbitrary 8 bit data"
2335 #: ../src/guestfs.pod:1152
2336 msgid "being in an unexpected character encoding"
2340 #: ../src/guestfs.pod:1156
2341 msgid "containing homoglyphs."
2345 #: ../src/guestfs.pod:1160
2346 msgid "SECURITY OF MOUNTING FILESYSTEMS"
2350 #: ../src/guestfs.pod:1162
2352 "When you mount a filesystem under Linux, mistakes in the kernel filesystem "
2353 "(VFS) module can sometimes be escalated into exploits by deliberately "
2354 "creating a malicious, malformed filesystem. These exploits are very severe "
2355 "for two reasons. Firstly there are very many filesystem drivers in the "
2356 "kernel, and many of them are infrequently used and not much developer "
2357 "attention has been paid to the code. Linux userspace helps potential "
2358 "crackers by detecting the filesystem type and automatically choosing the "
2359 "right VFS driver, even if that filesystem type is obscure or unexpected for "
2360 "the administrator. Secondly, a kernel-level exploit is like a local root "
2361 "exploit (worse in some ways), giving immediate and total access to the "
2362 "system right down to the hardware level."
2366 #: ../src/guestfs.pod:1175
2368 "That explains why you should never mount a filesystem from an untrusted "
2369 "guest on your host kernel. How about libguestfs? We run a Linux kernel "
2370 "inside a qemu virtual machine, usually running as a non-root user. The "
2371 "attacker would need to write a filesystem which first exploited the kernel, "
2372 "and then exploited either qemu virtualization (eg. a faulty qemu driver) or "
2373 "the libguestfs protocol, and finally to be as serious as the host kernel "
2374 "exploit it would need to escalate its privileges to root. This multi-step "
2375 "escalation, performed by a static piece of data, is thought to be extremely "
2376 "hard to do, although we never say 'never' about security issues."
2380 #: ../src/guestfs.pod:1186
2382 "In any case callers can reduce the attack surface by forcing the filesystem "
2383 "type when mounting (use L</guestfs_mount_vfs>)."
2387 #: ../src/guestfs.pod:1189
2388 msgid "PROTOCOL SECURITY"
2392 #: ../src/guestfs.pod:1191
2394 "The protocol is designed to be secure, being based on RFC 4506 (XDR) with a "
2395 "defined upper message size. However a program that uses libguestfs must "
2396 "also take care - for example you can write a program that downloads a binary "
2397 "from a disk image and executes it locally, and no amount of protocol "
2398 "security will save you from the consequences."
2402 #: ../src/guestfs.pod:1197
2403 msgid "INSPECTION SECURITY"
2407 #: ../src/guestfs.pod:1199
2409 "Parts of the inspection API (see L</INSPECTION>) return untrusted strings "
2410 "directly from the guest, and these could contain any 8 bit data. Callers "
2411 "should be careful to escape these before printing them to a structured file "
2412 "(for example, use HTML escaping if creating a web page)."
2416 #: ../src/guestfs.pod:1205
2418 "Guest configuration may be altered in unusual ways by the administrator of "
2419 "the virtual machine, and may not reflect reality (particularly for untrusted "
2420 "or actively malicious guests). For example we parse the hostname from "
2421 "configuration files like C</etc/sysconfig/network> that we find in the "
2422 "guest, but the guest administrator can easily manipulate these files to "
2423 "provide the wrong hostname."
2427 #: ../src/guestfs.pod:1213
2429 "The inspection API parses guest configuration using two external libraries: "
2430 "Augeas (Linux configuration) and hivex (Windows Registry). Both are "
2431 "designed to be robust in the face of malicious data, although denial of "
2432 "service attacks are still possible, for example with oversized configuration "
2437 #: ../src/guestfs.pod:1219
2438 msgid "RUNNING UNTRUSTED GUEST COMMANDS"
2442 #: ../src/guestfs.pod:1221
2444 "Be very cautious about running commands from the guest. By running a "
2445 "command in the guest, you are giving CPU time to a binary that you do not "
2446 "control, under the same user account as the library, albeit wrapped in qemu "
2447 "virtualization. More information and alternatives can be found in the "
2448 "section L</RUNNING COMMANDS>."
2452 #: ../src/guestfs.pod:1227
2453 msgid "CVE-2010-3851"
2454 msgstr "CVE-2010-3851"
2457 #: ../src/guestfs.pod:1229
2458 msgid "https://bugzilla.redhat.com/642934"
2459 msgstr "https://bugzilla.redhat.com/642934"
2462 #: ../src/guestfs.pod:1231
2464 "This security bug concerns the automatic disk format detection that qemu "
2465 "does on disk images."
2469 #: ../src/guestfs.pod:1234
2471 "A raw disk image is just the raw bytes, there is no header. Other disk "
2472 "images like qcow2 contain a special header. Qemu deals with this by looking "
2473 "for one of the known headers, and if none is found then assuming the disk "
2474 "image must be raw."
2478 #: ../src/guestfs.pod:1239
2480 "This allows a guest which has been given a raw disk image to write some "
2481 "other header. At next boot (or when the disk image is accessed by "
2482 "libguestfs) qemu would do autodetection and think the disk image format was, "
2483 "say, qcow2 based on the header written by the guest."
2487 #: ../src/guestfs.pod:1244
2489 "This in itself would not be a problem, but qcow2 offers many features, one "
2490 "of which is to allow a disk image to refer to another image (called the "
2491 "\"backing disk\"). It does this by placing the path to the backing disk "
2492 "into the qcow2 header. This path is not validated and could point to any "
2493 "host file (eg. \"/etc/passwd\"). The backing disk is then exposed through "
2494 "\"holes\" in the qcow2 disk image, which of course is completely under the "
2495 "control of the attacker."
2499 #: ../src/guestfs.pod:1252
2501 "In libguestfs this is rather hard to exploit except under two circumstances:"
2505 #: ../src/guestfs.pod:1259
2506 msgid "You have enabled the network or have opened the disk in write mode."
2510 #: ../src/guestfs.pod:1263
2512 "You are also running untrusted code from the guest (see L</RUNNING "
2517 #: ../src/guestfs.pod:1268
2519 "The way to avoid this is to specify the expected disk format when adding "
2520 "disks (the optional C<format> option to L</guestfs_add_drive_opts>). You "
2521 "should always do this if the disk is raw format, and it's a good idea for "
2526 #: ../src/guestfs.pod:1273
2528 "For disks added from libvirt using calls like L</guestfs_add_domain>, the "
2529 "format is fetched from libvirt and passed through."
2533 #: ../src/guestfs.pod:1276
2535 "For libguestfs tools, use the I<--format> command line parameter as "
2540 #: ../src/guestfs.pod:1279
2541 msgid "CONNECTION MANAGEMENT"
2545 #: ../src/guestfs.pod:1281
2550 #: ../src/guestfs.pod:1283
2552 "C<guestfs_h> is the opaque type representing a connection handle. Create a "
2553 "handle by calling L</guestfs_create>. Call L</guestfs_close> to free the "
2554 "handle and release all resources used."
2558 #: ../src/guestfs.pod:1287
2560 "For information on using multiple handles and threads, see the section L</"
2561 "MULTIPLE HANDLES AND MULTIPLE THREADS> above."
2565 #: ../src/guestfs.pod:1290
2566 msgid "guestfs_create"
2570 #: ../src/guestfs.pod:1292
2573 " guestfs_h *guestfs_create (void);\n"
2578 #: ../src/guestfs.pod:1294
2579 msgid "Create a connection handle."
2583 #: ../src/guestfs.pod:1296
2585 "On success this returns a non-NULL pointer to a handle. On error it returns "
2590 #: ../src/guestfs.pod:1299
2592 "You have to \"configure\" the handle after creating it. This includes "
2593 "calling L</guestfs_add_drive_opts> (or one of the equivalent calls) on the "
2594 "handle at least once."
2598 #: ../src/guestfs.pod:1303
2599 msgid "After configuring the handle, you have to call L</guestfs_launch>."
2603 #: ../src/guestfs.pod:1305
2605 "You may also want to configure error handling for the handle. See the L</"
2606 "ERROR HANDLING> section below."
2610 #: ../src/guestfs.pod:1308
2611 msgid "guestfs_close"
2615 #: ../src/guestfs.pod:1310
2618 " void guestfs_close (guestfs_h *g);\n"
2623 #: ../src/guestfs.pod:1312
2624 msgid "This closes the connection handle and frees up all resources used."
2628 #: ../src/guestfs.pod:1314
2630 "If autosync was set on the handle and the handle was launched, then this "
2631 "implicitly calls various functions to unmount filesystems and sync the "
2632 "disk. See L</guestfs_set_autosync> for more details."
2636 #: ../src/guestfs.pod:1318
2637 msgid "If a close callback was set on the handle, then it is called."
2641 #: ../src/guestfs.pod:1320
2642 msgid "ERROR HANDLING"
2643 msgstr "ОБРОБКА ПОМИЛОК"
2646 #: ../src/guestfs.pod:1322
2648 "API functions can return errors. For example, almost all functions that "
2649 "return C<int> will return C<-1> to indicate an error."
2653 #: ../src/guestfs.pod:1325
2655 "Additional information is available for errors: an error message string and "
2656 "optionally an error number (errno) if the thing that failed was a system "
2661 #: ../src/guestfs.pod:1329
2663 "You can get at the additional information about the last error on the handle "
2664 "by calling L</guestfs_last_error>, L</guestfs_last_errno>, and/or by setting "
2665 "up an error handler with L</guestfs_set_error_handler>."
2669 #: ../src/guestfs.pod:1334
2671 "When the handle is created, a default error handler is installed which "
2672 "prints the error message string to C<stderr>. For small short-running "
2673 "command line programs it is sufficient to do:"
2677 #: ../src/guestfs.pod:1338
2680 " if (guestfs_launch (g) == -1)\n"
2681 " exit (EXIT_FAILURE);\n"
2686 #: ../src/guestfs.pod:1341
2688 "since the default error handler will ensure that an error message has been "
2689 "printed to C<stderr> before the program exits."
2693 #: ../src/guestfs.pod:1344
2695 "For other programs the caller will almost certainly want to install an "
2696 "alternate error handler or do error handling in-line like this:"
2700 #: ../src/guestfs.pod:1347
2703 " g = guestfs_create ();\n"
2708 #: ../src/guestfs.pod:1349
2711 " /* This disables the default behaviour of printing errors\n"
2713 " guestfs_set_error_handler (g, NULL, NULL);\n"
2718 #: ../src/guestfs.pod:1353
2721 " if (guestfs_launch (g) == -1) {\n"
2722 " /* Examine the error message and print it etc. */\n"
2723 " char *msg = guestfs_last_error (g);\n"
2724 " int errnum = guestfs_last_errno (g);\n"
2725 " fprintf (stderr, \"%s\\n\", msg);\n"
2732 #: ../src/guestfs.pod:1361
2734 "Out of memory errors are handled differently. The default action is to call "
2735 "L<abort(3)>. If this is undesirable, then you can set a handler using L</"
2736 "guestfs_set_out_of_memory_handler>."
2740 #: ../src/guestfs.pod:1365
2742 "L</guestfs_create> returns C<NULL> if the handle cannot be created, and "
2743 "because there is no handle if this happens there is no way to get additional "
2744 "error information. However L</guestfs_create> is supposed to be a "
2745 "lightweight operation which can only fail because of insufficient memory (it "
2746 "returns NULL in this case)."
2750 #: ../src/guestfs.pod:1371
2751 msgid "guestfs_last_error"
2755 #: ../src/guestfs.pod:1373
2758 " const char *guestfs_last_error (guestfs_h *g);\n"
2763 #: ../src/guestfs.pod:1375
2765 "This returns the last error message that happened on C<g>. If there has not "
2766 "been an error since the handle was created, then this returns C<NULL>."
2770 #: ../src/guestfs.pod:1379
2772 "The lifetime of the returned string is until the next error occurs, or L</"
2773 "guestfs_close> is called."
2777 #: ../src/guestfs.pod:1382
2778 msgid "guestfs_last_errno"
2782 #: ../src/guestfs.pod:1384
2785 " int guestfs_last_errno (guestfs_h *g);\n"
2790 #: ../src/guestfs.pod:1386
2791 msgid "This returns the last error number (errno) that happened on C<g>."
2795 #: ../src/guestfs.pod:1388
2796 msgid "If successful, an errno integer not equal to zero is returned."
2800 #: ../src/guestfs.pod:1390
2802 "If no error, this returns 0. This call can return 0 in three situations:"
2806 #: ../src/guestfs.pod:1397
2807 msgid "There has not been any error on the handle."
2811 #: ../src/guestfs.pod:1401
2813 "There has been an error but the errno was meaningless. This corresponds to "
2814 "the case where the error did not come from a failed system call, but for "
2815 "some other reason."
2819 #: ../src/guestfs.pod:1407
2821 "There was an error from a failed system call, but for some reason the errno "
2822 "was not captured and returned. This usually indicates a bug in libguestfs."
2826 #: ../src/guestfs.pod:1413
2828 "Libguestfs tries to convert the errno from inside the applicance into a "
2829 "corresponding errno for the caller (not entirely trivial: the appliance "
2830 "might be running a completely different operating system from the library "
2831 "and error numbers are not standardized across Un*xen). If this could not be "
2832 "done, then the error is translated to C<EINVAL>. In practice this should "
2833 "only happen in very rare circumstances."
2837 #: ../src/guestfs.pod:1421
2838 msgid "guestfs_set_error_handler"
2842 #: ../src/guestfs.pod:1423
2845 " typedef void (*guestfs_error_handler_cb) (guestfs_h *g,\n"
2847 " const char *msg);\n"
2848 " void guestfs_set_error_handler (guestfs_h *g,\n"
2849 " guestfs_error_handler_cb cb,\n"
2855 #: ../src/guestfs.pod:1430
2857 "The callback C<cb> will be called if there is an error. The parameters "
2858 "passed to the callback are an opaque data pointer and the error message "
2863 #: ../src/guestfs.pod:1434
2865 "C<errno> is not passed to the callback. To get that the callback must call "
2866 "L</guestfs_last_errno>."
2870 #: ../src/guestfs.pod:1437
2872 "Note that the message string C<msg> is freed as soon as the callback "
2873 "function returns, so if you want to stash it somewhere you must make your "
2878 #: ../src/guestfs.pod:1441
2879 msgid "The default handler prints messages on C<stderr>."
2883 #: ../src/guestfs.pod:1443
2884 msgid "If you set C<cb> to C<NULL> then I<no> handler is called."
2888 #: ../src/guestfs.pod:1445
2889 msgid "guestfs_get_error_handler"
2893 #: ../src/guestfs.pod:1447
2896 " guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g,\n"
2897 " void **opaque_rtn);\n"
2902 #: ../src/guestfs.pod:1450
2903 msgid "Returns the current error handler callback."
2907 #: ../src/guestfs.pod:1452
2908 msgid "guestfs_set_out_of_memory_handler"
2912 #: ../src/guestfs.pod:1454
2915 " typedef void (*guestfs_abort_cb) (void);\n"
2916 " int guestfs_set_out_of_memory_handler (guestfs_h *g,\n"
2917 " guestfs_abort_cb);\n"
2922 #: ../src/guestfs.pod:1458
2924 "The callback C<cb> will be called if there is an out of memory situation. "
2925 "I<Note this callback must not return>."
2929 #: ../src/guestfs.pod:1461
2930 msgid "The default is to call L<abort(3)>."
2934 #: ../src/guestfs.pod:1463
2936 "You cannot set C<cb> to C<NULL>. You can't ignore out of memory situations."
2940 #: ../src/guestfs.pod:1466
2941 msgid "guestfs_get_out_of_memory_handler"
2945 #: ../src/guestfs.pod:1468
2948 " guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n"
2953 #: ../src/guestfs.pod:1470
2954 msgid "This returns the current out of memory handler."
2958 #: ../src/guestfs.pod:1472
2963 #: ../src/guestfs.pod:1474 ../fish/guestfish.pod:1010
2968 #: ../src/guestfs.pod:1476
2973 #: ../src/guestfs.pod:1478
2978 #: ../src/guestfs.pod:1480
2979 msgid "AVAILABILITY"
2983 #: ../src/guestfs.pod:1482
2984 msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE"
2988 #: ../src/guestfs.pod:1484
2990 "Using L</guestfs_available> you can test availability of the following "
2991 "groups of functions. This test queries the appliance to see if the "
2992 "appliance you are currently using supports the functionality."
2996 #: ../src/guestfs.pod:1489
2997 msgid "@AVAILABILITY@"
3001 #: ../src/guestfs.pod:1491
3002 msgid "GUESTFISH supported COMMAND"
3006 #: ../src/guestfs.pod:1493
3008 "In L<guestfish(3)> there is a handy interactive command C<supported> which "
3009 "prints out the available groups and whether they are supported by this build "
3010 "of libguestfs. Note however that you have to do C<run> first."
3014 #: ../src/guestfs.pod:1498
3015 msgid "SINGLE CALLS AT COMPILE TIME"
3019 #: ../src/guestfs.pod:1500
3021 "Since version 1.5.8, C<E<lt>guestfs.hE<gt>> defines symbols for each C API "
3022 "function, such as:"
3026 #: ../src/guestfs.pod:1503
3029 " #define LIBGUESTFS_HAVE_DD 1\n"
3034 #: ../src/guestfs.pod:1505
3035 msgid "if L</guestfs_dd> is available."
3039 #: ../src/guestfs.pod:1507
3041 "Before version 1.5.8, if you needed to test whether a single libguestfs "
3042 "function is available at compile time, we recommended using build tools such "
3043 "as autoconf or cmake. For example in autotools you could use:"
3047 #: ../src/guestfs.pod:1512
3050 " AC_CHECK_LIB([guestfs],[guestfs_create])\n"
3051 " AC_CHECK_FUNCS([guestfs_dd])\n"
3056 #: ../src/guestfs.pod:1515
3058 "which would result in C<HAVE_GUESTFS_DD> being either defined or not defined "
3063 #: ../src/guestfs.pod:1518
3064 msgid "SINGLE CALLS AT RUN TIME"
3068 #: ../src/guestfs.pod:1520
3070 "Testing at compile time doesn't guarantee that a function really exists in "
3071 "the library. The reason is that you might be dynamically linked against a "
3072 "previous I<libguestfs.so> (dynamic library) which doesn't have the call. "
3073 "This situation unfortunately results in a segmentation fault, which is a "
3074 "shortcoming of the C dynamic linking system itself."
3078 #: ../src/guestfs.pod:1527
3080 "You can use L<dlopen(3)> to test if a function is available at run time, as "
3081 "in this example program (note that you still need the compile time check as "
3086 #: ../src/guestfs.pod:1531
3089 " #include <stdio.h>\n"
3090 " #include <stdlib.h>\n"
3091 " #include <unistd.h>\n"
3092 " #include <dlfcn.h>\n"
3093 " #include <guestfs.h>\n"
3098 #: ../src/guestfs.pod:1537
3103 " #ifdef LIBGUESTFS_HAVE_DD\n"
3105 " int has_function;\n"
3110 #: ../src/guestfs.pod:1543
3113 " /* Test if the function guestfs_dd is really available. */\n"
3114 " dl = dlopen (NULL, RTLD_LAZY);\n"
3116 " fprintf (stderr, \"dlopen: %s\\n\", dlerror ());\n"
3117 " exit (EXIT_FAILURE);\n"
3119 " has_function = dlsym (dl, \"guestfs_dd\") != NULL;\n"
3125 #: ../src/guestfs.pod:1552
3128 " if (!has_function)\n"
3129 " printf (\"this libguestfs.so does NOT have guestfs_dd function\\n\");\n"
3131 " printf (\"this libguestfs.so has guestfs_dd function\\n\");\n"
3132 " /* Now it's safe to call\n"
3133 " guestfs_dd (g, \"foo\", \"bar\");\n"
3137 " printf (\"guestfs_dd function was not found at compile time\\n\");\n"
3144 #: ../src/guestfs.pod:1565
3146 "You may think the above is an awful lot of hassle, and it is. There are "
3147 "other ways outside of the C linking system to ensure that this kind of "
3148 "incompatibility never arises, such as using package versioning:"
3152 #: ../src/guestfs.pod:1570
3155 " Requires: libguestfs >= 1.0.80\n"
3160 #: ../src/guestfs.pod:1572
3161 msgid "CALLS WITH OPTIONAL ARGUMENTS"
3165 #: ../src/guestfs.pod:1574
3167 "A recent feature of the API is the introduction of calls which take optional "
3168 "arguments. In C these are declared 3 ways. The main way is as a call which "
3169 "takes variable arguments (ie. C<...>), as in this example:"
3173 #: ../src/guestfs.pod:1579
3176 " int guestfs_add_drive_opts (guestfs_h *g, const char *filename, ...);\n"
3181 #: ../src/guestfs.pod:1581
3183 "Call this with a list of optional arguments, terminated by C<-1>. So to "
3184 "call with no optional arguments specified:"
3188 #: ../src/guestfs.pod:1584
3191 " guestfs_add_drive_opts (g, filename, -1);\n"
3196 #: ../src/guestfs.pod:1586
3197 msgid "With a single optional argument:"
3201 #: ../src/guestfs.pod:1588
3204 " guestfs_add_drive_opts (g, filename,\n"
3205 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
3211 #: ../src/guestfs.pod:1592
3216 #: ../src/guestfs.pod:1594
3219 " guestfs_add_drive_opts (g, filename,\n"
3220 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
3221 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
3227 #: ../src/guestfs.pod:1599
3229 "and so forth. Don't forget the terminating C<-1> otherwise Bad Things will "
3234 #: ../src/guestfs.pod:1602
3235 msgid "USING va_list FOR OPTIONAL ARGUMENTS"
3239 #: ../src/guestfs.pod:1604
3241 "The second variant has the same name with the suffix C<_va>, which works the "
3242 "same way but takes a C<va_list>. See the C manual for details. For the "
3243 "example function, this is declared:"
3247 #: ../src/guestfs.pod:1608
3250 " int guestfs_add_drive_opts_va (guestfs_h *g, const char *filename,\n"
3256 #: ../src/guestfs.pod:1611
3257 msgid "CONSTRUCTING OPTIONAL ARGUMENTS"
3261 #: ../src/guestfs.pod:1613
3263 "The third variant is useful where you need to construct these calls. You "
3264 "pass in a structure where you fill in the optional fields. The structure "
3265 "has a bitmask as the first element which you must set to indicate which "
3266 "fields you have filled in. For our example function the structure and call "
3271 #: ../src/guestfs.pod:1619
3274 " struct guestfs_add_drive_opts_argv {\n"
3275 " uint64_t bitmask;\n"
3277 " const char *format;\n"
3280 " int guestfs_add_drive_opts_argv (guestfs_h *g, const char *filename,\n"
3281 " const struct guestfs_add_drive_opts_argv *optargs);\n"
3286 #: ../src/guestfs.pod:1628
3287 msgid "You could call it like this:"
3291 #: ../src/guestfs.pod:1630
3294 " struct guestfs_add_drive_opts_argv optargs = {\n"
3295 " .bitmask = GUESTFS_ADD_DRIVE_OPTS_READONLY_BITMASK |\n"
3296 " GUESTFS_ADD_DRIVE_OPTS_FORMAT_BITMASK,\n"
3298 " .format = \"qcow2\"\n"
3304 #: ../src/guestfs.pod:1637
3307 " guestfs_add_drive_opts_argv (g, filename, &optargs);\n"
3312 #: ../src/guestfs.pod:1639 ../src/guestfs-actions.pod:11
3313 #: ../src/guestfs-actions.pod:1858 ../src/guestfs-actions.pod:2785
3314 #: ../fish/guestfish-actions.pod:9 ../fish/guestfish-actions.pod:1262
3315 #: ../fish/guestfish-actions.pod:1898 ../tools/virt-win-reg.pl:704
3320 #: ../src/guestfs.pod:1645
3321 msgid "The C<_BITMASK> suffix on each option name when specifying the bitmask."
3325 #: ../src/guestfs.pod:1650
3326 msgid "You do not need to fill in all fields of the structure."
3330 #: ../src/guestfs.pod:1654
3332 "There must be a one-to-one correspondence between fields of the structure "
3333 "that are filled in, and bits set in the bitmask."
3337 #: ../src/guestfs.pod:1659
3338 msgid "OPTIONAL ARGUMENTS IN OTHER LANGUAGES"
3342 #: ../src/guestfs.pod:1661
3344 "In other languages, optional arguments are expressed in the way that is "
3345 "natural for that language. We refer you to the language-specific "
3346 "documentation for more details on that."
3350 #: ../src/guestfs.pod:1665
3351 msgid "For guestfish, see L<guestfish(1)/OPTIONAL ARGUMENTS>."
3355 #: ../src/guestfs.pod:1667
3356 msgid "SETTING CALLBACKS TO HANDLE EVENTS"
3360 #: ../src/guestfs.pod:1669
3362 "B<Note:> This section documents the generic event mechanism introduced in "
3363 "libguestfs 1.10, which you should use in new code if possible. The old "
3364 "functions C<guestfs_set_log_message_callback>, "
3365 "C<guestfs_set_subprocess_quit_callback>, "
3366 "C<guestfs_set_launch_done_callback>, C<guestfs_set_close_callback> and "
3367 "C<guestfs_set_progress_callback> are no longer documented in this manual "
3368 "page. Because of the ABI guarantee, the old functions continue to work."
3372 #: ../src/guestfs.pod:1678
3374 "Handles generate events when certain things happen, such as log messages "
3375 "being generated, progress messages during long-running operations, or the "
3376 "handle being closed. The API calls described below let you register a "
3377 "callback to be called when events happen. You can register multiple "
3378 "callbacks (for the same, different or overlapping sets of events), and "
3379 "individually remove callbacks. If callbacks are not removed, then they "
3380 "remain in force until the handle is closed."
3384 #: ../src/guestfs.pod:1686
3386 "In the current implementation, events are only generated synchronously: that "
3387 "means that events (and hence callbacks) can only happen while you are in the "
3388 "middle of making another libguestfs call. The callback is called in the "
3393 #: ../src/guestfs.pod:1691
3395 "Events may contain a payload, usually nothing (void), an array of 64 bit "
3396 "unsigned integers, or a message buffer. Payloads are discussed later on."
3400 #: ../src/guestfs.pod:1695
3401 msgid "CLASSES OF EVENTS"
3405 #: ../src/guestfs.pod:1699
3406 msgid "GUESTFS_EVENT_CLOSE (payload type: void)"
3410 #: ../src/guestfs.pod:1702
3412 "The callback function will be called while the handle is being closed "
3413 "(synchronously from L</guestfs_close>)."
3417 #: ../src/guestfs.pod:1705
3419 "Note that libguestfs installs an L<atexit(3)> handler to try to clean up "
3420 "handles that are open when the program exits. This means that this callback "
3421 "might be called indirectly from L<exit(3)>, which can cause unexpected "
3422 "problems in higher-level languages (eg. if your HLL interpreter has already "
3423 "been cleaned up by the time this is called, and if your callback then jumps "
3424 "into some HLL function)."
3428 #: ../src/guestfs.pod:1712
3430 "If no callback is registered: the handle is closed without any callback "
3435 #: ../src/guestfs.pod:1715
3436 msgid "GUESTFS_EVENT_SUBPROCESS_QUIT (payload type: void)"
3440 #: ../src/guestfs.pod:1718
3442 "The callback function will be called when the child process quits, either "
3443 "asynchronously or if killed by L</guestfs_kill_subprocess>. (This "
3444 "corresponds to a transition from any state to the CONFIG state)."
3448 #: ../src/guestfs.pod:1722 ../src/guestfs.pod:1731
3449 msgid "If no callback is registered: the event is ignored."
3453 #: ../src/guestfs.pod:1724
3454 msgid "GUESTFS_EVENT_LAUNCH_DONE (payload type: void)"
3458 #: ../src/guestfs.pod:1727
3460 "The callback function will be called when the child process becomes ready "
3461 "first time after it has been launched. (This corresponds to a transition "
3462 "from LAUNCHING to the READY state)."
3466 #: ../src/guestfs.pod:1733
3467 msgid "GUESTFS_EVENT_PROGRESS (payload type: array of 4 x uint64_t)"
3471 #: ../src/guestfs.pod:1736
3473 "Some long-running operations can generate progress messages. If this "
3474 "callback is registered, then it will be called each time a progress message "
3475 "is generated (usually two seconds after the operation started, and three "
3476 "times per second thereafter until it completes, although the frequency may "
3477 "change in future versions)."
3481 #: ../src/guestfs.pod:1742
3483 "The callback receives in the payload four unsigned 64 bit numbers which are "
3484 "(in order): C<proc_nr>, C<serial>, C<position>, C<total>."
3488 #: ../src/guestfs.pod:1745
3490 "The units of C<total> are not defined, although for some operations C<total> "
3491 "may relate in some way to the amount of data to be transferred (eg. in bytes "
3492 "or megabytes), and C<position> may be the portion which has been transferred."
3496 #: ../src/guestfs.pod:1750
3497 msgid "The only defined and stable parts of the API are:"
3501 #: ../src/guestfs.pod:1756
3503 "The callback can display to the user some type of progress bar or indicator "
3504 "which shows the ratio of C<position>:C<total>."
3508 #: ../src/guestfs.pod:1761
3509 msgid "0 E<lt>= C<position> E<lt>= C<total>"
3513 #: ../src/guestfs.pod:1765
3515 "If any progress notification is sent during a call, then a final progress "
3516 "notification is always sent when C<position> = C<total> (I<unless> the call "
3517 "fails with an error)."
3521 #: ../src/guestfs.pod:1769
3523 "This is to simplify caller code, so callers can easily set the progress "
3524 "indicator to \"100%\" at the end of the operation, without requiring special "
3525 "code to detect this case."
3529 #: ../src/guestfs.pod:1775
3531 "For some calls we are unable to estimate the progress of the call, but we "
3532 "can still generate progress messages to indicate activity. This is known as "
3533 "\"pulse mode\", and is directly supported by certain progress bar "
3534 "implementations (eg. GtkProgressBar)."
3538 #: ../src/guestfs.pod:1780
3540 "For these calls, zero or more progress messages are generated with "
3541 "C<position = 0> and C<total = 1>, followed by a final message with "
3542 "C<position = total = 1>."
3546 #: ../src/guestfs.pod:1784
3548 "As noted above, if the call fails with an error then the final message may "
3553 #: ../src/guestfs.pod:1789
3555 "The callback also receives the procedure number (C<proc_nr>) and serial "
3556 "number (C<serial>) of the call. These are only useful for debugging "
3557 "protocol issues, and the callback can normally ignore them. The callback "
3558 "may want to print these numbers in error messages or debugging messages."
3562 #: ../src/guestfs.pod:1795
3563 msgid "If no callback is registered: progress messages are discarded."
3567 #: ../src/guestfs.pod:1797
3568 msgid "GUESTFS_EVENT_APPLIANCE (payload type: message buffer)"
3572 #: ../src/guestfs.pod:1800
3574 "The callback function is called whenever a log message is generated by qemu, "
3575 "the appliance kernel, guestfsd (daemon), or utility programs."
3579 #: ../src/guestfs.pod:1803
3581 "If the verbose flag (L</guestfs_set_verbose>) is set before launch (L</"
3582 "guestfs_launch>) then additional debug messages are generated."
3586 #: ../src/guestfs.pod:1806 ../src/guestfs.pod:1820
3588 "If no callback is registered: the messages are discarded unless the verbose "
3589 "flag is set in which case they are sent to stderr. You can override the "
3590 "printing of verbose messages to stderr by setting up a callback."
3594 #: ../src/guestfs.pod:1811
3595 msgid "GUESTFS_EVENT_LIBRARY (payload type: message buffer)"
3599 #: ../src/guestfs.pod:1814
3601 "The callback function is called whenever a log message is generated by the "
3602 "library part of libguestfs."
3606 #: ../src/guestfs.pod:1817
3608 "If the verbose flag (L</guestfs_set_verbose>) is set then additional debug "
3609 "messages are generated."
3613 #: ../src/guestfs.pod:1825
3614 msgid "GUESTFS_EVENT_TRACE (payload type: message buffer)"
3618 #: ../src/guestfs.pod:1828
3620 "The callback function is called whenever a trace message is generated. This "
3621 "only applies if the trace flag (L</guestfs_set_trace>) is set."
3625 #: ../src/guestfs.pod:1831
3627 "If no callback is registered: the messages are sent to stderr. You can "
3628 "override the printing of trace messages to stderr by setting up a callback."
3632 #: ../src/guestfs.pod:1837
3633 msgid "guestfs_set_event_callback"
3637 #: ../src/guestfs.pod:1839
3640 " int guestfs_set_event_callback (guestfs_h *g,\n"
3641 " guestfs_event_callback cb,\n"
3642 " uint64_t event_bitmask,\n"
3649 #: ../src/guestfs.pod:1845
3651 "This function registers a callback (C<cb>) for all event classes in the "
3656 #: ../src/guestfs.pod:1848
3658 "For example, to register for all log message events, you could call this "
3659 "function with the bitmask C<GUESTFS_EVENT_APPLIANCE|GUESTFS_EVENT_LIBRARY>. "
3660 "To register a single callback for all possible classes of events, use "
3661 "C<GUESTFS_EVENT_ALL>."
3665 #: ../src/guestfs.pod:1854
3666 msgid "C<flags> should always be passed as 0."
3670 #: ../src/guestfs.pod:1856
3672 "C<opaque> is an opaque pointer which is passed to the callback. You can use "
3673 "it for any purpose."
3677 #: ../src/guestfs.pod:1859
3679 "The return value is the event handle (an integer) which you can use to "
3680 "delete the callback (see below)."
3684 #: ../src/guestfs.pod:1862
3686 "If there is an error, this function returns C<-1>, and sets the error in the "
3687 "handle in the usual way (see L</guestfs_last_error> etc.)"
3691 #: ../src/guestfs.pod:1865
3693 "Callbacks remain in effect until they are deleted, or until the handle is "
3698 #: ../src/guestfs.pod:1868
3700 "In the case where multiple callbacks are registered for a particular event "
3701 "class, all of the callbacks are called. The order in which multiple "
3702 "callbacks are called is not defined."
3706 #: ../src/guestfs.pod:1872
3707 msgid "guestfs_delete_event_callback"
3711 #: ../src/guestfs.pod:1874
3714 " void guestfs_delete_event_callback (guestfs_h *g, int event_handle);\n"
3719 #: ../src/guestfs.pod:1876
3721 "Delete a callback that was previously registered. C<event_handle> should be "
3722 "the integer that was returned by a previous call to "
3723 "C<guestfs_set_event_callback> on the same handle."
3727 #: ../src/guestfs.pod:1880
3728 msgid "guestfs_event_callback"
3732 #: ../src/guestfs.pod:1882
3735 " typedef void (*guestfs_event_callback) (\n"
3738 " uint64_t event,\n"
3739 " int event_handle,\n"
3741 " const char *buf, size_t buf_len,\n"
3742 " const uint64_t *array, size_t array_len);\n"
3747 #: ../src/guestfs.pod:1891
3749 "This is the type of the event callback function that you have to provide."
3753 #: ../src/guestfs.pod:1894
3755 "The basic parameters are: the handle (C<g>), the opaque user pointer "
3756 "(C<opaque>), the event class (eg. C<GUESTFS_EVENT_PROGRESS>), the event "
3757 "handle, and C<flags> which in the current API you should ignore."
3761 #: ../src/guestfs.pod:1898
3763 "The remaining parameters contain the event payload (if any). Each event may "
3764 "contain a payload, which usually relates to the event class, but for future "
3765 "proofing your code should be written to handle any payload for any event "
3770 #: ../src/guestfs.pod:1903
3772 "C<buf> and C<buf_len> contain a message buffer (if C<buf_len == 0>, then "
3773 "there is no message buffer). Note that this message buffer can contain "
3774 "arbitrary 8 bit data, including NUL bytes."
3778 #: ../src/guestfs.pod:1907
3780 "C<array> and C<array_len> is an array of 64 bit unsigned integers. At the "
3781 "moment this is only used for progress messages."
3785 #: ../src/guestfs.pod:1910
3786 msgid "EXAMPLE: CAPTURING LOG MESSAGES"
3790 #: ../src/guestfs.pod:1912
3792 "One motivation for the generic event API was to allow GUI programs to "
3793 "capture debug and other messages. In libguestfs E<le> 1.8 these were sent "
3794 "unconditionally to C<stderr>."
3798 #: ../src/guestfs.pod:1916
3800 "Events associated with log messages are: C<GUESTFS_EVENT_LIBRARY>, "
3801 "C<GUESTFS_EVENT_APPLIANCE> and C<GUESTFS_EVENT_TRACE>. (Note that error "
3802 "messages are not events; you must capture error messages separately)."
3806 #: ../src/guestfs.pod:1921
3808 "Programs have to set up a callback to capture the classes of events of "
3813 #: ../src/guestfs.pod:1924
3817 " guestfs_set_event_callback\n"
3818 " (g, message_callback,\n"
3819 " GUESTFS_EVENT_LIBRARY|GUESTFS_EVENT_APPLIANCE|\n"
3820 " GUESTFS_EVENT_TRACE,\n"
3821 " 0, NULL) == -1)\n"
3822 " if (eh == -1) {\n"
3823 " // handle error in the usual way\n"
3829 #: ../src/guestfs.pod:1934
3831 "The callback can then direct messages to the appropriate place. In this "
3832 "example, messages are directed to syslog:"
3836 #: ../src/guestfs.pod:1937
3840 " message_callback (\n"
3843 " uint64_t event,\n"
3844 " int event_handle,\n"
3846 " const char *buf, size_t buf_len,\n"
3847 " const uint64_t *array, size_t array_len)\n"
3849 " const int priority = LOG_USER|LOG_INFO;\n"
3850 " if (buf_len > 0)\n"
3851 " syslog (priority, \"event 0x%lx: %s\", event, buf);\n"
3857 #: ../src/guestfs.pod:1952
3858 msgid "PRIVATE DATA AREA"
3862 #: ../src/guestfs.pod:1954
3864 "You can attach named pieces of private data to the libguestfs handle, fetch "
3865 "them by name, and walk over them, for the lifetime of the handle. This is "
3866 "called the private data area and is only available from the C API."
3870 #: ../src/guestfs.pod:1959
3871 msgid "To attach a named piece of data, use the following call:"
3875 #: ../src/guestfs.pod:1961
3878 " void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n"
3883 #: ../src/guestfs.pod:1963
3885 "C<key> is the name to associate with this data, and C<data> is an arbitrary "
3886 "pointer (which can be C<NULL>). Any previous item with the same key is "
3891 #: ../src/guestfs.pod:1967
3893 "You can use any C<key> you want, but your key should I<not> start with an "
3894 "underscore character. Keys beginning with an underscore character are "
3895 "reserved for internal libguestfs purposes (eg. for implementing language "
3896 "bindings). It is recommended that you prefix the key with some unique "
3897 "string to avoid collisions with other users."
3901 #: ../src/guestfs.pod:1973
3902 msgid "To retrieve the pointer, use:"
3906 #: ../src/guestfs.pod:1975
3909 " void *guestfs_get_private (guestfs_h *g, const char *key);\n"
3914 #: ../src/guestfs.pod:1977
3916 "This function returns C<NULL> if either no data is found associated with "
3917 "C<key>, or if the user previously set the C<key>'s C<data> pointer to "
3922 #: ../src/guestfs.pod:1981
3924 "Libguestfs does not try to look at or interpret the C<data> pointer in any "
3925 "way. As far as libguestfs is concerned, it need not be a valid pointer at "
3926 "all. In particular, libguestfs does I<not> try to free the data when the "
3927 "handle is closed. If the data must be freed, then the caller must either "
3928 "free it before calling L</guestfs_close> or must set up a close callback to "
3929 "do it (see L</GUESTFS_EVENT_CLOSE>)."
3933 #: ../src/guestfs.pod:1988
3934 msgid "To walk over all entries, use these two functions:"
3938 #: ../src/guestfs.pod:1990
3941 " void *guestfs_first_private (guestfs_h *g, const char **key_rtn);\n"
3946 #: ../src/guestfs.pod:1992
3949 " void *guestfs_next_private (guestfs_h *g, const char **key_rtn);\n"
3954 #: ../src/guestfs.pod:1994
3956 "C<guestfs_first_private> returns the first key, pointer pair (\"first\" does "
3957 "not have any particular meaning -- keys are not returned in any defined "
3958 "order). A pointer to the key is returned in C<*key_rtn> and the "
3959 "corresponding data pointer is returned from the function. C<NULL> is "
3960 "returned if there are no keys stored in the handle."
3964 #: ../src/guestfs.pod:2000
3966 "C<guestfs_next_private> returns the next key, pointer pair. The return "
3967 "value of this function is also C<NULL> is there are no further entries to "
3972 #: ../src/guestfs.pod:2004
3973 msgid "Notes about walking over entries:"
3977 #: ../src/guestfs.pod:2010
3979 "You must not call C<guestfs_set_private> while walking over the entries."
3983 #: ../src/guestfs.pod:2015
3985 "The handle maintains an internal iterator which is reset when you call "
3986 "C<guestfs_first_private>. This internal iterator is invalidated when you "
3987 "call C<guestfs_set_private>."
3991 #: ../src/guestfs.pod:2021
3992 msgid "If you have set the data pointer associated with a key to C<NULL>, ie:"
3996 #: ../src/guestfs.pod:2023
3999 " guestfs_set_private (g, key, NULL);\n"
4004 #: ../src/guestfs.pod:2025
4005 msgid "then that C<key> is not returned when walking."
4009 #: ../src/guestfs.pod:2029
4011 "C<*key_rtn> is only valid until the next call to C<guestfs_first_private>, "
4012 "C<guestfs_next_private> or C<guestfs_set_private>."
4016 #: ../src/guestfs.pod:2035
4018 "The following example code shows how to print all keys and data pointers "
4019 "that are associated with the handle C<g>:"
4023 #: ../src/guestfs.pod:2038
4026 " const char *key;\n"
4027 " void *data = guestfs_first_private (g, &key);\n"
4028 " while (data != NULL)\n"
4030 " printf (\"key = %s, data = %p\\n\", key, data);\n"
4031 " data = guestfs_next_private (g, &key);\n"
4037 #: ../src/guestfs.pod:2046
4039 "More commonly you are only interested in keys that begin with an application-"
4040 "specific prefix C<foo_>. Modify the loop like so:"
4044 #: ../src/guestfs.pod:2049
4047 " const char *key;\n"
4048 " void *data = guestfs_first_private (g, &key);\n"
4049 " while (data != NULL)\n"
4051 " if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
4052 " printf (\"key = %s, data = %p\\n\", key, data);\n"
4053 " data = guestfs_next_private (g, &key);\n"
4059 #: ../src/guestfs.pod:2058
4061 "If you need to modify keys while walking, then you have to jump back to the "
4062 "beginning of the loop. For example, to delete all keys prefixed with "
4067 #: ../src/guestfs.pod:2062
4070 " const char *key;\n"
4073 " data = guestfs_first_private (g, &key);\n"
4074 " while (data != NULL)\n"
4076 " if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
4078 " guestfs_set_private (g, key, NULL);\n"
4079 " /* note that 'key' pointer is now invalid, and so is\n"
4080 " the internal iterator */\n"
4083 " data = guestfs_next_private (g, &key);\n"
4089 #: ../src/guestfs.pod:2078
4091 "Note that the above loop is guaranteed to terminate because the keys are "
4092 "being deleted, but other manipulations of keys within the loop might not "
4093 "terminate unless you also maintain an indication of which keys have been "
4098 #: ../src/guestfs.pod:2083 ../src/guestfs.pod:2088
4103 #: ../src/guestfs.pod:2085
4105 "<!-- old anchor for the next section --> <a name="
4106 "\"state_machine_and_low_level_event_api\"/>"
4108 "<!-- old anchor for the next section --> <a name="
4109 "\"state_machine_and_low_level_event_api\"/>"
4112 #: ../src/guestfs.pod:2090
4113 msgid "ARCHITECTURE"
4114 msgstr "АРХІТЕКТУРА"
4117 #: ../src/guestfs.pod:2092
4119 "Internally, libguestfs is implemented by running an appliance (a special "
4120 "type of small virtual machine) using L<qemu(1)>. Qemu runs as a child "
4121 "process of the main program."
4125 #: ../src/guestfs.pod:2096
4128 " ___________________\n"
4130 " | main program |\n"
4132 " | | child process / appliance\n"
4133 " | | __________________________\n"
4135 " +-------------------+ RPC | +-----------------+ |\n"
4136 " | libguestfs <--------------------> guestfsd | |\n"
4137 " | | | +-----------------+ |\n"
4138 " \\___________________/ | | Linux kernel | |\n"
4139 " | +--^--------------+ |\n"
4140 " \\_________|________________/\n"
4146 " \\______________/\n"
4151 #: ../src/guestfs.pod:2116
4153 "The library, linked to the main program, creates the child process and hence "
4154 "the appliance in the L</guestfs_launch> function."
4158 #: ../src/guestfs.pod:2119
4160 "Inside the appliance is a Linux kernel and a complete stack of userspace "
4161 "tools (such as LVM and ext2 programs) and a small controlling daemon called "
4162 "L</guestfsd>. The library talks to L</guestfsd> using remote procedure "
4163 "calls (RPC). There is a mostly one-to-one correspondence between libguestfs "
4164 "API calls and RPC calls to the daemon. Lastly the disk image(s) are "
4165 "attached to the qemu process which translates device access by the "
4166 "appliance's Linux kernel into accesses to the image."
4170 #: ../src/guestfs.pod:2128
4172 "A common misunderstanding is that the appliance \"is\" the virtual machine. "
4173 "Although the disk image you are attached to might also be used by some "
4174 "virtual machine, libguestfs doesn't know or care about this. (But you will "
4175 "care if both libguestfs's qemu process and your virtual machine are trying "
4176 "to update the disk image at the same time, since these usually results in "
4177 "massive disk corruption)."
4181 #: ../src/guestfs.pod:2135
4182 msgid "STATE MACHINE"
4183 msgstr "СКІНЧЕННИЙ АВТОМАТ"
4186 #: ../src/guestfs.pod:2137
4187 msgid "libguestfs uses a state machine to model the child process:"
4191 #: ../src/guestfs.pod:2139
4203 " / | \\ \\ guestfs_launch\n"
4204 " / | _\\__V______\n"
4206 " / | | LAUNCHING |\n"
4207 " / | \\___________/\n"
4209 " / | guestfs_launch\n"
4211 " ______ / __|____V\n"
4212 " / \\ ------> / \\\n"
4213 " | BUSY | | READY |\n"
4214 " \\______/ <------ \\________/\n"
4219 #: ../src/guestfs.pod:2161
4221 "The normal transitions are (1) CONFIG (when the handle is created, but there "
4222 "is no child process), (2) LAUNCHING (when the child process is booting up), "
4223 "(3) alternating between READY and BUSY as commands are issued to, and "
4224 "carried out by, the child process."
4228 #: ../src/guestfs.pod:2166
4230 "The guest may be killed by L</guestfs_kill_subprocess>, or may die "
4231 "asynchronously at any time (eg. due to some internal error), and that causes "
4232 "the state to transition back to CONFIG."
4236 #: ../src/guestfs.pod:2170
4238 "Configuration commands for qemu such as L</guestfs_add_drive> can only be "
4239 "issued when in the CONFIG state."
4243 #: ../src/guestfs.pod:2173
4245 "The API offers one call that goes from CONFIG through LAUNCHING to READY. "
4246 "L</guestfs_launch> blocks until the child process is READY to accept "
4247 "commands (or until some failure or timeout). L</guestfs_launch> internally "
4248 "moves the state from CONFIG to LAUNCHING while it is running."
4252 #: ../src/guestfs.pod:2179
4254 "API actions such as L</guestfs_mount> can only be issued when in the READY "
4255 "state. These API calls block waiting for the command to be carried out (ie. "
4256 "the state to transition to BUSY and then back to READY). There are no non-"
4257 "blocking versions, and no way to issue more than one command per handle at "
4262 #: ../src/guestfs.pod:2185
4264 "Finally, the child process sends asynchronous messages back to the main "
4265 "program, such as kernel log messages. You can register a callback to "
4266 "receive these messages."
4270 #: ../src/guestfs.pod:2189
4275 #: ../src/guestfs.pod:2191
4276 msgid "COMMUNICATION PROTOCOL"
4280 #: ../src/guestfs.pod:2193
4282 "Don't rely on using this protocol directly. This section documents how it "
4283 "currently works, but it may change at any time."
4287 #: ../src/guestfs.pod:2196
4289 "The protocol used to talk between the library and the daemon running inside "
4290 "the qemu virtual machine is a simple RPC mechanism built on top of XDR (RFC "
4291 "1014, RFC 1832, RFC 4506)."
4295 #: ../src/guestfs.pod:2200
4297 "The detailed format of structures is in C<src/guestfs_protocol.x> (note: "
4298 "this file is automatically generated)."
4302 #: ../src/guestfs.pod:2203
4304 "There are two broad cases, ordinary functions that don't have any C<FileIn> "
4305 "and C<FileOut> parameters, which are handled with very simple request/reply "
4306 "messages. Then there are functions that have any C<FileIn> or C<FileOut> "
4307 "parameters, which use the same request and reply messages, but they may also "
4308 "be followed by files sent using a chunked encoding."
4312 #: ../src/guestfs.pod:2210
4313 msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)"
4317 #: ../src/guestfs.pod:2212
4318 msgid "For ordinary functions, the request message is:"
4322 #: ../src/guestfs.pod:2214
4325 " total length (header + arguments,\n"
4326 " but not including the length word itself)\n"
4327 " struct guestfs_message_header (encoded as XDR)\n"
4328 " struct guestfs_<foo>_args (encoded as XDR)\n"
4333 #: ../src/guestfs.pod:2219
4335 "The total length field allows the daemon to allocate a fixed size buffer "
4336 "into which it slurps the rest of the message. As a result, the total length "
4337 "is limited to C<GUESTFS_MESSAGE_MAX> bytes (currently 4MB), which means the "
4338 "effective size of any request is limited to somewhere under this size."
4342 #: ../src/guestfs.pod:2225
4344 "Note also that many functions don't take any arguments, in which case the "
4345 "C<guestfs_I<foo>_args> is completely omitted."
4349 #: ../src/guestfs.pod:2228
4351 "The header contains the procedure number (C<guestfs_proc>) which is how the "
4352 "receiver knows what type of args structure to expect, or none at all."
4356 #: ../src/guestfs.pod:2232
4358 "For functions that take optional arguments, the optional arguments are "
4359 "encoded in the C<guestfs_I<foo>_args> structure in the same way as ordinary "
4360 "arguments. A bitmask in the header indicates which optional arguments are "
4361 "meaningful. The bitmask is also checked to see if it contains bits set "
4362 "which the daemon does not know about (eg. if more optional arguments were "
4363 "added in a later version of the library), and this causes the call to be "
4368 #: ../src/guestfs.pod:2240
4369 msgid "The reply message for ordinary functions is:"
4373 #: ../src/guestfs.pod:2242
4376 " total length (header + ret,\n"
4377 " but not including the length word itself)\n"
4378 " struct guestfs_message_header (encoded as XDR)\n"
4379 " struct guestfs_<foo>_ret (encoded as XDR)\n"
4384 #: ../src/guestfs.pod:2247
4386 "As above the C<guestfs_I<foo>_ret> structure may be completely omitted for "
4387 "functions that return no formal return values."
4391 #: ../src/guestfs.pod:2250
4393 "As above the total length of the reply is limited to C<GUESTFS_MESSAGE_MAX>."
4397 #: ../src/guestfs.pod:2253
4399 "In the case of an error, a flag is set in the header, and the reply message "
4400 "is slightly changed:"
4404 #: ../src/guestfs.pod:2256
4407 " total length (header + error,\n"
4408 " but not including the length word itself)\n"
4409 " struct guestfs_message_header (encoded as XDR)\n"
4410 " struct guestfs_message_error (encoded as XDR)\n"
4415 #: ../src/guestfs.pod:2261
4417 "The C<guestfs_message_error> structure contains the error message as a "
4422 #: ../src/guestfs.pod:2264
4423 msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS"
4427 #: ../src/guestfs.pod:2266
4429 "A C<FileIn> parameter indicates that we transfer a file I<into> the guest. "
4430 "The normal request message is sent (see above). However this is followed by "
4431 "a sequence of file chunks."
4435 #: ../src/guestfs.pod:2270
4438 " total length (header + arguments,\n"
4439 " but not including the length word itself,\n"
4440 " and not including the chunks)\n"
4441 " struct guestfs_message_header (encoded as XDR)\n"
4442 " struct guestfs_<foo>_args (encoded as XDR)\n"
4443 " sequence of chunks for FileIn param #0\n"
4444 " sequence of chunks for FileIn param #1 etc.\n"
4449 #: ../src/guestfs.pod:2278
4450 msgid "The \"sequence of chunks\" is:"
4454 #: ../src/guestfs.pod:2280
4457 " length of chunk (not including length word itself)\n"
4458 " struct guestfs_chunk (encoded as XDR)\n"
4459 " length of chunk\n"
4460 " struct guestfs_chunk (encoded as XDR)\n"
4462 " length of chunk\n"
4463 " struct guestfs_chunk (with data.data_len == 0)\n"
4468 #: ../src/guestfs.pod:2288
4470 "The final chunk has the C<data_len> field set to zero. Additionally a flag "
4471 "is set in the final chunk to indicate either successful completion or early "
4476 #: ../src/guestfs.pod:2292
4478 "At time of writing there are no functions that have more than one FileIn "
4479 "parameter. However this is (theoretically) supported, by sending the "
4480 "sequence of chunks for each FileIn parameter one after another (from left to "
4485 #: ../src/guestfs.pod:2297
4487 "Both the library (sender) I<and> the daemon (receiver) may cancel the "
4488 "transfer. The library does this by sending a chunk with a special flag set "
4489 "to indicate cancellation. When the daemon sees this, it cancels the whole "
4490 "RPC, does I<not> send any reply, and goes back to reading the next request."
4494 #: ../src/guestfs.pod:2303
4496 "The daemon may also cancel. It does this by writing a special word "
4497 "C<GUESTFS_CANCEL_FLAG> to the socket. The library listens for this during "
4498 "the transfer, and if it gets it, it will cancel the transfer (it sends a "
4499 "cancel chunk). The special word is chosen so that even if cancellation "
4500 "happens right at the end of the transfer (after the library has finished "
4501 "writing and has started listening for the reply), the \"spurious\" cancel "
4502 "flag will not be confused with the reply message."
4506 #: ../src/guestfs.pod:2312
4508 "This protocol allows the transfer of arbitrary sized files (no 32 bit "
4509 "limit), and also files where the size is not known in advance (eg. from "
4510 "pipes or sockets). However the chunks are rather small "
4511 "(C<GUESTFS_MAX_CHUNK_SIZE>), so that neither the library nor the daemon need "
4512 "to keep much in memory."
4516 #: ../src/guestfs.pod:2318
4517 msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS"
4521 #: ../src/guestfs.pod:2320
4523 "The protocol for FileOut parameters is exactly the same as for FileIn "
4524 "parameters, but with the roles of daemon and library reversed."
4528 #: ../src/guestfs.pod:2323
4531 " total length (header + ret,\n"
4532 " but not including the length word itself,\n"
4533 " and not including the chunks)\n"
4534 " struct guestfs_message_header (encoded as XDR)\n"
4535 " struct guestfs_<foo>_ret (encoded as XDR)\n"
4536 " sequence of chunks for FileOut param #0\n"
4537 " sequence of chunks for FileOut param #1 etc.\n"
4542 #: ../src/guestfs.pod:2331
4543 msgid "INITIAL MESSAGE"
4547 #: ../src/guestfs.pod:2333
4549 "When the daemon launches it sends an initial word (C<GUESTFS_LAUNCH_FLAG>) "
4550 "which indicates that the guest and daemon is alive. This is what L</"
4551 "guestfs_launch> waits for."
4555 #: ../src/guestfs.pod:2337
4556 msgid "PROGRESS NOTIFICATION MESSAGES"
4560 #: ../src/guestfs.pod:2339
4562 "The daemon may send progress notification messages at any time. These are "
4563 "distinguished by the normal length word being replaced by "
4564 "C<GUESTFS_PROGRESS_FLAG>, followed by a fixed size progress message."
4568 #: ../src/guestfs.pod:2343
4570 "The library turns them into progress callbacks (see L</"
4571 "GUESTFS_EVENT_PROGRESS>) if there is a callback registered, or discards them "
4576 #: ../src/guestfs.pod:2347
4578 "The daemon self-limits the frequency of progress messages it sends (see "
4579 "C<daemon/proto.c:notify_progress>). Not all calls generate progress "
4584 #: ../src/guestfs.pod:2351
4585 msgid "LIBGUESTFS VERSION NUMBERS"
4589 #: ../src/guestfs.pod:2353
4591 "Since April 2010, libguestfs has started to make separate development and "
4592 "stable releases, along with corresponding branches in our git repository. "
4593 "These separate releases can be identified by version number:"
4597 #: ../src/guestfs.pod:2358
4600 " even numbers for stable: 1.2.x, 1.4.x, ...\n"
4601 " .-------- odd numbers for development: 1.3.x, 1.5.x, ...\n"
4607 " | `-------- sub-version\n"
4609 " `------ always '1' because we don't change the ABI\n"
4614 #: ../src/guestfs.pod:2369
4615 msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"."
4619 #: ../src/guestfs.pod:2371
4621 "As time passes we cherry pick fixes from the development branch and backport "
4622 "those into the stable branch, the effect being that the stable branch should "
4623 "get more stable and less buggy over time. So the stable releases are ideal "
4624 "for people who don't need new features but would just like the software to "
4629 #: ../src/guestfs.pod:2377
4630 msgid "Our criteria for backporting changes are:"
4634 #: ../src/guestfs.pod:2383
4636 "Documentation changes which don't affect any code are backported unless the "
4637 "documentation refers to a future feature which is not in stable."
4641 #: ../src/guestfs.pod:2389
4643 "Bug fixes which are not controversial, fix obvious problems, and have been "
4644 "well tested are backported."
4648 #: ../src/guestfs.pod:2394
4650 "Simple rearrangements of code which shouldn't affect how it works get "
4651 "backported. This is so that the code in the two branches doesn't get too "
4652 "far out of step, allowing us to backport future fixes more easily."
4656 #: ../src/guestfs.pod:2400
4658 "We I<don't> backport new features, new APIs, new tools etc, except in one "
4659 "exceptional case: the new feature is required in order to implement an "
4660 "important bug fix."
4664 #: ../src/guestfs.pod:2406
4666 "A new stable branch starts when we think the new features in development are "
4667 "substantial and compelling enough over the current stable branch to warrant "
4668 "it. When that happens we create new stable and development versions 1.N.0 "
4669 "and 1.(N+1).0 [N is even]. The new dot-oh release won't necessarily be so "
4670 "stable at this point, but by backporting fixes from development, that branch "
4671 "will stabilize over time."
4675 #: ../src/guestfs.pod:2414
4676 msgid "EXTENDING LIBGUESTFS"
4680 #: ../src/guestfs.pod:2416
4681 msgid "ADDING A NEW API ACTION"
4685 #: ../src/guestfs.pod:2418
4687 "Large amounts of boilerplate code in libguestfs (RPC, bindings, "
4688 "documentation) are generated, and this makes it easy to extend the "
4693 #: ../src/guestfs.pod:2422
4694 msgid "To add a new API action there are two changes:"
4698 #: ../src/guestfs.pod:2428
4700 "You need to add a description of the call (name, parameters, return type, "
4701 "tests, documentation) to C<generator/generator_actions.ml>."
4705 #: ../src/guestfs.pod:2431
4707 "There are two sorts of API action, depending on whether the call goes "
4708 "through to the daemon in the appliance, or is serviced entirely by the "
4709 "library (see L</ARCHITECTURE> above). L</guestfs_sync> is an example of the "
4710 "former, since the sync is done in the appliance. L</guestfs_set_trace> is "
4711 "an example of the latter, since a trace flag is maintained in the handle and "
4712 "all tracing is done on the library side."
4716 #: ../src/guestfs.pod:2439
4718 "Most new actions are of the first type, and get added to the "
4719 "C<daemon_functions> list. Each function has a unique procedure number used "
4720 "in the RPC protocol which is assigned to that action when we publish "
4721 "libguestfs and cannot be reused. Take the latest procedure number and "
4726 #: ../src/guestfs.pod:2445
4728 "For library-only actions of the second type, add to the "
4729 "C<non_daemon_functions> list. Since these functions are serviced by the "
4730 "library and do not travel over the RPC mechanism to the daemon, these "
4731 "functions do not need a procedure number, and so the procedure number is set "
4736 #: ../src/guestfs.pod:2453
4737 msgid "Implement the action (in C):"
4741 #: ../src/guestfs.pod:2455
4743 "For daemon actions, implement the function C<do_E<lt>nameE<gt>> in the "
4744 "C<daemon/> directory."
4748 #: ../src/guestfs.pod:2458
4750 "For library actions, implement the function C<guestfs__E<lt>nameE<gt>> "
4751 "(note: double underscore) in the C<src/> directory."
4755 #: ../src/guestfs.pod:2461
4756 msgid "In either case, use another function as an example of what to do."
4760 #: ../src/guestfs.pod:2465
4761 msgid "After making these changes, use C<make> to compile."
4765 #: ../src/guestfs.pod:2467
4767 "Note that you don't need to implement the RPC, language bindings, manual "
4768 "pages or anything else. It's all automatically generated from the OCaml "
4773 #: ../src/guestfs.pod:2471
4774 msgid "ADDING TESTS FOR AN API ACTION"
4778 #: ../src/guestfs.pod:2473
4780 "You can supply zero or as many tests as you want per API call. The tests "
4781 "can either be added as part of the API description (C<generator/"
4782 "generator_actions.ml>), or in some rarer cases you may want to drop a script "
4783 "into C<regressions/>. Note that adding a script to C<regressions/> is "
4784 "slower, so if possible use the first method."
4788 #: ../src/guestfs.pod:2479
4790 "The following describes the test environment used when you add an API test "
4791 "in C<generator_actions.ml>."
4795 #: ../src/guestfs.pod:2482
4796 msgid "The test environment has 4 block devices:"
4800 #: ../src/guestfs.pod:2486
4801 msgid "C</dev/sda> 500MB"
4805 #: ../src/guestfs.pod:2488
4806 msgid "General block device for testing."
4810 #: ../src/guestfs.pod:2490
4811 msgid "C</dev/sdb> 50MB"
4815 #: ../src/guestfs.pod:2492
4817 "C</dev/sdb1> is an ext2 filesystem used for testing filesystem write "
4822 #: ../src/guestfs.pod:2495
4823 msgid "C</dev/sdc> 10MB"
4827 #: ../src/guestfs.pod:2497
4828 msgid "Used in a few tests where two block devices are needed."
4832 #: ../src/guestfs.pod:2499
4834 msgstr "C</dev/sdd>"
4837 #: ../src/guestfs.pod:2501
4838 msgid "ISO with fixed content (see C<images/test.iso>)."
4842 #: ../src/guestfs.pod:2505
4844 "To be able to run the tests in a reasonable amount of time, the libguestfs "
4845 "appliance and block devices are reused between tests. So don't try testing "
4846 "L</guestfs_kill_subprocess> :-x"
4850 #: ../src/guestfs.pod:2509
4852 "Each test starts with an initial scenario, selected using one of the "
4853 "C<Init*> expressions, described in C<generator/generator_types.ml>. These "
4854 "initialize the disks mentioned above in a particular way as documented in "
4855 "C<generator_types.ml>. You should not assume anything about the previous "
4856 "contents of other disks that are not initialized."
4860 #: ../src/guestfs.pod:2515
4862 "You can add a prerequisite clause to any individual test. This is a run-"
4863 "time check, which, if it fails, causes the test to be skipped. Useful if "
4864 "testing a command which might not work on all variations of libguestfs "
4865 "builds. A test that has prerequisite of C<Always> means to run "
4870 #: ../src/guestfs.pod:2521
4872 "In addition, packagers can skip individual tests by setting environment "
4873 "variables before running C<make check>."
4877 #: ../src/guestfs.pod:2524
4880 " SKIP_TEST_<CMD>_<NUM>=1\n"
4885 #: ../src/guestfs.pod:2526
4886 msgid "eg: C<SKIP_TEST_COMMAND_3=1> skips test #3 of L</guestfs_command>."
4890 #: ../src/guestfs.pod:2528
4895 #: ../src/guestfs.pod:2530
4898 " SKIP_TEST_<CMD>=1\n"
4903 #: ../src/guestfs.pod:2532
4904 msgid "eg: C<SKIP_TEST_ZEROFREE=1> skips all L</guestfs_zerofree> tests."
4908 #: ../src/guestfs.pod:2534
4909 msgid "Packagers can run only certain tests by setting for example:"
4913 #: ../src/guestfs.pod:2536
4916 " TEST_ONLY=\"vfs_type zerofree\"\n"
4921 #: ../src/guestfs.pod:2538
4923 "See C<capitests/tests.c> for more details of how these environment variables "
4928 #: ../src/guestfs.pod:2541
4929 msgid "DEBUGGING NEW API ACTIONS"
4933 #: ../src/guestfs.pod:2543
4934 msgid "Test new actions work before submitting them."
4938 #: ../src/guestfs.pod:2545
4939 msgid "You can use guestfish to try out new commands."
4943 #: ../src/guestfs.pod:2547
4945 "Debugging the daemon is a problem because it runs inside a minimal "
4946 "environment. However you can fprintf messages in the daemon to stderr, and "
4947 "they will show up if you use C<guestfish -v>."
4951 #: ../src/guestfs.pod:2551
4952 msgid "FORMATTING CODE AND OTHER CONVENTIONS"
4956 #: ../src/guestfs.pod:2553
4958 "Our C source code generally adheres to some basic code-formatting "
4959 "conventions. The existing code base is not totally consistent on this "
4960 "front, but we do prefer that contributed code be formatted similarly. In "
4961 "short, use spaces-not-TABs for indentation, use 2 spaces for each "
4962 "indentation level, and other than that, follow the K&R style."
4966 #: ../src/guestfs.pod:2559
4968 "If you use Emacs, add the following to one of one of your start-up files (e."
4969 "g., ~/.emacs), to help ensure that you get indentation right:"
4973 #: ../src/guestfs.pod:2562
4976 " ;;; In libguestfs, indent with spaces everywhere (not TABs).\n"
4977 " ;;; Exceptions: Makefile and ChangeLog modes.\n"
4978 " (add-hook 'find-file-hook\n"
4979 " '(lambda () (if (and buffer-file-name\n"
4980 " (string-match \"/libguestfs\\\\>\"\n"
4981 " (buffer-file-name))\n"
4982 " (not (string-equal mode-name \"Change Log\"))\n"
4983 " (not (string-equal mode-name \"Makefile\")))\n"
4984 " (setq indent-tabs-mode nil))))\n"
4989 #: ../src/guestfs.pod:2572
4992 " ;;; When editing C sources in libguestfs, use this style.\n"
4993 " (defun libguestfs-c-mode ()\n"
4994 " \"C mode with adjusted defaults for use with libguestfs.\"\n"
4996 " (c-set-style \"K&R\")\n"
4997 " (setq c-indent-level 2)\n"
4998 " (setq c-basic-offset 2))\n"
4999 " (add-hook 'c-mode-hook\n"
5000 " '(lambda () (if (string-match \"/libguestfs\\\\>\"\n"
5001 " (buffer-file-name))\n"
5002 " (libguestfs-c-mode))))\n"
5007 #: ../src/guestfs.pod:2584
5008 msgid "Enable warnings when compiling (and fix any problems this finds):"
5012 #: ../src/guestfs.pod:2587
5015 " ./configure --enable-gcc-warnings\n"
5020 #: ../src/guestfs.pod:2589
5021 msgid "Useful targets are:"
5025 #: ../src/guestfs.pod:2591
5028 " make syntax-check # checks the syntax of the C code\n"
5029 " make check # runs the test suite\n"
5034 #: ../src/guestfs.pod:2594
5035 msgid "DAEMON CUSTOM PRINTF FORMATTERS"
5039 #: ../src/guestfs.pod:2596
5041 "In the daemon code we have created custom printf formatters C<%Q> and C<%R>, "
5042 "which are used to do shell quoting."
5046 #: ../src/guestfs.pod:2601
5051 #: ../src/guestfs.pod:2603
5053 "Simple shell quoted string. Any spaces or other shell characters are "
5058 #: ../src/guestfs.pod:2606
5063 #: ../src/guestfs.pod:2608
5065 "Same as C<%Q> except the string is treated as a path which is prefixed by "
5070 #: ../src/guestfs.pod:2613 ../fish/guestfish.pod:242 ../fish/guestfish.pod:615
5071 msgid "For example:"
5075 #: ../src/guestfs.pod:2615
5078 " asprintf (&cmd, \"cat %R\", path);\n"
5083 #: ../src/guestfs.pod:2617
5084 msgid "would produce C<cat /sysroot/some\\ path\\ with\\ spaces>"
5088 #: ../src/guestfs.pod:2619
5090 "I<Note:> Do I<not> use these when you are passing parameters to the C<command"
5091 "{,r,v,rv}()> functions. These parameters do NOT need to be quoted because "
5092 "they are not passed via the shell (instead, straight to exec). You probably "
5093 "want to use the C<sysroot_path()> function however."
5097 #: ../src/guestfs.pod:2625
5098 msgid "SUBMITTING YOUR NEW API ACTIONS"
5102 #: ../src/guestfs.pod:2627
5104 "Submit patches to the mailing list: L<http://www.redhat.com/mailman/listinfo/"
5105 "libguestfs> and CC to L<rjones@redhat.com>."
5109 #: ../src/guestfs.pod:2631
5110 msgid "INTERNATIONALIZATION (I18N) SUPPORT"
5114 #: ../src/guestfs.pod:2633
5115 msgid "We support i18n (gettext anyhow) in the library."
5119 #: ../src/guestfs.pod:2635
5121 "However many messages come from the daemon, and we don't translate those at "
5122 "the moment. One reason is that the appliance generally has all locale files "
5123 "removed from it, because they take up a lot of space. So we'd have to readd "
5124 "some of those, as well as copying our PO files into the appliance."
5128 #: ../src/guestfs.pod:2641
5130 "Debugging messages are never translated, since they are intended for the "
5135 #: ../src/guestfs.pod:2644
5136 msgid "SOURCE CODE SUBDIRECTORIES"
5140 #: ../src/guestfs.pod:2648 ../src/guestfs-actions.pod:5991
5141 #: ../fish/guestfish-actions.pod:3968
5142 msgid "C<appliance>"
5143 msgstr "C<appliance>"
5146 #: ../src/guestfs.pod:2650
5147 msgid "The libguestfs appliance, build scripts and so on."
5151 #: ../src/guestfs.pod:2652
5152 msgid "C<capitests>"
5153 msgstr "C<capitests>"
5156 #: ../src/guestfs.pod:2654
5157 msgid "Automated tests of the C API."
5161 #: ../src/guestfs.pod:2656
5166 #: ../src/guestfs.pod:2658
5168 "The L<virt-cat(1)>, L<virt-filesystems(1)> and L<virt-ls(1)> commands and "
5173 #: ../src/guestfs.pod:2661
5180 #: ../src/guestfs.pod:2663
5182 "Safety and liveness tests of components that libguestfs depends upon (not of "
5183 "libguestfs itself). Mainly this is for qemu and the kernel."
5187 #: ../src/guestfs.pod:2666
5192 #: ../src/guestfs.pod:2668
5193 msgid "Outside contributions, experimental parts."
5197 #: ../src/guestfs.pod:2670
5202 #: ../src/guestfs.pod:2672
5204 "The daemon that runs inside the libguestfs appliance and carries out actions."
5208 #: ../src/guestfs.pod:2675
5213 #: ../src/guestfs.pod:2677
5214 msgid "L<virt-df(1)> command and documentation."
5218 #: ../src/guestfs.pod:2679
5223 #: ../src/guestfs.pod:2681
5224 msgid "L<virt-edit(1)> command and documentation."
5228 #: ../src/guestfs.pod:2683
5230 msgstr "C<examples>"
5233 #: ../src/guestfs.pod:2685
5234 msgid "C API example code."
5235 msgstr "Код прикладів використання програмного інтерфейсу мовою C."
5238 #: ../src/guestfs.pod:2687
5243 #: ../src/guestfs.pod:2689
5245 "L<guestfish(1)>, the command-line shell, and various shell scripts built on "
5246 "top such as L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, "
5247 "L<virt-tar-out(1)>."
5251 #: ../src/guestfs.pod:2693
5256 #: ../src/guestfs.pod:2695
5258 "L<guestmount(1)>, FUSE (userspace filesystem) built on top of libguestfs."
5262 #: ../src/guestfs.pod:2697
5263 msgid "C<generator>"
5264 msgstr "C<generator>"
5267 #: ../src/guestfs.pod:2699
5269 "The crucially important generator, used to automatically generate large "
5270 "amounts of boilerplate C code for things like RPC and bindings."
5274 #: ../src/guestfs.pod:2702
5279 #: ../src/guestfs.pod:2704
5280 msgid "Files used by the test suite."
5284 #: ../src/guestfs.pod:2706
5285 msgid "Some \"phony\" guest images which we test against."
5289 #: ../src/guestfs.pod:2708
5290 msgid "C<inspector>"
5291 msgstr "C<inspector>"
5294 #: ../src/guestfs.pod:2710
5295 msgid "L<virt-inspector(1)>, the virtual machine image inspector."
5299 #: ../src/guestfs.pod:2712
5304 #: ../src/guestfs.pod:2714
5305 msgid "Logo used on the website. The fish is called Arthur by the way."
5309 #: ../src/guestfs.pod:2716
5314 #: ../src/guestfs.pod:2718
5315 msgid "M4 macros used by autoconf."
5319 #: ../src/guestfs.pod:2720
5324 #: ../src/guestfs.pod:2722
5325 msgid "Translations of simple gettext strings."
5326 msgstr "Переклади простих рядків gettext."
5329 #: ../src/guestfs.pod:2724
5334 #: ../src/guestfs.pod:2726
5336 "The build infrastructure and PO files for translations of manpages and POD "
5337 "files. Eventually this will be combined with the C<po> directory, but that "
5338 "is rather complicated."
5342 #: ../src/guestfs.pod:2730
5343 msgid "C<regressions>"
5344 msgstr "C<regressions>"
5347 #: ../src/guestfs.pod:2732
5348 msgid "Regression tests."
5349 msgstr "Тести на регресії."
5352 #: ../src/guestfs.pod:2734
5357 #: ../src/guestfs.pod:2736
5358 msgid "L<virt-rescue(1)> command and documentation."
5362 #: ../src/guestfs.pod:2738
5367 #: ../src/guestfs.pod:2740
5368 msgid "Source code to the C library."
5372 #: ../src/guestfs.pod:2742
5377 #: ../src/guestfs.pod:2744
5378 msgid "Command line tools written in Perl (L<virt-resize(1)> and many others)."
5382 #: ../src/guestfs.pod:2746
5383 msgid "C<test-tool>"
5384 msgstr "C<test-tool>"
5387 #: ../src/guestfs.pod:2748
5389 "Test tool for end users to test if their qemu/kernel combination will work "
5394 #: ../src/guestfs.pod:2751
5399 #: ../src/guestfs.pod:2753
5404 #: ../src/guestfs.pod:2755
5409 #: ../src/guestfs.pod:2757
5414 #: ../src/guestfs.pod:2759
5419 #: ../src/guestfs.pod:2761
5424 #: ../src/guestfs.pod:2763
5429 #: ../src/guestfs.pod:2765
5434 #: ../src/guestfs.pod:2767
5435 msgid "Language bindings."
5436 msgstr "Прив’язки до мов програмування."
5439 #: ../src/guestfs.pod:2771
5444 #: ../src/guestfs.pod:2773
5445 msgid "PROTOCOL LIMITS"
5449 #: ../src/guestfs.pod:2775
5451 "Internally libguestfs uses a message-based protocol to pass API calls and "
5452 "their responses to and from a small \"appliance\" (see L</INTERNALS> for "
5453 "plenty more detail about this). The maximum message size used by the "
5454 "protocol is slightly less than 4 MB. For some API calls you may need to be "
5455 "aware of this limit. The API calls which may be affected are individually "
5456 "documented, with a link back to this section of the documentation."
5460 #: ../src/guestfs.pod:2783
5462 "A simple call such as L</guestfs_cat> returns its result (the file data) in "
5463 "a simple string. Because this string is at some point internally encoded as "
5464 "a message, the maximum size that it can return is slightly under 4 MB. If "
5465 "the requested file is larger than this then you will get an error."
5469 #: ../src/guestfs.pod:2789
5471 "In order to transfer large files into and out of the guest filesystem, you "
5472 "need to use particular calls that support this. The sections L</UPLOADING> "
5473 "and L</DOWNLOADING> document how to do this."
5477 #: ../src/guestfs.pod:2793
5479 "You might also consider mounting the disk image using our FUSE filesystem "
5480 "support (L<guestmount(1)>)."
5484 #: ../src/guestfs.pod:2796
5485 msgid "MAXIMUM NUMBER OF DISKS"
5489 #: ../src/guestfs.pod:2798
5490 msgid "When using virtio disks (the default) the current limit is B<25> disks."
5494 #: ../src/guestfs.pod:2801
5496 "Virtio itself consumes 1 virtual PCI slot per disk, and PCI is limited to 31 "
5497 "slots. However febootstrap only understands disks with names C</dev/vda> "
5498 "through C</dev/vdz> (26 letters) and it reserves one disk for its own "
5503 #: ../src/guestfs.pod:2806
5505 "We are working to substantially raise this limit in future versions but it "
5506 "requires complex changes to qemu."
5510 #: ../src/guestfs.pod:2809
5512 "In future versions of libguestfs it should also be possible to \"hot plug\" "
5513 "disks (add and remove disks after calling L</guestfs_launch>). This also "
5514 "requires changes to qemu."
5518 #: ../src/guestfs.pod:2813
5519 msgid "MAXIMUM NUMBER OF PARTITIONS PER DISK"
5523 #: ../src/guestfs.pod:2815
5524 msgid "Virtio limits the maximum number of partitions per disk to B<15>."
5528 #: ../src/guestfs.pod:2817
5530 "This is because it reserves 4 bits for the minor device number (thus C</dev/"
5531 "vda>, and C</dev/vda1> through C</dev/vda15>)."
5535 #: ../src/guestfs.pod:2820
5537 "If you attach a disk with more than 15 partitions, the extra partitions are "
5538 "ignored by libguestfs."
5542 #: ../src/guestfs.pod:2823
5543 msgid "MAXIMUM SIZE OF A DISK"
5547 #: ../src/guestfs.pod:2825
5548 msgid "Probably the limit is between 2**63-1 and 2**64-1 bytes."
5552 #: ../src/guestfs.pod:2827
5554 "We have tested block devices up to 1 exabyte (2**60 or "
5555 "1,152,921,504,606,846,976 bytes) using sparse files backed by an XFS host "
5560 #: ../src/guestfs.pod:2831
5562 "Although libguestfs probably does not impose any limit, the underlying host "
5563 "storage will. If you store disk images on a host ext4 filesystem, then the "
5564 "maximum size will be limited by the maximum ext4 file size (currently 16 "
5565 "TB). If you store disk images as host logical volumes then you are limited "
5566 "by the maximum size of an LV."
5570 #: ../src/guestfs.pod:2837
5572 "For the hugest disk image files, we recommend using XFS on the host for "
5577 #: ../src/guestfs.pod:2840
5578 msgid "MAXIMUM SIZE OF A PARTITION"
5582 #: ../src/guestfs.pod:2842
5584 "The MBR (ie. classic MS-DOS) partitioning scheme uses 32 bit sector "
5585 "numbers. Assuming a 512 byte sector size, this means that MBR cannot "
5586 "address a partition located beyond 2 TB on the disk."
5590 #: ../src/guestfs.pod:2846
5592 "It is recommended that you use GPT partitions on disks which are larger than "
5593 "this size. GPT uses 64 bit sector numbers and so can address partitions "
5594 "which are theoretically larger than the largest disk we could support."
5598 #: ../src/guestfs.pod:2851
5599 msgid "MAXIMUM SIZE OF A FILESYSTEM, FILES, DIRECTORIES"
5603 #: ../src/guestfs.pod:2853
5605 "This depends on the filesystem type. libguestfs itself does not impose any "
5606 "known limit. Consult Wikipedia or the filesystem documentation to find out "
5607 "what these limits are."
5611 #: ../src/guestfs.pod:2857
5612 msgid "MAXIMUM UPLOAD AND DOWNLOAD"
5616 #: ../src/guestfs.pod:2859
5618 "The API functions L</guestfs_upload>, L</guestfs_download>, L</"
5619 "guestfs_tar_in>, L</guestfs_tar_out> and the like allow unlimited sized "
5620 "uploads and downloads."
5624 #: ../src/guestfs.pod:2863
5626 #| msgid "INSPECTION"
5627 msgid "INSPECTION LIMITS"
5631 #: ../src/guestfs.pod:2865
5633 "The inspection code has several arbitrary limits on things like the size of "
5634 "Windows Registry hive it will read, and the length of product name. These "
5635 "are intended to stop a malicious guest from consuming arbitrary amounts of "
5636 "memory and disk space on the host, and should not be reached in practice. "
5637 "See the source code for more information."
5641 #: ../src/guestfs.pod:2871 ../fish/guestfish.pod:1017
5642 #: ../test-tool/libguestfs-test-tool.pod:82
5643 msgid "ENVIRONMENT VARIABLES"
5644 msgstr "ЗМІННІ СЕРЕДОВИЩА"
5647 #: ../src/guestfs.pod:2875 ../fish/guestfish.pod:1048
5648 msgid "LIBGUESTFS_APPEND"
5652 #: ../src/guestfs.pod:2877 ../fish/guestfish.pod:1050
5653 msgid "Pass additional options to the guest kernel."
5657 #: ../src/guestfs.pod:2879 ../fish/guestfish.pod:1052
5658 msgid "LIBGUESTFS_DEBUG"
5662 #: ../src/guestfs.pod:2881
5664 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
5665 "effect as calling C<guestfs_set_verbose (g, 1)>."
5669 #: ../src/guestfs.pod:2884 ../fish/guestfish.pod:1057
5670 msgid "LIBGUESTFS_MEMSIZE"
5674 #: ../src/guestfs.pod:2886 ../fish/guestfish.pod:1059
5676 "Set the memory allocated to the qemu process, in megabytes. For example:"
5680 #: ../src/guestfs.pod:2889 ../fish/guestfish.pod:1062
5683 " LIBGUESTFS_MEMSIZE=700\n"
5688 #: ../src/guestfs.pod:2891 ../fish/guestfish.pod:1064
5689 msgid "LIBGUESTFS_PATH"
5693 #: ../src/guestfs.pod:2893
5695 "Set the path that libguestfs uses to search for a supermin appliance. See "
5696 "the discussion of paths in section L</PATH> above."
5700 #: ../src/guestfs.pod:2896 ../fish/guestfish.pod:1069
5701 msgid "LIBGUESTFS_QEMU"
5705 #: ../src/guestfs.pod:2898 ../fish/guestfish.pod:1071
5707 "Set the default qemu binary that libguestfs uses. If not set, then the qemu "
5708 "which was found at compile time by the configure script is used."
5712 #: ../src/guestfs.pod:2902
5713 msgid "See also L</QEMU WRAPPERS> above."
5717 #: ../src/guestfs.pod:2904 ../fish/guestfish.pod:1075
5718 msgid "LIBGUESTFS_TRACE"
5722 #: ../src/guestfs.pod:2906
5724 "Set C<LIBGUESTFS_TRACE=1> to enable command traces. This has the same "
5725 "effect as calling C<guestfs_set_trace (g, 1)>."
5729 #: ../src/guestfs.pod:2909 ../fish/guestfish.pod:1084
5734 #: ../src/guestfs.pod:2911 ../fish/guestfish.pod:1086
5736 "Location of temporary directory, defaults to C</tmp> except for the cached "
5737 "supermin appliance which defaults to C</var/tmp>."
5741 #: ../src/guestfs.pod:2914 ../fish/guestfish.pod:1089
5743 "If libguestfs was compiled to use the supermin appliance then the real "
5744 "appliance is cached in this directory, shared between all handles belonging "
5745 "to the same EUID. You can use C<$TMPDIR> to configure another directory to "
5746 "use in case C</var/tmp> is not large enough."
5750 #: ../src/guestfs.pod:2922 ../fish/guestfish.pod:1156
5751 #: ../test-tool/libguestfs-test-tool.pod:87 ../fuse/guestmount.pod:279
5752 #: ../tools/virt-win-reg.pl:744 ../tools/virt-list-filesystems.pl:189
5753 #: ../tools/virt-tar.pl:286 ../tools/virt-make-fs.pl:539
5754 #: ../tools/virt-list-partitions.pl:257
5756 msgstr "ТАКОЖ ПЕРЕГЛЯНЬТЕ"
5759 #: ../src/guestfs.pod:2924
5761 "L<guestfs-examples(3)>, L<guestfs-ocaml(3)>, L<guestfs-python(3)>, L<guestfs-"
5762 "ruby(3)>, L<guestfish(1)>, L<guestmount(1)>, L<virt-cat(1)>, L<virt-copy-in"
5763 "(1)>, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, L<virt-filesystems"
5764 "(1)>, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, L<virt-list-"
5765 "partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, L<virt-rescue(1)>, L<virt-"
5766 "tar(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<virt-win-reg(1)>, L<qemu(1)"
5767 ">, L<febootstrap(1)>, L<hivex(3)>, L<http://libguestfs.org/>."
5771 #: ../src/guestfs.pod:2951
5773 "Tools with a similar purpose: L<fdisk(8)>, L<parted(8)>, L<kpartx(8)>, L<lvm"
5774 "(8)>, L<disktype(1)>."
5778 #: ../src/guestfs.pod:2958 ../tools/virt-win-reg.pl:759
5779 #: ../tools/virt-make-fs.pl:553
5784 #: ../src/guestfs.pod:2960
5785 msgid "To get a list of bugs against libguestfs use this link:"
5787 "Щоб переглянути список відомих вад у libguestfs, скористайтеся таким "
5791 #: ../src/guestfs.pod:2962
5793 "L<https://bugzilla.redhat.com/buglist.cgi?"
5794 "component=libguestfs&product=Virtualization+Tools>"
5796 "L<https://bugzilla.redhat.com/buglist.cgi?"
5797 "component=libguestfs&product=Virtualization+Tools>"
5800 #: ../src/guestfs.pod:2964
5801 msgid "To report a new bug against libguestfs use this link:"
5802 msgstr "Для звітування щодо вад у libguestfs скористайтеся цим посиланням:"
5805 #: ../src/guestfs.pod:2966
5807 "L<https://bugzilla.redhat.com/enter_bug.cgi?"
5808 "component=libguestfs&product=Virtualization+Tools>"
5810 "L<https://bugzilla.redhat.com/enter_bug.cgi?"
5811 "component=libguestfs&product=Virtualization+Tools>"
5814 #: ../src/guestfs.pod:2968
5815 msgid "When reporting a bug, please check:"
5819 #: ../src/guestfs.pod:2974
5820 msgid "That the bug hasn't been reported already."
5824 #: ../src/guestfs.pod:2978
5825 msgid "That you are testing a recent version."
5829 #: ../src/guestfs.pod:2982
5830 msgid "Describe the bug accurately, and give a way to reproduce it."
5834 #: ../src/guestfs.pod:2986
5836 "Run libguestfs-test-tool and paste the B<complete, unedited> output into the "
5841 #: ../src/guestfs.pod:2991 ../fish/guestfish.pod:1180
5842 #: ../test-tool/libguestfs-test-tool.pod:93 ../fuse/guestmount.pod:290
5847 #: ../src/guestfs.pod:2993 ../fish/guestfish.pod:1182
5848 #: ../test-tool/libguestfs-test-tool.pod:95 ../fuse/guestmount.pod:292
5849 msgid "Richard W.M. Jones (C<rjones at redhat dot com>)"
5853 #: ../src/guestfs.pod:2995 ../fish/guestfish.pod:1184
5854 #: ../test-tool/libguestfs-test-tool.pod:97 ../fuse/guestmount.pod:294
5855 #: ../tools/virt-win-reg.pl:774 ../tools/virt-list-filesystems.pl:206
5856 #: ../tools/virt-tar.pl:305 ../tools/virt-make-fs.pl:568
5857 #: ../tools/virt-list-partitions.pl:273
5859 msgstr "АВТОРСЬКІ ПРАВА"
5862 #: ../src/guestfs.pod:2997 ../fish/guestfish.pod:1186
5863 #: ../test-tool/libguestfs-test-tool.pod:99
5864 msgid "Copyright (C) 2009-2011 Red Hat Inc. L<http://libguestfs.org/>"
5868 #: ../src/guestfs.pod:3000
5870 "This library is free software; you can redistribute it and/or modify it "
5871 "under the terms of the GNU Lesser General Public License as published by the "
5872 "Free Software Foundation; either version 2 of the License, or (at your "
5873 "option) any later version."
5877 #: ../src/guestfs.pod:3005
5879 "This library is distributed in the hope that it will be useful, but WITHOUT "
5880 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
5881 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License "
5886 #: ../src/guestfs.pod:3010
5888 "You should have received a copy of the GNU Lesser General Public License "
5889 "along with this library; if not, write to the Free Software Foundation, "
5890 "Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA"
5894 #: ../src/guestfs-actions.pod:1
5895 msgid "guestfs_add_cdrom"
5899 #: ../src/guestfs-actions.pod:3
5903 " guestfs_add_cdrom (guestfs_h *g,\n"
5904 " const char *filename);\n"
5909 #: ../src/guestfs-actions.pod:7 ../fish/guestfish-actions.pod:5
5910 msgid "This function adds a virtual CD-ROM disk image to the guest."
5914 #: ../src/guestfs-actions.pod:9 ../fish/guestfish-actions.pod:7
5915 msgid "This is equivalent to the qemu parameter I<-cdrom filename>."
5919 #: ../src/guestfs-actions.pod:17
5921 "This call checks for the existence of C<filename>. This stops you from "
5922 "specifying other types of drive which are supported by qemu such as C<nbd:> "
5923 "and C<http:> URLs. To specify those, use the general C<guestfs_config> call "
5928 #: ../src/guestfs-actions.pod:24
5930 "If you just want to add an ISO file (often you use this as an efficient way "
5931 "to transfer large files into the guest), then you should probably use "
5932 "C<guestfs_add_drive_ro> instead."
5936 #: ../src/guestfs-actions.pod:30 ../src/guestfs-actions.pod:140
5937 #: ../src/guestfs-actions.pod:201 ../src/guestfs-actions.pod:238
5938 #: ../src/guestfs-actions.pod:252 ../src/guestfs-actions.pod:273
5939 #: ../src/guestfs-actions.pod:293 ../src/guestfs-actions.pod:307
5940 #: ../src/guestfs-actions.pod:422 ../src/guestfs-actions.pod:442
5941 #: ../src/guestfs-actions.pod:456 ../src/guestfs-actions.pod:501
5942 #: ../src/guestfs-actions.pod:529 ../src/guestfs-actions.pod:547
5943 #: ../src/guestfs-actions.pod:614 ../src/guestfs-actions.pod:647
5944 #: ../src/guestfs-actions.pod:661 ../src/guestfs-actions.pod:676
5945 #: ../src/guestfs-actions.pod:775 ../src/guestfs-actions.pod:793
5946 #: ../src/guestfs-actions.pod:807 ../src/guestfs-actions.pod:821
5947 #: ../src/guestfs-actions.pod:982 ../src/guestfs-actions.pod:1002
5948 #: ../src/guestfs-actions.pod:1020 ../src/guestfs-actions.pod:1104
5949 #: ../src/guestfs-actions.pod:1122 ../src/guestfs-actions.pod:1141
5950 #: ../src/guestfs-actions.pod:1155 ../src/guestfs-actions.pod:1175
5951 #: ../src/guestfs-actions.pod:1245 ../src/guestfs-actions.pod:1276
5952 #: ../src/guestfs-actions.pod:1301 ../src/guestfs-actions.pod:1343
5953 #: ../src/guestfs-actions.pod:1449 ../src/guestfs-actions.pod:1483
5954 #: ../src/guestfs-actions.pod:1698 ../src/guestfs-actions.pod:1720
5955 #: ../src/guestfs-actions.pod:1807 ../src/guestfs-actions.pod:2271
5956 #: ../src/guestfs-actions.pod:2415 ../src/guestfs-actions.pod:2476
5957 #: ../src/guestfs-actions.pod:2511 ../src/guestfs-actions.pod:3551
5958 #: ../src/guestfs-actions.pod:3566 ../src/guestfs-actions.pod:3591
5959 #: ../src/guestfs-actions.pod:3760 ../src/guestfs-actions.pod:3774
5960 #: ../src/guestfs-actions.pod:3787 ../src/guestfs-actions.pod:3801
5961 #: ../src/guestfs-actions.pod:3816 ../src/guestfs-actions.pod:3852
5962 #: ../src/guestfs-actions.pod:3924 ../src/guestfs-actions.pod:3944
5963 #: ../src/guestfs-actions.pod:3961 ../src/guestfs-actions.pod:3984
5964 #: ../src/guestfs-actions.pod:4007 ../src/guestfs-actions.pod:4039
5965 #: ../src/guestfs-actions.pod:4058 ../src/guestfs-actions.pod:4077
5966 #: ../src/guestfs-actions.pod:4112 ../src/guestfs-actions.pod:4124
5967 #: ../src/guestfs-actions.pod:4160 ../src/guestfs-actions.pod:4176
5968 #: ../src/guestfs-actions.pod:4189 ../src/guestfs-actions.pod:4204
5969 #: ../src/guestfs-actions.pod:4221 ../src/guestfs-actions.pod:4314
5970 #: ../src/guestfs-actions.pod:4334 ../src/guestfs-actions.pod:4347
5971 #: ../src/guestfs-actions.pod:4398 ../src/guestfs-actions.pod:4416
5972 #: ../src/guestfs-actions.pod:4434 ../src/guestfs-actions.pod:4450
5973 #: ../src/guestfs-actions.pod:4464 ../src/guestfs-actions.pod:4478
5974 #: ../src/guestfs-actions.pod:4495 ../src/guestfs-actions.pod:4510
5975 #: ../src/guestfs-actions.pod:4530 ../src/guestfs-actions.pod:4600
5976 #: ../src/guestfs-actions.pod:4673 ../src/guestfs-actions.pod:4704
5977 #: ../src/guestfs-actions.pod:4723 ../src/guestfs-actions.pod:4742
5978 #: ../src/guestfs-actions.pod:4754 ../src/guestfs-actions.pod:4771
5979 #: ../src/guestfs-actions.pod:4784 ../src/guestfs-actions.pod:4799
5980 #: ../src/guestfs-actions.pod:4814 ../src/guestfs-actions.pod:4849
5981 #: ../src/guestfs-actions.pod:4882 ../src/guestfs-actions.pod:4921
5982 #: ../src/guestfs-actions.pod:4941 ../src/guestfs-actions.pod:4955
5983 #: ../src/guestfs-actions.pod:4972 ../src/guestfs-actions.pod:5021
5984 #: ../src/guestfs-actions.pod:5058 ../src/guestfs-actions.pod:5072
5985 #: ../src/guestfs-actions.pod:5100 ../src/guestfs-actions.pod:5117
5986 #: ../src/guestfs-actions.pod:5135 ../src/guestfs-actions.pod:5269
5987 #: ../src/guestfs-actions.pod:5326 ../src/guestfs-actions.pod:5348
5988 #: ../src/guestfs-actions.pod:5366 ../src/guestfs-actions.pod:5398
5989 #: ../src/guestfs-actions.pod:5464 ../src/guestfs-actions.pod:5481
5990 #: ../src/guestfs-actions.pod:5494 ../src/guestfs-actions.pod:5508
5991 #: ../src/guestfs-actions.pod:5797 ../src/guestfs-actions.pod:5816
5992 #: ../src/guestfs-actions.pod:5835 ../src/guestfs-actions.pod:5849
5993 #: ../src/guestfs-actions.pod:5861 ../src/guestfs-actions.pod:5875
5994 #: ../src/guestfs-actions.pod:5887 ../src/guestfs-actions.pod:5901
5995 #: ../src/guestfs-actions.pod:5917 ../src/guestfs-actions.pod:5938
5996 #: ../src/guestfs-actions.pod:5957 ../src/guestfs-actions.pod:5976
5997 #: ../src/guestfs-actions.pod:6006 ../src/guestfs-actions.pod:6024
5998 #: ../src/guestfs-actions.pod:6047 ../src/guestfs-actions.pod:6065
5999 #: ../src/guestfs-actions.pod:6084 ../src/guestfs-actions.pod:6105
6000 #: ../src/guestfs-actions.pod:6124 ../src/guestfs-actions.pod:6141
6001 #: ../src/guestfs-actions.pod:6169 ../src/guestfs-actions.pod:6193
6002 #: ../src/guestfs-actions.pod:6212 ../src/guestfs-actions.pod:6236
6003 #: ../src/guestfs-actions.pod:6255 ../src/guestfs-actions.pod:6270
6004 #: ../src/guestfs-actions.pod:6289 ../src/guestfs-actions.pod:6326
6005 #: ../src/guestfs-actions.pod:6356 ../src/guestfs-actions.pod:6389
6006 #: ../src/guestfs-actions.pod:6511 ../src/guestfs-actions.pod:6632
6007 #: ../src/guestfs-actions.pod:6644 ../src/guestfs-actions.pod:6657
6008 #: ../src/guestfs-actions.pod:6670 ../src/guestfs-actions.pod:6692
6009 #: ../src/guestfs-actions.pod:6705 ../src/guestfs-actions.pod:6718
6010 #: ../src/guestfs-actions.pod:6731 ../src/guestfs-actions.pod:6746
6011 #: ../src/guestfs-actions.pod:6805 ../src/guestfs-actions.pod:6822
6012 #: ../src/guestfs-actions.pod:6838 ../src/guestfs-actions.pod:6854
6013 #: ../src/guestfs-actions.pod:6871 ../src/guestfs-actions.pod:6884
6014 #: ../src/guestfs-actions.pod:6904 ../src/guestfs-actions.pod:6940
6015 #: ../src/guestfs-actions.pod:6954 ../src/guestfs-actions.pod:6995
6016 #: ../src/guestfs-actions.pod:7008 ../src/guestfs-actions.pod:7026
6017 #: ../src/guestfs-actions.pod:7060 ../src/guestfs-actions.pod:7096
6018 #: ../src/guestfs-actions.pod:7215 ../src/guestfs-actions.pod:7233
6019 #: ../src/guestfs-actions.pod:7247 ../src/guestfs-actions.pod:7302
6020 #: ../src/guestfs-actions.pod:7315 ../src/guestfs-actions.pod:7360
6021 #: ../src/guestfs-actions.pod:7393 ../src/guestfs-actions.pod:7454
6022 #: ../src/guestfs-actions.pod:7480 ../src/guestfs-actions.pod:7547
6023 #: ../src/guestfs-actions.pod:7566 ../src/guestfs-actions.pod:7595
6024 msgid "This function returns 0 on success or -1 on error."
6028 #: ../src/guestfs-actions.pod:32 ../src/guestfs-actions.pod:254
6029 #: ../src/guestfs-actions.pod:275 ../fish/guestfish-actions.pod:28
6030 #: ../fish/guestfish-actions.pod:163 ../fish/guestfish-actions.pod:177
6032 "This function is deprecated. In new code, use the C<add_drive_opts> call "
6037 #: ../src/guestfs-actions.pod:35 ../src/guestfs-actions.pod:257
6038 #: ../src/guestfs-actions.pod:278 ../src/guestfs-actions.pod:1454
6039 #: ../src/guestfs-actions.pod:1949 ../src/guestfs-actions.pod:1970
6040 #: ../src/guestfs-actions.pod:4535 ../src/guestfs-actions.pod:4854
6041 #: ../src/guestfs-actions.pod:6334 ../src/guestfs-actions.pod:6364
6042 #: ../src/guestfs-actions.pod:6397 ../src/guestfs-actions.pod:6456
6043 #: ../src/guestfs-actions.pod:7398 ../src/guestfs-actions.pod:7488
6044 #: ../src/guestfs-actions.pod:7658 ../fish/guestfish-actions.pod:31
6045 #: ../fish/guestfish-actions.pod:166 ../fish/guestfish-actions.pod:180
6046 #: ../fish/guestfish-actions.pod:961 ../fish/guestfish-actions.pod:1321
6047 #: ../fish/guestfish-actions.pod:1335 ../fish/guestfish-actions.pod:3038
6048 #: ../fish/guestfish-actions.pod:3245 ../fish/guestfish-actions.pod:4230
6049 #: ../fish/guestfish-actions.pod:4253 ../fish/guestfish-actions.pod:4275
6050 #: ../fish/guestfish-actions.pod:4313 ../fish/guestfish-actions.pod:4954
6051 #: ../fish/guestfish-actions.pod:5052
6053 "Deprecated functions will not be removed from the API, but the fact that "
6054 "they are deprecated indicates that there are problems with correct use of "
6059 #: ../src/guestfs-actions.pod:39 ../src/guestfs-actions.pod:142
6060 #: ../src/guestfs-actions.pod:1106 ../src/guestfs-actions.pod:1921
6061 #: ../src/guestfs-actions.pod:2019 ../src/guestfs-actions.pod:2122
6062 #: ../src/guestfs-actions.pod:3553 ../src/guestfs-actions.pod:3573
6063 #: ../src/guestfs-actions.pod:4858 ../src/guestfs-actions.pod:6026
6064 #: ../src/guestfs-actions.pod:6143 ../src/guestfs-actions.pod:6257
6065 #: ../src/guestfs-actions.pod:6748 ../src/guestfs-actions.pod:6873
6066 #: ../src/guestfs-actions.pod:7402
6067 msgid "(Added in 0.3)"
6071 #: ../src/guestfs-actions.pod:41
6072 msgid "guestfs_add_domain"
6076 #: ../src/guestfs-actions.pod:43
6080 " guestfs_add_domain (guestfs_h *g,\n"
6081 " const char *dom,\n"
6087 #: ../src/guestfs-actions.pod:48 ../src/guestfs-actions.pod:151
6088 #: ../src/guestfs-actions.pod:2756 ../src/guestfs-actions.pod:4549
6089 #: ../src/guestfs-actions.pod:4868
6091 "You may supply a list of optional arguments to this call. Use zero or more "
6092 "of the following pairs of parameters, and terminate the list with C<-1> on "
6093 "its own. See L</CALLS WITH OPTIONAL ARGUMENTS>."
6097 #: ../src/guestfs-actions.pod:53
6100 " GUESTFS_ADD_DOMAIN_LIBVIRTURI, const char *libvirturi,\n"
6101 " GUESTFS_ADD_DOMAIN_READONLY, int readonly,\n"
6102 " GUESTFS_ADD_DOMAIN_IFACE, const char *iface,\n"
6103 " GUESTFS_ADD_DOMAIN_LIVE, int live,\n"
6104 " GUESTFS_ADD_DOMAIN_ALLOWUUID, int allowuuid,\n"
6109 #: ../src/guestfs-actions.pod:59
6111 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
6112 "It works by connecting to libvirt, requesting the domain and domain XML from "
6113 "libvirt, parsing it for disks, and calling C<guestfs_add_drive_opts> on each "
6118 #: ../src/guestfs-actions.pod:64 ../fish/guestfish-actions.pod:46
6120 "The number of disks added is returned. This operation is atomic: if an "
6121 "error is returned, then no disks are added."
6125 #: ../src/guestfs-actions.pod:67 ../fish/guestfish-actions.pod:49
6127 "This function does some minimal checks to make sure the libvirt domain is "
6128 "not running (unless C<readonly> is true). In a future version we will try "
6129 "to acquire the libvirt lock on each disk."
6133 #: ../src/guestfs-actions.pod:71 ../fish/guestfish-actions.pod:53
6135 "Disks must be accessible locally. This often means that adding disks from a "
6136 "remote libvirt connection (see L<http://libvirt.org/remote.html>) will fail "
6137 "unless those disks are accessible via the same device path locally too."
6141 #: ../src/guestfs-actions.pod:76 ../fish/guestfish-actions.pod:58
6143 "The optional C<libvirturi> parameter sets the libvirt URI (see L<http://"
6144 "libvirt.org/uri.html>). If this is not set then we connect to the default "
6145 "libvirt URI (or one set through an environment variable, see the libvirt "
6146 "documentation for full details)."
6150 #: ../src/guestfs-actions.pod:82 ../fish/guestfish-actions.pod:64
6152 "The optional C<live> flag controls whether this call will try to connect to "
6153 "a running virtual machine C<guestfsd> process if it sees a suitable "
6154 "E<lt>channelE<gt> element in the libvirt XML definition. The default (if "
6155 "the flag is omitted) is never to try. See L<guestfs(3)/ATTACHING TO RUNNING "
6156 "DAEMONS> for more information."
6160 #: ../src/guestfs-actions.pod:89 ../fish/guestfish-actions.pod:71
6162 "If the C<allowuuid> flag is true (default is false) then a UUID I<may> be "
6163 "passed instead of the domain name. The C<dom> string is treated as a UUID "
6164 "first and looked up, and if that lookup fails then we treat C<dom> as a name "
6169 #: ../src/guestfs-actions.pod:94
6171 "The other optional parameters are passed directly through to "
6172 "C<guestfs_add_drive_opts>."
6176 #: ../src/guestfs-actions.pod:97 ../src/guestfs-actions.pod:350
6177 #: ../src/guestfs-actions.pod:515 ../src/guestfs-actions.pod:693
6178 #: ../src/guestfs-actions.pod:724 ../src/guestfs-actions.pod:742
6179 #: ../src/guestfs-actions.pod:761 ../src/guestfs-actions.pod:1321
6180 #: ../src/guestfs-actions.pod:1677 ../src/guestfs-actions.pod:1880
6181 #: ../src/guestfs-actions.pod:1991 ../src/guestfs-actions.pod:2031
6182 #: ../src/guestfs-actions.pod:2086 ../src/guestfs-actions.pod:2109
6183 #: ../src/guestfs-actions.pod:2402 ../src/guestfs-actions.pod:2874
6184 #: ../src/guestfs-actions.pod:2892 ../src/guestfs-actions.pod:5044
6185 #: ../src/guestfs-actions.pod:5172 ../src/guestfs-actions.pod:5578
6186 #: ../src/guestfs-actions.pod:5604 ../src/guestfs-actions.pod:6981
6187 #: ../src/guestfs-actions.pod:7413 ../src/guestfs-actions.pod:7426
6188 #: ../src/guestfs-actions.pod:7439
6189 msgid "On error this function returns -1."
6193 #: ../src/guestfs-actions.pod:99
6194 msgid "(Added in 1.7.4)"
6198 #: ../src/guestfs-actions.pod:101
6199 msgid "guestfs_add_domain_va"
6203 #: ../src/guestfs-actions.pod:103
6207 " guestfs_add_domain_va (guestfs_h *g,\n"
6208 " const char *dom,\n"
6214 #: ../src/guestfs-actions.pod:108
6215 msgid "This is the \"va_list variant\" of L</guestfs_add_domain>."
6219 #: ../src/guestfs-actions.pod:110 ../src/guestfs-actions.pod:121
6220 #: ../src/guestfs-actions.pod:214 ../src/guestfs-actions.pod:225
6221 #: ../src/guestfs-actions.pod:2840 ../src/guestfs-actions.pod:2852
6222 #: ../src/guestfs-actions.pod:4614 ../src/guestfs-actions.pod:4626
6223 #: ../src/guestfs-actions.pod:4896 ../src/guestfs-actions.pod:4908
6224 msgid "See L</CALLS WITH OPTIONAL ARGUMENTS>."
6228 #: ../src/guestfs-actions.pod:112
6229 msgid "guestfs_add_domain_argv"
6233 #: ../src/guestfs-actions.pod:114
6237 " guestfs_add_domain_argv (guestfs_h *g,\n"
6238 " const char *dom,\n"
6239 " const struct guestfs_add_domain_argv *optargs);\n"
6244 #: ../src/guestfs-actions.pod:119
6245 msgid "This is the \"argv variant\" of L</guestfs_add_domain>."
6249 #: ../src/guestfs-actions.pod:123
6250 msgid "guestfs_add_drive"
6254 #: ../src/guestfs-actions.pod:125
6258 " guestfs_add_drive (guestfs_h *g,\n"
6259 " const char *filename);\n"
6264 #: ../src/guestfs-actions.pod:129
6266 "This function is the equivalent of calling C<guestfs_add_drive_opts> with no "
6267 "optional parameters, so the disk is added writable, with the format being "
6268 "detected automatically."
6272 #: ../src/guestfs-actions.pod:133
6274 "Automatic detection of the format opens you up to a potential security hole "
6275 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
6276 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
6277 "you should think about replacing calls to this function with calls to "
6278 "C<guestfs_add_drive_opts>, and specifying the format."
6282 #: ../src/guestfs-actions.pod:144
6283 msgid "guestfs_add_drive_opts"
6287 #: ../src/guestfs-actions.pod:146
6291 " guestfs_add_drive_opts (guestfs_h *g,\n"
6292 " const char *filename,\n"
6298 #: ../src/guestfs-actions.pod:156
6301 " GUESTFS_ADD_DRIVE_OPTS_READONLY, int readonly,\n"
6302 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, const char *format,\n"
6303 " GUESTFS_ADD_DRIVE_OPTS_IFACE, const char *iface,\n"
6308 #: ../src/guestfs-actions.pod:160 ../fish/guestfish-actions.pod:102
6310 "This function adds a virtual machine disk image C<filename> to libguestfs. "
6311 "The first time you call this function, the disk appears as C</dev/sda>, the "
6312 "second time as C</dev/sdb>, and so on."
6316 #: ../src/guestfs-actions.pod:165 ../fish/guestfish-actions.pod:107
6318 "You don't necessarily need to be root when using libguestfs. However you "
6319 "obviously do need sufficient permissions to access the filename for whatever "
6320 "operations you want to perform (ie. read access if you just want to read the "
6321 "image or write access if you want to modify the image)."
6325 #: ../src/guestfs-actions.pod:171 ../fish/guestfish-actions.pod:113
6326 msgid "This call checks that C<filename> exists."
6330 #: ../src/guestfs-actions.pod:173 ../src/guestfs-actions.pod:4562
6331 #: ../fish/guestfish-actions.pod:115 ../fish/guestfish-actions.pod:3049
6332 msgid "The optional arguments are:"
6336 #: ../src/guestfs-actions.pod:177 ../fish/guestfish-actions.pod:119
6338 msgstr "C<readonly>"
6341 #: ../src/guestfs-actions.pod:179 ../fish/guestfish-actions.pod:121
6343 "If true then the image is treated as read-only. Writes are still allowed, "
6344 "but they are stored in a temporary snapshot overlay which is discarded at "
6345 "the end. The disk that you add is not modified."
6349 #: ../src/guestfs-actions.pod:183 ../fish/guestfish-actions.pod:125
6354 #: ../src/guestfs-actions.pod:185
6356 "This forces the image format. If you omit this (or use C<guestfs_add_drive> "
6357 "or C<guestfs_add_drive_ro>) then the format is automatically detected. "
6358 "Possible formats include C<raw> and C<qcow2>."
6362 #: ../src/guestfs-actions.pod:189 ../fish/guestfish-actions.pod:131
6364 "Automatic detection of the format opens you up to a potential security hole "
6365 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
6366 "RHBZ#642934. Specifying the format closes this security hole."
6370 #: ../src/guestfs-actions.pod:194 ../fish/guestfish-actions.pod:136
6375 #: ../src/guestfs-actions.pod:196
6377 "This rarely-used option lets you emulate the behaviour of the deprecated "
6378 "C<guestfs_add_drive_with_if> call (q.v.)"
6382 #: ../src/guestfs-actions.pod:203
6383 msgid "(Added in 1.5.23)"
6387 #: ../src/guestfs-actions.pod:205
6388 msgid "guestfs_add_drive_opts_va"
6392 #: ../src/guestfs-actions.pod:207
6396 " guestfs_add_drive_opts_va (guestfs_h *g,\n"
6397 " const char *filename,\n"
6403 #: ../src/guestfs-actions.pod:212
6404 msgid "This is the \"va_list variant\" of L</guestfs_add_drive_opts>."
6408 #: ../src/guestfs-actions.pod:216
6409 msgid "guestfs_add_drive_opts_argv"
6413 #: ../src/guestfs-actions.pod:218
6417 " guestfs_add_drive_opts_argv (guestfs_h *g,\n"
6418 " const char *filename,\n"
6419 " const struct guestfs_add_drive_opts_argv *optargs);\n"
6424 #: ../src/guestfs-actions.pod:223
6425 msgid "This is the \"argv variant\" of L</guestfs_add_drive_opts>."
6429 #: ../src/guestfs-actions.pod:227
6430 msgid "guestfs_add_drive_ro"
6434 #: ../src/guestfs-actions.pod:229
6438 " guestfs_add_drive_ro (guestfs_h *g,\n"
6439 " const char *filename);\n"
6444 #: ../src/guestfs-actions.pod:233
6446 "This function is the equivalent of calling C<guestfs_add_drive_opts> with "
6447 "the optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the "
6448 "disk is added read-only, with the format being detected automatically."
6452 #: ../src/guestfs-actions.pod:240
6453 msgid "(Added in 1.0.38)"
6457 #: ../src/guestfs-actions.pod:242
6458 msgid "guestfs_add_drive_ro_with_if"
6462 #: ../src/guestfs-actions.pod:244
6466 " guestfs_add_drive_ro_with_if (guestfs_h *g,\n"
6467 " const char *filename,\n"
6468 " const char *iface);\n"
6473 #: ../src/guestfs-actions.pod:249
6475 "This is the same as C<guestfs_add_drive_ro> but it allows you to specify the "
6476 "QEMU interface emulation to use at run time."
6480 #: ../src/guestfs-actions.pod:261 ../src/guestfs-actions.pod:282
6481 #: ../src/guestfs-actions.pod:2361
6482 msgid "(Added in 1.0.84)"
6486 #: ../src/guestfs-actions.pod:263
6487 msgid "guestfs_add_drive_with_if"
6491 #: ../src/guestfs-actions.pod:265
6495 " guestfs_add_drive_with_if (guestfs_h *g,\n"
6496 " const char *filename,\n"
6497 " const char *iface);\n"
6502 #: ../src/guestfs-actions.pod:270
6504 "This is the same as C<guestfs_add_drive> but it allows you to specify the "
6505 "QEMU interface emulation to use at run time."
6509 #: ../src/guestfs-actions.pod:284
6510 msgid "guestfs_aug_clear"
6514 #: ../src/guestfs-actions.pod:286
6518 " guestfs_aug_clear (guestfs_h *g,\n"
6519 " const char *augpath);\n"
6524 #: ../src/guestfs-actions.pod:290 ../fish/guestfish-actions.pod:188
6526 "Set the value associated with C<path> to C<NULL>. This is the same as the "
6527 "L<augtool(1)> C<clear> command."
6531 #: ../src/guestfs-actions.pod:295 ../src/guestfs-actions.pod:2111
6532 msgid "(Added in 1.3.4)"
6536 #: ../src/guestfs-actions.pod:297
6537 msgid "guestfs_aug_close"
6541 #: ../src/guestfs-actions.pod:299
6545 " guestfs_aug_close (guestfs_h *g);\n"
6550 #: ../src/guestfs-actions.pod:302
6552 "Close the current Augeas handle and free up any resources used by it. After "
6553 "calling this, you have to call C<guestfs_aug_init> again before you can use "
6554 "any other Augeas functions."
6558 #: ../src/guestfs-actions.pod:309 ../src/guestfs-actions.pod:334
6559 #: ../src/guestfs-actions.pod:352 ../src/guestfs-actions.pod:366
6560 #: ../src/guestfs-actions.pod:424 ../src/guestfs-actions.pod:444
6561 #: ../src/guestfs-actions.pod:458 ../src/guestfs-actions.pod:489
6562 #: ../src/guestfs-actions.pod:503 ../src/guestfs-actions.pod:517
6563 #: ../src/guestfs-actions.pod:531 ../src/guestfs-actions.pod:549
6564 #: ../src/guestfs-actions.pod:5655
6565 msgid "(Added in 0.7)"
6569 #: ../src/guestfs-actions.pod:311
6570 msgid "guestfs_aug_defnode"
6574 #: ../src/guestfs-actions.pod:313
6577 " struct guestfs_int_bool *\n"
6578 " guestfs_aug_defnode (guestfs_h *g,\n"
6579 " const char *name,\n"
6580 " const char *expr,\n"
6581 " const char *val);\n"
6586 #: ../src/guestfs-actions.pod:319 ../fish/guestfish-actions.pod:204
6588 "Defines a variable C<name> whose value is the result of evaluating C<expr>."
6592 #: ../src/guestfs-actions.pod:322
6594 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
6595 "calling C<guestfs_aug_set> C<expr>, C<value>. C<name> will be the nodeset "
6596 "containing that single node."
6600 #: ../src/guestfs-actions.pod:326 ../fish/guestfish-actions.pod:211
6602 "On success this returns a pair containing the number of nodes in the "
6603 "nodeset, and a boolean flag if a node was created."
6607 #: ../src/guestfs-actions.pod:330
6609 "This function returns a C<struct guestfs_int_bool *>, or NULL if there was "
6610 "an error. I<The caller must call C<guestfs_free_int_bool> after use>."
6614 #: ../src/guestfs-actions.pod:336
6615 msgid "guestfs_aug_defvar"
6619 #: ../src/guestfs-actions.pod:338
6623 " guestfs_aug_defvar (guestfs_h *g,\n"
6624 " const char *name,\n"
6625 " const char *expr);\n"
6630 #: ../src/guestfs-actions.pod:343 ../fish/guestfish-actions.pod:219
6632 "Defines an Augeas variable C<name> whose value is the result of evaluating "
6633 "C<expr>. If C<expr> is NULL, then C<name> is undefined."
6637 #: ../src/guestfs-actions.pod:347 ../fish/guestfish-actions.pod:223
6639 "On success this returns the number of nodes in C<expr>, or C<0> if C<expr> "
6640 "evaluates to something which is not a nodeset."
6644 #: ../src/guestfs-actions.pod:354
6645 msgid "guestfs_aug_get"
6649 #: ../src/guestfs-actions.pod:356
6653 " guestfs_aug_get (guestfs_h *g,\n"
6654 " const char *augpath);\n"
6659 #: ../src/guestfs-actions.pod:360 ../fish/guestfish-actions.pod:230
6661 "Look up the value associated with C<path>. If C<path> matches exactly one "
6662 "node, the C<value> is returned."
6666 #: ../src/guestfs-actions.pod:363 ../src/guestfs-actions.pod:863
6667 #: ../src/guestfs-actions.pod:881 ../src/guestfs-actions.pod:941
6668 #: ../src/guestfs-actions.pod:957 ../src/guestfs-actions.pod:1060
6669 #: ../src/guestfs-actions.pod:1190 ../src/guestfs-actions.pod:1207
6670 #: ../src/guestfs-actions.pod:1226 ../src/guestfs-actions.pod:1360
6671 #: ../src/guestfs-actions.pod:1548 ../src/guestfs-actions.pod:1660
6672 #: ../src/guestfs-actions.pod:1823 ../src/guestfs-actions.pod:1840
6673 #: ../src/guestfs-actions.pod:1907 ../src/guestfs-actions.pod:1943
6674 #: ../src/guestfs-actions.pod:1964 ../src/guestfs-actions.pod:2134
6675 #: ../src/guestfs-actions.pod:2326 ../src/guestfs-actions.pod:2530
6676 #: ../src/guestfs-actions.pod:2620 ../src/guestfs-actions.pod:2724
6677 #: ../src/guestfs-actions.pod:2743 ../src/guestfs-actions.pod:2957
6678 #: ../src/guestfs-actions.pod:2985 ../src/guestfs-actions.pod:3006
6679 #: ../src/guestfs-actions.pod:3040 ../src/guestfs-actions.pod:3099
6680 #: ../src/guestfs-actions.pod:3119 ../src/guestfs-actions.pod:3139
6681 #: ../src/guestfs-actions.pod:3746 ../src/guestfs-actions.pod:4096
6682 #: ../src/guestfs-actions.pod:4266 ../src/guestfs-actions.pod:4376
6683 #: ../src/guestfs-actions.pod:5190 ../src/guestfs-actions.pod:5383
6684 #: ../src/guestfs-actions.pod:5553 ../src/guestfs-actions.pod:5731
6685 #: ../src/guestfs-actions.pod:5780 ../src/guestfs-actions.pod:6417
6686 #: ../src/guestfs-actions.pod:6433 ../src/guestfs-actions.pod:6450
6687 #: ../src/guestfs-actions.pod:6481 ../src/guestfs-actions.pod:7155
6688 #: ../src/guestfs-actions.pod:7174 ../src/guestfs-actions.pod:7192
6689 #: ../src/guestfs-actions.pod:7372 ../src/guestfs-actions.pod:7652
6691 "This function returns a string, or NULL on error. I<The caller must free "
6692 "the returned string after use>."
6696 #: ../src/guestfs-actions.pod:368
6697 msgid "guestfs_aug_init"
6701 #: ../src/guestfs-actions.pod:370
6705 " guestfs_aug_init (guestfs_h *g,\n"
6706 " const char *root,\n"
6712 #: ../src/guestfs-actions.pod:375 ../fish/guestfish-actions.pod:237
6714 "Create a new Augeas handle for editing configuration files. If there was "
6715 "any previous Augeas handle associated with this guestfs session, then it is "
6720 #: ../src/guestfs-actions.pod:379
6721 msgid "You must call this before using any other C<guestfs_aug_*> commands."
6725 #: ../src/guestfs-actions.pod:382 ../fish/guestfish-actions.pod:244
6727 "C<root> is the filesystem root. C<root> must not be NULL, use C</> instead."
6731 #: ../src/guestfs-actions.pod:385 ../fish/guestfish-actions.pod:247
6733 "The flags are the same as the flags defined in E<lt>augeas.hE<gt>, the "
6734 "logical I<or> of the following integers:"
6738 #: ../src/guestfs-actions.pod:391 ../fish/guestfish-actions.pod:253
6739 msgid "C<AUG_SAVE_BACKUP> = 1"
6740 msgstr "C<AUG_SAVE_BACKUP> = 1"
6743 #: ../src/guestfs-actions.pod:393 ../fish/guestfish-actions.pod:255
6744 msgid "Keep the original file with a C<.augsave> extension."
6748 #: ../src/guestfs-actions.pod:395 ../fish/guestfish-actions.pod:257
6749 msgid "C<AUG_SAVE_NEWFILE> = 2"
6750 msgstr "C<AUG_SAVE_NEWFILE> = 2"
6753 #: ../src/guestfs-actions.pod:397 ../fish/guestfish-actions.pod:259
6755 "Save changes into a file with extension C<.augnew>, and do not overwrite "
6756 "original. Overrides C<AUG_SAVE_BACKUP>."
6760 #: ../src/guestfs-actions.pod:400 ../fish/guestfish-actions.pod:262
6761 msgid "C<AUG_TYPE_CHECK> = 4"
6762 msgstr "C<AUG_TYPE_CHECK> = 4"
6765 #: ../src/guestfs-actions.pod:402 ../fish/guestfish-actions.pod:264
6766 msgid "Typecheck lenses (can be expensive)."
6770 #: ../src/guestfs-actions.pod:404 ../fish/guestfish-actions.pod:266
6771 msgid "C<AUG_NO_STDINC> = 8"
6772 msgstr "C<AUG_NO_STDINC> = 8"
6775 #: ../src/guestfs-actions.pod:406 ../fish/guestfish-actions.pod:268
6776 msgid "Do not use standard load path for modules."
6780 #: ../src/guestfs-actions.pod:408 ../fish/guestfish-actions.pod:270
6781 msgid "C<AUG_SAVE_NOOP> = 16"
6782 msgstr "C<AUG_SAVE_NOOP> = 16"
6785 #: ../src/guestfs-actions.pod:410 ../fish/guestfish-actions.pod:272
6786 msgid "Make save a no-op, just record what would have been changed."
6790 #: ../src/guestfs-actions.pod:412 ../fish/guestfish-actions.pod:274
6791 msgid "C<AUG_NO_LOAD> = 32"
6792 msgstr "C<AUG_NO_LOAD> = 32"
6795 #: ../src/guestfs-actions.pod:414
6796 msgid "Do not load the tree in C<guestfs_aug_init>."
6800 #: ../src/guestfs-actions.pod:418
6801 msgid "To close the handle, you can call C<guestfs_aug_close>."
6805 #: ../src/guestfs-actions.pod:420 ../fish/guestfish-actions.pod:282
6806 msgid "To find out more about Augeas, see L<http://augeas.net/>."
6810 #: ../src/guestfs-actions.pod:426
6811 msgid "guestfs_aug_insert"
6815 #: ../src/guestfs-actions.pod:428
6819 " guestfs_aug_insert (guestfs_h *g,\n"
6820 " const char *augpath,\n"
6821 " const char *label,\n"
6827 #: ../src/guestfs-actions.pod:434 ../fish/guestfish-actions.pod:288
6829 "Create a new sibling C<label> for C<path>, inserting it into the tree before "
6830 "or after C<path> (depending on the boolean flag C<before>)."
6834 #: ../src/guestfs-actions.pod:438 ../fish/guestfish-actions.pod:292
6836 "C<path> must match exactly one existing node in the tree, and C<label> must "
6837 "be a label, ie. not contain C</>, C<*> or end with a bracketed index C<[N]>."
6841 #: ../src/guestfs-actions.pod:446
6842 msgid "guestfs_aug_load"
6846 #: ../src/guestfs-actions.pod:448
6850 " guestfs_aug_load (guestfs_h *g);\n"
6855 #: ../src/guestfs-actions.pod:451 ../fish/guestfish-actions.pod:300
6856 msgid "Load files into the tree."
6857 msgstr "Завантажити файли до ієрархії."
6860 #: ../src/guestfs-actions.pod:453 ../fish/guestfish-actions.pod:302
6861 msgid "See C<aug_load> in the Augeas documentation for the full gory details."
6865 #: ../src/guestfs-actions.pod:460
6866 msgid "guestfs_aug_ls"
6870 #: ../src/guestfs-actions.pod:462
6874 " guestfs_aug_ls (guestfs_h *g,\n"
6875 " const char *augpath);\n"
6880 #: ../src/guestfs-actions.pod:466
6882 "This is just a shortcut for listing C<guestfs_aug_match> C<path/*> and "
6883 "sorting the resulting nodes into alphabetical order."
6887 #: ../src/guestfs-actions.pod:469 ../src/guestfs-actions.pod:485
6888 #: ../src/guestfs-actions.pod:631 ../src/guestfs-actions.pod:1079
6889 #: ../src/guestfs-actions.pod:1375 ../src/guestfs-actions.pod:1394
6890 #: ../src/guestfs-actions.pod:1497 ../src/guestfs-actions.pod:1516
6891 #: ../src/guestfs-actions.pod:1762 ../src/guestfs-actions.pod:2206
6892 #: ../src/guestfs-actions.pod:2222 ../src/guestfs-actions.pod:2241
6893 #: ../src/guestfs-actions.pod:2284 ../src/guestfs-actions.pod:2308
6894 #: ../src/guestfs-actions.pod:2379 ../src/guestfs-actions.pod:2428
6895 #: ../src/guestfs-actions.pod:2685 ../src/guestfs-actions.pod:3059
6896 #: ../src/guestfs-actions.pod:3335 ../src/guestfs-actions.pod:3649
6897 #: ../src/guestfs-actions.pod:3666 ../src/guestfs-actions.pod:3728
6898 #: ../src/guestfs-actions.pod:3833 ../src/guestfs-actions.pod:4238
6899 #: ../src/guestfs-actions.pod:5005 ../src/guestfs-actions.pod:5525
6900 #: ../src/guestfs-actions.pod:5651 ../src/guestfs-actions.pod:5765
6901 #: ../src/guestfs-actions.pod:6497 ../src/guestfs-actions.pod:6558
6902 #: ../src/guestfs-actions.pod:6613 ../src/guestfs-actions.pod:6759
6903 #: ../src/guestfs-actions.pod:6783 ../src/guestfs-actions.pod:7265
6904 #: ../src/guestfs-actions.pod:7285 ../src/guestfs-actions.pod:7332
6905 #: ../src/guestfs-actions.pod:7504 ../src/guestfs-actions.pod:7523
6906 #: ../src/guestfs-actions.pod:7609 ../src/guestfs-actions.pod:7628
6907 #: ../src/guestfs-actions.pod:7674 ../src/guestfs-actions.pod:7693
6909 "This function returns a NULL-terminated array of strings (like L<environ(3)"
6910 ">), or NULL if there was an error. I<The caller must free the strings and "
6911 "the array after use>."
6915 #: ../src/guestfs-actions.pod:473 ../src/guestfs-actions.pod:1004
6916 #: ../src/guestfs-actions.pod:1022 ../src/guestfs-actions.pod:1432
6917 #: ../src/guestfs-actions.pod:3413 ../src/guestfs-actions.pod:3444
6918 #: ../src/guestfs-actions.pod:4079 ../src/guestfs-actions.pod:4129
6919 #: ../src/guestfs-actions.pod:4316 ../src/guestfs-actions.pod:4349
6920 #: ../src/guestfs-actions.pod:4512 ../src/guestfs-actions.pod:5009
6921 #: ../src/guestfs-actions.pod:5466 ../src/guestfs-actions.pod:5863
6922 #: ../src/guestfs-actions.pod:5877 ../src/guestfs-actions.pod:5889
6923 #: ../src/guestfs-actions.pod:6338 ../src/guestfs-actions.pod:6997
6924 #: ../src/guestfs-actions.pod:7010 ../src/guestfs-actions.pod:7249
6925 #: ../src/guestfs-actions.pod:7492
6926 msgid "(Added in 0.8)"
6930 #: ../src/guestfs-actions.pod:475
6931 msgid "guestfs_aug_match"
6935 #: ../src/guestfs-actions.pod:477
6939 " guestfs_aug_match (guestfs_h *g,\n"
6940 " const char *augpath);\n"
6945 #: ../src/guestfs-actions.pod:481 ../fish/guestfish-actions.pod:316
6947 "Returns a list of paths which match the path expression C<path>. The "
6948 "returned paths are sufficiently qualified so that they match exactly one "
6949 "node in the current tree."
6953 #: ../src/guestfs-actions.pod:491
6954 msgid "guestfs_aug_mv"
6958 #: ../src/guestfs-actions.pod:493
6962 " guestfs_aug_mv (guestfs_h *g,\n"
6963 " const char *src,\n"
6964 " const char *dest);\n"
6969 #: ../src/guestfs-actions.pod:498 ../fish/guestfish-actions.pod:324
6971 "Move the node C<src> to C<dest>. C<src> must match exactly one node. "
6972 "C<dest> is overwritten if it exists."
6976 #: ../src/guestfs-actions.pod:505
6977 msgid "guestfs_aug_rm"
6981 #: ../src/guestfs-actions.pod:507
6985 " guestfs_aug_rm (guestfs_h *g,\n"
6986 " const char *augpath);\n"
6991 #: ../src/guestfs-actions.pod:511 ../fish/guestfish-actions.pod:331
6992 msgid "Remove C<path> and all of its children."
6996 #: ../src/guestfs-actions.pod:513 ../fish/guestfish-actions.pod:333
6997 msgid "On success this returns the number of entries which were removed."
7001 #: ../src/guestfs-actions.pod:519
7002 msgid "guestfs_aug_save"
7006 #: ../src/guestfs-actions.pod:521
7010 " guestfs_aug_save (guestfs_h *g);\n"
7015 #: ../src/guestfs-actions.pod:524 ../fish/guestfish-actions.pod:339
7016 msgid "This writes all pending changes to disk."
7020 #: ../src/guestfs-actions.pod:526
7022 "The flags which were passed to C<guestfs_aug_init> affect exactly how files "
7027 #: ../src/guestfs-actions.pod:533
7028 msgid "guestfs_aug_set"
7032 #: ../src/guestfs-actions.pod:535
7036 " guestfs_aug_set (guestfs_h *g,\n"
7037 " const char *augpath,\n"
7038 " const char *val);\n"
7043 #: ../src/guestfs-actions.pod:540 ../fish/guestfish-actions.pod:348
7044 msgid "Set the value associated with C<path> to C<val>."
7048 #: ../src/guestfs-actions.pod:542
7050 "In the Augeas API, it is possible to clear a node by setting the value to "
7051 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
7052 "this call. Instead you must use the C<guestfs_aug_clear> call."
7056 #: ../src/guestfs-actions.pod:551
7057 msgid "guestfs_available"
7061 #: ../src/guestfs-actions.pod:553
7065 " guestfs_available (guestfs_h *g,\n"
7066 " char *const *groups);\n"
7071 #: ../src/guestfs-actions.pod:557 ../fish/guestfish-actions.pod:359
7073 "This command is used to check the availability of some groups of "
7074 "functionality in the appliance, which not all builds of the libguestfs "
7075 "appliance will be able to provide."
7079 #: ../src/guestfs-actions.pod:561
7081 "The libguestfs groups, and the functions that those groups correspond to, "
7082 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
7083 "runtime by calling C<guestfs_available_all_groups>."
7087 #: ../src/guestfs-actions.pod:566 ../fish/guestfish-actions.pod:368
7089 "The argument C<groups> is a list of group names, eg: C<[\"inotify\", \"augeas"
7090 "\"]> would check for the availability of the Linux inotify functions and "
7091 "Augeas (configuration file editing) functions."
7095 #: ../src/guestfs-actions.pod:571 ../fish/guestfish-actions.pod:373
7096 msgid "The command returns no error if I<all> requested groups are available."
7100 #: ../src/guestfs-actions.pod:573 ../fish/guestfish-actions.pod:375
7102 "It fails with an error if one or more of the requested groups is unavailable "
7107 #: ../src/guestfs-actions.pod:576 ../fish/guestfish-actions.pod:378
7109 "If an unknown group name is included in the list of groups then an error is "
7114 #: ../src/guestfs-actions.pod:579 ../fish/guestfish-actions.pod:381
7116 msgstr "I<Нотатки:>"
7119 #: ../src/guestfs-actions.pod:585
7120 msgid "You must call C<guestfs_launch> before calling this function."
7124 #: ../src/guestfs-actions.pod:587 ../fish/guestfish-actions.pod:389
7126 "The reason is because we don't know what groups are supported by the "
7127 "appliance/daemon until it is running and can be queried."
7131 #: ../src/guestfs-actions.pod:593 ../fish/guestfish-actions.pod:395
7133 "If a group of functions is available, this does not necessarily mean that "
7134 "they will work. You still have to check for errors when calling individual "
7135 "API functions even if they are available."
7139 #: ../src/guestfs-actions.pod:600 ../fish/guestfish-actions.pod:402
7141 "It is usually the job of distro packagers to build complete functionality "
7142 "into the libguestfs appliance. Upstream libguestfs, if built from source "
7143 "with all requirements satisfied, will support everything."
7147 #: ../src/guestfs-actions.pod:607
7149 "This call was added in version C<1.0.80>. In previous versions of "
7150 "libguestfs all you could do would be to speculatively execute a command to "
7151 "find out if the daemon implemented it. See also C<guestfs_version>."
7155 #: ../src/guestfs-actions.pod:616 ../src/guestfs-actions.pod:1177
7156 msgid "(Added in 1.0.80)"
7160 #: ../src/guestfs-actions.pod:618
7161 msgid "guestfs_available_all_groups"
7165 #: ../src/guestfs-actions.pod:620
7169 " guestfs_available_all_groups (guestfs_h *g);\n"
7174 #: ../src/guestfs-actions.pod:623
7176 "This command returns a list of all optional groups that this daemon knows "
7177 "about. Note this returns both supported and unsupported groups. To find "
7178 "out which ones the daemon can actually support you have to call "
7179 "C<guestfs_available> on each member of the returned list."
7183 #: ../src/guestfs-actions.pod:629
7184 msgid "See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>."
7188 #: ../src/guestfs-actions.pod:635
7189 msgid "(Added in 1.3.15)"
7193 #: ../src/guestfs-actions.pod:637
7194 msgid "guestfs_base64_in"
7198 #: ../src/guestfs-actions.pod:639
7202 " guestfs_base64_in (guestfs_h *g,\n"
7203 " const char *base64file,\n"
7204 " const char *filename);\n"
7209 #: ../src/guestfs-actions.pod:644 ../fish/guestfish-actions.pod:432
7211 "This command uploads base64-encoded data from C<base64file> to C<filename>."
7215 #: ../src/guestfs-actions.pod:649 ../src/guestfs-actions.pod:663
7216 msgid "(Added in 1.3.5)"
7220 #: ../src/guestfs-actions.pod:651
7221 msgid "guestfs_base64_out"
7225 #: ../src/guestfs-actions.pod:653
7229 " guestfs_base64_out (guestfs_h *g,\n"
7230 " const char *filename,\n"
7231 " const char *base64file);\n"
7236 #: ../src/guestfs-actions.pod:658 ../fish/guestfish-actions.pod:441
7238 "This command downloads the contents of C<filename>, writing it out to local "
7239 "file C<base64file> encoded as base64."
7243 #: ../src/guestfs-actions.pod:665
7244 msgid "guestfs_blockdev_flushbufs"
7248 #: ../src/guestfs-actions.pod:667
7252 " guestfs_blockdev_flushbufs (guestfs_h *g,\n"
7253 " const char *device);\n"
7258 #: ../src/guestfs-actions.pod:671 ../fish/guestfish-actions.pod:450
7260 "This tells the kernel to flush internal buffers associated with C<device>."
7264 #: ../src/guestfs-actions.pod:674 ../src/guestfs-actions.pod:691
7265 #: ../src/guestfs-actions.pod:706 ../src/guestfs-actions.pod:722
7266 #: ../src/guestfs-actions.pod:740 ../src/guestfs-actions.pod:759
7267 #: ../src/guestfs-actions.pod:773 ../src/guestfs-actions.pod:791
7268 #: ../src/guestfs-actions.pod:805 ../src/guestfs-actions.pod:819
7269 #: ../fish/guestfish-actions.pod:453 ../fish/guestfish-actions.pod:464
7270 #: ../fish/guestfish-actions.pod:473 ../fish/guestfish-actions.pod:483
7271 #: ../fish/guestfish-actions.pod:495 ../fish/guestfish-actions.pod:508
7272 #: ../fish/guestfish-actions.pod:516 ../fish/guestfish-actions.pod:527
7273 #: ../fish/guestfish-actions.pod:535 ../fish/guestfish-actions.pod:543
7274 msgid "This uses the L<blockdev(8)> command."
7278 #: ../src/guestfs-actions.pod:678 ../src/guestfs-actions.pod:695
7279 #: ../src/guestfs-actions.pod:710 ../src/guestfs-actions.pod:726
7280 #: ../src/guestfs-actions.pod:744 ../src/guestfs-actions.pod:763
7281 #: ../src/guestfs-actions.pod:777 ../src/guestfs-actions.pod:795
7282 #: ../src/guestfs-actions.pod:809 ../src/guestfs-actions.pod:823
7283 msgid "(Added in 0.9.3)"
7287 #: ../src/guestfs-actions.pod:680
7288 msgid "guestfs_blockdev_getbsz"
7292 #: ../src/guestfs-actions.pod:682
7296 " guestfs_blockdev_getbsz (guestfs_h *g,\n"
7297 " const char *device);\n"
7302 #: ../src/guestfs-actions.pod:686 ../fish/guestfish-actions.pod:459
7303 msgid "This returns the block size of a device."
7307 #: ../src/guestfs-actions.pod:688 ../src/guestfs-actions.pod:788
7308 #: ../fish/guestfish-actions.pod:461 ../fish/guestfish-actions.pod:524
7310 "(Note this is different from both I<size in blocks> and I<filesystem block "
7315 #: ../src/guestfs-actions.pod:697
7316 msgid "guestfs_blockdev_getro"
7320 #: ../src/guestfs-actions.pod:699
7324 " guestfs_blockdev_getro (guestfs_h *g,\n"
7325 " const char *device);\n"
7330 #: ../src/guestfs-actions.pod:703 ../fish/guestfish-actions.pod:470
7332 "Returns a boolean indicating if the block device is read-only (true if read-"
7333 "only, false if not)."
7337 #: ../src/guestfs-actions.pod:708 ../src/guestfs-actions.pod:1415
7338 #: ../src/guestfs-actions.pod:1430 ../src/guestfs-actions.pod:1919
7339 #: ../src/guestfs-actions.pod:1930 ../src/guestfs-actions.pod:2002
7340 #: ../src/guestfs-actions.pod:2057 ../src/guestfs-actions.pod:2072
7341 #: ../src/guestfs-actions.pod:2097 ../src/guestfs-actions.pod:2120
7342 #: ../src/guestfs-actions.pod:3156 ../src/guestfs-actions.pod:3172
7343 #: ../src/guestfs-actions.pod:3190 ../src/guestfs-actions.pod:3352
7344 #: ../src/guestfs-actions.pod:3366 ../src/guestfs-actions.pod:3381
7345 #: ../src/guestfs-actions.pod:3395 ../src/guestfs-actions.pod:3411
7346 #: ../src/guestfs-actions.pod:3426 ../src/guestfs-actions.pod:3442
7347 #: ../src/guestfs-actions.pod:3456 ../src/guestfs-actions.pod:3469
7348 #: ../src/guestfs-actions.pod:3483 ../src/guestfs-actions.pod:3498
7349 #: ../src/guestfs-actions.pod:3513 ../src/guestfs-actions.pod:3526
7350 #: ../src/guestfs-actions.pod:3540 ../src/guestfs-actions.pod:5154
7351 msgid "This function returns a C truth value on success or -1 on error."
7355 #: ../src/guestfs-actions.pod:712
7356 msgid "guestfs_blockdev_getsize64"
7360 #: ../src/guestfs-actions.pod:714
7364 " guestfs_blockdev_getsize64 (guestfs_h *g,\n"
7365 " const char *device);\n"
7370 #: ../src/guestfs-actions.pod:718 ../fish/guestfish-actions.pod:479
7371 msgid "This returns the size of the device in bytes."
7375 #: ../src/guestfs-actions.pod:720
7376 msgid "See also C<guestfs_blockdev_getsz>."
7380 #: ../src/guestfs-actions.pod:728
7381 msgid "guestfs_blockdev_getss"
7385 #: ../src/guestfs-actions.pod:730
7389 " guestfs_blockdev_getss (guestfs_h *g,\n"
7390 " const char *device);\n"
7395 #: ../src/guestfs-actions.pod:734 ../fish/guestfish-actions.pod:489
7397 "This returns the size of sectors on a block device. Usually 512, but can be "
7398 "larger for modern devices."
7402 #: ../src/guestfs-actions.pod:737
7404 "(Note, this is not the size in sectors, use C<guestfs_blockdev_getsz> for "
7409 #: ../src/guestfs-actions.pod:746
7410 msgid "guestfs_blockdev_getsz"
7414 #: ../src/guestfs-actions.pod:748
7418 " guestfs_blockdev_getsz (guestfs_h *g,\n"
7419 " const char *device);\n"
7424 #: ../src/guestfs-actions.pod:752 ../fish/guestfish-actions.pod:501
7426 "This returns the size of the device in units of 512-byte sectors (even if "
7427 "the sectorsize isn't 512 bytes ... weird)."
7431 #: ../src/guestfs-actions.pod:755
7433 "See also C<guestfs_blockdev_getss> for the real sector size of the device, "
7434 "and C<guestfs_blockdev_getsize64> for the more useful I<size in bytes>."
7438 #: ../src/guestfs-actions.pod:765
7439 msgid "guestfs_blockdev_rereadpt"
7443 #: ../src/guestfs-actions.pod:767
7447 " guestfs_blockdev_rereadpt (guestfs_h *g,\n"
7448 " const char *device);\n"
7453 #: ../src/guestfs-actions.pod:771 ../fish/guestfish-actions.pod:514
7454 msgid "Reread the partition table on C<device>."
7458 #: ../src/guestfs-actions.pod:779
7459 msgid "guestfs_blockdev_setbsz"
7463 #: ../src/guestfs-actions.pod:781
7467 " guestfs_blockdev_setbsz (guestfs_h *g,\n"
7468 " const char *device,\n"
7469 " int blocksize);\n"
7474 #: ../src/guestfs-actions.pod:786 ../fish/guestfish-actions.pod:522
7475 msgid "This sets the block size of a device."
7479 #: ../src/guestfs-actions.pod:797
7480 msgid "guestfs_blockdev_setro"
7484 #: ../src/guestfs-actions.pod:799
7488 " guestfs_blockdev_setro (guestfs_h *g,\n"
7489 " const char *device);\n"
7494 #: ../src/guestfs-actions.pod:803 ../fish/guestfish-actions.pod:533
7495 msgid "Sets the block device named C<device> to read-only."
7499 #: ../src/guestfs-actions.pod:811
7500 msgid "guestfs_blockdev_setrw"
7504 #: ../src/guestfs-actions.pod:813
7508 " guestfs_blockdev_setrw (guestfs_h *g,\n"
7509 " const char *device);\n"
7514 #: ../src/guestfs-actions.pod:817 ../fish/guestfish-actions.pod:541
7515 msgid "Sets the block device named C<device> to read-write."
7519 #: ../src/guestfs-actions.pod:825
7520 msgid "guestfs_case_sensitive_path"
7524 #: ../src/guestfs-actions.pod:827
7528 " guestfs_case_sensitive_path (guestfs_h *g,\n"
7529 " const char *path);\n"
7534 #: ../src/guestfs-actions.pod:831 ../fish/guestfish-actions.pod:549
7536 "This can be used to resolve case insensitive paths on a filesystem which is "
7537 "case sensitive. The use case is to resolve paths which you have read from "
7538 "Windows configuration files or the Windows Registry, to the true path."
7542 #: ../src/guestfs-actions.pod:836 ../fish/guestfish-actions.pod:554
7544 "The command handles a peculiarity of the Linux ntfs-3g filesystem driver "
7545 "(and probably others), which is that although the underlying filesystem is "
7546 "case-insensitive, the driver exports the filesystem to Linux as case-"
7551 #: ../src/guestfs-actions.pod:841 ../fish/guestfish-actions.pod:559
7553 "One consequence of this is that special directories such as C<c:\\windows> "
7554 "may appear as C</WINDOWS> or C</windows> (or other things) depending on the "
7555 "precise details of how they were created. In Windows itself this would not "
7560 #: ../src/guestfs-actions.pod:847 ../fish/guestfish-actions.pod:565
7562 "Bug or feature? You decide: L<http://www.tuxera.com/community/ntfs-3g-faq/"
7567 #: ../src/guestfs-actions.pod:850 ../fish/guestfish-actions.pod:568
7569 "This function resolves the true case of each element in the path and returns "
7570 "the case-sensitive path."
7574 #: ../src/guestfs-actions.pod:853
7576 "Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\") might return C<"
7577 "\"/WINDOWS/system32\"> (the exact return value would depend on details of "
7578 "how the directories were originally created under Windows)."
7582 #: ../src/guestfs-actions.pod:858 ../fish/guestfish-actions.pod:576
7583 msgid "I<Note>: This function does not handle drive names, backslashes etc."
7587 #: ../src/guestfs-actions.pod:861
7588 msgid "See also C<guestfs_realpath>."
7592 #: ../src/guestfs-actions.pod:866 ../src/guestfs-actions.pod:7177
7593 msgid "(Added in 1.0.75)"
7597 #: ../src/guestfs-actions.pod:868
7602 #: ../src/guestfs-actions.pod:870
7606 " guestfs_cat (guestfs_h *g,\n"
7607 " const char *path);\n"
7612 #: ../src/guestfs-actions.pod:874 ../src/guestfs-actions.pod:5641
7613 #: ../fish/guestfish-actions.pod:585 ../fish/guestfish-actions.pod:3727
7614 msgid "Return the contents of the file named C<path>."
7618 #: ../src/guestfs-actions.pod:876
7620 "Note that this function cannot correctly handle binary files (specifically, "
7621 "files containing C<\\0> character which is treated as end of string). For "
7622 "those you need to use the C<guestfs_read_file> or C<guestfs_download> "
7623 "functions which have a more complex interface."
7627 #: ../src/guestfs-actions.pod:884 ../src/guestfs-actions.pod:1063
7628 #: ../src/guestfs-actions.pod:1083 ../src/guestfs-actions.pod:1379
7629 #: ../src/guestfs-actions.pod:1398 ../src/guestfs-actions.pod:1501
7630 #: ../src/guestfs-actions.pod:1520 ../src/guestfs-actions.pod:1766
7631 #: ../src/guestfs-actions.pod:2226 ../src/guestfs-actions.pod:2245
7632 #: ../src/guestfs-actions.pod:2288 ../src/guestfs-actions.pod:2312
7633 #: ../src/guestfs-actions.pod:2329 ../src/guestfs-actions.pod:2358
7634 #: ../src/guestfs-actions.pod:5423 ../src/guestfs-actions.pod:5449
7635 #: ../src/guestfs-actions.pod:5580 ../src/guestfs-actions.pod:5606
7636 #: ../src/guestfs-actions.pod:5630 ../src/guestfs-actions.pod:6562
7637 #: ../src/guestfs-actions.pod:6617 ../src/guestfs-actions.pod:6763
7638 #: ../src/guestfs-actions.pod:6787 ../src/guestfs-actions.pod:7456
7639 #: ../src/guestfs-actions.pod:7482 ../src/guestfs-actions.pod:7508
7640 #: ../src/guestfs-actions.pod:7527 ../src/guestfs-actions.pod:7613
7641 #: ../src/guestfs-actions.pod:7632 ../src/guestfs-actions.pod:7678
7642 #: ../src/guestfs-actions.pod:7697 ../fish/guestfish-actions.pod:592
7643 #: ../fish/guestfish-actions.pod:727 ../fish/guestfish-actions.pod:739
7644 #: ../fish/guestfish-actions.pod:915 ../fish/guestfish-actions.pod:925
7645 #: ../fish/guestfish-actions.pod:992 ../fish/guestfish-actions.pod:1002
7646 #: ../fish/guestfish-actions.pod:1194 ../fish/guestfish-actions.pod:1495
7647 #: ../fish/guestfish-actions.pod:1505 ../fish/guestfish-actions.pod:1533
7648 #: ../fish/guestfish-actions.pod:1548 ../fish/guestfish-actions.pod:1558
7649 #: ../fish/guestfish-actions.pod:1577 ../fish/guestfish-actions.pod:3597
7650 #: ../fish/guestfish-actions.pod:3612 ../fish/guestfish-actions.pod:3688
7651 #: ../fish/guestfish-actions.pod:3705 ../fish/guestfish-actions.pod:3720
7652 #: ../fish/guestfish-actions.pod:4374 ../fish/guestfish-actions.pod:4420
7653 #: ../fish/guestfish-actions.pod:4505 ../fish/guestfish-actions.pod:4520
7654 #: ../fish/guestfish-actions.pod:4930 ../fish/guestfish-actions.pod:4948
7655 #: ../fish/guestfish-actions.pod:4965 ../fish/guestfish-actions.pod:4975
7656 #: ../fish/guestfish-actions.pod:5024 ../fish/guestfish-actions.pod:5034
7657 #: ../fish/guestfish-actions.pod:5063 ../fish/guestfish-actions.pod:5073
7659 "Because of the message protocol, there is a transfer limit of somewhere "
7660 "between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
7664 #: ../src/guestfs-actions.pod:887 ../src/guestfs-actions.pod:3670
7665 #: ../src/guestfs-actions.pod:3732 ../src/guestfs-actions.pod:3749
7666 #: ../src/guestfs-actions.pod:3837 ../src/guestfs-actions.pod:4242
7667 #: ../src/guestfs-actions.pod:4256 ../src/guestfs-actions.pod:5529
7668 #: ../src/guestfs-actions.pod:5543 ../src/guestfs-actions.pod:7336
7669 #: ../src/guestfs-actions.pod:7350
7670 msgid "(Added in 0.4)"
7674 #: ../src/guestfs-actions.pod:889
7675 msgid "guestfs_checksum"
7679 #: ../src/guestfs-actions.pod:891
7683 " guestfs_checksum (guestfs_h *g,\n"
7684 " const char *csumtype,\n"
7685 " const char *path);\n"
7690 #: ../src/guestfs-actions.pod:896 ../fish/guestfish-actions.pod:599
7692 "This call computes the MD5, SHAx or CRC checksum of the file named C<path>."
7696 #: ../src/guestfs-actions.pod:899 ../fish/guestfish-actions.pod:602
7698 "The type of checksum to compute is given by the C<csumtype> parameter which "
7699 "must have one of the following values:"
7703 #: ../src/guestfs-actions.pod:904 ../fish/guestfish-actions.pod:607
7708 #: ../src/guestfs-actions.pod:906 ../fish/guestfish-actions.pod:609
7710 "Compute the cyclic redundancy check (CRC) specified by POSIX for the "
7715 #: ../src/guestfs-actions.pod:909 ../fish/guestfish-actions.pod:612
7720 #: ../src/guestfs-actions.pod:911 ../fish/guestfish-actions.pod:614
7721 msgid "Compute the MD5 hash (using the C<md5sum> program)."
7725 #: ../src/guestfs-actions.pod:913 ../fish/guestfish-actions.pod:616
7730 #: ../src/guestfs-actions.pod:915 ../fish/guestfish-actions.pod:618
7731 msgid "Compute the SHA1 hash (using the C<sha1sum> program)."
7735 #: ../src/guestfs-actions.pod:917 ../fish/guestfish-actions.pod:620
7740 #: ../src/guestfs-actions.pod:919 ../fish/guestfish-actions.pod:622
7741 msgid "Compute the SHA224 hash (using the C<sha224sum> program)."
7745 #: ../src/guestfs-actions.pod:921 ../fish/guestfish-actions.pod:624
7750 #: ../src/guestfs-actions.pod:923 ../fish/guestfish-actions.pod:626
7751 msgid "Compute the SHA256 hash (using the C<sha256sum> program)."
7755 #: ../src/guestfs-actions.pod:925 ../fish/guestfish-actions.pod:628
7760 #: ../src/guestfs-actions.pod:927 ../fish/guestfish-actions.pod:630
7761 msgid "Compute the SHA384 hash (using the C<sha384sum> program)."
7765 #: ../src/guestfs-actions.pod:929 ../fish/guestfish-actions.pod:632
7770 #: ../src/guestfs-actions.pod:931 ../fish/guestfish-actions.pod:634
7771 msgid "Compute the SHA512 hash (using the C<sha512sum> program)."
7775 #: ../src/guestfs-actions.pod:935 ../fish/guestfish-actions.pod:638
7776 msgid "The checksum is returned as a printable string."
7780 #: ../src/guestfs-actions.pod:937
7781 msgid "To get the checksum for a device, use C<guestfs_checksum_device>."
7785 #: ../src/guestfs-actions.pod:939
7786 msgid "To get the checksums for many files, use C<guestfs_checksums_out>."
7790 #: ../src/guestfs-actions.pod:944 ../src/guestfs-actions.pod:1252
7791 #: ../src/guestfs-actions.pod:2088 ../src/guestfs-actions.pod:3368
7792 #: ../src/guestfs-actions.pod:3397 ../src/guestfs-actions.pod:3458
7793 #: ../src/guestfs-actions.pod:3485 ../src/guestfs-actions.pod:7033
7794 msgid "(Added in 1.0.2)"
7798 #: ../src/guestfs-actions.pod:946
7799 msgid "guestfs_checksum_device"
7803 #: ../src/guestfs-actions.pod:948
7807 " guestfs_checksum_device (guestfs_h *g,\n"
7808 " const char *csumtype,\n"
7809 " const char *device);\n"
7814 #: ../src/guestfs-actions.pod:953
7816 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
7817 "device named C<device>. For the types of checksums supported see the "
7818 "C<guestfs_checksum> command."
7822 #: ../src/guestfs-actions.pod:960 ../src/guestfs-actions.pod:5060
7823 #: ../src/guestfs-actions.pod:5119 ../src/guestfs-actions.pod:5156
7824 #: ../src/guestfs-actions.pod:5174 ../src/guestfs-actions.pod:5350
7825 #: ../src/guestfs-actions.pod:6942 ../src/guestfs-actions.pod:6956
7826 #: ../src/guestfs-actions.pod:7362
7827 msgid "(Added in 1.3.2)"
7831 #: ../src/guestfs-actions.pod:962
7832 msgid "guestfs_checksums_out"
7836 #: ../src/guestfs-actions.pod:964
7840 " guestfs_checksums_out (guestfs_h *g,\n"
7841 " const char *csumtype,\n"
7842 " const char *directory,\n"
7843 " const char *sumsfile);\n"
7848 #: ../src/guestfs-actions.pod:970 ../fish/guestfish-actions.pod:656
7850 "This command computes the checksums of all regular files in C<directory> and "
7851 "then emits a list of those checksums to the local output file C<sumsfile>."
7855 #: ../src/guestfs-actions.pod:974 ../fish/guestfish-actions.pod:660
7857 "This can be used for verifying the integrity of a virtual machine. However "
7858 "to be properly secure you should pay attention to the output of the checksum "
7859 "command (it uses the ones from GNU coreutils). In particular when the "
7860 "filename is not printable, coreutils uses a special backslash syntax. For "
7861 "more information, see the GNU coreutils info file."
7865 #: ../src/guestfs-actions.pod:984
7866 msgid "(Added in 1.3.7)"
7870 #: ../src/guestfs-actions.pod:986
7871 msgid "guestfs_chmod"
7875 #: ../src/guestfs-actions.pod:988
7879 " guestfs_chmod (guestfs_h *g,\n"
7881 " const char *path);\n"
7886 #: ../src/guestfs-actions.pod:993 ../fish/guestfish-actions.pod:674
7888 "Change the mode (permissions) of C<path> to C<mode>. Only numeric modes are "
7893 #: ../src/guestfs-actions.pod:996 ../fish/guestfish-actions.pod:677
7895 "I<Note>: When using this command from guestfish, C<mode> by default would be "
7896 "decimal, unless you prefix it with C<0> to get octal, ie. use C<0700> not "
7901 #: ../src/guestfs-actions.pod:1000 ../src/guestfs-actions.pod:4493
7902 #: ../src/guestfs-actions.pod:4702 ../src/guestfs-actions.pod:4721
7903 #: ../src/guestfs-actions.pod:4740 ../fish/guestfish-actions.pod:681
7904 #: ../fish/guestfish-actions.pod:3013 ../fish/guestfish-actions.pod:3152
7905 #: ../fish/guestfish-actions.pod:3162 ../fish/guestfish-actions.pod:3172
7906 msgid "The mode actually set is affected by the umask."
7910 #: ../src/guestfs-actions.pod:1006
7911 msgid "guestfs_chown"
7915 #: ../src/guestfs-actions.pod:1008
7919 " guestfs_chown (guestfs_h *g,\n"
7922 " const char *path);\n"
7927 #: ../src/guestfs-actions.pod:1014 ../fish/guestfish-actions.pod:687
7928 msgid "Change the file owner to C<owner> and group to C<group>."
7932 #: ../src/guestfs-actions.pod:1016 ../src/guestfs-actions.pod:3587
7933 #: ../fish/guestfish-actions.pod:689 ../fish/guestfish-actions.pod:2464
7935 "Only numeric uid and gid are supported. If you want to use names, you will "
7936 "need to locate and parse the password file yourself (Augeas support makes "
7937 "this relatively easy)."
7941 #: ../src/guestfs-actions.pod:1024
7942 msgid "guestfs_command"
7946 #: ../src/guestfs-actions.pod:1026
7950 " guestfs_command (guestfs_h *g,\n"
7951 " char *const *arguments);\n"
7956 #: ../src/guestfs-actions.pod:1030 ../fish/guestfish-actions.pod:697
7958 "This call runs a command from the guest filesystem. The filesystem must be "
7959 "mounted, and must contain a compatible operating system (ie. something "
7960 "Linux, with the same or compatible processor architecture)."
7964 #: ../src/guestfs-actions.pod:1035
7966 "The single parameter is an argv-style list of arguments. The first element "
7967 "is the name of the program to run. Subsequent elements are parameters. The "
7968 "list must be non-empty (ie. must contain a program name). Note that the "
7969 "command runs directly, and is I<not> invoked via the shell (see "
7974 #: ../src/guestfs-actions.pod:1042 ../fish/guestfish-actions.pod:709
7975 msgid "The return value is anything printed to I<stdout> by the command."
7979 #: ../src/guestfs-actions.pod:1045 ../fish/guestfish-actions.pod:712
7981 "If the command returns a non-zero exit status, then this function returns an "
7982 "error message. The error message string is the content of I<stderr> from "
7987 #: ../src/guestfs-actions.pod:1049 ../fish/guestfish-actions.pod:716
7989 "The C<$PATH> environment variable will contain at least C</usr/bin> and C</"
7990 "bin>. If you require a program from another location, you should provide "
7991 "the full path in the first parameter."
7995 #: ../src/guestfs-actions.pod:1054 ../fish/guestfish-actions.pod:721
7997 "Shared libraries and data files required by the program must be available on "
7998 "filesystems which are mounted in the correct places. It is the caller's "
7999 "responsibility to ensure all filesystems that are needed are mounted at the "
8004 #: ../src/guestfs-actions.pod:1066 ../src/guestfs-actions.pod:1086
8005 #: ../src/guestfs-actions.pod:1551
8006 msgid "(Added in 0.9.1)"
8010 #: ../src/guestfs-actions.pod:1068
8011 msgid "guestfs_command_lines"
8015 #: ../src/guestfs-actions.pod:1070
8019 " guestfs_command_lines (guestfs_h *g,\n"
8020 " char *const *arguments);\n"
8025 #: ../src/guestfs-actions.pod:1074
8027 "This is the same as C<guestfs_command>, but splits the result into a list of "
8032 #: ../src/guestfs-actions.pod:1077
8033 msgid "See also: C<guestfs_sh_lines>"
8037 #: ../src/guestfs-actions.pod:1088
8038 msgid "guestfs_config"
8042 #: ../src/guestfs-actions.pod:1090
8046 " guestfs_config (guestfs_h *g,\n"
8047 " const char *qemuparam,\n"
8048 " const char *qemuvalue);\n"
8053 #: ../src/guestfs-actions.pod:1095 ../fish/guestfish-actions.pod:746
8055 "This can be used to add arbitrary qemu command line parameters of the form "
8056 "I<-param value>. Actually it's not quite arbitrary - we prevent you from "
8057 "setting some parameters which would interfere with parameters that we use."
8061 #: ../src/guestfs-actions.pod:1100 ../fish/guestfish-actions.pod:751
8062 msgid "The first character of C<param> string must be a C<-> (dash)."
8066 #: ../src/guestfs-actions.pod:1102 ../fish/guestfish-actions.pod:753
8067 msgid "C<value> can be NULL."
8071 #: ../src/guestfs-actions.pod:1108
8072 msgid "guestfs_copy_size"
8076 #: ../src/guestfs-actions.pod:1110
8080 " guestfs_copy_size (guestfs_h *g,\n"
8081 " const char *src,\n"
8082 " const char *dest,\n"
8088 #: ../src/guestfs-actions.pod:1116 ../fish/guestfish-actions.pod:759
8090 "This command copies exactly C<size> bytes from one source device or file "
8091 "C<src> to another destination device or file C<dest>."
8095 #: ../src/guestfs-actions.pod:1119 ../fish/guestfish-actions.pod:762
8097 "Note this will fail if the source is too short or if the destination is not "
8102 #: ../src/guestfs-actions.pod:1124 ../src/guestfs-actions.pod:1247
8103 #: ../src/guestfs-actions.pod:1278 ../src/guestfs-actions.pod:1323
8104 #: ../src/guestfs-actions.pod:1700 ../src/guestfs-actions.pod:1722
8105 #: ../src/guestfs-actions.pod:3568 ../src/guestfs-actions.pod:7028
8106 #: ../src/guestfs-actions.pod:7062 ../src/guestfs-actions.pod:7549
8107 #: ../src/guestfs-actions.pod:7568
8109 "This long-running command can generate progress notification messages so "
8110 "that the caller can display a progress bar or indicator. To receive these "
8111 "messages, the caller must register a progress event callback. See L<guestfs"
8112 "(3)/GUESTFS_EVENT_PROGRESS>."
8116 #: ../src/guestfs-actions.pod:1129 ../src/guestfs-actions.pod:4269
8117 #: ../src/guestfs-actions.pod:5556 ../src/guestfs-actions.pod:7269
8118 #: ../src/guestfs-actions.pod:7289 ../src/guestfs-actions.pod:7375
8119 msgid "(Added in 1.0.87)"
8123 #: ../src/guestfs-actions.pod:1131
8128 #: ../src/guestfs-actions.pod:1133
8132 " guestfs_cp (guestfs_h *g,\n"
8133 " const char *src,\n"
8134 " const char *dest);\n"
8139 #: ../src/guestfs-actions.pod:1138 ../fish/guestfish-actions.pod:769
8141 "This copies a file from C<src> to C<dest> where C<dest> is either a "
8142 "destination filename or destination directory."
8146 #: ../src/guestfs-actions.pod:1143 ../src/guestfs-actions.pod:1157
8147 #: ../src/guestfs-actions.pod:1229 ../src/guestfs-actions.pod:1303
8148 #: ../src/guestfs-actions.pod:1417 ../src/guestfs-actions.pod:5023
8149 #: ../src/guestfs-actions.pod:5400
8150 msgid "(Added in 1.0.18)"
8154 #: ../src/guestfs-actions.pod:1145
8155 msgid "guestfs_cp_a"
8159 #: ../src/guestfs-actions.pod:1147
8163 " guestfs_cp_a (guestfs_h *g,\n"
8164 " const char *src,\n"
8165 " const char *dest);\n"
8170 #: ../src/guestfs-actions.pod:1152 ../fish/guestfish-actions.pod:776
8172 "This copies a file or directory from C<src> to C<dest> recursively using the "
8177 #: ../src/guestfs-actions.pod:1159
8182 #: ../src/guestfs-actions.pod:1161
8186 " guestfs_dd (guestfs_h *g,\n"
8187 " const char *src,\n"
8188 " const char *dest);\n"
8193 #: ../src/guestfs-actions.pod:1166 ../fish/guestfish-actions.pod:783
8195 "This command copies from one source device or file C<src> to another "
8196 "destination device or file C<dest>. Normally you would use this to copy to "
8197 "or from a device or partition, for example to duplicate a filesystem."
8201 #: ../src/guestfs-actions.pod:1171
8203 "If the destination is a device, it must be as large or larger than the "
8204 "source file or device, otherwise the copy will fail. This command cannot do "
8205 "partial copies (see C<guestfs_copy_size>)."
8209 #: ../src/guestfs-actions.pod:1179
8214 #: ../src/guestfs-actions.pod:1181
8218 " guestfs_df (guestfs_h *g);\n"
8223 #: ../src/guestfs-actions.pod:1184 ../fish/guestfish-actions.pod:796
8224 msgid "This command runs the C<df> command to report disk space used."
8228 #: ../src/guestfs-actions.pod:1186 ../src/guestfs-actions.pod:1203
8230 "This command is mostly useful for interactive sessions. It is I<not> "
8231 "intended that you try to parse the output string. Use C<guestfs_statvfs> "
8236 #: ../src/guestfs-actions.pod:1193 ../src/guestfs-actions.pod:1210
8237 #: ../src/guestfs-actions.pod:1328 ../src/guestfs-actions.pod:2291
8238 #: ../src/guestfs-actions.pod:2315 ../src/guestfs-actions.pod:2383
8239 #: ../src/guestfs-actions.pod:4379 ../src/guestfs-actions.pod:4923
8240 #: ../src/guestfs-actions.pod:6766 ../src/guestfs-actions.pod:6790
8241 #: ../src/guestfs-actions.pod:7415 ../src/guestfs-actions.pod:7428
8242 #: ../src/guestfs-actions.pod:7441
8243 msgid "(Added in 1.0.54)"
8247 #: ../src/guestfs-actions.pod:1195
8248 msgid "guestfs_df_h"
8252 #: ../src/guestfs-actions.pod:1197
8256 " guestfs_df_h (guestfs_h *g);\n"
8261 #: ../src/guestfs-actions.pod:1200 ../fish/guestfish-actions.pod:806
8263 "This command runs the C<df -h> command to report disk space used in human-"
8268 #: ../src/guestfs-actions.pod:1212
8269 msgid "guestfs_dmesg"
8273 #: ../src/guestfs-actions.pod:1214
8277 " guestfs_dmesg (guestfs_h *g);\n"
8282 #: ../src/guestfs-actions.pod:1217 ../fish/guestfish-actions.pod:817
8284 "This returns the kernel messages (C<dmesg> output) from the guest kernel. "
8285 "This is sometimes useful for extended debugging of problems."
8289 #: ../src/guestfs-actions.pod:1221
8291 "Another way to get the same information is to enable verbose messages with "
8292 "C<guestfs_set_verbose> or by setting the environment variable "
8293 "C<LIBGUESTFS_DEBUG=1> before running the program."
8297 #: ../src/guestfs-actions.pod:1231
8298 msgid "guestfs_download"
8302 #: ../src/guestfs-actions.pod:1233
8306 " guestfs_download (guestfs_h *g,\n"
8307 " const char *remotefilename,\n"
8308 " const char *filename);\n"
8313 #: ../src/guestfs-actions.pod:1238 ../src/guestfs-actions.pod:1263
8314 #: ../fish/guestfish-actions.pod:830 ../fish/guestfish-actions.pod:843
8316 "Download file C<remotefilename> and save it as C<filename> on the local "
8321 #: ../src/guestfs-actions.pod:1241 ../src/guestfs-actions.pod:7022
8322 #: ../fish/guestfish-actions.pod:833 ../fish/guestfish-actions.pod:4678
8323 msgid "C<filename> can also be a named pipe."
8327 #: ../src/guestfs-actions.pod:1243
8328 msgid "See also C<guestfs_upload>, C<guestfs_cat>."
8332 #: ../src/guestfs-actions.pod:1254
8333 msgid "guestfs_download_offset"
8337 #: ../src/guestfs-actions.pod:1256
8341 " guestfs_download_offset (guestfs_h *g,\n"
8342 " const char *remotefilename,\n"
8343 " const char *filename,\n"
8344 " int64_t offset,\n"
8350 #: ../src/guestfs-actions.pod:1266 ../fish/guestfish-actions.pod:846
8352 "C<remotefilename> is read for C<size> bytes starting at C<offset> (this "
8353 "region must be within the file or device)."
8357 #: ../src/guestfs-actions.pod:1269
8359 "Note that there is no limit on the amount of data that can be downloaded "
8360 "with this call, unlike with C<guestfs_pread>, and this call always reads the "
8361 "full amount unless an error occurs."
8365 #: ../src/guestfs-actions.pod:1274
8366 msgid "See also C<guestfs_download>, C<guestfs_pread>."
8370 #: ../src/guestfs-actions.pod:1283 ../src/guestfs-actions.pod:7067
8371 msgid "(Added in 1.5.17)"
8375 #: ../src/guestfs-actions.pod:1285
8376 msgid "guestfs_drop_caches"
8380 #: ../src/guestfs-actions.pod:1287
8384 " guestfs_drop_caches (guestfs_h *g,\n"
8385 " int whattodrop);\n"
8390 #: ../src/guestfs-actions.pod:1291 ../fish/guestfish-actions.pod:862
8392 "This instructs the guest kernel to drop its page cache, and/or dentries and "
8393 "inode caches. The parameter C<whattodrop> tells the kernel what precisely "
8394 "to drop, see L<http://linux-mm.org/Drop_Caches>"
8398 #: ../src/guestfs-actions.pod:1296 ../fish/guestfish-actions.pod:867
8399 msgid "Setting C<whattodrop> to 3 should drop everything."
8403 #: ../src/guestfs-actions.pod:1298 ../fish/guestfish-actions.pod:869
8405 "This automatically calls L<sync(2)> before the operation, so that the "
8406 "maximum guest memory is freed."
8410 #: ../src/guestfs-actions.pod:1305
8415 #: ../src/guestfs-actions.pod:1307
8419 " guestfs_du (guestfs_h *g,\n"
8420 " const char *path);\n"
8425 #: ../src/guestfs-actions.pod:1311 ../fish/guestfish-actions.pod:876
8427 "This command runs the C<du -s> command to estimate file space usage for "
8432 #: ../src/guestfs-actions.pod:1314 ../fish/guestfish-actions.pod:879
8434 "C<path> can be a file or a directory. If C<path> is a directory then the "
8435 "estimate includes the contents of the directory and all subdirectories "
8440 #: ../src/guestfs-actions.pod:1318 ../fish/guestfish-actions.pod:883
8442 "The result is the estimated size in I<kilobytes> (ie. units of 1024 bytes)."
8446 #: ../src/guestfs-actions.pod:1330
8447 msgid "guestfs_e2fsck_f"
8451 #: ../src/guestfs-actions.pod:1332
8455 " guestfs_e2fsck_f (guestfs_h *g,\n"
8456 " const char *device);\n"
8461 #: ../src/guestfs-actions.pod:1336 ../fish/guestfish-actions.pod:890
8463 "This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3 filesystem checker "
8464 "on C<device>, noninteractively (I<-p>), even if the filesystem appears to be "
8469 #: ../src/guestfs-actions.pod:1340
8471 "This command is only needed because of C<guestfs_resize2fs> (q.v.). "
8472 "Normally you should use C<guestfs_fsck>."
8476 #: ../src/guestfs-actions.pod:1345
8477 msgid "(Added in 1.0.29)"
8481 #: ../src/guestfs-actions.pod:1347
8482 msgid "guestfs_echo_daemon"
8486 #: ../src/guestfs-actions.pod:1349
8490 " guestfs_echo_daemon (guestfs_h *g,\n"
8491 " char *const *words);\n"
8496 #: ../src/guestfs-actions.pod:1353 ../fish/guestfish-actions.pod:901
8498 "This command concatenates the list of C<words> passed with single spaces "
8499 "between them and returns the resulting string."
8503 #: ../src/guestfs-actions.pod:1356 ../fish/guestfish-actions.pod:904
8504 msgid "You can use this command to test the connection through to the daemon."
8508 #: ../src/guestfs-actions.pod:1358
8509 msgid "See also C<guestfs_ping_daemon>."
8513 #: ../src/guestfs-actions.pod:1363 ../src/guestfs-actions.pod:2099
8514 #: ../src/guestfs-actions.pod:6238
8515 msgid "(Added in 1.0.69)"
8519 #: ../src/guestfs-actions.pod:1365
8520 msgid "guestfs_egrep"
8524 #: ../src/guestfs-actions.pod:1367
8528 " guestfs_egrep (guestfs_h *g,\n"
8529 " const char *regex,\n"
8530 " const char *path);\n"
8535 #: ../src/guestfs-actions.pod:1372 ../fish/guestfish-actions.pod:912
8537 "This calls the external C<egrep> program and returns the matching lines."
8541 #: ../src/guestfs-actions.pod:1382 ../src/guestfs-actions.pod:1401
8542 #: ../src/guestfs-actions.pod:1458 ../src/guestfs-actions.pod:1504
8543 #: ../src/guestfs-actions.pod:1523 ../src/guestfs-actions.pod:2229
8544 #: ../src/guestfs-actions.pod:2248 ../src/guestfs-actions.pod:2404
8545 #: ../src/guestfs-actions.pod:2417 ../src/guestfs-actions.pod:2432
8546 #: ../src/guestfs-actions.pod:2478 ../src/guestfs-actions.pod:2500
8547 #: ../src/guestfs-actions.pod:2513 ../src/guestfs-actions.pod:3762
8548 #: ../src/guestfs-actions.pod:3776 ../src/guestfs-actions.pod:3789
8549 #: ../src/guestfs-actions.pod:3803 ../src/guestfs-actions.pod:4801
8550 #: ../src/guestfs-actions.pod:5734 ../src/guestfs-actions.pod:5783
8551 #: ../src/guestfs-actions.pod:6634 ../src/guestfs-actions.pod:6646
8552 #: ../src/guestfs-actions.pod:6659 ../src/guestfs-actions.pod:6672
8553 #: ../src/guestfs-actions.pod:6694 ../src/guestfs-actions.pod:6707
8554 #: ../src/guestfs-actions.pod:6720 ../src/guestfs-actions.pod:6733
8555 #: ../src/guestfs-actions.pod:7511 ../src/guestfs-actions.pod:7530
8556 #: ../src/guestfs-actions.pod:7616 ../src/guestfs-actions.pod:7635
8557 #: ../src/guestfs-actions.pod:7681 ../src/guestfs-actions.pod:7700
8558 msgid "(Added in 1.0.66)"
8562 #: ../src/guestfs-actions.pod:1384
8563 msgid "guestfs_egrepi"
8567 #: ../src/guestfs-actions.pod:1386
8571 " guestfs_egrepi (guestfs_h *g,\n"
8572 " const char *regex,\n"
8573 " const char *path);\n"
8578 #: ../src/guestfs-actions.pod:1391 ../fish/guestfish-actions.pod:922
8580 "This calls the external C<egrep -i> program and returns the matching lines."
8584 #: ../src/guestfs-actions.pod:1403
8585 msgid "guestfs_equal"
8589 #: ../src/guestfs-actions.pod:1405
8593 " guestfs_equal (guestfs_h *g,\n"
8594 " const char *file1,\n"
8595 " const char *file2);\n"
8600 #: ../src/guestfs-actions.pod:1410 ../fish/guestfish-actions.pod:932
8602 "This compares the two files C<file1> and C<file2> and returns true if their "
8603 "content is exactly equal, or false otherwise."
8607 #: ../src/guestfs-actions.pod:1413 ../fish/guestfish-actions.pod:935
8608 msgid "The external L<cmp(1)> program is used for the comparison."
8612 #: ../src/guestfs-actions.pod:1419
8613 msgid "guestfs_exists"
8617 #: ../src/guestfs-actions.pod:1421
8621 " guestfs_exists (guestfs_h *g,\n"
8622 " const char *path);\n"
8627 #: ../src/guestfs-actions.pod:1425 ../fish/guestfish-actions.pod:941
8629 "This returns C<true> if and only if there is a file, directory (or anything) "
8630 "with the given C<path> name."
8634 #: ../src/guestfs-actions.pod:1428
8635 msgid "See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>."
8639 #: ../src/guestfs-actions.pod:1434
8640 msgid "guestfs_fallocate"
8644 #: ../src/guestfs-actions.pod:1436
8648 " guestfs_fallocate (guestfs_h *g,\n"
8649 " const char *path,\n"
8655 #: ../src/guestfs-actions.pod:1441 ../src/guestfs-actions.pod:1467
8656 #: ../fish/guestfish-actions.pod:950 ../fish/guestfish-actions.pod:969
8658 "This command preallocates a file (containing zero bytes) named C<path> of "
8659 "size C<len> bytes. If the file exists already, it is overwritten."
8663 #: ../src/guestfs-actions.pod:1445 ../fish/guestfish-actions.pod:954
8665 "Do not confuse this with the guestfish-specific C<alloc> command which "
8666 "allocates a file in the host and attaches it as a device."
8670 #: ../src/guestfs-actions.pod:1451 ../fish/guestfish-actions.pod:958
8672 "This function is deprecated. In new code, use the C<fallocate64> call "
8677 #: ../src/guestfs-actions.pod:1460
8678 msgid "guestfs_fallocate64"
8682 #: ../src/guestfs-actions.pod:1462
8686 " guestfs_fallocate64 (guestfs_h *g,\n"
8687 " const char *path,\n"
8693 #: ../src/guestfs-actions.pod:1471
8695 "Note that this call allocates disk blocks for the file. To create a sparse "
8696 "file use C<guestfs_truncate_size> instead."
8700 #: ../src/guestfs-actions.pod:1474
8702 "The deprecated call C<guestfs_fallocate> does the same, but owing to an "
8703 "oversight it only allowed 30 bit lengths to be specified, effectively "
8704 "limiting the maximum size of files created through that call to 1GB."
8708 #: ../src/guestfs-actions.pod:1479 ../fish/guestfish-actions.pod:981
8710 "Do not confuse this with the guestfish-specific C<alloc> and C<sparse> "
8711 "commands which create a file in the host and attach it as a device."
8715 #: ../src/guestfs-actions.pod:1485
8716 msgid "(Added in 1.3.17)"
8720 #: ../src/guestfs-actions.pod:1487
8721 msgid "guestfs_fgrep"
8725 #: ../src/guestfs-actions.pod:1489
8729 " guestfs_fgrep (guestfs_h *g,\n"
8730 " const char *pattern,\n"
8731 " const char *path);\n"
8736 #: ../src/guestfs-actions.pod:1494 ../fish/guestfish-actions.pod:989
8738 "This calls the external C<fgrep> program and returns the matching lines."
8742 #: ../src/guestfs-actions.pod:1506
8743 msgid "guestfs_fgrepi"
8747 #: ../src/guestfs-actions.pod:1508
8751 " guestfs_fgrepi (guestfs_h *g,\n"
8752 " const char *pattern,\n"
8753 " const char *path);\n"
8758 #: ../src/guestfs-actions.pod:1513 ../fish/guestfish-actions.pod:999
8760 "This calls the external C<fgrep -i> program and returns the matching lines."
8764 #: ../src/guestfs-actions.pod:1525
8765 msgid "guestfs_file"
8769 #: ../src/guestfs-actions.pod:1527
8773 " guestfs_file (guestfs_h *g,\n"
8774 " const char *path);\n"
8779 #: ../src/guestfs-actions.pod:1531 ../fish/guestfish-actions.pod:1009
8781 "This call uses the standard L<file(1)> command to determine the type or "
8782 "contents of the file."
8786 #: ../src/guestfs-actions.pod:1534 ../fish/guestfish-actions.pod:1012
8788 "This call will also transparently look inside various types of compressed "
8793 #: ../src/guestfs-actions.pod:1537 ../fish/guestfish-actions.pod:1015
8795 "The exact command which runs is C<file -zb path>. Note in particular that "
8796 "the filename is not prepended to the output (the I<-b> option)."
8800 #: ../src/guestfs-actions.pod:1541 ../fish/guestfish-actions.pod:1019
8802 "The output depends on the output of the underlying L<file(1)> command and it "
8803 "can change in future in ways beyond our control. In other words, the output "
8804 "is not guaranteed by the ABI."
8808 #: ../src/guestfs-actions.pod:1545
8810 "See also: L<file(1)>, C<guestfs_vfs_type>, C<guestfs_lstat>, "
8811 "C<guestfs_is_file>, C<guestfs_is_blockdev> (etc), C<guestfs_is_zero>."
8815 #: ../src/guestfs-actions.pod:1553
8816 msgid "guestfs_file_architecture"
8820 #: ../src/guestfs-actions.pod:1555
8824 " guestfs_file_architecture (guestfs_h *g,\n"
8825 " const char *filename);\n"
8830 #: ../src/guestfs-actions.pod:1559 ../fish/guestfish-actions.pod:1030
8832 "This detects the architecture of the binary C<filename>, and returns it if "
8837 #: ../src/guestfs-actions.pod:1562 ../fish/guestfish-actions.pod:1033
8838 msgid "Currently defined architectures are:"
8842 #: ../src/guestfs-actions.pod:1566 ../fish/guestfish-actions.pod:1037
8847 #: ../src/guestfs-actions.pod:1568 ../fish/guestfish-actions.pod:1039
8849 "This string is returned for all 32 bit i386, i486, i586, i686 binaries "
8850 "irrespective of the precise processor requirements of the binary."
8854 #: ../src/guestfs-actions.pod:1571 ../fish/guestfish-actions.pod:1042
8859 #: ../src/guestfs-actions.pod:1573 ../fish/guestfish-actions.pod:1044
8860 msgid "64 bit x86-64."
8864 #: ../src/guestfs-actions.pod:1575 ../fish/guestfish-actions.pod:1046
8869 #: ../src/guestfs-actions.pod:1577 ../fish/guestfish-actions.pod:1048
8870 msgid "32 bit SPARC."
8874 #: ../src/guestfs-actions.pod:1579 ../fish/guestfish-actions.pod:1050
8879 #: ../src/guestfs-actions.pod:1581 ../fish/guestfish-actions.pod:1052
8880 msgid "64 bit SPARC V9 and above."
8884 #: ../src/guestfs-actions.pod:1583 ../fish/guestfish-actions.pod:1054
8889 #: ../src/guestfs-actions.pod:1585 ../fish/guestfish-actions.pod:1056
8890 msgid "Intel Itanium."
8891 msgstr "Intel Itanium."
8894 #: ../src/guestfs-actions.pod:1587 ../fish/guestfish-actions.pod:1058
8899 #: ../src/guestfs-actions.pod:1589 ../fish/guestfish-actions.pod:1060
8900 msgid "32 bit Power PC."
8904 #: ../src/guestfs-actions.pod:1591 ../fish/guestfish-actions.pod:1062
8909 #: ../src/guestfs-actions.pod:1593 ../fish/guestfish-actions.pod:1064
8910 msgid "64 bit Power PC."
8914 #: ../src/guestfs-actions.pod:1597 ../fish/guestfish-actions.pod:1068
8915 msgid "Libguestfs may return other architecture strings in future."
8919 #: ../src/guestfs-actions.pod:1599 ../fish/guestfish-actions.pod:1070
8920 msgid "The function works on at least the following types of files:"
8924 #: ../src/guestfs-actions.pod:1605 ../fish/guestfish-actions.pod:1076
8925 msgid "many types of Un*x and Linux binary"
8929 #: ../src/guestfs-actions.pod:1609 ../fish/guestfish-actions.pod:1080
8930 msgid "many types of Un*x and Linux shared library"
8934 #: ../src/guestfs-actions.pod:1613 ../fish/guestfish-actions.pod:1084
8935 msgid "Windows Win32 and Win64 binaries"
8939 #: ../src/guestfs-actions.pod:1617 ../fish/guestfish-actions.pod:1088
8940 msgid "Windows Win32 and Win64 DLLs"
8944 #: ../src/guestfs-actions.pod:1619 ../fish/guestfish-actions.pod:1090
8945 msgid "Win32 binaries and DLLs return C<i386>."
8949 #: ../src/guestfs-actions.pod:1621 ../fish/guestfish-actions.pod:1092
8950 msgid "Win64 binaries and DLLs return C<x86_64>."
8954 #: ../src/guestfs-actions.pod:1625 ../fish/guestfish-actions.pod:1096
8955 msgid "Linux kernel modules"
8959 #: ../src/guestfs-actions.pod:1629 ../fish/guestfish-actions.pod:1100
8960 msgid "Linux new-style initrd images"
8964 #: ../src/guestfs-actions.pod:1633 ../fish/guestfish-actions.pod:1104
8965 msgid "some non-x86 Linux vmlinuz kernels"
8969 #: ../src/guestfs-actions.pod:1637 ../fish/guestfish-actions.pod:1108
8970 msgid "What it can't do currently:"
8974 #: ../src/guestfs-actions.pod:1643 ../fish/guestfish-actions.pod:1114
8975 msgid "static libraries (libfoo.a)"
8979 #: ../src/guestfs-actions.pod:1647 ../fish/guestfish-actions.pod:1118
8980 msgid "Linux old-style initrd as compressed ext2 filesystem (RHEL 3)"
8984 #: ../src/guestfs-actions.pod:1651 ../fish/guestfish-actions.pod:1122
8985 msgid "x86 Linux vmlinuz kernels"
8989 #: ../src/guestfs-actions.pod:1653 ../fish/guestfish-actions.pod:1124
8991 "x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and "
8992 "compressed code, and are horribly hard to unpack. If you want to find the "
8993 "architecture of a kernel, use the architecture of the associated initrd or "
8994 "kernel module(s) instead."
8998 #: ../src/guestfs-actions.pod:1663 ../src/guestfs-actions.pod:1826
8999 #: ../src/guestfs-actions.pod:1843 ../src/guestfs-actions.pod:2533
9000 #: ../src/guestfs-actions.pod:2623 ../src/guestfs-actions.pod:2689
9001 #: ../src/guestfs-actions.pod:2876 ../src/guestfs-actions.pod:2894
9002 #: ../src/guestfs-actions.pod:2934 ../src/guestfs-actions.pod:3009
9003 #: ../src/guestfs-actions.pod:3102 ../src/guestfs-actions.pod:3339
9004 #: ../src/guestfs-actions.pod:3471
9005 msgid "(Added in 1.5.3)"
9009 #: ../src/guestfs-actions.pod:1665
9010 msgid "guestfs_filesize"
9014 #: ../src/guestfs-actions.pod:1667
9018 " guestfs_filesize (guestfs_h *g,\n"
9019 " const char *file);\n"
9024 #: ../src/guestfs-actions.pod:1671 ../fish/guestfish-actions.pod:1135
9025 msgid "This command returns the size of C<file> in bytes."
9029 #: ../src/guestfs-actions.pod:1673
9031 "To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>, "
9032 "C<guestfs_is_dir>, C<guestfs_is_file> etc. To get the size of block "
9033 "devices, use C<guestfs_blockdev_getsize64>."
9037 #: ../src/guestfs-actions.pod:1679
9038 msgid "(Added in 1.0.82)"
9042 #: ../src/guestfs-actions.pod:1681
9043 msgid "guestfs_fill"
9047 #: ../src/guestfs-actions.pod:1683
9051 " guestfs_fill (guestfs_h *g,\n"
9054 " const char *path);\n"
9059 #: ../src/guestfs-actions.pod:1689 ../fish/guestfish-actions.pod:1145
9061 "This command creates a new file called C<path>. The initial content of the "
9062 "file is C<len> octets of C<c>, where C<c> must be a number in the range C<"
9067 #: ../src/guestfs-actions.pod:1693
9069 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
9070 "C<guestfs_truncate_size>. To create a file with a pattern of repeating "
9071 "bytes use C<guestfs_fill_pattern>."
9075 #: ../src/guestfs-actions.pod:1705
9076 msgid "(Added in 1.0.79)"
9080 #: ../src/guestfs-actions.pod:1707
9081 msgid "guestfs_fill_pattern"
9085 #: ../src/guestfs-actions.pod:1709
9089 " guestfs_fill_pattern (guestfs_h *g,\n"
9090 " const char *pattern,\n"
9092 " const char *path);\n"
9097 #: ../src/guestfs-actions.pod:1715
9099 "This function is like C<guestfs_fill> except that it creates a new file of "
9100 "length C<len> containing the repeating pattern of bytes in C<pattern>. The "
9101 "pattern is truncated if necessary to ensure the length of the file is "
9102 "exactly C<len> bytes."
9106 #: ../src/guestfs-actions.pod:1727
9107 msgid "(Added in 1.3.12)"
9111 #: ../src/guestfs-actions.pod:1729
9112 msgid "guestfs_find"
9116 #: ../src/guestfs-actions.pod:1731
9120 " guestfs_find (guestfs_h *g,\n"
9121 " const char *directory);\n"
9126 #: ../src/guestfs-actions.pod:1735 ../fish/guestfish-actions.pod:1167
9128 "This command lists out all files and directories, recursively, starting at "
9129 "C<directory>. It is essentially equivalent to running the shell command "
9130 "C<find directory -print> but some post-processing happens on the output, "
9135 #: ../src/guestfs-actions.pod:1740 ../fish/guestfish-actions.pod:1172
9137 "This returns a list of strings I<without any prefix>. Thus if the directory "
9142 #: ../src/guestfs-actions.pod:1743 ../fish/guestfish-actions.pod:1175
9152 #: ../src/guestfs-actions.pod:1747
9154 "then the returned list from C<guestfs_find> C</tmp> would be 4 elements:"
9158 #: ../src/guestfs-actions.pod:1750 ../fish/guestfish-actions.pod:1182
9169 #: ../src/guestfs-actions.pod:1755 ../fish/guestfish-actions.pod:1187
9170 msgid "If C<directory> is not a directory, then this command returns an error."
9174 #: ../src/guestfs-actions.pod:1758 ../fish/guestfish-actions.pod:1190
9175 msgid "The returned list is sorted."
9179 #: ../src/guestfs-actions.pod:1760
9180 msgid "See also C<guestfs_find0>."
9184 #: ../src/guestfs-actions.pod:1769 ../src/guestfs-actions.pod:4206
9185 #: ../src/guestfs-actions.pod:5818
9186 msgid "(Added in 1.0.27)"
9190 #: ../src/guestfs-actions.pod:1771
9191 msgid "guestfs_find0"
9195 #: ../src/guestfs-actions.pod:1773
9199 " guestfs_find0 (guestfs_h *g,\n"
9200 " const char *directory,\n"
9201 " const char *files);\n"
9206 #: ../src/guestfs-actions.pod:1778 ../fish/guestfish-actions.pod:1201
9208 "This command lists out all files and directories, recursively, starting at "
9209 "C<directory>, placing the resulting list in the external file called "
9214 #: ../src/guestfs-actions.pod:1782
9216 "This command works the same way as C<guestfs_find> with the following "
9221 #: ../src/guestfs-actions.pod:1789 ../fish/guestfish-actions.pod:1212
9222 msgid "The resulting list is written to an external file."
9226 #: ../src/guestfs-actions.pod:1793 ../fish/guestfish-actions.pod:1216
9228 "Items (filenames) in the result are separated by C<\\0> characters. See "
9229 "L<find(1)> option I<-print0>."
9233 #: ../src/guestfs-actions.pod:1798 ../fish/guestfish-actions.pod:1221
9234 msgid "This command is not limited in the number of names that it can return."
9238 #: ../src/guestfs-actions.pod:1803 ../fish/guestfish-actions.pod:1226
9239 msgid "The result list is not sorted."
9243 #: ../src/guestfs-actions.pod:1809
9244 msgid "(Added in 1.0.74)"
9248 #: ../src/guestfs-actions.pod:1811
9249 msgid "guestfs_findfs_label"
9253 #: ../src/guestfs-actions.pod:1813
9257 " guestfs_findfs_label (guestfs_h *g,\n"
9258 " const char *label);\n"
9263 #: ../src/guestfs-actions.pod:1817 ../fish/guestfish-actions.pod:1236
9265 "This command searches the filesystems and returns the one which has the "
9266 "given label. An error is returned if no such filesystem can be found."
9270 #: ../src/guestfs-actions.pod:1821
9271 msgid "To find the label of a filesystem, use C<guestfs_vfs_label>."
9275 #: ../src/guestfs-actions.pod:1828
9276 msgid "guestfs_findfs_uuid"
9280 #: ../src/guestfs-actions.pod:1830
9284 " guestfs_findfs_uuid (guestfs_h *g,\n"
9285 " const char *uuid);\n"
9290 #: ../src/guestfs-actions.pod:1834 ../fish/guestfish-actions.pod:1246
9292 "This command searches the filesystems and returns the one which has the "
9293 "given UUID. An error is returned if no such filesystem can be found."
9297 #: ../src/guestfs-actions.pod:1838
9298 msgid "To find the UUID of a filesystem, use C<guestfs_vfs_uuid>."
9302 #: ../src/guestfs-actions.pod:1845
9303 msgid "guestfs_fsck"
9307 #: ../src/guestfs-actions.pod:1847
9311 " guestfs_fsck (guestfs_h *g,\n"
9312 " const char *fstype,\n"
9313 " const char *device);\n"
9318 #: ../src/guestfs-actions.pod:1852 ../fish/guestfish-actions.pod:1256
9320 "This runs the filesystem checker (fsck) on C<device> which should have "
9321 "filesystem type C<fstype>."
9325 #: ../src/guestfs-actions.pod:1855 ../fish/guestfish-actions.pod:1259
9327 "The returned integer is the status. See L<fsck(8)> for the list of status "
9328 "codes from C<fsck>."
9332 #: ../src/guestfs-actions.pod:1864 ../fish/guestfish-actions.pod:1268
9333 msgid "Multiple status codes can be summed together."
9337 #: ../src/guestfs-actions.pod:1868 ../fish/guestfish-actions.pod:1272
9339 "A non-zero return code can mean \"success\", for example if errors have been "
9340 "corrected on the filesystem."
9344 #: ../src/guestfs-actions.pod:1873 ../fish/guestfish-actions.pod:1277
9345 msgid "Checking or repairing NTFS volumes is not supported (by linux-ntfs)."
9349 #: ../src/guestfs-actions.pod:1878 ../fish/guestfish-actions.pod:1282
9351 "This command is entirely equivalent to running C<fsck -a -t fstype device>."
9355 #: ../src/guestfs-actions.pod:1882 ../src/guestfs-actions.pod:7554
9356 msgid "(Added in 1.0.16)"
9360 #: ../src/guestfs-actions.pod:1884
9361 msgid "guestfs_get_append"
9365 #: ../src/guestfs-actions.pod:1886
9369 " guestfs_get_append (guestfs_h *g);\n"
9374 #: ../src/guestfs-actions.pod:1889 ../fish/guestfish-actions.pod:1288
9376 "Return the additional kernel options which are added to the guest kernel "
9381 #: ../src/guestfs-actions.pod:1892 ../fish/guestfish-actions.pod:1291
9382 msgid "If C<NULL> then no options are added."
9386 #: ../src/guestfs-actions.pod:1894
9388 "This function returns a string which may be NULL. There is no way to return "
9389 "an error from this function. The string is owned by the guest handle and "
9390 "must I<not> be freed."
9394 #: ../src/guestfs-actions.pod:1898 ../src/guestfs-actions.pod:5496
9395 #: ../src/guestfs-actions.pod:5978 ../src/guestfs-actions.pod:6401
9396 #: ../src/guestfs-actions.pod:6420 ../src/guestfs-actions.pod:6436
9397 #: ../src/guestfs-actions.pod:6460 ../src/guestfs-actions.pod:7217
9398 #: ../src/guestfs-actions.pod:7235 ../src/guestfs-actions.pod:7597
9399 msgid "(Added in 1.0.26)"
9403 #: ../src/guestfs-actions.pod:1900
9404 msgid "guestfs_get_attach_method"
9408 #: ../src/guestfs-actions.pod:1902
9412 " guestfs_get_attach_method (guestfs_h *g);\n"
9417 #: ../src/guestfs-actions.pod:1905
9418 msgid "Return the current attach method. See C<guestfs_set_attach_method>."
9422 #: ../src/guestfs-actions.pod:1910 ../src/guestfs-actions.pod:6008
9423 msgid "(Added in 1.9.8)"
9427 #: ../src/guestfs-actions.pod:1912
9428 msgid "guestfs_get_autosync"
9432 #: ../src/guestfs-actions.pod:1914
9436 " guestfs_get_autosync (guestfs_h *g);\n"
9441 #: ../src/guestfs-actions.pod:1917 ../fish/guestfish-actions.pod:1303
9442 msgid "Get the autosync flag."
9446 #: ../src/guestfs-actions.pod:1923
9447 msgid "guestfs_get_direct"
9451 #: ../src/guestfs-actions.pod:1925
9455 " guestfs_get_direct (guestfs_h *g);\n"
9460 #: ../src/guestfs-actions.pod:1928 ../fish/guestfish-actions.pod:1309
9461 msgid "Return the direct appliance mode flag."
9465 #: ../src/guestfs-actions.pod:1932 ../src/guestfs-actions.pod:6049
9466 msgid "(Added in 1.0.72)"
9470 #: ../src/guestfs-actions.pod:1934
9471 msgid "guestfs_get_e2label"
9475 #: ../src/guestfs-actions.pod:1936
9479 " guestfs_get_e2label (guestfs_h *g,\n"
9480 " const char *device);\n"
9485 #: ../src/guestfs-actions.pod:1940 ../fish/guestfish-actions.pod:1315
9487 "This returns the ext2/3/4 filesystem label of the filesystem on C<device>."
9491 #: ../src/guestfs-actions.pod:1946 ../fish/guestfish-actions.pod:1318
9493 "This function is deprecated. In new code, use the C<vfs_label> call instead."
9497 #: ../src/guestfs-actions.pod:1953 ../src/guestfs-actions.pod:1974
9498 #: ../src/guestfs-actions.pod:6067 ../src/guestfs-actions.pod:6086
9499 msgid "(Added in 1.0.15)"
9503 #: ../src/guestfs-actions.pod:1955
9504 msgid "guestfs_get_e2uuid"
9508 #: ../src/guestfs-actions.pod:1957
9512 " guestfs_get_e2uuid (guestfs_h *g,\n"
9513 " const char *device);\n"
9518 #: ../src/guestfs-actions.pod:1961 ../fish/guestfish-actions.pod:1329
9520 "This returns the ext2/3/4 filesystem UUID of the filesystem on C<device>."
9524 #: ../src/guestfs-actions.pod:1967 ../fish/guestfish-actions.pod:1332
9526 "This function is deprecated. In new code, use the C<vfs_uuid> call instead."
9530 #: ../src/guestfs-actions.pod:1976
9531 msgid "guestfs_get_memsize"
9535 #: ../src/guestfs-actions.pod:1978
9539 " guestfs_get_memsize (guestfs_h *g);\n"
9544 #: ../src/guestfs-actions.pod:1981 ../fish/guestfish-actions.pod:1343
9546 "This gets the memory size in megabytes allocated to the qemu subprocess."
9550 #: ../src/guestfs-actions.pod:1984
9552 "If C<guestfs_set_memsize> was not called on this handle, and if "
9553 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
9554 "value for memsize."
9558 #: ../src/guestfs-actions.pod:1988 ../src/guestfs-actions.pod:2069
9559 #: ../src/guestfs-actions.pod:6102 ../src/guestfs-actions.pod:6209
9560 #: ../fish/guestfish-actions.pod:1350 ../fish/guestfish-actions.pod:1401
9561 #: ../fish/guestfish-actions.pod:4053 ../fish/guestfish-actions.pod:4140
9563 "For more information on the architecture of libguestfs, see L<guestfs(3)>."
9567 #: ../src/guestfs-actions.pod:1993 ../src/guestfs-actions.pod:4497
9568 #: ../src/guestfs-actions.pod:4706 ../src/guestfs-actions.pod:4725
9569 #: ../src/guestfs-actions.pod:4744 ../src/guestfs-actions.pod:4756
9570 #: ../src/guestfs-actions.pod:4773 ../src/guestfs-actions.pod:4786
9571 #: ../src/guestfs-actions.pod:5721 ../src/guestfs-actions.pod:6107
9572 #: ../src/guestfs-actions.pod:6368 ../src/guestfs-actions.pod:6983
9573 msgid "(Added in 1.0.55)"
9577 #: ../src/guestfs-actions.pod:1995
9578 msgid "guestfs_get_network"
9582 #: ../src/guestfs-actions.pod:1997
9586 " guestfs_get_network (guestfs_h *g);\n"
9591 #: ../src/guestfs-actions.pod:2000 ../fish/guestfish-actions.pod:1357
9592 msgid "This returns the enable network flag."
9596 #: ../src/guestfs-actions.pod:2004 ../src/guestfs-actions.pod:6126
9597 msgid "(Added in 1.5.4)"
9601 #: ../src/guestfs-actions.pod:2006
9602 msgid "guestfs_get_path"
9606 #: ../src/guestfs-actions.pod:2008
9610 " guestfs_get_path (guestfs_h *g);\n"
9615 #: ../src/guestfs-actions.pod:2011 ../fish/guestfish-actions.pod:1363
9616 msgid "Return the current search path."
9620 #: ../src/guestfs-actions.pod:2013 ../fish/guestfish-actions.pod:1365
9622 "This is always non-NULL. If it wasn't set already, then this will return "
9627 #: ../src/guestfs-actions.pod:2016 ../src/guestfs-actions.pod:2045
9629 "This function returns a string, or NULL on error. The string is owned by "
9630 "the guest handle and must I<not> be freed."
9634 #: ../src/guestfs-actions.pod:2021
9635 msgid "guestfs_get_pid"
9639 #: ../src/guestfs-actions.pod:2023
9643 " guestfs_get_pid (guestfs_h *g);\n"
9648 #: ../src/guestfs-actions.pod:2026 ../fish/guestfish-actions.pod:1374
9650 "Return the process ID of the qemu subprocess. If there is no qemu "
9651 "subprocess, then this will return an error."
9655 #: ../src/guestfs-actions.pod:2029 ../fish/guestfish-actions.pod:1377
9656 msgid "This is an internal call used for debugging and testing."
9660 #: ../src/guestfs-actions.pod:2033
9661 msgid "(Added in 1.0.56)"
9665 #: ../src/guestfs-actions.pod:2035
9666 msgid "guestfs_get_qemu"
9670 #: ../src/guestfs-actions.pod:2037
9674 " guestfs_get_qemu (guestfs_h *g);\n"
9679 #: ../src/guestfs-actions.pod:2040 ../fish/guestfish-actions.pod:1383
9680 msgid "Return the current qemu binary."
9684 #: ../src/guestfs-actions.pod:2042 ../fish/guestfish-actions.pod:1385
9686 "This is always non-NULL. If it wasn't set already, then this will return "
9687 "the default qemu binary name."
9691 #: ../src/guestfs-actions.pod:2048 ../src/guestfs-actions.pod:6171
9692 msgid "(Added in 1.0.6)"
9696 #: ../src/guestfs-actions.pod:2050
9697 msgid "guestfs_get_recovery_proc"
9701 #: ../src/guestfs-actions.pod:2052
9705 " guestfs_get_recovery_proc (guestfs_h *g);\n"
9710 #: ../src/guestfs-actions.pod:2055 ../fish/guestfish-actions.pod:1392
9711 msgid "Return the recovery process enabled flag."
9715 #: ../src/guestfs-actions.pod:2059 ../src/guestfs-actions.pod:3593
9716 #: ../src/guestfs-actions.pod:3904 ../src/guestfs-actions.pod:4304
9717 #: ../src/guestfs-actions.pod:4336 ../src/guestfs-actions.pod:5426
9718 #: ../src/guestfs-actions.pod:5769 ../src/guestfs-actions.pod:6195
9719 #: ../src/guestfs-actions.pod:6886 ../src/guestfs-actions.pod:6906
9720 #: ../src/guestfs-actions.pod:7098
9721 msgid "(Added in 1.0.77)"
9725 #: ../src/guestfs-actions.pod:2061
9726 msgid "guestfs_get_selinux"
9730 #: ../src/guestfs-actions.pod:2063
9734 " guestfs_get_selinux (guestfs_h *g);\n"
9739 #: ../src/guestfs-actions.pod:2066
9741 "This returns the current setting of the selinux flag which is passed to the "
9742 "appliance at boot time. See C<guestfs_set_selinux>."
9746 #: ../src/guestfs-actions.pod:2074 ../src/guestfs-actions.pod:2137
9747 #: ../src/guestfs-actions.pod:6214 ../src/guestfs-actions.pod:6272
9748 msgid "(Added in 1.0.67)"
9752 #: ../src/guestfs-actions.pod:2076
9753 msgid "guestfs_get_state"
9757 #: ../src/guestfs-actions.pod:2078
9761 " guestfs_get_state (guestfs_h *g);\n"
9766 #: ../src/guestfs-actions.pod:2081 ../fish/guestfish-actions.pod:1408
9768 "This returns the current state as an opaque integer. This is only useful "
9769 "for printing debug and internal error messages."
9773 #: ../src/guestfs-actions.pod:2084 ../src/guestfs-actions.pod:3364
9774 #: ../src/guestfs-actions.pod:3393 ../src/guestfs-actions.pod:3454
9775 #: ../src/guestfs-actions.pod:3481 ../fish/guestfish-actions.pod:1411
9776 #: ../fish/guestfish-actions.pod:2331 ../fish/guestfish-actions.pod:2349
9777 #: ../fish/guestfish-actions.pod:2387 ../fish/guestfish-actions.pod:2403
9778 msgid "For more information on states, see L<guestfs(3)>."
9782 #: ../src/guestfs-actions.pod:2090
9783 msgid "guestfs_get_trace"
9787 #: ../src/guestfs-actions.pod:2092
9791 " guestfs_get_trace (guestfs_h *g);\n"
9796 #: ../src/guestfs-actions.pod:2095 ../fish/guestfish-actions.pod:1417
9797 msgid "Return the command trace flag."
9801 #: ../src/guestfs-actions.pod:2101
9802 msgid "guestfs_get_umask"
9806 #: ../src/guestfs-actions.pod:2103
9810 " guestfs_get_umask (guestfs_h *g);\n"
9815 #: ../src/guestfs-actions.pod:2106
9817 "Return the current umask. By default the umask is C<022> unless it has been "
9818 "set by calling C<guestfs_umask>."
9822 #: ../src/guestfs-actions.pod:2113
9823 msgid "guestfs_get_verbose"
9827 #: ../src/guestfs-actions.pod:2115
9831 " guestfs_get_verbose (guestfs_h *g);\n"
9836 #: ../src/guestfs-actions.pod:2118 ../fish/guestfish-actions.pod:1430
9837 msgid "This returns the verbose messages flag."
9841 #: ../src/guestfs-actions.pod:2124
9842 msgid "guestfs_getcon"
9846 #: ../src/guestfs-actions.pod:2126
9850 " guestfs_getcon (guestfs_h *g);\n"
9855 #: ../src/guestfs-actions.pod:2129 ../fish/guestfish-actions.pod:1436
9856 msgid "This gets the SELinux security context of the daemon."
9860 #: ../src/guestfs-actions.pod:2131
9862 "See the documentation about SELINUX in L<guestfs(3)>, and C<guestfs_setcon>"
9866 #: ../src/guestfs-actions.pod:2139
9867 msgid "guestfs_getxattr"
9871 #: ../src/guestfs-actions.pod:2141
9875 " guestfs_getxattr (guestfs_h *g,\n"
9876 " const char *path,\n"
9877 " const char *name,\n"
9878 " size_t *size_r);\n"
9883 #: ../src/guestfs-actions.pod:2147
9885 "Get a single extended attribute from file C<path> named C<name>. This call "
9886 "follows symlinks. If you want to lookup an extended attribute for the "
9887 "symlink itself, use C<guestfs_lgetxattr>."
9891 #: ../src/guestfs-actions.pod:2151 ../src/guestfs-actions.pod:3607
9893 "Normally it is better to get all extended attributes from a file in one go "
9894 "by calling C<guestfs_getxattrs>. However some Linux filesystem "
9895 "implementations are buggy and do not provide a way to list out attributes. "
9896 "For these filesystems (notably ntfs-3g) you have to know the names of the "
9897 "extended attributes you want in advance and call this function."
9901 #: ../src/guestfs-actions.pod:2158 ../src/guestfs-actions.pod:3614
9902 #: ../fish/guestfish-actions.pod:1456 ../fish/guestfish-actions.pod:2483
9904 "Extended attribute values are blobs of binary data. If there is no extended "
9905 "attribute named C<name>, this returns an error."
9909 #: ../src/guestfs-actions.pod:2161
9910 msgid "See also: C<guestfs_getxattrs>, C<guestfs_lgetxattr>, L<attr(5)>."
9914 #: ../src/guestfs-actions.pod:2163 ../src/guestfs-actions.pod:2354
9915 #: ../src/guestfs-actions.pod:2824 ../src/guestfs-actions.pod:3619
9916 #: ../src/guestfs-actions.pod:5419 ../src/guestfs-actions.pod:5445
9917 #: ../src/guestfs-actions.pod:5626
9919 "This function returns a buffer, or NULL on error. The size of the returned "
9920 "buffer is written to C<*size_r>. I<The caller must free the returned buffer "
9925 #: ../src/guestfs-actions.pod:2167 ../src/guestfs-actions.pod:3623
9926 msgid "(Added in 1.7.24)"
9930 #: ../src/guestfs-actions.pod:2169
9931 msgid "guestfs_getxattrs"
9935 #: ../src/guestfs-actions.pod:2171
9938 " struct guestfs_xattr_list *\n"
9939 " guestfs_getxattrs (guestfs_h *g,\n"
9940 " const char *path);\n"
9945 #: ../src/guestfs-actions.pod:2175 ../fish/guestfish-actions.pod:1465
9947 "This call lists the extended attributes of the file or directory C<path>."
9951 #: ../src/guestfs-actions.pod:2178 ../fish/guestfish-actions.pod:1468
9953 "At the system call level, this is a combination of the L<listxattr(2)> and "
9954 "L<getxattr(2)> calls."
9958 #: ../src/guestfs-actions.pod:2181
9959 msgid "See also: C<guestfs_lgetxattrs>, L<attr(5)>."
9963 #: ../src/guestfs-actions.pod:2183 ../src/guestfs-actions.pod:3635
9964 #: ../src/guestfs-actions.pod:4300
9966 "This function returns a C<struct guestfs_xattr_list *>, or NULL if there was "
9967 "an error. I<The caller must call C<guestfs_free_xattr_list> after use>."
9971 #: ../src/guestfs-actions.pod:2187 ../src/guestfs-actions.pod:3639
9972 #: ../src/guestfs-actions.pod:3818 ../src/guestfs-actions.pod:3854
9973 #: ../src/guestfs-actions.pod:5799 ../src/guestfs-actions.pod:6291
9974 #: ../src/guestfs-actions.pod:7662
9975 msgid "(Added in 1.0.59)"
9979 #: ../src/guestfs-actions.pod:2189
9980 msgid "guestfs_glob_expand"
9984 #: ../src/guestfs-actions.pod:2191
9988 " guestfs_glob_expand (guestfs_h *g,\n"
9989 " const char *pattern);\n"
9994 #: ../src/guestfs-actions.pod:2195 ../fish/guestfish-actions.pod:1477
9996 "This command searches for all the pathnames matching C<pattern> according to "
9997 "the wildcard expansion rules used by the shell."
10001 #: ../src/guestfs-actions.pod:2199 ../fish/guestfish-actions.pod:1481
10003 "If no paths match, then this returns an empty list (note: not an error)."
10007 #: ../src/guestfs-actions.pod:2202 ../fish/guestfish-actions.pod:1484
10009 "It is just a wrapper around the C L<glob(3)> function with flags C<GLOB_MARK|"
10010 "GLOB_BRACE>. See that manual page for more details."
10014 #: ../src/guestfs-actions.pod:2210 ../src/guestfs-actions.pod:6484
10015 #: ../src/guestfs-actions.pod:6501
10016 msgid "(Added in 1.0.50)"
10020 #: ../src/guestfs-actions.pod:2212
10021 msgid "guestfs_grep"
10025 #: ../src/guestfs-actions.pod:2214
10029 " guestfs_grep (guestfs_h *g,\n"
10030 " const char *regex,\n"
10031 " const char *path);\n"
10036 #: ../src/guestfs-actions.pod:2219 ../fish/guestfish-actions.pod:1492
10037 msgid "This calls the external C<grep> program and returns the matching lines."
10041 #: ../src/guestfs-actions.pod:2231
10042 msgid "guestfs_grepi"
10046 #: ../src/guestfs-actions.pod:2233
10050 " guestfs_grepi (guestfs_h *g,\n"
10051 " const char *regex,\n"
10052 " const char *path);\n"
10057 #: ../src/guestfs-actions.pod:2238 ../fish/guestfish-actions.pod:1502
10059 "This calls the external C<grep -i> program and returns the matching lines."
10063 #: ../src/guestfs-actions.pod:2250
10064 msgid "guestfs_grub_install"
10068 #: ../src/guestfs-actions.pod:2252
10072 " guestfs_grub_install (guestfs_h *g,\n"
10073 " const char *root,\n"
10074 " const char *device);\n"
10079 #: ../src/guestfs-actions.pod:2257 ../fish/guestfish-actions.pod:1512
10081 "This command installs GRUB (the Grand Unified Bootloader) on C<device>, with "
10082 "the root directory being C<root>."
10086 #: ../src/guestfs-actions.pod:2260 ../fish/guestfish-actions.pod:1515
10088 "Note: If grub-install reports the error \"No suitable drive was found in the "
10089 "generated device map.\" it may be that you need to create a C</boot/grub/"
10090 "device.map> file first that contains the mapping between grub device names "
10091 "and Linux device names. It is usually sufficient to create a file "
10096 #: ../src/guestfs-actions.pod:2267 ../fish/guestfish-actions.pod:1522
10099 " (hd0) /dev/vda\n"
10104 #: ../src/guestfs-actions.pod:2269 ../fish/guestfish-actions.pod:1524
10105 msgid "replacing C</dev/vda> with the name of the installation device."
10109 #: ../src/guestfs-actions.pod:2273
10110 msgid "(Added in 1.0.17)"
10114 #: ../src/guestfs-actions.pod:2275
10115 msgid "guestfs_head"
10119 #: ../src/guestfs-actions.pod:2277
10123 " guestfs_head (guestfs_h *g,\n"
10124 " const char *path);\n"
10129 #: ../src/guestfs-actions.pod:2281 ../fish/guestfish-actions.pod:1530
10131 "This command returns up to the first 10 lines of a file as a list of strings."
10135 #: ../src/guestfs-actions.pod:2293
10136 msgid "guestfs_head_n"
10140 #: ../src/guestfs-actions.pod:2295
10144 " guestfs_head_n (guestfs_h *g,\n"
10146 " const char *path);\n"
10151 #: ../src/guestfs-actions.pod:2300 ../fish/guestfish-actions.pod:1540
10153 "If the parameter C<nrlines> is a positive number, this returns the first "
10154 "C<nrlines> lines of the file C<path>."
10158 #: ../src/guestfs-actions.pod:2303 ../fish/guestfish-actions.pod:1543
10160 "If the parameter C<nrlines> is a negative number, this returns lines from "
10161 "the file C<path>, excluding the last C<nrlines> lines."
10165 #: ../src/guestfs-actions.pod:2306 ../src/guestfs-actions.pod:6781
10166 #: ../fish/guestfish-actions.pod:1546 ../fish/guestfish-actions.pod:4518
10167 msgid "If the parameter C<nrlines> is zero, this returns an empty list."
10171 #: ../src/guestfs-actions.pod:2317
10172 msgid "guestfs_hexdump"
10176 #: ../src/guestfs-actions.pod:2319
10180 " guestfs_hexdump (guestfs_h *g,\n"
10181 " const char *path);\n"
10186 #: ../src/guestfs-actions.pod:2323 ../fish/guestfish-actions.pod:1555
10188 "This runs C<hexdump -C> on the given C<path>. The result is the human-"
10189 "readable, canonical hex dump of the file."
10193 #: ../src/guestfs-actions.pod:2332 ../src/guestfs-actions.pod:6565
10194 #: ../src/guestfs-actions.pod:6620
10195 msgid "(Added in 1.0.22)"
10199 #: ../src/guestfs-actions.pod:2334
10200 msgid "guestfs_initrd_cat"
10204 #: ../src/guestfs-actions.pod:2336
10208 " guestfs_initrd_cat (guestfs_h *g,\n"
10209 " const char *initrdpath,\n"
10210 " const char *filename,\n"
10211 " size_t *size_r);\n"
10216 #: ../src/guestfs-actions.pod:2342 ../fish/guestfish-actions.pod:1565
10218 "This command unpacks the file C<filename> from the initrd file called "
10219 "C<initrdpath>. The filename must be given I<without> the initial C</> "
10224 #: ../src/guestfs-actions.pod:2346 ../fish/guestfish-actions.pod:1569
10226 "For example, in guestfish you could use the following command to examine the "
10227 "boot script (usually called C</init>) contained in a Linux initrd or "
10232 #: ../src/guestfs-actions.pod:2350 ../fish/guestfish-actions.pod:1573
10235 " initrd-cat /boot/initrd-<version>.img init\n"
10240 #: ../src/guestfs-actions.pod:2352
10241 msgid "See also C<guestfs_initrd_list>."
10245 #: ../src/guestfs-actions.pod:2363
10246 msgid "guestfs_initrd_list"
10250 #: ../src/guestfs-actions.pod:2365
10254 " guestfs_initrd_list (guestfs_h *g,\n"
10255 " const char *path);\n"
10260 #: ../src/guestfs-actions.pod:2369 ../fish/guestfish-actions.pod:1584
10261 msgid "This command lists out files contained in an initrd."
10265 #: ../src/guestfs-actions.pod:2371 ../fish/guestfish-actions.pod:1586
10267 "The files are listed without any initial C</> character. The files are "
10268 "listed in the order they appear (not necessarily alphabetical). Directory "
10269 "names are listed as separate items."
10273 #: ../src/guestfs-actions.pod:2375 ../fish/guestfish-actions.pod:1590
10275 "Old Linux kernels (2.4 and earlier) used a compressed ext2 filesystem as "
10276 "initrd. We I<only> support the newer initramfs format (compressed cpio "
10281 #: ../src/guestfs-actions.pod:2385
10282 msgid "guestfs_inotify_add_watch"
10286 #: ../src/guestfs-actions.pod:2387
10290 " guestfs_inotify_add_watch (guestfs_h *g,\n"
10291 " const char *path,\n"
10297 #: ../src/guestfs-actions.pod:2392 ../fish/guestfish-actions.pod:1598
10298 msgid "Watch C<path> for the events listed in C<mask>."
10302 #: ../src/guestfs-actions.pod:2394 ../fish/guestfish-actions.pod:1600
10304 "Note that if C<path> is a directory then events within that directory are "
10305 "watched, but this does I<not> happen recursively (in subdirectories)."
10309 #: ../src/guestfs-actions.pod:2398 ../fish/guestfish-actions.pod:1604
10311 "Note for non-C or non-Linux callers: the inotify events are defined by the "
10312 "Linux kernel ABI and are listed in C</usr/include/sys/inotify.h>."
10316 #: ../src/guestfs-actions.pod:2406
10317 msgid "guestfs_inotify_close"
10321 #: ../src/guestfs-actions.pod:2408
10325 " guestfs_inotify_close (guestfs_h *g);\n"
10330 #: ../src/guestfs-actions.pod:2411 ../fish/guestfish-actions.pod:1612
10332 "This closes the inotify handle which was previously opened by inotify_init. "
10333 "It removes all watches, throws away any pending events, and deallocates all "
10338 #: ../src/guestfs-actions.pod:2419
10339 msgid "guestfs_inotify_files"
10343 #: ../src/guestfs-actions.pod:2421
10347 " guestfs_inotify_files (guestfs_h *g);\n"
10352 #: ../src/guestfs-actions.pod:2424
10354 "This function is a helpful wrapper around C<guestfs_inotify_read> which just "
10355 "returns a list of pathnames of objects that were touched. The returned "
10356 "pathnames are sorted and deduplicated."
10360 #: ../src/guestfs-actions.pod:2434
10361 msgid "guestfs_inotify_init"
10365 #: ../src/guestfs-actions.pod:2436
10369 " guestfs_inotify_init (guestfs_h *g,\n"
10370 " int maxevents);\n"
10375 #: ../src/guestfs-actions.pod:2440 ../fish/guestfish-actions.pod:1628
10377 "This command creates a new inotify handle. The inotify subsystem can be "
10378 "used to notify events which happen to objects in the guest filesystem."
10382 #: ../src/guestfs-actions.pod:2444
10384 "C<maxevents> is the maximum number of events which will be queued up between "
10385 "calls to C<guestfs_inotify_read> or C<guestfs_inotify_files>. If this is "
10386 "passed as C<0>, then the kernel (or previously set) default is used. For "
10387 "Linux 2.6.29 the default was 16384 events. Beyond this limit, the kernel "
10388 "throws away events, but records the fact that it threw them away by setting "
10389 "a flag C<IN_Q_OVERFLOW> in the returned structure list (see "
10390 "C<guestfs_inotify_read>)."
10394 #: ../src/guestfs-actions.pod:2454
10396 "Before any events are generated, you have to add some watches to the "
10397 "internal watch list. See: C<guestfs_inotify_add_watch>, "
10398 "C<guestfs_inotify_rm_watch> and C<guestfs_inotify_watch_all>."
10402 #: ../src/guestfs-actions.pod:2460
10404 "Queued up events should be read periodically by calling "
10405 "C<guestfs_inotify_read> (or C<guestfs_inotify_files> which is just a helpful "
10406 "wrapper around C<guestfs_inotify_read>). If you don't read the events out "
10407 "often enough then you risk the internal queue overflowing."
10411 #: ../src/guestfs-actions.pod:2467
10413 "The handle should be closed after use by calling C<guestfs_inotify_close>. "
10414 "This also removes any watches automatically."
10418 #: ../src/guestfs-actions.pod:2471 ../fish/guestfish-actions.pod:1659
10420 "See also L<inotify(7)> for an overview of the inotify interface as exposed "
10421 "by the Linux kernel, which is roughly what we expose via libguestfs. Note "
10422 "that there is one global inotify handle per libguestfs instance."
10426 #: ../src/guestfs-actions.pod:2480
10427 msgid "guestfs_inotify_read"
10431 #: ../src/guestfs-actions.pod:2482
10434 " struct guestfs_inotify_event_list *\n"
10435 " guestfs_inotify_read (guestfs_h *g);\n"
10440 #: ../src/guestfs-actions.pod:2485 ../fish/guestfish-actions.pod:1668
10442 "Return the complete queue of events that have happened since the previous "
10447 #: ../src/guestfs-actions.pod:2488 ../fish/guestfish-actions.pod:1671
10448 msgid "If no events have happened, this returns an empty list."
10452 #: ../src/guestfs-actions.pod:2490 ../fish/guestfish-actions.pod:1673
10454 "I<Note>: In order to make sure that all events have been read, you must call "
10455 "this function repeatedly until it returns an empty list. The reason is that "
10456 "the call will read events up to the maximum appliance-to-host message size "
10457 "and leave remaining events in the queue."
10461 #: ../src/guestfs-actions.pod:2496
10463 "This function returns a C<struct guestfs_inotify_event_list *>, or NULL if "
10464 "there was an error. I<The caller must call "
10465 "C<guestfs_free_inotify_event_list> after use>."
10469 #: ../src/guestfs-actions.pod:2502
10470 msgid "guestfs_inotify_rm_watch"
10474 #: ../src/guestfs-actions.pod:2504
10478 " guestfs_inotify_rm_watch (guestfs_h *g,\n"
10484 #: ../src/guestfs-actions.pod:2508
10486 "Remove a previously defined inotify watch. See C<guestfs_inotify_add_watch>."
10490 #: ../src/guestfs-actions.pod:2515
10491 msgid "guestfs_inspect_get_arch"
10495 #: ../src/guestfs-actions.pod:2517
10499 " guestfs_inspect_get_arch (guestfs_h *g,\n"
10500 " const char *root);\n"
10505 #: ../src/guestfs-actions.pod:2521
10507 "This returns the architecture of the inspected operating system. The "
10508 "possible return values are listed under C<guestfs_file_architecture>."
10512 #: ../src/guestfs-actions.pod:2525 ../fish/guestfish-actions.pod:1694
10514 "If the architecture could not be determined, then the string C<unknown> is "
10519 #: ../src/guestfs-actions.pod:2528 ../src/guestfs-actions.pod:2618
10520 #: ../src/guestfs-actions.pod:2722 ../src/guestfs-actions.pod:2741
10521 #: ../src/guestfs-actions.pod:2872 ../src/guestfs-actions.pod:2955
10522 #: ../src/guestfs-actions.pod:2983 ../src/guestfs-actions.pod:3004
10523 #: ../src/guestfs-actions.pod:3057 ../src/guestfs-actions.pod:3097
10524 #: ../src/guestfs-actions.pod:3117 ../src/guestfs-actions.pod:3137
10525 #: ../src/guestfs-actions.pod:3154 ../src/guestfs-actions.pod:3170
10526 #: ../src/guestfs-actions.pod:3188 ../src/guestfs-actions.pod:3290
10527 #: ../src/guestfs-actions.pod:3331 ../fish/guestfish-actions.pod:1697
10528 #: ../fish/guestfish-actions.pod:1780 ../fish/guestfish-actions.pod:1859
10529 #: ../fish/guestfish-actions.pod:1871 ../fish/guestfish-actions.pod:1955
10530 #: ../fish/guestfish-actions.pod:2016 ../fish/guestfish-actions.pod:2037
10531 #: ../fish/guestfish-actions.pod:2051 ../fish/guestfish-actions.pod:2091
10532 #: ../fish/guestfish-actions.pod:2123 ../fish/guestfish-actions.pod:2136
10533 #: ../fish/guestfish-actions.pod:2149 ../fish/guestfish-actions.pod:2159
10534 #: ../fish/guestfish-actions.pod:2169 ../fish/guestfish-actions.pod:2181
10535 #: ../fish/guestfish-actions.pod:2277 ../fish/guestfish-actions.pod:2311
10536 msgid "Please read L<guestfs(3)/INSPECTION> for more details."
10540 #: ../src/guestfs-actions.pod:2535
10541 msgid "guestfs_inspect_get_distro"
10545 #: ../src/guestfs-actions.pod:2537
10549 " guestfs_inspect_get_distro (guestfs_h *g,\n"
10550 " const char *root);\n"
10555 #: ../src/guestfs-actions.pod:2541 ../fish/guestfish-actions.pod:1703
10557 "This returns the distro (distribution) of the inspected operating system."
10561 #: ../src/guestfs-actions.pod:2544 ../fish/guestfish-actions.pod:1706
10562 msgid "Currently defined distros are:"
10566 #: ../src/guestfs-actions.pod:2548 ../fish/guestfish-actions.pod:1710
10567 msgid "\"archlinux\""
10568 msgstr "\"archlinux\""
10571 #: ../src/guestfs-actions.pod:2550 ../fish/guestfish-actions.pod:1712
10572 msgid "Arch Linux."
10573 msgstr "Arch Linux."
10576 #: ../src/guestfs-actions.pod:2552 ../fish/guestfish-actions.pod:1714
10578 #| msgid "\"gentoo\""
10580 msgstr "\"gentoo\""
10583 #: ../src/guestfs-actions.pod:2554 ../fish/guestfish-actions.pod:1716
10588 #: ../src/guestfs-actions.pod:2556 ../fish/guestfish-actions.pod:1718
10590 msgstr "\"debian\""
10593 #: ../src/guestfs-actions.pod:2558 ../fish/guestfish-actions.pod:1720
10598 #: ../src/guestfs-actions.pod:2560 ../fish/guestfish-actions.pod:1722
10600 msgstr "\"fedora\""
10603 #: ../src/guestfs-actions.pod:2562 ../fish/guestfish-actions.pod:1724
10608 #: ../src/guestfs-actions.pod:2564 ../fish/guestfish-actions.pod:1726
10610 msgstr "\"gentoo\""
10613 #: ../src/guestfs-actions.pod:2566 ../fish/guestfish-actions.pod:1728
10618 #: ../src/guestfs-actions.pod:2568 ../fish/guestfish-actions.pod:1730
10619 msgid "\"linuxmint\""
10620 msgstr "\"linuxmint\""
10623 #: ../src/guestfs-actions.pod:2570 ../fish/guestfish-actions.pod:1732
10624 msgid "Linux Mint."
10625 msgstr "Linux Mint."
10628 #: ../src/guestfs-actions.pod:2572 ../fish/guestfish-actions.pod:1734
10629 msgid "\"mandriva\""
10630 msgstr "\"mandriva\""
10633 #: ../src/guestfs-actions.pod:2574 ../fish/guestfish-actions.pod:1736
10638 #: ../src/guestfs-actions.pod:2576 ../fish/guestfish-actions.pod:1738
10643 #: ../src/guestfs-actions.pod:2578 ../fish/guestfish-actions.pod:1740
10648 #: ../src/guestfs-actions.pod:2580 ../fish/guestfish-actions.pod:1742
10650 msgstr "\"pardus\""
10653 #: ../src/guestfs-actions.pod:2582 ../fish/guestfish-actions.pod:1744
10658 #: ../src/guestfs-actions.pod:2584 ../fish/guestfish-actions.pod:1746
10659 msgid "\"redhat-based\""
10660 msgstr "\"redhat-based\""
10663 #: ../src/guestfs-actions.pod:2586 ../fish/guestfish-actions.pod:1748
10664 msgid "Some Red Hat-derived distro."
10665 msgstr "Дистрибутив, що походить від Red Hat."
10668 #: ../src/guestfs-actions.pod:2588 ../fish/guestfish-actions.pod:1750
10673 #: ../src/guestfs-actions.pod:2590 ../fish/guestfish-actions.pod:1752
10675 #| msgid "Red Hat Enterprise Linux and some derivatives."
10676 msgid "Red Hat Enterprise Linux."
10677 msgstr "Red Hat Enterprise Linux та деякі з похідних дистрибутивів."
10680 #: ../src/guestfs-actions.pod:2592 ../fish/guestfish-actions.pod:1754
10681 msgid "\"scientificlinux\""
10685 #: ../src/guestfs-actions.pod:2594 ../fish/guestfish-actions.pod:1756
10686 msgid "Scientific Linux."
10690 #: ../src/guestfs-actions.pod:2596 ../fish/guestfish-actions.pod:1758
10691 msgid "\"slackware\""
10695 #: ../src/guestfs-actions.pod:2598 ../fish/guestfish-actions.pod:1760
10700 #: ../src/guestfs-actions.pod:2600 ../fish/guestfish-actions.pod:1762
10702 msgstr "\"ubuntu\""
10705 #: ../src/guestfs-actions.pod:2602 ../fish/guestfish-actions.pod:1764
10710 #: ../src/guestfs-actions.pod:2604 ../src/guestfs-actions.pod:2713
10711 #: ../src/guestfs-actions.pod:3088 ../fish/guestfish-actions.pod:1766
10712 #: ../fish/guestfish-actions.pod:1850 ../fish/guestfish-actions.pod:2114
10713 msgid "\"unknown\""
10714 msgstr "\"unknown\""
10717 #: ../src/guestfs-actions.pod:2606 ../fish/guestfish-actions.pod:1768
10718 msgid "The distro could not be determined."
10719 msgstr "Дистрибутив, тип якого не вдалося визначити."
10722 #: ../src/guestfs-actions.pod:2608 ../src/guestfs-actions.pod:3080
10723 #: ../fish/guestfish-actions.pod:1770 ../fish/guestfish-actions.pod:2106
10724 msgid "\"windows\""
10725 msgstr "\"windows\""
10728 #: ../src/guestfs-actions.pod:2610 ../fish/guestfish-actions.pod:1772
10730 "Windows does not have distributions. This string is returned if the OS type "
10735 #: ../src/guestfs-actions.pod:2615 ../src/guestfs-actions.pod:2719
10736 #: ../src/guestfs-actions.pod:3094 ../fish/guestfish-actions.pod:1777
10737 #: ../fish/guestfish-actions.pod:1856 ../fish/guestfish-actions.pod:2120
10739 "Future versions of libguestfs may return other strings here. The caller "
10740 "should be prepared to handle any string."
10744 #: ../src/guestfs-actions.pod:2625
10745 msgid "guestfs_inspect_get_drive_mappings"
10749 #: ../src/guestfs-actions.pod:2627
10753 " guestfs_inspect_get_drive_mappings (guestfs_h *g,\n"
10754 " const char *root);\n"
10759 #: ../src/guestfs-actions.pod:2631 ../fish/guestfish-actions.pod:1786
10761 "This call is useful for Windows which uses a primitive system of assigning "
10762 "drive letters (like \"C:\") to partitions. This inspection API examines the "
10763 "Windows Registry to find out how disks/partitions are mapped to drive "
10764 "letters, and returns a hash table as in the example below:"
10768 #: ../src/guestfs-actions.pod:2637 ../fish/guestfish-actions.pod:1792
10771 " C => /dev/vda2\n"
10772 " E => /dev/vdb1\n"
10773 " F => /dev/vdc1\n"
10778 #: ../src/guestfs-actions.pod:2641 ../fish/guestfish-actions.pod:1796
10780 "Note that keys are drive letters. For Windows, the key is case insensitive "
10781 "and just contains the drive letter, without the customary colon separator "
10786 #: ../src/guestfs-actions.pod:2645 ../fish/guestfish-actions.pod:1800
10788 "In future we may support other operating systems that also used drive "
10789 "letters, but the keys for those might not be case insensitive and might be "
10790 "longer than 1 character. For example in OS-9, hard drives were named C<h0>, "
10795 #: ../src/guestfs-actions.pod:2650 ../fish/guestfish-actions.pod:1805
10797 "For Windows guests, currently only hard drive mappings are returned. "
10798 "Removable disks (eg. DVD-ROMs) are ignored."
10802 #: ../src/guestfs-actions.pod:2653 ../fish/guestfish-actions.pod:1808
10804 "For guests that do not use drive mappings, or if the drive mappings could "
10805 "not be determined, this returns an empty hash table."
10809 #: ../src/guestfs-actions.pod:2656
10811 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
10812 "C<guestfs_inspect_get_mountpoints>, C<guestfs_inspect_get_filesystems>."
10816 #: ../src/guestfs-actions.pod:2660 ../src/guestfs-actions.pod:2928
10817 #: ../src/guestfs-actions.pod:3706 ../src/guestfs-actions.pod:4985
10818 #: ../src/guestfs-actions.pod:6922
10820 "This function returns a NULL-terminated array of strings, or NULL if there "
10821 "was an error. The array of strings will always have length C<2n+1>, where "
10822 "C<n> keys and values alternate, followed by the trailing NULL entry. I<The "
10823 "caller must free the strings and the array after use>."
10827 #: ../src/guestfs-actions.pod:2666 ../src/guestfs-actions.pod:3122
10828 msgid "(Added in 1.9.17)"
10832 #: ../src/guestfs-actions.pod:2668
10833 msgid "guestfs_inspect_get_filesystems"
10837 #: ../src/guestfs-actions.pod:2670
10841 " guestfs_inspect_get_filesystems (guestfs_h *g,\n"
10842 " const char *root);\n"
10847 #: ../src/guestfs-actions.pod:2674 ../fish/guestfish-actions.pod:1819
10849 "This returns a list of all the filesystems that we think are associated with "
10850 "this operating system. This includes the root filesystem, other ordinary "
10851 "filesystems, and non-mounted devices like swap partitions."
10855 #: ../src/guestfs-actions.pod:2679 ../fish/guestfish-actions.pod:1824
10857 "In the case of a multi-boot virtual machine, it is possible for a filesystem "
10858 "to be shared between operating systems."
10862 #: ../src/guestfs-actions.pod:2682
10864 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
10865 "C<guestfs_inspect_get_mountpoints>."
10869 #: ../src/guestfs-actions.pod:2691
10870 msgid "guestfs_inspect_get_format"
10874 #: ../src/guestfs-actions.pod:2693
10878 " guestfs_inspect_get_format (guestfs_h *g,\n"
10879 " const char *root);\n"
10884 #: ../src/guestfs-actions.pod:2697 ../fish/guestfish-actions.pod:1834
10886 "This returns the format of the inspected operating system. You can use it "
10887 "to detect install images, live CDs and similar."
10891 #: ../src/guestfs-actions.pod:2700 ../fish/guestfish-actions.pod:1837
10892 msgid "Currently defined formats are:"
10896 #: ../src/guestfs-actions.pod:2704 ../fish/guestfish-actions.pod:1841
10897 msgid "\"installed\""
10898 msgstr "\"installed\""
10901 #: ../src/guestfs-actions.pod:2706 ../fish/guestfish-actions.pod:1843
10902 msgid "This is an installed operating system."
10903 msgstr "Це встановлена операційна система."
10906 #: ../src/guestfs-actions.pod:2708 ../fish/guestfish-actions.pod:1845
10907 msgid "\"installer\""
10911 #: ../src/guestfs-actions.pod:2710 ../fish/guestfish-actions.pod:1847
10913 "The disk image being inspected is not an installed operating system, but a "
10914 "I<bootable> install disk, live CD, or similar."
10918 #: ../src/guestfs-actions.pod:2715 ../fish/guestfish-actions.pod:1852
10919 msgid "The format of this disk image is not known."
10923 #: ../src/guestfs-actions.pod:2727 ../src/guestfs-actions.pod:3158
10924 #: ../src/guestfs-actions.pod:3174 ../src/guestfs-actions.pod:3192
10925 #: ../src/guestfs-actions.pod:5837
10926 msgid "(Added in 1.9.4)"
10930 #: ../src/guestfs-actions.pod:2729
10931 msgid "guestfs_inspect_get_hostname"
10935 #: ../src/guestfs-actions.pod:2731
10939 " guestfs_inspect_get_hostname (guestfs_h *g,\n"
10940 " const char *root);\n"
10945 #: ../src/guestfs-actions.pod:2735 ../fish/guestfish-actions.pod:1865
10947 "This function returns the hostname of the operating system as found by "
10948 "inspection of the guest's configuration files."
10952 #: ../src/guestfs-actions.pod:2738 ../fish/guestfish-actions.pod:1868
10954 "If the hostname could not be determined, then the string C<unknown> is "
10959 #: ../src/guestfs-actions.pod:2746
10960 msgid "(Added in 1.7.9)"
10964 #: ../src/guestfs-actions.pod:2748
10965 msgid "guestfs_inspect_get_icon"
10969 #: ../src/guestfs-actions.pod:2750
10973 " guestfs_inspect_get_icon (guestfs_h *g,\n"
10974 " const char *root,\n"
10975 " size_t *size_r,\n"
10981 #: ../src/guestfs-actions.pod:2761
10984 " GUESTFS_INSPECT_GET_ICON_FAVICON, int favicon,\n"
10985 " GUESTFS_INSPECT_GET_ICON_HIGHQUALITY, int highquality,\n"
10990 #: ../src/guestfs-actions.pod:2764 ../fish/guestfish-actions.pod:1877
10992 "This function returns an icon corresponding to the inspected operating "
10993 "system. The icon is returned as a buffer containing a PNG image (re-encoded "
10994 "to PNG if necessary)."
10998 #: ../src/guestfs-actions.pod:2768 ../fish/guestfish-actions.pod:1881
11000 "If it was not possible to get an icon this function returns a zero-length "
11001 "(non-NULL) buffer. I<Callers must check for this case>."
11005 #: ../src/guestfs-actions.pod:2771 ../fish/guestfish-actions.pod:1884
11007 "Libguestfs will start by looking for a file called C</etc/favicon.png> or "
11008 "C<C:\\etc\\favicon.png> and if it has the correct format, the contents of "
11009 "this file will be returned. You can disable favicons by passing the "
11010 "optional C<favicon> boolean as false (default is true)."
11014 #: ../src/guestfs-actions.pod:2777 ../fish/guestfish-actions.pod:1890
11016 "If finding the favicon fails, then we look in other places in the guest for "
11021 #: ../src/guestfs-actions.pod:2780 ../fish/guestfish-actions.pod:1893
11023 "If the optional C<highquality> boolean is true then only high quality icons "
11024 "are returned, which means only icons of high resolution with an alpha "
11025 "channel. The default (false) is to return any icon we can, even if it is of "
11026 "substandard quality."
11030 #: ../src/guestfs-actions.pod:2791 ../fish/guestfish-actions.pod:1904
11032 "Unlike most other inspection API calls, the guest's disks must be mounted up "
11033 "before you call this, since it needs to read information from the guest "
11034 "filesystem during the call."
11038 #: ../src/guestfs-actions.pod:2797 ../fish/guestfish-actions.pod:1910
11040 "B<Security:> The icon data comes from the untrusted guest, and should be "
11041 "treated with caution. PNG files have been known to contain exploits. "
11042 "Ensure that libpng (or other relevant libraries) are fully up to date before "
11043 "trying to process or display the icon."
11047 #: ../src/guestfs-actions.pod:2805 ../fish/guestfish-actions.pod:1918
11049 "The PNG image returned can be any size. It might not be square. Libguestfs "
11050 "tries to return the largest, highest quality icon available. The "
11051 "application must scale the icon to the required size."
11055 #: ../src/guestfs-actions.pod:2812 ../fish/guestfish-actions.pod:1925
11057 "Extracting icons from Windows guests requires the external C<wrestool> "
11058 "program from the C<icoutils> package, and several programs (C<bmptopnm>, "
11059 "C<pnmtopng>, C<pamcut>) from the C<netpbm> package. These must be "
11060 "installed separately."
11064 #: ../src/guestfs-actions.pod:2819 ../fish/guestfish-actions.pod:1932
11066 "Operating system icons are usually trademarks. Seek legal advice before "
11067 "using trademarks in applications."
11071 #: ../src/guestfs-actions.pod:2828 ../src/guestfs-actions.pod:3653
11072 #: ../src/guestfs-actions.pod:4884
11073 msgid "(Added in 1.11.12)"
11077 #: ../src/guestfs-actions.pod:2830
11078 msgid "guestfs_inspect_get_icon_va"
11082 #: ../src/guestfs-actions.pod:2832
11086 " guestfs_inspect_get_icon_va (guestfs_h *g,\n"
11087 " const char *root,\n"
11088 " size_t *size_r,\n"
11089 " va_list args);\n"
11094 #: ../src/guestfs-actions.pod:2838
11095 msgid "This is the \"va_list variant\" of L</guestfs_inspect_get_icon>."
11099 #: ../src/guestfs-actions.pod:2842
11100 msgid "guestfs_inspect_get_icon_argv"
11104 #: ../src/guestfs-actions.pod:2844
11108 " guestfs_inspect_get_icon_argv (guestfs_h *g,\n"
11109 " const char *root,\n"
11110 " size_t *size_r,\n"
11111 " const struct guestfs_inspect_get_icon_argv *optargs);\n"
11116 #: ../src/guestfs-actions.pod:2850
11117 msgid "This is the \"argv variant\" of L</guestfs_inspect_get_icon>."
11121 #: ../src/guestfs-actions.pod:2854
11122 msgid "guestfs_inspect_get_major_version"
11126 #: ../src/guestfs-actions.pod:2856
11130 " guestfs_inspect_get_major_version (guestfs_h *g,\n"
11131 " const char *root);\n"
11136 #: ../src/guestfs-actions.pod:2860 ../fish/guestfish-actions.pod:1943
11138 "This returns the major version number of the inspected operating system."
11142 #: ../src/guestfs-actions.pod:2863 ../fish/guestfish-actions.pod:1946
11144 "Windows uses a consistent versioning scheme which is I<not> reflected in the "
11145 "popular public names used by the operating system. Notably the operating "
11146 "system known as \"Windows 7\" is really version 6.1 (ie. major = 6, minor = "
11147 "1). You can find out the real versions corresponding to releases of Windows "
11148 "by consulting Wikipedia or MSDN."
11152 #: ../src/guestfs-actions.pod:2870 ../src/guestfs-actions.pod:2887
11153 #: ../fish/guestfish-actions.pod:1953 ../fish/guestfish-actions.pod:1964
11154 msgid "If the version could not be determined, then C<0> is returned."
11158 #: ../src/guestfs-actions.pod:2878
11159 msgid "guestfs_inspect_get_minor_version"
11163 #: ../src/guestfs-actions.pod:2880
11167 " guestfs_inspect_get_minor_version (guestfs_h *g,\n"
11168 " const char *root);\n"
11173 #: ../src/guestfs-actions.pod:2884 ../fish/guestfish-actions.pod:1961
11175 "This returns the minor version number of the inspected operating system."
11179 #: ../src/guestfs-actions.pod:2889
11181 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
11182 "C<guestfs_inspect_get_major_version>."
11186 #: ../src/guestfs-actions.pod:2896
11187 msgid "guestfs_inspect_get_mountpoints"
11191 #: ../src/guestfs-actions.pod:2898
11195 " guestfs_inspect_get_mountpoints (guestfs_h *g,\n"
11196 " const char *root);\n"
11201 #: ../src/guestfs-actions.pod:2902 ../fish/guestfish-actions.pod:1973
11203 "This returns a hash of where we think the filesystems associated with this "
11204 "operating system should be mounted. Callers should note that this is at "
11205 "best an educated guess made by reading configuration files such as C</etc/"
11206 "fstab>. I<In particular note> that this may return filesystems which are "
11207 "non-existent or not mountable and callers should be prepared to handle or "
11208 "ignore failures if they try to mount them."
11212 #: ../src/guestfs-actions.pod:2911 ../fish/guestfish-actions.pod:1982
11214 "Each element in the returned hashtable has a key which is the path of the "
11215 "mountpoint (eg. C</boot>) and a value which is the filesystem that would be "
11216 "mounted there (eg. C</dev/sda1>)."
11220 #: ../src/guestfs-actions.pod:2916 ../fish/guestfish-actions.pod:1987
11222 "Non-mounted devices such as swap devices are I<not> returned in this list."
11226 #: ../src/guestfs-actions.pod:2919
11228 "For operating systems like Windows which still use drive letters, this call "
11229 "will only return an entry for the first drive \"mounted on\" C</>. For "
11230 "information about the mapping of drive letters to partitions, see "
11231 "C<guestfs_inspect_get_drive_mappings>."
11235 #: ../src/guestfs-actions.pod:2925
11237 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
11238 "C<guestfs_inspect_get_filesystems>."
11242 #: ../src/guestfs-actions.pod:2936
11243 msgid "guestfs_inspect_get_package_format"
11247 #: ../src/guestfs-actions.pod:2938
11251 " guestfs_inspect_get_package_format (guestfs_h *g,\n"
11252 " const char *root);\n"
11257 #: ../src/guestfs-actions.pod:2942
11259 "This function and C<guestfs_inspect_get_package_management> return the "
11260 "package format and package management tool used by the inspected operating "
11261 "system. For example for Fedora these functions would return C<rpm> (package "
11262 "format) and C<yum> (package management)."
11266 #: ../src/guestfs-actions.pod:2948 ../fish/guestfish-actions.pod:2009
11268 "This returns the string C<unknown> if we could not determine the package "
11269 "format I<or> if the operating system does not have a real packaging system "
11274 #: ../src/guestfs-actions.pod:2952 ../fish/guestfish-actions.pod:2013
11276 "Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>. "
11277 "Future versions of libguestfs may return other strings."
11281 #: ../src/guestfs-actions.pod:2960 ../src/guestfs-actions.pod:2988
11282 msgid "(Added in 1.7.5)"
11286 #: ../src/guestfs-actions.pod:2962
11287 msgid "guestfs_inspect_get_package_management"
11291 #: ../src/guestfs-actions.pod:2964
11295 " guestfs_inspect_get_package_management (guestfs_h *g,\n"
11296 " const char *root);\n"
11301 #: ../src/guestfs-actions.pod:2968
11303 "C<guestfs_inspect_get_package_format> and this function return the package "
11304 "format and package management tool used by the inspected operating system. "
11305 "For example for Fedora these functions would return C<rpm> (package format) "
11306 "and C<yum> (package management)."
11310 #: ../src/guestfs-actions.pod:2974 ../fish/guestfish-actions.pod:2028
11312 "This returns the string C<unknown> if we could not determine the package "
11313 "management tool I<or> if the operating system does not have a real packaging "
11314 "system (eg. Windows)."
11318 #: ../src/guestfs-actions.pod:2978 ../fish/guestfish-actions.pod:2032
11320 "Possible strings include: C<yum>, C<up2date>, C<apt> (for all Debian "
11321 "derivatives), C<portage>, C<pisi>, C<pacman>, C<urpmi>. Future versions of "
11322 "libguestfs may return other strings."
11326 #: ../src/guestfs-actions.pod:2990
11327 msgid "guestfs_inspect_get_product_name"
11331 #: ../src/guestfs-actions.pod:2992
11335 " guestfs_inspect_get_product_name (guestfs_h *g,\n"
11336 " const char *root);\n"
11341 #: ../src/guestfs-actions.pod:2996 ../fish/guestfish-actions.pod:2043
11343 "This returns the product name of the inspected operating system. The "
11344 "product name is generally some freeform string which can be displayed to the "
11345 "user, but should not be parsed by programs."
11349 #: ../src/guestfs-actions.pod:3001 ../fish/guestfish-actions.pod:2048
11351 "If the product name could not be determined, then the string C<unknown> is "
11356 #: ../src/guestfs-actions.pod:3011
11357 msgid "guestfs_inspect_get_product_variant"
11361 #: ../src/guestfs-actions.pod:3013
11365 " guestfs_inspect_get_product_variant (guestfs_h *g,\n"
11366 " const char *root);\n"
11371 #: ../src/guestfs-actions.pod:3017 ../fish/guestfish-actions.pod:2057
11373 #| msgid "This is an installed operating system."
11374 msgid "This returns the product variant of the inspected operating system."
11375 msgstr "Це встановлена операційна система."
11378 #: ../src/guestfs-actions.pod:3020 ../fish/guestfish-actions.pod:2060
11380 "For Windows guests, this returns the contents of the Registry key C<HKLM"
11381 "\\Software\\Microsoft\\Windows NT\\CurrentVersion> C<InstallationType> which "
11382 "is usually a string such as C<Client> or C<Server> (other values are "
11383 "possible). This can be used to distinguish consumer and enterprise versions "
11384 "of Windows that have the same version number (for example, Windows 7 and "
11385 "Windows 2008 Server are both version 6.1, but the former is C<Client> and "
11386 "the latter is C<Server>)."
11390 #: ../src/guestfs-actions.pod:3029 ../fish/guestfish-actions.pod:2069
11392 "For enterprise Linux guests, in future we intend this to return the product "
11393 "variant such as C<Desktop>, C<Server> and so on. But this is not "
11394 "implemented at present."
11398 #: ../src/guestfs-actions.pod:3033 ../fish/guestfish-actions.pod:2073
11400 "If the product variant could not be determined, then the string C<unknown> "
11405 #: ../src/guestfs-actions.pod:3036
11407 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
11408 "C<guestfs_inspect_get_product_name>, C<guestfs_inspect_get_major_version>."
11412 #: ../src/guestfs-actions.pod:3043
11413 msgid "(Added in 1.9.13)"
11417 #: ../src/guestfs-actions.pod:3045
11418 msgid "guestfs_inspect_get_roots"
11422 #: ../src/guestfs-actions.pod:3047
11426 " guestfs_inspect_get_roots (guestfs_h *g);\n"
11431 #: ../src/guestfs-actions.pod:3050
11433 "This function is a convenient way to get the list of root devices, as "
11434 "returned from a previous call to C<guestfs_inspect_os>, but without redoing "
11435 "the whole inspection process."
11439 #: ../src/guestfs-actions.pod:3054
11441 "This returns an empty list if either no root devices were found or the "
11442 "caller has not called C<guestfs_inspect_os>."
11446 #: ../src/guestfs-actions.pod:3063
11447 msgid "(Added in 1.7.3)"
11451 #: ../src/guestfs-actions.pod:3065
11452 msgid "guestfs_inspect_get_type"
11456 #: ../src/guestfs-actions.pod:3067
11460 " guestfs_inspect_get_type (guestfs_h *g,\n"
11461 " const char *root);\n"
11466 #: ../src/guestfs-actions.pod:3071 ../fish/guestfish-actions.pod:2097
11468 "This returns the type of the inspected operating system. Currently defined "
11473 #: ../src/guestfs-actions.pod:3076 ../fish/guestfish-actions.pod:2102
11478 #: ../src/guestfs-actions.pod:3078 ../fish/guestfish-actions.pod:2104
11479 msgid "Any Linux-based operating system."
11483 #: ../src/guestfs-actions.pod:3082 ../fish/guestfish-actions.pod:2108
11484 msgid "Any Microsoft Windows operating system."
11488 #: ../src/guestfs-actions.pod:3084 ../fish/guestfish-actions.pod:2110
11489 msgid "\"freebsd\""
11490 msgstr "\"freebsd\""
11493 #: ../src/guestfs-actions.pod:3086 ../fish/guestfish-actions.pod:2112
11498 #: ../src/guestfs-actions.pod:3090 ../fish/guestfish-actions.pod:2116
11499 msgid "The operating system type could not be determined."
11503 #: ../src/guestfs-actions.pod:3104
11504 msgid "guestfs_inspect_get_windows_current_control_set"
11508 #: ../src/guestfs-actions.pod:3106
11512 " guestfs_inspect_get_windows_current_control_set (guestfs_h *g,\n"
11513 " const char *root);\n"
11518 #: ../src/guestfs-actions.pod:3110 ../fish/guestfish-actions.pod:2129
11520 "This returns the Windows CurrentControlSet of the inspected guest. The "
11521 "CurrentControlSet is a registry key name such as C<ControlSet001>."
11525 #: ../src/guestfs-actions.pod:3113 ../fish/guestfish-actions.pod:2132
11527 "This call assumes that the guest is Windows and that the Registry could be "
11528 "examined by inspection. If this is not the case then an error is returned."
11532 #: ../src/guestfs-actions.pod:3124
11533 msgid "guestfs_inspect_get_windows_systemroot"
11537 #: ../src/guestfs-actions.pod:3126
11541 " guestfs_inspect_get_windows_systemroot (guestfs_h *g,\n"
11542 " const char *root);\n"
11547 #: ../src/guestfs-actions.pod:3130 ../fish/guestfish-actions.pod:2142
11549 "This returns the Windows systemroot of the inspected guest. The systemroot "
11550 "is a directory path such as C</WINDOWS>."
11554 #: ../src/guestfs-actions.pod:3133 ../fish/guestfish-actions.pod:2145
11556 "This call assumes that the guest is Windows and that the systemroot could be "
11557 "determined by inspection. If this is not the case then an error is returned."
11561 #: ../src/guestfs-actions.pod:3142
11562 msgid "(Added in 1.5.25)"
11566 #: ../src/guestfs-actions.pod:3144
11567 msgid "guestfs_inspect_is_live"
11571 #: ../src/guestfs-actions.pod:3146
11575 " guestfs_inspect_is_live (guestfs_h *g,\n"
11576 " const char *root);\n"
11581 #: ../src/guestfs-actions.pod:3150
11583 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
11584 "disk), then this returns true if a live image was detected on the disk."
11588 #: ../src/guestfs-actions.pod:3160
11589 msgid "guestfs_inspect_is_multipart"
11593 #: ../src/guestfs-actions.pod:3162
11597 " guestfs_inspect_is_multipart (guestfs_h *g,\n"
11598 " const char *root);\n"
11603 #: ../src/guestfs-actions.pod:3166
11605 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
11606 "disk), then this returns true if the disk is part of a set."
11610 #: ../src/guestfs-actions.pod:3176
11611 msgid "guestfs_inspect_is_netinst"
11615 #: ../src/guestfs-actions.pod:3178
11619 " guestfs_inspect_is_netinst (guestfs_h *g,\n"
11620 " const char *root);\n"
11625 #: ../src/guestfs-actions.pod:3182
11627 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
11628 "disk), then this returns true if the disk is a network installer, ie. not a "
11629 "self-contained install CD but one which is likely to require network access "
11630 "to complete the install."
11634 #: ../src/guestfs-actions.pod:3194
11635 msgid "guestfs_inspect_list_applications"
11639 #: ../src/guestfs-actions.pod:3196
11642 " struct guestfs_application_list *\n"
11643 " guestfs_inspect_list_applications (guestfs_h *g,\n"
11644 " const char *root);\n"
11649 #: ../src/guestfs-actions.pod:3200 ../fish/guestfish-actions.pod:2187
11650 msgid "Return the list of applications installed in the operating system."
11654 #: ../src/guestfs-actions.pod:3202
11656 "I<Note:> This call works differently from other parts of the inspection "
11657 "API. You have to call C<guestfs_inspect_os>, then "
11658 "C<guestfs_inspect_get_mountpoints>, then mount up the disks, before calling "
11659 "this. Listing applications is a significantly more difficult operation "
11660 "which requires access to the full filesystem. Also note that unlike the "
11661 "other C<guestfs_inspect_get_*> calls which are just returning data cached in "
11662 "the libguestfs handle, this call actually reads parts of the mounted "
11663 "filesystems during the call."
11667 #: ../src/guestfs-actions.pod:3212 ../fish/guestfish-actions.pod:2199
11669 "This returns an empty list if the inspection code was not able to determine "
11670 "the list of applications."
11674 #: ../src/guestfs-actions.pod:3215 ../fish/guestfish-actions.pod:2202
11675 msgid "The application structure contains the following fields:"
11679 #: ../src/guestfs-actions.pod:3219 ../fish/guestfish-actions.pod:2206
11680 msgid "C<app_name>"
11681 msgstr "C<app_name>"
11684 #: ../src/guestfs-actions.pod:3221 ../fish/guestfish-actions.pod:2208
11686 "The name of the application. For Red Hat-derived and Debian-derived Linux "
11687 "guests, this is the package name."
11691 #: ../src/guestfs-actions.pod:3224 ../fish/guestfish-actions.pod:2211
11692 msgid "C<app_display_name>"
11693 msgstr "C<app_display_name>"
11696 #: ../src/guestfs-actions.pod:3226 ../fish/guestfish-actions.pod:2213
11698 "The display name of the application, sometimes localized to the install "
11699 "language of the guest operating system."
11703 #: ../src/guestfs-actions.pod:3229 ../fish/guestfish-actions.pod:2216
11705 "If unavailable this is returned as an empty string C<\"\">. Callers needing "
11706 "to display something can use C<app_name> instead."
11710 #: ../src/guestfs-actions.pod:3232 ../fish/guestfish-actions.pod:2219
11711 msgid "C<app_epoch>"
11712 msgstr "C<app_epoch>"
11715 #: ../src/guestfs-actions.pod:3234 ../fish/guestfish-actions.pod:2221
11717 "For package managers which use epochs, this contains the epoch of the "
11718 "package (an integer). If unavailable, this is returned as C<0>."
11722 #: ../src/guestfs-actions.pod:3237 ../fish/guestfish-actions.pod:2224
11723 msgid "C<app_version>"
11724 msgstr "C<app_version>"
11727 #: ../src/guestfs-actions.pod:3239 ../fish/guestfish-actions.pod:2226
11729 "The version string of the application or package. If unavailable this is "
11730 "returned as an empty string C<\"\">."
11734 #: ../src/guestfs-actions.pod:3242 ../fish/guestfish-actions.pod:2229
11735 msgid "C<app_release>"
11736 msgstr "C<app_release>"
11739 #: ../src/guestfs-actions.pod:3244 ../fish/guestfish-actions.pod:2231
11741 "The release string of the application or package, for package managers that "
11742 "use this. If unavailable this is returned as an empty string C<\"\">."
11746 #: ../src/guestfs-actions.pod:3248 ../fish/guestfish-actions.pod:2235
11747 msgid "C<app_install_path>"
11748 msgstr "C<app_install_path>"
11751 #: ../src/guestfs-actions.pod:3250 ../fish/guestfish-actions.pod:2237
11753 "The installation path of the application (on operating systems such as "
11754 "Windows which use installation paths). This path is in the format used by "
11755 "the guest operating system, it is not a libguestfs path."
11759 #: ../src/guestfs-actions.pod:3255 ../fish/guestfish-actions.pod:2242
11760 msgid "If unavailable this is returned as an empty string C<\"\">."
11764 #: ../src/guestfs-actions.pod:3257 ../fish/guestfish-actions.pod:2244
11765 msgid "C<app_trans_path>"
11766 msgstr "C<app_trans_path>"
11769 #: ../src/guestfs-actions.pod:3259 ../fish/guestfish-actions.pod:2246
11771 "The install path translated into a libguestfs path. If unavailable this is "
11772 "returned as an empty string C<\"\">."
11776 #: ../src/guestfs-actions.pod:3262 ../fish/guestfish-actions.pod:2249
11777 msgid "C<app_publisher>"
11778 msgstr "C<app_publisher>"
11781 #: ../src/guestfs-actions.pod:3264 ../fish/guestfish-actions.pod:2251
11783 "The name of the publisher of the application, for package managers that use "
11784 "this. If unavailable this is returned as an empty string C<\"\">."
11788 #: ../src/guestfs-actions.pod:3268 ../fish/guestfish-actions.pod:2255
11790 msgstr "C<app_url>"
11793 #: ../src/guestfs-actions.pod:3270 ../fish/guestfish-actions.pod:2257
11795 "The URL (eg. upstream URL) of the application. If unavailable this is "
11796 "returned as an empty string C<\"\">."
11800 #: ../src/guestfs-actions.pod:3273 ../fish/guestfish-actions.pod:2260
11801 msgid "C<app_source_package>"
11805 #: ../src/guestfs-actions.pod:3275 ../fish/guestfish-actions.pod:2262
11807 "For packaging systems which support this, the name of the source package. "
11808 "If unavailable this is returned as an empty string C<\"\">."
11812 #: ../src/guestfs-actions.pod:3278 ../fish/guestfish-actions.pod:2265
11813 msgid "C<app_summary>"
11817 #: ../src/guestfs-actions.pod:3280 ../fish/guestfish-actions.pod:2267
11819 "A short (usually one line) description of the application or package. If "
11820 "unavailable this is returned as an empty string C<\"\">."
11824 #: ../src/guestfs-actions.pod:3283 ../fish/guestfish-actions.pod:2270
11825 msgid "C<app_description>"
11829 #: ../src/guestfs-actions.pod:3285 ../fish/guestfish-actions.pod:2272
11831 "A longer description of the application or package. If unavailable this is "
11832 "returned as an empty string C<\"\">."
11836 #: ../src/guestfs-actions.pod:3292
11838 "This function returns a C<struct guestfs_application_list *>, or NULL if "
11839 "there was an error. I<The caller must call C<guestfs_free_application_list> "
11844 #: ../src/guestfs-actions.pod:3296
11845 msgid "(Added in 1.7.8)"
11849 #: ../src/guestfs-actions.pod:3298
11850 msgid "guestfs_inspect_os"
11854 #: ../src/guestfs-actions.pod:3300
11858 " guestfs_inspect_os (guestfs_h *g);\n"
11863 #: ../src/guestfs-actions.pod:3303 ../fish/guestfish-actions.pod:2283
11865 "This function uses other libguestfs functions and certain heuristics to "
11866 "inspect the disk(s) (usually disks belonging to a virtual machine), looking "
11867 "for operating systems."
11871 #: ../src/guestfs-actions.pod:3307 ../fish/guestfish-actions.pod:2287
11872 msgid "The list returned is empty if no operating systems were found."
11876 #: ../src/guestfs-actions.pod:3309 ../fish/guestfish-actions.pod:2289
11878 "If one operating system was found, then this returns a list with a single "
11879 "element, which is the name of the root filesystem of this operating system. "
11880 "It is also possible for this function to return a list containing more than "
11881 "one element, indicating a dual-boot or multi-boot virtual machine, with each "
11882 "element being the root filesystem of one of the operating systems."
11886 #: ../src/guestfs-actions.pod:3316
11888 "You can pass the root string(s) returned to other C<guestfs_inspect_get_*> "
11889 "functions in order to query further information about each operating system, "
11890 "such as the name and version."
11894 #: ../src/guestfs-actions.pod:3321
11896 "This function uses other libguestfs features such as C<guestfs_mount_ro> and "
11897 "C<guestfs_umount_all> in order to mount and unmount filesystems and look at "
11898 "the contents. This should be called with no disks currently mounted. The "
11899 "function may also use Augeas, so any existing Augeas handle will be closed."
11903 #: ../src/guestfs-actions.pod:3327 ../fish/guestfish-actions.pod:2307
11905 "This function cannot decrypt encrypted disks. The caller must do that first "
11906 "(supplying the necessary keys) if the disk is encrypted."
11910 #: ../src/guestfs-actions.pod:3333 ../src/guestfs-actions.pod:3664
11911 #: ../src/guestfs-actions.pod:3726
11912 msgid "See also C<guestfs_list_filesystems>."
11916 #: ../src/guestfs-actions.pod:3341
11917 msgid "guestfs_is_blockdev"
11921 #: ../src/guestfs-actions.pod:3343
11925 " guestfs_is_blockdev (guestfs_h *g,\n"
11926 " const char *path);\n"
11931 #: ../src/guestfs-actions.pod:3347 ../fish/guestfish-actions.pod:2319
11933 "This returns C<true> if and only if there is a block device with the given "
11938 #: ../src/guestfs-actions.pod:3350 ../src/guestfs-actions.pod:3379
11939 #: ../src/guestfs-actions.pod:3409 ../src/guestfs-actions.pod:3424
11940 #: ../src/guestfs-actions.pod:3440 ../src/guestfs-actions.pod:3496
11941 #: ../src/guestfs-actions.pod:3511
11942 msgid "See also C<guestfs_stat>."
11946 #: ../src/guestfs-actions.pod:3354 ../src/guestfs-actions.pod:3383
11947 #: ../src/guestfs-actions.pod:3428 ../src/guestfs-actions.pod:3500
11948 #: ../src/guestfs-actions.pod:3515
11949 msgid "(Added in 1.5.10)"
11953 #: ../src/guestfs-actions.pod:3356
11954 msgid "guestfs_is_busy"
11958 #: ../src/guestfs-actions.pod:3358
11962 " guestfs_is_busy (guestfs_h *g);\n"
11967 #: ../src/guestfs-actions.pod:3361 ../fish/guestfish-actions.pod:2328
11969 "This returns true iff this handle is busy processing a command (in the "
11974 #: ../src/guestfs-actions.pod:3370
11975 msgid "guestfs_is_chardev"
11979 #: ../src/guestfs-actions.pod:3372
11983 " guestfs_is_chardev (guestfs_h *g,\n"
11984 " const char *path);\n"
11989 #: ../src/guestfs-actions.pod:3376 ../fish/guestfish-actions.pod:2337
11991 "This returns C<true> if and only if there is a character device with the "
11992 "given C<path> name."
11996 #: ../src/guestfs-actions.pod:3385
11997 msgid "guestfs_is_config"
12001 #: ../src/guestfs-actions.pod:3387
12005 " guestfs_is_config (guestfs_h *g);\n"
12010 #: ../src/guestfs-actions.pod:3390 ../fish/guestfish-actions.pod:2346
12012 "This returns true iff this handle is being configured (in the C<CONFIG> "
12017 #: ../src/guestfs-actions.pod:3399
12018 msgid "guestfs_is_dir"
12022 #: ../src/guestfs-actions.pod:3401
12026 " guestfs_is_dir (guestfs_h *g,\n"
12027 " const char *path);\n"
12032 #: ../src/guestfs-actions.pod:3405 ../fish/guestfish-actions.pod:2355
12034 "This returns C<true> if and only if there is a directory with the given "
12035 "C<path> name. Note that it returns false for other objects like files."
12039 #: ../src/guestfs-actions.pod:3415
12040 msgid "guestfs_is_fifo"
12044 #: ../src/guestfs-actions.pod:3417
12048 " guestfs_is_fifo (guestfs_h *g,\n"
12049 " const char *path);\n"
12054 #: ../src/guestfs-actions.pod:3421 ../fish/guestfish-actions.pod:2365
12056 "This returns C<true> if and only if there is a FIFO (named pipe) with the "
12057 "given C<path> name."
12061 #: ../src/guestfs-actions.pod:3430
12062 msgid "guestfs_is_file"
12066 #: ../src/guestfs-actions.pod:3432
12070 " guestfs_is_file (guestfs_h *g,\n"
12071 " const char *path);\n"
12076 #: ../src/guestfs-actions.pod:3436 ../fish/guestfish-actions.pod:2374
12078 "This returns C<true> if and only if there is a regular file with the given "
12079 "C<path> name. Note that it returns false for other objects like directories."
12083 #: ../src/guestfs-actions.pod:3446
12084 msgid "guestfs_is_launching"
12088 #: ../src/guestfs-actions.pod:3448
12092 " guestfs_is_launching (guestfs_h *g);\n"
12097 #: ../src/guestfs-actions.pod:3451 ../fish/guestfish-actions.pod:2384
12099 "This returns true iff this handle is launching the subprocess (in the "
12100 "C<LAUNCHING> state)."
12104 #: ../src/guestfs-actions.pod:3460
12105 msgid "guestfs_is_lv"
12109 #: ../src/guestfs-actions.pod:3462
12113 " guestfs_is_lv (guestfs_h *g,\n"
12114 " const char *device);\n"
12119 #: ../src/guestfs-actions.pod:3466 ../fish/guestfish-actions.pod:2393
12121 "This command tests whether C<device> is a logical volume, and returns true "
12122 "iff this is the case."
12126 #: ../src/guestfs-actions.pod:3473
12127 msgid "guestfs_is_ready"
12131 #: ../src/guestfs-actions.pod:3475
12135 " guestfs_is_ready (guestfs_h *g);\n"
12140 #: ../src/guestfs-actions.pod:3478 ../fish/guestfish-actions.pod:2400
12142 "This returns true iff this handle is ready to accept commands (in the "
12147 #: ../src/guestfs-actions.pod:3487
12148 msgid "guestfs_is_socket"
12152 #: ../src/guestfs-actions.pod:3489
12156 " guestfs_is_socket (guestfs_h *g,\n"
12157 " const char *path);\n"
12162 #: ../src/guestfs-actions.pod:3493 ../fish/guestfish-actions.pod:2409
12164 "This returns C<true> if and only if there is a Unix domain socket with the "
12165 "given C<path> name."
12169 #: ../src/guestfs-actions.pod:3502
12170 msgid "guestfs_is_symlink"
12174 #: ../src/guestfs-actions.pod:3504
12178 " guestfs_is_symlink (guestfs_h *g,\n"
12179 " const char *path);\n"
12184 #: ../src/guestfs-actions.pod:3508 ../fish/guestfish-actions.pod:2418
12186 "This returns C<true> if and only if there is a symbolic link with the given "
12191 #: ../src/guestfs-actions.pod:3517
12192 msgid "guestfs_is_zero"
12196 #: ../src/guestfs-actions.pod:3519
12200 " guestfs_is_zero (guestfs_h *g,\n"
12201 " const char *path);\n"
12206 #: ../src/guestfs-actions.pod:3523 ../fish/guestfish-actions.pod:2427
12208 "This returns true iff the file exists and the file is empty or it contains "
12213 #: ../src/guestfs-actions.pod:3528 ../src/guestfs-actions.pod:3542
12214 msgid "(Added in 1.11.8)"
12218 #: ../src/guestfs-actions.pod:3530
12219 msgid "guestfs_is_zero_device"
12223 #: ../src/guestfs-actions.pod:3532
12227 " guestfs_is_zero_device (guestfs_h *g,\n"
12228 " const char *device);\n"
12233 #: ../src/guestfs-actions.pod:3536 ../fish/guestfish-actions.pod:2434
12234 msgid "This returns true iff the device exists and contains all zero bytes."
12238 #: ../src/guestfs-actions.pod:3538 ../fish/guestfish-actions.pod:2436
12239 msgid "Note that for large devices this can take a long time to run."
12243 #: ../src/guestfs-actions.pod:3544
12244 msgid "guestfs_kill_subprocess"
12248 #: ../src/guestfs-actions.pod:3546
12252 " guestfs_kill_subprocess (guestfs_h *g);\n"
12257 #: ../src/guestfs-actions.pod:3549 ../fish/guestfish-actions.pod:2442
12258 msgid "This kills the qemu subprocess. You should never need to call this."
12262 #: ../src/guestfs-actions.pod:3555
12263 msgid "guestfs_launch"
12267 #: ../src/guestfs-actions.pod:3557
12271 " guestfs_launch (guestfs_h *g);\n"
12276 #: ../src/guestfs-actions.pod:3560 ../fish/guestfish-actions.pod:2450
12278 "Internally libguestfs is implemented by running a virtual machine using "
12283 #: ../src/guestfs-actions.pod:3563 ../fish/guestfish-actions.pod:2453
12285 "You should call this after configuring the handle (eg. adding drives) but "
12286 "before performing any actions."
12290 #: ../src/guestfs-actions.pod:3575
12291 msgid "guestfs_lchown"
12295 #: ../src/guestfs-actions.pod:3577
12299 " guestfs_lchown (guestfs_h *g,\n"
12302 " const char *path);\n"
12307 #: ../src/guestfs-actions.pod:3583
12309 "Change the file owner to C<owner> and group to C<group>. This is like "
12310 "C<guestfs_chown> but if C<path> is a symlink then the link itself is "
12311 "changed, not the target."
12315 #: ../src/guestfs-actions.pod:3595
12316 msgid "guestfs_lgetxattr"
12320 #: ../src/guestfs-actions.pod:3597
12324 " guestfs_lgetxattr (guestfs_h *g,\n"
12325 " const char *path,\n"
12326 " const char *name,\n"
12327 " size_t *size_r);\n"
12332 #: ../src/guestfs-actions.pod:3603 ../fish/guestfish-actions.pod:2472
12334 "Get a single extended attribute from file C<path> named C<name>. If C<path> "
12335 "is a symlink, then this call returns an extended attribute from the symlink."
12339 #: ../src/guestfs-actions.pod:3617
12340 msgid "See also: C<guestfs_lgetxattrs>, C<guestfs_getxattr>, L<attr(5)>."
12344 #: ../src/guestfs-actions.pod:3625
12345 msgid "guestfs_lgetxattrs"
12349 #: ../src/guestfs-actions.pod:3627
12352 " struct guestfs_xattr_list *\n"
12353 " guestfs_lgetxattrs (guestfs_h *g,\n"
12354 " const char *path);\n"
12359 #: ../src/guestfs-actions.pod:3631
12361 "This is the same as C<guestfs_getxattrs>, but if C<path> is a symbolic link, "
12362 "then it returns the extended attributes of the link itself."
12366 #: ../src/guestfs-actions.pod:3641
12367 msgid "guestfs_list_9p"
12371 #: ../src/guestfs-actions.pod:3643
12375 " guestfs_list_9p (guestfs_h *g);\n"
12380 #: ../src/guestfs-actions.pod:3646 ../fish/guestfish-actions.pod:2500
12382 "List all 9p filesystems attached to the guest. A list of mount tags is "
12387 #: ../src/guestfs-actions.pod:3655
12388 msgid "guestfs_list_devices"
12392 #: ../src/guestfs-actions.pod:3657
12396 " guestfs_list_devices (guestfs_h *g);\n"
12401 #: ../src/guestfs-actions.pod:3660 ../fish/guestfish-actions.pod:2507
12402 msgid "List all the block devices."
12406 #: ../src/guestfs-actions.pod:3662 ../fish/guestfish-actions.pod:2509
12407 msgid "The full block device names are returned, eg. C</dev/sda>."
12411 #: ../src/guestfs-actions.pod:3672
12412 msgid "guestfs_list_filesystems"
12416 #: ../src/guestfs-actions.pod:3674
12420 " guestfs_list_filesystems (guestfs_h *g);\n"
12425 #: ../src/guestfs-actions.pod:3677 ../fish/guestfish-actions.pod:2517
12427 "This inspection command looks for filesystems on partitions, block devices "
12428 "and logical volumes, returning a list of devices containing filesystems and "
12433 #: ../src/guestfs-actions.pod:3681 ../fish/guestfish-actions.pod:2521
12435 "The return value is a hash, where the keys are the devices containing "
12436 "filesystems, and the values are the filesystem types. For example:"
12440 #: ../src/guestfs-actions.pod:3685 ../fish/guestfish-actions.pod:2525
12443 " \"/dev/sda1\" => \"ntfs\"\n"
12444 " \"/dev/sda2\" => \"ext2\"\n"
12445 " \"/dev/vg_guest/lv_root\" => \"ext4\"\n"
12446 " \"/dev/vg_guest/lv_swap\" => \"swap\"\n"
12451 #: ../src/guestfs-actions.pod:3690 ../fish/guestfish-actions.pod:2530
12453 "The value can have the special value \"unknown\", meaning the content of the "
12454 "device is undetermined or empty. \"swap\" means a Linux swap partition."
12458 #: ../src/guestfs-actions.pod:3694
12460 "This command runs other libguestfs commands, which might include "
12461 "C<guestfs_mount> and C<guestfs_umount>, and therefore you should use this "
12462 "soon after launch and only when nothing is mounted."
12466 #: ../src/guestfs-actions.pod:3698
12468 "Not all of the filesystems returned will be mountable. In particular, swap "
12469 "partitions are returned in the list. Also this command does not check that "
12470 "each filesystem found is valid and mountable, and some filesystems might be "
12471 "mountable but require special options. Filesystems may not all belong to a "
12472 "single logical operating system (use C<guestfs_inspect_os> to look for OSes)."
12476 #: ../src/guestfs-actions.pod:3712 ../src/guestfs-actions.pod:5386
12477 msgid "(Added in 1.5.15)"
12481 #: ../src/guestfs-actions.pod:3714
12482 msgid "guestfs_list_partitions"
12486 #: ../src/guestfs-actions.pod:3716
12490 " guestfs_list_partitions (guestfs_h *g);\n"
12495 #: ../src/guestfs-actions.pod:3719 ../fish/guestfish-actions.pod:2550
12496 msgid "List all the partitions detected on all block devices."
12500 #: ../src/guestfs-actions.pod:3721 ../fish/guestfish-actions.pod:2552
12501 msgid "The full partition device names are returned, eg. C</dev/sda1>"
12505 #: ../src/guestfs-actions.pod:3723
12507 "This does not return logical volumes. For that you will need to call "
12512 #: ../src/guestfs-actions.pod:3734
12517 #: ../src/guestfs-actions.pod:3736
12521 " guestfs_ll (guestfs_h *g,\n"
12522 " const char *directory);\n"
12527 #: ../src/guestfs-actions.pod:3740 ../fish/guestfish-actions.pod:2563
12529 "List the files in C<directory> (relative to the root directory, there is no "
12530 "cwd) in the format of 'ls -la'."
12534 #: ../src/guestfs-actions.pod:3743 ../fish/guestfish-actions.pod:2566
12536 "This command is mostly useful for interactive sessions. It is I<not> "
12537 "intended that you try to parse the output string."
12541 #: ../src/guestfs-actions.pod:3751
12546 #: ../src/guestfs-actions.pod:3753
12550 " guestfs_ln (guestfs_h *g,\n"
12551 " const char *target,\n"
12552 " const char *linkname);\n"
12557 #: ../src/guestfs-actions.pod:3758 ../fish/guestfish-actions.pod:2573
12558 msgid "This command creates a hard link using the C<ln> command."
12562 #: ../src/guestfs-actions.pod:3764
12563 msgid "guestfs_ln_f"
12567 #: ../src/guestfs-actions.pod:3766
12571 " guestfs_ln_f (guestfs_h *g,\n"
12572 " const char *target,\n"
12573 " const char *linkname);\n"
12578 #: ../src/guestfs-actions.pod:3771 ../fish/guestfish-actions.pod:2579
12580 "This command creates a hard link using the C<ln -f> command. The I<-f> "
12581 "option removes the link (C<linkname>) if it exists already."
12585 #: ../src/guestfs-actions.pod:3778
12586 msgid "guestfs_ln_s"
12590 #: ../src/guestfs-actions.pod:3780
12594 " guestfs_ln_s (guestfs_h *g,\n"
12595 " const char *target,\n"
12596 " const char *linkname);\n"
12601 #: ../src/guestfs-actions.pod:3785 ../fish/guestfish-actions.pod:2586
12602 msgid "This command creates a symbolic link using the C<ln -s> command."
12606 #: ../src/guestfs-actions.pod:3791
12607 msgid "guestfs_ln_sf"
12611 #: ../src/guestfs-actions.pod:3793
12615 " guestfs_ln_sf (guestfs_h *g,\n"
12616 " const char *target,\n"
12617 " const char *linkname);\n"
12622 #: ../src/guestfs-actions.pod:3798 ../fish/guestfish-actions.pod:2592
12624 "This command creates a symbolic link using the C<ln -sf> command, The I<-f> "
12625 "option removes the link (C<linkname>) if it exists already."
12629 #: ../src/guestfs-actions.pod:3805
12630 msgid "guestfs_lremovexattr"
12634 #: ../src/guestfs-actions.pod:3807
12638 " guestfs_lremovexattr (guestfs_h *g,\n"
12639 " const char *xattr,\n"
12640 " const char *path);\n"
12645 #: ../src/guestfs-actions.pod:3812
12647 "This is the same as C<guestfs_removexattr>, but if C<path> is a symbolic "
12648 "link, then it removes an extended attribute of the link itself."
12652 #: ../src/guestfs-actions.pod:3820
12657 #: ../src/guestfs-actions.pod:3822
12661 " guestfs_ls (guestfs_h *g,\n"
12662 " const char *directory);\n"
12667 #: ../src/guestfs-actions.pod:3826 ../fish/guestfish-actions.pod:2607
12669 "List the files in C<directory> (relative to the root directory, there is no "
12670 "cwd). The '.' and '..' entries are not returned, but hidden files are shown."
12674 #: ../src/guestfs-actions.pod:3830
12676 "This command is mostly useful for interactive sessions. Programs should "
12677 "probably use C<guestfs_readdir> instead."
12681 #: ../src/guestfs-actions.pod:3839
12682 msgid "guestfs_lsetxattr"
12686 #: ../src/guestfs-actions.pod:3841
12690 " guestfs_lsetxattr (guestfs_h *g,\n"
12691 " const char *xattr,\n"
12692 " const char *val,\n"
12694 " const char *path);\n"
12699 #: ../src/guestfs-actions.pod:3848
12701 "This is the same as C<guestfs_setxattr>, but if C<path> is a symbolic link, "
12702 "then it sets an extended attribute of the link itself."
12706 #: ../src/guestfs-actions.pod:3856
12707 msgid "guestfs_lstat"
12711 #: ../src/guestfs-actions.pod:3858
12714 " struct guestfs_stat *\n"
12715 " guestfs_lstat (guestfs_h *g,\n"
12716 " const char *path);\n"
12721 #: ../src/guestfs-actions.pod:3862 ../src/guestfs-actions.pod:6521
12722 #: ../fish/guestfish-actions.pod:2626 ../fish/guestfish-actions.pod:4353
12723 msgid "Returns file information for the given C<path>."
12727 #: ../src/guestfs-actions.pod:3864
12729 "This is the same as C<guestfs_stat> except that if C<path> is a symbolic "
12730 "link, then the link is stat-ed, not the file it refers to."
12734 #: ../src/guestfs-actions.pod:3868 ../fish/guestfish-actions.pod:2632
12735 msgid "This is the same as the C<lstat(2)> system call."
12739 #: ../src/guestfs-actions.pod:3870 ../src/guestfs-actions.pod:6525
12741 "This function returns a C<struct guestfs_stat *>, or NULL if there was an "
12742 "error. I<The caller must call C<guestfs_free_stat> after use>."
12746 #: ../src/guestfs-actions.pod:3874 ../src/guestfs-actions.pod:6529
12747 #: ../src/guestfs-actions.pod:6547 ../src/guestfs-actions.pod:6928
12748 msgid "(Added in 0.9.2)"
12752 #: ../src/guestfs-actions.pod:3876
12753 msgid "guestfs_lstatlist"
12757 #: ../src/guestfs-actions.pod:3878
12760 " struct guestfs_stat_list *\n"
12761 " guestfs_lstatlist (guestfs_h *g,\n"
12762 " const char *path,\n"
12763 " char *const *names);\n"
12768 #: ../src/guestfs-actions.pod:3883
12770 "This call allows you to perform the C<guestfs_lstat> operation on multiple "
12771 "files, where all files are in the directory C<path>. C<names> is the list "
12772 "of files from this directory."
12776 #: ../src/guestfs-actions.pod:3887 ../fish/guestfish-actions.pod:2642
12778 "On return you get a list of stat structs, with a one-to-one correspondence "
12779 "to the C<names> list. If any name did not exist or could not be lstat'd, "
12780 "then the C<ino> field of that structure is set to C<-1>."
12784 #: ../src/guestfs-actions.pod:3892
12786 "This call is intended for programs that want to efficiently list a directory "
12787 "contents without making many round-trips. See also C<guestfs_lxattrlist> "
12788 "for a similarly efficient call for getting extended attributes. Very long "
12789 "directory listings might cause the protocol message size to be exceeded, "
12790 "causing this call to fail. The caller must split up such requests into "
12791 "smaller groups of names."
12795 #: ../src/guestfs-actions.pod:3900
12797 "This function returns a C<struct guestfs_stat_list *>, or NULL if there was "
12798 "an error. I<The caller must call C<guestfs_free_stat_list> after use>."
12802 #: ../src/guestfs-actions.pod:3906
12803 msgid "guestfs_luks_add_key"
12807 #: ../src/guestfs-actions.pod:3908
12811 " guestfs_luks_add_key (guestfs_h *g,\n"
12812 " const char *device,\n"
12813 " const char *key,\n"
12814 " const char *newkey,\n"
12820 #: ../src/guestfs-actions.pod:3915 ../fish/guestfish-actions.pod:2659
12822 "This command adds a new key on LUKS device C<device>. C<key> is any "
12823 "existing key, and is used to access the device. C<newkey> is the new key to "
12824 "add. C<keyslot> is the key slot that will be replaced."
12828 #: ../src/guestfs-actions.pod:3920
12830 "Note that if C<keyslot> already contains a key, then this command will "
12831 "fail. You have to use C<guestfs_luks_kill_slot> first to remove that key."
12835 #: ../src/guestfs-actions.pod:3926 ../src/guestfs-actions.pod:3966
12836 #: ../src/guestfs-actions.pod:3989 ../src/guestfs-actions.pod:4009
12837 #: ../src/guestfs-actions.pod:4041 ../src/guestfs-actions.pod:4060
12839 "This function takes a key or passphrase parameter which could contain "
12840 "sensitive material. Read the section L</KEYS AND PASSPHRASES> for more "
12845 #: ../src/guestfs-actions.pod:3930 ../src/guestfs-actions.pod:3970
12846 #: ../src/guestfs-actions.pod:3993 ../src/guestfs-actions.pod:4013
12847 msgid "(Added in 1.5.2)"
12851 #: ../src/guestfs-actions.pod:3932
12852 msgid "guestfs_luks_close"
12856 #: ../src/guestfs-actions.pod:3934
12860 " guestfs_luks_close (guestfs_h *g,\n"
12861 " const char *device);\n"
12866 #: ../src/guestfs-actions.pod:3938
12868 "This closes a LUKS device that was created earlier by C<guestfs_luks_open> "
12869 "or C<guestfs_luks_open_ro>. The C<device> parameter must be the name of the "
12870 "LUKS mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
12871 "underlying block device."
12875 #: ../src/guestfs-actions.pod:3946 ../src/guestfs-actions.pod:4045
12876 #: ../src/guestfs-actions.pod:4064 ../src/guestfs-actions.pod:4114
12877 #: ../src/guestfs-actions.pod:4162
12878 msgid "(Added in 1.5.1)"
12882 #: ../src/guestfs-actions.pod:3948
12883 msgid "guestfs_luks_format"
12887 #: ../src/guestfs-actions.pod:3950
12891 " guestfs_luks_format (guestfs_h *g,\n"
12892 " const char *device,\n"
12893 " const char *key,\n"
12899 #: ../src/guestfs-actions.pod:3956 ../fish/guestfish-actions.pod:2685
12901 "This command erases existing data on C<device> and formats the device as a "
12902 "LUKS encrypted device. C<key> is the initial key, which is added to key "
12903 "slot C<slot>. (LUKS supports 8 key slots, numbered 0-7)."
12907 #: ../src/guestfs-actions.pod:3963 ../src/guestfs-actions.pod:3986
12908 #: ../src/guestfs-actions.pod:4126 ../src/guestfs-actions.pod:5137
12909 #: ../src/guestfs-actions.pod:5919 ../src/guestfs-actions.pod:6328
12910 #: ../src/guestfs-actions.pod:6358 ../src/guestfs-actions.pod:6391
12911 #: ../src/guestfs-actions.pod:7573 ../fish/guestfish-actions.pod:2693
12912 #: ../fish/guestfish-actions.pod:2706 ../fish/guestfish-actions.pod:2790
12913 #: ../fish/guestfish-actions.pod:3394 ../fish/guestfish-actions.pod:3914
12914 #: ../fish/guestfish-actions.pod:4224 ../fish/guestfish-actions.pod:4247
12915 #: ../fish/guestfish-actions.pod:4269 ../fish/guestfish-actions.pod:4999
12917 "B<This command is dangerous. Without careful use you can easily destroy all "
12922 #: ../src/guestfs-actions.pod:3972
12923 msgid "guestfs_luks_format_cipher"
12927 #: ../src/guestfs-actions.pod:3974
12931 " guestfs_luks_format_cipher (guestfs_h *g,\n"
12932 " const char *device,\n"
12933 " const char *key,\n"
12935 " const char *cipher);\n"
12940 #: ../src/guestfs-actions.pod:3981
12942 "This command is the same as C<guestfs_luks_format> but it also allows you to "
12943 "set the C<cipher> used."
12947 #: ../src/guestfs-actions.pod:3995
12948 msgid "guestfs_luks_kill_slot"
12952 #: ../src/guestfs-actions.pod:3997
12956 " guestfs_luks_kill_slot (guestfs_h *g,\n"
12957 " const char *device,\n"
12958 " const char *key,\n"
12964 #: ../src/guestfs-actions.pod:4003 ../fish/guestfish-actions.pod:2713
12966 "This command deletes the key in key slot C<keyslot> from the encrypted LUKS "
12967 "device C<device>. C<key> must be one of the I<other> keys."
12971 #: ../src/guestfs-actions.pod:4015
12972 msgid "guestfs_luks_open"
12976 #: ../src/guestfs-actions.pod:4017
12980 " guestfs_luks_open (guestfs_h *g,\n"
12981 " const char *device,\n"
12982 " const char *key,\n"
12983 " const char *mapname);\n"
12988 #: ../src/guestfs-actions.pod:4023 ../fish/guestfish-actions.pod:2724
12990 "This command opens a block device which has been encrypted according to the "
12991 "Linux Unified Key Setup (LUKS) standard."
12995 #: ../src/guestfs-actions.pod:4026 ../fish/guestfish-actions.pod:2727
12996 msgid "C<device> is the encrypted block device or partition."
13000 #: ../src/guestfs-actions.pod:4028 ../fish/guestfish-actions.pod:2729
13002 "The caller must supply one of the keys associated with the LUKS block "
13003 "device, in the C<key> parameter."
13007 #: ../src/guestfs-actions.pod:4031 ../fish/guestfish-actions.pod:2732
13009 "This creates a new block device called C</dev/mapper/mapname>. Reads and "
13010 "writes to this block device are decrypted from and encrypted to the "
13011 "underlying C<device> respectively."
13015 #: ../src/guestfs-actions.pod:4035
13017 "If this block device contains LVM volume groups, then calling "
13018 "C<guestfs_vgscan> followed by C<guestfs_vg_activate_all> will make them "
13023 #: ../src/guestfs-actions.pod:4047
13024 msgid "guestfs_luks_open_ro"
13028 #: ../src/guestfs-actions.pod:4049
13032 " guestfs_luks_open_ro (guestfs_h *g,\n"
13033 " const char *device,\n"
13034 " const char *key,\n"
13035 " const char *mapname);\n"
13040 #: ../src/guestfs-actions.pod:4055
13042 "This is the same as C<guestfs_luks_open> except that a read-only mapping is "
13047 #: ../src/guestfs-actions.pod:4066
13048 msgid "guestfs_lvcreate"
13052 #: ../src/guestfs-actions.pod:4068
13056 " guestfs_lvcreate (guestfs_h *g,\n"
13057 " const char *logvol,\n"
13058 " const char *volgroup,\n"
13064 #: ../src/guestfs-actions.pod:4074 ../fish/guestfish-actions.pod:2757
13066 "This creates an LVM logical volume called C<logvol> on the volume group "
13067 "C<volgroup>, with C<size> megabytes."
13071 #: ../src/guestfs-actions.pod:4081
13072 msgid "guestfs_lvm_canonical_lv_name"
13076 #: ../src/guestfs-actions.pod:4083
13080 " guestfs_lvm_canonical_lv_name (guestfs_h *g,\n"
13081 " const char *lvname);\n"
13086 #: ../src/guestfs-actions.pod:4087 ../fish/guestfish-actions.pod:2764
13088 "This converts alternative naming schemes for LVs that you might find to the "
13089 "canonical name. For example, C</dev/mapper/VG-LV> is converted to C</dev/VG/"
13094 #: ../src/guestfs-actions.pod:4091 ../fish/guestfish-actions.pod:2768
13096 "This command returns an error if the C<lvname> parameter does not refer to a "
13101 #: ../src/guestfs-actions.pod:4094
13102 msgid "See also C<guestfs_is_lv>."
13106 #: ../src/guestfs-actions.pod:4099
13107 msgid "(Added in 1.5.24)"
13111 #: ../src/guestfs-actions.pod:4101
13112 msgid "guestfs_lvm_clear_filter"
13116 #: ../src/guestfs-actions.pod:4103
13120 " guestfs_lvm_clear_filter (guestfs_h *g);\n"
13125 #: ../src/guestfs-actions.pod:4106
13127 "This undoes the effect of C<guestfs_lvm_set_filter>. LVM will be able to "
13128 "see every block device."
13132 #: ../src/guestfs-actions.pod:4109 ../src/guestfs-actions.pod:4151
13133 #: ../fish/guestfish-actions.pod:2780 ../fish/guestfish-actions.pod:2811
13135 "This command also clears the LVM cache and performs a volume group scan."
13139 #: ../src/guestfs-actions.pod:4116
13140 msgid "guestfs_lvm_remove_all"
13144 #: ../src/guestfs-actions.pod:4118
13148 " guestfs_lvm_remove_all (guestfs_h *g);\n"
13153 #: ../src/guestfs-actions.pod:4121 ../fish/guestfish-actions.pod:2787
13155 "This command removes all LVM logical volumes, volume groups and physical "
13160 #: ../src/guestfs-actions.pod:4131
13161 msgid "guestfs_lvm_set_filter"
13165 #: ../src/guestfs-actions.pod:4133
13169 " guestfs_lvm_set_filter (guestfs_h *g,\n"
13170 " char *const *devices);\n"
13175 #: ../src/guestfs-actions.pod:4137 ../fish/guestfish-actions.pod:2797
13177 "This sets the LVM device filter so that LVM will only be able to \"see\" the "
13178 "block devices in the list C<devices>, and will ignore all other attached "
13183 #: ../src/guestfs-actions.pod:4141 ../fish/guestfish-actions.pod:2801
13185 "Where disk image(s) contain duplicate PVs or VGs, this command is useful to "
13186 "get LVM to ignore the duplicates, otherwise LVM can get confused. Note also "
13187 "there are two types of duplication possible: either cloned PVs/VGs which "
13188 "have identical UUIDs; or VGs that are not cloned but just happen to have the "
13189 "same name. In normal operation you cannot create this situation, but you "
13190 "can do it outside LVM, eg. by cloning disk images or by bit twiddling "
13191 "inside the LVM metadata."
13195 #: ../src/guestfs-actions.pod:4154 ../fish/guestfish-actions.pod:2814
13196 msgid "You can filter whole block devices or individual partitions."
13200 #: ../src/guestfs-actions.pod:4156 ../fish/guestfish-actions.pod:2816
13202 "You cannot use this if any VG is currently in use (eg. contains a mounted "
13203 "filesystem), even if you are not filtering out that VG."
13207 #: ../src/guestfs-actions.pod:4164
13208 msgid "guestfs_lvremove"
13212 #: ../src/guestfs-actions.pod:4166
13216 " guestfs_lvremove (guestfs_h *g,\n"
13217 " const char *device);\n"
13222 #: ../src/guestfs-actions.pod:4170 ../fish/guestfish-actions.pod:2824
13224 "Remove an LVM logical volume C<device>, where C<device> is the path to the "
13225 "LV, such as C</dev/VG/LV>."
13229 #: ../src/guestfs-actions.pod:4173 ../fish/guestfish-actions.pod:2827
13231 "You can also remove all LVs in a volume group by specifying the VG name, C</"
13236 #: ../src/guestfs-actions.pod:4178 ../src/guestfs-actions.pod:5483
13237 #: ../src/guestfs-actions.pod:7304
13238 msgid "(Added in 1.0.13)"
13242 #: ../src/guestfs-actions.pod:4180
13243 msgid "guestfs_lvrename"
13247 #: ../src/guestfs-actions.pod:4182
13251 " guestfs_lvrename (guestfs_h *g,\n"
13252 " const char *logvol,\n"
13253 " const char *newlogvol);\n"
13258 #: ../src/guestfs-actions.pod:4187 ../fish/guestfish-actions.pod:2834
13259 msgid "Rename a logical volume C<logvol> with the new name C<newlogvol>."
13263 #: ../src/guestfs-actions.pod:4191 ../src/guestfs-actions.pod:7317
13264 msgid "(Added in 1.0.83)"
13268 #: ../src/guestfs-actions.pod:4193
13269 msgid "guestfs_lvresize"
13273 #: ../src/guestfs-actions.pod:4195
13277 " guestfs_lvresize (guestfs_h *g,\n"
13278 " const char *device,\n"
13284 #: ../src/guestfs-actions.pod:4200 ../fish/guestfish-actions.pod:2840
13286 "This resizes (expands or shrinks) an existing LVM logical volume to "
13287 "C<mbytes>. When reducing, data in the reduced part is lost."
13291 #: ../src/guestfs-actions.pod:4208
13292 msgid "guestfs_lvresize_free"
13296 #: ../src/guestfs-actions.pod:4210
13300 " guestfs_lvresize_free (guestfs_h *g,\n"
13301 " const char *lv,\n"
13307 #: ../src/guestfs-actions.pod:4215 ../fish/guestfish-actions.pod:2848
13309 "This expands an existing logical volume C<lv> so that it fills C<pc>% of the "
13310 "remaining free space in the volume group. Commonly you would call this with "
13311 "pc = 100 which expands the logical volume as much as possible, using all "
13312 "remaining free space in the volume group."
13316 #: ../src/guestfs-actions.pod:4223
13317 msgid "(Added in 1.3.3)"
13321 #: ../src/guestfs-actions.pod:4225
13322 msgid "guestfs_lvs"
13326 #: ../src/guestfs-actions.pod:4227
13330 " guestfs_lvs (guestfs_h *g);\n"
13335 #: ../src/guestfs-actions.pod:4230 ../fish/guestfish-actions.pod:2858
13337 "List all the logical volumes detected. This is the equivalent of the L<lvs"
13342 #: ../src/guestfs-actions.pod:4233 ../fish/guestfish-actions.pod:2861
13344 "This returns a list of the logical volume device names (eg. C</dev/"
13345 "VolGroup00/LogVol00>)."
13349 #: ../src/guestfs-actions.pod:4236
13350 msgid "See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>."
13354 #: ../src/guestfs-actions.pod:4244
13355 msgid "guestfs_lvs_full"
13359 #: ../src/guestfs-actions.pod:4246
13362 " struct guestfs_lvm_lv_list *\n"
13363 " guestfs_lvs_full (guestfs_h *g);\n"
13368 #: ../src/guestfs-actions.pod:4249 ../fish/guestfish-actions.pod:2870
13370 "List all the logical volumes detected. This is the equivalent of the L<lvs"
13371 "(8)> command. The \"full\" version includes all fields."
13375 #: ../src/guestfs-actions.pod:4252
13377 "This function returns a C<struct guestfs_lvm_lv_list *>, or NULL if there "
13378 "was an error. I<The caller must call C<guestfs_free_lvm_lv_list> after use>."
13382 #: ../src/guestfs-actions.pod:4258
13383 msgid "guestfs_lvuuid"
13387 #: ../src/guestfs-actions.pod:4260
13391 " guestfs_lvuuid (guestfs_h *g,\n"
13392 " const char *device);\n"
13397 #: ../src/guestfs-actions.pod:4264 ../fish/guestfish-actions.pod:2877
13398 msgid "This command returns the UUID of the LVM LV C<device>."
13402 #: ../src/guestfs-actions.pod:4271
13403 msgid "guestfs_lxattrlist"
13407 #: ../src/guestfs-actions.pod:4273
13410 " struct guestfs_xattr_list *\n"
13411 " guestfs_lxattrlist (guestfs_h *g,\n"
13412 " const char *path,\n"
13413 " char *const *names);\n"
13418 #: ../src/guestfs-actions.pod:4278 ../fish/guestfish-actions.pod:2883
13420 "This call allows you to get the extended attributes of multiple files, where "
13421 "all files are in the directory C<path>. C<names> is the list of files from "
13426 #: ../src/guestfs-actions.pod:4282 ../fish/guestfish-actions.pod:2887
13428 "On return you get a flat list of xattr structs which must be interpreted "
13429 "sequentially. The first xattr struct always has a zero-length C<attrname>. "
13430 "C<attrval> in this struct is zero-length to indicate there was an error "
13431 "doing C<lgetxattr> for this file, I<or> is a C string which is a decimal "
13432 "number (the number of following attributes for this file, which could be C<"
13433 "\"0\">). Then after the first xattr struct are the zero or more attributes "
13434 "for the first named file. This repeats for the second and subsequent files."
13438 #: ../src/guestfs-actions.pod:4292
13440 "This call is intended for programs that want to efficiently list a directory "
13441 "contents without making many round-trips. See also C<guestfs_lstatlist> for "
13442 "a similarly efficient call for getting standard stats. Very long directory "
13443 "listings might cause the protocol message size to be exceeded, causing this "
13444 "call to fail. The caller must split up such requests into smaller groups of "
13449 #: ../src/guestfs-actions.pod:4306
13450 msgid "guestfs_mkdir"
13454 #: ../src/guestfs-actions.pod:4308
13458 " guestfs_mkdir (guestfs_h *g,\n"
13459 " const char *path);\n"
13464 #: ../src/guestfs-actions.pod:4312 ../fish/guestfish-actions.pod:2909
13465 msgid "Create a directory named C<path>."
13469 #: ../src/guestfs-actions.pod:4318
13470 msgid "guestfs_mkdir_mode"
13474 #: ../src/guestfs-actions.pod:4320
13478 " guestfs_mkdir_mode (guestfs_h *g,\n"
13479 " const char *path,\n"
13485 #: ../src/guestfs-actions.pod:4325 ../fish/guestfish-actions.pod:2915
13487 "This command creates a directory, setting the initial permissions of the "
13488 "directory to C<mode>."
13492 #: ../src/guestfs-actions.pod:4328 ../fish/guestfish-actions.pod:2918
13494 "For common Linux filesystems, the actual mode which is set will be C<mode & "
13495 "~umask & 01777>. Non-native-Linux filesystems may interpret the mode in "
13500 #: ../src/guestfs-actions.pod:4332
13501 msgid "See also C<guestfs_mkdir>, C<guestfs_umask>"
13505 #: ../src/guestfs-actions.pod:4338
13506 msgid "guestfs_mkdir_p"
13510 #: ../src/guestfs-actions.pod:4340
13514 " guestfs_mkdir_p (guestfs_h *g,\n"
13515 " const char *path);\n"
13520 #: ../src/guestfs-actions.pod:4344 ../fish/guestfish-actions.pod:2928
13522 "Create a directory named C<path>, creating any parent directories as "
13523 "necessary. This is like the C<mkdir -p> shell command."
13527 #: ../src/guestfs-actions.pod:4351
13528 msgid "guestfs_mkdtemp"
13532 #: ../src/guestfs-actions.pod:4353
13536 " guestfs_mkdtemp (guestfs_h *g,\n"
13537 " const char *template);\n"
13542 #: ../src/guestfs-actions.pod:4357 ../fish/guestfish-actions.pod:2935
13544 "This command creates a temporary directory. The C<template> parameter "
13545 "should be a full pathname for the temporary directory name with the final "
13546 "six characters being \"XXXXXX\"."
13550 #: ../src/guestfs-actions.pod:4362 ../fish/guestfish-actions.pod:2940
13552 "For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\", the second one "
13553 "being suitable for Windows filesystems."
13557 #: ../src/guestfs-actions.pod:4365 ../fish/guestfish-actions.pod:2943
13558 msgid "The name of the temporary directory that was created is returned."
13562 #: ../src/guestfs-actions.pod:4368 ../fish/guestfish-actions.pod:2946
13563 msgid "The temporary directory is created with mode 0700 and is owned by root."
13567 #: ../src/guestfs-actions.pod:4371 ../fish/guestfish-actions.pod:2949
13569 "The caller is responsible for deleting the temporary directory and its "
13570 "contents after use."
13574 #: ../src/guestfs-actions.pod:4374 ../fish/guestfish-actions.pod:2952
13575 msgid "See also: L<mkdtemp(3)>"
13579 #: ../src/guestfs-actions.pod:4381
13580 msgid "guestfs_mke2fs_J"
13584 #: ../src/guestfs-actions.pod:4383
13588 " guestfs_mke2fs_J (guestfs_h *g,\n"
13589 " const char *fstype,\n"
13590 " int blocksize,\n"
13591 " const char *device,\n"
13592 " const char *journal);\n"
13597 #: ../src/guestfs-actions.pod:4390 ../fish/guestfish-actions.pod:2958
13599 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
13600 "C<journal>. It is equivalent to the command:"
13604 #: ../src/guestfs-actions.pod:4394 ../fish/guestfish-actions.pod:2962
13607 " mke2fs -t fstype -b blocksize -J device=<journal> <device>\n"
13612 #: ../src/guestfs-actions.pod:4396
13613 msgid "See also C<guestfs_mke2journal>."
13617 #: ../src/guestfs-actions.pod:4400 ../src/guestfs-actions.pod:4418
13618 #: ../src/guestfs-actions.pod:4436 ../src/guestfs-actions.pod:4452
13619 #: ../src/guestfs-actions.pod:4466 ../src/guestfs-actions.pod:4480
13620 #: ../src/guestfs-actions.pod:4539 ../src/guestfs-actions.pod:4816
13621 msgid "(Added in 1.0.68)"
13625 #: ../src/guestfs-actions.pod:4402
13626 msgid "guestfs_mke2fs_JL"
13630 #: ../src/guestfs-actions.pod:4404
13634 " guestfs_mke2fs_JL (guestfs_h *g,\n"
13635 " const char *fstype,\n"
13636 " int blocksize,\n"
13637 " const char *device,\n"
13638 " const char *label);\n"
13643 #: ../src/guestfs-actions.pod:4411 ../fish/guestfish-actions.pod:2970
13645 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
13646 "the journal labeled C<label>."
13650 #: ../src/guestfs-actions.pod:4414
13651 msgid "See also C<guestfs_mke2journal_L>."
13655 #: ../src/guestfs-actions.pod:4420
13656 msgid "guestfs_mke2fs_JU"
13660 #: ../src/guestfs-actions.pod:4422
13664 " guestfs_mke2fs_JU (guestfs_h *g,\n"
13665 " const char *fstype,\n"
13666 " int blocksize,\n"
13667 " const char *device,\n"
13668 " const char *uuid);\n"
13673 #: ../src/guestfs-actions.pod:4429 ../fish/guestfish-actions.pod:2979
13675 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
13676 "the journal with UUID C<uuid>."
13680 #: ../src/guestfs-actions.pod:4432
13681 msgid "See also C<guestfs_mke2journal_U>."
13685 #: ../src/guestfs-actions.pod:4438
13686 msgid "guestfs_mke2journal"
13690 #: ../src/guestfs-actions.pod:4440
13694 " guestfs_mke2journal (guestfs_h *g,\n"
13695 " int blocksize,\n"
13696 " const char *device);\n"
13701 #: ../src/guestfs-actions.pod:4445 ../fish/guestfish-actions.pod:2988
13703 "This creates an ext2 external journal on C<device>. It is equivalent to the "
13708 #: ../src/guestfs-actions.pod:4448 ../fish/guestfish-actions.pod:2991
13711 " mke2fs -O journal_dev -b blocksize device\n"
13716 #: ../src/guestfs-actions.pod:4454
13717 msgid "guestfs_mke2journal_L"
13721 #: ../src/guestfs-actions.pod:4456
13725 " guestfs_mke2journal_L (guestfs_h *g,\n"
13726 " int blocksize,\n"
13727 " const char *label,\n"
13728 " const char *device);\n"
13733 #: ../src/guestfs-actions.pod:4462 ../fish/guestfish-actions.pod:2997
13734 msgid "This creates an ext2 external journal on C<device> with label C<label>."
13738 #: ../src/guestfs-actions.pod:4468
13739 msgid "guestfs_mke2journal_U"
13743 #: ../src/guestfs-actions.pod:4470
13747 " guestfs_mke2journal_U (guestfs_h *g,\n"
13748 " int blocksize,\n"
13749 " const char *uuid,\n"
13750 " const char *device);\n"
13755 #: ../src/guestfs-actions.pod:4476 ../fish/guestfish-actions.pod:3003
13756 msgid "This creates an ext2 external journal on C<device> with UUID C<uuid>."
13760 #: ../src/guestfs-actions.pod:4482
13761 msgid "guestfs_mkfifo"
13765 #: ../src/guestfs-actions.pod:4484
13769 " guestfs_mkfifo (guestfs_h *g,\n"
13771 " const char *path);\n"
13776 #: ../src/guestfs-actions.pod:4489
13778 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
13779 "is just a convenient wrapper around C<guestfs_mknod>."
13783 #: ../src/guestfs-actions.pod:4499
13784 msgid "guestfs_mkfs"
13788 #: ../src/guestfs-actions.pod:4501
13792 " guestfs_mkfs (guestfs_h *g,\n"
13793 " const char *fstype,\n"
13794 " const char *device);\n"
13799 #: ../src/guestfs-actions.pod:4506 ../fish/guestfish-actions.pod:3019
13801 "This creates a filesystem on C<device> (usually a partition or LVM logical "
13802 "volume). The filesystem type is C<fstype>, for example C<ext3>."
13806 #: ../src/guestfs-actions.pod:4514
13807 msgid "guestfs_mkfs_b"
13811 #: ../src/guestfs-actions.pod:4516
13815 " guestfs_mkfs_b (guestfs_h *g,\n"
13816 " const char *fstype,\n"
13817 " int blocksize,\n"
13818 " const char *device);\n"
13823 #: ../src/guestfs-actions.pod:4522
13825 "This call is similar to C<guestfs_mkfs>, but it allows you to control the "
13826 "block size of the resulting filesystem. Supported block sizes depend on the "
13827 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
13831 #: ../src/guestfs-actions.pod:4527 ../src/guestfs-actions.pod:4572
13832 #: ../fish/guestfish-actions.pod:3032 ../fish/guestfish-actions.pod:3059
13834 "For VFAT and NTFS the C<blocksize> parameter is treated as the requested "
13839 #: ../src/guestfs-actions.pod:4532 ../fish/guestfish-actions.pod:3035
13841 "This function is deprecated. In new code, use the C<mkfs_opts> call instead."
13845 #: ../src/guestfs-actions.pod:4541
13846 msgid "guestfs_mkfs_opts"
13850 #: ../src/guestfs-actions.pod:4543
13854 " guestfs_mkfs_opts (guestfs_h *g,\n"
13855 " const char *fstype,\n"
13856 " const char *device,\n"
13862 #: ../src/guestfs-actions.pod:4554
13865 " GUESTFS_MKFS_OPTS_BLOCKSIZE, int blocksize,\n"
13866 " GUESTFS_MKFS_OPTS_FEATURES, const char *features,\n"
13867 " GUESTFS_MKFS_OPTS_INODE, int inode,\n"
13868 " GUESTFS_MKFS_OPTS_SECTORSIZE, int sectorsize,\n"
13873 #: ../src/guestfs-actions.pod:4559 ../fish/guestfish-actions.pod:3046
13875 "This function creates a filesystem on C<device>. The filesystem type is "
13876 "C<fstype>, for example C<ext3>."
13880 #: ../src/guestfs-actions.pod:4566 ../fish/guestfish-actions.pod:3053
13881 msgid "C<blocksize>"
13885 #: ../src/guestfs-actions.pod:4568 ../fish/guestfish-actions.pod:3055
13887 "The filesystem block size. Supported block sizes depend on the filesystem "
13888 "type, but typically they are C<1024>, C<2048> or C<4096> for Linux ext2/3 "
13893 #: ../src/guestfs-actions.pod:4575 ../fish/guestfish-actions.pod:3062
13894 msgid "For UFS block sizes, please see L<mkfs.ufs(8)>."
13898 #: ../src/guestfs-actions.pod:4577 ../fish/guestfish-actions.pod:3064
13899 msgid "C<features>"
13903 #: ../src/guestfs-actions.pod:4579 ../fish/guestfish-actions.pod:3066
13904 msgid "This passes the I<-O> parameter to the external mkfs program."
13908 #: ../src/guestfs-actions.pod:4581 ../fish/guestfish-actions.pod:3068
13910 "For certain filesystem types, this allows extra filesystem features to be "
13911 "selected. See L<mke2fs(8)> and L<mkfs.ufs(8)> for more details."
13915 #: ../src/guestfs-actions.pod:4585 ../fish/guestfish-actions.pod:3072
13917 "You cannot use this optional parameter with the C<gfs> or C<gfs2> filesystem "
13922 #: ../src/guestfs-actions.pod:4588 ../fish/guestfish-actions.pod:3075
13924 #| msgid "C<inspector>"
13926 msgstr "C<inspector>"
13929 #: ../src/guestfs-actions.pod:4590 ../fish/guestfish-actions.pod:3077
13931 "This passes the I<-I> parameter to the external L<mke2fs(8)> program which "
13932 "sets the inode size (only for ext2/3/4 filesystems at present)."
13936 #: ../src/guestfs-actions.pod:4593 ../fish/guestfish-actions.pod:3080
13938 #| msgid "C<inspector>"
13939 msgid "C<sectorsize>"
13940 msgstr "C<inspector>"
13943 #: ../src/guestfs-actions.pod:4595 ../fish/guestfish-actions.pod:3082
13945 "This passes the I<-S> parameter to external L<mkfs.ufs(8)> program, which "
13946 "sets sector size for ufs filesystem."
13950 #: ../src/guestfs-actions.pod:4602
13951 msgid "(Added in 1.7.19)"
13955 #: ../src/guestfs-actions.pod:4604
13956 msgid "guestfs_mkfs_opts_va"
13960 #: ../src/guestfs-actions.pod:4606
13964 " guestfs_mkfs_opts_va (guestfs_h *g,\n"
13965 " const char *fstype,\n"
13966 " const char *device,\n"
13967 " va_list args);\n"
13972 #: ../src/guestfs-actions.pod:4612
13973 msgid "This is the \"va_list variant\" of L</guestfs_mkfs_opts>."
13977 #: ../src/guestfs-actions.pod:4616
13978 msgid "guestfs_mkfs_opts_argv"
13982 #: ../src/guestfs-actions.pod:4618
13986 " guestfs_mkfs_opts_argv (guestfs_h *g,\n"
13987 " const char *fstype,\n"
13988 " const char *device,\n"
13989 " const struct guestfs_mkfs_opts_argv *optargs);\n"
13994 #: ../src/guestfs-actions.pod:4624
13995 msgid "This is the \"argv variant\" of L</guestfs_mkfs_opts>."
13999 #: ../src/guestfs-actions.pod:4628
14000 msgid "guestfs_mkmountpoint"
14004 #: ../src/guestfs-actions.pod:4630
14008 " guestfs_mkmountpoint (guestfs_h *g,\n"
14009 " const char *exemptpath);\n"
14014 #: ../src/guestfs-actions.pod:4634
14016 "C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are specialized calls "
14017 "that can be used to create extra mountpoints before mounting the first "
14022 #: ../src/guestfs-actions.pod:4638 ../fish/guestfish-actions.pod:3097
14024 "These calls are I<only> necessary in some very limited circumstances, mainly "
14025 "the case where you want to mount a mix of unrelated and/or read-only "
14026 "filesystems together."
14030 #: ../src/guestfs-actions.pod:4642 ../fish/guestfish-actions.pod:3101
14032 "For example, live CDs often contain a \"Russian doll\" nest of filesystems, "
14033 "an ISO outer layer, with a squashfs image inside, with an ext2/3 image "
14034 "inside that. You can unpack this as follows in guestfish:"
14038 #: ../src/guestfs-actions.pod:4647 ../fish/guestfish-actions.pod:3106
14041 " add-ro Fedora-11-i686-Live.iso\n"
14043 " mkmountpoint /cd\n"
14044 " mkmountpoint /sqsh\n"
14045 " mkmountpoint /ext3fs\n"
14046 " mount /dev/sda /cd\n"
14047 " mount-loop /cd/LiveOS/squashfs.img /sqsh\n"
14048 " mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs\n"
14053 #: ../src/guestfs-actions.pod:4656 ../fish/guestfish-actions.pod:3115
14054 msgid "The inner filesystem is now unpacked under the /ext3fs mountpoint."
14058 #: ../src/guestfs-actions.pod:4658
14060 "C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>. You "
14061 "may get unexpected errors if you try to mix these calls. It is safest to "
14062 "manually unmount filesystems and remove mountpoints after use."
14066 #: ../src/guestfs-actions.pod:4662
14068 "C<guestfs_umount_all> unmounts filesystems by sorting the paths longest "
14069 "first, so for this to work for manual mountpoints, you must ensure that the "
14070 "innermost mountpoints have the longest pathnames, as in the example code "
14075 #: ../src/guestfs-actions.pod:4667 ../fish/guestfish-actions.pod:3126
14077 "For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>"
14081 #: ../src/guestfs-actions.pod:4669
14083 "Autosync [see C<guestfs_set_autosync>, this is set by default on handles] "
14084 "can cause C<guestfs_umount_all> to be called when the handle is closed which "
14085 "can also trigger these issues."
14089 #: ../src/guestfs-actions.pod:4675 ../src/guestfs-actions.pod:4991
14090 #: ../src/guestfs-actions.pod:5903
14091 msgid "(Added in 1.0.62)"
14095 #: ../src/guestfs-actions.pod:4677
14096 msgid "guestfs_mknod"
14100 #: ../src/guestfs-actions.pod:4679
14104 " guestfs_mknod (guestfs_h *g,\n"
14108 " const char *path);\n"
14113 #: ../src/guestfs-actions.pod:4686 ../fish/guestfish-actions.pod:3136
14115 "This call creates block or character special devices, or named pipes (FIFOs)."
14119 #: ../src/guestfs-actions.pod:4689 ../fish/guestfish-actions.pod:3139
14121 "The C<mode> parameter should be the mode, using the standard constants. "
14122 "C<devmajor> and C<devminor> are the device major and minor numbers, only "
14123 "used when creating block and character special devices."
14127 #: ../src/guestfs-actions.pod:4694
14129 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
14130 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
14131 "regular file). These constants are available in the standard Linux header "
14132 "files, or you can use C<guestfs_mknod_b>, C<guestfs_mknod_c> or "
14133 "C<guestfs_mkfifo> which are wrappers around this command which bitwise OR in "
14134 "the appropriate constant for you."
14138 #: ../src/guestfs-actions.pod:4708
14139 msgid "guestfs_mknod_b"
14143 #: ../src/guestfs-actions.pod:4710
14147 " guestfs_mknod_b (guestfs_h *g,\n"
14151 " const char *path);\n"
14156 #: ../src/guestfs-actions.pod:4717
14158 "This call creates a block device node called C<path> with mode C<mode> and "
14159 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
14160 "wrapper around C<guestfs_mknod>."
14164 #: ../src/guestfs-actions.pod:4727
14165 msgid "guestfs_mknod_c"
14169 #: ../src/guestfs-actions.pod:4729
14173 " guestfs_mknod_c (guestfs_h *g,\n"
14177 " const char *path);\n"
14182 #: ../src/guestfs-actions.pod:4736
14184 "This call creates a char device node called C<path> with mode C<mode> and "
14185 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
14186 "wrapper around C<guestfs_mknod>."
14190 #: ../src/guestfs-actions.pod:4746
14191 msgid "guestfs_mkswap"
14195 #: ../src/guestfs-actions.pod:4748
14199 " guestfs_mkswap (guestfs_h *g,\n"
14200 " const char *device);\n"
14205 #: ../src/guestfs-actions.pod:4752 ../fish/guestfish-actions.pod:3178
14206 msgid "Create a swap partition on C<device>."
14210 #: ../src/guestfs-actions.pod:4758
14211 msgid "guestfs_mkswap_L"
14215 #: ../src/guestfs-actions.pod:4760
14219 " guestfs_mkswap_L (guestfs_h *g,\n"
14220 " const char *label,\n"
14221 " const char *device);\n"
14226 #: ../src/guestfs-actions.pod:4765 ../fish/guestfish-actions.pod:3184
14227 msgid "Create a swap partition on C<device> with label C<label>."
14231 #: ../src/guestfs-actions.pod:4767 ../fish/guestfish-actions.pod:3186
14233 "Note that you cannot attach a swap label to a block device (eg. C</dev/"
14234 "sda>), just to a partition. This appears to be a limitation of the kernel "
14239 #: ../src/guestfs-actions.pod:4775
14240 msgid "guestfs_mkswap_U"
14244 #: ../src/guestfs-actions.pod:4777
14248 " guestfs_mkswap_U (guestfs_h *g,\n"
14249 " const char *uuid,\n"
14250 " const char *device);\n"
14255 #: ../src/guestfs-actions.pod:4782 ../fish/guestfish-actions.pod:3194
14256 msgid "Create a swap partition on C<device> with UUID C<uuid>."
14260 #: ../src/guestfs-actions.pod:4788
14261 msgid "guestfs_mkswap_file"
14265 #: ../src/guestfs-actions.pod:4790
14269 " guestfs_mkswap_file (guestfs_h *g,\n"
14270 " const char *path);\n"
14275 #: ../src/guestfs-actions.pod:4794 ../fish/guestfish-actions.pod:3200
14276 msgid "Create a swap file."
14280 #: ../src/guestfs-actions.pod:4796
14282 "This command just writes a swap file signature to an existing file. To "
14283 "create the file itself, use something like C<guestfs_fallocate>."
14287 #: ../src/guestfs-actions.pod:4803
14288 msgid "guestfs_modprobe"
14292 #: ../src/guestfs-actions.pod:4805
14296 " guestfs_modprobe (guestfs_h *g,\n"
14297 " const char *modulename);\n"
14302 #: ../src/guestfs-actions.pod:4809 ../fish/guestfish-actions.pod:3209
14303 msgid "This loads a kernel module in the appliance."
14307 #: ../src/guestfs-actions.pod:4811 ../fish/guestfish-actions.pod:3211
14309 "The kernel module must have been whitelisted when libguestfs was built (see "
14310 "C<appliance/kmod.whitelist.in> in the source)."
14314 #: ../src/guestfs-actions.pod:4818
14315 msgid "guestfs_mount"
14319 #: ../src/guestfs-actions.pod:4820
14323 " guestfs_mount (guestfs_h *g,\n"
14324 " const char *device,\n"
14325 " const char *mountpoint);\n"
14330 #: ../src/guestfs-actions.pod:4825 ../fish/guestfish-actions.pod:3218
14332 "Mount a guest disk at a position in the filesystem. Block devices are named "
14333 "C</dev/sda>, C</dev/sdb> and so on, as they were added to the guest. If "
14334 "those block devices contain partitions, they will have the usual names (eg. "
14335 "C</dev/sda1>). Also LVM C</dev/VG/LV>-style names can be used."
14339 #: ../src/guestfs-actions.pod:4831 ../fish/guestfish-actions.pod:3224
14341 "The rules are the same as for L<mount(2)>: A filesystem must first be "
14342 "mounted on C</> before others can be mounted. Other filesystems can only be "
14343 "mounted on directories which already exist."
14347 #: ../src/guestfs-actions.pod:4836 ../fish/guestfish-actions.pod:3229
14349 "The mounted filesystem is writable, if we have sufficient permissions on the "
14350 "underlying device."
14354 #: ../src/guestfs-actions.pod:4839
14356 "B<Important note:> When you use this call, the filesystem options C<sync> "
14357 "and C<noatime> are set implicitly. This was originally done because we "
14358 "thought it would improve reliability, but it turns out that I<-o sync> has a "
14359 "very large negative performance impact and negligible effect on "
14360 "reliability. Therefore we recommend that you avoid using C<guestfs_mount> "
14361 "in any code that needs performance, and instead use C<guestfs_mount_options> "
14362 "(use an empty string for the first parameter if you don't want any options)."
14366 #: ../src/guestfs-actions.pod:4851 ../fish/guestfish-actions.pod:3242
14368 "This function is deprecated. In new code, use the C<mount_options> call "
14373 #: ../src/guestfs-actions.pod:4860
14374 msgid "guestfs_mount_9p"
14378 #: ../src/guestfs-actions.pod:4862
14382 " guestfs_mount_9p (guestfs_h *g,\n"
14383 " const char *mounttag,\n"
14384 " const char *mountpoint,\n"
14390 #: ../src/guestfs-actions.pod:4873
14393 " GUESTFS_MOUNT_9P_OPTIONS, const char *options,\n"
14398 #: ../src/guestfs-actions.pod:4875 ../fish/guestfish-actions.pod:3253
14400 "Mount the virtio-9p filesystem with the tag C<mounttag> on the directory "
14405 #: ../src/guestfs-actions.pod:4878 ../fish/guestfish-actions.pod:3256
14407 "If required, C<trans=virtio> will be automatically added to the options. "
14408 "Any other options required can be passed in the optional C<options> "
14413 #: ../src/guestfs-actions.pod:4886
14414 msgid "guestfs_mount_9p_va"
14418 #: ../src/guestfs-actions.pod:4888
14422 " guestfs_mount_9p_va (guestfs_h *g,\n"
14423 " const char *mounttag,\n"
14424 " const char *mountpoint,\n"
14425 " va_list args);\n"
14430 #: ../src/guestfs-actions.pod:4894
14431 msgid "This is the \"va_list variant\" of L</guestfs_mount_9p>."
14435 #: ../src/guestfs-actions.pod:4898
14436 msgid "guestfs_mount_9p_argv"
14440 #: ../src/guestfs-actions.pod:4900
14444 " guestfs_mount_9p_argv (guestfs_h *g,\n"
14445 " const char *mounttag,\n"
14446 " const char *mountpoint,\n"
14447 " const struct guestfs_mount_9p_argv *optargs);\n"
14452 #: ../src/guestfs-actions.pod:4906
14453 msgid "This is the \"argv variant\" of L</guestfs_mount_9p>."
14457 #: ../src/guestfs-actions.pod:4910
14458 msgid "guestfs_mount_loop"
14462 #: ../src/guestfs-actions.pod:4912
14466 " guestfs_mount_loop (guestfs_h *g,\n"
14467 " const char *file,\n"
14468 " const char *mountpoint);\n"
14473 #: ../src/guestfs-actions.pod:4917 ../fish/guestfish-actions.pod:3266
14475 "This command lets you mount C<file> (a filesystem image in a file) on a "
14476 "mount point. It is entirely equivalent to the command C<mount -o loop file "
14481 #: ../src/guestfs-actions.pod:4925
14482 msgid "guestfs_mount_options"
14486 #: ../src/guestfs-actions.pod:4927
14490 " guestfs_mount_options (guestfs_h *g,\n"
14491 " const char *options,\n"
14492 " const char *device,\n"
14493 " const char *mountpoint);\n"
14498 #: ../src/guestfs-actions.pod:4933
14500 "This is the same as the C<guestfs_mount> command, but it allows you to set "
14501 "the mount options as for the L<mount(8)> I<-o> flag."
14505 #: ../src/guestfs-actions.pod:4937 ../fish/guestfish-actions.pod:3278
14507 "If the C<options> parameter is an empty string, then no options are passed "
14508 "(all options default to whatever the filesystem uses)."
14512 #: ../src/guestfs-actions.pod:4943 ../src/guestfs-actions.pod:4957
14513 #: ../src/guestfs-actions.pod:4974
14514 msgid "(Added in 1.0.10)"
14518 #: ../src/guestfs-actions.pod:4945
14519 msgid "guestfs_mount_ro"
14523 #: ../src/guestfs-actions.pod:4947
14527 " guestfs_mount_ro (guestfs_h *g,\n"
14528 " const char *device,\n"
14529 " const char *mountpoint);\n"
14534 #: ../src/guestfs-actions.pod:4952
14536 "This is the same as the C<guestfs_mount> command, but it mounts the "
14537 "filesystem with the read-only (I<-o ro>) flag."
14541 #: ../src/guestfs-actions.pod:4959
14542 msgid "guestfs_mount_vfs"
14546 #: ../src/guestfs-actions.pod:4961
14550 " guestfs_mount_vfs (guestfs_h *g,\n"
14551 " const char *options,\n"
14552 " const char *vfstype,\n"
14553 " const char *device,\n"
14554 " const char *mountpoint);\n"
14559 #: ../src/guestfs-actions.pod:4968
14561 "This is the same as the C<guestfs_mount> command, but it allows you to set "
14562 "both the mount options and the vfstype as for the L<mount(8)> I<-o> and I<-"
14567 #: ../src/guestfs-actions.pod:4976
14568 msgid "guestfs_mountpoints"
14572 #: ../src/guestfs-actions.pod:4978
14576 " guestfs_mountpoints (guestfs_h *g);\n"
14581 #: ../src/guestfs-actions.pod:4981
14583 "This call is similar to C<guestfs_mounts>. That call returns a list of "
14584 "devices. This one returns a hash table (map) of device name to directory "
14585 "where the device is mounted."
14589 #: ../src/guestfs-actions.pod:4993
14590 msgid "guestfs_mounts"
14594 #: ../src/guestfs-actions.pod:4995
14598 " guestfs_mounts (guestfs_h *g);\n"
14603 #: ../src/guestfs-actions.pod:4998 ../fish/guestfish-actions.pod:3309
14605 "This returns the list of currently mounted filesystems. It returns the list "
14606 "of devices (eg. C</dev/sda1>, C</dev/VG/LV>)."
14610 #: ../src/guestfs-actions.pod:5001 ../fish/guestfish-actions.pod:3312
14611 msgid "Some internal mounts are not shown."
14615 #: ../src/guestfs-actions.pod:5003
14616 msgid "See also: C<guestfs_mountpoints>"
14620 #: ../src/guestfs-actions.pod:5011
14625 #: ../src/guestfs-actions.pod:5013
14629 " guestfs_mv (guestfs_h *g,\n"
14630 " const char *src,\n"
14631 " const char *dest);\n"
14636 #: ../src/guestfs-actions.pod:5018 ../fish/guestfish-actions.pod:3320
14638 "This moves a file from C<src> to C<dest> where C<dest> is either a "
14639 "destination filename or destination directory."
14643 #: ../src/guestfs-actions.pod:5025
14644 msgid "guestfs_ntfs_3g_probe"
14648 #: ../src/guestfs-actions.pod:5027
14652 " guestfs_ntfs_3g_probe (guestfs_h *g,\n"
14654 " const char *device);\n"
14659 #: ../src/guestfs-actions.pod:5032 ../fish/guestfish-actions.pod:3327
14661 "This command runs the L<ntfs-3g.probe(8)> command which probes an NTFS "
14662 "C<device> for mountability. (Not all NTFS volumes can be mounted read-"
14663 "write, and some cannot be mounted at all)."
14667 #: ../src/guestfs-actions.pod:5036 ../fish/guestfish-actions.pod:3331
14669 "C<rw> is a boolean flag. Set it to true if you want to test if the volume "
14670 "can be mounted read-write. Set it to false if you want to test if the "
14671 "volume can be mounted read-only."
14675 #: ../src/guestfs-actions.pod:5040 ../fish/guestfish-actions.pod:3335
14677 "The return value is an integer which C<0> if the operation would succeed, or "
14678 "some non-zero value documented in the L<ntfs-3g.probe(8)> manual page."
14682 #: ../src/guestfs-actions.pod:5046
14683 msgid "(Added in 1.0.43)"
14687 #: ../src/guestfs-actions.pod:5048
14688 msgid "guestfs_ntfsresize"
14692 #: ../src/guestfs-actions.pod:5050
14696 " guestfs_ntfsresize (guestfs_h *g,\n"
14697 " const char *device);\n"
14702 #: ../src/guestfs-actions.pod:5054 ../fish/guestfish-actions.pod:3343
14704 "This command resizes an NTFS filesystem, expanding or shrinking it to the "
14705 "size of the underlying device. See also L<ntfsresize(8)>."
14709 #: ../src/guestfs-actions.pod:5062
14710 msgid "guestfs_ntfsresize_size"
14714 #: ../src/guestfs-actions.pod:5064
14718 " guestfs_ntfsresize_size (guestfs_h *g,\n"
14719 " const char *device,\n"
14720 " int64_t size);\n"
14725 #: ../src/guestfs-actions.pod:5069
14727 "This command is the same as C<guestfs_ntfsresize> except that it allows you "
14728 "to specify the new size (in bytes) explicitly."
14732 #: ../src/guestfs-actions.pod:5074 ../src/guestfs-actions.pod:5510
14733 #: ../src/guestfs-actions.pod:5583 ../src/guestfs-actions.pod:5851
14734 #: ../src/guestfs-actions.pod:7459
14735 msgid "(Added in 1.3.14)"
14739 #: ../src/guestfs-actions.pod:5076
14740 msgid "guestfs_part_add"
14744 #: ../src/guestfs-actions.pod:5078
14748 " guestfs_part_add (guestfs_h *g,\n"
14749 " const char *device,\n"
14750 " const char *prlogex,\n"
14751 " int64_t startsect,\n"
14752 " int64_t endsect);\n"
14757 #: ../src/guestfs-actions.pod:5085
14759 "This command adds a partition to C<device>. If there is no partition table "
14760 "on the device, call C<guestfs_part_init> first."
14764 #: ../src/guestfs-actions.pod:5088 ../fish/guestfish-actions.pod:3361
14766 "The C<prlogex> parameter is the type of partition. Normally you should pass "
14767 "C<p> or C<primary> here, but MBR partition tables also support C<l> (or "
14768 "C<logical>) and C<e> (or C<extended>) partition types."
14772 #: ../src/guestfs-actions.pod:5093 ../fish/guestfish-actions.pod:3366
14774 "C<startsect> and C<endsect> are the start and end of the partition in "
14775 "I<sectors>. C<endsect> may be negative, which means it counts backwards "
14776 "from the end of the disk (C<-1> is the last sector)."
14780 #: ../src/guestfs-actions.pod:5097
14782 "Creating a partition which covers the whole disk is not so easy. Use "
14783 "C<guestfs_part_disk> to do that."
14787 #: ../src/guestfs-actions.pod:5102 ../src/guestfs-actions.pod:5140
14788 #: ../src/guestfs-actions.pod:5193 ../src/guestfs-actions.pod:5271
14789 #: ../src/guestfs-actions.pod:5309 ../src/guestfs-actions.pod:5328
14790 #: ../src/guestfs-actions.pod:5368
14791 msgid "(Added in 1.0.78)"
14795 #: ../src/guestfs-actions.pod:5104
14796 msgid "guestfs_part_del"
14800 #: ../src/guestfs-actions.pod:5106
14804 " guestfs_part_del (guestfs_h *g,\n"
14805 " const char *device,\n"
14811 #: ../src/guestfs-actions.pod:5111 ../fish/guestfish-actions.pod:3377
14812 msgid "This command deletes the partition numbered C<partnum> on C<device>."
14816 #: ../src/guestfs-actions.pod:5113 ../fish/guestfish-actions.pod:3379
14818 "Note that in the case of MBR partitioning, deleting an extended partition "
14819 "also deletes any logical partitions it contains."
14823 #: ../src/guestfs-actions.pod:5121
14824 msgid "guestfs_part_disk"
14828 #: ../src/guestfs-actions.pod:5123
14832 " guestfs_part_disk (guestfs_h *g,\n"
14833 " const char *device,\n"
14834 " const char *parttype);\n"
14839 #: ../src/guestfs-actions.pod:5128
14841 "This command is simply a combination of C<guestfs_part_init> followed by "
14842 "C<guestfs_part_add> to create a single primary partition covering the whole "
14847 #: ../src/guestfs-actions.pod:5132
14849 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
14850 "possible values are described in C<guestfs_part_init>."
14854 #: ../src/guestfs-actions.pod:5142
14855 msgid "guestfs_part_get_bootable"
14859 #: ../src/guestfs-actions.pod:5144
14863 " guestfs_part_get_bootable (guestfs_h *g,\n"
14864 " const char *device,\n"
14870 #: ../src/guestfs-actions.pod:5149 ../fish/guestfish-actions.pod:3401
14872 "This command returns true if the partition C<partnum> on C<device> has the "
14873 "bootable flag set."
14877 #: ../src/guestfs-actions.pod:5152
14878 msgid "See also C<guestfs_part_set_bootable>."
14882 #: ../src/guestfs-actions.pod:5158
14883 msgid "guestfs_part_get_mbr_id"
14887 #: ../src/guestfs-actions.pod:5160
14891 " guestfs_part_get_mbr_id (guestfs_h *g,\n"
14892 " const char *device,\n"
14898 #: ../src/guestfs-actions.pod:5165 ../fish/guestfish-actions.pod:3410
14900 "Returns the MBR type byte (also known as the ID byte) from the numbered "
14901 "partition C<partnum>."
14905 #: ../src/guestfs-actions.pod:5168 ../src/guestfs-actions.pod:5344
14907 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
14908 "undefined results for other partition table types (see "
14909 "C<guestfs_part_get_parttype>)."
14913 #: ../src/guestfs-actions.pod:5176
14914 msgid "guestfs_part_get_parttype"
14918 #: ../src/guestfs-actions.pod:5178
14922 " guestfs_part_get_parttype (guestfs_h *g,\n"
14923 " const char *device);\n"
14928 #: ../src/guestfs-actions.pod:5182 ../fish/guestfish-actions.pod:3421
14930 "This command examines the partition table on C<device> and returns the "
14931 "partition table type (format) being used."
14935 #: ../src/guestfs-actions.pod:5185
14937 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
14938 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
14939 "possible, although unusual. See C<guestfs_part_init> for a full list."
14943 #: ../src/guestfs-actions.pod:5195
14944 msgid "guestfs_part_init"
14948 #: ../src/guestfs-actions.pod:5197
14952 " guestfs_part_init (guestfs_h *g,\n"
14953 " const char *device,\n"
14954 " const char *parttype);\n"
14959 #: ../src/guestfs-actions.pod:5202 ../fish/guestfish-actions.pod:3433
14961 "This creates an empty partition table on C<device> of one of the partition "
14962 "types listed below. Usually C<parttype> should be either C<msdos> or C<gpt> "
14963 "(for large disks)."
14967 #: ../src/guestfs-actions.pod:5206
14969 "Initially there are no partitions. Following this, you should call "
14970 "C<guestfs_part_add> for each partition required."
14974 #: ../src/guestfs-actions.pod:5209 ../fish/guestfish-actions.pod:3440
14975 msgid "Possible values for C<parttype> are:"
14979 #: ../src/guestfs-actions.pod:5213 ../fish/guestfish-actions.pod:3444
14980 msgid "B<efi> | B<gpt>"
14984 #: ../src/guestfs-actions.pod:5215 ../fish/guestfish-actions.pod:3446
14985 msgid "Intel EFI / GPT partition table."
14989 #: ../src/guestfs-actions.pod:5217 ../fish/guestfish-actions.pod:3448
14991 "This is recommended for >= 2 TB partitions that will be accessed from Linux "
14992 "and Intel-based Mac OS X. It also has limited backwards compatibility with "
14993 "the C<mbr> format."
14997 #: ../src/guestfs-actions.pod:5221 ../fish/guestfish-actions.pod:3452
14998 msgid "B<mbr> | B<msdos>"
15002 #: ../src/guestfs-actions.pod:5223 ../fish/guestfish-actions.pod:3454
15004 "The standard PC \"Master Boot Record\" (MBR) format used by MS-DOS and "
15005 "Windows. This partition type will B<only> work for device sizes up to 2 "
15006 "TB. For large disks we recommend using C<gpt>."
15010 #: ../src/guestfs-actions.pod:5230 ../fish/guestfish-actions.pod:3461
15012 "Other partition table types that may work but are not supported include:"
15016 #: ../src/guestfs-actions.pod:5235 ../fish/guestfish-actions.pod:3466
15021 #: ../src/guestfs-actions.pod:5237 ../fish/guestfish-actions.pod:3468
15022 msgid "AIX disk labels."
15026 #: ../src/guestfs-actions.pod:5239 ../fish/guestfish-actions.pod:3470
15027 msgid "B<amiga> | B<rdb>"
15031 #: ../src/guestfs-actions.pod:5241 ../fish/guestfish-actions.pod:3472
15032 msgid "Amiga \"Rigid Disk Block\" format."
15036 #: ../src/guestfs-actions.pod:5243 ../fish/guestfish-actions.pod:3474
15041 #: ../src/guestfs-actions.pod:5245 ../fish/guestfish-actions.pod:3476
15042 msgid "BSD disk labels."
15046 #: ../src/guestfs-actions.pod:5247 ../fish/guestfish-actions.pod:3478
15051 #: ../src/guestfs-actions.pod:5249 ../fish/guestfish-actions.pod:3480
15052 msgid "DASD, used on IBM mainframes."
15056 #: ../src/guestfs-actions.pod:5251 ../fish/guestfish-actions.pod:3482
15061 #: ../src/guestfs-actions.pod:5253 ../fish/guestfish-actions.pod:3484
15062 msgid "MIPS/SGI volumes."
15066 #: ../src/guestfs-actions.pod:5255 ../fish/guestfish-actions.pod:3486
15071 #: ../src/guestfs-actions.pod:5257 ../fish/guestfish-actions.pod:3488
15072 msgid "Old Mac partition format. Modern Macs use C<gpt>."
15076 #: ../src/guestfs-actions.pod:5259 ../fish/guestfish-actions.pod:3490
15081 #: ../src/guestfs-actions.pod:5261 ../fish/guestfish-actions.pod:3492
15082 msgid "NEC PC-98 format, common in Japan apparently."
15086 #: ../src/guestfs-actions.pod:5263 ../fish/guestfish-actions.pod:3494
15091 #: ../src/guestfs-actions.pod:5265 ../fish/guestfish-actions.pod:3496
15092 msgid "Sun disk labels."
15096 #: ../src/guestfs-actions.pod:5273
15097 msgid "guestfs_part_list"
15101 #: ../src/guestfs-actions.pod:5275
15104 " struct guestfs_partition_list *\n"
15105 " guestfs_part_list (guestfs_h *g,\n"
15106 " const char *device);\n"
15111 #: ../src/guestfs-actions.pod:5279 ../fish/guestfish-actions.pod:3504
15113 "This command parses the partition table on C<device> and returns the list of "
15114 "partitions found."
15118 #: ../src/guestfs-actions.pod:5282 ../fish/guestfish-actions.pod:3507
15119 msgid "The fields in the returned structure are:"
15123 #: ../src/guestfs-actions.pod:5286 ../fish/guestfish-actions.pod:3511
15124 msgid "B<part_num>"
15128 #: ../src/guestfs-actions.pod:5288 ../fish/guestfish-actions.pod:3513
15129 msgid "Partition number, counting from 1."
15133 #: ../src/guestfs-actions.pod:5290 ../fish/guestfish-actions.pod:3515
15134 msgid "B<part_start>"
15138 #: ../src/guestfs-actions.pod:5292
15140 "Start of the partition I<in bytes>. To get sectors you have to divide by "
15141 "the device's sector size, see C<guestfs_blockdev_getss>."
15145 #: ../src/guestfs-actions.pod:5295 ../fish/guestfish-actions.pod:3520
15146 msgid "B<part_end>"
15150 #: ../src/guestfs-actions.pod:5297 ../fish/guestfish-actions.pod:3522
15151 msgid "End of the partition in bytes."
15155 #: ../src/guestfs-actions.pod:5299 ../fish/guestfish-actions.pod:3524
15156 msgid "B<part_size>"
15160 #: ../src/guestfs-actions.pod:5301 ../fish/guestfish-actions.pod:3526
15161 msgid "Size of the partition in bytes."
15165 #: ../src/guestfs-actions.pod:5305
15167 "This function returns a C<struct guestfs_partition_list *>, or NULL if there "
15168 "was an error. I<The caller must call C<guestfs_free_partition_list> after "
15173 #: ../src/guestfs-actions.pod:5311
15174 msgid "guestfs_part_set_bootable"
15178 #: ../src/guestfs-actions.pod:5313
15182 " guestfs_part_set_bootable (guestfs_h *g,\n"
15183 " const char *device,\n"
15185 " int bootable);\n"
15190 #: ../src/guestfs-actions.pod:5319 ../fish/guestfish-actions.pod:3534
15192 "This sets the bootable flag on partition numbered C<partnum> on device "
15193 "C<device>. Note that partitions are numbered from 1."
15197 #: ../src/guestfs-actions.pod:5322 ../fish/guestfish-actions.pod:3537
15199 "The bootable flag is used by some operating systems (notably Windows) to "
15200 "determine which partition to boot from. It is by no means universally "
15205 #: ../src/guestfs-actions.pod:5330
15206 msgid "guestfs_part_set_mbr_id"
15210 #: ../src/guestfs-actions.pod:5332
15214 " guestfs_part_set_mbr_id (guestfs_h *g,\n"
15215 " const char *device,\n"
15222 #: ../src/guestfs-actions.pod:5338 ../fish/guestfish-actions.pod:3545
15224 "Sets the MBR type byte (also known as the ID byte) of the numbered partition "
15225 "C<partnum> to C<idbyte>. Note that the type bytes quoted in most "
15226 "documentation are in fact hexadecimal numbers, but usually documented "
15227 "without any leading \"0x\" which might be confusing."
15231 #: ../src/guestfs-actions.pod:5352
15232 msgid "guestfs_part_set_name"
15236 #: ../src/guestfs-actions.pod:5354
15240 " guestfs_part_set_name (guestfs_h *g,\n"
15241 " const char *device,\n"
15243 " const char *name);\n"
15248 #: ../src/guestfs-actions.pod:5360 ../fish/guestfish-actions.pod:3559
15250 "This sets the partition name on partition numbered C<partnum> on device "
15251 "C<device>. Note that partitions are numbered from 1."
15255 #: ../src/guestfs-actions.pod:5363 ../fish/guestfish-actions.pod:3562
15257 "The partition name can only be set on certain types of partition table. "
15258 "This works on C<gpt> but not on C<mbr> partitions."
15262 #: ../src/guestfs-actions.pod:5370
15263 msgid "guestfs_part_to_dev"
15267 #: ../src/guestfs-actions.pod:5372
15271 " guestfs_part_to_dev (guestfs_h *g,\n"
15272 " const char *partition);\n"
15277 #: ../src/guestfs-actions.pod:5376 ../fish/guestfish-actions.pod:3569
15279 "This function takes a partition name (eg. \"/dev/sdb1\") and removes the "
15280 "partition number, returning the device name (eg. \"/dev/sdb\")."
15284 #: ../src/guestfs-actions.pod:5380
15286 "The named partition must exist, for example as a string returned from "
15287 "C<guestfs_list_partitions>."
15291 #: ../src/guestfs-actions.pod:5388
15292 msgid "guestfs_ping_daemon"
15296 #: ../src/guestfs-actions.pod:5390
15300 " guestfs_ping_daemon (guestfs_h *g);\n"
15305 #: ../src/guestfs-actions.pod:5393 ../fish/guestfish-actions.pod:3580
15307 "This is a test probe into the guestfs daemon running inside the qemu "
15308 "subprocess. Calling this function checks that the daemon responds to the "
15309 "ping message, without affecting the daemon or attached block device(s) in "
15314 #: ../src/guestfs-actions.pod:5402
15315 msgid "guestfs_pread"
15319 #: ../src/guestfs-actions.pod:5404
15323 " guestfs_pread (guestfs_h *g,\n"
15324 " const char *path,\n"
15326 " int64_t offset,\n"
15327 " size_t *size_r);\n"
15332 #: ../src/guestfs-actions.pod:5411 ../fish/guestfish-actions.pod:3589
15334 "This command lets you read part of a file. It reads C<count> bytes of the "
15335 "file, starting at C<offset>, from file C<path>."
15339 #: ../src/guestfs-actions.pod:5414 ../src/guestfs-actions.pod:5440
15340 #: ../fish/guestfish-actions.pod:3592 ../fish/guestfish-actions.pod:3607
15342 "This may read fewer bytes than requested. For further details see the "
15343 "L<pread(2)> system call."
15347 #: ../src/guestfs-actions.pod:5417
15348 msgid "See also C<guestfs_pwrite>, C<guestfs_pread_device>."
15352 #: ../src/guestfs-actions.pod:5428
15353 msgid "guestfs_pread_device"
15357 #: ../src/guestfs-actions.pod:5430
15361 " guestfs_pread_device (guestfs_h *g,\n"
15362 " const char *device,\n"
15364 " int64_t offset,\n"
15365 " size_t *size_r);\n"
15370 #: ../src/guestfs-actions.pod:5437 ../fish/guestfish-actions.pod:3604
15372 "This command lets you read part of a file. It reads C<count> bytes of "
15373 "C<device>, starting at C<offset>."
15377 #: ../src/guestfs-actions.pod:5443
15378 msgid "See also C<guestfs_pread>."
15382 #: ../src/guestfs-actions.pod:5452
15383 msgid "(Added in 1.5.21)"
15387 #: ../src/guestfs-actions.pod:5454
15388 msgid "guestfs_pvcreate"
15392 #: ../src/guestfs-actions.pod:5456
15396 " guestfs_pvcreate (guestfs_h *g,\n"
15397 " const char *device);\n"
15402 #: ../src/guestfs-actions.pod:5460 ../fish/guestfish-actions.pod:3619
15404 "This creates an LVM physical volume on the named C<device>, where C<device> "
15405 "should usually be a partition name such as C</dev/sda1>."
15409 #: ../src/guestfs-actions.pod:5468
15410 msgid "guestfs_pvremove"
15414 #: ../src/guestfs-actions.pod:5470
15418 " guestfs_pvremove (guestfs_h *g,\n"
15419 " const char *device);\n"
15424 #: ../src/guestfs-actions.pod:5474 ../fish/guestfish-actions.pod:3627
15426 "This wipes a physical volume C<device> so that LVM will no longer recognise "
15431 #: ../src/guestfs-actions.pod:5477 ../fish/guestfish-actions.pod:3630
15433 "The implementation uses the C<pvremove> command which refuses to wipe "
15434 "physical volumes that contain any volume groups, so you have to remove those "
15439 #: ../src/guestfs-actions.pod:5485
15440 msgid "guestfs_pvresize"
15444 #: ../src/guestfs-actions.pod:5487
15448 " guestfs_pvresize (guestfs_h *g,\n"
15449 " const char *device);\n"
15454 #: ../src/guestfs-actions.pod:5491 ../fish/guestfish-actions.pod:3638
15456 "This resizes (expands or shrinks) an existing LVM physical volume to match "
15457 "the new size of the underlying device."
15461 #: ../src/guestfs-actions.pod:5498
15462 msgid "guestfs_pvresize_size"
15466 #: ../src/guestfs-actions.pod:5500
15470 " guestfs_pvresize_size (guestfs_h *g,\n"
15471 " const char *device,\n"
15472 " int64_t size);\n"
15477 #: ../src/guestfs-actions.pod:5505
15479 "This command is the same as C<guestfs_pvresize> except that it allows you to "
15480 "specify the new size (in bytes) explicitly."
15484 #: ../src/guestfs-actions.pod:5512
15485 msgid "guestfs_pvs"
15489 #: ../src/guestfs-actions.pod:5514
15493 " guestfs_pvs (guestfs_h *g);\n"
15498 #: ../src/guestfs-actions.pod:5517 ../fish/guestfish-actions.pod:3652
15500 "List all the physical volumes detected. This is the equivalent of the L<pvs"
15505 #: ../src/guestfs-actions.pod:5520 ../fish/guestfish-actions.pod:3655
15507 "This returns a list of just the device names that contain PVs (eg. C</dev/"
15512 #: ../src/guestfs-actions.pod:5523
15513 msgid "See also C<guestfs_pvs_full>."
15517 #: ../src/guestfs-actions.pod:5531
15518 msgid "guestfs_pvs_full"
15522 #: ../src/guestfs-actions.pod:5533
15525 " struct guestfs_lvm_pv_list *\n"
15526 " guestfs_pvs_full (guestfs_h *g);\n"
15531 #: ../src/guestfs-actions.pod:5536 ../fish/guestfish-actions.pod:3664
15533 "List all the physical volumes detected. This is the equivalent of the L<pvs"
15534 "(8)> command. The \"full\" version includes all fields."
15538 #: ../src/guestfs-actions.pod:5539
15540 "This function returns a C<struct guestfs_lvm_pv_list *>, or NULL if there "
15541 "was an error. I<The caller must call C<guestfs_free_lvm_pv_list> after use>."
15545 #: ../src/guestfs-actions.pod:5545
15546 msgid "guestfs_pvuuid"
15550 #: ../src/guestfs-actions.pod:5547
15554 " guestfs_pvuuid (guestfs_h *g,\n"
15555 " const char *device);\n"
15560 #: ../src/guestfs-actions.pod:5551 ../fish/guestfish-actions.pod:3671
15561 msgid "This command returns the UUID of the LVM PV C<device>."
15565 #: ../src/guestfs-actions.pod:5558
15566 msgid "guestfs_pwrite"
15570 #: ../src/guestfs-actions.pod:5560
15574 " guestfs_pwrite (guestfs_h *g,\n"
15575 " const char *path,\n"
15576 " const char *content,\n"
15577 " size_t content_size,\n"
15578 " int64_t offset);\n"
15583 #: ../src/guestfs-actions.pod:5567 ../fish/guestfish-actions.pod:3677
15585 "This command writes to part of a file. It writes the data buffer C<content> "
15586 "to the file C<path> starting at offset C<offset>."
15590 #: ../src/guestfs-actions.pod:5570 ../fish/guestfish-actions.pod:3680
15592 "This command implements the L<pwrite(2)> system call, and like that system "
15593 "call it may not write the full data requested. The return value is the "
15594 "number of bytes that were actually written to the file. This could even be "
15595 "0, although short writes are unlikely for regular files in ordinary "
15600 #: ../src/guestfs-actions.pod:5576
15601 msgid "See also C<guestfs_pread>, C<guestfs_pwrite_device>."
15605 #: ../src/guestfs-actions.pod:5585
15606 msgid "guestfs_pwrite_device"
15610 #: ../src/guestfs-actions.pod:5587
15614 " guestfs_pwrite_device (guestfs_h *g,\n"
15615 " const char *device,\n"
15616 " const char *content,\n"
15617 " size_t content_size,\n"
15618 " int64_t offset);\n"
15623 #: ../src/guestfs-actions.pod:5594 ../fish/guestfish-actions.pod:3695
15625 "This command writes to part of a device. It writes the data buffer "
15626 "C<content> to C<device> starting at offset C<offset>."
15630 #: ../src/guestfs-actions.pod:5597 ../fish/guestfish-actions.pod:3698
15632 "This command implements the L<pwrite(2)> system call, and like that system "
15633 "call it may not write the full data requested (although short writes to disk "
15634 "devices and partitions are probably impossible with standard Linux kernels)."
15638 #: ../src/guestfs-actions.pod:5602
15639 msgid "See also C<guestfs_pwrite>."
15643 #: ../src/guestfs-actions.pod:5609
15644 msgid "(Added in 1.5.20)"
15648 #: ../src/guestfs-actions.pod:5611
15649 msgid "guestfs_read_file"
15653 #: ../src/guestfs-actions.pod:5613
15657 " guestfs_read_file (guestfs_h *g,\n"
15658 " const char *path,\n"
15659 " size_t *size_r);\n"
15664 #: ../src/guestfs-actions.pod:5618 ../fish/guestfish-actions.pod:3712
15665 msgid "This calls returns the contents of the file C<path> as a buffer."
15669 #: ../src/guestfs-actions.pod:5621
15671 "Unlike C<guestfs_cat>, this function can correctly handle files that contain "
15672 "embedded ASCII NUL characters. However unlike C<guestfs_download>, this "
15673 "function is limited in the total size of file that can be handled."
15677 #: ../src/guestfs-actions.pod:5633
15678 msgid "(Added in 1.0.63)"
15682 #: ../src/guestfs-actions.pod:5635
15683 msgid "guestfs_read_lines"
15687 #: ../src/guestfs-actions.pod:5637
15691 " guestfs_read_lines (guestfs_h *g,\n"
15692 " const char *path);\n"
15697 #: ../src/guestfs-actions.pod:5643 ../fish/guestfish-actions.pod:3729
15699 "The file contents are returned as a list of lines. Trailing C<LF> and "
15700 "C<CRLF> character sequences are I<not> returned."
15704 #: ../src/guestfs-actions.pod:5646
15706 "Note that this function cannot correctly handle binary files (specifically, "
15707 "files containing C<\\0> character which is treated as end of line). For "
15708 "those you need to use the C<guestfs_read_file> function which has a more "
15709 "complex interface."
15713 #: ../src/guestfs-actions.pod:5657
15714 msgid "guestfs_readdir"
15718 #: ../src/guestfs-actions.pod:5659
15721 " struct guestfs_dirent_list *\n"
15722 " guestfs_readdir (guestfs_h *g,\n"
15723 " const char *dir);\n"
15728 #: ../src/guestfs-actions.pod:5663 ../fish/guestfish-actions.pod:3741
15729 msgid "This returns the list of directory entries in directory C<dir>."
15733 #: ../src/guestfs-actions.pod:5665 ../fish/guestfish-actions.pod:3743
15735 "All entries in the directory are returned, including C<.> and C<..>. The "
15736 "entries are I<not> sorted, but returned in the same order as the underlying "
15741 #: ../src/guestfs-actions.pod:5669 ../fish/guestfish-actions.pod:3747
15743 "Also this call returns basic file type information about each file. The "
15744 "C<ftyp> field will contain one of the following characters:"
15748 #: ../src/guestfs-actions.pod:5674 ../fish/guestfish-actions.pod:3752
15753 #: ../src/guestfs-actions.pod:5676 ../fish/guestfish-actions.pod:3754
15754 msgid "Block special"
15758 #: ../src/guestfs-actions.pod:5678 ../fish/guestfish-actions.pod:3756
15763 #: ../src/guestfs-actions.pod:5680 ../fish/guestfish-actions.pod:3758
15764 msgid "Char special"
15768 #: ../src/guestfs-actions.pod:5682 ../fish/guestfish-actions.pod:3760
15773 #: ../src/guestfs-actions.pod:5684 ../fish/guestfish-actions.pod:3762
15778 #: ../src/guestfs-actions.pod:5686 ../fish/guestfish-actions.pod:3764
15783 #: ../src/guestfs-actions.pod:5688 ../fish/guestfish-actions.pod:3766
15784 msgid "FIFO (named pipe)"
15788 #: ../src/guestfs-actions.pod:5690 ../fish/guestfish-actions.pod:3768
15793 #: ../src/guestfs-actions.pod:5692 ../fish/guestfish-actions.pod:3770
15794 msgid "Symbolic link"
15798 #: ../src/guestfs-actions.pod:5694 ../fish/guestfish-actions.pod:3772
15803 #: ../src/guestfs-actions.pod:5696 ../fish/guestfish-actions.pod:3774
15804 msgid "Regular file"
15808 #: ../src/guestfs-actions.pod:5698 ../fish/guestfish-actions.pod:3776
15813 #: ../src/guestfs-actions.pod:5700 ../fish/guestfish-actions.pod:3778
15818 #: ../src/guestfs-actions.pod:5702 ../fish/guestfish-actions.pod:3780
15823 #: ../src/guestfs-actions.pod:5704 ../fish/guestfish-actions.pod:3782
15824 msgid "Unknown file type"
15828 #: ../src/guestfs-actions.pod:5706 ../fish/guestfish-actions.pod:3784
15833 #: ../src/guestfs-actions.pod:5708 ../fish/guestfish-actions.pod:3786
15835 "The L<readdir(3)> call returned a C<d_type> field with an unexpected value"
15839 #: ../src/guestfs-actions.pod:5713
15841 "This function is primarily intended for use by programs. To get a simple "
15842 "list of names, use C<guestfs_ls>. To get a printable directory for human "
15843 "consumption, use C<guestfs_ll>."
15847 #: ../src/guestfs-actions.pod:5717
15849 "This function returns a C<struct guestfs_dirent_list *>, or NULL if there "
15850 "was an error. I<The caller must call C<guestfs_free_dirent_list> after use>."
15854 #: ../src/guestfs-actions.pod:5723
15855 msgid "guestfs_readlink"
15859 #: ../src/guestfs-actions.pod:5725
15863 " guestfs_readlink (guestfs_h *g,\n"
15864 " const char *path);\n"
15869 #: ../src/guestfs-actions.pod:5729 ../fish/guestfish-actions.pod:3799
15870 msgid "This command reads the target of a symbolic link."
15874 #: ../src/guestfs-actions.pod:5736
15875 msgid "guestfs_readlinklist"
15879 #: ../src/guestfs-actions.pod:5738
15883 " guestfs_readlinklist (guestfs_h *g,\n"
15884 " const char *path,\n"
15885 " char *const *names);\n"
15890 #: ../src/guestfs-actions.pod:5743 ../fish/guestfish-actions.pod:3805
15892 "This call allows you to do a C<readlink> operation on multiple files, where "
15893 "all files are in the directory C<path>. C<names> is the list of files from "
15898 #: ../src/guestfs-actions.pod:5747 ../fish/guestfish-actions.pod:3809
15900 "On return you get a list of strings, with a one-to-one correspondence to the "
15901 "C<names> list. Each string is the value of the symbolic link."
15905 #: ../src/guestfs-actions.pod:5751 ../fish/guestfish-actions.pod:3813
15907 "If the C<readlink(2)> operation fails on any name, then the corresponding "
15908 "result string is the empty string C<\"\">. However the whole operation is "
15909 "completed even if there were C<readlink(2)> errors, and so you can call this "
15910 "function with names where you don't know if they are symbolic links already "
15911 "(albeit slightly less efficient)."
15915 #: ../src/guestfs-actions.pod:5758 ../fish/guestfish-actions.pod:3820
15917 "This call is intended for programs that want to efficiently list a directory "
15918 "contents without making many round-trips. Very long directory listings "
15919 "might cause the protocol message size to be exceeded, causing this call to "
15920 "fail. The caller must split up such requests into smaller groups of names."
15924 #: ../src/guestfs-actions.pod:5771
15925 msgid "guestfs_realpath"
15929 #: ../src/guestfs-actions.pod:5773
15933 " guestfs_realpath (guestfs_h *g,\n"
15934 " const char *path);\n"
15939 #: ../src/guestfs-actions.pod:5777 ../fish/guestfish-actions.pod:3831
15941 "Return the canonicalized absolute pathname of C<path>. The returned path "
15942 "has no C<.>, C<..> or symbolic link path elements."
15946 #: ../src/guestfs-actions.pod:5785
15947 msgid "guestfs_removexattr"
15951 #: ../src/guestfs-actions.pod:5787
15955 " guestfs_removexattr (guestfs_h *g,\n"
15956 " const char *xattr,\n"
15957 " const char *path);\n"
15962 #: ../src/guestfs-actions.pod:5792 ../fish/guestfish-actions.pod:3838
15964 "This call removes the extended attribute named C<xattr> of the file C<path>."
15968 #: ../src/guestfs-actions.pod:5795
15969 msgid "See also: C<guestfs_lremovexattr>, L<attr(5)>."
15973 #: ../src/guestfs-actions.pod:5801
15974 msgid "guestfs_resize2fs"
15978 #: ../src/guestfs-actions.pod:5803
15982 " guestfs_resize2fs (guestfs_h *g,\n"
15983 " const char *device);\n"
15988 #: ../src/guestfs-actions.pod:5807 ../fish/guestfish-actions.pod:3847
15990 "This resizes an ext2, ext3 or ext4 filesystem to match the size of the "
15991 "underlying device."
15995 #: ../src/guestfs-actions.pod:5810
15997 "I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f> on the "
15998 "C<device> before calling this command. For unknown reasons C<resize2fs> "
15999 "sometimes gives an error about this and sometimes not. In any case, it is "
16000 "always safe to call C<guestfs_e2fsck_f> before calling this function."
16004 #: ../src/guestfs-actions.pod:5820
16005 msgid "guestfs_resize2fs_M"
16009 #: ../src/guestfs-actions.pod:5822
16013 " guestfs_resize2fs_M (guestfs_h *g,\n"
16014 " const char *device);\n"
16019 #: ../src/guestfs-actions.pod:5826
16021 "This command is the same as C<guestfs_resize2fs>, but the filesystem is "
16022 "resized to its minimum size. This works like the I<-M> option to the "
16023 "C<resize2fs> command."
16027 #: ../src/guestfs-actions.pod:5830
16029 "To get the resulting size of the filesystem you should call "
16030 "C<guestfs_tune2fs_l> and read the C<Block size> and C<Block count> values. "
16031 "These two numbers, multiplied together, give the resulting size of the "
16032 "minimal filesystem in bytes."
16036 #: ../src/guestfs-actions.pod:5839
16037 msgid "guestfs_resize2fs_size"
16041 #: ../src/guestfs-actions.pod:5841
16045 " guestfs_resize2fs_size (guestfs_h *g,\n"
16046 " const char *device,\n"
16047 " int64_t size);\n"
16052 #: ../src/guestfs-actions.pod:5846
16054 "This command is the same as C<guestfs_resize2fs> except that it allows you "
16055 "to specify the new size (in bytes) explicitly."
16059 #: ../src/guestfs-actions.pod:5853
16064 #: ../src/guestfs-actions.pod:5855
16068 " guestfs_rm (guestfs_h *g,\n"
16069 " const char *path);\n"
16074 #: ../src/guestfs-actions.pod:5859 ../fish/guestfish-actions.pod:3880
16075 msgid "Remove the single file C<path>."
16079 #: ../src/guestfs-actions.pod:5865
16080 msgid "guestfs_rm_rf"
16084 #: ../src/guestfs-actions.pod:5867
16088 " guestfs_rm_rf (guestfs_h *g,\n"
16089 " const char *path);\n"
16094 #: ../src/guestfs-actions.pod:5871 ../fish/guestfish-actions.pod:3886
16096 "Remove the file or directory C<path>, recursively removing the contents if "
16097 "its a directory. This is like the C<rm -rf> shell command."
16101 #: ../src/guestfs-actions.pod:5879
16102 msgid "guestfs_rmdir"
16106 #: ../src/guestfs-actions.pod:5881
16110 " guestfs_rmdir (guestfs_h *g,\n"
16111 " const char *path);\n"
16116 #: ../src/guestfs-actions.pod:5885 ../fish/guestfish-actions.pod:3894
16117 msgid "Remove the single directory C<path>."
16121 #: ../src/guestfs-actions.pod:5891
16122 msgid "guestfs_rmmountpoint"
16126 #: ../src/guestfs-actions.pod:5893
16130 " guestfs_rmmountpoint (guestfs_h *g,\n"
16131 " const char *exemptpath);\n"
16136 #: ../src/guestfs-actions.pod:5897
16138 "This calls removes a mountpoint that was previously created with "
16139 "C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint> for full details."
16143 #: ../src/guestfs-actions.pod:5905
16144 msgid "guestfs_scrub_device"
16148 #: ../src/guestfs-actions.pod:5907
16152 " guestfs_scrub_device (guestfs_h *g,\n"
16153 " const char *device);\n"
16158 #: ../src/guestfs-actions.pod:5911 ../fish/guestfish-actions.pod:3908
16160 "This command writes patterns over C<device> to make data retrieval more "
16165 #: ../src/guestfs-actions.pod:5914 ../src/guestfs-actions.pod:5935
16166 #: ../src/guestfs-actions.pod:5954 ../fish/guestfish-actions.pod:3911
16167 #: ../fish/guestfish-actions.pod:3926 ../fish/guestfish-actions.pod:3939
16169 "It is an interface to the L<scrub(1)> program. See that manual page for "
16174 #: ../src/guestfs-actions.pod:5922 ../src/guestfs-actions.pod:5940
16175 #: ../src/guestfs-actions.pod:5959
16176 msgid "(Added in 1.0.52)"
16180 #: ../src/guestfs-actions.pod:5924
16181 msgid "guestfs_scrub_file"
16185 #: ../src/guestfs-actions.pod:5926
16189 " guestfs_scrub_file (guestfs_h *g,\n"
16190 " const char *file);\n"
16195 #: ../src/guestfs-actions.pod:5930 ../fish/guestfish-actions.pod:3921
16197 "This command writes patterns over a file to make data retrieval more "
16202 #: ../src/guestfs-actions.pod:5933 ../fish/guestfish-actions.pod:3924
16203 msgid "The file is I<removed> after scrubbing."
16207 #: ../src/guestfs-actions.pod:5942
16208 msgid "guestfs_scrub_freespace"
16212 #: ../src/guestfs-actions.pod:5944
16216 " guestfs_scrub_freespace (guestfs_h *g,\n"
16217 " const char *dir);\n"
16222 #: ../src/guestfs-actions.pod:5948
16224 "This command creates the directory C<dir> and then fills it with files until "
16225 "the filesystem is full, and scrubs the files as for C<guestfs_scrub_file>, "
16226 "and deletes them. The intention is to scrub any free space on the partition "
16227 "containing C<dir>."
16231 #: ../src/guestfs-actions.pod:5961
16232 msgid "guestfs_set_append"
16236 #: ../src/guestfs-actions.pod:5963
16240 " guestfs_set_append (guestfs_h *g,\n"
16241 " const char *append);\n"
16246 #: ../src/guestfs-actions.pod:5967 ../fish/guestfish-actions.pod:3948
16248 "This function is used to add additional options to the guest kernel command "
16253 #: ../src/guestfs-actions.pod:5970 ../fish/guestfish-actions.pod:3951
16255 "The default is C<NULL> unless overridden by setting C<LIBGUESTFS_APPEND> "
16256 "environment variable."
16260 #: ../src/guestfs-actions.pod:5973 ../fish/guestfish-actions.pod:3954
16262 "Setting C<append> to C<NULL> means I<no> additional options are passed "
16263 "(libguestfs always adds a few of its own)."
16267 #: ../src/guestfs-actions.pod:5980
16268 msgid "guestfs_set_attach_method"
16272 #: ../src/guestfs-actions.pod:5982
16276 " guestfs_set_attach_method (guestfs_h *g,\n"
16277 " const char *attachmethod);\n"
16282 #: ../src/guestfs-actions.pod:5986 ../fish/guestfish-actions.pod:3963
16284 "Set the method that libguestfs uses to connect to the back end guestfsd "
16285 "daemon. Possible methods are:"
16289 #: ../src/guestfs-actions.pod:5993 ../fish/guestfish-actions.pod:3970
16291 "Launch an appliance and connect to it. This is the ordinary method and the "
16296 #: ../src/guestfs-actions.pod:5996 ../fish/guestfish-actions.pod:3973
16297 msgid "C<unix:I<path>>"
16301 #: ../src/guestfs-actions.pod:5998 ../fish/guestfish-actions.pod:3975
16302 msgid "Connect to the Unix domain socket I<path>."
16306 #: ../src/guestfs-actions.pod:6000 ../fish/guestfish-actions.pod:3977
16308 "This method lets you connect to an existing daemon or (using virtio-serial) "
16309 "to a live guest. For more information, see L<guestfs(3)/ATTACHING TO "
16310 "RUNNING DAEMONS>."
16314 #: ../src/guestfs-actions.pod:6010
16315 msgid "guestfs_set_autosync"
16319 #: ../src/guestfs-actions.pod:6012
16323 " guestfs_set_autosync (guestfs_h *g,\n"
16324 " int autosync);\n"
16329 #: ../src/guestfs-actions.pod:6016 ../fish/guestfish-actions.pod:3989
16331 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
16332 "effort attempt to make filesystems consistent and synchronized when the "
16333 "handle is closed (also if the program exits without closing handles)."
16337 #: ../src/guestfs-actions.pod:6021 ../fish/guestfish-actions.pod:3994
16339 "This is enabled by default (since libguestfs 1.5.24, previously it was "
16340 "disabled by default)."
16344 #: ../src/guestfs-actions.pod:6028
16345 msgid "guestfs_set_direct"
16349 #: ../src/guestfs-actions.pod:6030
16353 " guestfs_set_direct (guestfs_h *g,\n"
16359 #: ../src/guestfs-actions.pod:6034 ../fish/guestfish-actions.pod:4003
16361 "If the direct appliance mode flag is enabled, then stdin and stdout are "
16362 "passed directly through to the appliance once it is launched."
16366 #: ../src/guestfs-actions.pod:6038
16368 "One consequence of this is that log messages aren't caught by the library "
16369 "and handled by C<guestfs_set_log_message_callback>, but go straight to "
16374 #: ../src/guestfs-actions.pod:6042 ../fish/guestfish-actions.pod:4011
16375 msgid "You probably don't want to use this unless you know what you are doing."
16379 #: ../src/guestfs-actions.pod:6045 ../fish/guestfish-actions.pod:4014
16380 msgid "The default is disabled."
16384 #: ../src/guestfs-actions.pod:6051
16385 msgid "guestfs_set_e2label"
16389 #: ../src/guestfs-actions.pod:6053
16393 " guestfs_set_e2label (guestfs_h *g,\n"
16394 " const char *device,\n"
16395 " const char *label);\n"
16400 #: ../src/guestfs-actions.pod:6058 ../fish/guestfish-actions.pod:4020
16402 "This sets the ext2/3/4 filesystem label of the filesystem on C<device> to "
16403 "C<label>. Filesystem labels are limited to 16 characters."
16407 #: ../src/guestfs-actions.pod:6062
16409 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label> to return "
16410 "the existing label on a filesystem."
16414 #: ../src/guestfs-actions.pod:6069
16415 msgid "guestfs_set_e2uuid"
16419 #: ../src/guestfs-actions.pod:6071
16423 " guestfs_set_e2uuid (guestfs_h *g,\n"
16424 " const char *device,\n"
16425 " const char *uuid);\n"
16430 #: ../src/guestfs-actions.pod:6076 ../fish/guestfish-actions.pod:4031
16432 "This sets the ext2/3/4 filesystem UUID of the filesystem on C<device> to "
16433 "C<uuid>. The format of the UUID and alternatives such as C<clear>, "
16434 "C<random> and C<time> are described in the L<tune2fs(8)> manpage."
16438 #: ../src/guestfs-actions.pod:6081
16440 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid> to return "
16441 "the existing UUID of a filesystem."
16445 #: ../src/guestfs-actions.pod:6088
16446 msgid "guestfs_set_memsize"
16450 #: ../src/guestfs-actions.pod:6090
16454 " guestfs_set_memsize (guestfs_h *g,\n"
16460 #: ../src/guestfs-actions.pod:6094
16462 "This sets the memory size in megabytes allocated to the qemu subprocess. "
16463 "This only has any effect if called before C<guestfs_launch>."
16467 #: ../src/guestfs-actions.pod:6098 ../fish/guestfish-actions.pod:4049
16469 "You can also change this by setting the environment variable "
16470 "C<LIBGUESTFS_MEMSIZE> before the handle is created."
16474 #: ../src/guestfs-actions.pod:6109
16475 msgid "guestfs_set_network"
16479 #: ../src/guestfs-actions.pod:6111
16483 " guestfs_set_network (guestfs_h *g,\n"
16489 #: ../src/guestfs-actions.pod:6115 ../fish/guestfish-actions.pod:4062
16491 "If C<network> is true, then the network is enabled in the libguestfs "
16492 "appliance. The default is false."
16496 #: ../src/guestfs-actions.pod:6118 ../fish/guestfish-actions.pod:4065
16498 "This affects whether commands are able to access the network (see L<guestfs"
16499 "(3)/RUNNING COMMANDS>)."
16503 #: ../src/guestfs-actions.pod:6121
16505 "You must call this before calling C<guestfs_launch>, otherwise it has no "
16510 #: ../src/guestfs-actions.pod:6128
16511 msgid "guestfs_set_path"
16515 #: ../src/guestfs-actions.pod:6130
16519 " guestfs_set_path (guestfs_h *g,\n"
16520 " const char *searchpath);\n"
16525 #: ../src/guestfs-actions.pod:6134 ../fish/guestfish-actions.pod:4077
16526 msgid "Set the path that libguestfs searches for kernel and initrd.img."
16530 #: ../src/guestfs-actions.pod:6136 ../fish/guestfish-actions.pod:4079
16532 "The default is C<$libdir/guestfs> unless overridden by setting "
16533 "C<LIBGUESTFS_PATH> environment variable."
16537 #: ../src/guestfs-actions.pod:6139 ../fish/guestfish-actions.pod:4082
16538 msgid "Setting C<path> to C<NULL> restores the default path."
16542 #: ../src/guestfs-actions.pod:6145
16543 msgid "guestfs_set_qemu"
16547 #: ../src/guestfs-actions.pod:6147
16551 " guestfs_set_qemu (guestfs_h *g,\n"
16552 " const char *qemu);\n"
16557 #: ../src/guestfs-actions.pod:6151 ../fish/guestfish-actions.pod:4090
16558 msgid "Set the qemu binary that we will use."
16562 #: ../src/guestfs-actions.pod:6153 ../fish/guestfish-actions.pod:4092
16564 "The default is chosen when the library was compiled by the configure script."
16568 #: ../src/guestfs-actions.pod:6156 ../fish/guestfish-actions.pod:4095
16570 "You can also override this by setting the C<LIBGUESTFS_QEMU> environment "
16575 #: ../src/guestfs-actions.pod:6159 ../fish/guestfish-actions.pod:4098
16576 msgid "Setting C<qemu> to C<NULL> restores the default qemu binary."
16580 #: ../src/guestfs-actions.pod:6161 ../fish/guestfish-actions.pod:4100
16582 "Note that you should call this function as early as possible after creating "
16583 "the handle. This is because some pre-launch operations depend on testing "
16584 "qemu features (by running C<qemu -help>). If the qemu binary changes, we "
16585 "don't retest features, and so you might see inconsistent results. Using the "
16586 "environment variable C<LIBGUESTFS_QEMU> is safest of all since that picks "
16587 "the qemu binary at the same time as the handle is created."
16591 #: ../src/guestfs-actions.pod:6173
16592 msgid "guestfs_set_recovery_proc"
16596 #: ../src/guestfs-actions.pod:6175
16600 " guestfs_set_recovery_proc (guestfs_h *g,\n"
16601 " int recoveryproc);\n"
16606 #: ../src/guestfs-actions.pod:6179
16608 "If this is called with the parameter C<false> then C<guestfs_launch> does "
16609 "not create a recovery process. The purpose of the recovery process is to "
16610 "stop runaway qemu processes in the case where the main program aborts "
16615 #: ../src/guestfs-actions.pod:6184
16617 "This only has any effect if called before C<guestfs_launch>, and the default "
16622 #: ../src/guestfs-actions.pod:6187 ../fish/guestfish-actions.pod:4122
16624 "About the only time when you would want to disable this is if the main "
16625 "process will fork itself into the background (\"daemonize\" itself). In "
16626 "this case the recovery process thinks that the main program has disappeared "
16627 "and so kills qemu, which is not very helpful."
16631 #: ../src/guestfs-actions.pod:6197
16632 msgid "guestfs_set_selinux"
16636 #: ../src/guestfs-actions.pod:6199
16640 " guestfs_set_selinux (guestfs_h *g,\n"
16646 #: ../src/guestfs-actions.pod:6203 ../fish/guestfish-actions.pod:4134
16648 "This sets the selinux flag that is passed to the appliance at boot time. "
16649 "The default is C<selinux=0> (disabled)."
16653 #: ../src/guestfs-actions.pod:6206 ../fish/guestfish-actions.pod:4137
16655 "Note that if SELinux is enabled, it is always in Permissive mode "
16656 "(C<enforcing=0>)."
16660 #: ../src/guestfs-actions.pod:6216
16661 msgid "guestfs_set_trace"
16665 #: ../src/guestfs-actions.pod:6218
16669 " guestfs_set_trace (guestfs_h *g,\n"
16675 #: ../src/guestfs-actions.pod:6222 ../fish/guestfish-actions.pod:4149
16677 "If the command trace flag is set to 1, then libguestfs calls, parameters and "
16678 "return values are traced."
16682 #: ../src/guestfs-actions.pod:6225 ../fish/guestfish-actions.pod:4152
16684 "If you want to trace C API calls into libguestfs (and other libraries) then "
16685 "possibly a better way is to use the external ltrace(1) command."
16689 #: ../src/guestfs-actions.pod:6229 ../fish/guestfish-actions.pod:4156
16691 "Command traces are disabled unless the environment variable "
16692 "C<LIBGUESTFS_TRACE> is defined and set to C<1>."
16696 #: ../src/guestfs-actions.pod:6232
16698 "Trace messages are normally sent to C<stderr>, unless you register a "
16699 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
16703 #: ../src/guestfs-actions.pod:6240
16704 msgid "guestfs_set_verbose"
16708 #: ../src/guestfs-actions.pod:6242
16712 " guestfs_set_verbose (guestfs_h *g,\n"
16718 #: ../src/guestfs-actions.pod:6246 ../fish/guestfish-actions.pod:4169
16719 msgid "If C<verbose> is true, this turns on verbose messages."
16723 #: ../src/guestfs-actions.pod:6248 ../fish/guestfish-actions.pod:4171
16725 "Verbose messages are disabled unless the environment variable "
16726 "C<LIBGUESTFS_DEBUG> is defined and set to C<1>."
16730 #: ../src/guestfs-actions.pod:6251
16732 "Verbose messages are normally sent to C<stderr>, unless you register a "
16733 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
16737 #: ../src/guestfs-actions.pod:6259
16738 msgid "guestfs_setcon"
16742 #: ../src/guestfs-actions.pod:6261
16746 " guestfs_setcon (guestfs_h *g,\n"
16747 " const char *context);\n"
16752 #: ../src/guestfs-actions.pod:6265 ../fish/guestfish-actions.pod:4182
16754 "This sets the SELinux security context of the daemon to the string "
16759 #: ../src/guestfs-actions.pod:6268 ../fish/guestfish-actions.pod:4185
16760 msgid "See the documentation about SELINUX in L<guestfs(3)>."
16764 #: ../src/guestfs-actions.pod:6274
16765 msgid "guestfs_setxattr"
16769 #: ../src/guestfs-actions.pod:6276
16773 " guestfs_setxattr (guestfs_h *g,\n"
16774 " const char *xattr,\n"
16775 " const char *val,\n"
16777 " const char *path);\n"
16782 #: ../src/guestfs-actions.pod:6283 ../fish/guestfish-actions.pod:4191
16784 "This call sets the extended attribute named C<xattr> of the file C<path> to "
16785 "the value C<val> (of length C<vallen>). The value is arbitrary 8 bit data."
16789 #: ../src/guestfs-actions.pod:6287
16790 msgid "See also: C<guestfs_lsetxattr>, L<attr(5)>."
16794 #: ../src/guestfs-actions.pod:6293
16795 msgid "guestfs_sfdisk"
16799 #: ../src/guestfs-actions.pod:6295
16803 " guestfs_sfdisk (guestfs_h *g,\n"
16804 " const char *device,\n"
16808 " char *const *lines);\n"
16813 #: ../src/guestfs-actions.pod:6303 ../fish/guestfish-actions.pod:4201
16815 "This is a direct interface to the L<sfdisk(8)> program for creating "
16816 "partitions on block devices."
16820 #: ../src/guestfs-actions.pod:6306 ../fish/guestfish-actions.pod:4204
16821 msgid "C<device> should be a block device, for example C</dev/sda>."
16825 #: ../src/guestfs-actions.pod:6308 ../fish/guestfish-actions.pod:4206
16827 "C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads and "
16828 "sectors on the device, which are passed directly to sfdisk as the I<-C>, I<-"
16829 "H> and I<-S> parameters. If you pass C<0> for any of these, then the "
16830 "corresponding parameter is omitted. Usually for 'large' disks, you can just "
16831 "pass C<0> for these, but for small (floppy-sized) disks, sfdisk (or rather, "
16832 "the kernel) cannot work out the right geometry and you will need to tell it."
16836 #: ../src/guestfs-actions.pod:6316 ../fish/guestfish-actions.pod:4214
16838 "C<lines> is a list of lines that we feed to C<sfdisk>. For more information "
16839 "refer to the L<sfdisk(8)> manpage."
16843 #: ../src/guestfs-actions.pod:6319 ../fish/guestfish-actions.pod:4217
16845 "To create a single partition occupying the whole disk, you would pass "
16846 "C<lines> as a single element list, when the single element being the string "
16851 #: ../src/guestfs-actions.pod:6323
16853 "See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>, C<guestfs_part_init>"
16857 #: ../src/guestfs-actions.pod:6331 ../src/guestfs-actions.pod:6361
16858 #: ../src/guestfs-actions.pod:6394 ../fish/guestfish-actions.pod:4227
16859 #: ../fish/guestfish-actions.pod:4250 ../fish/guestfish-actions.pod:4272
16861 "This function is deprecated. In new code, use the C<part_add> call instead."
16865 #: ../src/guestfs-actions.pod:6340
16866 msgid "guestfs_sfdiskM"
16870 #: ../src/guestfs-actions.pod:6342
16874 " guestfs_sfdiskM (guestfs_h *g,\n"
16875 " const char *device,\n"
16876 " char *const *lines);\n"
16881 #: ../src/guestfs-actions.pod:6347
16883 "This is a simplified interface to the C<guestfs_sfdisk> command, where "
16884 "partition sizes are specified in megabytes only (rounded to the nearest "
16885 "cylinder) and you don't need to specify the cyls, heads and sectors "
16886 "parameters which were rarely if ever used anyway."
16890 #: ../src/guestfs-actions.pod:6353
16892 "See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage and "
16893 "C<guestfs_part_disk>"
16897 #: ../src/guestfs-actions.pod:6370
16898 msgid "guestfs_sfdisk_N"
16902 #: ../src/guestfs-actions.pod:6372
16906 " guestfs_sfdisk_N (guestfs_h *g,\n"
16907 " const char *device,\n"
16912 " const char *line);\n"
16917 #: ../src/guestfs-actions.pod:6381 ../fish/guestfish-actions.pod:4261
16919 "This runs L<sfdisk(8)> option to modify just the single partition C<n> "
16920 "(note: C<n> counts from 1)."
16924 #: ../src/guestfs-actions.pod:6384
16926 "For other parameters, see C<guestfs_sfdisk>. You should usually pass C<0> "
16927 "for the cyls/heads/sectors parameters."
16931 #: ../src/guestfs-actions.pod:6387
16932 msgid "See also: C<guestfs_part_add>"
16936 #: ../src/guestfs-actions.pod:6403
16937 msgid "guestfs_sfdisk_disk_geometry"
16941 #: ../src/guestfs-actions.pod:6405
16945 " guestfs_sfdisk_disk_geometry (guestfs_h *g,\n"
16946 " const char *device);\n"
16951 #: ../src/guestfs-actions.pod:6409
16953 "This displays the disk geometry of C<device> read from the partition table. "
16954 "Especially in the case where the underlying block device has been resized, "
16955 "this can be different from the kernel's idea of the geometry (see "
16956 "C<guestfs_sfdisk_kernel_geometry>)."
16960 #: ../src/guestfs-actions.pod:6414 ../src/guestfs-actions.pod:6430
16961 #: ../fish/guestfish-actions.pod:4288 ../fish/guestfish-actions.pod:4297
16962 msgid "The result is in human-readable format, and not designed to be parsed."
16966 #: ../src/guestfs-actions.pod:6422
16967 msgid "guestfs_sfdisk_kernel_geometry"
16971 #: ../src/guestfs-actions.pod:6424
16975 " guestfs_sfdisk_kernel_geometry (guestfs_h *g,\n"
16976 " const char *device);\n"
16981 #: ../src/guestfs-actions.pod:6428 ../fish/guestfish-actions.pod:4295
16982 msgid "This displays the kernel's idea of the geometry of C<device>."
16986 #: ../src/guestfs-actions.pod:6438
16987 msgid "guestfs_sfdisk_l"
16991 #: ../src/guestfs-actions.pod:6440
16995 " guestfs_sfdisk_l (guestfs_h *g,\n"
16996 " const char *device);\n"
17001 #: ../src/guestfs-actions.pod:6444 ../fish/guestfish-actions.pod:4304
17003 "This displays the partition table on C<device>, in the human-readable output "
17004 "of the L<sfdisk(8)> command. It is not intended to be parsed."
17008 #: ../src/guestfs-actions.pod:6448
17009 msgid "See also: C<guestfs_part_list>"
17013 #: ../src/guestfs-actions.pod:6453 ../fish/guestfish-actions.pod:4310
17015 "This function is deprecated. In new code, use the C<part_list> call instead."
17019 #: ../src/guestfs-actions.pod:6462
17024 #: ../src/guestfs-actions.pod:6464
17028 " guestfs_sh (guestfs_h *g,\n"
17029 " const char *command);\n"
17034 #: ../src/guestfs-actions.pod:6468 ../fish/guestfish-actions.pod:4321
17036 "This call runs a command from the guest filesystem via the guest's C</bin/"
17041 #: ../src/guestfs-actions.pod:6471
17042 msgid "This is like C<guestfs_command>, but passes the command to:"
17046 #: ../src/guestfs-actions.pod:6473 ../fish/guestfish-actions.pod:4326
17049 " /bin/sh -c \"command\"\n"
17054 #: ../src/guestfs-actions.pod:6475 ../fish/guestfish-actions.pod:4328
17056 "Depending on the guest's shell, this usually results in wildcards being "
17057 "expanded, shell expressions being interpolated and so on."
17061 #: ../src/guestfs-actions.pod:6479
17062 msgid "All the provisos about C<guestfs_command> apply to this call."
17066 #: ../src/guestfs-actions.pod:6486
17067 msgid "guestfs_sh_lines"
17071 #: ../src/guestfs-actions.pod:6488
17075 " guestfs_sh_lines (guestfs_h *g,\n"
17076 " const char *command);\n"
17081 #: ../src/guestfs-actions.pod:6492
17083 "This is the same as C<guestfs_sh>, but splits the result into a list of "
17088 #: ../src/guestfs-actions.pod:6495
17089 msgid "See also: C<guestfs_command_lines>"
17093 #: ../src/guestfs-actions.pod:6503
17094 msgid "guestfs_sleep"
17098 #: ../src/guestfs-actions.pod:6505
17102 " guestfs_sleep (guestfs_h *g,\n"
17108 #: ../src/guestfs-actions.pod:6509 ../fish/guestfish-actions.pod:4347
17109 msgid "Sleep for C<secs> seconds."
17113 #: ../src/guestfs-actions.pod:6513
17114 msgid "(Added in 1.0.41)"
17118 #: ../src/guestfs-actions.pod:6515 ../src/guestfs-structs.pod:109
17119 msgid "guestfs_stat"
17123 #: ../src/guestfs-actions.pod:6517
17126 " struct guestfs_stat *\n"
17127 " guestfs_stat (guestfs_h *g,\n"
17128 " const char *path);\n"
17133 #: ../src/guestfs-actions.pod:6523 ../fish/guestfish-actions.pod:4355
17134 msgid "This is the same as the C<stat(2)> system call."
17138 #: ../src/guestfs-actions.pod:6531 ../src/guestfs-structs.pod:135
17139 msgid "guestfs_statvfs"
17143 #: ../src/guestfs-actions.pod:6533
17146 " struct guestfs_statvfs *\n"
17147 " guestfs_statvfs (guestfs_h *g,\n"
17148 " const char *path);\n"
17153 #: ../src/guestfs-actions.pod:6537 ../fish/guestfish-actions.pod:4361
17155 "Returns file system statistics for any mounted file system. C<path> should "
17156 "be a file or directory in the mounted file system (typically it is the mount "
17157 "point itself, but it doesn't need to be)."
17161 #: ../src/guestfs-actions.pod:6541 ../fish/guestfish-actions.pod:4365
17162 msgid "This is the same as the C<statvfs(2)> system call."
17166 #: ../src/guestfs-actions.pod:6543
17168 "This function returns a C<struct guestfs_statvfs *>, or NULL if there was an "
17169 "error. I<The caller must call C<guestfs_free_statvfs> after use>."
17173 #: ../src/guestfs-actions.pod:6549
17174 msgid "guestfs_strings"
17178 #: ../src/guestfs-actions.pod:6551
17182 " guestfs_strings (guestfs_h *g,\n"
17183 " const char *path);\n"
17188 #: ../src/guestfs-actions.pod:6555 ../fish/guestfish-actions.pod:4371
17190 "This runs the L<strings(1)> command on a file and returns the list of "
17191 "printable strings found."
17195 #: ../src/guestfs-actions.pod:6567
17196 msgid "guestfs_strings_e"
17200 #: ../src/guestfs-actions.pod:6569
17204 " guestfs_strings_e (guestfs_h *g,\n"
17205 " const char *encoding,\n"
17206 " const char *path);\n"
17211 #: ../src/guestfs-actions.pod:6574
17213 "This is like the C<guestfs_strings> command, but allows you to specify the "
17214 "encoding of strings that are looked for in the source file C<path>."
17218 #: ../src/guestfs-actions.pod:6578 ../fish/guestfish-actions.pod:4385
17219 msgid "Allowed encodings are:"
17223 #: ../src/guestfs-actions.pod:6582 ../fish/guestfish-actions.pod:4389
17228 #: ../src/guestfs-actions.pod:6584
17230 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
17231 "ISO-8859-X (this is what C<guestfs_strings> uses)."
17235 #: ../src/guestfs-actions.pod:6587 ../fish/guestfish-actions.pod:4394
17240 #: ../src/guestfs-actions.pod:6589 ../fish/guestfish-actions.pod:4396
17241 msgid "Single 8-bit-byte characters."
17245 #: ../src/guestfs-actions.pod:6591 ../fish/guestfish-actions.pod:4398
17250 #: ../src/guestfs-actions.pod:6593 ../fish/guestfish-actions.pod:4400
17251 msgid "16-bit big endian strings such as those encoded in UTF-16BE or UCS-2BE."
17255 #: ../src/guestfs-actions.pod:6596 ../fish/guestfish-actions.pod:4403
17256 msgid "l (lower case letter L)"
17260 #: ../src/guestfs-actions.pod:6598 ../fish/guestfish-actions.pod:4405
17262 "16-bit little endian such as UTF-16LE and UCS-2LE. This is useful for "
17263 "examining binaries in Windows guests."
17267 #: ../src/guestfs-actions.pod:6601 ../fish/guestfish-actions.pod:4408
17272 #: ../src/guestfs-actions.pod:6603 ../fish/guestfish-actions.pod:4410
17273 msgid "32-bit big endian such as UCS-4BE."
17277 #: ../src/guestfs-actions.pod:6605 ../fish/guestfish-actions.pod:4412
17282 #: ../src/guestfs-actions.pod:6607 ../fish/guestfish-actions.pod:4414
17283 msgid "32-bit little endian such as UCS-4LE."
17287 #: ../src/guestfs-actions.pod:6611 ../fish/guestfish-actions.pod:4418
17288 msgid "The returned strings are transcoded to UTF-8."
17292 #: ../src/guestfs-actions.pod:6622
17293 msgid "guestfs_swapoff_device"
17297 #: ../src/guestfs-actions.pod:6624
17301 " guestfs_swapoff_device (guestfs_h *g,\n"
17302 " const char *device);\n"
17307 #: ../src/guestfs-actions.pod:6628
17309 "This command disables the libguestfs appliance swap device or partition "
17310 "named C<device>. See C<guestfs_swapon_device>."
17314 #: ../src/guestfs-actions.pod:6636
17315 msgid "guestfs_swapoff_file"
17319 #: ../src/guestfs-actions.pod:6638
17323 " guestfs_swapoff_file (guestfs_h *g,\n"
17324 " const char *file);\n"
17329 #: ../src/guestfs-actions.pod:6642 ../fish/guestfish-actions.pod:4435
17330 msgid "This command disables the libguestfs appliance swap on file."
17334 #: ../src/guestfs-actions.pod:6648
17335 msgid "guestfs_swapoff_label"
17339 #: ../src/guestfs-actions.pod:6650
17343 " guestfs_swapoff_label (guestfs_h *g,\n"
17344 " const char *label);\n"
17349 #: ../src/guestfs-actions.pod:6654 ../fish/guestfish-actions.pod:4441
17351 "This command disables the libguestfs appliance swap on labeled swap "
17356 #: ../src/guestfs-actions.pod:6661
17357 msgid "guestfs_swapoff_uuid"
17361 #: ../src/guestfs-actions.pod:6663
17365 " guestfs_swapoff_uuid (guestfs_h *g,\n"
17366 " const char *uuid);\n"
17371 #: ../src/guestfs-actions.pod:6667 ../fish/guestfish-actions.pod:4448
17373 "This command disables the libguestfs appliance swap partition with the given "
17378 #: ../src/guestfs-actions.pod:6674
17379 msgid "guestfs_swapon_device"
17383 #: ../src/guestfs-actions.pod:6676
17387 " guestfs_swapon_device (guestfs_h *g,\n"
17388 " const char *device);\n"
17393 #: ../src/guestfs-actions.pod:6680
17395 "This command enables the libguestfs appliance to use the swap device or "
17396 "partition named C<device>. The increased memory is made available for all "
17397 "commands, for example those run using C<guestfs_command> or C<guestfs_sh>."
17401 #: ../src/guestfs-actions.pod:6685 ../fish/guestfish-actions.pod:4460
17403 "Note that you should not swap to existing guest swap partitions unless you "
17404 "know what you are doing. They may contain hibernation information, or other "
17405 "information that the guest doesn't want you to trash. You also risk leaking "
17406 "information about the host to the guest this way. Instead, attach a new "
17407 "host device to the guest and swap on that."
17411 #: ../src/guestfs-actions.pod:6696
17412 msgid "guestfs_swapon_file"
17416 #: ../src/guestfs-actions.pod:6698
17420 " guestfs_swapon_file (guestfs_h *g,\n"
17421 " const char *file);\n"
17426 #: ../src/guestfs-actions.pod:6702
17428 "This command enables swap to a file. See C<guestfs_swapon_device> for other "
17433 #: ../src/guestfs-actions.pod:6709
17434 msgid "guestfs_swapon_label"
17438 #: ../src/guestfs-actions.pod:6711
17442 " guestfs_swapon_label (guestfs_h *g,\n"
17443 " const char *label);\n"
17448 #: ../src/guestfs-actions.pod:6715
17450 "This command enables swap to a labeled swap partition. See "
17451 "C<guestfs_swapon_device> for other notes."
17455 #: ../src/guestfs-actions.pod:6722
17456 msgid "guestfs_swapon_uuid"
17460 #: ../src/guestfs-actions.pod:6724
17464 " guestfs_swapon_uuid (guestfs_h *g,\n"
17465 " const char *uuid);\n"
17470 #: ../src/guestfs-actions.pod:6728
17472 "This command enables swap to a swap partition with the given UUID. See "
17473 "C<guestfs_swapon_device> for other notes."
17477 #: ../src/guestfs-actions.pod:6735
17478 msgid "guestfs_sync"
17482 #: ../src/guestfs-actions.pod:6737
17486 " guestfs_sync (guestfs_h *g);\n"
17491 #: ../src/guestfs-actions.pod:6740 ../fish/guestfish-actions.pod:4492
17493 "This syncs the disk, so that any writes are flushed through to the "
17494 "underlying disk image."
17498 #: ../src/guestfs-actions.pod:6743 ../fish/guestfish-actions.pod:4495
17500 "You should always call this if you have modified a disk image, before "
17501 "closing the handle."
17505 #: ../src/guestfs-actions.pod:6750
17506 msgid "guestfs_tail"
17510 #: ../src/guestfs-actions.pod:6752
17514 " guestfs_tail (guestfs_h *g,\n"
17515 " const char *path);\n"
17520 #: ../src/guestfs-actions.pod:6756 ../fish/guestfish-actions.pod:4502
17522 "This command returns up to the last 10 lines of a file as a list of strings."
17526 #: ../src/guestfs-actions.pod:6768
17527 msgid "guestfs_tail_n"
17531 #: ../src/guestfs-actions.pod:6770
17535 " guestfs_tail_n (guestfs_h *g,\n"
17537 " const char *path);\n"
17542 #: ../src/guestfs-actions.pod:6775 ../fish/guestfish-actions.pod:4512
17544 "If the parameter C<nrlines> is a positive number, this returns the last "
17545 "C<nrlines> lines of the file C<path>."
17549 #: ../src/guestfs-actions.pod:6778 ../fish/guestfish-actions.pod:4515
17551 "If the parameter C<nrlines> is a negative number, this returns lines from "
17552 "the file C<path>, starting with the C<-nrlines>th line."
17556 #: ../src/guestfs-actions.pod:6792
17557 msgid "guestfs_tar_in"
17561 #: ../src/guestfs-actions.pod:6794
17565 " guestfs_tar_in (guestfs_h *g,\n"
17566 " const char *tarfile,\n"
17567 " const char *directory);\n"
17572 #: ../src/guestfs-actions.pod:6799 ../fish/guestfish-actions.pod:4527
17574 "This command uploads and unpacks local file C<tarfile> (an I<uncompressed> "
17575 "tar file) into C<directory>."
17579 #: ../src/guestfs-actions.pod:6802
17581 "To upload a compressed tarball, use C<guestfs_tgz_in> or C<guestfs_txz_in>."
17585 #: ../src/guestfs-actions.pod:6807 ../src/guestfs-actions.pod:6824
17586 #: ../src/guestfs-actions.pod:6840 ../src/guestfs-actions.pod:6856
17587 msgid "(Added in 1.0.3)"
17591 #: ../src/guestfs-actions.pod:6809
17592 msgid "guestfs_tar_out"
17596 #: ../src/guestfs-actions.pod:6811
17600 " guestfs_tar_out (guestfs_h *g,\n"
17601 " const char *directory,\n"
17602 " const char *tarfile);\n"
17607 #: ../src/guestfs-actions.pod:6816 ../fish/guestfish-actions.pod:4539
17609 "This command packs the contents of C<directory> and downloads it to local "
17614 #: ../src/guestfs-actions.pod:6819
17616 "To download a compressed tarball, use C<guestfs_tgz_out> or "
17617 "C<guestfs_txz_out>."
17621 #: ../src/guestfs-actions.pod:6826
17622 msgid "guestfs_tgz_in"
17626 #: ../src/guestfs-actions.pod:6828
17630 " guestfs_tgz_in (guestfs_h *g,\n"
17631 " const char *tarball,\n"
17632 " const char *directory);\n"
17637 #: ../src/guestfs-actions.pod:6833 ../fish/guestfish-actions.pod:4551
17639 "This command uploads and unpacks local file C<tarball> (a I<gzip compressed> "
17640 "tar file) into C<directory>."
17644 #: ../src/guestfs-actions.pod:6836
17645 msgid "To upload an uncompressed tarball, use C<guestfs_tar_in>."
17649 #: ../src/guestfs-actions.pod:6842
17650 msgid "guestfs_tgz_out"
17654 #: ../src/guestfs-actions.pod:6844
17658 " guestfs_tgz_out (guestfs_h *g,\n"
17659 " const char *directory,\n"
17660 " const char *tarball);\n"
17665 #: ../src/guestfs-actions.pod:6849 ../fish/guestfish-actions.pod:4562
17667 "This command packs the contents of C<directory> and downloads it to local "
17672 #: ../src/guestfs-actions.pod:6852
17673 msgid "To download an uncompressed tarball, use C<guestfs_tar_out>."
17677 #: ../src/guestfs-actions.pod:6858
17678 msgid "guestfs_touch"
17682 #: ../src/guestfs-actions.pod:6860
17686 " guestfs_touch (guestfs_h *g,\n"
17687 " const char *path);\n"
17692 #: ../src/guestfs-actions.pod:6864 ../fish/guestfish-actions.pod:4573
17694 "Touch acts like the L<touch(1)> command. It can be used to update the "
17695 "timestamps on a file, or, if the file does not exist, to create a new zero-"
17700 #: ../src/guestfs-actions.pod:6868 ../fish/guestfish-actions.pod:4577
17702 "This command only works on regular files, and will fail on other file types "
17703 "such as directories, symbolic links, block special etc."
17707 #: ../src/guestfs-actions.pod:6875
17708 msgid "guestfs_truncate"
17712 #: ../src/guestfs-actions.pod:6877
17716 " guestfs_truncate (guestfs_h *g,\n"
17717 " const char *path);\n"
17722 #: ../src/guestfs-actions.pod:6881 ../fish/guestfish-actions.pod:4584
17724 "This command truncates C<path> to a zero-length file. The file must exist "
17729 #: ../src/guestfs-actions.pod:6888
17730 msgid "guestfs_truncate_size"
17734 #: ../src/guestfs-actions.pod:6890
17738 " guestfs_truncate_size (guestfs_h *g,\n"
17739 " const char *path,\n"
17740 " int64_t size);\n"
17745 #: ../src/guestfs-actions.pod:6895 ../fish/guestfish-actions.pod:4591
17747 "This command truncates C<path> to size C<size> bytes. The file must exist "
17752 #: ../src/guestfs-actions.pod:6898
17754 "If the current file size is less than C<size> then the file is extended to "
17755 "the required size with zero bytes. This creates a sparse file (ie. disk "
17756 "blocks are not allocated for the file until you write to it). To create a "
17757 "non-sparse file of zeroes, use C<guestfs_fallocate64> instead."
17761 #: ../src/guestfs-actions.pod:6908
17762 msgid "guestfs_tune2fs_l"
17766 #: ../src/guestfs-actions.pod:6910
17770 " guestfs_tune2fs_l (guestfs_h *g,\n"
17771 " const char *device);\n"
17776 #: ../src/guestfs-actions.pod:6914 ../fish/guestfish-actions.pod:4604
17778 "This returns the contents of the ext2, ext3 or ext4 filesystem superblock on "
17783 #: ../src/guestfs-actions.pod:6917 ../fish/guestfish-actions.pod:4607
17785 "It is the same as running C<tune2fs -l device>. See L<tune2fs(8)> manpage "
17786 "for more details. The list of fields returned isn't clearly defined, and "
17787 "depends on both the version of C<tune2fs> that libguestfs was built against, "
17788 "and the filesystem itself."
17792 #: ../src/guestfs-actions.pod:6930
17793 msgid "guestfs_txz_in"
17797 #: ../src/guestfs-actions.pod:6932
17801 " guestfs_txz_in (guestfs_h *g,\n"
17802 " const char *tarball,\n"
17803 " const char *directory);\n"
17808 #: ../src/guestfs-actions.pod:6937 ../fish/guestfish-actions.pod:4616
17810 "This command uploads and unpacks local file C<tarball> (an I<xz compressed> "
17811 "tar file) into C<directory>."
17815 #: ../src/guestfs-actions.pod:6944
17816 msgid "guestfs_txz_out"
17820 #: ../src/guestfs-actions.pod:6946
17824 " guestfs_txz_out (guestfs_h *g,\n"
17825 " const char *directory,\n"
17826 " const char *tarball);\n"
17831 #: ../src/guestfs-actions.pod:6951 ../fish/guestfish-actions.pod:4625
17833 "This command packs the contents of C<directory> and downloads it to local "
17834 "file C<tarball> (as an xz compressed tar archive)."
17838 #: ../src/guestfs-actions.pod:6958
17839 msgid "guestfs_umask"
17843 #: ../src/guestfs-actions.pod:6960
17847 " guestfs_umask (guestfs_h *g,\n"
17853 #: ../src/guestfs-actions.pod:6964 ../fish/guestfish-actions.pod:4634
17855 "This function sets the mask used for creating new files and device nodes to "
17860 #: ../src/guestfs-actions.pod:6967 ../fish/guestfish-actions.pod:4637
17862 "Typical umask values would be C<022> which creates new files with "
17863 "permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and C<002> which creates "
17864 "new files with permissions like \"-rw-rw-r--\" or \"-rwxrwxr-x\"."
17868 #: ../src/guestfs-actions.pod:6972 ../fish/guestfish-actions.pod:4642
17870 "The default umask is C<022>. This is important because it means that "
17871 "directories and device nodes will be created with C<0644> or C<0755> mode "
17872 "even if you specify C<0777>."
17876 #: ../src/guestfs-actions.pod:6976
17878 "See also C<guestfs_get_umask>, L<umask(2)>, C<guestfs_mknod>, "
17879 "C<guestfs_mkdir>."
17883 #: ../src/guestfs-actions.pod:6979 ../fish/guestfish-actions.pod:4649
17884 msgid "This call returns the previous umask."
17888 #: ../src/guestfs-actions.pod:6985
17889 msgid "guestfs_umount"
17893 #: ../src/guestfs-actions.pod:6987
17897 " guestfs_umount (guestfs_h *g,\n"
17898 " const char *pathordevice);\n"
17903 #: ../src/guestfs-actions.pod:6991 ../fish/guestfish-actions.pod:4657
17905 "This unmounts the given filesystem. The filesystem may be specified either "
17906 "by its mountpoint (path) or the device which contains the filesystem."
17910 #: ../src/guestfs-actions.pod:6999
17911 msgid "guestfs_umount_all"
17915 #: ../src/guestfs-actions.pod:7001
17919 " guestfs_umount_all (guestfs_h *g);\n"
17924 #: ../src/guestfs-actions.pod:7004 ../fish/guestfish-actions.pod:4667
17925 msgid "This unmounts all mounted filesystems."
17929 #: ../src/guestfs-actions.pod:7006 ../fish/guestfish-actions.pod:4669
17930 msgid "Some internal mounts are not unmounted by this call."
17934 #: ../src/guestfs-actions.pod:7012
17935 msgid "guestfs_upload"
17939 #: ../src/guestfs-actions.pod:7014
17943 " guestfs_upload (guestfs_h *g,\n"
17944 " const char *filename,\n"
17945 " const char *remotefilename);\n"
17950 #: ../src/guestfs-actions.pod:7019 ../src/guestfs-actions.pod:7043
17951 #: ../fish/guestfish-actions.pod:4675 ../fish/guestfish-actions.pod:4688
17952 msgid "Upload local file C<filename> to C<remotefilename> on the filesystem."
17956 #: ../src/guestfs-actions.pod:7024
17957 msgid "See also C<guestfs_download>."
17961 #: ../src/guestfs-actions.pod:7035
17962 msgid "guestfs_upload_offset"
17966 #: ../src/guestfs-actions.pod:7037
17970 " guestfs_upload_offset (guestfs_h *g,\n"
17971 " const char *filename,\n"
17972 " const char *remotefilename,\n"
17973 " int64_t offset);\n"
17978 #: ../src/guestfs-actions.pod:7046 ../fish/guestfish-actions.pod:4691
17980 "C<remotefilename> is overwritten starting at the byte C<offset> specified. "
17981 "The intention is to overwrite parts of existing files or devices, although "
17982 "if a non-existant file is specified then it is created with a \"hole\" "
17983 "before C<offset>. The size of the data written is implicit in the size of "
17984 "the source C<filename>."
17988 #: ../src/guestfs-actions.pod:7053
17990 "Note that there is no limit on the amount of data that can be uploaded with "
17991 "this call, unlike with C<guestfs_pwrite>, and this call always writes the "
17992 "full amount unless an error occurs."
17996 #: ../src/guestfs-actions.pod:7058
17997 msgid "See also C<guestfs_upload>, C<guestfs_pwrite>."
18001 #: ../src/guestfs-actions.pod:7069
18002 msgid "guestfs_utimens"
18006 #: ../src/guestfs-actions.pod:7071
18010 " guestfs_utimens (guestfs_h *g,\n"
18011 " const char *path,\n"
18012 " int64_t atsecs,\n"
18013 " int64_t atnsecs,\n"
18014 " int64_t mtsecs,\n"
18015 " int64_t mtnsecs);\n"
18020 #: ../src/guestfs-actions.pod:7079 ../fish/guestfish-actions.pod:4711
18021 msgid "This command sets the timestamps of a file with nanosecond precision."
18025 #: ../src/guestfs-actions.pod:7082 ../fish/guestfish-actions.pod:4714
18027 "C<atsecs, atnsecs> are the last access time (atime) in secs and nanoseconds "
18032 #: ../src/guestfs-actions.pod:7085 ../fish/guestfish-actions.pod:4717
18034 "C<mtsecs, mtnsecs> are the last modification time (mtime) in secs and "
18035 "nanoseconds from the epoch."
18039 #: ../src/guestfs-actions.pod:7088 ../fish/guestfish-actions.pod:4720
18041 "If the C<*nsecs> field contains the special value C<-1> then the "
18042 "corresponding timestamp is set to the current time. (The C<*secs> field is "
18043 "ignored in this case)."
18047 #: ../src/guestfs-actions.pod:7092 ../fish/guestfish-actions.pod:4724
18049 "If the C<*nsecs> field contains the special value C<-2> then the "
18050 "corresponding timestamp is left unchanged. (The C<*secs> field is ignored "
18055 #: ../src/guestfs-actions.pod:7100 ../src/guestfs-structs.pod:175
18056 msgid "guestfs_version"
18060 #: ../src/guestfs-actions.pod:7102
18063 " struct guestfs_version *\n"
18064 " guestfs_version (guestfs_h *g);\n"
18069 #: ../src/guestfs-actions.pod:7105 ../fish/guestfish-actions.pod:4732
18071 "Return the libguestfs version number that the program is linked against."
18075 #: ../src/guestfs-actions.pod:7108 ../fish/guestfish-actions.pod:4735
18077 "Note that because of dynamic linking this is not necessarily the version of "
18078 "libguestfs that you compiled against. You can compile the program, and then "
18079 "at runtime dynamically link against a completely different C<libguestfs.so> "
18084 #: ../src/guestfs-actions.pod:7113 ../fish/guestfish-actions.pod:4740
18086 "This call was added in version C<1.0.58>. In previous versions of "
18087 "libguestfs there was no way to get the version number. From C code you can "
18088 "use dynamic linker functions to find out if this symbol exists (if it "
18089 "doesn't, then it's an earlier version)."
18093 #: ../src/guestfs-actions.pod:7119 ../fish/guestfish-actions.pod:4746
18095 "The call returns a structure with four elements. The first three (C<major>, "
18096 "C<minor> and C<release>) are numbers and correspond to the usual version "
18097 "triplet. The fourth element (C<extra>) is a string and is normally empty, "
18098 "but may be used for distro-specific information."
18102 #: ../src/guestfs-actions.pod:7125 ../fish/guestfish-actions.pod:4752
18104 "To construct the original version string: C<$major.$minor.$release$extra>"
18108 #: ../src/guestfs-actions.pod:7128 ../fish/guestfish-actions.pod:4755
18109 msgid "See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>."
18113 #: ../src/guestfs-actions.pod:7130
18115 "I<Note:> Don't use this call to test for availability of features. In "
18116 "enterprise distributions we backport features from later versions into "
18117 "earlier versions, making this an unreliable way to test for features. Use "
18118 "C<guestfs_available> instead."
18122 #: ../src/guestfs-actions.pod:7136
18124 "This function returns a C<struct guestfs_version *>, or NULL if there was an "
18125 "error. I<The caller must call C<guestfs_free_version> after use>."
18129 #: ../src/guestfs-actions.pod:7140
18130 msgid "(Added in 1.0.58)"
18134 #: ../src/guestfs-actions.pod:7142
18135 msgid "guestfs_vfs_label"
18139 #: ../src/guestfs-actions.pod:7144
18143 " guestfs_vfs_label (guestfs_h *g,\n"
18144 " const char *device);\n"
18149 #: ../src/guestfs-actions.pod:7148 ../fish/guestfish-actions.pod:4767
18150 msgid "This returns the filesystem label of the filesystem on C<device>."
18154 #: ../src/guestfs-actions.pod:7151 ../fish/guestfish-actions.pod:4770
18155 msgid "If the filesystem is unlabeled, this returns the empty string."
18159 #: ../src/guestfs-actions.pod:7153
18160 msgid "To find a filesystem from the label, use C<guestfs_findfs_label>."
18164 #: ../src/guestfs-actions.pod:7158 ../src/guestfs-actions.pod:7195
18165 msgid "(Added in 1.3.18)"
18169 #: ../src/guestfs-actions.pod:7160
18170 msgid "guestfs_vfs_type"
18174 #: ../src/guestfs-actions.pod:7162
18178 " guestfs_vfs_type (guestfs_h *g,\n"
18179 " const char *device);\n"
18184 #: ../src/guestfs-actions.pod:7166 ../fish/guestfish-actions.pod:4778
18186 "This command gets the filesystem type corresponding to the filesystem on "
18191 #: ../src/guestfs-actions.pod:7169 ../fish/guestfish-actions.pod:4781
18193 "For most filesystems, the result is the name of the Linux VFS module which "
18194 "would be used to mount this filesystem if you mounted it without specifying "
18195 "the filesystem type. For example a string such as C<ext3> or C<ntfs>."
18199 #: ../src/guestfs-actions.pod:7179
18200 msgid "guestfs_vfs_uuid"
18204 #: ../src/guestfs-actions.pod:7181
18208 " guestfs_vfs_uuid (guestfs_h *g,\n"
18209 " const char *device);\n"
18214 #: ../src/guestfs-actions.pod:7185 ../fish/guestfish-actions.pod:4790
18215 msgid "This returns the filesystem UUID of the filesystem on C<device>."
18219 #: ../src/guestfs-actions.pod:7188 ../fish/guestfish-actions.pod:4793
18220 msgid "If the filesystem does not have a UUID, this returns the empty string."
18224 #: ../src/guestfs-actions.pod:7190
18225 msgid "To find a filesystem from the UUID, use C<guestfs_findfs_uuid>."
18229 #: ../src/guestfs-actions.pod:7197
18230 msgid "guestfs_vg_activate"
18234 #: ../src/guestfs-actions.pod:7199
18238 " guestfs_vg_activate (guestfs_h *g,\n"
18240 " char *const *volgroups);\n"
18245 #: ../src/guestfs-actions.pod:7204 ../fish/guestfish-actions.pod:4801
18247 "This command activates or (if C<activate> is false) deactivates all logical "
18248 "volumes in the listed volume groups C<volgroups>. If activated, then they "
18249 "are made known to the kernel, ie. they appear as C</dev/mapper> devices. If "
18250 "deactivated, then those devices disappear."
18254 #: ../src/guestfs-actions.pod:7210 ../fish/guestfish-actions.pod:4807
18255 msgid "This command is the same as running C<vgchange -a y|n volgroups...>"
18259 #: ../src/guestfs-actions.pod:7212 ../fish/guestfish-actions.pod:4809
18261 "Note that if C<volgroups> is an empty list then B<all> volume groups are "
18262 "activated or deactivated."
18266 #: ../src/guestfs-actions.pod:7219
18267 msgid "guestfs_vg_activate_all"
18271 #: ../src/guestfs-actions.pod:7221
18275 " guestfs_vg_activate_all (guestfs_h *g,\n"
18276 " int activate);\n"
18281 #: ../src/guestfs-actions.pod:7225 ../fish/guestfish-actions.pod:4816
18283 "This command activates or (if C<activate> is false) deactivates all logical "
18284 "volumes in all volume groups. If activated, then they are made known to the "
18285 "kernel, ie. they appear as C</dev/mapper> devices. If deactivated, then "
18286 "those devices disappear."
18290 #: ../src/guestfs-actions.pod:7231 ../fish/guestfish-actions.pod:4822
18291 msgid "This command is the same as running C<vgchange -a y|n>"
18295 #: ../src/guestfs-actions.pod:7237
18296 msgid "guestfs_vgcreate"
18300 #: ../src/guestfs-actions.pod:7239
18304 " guestfs_vgcreate (guestfs_h *g,\n"
18305 " const char *volgroup,\n"
18306 " char *const *physvols);\n"
18311 #: ../src/guestfs-actions.pod:7244 ../fish/guestfish-actions.pod:4828
18313 "This creates an LVM volume group called C<volgroup> from the non-empty list "
18314 "of physical volumes C<physvols>."
18318 #: ../src/guestfs-actions.pod:7251
18319 msgid "guestfs_vglvuuids"
18323 #: ../src/guestfs-actions.pod:7253
18327 " guestfs_vglvuuids (guestfs_h *g,\n"
18328 " const char *vgname);\n"
18333 #: ../src/guestfs-actions.pod:7257 ../fish/guestfish-actions.pod:4835
18335 "Given a VG called C<vgname>, this returns the UUIDs of all the logical "
18336 "volumes created in this volume group."
18340 #: ../src/guestfs-actions.pod:7260
18342 "You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid> calls to "
18343 "associate logical volumes and volume groups."
18347 #: ../src/guestfs-actions.pod:7263
18348 msgid "See also C<guestfs_vgpvuuids>."
18352 #: ../src/guestfs-actions.pod:7271
18353 msgid "guestfs_vgpvuuids"
18357 #: ../src/guestfs-actions.pod:7273
18361 " guestfs_vgpvuuids (guestfs_h *g,\n"
18362 " const char *vgname);\n"
18367 #: ../src/guestfs-actions.pod:7277 ../fish/guestfish-actions.pod:4847
18369 "Given a VG called C<vgname>, this returns the UUIDs of all the physical "
18370 "volumes that this volume group resides on."
18374 #: ../src/guestfs-actions.pod:7280
18376 "You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid> calls to "
18377 "associate physical volumes and volume groups."
18381 #: ../src/guestfs-actions.pod:7283
18382 msgid "See also C<guestfs_vglvuuids>."
18386 #: ../src/guestfs-actions.pod:7291
18387 msgid "guestfs_vgremove"
18391 #: ../src/guestfs-actions.pod:7293
18395 " guestfs_vgremove (guestfs_h *g,\n"
18396 " const char *vgname);\n"
18401 #: ../src/guestfs-actions.pod:7297 ../fish/guestfish-actions.pod:4859
18402 msgid "Remove an LVM volume group C<vgname>, (for example C<VG>)."
18406 #: ../src/guestfs-actions.pod:7299 ../fish/guestfish-actions.pod:4861
18408 "This also forcibly removes all logical volumes in the volume group (if any)."
18412 #: ../src/guestfs-actions.pod:7306
18413 msgid "guestfs_vgrename"
18417 #: ../src/guestfs-actions.pod:7308
18421 " guestfs_vgrename (guestfs_h *g,\n"
18422 " const char *volgroup,\n"
18423 " const char *newvolgroup);\n"
18428 #: ../src/guestfs-actions.pod:7313 ../fish/guestfish-actions.pod:4868
18429 msgid "Rename a volume group C<volgroup> with the new name C<newvolgroup>."
18433 #: ../src/guestfs-actions.pod:7319
18434 msgid "guestfs_vgs"
18438 #: ../src/guestfs-actions.pod:7321
18442 " guestfs_vgs (guestfs_h *g);\n"
18447 #: ../src/guestfs-actions.pod:7324 ../fish/guestfish-actions.pod:4874
18449 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
18454 #: ../src/guestfs-actions.pod:7327 ../fish/guestfish-actions.pod:4877
18456 "This returns a list of just the volume group names that were detected (eg. "
18461 #: ../src/guestfs-actions.pod:7330
18462 msgid "See also C<guestfs_vgs_full>."
18466 #: ../src/guestfs-actions.pod:7338
18467 msgid "guestfs_vgs_full"
18471 #: ../src/guestfs-actions.pod:7340
18474 " struct guestfs_lvm_vg_list *\n"
18475 " guestfs_vgs_full (guestfs_h *g);\n"
18480 #: ../src/guestfs-actions.pod:7343 ../fish/guestfish-actions.pod:4886
18482 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
18483 "> command. The \"full\" version includes all fields."
18487 #: ../src/guestfs-actions.pod:7346
18489 "This function returns a C<struct guestfs_lvm_vg_list *>, or NULL if there "
18490 "was an error. I<The caller must call C<guestfs_free_lvm_vg_list> after use>."
18494 #: ../src/guestfs-actions.pod:7352
18495 msgid "guestfs_vgscan"
18499 #: ../src/guestfs-actions.pod:7354
18503 " guestfs_vgscan (guestfs_h *g);\n"
18508 #: ../src/guestfs-actions.pod:7357 ../fish/guestfish-actions.pod:4893
18510 "This rescans all block devices and rebuilds the list of LVM physical "
18511 "volumes, volume groups and logical volumes."
18515 #: ../src/guestfs-actions.pod:7364
18516 msgid "guestfs_vguuid"
18520 #: ../src/guestfs-actions.pod:7366
18524 " guestfs_vguuid (guestfs_h *g,\n"
18525 " const char *vgname);\n"
18530 #: ../src/guestfs-actions.pod:7370 ../fish/guestfish-actions.pod:4900
18531 msgid "This command returns the UUID of the LVM VG named C<vgname>."
18535 #: ../src/guestfs-actions.pod:7377
18536 msgid "guestfs_wait_ready"
18540 #: ../src/guestfs-actions.pod:7379
18544 " guestfs_wait_ready (guestfs_h *g);\n"
18549 #: ../src/guestfs-actions.pod:7382
18550 msgid "This function is a no op."
18554 #: ../src/guestfs-actions.pod:7384
18556 "In versions of the API E<lt> 1.0.71 you had to call this function just after "
18557 "calling C<guestfs_launch> to wait for the launch to complete. However this "
18558 "is no longer necessary because C<guestfs_launch> now does the waiting."
18562 #: ../src/guestfs-actions.pod:7389
18564 "If you see any calls to this function in code then you can just remove them, "
18565 "unless you want to retain compatibility with older versions of the API."
18569 #: ../src/guestfs-actions.pod:7395
18571 "This function is deprecated. In new code, use the C<launch> call instead."
18575 #: ../src/guestfs-actions.pod:7404
18576 msgid "guestfs_wc_c"
18580 #: ../src/guestfs-actions.pod:7406
18584 " guestfs_wc_c (guestfs_h *g,\n"
18585 " const char *path);\n"
18590 #: ../src/guestfs-actions.pod:7410 ../fish/guestfish-actions.pod:4906
18592 "This command counts the characters in a file, using the C<wc -c> external "
18597 #: ../src/guestfs-actions.pod:7417
18598 msgid "guestfs_wc_l"
18602 #: ../src/guestfs-actions.pod:7419
18606 " guestfs_wc_l (guestfs_h *g,\n"
18607 " const char *path);\n"
18612 #: ../src/guestfs-actions.pod:7423 ../fish/guestfish-actions.pod:4913
18614 "This command counts the lines in a file, using the C<wc -l> external command."
18618 #: ../src/guestfs-actions.pod:7430
18619 msgid "guestfs_wc_w"
18623 #: ../src/guestfs-actions.pod:7432
18627 " guestfs_wc_w (guestfs_h *g,\n"
18628 " const char *path);\n"
18633 #: ../src/guestfs-actions.pod:7436 ../fish/guestfish-actions.pod:4920
18635 "This command counts the words in a file, using the C<wc -w> external command."
18639 #: ../src/guestfs-actions.pod:7443
18640 msgid "guestfs_write"
18644 #: ../src/guestfs-actions.pod:7445
18648 " guestfs_write (guestfs_h *g,\n"
18649 " const char *path,\n"
18650 " const char *content,\n"
18651 " size_t content_size);\n"
18656 #: ../src/guestfs-actions.pod:7451 ../fish/guestfish-actions.pod:4927
18658 "This call creates a file called C<path>. The content of the file is the "
18659 "string C<content> (which can contain any 8 bit data)."
18663 #: ../src/guestfs-actions.pod:7461
18664 msgid "guestfs_write_file"
18668 #: ../src/guestfs-actions.pod:7463
18672 " guestfs_write_file (guestfs_h *g,\n"
18673 " const char *path,\n"
18674 " const char *content,\n"
18680 #: ../src/guestfs-actions.pod:7469 ../fish/guestfish-actions.pod:4937
18682 "This call creates a file called C<path>. The contents of the file is the "
18683 "string C<content> (which can contain any 8 bit data), with length C<size>."
18687 #: ../src/guestfs-actions.pod:7473 ../fish/guestfish-actions.pod:4941
18689 "As a special case, if C<size> is C<0> then the length is calculated using "
18690 "C<strlen> (so in this case the content cannot contain embedded ASCII NULs)."
18694 #: ../src/guestfs-actions.pod:7477 ../fish/guestfish-actions.pod:4945
18696 "I<NB.> Owing to a bug, writing content containing ASCII NUL characters does "
18697 "I<not> work, even if the length is specified."
18701 #: ../src/guestfs-actions.pod:7485 ../fish/guestfish-actions.pod:4951
18703 "This function is deprecated. In new code, use the C<write> call instead."
18707 #: ../src/guestfs-actions.pod:7494
18708 msgid "guestfs_zegrep"
18712 #: ../src/guestfs-actions.pod:7496
18716 " guestfs_zegrep (guestfs_h *g,\n"
18717 " const char *regex,\n"
18718 " const char *path);\n"
18723 #: ../src/guestfs-actions.pod:7501 ../fish/guestfish-actions.pod:4962
18725 "This calls the external C<zegrep> program and returns the matching lines."
18729 #: ../src/guestfs-actions.pod:7513
18730 msgid "guestfs_zegrepi"
18734 #: ../src/guestfs-actions.pod:7515
18738 " guestfs_zegrepi (guestfs_h *g,\n"
18739 " const char *regex,\n"
18740 " const char *path);\n"
18745 #: ../src/guestfs-actions.pod:7520 ../fish/guestfish-actions.pod:4972
18747 "This calls the external C<zegrep -i> program and returns the matching lines."
18751 #: ../src/guestfs-actions.pod:7532
18752 msgid "guestfs_zero"
18756 #: ../src/guestfs-actions.pod:7534
18760 " guestfs_zero (guestfs_h *g,\n"
18761 " const char *device);\n"
18766 #: ../src/guestfs-actions.pod:7538 ../fish/guestfish-actions.pod:4982
18767 msgid "This command writes zeroes over the first few blocks of C<device>."
18771 #: ../src/guestfs-actions.pod:7540 ../fish/guestfish-actions.pod:4984
18773 "How many blocks are zeroed isn't specified (but it's I<not> enough to "
18774 "securely wipe the device). It should be sufficient to remove any partition "
18775 "tables, filesystem superblocks and so on."
18779 #: ../src/guestfs-actions.pod:7544
18781 "See also: C<guestfs_zero_device>, C<guestfs_scrub_device>, "
18782 "C<guestfs_is_zero_device>"
18786 #: ../src/guestfs-actions.pod:7556
18787 msgid "guestfs_zero_device"
18791 #: ../src/guestfs-actions.pod:7558
18795 " guestfs_zero_device (guestfs_h *g,\n"
18796 " const char *device);\n"
18801 #: ../src/guestfs-actions.pod:7562
18803 "This command writes zeroes over the entire C<device>. Compare with "
18804 "C<guestfs_zero> which just zeroes the first few blocks of a device."
18808 #: ../src/guestfs-actions.pod:7576
18809 msgid "(Added in 1.3.1)"
18813 #: ../src/guestfs-actions.pod:7578
18814 msgid "guestfs_zerofree"
18818 #: ../src/guestfs-actions.pod:7580
18822 " guestfs_zerofree (guestfs_h *g,\n"
18823 " const char *device);\n"
18828 #: ../src/guestfs-actions.pod:7584 ../fish/guestfish-actions.pod:5006
18830 "This runs the I<zerofree> program on C<device>. This program claims to zero "
18831 "unused inodes and disk blocks on an ext2/3 filesystem, thus making it "
18832 "possible to compress the filesystem more effectively."
18836 #: ../src/guestfs-actions.pod:7589 ../fish/guestfish-actions.pod:5011
18837 msgid "You should B<not> run this program if the filesystem is mounted."
18841 #: ../src/guestfs-actions.pod:7592 ../fish/guestfish-actions.pod:5014
18843 "It is possible that using this program can damage the filesystem or data on "
18848 #: ../src/guestfs-actions.pod:7599
18849 msgid "guestfs_zfgrep"
18853 #: ../src/guestfs-actions.pod:7601
18857 " guestfs_zfgrep (guestfs_h *g,\n"
18858 " const char *pattern,\n"
18859 " const char *path);\n"
18864 #: ../src/guestfs-actions.pod:7606 ../fish/guestfish-actions.pod:5021
18866 "This calls the external C<zfgrep> program and returns the matching lines."
18870 #: ../src/guestfs-actions.pod:7618
18871 msgid "guestfs_zfgrepi"
18875 #: ../src/guestfs-actions.pod:7620
18879 " guestfs_zfgrepi (guestfs_h *g,\n"
18880 " const char *pattern,\n"
18881 " const char *path);\n"
18886 #: ../src/guestfs-actions.pod:7625 ../fish/guestfish-actions.pod:5031
18888 "This calls the external C<zfgrep -i> program and returns the matching lines."
18892 #: ../src/guestfs-actions.pod:7637
18893 msgid "guestfs_zfile"
18897 #: ../src/guestfs-actions.pod:7639
18901 " guestfs_zfile (guestfs_h *g,\n"
18902 " const char *meth,\n"
18903 " const char *path);\n"
18908 #: ../src/guestfs-actions.pod:7644 ../fish/guestfish-actions.pod:5041
18910 "This command runs C<file> after first decompressing C<path> using C<method>."
18914 #: ../src/guestfs-actions.pod:7647 ../fish/guestfish-actions.pod:5044
18915 msgid "C<method> must be one of C<gzip>, C<compress> or C<bzip2>."
18919 #: ../src/guestfs-actions.pod:7649
18921 "Since 1.0.63, use C<guestfs_file> instead which can now process compressed "
18926 #: ../src/guestfs-actions.pod:7655 ../fish/guestfish-actions.pod:5049
18928 "This function is deprecated. In new code, use the C<file> call instead."
18932 #: ../src/guestfs-actions.pod:7664
18933 msgid "guestfs_zgrep"
18937 #: ../src/guestfs-actions.pod:7666
18941 " guestfs_zgrep (guestfs_h *g,\n"
18942 " const char *regex,\n"
18943 " const char *path);\n"
18948 #: ../src/guestfs-actions.pod:7671 ../fish/guestfish-actions.pod:5060
18950 "This calls the external C<zgrep> program and returns the matching lines."
18954 #: ../src/guestfs-actions.pod:7683
18955 msgid "guestfs_zgrepi"
18959 #: ../src/guestfs-actions.pod:7685
18963 " guestfs_zgrepi (guestfs_h *g,\n"
18964 " const char *regex,\n"
18965 " const char *path);\n"
18970 #: ../src/guestfs-actions.pod:7690 ../fish/guestfish-actions.pod:5070
18972 "This calls the external C<zgrep -i> program and returns the matching lines."
18976 #: ../src/guestfs-availability.pod:3
18981 #: ../src/guestfs-availability.pod:5
18983 "The following functions: L</guestfs_aug_clear> L</guestfs_aug_close> L</"
18984 "guestfs_aug_defnode> L</guestfs_aug_defvar> L</guestfs_aug_get> L</"
18985 "guestfs_aug_init> L</guestfs_aug_insert> L</guestfs_aug_load> L</"
18986 "guestfs_aug_ls> L</guestfs_aug_match> L</guestfs_aug_mv> L</guestfs_aug_rm> "
18987 "L</guestfs_aug_save> L</guestfs_aug_set>"
18991 #: ../src/guestfs-availability.pod:21
18996 #: ../src/guestfs-availability.pod:23
18998 "The following functions: L</guestfs_inotify_add_watch> L</"
18999 "guestfs_inotify_close> L</guestfs_inotify_files> L</guestfs_inotify_init> L</"
19000 "guestfs_inotify_read> L</guestfs_inotify_rm_watch>"
19004 #: ../src/guestfs-availability.pod:31
19005 msgid "B<linuxfsuuid>"
19009 #: ../src/guestfs-availability.pod:33
19011 "The following functions: L</guestfs_mke2fs_JU> L</guestfs_mke2journal_U> L</"
19012 "guestfs_mkswap_U> L</guestfs_swapoff_uuid> L</guestfs_swapon_uuid>"
19016 #: ../src/guestfs-availability.pod:40
19017 msgid "B<linuxmodules>"
19021 #: ../src/guestfs-availability.pod:42
19022 msgid "The following functions: L</guestfs_modprobe>"
19026 #: ../src/guestfs-availability.pod:45
19027 msgid "B<linuxxattrs>"
19031 #: ../src/guestfs-availability.pod:47
19033 "The following functions: L</guestfs_getxattr> L</guestfs_getxattrs> L</"
19034 "guestfs_lgetxattr> L</guestfs_lgetxattrs> L</guestfs_lremovexattr> L</"
19035 "guestfs_lsetxattr> L</guestfs_lxattrlist> L</guestfs_removexattr> L</"
19036 "guestfs_setxattr>"
19040 #: ../src/guestfs-availability.pod:58
19045 #: ../src/guestfs-availability.pod:60
19047 "The following functions: L</guestfs_luks_add_key> L</guestfs_luks_close> L</"
19048 "guestfs_luks_format> L</guestfs_luks_format_cipher> L</"
19049 "guestfs_luks_kill_slot> L</guestfs_luks_open> L</guestfs_luks_open_ro>"
19053 #: ../src/guestfs-availability.pod:69
19058 #: ../src/guestfs-availability.pod:71
19060 "The following functions: L</guestfs_is_lv> L</guestfs_lvcreate> L</"
19061 "guestfs_lvm_remove_all> L</guestfs_lvm_set_filter> L</guestfs_lvremove> L</"
19062 "guestfs_lvresize> L</guestfs_lvresize_free> L</guestfs_lvs> L</"
19063 "guestfs_lvs_full> L</guestfs_pvcreate> L</guestfs_pvremove> L</"
19064 "guestfs_pvresize> L</guestfs_pvresize_size> L</guestfs_pvs> L</"
19065 "guestfs_pvs_full> L</guestfs_vg_activate> L</guestfs_vg_activate_all> L</"
19066 "guestfs_vgcreate> L</guestfs_vgremove> L</guestfs_vgs> L</guestfs_vgs_full>"
19070 #: ../src/guestfs-availability.pod:94
19075 #: ../src/guestfs-availability.pod:96
19077 "The following functions: L</guestfs_mkfifo> L</guestfs_mknod> L</"
19078 "guestfs_mknod_b> L</guestfs_mknod_c>"
19082 #: ../src/guestfs-availability.pod:102
19087 #: ../src/guestfs-availability.pod:104
19088 msgid "The following functions: L</guestfs_ntfs_3g_probe>"
19092 #: ../src/guestfs-availability.pod:107
19093 msgid "B<ntfsprogs>"
19097 #: ../src/guestfs-availability.pod:109
19099 "The following functions: L</guestfs_ntfsresize> L</guestfs_ntfsresize_size>"
19103 #: ../src/guestfs-availability.pod:113
19104 msgid "B<realpath>"
19108 #: ../src/guestfs-availability.pod:115
19109 msgid "The following functions: L</guestfs_realpath>"
19113 #: ../src/guestfs-availability.pod:118
19118 #: ../src/guestfs-availability.pod:120
19120 "The following functions: L</guestfs_scrub_device> L</guestfs_scrub_file> L</"
19121 "guestfs_scrub_freespace>"
19125 #: ../src/guestfs-availability.pod:125
19130 #: ../src/guestfs-availability.pod:127
19131 msgid "The following functions: L</guestfs_getcon> L</guestfs_setcon>"
19135 #: ../src/guestfs-availability.pod:131
19140 #: ../src/guestfs-availability.pod:133
19141 msgid "The following functions: L</guestfs_txz_in> L</guestfs_txz_out>"
19145 #: ../src/guestfs-availability.pod:137
19146 msgid "B<zerofree>"
19150 #: ../src/guestfs-availability.pod:139
19151 msgid "The following functions: L</guestfs_zerofree>"
19155 #: ../src/guestfs-structs.pod:1
19156 msgid "guestfs_int_bool"
19160 #: ../src/guestfs-structs.pod:3
19163 " struct guestfs_int_bool {\n"
19171 #: ../src/guestfs-structs.pod:8
19174 " struct guestfs_int_bool_list {\n"
19175 " uint32_t len; /* Number of elements in list. */\n"
19176 " struct guestfs_int_bool *val; /* Elements. */\n"
19182 #: ../src/guestfs-structs.pod:13
19185 " void guestfs_free_int_bool (struct guestfs_free_int_bool *);\n"
19186 " void guestfs_free_int_bool_list (struct guestfs_free_int_bool_list *);\n"
19191 #: ../src/guestfs-structs.pod:16
19192 msgid "guestfs_lvm_pv"
19196 #: ../src/guestfs-structs.pod:18
19199 " struct guestfs_lvm_pv {\n"
19200 " char *pv_name;\n"
19201 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
19202 " char pv_uuid[32];\n"
19204 " uint64_t pv_size;\n"
19205 " uint64_t dev_size;\n"
19206 " uint64_t pv_free;\n"
19207 " uint64_t pv_used;\n"
19208 " char *pv_attr;\n"
19209 " int64_t pv_pe_count;\n"
19210 " int64_t pv_pe_alloc_count;\n"
19211 " char *pv_tags;\n"
19212 " uint64_t pe_start;\n"
19213 " int64_t pv_mda_count;\n"
19214 " uint64_t pv_mda_free;\n"
19220 #: ../src/guestfs-structs.pod:36
19223 " struct guestfs_lvm_pv_list {\n"
19224 " uint32_t len; /* Number of elements in list. */\n"
19225 " struct guestfs_lvm_pv *val; /* Elements. */\n"
19231 #: ../src/guestfs-structs.pod:41
19234 " void guestfs_free_lvm_pv (struct guestfs_free_lvm_pv *);\n"
19235 " void guestfs_free_lvm_pv_list (struct guestfs_free_lvm_pv_list *);\n"
19240 #: ../src/guestfs-structs.pod:44
19241 msgid "guestfs_lvm_vg"
19245 #: ../src/guestfs-structs.pod:46
19248 " struct guestfs_lvm_vg {\n"
19249 " char *vg_name;\n"
19250 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
19251 " char vg_uuid[32];\n"
19253 " char *vg_attr;\n"
19254 " uint64_t vg_size;\n"
19255 " uint64_t vg_free;\n"
19256 " char *vg_sysid;\n"
19257 " uint64_t vg_extent_size;\n"
19258 " int64_t vg_extent_count;\n"
19259 " int64_t vg_free_count;\n"
19260 " int64_t max_lv;\n"
19261 " int64_t max_pv;\n"
19262 " int64_t pv_count;\n"
19263 " int64_t lv_count;\n"
19264 " int64_t snap_count;\n"
19265 " int64_t vg_seqno;\n"
19266 " char *vg_tags;\n"
19267 " int64_t vg_mda_count;\n"
19268 " uint64_t vg_mda_free;\n"
19274 #: ../src/guestfs-structs.pod:69
19277 " struct guestfs_lvm_vg_list {\n"
19278 " uint32_t len; /* Number of elements in list. */\n"
19279 " struct guestfs_lvm_vg *val; /* Elements. */\n"
19285 #: ../src/guestfs-structs.pod:74
19288 " void guestfs_free_lvm_vg (struct guestfs_free_lvm_vg *);\n"
19289 " void guestfs_free_lvm_vg_list (struct guestfs_free_lvm_vg_list *);\n"
19294 #: ../src/guestfs-structs.pod:77
19295 msgid "guestfs_lvm_lv"
19299 #: ../src/guestfs-structs.pod:79
19302 " struct guestfs_lvm_lv {\n"
19303 " char *lv_name;\n"
19304 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
19305 " char lv_uuid[32];\n"
19306 " char *lv_attr;\n"
19307 " int64_t lv_major;\n"
19308 " int64_t lv_minor;\n"
19309 " int64_t lv_kernel_major;\n"
19310 " int64_t lv_kernel_minor;\n"
19311 " uint64_t lv_size;\n"
19312 " int64_t seg_count;\n"
19314 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
19315 " float snap_percent;\n"
19316 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
19317 " float copy_percent;\n"
19318 " char *move_pv;\n"
19319 " char *lv_tags;\n"
19320 " char *mirror_log;\n"
19321 " char *modules;\n"
19327 #: ../src/guestfs-structs.pod:101
19330 " struct guestfs_lvm_lv_list {\n"
19331 " uint32_t len; /* Number of elements in list. */\n"
19332 " struct guestfs_lvm_lv *val; /* Elements. */\n"
19338 #: ../src/guestfs-structs.pod:106
19341 " void guestfs_free_lvm_lv (struct guestfs_free_lvm_lv *);\n"
19342 " void guestfs_free_lvm_lv_list (struct guestfs_free_lvm_lv_list *);\n"
19347 #: ../src/guestfs-structs.pod:111
19350 " struct guestfs_stat {\n"
19354 " int64_t nlink;\n"
19359 " int64_t blksize;\n"
19360 " int64_t blocks;\n"
19361 " int64_t atime;\n"
19362 " int64_t mtime;\n"
19363 " int64_t ctime;\n"
19369 #: ../src/guestfs-structs.pod:127
19372 " struct guestfs_stat_list {\n"
19373 " uint32_t len; /* Number of elements in list. */\n"
19374 " struct guestfs_stat *val; /* Elements. */\n"
19380 #: ../src/guestfs-structs.pod:132
19383 " void guestfs_free_stat (struct guestfs_free_stat *);\n"
19384 " void guestfs_free_stat_list (struct guestfs_free_stat_list *);\n"
19389 #: ../src/guestfs-structs.pod:137
19392 " struct guestfs_statvfs {\n"
19393 " int64_t bsize;\n"
19394 " int64_t frsize;\n"
19395 " int64_t blocks;\n"
19396 " int64_t bfree;\n"
19397 " int64_t bavail;\n"
19398 " int64_t files;\n"
19399 " int64_t ffree;\n"
19400 " int64_t favail;\n"
19403 " int64_t namemax;\n"
19409 #: ../src/guestfs-structs.pod:151
19412 " struct guestfs_statvfs_list {\n"
19413 " uint32_t len; /* Number of elements in list. */\n"
19414 " struct guestfs_statvfs *val; /* Elements. */\n"
19420 #: ../src/guestfs-structs.pod:156
19423 " void guestfs_free_statvfs (struct guestfs_free_statvfs *);\n"
19424 " void guestfs_free_statvfs_list (struct guestfs_free_statvfs_list *);\n"
19429 #: ../src/guestfs-structs.pod:159
19430 msgid "guestfs_dirent"
19434 #: ../src/guestfs-structs.pod:161
19437 " struct guestfs_dirent {\n"
19446 #: ../src/guestfs-structs.pod:167
19449 " struct guestfs_dirent_list {\n"
19450 " uint32_t len; /* Number of elements in list. */\n"
19451 " struct guestfs_dirent *val; /* Elements. */\n"
19457 #: ../src/guestfs-structs.pod:172
19460 " void guestfs_free_dirent (struct guestfs_free_dirent *);\n"
19461 " void guestfs_free_dirent_list (struct guestfs_free_dirent_list *);\n"
19466 #: ../src/guestfs-structs.pod:177
19469 " struct guestfs_version {\n"
19470 " int64_t major;\n"
19471 " int64_t minor;\n"
19472 " int64_t release;\n"
19479 #: ../src/guestfs-structs.pod:184
19482 " struct guestfs_version_list {\n"
19483 " uint32_t len; /* Number of elements in list. */\n"
19484 " struct guestfs_version *val; /* Elements. */\n"
19490 #: ../src/guestfs-structs.pod:189
19493 " void guestfs_free_version (struct guestfs_free_version *);\n"
19494 " void guestfs_free_version_list (struct guestfs_free_version_list *);\n"
19499 #: ../src/guestfs-structs.pod:192
19500 msgid "guestfs_xattr"
19504 #: ../src/guestfs-structs.pod:194
19507 " struct guestfs_xattr {\n"
19508 " char *attrname;\n"
19509 " /* The next two fields describe a byte array. */\n"
19510 " uint32_t attrval_len;\n"
19511 " char *attrval;\n"
19517 #: ../src/guestfs-structs.pod:201
19520 " struct guestfs_xattr_list {\n"
19521 " uint32_t len; /* Number of elements in list. */\n"
19522 " struct guestfs_xattr *val; /* Elements. */\n"
19528 #: ../src/guestfs-structs.pod:206
19531 " void guestfs_free_xattr (struct guestfs_free_xattr *);\n"
19532 " void guestfs_free_xattr_list (struct guestfs_free_xattr_list *);\n"
19537 #: ../src/guestfs-structs.pod:209
19538 msgid "guestfs_inotify_event"
19542 #: ../src/guestfs-structs.pod:211
19545 " struct guestfs_inotify_event {\n"
19546 " int64_t in_wd;\n"
19547 " uint32_t in_mask;\n"
19548 " uint32_t in_cookie;\n"
19549 " char *in_name;\n"
19555 #: ../src/guestfs-structs.pod:218
19558 " struct guestfs_inotify_event_list {\n"
19559 " uint32_t len; /* Number of elements in list. */\n"
19560 " struct guestfs_inotify_event *val; /* Elements. */\n"
19566 #: ../src/guestfs-structs.pod:223
19569 " void guestfs_free_inotify_event (struct guestfs_free_inotify_event *);\n"
19570 " void guestfs_free_inotify_event_list (struct guestfs_free_inotify_event_list *);\n"
19575 #: ../src/guestfs-structs.pod:226
19576 msgid "guestfs_partition"
19580 #: ../src/guestfs-structs.pod:228
19583 " struct guestfs_partition {\n"
19584 " int32_t part_num;\n"
19585 " uint64_t part_start;\n"
19586 " uint64_t part_end;\n"
19587 " uint64_t part_size;\n"
19593 #: ../src/guestfs-structs.pod:235
19596 " struct guestfs_partition_list {\n"
19597 " uint32_t len; /* Number of elements in list. */\n"
19598 " struct guestfs_partition *val; /* Elements. */\n"
19604 #: ../src/guestfs-structs.pod:240
19607 " void guestfs_free_partition (struct guestfs_free_partition *);\n"
19608 " void guestfs_free_partition_list (struct guestfs_free_partition_list *);\n"
19613 #: ../src/guestfs-structs.pod:243
19614 msgid "guestfs_application"
19618 #: ../src/guestfs-structs.pod:245
19621 " struct guestfs_application {\n"
19622 " char *app_name;\n"
19623 " char *app_display_name;\n"
19624 " int32_t app_epoch;\n"
19625 " char *app_version;\n"
19626 " char *app_release;\n"
19627 " char *app_install_path;\n"
19628 " char *app_trans_path;\n"
19629 " char *app_publisher;\n"
19630 " char *app_url;\n"
19631 " char *app_source_package;\n"
19632 " char *app_summary;\n"
19633 " char *app_description;\n"
19639 #: ../src/guestfs-structs.pod:260
19642 " struct guestfs_application_list {\n"
19643 " uint32_t len; /* Number of elements in list. */\n"
19644 " struct guestfs_application *val; /* Elements. */\n"
19650 #: ../src/guestfs-structs.pod:265
19653 " void guestfs_free_application (struct guestfs_free_application *);\n"
19654 " void guestfs_free_application_list (struct guestfs_free_application_list *);\n"
19659 #: ../fish/guestfish.pod:5
19660 msgid "guestfish - the libguestfs Filesystem Interactive SHell"
19664 #: ../fish/guestfish.pod:9
19667 " guestfish [--options] [commands]\n"
19672 #: ../fish/guestfish.pod:11
19680 #: ../fish/guestfish.pod:13
19683 " guestfish [--ro|--rw] -a disk.img\n"
19688 #: ../fish/guestfish.pod:15
19691 " guestfish [--ro|--rw] -a disk.img -m dev[:mountpoint]\n"
19696 #: ../fish/guestfish.pod:17
19699 " guestfish -d libvirt-domain\n"
19704 #: ../fish/guestfish.pod:19
19707 " guestfish [--ro|--rw] -a disk.img -i\n"
19712 #: ../fish/guestfish.pod:21
19715 " guestfish -d libvirt-domain -i\n"
19720 #: ../fish/guestfish.pod:23 ../fuse/guestmount.pod:15
19721 #: ../tools/virt-win-reg.pl:51 ../tools/virt-tar.pl:64
19726 #: ../fish/guestfish.pod:25
19728 "Using guestfish in read/write mode on live virtual machines can be "
19729 "dangerous, potentially causing disk corruption. Use the I<--ro> (read-only) "
19730 "option to use guestfish safely if the disk image or virtual machine might be "
19735 #: ../fish/guestfish.pod:32
19737 "Guestfish is a shell and command-line tool for examining and modifying "
19738 "virtual machine filesystems. It uses libguestfs and exposes all of the "
19739 "functionality of the guestfs API, see L<guestfs(3)>."
19743 #: ../fish/guestfish.pod:36
19745 "Guestfish gives you structured access to the libguestfs API, from shell "
19746 "scripts or the command line or interactively. If you want to rescue a "
19747 "broken virtual machine image, you should look at the L<virt-rescue(1)> "
19752 #: ../fish/guestfish.pod:41 ../fish/guestfish.pod:949
19753 #: ../fuse/guestmount.pod:39 ../tools/virt-tar.pl:50
19758 #: ../fish/guestfish.pod:43
19759 msgid "As an interactive shell"
19763 #: ../fish/guestfish.pod:45
19771 #: ../fish/guestfish.pod:47
19774 " Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
19775 " editing virtual machine filesystems.\n"
19780 #: ../fish/guestfish.pod:50
19783 " Type: 'help' for a list of commands\n"
19784 " 'man' to read the manual\n"
19785 " 'quit' to quit the shell\n"
19790 #: ../fish/guestfish.pod:54
19793 " ><fs> add-ro disk.img\n"
19795 " ><fs> list-filesystems\n"
19796 " /dev/sda1: ext4\n"
19797 " /dev/vg_guest/lv_root: ext4\n"
19798 " /dev/vg_guest/lv_swap: swap\n"
19799 " ><fs> mount /dev/vg_guest/lv_root /\n"
19800 " ><fs> cat /etc/fstab\n"
19802 " # Created by anaconda\n"
19809 #: ../fish/guestfish.pod:67
19810 msgid "From shell scripts"
19814 #: ../fish/guestfish.pod:69
19815 msgid "Create a new C</etc/motd> file in a guest or disk image:"
19819 #: ../fish/guestfish.pod:71
19822 " guestfish <<_EOF_\n"
19825 " mount /dev/vg_guest/lv_root /\n"
19826 " write /etc/motd \"Welcome, new users\"\n"
19832 #: ../fish/guestfish.pod:78
19833 msgid "List the LVM logical volumes in a disk image:"
19837 #: ../fish/guestfish.pod:80
19840 " guestfish -a disk.img --ro <<_EOF_\n"
19848 #: ../fish/guestfish.pod:85
19849 msgid "List all the filesystems in a disk image:"
19853 #: ../fish/guestfish.pod:87
19856 " guestfish -a disk.img --ro <<_EOF_\n"
19858 " list-filesystems\n"
19864 #: ../fish/guestfish.pod:92
19865 msgid "On one command line"
19869 #: ../fish/guestfish.pod:94
19870 msgid "Update C</etc/resolv.conf> in a guest:"
19874 #: ../fish/guestfish.pod:96
19878 " add disk.img : run : mount /dev/vg_guest/lv_root / : \\\n"
19879 " write /etc/resolv.conf \"nameserver 1.2.3.4\"\n"
19884 #: ../fish/guestfish.pod:100
19885 msgid "Edit C</boot/grub/grub.conf> interactively:"
19889 #: ../fish/guestfish.pod:102
19892 " guestfish --rw --add disk.img \\\n"
19893 " --mount /dev/vg_guest/lv_root \\\n"
19894 " --mount /dev/sda1:/boot \\\n"
19895 " edit /boot/grub/grub.conf\n"
19900 #: ../fish/guestfish.pod:107
19901 msgid "Mount disks automatically"
19905 #: ../fish/guestfish.pod:109
19907 "Use the I<-i> option to automatically mount the disks from a virtual machine:"
19911 #: ../fish/guestfish.pod:112
19914 " guestfish --ro -a disk.img -i cat /etc/group\n"
19919 #: ../fish/guestfish.pod:114
19922 " guestfish --ro -d libvirt-domain -i cat /etc/group\n"
19927 #: ../fish/guestfish.pod:116
19928 msgid "Another way to edit C</boot/grub/grub.conf> interactively is:"
19932 #: ../fish/guestfish.pod:118
19935 " guestfish --rw -a disk.img -i edit /boot/grub/grub.conf\n"
19940 #: ../fish/guestfish.pod:120
19941 msgid "As a script interpreter"
19945 #: ../fish/guestfish.pod:122
19946 msgid "Create a 100MB disk containing an ext2-formatted partition:"
19950 #: ../fish/guestfish.pod:124
19953 " #!/usr/bin/guestfish -f\n"
19954 " sparse test1.img 100M\n"
19956 " part-disk /dev/sda mbr\n"
19957 " mkfs ext2 /dev/sda1\n"
19962 #: ../fish/guestfish.pod:130
19963 msgid "Start with a prepared disk"
19967 #: ../fish/guestfish.pod:132
19969 "An alternate way to create a 100MB disk called C<test1.img> containing a "
19970 "single ext2-formatted partition:"
19974 #: ../fish/guestfish.pod:135
19977 " guestfish -N fs\n"
19982 #: ../fish/guestfish.pod:137
19983 msgid "To list what is available do:"
19987 #: ../fish/guestfish.pod:139 ../fish/guestfish.pod:940
19990 " guestfish -N help | less\n"
19995 #: ../fish/guestfish.pod:141
19996 msgid "Remote control"
20000 #: ../fish/guestfish.pod:143
20003 " eval \"`guestfish --listen`\"\n"
20004 " guestfish --remote add-ro disk.img\n"
20005 " guestfish --remote run\n"
20006 " guestfish --remote lvs\n"
20011 #: ../fish/guestfish.pod:148 ../test-tool/libguestfs-test-tool.pod:37
20012 #: ../fuse/guestmount.pod:83 ../tools/virt-win-reg.pl:96
20013 #: ../tools/virt-list-filesystems.pl:53 ../tools/virt-tar.pl:103
20014 #: ../tools/virt-make-fs.pl:153 ../tools/virt-list-partitions.pl:54
20019 #: ../fish/guestfish.pod:152 ../fuse/guestmount.pod:143
20020 #: ../tools/virt-win-reg.pl:104 ../tools/virt-list-filesystems.pl:61
20021 #: ../tools/virt-tar.pl:111 ../tools/virt-make-fs.pl:161
20022 #: ../tools/virt-list-partitions.pl:62
20027 #: ../fish/guestfish.pod:154
20028 msgid "Displays general help on options."
20032 #: ../fish/guestfish.pod:156
20037 #: ../fish/guestfish.pod:158
20038 msgid "B<--cmd-help>"
20042 #: ../fish/guestfish.pod:160
20043 msgid "Lists all available guestfish commands."
20047 #: ../fish/guestfish.pod:162
20052 #: ../fish/guestfish.pod:164
20053 msgid "B<--cmd-help cmd>"
20057 #: ../fish/guestfish.pod:166
20058 msgid "Displays detailed help on a single command C<cmd>."
20062 #: ../fish/guestfish.pod:168
20063 msgid "B<-a image>"
20067 #: ../fish/guestfish.pod:170
20068 msgid "B<--add image>"
20072 #: ../fish/guestfish.pod:172
20073 msgid "Add a block device or virtual machine image to the shell."
20077 #: ../fish/guestfish.pod:174 ../fuse/guestmount.pod:91
20079 "The format of the disk image is auto-detected. To override this and force a "
20080 "particular format use the I<--format=..> option."
20084 #: ../fish/guestfish.pod:177
20086 "Using this flag is mostly equivalent to using the C<add> command, with "
20087 "C<readonly:true> if the I<--ro> flag was given, and with C<format:...> if "
20088 "the I<--format=...> flag was given."
20092 #: ../fish/guestfish.pod:181
20097 #: ../fish/guestfish.pod:183
20098 msgid "B<--connect URI>"
20102 #: ../fish/guestfish.pod:185 ../fuse/guestmount.pod:96
20104 "When used in conjunction with the I<-d> option, this specifies the libvirt "
20105 "URI to use. The default is to use the default libvirt connection."
20109 #: ../fish/guestfish.pod:189
20114 #: ../fish/guestfish.pod:191
20116 "If using the I<--listen> option and a csh-like shell, use this option. See "
20117 "section L</REMOTE CONTROL AND CSH> below."
20121 #: ../fish/guestfish.pod:194
20122 msgid "B<-d libvirt-domain>"
20126 #: ../fish/guestfish.pod:196
20127 msgid "B<--domain libvirt-domain>"
20131 #: ../fish/guestfish.pod:198 ../fuse/guestmount.pod:102
20133 "Add disks from the named libvirt domain. If the I<--ro> option is also "
20134 "used, then any libvirt domain can be used. However in write mode, only "
20135 "libvirt domains which are shut down can be named here."
20139 #: ../fish/guestfish.pod:202 ../fuse/guestmount.pod:106
20140 msgid "Domain UUIDs can be used instead of names."
20144 #: ../fish/guestfish.pod:204
20146 "Using this flag is mostly equivalent to using the C<add-domain> command, "
20147 "with C<readonly:true> if the I<--ro> flag was given, and with C<format:...> "
20148 "if the I<--format:...> flag was given."
20152 #: ../fish/guestfish.pod:208
20157 #: ../fish/guestfish.pod:210
20158 msgid "B<--no-dest-paths>"
20162 #: ../fish/guestfish.pod:212
20164 "Don't tab-complete paths on the guest filesystem. It is useful to be able "
20165 "to hit the tab key to complete paths on the guest filesystem, but this "
20166 "causes extra \"hidden\" guestfs calls to be made, so this option is here to "
20167 "allow this feature to be disabled."
20171 #: ../fish/guestfish.pod:217 ../fuse/guestmount.pod:120
20172 msgid "B<--echo-keys>"
20176 #: ../fish/guestfish.pod:219 ../fuse/guestmount.pod:122
20178 "When prompting for keys and passphrases, guestfish normally turns echoing "
20179 "off so you cannot see what you are typing. If you are not worried about "
20180 "Tempest attacks and there is no one else in the room you can specify this "
20181 "flag to see what you are typing."
20185 #: ../fish/guestfish.pod:224
20190 #: ../fish/guestfish.pod:226
20191 msgid "B<--file file>"
20195 #: ../fish/guestfish.pod:228
20196 msgid "Read commands from C<file>. To write pure guestfish scripts, use:"
20200 #: ../fish/guestfish.pod:231
20203 " #!/usr/bin/guestfish -f\n"
20208 #: ../fish/guestfish.pod:233
20209 msgid "B<--format=raw|qcow2|..>"
20213 #: ../fish/guestfish.pod:235
20214 msgid "B<--format>"
20218 #: ../fish/guestfish.pod:237 ../fuse/guestmount.pod:129
20220 "The default for the I<-a> option is to auto-detect the format of the disk "
20221 "image. Using this forces the disk format for I<-a> options which follow on "
20222 "the command line. Using I<--format> with no argument switches back to auto-"
20223 "detection for subsequent I<-a> options."
20227 #: ../fish/guestfish.pod:244
20230 " guestfish --format=raw -a disk.img\n"
20235 #: ../fish/guestfish.pod:246
20236 msgid "forces raw format (no auto-detection) for C<disk.img>."
20240 #: ../fish/guestfish.pod:248
20243 " guestfish --format=raw -a disk.img --format -a another.img\n"
20248 #: ../fish/guestfish.pod:250
20250 "forces raw format (no auto-detection) for C<disk.img> and reverts to auto-"
20251 "detection for C<another.img>."
20255 #: ../fish/guestfish.pod:253
20257 "If you have untrusted raw-format guest disk images, you should use this "
20258 "option to specify the disk format. This avoids a possible security problem "
20259 "with malicious guests (CVE-2010-3851). See also L</add-drive-opts>."
20263 #: ../fish/guestfish.pod:258
20268 #: ../fish/guestfish.pod:260
20269 msgid "B<--inspector>"
20273 #: ../fish/guestfish.pod:262 ../fuse/guestmount.pod:149
20275 "Using L<virt-inspector(1)> code, inspect the disks looking for an operating "
20276 "system and mount filesystems as they would be mounted on the real virtual "
20281 #: ../fish/guestfish.pod:266
20282 msgid "Typical usage is either:"
20286 #: ../fish/guestfish.pod:268
20289 " guestfish -d myguest -i\n"
20294 #: ../fish/guestfish.pod:270
20295 msgid "(for an inactive libvirt domain called I<myguest>), or:"
20299 #: ../fish/guestfish.pod:272
20302 " guestfish --ro -d myguest -i\n"
20307 #: ../fish/guestfish.pod:274
20308 msgid "(for active domains, readonly), or specify the block device directly:"
20312 #: ../fish/guestfish.pod:276
20315 " guestfish --rw -a /dev/Guests/MyGuest -i\n"
20320 #: ../fish/guestfish.pod:278
20322 "Note that the command line syntax changed slightly over older versions of "
20323 "guestfish. You can still use the old syntax:"
20327 #: ../fish/guestfish.pod:281
20330 " guestfish [--ro] -i disk.img\n"
20335 #: ../fish/guestfish.pod:283
20338 " guestfish [--ro] -i libvirt-domain\n"
20343 #: ../fish/guestfish.pod:285
20345 "Using this flag is mostly equivalent to using the C<inspect-os> command and "
20346 "then using other commands to mount the filesystems that were found."
20350 #: ../fish/guestfish.pod:289 ../fuse/guestmount.pod:153
20351 msgid "B<--keys-from-stdin>"
20355 #: ../fish/guestfish.pod:291 ../fuse/guestmount.pod:155
20357 "Read key or passphrase parameters from stdin. The default is to try to read "
20358 "passphrases from the user by opening C</dev/tty>."
20362 #: ../fish/guestfish.pod:294
20363 msgid "B<--listen>"
20367 #: ../fish/guestfish.pod:296
20369 "Fork into the background and listen for remote commands. See section L</"
20370 "REMOTE CONTROL GUESTFISH OVER A SOCKET> below."
20374 #: ../fish/guestfish.pod:299 ../fuse/guestmount.pod:158
20379 #: ../fish/guestfish.pod:301 ../fuse/guestmount.pod:160
20381 "Connect to a live virtual machine. (Experimental, see L<guestfs(3)/"
20382 "ATTACHING TO RUNNING DAEMONS>)."
20386 #: ../fish/guestfish.pod:304 ../fuse/guestmount.pod:163
20387 msgid "B<-m dev[:mountpoint[:options]]>"
20391 #: ../fish/guestfish.pod:306 ../fuse/guestmount.pod:165
20392 msgid "B<--mount dev[:mountpoint[:options]]>"
20396 #: ../fish/guestfish.pod:308
20397 msgid "Mount the named partition or logical volume on the given mountpoint."
20401 #: ../fish/guestfish.pod:310
20402 msgid "If the mountpoint is omitted, it defaults to C</>."
20406 #: ../fish/guestfish.pod:312
20407 msgid "You have to mount something on C</> before most commands will work."
20411 #: ../fish/guestfish.pod:314
20413 "If any I<-m> or I<--mount> options are given, the guest is automatically "
20418 #: ../fish/guestfish.pod:317
20420 "If you don't know what filesystems a disk image contains, you can either run "
20421 "guestfish without this option, then list the partitions, filesystems and LVs "
20422 "available (see L</list-partitions>, L</list-filesystems> and L</lvs> "
20423 "commands), or you can use the L<virt-filesystems(1)> program."
20427 #: ../fish/guestfish.pod:323 ../fuse/guestmount.pod:173
20429 "The third (and rarely used) part of the mount parameter is the list of mount "
20430 "options used to mount the underlying filesystem. If this is not given, then "
20431 "the mount options are either the empty string or C<ro> (the latter if the "
20432 "I<--ro> flag is used). By specifying the mount options, you override this "
20433 "default choice. Probably the only time you would use this is to enable ACLs "
20434 "and/or extended attributes if the filesystem can support them:"
20438 #: ../fish/guestfish.pod:331 ../fuse/guestmount.pod:181
20441 " -m /dev/sda1:/:acl,user_xattr\n"
20446 #: ../fish/guestfish.pod:333
20447 msgid "Using this flag is equivalent to using the C<mount-options> command."
20451 #: ../fish/guestfish.pod:335
20456 #: ../fish/guestfish.pod:337
20457 msgid "B<--no-sync>"
20461 #: ../fish/guestfish.pod:339
20463 "Disable autosync. This is enabled by default. See the discussion of "
20464 "autosync in the L<guestfs(3)> manpage."
20468 #: ../fish/guestfish.pod:342
20473 #: ../fish/guestfish.pod:344
20474 msgid "B<--new type>"
20478 #: ../fish/guestfish.pod:346
20483 #: ../fish/guestfish.pod:348
20485 "Prepare a fresh disk image formatted as \"type\". This is an alternative to "
20486 "the I<-a> option: whereas I<-a> adds an existing disk, I<-N> creates a "
20487 "preformatted disk with a filesystem and adds it. See L</PREPARED DISK "
20492 #: ../fish/guestfish.pod:353
20493 msgid "B<--progress-bars>"
20497 #: ../fish/guestfish.pod:355
20498 msgid "Enable progress bars, even when guestfish is used non-interactively."
20502 #: ../fish/guestfish.pod:357
20504 "Progress bars are enabled by default when guestfish is used as an "
20505 "interactive shell."
20509 #: ../fish/guestfish.pod:360
20510 msgid "B<--no-progress-bars>"
20514 #: ../fish/guestfish.pod:362
20515 msgid "Disable progress bars."
20519 #: ../fish/guestfish.pod:364
20520 msgid "B<--remote[=pid]>"
20524 #: ../fish/guestfish.pod:366
20526 "Send remote commands to C<$GUESTFISH_PID> or C<pid>. See section L</REMOTE "
20527 "CONTROL GUESTFISH OVER A SOCKET> below."
20531 #: ../fish/guestfish.pod:369
20536 #: ../fish/guestfish.pod:371
20541 #: ../fish/guestfish.pod:373
20543 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
20544 "mounts are done read-only."
20548 #: ../fish/guestfish.pod:376
20550 "The option must always be used if the disk image or virtual machine might be "
20551 "running, and is generally recommended in cases where you don't need write "
20552 "access to the disk."
20556 #: ../fish/guestfish.pod:380
20558 "Note that prepared disk images created with I<-N> are not affected by this "
20559 "option. Also commands like C<add> are not affected - you have to specify "
20560 "the C<readonly:true> option explicitly if you need it."
20564 #: ../fish/guestfish.pod:384
20565 msgid "See also L</OPENING DISKS FOR READ AND WRITE> below."
20569 #: ../fish/guestfish.pod:386 ../fuse/guestmount.pod:237
20570 msgid "B<--selinux>"
20574 #: ../fish/guestfish.pod:388
20575 msgid "Enable SELinux support for the guest. See L<guestfs(3)/SELINUX>."
20579 #: ../fish/guestfish.pod:390
20584 #: ../fish/guestfish.pod:392
20585 msgid "B<--verbose>"
20589 #: ../fish/guestfish.pod:394
20591 "Enable very verbose messages. This is particularly useful if you find a bug."
20595 #: ../fish/guestfish.pod:397
20600 #: ../fish/guestfish.pod:399 ../tools/virt-win-reg.pl:112
20601 #: ../tools/virt-list-filesystems.pl:69 ../tools/virt-tar.pl:119
20602 #: ../tools/virt-make-fs.pl:169 ../tools/virt-list-partitions.pl:70
20603 msgid "B<--version>"
20607 #: ../fish/guestfish.pod:401
20608 msgid "Display the guestfish / libguestfs version number and exit."
20612 #: ../fish/guestfish.pod:403
20617 #: ../fish/guestfish.pod:405
20622 #: ../fish/guestfish.pod:407 ../fuse/guestmount.pod:251
20624 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
20625 "mounts are done read-write."
20629 #: ../fish/guestfish.pod:410
20630 msgid "See L</OPENING DISKS FOR READ AND WRITE> below."
20634 #: ../fish/guestfish.pod:412
20639 #: ../fish/guestfish.pod:414
20640 msgid "Echo each command before executing it."
20644 #: ../fish/guestfish.pod:418
20645 msgid "COMMANDS ON COMMAND LINE"
20649 #: ../fish/guestfish.pod:420
20651 "Any additional (non-option) arguments are treated as commands to execute."
20655 #: ../fish/guestfish.pod:423
20657 "Commands to execute should be separated by a colon (C<:>), where the colon "
20658 "is a separate parameter. Thus:"
20662 #: ../fish/guestfish.pod:426
20665 " guestfish cmd [args...] : cmd [args...] : cmd [args...] ...\n"
20670 #: ../fish/guestfish.pod:428
20672 "If there are no additional arguments, then we enter a shell, either an "
20673 "interactive shell with a prompt (if the input is a terminal) or a non-"
20674 "interactive shell."
20678 #: ../fish/guestfish.pod:432
20680 "In either command line mode or non-interactive shell, the first command that "
20681 "gives an error causes the whole shell to exit. In interactive mode (with a "
20682 "prompt) if a command fails, you can continue to enter commands."
20686 #: ../fish/guestfish.pod:437
20687 msgid "USING launch (OR run)"
20691 #: ../fish/guestfish.pod:439
20693 "As with L<guestfs(3)>, you must first configure your guest by adding disks, "
20694 "then launch it, then mount any disks you need, and finally issue actions/"
20695 "commands. So the general order of the day is:"
20699 #: ../fish/guestfish.pod:447
20700 msgid "add or -a/--add"
20704 #: ../fish/guestfish.pod:451
20705 msgid "launch (aka run)"
20709 #: ../fish/guestfish.pod:455
20710 msgid "mount or -m/--mount"
20714 #: ../fish/guestfish.pod:459
20715 msgid "any other commands"
20719 #: ../fish/guestfish.pod:463
20721 "C<run> is a synonym for C<launch>. You must C<launch> (or C<run>) your "
20722 "guest before mounting or performing any other commands."
20726 #: ../fish/guestfish.pod:466
20728 "The only exception is that if any of the I<-i>, I<-m>, I<--mount>, I<-N> or "
20729 "I<--new> options were given then C<run> is done automatically, simply "
20730 "because guestfish can't perform the action you asked for without doing this."
20734 #: ../fish/guestfish.pod:471
20735 msgid "OPENING DISKS FOR READ AND WRITE"
20739 #: ../fish/guestfish.pod:473
20741 "The guestfish, L<guestmount(1)> and L<virt-rescue(1)> options I<--ro> and "
20742 "I<--rw> affect whether the other command line options I<-a>, I<-c>, I<-d>, "
20743 "I<-i> and I<-m> open disk images read-only or for writing."
20747 #: ../fish/guestfish.pod:478
20749 "In libguestfs E<le> 1.10, guestfish, guestmount and virt-rescue defaulted to "
20750 "opening disk images supplied on the command line for write. To open a disk "
20751 "image read-only you have to do I<-a image --ro>."
20755 #: ../fish/guestfish.pod:482
20757 "This matters: If you accidentally open a live VM disk image writable then "
20758 "you will cause irreversible disk corruption."
20762 #: ../fish/guestfish.pod:485
20764 "By libguestfs 1.12 we intend to change the default the other way. Disk "
20765 "images will be opened read-only. You will have to either specify "
20766 "I<guestfish --rw>, I<guestmount --rw>, I<virt-rescue --rw>, or change the "
20767 "configuration file C</etc/libguestfs-tools.conf> in order to get write "
20768 "access for disk images specified by those other command line options."
20772 #: ../fish/guestfish.pod:492
20774 "This version of guestfish, guestmount and virt-rescue has a I<--rw> option "
20775 "which does nothing (it is already the default). However it is highly "
20776 "recommended that you use this option to indicate that you need write access, "
20777 "and prepare your scripts for the day when this option will be required for "
20782 #: ../fish/guestfish.pod:498
20784 "B<Note:> This does I<not> affect commands like L</add> and L</mount>, or any "
20785 "other libguestfs program apart from guestfish and guestmount."
20789 #: ../fish/guestfish.pod:501
20794 #: ../fish/guestfish.pod:503
20796 "You can quote ordinary parameters using either single or double quotes. For "
20801 #: ../fish/guestfish.pod:506
20804 " add \"file with a space.img\"\n"
20809 #: ../fish/guestfish.pod:508
20812 " rm '/file name'\n"
20817 #: ../fish/guestfish.pod:510
20825 #: ../fish/guestfish.pod:512
20827 "A few commands require a list of strings to be passed. For these, use a "
20828 "whitespace-separated list, enclosed in quotes. Strings containing "
20829 "whitespace to be passed through must be enclosed in single quotes. A "
20830 "literal single quote must be escaped with a backslash."
20834 #: ../fish/guestfish.pod:517
20837 " vgcreate VG \"/dev/sda1 /dev/sdb1\"\n"
20838 " command \"/bin/echo 'foo bar'\"\n"
20839 " command \"/bin/echo \\'foo\\'\"\n"
20844 #: ../fish/guestfish.pod:521
20845 msgid "OPTIONAL ARGUMENTS"
20849 #: ../fish/guestfish.pod:523
20851 "Some commands take optional arguments. These arguments appear in this "
20852 "documentation as C<[argname:..]>. You can use them as in these examples:"
20856 #: ../fish/guestfish.pod:527
20859 " add-drive-opts filename\n"
20864 #: ../fish/guestfish.pod:529
20867 " add-drive-opts filename readonly:true\n"
20872 #: ../fish/guestfish.pod:531
20875 " add-drive-opts filename format:qcow2 readonly:false\n"
20880 #: ../fish/guestfish.pod:533
20882 "Each optional argument can appear at most once. All optional arguments must "
20883 "appear after the required ones."
20887 #: ../fish/guestfish.pod:536
20892 #: ../fish/guestfish.pod:538
20894 "This section applies to all commands which can take integers as parameters."
20898 #: ../fish/guestfish.pod:541
20899 msgid "SIZE SUFFIX"
20903 #: ../fish/guestfish.pod:543
20905 "When the command takes a parameter measured in bytes, you can use one of the "
20906 "following suffixes to specify kilobytes, megabytes and larger sizes:"
20910 #: ../fish/guestfish.pod:549
20911 msgid "B<k> or B<K> or B<KiB>"
20915 #: ../fish/guestfish.pod:551
20916 msgid "The size in kilobytes (multiplied by 1024)."
20920 #: ../fish/guestfish.pod:553
20925 #: ../fish/guestfish.pod:555
20926 msgid "The size in SI 1000 byte units."
20930 #: ../fish/guestfish.pod:557
20931 msgid "B<M> or B<MiB>"
20935 #: ../fish/guestfish.pod:559
20936 msgid "The size in megabytes (multiplied by 1048576)."
20940 #: ../fish/guestfish.pod:561
20945 #: ../fish/guestfish.pod:563
20946 msgid "The size in SI 1000000 byte units."
20950 #: ../fish/guestfish.pod:565
20951 msgid "B<G> or B<GiB>"
20955 #: ../fish/guestfish.pod:567
20956 msgid "The size in gigabytes (multiplied by 2**30)."
20960 #: ../fish/guestfish.pod:569
20965 #: ../fish/guestfish.pod:571
20966 msgid "The size in SI 10**9 byte units."
20970 #: ../fish/guestfish.pod:573
20971 msgid "B<T> or B<TiB>"
20975 #: ../fish/guestfish.pod:575
20976 msgid "The size in terabytes (multiplied by 2**40)."
20980 #: ../fish/guestfish.pod:577
20985 #: ../fish/guestfish.pod:579
20986 msgid "The size in SI 10**12 byte units."
20990 #: ../fish/guestfish.pod:581
20991 msgid "B<P> or B<PiB>"
20995 #: ../fish/guestfish.pod:583
20996 msgid "The size in petabytes (multiplied by 2**50)."
21000 #: ../fish/guestfish.pod:585
21005 #: ../fish/guestfish.pod:587
21006 msgid "The size in SI 10**15 byte units."
21010 #: ../fish/guestfish.pod:589
21011 msgid "B<E> or B<EiB>"
21015 #: ../fish/guestfish.pod:591
21016 msgid "The size in exabytes (multiplied by 2**60)."
21020 #: ../fish/guestfish.pod:593
21025 #: ../fish/guestfish.pod:595
21026 msgid "The size in SI 10**18 byte units."
21030 #: ../fish/guestfish.pod:597
21031 msgid "B<Z> or B<ZiB>"
21035 #: ../fish/guestfish.pod:599
21036 msgid "The size in zettabytes (multiplied by 2**70)."
21040 #: ../fish/guestfish.pod:601
21045 #: ../fish/guestfish.pod:603
21046 msgid "The size in SI 10**21 byte units."
21050 #: ../fish/guestfish.pod:605
21051 msgid "B<Y> or B<YiB>"
21055 #: ../fish/guestfish.pod:607
21056 msgid "The size in yottabytes (multiplied by 2**80)."
21060 #: ../fish/guestfish.pod:609
21065 #: ../fish/guestfish.pod:611
21066 msgid "The size in SI 10**24 byte units."
21070 #: ../fish/guestfish.pod:617
21073 " truncate-size /file 1G\n"
21078 #: ../fish/guestfish.pod:619
21079 msgid "would truncate the file to 1 gigabyte."
21083 #: ../fish/guestfish.pod:621
21085 "Be careful because a few commands take sizes in kilobytes or megabytes (eg. "
21086 "the parameter to L</memsize> is specified in megabytes already). Adding a "
21087 "suffix will probably not do what you expect."
21091 #: ../fish/guestfish.pod:625
21092 msgid "OCTAL AND HEXADECIMAL NUMBERS"
21096 #: ../fish/guestfish.pod:627
21098 "For specifying the radix (base) use the C convention: C<0> to prefix an "
21099 "octal number or C<0x> to prefix a hexadecimal number. For example:"
21103 #: ../fish/guestfish.pod:630
21106 " 1234 decimal number 1234\n"
21107 " 02322 octal number, equivalent to decimal 1234\n"
21108 " 0x4d2 hexadecimal number, equivalent to decimal 1234\n"
21113 #: ../fish/guestfish.pod:634
21115 "When using the C<chmod> command, you almost always want to specify an octal "
21116 "number for the mode, and you must prefix it with C<0> (unlike the Unix "
21117 "L<chmod(1)> program):"
21121 #: ../fish/guestfish.pod:638
21124 " chmod 0777 /public # OK\n"
21125 " chmod 777 /public # WRONG! This is mode 777 decimal = 01411 octal.\n"
21130 #: ../fish/guestfish.pod:641
21132 "Commands that return numbers usually print them in decimal, but some "
21133 "commands print numbers in other radices (eg. C<umask> prints the mode in "
21134 "octal, preceeded by C<0>)."
21138 #: ../fish/guestfish.pod:645
21139 msgid "WILDCARDS AND GLOBBING"
21143 #: ../fish/guestfish.pod:647
21145 "Neither guestfish nor the underlying guestfs API performs wildcard expansion "
21146 "(globbing) by default. So for example the following will not do what you "
21151 #: ../fish/guestfish.pod:651
21159 #: ../fish/guestfish.pod:653
21161 "Assuming you don't have a directory called literally C</home/*> then the "
21162 "above command will return an error."
21166 #: ../fish/guestfish.pod:656
21167 msgid "To perform wildcard expansion, use the C<glob> command."
21171 #: ../fish/guestfish.pod:658
21174 " glob rm-rf /home/*\n"
21179 #: ../fish/guestfish.pod:660
21181 "runs C<rm-rf> on each path that matches (ie. potentially running the command "
21182 "many times), equivalent to:"
21186 #: ../fish/guestfish.pod:663
21189 " rm-rf /home/jim\n"
21190 " rm-rf /home/joe\n"
21191 " rm-rf /home/mary\n"
21196 #: ../fish/guestfish.pod:667
21197 msgid "C<glob> only works on simple guest paths and not on device names."
21201 #: ../fish/guestfish.pod:669
21203 "If you have several parameters, each containing a wildcard, then glob will "
21204 "perform a Cartesian product."
21208 #: ../fish/guestfish.pod:672
21213 #: ../fish/guestfish.pod:674
21215 "Any line which starts with a I<#> character is treated as a comment and "
21216 "ignored. The I<#> can optionally be preceeded by whitespace, but B<not> by "
21217 "a command. For example:"
21221 #: ../fish/guestfish.pod:678
21224 " # this is a comment\n"
21225 " # this is a comment\n"
21226 " foo # NOT a comment\n"
21231 #: ../fish/guestfish.pod:682
21232 msgid "Blank lines are also ignored."
21236 #: ../fish/guestfish.pod:684
21237 msgid "RUNNING COMMANDS LOCALLY"
21241 #: ../fish/guestfish.pod:686
21243 "Any line which starts with a I<!> character is treated as a command sent to "
21244 "the local shell (C</bin/sh> or whatever L<system(3)> uses). For example:"
21248 #: ../fish/guestfish.pod:690
21252 " tgz-out /remote local/remote-data.tar.gz\n"
21257 #: ../fish/guestfish.pod:693
21259 "will create a directory C<local> on the host, and then export the contents "
21260 "of C</remote> on the mounted filesystem to C<local/remote-data.tar.gz>. "
21261 "(See C<tgz-out>)."
21265 #: ../fish/guestfish.pod:697
21267 "To change the local directory, use the C<lcd> command. C<!cd> will have no "
21268 "effect, due to the way that subprocesses work in Unix."
21272 #: ../fish/guestfish.pod:700
21273 msgid "LOCAL COMMANDS WITH INLINE EXECUTION"
21277 #: ../fish/guestfish.pod:702
21279 "If a line starts with I<E<lt>!> then the shell command is executed (as for "
21280 "I<!>), but subsequently any output (stdout) of the shell command is parsed "
21281 "and executed as guestfish commands."
21285 #: ../fish/guestfish.pod:706
21287 "Thus you can use shell script to construct arbitrary guestfish commands "
21288 "which are then parsed by guestfish."
21292 #: ../fish/guestfish.pod:709
21294 "For example it is tedious to create a sequence of files (eg. C</foo.1> "
21295 "through C</foo.100>) using guestfish commands alone. However this is simple "
21296 "if we use a shell script to create the guestfish commands for us:"
21300 #: ../fish/guestfish.pod:714
21303 " <! for n in `seq 1 100`; do echo write /foo.$n $n; done\n"
21308 #: ../fish/guestfish.pod:716
21309 msgid "or with names like C</foo.001>:"
21313 #: ../fish/guestfish.pod:718
21316 " <! for n in `seq 1 100`; do printf \"write /foo.%03d %d\\n\" $n $n; done\n"
21321 #: ../fish/guestfish.pod:720
21323 "When using guestfish interactively it can be helpful to just run the shell "
21324 "script first (ie. remove the initial C<E<lt>> character so it is just an "
21325 "ordinary I<!> local command), see what guestfish commands it would run, and "
21326 "when you are happy with those prepend the C<E<lt>> character to run the "
21327 "guestfish commands for real."
21331 #: ../fish/guestfish.pod:726
21336 #: ../fish/guestfish.pod:728
21338 "Use C<command E<lt>spaceE<gt> | command> to pipe the output of the first "
21339 "command (a guestfish command) to the second command (any host command). For "
21344 #: ../fish/guestfish.pod:732
21347 " cat /etc/passwd | awk -F: '$3 == 0 { print }'\n"
21352 #: ../fish/guestfish.pod:734
21354 "(where C<cat> is the guestfish cat command, but C<awk> is the host awk "
21355 "program). The above command would list all accounts in the guest filesystem "
21356 "which have UID 0, ie. root accounts including backdoors. Other examples:"
21360 #: ../fish/guestfish.pod:739
21363 " hexdump /bin/ls | head\n"
21364 " list-devices | tail -1\n"
21365 " tgz-out / - | tar ztf -\n"
21370 #: ../fish/guestfish.pod:743
21372 "The space before the pipe symbol is required, any space after the pipe "
21373 "symbol is optional. Everything after the pipe symbol is just passed "
21374 "straight to the host shell, so it can contain redirections, globs and "
21375 "anything else that makes sense on the host side."
21379 #: ../fish/guestfish.pod:748
21381 "To use a literal argument which begins with a pipe symbol, you have to quote "
21386 #: ../fish/guestfish.pod:751
21394 #: ../fish/guestfish.pod:753
21395 msgid "HOME DIRECTORIES"
21399 #: ../fish/guestfish.pod:755
21401 "If a parameter starts with the character C<~> then the tilde may be expanded "
21402 "as a home directory path (either C<~> for the current user's home directory, "
21403 "or C<~user> for another user)."
21407 #: ../fish/guestfish.pod:759
21409 "Note that home directory expansion happens for users known I<on the host>, "
21410 "not in the guest filesystem."
21414 #: ../fish/guestfish.pod:762
21416 "To use a literal argument which begins with a tilde, you have to quote it, "
21421 #: ../fish/guestfish.pod:765
21429 #: ../fish/guestfish.pod:769
21431 "Libguestfs has some support for Linux guests encrypted according to the "
21432 "Linux Unified Key Setup (LUKS) standard, which includes nearly all whole "
21433 "disk encryption systems used by modern Linux guests. Currently only LVM-on-"
21434 "LUKS is supported."
21438 #: ../fish/guestfish.pod:774
21439 msgid "Identify encrypted block devices and partitions using L</vfs-type>:"
21443 #: ../fish/guestfish.pod:776
21446 " ><fs> vfs-type /dev/sda2\n"
21452 #: ../fish/guestfish.pod:779
21454 "Then open those devices using L</luks-open>. This creates a device-mapper "
21455 "device called C</dev/mapper/luksdev>."
21459 #: ../fish/guestfish.pod:782
21462 " ><fs> luks-open /dev/sda2 luksdev\n"
21463 " Enter key or passphrase (\"key\"): <enter the passphrase>\n"
21468 #: ../fish/guestfish.pod:785
21470 "Finally you have to tell LVM to scan for volume groups on the newly created "
21475 #: ../fish/guestfish.pod:788
21479 " vg-activate-all true\n"
21484 #: ../fish/guestfish.pod:791
21485 msgid "The logical volume(s) can now be mounted in the usual way."
21489 #: ../fish/guestfish.pod:793
21491 "Before closing a LUKS device you must unmount any logical volumes on it and "
21492 "deactivate the volume groups by calling C<vg-activate false VG> on each "
21493 "one. Then you can close the mapper device:"
21497 #: ../fish/guestfish.pod:797
21500 " vg-activate false /dev/VG\n"
21501 " luks-close /dev/mapper/luksdev\n"
21506 #: ../fish/guestfish.pod:800
21507 msgid "WINDOWS PATHS"
21511 #: ../fish/guestfish.pod:802
21513 "If a path is prefixed with C<win:> then you can use Windows-style drive "
21514 "letters and paths (with some limitations). The following commands are "
21519 #: ../fish/guestfish.pod:806
21522 " file /WINDOWS/system32/config/system.LOG\n"
21527 #: ../fish/guestfish.pod:808
21530 " file win:\\windows\\system32\\config\\system.log\n"
21535 #: ../fish/guestfish.pod:810
21538 " file WIN:C:\\Windows\\SYSTEM32\\CONFIG\\SYSTEM.LOG\n"
21543 #: ../fish/guestfish.pod:812
21545 "The parameter is rewritten \"behind the scenes\" by looking up the position "
21546 "where the drive is mounted, prepending that to the path, changing all "
21547 "backslash characters to forward slash, then resolving the result using L</"
21548 "case-sensitive-path>. For example if the E: drive was mounted on C</e> then "
21549 "the parameter might be rewritten like this:"
21553 #: ../fish/guestfish.pod:818
21556 " win:e:\\foo\\bar => /e/FOO/bar\n"
21561 #: ../fish/guestfish.pod:820
21562 msgid "This only works in argument positions that expect a path."
21566 #: ../fish/guestfish.pod:822
21567 msgid "UPLOADING AND DOWNLOADING FILES"
21571 #: ../fish/guestfish.pod:824
21573 "For commands such as C<upload>, C<download>, C<tar-in>, C<tar-out> and "
21574 "others which upload from or download to a local file, you can use the "
21575 "special filename C<-> to mean \"from stdin\" or \"to stdout\". For example:"
21579 #: ../fish/guestfish.pod:828
21587 #: ../fish/guestfish.pod:830
21589 "reads stdin and creates from that a file C</foo> in the disk image, and:"
21593 #: ../fish/guestfish.pod:833
21596 " tar-out /etc - | tar tf -\n"
21601 #: ../fish/guestfish.pod:835
21603 "writes the tarball to stdout and then pipes that into the external \"tar\" "
21604 "command (see L</PIPES>)."
21608 #: ../fish/guestfish.pod:838
21610 "When using C<-> to read from stdin, the input is read up to the end of "
21611 "stdin. You can also use a special \"heredoc\"-like syntax to read up to "
21612 "some arbitrary end marker:"
21616 #: ../fish/guestfish.pod:842
21619 " upload -<<END /foo\n"
21628 #: ../fish/guestfish.pod:848
21630 "Any string of characters can be used instead of C<END>. The end marker must "
21631 "appear on a line of its own, without any preceeding or following characters "
21632 "(not even spaces)."
21636 #: ../fish/guestfish.pod:852
21638 "Note that the C<-E<lt>E<lt>> syntax only applies to parameters used to "
21639 "upload local files (so-called \"FileIn\" parameters in the generator)."
21643 #: ../fish/guestfish.pod:855
21644 msgid "EXIT ON ERROR BEHAVIOUR"
21648 #: ../fish/guestfish.pod:857
21650 "By default, guestfish will ignore any errors when in interactive mode (ie. "
21651 "taking commands from a human over a tty), and will exit on the first error "
21652 "in non-interactive mode (scripts, commands given on the command line)."
21656 #: ../fish/guestfish.pod:862
21658 "If you prefix a command with a I<-> character, then that command will not "
21659 "cause guestfish to exit, even if that (one) command returns an error."
21663 #: ../fish/guestfish.pod:866
21664 msgid "REMOTE CONTROL GUESTFISH OVER A SOCKET"
21668 #: ../fish/guestfish.pod:868
21670 "Guestfish can be remote-controlled over a socket. This is useful "
21671 "particularly in shell scripts where you want to make several different "
21672 "changes to a filesystem, but you don't want the overhead of starting up a "
21673 "guestfish process each time."
21677 #: ../fish/guestfish.pod:873
21678 msgid "Start a guestfish server process using:"
21682 #: ../fish/guestfish.pod:875
21685 " eval \"`guestfish --listen`\"\n"
21690 #: ../fish/guestfish.pod:877
21691 msgid "and then send it commands by doing:"
21695 #: ../fish/guestfish.pod:879
21698 " guestfish --remote cmd [...]\n"
21703 #: ../fish/guestfish.pod:881
21704 msgid "To cause the server to exit, send it the exit command:"
21708 #: ../fish/guestfish.pod:883
21711 " guestfish --remote exit\n"
21716 #: ../fish/guestfish.pod:885
21718 "Note that the server will normally exit if there is an error in a command. "
21719 "You can change this in the usual way. See section L</EXIT ON ERROR "
21724 #: ../fish/guestfish.pod:889
21725 msgid "CONTROLLING MULTIPLE GUESTFISH PROCESSES"
21729 #: ../fish/guestfish.pod:891
21731 "The C<eval> statement sets the environment variable C<$GUESTFISH_PID>, which "
21732 "is how the I<--remote> option knows where to send the commands. You can "
21733 "have several guestfish listener processes running using:"
21737 #: ../fish/guestfish.pod:895
21740 " eval \"`guestfish --listen`\"\n"
21741 " pid1=$GUESTFISH_PID\n"
21742 " eval \"`guestfish --listen`\"\n"
21743 " pid2=$GUESTFISH_PID\n"
21745 " guestfish --remote=$pid1 cmd\n"
21746 " guestfish --remote=$pid2 cmd\n"
21751 #: ../fish/guestfish.pod:903
21752 msgid "REMOTE CONTROL AND CSH"
21756 #: ../fish/guestfish.pod:905
21758 "When using csh-like shells (csh, tcsh etc) you have to add the I<--csh> "
21763 #: ../fish/guestfish.pod:908
21766 " eval \"`guestfish --listen --csh`\"\n"
21771 #: ../fish/guestfish.pod:910
21772 msgid "REMOTE CONTROL DETAILS"
21776 #: ../fish/guestfish.pod:912
21778 "Remote control happens over a Unix domain socket called C</tmp/.guestfish-"
21779 "$UID/socket-$PID>, where C<$UID> is the effective user ID of the process, "
21780 "and C<$PID> is the process ID of the server."
21784 #: ../fish/guestfish.pod:916
21785 msgid "Guestfish client and server versions must match exactly."
21789 #: ../fish/guestfish.pod:918
21790 msgid "PREPARED DISK IMAGES"
21794 #: ../fish/guestfish.pod:920
21796 "Use the I<-N type> or I<--new type> parameter to select one of a set of "
21797 "preformatted disk images that guestfish can make for you to save typing. "
21798 "This is particularly useful for testing purposes. This option is used "
21799 "instead of the I<-a> option, and like I<-a> can appear multiple times (and "
21800 "can be mixed with I<-a>)."
21804 #: ../fish/guestfish.pod:926
21806 "The new disk is called C<test1.img> for the first I<-N>, C<test2.img> for "
21807 "the second and so on. Existing files in the current directory are "
21812 #: ../fish/guestfish.pod:930
21814 "The type briefly describes how the disk should be sized, partitioned, how "
21815 "filesystem(s) should be created, and how content should be added. "
21816 "Optionally the type can be followed by extra parameters, separated by C<:> "
21817 "(colon) characters. For example, I<-N fs> creates a default 100MB, sparsely-"
21818 "allocated disk, containing a single partition, with the partition formatted "
21819 "as ext2. I<-N fs:ext4:1G> is the same, but for an ext4 filesystem on a 1GB "
21824 #: ../fish/guestfish.pod:938
21825 msgid "To list the available types and any extra parameters they take, run:"
21829 #: ../fish/guestfish.pod:942
21831 "Note that the prepared filesystem is not mounted. You would usually have to "
21832 "use the C<mount /dev/sda1 /> command or add the I<-m /dev/sda1> option."
21836 #: ../fish/guestfish.pod:946
21838 "If any I<-N> or I<--new> options are given, the guest is automatically "
21843 #: ../fish/guestfish.pod:951
21844 msgid "Create a 100MB disk with an ext4-formatted partition:"
21848 #: ../fish/guestfish.pod:953
21851 " guestfish -N fs:ext4\n"
21856 #: ../fish/guestfish.pod:955
21857 msgid "Create a 32MB disk with a VFAT-formatted partition, and mount it:"
21861 #: ../fish/guestfish.pod:957
21864 " guestfish -N fs:vfat:32M -m /dev/sda1\n"
21869 #: ../fish/guestfish.pod:959
21870 msgid "Create a blank 200MB disk:"
21874 #: ../fish/guestfish.pod:961
21877 " guestfish -N disk:200M\n"
21882 #: ../fish/guestfish.pod:963
21883 msgid "PROGRESS BARS"
21887 #: ../fish/guestfish.pod:965
21889 "Some (not all) long-running commands send progress notification messages as "
21890 "they are running. Guestfish turns these messages into progress bars."
21894 #: ../fish/guestfish.pod:969
21896 "When a command that supports progress bars takes longer than two seconds to "
21897 "run, and if progress bars are enabled, then you will see one appearing below "
21902 #: ../fish/guestfish.pod:973
21905 " ><fs> copy-size /large-file /another-file 2048M\n"
21906 " / 10% [#####-----------------------------------------] 00:30\n"
21911 #: ../fish/guestfish.pod:976
21913 "The spinner on the left hand side moves round once for every progress "
21914 "notification received from the backend. This is a (reasonably) golden "
21915 "assurance that the command is \"doing something\" even if the progress bar "
21916 "is not moving, because the command is able to send the progress "
21917 "notifications. When the bar reaches 100% and the command finishes, the "
21918 "spinner disappears."
21922 #: ../fish/guestfish.pod:983
21924 "Progress bars are enabled by default when guestfish is used interactively. "
21925 "You can enable them even for non-interactive modes using I<--progress-bars>, "
21926 "and you can disable them completely using I<--no-progress-bars>."
21930 #: ../fish/guestfish.pod:988
21931 msgid "GUESTFISH COMMANDS"
21935 #: ../fish/guestfish.pod:990
21937 "The commands in this section are guestfish convenience commands, in other "
21938 "words, they are not part of the L<guestfs(3)> API."
21942 #: ../fish/guestfish.pod:993
21947 #: ../fish/guestfish.pod:995
21956 #: ../fish/guestfish.pod:998
21957 msgid "Without any parameter, this provides general help."
21961 #: ../fish/guestfish.pod:1000
21962 msgid "With a C<cmd> parameter, this displays detailed help for that command."
21966 #: ../fish/guestfish.pod:1002
21967 msgid "quit | exit"
21971 #: ../fish/guestfish.pod:1004
21972 msgid "This exits guestfish. You can also use C<^D> key."
21976 #: ../fish/guestfish.pod:1006
21977 msgid "@FISH_COMMANDS@"
21981 #: ../fish/guestfish.pod:1008
21986 #: ../fish/guestfish.pod:1012 ../test-tool/libguestfs-test-tool.pod:77
21991 #: ../fish/guestfish.pod:1014
21993 "guestfish returns 0 if the commands completed without error, or 1 if there "
21998 #: ../fish/guestfish.pod:1021
22003 #: ../fish/guestfish.pod:1023
22005 "The C<edit> command uses C<$EDITOR> as the editor. If not set, it uses "
22010 #: ../fish/guestfish.pod:1026
22011 msgid "GUESTFISH_DISPLAY_IMAGE"
22015 #: ../fish/guestfish.pod:1028
22017 "The C<display> command uses C<$GUESTFISH_DISPLAY_IMAGE> to display images. "
22018 "If not set, it uses L<display(1)>."
22022 #: ../fish/guestfish.pod:1031
22023 msgid "GUESTFISH_PID"
22027 #: ../fish/guestfish.pod:1033
22029 "Used with the I<--remote> option to specify the remote guestfish process to "
22030 "control. See section L</REMOTE CONTROL GUESTFISH OVER A SOCKET>."
22034 #: ../fish/guestfish.pod:1037
22039 #: ../fish/guestfish.pod:1039
22041 "The L</hexedit> command uses C<$HEXEDITOR> as the external hex editor. If "
22042 "not specified, the external L<hexedit(1)> program is used."
22046 #: ../fish/guestfish.pod:1043
22051 #: ../fish/guestfish.pod:1045
22053 "If compiled with GNU readline support, various files in the home directory "
22054 "can be used. See L</FILES>."
22058 #: ../fish/guestfish.pod:1054
22060 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
22061 "effect as using the B<-v> option."
22065 #: ../fish/guestfish.pod:1066
22067 "Set the path that guestfish uses to search for kernel and initrd.img. See "
22068 "the discussion of paths in L<guestfs(3)>."
22072 #: ../fish/guestfish.pod:1077
22073 msgid "Set C<LIBGUESTFS_TRACE=1> to enable command traces."
22077 #: ../fish/guestfish.pod:1079
22082 #: ../fish/guestfish.pod:1081
22084 "The C<more> command uses C<$PAGER> as the pager. If not set, it uses "
22089 #: ../fish/guestfish.pod:1097 ../fuse/guestmount.pod:264
22094 #: ../fish/guestfish.pod:1101 ../fuse/guestmount.pod:268
22095 msgid "$HOME/.libguestfs-tools.rc"
22099 #: ../fish/guestfish.pod:1103 ../fuse/guestmount.pod:270
22100 msgid "/etc/libguestfs-tools.conf"
22104 #: ../fish/guestfish.pod:1105 ../fuse/guestmount.pod:272
22106 "This configuration file controls the default read-only or read-write mode "
22107 "(I<--ro> or I<--rw>)."
22111 #: ../fish/guestfish.pod:1108
22112 msgid "See L</OPENING DISKS FOR READ AND WRITE>."
22116 #: ../fish/guestfish.pod:1110
22117 msgid "$HOME/.guestfish"
22121 #: ../fish/guestfish.pod:1112
22123 "If compiled with GNU readline support, then the command history is saved in "
22128 #: ../fish/guestfish.pod:1115
22129 msgid "$HOME/.inputrc"
22133 #: ../fish/guestfish.pod:1117
22134 msgid "/etc/inputrc"
22138 #: ../fish/guestfish.pod:1119
22140 "If compiled with GNU readline support, then these files can be used to "
22141 "configure readline. For further information, please see L<readline(3)/"
22142 "INITIALIZATION FILE>."
22146 #: ../fish/guestfish.pod:1123
22147 msgid "To write rules which only apply to guestfish, use:"
22151 #: ../fish/guestfish.pod:1125
22161 #: ../fish/guestfish.pod:1129
22163 "Variables that you can set in inputrc that change the behaviour of guestfish "
22164 "in useful ways include:"
22168 #: ../fish/guestfish.pod:1134
22169 msgid "completion-ignore-case (default: on)"
22173 #: ../fish/guestfish.pod:1136
22175 "By default, guestfish will ignore case when tab-completing paths on the "
22180 #: ../fish/guestfish.pod:1139
22183 " set completion-ignore-case off\n"
22188 #: ../fish/guestfish.pod:1141
22189 msgid "to make guestfish case sensitive."
22193 #: ../fish/guestfish.pod:1145
22198 #: ../fish/guestfish.pod:1147
22199 msgid "test2.img (etc)"
22203 #: ../fish/guestfish.pod:1149
22205 "When using the I<-N> or I<--new> option, the prepared disk or filesystem "
22206 "will be created in the file C<test1.img> in the current directory. The "
22207 "second use of I<-N> will use C<test2.img> and so on. Any existing file with "
22208 "the same name will be overwritten."
22212 #: ../fish/guestfish.pod:1158
22214 "L<guestfs(3)>, L<http://libguestfs.org/>, L<virt-cat(1)>, L<virt-copy-in(1)"
22215 ">, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, L<virt-filesystems(1)"
22216 ">, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, L<virt-list-partitions"
22217 "(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, L<virt-rescue(1)>, L<virt-resize(1)"
22218 ">, L<virt-tar(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<virt-win-reg(1)"
22219 ">, L<display(1)>, L<hexedit(1)>."
22223 #: ../fish/guestfish.pod:1189 ../test-tool/libguestfs-test-tool.pod:102
22224 #: ../fuse/guestmount.pod:299 ../tools/virt-win-reg.pl:778
22225 #: ../tools/virt-list-filesystems.pl:210 ../tools/virt-tar.pl:309
22226 #: ../tools/virt-make-fs.pl:572 ../tools/virt-list-partitions.pl:277
22228 "This program is free software; you can redistribute it and/or modify it "
22229 "under the terms of the GNU General Public License as published by the Free "
22230 "Software Foundation; either version 2 of the License, or (at your option) "
22231 "any later version."
22235 #: ../fish/guestfish.pod:1194 ../test-tool/libguestfs-test-tool.pod:107
22236 #: ../fuse/guestmount.pod:304 ../tools/virt-win-reg.pl:783
22237 #: ../tools/virt-list-filesystems.pl:215 ../tools/virt-tar.pl:314
22238 #: ../tools/virt-make-fs.pl:577 ../tools/virt-list-partitions.pl:282
22240 "This program is distributed in the hope that it will be useful, but WITHOUT "
22241 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
22242 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for "
22247 #: ../fish/guestfish.pod:1199 ../test-tool/libguestfs-test-tool.pod:112
22248 #: ../fuse/guestmount.pod:309 ../tools/virt-win-reg.pl:788
22249 #: ../tools/virt-list-filesystems.pl:220 ../tools/virt-tar.pl:319
22250 #: ../tools/virt-make-fs.pl:582 ../tools/virt-list-partitions.pl:287
22252 "You should have received a copy of the GNU General Public License along with "
22253 "this program; if not, write to the Free Software Foundation, Inc., 675 Mass "
22254 "Ave, Cambridge, MA 02139, USA."
22258 #: ../fish/guestfish-actions.pod:1
22263 #: ../fish/guestfish-actions.pod:3
22266 " add-cdrom filename\n"
22271 #: ../fish/guestfish-actions.pod:15
22273 "This call checks for the existence of C<filename>. This stops you from "
22274 "specifying other types of drive which are supported by qemu such as C<nbd:> "
22275 "and C<http:> URLs. To specify those, use the general L</config> call "
22280 #: ../fish/guestfish-actions.pod:22
22282 "If you just want to add an ISO file (often you use this as an efficient way "
22283 "to transfer large files into the guest), then you should probably use L</add-"
22284 "drive-ro> instead."
22288 #: ../fish/guestfish-actions.pod:35
22293 #: ../fish/guestfish-actions.pod:37
22298 #: ../fish/guestfish-actions.pod:39
22301 " add-domain dom [libvirturi:..] [readonly:..] [iface:..] [live:..] [allowuuid:..]\n"
22306 #: ../fish/guestfish-actions.pod:41
22308 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
22309 "It works by connecting to libvirt, requesting the domain and domain XML from "
22310 "libvirt, parsing it for disks, and calling L</add-drive-opts> on each one."
22314 #: ../fish/guestfish-actions.pod:76
22316 "The other optional parameters are passed directly through to L</add-drive-"
22321 #: ../fish/guestfish-actions.pod:79 ../fish/guestfish-actions.pod:143
22322 #: ../fish/guestfish-actions.pod:1937 ../fish/guestfish-actions.pod:3087
22323 #: ../fish/guestfish-actions.pod:3260
22325 "This command has one or more optional arguments. See L</OPTIONAL ARGUMENTS>."
22329 #: ../fish/guestfish-actions.pod:81
22334 #: ../fish/guestfish-actions.pod:83
22337 " add-drive filename\n"
22342 #: ../fish/guestfish-actions.pod:85
22344 "This function is the equivalent of calling L</add-drive-opts> with no "
22345 "optional parameters, so the disk is added writable, with the format being "
22346 "detected automatically."
22350 #: ../fish/guestfish-actions.pod:89
22352 "Automatic detection of the format opens you up to a potential security hole "
22353 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
22354 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
22355 "you should think about replacing calls to this function with calls to L</add-"
22356 "drive-opts>, and specifying the format."
22360 #: ../fish/guestfish-actions.pod:96
22361 msgid "add-drive-opts"
22365 #: ../fish/guestfish-actions.pod:98
22370 #: ../fish/guestfish-actions.pod:100
22373 " add-drive-opts filename [readonly:..] [format:..] [iface:..]\n"
22378 #: ../fish/guestfish-actions.pod:127
22380 "This forces the image format. If you omit this (or use L</add-drive> or L</"
22381 "add-drive-ro>) then the format is automatically detected. Possible formats "
22382 "include C<raw> and C<qcow2>."
22386 #: ../fish/guestfish-actions.pod:138
22388 "This rarely-used option lets you emulate the behaviour of the deprecated L</"
22389 "add-drive-with-if> call (q.v.)"
22393 #: ../fish/guestfish-actions.pod:145
22394 msgid "add-drive-ro"
22398 #: ../fish/guestfish-actions.pod:147
22403 #: ../fish/guestfish-actions.pod:149
22406 " add-drive-ro filename\n"
22411 #: ../fish/guestfish-actions.pod:151
22413 "This function is the equivalent of calling L</add-drive-opts> with the "
22414 "optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the disk "
22415 "is added read-only, with the format being detected automatically."
22419 #: ../fish/guestfish-actions.pod:156
22420 msgid "add-drive-ro-with-if"
22424 #: ../fish/guestfish-actions.pod:158
22427 " add-drive-ro-with-if filename iface\n"
22432 #: ../fish/guestfish-actions.pod:160
22434 "This is the same as L</add-drive-ro> but it allows you to specify the QEMU "
22435 "interface emulation to use at run time."
22439 #: ../fish/guestfish-actions.pod:170
22440 msgid "add-drive-with-if"
22444 #: ../fish/guestfish-actions.pod:172
22447 " add-drive-with-if filename iface\n"
22452 #: ../fish/guestfish-actions.pod:174
22454 "This is the same as L</add-drive> but it allows you to specify the QEMU "
22455 "interface emulation to use at run time."
22459 #: ../fish/guestfish-actions.pod:184
22464 #: ../fish/guestfish-actions.pod:186
22467 " aug-clear augpath\n"
22472 #: ../fish/guestfish-actions.pod:191
22477 #: ../fish/guestfish-actions.pod:193
22485 #: ../fish/guestfish-actions.pod:195
22487 "Close the current Augeas handle and free up any resources used by it. After "
22488 "calling this, you have to call L</aug-init> again before you can use any "
22489 "other Augeas functions."
22493 #: ../fish/guestfish-actions.pod:200
22494 msgid "aug-defnode"
22498 #: ../fish/guestfish-actions.pod:202
22501 " aug-defnode name expr val\n"
22506 #: ../fish/guestfish-actions.pod:207
22508 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
22509 "calling L</aug-set> C<expr>, C<value>. C<name> will be the nodeset "
22510 "containing that single node."
22514 #: ../fish/guestfish-actions.pod:215
22519 #: ../fish/guestfish-actions.pod:217
22522 " aug-defvar name expr\n"
22527 #: ../fish/guestfish-actions.pod:226
22532 #: ../fish/guestfish-actions.pod:228
22535 " aug-get augpath\n"
22540 #: ../fish/guestfish-actions.pod:233
22545 #: ../fish/guestfish-actions.pod:235
22548 " aug-init root flags\n"
22553 #: ../fish/guestfish-actions.pod:241
22554 msgid "You must call this before using any other L</aug-*> commands."
22558 #: ../fish/guestfish-actions.pod:276
22559 msgid "Do not load the tree in L</aug-init>."
22563 #: ../fish/guestfish-actions.pod:280
22564 msgid "To close the handle, you can call L</aug-close>."
22568 #: ../fish/guestfish-actions.pod:284
22573 #: ../fish/guestfish-actions.pod:286
22576 " aug-insert augpath label true|false\n"
22581 #: ../fish/guestfish-actions.pod:296
22586 #: ../fish/guestfish-actions.pod:298
22594 #: ../fish/guestfish-actions.pod:305
22599 #: ../fish/guestfish-actions.pod:307
22602 " aug-ls augpath\n"
22607 #: ../fish/guestfish-actions.pod:309
22609 "This is just a shortcut for listing L</aug-match> C<path/*> and sorting the "
22610 "resulting nodes into alphabetical order."
22614 #: ../fish/guestfish-actions.pod:312
22619 #: ../fish/guestfish-actions.pod:314
22622 " aug-match augpath\n"
22627 #: ../fish/guestfish-actions.pod:320
22632 #: ../fish/guestfish-actions.pod:322
22635 " aug-mv src dest\n"
22640 #: ../fish/guestfish-actions.pod:327
22645 #: ../fish/guestfish-actions.pod:329
22648 " aug-rm augpath\n"
22653 #: ../fish/guestfish-actions.pod:335
22658 #: ../fish/guestfish-actions.pod:337
22666 #: ../fish/guestfish-actions.pod:341
22668 "The flags which were passed to L</aug-init> affect exactly how files are "
22673 #: ../fish/guestfish-actions.pod:344
22678 #: ../fish/guestfish-actions.pod:346
22681 " aug-set augpath val\n"
22686 #: ../fish/guestfish-actions.pod:350
22688 "In the Augeas API, it is possible to clear a node by setting the value to "
22689 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
22690 "this call. Instead you must use the L</aug-clear> call."
22694 #: ../fish/guestfish-actions.pod:355
22699 #: ../fish/guestfish-actions.pod:357
22702 " available 'groups ...'\n"
22707 #: ../fish/guestfish-actions.pod:363
22709 "The libguestfs groups, and the functions that those groups correspond to, "
22710 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
22711 "runtime by calling L</available-all-groups>."
22715 #: ../fish/guestfish-actions.pod:387
22716 msgid "You must call L</launch> before calling this function."
22720 #: ../fish/guestfish-actions.pod:409
22722 "This call was added in version C<1.0.80>. In previous versions of "
22723 "libguestfs all you could do would be to speculatively execute a command to "
22724 "find out if the daemon implemented it. See also L</version>."
22728 #: ../fish/guestfish-actions.pod:416
22729 msgid "available-all-groups"
22733 #: ../fish/guestfish-actions.pod:418
22736 " available-all-groups\n"
22741 #: ../fish/guestfish-actions.pod:420
22743 "This command returns a list of all optional groups that this daemon knows "
22744 "about. Note this returns both supported and unsupported groups. To find "
22745 "out which ones the daemon can actually support you have to call L</"
22746 "available> on each member of the returned list."
22750 #: ../fish/guestfish-actions.pod:426
22751 msgid "See also L</available> and L<guestfs(3)/AVAILABILITY>."
22755 #: ../fish/guestfish-actions.pod:428
22760 #: ../fish/guestfish-actions.pod:430
22763 " base64-in (base64file|-) filename\n"
22768 #: ../fish/guestfish-actions.pod:435 ../fish/guestfish-actions.pod:444
22769 #: ../fish/guestfish-actions.pod:668 ../fish/guestfish-actions.pod:837
22770 #: ../fish/guestfish-actions.pod:856 ../fish/guestfish-actions.pod:1230
22771 #: ../fish/guestfish-actions.pod:4533 ../fish/guestfish-actions.pod:4545
22772 #: ../fish/guestfish-actions.pod:4556 ../fish/guestfish-actions.pod:4567
22773 #: ../fish/guestfish-actions.pod:4619 ../fish/guestfish-actions.pod:4628
22774 #: ../fish/guestfish-actions.pod:4682 ../fish/guestfish-actions.pod:4705
22775 msgid "Use C<-> instead of a filename to read/write from stdin/stdout."
22779 #: ../fish/guestfish-actions.pod:437
22784 #: ../fish/guestfish-actions.pod:439
22787 " base64-out filename (base64file|-)\n"
22792 #: ../fish/guestfish-actions.pod:446
22793 msgid "blockdev-flushbufs"
22797 #: ../fish/guestfish-actions.pod:448
22800 " blockdev-flushbufs device\n"
22805 #: ../fish/guestfish-actions.pod:455
22806 msgid "blockdev-getbsz"
22810 #: ../fish/guestfish-actions.pod:457
22813 " blockdev-getbsz device\n"
22818 #: ../fish/guestfish-actions.pod:466
22819 msgid "blockdev-getro"
22823 #: ../fish/guestfish-actions.pod:468
22826 " blockdev-getro device\n"
22831 #: ../fish/guestfish-actions.pod:475
22832 msgid "blockdev-getsize64"
22836 #: ../fish/guestfish-actions.pod:477
22839 " blockdev-getsize64 device\n"
22844 #: ../fish/guestfish-actions.pod:481
22845 msgid "See also L</blockdev-getsz>."
22849 #: ../fish/guestfish-actions.pod:485
22850 msgid "blockdev-getss"
22854 #: ../fish/guestfish-actions.pod:487
22857 " blockdev-getss device\n"
22862 #: ../fish/guestfish-actions.pod:492
22864 "(Note, this is not the size in sectors, use L</blockdev-getsz> for that)."
22868 #: ../fish/guestfish-actions.pod:497
22869 msgid "blockdev-getsz"
22873 #: ../fish/guestfish-actions.pod:499
22876 " blockdev-getsz device\n"
22881 #: ../fish/guestfish-actions.pod:504
22883 "See also L</blockdev-getss> for the real sector size of the device, and L</"
22884 "blockdev-getsize64> for the more useful I<size in bytes>."
22888 #: ../fish/guestfish-actions.pod:510
22889 msgid "blockdev-rereadpt"
22893 #: ../fish/guestfish-actions.pod:512
22896 " blockdev-rereadpt device\n"
22901 #: ../fish/guestfish-actions.pod:518
22902 msgid "blockdev-setbsz"
22906 #: ../fish/guestfish-actions.pod:520
22909 " blockdev-setbsz device blocksize\n"
22914 #: ../fish/guestfish-actions.pod:529
22915 msgid "blockdev-setro"
22919 #: ../fish/guestfish-actions.pod:531
22922 " blockdev-setro device\n"
22927 #: ../fish/guestfish-actions.pod:537
22928 msgid "blockdev-setrw"
22932 #: ../fish/guestfish-actions.pod:539
22935 " blockdev-setrw device\n"
22940 #: ../fish/guestfish-actions.pod:545
22941 msgid "case-sensitive-path"
22945 #: ../fish/guestfish-actions.pod:547
22948 " case-sensitive-path path\n"
22953 #: ../fish/guestfish-actions.pod:571
22955 "Thus L</case-sensitive-path> (\"/Windows/System32\") might return C<\"/"
22956 "WINDOWS/system32\"> (the exact return value would depend on details of how "
22957 "the directories were originally created under Windows)."
22961 #: ../fish/guestfish-actions.pod:579
22962 msgid "See also L</realpath>."
22966 #: ../fish/guestfish-actions.pod:581
22971 #: ../fish/guestfish-actions.pod:583
22979 #: ../fish/guestfish-actions.pod:587
22981 "Note that this function cannot correctly handle binary files (specifically, "
22982 "files containing C<\\0> character which is treated as end of string). For "
22983 "those you need to use the L</read-file> or L</download> functions which have "
22984 "a more complex interface."
22988 #: ../fish/guestfish-actions.pod:595
22993 #: ../fish/guestfish-actions.pod:597
22996 " checksum csumtype path\n"
23001 #: ../fish/guestfish-actions.pod:640
23002 msgid "To get the checksum for a device, use L</checksum-device>."
23006 #: ../fish/guestfish-actions.pod:642
23007 msgid "To get the checksums for many files, use L</checksums-out>."
23011 #: ../fish/guestfish-actions.pod:644
23012 msgid "checksum-device"
23016 #: ../fish/guestfish-actions.pod:646
23019 " checksum-device csumtype device\n"
23024 #: ../fish/guestfish-actions.pod:648
23026 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
23027 "device named C<device>. For the types of checksums supported see the L</"
23028 "checksum> command."
23032 #: ../fish/guestfish-actions.pod:652
23033 msgid "checksums-out"
23037 #: ../fish/guestfish-actions.pod:654
23040 " checksums-out csumtype directory (sumsfile|-)\n"
23045 #: ../fish/guestfish-actions.pod:670
23050 #: ../fish/guestfish-actions.pod:672
23053 " chmod mode path\n"
23058 #: ../fish/guestfish-actions.pod:683
23063 #: ../fish/guestfish-actions.pod:685
23066 " chown owner group path\n"
23071 #: ../fish/guestfish-actions.pod:693
23076 #: ../fish/guestfish-actions.pod:695
23079 " command 'arguments ...'\n"
23084 #: ../fish/guestfish-actions.pod:702
23086 "The single parameter is an argv-style list of arguments. The first element "
23087 "is the name of the program to run. Subsequent elements are parameters. The "
23088 "list must be non-empty (ie. must contain a program name). Note that the "
23089 "command runs directly, and is I<not> invoked via the shell (see L</sh>)."
23093 #: ../fish/guestfish-actions.pod:730
23094 msgid "command-lines"
23098 #: ../fish/guestfish-actions.pod:732
23101 " command-lines 'arguments ...'\n"
23106 #: ../fish/guestfish-actions.pod:734
23108 "This is the same as L</command>, but splits the result into a list of lines."
23112 #: ../fish/guestfish-actions.pod:737
23113 msgid "See also: L</sh-lines>"
23117 #: ../fish/guestfish-actions.pod:742
23122 #: ../fish/guestfish-actions.pod:744
23125 " config qemuparam qemuvalue\n"
23130 #: ../fish/guestfish-actions.pod:755
23135 #: ../fish/guestfish-actions.pod:757
23138 " copy-size src dest size\n"
23143 #: ../fish/guestfish-actions.pod:765
23148 #: ../fish/guestfish-actions.pod:767
23156 #: ../fish/guestfish-actions.pod:772
23161 #: ../fish/guestfish-actions.pod:774
23169 #: ../fish/guestfish-actions.pod:779
23174 #: ../fish/guestfish-actions.pod:781
23182 #: ../fish/guestfish-actions.pod:788
23184 "If the destination is a device, it must be as large or larger than the "
23185 "source file or device, otherwise the copy will fail. This command cannot do "
23186 "partial copies (see L</copy-size>)."
23190 #: ../fish/guestfish-actions.pod:792
23195 #: ../fish/guestfish-actions.pod:794
23203 #: ../fish/guestfish-actions.pod:798 ../fish/guestfish-actions.pod:809
23205 "This command is mostly useful for interactive sessions. It is I<not> "
23206 "intended that you try to parse the output string. Use L</statvfs> from "
23211 #: ../fish/guestfish-actions.pod:802
23216 #: ../fish/guestfish-actions.pod:804
23224 #: ../fish/guestfish-actions.pod:813
23229 #: ../fish/guestfish-actions.pod:815
23237 #: ../fish/guestfish-actions.pod:821
23239 "Another way to get the same information is to enable verbose messages with "
23240 "L</set-verbose> or by setting the environment variable C<LIBGUESTFS_DEBUG=1> "
23241 "before running the program."
23245 #: ../fish/guestfish-actions.pod:826
23250 #: ../fish/guestfish-actions.pod:828
23253 " download remotefilename (filename|-)\n"
23258 #: ../fish/guestfish-actions.pod:835
23259 msgid "See also L</upload>, L</cat>."
23263 #: ../fish/guestfish-actions.pod:839
23264 msgid "download-offset"
23268 #: ../fish/guestfish-actions.pod:841
23271 " download-offset remotefilename (filename|-) offset size\n"
23276 #: ../fish/guestfish-actions.pod:849
23278 "Note that there is no limit on the amount of data that can be downloaded "
23279 "with this call, unlike with L</pread>, and this call always reads the full "
23280 "amount unless an error occurs."
23284 #: ../fish/guestfish-actions.pod:854
23285 msgid "See also L</download>, L</pread>."
23289 #: ../fish/guestfish-actions.pod:858
23290 msgid "drop-caches"
23294 #: ../fish/guestfish-actions.pod:860
23297 " drop-caches whattodrop\n"
23302 #: ../fish/guestfish-actions.pod:872
23307 #: ../fish/guestfish-actions.pod:874
23315 #: ../fish/guestfish-actions.pod:886
23320 #: ../fish/guestfish-actions.pod:888
23323 " e2fsck-f device\n"
23328 #: ../fish/guestfish-actions.pod:894
23330 "This command is only needed because of L</resize2fs> (q.v.). Normally you "
23331 "should use L</fsck>."
23335 #: ../fish/guestfish-actions.pod:897
23336 msgid "echo-daemon"
23340 #: ../fish/guestfish-actions.pod:899
23343 " echo-daemon 'words ...'\n"
23348 #: ../fish/guestfish-actions.pod:906
23349 msgid "See also L</ping-daemon>."
23353 #: ../fish/guestfish-actions.pod:908
23358 #: ../fish/guestfish-actions.pod:910
23361 " egrep regex path\n"
23366 #: ../fish/guestfish-actions.pod:918
23371 #: ../fish/guestfish-actions.pod:920
23374 " egrepi regex path\n"
23379 #: ../fish/guestfish-actions.pod:928
23384 #: ../fish/guestfish-actions.pod:930
23387 " equal file1 file2\n"
23392 #: ../fish/guestfish-actions.pod:937
23397 #: ../fish/guestfish-actions.pod:939
23405 #: ../fish/guestfish-actions.pod:944
23406 msgid "See also L</is-file>, L</is-dir>, L</stat>."
23410 #: ../fish/guestfish-actions.pod:946
23415 #: ../fish/guestfish-actions.pod:948
23418 " fallocate path len\n"
23423 #: ../fish/guestfish-actions.pod:965
23424 msgid "fallocate64"
23428 #: ../fish/guestfish-actions.pod:967
23431 " fallocate64 path len\n"
23436 #: ../fish/guestfish-actions.pod:973
23438 "Note that this call allocates disk blocks for the file. To create a sparse "
23439 "file use L</truncate-size> instead."
23443 #: ../fish/guestfish-actions.pod:976
23445 "The deprecated call L</fallocate> does the same, but owing to an oversight "
23446 "it only allowed 30 bit lengths to be specified, effectively limiting the "
23447 "maximum size of files created through that call to 1GB."
23451 #: ../fish/guestfish-actions.pod:985
23456 #: ../fish/guestfish-actions.pod:987
23459 " fgrep pattern path\n"
23464 #: ../fish/guestfish-actions.pod:995
23469 #: ../fish/guestfish-actions.pod:997
23472 " fgrepi pattern path\n"
23477 #: ../fish/guestfish-actions.pod:1005
23482 #: ../fish/guestfish-actions.pod:1007
23490 #: ../fish/guestfish-actions.pod:1023
23492 "See also: L<file(1)>, L</vfs-type>, L</lstat>, L</is-file>, L</is-blockdev> "
23493 "(etc), L</is-zero>."
23497 #: ../fish/guestfish-actions.pod:1026
23498 msgid "file-architecture"
23502 #: ../fish/guestfish-actions.pod:1028
23505 " file-architecture filename\n"
23510 #: ../fish/guestfish-actions.pod:1131
23515 #: ../fish/guestfish-actions.pod:1133
23523 #: ../fish/guestfish-actions.pod:1137
23525 "To get other stats about a file, use L</stat>, L</lstat>, L</is-dir>, L</is-"
23526 "file> etc. To get the size of block devices, use L</blockdev-getsize64>."
23530 #: ../fish/guestfish-actions.pod:1141
23535 #: ../fish/guestfish-actions.pod:1143
23538 " fill c len path\n"
23543 #: ../fish/guestfish-actions.pod:1149
23545 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
23546 "L</truncate-size>. To create a file with a pattern of repeating bytes use "
23547 "L</fill-pattern>."
23551 #: ../fish/guestfish-actions.pod:1154
23552 msgid "fill-pattern"
23556 #: ../fish/guestfish-actions.pod:1156
23559 " fill-pattern pattern len path\n"
23564 #: ../fish/guestfish-actions.pod:1158
23566 "This function is like L</fill> except that it creates a new file of length "
23567 "C<len> containing the repeating pattern of bytes in C<pattern>. The pattern "
23568 "is truncated if necessary to ensure the length of the file is exactly C<len> "
23573 #: ../fish/guestfish-actions.pod:1163
23578 #: ../fish/guestfish-actions.pod:1165
23581 " find directory\n"
23586 #: ../fish/guestfish-actions.pod:1179
23587 msgid "then the returned list from L</find> C</tmp> would be 4 elements:"
23591 #: ../fish/guestfish-actions.pod:1192
23592 msgid "See also L</find0>."
23596 #: ../fish/guestfish-actions.pod:1197
23601 #: ../fish/guestfish-actions.pod:1199
23604 " find0 directory (files|-)\n"
23609 #: ../fish/guestfish-actions.pod:1205
23611 "This command works the same way as L</find> with the following exceptions:"
23615 #: ../fish/guestfish-actions.pod:1232
23616 msgid "findfs-label"
23620 #: ../fish/guestfish-actions.pod:1234
23623 " findfs-label label\n"
23628 #: ../fish/guestfish-actions.pod:1240
23629 msgid "To find the label of a filesystem, use L</vfs-label>."
23633 #: ../fish/guestfish-actions.pod:1242
23634 msgid "findfs-uuid"
23638 #: ../fish/guestfish-actions.pod:1244
23641 " findfs-uuid uuid\n"
23646 #: ../fish/guestfish-actions.pod:1250
23647 msgid "To find the UUID of a filesystem, use L</vfs-uuid>."
23651 #: ../fish/guestfish-actions.pod:1252
23656 #: ../fish/guestfish-actions.pod:1254
23659 " fsck fstype device\n"
23664 #: ../fish/guestfish-actions.pod:1284
23669 #: ../fish/guestfish-actions.pod:1286
23677 #: ../fish/guestfish-actions.pod:1293
23678 msgid "get-attach-method"
23682 #: ../fish/guestfish-actions.pod:1295
23685 " get-attach-method\n"
23690 #: ../fish/guestfish-actions.pod:1297
23691 msgid "Return the current attach method. See L</set-attach-method>."
23695 #: ../fish/guestfish-actions.pod:1299
23696 msgid "get-autosync"
23700 #: ../fish/guestfish-actions.pod:1301
23708 #: ../fish/guestfish-actions.pod:1305
23713 #: ../fish/guestfish-actions.pod:1307
23721 #: ../fish/guestfish-actions.pod:1311
23722 msgid "get-e2label"
23726 #: ../fish/guestfish-actions.pod:1313
23729 " get-e2label device\n"
23734 #: ../fish/guestfish-actions.pod:1325
23739 #: ../fish/guestfish-actions.pod:1327
23742 " get-e2uuid device\n"
23747 #: ../fish/guestfish-actions.pod:1339
23748 msgid "get-memsize"
23752 #: ../fish/guestfish-actions.pod:1341
23760 #: ../fish/guestfish-actions.pod:1346
23762 "If L</set-memsize> was not called on this handle, and if "
23763 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
23764 "value for memsize."
23768 #: ../fish/guestfish-actions.pod:1353
23769 msgid "get-network"
23773 #: ../fish/guestfish-actions.pod:1355
23781 #: ../fish/guestfish-actions.pod:1359
23786 #: ../fish/guestfish-actions.pod:1361
23794 #: ../fish/guestfish-actions.pod:1368
23799 #: ../fish/guestfish-actions.pod:1370
23804 #: ../fish/guestfish-actions.pod:1372
23812 #: ../fish/guestfish-actions.pod:1379
23817 #: ../fish/guestfish-actions.pod:1381
23825 #: ../fish/guestfish-actions.pod:1388
23826 msgid "get-recovery-proc"
23830 #: ../fish/guestfish-actions.pod:1390
23833 " get-recovery-proc\n"
23838 #: ../fish/guestfish-actions.pod:1394
23839 msgid "get-selinux"
23843 #: ../fish/guestfish-actions.pod:1396
23851 #: ../fish/guestfish-actions.pod:1398
23853 "This returns the current setting of the selinux flag which is passed to the "
23854 "appliance at boot time. See L</set-selinux>."
23858 #: ../fish/guestfish-actions.pod:1404
23863 #: ../fish/guestfish-actions.pod:1406
23871 #: ../fish/guestfish-actions.pod:1413
23876 #: ../fish/guestfish-actions.pod:1415
23884 #: ../fish/guestfish-actions.pod:1419
23889 #: ../fish/guestfish-actions.pod:1421
23897 #: ../fish/guestfish-actions.pod:1423
23899 "Return the current umask. By default the umask is C<022> unless it has been "
23900 "set by calling L</umask>."
23904 #: ../fish/guestfish-actions.pod:1426
23905 msgid "get-verbose"
23909 #: ../fish/guestfish-actions.pod:1428
23917 #: ../fish/guestfish-actions.pod:1432
23922 #: ../fish/guestfish-actions.pod:1434
23930 #: ../fish/guestfish-actions.pod:1438
23931 msgid "See the documentation about SELINUX in L<guestfs(3)>, and L</setcon>"
23935 #: ../fish/guestfish-actions.pod:1441
23940 #: ../fish/guestfish-actions.pod:1443
23943 " getxattr path name\n"
23948 #: ../fish/guestfish-actions.pod:1445
23950 "Get a single extended attribute from file C<path> named C<name>. This call "
23951 "follows symlinks. If you want to lookup an extended attribute for the "
23952 "symlink itself, use L</lgetxattr>."
23956 #: ../fish/guestfish-actions.pod:1449 ../fish/guestfish-actions.pod:2476
23958 "Normally it is better to get all extended attributes from a file in one go "
23959 "by calling L</getxattrs>. However some Linux filesystem implementations are "
23960 "buggy and do not provide a way to list out attributes. For these "
23961 "filesystems (notably ntfs-3g) you have to know the names of the extended "
23962 "attributes you want in advance and call this function."
23966 #: ../fish/guestfish-actions.pod:1459
23967 msgid "See also: L</getxattrs>, L</lgetxattr>, L<attr(5)>."
23971 #: ../fish/guestfish-actions.pod:1461
23976 #: ../fish/guestfish-actions.pod:1463
23979 " getxattrs path\n"
23984 #: ../fish/guestfish-actions.pod:1471
23985 msgid "See also: L</lgetxattrs>, L<attr(5)>."
23989 #: ../fish/guestfish-actions.pod:1473
23990 msgid "glob-expand"
23994 #: ../fish/guestfish-actions.pod:1475
23997 " glob-expand pattern\n"
24002 #: ../fish/guestfish-actions.pod:1488
24007 #: ../fish/guestfish-actions.pod:1490
24010 " grep regex path\n"
24015 #: ../fish/guestfish-actions.pod:1498
24020 #: ../fish/guestfish-actions.pod:1500
24023 " grepi regex path\n"
24028 #: ../fish/guestfish-actions.pod:1508
24029 msgid "grub-install"
24033 #: ../fish/guestfish-actions.pod:1510
24036 " grub-install root device\n"
24041 #: ../fish/guestfish-actions.pod:1526
24046 #: ../fish/guestfish-actions.pod:1528
24054 #: ../fish/guestfish-actions.pod:1536
24059 #: ../fish/guestfish-actions.pod:1538
24062 " head-n nrlines path\n"
24067 #: ../fish/guestfish-actions.pod:1551
24072 #: ../fish/guestfish-actions.pod:1553
24080 #: ../fish/guestfish-actions.pod:1561
24085 #: ../fish/guestfish-actions.pod:1563
24088 " initrd-cat initrdpath filename\n"
24093 #: ../fish/guestfish-actions.pod:1575
24094 msgid "See also L</initrd-list>."
24098 #: ../fish/guestfish-actions.pod:1580
24099 msgid "initrd-list"
24103 #: ../fish/guestfish-actions.pod:1582
24106 " initrd-list path\n"
24111 #: ../fish/guestfish-actions.pod:1594
24112 msgid "inotify-add-watch"
24116 #: ../fish/guestfish-actions.pod:1596
24119 " inotify-add-watch path mask\n"
24124 #: ../fish/guestfish-actions.pod:1608
24125 msgid "inotify-close"
24129 #: ../fish/guestfish-actions.pod:1610
24137 #: ../fish/guestfish-actions.pod:1616
24138 msgid "inotify-files"
24142 #: ../fish/guestfish-actions.pod:1618
24150 #: ../fish/guestfish-actions.pod:1620
24152 "This function is a helpful wrapper around L</inotify-read> which just "
24153 "returns a list of pathnames of objects that were touched. The returned "
24154 "pathnames are sorted and deduplicated."
24158 #: ../fish/guestfish-actions.pod:1624
24159 msgid "inotify-init"
24163 #: ../fish/guestfish-actions.pod:1626
24166 " inotify-init maxevents\n"
24171 #: ../fish/guestfish-actions.pod:1632
24173 "C<maxevents> is the maximum number of events which will be queued up between "
24174 "calls to L</inotify-read> or L</inotify-files>. If this is passed as C<0>, "
24175 "then the kernel (or previously set) default is used. For Linux 2.6.29 the "
24176 "default was 16384 events. Beyond this limit, the kernel throws away events, "
24177 "but records the fact that it threw them away by setting a flag "
24178 "C<IN_Q_OVERFLOW> in the returned structure list (see L</inotify-read>)."
24182 #: ../fish/guestfish-actions.pod:1642
24184 "Before any events are generated, you have to add some watches to the "
24185 "internal watch list. See: L</inotify-add-watch>, L</inotify-rm-watch> and "
24186 "L</inotify-watch-all>."
24190 #: ../fish/guestfish-actions.pod:1648
24192 "Queued up events should be read periodically by calling L</inotify-read> (or "
24193 "L</inotify-files> which is just a helpful wrapper around L</inotify-read>). "
24194 "If you don't read the events out often enough then you risk the internal "
24195 "queue overflowing."
24199 #: ../fish/guestfish-actions.pod:1655
24201 "The handle should be closed after use by calling L</inotify-close>. This "
24202 "also removes any watches automatically."
24206 #: ../fish/guestfish-actions.pod:1664
24207 msgid "inotify-read"
24211 #: ../fish/guestfish-actions.pod:1666
24219 #: ../fish/guestfish-actions.pod:1679
24220 msgid "inotify-rm-watch"
24224 #: ../fish/guestfish-actions.pod:1681
24227 " inotify-rm-watch wd\n"
24232 #: ../fish/guestfish-actions.pod:1683
24233 msgid "Remove a previously defined inotify watch. See L</inotify-add-watch>."
24237 #: ../fish/guestfish-actions.pod:1686
24238 msgid "inspect-get-arch"
24242 #: ../fish/guestfish-actions.pod:1688
24245 " inspect-get-arch root\n"
24250 #: ../fish/guestfish-actions.pod:1690
24252 "This returns the architecture of the inspected operating system. The "
24253 "possible return values are listed under L</file-architecture>."
24257 #: ../fish/guestfish-actions.pod:1699
24258 msgid "inspect-get-distro"
24262 #: ../fish/guestfish-actions.pod:1701
24265 " inspect-get-distro root\n"
24270 #: ../fish/guestfish-actions.pod:1782
24271 msgid "inspect-get-drive-mappings"
24275 #: ../fish/guestfish-actions.pod:1784
24278 " inspect-get-drive-mappings root\n"
24283 #: ../fish/guestfish-actions.pod:1811
24285 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
24286 "get-mountpoints>, L</inspect-get-filesystems>."
24290 #: ../fish/guestfish-actions.pod:1815
24291 msgid "inspect-get-filesystems"
24295 #: ../fish/guestfish-actions.pod:1817
24298 " inspect-get-filesystems root\n"
24303 #: ../fish/guestfish-actions.pod:1827
24305 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
24306 "get-mountpoints>."
24310 #: ../fish/guestfish-actions.pod:1830
24311 msgid "inspect-get-format"
24315 #: ../fish/guestfish-actions.pod:1832
24318 " inspect-get-format root\n"
24323 #: ../fish/guestfish-actions.pod:1861
24324 msgid "inspect-get-hostname"
24328 #: ../fish/guestfish-actions.pod:1863
24331 " inspect-get-hostname root\n"
24336 #: ../fish/guestfish-actions.pod:1873
24337 msgid "inspect-get-icon"
24341 #: ../fish/guestfish-actions.pod:1875
24344 " inspect-get-icon root [favicon:..] [highquality:..]\n"
24349 #: ../fish/guestfish-actions.pod:1939
24350 msgid "inspect-get-major-version"
24354 #: ../fish/guestfish-actions.pod:1941
24357 " inspect-get-major-version root\n"
24362 #: ../fish/guestfish-actions.pod:1957
24363 msgid "inspect-get-minor-version"
24367 #: ../fish/guestfish-actions.pod:1959
24370 " inspect-get-minor-version root\n"
24375 #: ../fish/guestfish-actions.pod:1966
24377 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
24378 "get-major-version>."
24382 #: ../fish/guestfish-actions.pod:1969
24383 msgid "inspect-get-mountpoints"
24387 #: ../fish/guestfish-actions.pod:1971
24390 " inspect-get-mountpoints root\n"
24395 #: ../fish/guestfish-actions.pod:1990
24397 "For operating systems like Windows which still use drive letters, this call "
24398 "will only return an entry for the first drive \"mounted on\" C</>. For "
24399 "information about the mapping of drive letters to partitions, see L</inspect-"
24400 "get-drive-mappings>."
24404 #: ../fish/guestfish-actions.pod:1996
24406 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
24407 "get-filesystems>."
24411 #: ../fish/guestfish-actions.pod:1999
24412 msgid "inspect-get-package-format"
24416 #: ../fish/guestfish-actions.pod:2001
24419 " inspect-get-package-format root\n"
24424 #: ../fish/guestfish-actions.pod:2003
24426 "This function and L</inspect-get-package-management> return the package "
24427 "format and package management tool used by the inspected operating system. "
24428 "For example for Fedora these functions would return C<rpm> (package format) "
24429 "and C<yum> (package management)."
24433 #: ../fish/guestfish-actions.pod:2018
24434 msgid "inspect-get-package-management"
24438 #: ../fish/guestfish-actions.pod:2020
24441 " inspect-get-package-management root\n"
24446 #: ../fish/guestfish-actions.pod:2022
24448 "L</inspect-get-package-format> and this function return the package format "
24449 "and package management tool used by the inspected operating system. For "
24450 "example for Fedora these functions would return C<rpm> (package format) and "
24451 "C<yum> (package management)."
24455 #: ../fish/guestfish-actions.pod:2039
24456 msgid "inspect-get-product-name"
24460 #: ../fish/guestfish-actions.pod:2041
24463 " inspect-get-product-name root\n"
24468 #: ../fish/guestfish-actions.pod:2053
24469 msgid "inspect-get-product-variant"
24473 #: ../fish/guestfish-actions.pod:2055
24476 " inspect-get-product-variant root\n"
24481 #: ../fish/guestfish-actions.pod:2076
24483 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
24484 "get-product-name>, L</inspect-get-major-version>."
24488 #: ../fish/guestfish-actions.pod:2080
24489 msgid "inspect-get-roots"
24493 #: ../fish/guestfish-actions.pod:2082
24496 " inspect-get-roots\n"
24501 #: ../fish/guestfish-actions.pod:2084
24503 "This function is a convenient way to get the list of root devices, as "
24504 "returned from a previous call to L</inspect-os>, but without redoing the "
24505 "whole inspection process."
24509 #: ../fish/guestfish-actions.pod:2088
24511 "This returns an empty list if either no root devices were found or the "
24512 "caller has not called L</inspect-os>."
24516 #: ../fish/guestfish-actions.pod:2093
24517 msgid "inspect-get-type"
24521 #: ../fish/guestfish-actions.pod:2095
24524 " inspect-get-type root\n"
24529 #: ../fish/guestfish-actions.pod:2125
24530 msgid "inspect-get-windows-current-control-set"
24534 #: ../fish/guestfish-actions.pod:2127
24537 " inspect-get-windows-current-control-set root\n"
24542 #: ../fish/guestfish-actions.pod:2138
24543 msgid "inspect-get-windows-systemroot"
24547 #: ../fish/guestfish-actions.pod:2140
24550 " inspect-get-windows-systemroot root\n"
24555 #: ../fish/guestfish-actions.pod:2151
24556 msgid "inspect-is-live"
24560 #: ../fish/guestfish-actions.pod:2153
24563 " inspect-is-live root\n"
24568 #: ../fish/guestfish-actions.pod:2155
24570 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
24571 "then this returns true if a live image was detected on the disk."
24575 #: ../fish/guestfish-actions.pod:2161
24576 msgid "inspect-is-multipart"
24580 #: ../fish/guestfish-actions.pod:2163
24583 " inspect-is-multipart root\n"
24588 #: ../fish/guestfish-actions.pod:2165
24590 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
24591 "then this returns true if the disk is part of a set."
24595 #: ../fish/guestfish-actions.pod:2171
24596 msgid "inspect-is-netinst"
24600 #: ../fish/guestfish-actions.pod:2173
24603 " inspect-is-netinst root\n"
24608 #: ../fish/guestfish-actions.pod:2175
24610 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
24611 "then this returns true if the disk is a network installer, ie. not a self-"
24612 "contained install CD but one which is likely to require network access to "
24613 "complete the install."
24617 #: ../fish/guestfish-actions.pod:2183
24618 msgid "inspect-list-applications"
24622 #: ../fish/guestfish-actions.pod:2185
24625 " inspect-list-applications root\n"
24630 #: ../fish/guestfish-actions.pod:2189
24632 "I<Note:> This call works differently from other parts of the inspection "
24633 "API. You have to call L</inspect-os>, then L</inspect-get-mountpoints>, "
24634 "then mount up the disks, before calling this. Listing applications is a "
24635 "significantly more difficult operation which requires access to the full "
24636 "filesystem. Also note that unlike the other L</inspect-get-*> calls which "
24637 "are just returning data cached in the libguestfs handle, this call actually "
24638 "reads parts of the mounted filesystems during the call."
24642 #: ../fish/guestfish-actions.pod:2279
24647 #: ../fish/guestfish-actions.pod:2281
24655 #: ../fish/guestfish-actions.pod:2296
24657 "You can pass the root string(s) returned to other L</inspect-get-*> "
24658 "functions in order to query further information about each operating system, "
24659 "such as the name and version."
24663 #: ../fish/guestfish-actions.pod:2301
24665 "This function uses other libguestfs features such as L</mount-ro> and L</"
24666 "umount-all> in order to mount and unmount filesystems and look at the "
24667 "contents. This should be called with no disks currently mounted. The "
24668 "function may also use Augeas, so any existing Augeas handle will be closed."
24672 #: ../fish/guestfish-actions.pod:2313 ../fish/guestfish-actions.pod:2511
24673 #: ../fish/guestfish-actions.pod:2557
24674 msgid "See also L</list-filesystems>."
24678 #: ../fish/guestfish-actions.pod:2315
24679 msgid "is-blockdev"
24683 #: ../fish/guestfish-actions.pod:2317
24686 " is-blockdev path\n"
24691 #: ../fish/guestfish-actions.pod:2322 ../fish/guestfish-actions.pod:2340
24692 #: ../fish/guestfish-actions.pod:2359 ../fish/guestfish-actions.pod:2368
24693 #: ../fish/guestfish-actions.pod:2378 ../fish/guestfish-actions.pod:2412
24694 #: ../fish/guestfish-actions.pod:2421
24695 msgid "See also L</stat>."
24699 #: ../fish/guestfish-actions.pod:2324
24704 #: ../fish/guestfish-actions.pod:2326
24712 #: ../fish/guestfish-actions.pod:2333
24717 #: ../fish/guestfish-actions.pod:2335
24720 " is-chardev path\n"
24725 #: ../fish/guestfish-actions.pod:2342
24730 #: ../fish/guestfish-actions.pod:2344
24738 #: ../fish/guestfish-actions.pod:2351
24743 #: ../fish/guestfish-actions.pod:2353
24751 #: ../fish/guestfish-actions.pod:2361
24756 #: ../fish/guestfish-actions.pod:2363
24764 #: ../fish/guestfish-actions.pod:2370
24769 #: ../fish/guestfish-actions.pod:2372
24777 #: ../fish/guestfish-actions.pod:2380
24778 msgid "is-launching"
24782 #: ../fish/guestfish-actions.pod:2382
24790 #: ../fish/guestfish-actions.pod:2389
24795 #: ../fish/guestfish-actions.pod:2391
24803 #: ../fish/guestfish-actions.pod:2396
24808 #: ../fish/guestfish-actions.pod:2398
24816 #: ../fish/guestfish-actions.pod:2405
24821 #: ../fish/guestfish-actions.pod:2407
24824 " is-socket path\n"
24829 #: ../fish/guestfish-actions.pod:2414
24834 #: ../fish/guestfish-actions.pod:2416
24837 " is-symlink path\n"
24842 #: ../fish/guestfish-actions.pod:2423
24847 #: ../fish/guestfish-actions.pod:2425
24855 #: ../fish/guestfish-actions.pod:2430
24856 msgid "is-zero-device"
24860 #: ../fish/guestfish-actions.pod:2432
24863 " is-zero-device device\n"
24868 #: ../fish/guestfish-actions.pod:2438
24869 msgid "kill-subprocess"
24873 #: ../fish/guestfish-actions.pod:2440
24876 " kill-subprocess\n"
24881 #: ../fish/guestfish-actions.pod:2444
24886 #: ../fish/guestfish-actions.pod:2446
24891 #: ../fish/guestfish-actions.pod:2448
24899 #: ../fish/guestfish-actions.pod:2456
24904 #: ../fish/guestfish-actions.pod:2458
24907 " lchown owner group path\n"
24912 #: ../fish/guestfish-actions.pod:2460
24914 "Change the file owner to C<owner> and group to C<group>. This is like L</"
24915 "chown> but if C<path> is a symlink then the link itself is changed, not the "
24920 #: ../fish/guestfish-actions.pod:2468
24925 #: ../fish/guestfish-actions.pod:2470
24928 " lgetxattr path name\n"
24933 #: ../fish/guestfish-actions.pod:2486
24934 msgid "See also: L</lgetxattrs>, L</getxattr>, L<attr(5)>."
24938 #: ../fish/guestfish-actions.pod:2488
24943 #: ../fish/guestfish-actions.pod:2490
24946 " lgetxattrs path\n"
24951 #: ../fish/guestfish-actions.pod:2492
24953 "This is the same as L</getxattrs>, but if C<path> is a symbolic link, then "
24954 "it returns the extended attributes of the link itself."
24958 #: ../fish/guestfish-actions.pod:2496
24963 #: ../fish/guestfish-actions.pod:2498
24971 #: ../fish/guestfish-actions.pod:2503
24972 msgid "list-devices"
24976 #: ../fish/guestfish-actions.pod:2505
24984 #: ../fish/guestfish-actions.pod:2513
24985 msgid "list-filesystems"
24989 #: ../fish/guestfish-actions.pod:2515
24992 " list-filesystems\n"
24997 #: ../fish/guestfish-actions.pod:2534
24999 "This command runs other libguestfs commands, which might include L</mount> "
25000 "and L</umount>, and therefore you should use this soon after launch and only "
25001 "when nothing is mounted."
25005 #: ../fish/guestfish-actions.pod:2538
25007 "Not all of the filesystems returned will be mountable. In particular, swap "
25008 "partitions are returned in the list. Also this command does not check that "
25009 "each filesystem found is valid and mountable, and some filesystems might be "
25010 "mountable but require special options. Filesystems may not all belong to a "
25011 "single logical operating system (use L</inspect-os> to look for OSes)."
25015 #: ../fish/guestfish-actions.pod:2546
25016 msgid "list-partitions"
25020 #: ../fish/guestfish-actions.pod:2548
25023 " list-partitions\n"
25028 #: ../fish/guestfish-actions.pod:2554
25030 "This does not return logical volumes. For that you will need to call L</"
25035 #: ../fish/guestfish-actions.pod:2559
25040 #: ../fish/guestfish-actions.pod:2561
25048 #: ../fish/guestfish-actions.pod:2569
25053 #: ../fish/guestfish-actions.pod:2571
25056 " ln target linkname\n"
25061 #: ../fish/guestfish-actions.pod:2575
25066 #: ../fish/guestfish-actions.pod:2577
25069 " ln-f target linkname\n"
25074 #: ../fish/guestfish-actions.pod:2582
25079 #: ../fish/guestfish-actions.pod:2584
25082 " ln-s target linkname\n"
25087 #: ../fish/guestfish-actions.pod:2588
25092 #: ../fish/guestfish-actions.pod:2590
25095 " ln-sf target linkname\n"
25100 #: ../fish/guestfish-actions.pod:2595
25101 msgid "lremovexattr"
25105 #: ../fish/guestfish-actions.pod:2597
25108 " lremovexattr xattr path\n"
25113 #: ../fish/guestfish-actions.pod:2599
25115 "This is the same as L</removexattr>, but if C<path> is a symbolic link, then "
25116 "it removes an extended attribute of the link itself."
25120 #: ../fish/guestfish-actions.pod:2603
25125 #: ../fish/guestfish-actions.pod:2605
25133 #: ../fish/guestfish-actions.pod:2611
25135 "This command is mostly useful for interactive sessions. Programs should "
25136 "probably use L</readdir> instead."
25140 #: ../fish/guestfish-actions.pod:2614
25145 #: ../fish/guestfish-actions.pod:2616
25148 " lsetxattr xattr val vallen path\n"
25153 #: ../fish/guestfish-actions.pod:2618
25155 "This is the same as L</setxattr>, but if C<path> is a symbolic link, then it "
25156 "sets an extended attribute of the link itself."
25160 #: ../fish/guestfish-actions.pod:2622
25165 #: ../fish/guestfish-actions.pod:2624
25173 #: ../fish/guestfish-actions.pod:2628
25175 "This is the same as L</stat> except that if C<path> is a symbolic link, then "
25176 "the link is stat-ed, not the file it refers to."
25180 #: ../fish/guestfish-actions.pod:2634
25185 #: ../fish/guestfish-actions.pod:2636
25188 " lstatlist path 'names ...'\n"
25193 #: ../fish/guestfish-actions.pod:2638
25195 "This call allows you to perform the L</lstat> operation on multiple files, "
25196 "where all files are in the directory C<path>. C<names> is the list of files "
25197 "from this directory."
25201 #: ../fish/guestfish-actions.pod:2647
25203 "This call is intended for programs that want to efficiently list a directory "
25204 "contents without making many round-trips. See also L</lxattrlist> for a "
25205 "similarly efficient call for getting extended attributes. Very long "
25206 "directory listings might cause the protocol message size to be exceeded, "
25207 "causing this call to fail. The caller must split up such requests into "
25208 "smaller groups of names."
25212 #: ../fish/guestfish-actions.pod:2655
25213 msgid "luks-add-key"
25217 #: ../fish/guestfish-actions.pod:2657
25220 " luks-add-key device keyslot\n"
25225 #: ../fish/guestfish-actions.pod:2664
25227 "Note that if C<keyslot> already contains a key, then this command will "
25228 "fail. You have to use L</luks-kill-slot> first to remove that key."
25232 #: ../fish/guestfish-actions.pod:2668 ../fish/guestfish-actions.pod:2690
25233 #: ../fish/guestfish-actions.pod:2703 ../fish/guestfish-actions.pod:2717
25234 #: ../fish/guestfish-actions.pod:2740 ../fish/guestfish-actions.pod:2750
25236 "This command has one or more key or passphrase parameters. Guestfish will "
25237 "prompt for these separately."
25241 #: ../fish/guestfish-actions.pod:2671
25246 #: ../fish/guestfish-actions.pod:2673
25249 " luks-close device\n"
25254 #: ../fish/guestfish-actions.pod:2675
25256 "This closes a LUKS device that was created earlier by L</luks-open> or L</"
25257 "luks-open-ro>. The C<device> parameter must be the name of the LUKS mapping "
25258 "device (ie. C</dev/mapper/mapname>) and I<not> the name of the underlying "
25263 #: ../fish/guestfish-actions.pod:2681
25264 msgid "luks-format"
25268 #: ../fish/guestfish-actions.pod:2683
25271 " luks-format device keyslot\n"
25276 #: ../fish/guestfish-actions.pod:2696
25277 msgid "luks-format-cipher"
25281 #: ../fish/guestfish-actions.pod:2698
25284 " luks-format-cipher device keyslot cipher\n"
25289 #: ../fish/guestfish-actions.pod:2700
25291 "This command is the same as L</luks-format> but it also allows you to set "
25292 "the C<cipher> used."
25296 #: ../fish/guestfish-actions.pod:2709
25297 msgid "luks-kill-slot"
25301 #: ../fish/guestfish-actions.pod:2711
25304 " luks-kill-slot device keyslot\n"
25309 #: ../fish/guestfish-actions.pod:2720
25314 #: ../fish/guestfish-actions.pod:2722
25317 " luks-open device mapname\n"
25322 #: ../fish/guestfish-actions.pod:2736
25324 "If this block device contains LVM volume groups, then calling L</vgscan> "
25325 "followed by L</vg-activate-all> will make them visible."
25329 #: ../fish/guestfish-actions.pod:2743
25330 msgid "luks-open-ro"
25334 #: ../fish/guestfish-actions.pod:2745
25337 " luks-open-ro device mapname\n"
25342 #: ../fish/guestfish-actions.pod:2747
25344 "This is the same as L</luks-open> except that a read-only mapping is created."
25348 #: ../fish/guestfish-actions.pod:2753
25353 #: ../fish/guestfish-actions.pod:2755
25356 " lvcreate logvol volgroup mbytes\n"
25361 #: ../fish/guestfish-actions.pod:2760
25362 msgid "lvm-canonical-lv-name"
25366 #: ../fish/guestfish-actions.pod:2762
25369 " lvm-canonical-lv-name lvname\n"
25374 #: ../fish/guestfish-actions.pod:2771
25375 msgid "See also L</is-lv>."
25379 #: ../fish/guestfish-actions.pod:2773
25380 msgid "lvm-clear-filter"
25384 #: ../fish/guestfish-actions.pod:2775
25387 " lvm-clear-filter\n"
25392 #: ../fish/guestfish-actions.pod:2777
25394 "This undoes the effect of L</lvm-set-filter>. LVM will be able to see every "
25399 #: ../fish/guestfish-actions.pod:2783
25400 msgid "lvm-remove-all"
25404 #: ../fish/guestfish-actions.pod:2785
25407 " lvm-remove-all\n"
25412 #: ../fish/guestfish-actions.pod:2793
25413 msgid "lvm-set-filter"
25417 #: ../fish/guestfish-actions.pod:2795
25420 " lvm-set-filter 'devices ...'\n"
25425 #: ../fish/guestfish-actions.pod:2820
25430 #: ../fish/guestfish-actions.pod:2822
25433 " lvremove device\n"
25438 #: ../fish/guestfish-actions.pod:2830
25443 #: ../fish/guestfish-actions.pod:2832
25446 " lvrename logvol newlogvol\n"
25451 #: ../fish/guestfish-actions.pod:2836
25456 #: ../fish/guestfish-actions.pod:2838
25459 " lvresize device mbytes\n"
25464 #: ../fish/guestfish-actions.pod:2844
25465 msgid "lvresize-free"
25469 #: ../fish/guestfish-actions.pod:2846
25472 " lvresize-free lv percent\n"
25477 #: ../fish/guestfish-actions.pod:2854
25482 #: ../fish/guestfish-actions.pod:2856
25490 #: ../fish/guestfish-actions.pod:2864
25491 msgid "See also L</lvs-full>, L</list-filesystems>."
25495 #: ../fish/guestfish-actions.pod:2866
25500 #: ../fish/guestfish-actions.pod:2868
25508 #: ../fish/guestfish-actions.pod:2873
25513 #: ../fish/guestfish-actions.pod:2875
25521 #: ../fish/guestfish-actions.pod:2879
25526 #: ../fish/guestfish-actions.pod:2881
25529 " lxattrlist path 'names ...'\n"
25534 #: ../fish/guestfish-actions.pod:2897
25536 "This call is intended for programs that want to efficiently list a directory "
25537 "contents without making many round-trips. See also L</lstatlist> for a "
25538 "similarly efficient call for getting standard stats. Very long directory "
25539 "listings might cause the protocol message size to be exceeded, causing this "
25540 "call to fail. The caller must split up such requests into smaller groups of "
25545 #: ../fish/guestfish-actions.pod:2905
25550 #: ../fish/guestfish-actions.pod:2907
25558 #: ../fish/guestfish-actions.pod:2911
25563 #: ../fish/guestfish-actions.pod:2913
25566 " mkdir-mode path mode\n"
25571 #: ../fish/guestfish-actions.pod:2922
25572 msgid "See also L</mkdir>, L</umask>"
25576 #: ../fish/guestfish-actions.pod:2924
25581 #: ../fish/guestfish-actions.pod:2926
25589 #: ../fish/guestfish-actions.pod:2931
25594 #: ../fish/guestfish-actions.pod:2933
25597 " mkdtemp template\n"
25602 #: ../fish/guestfish-actions.pod:2954
25607 #: ../fish/guestfish-actions.pod:2956
25610 " mke2fs-J fstype blocksize device journal\n"
25615 #: ../fish/guestfish-actions.pod:2964
25616 msgid "See also L</mke2journal>."
25620 #: ../fish/guestfish-actions.pod:2966
25625 #: ../fish/guestfish-actions.pod:2968
25628 " mke2fs-JL fstype blocksize device label\n"
25633 #: ../fish/guestfish-actions.pod:2973
25634 msgid "See also L</mke2journal-L>."
25638 #: ../fish/guestfish-actions.pod:2975
25643 #: ../fish/guestfish-actions.pod:2977
25646 " mke2fs-JU fstype blocksize device uuid\n"
25651 #: ../fish/guestfish-actions.pod:2982
25652 msgid "See also L</mke2journal-U>."
25656 #: ../fish/guestfish-actions.pod:2984
25657 msgid "mke2journal"
25661 #: ../fish/guestfish-actions.pod:2986
25664 " mke2journal blocksize device\n"
25669 #: ../fish/guestfish-actions.pod:2993
25670 msgid "mke2journal-L"
25674 #: ../fish/guestfish-actions.pod:2995
25677 " mke2journal-L blocksize label device\n"
25682 #: ../fish/guestfish-actions.pod:2999
25683 msgid "mke2journal-U"
25687 #: ../fish/guestfish-actions.pod:3001
25690 " mke2journal-U blocksize uuid device\n"
25695 #: ../fish/guestfish-actions.pod:3005
25700 #: ../fish/guestfish-actions.pod:3007
25703 " mkfifo mode path\n"
25708 #: ../fish/guestfish-actions.pod:3009
25710 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
25711 "is just a convenient wrapper around L</mknod>."
25715 #: ../fish/guestfish-actions.pod:3015
25720 #: ../fish/guestfish-actions.pod:3017
25723 " mkfs fstype device\n"
25728 #: ../fish/guestfish-actions.pod:3023
25733 #: ../fish/guestfish-actions.pod:3025
25736 " mkfs-b fstype blocksize device\n"
25741 #: ../fish/guestfish-actions.pod:3027
25743 "This call is similar to L</mkfs>, but it allows you to control the block "
25744 "size of the resulting filesystem. Supported block sizes depend on the "
25745 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
25749 #: ../fish/guestfish-actions.pod:3042
25754 #: ../fish/guestfish-actions.pod:3044
25757 " mkfs-opts fstype device [blocksize:..] [features:..] [inode:..] [sectorsize:..]\n"
25762 #: ../fish/guestfish-actions.pod:3089
25763 msgid "mkmountpoint"
25767 #: ../fish/guestfish-actions.pod:3091
25770 " mkmountpoint exemptpath\n"
25775 #: ../fish/guestfish-actions.pod:3093
25777 "L</mkmountpoint> and L</rmmountpoint> are specialized calls that can be used "
25778 "to create extra mountpoints before mounting the first filesystem."
25782 #: ../fish/guestfish-actions.pod:3117
25784 "L</mkmountpoint> is not compatible with L</umount-all>. You may get "
25785 "unexpected errors if you try to mix these calls. It is safest to manually "
25786 "unmount filesystems and remove mountpoints after use."
25790 #: ../fish/guestfish-actions.pod:3121
25792 "L</umount-all> unmounts filesystems by sorting the paths longest first, so "
25793 "for this to work for manual mountpoints, you must ensure that the innermost "
25794 "mountpoints have the longest pathnames, as in the example code above."
25798 #: ../fish/guestfish-actions.pod:3128
25800 "Autosync [see L</set-autosync>, this is set by default on handles] can cause "
25801 "L</umount-all> to be called when the handle is closed which can also trigger "
25806 #: ../fish/guestfish-actions.pod:3132
25811 #: ../fish/guestfish-actions.pod:3134
25814 " mknod mode devmajor devminor path\n"
25819 #: ../fish/guestfish-actions.pod:3144
25821 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
25822 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
25823 "regular file). These constants are available in the standard Linux header "
25824 "files, or you can use L</mknod-b>, L</mknod-c> or L</mkfifo> which are "
25825 "wrappers around this command which bitwise OR in the appropriate constant "
25830 #: ../fish/guestfish-actions.pod:3154
25835 #: ../fish/guestfish-actions.pod:3156
25838 " mknod-b mode devmajor devminor path\n"
25843 #: ../fish/guestfish-actions.pod:3158
25845 "This call creates a block device node called C<path> with mode C<mode> and "
25846 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
25847 "wrapper around L</mknod>."
25851 #: ../fish/guestfish-actions.pod:3164
25856 #: ../fish/guestfish-actions.pod:3166
25859 " mknod-c mode devmajor devminor path\n"
25864 #: ../fish/guestfish-actions.pod:3168
25866 "This call creates a char device node called C<path> with mode C<mode> and "
25867 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
25868 "wrapper around L</mknod>."
25872 #: ../fish/guestfish-actions.pod:3174
25877 #: ../fish/guestfish-actions.pod:3176
25885 #: ../fish/guestfish-actions.pod:3180
25890 #: ../fish/guestfish-actions.pod:3182
25893 " mkswap-L label device\n"
25898 #: ../fish/guestfish-actions.pod:3190
25903 #: ../fish/guestfish-actions.pod:3192
25906 " mkswap-U uuid device\n"
25911 #: ../fish/guestfish-actions.pod:3196
25912 msgid "mkswap-file"
25916 #: ../fish/guestfish-actions.pod:3198
25919 " mkswap-file path\n"
25924 #: ../fish/guestfish-actions.pod:3202
25926 "This command just writes a swap file signature to an existing file. To "
25927 "create the file itself, use something like L</fallocate>."
25931 #: ../fish/guestfish-actions.pod:3205
25936 #: ../fish/guestfish-actions.pod:3207
25939 " modprobe modulename\n"
25944 #: ../fish/guestfish-actions.pod:3214
25949 #: ../fish/guestfish-actions.pod:3216
25952 " mount device mountpoint\n"
25957 #: ../fish/guestfish-actions.pod:3232
25959 "B<Important note:> When you use this call, the filesystem options C<sync> "
25960 "and C<noatime> are set implicitly. This was originally done because we "
25961 "thought it would improve reliability, but it turns out that I<-o sync> has a "
25962 "very large negative performance impact and negligible effect on "
25963 "reliability. Therefore we recommend that you avoid using L</mount> in any "
25964 "code that needs performance, and instead use L</mount-options> (use an empty "
25965 "string for the first parameter if you don't want any options)."
25969 #: ../fish/guestfish-actions.pod:3249
25974 #: ../fish/guestfish-actions.pod:3251
25977 " mount-9p mounttag mountpoint [options:..]\n"
25982 #: ../fish/guestfish-actions.pod:3262
25987 #: ../fish/guestfish-actions.pod:3264
25990 " mount-loop file mountpoint\n"
25995 #: ../fish/guestfish-actions.pod:3270
25996 msgid "mount-options"
26000 #: ../fish/guestfish-actions.pod:3272
26003 " mount-options options device mountpoint\n"
26008 #: ../fish/guestfish-actions.pod:3274
26010 "This is the same as the L</mount> command, but it allows you to set the "
26011 "mount options as for the L<mount(8)> I<-o> flag."
26015 #: ../fish/guestfish-actions.pod:3282
26020 #: ../fish/guestfish-actions.pod:3284
26023 " mount-ro device mountpoint\n"
26028 #: ../fish/guestfish-actions.pod:3286
26030 "This is the same as the L</mount> command, but it mounts the filesystem with "
26031 "the read-only (I<-o ro>) flag."
26035 #: ../fish/guestfish-actions.pod:3289
26040 #: ../fish/guestfish-actions.pod:3291
26043 " mount-vfs options vfstype device mountpoint\n"
26048 #: ../fish/guestfish-actions.pod:3293
26050 "This is the same as the L</mount> command, but it allows you to set both the "
26051 "mount options and the vfstype as for the L<mount(8)> I<-o> and I<-t> flags."
26055 #: ../fish/guestfish-actions.pod:3297
26056 msgid "mountpoints"
26060 #: ../fish/guestfish-actions.pod:3299
26068 #: ../fish/guestfish-actions.pod:3301
26070 "This call is similar to L</mounts>. That call returns a list of devices. "
26071 "This one returns a hash table (map) of device name to directory where the "
26072 "device is mounted."
26076 #: ../fish/guestfish-actions.pod:3305
26081 #: ../fish/guestfish-actions.pod:3307
26089 #: ../fish/guestfish-actions.pod:3314
26090 msgid "See also: L</mountpoints>"
26094 #: ../fish/guestfish-actions.pod:3316
26099 #: ../fish/guestfish-actions.pod:3318
26107 #: ../fish/guestfish-actions.pod:3323
26108 msgid "ntfs-3g-probe"
26112 #: ../fish/guestfish-actions.pod:3325
26115 " ntfs-3g-probe true|false device\n"
26120 #: ../fish/guestfish-actions.pod:3339
26125 #: ../fish/guestfish-actions.pod:3341
26128 " ntfsresize device\n"
26133 #: ../fish/guestfish-actions.pod:3347
26134 msgid "ntfsresize-size"
26138 #: ../fish/guestfish-actions.pod:3349
26141 " ntfsresize-size device size\n"
26146 #: ../fish/guestfish-actions.pod:3351
26148 "This command is the same as L</ntfsresize> except that it allows you to "
26149 "specify the new size (in bytes) explicitly."
26153 #: ../fish/guestfish-actions.pod:3354
26158 #: ../fish/guestfish-actions.pod:3356
26161 " part-add device prlogex startsect endsect\n"
26166 #: ../fish/guestfish-actions.pod:3358
26168 "This command adds a partition to C<device>. If there is no partition table "
26169 "on the device, call L</part-init> first."
26173 #: ../fish/guestfish-actions.pod:3370
26175 "Creating a partition which covers the whole disk is not so easy. Use L</"
26176 "part-disk> to do that."
26180 #: ../fish/guestfish-actions.pod:3373
26185 #: ../fish/guestfish-actions.pod:3375
26188 " part-del device partnum\n"
26193 #: ../fish/guestfish-actions.pod:3383
26198 #: ../fish/guestfish-actions.pod:3385
26201 " part-disk device parttype\n"
26206 #: ../fish/guestfish-actions.pod:3387
26208 "This command is simply a combination of L</part-init> followed by L</part-"
26209 "add> to create a single primary partition covering the whole disk."
26213 #: ../fish/guestfish-actions.pod:3391
26215 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
26216 "possible values are described in L</part-init>."
26220 #: ../fish/guestfish-actions.pod:3397
26221 msgid "part-get-bootable"
26225 #: ../fish/guestfish-actions.pod:3399
26228 " part-get-bootable device partnum\n"
26233 #: ../fish/guestfish-actions.pod:3404
26234 msgid "See also L</part-set-bootable>."
26238 #: ../fish/guestfish-actions.pod:3406
26239 msgid "part-get-mbr-id"
26243 #: ../fish/guestfish-actions.pod:3408
26246 " part-get-mbr-id device partnum\n"
26251 #: ../fish/guestfish-actions.pod:3413 ../fish/guestfish-actions.pod:3551
26253 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
26254 "undefined results for other partition table types (see L</part-get-"
26259 #: ../fish/guestfish-actions.pod:3417
26260 msgid "part-get-parttype"
26264 #: ../fish/guestfish-actions.pod:3419
26267 " part-get-parttype device\n"
26272 #: ../fish/guestfish-actions.pod:3424
26274 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
26275 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
26276 "possible, although unusual. See L</part-init> for a full list."
26280 #: ../fish/guestfish-actions.pod:3429
26285 #: ../fish/guestfish-actions.pod:3431
26288 " part-init device parttype\n"
26293 #: ../fish/guestfish-actions.pod:3437
26295 "Initially there are no partitions. Following this, you should call L</part-"
26296 "add> for each partition required."
26300 #: ../fish/guestfish-actions.pod:3500
26305 #: ../fish/guestfish-actions.pod:3502
26308 " part-list device\n"
26313 #: ../fish/guestfish-actions.pod:3517
26315 "Start of the partition I<in bytes>. To get sectors you have to divide by "
26316 "the device's sector size, see L</blockdev-getss>."
26320 #: ../fish/guestfish-actions.pod:3530
26321 msgid "part-set-bootable"
26325 #: ../fish/guestfish-actions.pod:3532
26328 " part-set-bootable device partnum true|false\n"
26333 #: ../fish/guestfish-actions.pod:3541
26334 msgid "part-set-mbr-id"
26338 #: ../fish/guestfish-actions.pod:3543
26341 " part-set-mbr-id device partnum idbyte\n"
26346 #: ../fish/guestfish-actions.pod:3555
26347 msgid "part-set-name"
26351 #: ../fish/guestfish-actions.pod:3557
26354 " part-set-name device partnum name\n"
26359 #: ../fish/guestfish-actions.pod:3565
26360 msgid "part-to-dev"
26364 #: ../fish/guestfish-actions.pod:3567
26367 " part-to-dev partition\n"
26372 #: ../fish/guestfish-actions.pod:3573
26374 "The named partition must exist, for example as a string returned from L</"
26375 "list-partitions>."
26379 #: ../fish/guestfish-actions.pod:3576
26380 msgid "ping-daemon"
26384 #: ../fish/guestfish-actions.pod:3578
26392 #: ../fish/guestfish-actions.pod:3585
26397 #: ../fish/guestfish-actions.pod:3587
26400 " pread path count offset\n"
26405 #: ../fish/guestfish-actions.pod:3595
26406 msgid "See also L</pwrite>, L</pread-device>."
26410 #: ../fish/guestfish-actions.pod:3600
26411 msgid "pread-device"
26415 #: ../fish/guestfish-actions.pod:3602
26418 " pread-device device count offset\n"
26423 #: ../fish/guestfish-actions.pod:3610
26424 msgid "See also L</pread>."
26428 #: ../fish/guestfish-actions.pod:3615
26433 #: ../fish/guestfish-actions.pod:3617
26436 " pvcreate device\n"
26441 #: ../fish/guestfish-actions.pod:3623
26446 #: ../fish/guestfish-actions.pod:3625
26449 " pvremove device\n"
26454 #: ../fish/guestfish-actions.pod:3634
26459 #: ../fish/guestfish-actions.pod:3636
26462 " pvresize device\n"
26467 #: ../fish/guestfish-actions.pod:3641
26468 msgid "pvresize-size"
26472 #: ../fish/guestfish-actions.pod:3643
26475 " pvresize-size device size\n"
26480 #: ../fish/guestfish-actions.pod:3645
26482 "This command is the same as L</pvresize> except that it allows you to "
26483 "specify the new size (in bytes) explicitly."
26487 #: ../fish/guestfish-actions.pod:3648
26492 #: ../fish/guestfish-actions.pod:3650
26500 #: ../fish/guestfish-actions.pod:3658
26501 msgid "See also L</pvs-full>."
26505 #: ../fish/guestfish-actions.pod:3660
26510 #: ../fish/guestfish-actions.pod:3662
26518 #: ../fish/guestfish-actions.pod:3667
26523 #: ../fish/guestfish-actions.pod:3669
26531 #: ../fish/guestfish-actions.pod:3673
26536 #: ../fish/guestfish-actions.pod:3675
26539 " pwrite path content offset\n"
26544 #: ../fish/guestfish-actions.pod:3686
26545 msgid "See also L</pread>, L</pwrite-device>."
26549 #: ../fish/guestfish-actions.pod:3691
26550 msgid "pwrite-device"
26554 #: ../fish/guestfish-actions.pod:3693
26557 " pwrite-device device content offset\n"
26562 #: ../fish/guestfish-actions.pod:3703
26563 msgid "See also L</pwrite>."
26567 #: ../fish/guestfish-actions.pod:3708
26572 #: ../fish/guestfish-actions.pod:3710
26575 " read-file path\n"
26580 #: ../fish/guestfish-actions.pod:3715
26582 "Unlike L</cat>, this function can correctly handle files that contain "
26583 "embedded ASCII NUL characters. However unlike L</download>, this function "
26584 "is limited in the total size of file that can be handled."
26588 #: ../fish/guestfish-actions.pod:3723
26593 #: ../fish/guestfish-actions.pod:3725
26596 " read-lines path\n"
26601 #: ../fish/guestfish-actions.pod:3732
26603 "Note that this function cannot correctly handle binary files (specifically, "
26604 "files containing C<\\0> character which is treated as end of line). For "
26605 "those you need to use the L</read-file> function which has a more complex "
26610 #: ../fish/guestfish-actions.pod:3737
26615 #: ../fish/guestfish-actions.pod:3739
26623 #: ../fish/guestfish-actions.pod:3791
26625 "This function is primarily intended for use by programs. To get a simple "
26626 "list of names, use L</ls>. To get a printable directory for human "
26627 "consumption, use L</ll>."
26631 #: ../fish/guestfish-actions.pod:3795
26636 #: ../fish/guestfish-actions.pod:3797
26644 #: ../fish/guestfish-actions.pod:3801
26645 msgid "readlinklist"
26649 #: ../fish/guestfish-actions.pod:3803
26652 " readlinklist path 'names ...'\n"
26657 #: ../fish/guestfish-actions.pod:3827
26662 #: ../fish/guestfish-actions.pod:3829
26670 #: ../fish/guestfish-actions.pod:3834
26671 msgid "removexattr"
26675 #: ../fish/guestfish-actions.pod:3836
26678 " removexattr xattr path\n"
26683 #: ../fish/guestfish-actions.pod:3841
26684 msgid "See also: L</lremovexattr>, L<attr(5)>."
26688 #: ../fish/guestfish-actions.pod:3843
26693 #: ../fish/guestfish-actions.pod:3845
26696 " resize2fs device\n"
26701 #: ../fish/guestfish-actions.pod:3850
26703 "I<Note:> It is sometimes required that you run L</e2fsck-f> on the C<device> "
26704 "before calling this command. For unknown reasons C<resize2fs> sometimes "
26705 "gives an error about this and sometimes not. In any case, it is always safe "
26706 "to call L</e2fsck-f> before calling this function."
26710 #: ../fish/guestfish-actions.pod:3856
26711 msgid "resize2fs-M"
26715 #: ../fish/guestfish-actions.pod:3858
26718 " resize2fs-M device\n"
26723 #: ../fish/guestfish-actions.pod:3860
26725 "This command is the same as L</resize2fs>, but the filesystem is resized to "
26726 "its minimum size. This works like the I<-M> option to the C<resize2fs> "
26731 #: ../fish/guestfish-actions.pod:3864
26733 "To get the resulting size of the filesystem you should call L</tune2fs-l> "
26734 "and read the C<Block size> and C<Block count> values. These two numbers, "
26735 "multiplied together, give the resulting size of the minimal filesystem in "
26740 #: ../fish/guestfish-actions.pod:3869
26741 msgid "resize2fs-size"
26745 #: ../fish/guestfish-actions.pod:3871
26748 " resize2fs-size device size\n"
26753 #: ../fish/guestfish-actions.pod:3873
26755 "This command is the same as L</resize2fs> except that it allows you to "
26756 "specify the new size (in bytes) explicitly."
26760 #: ../fish/guestfish-actions.pod:3876
26765 #: ../fish/guestfish-actions.pod:3878
26773 #: ../fish/guestfish-actions.pod:3882
26778 #: ../fish/guestfish-actions.pod:3884
26786 #: ../fish/guestfish-actions.pod:3890
26791 #: ../fish/guestfish-actions.pod:3892
26799 #: ../fish/guestfish-actions.pod:3896
26800 msgid "rmmountpoint"
26804 #: ../fish/guestfish-actions.pod:3898
26807 " rmmountpoint exemptpath\n"
26812 #: ../fish/guestfish-actions.pod:3900
26814 "This calls removes a mountpoint that was previously created with L</"
26815 "mkmountpoint>. See L</mkmountpoint> for full details."
26819 #: ../fish/guestfish-actions.pod:3904
26820 msgid "scrub-device"
26824 #: ../fish/guestfish-actions.pod:3906
26827 " scrub-device device\n"
26832 #: ../fish/guestfish-actions.pod:3917
26837 #: ../fish/guestfish-actions.pod:3919
26840 " scrub-file file\n"
26845 #: ../fish/guestfish-actions.pod:3929
26846 msgid "scrub-freespace"
26850 #: ../fish/guestfish-actions.pod:3931
26853 " scrub-freespace dir\n"
26858 #: ../fish/guestfish-actions.pod:3933
26860 "This command creates the directory C<dir> and then fills it with files until "
26861 "the filesystem is full, and scrubs the files as for L</scrub-file>, and "
26862 "deletes them. The intention is to scrub any free space on the partition "
26863 "containing C<dir>."
26867 #: ../fish/guestfish-actions.pod:3942
26872 #: ../fish/guestfish-actions.pod:3944
26877 #: ../fish/guestfish-actions.pod:3946
26880 " set-append append\n"
26885 #: ../fish/guestfish-actions.pod:3957
26886 msgid "set-attach-method"
26890 #: ../fish/guestfish-actions.pod:3959
26891 msgid "attach-method"
26895 #: ../fish/guestfish-actions.pod:3961
26898 " set-attach-method attachmethod\n"
26903 #: ../fish/guestfish-actions.pod:3983
26904 msgid "set-autosync"
26908 #: ../fish/guestfish-actions.pod:3985
26913 #: ../fish/guestfish-actions.pod:3987
26916 " set-autosync true|false\n"
26921 #: ../fish/guestfish-actions.pod:3997
26926 #: ../fish/guestfish-actions.pod:3999
26931 #: ../fish/guestfish-actions.pod:4001
26934 " set-direct true|false\n"
26939 #: ../fish/guestfish-actions.pod:4007
26941 "One consequence of this is that log messages aren't caught by the library "
26942 "and handled by L</set-log-message-callback>, but go straight to stdout."
26946 #: ../fish/guestfish-actions.pod:4016
26947 msgid "set-e2label"
26951 #: ../fish/guestfish-actions.pod:4018
26954 " set-e2label device label\n"
26959 #: ../fish/guestfish-actions.pod:4024
26961 "You can use either L</tune2fs-l> or L</get-e2label> to return the existing "
26962 "label on a filesystem."
26966 #: ../fish/guestfish-actions.pod:4027
26971 #: ../fish/guestfish-actions.pod:4029
26974 " set-e2uuid device uuid\n"
26979 #: ../fish/guestfish-actions.pod:4036
26981 "You can use either L</tune2fs-l> or L</get-e2uuid> to return the existing "
26982 "UUID of a filesystem."
26986 #: ../fish/guestfish-actions.pod:4039
26987 msgid "set-memsize"
26991 #: ../fish/guestfish-actions.pod:4041
26996 #: ../fish/guestfish-actions.pod:4043
26999 " set-memsize memsize\n"
27004 #: ../fish/guestfish-actions.pod:4045
27006 "This sets the memory size in megabytes allocated to the qemu subprocess. "
27007 "This only has any effect if called before L</launch>."
27011 #: ../fish/guestfish-actions.pod:4056
27012 msgid "set-network"
27016 #: ../fish/guestfish-actions.pod:4058
27021 #: ../fish/guestfish-actions.pod:4060
27024 " set-network true|false\n"
27029 #: ../fish/guestfish-actions.pod:4068
27031 "You must call this before calling L</launch>, otherwise it has no effect."
27035 #: ../fish/guestfish-actions.pod:4071
27040 #: ../fish/guestfish-actions.pod:4073
27045 #: ../fish/guestfish-actions.pod:4075
27048 " set-path searchpath\n"
27053 #: ../fish/guestfish-actions.pod:4084
27058 #: ../fish/guestfish-actions.pod:4086
27063 #: ../fish/guestfish-actions.pod:4088
27071 #: ../fish/guestfish-actions.pod:4108
27072 msgid "set-recovery-proc"
27076 #: ../fish/guestfish-actions.pod:4110
27077 msgid "recovery-proc"
27081 #: ../fish/guestfish-actions.pod:4112
27084 " set-recovery-proc true|false\n"
27089 #: ../fish/guestfish-actions.pod:4114
27091 "If this is called with the parameter C<false> then L</launch> does not "
27092 "create a recovery process. The purpose of the recovery process is to stop "
27093 "runaway qemu processes in the case where the main program aborts abruptly."
27097 #: ../fish/guestfish-actions.pod:4119
27099 "This only has any effect if called before L</launch>, and the default is "
27104 #: ../fish/guestfish-actions.pod:4128
27105 msgid "set-selinux"
27109 #: ../fish/guestfish-actions.pod:4130
27114 #: ../fish/guestfish-actions.pod:4132
27117 " set-selinux true|false\n"
27122 #: ../fish/guestfish-actions.pod:4143
27127 #: ../fish/guestfish-actions.pod:4145
27132 #: ../fish/guestfish-actions.pod:4147
27135 " set-trace true|false\n"
27140 #: ../fish/guestfish-actions.pod:4159
27142 "Trace messages are normally sent to C<stderr>, unless you register a "
27143 "callback to send them somewhere else (see L</set-event-callback>)."
27147 #: ../fish/guestfish-actions.pod:4163
27148 msgid "set-verbose"
27152 #: ../fish/guestfish-actions.pod:4165
27157 #: ../fish/guestfish-actions.pod:4167
27160 " set-verbose true|false\n"
27165 #: ../fish/guestfish-actions.pod:4174
27167 "Verbose messages are normally sent to C<stderr>, unless you register a "
27168 "callback to send them somewhere else (see L</set-event-callback>)."
27172 #: ../fish/guestfish-actions.pod:4178
27177 #: ../fish/guestfish-actions.pod:4180
27180 " setcon context\n"
27185 #: ../fish/guestfish-actions.pod:4187
27190 #: ../fish/guestfish-actions.pod:4189
27193 " setxattr xattr val vallen path\n"
27198 #: ../fish/guestfish-actions.pod:4195
27199 msgid "See also: L</lsetxattr>, L<attr(5)>."
27203 #: ../fish/guestfish-actions.pod:4197
27208 #: ../fish/guestfish-actions.pod:4199
27211 " sfdisk device cyls heads sectors 'lines ...'\n"
27216 #: ../fish/guestfish-actions.pod:4221
27217 msgid "See also: L</sfdisk-l>, L</sfdisk-N>, L</part-init>"
27221 #: ../fish/guestfish-actions.pod:4234
27226 #: ../fish/guestfish-actions.pod:4236
27229 " sfdiskM device 'lines ...'\n"
27234 #: ../fish/guestfish-actions.pod:4238
27236 "This is a simplified interface to the L</sfdisk> command, where partition "
27237 "sizes are specified in megabytes only (rounded to the nearest cylinder) and "
27238 "you don't need to specify the cyls, heads and sectors parameters which were "
27239 "rarely if ever used anyway."
27243 #: ../fish/guestfish-actions.pod:4244
27244 msgid "See also: L</sfdisk>, the L<sfdisk(8)> manpage and L</part-disk>"
27248 #: ../fish/guestfish-actions.pod:4257
27253 #: ../fish/guestfish-actions.pod:4259
27256 " sfdisk-N device partnum cyls heads sectors line\n"
27261 #: ../fish/guestfish-actions.pod:4264
27263 "For other parameters, see L</sfdisk>. You should usually pass C<0> for the "
27264 "cyls/heads/sectors parameters."
27268 #: ../fish/guestfish-actions.pod:4267
27269 msgid "See also: L</part-add>"
27273 #: ../fish/guestfish-actions.pod:4279
27274 msgid "sfdisk-disk-geometry"
27278 #: ../fish/guestfish-actions.pod:4281
27281 " sfdisk-disk-geometry device\n"
27286 #: ../fish/guestfish-actions.pod:4283
27288 "This displays the disk geometry of C<device> read from the partition table. "
27289 "Especially in the case where the underlying block device has been resized, "
27290 "this can be different from the kernel's idea of the geometry (see L</sfdisk-"
27291 "kernel-geometry>)."
27295 #: ../fish/guestfish-actions.pod:4291
27296 msgid "sfdisk-kernel-geometry"
27300 #: ../fish/guestfish-actions.pod:4293
27303 " sfdisk-kernel-geometry device\n"
27308 #: ../fish/guestfish-actions.pod:4300
27313 #: ../fish/guestfish-actions.pod:4302
27316 " sfdisk-l device\n"
27321 #: ../fish/guestfish-actions.pod:4308
27322 msgid "See also: L</part-list>"
27326 #: ../fish/guestfish-actions.pod:4317
27331 #: ../fish/guestfish-actions.pod:4319
27339 #: ../fish/guestfish-actions.pod:4324
27340 msgid "This is like L</command>, but passes the command to:"
27344 #: ../fish/guestfish-actions.pod:4332
27345 msgid "All the provisos about L</command> apply to this call."
27349 #: ../fish/guestfish-actions.pod:4334
27354 #: ../fish/guestfish-actions.pod:4336
27357 " sh-lines command\n"
27362 #: ../fish/guestfish-actions.pod:4338
27363 msgid "This is the same as L</sh>, but splits the result into a list of lines."
27367 #: ../fish/guestfish-actions.pod:4341
27368 msgid "See also: L</command-lines>"
27372 #: ../fish/guestfish-actions.pod:4343
27377 #: ../fish/guestfish-actions.pod:4345
27385 #: ../fish/guestfish-actions.pod:4349
27390 #: ../fish/guestfish-actions.pod:4351
27398 #: ../fish/guestfish-actions.pod:4357
27403 #: ../fish/guestfish-actions.pod:4359
27411 #: ../fish/guestfish-actions.pod:4367
27416 #: ../fish/guestfish-actions.pod:4369
27424 #: ../fish/guestfish-actions.pod:4377
27429 #: ../fish/guestfish-actions.pod:4379
27432 " strings-e encoding path\n"
27437 #: ../fish/guestfish-actions.pod:4381
27439 "This is like the L</strings> command, but allows you to specify the encoding "
27440 "of strings that are looked for in the source file C<path>."
27444 #: ../fish/guestfish-actions.pod:4391
27446 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
27447 "ISO-8859-X (this is what L</strings> uses)."
27451 #: ../fish/guestfish-actions.pod:4423
27452 msgid "swapoff-device"
27456 #: ../fish/guestfish-actions.pod:4425
27459 " swapoff-device device\n"
27464 #: ../fish/guestfish-actions.pod:4427
27466 "This command disables the libguestfs appliance swap device or partition "
27467 "named C<device>. See L</swapon-device>."
27471 #: ../fish/guestfish-actions.pod:4431
27472 msgid "swapoff-file"
27476 #: ../fish/guestfish-actions.pod:4433
27479 " swapoff-file file\n"
27484 #: ../fish/guestfish-actions.pod:4437
27485 msgid "swapoff-label"
27489 #: ../fish/guestfish-actions.pod:4439
27492 " swapoff-label label\n"
27497 #: ../fish/guestfish-actions.pod:4444
27498 msgid "swapoff-uuid"
27502 #: ../fish/guestfish-actions.pod:4446
27505 " swapoff-uuid uuid\n"
27510 #: ../fish/guestfish-actions.pod:4451
27511 msgid "swapon-device"
27515 #: ../fish/guestfish-actions.pod:4453
27518 " swapon-device device\n"
27523 #: ../fish/guestfish-actions.pod:4455
27525 "This command enables the libguestfs appliance to use the swap device or "
27526 "partition named C<device>. The increased memory is made available for all "
27527 "commands, for example those run using L</command> or L</sh>."
27531 #: ../fish/guestfish-actions.pod:4467
27532 msgid "swapon-file"
27536 #: ../fish/guestfish-actions.pod:4469
27539 " swapon-file file\n"
27544 #: ../fish/guestfish-actions.pod:4471
27546 "This command enables swap to a file. See L</swapon-device> for other notes."
27550 #: ../fish/guestfish-actions.pod:4474
27551 msgid "swapon-label"
27555 #: ../fish/guestfish-actions.pod:4476
27558 " swapon-label label\n"
27563 #: ../fish/guestfish-actions.pod:4478
27565 "This command enables swap to a labeled swap partition. See L</swapon-"
27566 "device> for other notes."
27570 #: ../fish/guestfish-actions.pod:4481
27571 msgid "swapon-uuid"
27575 #: ../fish/guestfish-actions.pod:4483
27578 " swapon-uuid uuid\n"
27583 #: ../fish/guestfish-actions.pod:4485
27585 "This command enables swap to a swap partition with the given UUID. See L</"
27586 "swapon-device> for other notes."
27590 #: ../fish/guestfish-actions.pod:4488
27595 #: ../fish/guestfish-actions.pod:4490
27603 #: ../fish/guestfish-actions.pod:4498
27608 #: ../fish/guestfish-actions.pod:4500
27616 #: ../fish/guestfish-actions.pod:4508
27621 #: ../fish/guestfish-actions.pod:4510
27624 " tail-n nrlines path\n"
27629 #: ../fish/guestfish-actions.pod:4523
27634 #: ../fish/guestfish-actions.pod:4525
27637 " tar-in (tarfile|-) directory\n"
27642 #: ../fish/guestfish-actions.pod:4530
27643 msgid "To upload a compressed tarball, use L</tgz-in> or L</txz-in>."
27647 #: ../fish/guestfish-actions.pod:4535
27652 #: ../fish/guestfish-actions.pod:4537
27655 " tar-out directory (tarfile|-)\n"
27660 #: ../fish/guestfish-actions.pod:4542
27661 msgid "To download a compressed tarball, use L</tgz-out> or L</txz-out>."
27665 #: ../fish/guestfish-actions.pod:4547
27670 #: ../fish/guestfish-actions.pod:4549
27673 " tgz-in (tarball|-) directory\n"
27678 #: ../fish/guestfish-actions.pod:4554
27679 msgid "To upload an uncompressed tarball, use L</tar-in>."
27683 #: ../fish/guestfish-actions.pod:4558
27688 #: ../fish/guestfish-actions.pod:4560
27691 " tgz-out directory (tarball|-)\n"
27696 #: ../fish/guestfish-actions.pod:4565
27697 msgid "To download an uncompressed tarball, use L</tar-out>."
27701 #: ../fish/guestfish-actions.pod:4569
27706 #: ../fish/guestfish-actions.pod:4571
27714 #: ../fish/guestfish-actions.pod:4580
27719 #: ../fish/guestfish-actions.pod:4582
27727 #: ../fish/guestfish-actions.pod:4587
27728 msgid "truncate-size"
27732 #: ../fish/guestfish-actions.pod:4589
27735 " truncate-size path size\n"
27740 #: ../fish/guestfish-actions.pod:4594
27742 "If the current file size is less than C<size> then the file is extended to "
27743 "the required size with zero bytes. This creates a sparse file (ie. disk "
27744 "blocks are not allocated for the file until you write to it). To create a "
27745 "non-sparse file of zeroes, use L</fallocate64> instead."
27749 #: ../fish/guestfish-actions.pod:4600
27754 #: ../fish/guestfish-actions.pod:4602
27757 " tune2fs-l device\n"
27762 #: ../fish/guestfish-actions.pod:4612
27767 #: ../fish/guestfish-actions.pod:4614
27770 " txz-in (tarball|-) directory\n"
27775 #: ../fish/guestfish-actions.pod:4621
27780 #: ../fish/guestfish-actions.pod:4623
27783 " txz-out directory (tarball|-)\n"
27788 #: ../fish/guestfish-actions.pod:4630
27793 #: ../fish/guestfish-actions.pod:4632
27801 #: ../fish/guestfish-actions.pod:4646
27802 msgid "See also L</get-umask>, L<umask(2)>, L</mknod>, L</mkdir>."
27806 #: ../fish/guestfish-actions.pod:4651
27811 #: ../fish/guestfish-actions.pod:4653
27816 #: ../fish/guestfish-actions.pod:4655
27819 " umount pathordevice\n"
27824 #: ../fish/guestfish-actions.pod:4661
27829 #: ../fish/guestfish-actions.pod:4663
27830 msgid "unmount-all"
27834 #: ../fish/guestfish-actions.pod:4665
27842 #: ../fish/guestfish-actions.pod:4671
27847 #: ../fish/guestfish-actions.pod:4673
27850 " upload (filename|-) remotefilename\n"
27855 #: ../fish/guestfish-actions.pod:4680
27856 msgid "See also L</download>."
27860 #: ../fish/guestfish-actions.pod:4684
27861 msgid "upload-offset"
27865 #: ../fish/guestfish-actions.pod:4686
27868 " upload-offset (filename|-) remotefilename offset\n"
27873 #: ../fish/guestfish-actions.pod:4698
27875 "Note that there is no limit on the amount of data that can be uploaded with "
27876 "this call, unlike with L</pwrite>, and this call always writes the full "
27877 "amount unless an error occurs."
27881 #: ../fish/guestfish-actions.pod:4703
27882 msgid "See also L</upload>, L</pwrite>."
27886 #: ../fish/guestfish-actions.pod:4707
27891 #: ../fish/guestfish-actions.pod:4709
27894 " utimens path atsecs atnsecs mtsecs mtnsecs\n"
27899 #: ../fish/guestfish-actions.pod:4728
27904 #: ../fish/guestfish-actions.pod:4730
27912 #: ../fish/guestfish-actions.pod:4757
27914 "I<Note:> Don't use this call to test for availability of features. In "
27915 "enterprise distributions we backport features from later versions into "
27916 "earlier versions, making this an unreliable way to test for features. Use "
27917 "L</available> instead."
27921 #: ../fish/guestfish-actions.pod:4763
27926 #: ../fish/guestfish-actions.pod:4765
27929 " vfs-label device\n"
27934 #: ../fish/guestfish-actions.pod:4772
27935 msgid "To find a filesystem from the label, use L</findfs-label>."
27939 #: ../fish/guestfish-actions.pod:4774
27944 #: ../fish/guestfish-actions.pod:4776
27947 " vfs-type device\n"
27952 #: ../fish/guestfish-actions.pod:4786
27957 #: ../fish/guestfish-actions.pod:4788
27960 " vfs-uuid device\n"
27965 #: ../fish/guestfish-actions.pod:4795
27966 msgid "To find a filesystem from the UUID, use L</findfs-uuid>."
27970 #: ../fish/guestfish-actions.pod:4797
27971 msgid "vg-activate"
27975 #: ../fish/guestfish-actions.pod:4799
27978 " vg-activate true|false 'volgroups ...'\n"
27983 #: ../fish/guestfish-actions.pod:4812
27984 msgid "vg-activate-all"
27988 #: ../fish/guestfish-actions.pod:4814
27991 " vg-activate-all true|false\n"
27996 #: ../fish/guestfish-actions.pod:4824
28001 #: ../fish/guestfish-actions.pod:4826
28004 " vgcreate volgroup 'physvols ...'\n"
28009 #: ../fish/guestfish-actions.pod:4831
28014 #: ../fish/guestfish-actions.pod:4833
28017 " vglvuuids vgname\n"
28022 #: ../fish/guestfish-actions.pod:4838
28024 "You can use this along with L</lvs> and L</lvuuid> calls to associate "
28025 "logical volumes and volume groups."
28029 #: ../fish/guestfish-actions.pod:4841
28030 msgid "See also L</vgpvuuids>."
28034 #: ../fish/guestfish-actions.pod:4843
28039 #: ../fish/guestfish-actions.pod:4845
28042 " vgpvuuids vgname\n"
28047 #: ../fish/guestfish-actions.pod:4850
28049 "You can use this along with L</pvs> and L</pvuuid> calls to associate "
28050 "physical volumes and volume groups."
28054 #: ../fish/guestfish-actions.pod:4853
28055 msgid "See also L</vglvuuids>."
28059 #: ../fish/guestfish-actions.pod:4855
28064 #: ../fish/guestfish-actions.pod:4857
28067 " vgremove vgname\n"
28072 #: ../fish/guestfish-actions.pod:4864
28077 #: ../fish/guestfish-actions.pod:4866
28080 " vgrename volgroup newvolgroup\n"
28085 #: ../fish/guestfish-actions.pod:4870
28090 #: ../fish/guestfish-actions.pod:4872
28098 #: ../fish/guestfish-actions.pod:4880
28099 msgid "See also L</vgs-full>."
28103 #: ../fish/guestfish-actions.pod:4882
28108 #: ../fish/guestfish-actions.pod:4884
28116 #: ../fish/guestfish-actions.pod:4889
28121 #: ../fish/guestfish-actions.pod:4891
28129 #: ../fish/guestfish-actions.pod:4896
28134 #: ../fish/guestfish-actions.pod:4898
28142 #: ../fish/guestfish-actions.pod:4902
28147 #: ../fish/guestfish-actions.pod:4904
28155 #: ../fish/guestfish-actions.pod:4909
28160 #: ../fish/guestfish-actions.pod:4911
28168 #: ../fish/guestfish-actions.pod:4916
28173 #: ../fish/guestfish-actions.pod:4918
28181 #: ../fish/guestfish-actions.pod:4923
28186 #: ../fish/guestfish-actions.pod:4925
28189 " write path content\n"
28194 #: ../fish/guestfish-actions.pod:4933
28199 #: ../fish/guestfish-actions.pod:4935
28202 " write-file path content size\n"
28207 #: ../fish/guestfish-actions.pod:4958
28212 #: ../fish/guestfish-actions.pod:4960
28215 " zegrep regex path\n"
28220 #: ../fish/guestfish-actions.pod:4968
28225 #: ../fish/guestfish-actions.pod:4970
28228 " zegrepi regex path\n"
28233 #: ../fish/guestfish-actions.pod:4978
28238 #: ../fish/guestfish-actions.pod:4980
28246 #: ../fish/guestfish-actions.pod:4988
28247 msgid "See also: L</zero-device>, L</scrub-device>, L</is-zero-device>"
28251 #: ../fish/guestfish-actions.pod:4991
28252 msgid "zero-device"
28256 #: ../fish/guestfish-actions.pod:4993
28259 " zero-device device\n"
28264 #: ../fish/guestfish-actions.pod:4995
28266 "This command writes zeroes over the entire C<device>. Compare with L</zero> "
28267 "which just zeroes the first few blocks of a device."
28271 #: ../fish/guestfish-actions.pod:5002
28276 #: ../fish/guestfish-actions.pod:5004
28279 " zerofree device\n"
28284 #: ../fish/guestfish-actions.pod:5017
28289 #: ../fish/guestfish-actions.pod:5019
28292 " zfgrep pattern path\n"
28297 #: ../fish/guestfish-actions.pod:5027
28302 #: ../fish/guestfish-actions.pod:5029
28305 " zfgrepi pattern path\n"
28310 #: ../fish/guestfish-actions.pod:5037
28315 #: ../fish/guestfish-actions.pod:5039
28318 " zfile meth path\n"
28323 #: ../fish/guestfish-actions.pod:5046
28325 "Since 1.0.63, use L</file> instead which can now process compressed files."
28329 #: ../fish/guestfish-actions.pod:5056
28334 #: ../fish/guestfish-actions.pod:5058
28337 " zgrep regex path\n"
28342 #: ../fish/guestfish-actions.pod:5066
28347 #: ../fish/guestfish-actions.pod:5068
28350 " zgrepi regex path\n"
28355 #: ../fish/guestfish-commands.pod:1
28360 #: ../fish/guestfish-commands.pod:3
28365 #: ../fish/guestfish-commands.pod:5
28368 " alloc filename size\n"
28373 #: ../fish/guestfish-commands.pod:7
28375 "This creates an empty (zeroed) file of the given size, and then adds so it "
28376 "can be further examined."
28380 #: ../fish/guestfish-commands.pod:10 ../fish/guestfish-commands.pod:182
28381 msgid "For more advanced image creation, see L<qemu-img(1)> utility."
28385 #: ../fish/guestfish-commands.pod:12 ../fish/guestfish-commands.pod:184
28386 msgid "Size can be specified using standard suffixes, eg. C<1M>."
28390 #: ../fish/guestfish-commands.pod:14
28392 "To create a sparse file, use L</sparse> instead. To create a prepared disk "
28393 "image, see L</PREPARED DISK IMAGES>."
28397 #: ../fish/guestfish-commands.pod:17
28402 #: ../fish/guestfish-commands.pod:19
28405 " copy-in local [local ...] /remotedir\n"
28410 #: ../fish/guestfish-commands.pod:21
28412 "C<copy-in> copies local files or directories recursively into the disk "
28413 "image, placing them in the directory called C</remotedir> (which must "
28414 "exist). This guestfish meta-command turns into a sequence of L</tar-in> and "
28415 "other commands as necessary."
28419 #: ../fish/guestfish-commands.pod:26
28421 "Multiple local files and directories can be specified, but the last "
28422 "parameter must always be a remote directory. Wildcards cannot be used."
28426 #: ../fish/guestfish-commands.pod:30
28431 #: ../fish/guestfish-commands.pod:32
28434 " copy-out remote [remote ...] localdir\n"
28439 #: ../fish/guestfish-commands.pod:34
28441 "C<copy-out> copies remote files or directories recursively out of the disk "
28442 "image, placing them on the host disk in a local directory called C<localdir> "
28443 "(which must exist). This guestfish meta-command turns into a sequence of L</"
28444 "download>, L</tar-out> and other commands as necessary."
28448 #: ../fish/guestfish-commands.pod:40
28450 "Multiple remote files and directories can be specified, but the last "
28451 "parameter must always be a local directory. To download to the current "
28452 "directory, use C<.> as in:"
28456 #: ../fish/guestfish-commands.pod:44
28459 " copy-out /home .\n"
28464 #: ../fish/guestfish-commands.pod:46
28466 "Wildcards cannot be used in the ordinary command, but you can use them with "
28467 "the help of L</glob> like this:"
28471 #: ../fish/guestfish-commands.pod:49
28474 " glob copy-out /home/* .\n"
28479 #: ../fish/guestfish-commands.pod:51
28484 #: ../fish/guestfish-commands.pod:53
28487 " display filename\n"
28492 #: ../fish/guestfish-commands.pod:55
28494 "Use C<display> (a graphical display program) to display an image file. It "
28495 "downloads the file, and runs C<display> on it."
28499 #: ../fish/guestfish-commands.pod:58
28501 "To use an alternative program, set the C<GUESTFISH_DISPLAY_IMAGE> "
28502 "environment variable. For example to use the GNOME display program:"
28506 #: ../fish/guestfish-commands.pod:61
28509 " export GUESTFISH_DISPLAY_IMAGE=eog\n"
28514 #: ../fish/guestfish-commands.pod:63
28516 #| msgid "See L<guestfish(1)>."
28517 msgid "See also L<display(1)>."
28518 msgstr "Див. L<guestfish(1)>."
28521 #: ../fish/guestfish-commands.pod:65
28526 #: ../fish/guestfish-commands.pod:67
28529 " echo [params ...]\n"
28534 #: ../fish/guestfish-commands.pod:69
28535 msgid "This echos the parameters to the terminal."
28539 #: ../fish/guestfish-commands.pod:71
28544 #: ../fish/guestfish-commands.pod:73
28549 #: ../fish/guestfish-commands.pod:75
28554 #: ../fish/guestfish-commands.pod:77
28562 #: ../fish/guestfish-commands.pod:79
28564 "This is used to edit a file. It downloads the file, edits it locally using "
28565 "your editor, then uploads the result."
28569 #: ../fish/guestfish-commands.pod:82
28571 "The editor is C<$EDITOR>. However if you use the alternate commands C<vi> "
28572 "or C<emacs> you will get those corresponding editors."
28576 #: ../fish/guestfish-commands.pod:86
28581 #: ../fish/guestfish-commands.pod:88
28584 " glob command args...\n"
28589 #: ../fish/guestfish-commands.pod:90
28591 "Expand wildcards in any paths in the args list, and run C<command> "
28592 "repeatedly on each matching path."
28596 #: ../fish/guestfish-commands.pod:93
28597 msgid "See L</WILDCARDS AND GLOBBING>."
28601 #: ../fish/guestfish-commands.pod:95
28606 #: ../fish/guestfish-commands.pod:97
28609 " hexedit <filename|device>\n"
28610 " hexedit <filename|device> <max>\n"
28611 " hexedit <filename|device> <start> <max>\n"
28616 #: ../fish/guestfish-commands.pod:101
28618 "Use hexedit (a hex editor) to edit all or part of a binary file or block "
28623 #: ../fish/guestfish-commands.pod:104
28625 "This command works by downloading potentially the whole file or device, "
28626 "editing it locally, then uploading it. If the file or device is large, you "
28627 "have to specify which part you wish to edit by using C<max> and/or C<start> "
28628 "C<max> parameters. C<start> and C<max> are specified in bytes, with the "
28629 "usual modifiers allowed such as C<1M> (1 megabyte)."
28633 #: ../fish/guestfish-commands.pod:111
28634 msgid "For example to edit the first few sectors of a disk you might do:"
28638 #: ../fish/guestfish-commands.pod:114
28641 " hexedit /dev/sda 1M\n"
28646 #: ../fish/guestfish-commands.pod:116
28648 "which would allow you to edit anywhere within the first megabyte of the disk."
28652 #: ../fish/guestfish-commands.pod:119
28653 msgid "To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:"
28657 #: ../fish/guestfish-commands.pod:121
28660 " hexedit /dev/sda1 0x400 0x400\n"
28665 #: ../fish/guestfish-commands.pod:123
28666 msgid "(assuming the superblock is in the standard location)."
28670 #: ../fish/guestfish-commands.pod:125
28672 "This command requires the external L<hexedit(1)> program. You can specify "
28673 "another program to use by setting the C<HEXEDITOR> environment variable."
28677 #: ../fish/guestfish-commands.pod:129
28678 msgid "See also L</hexdump>."
28682 #: ../fish/guestfish-commands.pod:131
28687 #: ../fish/guestfish-commands.pod:133
28695 #: ../fish/guestfish-commands.pod:135
28697 "Change the local directory, ie. the current directory of guestfish itself."
28701 #: ../fish/guestfish-commands.pod:138
28702 msgid "Note that C<!cd> won't do what you might expect."
28706 #: ../fish/guestfish-commands.pod:140
28711 #: ../fish/guestfish-commands.pod:142
28716 #: ../fish/guestfish-commands.pod:144
28724 #: ../fish/guestfish-commands.pod:146
28725 msgid "Opens the manual page for guestfish."
28729 #: ../fish/guestfish-commands.pod:148
28734 #: ../fish/guestfish-commands.pod:150
28739 #: ../fish/guestfish-commands.pod:152
28747 #: ../fish/guestfish-commands.pod:154
28755 #: ../fish/guestfish-commands.pod:156
28756 msgid "This is used to view a file."
28760 #: ../fish/guestfish-commands.pod:158
28762 "The default viewer is C<$PAGER>. However if you use the alternate command "
28763 "C<less> you will get the C<less> command specifically."
28767 #: ../fish/guestfish-commands.pod:161
28772 #: ../fish/guestfish-commands.pod:163
28780 #: ../fish/guestfish-commands.pod:165
28782 "Close and reopen the libguestfs handle. It is not necessary to use this "
28783 "normally, because the handle is closed properly when guestfish exits. "
28784 "However this is occasionally useful for testing."
28788 #: ../fish/guestfish-commands.pod:169
28793 #: ../fish/guestfish-commands.pod:171
28796 " sparse filename size\n"
28801 #: ../fish/guestfish-commands.pod:173
28803 "This creates an empty sparse file of the given size, and then adds so it can "
28804 "be further examined."
28808 #: ../fish/guestfish-commands.pod:176
28810 "In all respects it works the same as the L</alloc> command, except that the "
28811 "image file is allocated sparsely, which means that disk blocks are not "
28812 "assigned to the file until they are needed. Sparse disk files only use "
28813 "space when written to, but they are slower and there is a danger you could "
28814 "run out of real disk space during a write operation."
28818 #: ../fish/guestfish-commands.pod:186
28823 #: ../fish/guestfish-commands.pod:188
28831 #: ../fish/guestfish-commands.pod:190
28833 "This command returns a list of the optional groups known to the daemon, and "
28834 "indicates which ones are supported by this build of the libguestfs appliance."
28838 #: ../fish/guestfish-commands.pod:194
28839 msgid "See also L<guestfs(3)/AVAILABILITY>."
28843 #: ../fish/guestfish-commands.pod:196
28848 #: ../fish/guestfish-commands.pod:198
28851 " time command args...\n"
28856 #: ../fish/guestfish-commands.pod:200
28858 "Run the command as usual, but print the elapsed time afterwards. This can "
28859 "be useful for benchmarking operations."
28863 #: ../test-tool/libguestfs-test-tool.pod:5
28864 msgid "libguestfs-test-tool - End user tests for libguestfs"
28868 #: ../test-tool/libguestfs-test-tool.pod:9
28871 " libguestfs-test-tool [--options]\n"
28876 #: ../test-tool/libguestfs-test-tool.pod:13
28878 "libguestfs-test-tool is a test program shipped with libguestfs to end users "
28879 "and developers, to allow them to check basic libguestfs functionality is "
28880 "working. This is needed because libguestfs occasionally breaks for reasons "
28881 "beyond our control: usually because of changes in the underlying qemu or "
28882 "kernel packages, or the host environment."
28886 #: ../test-tool/libguestfs-test-tool.pod:20
28887 msgid "If you suspect a problem in libguestfs, then just run:"
28891 #: ../test-tool/libguestfs-test-tool.pod:22
28894 " libguestfs-test-tool\n"
28899 #: ../test-tool/libguestfs-test-tool.pod:24
28900 msgid "It will print lots of diagnostic messages."
28904 #: ../test-tool/libguestfs-test-tool.pod:26
28905 msgid "If it runs to completion successfully, you will see this near the end:"
28909 #: ../test-tool/libguestfs-test-tool.pod:28
28912 " ===== TEST FINISHED OK =====\n"
28917 #: ../test-tool/libguestfs-test-tool.pod:30
28918 msgid "and the test tool will exit with code 0."
28922 #: ../test-tool/libguestfs-test-tool.pod:32
28924 "If it fails (and/or exits with non-zero error code), please paste the "
28925 "B<complete, unedited> output of the test tool into a bug report. More "
28926 "information about reporting bugs can be found on the L<http://libguestfs.org/"
28931 #: ../test-tool/libguestfs-test-tool.pod:41
28936 #: ../test-tool/libguestfs-test-tool.pod:43
28937 msgid "Display short usage information and exit."
28941 #: ../test-tool/libguestfs-test-tool.pod:45
28942 msgid "I<--qemu qemu_binary>"
28946 #: ../test-tool/libguestfs-test-tool.pod:47
28948 "If you have downloaded another qemu binary, point this option at the full "
28949 "path of the binary to try it."
28953 #: ../test-tool/libguestfs-test-tool.pod:50
28954 msgid "I<--qemudir qemu_source_dir>"
28958 #: ../test-tool/libguestfs-test-tool.pod:52
28960 "If you have compiled qemu from source, point this option at the source "
28961 "directory to try it."
28965 #: ../test-tool/libguestfs-test-tool.pod:55
28966 msgid "I<--timeout N>"
28970 #: ../test-tool/libguestfs-test-tool.pod:57
28972 "Set the launch timeout to C<N> seconds. The default is 120 seconds which "
28973 "does not usually need to be adjusted unless your machine is very slow."
28977 #: ../test-tool/libguestfs-test-tool.pod:63
28978 msgid "TRYING OUT A DIFFERENT VERSION OF QEMU"
28982 #: ../test-tool/libguestfs-test-tool.pod:65
28984 "If you have compiled another version of qemu from source and would like to "
28985 "try that, then you can use the I<--qemudir> option to point to the qemu "
28986 "source directory."
28990 #: ../test-tool/libguestfs-test-tool.pod:69
28992 "If you have downloaded a qemu binary from somewhere, use the I<--qemu> "
28993 "option to point to the binary."
28997 #: ../test-tool/libguestfs-test-tool.pod:72
28999 "When using an alternate qemu with libguestfs, usually you would need to "
29000 "write a qemu wrapper script (see section I<QEMU WRAPPERS> in L<guestfs(3)"
29001 ">). libguestfs-test-tool writes a temporary qemu wrapper script when you "
29002 "use either of the I<--qemudir> or I<--qemu> options."
29006 #: ../test-tool/libguestfs-test-tool.pod:79
29008 "libguestfs-test-tool returns I<0> if the tests completed without error, or "
29009 "I<1> if there was an error."
29013 #: ../test-tool/libguestfs-test-tool.pod:84
29015 "For the full list of environment variables which may affect libguestfs, "
29016 "please see the L<guestfs(3)> manual page."
29020 #: ../test-tool/libguestfs-test-tool.pod:89
29021 msgid "L<guestfs(3)>, L<http://libguestfs.org/>, L<http://qemu.org/>."
29025 #: ../fuse/guestmount.pod:5
29027 "guestmount - Mount a guest filesystem on the host using FUSE and libguestfs"
29031 #: ../fuse/guestmount.pod:9
29034 " guestmount [--options] -a disk.img -m device [--ro] mountpoint\n"
29039 #: ../fuse/guestmount.pod:11
29042 " guestmount [--options] -a disk.img -i [--ro] mountpoint\n"
29047 #: ../fuse/guestmount.pod:13
29050 " guestmount [--options] -d Guest -i [--ro] mountpoint\n"
29055 #: ../fuse/guestmount.pod:17
29057 "You must I<not> use C<guestmount> in read-write mode on live virtual "
29058 "machines. If you do this, you risk disk corruption in the VM."
29062 #: ../fuse/guestmount.pod:22
29064 "The guestmount program can be used to mount virtual machine filesystems and "
29065 "other disk images on the host. It uses libguestfs for access to the guest "
29066 "filesystem, and FUSE (the \"filesystem in userspace\") to make it appear as "
29067 "a mountable device."
29071 #: ../fuse/guestmount.pod:27
29073 "Along with other options, you have to give at least one device (I<-a> "
29074 "option) or libvirt domain (I<-d> option), and at least one mountpoint (I<-m> "
29075 "option) or use the I<-i> inspection option. How this works is better "
29076 "explained in the L<guestfish(1)> manual page, or by looking at the examples "
29081 #: ../fuse/guestmount.pod:33
29083 "FUSE lets you mount filesystems as non-root. The mountpoint must be owned "
29084 "by you, and the filesystem will not be visible to any other users unless you "
29085 "make certain global configuration changes to C</etc/fuse.conf>. To unmount "
29086 "the filesystem, use the C<fusermount -u> command."
29090 #: ../fuse/guestmount.pod:41
29092 "For a typical Windows guest which has its main filesystem on the first "
29097 #: ../fuse/guestmount.pod:44
29100 " guestmount -a windows.img -m /dev/sda1 --ro /mnt\n"
29105 #: ../fuse/guestmount.pod:46
29107 "For a typical Linux guest which has a /boot filesystem on the first "
29108 "partition, and the root filesystem on a logical volume:"
29112 #: ../fuse/guestmount.pod:49
29115 " guestmount -a linux.img -m /dev/VG/LV -m /dev/sda1:/boot --ro /mnt\n"
29120 #: ../fuse/guestmount.pod:51
29121 msgid "To get libguestfs to detect guest mountpoints for you:"
29125 #: ../fuse/guestmount.pod:53
29128 " guestmount -a guest.img -i --ro /mnt\n"
29133 #: ../fuse/guestmount.pod:55
29134 msgid "For a libvirt guest called \"Guest\" you could do:"
29138 #: ../fuse/guestmount.pod:57
29141 " guestmount -d Guest -i --ro /mnt\n"
29146 #: ../fuse/guestmount.pod:59
29148 "If you don't know what filesystems are contained in a guest or disk image, "
29149 "use L<virt-filesystems(1)> first:"
29153 #: ../fuse/guestmount.pod:62
29156 " virt-filesystems MyGuest\n"
29161 #: ../fuse/guestmount.pod:64
29163 "If you want to trace the libguestfs calls but without excessive debugging "
29164 "information, we recommend:"
29168 #: ../fuse/guestmount.pod:67
29171 " guestmount [...] --trace /mnt\n"
29176 #: ../fuse/guestmount.pod:69
29177 msgid "If you want to debug the program, we recommend:"
29181 #: ../fuse/guestmount.pod:71
29184 " guestmount [...] --trace --verbose /mnt\n"
29189 #: ../fuse/guestmount.pod:73
29194 #: ../fuse/guestmount.pod:75
29195 msgid "Other users cannot see the filesystem by default"
29199 #: ../fuse/guestmount.pod:77
29201 "If you mount a filesystem as one user (eg. root), then other users will not "
29202 "be able to see it by default. The fix is to add the FUSE C<allow_other> "
29203 "option when mounting:"
29207 #: ../fuse/guestmount.pod:81
29210 " sudo guestmount [...] -o allow_other /mnt\n"
29215 #: ../fuse/guestmount.pod:87
29216 msgid "B<-a image> | B<--add image>"
29220 #: ../fuse/guestmount.pod:89
29221 msgid "Add a block device or virtual machine image."
29225 #: ../fuse/guestmount.pod:94
29226 msgid "B<-c URI> | B<--connect URI>"
29230 #: ../fuse/guestmount.pod:100
29231 msgid "B<-d libvirt-domain> | B<--domain libvirt-domain>"
29235 #: ../fuse/guestmount.pod:108
29236 msgid "B<--dir-cache-timeout N>"
29240 #: ../fuse/guestmount.pod:110
29242 "Set the readdir cache timeout to I<N> seconds, the default being 60 "
29243 "seconds. The readdir cache [actually, there are several semi-independent "
29244 "caches] is populated after a readdir(2) call with the stat and extended "
29245 "attributes of the files in the directory, in anticipation that they will be "
29246 "requested soon after."
29250 #: ../fuse/guestmount.pod:116
29252 "There is also a different attribute cache implemented by FUSE (see the FUSE "
29253 "option I<-o attr_timeout>), but the FUSE cache does not anticipate future "
29254 "requests, only cache existing ones."
29258 #: ../fuse/guestmount.pod:127
29259 msgid "B<--format=raw|qcow2|..> | B<--format>"
29263 #: ../fuse/guestmount.pod:134
29265 "If you have untrusted raw-format guest disk images, you should use this "
29266 "option to specify the disk format. This avoids a possible security problem "
29267 "with malicious guests (CVE-2010-3851). See also L<guestfs(3)/"
29268 "guestfs_add_drive_opts>."
29272 #: ../fuse/guestmount.pod:139
29273 msgid "B<--fuse-help>"
29277 #: ../fuse/guestmount.pod:141
29278 msgid "Display help on special FUSE options (see I<-o> below)."
29282 #: ../fuse/guestmount.pod:145
29283 msgid "Display brief help and exit."
29287 #: ../fuse/guestmount.pod:147
29288 msgid "B<-i> | B<--inspector>"
29292 #: ../fuse/guestmount.pod:167
29294 "Mount the named partition or logical volume on the given mountpoint B<in the "
29295 "guest> (this has nothing to do with mountpoints in the host)."
29299 #: ../fuse/guestmount.pod:170
29301 "If the mountpoint is omitted, it defaults to C</>. You have to mount "
29302 "something on C</>."
29306 #: ../fuse/guestmount.pod:183
29307 msgid "B<-n> | B<--no-sync>"
29311 #: ../fuse/guestmount.pod:185
29313 "By default, we attempt to sync the guest disk when the FUSE mountpoint is "
29314 "unmounted. If you specify this option, then we don't attempt to sync the "
29315 "disk. See the discussion of autosync in the L<guestfs(3)> manpage."
29319 #: ../fuse/guestmount.pod:190
29320 msgid "B<-o option> | B<--option option>"
29324 #: ../fuse/guestmount.pod:192
29325 msgid "Pass extra options to FUSE."
29329 #: ../fuse/guestmount.pod:194
29331 "To get a list of all the extra options supported by FUSE, use the command "
29332 "below. Note that only the FUSE I<-o> options can be passed, and only some "
29333 "of them are a good idea."
29337 #: ../fuse/guestmount.pod:198
29340 " guestmount --fuse-help\n"
29345 #: ../fuse/guestmount.pod:200
29346 msgid "Some potentially useful FUSE options:"
29350 #: ../fuse/guestmount.pod:204
29351 msgid "B<-o allow_other>"
29355 #: ../fuse/guestmount.pod:206
29356 msgid "Allow other users to see the filesystem."
29360 #: ../fuse/guestmount.pod:208
29361 msgid "B<-o attr_timeout=N>"
29365 #: ../fuse/guestmount.pod:210
29366 msgid "Enable attribute caching by FUSE, and set the timeout to I<N> seconds."
29370 #: ../fuse/guestmount.pod:212
29371 msgid "B<-o kernel_cache>"
29375 #: ../fuse/guestmount.pod:214
29377 "Allow the kernel to cache files (reduces the number of reads that have to go "
29378 "through the L<guestfs(3)> API). This is generally a good idea if you can "
29379 "afford the extra memory usage."
29383 #: ../fuse/guestmount.pod:218
29384 msgid "B<-o uid=N> B<-o gid=N>"
29388 #: ../fuse/guestmount.pod:220
29390 "Use these options to map all UIDs and GIDs inside the guest filesystem to "
29391 "the chosen values."
29395 #: ../fuse/guestmount.pod:225
29396 msgid "B<-r> | B<--ro>"
29400 #: ../fuse/guestmount.pod:227
29402 "Add devices and mount everything read-only. Also disallow writes and make "
29403 "the disk appear read-only to FUSE."
29407 #: ../fuse/guestmount.pod:230
29409 "This is highly recommended if you are not going to edit the guest disk. If "
29410 "the guest is running and this option is I<not> supplied, then there is a "
29411 "strong risk of disk corruption in the guest. We try to prevent this from "
29412 "happening, but it is not always possible."
29416 #: ../fuse/guestmount.pod:235
29417 msgid "See also L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
29421 #: ../fuse/guestmount.pod:239
29422 msgid "Enable SELinux support for the guest."
29426 #: ../fuse/guestmount.pod:241
29427 msgid "B<-v> | B<--verbose>"
29431 #: ../fuse/guestmount.pod:243
29432 msgid "Enable verbose messages from underlying libguestfs."
29436 #: ../fuse/guestmount.pod:245
29437 msgid "B<-V> | B<--version>"
29441 #: ../fuse/guestmount.pod:247
29442 msgid "Display the program version and exit."
29446 #: ../fuse/guestmount.pod:249
29447 msgid "B<-w> | B<--rw>"
29451 #: ../fuse/guestmount.pod:254 ../fuse/guestmount.pod:275
29452 msgid "See L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
29456 #: ../fuse/guestmount.pod:256
29457 msgid "B<-x> | B<--trace>"
29461 #: ../fuse/guestmount.pod:258
29462 msgid "Trace libguestfs calls and entry into each FUSE function."
29466 #: ../fuse/guestmount.pod:260
29467 msgid "This also stops the daemon from forking into the background."
29471 #: ../fuse/guestmount.pod:281
29473 "L<guestfish(1)>, L<virt-inspector(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
29474 "L<virt-tar(1)>, L<guestfs(3)>, L<http://libguestfs.org/>, L<http://fuse.sf."
29479 #: ../fuse/guestmount.pod:296
29480 msgid "Copyright (C) 2009-2010 Red Hat Inc. L<http://libguestfs.org/>"
29484 #: ../tools/virt-win-reg.pl:37
29486 "virt-win-reg - Export and merge Windows Registry entries from a Windows guest"
29490 #: ../tools/virt-win-reg.pl:41
29493 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey'\n"
29498 #: ../tools/virt-win-reg.pl:43
29501 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' name\n"
29506 #: ../tools/virt-win-reg.pl:45
29509 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' @\n"
29514 #: ../tools/virt-win-reg.pl:47
29517 " virt-win-reg --merge domname [input.reg ...]\n"
29522 #: ../tools/virt-win-reg.pl:49
29525 " virt-win-reg [--options] disk.img ... # instead of domname\n"
29530 #: ../tools/virt-win-reg.pl:53
29532 "You must I<not> use C<virt-win-reg> with the I<--merge> option on live "
29533 "virtual machines. If you do this, you I<will> get irreversible disk "
29534 "corruption in the VM. C<virt-win-reg> tries to stop you from doing this, "
29535 "but doesn't catch all cases."
29539 #: ../tools/virt-win-reg.pl:58
29541 "Modifying the Windows Registry is an inherently risky operation. The format "
29542 "is deliberately obscure and undocumented, and Registry changes can leave the "
29543 "system unbootable. Therefore when using the I<--merge> option, make sure "
29544 "you have a reliable backup first."
29548 #: ../tools/virt-win-reg.pl:65
29550 "This program can export and merge Windows Registry entries from a Windows "
29555 #: ../tools/virt-win-reg.pl:68
29557 "The first parameter is the libvirt guest name or the raw disk image of a "
29562 #: ../tools/virt-win-reg.pl:71
29564 "If I<--merge> is I<not> specified, then the chosen registry key is displayed/"
29565 "exported (recursively). For example:"
29569 #: ../tools/virt-win-reg.pl:74
29572 " $ virt-win-reg Windows7 'HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft'\n"
29577 #: ../tools/virt-win-reg.pl:76
29579 "You can also display single values from within registry keys, for example:"
29583 #: ../tools/virt-win-reg.pl:79
29586 " $ cvkey='HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion'\n"
29587 " $ virt-win-reg Windows7 $cvkey ProductName\n"
29588 " Windows 7 Enterprise\n"
29593 #: ../tools/virt-win-reg.pl:83
29595 "With I<--merge>, you can merge a textual regedit file into the Windows "
29600 #: ../tools/virt-win-reg.pl:86
29603 " $ virt-win-reg --merge Windows7 changes.reg\n"
29608 #: ../tools/virt-win-reg.pl:88 ../tools/virt-tar.pl:45
29613 #: ../tools/virt-win-reg.pl:90
29615 "This program is only meant for simple access to the registry. If you want "
29616 "to do complicated things with the registry, we suggest you download the "
29617 "Registry hive files from the guest using L<libguestfs(3)> or L<guestfish(1)> "
29618 "and access them locally, eg. using L<hivex(3)>, L<hivexsh(1)> or "
29619 "L<hivexregedit(1)>."
29623 #: ../tools/virt-win-reg.pl:106 ../tools/virt-list-filesystems.pl:63
29624 #: ../tools/virt-tar.pl:113 ../tools/virt-make-fs.pl:163
29625 #: ../tools/virt-list-partitions.pl:64
29626 msgid "Display brief help."
29630 #: ../tools/virt-win-reg.pl:114 ../tools/virt-list-filesystems.pl:71
29631 #: ../tools/virt-tar.pl:121 ../tools/virt-make-fs.pl:171
29632 #: ../tools/virt-list-partitions.pl:72
29633 msgid "Display version number and exit."
29637 #: ../tools/virt-win-reg.pl:120 ../tools/virt-make-fs.pl:177
29642 #: ../tools/virt-win-reg.pl:122
29643 msgid "Enable debugging messages."
29647 #: ../tools/virt-win-reg.pl:128 ../tools/virt-list-filesystems.pl:77
29648 #: ../tools/virt-tar.pl:127 ../tools/virt-list-partitions.pl:78
29649 msgid "B<--connect URI> | B<-c URI>"
29653 #: ../tools/virt-win-reg.pl:130 ../tools/virt-list-filesystems.pl:79
29654 #: ../tools/virt-tar.pl:129 ../tools/virt-list-partitions.pl:80
29656 "If using libvirt, connect to the given I<URI>. If omitted, then we connect "
29657 "to the default libvirt hypervisor."
29661 #: ../tools/virt-win-reg.pl:133 ../tools/virt-list-filesystems.pl:82
29662 #: ../tools/virt-tar.pl:132 ../tools/virt-list-partitions.pl:83
29664 "If you specify guest block devices directly, then libvirt is not used at all."
29668 #: ../tools/virt-win-reg.pl:140 ../tools/virt-list-filesystems.pl:89
29669 #: ../tools/virt-tar.pl:139 ../tools/virt-list-partitions.pl:90
29670 msgid "B<--format> raw"
29674 #: ../tools/virt-win-reg.pl:142 ../tools/virt-list-filesystems.pl:91
29675 #: ../tools/virt-tar.pl:141 ../tools/virt-list-partitions.pl:92
29677 "Specify the format of disk images given on the command line. If this is "
29678 "omitted then the format is autodetected from the content of the disk image."
29682 #: ../tools/virt-win-reg.pl:146 ../tools/virt-list-filesystems.pl:95
29683 #: ../tools/virt-tar.pl:145 ../tools/virt-list-partitions.pl:96
29685 "If disk images are requested from libvirt, then this program asks libvirt "
29686 "for this information. In this case, the value of the format parameter is "
29691 #: ../tools/virt-win-reg.pl:150 ../tools/virt-list-filesystems.pl:99
29692 #: ../tools/virt-tar.pl:149 ../tools/virt-list-partitions.pl:100
29694 "If working with untrusted raw-format guest disk images, you should ensure "
29695 "the format is always specified."
29699 #: ../tools/virt-win-reg.pl:157
29704 #: ../tools/virt-win-reg.pl:159
29706 "In merge mode, this merges a textual regedit file into the Windows Registry "
29707 "of the virtual machine. If this flag is I<not> given then virt-win-reg "
29708 "displays or exports Registry entries instead."
29712 #: ../tools/virt-win-reg.pl:163
29714 "Note that I<--merge> is I<unsafe> to use on live virtual machines, and will "
29715 "result in disk corruption. However exporting (without this flag) is always "
29720 #: ../tools/virt-win-reg.pl:171
29721 msgid "B<--encoding> UTF-16LE|ASCII"
29725 #: ../tools/virt-win-reg.pl:173
29727 "When merging (only), you may need to specify the encoding for strings to be "
29728 "used in the hive file. This is explained in detail in L<Win::Hivex::Regedit"
29729 "(3)/ENCODING STRINGS>."
29733 #: ../tools/virt-win-reg.pl:177
29735 "The default is to use UTF-16LE, which should work with recent versions of "
29740 #: ../tools/virt-win-reg.pl:184
29741 msgid "B<--unsafe-printable-strings>"
29745 #: ../tools/virt-win-reg.pl:186
29747 "When exporting (only), assume strings are UTF-16LE and print them as strings "
29748 "instead of hex sequences. Remove the final zero codepoint from strings if "
29753 #: ../tools/virt-win-reg.pl:190
29755 "This is unsafe and does not preserve the fidelity of strings in the original "
29756 "Registry for various reasons:"
29760 #: ../tools/virt-win-reg.pl:197
29762 "Assumes the original encoding is UTF-16LE. ASCII strings and strings in "
29763 "other encodings will be corrupted by this transformation."
29767 #: ../tools/virt-win-reg.pl:202
29769 "Assumes that everything which has type 1 or 2 is really a string and that "
29770 "everything else is not a string, but the type field in real Registries is "
29775 #: ../tools/virt-win-reg.pl:208
29777 "Loses information about whether a zero codepoint followed the string in the "
29782 #: ../tools/virt-win-reg.pl:213
29784 "This all happens because the Registry itself contains no information about "
29785 "how strings are encoded (see L<Win::Hivex::Regedit(3)/ENCODING STRINGS>)."
29789 #: ../tools/virt-win-reg.pl:217
29791 "You should only use this option for quick hacking and debugging of the "
29792 "Registry contents, and I<never> use it if the output is going to be passed "
29793 "into another program or stored in another Registry."
29797 #: ../tools/virt-win-reg.pl:554
29798 msgid "SUPPORTED SYSTEMS"
29802 #: ../tools/virt-win-reg.pl:556
29804 "The program currently supports Windows NT-derived guests starting with "
29805 "Windows XP through to at least Windows 7."
29809 #: ../tools/virt-win-reg.pl:559
29810 msgid "The following Registry keys are supported:"
29814 #: ../tools/virt-win-reg.pl:563
29815 msgid "C<HKEY_LOCAL_MACHINE\\SAM>"
29819 #: ../tools/virt-win-reg.pl:565
29820 msgid "C<HKEY_LOCAL_MACHINE\\SECURITY>"
29824 #: ../tools/virt-win-reg.pl:567
29825 msgid "C<HKEY_LOCAL_MACHINE\\SOFTWARE>"
29829 #: ../tools/virt-win-reg.pl:569
29830 msgid "C<HKEY_LOCAL_MACHINE\\SYSTEM>"
29834 #: ../tools/virt-win-reg.pl:571
29835 msgid "C<HKEY_USERS\\.DEFAULT>"
29839 #: ../tools/virt-win-reg.pl:573
29840 msgid "C<HKEY_USERS\\I<SID>>"
29844 #: ../tools/virt-win-reg.pl:575
29845 msgid "where I<SID> is a Windows User SID (eg. C<S-1-5-18>)."
29849 #: ../tools/virt-win-reg.pl:577
29850 msgid "C<HKEY_USERS\\I<username>>"
29854 #: ../tools/virt-win-reg.pl:579
29856 "where I<username> is a local user name (this is a libguestfs extension)."
29860 #: ../tools/virt-win-reg.pl:583
29862 "You can use C<HKLM> as a shorthand for C<HKEY_LOCAL_MACHINE>, and C<HKU> for "
29867 #: ../tools/virt-win-reg.pl:586
29869 "The literal keys C<HKEY_USERS\\$SID> and C<HKEY_CURRENT_USER> are not "
29870 "supported (there is no \"current user\")."
29874 #: ../tools/virt-win-reg.pl:589
29879 #: ../tools/virt-win-reg.pl:591
29881 "C<virt-win-reg> expects that regedit files have already been reencoded in "
29882 "the local encoding. Usually on Linux hosts, this means UTF-8 with Unix-"
29883 "style line endings. Since Windows regedit files are often in UTF-16LE with "
29884 "Windows-style line endings, you may need to reencode the whole file before "
29885 "or after processing."
29889 #: ../tools/virt-win-reg.pl:597
29891 "To reencode a file from Windows format to Linux (before processing it with "
29892 "the I<--merge> option), you would do something like this:"
29896 #: ../tools/virt-win-reg.pl:600
29899 " iconv -f utf-16le -t utf-8 < win.reg | dos2unix > linux.reg\n"
29904 #: ../tools/virt-win-reg.pl:602
29906 "To go in the opposite direction, after exporting and before sending the file "
29907 "to a Windows user, do something like this:"
29911 #: ../tools/virt-win-reg.pl:605
29914 " unix2dos linux.reg | iconv -f utf-8 -t utf-16le > win.reg\n"
29919 #: ../tools/virt-win-reg.pl:607
29920 msgid "For more information about encoding, see L<Win::Hivex::Regedit(3)>."
29924 #: ../tools/virt-win-reg.pl:609
29926 "If you are unsure about the current encoding, use the L<file(1)> command. "
29927 "Recent versions of Windows regedit.exe produce a UTF-16LE file with Windows-"
29928 "style (CRLF) line endings, like this:"
29932 #: ../tools/virt-win-reg.pl:613
29935 " $ file software.reg\n"
29936 " software.reg: Little-endian UTF-16 Unicode text, with very long lines,\n"
29937 " with CRLF line terminators\n"
29942 #: ../tools/virt-win-reg.pl:617
29943 msgid "This file would need conversion before you could I<--merge> it."
29947 #: ../tools/virt-win-reg.pl:619
29948 msgid "CurrentControlSet etc."
29952 #: ../tools/virt-win-reg.pl:621
29954 "Registry keys like C<CurrentControlSet> don't really exist in the Windows "
29955 "Registry at the level of the hive file, and therefore you cannot modify "
29960 #: ../tools/virt-win-reg.pl:625
29962 "C<CurrentControlSet> is usually an alias for C<ControlSet001>. In some "
29963 "circumstances it might refer to another control set. The way to find out is "
29964 "to look at the C<HKLM\\SYSTEM\\Select> key:"
29968 #: ../tools/virt-win-reg.pl:629
29971 " # virt-win-reg WindowsGuest 'HKLM\\SYSTEM\\Select'\n"
29972 " [HKEY_LOCAL_MACHINE\\SYSTEM\\Select]\n"
29973 " \"Current\"=dword:00000001\n"
29974 " \"Default\"=dword:00000001\n"
29975 " \"Failed\"=dword:00000000\n"
29976 " \"LastKnownGood\"=dword:00000002\n"
29981 #: ../tools/virt-win-reg.pl:636
29982 msgid "\"Current\" is the one which Windows will choose when it boots."
29986 #: ../tools/virt-win-reg.pl:638
29988 "Similarly, other C<Current...> keys in the path may need to be replaced."
29992 #: ../tools/virt-win-reg.pl:641
29993 msgid "WINDOWS TIPS"
29997 #: ../tools/virt-win-reg.pl:643
29999 "Note that some of these tips modify the guest disk image. The guest I<must> "
30000 "be shut off, else you will get disk corruption."
30004 #: ../tools/virt-win-reg.pl:646
30005 msgid "RUNNING A BATCH SCRIPT WHEN A USER LOGS IN"
30009 #: ../tools/virt-win-reg.pl:648
30011 "Prepare a DOS batch script, VBScript or executable. Upload this using "
30012 "L<guestfish(1)>. For this example the script is called C<test.bat> and it "
30013 "is uploaded into C<C:\\>:"
30017 #: ../tools/virt-win-reg.pl:652
30020 " guestfish -i -d WindowsGuest upload test.bat /test.bat\n"
30025 #: ../tools/virt-win-reg.pl:654
30026 msgid "Prepare a regedit file containing the registry change:"
30030 #: ../tools/virt-win-reg.pl:656
30033 " cat > test.reg <<'EOF'\n"
30034 " [HKLM\\Software\\Microsoft\\Windows\\CurrentVersion\\RunOnce]\n"
30035 " \"Test\"=\"c:\\\\test.bat\"\n"
30041 #: ../tools/virt-win-reg.pl:661
30043 "In this example we use the key C<RunOnce> which means that the script will "
30044 "run precisely once when the first user logs in. If you want it to run every "
30045 "time a user logs in, replace C<RunOnce> with C<Run>."
30049 #: ../tools/virt-win-reg.pl:665
30050 msgid "Now update the registry:"
30054 #: ../tools/virt-win-reg.pl:667
30057 " virt-win-reg --merge WindowsGuest test.reg\n"
30062 #: ../tools/virt-win-reg.pl:669
30063 msgid "INSTALLING A SERVICE"
30067 #: ../tools/virt-win-reg.pl:671
30069 "This section assumes you are familiar with Windows services, and you either "
30070 "have a program which handles the Windows Service Control Protocol directly "
30071 "or you want to run any program using a service wrapper like SrvAny or the "
30076 #: ../tools/virt-win-reg.pl:676
30078 "First upload the program and optionally the service wrapper. In this case "
30079 "the test program is called C<test.exe> and we are using the RHSrvAny wrapper:"
30083 #: ../tools/virt-win-reg.pl:680
30086 " guestfish -i -d WindowsGuest <<EOF\n"
30087 " upload rhsrvany.exe /rhsrvany.exe\n"
30088 " upload test.exe /test.exe\n"
30094 #: ../tools/virt-win-reg.pl:685
30096 "Prepare a regedit file containing the registry changes. In this example, "
30097 "the first registry change is needed for the service itself or the service "
30098 "wrapper (if used). The second registry change is only needed because I am "
30099 "using the RHSrvAny service wrapper."
30103 #: ../tools/virt-win-reg.pl:690
30106 " cat > service.reg <<'EOF'\n"
30107 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny]\n"
30108 " \"Type\"=dword:00000010\n"
30109 " \"Start\"=dword:00000002\n"
30110 " \"ErrorControl\"=dword:00000001\n"
30111 " \"ImagePath\"=\"c:\\\\rhsrvany.exe\"\n"
30112 " \"DisplayName\"=\"RHSrvAny\"\n"
30113 " \"ObjectName\"=\"NetworkService\"\n"
30118 #: ../tools/virt-win-reg.pl:699
30121 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny\\Parameters]\n"
30122 " \"CommandLine\"=\"c:\\\\test.exe\"\n"
30123 " \"PWD\"=\"c:\\\\Temp\"\n"
30129 #: ../tools/virt-win-reg.pl:710
30131 "For use of C<ControlSet001> see the section above in this manual page. You "
30132 "may need to adjust this according to the control set that is in use by the "
30137 #: ../tools/virt-win-reg.pl:716
30139 "C<\"ObjectName\"> controls the privileges that the service will have. An "
30140 "alternative is C<\"ObjectName\"=\"LocalSystem\"> which would be the most "
30141 "privileged account."
30145 #: ../tools/virt-win-reg.pl:722
30147 "For the meaning of the magic numbers, see this Microsoft KB article: "
30148 "L<http://support.microsoft.com/kb/103000>."
30152 #: ../tools/virt-win-reg.pl:727
30153 msgid "Update the registry:"
30157 #: ../tools/virt-win-reg.pl:729
30160 " virt-win-reg --merge WindowsGuest service.reg\n"
30165 #: ../tools/virt-win-reg.pl:731 ../tools/virt-list-filesystems.pl:182
30166 #: ../tools/virt-tar.pl:279 ../tools/virt-make-fs.pl:532
30167 #: ../tools/virt-list-partitions.pl:250
30168 msgid "SHELL QUOTING"
30172 #: ../tools/virt-win-reg.pl:733
30174 "Be careful when passing parameters containing C<\\> (backslash) in the "
30175 "shell. Usually you will have to use 'single quotes' or double backslashes "
30176 "(but not both) to protect them from the shell."
30180 #: ../tools/virt-win-reg.pl:737
30181 msgid "Paths and value names are case-insensitive."
30185 #: ../tools/virt-win-reg.pl:739 ../tools/virt-list-filesystems.pl:184
30186 #: ../tools/virt-tar.pl:281 ../tools/virt-make-fs.pl:534
30187 #: ../tools/virt-list-partitions.pl:252
30189 "Libvirt guest names can contain arbitrary characters, some of which have "
30190 "meaning to the shell such as C<#> and space. You may need to quote or "
30191 "escape these characters on the command line. See the shell manual page L<sh"
30192 "(1)> for details."
30196 #: ../tools/virt-win-reg.pl:746
30198 "L<hivex(3)>, L<hivexsh(1)>, L<hivexregedit(1)>, L<guestfs(3)>, L<guestfish(1)"
30199 ">, L<virt-cat(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Win::Hivex"
30200 "(3)>, L<Win::Hivex::Regedit(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
30204 #: ../tools/virt-win-reg.pl:761 ../tools/virt-make-fs.pl:555
30206 "When reporting bugs, please enable debugging and capture the I<complete> "
30211 #: ../tools/virt-win-reg.pl:764
30214 " export LIBGUESTFS_DEBUG=1\n"
30215 " virt-win-reg --debug [... rest ...] > /tmp/virt-win-reg.log 2>&1\n"
30220 #: ../tools/virt-win-reg.pl:767
30222 "Attach /tmp/virt-win-reg.log to a new bug report at L<https://bugzilla."
30227 #: ../tools/virt-win-reg.pl:770 ../tools/virt-list-filesystems.pl:202
30228 #: ../tools/virt-tar.pl:301 ../tools/virt-make-fs.pl:564
30229 #: ../tools/virt-list-partitions.pl:269
30234 #: ../tools/virt-win-reg.pl:772 ../tools/virt-list-filesystems.pl:204
30235 #: ../tools/virt-tar.pl:303 ../tools/virt-make-fs.pl:566
30236 #: ../tools/virt-list-partitions.pl:271
30237 msgid "Richard W.M. Jones L<http://people.redhat.com/~rjones/>"
30241 #: ../tools/virt-win-reg.pl:776 ../tools/virt-make-fs.pl:570
30242 msgid "Copyright (C) 2010 Red Hat Inc."
30246 #: ../tools/virt-list-filesystems.pl:32
30248 "virt-list-filesystems - List filesystems in a virtual machine or disk image"
30252 #: ../tools/virt-list-filesystems.pl:36
30255 " virt-list-filesystems [--options] domname\n"
30260 #: ../tools/virt-list-filesystems.pl:38
30263 " virt-list-filesystems [--options] disk.img [disk.img ...]\n"
30268 #: ../tools/virt-list-filesystems.pl:42 ../tools/virt-list-partitions.pl:42
30270 "This tool is obsolete. Use L<virt-filesystems(1)> as a more flexible "
30275 #: ../tools/virt-list-filesystems.pl:45
30277 "C<virt-list-filesystems> is a command line tool to list the filesystems that "
30278 "are contained in a virtual machine or disk image."
30282 #: ../tools/virt-list-filesystems.pl:49
30284 "C<virt-list-filesystems> is just a simple wrapper around L<libguestfs(3)> "
30285 "functionality. For more complex cases you should look at the L<guestfish(1)"
30290 #: ../tools/virt-list-filesystems.pl:106 ../tools/virt-list-partitions.pl:115
30291 msgid "B<-l> | B<--long>"
30295 #: ../tools/virt-list-filesystems.pl:108
30297 "With this option, C<virt-list-filesystems> displays the type of each "
30298 "filesystem too (where \"type\" means C<ext3>, C<xfs> etc.)"
30302 #: ../tools/virt-list-filesystems.pl:115
30303 msgid "B<-a> | B<--all>"
30307 #: ../tools/virt-list-filesystems.pl:117
30309 "Normally we only show mountable filesystems. If this option is given then "
30310 "swap devices are shown too."
30314 #: ../tools/virt-list-filesystems.pl:191
30316 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, L<virt-"
30317 "filesystems(1)>, L<virt-list-partitions(1)>, L<Sys::Guestfs(3)>, L<Sys::"
30318 "Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
30322 #: ../tools/virt-list-filesystems.pl:208 ../tools/virt-tar.pl:307
30323 msgid "Copyright (C) 2009 Red Hat Inc."
30327 #: ../tools/virt-tar.pl:33
30328 msgid "virt-tar - Extract or upload files to a virtual machine"
30332 #: ../tools/virt-tar.pl:37
30335 " virt-tar [--options] -x domname directory tarball\n"
30340 #: ../tools/virt-tar.pl:39
30343 " virt-tar [--options] -u domname tarball directory\n"
30348 #: ../tools/virt-tar.pl:41
30351 " virt-tar [--options] disk.img [disk.img ...] -x directory tarball\n"
30356 #: ../tools/virt-tar.pl:43
30359 " virt-tar [--options] disk.img [disk.img ...] -u tarball directory\n"
30364 #: ../tools/virt-tar.pl:47
30366 "This tool is obsolete. Use L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-"
30367 "tar-in(1)>, L<virt-tar-out(1)> as replacements."
30371 #: ../tools/virt-tar.pl:52
30372 msgid "Download C</home> from the VM into a local tarball:"
30376 #: ../tools/virt-tar.pl:54
30379 " virt-tar -x domname /home home.tar\n"
30384 #: ../tools/virt-tar.pl:56
30387 " virt-tar -zx domname /home home.tar.gz\n"
30392 #: ../tools/virt-tar.pl:58
30393 msgid "Upload a local tarball and unpack it inside C</tmp> in the VM:"
30397 #: ../tools/virt-tar.pl:60
30400 " virt-tar -u domname uploadstuff.tar /tmp\n"
30405 #: ../tools/virt-tar.pl:62
30408 " virt-tar -zu domname uploadstuff.tar.gz /tmp\n"
30413 #: ../tools/virt-tar.pl:66
30415 "You must I<not> use C<virt-tar> with the I<-u> option (upload) on live "
30416 "virtual machines. If you do this, you risk disk corruption in the VM. "
30417 "C<virt-tar> tries to stop you from doing this, but doesn't catch all cases."
30421 #: ../tools/virt-tar.pl:71
30423 "You can use I<-x> (extract) on live virtual machines, but you might get "
30424 "inconsistent results or errors if there is filesystem activity inside the "
30425 "VM. If the live VM is synched and quiescent, then C<virt-tar> will usually "
30426 "work, but the only way to guarantee consistent results is if the virtual "
30427 "machine is shut down."
30431 #: ../tools/virt-tar.pl:79
30433 "C<virt-tar> is a general purpose archive tool for downloading and uploading "
30434 "parts of a guest filesystem. There are many possibilities: making backups, "
30435 "uploading data files, snooping on guest activity, fixing or customizing "
30440 #: ../tools/virt-tar.pl:84
30442 "If you want to just view a single file, use L<virt-cat(1)>. If you just "
30443 "want to edit a single file, use L<virt-edit(1)>. For more complex cases you "
30444 "should look at the L<guestfish(1)> tool."
30448 #: ../tools/virt-tar.pl:88
30450 "There are two modes of operation: I<-x> (eXtract) downloads a directory and "
30451 "its contents (recursively) from the virtual machine into a local tarball. "
30452 "I<-u> uploads from a local tarball, unpacking it into a directory inside the "
30453 "virtual machine. You cannot use these two options together."
30457 #: ../tools/virt-tar.pl:94
30459 "In addition, you may need to use the I<-z> (gZip) option to enable "
30460 "compression. When uploading, you have to specify I<-z> if the upload file "
30461 "is compressed because virt-tar won't detect this on its own."
30465 #: ../tools/virt-tar.pl:98
30467 "C<virt-tar> can only handle tar (optionally gzipped) format tarballs. For "
30468 "example it cannot do PKZip files or bzip2 compression. If you want that "
30469 "then you'll have to rebuild the tarballs yourself. (This is a limitation of "
30470 "the L<libguestfs(3)> API)."
30474 #: ../tools/virt-tar.pl:156
30475 msgid "B<-x> | B<--extract> | B<--download>"
30479 #: ../tools/virt-tar.pl:158
30480 msgid "B<-u> | B<--upload>"
30484 #: ../tools/virt-tar.pl:160
30486 "Use I<-x> to extract (download) a directory from a virtual machine to a "
30491 #: ../tools/virt-tar.pl:163
30493 "Use I<-u> to upload and unpack from a local tarball into a virtual machine. "
30494 "Please read the L</WARNING> section above before using this option."
30498 #: ../tools/virt-tar.pl:167
30499 msgid "You must specify exactly one of these options."
30503 #: ../tools/virt-tar.pl:173
30504 msgid "B<-z> | B<--gzip>"
30508 #: ../tools/virt-tar.pl:175
30509 msgid "Specify that the input or output tarball is gzip-compressed."
30513 #: ../tools/virt-tar.pl:288
30515 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, L<virt-copy-"
30516 "in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<Sys::"
30517 "Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs."
30522 #: ../tools/virt-make-fs.pl:37
30523 msgid "virt-make-fs - Make a filesystem from a tar archive or files"
30527 #: ../tools/virt-make-fs.pl:41
30530 " virt-make-fs [--options] input.tar output.img\n"
30535 #: ../tools/virt-make-fs.pl:43
30538 " virt-make-fs [--options] input.tar.gz output.img\n"
30543 #: ../tools/virt-make-fs.pl:45
30546 " virt-make-fs [--options] directory output.img\n"
30551 #: ../tools/virt-make-fs.pl:49
30553 "Virt-make-fs is a command line tool for creating a filesystem from a tar "
30554 "archive or some files in a directory. It is similar to tools like L<mkisofs"
30555 "(1)>, L<genisoimage(1)> and L<mksquashfs(1)>. Unlike those tools, it can "
30556 "create common filesystem types like ext2/3 or NTFS, which can be useful if "
30557 "you want to attach these filesystems to existing virtual machines (eg. to "
30558 "import large amounts of read-only data to a VM)."
30562 #: ../tools/virt-make-fs.pl:57
30563 msgid "Basic usage is:"
30567 #: ../tools/virt-make-fs.pl:59
30570 " virt-make-fs input output\n"
30575 #: ../tools/virt-make-fs.pl:61
30577 "where C<input> is either a directory containing files that you want to add, "
30578 "or a tar archive (either uncompressed tar or gzip-compressed tar); and "
30579 "C<output> is a disk image. The input type is detected automatically. The "
30580 "output disk image defaults to a raw ext2 image unless you specify extra "
30581 "flags (see L</OPTIONS> below)."
30585 #: ../tools/virt-make-fs.pl:67
30586 msgid "EXTRA SPACE"
30590 #: ../tools/virt-make-fs.pl:69
30592 "Unlike formats such as tar and squashfs, a filesystem does not \"just fit\" "
30593 "the files that it contains, but might have extra space. Depending on how "
30594 "you are going to use the output, you might think this extra space is wasted "
30595 "and want to minimize it, or you might want to leave space so that more files "
30596 "can be added later. Virt-make-fs defaults to minimizing the extra space, "
30597 "but you can use the I<--size> flag to leave space in the filesystem if you "
30602 #: ../tools/virt-make-fs.pl:77
30604 "An alternative way to leave extra space but not make the output image any "
30605 "bigger is to use an alternative disk image format (instead of the default "
30606 "\"raw\" format). Using I<--format=qcow2> will use the native QEmu/KVM qcow2 "
30607 "image format (check your hypervisor supports this before using it). This "
30608 "allows you to choose a large I<--size> but the extra space won't actually be "
30609 "allocated in the image until you try to store something in it."
30613 #: ../tools/virt-make-fs.pl:85
30615 "Don't forget that you can also use local commands including L<resize2fs(8)> "
30616 "and L<virt-resize(1)> to resize existing filesystems, or rerun virt-make-fs "
30617 "to build another image from scratch."
30621 #: ../tools/virt-make-fs.pl:89 ../tools/virt-make-fs.pl:123
30622 #: ../tools/virt-make-fs.pl:142
30627 #: ../tools/virt-make-fs.pl:91
30630 " virt-make-fs --format=qcow2 --size=+200M input output.img\n"
30635 #: ../tools/virt-make-fs.pl:93
30636 msgid "FILESYSTEM TYPE"
30640 #: ../tools/virt-make-fs.pl:95
30642 "The default filesystem type is C<ext2>. Just about any filesystem type that "
30643 "libguestfs supports can be used (but I<not> read-only formats like "
30644 "ISO9660). Here are some of the more common choices:"
30648 #: ../tools/virt-make-fs.pl:101
30653 #: ../tools/virt-make-fs.pl:103
30655 "Note that ext3 filesystems contain a journal, typically 1-32 MB in size. If "
30656 "you are not going to use the filesystem in a way that requires the journal, "
30657 "then this is just wasted overhead."
30661 #: ../tools/virt-make-fs.pl:107
30662 msgid "I<ntfs> or I<vfat>"
30666 #: ../tools/virt-make-fs.pl:109
30667 msgid "Useful if exporting data to a Windows guest."
30671 #: ../tools/virt-make-fs.pl:111
30673 "I<Note for vfat>: The tar archive or local directory must only contain files "
30674 "which are owned by root (ie. UID:GID = 0:0). The reason is that the tar "
30675 "program running within libguestfs is unable to change the ownership of non-"
30676 "root files, since vfat itself does not support this."
30680 #: ../tools/virt-make-fs.pl:116
30685 #: ../tools/virt-make-fs.pl:118
30687 "Lower overhead than C<ext2>, but certain limitations on filename length and "
30688 "total filesystem size."
30692 #: ../tools/virt-make-fs.pl:125
30695 " virt-make-fs --type=minix input minixfs.img\n"
30700 #: ../tools/virt-make-fs.pl:127
30701 msgid "TO PARTITION OR NOT TO PARTITION"
30705 #: ../tools/virt-make-fs.pl:129
30706 msgid "Optionally virt-make-fs can add a partition table to the output disk."
30710 #: ../tools/virt-make-fs.pl:131
30712 "Adding a partition can make the disk image more compatible with certain "
30713 "virtualized operating systems which don't expect to see a filesystem "
30714 "directly located on a block device (Linux doesn't care and will happily "
30715 "handle both types)."
30719 #: ../tools/virt-make-fs.pl:136
30721 "On the other hand, if you have a partition table then the output image is no "
30722 "longer a straight filesystem. For example you cannot run L<fsck(8)> "
30723 "directly on a partitioned disk image. (However libguestfs tools such as "
30724 "L<guestfish(1)> and L<virt-resize(1)> can still be used)."
30728 #: ../tools/virt-make-fs.pl:144
30729 msgid "Add an MBR partition:"
30733 #: ../tools/virt-make-fs.pl:146
30736 " virt-make-fs --partition -- input disk.img\n"
30741 #: ../tools/virt-make-fs.pl:148
30743 "If the output disk image could be terabyte-sized or larger, it's better to "
30744 "use an EFI/GPT-compatible partition table:"
30748 #: ../tools/virt-make-fs.pl:151
30751 " virt-make-fs --partition=gpt --size=+4T --format=qcow2 input disk.img\n"
30756 #: ../tools/virt-make-fs.pl:179
30757 msgid "Enable debugging information."
30761 #: ../tools/virt-make-fs.pl:185
30762 msgid "B<--size=E<lt>NE<gt>>"
30766 #: ../tools/virt-make-fs.pl:187
30767 msgid "B<--size=+E<lt>NE<gt>>"
30771 #: ../tools/virt-make-fs.pl:189
30772 msgid "B<-s E<lt>NE<gt>>"
30776 #: ../tools/virt-make-fs.pl:191
30777 msgid "B<-s +E<lt>NE<gt>>"
30781 #: ../tools/virt-make-fs.pl:193
30783 "Use the I<--size> (or I<-s>) option to choose the size of the output image."
30787 #: ../tools/virt-make-fs.pl:196
30789 "If this option is I<not> given, then the output image will be just large "
30790 "enough to contain all the files, with not much wasted space."
30794 #: ../tools/virt-make-fs.pl:199
30796 "To choose a fixed size output disk, specify an absolute number followed by b/"
30797 "K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
30798 "Petabytes or Exabytes. This must be large enough to contain all the input "
30799 "files, else you will get an error."
30803 #: ../tools/virt-make-fs.pl:204
30805 "To leave extra space, specify C<+> (plus sign) and a number followed by b/K/"
30806 "M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
30807 "Petabytes or Exabytes. For example: I<--size=+200M> means enough space for "
30808 "the input files, and (approximately) an extra 200 MB free space."
30812 #: ../tools/virt-make-fs.pl:210
30814 "Note that virt-make-fs estimates free space, and therefore will not produce "
30815 "filesystems containing precisely the free space requested. (It is much more "
30816 "expensive and time-consuming to produce a filesystem which has precisely the "
30817 "desired free space)."
30821 #: ../tools/virt-make-fs.pl:219
30822 msgid "B<--format=E<lt>fmtE<gt>>"
30826 #: ../tools/virt-make-fs.pl:221
30827 msgid "B<-F E<lt>fmtE<gt>>"
30831 #: ../tools/virt-make-fs.pl:223
30832 msgid "Choose the output disk image format."
30836 #: ../tools/virt-make-fs.pl:225
30837 msgid "The default is C<raw> (raw disk image)."
30841 #: ../tools/virt-make-fs.pl:227
30843 "For other choices, see the L<qemu-img(1)> manpage. The only other choice "
30844 "that would really make sense here is C<qcow2>."
30848 #: ../tools/virt-make-fs.pl:234
30849 msgid "B<--type=E<lt>fsE<gt>>"
30853 #: ../tools/virt-make-fs.pl:236
30854 msgid "B<-t E<lt>fsE<gt>>"
30858 #: ../tools/virt-make-fs.pl:238
30859 msgid "Choose the output filesystem type."
30863 #: ../tools/virt-make-fs.pl:240
30864 msgid "The default is C<ext2>."
30868 #: ../tools/virt-make-fs.pl:242
30870 "Any filesystem which is supported read-write by libguestfs can be used here."
30874 #: ../tools/virt-make-fs.pl:249
30875 msgid "B<--partition>"
30879 #: ../tools/virt-make-fs.pl:251
30880 msgid "B<--partition=E<lt>parttypeE<gt>>"
30884 #: ../tools/virt-make-fs.pl:253
30886 "If specified, this flag adds an MBR partition table to the output disk image."
30890 #: ../tools/virt-make-fs.pl:256
30892 "You can change the partition table type, eg. I<--partition=gpt> for large "
30897 #: ../tools/virt-make-fs.pl:259
30899 "Note that if you just use a lonesome I<--partition>, the Perl option parser "
30900 "might consider the next parameter to be the partition type. For example:"
30904 #: ../tools/virt-make-fs.pl:263
30907 " virt-make-fs --partition input.tar ...\n"
30912 #: ../tools/virt-make-fs.pl:265
30914 "would cause virt-make-fs to think you wanted to use a partition type of "
30915 "C<input.tar> which is completely wrong. To avoid this, use I<--> (a double "
30916 "dash) between options and the input file argument:"
30920 #: ../tools/virt-make-fs.pl:269
30923 " virt-make-fs --partition -- input.tar ...\n"
30928 #: ../tools/virt-make-fs.pl:541
30930 "L<guestfish(1)>, L<virt-resize(1)>, L<virt-tar-in(1)>, L<mkisofs(1)>, "
30931 "L<genisoimage(1)>, L<mksquashfs(1)>, L<mke2fs(8)>, L<resize2fs(8)>, L<guestfs"
30932 "(3)>, L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
30936 #: ../tools/virt-make-fs.pl:558
30939 " export LIBGUESTFS_DEBUG=1\n"
30940 " virt-make-fs --debug [...] > /tmp/virt-make-fs.log 2>&1\n"
30945 #: ../tools/virt-make-fs.pl:561
30947 "Attach /tmp/virt-make-fs.log to a new bug report at L<https://bugzilla."
30952 #: ../tools/virt-list-partitions.pl:32
30954 "virt-list-partitions - List partitions in a virtual machine or disk image"
30958 #: ../tools/virt-list-partitions.pl:36
30961 " virt-list-partitions [--options] domname\n"
30966 #: ../tools/virt-list-partitions.pl:38
30969 " virt-list-partitions [--options] disk.img [disk.img ...]\n"
30974 #: ../tools/virt-list-partitions.pl:45
30976 "C<virt-list-partitions> is a command line tool to list the partitions that "
30977 "are contained in a virtual machine or disk image. It is mainly useful as a "
30978 "first step to using L<virt-resize(1)>."
30982 #: ../tools/virt-list-partitions.pl:50
30984 "C<virt-list-partitions> is just a simple wrapper around L<libguestfs(3)> "
30985 "functionality. For more complex cases you should look at the L<guestfish(1)"
30990 #: ../tools/virt-list-partitions.pl:107
30991 msgid "B<-h> | B<--human-readable>"
30995 #: ../tools/virt-list-partitions.pl:109
30996 msgid "Show sizes in human-readable form (eg. \"1G\")."
31000 #: ../tools/virt-list-partitions.pl:117
31002 "With this option, C<virt-list-partitions> displays the type and size of each "
31003 "partition too (where \"type\" means C<ext3>, C<pv> etc.)"
31007 #: ../tools/virt-list-partitions.pl:124
31008 msgid "B<-t> | B<--total>"
31012 #: ../tools/virt-list-partitions.pl:126
31014 "Display the total size of each block device (as a separate row or rows)."
31018 #: ../tools/virt-list-partitions.pl:259
31020 "L<guestfs(3)>, L<guestfish(1)>, L<virt-filesystems(1)>, L<virt-list-"
31021 "filesystems(1)>, L<virt-resize(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib"
31022 "(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
31026 #: ../tools/virt-list-partitions.pl:275
31027 msgid "Copyright (C) 2009-2010 Red Hat Inc."